images.go 26.6 KB
Newer Older
1
2
3
4
5
6
7
8
package server

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

	"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
func (m *Model) Prompt(request api.GenerateRequest) (string, error) {
40
41
42
43
44
45
	t := m.Template
	if request.Template != "" {
		t = request.Template
	}

	tmpl, err := template.New("").Parse(t)
46
47
48
49
50
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
51
		First  bool
52
53
		System string
		Prompt string
54
55
56

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

Michael Yang's avatar
Michael Yang committed
59
	vars.First = len(request.Context) == 0
60
61
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
62
	vars.Context = request.Context
63

64
65
66
67
	if request.System != "" {
		vars.System = request.System
	}

68
69
70
71
72
73
74
75
	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

76
77
78
79
80
81
82
83
84
85
86
87
88
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
89
type LayerReader struct {
90
	Layer
Michael Yang's avatar
Michael Yang committed
91
	io.Reader
92
93
94
95
96
97
98
99
100
101
102
103
104
}

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
105
106
107
108
109
110
111
112
113
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
114
115
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
116
117
118
	if err != nil {
		return nil, err
	}
119

120
121
	if _, err = os.Stat(fp); err != nil {
		return nil, err
122
123
124
125
	}

	var manifest *ManifestV2

126
	bts, err := os.ReadFile(fp)
127
128
129
130
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

131
	if err := json.Unmarshal(bts, &manifest); err != nil {
132
133
134
135
136
137
138
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
139
140
141
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
142
143
144
145
146
	if err != nil {
		return nil, err
	}

	model := &Model{
147
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
148
		Digest: manifest.Config.Digest,
149
150
151
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
152
		filename, err := GetBlobsPath(layer.Digest)
153
154
155
156
		if err != nil {
			return nil, err
		}

157
158
159
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
160
161
162
163
164
165
166
167
168
		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)
169
170
171
			if err != nil {
				return nil, err
			}
172
173

			model.System = string(bts)
174
175
176
177
178
179
180
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
181
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
182
183
184
185
186
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
187

188
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
189
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
190
191
				return nil, err
			}
192
193
194
195
196
197
		}
	}

	return model, nil
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

452
// paramsToReader converts specified parameter options to their correct types, and returns a reader for the json
453
func paramsToReader(params map[string][]string) (io.ReadSeeker, error) {
454
455
456
	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
457

458
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
459
460
461
462
463
464
465
466
	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
		}
	}

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

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

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

494
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
495
				case reflect.String:
496
					out[key] = vals[0]
497
				case reflect.Slice:
498
499
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
500
501
502
503
504
505
506
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

507
	bts, err := json.Marshal(out)
508
509
510
511
	if err != nil {
		return nil, err
	}

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

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

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

	return layer, nil
}

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

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

	return nil
}

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

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

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

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

656
657
	fn(api.ProgressResponse{Status: "retrieving manifest"})

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

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

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

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

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

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

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

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

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

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

727
	fn(api.ProgressResponse{Status: "success"})
728
729
730
731

	return nil
}

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

735
	fn(api.ProgressResponse{Status: "pulling manifest"})
736

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

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

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

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

770
	fn(api.ProgressResponse{Status: "writing manifest"})
771

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

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

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

788
	fn(api.ProgressResponse{Status: "success"})
789
790
791
792

	return nil
}

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

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

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

839
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
840

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

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

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

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

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

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

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

918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
	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
			}
936

937
			totalUploaded += int(n)
938
939

			fn(api.ProgressResponse{
940
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
941
				Digest:    layer.Digest,
942
943
				Total:     layer.Size,
				Completed: totalUploaded,
944
			})
945
946
947
948

			if totalUploaded >= layer.Size {
				return
			}
949
		}
950
	}()
951

952
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
953

954
955
956
957
	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))
958

959
960
961
962
963
964
965
966
967
968
969
	// 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))
970
	}
971
972
973
	return nil
}

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

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

988
989
990
991
		return nil
	}

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

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

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

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

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

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

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

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

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

1066
1067
1068
			break
		}

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

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

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

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

	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
1119

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

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

	return nil
}