images.go 28.3 KB
Newer Older
1
2
3
package server

import (
4
	"bufio"
5
	"bytes"
6
	"context"
7
8
9
10
	"crypto/sha256"
	"encoding/json"
	"errors"
	"fmt"
11
	"html/template"
12
13
14
15
16
	"io"
	"log"
	"net/http"
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
17
	"reflect"
18
19
20
21
	"strconv"
	"strings"

	"github.com/jmorganca/ollama/api"
22
	"github.com/jmorganca/ollama/llama"
23
	"github.com/jmorganca/ollama/parser"
24
	"github.com/jmorganca/ollama/vector"
25
26
)

27
28
29
30
31
32
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
}

33
type Model struct {
34
35
36
37
38
39
40
	Name       string `json:"name"`
	ModelPath  string
	Template   string
	System     string
	Digest     string
	Options    map[string]interface{}
	Embeddings []vector.Embedding
41
42
}

Bruce MacDonald's avatar
Bruce MacDonald committed
43
func (m *Model) Prompt(request api.GenerateRequest, embedding string) (string, error) {
44
45
46
47
48
49
	t := m.Template
	if request.Template != "" {
		t = request.Template
	}

	tmpl, err := template.New("").Parse(t)
50
51
52
53
54
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
55
		First  bool
56
57
		System string
		Prompt string
58
		Embed  string
59
60
61

		// deprecated: versions <= 0.0.7 used this to omit the system prompt
		Context []int
62
63
	}

Michael Yang's avatar
Michael Yang committed
64
	vars.First = len(request.Context) == 0
65
66
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
67
	vars.Context = request.Context
Bruce MacDonald's avatar
Bruce MacDonald committed
68
	vars.Embed = embedding
69

70
71
72
73
	if request.System != "" {
		vars.System = request.System
	}

74
75
76
77
78
79
80
81
	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

82
83
84
85
86
87
88
89
90
91
92
93
94
type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
	Config        Layer    `json:"config"`
	Layers        []*Layer `json:"layers"`
}

type Layer struct {
	MediaType string `json:"mediaType"`
	Digest    string `json:"digest"`
	Size      int    `json:"size"`
}

Michael Yang's avatar
Michael Yang committed
95
type LayerReader struct {
96
	Layer
Michael Yang's avatar
Michael Yang committed
97
	io.Reader
98
99
100
101
102
103
104
105
106
107
108
109
110
}

type ConfigV2 struct {
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
	RootFS       RootFS `json:"rootfs"`
}

type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Patrick Devine's avatar
Patrick Devine committed
111
112
113
114
115
116
117
118
119
func (m *ManifestV2) GetTotalSize() int {
	var total int
	for _, layer := range m.Layers {
		total += layer.Size
	}
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
120
121
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
122
123
124
	if err != nil {
		return nil, err
	}
125

126
127
	if _, err = os.Stat(fp); err != nil {
		return nil, err
128
129
130
131
	}

	var manifest *ManifestV2

132
	bts, err := os.ReadFile(fp)
133
134
135
136
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

137
	if err := json.Unmarshal(bts, &manifest); err != nil {
138
139
140
141
142
143
144
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
145
146
147
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
148
149
150
151
152
	if err != nil {
		return nil, err
	}

	model := &Model{
153
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
154
		Digest: manifest.Config.Digest,
155
156
157
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
158
		filename, err := GetBlobsPath(layer.Digest)
159
160
161
162
		if err != nil {
			return nil, err
		}

163
164
165
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
166
167
168
169
170
171
172
173
174
175
		case "application/vnd.ollama.image.embed":
			file, err := os.Open(filename)
			if err != nil {
				return nil, fmt.Errorf("failed to open file: %s", filename)
			}
			defer file.Close()

			if err = json.NewDecoder(file).Decode(&model.Embeddings); err != nil {
				return nil, err
			}
176
177
178
179
180
181
182
183
184
		case "application/vnd.ollama.image.template":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
		case "application/vnd.ollama.image.system":
			bts, err := os.ReadFile(filename)
185
186
187
			if err != nil {
				return nil, err
			}
188
189

			model.System = string(bts)
190
191
192
193
194
195
196
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
197
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
198
199
200
201
202
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
203

204
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
205
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
206
207
				return nil, err
			}
208
209
210
211
212
213
		}
	}

	return model, nil
}

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
func filenameWithPath(path, f string) (string, error) {
	// if filePath starts with ~/, replace it with the user's home directory.
	if strings.HasPrefix(f, "~/") {
		parts := strings.Split(f, "/")
		home, err := os.UserHomeDir()
		if err != nil {
			return "", fmt.Errorf("failed to open file: %v", err)
		}

		f = filepath.Join(home, filepath.Join(parts[1:]...))
	}

	// if filePath is not an absolute path, make it relative to the modelfile path
	if !filepath.IsAbs(f) {
		f = filepath.Join(filepath.Dir(path), f)
	}

	return f, nil
}

