images.go 31.3 KB
Newer Older
1
2
3
package server

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

	"github.com/jmorganca/ollama/api"
22
	"github.com/jmorganca/ollama/llm"
23
	"github.com/jmorganca/ollama/parser"
24
	"github.com/jmorganca/ollama/vector"
25
26
)

27
28
29
30
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
Patrick Devine's avatar
Patrick Devine committed
31
	Token    string
32
33
}

34
type Model struct {
35
36
37
38
39
40
41
42
	Name         string `json:"name"`
	ModelPath    string
	AdapterPaths []string
	Template     string
	System       string
	Digest       string
	Options      map[string]interface{}
	Embeddings   []vector.Embedding
43
44
}

Bruce MacDonald's avatar
Bruce MacDonald committed
45
func (m *Model) Prompt(request api.GenerateRequest, embedding string) (string, error) {
46
47
48
49
50
51
	t := m.Template
	if request.Template != "" {
		t = request.Template
	}

	tmpl, err := template.New("").Parse(t)
52
53
54
55
56
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
57
		First  bool
58
59
		System string
		Prompt string
60
		Embed  string
61
62
63

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

Michael Yang's avatar
Michael Yang committed
66
	vars.First = len(request.Context) == 0
67
68
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
69
	vars.Context = request.Context
Bruce MacDonald's avatar
Bruce MacDonald committed
70
	vars.Embed = embedding
71

72
73
74
75
	if request.System != "" {
		vars.System = request.System
	}

76
77
78
79
80
81
82
83
	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

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

type ConfigV2 struct {
103
104
105
106
107
108
	ModelFamily llm.ModelFamily `json:"model_family"`
	ModelType   llm.ModelType   `json:"model_type"`
	FileType    llm.FileType    `json:"file_type"`
	RootFS      RootFS          `json:"rootfs"`

	// required by spec
109
110
111
112
113
114
115
116
117
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
}

type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Patrick Devine's avatar
Patrick Devine committed
118
119
120
121
122
123
124
125
126
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
127
128
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
129
130
131
	if err != nil {
		return nil, err
	}
132

133
134
	if _, err = os.Stat(fp); err != nil {
		return nil, err
135
136
137
138
	}

	var manifest *ManifestV2

139
	bts, err := os.ReadFile(fp)
140
141
142
143
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

144
	if err := json.Unmarshal(bts, &manifest); err != nil {
145
146
147
148
149
150
151
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
Patrick Devine's avatar
Patrick Devine committed
152
153
154
	mp := ParseModelPath(name)

	manifest, err := GetManifest(mp)
155
156
157
158
159
	if err != nil {
		return nil, err
	}

	model := &Model{
160
		Name:   mp.GetFullTagname(),
Jeffrey Morgan's avatar
Jeffrey Morgan committed
161
		Digest: manifest.Config.Digest,
162
163
164
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
165
		filename, err := GetBlobsPath(layer.Digest)
166
167
168
169
		if err != nil {
			return nil, err
		}

170
171
172
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
173
174
175
176
177
178
179
180
181
182
		case "application/vnd.ollama.image.embed":
			file, err := os.Open(filename)
			if err != nil {
				return nil, fmt.Errorf("failed to open file: %s", filename)
			}
			defer file.Close()

			if err = json.NewDecoder(file).Decode(&model.Embeddings); err != nil {
				return nil, err
			}
183
184
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
185
186
187
188
189
190
191
192
193
		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)
194
195
196
			if err != nil {
				return nil, err
			}
197
198

			model.System = string(bts)
199
200
201
202
203
204
205
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
206
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
207
208
209
210
211
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
212

213
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
214
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
215
216
				return nil, err
			}
217
218
219
220
221
222
		}
	}

	return model, nil
}

223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
func filenameWithPath(path, f string) (string, error) {
	// if filePath starts with ~/, replace it with the user's home directory.
	if strings.HasPrefix(f, "~/") {
		parts := strings.Split(f, "/")
		home, err := os.UserHomeDir()
		if err != nil {
			return "", fmt.Errorf("failed to open file: %v", err)
		}

		f = filepath.Join(home, filepath.Join(parts[1:]...))
	}

	// if filePath is not an absolute path, make it relative to the modelfile path
	if !filepath.IsAbs(f) {
		f = filepath.Join(filepath.Dir(path), f)
	}

	return f, nil
}

