images.go 26.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
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
55
type PromptVars struct {
	System   string
	Prompt   string
	Response string
	First    bool
}
56

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
69
70
71
72
73
74
75
76
	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
}
77

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

Bruce MacDonald's avatar
Bruce MacDonald committed
85
86
87
88
89
90
91
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
	writePrompt := func() error {
		p, err := m.Prompt(currentVars)
		if err != nil {
			return err
		}
		prompt.WriteString(p)
		currentVars = PromptVars{}
		return nil
	}

	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)
		}
119
120
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
121
122
123
124
125
126
127
128
	// Append the last set of vars if they are non-empty
	if currentVars.Prompt != "" || currentVars.System != "" {
		if err := writePrompt(); err != nil {
			return "", err
		}
	}

	return prompt.String(), nil
129
130
}

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

type ConfigV2 struct {
Michael Yang's avatar
Michael Yang committed
139
140
141
142
143
144
	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"`
145
146

	// required by spec
147
148
149
150
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
}

Michael Yang's avatar
Michael Yang committed
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
178
179
180
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
	}
}

181
182
183
184
185
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

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

Patrick Devine's avatar
Patrick Devine committed
191
192
193
194
	total += m.Config.Size
	return total
}

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

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

	var manifest *ManifestV2

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

Patrick Devine's avatar
Patrick Devine committed
212
213
214
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

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

Patrick Devine's avatar
Patrick Devine committed
219
	return manifest, shaStr, nil
220
221
222
}

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

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

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

243
244
245
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
246
			model.OriginalModel = layer.From
247
		case "application/vnd.ollama.image.embed":
248
249
250
			// 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.")
251
252
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
253
254
255
256
257
258
259
260
261
		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)
262
263
264
			if err != nil {
				return nil, err
			}
265
266

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

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

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

	return model, nil
}

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

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

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

Michael Yang's avatar
Michael Yang committed
319
320
321
	return abspath
}

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

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

Michael Yang's avatar
Michael Yang committed
333
	var layers Layers
Michael Yang's avatar
Michael Yang committed
334

335
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
336
337
	fromParams := make(map[string]any)

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

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

				c.Args = blobPath
			}

353
			bin, err := os.Open(realpath(modelFileDir, c.Args))
354
			if err != nil {
Michael Yang's avatar
Michael Yang committed
355
356
357
358
359
360
361
				// 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 {
362
363
364
						return err
					}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
390
391
392
393
				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
394

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

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

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

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

Michael Yang's avatar
Michael Yang committed
419
					layers.Add(layer)
420
				}
Michael Yang's avatar
Michael Yang committed
421
422
423

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
424
			}
Michael Yang's avatar
Michael Yang committed
425
			defer bin.Close()
426

427
428
429
			var offset int64
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
430

431
432
433
434
435
436
437
				bin.Seek(offset, io.SeekStart)
				ggml, err := llm.DecodeGGML(bin)
				if errors.Is(err, io.EOF) {
					break
				} else if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
438

Michael Yang's avatar
Michael Yang committed
439
440
441
442
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
443

444
445
446
447
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
448

449
450
451
452
453
454
455
456
457
458
				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
459
		case "adapter":
460
461
462
463
464
465
466
467
			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
468

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
538
		layers.Replace(layer)
539
540
	}

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

Michael Yang's avatar
Michael Yang committed
546
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
547

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

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

Michael Yang's avatar
Michael Yang committed
558
	delete(deleteMap, configLayer.Digest)
559

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

Michael Yang's avatar
Michael Yang committed
566
567
568
		status := "writing layer"
		if !committed {
			status = "using already created layer"
569
570
		}

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

Michael Yang's avatar
Michael Yang committed
573
		delete(deleteMap, layer.Digest)
574
575
	}

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

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

Michael Yang's avatar
Michael Yang committed
587
588
	fn(api.ProgressResponse{Status: "success"})
	return nil
589
590
}

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

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

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

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

	return nil
}

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

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

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

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

		// 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)
655
		return nil
Michael Yang's avatar
Michael Yang committed
656
657
658
	}

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

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
663
664
665
666
667
668
669
670
671
	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)
672
673
				continue
			}
Michael Yang's avatar
Michael Yang committed
674
675
		} else {
			log.Printf("wanted to remove: %s", fp)
676
677
678
		}
	}

679
680
681
682
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
683
	deleteMap := make(map[string]struct{})
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
	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
700
701
702
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
703
704
705
706
707
708
709
710
711
712
713
714
715
716
	}

	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
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
747
748
749
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
}

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

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

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

768
	fp, err := mp.GetManifestPath()
769
770
771
772
773
774
775
776
777
778
779
780
	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
781
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
782
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
783
		*Model
Michael Yang's avatar
Michael Yang committed
784
		From       string
Michael Yang's avatar
Michael Yang committed
785
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
786
787
	}

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

Michael Yang's avatar
Michael Yang committed
795
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
796
797
	}

Michael Yang's avatar
Michael Yang committed
798
799
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
800

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

	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 }}"""
811
812

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
813
SYSTEM """{{ .System }}"""
814
{{- end }}
815
816
817
818

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

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

	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
}

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

846
847
848
849
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

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

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

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

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

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

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

887
	fn(api.ProgressResponse{Status: "success"})
888
889
890
891

	return nil
}

892
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
893
894
	mp := ParseModelPath(name)

895
896
897
898
899
	var manifest *ManifestV2
	var err error
	var noprune string

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

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

916
917
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
918
	}
919

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

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

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

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

Michael Yang's avatar
Michael Yang committed
946
947
948
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
949
950
951
952
953
954
955
956
957
958
959
			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
960
961
962
963
			return err
		}
	}

964
	fn(api.ProgressResponse{Status: "writing manifest"})
965

966
	manifestJSON, err := json.Marshal(manifest)
967
968
969
970
	if err != nil {
		return err
	}

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

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

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

993
	fn(api.ProgressResponse{Status: "success"})
994
995
996
997

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
1025
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1026
1027
}

1028
1029
var errUnauthorized = fmt.Errorf("unauthorized")

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

1037
1038
1039
1040
1041
1042
1043
1044
1045
		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
1046
1047
1048
		if err != nil {
			return nil, err
		}
1049
1050
1051
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1052
1053
1054
1055
			if err != nil {
				return nil, err
			}
		}
1056
1057
1058
1059
1060
1061
1062

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

		return resp, err
1063
1064
1065
1066
1067
1068
1069
1070
	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
1071
1072
	}

1073
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1074
1075
}

Michael Yang's avatar
Michael Yang committed
1076
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
1077
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1078
		requestURL.Scheme = "http"
1079
1080
	}

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

Michael Yang's avatar
Michael Yang committed
1086
1087
1088
1089
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1090
1091
1092
1093
1094
1095
	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)
		}
1096
1097
	}

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

Michael Yang's avatar
Michael Yang committed
1100
1101
1102
1103
1104
1105
1106
1107
1108
	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
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
	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)
1121
1122
1123
1124
1125
1126
	if err != nil {
		return nil, err
	}

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

Patrick Devine's avatar
Patrick Devine committed
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
1158
1159
1160
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"),
	}
}

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

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

	return nil
}