234
func CreateModel(ctx context.Context, name string, path string, fn func(resp api.ProgressResponse)) error {
235
236
	mf, err := os.Open(path)
	if err != nil {
237
		fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
238
		return fmt.Errorf("failed to open file: %w", err)
239
	}
240
	defer mf.Close()
241

242
	fn(api.ProgressResponse{Status: "parsing modelfile"})
243
244
245
246
247
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
248
	var layers []*LayerReader
249
	params := make(map[string][]string)
250
	embed := EmbeddingParams{fn: fn, opts: api.DefaultOptions()}
251
	for _, c := range commands {
252
		log.Printf("[%s] - %s\n", c.Name, c.Args)
253
254
		switch c.Name {
		case "model":
255
			fn(api.ProgressResponse{Status: "looking for model"})
256
			embed.model = c.Args
257
			mf, err := GetManifest(ParseModelPath(c.Args))
258
			if err != nil {
259
260
261
				modelFile, err := filenameWithPath(path, c.Args)
				if err != nil {
					return err
262
				}
263
				if _, err := os.Stat(modelFile); err != nil {
264
265
266
					// the model file does not exist, try pulling it
					if errors.Is(err, os.ErrNotExist) {
						fn(api.ProgressResponse{Status: "pulling model file"})
267
						if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
268
269
							return err
						}
270
						mf, err = GetManifest(ParseModelPath(c.Args))
271
272
273
274
275
276
277
278
279
						if err != nil {
							return fmt.Errorf("failed to open file after pull: %v", err)
						}
					} else {
						return err
					}
				} else {
					// create a model from this specified file
					fn(api.ProgressResponse{Status: "creating model layer"})
280
					file, err := os.Open(modelFile)
281
282
283
284
285
286
287
288
289
290
291
					if err != nil {
						return fmt.Errorf("failed to open file: %v", err)
					}
					defer file.Close()

					l, err := CreateLayer(file)
					if err != nil {
						return fmt.Errorf("failed to create layer: %v", err)
					}
					l.MediaType = "application/vnd.ollama.image.model"
					layers = append(layers, l)
292
				}
293
294
			}
			if mf != nil {
295
296
297
298
299
300
301
302
303
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
304
305
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
306
307
308
			if err != nil {
				return err
			}
309
			embed.files = append(embed.files, embedFilePath)
Bruce MacDonald's avatar
Bruce MacDonald committed
310
311
312
313
314
315
316
317
318
319
320
321
		case "license":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

			layer, err := CreateLayer(strings.NewReader(c.Args))
			if err != nil {
				return err
			}

			layer.MediaType = mediaType
			layers = append(layers, layer)
		case "template", "system", "prompt":
322
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
323
			// remove the prompt layer if one exists
324
325
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
326

327
			layer, err := CreateLayer(strings.NewReader(c.Args))
328
			if err != nil {
329
				return err
330
			}
331
332
333

			layer.MediaType = mediaType
			layers = append(layers, layer)
334
		default:
335
336
			// runtime parameters, build a list of args for each parameter to allow multiple values to be specified (ex: multiple stop tokens)
			params[c.Name] = append(params[c.Name], c.Args)
337
338
339
340
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
341
	if len(params) > 0 {
342
		fn(api.ProgressResponse{Status: "creating parameter layer"})
343
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
344
		formattedParams, err := formatParams(params)
345
346
347
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
348
349
350
351
352
353
354

		bts, err := json.Marshal(formattedParams)
		if err != nil {
			return err
		}

		l, err := CreateLayer(bytes.NewReader(bts))
355
356
357
358
359
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
360
361
362
363

		// apply these parameters to the embedding options, in case embeddings need to be generated using this model
		embed.opts = api.DefaultOptions()
		embed.opts.FromMap(formattedParams)
364
365
	}

366
367
368
369
370
371
372
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

373
374
375
376
377
378
379
380
381
382
383
	digests, err := getLayerDigests(layers)
	if err != nil {
		return err
	}

	var manifestLayers []*Layer
	for _, l := range layers {
		manifestLayers = append(manifestLayers, &l.Layer)
	}

	// Create a layer for the config object
384
	fn(api.ProgressResponse{Status: "creating config layer"})
385
386
387
388
389
390
391
392
393
394
395
396
	cfg, err := createConfigLayer(digests)
	if err != nil {
		return err
	}
	layers = append(layers, cfg)

	err = SaveLayers(layers, fn, false)
	if err != nil {
		return err
	}

	// Create the manifest
397
	fn(api.ProgressResponse{Status: "writing manifest"})
398
399
400
401
402
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

403
	fn(api.ProgressResponse{Status: "success"})
404
405
406
	return nil
}

407
408
409
410
411
412
413
414
415
416
417
type EmbeddingParams struct {
	model string
	opts  api.Options
	files []string // paths to files to embed
	fn    func(resp api.ProgressResponse)
}

// embeddingLayers loads the associated LLM and generates the embeddings to be stored from an input file
func embeddingLayers(e EmbeddingParams) ([]*LayerReader, error) {
	layers := []*LayerReader{}
	if len(e.files) > 0 {
418
419
420
421
422
423
424
425
426
427
428
		if _, err := os.Stat(e.model); err != nil {
			if os.IsNotExist(err) {
				// this is a model name rather than the file
				model, err := GetModel(e.model)
				if err != nil {
					return nil, fmt.Errorf("failed to get model to generate embeddings: %v", err)
				}
				e.model = model.ModelPath
			} else {
				return nil, fmt.Errorf("failed to get model file to generate embeddings: %v", err)
			}
429
430
431
		}

		e.opts.EmbeddingOnly = true
432
		llm, err := llama.New(e.model, e.opts)
433
434
435
		if err != nil {
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
436
437
438
439
440
		defer func() {
			if llm != nil {
				llm.Close()
			}
		}()
441

Bruce MacDonald's avatar
Bruce MacDonald committed
442
443
444
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
445
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
446
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
447
448
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
449
450
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
451
452
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
453
454
455
				addedFiles[filePath] = true
				// TODO: check file type
				f, err := os.Open(filePath)
456
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
457
					return nil, fmt.Errorf("could not open embed file: %w", err)
458
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
				scanner := bufio.NewScanner(f)
				scanner.Split(bufio.ScanLines)

				data := []string{}
				for scanner.Scan() {
					data = append(data, scanner.Text())
				}
				f.Close()

				// the digest of the file is set here so that the client knows a new operation is in progress
				fileDigest, _ := GetSHA256Digest(bytes.NewReader([]byte(filePath)))

				embeddings := []vector.Embedding{}
				for i, d := range data {
					if strings.TrimSpace(d) == "" {
						continue
					}
					e.fn(api.ProgressResponse{
						Status:    fmt.Sprintf("creating embeddings for file %s", filePath),
						Digest:    fileDigest,
						Total:     len(data) - 1,
						Completed: i,
					})
					embed, err := llm.Embedding(d)
					if err != nil {
484
485
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
Bruce MacDonald's avatar
Bruce MacDonald committed
486
487
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
488
489
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
490
491
492
493
494
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
495

Bruce MacDonald's avatar
Bruce MacDonald committed
496
497
498
499
500
				digest, size := GetSHA256Digest(r)
				// Reset the position of the reader after calculating the digest
				if _, err := r.Seek(0, io.SeekStart); err != nil {
					return nil, fmt.Errorf("could not reset embed reader: %w", err)
				}
501

Bruce MacDonald's avatar
Bruce MacDonald committed
502
503
504
505
506
507
508
509
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
						Size:      size,
					},
					Reader: r,
				}
510

Bruce MacDonald's avatar
Bruce MacDonald committed
511
512
				layers = append(layers, layer)
			}
513
514
515
516
517
		}
	}
	return layers, nil
}

Michael Yang's avatar
Michael Yang committed
518
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
519
520
521
522
523
524
525
526
527
528
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

529
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
530
531
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
532
		fp, err := GetBlobsPath(layer.Digest)
533
534
535
		if err != nil {
			return err
		}
536
537
538

		_, err = os.Stat(fp)
		if os.IsNotExist(err) || force {
539
540
			fn(api.ProgressResponse{Status: fmt.Sprintf("writing layer %s", layer.Digest)})

541
542
543
544
545
546
547
			out, err := os.Create(fp)
			if err != nil {
				log.Printf("couldn't create %s", fp)
				return err
			}
			defer out.Close()

Michael Yang's avatar
Michael Yang committed
548
			if _, err = io.Copy(out, layer.Reader); err != nil {
549
550
				return err
			}
Michael Yang's avatar
Michael Yang committed
551

552
		} else {
553
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
554
555
556
557
558
559
		}
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
560
func CreateManifest(name string, cfg *LayerReader, layers []*Layer) error {
Patrick Devine's avatar
Patrick Devine committed
561
562
	mp := ParseModelPath(name)

563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
	manifest := ManifestV2{
		SchemaVersion: 2,
		MediaType:     "application/vnd.docker.distribution.manifest.v2+json",
		Config: Layer{
			MediaType: cfg.MediaType,
			Size:      cfg.Size,
			Digest:    cfg.Digest,
		},
		Layers: layers,
	}

	manifestJSON, err := json.Marshal(manifest)
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
579
	fp, err := mp.GetManifestPath(true)
580
581
582
	if err != nil {
		return err
	}
583
	return os.WriteFile(fp, manifestJSON, 0o644)
584
585
}

Michael Yang's avatar
Michael Yang committed
586
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
587
	fp, err := GetBlobsPath(layer.Digest)
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
	if err != nil {
		return nil, err
	}

	file, err := os.Open(fp)
	if err != nil {
		return nil, fmt.Errorf("could not open blob: %w", err)
	}
	defer file.Close()

	newLayer, err := CreateLayer(file)
	if err != nil {
		return nil, err
	}
	newLayer.MediaType = layer.MediaType
	return newLayer, nil
}

