images.go 30 KB

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