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

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

24
	"github.com/ollama/ollama/api"
Michael Yang's avatar
Michael Yang committed
25
	"github.com/ollama/ollama/envconfig"
26
	"github.com/ollama/ollama/fs/gguf"
27
	"github.com/ollama/ollama/parser"
Michael Yang's avatar
Michael Yang committed
28
	"github.com/ollama/ollama/template"
29
	"github.com/ollama/ollama/thinking"
Michael Yang's avatar
Michael Yang committed
30
	"github.com/ollama/ollama/types/model"
31
	"github.com/ollama/ollama/version"
32
33
)

34
35
36
37
38
var (
	errCapabilities         = errors.New("does not support")
	errCapabilityCompletion = errors.New("completion")
	errCapabilityTools      = errors.New("tools")
	errCapabilityInsert     = errors.New("insert")
39
40
	errCapabilityVision     = errors.New("vision")
	errCapabilityEmbedding  = errors.New("embedding")
41
	errCapabilityThinking   = errors.New("thinking")
CYJiang's avatar
CYJiang committed
42
	errInsecureProtocol     = errors.New("insecure protocol http")
43
)
Michael Yang's avatar
Michael Yang committed
44

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

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

54
type Model struct {
Michael Yang's avatar
Michael Yang committed
55
	Name           string `json:"name"`
56
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
57
58
	ShortName      string
	ModelPath      string
59
	ParentModel    string
Michael Yang's avatar
Michael Yang committed
60
61
62
63
64
	AdapterPaths   []string
	ProjectorPaths []string
	System         string
	License        []string
	Digest         string
65
	Options        map[string]any
Michael Yang's avatar
Michael Yang committed
66
	Messages       []api.Message
Michael Yang's avatar
Michael Yang committed
67
68

	Template *template.Template
69
70
}

71
72
73
// Capabilities returns the capabilities that the model supports
func (m *Model) Capabilities() []model.Capability {
	capabilities := []model.Capability{}
74

75
	// Check for completion capability
76
	f, err := gguf.Open(m.ModelPath)
77
	if err == nil {
78
		defer f.Close()
79

80
81
		if f.KeyValue("pooling_type").Valid() {
			capabilities = append(capabilities, model.CapabilityEmbedding)
82
		} else {
83
84
85
86
87
			// If no embedding is specified, we assume the model supports completion
			capabilities = append(capabilities, model.CapabilityCompletion)
		}
		if f.KeyValue("vision.block_count").Valid() {
			capabilities = append(capabilities, model.CapabilityVision)
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
		}
	} else {
		slog.Error("couldn't open model file", "error", err)
	}

	if m.Template == nil {
		return capabilities
	}

	// Check for tools capability
	if slices.Contains(m.Template.Vars(), "tools") {
		capabilities = append(capabilities, model.CapabilityTools)
	}

	// Check for insert capability
	if slices.Contains(m.Template.Vars(), "suffix") {
		capabilities = append(capabilities, model.CapabilityInsert)
	}

107
108
109
110
111
	// Check for vision capability in projector-based models
	if len(m.ProjectorPaths) > 0 {
		capabilities = append(capabilities, model.CapabilityVision)
	}

112
	// Check for thinking capability
113
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
Michael Yang's avatar
Michael Yang committed
114
115
	hasTags := openingTag != "" && closingTag != ""
	if hasTags || m.Config.ModelFamily == "gptoss" {
116
117
118
		capabilities = append(capabilities, model.CapabilityThinking)
	}

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
	return capabilities
}

