images.go 32.1 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
	"io"
	"log"
	"net/http"
Michael Yang's avatar
Michael Yang committed
15
	"net/url"
16
	"os"
Michael Yang's avatar
Michael Yang committed
17
	"path"
18
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
19
	"reflect"
Michael Yang's avatar
Michael Yang committed
20
	"runtime"
21
22
23
24
	"strconv"
	"strings"

	"github.com/jmorganca/ollama/api"
25
	"github.com/jmorganca/ollama/llm"
26
	"github.com/jmorganca/ollama/parser"
27
	"github.com/jmorganca/ollama/vector"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/jmorganca/ollama/version"
29
30
)

31
32
const MaxRetries = 3

33
34
35
36
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
Patrick Devine's avatar
Patrick Devine committed
37
	Token    string
38
39
}

40
type Model struct {
41
42
43
44
45
46
47
48
	Name         string `json:"name"`
	ModelPath    string
	AdapterPaths []string
	Template     string
	System       string
	Digest       string
	Options      map[string]interface{}
	Embeddings   []vector.Embedding
49
50
}

Bruce MacDonald's avatar
Bruce MacDonald committed
51
func (m *Model) Prompt(request api.GenerateRequest, embedding string) (string, error) {
52
53
54
55
56
57
	t := m.Template
	if request.Template != "" {
		t = request.Template
	}

	tmpl, err := template.New("").Parse(t)
58
59
60
61
62
	if err != nil {
		return "", err
	}

	var vars struct {
Michael Yang's avatar
Michael Yang committed
63
		First  bool
64
65
		System string
		Prompt string
66
		Embed  string
67
68
69

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

Michael Yang's avatar
Michael Yang committed
72
	vars.First = len(request.Context) == 0
73
74
	vars.System = m.System
	vars.Prompt = request.Prompt
Michael Yang's avatar
Michael Yang committed
75
	vars.Context = request.Context
Bruce MacDonald's avatar
Bruce MacDonald committed
76
	vars.Embed = embedding
77

78
79
80
81
	if request.System != "" {
		vars.System = request.System
	}

82
83
84
85
86
87
88
89
	var sb strings.Builder
	if err := tmpl.Execute(&sb, vars); err != nil {
		return "", err
	}

	return sb.String(), nil
}

90
91
92
93
94
95
96
97
98
99
100
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
101
	From      string `json:"from,omitempty"`
102
103
}

Michael Yang's avatar
Michael Yang committed
104
type LayerReader struct {
105
	Layer
Michael Yang's avatar
Michael Yang committed
106
	io.Reader
107
108
109
}

type ConfigV2 struct {
110
	ModelFamily llm.ModelFamily `json:"model_family"`
Michael Yang's avatar
fmt  
Michael Yang committed
111
112
113
	ModelType   string          `json:"model_type"`
	FileType    string          `json:"file_type"`
	RootFS      RootFS          `json:"rootfs"`
114
115

	// required by spec
116
117
118
119
120
121
122
123
124
	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
125
126
127
128
129
130
131
132
133
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
134
135
func GetManifest(mp ModelPath) (*ManifestV2, error) {
	fp, err := mp.GetManifestPath(false)
136
137
138
	if err != nil {
		return nil, err
	}
139

140
141
	if _, err = os.Stat(fp); err != nil {
		return nil, err
142
143
144
145
	}

	var manifest *ManifestV2

146
	bts, err := os.ReadFile(fp)
147
148
149
150
	if err != nil {
		return nil, fmt.Errorf("couldn't open file '%s'", fp)
	}

151
	if err := json.Unmarshal(bts, &manifest); err != nil {
152
153
154
155
156
157
158
		return nil, err
	}

	return manifest, nil
}

func GetModel(name string) (*Model, error) {
159
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
160
	manifest, err := GetManifest(mp)
161
162
163
164
165
	if err != nil {
		return nil, err
	}

	model := &Model{
Michael Yang's avatar
Michael Yang committed
166
167
168
		Name:     mp.GetFullTagname(),
		Digest:   manifest.Config.Digest,
		Template: "{{ .Prompt }}",
169
170
171
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
172
		filename, err := GetBlobsPath(layer.Digest)
173
174
175
176
		if err != nil {
			return nil, err
		}

177
178
179
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
180
181
182
183
184
185
186
187
188
189
		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
			}
190
191
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
192
193
194
195
196
197
198
199
200
		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)
201
202
203
			if err != nil {
				return nil, err
			}
204
205

			model.System = string(bts)
206
207
208
209
210
211
212
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
213
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
214
215
216
217
218
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
219

220
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
221
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
222
223
				return nil, err
			}
