images.go 29 KB

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