images.go 26.7 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"
Michael Yang's avatar
Michael Yang committed
21
	"strconv"
22
23
	"strings"

Michael Yang's avatar
Michael Yang committed
24
25
	"golang.org/x/exp/slices"

26
	"github.com/ollama/ollama/api"
27
	"github.com/ollama/ollama/auth"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/ollama/ollama/format"
29
	"github.com/ollama/ollama/llm"
30
	"github.com/ollama/ollama/server/envconfig"
31
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
32
	"github.com/ollama/ollama/types/model"
Michael Yang's avatar
Michael Yang committed
33
	"github.com/ollama/ollama/types/ordered"
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
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
56
	Size           int64
Michael Yang's avatar
Michael Yang committed
57
	Options        map[string]interface{}
58
59
60
	Messages       []Message
}

61
62
63
64
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
65
66
67
68
69
70
71
func (m *Model) String() string {
	var modelfile model.File

	modelfile.Commands = append(modelfile.Commands, model.Command{
		Name: "model",
		Args: m.ModelPath,
	})
72
73

	if m.Template != "" {
Michael Yang's avatar
Michael Yang committed
74
75
76
77
		modelfile.Commands = append(modelfile.Commands, model.Command{
			Name: "template",
			Args: m.Template,
		})
78
79
80
	}

	if m.System != "" {
Michael Yang's avatar
Michael Yang committed
81
82
83
84
		modelfile.Commands = append(modelfile.Commands, model.Command{
			Name: "system",
			Args: m.System,
		})
85
86
87
	}

	for _, adapter := range m.AdapterPaths {
Michael Yang's avatar
Michael Yang committed
88
89
90
91
		modelfile.Commands = append(modelfile.Commands, model.Command{
			Name: "adapter",
			Args: adapter,
		})
92
93
94
	}

	for _, projector := range m.ProjectorPaths {
Michael Yang's avatar
Michael Yang committed
95
96
97
98
		modelfile.Commands = append(modelfile.Commands, model.Command{
			Name: "projector",
			Args: projector,
		})
99
100
101
102
103
104
	}

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

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

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

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

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

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

type ConfigV2 struct {
148
149
150
151
152
153
	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"`

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

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

Michael Yang's avatar
Michael Yang committed
165
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
166
167
168
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
169

Patrick Devine's avatar
Patrick Devine committed
170
171
172
173
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
174
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
175
	fp, err := mp.GetManifestPath()
176
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
177
		return nil, "", err
178
	}
179

180
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
181
		return nil, "", err
182
183
184
185
	}

	var manifest *ManifestV2

186
	bts, err := os.ReadFile(fp)
187
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
188
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
189
190
	}

Patrick Devine's avatar
Patrick Devine committed
191
192
193
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

194
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
195
		return nil, "", err
196
197
	}

Patrick Devine's avatar
Patrick Devine committed
198
	return manifest, shaStr, nil
199
200
201
}

func GetModel(name string) (*Model, error) {
202
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
203
	manifest, digest, err := GetManifest(mp)
204
205
206
207
208
	if err != nil {
		return nil, err
	}

	model := &Model{
209
210
211
212
213
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
Patrick Devine's avatar
Patrick Devine committed
214
		Size:      manifest.GetTotalSize(),
215
216
	}

217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
	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
	}

232
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
233
		filename, err := GetBlobsPath(layer.Digest)
234
235
236
237
		if err != nil {
			return nil, err
		}

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

			model.System = string(bts)
264
265
266
267
268
269
270
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
271
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
272
273
274
275
276
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
277

278
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
279
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
280
281
				return nil, err
			}
282
283
284
285
286
287
288
289
290
291
		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
292
293
294
295
296
297
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
298
299
300
301
302
303
		}
	}

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
304
func realpath(rel, from string) string {
305
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
306
	if err != nil {
307
		return from
308
309
	}

Michael Yang's avatar
Michael Yang committed
310
	home, err := os.UserHomeDir()
311
	if err != nil {
Michael Yang's avatar
Michael Yang committed
312
		return abspath
313
314
	}

315
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
316
		return home
317
318
319
320
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
321
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
322
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
323
		return filepath.Join(rel, from)
324
325
	}

