images.go 30 KB

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