Module `Frenetic_kernel.OpenFlow`Source

A uniform interface to OpenFlow 1.0 and 1.3.

A high-level language, such as Frenetic, should support OpenFlow 1.0 and also exploit OpenFlow 1.3 features when possible. For example, when two Frenetic actions are composed in parallel, they logically work on two copies of a packet. Certain kinds of parallel composition cannot be realized in OpenFlow 1.0, but they are trivial to implement with group tables in OpenFlow 1.3.

Similarly, OpenFlow 1.3 can implement failover efficiently using fast- failover groups. But, in OpenFlow 1.0, we have to incur a round-trip to the controller.

Instead of creating two different versions of the Frenetic compiler, we here define a high-level action data type. When targeting OpenFlow 1.0, actions translates to 1.0 action sequences and controller round-trips if needed. When targeting OpenFlow 1.3, action also builds group tables to realize actions efficiently. This requires a global analysis of all the actions in a flow table. Therefore, Frenetic needs to supply the entire flow table at once and cannot add and remove flow table entries individually

OpenFlow Identifier Types

OpenFlow requires identifiers for switches, ports, transaction numbers, etc. The representation of these identifiers varies across different versions of OpenFlow, which is why they are abstract.

Sourcetype switchId = int64

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

Sourceval sexp_of_switchId : switchId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval switchId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> switchId

Sourceval compare_switchId : switchId -> switchId -> int

Sourcetype portId = int32

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

Sourceval sexp_of_portId : portId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portId

Sourceval compare_portId : portId -> portId -> int

Sourcetype queueId = int32

Sourceval equal_queueId : queueId -> queueId -> Ppx_deriving_runtime.bool

Sourceval sexp_of_queueId : queueId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval queueId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> queueId

Sourceval compare_queueId : queueId -> queueId -> int

Sourcetype bufferId = int32

Sourceval equal_bufferId : bufferId -> bufferId -> Ppx_deriving_runtime.bool

Sourceval sexp_of_bufferId : bufferId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval bufferId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> bufferId

Sourceval compare_bufferId : bufferId -> bufferId -> int

Sourceexception Unsupported of string

Packet Types

Sourcetype payload =

| Buffered of bufferId * Cstruct.t
(*
Buffered (id, buf) is a packet buffered on a switch
*)
| NotBuffered of Cstruct.t

Packet payloads

Sourceval sexp_of_payload : payload -> Ppx_sexp_conv_lib.Sexp.t

Sourceval payload_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> payload

Sourceval payload_bytes : payload -> Cstruct.t

payload_bytes payload returns the bytes for the given payload

Sourcetype packetInReason =

| NoMatch
| ExplicitSend

Sourceval sexp_of_packetInReason : packetInReason -> Ppx_sexp_conv_lib.Sexp.t

Sourceval packetInReason_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> packetInReason

Switch Configuaration

Sourcetype switchFeatures = {

switch_id : switchId;
switch_ports : portId list;

}

A simplification of the _switch features_ message from OpenFlow

Sourceval sexp_of_switchFeatures : switchFeatures -> Ppx_sexp_conv_lib.Sexp.t

Sourceval switchFeatures_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> switchFeatures

Packet Forwarding

Sourcemodule Pattern : sig ... end

Sourcetype modify =

| SetEthSrc of Packet.dlAddr
| SetEthDst of Packet.dlAddr
| SetVlan of Packet.dlVlan
| SetVlanPcp of Packet.dlVlanPcp
| SetEthTyp of Packet.dlTyp
| SetIPProto of Packet.nwProto
| SetIP4Src of Packet.nwAddr
| SetIP4Dst of Packet.nwAddr
| SetTCPSrcPort of Packet.tpPort
| SetTCPDstPort of Packet.tpPort

Sourceval sexp_of_modify : modify -> Ppx_sexp_conv_lib.Sexp.t

Sourceval modify_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> modify

Sourcetype pseudoport =

| Physical of portId
| InPort
| Table
| Normal
| Flood
| All
| Controller of int
| Local

Sourceval sexp_of_pseudoport : pseudoport -> Ppx_sexp_conv_lib.Sexp.t

Sourceval pseudoport_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> pseudoport

Sourcetype groupId = int32

Sourceval sexp_of_groupId : groupId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval groupId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> groupId

