images.go 29 KB

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