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
380
			for _, baseLayer := range baseLayers {
				if quantization != "" && baseLayer.GGML != nil && baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
381
					ftype, err := llm.ParseFileType(quantization)
382
					if err != nil {
Michael Yang's avatar
Michael Yang committed
383
						return err
384
					}
Michael Yang's avatar
Michael Yang committed
385

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
415
416
417
418
419
420
				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())
421
422
				}

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

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

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

Michael Yang's avatar
Michael Yang committed
453
454
455
456
457
458
459
460
461
462
463
			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
464

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

Michael Yang's avatar
Michael Yang committed
484
485
486
487
488
			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
489

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

Michael Yang's avatar
Michael Yang committed
496
			return true
497
		default:
Michael Yang's avatar
Michael Yang committed
498
			return false
499
		}
Michael Yang's avatar
Michael Yang committed
500
501
502
503
	})

	if err2 != nil {
		return err2
504
505
	}

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

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

Michael Yang's avatar
Michael Yang committed
517
		layers = append(layers, layer)
518
519
	}

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

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

Michael Yang's avatar
Michael Yang committed
531
		layers = append(layers, layer)
532
533
	}

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

Michael Yang's avatar
Michael Yang committed
539
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
540

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

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

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

Michael Yang's avatar
Michael Yang committed
557
558
559
560
561
562
	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{}{}
			}
563
564
		}

Michael Yang's avatar
Michael Yang committed
565
566
567
		if manifest.Config.Digest != layer.Digest {
			unref[manifest.Config.Digest] = struct{}{}
		}
568
569
	}

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

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

Michael Yang's avatar
Michael Yang committed
581
582
	fn(api.ProgressResponse{Status: "success"})
	return nil
583
584
}

585

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

594
595
596
597
	if src.Filepath() == dst.Filepath() {
		return nil
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

682
683
684
685
	return nil
}

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

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

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

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

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

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

	return nil
}

Michael Yang's avatar
Michael Yang committed
718
719
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
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
}

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

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

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

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

	return nil
}

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

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

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

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

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

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

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

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

824
	fn(api.ProgressResponse{Status: "success"})
825
826
827
828

	return nil
}

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

832
833
834
835
836
	var manifest *ManifestV2
	var err error
	var noprune string

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

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

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

857
	fn(api.ProgressResponse{Status: "pulling manifest"})
858

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

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

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

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

901
	fn(api.ProgressResponse{Status: "writing manifest"})
902

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

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

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

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

930
	fn(api.ProgressResponse{Status: "success"})
931
932
933
934

	return nil
}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
1006
1007
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1008
1009
1010
1011

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

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

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

	return resp, nil
}

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

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

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

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

	return nil
}