images.go 28.7 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/llm"
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
}

type ConfigV2 struct {
101
102
103
104
105
106
	ModelFamily llm.ModelFamily `json:"model_family"`
	ModelType   llm.ModelType   `json:"model_type"`
	FileType    llm.FileType    `json:"file_type"`
	RootFS      RootFS          `json:"rootfs"`

	// required by spec
107
108
109
110
111
112
113
114
115
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
}

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

Patrick Devine's avatar
Patrick Devine committed
116
117
118
119
120
121
122
123
124
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
125
126
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
127
128
129
	if err != nil {
		return nil, err
	}
130

131
132
	if _, err = os.Stat(fp); err != nil {
		return nil, err
133
134
135
136
	}

	var manifest *ManifestV2

137
	bts, err := os.ReadFile(fp)
138
139
140
141
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

142
	if err := json.Unmarshal(bts, &manifest); err != nil {
143
144
145
146
147
148
149
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
150
151
152
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
153
154
155
156
157
	if err != nil {
		return nil, err
	}

	model := &Model{
158
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
159
		Digest: manifest.Config.Digest,
160
161
162
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
163
		filename, err := GetBlobsPath(layer.Digest)
164
165
166
167
		if err != nil {
			return nil, err
		}

168
169
170
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
171
172
173
174
175
176
177
178
179
180
		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
			}
181
182
183
184
185
186
187
188
189
		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)
190
191
192
			if err != nil {
				return nil, err
			}
193
194

			model.System = string(bts)
195
196
197
198
199
200
201
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
202
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
203
204
205
206
207
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
208

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

	return model, nil
}

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
}

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

247
	fn(api.ProgressResponse{Status: "parsing modelfile"})
248
249
250
251
252
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

253
254
255
256
257
	config := ConfigV2{
		Architecture: "amd64",
		OS:           "linux",
	}

Michael Yang's avatar
Michael Yang committed
258
	var layers []*LayerReader
259
	params := make(map[string][]string)
260
	embed := EmbeddingParams{fn: fn, opts: api.DefaultOptions()}
261
	for _, c := range commands {
262
		log.Printf("[%s] - %s\n", c.Name, c.Args)
263
264
		switch c.Name {
		case "model":
265
			fn(api.ProgressResponse{Status: "looking for model"})
266
			embed.model = c.Args
267
			mf, err := GetManifest(ParseModelPath(c.Args))
268
			if err != nil {
269
270
271
				modelFile, err := filenameWithPath(path, c.Args)
				if err != nil {
					return err
272
				}
273
				if _, err := os.Stat(modelFile); err != nil {
274
275
276
					// the model file does not exist, try pulling it
					if errors.Is(err, os.ErrNotExist) {
						fn(api.ProgressResponse{Status: "pulling model file"})
277
						if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
278
279
							return err
						}
280
						mf, err = GetManifest(ParseModelPath(c.Args))
281
282
283
284
285
286
287
288
289
						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"})
290
					file, err := os.Open(modelFile)
291
292
293
294
295
					if err != nil {
						return fmt.Errorf("failed to open file: %v", err)
					}
					defer file.Close()

296
297
298
299
300
301
302
303
304
305
306
307
					ggml, err := llm.DecodeGGML(file, llm.ModelFamilyLlama)
					if err != nil {
						return err
					}

					config.ModelFamily = ggml.ModelFamily
					config.ModelType = ggml.ModelType
					config.FileType = ggml.FileType

					// reset the file
					file.Seek(0, io.SeekStart)

308
309
310
311
312
313
					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)
314
				}
315
			}
316

317
			if mf != nil {
318
319
320
321
322
323
324
325
326
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
327
328
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
329
330
331
			if err != nil {
				return err
			}
332
			embed.files = append(embed.files, embedFilePath)
Bruce MacDonald's avatar
Bruce MacDonald committed
333
334
335
336
337
338
339
340
341
342
343
344
		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":
345
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
346
			// remove the layer if one exists
347
348
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
349

350
			layer, err := CreateLayer(strings.NewReader(c.Args))
351
			if err != nil {
352
				return err
353
			}
354
355
356

			layer.MediaType = mediaType
			layers = append(layers, layer)
357
		default:
358
359
			// 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)
360
361
362
363
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
364
	if len(params) > 0 {
365
		fn(api.ProgressResponse{Status: "creating parameter layer"})
366
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
367
		formattedParams, err := formatParams(params)
368
369
370
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
371
372
373
374
375
376
377

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

		l, err := CreateLayer(bytes.NewReader(bts))
378
379
380
381
382
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
383
384
385
386

		// 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)
387
388
	}

389
390
391
392
393
394
395
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

396
397
398
399
400
401
402
403
404
405
406
	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
407
	fn(api.ProgressResponse{Status: "creating config layer"})
408
	cfg, err := createConfigLayer(config, digests)
409
410
411
412
413
414
415
416
417
418
419
	if err != nil {
		return err
	}
	layers = append(layers, cfg)

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

	// Create the manifest
420
	fn(api.ProgressResponse{Status: "writing manifest"})
421
422
423
424
425
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

426
	fn(api.ProgressResponse{Status: "success"})
427
428
429
	return nil
}

430
431
432
433
434
435
436
437
438
439
440
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 {
441
442
443
444
445
446
447
448
449
450
451
		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)
			}
