images.go 27.2 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

	"github.com/jmorganca/ollama/api"
	"github.com/jmorganca/ollama/parser"
22
	"github.com/mitchellh/mapstructure"
23
24
)

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

31
32
33
type Model struct {
	Name      string `json:"name"`
	ModelPath string
34
35
	Template  string
	System    string
36
	Digest    string
37
38
39
	Options   api.Options
}

40
41
42
43
44
45
46
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
47
		First  bool
48
49
		System string
		Prompt string
50
51
52

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

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

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

	return sb.String(), nil
}

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

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

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

	var manifest *ManifestV2

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

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

	return manifest, nil
}

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

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

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

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

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

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

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

180
181
182
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
			// TODO: once there are no modelfiles in the wild that do not have default options populated this can be removed
			var opts map[string]interface{}
Michael Yang's avatar
Michael Yang committed
183
184
185
186
			if err = json.NewDecoder(params).Decode(&opts); err != nil {
				return nil, err
			}

187
188
189
190
			// update the default options on the model with the options that have been specified
			if err := mapstructure.Decode(opts, &model.Options); err != nil {
				return nil, err
			}
191
192
193
194
195
196
		}
	}

	return model, nil
}

197
func CreateModel(name string, path string, fn func(resp api.ProgressResponse)) error {
198
199
	mf, err := os.Open(path)
	if err != nil {
200
		fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
201
		return fmt.Errorf("failed to open file: %w", err)
202
	}
203
	defer mf.Close()
204

205
	fn(api.ProgressResponse{Status: "parsing modelfile"})
206
207
208
209
210
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
211
	var layers []*LayerReader
212
	params := make(map[string][]string)
213
214

	for _, c := range commands {
215
		log.Printf("[%s] - %s\n", c.Name, c.Args)
216
217
		switch c.Name {
		case "model":
218
			fn(api.ProgressResponse{Status: "looking for model"})
219
			mf, err := GetManifest(ParseModelPath(c.Args))
220
			if err != nil {
221
				fp := c.Args
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

				// 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)
237
238
				}

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
				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"})
257

258
259
260
261
262
263
264
265
266
267
268
269
					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)
270
				}
271
272
			}
			if mf != nil {
273
274
275
276
277
278
279
280
281
				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
282
283
284
285
286
287
288
289
290
291
292
293
294
		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":
295
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
296
			// remove the prompt layer if one exists
297
298
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
299

300
			layer, err := CreateLayer(strings.NewReader(c.Args))
301
			if err != nil {
302
				return err
303
			}
304
305
306

			layer.MediaType = mediaType
			layers = append(layers, layer)
307
		default:
308
309
			// 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)
310
311
312
313
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
314
	if len(params) > 0 {
315
		fn(api.ProgressResponse{Status: "creating parameter layer"})
316
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
Michael Yang's avatar
Michael Yang committed
317
		paramData, err := paramsToReader(params)
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
		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
340
	fn(api.ProgressResponse{Status: "creating config layer"})
341
342
343
344
345
346
347
348
349
350
351
352
	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
353
	fn(api.ProgressResponse{Status: "writing manifest"})
354
355
356
357
358
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

359
	fn(api.ProgressResponse{Status: "success"})
360
361
362
	return nil
}

Michael Yang's avatar
Michael Yang committed
363
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
364
365
366
367
368
369
370
371
372
373
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

374
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
375
376
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
377
		fp, err := GetBlobsPath(layer.Digest)
378
379
380
		if err != nil {
			return err
		}
381
382
383

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

386
387
388
389
390
391
392
			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
393
			if _, err = io.Copy(out, layer.Reader); err != nil {
394
395
				return err
			}
Michael Yang's avatar
Michael Yang committed
396

397
		} else {
398
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
399
400
401
402
403
404
		}
	}

	return nil
}

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

408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
	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
424
	fp, err := mp.GetManifestPath(true)
425
426
427
	if err != nil {
		return err
	}
428
	return os.WriteFile(fp, manifestJSON, 0o644)
429
430
}

Michael Yang's avatar
Michael Yang committed
431
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
432
	fp, err := GetBlobsPath(layer.Digest)
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
	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
}

451
func paramsToReader(params map[string][]string) (io.ReadSeeker, error) {
Michael Yang's avatar
Michael Yang committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
	opts := api.DefaultOptions()
	typeOpts := reflect.TypeOf(opts)

	// build map of json struct tags
	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
		}
	}

	valueOpts := reflect.ValueOf(&opts).Elem()
	// iterate params and set values based on json struct tags
466
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
467
468
469
470
471
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
472
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
473
					if err != nil {
474
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
475
476
477
478
					}

					field.SetFloat(floatVal)
				case reflect.Int:
