images.go 30 KB

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