images.go 26.5 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"
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
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
55
	Size           int64
Michael Yang's avatar
Michael Yang committed
56
	Options        map[string]interface{}
57
58
59
	Messages       []Message
}

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

Michael Yang's avatar
Michael Yang committed
64
65
66
67
68
69
70
func (m *Model) String() string {
	var modelfile model.File

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	var manifest *ManifestV2

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

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

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

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

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

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

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

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

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

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

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

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

	return model, nil
}

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
389
					filetype := baseLayer.GGML.KV().FileType()
Michael Yang's avatar
Michael Yang committed
390
					if !slices.Contains([]string{"F16", "F32"}, filetype) {
Michael Yang's avatar
Michael Yang committed
391
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
392
					}
Michael Yang's avatar
Michael Yang committed
393

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

Michael Yang's avatar
Michael Yang committed
396
					blob, err := GetBlobsPath(baseLayer.Digest)
Michael Yang's avatar
Michael Yang committed
397
					if err != nil {
Michael Yang's avatar
Michael Yang committed
398
						return err
Michael Yang's avatar
Michael Yang committed
399
					}
400

Michael Yang's avatar
Michael Yang committed
401
402
					temp, err := os.CreateTemp(filepath.Dir(blob), quantization)
					if err != nil {
Michael Yang's avatar
Michael Yang committed
403
						return err
Michael Yang's avatar
Michael Yang committed
404
					}
Michael Yang's avatar
Michael Yang committed
405
406
					defer temp.Close()
					defer os.Remove(temp.Name())
Michael Yang's avatar
Michael Yang committed
407

Michael Yang's avatar
Michael Yang committed
408
					if err := llm.Quantize(blob, temp.Name(), ftype); err != nil {
Michael Yang's avatar
Michael Yang committed
409
						return err
Michael Yang's avatar
Michael Yang committed
410
					}
411

Michael Yang's avatar
Michael Yang committed
412
					baseLayer.Layer, err = NewLayer(temp, baseLayer.Layer.MediaType)
Michael Yang's avatar
Michael Yang committed
413
					if err != nil {
Michael Yang's avatar
Michael Yang committed
414
						return err
Michael Yang's avatar
Michael Yang committed
415
					}
416
				}
417

Michael Yang's avatar
Michael Yang committed
418
419
420
421
422
423
				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()))
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType())
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
424
425
				}

Michael Yang's avatar
Michael Yang committed
426
				layers = append(layers, baseLayer.Layer)
427
			}
Michael Yang's avatar
Michael Yang committed
428
429
430
		case "license", "template", "system":
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
431
			if err != nil {
Michael Yang's avatar
Michael Yang committed
432
				return err
433
434
			}

Michael Yang's avatar
Michael Yang committed
435
436
437
438
439
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
					return layer.MediaType == mediatype
				})
Michael Yang's avatar
Michael Yang committed
440
441
			}

Michael Yang's avatar
Michael Yang committed
442
443
444
445
446
447
448
449
450
451
			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}})
452
			if err != nil {
Michael Yang's avatar
Michael Yang committed
453
				return err
454
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
455

Michael Yang's avatar
Michael Yang committed
456
457
458
459
460
461
462
463
464
465
466
			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
467

Michael Yang's avatar
Michael Yang committed
468
469
470
471
472
473
474
475
476
477
478
479
480
	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
481
			if err != nil {
Michael Yang's avatar
Michael Yang committed
482
483
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
484
			}
Michael Yang's avatar
Michael Yang committed
485
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
486

Michael Yang's avatar
Michael Yang committed
487
488
489
490
491
			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
492

Michael Yang's avatar
Michael Yang committed
493
494
495
496
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
497
			}
498

Michael Yang's avatar
Michael Yang committed
499
			return true
500
		default:
Michael Yang's avatar
Michael Yang committed
501
			return false
502
		}
Michael Yang's avatar
Michael Yang committed
503
504
505
506
	})

	if err2 != nil {
		return err2
507
508
	}

509
510
	if len(messages) > 0 {
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
511
		if err := json.NewEncoder(&b).Encode(messages); err != nil {
512
513
514
515
516
517
518
519
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
520
		layers = append(layers, layer)
521
522
	}

Michael Yang's avatar
Michael Yang committed
523
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
524
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
525
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
526
527
528
			return err
		}

Michael Yang's avatar
Michael Yang committed
529
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
530
		if err != nil {
Michael Yang's avatar
Michael Yang committed
531
			return err
532
		}
Michael Yang's avatar
Michael Yang committed
533

Michael Yang's avatar
Michael Yang committed
534
		layers = append(layers, layer)
535
536
	}

Michael Yang's avatar
Michael Yang committed
537
538
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
539
		digests[i] = layer.Digest
540
541
	}

Michael Yang's avatar
Michael Yang committed
542
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
543

Michael Yang's avatar
Michael Yang committed
544
545
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
546
547
548
		return err
	}

Michael Yang's avatar
Michael Yang committed
549
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
550
	if err != nil {
551
552
553
		return err
	}

