images.go 27 KB

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