+
+/* 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(enum ofp_version);
+enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
+enum ofp_version 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 match *);
+
+void ofputil_format_version(struct ds *, enum ofp_version);
+void ofputil_format_version_name(struct ds *, enum ofp_version);
+
+/* A bitmap of version numbers
+ *
+ * Bit offsets correspond to ofp_version numbers which in turn correspond to
+ * wire-protocol numbers for Open Flow versions.. E.g. (1u << OFP11_VERSION)
+ * is the mask for Open Flow 1.1. If the bit for a version is set then it is
+ * allowed, otherwise it is disallowed. */
+
+void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
+void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
+
+uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
+enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
+
+/* Bitmap of OpenFlow versions that Open vSwitch supports. */
+#define OFPUTIL_SUPPORTED_VERSIONS \
+ ((1u << OFP10_VERSION) | (1u << OFP12_VERSION) | (1u << OFP13_VERSION))
+
+/* Bitmap of OpenFlow versions to enable by default (a subset of
+ * OFPUTIL_SUPPORTED_VERSIONS). */
+#define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
+
+enum ofputil_protocol ofputil_protocols_from_string(const char *s);
+
+const char *ofputil_version_to_string(enum ofp_version ofp_version);
+uint32_t ofputil_versions_from_string(const char *s);
+uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
+
+bool ofputil_decode_hello(const struct ofp_header *,
+ uint32_t *allowed_versions);
+struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
+
+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 ofp10_match. */
+void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
+void ofputil_match_from_ofp10_match(const struct ofp10_match *,
+ struct match *);
+void ofputil_normalize_match(struct match *);
+void ofputil_normalize_match_quiet(struct match *);
+void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
+
+/* Work with ofp11_match. */
+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 *);
+void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_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);
+
+/* 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 ofp_version,
+ enum nx_packet_in_format);
+
+/* NXT_FLOW_MOD_TABLE_ID extension. */
+struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
+
+/* 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. "<used>" and "-" indicate a value
+ * that may be populated and an ignored field, respectively.
+ *
+ * cookie cookie_mask new_cookie
+ * ====== =========== ==========
+ * OF10 Add - 0 <used>
+ * OF10 Modify - 0 <used>
+ * OF10 Delete - 0 -
+ * NXM Add - 0 <used>
+ * NXM Modify <used> <used> <used>
+ * NXM Delete <used> <used> -
+ */
+struct ofputil_flow_mod {
+ struct match match;
+ unsigned int priority;
+ 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. */
+ 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;
+ struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
+ size_t ofpacts_len; /* Length of ofpacts, in bytes. */
+};
+
+enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
+ const struct ofp_header *,
+ enum ofputil_protocol,
+ struct ofpbuf *ofpacts);
+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? */
+ struct match match;
+ ovs_be64 cookie;
+ ovs_be64 cookie_mask;
+ ofp_port_t out_port;
+ uint8_t table_id;
+};
+
+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 {
+ struct match match;
+ ovs_be64 cookie;
+ uint8_t table_id;
+ uint32_t duration_sec;
+ uint32_t duration_nsec;
+ uint16_t priority;
+ 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. */
+ struct ofpact *ofpacts;
+ size_t ofpacts_len;
+ uint16_t flags; /* Added for OF 1.3 */
+};
+
+int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
+ struct ofpbuf *msg,
+ bool flow_age_extension,
+ struct ofpbuf *ofpacts);
+void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
+ struct list *replies);
+
+/* 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. */
+ uint32_t flow_count;
+};
+
+struct ofpbuf *ofputil_encode_aggregate_stats_reply(
+ const struct ofputil_aggregate_stats *stats,
+ const struct ofp_header *request);
+enum ofperr ofputil_decode_aggregate_stats_reply(
+ struct ofputil_aggregate_stats *,
+ const struct ofp_header *reply);
+
+/* Flow removed message, independent of protocol. */
+struct ofputil_flow_removed {
+ struct match match;
+ uint16_t priority;
+ ovs_be64 cookie;
+ uint8_t reason; /* One of OFPRR_*. */
+ uint8_t table_id; /* 255 if message didn't include table ID. */
+ uint32_t duration_sec;
+ uint32_t duration_nsec;
+ uint16_t idle_timeout;
+ uint16_t hard_timeout;
+ uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
+ uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
+};
+
+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 ofputil_protocol);
+
+/* Abstract packet-in message. */
+struct ofputil_packet_in {
+ 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;
+
+ uint32_t buffer_id;
+ int send_len;
+ uint16_t total_len; /* Full length of frame. */
+
+ struct flow_metadata fmd; /* Metadata at creation time. */
+};
+
+enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
+ const struct ofp_header *);
+struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
+ enum ofputil_protocol protocol,
+ enum nx_packet_in_format);
+
+enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
+const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
+ char *reasonbuf,
+ size_t bufsize);
+bool ofputil_packet_in_reason_from_string(const char *,
+ enum ofp_packet_in_reason *);
+
+/* Abstract packet-out message.
+ *
+ * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
+ * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
+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. */
+ ofp_port_t in_port; /* Packet's input port. */
+ struct ofpact *ofpacts; /* Actions. */
+ size_t ofpacts_len; /* Size of ofpacts in bytes. */
+};
+
+enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
+ const struct ofp_header *,
+ struct ofpbuf *ofpacts);
+struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
+ enum ofputil_protocol protocol);
+
+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 {
+ ofp_port_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, 1.1, 1.2, and 1.3 share these capability values. */
+ 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. */
+
+ /* OpenFlow 1.0 and 1.1 share this capability. */
+ 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, 1.2, and 1.3 share this capability. */
+ OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
+
+ /* OpenFlow 1.2 and 1.3 share this capability */
+ OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
+};
+
+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,
+ OFPUTIL_A_SET_FIELD = 1 << 27,
+};
+
+/* 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. */
+ uint8_t auxiliary_id; /* Identify auxiliary connections */
+ enum ofputil_capabilities capabilities;
+ enum ofputil_action_bitmap actions;
+};
+
+enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
+ struct ofputil_switch_features *,
+ struct ofpbuf *);
+
+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 *);
+bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
+
+/* phy_port helper functions. */
+int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
+ struct ofputil_phy_port *);
+size_t ofputil_count_phy_ports(uint8_t ofp_version, 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_header *,
+ 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 {
+ ofp_port_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);
+
+struct ofputil_meter_band {
+ uint16_t type;
+ uint8_t pad;
+ uint8_t prec_level; /* Non-zero if type == OFPMBT_DSCP_REMARK */
+ uint32_t rate;
+ uint32_t burst_size;
+};
+
+struct ofputil_meter_band_stats {
+ uint64_t packet_count;
+ uint64_t byte_count;
+};
+
+struct ofputil_meter_config {
+ uint32_t meter_id;
+ uint16_t flags;
+ uint16_t n_bands;
+ struct ofputil_meter_band *bands;
+};
+
+/* Abstract ofp_meter_mod. */
+struct ofputil_meter_mod {
+ uint16_t command;
+ struct ofputil_meter_config meter;
+};
+
+struct ofputil_meter_stats {
+ uint32_t meter_id;
+ uint32_t flow_count;
+ uint64_t packet_in_count;
+ uint64_t byte_in_count;
+ uint32_t duration_sec;
+ uint32_t duration_nsec;
+ uint16_t n_bands;
+ struct ofputil_meter_band_stats *bands; /* band stats */
+};
+
+struct ofputil_meter_features {
+ uint32_t max_meters; /* Maximum number of meters */
+ uint32_t band_types; /* Can support max 32 band types */
+ uint32_t capabilities; /* Supported flags */
+ uint8_t max_bands;
+ uint8_t max_color;
+};
+
+enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
+ struct ofputil_meter_mod *,
+ struct ofpbuf *bands);
+struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version ofp_version,
+ const struct ofputil_meter_mod *);
+
+void ofputil_decode_meter_features(const struct ofp_header *,
+ struct ofputil_meter_features *);
+struct ofpbuf *ofputil_encode_meter_features_reply(const struct
+ ofputil_meter_features *,
+ const struct ofp_header *
+ request);
+void ofputil_decode_meter_request(const struct ofp_header *,
+ uint32_t *meter_id);
+
+void ofputil_append_meter_config(struct list *replies,
+ const struct ofputil_meter_config *omc);
+
+void ofputil_append_meter_stats(struct list *replies,
+ const struct ofputil_meter_stats *oms);
+
+enum ofputil_meter_request_type {
+ OFPUTIL_METER_FEATURES,
+ OFPUTIL_METER_CONFIG,
+ OFPUTIL_METER_STATS
+};
+
+struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
+ enum ofputil_meter_request_type,
+ uint32_t meter_id);
+
+int ofputil_decode_meter_stats(struct ofpbuf *msg,
+ struct ofputil_meter_stats *ms,
+ struct ofpbuf *bands);
+
+int ofputil_decode_meter_config(struct ofpbuf *msg,
+ struct ofputil_meter_config *mc,
+ struct ofpbuf *bands);
+
+/* Type for meter_id in ofproto provider interface, UINT32_MAX if none */
+typedef struct { uint32_t uint32; } ofproto_meter_id;
+
+/* Abstract ofp_role_request and reply. */
+struct ofputil_role_request {
+ enum ofp12_controller_role role;
+ bool have_generation_id;
+ 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 *);
+
+/* Abstract table stats.