606
607
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
608
609
610
	opts := api.Options{}
	valueOpts := reflect.ValueOf(&opts).Elem() // names of the fields in the options struct
	typeOpts := reflect.TypeOf(opts)           // types of the fields in the options struct
Michael Yang's avatar
Michael Yang committed
611

612
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
613
614
615
616
617
618
619
620
	jsonOpts := make(map[string]reflect.StructField)
	for _, field := range reflect.VisibleFields(typeOpts) {
		jsonTag := strings.Split(field.Tag.Get("json"), ",")[0]
		if jsonTag != "" {
			jsonOpts[jsonTag] = field
		}
	}

621
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
622
	// iterate params and set values based on json struct tags
623
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
624
625
626
627
628
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
629
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
630
					if err != nil {
631
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
632
633
					}

634
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
635
				case reflect.Int:
636
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
637
					if err != nil {
638
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
639
640
					}

641
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
642
				case reflect.Bool:
643
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
644
					if err != nil {
645
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
646
647
					}

648
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
649
				case reflect.String:
650
					out[key] = vals[0]
651
				case reflect.Slice:
652
653
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
654
655
656
657
658
659
660
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

661
	return out, nil
662
663
}

Michael Yang's avatar
Michael Yang committed
664
func getLayerDigests(layers []*LayerReader) ([]string, error) {
665
666
667
668
669
670
671
672
673
674
675
	var digests []string
	for _, l := range layers {
		if l.Digest == "" {
			return nil, fmt.Errorf("layer is missing a digest")
		}
		digests = append(digests, l.Digest)
	}
	return digests, nil
}

