images.go 31.2 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
307
		case "embed":
			// TODO: support entire directories here
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
308
309
310
			if err != nil {
				return err
			}
311
312
			embed.files = append(embed.files, embedFilePath)
		case "license", "template", "system", "prompt":
313
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
314
			// remove the prompt layer if one exists
315
316
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
317

318
			layer, err := CreateLayer(strings.NewReader(c.Args))
319
			if err != nil {
320
				return err
321
			}
322
323
324

			layer.MediaType = mediaType
			layers = append(layers, layer)
325
		default:
326
327
			// 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)
328
329
330
331
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
332
	if len(params) > 0 {
333
		fn(api.ProgressResponse{Status: "creating parameter layer"})
334
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
335
		formattedParams, err := formatParams(params)
336
337
338
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
339
340
341
342
343
344
345

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

		l, err := CreateLayer(bytes.NewReader(bts))
346
347
348
349
350
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
351
352
353
354

		// 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)
355
356
	}

357
358
	fmt.Println(embed.model)

359
360
361
362
363
364
365
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

366
367
368
369
370
371
372
373
374
375
376
	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
377
	fn(api.ProgressResponse{Status: "creating config layer"})
378
379
380
381
382
383
384
385
386
387
388
389
	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
390
	fn(api.ProgressResponse{Status: "writing manifest"})
391
392
393
394
395
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

396
	fn(api.ProgressResponse{Status: "success"})
397
398
399
	return nil
}

400
401
402
403
404
405
406
407
408
409
410
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 {
411
412
413
414
415
416
417
418
419
420
421
		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)
			}
422
423
424
		}

		e.opts.EmbeddingOnly = true
425
		llm, err := llama.New(e.model, e.opts)
426
427
428
429
		if err != nil {
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
430
431
432
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
433
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
434
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
435
436
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
437
438
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
439
440
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
441
442
443
				addedFiles[filePath] = true
				// TODO: check file type
				f, err := os.Open(filePath)
444
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
445
					return nil, fmt.Errorf("could not open embed file: %w", err)
446
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
				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)
479
480
481
						retry++
						goto generate
					}
Bruce MacDonald's avatar
Bruce MacDonald committed
482
483
484
485
486
487
					// 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()
488
							llm, err = llama.New(e.model, e.opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
489
490
491
492
493
494
495
496
							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})
497
498
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
499
500
501
502
503
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
504

Bruce MacDonald's avatar
Bruce MacDonald committed
505
506
507
508
509
				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)
				}
510

Bruce MacDonald's avatar
Bruce MacDonald committed
511
512
513
514
515
516
517
518
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
						Size:      size,
					},
					Reader: r,
				}
519

Bruce MacDonald's avatar
Bruce MacDonald committed
520
521
				layers = append(layers, layer)
			}
522
523
524
525
526
		}
	}
	return layers, nil
}

Michael Yang's avatar
Michael Yang committed
527
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
528
529
530
531
532
533
534
535
536
537
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

538
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
539
540
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
541
		fp, err := GetBlobsPath(layer.Digest)
542
543
544
		if err != nil {
			return err
		}
545
546
547

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

550
551
552
553
554
555
556
			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
557
			if _, err = io.Copy(out, layer.Reader); err != nil {
558
559
				return err
			}
Michael Yang's avatar
Michael Yang committed
560

561
		} else {
562
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
563
564
565
566
567
568
		}
	}

	return nil
}

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

572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
	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
588
	fp, err := mp.GetManifestPath(true)
589
590
591
	if err != nil {
		return err
	}
592
	return os.WriteFile(fp, manifestJSON, 0o644)
593
594
}

Michael Yang's avatar
Michael Yang committed
595
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
596
	fp, err := GetBlobsPath(layer.Digest)
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
	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
}

615
616
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
617
618
619
	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
620

621
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
622
623
624
625
626
627
628
629
	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
		}
	}

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

643
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
644
				case reflect.Int:
645
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
646
					if err != nil {
647
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
648
649
					}

650
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
651
				case reflect.Bool:
652
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
653
					if err != nil {
654
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
655
656
					}

657
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
658
				case reflect.String:
659
					out[key] = vals[0]
660
				case reflect.Slice:
661
662
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
663
664
665
666
667
668
669
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

670
	return out, nil
671
672
}

Michael Yang's avatar
Michael Yang committed
673
func getLayerDigests(layers []*LayerReader) ([]string, error) {
674
675
676
677
678
679
680
681
682
683
684
	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
685
686
687
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
	f.Seek(0, 0)
688

Michael Yang's avatar
Michael Yang committed
689
	layer := &LayerReader{
690
691
692
693
694
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
695
		Reader: f,
696
697
698
699
700
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
701
702
703
704
705
706
707
708
709
710
711
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
712
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
713
714
715
716
717
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
718
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
719
720
721
722
723
724
725
726
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

727
func DeleteModel(name string) error {
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
	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
775
776
777
	if err != nil {
		return err
	}
778

Michael Yang's avatar
Michael Yang committed
779
780
781
782
	if err != nil {
		return err
	}

783
784
785
	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
786
			fp, err := GetBlobsPath(k)
787
			if err != nil {
788
789
790
791
792
				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)
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
				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
}

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

814
815
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
816
	manifest, err := GetManifest(mp)
817
	if err != nil {
818
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
819
820
821
822
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
823
	layers = append(layers, manifest.Layers...)
824
825
826
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
827
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
828
829
830
831
832
		if err != nil {
			return err
		}

		if exists {
833
834
835
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
836
837
				Total:     layer.Size,
				Completed: layer.Size,
838
			})
839
			log.Printf("Layer %s already exists", layer.Digest)
840
841
842
			continue
		}

843
		fn(api.ProgressResponse{
844
845
846
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
847
		})
848

849
		location, err := startUpload(mp, regOpts)
850
851
852
853
854
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

855
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
856
857
858
859
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
860
861
	}