// CheckCapabilities checks if the model has the specified capabilities returning an error describing
// any missing or unknown capabilities
func (m *Model) CheckCapabilities(want ...model.Capability) error {
	available := m.Capabilities()
	var errs []error

	// Map capabilities to their corresponding error
	capToErr := map[model.Capability]error{
		model.CapabilityCompletion: errCapabilityCompletion,
		model.CapabilityTools:      errCapabilityTools,
		model.CapabilityInsert:     errCapabilityInsert,
		model.CapabilityVision:     errCapabilityVision,
		model.CapabilityEmbedding:  errCapabilityEmbedding,
135
		model.CapabilityThinking:   errCapabilityThinking,
136
137
138
139
140
	}

	for _, cap := range want {
		err, ok := capToErr[cap]
		if !ok {
Michael Yang's avatar
Michael Yang committed
141
			slog.Error("unknown capability", "capability", cap)
Michael Yang's avatar
Michael Yang committed
142
			return fmt.Errorf("unknown capability: %s", cap)
Michael Yang's avatar
Michael Yang committed
143
		}
144
145
146
147

		if !slices.Contains(available, cap) {
			errs = append(errs, err)
		}
Michael Yang's avatar
Michael Yang committed
148
149
	}

150
	var err error
151
	if len(errs) > 0 {
152
153
154
155
156
157
158
159
		err = fmt.Errorf("%w %w", errCapabilities, errors.Join(errs...))
	}

	if slices.Contains(errs, errCapabilityThinking) {
		if m.Config.ModelFamily == "qwen3" || model.ParseName(m.Name).Model == "deepseek-r1" {
			// append a message to the existing error
			return fmt.Errorf("%w. Pull the model again to get the latest version with full thinking support", err)
		}
Michael Yang's avatar
Michael Yang committed
160
161
	}

162
	return err
163
164
}

Michael Yang's avatar
Michael Yang committed
165
func (m *Model) String() string {
166
	var modelfile parser.Modelfile
Michael Yang's avatar
Michael Yang committed
167

168
	modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
169
170
171
		Name: "model",
		Args: m.ModelPath,
	})
172

Michael Yang's avatar
Michael Yang committed
173
	for _, adapter := range m.AdapterPaths {
174
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
175
176
			Name: "adapter",
			Args: adapter,
Michael Yang's avatar
Michael Yang committed
177
		})
178
179
	}

Michael Yang's avatar
Michael Yang committed
180
	for _, projector := range m.ProjectorPaths {
181
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
182
183
			Name: "model",
			Args: projector,
Michael Yang's avatar
Michael Yang committed
184
		})
185
186
	}

Michael Yang's avatar
Michael Yang committed
187
	if m.Template != nil {
188
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
189
			Name: "template",
Michael Yang's avatar
Michael Yang committed
190
			Args: m.Template.String(),
Michael Yang's avatar
Michael Yang committed
191
		})
192
193
	}

Michael Yang's avatar
Michael Yang committed
194
	if m.System != "" {
195
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
196
197
			Name: "system",
			Args: m.System,
Michael Yang's avatar
Michael Yang committed
198
		})
199
200
201
202
203
204
	}

	for k, v := range m.Options {
		switch v := v.(type) {
		case []any:
			for _, s := range v {
205
				modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
206
207
208
					Name: k,
					Args: fmt.Sprintf("%v", s),
				})
209
210
			}
		default:
211
			modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
212
213
214
				Name: k,
				Args: fmt.Sprintf("%v", v),
			})
215
216
217
218
		}
	}

	for _, license := range m.License {
219
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
220
221
222
			Name: "license",
			Args: license,
		})
223
224
225
	}

	for _, msg := range m.Messages {
226
		modelfile.Commands = append(modelfile.Commands, parser.Command{
Michael Yang's avatar
Michael Yang committed
227
			Name: "message",
Michael Yang's avatar
Michael Yang committed
228
			Args: fmt.Sprintf("%s: %s", msg.Role, msg.Content),
Michael Yang's avatar
Michael Yang committed
229
		})
230
231
	}

Michael Yang's avatar
Michael Yang committed
232
	return modelfile.String()
233
234
}

235
type ConfigV2 struct {
236
237
238
239
240
241
	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"`

242
	// required by spec
243
244
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
245
	RootFS       RootFS `json:"rootfs"`
246
247
248
249
250
251
252
}

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

