"vscode:/vscode.git/clone" did not exist on "44463b94989bfe3f3849ed29629576abd53a9976"
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
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
13
	"log/slog"
14
	"net/http"
Michael Yang's avatar
Michael Yang committed
15
	"net/url"
16
17
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
18
	"runtime"
Michael Yang's avatar
Michael Yang committed
19
	"strconv"
20
	"strings"
Quinn Slack's avatar
Quinn Slack committed
21
	"text/template"
22

Michael Yang's avatar
Michael Yang committed
23
24
	"golang.org/x/exp/slices"

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

Michael Yang's avatar
Michael Yang committed
31
32
33
34
35
36
37
type registryOptions struct {
	Insecure bool
	Username string
	Password string
	Token    string
}

38
type Model struct {
Michael Yang's avatar
Michael Yang committed
39
	Name           string `json:"name"`
40
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
41
42
	ShortName      string
	ModelPath      string
43
	ParentModel    string
Michael Yang's avatar
Michael Yang committed
44
45
46
47
48
49
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
50
	Size           int64
Michael Yang's avatar
Michael Yang committed
51
	Options        map[string]interface{}
52
53
54
	Messages       []Message
}

55
56
57
58
func (m *Model) IsEmbedding() bool {
	return slices.Contains(m.Config.ModelFamilies, "bert") || slices.Contains(m.Config.ModelFamilies, "nomic-bert")
}

59
60
61
type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
62
63
64
65
66
}

type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
67
	Config        *Layer   `json:"config"`
68
69
70
71
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
72
73
74
75
76
77
	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"`

78
	// required by spec
79
80
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
81
	RootFS       RootFS `json:"rootfs"`
82
83
}

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

114
115
116
117
118
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Michael Yang's avatar
Michael Yang committed
119
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
120
121
122
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
123

Patrick Devine's avatar
Patrick Devine committed
124
125
126
127
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
128
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
129
	fp, err := mp.GetManifestPath()
130
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
131
		return nil, "", err
132
	}
133

134
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
135
		return nil, "", err
136
137
138
139
	}

	var manifest *ManifestV2

140
	bts, err := os.ReadFile(fp)
141
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
142
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
143
144
	}

Patrick Devine's avatar
Patrick Devine committed
145
146
147
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

148
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
149
		return nil, "", err
150
151
	}

Patrick Devine's avatar
Patrick Devine committed
152
	return manifest, shaStr, nil
153
154
155
}

func GetModel(name string) (*Model, error) {
156
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
157
	manifest, digest, err := GetManifest(mp)
158
159
160
161
162
	if err != nil {
		return nil, err
	}

	model := &Model{
163
164
165
166
167
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
Patrick Devine's avatar
Patrick Devine committed
168
		Size:      manifest.GetTotalSize(),
169
170
	}

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
	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
	}

186
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
187
		filename, err := GetBlobsPath(layer.Digest)
188
189
190
191
		if err != nil {
			return nil, err
		}

192
193
194
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
195
			model.ParentModel = layer.From
196
		case "application/vnd.ollama.image.embed":
197
198
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
199
			slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
200
201
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
202
203
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
204
205
206
207
208
209
210
211
212
		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)
213
214
215
			if err != nil {
				return nil, err
			}
216
217

			model.System = string(bts)
218
219
220
221
222
223
224
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
225
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
226
227
228
229
230
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
231

232
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
233
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
234
235
				return nil, err
			}
236
237
238
239
240
241
242
243
244
245
		case "application/vnd.ollama.image.messages":
			msgs, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer msgs.Close()

			if err = json.NewDecoder(msgs).Decode(&model.Messages); err != nil {
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
246
247
248
249
250
251
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
252
253
254
255
256
257
		}
	}

	return model, nil
}

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

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

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

Michael Yang's avatar
Michael Yang committed
280
281
282
	return abspath
}

283
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
284
285
286
287
288
289
290
	deleteMap := make(map[string]struct{})
	if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
		for _, layer := range append(manifest.Layers, manifest.Config) {
			deleteMap[layer.Digest] = struct{}{}
		}
	}

291
292
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
293
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
294
295
296
		RootFS: RootFS{
			Type: "layers",
		},
297
298
	}

Michael Yang's avatar
Michael Yang committed
299
	var layers Layers
