+/* Basic decoding and length validation of OpenFlow messages. */
+enum ofputil_msg_code {
+ OFPUTIL_MSG_INVALID,
+
+ /* OFPT_* messages. */
+ OFPUTIL_OFPT_HELLO,
+ OFPUTIL_OFPT_ERROR,
+ OFPUTIL_OFPT_ECHO_REQUEST,
+ OFPUTIL_OFPT_ECHO_REPLY,
+ OFPUTIL_OFPT_FEATURES_REQUEST,
+ OFPUTIL_OFPT_FEATURES_REPLY,
+ OFPUTIL_OFPT_GET_CONFIG_REQUEST,
+ OFPUTIL_OFPT_GET_CONFIG_REPLY,
+ OFPUTIL_OFPT_SET_CONFIG,
+ OFPUTIL_OFPT_PACKET_IN,
+ OFPUTIL_OFPT_FLOW_REMOVED,
+ OFPUTIL_OFPT_PORT_STATUS,
+ OFPUTIL_OFPT_PACKET_OUT,
+ OFPUTIL_OFPT_FLOW_MOD,
+ OFPUTIL_OFPT_PORT_MOD,
+ OFPUTIL_OFPT_BARRIER_REQUEST,
+ OFPUTIL_OFPT_BARRIER_REPLY,
+ OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
+ OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
+
+ /* OFPST_* stat requests. */
+ OFPUTIL_OFPST_DESC_REQUEST,
+ OFPUTIL_OFPST_FLOW_REQUEST,
+ OFPUTIL_OFPST_AGGREGATE_REQUEST,
+ OFPUTIL_OFPST_TABLE_REQUEST,
+ OFPUTIL_OFPST_PORT_REQUEST,
+ OFPUTIL_OFPST_QUEUE_REQUEST,
+
+ /* OFPST_* stat replies. */
+ OFPUTIL_OFPST_DESC_REPLY,
+ OFPUTIL_OFPST_FLOW_REPLY,
+ OFPUTIL_OFPST_QUEUE_REPLY,
+ OFPUTIL_OFPST_PORT_REPLY,
+ OFPUTIL_OFPST_TABLE_REPLY,
+ OFPUTIL_OFPST_AGGREGATE_REPLY,
+
+ /* NXT_* messages. */
+ OFPUTIL_NXT_ROLE_REQUEST,
+ OFPUTIL_NXT_ROLE_REPLY,
+ OFPUTIL_NXT_SET_FLOW_FORMAT,
+ OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
+ OFPUTIL_NXT_FLOW_MOD,
+ OFPUTIL_NXT_FLOW_REMOVED,
+
+ /* NXST_* stat requests. */
+ OFPUTIL_NXST_FLOW_REQUEST,
+ OFPUTIL_NXST_AGGREGATE_REQUEST,
+
+ /* NXST_* stat replies. */
+ OFPUTIL_NXST_FLOW_REPLY,
+ OFPUTIL_NXST_AGGREGATE_REPLY
+};
+
+struct ofputil_msg_type;
+int ofputil_decode_msg_type(const struct ofp_header *,
+ 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);
+
+/* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
+ * and from IP bitmasks. */
+ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
+int ofputil_netmask_to_wcbits(ovs_be32 netmask);
+
+/* 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_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);
+
+/* 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 cls_rule cr;
+ ovs_be64 cookie;
+ uint8_t table_id;
+ uint16_t command;
+ uint16_t idle_timeout;
+ uint16_t hard_timeout;
+ uint32_t buffer_id;
+ uint16_t out_port;
+ uint16_t flags;
+ union ofp_action *actions;
+ 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 nx_flow_format,
+ bool flow_mod_table_id);
+
+/* Flow stats or aggregate stats request, independent of flow format. */
+struct flow_stats_request {
+ bool aggregate; /* Aggregate results? */
+ struct cls_rule match;
+ uint16_t out_port;
+ uint8_t table_id;
+};
+
+int ofputil_decode_flow_stats_request(struct flow_stats_request *,
+ const struct ofp_header *);
+struct ofpbuf *ofputil_encode_flow_stats_request(
+ const struct flow_stats_request *, enum nx_flow_format);
+
+/* Flow stats reply, independent of flow format. */
+struct ofputil_flow_stats {
+ struct cls_rule rule;
+ ovs_be64 cookie;
+ uint8_t 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. */
+ union ofp_action *actions;
+ size_t n_actions;
+};
+
+int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
+ struct ofpbuf *msg);
+void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
+ struct list *replies);
+
+/* Aggregate stats reply, independent of flow format. */
+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_stats_msg *request);
+
+/* Flow removed message, independent of flow format. */
+struct ofputil_flow_removed {
+ struct cls_rule rule;
+ ovs_be64 cookie;
+ uint8_t reason; /* One of OFPRR_*. */
+ uint32_t duration_sec;
+ uint32_t duration_nsec;
+ uint16_t idle_timeout;
+ uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
+ uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
+};
+
+int 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_*. */
+
+ uint32_t buffer_id;
+ int send_len;
+};
+
+struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
+ struct ofpbuf *rw_packet);