Michael Yang's avatar
Michael Yang committed
326
327
328
	return abspath
}

Michael Yang's avatar
Michael Yang committed
329
func CreateModel(ctx context.Context, name, modelFileDir, quantization string, modelfile *model.File, fn func(resp api.ProgressResponse)) (err error) {
330
331
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
332
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
333
334
335
		RootFS: RootFS{
			Type: "layers",
		},
336
337
	}

Michael Yang's avatar
Michael Yang committed
338
339
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
340

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

345
		switch c.Name {
Michael Yang's avatar
Michael Yang committed
346
347
348
349
		case "model", "adapter":
			var layers2 *ordered.Map[*Layer, *llm.GGML]
			if name := model.ParseName(c.Args, ""); name.IsValid() {
				layers2, err = parseFromModel(ctx, name, fn)
Michael Yang's avatar
Michael Yang committed
350
351
352
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
353
354
355
			} else if strings.HasPrefix(c.Args, "@") {
				blobpath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
Michael Yang's avatar
Michael Yang committed
356
					return err
357
				}
358

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

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

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

Michael Yang's avatar
Michael Yang committed
380
381
			var err2 error
			var tempfiles []*os.File
Michael Yang's avatar
Michael Yang committed
382

Michael Yang's avatar
Michael Yang committed
383
384
385
386
			// TODO(mxyng): replace with rangefunc
			layers2.Items()(func(layer *Layer, ggml *llm.GGML) bool {
				if quantization != "" && ggml != nil && ggml.Name() == "gguf" {
					ftype, err := llm.ParseFileType(quantization)
387
					if err != nil {
Michael Yang's avatar
Michael Yang committed
388
389
						err2 = err
						return false
390
					}
Michael Yang's avatar
Michael Yang committed
391

Michael Yang's avatar
Michael Yang committed
392
393
394
395
396
					filetype := ggml.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, filetype) {
						err2 = errors.New("quantization is only supported for F16 and F32 models")
						return false
					}
Michael Yang's avatar
Michael Yang committed
397

Michael Yang's avatar
Michael Yang committed
398
					fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", filetype, quantization)})
399

Michael Yang's avatar
Michael Yang committed
400
401
402
403
404
					blob, err := GetBlobsPath(layer.Digest)
					if err != nil {
						err2 = err
						return false
					}
405

Michael Yang's avatar
Michael Yang committed
406
407
408
409
410
411
					temp, err := os.CreateTemp(filepath.Dir(blob), quantization)
					if err != nil {
						err2 = err
						return false
					}
					tempfiles = append(tempfiles, temp)
Michael Yang's avatar
Michael Yang committed
412

Michael Yang's avatar
Michael Yang committed
413
414
415
416
					if err := llm.Quantize(blob, temp.Name(), ftype); err != nil {
						err2 = err
						return false
					}
417

Michael Yang's avatar
Michael Yang committed
418
419
420
421
422
					layer, err = NewLayer(temp, layer.MediaType)
					if err != nil {
						err2 = err
						return false
					}
423
				}
424

Michael Yang's avatar
Michael Yang committed
425
426
427
428
429
430
				if ggml != nil {
					config.ModelFormat = cmp.Or(config.ModelFormat, ggml.Name())
					config.ModelFamily = cmp.Or(config.ModelFamily, ggml.KV().Architecture())
					config.ModelType = cmp.Or(config.ModelType, format.HumanNumber(ggml.KV().ParameterCount()))
					config.FileType = cmp.Or(config.FileType, ggml.KV().FileType())
					config.ModelFamilies = append(config.ModelFamilies, ggml.KV().Architecture())
431
432
				}

Michael Yang's avatar
Michael Yang committed
433
434
435
				layers = append(layers, layer)
				return true
			})
436

Michael Yang's avatar
Michael Yang committed
437
438
439
			for _, tempfile := range tempfiles {
				defer tempfile.Close()
				defer os.Remove(tempfile.Name())
440
			}
441

Michael Yang's avatar
Michael Yang committed
442
443
			if err2 != nil {
				return err2
444
			}
