images.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131
  1. package server
  2. import (
  3. "bytes"
  4. "crypto/sha256"
  5. "encoding/json"
  6. "errors"
  7. "fmt"
  8. "io"
  9. "log"
  10. "net/http"
  11. "os"
  12. "path"
  13. "path/filepath"
  14. "reflect"
  15. "strconv"
  16. "strings"
  17. "text/template"
  18. "github.com/jmorganca/ollama/api"
  19. "github.com/jmorganca/ollama/parser"
  20. )
  21. type RegistryOptions struct {
  22. Insecure bool
  23. Username string
  24. Password string
  25. }
  26. type Model struct {
  27. Name string `json:"name"`
  28. ModelPath string
  29. Template string
  30. System string
  31. Digest string
  32. Options map[string]interface{}
  33. }
  34. func (m *Model) Prompt(request api.GenerateRequest) (string, error) {
  35. tmpl, err := template.New("").Parse(m.Template)
  36. if err != nil {
  37. return "", err
  38. }
  39. var vars struct {
  40. First bool
  41. System string
  42. Prompt string
  43. // deprecated: versions <= 0.0.7 used this to omit the system prompt
  44. Context []int
  45. }
  46. vars.First = len(request.Context) == 0
  47. vars.System = m.System
  48. vars.Prompt = request.Prompt
  49. vars.Context = request.Context
  50. var sb strings.Builder
  51. if err := tmpl.Execute(&sb, vars); err != nil {
  52. return "", err
  53. }
  54. return sb.String(), nil
  55. }
  56. type ManifestV2 struct {
  57. SchemaVersion int `json:"schemaVersion"`
  58. MediaType string `json:"mediaType"`
  59. Config Layer `json:"config"`
  60. Layers []*Layer `json:"layers"`
  61. }
  62. type Layer struct {
  63. MediaType string `json:"mediaType"`
  64. Digest string `json:"digest"`
  65. Size int `json:"size"`
  66. }
  67. type LayerReader struct {
  68. Layer
  69. io.Reader
  70. }
  71. type ConfigV2 struct {
  72. Architecture string `json:"architecture"`
  73. OS string `json:"os"`
  74. RootFS RootFS `json:"rootfs"`
  75. }
  76. type RootFS struct {
  77. Type string `json:"type"`
  78. DiffIDs []string `json:"diff_ids"`
  79. }
  80. func (m *ManifestV2) GetTotalSize() int {
  81. var total int
  82. for _, layer := range m.Layers {
  83. total += layer.Size
  84. }
  85. total += m.Config.Size
  86. return total
  87. }
  88. func GetManifest(mp ModelPath) (*ManifestV2, error) {
  89. fp, err := mp.GetManifestPath(false)
  90. if err != nil {
  91. return nil, err
  92. }
  93. if _, err = os.Stat(fp); err != nil {
  94. return nil, err
  95. }
  96. var manifest *ManifestV2
  97. bts, err := os.ReadFile(fp)
  98. if err != nil {
  99. return nil, fmt.Errorf("couldn't open file '%s'", fp)
  100. }
  101. if err := json.Unmarshal(bts, &manifest); err != nil {
  102. return nil, err
  103. }
  104. return manifest, nil
  105. }
  106. func GetModel(name string) (*Model, error) {
  107. mp := ParseModelPath(name)
  108. manifest, err := GetManifest(mp)
  109. if err != nil {
  110. return nil, err
  111. }
  112. model := &Model{
  113. Name: mp.GetFullTagname(),
  114. Digest: manifest.Config.Digest,
  115. }
  116. for _, layer := range manifest.Layers {
  117. filename, err := GetBlobsPath(layer.Digest)
  118. if err != nil {
  119. return nil, err
  120. }
  121. switch layer.MediaType {
  122. case "application/vnd.ollama.image.model":
  123. model.ModelPath = filename
  124. case "application/vnd.ollama.image.template":
  125. bts, err := os.ReadFile(filename)
  126. if err != nil {
  127. return nil, err
  128. }
  129. model.Template = string(bts)
  130. case "application/vnd.ollama.image.system":
  131. bts, err := os.ReadFile(filename)
  132. if err != nil {
  133. return nil, err
  134. }
  135. model.System = string(bts)
  136. case "application/vnd.ollama.image.prompt":
  137. bts, err := os.ReadFile(filename)
  138. if err != nil {
  139. return nil, err
  140. }
  141. model.Template = string(bts)
  142. case "application/vnd.ollama.image.params":
  143. params, err := os.Open(filename)
  144. if err != nil {
  145. return nil, err
  146. }
  147. defer params.Close()
  148. // parse model options parameters into a map so that we can see which fields have been specified explicitly
  149. if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
  150. return nil, err
  151. }
  152. }
  153. }
  154. return model, nil
  155. }
  156. func CreateModel(name string, path string, fn func(resp api.ProgressResponse)) error {
  157. mf, err := os.Open(path)
  158. if err != nil {
  159. fn(api.ProgressResponse{Status: fmt.Sprintf("couldn't open modelfile '%s'", path)})
  160. return fmt.Errorf("failed to open file: %w", err)
  161. }
  162. defer mf.Close()
  163. fn(api.ProgressResponse{Status: "parsing modelfile"})
  164. commands, err := parser.Parse(mf)
  165. if err != nil {
  166. return err
  167. }
  168. var layers []*LayerReader
  169. params := make(map[string][]string)
  170. for _, c := range commands {
  171. log.Printf("[%s] - %s\n", c.Name, c.Args)
  172. switch c.Name {
  173. case "model":
  174. fn(api.ProgressResponse{Status: "looking for model"})
  175. mf, err := GetManifest(ParseModelPath(c.Args))
  176. if err != nil {
  177. fp := c.Args
  178. // If filePath starts with ~/, replace it with the user's home directory.
  179. if strings.HasPrefix(fp, "~/") {
  180. parts := strings.Split(fp, "/")
  181. home, err := os.UserHomeDir()
  182. if err != nil {
  183. return fmt.Errorf("failed to open file: %v", err)
  184. }
  185. fp = filepath.Join(home, filepath.Join(parts[1:]...))
  186. }
  187. // If filePath is not an absolute path, make it relative to the modelfile path
  188. if !filepath.IsAbs(fp) {
  189. fp = filepath.Join(filepath.Dir(path), fp)
  190. }
  191. if _, err := os.Stat(fp); err != nil {
  192. // the model file does not exist, try pulling it
  193. if errors.Is(err, os.ErrNotExist) {
  194. fn(api.ProgressResponse{Status: "pulling model file"})
  195. if err := PullModel(c.Args, &RegistryOptions{}, fn); err != nil {
  196. return err
  197. }
  198. mf, err = GetManifest(ParseModelPath(c.Args))
  199. if err != nil {
  200. return fmt.Errorf("failed to open file after pull: %v", err)
  201. }
  202. } else {
  203. return err
  204. }
  205. } else {
  206. // create a model from this specified file
  207. fn(api.ProgressResponse{Status: "creating model layer"})
  208. file, err := os.Open(fp)
  209. if err != nil {
  210. return fmt.Errorf("failed to open file: %v", err)
  211. }
  212. defer file.Close()
  213. l, err := CreateLayer(file)
  214. if err != nil {
  215. return fmt.Errorf("failed to create layer: %v", err)
  216. }
  217. l.MediaType = "application/vnd.ollama.image.model"
  218. layers = append(layers, l)
  219. }
  220. }
  221. if mf != nil {
  222. log.Printf("manifest = %#v", mf)
  223. for _, l := range mf.Layers {
  224. newLayer, err := GetLayerWithBufferFromLayer(l)
  225. if err != nil {
  226. return err
  227. }
  228. layers = append(layers, newLayer)
  229. }
  230. }
  231. case "license":
  232. fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
  233. // remove the prompt layer if one exists
  234. mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
  235. layer, err := CreateLayer(strings.NewReader(c.Args))
  236. if err != nil {
  237. return err
  238. }
  239. layer.MediaType = mediaType
  240. layers = append(layers, layer)
  241. case "template", "system", "prompt":
  242. fn(api.ProgressResponse{Status: fmt.Sprintf("creating model %s layer", c.Name)})
  243. // remove the prompt layer if one exists
  244. mediaType := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)
  245. layers = removeLayerFromLayers(layers, mediaType)
  246. layer, err := CreateLayer(strings.NewReader(c.Args))
  247. if err != nil {
  248. return err
  249. }
  250. layer.MediaType = mediaType
  251. layers = append(layers, layer)
  252. default:
  253. // runtime parameters, build a list of args for each parameter to allow multiple values to be specified (ex: multiple stop tokens)
  254. params[c.Name] = append(params[c.Name], c.Args)
  255. }
  256. }
  257. // Create a single layer for the parameters
  258. if len(params) > 0 {
  259. fn(api.ProgressResponse{Status: "creating parameter layer"})
  260. layers = removeLayerFromLayers(layers, "application/vnd.ollama.image.params")
  261. paramData, err := paramsToReader(params)
  262. if err != nil {
  263. return fmt.Errorf("couldn't create params json: %v", err)
  264. }
  265. l, err := CreateLayer(paramData)
  266. if err != nil {
  267. return fmt.Errorf("failed to create layer: %v", err)
  268. }
  269. l.MediaType = "application/vnd.ollama.image.params"
  270. layers = append(layers, l)
  271. }
  272. digests, err := getLayerDigests(layers)
  273. if err != nil {
  274. return err
  275. }
  276. var manifestLayers []*Layer
  277. for _, l := range layers {
  278. manifestLayers = append(manifestLayers, &l.Layer)
  279. }
  280. // Create a layer for the config object
  281. fn(api.ProgressResponse{Status: "creating config layer"})
  282. cfg, err := createConfigLayer(digests)
  283. if err != nil {
  284. return err
  285. }
  286. layers = append(layers, cfg)
  287. err = SaveLayers(layers, fn, false)
  288. if err != nil {
  289. return err
  290. }
  291. // Create the manifest
  292. fn(api.ProgressResponse{Status: "writing manifest"})
  293. err = CreateManifest(name, cfg, manifestLayers)
  294. if err != nil {
  295. return err
  296. }
  297. fn(api.ProgressResponse{Status: "success"})
  298. return nil
  299. }
  300. func removeLayerFromLayers(layers []*LayerReader, mediaType string) []*LayerReader {
  301. j := 0
  302. for _, l := range layers {
  303. if l.MediaType != mediaType {
  304. layers[j] = l
  305. j++
  306. }
  307. }
  308. return layers[:j]
  309. }
  310. func SaveLayers(layers []*LayerReader, fn func(resp api.ProgressResponse), force bool) error {
  311. // Write each of the layers to disk
  312. for _, layer := range layers {
  313. fp, err := GetBlobsPath(layer.Digest)
  314. if err != nil {
  315. return err
  316. }
  317. _, err = os.Stat(fp)
  318. if os.IsNotExist(err) || force {
  319. fn(api.ProgressResponse{Status: fmt.Sprintf("writing layer %s", layer.Digest)})
  320. out, err := os.Create(fp)
  321. if err != nil {
  322. log.Printf("couldn't create %s", fp)
  323. return err
  324. }
  325. defer out.Close()
  326. if _, err = io.Copy(out, layer.Reader); err != nil {
  327. return err
  328. }
  329. } else {
  330. fn(api.ProgressResponse{Status: fmt.Sprintf("using already created layer %s", layer.Digest)})
  331. }
  332. }
  333. return nil
  334. }
  335. func CreateManifest(name string, cfg *LayerReader, layers []*Layer) error {
  336. mp := ParseModelPath(name)
  337. manifest := ManifestV2{
  338. SchemaVersion: 2,
  339. MediaType: "application/vnd.docker.distribution.manifest.v2+json",
  340. Config: Layer{
  341. MediaType: cfg.MediaType,
  342. Size: cfg.Size,
  343. Digest: cfg.Digest,
  344. },
  345. Layers: layers,
  346. }
  347. manifestJSON, err := json.Marshal(manifest)
  348. if err != nil {
  349. return err
  350. }
  351. fp, err := mp.GetManifestPath(true)
  352. if err != nil {
  353. return err
  354. }
  355. return os.WriteFile(fp, manifestJSON, 0o644)
  356. }
  357. func GetLayerWithBufferFromLayer(layer *Layer) (*LayerReader, error) {
  358. fp, err := GetBlobsPath(layer.Digest)
  359. if err != nil {
  360. return nil, err
  361. }
  362. file, err := os.Open(fp)
  363. if err != nil {
  364. return nil, fmt.Errorf("could not open blob: %w", err)
  365. }
  366. defer file.Close()
  367. newLayer, err := CreateLayer(file)
  368. if err != nil {
  369. return nil, err
  370. }
  371. newLayer.MediaType = layer.MediaType
  372. return newLayer, nil
  373. }
  374. // paramsToReader converts specified parameter options to their correct types, and returns a reader for the json
  375. func paramsToReader(params map[string][]string) (io.ReadSeeker, error) {
  376. opts := api.Options{}
  377. valueOpts := reflect.ValueOf(&opts).Elem() // names of the fields in the options struct
  378. typeOpts := reflect.TypeOf(opts) // types of the fields in the options struct
  379. // build map of json struct tags to their types
  380. jsonOpts := make(map[string]reflect.StructField)
  381. for _, field := range reflect.VisibleFields(typeOpts) {
  382. jsonTag := strings.Split(field.Tag.Get("json"), ",")[0]
  383. if jsonTag != "" {
  384. jsonOpts[jsonTag] = field
  385. }
  386. }
  387. out := make(map[string]interface{})
  388. // iterate params and set values based on json struct tags
  389. for key, vals := range params {
  390. if opt, ok := jsonOpts[key]; ok {
  391. field := valueOpts.FieldByName(opt.Name)
  392. if field.IsValid() && field.CanSet() {
  393. switch field.Kind() {
  394. case reflect.Float32:
  395. floatVal, err := strconv.ParseFloat(vals[0], 32)
  396. if err != nil {
  397. return nil, fmt.Errorf("invalid float value %s", vals)
  398. }
  399. out[key] = floatVal
  400. case reflect.Int:
  401. intVal, err := strconv.ParseInt(vals[0], 10, 0)
  402. if err != nil {
  403. return nil, fmt.Errorf("invalid int value %s", vals)
  404. }
  405. out[key] = intVal
  406. case reflect.Bool:
  407. boolVal, err := strconv.ParseBool(vals[0])
  408. if err != nil {
  409. return nil, fmt.Errorf("invalid bool value %s", vals)
  410. }
  411. out[key] = boolVal
  412. case reflect.String:
  413. out[key] = vals[0]
  414. case reflect.Slice:
  415. // TODO: only string slices are supported right now
  416. out[key] = vals
  417. default:
  418. return nil, fmt.Errorf("unknown type %s for %s", field.Kind(), key)
  419. }
  420. }
  421. }
  422. }
  423. bts, err := json.Marshal(out)
  424. if err != nil {
  425. return nil, err
  426. }
  427. return bytes.NewReader(bts), nil
  428. }
  429. func getLayerDigests(layers []*LayerReader) ([]string, error) {
  430. var digests []string
  431. for _, l := range layers {
  432. if l.Digest == "" {
  433. return nil, fmt.Errorf("layer is missing a digest")
  434. }
  435. digests = append(digests, l.Digest)
  436. }
  437. return digests, nil
  438. }
  439. // CreateLayer creates a Layer object from a given file
  440. func CreateLayer(f io.ReadSeeker) (*LayerReader, error) {
  441. digest, size := GetSHA256Digest(f)
  442. f.Seek(0, 0)
  443. layer := &LayerReader{
  444. Layer: Layer{
  445. MediaType: "application/vnd.docker.image.rootfs.diff.tar",
  446. Digest: digest,
  447. Size: size,
  448. },
  449. Reader: f,
  450. }
  451. return layer, nil
  452. }
  453. func CopyModel(src, dest string) error {
  454. srcPath, err := ParseModelPath(src).GetManifestPath(false)
  455. if err != nil {
  456. return err
  457. }
  458. destPath, err := ParseModelPath(dest).GetManifestPath(true)
  459. if err != nil {
  460. return err
  461. }
  462. // copy the file
  463. input, err := os.ReadFile(srcPath)
  464. if err != nil {
  465. fmt.Println("Error reading file:", err)
  466. return err
  467. }
  468. err = os.WriteFile(destPath, input, 0o644)
  469. if err != nil {
  470. fmt.Println("Error reading file:", err)
  471. return err
  472. }
  473. return nil
  474. }
  475. func DeleteModel(name string) error {
  476. mp := ParseModelPath(name)
  477. manifest, err := GetManifest(mp)
  478. if err != nil {
  479. return err
  480. }
  481. deleteMap := make(map[string]bool)
  482. for _, layer := range manifest.Layers {
  483. deleteMap[layer.Digest] = true
  484. }
  485. deleteMap[manifest.Config.Digest] = true
  486. fp, err := GetManifestPath()
  487. if err != nil {
  488. return err
  489. }
  490. err = filepath.Walk(fp, func(path string, info os.FileInfo, err error) error {
  491. if err != nil {
  492. return err
  493. }
  494. if !info.IsDir() {
  495. path := path[len(fp)+1:]
  496. slashIndex := strings.LastIndex(path, "/")
  497. if slashIndex == -1 {
  498. return nil
  499. }
  500. tag := path[:slashIndex] + ":" + path[slashIndex+1:]
  501. fmp := ParseModelPath(tag)
  502. // skip the manifest we're trying to delete
  503. if mp.GetFullTagname() == fmp.GetFullTagname() {
  504. return nil
  505. }
  506. // save (i.e. delete from the deleteMap) any files used in other manifests
  507. manifest, err := GetManifest(fmp)
  508. if err != nil {
  509. log.Printf("skipping file: %s", fp)
  510. return nil
  511. }
  512. for _, layer := range manifest.Layers {
  513. delete(deleteMap, layer.Digest)
  514. }
  515. delete(deleteMap, manifest.Config.Digest)
  516. }
  517. return nil
  518. })
  519. if err != nil {
  520. return err
  521. }
  522. if err != nil {
  523. return err
  524. }
  525. // only delete the files which are still in the deleteMap
  526. for k, v := range deleteMap {
  527. if v {
  528. fp, err := GetBlobsPath(k)
  529. if err != nil {
  530. log.Printf("couldn't get file path for '%s': %v", k, err)
  531. continue
  532. }
  533. if err := os.Remove(fp); err != nil {
  534. log.Printf("couldn't remove file '%s': %v", fp, err)
  535. continue
  536. }
  537. }
  538. }
  539. fp, err = mp.GetManifestPath(false)
  540. if err != nil {
  541. return err
  542. }
  543. err = os.Remove(fp)
  544. if err != nil {
  545. log.Printf("couldn't remove manifest file '%s': %v", fp, err)
  546. return err
  547. }
  548. return nil
  549. }
  550. func PushModel(name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  551. mp := ParseModelPath(name)
  552. fn(api.ProgressResponse{Status: "retrieving manifest"})
  553. manifest, err := GetManifest(mp)
  554. if err != nil {
  555. fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
  556. return err
  557. }
  558. var layers []*Layer
  559. layers = append(layers, manifest.Layers...)
  560. layers = append(layers, &manifest.Config)
  561. for _, layer := range layers {
  562. exists, err := checkBlobExistence(mp, layer.Digest, regOpts)
  563. if err != nil {
  564. return err
  565. }
  566. if exists {
  567. fn(api.ProgressResponse{
  568. Status: "using existing layer",
  569. Digest: layer.Digest,
  570. Total: layer.Size,
  571. Completed: layer.Size,
  572. })
  573. log.Printf("Layer %s already exists", layer.Digest)
  574. continue
  575. }
  576. fn(api.ProgressResponse{
  577. Status: "starting upload",
  578. Digest: layer.Digest,
  579. Total: layer.Size,
  580. })
  581. location, err := startUpload(mp, regOpts)
  582. if err != nil {
  583. log.Printf("couldn't start upload: %v", err)
  584. return err
  585. }
  586. err = uploadBlobChunked(mp, location, layer, regOpts, fn)
  587. if err != nil {
  588. log.Printf("error uploading blob: %v", err)
  589. return err
  590. }
  591. }
  592. fn(api.ProgressResponse{Status: "pushing manifest"})
  593. url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
  594. headers := map[string]string{
  595. "Content-Type": "application/vnd.docker.distribution.manifest.v2+json",
  596. }
  597. manifestJSON, err := json.Marshal(manifest)
  598. if err != nil {
  599. return err
  600. }
  601. resp, err := makeRequest("PUT", url, headers, bytes.NewReader(manifestJSON), regOpts)
  602. if err != nil {
  603. return err
  604. }
  605. defer resp.Body.Close()
  606. // Check for success: For a successful upload, the Docker registry will respond with a 201 Created
  607. if resp.StatusCode != http.StatusCreated {
  608. body, _ := io.ReadAll(resp.Body)
  609. return fmt.Errorf("on push registry responded with code %d: %v", resp.StatusCode, string(body))
  610. }
  611. fn(api.ProgressResponse{Status: "success"})
  612. return nil
  613. }
  614. func PullModel(name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  615. mp := ParseModelPath(name)
  616. fn(api.ProgressResponse{Status: "pulling manifest"})
  617. manifest, err := pullModelManifest(mp, regOpts)
  618. if err != nil {
  619. return fmt.Errorf("pull model manifest: %s", err)
  620. }
  621. var layers []*Layer
  622. layers = append(layers, manifest.Layers...)
  623. layers = append(layers, &manifest.Config)
  624. for _, layer := range layers {
  625. if err := downloadBlob(mp, layer.Digest, regOpts, fn); err != nil {
  626. return err
  627. }
  628. }
  629. fn(api.ProgressResponse{Status: "verifying sha256 digest"})
  630. for _, layer := range layers {
  631. if err := verifyBlob(layer.Digest); err != nil {
  632. if errors.Is(err, errDigestMismatch) {
  633. // something went wrong, delete the blob
  634. fp, err := GetBlobsPath(layer.Digest)
  635. if err != nil {
  636. return err
  637. }
  638. if err := os.Remove(fp); err != nil {
  639. // log this, but return the original error
  640. log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
  641. }
  642. }
  643. return err
  644. }
  645. }
  646. fn(api.ProgressResponse{Status: "writing manifest"})
  647. manifestJSON, err := json.Marshal(manifest)
  648. if err != nil {
  649. return err
  650. }
  651. fp, err := mp.GetManifestPath(true)
  652. if err != nil {
  653. return err
  654. }
  655. err = os.WriteFile(fp, manifestJSON, 0o644)
  656. if err != nil {
  657. log.Printf("couldn't write to %s", fp)
  658. return err
  659. }
  660. fn(api.ProgressResponse{Status: "success"})
  661. return nil
  662. }
  663. func pullModelManifest(mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
  664. url := fmt.Sprintf("%s/v2/%s/manifests/%s", mp.Registry, mp.GetNamespaceRepository(), mp.Tag)
  665. headers := map[string]string{
  666. "Accept": "application/vnd.docker.distribution.manifest.v2+json",
  667. }
  668. resp, err := makeRequest("GET", url, headers, nil, regOpts)
  669. if err != nil {
  670. log.Printf("couldn't get manifest: %v", err)
  671. return nil, err
  672. }
  673. defer resp.Body.Close()
  674. // Check for success: For a successful upload, the Docker registry will respond with a 201 Created
  675. if resp.StatusCode != http.StatusOK {
  676. if resp.StatusCode == http.StatusNotFound {
  677. return nil, fmt.Errorf("model not found")
  678. }
  679. body, _ := io.ReadAll(resp.Body)
  680. return nil, fmt.Errorf("on pull registry responded with code %d: %s", resp.StatusCode, body)
  681. }
  682. var m *ManifestV2
  683. if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
  684. return nil, err
  685. }
  686. return m, err
  687. }
  688. func createConfigLayer(layers []string) (*LayerReader, error) {
  689. // TODO change architecture and OS
  690. config := ConfigV2{
  691. Architecture: "arm64",
  692. OS: "linux",
  693. RootFS: RootFS{
  694. Type: "layers",
  695. DiffIDs: layers,
  696. },
  697. }
  698. configJSON, err := json.Marshal(config)
  699. if err != nil {
  700. return nil, err
  701. }
  702. digest, size := GetSHA256Digest(bytes.NewBuffer(configJSON))
  703. layer := &LayerReader{
  704. Layer: Layer{
  705. MediaType: "application/vnd.docker.container.image.v1+json",
  706. Digest: digest,
  707. Size: size,
  708. },
  709. Reader: bytes.NewBuffer(configJSON),
  710. }
  711. return layer, nil
  712. }
  713. // GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
  714. func GetSHA256Digest(r io.Reader) (string, int) {
  715. h := sha256.New()
  716. n, err := io.Copy(h, r)
  717. if err != nil {
  718. log.Fatal(err)
  719. }
  720. return fmt.Sprintf("sha256:%x", h.Sum(nil)), int(n)
  721. }
  722. func startUpload(mp ModelPath, regOpts *RegistryOptions) (string, error) {
  723. url := fmt.Sprintf("%s/v2/%s/blobs/uploads/", mp.Registry, mp.GetNamespaceRepository())
  724. resp, err := makeRequest("POST", url, nil, nil, regOpts)
  725. if err != nil {
  726. log.Printf("couldn't start upload: %v", err)
  727. return "", err
  728. }
  729. defer resp.Body.Close()
  730. // Check for success
  731. if resp.StatusCode != http.StatusAccepted {
  732. body, _ := io.ReadAll(resp.Body)
  733. return "", fmt.Errorf("on upload registry responded with code %d: %s", resp.StatusCode, body)
  734. }
  735. // Extract UUID location from header
  736. location := resp.Header.Get("Location")
  737. if location == "" {
  738. return "", fmt.Errorf("location header is missing in response")
  739. }
  740. return location, nil
  741. }
  742. // Function to check if a blob already exists in the Docker registry
  743. func checkBlobExistence(mp ModelPath, digest string, regOpts *RegistryOptions) (bool, error) {
  744. url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
  745. resp, err := makeRequest("HEAD", url, nil, nil, regOpts)
  746. if err != nil {
  747. log.Printf("couldn't check for blob: %v", err)
  748. return false, err
  749. }
  750. defer resp.Body.Close()
  751. // Check for success: If the blob exists, the Docker registry will respond with a 200 OK
  752. return resp.StatusCode == http.StatusOK, nil
  753. }
  754. func uploadBlobChunked(mp ModelPath, url string, layer *Layer, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  755. // TODO allow resumability
  756. // TODO allow canceling uploads via DELETE
  757. // TODO allow cross repo blob mount
  758. fp, err := GetBlobsPath(layer.Digest)
  759. if err != nil {
  760. return err
  761. }
  762. f, err := os.Open(fp)
  763. if err != nil {
  764. return err
  765. }
  766. totalUploaded := 0
  767. r, w := io.Pipe()
  768. defer r.Close()
  769. go func() {
  770. defer w.Close()
  771. for {
  772. n, err := io.CopyN(w, f, 1024*1024)
  773. if err != nil && !errors.Is(err, io.EOF) {
  774. fn(api.ProgressResponse{
  775. Status: fmt.Sprintf("error copying pipe: %v", err),
  776. Digest: layer.Digest,
  777. Total: layer.Size,
  778. Completed: totalUploaded,
  779. })
  780. return
  781. }
  782. totalUploaded += int(n)
  783. fn(api.ProgressResponse{
  784. Status: fmt.Sprintf("uploading %s", layer.Digest),
  785. Digest: layer.Digest,
  786. Total: layer.Size,
  787. Completed: totalUploaded,
  788. })
  789. if totalUploaded >= layer.Size {
  790. return
  791. }
  792. }
  793. }()
  794. url = fmt.Sprintf("%s&digest=%s", url, layer.Digest)
  795. headers := make(map[string]string)
  796. headers["Content-Type"] = "application/octet-stream"
  797. headers["Content-Range"] = fmt.Sprintf("0-%d", layer.Size-1)
  798. headers["Content-Length"] = strconv.Itoa(int(layer.Size))
  799. // finish the upload
  800. resp, err := makeRequest("PUT", url, headers, r, regOpts)
  801. if err != nil {
  802. log.Printf("couldn't finish upload: %v", err)
  803. return err
  804. }
  805. defer resp.Body.Close()
  806. if resp.StatusCode != http.StatusCreated {
  807. body, _ := io.ReadAll(resp.Body)
  808. return fmt.Errorf("on finish upload registry responded with code %d: %v", resp.StatusCode, string(body))
  809. }
  810. return nil
  811. }
  812. func downloadBlob(mp ModelPath, digest string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
  813. fp, err := GetBlobsPath(digest)
  814. if err != nil {
  815. return err
  816. }
  817. if fi, _ := os.Stat(fp); fi != nil {
  818. // we already have the file, so return
  819. fn(api.ProgressResponse{
  820. Digest: digest,
  821. Total: int(fi.Size()),
  822. Completed: int(fi.Size()),
  823. })
  824. return nil
  825. }
  826. var size int64
  827. chunkSize := 1024 * 1024 // 1 MiB in bytes
  828. fi, err := os.Stat(fp + "-partial")
  829. switch {
  830. case errors.Is(err, os.ErrNotExist):
  831. // noop, file doesn't exist so create it
  832. case err != nil:
  833. return fmt.Errorf("stat: %w", err)
  834. default:
  835. size = fi.Size()
  836. // Ensure the size is divisible by the chunk size by removing excess bytes
  837. size -= size % int64(chunkSize)
  838. err := os.Truncate(fp+"-partial", size)
  839. if err != nil {
  840. return fmt.Errorf("truncate: %w", err)
  841. }
  842. }
  843. url := fmt.Sprintf("%s/v2/%s/blobs/%s", mp.Registry, mp.GetNamespaceRepository(), digest)
  844. headers := map[string]string{
  845. "Range": fmt.Sprintf("bytes=%d-", size),
  846. }
  847. resp, err := makeRequest("GET", url, headers, nil, regOpts)
  848. if err != nil {
  849. log.Printf("couldn't download blob: %v", err)
  850. return err
  851. }
  852. defer resp.Body.Close()
  853. if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusPartialContent {
  854. body, _ := io.ReadAll(resp.Body)
  855. return fmt.Errorf("on download registry responded with code %d: %v", resp.StatusCode, string(body))
  856. }
  857. err = os.MkdirAll(path.Dir(fp), 0o700)
  858. if err != nil {
  859. return fmt.Errorf("make blobs directory: %w", err)
  860. }
  861. out, err := os.OpenFile(fp+"-partial", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o644)
  862. if err != nil {
  863. return fmt.Errorf("open file: %w", err)
  864. }
  865. defer out.Close()
  866. remaining, _ := strconv.ParseInt(resp.Header.Get("Content-Length"), 10, 64)
  867. completed := size
  868. total := remaining + completed
  869. for {
  870. fn(api.ProgressResponse{
  871. Status: fmt.Sprintf("downloading %s", digest),
  872. Digest: digest,
  873. Total: int(total),
  874. Completed: int(completed),
  875. })
  876. if completed >= total {
  877. if err := out.Close(); err != nil {
  878. return err
  879. }
  880. if err := os.Rename(fp+"-partial", fp); err != nil {
  881. fn(api.ProgressResponse{
  882. Status: fmt.Sprintf("error renaming file: %v", err),
  883. Digest: digest,
  884. Total: int(total),
  885. Completed: int(completed),
  886. })
  887. return err
  888. }
  889. break
  890. }
  891. n, err := io.CopyN(out, resp.Body, int64(chunkSize))
  892. if err != nil && !errors.Is(err, io.EOF) {
  893. return err
  894. }
  895. completed += n
  896. }
  897. log.Printf("success getting %s\n", digest)
  898. return nil
  899. }
  900. func makeRequest(method, url string, headers map[string]string, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
  901. if !strings.HasPrefix(url, "http") {
  902. if regOpts.Insecure {
  903. url = "http://" + url
  904. } else {
  905. url = "https://" + url
  906. }
  907. }
  908. req, err := http.NewRequest(method, url, body)
  909. if err != nil {
  910. return nil, err
  911. }
  912. for k, v := range headers {
  913. req.Header.Set(k, v)
  914. }
  915. // TODO: better auth
  916. if regOpts.Username != "" && regOpts.Password != "" {
  917. req.SetBasicAuth(regOpts.Username, regOpts.Password)
  918. }
  919. client := &http.Client{
  920. CheckRedirect: func(req *http.Request, via []*http.Request) error {
  921. if len(via) >= 10 {
  922. return fmt.Errorf("too many redirects")
  923. }
  924. log.Printf("redirected to: %s\n", req.URL)
  925. return nil
  926. },
  927. }
  928. resp, err := client.Do(req)
  929. if err != nil {
  930. return nil, err
  931. }
  932. return resp, nil
  933. }
  934. var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")
  935. func verifyBlob(digest string) error {
  936. fp, err := GetBlobsPath(digest)
  937. if err != nil {
  938. return err
  939. }
  940. f, err := os.Open(fp)
  941. if err != nil {
  942. return err
  943. }
  944. defer f.Close()
  945. fileDigest, _ := GetSHA256Digest(f)
  946. if digest != fileDigest {
  947. return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
  948. }
  949. return nil
  950. }