images.go 26.2 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"
31
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
32
	"github.com/ollama/ollama/types/model"
33
	"github.com/ollama/ollama/version"
34
35
)

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

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

59
60
61
62
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
63
func (m *Model) String() string {
64
	var modelfile parser.File
Michael Yang's avatar
Michael Yang committed
65

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

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

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

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

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

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

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

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

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

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

type ConfigV2 struct {
139
140
141
142
143
144
	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"`

145
	// required by spec
146
147
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
148
	RootFS       RootFS `json:"rootfs"`
149
150
151
152
153
154
155
}

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

Michael Yang's avatar
Michael Yang committed
156
func GetManifest(mp ModelPath) (*Manifest, string, error) {
157
	fp, err := mp.GetManifestPath()
158
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
159
		return nil, "", err
160
	}
161

162
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
163
		return nil, "", err
164
165
	}

Michael Yang's avatar
Michael Yang committed
166
	var manifest *Manifest
167

168
	bts, err := os.ReadFile(fp)
169
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
170
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
171
172
	}

Patrick Devine's avatar
Patrick Devine committed
173
174
175
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

176
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
177
		return nil, "", err
178
179
	}

Patrick Devine's avatar
Patrick Devine committed
180
	return manifest, shaStr, nil
181
182
183
}

func GetModel(name string) (*Model, error) {
184
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
185
	manifest, digest, err := GetManifest(mp)
186
187
188
189
190
	if err != nil {
		return nil, err
	}

	model := &Model{
191
192
193
194
195
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
196
197
	}

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
	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
	}

213
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
214
		filename, err := GetBlobsPath(layer.Digest)
215
216
217
218
		if err != nil {
			return nil, err
		}

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

			model.System = string(bts)
245
246
247
248
249
250
251
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
252
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
253
254
255
256
257
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
258

259
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
260
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
261
262
				return nil, err
			}
263
264
265
266
267
268
269
270
271
272
		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
273
274
275
276
277
278
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
279
280
281
282
283
284
		}
	}

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
285
func realpath(rel, from string) string {
286
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
287
	if err != nil {
288
		return from
289
290
	}

Michael Yang's avatar
Michael Yang committed
291
	home, err := os.UserHomeDir()
292
	if err != nil {
Michael Yang's avatar
Michael Yang committed
293
		return abspath
294
295
	}

296
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
297
		return home
298
299
300
301
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
302
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
303
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
304
		return filepath.Join(rel, from)
305
306
	}

Michael Yang's avatar
Michael Yang committed
307
308
309
	return abspath
}

310
func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
311
312
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
313
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
314
315
316
		RootFS: RootFS{
			Type: "layers",
		},
317
318
	}

Michael Yang's avatar
Michael Yang committed
319
320
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
321

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

326
		switch c.Name {
Michael Yang's avatar
Michael Yang committed
327
		case "model", "adapter":
328
			var baseLayers []*layerGGML
Michael Yang's avatar
rebase  
Michael Yang committed
329
			if name := model.ParseName(c.Args); name.IsValid() {
Michael Yang's avatar
Michael Yang committed
330
				baseLayers, err = parseFromModel(ctx, name, fn)
Michael Yang's avatar
Michael Yang committed
331
332
333
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
334
			} else if strings.HasPrefix(c.Args, "@") {
335
				digest := strings.TrimPrefix(c.Args, "@")
Michael Yang's avatar
Michael Yang committed
336
337
				if ib, ok := intermediateBlobs[digest]; ok {
					p, err := GetBlobsPath(ib)
338
339
340
341
342
343
344
345
346
					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
347
348
						fn(api.ProgressResponse{Status: fmt.Sprintf("using cached layer %s", ib)})
						digest = ib
349
350
351
352
					}
				}

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
353
				if err != nil {
Michael Yang's avatar
Michael Yang committed
354
					return err
355
				}
356

Michael Yang's avatar
Michael Yang committed
357
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
358
359
360
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
361
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
362

363
				baseLayers, err = parseFromFile(ctx, blob, digest, fn)
Michael Yang's avatar
Michael Yang committed
364
365
366
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
367
368
			} else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
				defer file.Close()
Michael Yang's avatar
Michael Yang committed
369

370
				baseLayers, err = parseFromFile(ctx, file, "", fn)
Michael Yang's avatar
Michael Yang committed
371
				if err != nil {
Michael Yang's avatar
Michael Yang committed
372
373
					return err
				}
Michael Yang's avatar
Michael Yang committed
374
375
376
			} else {
				return fmt.Errorf("invalid model reference: %s", c.Args)
			}
Michael Yang's avatar
Michael Yang committed
377

Michael Yang's avatar
Michael Yang committed
378
			for _, baseLayer := range baseLayers {
Michael Yang's avatar
Michael Yang committed
379
380
381
382
				if quantization != "" &&
					baseLayer.MediaType == "application/vnd.ollama.image.model" &&
					baseLayer.GGML != nil &&
					baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
383
					want, err := llm.ParseFileType(quantization)
384
					if err != nil {
Michael Yang's avatar
Michael Yang committed
385
						return err
386
					}
Michael Yang's avatar
Michael Yang committed
387

Michael Yang's avatar
Michael Yang committed
388
389
					ft := baseLayer.GGML.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
Michael Yang's avatar
Michael Yang committed
390
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
					} 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
