images.go 28 KB

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