images.go 25.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
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
53
type PromptVars struct {
	System   string
	Prompt   string
	Response string
	First    bool
}
54

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

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
76
77
78
79
80
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
81
82
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
83
84
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
	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)
		}
117
118
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
119
120
121
122
123
124
125
126
	// 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
127
128
}

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

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

	// required by spec
144
145
146
147
148
149
150
151
152
	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
153
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
154
155
156
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
157

Patrick Devine's avatar
Patrick Devine committed
158
159
160
161
	total += m.Config.Size
	return total
}

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

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

	var manifest *ManifestV2

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

Patrick Devine's avatar
Patrick Devine committed
179
180
181
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

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

Patrick Devine's avatar
Patrick Devine committed
186
	return manifest, shaStr, nil
187
188
189
}

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

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

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

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

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

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

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

	return model, nil
}

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

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

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

Michael Yang's avatar
Michael Yang committed
286
287
288
	return abspath
}

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

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

Michael Yang's avatar
Michael Yang committed
300
	var layers Layers
Michael Yang's avatar
Michael Yang committed
301

302
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
303
304
	fromParams := make(map[string]any)

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

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

				c.Args = blobPath
			}

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
357
358
359
360
				config.ModelFormat = fromConfig.ModelFormat
				config.ModelFamily = fromConfig.ModelFamily
				config.ModelType = fromConfig.ModelType
				config.FileType = fromConfig.FileType
Michael Yang's avatar
Michael Yang committed
361

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

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

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

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

Michael Yang's avatar
Michael Yang committed
386
					layers.Add(layer)
387
				}
Michael Yang's avatar
Michael Yang committed
388
389
390

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
391
			}
Michael Yang's avatar
Michael Yang committed
392
			defer bin.Close()
393

Michael Yang's avatar
Michael Yang committed
394
395
			fn(api.ProgressResponse{Status: "creating model layer"})
			ggml, err := llm.DecodeGGML(bin)
Michael Yang's avatar
Michael Yang committed
396
397
			if err != nil {
				return err
398
399
			}

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

			bin.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
406
			layer, err := NewLayer(bin, mediatype)
Michael Yang's avatar
Michael Yang committed
407
408
409
			if err != nil {
				return err
			}
410

Michael Yang's avatar
Michael Yang committed
411
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
412
		case "adapter":
413
414
415
416
417
418
419
420
			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
421

Michael Yang's avatar
Michael Yang committed
422
			fn(api.ProgressResponse{Status: "creating adapter layer"})
423
			bin, err := os.Open(realpath(modelFileDir, c.Args))
424
			if err != nil {
Michael Yang's avatar
Michael Yang committed
425
				return err
426
			}
Michael Yang's avatar
Michael Yang committed
427
			defer bin.Close()
428

Michael Yang's avatar
Michael Yang committed
429
			layer, err := NewLayer(bin, mediatype)
430
			if err != nil {
Michael Yang's avatar
Michael Yang committed
431
				return err
432
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
433

Michael Yang's avatar
Michael Yang committed
434
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
435
436
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
437
438
439

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
440
441
442
443
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
444
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
445
446
447
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
448
449
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
450
			if err != nil {
451
				return err
452
			}
453

Michael Yang's avatar
Michael Yang committed
454
			layers.Replace(layer)
455
		default:
456
			params[c.Name] = append(params[c.Name], c.Args)
457
458
459
		}
	}

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

463
		formattedParams, err := api.FormatParams(params)
464
		if err != nil {
Michael Yang's avatar
Michael Yang committed
465
			return err
466
		}
467

Michael Yang's avatar
Michael Yang committed
468
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
469
470
471
472
473
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Michael Yang's avatar
Michael Yang committed
474
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
475
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
476
477
478
479
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
480
481
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
482
483
484
			return err
		}

Michael Yang's avatar
Michael Yang committed
485
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
486
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
487
		if err != nil {
Michael Yang's avatar
Michael Yang committed
488
			return err
489
		}
Michael Yang's avatar
Michael Yang committed
490