243
func CreateModel(ctx context.Context, name string, path string, fn func(resp api.ProgressResponse)) error {
244
245
	mf, err := os.Open(path)
	if err != nil {
246
		fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
247
		return fmt.Errorf("failed to open file: %w", err)
248
	}
249
	defer mf.Close()
250

251
	fn(api.ProgressResponse{Status: "parsing modelfile"})
252
253
254
255
256
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

257
258
259
260
261
	config := ConfigV2{
		Architecture: "amd64",
		OS:           "linux",
	}

Michael Yang's avatar
Michael Yang committed
262
	var layers []*LayerReader
263
	params := make(map[string][]string)
264
	embed := EmbeddingParams{fn: fn, opts: api.DefaultOptions()}
265
	for _, c := range commands {
266
		log.Printf("[%s] - %s\n", c.Name, c.Args)
267
268
		switch c.Name {
		case "model":
269
			fn(api.ProgressResponse{Status: "looking for model"})
270
			embed.model = c.Args
271
			mf, err := GetManifest(ParseModelPath(c.Args))
272
			if err != nil {
273
274
275
				modelFile, err := filenameWithPath(path, c.Args)
				if err != nil {
					return err
276
				}
277
				if _, err := os.Stat(modelFile); err != nil {
278
279
280
					// the model file does not exist, try pulling it
					if errors.Is(err, os.ErrNotExist) {
						fn(api.ProgressResponse{Status: "pulling model file"})
281
						if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
282
283
							return err
						}
284
						mf, err = GetManifest(ParseModelPath(c.Args))
285
286
287
288
289
290
291
292
293
						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"})
294
					file, err := os.Open(modelFile)
295
296
297
298
299
					if err != nil {
						return fmt.Errorf("failed to open file: %v", err)
					}
					defer file.Close()

300
301
302
303
304
305
306
307
308
309
310
311
					ggml, err := llm.DecodeGGML(file, llm.ModelFamilyLlama)
					if err != nil {
						return err
					}

					config.ModelFamily = ggml.ModelFamily
					config.ModelType = ggml.ModelType
					config.FileType = ggml.FileType

					// reset the file
					file.Seek(0, io.SeekStart)

312
313
314
315
316
317
					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)
318
				}
319
			}
320

321
			if mf != nil {
322
323
324
325
326
327
328
329
330
				log.Printf("manifest = %#v", mf)
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
					layers = append(layers, newLayer)
				}
			}
331
332
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
333
334
335
			if err != nil {
				return err
			}
336
			embed.files = append(embed.files, embedFilePath)
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
		case "adapter":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})

			fp := c.Args
			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)
			}

			// create a model from this specified file
			fn(api.ProgressResponse{Status: "creating model layer"})

			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.adapter"
			layers = append(layers, l)
Bruce MacDonald's avatar
Bruce MacDonald committed
371
372
373
374
375
376
377
378
379
380
381
382
		case "license":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
			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":
383
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
384
			// remove the layer if one exists
385
386
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
387

388
			layer, err := CreateLayer(strings.NewReader(c.Args))
389
			if err != nil {
390
				return err
391
			}
392
393
394

			layer.MediaType = mediaType
			layers = append(layers, layer)
395
		default:
396
397
			// 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)
398
399
400
401
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
402
	if len(params) > 0 {
403
		fn(api.ProgressResponse{Status: "creating parameter layer"})
404
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
405
		formattedParams, err := formatParams(params)
406
407
408
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
409
410
411
412
413
414
415

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

		l, err := CreateLayer(bytes.NewReader(bts))
416
417
418
419
420
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
421
422
423
424

		// apply these parameters to the embedding options, in case embeddings need to be generated using this model
		embed.opts = api.DefaultOptions()
		embed.opts.FromMap(formattedParams)
425
426
	}

427
428
429
430
431
432
433
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

434
435
436
437
438
439
440
441
442
443
444
	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
445
	fn(api.ProgressResponse{Status: "creating config layer"})
446
	cfg, err := createConfigLayer(config, digests)
447
448
449
450
451
452
453
454
455
456
457
	if err != nil {
		return err
	}
	layers = append(layers, cfg)

	err = SaveLayers(layers, fn, false)
	if err != nil {
		return err
	}

	// Create the manifest
458
	fn(api.ProgressResponse{Status: "writing manifest"})
