Module Frenetic_kernel.PacketSource

Library for constructing, marshaling and parsing data packets. These packets are independent of OpenFlow message information - they are mostly used for the payloads of PacketIn and PacketOut messages.

Packet types

It is possible to navigate the structure of a packet directly using the types defined here. However, using Accessors may be more convenient.

Sourcetype int8 = int

int8 is the type of 8-bit integers.

Sourceval sexp_of_int8 : int8 -> Ppx_sexp_conv_lib.Sexp.t
Sourceval int8_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> int8
Sourceval compare_int8 : int8 -> int8 -> int
Sourcetype int16 = int

int16 is the type of 16-bit integers.

Sourceval sexp_of_int16 : int16 -> Ppx_sexp_conv_lib.Sexp.t
Sourceval int16_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> int16
Sourceval compare_int16 : int16 -> int16 -> int
Sourcetype int48 = int64

int48 is the type of 48-bit integers.

Sourceval sexp_of_int48 : int48 -> Ppx_sexp_conv_lib.Sexp.t
Sourceval int48_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> int48
Sourceval compare_int48 : int48 -> int48 -> int
Sourcetype dlAddr = int48

dlAddr is the type of Ethernet addresses.

Sourceval sexp_of_dlAddr : dlAddr -> Ppx_sexp_conv_lib.Sexp.t
Sourceval dlAddr_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> dlAddr
Sourceval compare_dlAddr : dlAddr -> dlAddr -> int
Sourcetype dlTyp = int16

dlTyp is the type of Ethernet frame types.

Sourceval sexp_of_dlTyp : dlTyp -> Ppx_sexp_conv_lib.Sexp.t
Sourceval dlTyp_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> dlTyp
Sourceval compare_dlTyp : dlTyp -> dlTyp -> int
Sourcetype dlVlan = int16 option

dlVlan is the type of VLAN identifiers. A value of None indicates that no 802.1Q (VLAN) header is set, which is distinct from setting the VLAN to 0.

Sourceval sexp_of_dlVlan : dlVlan -> Ppx_sexp_conv_lib.Sexp.t
Sourceval dlVlan_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> dlVlan
Sourceval compare_dlVlan : dlVlan -> dlVlan -> int
Sourcetype dlVlanPcp = int8

dlVlanPcp is the type of 802.1Q (VLAN) priorities.

Sourceval sexp_of_dlVlanPcp : dlVlanPcp -> Ppx_sexp_conv_lib.Sexp.t
Sourceval dlVlanPcp_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> dlVlanPcp
Sourceval compare_dlVlanPcp : dlVlanPcp -> dlVlanPcp -> int
Sourcetype dlVlanDei = bool

dlVlanDei is the type of 802.1Q (VLAN) drop eligible indicator.

Sourceval sexp_of_dlVlanDei : dlVlanDei -> Ppx_sexp_conv_lib.Sexp.t
Sourceval dlVlanDei_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> dlVlanDei
Sourceval compare_dlVlanDei : dlVlanDei -> dlVlanDei -> int
Sourcetype nwAddr = int32

nwAddr is the type of IPv4 addresses.

Sourceval sexp_of_nwAddr : nwAddr -> Ppx_sexp_conv_lib.Sexp.t
Sourceval nwAddr_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> nwAddr
Sourceval compare_nwAddr : nwAddr -> nwAddr -> int
Sourcetype nwProto = int8

nwProto is the type of IPv4 protocol numbers.

Sourceval sexp_of_nwProto : nwProto -> Ppx_sexp_conv_lib.Sexp.t
Sourceval nwProto_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> nwProto
Sourceval compare_nwProto : nwProto -> nwProto -> int
Sourcetype nwTos = int8

nwTos is the type of IPv4 types of service.

Sourceval sexp_of_nwTos : nwTos -> Ppx_sexp_conv_lib.Sexp.t
Sourceval nwTos_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> nwTos
Sourceval compare_nwTos : nwTos -> nwTos -> int
Sourcetype ipv6Addr = int64 * int64

