images.go 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289
  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.Intermediate = true
  348. metadataLayer.MergeBase = baseLayer.Digest
  349. layers = append(layers, metadataLayer)
  350. metadataPath, err := GetBlobsPath(metadataLayer.Digest)
  351. if err != nil {
  352. return err
  353. }
  354. defer os.Remove(metadataPath)
  355. stat, err := f.Stat()
  356. if err != nil {
  357. return err
  358. }
  359. data := io.NewSectionReader(f, baseLayer.GGML.Offset(), stat.Size())
  360. dataLayer, err := NewLayer(data, "application/vnd.ollama.image.model+data")
  361. if err != nil {
  362. return err
  363. }
  364. dataLayer.Intermediate = true
  365. dataLayer.MergeBase = baseLayer.Digest
  366. layers = append(layers, dataLayer)
  367. dataPath, err := GetBlobsPath(dataLayer.Digest)
  368. if err != nil {
  369. return err
  370. }
  371. defer os.Remove(dataPath)
  372. continue
  373. }
  374. layers = append(layers, baseLayer.Layer)
  375. }
  376. case "license", "template", "system":
  377. blob := strings.NewReader(c.Args)
  378. layer, err := NewLayer(blob, mediatype)
  379. if err != nil {
  380. return err
  381. }
  382. if c.Name != "license" {
  383. // replace
  384. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  385. return layer.MediaType == mediatype
  386. })
  387. }
  388. layers = append(layers, layer)
  389. case "message":
  390. role, content, ok := strings.Cut(c.Args, ": ")
  391. if !ok {
  392. return fmt.Errorf("invalid message: %s", c.Args)
  393. }
  394. messages = append(messages, &api.Message{Role: role, Content: content})
  395. default:
  396. ps, err := api.FormatParams(map[string][]string{c.Name: {c.Args}})
  397. if err != nil {
  398. return err
  399. }
  400. for k, v := range ps {
  401. if ks, ok := parameters[k].([]string); ok {
  402. parameters[k] = append(ks, v.([]string)...)
  403. } else if vs, ok := v.([]string); ok {
  404. parameters[k] = vs
  405. } else {
  406. parameters[k] = v
  407. }
  408. }
  409. }
  410. }
  411. var err2 error
  412. layers = slices.DeleteFunc(layers, func(layer *Layer) bool {
  413. switch layer.MediaType {
  414. case "application/vnd.ollama.image.message":
  415. // if there are new messages, remove the inherited ones
  416. if len(messages) > 0 {
  417. return true
  418. }
  419. return false
  420. case "application/vnd.ollama.image.params":
  421. // merge inherited parameters with new ones
  422. r, err := layer.Open()
  423. if err != nil {
  424. err2 = err
  425. return false
  426. }
  427. defer r.Close()
  428. var ps map[string]any
  429. if err := json.NewDecoder(r).Decode(&ps); err != nil {
  430. err2 = err
  431. return false
  432. }
  433. for k, v := range ps {
  434. if _, ok := parameters[k]; !ok {
  435. parameters[k] = v
  436. }
  437. }
  438. return true
  439. default:
  440. return false
  441. }
  442. })
  443. if err2 != nil {
  444. return err2
  445. }
  446. if len(messages) > 0 {
  447. var b bytes.Buffer
  448. if err := json.NewEncoder(&b).Encode(messages); err != nil {
  449. return err
  450. }
  451. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  452. if err != nil {
  453. return err
  454. }
  455. layers = append(layers, layer)
  456. }
  457. if len(parameters) > 0 {
  458. var b bytes.Buffer
  459. if err := json.NewEncoder(&b).Encode(parameters); err != nil {
  460. return err
  461. }
  462. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  463. if err != nil {
  464. return err
  465. }
  466. layers = append(layers, layer)
  467. }
  468. digests := make([]string, len(layers))
  469. for i, layer := range layers {
  470. digests[i] = layer.Digest
  471. }
  472. config.RootFS.DiffIDs = digests
  473. var b bytes.Buffer
  474. if err := json.NewEncoder(&b).Encode(config); err != nil {
  475. return err
  476. }
  477. layer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  478. if err != nil {
  479. return err
  480. }
  481. for _, layer := range append(layers, layer) {
  482. if layer.message != "" {
  483. fn(api.ProgressResponse{Status: layer.message})
  484. }
  485. }
  486. unref := make(map[string]struct{})
  487. if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
  488. for _, layer := range manifest.Layers {
  489. if !slices.Contains(digests, layer.Digest) {
  490. unref[layer.Digest] = struct{}{}
  491. }
  492. }
  493. if manifest.Config.Digest != layer.Digest {
  494. unref[manifest.Config.Digest] = struct{}{}
  495. }
  496. }
  497. fn(api.ProgressResponse{Status: "writing manifest"})
  498. if err := WriteManifest(name, layer, layers); err != nil {
  499. return err
  500. }
  501. if os.Getenv("OLLAMA_NOPRUNE") == "" && len(unref) > 0 {
  502. fn(api.ProgressResponse{Status: "removing unused layers"})
  503. if err := deleteUnusedLayers(nil, unref, false); err != nil {
  504. return err
  505. }
  506. }
  507. fn(api.ProgressResponse{Status: "success"})
  508. return nil
  509. }
  510. func CopyModel(src, dst model.Name) error {
  511. if !dst.IsFullyQualified() {
  512. return model.Unqualified(dst)
  513. }
  514. if !src.IsFullyQualified() {
  515. return model.Unqualified(src)
  516. }
  517. if src.Filepath() == dst.Filepath() {
  518. return nil
  519. }
  520. manifests, err := GetManifestPath()
  521. if err != nil {
  522. return err
  523. }
  524. dstpath := filepath.Join(manifests, dst.Filepath())
  525. if err := os.MkdirAll(filepath.Dir(dstpath), 0o755); err != nil {
  526. return err
  527. }
  528. srcpath := filepath.Join(manifests, src.Filepath())
  529. srcfile, err := os.Open(srcpath)
  530. if err != nil {
  531. return err
  532. }
  533. defer srcfile.Close()
  534. dstfile, err := os.Create(dstpath)
  535. if err != nil {
  536. return err
  537. }
  538. defer dstfile.Close()
  539. _, err = io.Copy(dstfile, srcfile)
  540. return err
  541. }
  542. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  543. fp, err := GetManifestPath()
  544. if err != nil {
  545. return err
  546. }
  547. walkFunc := func(path string, info os.FileInfo, _ error) error {
  548. if info.IsDir() {
  549. return nil
  550. }
  551. dir, file := filepath.Split(path)
  552. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  553. tag := strings.Join([]string{dir, file}, ":")
  554. fmp := ParseModelPath(tag)
  555. // skip the manifest we're trying to delete
  556. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  557. return nil
  558. }
  559. // save (i.e. delete from the deleteMap) any files used in other manifests
  560. manifest, _, err := GetManifest(fmp)
  561. if err != nil {
  562. // nolint: nilerr
  563. return nil
  564. }
  565. for _, layer := range manifest.Layers {
  566. delete(deleteMap, layer.Digest)
  567. if layer.MergeBase != "" {
  568. delete(deleteMap, layer.MergeBase)
  569. }
  570. }
  571. delete(deleteMap, manifest.Config.Digest)
  572. return nil
  573. }
  574. if err := filepath.Walk(fp, walkFunc); err != nil {
  575. return err
  576. }
  577. // only delete the files which are still in the deleteMap
  578. for k := range deleteMap {
  579. fp, err := GetBlobsPath(k)
  580. if err != nil {
  581. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  582. continue
  583. }
  584. if !dryRun {
  585. if err := os.Remove(fp); err != nil {
  586. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  587. continue
  588. }
  589. } else {
  590. slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
  591. }
  592. }
  593. return nil
  594. }
  595. func PruneLayers() error {
  596. deleteMap := make(map[string]struct{})
  597. p, err := GetBlobsPath("")
  598. if err != nil {
  599. return err
  600. }
  601. blobs, err := os.ReadDir(p)
  602. if err != nil {
  603. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  604. return err
  605. }
  606. for _, blob := range blobs {
  607. name := blob.Name()
  608. name = strings.ReplaceAll(name, "-", ":")
  609. if strings.HasPrefix(name, "sha256:") {
  610. deleteMap[name] = struct{}{}
  611. }
  612. }
  613. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  614. err = deleteUnusedLayers(nil, deleteMap, false)
  615. if err != nil {
  616. return err
  617. }
  618. slog.Info(fmt.Sprintf("total unused blobs removed: %d", len(deleteMap)))
  619. return nil
  620. }
  621. func PruneDirectory(path string) error {
  622. info, err := os.Lstat(path)
  623. if err != nil {
  624. return err
  625. }
  626. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  627. entries, err := os.ReadDir(path)
  628. if err != nil {
  629. return err
  630. }
  631. for _, entry := range entries {
  632. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  633. return err
  634. }
  635. }
  636. entries, err = os.ReadDir(path)
  637. if err != nil {
  638. return err
  639. }
  640. if len(entries) > 0 {
  641. return nil
  642. }
  643. return os.Remove(path)
  644. }
  645. return nil
  646. }
  647. func DeleteModel(name string) error {
  648. mp := ParseModelPath(name)
  649. manifest, _, err := GetManifest(mp)
  650. if err != nil {
  651. return err
  652. }
  653. deleteMap := make(map[string]struct{})
  654. for _, layer := range manifest.Layers {
  655. deleteMap[layer.Digest] = struct{}{}
  656. if layer.MergeBase != "" {
  657. deleteMap[layer.MergeBase] = struct{}{}
  658. }
  659. }
  660. deleteMap[manifest.Config.Digest] = struct{}{}
  661. err = deleteUnusedLayers(&mp, deleteMap, false)
  662. if err != nil {
  663. return err
  664. }
  665. fp, err := mp.GetManifestPath()
  666. if err != nil {
  667. return err
  668. }
  669. err = os.Remove(fp)
  670. if err != nil {
  671. slog.Info(fmt.Sprintf("couldn't remove manifest file '%s': %v", fp, err))
  672. return err
  673. }
  674. return nil
  675. }
  676. func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  677. mp := ParseModelPath(name)
  678. fn(api.ProgressResponse{Status: "retrieving manifest"})
  679. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  680. return fmt.Errorf("insecure protocol http")
  681. }
  682. manifest, _, err := GetManifest(mp)
  683. if err != nil {
  684. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  685. return err
  686. }
  687. var layers []*Layer
  688. layers = append(layers, manifest.Layers...)
  689. layers = append(layers, manifest.Config)
  690. for _, layer := range layers {
  691. if !layer.Intermediate {
  692. continue
  693. }
  694. switch layer.MediaType {
  695. case "application/vnd.ollama.image.model+metadata", "application/vnd.ollama.image.model+data":
  696. if _, err := GetBlobsPath(layer.MergeBase); errors.Is(err, os.ErrNotExist) {
  697. filename, err := GetBlobsPath(layer.MergeBase)
  698. if err != nil {
  699. return err
  700. }
  701. f, err := os.Open(filename)
  702. if err != nil {
  703. return err
  704. }
  705. defer f.Close()
  706. ggml, size, err := llm.DecodeGGML(f)
  707. if err != nil {
  708. return err
  709. }
  710. if _, err := f.Seek(0, io.SeekStart); err != nil {
  711. return err
  712. }
  713. metadata := io.NewSectionReader(f, 0, ggml.Offset())
  714. if _, err := NewLayer(metadata, "application/vnd.ollama.image.model+metadata"); err != nil {
  715. return err
  716. }
  717. data := io.NewSectionReader(f, ggml.Offset(), size)
  718. if _, err := NewLayer(data, "application/vnd.ollama.image.model+metadata"); err != nil {
  719. return err
  720. }
  721. } else if err != nil {
  722. return err
  723. }
  724. }
  725. }
  726. for _, layer := range layers {
  727. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  728. slog.Info(fmt.Sprintf("error uploading blob: %v", err))
  729. return err
  730. }
  731. }
  732. fn(api.ProgressResponse{Status: "pushing manifest"})
  733. requestURL := mp.BaseURL()
  734. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  735. manifestJSON, err := json.Marshal(manifest)
  736. if err != nil {
  737. return err
  738. }
  739. headers := make(http.Header)
  740. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  741. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  742. if err != nil {
  743. return err
  744. }
  745. defer resp.Body.Close()
  746. fn(api.ProgressResponse{Status: "success"})
  747. return nil
  748. }
  749. func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error {
  750. mp := ParseModelPath(name)
  751. var manifest *ManifestV2
  752. var err error
  753. var noprune string
  754. // build deleteMap to prune unused layers
  755. deleteMap := make(map[string]struct{})
  756. if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  757. manifest, _, err = GetManifest(mp)
  758. if err != nil && !errors.Is(err, os.ErrNotExist) {
  759. return err
  760. }
  761. if manifest != nil {
  762. for _, l := range manifest.Layers {
  763. deleteMap[l.Digest] = struct{}{}
  764. }
  765. deleteMap[manifest.Config.Digest] = struct{}{}
  766. }
  767. }
  768. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  769. return fmt.Errorf("insecure protocol http")
  770. }
  771. fn(api.ProgressResponse{Status: "pulling manifest"})
  772. manifest, err = pullModelManifest(ctx, mp, regOpts)
  773. if err != nil {
  774. return fmt.Errorf("pull model manifest: %s", err)
  775. }
  776. var layers []*Layer
  777. layers = append(layers, manifest.Layers...)
  778. layers = append(layers, manifest.Config)
  779. for _, layer := range layers {
  780. if layer.Intermediate {
  781. filename, err := GetBlobsPath(layer.MergeBase)
  782. if err != nil {
  783. return err
  784. }
  785. if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
  786. // pass
  787. } else if err != nil {
  788. return err
  789. } else {
  790. fn(api.ProgressResponse{
  791. Status: fmt.Sprintf("pulling %s", layer.Digest[7:19]),
  792. Digest: layer.Digest,
  793. Total: layer.Size,
  794. Completed: layer.Size,
  795. })
  796. continue
  797. }
  798. }
  799. if err := downloadBlob(
  800. ctx,
  801. downloadOpts{
  802. mp: mp,
  803. digest: layer.Digest,
  804. regOpts: regOpts,
  805. fn: fn,
  806. }); err != nil {
  807. return err
  808. }
  809. delete(deleteMap, layer.Digest)
  810. }
  811. delete(deleteMap, manifest.Config.Digest)
  812. type mergedLayer struct {
  813. Metadata, Data *Layer
  814. }
  815. mergedLayers := make(map[string]mergedLayer)
  816. for _, layer := range manifest.Layers {
  817. filename, err := GetBlobsPath(layer.MergeBase)
  818. if err != nil {
  819. return err
  820. }
  821. if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
  822. merged := mergedLayers[layer.MergeBase]
  823. if layer.MediaType == "application/vnd.ollama.image.model+metadata" {
  824. merged.Metadata = layer
  825. } else if layer.MediaType == "application/vnd.ollama.image.model+data" {
  826. merged.Data = layer
  827. } else {
  828. continue
  829. }
  830. mergedLayers[layer.MergeBase] = merged
  831. } else if err != nil {
  832. return err
  833. } else {
  834. continue
  835. }
  836. }
  837. for _, mergedLayer := range mergedLayers {
  838. fn(api.ProgressResponse{Status: "merging layers"})
  839. metadata, err := mergedLayer.Metadata.Open()
  840. if err != nil {
  841. return err
  842. }
  843. defer metadata.Close()
  844. data, err := mergedLayer.Data.Open()
  845. if err != nil {
  846. return err
  847. }
  848. defer data.Close()
  849. if _, err := NewLayer(io.MultiReader(metadata, data), "application/vnd.ollama.image.model"); err != nil {
  850. return err
  851. }
  852. }
  853. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  854. for _, layer := range layers {
  855. if err := verifyBlob(layer.Digest); errors.Is(err, os.ErrNotExist) && layer.Intermediate {
  856. // pass
  857. } else if err != nil {
  858. if errors.Is(err, errDigestMismatch) {
  859. // something went wrong, delete the blob
  860. fp, err := GetBlobsPath(layer.Digest)
  861. if err != nil {
  862. return err
  863. }
  864. if err := os.Remove(fp); err != nil {
  865. // log this, but return the original error
  866. slog.Info(fmt.Sprintf("couldn't remove file with digest mismatch '%s': %v", fp, err))
  867. }
  868. }
  869. return err
  870. }
  871. }
  872. fn(api.ProgressResponse{Status: "writing manifest"})
  873. manifestJSON, err := json.Marshal(manifest)
  874. if err != nil {
  875. return err
  876. }
  877. fp, err := mp.GetManifestPath()
  878. if err != nil {
  879. return err
  880. }
  881. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  882. return err
  883. }
  884. err = os.WriteFile(fp, manifestJSON, 0o644)
  885. if err != nil {
  886. slog.Info(fmt.Sprintf("couldn't write to %s", fp))
  887. return err
  888. }
  889. if noprune == "" {
  890. fn(api.ProgressResponse{Status: "removing any unused layers"})
  891. err = deleteUnusedLayers(nil, deleteMap, false)
  892. if err != nil {
  893. return err
  894. }
  895. }
  896. fn(api.ProgressResponse{Status: "success"})
  897. return nil
  898. }
  899. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *registryOptions) (*ManifestV2, error) {
  900. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  901. headers := make(http.Header)
  902. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  903. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  904. if err != nil {
  905. return nil, err
  906. }
  907. defer resp.Body.Close()
  908. var m *ManifestV2
  909. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  910. return nil, err
  911. }
  912. return m, err
  913. }
  914. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  915. func GetSHA256Digest(r io.Reader) (string, int64) {
  916. h := sha256.New()
  917. n, err := io.Copy(h, r)
  918. if err != nil {
  919. log.Fatal(err)
  920. }
  921. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  922. }
  923. var errUnauthorized = fmt.Errorf("unauthorized: access denied")
  924. // getTokenSubject returns the subject of a JWT token, it does not validate the token
  925. func getTokenSubject(token string) string {
  926. parts := strings.Split(token, ".")
  927. if len(parts) != 3 {
  928. slog.Error("jwt token does not contain 3 parts")
  929. return ""
  930. }
  931. payload := parts[1]
  932. payloadBytes, err := base64.RawURLEncoding.DecodeString(payload)
  933. if err != nil {
  934. slog.Error(fmt.Sprintf("failed to decode jwt payload: %v", err))
  935. return ""
  936. }
  937. var payloadMap map[string]interface{}
  938. if err := json.Unmarshal(payloadBytes, &payloadMap); err != nil {
  939. slog.Error(fmt.Sprintf("failed to unmarshal payload JSON: %v", err))
  940. return ""
  941. }
  942. sub, ok := payloadMap["sub"]
  943. if !ok {
  944. slog.Error("jwt does not contain 'sub' field")
  945. return ""
  946. }
  947. return fmt.Sprintf("%s", sub)
  948. }
  949. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  950. anonymous := true // access will default to anonymous if no user is found associated with the public key
  951. for i := 0; i < 2; i++ {
  952. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  953. if err != nil {
  954. if !errors.Is(err, context.Canceled) {
  955. slog.Info(fmt.Sprintf("request failed: %v", err))
  956. }
  957. return nil, err
  958. }
  959. switch {
  960. case resp.StatusCode == http.StatusUnauthorized:
  961. // Handle authentication error with one retry
  962. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  963. token, err := getAuthorizationToken(ctx, challenge)
  964. if err != nil {
  965. return nil, err
  966. }
  967. anonymous = getTokenSubject(token) == "anonymous"
  968. regOpts.Token = token
  969. if body != nil {
  970. _, err = body.Seek(0, io.SeekStart)
  971. if err != nil {
  972. return nil, err
  973. }
  974. }
  975. case resp.StatusCode == http.StatusNotFound:
  976. return nil, os.ErrNotExist
  977. case resp.StatusCode >= http.StatusBadRequest:
  978. responseBody, err := io.ReadAll(resp.Body)
  979. if err != nil {
  980. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  981. }
  982. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  983. default:
  984. return resp, nil
  985. }
  986. }
  987. if anonymous {
  988. // no user is associated with the public key, and the request requires non-anonymous access
  989. pubKey, nestedErr := auth.GetPublicKey()
  990. if nestedErr != nil {
  991. slog.Error(fmt.Sprintf("couldn't get public key: %v", nestedErr))
  992. return nil, errUnauthorized
  993. }
  994. return nil, &errtypes.UnknownOllamaKey{Key: pubKey}
  995. }
  996. // user is associated with the public key, but is not authorized to make the request
  997. return nil, errUnauthorized
  998. }
  999. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  1000. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  1001. requestURL.Scheme = "http"
  1002. }
  1003. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  1004. if err != nil {
  1005. return nil, err
  1006. }
  1007. if headers != nil {
  1008. req.Header = headers
  1009. }
  1010. if regOpts != nil {
  1011. if regOpts.Token != "" {
  1012. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  1013. } else if regOpts.Username != "" && regOpts.Password != "" {
  1014. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  1015. }
  1016. }
  1017. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  1018. if s := req.Header.Get("Content-Length"); s != "" {
  1019. contentLength, err := strconv.ParseInt(s, 10, 64)
  1020. if err != nil {
  1021. return nil, err
  1022. }
  1023. req.ContentLength = contentLength
  1024. }
  1025. resp, err := http.DefaultClient.Do(req)
  1026. if err != nil {
  1027. return nil, err
  1028. }
  1029. return resp, nil
  1030. }
  1031. func getValue(header, key string) string {
  1032. startIdx := strings.Index(header, key+"=")
  1033. if startIdx == -1 {
  1034. return ""
  1035. }
  1036. // Move the index to the starting quote after the key.
  1037. startIdx += len(key) + 2
  1038. endIdx := startIdx
  1039. for endIdx < len(header) {
  1040. if header[endIdx] == '"' {
  1041. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  1042. endIdx++
  1043. continue
  1044. }
  1045. break
  1046. }
  1047. endIdx++
  1048. }
  1049. return header[startIdx:endIdx]
  1050. }
  1051. func parseRegistryChallenge(authStr string) registryChallenge {
  1052. authStr = strings.TrimPrefix(authStr, "Bearer ")
  1053. return registryChallenge{
  1054. Realm: getValue(authStr, "realm"),
  1055. Service: getValue(authStr, "service"),
  1056. Scope: getValue(authStr, "scope"),
  1057. }
  1058. }
  1059. var errDigestMismatch = errors.New("digest mismatch, file must be downloaded again")
  1060. func verifyBlob(digest string) error {
  1061. fp, err := GetBlobsPath(digest)
  1062. if err != nil {
  1063. return err
  1064. }
  1065. f, err := os.Open(fp)
  1066. if err != nil {
  1067. return err
  1068. }
  1069. defer f.Close()
  1070. fileDigest, _ := GetSHA256Digest(f)
  1071. if digest != fileDigest {
  1072. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  1073. }
  1074. return nil
  1075. }