images.go 27 KB

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