// CreateLayer creates a Layer object from a given file
Michael Yang's avatar
Michael Yang committed
676
677
678
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
	f.Seek(0, 0)
679

Michael Yang's avatar
Michael Yang committed
680
	layer := &LayerReader{
681
682
683
684
685
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
686
		Reader: f,
687
688
689
690
691
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
692
693
694
695
696
697
698
699
700
701
702
func CopyModel(src, dest string) error {
	srcPath, err := ParseModelPath(src).GetManifestPath(false)
	if err != nil {
		return err
	}
	destPath, err := ParseModelPath(dest).GetManifestPath(true)
	if err != nil {
		return err
	}

	// copy the file
Michael Yang's avatar
Michael Yang committed
703
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
704
705
706
707
708
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
709
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
710
711
712
713
714
715
716
717
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

718
func DeleteModel(name string) error {
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
	if err != nil {
		return err
	}
	deleteMap := make(map[string]bool)
	for _, layer := range manifest.Layers {
		deleteMap[layer.Digest] = true
	}
	deleteMap[manifest.Config.Digest] = true

	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
	err = filepath.Walk(fp, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}
		if !info.IsDir() {
			path := path[len(fp)+1:]
			slashIndex := strings.LastIndex(path, "/")
			if slashIndex == -1 {
				return nil
			}
			tag := path[:slashIndex] + ":" + path[slashIndex+1:]
			fmp := ParseModelPath(tag)

			// skip the manifest we're trying to delete
			if mp.GetFullTagname() == fmp.GetFullTagname() {
				return nil
			}

			// save (i.e. delete from the deleteMap) any files used in other manifests
			manifest, err := GetManifest(fmp)
			if err != nil {
				log.Printf("skipping file: %s", fp)
				return nil
			}
			for _, layer := range manifest.Layers {
				delete(deleteMap, layer.Digest)
			}
			delete(deleteMap, manifest.Config.Digest)
		}
		return nil
	})
Michael Yang's avatar
Michael Yang committed
766
767
768
	if err != nil {
		return err
	}
769

Michael Yang's avatar
Michael Yang committed
770
771
772
773
	if err != nil {
		return err
	}

774
775
776
	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
777
			fp, err := GetBlobsPath(k)
778
			if err != nil {
779
780
781
782
783
				log.Printf("couldn't get file path for '%s': %v", k, err)
				continue
			}
			if err := os.Remove(fp); err != nil {
				log.Printf("couldn't remove file '%s': %v", fp, err)
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
				continue
			}
		}
	}

	fp, err = mp.GetManifestPath(false)
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
		log.Printf("couldn't remove manifest file '%s': %v", fp, err)
		return err
	}

	return nil
}

