images.go 27 KB

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