images.go 29 KB

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