+ 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->idle_age = -1;
+ fs->hard_age = -1;
+ 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,
+ NULL, NULL)) {
+ 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->idle_age = -1;
+ fs->hard_age = -1;
+ if (flow_age_extension) {
+ if (nfs->idle_age) {
+ fs->idle_age = ntohs(nfs->idle_age) - 1;
+ }
+ if (nfs->hard_age) {
+ fs->hard_age = ntohs(nfs->hard_age) - 1;
+ }
+ }
+ 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->idle_age = htons(fs->idle_age < 0 ? 0
+ : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
+ : UINT16_MAX);
+ nfs->hard_age = htons(fs->hard_age < 0 ? 0
+ : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
+ : UINT16_MAX);
+ nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
+ 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. */
+enum ofperr
+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, NULL, NULL);
+ if (error) {
+ return error;
+ }
+ if (b.size) {
+ return OFPERR_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, 0, 0);
+
+ 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;
+}
+
+int
+ofputil_decode_packet_in(struct ofputil_packet_in *pin,
+ 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);
+ memset(pin, 0, sizeof *pin);
+
+ if (code == OFPUTIL_OFPT_PACKET_IN) {
+ const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
+
+ pin->packet = opi->data;
+ pin->packet_len = ntohs(opi->header.length)
+ - offsetof(struct ofp_packet_in, data);
+
+ pin->fmd.in_port = ntohs(opi->in_port);
+ pin->reason = opi->reason;
+ pin->buffer_id = ntohl(opi->buffer_id);
+ pin->total_len = ntohs(opi->total_len);
+ } else if (code == OFPUTIL_NXT_PACKET_IN) {
+ const struct nx_packet_in *npi;
+ struct cls_rule rule;
+ struct ofpbuf b;
+ int error;
+
+ ofpbuf_use_const(&b, oh, ntohs(oh->length));
+
+ npi = ofpbuf_pull(&b, sizeof *npi);
+ error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
+ NULL);
+ if (error) {
+ return error;
+ }
+
+ if (!ofpbuf_try_pull(&b, 2)) {
+ return OFPERR_OFPBRC_BAD_LEN;
+ }
+
+ pin->packet = b.data;
+ pin->packet_len = b.size;
+ pin->reason = npi->reason;
+ pin->table_id = npi->table_id;
+ pin->cookie = npi->cookie;
+
+ pin->fmd.in_port = rule.flow.in_port;
+
+ pin->fmd.tun_id = rule.flow.tun_id;
+ pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
+
+ memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
+ memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
+ sizeof pin->fmd.reg_masks);
+
+ pin->buffer_id = ntohl(npi->buffer_id);
+ pin->total_len = ntohs(npi->total_len);
+ } else {
+ NOT_REACHED();
+ }
+
+ return 0;
+}
+
+/* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
+ * in the format specified by 'packet_in_format'. */
+struct ofpbuf *
+ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
+ enum nx_packet_in_format packet_in_format)
+{
+ size_t send_len = MIN(pin->send_len, pin->packet_len);
+ struct ofpbuf *packet;
+
+ /* Add OFPT_PACKET_IN. */
+ if (packet_in_format == NXPIF_OPENFLOW10) {
+ size_t header_len = offsetof(struct ofp_packet_in, data);
+ struct ofp_packet_in *opi;
+
+ packet = ofpbuf_new(send_len + header_len);
+ opi = ofpbuf_put_zeros(packet, header_len);
+ opi->header.version = OFP_VERSION;
+ opi->header.type = OFPT_PACKET_IN;
+ opi->total_len = htons(pin->total_len);
+ opi->in_port = htons(pin->fmd.in_port);
+ opi->reason = pin->reason;
+ opi->buffer_id = htonl(pin->buffer_id);
+
+ ofpbuf_put(packet, pin->packet, send_len);
+ } else if (packet_in_format == NXPIF_NXM) {
+ struct nx_packet_in *npi;
+ struct cls_rule rule;
+ size_t match_len;
+ size_t i;
+
+ /* Estimate of required PACKET_IN length includes the NPI header, space
+ * for the match (2 times sizeof the metadata seems like enough), 2
+ * bytes for padding, and the packet length. */
+ packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
+ + 2 + send_len);
+
+ cls_rule_init_catchall(&rule, 0);
+ cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
+ pin->fmd.tun_id_mask);
+
+ for (i = 0; i < FLOW_N_REGS; i++) {
+ cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
+ pin->fmd.reg_masks[i]);
+ }
+
+ cls_rule_set_in_port(&rule, pin->fmd.in_port);
+
+ ofpbuf_put_zeros(packet, sizeof *npi);
+ match_len = nx_put_match(packet, &rule, 0, 0);
+ ofpbuf_put_zeros(packet, 2);
+ ofpbuf_put(packet, pin->packet, send_len);
+
+ npi = packet->data;
+ npi->nxh.header.version = OFP_VERSION;
+ npi->nxh.header.type = OFPT_VENDOR;
+ npi->nxh.vendor = htonl(NX_VENDOR_ID);
+ npi->nxh.subtype = htonl(NXT_PACKET_IN);
+
+ npi->buffer_id = htonl(pin->buffer_id);
+ npi->total_len = htons(pin->total_len);
+ npi->reason = pin->reason;
+ npi->table_id = pin->table_id;
+ npi->cookie = pin->cookie;
+ npi->match_len = htons(match_len);
+ } else {
+ NOT_REACHED();
+ }
+ update_openflow_length(packet);
+
+ return packet;
+}
+
+const char *
+ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
+{
+ static char s[INT_STRLEN(int) + 1];
+
+ switch (reason) {
+ case OFPR_NO_MATCH:
+ return "no_match";
+ case OFPR_ACTION:
+ return "action";
+ case OFPR_INVALID_TTL:
+ return "invalid_ttl";
+
+ case OFPR_N_REASONS:
+ default:
+ sprintf(s, "%d", (int) reason);
+ return s;
+ }
+}
+
+bool
+ofputil_packet_in_reason_from_string(const char *s,
+ enum ofp_packet_in_reason *reason)
+{
+ int i;
+
+ for (i = 0; i < OFPR_N_REASONS; i++) {
+ if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
+ *reason = i;
+ return true;
+ }
+ }
+ return false;
+}
+
+enum ofperr
+ofputil_decode_packet_out(struct ofputil_packet_out *po,
+ const struct ofp_packet_out *opo)
+{
+ enum ofperr error;
+ struct ofpbuf b;
+
+ po->buffer_id = ntohl(opo->buffer_id);
+ po->in_port = ntohs(opo->in_port);
+ if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
+ && po->in_port != OFPP_NONE) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
+ po->in_port);
+ return OFPERR_NXBRC_BAD_IN_PORT;
+ }
+
+ ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
+ ofpbuf_pull(&b, sizeof *opo);
+
+ error = ofputil_pull_actions(&b, ntohs(opo->actions_len),
+ &po->actions, &po->n_actions);
+ if (error) {
+ return error;
+ }
+
+ if (po->buffer_id == UINT32_MAX) {
+ po->packet = b.data;
+ po->packet_len = b.size;
+ } else {
+ po->packet = NULL;
+ po->packet_len = 0;
+ }
+
+ return 0;
+}
+
+struct ofpbuf *
+ofputil_encode_packet_out(const struct ofputil_packet_out *po)
+{
+ struct ofp_packet_out *opo;
+ size_t actions_len;
+ struct ofpbuf *msg;
+ size_t size;
+
+ actions_len = po->n_actions * sizeof *po->actions;
+ size = sizeof *opo + actions_len;
+ if (po->buffer_id == UINT32_MAX) {
+ size += po->packet_len;
+ }
+
+ msg = ofpbuf_new(size);
+ opo = put_openflow(sizeof *opo, OFPT_PACKET_OUT, msg);
+ opo->buffer_id = htonl(po->buffer_id);
+ opo->in_port = htons(po->in_port);
+ opo->actions_len = htons(actions_len);
+ ofpbuf_put(msg, po->actions, actions_len);
+ if (po->buffer_id == UINT32_MAX) {
+ ofpbuf_put(msg, po->packet, po->packet_len);
+ }
+ update_openflow_length(msg);
+
+ return msg;
+}
+
+/* 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
+/* Allocates and stores in '*bufferp' a new ofpbuf with a size of
+ * 'openflow_len', starting with an OpenFlow header with the given 'type' and
+ * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
+ * zeroed.
+ *
+ * The caller is responsible for freeing '*bufferp' when it is no longer
+ * needed.
+ *
+ * The OpenFlow header length is initially set to 'openflow_len'; if the
+ * message is later extended, the length should be updated with
+ * update_openflow_length() before sending.
+ *
+ * Returns the header. */
+void *
+make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
+{
+ *bufferp = ofpbuf_new(openflow_len);
+ return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
+}
+
+/* Similar to make_openflow() but creates a Nicira vendor extension message
+ * with the specific 'subtype'. 'subtype' should be in host byte order. */
+void *
+make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
+{
+ return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
+}
+
+/* Allocates and stores in '*bufferp' a new ofpbuf with a size of
+ * 'openflow_len', starting with an OpenFlow header with the given 'type' and
+ * transaction id 'xid'. Allocated bytes beyond the header, if any, are