images.go 27.2 KB
Newer Older
1
2
3
4
package server

import (
	"bytes"
Michael Yang's avatar
Michael Yang committed
5
	"cmp"
6
	"context"
7
	"crypto/sha256"
8
	"encoding/base64"
Patrick Devine's avatar
Patrick Devine committed
9
	"encoding/hex"
10
11
12
13
14
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
15
	"log/slog"
16
	"net/http"
Michael Yang's avatar
Michael Yang committed
17
	"net/url"
18
19
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
20
	"runtime"
21
	"slices"
Michael Yang's avatar
Michael Yang committed
22
	"strconv"
23
24
	"strings"

25
	"github.com/ollama/ollama/api"
26
	"github.com/ollama/ollama/auth"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/ollama/ollama/envconfig"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/ollama/ollama/format"
29
	"github.com/ollama/ollama/llm"
30
	"github.com/ollama/ollama/parser"
Michael Yang's avatar
Michael Yang committed
31
	"github.com/ollama/ollama/template"
32
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
33
	"github.com/ollama/ollama/types/model"
34
	"github.com/ollama/ollama/version"
35
36
)

Michael Yang's avatar
Michael Yang committed
37
38
var errCapabilityCompletion = errors.New("completion")

Michael Yang's avatar
Michael Yang committed
39
40
41
42
type Capability string

const CapabilityCompletion = Capability("completion")

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

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

	Template *template.Template
65
66
}

Michael Yang's avatar
Michael Yang committed
67
68
69
70
// CheckCapabilities checks if the model has the specified capabilities returning an error describing
// any missing or unknown capabilities
func (m *Model) CheckCapabilities(caps ...Capability) error {
	var errs []error
Michael Yang's avatar
Michael Yang committed
71
72
73
	for _, cap := range caps {
		switch cap {
		case CapabilityCompletion:
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
			f, err := os.Open(m.ModelPath)
			if err != nil {
				slog.Error("couldn't open model file", "error", err)
				continue
			}
			defer f.Close()

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

			if _, ok := ggml.KV()[fmt.Sprintf("%s.pooling_type", ggml.KV().Architecture())]; ok {
Michael Yang's avatar
Michael Yang committed
89
				errs = append(errs, errCapabilityCompletion)
Michael Yang's avatar
Michael Yang committed
90
91
92
			}
		default:
			slog.Error("unknown capability", "capability", cap)
Michael Yang's avatar
Michael Yang committed
93
			return fmt.Errorf("unknown capability: %s", cap)
Michael Yang's avatar
Michael Yang committed
94
95
96
		}
	}

Michael Yang's avatar
Michael Yang committed
97
98
99
100
101
	if err := errors.Join(errs...); err != nil {
		return fmt.Errorf("missing capabilities: %w", errors.Join(errs...))
	}

	return nil
102
103
}

Michael Yang's avatar
Michael Yang committed
104
func (m *Model) String() string {
105
	var modelfile parser.File
Michael Yang's avatar
Michael Yang committed
106

107
	modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
108
109
110
		Name: "model",
		Args: m.ModelPath,
	})
111

Michael Yang's avatar
Michael Yang committed
112
	for _, adapter := range m.AdapterPaths {
113
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
114
115
			Name: "adapter",
			Args: adapter,
Michael Yang's avatar
Michael Yang committed
116
		})
117
118
	}

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

Michael Yang's avatar
Michael Yang committed
126
	if m.Template != nil {
127
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
128
			Name: "template",
Michael Yang's avatar
Michael Yang committed
129
			Args: m.Template.String(),
Michael Yang's avatar
Michael Yang committed
130
		})
131
132
	}

Michael Yang's avatar
Michael Yang committed
133
	if m.System != "" {
134
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
135
136
			Name: "system",
			Args: m.System,
Michael Yang's avatar
Michael Yang committed
137
		})
138
139
140
141
142
143
	}

	for k, v := range m.Options {
		switch v := v.(type) {
		case []any:
			for _, s := range v {
144
				modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
145
146
147
					Name: k,
					Args: fmt.Sprintf("%v", s),
				})
148
149
			}
		default:
150
			modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
