images.go 25.5 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/http"
Michael Yang's avatar
Michael Yang committed
15
	"net/url"
16
17
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
18
	"runtime"
19
	"strings"
Quinn Slack's avatar
Quinn Slack committed
20
	"text/template"
21

Michael Yang's avatar
Michael Yang committed
22
23
	"golang.org/x/exp/slices"

24
	"github.com/jmorganca/ollama/api"
25
	"github.com/jmorganca/ollama/auth"
26
	"github.com/jmorganca/ollama/llm"
27
28
29
30
	"github.com/jmorganca/ollama/parser"
)

type Model struct {
Michael Yang's avatar
Michael Yang committed
31
	Name           string `json:"name"`
32
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
33
34
	ShortName      string
	ModelPath      string
35
	ParentModel    string
Michael Yang's avatar
Michael Yang committed
36
37
38
39
40
41
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
42
	Size           int64
Michael Yang's avatar
Michael Yang committed
43
	Options        map[string]interface{}
44
45
46
47
48
49
	Messages       []Message
}

type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
50
51
52
53
54
}

type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
55
	Config        *Layer   `json:"config"`
56
57
58
59
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
60
61
62
63
64
65
	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"`

66
	// required by spec
67
68
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
69
	RootFS       RootFS `json:"rootfs"`
70
71
}

Michael Yang's avatar
Michael Yang committed
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
func (c *ConfigV2) SetModelFormat(format string) {
	if c.ModelFormat == "" {
		c.ModelFormat = format
	}
}

func (c *ConfigV2) SetModelFamily(families ...string) {
	for _, family := range families {
		if c.ModelFamily == "" {
			c.ModelFamily = family
		}

		if !slices.Contains(c.ModelFamilies, family) {
			c.ModelFamilies = append(c.ModelFamilies, family)
		}
	}
}

func (c *ConfigV2) SetModelType(modelType string) {
	if c.ModelType == "" {
		c.ModelType = modelType
	}
}

func (c *ConfigV2) SetFileType(fileType string) {
	if c.FileType == "" {
		c.FileType = fileType
	}
}

102
103
104
105
106
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Michael Yang's avatar
Michael Yang committed
107
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
108
109
110
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
111

Patrick Devine's avatar
Patrick Devine committed
112
113
114
115
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
116
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
117
	fp, err := mp.GetManifestPath()
118
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
119
		return nil, "", err
120
	}
121

122
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
123
		return nil, "", err
124
125
126
127
	}

	var manifest *ManifestV2

128
	bts, err := os.ReadFile(fp)
129
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
130
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
131
132
	}

Patrick Devine's avatar
Patrick Devine committed
133
134
135
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

136
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
137
		return nil, "", err
138
139
	}

Patrick Devine's avatar
Patrick Devine committed
140
	return manifest, shaStr, nil
141
142
143
}

func GetModel(name string) (*Model, error) {
144
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
145
	manifest, digest, err := GetManifest(mp)
146
147
148
149
150
	if err != nil {
		return nil, err
	}

	model := &Model{
151
152
153
154
155
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
Patrick Devine's avatar
Patrick Devine committed
156
		Size:      manifest.GetTotalSize(),
157
158
	}

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
	filename, err := GetBlobsPath(manifest.Config.Digest)
	if err != nil {
		return nil, err
	}

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

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

174
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
175
		filename, err := GetBlobsPath(layer.Digest)
176
177
178
179
		if err != nil {
			return nil, err
		}

180
181
182
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
183
			model.ParentModel = layer.From
184
		case "application/vnd.ollama.image.embed":
185
186
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
187
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
188
189
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
190
191
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
192
193
194
195
196
197
198
199
200
		case "application/vnd.ollama.image.template":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
		case "application/vnd.ollama.image.system":
			bts, err := os.ReadFile(filename)
201
202
203
			if err != nil {
				return nil, err
			}
204
205

			model.System = string(bts)
206
207
208
209
210
211
212
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
213
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
214
215
216
217
218
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
219

220
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
221
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
222
223
				return nil, err
			}
224
225
226
227
228
229
230
231
232
233
		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
234
235
236
237
238
239
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
240
241
242
243
244
245
		}
	}

	return model, nil
}

246
247
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
248
	if err != nil {
249
		return from
250
251
	}

Michael Yang's avatar
Michael Yang committed
252
	home, err := os.UserHomeDir()
253
	if err != nil {
Michael Yang's avatar
Michael Yang committed
254
		return abspath
255
256
	}

257
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
258
		return home
