images.go 26 KB

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