images.go 29 KB

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