479
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
480
					if err != nil {
481
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
482
483
484
485
					}

					field.SetInt(intVal)
				case reflect.Bool:
486
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
487
					if err != nil {
488
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
489
490
491
492
					}

					field.SetBool(boolVal)
				case reflect.String:
493
					field.SetString(vals[0])
494
				case reflect.Slice:
495
					field.Set(reflect.ValueOf(vals))
Michael Yang's avatar
Michael Yang committed
496
497
498
499
500
501
502
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

503
504
505
506
507
508
509
	// convert opts to map so that zero fields are not omitted
	out := make(map[string]interface{})
	if err := mapstructure.Decode(opts, &out); err != nil {
		return nil, err
	}

	bts, err := json.Marshal(out)
510
511
512
513
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
514
	return bytes.NewReader(bts), nil
515
516
}

Michael Yang's avatar
Michael Yang committed
517
func getLayerDigests(layers []*LayerReader) ([]string, error) {
518
519
520
521
522
523
524
525
526
527
528
	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
529
530
531
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
	f.Seek(0, 0)
532

Michael Yang's avatar
Michael Yang committed
533
	layer := &LayerReader{
534
535
536
537
538
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
539
		Reader: f,
540
541
542
543
544
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
545
546
547
548
549
550
551
552
553
554
555
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
556
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
557
558
559
560
561
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
562
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
563
564
565
566
567
568
569
570
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

571
func DeleteModel(name string) error {
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
608
609
610
611
612
613
614
615
616
617
618
	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
619
620
621
	if err != nil {
		return err
	}
622

Michael Yang's avatar
Michael Yang committed
623
624
625
626
	if err != nil {
		return err
	}

627
628
629
	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
630
			fp, err := GetBlobsPath(k)
631
			if err != nil {
632
633
634
635
636
				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)
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
				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
}

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

658
659
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
660
	manifest, err := GetManifest(mp)
661
	if err != nil {
662
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
663
664
665
666
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
667
	layers = append(layers, manifest.Layers...)
668
669
670
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
671
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
672
673
674
675
676
		if err != nil {
			return err
		}

		if exists {
677
678
679
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
680
681
				Total:     layer.Size,
				Completed: layer.Size,
682
			})
683
			log.Printf("Layer %s already exists", layer.Digest)
684
685
686
			continue
		}

687
		fn(api.ProgressResponse{
688
689
690
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
691
		})
692

693
		location, err := startUpload(mp, regOpts)
694
695
696
697
698
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

699
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
700
701
702
703
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
704
705
	}

706
	fn(api.ProgressResponse{Status: "pushing manifest"})
707
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
708
709
710
711
712
713
714
715
716
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

717
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
718
719
720
721
722
723
724
725
	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)
726
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
727
728
	}

729
	fn(api.ProgressResponse{Status: "success"})
730
731
732
733

	return nil
}

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

737
	fn(api.ProgressResponse{Status: "pulling manifest"})
738

739
	manifest, err := pullModelManifest(mp, regOpts)
740
	if err != nil {
741
		return fmt.Errorf("pull model manifest: %s", err)
742
743
744
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
745
	layers = append(layers, manifest.Layers...)
746
747
748
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
749
		if err := downloadBlob(mp, layer.Digest, regOpts, fn); err != nil {
750
751
752
753
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
754
755
756
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
757
758
759
760
761
762
763
764
765
766
767
			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
768
769
770
771
			return err
		}
	}

772
	fn(api.ProgressResponse{Status: "writing manifest"})
773

774
	manifestJSON, err := json.Marshal(manifest)
775
776
777
778
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
779
	fp, err := mp.GetManifestPath(true)
780
781
782
783
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
784
	err = os.WriteFile(fp, manifestJSON, 0o644)
785
786
787
788
789
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

790
	fn(api.ProgressResponse{Status: "success"})
791
792
793
794

	return nil
}

795
796
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
797
798
799
800
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

801
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
802
803
804
805
806
807
808
809
	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 {
810
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
811
			return nil, fmt.Errorf("model not found")
812
		}
813
		body, _ := io.ReadAll(resp.Body)
814
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
815
816
817
818
819
820
821
822
823
824
	}

	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
825
func createConfigLayer(layers []string) (*LayerReader, error) {
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
	// 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
	}

841
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
842

Michael Yang's avatar
Michael Yang committed
843
	layer := &LayerReader{
844
845
846
847
848
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
849
		Reader: bytes.NewBuffer(configJSON),
850
851
852
853
854
	}
	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
855
856
857
858
859
860
861
862
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)
863
864
}

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

868
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
869
870
871
872
873
874
875
876
877
	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)
878
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
879
880
881
882
883
884
885
886
887
888
889
890
	}

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

894
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
895
896
897
898
899
900
901
902
903
904
	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
