package mirage

  1. Overview
  2. Docs
The MirageOS library operating system

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Gazagnaire
  2. A
    Anil Madhavapeddy
  3. Gabriel Radanne
  4. M
    Mindy Preston
  5. T
    Thomas Leonard
  6. N
    Nicolas Ojeda Bar
  7. D
    Dave Scott
  8. D
    David Kaloper
  9. H
    Hannes Mehnert
  10. R
    Richard Mortier

Maintainers

  1. A
    anil@recoil.org
  2. T
    thomas@gazagnaire.org

Sources

mirage-4.10.3.tbz
sha256=648db61b37ba27281a16d4917ef963f36d84c22d9f0596ca1955e871bdce8133
sha512=74da93861e0d915564db77dee56aa207a53bc35f75087dd78c9fcd8f24fbdea68c04404b901b90ba62c8b577be9fda0b8980322c6e8a2f423c6c6f6b96779f45

doc/mirage.devices/Devices/Key/index.html

Module Devices.KeySource

Command-line arguments for the Mirage configuration tool.

include module type of Functoria.Key

Configuration Keys

Sourcetype 'a key = 'a Functoria.Key.key

The type for configuration keys. Keys are used to parameterize the choice of module implementation.

Sourceval create : string -> 'a Arg.t -> 'a key

create n a is the key named n whose contents is determined by parsing the command-line argument a.

Configuration Values

Sourcetype +'a value = 'a Functoria.Key.value

The type for configure-time and run-time values. Values are either pure or obtained by composing other values. Values might have data dependencies, which form an (implicit) directed and acyclic graph that need to be evaluated.

Sourceval pure : 'a -> 'a value

pure x is a value without any dependency.

Sourceval ($) : ('a -> 'b) value -> 'a value -> 'b value

f $ v is is the value resulting from the application of f'value to v's value. $ is the usual app operator for applicative functor.

Sourceval map : ('a -> 'b) -> 'a value -> 'b value

map f v is pure f $ v.

Sourceval if_ : bool value -> 'a -> 'a -> 'a value

if_ v x y is map (fun b -> if b then x else y) v.

Sourceval match_ : 'a value -> ('a -> 'b) -> 'b value

match_ v pattern is map pattern v.

Sourceval default : 'a value -> 'a

default v returns the default value for v.

Sourceval value : 'a key -> 'a value

value k is the value parsed by k.

Abstract Keys

The type for abstract keys.

Sourceval name : t -> string

name t is the string given as t's name when t was created.

Sourceval v : 'a key -> t

v k is the k with its type hidden.

Sourceval equal : t -> t -> bool

equal is the equality function of untyped keys.

Sourceval pp : t Fmt.t

pp fmt k prints the name of k.

Set implements sets over t elements.

Sourceval of_deps : Set.t -> unit value

of_deps keys is a value with keys as data-dependencies.

Sourceval deps : 'a value -> Set.t

deps v are v's data-dependencies.

Sourceval pp_deps : 'a value Fmt.t

pp_deps fmt v prints the name of the dependencies of v.

Parsing context

type context := Functoria.Context.t

The type for values holding parsing context.

Sourceval add_to_context : 'a key -> 'a -> context -> context

Add a binding to a context.

context ks is a Cmdliner term that evaluates into a parsing context for command-line arguments.

Sourceval mem : context -> 'a value -> bool

mem c v is true iff all the dependencies of v have been evaluated.

Sourceval peek : context -> 'a value -> 'a option

peek c v is Some x if mem v and None otherwise.

Sourceval eval : context -> 'a value -> 'a

eval c v evaluates v in c's context, using default values if necessary.

Sourceval get : context -> 'a key -> 'a

get c k is k's value in c's context. If k is not present in c, it is k's default value.

Sourceval find : context -> 'a key -> 'a option

find c k is k's value in c's context or None if k is not present in c.

pps c fmt ks prints the keys ks using the context c to get their value.

Sourcetype mode_unix = [
  1. | `Unix
  2. | `MacOSX
]
Sourcetype mode_xen = [
  1. | `Xen
  2. | `Qubes
]
Sourcetype mode_solo5 = [
  1. | `Hvt
  2. | `Spt
  3. | `Virtio
  4. | `Muen
  5. | `Genode
]
Sourcetype mode_unikraft = [
  1. | `Firecracker
  2. | `QEMU
]

Mirage keys

Sourceval target : mode key

-t TARGET: Key setting the configuration mode for the current project. Is one of "unix", "macosx", "xen", "qubes", "virtio", "hvt", "muen", "genode" or "spt".

Sourceval pp_target : mode Fmt.t

Pretty printer for the mode.

Sourceval is_unix : bool value

Is true iff the target key is a UNIXish system ("unix" or "macosx").

Sourceval is_solo5 : bool value

Is true iff the target key is a Solo5-based target.

Sourceval is_xen : bool value

Is true iff the target key is a Xen-based system ("xen" or "qubes").

Sourceval is_unikraft : bool value

Is true iff the target key is a Unikraft-based target.

Generic keys

Some keys have a group optional argument. This group argument allows to give several keys a prefix.

For example, if we have two ip stacks, one external and one internal, We can use the group option to name them in and out. This way, the available keys will be --in-ip and --out-ip.

If a key has another, non-optional argument. It is the default value.

Keys are always named the same as their command line option.

File system keys

Sourceval kv_ro : ?group:string -> unit -> [ `Crunch | `Direct ] key

The type of key value store. Is one of "crunch", or "direct".

Sourceval block : ?group:string -> unit -> [ `XenstoreId | `BlockFile | `Ramdisk ] key

Block device keys

Stack keys

Sourceval dhcp : ?group:string -> unit -> bool key

Enable dhcp. Is either true or false.

Sourceval net : ?group:string -> unit -> [ `OCaml | `Host ] option key

The type of stack. Is either "ocaml" or "host".