images.go 27.3 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"
Patrick Devine's avatar
Patrick Devine committed
8
	"encoding/hex"
9
10
11
12
13
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
14
	"log/slog"
15
	"net"
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"
Michael Yang's avatar
Michael Yang committed
26
	"github.com/ollama/ollama/envconfig"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/ollama/ollama/format"
28
	"github.com/ollama/ollama/llama"
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"
Michael Yang's avatar
Michael Yang committed
32
	"github.com/ollama/ollama/types/model"
33
	"github.com/ollama/ollama/version"
34
35
)

36
37
38
39
40
41
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
42

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

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

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

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

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

	Template *template.Template
75
76
}

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

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

	return nil
121
122
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return model, nil
}

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

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

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

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

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

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

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

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

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

				blobpath, err := GetBlobsPath(digest)
Michael Yang's avatar
Michael Yang committed
406
				if err != nil {
Michael Yang's avatar
Michael Yang committed
407
					return err
408
				}
409

Michael Yang's avatar
Michael Yang committed
410
				blob, err := os.Open(blobpath)
Michael Yang's avatar
Michael Yang committed
411
412
413
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
414
				defer blob.Close()
Michael Yang's avatar
Michael Yang committed
415

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

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

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

Michael Yang's avatar
Michael Yang committed
441
442
					ft := baseLayer.GGML.KV().FileType()
					if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
Michael Yang's avatar
Michael Yang committed
443
						return errors.New("quantization is only supported for F16 and F32 models")
Michael Yang's avatar
Michael Yang committed
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())

459
						if err := llama.Quantize(blob, temp.Name(), uint32(want)); err != nil {
Michael Yang's avatar
Michael Yang committed
460
461
462
							return err
						}

Michael Yang's avatar
Michael Yang committed
463
						layer, err := NewLayer(temp, baseLayer.MediaType)
Michael Yang's avatar
Michael Yang committed
464
465
466
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
467

Michael Yang's avatar
Michael Yang committed
468
469
470
471
						if _, err := temp.Seek(0, io.SeekStart); err != nil {
							return err
						}

472
						ggml, _, err := llm.DecodeGGML(temp, 0)
Michael Yang's avatar
Michael Yang committed
473
474
						if err != nil {
							return err
Michael Yang's avatar
Michael Yang committed
475
476
						}

Michael Yang's avatar
Michael Yang committed
477
478
						baseLayer.Layer = layer
						baseLayer.GGML = ggml
Michael Yang's avatar
Michael Yang committed
479
					}
480
				}
481

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

Michael Yang's avatar
Michael Yang committed
490
				layers = append(layers, baseLayer.Layer)
491
			}
Michael Yang's avatar
Michael Yang committed
492
		case "license", "template", "system":
Josh's avatar
Josh committed
493
494
495
496
497
498
			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
499
500
			if c.Name != "license" {
				// replace
501
				layers = slices.DeleteFunc(layers, func(layer Layer) bool {
502
503
504
505
506
507
508
509
510
					if layer.MediaType != mediatype {
						return false
					}

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

					return true
Michael Yang's avatar
Michael Yang committed
511
				})
Michael Yang's avatar
Michael Yang committed
512
513
			}

514
515
516
517
518
519
			blob := strings.NewReader(c.Args)
			layer, err := NewLayer(blob, mediatype)
			if err != nil {
				return err
			}

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

Michael Yang's avatar
Michael Yang committed
534
535
536
537
538
539
540
541
542
543
544
			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
545

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

Michael Yang's avatar
Michael Yang committed
565
566
567
568
569
			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
570

Michael Yang's avatar
Michael Yang committed
571
572
573
574
			for k, v := range ps {
				if _, ok := parameters[k]; !ok {
					parameters[k] = v
				}
575
			}
576

Michael Yang's avatar
Michael Yang committed
577
			return true
578
		default:
Michael Yang's avatar
Michael Yang committed
579
			return false
580
		}
Michael Yang's avatar
Michael Yang committed
581
582
583
584
	})

	if err2 != nil {
		return err2
585
586
	}

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

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

Michael Yang's avatar
Michael Yang committed
598
		layers = append(layers, layer)
599
600
	}

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

Michael Yang's avatar
Michael Yang committed
607
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
608
		if err != nil {
Michael Yang's avatar
Michael Yang committed
609
			return err
610
		}
Michael Yang's avatar
Michael Yang committed
611

Michael Yang's avatar
Michael Yang committed
612
		layers = append(layers, layer)
613
614
	}

