OpenFlow Switch Specification Version ( Protocol version 0x06 )

Transcription

1 OpenFlow Switch Specification Version ( Protocol version 0x06 ) December 19, 2014 ONF TS-020 Copyright 2014; Open Networking Foundation

2 Disclaimer THIS SPECIFICATION HAS BEEN APPROVED BY THE BOARD OF DIRECTORS OF THE OPEN NETWORKING FOUNDATION ( ONF ) BUT WILL NOT BE A FINAL SPEC- IFICATION UNTIL RATIFIED BY THE MEMBERS PER ONF S POLICIES AND PRO- CEDURES. THE CONTENTS OF THIS SPECIFICATION MAY BE CHANGED PRIOR TO PUBLICATION AND SUCH CHANGES MAY INCLUDE THE ADDITION OR DELE- TION OF NECESSARY CLAIMS OF PATENT AND OTHER INTELLECTUAL PROPERTY RIGHTS. THEREFORE, ONF PROVIDES THIS SPECIFICATION TO YOU ON AN AS IS BASIS, AND WITHOUT WARRANTY OF ANY KIND. THIS SPECIFICATION IS PROVIDED AS IS WITH NO WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY, NONINFRINGEMENT, FIT- NESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. Without limitation, ONF disclaims all liability, including liability for infringement of any proprietary rights, relating to use of information in this specification and to the implementation of this specification, and ONF disclaims all liability for cost of procurement of substitute goods or services, lost profits, loss of use, loss of data or any incidental, consequential, direct, indirect, or special damages, whether under contract, tort, warranty or otherwise, arising in any way out of use or reliance upon this specification or any information herein. No license, express or implied, by estoppel or otherwise, to any Open Networking Foundation or Open Networking Foundation member intellectual property rights is granted herein. Except that a license is hereby granted by ONF to copy and reproduce this specification for internal use only. Contact the Open Networking Foundation at for information on specification licensing through membership agreements. Any marks and brands contained herein are the property of their respective owners. Contents 1 Introduction 11 2 Switch Components 11 3 Glossary 12 4 OpenFlow Ports OpenFlow Ports Standard Ports Physical Ports Logical Ports Reserved Ports ; The Open Networking Foundation

3 4.6 Port changes Port recirculation OpenFlow Tables Pipeline Processing Pipeline Consistency Flow Tables and flow entries Matching Table-miss Instructions Action Set List of Actions Actions Default values for fields on push Counters Group Table Group Types Meter Table Meter Bands Ingress and egress processing differences OpenFlow Channel and Control Channel OpenFlow Switch Protocol Overview Controller-to-Switch Asynchronous Symmetric Message Handling OpenFlow Channel Connections Connection URI Connection Setup Connection Maintenance Connection Interruption Encryption Multiple Controllers Auxiliary Connections Flow Table Modification Messages Flow Removal Flow Table Synchronisation Group Table Modification Messages Meter Modification Messages Bundle Messages Bundle overview Bundle example usage Bundle error processing Bundle atomic modifications Bundle parallelism ; The Open Networking Foundation

4 6.9.6 Scheduled Bundles The Scheduled Bundle Procedure Discarding Scheduled Bundles Timekeeping and Synchronization Scheduling Tolerance The OpenFlow Switch Protocol Protocol basic format OpenFlow Header Padding Reserved and unsupported values and bit positions Common Structures Port Structures Port Description Structures Port Description Properties Header Types Structure Flow Match Structures Flow Match Header Flow Match Field Structures OXM classes Flow Matching Flow Match Field Masking Flow Match Field Prerequisite Flow Match Fields Header Match Fields Pipeline Match Fields Packet registers Packet Type Match Field Experimenter Flow Match Fields Flow Stats Structures Flow Stats Header Flow Stat Field Structures OXS classes Flow Stat Fields Experimenter Flow Stat Fields Flow Instruction Structures Action Structures Output Action Structures Group Action Structures Set-Queue Action Structure Meter Action Structure TTL Actions Structures Push and Pop Actions Structures Set-Field Action Structure Copy-Field Action Structure Experimenter Action Structure Controller Status Structure ; The Open Networking Foundation