Sourcetype action =

| Output of pseudoport
| Enqueue of portId * queueId
| Modify of modify
| FastFail of groupId

Sourceval sexp_of_action : action -> Ppx_sexp_conv_lib.Sexp.t

Sourceval action_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> action

Sourcetype seq = action list

Sourceval sexp_of_seq : seq -> Ppx_sexp_conv_lib.Sexp.t

Sourceval seq_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> seq

Sourcetype par = seq list

Sourceval sexp_of_par : par -> Ppx_sexp_conv_lib.Sexp.t

Sourceval par_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> par

Sourcetype group = par list

Sourceval sexp_of_group : group -> Ppx_sexp_conv_lib.Sexp.t

Sourceval group_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> group

Sourcetype timeout =

| Permanent
(*
No timeout
*)
| ExpiresAfter of Packet.int16
(*
Time out after n seconds
*)

Sourceval sexp_of_timeout : timeout -> Ppx_sexp_conv_lib.Sexp.t

Sourceval timeout_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> timeout

Sourcetype flow = {

pattern : Pattern.t;
action : group;
cookie : int64;
idle_timeout : timeout;
hard_timeout : timeout;

}

Sourceval sexp_of_flow : flow -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flow_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flow

Sourcetype flowTable = flow list

Priorities are implicit

Sourceval sexp_of_flowTable : flowTable -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowTable_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowTable

Sourcetype flowStats = {

flow_table_id : int64;
flow_pattern : Pattern.t;
flow_actions : action list;
flow_duration_sec : int64;
flow_duration_nsec : int64;
flow_priority : int64;
flow_idle_timeout : int64;
flow_hard_timeout : int64;
flow_packet_count : int64;
flow_byte_count : int64;

}

The body of a reply to an individual flow statistics request

Sourceval sexp_of_flowStats : flowStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowStats

Sourcetype portStats = {

port_no : int64;
port_rx_packets : int64;
port_tx_packets : int64;
port_rx_bytes : int64;
port_tx_bytes : int64;
port_rx_dropped : int64;
port_tx_dropped : int64;
port_rx_errors : int64;
port_tx_errors : int64;
port_rx_frame_err : int64;
port_rx_over_err : int64;
port_rx_crc_err : int64;
port_collisions : int64;

}

Sourceval sexp_of_portStats : portStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portStats

Sourcetype event =

| SwitchUp of switchId * portId list
| SwitchDown of switchId
| PortUp of switchId * portId
| PortDown of switchId * portId
| PacketIn of string * switchId * portId * payload * int * packetInReason
| PortStats of switchId * portStats
| FlowStats of switchId * flowStats

Sourcetype pktOut = payload * portId option * action list

Sourceval sexp_of_pktOut : pktOut -> Ppx_sexp_conv_lib.Sexp.t

Sourceval pktOut_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> pktOut

Sourceval format_list : 'a list -> to_string:('a -> string) -> string

Sourceval format_action : Format.formatter -> action -> unit

Sourceval format_seq : Format.formatter -> seq -> unit

Sourceval format_par : Format.formatter -> par -> unit

Sourceval format_group : Format.formatter -> group -> unit

Sourceval format_flow : Format.formatter -> flow -> unit

Sourceval format_flowTable : Format.formatter -> flowTable -> unit

Sourceval string_of_action : action -> string

Sourceval string_of_seq : seq -> string

Sourceval string_of_par : par -> string

Sourceval string_of_flow : flow -> string

Sourceval string_of_group : group -> string

Sourceval string_of_flowTable : ?label:string -> flowTable -> string

Sourceval string_of_event : event -> string

Sourcemodule OF10 = OpenFlow0x01

Sourcemodule To0x01 : sig ... end

Sourcemodule From0x01 : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frenetic.kernel/Frenetic_kernel/OpenFlow/index.html

Module `Frenetic_kernel.OpenFlow`Source

OpenFlow Identifier Types

Packet Types

Switch Configuaration

Packet Forwarding

package frenetic

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frenetic.kernel/Frenetic_kernel/OpenFlow/index.html

Module Frenetic_kernel.OpenFlowSource

OpenFlow Identifier Types

Packet Types

Switch Configuaration

Packet Forwarding

Module `Frenetic_kernel.OpenFlow`Source