images.go 28 KB

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