images.go 33.1 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
const MaxRetries = 3

29
30
31
32
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
Patrick Devine's avatar
Patrick Devine committed
33
	Token    string
34
35
}

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

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

	tmpl, err := template.New("").Parse(t)
54
55
56
57
58
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
59
		First  bool
60
61
		System string
		Prompt string
62
		Embed  string
63
64
65

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

Michael Yang's avatar
Michael Yang committed
68
	vars.First = len(request.Context) == 0
69
70
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
71
	vars.Context = request.Context
Bruce MacDonald's avatar
Bruce MacDonald committed
72
	vars.Embed = embedding
73

74
75
76
77
	if request.System != "" {
		vars.System = request.System
	}

78
79
80
81
82
83
84
85
	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

86
87
88
89
90
91
92
93
94
95
96
97
98
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
99
type LayerReader struct {
100
	Layer
Michael Yang's avatar
Michael Yang committed
101
	io.Reader
102
103
104
}

type ConfigV2 struct {
105
106
107
108
109
110
	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
111
112
113
114
115
116
117
118
119
	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
120
121
122
123
124
125
126
127
128
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
129
130
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
131
132
133
	if err != nil {
		return nil, err
	}
134

135
136
	if _, err = os.Stat(fp); err != nil {
		return nil, err
137
138
139
140
	}

	var manifest *ManifestV2

141
	bts, err := os.ReadFile(fp)
142
143
144
145
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

146
	if err := json.Unmarshal(bts, &manifest); err != nil {
147
148
149
150
151
152
153
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
154
155
156
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
157
158
159
160
161
	if err != nil {
		return nil, err
	}

	model := &Model{
162
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
163
		Digest: manifest.Config.Digest,
164
165
166
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
167
		filename, err := GetBlobsPath(layer.Digest)
168
169
170
171
		if err != nil {
			return nil, err
		}

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

			model.System = string(bts)
201
202
203
204
205
206
207
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
208
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
209
210
211
212
213
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
214

215
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
216
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
217
218
				return nil, err
			}
219
220
221
222
223
224
		}
	}

	return model, nil
}

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
}

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

253
	fn(api.ProgressResponse{Status: "parsing modelfile"})
254
255
256
257
258
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

259
260
261
262
263
	config := ConfigV2{
		Architecture: "amd64",
		OS:           "linux",
	}

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

302
303
304
305
306
307
308
309
310
311
312
313
					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)

314
315
316
317
318
319
					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)
320
				}
321
			}
322

323
			if mf != nil {
324
325
326
327
328
329
330
331
332
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
333
334
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
335
336
337
			if err != nil {
				return err
			}
338
			embed.files = append(embed.files, embedFilePath)
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
		case "adapter":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})

			fp := c.Args
			if strings.HasPrefix(fp, "~/") {
				parts := strings.Split(fp, "/")
				home, err := os.UserHomeDir()
				if err != nil {
					return fmt.Errorf("failed to open file: %v", err)
				}

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

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

			// create a model from this specified file
			fn(api.ProgressResponse{Status: "creating model layer"})

			file, err := os.Open(fp)
			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.adapter"
			layers = append(layers, l)
Bruce MacDonald's avatar
Bruce MacDonald committed
373
374
375
376
377
378
379
380
381
382
383
384
		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":
385
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
386
			// remove the layer if one exists
387
388
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
389

390
			layer, err := CreateLayer(strings.NewReader(c.Args))
391
			if err != nil {
392
				return err
393
			}
394
395
396

			layer.MediaType = mediaType
			layers = append(layers, layer)
397
		default:
398
399
			// 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)
400
401
402
403
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
404
	if len(params) > 0 {
405
		fn(api.ProgressResponse{Status: "creating parameter layer"})
406
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
407
		formattedParams, err := formatParams(params)
408
409
410
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
411
412
413
414
415
416
417

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

		l, err := CreateLayer(bytes.NewReader(bts))
418
419
420
421
422
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
423
424
425
426

		// 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)
427
428
	}

429
430
431
432
433
434
435
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

436
437
438
439
440
441
442
443
444
445
446
	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
447
	fn(api.ProgressResponse{Status: "creating config layer"})
448
	cfg, err := createConfigLayer(config, digests)
449
450
451
452
453
454
455
456
457
458
459
	if err != nil {
		return err
	}
	layers = append(layers, cfg)

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

	// Create the manifest
460
	fn(api.ProgressResponse{Status: "writing manifest"})
461
462
463
464
465
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

466
	fn(api.ProgressResponse{Status: "success"})
467
468
469
	return nil
}

470
471
472
473
474
475
476
477
478
479
480
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 {
481
482
483
484
485
486
487
488
489
490
491
		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)
			}