259
260
261
262
263
264
265
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

	if _, err := os.Stat(filepath.Join(mfDir, from)); err == nil {
		// this is a file relative to the Modelfile
		return filepath.Join(mfDir, from)
266
267
	}

Michael Yang's avatar
Michael Yang committed
268
269
270
	return abspath
}

271
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
272
273
274
275
276
277
278
	deleteMap := make(map[string]struct{})
	if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
		for _, layer := range append(manifest.Layers, manifest.Config) {
			deleteMap[layer.Digest] = struct{}{}
		}
	}

279
280
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
281
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
282
283
284
		RootFS: RootFS{
			Type: "layers",
		},
285
286
	}

Michael Yang's avatar
Michael Yang committed
287
	var layers Layers
288
	messages := []string{}
Michael Yang's avatar
Michael Yang committed
289

290
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
291
292
	fromParams := make(map[string]any)

293
	for _, c := range commands {
Michael Yang's avatar
Michael Yang committed
294
295
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

296
297
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
298
299
300
301
302
303
304
305
306
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

307
			bin, err := os.Open(realpath(modelFileDir, c.Args))
308
			if err != nil {
Michael Yang's avatar
Michael Yang committed
309
310
311
312
313
314
				// not a file on disk so must be a model reference
				modelpath := ParseModelPath(c.Args)
				manifest, _, err := GetManifest(modelpath)
				switch {
				case errors.Is(err, os.ErrNotExist):
					fn(api.ProgressResponse{Status: "pulling model"})
315
					if err := PullModel(ctx, c.Args, &auth.RegistryOptions{}, fn); err != nil {
316
317
318
						return err
					}

Michael Yang's avatar
Michael Yang committed
319
					manifest, _, err = GetManifest(modelpath)
320
321
322
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
323
324
				case err != nil:
					return err
325
				}
326

327
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
328
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
329
330
331
332
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
333
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
334
335
336
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
337
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
338

Michael Yang's avatar
Michael Yang committed
339
340
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
341
342
343
					return err
				}

Bruce MacDonald's avatar
Bruce MacDonald committed
344
345
346
347
348
				// if the model is still not in gguf format, error out
				if fromConfig.ModelFormat != "gguf" {
					return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
				}

Michael Yang's avatar
Michael Yang committed
349
350
351
352
				config.SetModelFormat(fromConfig.ModelFormat)
				config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
				config.SetModelType(fromConfig.ModelType)
				config.SetFileType(fromConfig.FileType)
Michael Yang's avatar
Michael Yang committed
353

Michael Yang's avatar
Michael Yang committed
354
355
356
357
				for _, layer := range manifest.Layers {
					deleteMap[layer.Digest] = struct{}{}
					if layer.MediaType == "application/vnd.ollama.image.params" {
						fromParamsPath, err := GetBlobsPath(layer.Digest)
Michael Yang's avatar
Michael Yang committed
358
359
360
361
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
362
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
363
364
365
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
366
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
367

Michael Yang's avatar
Michael Yang committed
368
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
369
370
371
372
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
373
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
374
375
376
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
377

Michael Yang's avatar
Michael Yang committed
378
					layers.Add(layer)
379
				}
Michael Yang's avatar
Michael Yang committed
380
381
382

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
383
			}
Michael Yang's avatar
Michael Yang committed
384
			defer bin.Close()
385

386
			var offset int64
Bruce MacDonald's avatar
Bruce MacDonald committed
387
		CREATE:
388
389
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
390

391
392
				bin.Seek(offset, io.SeekStart)
				ggml, err := llm.DecodeGGML(bin)
Bruce MacDonald's avatar
Bruce MacDonald committed
393
394
395
396
397
398
399
400
401
				if err != nil {
					switch {
					case errors.Is(err, io.EOF):
						break CREATE
					case errors.Is(err, llm.ErrUnsupportedFormat):
						return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
					default:
						return err
					}
402
				}
Michael Yang's avatar
Michael Yang committed
403

Michael Yang's avatar
Michael Yang committed
404
405
406
407
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
408

409
410
411
412
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
413

414
415
416
417
418
419
420
421
422
423
				sr := io.NewSectionReader(bin, offset, ggml.Size)
				layer, err := NewLayer(sr, mediatype)
				if err != nil {
					return err
				}

				layers.Add(layer)

				offset += ggml.Size
			}
Michael Yang's avatar
Michael Yang committed
424
		case "adapter":
425
426
427
428
429
430
431
432
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
433

Michael Yang's avatar
Michael Yang committed
434
			fn(api.ProgressResponse{Status: "creating adapter layer"})
435
			bin, err := os.Open(realpath(modelFileDir, c.Args))
