images.go 25.6 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
22

	"github.com/jmorganca/ollama/api"
23
	"github.com/jmorganca/ollama/llm"
24
	"github.com/jmorganca/ollama/parser"
Michael Yang's avatar
Michael Yang committed
25
	"github.com/jmorganca/ollama/version"
26
27
)

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

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

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

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
66
67
68
69
70
71
72
73
	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
}
74

Bruce MacDonald's avatar
Bruce MacDonald committed
75
76
77
78
79
80
81
82
83
84
85
86
87
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
88
89
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
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
119
120
	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
		}
121
122
	}

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

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

type ConfigV2 struct {
Michael Yang's avatar
Michael Yang committed
134
135
136
137
138
	ModelFormat string `json:"model_format"`
	ModelFamily string `json:"model_family"`
	ModelType   string `json:"model_type"`
	FileType    string `json:"file_type"`
	RootFS      RootFS `json:"rootfs"`
139
140

	// required by spec
141
142
143
144
145
146
147
148
149
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
}

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

Michael Yang's avatar
Michael Yang committed
150
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
151
152
153
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
154

Patrick Devine's avatar
Patrick Devine committed
155
156
157
158
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
159
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
160
	fp, err := mp.GetManifestPath()
161
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
162
		return nil, "", err
163
	}
164

165
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
166
		return nil, "", err
167
168
169
170
	}

	var manifest *ManifestV2

171
	bts, err := os.ReadFile(fp)
172
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
173
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
174
175
	}

Patrick Devine's avatar
Patrick Devine committed
176
177
178
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

179
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
180
		return nil, "", err
181
182
	}

Patrick Devine's avatar
Patrick Devine committed
183
	return manifest, shaStr, nil
184
185
186
}

func GetModel(name string) (*Model, error) {
187
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
188
	manifest, digest, err := GetManifest(mp)
189
190
191
192
193
	if err != nil {
		return nil, err
	}

	model := &Model{
194
195
196
197
198
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
199
200
201
	}

	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
202
		filename, err := GetBlobsPath(layer.Digest)
203
204
205
206
		if err != nil {
			return nil, err
		}

207
208
209
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
210
			model.OriginalModel = layer.From
211
		case "application/vnd.ollama.image.embed":
212
213
214
			// 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.")
215
216
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
217
218
219
220
221
222
223
224
225
		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)
226
227
228
			if err != nil {
				return nil, err
			}
229
230

			model.System = string(bts)
231
232
233
234
235
236
237
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
238
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
239
240
241
242
243
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
244

245
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
246
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
247
248
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
249
250
251
252
253
254
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
255
256
257
258
259
260
		}
	}

	return model, nil
}

261
262
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
263
	if err != nil {
264
		return from
265
266
	}

Michael Yang's avatar
Michael Yang committed
267
	home, err := os.UserHomeDir()
268
	if err != nil {
Michael Yang's avatar
Michael Yang committed
269
		return abspath
270
271
	}

272
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
273
		return home
274
275
276
277
278
279
280
	} 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)
281
282
	}

Michael Yang's avatar
Michael Yang committed
283
284
285
	return abspath
}

286
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
287
288
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
289
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
290
291
292
		RootFS: RootFS{
			Type: "layers",
		},
293
294
	}

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

Michael Yang's avatar
Michael Yang committed
297
	var layers Layers
Michael Yang's avatar
Michael Yang committed
298

299
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
300
301
	fromParams := make(map[string]any)

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

306
307
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
308
309
310
311
312
313
314
315
316
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

317
			bin, err := os.Open(realpath(modelFileDir, c.Args))
318
			if err != nil {
Michael Yang's avatar
Michael Yang committed
319
320
321
322
323
324
325
				// 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 {
326
327
328
						return err
					}

Michael Yang's avatar
Michael Yang committed
329
					manifest, _, err = GetManifest(modelpath)
330
331
332
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
333
334
				case err != nil:
					return err
335
				}
336

337
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
338
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
339
340
341
342
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
343
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
344
345
346
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
347
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
348

Michael Yang's avatar
Michael Yang committed
349
350
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
351
352
353
					return err
				}

Michael Yang's avatar
Michael Yang committed
354
355
356
357
				config.ModelFormat = fromConfig.ModelFormat
				config.ModelFamily = fromConfig.ModelFamily
				config.ModelType = fromConfig.ModelType
				config.FileType = fromConfig.FileType
Michael Yang's avatar
Michael Yang committed
358

Michael Yang's avatar
Michael Yang committed
359
360
361
362
				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
363
364
365
366
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
367
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
368
369
370
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
371
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
372

Michael Yang's avatar
Michael Yang committed
373
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
374
375
376
377
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
378
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
379
380
381
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
382

Michael Yang's avatar
Michael Yang committed
383
					layers.Add(layer)
384
				}
Michael Yang's avatar
Michael Yang committed
385
386
387

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
388
			}
