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

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

25
	"github.com/ollama/ollama/api"
26
	"github.com/ollama/ollama/auth"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/ollama/ollama/envconfig"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/ollama/ollama/format"
29
	"github.com/ollama/ollama/llm"
30
	"github.com/ollama/ollama/parser"
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
)

37
38
39
40
41
42
var (
	errCapabilities         = errors.New("does not support")
	errCapabilityCompletion = errors.New("completion")
	errCapabilityTools      = errors.New("tools")
	errCapabilityInsert     = errors.New("insert")
)
Michael Yang's avatar
Michael Yang committed
43

Michael Yang's avatar
Michael Yang committed
44
45
type Capability string

Michael Yang's avatar
tools  
Michael Yang committed
46
47
48
const (
	CapabilityCompletion = Capability("completion")
	CapabilityTools      = Capability("tools")
49
	CapabilityInsert     = Capability("insert")
Michael Yang's avatar
tools  
Michael Yang committed
50
)
Michael Yang's avatar
Michael Yang committed
51

Michael Yang's avatar
Michael Yang committed
52
53
54
55
56
type registryOptions struct {
	Insecure bool
	Username string
	Password string
	Token    string
57
58

	CheckRedirect func(req *http.Request, via []*http.Request) error
Michael Yang's avatar
Michael Yang committed
59
60
}

61
type Model struct {
Michael Yang's avatar
Michael Yang committed
62
	Name           string `json:"name"`
63
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
64
65
	ShortName      string
	ModelPath      string
66
	ParentModel    string
Michael Yang's avatar
Michael Yang committed
67
68
69
70
71
72
	AdapterPaths   []string
	ProjectorPaths []string
	System         string
	License        []string
	Digest         string
	Options        map[string]interface{}
Michael Yang's avatar
Michael Yang committed
73
	Messages       []api.Message
Michael Yang's avatar
Michael Yang committed
74
75

	Template *template.Template
76
77
}

Michael Yang's avatar
Michael Yang committed
78
79
80
81
// 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
82
83
84
	for _, cap := range caps {
		switch cap {
		case CapabilityCompletion:
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
			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
100
				errs = append(errs, errCapabilityCompletion)
Michael Yang's avatar
Michael Yang committed
101
			}
Michael Yang's avatar
tools  
Michael Yang committed
102
103
		case CapabilityTools:
			if !slices.Contains(m.Template.Vars(), "tools") {
104
105
106
107
108
109
				errs = append(errs, errCapabilityTools)
			}
		case CapabilityInsert:
			vars := m.Template.Vars()
			if !slices.Contains(vars, "suffix") {
				errs = append(errs, errCapabilityInsert)
Michael Yang's avatar
tools  
Michael Yang committed
110
			}
Michael Yang's avatar
Michael Yang committed
111
112
		default:
			slog.Error("unknown capability", "capability", cap)
Michael Yang's avatar
Michael Yang committed
113
			return fmt.Errorf("unknown capability: %s", cap)
Michael Yang's avatar
Michael Yang committed
114
115
116
		}
	}

Michael Yang's avatar
Michael Yang committed
117
	if err := errors.Join(errs...); err != nil {
118
		return fmt.Errorf("%w %w", errCapabilities, errors.Join(errs...))
Michael Yang's avatar
Michael Yang committed
119
120
121
	}

	return nil
122
123
}

Michael Yang's avatar
Michael Yang committed
124
func (m *Model) String() string {
125
	var modelfile parser.File
Michael Yang's avatar
Michael Yang committed
126

127
	modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
128
129
130
		Name: "model",
		Args: m.ModelPath,
	})
131

Michael Yang's avatar
Michael Yang committed
132
	for _, adapter := range m.AdapterPaths {
133
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
134
135
			Name: "adapter",
			Args: adapter,
Michael Yang's avatar
Michael Yang committed
136
		})
137
138
	}

Michael Yang's avatar
Michael Yang committed
139
	for _, projector := range m.ProjectorPaths {
140
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
141
142
			Name: "model",
			Args: projector,
Michael Yang's avatar
Michael Yang committed
143
		})
144
145
	}

Michael Yang's avatar
Michael Yang committed
146
	if m.Template != nil {
147
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
148
			Name: "template",
Michael Yang's avatar
Michael Yang committed
149
			Args: m.Template.String(),
Michael Yang's avatar
Michael Yang committed
150
		})