300
	messages := []string{}
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
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

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

				c.Args = blobPath
			}

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

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

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

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
356
357
358
359
360
				// if the model is still not in gguf format, error out
				if fromConfig.ModelFormat != "gguf" {
					return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
				}

Michael Yang's avatar
Michael Yang committed
361
362
363
364
				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
365

Michael Yang's avatar
Michael Yang committed
366
367
368
369
				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
370
371
372
373
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
374
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
375
376
377
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
378
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
379

Michael Yang's avatar
Michael Yang committed
380
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
381
382
383
384
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
385
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
386
387
388
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
389

Michael Yang's avatar
Michael Yang committed
390
					layers.Add(layer)
391
				}
Michael Yang's avatar
Michael Yang committed
392
393
394

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
395
			}
Michael Yang's avatar
Michael Yang committed
396
			defer bin.Close()
397

398
			var offset int64
Bruce MacDonald's avatar
Bruce MacDonald committed
399
		CREATE:
400
401
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
402

403
404
				bin.Seek(offset, io.SeekStart)
				ggml, err := llm.DecodeGGML(bin)
Bruce MacDonald's avatar
Bruce MacDonald committed
405
406
407
408
409
410
411
412
413
				if err != nil {
					switch {
					case errors.Is(err, io.EOF):
						break CREATE
					case errors.Is(err, llm.ErrUnsupportedFormat):
						return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
					default:
						return err
					}
414
				}
Michael Yang's avatar
Michael Yang committed
415

Michael Yang's avatar
Michael Yang committed
416
417
418
419
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
420

421
422
423
424
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
425

426
427
428
429
430
431
432
433
434
435
				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
436
		case "adapter":
437
438
439
440
441
442
443
444
			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
445

Michael Yang's avatar
Michael Yang committed
446
			fn(api.ProgressResponse{Status: "creating adapter layer"})
447
			bin, err := os.Open(realpath(modelFileDir, c.Args))
448
			if err != nil {
Michael Yang's avatar
Michael Yang committed
449
				return err
450
			}
Michael Yang's avatar
Michael Yang committed
451
			defer bin.Close()
452

Michael Yang's avatar
Michael Yang committed
453
			layer, err := NewLayer(bin, mediatype)
454
			if err != nil {
Michael Yang's avatar
Michael Yang committed
455
				return err
456
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
457

Michael Yang's avatar
Michael Yang committed
458
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
459
460
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
461
462
463

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
464
465
466
467
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
468
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
469
470
471
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
472
473
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
474
			if err != nil {
475
				return err
476
			}
477

Michael Yang's avatar
Michael Yang committed
478
			layers.Replace(layer)
479
480
		case "message":
			messages = append(messages, c.Args)
481
		default:
482
			params[c.Name] = append(params[c.Name], c.Args)
483
484
485
		}
	}

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
	if len(messages) > 0 {
		fn(api.ProgressResponse{Status: "creating parameters layer"})

		msgs := make([]api.Message, 0)

		for _, m := range messages {
			// todo: handle images
			msg := strings.SplitN(m, ": ", 2)
			msgs = append(msgs, api.Message{Role: msg[0], Content: msg[1]})
		}

		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(msgs); err != nil {
			return err
		}

		layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
		if err != nil {
			return err
		}

		layers.Replace(layer)
	}

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

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

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

Patrick Devine's avatar
Patrick Devine committed
524
		// xxx - can this be removed?
Michael Yang's avatar
Michael Yang committed
525
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
526
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
527
528
529
530
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
531
532
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
533
534
535
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
542
		layers.Replace(layer)
543
544
	}

Michael Yang's avatar
Michael Yang committed
545
546
547
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
548
549
	}

Michael Yang's avatar
Michael Yang committed
550
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
551

Michael Yang's avatar
Michael Yang committed
552
553
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
554
555
556
		return err
	}

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

Michael Yang's avatar
Michael Yang committed
562
	delete(deleteMap, configLayer.Digest)
563

Michael Yang's avatar
Michael Yang committed
564
565
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
566
567
568
		if err != nil {
			return err
		}
569

Michael Yang's avatar
Michael Yang committed
570
571
572
		status := "writing layer"
		if !committed {
			status = "using already created layer"
573
574
		}

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

Michael Yang's avatar
Michael Yang committed
577
		delete(deleteMap, layer.Digest)
578
579
	}

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

Michael Yang's avatar
Michael Yang committed
585
586
587
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
588
589
590
		}
	}

