images.go 28 KB

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