images.go 29 KB

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