905
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
906
907
908
909
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
910
	fp, err := GetBlobsPath(layer.Digest)
911
912
913
914
	if err != nil {
		return err
	}

915
916
917
918
919
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

920
921
	headers := make(map[string]string)
	headers["Content-Type"] = "application/octet-stream"
922

923
924
925
	chunkSize := 1 << 20
	buf := make([]byte, chunkSize)
	var totalUploaded int
926

927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
	for {
		n, err := f.Read(buf)
		if err != nil {
			return err
		}

		headers["Content-Length"] = fmt.Sprintf("%d", n)
		headers["Content-Range"] = fmt.Sprintf("%d-%d", totalUploaded, totalUploaded+n-1)

		fn(api.ProgressResponse{
			Status:    fmt.Sprintf("uploading %s", layer.Digest),
			Digest:    layer.Digest,
			Total:     int(layer.Size),
			Completed: int(totalUploaded),
		})

		// change the buffersize for the last chunk
		if n < chunkSize {
			buf = buf[:n]
		}
		resp, err := makeRequest("PATCH", url, headers, bytes.NewReader(buf), regOpts)
		if err != nil {
			log.Printf("couldn't upload blob: %v", err)
			return err
		}
		defer resp.Body.Close()
		url = resp.Header.Get("Location")

		// Check for success: For a successful upload, the Docker registry will respond with a 201 Created
		if resp.StatusCode != http.StatusAccepted {
			fn(api.ProgressResponse{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
958
				Status:    "error uploading layer",
959
960
961
962
963
				Digest:    layer.Digest,
				Total:     int(layer.Size),
				Completed: int(totalUploaded),
			})
			body, _ := io.ReadAll(resp.Body)
964
			return fmt.Errorf("on layer upload registry responded with code %d: %v", resp.StatusCode, string(body))
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
		}

		totalUploaded += n
		if totalUploaded >= layer.Size {
			url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)

			// finish the upload
			resp, err := makeRequest("PUT", url, nil, nil, 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)
981
				return fmt.Errorf("on finish upload registry responded with code %d: %v", resp.StatusCode, string(body))
982
983
984
985
			}
			break
		}
	}
986
987
988
	return nil
}

989
func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
990
	fp, err := GetBlobsPath(digest)
991
992
993
994
	if err != nil {
		return err
	}

995
	if fi, _ := os.Stat(fp); fi != nil {
996
		// we already have the file, so return
997
998
999
1000
1001
1002
		fn(api.ProgressResponse{
			Digest:    digest,
			Total:     int(fi.Size()),
			Completed: int(fi.Size()),
		})

1003
1004
1005
1006
		return nil
	}

	var size int64
Bruce MacDonald's avatar
Bruce MacDonald committed
1007
	chunkSize := 1024 * 1024 // 1 MiB in bytes
1008
1009
1010
1011
1012
1013
1014
1015
1016

	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
1017
1018
1019
1020
1021
1022
1023
		// 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)
		}
1024
1025
	}

1026
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1027
1028
1029
1030
	headers := map[string]string{
		"Range": fmt.Sprintf("bytes=%d-", size),
	}

1031
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1032
1033
1034
1035
1036
1037
1038
	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
1039
		body, _ := io.ReadAll(resp.Body)
1040
		return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
1041
1042
1043
1044
1045
1046
1047
1048
1049
	}

	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 {
1050
		return fmt.Errorf("open file: %w", err)
1051
1052
1053
1054
1055
1056
1057
1058
	}
	defer out.Close()

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

	for {
1059
1060
1061
1062
1063
1064
1065
		fn(api.ProgressResponse{
			Status:    fmt.Sprintf("downloading %s", digest),
			Digest:    digest,
			Total:     int(total),
			Completed: int(completed),
		})

1066
		if completed >= total {
Michael Yang's avatar
Michael Yang committed
1067
1068
1069
1070
			if err := out.Close(); err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
1071
			if err := os.Rename(fp+"-partial", fp); err != nil {
1072
1073
1074
1075
1076
1077
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error renaming file: %v", err),
					Digest:    digest,
					Total:     int(total),
					Completed: int(completed),
				})
1078
1079
				return err
			}
Michael Yang's avatar
Michael Yang committed
1080

1081
1082
1083
			break
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
1084
		n, err := io.CopyN(out, resp.Body, int64(chunkSize))
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
		if err != nil && !errors.Is(err, io.EOF) {
			return err
		}
		completed += n
	}

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

1095
1096
1097
1098
1099
1100
1101
1102
1103
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
		}
	}

1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
	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
1114
1115
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
	}

	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
1134

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

Michael Yang's avatar
Michael Yang committed
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
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 {
1151
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1152
1153
1154
1155
	}

	return nil
}