images.go 27.1 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
	ShortName      string
	ModelPath      string
	OriginalModel  string
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
49
	Size           int64
Michael Yang's avatar
Michael Yang committed
50
	Options        map[string]interface{}
51
52
}

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

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

68
69
70
71
72
	if p.System == "" {
		// use the default system prompt for this model if one is not specified
		p.System = m.System
	}

73
74
75
76
77
	vars := map[string]any{
		"System":   p.System,
		"Prompt":   p.Prompt,
		"Response": p.Response,
		"First":    p.First,
78
79
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
80
	var sb strings.Builder
81
	if err := tmpl.Execute(&sb, vars); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
82
83
84
85
86
87
		return "", err
	}
	prompt.WriteString(sb.String())
	prompt.WriteString(p.Response)
	return prompt.String(), nil
}
88

Bruce MacDonald's avatar
Bruce MacDonald committed
89
90
91
92
93
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
94
95
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
96
97
98
99
100
101
102
103
104
105
106
	writePrompt := func() error {
		p, err := m.Prompt(currentVars)
		if err != nil {
			return err
		}
		prompt.WriteString(p)
		currentVars = PromptVars{}
		return nil
	}

	for _, msg := range msgs {
107
		switch strings.ToLower(msg.Role) {
Bruce MacDonald's avatar
Bruce MacDonald committed
108
		case "system":
109
			if currentVars.System != "" {
Bruce MacDonald's avatar
Bruce MacDonald committed
110
111
112
113
114
115
				if err := writePrompt(); err != nil {
					return "", err
				}
			}
			currentVars.System = msg.Content
		case "user":
116
			if currentVars.Prompt != "" {
Bruce MacDonald's avatar
Bruce MacDonald committed
117
118
119
120
121
122
123
124
125
126
127
128
129
				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)
		}
130
131
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
132
133
134
135
136
137
138
139
	// 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
140
141
}

142
143
144
type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
145
	Config        *Layer   `json:"config"`
146
147
148
149
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
150
151
152
153
154
155
	ModelFormat   string   `json:"model_format"`
	ModelFamily   string   `json:"model_family"`
	ModelFamilies []string `json:"model_families"`
	ModelType     string   `json:"model_type"`
	FileType      string   `json:"file_type"`

156
	// required by spec
157
158
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
159
	RootFS       RootFS `json:"rootfs"`
160
161
}

Michael Yang's avatar
Michael Yang committed
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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
	}
}

192
193
194
195
196
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Michael Yang's avatar
Michael Yang committed
197
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
198
199
200
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
201

Patrick Devine's avatar
Patrick Devine committed
202
203
204
205
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
206
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
207
	fp, err := mp.GetManifestPath()
208
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
209
		return nil, "", err
210
	}
211

212
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
213
		return nil, "", err
214
215
216
217
	}

	var manifest *ManifestV2

218
	bts, err := os.ReadFile(fp)
219
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
220
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
221
222
	}

Patrick Devine's avatar
Patrick Devine committed
223
224
225
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

226
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
227
		return nil, "", err
228
229
	}

Patrick Devine's avatar
Patrick Devine committed
230
	return manifest, shaStr, nil
231
232
233
}

func GetModel(name string) (*Model, error) {
234
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
235
	manifest, digest, err := GetManifest(mp)
236
237
238
239
240
	if err != nil {
		return nil, err
	}

	model := &Model{
241
242
243
244
245
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
Patrick Devine's avatar
Patrick Devine committed
246
		Size:      manifest.GetTotalSize(),
247
248
	}

249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
	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
	}

264
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
265
		filename, err := GetBlobsPath(layer.Digest)
266
267
268
269
		if err != nil {
			return nil, err
		}

270
271
272
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
273
			model.OriginalModel = layer.From
274
		case "application/vnd.ollama.image.embed":
275
276
277
			// 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.")
278
279
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
280
281
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
282
283
284
285
286
287
288
289
290
		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)
291
292
293
			if err != nil {
				return nil, err
			}
294
295

			model.System = string(bts)
296
297
298
299
300
301
302
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
303
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
304
305
306
307
308
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
309