Michael Yang's avatar
Michael Yang committed
389
			defer bin.Close()
390

391
392
393
394
395
396
397
398
399
400
401
			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
				}
402

403
404
405
406
				config.ModelFormat = ggml.Name()
				config.ModelFamily = ggml.ModelFamily()
				config.ModelType = ggml.ModelType()
				config.FileType = ggml.FileType()
Michael Yang's avatar
Michael Yang committed
407

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

413
414
415
416
417
418
419
420
421
422
				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
423
		case "adapter":
424
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
			}
			
Michael Yang's avatar
Michael Yang committed
433
			fn(api.ProgressResponse{Status: "creating adapter layer"})
434
			bin, err := os.Open(realpath(modelFileDir, c.Args))
435
			if err != nil {
Michael Yang's avatar
Michael Yang committed
436
				return err
437
			}
Michael Yang's avatar
Michael Yang committed
438
			defer bin.Close()
439

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
465
			layers.Replace(layer)
466
		default:
467
			params[c.Name] = append(params[c.Name], c.Args)
468
469
470
		}
	}

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

474
		formattedParams, err := api.FormatParams(params)
475
		if err != nil {
Michael Yang's avatar
Michael Yang committed
476
			return err
477
		}
478

Michael Yang's avatar
Michael Yang committed
479
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
480
481
482
483
484
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Michael Yang's avatar
Michael Yang committed
485
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
486
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
487
488
489
490
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
491
492
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
493
494
495
			return err
		}

Michael Yang's avatar
Michael Yang committed
496
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
497
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
498
		if err != nil {
Michael Yang's avatar
Michael Yang committed
499
			return err
500
		}
Michael Yang's avatar
Michael Yang committed
501

Michael Yang's avatar
Michael Yang committed
502
		layers.Replace(layer)
503
504
	}

Michael Yang's avatar
Michael Yang committed
505
506
507
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
508
509
	}

Michael Yang's avatar
Michael Yang committed
510
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
511

Michael Yang's avatar
Michael Yang committed
512
513
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
514
515
516
		return err
	}

Michael Yang's avatar
Michael Yang committed
517
518
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
519
520
521
		return err
	}

Michael Yang's avatar
Michael Yang committed
522
	delete(deleteMap, configLayer.Digest)
523

Michael Yang's avatar
Michael Yang committed
524
525
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
526
527
528
		if err != nil {
			return err
		}
529

Michael Yang's avatar
Michael Yang committed
530
531
532
		status := "writing layer"
		if !committed {
			status = "using already created layer"
533
534
		}

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

Michael Yang's avatar
Michael Yang committed
537
		delete(deleteMap, layer.Digest)
538
539
	}

Michael Yang's avatar
Michael Yang committed
540
541
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
542
543
		return err
	}
544

Michael Yang's avatar
Michael Yang committed
545
546
547
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
548
549
550
		}
	}

Michael Yang's avatar
Michael Yang committed
551
552
	fn(api.ProgressResponse{Status: "success"})
	return nil
553
554
}

Patrick Devine's avatar
Patrick Devine committed
555
func CopyModel(src, dest string) error {
556
	srcModelPath := ParseModelPath(src)
557
	srcPath, err := srcModelPath.GetManifestPath()
558
559
560
561
	if err != nil {
		return err
	}

562
	destModelPath := ParseModelPath(dest)
563
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
564
565
566
	if err != nil {
		return err
	}
567
568
569
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
570
571

	// copy the file
Michael Yang's avatar
Michael Yang committed
572
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
573
574
575
576
577
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
578
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
579
580
581
582
583
584
585
586
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
587
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
588
589
590
591
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
592
593
594
595

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

Michael Yang's avatar
Michael Yang committed
598
599
600
601
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
602

Michael Yang's avatar
Michael Yang committed
603
		// skip the manifest we're trying to delete
604
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
605
			return nil
606
		}
Michael Yang's avatar
Michael Yang committed
607
608
609
610
611
612
613
614
615
616
617
618

		// 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)
619
		return nil
Michael Yang's avatar
Michael Yang committed
620
621
622
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
623
624
		return err
	}
625
626

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
627
628
629
630
631
632
633
634
635
	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)
636
637
				continue
			}
Michael Yang's avatar
Michael Yang committed
638
639
		} else {
			log.Printf("wanted to remove: %s", fp)
640
641
642
		}
	}

643
644
645
646
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
647
	deleteMap := make(map[string]struct{})
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
	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
664
665
666
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
667
668
669
670
671
672
673
674
675
676
677
678
679
680
	}

	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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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
}

714
715
716
717
718
719
720
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
721
	deleteMap := make(map[string]struct{})
722
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
723
		deleteMap[layer.Digest] = struct{}{}
724
	}
Michael Yang's avatar
Michael Yang committed
725
	deleteMap[manifest.Config.Digest] = struct{}{}
726
727
728
729
730
731

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

