images.go 27 KB

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