459
460
461
462
463
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

464
	fn(api.ProgressResponse{Status: "success"})
465
466
467
	return nil
}

468
469
470
471
472
473
474
475
476
477
478
type EmbeddingParams struct {
	model string
	opts  api.Options
	files []string // paths to files to embed
	fn    func(resp api.ProgressResponse)
}

// embeddingLayers loads the associated LLM and generates the embeddings to be stored from an input file
func embeddingLayers(e EmbeddingParams) ([]*LayerReader, error) {
	layers := []*LayerReader{}
	if len(e.files) > 0 {
479
480
481
482
483
484
485
486
487
488
489
		if _, err := os.Stat(e.model); err != nil {
			if os.IsNotExist(err) {
				// this is a model name rather than the file
				model, err := GetModel(e.model)
				if err != nil {
					return nil, fmt.Errorf("failed to get model to generate embeddings: %v", err)
				}
				e.model = model.ModelPath
			} else {
				return nil, fmt.Errorf("failed to get model file to generate embeddings: %v", err)
			}
490
491
492
		}

		e.opts.EmbeddingOnly = true
493
		llmModel, err := llm.New(e.model, []string{}, e.opts)
494
495
496
		if err != nil {
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
497
		defer func() {
498
499
			if llmModel != nil {
				llmModel.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
500
501
			}
		}()
502

Bruce MacDonald's avatar
Bruce MacDonald committed
503
504
505
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
506
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
507
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
508
509
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
510
511
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
512
513
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
514
515
516
				addedFiles[filePath] = true
				// TODO: check file type
				f, err := os.Open(filePath)
517
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
518
					return nil, fmt.Errorf("could not open embed file: %w", err)
519
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
				scanner := bufio.NewScanner(f)
				scanner.Split(bufio.ScanLines)

				data := []string{}
				for scanner.Scan() {
					data = append(data, scanner.Text())
				}
				f.Close()

				// the digest of the file is set here so that the client knows a new operation is in progress
				fileDigest, _ := GetSHA256Digest(bytes.NewReader([]byte(filePath)))

				embeddings := []vector.Embedding{}
				for i, d := range data {
					if strings.TrimSpace(d) == "" {
						continue
					}
					e.fn(api.ProgressResponse{
						Status:    fmt.Sprintf("creating embeddings for file %s", filePath),
						Digest:    fileDigest,
						Total:     len(data) - 1,
						Completed: i,
					})
543
					embed, err := llmModel.Embedding(d)
Bruce MacDonald's avatar
Bruce MacDonald committed
544
					if err != nil {
545
546
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
Bruce MacDonald's avatar
Bruce MacDonald committed
547
548
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
549
550
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
551
552
553
554
555
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
556

Bruce MacDonald's avatar
Bruce MacDonald committed
557
558
559
560
561
				digest, size := GetSHA256Digest(r)
				// Reset the position of the reader after calculating the digest
				if _, err := r.Seek(0, io.SeekStart); err != nil {
					return nil, fmt.Errorf("could not reset embed reader: %w", err)
				}
562

Bruce MacDonald's avatar
Bruce MacDonald committed
563
564
565
566
567
568
569
570
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
						Size:      size,
					},
					Reader: r,
				}
571

Bruce MacDonald's avatar
Bruce MacDonald committed
572
573
				layers = append(layers, layer)
			}
574
575
576
577
578
		}
	}
	return layers, nil
}

Michael Yang's avatar
Michael Yang committed
579
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
580
581
582
583
584
585
586
587
588
589
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

590
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
591
592
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
593
		fp, err := GetBlobsPath(layer.Digest)
594
595
596
		if err != nil {
			return err
		}
597
598
599

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

602
603
604
605
606
607
608
			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
609
			if _, err = io.Copy(out, layer.Reader); err != nil {
610
611
				return err
			}
Michael Yang's avatar
Michael Yang committed
612

613
		} else {
614
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
615
616
617
618
619
620
		}
	}

	return nil
}

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

624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
	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
640
	fp, err := mp.GetManifestPath(true)
641
642
643
	if err != nil {
		return err
	}
644
	return os.WriteFile(fp, manifestJSON, 0o644)
645
646
}

Michael Yang's avatar
Michael Yang committed
647
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
648
	fp, err := GetBlobsPath(layer.Digest)
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
	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
}

667
668
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
669
670
671
	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
672

