images.go 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285
  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 still not in gguf format, error out
  409. if fromConfig.ModelFormat != "gguf" {
  410. return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
  411. }
  412. config.SetModelFormat(fromConfig.ModelFormat)
  413. config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
  414. config.SetModelType(fromConfig.ModelType)
  415. config.SetFileType(fromConfig.FileType)
  416. for _, layer := range manifest.Layers {
  417. deleteMap[layer.Digest] = struct{}{}
  418. if layer.MediaType == "application/vnd.ollama.image.params" {
  419. fromParamsPath, err := GetBlobsPath(layer.Digest)
  420. if err != nil {
  421. return err
  422. }
  423. fromParamsFile, err := os.Open(fromParamsPath)
  424. if err != nil {
  425. return err
  426. }
  427. defer fromParamsFile.Close()
  428. if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
  429. return err
  430. }
  431. }
  432. layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
  433. if err != nil {
  434. return err
  435. }
  436. layers.Add(layer)
  437. }
  438. deleteMap[manifest.Config.Digest] = struct{}{}
  439. continue
  440. }
  441. defer bin.Close()
  442. var offset int64
  443. CREATE:
  444. for {
  445. fn(api.ProgressResponse{Status: "creating model layer"})
  446. bin.Seek(offset, io.SeekStart)
  447. ggml, err := llm.DecodeGGML(bin)
  448. if err != nil {
  449. switch {
  450. case errors.Is(err, io.EOF):
  451. break CREATE
  452. case errors.Is(err, llm.ErrUnsupportedFormat):
  453. return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
  454. default:
  455. return err
  456. }
  457. }
  458. config.SetModelFormat(ggml.Name())
  459. config.SetModelFamily(ggml.ModelFamily())
  460. config.SetModelType(ggml.ModelType())
  461. config.SetFileType(ggml.FileType())
  462. mediatype := mediatype
  463. if ggml.ModelFamily() == "clip" {
  464. mediatype = "application/vnd.ollama.image.projector"
  465. }
  466. sr := io.NewSectionReader(bin, offset, ggml.Size)
  467. layer, err := NewLayer(sr, mediatype)
  468. if err != nil {
  469. return err
  470. }
  471. layers.Add(layer)
  472. offset += ggml.Size
  473. }
  474. case "adapter":
  475. if strings.HasPrefix(c.Args, "@") {
  476. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  477. if err != nil {
  478. return err
  479. }
  480. c.Args = blobPath
  481. }
  482. fn(api.ProgressResponse{Status: "creating adapter layer"})
  483. bin, err := os.Open(realpath(modelFileDir, c.Args))
  484. if err != nil {
  485. return err
  486. }
  487. defer bin.Close()
  488. layer, err := NewLayer(bin, mediatype)
  489. if err != nil {
  490. return err
  491. }
  492. layers.Add(layer)
  493. case "license":
  494. fn(api.ProgressResponse{Status: "creating license layer"})
  495. bin := strings.NewReader(c.Args)
  496. layer, err := NewLayer(bin, mediatype)
  497. if err != nil {
  498. return err
  499. }
  500. layers.Add(layer)
  501. case "template", "system":
  502. fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})
  503. bin := strings.NewReader(c.Args)
  504. layer, err := NewLayer(bin, mediatype)
  505. if err != nil {
  506. return err
  507. }
  508. layers.Replace(layer)
  509. default:
  510. params[c.Name] = append(params[c.Name], c.Args)
  511. }
  512. }
  513. if len(params) > 0 {
  514. fn(api.ProgressResponse{Status: "creating parameters layer"})
  515. formattedParams, err := api.FormatParams(params)
  516. if err != nil {
  517. return err
  518. }
  519. for k, v := range fromParams {
  520. if _, ok := formattedParams[k]; !ok {
  521. formattedParams[k] = v
  522. }
  523. }
  524. // xxx - can this be removed?
  525. if config.ModelType == "65B" {
  526. if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
  527. config.ModelType = "70B"
  528. }
  529. }
  530. var b bytes.Buffer
  531. if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
  532. return err
  533. }
  534. fn(api.ProgressResponse{Status: "creating config layer"})
  535. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  536. if err != nil {
  537. return err
  538. }
  539. layers.Replace(layer)
  540. }
  541. digests := make([]string, len(layers.items))
  542. for i, layer := range layers.items {
  543. digests[i] = layer.Digest
  544. }
  545. config.RootFS.DiffIDs = digests
  546. var b bytes.Buffer
  547. if err := json.NewEncoder(&b).Encode(config); err != nil {
  548. return err
  549. }
  550. configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  551. if err != nil {
  552. return err
  553. }
  554. delete(deleteMap, configLayer.Digest)
  555. for _, layer := range append(layers.items, configLayer) {
  556. committed, err := layer.Commit()
  557. if err != nil {
  558. return err
  559. }
  560. status := "writing layer"
  561. if !committed {
  562. status = "using already created layer"
  563. }
  564. fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
  565. delete(deleteMap, layer.Digest)
  566. }
  567. fn(api.ProgressResponse{Status: "writing manifest"})
  568. if err := WriteManifest(name, configLayer, layers.items); err != nil {
  569. return err
  570. }
  571. if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  572. if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
  573. return err
  574. }
  575. }
  576. fn(api.ProgressResponse{Status: "success"})
  577. return nil
  578. }
  579. func CopyModel(src, dest string) error {
  580. srcModelPath := ParseModelPath(src)
  581. srcPath, err := srcModelPath.GetManifestPath()
  582. if err != nil {
  583. return err
  584. }
  585. destModelPath := ParseModelPath(dest)
  586. destPath, err := destModelPath.GetManifestPath()
  587. if err != nil {
  588. return err
  589. }
  590. if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
  591. return err
  592. }
  593. // copy the file
  594. input, err := os.ReadFile(srcPath)
  595. if err != nil {
  596. fmt.Println("Error reading file:", err)
  597. return err
  598. }
  599. err = os.WriteFile(destPath, input, 0o644)
  600. if err != nil {
  601. fmt.Println("Error reading file:", err)
  602. return err
  603. }
  604. return nil
  605. }
  606. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  607. fp, err := GetManifestPath()
  608. if err != nil {
  609. return err
  610. }
  611. walkFunc := func(path string, info os.FileInfo, _ error) error {
  612. if info.IsDir() {
  613. return nil
  614. }
  615. dir, file := filepath.Split(path)
  616. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  617. tag := strings.Join([]string{dir, file}, ":")
  618. fmp := ParseModelPath(tag)
  619. // skip the manifest we're trying to delete
  620. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  621. return nil
  622. }
  623. // save (i.e. delete from the deleteMap) any files used in other manifests
  624. manifest, _, err := GetManifest(fmp)
  625. if err != nil {
  626. // nolint: nilerr
  627. return nil
  628. }
  629. for _, layer := range manifest.Layers {
  630. delete(deleteMap, layer.Digest)
  631. }
  632. delete(deleteMap, manifest.Config.Digest)
  633. return nil
  634. }
  635. if err := filepath.Walk(fp, walkFunc); err != nil {
  636. return err
  637. }
  638. // only delete the files which are still in the deleteMap
  639. for k := range deleteMap {
  640. fp, err := GetBlobsPath(k)
  641. if err != nil {
  642. log.Printf("couldn't get file path for '%s': %v", k, err)
  643. continue
  644. }
  645. if !dryRun {
  646. if err := os.Remove(fp); err != nil {
  647. log.Printf("couldn't remove file '%s': %v", fp, err)
  648. continue
  649. }
  650. } else {
  651. log.Printf("wanted to remove: %s", fp)
  652. }
  653. }
  654. return nil
  655. }
  656. func PruneLayers() error {
  657. deleteMap := make(map[string]struct{})
  658. p, err := GetBlobsPath("")
  659. if err != nil {
  660. return err
  661. }
  662. blobs, err := os.ReadDir(p)
  663. if err != nil {
  664. log.Printf("couldn't read dir '%s': %v", p, err)
  665. return err
  666. }
  667. for _, blob := range blobs {
  668. name := blob.Name()
  669. if runtime.GOOS == "windows" {
  670. name = strings.ReplaceAll(name, "-", ":")
  671. }
  672. if strings.HasPrefix(name, "sha256:") {
  673. deleteMap[name] = struct{}{}
  674. }
  675. }
  676. log.Printf("total blobs: %d", len(deleteMap))
  677. err = deleteUnusedLayers(nil, deleteMap, false)
  678. if err != nil {
  679. return err
  680. }
  681. log.Printf("total unused blobs removed: %d", len(deleteMap))
  682. return nil
  683. }
  684. func PruneDirectory(path string) error {
  685. info, err := os.Lstat(path)
  686. if err != nil {
  687. return err
  688. }
  689. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  690. entries, err := os.ReadDir(path)
  691. if err != nil {
  692. return err
  693. }
  694. for _, entry := range entries {
  695. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  696. return err
  697. }
  698. }
  699. entries, err = os.ReadDir(path)
  700. if err != nil {
  701. return err
  702. }
  703. if len(entries) > 0 {
  704. return nil
  705. }
  706. return os.Remove(path)
  707. }
  708. return nil
  709. }
  710. func DeleteModel(name string) error {
  711. mp := ParseModelPath(name)
  712. manifest, _, err := GetManifest(mp)
  713. if err != nil {
  714. return err
  715. }
  716. deleteMap := make(map[string]struct{})
  717. for _, layer := range manifest.Layers {
  718. deleteMap[layer.Digest] = struct{}{}
  719. }
  720. deleteMap[manifest.Config.Digest] = struct{}{}
  721. err = deleteUnusedLayers(&mp, deleteMap, false)
  722. if err != nil {
  723. return err
  724. }
  725. fp, err := mp.GetManifestPath()
  726. if err != nil {
  727. return err
  728. }
  729. err = os.Remove(fp)
  730. if err != nil {
  731. log.Printf("couldn't remove manifest file '%s': %v", fp, err)
  732. return err
  733. }
  734. return nil
  735. }
  736. func ShowModelfile(model *Model) (string, error) {
  737. var mt struct {
  738. *Model
  739. From string
  740. Parameters map[string][]any
  741. }
  742. mt.Parameters = make(map[string][]any)
  743. for k, v := range model.Options {
  744. if s, ok := v.([]any); ok {
  745. mt.Parameters[k] = s
  746. continue
  747. }
  748. mt.Parameters[k] = []any{v}
  749. }
  750. mt.Model = model
  751. mt.From = model.ModelPath
  752. if model.OriginalModel != "" {
  753. mt.From = model.OriginalModel
  754. }
  755. modelFile := `# Modelfile generated by "ollama show"
  756. # To build a new Modelfile based on this one, replace the FROM line with:
  757. # FROM {{ .ShortName }}
  758. FROM {{ .From }}
  759. TEMPLATE """{{ .Template }}"""
  760. {{- if .System }}
  761. SYSTEM """{{ .System }}"""
  762. {{- end }}
  763. {{- range $adapter := .AdapterPaths }}
  764. ADAPTER {{ $adapter }}
  765. {{- end }}
  766. {{- range $k, $v := .Parameters }}
  767. {{- range $parameter := $v }}
  768. PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
  769. {{- end }}
  770. {{- end }}`
  771. tmpl, err := template.New("").Parse(modelFile)
  772. if err != nil {
  773. log.Printf("error parsing template: %q", err)
  774. return "", err
  775. }
  776. var buf bytes.Buffer
  777. if err = tmpl.Execute(&buf, mt); err != nil {
  778. log.Printf("error executing template: %q", err)
  779. return "", err
  780. }
  781. return buf.String(), nil
  782. }
  783. func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  784. mp := ParseModelPath(name)
  785. fn(api.ProgressResponse{Status: "retrieving manifest"})
  786. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  787. return fmt.Errorf("insecure protocol http")
  788. }
  789. manifest, _, err := GetManifest(mp)
  790. if err != nil {
  791. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  792. return err
  793. }
  794. var layers []*Layer
  795. layers = append(layers, manifest.Layers...)
  796. layers = append(layers, manifest.Config)
  797. for _, layer := range layers {
  798. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  799. log.Printf("error uploading blob: %v", err)
  800. if errors.Is(err, errUnauthorized) {
  801. return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
  802. }
  803. return err
  804. }
  805. }
  806. fn(api.ProgressResponse{Status: "pushing manifest"})
  807. requestURL := mp.BaseURL()
  808. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  809. manifestJSON, err := json.Marshal(manifest)
  810. if err != nil {
  811. return err
  812. }
  813. headers := make(http.Header)
  814. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  815. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  816. if err != nil {
  817. return err
  818. }
  819. defer resp.Body.Close()
  820. fn(api.ProgressResponse{Status: "success"})
  821. return nil
  822. }
  823. func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  824. mp := ParseModelPath(name)
  825. var manifest *ManifestV2
  826. var err error
  827. var noprune string
  828. // build deleteMap to prune unused layers
  829. deleteMap := make(map[string]struct{})
  830. if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  831. manifest, _, err = GetManifest(mp)
  832. if err != nil && !errors.Is(err, os.ErrNotExist) {
  833. return err
  834. }
  835. if manifest != nil {
  836. for _, l := range manifest.Layers {
  837. deleteMap[l.Digest] = struct{}{}
  838. }
  839. deleteMap[manifest.Config.Digest] = struct{}{}
  840. }
  841. }
  842. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  843. return fmt.Errorf("insecure protocol http")
  844. }
  845. fn(api.ProgressResponse{Status: "pulling manifest"})
  846. manifest, err = pullModelManifest(ctx, mp, regOpts)
  847. if err != nil {
  848. return fmt.Errorf("pull model manifest: %s", err)
  849. }
  850. var layers []*Layer
  851. layers = append(layers, manifest.Layers...)
  852. layers = append(layers, manifest.Config)
  853. for _, layer := range layers {
  854. if err := downloadBlob(
  855. ctx,
  856. downloadOpts{
  857. mp: mp,
  858. digest: layer.Digest,
  859. regOpts: regOpts,
  860. fn: fn,
  861. }); err != nil {
  862. return err
  863. }
  864. delete(deleteMap, layer.Digest)
  865. }
  866. delete(deleteMap, manifest.Config.Digest)
  867. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  868. for _, layer := range layers {
  869. if err := verifyBlob(layer.Digest); err != nil {
  870. if errors.Is(err, errDigestMismatch) {
  871. // something went wrong, delete the blob
  872. fp, err := GetBlobsPath(layer.Digest)
  873. if err != nil {
  874. return err
  875. }
  876. if err := os.Remove(fp); err != nil {
  877. // log this, but return the original error
  878. log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
  879. }
  880. }
  881. return err
  882. }
  883. }
  884. fn(api.ProgressResponse{Status: "writing manifest"})
  885. manifestJSON, err := json.Marshal(manifest)
  886. if err != nil {
  887. return err
  888. }
  889. fp, err := mp.GetManifestPath()
  890. if err != nil {
  891. return err
  892. }
  893. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  894. return err
  895. }
  896. err = os.WriteFile(fp, manifestJSON, 0o644)
  897. if err != nil {
  898. log.Printf("couldn't write to %s", fp)
  899. return err
  900. }
  901. if noprune == "" {
  902. fn(api.ProgressResponse{Status: "removing any unused layers"})
  903. err = deleteUnusedLayers(nil, deleteMap, false)
  904. if err != nil {
  905. return err
  906. }
  907. }
  908. fn(api.ProgressResponse{Status: "success"})
  909. return nil
  910. }
  911. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
  912. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  913. headers := make(http.Header)
  914. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  915. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  916. if err != nil {
  917. return nil, err
  918. }
  919. defer resp.Body.Close()
  920. var m *ManifestV2
  921. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  922. return nil, err
  923. }
  924. return m, err
  925. }
  926. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  927. func GetSHA256Digest(r io.Reader) (string, int64) {
  928. h := sha256.New()
  929. n, err := io.Copy(h, r)
  930. if err != nil {
  931. log.Fatal(err)
  932. }
  933. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  934. }
  935. var errUnauthorized = fmt.Errorf("unauthorized")
  936. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
  937. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  938. if err != nil {
  939. if !errors.Is(err, context.Canceled) {
  940. log.Printf("request failed: %v", err)
  941. }
  942. return nil, err
  943. }
  944. switch {
  945. case resp.StatusCode == http.StatusUnauthorized:
  946. // Handle authentication error with one retry
  947. auth := resp.Header.Get("www-authenticate")
  948. authRedir := ParseAuthRedirectString(auth)
  949. token, err := getAuthToken(ctx, authRedir)
  950. if err != nil {
  951. return nil, err
  952. }
  953. regOpts.Token = token
  954. if body != nil {
  955. _, err = body.Seek(0, io.SeekStart)
  956. if err != nil {
  957. return nil, err
  958. }
  959. }
  960. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  961. if resp.StatusCode == http.StatusUnauthorized {
  962. return nil, errUnauthorized
  963. }
  964. return resp, err
  965. case resp.StatusCode == http.StatusNotFound:
  966. return nil, os.ErrNotExist
  967. case resp.StatusCode >= http.StatusBadRequest:
  968. responseBody, err := io.ReadAll(resp.Body)
  969. if err != nil {
  970. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  971. }
  972. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  973. }
  974. return resp, nil
  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. }