436
			if err != nil {
Michael Yang's avatar
Michael Yang committed
437
				return err
438
			}
Michael Yang's avatar
Michael Yang committed
439
			defer bin.Close()
440

Michael Yang's avatar
Michael Yang committed
441
			layer, err := NewLayer(bin, mediatype)
442
			if err != nil {
Michael Yang's avatar
Michael Yang committed
443
				return err
444
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
445

Michael Yang's avatar
Michael Yang committed
446
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
447
448
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
449
450
451

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
452
453
454
455
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
456
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
457
458
459
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
460
461
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
462
			if err != nil {
463
				return err
464
			}
465

Michael Yang's avatar
Michael Yang committed
466
			layers.Replace(layer)
467
468
		case "message":
			messages = append(messages, c.Args)
469
		default:
470
			params[c.Name] = append(params[c.Name], c.Args)
471
472
473
		}
	}

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
	if len(messages) > 0 {
		fn(api.ProgressResponse{Status: "creating parameters layer"})

		msgs := make([]api.Message, 0)

		for _, m := range messages {
			// todo: handle images
			msg := strings.SplitN(m, ": ", 2)
			msgs = append(msgs, api.Message{Role: msg[0], Content: msg[1]})
		}

		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(msgs); err != nil {
			return err
		}

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

		layers.Replace(layer)
	}

Michael Yang's avatar
Michael Yang committed
498
	if len(params) > 0 {
Michael Yang's avatar
Michael Yang committed
499
		fn(api.ProgressResponse{Status: "creating parameters layer"})
Michael Yang's avatar
Michael Yang committed
500

501
		formattedParams, err := api.FormatParams(params)
502
		if err != nil {
Michael Yang's avatar
Michael Yang committed
503
			return err
504
		}
505

Michael Yang's avatar
Michael Yang committed
506
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
507
508
509
510
511
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Patrick Devine's avatar
Patrick Devine committed
512
		// xxx - can this be removed?
Michael Yang's avatar
Michael Yang committed
513
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
514
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
515
516
517
518
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
519
520
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
521
522
523
			return err
		}

Michael Yang's avatar
Michael Yang committed
524
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
525
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
526
		if err != nil {
Michael Yang's avatar
Michael Yang committed
527
			return err
528
		}
Michael Yang's avatar
Michael Yang committed
529

Michael Yang's avatar
Michael Yang committed
530
		layers.Replace(layer)
531
532
	}

Michael Yang's avatar
Michael Yang committed
533
534
535
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
536
537
	}

Michael Yang's avatar
Michael Yang committed
538
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
539

Michael Yang's avatar
Michael Yang committed
540
541
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
542
543
544
		return err
	}

Michael Yang's avatar
Michael Yang committed
545
546
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
547
548
549
		return err
	}

Michael Yang's avatar
Michael Yang committed
550
	delete(deleteMap, configLayer.Digest)
551

Michael Yang's avatar
Michael Yang committed
552
553
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
554
555
556
		if err != nil {
			return err
		}
557

Michael Yang's avatar
Michael Yang committed
558
559
560
		status := "writing layer"
		if !committed {
			status = "using already created layer"
561
562
		}

Michael Yang's avatar
Michael Yang committed
563
		fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
564

Michael Yang's avatar
Michael Yang committed
565
		delete(deleteMap, layer.Digest)
566
567
	}

Michael Yang's avatar
Michael Yang committed
568
569
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
570
571
		return err
	}
572

Michael Yang's avatar
Michael Yang committed
573
574
575
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
576
577
578
		}
	}

Michael Yang's avatar
Michael Yang committed
579
580
	fn(api.ProgressResponse{Status: "success"})
	return nil
581
582
}

Patrick Devine's avatar
Patrick Devine committed
583
func CopyModel(src, dest string) error {
584
	srcModelPath := ParseModelPath(src)
585
	srcPath, err := srcModelPath.GetManifestPath()
586
587
588
589
	if err != nil {
		return err
	}

590
	destModelPath := ParseModelPath(dest)
591
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
592
593
594
	if err != nil {
		return err
	}
595
596
597
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
598
599

	// copy the file
Michael Yang's avatar
Michael Yang committed
600
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
601
602
603
604
605
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
606
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
607
608
609
610
611
612
613
614
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
615
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
616
617
618
619
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
620
621
622
623

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

Michael Yang's avatar
Michael Yang committed
626
627
628
629
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
630

Michael Yang's avatar
Michael Yang committed
631
		// skip the manifest we're trying to delete
632
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
633
			return nil
634
		}
