images.go 26.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
package server

import (
	"bytes"
	"crypto/sha256"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
	"net/http"
	"os"
	"path"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
15
	"reflect"
16
17
	"strconv"
	"strings"
18
	"text/template"
19
20
21
22
23

	"github.com/jmorganca/ollama/api"
	"github.com/jmorganca/ollama/parser"
)

24
25
26
27
28
29
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
}

30
31
32
type Model struct {
	Name      string `json:"name"`
	ModelPath string
33
34
	Template  string
	System    string
35
	Digest    string
36
	Options   map[string]interface{}
37
38
}

39
40
41
42
43
44
45
func (m *Model) Prompt(request api.GenerateRequest) (string, error) {
	tmpl, err := template.New("").Parse(m.Template)
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
46
		First  bool
47
48
		System string
		Prompt string
49
50
51

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

Michael Yang's avatar
Michael Yang committed
54
	vars.First = len(request.Context) == 0
55
56
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
57
	vars.Context = request.Context
58
59
60
61
62
63
64
65
66

	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

67
68
69
70
71
72
73
74
75
76
77
78
79
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
80
type LayerReader struct {
81
	Layer
Michael Yang's avatar
Michael Yang committed
82
	io.Reader
83
84
85
86
87
88
89
90
91
92
93
94
95
}

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
96
97
98
99
100
101
102
103
104
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
105
106
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
107
108
109
	if err != nil {
		return nil, err
	}
110

111
112
	if _, err = os.Stat(fp); err != nil {
		return nil, err
113
114
115
116
	}

	var manifest *ManifestV2

117
	bts, err := os.ReadFile(fp)
118
119
120
121
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

122
	if err := json.Unmarshal(bts, &manifest); err != nil {
123
124
125
126
127
128
129
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
130
131
132
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
133
134
135
136
137
	if err != nil {
		return nil, err
	}

	model := &Model{
138
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
139
		Digest: manifest.Config.Digest,
140
141
142
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
143
		filename, err := GetBlobsPath(layer.Digest)
144
145
146
147
		if err != nil {
			return nil, err
		}

148
149
150
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
151
152
153
154
155
156
157
158
159
		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)
160
161
162
			if err != nil {
				return nil, err
			}
163
164

			model.System = string(bts)
165
166
167
168
169
170
171
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
172
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
173
174
175
176
177
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
178

179
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
180
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
181
182
				return nil, err
			}
183
184
185
186
187
188
		}
	}

	return model, nil
}

189
func CreateModel(name string, path string, fn func(resp api.ProgressResponse)) error {
190
191
	mf, err := os.Open(path)
	if err != nil {
192
		fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
193
		return fmt.Errorf("failed to open file: %w", err)
194
	}
195
	defer mf.Close()
196

197
	fn(api.ProgressResponse{Status: "parsing modelfile"})
198
199
200
201
202
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
203
	var layers []*LayerReader
204
	params := make(map[string][]string)
205
206

	for _, c := range commands {
207
		log.Printf("[%s] - %s\n", c.Name, c.Args)
208
209
		switch c.Name {
		case "model":
210
			fn(api.ProgressResponse{Status: "looking for model"})
211
			mf, err := GetManifest(ParseModelPath(c.Args))
212
			if err != nil {
213
				fp := c.Args
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

				// If filePath starts with ~/, replace it with the user's home directory.
				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)
229
230
				}

231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
				if _, err := os.Stat(fp); err != nil {
					// 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
						}
						mf, err = GetManifest(ParseModelPath(c.Args))
						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"})
249

250
251
252
253
254
255
256
257
258
259
260
261
					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.model"
					layers = append(layers, l)
262
				}
263
264
			}
			if mf != nil {
265
266
267
268
269
270
271
272
273
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
Michael Yang's avatar
Michael Yang committed
274
275
276
277
278
279
280
281
282
283
284
285
286
		case "license":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
			// remove the prompt layer if one exists
			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":
287
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
288
			// remove the prompt layer if one exists
289
290
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
291

292
			layer, err := CreateLayer(strings.NewReader(c.Args))
293
			if err != nil {
294
				return err
295
			}
296
297
298

			layer.MediaType = mediaType
			layers = append(layers, layer)
299
		default:
300
301
			// 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)
302
303
304
305
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
306
	if len(params) > 0 {
307
		fn(api.ProgressResponse{Status: "creating parameter layer"})
308
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
Michael Yang's avatar
Michael Yang committed
309
		paramData, err := paramsToReader(params)
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
		l, err := CreateLayer(paramData)
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
	}

	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
332
	fn(api.ProgressResponse{Status: "creating config layer"})
333
334
335
336
337
338
339
340
341
342
343
344
	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
345
	fn(api.ProgressResponse{Status: "writing manifest"})
346
347
348
349
350
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

351
	fn(api.ProgressResponse{Status: "success"})
352
353
354
	return nil
}

