images.go 27 KB

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