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

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

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

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

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

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

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

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

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

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

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

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

	return sb.String(), nil
}

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

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
112
113
114
115
116
117
118
119
120
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
121
122
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
123
124
125
	if err != nil {
		return nil, err
	}
126

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

	var manifest *ManifestV2

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

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

	return manifest, nil
}

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

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

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

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

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

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

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

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

	return model, nil
}

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
}

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

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

Michael Yang's avatar
Michael Yang committed
249
	var layers []*LayerReader
250
	params := make(map[string][]string)
251
	embed := EmbeddingParams{fn: fn, opts: api.DefaultOptions()}
252
	for _, c := range commands {
253
		log.Printf("[%s] - %s\n", c.Name, c.Args)
254
255
		switch c.Name {
		case "model":
256
			fn(api.ProgressResponse{Status: "looking for model"})
257
			embed.model = c.Args
258
			mf, err := GetManifest(ParseModelPath(c.Args))
259
			if err != nil {
260
261
262
				modelFile, err := filenameWithPath(path, c.Args)
				if err != nil {
					return err
263
				}
264
				if _, err := os.Stat(modelFile); err != nil {
265
266
267
268
269
270
					// the model file does not exist, try pulling it
					if errors.Is(err, os.ErrNotExist) {
						fn(api.ProgressResponse{Status: "pulling model file"})
						if err := PullModel(c.Args, &RegistryOptions{}, fn); err != nil {
							return err
						}
271
						mf, err = GetManifest(ParseModelPath(c.Args))
272
273
274
275
276
277
278
279
280
						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"})
281
					file, err := os.Open(modelFile)
282
283
284
285
286
287
288
289
290
291
292
					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)
293
				}
294
295
			}
			if mf != nil {
296
297
298
299
300
301
302
303
304
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
305
306
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
307
308
309
			if err != nil {
				return err
			}
310
			embed.files = append(embed.files, embedFilePath)
Bruce MacDonald's avatar
Bruce MacDonald committed
311
312
313
314
315
316
317
318
319
320
321
322
		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":
323
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
324
			// remove the prompt layer if one exists
325
326
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
327

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

			layer.MediaType = mediaType
			layers = append(layers, layer)
335
		default:
336
337
			// 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)
338
339
340
341
		}
	}

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

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

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

		// 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)
365
366
	}

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

374
375
376
377
378
379
380
381
382
383
384
	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
385
	fn(api.ProgressResponse{Status: "creating config layer"})
386
387
388
389
390
391
392
393
394
395
396
397
	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
398
	fn(api.ProgressResponse{Status: "writing manifest"})
399
400
401
402
403
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

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

408
409
410
411
412
413
414
415
416
417
418
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 {
419
420
421
422
423
424
425
426
427
428
429
		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)
			}
430
431
432
		}

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
450
451
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
452
453
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
454
455
456
				addedFiles[filePath] = true
				// TODO: check file type
				f, err := os.Open(filePath)
457
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
458
					return nil, fmt.Errorf("could not open embed file: %w", err)
459
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
				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,
					})
					retry := 0
				generate:
					if retry > 3 {
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
					}
					embed, err := llm.Embedding(d)
					if err != nil {
						log.Printf("retrying embedding generation for '%s' line %d: %v", filePath, i+1, err)
492
493
494
						retry++
						goto generate
					}
Bruce MacDonald's avatar
Bruce MacDonald committed
495
496
497
498
499
500
					// Check for NaN and Inf in the embedding, which can't be stored
					for _, value := range embed {
						if math.IsNaN(value) || math.IsInf(value, 0) {
							log.Printf("reloading model, embedding contains NaN or Inf")
							// reload the model to get a new embedding, the seed can effect these outputs and reloading changes it
							llm.Close()
501
							llm, err = llama.New(e.model, e.opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
502
503
504
505
506
507
508
509
							if err != nil {
								return nil, fmt.Errorf("load model to generate embeddings: %v", err)
							}
							retry++
							goto generate
						}
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
510
511
				}

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

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

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

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

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

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

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

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

683
	return out, nil
684
685
}

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

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

	return layer, nil
}

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

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

	return nil
}

740
func DeleteModel(name string) error {
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
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
	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
788
789
790
	if err != nil {
		return err
	}
791

Michael Yang's avatar
Michael Yang committed
792
793
794
795
	if err != nil {
		return err
	}

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

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

827
828
	fn(api.ProgressResponse{Status: "retrieving manifest"})

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

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
836
	layers = append(layers, manifest.Layers...)
837
838
839
	layers = append(layers, &manifest.Config)

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

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

856
		fn(api.ProgressResponse{
857
858
859
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
860
		})
861

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

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

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

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

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

898
	fn(api.ProgressResponse{Status: "success"})
899
900
901
902

	return nil
}

903
func PullModel(name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
904
	mp := ParseModelPath(name)
905

906
	fn(api.ProgressResponse{Status: "pulling manifest"})
907

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

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
914
	layers = append(layers, manifest.Layers...)
915
916
917
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
918
		if err := downloadBlob(mp, layer.Digest, regOpts, fn); err != nil {
919
920
921
922
			return err
		}
	}

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

941
	fn(api.ProgressResponse{Status: "writing manifest"})
942