224
225
226
227
228
229
		}
	}

	return model, nil
}

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
}

250
func CreateModel(ctx context.Context, name string, path string, fn func(resp api.ProgressResponse)) error {
251
252
	mf, err := os.Open(path)
	if err != nil {
253
		fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
254
		return fmt.Errorf("failed to open file: %w", err)
255
	}
256
	defer mf.Close()
257

258
	fn(api.ProgressResponse{Status: "parsing modelfile"})
259
260
261
262
263
	commands, err := parser.Parse(mf)
	if err != nil {
		return err
	}

264
265
266
267
268
	config := ConfigV2{
		Architecture: "amd64",
		OS:           "linux",
	}

Michael Yang's avatar
Michael Yang committed
269
	var layers []*LayerReader
270
	params := make(map[string][]string)
271
	embed := EmbeddingParams{fn: fn}
272
	for _, c := range commands {
273
		log.Printf("[%s] - %s\n", c.Name, c.Args)
274
275
		switch c.Name {
		case "model":
276
			fn(api.ProgressResponse{Status: "looking for model"})
277
			embed.model = c.Args
278

279
			mp := ParseModelPath(c.Args)
Michael Yang's avatar
Michael Yang committed
280
			mf, err := GetManifest(mp)
281
			if err != nil {
282
283
284
				modelFile, err := filenameWithPath(path, c.Args)
				if err != nil {
					return err
285
				}
286
				if _, err := os.Stat(modelFile); err != nil {
287
288
289
					// the model file does not exist, try pulling it
					if errors.Is(err, os.ErrNotExist) {
						fn(api.ProgressResponse{Status: "pulling model file"})
290
						if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
291
292
							return err
						}
293
						mf, err = GetManifest(mp)
294
295
296
297
298
299
300
						if err != nil {
							return fmt.Errorf("failed to open file after pull: %v", err)
						}
					} else {
						return err
					}
				} else {
301
					embed.model = modelFile
302
303
					// create a model from this specified file
					fn(api.ProgressResponse{Status: "creating model layer"})
304
					file, err := os.Open(modelFile)
305
306
307
308
309
					if err != nil {
						return fmt.Errorf("failed to open file: %v", err)
					}
					defer file.Close()

310
311
312
313
314
					ggml, err := llm.DecodeGGML(file, llm.ModelFamilyLlama)
					if err != nil {
						return err
					}

Michael Yang's avatar
Michael Yang committed
315
316
317
					config.ModelFamily = ggml.ModelFamily()
					config.ModelType = ggml.ModelType().String()
					config.FileType = ggml.FileType().String()
318
319
320
321

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

322
323
324
325
326
327
					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)
328
				}
329
			}
330

331
			if mf != nil {
Michael Yang's avatar
Michael Yang committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
				sourceBlobPath, err := GetBlobsPath(mf.Config.Digest)
				if err != nil {
					return err
				}

				sourceBlob, err := os.Open(sourceBlobPath)
				if err != nil {
					return err
				}
				defer sourceBlob.Close()

				var source ConfigV2
				if err := json.NewDecoder(sourceBlob).Decode(&source); err != nil {
					return err
				}

				// copie the model metadata
				config.ModelFamily = source.ModelFamily
				config.ModelType = source.ModelType
				config.FileType = source.FileType

353
354
355
356
357
				for _, l := range mf.Layers {
					newLayer, err := GetLayerWithBufferFromLayer(l)
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
358
					newLayer.From = mp.GetNamespaceRepository()
359
360
361
					layers = append(layers, newLayer)
				}
			}
362
363
		case "embed":
			embedFilePath, err := filenameWithPath(path, c.Args)
Michael Yang's avatar
Michael Yang committed
364
365
366
			if err != nil {
				return err
			}
367
			embed.files = append(embed.files, embedFilePath)
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
		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
402
403
404
405
406
407
408
409
410
411
412
413
		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":
414
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
415
			// remove the layer if one exists
416
417
			mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
			layers = removeLayerFromLayers(layers, mediaType)
418

419
			layer, err := CreateLayer(strings.NewReader(c.Args))
420
			if err != nil {
421
				return err
422
			}
423
424
425

			layer.MediaType = mediaType
			layers = append(layers, layer)
426
		default:
427
428
			// 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)
429
430
431
432
		}
	}

	// Create a single layer for the parameters