492
493
494
		}

		e.opts.EmbeddingOnly = true
495
		llmModel, err := llm.New(e.model, []string{}, e.opts)
496
497
498
		if err != nil {
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
499
		defer func() {
500
501
			if llmModel != nil {
				llmModel.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
502
503
			}
		}()
504

Bruce MacDonald's avatar
Bruce MacDonald committed
505
506
507
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
508
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
509
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
510
511
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
512
513
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
514
515
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
516
				addedFiles[filePath] = true
Bruce MacDonald's avatar
Bruce MacDonald committed
517
518
519
520
521
522
523
524
				// check if we already have embeddings for this file path
				layerIdentifier := fmt.Sprintf("%s:%s", filePath, e.model)
				digest, _ := GetSHA256Digest(strings.NewReader(layerIdentifier))
				existing, err := existingFileEmbeddings(digest)
				if err != nil {
					return nil, fmt.Errorf("failed to check existing embeddings for file %s: %v", filePath, err)
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
525
526
				// TODO: check file type
				f, err := os.Open(filePath)
527
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
528
					return nil, fmt.Errorf("could not open embed file: %w", err)
529
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
				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,
					})
Bruce MacDonald's avatar
Bruce MacDonald committed
553
554
555
556
557
					if len(existing[d]) > 0 {
						// already have an embedding for this line
						embeddings = append(embeddings, vector.Embedding{Data: d, Vector: existing[d]})
						continue
					}
558
					embed, err := llmModel.Embedding(d)
Bruce MacDonald's avatar
Bruce MacDonald committed
559
					if err != nil {
560
561
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
Bruce MacDonald's avatar
Bruce MacDonald committed
562
563
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
564
565
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
566
567
568
569
570
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
571

Bruce MacDonald's avatar
Bruce MacDonald committed
572
573
574
575
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
Bruce MacDonald's avatar
Bruce MacDonald committed
576
						Size:      r.Len(),
Bruce MacDonald's avatar
Bruce MacDonald committed
577
578
579
					},
					Reader: r,
				}
580

Bruce MacDonald's avatar
Bruce MacDonald committed
581
582
				layers = append(layers, layer)
			}
583
584
585
586
587
		}
	}
	return layers, nil
}

Bruce MacDonald's avatar
Bruce MacDonald committed
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
// existingFileEmbeddings checks if we already have embeddings for a file and loads them into a look-up map
func existingFileEmbeddings(digest string) (map[string][]float64, error) {
	path, err := GetBlobsPath(digest)
	if err != nil {
		return nil, fmt.Errorf("embeddings blobs path: %w", err)
	}
	existingFileEmbeddings := make(map[string][]float64)
	if _, err := os.Stat(path); err == nil {
		// already have some embeddings for this file, load embeddings previously generated
		file, err := os.Open(path)
		if err != nil {
			return nil, fmt.Errorf("failed to open existing embedding file: %s", err)
		}
		defer file.Close()

		existing := []vector.Embedding{}
		if err = json.NewDecoder(file).Decode(&existing); err != nil {
			return nil, err
		}
		for _, e := range existing {
			existingFileEmbeddings[e.Data] = e.Vector
		}
	}
	return existingFileEmbeddings, nil
}

Michael Yang's avatar
Michael Yang committed
614
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
615
616
617
618
619
620
621
622
623
624
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

625
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
626
627
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
628
		fp, err := GetBlobsPath(layer.Digest)
629
630
631
		if err != nil {
			return err
		}
632
633

		_, err = os.Stat(fp)
Bruce MacDonald's avatar
Bruce MacDonald committed
634
635
		// note: embed layers are always written since their digest doesnt indicate anything about the contents
		if os.IsNotExist(err) || force || layer.MediaType == "application/vnd.ollama.image.embed" {
636
637
			fn(api.ProgressResponse{Status: fmt.Sprintf("writing layer %s", layer.Digest)})

638
639
640
641
642
643
644
			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
645
			if _, err = io.Copy(out, layer.Reader); err != nil {
646
647
				return err
			}
Michael Yang's avatar
Michael Yang committed
648

649
		} else {
650
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
651
652
653
654
655
656
		}
	}

	return nil
}

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

660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
	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
676
	fp, err := mp.GetManifestPath(true)
677
678
679
	if err != nil {
		return err
	}
680
	return os.WriteFile(fp, manifestJSON, 0o644)
681
682
}

Michael Yang's avatar
Michael Yang committed
683
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
684
	fp, err := GetBlobsPath(layer.Digest)
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
	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
}

703
704
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
705
706
707
	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
708

709
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
710
711
712
713
714
715
716
717
	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
		}
	}

718
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
719
	// iterate params and set values based on json struct tags