151
152
153
				Name: k,
				Args: fmt.Sprintf("%v", v),
			})
154
155
156
157
		}
	}

	for _, license := range m.License {
158
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
159
160
161
			Name: "license",
			Args: license,
		})
162
163
164
	}

	for _, msg := range m.Messages {
165
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
166
167
168
			Name: "message",
			Args: fmt.Sprintf("%s %s", msg.Role, msg.Content),
		})
169
170
	}

Michael Yang's avatar
Michael Yang committed
171
	return modelfile.String()
172
173
}

174
175
176
type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
177
178
179
}

type ConfigV2 struct {
180
181
182
183
184
185
	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"`

186
	// required by spec
187
188
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
189
	RootFS       RootFS `json:"rootfs"`
190
191
192
193
194
195
196
}

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

Michael Yang's avatar
Michael Yang committed
197
func GetManifest(mp ModelPath) (*Manifest, string, error) {
198
	fp, err := mp.GetManifestPath()
199
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
200
		return nil, "", err
201
	}
202

203
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
204
		return nil, "", err
205
206
	}

Michael Yang's avatar
Michael Yang committed
207
	var manifest *Manifest
208

209
	bts, err := os.ReadFile(fp)
210
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
211
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
212
213
	}

Patrick Devine's avatar
Patrick Devine committed
214
215
216
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

217
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
218
		return nil, "", err
219
220
	}

Patrick Devine's avatar
Patrick Devine committed
221
	return manifest, shaStr, nil
222
223
224
}

func GetModel(name string) (*Model, error) {
225
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
226
	manifest, digest, err := GetManifest(mp)
227
228
229
230
231
	if err != nil {
		return nil, err
	}

	model := &Model{
232
233
234
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
Michael Yang's avatar
Michael Yang committed
235
		Template:  template.DefaultTemplate,
236
237
	}

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
	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
	}

253
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
254
		filename, err := GetBlobsPath(layer.Digest)
255
256
257
258
		if err != nil {
			return nil, err
		}

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

Michael Yang's avatar
Michael Yang committed
278
			model.Template, err = template.Parse(string(bts))
279
280
281
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
282
		case "application/vnd.ollama.image.system":
283
284
285
286
287
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
288
			model.System = string(bts)
289
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
290
291
292
293
294
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
295

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

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
322
func realpath(rel, from string) string {
323
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
324
	if err != nil {
325
		return from
326
327
	}

Michael Yang's avatar
Michael Yang committed
328
	home, err := os.UserHomeDir()
329
	if err != nil {
Michael Yang's avatar
Michael Yang committed
330
		return abspath
331
332
	}

333
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
334
		return home
335
336
337
338
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
339
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
340
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
341
		return filepath.Join(rel, from)
342
343
	}

Michael Yang's avatar
Michael Yang committed
344
345
346
	return abspath
}

347
func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
348
349
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
350
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
351
352
353
		RootFS: RootFS{
			Type: "layers",
		},
354
355
	}

Michael Yang's avatar
Michael Yang committed
356
357
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
358

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

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

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
390
				if err != nil {
Michael Yang's avatar
Michael Yang committed
391
					return err
392
				}
393

Michael Yang's avatar
Michael Yang committed
394
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
395
396
397
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
398
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
399

400
				baseLayers, err = parseFromFile(ctx, blob, digest, fn)
Michael Yang's avatar
Michael Yang committed
401
402
403
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
404
405
			} else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
				defer file.Close()
Michael Yang's avatar
Michael Yang committed
406

407
				baseLayers, err = parseFromFile(ctx, file, "", fn)
Michael Yang's avatar
Michael Yang committed
408
				if err != nil {
Michael Yang's avatar
Michael Yang committed
409
410
					return err
				}
Michael Yang's avatar
Michael Yang committed
411
412
413
			} else {
				return fmt.Errorf("invalid model reference: %s", c.Args)
			}
Michael Yang's avatar
Michael Yang committed
414