5 7.2.8 Experimenter Structure Controller-to-Switch Messages Handshake Switch Configuration Flow Table Configuration Modify State Messages Modify Flow Table Message Modify Flow Entry Message Modify Group Entry Message Port Modification Message Meter Modification Message Multipart Messages Description Individual Flow Descriptions Individual Flow Statistics Aggregate Flow Statistics Port Statistics Port Description Queue Statistics Queue Descriptions Group Statistics Group Description Group Features Meter Statistics Meter Descriptions Meter Features Controller Status Multipart Table Statistics Table Description Table Features Flow Monitoring Bundle Features Multipart Experimenter Multipart Packet-Out Message Barrier Message Role Request Message Bundle messages Bundle control messages Bundle Add message Bundle flags Bundle properties Time Format Creating and opening a bundle Adding messages to a bundle Closing a bundle Committing Bundles Discarding Bundles ; The Open Networking Foundation

6 Other bundle error conditions Set Asynchronous Configuration Message Asynchronous Messages Packet-In Message Flow Removed Message Port Status Message Controller Role Status Message Table Status Message Request Forward Message Controller Status Message Symmetric Messages Hello Echo Request Echo Reply Error Message Hello Failed error codes Bad Request error codes Bad Action error codes Bad Instruction error codes Bad Match error codes Flow-mod Failed error codes Group-mod Failed error codes Port-mod Failed error codes Table-mod Failed error codes Queue-op Failed error codes Switch Config Failed error codes Role Request Failed error codes Meter-mod Failed error codes Table-features Failed error codes Bad Property error codes Async Config Failed error codes Flow-monitor Failed error codes Bundle Failed error codes Experimenter Error Message Experimenter Message A Header file openflow.h 196 B Release Notes 238 B.1 OpenFlow version B.2 OpenFlow version B.3 OpenFlow version B.4 OpenFlow version B.5 OpenFlow version B.6 OpenFlow version B.6.1 IP Netmasks B.6.2 New Physical Port Stats ; The Open Networking Foundation

7 B.6.3 IN PORT Virtual Port B.6.4 Port and Link Status and Configuration B.6.5 Echo Request/Reply Messages B.6.6 Vendor Extensions B.6.7 Explicit Handling of IP Fragments B D Spanning Tree B.6.9 Modify Actions in Existing Flow Entries B.6.10 More Flexible Description of Tables B.6.11 Lookup Count in Tables B.6.12 Modifying Flags in Port-Mod More Explicit B.6.13 New Packet-Out Message Format B.6.14 Hard Timeout for Flow Entries B.6.15 Reworked initial handshake to support backwards compatibility B.6.16 Description of Switch Stat B.6.17 Variable Length and Vendor Actions B.6.18 VLAN Action Changes B.6.19 Max Supported Ports Set to B.6.20 Send Error Message When Flow Not Added Due To Full Tables B.6.21 Behavior Defined When Controller Connection Lost B.6.22 ICMP Type and Code Fields Now Matchable B.6.23 Output Port Filtering for Delete, Flow Stats and Aggregate Stats B.7 OpenFlow version B.7.1 Failover B.7.2 Emergency Flow Cache B.7.3 Barrier Command B.7.4 Match on VLAN Priority Bits B.7.5 Selective Flow Expirations B.7.6 Flow Mod Behavior B.7.7 Flow Expiration Duration B.7.8 Notification for Flow Deletes B.7.9 Rewrite DSCP in IP ToS header B.7.10 Port Enumeration now starts at B.7.11 Other changes to the Specification B.8 OpenFlow version B.8.1 Slicing B.8.2 Flow cookies B.8.3 User-specifiable datapath description B.8.4 Match on IP fields in ARP packets B.8.5 Match on IP ToS/DSCP bits B.8.6 Querying port stats for individual ports B.8.7 Improved flow duration resolution in stats/expiry messages B.8.8 Other changes to the Specification B.9 OpenFlow version B.9.1 Multiple Tables B.9.2 Groups B.9.3 Tags : MPLS & VLAN B.9.4 Virtual ports ; The Open Networking Foundation