Michael Yang's avatar
Michael Yang committed
591
592
	fn(api.ProgressResponse{Status: "success"})
	return nil
593
594
}

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

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

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

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

	return nil
}

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

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

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

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

		// save (i.e. delete from the deleteMap) any files used in other manifests
		manifest, _, err := GetManifest(fmp)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
651
			// nolint: nilerr
Michael Yang's avatar
Michael Yang committed
652
653
654
655
656
657
658
659
			return nil
		}

		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
660
		return nil
Michael Yang's avatar
Michael Yang committed
661
662
663
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
664
665
		return err
	}
666
667

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
668
669
670
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
671
			slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
Michael Yang's avatar
Michael Yang committed
672
673
674
675
			continue
		}
		if !dryRun {
			if err := os.Remove(fp); err != nil {
676
				slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
677
678
				continue
			}
Michael Yang's avatar
Michael Yang committed
679
		} else {
680
			slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
681
682
683
		}
	}

684
685
686
687
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
688
	deleteMap := make(map[string]struct{})
689
690
691
692
693
694
695
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
696
		slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
697
698
699
700
701
702
703
704
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
		if runtime.GOOS == "windows" {
			name = strings.ReplaceAll(name, "-", ":")
		}
Michael Yang's avatar
Michael Yang committed
705
706
707
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
708
709
	}

710
	slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
711
712
713
714
715
716

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

717
	slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
718
719
720
721

	return nil
}

Michael Yang's avatar
Michael Yang committed
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
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
}

755
756
757
758
759
760
761
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
762
	deleteMap := make(map[string]struct{})
763
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
764
		deleteMap[layer.Digest] = struct{}{}
765
	}
Michael Yang's avatar
Michael Yang committed
766
	deleteMap[manifest.Config.Digest] = struct{}{}
767
768
769
770
771
772

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

773
	fp, err := mp.GetManifestPath()
774
775
776
777
778
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
779
		slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
780
781
782
783
784
785
		return err
	}

	return nil
}

Patrick Devine's avatar
Patrick Devine committed
786
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
787
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
788
		*Model
Michael Yang's avatar
Michael Yang committed
789
		From       string
Michael Yang's avatar
Michael Yang committed
790
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
791
792
	}

Michael Yang's avatar
Michael Yang committed
793
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
794
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
795
796
797
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
798
799
		}

Michael Yang's avatar
Michael Yang committed
800
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
801
802
	}

Michael Yang's avatar
Michael Yang committed
803
804
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
805

