X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.h;h=f9b0be7ceebe5320657fc20bf6da9a9326e7b314;hb=e3f8f887480856064fab42bc01ae364d64506d85;hp=39c81be5a63d245989c6650bbf295c20d74dd5c5;hpb=0445637d8a3ac8c5a5ccf4958b7e8e282f297e98;p=sliver-openvswitch.git diff --git a/lib/ofp-util.h b/lib/ofp-util.h index 39c81be5a..f9b0be7ce 100644 --- a/lib/ofp-util.h +++ b/lib/ofp-util.h @@ -30,6 +30,8 @@ #include "type-props.h" struct ofpbuf; +union ofp_action; +struct ofpact_set_field; /* Port numbers. */ enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, @@ -43,6 +45,14 @@ void ofputil_format_port(ofp_port_t port, struct ds *); void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize); +/* Group numbers. */ +enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) }; +bool ofputil_group_from_string(const char *, uint32_t *group_id); +void ofputil_format_group(uint32_t group_id, struct ds *); +void ofputil_group_to_string(uint32_t group_id, + char namebuf[MAX_GROUP_NAME_LEN + 1], + size_t bufsize); + /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts * to and from IP bitmasks. */ ovs_be32 ofputil_wcbits_to_netmask(int wcbits); @@ -80,6 +90,16 @@ enum ofputil_protocol { OFPUTIL_P_OF10_NXM_TID = 1 << 3, #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID) #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID) +#define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY) + + /* OpenFlow 1.1 protocol. + * + * We only support the standard OpenFlow 1.1 flow format. + * + * OpenFlow 1.1 always operates with an equivalent of the + * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID" + * variant. */ + OFPUTIL_P_OF11_STD = 1 << 4, /* OpenFlow 1.2+ protocols (only one variant each). * @@ -88,16 +108,28 @@ enum ofputil_protocol { * OpenFlow 1.2+ always operates with an equivalent of the * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID" * variant. */ - OFPUTIL_P_OF12_OXM = 1 << 4, - OFPUTIL_P_OF13_OXM = 1 << 5, + OFPUTIL_P_OF12_OXM = 1 << 5, + OFPUTIL_P_OF13_OXM = 1 << 6, #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_OXM) +#define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \ + OFPUTIL_P_ANY_OXM) + +#define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM) + +#define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM) + +#define OFPUTIL_P_OF12_UP (OFPUTIL_P_ANY_OXM) + +#define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM) + /* All protocols. */ -#define OFPUTIL_P_ANY ((1 << 6) - 1) +#define OFPUTIL_P_ANY ((1 << 7) - 1) /* Protocols in which a specific table may be specified in flow_mods. */ #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \ OFPUTIL_P_OF10_NXM_TID | \ + OFPUTIL_P_OF11_STD | \ OFPUTIL_P_ANY_OXM) }; @@ -119,7 +151,6 @@ enum ofputil_protocol ofputil_protocol_set_base( const char *ofputil_protocol_to_string(enum ofputil_protocol); char *ofputil_protocols_to_string(enum ofputil_protocol); enum ofputil_protocol ofputil_protocols_from_string(const char *); -enum ofputil_protocol ofputil_usable_protocols(const struct match *); void ofputil_format_version(struct ds *, enum ofp_version); void ofputil_format_version_name(struct ds *, enum ofp_version); @@ -178,7 +209,10 @@ enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *, uint16_t *padded_match_len); enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *, struct match *); +int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *, + enum ofputil_protocol); void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *); +int ofputil_match_typical_len(enum ofputil_protocol); /* dl_type translation between OpenFlow and 'struct flow' format. */ ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type); @@ -194,37 +228,67 @@ struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version, /* NXT_FLOW_MOD_TABLE_ID extension. */ struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id); +/* Protocol-independent flow_mod flags. */ +enum ofputil_flow_mod_flags { + /* Flags that are maintained with a flow as part of its state. + * + * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */ + OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */ + OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */ + OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */ +#define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \ + | OFPUTIL_FF_NO_PKT_COUNTS \ + | OFPUTIL_FF_NO_BYT_COUNTS) + + /* Flags that affect flow_mod behavior but are not part of flow state. */ + OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */ + OFPUTIL_FF_EMERG = 1 << 4, /* OpenFlow 1.0 only. */ + OFPUTIL_FF_RESET_COUNTS = 1 << 5, /* OpenFlow 1.2+. */ +}; + /* Protocol-independent flow_mod. * * The handling of cookies across multiple versions of OpenFlow is a bit - * confusing. A full description of Open vSwitch's cookie handling is - * in the DESIGN file. The following table shows the expected values of - * the cookie-related fields for the different flow_mod commands in - * OpenFlow 1.0 ("OF10") and NXM. "" and "-" indicate a value - * that may be populated and an ignored field, respectively. - * - * cookie cookie_mask new_cookie - * ====== =========== ========== - * OF10 Add - 0 - * OF10 Modify - 0 - * OF10 Delete - 0 - - * NXM Add - 0 - * NXM Modify - * NXM Delete - - */ + * confusing. See DESIGN for the details. */ struct ofputil_flow_mod { + struct list list_node; /* For queuing flow_mods. */ + struct match match; unsigned int priority; + + /* Cookie matching. The flow_mod affects only flows that have cookies that + * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits. + * + * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */ ovs_be64 cookie; /* Cookie bits to match. */ ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */ - ovs_be64 new_cookie; /* New cookie to install or -1. */ + + /* Cookie changes. + * + * OFPFC_ADD uses 'new_cookie' as the new flow's cookie. 'new_cookie' + * should not be UINT64_MAX. + * + * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases: + * + * - If one or more matching flows exist and 'modify_cookie' is true, + * then the flow_mod changes the existing flows' cookies to + * 'new_cookie'. 'new_cookie' should not be UINT64_MAX. + * + * - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and + * 'cookie_mask' is 0, then the flow_mod adds a new flow with + * 'new_cookie' as its cookie. + */ + ovs_be64 new_cookie; /* New cookie to install or UINT64_MAX. */ + bool modify_cookie; /* Set cookie of existing flow to 'new_cookie'? */ + uint8_t table_id; uint16_t command; uint16_t idle_timeout; uint16_t hard_timeout; uint32_t buffer_id; ofp_port_t out_port; - uint16_t flags; + uint32_t out_group; + enum ofputil_flow_mod_flags flags; struct ofpact *ofpacts; /* Series of "struct ofpact"s. */ size_t ofpacts_len; /* Length of ofpacts, in bytes. */ }; @@ -236,9 +300,6 @@ enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *, struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *, enum ofputil_protocol); -enum ofputil_protocol ofputil_flow_mod_usable_protocols( - const struct ofputil_flow_mod *fms, size_t n_fms); - /* Flow stats or aggregate stats request, independent of protocol. */ struct ofputil_flow_stats_request { bool aggregate; /* Aggregate results? */ @@ -246,6 +307,7 @@ struct ofputil_flow_stats_request { ovs_be64 cookie; ovs_be64 cookie_mask; ofp_port_t out_port; + uint32_t out_group; uint8_t table_id; }; @@ -253,8 +315,6 @@ enum ofperr ofputil_decode_flow_stats_request( struct ofputil_flow_stats_request *, const struct ofp_header *); struct ofpbuf *ofputil_encode_flow_stats_request( const struct ofputil_flow_stats_request *, enum ofputil_protocol); -enum ofputil_protocol ofputil_flow_stats_request_usable_protocols( - const struct ofputil_flow_stats_request *); /* Flow stats reply, independent of protocol. */ struct ofputil_flow_stats { @@ -272,7 +332,7 @@ struct ofputil_flow_stats { uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ struct ofpact *ofpacts; size_t ofpacts_len; - uint16_t flags; /* Added for OF 1.3 */ + enum ofputil_flow_mod_flags flags; }; int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *, @@ -318,19 +378,33 @@ struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *, /* Abstract packet-in message. */ struct ofputil_packet_in { + /* Packet data and metadata. + * + * To save bandwidth, in some cases a switch may send only the first + * several bytes of a packet, indicated by 'packet_len < total_len'. When + * the full packet is included, 'packet_len == total_len'. */ const void *packet; - size_t packet_len; - - enum ofp_packet_in_reason reason; /* One of OFPR_*. */ - uint16_t controller_id; /* Controller ID to send to. */ - uint8_t table_id; - ovs_be64 cookie; + size_t packet_len; /* Number of bytes in 'packet'. */ + size_t total_len; /* Size of packet, pre-truncation. */ + struct flow_metadata fmd; + /* Identifies a buffer in the switch that contains the full packet, to + * allow the controller to reference it later without having to send the + * entire packet back to the switch. + * + * UINT32_MAX indicates that the packet is not buffered in the switch. A + * switch should only use UINT32_MAX when it sends the entire packet. */ uint32_t buffer_id; - int send_len; - uint16_t total_len; /* Full length of frame. */ - struct flow_metadata fmd; /* Metadata at creation time. */ + /* Reason that the packet-in is being sent. */ + enum ofp_packet_in_reason reason; /* One of OFPR_*. */ + + /* Information about the OpenFlow flow that triggered the packet-in. + * + * A packet-in triggered by a flow table miss has no associated flow. In + * that case, 'cookie' is UINT64_MAX. */ + uint8_t table_id; /* OpenFlow table ID. */ + ovs_be64 cookie; /* Flow's cookie. */ }; enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *, @@ -514,6 +588,17 @@ enum ofperr ofputil_decode_port_mod(const struct ofp_header *, struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *, enum ofputil_protocol); +/* Abstract ofp_table_mod. */ +struct ofputil_table_mod { + uint8_t table_id; /* ID of the table, 0xff indicates all tables. */ + uint32_t config; +}; + +enum ofperr ofputil_decode_table_mod(const struct ofp_header *, + struct ofputil_table_mod *); +struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *, + enum ofputil_protocol); + /* Meter band configuration for all supported band types. */ struct ofputil_meter_band { uint16_t type; @@ -608,11 +693,23 @@ struct ofputil_role_request { uint64_t generation_id; }; +struct ofputil_role_status { + enum ofp12_controller_role role; + enum ofp14_controller_role_reason reason; + uint64_t generation_id; +}; + enum ofperr ofputil_decode_role_message(const struct ofp_header *, struct ofputil_role_request *); struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *, const struct ofputil_role_request *); +struct ofpbuf *ofputil_encode_role_status( + const struct ofputil_role_status *status, + enum ofputil_protocol protocol); + +enum ofperr ofputil_decode_role_status(const struct ofp_header *oh, + struct ofputil_role_status *rs); /* Abstract table stats. * * For now we use ofp12_table_stats as a superset of the other protocol @@ -622,6 +719,34 @@ struct ofpbuf *ofputil_encode_table_stats_reply( const struct ofp12_table_stats[], int n, const struct ofp_header *request); +/* Queue configuration request. */ +struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version, + ofp_port_t port); +enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *, + ofp_port_t *port); + +/* Queue configuration reply. */ +struct ofputil_queue_config { + uint32_t queue_id; + + /* Each of these optional values is expressed in tenths of a percent. + * Values greater than 1000 indicate that the feature is disabled. + * UINT16_MAX indicates that the value is omitted. */ + uint16_t min_rate; + uint16_t max_rate; +}; + +struct ofpbuf *ofputil_encode_queue_get_config_reply( + const struct ofp_header *request); +void ofputil_append_queue_get_config_reply( + struct ofpbuf *reply, const struct ofputil_queue_config *); + +enum ofperr ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, + ofp_port_t *); +int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply, + struct ofputil_queue_config *); + + /* Abstract nx_flow_monitor_request. */ struct ofputil_flow_monitor_request { uint32_t id; @@ -737,6 +862,7 @@ enum { }; int ofputil_action_code_from_name(const char *); +const char * ofputil_action_name_from_code(enum ofputil_action_code code); void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf); @@ -810,7 +936,15 @@ ofputil_encode_queue_stats_request(enum ofp_version ofp_version, struct ofputil_queue_stats { ofp_port_t port_no; uint32_t queue_id; - struct netdev_queue_stats stats; + + /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */ + uint64_t tx_bytes; + uint64_t tx_packets; + uint64_t tx_errors; + + /* UINT32_MAX if unknown. */ + uint32_t duration_sec; + uint32_t duration_nsec; }; size_t ofputil_count_queue_stats(const struct ofp_header *); @@ -818,4 +952,88 @@ int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *ms void ofputil_append_queue_stat(struct list *replies, const struct ofputil_queue_stats *oqs); +/* Bucket for use in groups. */ +struct ofputil_bucket { + struct list list_node; + uint16_t weight; /* Relative weight, for "select" groups. */ + ofp_port_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 ofpact *ofpacts; /* Series of "struct ofpact"s. */ + size_t ofpacts_len; /* Length of ofpacts, in bytes. */ +}; + +/* Protocol-independent group_mod. */ +struct ofputil_group_mod { + uint16_t command; /* One of OFPGC11_*. */ + uint8_t type; /* One of OFPGT11_*. */ + uint32_t group_id; /* Group identifier. */ + struct list buckets; /* Contains "struct ofputil_bucket"s. */ +}; + +struct bucket_counter { + uint64_t packet_count; /* Number of packets processed by bucket. */ + uint64_t byte_count; /* Number of bytes processed by bucket. */ +}; + +/* Group stats reply, independent of protocol. */ +struct ofputil_group_stats { + uint32_t group_id; /* Group identifier. */ + uint32_t ref_count; + uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ + uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ + uint32_t duration_sec; /* UINT32_MAX if unknown. */ + uint32_t duration_nsec; + uint32_t n_buckets; + struct bucket_counter *bucket_stats; +}; + +/* Group features reply, independent of protocol. */ +struct ofputil_group_features { + uint32_t types; /* Bitmap of OFPGT_* values supported. */ + uint32_t capabilities; /* Bitmap of OFPGFC12_* capability supported. */ + uint32_t max_groups[4]; /* Maximum number of groups for each type. */ + uint32_t actions[4]; /* Bitmaps of OFPAT_* that are supported. */ +}; + +/* Group desc reply, independent of protocol. */ +struct ofputil_group_desc { + uint8_t type; /* One of OFPGT_*. */ + uint32_t group_id; /* Group identifier. */ + struct list buckets; /* Contains "struct ofputil_bucket"s. */ +}; + +void ofputil_bucket_list_destroy(struct list *buckets); + +struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version, + uint32_t group_id); +enum ofperr ofputil_decode_group_stats_request( + const struct ofp_header *request, uint32_t *group_id); +void ofputil_append_group_stats(struct list *replies, + const struct ofputil_group_stats *); +struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version); +struct ofpbuf *ofputil_encode_group_features_reply( + const struct ofputil_group_features *, const struct ofp_header *request); +void ofputil_decode_group_features_reply(const struct ofp_header *, + struct ofputil_group_features *); +struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version, + const struct ofputil_group_mod *gm); + +enum ofperr ofputil_decode_group_mod(const struct ofp_header *, + struct ofputil_group_mod *); + +int ofputil_decode_group_stats_reply(struct ofpbuf *, + struct ofputil_group_stats *); + +int ofputil_decode_group_desc_reply(struct ofputil_group_desc *, + struct ofpbuf *, enum ofp_version); + +void ofputil_append_group_desc_reply(const struct ofputil_group_desc *, + struct list *buckets, + struct list *replies); +struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version); + #endif /* ofp-util.h */