151
152
	}

Michael Yang's avatar
Michael Yang committed
153
	if m.System != "" {
154
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
155
156
			Name: "system",
			Args: m.System,
Michael Yang's avatar
Michael Yang committed
157
		})
158
159
160
161
162
163
	}

	for k, v := range m.Options {
		switch v := v.(type) {
		case []any:
			for _, s := range v {
164
				modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
165
166
167
					Name: k,
					Args: fmt.Sprintf("%v", s),
				})
168
169
			}
		default:
170
			modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
171
172
173
				Name: k,
				Args: fmt.Sprintf("%v", v),
			})
174
175
176
177
		}
	}

	for _, license := range m.License {
178
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
179
180
181
			Name: "license",
			Args: license,
		})
182
183
184
	}

	for _, msg := range m.Messages {
185
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
186
			Name: "message",
Michael Yang's avatar
Michael Yang committed
187
			Args: fmt.Sprintf("%s: %s", msg.Role, msg.Content),
Michael Yang's avatar
Michael Yang committed
188
		})
189
190
	}

Michael Yang's avatar
Michael Yang committed
191
	return modelfile.String()
192
193
}

194
type ConfigV2 struct {
195
196
197
198
199
200
	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"`

201
	// required by spec
202
203
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
204
	RootFS       RootFS `json:"rootfs"`
205
206
207
208
209
210
211
}

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

Michael Yang's avatar
Michael Yang committed
212
func GetManifest(mp ModelPath) (*Manifest, string, error) {
213
	fp, err := mp.GetManifestPath()
214
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
215
		return nil, "", err
216
	}
217

Michael Yang's avatar
Michael Yang committed
218
	f, err := os.Open(fp)
219
	if err != nil {
Michael Yang's avatar
Michael Yang committed
220
		return nil, "", err
221
	}
Michael Yang's avatar
Michael Yang committed
222
	defer f.Close()
223

Michael Yang's avatar
Michael Yang committed
224
	sha256sum := sha256.New()
Patrick Devine's avatar
Patrick Devine committed
225

Michael Yang's avatar
Michael Yang committed
226
227
	var manifest Manifest
	if err := json.NewDecoder(io.TeeReader(f, sha256sum)).Decode(&manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
228
		return nil, "", err
229
230
	}

Michael Yang's avatar
Michael Yang committed
231
	return &manifest, hex.EncodeToString(sha256sum.Sum(nil)), nil
232
233
234
}

func GetModel(name string) (*Model, error) {
235
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
236
	manifest, digest, err := GetManifest(mp)
237
238
239
240
241
	if err != nil {
		return nil, err
	}

	model := &Model{
242
243
244
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
Michael Yang's avatar
Michael Yang committed
245
		Template:  template.DefaultTemplate,
246
247
	}

248
249
250
251
252
	if manifest.Config.Digest != "" {
		filename, err := GetBlobsPath(manifest.Config.Digest)
		if err != nil {
			return nil, err
		}
253

254
255
256
257
258
		configFile, err := os.Open(filename)
		if err != nil {
			return nil, err
		}
		defer configFile.Close()
259

260
261
262
		if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
			return nil, err
		}
263
264
	}

265
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
266
		filename, err := GetBlobsPath(layer.Digest)
267
268
269
270
		if err != nil {
			return nil, err
		}

271
272
273
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
274
			model.ParentModel = layer.From
275
		case "application/vnd.ollama.image.embed":
276
277
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
278
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
279
280
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
281
282
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
Michael Yang's avatar
Michael Yang committed
283
284
		case "application/vnd.ollama.image.prompt",
			"application/vnd.ollama.image.template":
285
286
287
288
289
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
290
			model.Template, err = template.Parse(string(bts))
291
292
293
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
294
		case "application/vnd.ollama.image.system":
295
296
297
298
299
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
300
			model.System = string(bts)
301
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
302
303
304
305
306
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
307

308
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
309
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
310
311
				return nil, err
			}
312
313
314
315
316
317
318
319
320
321
		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
