images.go 29 KB

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