images.go 26.7 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 {
Michael Yang's avatar
Michael Yang committed
38
	Name           string `json:"name"`
39
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
40
41
42
43
44
45
46
47
48
49
	ShortName      string
	ModelPath      string
	OriginalModel  string
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
	Options        map[string]interface{}
50
51
}

Bruce MacDonald's avatar
Bruce MacDonald committed
52
53
54
55
56
57
type PromptVars struct {
	System   string
	Prompt   string
	Response string
	First    bool
}
58

Bruce MacDonald's avatar
Bruce MacDonald committed
59
60
func (m *Model) Prompt(p PromptVars) (string, error) {
	var prompt strings.Builder
61
62
	// Use the "missingkey=zero" option to handle missing variables without panicking
	tmpl, err := template.New("").Option("missingkey=zero").Parse(m.Template)
63
64
65
66
	if err != nil {
		return "", err
	}

67
68
69
70
71
	vars := map[string]any{
		"System":   p.System,
		"Prompt":   p.Prompt,
		"Response": p.Response,
		"First":    p.First,
72
73
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
74
	var sb strings.Builder
75
	if err := tmpl.Execute(&sb, vars); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
76
77
78
79
80
81
		return "", err
	}
	prompt.WriteString(sb.String())
	prompt.WriteString(p.Response)
	return prompt.String(), nil
}
82

Bruce MacDonald's avatar
Bruce MacDonald committed
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{
		First: true,
Bruce MacDonald's avatar
Bruce MacDonald committed
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
121
122
123
	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)
		}
124
125
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
126
127
128
129
130
131
132
133
	// 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
134
135
}

136
137
138
type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
139
	Config        *Layer   `json:"config"`
140
141
142
143
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
144
	// required by spec
145
146
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
147
148
149
	RootFS       RootFS `json:"rootfs"`

	api.ModelConfiguration
150
151
}

Michael Yang's avatar
Michael Yang committed
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
181
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
	}
}

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

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

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

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

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

	var manifest *ManifestV2

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

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

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

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

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

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

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
	filename, err := GetBlobsPath(manifest.Config.Digest)
	if err != nil {
		return nil, err
	}

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

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

253
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
254
		filename, err := GetBlobsPath(layer.Digest)
255
256
257
258
		if err != nil {
			return nil, err
		}

259
260
261
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
262
			model.OriginalModel = layer.From
263
		case "application/vnd.ollama.image.embed":
264
265
266
			// 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.")
267
268
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
269
270
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
271
272
273
274
275
276
277
278
279
		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)
280
281
282
			if err != nil {
				return nil, err
			}
283
284

			model.System = string(bts)
285
286
287
288
289
290
291
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
292
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
293
294
295
296
297
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
298

299
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
300
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
301
302
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
303
304
305
306
307
308
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
309
310
311
312
313
314
		}
	}

	return model, nil
}

315
316
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
317
	if err != nil {
318
		return from
319
320
	}

Michael Yang's avatar
Michael Yang committed
321
	home, err := os.UserHomeDir()
322
	if err != nil {
Michael Yang's avatar
Michael Yang committed
323
		return abspath
324
325
	}

326
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
327
		return home
328
329
330
331
332
333
334
	} 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)
335
336
	}

Michael Yang's avatar
Michael Yang committed
337
338
339
	return abspath
}

340
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
341
342
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
343
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
344
345
346
		RootFS: RootFS{
			Type: "layers",
		},
347
348
	}

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

Michael Yang's avatar
Michael Yang committed
351
	var layers Layers
Michael Yang's avatar
Michael Yang committed
352

353
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
354
355
	fromParams := make(map[string]any)

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

360
361
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
362
363
364
365
366
367
368
369
370
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

371
			bin, err := os.Open(realpath(modelFileDir, c.Args))
372
			if err != nil {
Michael Yang's avatar
Michael Yang committed
373
374
375
376
377
378
379
				// 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 {
380
381
382
						return err
					}

Michael Yang's avatar
Michael Yang committed
383
					manifest, _, err = GetManifest(modelpath)
384
385
386
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
387
388
				case err != nil:
					return err
389
				}
390

391
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
392
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
393
394
395
396
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
397
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
398
399
400
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
401
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
402

Michael Yang's avatar
Michael Yang committed
403
404
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
405
406
407
					return err
				}

Michael Yang's avatar
Michael Yang committed
408
409
410
411
				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
412

Michael Yang's avatar
Michael Yang committed
413
414
415
416
				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
417
418
419
420
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
421
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
422
423
424
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
425
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
426

Michael Yang's avatar
Michael Yang committed
427
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
428
429
430
431
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
432
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
433
434
435
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
436

Michael Yang's avatar
Michael Yang committed
437
					layers.Add(layer)
438
				}
Michael Yang's avatar
Michael Yang committed
439
440
441

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
442
			}
Michael Yang's avatar
Michael Yang committed
443
			defer bin.Close()
444

445
446
447
			var offset int64
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
448

449
450
451
452
453
454
455
				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
456

