images.go 29 KB

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