X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.h;h=bf2ae07ba7639fb29d50413ecae19b07d3f51244;hb=e0edde6fee279cdbbf3c179f5f50adaf0c7c7f1e;hp=13195c76c2b0b2a37a5aa5105fe32dfbb0a5d896;hpb=548349603423bea41ec2989583231c1a117f6a9e;p=sliver-openvswitch.git diff --git a/lib/ofp-util.h b/lib/ofp-util.h index 13195c76c..bf2ae07ba 100644 --- a/lib/ofp-util.h +++ b/lib/ofp-util.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,6 +23,7 @@ #include #include "classifier.h" #include "flow.h" +#include "netdev.h" #include "openflow/nicira-ext.h" #include "openvswitch/types.h" @@ -79,6 +80,9 @@ enum ofputil_msg_code { OFPUTIL_NXT_FLOW_REMOVED, OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFPUTIL_NXT_PACKET_IN, + OFPUTIL_NXT_FLOW_AGE, + OFPUTIL_NXT_SET_ASYNC_CONFIG, + OFPUTIL_NXT_SET_CONTROLLER_ID, /* NXST_* stat requests. */ OFPUTIL_NXST_FLOW_REQUEST, @@ -90,15 +94,19 @@ enum ofputil_msg_code { }; struct ofputil_msg_type; -int ofputil_decode_msg_type(const struct ofp_header *, - const struct ofputil_msg_type **); -int ofputil_decode_msg_type_partial(const struct ofp_header *, size_t length, +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 *); /* Port numbers. */ -int ofputil_check_output_port(uint16_t ofp_port, int max_ports); +enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port); +ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port); + +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 *); @@ -107,25 +115,77 @@ void ofputil_format_port(uint16_t port, struct ds *); ovs_be32 ofputil_wcbits_to_netmask(int wcbits); int ofputil_netmask_to_wcbits(ovs_be32 netmask); +/* Protocols. + * + * These are arranged from most portable to least portable, or alternatively + * from least powerful to most powerful. Formats earlier on the list are more + * likely to be understood for the purpose of making requests, but formats + * later on the list are more likely to accurately describe a flow within a + * switch. + * + * On any given OpenFlow connection, a single protocol is in effect at any + * given time. These values use separate bits only because that makes it easy + * to test whether a particular protocol is within a given set of protocols and + * to implement set union and intersection. + */ +enum ofputil_protocol { + /* OpenFlow 1.0-based protocols. */ + OFPUTIL_P_OF10 = 1 << 0, /* OpenFlow 1.0 flow format. */ + OFPUTIL_P_OF10_TID = 1 << 1, /* OF1.0 + flow_mod_table_id extension. */ +#define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10 | OFPUTIL_P_OF10_TID) + + /* OpenFlow 1.0 with NXM-based flow formats. */ + OFPUTIL_P_NXM = 1 << 2, /* Nicira extended match. */ + OFPUTIL_P_NXM_TID = 1 << 3, /* NXM + flow_mod_table_id extension. */ +#define OFPUTIL_P_NXM_ANY (OFPUTIL_P_NXM | OFPUTIL_P_NXM_TID) + + /* All protocols. */ +#define OFPUTIL_P_ANY (OFPUTIL_P_OF10_ANY | OFPUTIL_P_NXM_ANY) + + /* Protocols in which a specific table may be specified in flow_mods. */ +#define OFPUTIL_P_TID (OFPUTIL_P_OF10_TID | OFPUTIL_P_NXM_TID) +}; + +/* Protocols to use for flow dumps, from most to least preferred. */ +extern enum ofputil_protocol ofputil_flow_dump_protocols[]; +extern size_t ofputil_n_flow_dump_protocols; + +enum ofputil_protocol ofputil_protocol_from_ofp_version(int version); +uint8_t ofputil_protocol_to_ofp_version(enum ofputil_protocol); + +bool ofputil_protocol_is_valid(enum ofputil_protocol); +enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol, + bool enable); +enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol); +enum ofputil_protocol ofputil_protocol_set_base( + enum ofputil_protocol cur, enum ofputil_protocol new_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 cls_rule *); + +struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current, + enum ofputil_protocol want, + enum ofputil_protocol *next); + +/* nx_flow_format */ +struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format); +enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format); +bool ofputil_nx_flow_format_is_valid(enum nx_flow_format); +const char *ofputil_nx_flow_format_to_string(enum nx_flow_format); + /* Work with OpenFlow 1.0 ofp_match. */ void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *); void ofputil_cls_rule_from_match(const struct ofp_match *, unsigned int priority, struct cls_rule *); -void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format); +void ofputil_normalize_rule(struct cls_rule *); void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *); /* dl_type translation between OpenFlow and 'struct flow' format. */ ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type); ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type); -/* Flow formats. */ -bool ofputil_flow_format_is_valid(enum nx_flow_format); -const char *ofputil_flow_format_to_string(enum nx_flow_format); -int ofputil_flow_format_from_string(const char *); -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 *); @@ -135,7 +195,7 @@ 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. */ +/* Protocol-independent flow_mod. */ struct ofputil_flow_mod { struct cls_rule cr; ovs_be64 cookie; @@ -151,13 +211,16 @@ struct ofputil_flow_mod { size_t n_actions; }; -int ofputil_decode_flow_mod(struct ofputil_flow_mod *, - const struct ofp_header *, bool flow_mod_table_id); +enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *, + const struct ofp_header *, + enum ofputil_protocol); struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *, - enum nx_flow_format, - bool flow_mod_table_id); + 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 flow format. */ +/* Flow stats or aggregate stats request, independent of protocol. */ struct ofputil_flow_stats_request { bool aggregate; /* Aggregate results? */ struct cls_rule match; @@ -167,12 +230,14 @@ struct ofputil_flow_stats_request { uint8_t table_id; }; -int ofputil_decode_flow_stats_request(struct ofputil_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 ofputil_flow_stats_request *, enum nx_flow_format); + 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 flow format. */ +/* Flow stats reply, independent of protocol. */ struct ofputil_flow_stats { struct cls_rule rule; ovs_be64 cookie; @@ -181,6 +246,8 @@ struct ofputil_flow_stats { uint32_t duration_nsec; uint16_t idle_timeout; uint16_t hard_timeout; + int idle_age; /* Seconds since last packet, -1 if unknown. */ + int hard_age; /* Seconds since last change, -1 if unknown. */ uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ union ofp_action *actions; @@ -188,11 +255,12 @@ struct ofputil_flow_stats { }; int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *, - struct ofpbuf *msg); + struct ofpbuf *msg, + bool flow_age_extension); void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *, struct list *replies); -/* Aggregate stats reply, independent of flow format. */ +/* Aggregate stats reply, independent of protocol. */ struct ofputil_aggregate_stats { uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */ uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */ @@ -203,7 +271,7 @@ struct ofpbuf *ofputil_encode_aggregate_stats_reply( const struct ofputil_aggregate_stats *stats, const struct ofp_stats_msg *request); -/* Flow removed message, independent of flow format. */ +/* Flow removed message, independent of protocol. */ struct ofputil_flow_removed { struct cls_rule rule; ovs_be64 cookie; @@ -215,17 +283,18 @@ 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); + enum ofputil_protocol); /* Abstract packet-in message. */ struct ofputil_packet_in { const void *packet; size_t packet_len; - uint8_t reason; /* One of OFPR_*. */ + 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; @@ -240,8 +309,163 @@ int ofputil_decode_packet_in(struct ofputil_packet_in *, const struct ofp_header *); struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *, enum nx_packet_in_format); -int ofputil_decode_packet_in(struct ofputil_packet_in *pi, - const struct ofp_header *oh); + +const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason); +bool ofputil_packet_in_reason_from_string(const char *, + enum ofp_packet_in_reason *); + +/* Abstract packet-out message. */ +struct ofputil_packet_out { + const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */ + size_t packet_len; /* Length of packet data in bytes. */ + uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */ + uint16_t in_port; /* Packet's input port or OFPP_NONE. */ + union ofp_action *actions; /* Actions. */ + size_t n_actions; /* Number of elements in 'actions' array. */ +}; + +enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *, + const struct ofp_packet_out *); +struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *); + +enum ofputil_port_config { + /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */ + OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */ + OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */ + OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */ + OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */ + /* OpenFlow 1.0 only. */ + OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */ + OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */ + OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */ + /* There are no OpenFlow 1.1-only bits. */ +}; + +enum ofputil_port_state { + /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */ + OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */ + /* OpenFlow 1.1 only. */ + OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */ + OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */ + /* OpenFlow 1.0 only. */ + OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */ + OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */ + OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */ + OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */ + OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */ +}; + +/* Abstract ofp10_phy_port or ofp11_port. */ +struct ofputil_phy_port { + uint16_t port_no; + uint8_t hw_addr[OFP_ETH_ALEN]; + char name[OFP_MAX_PORT_NAME_LEN]; + enum ofputil_port_config config; + enum ofputil_port_state state; + + /* NETDEV_F_* feature bitmasks. */ + enum netdev_features curr; /* Current features. */ + enum netdev_features advertised; /* Features advertised by the port. */ + enum netdev_features supported; /* Features supported by the port. */ + enum netdev_features peer; /* Features advertised by peer. */ + + /* Speed. */ + uint32_t curr_speed; /* Current speed, in kbps. */ + uint32_t max_speed; /* Maximum supported speed, in kbps. */ +}; + +enum ofputil_capabilities { + /* OpenFlow 1.0 and 1.1 share these values for these capabilities. */ + OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */ + OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */ + OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */ + OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */ + OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */ + OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */ + + /* OpenFlow 1.0 only. */ + OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */ + + /* OpenFlow 1.1 only. */ + OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */ +}; + +enum ofputil_action_bitmap { + OFPUTIL_A_OUTPUT = 1 << 0, + OFPUTIL_A_SET_VLAN_VID = 1 << 1, + OFPUTIL_A_SET_VLAN_PCP = 1 << 2, + OFPUTIL_A_STRIP_VLAN = 1 << 3, + OFPUTIL_A_SET_DL_SRC = 1 << 4, + OFPUTIL_A_SET_DL_DST = 1 << 5, + OFPUTIL_A_SET_NW_SRC = 1 << 6, + OFPUTIL_A_SET_NW_DST = 1 << 7, + OFPUTIL_A_SET_NW_ECN = 1 << 8, + OFPUTIL_A_SET_NW_TOS = 1 << 9, + OFPUTIL_A_SET_TP_SRC = 1 << 10, + OFPUTIL_A_SET_TP_DST = 1 << 11, + OFPUTIL_A_ENQUEUE = 1 << 12, + OFPUTIL_A_COPY_TTL_OUT = 1 << 13, + OFPUTIL_A_COPY_TTL_IN = 1 << 14, + OFPUTIL_A_SET_MPLS_LABEL = 1 << 15, + OFPUTIL_A_SET_MPLS_TC = 1 << 16, + OFPUTIL_A_SET_MPLS_TTL = 1 << 17, + OFPUTIL_A_DEC_MPLS_TTL = 1 << 18, + OFPUTIL_A_PUSH_VLAN = 1 << 19, + OFPUTIL_A_POP_VLAN = 1 << 20, + OFPUTIL_A_PUSH_MPLS = 1 << 21, + OFPUTIL_A_POP_MPLS = 1 << 22, + OFPUTIL_A_SET_QUEUE = 1 << 23, + OFPUTIL_A_GROUP = 1 << 24, + OFPUTIL_A_SET_NW_TTL = 1 << 25, + OFPUTIL_A_DEC_NW_TTL = 1 << 26, +}; + +/* Abstract ofp_switch_features. */ +struct ofputil_switch_features { + uint64_t datapath_id; /* Datapath unique ID. */ + uint32_t n_buffers; /* Max packets buffered at once. */ + uint8_t n_tables; /* Number of tables supported by datapath. */ + enum ofputil_capabilities capabilities; + enum ofputil_action_bitmap actions; +}; + +enum ofperr ofputil_decode_switch_features(const struct ofp_switch_features *, + struct ofputil_switch_features *, + struct ofpbuf *); +int ofputil_pull_switch_features_port(struct ofpbuf *, + struct ofputil_phy_port *); +size_t ofputil_count_phy_ports(const struct ofp_switch_features *); + +struct ofpbuf *ofputil_encode_switch_features( + const struct ofputil_switch_features *, enum ofputil_protocol, + ovs_be32 xid); +void ofputil_put_switch_features_port(const struct ofputil_phy_port *, + struct ofpbuf *); + +/* Abstract ofp_port_status. */ +struct ofputil_port_status { + enum ofp_port_reason reason; + struct ofputil_phy_port desc; +}; + +enum ofperr ofputil_decode_port_status(const struct ofp_port_status *, + struct ofputil_port_status *); +struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *, + enum ofputil_protocol); + +/* Abstract ofp_port_mod. */ +struct ofputil_port_mod { + uint16_t port_no; + uint8_t hw_addr[OFP_ETH_ALEN]; + enum ofputil_port_config config; + enum ofputil_port_config mask; + enum netdev_features advertise; +}; + +enum ofperr ofputil_decode_port_mod(const struct ofp_header *, + struct ofputil_port_mod *); +struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *, + enum ofputil_protocol); /* OpenFlow protocol utility functions. */ void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **); @@ -290,17 +514,11 @@ struct ofpbuf *make_add_simple_flow(const struct cls_rule *, struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason, const struct ofpbuf *payload, int max_send_len); -struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id, - uint16_t in_port, - const struct ofp_action_header *, - size_t n_actions); -struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id, - uint16_t in_port, uint16_t out_port); -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); +struct ofpbuf *ofputil_encode_barrier_request(void); + const char *ofputil_frag_handling_to_string(enum ofp_config_flags); bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); @@ -308,21 +526,21 @@ bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); /* The type of an action. * - * For each implemented OFPAT_* and NXAST_* action type, there is a + * For each implemented OFPAT10_* 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_OFPAT10_OUTPUT + * OFPUTIL_OFPAT10_SET_VLAN_VID + * OFPUTIL_OFPAT10_SET_VLAN_PCP + * OFPUTIL_OFPAT10_STRIP_VLAN + * OFPUTIL_OFPAT10_SET_DL_SRC + * OFPUTIL_OFPAT10_SET_DL_DST + * OFPUTIL_OFPAT10_SET_NW_SRC + * OFPUTIL_OFPAT10_SET_NW_DST + * OFPUTIL_OFPAT10_SET_NW_TOS + * OFPUTIL_OFPAT10_SET_TP_SRC + * OFPUTIL_OFPAT10_SET_TP_DST + * OFPUTIL_OFPAT10_ENQUEUE * OFPUTIL_NXAST_RESUBMIT * OFPUTIL_NXAST_SET_TUNNEL * OFPUTIL_NXAST_SET_QUEUE @@ -337,18 +555,21 @@ bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); * OFPUTIL_NXAST_BUNDLE_LOAD * OFPUTIL_NXAST_RESUBMIT_TABLE * OFPUTIL_NXAST_OUTPUT_REG + * OFPUTIL_NXAST_LEARN + * OFPUTIL_NXAST_DEC_TTL + * OFPUTIL_NXAST_FIN_TIMEOUT * * (The above list helps developers who want to "grep" for these definitions.) */ enum ofputil_action_code { -#define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM, +#define OFPAT10_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 OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1 OFPUTIL_N_ACTIONS = 0 #include "ofp-util.def" @@ -376,7 +597,7 @@ void *ofputil_put_action(enum ofputil_action_code, 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) \ +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ void ofputil_init_##ENUM(struct STRUCT *); \ struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *); #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \ @@ -418,160 +639,16 @@ 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);