images.go 28 KB

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