Michael Yang's avatar
Michael Yang committed
635
636
637
638

		// save (i.e. delete from the deleteMap) any files used in other manifests
		manifest, _, err := GetManifest(fmp)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
639
			// nolint: nilerr
Michael Yang's avatar
Michael Yang committed
640
641
642
643
644
645
646
647
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
648
		return nil
Michael Yang's avatar
Michael Yang committed
649
650
651
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
652
653
		return err
	}
654
655

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
656
657
658
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
659
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
660
661
662
663
			continue
		}
		if !dryRun {
			if err := os.Remove(fp); err != nil {
664
				slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
665
666
				continue
			}
Michael Yang's avatar
Michael Yang committed
667
		} else {
668
			slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
669
670
671
		}
	}

672
673
674
675
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
676
	deleteMap := make(map[string]struct{})
677
678
679
680
681
682
683
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
684
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
685
686
687
688
689
690
691
692
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
		if runtime.GOOS == "windows" {
			name = strings.ReplaceAll(name, "-", ":")
		}
Michael Yang's avatar
Michael Yang committed
693
694
695
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
696
697
	}

698
	slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
699
700
701
702
703
704

	err = deleteUnusedLayers(nil, deleteMap, false)
	if err != nil {
		return err
	}

705
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
706
707
708
709

	return nil
}

Michael Yang's avatar
Michael Yang committed
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
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
}

743
744
745
746
747
748
749
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
750
	deleteMap := make(map[string]struct{})
751
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
752
		deleteMap[layer.Digest] = struct{}{}
753
	}
Michael Yang's avatar
Michael Yang committed
754
	deleteMap[manifest.Config.Digest] = struct{}{}
755
756
757
758
759
760

	err = deleteUnusedLayers(&mp, deleteMap, false)
	if err != nil {
		return err
	}

761
	fp, err := mp.GetManifestPath()
762
763
764
765
766
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
767
		slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
768
769
770
771
772
773
		return err
	}

	return nil
}

Patrick Devine's avatar
Patrick Devine committed
774
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
775
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
776
		*Model
Michael Yang's avatar
Michael Yang committed
777
		From       string
Michael Yang's avatar
Michael Yang committed
778
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
779
780
	}

Michael Yang's avatar
Michael Yang committed
781
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
782
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
783
784
785
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
786
787
		}

Michael Yang's avatar
Michael Yang committed
788
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
789
790
	}

Michael Yang's avatar
Michael Yang committed
791
792
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
793