410
						layer, err := NewLayer(temp, baseLayer.MediaType)
Michael Yang's avatar
Michael Yang committed
411
412
413
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
414

Michael Yang's avatar
Michael Yang committed
415
416
417
418
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

419
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
420
421
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
422
423
						}

Michael Yang's avatar
Michael Yang committed
424
425
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
426
					}
427
				}
428

Michael Yang's avatar
Michael Yang committed
429
430
431
432
				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
433
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
434
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
435
436
				}

Michael Yang's avatar
Michael Yang committed
437
				layers = append(layers, baseLayer.Layer)
438
			}
Michael Yang's avatar
Michael Yang committed
439
440
441
442
		case "license", "template", "system":
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
443
444
445
446
447
448
449
450
451
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
452
				})
Michael Yang's avatar
Michael Yang committed
453
454
			}

455
456
457
458
459
460
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
461
462
463
464
465
466
467
468
469
470
			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}})
471
			if err != nil {
Michael Yang's avatar
Michael Yang committed
472
				return err
473
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
474

Michael Yang's avatar
Michael Yang committed
475
476
477
478
479
480
481
482
483
484
485
			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
486

Michael Yang's avatar
Michael Yang committed
487
488
489
490
491
492
493
494
495
496
497
498
499
	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
500
			if err != nil {
Michael Yang's avatar
Michael Yang committed
501
502
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
503
			}
Michael Yang's avatar
Michael Yang committed
504
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
505

Michael Yang's avatar
Michael Yang committed
506
507
508
509
510
			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
511

Michael Yang's avatar
Michael Yang committed
512
513
514
515
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
516
			}
517

Michael Yang's avatar
Michael Yang committed
518
			return true
519
		default:
Michael Yang's avatar
Michael Yang committed
520
			return false
521
		}
Michael Yang's avatar
Michael Yang committed
522
523
524
525
	})

	if err2 != nil {
		return err2
526
527
	}

528
529
	if len(messages) > 0 {
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
530
		if err := json.NewEncoder(&b).Encode(messages); err != nil {
531
532
533
534
535
536
537
538
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
539
		layers = append(layers, layer)
540
541
	}

Michael Yang's avatar
Michael Yang committed
542
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
543
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
544
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
545
546
547
			return err
		}

Michael Yang's avatar
Michael Yang committed
548
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
549
		if err != nil {
Michael Yang's avatar
Michael Yang committed
550
			return err
551
		}
Michael Yang's avatar
Michael Yang committed
552

Michael Yang's avatar
Michael Yang committed
553
		layers = append(layers, layer)
554
555
	}

Michael Yang's avatar
Michael Yang committed
556
557
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
558
		digests[i] = layer.Digest
559
560
	}

Michael Yang's avatar
Michael Yang committed
561
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
562

Michael Yang's avatar
Michael Yang committed
563
564
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
565
566
567
		return err
	}

Michael Yang's avatar
Michael Yang committed
568
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
569
	if err != nil {
570
571
572
		return err
	}

Michael Yang's avatar
Michael Yang committed
573
574
575
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
576
		}
Michael Yang's avatar
Michael Yang committed
577
	}
578

579
	old, _ := ParseNamedManifest(name)
580

Michael Yang's avatar
Michael Yang committed
581
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
582
	if err := WriteManifest(name, layer, layers); err != nil {
583
584
		return err
	}
585

586
587
	if !envconfig.NoPrune && old != nil {
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
588
			return err
589
590
591
		}
	}

Michael Yang's avatar
Michael Yang committed
592
593
	fn(api.ProgressResponse{Status: "success"})
	return nil
594
595
}

Michael Yang's avatar
Michael Yang committed
596
func CopyModel(src, dst model.Name) error {
597
598
599
600
601
602
603
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

604
605
606
607
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
608
	manifests, err := GetManifestPath()
609
610
611
612
	if err != nil {
		return err
	}

613
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
614
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
615
616
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
617

618
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
619
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
620
621
622
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
623
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
624

Michael Yang's avatar
Michael Yang committed
625
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
626
627
628
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
629
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
630

Michael Yang's avatar
Michael Yang committed
631
632
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
633
634
}

635
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
636
637
638
639
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
640
641
642
643

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

Michael Yang's avatar
Michael Yang committed
646
647
648
649
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
650

Michael Yang's avatar
Michael Yang committed
651
		// skip the manifest we're trying to delete
652
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
653
			return nil
654
		}
Michael Yang's avatar
Michael Yang committed
655
656
657
658

		// 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
659
			//nolint:nilerr
Michael Yang's avatar
Michael Yang committed
660
661
662
663
664
665
666
667
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
668
		return nil
Michael Yang's avatar
Michael Yang committed
669
670
671
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
672
673
		return err
	}
674
675

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
676
677
678
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
679
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
680
681
			continue
		}
