albatross/src/vmm_unix.mli

(* (c) 2017 Hannes Mehnert, all rights reserved *)

open Rresult

open Vmm_core

type supported = FreeBSD | Linux

val uname : supported Lazy.t

val set_dbdir : Fpath.t -> unit

val check_commands : unit -> (unit, [> R.msg ]) result

val prepare : Name.t -> Unikernel.config ->
  ((string * string) list, [> R.msg ]) result

val exec : Name.t -> Unikernel.config -> (string * string) list ->
  (string * Name.t) list -> (Unikernel.t, [> R.msg ]) result

val free_system_resources : Name.t -> string list -> (unit, [> R.msg ]) result

val destroy : Unikernel.t -> unit

val close_no_err : Unix.file_descr -> unit

val create_block : Name.t -> int -> (unit, [> R.msg ]) result

val destroy_block : Name.t -> (unit, [> R.msg ]) result

val find_block_devices : unit -> ((Name.t * int) list, [> R.msg ]) result

val dump : ?name:string -> Cstruct.t -> (unit, [> R.msg ]) result

val restore : ?name:string -> unit -> (Cstruct.t, [> R.msg | `NoFile ]) result

val vm_device : Unikernel.t -> (string, [> R.msg ]) result
initial 2017-05-26 14:30:34 +00:00			`(* (c) 2017 Hannes Mehnert, all rights reserved *)`

			`open Rresult`

			`open Vmm_core`

make dbdir and tmpdir platform-specific and overwritable by all command line utilities 2019-10-29 22:37:42 +00:00			`type supported = FreeBSD \| Linux`

			`val uname : supported Lazy.t`

			`val set_dbdir : Fpath.t -> unit`

Vmm_unix.check_commands : unit -> (unit, [> `Msg of string ]) result - which checks (platform-dependent) all required executables Vmm_unix.prepare/exec execute solo5-{spt/hvt} depending on the image type (solo5-elftool figures that out), use jsonm to parse output Vmm_unix: use ip on linux, no longer ifconfig 2019-10-27 19:46:07 +00:00			`val check_commands : unit -> (unit, [> R.msg ]) result`

revise the "--net=yyy" argument to (optionally) contain a service:bridge it used to only contain service, and used the same string for the bridge. This is not flexible enough to run off-the-shelf unikernels (configured for bridge "service" and "management" on multi-homed servers). The old behaviour is the new default (i.e. "--net=service" creates and attaches a tap device to bridge "service", and passes "--net:service=tapYY" to the solo5 tender). But it is more flexible now: "--net=service:other-bridge" will create a tap device attached to "other-bridge" and pass "--net:service=tapYY" to the tender. This way, there's no need to match bridge names on the actual server with network device names of the unikernels. NB: this is (mostly) backwards-compatible: the on-disk data structures are versioned (and the version is bumped with this PR), an old albatross client can send "create" commands to a new server. But a new client will get a parse error from an old server - which is fine taking into consideration the deployment base. 2020-03-25 14:19:28 +00:00			`val prepare : Name.t -> Unikernel.config ->`
			`((string * string) list, [> R.msg ]) result`
initial 2017-05-26 14:30:34 +00:00
changes for solo5 0.6 -- this is a breaking change in the wire protocol 2019-09-28 17:09:45 +00:00			`val exec : Name.t -> Unikernel.config -> (string * string) list ->`
			`(string * Name.t) list -> (Unikernel.t, [> R.msg ]) result`
initial 2017-05-26 14:30:34 +00:00
remove unnecessary freebsd-specific teardown code (bhyvectl --destroy), since 0.6 reverted privdrop 2019-10-11 21:04:51 +00:00			`val free_system_resources : Name.t -> string list -> (unit, [> R.msg ]) result`
initial 2017-05-26 14:30:34 +00:00
rename Vm to Unikernel 2018-11-13 00:02:05 +00:00			`val destroy : Unikernel.t -> unit`
initial 2017-05-26 14:30:34 +00:00
			`val close_no_err : Unix.file_descr -> unit`
block device support 2018-11-10 00:02:07 +00:00
rename Vmm_core.id to Vmm_core.Name.t and make it private - also check constructors to fit into 20 chars ldh (and in Vmm_tls max depth = 10) 2018-11-11 00:21:12 +00:00			`val create_block : Name.t -> int -> (unit, [> R.msg ]) result`
block device support 2018-11-10 00:02:07 +00:00
rename Vmm_core.id to Vmm_core.Name.t and make it private - also check constructors to fit into 20 chars ldh (and in Vmm_tls max depth = 10) 2018-11-11 00:21:12 +00:00			`val destroy_block : Name.t -> (unit, [> R.msg ]) result`
block device support 2018-11-10 00:02:07 +00:00
rename Vmm_core.id to Vmm_core.Name.t and make it private - also check constructors to fit into 20 chars ldh (and in Vmm_tls max depth = 10) 2018-11-11 00:21:12 +00:00			`val find_block_devices : unit -> ((Name.t * int) list, [> R.msg ]) result`
vmmd: dump state (unikernel configurations) on create+destroy, restore from state on startup 2019-01-20 21:17:59 +00:00
further rng cleanups (remove deps from dune); albatross-client-inspect-dump which reads a state file (for cautious upgrades) 2020-07-05 18:39:29 +00:00			`val dump : ?name:string -> Cstruct.t -> (unit, [> R.msg ]) result`
vmmd: dump state (unikernel configurations) on create+destroy, restore from state on startup 2019-01-20 21:17:59 +00:00
further rng cleanups (remove deps from dune); albatross-client-inspect-dump which reads a state file (for cautious upgrades) 2020-07-05 18:39:29 +00:00			val restore : ?name:string -> unit -> (Cstruct.t, [> R.msg \| `NoFile ]) result
vmm_vmmd, vmm_unix: compute device name (/dev/vmm/solo5-PID) in vmm_unix (depending on host OS); also destroy this device on shutdown (used to be done by solo5-hvt, but that now drops privileges and is no longer able to do this) 2019-01-20 22:02:01 +00:00
			`val vm_device : Unikernel.t -> (string, [> R.msg ]) result`