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. ftype, err := llm.ParseFileType(quantization)
  320. if err != nil {
  321. return err
  322. }
  323. filetype := baseLayer.GGML.KV().FileType()
  324. if !slices.Contains([]string{"F16", "F32"}, filetype) {
  325. return errors.New("quantization is only supported for F16 and F32 models")
  326. }
  327. fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", filetype, 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(), ftype); 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. if baseLayer.GGML != nil {
  347. config.ModelFormat = cmp.Or(config.ModelFormat, baseLayer.GGML.Name())
  348. config.ModelFamily = cmp.Or(config.ModelFamily, baseLayer.GGML.KV().Architecture())
  349. config.ModelType = cmp.Or(config.ModelType, format.HumanNumber(baseLayer.GGML.KV().ParameterCount()))
  350. config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType())
  351. config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
  352. }
  353. layers = append(layers, baseLayer.Layer)
  354. }
  355. case "license", "template", "system":
  356. blob := strings.NewReader(c.Args)
  357. layer, err := NewLayer(blob, mediatype)
  358. if err != nil {
  359. return err
  360. }
  361. if c.Name != "license" {
  362. // replace
  363. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  364. return layer.MediaType == mediatype
  365. })
  366. }
  367. layers = append(layers, layer)
  368. case "message":
  369. role, content, ok := strings.Cut(c.Args, ": ")
  370. if !ok {
  371. return fmt.Errorf("invalid message: %s", c.Args)
  372. }
  373. messages = append(messages, &api.Message{Role: role, Content: content})
  374. default:
  375. ps, err := api.FormatParams(map[string][]string{c.Name: {c.Args}})
  376. if err != nil {
  377. return err
  378. }
  379. for k, v := range ps {
  380. if ks, ok := parameters[k].([]string); ok {
  381. parameters[k] = append(ks, v.([]string)...)
  382. } else if vs, ok := v.([]string); ok {
  383. parameters[k] = vs
  384. } else {
  385. parameters[k] = v
  386. }
  387. }
  388. }
  389. }
  390. var err2 error
  391. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  392. switch layer.MediaType {
  393. case "application/vnd.ollama.image.message":
  394. // if there are new messages, remove the inherited ones
  395. if len(messages) > 0 {
  396. return true
  397. }
  398. return false
  399. case "application/vnd.ollama.image.params":
  400. // merge inherited parameters with new ones
  401. r, err := layer.Open()
  402. if err != nil {
  403. err2 = err
  404. return false
  405. }
  406. defer r.Close()
  407. var ps map[string]any
  408. if err := json.NewDecoder(r).Decode(&ps); err != nil {
  409. err2 = err
  410. return false
  411. }
  412. for k, v := range ps {
  413. if _, ok := parameters[k]; !ok {
  414. parameters[k] = v
  415. }
  416. }
  417. return true
  418. default:
  419. return false
  420. }
  421. })
  422. if err2 != nil {
  423. return err2
  424. }
  425. if len(messages) > 0 {
  426. var b bytes.Buffer
  427. if err := json.NewEncoder(&b).Encode(messages); err != nil {
  428. return err
  429. }
  430. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  431. if err != nil {
  432. return err
  433. }
  434. layers = append(layers, layer)
  435. }
  436. if len(parameters) > 0 {
  437. var b bytes.Buffer
  438. if err := json.NewEncoder(&b).Encode(parameters); err != nil {
  439. return err
  440. }
  441. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  442. if err != nil {
  443. return err
  444. }
  445. layers = append(layers, layer)
  446. }
  447. digests := make([]string, len(layers))
  448. for i, layer := range layers {
  449. digests[i] = layer.Digest
  450. }
  451. config.RootFS.DiffIDs = digests
  452. var b bytes.Buffer
  453. if err := json.NewEncoder(&b).Encode(config); err != nil {
  454. return err
  455. }
  456. layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  457. if err != nil {
  458. return err
  459. }
  460. for _, layer := range append(layers, layer) {
  461. if layer.status != "" {
  462. fn(api.ProgressResponse{Status: layer.status})
  463. }
  464. }
  465. unref := make(map[string]struct{})
  466. if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
  467. for _, layer := range manifest.Layers {
  468. if !slices.Contains(digests, layer.Digest) {
  469. unref[layer.Digest] = struct{}{}
  470. }
  471. }
  472. if manifest.Config.Digest != layer.Digest {
  473. unref[manifest.Config.Digest] = struct{}{}
  474. }
  475. }
  476. fn(api.ProgressResponse{Status: "writing manifest"})
  477. if err := WriteManifest(name, layer, layers); err != nil {
  478. return err
  479. }
  480. if !envconfig.NoPrune {
  481. if err := deleteUnusedLayers(nil, unref, false); err != nil {
  482. return err
  483. }
  484. }
  485. fn(api.ProgressResponse{Status: "success"})
  486. return nil
  487. }
  488. func CopyModel(src, dst model.Name) error {
  489. if !dst.IsFullyQualified() {
  490. return model.Unqualified(dst)
  491. }
  492. if !src.IsFullyQualified() {
  493. return model.Unqualified(src)
  494. }
  495. if src.Filepath() == dst.Filepath() {
  496. return nil
  497. }
  498. manifests, err := GetManifestPath()
  499. if err != nil {
  500. return err
  501. }
  502. dstpath := filepath.Join(manifests, dst.Filepath())
  503. if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
  504. return err
  505. }
  506. srcpath := filepath.Join(manifests, src.Filepath())
  507. srcfile, err := os.Open(srcpath)
  508. if err != nil {
  509. return err
  510. }
  511. defer srcfile.Close()
  512. dstfile, err := os.Create(dstpath)
  513. if err != nil {
  514. return err
  515. }
  516. defer dstfile.Close()
  517. _, err = io.Copy(dstfile, srcfile)
  518. return err
  519. }
  520. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  521. fp, err := GetManifestPath()
  522. if err != nil {
  523. return err
  524. }
  525. walkFunc := func(path string, info os.FileInfo, _ error) error {
  526. if info.IsDir() {
  527. return nil
  528. }
  529. dir, file := filepath.Split(path)
  530. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  531. tag := strings.Join([]string{dir, file}, ":")
  532. fmp := ParseModelPath(tag)
  533. // skip the manifest we're trying to delete
  534. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  535. return nil
  536. }
  537. // save (i.e. delete from the deleteMap) any files used in other manifests
  538. manifest, _, err := GetManifest(fmp)
  539. if err != nil {
  540. // nolint: nilerr
  541. return nil
  542. }
  543. for _, layer := range manifest.Layers {
  544. delete(deleteMap, layer.Digest)
  545. }
  546. delete(deleteMap, manifest.Config.Digest)
  547. return nil
  548. }
  549. if err := filepath.Walk(fp, walkFunc); err != nil {
  550. return err
  551. }
  552. // only delete the files which are still in the deleteMap
  553. for k := range deleteMap {
  554. fp, err := GetBlobsPath(k)
  555. if err != nil {
  556. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  557. continue
  558. }
  559. if !dryRun {
  560. if err := os.Remove(fp); err != nil {
  561. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  562. continue
  563. }
  564. } else {
  565. slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
  566. }
  567. }
  568. return nil
  569. }
  570. func PruneLayers() error {
  571. deleteMap := make(map[string]struct{})
  572. p, err := GetBlobsPath("")
  573. if err != nil {
  574. return err
  575. }
  576. blobs, err := os.ReadDir(p)
  577. if err != nil {
  578. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  579. return err
  580. }
  581. for _, blob := range blobs {
  582. name := blob.Name()
  583. name = strings.ReplaceAll(name, "-", ":")
  584. if strings.HasPrefix(name, "sha256:") {
  585. deleteMap[name] = struct{}{}
  586. }
  587. }
  588. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  589. err = deleteUnusedLayers(nil, deleteMap, false)
  590. if err != nil {
  591. return err
  592. }
  593. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  594. return nil
  595. }
  596. func PruneDirectory(path string) error {
  597. info, err := os.Lstat(path)
  598. if err != nil {
  599. return err
  600. }
  601. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  602. entries, err := os.ReadDir(path)
  603. if err != nil {
  604. return err
  605. }
  606. for _, entry := range entries {
  607. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  608. return err
  609. }
  610. }
  611. entries, err = os.ReadDir(path)
  612. if err != nil {
  613. return err
  614. }
  615. if len(entries) > 0 {
  616. return nil
  617. }
  618. return os.Remove(path)
  619. }
  620. return nil
  621. }
  622. func DeleteModel(name string) error {
  623. mp := ParseModelPath(name)
  624. manifest, _, err := GetManifest(mp)
  625. if err != nil {
  626. return err
  627. }
  628. deleteMap := make(map[string]struct{})
  629. for _, layer := range manifest.Layers {
  630. deleteMap[layer.Digest] = struct{}{}
  631. }
  632. deleteMap[manifest.Config.Digest] = struct{}{}
  633. err = deleteUnusedLayers(&mp, deleteMap, false)
  634. if err != nil {
  635. return err
  636. }
  637. fp, err := mp.GetManifestPath()
  638. if err != nil {
  639. return err
  640. }
  641. err = os.Remove(fp)
  642. if err != nil {
  643. slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
  644. return err
  645. }
  646. return nil
  647. }
  648. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  649. mp := ParseModelPath(name)
  650. fn(api.ProgressResponse{Status: "retrieving manifest"})
  651. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  652. return fmt.Errorf("insecure protocol http")
  653. }
  654. manifest, _, err := GetManifest(mp)
  655. if err != nil {
  656. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  657. return err
  658. }
  659. var layers []*Layer
  660. layers = append(layers, manifest.Layers...)
  661. layers = append(layers, manifest.Config)
  662. for _, layer := range layers {
  663. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  664. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  665. return err
  666. }
  667. }
  668. fn(api.ProgressResponse{Status: "pushing manifest"})
  669. requestURL := mp.BaseURL()
  670. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  671. manifestJSON, err := json.Marshal(manifest)
  672. if err != nil {
  673. return err
  674. }
  675. headers := make(http.Header)
  676. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  677. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  678. if err != nil {
  679. return err
  680. }
  681. defer resp.Body.Close()
  682. fn(api.ProgressResponse{Status: "success"})
  683. return nil
  684. }
  685. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  686. mp := ParseModelPath(name)
  687. var manifest *ManifestV2
  688. var err error
  689. var noprune string
  690. // build deleteMap to prune unused layers
  691. deleteMap := make(map[string]struct{})
  692. if !envconfig.NoPrune {
  693. manifest, _, err = GetManifest(mp)
  694. if err != nil && !errors.Is(err, os.ErrNotExist) {
  695. return err
  696. }
  697. if manifest != nil {
  698. for _, l := range manifest.Layers {
  699. deleteMap[l.Digest] = struct{}{}
  700. }
  701. deleteMap[manifest.Config.Digest] = struct{}{}
  702. }
  703. }
  704. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  705. return fmt.Errorf("insecure protocol http")
  706. }
  707. fn(api.ProgressResponse{Status: "pulling manifest"})
  708. manifest, err = pullModelManifest(ctx, mp, regOpts)
  709. if err != nil {
  710. return fmt.Errorf("pull model manifest: %s", err)
  711. }
  712. var layers []*Layer
  713. layers = append(layers, manifest.Layers...)
  714. layers = append(layers, manifest.Config)
  715. for _, layer := range layers {
  716. if err := downloadBlob(
  717. ctx,
  718. downloadOpts{
  719. mp: mp,
  720. digest: layer.Digest,
  721. regOpts: regOpts,
  722. fn: fn,
  723. }); err != nil {
  724. return err
  725. }
  726. delete(deleteMap, layer.Digest)
  727. }
  728. delete(deleteMap, manifest.Config.Digest)
  729. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  730. for _, layer := range layers {
  731. if err := verifyBlob(layer.Digest); err != nil {
  732. if errors.Is(err, errDigestMismatch) {
  733. // something went wrong, delete the blob
  734. fp, err := GetBlobsPath(layer.Digest)
  735. if err != nil {
  736. return err
  737. }
  738. if err := os.Remove(fp); err != nil {
  739. // log this, but return the original error
  740. slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
  741. }
  742. }
  743. return err
  744. }
  745. }
  746. fn(api.ProgressResponse{Status: "writing manifest"})
  747. manifestJSON, err := json.Marshal(manifest)
  748. if err != nil {
  749. return err
  750. }
  751. fp, err := mp.GetManifestPath()
  752. if err != nil {
  753. return err
  754. }
  755. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  756. return err
  757. }
  758. err = os.WriteFile(fp, manifestJSON, 0o644)
  759. if err != nil {
  760. slog.Info(fmt.Sprintf("couldn't write to %s", fp))
  761. return err
  762. }
  763. if noprune == "" {
  764. fn(api.ProgressResponse{Status: "removing any unused layers"})
  765. err = deleteUnusedLayers(nil, deleteMap, false)
  766. if err != nil {
  767. return err
  768. }
  769. }
  770. fn(api.ProgressResponse{Status: "success"})
  771. return nil
  772. }
  773. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *registryOptions) (*ManifestV2, error) {
  774. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  775. headers := make(http.Header)
  776. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  777. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  778. if err != nil {
  779. return nil, err
  780. }
  781. defer resp.Body.Close()
  782. var m *ManifestV2
  783. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  784. return nil, err
  785. }
  786. return m, err
  787. }
  788. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  789. func GetSHA256Digest(r io.Reader) (string, int64) {
  790. h := sha256.New()
  791. n, err := io.Copy(h, r)
  792. if err != nil {
  793. log.Fatal(err)
  794. }
  795. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  796. }
  797. var errUnauthorized = fmt.Errorf("unauthorized: access denied")
  798. // getTokenSubject returns the subject of a JWT token, it does not validate the token
  799. func getTokenSubject(token string) string {
  800. parts := strings.Split(token, ".")
  801. if len(parts) != 3 {
  802. slog.Error("jwt token does not contain 3 parts")
  803. return ""
  804. }
  805. payload := parts[1]
  806. payloadBytes, err := base64.RawURLEncoding.DecodeString(payload)
  807. if err != nil {
  808. slog.Error(fmt.Sprintf("failed to decode jwt payload: %v", err))
  809. return ""
  810. }
  811. var payloadMap map[string]interface{}
  812. if err := json.Unmarshal(payloadBytes, &payloadMap); err != nil {
  813. slog.Error(fmt.Sprintf("failed to unmarshal payload JSON: %v", err))
  814. return ""
  815. }
  816. sub, ok := payloadMap["sub"]
  817. if !ok {
  818. slog.Error("jwt does not contain 'sub' field")
  819. return ""
  820. }
  821. return fmt.Sprintf("%s", sub)
  822. }
  823. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  824. anonymous := true // access will default to anonymous if no user is found associated with the public key
  825. for i := 0; i < 2; i++ {
  826. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  827. if err != nil {
  828. if !errors.Is(err, context.Canceled) {
  829. slog.Info(fmt.Sprintf("request failed: %v", err))
  830. }
  831. return nil, err
  832. }
  833. switch {
  834. case resp.StatusCode == http.StatusUnauthorized:
  835. // Handle authentication error with one retry
  836. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  837. token, err := getAuthorizationToken(ctx, challenge)
  838. if err != nil {
  839. return nil, err
  840. }
  841. anonymous = getTokenSubject(token) == "anonymous"
  842. regOpts.Token = token
  843. if body != nil {
  844. _, err = body.Seek(0, io.SeekStart)
  845. if err != nil {
  846. return nil, err
  847. }
  848. }
  849. case resp.StatusCode == http.StatusNotFound:
  850. return nil, os.ErrNotExist
  851. case resp.StatusCode >= http.StatusBadRequest:
  852. responseBody, err := io.ReadAll(resp.Body)
  853. if err != nil {
  854. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  855. }
  856. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  857. default:
  858. return resp, nil
  859. }
  860. }
  861. if anonymous {
  862. // no user is associated with the public key, and the request requires non-anonymous access
  863. pubKey, nestedErr := auth.GetPublicKey()
  864. if nestedErr != nil {
  865. slog.Error(fmt.Sprintf("couldn't get public key: %v", nestedErr))
  866. return nil, errUnauthorized
  867. }
  868. return nil, &errtypes.UnknownOllamaKey{Key: pubKey}
  869. }
  870. // user is associated with the public key, but is not authorized to make the request
  871. return nil, errUnauthorized
  872. }
  873. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  874. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  875. requestURL.Scheme = "http"
  876. }
  877. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  878. if err != nil {
  879. return nil, err
  880. }
  881. if headers != nil {
  882. req.Header = headers
  883. }
  884. if regOpts != nil {
  885. if regOpts.Token != "" {
  886. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  887. } else if regOpts.Username != "" && regOpts.Password != "" {
  888. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  889. }
  890. }
  891. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  892. if s := req.Header.Get("Content-Length"); s != "" {
  893. contentLength, err := strconv.ParseInt(s, 10, 64)
  894. if err != nil {
  895. return nil, err
  896. }
  897. req.ContentLength = contentLength
  898. }
  899. resp, err := http.DefaultClient.Do(req)
  900. if err != nil {
  901. return nil, err
  902. }
  903. return resp, nil
  904. }
  905. func getValue(header, key string) string {
  906. startIdx := strings.Index(header, key+"=")
  907. if startIdx == -1 {
  908. return ""
  909. }
  910. // Move the index to the starting quote after the key.
  911. startIdx += len(key) + 2
  912. endIdx := startIdx
  913. for endIdx < len(header) {
  914. if header[endIdx] == '"' {
  915. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  916. endIdx++
  917. continue
  918. }
  919. break
  920. }
  921. endIdx++
  922. }
  923. return header[startIdx:endIdx]
  924. }
  925. func parseRegistryChallenge(authStr string) registryChallenge {
  926. authStr = strings.TrimPrefix(authStr, "Bearer ")
  927. return registryChallenge{
  928. Realm: getValue(authStr, "realm"),
  929. Service: getValue(authStr, "service"),
  930. Scope: getValue(authStr, "scope"),
  931. }
  932. }
  933. var errDigestMismatch = errors.New("digest mismatch, file must be downloaded again")
  934. func verifyBlob(digest string) error {
  935. fp, err := GetBlobsPath(digest)
  936. if err != nil {
  937. return err
  938. }
  939. f, err := os.Open(fp)
  940. if err != nil {
  941. return err
  942. }
  943. defer f.Close()
  944. fileDigest, _ := GetSHA256Digest(f)
  945. if digest != fileDigest {
  946. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  947. }
  948. return nil
  949. }