images.go 29 KB

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