ipv6Addr is the type of IPv6 addresses.

Sourceval sexp_of_ipv6Addr : ipv6Addr -> Ppx_sexp_conv_lib.Sexp.t
Sourceval ipv6Addr_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> ipv6Addr
Sourceval compare_ipv6Addr : ipv6Addr -> ipv6Addr -> int
Sourcetype tpPort = int16

tpPort is the type of transport protocol ports.

Sourceval sexp_of_tpPort : tpPort -> Ppx_sexp_conv_lib.Sexp.t
Sourceval tpPort_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> tpPort
Sourceval compare_tpPort : tpPort -> tpPort -> int
Sourcemodule Tcp : sig ... end

TCP frame of a packet.

Sourcemodule Udp : sig ... end

UDP frame of a packet.

Sourcemodule Icmp : sig ... end

ICMP frame of a packet.

Sourcemodule Dns : sig ... end

Basic DNS packet type.

Sourcemodule Igmp1and2 : sig ... end

IGMP v1 and v2 message type.

Sourcemodule Igmp3 : sig ... end

IGMP v3 message type.

Sourcemodule Igmp : sig ... end

IGMP frame of a packet.

Sourcemodule Ip : sig ... end

IPv4 frame of a packet.

Sourcemodule Arp : sig ... end

Address resolution protocol (ARP) packet payload.

Sourcetype nw =
  1. | Ip of Ip.t
    (*

    Internet Protocol version 4 (IPv4).

    *)
  2. | Arp of Arp.t
    (*

    Address Resolution Protocol (ARP).

    *)
  3. | Unparsable of dlTyp * Cstruct.t
    (*

    The EtherType code accompanied by the uninterpreted ethernet payload.

    *)

The type nw represents a packet at the network protocol level.

Sourceval sexp_of_nw : nw -> Ppx_sexp_conv_lib.Sexp.t
Sourceval nw_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> nw
Sourcetype packet = {
  1. dlSrc : dlAddr;
    (*

    Ethernet source address.

    *)
  2. dlDst : dlAddr;
    (*

    Ethernet destination address.

    *)
  3. dlVlan : dlVlan;
    (*

    802.1Q VLAN identifier, if any.

    *)
  4. dlVlanDei : dlVlanDei;
    (*

    802.1Q VLAN Drop Eligible Indciator. Ignored if dlVlan is None

    *)
  5. dlVlanPcp : dlVlanPcp;
    (*

    802.1Q VLAN priority. Ignored if dlVlan is None.

    *)
  6. nw : nw;
    (*

    Network payload.

    *)
}

The type packet represents a packet at the ethernet protocol level.

Sourceval sexp_of_packet : packet -> Ppx_sexp_conv_lib.Sexp.t
Sourceval packet_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> packet
Accessors
Sourceval dlTyp : packet -> dlTyp

dlTyp pkt returns the ethernet frame type of pkt

Sourceval nwSrc : packet -> nwAddr

nwSrc pkt returns the source IP address of pkt.

  • raises

    Invalid_argument if the packet is not carrying an IP payload.

Sourceval nwDst : packet -> nwAddr

nwDst pkt returns the destination IP address of pkt.

  • raises

    Invalid_argument if the packet is not carrying an IP payload.

Sourceval nwTos : packet -> nwTos

nwTos pkt returns the IPv4 type of service of pkt.

  • raises

    Invalid_argument if the packet is not carrying an IP payload.

Sourceval nwProto : packet -> nwProto

nwProto pkt returns the IP protocol number of pkt.

  • raises

    Invalid_argument if the packet is not carrying an IP payload.

Sourceval tpSrc : packet -> tpPort

tpSrc pkt returns the transport protocol source port of pkt.

Sourceval tpDst : packet -> tpPort

tpDst pkt returns the transport protocol destination port of pkt.

Sourceval arpOperation : packet -> int

arpOperation pkt returns the ARP operation code of pkt.

Mutators
Sourceval setDlSrc : packet -> dlAddr -> packet