Michael Yang's avatar
Michael Yang committed
491
		layers.Replace(layer)
492
493
	}

Michael Yang's avatar
Michael Yang committed
494
495
496
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
497
498
	}

Michael Yang's avatar
Michael Yang committed
499
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
500

Michael Yang's avatar
Michael Yang committed
501
502
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
503
504
505
		return err
	}

Michael Yang's avatar
Michael Yang committed
506
507
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
508
509
510
		return err
	}

Michael Yang's avatar
Michael Yang committed
511
	delete(deleteMap, configLayer.Digest)
512

Michael Yang's avatar
Michael Yang committed
513
514
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
515
516
517
		if err != nil {
			return err
		}
518

Michael Yang's avatar
Michael Yang committed
519
520
521
		status := "writing layer"
		if !committed {
			status = "using already created layer"
522
523
		}

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

Michael Yang's avatar
Michael Yang committed
526
		delete(deleteMap, layer.Digest)
527
528
	}

Michael Yang's avatar
Michael Yang committed
529
530
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
531
532
		return err
	}
533

Michael Yang's avatar
Michael Yang committed
534
535
536
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
537
538
539
		}
	}

Michael Yang's avatar
Michael Yang committed
540
541
	fn(api.ProgressResponse{Status: "success"})
	return nil
542
543
}

Patrick Devine's avatar
Patrick Devine committed
544
func CopyModel(src, dest string) error {
545
	srcModelPath := ParseModelPath(src)
546
	srcPath, err := srcModelPath.GetManifestPath()
547
548
549
550
	if err != nil {
		return err
	}

551
	destModelPath := ParseModelPath(dest)
552
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
553
554
555
	if err != nil {
		return err
	}
556
557
558
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
559
560

	// copy the file
Michael Yang's avatar
Michael Yang committed
561
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
562
563
564
565
566
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
567
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
568
569
570
571
572
573
574
575
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
576
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
577
578
579
580
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
581
582
583
584

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

Michael Yang's avatar
Michael Yang committed
587
588
589
590
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
591

Michael Yang's avatar
Michael Yang committed
592
		// skip the manifest we're trying to delete
593
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
594
			return nil
595
		}
Michael Yang's avatar
Michael Yang committed
596
597
598
599
600
601
602
603
604
605
606
607

		// 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)
608
		return nil
Michael Yang's avatar
Michael Yang committed
609
610
611
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
612
613
		return err
	}
614
615

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
616
617
618
619
620
621
622
623
624
	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)
625
626
				continue
			}
Michael Yang's avatar
Michael Yang committed
627
628
		} else {
			log.Printf("wanted to remove: %s", fp)
629
630
631
		}
	}

632
633
634
635
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
636
	deleteMap := make(map[string]struct{})
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
	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
653
654
655
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
656
657
658
659
660
661
662
663
664
665
666
667
668
669
	}

	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
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
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
}

703
704
705
706
707
708
709
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
710
	deleteMap := make(map[string]struct{})
711
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
712
		deleteMap[layer.Digest] = struct{}{}
713
	}
Michael Yang's avatar
Michael Yang committed
714
	deleteMap[manifest.Config.Digest] = struct{}{}
715
716
717
718
719
720

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

721
	fp, err := mp.GetManifestPath()
722
723
724
725
726
727
728
729
730
731
732
733
	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
734
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
735
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
736
		*Model
Michael Yang's avatar
Michael Yang committed
737
		From       string
Michael Yang's avatar
Michael Yang committed
738
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
739
740
	}

Michael Yang's avatar
Michael Yang committed
741
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
742
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
743
744
745
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
746
747
		}

Michael Yang's avatar
Michael Yang committed
748
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
749
750
	}

Michael Yang's avatar
Michael Yang committed
751
752
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
753