Michael Yang's avatar
Michael Yang committed
445
446
447
		case "license", "template", "system":
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
448
			if err != nil {
Michael Yang's avatar
Michael Yang committed
449
				return err
450
451
			}

Michael Yang's avatar
Michael Yang committed
452
453
454
455
456
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
					return layer.MediaType == mediatype
				})
Michael Yang's avatar
Michael Yang committed
457
458
			}

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

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

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

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

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

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

	if err2 != nil {
		return err2
524
525
	}

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

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

Michael Yang's avatar
Michael Yang committed
537
		layers = append(layers, layer)
538
539
	}

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

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

Michael Yang's avatar
Michael Yang committed
551
		layers = append(layers, layer)
552
553
	}

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

Michael Yang's avatar
Michael Yang committed
559
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
560

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

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

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

Michael Yang's avatar
Michael Yang committed
577
578
579
580
581
582
	unref := make(map[string]struct{})
	if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
		for _, layer := range manifest.Layers {
			if !slices.Contains(digests, layer.Digest) {
				unref[layer.Digest] = struct{}{}
			}
583
584
		}

Michael Yang's avatar
Michael Yang committed
585
586
587
		if manifest.Config.Digest != layer.Digest {
			unref[manifest.Config.Digest] = struct{}{}
		}
588
589
	}

Michael Yang's avatar
Michael Yang committed
590
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
591
	if err := WriteManifest(name, layer, layers); err != nil {
592
593
		return err
	}
594

595
	if !envconfig.NoPrune {
Michael Yang's avatar
Michael Yang committed
596
		if err := deleteUnusedLayers(nil, unref, false); err != nil {
Michael Yang's avatar
Michael Yang committed
597
			return err
598
599
600
		}
	}

Michael Yang's avatar
Michael Yang committed
601
602
	fn(api.ProgressResponse{Status: "success"})
	return nil
603
604
}

605

Michael Yang's avatar
Michael Yang committed
606
func CopyModel(src, dst model.Name) error {
607
608
609
610
611
612
613
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

614
615
616
617
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
618
	manifests, err := GetManifestPath()
619
620
621
622
	if err != nil {
		return err
	}

623
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
624
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
625
626
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
627

628
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
629
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
630
631
632
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
633
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
634

Michael Yang's avatar
Michael Yang committed
635
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
636
637
638
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
639
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
640

Michael Yang's avatar
Michael Yang committed
641
642
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
643
644
}

Michael Yang's avatar
Michael Yang committed
645
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
646
647
648
649
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
650
651
652
653

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

Michael Yang's avatar
Michael Yang committed
656
657
658
659
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
660

Michael Yang's avatar
Michael Yang committed
661
		// skip the manifest we're trying to delete
662
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
663
			return nil
664
		}
Michael Yang's avatar
Michael Yang committed
665
666
667
668

		// 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
669
			// nolint: nilerr
Michael Yang's avatar
Michael Yang committed
670
671
672
673
674
675
676
677
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
678
		return nil
Michael Yang's avatar
Michael Yang committed
679
680
681
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
682
683
		return err
	}
684
685

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

702
703
704
705
	return nil
}

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

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

	for _, blob := range blobs {
		name := blob.Name()
720
		name = strings.ReplaceAll(name, "-", ":")
Michael Yang's avatar
Michael Yang committed
721
722
723
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
724
725
	}

726
	slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
727
728
729
730
731
732

	err = deleteUnusedLayers(nil, deleteMap, false)
	if err != nil {
		return err
	}

733
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
734
735
736
737

	return nil
}

Michael Yang's avatar
Michael Yang committed
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
768
769
770
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
}

771
772
773
774
775
776
777
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
778
	deleteMap := make(map[string]struct{})
779
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
780
		deleteMap[layer.Digest] = struct{}{}
781
	}
Michael Yang's avatar
Michael Yang committed
782
	deleteMap[manifest.Config.Digest] = struct{}{}
783
784
785
786
787
788

	err = deleteUnusedLayers(&mp, deleteMap, false)
	if err != nil {
		return err
	}

