package qcow

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package qcow

qcow
- Qcow
  - Make
    
    B
    
    Config
    
    Debug
    
    Setting
    
    Stats
    
    Time
- Qcow_bitmap
  - Interval
  - Test
- Qcow_block_cache
  - Make
    
    B
- Qcow_cache
  - Debug
- Qcow_cluster_map
  - Available
  - Copies
  - Debug
  - Erased
  - Junk
  - Move
  - MutableSet
  - Roots
- Qcow_config
- Qcow_cstructs
  - BE
- Qcow_debug
- Qcow_diet
  - ELT
  - Make
    
    Elt
    
    Interval
  - Test
- Qcow_error
  - Lwt_error
    
    Infix
    
    List
  - Lwt_write_error
    
    Infix
- Qcow_header
- Qcow_int
  - IntervalSet
    
    Interval
  - Map
- Qcow_int64
  - IntervalSet
    
    Interval
  - Map
- Qcow_locks
  - Client
  - Debug
  - Read
  - Write
- Qcow_metadata
  - Physical
  - Refcounts
- Qcow_padded
  - Make
    
    B
- Qcow_physical
- Qcow_recycler
  - Make
    
    B
    
    Time
- Qcow_rwlock
  - Client
  - Debug
  - Read
  - Write
- Qcow_s
  - INTERVAL_SET
    
    Interval
  - LOG
  - NUM
  - PRINTABLE
  - RESIZABLE_BLOCK
  - SERIALISABLE
- Qcow_types
  - Cluster
    
    IntervalSet
    
    Interval
    
    Map
  - Int
    
    IntervalSet
    
    Interval
    
    Map
  - Int16
  - Int32
  - Int64
    
    IntervalSet
    
    Interval
    
    Map
  - Int8
- Qcow_virtual
- Qcow_word_size
  - Cluster
    
    IntervalSet
    
    Interval
    
    Map

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module B : Qcow_s.RESIZABLE_BLOCK

module Time : Mirage_time_lwt.S

Signature

type t

A cluster recycling engine

val create : 
  base:B.t ->
  sector_size:int ->
  cluster_bits:int ->
  cache:Qcow_cache.t ->
  locks:Qcow_locks.t ->
  metadata:Qcow_metadata.t ->
  runtime_asserts:bool ->
  t

Initialise a cluster recycler over the given block device

val set_cluster_map : t -> Qcow_cluster_map.t -> unit

Set the associated cluster map (which will be updated on every cluster write)

val start_background_thread : 
  t ->
  keep_erased:int64 ->
  ?compact_after_unmaps:int64 ->
  unit ->
  unit

Start a background thread which will perform block recycling

val allocate : 
  t ->
  Qcow_types.Cluster.t ->
  Qcow_types.Cluster.IntervalSet.t option

allocate t n returns n clusters which are ready for re-use. If there are not enough clusters free then this returns None.

val erase : 
  t ->
  Qcow_types.Cluster.IntervalSet.t ->
  (unit, B.write_error) Pervasives.result Lwt.t

Write zeroes over the specified set of clusters

val copy : 
  t ->
  Qcow_types.Cluster.t ->
  Qcow_types.Cluster.t ->
  (unit, B.write_error) Pervasives.result Lwt.t

copy src dst copies the cluster src to dst

val move_all : 
  ?progress_cb:(percent:int -> unit) ->
  t ->
  Qcow_cluster_map.Move.t list ->
  (unit, Qcow_metadata.write_error) Pervasives.result Lwt.t

move_all t mv perform the initial data copy of the move operations mv

val update_references : 
  t ->
  (int64, Qcow_metadata.write_error) Pervasives.result Lwt.t

update_references t rewrites references to any recently copied and flushed block, returning the number of writes completed.

val flush : t -> (unit, B.write_error) Pervasives.result Lwt.t

Issue a flush to the block device, update internal recycler state.