Michael Yang's avatar
Michael Yang committed
615
616
	digests := make([]string, len(layers))
	for i, layer := range layers {
Michael Yang's avatar
Michael Yang committed
617
		digests[i] = layer.Digest
618
619
	}

Michael Yang's avatar
Michael Yang committed
620
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
621

Michael Yang's avatar
Michael Yang committed
622
623
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
624
625
626
		return err
	}

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

632
	for _, layer := range append(layers, configLayer) {
Michael Yang's avatar
Michael Yang committed
633
634
		if layer.status != "" {
			fn(api.ProgressResponse{Status: layer.status})
635
		}
Michael Yang's avatar
Michael Yang committed
636
	}
637

638
	old, _ := ParseNamedManifest(name)
639

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

Michael Yang's avatar
bool  
Michael Yang committed
645
	if !envconfig.NoPrune() && old != nil {
646
		if err := old.RemoveLayers(); err != nil {
Michael Yang's avatar
Michael Yang committed
647
			return err
648
649
650
		}
	}

Michael Yang's avatar
Michael Yang committed
651
652
	fn(api.ProgressResponse{Status: "success"})
	return nil
653
654
}

Michael Yang's avatar
Michael Yang committed
655
func CopyModel(src, dst model.Name) error {
656
657
658
659
660
661
662
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

663
664
665
666
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
667
	manifests, err := GetManifestPath()
668
669
670
671
	if err != nil {
		return err
	}

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

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

Michael Yang's avatar
Michael Yang committed
684
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
685
686
687
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
688
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
689

Michael Yang's avatar
Michael Yang committed
690
691
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
692
693
}

Michael Yang's avatar
Michael Yang committed
694
func deleteUnusedLayers(deleteMap map[string]struct{}) error {
695
696
	// Ignore corrupt manifests to avoid blocking deletion of layers that are freshly orphaned
	manifests, err := Manifests(true)
697
698
699
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
700

Michael Yang's avatar
Michael Yang committed
701
	for _, manifest := range manifests {
Michael Yang's avatar
Michael Yang committed
702
703
704
705
706
		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
707
	}
708
709

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

722
723
724
725
	return nil
}

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

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

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

		_, 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
752
		}
753
754

		deleteMap[name] = struct{}{}
755
756
	}

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

Michael Yang's avatar
Michael Yang committed
759
	if err := deleteUnusedLayers(deleteMap); err != nil {
760
		slog.Error(fmt.Sprintf("couldn't remove unused layers: %v", err))
761
		return nil
762
763
	}

764
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
765
766
767
768

	return nil
}

Michael Yang's avatar
Michael Yang committed
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
797
798
799
800
801
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
802
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
803
	mp := ParseModelPath(name)
804
805
	fn(api.ProgressResponse{Status: "retrieving manifest"})

806
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
Michael Yang's avatar
lint  
Michael Yang committed
807
		return errors.New("insecure protocol http")
808
809
	}

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

816
	var layers []Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
817
	layers = append(layers, manifest.Layers...)
818
	if manifest.Config.Digest != "" {
819
		layers = append(layers, manifest.Config)
820
	}
821
822

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

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

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

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

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

	return nil
}

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

854
	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
855
	deleteMap := make(map[string]struct{})
Michael Yang's avatar
Michael Yang committed
856
857
858
	manifest, _, err := GetManifest(mp)
	if errors.Is(err, os.ErrNotExist) {
		// noop
859
860
	} else if err != nil {
		slog.Warn("pulling model with bad existing manifest", "name", name, "error", err)
Michael Yang's avatar
Michael Yang committed
861
862
863
	} else {
		for _, l := range manifest.Layers {
			deleteMap[l.Digest] = struct{}{}
864
		}
Michael Yang's avatar
Michael Yang committed
865
866
		if manifest.Config.Digest != "" {
			deleteMap[manifest.Config.Digest] = struct{}{}
867
868
869
		}
	}

870
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
Michael Yang's avatar
lint  
Michael Yang committed
871
		return errors.New("insecure protocol http")
872
	}
873

874
	fn(api.ProgressResponse{Status: "pulling manifest"})
875

876
	manifest, err = pullModelManifest(ctx, mp, regOpts)
877
	if err != nil {
878
		return fmt.Errorf("pull model manifest: %s", err)
879
880
	}

881
	var layers []Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
882
	layers = append(layers, manifest.Layers...)
883
	if manifest.Config.Digest != "" {
884
		layers = append(layers, manifest.Config)
885
	}
886

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

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

924
	fn(api.ProgressResponse{Status: "writing manifest"})
925

