Module Mirage

Mirage combinators.

Mirage devices a set of devices and combinator to to define portable applications across all platforms that MirageOS supports.

Release v3.10.4

module Key : module type of sig ... end

Configuration keys.

include Functoria_app.DSL
type !'d typ = 'd Functoria.typ =
| Type : 'a -> 'a typ
| Function : 'b typ * 'c typ -> ('b -> 'c) typ
val typ : 'a -> 'a typ
val (@->) : 'a typ -> 'b typ -> ('a -> 'b) typ
type job = Functoria.job
val job : job typ
type 'a impl = 'a Functoria.impl
val ($) : ('a -> 'b) impl -> 'a impl -> 'b impl
type abstract_impl = Functoria.abstract_impl =
| Abstract : 'a impl -> abstract_impl
val abstract : 'a impl -> abstract_impl
type key = Functoria_key.t
type context = Functoria_key.context
type 'a value = 'a Functoria_key.value
val if_impl : bool value -> 'a impl -> 'a impl -> 'a impl
val match_impl : 'b value -> default:'a impl -> ('b * 'a impl) list -> 'a impl
module type KEY = sig ... end
type package = private Functoria.package = {
opam : string;
pin : string option;
build : bool;
ocamlfind : Astring.String.Set.t;
min : Astring.String.Set.t;
max : Astring.String.Set.t;
}
val package : ?⁠build:bool -> ?⁠sublibs:string list -> ?⁠ocamlfind:string list -> ?⁠min:string -> ?⁠max:string -> ?⁠pin:string -> string -> package
val foreign : ?⁠packages:package list -> ?⁠keys:key list -> ?⁠deps:abstract_impl list -> string -> 'a typ -> 'a impl
module Info = Functoria.Info
class type !'ty configurable = object ... end
val impl : 'a configurable -> 'a impl
class base_configurable : object ... end
class !'a foreign : ?⁠packages:package list -> ?⁠keys:key list -> ?⁠deps:abstract_impl list -> string -> 'a typ -> 'a configurable
val hash : 'a impl -> int
val equal : 'a impl -> 'a impl -> bool
module ImplTbl = Functoria.ImplTbl
val explode : 'a impl -> [ `App of abstract_impl * abstract_impl | `If of bool value * 'a impl * 'a impl | `Impl of 'a configurable ]

General mirage devices

type tracing

The type for tracing.

val tracing : tracing typ

Implementation of the tracing type.

val mprof_trace : size:int -> unit -> tracing impl

Use mirage-profile to trace the unikernel. On Unix, this creates and mmaps a file called "trace.ctf". On Xen, it shares the trace buffer with dom0.

parameter size:

size of the ring buffer to use.

type qubesdb
val qubesdb : qubesdb typ

For the Qubes target, the Qubes database from which to look up * dynamic runtime configuration information.

val default_qubesdb : qubesdb impl

A default qubes database, guessed from the usual valid configurations.

Time

type time

Abstract type for timers.

val time : time typ

Implementations of the Mirage_types.TIME signature.

val default_time : time impl

The default timer implementation.

Clocks

type pclock

Abstract type for POSIX clocks.

val pclock : pclock typ

Implementations of the Mirage_types.PCLOCK signature.

val default_posix_clock : pclock impl

The default mirage-clock PCLOCK implementation.

type mclock

Abstract type for monotonic clocks

val mclock : mclock typ

Implementations of the Mirage_types.MCLOCK signature.

val default_monotonic_clock : mclock impl

The default mirage-clock MCLOCK implementation.

Log reporters

type reporter

The type for log reporters.

val reporter : reporter typ

Implementation of the log reporter type.

val default_reporter : ?⁠clock:pclock impl -> ?⁠ring_size:int -> ?⁠level:Logs.level -> unit -> reporter impl

default_reporter ?clock ?level () is the log reporter that prints log messages to the console, timestampted with clock. If not provided, the default clock is default_posix_clock. level is the default log threshold. It is Logs.Info if not specified.

