images.go 27 KB

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