images.go 35 KB

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