images.go 26.8 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/template"
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
type Capability string

const CapabilityCompletion = Capability("completion")

Michael Yang's avatar
Michael Yang committed
41
42
43
44
45
46
47
type registryOptions struct {
	Insecure bool
	Username string
	Password string
	Token    string
}

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

	Template *template.Template
63
64
}

Michael Yang's avatar
Michael Yang committed
65
66
67
68
func (m *Model) Has(caps ...Capability) bool {
	for _, cap := range caps {
		switch cap {
		case CapabilityCompletion:
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
			f, err := os.Open(m.ModelPath)
			if err != nil {
				slog.Error("couldn't open model file", "error", err)
				continue
			}
			defer f.Close()

			// TODO(mxyng): decode the GGML into model to avoid doing this multiple times
			ggml, _, err := llm.DecodeGGML(f, 0)
			if err != nil {
				slog.Error("couldn't decode ggml", "error", err)
				continue
			}

			if _, ok := ggml.KV()[fmt.Sprintf("%s.pooling_type", ggml.KV().Architecture())]; ok {
Michael Yang's avatar
Michael Yang committed
84
85
86
87
88
89
90
91
92
				return false
			}
		default:
			slog.Error("unknown capability", "capability", cap)
			return false
		}
	}

	return true
93
94
}

Michael Yang's avatar
Michael Yang committed
95
func (m *Model) String() string {
96
	var modelfile parser.File
Michael Yang's avatar
Michael Yang committed
97

98
	modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
99
100
101
		Name: "model",
		Args: m.ModelPath,
	})
102

Michael Yang's avatar
Michael Yang committed
103
	for _, adapter := range m.AdapterPaths {
104
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
105
106
			Name: "adapter",
			Args: adapter,
Michael Yang's avatar
Michael Yang committed
107
		})
108
109
	}

Michael Yang's avatar
Michael Yang committed
110
	for _, projector := range m.ProjectorPaths {
111
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
112
113
			Name: "model",
			Args: projector,
Michael Yang's avatar
Michael Yang committed
114
		})
115
116
	}

Michael Yang's avatar
Michael Yang committed
117
	if m.Template != nil {
118
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
119
			Name: "template",
Michael Yang's avatar
Michael Yang committed
120
			Args: m.Template.String(),
Michael Yang's avatar
Michael Yang committed
121
		})
122
123
	}

Michael Yang's avatar
Michael Yang committed
124
	if m.System != "" {
125
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
126
127
			Name: "system",
			Args: m.System,
Michael Yang's avatar
Michael Yang committed
128
		})
129
130
131
132
133
134
	}

	for k, v := range m.Options {
		switch v := v.(type) {
		case []any:
			for _, s := range v {
135
				modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
136
137
138
					Name: k,
					Args: fmt.Sprintf("%v", s),
				})
139
140
			}
		default:
141
			modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
142
143
144
				Name: k,
				Args: fmt.Sprintf("%v", v),
			})
145
146
147
148
		}
	}

	for _, license := range m.License {
149
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
150
151
152
			Name: "license",
			Args: license,
		})
153
154
155
	}

	for _, msg := range m.Messages {
156
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
157
158
159
			Name: "message",
			Args: fmt.Sprintf("%s %s", msg.Role, msg.Content),
		})
160
161
	}

Michael Yang's avatar
Michael Yang committed
162
	return modelfile.String()
163
164
}

165
166
167
type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
168
169
170
}

type ConfigV2 struct {
171
172
173
174
175
176
	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"`

177
	// required by spec
178
179
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
180
	RootFS       RootFS `json:"rootfs"`
181
182
183
184
185
186
187
}

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

Michael Yang's avatar
Michael Yang committed
188
func GetManifest(mp ModelPath) (*Manifest, string, error) {
189
	fp, err := mp.GetManifestPath()
190
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
191
		return nil, "", err
192
	}
193

194
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
195
		return nil, "", err
196
197
	}

Michael Yang's avatar
Michael Yang committed
198
	var manifest *Manifest
199

200
	bts, err := os.ReadFile(fp)
201
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
202
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
203
204
	}

Patrick Devine's avatar
Patrick Devine committed
205
206
207
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

208
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
209
		return nil, "", err
210
211
	}

