images.go 26.3 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
13
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
	"net/http"
Michael Yang's avatar
Michael Yang committed
14
	"net/url"
15
16
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
17
	"runtime"
18
19
	"strconv"
	"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/llm"
26
	"github.com/jmorganca/ollama/parser"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/jmorganca/ollama/version"
28
29
)

30
31
32
33
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
Patrick Devine's avatar
Patrick Devine committed
34
	Token    string
35
36
}

37
type Model struct {
Patrick Devine's avatar
Patrick Devine committed
38
39
40
41
42
43
44
45
46
47
	Name          string `json:"name"`
	ShortName     string
	ModelPath     string
	OriginalModel string
	AdapterPaths  []string
	Template      string
	System        string
	License       []string
	Digest        string
	Options       map[string]interface{}
48
49
}

Bruce MacDonald's avatar
Bruce MacDonald committed
50
51
52
53
54
type PromptVars struct {
	System   string
	Prompt   string
	Response string
}
55

Bruce MacDonald's avatar
Bruce MacDonald committed
56
57
58
func (m *Model) Prompt(p PromptVars) (string, error) {
	var prompt strings.Builder
	tmpl, err := template.New("").Parse(m.Template)
59
60
61
62
	if err != nil {
		return "", err
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
63
64
65
	if p.System == "" {
		// use the default system prompt for this model if one is not specified
		p.System = m.System
66
67
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
68
69
70
71
72
73
74
75
	var sb strings.Builder
	if err := tmpl.Execute(&sb, p); err != nil {
		return "", err
	}
	prompt.WriteString(sb.String())
	prompt.WriteString(p.Response)
	return prompt.String(), nil
}
76

Bruce MacDonald's avatar
Bruce MacDonald committed
77
78
79
80
81
82
83
84
85
86
87
88
89
func (m *Model) ChatPrompt(msgs []api.Message) (string, error) {
	// build the prompt from the list of messages
	var prompt strings.Builder
	currentVars := PromptVars{}

	writePrompt := func() error {
		p, err := m.Prompt(currentVars)
		if err != nil {
			return err
		}
		prompt.WriteString(p)
		currentVars = PromptVars{}
		return nil
90
91
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
	for _, msg := range msgs {
		switch msg.Role {
		case "system":
			if currentVars.Prompt != "" || currentVars.System != "" {
				if err := writePrompt(); err != nil {
					return "", err
				}
			}
			currentVars.System = msg.Content
		case "user":
			if currentVars.Prompt != "" || currentVars.System != "" {
				if err := writePrompt(); err != nil {
					return "", err
				}
			}
			currentVars.Prompt = msg.Content
		case "assistant":
			currentVars.Response = msg.Content
			if err := writePrompt(); err != nil {
				return "", err
			}
		default:
			return "", fmt.Errorf("invalid role: %s, role must be one of [system, user, assistant]", msg.Role)
		}
	}

	// Append the last set of vars if they are non-empty
	if currentVars.Prompt != "" || currentVars.System != "" {
		if err := writePrompt(); err != nil {
			return "", err
		}
123
124
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
125
	return prompt.String(), nil
126
127
}

128
129
130
type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
131
	Config        *Layer   `json:"config"`
132
133
134
135
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
Michael Yang's avatar
Michael Yang committed
136
137
138
139
140
141
	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"`
	RootFS        RootFS   `json:"rootfs"`
142
143

	// required by spec
144
145
146
147
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
}

Michael Yang's avatar
Michael Yang committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
	}
}

178
179
180
181
182
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Michael Yang's avatar
Michael Yang committed
183
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
184
185
186
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
187

Patrick Devine's avatar
Patrick Devine committed
188
189
190
191
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
192
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
193
	fp, err := mp.GetManifestPath()
194
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
195
		return nil, "", err
196
	}
197

198
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
199
		return nil, "", err
200
201
202
203
	}

	var manifest *ManifestV2

204
	bts, err := os.ReadFile(fp)
205
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
206
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
207
208
	}

Patrick Devine's avatar
Patrick Devine committed
209
210
211
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

212
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
213
		return nil, "", err
214
215
	}

Patrick Devine's avatar
Patrick Devine committed
216
	return manifest, shaStr, nil
217
218
219
}

