images.go 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254
  1. package server
  2. import (
  3. "archive/zip"
  4. "bytes"
  5. "context"
  6. "crypto/sha256"
  7. "encoding/hex"
  8. "encoding/json"
  9. "errors"
  10. "fmt"
  11. "io"
  12. "io/fs"
  13. "log"
  14. "log/slog"
  15. "net/http"
  16. "net/url"
  17. "os"
  18. "path/filepath"
  19. "runtime"
  20. "strconv"
  21. "strings"
  22. "text/template"
  23. "golang.org/x/exp/slices"
  24. "github.com/ollama/ollama/api"
  25. "github.com/ollama/ollama/convert"
  26. "github.com/ollama/ollama/format"
  27. "github.com/ollama/ollama/llm"
  28. "github.com/ollama/ollama/parser"
  29. "github.com/ollama/ollama/version"
  30. )
  31. type registryOptions struct {
  32. Insecure bool
  33. Username string
  34. Password string
  35. Token string
  36. }
  37. type Model struct {
  38. Name string `json:"name"`
  39. Config ConfigV2
  40. ShortName string
  41. ModelPath string
  42. ParentModel string
  43. AdapterPaths []string
  44. ProjectorPaths []string
  45. Template string
  46. System string
  47. License []string
  48. Digest string
  49. Size int64
  50. Options map[string]interface{}
  51. Messages []Message
  52. }
  53. func (m *Model) IsEmbedding() bool {
  54. return slices.Contains(m.Config.ModelFamilies, "bert") || slices.Contains(m.Config.ModelFamilies, "nomic-bert")
  55. }
  56. type Message struct {
  57. Role string `json:"role"`
  58. Content string `json:"content"`
  59. }
  60. type ManifestV2 struct {
  61. SchemaVersion int `json:"schemaVersion"`
  62. MediaType string `json:"mediaType"`
  63. Config *Layer `json:"config"`
  64. Layers []*Layer `json:"layers"`
  65. }
  66. type ConfigV2 struct {
  67. ModelFormat string `json:"model_format"`
  68. ModelFamily string `json:"model_family"`
  69. ModelFamilies []string `json:"model_families"`
  70. ModelType string `json:"model_type"`
  71. FileType string `json:"file_type"`
  72. // required by spec
  73. Architecture string `json:"architecture"`
  74. OS string `json:"os"`
  75. RootFS RootFS `json:"rootfs"`
  76. }
  77. func (c *ConfigV2) SetModelFormat(format string) {
  78. if c.ModelFormat == "" {
  79. c.ModelFormat = format
  80. }
  81. }
  82. func (c *ConfigV2) SetModelFamily(families ...string) {
  83. for _, family := range families {
  84. if c.ModelFamily == "" {
  85. c.ModelFamily = family
  86. }
  87. if !slices.Contains(c.ModelFamilies, family) {
  88. c.ModelFamilies = append(c.ModelFamilies, family)
  89. }
  90. }
  91. }
  92. func (c *ConfigV2) SetModelType(modelType string) {
  93. if c.ModelType == "" {
  94. c.ModelType = modelType
  95. }
  96. }
  97. func (c *ConfigV2) SetFileType(fileType string) {
  98. if c.FileType == "" {
  99. c.FileType = fileType
  100. }
  101. }
  102. type RootFS struct {
  103. Type string `json:"type"`
  104. DiffIDs []string `json:"diff_ids"`
  105. }
  106. func (m *ManifestV2) GetTotalSize() (total int64) {
  107. for _, layer := range m.Layers {
  108. total += layer.Size
  109. }
  110. total += m.Config.Size
  111. return total
  112. }
  113. func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
  114. fp, err := mp.GetManifestPath()
  115. if err != nil {
  116. return nil, "", err
  117. }
  118. if _, err = os.Stat(fp); err != nil {
  119. return nil, "", err
  120. }
  121. var manifest *ManifestV2
  122. bts, err := os.ReadFile(fp)
  123. if err != nil {
  124. return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
  125. }
  126. shaSum := sha256.Sum256(bts)
  127. shaStr := hex.EncodeToString(shaSum[:])
  128. if err := json.Unmarshal(bts, &manifest); err != nil {
  129. return nil, "", err
  130. }
  131. return manifest, shaStr, nil
  132. }
  133. func GetModel(name string) (*Model, error) {
  134. mp := ParseModelPath(name)
  135. manifest, digest, err := GetManifest(mp)
  136. if err != nil {
  137. return nil, err
  138. }
  139. model := &Model{
  140. Name: mp.GetFullTagname(),
  141. ShortName: mp.GetShortTagname(),
  142. Digest: digest,
  143. Template: "{{ .Prompt }}",
  144. License: []string{},
  145. Size: manifest.GetTotalSize(),
  146. }
  147. filename, err := GetBlobsPath(manifest.Config.Digest)
  148. if err != nil {
  149. return nil, err
  150. }
  151. configFile, err := os.Open(filename)
  152. if err != nil {
  153. return nil, err
  154. }
  155. defer configFile.Close()
  156. if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
  157. return nil, err
  158. }
  159. for _, layer := range manifest.Layers {
  160. filename, err := GetBlobsPath(layer.Digest)
  161. if err != nil {
  162. return nil, err
  163. }
  164. switch layer.MediaType {
  165. case "application/vnd.ollama.image.model":
  166. model.ModelPath = filename
  167. model.ParentModel = layer.From
  168. case "application/vnd.ollama.image.embed":
  169. // Deprecated in versions > 0.1.2
  170. // TODO: remove this warning in a future version
  171. slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
  172. case "application/vnd.ollama.image.adapter":
  173. model.AdapterPaths = append(model.AdapterPaths, filename)
  174. case "application/vnd.ollama.image.projector":
  175. model.ProjectorPaths = append(model.ProjectorPaths, filename)
  176. case "application/vnd.ollama.image.template":
  177. bts, err := os.ReadFile(filename)
  178. if err != nil {
  179. return nil, err
  180. }
  181. model.Template = string(bts)
  182. case "application/vnd.ollama.image.system":
  183. bts, err := os.ReadFile(filename)
  184. if err != nil {
  185. return nil, err
  186. }
  187. model.System = string(bts)
  188. case "application/vnd.ollama.image.prompt":
  189. bts, err := os.ReadFile(filename)
  190. if err != nil {
  191. return nil, err
  192. }
  193. model.Template = string(bts)
  194. case "application/vnd.ollama.image.params":
  195. params, err := os.Open(filename)
  196. if err != nil {
  197. return nil, err
  198. }
  199. defer params.Close()
  200. // parse model options parameters into a map so that we can see which fields have been specified explicitly
  201. if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
  202. return nil, err
  203. }
  204. case "application/vnd.ollama.image.messages":
  205. msgs, err := os.Open(filename)
  206. if err != nil {
  207. return nil, err
  208. }
  209. defer msgs.Close()
  210. if err = json.NewDecoder(msgs).Decode(&model.Messages); err != nil {
  211. return nil, err
  212. }
  213. case "application/vnd.ollama.image.license":
  214. bts, err := os.ReadFile(filename)
  215. if err != nil {
  216. return nil, err
  217. }
  218. model.License = append(model.License, string(bts))
  219. }
  220. }
  221. return model, nil
  222. }
  223. func realpath(mfDir, from string) string {
  224. abspath, err := filepath.Abs(from)
  225. if err != nil {
  226. return from
  227. }
  228. home, err := os.UserHomeDir()
  229. if err != nil {
  230. return abspath
  231. }
  232. if from == "~" {
  233. return home
  234. } else if strings.HasPrefix(from, "~/") {
  235. return filepath.Join(home, from[2:])
  236. }
  237. if _, err := os.Stat(filepath.Join(mfDir, from)); err == nil {
  238. // this is a file relative to the Modelfile
  239. return filepath.Join(mfDir, from)
  240. }
  241. return abspath
  242. }
  243. func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
  244. deleteMap := make(map[string]struct{})
  245. if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
  246. for _, layer := range append(manifest.Layers, manifest.Config) {
  247. deleteMap[layer.Digest] = struct{}{}
  248. }
  249. }
  250. config := ConfigV2{
  251. OS: "linux",
  252. Architecture: "amd64",
  253. RootFS: RootFS{
  254. Type: "layers",
  255. },
  256. }
  257. var layers Layers
  258. messages := []string{}
  259. params := make(map[string][]string)
  260. fromParams := make(map[string]any)
  261. for _, c := range commands {
  262. mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
  263. switch c.Name {
  264. case "model":
  265. if strings.HasPrefix(c.Args, "@") {
  266. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  267. if err != nil {
  268. return err
  269. }
  270. c.Args = blobPath
  271. }
  272. pathName := realpath(modelFileDir, c.Args)
  273. ggufName, err := convertSafetensors(name, pathName, fn)
  274. if err != nil {
  275. var pathErr *fs.PathError
  276. switch {
  277. case errors.Is(err, zip.ErrFormat):
  278. // it's not a safetensor archive
  279. case errors.As(err, &pathErr):
  280. // it's not a file on disk, could be a model reference
  281. default:
  282. return err
  283. }
  284. }
  285. if ggufName != "" {
  286. pathName = ggufName
  287. slog.Debug(fmt.Sprintf("new image layer path: %s", pathName))
  288. defer os.RemoveAll(ggufName)
  289. }
  290. bin, err := os.Open(pathName)
  291. if err != nil {
  292. // not a file on disk so must be a model reference
  293. modelpath := ParseModelPath(c.Args)
  294. manifest, _, err := GetManifest(modelpath)
  295. switch {
  296. case errors.Is(err, os.ErrNotExist):
  297. fn(api.ProgressResponse{Status: "pulling model"})
  298. if err := PullModel(ctx, c.Args, &registryOptions{}, fn); err != nil {
  299. return err
  300. }
  301. manifest, _, err = GetManifest(modelpath)
  302. if err != nil {
  303. return err
  304. }
  305. case err != nil:
  306. return err
  307. }
  308. fn(api.ProgressResponse{Status: "reading model metadata"})
  309. fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
  310. if err != nil {
  311. return err
  312. }
  313. fromConfigFile, err := os.Open(fromConfigPath)
  314. if err != nil {
  315. return err
  316. }
  317. defer fromConfigFile.Close()
  318. var fromConfig ConfigV2
  319. if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
  320. return err
  321. }
  322. // if the model is still not in gguf format, error out
  323. if fromConfig.ModelFormat != "gguf" {
  324. return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
  325. }
  326. config.SetModelFormat(fromConfig.ModelFormat)
  327. config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
  328. config.SetModelType(fromConfig.ModelType)
  329. config.SetFileType(fromConfig.FileType)
  330. for _, layer := range manifest.Layers {
  331. deleteMap[layer.Digest] = struct{}{}
  332. if layer.MediaType == "application/vnd.ollama.image.params" {
  333. fromParamsPath, err := GetBlobsPath(layer.Digest)
  334. if err != nil {
  335. return err
  336. }
  337. fromParamsFile, err := os.Open(fromParamsPath)
  338. if err != nil {
  339. return err
  340. }
  341. defer fromParamsFile.Close()
  342. if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
  343. return err
  344. }
  345. }
  346. layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
  347. if err != nil {
  348. return err
  349. }
  350. layers.Add(layer)
  351. }
  352. deleteMap[manifest.Config.Digest] = struct{}{}
  353. continue
  354. }
  355. defer bin.Close()
  356. var offset int64
  357. for {
  358. fn(api.ProgressResponse{Status: "creating model layer"})
  359. if _, err := bin.Seek(offset, io.SeekStart); err != nil {
  360. return err
  361. }
  362. ggml, size, err := llm.DecodeGGML(bin)
  363. if errors.Is(err, io.EOF) {
  364. break
  365. } else if errors.Is(err, llm.ErrUnsupportedFormat) {
  366. return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
  367. } else if err != nil {
  368. return err
  369. }
  370. config.SetModelFormat(ggml.Name())
  371. config.SetModelFamily(ggml.KV().Architecture())
  372. config.SetModelType(format.HumanNumber(ggml.KV().ParameterCount()))
  373. config.SetFileType(ggml.KV().FileType())
  374. mediatype := mediatype
  375. if ggml.KV().Architecture() == "clip" {
  376. mediatype = "application/vnd.ollama.image.projector"
  377. }
  378. sr := io.NewSectionReader(bin, offset, size)
  379. layer, err := NewLayer(sr, mediatype)
  380. if err != nil {
  381. return err
  382. }
  383. layers.Add(layer)
  384. offset += size
  385. }
  386. case "adapter":
  387. if strings.HasPrefix(c.Args, "@") {
  388. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  389. if err != nil {
  390. return err
  391. }
  392. c.Args = blobPath
  393. }
  394. fn(api.ProgressResponse{Status: "creating adapter layer"})
  395. bin, err := os.Open(realpath(modelFileDir, c.Args))
  396. if err != nil {
  397. return err
  398. }
  399. defer bin.Close()
  400. _, size, err := llm.DecodeGGML(bin)
  401. if err != nil {
  402. return err
  403. }
  404. sr := io.NewSectionReader(bin, 0, size)
  405. layer, err := NewLayer(sr, mediatype)
  406. if err != nil {
  407. return err
  408. }
  409. layers.Add(layer)
  410. case "license":
  411. fn(api.ProgressResponse{Status: "creating license layer"})
  412. bin := strings.NewReader(c.Args)
  413. layer, err := NewLayer(bin, mediatype)
  414. if err != nil {
  415. return err
  416. }
  417. layers.Add(layer)
  418. case "template", "system":
  419. fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})
  420. bin := strings.NewReader(c.Args)
  421. layer, err := NewLayer(bin, mediatype)
  422. if err != nil {
  423. return err
  424. }
  425. layers.Replace(layer)
  426. case "message":
  427. messages = append(messages, c.Args)
  428. default:
  429. params[c.Name] = append(params[c.Name], c.Args)
  430. }
  431. }
  432. if len(messages) > 0 {
  433. fn(api.ProgressResponse{Status: "creating parameters layer"})
  434. msgs := make([]api.Message, 0)
  435. for _, m := range messages {
  436. // todo: handle images
  437. msg := strings.SplitN(m, ": ", 2)
  438. msgs = append(msgs, api.Message{Role: msg[0], Content: msg[1]})
  439. }
  440. var b bytes.Buffer
  441. if err := json.NewEncoder(&b).Encode(msgs); err != nil {
  442. return err
  443. }
  444. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  445. if err != nil {
  446. return err
  447. }
  448. layers.Replace(layer)
  449. }
  450. if len(params) > 0 {
  451. fn(api.ProgressResponse{Status: "creating parameters layer"})
  452. formattedParams, err := api.FormatParams(params)
  453. if err != nil {
  454. return err
  455. }
  456. for k, v := range fromParams {
  457. if _, ok := formattedParams[k]; !ok {
  458. formattedParams[k] = v
  459. }
  460. }
  461. var b bytes.Buffer
  462. if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
  463. return err
  464. }
  465. fn(api.ProgressResponse{Status: "creating config layer"})
  466. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  467. if err != nil {
  468. return err
  469. }
  470. layers.Replace(layer)
  471. }
  472. digests := make([]string, len(layers.items))
  473. for i, layer := range layers.items {
  474. digests[i] = layer.Digest
  475. }
  476. config.RootFS.DiffIDs = digests
  477. var b bytes.Buffer
  478. if err := json.NewEncoder(&b).Encode(config); err != nil {
  479. return err
  480. }
  481. configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  482. if err != nil {
  483. return err
  484. }
  485. delete(deleteMap, configLayer.Digest)
  486. for _, layer := range append(layers.items, configLayer) {
  487. committed, err := layer.Commit()
  488. if err != nil {
  489. return err
  490. }
  491. status := "writing layer"
  492. if !committed {
  493. status = "using already created layer"
  494. }
  495. fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
  496. delete(deleteMap, layer.Digest)
  497. }
  498. fn(api.ProgressResponse{Status: "writing manifest"})
  499. if err := WriteManifest(name, configLayer, layers.items); err != nil {
  500. return err
  501. }
  502. if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  503. if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
  504. return err
  505. }
  506. }
  507. fn(api.ProgressResponse{Status: "success"})
  508. return nil
  509. }
  510. func convertSafetensors(name, path string, fn func(resp api.ProgressResponse)) (string, error) {
  511. r, err := zip.OpenReader(path)
  512. if err != nil {
  513. return "", err
  514. }
  515. defer r.Close()
  516. tempDir, err := os.MkdirTemp("", "ollama-convert")
  517. if err != nil {
  518. return "", err
  519. }
  520. defer os.RemoveAll(tempDir)
  521. fn(api.ProgressResponse{Status: "unpacking model metadata"})
  522. for _, f := range r.File {
  523. fpath := filepath.Join(tempDir, f.Name)
  524. outFile, err := os.OpenFile(fpath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
  525. if err != nil {
  526. return "", err
  527. }
  528. rc, err := f.Open()
  529. if err != nil {
  530. return "", err
  531. }
  532. _, err = io.Copy(outFile, rc)
  533. if err != nil {
  534. return "", err
  535. }
  536. outFile.Close()
  537. rc.Close()
  538. }
  539. params, err := convert.GetParams(tempDir)
  540. if err != nil {
  541. return "", err
  542. }
  543. mArch, err := convert.GetModelArchFromParams(name, tempDir, params)
  544. if err != nil {
  545. return "", err
  546. }
  547. fn(api.ProgressResponse{Status: "processing safetensors"})
  548. if err := mArch.GetTensors(); err != nil {
  549. return "", err
  550. }
  551. if err := mArch.LoadVocab(); err != nil {
  552. return "", err
  553. }
  554. fn(api.ProgressResponse{Status: "converting model"})
  555. path, err = mArch.WriteGGUF()
  556. if err != nil {
  557. return "", err
  558. }
  559. return path, nil
  560. }
  561. func CopyModel(src, dest string) error {
  562. srcModelPath := ParseModelPath(src)
  563. srcPath, err := srcModelPath.GetManifestPath()
  564. if err != nil {
  565. return err
  566. }
  567. destModelPath := ParseModelPath(dest)
  568. destPath, err := destModelPath.GetManifestPath()
  569. if err != nil {
  570. return err
  571. }
  572. if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
  573. return err
  574. }
  575. // copy the file
  576. input, err := os.ReadFile(srcPath)
  577. if err != nil {
  578. fmt.Println("Error reading file:", err)
  579. return err
  580. }
  581. err = os.WriteFile(destPath, input, 0o644)
  582. if err != nil {
  583. fmt.Println("Error reading file:", err)
  584. return err
  585. }
  586. return nil
  587. }
  588. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  589. fp, err := GetManifestPath()
  590. if err != nil {
  591. return err
  592. }
  593. walkFunc := func(path string, info os.FileInfo, _ error) error {
  594. if info.IsDir() {
  595. return nil
  596. }
  597. dir, file := filepath.Split(path)
  598. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  599. tag := strings.Join([]string{dir, file}, ":")
  600. fmp := ParseModelPath(tag)
  601. // skip the manifest we're trying to delete
  602. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  603. return nil
  604. }
  605. // save (i.e. delete from the deleteMap) any files used in other manifests
  606. manifest, _, err := GetManifest(fmp)
  607. if err != nil {
  608. // nolint: nilerr
  609. return nil
  610. }
  611. for _, layer := range manifest.Layers {
  612. delete(deleteMap, layer.Digest)
  613. }
  614. delete(deleteMap, manifest.Config.Digest)
  615. return nil
  616. }
  617. if err := filepath.Walk(fp, walkFunc); err != nil {
  618. return err
  619. }
  620. // only delete the files which are still in the deleteMap
  621. for k := range deleteMap {
  622. fp, err := GetBlobsPath(k)
  623. if err != nil {
  624. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  625. continue
  626. }
  627. if !dryRun {
  628. if err := os.Remove(fp); err != nil {
  629. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  630. continue
  631. }
  632. } else {
  633. slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
  634. }
  635. }
  636. return nil
  637. }
  638. func PruneLayers() error {
  639. deleteMap := make(map[string]struct{})
  640. p, err := GetBlobsPath("")
  641. if err != nil {
  642. return err
  643. }
  644. blobs, err := os.ReadDir(p)
  645. if err != nil {
  646. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  647. return err
  648. }
  649. for _, blob := range blobs {
  650. name := blob.Name()
  651. name = strings.ReplaceAll(name, "-", ":")
  652. if strings.HasPrefix(name, "sha256:") {
  653. deleteMap[name] = struct{}{}
  654. }
  655. }
  656. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  657. err = deleteUnusedLayers(nil, deleteMap, false)
  658. if err != nil {
  659. return err
  660. }
  661. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  662. return nil
  663. }
  664. func PruneDirectory(path string) error {
  665. info, err := os.Lstat(path)
  666. if err != nil {
  667. return err
  668. }
  669. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  670. entries, err := os.ReadDir(path)
  671. if err != nil {
  672. return err
  673. }
  674. for _, entry := range entries {
  675. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  676. return err
  677. }
  678. }
  679. entries, err = os.ReadDir(path)
  680. if err != nil {
  681. return err
  682. }
  683. if len(entries) > 0 {
  684. return nil
  685. }
  686. return os.Remove(path)
  687. }
  688. return nil
  689. }
  690. func DeleteModel(name string) error {
  691. mp := ParseModelPath(name)
  692. manifest, _, err := GetManifest(mp)
  693. if err != nil {
  694. return err
  695. }
  696. deleteMap := make(map[string]struct{})
  697. for _, layer := range manifest.Layers {
  698. deleteMap[layer.Digest] = struct{}{}
  699. }
  700. deleteMap[manifest.Config.Digest] = struct{}{}
  701. err = deleteUnusedLayers(&mp, deleteMap, false)
  702. if err != nil {
  703. return err
  704. }
  705. fp, err := mp.GetManifestPath()
  706. if err != nil {
  707. return err
  708. }
  709. err = os.Remove(fp)
  710. if err != nil {
  711. slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
  712. return err
  713. }
  714. return nil
  715. }
  716. func ShowModelfile(model *Model) (string, error) {
  717. var mt struct {
  718. *Model
  719. From string
  720. Parameters map[string][]any
  721. }
  722. mt.Parameters = make(map[string][]any)
  723. for k, v := range model.Options {
  724. if s, ok := v.([]any); ok {
  725. mt.Parameters[k] = s
  726. continue
  727. }
  728. mt.Parameters[k] = []any{v}
  729. }
  730. mt.Model = model
  731. mt.From = model.ModelPath
  732. if model.ParentModel != "" {
  733. mt.From = model.ParentModel
  734. }
  735. modelFile := `# Modelfile generated by "ollama show"
  736. # To build a new Modelfile based on this one, replace the FROM line with:
  737. # FROM {{ .ShortName }}
  738. FROM {{ .From }}
  739. TEMPLATE """{{ .Template }}"""
  740. {{- if .System }}
  741. SYSTEM """{{ .System }}"""
  742. {{- end }}
  743. {{- range $adapter := .AdapterPaths }}
  744. ADAPTER {{ $adapter }}
  745. {{- end }}
  746. {{- range $k, $v := .Parameters }}
  747. {{- range $parameter := $v }}
  748. PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
  749. {{- end }}
  750. {{- end }}`
  751. tmpl, err := template.New("").Parse(modelFile)
  752. if err != nil {
  753. slog.Info(fmt.Sprintf("error parsing template: %q", err))
  754. return "", err
  755. }
  756. var buf bytes.Buffer
  757. if err = tmpl.Execute(&buf, mt); err != nil {
  758. slog.Info(fmt.Sprintf("error executing template: %q", err))
  759. return "", err
  760. }
  761. return buf.String(), nil
  762. }
  763. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  764. mp := ParseModelPath(name)
  765. fn(api.ProgressResponse{Status: "retrieving manifest"})
  766. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  767. return fmt.Errorf("insecure protocol http")
  768. }
  769. manifest, _, err := GetManifest(mp)
  770. if err != nil {
  771. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  772. return err
  773. }
  774. var layers []*Layer
  775. layers = append(layers, manifest.Layers...)
  776. layers = append(layers, manifest.Config)
  777. for _, layer := range layers {
  778. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  779. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  780. if errors.Is(err, errUnauthorized) {
  781. return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
  782. }
  783. return err
  784. }
  785. }
  786. fn(api.ProgressResponse{Status: "pushing manifest"})
  787. requestURL := mp.BaseURL()
  788. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  789. manifestJSON, err := json.Marshal(manifest)
  790. if err != nil {
  791. return err
  792. }
  793. headers := make(http.Header)
  794. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  795. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  796. if err != nil {
  797. return err
  798. }
  799. defer resp.Body.Close()
  800. fn(api.ProgressResponse{Status: "success"})
  801. return nil
  802. }
  803. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  804. mp := ParseModelPath(name)
  805. var manifest *ManifestV2
  806. var err error
  807. var noprune string
  808. // build deleteMap to prune unused layers
  809. deleteMap := make(map[string]struct{})
  810. if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  811. manifest, _, err = GetManifest(mp)
  812. if err != nil && !errors.Is(err, os.ErrNotExist) {
  813. return err
  814. }
  815. if manifest != nil {
  816. for _, l := range manifest.Layers {
  817. deleteMap[l.Digest] = struct{}{}
  818. }
  819. deleteMap[manifest.Config.Digest] = struct{}{}
  820. }
  821. }
  822. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  823. return fmt.Errorf("insecure protocol http")
  824. }
  825. fn(api.ProgressResponse{Status: "pulling manifest"})
  826. manifest, err = pullModelManifest(ctx, mp, regOpts)
  827. if err != nil {
  828. return fmt.Errorf("pull model manifest: %s", err)
  829. }
  830. var layers []*Layer
  831. layers = append(layers, manifest.Layers...)
  832. layers = append(layers, manifest.Config)
  833. for _, layer := range layers {
  834. if err := downloadBlob(
  835. ctx,
  836. downloadOpts{
  837. mp: mp,
  838. digest: layer.Digest,
  839. regOpts: regOpts,
  840. fn: fn,
  841. }); err != nil {
  842. return err
  843. }
  844. delete(deleteMap, layer.Digest)
  845. }
  846. delete(deleteMap, manifest.Config.Digest)
  847. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  848. for _, layer := range layers {
  849. if err := verifyBlob(layer.Digest); err != nil {
  850. if errors.Is(err, errDigestMismatch) {
  851. // something went wrong, delete the blob
  852. fp, err := GetBlobsPath(layer.Digest)
  853. if err != nil {
  854. return err
  855. }
  856. if err := os.Remove(fp); err != nil {
  857. // log this, but return the original error
  858. slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
  859. }
  860. }
  861. return err
  862. }
  863. }
  864. fn(api.ProgressResponse{Status: "writing manifest"})
  865. manifestJSON, err := json.Marshal(manifest)
  866. if err != nil {
  867. return err
  868. }
  869. fp, err := mp.GetManifestPath()
  870. if err != nil {
  871. return err
  872. }
  873. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  874. return err
  875. }
  876. err = os.WriteFile(fp, manifestJSON, 0o644)
  877. if err != nil {
  878. slog.Info(fmt.Sprintf("couldn't write to %s", fp))
  879. return err
  880. }
  881. if noprune == "" {
  882. fn(api.ProgressResponse{Status: "removing any unused layers"})
  883. err = deleteUnusedLayers(nil, deleteMap, false)
  884. if err != nil {
  885. return err
  886. }
  887. }
  888. fn(api.ProgressResponse{Status: "success"})
  889. return nil
  890. }
  891. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *registryOptions) (*ManifestV2, error) {
  892. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  893. headers := make(http.Header)
  894. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  895. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  896. if err != nil {
  897. return nil, err
  898. }
  899. defer resp.Body.Close()
  900. var m *ManifestV2
  901. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  902. return nil, err
  903. }
  904. return m, err
  905. }
  906. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  907. func GetSHA256Digest(r io.Reader) (string, int64) {
  908. h := sha256.New()
  909. n, err := io.Copy(h, r)
  910. if err != nil {
  911. log.Fatal(err)
  912. }
  913. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  914. }
  915. var errUnauthorized = fmt.Errorf("unauthorized")
  916. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  917. for i := 0; i < 2; i++ {
  918. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  919. if err != nil {
  920. if !errors.Is(err, context.Canceled) {
  921. slog.Info(fmt.Sprintf("request failed: %v", err))
  922. }
  923. return nil, err
  924. }
  925. switch {
  926. case resp.StatusCode == http.StatusUnauthorized:
  927. // Handle authentication error with one retry
  928. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  929. token, err := getAuthorizationToken(ctx, challenge)
  930. if err != nil {
  931. return nil, err
  932. }
  933. regOpts.Token = token
  934. if body != nil {
  935. _, err = body.Seek(0, io.SeekStart)
  936. if err != nil {
  937. return nil, err
  938. }
  939. }
  940. case resp.StatusCode == http.StatusNotFound:
  941. return nil, os.ErrNotExist
  942. case resp.StatusCode >= http.StatusBadRequest:
  943. responseBody, err := io.ReadAll(resp.Body)
  944. if err != nil {
  945. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  946. }
  947. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  948. default:
  949. return resp, nil
  950. }
  951. }
  952. return nil, errUnauthorized
  953. }
  954. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  955. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  956. requestURL.Scheme = "http"
  957. }
  958. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  959. if err != nil {
  960. return nil, err
  961. }
  962. if headers != nil {
  963. req.Header = headers
  964. }
  965. if regOpts != nil {
  966. if regOpts.Token != "" {
  967. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  968. } else if regOpts.Username != "" && regOpts.Password != "" {
  969. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  970. }
  971. }
  972. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  973. if s := req.Header.Get("Content-Length"); s != "" {
  974. contentLength, err := strconv.ParseInt(s, 10, 64)
  975. if err != nil {
  976. return nil, err
  977. }
  978. req.ContentLength = contentLength
  979. }
  980. resp, err := http.DefaultClient.Do(req)
  981. if err != nil {
  982. return nil, err
  983. }
  984. return resp, nil
  985. }
  986. func getValue(header, key string) string {
  987. startIdx := strings.Index(header, key+"=")
  988. if startIdx == -1 {
  989. return ""
  990. }
  991. // Move the index to the starting quote after the key.
  992. startIdx += len(key) + 2
  993. endIdx := startIdx
  994. for endIdx < len(header) {
  995. if header[endIdx] == '"' {
  996. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  997. endIdx++
  998. continue
  999. }
  1000. break
  1001. }
  1002. endIdx++
  1003. }
  1004. return header[startIdx:endIdx]
  1005. }
  1006. func parseRegistryChallenge(authStr string) registryChallenge {
  1007. authStr = strings.TrimPrefix(authStr, "Bearer ")
  1008. return registryChallenge{
  1009. Realm: getValue(authStr, "realm"),
  1010. Service: getValue(authStr, "service"),
  1011. Scope: getValue(authStr, "scope"),
  1012. }
  1013. }
  1014. var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")
  1015. func verifyBlob(digest string) error {
  1016. fp, err := GetBlobsPath(digest)
  1017. if err != nil {
  1018. return err
  1019. }
  1020. f, err := os.Open(fp)
  1021. if err != nil {
  1022. return err
  1023. }
  1024. defer f.Close()
  1025. fileDigest, _ := GetSHA256Digest(f)
  1026. if digest != fileDigest {
  1027. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  1028. }
  1029. return nil
  1030. }