images.go 29 KB

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