setDlSrc pkt addr sets the ethernet source address of pkt to addr.

Sourceval setDlDst : packet -> dlAddr -> packet

setDlDst pkt addr sets the ethernet destination address of pkt to addr.

Sourceval setDlVlan : packet -> dlVlan -> packet

setDlVlan pkt vlan sets the VLAN identifier of pkt to vlan.

Sourceval setDlVlanPcp : packet -> dlVlanPcp -> packet

setDlVlanPcp pkt pri sets the VLAN priority of pkt to pri.

Sourceval setNwSrc : packet -> nwAddr -> packet

setNwSrc pkt sets the source IP address of pkt if the packet carries an IP payload. Otherwise, it returns the packet unchanged.

Sourceval setNwDst : packet -> nwAddr -> packet

setNwDst pkt sets the destination IP address of pkt if the packet carries an IP payload. Otherwise, it returns the packet unchanged.

Sourceval setNwTos : packet -> nwTos -> packet

setNwTos pkt sets the IPv4 type of service of pkt if the packet carries an IP payload. Otherwise, it returns the packet unchanged.

Sourceval setTpSrc : packet -> tpPort -> packet

setTpSrc pkt sets the transport protocol source port of pkt if the packet carries a TCP or UDP payload. Otherwise, it returns the packet unchanged.

Sourceval setTpDst : packet -> tpPort -> packet

setTpDst pkt sets the transport protocol destination port of pkt if the packet carries a TCP or UDP payload. Otherwise, it returns the packet unchanged.

Pretty Printing
Sourceval string_of_mac : dlAddr -> string

string_of_mac mac pretty-prints an ethernet address.

Sourceval mac_of_string : string -> dlAddr

mac_of_string string converts an colon-separated ethernet address to a dlAddr *

Sourceval string_of_dlAddr : dlAddr -> string

string_of_dlAddr addr is identical to string_of_mac.

Sourceval string_of_dlTyp : dlTyp -> string

string_of_dlTyp typ pretty-prints an ethernet frame type.

Sourceval string_of_dlVlan : dlVlan -> string

string_of_dlVlan vlan pretty-prints an 802.1Q VLAN identifier.

Sourceval string_of_dlVlanPcp : dlVlanPcp -> string

string_of_dlVlanPcp p pretty-prints an 802.1Q VLAN priority.

Sourceval string_of_ip : nwAddr -> string

string_of_ip ip pretty-prints an IPv4 address.

Sourceval ip_of_string : string -> nwAddr

ip_of_string string converts an dot-separated IPv4 address to a nwAddr *

Sourceval string_of_nwAddr : nwAddr -> string

string_of_nwAddr addr is identical to string_of_ip.

Sourceval string_of_nwProto : nwProto -> string

string_of_nwProto p pretty-prints an IPv4 protocol.

Sourceval string_of_nwTos : nwTos -> string

string_of_nwTos t pretty-prints an IPv4 type of service.

Sourceval string_of_ipv6 : ipv6Addr -> string

string_of_ipv6 t pretty-prints an IPv6 address. *

Sourceval ipv6_of_string : string -> ipv6Addr

string_of_ipv6 t Converts a colon-separated IPv6 address to ipv6Addr. *

Sourceval string_of_tpPort : tpPort -> string

string_of_tpPort p pretty-prints a transport protocol port number.

Sourceval bytes_of_mac : dlAddr -> string

bytes_of_mac mac returns a bit-string representation of mac.

Sourceval mac_of_bytes : string -> int48

mac_of_bytes str constructs a dlAddr from a bit-string representation.

Serialization
Sourceval parse : Cstruct.t -> packet

parse bits parses a bit sequence into a packet.

Sourceval len : packet -> int

len pkt length of packet in bytes.

Sourceval marshal : packet -> Cstruct.t

marshal pkt marshals pkt into a bit sequence.

Sourceval to_string : packet -> string

to_string pkt prints pkt as a string.

Sourceval format_packet : Format.formatter -> packet -> unit

format_packet fmt pkt uses formatter fmt to format pkt.