452
453
454
		}

		e.opts.EmbeddingOnly = true
455
		llmModel, err := llm.New(e.model, e.opts)
456
457
458
		if err != nil {
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
459
		defer func() {
460
461
			if llmModel != nil {
				llmModel.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
462
463
			}
		}()
464

Bruce MacDonald's avatar
Bruce MacDonald committed
465
466
467
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
468
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
469
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
470
471
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
472
473
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
474
475
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
476
477
478
				addedFiles[filePath] = true
				// TODO: check file type
				f, err := os.Open(filePath)
479
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
480
					return nil, fmt.Errorf("could not open embed file: %w", err)
481
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
				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,
					})
505
					embed, err := llmModel.Embedding(d)
Bruce MacDonald's avatar
Bruce MacDonald committed
506
					if err != nil {
507
508
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
Bruce MacDonald's avatar
Bruce MacDonald committed
509
510
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
511
512
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
513
514
515
516
517
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
518

Bruce MacDonald's avatar
Bruce MacDonald committed
519
520
521
522
523
				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)
				}
524

Bruce MacDonald's avatar
Bruce MacDonald committed
525
526
527
528
529
530
531
532
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
						Size:      size,
					},
					Reader: r,
				}
533

Bruce MacDonald's avatar
Bruce MacDonald committed
534
535
				layers = append(layers, layer)
			}
536
537
538
539
540
		}
	}
	return layers, nil
}

Michael Yang's avatar
Michael Yang committed
541
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
542
543
544
545
546
547
548
549
550
551
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

552
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
553
554
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
555
		fp, err := GetBlobsPath(layer.Digest)
556
557
558
		if err != nil {
			return err
		}
559
560
561

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

564
565
566
567
568
569
570
			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
571
			if _, err = io.Copy(out, layer.Reader); err != nil {
572
573
				return err
			}
Michael Yang's avatar
Michael Yang committed
574

575
		} else {
576
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
577
578
579
580
581
582
		}
	}

	return nil
}

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

586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
	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
602
	fp, err := mp.GetManifestPath(true)
603
604
605
	if err != nil {
		return err
	}
606
	return os.WriteFile(fp, manifestJSON, 0o644)
607
608
}

Michael Yang's avatar
Michael Yang committed
609
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
610
	fp, err := GetBlobsPath(layer.Digest)
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
	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
}

629
630
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
631
632
633
	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
634

635
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
636
637
638
639
640
641
642
643
	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
		}
	}

644
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
645
	// iterate params and set values based on json struct tags
646
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
647
648
649
650
651
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
652
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
653
					if err != nil {
654
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
655
656
					}

657
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
658
				case reflect.Int:
659
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
660
					if err != nil {
661
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
662
663
					}

664
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
665
				case reflect.Bool:
666
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
667
					if err != nil {
668
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
669
670
					}

671
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
672
				case reflect.String:
673
					out[key] = vals[0]
674
				case reflect.Slice:
675
676
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
677
678
679
680
681
682
683
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

684
	return out, nil
685
686
}

