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. "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. fn(api.ProgressResponse{
  365. Status: "quantizing model",
  366. Quantize: "quant",
  367. })
  368. ft := baseLayer.GGML.KV().FileType()
  369. if !slices.Contains([]string{"F16", "F32"}, ft.String()) {
  370. return errors.New("quantization is only supported for F16 and F32 models")
  371. } else if want != ft {
  372. blob, err := GetBlobsPath(baseLayer.Digest)
  373. if err != nil {
  374. return err
  375. }
  376. temp, err := os.CreateTemp(filepath.Dir(blob), quantization)
  377. if err != nil {
  378. return err
  379. }
  380. defer temp.Close()
  381. defer os.Remove(temp.Name())
  382. // Quantizes per layer
  383. // Save total quantized tensors
  384. if err := llm.Quantize(blob, temp.Name(), want, fn); err != nil {
  385. return err
  386. }
  387. layer, err := NewLayer(temp, baseLayer.MediaType)
  388. if err != nil {
  389. return err
  390. }
  391. if _, err := temp.Seek(0, io.SeekStart); err != nil {
  392. return err
  393. }
  394. ggml, _, err := llm.DecodeGGML(temp, 0)
  395. if err != nil {
  396. return err
  397. }
  398. baseLayer.Layer = layer
  399. baseLayer.GGML = ggml
  400. }
  401. fn(api.ProgressResponse{
  402. Status: "quantizing model done",
  403. Quantize: quantization,
  404. })
  405. }
  406. if baseLayer.GGML != nil {
  407. config.ModelFormat = cmp.Or(config.ModelFormat, baseLayer.GGML.Name())
  408. config.ModelFamily = cmp.Or(config.ModelFamily, baseLayer.GGML.KV().Architecture())
  409. config.ModelType = cmp.Or(config.ModelType, format.HumanNumber(baseLayer.GGML.KV().ParameterCount()))
  410. config.FileType = cmp.Or(config.FileType, baseLayer.GGML.KV().FileType().String())
  411. config.ModelFamilies = append(config.ModelFamilies, baseLayer.GGML.KV().Architecture())
  412. }
  413. /* fn(api.ProgressResponse{
  414. Status: fmt.Sprintf("quantizing model %d%%", i*100/layerCount),
  415. Quantize: quantization,
  416. }) */
  417. layers = append(layers, baseLayer.Layer)
  418. }
  419. case "license", "template", "system":
  420. if c.Name != "license" {
  421. // replace
  422. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  423. if layer.MediaType != mediatype {
  424. return false
  425. }
  426. if err := layer.Remove(); err != nil {
  427. return false
  428. }
  429. return true
  430. })
  431. }
  432. blob := strings.NewReader(c.Args)
  433. layer, err := NewLayer(blob, mediatype)
  434. if err != nil {
  435. return err
  436. }
  437. layers = append(layers, layer)
  438. case "message":
  439. role, content, ok := strings.Cut(c.Args, ": ")
  440. if !ok {
  441. return fmt.Errorf("invalid message: %s", c.Args)
  442. }
  443. messages = append(messages, &api.Message{Role: role, Content: content})
  444. default:
  445. ps, err := api.FormatParams(map[string][]string{c.Name: {c.Args}})
  446. if err != nil {
  447. return err
  448. }
  449. for k, v := range ps {
  450. if ks, ok := parameters[k].([]string); ok {
  451. parameters[k] = append(ks, v.([]string)...)
  452. } else if vs, ok := v.([]string); ok {
  453. parameters[k] = vs
  454. } else {
  455. parameters[k] = v
  456. }
  457. }
  458. }
  459. }
  460. var err2 error
  461. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  462. switch layer.MediaType {
  463. case "application/vnd.ollama.image.message":
  464. // if there are new messages, remove the inherited ones
  465. if len(messages) > 0 {
  466. return true
  467. }
  468. return false
  469. case "application/vnd.ollama.image.params":
  470. // merge inherited parameters with new ones
  471. r, err := layer.Open()
  472. if err != nil {
  473. err2 = err
  474. return false
  475. }
  476. defer r.Close()
  477. var ps map[string]any
  478. if err := json.NewDecoder(r).Decode(&ps); err != nil {
  479. err2 = err
  480. return false
  481. }
  482. for k, v := range ps {
  483. if _, ok := parameters[k]; !ok {
  484. parameters[k] = v
  485. }
  486. }
  487. return true
  488. default:
  489. return false
  490. }
  491. })
  492. if err2 != nil {
  493. return err2
  494. }
  495. if len(messages) > 0 {
  496. var b bytes.Buffer
  497. if err := json.NewEncoder(&b).Encode(messages); err != nil {
  498. return err
  499. }
  500. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  501. if err != nil {
  502. return err
  503. }
  504. layers = append(layers, layer)
  505. }
  506. if len(parameters) > 0 {
  507. var b bytes.Buffer
  508. if err := json.NewEncoder(&b).Encode(parameters); err != nil {
  509. return err
  510. }
  511. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  512. if err != nil {
  513. return err
  514. }
  515. layers = append(layers, layer)
  516. }
  517. digests := make([]string, len(layers))
  518. for i, layer := range layers {
  519. digests[i] = layer.Digest
  520. }
  521. config.RootFS.DiffIDs = digests
  522. var b bytes.Buffer
  523. if err := json.NewEncoder(&b).Encode(config); err != nil {
  524. return err
  525. }
  526. layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  527. if err != nil {
  528. return err
  529. }
  530. for _, layer := range append(layers, layer) {
  531. if layer.status != "" {
  532. fn(api.ProgressResponse{Status: layer.status})
  533. }
  534. }
  535. old, _ := ParseNamedManifest(name)
  536. fn(api.ProgressResponse{Status: "writing manifest"})
  537. if err := WriteManifest(name, layer, layers); err != nil {
  538. return err
  539. }
  540. if !envconfig.NoPrune && old != nil {
  541. if err := old.RemoveLayers(); err != nil {
  542. return err
  543. }
  544. }
  545. fn(api.ProgressResponse{Status: "success"})
  546. return nil
  547. }
  548. func CopyModel(src, dst model.Name) error {
  549. if !dst.IsFullyQualified() {
  550. return model.Unqualified(dst)
  551. }
  552. if !src.IsFullyQualified() {
  553. return model.Unqualified(src)
  554. }
  555. if src.Filepath() == dst.Filepath() {
  556. return nil
  557. }
  558. manifests, err := GetManifestPath()
  559. if err != nil {
  560. return err
  561. }
  562. dstpath := filepath.Join(manifests, dst.Filepath())
  563. if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
  564. return err
  565. }
  566. srcpath := filepath.Join(manifests, src.Filepath())
  567. srcfile, err := os.Open(srcpath)
  568. if err != nil {
  569. return err
  570. }
  571. defer srcfile.Close()
  572. dstfile, err := os.Create(dstpath)
  573. if err != nil {
  574. return err
  575. }
  576. defer dstfile.Close()
  577. _, err = io.Copy(dstfile, srcfile)
  578. return err
  579. }
  580. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}) error {
  581. fp, err := GetManifestPath()
  582. if err != nil {
  583. return err
  584. }
  585. walkFunc := func(path string, info os.FileInfo, _ error) error {
  586. if info.IsDir() {
  587. return nil
  588. }
  589. dir, file := filepath.Split(path)
  590. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  591. tag := strings.Join([]string{dir, file}, ":")
  592. fmp := ParseModelPath(tag)
  593. // skip the manifest we're trying to delete
  594. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  595. return nil
  596. }
  597. // save (i.e. delete from the deleteMap) any files used in other manifests
  598. manifest, _, err := GetManifest(fmp)
  599. if err != nil {
  600. //nolint:nilerr
  601. return nil
  602. }
  603. for _, layer := range manifest.Layers {
  604. delete(deleteMap, layer.Digest)
  605. }
  606. delete(deleteMap, manifest.Config.Digest)
  607. return nil
  608. }
  609. if err := filepath.Walk(fp, walkFunc); err != nil {
  610. return err
  611. }
  612. // only delete the files which are still in the deleteMap
  613. for k := range deleteMap {
  614. fp, err := GetBlobsPath(k)
  615. if err != nil {
  616. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  617. continue
  618. }
  619. if err := os.Remove(fp); err != nil {
  620. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  621. continue
  622. }
  623. }
  624. return nil
  625. }
  626. func PruneLayers() error {
  627. deleteMap := make(map[string]struct{})
  628. p, err := GetBlobsPath("")
  629. if err != nil {
  630. return err
  631. }
  632. blobs, err := os.ReadDir(p)
  633. if err != nil {
  634. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  635. return err
  636. }
  637. for _, blob := range blobs {
  638. name := blob.Name()
  639. name = strings.ReplaceAll(name, "-", ":")
  640. _, err := GetBlobsPath(name)
  641. if err != nil {
  642. if errors.Is(err, ErrInvalidDigestFormat) {
  643. // remove invalid blobs (e.g. partial downloads)
  644. if err := os.Remove(filepath.Join(p, blob.Name())); err != nil {
  645. slog.Error("couldn't remove blob", "blob", blob.Name(), "error", err)
  646. }
  647. }
  648. continue
  649. }
  650. deleteMap[name] = struct{}{}
  651. }
  652. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  653. err = deleteUnusedLayers(nil, deleteMap)
  654. if err != nil {
  655. return err
  656. }
  657. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  658. return nil
  659. }
  660. func PruneDirectory(path string) error {
  661. info, err := os.Lstat(path)
  662. if err != nil {
  663. return err
  664. }
  665. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  666. entries, err := os.ReadDir(path)
  667. if err != nil {
  668. return err
  669. }
  670. for _, entry := range entries {
  671. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  672. return err
  673. }
  674. }
  675. entries, err = os.ReadDir(path)
  676. if err != nil {
  677. return err
  678. }
  679. if len(entries) > 0 {
  680. return nil
  681. }
  682. return os.Remove(path)
  683. }
  684. return nil
  685. }
  686. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  687. mp := ParseModelPath(name)
  688. fn(api.ProgressResponse{Status: "retrieving manifest"})
  689. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  690. return fmt.Errorf("insecure protocol http")
  691. }
  692. manifest, _, err := GetManifest(mp)
  693. if err != nil {
  694. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  695. return err
  696. }
  697. var layers []*Layer
  698. layers = append(layers, manifest.Layers...)
  699. layers = append(layers, manifest.Config)
  700. for _, layer := range layers {
  701. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  702. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  703. return err
  704. }
  705. }
  706. fn(api.ProgressResponse{Status: "pushing manifest"})
  707. requestURL := mp.BaseURL()
  708. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  709. manifestJSON, err := json.Marshal(manifest)
  710. if err != nil {
  711. return err
  712. }
  713. headers := make(http.Header)
  714. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  715. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  716. if err != nil {
  717. return err
  718. }
  719. defer resp.Body.Close()
  720. fn(api.ProgressResponse{Status: "success"})
  721. return nil
  722. }
  723. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  724. mp := ParseModelPath(name)
  725. var manifest *Manifest
  726. var err error
  727. var noprune string
  728. // build deleteMap to prune unused layers
  729. deleteMap := make(map[string]struct{})
  730. if !envconfig.NoPrune {
  731. manifest, _, err = GetManifest(mp)
  732. if err != nil && !errors.Is(err, os.ErrNotExist) {
  733. return err
  734. }
  735. if manifest != nil {
  736. for _, l := range manifest.Layers {
  737. deleteMap[l.Digest] = struct{}{}
  738. }
  739. deleteMap[manifest.Config.Digest] = struct{}{}
  740. }
  741. }
  742. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  743. return fmt.Errorf("insecure protocol http")
  744. }
  745. fn(api.ProgressResponse{Status: "pulling manifest"})
  746. manifest, err = pullModelManifest(ctx, mp, regOpts)
  747. if err != nil {
  748. return fmt.Errorf("pull model manifest: %s", err)
  749. }
  750. var layers []*Layer
  751. layers = append(layers, manifest.Layers...)
  752. layers = append(layers, manifest.Config)
  753. skipVerify := make(map[string]bool)
  754. for _, layer := range layers {
  755. cacheHit, err := downloadBlob(ctx, downloadOpts{
  756. mp: mp,
  757. digest: layer.Digest,
  758. regOpts: regOpts,
  759. fn: fn,
  760. })
  761. if err != nil {
  762. return err
  763. }
  764. skipVerify[layer.Digest] = cacheHit
  765. delete(deleteMap, layer.Digest)
  766. }
  767. delete(deleteMap, manifest.Config.Digest)
  768. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  769. for _, layer := range layers {
  770. if skipVerify[layer.Digest] {
  771. continue
  772. }
  773. if err := verifyBlob(layer.Digest); err != nil {
  774. if errors.Is(err, errDigestMismatch) {
  775. // something went wrong, delete the blob
  776. fp, err := GetBlobsPath(layer.Digest)
  777. if err != nil {
  778. return err
  779. }
  780. if err := os.Remove(fp); err != nil {
  781. // log this, but return the original error
  782. slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
  783. }
  784. }
  785. return err
  786. }
  787. }
  788. fn(api.ProgressResponse{Status: "writing manifest"})
  789. manifestJSON, err := json.Marshal(manifest)
  790. if err != nil {
  791. return err
  792. }
  793. fp, err := mp.GetManifestPath()
  794. if err != nil {
  795. return err
  796. }
  797. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  798. return err
  799. }
  800. err = os.WriteFile(fp, manifestJSON, 0o644)
  801. if err != nil {
  802. slog.Info(fmt.Sprintf("couldn't write to %s", fp))
  803. return err
  804. }
  805. if noprune == "" {
  806. fn(api.ProgressResponse{Status: "removing any unused layers"})
  807. err = deleteUnusedLayers(nil, deleteMap)
  808. if err != nil {
  809. return err
  810. }
  811. }
  812. fn(api.ProgressResponse{Status: "success"})
  813. return nil
  814. }
  815. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *registryOptions) (*Manifest, error) {
  816. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  817. headers := make(http.Header)
  818. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  819. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  820. if err != nil {
  821. return nil, err
  822. }
  823. defer resp.Body.Close()
  824. var m *Manifest
  825. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  826. return nil, err
  827. }
  828. return m, err
  829. }
  830. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  831. func GetSHA256Digest(r io.Reader) (string, int64) {
  832. h := sha256.New()
  833. n, err := io.Copy(h, r)
  834. if err != nil {
  835. log.Fatal(err)
  836. }
  837. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  838. }
  839. var errUnauthorized = fmt.Errorf("unauthorized: access denied")
  840. // getTokenSubject returns the subject of a JWT token, it does not validate the token
  841. func getTokenSubject(token string) string {
  842. parts := strings.Split(token, ".")
  843. if len(parts) != 3 {
  844. return ""
  845. }
  846. payload := parts[1]
  847. payloadBytes, err := base64.RawURLEncoding.DecodeString(payload)
  848. if err != nil {
  849. slog.Error(fmt.Sprintf("failed to decode jwt payload: %v", err))
  850. return ""
  851. }
  852. var payloadMap map[string]interface{}
  853. if err := json.Unmarshal(payloadBytes, &payloadMap); err != nil {
  854. slog.Error(fmt.Sprintf("failed to unmarshal payload JSON: %v", err))
  855. return ""
  856. }
  857. sub, ok := payloadMap["sub"]
  858. if !ok {
  859. slog.Error("jwt does not contain 'sub' field")
  860. return ""
  861. }
  862. return fmt.Sprintf("%s", sub)
  863. }
  864. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  865. anonymous := true // access will default to anonymous if no user is found associated with the public key
  866. for range 2 {
  867. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  868. if err != nil {
  869. if !errors.Is(err, context.Canceled) {
  870. slog.Info(fmt.Sprintf("request failed: %v", err))
  871. }
  872. return nil, err
  873. }
  874. switch {
  875. case resp.StatusCode == http.StatusUnauthorized:
  876. // Handle authentication error with one retry
  877. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  878. token, err := getAuthorizationToken(ctx, challenge)
  879. if err != nil {
  880. return nil, err
  881. }
  882. anonymous = getTokenSubject(token) == "anonymous"
  883. regOpts.Token = token
  884. if body != nil {
  885. _, err = body.Seek(0, io.SeekStart)
  886. if err != nil {
  887. return nil, err
  888. }
  889. }
  890. case resp.StatusCode == http.StatusNotFound:
  891. return nil, os.ErrNotExist
  892. case resp.StatusCode >= http.StatusBadRequest:
  893. responseBody, err := io.ReadAll(resp.Body)
  894. if err != nil {
  895. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  896. }
  897. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  898. default:
  899. return resp, nil
  900. }
  901. }
  902. if anonymous {
  903. // no user is associated with the public key, and the request requires non-anonymous access
  904. pubKey, nestedErr := auth.GetPublicKey()
  905. localPubKey := strings.TrimSpace(string(ssh.MarshalAuthorizedKey(pubKey)))
  906. if nestedErr != nil {
  907. slog.Error(fmt.Sprintf("couldn't get public key: %v", nestedErr))
  908. return nil, errUnauthorized
  909. }
  910. return nil, &errtypes.UnknownOllamaKey{Key: localPubKey}
  911. }
  912. // user is associated with the public key, but is not authorized to make the request
  913. return nil, errUnauthorized
  914. }
  915. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  916. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  917. requestURL.Scheme = "http"
  918. }
  919. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  920. if err != nil {
  921. return nil, err
  922. }
  923. if headers != nil {
  924. req.Header = headers
  925. }
  926. if regOpts != nil {
  927. if regOpts.Token != "" {
  928. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  929. } else if regOpts.Username != "" && regOpts.Password != "" {
  930. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  931. }
  932. }
  933. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  934. if s := req.Header.Get("Content-Length"); s != "" {
  935. contentLength, err := strconv.ParseInt(s, 10, 64)
  936. if err != nil {
  937. return nil, err
  938. }
  939. req.ContentLength = contentLength
  940. }
  941. resp, err := http.DefaultClient.Do(req)
  942. if err != nil {
  943. return nil, err
  944. }
  945. return resp, nil
  946. }
  947. func getValue(header, key string) string {
  948. startIdx := strings.Index(header, key+"=")
  949. if startIdx == -1 {
  950. return ""
  951. }
  952. // Move the index to the starting quote after the key.
  953. startIdx += len(key) + 2
  954. endIdx := startIdx
  955. for endIdx < len(header) {
  956. if header[endIdx] == '"' {
  957. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  958. endIdx++
  959. continue
  960. }
  961. break
  962. }
  963. endIdx++
  964. }
  965. return header[startIdx:endIdx]
  966. }
  967. func parseRegistryChallenge(authStr string) registryChallenge {
  968. authStr = strings.TrimPrefix(authStr, "Bearer ")
  969. return registryChallenge{
  970. Realm: getValue(authStr, "realm"),
  971. Service: getValue(authStr, "service"),
  972. Scope: getValue(authStr, "scope"),
  973. }
  974. }
  975. var errDigestMismatch = errors.New("digest mismatch, file must be downloaded again")
  976. func verifyBlob(digest string) error {
  977. fp, err := GetBlobsPath(digest)
  978. if err != nil {
  979. return err
  980. }
  981. f, err := os.Open(fp)
  982. if err != nil {
  983. return err
  984. }
  985. defer f.Close()
  986. fileDigest, _ := GetSHA256Digest(f)
  987. if digest != fileDigest {
  988. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  989. }
  990. return nil
  991. }