Michael Yang's avatar
Michael Yang committed
355
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
356
357
358
359
360
361
362
363
364
365
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

366
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
367
368
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
369
		fp, err := GetBlobsPath(layer.Digest)
370
371
372
		if err != nil {
			return err
		}
373
374
375

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

378
379
380
381
382
383
384
			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
385
			if _, err = io.Copy(out, layer.Reader); err != nil {
386
387
				return err
			}
Michael Yang's avatar
Michael Yang committed
388

389
		} else {
390
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
391
392
393
394
395
396
		}
	}

	return nil
}

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

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
	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
416
	fp, err := mp.GetManifestPath(true)
417
418
419
	if err != nil {
		return err
	}
420
	return os.WriteFile(fp, manifestJSON, 0o644)
421
422
}

Michael Yang's avatar
Michael Yang committed
423
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
424
	fp, err := GetBlobsPath(layer.Digest)
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
	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
}

443
// paramsToReader converts specified parameter options to their correct types, and returns a reader for the json
444
func paramsToReader(params map[string][]string) (io.ReadSeeker, error) {
445
446
447
	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
448

449
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
450
451
452
453
454
455
456
457
	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
		}
	}

458
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
459
	// iterate params and set values based on json struct tags
460
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
461
462
463
464
465
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
466
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
467
					if err != nil {
468
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
469
470
					}

471
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
472
				case reflect.Int:
473
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
474
					if err != nil {
475
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
476
477
					}

478
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
479
				case reflect.Bool:
480
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
481
					if err != nil {
482
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
483
484
					}

485
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
486
				case reflect.String:
487
					out[key] = vals[0]
488
				case reflect.Slice:
489
490
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
491
492
493
494
495
496
497
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

498
	bts, err := json.Marshal(out)
499
500
501
502
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
503
	return bytes.NewReader(bts), nil
504
505
}

Michael Yang's avatar
Michael Yang committed
506
func getLayerDigests(layers []*LayerReader) ([]string, error) {
507
508
509
510
511
512
513
514
515
516
517
	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
518
519
520
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
	f.Seek(0, 0)
521

Michael Yang's avatar
Michael Yang committed
522
	layer := &LayerReader{
523
524
525
526
527
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
528
		Reader: f,
529
530
531
532
533
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
534
535
536
537
538
539
540
541
542
543
544
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
545
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
546
547
548
549
550
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
551
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
552
553
554
555
556
557
558
559
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

560
func DeleteModel(name string) error {
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
	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
608
609
610
	if err != nil {
		return err
	}
611

Michael Yang's avatar
Michael Yang committed
612
613
614
615
	if err != nil {
		return err
	}

616
617
618
	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
619
			fp, err := GetBlobsPath(k)
620
			if err != nil {
621
622
623
624
625
				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)
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
				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
}

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

647
648
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
649
	manifest, err := GetManifest(mp)
650
	if err != nil {
651
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
652
653
654
655
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
656
	layers = append(layers, manifest.Layers...)
657
658
659
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
660
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
661
662
663
664
665
		if err != nil {
			return err
		}

		if exists {
666
667
668
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
669
670
				Total:     layer.Size,
				Completed: layer.Size,
671
			})
672
			log.Printf("Layer %s already exists", layer.Digest)
673
674
675
			continue
		}

676
		fn(api.ProgressResponse{
677
678
679
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
680
		})
681

682
		location, err := startUpload(mp, regOpts)
683
684
685
686
687
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

688
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
689
690
691
692
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
693
694
	}

695
	fn(api.ProgressResponse{Status: "pushing manifest"})
696
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
697
698
699
700
701
702
703
704
705
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

706
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
707
708
709
710
711
712
713
714
	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)
715
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
716
717
	}

718
	fn(api.ProgressResponse{Status: "success"})
719
720
721
722

	return nil
}

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

726
	fn(api.ProgressResponse{Status: "pulling manifest"})
727

728
	manifest, err := pullModelManifest(mp, regOpts)
729
	if err != nil {
730
		return fmt.Errorf("pull model manifest: %s", err)
731
732
733
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
734
	layers = append(layers, manifest.Layers...)
735
736
737
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
738
		if err := downloadBlob(mp, layer.Digest, regOpts, fn); err != nil {
739
740
741
742
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
743
744
745
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
746
747
748
749
750
751
752
753
754
755
756
			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
757
758
759
760
			return err
		}
	}

