frenetic 5.0.5 · OCaml Package

NetKAT Syntax

The NetKAT language is central to Frenetic, and we factor out the central types here. The big actors on NetKAT structures are Compiler which compiles NetKAT into flow tables, Parser which turns NetKAT strings (e.g "TcpSrcPort(8080); port := 2") into NetKAT, and Json which turns JSON-formatted NetKAT into NetKAT

exception Non_local

Basics

type switchId = Frenetic_kernel.OpenFlow.switchId

val equal_switchId : switchId -> switchId -> Ppx_deriving_runtime.bool

val sexp_of_switchId : switchId -> Ppx_sexp_conv_lib.Sexp.t

val switchId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> switchId

val compare_switchId : switchId -> switchId -> int

type portId = Frenetic_kernel.OpenFlow.portId

val equal_portId : portId -> portId -> Ppx_deriving_runtime.bool

val sexp_of_portId : portId -> Ppx_sexp_conv_lib.Sexp.t

val portId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portId

val compare_portId : portId -> portId -> int

type payload = Frenetic_kernel.OpenFlow.payload

val sexp_of_payload : payload -> Ppx_sexp_conv_lib.Sexp.t

val payload_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> payload

type vswitchId = int64

val equal_vswitchId : vswitchId -> vswitchId -> Ppx_deriving_runtime.bool

val sexp_of_vswitchId : vswitchId -> Ppx_sexp_conv_lib.Sexp.t

val vswitchId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> vswitchId

val compare_vswitchId : vswitchId -> vswitchId -> int

type vportId = int64

val equal_vportId : vportId -> vportId -> Ppx_deriving_runtime.bool

val sexp_of_vportId : vportId -> Ppx_sexp_conv_lib.Sexp.t

val vportId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> vportId

val compare_vportId : vportId -> vportId -> int

type vfabricId = int64

val equal_vfabricId : vfabricId -> vfabricId -> Ppx_deriving_runtime.bool

val sexp_of_vfabricId : vfabricId -> Ppx_sexp_conv_lib.Sexp.t

val vfabricId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> vfabricId

val compare_vfabricId : vfabricId -> vfabricId -> int

type metaId = string

val equal_metaId : metaId -> metaId -> Ppx_deriving_runtime.bool

val sexp_of_metaId : metaId -> Ppx_sexp_conv_lib.Sexp.t

val metaId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> metaId

val compare_metaId : metaId -> metaId -> int

type abstract_location = string

val equal_abstract_location : 
  abstract_location ->
  abstract_location ->
  Ppx_deriving_runtime.bool

val sexp_of_abstract_location : abstract_location -> Ppx_sexp_conv_lib.Sexp.t

val abstract_location_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> abstract_location

val compare_abstract_location : abstract_location -> abstract_location -> int

val hash_fold_abstract_location : 
  Ppx_hash_lib.Std.Hash.state ->
  abstract_location ->
  Ppx_hash_lib.Std.Hash.state

val hash_abstract_location : 
  abstract_location ->
  Ppx_hash_lib.Std.Hash.hash_value

Policies

val string_of_fastfail : int32 list -> string

type location =

| Physical of int32
| FastFail of int32 list
| Pipe of string
| Query of string

val sexp_of_location : location -> Ppx_sexp_conv_lib.Sexp.t

val location_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> location

val compare_location : location -> location -> int

type header_val =

| Switch of switchId
| Location of location
| EthSrc of Frenetic_kernel.Packet.dlAddr
| EthDst of Frenetic_kernel.Packet.dlAddr
| Vlan of Frenetic_kernel.Packet.int16
| VlanPcp of Frenetic_kernel.Packet.dlVlanPcp
| EthType of Frenetic_kernel.Packet.dlTyp
| IPProto of Frenetic_kernel.Packet.nwProto
| IP4Src of Frenetic_kernel.Packet.nwAddr * int32
| IP4Dst of Frenetic_kernel.Packet.nwAddr * int32
| TCPSrcPort of Frenetic_kernel.Packet.tpPort
| TCPDstPort of Frenetic_kernel.Packet.tpPort
| VSwitch of vswitchId
| VPort of vportId
| VFabric of vfabricId
| Meta of metaId * int64
| From of abstract_location
| AbstractLoc of abstract_location

val sexp_of_header_val : header_val -> Ppx_sexp_conv_lib.Sexp.t

val header_val_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> header_val

type pred =

| True
| False
| Test of header_val
| And of pred * pred
| Or of pred * pred
| Neg of pred

val sexp_of_pred : pred -> Ppx_sexp_conv_lib.Sexp.t

val pred_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> pred

type meta_init =

| Alias of header_val
| Const of int64

val sexp_of_meta_init : meta_init -> Ppx_sexp_conv_lib.Sexp.t

val meta_init_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> meta_init

type policy =

| Filter of pred
| Mod of header_val
| Union of policy * policy
| Seq of policy * policy
| Star of policy
| Link of switchId * portId * switchId * portId
| VLink of vswitchId * vportId * vswitchId * vportId
| Let of {
1. id : metaId;
2. init : meta_init;
3. mut : bool;
4. body : policy;
}
| Dup

val sexp_of_policy : policy -> Ppx_sexp_conv_lib.Sexp.t

val policy_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> policy

val id : policy

val drop : policy

Applications

type action = Frenetic_kernel.OpenFlow.action

type switch_port = switchId * portId

val sexp_of_switch_port : switch_port -> Ppx_sexp_conv_lib.Sexp.t

val switch_port_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> switch_port

type host = Frenetic_kernel.Packet.dlAddr * Frenetic_kernel.Packet.nwAddr

val sexp_of_host : host -> Ppx_sexp_conv_lib.Sexp.t

val host_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> host

type bufferId = Core.Int32.t

val sexp_of_bufferId : bufferId -> Ppx_sexp_conv_lib.Sexp.t

val bufferId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> bufferId

package frenetic

Policies

Applications