720
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
721
722
723
724
725
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
726
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
727
					if err != nil {
728
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
729
730
					}

731
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
732
				case reflect.Int:
733
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
734
					if err != nil {
735
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
736
737
					}

738
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
739
				case reflect.Bool:
740
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
741
					if err != nil {
742
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
743
744
					}

745
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
746
				case reflect.String:
747
					out[key] = vals[0]
748
				case reflect.Slice:
749
750
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
751
752
753
754
755
756
757
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

758
	return out, nil
759
760
}

Michael Yang's avatar
Michael Yang committed
761
func getLayerDigests(layers []*LayerReader) ([]string, error) {
762
763
764
765
766
767
768
769
770
771
772
	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
773
774
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
775
	f.Seek(0, io.SeekStart)
776

Michael Yang's avatar
Michael Yang committed
777
	layer := &LayerReader{
778
779
780
781
782
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
783
		Reader: f,
784
785
786
787
788
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
789
790
791
792
793
794
795
796
797
798
799
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
800
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
801
802
803
804
805
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
806
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
807
808
809
810
811
812
813
814
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

815
func DeleteModel(name string) error {
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
	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
863
864
865
	if err != nil {
		return err
	}
866
867
868
869

	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
870
			fp, err := GetBlobsPath(k)
871
			if err != nil {
872
873
874
875
876
				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)
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
				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
}

895
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
896
897
	mp := ParseModelPath(name)

898
899
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
900
	manifest, err := GetManifest(mp)
901
	if err != nil {
902
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
903
904
905
906
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
907
	layers = append(layers, manifest.Layers...)
908
909
910
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
911
		exists, err := checkBlobExistence(ctx, mp, layer.Digest, regOpts)
912
913
914
915
916
		if err != nil {
			return err
		}

		if exists {
917
918
919
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
920
921
				Total:     layer.Size,
				Completed: layer.Size,
922
			})
923
			log.Printf("Layer %s already exists", layer.Digest)
924
925
926
			continue
		}

927
		fn(api.ProgressResponse{
928
929
930
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
931
		})
932

933
		location, err := startUpload(ctx, mp, regOpts)
934
935
936
937
938
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

939
		err = uploadBlobChunked(ctx, mp, location, layer, regOpts, fn)
940
941
942
943
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
944
945
	}

946
	fn(api.ProgressResponse{Status: "pushing manifest"})
947
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
948
949
950
951
952
953
954
955
956
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

957
	resp, err := makeRequest(ctx, "PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
958
959
960
961
962
963
964
965
	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)
966
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
967
968
	}

969
	fn(api.ProgressResponse{Status: "success"})
970
971
972
973

	return nil
}

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

977
	fn(api.ProgressResponse{Status: "pulling manifest"})
978

979
	manifest, err := pullModelManifest(ctx, mp, regOpts)
980
	if err != nil {
981
		return fmt.Errorf("pull model manifest: %s", err)
982
983
984
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
985
	layers = append(layers, manifest.Layers...)
986
987
988
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
989
		if err := downloadBlob(ctx, mp, layer.Digest, regOpts, fn); err != nil {
990
991
992
993
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
994
995
996
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
			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
1008
1009
1010
1011
			return err
		}
	}

1012
	fn(api.ProgressResponse{Status: "writing manifest"})
1013

1014
	manifestJSON, err := json.Marshal(manifest)
1015
1016
1017
1018
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
1019
	fp, err := mp.GetManifestPath(true)
1020
1021
1022
1023
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1024
	err = os.WriteFile(fp, manifestJSON, 0o644)
1025
1026
1027
1028
1029
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

1030
	fn(api.ProgressResponse{Status: "success"})
1031
1032
1033
1034

	return nil
}

1035
func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
1036
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
1037
1038
1039
1040
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

1041
	resp, err := makeRequest(ctx, "GET", url, headers, nil, regOpts)
1042
1043
1044
1045
1046
1047
1048
1049
	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 {
1050
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
1051
			return nil, fmt.Errorf("model not found")
1052
		}
1053
		body, _ := io.ReadAll(resp.Body)
1054
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
	}

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

	return m, err
}

1065
1066
1067
1068
func createConfigLayer(config ConfigV2, layers []string) (*LayerReader, error) {
	config.RootFS = RootFS{
		Type:    "layers",
		DiffIDs: layers,
1069
1070
1071
1072
1073
1074
1075
	}

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

1076
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
1077

Michael Yang's avatar
Michael Yang committed
1078
	layer := &LayerReader{
1079
1080
1081
1082
1083
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
1084
		Reader: bytes.NewBuffer(configJSON),
1085
1086
1087
1088
1089
	}
	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
1090
1091
1092
1093
1094
1095
1096
1097
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)
1098
1099
}