Patrick Devine's avatar
Patrick Devine committed
212
	return manifest, shaStr, nil
213
214
215
}

func GetModel(name string) (*Model, error) {
216
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
217
	manifest, digest, err := GetManifest(mp)
218
219
220
221
222
	if err != nil {
		return nil, err
	}

	model := &Model{
223
224
225
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
Michael Yang's avatar
Michael Yang committed
226
		Template:  template.DefaultTemplate,
227
228
	}

229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
	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
	}

244
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
245
		filename, err := GetBlobsPath(layer.Digest)
246
247
248
249
		if err != nil {
			return nil, err
		}

250
251
252
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
253
			model.ParentModel = layer.From
254
		case "application/vnd.ollama.image.embed":
255
256
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
257
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
258
259
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
260
261
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
Michael Yang's avatar
Michael Yang committed
262
263
		case "application/vnd.ollama.image.prompt",
			"application/vnd.ollama.image.template":
264
265
266
267
268
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
269
			model.Template, err = template.Parse(string(bts))
270
271
272
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
273
		case "application/vnd.ollama.image.system":
274
275
276
277
278
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
279
			model.System = string(bts)
280
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
281
282
283
284
285
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
286

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

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
313
func realpath(rel, from string) string {
314
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
315
	if err != nil {
316
		return from
317
318
	}

Michael Yang's avatar
Michael Yang committed
319
	home, err := os.UserHomeDir()
320
	if err != nil {
Michael Yang's avatar
Michael Yang committed
321
		return abspath
322
323
	}

324
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
325
		return home
326
327
328
329
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
330
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
331
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
332
		return filepath.Join(rel, from)
333
334
	}

Michael Yang's avatar
Michael Yang committed
335
336
337
	return abspath
}

338
func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
339
340
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
341
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
342
343
344
		RootFS: RootFS{
			Type: "layers",
		},
345
346
	}

Michael Yang's avatar
Michael Yang committed
347
348
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
349

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

354
		switch c.Name {
Michael Yang's avatar
Michael Yang committed
355
		case "model", "adapter":
356
			var baseLayers []*layerGGML
Michael Yang's avatar
rebase  
Michael Yang committed
357
			if name := model.ParseName(c.Args); name.IsValid() {
Michael Yang's avatar
Michael Yang committed
358
				baseLayers, err = parseFromModel(ctx, name, fn)
Michael Yang's avatar
Michael Yang committed
359
360
361
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
362
			} else if strings.HasPrefix(c.Args, "@") {
363
				digest := strings.TrimPrefix(c.Args, "@")
Michael Yang's avatar
Michael Yang committed
364
365
				if ib, ok := intermediateBlobs[digest]; ok {
					p, err := GetBlobsPath(ib)
366
367
368
369
370
371
372
373
374
					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
375
376
						fn(api.ProgressResponse{Status: fmt.Sprintf("using cached layer %s", ib)})
						digest = ib
377
378
379
380
					}
				}

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
381
				if err != nil {
Michael Yang's avatar
Michael Yang committed
382
					return err
383
				}
384

Michael Yang's avatar
Michael Yang committed
385
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
386
387
388
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
389
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
390

391
				baseLayers, err = parseFromFile(ctx, blob, digest, fn)
Michael Yang's avatar
Michael Yang committed
392
393
394
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
395
396
			} else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
				defer file.Close()
Michael Yang's avatar
Michael Yang committed
397

398
				baseLayers, err = parseFromFile(ctx, file, "", fn)
Michael Yang's avatar
Michael Yang committed
399
				if err != nil {
Michael Yang's avatar
Michael Yang committed
400
401
					return err
				}
Michael Yang's avatar
Michael Yang committed
402
403
404
			} else {
				return fmt.Errorf("invalid model reference: %s", c.Args)
			}
Michael Yang's avatar
Michael Yang committed
405

Michael Yang's avatar
Michael Yang committed
406
			for _, baseLayer := range baseLayers {
Michael Yang's avatar
Michael Yang committed
407
408
409
410
				if quantization != "" &&
					baseLayer.MediaType == "application/vnd.ollama.image.model" &&
					baseLayer.GGML != nil &&
					baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
411
					want, err := llm.ParseFileType(quantization)
412
					if err != nil {
Michael Yang's avatar
Michael Yang committed
413
						return err
414
					}
Michael Yang's avatar
Michael Yang committed
415

Michael Yang's avatar
Michael Yang committed
416
417
					ft := baseLayer.GGML.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
Michael Yang's avatar
Michael Yang committed
418
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
					} 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
