images.go 31 KB

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