Michael Yang's avatar
Michael Yang committed
433
	if len(params) > 0 {
434
		fn(api.ProgressResponse{Status: "creating parameter layer"})
435
		layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
436
		formattedParams, err := formatParams(params)
437
438
439
		if err != nil {
			return fmt.Errorf("couldn't create params json: %v", err)
		}
440
441
442
443
444
445
446

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

		l, err := CreateLayer(bytes.NewReader(bts))
447
448
449
450
451
		if err != nil {
			return fmt.Errorf("failed to create layer: %v", err)
		}
		l.MediaType = "application/vnd.ollama.image.params"
		layers = append(layers, l)
452
453

		// apply these parameters to the embedding options, in case embeddings need to be generated using this model
454
		embed.opts = formattedParams
455
456
	}

457
458
459
460
461
462
463
	// generate the embedding layers
	embeddingLayers, err := embeddingLayers(embed)
	if err != nil {
		return err
	}
	layers = append(layers, embeddingLayers...)

464
465
466
467
468
469
470
471
472
473
474
	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
475
	fn(api.ProgressResponse{Status: "creating config layer"})
476
	cfg, err := createConfigLayer(config, digests)
477
478
479
480
481
	if err != nil {
		return err
	}
	layers = append(layers, cfg)

Michael Yang's avatar
Michael Yang committed
482
	if err := SaveLayers(layers, fn, false); err != nil {
483
484
485
486
		return err
	}

	// Create the manifest
487
	fn(api.ProgressResponse{Status: "writing manifest"})
488
489
490
491
492
	err = CreateManifest(name, cfg, manifestLayers)
	if err != nil {
		return err
	}

493
	fn(api.ProgressResponse{Status: "success"})
494
495
496
	return nil
}

