package frenetic

  1. Overview
  2. Docs
package frenetic
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Frenetic_kernel.OpenFlowSource

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 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 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 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 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 =
  1. | Buffered of bufferId * Cstruct.t
    (*

    Buffered (id, buf) is a packet buffered on a switch

    *)
  2. | 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 =
  1. | NoMatch
  2. | 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 = {
  1. switch_id : switchId;
  2. 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 =
  1. | SetEthSrc of Packet.dlAddr
  2. | SetEthDst of Packet.dlAddr
  3. | SetVlan of Packet.dlVlan
  4. | SetVlanPcp of Packet.dlVlanPcp
  5. | SetEthTyp of Packet.dlTyp
  6. | SetIPProto of Packet.nwProto
  7. | SetIP4Src of Packet.nwAddr
  8. | SetIP4Dst of Packet.nwAddr
  9. | SetTCPSrcPort of Packet.tpPort
  10. | 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 =
  1. | Physical of portId
  2. | InPort
  3. | Table
  4. | Normal
  5. | Flood
  6. | All
  7. | Controller of int
  8. | 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 =
  1. | Output of pseudoport
  2. | Enqueue of portId * queueId
  3. | Modify of modify
  4. | 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 =
  1. | Permanent
    (*

    No timeout

    *)
  2. | 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 = {
  1. pattern : Pattern.t;
  2. action : group;
  3. cookie : int64;
  4. idle_timeout : timeout;
  5. 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 = {
  1. flow_table_id : int64;
  2. flow_pattern : Pattern.t;
  3. flow_actions : action list;
  4. flow_duration_sec : int64;
  5. flow_duration_nsec : int64;
  6. flow_priority : int64;
  7. flow_idle_timeout : int64;
  8. flow_hard_timeout : int64;
  9. flow_packet_count : int64;
  10. 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 = {
  1. port_no : int64;
  2. port_rx_packets : int64;
  3. port_tx_packets : int64;
  4. port_rx_bytes : int64;
  5. port_tx_bytes : int64;
  6. port_rx_dropped : int64;
  7. port_tx_dropped : int64;
  8. port_rx_errors : int64;
  9. port_tx_errors : int64;
  10. port_rx_frame_err : int64;
  11. port_rx_over_err : int64;
  12. port_rx_crc_err : int64;
  13. 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 =
  1. | SwitchUp of switchId * portId list
  2. | SwitchDown of switchId
  3. | PortUp of switchId * portId
  4. | PortDown of switchId * portId
  5. | PacketIn of string * switchId * portId * payload * int * packetInReason
  6. | PortStats of switchId * portStats
  7. | 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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct