images.go 27 KB

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