310
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
311
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
312
313
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
314
315
316
317
318
319
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
320
321
322
323
324
325
		}
	}

	return model, nil
}

326
327
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
328
	if err != nil {
329
		return from
330
331
	}

Michael Yang's avatar
Michael Yang committed
332
	home, err := os.UserHomeDir()
333
	if err != nil {
Michael Yang's avatar
Michael Yang committed
334
		return abspath
335
336
	}

337
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
338
		return home
339
340
341
342
343
344
345
	} 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)
346
347
	}

Michael Yang's avatar
Michael Yang committed
348
349
350
	return abspath
}

351
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
352
353
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
354
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
355
356
357
		RootFS: RootFS{
			Type: "layers",
		},
358
359
	}

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

Michael Yang's avatar
Michael Yang committed
362
	var layers Layers
Michael Yang's avatar
Michael Yang committed
363

364
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
365
366
	fromParams := make(map[string]any)

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

371
372
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
373
374
375
376
377
378
379
380
381
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

382
			bin, err := os.Open(realpath(modelFileDir, c.Args))
383
			if err != nil {
Michael Yang's avatar
Michael Yang committed
384
385
386
387
388
389
390
				// 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 {
391
392
393
						return err
					}

Michael Yang's avatar
Michael Yang committed
394
					manifest, _, err = GetManifest(modelpath)
395
396
397
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
398
399
				case err != nil:
					return err
400
				}
401

402
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
403
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
404
405
406
407
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
408
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
409
410
411
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
412
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
413

Michael Yang's avatar
Michael Yang committed
414
415
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
416
417
418
					return err
				}

Michael Yang's avatar
Michael Yang committed
419
420
421
422
				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
423

Michael Yang's avatar
Michael Yang committed
424
425
426
427
				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
428
429
430
431
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
432
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
433
434
435
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
436
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
437

Michael Yang's avatar
Michael Yang committed
438
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
439
440
441
442
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
443
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
444
445
446
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
447

Michael Yang's avatar
Michael Yang committed
448
					layers.Add(layer)
449
				}
Michael Yang's avatar
Michael Yang committed
450
451
452

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
453
			}
Michael Yang's avatar
Michael Yang committed
454
			defer bin.Close()
455

456
457
458
			var offset int64
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
459

460
461
462
463
464
465
466
				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
467

Michael Yang's avatar
Michael Yang committed
468
469
470
471
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
472

473
474
475
476
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
477

478
479
480
481
482
483
484
485
486
487
				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
488
		case "adapter":
489
490
491
492
493
494
495
496
			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
497

Michael Yang's avatar
Michael Yang committed
498
			fn(api.ProgressResponse{Status: "creating adapter layer"})
499
			bin, err := os.Open(realpath(modelFileDir, c.Args))
500
			if err != nil {
Michael Yang's avatar
Michael Yang committed
501
				return err
502
			}
Michael Yang's avatar
Michael Yang committed
503
			defer bin.Close()
504

Michael Yang's avatar
Michael Yang committed
505
			layer, err := NewLayer(bin, mediatype)
506
			if err != nil {
Michael Yang's avatar
Michael Yang committed
507
				return err
508
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
509

Michael Yang's avatar
Michael Yang committed
510
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
511
512
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
513
514
515

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
516
517
518
519
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
520
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
521
522
523
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
524
525
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
526
			if err != nil {
527
				return err
528
			}
529

Michael Yang's avatar
Michael Yang committed
530
			layers.Replace(layer)
531
		default:
532
			params[c.Name] = append(params[c.Name], c.Args)
533
534
535
		}
	}

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

539
		formattedParams, err := api.FormatParams(params)
540
		if err != nil {
Michael Yang's avatar
Michael Yang committed
541
			return err
542
		}
543

Michael Yang's avatar
Michael Yang committed
544
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
545
546
547
548
549
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Patrick Devine's avatar
Patrick Devine committed
550
		// xxx - can this be removed?
Michael Yang's avatar
Michael Yang committed
551
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
552
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
553
554
555
556
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
557
558
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
559
560
561
			return err
		}

Michael Yang's avatar
Michael Yang committed
562
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
563
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
564
		if err != nil {
Michael Yang's avatar
Michael Yang committed
565
			return err
566
		}
