images.go 26.9 KB
Newer Older
1
2
3
4
package server

import (
	"bytes"
Michael Yang's avatar
Michael Yang committed
5
	"cmp"
6
	"context"
7
	"crypto/sha256"
8
	"encoding/base64"
Patrick Devine's avatar
Patrick Devine committed
9
	"encoding/hex"
10
11
12
13
14
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
15
	"log/slog"
16
	"net/http"
Michael Yang's avatar
Michael Yang committed
17
	"net/url"
18
19
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
20
	"runtime"
21
	"slices"
Michael Yang's avatar
Michael Yang committed
22
	"strconv"
23
24
	"strings"

25
	"github.com/ollama/ollama/api"
26
	"github.com/ollama/ollama/auth"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/ollama/ollama/envconfig"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/ollama/ollama/format"
29
	"github.com/ollama/ollama/llm"
30
	"github.com/ollama/ollama/parser"
Michael Yang's avatar
Michael Yang committed
31
	"github.com/ollama/ollama/templates"
32
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
33
	"github.com/ollama/ollama/types/model"
34
	"github.com/ollama/ollama/version"
35
36
)

Michael Yang's avatar
Michael Yang committed
37
38
39
40
41
42
43
type registryOptions struct {
	Insecure bool
	Username string
	Password string
	Token    string
}

44
type Model struct {
Michael Yang's avatar
Michael Yang committed
45
	Name           string `json:"name"`
46
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
47
48
	ShortName      string
	ModelPath      string
49
	ParentModel    string
Michael Yang's avatar
Michael Yang committed
50
51
52
53
54
55
56
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
	Options        map[string]interface{}
57
58
59
	Messages       []Message
}

60
61
62
63
func (m *Model) IsEmbedding() bool {
	return slices.Contains(m.Config.ModelFamilies, "bert") || slices.Contains(m.Config.ModelFamilies, "nomic-bert")
}

Michael Yang's avatar
Michael Yang committed
64
func (m *Model) String() string {
65
	var modelfile parser.File
Michael Yang's avatar
Michael Yang committed
66

67
	modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
68
69
70
		Name: "model",
		Args: m.ModelPath,
	})
71

Michael Yang's avatar
Michael Yang committed
72
	for _, adapter := range m.AdapterPaths {
73
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
74
75
			Name: "adapter",
			Args: adapter,
Michael Yang's avatar
Michael Yang committed
76
		})
77
78
	}

Michael Yang's avatar
Michael Yang committed
79
	for _, projector := range m.ProjectorPaths {
80
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
81
82
			Name: "model",
			Args: projector,
Michael Yang's avatar
Michael Yang committed
83
		})
84
85
	}

Michael Yang's avatar
Michael Yang committed
86
	if m.Template != "" {
87
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
88
89
			Name: "template",
			Args: m.Template,
Michael Yang's avatar
Michael Yang committed
90
		})
91
92
	}

Michael Yang's avatar
Michael Yang committed
93
	if m.System != "" {
94
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
95
96
			Name: "system",
			Args: m.System,
Michael Yang's avatar
Michael Yang committed
97
		})
98
99
100
101
102
103
	}

	for k, v := range m.Options {
		switch v := v.(type) {
		case []any:
			for _, s := range v {
104
				modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
105
106
107
					Name: k,
					Args: fmt.Sprintf("%v", s),
				})
108
109
			}
		default:
110
			modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
111
112
113
				Name: k,
				Args: fmt.Sprintf("%v", v),
			})
114
115
116
117
		}
	}

	for _, license := range m.License {
118
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
119
120
121
			Name: "license",
			Args: license,
		})
122
123
124
	}

	for _, msg := range m.Messages {
125
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
126
127
128
			Name: "message",
			Args: fmt.Sprintf("%s %s", msg.Role, msg.Content),
		})
129
130
	}

Michael Yang's avatar
Michael Yang committed
131
	return modelfile.String()
132
133
}