926
	manifestJSON, err := json.Marshal(manifest)
927
928
929
930
	if err != nil {
		return err
	}

931
	fp, err := mp.GetManifestPath()
932
933
934
	if err != nil {
		return err
	}
935
936
937
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
938

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

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

952
	fn(api.ProgressResponse{Status: "success"})
953
954
955
956

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
968
	var m Manifest
969
970
971
972
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
973
	return &m, err
974
975
976
}

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

Michael Yang's avatar
Michael Yang committed
984
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
985
986
}

Michael Yang's avatar
lint  
Michael Yang committed
987
var errUnauthorized = errors.New("unauthorized: access denied")
988

Michael Yang's avatar
Michael Yang committed
989
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
Michael Yang's avatar
lint  
Michael Yang committed
990
	for range 2 {
Michael Yang's avatar
Michael Yang committed
991
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
992
		if err != nil {
Michael Yang's avatar
Michael Yang committed
993
			if !errors.Is(err, context.Canceled) {
994
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
995
996
			}

Michael Yang's avatar
Michael Yang committed
997
998
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
999
1000
1001

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
1002
1003
			resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
1004
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
1005
1006
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
1007
1008
1009
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
1010
1011
1012
1013
1014
1015
1016
1017
			regOpts.Token = token
			if body != nil {
				_, err = body.Seek(0, io.SeekStart)
				if err != nil {
					return nil, err
				}
			}
		case resp.StatusCode == http.StatusNotFound:
1018
			resp.Body.Close()
Michael Yang's avatar
Michael Yang committed
1019
1020
			return nil, os.ErrNotExist
		case resp.StatusCode >= http.StatusBadRequest:
1021
			defer resp.Body.Close()
Michael Yang's avatar
Michael Yang committed
1022
1023
1024
1025
1026
1027
1028
			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
1029
1030
1031
		}
	}

Michael Yang's avatar
Michael Yang committed
1032
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1033
1034
}

1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
// testMakeRequestDialContext specifies the dial function for the http client in
// makeRequest. It can be used to resolve hosts in model names to local
// addresses for testing. For example, the model name ("example.com/my/model")
// can be directed to push/pull from "127.0.0.1:1234".
//
// This is not safe to set across goroutines. It should be set in
// the main test goroutine, and not by tests marked to run in parallel with
// t.Parallel().
//
// It should be cleared after use, otherwise it will affect other tests.
//
// Ideally we would have some set this up the stack, but the code is not
// structured in a way that makes this easy, so this will have to do for now.
var testMakeRequestDialContext func(ctx context.Context, network, addr string) (net.Conn, error)

Michael Yang's avatar
Michael Yang committed
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
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)
		}
	}

1072
	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
Michael Yang's avatar
Michael Yang committed
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082

	if s := req.Header.Get("Content-Length"); s != "" {
		contentLength, err := strconv.ParseInt(s, 10, 64)
		if err != nil {
			return nil, err
		}

		req.ContentLength = contentLength
	}

1083
	c := &http.Client{
1084
		CheckRedirect: regOpts.CheckRedirect,
Michael Yang's avatar
Michael Yang committed
1085
	}
1086
1087
1088
1089
1090
1091
	if testMakeRequestDialContext != nil {
		tr := http.DefaultTransport.(*http.Transport).Clone()
		tr.DialContext = testMakeRequestDialContext
		c.Transport = tr
	}
	return c.Do(req)
Michael Yang's avatar
Michael Yang committed
1092
1093
}

Patrick Devine's avatar
Patrick Devine committed
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
func getValue(header, key string) string {
	startIdx := strings.Index(header, key+"=")
	if startIdx == -1 {
		return ""
	}

	// Move the index to the starting quote after the key.
	startIdx += len(key) + 2
	endIdx := startIdx

	for endIdx < len(header) {
		if header[endIdx] == '"' {
			if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
				endIdx++
				continue
			}
			break
		}
		endIdx++
	}
	return header[startIdx:endIdx]
}

Michael Yang's avatar
Michael Yang committed
1117
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1118
1119
	authStr = strings.TrimPrefix(authStr, "Bearer ")

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

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

Michael Yang's avatar
Michael Yang committed
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
func verifyBlob(digest string) error {
	fp, err := GetBlobsPath(digest)
	if err != nil {
		return err
	}

	f, err := os.Open(fp)
	if err != nil {
		return err
	}
	defer f.Close()

	fileDigest, _ := GetSHA256Digest(f)
	if digest != fileDigest {
1143
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1144
1145
1146
1147
	}

	return nil
}