images.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137
  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. "github.com/ollama/ollama/api"
  24. "github.com/ollama/ollama/auth"
  25. "github.com/ollama/ollama/envconfig"
  26. "github.com/ollama/ollama/format"
  27. "github.com/ollama/ollama/llm"
  28. "github.com/ollama/ollama/parser"
  29. "github.com/ollama/ollama/types/errtypes"
  30. "github.com/ollama/ollama/types/model"
  31. "github.com/ollama/ollama/version"
  32. )
  33. type registryOptions struct {
  34. Insecure bool
  35. Username string
  36. Password string
  37. Token string
  38. }
  39. type Model struct {
  40. Name string `json:"name"`
  41. Config ConfigV2
  42. ShortName string
  43. ModelPath string
  44. ParentModel string
  45. AdapterPaths []string
  46. ProjectorPaths []string
  47. Template string
  48. System string
  49. License []string
  50. Digest string
  51. Options map[string]interface{}
  52. Messages []Message
  53. }
  54. func (m *Model) IsEmbedding() bool {
  55. return slices.Contains(m.Config.ModelFamilies, "bert") || slices.Contains(m.Config.ModelFamilies, "nomic-bert")
  56. }
  57. func (m *Model) String() string {
  58. var modelfile parser.File
  59. modelfile.Commands = append(modelfile.Commands, parser.Command{
  60. Name: "model",
  61. Args: m.ModelPath,
  62. })
  63. for _, adapter := range m.AdapterPaths {
  64. modelfile.Commands = append(modelfile.Commands, parser.Command{
  65. Name: "adapter",
  66. Args: adapter,
  67. })
  68. }
  69. for _, projector := range m.ProjectorPaths {
  70. modelfile.Commands = append(modelfile.Commands, parser.Command{
  71. Name: "model",
  72. Args: projector,
  73. })
  74. }
  75. if m.Template != "" {
  76. modelfile.Commands = append(modelfile.Commands, parser.Command{
  77. Name: "template",
  78. Args: m.Template,
  79. })
  80. }
  81. if m.System != "" {
  82. modelfile.Commands = append(modelfile.Commands, parser.Command{
  83. Name: "system",
  84. Args: m.System,
  85. })
  86. }
  87. for k, v := range m.Options {
  88. switch v := v.(type) {
  89. case []any:
  90. for _, s := range v {
  91. modelfile.Commands = append(modelfile.Commands, parser.Command{
  92. Name: k,
  93. Args: fmt.Sprintf("%v", s),
  94. })
  95. }
  96. default:
  97. modelfile.Commands = append(modelfile.Commands, parser.Command{
  98. Name: k,
  99. Args: fmt.Sprintf("%v", v),
  100. })
  101. }
  102. }
  103. for _, license := range m.License {
  104. modelfile.Commands = append(modelfile.Commands, parser.Command{
  105. Name: "license",
  106. Args: license,
  107. })
  108. }
  109. for _, msg := range m.Messages {
  110. modelfile.Commands = append(modelfile.Commands, parser.Command{
  111. Name: "message",
  112. Args: fmt.Sprintf("%s %s", msg.Role, msg.Content),
  113. })
  114. }
  115. return modelfile.String()
  116. }
  117. type Message struct {
  118. Role string `json:"role"`
  119. Content string `json:"content"`
  120. }
  121. type ManifestV2 struct {
  122. SchemaVersion int `json:"schemaVersion"`
  123. MediaType string `json:"mediaType"`
  124. Config *Layer `json:"config"`
  125. Layers []*Layer `json:"layers"`
  126. }
  127. type ConfigV2 struct {
  128. ModelFormat string `json:"model_format"`
  129. ModelFamily string `json:"model_family"`
  130. ModelFamilies []string `json:"model_families"`
  131. ModelType string `json:"model_type"`
  132. FileType string `json:"file_type"`
  133. // required by spec
  134. Architecture string `json:"architecture"`
  135. OS string `json:"os"`
  136. RootFS RootFS `json:"rootfs"`
  137. }
  138. type RootFS struct {
  139. Type string `json:"type"`
  140. DiffIDs []string `json:"diff_ids"`
  141. }
  142. func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
  143. fp, err := mp.GetManifestPath()
  144. if err != nil {
  145. return nil, "", err
  146. }
  147. if _, err = os.Stat(fp); err != nil {
  148. return nil, "", err
  149. }
  150. var manifest *ManifestV2
  151. bts, err := os.ReadFile(fp)
  152. if err != nil {
  153. return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
  154. }
  155. shaSum := sha256.Sum256(bts)
  156. shaStr := hex.EncodeToString(shaSum[:])
  157. if err := json.Unmarshal(bts, &manifest); err != nil {
  158. return nil, "", err
  159. }
  160. return manifest, shaStr, nil
  161. }
  162. func GetModel(name string) (*Model, error) {
  163. mp := ParseModelPath(name)
  164. manifest, digest, err := GetManifest(mp)
  165. if err != nil {
  166. return nil, err
  167. }
  168. model := &Model{
  169. Name: mp.GetFullTagname(),
  170. ShortName: mp.GetShortTagname(),
  171. Digest: digest,
  172. Template: "{{ .Prompt }}",
  173. License: []string{},
  174. }
  175. filename, err := GetBlobsPath(manifest.Config.Digest)
  176. if err != nil {
  177. return nil, err
  178. }
  179. configFile, err := os.Open(filename)
  180. if err != nil {
  181. return nil, err
  182. }
  183. defer configFile.Close()
  184. if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
  185. return nil, err
  186. }
  187. for _, layer := range manifest.Layers {
  188. filename, err := GetBlobsPath(layer.Digest)
  189. if err != nil {
  190. return nil, err
  191. }
  192. switch layer.MediaType {
  193. case "application/vnd.ollama.image.model":
  194. model.ModelPath = filename
  195. model.ParentModel = layer.From
  196. case "application/vnd.ollama.image.embed":
  197. // Deprecated in versions > 0.1.2
  198. // TODO: remove this warning in a future version
  199. slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
  200. case "application/vnd.ollama.image.adapter":
  201. model.AdapterPaths = append(model.AdapterPaths, filename)
  202. case "application/vnd.ollama.image.projector":
  203. model.ProjectorPaths = append(model.ProjectorPaths, filename)
  204. case "application/vnd.ollama.image.template":
  205. bts, err := os.ReadFile(filename)
  206. if err != nil {
  207. return nil, err
  208. }
  209. model.Template = string(bts)
  210. case "application/vnd.ollama.image.system":
  211. bts, err := os.ReadFile(filename)
  212. if err != nil {
  213. return nil, err
  214. }
  215. model.System = string(bts)
  216. case "application/vnd.ollama.image.prompt":
  217. bts, err := os.ReadFile(filename)
  218. if err != nil {
  219. return nil, err
  220. }
  221. model.Template = string(bts)
  222. case "application/vnd.ollama.image.params":
  223. params, err := os.Open(filename)
  224. if err != nil {
  225. return nil, err
  226. }
  227. defer params.Close()
  228. // parse model options parameters into a map so that we can see which fields have been specified explicitly
  229. if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
  230. return nil, err
  231. }
  232. case "application/vnd.ollama.image.messages":
  233. msgs, err := os.Open(filename)
  234. if err != nil {
  235. return nil, err
  236. }
  237. defer msgs.Close()
  238. if err = json.NewDecoder(msgs).Decode(&model.Messages); err != nil {
  239. return nil, err
  240. }
  241. case "application/vnd.ollama.image.license":
  242. bts, err := os.ReadFile(filename)
  243. if err != nil {
  244. return nil, err
  245. }
  246. model.License = append(model.License, string(bts))
  247. }
  248. }
  249. return model, nil
  250. }
  251. func realpath(rel, from string) string {
  252. abspath, err := filepath.Abs(from)
  253. if err != nil {
  254. return from
  255. }
  256. home, err := os.UserHomeDir()
  257. if err != nil {
  258. return abspath
  259. }
  260. if from == "~" {
  261. return home
  262. } else if strings.HasPrefix(from, "~/") {
  263. return filepath.Join(home, from[2:])
  264. }
  265. if _, err := os.Stat(filepath.Join(rel, from)); err == nil {
  266. // this is a file relative to the Modelfile
  267. return filepath.Join(rel, from)
  268. }
  269. return abspath
  270. }
  271. func CreateModel(ctx context.Context, name model.Name, modelFileDir, quantization string, modelfile *parser.File, fn func(resp api.ProgressResponse)) (err error) {
  272. config := ConfigV2{
  273. OS: "linux",
  274. Architecture: "amd64",
  275. RootFS: RootFS{
  276. Type: "layers",
  277. },
  278. }
  279. var messages []*api.Message
  280. parameters := make(map[string]any)
  281. var layers []*Layer
  282. for _, c := range modelfile.Commands {
  283. mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
  284. switch c.Name {
  285. case "model", "adapter":
  286. var baseLayers []*layerWithGGML
  287. if name := model.ParseName(c.Args); name.IsValid() {
  288. baseLayers, err = parseFromModel(ctx, name, fn)
  289. if err != nil {
  290. return err
  291. }
  292. } else if strings.HasPrefix(c.Args, "@") {
  293. digest := strings.TrimPrefix(c.Args, "@")
  294. if ib, ok := intermediateBlobs[digest]; ok {
  295. p, err := GetBlobsPath(ib)
  296. if err != nil {
  297. return err
  298. }
  299. if _, err := os.Stat(p); errors.Is(err, os.ErrNotExist) {
  300. // pass
  301. } else if err != nil {
  302. return err
  303. } else {
  304. fn(api.ProgressResponse{Status: fmt.Sprintf("using cached layer %s", ib)})
  305. digest = ib
  306. }
  307. }
  308. blobpath, err := GetBlobsPath(digest)
  309. if err != nil {
  310. return err
  311. }
  312. blob, err := os.Open(blobpath)
  313. if err != nil {
  314. return err
  315. }
  316. defer blob.Close()
  317. baseLayers, err = parseFromFile(ctx, blob, digest, fn)
  318. if err != nil {
  319. return err
  320. }
  321. } else if file, err := os.Open(realpath(modelFileDir, c.Args)); err == nil {
  322. defer file.Close()
  323. baseLayers, err = parseFromFile(ctx, file, "", fn)
  324. if err != nil {
  325. return err
  326. }
  327. } else {
  328. return fmt.Errorf("invalid model reference: %s", c.Args)
  329. }
  330. for _, baseLayer := range baseLayers {
  331. if quantization != "" &&
  332. baseLayer.MediaType == "application/vnd.ollama.image.model" &&
  333. baseLayer.GGML != nil &&
  334. baseLayer.GGML.Name() == "gguf" {
  335. want, err := llm.ParseFileType(quantization)
  336. if err != nil {
  337. return err
  338. }
  339. ft := baseLayer.GGML.KV().FileType()
  340. if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
  341. return errors.New("quantization is only supported for F16 and F32 models")
  342. } else if want != ft {
  343. fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", ft, quantization)})
  344. blob, err := GetBlobsPath(baseLayer.Digest)
  345. if err != nil {
  346. return err
  347. }
  348. temp, err := os.CreateTemp(filepath.Dir(blob), quantization)
  349. if err != nil {
  350. return err
  351. }
  352. defer temp.Close()
  353. defer os.Remove(temp.Name())
  354. if err := llm.Quantize(blob, temp.Name(), want); err != nil {
  355. return err
  356. }
  357. layers, err := parseFromFile(ctx, temp, "", fn)
  358. if err != nil {
  359. return err
  360. }
  361. if len(layers) != 1 {
  362. return errors.New("quantization failed")
  363. }
  364. baseLayer.Layer = layers[0].Layer
  365. baseLayer.GGML = layers[0].GGML
  366. }
  367. }
  368. if baseLayer.GGML != nil {
  369. config.ModelFormat = cmp.Or(config.ModelFormat, baseLayer.GGML.Name())
  370. config.ModelFamily = cmp.Or(config.ModelFamily, baseLayer.GGML.KV().Architecture())
  371. config.ModelType = cmp.Or(config.ModelType, format.HumanNumber(baseLayer.GGML.KV().ParameterCount()))
  372. config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
  373. config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
  374. }
  375. layers = append(layers, baseLayer.Layer)
  376. }
  377. case "license", "template", "system":
  378. if c.Name != "license" {
  379. // replace
  380. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  381. if layer.MediaType != mediatype {
  382. return false
  383. }
  384. if err := layer.Remove(); err != nil {
  385. return false
  386. }
  387. return true
  388. })
  389. }
  390. blob := strings.NewReader(c.Args)
  391. layer, err := NewLayer(blob, mediatype)
  392. if err != nil {
  393. return err
  394. }
  395. layers = append(layers, layer)
  396. case "message":
  397. role, content, ok := strings.Cut(c.Args, ": ")
  398. if !ok {
  399. return fmt.Errorf("invalid message: %s", c.Args)
  400. }
  401. messages = append(messages, &api.Message{Role: role, Content: content})
  402. default:
  403. ps, err := api.FormatParams(map[string][]string{c.Name: {c.Args}})
  404. if err != nil {
  405. return err
  406. }
  407. for k, v := range ps {
  408. if ks, ok := parameters[k].([]string); ok {
  409. parameters[k] = append(ks, v.([]string)...)
  410. } else if vs, ok := v.([]string); ok {
  411. parameters[k] = vs
  412. } else {
  413. parameters[k] = v
  414. }
  415. }
  416. }
  417. }
  418. var err2 error
  419. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  420. switch layer.MediaType {
  421. case "application/vnd.ollama.image.message":
  422. // if there are new messages, remove the inherited ones
  423. if len(messages) > 0 {
  424. return true
  425. }
  426. return false
  427. case "application/vnd.ollama.image.params":
  428. // merge inherited parameters with new ones
  429. r, err := layer.Open()
  430. if err != nil {
  431. err2 = err
  432. return false
  433. }
  434. defer r.Close()
  435. var ps map[string]any
  436. if err := json.NewDecoder(r).Decode(&ps); err != nil {
  437. err2 = err
  438. return false
  439. }
  440. for k, v := range ps {
  441. if _, ok := parameters[k]; !ok {
  442. parameters[k] = v
  443. }
  444. }
  445. return true
  446. default:
  447. return false
  448. }
  449. })
  450. if err2 != nil {
  451. return err2
  452. }
  453. if len(messages) > 0 {
  454. var b bytes.Buffer
  455. if err := json.NewEncoder(&b).Encode(messages); err != nil {
  456. return err
  457. }
  458. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  459. if err != nil {
  460. return err
  461. }
  462. layers = append(layers, layer)
  463. }
  464. if len(parameters) > 0 {
  465. var b bytes.Buffer
  466. if err := json.NewEncoder(&b).Encode(parameters); err != nil {
  467. return err
  468. }
  469. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  470. if err != nil {
  471. return err
  472. }
  473. layers = append(layers, layer)
  474. }
  475. digests := make([]string, len(layers))
  476. for i, layer := range layers {
  477. digests[i] = layer.Digest
  478. }
  479. config.RootFS.DiffIDs = digests
  480. var b bytes.Buffer
  481. if err := json.NewEncoder(&b).Encode(config); err != nil {
  482. return err
  483. }
  484. layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  485. if err != nil {
  486. return err
  487. }
  488. for _, layer := range append(layers, layer) {
  489. if layer.status != "" {
  490. fn(api.ProgressResponse{Status: layer.status})
  491. }
  492. }
  493. old, _ := ParseNamedManifest(name)
  494. fn(api.ProgressResponse{Status: "writing manifest"})
  495. if err := WriteManifest(name, layer, layers); err != nil {
  496. return err
  497. }
  498. if !envconfig.NoPrune && old != nil {
  499. if err := old.RemoveLayers(); err != nil {
  500. return err
  501. }
  502. }
  503. fn(api.ProgressResponse{Status: "success"})
  504. return nil
  505. }
  506. func CopyModel(src, dst model.Name) error {
  507. if !dst.IsFullyQualified() {
  508. return model.Unqualified(dst)
  509. }
  510. if !src.IsFullyQualified() {
  511. return model.Unqualified(src)
  512. }
  513. if src.Filepath() == dst.Filepath() {
  514. return nil
  515. }
  516. manifests, err := GetManifestPath()
  517. if err != nil {
  518. return err
  519. }
  520. dstpath := filepath.Join(manifests, dst.Filepath())
  521. if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
  522. return err
  523. }
  524. srcpath := filepath.Join(manifests, src.Filepath())
  525. srcfile, err := os.Open(srcpath)
  526. if err != nil {
  527. return err
  528. }
  529. defer srcfile.Close()
  530. dstfile, err := os.Create(dstpath)
  531. if err != nil {
  532. return err
  533. }
  534. defer dstfile.Close()
  535. _, err = io.Copy(dstfile, srcfile)
  536. return err
  537. }
  538. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
  539. fp, err := GetManifestPath()
  540. if err != nil {
  541. return err
  542. }
  543. walkFunc := func(path string, info os.FileInfo, _ error) error {
  544. if info.IsDir() {
  545. return nil
  546. }
  547. dir, file := filepath.Split(path)
  548. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  549. tag := strings.Join([]string{dir, file}, ":")
  550. fmp := ParseModelPath(tag)
  551. // skip the manifest we're trying to delete
  552. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  553. return nil
  554. }
  555. // save (i.e. delete from the deleteMap) any files used in other manifests
  556. manifest, _, err := GetManifest(fmp)
  557. if err != nil {
  558. //nolint:nilerr
  559. return nil
  560. }
  561. for _, layer := range manifest.Layers {
  562. delete(deleteMap, layer.Digest)
  563. }
  564. delete(deleteMap, manifest.Config.Digest)
  565. return nil
  566. }
  567. if err := filepath.Walk(fp, walkFunc); err != nil {
  568. return err
  569. }
  570. // only delete the files which are still in the deleteMap
  571. for k := range deleteMap {
  572. fp, err := GetBlobsPath(k)
  573. if err != nil {
  574. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  575. continue
  576. }
  577. if err := os.Remove(fp); err != nil {
  578. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  579. continue
  580. }
  581. }
  582. return nil
  583. }
  584. func PruneLayers() error {
  585. deleteMap := make(map[string]struct{})
  586. p, err := GetBlobsPath("")
  587. if err != nil {
  588. return err
  589. }
  590. blobs, err := os.ReadDir(p)
  591. if err != nil {
  592. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  593. return err
  594. }
  595. for _, blob := range blobs {
  596. name := blob.Name()
  597. name = strings.ReplaceAll(name, "-", ":")
  598. _, err := GetBlobsPath(name)
  599. if err != nil {
  600. if errors.Is(err, ErrInvalidDigestFormat) {
  601. // remove invalid blobs (e.g. partial downloads)
  602. if err := os.Remove(filepath.Join(p, blob.Name())); err != nil {
  603. slog.Error("couldn't remove blob", "blob", blob.Name(), "error", err)
  604. }
  605. }
  606. continue
  607. }
  608. deleteMap[name] = struct{}{}
  609. }
  610. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  611. err = deleteUnusedLayers(nil, deleteMap)
  612. if err != nil {
  613. return err
  614. }
  615. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  616. return nil
  617. }
  618. func PruneDirectory(path string) error {
  619. info, err := os.Lstat(path)
  620. if err != nil {
  621. return err
  622. }
  623. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  624. entries, err := os.ReadDir(path)
  625. if err != nil {
  626. return err
  627. }
  628. for _, entry := range entries {
  629. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  630. return err
  631. }
  632. }
  633. entries, err = os.ReadDir(path)
  634. if err != nil {
  635. return err
  636. }
  637. if len(entries) > 0 {
  638. return nil
  639. }
  640. return os.Remove(path)
  641. }
  642. return nil
  643. }
  644. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  645. mp := ParseModelPath(name)
  646. fn(api.ProgressResponse{Status: "retrieving manifest"})
  647. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  648. return fmt.Errorf("insecure protocol http")
  649. }
  650. manifest, _, err := GetManifest(mp)
  651. if err != nil {
  652. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  653. return err
  654. }
  655. var layers []*Layer
  656. layers = append(layers, manifest.Layers...)
  657. layers = append(layers, manifest.Config)
  658. for _, layer := range layers {
  659. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  660. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  661. return err
  662. }
  663. }
  664. fn(api.ProgressResponse{Status: "pushing manifest"})
  665. requestURL := mp.BaseURL()
  666. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  667. manifestJSON, err := json.Marshal(manifest)
  668. if err != nil {
  669. return err
  670. }
  671. headers := make(http.Header)
  672. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  673. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  674. if err != nil {
  675. return err
  676. }
  677. defer resp.Body.Close()
  678. fn(api.ProgressResponse{Status: "success"})
  679. return nil
  680. }
  681. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  682. mp := ParseModelPath(name)
  683. var manifest *ManifestV2
  684. var err error
  685. var noprune string
  686. // build deleteMap to prune unused layers
  687. deleteMap := make(map[string]struct{})
  688. if !envconfig.NoPrune {
  689. manifest, _, err = GetManifest(mp)
  690. if err != nil && !errors.Is(err, os.ErrNotExist) {
  691. return err
  692. }
  693. if manifest != nil {
  694. for _, l := range manifest.Layers {
  695. deleteMap[l.Digest] = struct{}{}
  696. }
  697. deleteMap[manifest.Config.Digest] = struct{}{}
  698. }
  699. }
  700. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  701. return fmt.Errorf("insecure protocol http")
  702. }
  703. fn(api.ProgressResponse{Status: "pulling manifest"})
  704. manifest, err = pullModelManifest(ctx, mp, regOpts)
  705. if err != nil {
  706. return fmt.Errorf("pull model manifest: %s", err)
  707. }
  708. var layers []*Layer
  709. layers = append(layers, manifest.Layers...)
  710. layers = append(layers, manifest.Config)
  711. skipVerify := make(map[string]bool)
  712. for _, layer := range layers {
  713. cacheHit, err := downloadBlob(ctx, downloadOpts{
  714. mp: mp,
  715. digest: layer.Digest,
  716. regOpts: regOpts,
  717. fn: fn,
  718. })
  719. if err != nil {
  720. return err
  721. }
  722. skipVerify[layer.Digest] = cacheHit
  723. delete(deleteMap, layer.Digest)
  724. }
  725. delete(deleteMap, manifest.Config.Digest)
  726. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  727. for _, layer := range layers {
  728. if skipVerify[layer.Digest] {
  729. continue
  730. }
  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)
  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 range 2 {
  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. }