8 B.9.5 Controller connection failure B.9.6 Other changes B.10 OpenFlow version B.10.1 Extensible match support B.10.2 Extensible set field packet rewriting support B.10.3 Extensible context expression in packet-in B.10.4 Extensible Error messages via experimenter error type B.10.5 IPv6 support added B.10.6 Simplified behaviour of flow-mod request B.10.7 Removed packet parsing specification B.10.8 Controller role change mechanism B.10.9 Other changes B.11 OpenFlow version B.11.1 Refactor capabilities negotiation B.11.2 More flexible table miss support B.11.3 IPv6 Extension Header handling support B.11.4 Per flow meters B.11.5 Per connection event filtering B.11.6 Auxiliary connections B.11.7 MPLS BoS matching B.11.8 Provider Backbone Bridging tagging B.11.9 Rework tag order B.11.10Tunnel-ID metadata B.11.11Cookies in packet-in B.11.12Duration for stats B.11.13On demand flow counters B.11.14Other changes B.12 OpenFlow version B.12.1 Improved version negotiation B.12.2 Other changes B.13 OpenFlow version B.13.1 Changes B.13.2 Clarifications B.14 OpenFlow version B.14.1 Changes B.14.2 Clarifications B.15 OpenFlow version B.15.1 Changes B.15.2 Clarifications B.16 OpenFlow version B.16.1 More extensible wire protocol B.16.2 More descriptive reasons for packet-in B.16.3 Optical port properties B.16.4 Flow-removed reason for meter delete B.16.5 Flow monitoring B.16.6 Role status events B.16.7 Eviction ; The Open Networking Foundation

9 B.16.8 Vacancy events B.16.9 Bundles B.16.10Synchronised tables B.16.11Group and Meter change notifications B.16.12Error code for bad priority B.16.13Error code for Set-async-config B.16.14PBB UCA header field B.16.15Error code for duplicate instruction B.16.16Error code for multipart timeout B.16.17Change default TCP port to B.17 OpenFlow version alpha B.17.1 Changes B.17.2 Clarifications B.18 OpenFlow version B.18.1 Egress Tables B.18.2 Packet Type aware pipeline B.18.3 Extensible Flow Entry Statistics B.18.4 Flow Entry Statistics Trigger B.18.5 Copy-Field action to copy between two OXM fields B.18.6 Packet Register pipeline fields B.18.7 TCP flags matching B.18.8 Group command for selective bucket operation B.18.9 Allow set-field action to set metadata field B.18.10Allow wildcard to be used in set-field action B.18.11Scheduled Bundles B.18.12Controller connection status B.18.13Meter action B.18.14Enable setting all pipeline fields in packet-out B.18.15Port properties for pipeline fields B.18.16Port property for recirculation B.18.17Clarify and improve barrier B.18.18Always generate port status on port config change B.18.19Make all Experimenter OXM-IDs 64 bits B.18.20Unified requests for group, port and queue multiparts B.18.21Rename some type for consistency B.18.22Specification reorganisation C Credits 277 List of Tables 1 Main components of a flow entry in a flow table Push/pop tag actions Change-TTL actions Existing fields that may be copied into new fields on a push action List of counters ; The Open Networking Foundation

10 6 Main components of a group entry in the group table Main components of a meter entry in the meter table Main components of a meter band in a meter entry Common Canonical Header Types OXM TLV header fields OXM mask and value Required match fields Header match fields details Match combinations for VLAN tags Pipeline match fields details Packet Types OXS TLV header fields Stat fields details List of Figures 1 Main components of an OpenFlow switch Packet flow through the processing pipeline Simplified flowchart detailing packet flow through an OpenFlow switch Matching and Instruction exectution in a flow table Scheduled Bundle Procedure Discarding a Scheduled Commit Scheduling Tolerance OXM TLV header layout OXS TLV header layout ; The Open Networking Foundation

