images.go 27 KB

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