673
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
674
675
676
677
678
679
680
681
	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
		}
	}

682
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
683
	// iterate params and set values based on json struct tags
684
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
685
686
687
688
689
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
690
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
691
					if err != nil {
692
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
693
694
					}

695
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
696
				case reflect.Int:
697
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
698
					if err != nil {
699
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
700
701
					}

702
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
703
				case reflect.Bool:
704
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
705
					if err != nil {
706
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
707
708
					}

709
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
710
				case reflect.String:
711
					out[key] = vals[0]
712
				case reflect.Slice:
713
714
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
715
716
717
718
719
720
721
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

722
	return out, nil
723
724
}

Michael Yang's avatar
Michael Yang committed
725
func getLayerDigests(layers []*LayerReader) ([]string, error) {
726
727
728
729
730
731
732
733
734
735
736
	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
737
738
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
739
	f.Seek(0, io.SeekStart)
740

Michael Yang's avatar
Michael Yang committed
741
	layer := &LayerReader{
742
743
744
745
746
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
747
		Reader: f,
748
749
750
751
752
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
753
754
755
756
757
758
759
760
761
762
763
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
764
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
765
766
767
768
769
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
770
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
771
772
773
774
775
776
777
778
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

779
func DeleteModel(name string) error {
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
	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
827
828
829
	if err != nil {
		return err
	}
830
831
832
833

	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
834
			fp, err := GetBlobsPath(k)
835
			if err != nil {
836
837
838
839
840
				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)
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
				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
}

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

862
863
	fn(api.ProgressResponse{Status: "retrieving manifest"})

Patrick Devine's avatar
Patrick Devine committed
864
	manifest, err := GetManifest(mp)
865
	if err != nil {
866
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
867
868
869
870
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
871
	layers = append(layers, manifest.Layers...)
872
873
874
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
875
		exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
876
877
878
879
880
		if err != nil {
			return err
		}

		if exists {
881
882
883
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
884
885
				Total:     layer.Size,
				Completed: layer.Size,
886
			})
887
			log.Printf("Layer %s already exists", layer.Digest)
888
889
890
			continue
		}

891
		fn(api.ProgressResponse{
892
893
894
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
895
		})
896

897
		location, err := startUpload(mp, regOpts)
898
899
900
901
902
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

903
		err = uploadBlobChunked(mp, location, layer, regOpts, fn)
904
905
906
907
		if err != nil {
			log.Printf("error uploading blob: %v", err)
			return err
		}
908
909
	}

910
	fn(api.ProgressResponse{Status: "pushing manifest"})
911
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
912
913
914
915
916
917
918
919
920
	headers := map[string]string{
		"Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
	}

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

921
	resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
922
923
924
925
926
927
928
929
	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)
930
		return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
931
932
	}

933
	fn(api.ProgressResponse{Status: "success"})
934
935
936
937

	return nil
}

938
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
Patrick Devine's avatar
Patrick Devine committed
939
	mp := ParseModelPath(name)
940

941
	fn(api.ProgressResponse{Status: "pulling manifest"})
942

943
	manifest, err := pullModelManifest(mp, regOpts)
944
	if err != nil {
945
		return fmt.Errorf("pull model manifest: %s", err)
946
947
948
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
949
	layers = append(layers, manifest.Layers...)
950
951
952
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
953
		if err := downloadBlob(ctx, mp, layer.Digest, regOpts, fn); err != nil {
954
955
956
957
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
958
959
960
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
961
962
963
964
965
966
967
968
969
970
971
			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
972
973
974
975
			return err
		}
	}

976
	fn(api.ProgressResponse{Status: "writing manifest"})
977

978
	manifestJSON, err := json.Marshal(manifest)
979
980
981
982
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
983
	fp, err := mp.GetManifestPath(true)
984
985
986
987
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
988
	err = os.WriteFile(fp, manifestJSON, 0o644)
989
990
991
992
993
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

994
	fn(api.ProgressResponse{Status: "success"})
995
996
997
998

	return nil
}

999
1000
func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
	url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
1001
1002
1003
1004
	headers := map[string]string{
		"Accept": "application/vnd.docker.distribution.manifest.v2+json",
	}

1005
	resp, err := makeRequest("GET", url, headers, nil, regOpts)
1006
1007
1008
1009
1010
1011
1012
1013
	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 {
1014
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
1015
			return nil, fmt.Errorf("model not found")
1016
		}