497
498
type EmbeddingParams struct {
	model string
499
	opts  map[string]interface{}
500
501
502
503
504
505
506
507
	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 {
508
509
510
511
512
		// check if the model is a file path or a model name
		model, err := GetModel(e.model)
		if err != nil {
			if !strings.Contains(err.Error(), "couldn't open file") {
				return nil, fmt.Errorf("unexpected error opening model to generate embeddings: %v", err)
513
			}
514
515
			// the model may be a file path, create a model from this file
			model = &Model{ModelPath: e.model}
516
517
		}

518
		if err := load(model, e.opts, defaultSessionDuration); err != nil {
519
520
521
			return nil, fmt.Errorf("load model to generate embeddings: %v", err)
		}

522
		// this will be used to check if we already have embeddings for a file
523
		modelInfo, err := os.Stat(model.ModelPath)
524
		if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
525
			return nil, fmt.Errorf("failed to get model file info: %v", err)
526
527
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
528
529
530
		addedFiles := make(map[string]bool) // keep track of files that have already been added
		for _, filePattern := range e.files {
			matchingFiles, err := filepath.Glob(filePattern)
531
			if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
532
				return nil, fmt.Errorf("could not find files with pattern %s: %w", filePattern, err)
533
534
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
535
536
			for _, filePath := range matchingFiles {
				if addedFiles[filePath] {
537
538
					continue
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
539
				addedFiles[filePath] = true
Bruce MacDonald's avatar
Bruce MacDonald committed
540
				// check if we already have embeddings for this file path
541
				layerIdentifier := fmt.Sprintf("%s:%s:%s:%d", filePath, e.model, modelInfo.ModTime().Format("2006-01-02 15:04:05"), modelInfo.Size())
Bruce MacDonald's avatar
Bruce MacDonald committed
542
543
544
545
546
547
				digest, _ := GetSHA256Digest(strings.NewReader(layerIdentifier))
				existing, err := existingFileEmbeddings(digest)
				if err != nil {
					return nil, fmt.Errorf("failed to check existing embeddings for file %s: %v", filePath, err)
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
548
549
				// TODO: check file type
				f, err := os.Open(filePath)
550
				if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
551
					return nil, fmt.Errorf("could not open embed file: %w", err)
552
				}
Bruce MacDonald's avatar
Bruce MacDonald committed
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
				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,
					})
Bruce MacDonald's avatar
Bruce MacDonald committed
576
577
578
579
580
					if len(existing[d]) > 0 {
						// already have an embedding for this line
						embeddings = append(embeddings, vector.Embedding{Data: d, Vector: existing[d]})
						continue
					}
581
					embed, err := loaded.llm.Embedding(d)
Bruce MacDonald's avatar
Bruce MacDonald committed
582
					if err != nil {
583
584
						log.Printf("failed to generate embedding for '%s' line %d: %v", filePath, i+1, err)
						continue
Bruce MacDonald's avatar
Bruce MacDonald committed
585
586
					}
					embeddings = append(embeddings, vector.Embedding{Data: d, Vector: embed})
587
588
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
589
590
591
592
593
				b, err := json.Marshal(embeddings)
				if err != nil {
					return nil, fmt.Errorf("failed to encode embeddings: %w", err)
				}
				r := bytes.NewReader(b)
594

Bruce MacDonald's avatar
Bruce MacDonald committed
595
596
597
598
				layer := &LayerReader{
					Layer: Layer{
						MediaType: "application/vnd.ollama.image.embed",
						Digest:    digest,
Bruce MacDonald's avatar
Bruce MacDonald committed
599
						Size:      r.Len(),
Bruce MacDonald's avatar
Bruce MacDonald committed
600
601
602
					},
					Reader: r,
				}
603

Bruce MacDonald's avatar
Bruce MacDonald committed
604
605
				layers = append(layers, layer)
			}
606
607
608
609
610
		}
	}
	return layers, nil
}

Bruce MacDonald's avatar
Bruce MacDonald committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
// existingFileEmbeddings checks if we already have embeddings for a file and loads them into a look-up map
func existingFileEmbeddings(digest string) (map[string][]float64, error) {
	path, err := GetBlobsPath(digest)
	if err != nil {
		return nil, fmt.Errorf("embeddings blobs path: %w", err)
	}
	existingFileEmbeddings := make(map[string][]float64)
	if _, err := os.Stat(path); err == nil {
		// already have some embeddings for this file, load embeddings previously generated
		file, err := os.Open(path)
		if err != nil {
			return nil, fmt.Errorf("failed to open existing embedding file: %s", err)
		}
		defer file.Close()

		existing := []vector.Embedding{}
		if err = json.NewDecoder(file).Decode(&existing); err != nil {
			return nil, err
		}
		for _, e := range existing {
			existingFileEmbeddings[e.Data] = e.Vector
		}
	}
	return existingFileEmbeddings, nil
}

Michael Yang's avatar
Michael Yang committed
637
func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
638
639
640
641
642
643
644
645
646
647
	j := 0
	for _, l := range layers {
		if l.MediaType != mediaType {
			layers[j] = l
			j++
		}
	}
	return layers[:j]
}

