X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenflow.h;h=1ad8227e4826dba3f391b0e53d82b695cd58c16a;hb=2c775287e298648ac695df4e66cffe99f1b497c1;hp=3525e166bf832377ba3c86a2210ad737a4c78bdc;hpb=e88c18152df9de5245df5ff7ca90bfeda5c2dd70;p=sliver-openvswitch.git diff --git a/include/openflow.h b/include/openflow.h index 3525e166b..1ad8227e4 100644 --- a/include/openflow.h +++ b/include/openflow.h @@ -42,7 +42,9 @@ #include #endif -#ifndef __cplusplus +#ifdef SWIG +#define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */ +#elif !defined(__cplusplus) /* Build-time assertion for use in a declaration context. */ #define OFP_ASSERT(EXPR) \ extern int (*build_assert(void))[ sizeof(struct { \ @@ -52,6 +54,12 @@ #define OFP_ASSERT BOOST_STATIC_ASSERT #endif /* __cplusplus */ +#ifndef SWIG +#define OFP_PACKED __attribute__((packed)) +#else +#define OFP_PACKED /* SWIG doesn't understand __attribute. */ +#endif + /* Maximum length of a OpenFlow packet. */ #define OFP_MAXLEN (sizeof(struct ofp_switch_features) \ + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200) @@ -60,7 +68,7 @@ /* The most significant bit being set in the version field indicates an * experimental OpenFlow version. */ -#define OFP_VERSION 0x85 +#define OFP_VERSION 0x89 #define OFP_MAX_TABLE_NAME_LEN 32 #define OFP_MAX_PORT_NAME_LEN 16 @@ -76,10 +84,13 @@ enum ofp_port { OFPP_MAX = 0x100, /* 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. - */ + 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. */ @@ -124,7 +135,13 @@ OFP_ASSERT(sizeof(struct ofp_header) == 8); enum ofp_config_flags { /* Tells datapath to notify the controller of expired flow entries. */ - OFPC_SEND_FLOW_EXP = 1 << 0 + OFPC_SEND_FLOW_EXP = 1 << 0, + + /* Handling of IP fragments. */ + OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */ + OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */ + OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */ + OFPC_FRAG_MASK = 3 << 1 }; /* Switch configuration. */ @@ -142,13 +159,17 @@ enum ofp_capabilities { OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */ OFPC_PORT_STATS = 1 << 2, /* Port statistics. */ OFPC_STP = 1 << 3, /* 802.11d spanning tree. */ - OFPC_MULTI_PHY_TX = 1 << 4 /* Supports transmitting through multiple + OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple physical interfaces */ + OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */ }; /* Flags to indicate behavior of the physical port */ enum ofp_port_flags { - OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding */ + OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding. */ + OFPPFL_PORT_DOWN = 1 << 1, /* Port is configured down. */ + OFPPFL_LINK_DOWN = 1 << 2, /* No physical link on interface. + NOTE: Non-settable field */ }; /* Features of physical ports available in a datapath. */ @@ -195,13 +216,13 @@ struct ofp_switch_features { uint8_t pad[4]; /* Align to 64-bits. */ /* Port info.*/ - struct ofp_phy_port ports[0]; /* Port definitions. The number of ports + struct ofp_phy_port ports[0]; /* Port definitions. The number of ports is inferred from the length field in the header. */ }; OFP_ASSERT(sizeof(struct ofp_switch_features) == 48); -/* What changed about the phsyical port */ +/* What changed about the physical port */ enum ofp_port_reason { OFPPR_ADD, /* The port was added */ OFPPR_DELETE, /* The port was removed */ @@ -220,12 +241,14 @@ OFP_ASSERT(sizeof(struct ofp_port_status) == 48); /* Modify behavior of the physical port */ struct ofp_port_mod { struct ofp_header header; + uint32_t mask; /* Bitmap of "ofp_port_flags" that should be + changed. */ struct ofp_phy_port desc; }; -OFP_ASSERT(sizeof(struct ofp_port_mod) == 44); +OFP_ASSERT(sizeof(struct ofp_port_mod) == 48); /* Why is this packet being sent to the controller? */ -enum ofp_reason { +enum ofp_packet_in_reason { OFPR_NO_MATCH, /* No matching flow. */ OFPR_ACTION /* Action explicitly output to controller. */ }; @@ -280,7 +303,7 @@ struct ofp_action { struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */ uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */ uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */ - uint32_t nw_addr __attribute__((packed)); /* OFPAT_SET_NW_SRC/DST */ + uint32_t nw_addr OFP_PACKED; /* OFPAT_SET_NW_SRC/DST */ uint16_t tp; /* OFPAT_SET_TP_SRC/DST */ } arg; }; @@ -289,13 +312,13 @@ OFP_ASSERT(sizeof(struct ofp_action) == 8); /* Send packet (controller -> datapath). */ 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). */ - uint16_t out_port; /* Output port (if buffer_id == -1). */ - union { - struct ofp_action actions[0]; /* buffer_id != -1 */ - uint8_t data[0]; /* buffer_id == -1 */ - } u; + uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */ + uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */ + uint16_t n_actions; /* Number of actions. */ + struct ofp_action 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); @@ -312,12 +335,27 @@ enum ofp_flow_wildcards { 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_NW_SRC = 1 << 5, /* IP source address. */ - OFPFW_NW_DST = 1 << 6, /* IP destination address. */ - OFPFW_NW_PROTO = 1 << 7, /* IP protocol. */ - OFPFW_TP_SRC = 1 << 8, /* TCP/UDP source port. */ - OFPFW_TP_DST = 1 << 9, /* TCP/UDP destination port. */ - OFPFW_ALL = (1 << 10) - 1 + 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, + + /* Wildcard all fields. */ + OFPFW_ALL = ((1 << 20) - 1) }; /* Values below this cutoff are 802.3 packets and the two bytes @@ -333,22 +371,23 @@ enum ofp_flow_wildcards { /* Fields to match against flows */ struct ofp_match { - uint16_t wildcards; /* Wildcard fields. */ + uint32_t wildcards; /* Wildcard fields. */ uint16_t in_port; /* Input switch port. */ uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */ uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */ uint16_t dl_vlan; /* Input VLAN. */ uint16_t dl_type; /* Ethernet frame type. */ + uint8_t nw_proto; /* IP protocol. */ + uint8_t pad; /* Align to 32-bits. */ uint32_t nw_src; /* IP source address. */ uint32_t nw_dst; /* IP destination address. */ - uint8_t nw_proto; /* IP protocol. */ - uint8_t pad[3]; /* Align to 32-bits. */ uint16_t tp_src; /* TCP/UDP source port. */ uint16_t tp_dst; /* TCP/UDP destination port. */ }; OFP_ASSERT(sizeof(struct ofp_match) == 36); -/* Value used in "max_idle" to indicate that the entry is permanent */ +/* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry + * is permanent. */ #define OFP_FLOW_PERMANENT 0 /* By default, choose a priority in the middle */ @@ -361,23 +400,30 @@ struct ofp_flow_mod { /* Flow actions. */ uint16_t command; /* One of OFPFC_*. */ - uint16_t max_idle; /* Idle time before discarding (seconds). */ - uint32_t buffer_id; /* Buffered packet to apply to (or -1). */ + 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. */ - uint8_t pad[2]; /* Align to 32-bits. */ + uint32_t buffer_id; /* Buffered packet to apply to (or -1). */ uint32_t reserved; /* Reserved for future use. */ struct ofp_action actions[0]; /* The number of actions is inferred from the length field in the header. */ }; OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60); +/* Why did this flow expire? */ +enum ofp_flow_expired_reason { + OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */ + OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */ +}; + /* Flow expiration (datapath -> controller). */ struct ofp_flow_expired { struct ofp_header header; struct ofp_match match; /* Description of fields */ uint16_t priority; /* Priority level of flow entry. */ - uint8_t pad[2]; /* Align to 32-bits. */ + uint8_t reason; /* One of OFPER_*. */ + uint8_t pad[1]; /* Align to 32-bits. */ uint32_t duration; /* Time flow was alive in seconds. */ uint8_t pad2[4]; /* Align to 64-bits. */ @@ -398,6 +444,11 @@ struct ofp_error_msg { OFP_ASSERT(sizeof(struct ofp_error_msg) == 12); enum ofp_stats_types { + /* Description of this OpenFlow switch. + * The request body is empty. + * The reply body is struct ofp_desc_stats. */ + OFPST_DESC, + /* Individual flow statistics. * The request body is struct ofp_flow_stats_request. * The reply body is an array of struct ofp_flow_stats. */ @@ -416,7 +467,15 @@ enum ofp_stats_types { /* Physical port statistics. * The request body is empty. * The reply body is an array of struct ofp_port_stats. */ - OFPST_PORT + OFPST_PORT, + + /* Switch status. + * The request body is an ASCII string that specifies a prefix of the key + * names to include in the output; if it is the null string, then all + * key-value pairs are included. + * The reply body is an ASCII string of key-value pairs in the form + * "key=value\n". */ + OFPST_SWITCH }; struct ofp_stats_request { @@ -439,6 +498,18 @@ struct ofp_stats_reply { }; OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12); +#define DESC_STR_LEN 256 +#define SERIAL_NUM_LEN 32 +/* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated + * ASCII string. */ +struct ofp_desc_stats { + char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */ + char hw_desc[DESC_STR_LEN]; /* Hardware description. */ + char sw_desc[DESC_STR_LEN]; /* Software description. */ + char serial_num[SERIAL_NUM_LEN]; /* Serial number. */ +}; +OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800); + /* Body for ofp_stats_request of type OFPST_FLOW. */ struct ofp_flow_stats_request { struct ofp_match match; /* Fields to match */ @@ -457,12 +528,14 @@ struct ofp_flow_stats { uint32_t duration; /* Time flow has been alive in seconds. */ uint16_t priority; /* Priority of the entry. Only meaningful when this is not an exact-match entry. */ - uint16_t max_idle; /* Number of seconds idle before expiration. */ + uint16_t idle_timeout; /* Number of seconds idle before expiration. */ + uint16_t hard_timeout; /* Number of seconds before expiration. */ + uint16_t pad2[3]; /* Pad to 64 bits. */ uint64_t packet_count; /* Number of packets in flow. */ uint64_t byte_count; /* Number of bytes in flow. */ struct ofp_action actions[0]; /* Actions. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_stats) == 64); +OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72); /* Body for ofp_stats_request of type OFPST_AGGREGATE. */ struct ofp_aggregate_stats_request { @@ -494,14 +567,27 @@ struct ofp_table_stats { }; OFP_ASSERT(sizeof(struct ofp_table_stats) == 56); -/* Statistics about a particular port */ +/* 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 */ - uint64_t rx_count; /* Number of received packets */ - uint64_t tx_count; /* Number of transmitted packets */ - uint64_t drop_count; /* Number of packets dropped by interface */ -}; -OFP_ASSERT(sizeof(struct ofp_port_stats) == 32); + uint8_t pad[6]; /* 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. */ + uint64_t tx_bytes; /* Number of transmitted bytes. */ + uint64_t rx_dropped; /* Number of packets dropped by RX. */ + uint64_t tx_dropped; /* Number of packets dropped by TX. */ + uint64_t rx_errors; /* Number of receive errors. This is a super-set + of receive errors and should be great than or + equal to the sum of al rx_*_err values. */ + uint64_t tx_errors; /* Number of transmit errors. This is a super-set + of transmit errors. */ + uint64_t rx_frame_err; /* Number of frame alignment errors. */ + uint64_t rx_over_err; /* Number of packets with RX overrun. */ + uint64_t rx_crc_err; /* Number of CRC errors. */ + uint64_t collisions; /* Number of collisions. */ +}; +OFP_ASSERT(sizeof(struct ofp_port_stats) == 104); #endif /* openflow.h */