images.go 27 KB

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