images.go 27 KB

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