images.go 27 KB

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