11 1 Introduction This document describes the requirements of an OpenFlow Logical Switch. Additional information describing OpenFlow and Software Defined Networking is available on the Open Networking Foundation website ( This specification covers the components and the basic functions of the switch, and the OpenFlow switch protocol to manage an OpenFlow switch from a remote OpenFlow controller. Controller Controller OpenFlow Channel Protocol OpenFlow Channel Control Channel OpenFlow Switch Group Table Datapath Meter Table Port Port Flow Table Flow Table Pipeline Flow Table Port Port Figure 1: Main components of an OpenFlow switch. 2 Switch Components An OpenFlow Logical Switch consists of one or more flow tables and a group table, which perform packet lookups and forwarding, and one or more OpenFlow channels to an external controller (Figure 1). The switch communicates with the controller and the controller manages the switch via the OpenFlow switch protocol. Using the OpenFlow switch protocol, the controller can add, update, and delete flow entries in flow tables, both reactively (in response to packets) and proactively. Each flow table in the switch contains a set of flow entries; each flow entry consists of match fields, counters, and a set of instructions to apply to matching packets (see 5.2). Matching starts at the first flow table and may continue to additional flow tables of the pipeline (see 5.1). Flow entries match packets in priority order, with the first matching entry in each table being used (see 5.3). If a matching entry is found, the instructions associated with the specific flow entry are executed (see 5.5). If no match is found in a flow table, the outcome depends on configuration of the ; The Open Networking Foundation

12 table-miss flow entry: for example, the packet may be forwarded to the controllers over the OpenFlow channel, dropped, or may continue to the next flow table (see 5.4). Instructions associated with each flow entry either contain actions or modify pipeline processing (see 5.5). Actions included in instructions describe packet forwarding, packet modification and group table processing. Pipeline processing instructions allow packets to be sent to subsequent tables for further processing and allow information, in the form of metadata, to be communicated between tables. Table pipeline processing stops when the instruction set associated with a matching flow entry does not specify a next table; at this point the packet is usually modified and forwarded (see 5.6). Flow entries may forward to a port. This is usually a physical port, but it may also be a logical port defined by the switch or a reserved port defined by this specification (see 4.1). Reserved ports may specify generic forwarding actions such as sending to the controller, flooding, or forwarding using non- OpenFlow methods, such as normal switch processing (see 4.5), while switch-defined logical ports may specify link aggregation groups, tunnels or loopback interfaces (see 4.4). Actions associated with flow entries may also direct packets to a group, which specifies additional processing (see 5.10). Groups represent sets of actions for flooding, as well as more complex forwarding semantics (e.g. multipath, fast reroute, and link aggregation). As a general layer of indirection, groups also enable multiple flow entries to forward to a single identifier (e.g. IP forwarding to a common next hop). This abstraction allows common output actions across flow entries to be changed efficiently. The group table contains group entries; each group entry contains a list of action buckets with specific semantics dependent on group type (see ). The actions in one or more action buckets are applied to packets sent to the group. Switch designers are free to implement the internals in any way convenient, provided that correct match and instruction semantics are preserved. For example, while a flow entry may use an all group to forward to multiple ports, a switch designer may choose to implement this as a single bitmask within the hardware forwarding table. Another example is matching; the pipeline exposed by an OpenFlow switch may be physically implemented with a different number of hardware tables. 3 Glossary This section describes key OpenFlow specification terms. Most terms are specific to this specification. Action: an operation that forwards the packet to a port, modifies the packet (such as decrementing the TTL field) or changes its state (such as associating it with a queue). Most actions include parameters, for example a set-field action includes a field type and field value. Actions may be specified as part of the instruction set associated with a flow entry or in an action bucket associated with a group entry. Actions may be accumulated in the Action Set of the packet or applied immediately to the packet (see 5.8). List of Actions: a list of actions included in a flow entry in the Apply-Actions instruction or in a packet-out message that are executed immediately in the list order (see 5.7). Actions in a list can be duplicated, their effects are cumulative ; The Open Networking Foundation

13 Set of Actions: a set of actions included in a flow entry in the Write-Actions instruction that are added to the action set, or in a group action-bucket that are executed in action-set order (see 5.6). Actions in a set can occur only once. Action Bucket: a set of actions in a group. The group will select one or more buckets for each packet. Action Set: a set of actions associated with the packet that are accumulated while the packet is processed by each table and that are executed in specified order when the instruction set terminates pipeline processing (see 5.6). Byte: an 8-bit octet. Connection: a network connection that carry OpenFlow messages between a switch and a controller, it may be implemented using various network transport protocols (see 6.3). An OpenFlow channel has a main connection, and optionally a number of auxiliary connections (see 6.3.7). Control Channel: The aggregation of components of an OpenFlow logical switch that manage communication with controllers. The control channel includes one OpenFlow channel per OpenFlow controller. Controller: see OpenFlow controller. Counter: counters are the main element of OpenFlow statistics and accumulated at various specific points of the pipeline, such as on a port or on a flow entry (see 5.9). Counters typically count the number of packets and bytes passing through an OpenFlow element, however other counters types are also defined. Datapath: the aggregation of components of an OpenFlow logical switch that are directly involved in traffic processing and forwarding. The datapath includes the pipeline of flow tables, the group table and the ports. Flow Entry: an element in a flow table used to match and process packets. It contains a set of match fields for matching packets, a priority for matching precedence, a set of counters to track packets, and a set of instructions to apply (see 5.2). Flow Table: a stage of the pipeline. It contains flow entries. Forwarding: Deciding the output port or set of output ports for a packet, and transfering that packet to those output ports. Group: a list of action buckets and some means of choosing one or more of those buckets to apply on a per-packet basis (see 5.10). Header: control information embedded in a packet used by a switch to identify the packet and to inform the switch on how to process and forward the packet. The header typically includes various header fields to identify the source and destination of the packet, and how to interpret other headers and the payload. Header Field: a value from the packet header. The packet header is parsed to extract its header fields which are matched against corresponding match fields. Hybrid: integrate both OpenFlow operation and normal Ethernet switching operation (see 5.1) ; The Open Networking Foundation

14 Instruction: instructions are attached to a flow entry and describe the OpenFlow processing that happens when a packet matches the flow entry. An instruction either modifies pipeline processing, such as directing the packet to another flow table, or contains a set of actions to add to the action set, or contains a list of actions to apply immediately to the packet (see 5.5). Instruction Set: a set of instructions attached to a flow entry in a flow table. Match Field: a part of a flow entry against which a packet is matched. Match fields can match the various packet header fields (see ), the packet ingress port, the metadata value and other pipeline fields (see ). A match field may be wildcarded (match any value) and in some cases bitmasked (match subset of bits). Matching: comparing the set of header fields and pipeline fields of a packet to the match fields of a flow entry (see 5.3). Metadata: a maskable register that is used to carry information from one table to the next. Message: OpenFlow protocol unit sent over an OpenFlow connection. May be a request, a reply, a control message or a status event. Meter: a switch element that can measure and control the rate of packets. The meter triggers a meter band if the packet rate or byte rate passing through the meter exceeds a predefined threshold (see 5.11). If the meter band drops the packet, it is called a Rate Limiter. OpenFlow Channel: interface between an OpenFlow switch and an OpenFlow controller, used by the controller to manage the switch. OpenFlow Controller: an entity interacting with the OpenFlow switch using the OpenFlow switch protocol. In most case, an OpenFlow Controller is software which controls many OpenFlow Logical Switches. OpenFlow Logical Switch: A set of OpenFlow resources that can be managed as a single entity, includes a datapath and a control channel. OpenFlow Protocol: The protocol defined by this specification. Also called OpenFlow Switch Protocol. OpenFlow Switch: See OpenFlow Logical Switch. Packet: a series of bytes comprising a header, a payload and optionally a trailer, in that order, and treated as a unit for purposes of processing and forwarding. The default packet type is Ethernet, other packet types are also supported (see ). Pipeline: the set of linked flow tables that provide matching, forwarding, and packet modification in an OpenFlow switch (see 5.1). Pipeline fields: set of values attached to the packet during pipeline processing which are not header fields. Include the ingress port, the metadata value, the Tunnel-ID value and others (see ). Port: where packets enter and exit the OpenFlow pipeline (see 4.1). May be a physical port, a logical port, or a reserved port defined by the OpenFlow switch protocol. Queue: Schedule packets according to their priority on an output port to provide Quality-of- Service (QoS) ; The Open Networking Foundation

15 Switch: See OpenFlow Logical Switch. Tag: a header that can be inserted or removed from a packet via push and pop actions. Outermost Tag: the tag that appears closest to the beginning of a packet. 4 OpenFlow Ports This section describes the OpenFlow port abstraction and the various types of OpenFlow ports supported by OpenFlow. 4.1 OpenFlow Ports OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports, a packet can be forwarded from one OpenFlow switch to another OpenFlow switch only via an output OpenFlow port on the first switch and an ingress OpenFlow port on the second switch. An OpenFlow switch makes a number of OpenFlow ports available for OpenFlow processing. The set of OpenFlow ports may not be identical to the set of network interfaces provided by the switch hardware, some network interfaces may be disabled for OpenFlow, and the OpenFlow switch may define additional OpenFlow ports. OpenFlow packets are received on an ingress port and processed by the OpenFlow pipeline (see 5.1) which may forward them to an output port. The packet ingress port is a property of the packet throughout the OpenFlow pipeline and represents the OpenFlow port on which the packet was received into the OpenFlow switch. The ingress port can be used when matching packets (see 5.3). The Open- Flow pipeline can decide to send the packet on an output port using the output action (see 5.8), which defines how the packet goes back to the network. An OpenFlow switch must support three types of OpenFlow ports: physical ports, logical ports and reserved ports. 4.2 Standard Ports The OpenFlow standard ports are defined as physical ports, logical ports, and the LOCAL reserved port if supported (excluding other reserved ports). Standard ports can be used as ingress and output ports, they can be used in groups (see 5.10), they have port counters (see 5.9) and they have state and configuration (see 7.2.1) ; The Open Networking Foundation

16 4.3 Physical Ports The OpenFlow physical ports are switch defined ports that correspond to a hardware interface of the switch. For example, on an Ethernet switch, physical ports map one-to-one to the Ethernet interfaces. In some deployments, the OpenFlow switch may be virtualised over the switch hardware. In those cases, an OpenFlow physical port may represent a virtual slice of the corresponding hardware interface of the switch. 4.4 Logical Ports The OpenFlow logical ports are switch defined ports that don t correspond directly to a hardware interface of the switch. Logical ports are higher level abstractions that may be defined in the switch using non-openflow methods (e.g. link aggregation groups, tunnels, loopback interfaces). Logical ports may include packet encapsulation and may map to various physical ports. The processing done by the logical port is implementation dependant and must be transparent to OpenFlow processing, and those ports must interact with OpenFlow processing like OpenFlow physical ports. The only differences between physical ports and logical ports is that a packet associated with a logical port may have an extra pipeline field called Tunnel-ID associated with it (see ) and when a packet received on a logical port is sent to the controller, both its logical port and its underlying physical port are reported to the controller (see 7.4.1). 4.5 Reserved Ports The OpenFlow reserved ports are defined by this specification. They specify generic forwarding actions such as sending to the controller, flooding, or forwarding using non-openflow methods, such as normal switch processing. A switch is not required to support all reserved ports, just those marked Required below. Required: ALL: Represents all ports the switch can use for forwarding a specific packet. Can be used only as an output port. In that case a copy of the packet starts egress processing on all standard ports, excluding the packet ingress port and ports that are configured OFPPC_NO_FWD. Required: CONTROLLER: Represents the control channel with the OpenFlow controllers. Can be used as an ingress port or as an output port. When used as an output port, encapsulate the packet in a packet-in message and send it using the OpenFlow switch protocol (see 7.4.1). When used as an ingress port, this identifies a packet originating from the controller. Required: TABLE: Represents the start of the OpenFlow pipeline (see 5.1). This port is only valid in an output action in the list of actions of a packet-out message (see 7.3.6), and submits the packet to the first flow table so that the packet can be processed through the regular OpenFlow pipeline. Required: IN PORT: Represents the packet ingress port. Can be used only as an output port, send the packet out through its ingress port ; The Open Networking Foundation

17 Required: ANY: Special value used in some OpenFlow requests when no port is specified (i.e. port is wildcarded). Some OpenFlow requests contain a reference to a specific port that the request only applies to. Using ANY as the port number in these requests allows that request instance to apply to any and all ports. Can neither be used as an ingress port nor as an output port. Required: UNSET: Special value to specify the that output port has not been set in the Action-Set. Only used when trying to match the output port in the action set using the OXM_OF_ACTSET_OUTPUT match field (see ). Can neither be used as an ingress port nor as an output port. Optional: LOCAL: Represents the switch s local networking stack and its management stack. Can be used as an ingress port or as an output port. The local port enables remote entities to interact with the switch and its network services via the OpenFlow network, rather than via a separate control network. With a suitable set of default flow entries it can be used to implement an in-band controller connection. Optional: NORMAL: Represents forwarding using the traditional non-openflow pipeline of the switch (see 5.1). Can be used only as an output port and processes the packet using the normal pipeline. In general will bridge or route the packet, however the actual result is implementation dependant. If the switch cannot forward packets from the OpenFlow pipeline to the normal pipeline, it must indicate that it does not support this action. Optional: FLOOD: Represents flooding using the traditional non-openflow pipeline of the switch (see 5.1). Can be used only as an output port, actual result is implementation dependant. In general will send the packet out all standard ports, but not to the ingress port, nor ports that are in OFPPS_BLOCKED state. The switch may also use the packet VLAN ID or other criteria to select which ports to use for flooding. OpenFlow-only switches do not support the NORMAL port and FLOOD port, while OpenFlow-hybrid switches may support them (see 5.1). Forwarding packets to the FLOOD port depends on the switch implementation and configuration, while forwarding using a group of type all enables the controller to more flexibly implement flooding (see ). 4.6 Port changes A switch configuration, for example using the OpenFlow Configuration Protocol, may add or remove ports from the OpenFlow switch at any time. The switch may change the port state based on the underlying port mechanism, for example if the link is going down (see 7.2.1). The controller or a switch configuration may change the port configuration (see 7.2.1). Any such changes to port state or configuration must be communicated to the OpenFlow controller (see 7.4.3). Port addition, modification or removal never changes the content of the flow tables, in particular flow entries referencing those ports are not modified or removed (flow entries may reference ports via the match or actions). Packet forwarded to non-existent ports are just dropped (see 5.6). Similarly, Port addition, modification and removal never changes the content of the group table, however the behaviour of some groups may change through liveness checking (see 6.7). If a port is deleted and its port number is later reused for a different physical or logical port, any remaining flow entries or group entries still referencing that port number may be effectively re-targeted ; The Open Networking Foundation

18 to the new port, possibly with undesirable results. Therefore, when a port is deleted it is left to the controller to clean up any flow entries or group entries referencing that port, if needed. 4.7 Port recirculation Logical ports can optionally be used to insert a network service or complex processing in the OpenFlow switch (see 4.4). Most often, packets sent to logical ports never return to the same OpenFlow switch, they are either consumed by the logical port or eventually sent over a physical port. In other cases, packets sent to a logical port are recirculated back to the OpenFlow switch after the logical port processing. Packet recirculation via logical ports is optional, and OpenFlow supports multiple types of port recirculation. The simplest recirculation is when a packet sent on a logical port returns back into the switch via the same logical port. This could be used for a loopback or unidirectional packet processing. Recirculation can also happen between a port pair, in which a packet sent on a logical port returns back into the switch via the other logical port of the pair. This could be used to represent tunnel endpoints or bidirectional packet processing. A port property describes the recirculation relationship between ports (see ). A switch should protect itself from packet infinite loops when using port recirculation. This mechanism is implementation-specific and outside the scope of this specification. For example, the switch could attach an internal recirculation count to each packet, which is incremented for each recirculation, and the switch drops packets for which the counter is above a switch-defined threshold. Controllers are strongly encouraged to avoid generating combinations of flow entries that may yield recirculation loops. Because of the wide range of possible processing, very little can be assumed about the packets recirculated back into the switch. Recirculated packets go back to the first flow table of the pipeline (see 5.1) and can be identified by their new input port. The packet headers may have changed, so the match fields are not guaranteed to be the same. The logical port may do packet fragmentation and reassembly, so the packets may not match one to one and may have different sizes. The Tunnel-ID field and some other pipeline fields associated with the packet may optionally be preserved through the recirculation and available for matching when returning to the switch, the pipeline fields that are preserved are indicated via the port match field property (see ). If a pipeline field is present in both the OFPPDPT_PIPELINE_OUTPUT property of the output port and the OFPPDPT_PIPELINE_INPUT property of the return port, then this pipeline field is preserved with the packet (its value must remain the same). 5 OpenFlow Tables This section describes the components of flow tables and group tables, along with the mechanics of matching and action handling ; The Open Networking Foundation

19 Packet In Ingress Port Ingress processing Set Ingress Port Action Set = {} Flow Table 0 Flow Table 1 Packet + pipeline fields (ingress port, metadata...) Action Set Flow Table n Execute Action Set Group Table Egress processing Set Output Port Action Set = {output} Flow Table e Flow Table e+1 e = first egress table-id Packet + pipeline fields (output port, metadata...) Action Set Flow Table e+m Execute Action Set Packet Out Output Port Figure 2: Packet flow through the processing pipeline. 5.1 Pipeline Processing OpenFlow-compliant switches come in two types: OpenFlow-only, and OpenFlow-hybrid. OpenFlowonly switches support only OpenFlow operation, in those switches all packets are processed by the OpenFlow pipeline, and can not be processed otherwise. OpenFlow-hybrid switches support both OpenFlow operation and normal Ethernet switching operation, i.e. traditional L2 Ethernet switching, VLAN isolation, L3 routing (IPv4 routing, IPv6 routing...), ACL and QoS processing. Those switches should provide a classification mechanism outside of Open- Flow that routes traffic to either the OpenFlow pipeline or the normal pipeline. For example, a switch may use the VLAN tag or input port of the packet to decide whether to process the packet using one pipeline or the other, or it may direct all packets to the OpenFlow pipeline. This classification mechanism is outside the scope of this specification. An OpenFlow-hybrid switch may also allow a packet to go from the OpenFlow pipeline to the normal pipeline through the NORMAL and FLOOD reserved ports (see 4.5). The OpenFlow pipeline of every OpenFlow Logical Switch contains one or more flow tables, each flow table containing multiple flow entries. The OpenFlow pipeline processing defines how packets interact with those flow tables (see Figure 2). An OpenFlow switch is required to have at least one ingress flow table, and can optionally have more flow tables. An OpenFlow switch with only a single flow table is valid, in this case pipeline processing is greatly simplified. The flow tables of an OpenFlow switch are sequentially numbered, starting at 0. Pipeline processing ; The Open Networking Foundation

20 happens in two stages, ingress processing and egress processing. The separation of the two stages is indicated by the first egress table (see 7.3.2), all tables with a number lower than the first egress table must be used as ingress tables, and no table with a number higher than or equal to the first egress table can be used as an ingress table. Pipeline processing always starts with ingress processing at the first flow table: the packet must be first matched against flow entries of flow table 0 (see Figure 3). Other ingress flow tables may be used depending on the outcome of the match in the first table. If the outcome of ingress processing is to forward the packet to an output port, the OpenFlow switch may perform egress processing in the context of that output port. Egress processing is optional, a switch may not support any egress tables or may not be configured to use them. If no valid egress table is configured as the first egress table (see 7.3.2), the packet must be process by the output port, and in most case the packet is forwarded out of the switch. If a valid egress table is configured as the first egress table (see 7.3.2), the packet must be matched against flow entries of that flow table, and other egress flow tables may be used depending on the outcome of the match in that flow table. When processed by a flow table, the packet is matched against the flow entries of the flow table to select a flow entry (see 5.3). If a flow entry is found, the instruction set included in that flow entry is executed. These instructions may explicitly direct the packet to another flow table (using the Goto- Table Instruction, see 5.5), where the same process is repeated again. A flow entry can only direct a packet to a flow table number which is greater than its own flow table number, in other words pipeline processing can only go forward and not backward. Obviously, the flow entries of the last table of a pipeline stage can not include the Goto-Table instruction. If the matching flow entry does not direct packets to another flow table, the current stage of pipeline processing stops at this table, the packet is processed with its associated action set and usually forwarded (see 5.6). If a packet does not match a flow entry in a flow table, this is a table miss. The behavior on a table miss depends on the table configuration (see 5.4). The instructions included in the table-miss flow entry in the flow table can flexibly specify how to process unmatched packets, useful options include dropping them, passing them to another table or sending them to the controllers over the control channel via packet-in messages (see 6.1.2). There are few cases where a packet is not fully processed by a flow entry and pipeline processing stops without processing the packet s action set or directing it to another table. If no table-miss flow entry is present, the packet is dropped (see 5.4). If an invalid TTL is found, the packet may be sent to the controller (see 5.8). The OpenFlow pipeline and various OpenFlow operations process packets of a specific type in conformance with the specifications defined for that packet type, unless the present specification or the OpenFlow configuration specify otherwise. For example, the Ethernet header definition used by Open- Flow must conform to IEEE specifications, and the TCP/IP header definition used by OpenFlow must conform to RFC specifications. Additionally, packet reordering in an OpenFlow switch must conform to the requirements of IEEE specifications, provided that the packets are processed by the same flow entries, group buckets and meter bands ; The Open Networking Foundation