images.go 31 KB

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