794
795
	if model.ParentModel != "" {
		mt.From = model.ParentModel
Patrick Devine's avatar
Patrick Devine committed
796
797
798
799
800
801
802
803
	}

	modelFile := `# Modelfile generated by "ollama show"
# To build a new Modelfile based on this one, replace the FROM line with:
# FROM {{ .ShortName }}

FROM {{ .From }}
TEMPLATE """{{ .Template }}"""
804
805

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
806
SYSTEM """{{ .System }}"""
807
{{- end }}
808
809
810
811

{{- range $adapter := .AdapterPaths }}
ADAPTER {{ $adapter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
812

Michael Yang's avatar
Michael Yang committed
813
814
815
816
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
817
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
818
819
820

	tmpl, err := template.New("").Parse(modelFile)
	if err != nil {
821
		slog.Info(fmt.Sprintf("error parsing template: %q", err))
Patrick Devine's avatar
Patrick Devine committed
822
823
824
825
826
827
		return "", err
	}

	var buf bytes.Buffer

	if err = tmpl.Execute(&buf, mt); err != nil {
828
		slog.Info(fmt.Sprintf("error executing template: %q", err))
Patrick Devine's avatar
Patrick Devine committed
829
830
831
832
833
834
		return "", err
	}

	return buf.String(), nil
}

835
func PushModel(ctx context.Context, name string, regOpts *auth.RegistryOptions, fn func(api.ProgressResponse)) error {
836
	mp := ParseModelPath(name)
837
838
	fn(api.ProgressResponse{Status: "retrieving manifest"})

839
840
841
842
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
843
	manifest, _, err := GetManifest(mp)
844
	if err != nil {
845
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
846
847
848
849
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
850
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
851
	layers = append(layers, manifest.Config)
852
853

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
854
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
855
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
856
857
858
			if errors.Is(err, errUnauthorized) {
				return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
			}
859
860
			return err
		}
861
862
	}

863
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
864
865
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
866
867
868
869
870
871

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

Michael Yang's avatar
Michael Yang committed
872
873
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
874
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
875
876
877
878
879
	if err != nil {
		return err
	}
	defer resp.Body.Close()

880
	fn(api.ProgressResponse{Status: "success"})
881
882
883
884

	return nil
}

885
func PullModel(ctx context.Context, name string, regOpts *auth.RegistryOptions, fn func(api.ProgressResponse)) error {
886
887
	mp := ParseModelPath(name)

888
889
890
891
892
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
893
	deleteMap := make(map[string]struct{})
894
895
896
897
898
899
900
901
902

	if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		manifest, _, err = GetManifest(mp)
		if err != nil && !errors.Is(err, os.ErrNotExist) {
			return err
		}

		if manifest != nil {
			for _, l := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
903
				deleteMap[l.Digest] = struct{}{}
904
			}
Michael Yang's avatar
Michael Yang committed
905
			deleteMap[manifest.Config.Digest] = struct{}{}
906
907
908
		}
	}

909
910
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
911
	}
912

913
	fn(api.ProgressResponse{Status: "pulling manifest"})
914

915
	manifest, err = pullModelManifest(ctx, mp, regOpts)
916
	if err != nil {
917
		return fmt.Errorf("pull model manifest: %s", err)
918
919
920
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
921
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
922
	layers = append(layers, manifest.Config)
923
924

	for _, layer := range layers {
925
926
927
928
929
930
931
932
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
933
934
			return err
		}
935
		delete(deleteMap, layer.Digest)
936
	}
937
	delete(deleteMap, manifest.Config.Digest)
938

Michael Yang's avatar
Michael Yang committed
939
940
941
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
942
943
944
945
946
947
948
949
			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
950
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
951
952
				}
			}
Michael Yang's avatar
Michael Yang committed
953
954
955
956
			return err
		}
	}

957
	fn(api.ProgressResponse{Status: "writing manifest"})
958

959
	manifestJSON, err := json.Marshal(manifest)
960
961
962
963
	if err != nil {
		return err
	}

964
	fp, err := mp.GetManifestPath()
965
966
967
	if err != nil {
		return err
	}
968
969
970
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
971

Bruce MacDonald's avatar
Bruce MacDonald committed
972
	err = os.WriteFile(fp, manifestJSON, 0o644)
973
	if err != nil {
974
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
975
976
977
		return err
	}

978
979
980
981
982
983
984
985
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

986
	fn(api.ProgressResponse{Status: "success"})
987
988
989
990

	return nil
}

991
func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *auth.RegistryOptions) (*ManifestV2, error) {
Michael Yang's avatar
Michael Yang committed
992
	requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
993

Michael Yang's avatar
Michael Yang committed
994
995
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
996
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	var m *ManifestV2
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

	return m, err
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
1011
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
1012
1013
1014
1015
1016
1017
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
1018
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1019
1020
}

1021
1022
var errUnauthorized = fmt.Errorf("unauthorized")

1023
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *auth.RegistryOptions) (*http.Response, error) {
Michael Yang's avatar
Michael Yang committed
1024
	for i := 0; i < 2; i++ {
1025
		resp, err := auth.MakeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1026
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1027
			if !errors.Is(err, context.Canceled) {
1028
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1029
1030
			}

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

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
			// Handle authentication error with one retry
1037
1038
1039
			authenticate := resp.Header.Get("www-authenticate")
			authRedir := ParseAuthRedirectString(authenticate)
			token, err := auth.GetAuthToken(ctx, authRedir)
Michael Yang's avatar
Michael Yang committed
1040
1041
1042
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
			regOpts.Token = token
			if body != nil {
				_, err = body.Seek(0, io.SeekStart)
				if err != nil {
					return nil, err
				}
			}
		case resp.StatusCode == http.StatusNotFound:
			return nil, os.ErrNotExist
		case resp.StatusCode >= http.StatusBadRequest:
			responseBody, err := io.ReadAll(resp.Body)
			if err != nil {
				return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
			}
			return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
		default:
			return resp, nil
Michael Yang's avatar
Michael Yang committed
1060
1061
1062
		}
	}

Michael Yang's avatar
Michael Yang committed
1063
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1064
1065
}

Patrick Devine's avatar
Patrick Devine committed
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
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]
}

1089
func ParseAuthRedirectString(authStr string) auth.AuthRedirect {
Patrick Devine's avatar
Patrick Devine committed
1090
1091
	authStr = strings.TrimPrefix(authStr, "Bearer ")

1092
	return auth.AuthRedirect{
Patrick Devine's avatar
Patrick Devine committed
1093
1094
1095
1096
1097
1098
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

1099
1100
var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")

Michael Yang's avatar
Michael Yang committed
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
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 {
1115
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1116
1117
1118
1119
	}

	return nil
}