AuthorAnil Madhavapeddy <anil@recoil.org>
Issue Trackerhttps://github.com/mirage/ocaml-vmnet/issues
MaintainerAnil Madhavapeddy <anil@recoil.org>
&cstruct>= 1.9.0
ipaddr>= 1.4.0
lwt>= 2.4.3
sexplib>= 113.24.00
Availableos = "darwin"
PublishedMar 20, 2016
Source [http] https://github.com/mirage/ocaml-vmnet/archive/v1.1.0.tar.gz
StatisticsNot installed in the last month.

Userlevel network bridging on MacOS X

MacOS X 10.10 (Yosemite) introduced the somewhat undocumented vmnet framework. This exposes virtual network interfaces to userland applications. There are a number of advantages of this over previous implementations:

  • Unlike tuntaposx, this is builtin to MacOS X now and so is easier to package up and distribute for end users.
  • vmnet uses the XPC sandboxing interfaces and should make it easier to drop a hard dependency on running networking applications as root.
  • Most significantly, vmnet supports bridging network traffic to the outside world, which was previously unsupported.

These OCaml bindings are constructed against the documentation contained in the <vmnet.h> header file in Yosemite, and may not be correct due to the lack of any other example code. However, they do suffice to run MirageOS applications that can connect to the outside world. The bindings are also slightly complicated by the need to interface GCD thread pools with the OCaml runtime, so please report any instabilities that you see when using this interface as a consumer.

There are two libraries provided:

  • Vmnet is the raw OCaml binding to the vmnet framework, using OCaml preemptive threads to handle synchronisation.
  • Lwt_vmnet uses the Lwt framework to provide a monadic asynchronous I/O interface at a higher level.

Most users should use Lwt_vmnet to handle guest traffic.

Necessary for