images.go 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273
  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, quantization 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. defer os.RemoveAll(ggufName)
  288. if quantization != "" {
  289. quantization = strings.ToUpper(quantization)
  290. fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", "F16", quantization)})
  291. tempfile, err := os.CreateTemp(filepath.Dir(ggufName), quantization)
  292. if err != nil {
  293. return err
  294. }
  295. defer os.RemoveAll(tempfile.Name())
  296. if err := llm.Quantize(ggufName, tempfile.Name(), quantization); err != nil {
  297. return err
  298. }
  299. if err := tempfile.Close(); err != nil {
  300. return err
  301. }
  302. pathName = tempfile.Name()
  303. }
  304. }
  305. bin, err := os.Open(pathName)
  306. if err != nil {
  307. // not a file on disk so must be a model reference
  308. modelpath := ParseModelPath(c.Args)
  309. manifest, _, err := GetManifest(modelpath)
  310. switch {
  311. case errors.Is(err, os.ErrNotExist):
  312. fn(api.ProgressResponse{Status: "pulling model"})
  313. if err := PullModel(ctx, c.Args, &registryOptions{}, fn); err != nil {
  314. return err
  315. }
  316. manifest, _, err = GetManifest(modelpath)
  317. if err != nil {
  318. return err
  319. }
  320. case err != nil:
  321. return err
  322. }
  323. fn(api.ProgressResponse{Status: "reading model metadata"})
  324. fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
  325. if err != nil {
  326. return err
  327. }
  328. fromConfigFile, err := os.Open(fromConfigPath)
  329. if err != nil {
  330. return err
  331. }
  332. defer fromConfigFile.Close()
  333. var fromConfig ConfigV2
  334. if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
  335. return err
  336. }
  337. // if the model is still not in gguf format, error out
  338. if fromConfig.ModelFormat != "gguf" {
  339. return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
  340. }
  341. config.SetModelFormat(fromConfig.ModelFormat)
  342. config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
  343. config.SetModelType(fromConfig.ModelType)
  344. config.SetFileType(fromConfig.FileType)
  345. for _, layer := range manifest.Layers {
  346. deleteMap[layer.Digest] = struct{}{}
  347. if layer.MediaType == "application/vnd.ollama.image.params" {
  348. fromParamsPath, err := GetBlobsPath(layer.Digest)
  349. if err != nil {
  350. return err
  351. }
  352. fromParamsFile, err := os.Open(fromParamsPath)
  353. if err != nil {
  354. return err
  355. }
  356. defer fromParamsFile.Close()
  357. if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
  358. return err
  359. }
  360. }
  361. layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
  362. if err != nil {
  363. return err
  364. }
  365. layers.Add(layer)
  366. }
  367. deleteMap[manifest.Config.Digest] = struct{}{}
  368. continue
  369. }
  370. defer bin.Close()
  371. var offset int64
  372. for {
  373. fn(api.ProgressResponse{Status: "creating model layer"})
  374. if _, err := bin.Seek(offset, io.SeekStart); err != nil {
  375. return err
  376. }
  377. ggml, size, err := llm.DecodeGGML(bin)
  378. if errors.Is(err, io.EOF) {
  379. break
  380. } else if errors.Is(err, llm.ErrUnsupportedFormat) {
  381. return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
  382. } else if err != nil {
  383. return err
  384. }
  385. config.SetModelFormat(ggml.Name())
  386. config.SetModelFamily(ggml.KV().Architecture())
  387. config.SetModelType(format.HumanNumber(ggml.KV().ParameterCount()))
  388. config.SetFileType(ggml.KV().FileType())
  389. mediatype := mediatype
  390. if ggml.KV().Architecture() == "clip" {
  391. mediatype = "application/vnd.ollama.image.projector"
  392. }
  393. sr := io.NewSectionReader(bin, offset, size)
  394. layer, err := NewLayer(sr, mediatype)
  395. if err != nil {
  396. return err
  397. }
  398. layers.Add(layer)
  399. offset += size
  400. }
  401. case "adapter":
  402. if strings.HasPrefix(c.Args, "@") {
  403. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  404. if err != nil {
  405. return err
  406. }
  407. c.Args = blobPath
  408. }
  409. fn(api.ProgressResponse{Status: "creating adapter layer"})
  410. bin, err := os.Open(realpath(modelFileDir, c.Args))
  411. if err != nil {
  412. return err
  413. }
  414. defer bin.Close()
  415. _, size, err := llm.DecodeGGML(bin)
  416. if err != nil {
  417. return err
  418. }
  419. sr := io.NewSectionReader(bin, 0, size)
  420. layer, err := NewLayer(sr, mediatype)
  421. if err != nil {
  422. return err
  423. }
  424. layers.Add(layer)
  425. case "license":
  426. fn(api.ProgressResponse{Status: "creating license layer"})
  427. bin := strings.NewReader(c.Args)
  428. layer, err := NewLayer(bin, mediatype)
  429. if err != nil {
  430. return err
  431. }
  432. layers.Add(layer)
  433. case "template", "system":
  434. fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})
  435. bin := strings.NewReader(c.Args)
  436. layer, err := NewLayer(bin, mediatype)
  437. if err != nil {
  438. return err
  439. }
  440. layers.Replace(layer)
  441. case "message":
  442. messages = append(messages, c.Args)
  443. default:
  444. params[c.Name] = append(params[c.Name], c.Args)
  445. }
  446. }
  447. if len(messages) > 0 {
  448. fn(api.ProgressResponse{Status: "creating parameters layer"})
  449. msgs := make([]api.Message, 0)
  450. for _, m := range messages {
  451. // todo: handle images
  452. msg := strings.SplitN(m, ": ", 2)
  453. msgs = append(msgs, api.Message{Role: msg[0], Content: msg[1]})
  454. }
  455. var b bytes.Buffer
  456. if err := json.NewEncoder(&b).Encode(msgs); err != nil {
  457. return err
  458. }
  459. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  460. if err != nil {
  461. return err
  462. }
  463. layers.Replace(layer)
  464. }
  465. if len(params) > 0 {
  466. fn(api.ProgressResponse{Status: "creating parameters layer"})
  467. formattedParams, err := api.FormatParams(params)
  468. if err != nil {
  469. return err
  470. }
  471. for k, v := range fromParams {
  472. if _, ok := formattedParams[k]; !ok {
  473. formattedParams[k] = v
  474. }
  475. }
  476. var b bytes.Buffer
  477. if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
  478. return err
  479. }
  480. fn(api.ProgressResponse{Status: "creating config layer"})
  481. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  482. if err != nil {
  483. return err
  484. }
  485. layers.Replace(layer)
  486. }
  487. digests := make([]string, len(layers.items))
  488. for i, layer := range layers.items {
  489. digests[i] = layer.Digest
  490. }
  491. config.RootFS.DiffIDs = digests
  492. var b bytes.Buffer
  493. if err := json.NewEncoder(&b).Encode(config); err != nil {
  494. return err
  495. }
  496. configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  497. if err != nil {
  498. return err
  499. }
  500. delete(deleteMap, configLayer.Digest)
  501. for _, layer := range append(layers.items, configLayer) {
  502. committed, err := layer.Commit()
  503. if err != nil {
  504. return err
  505. }
  506. status := "writing layer"
  507. if !committed {
  508. status = "using already created layer"
  509. }
  510. fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
  511. delete(deleteMap, layer.Digest)
  512. }
  513. fn(api.ProgressResponse{Status: "writing manifest"})
  514. if err := WriteManifest(name, configLayer, layers.items); err != nil {
  515. return err
  516. }
  517. if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  518. if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
  519. return err
  520. }
  521. }
  522. fn(api.ProgressResponse{Status: "success"})
  523. return nil
  524. }
  525. func convertSafetensors(name, path string, fn func(resp api.ProgressResponse)) (string, error) {
  526. r, err := zip.OpenReader(path)
  527. if err != nil {
  528. return "", err
  529. }
  530. defer r.Close()
  531. tempDir, err := os.MkdirTemp("", "ollama-convert")
  532. if err != nil {
  533. return "", err
  534. }
  535. defer os.RemoveAll(tempDir)
  536. fn(api.ProgressResponse{Status: "unpacking model metadata"})
  537. for _, f := range r.File {
  538. fpath := filepath.Join(tempDir, f.Name)
  539. outFile, err := os.OpenFile(fpath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
  540. if err != nil {
  541. return "", err
  542. }
  543. rc, err := f.Open()
  544. if err != nil {
  545. return "", err
  546. }
  547. _, err = io.Copy(outFile, rc)
  548. if err != nil {
  549. return "", err
  550. }
  551. outFile.Close()
  552. rc.Close()
  553. }
  554. params, err := convert.GetParams(tempDir)
  555. if err != nil {
  556. return "", err
  557. }
  558. mArch, err := convert.GetModelArchFromParams(name, tempDir, params)
  559. if err != nil {
  560. return "", err
  561. }
  562. fn(api.ProgressResponse{Status: "processing safetensors"})
  563. if err := mArch.GetTensors(); err != nil {
  564. return "", err
  565. }
  566. if err := mArch.LoadVocab(); err != nil {
  567. return "", err
  568. }
  569. fn(api.ProgressResponse{Status: "converting model"})
  570. path, err = mArch.WriteGGUF()
  571. if err != nil {
  572. return "", err
  573. }
  574. return path, nil
  575. }
  576. func CopyModel(src, dest string) error {
  577. srcModelPath := ParseModelPath(src)
  578. srcPath, err := srcModelPath.GetManifestPath()
  579. if err != nil {
  580. return err
  581. }
  582. destModelPath := ParseModelPath(dest)
  583. destPath, err := destModelPath.GetManifestPath()
  584. if err != nil {
  585. return err
  586. }
  587. if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
  588. return err
  589. }
  590. // copy the file
  591. input, err := os.ReadFile(srcPath)
  592. if err != nil {
  593. fmt.Println("Error reading file:", err)
  594. return err
  595. }
  596. err = os.WriteFile(destPath, input, 0o644)
  597. if err != nil {
  598. fmt.Println("Error reading file:", err)
  599. return err
  600. }
  601. return nil
  602. }
  603. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  604. fp, err := GetManifestPath()
  605. if err != nil {
  606. return err
  607. }
  608. walkFunc := func(path string, info os.FileInfo, _ error) error {
  609. if info.IsDir() {
  610. return nil
  611. }
  612. dir, file := filepath.Split(path)
  613. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  614. tag := strings.Join([]string{dir, file}, ":")
  615. fmp := ParseModelPath(tag)
  616. // skip the manifest we're trying to delete
  617. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  618. return nil
  619. }
  620. // save (i.e. delete from the deleteMap) any files used in other manifests
  621. manifest, _, err := GetManifest(fmp)
  622. if err != nil {
  623. // nolint: nilerr
  624. return nil
  625. }
  626. for _, layer := range manifest.Layers {
  627. delete(deleteMap, layer.Digest)
  628. }
  629. delete(deleteMap, manifest.Config.Digest)
  630. return nil
  631. }
  632. if err := filepath.Walk(fp, walkFunc); err != nil {
  633. return err
  634. }
  635. // only delete the files which are still in the deleteMap
  636. for k := range deleteMap {
  637. fp, err := GetBlobsPath(k)
  638. if err != nil {
  639. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  640. continue
  641. }
  642. if !dryRun {
  643. if err := os.Remove(fp); err != nil {
  644. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  645. continue
  646. }
  647. } else {
  648. slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
  649. }
  650. }
  651. return nil
  652. }
  653. func PruneLayers() error {
  654. deleteMap := make(map[string]struct{})
  655. p, err := GetBlobsPath("")
  656. if err != nil {
  657. return err
  658. }
  659. blobs, err := os.ReadDir(p)
  660. if err != nil {
  661. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  662. return err
  663. }
  664. for _, blob := range blobs {
  665. name := blob.Name()
  666. name = strings.ReplaceAll(name, "-", ":")
  667. if strings.HasPrefix(name, "sha256:") {
  668. deleteMap[name] = struct{}{}
  669. }
  670. }
  671. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  672. err = deleteUnusedLayers(nil, deleteMap, false)
  673. if err != nil {
  674. return err
  675. }
  676. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  677. return nil
  678. }
  679. func PruneDirectory(path string) error {
  680. info, err := os.Lstat(path)
  681. if err != nil {
  682. return err
  683. }
  684. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  685. entries, err := os.ReadDir(path)
  686. if err != nil {
  687. return err
  688. }
  689. for _, entry := range entries {
  690. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  691. return err
  692. }
  693. }
  694. entries, err = os.ReadDir(path)
  695. if err != nil {
  696. return err
  697. }
  698. if len(entries) > 0 {
  699. return nil
  700. }
  701. return os.Remove(path)
  702. }
  703. return nil
  704. }
  705. func DeleteModel(name string) error {
  706. mp := ParseModelPath(name)
  707. manifest, _, err := GetManifest(mp)
  708. if err != nil {
  709. return err
  710. }
  711. deleteMap := make(map[string]struct{})
  712. for _, layer := range manifest.Layers {
  713. deleteMap[layer.Digest] = struct{}{}
  714. }
  715. deleteMap[manifest.Config.Digest] = struct{}{}
  716. err = deleteUnusedLayers(&mp, deleteMap, false)
  717. if err != nil {
  718. return err
  719. }
  720. fp, err := mp.GetManifestPath()
  721. if err != nil {
  722. return err
  723. }
  724. err = os.Remove(fp)
  725. if err != nil {
  726. slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
  727. return err
  728. }
  729. return nil
  730. }
  731. func ShowModelfile(model *Model) (string, error) {
  732. var mt struct {
  733. *Model
  734. From string
  735. Parameters map[string][]any
  736. }
  737. mt.Parameters = make(map[string][]any)
  738. for k, v := range model.Options {
  739. if s, ok := v.([]any); ok {
  740. mt.Parameters[k] = s
  741. continue
  742. }
  743. mt.Parameters[k] = []any{v}
  744. }
  745. mt.Model = model
  746. mt.From = model.ModelPath
  747. if model.ParentModel != "" {
  748. mt.From = model.ParentModel
  749. }
  750. modelFile := `# Modelfile generated by "ollama show"
  751. # To build a new Modelfile based on this one, replace the FROM line with:
  752. # FROM {{ .ShortName }}
  753. FROM {{ .From }}
  754. TEMPLATE """{{ .Template }}"""
  755. {{- if .System }}
  756. SYSTEM """{{ .System }}"""
  757. {{- end }}
  758. {{- range $adapter := .AdapterPaths }}
  759. ADAPTER {{ $adapter }}
  760. {{- end }}
  761. {{- range $k, $v := .Parameters }}
  762. {{- range $parameter := $v }}
  763. PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
  764. {{- end }}
  765. {{- end }}`
  766. tmpl, err := template.New("").Parse(modelFile)
  767. if err != nil {
  768. slog.Info(fmt.Sprintf("error parsing template: %q", err))
  769. return "", err
  770. }
  771. var buf bytes.Buffer
  772. if err = tmpl.Execute(&buf, mt); err != nil {
  773. slog.Info(fmt.Sprintf("error executing template: %q", err))
  774. return "", err
  775. }
  776. return buf.String(), nil
  777. }
  778. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  779. mp := ParseModelPath(name)
  780. fn(api.ProgressResponse{Status: "retrieving manifest"})
  781. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  782. return fmt.Errorf("insecure protocol http")
  783. }
  784. manifest, _, err := GetManifest(mp)
  785. if err != nil {
  786. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  787. return err
  788. }
  789. var layers []*Layer
  790. layers = append(layers, manifest.Layers...)
  791. layers = append(layers, manifest.Config)
  792. for _, layer := range layers {
  793. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  794. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  795. if errors.Is(err, errUnauthorized) {
  796. return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
  797. }
  798. return err
  799. }
  800. }
  801. fn(api.ProgressResponse{Status: "pushing manifest"})
  802. requestURL := mp.BaseURL()
  803. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  804. manifestJSON, err := json.Marshal(manifest)
  805. if err != nil {
  806. return err
  807. }
  808. headers := make(http.Header)
  809. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  810. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  811. if err != nil {
  812. return err
  813. }
  814. defer resp.Body.Close()
  815. fn(api.ProgressResponse{Status: "success"})
  816. return nil
  817. }
  818. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  819. mp := ParseModelPath(name)
  820. var manifest *ManifestV2
  821. var err error
  822. var noprune string
  823. // build deleteMap to prune unused layers
  824. deleteMap := make(map[string]struct{})
  825. if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  826. manifest, _, err = GetManifest(mp)
  827. if err != nil && !errors.Is(err, os.ErrNotExist) {
  828. return err
  829. }
  830. if manifest != nil {
  831. for _, l := range manifest.Layers {
  832. deleteMap[l.Digest] = struct{}{}
  833. }
  834. deleteMap[manifest.Config.Digest] = struct{}{}
  835. }
  836. }
  837. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  838. return fmt.Errorf("insecure protocol http")
  839. }
  840. fn(api.ProgressResponse{Status: "pulling manifest"})
  841. manifest, err = pullModelManifest(ctx, mp, regOpts)
  842. if err != nil {
  843. return fmt.Errorf("pull model manifest: %s", err)
  844. }
  845. var layers []*Layer
  846. layers = append(layers, manifest.Layers...)
  847. layers = append(layers, manifest.Config)
  848. for _, layer := range layers {
  849. if err := downloadBlob(
  850. ctx,
  851. downloadOpts{
  852. mp: mp,
  853. digest: layer.Digest,
  854. regOpts: regOpts,
  855. fn: fn,
  856. }); err != nil {
  857. return err
  858. }
  859. delete(deleteMap, layer.Digest)
  860. }
  861. delete(deleteMap, manifest.Config.Digest)
  862. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  863. for _, layer := range layers {
  864. if err := verifyBlob(layer.Digest); err != nil {
  865. if errors.Is(err, errDigestMismatch) {
  866. // something went wrong, delete the blob
  867. fp, err := GetBlobsPath(layer.Digest)
  868. if err != nil {
  869. return err
  870. }
  871. if err := os.Remove(fp); err != nil {
  872. // log this, but return the original error
  873. slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
  874. }
  875. }
  876. return err
  877. }
  878. }
  879. fn(api.ProgressResponse{Status: "writing manifest"})
  880. manifestJSON, err := json.Marshal(manifest)
  881. if err != nil {
  882. return err
  883. }
  884. fp, err := mp.GetManifestPath()
  885. if err != nil {
  886. return err
  887. }
  888. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  889. return err
  890. }
  891. err = os.WriteFile(fp, manifestJSON, 0o644)
  892. if err != nil {
  893. slog.Info(fmt.Sprintf("couldn't write to %s", fp))
  894. return err
  895. }
  896. if noprune == "" {
  897. fn(api.ProgressResponse{Status: "removing any unused layers"})
  898. err = deleteUnusedLayers(nil, deleteMap, false)
  899. if err != nil {
  900. return err
  901. }
  902. }
  903. fn(api.ProgressResponse{Status: "success"})
  904. return nil
  905. }
  906. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *registryOptions) (*ManifestV2, error) {
  907. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  908. headers := make(http.Header)
  909. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  910. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  911. if err != nil {
  912. return nil, err
  913. }
  914. defer resp.Body.Close()
  915. var m *ManifestV2
  916. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  917. return nil, err
  918. }
  919. return m, err
  920. }
  921. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  922. func GetSHA256Digest(r io.Reader) (string, int64) {
  923. h := sha256.New()
  924. n, err := io.Copy(h, r)
  925. if err != nil {
  926. log.Fatal(err)
  927. }
  928. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  929. }
  930. var errUnauthorized = fmt.Errorf("unauthorized")
  931. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  932. for i := 0; i < 2; i++ {
  933. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  934. if err != nil {
  935. if !errors.Is(err, context.Canceled) {
  936. slog.Info(fmt.Sprintf("request failed: %v", err))
  937. }
  938. return nil, err
  939. }
  940. switch {
  941. case resp.StatusCode == http.StatusUnauthorized:
  942. // Handle authentication error with one retry
  943. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  944. token, err := getAuthorizationToken(ctx, challenge)
  945. if err != nil {
  946. return nil, err
  947. }
  948. regOpts.Token = token
  949. if body != nil {
  950. _, err = body.Seek(0, io.SeekStart)
  951. if err != nil {
  952. return nil, err
  953. }
  954. }
  955. case resp.StatusCode == http.StatusNotFound:
  956. return nil, os.ErrNotExist
  957. case resp.StatusCode >= http.StatusBadRequest:
  958. responseBody, err := io.ReadAll(resp.Body)
  959. if err != nil {
  960. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  961. }
  962. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  963. default:
  964. return resp, nil
  965. }
  966. }
  967. return nil, errUnauthorized
  968. }
  969. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  970. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  971. requestURL.Scheme = "http"
  972. }
  973. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  974. if err != nil {
  975. return nil, err
  976. }
  977. if headers != nil {
  978. req.Header = headers
  979. }
  980. if regOpts != nil {
  981. if regOpts.Token != "" {
  982. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  983. } else if regOpts.Username != "" && regOpts.Password != "" {
  984. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  985. }
  986. }
  987. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  988. if s := req.Header.Get("Content-Length"); s != "" {
  989. contentLength, err := strconv.ParseInt(s, 10, 64)
  990. if err != nil {
  991. return nil, err
  992. }
  993. req.ContentLength = contentLength
  994. }
  995. resp, err := http.DefaultClient.Do(req)
  996. if err != nil {
  997. return nil, err
  998. }
  999. return resp, nil
  1000. }
  1001. func getValue(header, key string) string {
  1002. startIdx := strings.Index(header, key+"=")
  1003. if startIdx == -1 {
  1004. return ""
  1005. }
  1006. // Move the index to the starting quote after the key.
  1007. startIdx += len(key) + 2
  1008. endIdx := startIdx
  1009. for endIdx < len(header) {
  1010. if header[endIdx] == '"' {
  1011. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  1012. endIdx++
  1013. continue
  1014. }
  1015. break
  1016. }
  1017. endIdx++
  1018. }
  1019. return header[startIdx:endIdx]
  1020. }
  1021. func parseRegistryChallenge(authStr string) registryChallenge {
  1022. authStr = strings.TrimPrefix(authStr, "Bearer ")
  1023. return registryChallenge{
  1024. Realm: getValue(authStr, "realm"),
  1025. Service: getValue(authStr, "service"),
  1026. Scope: getValue(authStr, "scope"),
  1027. }
  1028. }
  1029. var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")
  1030. func verifyBlob(digest string) error {
  1031. fp, err := GetBlobsPath(digest)
  1032. if err != nil {
  1033. return err
  1034. }
  1035. f, err := os.Open(fp)
  1036. if err != nil {
  1037. return err
  1038. }
  1039. defer f.Close()
  1040. fileDigest, _ := GetSHA256Digest(f)
  1041. if digest != fileDigest {
  1042. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  1043. }
  1044. return nil
  1045. }