func GetModel(name string) (*Model, error) {
220
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
221
	manifest, digest, err := GetManifest(mp)
222
223
224
225
226
	if err != nil {
		return nil, err
	}

	model := &Model{
227
228
229
230
231
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
232
233
234
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
235
		filename, err := GetBlobsPath(layer.Digest)
236
237
238
239
		if err != nil {
			return nil, err
		}

240
241
242
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
243
			model.OriginalModel = layer.From
244
		case "application/vnd.ollama.image.embed":
245
246
247
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
			log.Print("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
248
249
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
250
251
252
253
254
255
256
257
258
		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)
259
260
261
			if err != nil {
				return nil, err
			}
262
263

			model.System = string(bts)
264
265
266
267
268
269
270
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
271
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
272
273
274
275
276
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
277

278
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
279
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
280
281
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
282
283
284
285
286
287
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
288
289
290
291
292
293
		}
	}

	return model, nil
}

294
295
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
296
	if err != nil {
297
		return from
298
299
	}

Michael Yang's avatar
Michael Yang committed
300
	home, err := os.UserHomeDir()
301
	if err != nil {
Michael Yang's avatar
Michael Yang committed
302
		return abspath
303
304
	}

305
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
306
		return home
307
308
309
310
311
312
313
	} 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)
314
315
	}

Michael Yang's avatar
Michael Yang committed
316
317
318
	return abspath
}

319
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
320
321
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
322
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
323
324
325
		RootFS: RootFS{
			Type: "layers",
		},
326
327
	}

Michael Yang's avatar
Michael Yang committed
328
329
	deleteMap := make(map[string]struct{})

Michael Yang's avatar
Michael Yang committed
330
	var layers Layers
Michael Yang's avatar
Michael Yang committed
331

332
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
333
334
	fromParams := make(map[string]any)

335
	for _, c := range commands {
Michael Yang's avatar
Michael Yang committed
336
337
338
		log.Printf("[%s] - %s", c.Name, c.Args)
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

339
340
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
341
342
343
344
345
346
347
348
349
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

350
			bin, err := os.Open(realpath(modelFileDir, c.Args))
351
			if err != nil {
Michael Yang's avatar
Michael Yang committed
352
353
354
355
356
357
358
				// 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"})
					if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
359
360
361
						return err
					}

Michael Yang's avatar
Michael Yang committed
362
					manifest, _, err = GetManifest(modelpath)
363
364
365
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
366
367
				case err != nil:
					return err
368
				}
369

370
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
371
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
372
373
374
375
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
376
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
377
378
379
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
380
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
381

Michael Yang's avatar
Michael Yang committed
382
383
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
384
385
386
					return err
				}

Michael Yang's avatar
Michael Yang committed
387
388
389
390
				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
391

Michael Yang's avatar
Michael Yang committed
392
393
394
395
				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
396
397
398
399
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
400
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
401
402
403
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
404
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
405

Michael Yang's avatar
Michael Yang committed
406
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
407
408
409
410
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
411
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
412
413
414
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
415

Michael Yang's avatar
Michael Yang committed
416
					layers.Add(layer)
417
				}
Michael Yang's avatar
Michael Yang committed
418
419
420

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
421
			}
Michael Yang's avatar
Michael Yang committed
422
			defer bin.Close()
423

424
425
426
427
428
429
430
431
432
433
434
			var offset int64
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})

				bin.Seek(offset, io.SeekStart)
				ggml, err := llm.DecodeGGML(bin)
				if errors.Is(err, io.EOF) {
					break
				} else if err != nil {
					return err
				}
435

Michael Yang's avatar
Michael Yang committed
436
437
438
439
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
Michael Yang's avatar
Michael Yang committed
440

441
442
443
444
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
445

446
447
448
449
450
451
452
453
454
455
				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
456
		case "adapter":
457
458
459
460
461
462
463
464
465
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}
			
Michael Yang's avatar
Michael Yang committed
466
			fn(api.ProgressResponse{Status: "creating adapter layer"})
467
			bin, err := os.Open(realpath(modelFileDir, c.Args))
468
			if err != nil {
Michael Yang's avatar
Michael Yang committed
469
				return err
470
			}
Michael Yang's avatar
Michael Yang committed
471
			defer bin.Close()
472

Michael Yang's avatar
Michael Yang committed
473
			layer, err := NewLayer(bin, mediatype)
474
			if err != nil {
Michael Yang's avatar
Michael Yang committed
475
				return err
476
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
477

Michael Yang's avatar
Michael Yang committed
478
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
479
480
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
481
482
483

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
484
485
486
487
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
488
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
489
490
491
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
492
493
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
494
			if err != nil {
495
				return err
496
			}
497

Michael Yang's avatar
Michael Yang committed
498
			layers.Replace(layer)
499
		default:
500
			params[c.Name] = append(params[c.Name], c.Args)
501
502
503
		}
	}

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

507
		formattedParams, err := api.FormatParams(params)
508
		if err != nil {
Michael Yang's avatar
Michael Yang committed
509
			return err
510
		}
511

