images.go 28 KB

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