Michael Yang's avatar
Michael Yang committed
687
func getLayerDigests(layers []*LayerReader) ([]string, error) {
688
689
690
691
692
693
694
695
696
697
698
	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
699
700
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
701
	f.Seek(0, io.SeekStart)
702

Michael Yang's avatar
Michael Yang committed
703
	layer := &LayerReader{
704
705
706
707
708
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
709
		Reader: f,
710
711
712
713
714
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
715
716
717
718
719
720
721
722
723
724
725
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
726
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
727
728
729
730
731
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
732
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
733
734
735
736
737
738
739
740
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

741
func DeleteModel(name string) error {
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
	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
789
790
791
	if err != nil {
		return err
	}
792
793
794
795

	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
796
			fp, err := GetBlobsPath(k)
797
			if err != nil {
798
799
800
801
802
				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)
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
				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
}

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

824
825
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
826
	manifest, err := GetManifest(mp)
827
	if err != nil {
828
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
829
830
831
832
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
833
	layers = append(layers, manifest.Layers...)
834
835
836
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
837
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
838
839
840
841
842
		if err != nil {
			return err
		}

		if exists {
843
844
845
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
846
847
				Total:     layer.Size,
				Completed: layer.Size,
848
			})
849
			log.Printf("Layer %s already exists", layer.Digest)
850
851
852
			continue
		}

853
		fn(api.ProgressResponse{
854
855
856
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
857
		})
858

859
		location, err := startUpload(mp, regOpts)
860
861
862
863
864
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

865
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
866
867
868
869
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
870
871
	}

872
	fn(api.ProgressResponse{Status: "pushing manifest"})
873
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
874
875
876
877
878
879
880
881
882
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

883
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
884
885
886
887
888
889
890
891
	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)
892
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
893
894
	}

895
	fn(api.ProgressResponse{Status: "success"})
896
897
898
899

	return nil
}

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

903
	fn(api.ProgressResponse{Status: "pulling manifest"})
904

905
	manifest, err := pullModelManifest(mp, regOpts)
906
	if err != nil {
907
		return fmt.Errorf("pull model manifest: %s", err)
908
909
910
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
911
	layers = append(layers, manifest.Layers...)
912
913
914
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
915
		if err := downloadBlob(ctx, mp, layer.Digest, regOpts, fn); err != nil {
916
917
918
919
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
920
921
922
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
923
924
925
926
927
928
929
930
931
932
933
			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
934
935
936
937
			return err
		}
	}

938
	fn(api.ProgressResponse{Status: "writing manifest"})
939

940
	manifestJSON, err := json.Marshal(manifest)
941
942
943
944
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
945
	fp, err := mp.GetManifestPath(true)
946
947
948
949
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
950
	err = os.WriteFile(fp, manifestJSON, 0o644)
951
952
953
954
955
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

956
	fn(api.ProgressResponse{Status: "success"})
957
958
959
960

	return nil
}

961
962
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
963
964
965
966
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

967
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
968
969
970
971
972
973
974
975
	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 {
976
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
977
			return nil, fmt.Errorf("model not found")
978
		}
979
		body, _ := io.ReadAll(resp.Body)
980
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
981
982
983
984
985
986
987
988
989
990
	}

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

	return m, err
}

991
992
993
994
func createConfigLayer(config ConfigV2, layers []string) (*LayerReader, error) {
	config.RootFS = RootFS{
		Type:    "layers",
		DiffIDs: layers,
995
996
997
998
999
1000
1001
	}

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

1002
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
1003

Michael Yang's avatar
Michael Yang committed
1004
	layer := &LayerReader{
1005
1006
1007
1008
1009
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
1010
		Reader: bytes.NewBuffer(configJSON),
1011
1012
1013
1014
1015
	}
	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
1016
1017
1018
1019
1020
1021
1022
1023
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)
1024
1025
}

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

1029
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
1030
1031
1032
1033
1034
1035
1036
1037
1038
	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)
1039
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
	}

	// 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
1052
1053
func checkBlobExistence(mp ModelPath, digest string, regOpts *RegistryOptions) (bool, error) {
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1054

1055
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
	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
1066
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1067
1068
1069
1070
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
1071
	fp, err := GetBlobsPath(layer.Digest)
1072
1073
1074
1075
	if err != nil {
		return err
	}

1076
1077
1078
1079
1080
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
	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
			}
1099

1100
			totalUploaded += int(n)
1101
1102

			fn(api.ProgressResponse{
1103
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1104
				Digest:    layer.Digest,
1105
1106
				Total:     layer.Size,
				Completed: totalUploaded,
1107
			})
1108
1109
1110
1111

			if totalUploaded >= layer.Size {
				return
			}
1112
		}
1113
	}()
1114

1115
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1116

1117
1118
1119
1120
	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))
1121

1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
	// 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))
1133
	}
1134
1135
1136
	return nil
}

1137
1138
1139
1140
1141
1142
1143
1144
1145
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
		}
	}

1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
	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
1156
1157
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
	}

	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
1176

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

Michael Yang's avatar
Michael Yang committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
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 {
1193
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1194
1195
1196
1197
	}

	return nil
}