+ static uint32_t next_xid = 1;
+ return htonl(next_xid++);
+}
+\f
+/* Basic parsing of OpenFlow messages. */
+
+struct ofputil_msg_type {
+ enum ofputil_msg_code code; /* OFPUTIL_*. */
+ uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
+ const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
+ unsigned int min_size; /* Minimum total message size in bytes. */
+ /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
+ * the message may exceed 'min_size' by an even multiple of this value. */
+ unsigned int extra_multiple;
+};
+
+struct ofputil_msg_category {
+ const char *name; /* e.g. "OpenFlow message" */
+ const struct ofputil_msg_type *types;
+ size_t n_types;
+ int missing_error; /* ofp_mkerr() value for missing type. */
+};
+
+static bool
+ofputil_length_ok(const struct ofputil_msg_category *cat,
+ const struct ofputil_msg_type *type,
+ unsigned int size)
+{
+ switch (type->extra_multiple) {
+ case 0:
+ if (size != type->min_size) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
+ "length %u (expected length %u)",
+ cat->name, type->name, size, type->min_size);
+ return false;
+ }
+ return true;
+
+ case 1:
+ if (size < type->min_size) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
+ "length %u (expected length at least %u bytes)",
+ cat->name, type->name, size, type->min_size);
+ return false;
+ }
+ return true;
+
+ default:
+ if (size < type->min_size
+ || (size - type->min_size) % type->extra_multiple) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
+ "length %u (must be exactly %u bytes or longer "
+ "by an integer multiple of %u bytes)",
+ cat->name, type->name, size,
+ type->min_size, type->extra_multiple);
+ return false;
+ }
+ return true;
+ }
+}
+
+static int
+ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
+ uint32_t value, unsigned int size,
+ const struct ofputil_msg_type **typep)
+{
+ const struct ofputil_msg_type *type;
+
+ for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
+ if (type->value == value) {
+ if (!ofputil_length_ok(cat, type, size)) {
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ }
+ *typep = type;
+ return 0;
+ }
+ }
+
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
+ cat->name, value);
+ return cat->missing_error;
+}
+
+static int
+ofputil_decode_vendor(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ static const struct ofputil_msg_type nxt_messages[] = {
+ { OFPUTIL_NXT_STATUS_REQUEST,
+ NXT_STATUS_REQUEST, "NXT_STATUS_REQUEST",
+ sizeof(struct nicira_header), 1 },
+
+ { OFPUTIL_NXT_STATUS_REPLY,
+ NXT_STATUS_REPLY, "NXT_STATUS_REPLY",
+ sizeof(struct nicira_header), 1 },
+
+ { OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
+ NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE",
+ sizeof(struct nxt_tun_id_cookie), 0 },
+
+ { OFPUTIL_NXT_ROLE_REQUEST,
+ NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
+ sizeof(struct nx_role_request), 0 },
+
+ { OFPUTIL_NXT_ROLE_REPLY,
+ NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
+ sizeof(struct nx_role_request), 0 },
+
+ { OFPUTIL_NXT_SET_FLOW_FORMAT,
+ NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
+ sizeof(struct nxt_set_flow_format), 0 },
+
+ { OFPUTIL_NXT_FLOW_MOD,
+ NXT_FLOW_MOD, "NXT_FLOW_MOD",
+ sizeof(struct nx_flow_mod), 8 },
+
+ { OFPUTIL_NXT_FLOW_REMOVED,
+ NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
+ sizeof(struct nx_flow_removed), 8 },
+ };
+
+ static const struct ofputil_msg_category nxt_category = {
+ "Nicira extension message",
+ nxt_messages, ARRAY_SIZE(nxt_messages),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
+ };
+
+ const struct ofp_vendor_header *ovh;
+ const struct nicira_header *nh;
+
+ ovh = (const struct ofp_vendor_header *) oh;
+ if (ovh->vendor != htonl(NX_VENDOR_ID)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
+ "vendor %"PRIx32, ntohl(ovh->vendor));
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
+ }
+
+ if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
+ "length %u (expected at least %zu)",
+ ntohs(ovh->header.length), sizeof(struct nicira_header));
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ }
+
+ nh = (const struct nicira_header *) oh;
+ return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
+ ntohs(oh->length), typep);
+}
+
+static int
+check_nxstats_msg(const struct ofp_header *oh)
+{
+ const struct ofp_stats_request *osr;
+ ovs_be32 vendor;
+
+ osr = (const struct ofp_stats_request *) oh;
+
+ memcpy(&vendor, osr->body, sizeof vendor);
+ if (vendor != htonl(NX_VENDOR_ID)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
+ "unknown vendor %"PRIx32, ntohl(vendor));
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
+ }
+
+ if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ }
+
+ return 0;
+}
+
+static int
+ofputil_decode_nxst_request(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ static const struct ofputil_msg_type nxst_requests[] = {
+ { OFPUTIL_NXST_FLOW_REQUEST,
+ NXST_FLOW, "NXST_FLOW request",
+ sizeof(struct nx_flow_stats_request), 8 },
+
+ { OFPUTIL_NXST_AGGREGATE_REQUEST,
+ NXST_AGGREGATE, "NXST_AGGREGATE request",
+ sizeof(struct nx_aggregate_stats_request), 8 },
+ };
+
+ static const struct ofputil_msg_category nxst_request_category = {
+ "Nicira extension statistics request",
+ nxst_requests, ARRAY_SIZE(nxst_requests),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
+ };
+
+ const struct nicira_stats_msg *nsm;
+ int error;
+
+ error = check_nxstats_msg(oh);
+ if (error) {
+ return error;
+ }
+
+ nsm = (struct nicira_stats_msg *) oh;
+ return ofputil_lookup_openflow_message(&nxst_request_category,
+ ntohl(nsm->subtype),
+ ntohs(oh->length), typep);
+}
+
+static int
+ofputil_decode_nxst_reply(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ static const struct ofputil_msg_type nxst_replies[] = {
+ { OFPUTIL_NXST_FLOW_REPLY,
+ NXST_FLOW, "NXST_FLOW reply",
+ sizeof(struct nicira_stats_msg), 8 },
+
+ { OFPUTIL_NXST_AGGREGATE_REPLY,
+ NXST_AGGREGATE, "NXST_AGGREGATE reply",
+ sizeof(struct nx_aggregate_stats_reply), 0 },
+ };
+
+ static const struct ofputil_msg_category nxst_reply_category = {
+ "Nicira extension statistics reply",
+ nxst_replies, ARRAY_SIZE(nxst_replies),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
+ };
+
+ const struct nicira_stats_msg *nsm;
+ int error;
+
+ error = check_nxstats_msg(oh);
+ if (error) {
+ return error;
+ }
+
+ nsm = (struct nicira_stats_msg *) oh;
+ return ofputil_lookup_openflow_message(&nxst_reply_category,
+ ntohl(nsm->subtype),
+ ntohs(oh->length), typep);
+}
+
+static int
+ofputil_decode_ofpst_request(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
+ static const struct ofputil_msg_type ofpst_requests[] = {
+ { OFPUTIL_OFPST_DESC_REQUEST,
+ OFPST_DESC, "OFPST_DESC request",
+ OSR_SIZE, 0 },
+
+ { OFPUTIL_OFPST_FLOW_REQUEST,
+ OFPST_FLOW, "OFPST_FLOW request",
+ OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
+
+ { OFPUTIL_OFPST_AGGREGATE_REQUEST,
+ OFPST_AGGREGATE, "OFPST_AGGREGATE request",
+ OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
+
+ { OFPUTIL_OFPST_TABLE_REQUEST,
+ OFPST_TABLE, "OFPST_TABLE request",
+ OSR_SIZE, 0 },
+
+ { OFPUTIL_OFPST_PORT_REQUEST,
+ OFPST_PORT, "OFPST_PORT request",
+ OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
+
+ { OFPUTIL_OFPST_QUEUE_REQUEST,
+ OFPST_QUEUE, "OFPST_QUEUE request",
+ OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
+
+ { 0,
+ OFPST_VENDOR, "OFPST_VENDOR request",
+ OSR_SIZE + sizeof(uint32_t), 1 },
+ };
+
+ static const struct ofputil_msg_category ofpst_request_category = {
+ "OpenFlow statistics",
+ ofpst_requests, ARRAY_SIZE(ofpst_requests),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
+ };
+
+ const struct ofp_stats_request *osr;
+ int error;
+
+ osr = (const struct ofp_stats_request *) oh;
+ error = ofputil_lookup_openflow_message(&ofpst_request_category,
+ ntohs(osr->type),
+ ntohs(oh->length), typep);
+ if (!error && osr->type == htons(OFPST_VENDOR)) {
+ error = ofputil_decode_nxst_request(oh, typep);
+ }
+ return error;
+}
+
+static int
+ofputil_decode_ofpst_reply(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
+ static const struct ofputil_msg_type ofpst_replies[] = {
+ { OFPUTIL_OFPST_DESC_REPLY,
+ OFPST_DESC, "OFPST_DESC reply",
+ OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
+
+ { OFPUTIL_OFPST_FLOW_REPLY,
+ OFPST_FLOW, "OFPST_FLOW reply",
+ OSR_SIZE, 1 },
+
+ { OFPUTIL_OFPST_AGGREGATE_REPLY,
+ OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
+ OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
+
+ { OFPUTIL_OFPST_TABLE_REPLY,
+ OFPST_TABLE, "OFPST_TABLE reply",
+ OSR_SIZE, sizeof(struct ofp_table_stats) },
+
+ { OFPUTIL_OFPST_PORT_REPLY,
+ OFPST_PORT, "OFPST_PORT reply",
+ OSR_SIZE, sizeof(struct ofp_port_stats) },
+
+ { OFPUTIL_OFPST_QUEUE_REPLY,
+ OFPST_QUEUE, "OFPST_QUEUE reply",
+ OSR_SIZE, sizeof(struct ofp_queue_stats) },
+
+ { 0,
+ OFPST_VENDOR, "OFPST_VENDOR reply",
+ OSR_SIZE + sizeof(uint32_t), 1 },
+ };
+
+ static const struct ofputil_msg_category ofpst_reply_category = {
+ "OpenFlow statistics",
+ ofpst_replies, ARRAY_SIZE(ofpst_replies),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
+ };
+
+ const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh;
+ int error;
+
+ error = ofputil_lookup_openflow_message(&ofpst_reply_category,
+ ntohs(osr->type),
+ ntohs(oh->length), typep);
+ if (!error && osr->type == htons(OFPST_VENDOR)) {
+ error = ofputil_decode_nxst_reply(oh, typep);
+ }
+ return error;
+}
+
+/* Decodes the message type represented by 'oh'. Returns 0 if successful or
+ * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
+ * way, stores in '*typep' a type structure that can be inspected with the
+ * ofputil_msg_type_*() functions.
+ *
+ * oh->length must indicate the correct length of the message (and must be at
+ * least sizeof(struct ofp_header)).
+ *
+ * Success indicates that 'oh' is at least as long as the minimum-length
+ * message of its type. */
+int
+ofputil_decode_msg_type(const struct ofp_header *oh,
+ const struct ofputil_msg_type **typep)
+{
+ static const struct ofputil_msg_type ofpt_messages[] = {
+ { OFPUTIL_OFPT_HELLO,
+ OFPT_HELLO, "OFPT_HELLO",
+ sizeof(struct ofp_hello), 1 },
+
+ { OFPUTIL_OFPT_ERROR,
+ OFPT_ERROR, "OFPT_ERROR",
+ sizeof(struct ofp_error_msg), 1 },
+
+ { OFPUTIL_OFPT_ECHO_REQUEST,
+ OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
+ sizeof(struct ofp_header), 1 },
+
+ { OFPUTIL_OFPT_ECHO_REPLY,
+ OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
+ sizeof(struct ofp_header), 1 },
+
+ { OFPUTIL_OFPT_FEATURES_REQUEST,
+ OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
+ sizeof(struct ofp_header), 0 },
+
+ { OFPUTIL_OFPT_FEATURES_REPLY,
+ OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
+ sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
+
+ { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
+ OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
+ sizeof(struct ofp_header), 0 },
+
+ { OFPUTIL_OFPT_GET_CONFIG_REPLY,
+ OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
+ sizeof(struct ofp_switch_config), 0 },
+
+ { OFPUTIL_OFPT_SET_CONFIG,
+ OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
+ sizeof(struct ofp_switch_config), 0 },
+
+ { OFPUTIL_OFPT_PACKET_IN,
+ OFPT_PACKET_IN, "OFPT_PACKET_IN",
+ offsetof(struct ofp_packet_in, data), 1 },
+
+ { OFPUTIL_OFPT_FLOW_REMOVED,
+ OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
+ sizeof(struct ofp_flow_removed), 0 },
+
+ { OFPUTIL_OFPT_PORT_STATUS,
+ OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
+ sizeof(struct ofp_port_status), 0 },
+
+ { OFPUTIL_OFPT_PACKET_OUT,
+ OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
+ sizeof(struct ofp_packet_out), 1 },
+
+ { OFPUTIL_OFPT_FLOW_MOD,
+ OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
+ sizeof(struct ofp_flow_mod), 1 },
+
+ { OFPUTIL_OFPT_PORT_MOD,
+ OFPT_PORT_MOD, "OFPT_PORT_MOD",
+ sizeof(struct ofp_port_mod), 0 },
+
+ { 0,
+ OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
+ sizeof(struct ofp_stats_request), 1 },
+
+ { 0,
+ OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
+ sizeof(struct ofp_stats_reply), 1 },
+
+ { OFPUTIL_OFPT_BARRIER_REQUEST,
+ OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
+ sizeof(struct ofp_header), 0 },
+
+ { OFPUTIL_OFPT_BARRIER_REPLY,
+ OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
+ sizeof(struct ofp_header), 0 },
+
+ { 0,
+ OFPT_VENDOR, "OFPT_VENDOR",
+ sizeof(struct ofp_vendor_header), 1 },
+ };
+
+ static const struct ofputil_msg_category ofpt_category = {
+ "OpenFlow message",
+ ofpt_messages, ARRAY_SIZE(ofpt_messages),
+ OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
+ };
+
+ int error;
+
+ error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
+ ntohs(oh->length), typep);
+ if (!error) {
+ switch (oh->type) {
+ case OFPT_VENDOR:
+ error = ofputil_decode_vendor(oh, typep);
+ break;
+
+ case OFPT_STATS_REQUEST:
+ error = ofputil_decode_ofpst_request(oh, typep);
+ break;
+
+ case OFPT_STATS_REPLY:
+ error = ofputil_decode_ofpst_reply(oh, typep);
+
+ default:
+ break;
+ }
+ }
+ if (error) {
+ static const struct ofputil_msg_type ofputil_invalid_type = {
+ OFPUTIL_INVALID,
+ 0, "OFPUTIL_INVALID",
+ 0, 0
+ };
+
+ *typep = &ofputil_invalid_type;
+ }
+ return error;
+}
+
+/* Returns an OFPUTIL_* message type code for 'type'. */
+enum ofputil_msg_code
+ofputil_msg_type_code(const struct ofputil_msg_type *type)
+{
+ return type->code;
+}
+\f
+/* Flow formats. */
+
+bool
+ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
+{
+ switch (flow_format) {
+ case NXFF_OPENFLOW10:
+ case NXFF_TUN_ID_FROM_COOKIE:
+ case NXFF_NXM:
+ return true;
+ }
+
+ return false;
+}
+
+const char *
+ofputil_flow_format_to_string(enum nx_flow_format flow_format)
+{
+ switch (flow_format) {
+ case NXFF_OPENFLOW10:
+ return "openflow10";
+ case NXFF_TUN_ID_FROM_COOKIE:
+ return "tun_id_from_cookie";
+ case NXFF_NXM:
+ return "nxm";
+ default:
+ NOT_REACHED();
+ }
+}
+
+int
+ofputil_flow_format_from_string(const char *s)
+{
+ return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
+ : !strcmp(s, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE
+ : !strcmp(s, "nxm") ? NXFF_NXM
+ : -1);
+}
+
+static bool
+regs_fully_wildcarded(const struct flow_wildcards *wc)
+{
+ int i;
+
+ for (i = 0; i < FLOW_N_REGS; i++) {
+ if (wc->reg_masks[i] != 0) {
+ return false;
+ }
+ }
+ return true;
+}
+
+static inline bool
+is_nxm_required(const struct cls_rule *rule, bool cookie_support,
+ ovs_be64 cookie)
+{
+ const struct flow_wildcards *wc = &rule->wc;
+ ovs_be32 cookie_hi;
+
+ /* Only NXM supports separately wildcards the Ethernet multicast bit. */
+ if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
+ return true;
+ }
+
+ /* Only NXM supports matching registers. */
+ if (!regs_fully_wildcarded(wc)) {
+ return true;
+ }
+
+ switch (wc->tun_id_mask) {
+ case CONSTANT_HTONLL(0):
+ /* Other formats can fully wildcard tun_id. */
+ break;
+
+ case CONSTANT_HTONLL(UINT64_MAX):
+ /* Only NXM supports matching tunnel ID, unless there is a cookie and
+ * the top 32 bits of the cookie are the desired tunnel ID value. */
+ cookie_hi = htonl(ntohll(cookie) >> 32);
+ if (!cookie_support
+ || (cookie_hi && cookie_hi != ntohll(rule->flow.tun_id))) {
+ return true;
+ }
+ break;
+
+ default:
+ /* Only NXM supports partial matches on tunnel ID. */
+ return true;
+ }
+
+ /* Other formats can express this rule. */
+ return false;
+}
+
+/* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
+ * (e.g. to add or remove a flow). 'cookie_support' should be true if the
+ * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for
+ * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do
+ * not, for example). If 'cookie_support' is true, then 'cookie' should be the
+ * cookie to be sent; otherwise its value is ignored.
+ *
+ * The "best" flow format is chosen on this basis:
+ *
+ * - It must be capable of expressing the rule. NXFF_OPENFLOW10 flows can't
+ * handle tunnel IDs. NXFF_TUN_ID_FROM_COOKIE flows can't handle registers
+ * or fixing the Ethernet multicast bit, and can't handle tunnel IDs that
+ * conflict with the high 32 bits of the cookie or commands that don't
+ * support cookies.
+ *
+ * - Otherwise, the chosen format should be as backward compatible as
+ * possible. (NXFF_OPENFLOW10 is more backward compatible than
+ * NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than
+ * NXFF_NXM.)
+ */
+enum nx_flow_format
+ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support,
+ ovs_be64 cookie)
+{
+ if (is_nxm_required(rule, cookie_support, cookie)) {
+ return NXFF_NXM;
+ } else if (rule->wc.tun_id_mask != htonll(0)) {
+ return NXFF_TUN_ID_FROM_COOKIE;
+ } else {
+ return NXFF_OPENFLOW10;
+ }
+}
+
+/* Returns an OpenFlow message that can be used to set the flow format to
+ * 'flow_format'. */
+struct ofpbuf *
+ofputil_make_set_flow_format(enum nx_flow_format flow_format)
+{
+ struct ofpbuf *msg;
+
+ if (flow_format == NXFF_OPENFLOW10
+ || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
+ struct nxt_tun_id_cookie *tic;
+
+ tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg);
+ tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE;
+ } else {
+ struct nxt_set_flow_format *sff;
+
+ sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
+ sff->format = htonl(flow_format);
+ }
+
+ return msg;
+}
+
+/* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
+ * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
+ * code.
+ *
+ * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format
+ * at the time when the message was received. Otherwise 'flow_format' is
+ * ignored.
+ *
+ * Does not validate the flow_mod actions. */
+int
+ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
+ enum nx_flow_format flow_format)
+{
+ const struct ofputil_msg_type *type;
+ struct ofpbuf b;
+
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ ofputil_decode_msg_type(oh, &type);
+ if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
+ /* Standard OpenFlow flow_mod. */
+ struct ofp_match match, orig_match;
+ const struct ofp_flow_mod *ofm;
+ int error;
+
+ /* Dissect the message. */
+ ofm = ofpbuf_pull(&b, sizeof *ofm);
+ error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
+ if (error) {
+ return error;
+ }
+
+ /* Normalize ofm->match. If normalization actually changes anything,
+ * then log the differences. */
+ match = ofm->match;
+ match.pad1[0] = match.pad2[0] = 0;
+ orig_match = match;
+ normalize_match(&match);
+ if (memcmp(&match, &orig_match, sizeof orig_match)) {
+ if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) {
+ char *old = ofp_match_to_literal_string(&orig_match);
+ char *new = ofp_match_to_literal_string(&match);
+ VLOG_INFO("normalization changed ofp_match, details:");
+ VLOG_INFO(" pre: %s", old);
+ VLOG_INFO("post: %s", new);
+ free(old);
+ free(new);
+ }
+ }
+
+ /* Translate the message. */
+ ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format,
+ ofm->cookie, &fm->cr);
+ fm->cookie = ofm->cookie;
+ fm->command = ntohs(ofm->command);
+ fm->idle_timeout = ntohs(ofm->idle_timeout);
+ fm->hard_timeout = ntohs(ofm->hard_timeout);
+ fm->buffer_id = ntohl(ofm->buffer_id);
+ fm->out_port = ntohs(ofm->out_port);
+ fm->flags = ntohs(ofm->flags);
+ } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
+ /* Nicira extended flow_mod. */
+ const struct nx_flow_mod *nfm;
+ int error;
+
+ /* Dissect the message. */
+ nfm = ofpbuf_pull(&b, sizeof *nfm);
+ error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
+ &fm->cr);
+ if (error) {
+ return error;
+ }
+ error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
+ if (error) {
+ return error;
+ }
+
+ /* Translate the message. */
+ fm->cookie = nfm->cookie;
+ fm->command = ntohs(nfm->command);
+ fm->idle_timeout = ntohs(nfm->idle_timeout);
+ fm->hard_timeout = ntohs(nfm->hard_timeout);
+ fm->buffer_id = ntohl(nfm->buffer_id);
+ fm->out_port = ntohs(nfm->out_port);
+ fm->flags = ntohs(nfm->flags);
+ } else {
+ NOT_REACHED();
+ }
+
+ return 0;
+}
+
+/* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
+ * 'flow_format' and returns the message. */
+struct ofpbuf *
+ofputil_encode_flow_mod(const struct flow_mod *fm,
+ enum nx_flow_format flow_format)
+{
+ size_t actions_len = fm->n_actions * sizeof *fm->actions;
+ struct ofpbuf *msg;
+
+ if (flow_format == NXFF_OPENFLOW10
+ || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
+ struct ofp_flow_mod *ofm;
+
+ msg = ofpbuf_new(sizeof *ofm + actions_len);
+ ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
+ ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match,
+ fm->cookie, &ofm->cookie);
+ ofm->command = htons(fm->command);
+ ofm->idle_timeout = htons(fm->idle_timeout);
+ ofm->hard_timeout = htons(fm->hard_timeout);
+ ofm->priority = htons(fm->cr.priority);
+ ofm->buffer_id = htonl(fm->buffer_id);
+ ofm->out_port = htons(fm->out_port);
+ ofm->flags = htons(fm->flags);
+ } else if (flow_format == NXFF_NXM) {
+ struct nx_flow_mod *nfm;
+ int match_len;
+
+ msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
+ put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
+ match_len = nx_put_match(msg, &fm->cr);
+
+ nfm = msg->data;
+ nfm->cookie = fm->cookie;
+ nfm->command = htons(fm->command);
+ nfm->idle_timeout = htons(fm->idle_timeout);
+ nfm->hard_timeout = htons(fm->hard_timeout);
+ nfm->priority = htons(fm->cr.priority);
+ nfm->buffer_id = htonl(fm->buffer_id);
+ nfm->out_port = htons(fm->out_port);
+ nfm->flags = htons(fm->flags);
+ nfm->match_len = htons(match_len);
+ } else {
+ NOT_REACHED();
+ }
+
+ ofpbuf_put(msg, fm->actions, actions_len);
+ update_openflow_length(msg);
+ return msg;
+}
+
+static int
+ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
+ const struct ofp_header *oh,
+ enum nx_flow_format flow_format,
+ bool aggregate)
+{
+ const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
+
+ fsr->aggregate = aggregate;
+ ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match);
+ fsr->out_port = ntohs(ofsr->out_port);
+ fsr->table_id = ofsr->table_id;
+
+ return 0;
+}
+
+static int
+ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
+ const struct ofp_header *oh,
+ bool aggregate)
+{
+ const struct nx_flow_stats_request *nfsr;
+ struct ofpbuf b;
+ int error;
+
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ nfsr = ofpbuf_pull(&b, sizeof *nfsr);
+ error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
+ if (error) {
+ return error;
+ }
+ if (b.size) {
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ }
+
+ fsr->aggregate = aggregate;
+ fsr->out_port = ntohs(nfsr->out_port);
+ fsr->table_id = nfsr->table_id;
+
+ return 0;
+}
+
+/* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
+ * message 'oh', received when the current flow format was 'flow_format', into
+ * an abstract flow_stats_request in 'fsr'. Returns 0 if successful, otherwise
+ * an OpenFlow error code.
+ *
+ * For OFPST_FLOW and OFPST_AGGREGATE messages, 'flow_format' should be the
+ * current flow format at the time when the message was received. Otherwise
+ * 'flow_format' is ignored. */
+int
+ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
+ const struct ofp_header *oh,
+ enum nx_flow_format flow_format)
+{
+ const struct ofputil_msg_type *type;
+ struct ofpbuf b;
+ int code;
+
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ ofputil_decode_msg_type(oh, &type);
+ code = ofputil_msg_type_code(type);
+ switch (code) {
+ case OFPUTIL_OFPST_FLOW_REQUEST:
+ return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false);
+
+ case OFPUTIL_OFPST_AGGREGATE_REQUEST:
+ return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true);
+
+ case OFPUTIL_NXST_FLOW_REQUEST:
+ return ofputil_decode_nxst_flow_request(fsr, oh, false);
+
+ case OFPUTIL_NXST_AGGREGATE_REQUEST:
+ return ofputil_decode_nxst_flow_request(fsr, oh, true);
+
+ default:
+ /* Hey, the caller lied. */
+ NOT_REACHED();
+ }
+}
+
+/* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
+ * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE message 'oh' according to
+ * 'flow_format', and returns the message. */
+struct ofpbuf *
+ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
+ enum nx_flow_format flow_format)
+{
+ struct ofpbuf *msg;
+
+ if (flow_format == NXFF_OPENFLOW10
+ || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
+ struct ofp_flow_stats_request *ofsr;
+ int type;
+
+ BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
+ == sizeof(struct ofp_aggregate_stats_request));
+
+ type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
+ ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
+ ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match,
+ 0, NULL);
+ ofsr->table_id = fsr->table_id;
+ ofsr->out_port = htons(fsr->out_port);
+ } else if (flow_format == NXFF_NXM) {
+ struct nx_flow_stats_request *nfsr;
+ int match_len;
+ int subtype;
+
+ subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
+ ofputil_make_nxstats_request(sizeof *nfsr, subtype, &msg);
+ match_len = nx_put_match(msg, &fsr->match);
+
+ nfsr = msg->data;
+ nfsr->out_port = htons(fsr->out_port);
+ nfsr->match_len = htons(match_len);
+ nfsr->table_id = fsr->table_id;
+ } else {
+ NOT_REACHED();
+ }
+
+ return msg;
+}
+
+/* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh', received
+ * when the current flow format was 'flow_format', into an abstract
+ * ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise an
+ * OpenFlow error code.
+ *
+ * For OFPT_FLOW_REMOVED messages, 'flow_format' should be the current flow
+ * format at the time when the message was received. Otherwise 'flow_format'
+ * is ignored. */
+int
+ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
+ const struct ofp_header *oh,
+ enum nx_flow_format flow_format)
+{
+ const struct ofputil_msg_type *type;
+ enum ofputil_msg_code code;
+
+ ofputil_decode_msg_type(oh, &type);
+ code = ofputil_msg_type_code(type);
+ if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
+ const struct ofp_flow_removed *ofr;
+
+ ofr = (const struct ofp_flow_removed *) oh;
+ ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
+ flow_format, ofr->cookie, &fr->rule);
+ fr->cookie = ofr->cookie;
+ fr->reason = ofr->reason;
+ fr->duration_sec = ntohl(ofr->duration_sec);
+ fr->duration_nsec = ntohl(ofr->duration_nsec);
+ fr->idle_timeout = ntohs(ofr->idle_timeout);
+ fr->packet_count = ntohll(ofr->packet_count);
+ fr->byte_count = ntohll(ofr->byte_count);
+ } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
+ struct nx_flow_removed *nfr;
+ struct ofpbuf b;
+ int error;
+
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ nfr = ofpbuf_pull(&b, sizeof *nfr);
+ error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
+ &fr->rule);
+ if (error) {
+ return error;
+ }
+ if (b.size) {
+ return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
+ }
+
+ fr->cookie = nfr->cookie;
+ fr->reason = nfr->reason;
+ fr->duration_sec = ntohl(nfr->duration_sec);
+ fr->duration_nsec = ntohl(nfr->duration_nsec);
+ fr->idle_timeout = ntohs(nfr->idle_timeout);
+ fr->packet_count = ntohll(nfr->packet_count);
+ fr->byte_count = ntohll(nfr->byte_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return 0;