732
	fp, err := mp.GetManifestPath()
733
734
735
736
737
738
739
740
741
742
743
744
	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
745
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
746
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
747
		*Model
Michael Yang's avatar
Michael Yang committed
748
		From       string
Michael Yang's avatar
Michael Yang committed
749
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
750
751
	}

Michael Yang's avatar
Michael Yang committed
752
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
753
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
754
755
756
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
757
758
		}

Michael Yang's avatar
Michael Yang committed
759
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
760
761
	}

Michael Yang's avatar
Michael Yang committed
762
763
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
764

Michael Yang's avatar
Michael Yang committed
765
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
766
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
767
768
769
770
771
772
773
774
	}

	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 }}"""
775
776

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
777
SYSTEM """{{ .System }}"""
778
{{- end }}
779
780
781
782

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

Michael Yang's avatar
Michael Yang committed
784
785
786
787
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
788
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805

	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
}

806
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
807
	mp := ParseModelPath(name)
808
809
	fn(api.ProgressResponse{Status: "retrieving manifest"})

810
811
812
813
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
814
	manifest, _, err := GetManifest(mp)
815
	if err != nil {
816
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
817
818
819
820
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
821
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
822
	layers = append(layers, manifest.Config)
823
824

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
825
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
826
			log.Printf("error uploading blob: %v", err)
827
828
829
			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())
			}
830
831
			return err
		}
832
833
	}

834
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
835
836
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
837
838
839
840
841
842

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

Michael Yang's avatar
Michael Yang committed
843
844
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
845
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
846
847
848
849
850
	if err != nil {
		return err
	}
	defer resp.Body.Close()

851
	fn(api.ProgressResponse{Status: "success"})
852
853
854
855

	return nil
}

856
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
857
858
	mp := ParseModelPath(name)

859
860
861
862
863
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
864
	deleteMap := make(map[string]struct{})
865
866
867
868
869
870
871
872
873

	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
874
				deleteMap[l.Digest] = struct{}{}
875
			}
Michael Yang's avatar
Michael Yang committed
876
			deleteMap[manifest.Config.Digest] = struct{}{}
877
878
879
		}
	}

880
881
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
882
	}
883

884
	fn(api.ProgressResponse{Status: "pulling manifest"})
885

886
	manifest, err = pullModelManifest(ctx, mp, regOpts)
887
	if err != nil {
888
		return fmt.Errorf("pull model manifest: %s", err)
889
890
891
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
892
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
893
	layers = append(layers, manifest.Config)
894
895

	for _, layer := range layers {
896
897
898
899
900
901
902
903
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
904
905
			return err
		}
906
		delete(deleteMap, layer.Digest)
907
	}
908
	delete(deleteMap, manifest.Config.Digest)
909

Michael Yang's avatar
Michael Yang committed
910
911
912
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
913
914
915
916
917
918
919
920
921
922
923
			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
924
925
926
927
			return err
		}
	}

928
	fn(api.ProgressResponse{Status: "writing manifest"})
929

930
	manifestJSON, err := json.Marshal(manifest)
931
932
933
934
	if err != nil {
		return err
	}

935
	fp, err := mp.GetManifestPath()
936
937
938
	if err != nil {
		return err
	}
939
940
941
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
942

Bruce MacDonald's avatar
Bruce MacDonald committed
943
	err = os.WriteFile(fp, manifestJSON, 0o644)
944
945
946
947
948
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

949
950
951
952
953
954
955
956
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

957
	fn(api.ProgressResponse{Status: "success"})
958
959
960
961

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
965
966
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
967
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
968
969
970
971
972
973
974
975
976
977
978
979
980
981
	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
982
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
983
984
985
986
987
988
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
989
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
990
991
}

992
993
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
994
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
995
996
997
998
999
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
1000

1001
1002
1003
1004
1005
1006
1007
1008
1009
		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
1010
1011
1012
		if err != nil {
			return nil, err
		}
1013
1014
1015
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1016
1017
1018
1019
			if err != nil {
				return nil, err
			}
		}
1020
1021
1022
1023
1024
1025
1026

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

		return resp, err
1027
1028
1029
1030
1031
1032
1033
1034
	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
1035
1036
	}

1037
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1038
1039
}

Michael Yang's avatar
Michael Yang committed
1040
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
1041
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1042
		requestURL.Scheme = "http"
1043
1044
	}

Michael Yang's avatar
Michael Yang committed
1045
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1046
1047
1048
1049
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1050
1051
1052
1053
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1054
1055
1056
1057
1058
1059
	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)
		}
1060
1061
	}

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

Michael Yang's avatar
Michael Yang committed
1064
1065
1066
1067
1068
1069
1070
1071
1072
	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
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
	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)
1085
1086
1087
1088
1089
1090
	if err != nil {
		return nil, err
	}

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

Patrick Devine's avatar
Patrick Devine committed
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
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"),
	}
}

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

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

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

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

	return nil
}