789
	fp, err := mp.GetManifestPath()
790
791
792
793
794
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
795
		slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
796
797
798
799
800
801
		return err
	}

	return nil
}

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

806
807
808
809
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
810
	manifest, _, err := GetManifest(mp)
811
	if err != nil {
812
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
813
814
815
816
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
817
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
818
	layers = append(layers, manifest.Config)
819
820

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
821
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
822
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
823
824
			return err
		}
825
826
	}

827
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
828
829
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
830
831
832
833
834
835

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

Michael Yang's avatar
Michael Yang committed
836
837
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
838
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
839
840
841
842
843
	if err != nil {
		return err
	}
	defer resp.Body.Close()

844
	fn(api.ProgressResponse{Status: "success"})
845
846
847
848

	return nil
}

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

852
853
854
855
856
	var manifest *ManifestV2
	var err error
	var noprune string

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

859
	if !envconfig.NoPrune {
860
861
862
863
864
865
866
		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
867
				deleteMap[l.Digest] = struct{}{}
868
			}
Michael Yang's avatar
Michael Yang committed
869
			deleteMap[manifest.Config.Digest] = struct{}{}
870
871
872
		}
	}

873
874
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
875
	}
876

877
	fn(api.ProgressResponse{Status: "pulling manifest"})
878

879
	manifest, err = pullModelManifest(ctx, mp, regOpts)
880
	if err != nil {
881
		return fmt.Errorf("pull model manifest: %s", err)
882
883
884
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
885
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
886
	layers = append(layers, manifest.Config)
887
888

	for _, layer := range layers {
889
890
891
892
893
894
895
896
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
897
898
			return err
		}
899
		delete(deleteMap, layer.Digest)
900
	}
901
	delete(deleteMap, manifest.Config.Digest)
902

Michael Yang's avatar
Michael Yang committed
903
904
905
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
906
907
908
909
910
911
912
913
			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
914
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
915
916
				}
			}
Michael Yang's avatar
Michael Yang committed
917
918
919
920
			return err
		}
	}

921
	fn(api.ProgressResponse{Status: "writing manifest"})
922

923
	manifestJSON, err := json.Marshal(manifest)
924
925
926
927
	if err != nil {
		return err
	}

928
	fp, err := mp.GetManifestPath()
929
930
931
	if err != nil {
		return err
	}
932
933
934
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
935

Bruce MacDonald's avatar
Bruce MacDonald committed
936
	err = os.WriteFile(fp, manifestJSON, 0o644)
937
	if err != nil {
938
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
939
940
941
		return err
	}

942
943
944
945
946
947
948
949
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

950
	fn(api.ProgressResponse{Status: "success"})
951
952
953
954

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
958
959
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
960
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
961
962
963
964
965
966
967
968
969
970
971
972
973
974
	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
975
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
976
977
978
979
980
981
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
982
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
983
984
}

985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
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)
}
1016

Michael Yang's avatar
Michael Yang committed
1017
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
1018
	anonymous := true // access will default to anonymous if no user is found associated with the public key
Michael Yang's avatar
Michael Yang committed
1019
	for i := 0; i < 2; i++ {
Michael Yang's avatar
Michael Yang committed
1020
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1021
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1022
			if !errors.Is(err, context.Canceled) {
1023
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1024
1025
			}

Michael Yang's avatar
Michael Yang committed
1026
1027
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1028
1029
1030
1031

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
1032
1033
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
1034
1035
1036
			if err != nil {
				return nil, err
			}
1037
			anonymous = getTokenSubject(token) == "anonymous"
Michael Yang's avatar
Michael Yang committed
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
			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
1055
1056
1057
		}
	}

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
	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
1068
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1069
1070
}

Michael Yang's avatar
Michael Yang committed
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
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
1104
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1105
1106
1107
1108
1109
1110
1111
	if err != nil {
		return nil, err
	}

	return resp, nil
}

Patrick Devine's avatar
Patrick Devine committed
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
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
1135
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1136
1137
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
1138
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1139
1140
1141
1142
1143
1144
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
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 {
1161
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1162
1163
1164
1165
	}

	return nil
}