Michael Yang's avatar
Michael Yang committed
554
555
556
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
557
		}
Michael Yang's avatar
Michael Yang committed
558
	}
559

Michael Yang's avatar
Michael Yang committed
560
561
562
563
564
565
	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{}{}
			}
566
567
		}

Michael Yang's avatar
Michael Yang committed
568
569
570
		if manifest.Config.Digest != layer.Digest {
			unref[manifest.Config.Digest] = struct{}{}
		}
571
572
	}

Michael Yang's avatar
Michael Yang committed
573
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
574
	if err := WriteManifest(name, layer, layers); err != nil {
575
576
		return err
	}
577

578
	if !envconfig.NoPrune {
Michael Yang's avatar
Michael Yang committed
579
		if err := deleteUnusedLayers(nil, unref, false); err != nil {
Michael Yang's avatar
Michael Yang committed
580
			return err
581
582
583
		}
	}

Michael Yang's avatar
Michael Yang committed
584
585
	fn(api.ProgressResponse{Status: "success"})
	return nil
586
587
}

Michael Yang's avatar
Michael Yang committed
588
func CopyModel(src, dst model.Name) error {
589
590
591
592
593
594
595
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

596
597
598
599
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
600
	manifests, err := GetManifestPath()
601
602
603
604
	if err != nil {
		return err
	}

605
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
606
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
607
608
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
609

610
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
611
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
612
613
614
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
615
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
616

Michael Yang's avatar
Michael Yang committed
617
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
618
619
620
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
621
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
622

Michael Yang's avatar
Michael Yang committed
623
624
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
625
626
}

Michael Yang's avatar
Michael Yang committed
627
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
628
629
630
631
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
632
633
634
635

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

Michael Yang's avatar
Michael Yang committed
638
639
640
641
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
642

Michael Yang's avatar
Michael Yang committed
643
		// skip the manifest we're trying to delete
644
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
645
			return nil
646
		}
Michael Yang's avatar
Michael Yang committed
647
648
649
650

		// 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
651
			// nolint: nilerr
Michael Yang's avatar
Michael Yang committed
652
653
654
655
656
657
658
659
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
660
		return nil
Michael Yang's avatar
Michael Yang committed
661
662
663
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
664
665
		return err
	}
666
667

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
668
669
670
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
671
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
672
673
674
675
			continue
		}
		if !dryRun {
			if err := os.Remove(fp); err != nil {
676
				slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
677
678
				continue
			}
Michael Yang's avatar
Michael Yang committed
679
		} else {
680
			slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
681
682
683
		}
	}

684
685
686
687
	return nil
}

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

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

	for _, blob := range blobs {
		name := blob.Name()
702
		name = strings.ReplaceAll(name, "-", ":")
Michael Yang's avatar
Michael Yang committed
703
704
705
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
706
707
	}

708
	slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
709
710
711
712
713
714

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

715
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
716
717
718
719

	return nil
}

Michael Yang's avatar
Michael Yang committed
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
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
}

753
754
755
756
757
758
759
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
760
	deleteMap := make(map[string]struct{})
761
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
762
		deleteMap[layer.Digest] = struct{}{}
763
	}
Michael Yang's avatar
Michael Yang committed
764
	deleteMap[manifest.Config.Digest] = struct{}{}
765
766
767
768
769
770

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

771
	fp, err := mp.GetManifestPath()
772
773
774
775
776
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
777
		slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
778
779
780
781
782
783
		return err
	}

	return nil
}

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

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

841
	if !envconfig.NoPrune {
842
843
844
845
846
847
848
		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
849
				deleteMap[l.Digest] = struct{}{}
850
			}
Michael Yang's avatar
Michael Yang committed
851
			deleteMap[manifest.Config.Digest] = struct{}{}
852
853
854
		}
	}

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

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

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

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

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

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

903
	fn(api.ProgressResponse{Status: "writing manifest"})
904

905
	manifestJSON, err := json.Marshal(manifest)
906
907
908
909
	if err != nil {
		return err
	}

910
	fp, err := mp.GetManifestPath()
911
912
913
	if err != nil {
		return err
	}
914
915
916
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
917

Bruce MacDonald's avatar
Bruce MacDonald committed
918
	err = os.WriteFile(fp, manifestJSON, 0o644)
919
	if err != nil {
920
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
921
922
923
		return err
	}

924
925
926
927
928
929
930
931
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

932
	fn(api.ProgressResponse{Status: "success"})
933
934
935
936

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
964
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
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
992
993
994
995
996
997
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)
}
998

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

Michael Yang's avatar
Michael Yang committed
1008
1009
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1010
1011
1012
1013

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

1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
	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
1050
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1051
1052
}

Michael Yang's avatar
Michael Yang committed
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
1080
1081
1082
1083
1084
1085
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
1086
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1087
1088
1089
1090
1091
1092
1093
	if err != nil {
		return nil, err
	}

	return resp, nil
}

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

Michael Yang's avatar
Michael Yang committed
1120
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1121
1122
1123
1124
1125
1126
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

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

	return nil
}