943
	manifestJSON, err := json.Marshal(manifest)
944
945
946
947
	if err != nil {
		return err
	}

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

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

959
	fn(api.ProgressResponse{Status: "success"})
960
961
962
963

	return nil
}

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

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

	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
994
func createConfigLayer(layers []string) (*LayerReader, error) {
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
	// 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
	}

1010
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
1011

Michael Yang's avatar
Michael Yang committed
1012
	layer := &LayerReader{
1013
1014
1015
1016
1017
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
1018
		Reader: bytes.NewBuffer(configJSON),
1019
1020
1021
1022
1023
	}
	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
1024
1025
1026
1027
1028
1029
1030
1031
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)
1032
1033
}

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

1037
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
1038
1039
1040
1041
1042
1043
1044
1045
1046
	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)
1047
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
	}

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

1063
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
	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
1074
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1075
1076
1077
1078
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
1079
	fp, err := GetBlobsPath(layer.Digest)
1080
1081
1082
1083
	if err != nil {
		return err
	}

1084
1085
1086
1087
1088
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
	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
			}
1107

1108
			totalUploaded += int(n)
1109
1110

			fn(api.ProgressResponse{
1111
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1112
				Digest:    layer.Digest,
1113
1114
				Total:     layer.Size,
				Completed: totalUploaded,
1115
			})
1116
1117
1118
1119

			if totalUploaded >= layer.Size {
				return
			}
1120
		}
1121
	}()
1122

1123
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1124

1125
1126
1127
1128
	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))
1129

1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
	// 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))
1141
	}
1142
1143
1144
	return nil
}

1145
func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
1146
	fp, err := GetBlobsPath(digest)
1147
1148
1149
1150
	if err != nil {
		return err
	}

1151
	if fi, _ := os.Stat(fp); fi != nil {
1152
		// we already have the file, so return
1153
1154
1155
1156
1157
1158
		fn(api.ProgressResponse{
			Digest:    digest,
			Total:     int(fi.Size()),
			Completed: int(fi.Size()),
		})

1159
1160
1161
1162
		return nil
	}

	var size int64
Bruce MacDonald's avatar
Bruce MacDonald committed
1163
	chunkSize := 1024 * 1024 // 1 MiB in bytes
1164
1165
1166
1167
1168
1169
1170
1171
1172

	fi, err := os.Stat(fp + "-partial")
	switch {
	case errors.Is(err, os.ErrNotExist):
		// noop, file doesn't exist so create it
	case err != nil:
		return fmt.Errorf("stat: %w", err)
	default:
		size = fi.Size()
Bruce MacDonald's avatar
Bruce MacDonald committed
1173
1174
1175
1176
1177
1178
1179
		// Ensure the size is divisible by the chunk size by removing excess bytes
		size -= size % int64(chunkSize)

		err := os.Truncate(fp+"-partial", size)
		if err != nil {
			return fmt.Errorf("truncate: %w", err)
		}
1180
1181
	}

1182
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1183
1184
1185
1186
	headers := map[string]string{
		"Range": fmt.Sprintf("bytes=%d-", size),
	}

1187
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1188
1189
1190
1191
1192
1193
1194
	if err != nil {
		log.Printf("couldn't download blob: %v", err)
		return err
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusPartialContent {
Michael Yang's avatar
Michael Yang committed
1195
		body, _ := io.ReadAll(resp.Body)
1196
		return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
1197
1198
1199
1200
1201
1202
1203
1204
1205
	}

	err = os.MkdirAll(path.Dir(fp), 0o700)
	if err != nil {
		return fmt.Errorf("make blobs directory: %w", err)
	}

	out, err := os.OpenFile(fp+"-partial", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o644)
	if err != nil {
1206
		return fmt.Errorf("open file: %w", err)
1207
1208
1209
1210
1211
1212
1213
1214
	}
	defer out.Close()

	remaining, _ := strconv.ParseInt(resp.Header.Get("Content-Length"), 10, 64)
	completed := size
	total := remaining + completed

	for {
1215
		fn(api.ProgressResponse{
1216
			Status:    fmt.Sprintf("pulling %s...", digest[7:19]),
1217
1218
1219
1220
1221
			Digest:    digest,
			Total:     int(total),
			Completed: int(completed),
		})

1222
		if completed >= total {
Michael Yang's avatar
Michael Yang committed
1223
1224
1225
1226
			if err := out.Close(); err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
1227
			if err := os.Rename(fp+"-partial", fp); err != nil {
1228
1229
1230
1231
1232
1233
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error renaming file: %v", err),
					Digest:    digest,
					Total:     int(total),
					Completed: int(completed),
				})
1234
1235
				return err
			}
Michael Yang's avatar
Michael Yang committed
1236

1237
1238
1239
			break
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
1240
		n, err := io.CopyN(out, resp.Body, int64(chunkSize))
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
		if err != nil && !errors.Is(err, io.EOF) {
			return err
		}
		completed += n
	}

	log.Printf("success getting %s\n", digest)
	return nil
}

1251
1252
1253
1254
1255
1256
1257
1258
1259
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
		}
	}

1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
	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
1270
1271
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
	}

	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
1290

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

Michael Yang's avatar
Michael Yang committed
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
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 {
1307
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1308
1309
1310
1311
	}

	return nil
}