134
135
136
type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
137
138
139
140
141
}

type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
142
	Config        *Layer   `json:"config"`
143
144
145
146
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
147
148
149
150
151
152
	ModelFormat   string   `json:"model_format"`
	ModelFamily   string   `json:"model_family"`
	ModelFamilies []string `json:"model_families"`
	ModelType     string   `json:"model_type"`
	FileType      string   `json:"file_type"`

153
	// required by spec
154
155
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
156
	RootFS       RootFS `json:"rootfs"`
157
158
159
160
161
162
163
}

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

Patrick Devine's avatar
Patrick Devine committed
164
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
165
	fp, err := mp.GetManifestPath()
166
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
167
		return nil, "", err
168
	}
169

170
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
171
		return nil, "", err
172
173
174
175
	}

	var manifest *ManifestV2

176
	bts, err := os.ReadFile(fp)
177
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
178
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
179
180
	}

Patrick Devine's avatar
Patrick Devine committed
181
182
183
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

184
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
185
		return nil, "", err
186
187
	}

Patrick Devine's avatar
Patrick Devine committed
188
	return manifest, shaStr, nil
189
190
191
}

func GetModel(name string) (*Model, error) {
192
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
193
	manifest, digest, err := GetManifest(mp)
194
195
196
197
198
	if err != nil {
		return nil, err
	}

	model := &Model{
199
200
201
202
203
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
204
205
	}

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
	filename, err := GetBlobsPath(manifest.Config.Digest)
	if err != nil {
		return nil, err
	}

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

	if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
		return nil, err
	}

221
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
222
		filename, err := GetBlobsPath(layer.Digest)
223
224
225
226
		if err != nil {
			return nil, err
		}

227
228
229
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
230
			model.ParentModel = layer.From
231
		case "application/vnd.ollama.image.embed":
232
233
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
234
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
235
236
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
237
238
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
239
240
241
242
243
244
245
246
247
		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)
248
249
250
			if err != nil {
				return nil, err
			}
251
252

			model.System = string(bts)
253
254
255
256
257
258
259
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
260
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
261
262
263
264
265
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
266

267
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
268
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
269
270
				return nil, err
			}
271
272
273
274
275
276
277
278
279
280
		case "application/vnd.ollama.image.messages":
			msgs, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer msgs.Close()

			if err = json.NewDecoder(msgs).Decode(&model.Messages); err != nil {
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
281
282
283
284
285
286
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
287
288
289
290
291
292
		}
	}

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
293
func realpath(rel, from string) string {
294
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
295
	if err != nil {
296
		return from
297
298
	}

Michael Yang's avatar
Michael Yang committed
299
	home, err := os.UserHomeDir()
300
	if err != nil {
Michael Yang's avatar
Michael Yang committed
301
		return abspath
302
303
	}

304
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
305
		return home
306
307
308
309
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
310
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
311
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
312
		return filepath.Join(rel, from)
313
314
	}

Michael Yang's avatar
Michael Yang committed
315
316
317
	return abspath
}

318
func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
319
320
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
321
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
322
323
324
		RootFS: RootFS{
			Type: "layers",
		},
325
326
	}

Michael Yang's avatar
Michael Yang committed
327
328
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
329

Michael Yang's avatar
Michael Yang committed
330
	var layers []*Layer
