images.go 27 KB

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