802
func PushModel(name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
803
804
	mp := ParseModelPath(name)

805
806
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
807
	manifest, err := GetManifest(mp)
808
	if err != nil {
809
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
810
811
812
813
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
814
	layers = append(layers, manifest.Layers...)
815
816
817
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
818
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
819
820
821
822
823
		if err != nil {
			return err
		}

		if exists {
824
825
826
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
827
828
				Total:     layer.Size,
				Completed: layer.Size,
829
			})
830
			log.Printf("Layer %s already exists", layer.Digest)
831
832
833
			continue
		}

834
		fn(api.ProgressResponse{
835
836
837
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
838
		})
839

840
		location, err := startUpload(mp, regOpts)
841
842
843
844
845
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

846
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
847
848
849
850
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
851
852
	}

853
	fn(api.ProgressResponse{Status: "pushing manifest"})
854
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
855
856
857
858
859
860
861
862
863
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

	manifestJSON, err := json.Marshal(manifest)
	if err != nil {
		return err
	}

864
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
865
866
867
868
869
870
871
872
	if err != nil {
		return err
	}
	defer resp.Body.Close()

	// Check for success: For a successful upload, the Docker registry will respond with a 201 Created
	if resp.StatusCode != http.StatusCreated {
		body, _ := io.ReadAll(resp.Body)
873
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
874
875
	}