Michael Yang's avatar
Michael Yang committed
331
	for _, c := range modelfile.Commands {
Michael Yang's avatar
Michael Yang committed
332
333
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

334
		switch c.Name {
Michael Yang's avatar
Michael Yang committed
335
		case "model", "adapter":
Michael Yang's avatar
Michael Yang committed
336
			var baseLayers []*layerWithGGML
Michael Yang's avatar
rebase  
Michael Yang committed
337
			if name := model.ParseName(c.Args); name.IsValid() {
Michael Yang's avatar
Michael Yang committed
338
				baseLayers, err = parseFromModel(ctx, name, fn)
Michael Yang's avatar
Michael Yang committed
339
340
341
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
342
			} else if strings.HasPrefix(c.Args, "@") {
343
				digest := strings.TrimPrefix(c.Args, "@")
Michael Yang's avatar
Michael Yang committed
344
345
				if ib, ok := intermediateBlobs[digest]; ok {
					p, err := GetBlobsPath(ib)
346
347
348
349
350
351
352
353
354
					if err != nil {
						return err
					}

					if _, err := os.Stat(p); errors.Is(err, os.ErrNotExist) {
						// pass
					} else if err != nil {
						return err
					} else {
Michael Yang's avatar
Michael Yang committed
355
356
						fn(api.ProgressResponse{Status: fmt.Sprintf("using cached layer %s", ib)})
						digest = ib
357
358
359
360
					}
				}

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
361
				if err != nil {
Michael Yang's avatar
Michael Yang committed
362
					return err
363
				}
364

Michael Yang's avatar
Michael Yang committed
365
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
366
367
368
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
369
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
370

371
				baseLayers, err = parseFromFile(ctx, blob, digest, fn)
Michael Yang's avatar
Michael Yang committed
372
373
374
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
375
376
			} else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
				defer file.Close()
Michael Yang's avatar
Michael Yang committed
377

378
				baseLayers, err = parseFromFile(ctx, file, "", fn)
Michael Yang's avatar
Michael Yang committed
379
				if err != nil {
Michael Yang's avatar
Michael Yang committed
380
381
					return err
				}
Michael Yang's avatar
Michael Yang committed
382
383
384
			} else {
				return fmt.Errorf("invalid model reference: %s", c.Args)
			}
Michael Yang's avatar
Michael Yang committed
385

Michael Yang's avatar
Michael Yang committed
386
			for _, baseLayer := range baseLayers {
Michael Yang's avatar
Michael Yang committed
387
388
389
390
				if quantization != "" &&
					baseLayer.MediaType == "application/vnd.ollama.image.model" &&
					baseLayer.GGML != nil &&
					baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
391
					want, err := llm.ParseFileType(quantization)
392
					if err != nil {
Michael Yang's avatar
Michael Yang committed
393
						return err
394
					}
Michael Yang's avatar
Michael Yang committed
395

Michael Yang's avatar
Michael Yang committed
396
397
					ft := baseLayer.GGML.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
Michael Yang's avatar
Michael Yang committed
398
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
					} else if want != ft {
						fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", ft, quantization)})

						blob, err := GetBlobsPath(baseLayer.Digest)
						if err != nil {
							return err
						}

						temp, err := os.CreateTemp(filepath.Dir(blob), quantization)
						if err != nil {
							return err
						}
						defer temp.Close()
						defer os.Remove(temp.Name())

						if err := llm.Quantize(blob, temp.Name(), want); err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
418
						layers, err := parseFromFile(ctx, temp, "", fn)
Michael Yang's avatar
Michael Yang committed
419
420
421
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
422
423
424
425
426
427
428

						if len(layers) != 1 {
							return errors.New("quantization failed")
						}

						baseLayer.Layer = layers[0].Layer
						baseLayer.GGML = layers[0].GGML
Michael Yang's avatar
Michael Yang committed
429
					}
430
				}
431

Michael Yang's avatar
Michael Yang committed
432
433
434
435
				if baseLayer.GGML != nil {
					config.ModelFormat = cmp.Or(config.ModelFormat, baseLayer.GGML.Name())
					config.ModelFamily = cmp.Or(config.ModelFamily, baseLayer.GGML.KV().Architecture())
					config.ModelType = cmp.Or(config.ModelType, format.HumanNumber(baseLayer.GGML.KV().ParameterCount()))
Michael Yang's avatar
Michael Yang committed
436
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
437
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
Michael Yang's avatar
Michael Yang committed
438
439

					if s := baseLayer.GGML.KV().ChatTemplate(); s != "" {
440
441
442
443
444
445
446
447
448
449
						if t, err := templates.NamedTemplate(s); err != nil {
							slog.Debug("template detection", "error", err)
						} else {
							layer, err := NewLayer(t.Reader(), "application/vnd.ollama.image.template")
							if err != nil {
								return err
							}

							layer.status = fmt.Sprintf("using autodetected template %s", t.Name)
							layers = append(layers, layer)
Michael Yang's avatar
Michael Yang committed
450
451
						}
					}
452
453
				}