648
func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
649
650
	// Write each of the layers to disk
	for _, layer := range layers {
Patrick Devine's avatar
Patrick Devine committed
651
		fp, err := GetBlobsPath(layer.Digest)
652
653
654
		if err != nil {
			return err
		}
655
656

		_, err = os.Stat(fp)
Bruce MacDonald's avatar
Bruce MacDonald committed
657
658
		// note: embed layers are always written since their digest doesnt indicate anything about the contents
		if os.IsNotExist(err) || force || layer.MediaType == "application/vnd.ollama.image.embed" {
659
660
			fn(api.ProgressResponse{Status: fmt.Sprintf("writing layer %s", layer.Digest)})

661
662
663
664
665
666
667
			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
668
			if _, err = io.Copy(out, layer.Reader); err != nil {
669
670
				return err
			}
Michael Yang's avatar
Michael Yang committed
671

672
		} else {
673
			fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
674
675
676
677
678
679
		}
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
680
func CreateManifest(name string, cfg *LayerReader, layers []*Layer) error {
681
	mp := ParseModelPath(name)
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
	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
698
	fp, err := mp.GetManifestPath(true)
699
700
701
	if err != nil {
		return err
	}
702
	return os.WriteFile(fp, manifestJSON, 0o644)
703
704
}

Michael Yang's avatar
Michael Yang committed
705
func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
Patrick Devine's avatar
Patrick Devine committed
706
	fp, err := GetBlobsPath(layer.Digest)
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
	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
}

725
726
// formatParams converts specified parameter options to their correct types
func formatParams(params map[string][]string) (map[string]interface{}, error) {
727
728
729
	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
730

731
	// build map of json struct tags to their types
Michael Yang's avatar
Michael Yang committed
732
733
734
735
736
737
738
739
	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
		}
	}

740
	out := make(map[string]interface{})
Michael Yang's avatar
Michael Yang committed
741
	// iterate params and set values based on json struct tags
742
	for key, vals := range params {
Michael Yang's avatar
Michael Yang committed
743
744
745
746
747
		if opt, ok := jsonOpts[key]; ok {
			field := valueOpts.FieldByName(opt.Name)
			if field.IsValid() && field.CanSet() {
				switch field.Kind() {
				case reflect.Float32:
748
					floatVal, err := strconv.ParseFloat(vals[0], 32)
Michael Yang's avatar
Michael Yang committed
749
					if err != nil {
750
						return nil, fmt.Errorf("invalid float value %s", vals)
Michael Yang's avatar
Michael Yang committed
751
752
					}

753
					out[key] = floatVal
Michael Yang's avatar
Michael Yang committed
754
				case reflect.Int:
755
					intVal, err := strconv.ParseInt(vals[0], 10, 0)
Michael Yang's avatar
Michael Yang committed
756
					if err != nil {
757
						return nil, fmt.Errorf("invalid int value %s", vals)
Michael Yang's avatar
Michael Yang committed
758
759
					}

760
					out[key] = intVal
Michael Yang's avatar
Michael Yang committed
761
				case reflect.Bool:
762
					boolVal, err := strconv.ParseBool(vals[0])
Michael Yang's avatar
Michael Yang committed
763
					if err != nil {
764
						return nil, fmt.Errorf("invalid bool value %s", vals)
Michael Yang's avatar
Michael Yang committed
765
766
					}

767
					out[key] = boolVal
Michael Yang's avatar
Michael Yang committed
768
				case reflect.String:
769
					out[key] = vals[0]
770
				case reflect.Slice:
771
772
					// TODO: only string slices are supported right now
					out[key] = vals
Michael Yang's avatar
Michael Yang committed
773
774
775
776
777
778
779
				default:
					return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
				}
			}
		}
	}

780
	return out, nil
781
782
}

Michael Yang's avatar
Michael Yang committed
783
func getLayerDigests(layers []*LayerReader) ([]string, error) {
784
785
786
787
788
789
790
791
792
793
794
	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
795
796
func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
	digest, size := GetSHA256Digest(f)
797
	f.Seek(0, io.SeekStart)
798

Michael Yang's avatar
Michael Yang committed
799
	layer := &LayerReader{
800
801
802
803
804
		Layer: Layer{
			MediaType: "application/vnd.docker.image.rootfs.diff.tar",
			Digest:    digest,
			Size:      size,
		},
Michael Yang's avatar
Michael Yang committed
805
		Reader: f,
806
807
808
809
810
	}

	return layer, nil
}

