images.go 28 KB

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