Michael Yang's avatar
Michael Yang committed
454
				layers = append(layers, baseLayer.Layer)
455
			}
Michael Yang's avatar
Michael Yang committed
456
457
458
459
		case "license", "template", "system":
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
460
461
462
463
464
465
466
467
468
					if layer.MediaType != mediatype {
						return false
					}

					if err := layer.Remove(); err != nil {
						return false
					}

					return true
Michael Yang's avatar
Michael Yang committed
469
				})
Michael Yang's avatar
Michael Yang committed
470
471
			}

472
473
474
475
476
477
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
478
479
480
481
482
483
484
485
486
487
			layers = append(layers, layer)
		case "message":
			role, content, ok := strings.Cut(c.Args, ": ")
			if !ok {
				return fmt.Errorf("invalid message: %s", c.Args)
			}

			messages = append(messages, &api.Message{Role: role, Content: content})
		default:
			ps, err := api.FormatParams(map[string][]string{c.Name: {c.Args}})
488
			if err != nil {
Michael Yang's avatar
Michael Yang committed
489
				return err
490
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
491

Michael Yang's avatar
Michael Yang committed
492
493
494
495
496
497
498
499
500
501
502
			for k, v := range ps {
				if ks, ok := parameters[k].([]string); ok {
					parameters[k] = append(ks, v.([]string)...)
				} else if vs, ok := v.([]string); ok {
					parameters[k] = vs
				} else {
					parameters[k] = v
				}
			}
		}
	}
Michael Yang's avatar
Michael Yang committed
503

Michael Yang's avatar
Michael Yang committed
504
505
506
507
508
509
510
511
512
513
514
515
516
	var err2 error
	layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
		switch layer.MediaType {
		case "application/vnd.ollama.image.message":
			// if there are new messages, remove the inherited ones
			if len(messages) > 0 {
				return true
			}

			return false
		case "application/vnd.ollama.image.params":
			// merge inherited parameters with new ones
			r, err := layer.Open()
Bruce MacDonald's avatar
Bruce MacDonald committed
517
			if err != nil {
Michael Yang's avatar
Michael Yang committed
518
519
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
520
			}
Michael Yang's avatar
Michael Yang committed
521
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
522

Michael Yang's avatar
Michael Yang committed
523
524
525
526
527
			var ps map[string]any
			if err := json.NewDecoder(r).Decode(&ps); err != nil {
				err2 = err
				return false
			}
Michael Yang's avatar
Michael Yang committed
528

Michael Yang's avatar
Michael Yang committed
529
530
531
532
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
533
			}
534

Michael Yang's avatar
Michael Yang committed
535
			return true
536
		default:
Michael Yang's avatar
Michael Yang committed
537
			return false
538
		}
Michael Yang's avatar
Michael Yang committed
539
540
541
542
	})

	if err2 != nil {
		return err2
543
544
	}

545
546
	if len(messages) > 0 {
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
547
		if err := json.NewEncoder(&b).Encode(messages); err != nil {
548
549
550
551
552
553
554
555
			return err
		}

		layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
556
		layers = append(layers, layer)
557
558
	}

Michael Yang's avatar
Michael Yang committed
559
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
560
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
561
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
562
563
564
			return err
		}

Michael Yang's avatar
Michael Yang committed
565
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
566
		if err != nil {
Michael Yang's avatar
Michael Yang committed
567
			return err
568
		}
Michael Yang's avatar
Michael Yang committed
569