Michael Yang's avatar
Michael Yang committed
415
			for _, baseLayer := range baseLayers {
Michael Yang's avatar
Michael Yang committed
416
417
418
419
				if quantization != "" &&
					baseLayer.MediaType == "application/vnd.ollama.image.model" &&
					baseLayer.GGML != nil &&
					baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
420
					want, err := llm.ParseFileType(quantization)
421
					if err != nil {
Michael Yang's avatar
Michael Yang committed
422
						return err
423
					}
Michael Yang's avatar
Michael Yang committed
424

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

Michael Yang's avatar
Michael Yang committed
452
453
454
455
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

456
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
457
458
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
459
460
						}

Michael Yang's avatar
Michael Yang committed
461
462
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
463
					}
464
				}
465

Michael Yang's avatar
Michael Yang committed
466
467
468
469
				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
470
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
471
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
472
473
				}

Michael Yang's avatar
Michael Yang committed
474
				layers = append(layers, baseLayer.Layer)
475
			}
Michael Yang's avatar
Michael Yang committed
476
477
478
479
		case "license", "template", "system":
			if c.Name != "license" {
				// replace
				layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
480
481
482
483
484
485
486
487
488
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
489
				})
Michael Yang's avatar
Michael Yang committed
490
491
			}

492
493
494
495
496
497
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
498
499
500
501
502
503
504
505
506
507
			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}})
508
			if err != nil {
Michael Yang's avatar
Michael Yang committed
509
				return err
510
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
511

Michael Yang's avatar
Michael Yang committed
512
513
514
515
516
517
518
519
520
521
522
			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
523

Michael Yang's avatar
Michael Yang committed
524
525
526
527
528
529
530
531
532
533
534
535
536
	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
537
			if err != nil {
Michael Yang's avatar
Michael Yang committed
538
539
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
540
			}
Michael Yang's avatar
Michael Yang committed
541
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
542

Michael Yang's avatar
Michael Yang committed
543
544
545
546
547
			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
548

Michael Yang's avatar
Michael Yang committed
549
550
551
552
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
553
			}
554

Michael Yang's avatar
Michael Yang committed
555
			return true
556
		default:
Michael Yang's avatar
Michael Yang committed
557
			return false
558
		}
Michael Yang's avatar
Michael Yang committed
559
560
561
562
	})

	if err2 != nil {
		return err2
563
564
	}

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

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

Michael Yang's avatar
Michael Yang committed
576
		layers = append(layers, layer)
577
578
	}

Michael Yang's avatar
Michael Yang committed
579
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
580
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
581
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
582
583
584
			return err
		}

Michael Yang's avatar
Michael Yang committed
585
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
586
		if err != nil {
Michael Yang's avatar
Michael Yang committed
587
			return err
588
		}
Michael Yang's avatar
Michael Yang committed
589

Michael Yang's avatar
Michael Yang committed
590
		layers = append(layers, layer)
591
592
	}

Michael Yang's avatar
Michael Yang committed
593
594
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
595
		digests[i] = layer.Digest
596
597
	}

Michael Yang's avatar
Michael Yang committed
598
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
599

Michael Yang's avatar
Michael Yang committed
600
601
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
602
603
604
		return err
	}

Michael Yang's avatar
Michael Yang committed
605
	layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
606
	if err != nil {
607
608
609
		return err
	}

Michael Yang's avatar
Michael Yang committed
610
611
612
	for _, layer := range append(layers, layer) {
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
613
		}
Michael Yang's avatar
Michael Yang committed
614
	}
615

616
	old, _ := ParseNamedManifest(name)
617

Michael Yang's avatar
Michael Yang committed
618
	fn(api.ProgressResponse{Status: "writing manifest"})
Michael Yang's avatar
Michael Yang committed
619
	if err := WriteManifest(name, layer, layers); err != nil {
620
621
		return err
	}
622

623
624
	if !envconfig.NoPrune && old != nil {
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
625
			return err
626
627
628
		}
	}

Michael Yang's avatar
Michael Yang committed
629
630
	fn(api.ProgressResponse{Status: "success"})
	return nil
631
632
}