862
	fn(api.ProgressResponse{Status: "pushing manifest"})
863
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
864
865
866
867
868
869
870
871
872
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

873
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
874
875
876
877
878
879
880
881
	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)
882
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
883
884
	}

885
	fn(api.ProgressResponse{Status: "success"})
886
887
888
889

	return nil
}

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

893
	fn(api.ProgressResponse{Status: "pulling manifest"})
894

895
	manifest, err := pullModelManifest(mp, regOpts)
896
	if err != nil {
897
		return fmt.Errorf("pull model manifest: %s", err)
898
899
900
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
901
	layers = append(layers, manifest.Layers...)
902
903
904
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
905
		if err := downloadBlob(mp, layer.Digest, regOpts, fn); err != nil {
906
907
908
909
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
910
911
912
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
913
914
915
916
917
918
919
920
921
922
923
			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
924
925
926
927
			return err
		}
	}

928
	fn(api.ProgressResponse{Status: "writing manifest"})
929

930
	manifestJSON, err := json.Marshal(manifest)
931
932
933
934
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
935
	fp, err := mp.GetManifestPath(true)
936
937
938
939
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
940
	err = os.WriteFile(fp, manifestJSON, 0o644)
941
942
943
944
945
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

946
	fn(api.ProgressResponse{Status: "success"})
947
948
949
950

	return nil
}

951
952
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
953
954
955
956
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

957
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
958
959
960
961
962
963
964
965
	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 {
966
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
967
			return nil, fmt.Errorf("model not found")
968
		}
969
		body, _ := io.ReadAll(resp.Body)
970
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
971
972
973
974
975
976
977
978
979
980
	}

	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
981
func createConfigLayer(layers []string) (*LayerReader, error) {
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
	// 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
	}

997
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
998

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

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

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

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

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

Patrick Devine's avatar
Patrick Devine committed
1066
	fp, err := GetBlobsPath(layer.Digest)
1067
1068
1069
1070
	if err != nil {
		return err
	}

1071
1072
1073
1074
1075
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
	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
			}
1094

1095
			totalUploaded += int(n)
1096
1097

			fn(api.ProgressResponse{
1098
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1099
				Digest:    layer.Digest,
1100
1101
				Total:     layer.Size,
				Completed: totalUploaded,
1102
			})
1103
1104
1105
1106

			if totalUploaded >= layer.Size {
				return
			}
1107
		}
1108
	}()
1109

1110
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1111

1112
1113
1114
1115
	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))
1116

1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
	// 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))
1128
	}
1129
1130
1131
	return nil
}

1132
func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
1133
	fp, err := GetBlobsPath(digest)
1134
1135
1136
1137
	if err != nil {
		return err
	}

1138
	if fi, _ := os.Stat(fp); fi != nil {
1139
		// we already have the file, so return
1140
1141
1142
1143
1144
1145
		fn(api.ProgressResponse{
			Digest:    digest,
			Total:     int(fi.Size()),
			Completed: int(fi.Size()),
		})

1146
1147
1148
1149
		return nil
	}

	var size int64
Bruce MacDonald's avatar
Bruce MacDonald committed
1150
	chunkSize := 1024 * 1024 // 1 MiB in bytes
1151
1152
1153
1154
1155
1156
1157
1158
1159

	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
1160
1161
1162
1163
1164
1165
1166
		// 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)
		}
1167
1168
	}

1169
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1170
1171
1172
1173
	headers := map[string]string{
		"Range": fmt.Sprintf("bytes=%d-", size),
	}

1174
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1175
1176
1177
1178
1179
1180
1181
	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
1182
		body, _ := io.ReadAll(resp.Body)
1183
		return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
1184
1185
1186
1187
1188
1189
1190
1191
1192
	}

	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 {
1193
		return fmt.Errorf("open file: %w", err)
1194
1195
1196
1197
1198
1199
1200
1201
	}
	defer out.Close()

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

	for {
1202
		fn(api.ProgressResponse{
1203
			Status:    fmt.Sprintf("pulling %s...", digest[7:19]),
1204
1205
1206
1207
1208
			Digest:    digest,
			Total:     int(total),
			Completed: int(completed),
		})

1209
		if completed >= total {
Michael Yang's avatar
Michael Yang committed
1210
1211
1212
1213
			if err := out.Close(); err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
1214
			if err := os.Rename(fp+"-partial", fp); err != nil {
1215
1216
1217
1218
1219
1220
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error renaming file: %v", err),
					Digest:    digest,
					Total:     int(total),
					Completed: int(completed),
				})
1221
1222
				return err
			}
Michael Yang's avatar
Michael Yang committed
1223

1224
1225
1226
			break
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
1227
		n, err := io.CopyN(out, resp.Body, int64(chunkSize))
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
		if err != nil && !errors.Is(err, io.EOF) {
			return err
		}
		completed += n
	}

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

1238
1239
1240
1241
1242
1243
1244
1245
1246
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
		}
	}

1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
	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
1257
1258
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
	}

	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
1277

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

Michael Yang's avatar
Michael Yang committed
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
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 {
1294
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1295
1296
1297
1298
	}

	return nil
}