Patrick Devine's avatar
Patrick Devine committed
811
func CopyModel(src, dest string) error {
812
	srcModelPath := ParseModelPath(src)
813
814
815
816
817
	srcPath, err := srcModelPath.GetManifestPath(false)
	if err != nil {
		return err
	}

818
	destModelPath := ParseModelPath(dest)
819
	destPath, err := destModelPath.GetManifestPath(true)
Patrick Devine's avatar
Patrick Devine committed
820
821
822
823
824
	if err != nil {
		return err
	}

	// copy the file
Michael Yang's avatar
Michael Yang committed
825
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
826
827
828
829
830
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
831
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
832
833
834
835
836
837
838
839
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

840
func DeleteModel(name string) error {
841
	mp := ParseModelPath(name)
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
	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:]
867
			fmp := ParseModelPath(tag)
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886

			// 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
887
888
889
	if err != nil {
		return err
	}
890
891
892
893

	// only delete the files which are still in the deleteMap
	for k, v := range deleteMap {
		if v {
894
			fp, err := GetBlobsPath(k)
895
			if err != nil {
896
897
898
899
900
				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)
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
				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
}

919
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
920
	mp := ParseModelPath(name)
921
922
	fn(api.ProgressResponse{Status: "retrieving manifest"})

923
924
925
926
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
927
	manifest, err := GetManifest(mp)
928
	if err != nil {
929
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
930
931
932
933
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
934
	layers = append(layers, manifest.Layers...)
935
936
937
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
938
		exists, err := checkBlobExistence(ctx, mp, layer.Digest, regOpts)
939
940
941
942
943
		if err != nil {
			return err
		}

		if exists {
944
945
946
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
947
948
				Total:     layer.Size,
				Completed: layer.Size,
949
			})
950
			log.Printf("Layer %s already exists", layer.Digest)
951
952
953
			continue
		}

954
		fn(api.ProgressResponse{
955
956
957
			Status: "starting upload",
			Digest: layer.Digest,
			Total:  layer.Size,
958
		})
959

Michael Yang's avatar
Michael Yang committed
960
		location, err := startUpload(ctx, mp, layer, regOpts)
961
962
963
964
965
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return err
		}

Michael Yang's avatar
Michael Yang committed
966
967
		if strings.HasPrefix(path.Base(location.Path), "sha256:") {
			layer.Digest = path.Base(location.Path)
Michael Yang's avatar
Michael Yang committed
968
969
970
971
972
973
974
975
976
977
			fn(api.ProgressResponse{
				Status:    "using existing layer",
				Digest:    layer.Digest,
				Total:     layer.Size,
				Completed: layer.Size,
			})
			continue
		}

		if err := uploadBlobChunked(ctx, mp, location, layer, regOpts, fn); err != nil {
978
979
980
			log.Printf("error uploading blob: %v", err)
			return err
		}
981
982
	}

983
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
984
985
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
986
987
988
989
990
991

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

Michael Yang's avatar
Michael Yang committed
992
993
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
994
	resp, err := makeRequestWithRetry(ctx, "PUT", requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
995
996
997
998
999
	if err != nil {
		return err
	}
	defer resp.Body.Close()

1000
	fn(api.ProgressResponse{Status: "success"})
1001
1002
1003
1004

	return nil
}

1005
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
1006
1007
1008
1009
	mp := ParseModelPath(name)

	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
1010
	}
1011

1012
	fn(api.ProgressResponse{Status: "pulling manifest"})
1013

1014
	manifest, err := pullModelManifest(ctx, mp, regOpts)
1015
	if err != nil {
1016
		return fmt.Errorf("pull model manifest: %s", err)
1017
1018
1019
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
1020
	layers = append(layers, manifest.Layers...)
1021
1022
1023
	layers = append(layers, &manifest.Config)

	for _, layer := range layers {
1024
1025
1026
1027
1028
1029
1030
1031
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
1032
1033
1034
1035
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
1036
1037
1038
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
			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
1050
1051
1052
1053
			return err
		}
	}

1054
	fn(api.ProgressResponse{Status: "writing manifest"})
1055

1056
	manifestJSON, err := json.Marshal(manifest)
1057
1058
1059
1060
	if err != nil {
		return err
	}

Patrick Devine's avatar
Patrick Devine committed
1061
	fp, err := mp.GetManifestPath(true)
1062
1063
1064
1065
	if err != nil {
		return err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1066
	err = os.WriteFile(fp, manifestJSON, 0o644)
1067
1068
1069
1070
1071
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

1072
	fn(api.ProgressResponse{Status: "success"})
1073
1074
1075
1076

	return nil
}