806
807
	if model.ParentModel != "" {
		mt.From = model.ParentModel
Patrick Devine's avatar
Patrick Devine committed
808
809
810
811
812
813
814
815
	}

	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 }}"""
816
817

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
818
SYSTEM """{{ .System }}"""
819
{{- end }}
820
821
822
823

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

Michael Yang's avatar
Michael Yang committed
825
826
827
828
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
829
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
830
831
832

	tmpl, err := template.New("").Parse(modelFile)
	if err != nil {
833
		slog.Info(fmt.Sprintf("error parsing template: %q", err))
Patrick Devine's avatar
Patrick Devine committed
834
835
836
837
838
839
		return "", err
	}

	var buf bytes.Buffer

	if err = tmpl.Execute(&buf, mt); err != nil {
840
		slog.Info(fmt.Sprintf("error executing template: %q", err))
Patrick Devine's avatar
Patrick Devine committed
841
842
843
844
845
846
		return "", err
	}

	return buf.String(), nil
}

Michael Yang's avatar
Michael Yang committed
847
func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
848
	mp := ParseModelPath(name)
849
850
	fn(api.ProgressResponse{Status: "retrieving manifest"})

851
852
853
854
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
855
	manifest, _, err := GetManifest(mp)
856
	if err != nil {
857
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
858
859
860
861
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
862
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
863
	layers = append(layers, manifest.Config)
864
865

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
866
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
867
			slog.Info(fmt.Sprintf("error uploading blob: %v", err))
868
869
870
			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())
			}
871
872
			return err
		}
873
874
	}

875
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
876
877
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
878
879
880
881
882
883

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

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

892
	fn(api.ProgressResponse{Status: "success"})
893
894
895
896

	return nil
}

Michael Yang's avatar
Michael Yang committed
897
func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
898
899
	mp := ParseModelPath(name)

900
901
902
903
904
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
905
	deleteMap := make(map[string]struct{})
906
907
908
909
910
911
912
913
914

	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
915
				deleteMap[l.Digest] = struct{}{}
916
			}
Michael Yang's avatar
Michael Yang committed
917
			deleteMap[manifest.Config.Digest] = struct{}{}
918
919
920
		}
	}

921
922
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
923
	}
924

925
	fn(api.ProgressResponse{Status: "pulling manifest"})
926

927
	manifest, err = pullModelManifest(ctx, mp, regOpts)
928
	if err != nil {
929
		return fmt.Errorf("pull model manifest: %s", err)
930
931
932
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
933
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
934
	layers = append(layers, manifest.Config)
935
936

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

Michael Yang's avatar
Michael Yang committed
951
952
953
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
954
955
956
957
958
959
960
961
			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
962
					slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
963
964
				}
			}
Michael Yang's avatar
Michael Yang committed
965
966
967
968
			return err
		}
	}

969
	fn(api.ProgressResponse{Status: "writing manifest"})
970

971
	manifestJSON, err := json.Marshal(manifest)
972
973
974
975
	if err != nil {
		return err
	}

976
	fp, err := mp.GetManifestPath()
977
978
979
	if err != nil {
		return err
	}
980
981
982
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
983

Bruce MacDonald's avatar
Bruce MacDonald committed
984
	err = os.WriteFile(fp, manifestJSON, 0o644)
985
	if err != nil {
986
		slog.Info(fmt.Sprintf("couldn't write to %s", fp))
987
988
989
		return err
	}

990
991
992
993
994
995
996
997
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

998
	fn(api.ProgressResponse{Status: "success"})
999
1000
1001
1002

	return nil
}

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

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

Michael Yang's avatar
Michael Yang committed
1030
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1031
1032
}

1033
1034
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
1035
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
Michael Yang's avatar
Michael Yang committed
1036
	for i := 0; i < 2; i++ {
Michael Yang's avatar
Michael Yang committed
1037
		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
Michael Yang's avatar
Michael Yang committed
1038
		if err != nil {
Michael Yang's avatar
Michael Yang committed
1039
			if !errors.Is(err, context.Canceled) {
1040
				slog.Info(fmt.Sprintf("request failed: %v", err))
Michael Yang's avatar
Michael Yang committed
1041
1042
			}

Michael Yang's avatar
Michael Yang committed
1043
1044
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
1045
1046
1047
1048

		switch {
		case resp.StatusCode == http.StatusUnauthorized:
			// Handle authentication error with one retry
Michael Yang's avatar
Michael Yang committed
1049
1050
			challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
			token, err := getAuthorizationToken(ctx, challenge)
Michael Yang's avatar
Michael Yang committed
1051
1052
1053
			if err != nil {
				return nil, err
			}
Michael Yang's avatar
Michael Yang committed
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
			regOpts.Token = token
			if body != nil {
				_, err = body.Seek(0, io.SeekStart)
				if err != nil {
					return nil, err
				}
			}
		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)
		default:
			return resp, nil
Michael Yang's avatar
Michael Yang committed
1071
1072
1073
		}
	}

Michael Yang's avatar
Michael Yang committed
1074
	return nil, errUnauthorized
Michael Yang's avatar
Michael Yang committed
1075
1076
}

Michael Yang's avatar
Michael Yang committed
1077
1078
1079
1080
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
func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
		requestURL.Scheme = "http"
	}

	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
	if err != nil {
		return nil, err
	}

	if headers != nil {
		req.Header = headers
	}

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

	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))

	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
1110
	resp, err := http.DefaultClient.Do(req)
Michael Yang's avatar
Michael Yang committed
1111
1112
1113
1114
1115
1116
1117
	if err != nil {
		return nil, err
	}

	return resp, nil
}

Patrick Devine's avatar
Patrick Devine committed
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
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]
}

Michael Yang's avatar
Michael Yang committed
1141
func parseRegistryChallenge(authStr string) registryChallenge {
Patrick Devine's avatar
Patrick Devine committed
1142
1143
	authStr = strings.TrimPrefix(authStr, "Bearer ")

Michael Yang's avatar
Michael Yang committed
1144
	return registryChallenge{
Patrick Devine's avatar
Patrick Devine committed
1145
1146
1147
1148
1149
1150
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

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

Michael Yang's avatar
Michael Yang committed
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
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 {
1167
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1168
1169
1170
1171
	}

	return nil
}