images.go 27 KB

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