tcpip

AuthorsAnil Madhavapeddy, Balraj Singh, Richard Mortier, Nicolas Ojeda Bar, Thomas Gazagnaire, Vincent Bernardoff, Magnus Skjegstad, Mindy Preston, Thomas Leonard, David Scott, Gabor Pali, Hannes Mehnert, Haris Rotsos, Kia, Luke Dunstan, Pablo Polvorin, Tim Cuthbertson, lnmx and pqwy
LicenseISC
Homepagehttps://github.com/mirage/mirage-tcpip
Issue Trackerhttps://github.com/mirage/mirage-tcpip/issues
Tagorg:mirage
Maintaineranil@recoil.org
Dependencies
&alcotest>= 0.7.0
configurator
cstruct>= 3.0.2
cstruct-lwt
duration
fmt
io-page-unix
ipaddr>= 2.2.0
jbuilder>= 1.0+beta10
logs>= 0.6.0
lwt>= 3.0.0
mirage-clock>= 1.2.0
mirage-clock-lwt>= 1.2.0
mirage-clock-unix>= 1.2.0
mirage-flow>= 1.2.0
mirage-net>= 1.0.0
mirage-net-lwt>= 1.0.0
mirage-profile>= 0.5
mirage-protocols>= 1.1.0
mirage-protocols-lwt>= 1.1.0
mirage-random>= 1.0.0
mirage-stack-lwt>= 1.0.0
mirage-time-lwt>= 1.0.0
mirage-vnetif>= 0.4.0
pcap-format
randomconv
rresult
Availableocaml-version >= "4.03.0"
PublishedNov 9, 2017
Source [http] https://github.com/mirage/mirage-tcpip/releases/download/v3.3.1/tcpip-3.3.1.tbz
a619790aa8efcbf1c79aebde4409d780
StatisticsInstalled 67 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/tcpip/tcpip.3.3.1/opam

An OCaml TCP/IP networking stack

mirage-tcpip provides a networking stack for the Mirage operating system. It provides implementations for the following module types (which correspond with the similarly-named protocols):

  • ETHERNET
  • ARP
  • IP (via the IPv4 and IPv6 modules)
  • ICMP
  • UDP
  • TCP

Implementations

There are two implementations of the IP, ICMP, UDP, and TCP module types - the socket stack, and the direct stack.

The socket stack

The socket stack uses socket calls to a traditional operating system to provide the functionality described in the module types.

See the src/stack-unix/ directory for the modules used as implementations of the socket stack.

The socket stack is used for testing or other applications which do not expect to run as unikernels.

The direct stack

The direct stack expects to write to a device implementing the NETIF module type defined for MirageOS.

See the src/ directory for the modules used as implementations of the direct stack, which is the expected stack for most MirageOS applications.

The direct stack is the only usable set of implementations for applications which will run as unikernels on a hypervisor target.

Community

License

mirage-tcpip is distributed under the ISC license.