images.go 27 KB

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