1077
func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
Michael Yang's avatar
Michael Yang committed
1078
	requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
1079

Michael Yang's avatar
Michael Yang committed
1080
1081
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
1082
	resp, err := makeRequest(ctx, "GET", requestURL, headers, nil, regOpts)
1083
1084
1085
1086
1087
1088
1089
1090
	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 {
1091
		if resp.StatusCode == http.StatusNotFound {
Bruce MacDonald's avatar
Bruce MacDonald committed
1092
			return nil, fmt.Errorf("model not found")
1093
		}
1094
		body, _ := io.ReadAll(resp.Body)
1095
		return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
	}

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

	return m, err
}

1106
1107
1108
1109
func createConfigLayer(config ConfigV2, layers []string) (*LayerReader, error) {
	config.RootFS = RootFS{
		Type:    "layers",
		DiffIDs: layers,
1110
1111
1112
1113
1114
1115
1116
	}

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

1117
	digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
1118

Michael Yang's avatar
Michael Yang committed
1119
	layer := &LayerReader{
1120
1121
1122
1123
1124
		Layer: Layer{
			MediaType: "application/vnd.docker.container.image.v1+json",
			Digest:    digest,
			Size:      size,
		},
1125
		Reader: bytes.NewBuffer(configJSON),
1126
1127
1128
1129
1130
	}
	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
1131
1132
1133
1134
1135
1136
1137
1138
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)
1139
1140
1141
}

// Function to check if a blob already exists in the Docker registry
1142
func checkBlobExistence(ctx context.Context, mp ModelPath, digest string, regOpts *RegistryOptions) (bool, error) {
Michael Yang's avatar
Michael Yang committed
1143
1144
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "blobs", digest)
1145

Michael Yang's avatar
Michael Yang committed
1146
	resp, err := makeRequest(ctx, "HEAD", requestURL, nil, nil, regOpts)
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
	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
1157
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
Michael Yang's avatar
Michael Yang committed
1158
1159
	var status string
	for try := 0; try < MaxRetries; try++ {
Michael Yang's avatar
Michael Yang committed
1160
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
		if err != nil {
			log.Printf("couldn't start upload: %v", err)
			return nil, err
		}

		status = resp.Status

		switch resp.StatusCode {
		case http.StatusAccepted, http.StatusCreated:
			return resp, nil
		case http.StatusUnauthorized:
			auth := resp.Header.Get("www-authenticate")
			authRedir := ParseAuthRedirectString(auth)
			token, err := getAuthToken(ctx, authRedir, regOpts)
			if err != nil {
				return nil, err
			}

			regOpts.Token = token
			if body != nil {
				if _, err := body.Seek(0, io.SeekStart); err != nil {
					return nil, err
				}
			}

			continue
		default:
			body, _ := io.ReadAll(resp.Body)
			return nil, fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
		}
	}

	return nil, fmt.Errorf("max retry exceeded: %v", status)
}

Michael Yang's avatar
Michael Yang committed
1196
1197
1198
func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
	if requestURL.Scheme != "http" && regOpts.Insecure {
		requestURL.Scheme = "http"
1199
1200
	}

Michael Yang's avatar
Michael Yang committed
1201
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1202
1203
1204
1205
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1206
1207
1208
1209
	if headers != nil {
		req.Header = headers
	}

Patrick Devine's avatar
Patrick Devine committed
1210
1211
1212
1213
	if regOpts.Token != "" {
		req.Header.Set("Authorization", "Bearer "+regOpts.Token)
	} else if regOpts.Username != "" && regOpts.Password != "" {
		req.SetBasicAuth(regOpts.Username, regOpts.Password)
1214
1215
	}

Michael Yang's avatar
Michael Yang committed
1216
	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226

	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
		},
	}
Michael Yang's avatar
Michael Yang committed
1227

1228
1229
1230
1231
1232
1233
1234
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}

	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1235

Patrick Devine's avatar
Patrick Devine committed
1236
1237
1238
1239
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
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"),
	}
}

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

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

	return nil
}