Michael Yang's avatar
Michael Yang committed
253
func GetManifest(mp ModelPath) (*Manifest, string, error) {
254
	fp, err := mp.GetManifestPath()
255
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
256
		return nil, "", err
257
	}
258

Michael Yang's avatar
Michael Yang committed
259
	f, err := os.Open(fp)
260
	if err != nil {
Michael Yang's avatar
Michael Yang committed
261
		return nil, "", err
262
	}
Michael Yang's avatar
Michael Yang committed
263
	defer f.Close()
264

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

Michael Yang's avatar
Michael Yang committed
267
268
	var manifest Manifest
	if err := json.NewDecoder(io.TeeReader(f, sha256sum)).Decode(&manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
269
		return nil, "", err
270
271
	}

Michael Yang's avatar
Michael Yang committed
272
	return &manifest, hex.EncodeToString(sha256sum.Sum(nil)), nil
273
274
275
}

func GetModel(name string) (*Model, error) {
276
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
277
	manifest, digest, err := GetManifest(mp)
278
279
280
281
282
	if err != nil {
		return nil, err
	}

	model := &Model{
283
284
285
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
Michael Yang's avatar
Michael Yang committed
286
		Template:  template.DefaultTemplate,
287
288
	}

289
290
291
292
293
	if manifest.Config.Digest != "" {
		filename, err := GetBlobsPath(manifest.Config.Digest)
		if err != nil {
			return nil, err
		}
294

295
296
297
298
299
		configFile, err := os.Open(filename)
		if err != nil {
			return nil, err
		}
		defer configFile.Close()
300

301
302
303
		if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
			return nil, err
		}
304
305
	}

306
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
307
		filename, err := GetBlobsPath(layer.Digest)
308
309
310
311
		if err != nil {
			return nil, err
		}

312
313
314
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
315
			model.ParentModel = layer.From
316
		case "application/vnd.ollama.image.embed":
317
318
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
319
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
320
321
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
322
323
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
Michael Yang's avatar
Michael Yang committed
324
325
		case "application/vnd.ollama.image.prompt",
			"application/vnd.ollama.image.template":
326
327
328
329
330
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
331
			model.Template, err = template.Parse(string(bts))
332
333
334
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
335
		case "application/vnd.ollama.image.system":
336
337
338
339
340
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

Michael Yang's avatar
Michael Yang committed
341
			model.System = string(bts)
342
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
343
344
345
346
347
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
348

349
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
350
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
351
352
				return nil, err
			}
353
354
355
356
357
358
359
360
361
362
		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
363
364
365
366
367
368
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
369
370
371
372
373
374
		}
	}

	return model, nil
}

Michael Yang's avatar
Michael Yang committed
375
func CopyModel(src, dst model.Name) error {
376
377
378
379
380
381
382
	if !dst.IsFullyQualified() {
		return model.Unqualified(dst)
	}
	if !src.IsFullyQualified() {
		return model.Unqualified(src)
	}

383
384
385
386
	if src.Filepath() == dst.Filepath() {
		return nil
	}

Michael Yang's avatar
Michael Yang committed
387
	manifests, err := GetManifestPath()
388
389
390
391
	if err != nil {
		return err
	}

392
	dstpath := filepath.Join(manifests, dst.Filepath())
Michael Yang's avatar
Michael Yang committed
393
	if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
394
395
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
396

397
	srcpath := filepath.Join(manifests, src.Filepath())
Michael Yang's avatar
Michael Yang committed
398
	srcfile, err := os.Open(srcpath)
Patrick Devine's avatar
Patrick Devine committed
399
400
401
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
402
	defer srcfile.Close()
Patrick Devine's avatar
Patrick Devine committed
403

Michael Yang's avatar
Michael Yang committed
404
	dstfile, err := os.Create(dstpath)
Patrick Devine's avatar
Patrick Devine committed
405
406
407
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
408
	defer dstfile.Close()
Patrick Devine's avatar
Patrick Devine committed
409

Michael Yang's avatar
Michael Yang committed
410
411
	_, err = io.Copy(dstfile, srcfile)
	return err
Patrick Devine's avatar
Patrick Devine committed
412
413
}