Michael Yang's avatar
Michael Yang committed
567

Michael Yang's avatar
Michael Yang committed
568
		layers.Replace(layer)
569
570
	}

Michael Yang's avatar
Michael Yang committed
571
572
573
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
574
575
	}

Michael Yang's avatar
Michael Yang committed
576
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
577

Michael Yang's avatar
Michael Yang committed
578
579
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
580
581
582
		return err
	}

Michael Yang's avatar
Michael Yang committed
583
584
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
585
586
587
		return err
	}

Michael Yang's avatar
Michael Yang committed
588
	delete(deleteMap, configLayer.Digest)
589

Michael Yang's avatar
Michael Yang committed
590
591
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
592
593
594
		if err != nil {
			return err
		}
595

Michael Yang's avatar
Michael Yang committed
596
597
598
		status := "writing layer"
		if !committed {
			status = "using already created layer"
599
600
		}

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

Michael Yang's avatar
Michael Yang committed
603
		delete(deleteMap, layer.Digest)
604
605
	}

Michael Yang's avatar
Michael Yang committed
606
607
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
608
609
		return err
	}
610

Michael Yang's avatar
Michael Yang committed
611
612
613
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
614
615
616
		}
	}

Michael Yang's avatar
Michael Yang committed
617
618
	fn(api.ProgressResponse{Status: "success"})
	return nil
619
620
}

Patrick Devine's avatar
Patrick Devine committed
621
func CopyModel(src, dest string) error {
622
	srcModelPath := ParseModelPath(src)
623
	srcPath, err := srcModelPath.GetManifestPath()
624
625
626
627
	if err != nil {
		return err
	}

628
	destModelPath := ParseModelPath(dest)
629
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
630
631
632
	if err != nil {
		return err
	}
633
634
635
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
636
637

	// copy the file
Michael Yang's avatar
Michael Yang committed
638
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
639
640
641
642
643
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
644
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
645
646
647
648
649
650
651
652
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
653
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
654
655
656
657
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
658
659
660
661

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

Michael Yang's avatar
Michael Yang committed
664
665
666
667
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
668

Michael Yang's avatar
Michael Yang committed
669
		// skip the manifest we're trying to delete
670
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
671
			return nil
672
		}
Michael Yang's avatar
Michael Yang committed
673
674
675
676
677
678
679
680
681
682
683
684

		// 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)
685
		return nil
Michael Yang's avatar
Michael Yang committed
686
687
688
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
689
690
		return err
	}
691
692

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
693
694
695
696
697
698
699
700
701
	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)
702
703
				continue
			}
Michael Yang's avatar
Michael Yang committed
704
705
		} else {
			log.Printf("wanted to remove: %s", fp)
706
707
708
		}
	}

709
710
711
712
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
713
	deleteMap := make(map[string]struct{})
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
	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
730
731
732
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
733
734
735
736
737
738
739
740
741
742
743
744
745
746
	}

	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
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
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
}

780
781
782
783
784
785
786
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
787
	deleteMap := make(map[string]struct{})
788
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
789
		deleteMap[layer.Digest] = struct{}{}
790
	}
Michael Yang's avatar
Michael Yang committed
791
	deleteMap[manifest.Config.Digest] = struct{}{}
792
793
794
795
796
797

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

798
	fp, err := mp.GetManifestPath()
799
800
801
802
803
804
805
806
807
808
809
810
	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
811
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
812
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
813
		*Model
Michael Yang's avatar
Michael Yang committed
814
		From       string
Michael Yang's avatar
Michael Yang committed
815
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
816
817
	}

Michael Yang's avatar
Michael Yang committed
818
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
819
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
820
821
822
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
823
824
		}

Michael Yang's avatar
Michael Yang committed
825
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
826
827
	}

Michael Yang's avatar
Michael Yang committed
828
829
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
830