438
						layer, err := NewLayer(temp, baseLayer.MediaType)
Michael Yang's avatar
Michael Yang committed
439
440
441
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
442

Michael Yang's avatar
Michael Yang committed
443
444
445
446
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

447
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
448
449
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
450
451
						}

Michael Yang's avatar
Michael Yang committed
452
453
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
454
					}
455
				}
456

Michael Yang's avatar
Michael Yang committed
457
458
459
460
				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
461
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
462
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
463
464
				}

Michael Yang's avatar
Michael Yang committed
465
				layers = append(layers, baseLayer.Layer)
466
			}
Michael Yang's avatar
Michael Yang committed
467
468
469
470
		case "license", "template", "system":
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
471
472
473
474
475
476
477
478
479
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
480
				})
Michael Yang's avatar
Michael Yang committed
481
482
			}

483
484
485
486
487
488
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
489
490
491
492
493
494
495
496
497
498
			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}})
499
			if err != nil {
Michael Yang's avatar
Michael Yang committed
500
				return err
501
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
502

Michael Yang's avatar
Michael Yang committed
503
504
505
506
507
508
509
510
511
512
513
			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
514

Michael Yang's avatar
Michael Yang committed
515
516
517
518
519
520
521
522
523
524
525
526
527
	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
528
			if err != nil {
Michael Yang's avatar
Michael Yang committed
529
530
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
531
			}
Michael Yang's avatar
Michael Yang committed
532
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
533

Michael Yang's avatar
Michael Yang committed
534
535
536
537
538
			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
539

Michael Yang's avatar
Michael Yang committed
540
541
542
543
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
544
			}
545

Michael Yang's avatar
Michael Yang committed
546
			return true
547
		default:
Michael Yang's avatar
Michael Yang committed
548
			return false
549
		}
Michael Yang's avatar
Michael Yang committed
550
551
552
553
	})

	if err2 != nil {
		return err2
554
555
	}

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

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

Michael Yang's avatar
Michael Yang committed
567
		layers = append(layers, layer)
568
569
	}

Michael Yang's avatar
Michael Yang committed
570
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
571
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
572
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
573
574
575
			return err
		}

Michael Yang's avatar
Michael Yang committed
576
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
577
		if err != nil {
Michael Yang's avatar
Michael Yang committed
578
			return err
579
		}
Michael Yang's avatar
Michael Yang committed
580

Michael Yang's avatar
Michael Yang committed
581
		layers = append(layers, layer)
582
583
	}

Michael Yang's avatar
Michael Yang committed
584
585
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
586
		digests[i] = layer.Digest
587
588
	}

Michael Yang's avatar
Michael Yang committed
589
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
590

Michael Yang's avatar
Michael Yang committed
591
592
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
593
594
595
		return err
	}

Michael Yang's avatar
Michael Yang committed
596
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
597
	if err != nil {
598
599
600
		return err
	}

Michael Yang's avatar
Michael Yang committed
601
602
603
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
604
		}
Michael Yang's avatar
Michael Yang committed
605
	}
606

607
	old, _ := ParseNamedManifest(name)
608

Michael Yang's avatar
Michael Yang committed
609
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
610
	if err := WriteManifest(name, layer, layers); err != nil {
611
612
		return err
	}
613

614
615
	if !envconfig.NoPrune && old != nil {
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
616
			return err
617
618
619
		}
	}

Michael Yang's avatar
Michael Yang committed
620
621
	fn(api.ProgressResponse{Status: "success"})
	return nil
622
623
}

Michael Yang's avatar
Michael Yang committed
624
func CopyModel(src, dst model.Name) error {
625
626
627
628
629
630
631
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

632
633
634
635
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
636
	manifests, err := GetManifestPath()
637
638
639
640
	if err != nil {
		return err
	}

641
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
642
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
643
644
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
645

646
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
647
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
648
649
650
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
651
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
652

Michael Yang's avatar
Michael Yang committed
653
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
654
655
656
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
657
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
658

Michael Yang's avatar
Michael Yang committed
659
660
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
661
662
}