322
323
324
325
326
327
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
328
329
330
331
332
333
		}
	}

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
334
func realpath(rel, from string) string {
335
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
336
	if err != nil {
337
		return from
338
339
	}

Michael Yang's avatar
Michael Yang committed
340
	home, err := os.UserHomeDir()
341
	if err != nil {
Michael Yang's avatar
Michael Yang committed
342
		return abspath
343
344
	}

345
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
346
		return home
347
348
349
350
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

Michael Yang's avatar
Michael Yang committed
351
	if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
352
		// this is a file relative to the Modelfile
Michael Yang's avatar
Michael Yang committed
353
		return filepath.Join(rel, from)
354
355
	}

Michael Yang's avatar
Michael Yang committed
356
357
358
	return abspath
}

359
func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
360
361
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
362
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
363
364
365
		RootFS: RootFS{
			Type: "layers",
		},
366
367
	}

Michael Yang's avatar
Michael Yang committed
368
369
	var messages []*api.Message
	parameters := make(map[string]any)
Michael Yang's avatar
Michael Yang committed
370

371
	var layers []Layer
Michael Yang's avatar
Michael Yang committed
372
	for _, c := range modelfile.Commands {
Michael Yang's avatar
Michael Yang committed
373
374
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

375
		switch c.Name {
Michael Yang's avatar
Michael Yang committed
376
		case "model", "adapter":
377
			var baseLayers []*layerGGML
Michael Yang's avatar
rebase  
Michael Yang committed
378
			if name := model.ParseName(c.Args); name.IsValid() {
Michael Yang's avatar
Michael Yang committed
379
				baseLayers, err = parseFromModel(ctx, name, fn)
Michael Yang's avatar
Michael Yang committed
380
381
382
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
383
			} else if strings.HasPrefix(c.Args, "@") {
384
				digest := strings.TrimPrefix(c.Args, "@")
Michael Yang's avatar
Michael Yang committed
385
386
				if ib, ok := intermediateBlobs[digest]; ok {
					p, err := GetBlobsPath(ib)
387
388
389
390
391
392
393
394
395
					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
396
397
						fn(api.ProgressResponse{Status: fmt.Sprintf("using cached layer %s", ib)})
						digest = ib
398
399
400
401
					}
				}

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
402
				if err != nil {
Michael Yang's avatar
Michael Yang committed
403
					return err
404
				}
405

Michael Yang's avatar
Michael Yang committed
406
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
407
408
409
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
410
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
411

412
				baseLayers, err = parseFromFile(ctx, blob, digest, fn)
Michael Yang's avatar
Michael Yang committed
413
414
415
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
416
417
			} else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
				defer file.Close()
Michael Yang's avatar
Michael Yang committed
418

419
				baseLayers, err = parseFromFile(ctx, file, "", fn)
Michael Yang's avatar
Michael Yang committed
420
				if err != nil {
Michael Yang's avatar
Michael Yang committed
421
422
					return err
				}
Michael Yang's avatar
Michael Yang committed
423
424
425
			} else {
				return fmt.Errorf("invalid model reference: %s", c.Args)
			}
Michael Yang's avatar
Michael Yang committed
426

Michael Yang's avatar
Michael Yang committed
427
			for _, baseLayer := range baseLayers {
Michael Yang's avatar
Michael Yang committed
428
429
430
431
				if quantization != "" &&
					baseLayer.MediaType == "application/vnd.ollama.image.model" &&
					baseLayer.GGML != nil &&
					baseLayer.GGML.Name() == "gguf" {
Michael Yang's avatar
Michael Yang committed
432
					want, err := llm.ParseFileType(quantization)
433
					if err != nil {
Michael Yang's avatar
Michael Yang committed
434
						return err
435
					}
Michael Yang's avatar
Michael Yang committed
436

Michael Yang's avatar
Michael Yang committed
437
438
					ft := baseLayer.GGML.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
Michael Yang's avatar
Michael Yang committed
439
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
					} 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
459
						layer, err := NewLayer(temp, baseLayer.MediaType)
Michael Yang's avatar
Michael Yang committed
460
461
462
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
463

Michael Yang's avatar
Michael Yang committed
464
465
466
467
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

468
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
469
470
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
471
472
						}

Michael Yang's avatar
Michael Yang committed
473
474
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
475
					}
476
				}
477

Michael Yang's avatar
Michael Yang committed
478
479
480
481
				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
482
					config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
Michael Yang's avatar
Michael Yang committed
483
					config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
484
485
				}

Michael Yang's avatar
Michael Yang committed
486
				layers = append(layers, baseLayer.Layer)
