images.go 33 KB

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