images.go 27 KB

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