Michael Yang's avatar
Michael Yang committed
457
458
459
460
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
461

462
463
464
465
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
466

467
468
469
470
471
472
473
474
475
476
				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
477
		case "adapter":
478
479
480
481
482
483
484
485
			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
486

Michael Yang's avatar
Michael Yang committed
487
			fn(api.ProgressResponse{Status: "creating adapter layer"})
488
			bin, err := os.Open(realpath(modelFileDir, c.Args))
489
			if err != nil {
Michael Yang's avatar
Michael Yang committed
490
				return err
491
			}
Michael Yang's avatar
Michael Yang committed
492
			defer bin.Close()
493

Michael Yang's avatar
Michael Yang committed
494
			layer, err := NewLayer(bin, mediatype)
495
			if err != nil {
Michael Yang's avatar
Michael Yang committed
496
				return err
497
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
498

Michael Yang's avatar
Michael Yang committed
499
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
500
501
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
502
503
504

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
505
506
507
508
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
509
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
510
511
512
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
513
514
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
515
			if err != nil {
516
				return err
517
			}
518

Michael Yang's avatar
Michael Yang committed
519
			layers.Replace(layer)
520
		default:
521
			params[c.Name] = append(params[c.Name], c.Args)
522
523
524
		}
	}

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

528
		formattedParams, err := api.FormatParams(params)
529
		if err != nil {
Michael Yang's avatar
Michael Yang committed
530
			return err
531
		}
532

Michael Yang's avatar
Michael Yang committed
533
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
534
535
536
537
538
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Michael Yang's avatar
Michael Yang committed
539
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
540
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
541
542
543
544
				config.ModelType = "70B"
			}
		}

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

Michael Yang's avatar
Michael Yang committed
550
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
551
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
552
		if err != nil {
Michael Yang's avatar
Michael Yang committed
553
			return err
554
		}
Michael Yang's avatar
Michael Yang committed
555

Michael Yang's avatar
Michael Yang committed
556
		layers.Replace(layer)
557
558
	}

Michael Yang's avatar
Michael Yang committed
559
560
561
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
562
563
	}

Michael Yang's avatar
Michael Yang committed
564
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
565

Michael Yang's avatar
Michael Yang committed
566
567
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
568
569
570
		return err
	}

Michael Yang's avatar
Michael Yang committed
571
572
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
573
574
575
		return err
	}

Michael Yang's avatar
Michael Yang committed
576
	delete(deleteMap, configLayer.Digest)
577

Michael Yang's avatar
Michael Yang committed
578
579
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
580
581
582
		if err != nil {
			return err
		}
583

Michael Yang's avatar
Michael Yang committed
584
585
586
		status := "writing layer"
		if !committed {
			status = "using already created layer"
587
588
		}

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

Michael Yang's avatar
Michael Yang committed
591
		delete(deleteMap, layer.Digest)
592
593
	}

Michael Yang's avatar
Michael Yang committed
594
595
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
596
597
		return err
	}
598

Michael Yang's avatar
Michael Yang committed
599
600
601
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
602
603
604
		}
	}

Michael Yang's avatar
Michael Yang committed
605
606
	fn(api.ProgressResponse{Status: "success"})
	return nil
607
608
}

Patrick Devine's avatar
Patrick Devine committed
609
func CopyModel(src, dest string) error {
610
	srcModelPath := ParseModelPath(src)
611
	srcPath, err := srcModelPath.GetManifestPath()
612
613
614
615
	if err != nil {
		return err
	}

616
	destModelPath := ParseModelPath(dest)
617
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
618
619
620
	if err != nil {
		return err
	}
621
622
623
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
624
625

	// copy the file
Michael Yang's avatar
Michael Yang committed
626
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
627
628
629
630
631
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
632
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
633
634
635
636
637
638
639
640
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
641
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
642
643
644
645
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
646
647
648
649

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

Michael Yang's avatar
Michael Yang committed
652
653
654
655
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
656

Michael Yang's avatar
Michael Yang committed
657
		// skip the manifest we're trying to delete
658
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
659
			return nil
660
		}
Michael Yang's avatar
Michael Yang committed
661
662
663
664
665
666
667
668
669
670
671
672

		// 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)
673
		return nil
Michael Yang's avatar
Michael Yang committed
674
675
676
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
677
678
		return err
	}
679
680

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
681
682
683
684
685
686
687
688
689
	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)
690
691
				continue
			}
Michael Yang's avatar
Michael Yang committed
692
693
		} else {
			log.Printf("wanted to remove: %s", fp)
694
695
696
		}
	}

697
698
699
700
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
701
	deleteMap := make(map[string]struct{})
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
	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
718
719
720
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
721
722
723
724
725
726
727
728
729
730
731
732
733
734
	}

	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
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
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
}

768
769
770
771
772
773
774
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
775
	deleteMap := make(map[string]struct{})
776
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
777
		deleteMap[layer.Digest] = struct{}{}
778
	}
Michael Yang's avatar
Michael Yang committed
779
	deleteMap[manifest.Config.Digest] = struct{}{}
