package xen-gnt

  1. Overview
  2. Docs
Xen grant table bindings for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (1)

Authors

  1. A
    Anil Madhavapeddy
  2. J
    John Else
  3. T
    Thomas Leonard
  4. A
    Andrew Cooper
  5. D
    David Scott

Maintainers

  1. J
    john.else@citrix.com

Sources

xen-gnt-4.0.2.tbz
sha256=8afceb5955d20c0630fbfb7d255df1796873b112e33aeb7197540f5099a9e6a3
sha512=d85ca83e98e5ff3331638a9bdde33776b5e29c2863da6c962a8ffe18ebf773af97e310b8eea29ba2c9509bbb308ad2932b5bc7b388b7af32763c76db3adec661

doc/xen-gnt/Gnt/index.html

Module GntSource

Allow a local xen domain to read/write memory exported ("granted") from foreign domains. Safe memory sharing is a building block of all xen inter-domain communication protocols such as those for virtual network and disk devices.

Foreign domains will explicitly "grant" us access to certain memory regions such as disk buffers. These regions are uniquely identified by the pair of (foreign domain id, integer reference) which is passed to us over some existing channel (typically via xenstore keys or via structures in previously-shared memory region).

Common interface

Sourcetype gntref = int

Type of a grant table index, called a grant reference in Xen's terminology.

Receiving foreign pages

Sourcemodule Gnttab : sig ... end

Offering pages to foreign domains

Sourcemodule Gntshr : sig ... end
Sourceval console : gntref

In xen-4.2 and later, the domain builder will allocate one of the reserved grant table entries and use it to pre-authorise the console backend domain.

Sourceval xenstore : gntref

In xen-4.2 and later, the domain builder will allocate one of the reserved grant table entries and use it to pre-authorise the xenstore backend domain.

Functions called by Sched, do not call directly.

Sourceval suspend : unit -> unit
Sourceval resume : unit -> unit