1100
func startUpload(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (string, error) {
1101
	url := fmt.Sprintf("%s/v2/%s/blobs/uploads/", mp.Registry, mp.GetNamespaceRepository())
1102

1103
	resp, err := makeRequest(ctx, "POST", url, nil, nil, regOpts)
1104
1105
1106
1107
1108
1109
1110
1111
1112
	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)
1113
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
	}

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

1129
	resp, err := makeRequest(ctx, "HEAD", url, nil, nil, regOpts)
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
	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
}

1140
func uploadBlobChunked(ctx context.Context, mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1141
1142
1143
1144
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
1145
	fp, err := GetBlobsPath(layer.Digest)
1146
1147
1148
1149
	if err != nil {
		return err
	}

1150
1151
1152
1153
1154
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
	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
			}
1173

1174
			totalUploaded += int(n)
1175
1176

			fn(api.ProgressResponse{
1177
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1178
				Digest:    layer.Digest,
1179
1180
				Total:     layer.Size,
				Completed: totalUploaded,
1181
			})
1182
1183
1184
1185

			if totalUploaded >= layer.Size {
				return
			}
1186
		}
1187
	}()
1188

1189
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1190

1191
1192
1193
1194
	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))
1195

1196
	// finish the upload
1197
	resp, err := makeRequest(ctx, "PUT", url, headers, r, regOpts)
1198
1199
1200
1201
1202
1203
1204
1205
1206
	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))
1207
	}
1208
1209
1210
	return nil
}

1211
1212
1213
1214
1215
1216
func makeRequest(ctx context.Context, method, url string, headers map[string]string, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
	retryCtx := ctx.Value("retries")
	var retries int
	var ok bool
	if retries, ok = retryCtx.(int); ok {
		if retries > MaxRetries {
Bruce MacDonald's avatar
Bruce MacDonald committed
1217
			return nil, fmt.Errorf("maximum retries hit; are you sure you have access to this resource?")
1218
1219
1220
		}
	}

1221
1222
1223
1224
1225
1226
1227
1228
	if !strings.HasPrefix(url, "http") {
		if regOpts.Insecure {
			url = "http://" + url
		} else {
			url = "https://" + url
		}
	}

Patrick Devine's avatar
Patrick Devine committed
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
	// make a copy of the body in case we need to try the call to makeRequest again
	var buf bytes.Buffer
	if body != nil {
		_, err := io.Copy(&buf, body)
		if err != nil {
			return nil, err
		}
	}

	bodyCopy := bytes.NewReader(buf.Bytes())

	req, err := http.NewRequest(method, url, bodyCopy)
1241
1242
1243
1244
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1245
1246
1247
1248
	if regOpts.Token != "" {
		req.Header.Set("Authorization", "Bearer "+regOpts.Token)
	} else if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1249
1250
	}

Patrick Devine's avatar
Patrick Devine committed
1251
1252
	for k, v := range headers {
		req.Header.Set(k, v)
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
	}

	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
	}

Patrick Devine's avatar
Patrick Devine committed
1269
1270
1271
1272
	// if the request is unauthenticated, try to authenticate and make the request again
	if resp.StatusCode == http.StatusUnauthorized {
		auth := resp.Header.Get("Www-Authenticate")
		authRedir := ParseAuthRedirectString(string(auth))
1273
		token, err := getAuthToken(ctx, authRedir, regOpts)
Patrick Devine's avatar
Patrick Devine committed
1274
1275
1276
1277
1278
		if err != nil {
			return nil, err
		}
		regOpts.Token = token
		bodyCopy = bytes.NewReader(buf.Bytes())
1279
1280
		ctx = context.WithValue(ctx, "retries", retries+1)
		return makeRequest(ctx, method, url, headers, bodyCopy, regOpts)
Patrick Devine's avatar
Patrick Devine committed
1281
1282
	}

1283
1284
	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1285

Patrick Devine's avatar
Patrick Devine committed
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
func getValue(header, key string) string {
	startIdx := strings.Index(header, key+"=")
	if startIdx == -1 {
		return ""
	}

	// Move the index to the starting quote after the key.
	startIdx += len(key) + 2
	endIdx := startIdx

	for endIdx < len(header) {
		if header[endIdx] == '"' {
			if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
				endIdx++
				continue
			}
			break
		}
		endIdx++
	}
	return header[startIdx:endIdx]
}

func ParseAuthRedirectString(authStr string) AuthRedirect {
	authStr = strings.TrimPrefix(authStr, "Bearer ")

	return AuthRedirect{
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
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 {
1335
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1336
1337
1338
1339
	}

	return nil
}