images.go 33 KB

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