876
	fn(api.ProgressResponse{Status: "success"})
877
878
879
880

	return nil
}

881
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
882
	mp := ParseModelPath(name)
883

884
	fn(api.ProgressResponse{Status: "pulling manifest"})
885

886
	manifest, err := pullModelManifest(mp, regOpts)
887
	if err != nil {
888
		return fmt.Errorf("pull model manifest: %s", err)
889
890
891
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
892
	layers = append(layers, manifest.Layers...)
893
894
895
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
896
		if err := downloadBlob(ctx, mp, layer.Digest, regOpts, fn); err != nil {
897
898
899
900
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
901
902
903
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
904
905
906
907
908
909
910
911
912
913
914
			if errors.Is(err, errDigestMismatch) {
				// something went wrong, delete the blob
				fp, err := GetBlobsPath(layer.Digest)
				if err != nil {
					return err
				}
				if err := os.Remove(fp); err != nil {
					// log this, but return the original error
					log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
				}
			}
Michael Yang's avatar
Michael Yang committed
915
916
917
918
			return err
		}
	}

919
	fn(api.ProgressResponse{Status: "writing manifest"})
920

921
	manifestJSON, err := json.Marshal(manifest)
922
923
924
925
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
926
	fp, err := mp.GetManifestPath(true)
927
928
929
930
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
931
	err = os.WriteFile(fp, manifestJSON, 0o644)
932
933
934
935
936
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

937
	fn(api.ProgressResponse{Status: "success"})
938
939
940
941

	return nil
}

942
943
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
944
945
946
947
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

948
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
949
950
951
952
953
954
955
956
	if err != nil {
		log.Printf("couldn't get manifest: %v", err)
		return nil, err
	}
	defer resp.Body.Close()

	// Check for success: For a successful upload, the Docker registry will respond with a 201 Created
	if resp.StatusCode != http.StatusOK {
957
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
958
			return nil, fmt.Errorf("model not found")
959
		}
960
		body, _ := io.ReadAll(resp.Body)
961
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
962
963
964
965
966
967
968
969
970
971
	}

	var m *ManifestV2
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

	return m, err
}

