images.go 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278
  1. package server
  2. import (
  3. "archive/zip"
  4. "bytes"
  5. "context"
  6. "crypto/sha256"
  7. "encoding/hex"
  8. "encoding/json"
  9. "errors"
  10. "fmt"
  11. "io"
  12. "io/fs"
  13. "log"
  14. "log/slog"
  15. "net/http"
  16. "net/url"
  17. "os"
  18. "path/filepath"
  19. "runtime"
  20. "strconv"
  21. "strings"
  22. "text/template"
  23. "golang.org/x/exp/slices"
  24. "github.com/ollama/ollama/api"
  25. "github.com/ollama/ollama/convert"
  26. "github.com/ollama/ollama/format"
  27. "github.com/ollama/ollama/llm"
  28. "github.com/ollama/ollama/parser"
  29. "github.com/ollama/ollama/version"
  30. )
  31. type registryOptions struct {
  32. Insecure bool
  33. Username string
  34. Password string
  35. Token string
  36. }
  37. type Model struct {
  38. Name string `json:"name"`
  39. Config ConfigV2
  40. ShortName string
  41. ModelPath string
  42. ParentModel string
  43. AdapterPaths []string
  44. ProjectorPaths []string
  45. Template string
  46. System string
  47. License []string
  48. Digest string
  49. Size int64
  50. Options map[string]interface{}
  51. Messages []Message
  52. }
  53. func (m *Model) IsEmbedding() bool {
  54. return slices.Contains(m.Config.ModelFamilies, "bert") || slices.Contains(m.Config.ModelFamilies, "nomic-bert")
  55. }
  56. type Message struct {
  57. Role string `json:"role"`
  58. Content string `json:"content"`
  59. }
  60. type ManifestV2 struct {
  61. SchemaVersion int `json:"schemaVersion"`
  62. MediaType string `json:"mediaType"`
  63. Config *Layer `json:"config"`
  64. Layers []*Layer `json:"layers"`
  65. }
  66. type ConfigV2 struct {
  67. ModelFormat string `json:"model_format"`
  68. ModelFamily string `json:"model_family"`
  69. ModelFamilies []string `json:"model_families"`
  70. ModelType string `json:"model_type"`
  71. FileType string `json:"file_type"`
  72. // required by spec
  73. Architecture string `json:"architecture"`
  74. OS string `json:"os"`
  75. RootFS RootFS `json:"rootfs"`
  76. }
  77. func (c *ConfigV2) SetModelFormat(format string) {
  78. if c.ModelFormat == "" {
  79. c.ModelFormat = format
  80. }
  81. }
  82. func (c *ConfigV2) SetModelFamily(families ...string) {
  83. for _, family := range families {
  84. if c.ModelFamily == "" {
  85. c.ModelFamily = family
  86. }
  87. if !slices.Contains(c.ModelFamilies, family) {
  88. c.ModelFamilies = append(c.ModelFamilies, family)
  89. }
  90. }
  91. }
  92. func (c *ConfigV2) SetModelType(modelType string) {
  93. if c.ModelType == "" {
  94. c.ModelType = modelType
  95. }
  96. }
  97. func (c *ConfigV2) SetFileType(fileType string) {
  98. if c.FileType == "" {
  99. c.FileType = fileType
  100. }
  101. }
  102. type RootFS struct {
  103. Type string `json:"type"`
  104. DiffIDs []string `json:"diff_ids"`
  105. }
  106. func (m *ManifestV2) GetTotalSize() (total int64) {
  107. for _, layer := range m.Layers {
  108. total += layer.Size
  109. }
  110. total += m.Config.Size
  111. return total
  112. }
  113. func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
  114. fp, err := mp.GetManifestPath()
  115. if err != nil {
  116. return nil, "", err
  117. }
  118. if _, err = os.Stat(fp); err != nil {
  119. return nil, "", err
  120. }
  121. var manifest *ManifestV2
  122. bts, err := os.ReadFile(fp)
  123. if err != nil {
  124. return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
  125. }
  126. shaSum := sha256.Sum256(bts)
  127. shaStr := hex.EncodeToString(shaSum[:])
  128. if err := json.Unmarshal(bts, &manifest); err != nil {
  129. return nil, "", err
  130. }
  131. return manifest, shaStr, nil
  132. }
  133. func GetModel(name string) (*Model, error) {
  134. mp := ParseModelPath(name)
  135. manifest, digest, err := GetManifest(mp)
  136. if err != nil {
  137. return nil, err
  138. }
  139. model := &Model{
  140. Name: mp.GetFullTagname(),
  141. ShortName: mp.GetShortTagname(),
  142. Digest: digest,
  143. Template: "{{ .Prompt }}",
  144. License: []string{},
  145. Size: manifest.GetTotalSize(),
  146. }
  147. filename, err := GetBlobsPath(manifest.Config.Digest)
  148. if err != nil {
  149. return nil, err
  150. }
  151. configFile, err := os.Open(filename)
  152. if err != nil {
  153. return nil, err
  154. }
  155. defer configFile.Close()
  156. if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
  157. return nil, err
  158. }
  159. for _, layer := range manifest.Layers {
  160. filename, err := GetBlobsPath(layer.Digest)
  161. if err != nil {
  162. return nil, err
  163. }
  164. switch layer.MediaType {
  165. case "application/vnd.ollama.image.model":
  166. model.ModelPath = filename
  167. model.ParentModel = layer.From
  168. case "application/vnd.ollama.image.embed":
  169. // Deprecated in versions > 0.1.2
  170. // TODO: remove this warning in a future version
  171. slog.Info("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
  172. case "application/vnd.ollama.image.adapter":
  173. model.AdapterPaths = append(model.AdapterPaths, filename)
  174. case "application/vnd.ollama.image.projector":
  175. model.ProjectorPaths = append(model.ProjectorPaths, filename)
  176. case "application/vnd.ollama.image.template":
  177. bts, err := os.ReadFile(filename)
  178. if err != nil {
  179. return nil, err
  180. }
  181. model.Template = string(bts)
  182. case "application/vnd.ollama.image.system":
  183. bts, err := os.ReadFile(filename)
  184. if err != nil {
  185. return nil, err
  186. }
  187. model.System = string(bts)
  188. case "application/vnd.ollama.image.prompt":
  189. bts, err := os.ReadFile(filename)
  190. if err != nil {
  191. return nil, err
  192. }
  193. model.Template = string(bts)
  194. case "application/vnd.ollama.image.params":
  195. params, err := os.Open(filename)
  196. if err != nil {
  197. return nil, err
  198. }
  199. defer params.Close()
  200. // parse model options parameters into a map so that we can see which fields have been specified explicitly
  201. if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
  202. return nil, err
  203. }
  204. case "application/vnd.ollama.image.messages":
  205. msgs, err := os.Open(filename)
  206. if err != nil {
  207. return nil, err
  208. }
  209. defer msgs.Close()
  210. if err = json.NewDecoder(msgs).Decode(&model.Messages); err != nil {
  211. return nil, err
  212. }
  213. case "application/vnd.ollama.image.license":
  214. bts, err := os.ReadFile(filename)
  215. if err != nil {
  216. return nil, err
  217. }
  218. model.License = append(model.License, string(bts))
  219. }
  220. }
  221. return model, nil
  222. }
  223. func realpath(mfDir, from string) string {
  224. abspath, err := filepath.Abs(from)
  225. if err != nil {
  226. return from
  227. }
  228. home, err := os.UserHomeDir()
  229. if err != nil {
  230. return abspath
  231. }
  232. if from == "~" {
  233. return home
  234. } else if strings.HasPrefix(from, "~/") {
  235. return filepath.Join(home, from[2:])
  236. }
  237. if _, err := os.Stat(filepath.Join(mfDir, from)); err == nil {
  238. // this is a file relative to the Modelfile
  239. return filepath.Join(mfDir, from)
  240. }
  241. return abspath
  242. }
  243. func CreateModel(ctx context.Context, name, modelFileDir, quantization string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
  244. deleteMap := make(map[string]struct{})
  245. if manifest, _, err := GetManifest(ParseModelPath(name)); err == nil {
  246. for _, layer := range append(manifest.Layers, manifest.Config) {
  247. deleteMap[layer.Digest] = struct{}{}
  248. }
  249. }
  250. config := ConfigV2{
  251. OS: "linux",
  252. Architecture: "amd64",
  253. RootFS: RootFS{
  254. Type: "layers",
  255. },
  256. }
  257. var layers Layers
  258. messages := []string{}
  259. params := make(map[string][]string)
  260. fromParams := make(map[string]any)
  261. for _, c := range commands {
  262. mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
  263. switch c.Name {
  264. case "model":
  265. if strings.HasPrefix(c.Args, "@") {
  266. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  267. if err != nil {
  268. return err
  269. }
  270. c.Args = blobPath
  271. }
  272. pathName := realpath(modelFileDir, c.Args)
  273. ggufName, err := convertModel(name, pathName, fn)
  274. if err != nil {
  275. var pathErr *fs.PathError
  276. switch {
  277. case errors.Is(err, zip.ErrFormat):
  278. // it's not a safetensor archive
  279. case errors.As(err, &pathErr):
  280. // it's not a file on disk, could be a model reference
  281. default:
  282. return err
  283. }
  284. }
  285. if ggufName != "" {
  286. pathName = ggufName
  287. defer os.RemoveAll(ggufName)
  288. if quantization != "" {
  289. quantization = strings.ToUpper(quantization)
  290. fn(api.ProgressResponse{Status: fmt.Sprintf("quantizing %s model to %s", "F16", quantization)})
  291. tempfile, err := os.CreateTemp(filepath.Dir(ggufName), quantization)
  292. if err != nil {
  293. return err
  294. }
  295. defer os.RemoveAll(tempfile.Name())
  296. if err := llm.Quantize(ggufName, tempfile.Name(), quantization); err != nil {
  297. return err
  298. }
  299. if err := tempfile.Close(); err != nil {
  300. return err
  301. }
  302. pathName = tempfile.Name()
  303. }
  304. }
  305. bin, err := os.Open(pathName)
  306. if err != nil {
  307. // not a file on disk so must be a model reference
  308. modelpath := ParseModelPath(c.Args)
  309. manifest, _, err := GetManifest(modelpath)
  310. switch {
  311. case errors.Is(err, os.ErrNotExist):
  312. fn(api.ProgressResponse{Status: "pulling model"})
  313. if err := PullModel(ctx, c.Args, &registryOptions{}, fn); err != nil {
  314. return err
  315. }
  316. manifest, _, err = GetManifest(modelpath)
  317. if err != nil {
  318. return err
  319. }
  320. case err != nil:
  321. return err
  322. }
  323. fn(api.ProgressResponse{Status: "reading model metadata"})
  324. fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
  325. if err != nil {
  326. return err
  327. }
  328. fromConfigFile, err := os.Open(fromConfigPath)
  329. if err != nil {
  330. return err
  331. }
  332. defer fromConfigFile.Close()
  333. var fromConfig ConfigV2
  334. if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
  335. return err
  336. }
  337. // if the model is still not in gguf format, error out
  338. if fromConfig.ModelFormat != "gguf" {
  339. return fmt.Errorf("%s is not in gguf format, this base model is not compatible with this version of ollama", c.Args)
  340. }
  341. config.SetModelFormat(fromConfig.ModelFormat)
  342. config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
  343. config.SetModelType(fromConfig.ModelType)
  344. config.SetFileType(fromConfig.FileType)
  345. for _, layer := range manifest.Layers {
  346. deleteMap[layer.Digest] = struct{}{}
  347. if layer.MediaType == "application/vnd.ollama.image.params" {
  348. fromParamsPath, err := GetBlobsPath(layer.Digest)
  349. if err != nil {
  350. return err
  351. }
  352. fromParamsFile, err := os.Open(fromParamsPath)
  353. if err != nil {
  354. return err
  355. }
  356. defer fromParamsFile.Close()
  357. if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
  358. return err
  359. }
  360. }
  361. layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
  362. if err != nil {
  363. return err
  364. }
  365. layers.Add(layer)
  366. }
  367. deleteMap[manifest.Config.Digest] = struct{}{}
  368. continue
  369. }
  370. defer bin.Close()
  371. var offset int64
  372. for {
  373. fn(api.ProgressResponse{Status: "creating model layer"})
  374. if _, err := bin.Seek(offset, io.SeekStart); err != nil {
  375. return err
  376. }
  377. ggml, size, err := llm.DecodeGGML(bin)
  378. if errors.Is(err, io.EOF) {
  379. break
  380. } else if errors.Is(err, llm.ErrUnsupportedFormat) {
  381. return fmt.Errorf("model binary specified in FROM field is not a valid gguf format model, %w", err)
  382. } else if err != nil {
  383. return err
  384. }
  385. config.SetModelFormat(ggml.Name())
  386. config.SetModelFamily(ggml.KV().Architecture())
  387. config.SetModelType(format.HumanNumber(ggml.KV().ParameterCount()))
  388. config.SetFileType(ggml.KV().FileType())
  389. mediatype := mediatype
  390. if ggml.KV().Architecture() == "clip" {
  391. mediatype = "application/vnd.ollama.image.projector"
  392. }
  393. sr := io.NewSectionReader(bin, offset, size)
  394. layer, err := NewLayer(sr, mediatype)
  395. if err != nil {
  396. return err
  397. }
  398. layers.Add(layer)
  399. offset += size
  400. }
  401. case "adapter":
  402. if strings.HasPrefix(c.Args, "@") {
  403. blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
  404. if err != nil {
  405. return err
  406. }
  407. c.Args = blobPath
  408. }
  409. fn(api.ProgressResponse{Status: "creating adapter layer"})
  410. bin, err := os.Open(realpath(modelFileDir, c.Args))
  411. if err != nil {
  412. return err
  413. }
  414. defer bin.Close()
  415. _, size, err := llm.DecodeGGML(bin)
  416. if err != nil {
  417. return err
  418. }
  419. sr := io.NewSectionReader(bin, 0, size)
  420. layer, err := NewLayer(sr, mediatype)
  421. if err != nil {
  422. return err
  423. }
  424. layers.Add(layer)
  425. case "license":
  426. fn(api.ProgressResponse{Status: "creating license layer"})
  427. bin := strings.NewReader(c.Args)
  428. layer, err := NewLayer(bin, mediatype)
  429. if err != nil {
  430. return err
  431. }
  432. layers.Add(layer)
  433. case "template", "system":
  434. fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})
  435. bin := strings.NewReader(c.Args)
  436. layer, err := NewLayer(bin, mediatype)
  437. if err != nil {
  438. return err
  439. }
  440. layers.Replace(layer)
  441. case "message":
  442. messages = append(messages, c.Args)
  443. default:
  444. params[c.Name] = append(params[c.Name], c.Args)
  445. }
  446. }
  447. if len(messages) > 0 {
  448. fn(api.ProgressResponse{Status: "creating parameters layer"})
  449. msgs := make([]api.Message, 0)
  450. for _, m := range messages {
  451. // todo: handle images
  452. msg := strings.SplitN(m, ": ", 2)
  453. msgs = append(msgs, api.Message{Role: msg[0], Content: msg[1]})
  454. }
  455. var b bytes.Buffer
  456. if err := json.NewEncoder(&b).Encode(msgs); err != nil {
  457. return err
  458. }
  459. layer, err := NewLayer(&b, "application/vnd.ollama.image.messages")
  460. if err != nil {
  461. return err
  462. }
  463. layers.Replace(layer)
  464. }
  465. if len(params) > 0 {
  466. fn(api.ProgressResponse{Status: "creating parameters layer"})
  467. formattedParams, err := api.FormatParams(params)
  468. if err != nil {
  469. return err
  470. }
  471. for k, v := range fromParams {
  472. if _, ok := formattedParams[k]; !ok {
  473. formattedParams[k] = v
  474. }
  475. }
  476. var b bytes.Buffer
  477. if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
  478. return err
  479. }
  480. fn(api.ProgressResponse{Status: "creating config layer"})
  481. layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
  482. if err != nil {
  483. return err
  484. }
  485. layers.Replace(layer)
  486. }
  487. digests := make([]string, len(layers.items))
  488. for i, layer := range layers.items {
  489. digests[i] = layer.Digest
  490. }
  491. config.RootFS.DiffIDs = digests
  492. var b bytes.Buffer
  493. if err := json.NewEncoder(&b).Encode(config); err != nil {
  494. return err
  495. }
  496. configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
  497. if err != nil {
  498. return err
  499. }
  500. delete(deleteMap, configLayer.Digest)
  501. for _, layer := range append(layers.items, configLayer) {
  502. committed, err := layer.Commit()
  503. if err != nil {
  504. return err
  505. }
  506. status := "writing layer"
  507. if !committed {
  508. status = "using already created layer"
  509. }
  510. fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
  511. delete(deleteMap, layer.Digest)
  512. }
  513. fn(api.ProgressResponse{Status: "writing manifest"})
  514. if err := WriteManifest(name, configLayer, layers.items); err != nil {
  515. return err
  516. }
  517. if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  518. if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
  519. return err
  520. }
  521. }
  522. fn(api.ProgressResponse{Status: "success"})
  523. return nil
  524. }
  525. func convertModel(name, path string, fn func(resp api.ProgressResponse)) (string, error) {
  526. r, err := zip.OpenReader(path)
  527. if err != nil {
  528. return "", err
  529. }
  530. defer r.Close()
  531. tempDir, err := os.MkdirTemp("", "ollama-convert")
  532. if err != nil {
  533. return "", err
  534. }
  535. defer os.RemoveAll(tempDir)
  536. fn(api.ProgressResponse{Status: "unpacking model metadata"})
  537. for _, f := range r.File {
  538. fpath := filepath.Join(tempDir, f.Name)
  539. outFile, err := os.OpenFile(fpath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
  540. if err != nil {
  541. return "", err
  542. }
  543. rc, err := f.Open()
  544. if err != nil {
  545. return "", err
  546. }
  547. _, err = io.Copy(outFile, rc)
  548. if err != nil {
  549. return "", err
  550. }
  551. outFile.Close()
  552. rc.Close()
  553. }
  554. mf, err := convert.GetModelFormat(tempDir)
  555. if err != nil {
  556. return "", err
  557. }
  558. params, err := mf.GetParams(tempDir)
  559. if err != nil {
  560. return "", err
  561. }
  562. mArch, err := mf.GetModelArch(name, tempDir, params)
  563. if err != nil {
  564. return "", err
  565. }
  566. fn(api.ProgressResponse{Status: "processing tensors"})
  567. if err := mArch.GetTensors(); err != nil {
  568. return "", err
  569. }
  570. if err := mArch.LoadVocab(); err != nil {
  571. return "", err
  572. }
  573. fn(api.ProgressResponse{Status: "converting model"})
  574. path, err = mArch.WriteGGUF()
  575. if err != nil {
  576. return "", err
  577. }
  578. return path, nil
  579. }
  580. func CopyModel(src, dest string) error {
  581. srcModelPath := ParseModelPath(src)
  582. srcPath, err := srcModelPath.GetManifestPath()
  583. if err != nil {
  584. return err
  585. }
  586. destModelPath := ParseModelPath(dest)
  587. destPath, err := destModelPath.GetManifestPath()
  588. if err != nil {
  589. return err
  590. }
  591. if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
  592. return err
  593. }
  594. // copy the file
  595. input, err := os.ReadFile(srcPath)
  596. if err != nil {
  597. fmt.Println("Error reading file:", err)
  598. return err
  599. }
  600. err = os.WriteFile(destPath, input, 0o644)
  601. if err != nil {
  602. fmt.Println("Error reading file:", err)
  603. return err
  604. }
  605. return nil
  606. }
  607. func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
  608. fp, err := GetManifestPath()
  609. if err != nil {
  610. return err
  611. }
  612. walkFunc := func(path string, info os.FileInfo, _ error) error {
  613. if info.IsDir() {
  614. return nil
  615. }
  616. dir, file := filepath.Split(path)
  617. dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
  618. tag := strings.Join([]string{dir, file}, ":")
  619. fmp := ParseModelPath(tag)
  620. // skip the manifest we're trying to delete
  621. if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
  622. return nil
  623. }
  624. // save (i.e. delete from the deleteMap) any files used in other manifests
  625. manifest, _, err := GetManifest(fmp)
  626. if err != nil {
  627. // nolint: nilerr
  628. return nil
  629. }
  630. for _, layer := range manifest.Layers {
  631. delete(deleteMap, layer.Digest)
  632. }
  633. delete(deleteMap, manifest.Config.Digest)
  634. return nil
  635. }
  636. if err := filepath.Walk(fp, walkFunc); err != nil {
  637. return err
  638. }
  639. // only delete the files which are still in the deleteMap
  640. for k := range deleteMap {
  641. fp, err := GetBlobsPath(k)
  642. if err != nil {
  643. slog.Info(fmt.Sprintf("couldn't get file path for '%s': %v", k, err))
  644. continue
  645. }
  646. if !dryRun {
  647. if err := os.Remove(fp); err != nil {
  648. slog.Info(fmt.Sprintf("couldn't remove file '%s': %v", fp, err))
  649. continue
  650. }
  651. } else {
  652. slog.Info(fmt.Sprintf("wanted to remove: %s", fp))
  653. }
  654. }
  655. return nil
  656. }
  657. func PruneLayers() error {
  658. deleteMap := make(map[string]struct{})
  659. p, err := GetBlobsPath("")
  660. if err != nil {
  661. return err
  662. }
  663. blobs, err := os.ReadDir(p)
  664. if err != nil {
  665. slog.Info(fmt.Sprintf("couldn't read dir '%s': %v", p, err))
  666. return err
  667. }
  668. for _, blob := range blobs {
  669. name := blob.Name()
  670. name = strings.ReplaceAll(name, "-", ":")
  671. if strings.HasPrefix(name, "sha256:") {
  672. deleteMap[name] = struct{}{}
  673. }
  674. }
  675. slog.Info(fmt.Sprintf("total blobs: %d", len(deleteMap)))
  676. err = deleteUnusedLayers(nil, deleteMap, false)
  677. if err != nil {
  678. return err
  679. }
  680. slog.Info(fmt.Sprintf("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. slog.Info(fmt.Sprintf("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.ParentModel != "" {
  752. mt.From = model.ParentModel
  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. slog.Info(fmt.Sprintf("error parsing template: %q", err))
  773. return "", err
  774. }
  775. var buf bytes.Buffer
  776. if err = tmpl.Execute(&buf, mt); err != nil {
  777. slog.Info(fmt.Sprintf("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. slog.Info(fmt.Sprintf("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. slog.Info(fmt.Sprintf("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. slog.Info(fmt.Sprintf("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 = errors.New("unauthorized")
  935. func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *registryOptions) (*http.Response, error) {
  936. for i := 0; i < 2; i++ {
  937. resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
  938. if err != nil {
  939. if !errors.Is(err, context.Canceled) {
  940. slog.Info(fmt.Sprintf("request failed: %v", err))
  941. }
  942. return nil, err
  943. }
  944. switch {
  945. case resp.StatusCode == http.StatusUnauthorized:
  946. // Handle authentication error with one retry
  947. challenge := parseRegistryChallenge(resp.Header.Get("www-authenticate"))
  948. token, err := getAuthorizationToken(ctx, challenge)
  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. case resp.StatusCode == http.StatusNotFound:
  960. return nil, os.ErrNotExist
  961. case resp.StatusCode >= http.StatusBadRequest:
  962. responseBody, err := io.ReadAll(resp.Body)
  963. if err != nil {
  964. return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
  965. }
  966. return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
  967. default:
  968. return resp, nil
  969. }
  970. }
  971. return nil, errUnauthorized
  972. }
  973. func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *registryOptions) (*http.Response, error) {
  974. if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
  975. requestURL.Scheme = "http"
  976. }
  977. req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
  978. if err != nil {
  979. return nil, err
  980. }
  981. if headers != nil {
  982. req.Header = headers
  983. }
  984. if regOpts != nil {
  985. if regOpts.Token != "" {
  986. req.Header.Set("Authorization", "Bearer "+regOpts.Token)
  987. } else if regOpts.Username != "" && regOpts.Password != "" {
  988. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  989. }
  990. }
  991. req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
  992. if s := req.Header.Get("Content-Length"); s != "" {
  993. contentLength, err := strconv.ParseInt(s, 10, 64)
  994. if err != nil {
  995. return nil, err
  996. }
  997. req.ContentLength = contentLength
  998. }
  999. resp, err := http.DefaultClient.Do(req)
  1000. if err != nil {
  1001. return nil, err
  1002. }
  1003. return resp, nil
  1004. }
  1005. func getValue(header, key string) string {
  1006. startIdx := strings.Index(header, key+"=")
  1007. if startIdx == -1 {
  1008. return ""
  1009. }
  1010. // Move the index to the starting quote after the key.
  1011. startIdx += len(key) + 2
  1012. endIdx := startIdx
  1013. for endIdx < len(header) {
  1014. if header[endIdx] == '"' {
  1015. if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
  1016. endIdx++
  1017. continue
  1018. }
  1019. break
  1020. }
  1021. endIdx++
  1022. }
  1023. return header[startIdx:endIdx]
  1024. }
  1025. func parseRegistryChallenge(authStr string) registryChallenge {
  1026. authStr = strings.TrimPrefix(authStr, "Bearer ")
  1027. return registryChallenge{
  1028. Realm: getValue(authStr, "realm"),
  1029. Service: getValue(authStr, "service"),
  1030. Scope: getValue(authStr, "scope"),
  1031. }
  1032. }
  1033. var errDigestMismatch = errors.New("digest mismatch, file must be downloaded again")
  1034. func verifyBlob(digest string) error {
  1035. fp, err := GetBlobsPath(digest)
  1036. if err != nil {
  1037. return err
  1038. }
  1039. f, err := os.Open(fp)
  1040. if err != nil {
  1041. return err
  1042. }
  1043. defer f.Close()
  1044. fileDigest, _ := GetSHA256Digest(f)
  1045. if digest != fileDigest {
  1046. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  1047. }
  1048. return nil
  1049. }