Michael Yang's avatar
Michael Yang committed
414
func deleteUnusedLayers(deleteMap map[string]struct{}) error {
415
416
	// Ignore corrupt manifests to avoid blocking deletion of layers that are freshly orphaned
	manifests, err := Manifests(true)
417
418
419
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
420

Michael Yang's avatar
Michael Yang committed
421
	for _, manifest := range manifests {
Michael Yang's avatar
Michael Yang committed
422
423
424
425
426
		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
427
	}
428
429

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
430
431
432
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
433
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
434
435
			continue
		}
436
437
438
		if err := os.Remove(fp); err != nil {
			slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
			continue
439
440
441
		}
	}

442
443
444
445
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
446
	deleteMap := make(map[string]struct{})
447
448
449
450
451
452
453
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
454
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
455
456
457
458
459
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
460
		name = strings.ReplaceAll(name, "-", ":")
461
462
463
464
465
466
467
468
469
470
471

		_, 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
472
		}
473
474

		deleteMap[name] = struct{}{}
475
476
	}

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

Michael Yang's avatar
Michael Yang committed
479
	if err := deleteUnusedLayers(deleteMap); err != nil {
480
		slog.Error(fmt.Sprintf("couldn't remove unused layers: %v", err))
481
		return nil
482
483
	}

484
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
485
486
487
488

	return nil
}

Michael Yang's avatar
Michael Yang committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
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
522
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
523
	mp := ParseModelPath(name)
524
525
	fn(api.ProgressResponse{Status: "retrieving manifest"})

526
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
CYJiang's avatar
CYJiang committed
527
		return errInsecureProtocol
528
529
	}

Patrick Devine's avatar
Patrick Devine committed
530
	manifest, _, err := GetManifest(mp)
531
	if err != nil {
532
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
533
534
535
		return err
	}

536
	var layers []Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
537
	layers = append(layers, manifest.Layers...)
538
	if manifest.Config.Digest != "" {
539
		layers = append(layers, manifest.Config)
540
	}
541
542

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
543
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
544
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
545
546
			return err
		}
547
548
	}

549
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
550
551
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
552
553
554
555
556
557

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

Michael Yang's avatar
Michael Yang committed
558
559
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
560
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
561
562
563
564
565
	if err != nil {
		return err
	}
	defer resp.Body.Close()

566
	fn(api.ProgressResponse{Status: "success"})
567
568
569
570

	return nil
}

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

574
	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
575
	deleteMap := make(map[string]struct{})
Michael Yang's avatar
Michael Yang committed
576
577
578
	manifest, _, err := GetManifest(mp)
	if errors.Is(err, os.ErrNotExist) {
		// noop
579
580
	} else if err != nil {
		slog.Warn("pulling model with bad existing manifest", "name", name, "error", err)
Michael Yang's avatar
Michael Yang committed
581
582
583
	} else {
		for _, l := range manifest.Layers {
			deleteMap[l.Digest] = struct{}{}
584
		}
Michael Yang's avatar
Michael Yang committed
585
586
		if manifest.Config.Digest != "" {
			deleteMap[manifest.Config.Digest] = struct{}{}
587
588
589
		}
	}

590
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
CYJiang's avatar
CYJiang committed
591
		return errInsecureProtocol
592
	}
593

594
	fn(api.ProgressResponse{Status: "pulling manifest"})
595

596
	manifest, err = pullModelManifest(ctx, mp, regOpts)
597
	if err != nil {
598
		return fmt.Errorf("pull model manifest: %s", err)
599
600
	}

601
	var layers []Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
602
	layers = append(layers, manifest.Layers...)
603
	if manifest.Config.Digest != "" {
604
		layers = append(layers, manifest.Config)
605
	}
606

607
	skipVerify := make(map[string]bool)