val no_reporter : reporter impl

no_reporter disable log reporting.

Random

type random

Abstract type for random sources.

val random : random typ

Implementations of the Mirage_types.RANDOM signature.

val stdlib_random : random impl

Passthrough to the OCaml Random generator.

val nocrypto_random : random impl

Passthrough to the Fortuna PRNG implemented in nocrypto.

val default_random : random impl

Default PRNG device to be used in unikernels. It uses getrandom/getentropy on Unix, and a Fortuna PRNG on other targets.

Consoles

type console

Abstract type for consoles.

val console : console typ

Implementations of the Mirage_types.CONSOLE signature.

val default_console : console impl

Default console implementation.

val custom_console : string -> console impl

Custom console implementation.

Block devices

type block

Abstract type for raw block device configurations.

val block : block typ

Implementations of the Mirage_types.BLOCK signature.

val block_of_file : string -> block impl

Use the given file as a raw block device.

val block_of_xenstore_id : string -> block impl

Use the given XenStore ID (ex: /dev/xvdi1 or 51760) as a raw block device.

val ramdisk : string -> block impl

Use a ramdisk with the given name.

val generic_block : ?⁠group:string -> ?⁠key:[ `XenstoreId | `BlockFile | `Ramdisk ] value -> string -> block impl

Static key/value stores

type kv_ro

Abstract type for read-only key/value store.

val kv_ro : kv_ro typ

Implementations of the Mirage_types.KV_RO signature.

val crunch : string -> kv_ro impl

Crunch a directory.

val archive : block impl -> kv_ro impl
val archive_of_files : ?⁠dir:string -> unit -> kv_ro impl
val direct_kv_ro : string -> kv_ro impl

Direct access to the underlying filesystem as a key/value store. For Xen backends, this is equivalent to crunch.

val generic_kv_ro : ?⁠group:string -> ?⁠key:[ `Archive | `Crunch | `Direct | `Fat ] value -> string -> kv_ro impl

Generic key/value that will choose dynamically between fat, archive and crunch. To use a filesystem implementation, try kv_ro_of_fs.

If no key is provided, it uses Key.kv_ro to create a new one.

type kv_rw

Abstract type for read-write key/value store.

val kv_rw : kv_rw typ

Implementations of the Mirage_types.KV_RW signature.

val direct_kv_rw : string -> kv_rw impl

Direct access to the underlying filesystem as a key/value store. Only available on Unix backends.

val kv_rw_mem : ?⁠clock:pclock impl -> unit -> kv_rw impl

An in-memory key-value store using mirage-kv-mem.

Filesystem

type fs

Abstract type for filesystems.

val fs : fs typ

Implementations of the Mirage_types.FS signature.

val fat : block impl -> fs impl

Consider a raw block device as a FAT filesystem.

val fat_of_files : ?⁠dir:string -> ?⁠regexp:string -> unit -> fs impl

fat_files dir ?dir ?regexp () collects all the files matching the shell pattern regexp in the directory dir into a FAT image. By default, dir is the current working directory and regexp is *

val kv_ro_of_fs : fs impl -> kv_ro impl

Consider a filesystem implementation as a read-only key/value store.

Network interfaces

type network

Abstract type for network configurations.

val network : network typ

Implementations of the Mirage_types.NETWORK signature.

val default_network : network impl

default_network is a dynamic network implementation * which attempts to do something reasonable based on the target.

val netif : ?⁠group:string -> string -> network impl

A custom network interface. Exposes a Key.interface key.

Ethernet configuration

type ethernet
val ethernet : ethernet typ

Implementations of the Mirage_types.ETHERNET signature.

val etif : network impl -> ethernet impl

ARP configuration

type arpv4
val arpv4 : arpv4 typ

Implementation of the Mirage_types.ARPV4 signature.

val arp : ?⁠time:time impl -> ethernet impl -> arpv4 impl

ARP implementation provided by the arp library

IP configuration

Implementations of the Mirage_types.IP signature.

type v4
type v6
type v4v6
type 'a ip

Abstract type for IP configurations.

type ipv4 = v4 ip
type ipv6 = v6 ip
type ipv4v6 = v4v6 ip
val ipv4 : ipv4 typ

The Mirage_types.IPV4 module signature.

val ipv6 : ipv6 typ

The Mirage_types.IPV6 module signature.

val ipv4v6 : ipv4v6 typ

The Mirage_types.IP module signature with ipaddr = Ipaddr.t.

type ipv4_config = {
network : Ipaddr.V4.Prefix.t;
gateway : Ipaddr.V4.t option;
}

Type for manual IPv4 configuration.

type ipv6_config = {
network : Ipaddr.V6.Prefix.t;
gateway : Ipaddr.V6.t option;
}

Type for manual IPv6 configuration.

val create_ipv4 : ?⁠group:string -> ?⁠config:ipv4_config -> ?⁠no_init:bool Key.key -> ?⁠random:random impl -> ?⁠clock:mclock impl -> ethernet impl -> arpv4 impl -> ipv4 impl

Use an IPv4 address Exposes the keys Key.V4.network and Key.V4.gateway. If provided, the values of these keys will override those supplied in the ipv4 configuration record, if that has been provided.

val ipv4_qubes : ?⁠random:random impl -> ?⁠clock:mclock impl -> qubesdb impl -> ethernet impl -> arpv4 impl -> ipv4 impl

Use a given initialized QubesDB to look up and configure the appropriate * IPv4 interface.

val create_ipv6 : ?⁠random:random impl -> ?⁠time:time impl -> ?⁠clock:mclock impl -> ?⁠group:string -> ?⁠config:ipv6_config -> ?⁠no_init:bool Key.key -> network impl -> ethernet impl -> ipv6 impl

Use an IPv6 address. Exposes the keys Key.V6.network and Key.V6.gateway.

val create_ipv4v6 : ?⁠group:string -> ipv4 impl -> ipv6 impl -> ipv4v6 impl

UDP configuration

type 'a udp
type udpv4 = v4 udp
type udpv6 = v6 udp
type udpv4v6 = v4v6 udp
val udp : 'a udp typ

Implementation of the Mirage_types.UDP signature.

val udpv4 : udpv4 typ
val udpv6 : udpv6 typ
val udpv4v6 : udpv4v6 typ
val direct_udp : ?⁠random:random impl -> 'a ip impl -> 'a udp impl
val socket_udpv4 : ?⁠group:string -> Ipaddr.V4.t option -> udpv4 impl
val socket_udpv6 : ?⁠group:string -> Ipaddr.V6.t option -> udpv6 impl
val socket_udpv4v6 : ?⁠group:string -> Ipaddr.V4.t option -> Ipaddr.V6.t option -> udpv4v6 impl

TCP configuration

type 'a tcp
type tcpv4 = v4 tcp
type tcpv6 = v6 tcp
type tcpv4v6 = v4v6 tcp
val tcp : 'a tcp typ

Implementation of the Mirage_types.TCP signature.

val tcpv4 : tcpv4 typ
val tcpv6 : tcpv6 typ
val tcpv4v6 : tcpv4v6 typ
val direct_tcp : ?⁠clock:mclock impl -> ?⁠random:random impl -> ?⁠time:time impl -> 'a ip impl -> 'a tcp impl
val socket_tcpv4 : ?⁠group:string -> Ipaddr.V4.t option -> tcpv4 impl
val socket_tcpv6 : ?⁠group:string -> Ipaddr.V6.t option -> tcpv6 impl
val socket_tcpv4v6 : ?⁠group:string -> Ipaddr.V4.t option -> Ipaddr.V6.t option -> tcpv4v6 impl

Network stack configuration

type stackv4

IPv4

val stackv4 : stackv4 typ

Implementation of the Mirage_types.STACKV4 signature.

val direct_stackv4 : ?⁠clock:mclock impl -> ?⁠random:random impl -> ?⁠time:time impl -> ?⁠group:string -> network impl -> ethernet impl -> arpv4 impl -> ipv4 impl -> stackv4 impl

Direct network stack with given ip.

val socket_stackv4 : ?⁠group:string -> unit -> stackv4 impl

Network stack with sockets.

val qubes_ipv4_stack : ?⁠group:string -> ?⁠qubesdb:qubesdb impl -> ?⁠arp:(ethernet impl -> arpv4 impl) -> network impl -> stackv4 impl

Build a stackv4 by looking up configuration information via QubesDB, * building an ipv4, then building a stack on top of that.

val dhcp_ipv4_stack : ?⁠group:string -> ?⁠random:random impl -> ?⁠clock:mclock impl -> ?⁠time:time impl -> ?⁠arp:(ethernet impl -> arpv4 impl) -> network impl -> stackv4 impl

Build a stackv4 by obtaining a DHCP lease, using the lease to * build an ipv4, then building a stack on top of that.

val static_ipv4_stack : ?⁠group:string -> ?⁠config:ipv4_config -> ?⁠arp:(ethernet impl -> arpv4 impl) -> network impl -> stackv4 impl

Build a stackv4 by checking the Key.V4.network, and Key.V4.gateway keys * for ipv4 configuration information, filling in unspecified information from ?config, * then building a stack on top of that.

val generic_stackv4 : ?⁠group:string -> ?⁠config:ipv4_config -> ?⁠dhcp_key:bool value -> ?⁠net_key:[ `Direct | `Socket ] option value -> network impl -> stackv4 impl

Generic stack using a dhcp and a net keys: Key.net and Key.dhcp.

If a key is not provided, it uses Key.net or Key.dhcp (with the group argument) to create it.

IPv6

type stackv6
val stackv6 : stackv6 typ

Implementation of the Mirage_stack.V6 signature.

val direct_stackv6 : ?⁠clock:mclock impl -> ?⁠random:random impl -> ?⁠time:time impl -> ?⁠group:string -> network impl -> ethernet impl -> ipv6 impl -> stackv6 impl

Direct network stack with given ip.

val socket_stackv6 : ?⁠group:string -> unit -> stackv6 impl

Network stack with sockets.

val static_ipv6_stack : ?⁠group:string -> ?⁠config:ipv6_config -> network impl -> stackv6 impl

Build a stackv6 by checking the Key.V6.network, and Key.V6.gateway keys for ipv6 configuration information, filling in unspecified information from ?config, then building a stack on top of that.

val generic_stackv6 : ?⁠group:string -> ?⁠config:ipv6_config -> ?⁠net_key:[ `Direct | `Socket ] option value -> network impl -> stackv6 impl

Generic stack using a net keys: Key.net.

If a key is not provided, it uses Key.net (with the group argument) to create it.

Dual IPv4 and IPv6

type stackv4v6
val stackv4v6 : stackv4v6 typ

Implementation of the Mirage_stack.V4V6 signature.

val direct_stackv4v6 : ?⁠clock:mclock impl -> ?⁠random:random impl -> ?⁠time:time impl -> ?⁠group:string -> ipv4_only:bool Key.key -> ipv6_only:bool Key.key -> network impl -> ethernet impl -> arpv4 impl -> ipv4 impl -> ipv6 impl -> stackv4v6 impl

Direct network stack with given ip.

val socket_stackv4v6 : ?⁠group:string -> unit -> stackv4v6 impl

Network stack with sockets.

val static_ipv4v6_stack : ?⁠group:string -> ?⁠ipv6_config:ipv6_config -> ?⁠ipv4_config:ipv4_config -> ?⁠arp:(ethernet impl -> arpv4 impl) -> network impl -> stackv4v6 impl

Build a stackv4v6 by checking the Key.V6.network, and Key.V6.gateway keys for IPv4 and IPv6 configuration information, filling in unspecified information from ?config, then building a stack on top of that.

val generic_stackv4v6 : ?⁠group:string -> ?⁠ipv6_config:ipv6_config -> ?⁠ipv4_config:ipv4_config -> ?⁠dhcp_key:bool value -> ?⁠net_key:[ `Direct | `Socket ] option value -> network impl -> stackv4v6 impl

Generic stack using a net keys: Key.net.

If a key is not provided, it uses Key.net (with the group argument) to create it.

Resolver configuration

type resolver
val resolver : resolver typ
val resolver_dns : ?⁠ns:Ipaddr.t -> ?⁠ns_port:int -> ?⁠random:random impl -> ?⁠time:time impl -> ?⁠mclock:mclock impl -> stackv4v6 impl -> resolver impl
val resolver_unix_system : resolver impl

Syslog configuration

type syslog_config = {
hostname : string;
server : Ipaddr.t option;
port : int option;
truncate : int option;
}
val syslog_config : ?⁠port:int -> ?⁠truncate:int -> ?⁠server:Ipaddr.t -> string -> syslog_config

Helper for constructing a syslog_config.

type syslog

The type for syslog

val syslog : syslog typ

Implementation of the syslog type.

val syslog_udp : ?⁠config:syslog_config -> ?⁠console:console impl -> ?⁠clock:pclock impl -> stackv4v6 impl -> syslog impl

Emit log messages via UDP to the configured host.

val syslog_tcp : ?⁠config:syslog_config -> ?⁠console:console impl -> ?⁠clock:pclock impl -> stackv4v6 impl -> syslog impl

Emit log messages via TCP to the configured host.

val syslog_tls : ?⁠config:syslog_config -> ?⁠keyname:string -> ?⁠console:console impl -> ?⁠clock:pclock impl -> stackv4v6 impl -> kv_ro impl -> syslog impl

Emit log messages via TLS to the configured host, using the credentials (private ekey, certificate, trust anchor) provided in the KV_RO using the keyname.

Entropy

val nocrypto : job impl

Device that initializes the entropy. Deprecated and unused.

Conduit configuration

type conduit
val conduit : conduit typ
val conduit_direct : ?⁠tls:bool -> ?⁠random:random impl -> stackv4v6 impl -> conduit impl

HTTP configuration

type http
val http : http typ
val http_server : conduit impl -> http impl
val cohttp_server : conduit impl -> http impl

cohttp_server starts a Cohttp server.

val httpaf_server : conduit impl -> http impl

httpaf_server starts a http/af server.

type http_client
val http_client : http_client typ
val cohttp_client : ?⁠pclock:pclock impl -> resolver impl -> conduit impl -> http_client impl

cohttp_server starts a Cohttp server.

Argv configuration

val default_argv : Functoria_app.argv impl

default_argv is a dynamic argv implementation * which attempts to do something reasonable based on the target.

val no_argv : Functoria_app.argv impl

no_argv Disable command line parsing and set argv to |""|.

Other devices

val noop : job impl

noop is a job that does nothing, has no dependency and returns ()

type info

info is the type for module implementing Mirage_runtime.Info.

val info : info typ

info is the combinator to generate info values to use at runtime.

val app_info : info impl

app_info exports all the information available at configure time into a runtime Mirage.Info.t value.

Application registering

val register : ?⁠argv:Functoria_app.argv impl -> ?⁠tracing:tracing impl -> ?⁠reporter:reporter impl -> ?⁠keys:Key.t list -> ?⁠packages:Functoria.package list -> string -> job impl list -> unit

register name jobs registers the application named by name which will executes the given jobs.

parameter packages

The opam packages needed by this module.

parameter keys

The keys related to this module.

parameter tracing

Enable tracing.

parameter reporter

Configure logging. The default log reporter is default_reporter. To disable logging, use no_reporter.

parameter argv

Configure command-line argument parsing. The default parser is default_argv. To disable command-line parsing, use no_argv.