761
	fn(api.ProgressResponse{Status: "writing manifest"})
762

763
	manifestJSON, err := json.Marshal(manifest)
764
765
766
767
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
768
	fp, err := mp.GetManifestPath(true)
769
770
771
772
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
773
	err = os.WriteFile(fp, manifestJSON, 0o644)
774
775
776
777
778
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

779
	fn(api.ProgressResponse{Status: "success"})
780
781
782
783

	return nil
}

784
785
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
786
787
788
789
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

790
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
791
792
793
794
795
796
797
798
	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 {
799
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
800
			return nil, fmt.Errorf("model not found")
801
		}
802
		body, _ := io.ReadAll(resp.Body)
803
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
804
805
806
807
808
809
810
811
812
813
	}

	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
814
func createConfigLayer(layers []string) (*LayerReader, error) {
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
	// 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
	}

830
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
831

Michael Yang's avatar
Michael Yang committed
832
	layer := &LayerReader{
833
834
835
836
837
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
838
		Reader: bytes.NewBuffer(configJSON),
839
840
841
842
843
	}
	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
844
845
846
847
848
849
850
851
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)
852
853
}

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

857
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
858
859
860
861
862
863
864
865
866
	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)
867
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
868
869
870
871
872
873
874
875
876
877
878
879
	}

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

883
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
884
885
886
887
888
889
890
891
892
893
	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
894
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
895
896
897
898
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
899
	fp, err := GetBlobsPath(layer.Digest)
900
901
902
903
	if err != nil {
		return err
	}

904
905
906
907
908
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
	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
			}
927

928
			totalUploaded += int(n)
929
930

			fn(api.ProgressResponse{
931
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
932
				Digest:    layer.Digest,
933
934
				Total:     layer.Size,
				Completed: totalUploaded,
935
			})
936
937
938
939

			if totalUploaded >= layer.Size {
				return
			}
940
		}
941
	}()
942

943
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
944

945
946
947
948
	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))
949

950
951
952
953
954
955
956
957
958
959
960
	// 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))
961
	}
962
963
964
	return nil
}

965
func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
966
	fp, err := GetBlobsPath(digest)
967
968
969
970
	if err != nil {
		return err
	}

971
	if fi, _ := os.Stat(fp); fi != nil {
972
		// we already have the file, so return
973
974
975
976
977
978
		fn(api.ProgressResponse{
			Digest:    digest,
			Total:     int(fi.Size()),
			Completed: int(fi.Size()),
		})

979
980
981
982
		return nil
	}

	var size int64
Bruce MacDonald's avatar
Bruce MacDonald committed
983
	chunkSize := 1024 * 1024 // 1 MiB in bytes
984
985
986
987
988
989
990
991
992

	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
993
994
995
996
997
998
999
		// 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)
		}
1000
1001
	}

1002
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1003
1004
1005
1006
	headers := map[string]string{
		"Range": fmt.Sprintf("bytes=%d-", size),
	}

1007
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1008
1009
1010
1011
1012
1013
1014
	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
1015
		body, _ := io.ReadAll(resp.Body)
1016
		return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
1017
1018
1019
1020
1021
1022
1023
1024
1025
	}

	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 {
1026
		return fmt.Errorf("open file: %w", err)
1027
1028
1029
1030
1031
1032
1033
1034
	}
	defer out.Close()

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

	for {
1035
1036
1037
1038
1039
1040
1041
		fn(api.ProgressResponse{
			Status:    fmt.Sprintf("downloading %s", digest),
			Digest:    digest,
			Total:     int(total),
			Completed: int(completed),
		})

1042
		if completed >= total {
Michael Yang's avatar
Michael Yang committed
1043
1044
1045
1046
			if err := out.Close(); err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
1047
			if err := os.Rename(fp+"-partial", fp); err != nil {
1048
1049
1050
1051
1052
1053
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error renaming file: %v", err),
					Digest:    digest,
					Total:     int(total),
					Completed: int(completed),
				})
1054
1055
				return err
			}
Michael Yang's avatar
Michael Yang committed
1056

1057
1058
1059
			break
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
1060
		n, err := io.CopyN(out, resp.Body, int64(chunkSize))
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
		if err != nil && !errors.Is(err, io.EOF) {
			return err
		}
		completed += n
	}

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

1071
1072
1073
1074
1075
1076
1077
1078
1079
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
		}
	}

1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
	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
1090
1091
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
	}

	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
1110

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

Michael Yang's avatar
Michael Yang committed
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
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 {
1127
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1128
1129
1130
1131
	}

	return nil
}