"test/child.cpp" did not exist on "767133d2b27d891e9d693a904906b363f8f8fc16"
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"
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" {
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, command, baseLayers, 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, command, baseLayers, 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
					} 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())

455
						if err := llama.Quantize(blob, temp.Name(), uint32(want)); err != nil {
Michael Yang's avatar
Michael Yang committed
456
457
458
							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
func deleteUnusedLayers(deleteMap map[string]struct{}) error {
691
692
	// Ignore corrupt manifests to avoid blocking deletion of layers that are freshly orphaned
	manifests, err := Manifests(true)
693
694
695
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
696

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

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

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

718
719
720
721
	return nil
}

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return nil
}

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
985
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
986
	for range 2 {
Michael Yang's avatar
Michael Yang committed
987
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
988
		if err != nil {
Michael Yang's avatar
Michael Yang committed
989
			if !errors.Is(err, context.Canceled) {
990
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
991
992
			}

Michael Yang's avatar
Michael Yang committed
993
994
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
995
996
997

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
998
999
			resp.Body.Close()

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

Michael Yang's avatar
Michael Yang committed
1028
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1029
1030
}

1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
// 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
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
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)
		}
	}

1068
	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
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078

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

		req.ContentLength = contentLength
	}

1079
	resp, err := (&http.Client{
1080
1081
1082
		Transport: &http.Transport{
			DialContext: testMakeRequestDialContext,
		},
1083
1084
		CheckRedirect: regOpts.CheckRedirect,
	}).Do(req)
Michael Yang's avatar
Michael Yang committed
1085
1086
1087
1088
1089
1090
1091
	if err != nil {
		return nil, err
	}

	return resp, nil
}

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

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

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

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

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

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

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

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

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

	return nil
}