487
			}
Michael Yang's avatar
Michael Yang committed
488
		case "license", "template", "system":
Josh's avatar
Josh committed
489
490
491
492
493
494
			if c.Name == "template" {
				if _, err := template.Parse(c.Args); err != nil {
					return fmt.Errorf("%w: %s", errBadTemplate, err)
				}
			}

Michael Yang's avatar
Michael Yang committed
495
496
			if c.Name != "license" {
				// replace
497
				layers = slices.DeleteFunc(layers, func(layer Layer) bool {
498
499
500
501
502
503
504
505
506
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
507
				})
Michael Yang's avatar
Michael Yang committed
508
509
			}

510
511
512
513
514
515
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
516
517
518
519
520
521
522
523
524
525
			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}})
526
			if err != nil {
Michael Yang's avatar
Michael Yang committed
527
				return err
528
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
529

Michael Yang's avatar
Michael Yang committed
530
531
532
533
534
535
536
537
538
539
540
			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
541

Michael Yang's avatar
Michael Yang committed
542
	var err2 error
543
	layers = slices.DeleteFunc(layers, func(layer Layer) bool {
Michael Yang's avatar
Michael Yang committed
544
545
546
547
548
549
550
551
552
553
554
		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
555
			if err != nil {
Michael Yang's avatar
Michael Yang committed
556
557
				err2 = err
				return false
Bruce MacDonald's avatar
Bruce MacDonald committed
558
			}
Michael Yang's avatar
Michael Yang committed
559
			defer r.Close()
Bruce MacDonald's avatar
Bruce MacDonald committed
560

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

Michael Yang's avatar
Michael Yang committed
567
568
569
570
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
571
			}
572

Michael Yang's avatar
Michael Yang committed
573
			return true
574
		default:
Michael Yang's avatar
Michael Yang committed
575
			return false
576
		}
Michael Yang's avatar
Michael Yang committed
577
578
579
580
	})

	if err2 != nil {
		return err2
581
582
	}

583
584
	if len(messages) > 0 {
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
585
		if err := json.NewEncoder(&b).Encode(messages); err != nil {
586
587
588
589
590
591
592
593
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
594
		layers = append(layers, layer)
595
596
	}

Michael Yang's avatar
Michael Yang committed
597
	if len(parameters) > 0 {
Michael Yang's avatar
Michael Yang committed
598
		var b bytes.Buffer
Michael Yang's avatar
Michael Yang committed
599
		if err := json.NewEncoder(&b).Encode(parameters); err != nil {
600
601
602
			return err
		}

Michael Yang's avatar
Michael Yang committed
603
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
604
		if err != nil {
Michael Yang's avatar
Michael Yang committed
605
			return err
606
		}
Michael Yang's avatar
Michael Yang committed
607

Michael Yang's avatar
Michael Yang committed
608
		layers = append(layers, layer)
609
610
	}

Michael Yang's avatar
Michael Yang committed
611
612
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
613
		digests[i] = layer.Digest
614
615
	}

Michael Yang's avatar
Michael Yang committed
616
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
617

Michael Yang's avatar
Michael Yang committed
618
619
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
620
621
622
		return err
	}

623
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
Michael Yang's avatar
Michael Yang committed
624
	if err != nil {
625
626
627
		return err
	}

628
	for _, layer := range append(layers, configLayer) {
Michael Yang's avatar
Michael Yang committed
629
630
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
631
		}
Michael Yang's avatar
Michael Yang committed
632
	}
633

634
	old, _ := ParseNamedManifest(name)
635

Michael Yang's avatar
Michael Yang committed
636
	fn(api.ProgressResponse{Status: "writing manifest"})
637
	if err := WriteManifest(name, configLayer, layers); err != nil {
638
639
		return err
	}
640

Michael Yang's avatar
bool  
Michael Yang committed
641
	if !envconfig.NoPrune() && old != nil {
642
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
643
			return err
644
645
646
		}
	}

Michael Yang's avatar
Michael Yang committed
647
648
	fn(api.ProgressResponse{Status: "success"})
	return nil
649
650
}

