--- openflow-2010-08-26-3.h 2015-07-23 09:54:16.164479322 -0700 +++ openflow-2010-10-06.h 2015-07-23 09:54:16.168479322 -0700 @@ -79,23 +79,23 @@ /* Port numbering. Physical ports are numbered starting from 1. */ enum ofp_port { /* Maximum number of physical switch ports. */ - OFPP_MAX = 0xff00, + OFPP_MAX = 0xffffff00, /* Fake output "ports". */ - OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This - virtual port must be explicitly used - in order to send back out of the input - port. */ - OFPP_TABLE = 0xfff9, /* Perform actions in flow table. - NB: This can only be the destination - port for packet-out messages. */ - OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */ - OFPP_FLOOD = 0xfffb, /* All physical ports except input port and - those disabled by STP. */ - OFPP_ALL = 0xfffc, /* All physical ports except input port. */ - OFPP_CONTROLLER = 0xfffd, /* Send to controller. */ - OFPP_LOCAL = 0xfffe, /* Local openflow "port". */ - OFPP_NONE = 0xffff /* Not associated with a physical port. */ + OFPP_IN_PORT = 0xfffffff8, /* Send the packet out the input port. This + virtual port must be explicitly used + in order to send back out of the input + port. */ + OFPP_TABLE = 0xfffffff9, /* Perform actions in flow table. + NB: This can only be the destination + port for packet-out messages. */ + OFPP_NORMAL = 0xfffffffa, /* Process with normal L2/L3 switching. */ + OFPP_FLOOD = 0xfffffffb, /* All physical ports in VLAN, except input + port and those blocked or link down. */ + OFPP_ALL = 0xfffffffc, /* All physical ports except input port. */ + OFPP_CONTROLLER = 0xfffffffd, /* Send to controller. */ + OFPP_LOCAL = 0xfffffffe, /* Local openflow "port". */ + OFPP_NONE = 0xffffffff /* Not associated with a physical port. */ }; enum ofp_type { @@ -121,7 +121,9 @@ /* Controller command messages. */ OFPT_PACKET_OUT, /* Controller/switch message */ OFPT_FLOW_MOD, /* Controller/switch message */ + OFPT_GROUP_MOD, /* Controller/switch message */ OFPT_PORT_MOD, /* Controller/switch message */ + OFPT_TABLE_MOD, /* Controller/switch message */ /* Statistics messages. */ OFPT_STATS_REQUEST, /* Controller/switch message */ @@ -133,8 +135,7 @@ /* Queue Configuration messages. */ OFPT_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */ - OFPT_QUEUE_GET_CONFIG_REPLY /* Controller/switch message */ - + OFPT_QUEUE_GET_CONFIG_REPLY, /* Controller/switch message */ }; /* Header on all OpenFlow packets. */ @@ -158,10 +159,14 @@ enum ofp_config_flags { /* Handling of IP fragments. */ - OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */ - OFPC_FRAG_DROP = 1, /* Drop fragments. */ - OFPC_FRAG_REASM = 2, /* Reassemble (only if OFPC_IP_REASM set). */ - OFPC_FRAG_MASK = 3 + OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */ + OFPC_FRAG_DROP = 1 << 0, /* Drop fragments. */ + OFPC_FRAG_REASM = 1 << 1, /* Reassemble (only if OFPC_IP_REASM set). */ + OFPC_FRAG_MASK = 3, + + /* TTL processing - applicable for IP and MPLS packets */ + OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL + ie. 0 or 1 to controller */ }; /* Switch configuration. */ @@ -173,13 +178,30 @@ }; OFP_ASSERT(sizeof(struct ofp_switch_config) == 12); +/* Flags to indicate behavior of the flow table. These flags are used in + ofp_table_stats to describe the current configuration. They are used in + ofp_table_mod message to configure the table's behavior */ +enum ofp_table_config { + OFPTC_TABLE_MISS_CONTINUE = 1, /* Continue to the next table in the + pipeline (OpenFlow 1.0 behavior) */ + OFPTC_TABLE_MISS_DROP = 2, /* Drop the packet */ + OFPTC_TABLE_MISS_MASK = 3 +}; + +/* Configure/Modify behavior of a flow table */ +struct ofp_table_mod { + struct ofp_header header; + uint8_t table_id; /* ID of the table, 0xFF indicates all tables */ + uint8_t pad[3]; /* Pad to 32 bits */ + uint32_t config; /* Bitmap of OFPTC_* flags */ +}; +OFP_ASSERT(sizeof(struct ofp_table_mod) == 16); + /* Capabilities supported by the datapath. */ enum ofp_capabilities { OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */ OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */ OFPC_PORT_STATS = 1 << 2, /* Port statistics. */ - OFPC_STP = 1 << 3, /* 802.1d spanning tree. */ - OFPC_RESERVED = 1 << 4, /* Reserved, must be zero. */ OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */ OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */ OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP pkts. */ @@ -192,11 +214,7 @@ enum ofp_port_config { OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */ - OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */ - OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D spanning - tree packets. */ - OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */ - OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */ + OFPPC_NO_RECV = 1 << 2, /* Drop all packets received by port. */ OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */ OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */ }; @@ -205,17 +223,9 @@ * the controller. */ enum ofp_port_state { - OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */ - - /* The OFPPS_STP_* bits have no effect on switch operation. The - * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and - * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning - * tree. */ - OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */ - OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */ - OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */ - OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */ - OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */ + OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */ + OFPPS_BLOCKED = 1 << 1, /* Port is blocked */ + OFPPS_LIVE = 1 << 2, /* Live for Fast Failover Group. */ }; /* Features of physical ports available in a datapath. */ @@ -236,8 +246,10 @@ /* Description of a physical port */ struct ofp_phy_port { - uint16_t port_no; + uint32_t port_no; + uint8_t pad[4]; uint8_t hw_addr[OFP_ETH_ALEN]; + uint8_t pad2[2]; /* Align to 64 bits. */ char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */ uint32_t config; /* Bitmap of OFPPC_* flags. */ @@ -249,8 +261,11 @@ uint32_t advertised; /* Features being advertised by the port. */ uint32_t supported; /* Features supported by the port. */ uint32_t peer; /* Features advertised by peer. */ + + uint32_t curr_speed; /* Current port bitrate in kbps. */ + uint8_t pad3[4]; /* Align to 64 bits. */ }; -OFP_ASSERT(sizeof(struct ofp_phy_port) == 48); +OFP_ASSERT(sizeof(struct ofp_phy_port) == 64); /* Switch features. */ struct ofp_switch_features { @@ -266,7 +281,7 @@ /* Features. */ uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */ - uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */ + uint32_t reserved; /* Port info.*/ struct ofp_phy_port ports[0]; /* Port definitions. The number of ports @@ -294,21 +309,22 @@ /* Modify behavior of the physical port */ struct ofp_port_mod { struct ofp_header header; - uint16_t port_no; + uint32_t port_no; + uint8_t pad[4]; uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not configurable. This is used to sanity-check the request, so it must be the same as returned in an ofp_phy_port struct. */ - + uint8_t pad2[2]; /* Pad to 64 bits. */ uint32_t config; /* Bitmap of OFPPC_* flags. */ uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */ - uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all - bits to prevent any action taking place. */ - uint8_t pad[4]; /* Pad to 64-bits. */ + uint32_t advertise; /* Bitmap of OFPPF_*. Zero all bits to prevent + any action taking place. */ + unit8_t pad3[4]; /* Pad to 64 bits. */ }; -OFP_ASSERT(sizeof(struct ofp_port_mod) == 32); +OFP_ASSERT(sizeof(struct ofp_port_mod) == 40); /* Why is this packet being sent to the controller? */ enum ofp_packet_in_reason { @@ -320,10 +336,11 @@ struct ofp_packet_in { struct ofp_header header; uint32_t buffer_id; /* ID assigned by datapath. */ + uint32_t in_port; /* Port on which frame was received. */ uint16_t total_len; /* Full length of frame. */ - uint16_t in_port; /* Port on which frame was received. */ uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */ - uint8_t pad; + uint8_t table_id; /* ID of the table that was looked up */ + unit8_t pad[2]; /* Pad to "special". */ uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word, so the IP header is 32-bit aligned. The amount of data is inferred from the length @@ -331,12 +348,13 @@ offsetof(struct ofp_packet_in, data) == sizeof(struct ofp_packet_in) - 2. */ }; -OFP_ASSERT(sizeof(struct ofp_packet_in) == 20); +OFP_ASSERT(sizeof(struct ofp_packet_in) == 24); enum ofp_action_type { OFPAT_OUTPUT, /* Output to switch port. */ OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */ OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */ + OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */ OFPAT_SET_DL_SRC, /* Ethernet source address. */ OFPAT_SET_DL_DST, /* Ethernet destination address. */ OFPAT_SET_NW_SRC, /* IP source address. */ @@ -344,20 +362,10 @@ OFPAT_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */ OFPAT_SET_TP_SRC, /* TCP/UDP source port. */ OFPAT_SET_TP_DST, /* TCP/UDP destination port. */ - OFPAT_COPY_TTL_OUT, /* Copy TTL "outwards" -- from next-to-outermost to - outermost */ - OFPAT_COPY_TTL_IN, /* Copy TTL "inwards" -- from outermost to - next-to-outermost */ - OFPAT_SET_MPLS_LABEL, /* MPLS label */ - OFPAT_SET_MPLS_TC, /* MPLS TC */ - OFPAT_SET_MPLS_TTL, /* MPLS TTL */ - OFPAT_DEC_MPLS_TTL, /* Decrement MPLS TTL */ - - OFPAT_PUSH_VLAN, /* Push a new VLAN tag */ - OFPAT_POP_VLAN, /* Pop the outer VLAN tag */ - OFPAT_PUSH_MPLS, /* Push a new MPLS tag */ - OFPAT_POP_MPLS, /* Pop the outer MPLS tag */ - OFPAT_ENQUEUE, /* Output to queue. */ + OFPAT_SET_QUEUE, /* Set queue id used by Output action. */ + OFPAT_GROUP, /* Apply group. */ + OFPAT_SET_NW_TTL, /* IP TTL. */ + OFPAT_DEC_NW_TTL, /* Decrement IP TTL. */ OFPAT_VENDOR = 0xffff }; @@ -367,11 +375,12 @@ * packet should be sent.*/ struct ofp_action_output { uint16_t type; /* OFPAT_OUTPUT. */ - uint16_t len; /* Length is 8. */ - uint16_t port; /* Output port. */ + uint16_t len; /* Length is 16. */ + uint32_t port; /* Output port. */ uint16_t max_len; /* Max length to send to controller. */ + unit8_t pad[2]; /* Pad to 32 bits. */ }; -OFP_ASSERT(sizeof(struct ofp_action_output) == 8); +OFP_ASSERT(sizeof(struct ofp_action_output) == 16); /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate * special conditions. All ones is used to match that no VLAN id was @@ -431,31 +440,22 @@ }; OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8); -/* Action structure for OFPAT_SET_MPLS_LABEL. */ -struct ofp_action_mpls_label { - uint16_t type; /* OFPAT_SET_MPLS_LABEL. */ +/* Action structure for OFPAT_GROUP. */ +struct ofp_action_group { + uint16_t type; /* OFPAT_GROUP. */ uint16_t len; /* Length is 8. */ - uint32_t mpls_label; /* MPLS label */ + uint32_t group_id; /* Group identifier. */ }; -OFP_ASSERT(sizeof(struct ofp_action_mpls_label) == 8); +OFP_ASSERT(sizeof(struct ofp_action_group) == 8); -/* Action structure for OFPAT_SET_MPLS_TC. */ -struct ofp_action_mpls_tc { - uint16_t type; /* OFPAT_SET_MPLS_TC. */ +/* Action structure for OFPAT_SET_NW_TTL. */ +struct ofp_action_nw_ttl { + uint16_t type; /* OFPAT_SET_NW_TTL. */ uint16_t len; /* Length is 8. */ - uint8_t mpls_tc; /* MPLS TC */ + uint8_t nw_ttl; /* IP TTL */ uint8_t pad[3]; }; -OFP_ASSERT(sizeof(struct ofp_action_mpls_tc) == 8); - -/* Action structure for OFPAT_SET_MPLS_TTL. */ -struct ofp_action_mpls_ttl { - uint16_t type; /* OFPAT_SET_MPLS_TTL. */ - uint16_t len; /* Length is 8. */ - uint8_t mpls_ttl; /* MPLS TTL */ - uint8_t pad[3]; -}; -OFP_ASSERT(sizeof(struct ofp_action_mpls_ttl) == 8); +OFP_ASSERT(sizeof(struct ofp_action_nw_ttl) == 8); /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */ struct ofp_action_vendor_header { @@ -483,57 +483,45 @@ struct ofp_packet_out { struct ofp_header header; uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */ - uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */ + uint32_t in_port; /* Packet's input port (OFPP_NONE if none). */ uint16_t actions_len; /* Size of action array in bytes. */ + uint8_t pad[2]; struct ofp_action_header actions[0]; /* Actions. */ /* uint8_t data[0]; */ /* Packet data. The length is inferred from the length field in the header. (Only meaningful if buffer_id == -1.) */ }; -OFP_ASSERT(sizeof(struct ofp_packet_out) == 16); +OFP_ASSERT(sizeof(struct ofp_packet_out) == 20); enum ofp_flow_mod_command { OFPFC_ADD, /* New flow. */ OFPFC_MODIFY, /* Modify all matching flows. */ OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */ OFPFC_DELETE, /* Delete all matching flows. */ - OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */ + OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */ +}; + +/* Group commands */ +enum ofp_group_mod_command { + OFPGC_ADD, /* New group. */ + OFPGC_MODIFY, /* Modify all matching groups. */ + OFPGC_DELETE, /* Delete all matching groups. */ }; /* Flow wildcards. */ enum ofp_flow_wildcards { OFPFW_IN_PORT = 1 << 0, /* Switch input port. */ OFPFW_DL_VLAN = 1 << 1, /* VLAN id. */ - OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */ - OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */ - OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */ + OFPFW_DL_VLAN_PCP = 1 << 2, /* VLAN priority. */ + OFPFW_DL_TYPE = 1 << 3, /* Ethernet frame type. */ + OFPFW_NW_TOS = 1 << 4, /* IP ToS (DSCP field, 6 bits). */ OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */ OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */ OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */ - - /* IP source address wildcard bit count. 0 is exact match, 1 ignores the - * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard - * the entire field. This is the *opposite* of the usual convention where - * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */ - OFPFW_NW_SRC_SHIFT = 8, - OFPFW_NW_SRC_BITS = 6, - OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT, - OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT, - - /* IP destination address wildcard bit count. Same format as source. */ - OFPFW_NW_DST_SHIFT = 14, - OFPFW_NW_DST_BITS = 6, - OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT, - OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT, - - OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */ - OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */ - - OFPFW_MPLS_LABEL = 1 << 22, /* MPLS label. */ - OFPFW_MPLS_TC = 1 << 23, /* MPLS TC. */ + OFPFW_METADATA = 1 << 8, /* Metadata field */ /* Wildcard all fields. */ - OFPFW_ALL = ((1 << 24) - 1) + OFPFW_ALL = ((1 << 9) - 1) }; /* The wildcards for ICMP type and code fields use the transport source @@ -560,26 +548,29 @@ /* Fields to match against flows */ struct ofp_match { uint32_t wildcards; /* Wildcard fields. */ - uint16_t in_port; /* Input switch port. */ + uint32_t in_port; /* Input switch port. */ uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */ + uint8_t dl_src_mask[OFP_ETH_ALEN]; /* Ethernet source address mask. */ uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */ + uint8_t dl_dst_mask[OFP_ETH_ALEN]; /* Ethernet destination address mask. */ + uint8_t pad1[2]; /* Align to 64-bits */ uint16_t dl_vlan; /* Input VLAN id. */ uint8_t dl_vlan_pcp; /* Input VLAN priority. */ - uint8_t pad1[1]; /* Align to 64-bits */ + uint8_t pad2[1]; /* Align to 32-bits */ uint16_t dl_type; /* Ethernet frame type. */ uint8_t nw_tos; /* IP ToS (actually DSCP field, 6 bits). */ uint8_t nw_proto; /* IP protocol or lower 8 bits of * ARP opcode. */ - uint8_t pad2[2]; /* Align to 64-bits */ uint32_t nw_src; /* IP source address. */ + uint32_t nw_src_mask; /* IP source address mask. */ uint32_t nw_dst; /* IP destination address. */ + uint32_t nw_dst_mask; /* IP destination address mask. */ uint16_t tp_src; /* TCP/UDP source port. */ uint16_t tp_dst; /* TCP/UDP destination port. */ - uint32_t mpls_label; /* MPLS label. */ - uint8_t mpls_tc; /* MPLS TC. */ - uint8_t pad3[5]; /* Align to 64-bits */ + uint64_t metadata; /* Metadata passed between tables. */ + uint64_t metadata_mask; /* Mask for metadata. */ }; -OFP_ASSERT(sizeof(struct ofp_match) == 48); +OFP_ASSERT(sizeof(struct ofp_match) == 56); /* The match fields for ICMP type and code use the transport source and * destination port fields, respectively. */ @@ -593,11 +584,55 @@ /* By default, choose a priority in the middle. */ #define OFP_DEFAULT_PRIORITY 0x8000 +enum ofp_instruction_type { + OFPIT_GOTO_TABLE = 1, /* Setup the next table in the lookup + pipeline */ + OFPIT_WRITE_METADATA = 2, /* Setup the metadata field for use in later + pipelines */ + OFPIT_WRITE_ACTIONS = 3, /* Write the action(s) onto the datapath action + set */ + OFPIT_APPLY_ACTIONS = 4, /* Applies the action(s) immediately */ + OFPIT_CLEAR_ACTIONS = 5, /* Clears all actions from the datapath + action set */ + + OFPIT_EXTENSION = 0xFFFF /* Experimental instructions */ +}; + +struct ofp_instruction_goto_table { + uint16_t type; /* OFPI_GOTO_TABLE */ + uint16_t len; /* Length of this struct in bytes. */ + uint8_t table_id; /* Set next table in the lookup pipeline */ + uint8_t pad[3]; /* Pad to 64 bits. */ +}; +OFP_ASSERT(sizeof(struct ofp_instruction_goto_table) == 8); + +struct ofp_instruction_write_metadata { + uint16_t type; /* OFPI_WRITE_METADATA */ + uint16_t len; /* Length of this struct in bytes. */ + uint64_t metadata; /* Metadata value to write */ + uint64_t metadata_mask; /* Metadata write bitmask */ +}; +OFP_ASSERT(sizeof(struct ofp_instruction_write_metadata) == 20); + +struct ofp_instruction_actions { + uint16_t type; /* One of OFPIT_*_ACTIONS */ + uint16_t len; /* Length of this struct in bytes. */ + struct ofp_action_header actions[0]; /* Actions associated with + OFPI_WRITE_ACTIONS and + OFPI_APPLY_ACTIONS */ +}; +OFP_ASSERT(sizeof(ofp_instruction_actions) == 12); + +struct ofp_instruction_vendor { + uint16_t type; /* OFPI_VENDOR */ + uint16_t len; /* Length of this struct in bytes */ +}; +OFP_ASSERT(sizeof(ofp_instruction_vendor) == 4); + enum ofp_flow_mod_flags { OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow * expires or is deleted. */ - OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */ - OFPFF_EMERG = 1 << 2 /* Remark this is for emergency. */ + OFPFF_CHECK_OVERLAP = 1 << 1 /* Check for overlapping entries first. */ }; /* Flow setup and teardown (controller -> datapath). */ @@ -605,24 +640,79 @@ struct ofp_header header; struct ofp_match match; /* Fields to match */ uint64_t cookie; /* Opaque controller-issued identifier. */ + uint64_t cookie_mask; /* Mask used to restrict the cookie bits + that must match when the command is + OFPFC_MODIFY* or OFPFC_DELETE*. A value + of 0 indicates no restriction. */ /* Flow actions. */ - uint16_t command; /* One of OFPFC_*. */ + uint8_t table_id; /* ID of the table to put the flow in */ + uint8_t command; /* One of OFPFC_*. */ uint16_t idle_timeout; /* Idle time before discarding (seconds). */ uint16_t hard_timeout; /* Max time before discarding (seconds). */ uint16_t priority; /* Priority level of flow entry. */ uint32_t buffer_id; /* Buffered packet to apply to (or -1). Not meaningful for OFPFC_DELETE*. */ - uint16_t out_port; /* For OFPFC_DELETE* commands, require + uint32_t out_port; /* For OFPFC_DELETE* commands, require matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ uint16_t flags; /* One of OFPFF_*. */ + uint8_t pad[2]; + struct ofp_instruction instructions[0]; /* Instruction set */ +}; +OFP_ASSERT(sizeof(struct ofp_flow_mod) == 80); + +/* Group numbering. Groups can use any number up to OFPG_MAX. */ +enum ofp_group { + /* Last usable group number. */ + OFPG_MAX = 0xffffff00, + + /* Fake groups. */ + OFPG_ALL = 0xfffffffc, /* Represents all groups for group delete + commands. */ + OFPG_NONE = 0xffffffff /* No group specified. */ +}; + +/* Group setup and teardown (controller -> datapath). */ +struct ofp_group_mod { + struct ofp_header header; + uint16_t command; /* One of OFPGC_*. */ + uint8_t type; /* One of OFPGT_*. */ + unit8_t pad; /* Pad to 64 bits. */ + uint32_t group_id; /* Group identifier. */ + struct ofp_bucket buckets[0]; /* The bucket length is inferred from the + length field in the header. */ +}; +OFP_ASSERT(sizeof(struct ofp_group_mod) == 16); + +/* Group types. Values in the range [128, 255] are reserved for experimental + * use. */ +enum ofp_group_type { + OFPGT_FLOOD, /* Flood group. */ + OFPGT_MPATH, /* Multipath group. */ + OFPGT_INDIRECT, /* Indirect group. */ + OFPGT_FF /* Fast failover group. */ +}; + +/* Bucket for use in groups. */ +struct ofp_bucket { + uint16_t len; /* Length the bucket in bytes, including + this header and any padding to make it + 64-bit aligned. */ + uint16_t weight; /* Relative weight of bucket. Only + defined for multipath groups. */ + uint32_t watch_port; /* Port whose state affects whether this + bucket is live. Only required for fast + failover groups. */ + uint32_t watch_group; /* Group whose state affects whether this + bucket is live. Only required for fast + failover groups. */ struct ofp_action_header actions[0]; /* The action length is inferred - from the length field in the - header. */ + from the length field in the + header. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72); +OFP_ASSERT(sizeof(struct ofp_action_header) == 8); /* Why was this flow removed? */ enum ofp_flow_removed_reason { @@ -639,7 +729,7 @@ uint16_t priority; /* Priority level of flow entry. */ uint8_t reason; /* One of OFPRR_*. */ - uint8_t pad[1]; /* Align to 32-bits. */ + uint8_t table_id; /* ID of the table */ uint32_t duration_sec; /* Time flow was alive in seconds. */ uint32_t duration_nsec; /* Time flow was alive in nanoseconds beyond @@ -659,6 +749,7 @@ OFPET_BAD_REQUEST, /* Request was not understood. */ OFPET_BAD_ACTION, /* Error in action description. */ OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */ + OFPET_GROUP_MOD_FAILED, /* Problem modifying group entry. */ OFPET_PORT_MOD_FAILED, /* Port mod request failed. */ OFPET_QUEUE_OP_FAILED /* Queue operation failed. */ }; @@ -682,7 +773,8 @@ OFPBRC_EPERM, /* Permissions error. */ OFPBRC_BAD_LEN, /* Wrong request length for type. */ OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */ - OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */ + OFPBRC_BUFFER_UNKNOWN, /* Specified buffer does not exist. */ + OFPBRC_BAD_TABLE_ID /* Invalid table-id associated with the flow */ }; /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least @@ -692,32 +784,57 @@ OFPBAC_BAD_LEN, /* Length problem in actions. */ OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */ OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */ - OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */ + OFPBAC_BAD_OUT_PORT, /* Invalid port in forward action. */ OFPBAC_BAD_ARGUMENT, /* Bad action argument. */ OFPBAC_EPERM, /* Permissions error. */ OFPBAC_TOO_MANY, /* Can't handle this many actions. */ - OFPBAC_BAD_QUEUE /* Problem validating output queue. */ + OFPBAC_BAD_QUEUE, /* Problem validating output queue. */ + OFPBAC_BAD_OUT_GROUP, /* Invalid group id in forward action. */ }; /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains * at least the first 64 bytes of the failed request. */ enum ofp_flow_mod_failed_code { + OFPFMFC_UNKNOWN, /* Unspecified error */ OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */ OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with * CHECK_OVERLAP flag set. */ OFPFMFC_EPERM, /* Permissions error. */ - OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard - * timeout. */ + OFPFMFC_BAD_TIMEOUT, /* Flow not added because of unsupported + * idle/hard timeout. */ OFPFMFC_BAD_COMMAND, /* Unknown command. */ - OFPFMFC_UNSUPPORTED /* Unsupported action list - cannot process in + OFPFMFC_UNSUPPORTED, /* Unsupported action list - cannot process in * the order specified. */ + OFPFMFC_TABLE_FULL, /* Table specified by the flow mod */ + OFPFMFC_BAD_INSTRUCTION /* Unsupported instruction specified by the + flow mod */ +}; + +/* ofp_error_msg 'code' values for OFPET_GROUP_MOD_FAILED. 'data' contains + * at least the first 64 bytes of the failed request. */ +enum ofp_group_mod_failed_code { + OFPGMFC_GROUP_EXISTS, /* Group not added because a group ADD + * attempted to replace an + * already-present group. */ + OFPGMFC_INVALID_GROUP, /* Group not added because Group specified + * is invalid. */ + OFPGMFC_WEIGHT_UNSUPPORTED, /* Switch does not support unequal load + * sharing with multipath groups. */ + OFPGMFC_OUT_OF_GROUPS, /* The group table is full. */ + OFPGMFC_OUT_OF_BUCKETS, /* The maximum number of action buckets + * for a group has been exceeded. */ + OFPGMFC_CHAINING_UNSUPPORTED, /* Switch does not support groups that + * forward to groups. */ + OFPGMFC_WATCH_UNSUPPORTED, /* This group can not watch the + watch_port or watch_group specified. */ + OFPGMFC_LOOP /* Group entry would cause a loop. */ }; /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains * at least the first 64 bytes of the failed request. */ enum ofp_port_mod_failed_code { OFPPMFC_BAD_PORT, /* Specified port does not exist. */ - OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */ + OFPPMFC_BAD_HW_ADDR /* Specified hardware address is wrong. */ }; /* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains @@ -770,6 +887,16 @@ * The reply body is an array of struct ofp_queue_stats */ OFPST_QUEUE, + /* Group counter statistics. + * The request body is empty. + * The reply is struct ofp_group_stats. */ + OFPST_GROUP, + + /* Group description statistics. + * The request body is empty. + * The reply body is struct ofp_group_desc_stats. */ + OFPST_GROUP_DESC, + /* Vendor extension. * The request and reply bodies begin with a 32-bit vendor ID, which takes * the same form as in "struct ofp_vendor_header". The request and reply @@ -815,12 +942,17 @@ struct ofp_match match; /* Fields to match. */ uint8_t table_id; /* ID of table to read (from ofp_table_stats), 0xff for all tables or 0xfe for emergency. */ - uint8_t pad; /* Align to 32 bits. */ - uint16_t out_port; /* Require matching entries to include this + uint8_t pad[3]; /* Align to 64 bits. */ + uint32_t out_port; /* Require matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ + uint64_t cookie; /* Require matching entries to contain this + cookie value */ + uint64_t cookie_mask; /* Mask used to restrict the cookie bits that + must match. A value of 0 indicates + no restriction. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44); +OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 64); /* Body of reply to OFPST_FLOW request. */ struct ofp_flow_stats { @@ -839,7 +971,7 @@ uint64_t cookie; /* Opaque controller-issued identifier. */ uint64_t packet_count; /* Number of packets in flow. */ uint64_t byte_count; /* Number of bytes in flow. */ - struct ofp_action_header actions[0]; /* Actions. */ + struct ofp_instruction instructions[0]; /* Instruction set. */ }; OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88); @@ -848,12 +980,17 @@ struct ofp_match match; /* Fields to match. */ uint8_t table_id; /* ID of table to read (from ofp_table_stats) 0xff for all tables or 0xfe for emergency. */ - uint8_t pad; /* Align to 32 bits. */ - uint16_t out_port; /* Require matching entries to include this + uint8_t pad[3]; /* Align to 64 bits. */ + uint32_t out_port; /* Require matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ + uint64_t cookie; /* Require matching entries to contain this + cookie value */ + uint64_t cookie_mask; /* Mask used to restrict the cookie bits that + must match. A value of 0 indicates + no restriction. */ }; -OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44); +OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 64); /* Body of reply to OFPST_AGGREGATE request. */ struct ofp_aggregate_stats_reply { @@ -872,28 +1009,34 @@ char name[OFP_MAX_TABLE_NAME_LEN]; uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are supported by the table. */ + uint32_t actions; /* Bitmap of OFPAT_* that are supported + by the table. */ + uint32_t match; /* Bitmap of OFPFW_* that indicate the fields + the table can match on. */ + uint32_t instructions; /* Bitmap of OFPIT_* values supported. */ + uint32_t config; /* Bitmap of OFPTC_* values */ uint32_t max_entries; /* Max number of entries supported. */ uint32_t active_count; /* Number of active entries. */ uint64_t lookup_count; /* Number of packets looked up in table. */ uint64_t matched_count; /* Number of packets that hit table. */ }; -OFP_ASSERT(sizeof(struct ofp_table_stats) == 64); +OFP_ASSERT(sizeof(struct ofp_table_stats) == 76) /* Body for ofp_stats_request of type OFPST_PORT. */ struct ofp_port_stats_request { - uint16_t port_no; /* OFPST_PORT message must request statistics + uint32_t port_no; /* OFPST_PORT message must request statistics * either for a single port (specified in * port_no) or for all ports (if port_no == * OFPP_NONE). */ - uint8_t pad[6]; + uint8_t pad[4]; }; OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 8); /* Body of reply to OFPST_PORT request. If a counter is unsupported, set * the field to all ones. */ struct ofp_port_stats { - uint16_t port_no; - uint8_t pad[6]; /* Align to 64-bits. */ + uint32_t port_no; + uint8_t pad[4]; /* Align to 64-bits. */ uint64_t rx_packets; /* Number of received packets. */ uint64_t tx_packets; /* Number of transmitted packets. */ uint64_t rx_bytes; /* Number of received bytes. */ @@ -915,6 +1058,47 @@ }; OFP_ASSERT(sizeof(struct ofp_port_stats) == 104); +/* Body of OFPST_GROUP request. */ +struct ofp_group_stats_request { + uint32_t group_id; /* All groups if OFPG_ALL. */ + uint8_t pad[4]; /* Align to 64 bits. */ +}; +OFP_ASSERT(sizeof(struct ofp_group_stats_request) == 8); + +/* All ones is used to indicate all groups on a switch. */ +#define OFPG_ALL 0xffffffff + +/* Body of reply to OFPST_GROUP request. */ +struct ofp_group_stats { + uint16_t length; /* Length of this entry. */ + uint8_t pad[2]; /* Align to 64 bits. */ + uint32_t group_id; /* Group identifier. */ + uint32_t ref_count; /* Number of flows or groups that directly forward + to this group. */ + uint8_t pad2[4]; /* Align to 64 bits. */ + uint64_t packet_count; /* Number of packets processed by group. */ + uint64_t byte_count; /* Number of bytes processed by group. */ + struct ofp_bucket_counter bucket_stats[0]; +}; +OFP_ASSERT(sizeof(struct ofp_group_stats) == 32); + +/* Used in group stats replies. */ +struct ofp_bucket_counter { + uint64_t packet_count; /* Number of packets processed by bucket. */ + uint64_t byte_count; /* Number of bytes processed by bucket. */ +}; +OFP_ASSERT(sizeof(struct ofp_bucket_counter) == 16); + +/* Body of reply to OFPST_GROUP_DESC request. */ +struct ofp_group_desc_stats { + uint16_t length; /* Length of this entry. */ + uint8_t type; /* One of OFPGT_*. */ + uint8_t pad; /* Pad to 64 bits. */ + uint32_t group_id; /* Group identifier. */ + struct ofp_bucket buckets[0]; +}; +OFP_ASSERT(sizeof(struct ofp_group_desc_stats) == 16); + /* Vendor extension. */ struct ofp_vendor_header { struct ofp_header header; /* Type OFPT_VENDOR. */ @@ -967,43 +1151,36 @@ /* Query for port queue configuration. */ struct ofp_queue_get_config_request { struct ofp_header header; - uint16_t port; /* Port to be queried. Should refer + uint32_t port; /* Port to be queried. Should refer to a valid physical port (i.e. < OFPP_MAX) */ - uint8_t pad[2]; /* 32-bit alignment. */ }; OFP_ASSERT(sizeof(struct ofp_queue_get_config_request) == 12); /* Queue configuration for a given port. */ struct ofp_queue_get_config_reply { struct ofp_header header; - uint16_t port; - uint8_t pad[6]; + uint32_t port; + uint8_t pad[4]; struct ofp_packet_queue queues[0]; /* List of configured queues. */ }; OFP_ASSERT(sizeof(struct ofp_queue_get_config_reply) == 16); -/* OFPAT_ENQUEUE action struct: send packets to given queue on port. */ -struct ofp_action_enqueue { - uint16_t type; /* OFPAT_ENQUEUE. */ - uint16_t len; /* Len is 16. */ - uint16_t port; /* Port that queue belongs. Should - refer to a valid physical port - (i.e. < OFPP_MAX) or OFPP_IN_PORT. */ - uint8_t pad[6]; /* Pad for 64-bit alignment. */ - uint32_t queue_id; /* Where to enqueue the packets. */ +/* OFPAT_SET_QUEUE action struct: send packets to given queue on port. */ +struct ofp_action_set_queue { + uint16_t type; /* OFPAT_SET_QUEUE. */ + uint16_t len; /* Len is 8. */ + uint32_t queue_id; /* Queue id for the packets. */ }; -OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16); +OFP_ASSERT(sizeof(struct ofp_action_set_queue) == 8); struct ofp_queue_stats_request { - uint16_t port_no; /* All ports if OFPT_ALL. */ - uint8_t pad[2]; /* Align to 32-bits. */ + uint32_t port_no; /* All ports if OFPT_ALL. */ uint32_t queue_id; /* All queues if OFPQ_ALL. */ }; OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 8); struct ofp_queue_stats { - uint16_t port_no; - uint8_t pad[2]; /* Align to 32-bits. */ + uint32_t port_no; uint32_t queue_id; /* Queue i.d */ uint64_t tx_bytes; /* Number of transmitted bytes. */ uint64_t tx_packets; /* Number of transmitted packets. */