images.go 27 KB

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