Michael Yang's avatar
Michael Yang committed
633
func CopyModel(src, dst model.Name) error {
634
635
636
637
638
639
640
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

641
642
643
644
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
645
	manifests, err := GetManifestPath()
646
647
648
649
	if err != nil {
		return err
	}

650
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
651
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
652
653
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
654

655
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
656
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
657
658
659
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
660
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
661

Michael Yang's avatar
Michael Yang committed
662
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
663
664
665
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
666
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
667

Michael Yang's avatar
Michael Yang committed
668
669
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
670
671
}

672
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
673
674
675
676
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
677
678
679
680

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

Michael Yang's avatar
Michael Yang committed
683
684
685
686
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
687

Michael Yang's avatar
Michael Yang committed
688
		// skip the manifest we're trying to delete
689
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
690
			return nil
691
		}
Michael Yang's avatar
Michael Yang committed
692
693
694
695

		// 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
696
			//nolint:nilerr
Michael Yang's avatar
Michael Yang committed
697
698
699
700
701
702
703
704
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
705
		return nil
Michael Yang's avatar
Michael Yang committed
706
707
708
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
709
710
		return err
	}
711
712

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
713
714
715
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
716
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
717
718
			continue
		}
719
720
721
		if err := os.Remove(fp); err != nil {
			slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
			continue
722
723
724
		}
	}

725
726
727
728
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
729
	deleteMap := make(map[string]struct{})
730
731
732
733
734
735
736
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
737
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
738
739
740
741
742
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
743
		name = strings.ReplaceAll(name, "-", ":")
744
745
746
747
748
749
750
751
752
753
754

		_, 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
755
		}
756
757

		deleteMap[name] = struct{}{}
758
759
	}

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

762
	err = deleteUnusedLayers(nil, deleteMap)
763
764
765
766
	if err != nil {
		return err
	}

767
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
768
769
770
771

	return nil
}

Michael Yang's avatar
Michael Yang committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
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
805
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
806
	mp := ParseModelPath(name)
807
808
	fn(api.ProgressResponse{Status: "retrieving manifest"})

809
810
811
812
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

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

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

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

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

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

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

847
	fn(api.ProgressResponse{Status: "success"})
848
849
850
851

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
855
	var manifest *Manifest
856
857
858
859
	var err error
	var noprune string

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

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

876
877
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
878
	}
879

880
	fn(api.ProgressResponse{Status: "pulling manifest"})
881

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

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

891
	skipVerify := make(map[string]bool)
892
	for _, layer := range layers {
893
894
895
896
897
898
899
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
900
901
			return err
		}
902
		skipVerify[layer.Digest] = cacheHit
903
		delete(deleteMap, layer.Digest)
904
	}
905
	delete(deleteMap, manifest.Config.Digest)
906

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

928
	fn(api.ProgressResponse{Status: "writing manifest"})
929

930
	manifestJSON, err := json.Marshal(manifest)
931
932
933
934
	if err != nil {
		return err
	}

935
	fp, err := mp.GetManifestPath()
936
937
938
	if err != nil {
		return err
	}
939
940
941
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
942

Bruce MacDonald's avatar
Bruce MacDonald committed
943
	err = os.WriteFile(fp, manifestJSON, 0o644)
944
	if err != nil {
945
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
946
947
948
		return err
	}

949
950
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
951
		err = deleteUnusedLayers(nil, deleteMap)
952
953
954
955
956
		if err != nil {
			return err
		}
	}

957
	fn(api.ProgressResponse{Status: "success"})
958
959
960
961

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
965
966
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
967
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
968
969
970
971
972
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
973
	var m *Manifest
974
975
976
977
978
979
980
981
	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
982
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
983
984
985
986
987
988
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
989
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
990
991
}

992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
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)
}
1022

Michael Yang's avatar
Michael Yang committed
1023
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
1024
	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
1025
	for range 2 {
Michael Yang's avatar
Michael Yang committed
1026
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1027
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1028
			if !errors.Is(err, context.Canceled) {
1029
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1030
1031
			}

Michael Yang's avatar
Michael Yang committed
1032
1033
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1034
1035
1036
1037

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

1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
	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
1074
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1075
1076
}

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

	return resp, nil
}

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

Michael Yang's avatar
Michael Yang committed
1144
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1145
1146
1147
1148
1149
1150
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
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 {
1167
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1168
1169
1170
1171
	}

	return nil
}