images.go 29 KB

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