682
683
684
		if err := os.Remove(fp); err != nil {
			slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
			continue
685
686
687
		}
	}

688
689
690
691
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
692
	deleteMap := make(map[string]struct{})
693
694
695
696
697
698
699
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
700
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
701
702
703
704
705
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
706
		name = strings.ReplaceAll(name, "-", ":")
707
708
709
710
711
712
713
714
715
716
717

		_, 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
718
		}
719
720

		deleteMap[name] = struct{}{}
721
722
	}

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

725
	err = deleteUnusedLayers(nil, deleteMap)
726
727
728
729
	if err != nil {
		return err
	}

730
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
731
732
733
734

	return nil
}

Michael Yang's avatar
Michael Yang committed
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
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
768
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
769
	mp := ParseModelPath(name)
770
771
	fn(api.ProgressResponse{Status: "retrieving manifest"})

772
773
774
775
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
776
	manifest, _, err := GetManifest(mp)
777
	if err != nil {
778
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
779
780
781
782
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
783
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
784
	layers = append(layers, manifest.Config)
785
786

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
787
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
788
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
789
790
			return err
		}
791
792
	}

793
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
794
795
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
796
797
798
799
800
801

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

Michael Yang's avatar
Michael Yang committed
802
803
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
804
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
805
806
807
808
809
	if err != nil {
		return err
	}
	defer resp.Body.Close()

810
	fn(api.ProgressResponse{Status: "success"})
811
812
813
814

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
818
	var manifest *Manifest
819
820
821
822
	var err error
	var noprune string

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

825
	if !envconfig.NoPrune {
826
827
828
829
830
831
832
		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
833
				deleteMap[l.Digest] = struct{}{}
834
			}
Michael Yang's avatar
Michael Yang committed
835
			deleteMap[manifest.Config.Digest] = struct{}{}
836
837
838
		}
	}

839
840
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
841
	}
842

843
	fn(api.ProgressResponse{Status: "pulling manifest"})
844

845
	manifest, err = pullModelManifest(ctx, mp, regOpts)
846
	if err != nil {
847
		return fmt.Errorf("pull model manifest: %s", err)
848
849
850
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
851
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
852
	layers = append(layers, manifest.Config)
853

854
	skipVerify := make(map[string]bool)
855
	for _, layer := range layers {
856
857
858
859
860
861
862
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
863
864
			return err
		}
865
		skipVerify[layer.Digest] = cacheHit
866
		delete(deleteMap, layer.Digest)
867
	}
868
	delete(deleteMap, manifest.Config.Digest)
869

Michael Yang's avatar
Michael Yang committed
870
871
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
872
873
874
		if skipVerify[layer.Digest] {
			continue
		}
Michael Yang's avatar
Michael Yang committed
875
		if err := verifyBlob(layer.Digest); err != nil {
876
877
878
879
880
881
882
883
			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
884
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
885
886
				}
			}
Michael Yang's avatar
Michael Yang committed
887
888
889
890
			return err
		}
	}

891
	fn(api.ProgressResponse{Status: "writing manifest"})
892

893
	manifestJSON, err := json.Marshal(manifest)
894
895
896
897
	if err != nil {
		return err
	}

898
	fp, err := mp.GetManifestPath()
899
900
901
	if err != nil {
		return err
	}
902
903
904
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
905

Bruce MacDonald's avatar
Bruce MacDonald committed
906
	err = os.WriteFile(fp, manifestJSON, 0o644)
907
	if err != nil {
908
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
909
910
911
		return err
	}

912
913
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
914
		err = deleteUnusedLayers(nil, deleteMap)
915
916
917
918
919
		if err != nil {
			return err
		}
	}

920
	fn(api.ProgressResponse{Status: "success"})
921
922
923
924

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
928
929
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
930
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
931
932
933
934
935
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
936
	var m *Manifest
937
938
939
940
941
942
943
944
	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
945
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
946
947
948
949
950
951
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
952
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
953
954
}

955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
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 {
		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)
}
985

Michael Yang's avatar
Michael Yang committed
986
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
987
	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
988
	for range 2 {
Michael Yang's avatar
Michael Yang committed
989
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
990
		if err != nil {
Michael Yang's avatar
Michael Yang committed
991
			if !errors.Is(err, context.Canceled) {
992
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
993
994
			}

Michael Yang's avatar
Michael Yang committed
995
996
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
997
998
999
1000

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
1001
1002
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
1003
1004
1005
			if err != nil {
				return nil, err
			}
1006
			anonymous = getTokenSubject(token) == "anonymous"
Michael Yang's avatar
Michael Yang committed
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
			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
1024
1025
1026
		}
	}

1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
	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
1037
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1038
1039
}

Michael Yang's avatar
Michael Yang committed
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
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
1073
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1074
1075
1076
1077
1078
1079
1080
	if err != nil {
		return nil, err
	}

	return resp, nil
}

Patrick Devine's avatar
Patrick Devine committed
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
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
1104
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1105
1106
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
1107
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1108
1109
1110
1111
1112
1113
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
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 {
1130
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1131
1132
1133
1134
	}

	return nil
}