images.go 27 KB

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