images.go 26.6 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
36
37
	Options   api.Options
}

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

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

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

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

	return sb.String(), nil
}

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

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

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

	var manifest *ManifestV2

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

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

	return manifest, nil
}

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

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

	model := &Model{
Patrick Devine's avatar
Patrick Devine committed
137
		Name: mp.GetFullTagname(),
138
139
140
	}

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

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

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

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

			var opts api.Options
Michael Yang's avatar
Michael Yang committed
178
179
180
181
			if err = json.NewDecoder(params).Decode(&opts); err != nil {
				return nil, err
			}

182
183
184
185
186
187
188
			model.Options = opts
		}
	}

	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
func paramsToReader(params map[string][]string) (io.ReadSeeker, error) {
Michael Yang's avatar
Michael Yang committed
444
445
446
447
448
449
450
451
452
453
454
455
456
457
	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
458
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
459
460
461
462
463
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
464
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
465
					if err != nil {
466
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
467
468
469
470
					}

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

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

					field.SetBool(boolVal)
				case reflect.String:
485
					field.SetString(vals[0])
486
				case reflect.Slice:
487
					field.Set(reflect.ValueOf(vals))
Michael Yang's avatar
Michael Yang committed
488
489
490
491
492
493
494
495
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

	bts, err := json.Marshal(opts)
496
497
498
499
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
500
	return bytes.NewReader(bts), nil
501
502
}

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

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

	return layer, nil
}

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

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

	return nil
}

557
func DeleteModel(name string) error {
558
559
560
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
	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
605
606
607
	if err != nil {
		return err
	}
608

Michael Yang's avatar
Michael Yang committed
609
610
611
612
	if err != nil {
		return err
	}

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

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

644
645
	fn(api.ProgressResponse{Status: "retrieving manifest"})

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

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
653
	layers = append(layers, manifest.Layers...)
654
655
656
	layers = append(layers, &manifest.Config)

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

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

673
		fn(api.ProgressResponse{
674
675
676
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
677
		})
678

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

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

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

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

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

715
	fn(api.ProgressResponse{Status: "success"})
716
717
718
719

	return nil
}

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

723
	fn(api.ProgressResponse{Status: "pulling manifest"})
724

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

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
731
	layers = append(layers, manifest.Layers...)
732
733
734
	layers = append(layers, &manifest.Config)

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

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

758
	fn(api.ProgressResponse{Status: "writing manifest"})
759

760
	manifestJSON, err := json.Marshal(manifest)
761
762
763
764
	if err != nil {
		return err
	}

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

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

776
	fn(api.ProgressResponse{Status: "success"})
777
778
779
780

	return nil
}

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

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

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

827
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
828

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

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

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

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

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

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

901
902
903
904
905
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

906
907
	headers := make(map[string]string)
	headers["Content-Type"] = "application/octet-stream"
908

909
910
911
	chunkSize := 1 << 20
	buf := make([]byte, chunkSize)
	var totalUploaded int
912

913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
	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
944
				Status:    "error uploading layer",
945
946
947
948
949
				Digest:    layer.Digest,
				Total:     int(layer.Size),
				Completed: int(totalUploaded),
			})
			body, _ := io.ReadAll(resp.Body)
950
			return fmt.Errorf("on layer upload registry responded with code %d: %v", resp.StatusCode, string(body))
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
		}

		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)
967
				return fmt.Errorf("on finish upload registry responded with code %d: %v", resp.StatusCode, string(body))
968
969
970
971
			}
			break
		}
	}
972
973
974
	return nil
}

975
func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
976
	fp, err := GetBlobsPath(digest)
977
978
979
980
	if err != nil {
		return err
	}

981
	if fi, _ := os.Stat(fp); fi != nil {
982
		// we already have the file, so return
983
984
985
986
987
988
		fn(api.ProgressResponse{
			Digest:    digest,
			Total:     int(fi.Size()),
			Completed: int(fi.Size()),
		})

989
990
991
992
		return nil
	}

	var size int64
Bruce MacDonald's avatar
Bruce MacDonald committed
993
	chunkSize := 1024 * 1024 // 1 MiB in bytes
994
995
996
997
998
999
1000
1001
1002

	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
1003
1004
1005
1006
1007
1008
1009
		// 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)
		}
1010
1011
	}

1012
	url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
1013
1014
1015
1016
	headers := map[string]string{
		"Range": fmt.Sprintf("bytes=%d-", size),
	}

1017
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1018
1019
1020
1021
1022
1023
1024
	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
1025
		body, _ := io.ReadAll(resp.Body)
1026
		return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
1027
1028
1029
1030
1031
1032
1033
1034
1035
	}

	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 {
1036
		return fmt.Errorf("open file: %w", err)
1037
1038
1039
1040
1041
1042
1043
1044
	}
	defer out.Close()

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

	for {
1045
1046
1047
1048
1049
1050
1051
		fn(api.ProgressResponse{
			Status:    fmt.Sprintf("downloading %s", digest),
			Digest:    digest,
			Total:     int(total),
			Completed: int(completed),
		})

1052
		if completed >= total {
Michael Yang's avatar
Michael Yang committed
1053
1054
1055
1056
			if err := out.Close(); err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
1057
			if err := os.Rename(fp+"-partial", fp); err != nil {
1058
1059
1060
1061
1062
1063
				fn(api.ProgressResponse{
					Status:    fmt.Sprintf("error renaming file: %v", err),
					Digest:    digest,
					Total:     int(total),
					Completed: int(completed),
				})
1064
1065
				return err
			}
Michael Yang's avatar
Michael Yang committed
1066

1067
1068
1069
			break
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
1070
		n, err := io.CopyN(out, resp.Body, int64(chunkSize))
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
		if err != nil && !errors.Is(err, io.EOF) {
			return err
		}
		completed += n
	}

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

1081
1082
1083
1084
1085
1086
1087
1088
1089
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
		}
	}

1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
	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
1100
1101
	if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
	}

	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
1120

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

Michael Yang's avatar
Michael Yang committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
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 {
1137
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1138
1139
1140
1141
	}

	return nil
}