780
781
782
783
784
785

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

786
	fp, err := mp.GetManifestPath()
787
788
789
790
791
792
793
794
795
796
797
798
	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
799
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
800
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
801
		*Model
Michael Yang's avatar
Michael Yang committed
802
		From       string
Michael Yang's avatar
Michael Yang committed
803
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
804
805
	}

Michael Yang's avatar
Michael Yang committed
806
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
807
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
808
809
810
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
811
812
		}

Michael Yang's avatar
Michael Yang committed
813
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
814
815
	}

Michael Yang's avatar
Michael Yang committed
816
817
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
818

Michael Yang's avatar
Michael Yang committed
819
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
820
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
821
822
823
824
825
826
827
828
	}

	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 }}"""
829
830

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
831
SYSTEM """{{ .System }}"""
832
{{- end }}
833
834
835
836

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

Michael Yang's avatar
Michael Yang committed
838
839
840
841
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
842
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859

	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
}

860
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
861
	mp := ParseModelPath(name)
862
863
	fn(api.ProgressResponse{Status: "retrieving manifest"})

864
865
866
867
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
868
	manifest, _, err := GetManifest(mp)
869
	if err != nil {
870
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
871
872
873
874
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
875
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
876
	layers = append(layers, manifest.Config)
877
878

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
879
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
880
			log.Printf("error uploading blob: %v", err)
881
882
883
			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())
			}
884
885
			return err
		}
886
887
	}

888
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
889
890
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
891
892
893
894
895
896

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

Michael Yang's avatar
Michael Yang committed
897
898
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
899
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
900
901
902
903
904
	if err != nil {
		return err
	}
	defer resp.Body.Close()

905
	fn(api.ProgressResponse{Status: "success"})
906
907
908
909

	return nil
}

910
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
911
912
	mp := ParseModelPath(name)

913
914
915
916
917
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
918
	deleteMap := make(map[string]struct{})
919
920
921
922
923
924
925
926
927

	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
928
				deleteMap[l.Digest] = struct{}{}
929
			}
Michael Yang's avatar
Michael Yang committed
930
			deleteMap[manifest.Config.Digest] = struct{}{}
931
932
933
		}
	}

934
935
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
936
	}
937

938
	fn(api.ProgressResponse{Status: "pulling manifest"})
939

940
	manifest, err = pullModelManifest(ctx, mp, regOpts)
941
	if err != nil {
942
		return fmt.Errorf("pull model manifest: %s", err)
943
944
945
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
946
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
947
	layers = append(layers, manifest.Config)
948
949

	for _, layer := range layers {
950
951
952
953
954
955
956
957
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
958
959
			return err
		}
960
		delete(deleteMap, layer.Digest)
961
	}
962
	delete(deleteMap, manifest.Config.Digest)
963

Michael Yang's avatar
Michael Yang committed
964
965
966
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
967
968
969
970
971
972
973
974
975
976
977
			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
978
979
980
981
			return err
		}
	}

982
	fn(api.ProgressResponse{Status: "writing manifest"})
983

984
	manifestJSON, err := json.Marshal(manifest)
985
986
987
988
	if err != nil {
		return err
	}

989
	fp, err := mp.GetManifestPath()
990
991
992
	if err != nil {
		return err
	}
993
994
995
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
996

Bruce MacDonald's avatar
Bruce MacDonald committed
997
	err = os.WriteFile(fp, manifestJSON, 0o644)
998
999
1000
1001
1002
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

1003
1004
1005
1006
1007
1008
1009
1010
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

1011
	fn(api.ProgressResponse{Status: "success"})
1012
1013
1014
1015

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
1019
1020
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
1021
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
	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
1036
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
1037
1038
1039
1040
1041
1042
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
1043
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1044
1045
}

1046
1047
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
1048
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
1049
1050
1051
1052
1053
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
1054

1055
1056
1057
1058
1059
1060
1061
1062
1063
		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
1064
1065
1066
		if err != nil {
			return nil, err
		}
1067
1068
1069
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1070
1071
1072
1073
			if err != nil {
				return nil, err
			}
		}
1074
1075
1076
1077
1078
1079
1080

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

		return resp, err
1081
1082
1083
1084
1085
1086
1087
1088
	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
1089
1090
	}

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

Michael Yang's avatar
Michael Yang committed
1094
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
1095
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1096
		requestURL.Scheme = "http"
1097
1098
	}

Michael Yang's avatar
Michael Yang committed
1099
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1100
1101
1102
1103
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1104
1105
1106
1107
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1108
1109
1110
1111
1112
1113
	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)
		}
1114
1115
	}

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

Michael Yang's avatar
Michael Yang committed
1118
1119
1120
1121
1122
1123
1124
1125
1126
	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
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
	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)
1139
1140
1141
1142
1143
1144
	if err != nil {
		return nil, err
	}

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

Patrick Devine's avatar
Patrick Devine committed
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
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"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
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 {
1195
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1196
1197
1198
1199
	}

	return nil
}