1017
		body, _ := io.ReadAll(resp.Body)
1018
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
	}

	var m *ManifestV2
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

	return m, err
}

1029
1030
1031
1032
func createConfigLayer(config ConfigV2, layers []string) (*LayerReader, error) {
	config.RootFS = RootFS{
		Type:    "layers",
		DiffIDs: layers,
1033
1034
1035
1036
1037
1038
1039
	}

	configJSON, err := json.Marshal(config)
	if err != nil {
		return nil, err
	}

1040
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
1041

Michael Yang's avatar
Michael Yang committed
1042
	layer := &LayerReader{
1043
1044
1045
1046
1047
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
1048
		Reader: bytes.NewBuffer(configJSON),
1049
1050
1051
1052
1053
	}
	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
1054
1055
1056
1057
1058
1059
1060
1061
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)
1062
1063
}

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

1067
	resp, err := makeRequest("POST", url, nil, nil, regOpts)
1068
1069
1070
1071
1072
1073
1074
1075
1076
	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)
1077
		return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
	}

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

1093
	resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
	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
1104
func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1105
1106
1107
1108
	// TODO allow resumability
	// TODO allow canceling uploads via DELETE
	// TODO allow cross repo blob mount

Patrick Devine's avatar
Patrick Devine committed
1109
	fp, err := GetBlobsPath(layer.Digest)
1110
1111
1112
1113
	if err != nil {
		return err
	}

1114
1115
1116
1117
1118
	f, err := os.Open(fp)
	if err != nil {
		return err
	}

1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
	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
			}
1137

1138
			totalUploaded += int(n)
1139
1140

			fn(api.ProgressResponse{
1141
				Status:    fmt.Sprintf("uploading %s", layer.Digest),
1142
				Digest:    layer.Digest,
1143
1144
				Total:     layer.Size,
				Completed: totalUploaded,
1145
			})
1146
1147
1148
1149

			if totalUploaded >= layer.Size {
				return
			}
1150
		}
1151
	}()
1152

1153
	url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
1154

1155
1156
1157
1158
	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))
1159

1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
	// 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))
1171
	}
1172
1173
1174
	return nil
}

1175
1176
1177
1178
1179
1180
1181
1182
1183
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
		}
	}

Patrick Devine's avatar
Patrick Devine committed
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
	// make a copy of the body in case we need to try the call to makeRequest again
	var buf bytes.Buffer
	if body != nil {
		_, err := io.Copy(&buf, body)
		if err != nil {
			return nil, err
		}
	}

	bodyCopy := bytes.NewReader(buf.Bytes())

	req, err := http.NewRequest(method, url, bodyCopy)
1196
1197
1198
1199
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1200
1201
1202
1203
	if regOpts.Token != "" {
		req.Header.Set("Authorization", "Bearer "+regOpts.Token)
	} else if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1204
1205
	}

Patrick Devine's avatar
Patrick Devine committed
1206
1207
	for k, v := range headers {
		req.Header.Set(k, v)
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
	}

	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
	}

Patrick Devine's avatar
Patrick Devine committed
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
	// if the request is unauthenticated, try to authenticate and make the request again
	if resp.StatusCode == http.StatusUnauthorized {
		auth := resp.Header.Get("Www-Authenticate")
		authRedir := ParseAuthRedirectString(string(auth))
		token, err := getAuthToken(authRedir, regOpts)
		if err != nil {
			return nil, err
		}
		regOpts.Token = token
		bodyCopy = bytes.NewReader(buf.Bytes())
		return makeRequest(method, url, headers, bodyCopy, regOpts)
	}

1237
1238
	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1239

Patrick Devine's avatar
Patrick Devine committed
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
func getValue(header, key string) string {
	startIdx := strings.Index(header, key+"=")
	if startIdx == -1 {
		return ""
	}

	// Move the index to the starting quote after the key.
	startIdx += len(key) + 2
	endIdx := startIdx

	for endIdx < len(header) {
		if header[endIdx] == '"' {
			if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
				endIdx++
				continue
			}
			break
		}
		endIdx++
	}
	return header[startIdx:endIdx]
}

func ParseAuthRedirectString(authStr string) AuthRedirect {
	authStr = strings.TrimPrefix(authStr, "Bearer ")

	return AuthRedirect{
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

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

	return nil
}