images.go 26.4 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
139
140
}

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

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

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

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

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

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

	var manifest *ManifestV2

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

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

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

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

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

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

205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
	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
	}

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

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

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

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

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

	return model, nil
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
422
423
424
425
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

426
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
427
428
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
429
430
						}

Michael Yang's avatar
Michael Yang committed
431
432
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
433
					}
434
				}
435

Michael Yang's avatar
Michael Yang committed
436
437
438
439
				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
440
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
441
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
442
443
				}

Michael Yang's avatar
Michael Yang committed
444
				layers = append(layers, baseLayer.Layer)
445
			}
Michael Yang's avatar
Michael Yang committed
446
447
448
449
		case "license", "template", "system":
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
450
451
452
453
454
455
456
457
458
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
459
				})
Michael Yang's avatar
Michael Yang committed
460
461
			}

462
463
464
465
466
467
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
468
469
470
471
472
473
474
475
476
477
			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}})
478
			if err != nil {
Michael Yang's avatar
Michael Yang committed
479
				return err
480
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
481

Michael Yang's avatar
Michael Yang committed
482
483
484
485
486
487
488
489
490
491
492
			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
493

Michael Yang's avatar
Michael Yang committed
494
495
496
497
498
499
500
501
502
503
504
505
506
	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
507
			if err != nil {
Michael Yang's avatar
Michael Yang committed
508
509
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
510
			}
Michael Yang's avatar
Michael Yang committed
511
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
512

Michael Yang's avatar
Michael Yang committed
513
514
515
516
517
			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
518

Michael Yang's avatar
Michael Yang committed
519
520
521
522
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
523
			}
524

Michael Yang's avatar
Michael Yang committed
525
			return true
526
		default:
Michael Yang's avatar
Michael Yang committed
527
			return false
528
		}
Michael Yang's avatar
Michael Yang committed
529
530
531
532
	})

	if err2 != nil {
		return err2
533
534
	}

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

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

Michael Yang's avatar
Michael Yang committed
546
		layers = append(layers, layer)
547
548
	}

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

Michael Yang's avatar
Michael Yang committed
555
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
556
		if err != nil {
Michael Yang's avatar
Michael Yang committed
557
			return err
558
		}
Michael Yang's avatar
Michael Yang committed
559

Michael Yang's avatar
Michael Yang committed
560
		layers = append(layers, layer)
561
562
	}

Michael Yang's avatar
Michael Yang committed
563
564
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
565
		digests[i] = layer.Digest
566
567
	}

Michael Yang's avatar
Michael Yang committed
568
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
569

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

Michael Yang's avatar
Michael Yang committed
575
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
576
	if err != nil {
577
578
579
		return err
	}

Michael Yang's avatar
Michael Yang committed
580
581
582
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
583
		}
Michael Yang's avatar
Michael Yang committed
584
	}
585

586
	old, _ := ParseNamedManifest(name)
587

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

593
594
	if !envconfig.NoPrune && old != nil {
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
595
			return err
596
597
598
		}
	}

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

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

611
612
613
614
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
615
	manifests, err := GetManifestPath()
616
617
618
619
	if err != nil {
		return err
	}

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

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

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

Michael Yang's avatar
Michael Yang committed
638
639
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
640
641
}

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

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

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

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

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

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

		delete(deleteMap, manifest.Config.Digest)
675
		return nil
Michael Yang's avatar
Michael Yang committed
676
677
678
	}

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

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

695
696
697
698
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
699
	deleteMap := make(map[string]struct{})
700
701
702
703
704
705
706
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
707
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
708
709
710
711
712
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
713
		name = strings.ReplaceAll(name, "-", ":")
714
715
716
717
718
719
720
721
722
723
724

		_, 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
725
		}
726
727

		deleteMap[name] = struct{}{}
728
729
	}

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

732
	err = deleteUnusedLayers(nil, deleteMap)
733
734
735
736
	if err != nil {
		return err
	}

737
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
738
739
740
741

	return nil
}

Michael Yang's avatar
Michael Yang committed
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
771
772
773
774
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
775
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
776
	mp := ParseModelPath(name)
777
778
	fn(api.ProgressResponse{Status: "retrieving manifest"})

779
780
781
782
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
783
	manifest, _, err := GetManifest(mp)
784
	if err != nil {
785
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
786
787
788
789
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
790
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
791
	layers = append(layers, manifest.Config)
792
793

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
794
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
795
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
796
797
			return err
		}
798
799
	}

800
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
801
802
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
803
804
805
806
807
808

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

Michael Yang's avatar
Michael Yang committed
809
810
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
811
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
812
813
814
815
816
	if err != nil {
		return err
	}
	defer resp.Body.Close()

817
	fn(api.ProgressResponse{Status: "success"})
818
819
820
821

	return nil
}

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

825
826
827
828
829
	var manifest *ManifestV2
	var err error
	var noprune string

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

832
	if !envconfig.NoPrune {
833
834
835
836
837
838
839
		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
840
				deleteMap[l.Digest] = struct{}{}
841
			}
Michael Yang's avatar
Michael Yang committed
842
			deleteMap[manifest.Config.Digest] = struct{}{}
843
844
845
		}
	}

846
847
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
848
	}
849

850
	fn(api.ProgressResponse{Status: "pulling manifest"})
851

852
	manifest, err = pullModelManifest(ctx, mp, regOpts)
853
	if err != nil {
854
		return fmt.Errorf("pull model manifest: %s", err)
855
856
857
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
858
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
859
	layers = append(layers, manifest.Config)
860

861
	skipVerify := make(map[string]bool)
862
	for _, layer := range layers {
863
864
865
866
867
868
869
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
870
871
			return err
		}
872
		skipVerify[layer.Digest] = cacheHit
873
		delete(deleteMap, layer.Digest)
874
	}
875
	delete(deleteMap, manifest.Config.Digest)
876

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

898
	fn(api.ProgressResponse{Status: "writing manifest"})
899

900
	manifestJSON, err := json.Marshal(manifest)
901
902
903
904
	if err != nil {
		return err
	}

905
	fp, err := mp.GetManifestPath()
906
907
908
	if err != nil {
		return err
	}
909
910
911
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
912

Bruce MacDonald's avatar
Bruce MacDonald committed
913
	err = os.WriteFile(fp, manifestJSON, 0o644)
914
	if err != nil {
915
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
916
917
918
		return err
	}

919
920
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
921
		err = deleteUnusedLayers(nil, deleteMap)
922
923
924
925
926
		if err != nil {
			return err
		}
	}

927
	fn(api.ProgressResponse{Status: "success"})
928
929
930
931

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
935
936
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
937
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
938
939
940
941
942
943
944
945
946
947
948
949
950
951
	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
952
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
953
954
955
956
957
958
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
959
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
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
985
986
987
988
989
990
991
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)
}
992

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

Michael Yang's avatar
Michael Yang committed
1002
1003
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1004
1005
1006
1007

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

1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
	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
1044
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1045
1046
}

Michael Yang's avatar
Michael Yang committed
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
1073
1074
1075
1076
1077
1078
1079
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
1080
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1081
1082
1083
1084
1085
1086
1087
	if err != nil {
		return nil, err
	}

	return resp, nil
}

Patrick Devine's avatar
Patrick Devine committed
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
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
1111
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1112
1113
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
1114
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1115
1116
1117
1118
1119
1120
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
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 {
1137
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1138
1139
1140
1141
	}

	return nil
}