Michael Yang's avatar
Michael Yang committed
570
		layers = append(layers, layer)
571
572
	}

Michael Yang's avatar
Michael Yang committed
573
574
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
575
		digests[i] = layer.Digest
576
577
	}

Michael Yang's avatar
Michael Yang committed
578
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
579

Michael Yang's avatar
Michael Yang committed
580
581
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
582
583
584
		return err
	}

Michael Yang's avatar
Michael Yang committed
585
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
586
	if err != nil {
587
588
589
		return err
	}

Michael Yang's avatar
Michael Yang committed
590
591
592
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
593
		}
Michael Yang's avatar
Michael Yang committed
594
	}
595

596
	old, _ := ParseNamedManifest(name)
597

Michael Yang's avatar
Michael Yang committed
598
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
599
	if err := WriteManifest(name, layer, layers); err != nil {
600
601
		return err
	}
602

603
604
	if !envconfig.NoPrune && old != nil {
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
605
			return err
606
607
608
		}
	}

Michael Yang's avatar
Michael Yang committed
609
610
	fn(api.ProgressResponse{Status: "success"})
	return nil
611
612
}

Michael Yang's avatar
Michael Yang committed
613
func CopyModel(src, dst model.Name) error {
614
615
616
617
618
619
620
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

621
622
623
624
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
625
	manifests, err := GetManifestPath()
626
627
628
629
	if err != nil {
		return err
	}

630
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
631
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
632
633
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
634

635
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
636
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
637
638
639
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
640
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
641

Michael Yang's avatar
Michael Yang committed
642
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
643
644
645
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
646
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
647

Michael Yang's avatar
Michael Yang committed
648
649
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
650
651
}

652
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
653
654
655
656
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
657
658
659
660

	walkFunc := func(path string, info os.FileInfo, _ error) error {
		if info.IsDir() {
			return nil
661
662
		}

Michael Yang's avatar
Michael Yang committed
663
664
665
666
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
667

Michael Yang's avatar
Michael Yang committed
668
		// skip the manifest we're trying to delete
669
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
670
			return nil
671
		}
Michael Yang's avatar
Michael Yang committed
672
673
674
675

		// save (i.e. delete from the deleteMap) any files used in other manifests
		manifest, _, err := GetManifest(fmp)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
676
			//nolint:nilerr
Michael Yang's avatar
Michael Yang committed
677
678
679
680
681
682
683
684
			return nil
		}

		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
685
		return nil
Michael Yang's avatar
Michael Yang committed
686
687
688
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
689
690
		return err
	}
691
692

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
693
694
695
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
696
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
697
698
			continue
		}
699
700
701
		if err := os.Remove(fp); err != nil {
			slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
			continue
702
703
704
		}
	}

705
706
707
708
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
709
	deleteMap := make(map[string]struct{})
710
711
712
713
714
715
716
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
717
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
718
719
720
721
722
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
723
		name = strings.ReplaceAll(name, "-", ":")
724
725
726
727
728
729
730
731
732
733
734

		_, err := GetBlobsPath(name)
		if err != nil {
			if errors.Is(err, ErrInvalidDigestFormat) {
				// remove invalid blobs (e.g. partial downloads)
				if err := os.Remove(filepath.Join(p, blob.Name())); err != nil {
					slog.Error("couldn't remove blob", "blob", blob.Name(), "error", err)
				}
			}

			continue
Michael Yang's avatar
Michael Yang committed
735
		}
736
737

		deleteMap[name] = struct{}{}
738
739
	}

740
	slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
741

742
	err = deleteUnusedLayers(nil, deleteMap)
743
744
745
746
	if err != nil {
		return err
	}

747
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
748
749
750
751

	return nil
}