608
	for _, layer := range layers {
609
610
611
612
613
614
615
		cacheHit, err := downloadBlob(ctx, downloadOpts{
			mp:      mp,
			digest:  layer.Digest,
			regOpts: regOpts,
			fn:      fn,
		})
		if err != nil {
616
617
			return err
		}
618
		skipVerify[layer.Digest] = cacheHit
619
		delete(deleteMap, layer.Digest)
620
	}
621
	delete(deleteMap, manifest.Config.Digest)
622

Michael Yang's avatar
Michael Yang committed
623
624
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
625
626
627
		if skipVerify[layer.Digest] {
			continue
		}
Michael Yang's avatar
Michael Yang committed
628
		if err := verifyBlob(layer.Digest); err != nil {
629
630
631
632
633
634
635
636
			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
637
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
638
639
				}
			}
Michael Yang's avatar
Michael Yang committed
640
641
642
643
			return err
		}
	}

644
	fn(api.ProgressResponse{Status: "writing manifest"})
645

646
	manifestJSON, err := json.Marshal(manifest)
647
648
649
650
	if err != nil {
		return err
	}

651
	fp, err := mp.GetManifestPath()
652
653
654
	if err != nil {
		return err
	}
655
656
657
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
658

Bruce MacDonald's avatar
Bruce MacDonald committed
659
	err = os.WriteFile(fp, manifestJSON, 0o644)
660
	if err != nil {
661
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
662
663
664
		return err
	}

Michael Yang's avatar
Michael Yang committed
665
666
	if !envconfig.NoPrune() && len(deleteMap) > 0 {
		fn(api.ProgressResponse{Status: "removing unused layers"})
Michael Yang's avatar
Michael Yang committed
667
		if err := deleteUnusedLayers(deleteMap); err != nil {
668
			fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't remove unused layers: %v", err)})
669
670
671
		}
	}

672
	fn(api.ProgressResponse{Status: "success"})
673
674
675
676

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
680
681
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
682
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
683
684
685
686
687
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
688
	var m Manifest
689
690
691
692
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
693
	return &m, err
694
695
696
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
697
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
698
699
700
701
702
703
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
704
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
705
706
}

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

Michael Yang's avatar
Michael Yang committed
709
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
710
	for range 2 {
Michael Yang's avatar
Michael Yang committed
711
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
712
		if err != nil {
Michael Yang's avatar
Michael Yang committed
713
			if !errors.Is(err, context.Canceled) {
714
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
715
716
			}

Michael Yang's avatar
Michael Yang committed
717
718
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
719
720
721

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
722
723
			resp.Body.Close()

Michael Yang's avatar
Michael Yang committed
724
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
725
726
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
727
728
729
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
730
731
732
733
734
735
736
737
			regOpts.Token = token
			if body != nil {
				_, err = body.Seek(0, io.SeekStart)
				if err != nil {
					return nil, err
				}
			}
		case resp.StatusCode == http.StatusNotFound:
738
			resp.Body.Close()
Michael Yang's avatar
Michael Yang committed
739
740
			return nil, os.ErrNotExist
		case resp.StatusCode >= http.StatusBadRequest:
741
			defer resp.Body.Close()
Michael Yang's avatar
Michael Yang committed
742
743
744
745
746
747
748
			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
749
750
751
		}
	}

Michael Yang's avatar
Michael Yang committed
752
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
753
754
}

755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
// 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
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
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)
		}
	}

792
	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
793
794
795
796
797
798
799
800
801
802

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

		req.ContentLength = contentLength
	}

803
	c := &http.Client{
804
		CheckRedirect: regOpts.CheckRedirect,
Michael Yang's avatar
Michael Yang committed
805
	}
806
807
808
809
810
811
	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
812
813
}

Patrick Devine's avatar
Patrick Devine committed
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
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
837
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
838
839
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
840
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
841
842
843
844
845
846
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
849
850
851
852
853
854
855
856
857
858
859
860
861
862
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 {
863
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
864
865
866
867
	}

	return nil
}