Michael Yang's avatar
Michael Yang committed
831
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
832
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
833
834
835
836
837
838
839
840
	}

	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 }}"""
841
842

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
843
SYSTEM """{{ .System }}"""
844
{{- end }}
845
846
847
848

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

Michael Yang's avatar
Michael Yang committed
850
851
852
853
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
854
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871

	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
}

872
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
873
	mp := ParseModelPath(name)
874
875
	fn(api.ProgressResponse{Status: "retrieving manifest"})

876
877
878
879
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
880
	manifest, _, err := GetManifest(mp)
881
	if err != nil {
882
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
883
884
885
886
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
887
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
888
	layers = append(layers, manifest.Config)
889
890

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
891
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
892
			log.Printf("error uploading blob: %v", err)
893
894
895
			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())
			}
896
897
			return err
		}
898
899
	}

900
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
901
902
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
903
904
905
906
907
908

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

Michael Yang's avatar
Michael Yang committed
909
910
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
911
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
912
913
914
915
916
	if err != nil {
		return err
	}
	defer resp.Body.Close()

917
	fn(api.ProgressResponse{Status: "success"})
918
919
920
921

	return nil
}

922
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
923
924
	mp := ParseModelPath(name)

925
926
927
928
929
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
930
	deleteMap := make(map[string]struct{})
931
932
933
934
935
936
937
938
939

	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
940
				deleteMap[l.Digest] = struct{}{}
941
			}
Michael Yang's avatar
Michael Yang committed
942
			deleteMap[manifest.Config.Digest] = struct{}{}
943
944
945
		}
	}

946
947
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
948
	}
949

950
	fn(api.ProgressResponse{Status: "pulling manifest"})
951

952
	manifest, err = pullModelManifest(ctx, mp, regOpts)
953
	if err != nil {
954
		return fmt.Errorf("pull model manifest: %s", err)
955
956
957
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
958
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
959
	layers = append(layers, manifest.Config)
960
961

	for _, layer := range layers {
962
963
964
965
966
967
968
969
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
970
971
			return err
		}
972
		delete(deleteMap, layer.Digest)
973
	}
974
	delete(deleteMap, manifest.Config.Digest)
975

Michael Yang's avatar
Michael Yang committed
976
977
978
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
979
980
981
982
983
984
985
986
987
988
989
			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
990
991
992
993
			return err
		}
	}

994
	fn(api.ProgressResponse{Status: "writing manifest"})
995

996
	manifestJSON, err := json.Marshal(manifest)
997
998
999
1000
	if err != nil {
		return err
	}

1001
	fp, err := mp.GetManifestPath()
1002
1003
1004
	if err != nil {
		return err
	}
1005
1006
1007
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
1008

Bruce MacDonald's avatar
Bruce MacDonald committed
1009
	err = os.WriteFile(fp, manifestJSON, 0o644)
1010
1011
1012
1013
1014
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

1015
1016
1017
1018
1019
1020
1021
1022
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

1023
	fn(api.ProgressResponse{Status: "success"})
1024
1025
1026
1027

	return nil
}

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

Michael Yang's avatar
Michael Yang committed
1031
1032
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
1033
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
	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
1048
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
1049
1050
1051
1052
1053
1054
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
1055
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1056
1057
}

1058
1059
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
1060
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
1061
1062
1063
1064
1065
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
1066

1067
1068
1069
1070
1071
1072
1073
1074
1075
		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
1076
1077
1078
		if err != nil {
			return nil, err
		}
1079
1080
1081
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1082
1083
1084
1085
			if err != nil {
				return nil, err
			}
		}
1086
1087
1088
1089
1090
1091
1092

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

		return resp, err
1093
1094
1095
1096
1097
1098
1099
1100
	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
1101
1102
	}

1103
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1104
1105
}

Michael Yang's avatar
Michael Yang committed
1106
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
1107
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1108
		requestURL.Scheme = "http"
1109
1110
	}

Michael Yang's avatar
Michael Yang committed
1111
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1112
1113
1114
1115
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1116
1117
1118
1119
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1120
1121
1122
1123
1124
1125
	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)
		}
1126
1127
	}

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

Michael Yang's avatar
Michael Yang committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
	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
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
	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)
1151
1152
1153
1154
1155
1156
	if err != nil {
		return nil, err
	}

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

Patrick Devine's avatar
Patrick Devine committed
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
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"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
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 {
1207
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1208
1209
1210
1211
	}

	return nil
}