images.go 28 KB

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