images.go 29 KB

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