package mirage-block

  1. Overview
  2. Docs
Block signatures and implementations for MirageOS

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-block-v2.0.1.tbz
sha256=8cd1386e7a6ca2c9c3bf04102ed66bd72e3a40ead31abc9716317dd563e5e8f2
sha512=b894f9d7a2269521ce82e17371abc60fc0de76d7c93477e48c2f95baaa2f3d936eedd8e7aee8473252f77352a3ba0ef430ab0ae806a2d22ff75381349029b4c6

Description

This repo contains generic operations over Mirage BLOCK devices.

Tags

org:mirage

Published: 05 Nov 2019

README

Block implementations for mirage

This repo contains generic operations over Mirage BLOCK devices.

Please consult the API documentation.

Example usage

In a top-level like utop:

# #require "io-page.unix";;
# #require "mirage-block";;
# #require "mirage-block-ramdisk";;
# #require "lwt.syntax";;

# lwt t_or_error = Ramdisk.create ~name:"hello" ~size_sectors:1024L ~sector_size:512;;
val t_or_error : [ `Error of Ramdisk.error | `Ok of Ramdisk.t ] = `Ok <abstr>

# let t = Mirage_block.Error.ok_exn t_or_error;;
val t : Ramdisk.t = <abstr>

# let page = Io_page.(to_cstruct (get 1));;
val page : Ramdisk.page_aligned_buffer =
  {Cstruct.buffer = <abstr>; off = 0; len = 4096}

# lwt result_or_error = Ramdisk.read t 0L [ page ];;
val result_or_error : [ `Error of Ramdisk.error | `Ok of unit ] = `Ok ()

# lwt ok_or_error = Mirage_block.sparse_copy (module Ramdisk) t (module Ramdisk) t;;
val ok_or_error :
  [ `Error of [> `Different_sizes | `Is_read_only | `Msg of bytes ]
  | `Ok of unit ] = `Ok ()

Dependencies (5)

  1. cstruct >= "4.0.0"
  2. lwt >= "4.0.0"
  3. mirage-device >= "2.0.0"
  4. dune >= "1.0"
  5. ocaml >= "4.06.0"

Dev Dependencies

None

Used by (17)

  1. docteur-unix < "0.0.3"
  2. fat-filesystem >= "0.14.0" & < "0.15.1"
  3. mirage-block-ccm >= "1.1.0"
  4. mirage-block-combinators = "2.0.1"
  5. mirage-block-ramdisk >= "0.5"
  6. mirage-block-solo5 >= "0.6.1"
  7. mirage-block-unix >= "2.12.0"
  8. mirage-block-xen >= "1.7.0"
  9. mirage-types >= "3.7.1"
  10. nbd = "6.0.0"
  11. nbd-tool < "6.0.1"
  12. nbd-unix
  13. qcow >= "0.11.0"
  14. qcow-tool >= "0.11.0"
  15. shared-block-ring = "3.0.0"
  16. tar-mirage >= "2.0.0"
  17. vhd-format-lwt >= "0.12.1"

Conflicts

None