images.go 32 KB

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