Michael Yang's avatar
Michael Yang committed
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
func PruneDirectory(path string) error {
	info, err := os.Lstat(path)
	if err != nil {
		return err
	}

	if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
		entries, err := os.ReadDir(path)
		if err != nil {
			return err
		}

		for _, entry := range entries {
			if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
				return err
			}
		}

		entries, err = os.ReadDir(path)
		if err != nil {
			return err
		}

		if len(entries) > 0 {
			return nil
		}

		return os.Remove(path)
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
785
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
786
	mp := ParseModelPath(name)
787
788
	fn(api.ProgressResponse{Status: "retrieving manifest"})

789
790
791
792
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
793
	manifest, _, err := GetManifest(mp)
794
	if err != nil {
795
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
796
797
798
799
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
800
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
801
	layers = append(layers, manifest.Config)
802
803

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
804
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
805
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
806
807
			return err
		}
808
809
	}

810
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
811
812
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
813
814
815
816
817
818

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

Michael Yang's avatar
Michael Yang committed
819
820
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
821
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
822
823
824
825
826
	if err != nil {
		return err
	}
	defer resp.Body.Close()

827
	fn(api.ProgressResponse{Status: "success"})
828
829
830
831

	return nil
}

Michael Yang's avatar
Michael Yang committed
832
func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
833
834
	mp := ParseModelPath(name)

835
836
837
838
839
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
840
	deleteMap := make(map[string]struct{})
841

842
	if !envconfig.NoPrune {
843
844
845
846
847
848
849
		manifest, _, err = GetManifest(mp)
		if err != nil && !errors.Is(err, os.ErrNotExist) {
			return err
		}

		if manifest != nil {
			for _, l := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
850
				deleteMap[l.Digest] = struct{}{}
851
			}
Michael Yang's avatar
Michael Yang committed
852
			deleteMap[manifest.Config.Digest] = struct{}{}
853
854
855
		}
	}

856
857
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
858
	}
859

860
	fn(api.ProgressResponse{Status: "pulling manifest"})
861

862
	manifest, err = pullModelManifest(ctx, mp, regOpts)
863
	if err != nil {
864
		return fmt.Errorf("pull model manifest: %s", err)
865
866
867
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
868
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
869
	layers = append(layers, manifest.Config)
870

871
	skipVerify := make(map[string]bool)
872
	for _, layer := range layers {
873
874
875
876
877
878
879
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
880
881
			return err
		}
882
		skipVerify[layer.Digest] = cacheHit
883
		delete(deleteMap, layer.Digest)
884
	}
885
	delete(deleteMap, manifest.Config.Digest)
886

Michael Yang's avatar
Michael Yang committed
887
888
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
889
890
891
		if skipVerify[layer.Digest] {
			continue
		}
Michael Yang's avatar
Michael Yang committed
892
		if err := verifyBlob(layer.Digest); err != nil {
893
894
895
896
897
898
899
900
			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
901
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
902
903
				}
			}
Michael Yang's avatar
Michael Yang committed
904
905
906
907
			return err
		}
	}

908
	fn(api.ProgressResponse{Status: "writing manifest"})
909

910
	manifestJSON, err := json.Marshal(manifest)
911
912
913
914
	if err != nil {
		return err
	}

915
	fp, err := mp.GetManifestPath()
916
917
918
	if err != nil {
		return err
	}
919
920
921
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
922

Bruce MacDonald's avatar
Bruce MacDonald committed
923
	err = os.WriteFile(fp, manifestJSON, 0o644)
924
	if err != nil {
925
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
926
927
928
		return err
	}

929
930
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
931
		err = deleteUnusedLayers(nil, deleteMap)
932
933
934
935
936
		if err != nil {
			return err
		}
	}

937
	fn(api.ProgressResponse{Status: "success"})
938
939
940
941

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
945
946
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
947
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
948
949
950
951
952
953
954
955
956
957
958
959
960
961
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

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

	return m, err
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
962
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
963
964
965
966
967
968
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
969
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
970
971
}

972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
var errUnauthorized = fmt.Errorf("unauthorized: access denied")

