images.go 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284
  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. return nil
  627. }
  628. for _, layer := range manifest.Layers {
  629. delete(deleteMap, layer.Digest)
  630. }
  631. delete(deleteMap, manifest.Config.Digest)
  632. return nil
  633. }
  634. if err := filepath.Walk(fp, walkFunc); err != nil {
  635. return err
  636. }
  637. // only delete the files which are still in the deleteMap
  638. for k := range deleteMap {
  639. fp, err := GetBlobsPath(k)
  640. if err != nil {
  641. log.Printf("couldn't get file path for '%s': %v", k, err)
  642. continue
  643. }
  644. if !dryRun {
  645. if err := os.Remove(fp); err != nil {
  646. log.Printf("couldn't remove file '%s': %v", fp, err)
  647. continue
  648. }
  649. } else {
  650. log.Printf("wanted to remove: %s", fp)
  651. }
  652. }
  653. return nil
  654. }
  655. func PruneLayers() error {
  656. deleteMap := make(map[string]struct{})
  657. p, err := GetBlobsPath("")
  658. if err != nil {
  659. return err
  660. }
  661. blobs, err := os.ReadDir(p)
  662. if err != nil {
  663. log.Printf("couldn't read dir '%s': %v", p, err)
  664. return err
  665. }
  666. for _, blob := range blobs {
  667. name := blob.Name()
  668. if runtime.GOOS == "windows" {
  669. name = strings.ReplaceAll(name, "-", ":")
  670. }
  671. if strings.HasPrefix(name, "sha256:") {
  672. deleteMap[name] = struct{}{}
  673. }
  674. }
  675. log.Printf("total blobs: %d", len(deleteMap))
  676. err = deleteUnusedLayers(nil, deleteMap, false)
  677. if err != nil {
  678. return err
  679. }
  680. log.Printf("total unused blobs removed: %d", len(deleteMap))
  681. return nil
  682. }
  683. func PruneDirectory(path string) error {
  684. info, err := os.Lstat(path)
  685. if err != nil {
  686. return err
  687. }
  688. if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
  689. entries, err := os.ReadDir(path)
  690. if err != nil {
  691. return err
  692. }
  693. for _, entry := range entries {
  694. if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
  695. return err
  696. }
  697. }
  698. entries, err = os.ReadDir(path)
  699. if err != nil {
  700. return err
  701. }
  702. if len(entries) > 0 {
  703. return nil
  704. }
  705. return os.Remove(path)
  706. }
  707. return nil
  708. }
  709. func DeleteModel(name string) error {
  710. mp := ParseModelPath(name)
  711. manifest, _, err := GetManifest(mp)
  712. if err != nil {
  713. return err
  714. }
  715. deleteMap := make(map[string]struct{})
  716. for _, layer := range manifest.Layers {
  717. deleteMap[layer.Digest] = struct{}{}
  718. }
  719. deleteMap[manifest.Config.Digest] = struct{}{}
  720. err = deleteUnusedLayers(&mp, deleteMap, false)
  721. if err != nil {
  722. return err
  723. }
  724. fp, err := mp.GetManifestPath()
  725. if err != nil {
  726. return err
  727. }
  728. err = os.Remove(fp)
  729. if err != nil {
  730. log.Printf("couldn't remove manifest file '%s': %v", fp, err)
  731. return err
  732. }
  733. return nil
  734. }
  735. func ShowModelfile(model *Model) (string, error) {
  736. var mt struct {
  737. *Model
  738. From string
  739. Parameters map[string][]any
  740. }
  741. mt.Parameters = make(map[string][]any)
  742. for k, v := range model.Options {
  743. if s, ok := v.([]any); ok {
  744. mt.Parameters[k] = s
  745. continue
  746. }
  747. mt.Parameters[k] = []any{v}
  748. }
  749. mt.Model = model
  750. mt.From = model.ModelPath
  751. if model.OriginalModel != "" {
  752. mt.From = model.OriginalModel
  753. }
  754. modelFile := `# Modelfile generated by "ollama show"
  755. # To build a new Modelfile based on this one, replace the FROM line with:
  756. # FROM {{ .ShortName }}
  757. FROM {{ .From }}
  758. TEMPLATE """{{ .Template }}"""
  759. {{- if .System }}
  760. SYSTEM """{{ .System }}"""
  761. {{- end }}
  762. {{- range $adapter := .AdapterPaths }}
  763. ADAPTER {{ $adapter }}
  764. {{- end }}
  765. {{- range $k, $v := .Parameters }}
  766. {{- range $parameter := $v }}
  767. PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
  768. {{- end }}
  769. {{- end }}`
  770. tmpl, err := template.New("").Parse(modelFile)
  771. if err != nil {
  772. log.Printf("error parsing template: %q", err)
  773. return "", err
  774. }
  775. var buf bytes.Buffer
  776. if err = tmpl.Execute(&buf, mt); err != nil {
  777. log.Printf("error executing template: %q", err)
  778. return "", err
  779. }
  780. return buf.String(), nil
  781. }
  782. func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  783. mp := ParseModelPath(name)
  784. fn(api.ProgressResponse{Status: "retrieving manifest"})
  785. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  786. return fmt.Errorf("insecure protocol http")
  787. }
  788. manifest, _, err := GetManifest(mp)
  789. if err != nil {
  790. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  791. return err
  792. }
  793. var layers []*Layer
  794. layers = append(layers, manifest.Layers...)
  795. layers = append(layers, manifest.Config)
  796. for _, layer := range layers {
  797. if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
  798. log.Printf("error uploading blob: %v", err)
  799. if errors.Is(err, errUnauthorized) {
  800. return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
  801. }
  802. return err
  803. }
  804. }
  805. fn(api.ProgressResponse{Status: "pushing manifest"})
  806. requestURL := mp.BaseURL()
  807. requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  808. manifestJSON, err := json.Marshal(manifest)
  809. if err != nil {
  810. return err
  811. }
  812. headers := make(http.Header)
  813. headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
  814. resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
  815. if err != nil {
  816. return err
  817. }
  818. defer resp.Body.Close()
  819. fn(api.ProgressResponse{Status: "success"})
  820. return nil
  821. }
  822. func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  823. mp := ParseModelPath(name)
  824. var manifest *ManifestV2
  825. var err error
  826. var noprune string
  827. // build deleteMap to prune unused layers
  828. deleteMap := make(map[string]struct{})
  829. if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  830. manifest, _, err = GetManifest(mp)
  831. if err != nil && !errors.Is(err, os.ErrNotExist) {
  832. return err
  833. }
  834. if manifest != nil {
  835. for _, l := range manifest.Layers {
  836. deleteMap[l.Digest] = struct{}{}
  837. }
  838. deleteMap[manifest.Config.Digest] = struct{}{}
  839. }
  840. }
  841. if mp.ProtocolScheme == "http" && !regOpts.Insecure {
  842. return fmt.Errorf("insecure protocol http")
  843. }
  844. fn(api.ProgressResponse{Status: "pulling manifest"})
  845. manifest, err = pullModelManifest(ctx, mp, regOpts)
  846. if err != nil {
  847. return fmt.Errorf("pull model manifest: %s", err)
  848. }
  849. var layers []*Layer
  850. layers = append(layers, manifest.Layers...)
  851. layers = append(layers, manifest.Config)
  852. for _, layer := range layers {
  853. if err := downloadBlob(
  854. ctx,
  855. downloadOpts{
  856. mp: mp,
  857. digest: layer.Digest,
  858. regOpts: regOpts,
  859. fn: fn,
  860. }); err != nil {
  861. return err
  862. }
  863. delete(deleteMap, layer.Digest)
  864. }
  865. delete(deleteMap, manifest.Config.Digest)
  866. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  867. for _, layer := range layers {
  868. if err := verifyBlob(layer.Digest); err != nil {
  869. if errors.Is(err, errDigestMismatch) {
  870. // something went wrong, delete the blob
  871. fp, err := GetBlobsPath(layer.Digest)
  872. if err != nil {
  873. return err
  874. }
  875. if err := os.Remove(fp); err != nil {
  876. // log this, but return the original error
  877. log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
  878. }
  879. }
  880. return err
  881. }
  882. }
  883. fn(api.ProgressResponse{Status: "writing manifest"})
  884. manifestJSON, err := json.Marshal(manifest)
  885. if err != nil {
  886. return err
  887. }
  888. fp, err := mp.GetManifestPath()
  889. if err != nil {
  890. return err
  891. }
  892. if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
  893. return err
  894. }
  895. err = os.WriteFile(fp, manifestJSON, 0o644)
  896. if err != nil {
  897. log.Printf("couldn't write to %s", fp)
  898. return err
  899. }
  900. if noprune == "" {
  901. fn(api.ProgressResponse{Status: "removing any unused layers"})
  902. err = deleteUnusedLayers(nil, deleteMap, false)
  903. if err != nil {
  904. return err
  905. }
  906. }
  907. fn(api.ProgressResponse{Status: "success"})
  908. return nil
  909. }
  910. func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
  911. requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
  912. headers := make(http.Header)
  913. headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
  914. resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
  915. if err != nil {
  916. return nil, err
  917. }
  918. defer resp.Body.Close()
  919. var m *ManifestV2
  920. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  921. return nil, err
  922. }
  923. return m, err
  924. }
  925. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  926. func GetSHA256Digest(r io.Reader) (string, int64) {
  927. h := sha256.New()
  928. n, err := io.Copy(h, r)
  929. if err != nil {
  930. log.Fatal(err)
  931. }
  932. return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
  933. }
  934. var errUnauthorized = fmt.Errorf("unauthorized")
  935. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
  936. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  937. if err != nil {
  938. if !errors.Is(err, context.Canceled) {
  939. log.Printf("request failed: %v", err)
  940. }
  941. return nil, err
  942. }
  943. switch {
  944. case resp.StatusCode == http.StatusUnauthorized:
  945. // Handle authentication error with one retry
  946. auth := resp.Header.Get("www-authenticate")
  947. authRedir := ParseAuthRedirectString(auth)
  948. token, err := getAuthToken(ctx, authRedir)
  949. if err != nil {
  950. return nil, err
  951. }
  952. regOpts.Token = token
  953. if body != nil {
  954. _, err = body.Seek(0, io.SeekStart)
  955. if err != nil {
  956. return nil, err
  957. }
  958. }
  959. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  960. if resp.StatusCode == http.StatusUnauthorized {
  961. return nil, errUnauthorized
  962. }
  963. return resp, err
  964. case resp.StatusCode == http.StatusNotFound:
  965. return nil, os.ErrNotExist
  966. case resp.StatusCode >= http.StatusBadRequest:
  967. responseBody, err := io.ReadAll(resp.Body)
  968. if err != nil {
  969. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  970. }
  971. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  972. }
  973. return resp, nil
  974. }
  975. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
  976. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  977. requestURL.Scheme = "http"
  978. }
  979. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  980. if err != nil {
  981. return nil, err
  982. }
  983. if headers != nil {
  984. req.Header = headers
  985. }
  986. if regOpts != nil {
  987. if regOpts.Token != "" {
  988. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  989. } else if regOpts.Username != "" && regOpts.Password != "" {
  990. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  991. }
  992. }
  993. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  994. if s := req.Header.Get("Content-Length"); s != "" {
  995. contentLength, err := strconv.ParseInt(s, 10, 64)
  996. if err != nil {
  997. return nil, err
  998. }
  999. req.ContentLength = contentLength
  1000. }
  1001. proxyURL, err := http.ProxyFromEnvironment(req)
  1002. if err != nil {
  1003. return nil, err
  1004. }
  1005. client := http.Client{
  1006. Transport: &http.Transport{
  1007. Proxy: http.ProxyURL(proxyURL),
  1008. },
  1009. }
  1010. resp, err := client.Do(req)
  1011. if err != nil {
  1012. return nil, err
  1013. }
  1014. return resp, nil
  1015. }
  1016. func getValue(header, key string) string {
  1017. startIdx := strings.Index(header, key+"=")
  1018. if startIdx == -1 {
  1019. return ""
  1020. }
  1021. // Move the index to the starting quote after the key.
  1022. startIdx += len(key) + 2
  1023. endIdx := startIdx
  1024. for endIdx < len(header) {
  1025. if header[endIdx] == '"' {
  1026. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  1027. endIdx++
  1028. continue
  1029. }
  1030. break
  1031. }
  1032. endIdx++
  1033. }
  1034. return header[startIdx:endIdx]
  1035. }
  1036. func ParseAuthRedirectString(authStr string) AuthRedirect {
  1037. authStr = strings.TrimPrefix(authStr, "Bearer ")
  1038. return AuthRedirect{
  1039. Realm: getValue(authStr, "realm"),
  1040. Service: getValue(authStr, "service"),
  1041. Scope: getValue(authStr, "scope"),
  1042. }
  1043. }
  1044. var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")
  1045. func verifyBlob(digest string) error {
  1046. fp, err := GetBlobsPath(digest)
  1047. if err != nil {
  1048. return err
  1049. }
  1050. f, err := os.Open(fp)
  1051. if err != nil {
  1052. return err
  1053. }
  1054. defer f.Close()
  1055. fileDigest, _ := GetSHA256Digest(f)
  1056. if digest != fileDigest {
  1057. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  1058. }
  1059. return nil
  1060. }