Michael Yang's avatar
Michael Yang committed
651
func CopyModel(src, dst model.Name) error {
652
653
654
655
656
657
658
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

659
660
661
662
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
663
	manifests, err := GetManifestPath()
664
665
666
667
	if err != nil {
		return err
	}

668
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
669
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
670
671
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
672

673
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
674
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
675
676
677
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
678
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
679

Michael Yang's avatar
Michael Yang committed
680
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
681
682
683
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
684
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
685

Michael Yang's avatar
Michael Yang committed
686
687
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
688
689
}

Michael Yang's avatar
Michael Yang committed
690
691
func deleteUnusedLayers(deleteMap map[string]struct{}) error {
	manifests, err := Manifests()
692
693
694
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
695

Michael Yang's avatar
Michael Yang committed
696
	for _, manifest := range manifests {
Michael Yang's avatar
Michael Yang committed
697
698
699
700
701
		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
702
	}
703
704

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

717
718
719
720
	return nil
}

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
754
	if err := deleteUnusedLayers(deleteMap); err != nil {
755
		slog.Error(fmt.Sprintf("couldn't remove unused layers: %v", err))
756
		return nil
757
758
	}

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

	return nil
}

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

801
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
Michael Yang's avatar
lint  
Michael Yang committed
802
		return errors.New("insecure protocol http")
803
804
	}

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

811
	var layers []Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
812
	layers = append(layers, manifest.Layers...)
813
	if manifest.Config.Digest != "" {
814
		layers = append(layers, manifest.Config)
815
	}
816
817

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

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

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

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

841
	fn(api.ProgressResponse{Status: "success"})
842
843
844
845

	return nil
}

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

849
	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
850
	deleteMap := make(map[string]struct{})
Michael Yang's avatar
Michael Yang committed
851
852
853
854
855
856
857
858
	manifest, _, err := GetManifest(mp)
	if errors.Is(err, os.ErrNotExist) {
		// noop
	} else if err != nil && !errors.Is(err, os.ErrNotExist) {
		return err
	} else {
		for _, l := range manifest.Layers {
			deleteMap[l.Digest] = struct{}{}
859
		}
Michael Yang's avatar
Michael Yang committed
860
861
		if manifest.Config.Digest != "" {
			deleteMap[manifest.Config.Digest] = struct{}{}
862
863
864
		}
	}

865
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
Michael Yang's avatar
lint  
Michael Yang committed
866
		return errors.New("insecure protocol http")
867
	}
868

869
	fn(api.ProgressResponse{Status: "pulling manifest"})
870

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

876
	var layers []Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
877
	layers = append(layers, manifest.Layers...)
878
	if manifest.Config.Digest != "" {
879
		layers = append(layers, manifest.Config)
880
	}
881

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

Michael Yang's avatar
Michael Yang committed
898
899
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
900
901
902
		if skipVerify[layer.Digest] {
			continue
		}
Michael Yang's avatar
Michael Yang committed
903
		if err := verifyBlob(layer.Digest); err != nil {
904
905
906
907
908
909
910
911
			if errors.Is(err, errDigestMismatch) {
				// something went wrong, delete the blob
				fp, err := GetBlobsPath(layer.Digest)
				if err != nil {
					return err
				}
				if err := os.Remove(fp); err != nil {
					// log this, but return the original error
912
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
913
914
				}
			}
Michael Yang's avatar
Michael Yang committed
915
916
917
918
			return err
		}
	}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
940
941
	if !envconfig.NoPrune() && len(deleteMap) > 0 {
		fn(api.ProgressResponse{Status: "removing unused layers"})
Michael Yang's avatar
Michael Yang committed
942
		if err := deleteUnusedLayers(deleteMap); err != nil {
943
			fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't remove unused layers: %v", err)})
944
945
946
		}
	}

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

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
963
	var m Manifest
964
965
966
967
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
968
	return &m, err
969
970
971
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
972
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
973
974
975
976
977
978
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

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

Michael Yang's avatar
lint  
Michael Yang committed
982
var errUnauthorized = errors.New("unauthorized: access denied")
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011

// 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)
}
1012

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

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

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

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

Michael Yang's avatar
Michael Yang committed
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
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
	}

1100
1101
1102
	resp, err := (&http.Client{
		CheckRedirect: regOpts.CheckRedirect,
	}).Do(req)
Michael Yang's avatar
Michael Yang committed
1103
1104
1105
1106
1107
1108
1109
	if err != nil {
		return nil, err
	}

	return resp, nil
}

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

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

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

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

	return nil
}