images.go 27 KB

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