Michael Yang's avatar
Michael Yang committed
972
func createConfigLayer(layers []string) (*LayerReader, error) {
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
	// TODO change architecture and OS
	config := ConfigV2{
		Architecture: "arm64",
		OS:           "linux",
		RootFS: RootFS{
			Type:    "layers",
			DiffIDs: layers,
		},
	}

	configJSON, err := json.Marshal(config)
	if err != nil {
		return nil, err
	}

988
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
989

Michael Yang's avatar
Michael Yang committed
990
	layer := &LayerReader{
991
992
993
994
995
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
996
		Reader: bytes.NewBuffer(configJSON),
997
998
999
1000
1001
	}
	return layer, nil
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
1002
1003
1004
1005
1006
1007
1008
1009
func GetSHA256Digest(r io.Reader) (string, int) {
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

	return fmt.Sprintf("sha256:%x", h.Sum(nil)), int(n)
1010
1011
}

1012
1013
func startUpload(mp ModelPath, regOpts *RegistryOptions) (string, error) {
	url := fmt.Sprintf("%s/v2/%s/blobs/uploads/", mp.Registry, mp.GetNamespaceRepository())
1014

1015
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
1016
1017
1018
1019
1020
1021
1022
1023
1024
	if err != nil {
		log.Printf("couldn't start upload: %v", err)
		return "", err
	}
	defer resp.Body.Close()

	// Check for success
	if resp.StatusCode != http.StatusAccepted {
		body, _ := io.ReadAll(resp.Body)
1025
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
	}

	// Extract UUID location from header
	location := resp.Header.Get("Location")
	if location == "" {
		return "", fmt.Errorf("location header is missing in response")
	}

	return location, nil
}

// Function to check if a blob already exists in the Docker registry
1038
1039
func checkBlobExistence(mp ModelPath, digest string, regOpts *RegistryOptions) (bool, error) {
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1040

1041
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
	if err != nil {
		log.Printf("couldn't check for blob: %v", err)
		return false, err
	}
	defer resp.Body.Close()

	// Check for success: If the blob exists, the Docker registry will respond with a 200 OK
	return resp.StatusCode == http.StatusOK, nil
}

Michael Yang's avatar
Michael Yang committed
1052
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1053
1054
1055
1056
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
1057
	fp, err := GetBlobsPath(layer.Digest)
1058
1059
1060
1061
	if err != nil {
		return err
	}

1062
1063
1064
1065
1066
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
	totalUploaded := 0

	r, w := io.Pipe()
	defer r.Close()

	go func() {
		defer w.Close()
		for {
			n, err := io.CopyN(w, f, 1024*1024)
			if err != nil && !errors.Is(err, io.EOF) {
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error copying pipe: %v", err),
					Digest:    layer.Digest,
					Total:     layer.Size,
					Completed: totalUploaded,
				})
				return
			}
1085

1086
			totalUploaded += int(n)
1087
1088

			fn(api.ProgressResponse{
1089
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1090
				Digest:    layer.Digest,
1091
1092
				Total:     layer.Size,
				Completed: totalUploaded,
1093
			})
1094
1095
1096
1097

			if totalUploaded >= layer.Size {
				return
			}
1098
		}
1099
	}()
1100

1101
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1102

1103
1104
1105
1106
	headers := make(map[string]string)
	headers["Content-Type"] = "application/octet-stream"
	headers["Content-Range"] = fmt.Sprintf("0-%d", layer.Size-1)
	headers["Content-Length"] = strconv.Itoa(int(layer.Size))
1107

1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
	// finish the upload
	resp, err := makeRequest("PUT", url, headers, r, regOpts)
	if err != nil {
		log.Printf("couldn't finish upload: %v", err)
		return err
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusCreated {
		body, _ := io.ReadAll(resp.Body)
		return fmt.Errorf("on finish upload registry responded with code %d: %v", resp.StatusCode, string(body))
1119
	}
1120
1121
1122
	return nil
}

1123
1124
1125
1126
1127
1128
1129
1130
1131
func makeRequest(method, url string, headers map[string]string, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
	if !strings.HasPrefix(url, "http") {
		if regOpts.Insecure {
			url = "http://" + url
		} else {
			url = "https://" + url
		}
	}

1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
	req, err := http.NewRequest(method, url, body)
	if err != nil {
		return nil, err
	}

	for k, v := range headers {
		req.Header.Set(k, v)
	}

	// TODO: better auth
1142
1143
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
	}

	client := &http.Client{
		CheckRedirect: func(req *http.Request, via []*http.Request) error {
			if len(via) >= 10 {
				return fmt.Errorf("too many redirects")
			}
			log.Printf("redirected to: %s\n", req.URL)
			return nil
		},
	}
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}

	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1162

1163
1164
var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")

Michael Yang's avatar
Michael Yang committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
func verifyBlob(digest string) error {
	fp, err := GetBlobsPath(digest)
	if err != nil {
		return err
	}

	f, err := os.Open(fp)
	if err != nil {
		return err
	}
	defer f.Close()

	fileDigest, _ := GetSHA256Digest(f)
	if digest != fileDigest {
1179
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1180
1181
1182
1183
	}

	return nil
}