images.go 31 KB

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