663
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
664
665
666
667
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
668
669
670
671

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

Michael Yang's avatar
Michael Yang committed
674
675
676
677
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
678

Michael Yang's avatar
Michael Yang committed
679
		// skip the manifest we're trying to delete
680
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
681
			return nil
682
		}
Michael Yang's avatar
Michael Yang committed
683
684
685
686

		// 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
687
			//nolint:nilerr
Michael Yang's avatar
Michael Yang committed
688
689
690
691
692
693
694
695
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
696
		return nil
Michael Yang's avatar
Michael Yang committed
697
698
699
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
700
701
		return err
	}
702
703

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
704
705
706
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
707
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
708
709
			continue
		}
710
711
712
		if err := os.Remove(fp); err != nil {
			slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
			continue
713
714
715
		}
	}

716
717
718
719
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
720
	deleteMap := make(map[string]struct{})
721
722
723
724
725
726
727
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
728
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
729
730
731
732
733
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
734
		name = strings.ReplaceAll(name, "-", ":")
735
736
737
738
739
740
741
742
743
744
745

		_, 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
746
		}
747
748

		deleteMap[name] = struct{}{}
749
750
	}

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

753
	err = deleteUnusedLayers(nil, deleteMap)
754
755
756
757
	if err != nil {
		return err
	}

758
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
759
760
761
762

	return nil
}

Michael Yang's avatar
Michael Yang committed
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
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
796
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
797
	mp := ParseModelPath(name)
798
799
	fn(api.ProgressResponse{Status: "retrieving manifest"})

800
801
802
803
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
804
	manifest, _, err := GetManifest(mp)
805
	if err != nil {
806
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
807
808
809
810
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
811
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
812
	layers = append(layers, manifest.Config)
813
814

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
815
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
816
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
817
818
			return err
		}
819
820
	}

821
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
822
823
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
824
825
826
827
828
829

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

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

838
	fn(api.ProgressResponse{Status: "success"})
839
840
841
842

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
846
	var manifest *Manifest
847
848
849
850
	var err error
	var noprune string

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

853
	if !envconfig.NoPrune {
854
855
856
857
858
859
860
		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
861
				deleteMap[l.Digest] = struct{}{}
862
			}
Michael Yang's avatar
Michael Yang committed
863
			deleteMap[manifest.Config.Digest] = struct{}{}
864
865
866
		}
	}

867
868
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
869
	}
870

871
	fn(api.ProgressResponse{Status: "pulling manifest"})
872

873
	manifest, err = pullModelManifest(ctx, mp, regOpts)
874
	if err != nil {
875
		return fmt.Errorf("pull model manifest: %s", err)
876
877
878
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
879
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
880
	layers = append(layers, manifest.Config)
881

882
	skipVerify := make(map[string]bool)
883
	for _, layer := range layers {
884
885
886
887
888
889
890
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
891
892
			return err
		}
893
		skipVerify[layer.Digest] = cacheHit
894
		delete(deleteMap, layer.Digest)
895
	}
896
	delete(deleteMap, manifest.Config.Digest)
897

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

919
	fn(api.ProgressResponse{Status: "writing manifest"})
920

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

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

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

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

948
	fn(api.ProgressResponse{Status: "success"})
949
950
951
952

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
956
957
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
958
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
959
960
961
962
963
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
964
	var m *Manifest
965
966
967
968
969
970
971
972
	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
973
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
974
975
976
977
978
979
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

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

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
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)
}
1013

Michael Yang's avatar
Michael Yang committed
1014
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
1015
	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
1016
	for range 2 {
Michael Yang's avatar
Michael Yang committed
1017
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1018
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1019
			if !errors.Is(err, context.Canceled) {
1020
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1021
1022
			}

Michael Yang's avatar
Michael Yang committed
1023
1024
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1025
1026
1027
1028

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

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

Michael Yang's avatar
Michael Yang committed
1068
1069
1070
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
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
1101
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1102
1103
1104
1105
1106
1107
1108
	if err != nil {
		return nil, err
	}

	return resp, nil
}

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

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

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

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

	return nil
}