images.go 28 KB

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