Michael Yang's avatar
Michael Yang committed
754
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
755
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
756
757
758
759
760
761
762
763
	}

	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 }}"""
764
765

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
766
SYSTEM """{{ .System }}"""
767
{{- end }}
768
769
770
771

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

Michael Yang's avatar
Michael Yang committed
773
774
775
776
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
777
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794

	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
}

795
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
796
	mp := ParseModelPath(name)
797
798
	fn(api.ProgressResponse{Status: "retrieving manifest"})

799
800
801
802
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
803
	manifest, _, err := GetManifest(mp)
804
	if err != nil {
805
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
806
807
808
809
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
810
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
811
	layers = append(layers, manifest.Config)
812
813

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
814
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
815
			log.Printf("error uploading blob: %v", err)
816
817
818
			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())
			}
819
820
			return err
		}
821
822
	}

823
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
824
825
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
826
827
828
829
830
831

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

Michael Yang's avatar
Michael Yang committed
832
833
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
834
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
835
836
837
838
839
	if err != nil {
		return err
	}
	defer resp.Body.Close()

840
	fn(api.ProgressResponse{Status: "success"})
841
842
843
844

	return nil
}

845
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
846
847
	mp := ParseModelPath(name)

848
849
850
851
852
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
853
	deleteMap := make(map[string]struct{})
854
855
856
857
858
859
860
861
862

	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
863
				deleteMap[l.Digest] = struct{}{}
864
			}
Michael Yang's avatar
Michael Yang committed
865
			deleteMap[manifest.Config.Digest] = struct{}{}
866
867
868
		}
	}

869
870
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
871
	}
872

873
	fn(api.ProgressResponse{Status: "pulling manifest"})
874

875
	manifest, err = pullModelManifest(ctx, mp, regOpts)
876
	if err != nil {
877
		return fmt.Errorf("pull model manifest: %s", err)
878
879
880
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
881
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
882
	layers = append(layers, manifest.Config)
883
884

	for _, layer := range layers {
885
886
887
888
889
890
891
892
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
893
894
			return err
		}
895
		delete(deleteMap, layer.Digest)
896
	}
897
	delete(deleteMap, manifest.Config.Digest)
898

Michael Yang's avatar
Michael Yang committed
899
900
901
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
902
903
904
905
906
907
908
909
910
911
912
			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
913
914
915
916
			return err
		}
	}

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

919
	manifestJSON, err := json.Marshal(manifest)
920
921
922
923
	if err != nil {
		return err
	}

924
	fp, err := mp.GetManifestPath()
925
926
927
	if err != nil {
		return err
	}
928
929
930
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
931

Bruce MacDonald's avatar
Bruce MacDonald committed
932
	err = os.WriteFile(fp, manifestJSON, 0o644)
933
934
935
936
937
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

938
939
940
941
942
943
944
945
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

946
	fn(api.ProgressResponse{Status: "success"})
947
948
949
950

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
954
955
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
956
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
957
958
959
960
961
962
963
964
965
966
967
968
969
970
	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
971
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
972
973
974
975
976
977
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
978
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
979
980
}

981
982
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
983
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
984
985
986
987
988
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
989

990
991
992
993
994
995
996
997
998
		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
999
1000
1001
		if err != nil {
			return nil, err
		}
1002
1003
1004
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1005
1006
1007
1008
			if err != nil {
				return nil, err
			}
		}
1009
1010
1011
1012
1013
1014
1015

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

		return resp, err
1016
1017
1018
1019
1020
1021
1022
1023
	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
1024
1025
	}

1026
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1027
1028
}

Michael Yang's avatar
Michael Yang committed
1029
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
1030
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1031
		requestURL.Scheme = "http"
1032
1033
	}

Michael Yang's avatar
Michael Yang committed
1034
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1035
1036
1037
1038
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1039
1040
1041
1042
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1043
1044
1045
1046
1047
1048
	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)
		}
1049
1050
	}

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

Michael Yang's avatar
Michael Yang committed
1053
1054
1055
1056
1057
1058
1059
1060
1061
	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
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
	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)
1074
1075
1076
1077
1078
1079
	if err != nil {
		return nil, err
	}

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

Patrick Devine's avatar
Patrick Devine committed
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
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"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
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 {
1130
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1131
1132
1133
1134
	}

	return nil
}