+/* 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_msg), 1 },
+
+ { 0,
+ OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
+ sizeof(struct ofp_stats_msg), 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_MSG_INVALID,
+ 0, "OFPUTIL_MSG_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_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_NXM:
+ return "nxm";
+ default:
+ NOT_REACHED();
+ }
+}
+
+int
+ofputil_flow_format_from_string(const char *s)
+{
+ return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
+ : !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;
+}
+
+/* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
+ * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
+ * or fixing the Ethernet multicast bit. Otherwise, it's better to use
+ * NXFF_OPENFLOW10 for backward compatibility. */
+enum nx_flow_format
+ofputil_min_flow_format(const struct cls_rule *rule)
+{
+ const struct flow_wildcards *wc = &rule->wc;
+
+ BUILD_ASSERT_DECL(FLOW_WC_SEQ == 1);
+
+ /* Only NXM supports separately wildcards the Ethernet multicast bit. */
+ if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
+ return NXFF_NXM;
+ }
+
+ /* Only NXM supports matching ARP hardware addresses. */
+ if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
+ return NXFF_NXM;
+ }
+
+ /* Only NXM supports matching IPv6 traffic. */
+ if (!(wc->wildcards & FWW_DL_TYPE)
+ && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
+ return NXFF_NXM;
+ }
+
+ /* Only NXM supports matching registers. */
+ if (!regs_fully_wildcarded(wc)) {
+ return NXFF_NXM;
+ }
+
+ /* Only NXM supports matching tun_id. */
+ if (wc->tun_id_mask != htonll(0)) {
+ return NXFF_NXM;
+ }
+
+ /* Other formats can express this rule. */
+ 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 nxt_set_flow_format *sff;
+ struct ofpbuf *msg;
+
+ sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
+ sff->format = htonl(flow_format);
+
+ return msg;
+}
+
+/* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
+ * extension on or off (according to 'flow_mod_table_id'). */
+struct ofpbuf *
+ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
+{
+ struct nxt_flow_mod_table_id *nfmti;
+ struct ofpbuf *msg;
+
+ nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
+ nfmti->set = flow_mod_table_id;
+ 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.
+ *
+ * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
+ * enabled, false otherwise.
+ *
+ * Does not validate the flow_mod actions. */
+int
+ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
+ const struct ofp_header *oh, bool flow_mod_table_id)
+{
+ const struct ofputil_msg_type *type;
+ uint16_t command;
+ 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. */
+ const struct ofp_flow_mod *ofm;
+ uint16_t priority;
+ 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;
+ }
+
+ /* Set priority based on original wildcards. Normally we'd allow
+ * ofputil_cls_rule_from_match() to do this for us, but
+ * ofputil_normalize_rule() can put wildcards where the original flow
+ * didn't have them. */
+ priority = ntohs(ofm->priority);
+ if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
+ priority = UINT16_MAX;
+ }
+
+ /* Translate the rule. */
+ ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
+ ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
+
+ /* Translate the message. */
+ fm->cookie = ofm->cookie;
+ 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;
+ 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();
+ }
+
+ if (flow_mod_table_id) {
+ fm->command = command & 0xff;
+ fm->table_id = command >> 8;
+ } else {
+ fm->command = command;
+ fm->table_id = 0xff;
+ }
+
+ return 0;
+}
+
+/* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
+ * 'flow_format' and returns the message.
+ *
+ * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
+ * enabled, false otherwise. */
+struct ofpbuf *
+ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
+ enum nx_flow_format flow_format,
+ bool flow_mod_table_id)
+{
+ size_t actions_len = fm->n_actions * sizeof *fm->actions;
+ struct ofpbuf *msg;
+ uint16_t command;
+
+ command = (flow_mod_table_id
+ ? (fm->command & 0xff) | (fm->table_id << 8)
+ : fm->command);
+
+ if (flow_format == NXFF_OPENFLOW10) {
+ 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, &ofm->match);
+ ofm->cookie = fm->cookie;
+ ofm->command = htons(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(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 ofputil_flow_stats_request *fsr,
+ const struct ofp_header *oh,
+ bool aggregate)
+{
+ const struct ofp_flow_stats_request *ofsr =
+ (const struct ofp_flow_stats_request *) oh;
+
+ fsr->aggregate = aggregate;
+ ofputil_cls_rule_from_match(&ofsr->match, 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 ofputil_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
+ * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
+ * successful, otherwise an OpenFlow error code. */
+int
+ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
+ const struct ofp_header *oh)
+{
+ 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, false);
+
+ case OFPUTIL_OFPST_AGGREGATE_REQUEST:
+ return ofputil_decode_ofpst_flow_request(fsr, oh, 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 request 'oh' according to
+ * 'flow_format', and returns the message. */
+struct ofpbuf *
+ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
+ enum nx_flow_format flow_format)
+{
+ struct ofpbuf *msg;
+
+ if (flow_format == NXFF_OPENFLOW10) {
+ struct ofp_flow_stats_request *ofsr;
+ int type;
+
+ type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
+ ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
+ ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
+ 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_stats_request(sizeof *nfsr, OFPST_VENDOR, 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 OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
+ * ofputil_flow_stats in 'fs'.
+ *
+ * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
+ * OpenFlow message. Calling this function multiple times for a single 'msg'
+ * iterates through the replies. The caller must initially leave 'msg''s layer
+ * pointers null and not modify them between calls.
+ *
+ * Returns 0 if successful, EOF if no replies were left in this 'msg',
+ * otherwise a positive errno value. */
+int
+ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
+ struct ofpbuf *msg)
+{
+ const struct ofputil_msg_type *type;
+ int code;
+
+ ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
+ code = ofputil_msg_type_code(type);
+ if (!msg->l2) {
+ msg->l2 = msg->data;
+ if (code == OFPUTIL_OFPST_FLOW_REPLY) {
+ ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
+ } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
+ ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
+ } else {
+ NOT_REACHED();
+ }
+ }
+
+ if (!msg->size) {
+ return EOF;
+ } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
+ const struct ofp_flow_stats *ofs;
+ size_t length;
+
+ ofs = ofpbuf_try_pull(msg, sizeof *ofs);
+ if (!ofs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
+ "bytes at end", msg->size);
+ return EINVAL;
+ }
+
+ length = ntohs(ofs->length);
+ if (length < sizeof *ofs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
+ "length %zu", length);
+ return EINVAL;
+ }
+
+ if (ofputil_pull_actions(msg, length - sizeof *ofs,
+ &fs->actions, &fs->n_actions)) {
+ return EINVAL;
+ }
+
+ fs->cookie = get_32aligned_be64(&ofs->cookie);
+ ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
+ &fs->rule);
+ fs->table_id = ofs->table_id;
+ fs->duration_sec = ntohl(ofs->duration_sec);
+ fs->duration_nsec = ntohl(ofs->duration_nsec);
+ fs->idle_timeout = ntohs(ofs->idle_timeout);
+ fs->hard_timeout = ntohs(ofs->hard_timeout);
+ fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
+ fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
+ } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
+ const struct nx_flow_stats *nfs;
+ size_t match_len, length;
+
+ nfs = ofpbuf_try_pull(msg, sizeof *nfs);
+ if (!nfs) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
+ "bytes at end", msg->size);
+ return EINVAL;
+ }
+
+ length = ntohs(nfs->length);
+ match_len = ntohs(nfs->match_len);
+ if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
+ "claims invalid length %zu", match_len, length);
+ return EINVAL;
+ }
+ if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
+ return EINVAL;
+ }
+
+ if (ofputil_pull_actions(msg,
+ length - sizeof *nfs - ROUND_UP(match_len, 8),
+ &fs->actions, &fs->n_actions)) {
+ return EINVAL;
+ }
+
+ fs->cookie = nfs->cookie;
+ fs->table_id = nfs->table_id;
+ fs->duration_sec = ntohl(nfs->duration_sec);
+ fs->duration_nsec = ntohl(nfs->duration_nsec);
+ fs->idle_timeout = ntohs(nfs->idle_timeout);
+ fs->hard_timeout = ntohs(nfs->hard_timeout);
+ fs->packet_count = ntohll(nfs->packet_count);
+ fs->byte_count = ntohll(nfs->byte_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return 0;
+}
+
+/* Returns 'count' unchanged except that UINT64_MAX becomes 0.
+ *
+ * We use this in situations where OVS internally uses UINT64_MAX to mean
+ * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
+static uint64_t
+unknown_to_zero(uint64_t count)
+{
+ return count != UINT64_MAX ? count : 0;
+}
+
+/* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
+ * those already present in the list of ofpbufs in 'replies'. 'replies' should
+ * have been initialized with ofputil_start_stats_reply(). */
+void
+ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
+ struct list *replies)
+{
+ size_t act_len = fs->n_actions * sizeof *fs->actions;
+ const struct ofp_stats_msg *osm;
+
+ osm = ofpbuf_from_list(list_back(replies))->data;
+ if (osm->type == htons(OFPST_FLOW)) {
+ size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
+ struct ofp_flow_stats *ofs;
+
+ ofs = ofputil_append_stats_reply(len, replies);
+ ofs->length = htons(len);
+ ofs->table_id = fs->table_id;
+ ofs->pad = 0;
+ ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
+ ofs->duration_sec = htonl(fs->duration_sec);
+ ofs->duration_nsec = htonl(fs->duration_nsec);
+ ofs->priority = htons(fs->rule.priority);
+ ofs->idle_timeout = htons(fs->idle_timeout);
+ ofs->hard_timeout = htons(fs->hard_timeout);
+ memset(ofs->pad2, 0, sizeof ofs->pad2);
+ put_32aligned_be64(&ofs->cookie, fs->cookie);
+ put_32aligned_be64(&ofs->packet_count,
+ htonll(unknown_to_zero(fs->packet_count)));
+ put_32aligned_be64(&ofs->byte_count,
+ htonll(unknown_to_zero(fs->byte_count)));
+ memcpy(ofs->actions, fs->actions, act_len);
+ } else if (osm->type == htons(OFPST_VENDOR)) {
+ struct nx_flow_stats *nfs;
+ struct ofpbuf *msg;
+ size_t start_len;
+
+ msg = ofputil_reserve_stats_reply(
+ sizeof *nfs + NXM_MAX_LEN + act_len, replies);
+ start_len = msg->size;
+
+ nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
+ nfs->table_id = fs->table_id;
+ nfs->pad = 0;
+ nfs->duration_sec = htonl(fs->duration_sec);
+ nfs->duration_nsec = htonl(fs->duration_nsec);
+ nfs->priority = htons(fs->rule.priority);
+ nfs->idle_timeout = htons(fs->idle_timeout);
+ nfs->hard_timeout = htons(fs->hard_timeout);
+ nfs->match_len = htons(nx_put_match(msg, &fs->rule));
+ memset(nfs->pad2, 0, sizeof nfs->pad2);
+ nfs->cookie = fs->cookie;
+ nfs->packet_count = htonll(fs->packet_count);
+ nfs->byte_count = htonll(fs->byte_count);
+ ofpbuf_put(msg, fs->actions, act_len);
+ nfs->length = htons(msg->size - start_len);
+ } else {
+ NOT_REACHED();
+ }
+}
+
+/* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
+ * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */
+struct ofpbuf *
+ofputil_encode_aggregate_stats_reply(
+ const struct ofputil_aggregate_stats *stats,
+ const struct ofp_stats_msg *request)
+{
+ struct ofpbuf *msg;
+
+ if (request->type == htons(OFPST_AGGREGATE)) {
+ struct ofp_aggregate_stats_reply *asr;
+
+ asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
+ put_32aligned_be64(&asr->packet_count,
+ htonll(unknown_to_zero(stats->packet_count)));
+ put_32aligned_be64(&asr->byte_count,
+ htonll(unknown_to_zero(stats->byte_count)));
+ asr->flow_count = htonl(stats->flow_count);
+ } else if (request->type == htons(OFPST_VENDOR)) {
+ struct nx_aggregate_stats_reply *nasr;
+
+ nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
+ assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
+ nasr->packet_count = htonll(stats->packet_count);
+ nasr->byte_count = htonll(stats->byte_count);
+ nasr->flow_count = htonl(stats->flow_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return msg;
+}
+
+/* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
+ * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
+ * an OpenFlow error code. */
+int
+ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
+ const struct ofp_header *oh)
+{
+ 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),
+ &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;
+}
+
+/* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
+ * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
+ * message. */
+struct ofpbuf *
+ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
+ enum nx_flow_format flow_format)
+{
+ struct ofpbuf *msg;
+
+ if (flow_format == NXFF_OPENFLOW10) {
+ struct ofp_flow_removed *ofr;
+
+ ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
+ &msg);
+ ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
+ ofr->cookie = fr->cookie;
+ ofr->priority = htons(fr->rule.priority);
+ ofr->reason = fr->reason;
+ ofr->duration_sec = htonl(fr->duration_sec);
+ ofr->duration_nsec = htonl(fr->duration_nsec);
+ ofr->idle_timeout = htons(fr->idle_timeout);
+ ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
+ ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
+ } else if (flow_format == NXFF_NXM) {
+ struct nx_flow_removed *nfr;
+ int match_len;
+
+ make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
+ match_len = nx_put_match(msg, &fr->rule);
+
+ nfr = msg->data;
+ nfr->cookie = fr->cookie;
+ nfr->priority = htons(fr->rule.priority);
+ nfr->reason = fr->reason;
+ nfr->duration_sec = htonl(fr->duration_sec);
+ nfr->duration_nsec = htonl(fr->duration_nsec);
+ nfr->idle_timeout = htons(fr->idle_timeout);
+ nfr->match_len = htons(match_len);
+ nfr->packet_count = htonll(fr->packet_count);
+ nfr->byte_count = htonll(fr->byte_count);
+ } else {
+ NOT_REACHED();
+ }
+
+ return msg;
+}
+
+/* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
+ * and returns the message.
+ *
+ * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
+ * returned ofpbuf.
+ *
+ * If 'rw_packet' is nonnull, then it must contain the same data as
+ * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
+ * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
+ * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
+ * enough headroom to insert a "struct ofp_packet_in", this is more efficient
+ * than ofputil_encode_packet_in() because it does not copy the packet
+ * payload. */
+struct ofpbuf *
+ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
+ struct ofpbuf *rw_packet)
+{
+ int total_len = pin->packet->size;
+ struct ofp_packet_in *opi;
+
+ if (rw_packet) {
+ if (pin->send_len < rw_packet->size) {
+ rw_packet->size = pin->send_len;
+ }
+ } else {
+ rw_packet = ofpbuf_clone_data_with_headroom(
+ pin->packet->data, MIN(pin->send_len, pin->packet->size),
+ offsetof(struct ofp_packet_in, data));
+ }
+
+ /* Add OFPT_PACKET_IN. */
+ opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data));
+ opi->header.version = OFP_VERSION;
+ opi->header.type = OFPT_PACKET_IN;
+ opi->total_len = htons(total_len);
+ opi->in_port = htons(pin->in_port);
+ opi->reason = pin->reason;
+ opi->buffer_id = htonl(pin->buffer_id);
+ update_openflow_length(rw_packet);
+
+ return rw_packet;
+}
+
+/* Returns a string representing the message type of 'type'. The string is the
+ * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
+ * messages, the constant is followed by "request" or "reply",
+ * e.g. "OFPST_AGGREGATE reply". */
+const char *
+ofputil_msg_type_name(const struct ofputil_msg_type *type)
+{
+ return type->name;
+}
+\f