Michael Yang's avatar
Michael Yang committed
512
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
513
514
515
516
517
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Michael Yang's avatar
Michael Yang committed
518
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
519
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
520
521
522
523
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
524
525
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
526
527
528
			return err
		}

Michael Yang's avatar
Michael Yang committed
529
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
530
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
531
		if err != nil {
Michael Yang's avatar
Michael Yang committed
532
			return err
533
		}
Michael Yang's avatar
Michael Yang committed
534

Michael Yang's avatar
Michael Yang committed
535
		layers.Replace(layer)
536
537
	}

Michael Yang's avatar
Michael Yang committed
538
539
540
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
541
542
	}

Michael Yang's avatar
Michael Yang committed
543
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
544

Michael Yang's avatar
Michael Yang committed
545
546
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
547
548
549
		return err
	}

Michael Yang's avatar
Michael Yang committed
550
551
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
552
553
554
		return err
	}

Michael Yang's avatar
Michael Yang committed
555
	delete(deleteMap, configLayer.Digest)
556

Michael Yang's avatar
Michael Yang committed
557
558
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
559
560
561
		if err != nil {
			return err
		}
562

Michael Yang's avatar
Michael Yang committed
563
564
565
		status := "writing layer"
		if !committed {
			status = "using already created layer"
566
567
		}

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

Michael Yang's avatar
Michael Yang committed
570
		delete(deleteMap, layer.Digest)
571
572
	}

Michael Yang's avatar
Michael Yang committed
573
574
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
575
576
		return err
	}
577

Michael Yang's avatar
Michael Yang committed
578
579
580
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
581
582
583
		}
	}

Michael Yang's avatar
Michael Yang committed
584
585
	fn(api.ProgressResponse{Status: "success"})
	return nil
586
587
}

Patrick Devine's avatar
Patrick Devine committed
588
func CopyModel(src, dest string) error {
589
	srcModelPath := ParseModelPath(src)
590
	srcPath, err := srcModelPath.GetManifestPath()
591
592
593
594
	if err != nil {
		return err
	}

595
	destModelPath := ParseModelPath(dest)
596
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
597
598
599
	if err != nil {
		return err
	}
600
601
602
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
603
604

	// copy the file
Michael Yang's avatar
Michael Yang committed
605
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
606
607
608
609
610
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
611
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
612
613
614
615
616
617
618
619
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
620
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
621
622
623
624
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
625
626
627
628

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

Michael Yang's avatar
Michael Yang committed
631
632
633
634
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
635

Michael Yang's avatar
Michael Yang committed
636
		// skip the manifest we're trying to delete
637
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
638
			return nil
639
		}
Michael Yang's avatar
Michael Yang committed
640
641
642
643
644
645
646
647
648
649
650
651

		// save (i.e. delete from the deleteMap) any files used in other manifests
		manifest, _, err := GetManifest(fmp)
		if err != nil {
			return nil
		}

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

		delete(deleteMap, manifest.Config.Digest)
652
		return nil
Michael Yang's avatar
Michael Yang committed
653
654
655
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
656
657
		return err
	}
658
659

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

676
677
678
679
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
680
	deleteMap := make(map[string]struct{})
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
		log.Printf("couldn't read dir '%s': %v", p, err)
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
		if runtime.GOOS == "windows" {
			name = strings.ReplaceAll(name, "-", ":")
		}
Michael Yang's avatar
Michael Yang committed
697
698
699
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
700
701
702
703
704
705
706
707
708
709
710
711
712
713
	}

	log.Printf("total blobs: %d", len(deleteMap))

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

	log.Printf("total unused blobs removed: %d", len(deleteMap))

	return nil
}

Michael Yang's avatar
Michael Yang committed
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
743
744
745
746
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
}

747
748
749
750
751
752
753
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

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

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

765
	fp, err := mp.GetManifestPath()
766
767
768
769
770
771
772
773
774
775
776
777
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
		log.Printf("couldn't remove manifest file '%s': %v", fp, err)
		return err
	}

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
792
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
793
794
	}

Michael Yang's avatar
Michael Yang committed
795
796
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
797