// getTokenSubject returns the subject of a JWT token, it does not validate the token
func getTokenSubject(token string) string {
	parts := strings.Split(token, ".")
	if len(parts) != 3 {
		slog.Error("jwt token does not contain 3 parts")
		return ""
	}

	payload := parts[1]
	payloadBytes, err := base64.RawURLEncoding.DecodeString(payload)
	if err != nil {
		slog.Error(fmt.Sprintf("failed to decode jwt payload: %v", err))
		return ""
	}

	var payloadMap map[string]interface{}
	if err := json.Unmarshal(payloadBytes, &payloadMap); err != nil {
		slog.Error(fmt.Sprintf("failed to unmarshal payload JSON: %v", err))
		return ""
	}

	sub, ok := payloadMap["sub"]
	if !ok {
		slog.Error("jwt does not contain 'sub' field")
		return ""
	}

	return fmt.Sprintf("%s", sub)
}
1003

Michael Yang's avatar
Michael Yang committed
1004
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
1005
	anonymous := true // access will default to anonymous if no user is found associated with the public key
Michael Yang's avatar
lint  
Michael Yang committed
1006
	for range 2 {
Michael Yang's avatar
Michael Yang committed
1007
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1008
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1009
			if !errors.Is(err, context.Canceled) {
1010
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1011
1012
			}

Michael Yang's avatar
Michael Yang committed
1013
1014
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1015
1016
1017
1018

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
1019
1020
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
1021
1022
1023
			if err != nil {
				return nil, err
			}
1024
			anonymous = getTokenSubject(token) == "anonymous"
Michael Yang's avatar
Michael Yang committed
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
			regOpts.Token = token
			if body != nil {
				_, err = body.Seek(0, io.SeekStart)
				if err != nil {
					return nil, err
				}
			}
		case resp.StatusCode == http.StatusNotFound:
			return nil, os.ErrNotExist
		case resp.StatusCode >= http.StatusBadRequest:
			responseBody, err := io.ReadAll(resp.Body)
			if err != nil {
				return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
			}
			return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
		default:
			return resp, nil
Michael Yang's avatar
Michael Yang committed
1042
1043
1044
		}
	}

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
	if anonymous {
		// no user is associated with the public key, and the request requires non-anonymous access
		pubKey, nestedErr := auth.GetPublicKey()
		if nestedErr != nil {
			slog.Error(fmt.Sprintf("couldn't get public key: %v", nestedErr))
			return nil, errUnauthorized
		}
		return nil, &errtypes.UnknownOllamaKey{Key: pubKey}
	}
	// user is associated with the public key, but is not authorized to make the request
Michael Yang's avatar
Michael Yang committed
1055
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1056
1057
}

Michael Yang's avatar
Michael Yang committed
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
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 != nil && regOpts.Insecure {
		requestURL.Scheme = "http"
	}

	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
	if err != nil {
		return nil, err
	}

	if headers != nil {
		req.Header = headers
	}

	if regOpts != nil {
		if regOpts.Token != "" {
			req.Header.Set("Authorization", "Bearer "+regOpts.Token)
		} else if regOpts.Username != "" && regOpts.Password != "" {
			req.SetBasicAuth(regOpts.Username, regOpts.Password)
		}
	}

	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))

	if s := req.Header.Get("Content-Length"); s != "" {
		contentLength, err := strconv.ParseInt(s, 10, 64)
		if err != nil {
			return nil, err
		}

		req.ContentLength = contentLength
	}

Michael Yang's avatar
Michael Yang committed
1091
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1092
1093
1094
1095
1096
1097
1098
	if err != nil {
		return nil, err
	}

	return resp, nil
}

Patrick Devine's avatar
Patrick Devine committed
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
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]
}

Michael Yang's avatar
Michael Yang committed
1122
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1123
1124
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
1125
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1126
1127
1128
1129
1130
1131
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

1132
var errDigestMismatch = errors.New("digest mismatch, file must be downloaded again")
1133

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

	return nil
}