images.go 30 KB

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