X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.h;h=422c14a7bc8fac10ae8d45013b3d7ad55317186b;hb=f0fd1a1772665ea57662281d9cccadb0f0146196;hp=dfd47be6d6dc7a2f06f7ecbc7301120dd2ecdb72;hpb=43d1478b1690ecd0ef6b63890bc13438c1914e47;p=sliver-openvswitch.git diff --git a/lib/ofp-util.h b/lib/ofp-util.h index dfd47be6d..422c14a7b 100644 --- a/lib/ofp-util.h +++ b/lib/ofp-util.h @@ -77,6 +77,8 @@ enum ofputil_msg_code { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFPUTIL_NXT_FLOW_MOD, OFPUTIL_NXT_FLOW_REMOVED, + OFPUTIL_NXT_SET_PACKET_IN_FORMAT, + OFPUTIL_NXT_PACKET_IN, /* NXST_* stat requests. */ OFPUTIL_NXST_FLOW_REQUEST, @@ -88,11 +90,18 @@ enum ofputil_msg_code { }; struct ofputil_msg_type; -int ofputil_decode_msg_type(const struct ofp_header *, - const struct ofputil_msg_type **); +enum ofperr ofputil_decode_msg_type(const struct ofp_header *, + const struct ofputil_msg_type **); +enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *, + size_t length, + const struct ofputil_msg_type **); enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *); const char *ofputil_msg_type_name(const struct ofputil_msg_type *); -int ofputil_check_output_port(uint16_t ofp_port, int max_ports); + +/* Port numbers. */ +enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports); +bool ofputil_port_from_string(const char *, uint16_t *port); +void ofputil_format_port(uint16_t port, struct ds *); /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to * and from IP bitmasks. */ @@ -118,13 +127,20 @@ enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *); struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format); +/* PACKET_IN. */ +bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format); +int ofputil_packet_in_format_from_string(const char *); +const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format); +struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format); + /* NXT_FLOW_MOD_TABLE_ID extension. */ struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id); /* Flow format independent flow_mod. */ -struct flow_mod { +struct ofputil_flow_mod { struct cls_rule cr; ovs_be64 cookie; + ovs_be64 cookie_mask; uint8_t table_id; uint16_t command; uint16_t idle_timeout; @@ -136,24 +152,27 @@ struct flow_mod { size_t n_actions; }; -int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *, - bool flow_mod_table_id); -struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *, +enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *, + const struct ofp_header *, + bool flow_mod_table_id); +struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *, enum nx_flow_format, bool flow_mod_table_id); /* Flow stats or aggregate stats request, independent of flow format. */ -struct flow_stats_request { +struct ofputil_flow_stats_request { bool aggregate; /* Aggregate results? */ struct cls_rule match; + ovs_be64 cookie; + ovs_be64 cookie_mask; uint16_t out_port; uint8_t table_id; }; -int ofputil_decode_flow_stats_request(struct flow_stats_request *, - const struct ofp_header *); +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 flow_stats_request *, enum nx_flow_format); + const struct ofputil_flow_stats_request *, enum nx_flow_format); /* Flow stats reply, independent of flow format. */ struct ofputil_flow_stats { @@ -198,23 +217,33 @@ struct ofputil_flow_removed { uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ }; -int ofputil_decode_flow_removed(struct ofputil_flow_removed *, - const struct ofp_header *); +enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *, + const struct ofp_header *); struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *, enum nx_flow_format); /* Abstract packet-in message. */ struct ofputil_packet_in { - struct ofpbuf *packet; - uint16_t in_port; - uint8_t reason; /* One of OFPR_*. */ + const void *packet; + size_t packet_len; + + enum ofp_packet_in_reason reason; /* One of OFPRR_*. */ + uint8_t table_id; + ovs_be64 cookie; uint32_t buffer_id; int send_len; + uint16_t total_len; /* Full length of frame. */ + + struct flow_metadata fmd; /* Metadata at creation time. */ }; +int ofputil_decode_packet_in(struct ofputil_packet_in *, + const struct ofp_header *); struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *, - struct ofpbuf *rw_packet); + enum nx_packet_in_format); +int ofputil_decode_packet_in(struct ofputil_packet_in *pi, + const struct ofp_header *oh); /* OpenFlow protocol utility functions. */ void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **); @@ -273,43 +302,90 @@ struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet, uint16_t in_port, uint16_t out_port); struct ofpbuf *make_echo_request(void); struct ofpbuf *make_echo_reply(const struct ofp_header *rq); + +const char *ofputil_frag_handling_to_string(enum ofp_config_flags); +bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); /* Actions. */ +/* The type of an action. + * + * For each implemented OFPAT_* and NXAST_* action type, there is a + * corresponding constant prefixed with OFPUTIL_, e.g.: + * + * OFPUTIL_OFPAT_OUTPUT + * OFPUTIL_OFPAT_SET_VLAN_VID + * OFPUTIL_OFPAT_SET_VLAN_PCP + * OFPUTIL_OFPAT_STRIP_VLAN + * OFPUTIL_OFPAT_SET_DL_SRC + * OFPUTIL_OFPAT_SET_DL_DST + * OFPUTIL_OFPAT_SET_NW_SRC + * OFPUTIL_OFPAT_SET_NW_DST + * OFPUTIL_OFPAT_SET_NW_TOS + * OFPUTIL_OFPAT_SET_TP_SRC + * OFPUTIL_OFPAT_SET_TP_DST + * OFPUTIL_OFPAT_ENQUEUE + * OFPUTIL_NXAST_RESUBMIT + * OFPUTIL_NXAST_SET_TUNNEL + * OFPUTIL_NXAST_SET_QUEUE + * OFPUTIL_NXAST_POP_QUEUE + * OFPUTIL_NXAST_REG_MOVE + * OFPUTIL_NXAST_REG_LOAD + * OFPUTIL_NXAST_NOTE + * OFPUTIL_NXAST_SET_TUNNEL64 + * OFPUTIL_NXAST_MULTIPATH + * OFPUTIL_NXAST_AUTOPATH + * OFPUTIL_NXAST_BUNDLE + * OFPUTIL_NXAST_BUNDLE_LOAD + * OFPUTIL_NXAST_RESUBMIT_TABLE + * OFPUTIL_NXAST_OUTPUT_REG + * + * (The above list helps developers who want to "grep" for these definitions.) + */ enum ofputil_action_code { - /* OFPAT_* actions. */ - OFPUTIL_OFPAT_OUTPUT, - OFPUTIL_OFPAT_SET_VLAN_VID, - OFPUTIL_OFPAT_SET_VLAN_PCP, - OFPUTIL_OFPAT_STRIP_VLAN, - OFPUTIL_OFPAT_SET_DL_SRC, - OFPUTIL_OFPAT_SET_DL_DST, - OFPUTIL_OFPAT_SET_NW_SRC, - OFPUTIL_OFPAT_SET_NW_DST, - OFPUTIL_OFPAT_SET_NW_TOS, - OFPUTIL_OFPAT_SET_TP_SRC, - OFPUTIL_OFPAT_SET_TP_DST, - OFPUTIL_OFPAT_ENQUEUE, - - /* NXAST_* actions. */ - OFPUTIL_NXAST_RESUBMIT, - OFPUTIL_NXAST_SET_TUNNEL, - OFPUTIL_NXAST_SET_QUEUE, - OFPUTIL_NXAST_POP_QUEUE, - OFPUTIL_NXAST_REG_MOVE, - OFPUTIL_NXAST_REG_LOAD, - OFPUTIL_NXAST_NOTE, - OFPUTIL_NXAST_SET_TUNNEL64, - OFPUTIL_NXAST_MULTIPATH, - OFPUTIL_NXAST_AUTOPATH, - OFPUTIL_NXAST_BUNDLE, - OFPUTIL_NXAST_BUNDLE_LOAD, +#define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM, +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM, +#include "ofp-util.def" +}; + +/* The number of values of "enum ofputil_action_code". */ +enum { +#define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1 +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1 + OFPUTIL_N_ACTIONS = 0 +#include "ofp-util.def" }; int ofputil_decode_action(const union ofp_action *); enum ofputil_action_code ofputil_decode_action_unsafe( const union ofp_action *); +int ofputil_action_code_from_name(const char *); + +void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf); + +/* For each OpenFlow action that has a corresponding action structure + * struct , this defines two functions: + * + * void ofputil_init_(struct *action); + * + * Initializes the parts of 'action' that identify it as having type + * and length 'sizeof *action' and zeros the rest. For actions that have + * variable length, the length used and cleared is that of struct . + * + * struct *ofputil_put_(struct ofpbuf *buf); + * + * Appends a new 'action', of length 'sizeof(struct )', to 'buf', + * initializes it with ofputil_init_(), and returns it. + */ +#define OFPAT_ACTION(ENUM, STRUCT, NAME) \ + void ofputil_init_##ENUM(struct STRUCT *); \ + struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *); +#define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ + void ofputil_init_##ENUM(struct STRUCT *); \ + struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *); +#include "ofp-util.def" + #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */ static inline union ofp_action * @@ -344,159 +420,18 @@ ofputil_action_is_valid(const union ofp_action *a, size_t n_actions) ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \ (ITER) = ofputil_action_next(ITER))) -int validate_actions(const union ofp_action *, size_t n_actions, - const struct flow *, int max_ports); +enum ofperr validate_actions(const union ofp_action *, size_t n_actions, + const struct flow *, int max_ports); bool action_outputs_to_port(const union ofp_action *, ovs_be16 port); -int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len, - union ofp_action **, size_t *); +enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len, + union ofp_action **, size_t *); bool ofputil_actions_equal(const union ofp_action *a, size_t n_a, const union ofp_action *b, size_t n_b); union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n); - -/* OpenFlow vendors. - * - * These functions map OpenFlow 32-bit vendor IDs (as used in struct - * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values - * are only used internally in Open vSwitch and never appear on the wire, so - * particular codes used are not important. - */ - -/* Vendor error numbers currently used in Open vSwitch. */ -#define OFPUTIL_VENDORS \ - /* vendor name vendor value */ \ - OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \ - OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID) - -/* OFPUTIL_VENDOR_* definitions. */ -enum ofputil_vendor_codes { -#define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME, - OFPUTIL_VENDORS - OFPUTIL_N_VENDORS -#undef OFPUTIL_VENDOR -}; - -/* Error codes. - * - * We embed system errno values and OpenFlow standard and vendor extension - * error codes into a single 31-bit space using the following encoding. - * (Bit 31 is unused and assumed 0 to avoid negative "int" values.) - * - * 30 0 - * +------------------------------------------------------+ - * | 0 | success - * +------------------------------------------------------+ - * - * 30 29 0 - * +--+---------------------------------------------------+ - * | 0| errno value | errno value - * +--+---------------------------------------------------+ - * - * 30 29 26 25 16 15 0 - * +--+-------+----------------+--------------------------+ - * | 1| 0 | type | code | standard OpenFlow - * +--+-------+----------------+--------------------------+ error - * - * 30 29 26 25 16 15 0 - * +--+-------+----------------+--------------------------+ Nicira - * | 1| vendor| type | code | NXET_VENDOR - * +--+-------+----------------+--------------------------+ error extension - * - * C and POSIX say that errno values are positive. We assume that they are - * less than 2**29. They are actually less than 65536 on at least Linux, - * FreeBSD, OpenBSD, and Windows. - * - * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above. - * It must be nonzero. - * - * Negative values are not defined. - */ - -/* Currently 4 bits are allocated to the "vendor" field. Make sure that all - * the vendor codes can fit. */ -BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16); - -/* These are macro versions of the functions defined below. The macro versions - * are intended for use in contexts where function calls are not allowed, - * e.g. static initializers and case labels. */ -#define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE)) -#define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \ - ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE)) -#define OFP_MKERR_NICIRA(TYPE, CODE) \ - OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE) - -/* Returns the standard OpenFlow error with the specified 'type' and 'code' as - * an integer. */ -static inline int -ofp_mkerr(uint16_t type, uint16_t code) -{ - return OFP_MKERR(type, code); -} - -/* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and - * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */ -static inline int -ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code) -{ - assert(vendor < OFPUTIL_N_VENDORS); - return OFP_MKERR_VENDOR(vendor, type, code); -} - -/* Returns the OpenFlow vendor error with Nicira as vendor, with the specific - * 'type' and 'code', as an integer. */ -static inline int -ofp_mkerr_nicira(uint16_t type, uint16_t code) -{ - return OFP_MKERR_NICIRA(type, code); -} - -/* Returns true if 'error' encodes an OpenFlow standard or vendor extension - * error codes as documented above. */ -static inline bool -is_ofp_error(int error) -{ - return (error & (1 << 30)) != 0; -} - -/* Returns true if 'error' appears to be a system errno value. */ -static inline bool -is_errno(int error) -{ - return !is_ofp_error(error); -} - -/* Returns the "vendor" part of the OpenFlow error code 'error' (which must be - * in the format explained above). This is normally one of the - * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a - * standard OpenFlow error. */ -static inline uint8_t -get_ofp_err_vendor(int error) -{ - return (error >> 26) & 0xf; -} - -/* Returns the "type" part of the OpenFlow error code 'error' (which must be in - * the format explained above). */ -static inline uint16_t -get_ofp_err_type(int error) -{ - return (error >> 16) & 0x3ff; -} - -/* Returns the "code" part of the OpenFlow error code 'error' (which must be in - * the format explained above). */ -static inline uint16_t -get_ofp_err_code(int error) -{ - return error & 0xffff; -} - -struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *); -int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs); -/* String versions of errors. */ -void ofputil_format_error(struct ds *, int error); -char *ofputil_error_to_string(int error); +/* Handy utility for parsing flows and actions. */ +bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep); #endif /* ofp-util.h */