Michael Yang's avatar
Michael Yang committed
798
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
799
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
800
801
802
803
804
805
806
807
	}

	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 }}"""
808
809

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
810
SYSTEM """{{ .System }}"""
811
{{- end }}
812
813
814
815

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

Michael Yang's avatar
Michael Yang committed
817
818
819
820
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
821
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838

	tmpl, err := template.New("").Parse(modelFile)
	if err != nil {
		log.Printf("error parsing template: %q", err)
		return "", err
	}

	var buf bytes.Buffer

	if err = tmpl.Execute(&buf, mt); err != nil {
		log.Printf("error executing template: %q", err)
		return "", err
	}

	return buf.String(), nil
}

839
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
840
	mp := ParseModelPath(name)
841
842
	fn(api.ProgressResponse{Status: "retrieving manifest"})

843
844
845
846
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

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

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
854
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
855
	layers = append(layers, manifest.Config)
856
857

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
858
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
859
			log.Printf("error uploading blob: %v", err)
860
861
862
			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())
			}
863
864
			return err
		}
865
866
	}

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

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

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

884
	fn(api.ProgressResponse{Status: "success"})
885
886
887
888

	return nil
}

889
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
890
891
	mp := ParseModelPath(name)

892
893
894
895
896
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
897
	deleteMap := make(map[string]struct{})
898
899
900
901
902
903
904
905
906

	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
907
				deleteMap[l.Digest] = struct{}{}
908
			}
Michael Yang's avatar
Michael Yang committed
909
			deleteMap[manifest.Config.Digest] = struct{}{}
910
911
912
		}
	}

913
914
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
915
	}
916

917
	fn(api.ProgressResponse{Status: "pulling manifest"})
918

919
	manifest, err = pullModelManifest(ctx, mp, regOpts)
920
	if err != nil {
921
		return fmt.Errorf("pull model manifest: %s", err)
922
923
924
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
925
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
926
	layers = append(layers, manifest.Config)
927
928

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

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

961
	fn(api.ProgressResponse{Status: "writing manifest"})
962

963
	manifestJSON, err := json.Marshal(manifest)
964
965
966
967
	if err != nil {
		return err
	}

968
	fp, err := mp.GetManifestPath()
969
970
971
	if err != nil {
		return err
	}
972
973
974
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
975

Bruce MacDonald's avatar
Bruce MacDonald committed
976
	err = os.WriteFile(fp, manifestJSON, 0o644)
977
978
979
980
981
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

982
983
984
985
986
987
988
989
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

990
	fn(api.ProgressResponse{Status: "success"})
991
992
993
994

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
998
999
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
1000
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
	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
1015
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
1016
1017
1018
1019
1020
1021
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
1022
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1023
1024
}

1025
1026
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
1027
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
1028
1029
1030
1031
1032
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
1033

1034
1035
1036
1037
1038
1039
1040
1041
1042
		return nil, err
	}

	switch {
	case resp.StatusCode == http.StatusUnauthorized:
		// Handle authentication error with one retry
		auth := resp.Header.Get("www-authenticate")
		authRedir := ParseAuthRedirectString(auth)
		token, err := getAuthToken(ctx, authRedir)
Michael Yang's avatar
Michael Yang committed
1043
1044
1045
		if err != nil {
			return nil, err
		}
1046
1047
1048
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1049
1050
1051
1052
			if err != nil {
				return nil, err
			}
		}
1053
1054
1055
1056
1057
1058
1059

		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
		if resp.StatusCode == http.StatusUnauthorized {
			return nil, errUnauthorized
		}

		return resp, err
1060
1061
1062
1063
1064
1065
1066
1067
	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)
Michael Yang's avatar
Michael Yang committed
1068
1069
	}

1070
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1071
1072
}

Michael Yang's avatar
Michael Yang committed
1073
func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
Michael Yang's avatar
Michael Yang committed
1074
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1075
		requestURL.Scheme = "http"
1076
1077
	}

Michael Yang's avatar
Michael Yang committed
1078
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1079
1080
1081
1082
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1083
1084
1085
1086
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1087
1088
1089
1090
1091
1092
	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)
		}
1093
1094
	}

Michael Yang's avatar
Michael Yang committed
1095
	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
1096

Michael Yang's avatar
Michael Yang committed
1097
1098
1099
1100
1101
1102
1103
1104
1105
	if s := req.Header.Get("Content-Length"); s != "" {
		contentLength, err := strconv.ParseInt(s, 10, 64)
		if err != nil {
			return nil, err
		}

		req.ContentLength = contentLength
	}

Michael Yang's avatar
Michael Yang committed
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
	proxyURL, err := http.ProxyFromEnvironment(req)
	if err != nil {
		return nil, err
	}

	client := http.Client{
		Transport: &http.Transport{
			Proxy: http.ProxyURL(proxyURL),
		},
	}

	resp, err := client.Do(req)
1118
1119
1120
1121
1122
1123
	if err != nil {
		return nil, err
	}

	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1124

Patrick Devine's avatar
Patrick Devine committed
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
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]
}

func ParseAuthRedirectString(authStr string) AuthRedirect {
	authStr = strings.TrimPrefix(authStr, "Bearer ")

	return AuthRedirect{
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
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 {
1174
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1175
1176
1177
1178
	}

	return nil
}