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