lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <sys/types.h>
  22 #include <netinet/in.h>
  23 #include <netinet/icmp6.h>
  24 #include <stdlib.h>
  25 #include "autopath.h"
  26 #include "bundle.h"
  27 #include "byte-order.h"
  28 #include "classifier.h"
  29 #include "dynamic-string.h"
  30 #include "learn.h"
  31 #include "multipath.h"
  32 #include "nx-match.h"
  33 #include "ofp-errors.h"
  34 #include "ofp-util.h"
  35 #include "ofpbuf.h"
  36 #include "packets.h"
  37 #include "random.h"
  38 #include "unaligned.h"
  39 #include "type-props.h"
  40 #include "vlog.h"
  41
  42 VLOG_DEFINE_THIS_MODULE(ofp_util);
  43
  44 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  45  * in the peer and so there's not much point in showing a lot of them. */
  46 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  47
  48 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
  49  * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
  50  * is wildcarded.
  51  *
  52  * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
  53  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
  54  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
  55  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
  56  * wildcarded. */
  57 ovs_be32
  58 ofputil_wcbits_to_netmask(int wcbits)
  59 {
  60     wcbits &= 0x3f;
  61     return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
  62 }
  63
  64 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
  65  * that it wildcards, that is, the number of 0-bits in 'netmask'.  'netmask'
  66  * must be a CIDR netmask (see ip_is_cidr()). */
  67 int
  68 ofputil_netmask_to_wcbits(ovs_be32 netmask)
  69 {
  70     return 32 - ip_count_cidr_bits(netmask);
  71 }
  72
  73 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
  74  * name. */
  75 #define WC_INVARIANT_LIST \
  76     WC_INVARIANT_BIT(IN_PORT) \
  77     WC_INVARIANT_BIT(DL_SRC) \
  78     WC_INVARIANT_BIT(DL_DST) \
  79     WC_INVARIANT_BIT(DL_TYPE) \
  80     WC_INVARIANT_BIT(NW_PROTO) \
  81     WC_INVARIANT_BIT(TP_SRC) \
  82     WC_INVARIANT_BIT(TP_DST)
  83
  84 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
  85  * actually have the same names and values. */
  86 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
  87     WC_INVARIANT_LIST
  88 #undef WC_INVARIANT_BIT
  89
  90 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
  91  * OR'd together. */
  92 static const flow_wildcards_t WC_INVARIANTS = 0
  93 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
  94     WC_INVARIANT_LIST
  95 #undef WC_INVARIANT_BIT
  96 ;
  97
  98 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
  99  * struct cls_rule.  It is the caller's responsibility to handle the special
 100  * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
 101 void
 102 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
 103 {
 104     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
 105
 106     /* Initialize most of rule->wc. */
 107     flow_wildcards_init_catchall(wc);
 108     wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
 109
 110     /* Wildcard fields that aren't defined by ofp_match or tun_id. */
 111     wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
 112                       | FWW_ND_TARGET | FWW_IPV6_LABEL);
 113
 114     if (ofpfw & OFPFW_NW_TOS) {
 115         /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
 116          * the enum than we can use. */
 117         wc->wildcards |= FWW_NW_DSCP;
 118     }
 119
 120     wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
 121     wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
 122
 123     if (ofpfw & OFPFW_DL_DST) {
 124         /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
 125          * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
 126          * and FWW_ETH_MCAST. */
 127         wc->wildcards |= FWW_ETH_MCAST;
 128     }
 129
 130     /* VLAN TCI mask. */
 131     if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
 132         wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
 133     }
 134     if (!(ofpfw & OFPFW_DL_VLAN)) {
 135         wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
 136     }
 137 }
 138
 139 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
 140  * 'priority'. */
 141 void
 142 ofputil_cls_rule_from_match(const struct ofp_match *match,
 143                             unsigned int priority, struct cls_rule *rule)
 144 {
 145     uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
 146
 147     /* Initialize rule->priority, rule->wc. */
 148     rule->priority = !ofpfw ? UINT16_MAX : priority;
 149     ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
 150
 151     /* Initialize most of rule->flow. */
 152     rule->flow.nw_src = match->nw_src;
 153     rule->flow.nw_dst = match->nw_dst;
 154     rule->flow.in_port = ntohs(match->in_port);
 155     rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
 156     rule->flow.tp_src = match->tp_src;
 157     rule->flow.tp_dst = match->tp_dst;
 158     memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
 159     memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
 160     rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
 161     rule->flow.nw_proto = match->nw_proto;
 162
 163     /* Translate VLANs. */
 164     if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
 165         /* Match only packets without 802.1Q header.
 166          *
 167          * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
 168          *
 169          * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
 170          * because we can't have a specific PCP without an 802.1Q header.
 171          * However, older versions of OVS treated this as matching packets
 172          * withut an 802.1Q header, so we do here too. */
 173         rule->flow.vlan_tci = htons(0);
 174         rule->wc.vlan_tci_mask = htons(0xffff);
 175     } else {
 176         ovs_be16 vid, pcp, tci;
 177
 178         vid = match->dl_vlan & htons(VLAN_VID_MASK);
 179         pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
 180         tci = vid | pcp | htons(VLAN_CFI);
 181         rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
 182     }
 183
 184     /* Clean up. */
 185     cls_rule_zero_wildcarded_fields(rule);
 186 }
 187
 188 /* Convert 'rule' into the OpenFlow match structure 'match'. */
 189 void
 190 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
 191 {
 192     const struct flow_wildcards *wc = &rule->wc;
 193     uint32_t ofpfw;
 194
 195     /* Figure out most OpenFlow wildcards. */
 196     ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
 197     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
 198     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
 199     if (wc->wildcards & FWW_NW_DSCP) {
 200         ofpfw |= OFPFW_NW_TOS;
 201     }
 202
 203     /* Translate VLANs. */
 204     match->dl_vlan = htons(0);
 205     match->dl_vlan_pcp = 0;
 206     if (rule->wc.vlan_tci_mask == htons(0)) {
 207         ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
 208     } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
 209                && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
 210         match->dl_vlan = htons(OFP_VLAN_NONE);
 211     } else {
 212         if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
 213             ofpfw |= OFPFW_DL_VLAN;
 214         } else {
 215             match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
 216         }
 217
 218         if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
 219             ofpfw |= OFPFW_DL_VLAN_PCP;
 220         } else {
 221             match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
 222         }
 223     }
 224
 225     /* Compose most of the match structure. */
 226     match->wildcards = htonl(ofpfw);
 227     match->in_port = htons(rule->flow.in_port);
 228     memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
 229     memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
 230     match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
 231     match->nw_src = rule->flow.nw_src;
 232     match->nw_dst = rule->flow.nw_dst;
 233     match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
 234     match->nw_proto = rule->flow.nw_proto;
 235     match->tp_src = rule->flow.tp_src;
 236     match->tp_dst = rule->flow.tp_dst;
 237     memset(match->pad1, '\0', sizeof match->pad1);
 238     memset(match->pad2, '\0', sizeof match->pad2);
 239 }
 240
 241 /* Given a 'dl_type' value in the format used in struct flow, returns the
 242  * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
 243 ovs_be16
 244 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
 245 {
 246     return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
 247             ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 248             : flow_dl_type);
 249 }
 250
 251 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
 252  * structure, returns the corresponding 'dl_type' value for use in struct
 253  * flow. */
 254 ovs_be16
 255 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
 256 {
 257     return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 258             ? htons(FLOW_DL_TYPE_NONE)
 259             : ofp_dl_type);
 260 }
 261
 262 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
 263 static ovs_be32
 264 alloc_xid(void)
 265 {
 266     static uint32_t next_xid = 1;
 267     return htonl(next_xid++);
 268 }
 269 \f
 270 /* Basic parsing of OpenFlow messages. */
 271
 272 struct ofputil_msg_type {
 273     enum ofputil_msg_code code; /* OFPUTIL_*. */
 274     uint32_t value;             /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
 275     const char *name;           /* e.g. "OFPT_FLOW_REMOVED". */
 276     unsigned int min_size;      /* Minimum total message size in bytes. */
 277     /* 0 if 'min_size' is the exact size that the message must be.  Otherwise,
 278      * the message may exceed 'min_size' by an even multiple of this value. */
 279     unsigned int extra_multiple;
 280 };
 281
 282 /* Represents a malformed OpenFlow message. */
 283 static const struct ofputil_msg_type ofputil_invalid_type = {
 284     OFPUTIL_MSG_INVALID, 0, "OFPUTIL_MSG_INVALID", 0, 0
 285 };
 286
 287 struct ofputil_msg_category {
 288     const char *name;           /* e.g. "OpenFlow message" */
 289     const struct ofputil_msg_type *types;
 290     size_t n_types;
 291     int missing_error;          /* ofp_mkerr() value for missing type. */
 292 };
 293
 294 static int
 295 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
 296 {
 297     switch (type->extra_multiple) {
 298     case 0:
 299         if (size != type->min_size) {
 300             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 301                          "length %u (expected length %u)",
 302                          type->name, size, type->min_size);
 303             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 304         }
 305         return 0;
 306
 307     case 1:
 308         if (size < type->min_size) {
 309             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 310                          "length %u (expected length at least %u bytes)",
 311                          type->name, size, type->min_size);
 312             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 313         }
 314         return 0;
 315
 316     default:
 317         if (size < type->min_size
 318             || (size - type->min_size) % type->extra_multiple) {
 319             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 320                          "length %u (must be exactly %u bytes or longer "
 321                          "by an integer multiple of %u bytes)",
 322                          type->name, size,
 323                          type->min_size, type->extra_multiple);
 324             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 325         }
 326         return 0;
 327     }
 328 }
 329
 330 static int
 331 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
 332                                 uint32_t value,
 333                                 const struct ofputil_msg_type **typep)
 334 {
 335     const struct ofputil_msg_type *type;
 336
 337     for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
 338         if (type->value == value) {
 339             *typep = type;
 340             return 0;
 341         }
 342     }
 343
 344     VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
 345                  cat->name, value);
 346     return cat->missing_error;
 347 }
 348
 349 static int
 350 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
 351                       const struct ofputil_msg_type **typep)
 352 {
 353     static const struct ofputil_msg_type nxt_messages[] = {
 354         { OFPUTIL_NXT_ROLE_REQUEST,
 355           NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
 356           sizeof(struct nx_role_request), 0 },
 357
 358         { OFPUTIL_NXT_ROLE_REPLY,
 359           NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
 360           sizeof(struct nx_role_request), 0 },
 361
 362         { OFPUTIL_NXT_SET_FLOW_FORMAT,
 363           NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
 364           sizeof(struct nxt_set_flow_format), 0 },
 365
 366         { OFPUTIL_NXT_FLOW_MOD,
 367           NXT_FLOW_MOD, "NXT_FLOW_MOD",
 368           sizeof(struct nx_flow_mod), 8 },
 369
 370         { OFPUTIL_NXT_FLOW_REMOVED,
 371           NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
 372           sizeof(struct nx_flow_removed), 8 },
 373
 374         { OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
 375           NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
 376           sizeof(struct nxt_flow_mod_table_id), 0 },
 377     };
 378
 379     static const struct ofputil_msg_category nxt_category = {
 380         "Nicira extension message",
 381         nxt_messages, ARRAY_SIZE(nxt_messages),
 382         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 383     };
 384
 385     const struct ofp_vendor_header *ovh;
 386     const struct nicira_header *nh;
 387
 388     if (length < sizeof(struct ofp_vendor_header)) {
 389         if (length == ntohs(oh->length)) {
 390             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
 391         }
 392         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 393     }
 394
 395     ovh = (const struct ofp_vendor_header *) oh;
 396     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
 397         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
 398                      "vendor %"PRIx32, ntohl(ovh->vendor));
 399         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
 400     }
 401
 402     if (length < sizeof(struct nicira_header)) {
 403         if (length == ntohs(oh->length)) {
 404             VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
 405                          "length %u (expected at least %zu)",
 406                          ntohs(ovh->header.length),
 407                          sizeof(struct nicira_header));
 408         }
 409         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 410     }
 411
 412     nh = (const struct nicira_header *) oh;
 413     return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
 414                                            typep);
 415 }
 416
 417 static int
 418 check_nxstats_msg(const struct ofp_header *oh, size_t length)
 419 {
 420     const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
 421     ovs_be32 vendor;
 422
 423     if (length < sizeof(struct ofp_vendor_stats_msg)) {
 424         if (length == ntohs(oh->length)) {
 425             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
 426         }
 427         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 428     }
 429
 430     memcpy(&vendor, osm + 1, sizeof vendor);
 431     if (vendor != htonl(NX_VENDOR_ID)) {
 432         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
 433                      "unknown vendor %"PRIx32, ntohl(vendor));
 434         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
 435     }
 436
 437     if (length < sizeof(struct nicira_stats_msg)) {
 438         if (length == ntohs(osm->header.length)) {
 439             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
 440         }
 441         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 442     }
 443
 444     return 0;
 445 }
 446
 447 static int
 448 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
 449                             const struct ofputil_msg_type **typep)
 450 {
 451     static const struct ofputil_msg_type nxst_requests[] = {
 452         { OFPUTIL_NXST_FLOW_REQUEST,
 453           NXST_FLOW, "NXST_FLOW request",
 454           sizeof(struct nx_flow_stats_request), 8 },
 455
 456         { OFPUTIL_NXST_AGGREGATE_REQUEST,
 457           NXST_AGGREGATE, "NXST_AGGREGATE request",
 458           sizeof(struct nx_aggregate_stats_request), 8 },
 459     };
 460
 461     static const struct ofputil_msg_category nxst_request_category = {
 462         "Nicira extension statistics request",
 463         nxst_requests, ARRAY_SIZE(nxst_requests),
 464         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 465     };
 466
 467     const struct nicira_stats_msg *nsm;
 468     int error;
 469
 470     error = check_nxstats_msg(oh, length);
 471     if (error) {
 472         return error;
 473     }
 474
 475     nsm = (struct nicira_stats_msg *) oh;
 476     return ofputil_lookup_openflow_message(&nxst_request_category,
 477                                            ntohl(nsm->subtype), typep);
 478 }
 479
 480 static int
 481 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
 482                           const struct ofputil_msg_type **typep)
 483 {
 484     static const struct ofputil_msg_type nxst_replies[] = {
 485         { OFPUTIL_NXST_FLOW_REPLY,
 486           NXST_FLOW, "NXST_FLOW reply",
 487           sizeof(struct nicira_stats_msg), 8 },
 488
 489         { OFPUTIL_NXST_AGGREGATE_REPLY,
 490           NXST_AGGREGATE, "NXST_AGGREGATE reply",
 491           sizeof(struct nx_aggregate_stats_reply), 0 },
 492     };
 493
 494     static const struct ofputil_msg_category nxst_reply_category = {
 495         "Nicira extension statistics reply",
 496         nxst_replies, ARRAY_SIZE(nxst_replies),
 497         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 498     };
 499
 500     const struct nicira_stats_msg *nsm;
 501     int error;
 502
 503     error = check_nxstats_msg(oh, length);
 504     if (error) {
 505         return error;
 506     }
 507
 508     nsm = (struct nicira_stats_msg *) oh;
 509     return ofputil_lookup_openflow_message(&nxst_reply_category,
 510                                            ntohl(nsm->subtype), typep);
 511 }
 512
 513 static int
 514 check_stats_msg(const struct ofp_header *oh, size_t length)
 515 {
 516     if (length < sizeof(struct ofp_stats_msg)) {
 517         if (length == ntohs(oh->length)) {
 518             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
 519         }
 520         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 521     }
 522
 523     return 0;
 524 }
 525
 526 static int
 527 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
 528                              const struct ofputil_msg_type **typep)
 529 {
 530     static const struct ofputil_msg_type ofpst_requests[] = {
 531         { OFPUTIL_OFPST_DESC_REQUEST,
 532           OFPST_DESC, "OFPST_DESC request",
 533           sizeof(struct ofp_stats_msg), 0 },
 534
 535         { OFPUTIL_OFPST_FLOW_REQUEST,
 536           OFPST_FLOW, "OFPST_FLOW request",
 537           sizeof(struct ofp_flow_stats_request), 0 },
 538
 539         { OFPUTIL_OFPST_AGGREGATE_REQUEST,
 540           OFPST_AGGREGATE, "OFPST_AGGREGATE request",
 541           sizeof(struct ofp_flow_stats_request), 0 },
 542
 543         { OFPUTIL_OFPST_TABLE_REQUEST,
 544           OFPST_TABLE, "OFPST_TABLE request",
 545           sizeof(struct ofp_stats_msg), 0 },
 546
 547         { OFPUTIL_OFPST_PORT_REQUEST,
 548           OFPST_PORT, "OFPST_PORT request",
 549           sizeof(struct ofp_port_stats_request), 0 },
 550
 551         { OFPUTIL_OFPST_QUEUE_REQUEST,
 552           OFPST_QUEUE, "OFPST_QUEUE request",
 553           sizeof(struct ofp_queue_stats_request), 0 },
 554
 555         { 0,
 556           OFPST_VENDOR, "OFPST_VENDOR request",
 557           sizeof(struct ofp_vendor_stats_msg), 1 },
 558     };
 559
 560     static const struct ofputil_msg_category ofpst_request_category = {
 561         "OpenFlow statistics",
 562         ofpst_requests, ARRAY_SIZE(ofpst_requests),
 563         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
 564     };
 565
 566     const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
 567     int error;
 568
 569     error = check_stats_msg(oh, length);
 570     if (error) {
 571         return error;
 572     }
 573
 574     error = ofputil_lookup_openflow_message(&ofpst_request_category,
 575                                             ntohs(request->type), typep);
 576     if (!error && request->type == htons(OFPST_VENDOR)) {
 577         error = ofputil_decode_nxst_request(oh, length, typep);
 578     }
 579     return error;
 580 }
 581
 582 static int
 583 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
 584                            const struct ofputil_msg_type **typep)
 585 {
 586     static const struct ofputil_msg_type ofpst_replies[] = {
 587         { OFPUTIL_OFPST_DESC_REPLY,
 588           OFPST_DESC, "OFPST_DESC reply",
 589           sizeof(struct ofp_desc_stats), 0 },
 590
 591         { OFPUTIL_OFPST_FLOW_REPLY,
 592           OFPST_FLOW, "OFPST_FLOW reply",
 593           sizeof(struct ofp_stats_msg), 1 },
 594
 595         { OFPUTIL_OFPST_AGGREGATE_REPLY,
 596           OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
 597           sizeof(struct ofp_aggregate_stats_reply), 0 },
 598
 599         { OFPUTIL_OFPST_TABLE_REPLY,
 600           OFPST_TABLE, "OFPST_TABLE reply",
 601           sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
 602
 603         { OFPUTIL_OFPST_PORT_REPLY,
 604           OFPST_PORT, "OFPST_PORT reply",
 605           sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
 606
 607         { OFPUTIL_OFPST_QUEUE_REPLY,
 608           OFPST_QUEUE, "OFPST_QUEUE reply",
 609           sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
 610
 611         { 0,
 612           OFPST_VENDOR, "OFPST_VENDOR reply",
 613           sizeof(struct ofp_vendor_stats_msg), 1 },
 614     };
 615
 616     static const struct ofputil_msg_category ofpst_reply_category = {
 617         "OpenFlow statistics",
 618         ofpst_replies, ARRAY_SIZE(ofpst_replies),
 619         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
 620     };
 621
 622     const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
 623     int error;
 624
 625     error = check_stats_msg(oh, length);
 626     if (error) {
 627         return error;
 628     }
 629
 630     error = ofputil_lookup_openflow_message(&ofpst_reply_category,
 631                                            ntohs(reply->type), typep);
 632     if (!error && reply->type == htons(OFPST_VENDOR)) {
 633         error = ofputil_decode_nxst_reply(oh, length, typep);
 634     }
 635     return error;
 636 }
 637
 638 static int
 639 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
 640                           const struct ofputil_msg_type **typep)
 641 {
 642     static const struct ofputil_msg_type ofpt_messages[] = {
 643         { OFPUTIL_OFPT_HELLO,
 644           OFPT_HELLO, "OFPT_HELLO",
 645           sizeof(struct ofp_hello), 1 },
 646
 647         { OFPUTIL_OFPT_ERROR,
 648           OFPT_ERROR, "OFPT_ERROR",
 649           sizeof(struct ofp_error_msg), 1 },
 650
 651         { OFPUTIL_OFPT_ECHO_REQUEST,
 652           OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
 653           sizeof(struct ofp_header), 1 },
 654
 655         { OFPUTIL_OFPT_ECHO_REPLY,
 656           OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
 657           sizeof(struct ofp_header), 1 },
 658
 659         { OFPUTIL_OFPT_FEATURES_REQUEST,
 660           OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
 661           sizeof(struct ofp_header), 0 },
 662
 663         { OFPUTIL_OFPT_FEATURES_REPLY,
 664           OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
 665           sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
 666
 667         { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
 668           OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
 669           sizeof(struct ofp_header), 0 },
 670
 671         { OFPUTIL_OFPT_GET_CONFIG_REPLY,
 672           OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
 673           sizeof(struct ofp_switch_config), 0 },
 674
 675         { OFPUTIL_OFPT_SET_CONFIG,
 676           OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
 677           sizeof(struct ofp_switch_config), 0 },
 678
 679         { OFPUTIL_OFPT_PACKET_IN,
 680           OFPT_PACKET_IN, "OFPT_PACKET_IN",
 681           offsetof(struct ofp_packet_in, data), 1 },
 682
 683         { OFPUTIL_OFPT_FLOW_REMOVED,
 684           OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
 685           sizeof(struct ofp_flow_removed), 0 },
 686
 687         { OFPUTIL_OFPT_PORT_STATUS,
 688           OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
 689           sizeof(struct ofp_port_status), 0 },
 690
 691         { OFPUTIL_OFPT_PACKET_OUT,
 692           OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
 693           sizeof(struct ofp_packet_out), 1 },
 694
 695         { OFPUTIL_OFPT_FLOW_MOD,
 696           OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
 697           sizeof(struct ofp_flow_mod), 1 },
 698
 699         { OFPUTIL_OFPT_PORT_MOD,
 700           OFPT_PORT_MOD, "OFPT_PORT_MOD",
 701           sizeof(struct ofp_port_mod), 0 },
 702
 703         { 0,
 704           OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
 705           sizeof(struct ofp_stats_msg), 1 },
 706
 707         { 0,
 708           OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
 709           sizeof(struct ofp_stats_msg), 1 },
 710
 711         { OFPUTIL_OFPT_BARRIER_REQUEST,
 712           OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
 713           sizeof(struct ofp_header), 0 },
 714
 715         { OFPUTIL_OFPT_BARRIER_REPLY,
 716           OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
 717           sizeof(struct ofp_header), 0 },
 718
 719         { 0,
 720           OFPT_VENDOR, "OFPT_VENDOR",
 721           sizeof(struct ofp_vendor_header), 1 },
 722     };
 723
 724     static const struct ofputil_msg_category ofpt_category = {
 725         "OpenFlow message",
 726         ofpt_messages, ARRAY_SIZE(ofpt_messages),
 727         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
 728     };
 729
 730     int error;
 731
 732     error = ofputil_lookup_openflow_message(&ofpt_category, oh->type, typep);
 733     if (!error) {
 734         switch (oh->type) {
 735         case OFPT_VENDOR:
 736             error = ofputil_decode_vendor(oh, length, typep);
 737             break;
 738
 739         case OFPT_STATS_REQUEST:
 740             error = ofputil_decode_ofpst_request(oh, length, typep);
 741             break;
 742
 743         case OFPT_STATS_REPLY:
 744             error = ofputil_decode_ofpst_reply(oh, length, typep);
 745
 746         default:
 747             break;
 748         }
 749     }
 750     return error;
 751 }
 752
 753 /* Decodes the message type represented by 'oh'.  Returns 0 if successful or
 754  * an OpenFlow error code constructed with ofp_mkerr() on failure.  Either
 755  * way, stores in '*typep' a type structure that can be inspected with the
 756  * ofputil_msg_type_*() functions.
 757  *
 758  * oh->length must indicate the correct length of the message (and must be at
 759  * least sizeof(struct ofp_header)).
 760  *
 761  * Success indicates that 'oh' is at least as long as the minimum-length
 762  * message of its type. */
 763 int
 764 ofputil_decode_msg_type(const struct ofp_header *oh,
 765                         const struct ofputil_msg_type **typep)
 766 {
 767     size_t length = ntohs(oh->length);
 768     int error;
 769
 770     error = ofputil_decode_msg_type__(oh, length, typep);
 771     if (!error) {
 772         error = ofputil_check_length(*typep, length);
 773     }
 774     if (error) {
 775         *typep = &ofputil_invalid_type;
 776     }
 777     return error;
 778 }
 779
 780 /* Decodes the message type represented by 'oh', of which only the first
 781  * 'length' bytes are available.  Returns 0 if successful or an OpenFlow error
 782  * code constructed with ofp_mkerr() on failure.  Either way, stores in
 783  * '*typep' a type structure that can be inspected with the
 784  * ofputil_msg_type_*() functions.  */
 785 int
 786 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
 787                                 const struct ofputil_msg_type **typep)
 788 {
 789     int error;
 790
 791     error = (length >= sizeof *oh
 792              ? ofputil_decode_msg_type__(oh, length, typep)
 793              : ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN));
 794     if (error) {
 795         *typep = &ofputil_invalid_type;
 796     }
 797     return error;
 798 }
 799
 800 /* Returns an OFPUTIL_* message type code for 'type'. */
 801 enum ofputil_msg_code
 802 ofputil_msg_type_code(const struct ofputil_msg_type *type)
 803 {
 804     return type->code;
 805 }
 806 \f
 807 /* Flow formats. */
 808
 809 bool
 810 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
 811 {
 812     switch (flow_format) {
 813     case NXFF_OPENFLOW10:
 814     case NXFF_NXM:
 815         return true;
 816     }
 817
 818     return false;
 819 }
 820
 821 const char *
 822 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
 823 {
 824     switch (flow_format) {
 825     case NXFF_OPENFLOW10:
 826         return "openflow10";
 827     case NXFF_NXM:
 828         return "nxm";
 829     default:
 830         NOT_REACHED();
 831     }
 832 }
 833
 834 int
 835 ofputil_flow_format_from_string(const char *s)
 836 {
 837     return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
 838             : !strcmp(s, "nxm") ? NXFF_NXM
 839             : -1);
 840 }
 841
 842 static bool
 843 regs_fully_wildcarded(const struct flow_wildcards *wc)
 844 {
 845     int i;
 846
 847     for (i = 0; i < FLOW_N_REGS; i++) {
 848         if (wc->reg_masks[i] != 0) {
 849             return false;
 850         }
 851     }
 852     return true;
 853 }
 854
 855 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
 856  * (e.g. to add or remove a flow).  Only NXM can handle tunnel IDs, registers,
 857  * or fixing the Ethernet multicast bit.  Otherwise, it's better to use
 858  * NXFF_OPENFLOW10 for backward compatibility. */
 859 enum nx_flow_format
 860 ofputil_min_flow_format(const struct cls_rule *rule)
 861 {
 862     const struct flow_wildcards *wc = &rule->wc;
 863
 864     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 7);
 865
 866     /* Only NXM supports separately wildcards the Ethernet multicast bit. */
 867     if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
 868         return NXFF_NXM;
 869     }
 870
 871     /* Only NXM supports matching ARP hardware addresses. */
 872     if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
 873         return NXFF_NXM;
 874     }
 875
 876     /* Only NXM supports matching IPv6 traffic. */
 877     if (!(wc->wildcards & FWW_DL_TYPE)
 878             && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
 879         return NXFF_NXM;
 880     }
 881
 882     /* Only NXM supports matching registers. */
 883     if (!regs_fully_wildcarded(wc)) {
 884         return NXFF_NXM;
 885     }
 886
 887     /* Only NXM supports matching tun_id. */
 888     if (wc->tun_id_mask != htonll(0)) {
 889         return NXFF_NXM;
 890     }
 891
 892     /* Only NXM supports matching fragments. */
 893     if (wc->nw_frag_mask) {
 894         return NXFF_NXM;
 895     }
 896
 897     /* Only NXM supports matching IPv6 flow label. */
 898     if (!(wc->wildcards & FWW_IPV6_LABEL)) {
 899         return NXFF_NXM;
 900     }
 901
 902     /* Only NXM supports matching IP ECN bits. */
 903     if (!(wc->wildcards & FWW_NW_ECN)) {
 904         return NXFF_NXM;
 905     }
 906
 907     /* Only NXM supports matching IP TTL/hop limit. */
 908     if (!(wc->wildcards & FWW_NW_TTL)) {
 909         return NXFF_NXM;
 910     }
 911
 912     /* Other formats can express this rule. */
 913     return NXFF_OPENFLOW10;
 914 }
 915
 916 /* Returns an OpenFlow message that can be used to set the flow format to
 917  * 'flow_format'.  */
 918 struct ofpbuf *
 919 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
 920 {
 921     struct nxt_set_flow_format *sff;
 922     struct ofpbuf *msg;
 923
 924     sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
 925     sff->format = htonl(flow_format);
 926
 927     return msg;
 928 }
 929
 930 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
 931  * extension on or off (according to 'flow_mod_table_id'). */
 932 struct ofpbuf *
 933 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
 934 {
 935     struct nxt_flow_mod_table_id *nfmti;
 936     struct ofpbuf *msg;
 937
 938     nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
 939     nfmti->set = flow_mod_table_id;
 940     return msg;
 941 }
 942
 943 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
 944  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
 945  * code.
 946  *
 947  * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
 948  * enabled, false otherwise.
 949  *
 950  * Does not validate the flow_mod actions. */
 951 int
 952 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
 953                         const struct ofp_header *oh, bool flow_mod_table_id)
 954 {
 955     const struct ofputil_msg_type *type;
 956     uint16_t command;
 957     struct ofpbuf b;
 958
 959     ofpbuf_use_const(&b, oh, ntohs(oh->length));
 960
 961     ofputil_decode_msg_type(oh, &type);
 962     if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
 963         /* Standard OpenFlow flow_mod. */
 964         const struct ofp_flow_mod *ofm;
 965         uint16_t priority;
 966         int error;
 967
 968         /* Dissect the message. */
 969         ofm = ofpbuf_pull(&b, sizeof *ofm);
 970         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
 971         if (error) {
 972             return error;
 973         }
 974
 975         /* Set priority based on original wildcards.  Normally we'd allow
 976          * ofputil_cls_rule_from_match() to do this for us, but
 977          * ofputil_normalize_rule() can put wildcards where the original flow
 978          * didn't have them. */
 979         priority = ntohs(ofm->priority);
 980         if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
 981             priority = UINT16_MAX;
 982         }
 983
 984         /* Translate the rule. */
 985         ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
 986         ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
 987
 988         /* Translate the message. */
 989         fm->cookie = ofm->cookie;
 990         fm->cookie_mask = htonll(UINT64_MAX);
 991         command = ntohs(ofm->command);
 992         fm->idle_timeout = ntohs(ofm->idle_timeout);
 993         fm->hard_timeout = ntohs(ofm->hard_timeout);
 994         fm->buffer_id = ntohl(ofm->buffer_id);
 995         fm->out_port = ntohs(ofm->out_port);
 996         fm->flags = ntohs(ofm->flags);
 997     } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
 998         /* Nicira extended flow_mod. */
 999         const struct nx_flow_mod *nfm;
1000         int error;
1001
1002         /* Dissect the message. */
1003         nfm = ofpbuf_pull(&b, sizeof *nfm);
1004         error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1005                               &fm->cr, &fm->cookie, &fm->cookie_mask);
1006         if (error) {
1007             return error;
1008         }
1009         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1010         if (error) {
1011             return error;
1012         }
1013
1014         /* Translate the message. */
1015         command = ntohs(nfm->command);
1016         if (command == OFPFC_ADD) {
1017             if (fm->cookie_mask) {
1018                 /* The "NXM_NX_COOKIE*" matches are not valid for flow
1019                  * additions.  Additions must use the "cookie" field of
1020                  * the "nx_flow_mod" structure. */
1021                 return ofp_mkerr(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID);
1022             } else {
1023                 fm->cookie = nfm->cookie;
1024                 fm->cookie_mask = htonll(UINT64_MAX);
1025             }
1026         }
1027         fm->idle_timeout = ntohs(nfm->idle_timeout);
1028         fm->hard_timeout = ntohs(nfm->hard_timeout);
1029         fm->buffer_id = ntohl(nfm->buffer_id);
1030         fm->out_port = ntohs(nfm->out_port);
1031         fm->flags = ntohs(nfm->flags);
1032     } else {
1033         NOT_REACHED();
1034     }
1035
1036     if (flow_mod_table_id) {
1037         fm->command = command & 0xff;
1038         fm->table_id = command >> 8;
1039     } else {
1040         fm->command = command;
1041         fm->table_id = 0xff;
1042     }
1043
1044     return 0;
1045 }
1046
1047 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1048  * 'flow_format' and returns the message.
1049  *
1050  * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
1051  * enabled, false otherwise. */
1052 struct ofpbuf *
1053 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1054                         enum nx_flow_format flow_format,
1055                         bool flow_mod_table_id)
1056 {
1057     size_t actions_len = fm->n_actions * sizeof *fm->actions;
1058     struct ofpbuf *msg;
1059     uint16_t command;
1060
1061     command = (flow_mod_table_id
1062                ? (fm->command & 0xff) | (fm->table_id << 8)
1063                : fm->command);
1064
1065     if (flow_format == NXFF_OPENFLOW10) {
1066         struct ofp_flow_mod *ofm;
1067
1068         msg = ofpbuf_new(sizeof *ofm + actions_len);
1069         ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
1070         ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
1071         ofm->cookie = fm->cookie;
1072         ofm->command = htons(command);
1073         ofm->idle_timeout = htons(fm->idle_timeout);
1074         ofm->hard_timeout = htons(fm->hard_timeout);
1075         ofm->priority = htons(fm->cr.priority);
1076         ofm->buffer_id = htonl(fm->buffer_id);
1077         ofm->out_port = htons(fm->out_port);
1078         ofm->flags = htons(fm->flags);
1079     } else if (flow_format == NXFF_NXM) {
1080         struct nx_flow_mod *nfm;
1081         int match_len;
1082
1083         msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1084         put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1085         nfm = msg->data;
1086         nfm->command = htons(command);
1087         if (command == OFPFC_ADD) {
1088             nfm->cookie = fm->cookie;
1089             match_len = nx_put_match(msg, &fm->cr, 0, 0);
1090         } else {
1091             nfm->cookie = 0;
1092             match_len = nx_put_match(msg, &fm->cr,
1093                                      fm->cookie, fm->cookie_mask);
1094         }
1095         nfm->idle_timeout = htons(fm->idle_timeout);
1096         nfm->hard_timeout = htons(fm->hard_timeout);
1097         nfm->priority = htons(fm->cr.priority);
1098         nfm->buffer_id = htonl(fm->buffer_id);
1099         nfm->out_port = htons(fm->out_port);
1100         nfm->flags = htons(fm->flags);
1101         nfm->match_len = htons(match_len);
1102     } else {
1103         NOT_REACHED();
1104     }
1105
1106     ofpbuf_put(msg, fm->actions, actions_len);
1107     update_openflow_length(msg);
1108     return msg;
1109 }
1110
1111 static int
1112 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1113                                   const struct ofp_header *oh,
1114                                   bool aggregate)
1115 {
1116     const struct ofp_flow_stats_request *ofsr =
1117         (const struct ofp_flow_stats_request *) oh;
1118
1119     fsr->aggregate = aggregate;
1120     ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1121     fsr->out_port = ntohs(ofsr->out_port);
1122     fsr->table_id = ofsr->table_id;
1123     fsr->cookie = fsr->cookie_mask = htonll(0);
1124
1125     return 0;
1126 }
1127
1128 static int
1129 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1130                                  const struct ofp_header *oh,
1131                                  bool aggregate)
1132 {
1133     const struct nx_flow_stats_request *nfsr;
1134     struct ofpbuf b;
1135     int error;
1136
1137     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1138
1139     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1140     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1141                           &fsr->cookie, &fsr->cookie_mask);
1142     if (error) {
1143         return error;
1144     }
1145     if (b.size) {
1146         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1147     }
1148
1149     fsr->aggregate = aggregate;
1150     fsr->out_port = ntohs(nfsr->out_port);
1151     fsr->table_id = nfsr->table_id;
1152
1153     return 0;
1154 }
1155
1156 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1157  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
1158  * successful, otherwise an OpenFlow error code. */
1159 int
1160 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1161                                   const struct ofp_header *oh)
1162 {
1163     const struct ofputil_msg_type *type;
1164     struct ofpbuf b;
1165     int code;
1166
1167     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1168
1169     ofputil_decode_msg_type(oh, &type);
1170     code = ofputil_msg_type_code(type);
1171     switch (code) {
1172     case OFPUTIL_OFPST_FLOW_REQUEST:
1173         return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1174
1175     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1176         return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1177
1178     case OFPUTIL_NXST_FLOW_REQUEST:
1179         return ofputil_decode_nxst_flow_request(fsr, oh, false);
1180
1181     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1182         return ofputil_decode_nxst_flow_request(fsr, oh, true);
1183
1184     default:
1185         /* Hey, the caller lied. */
1186         NOT_REACHED();
1187     }
1188 }
1189
1190 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1191  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1192  * 'flow_format', and returns the message. */
1193 struct ofpbuf *
1194 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1195                                   enum nx_flow_format flow_format)
1196 {
1197     struct ofpbuf *msg;
1198
1199     if (flow_format == NXFF_OPENFLOW10) {
1200         struct ofp_flow_stats_request *ofsr;
1201         int type;
1202
1203         type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1204         ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1205         ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1206         ofsr->table_id = fsr->table_id;
1207         ofsr->out_port = htons(fsr->out_port);
1208     } else if (flow_format == NXFF_NXM) {
1209         struct nx_flow_stats_request *nfsr;
1210         int match_len;
1211         int subtype;
1212
1213         subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1214         ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1215         match_len = nx_put_match(msg, &fsr->match,
1216                                  fsr->cookie, fsr->cookie_mask);
1217
1218         nfsr = msg->data;
1219         nfsr->out_port = htons(fsr->out_port);
1220         nfsr->match_len = htons(match_len);
1221         nfsr->table_id = fsr->table_id;
1222     } else {
1223         NOT_REACHED();
1224     }
1225
1226     return msg;
1227 }
1228
1229 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1230  * ofputil_flow_stats in 'fs'.
1231  *
1232  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1233  * OpenFlow message.  Calling this function multiple times for a single 'msg'
1234  * iterates through the replies.  The caller must initially leave 'msg''s layer
1235  * pointers null and not modify them between calls.
1236  *
1237  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1238  * otherwise a positive errno value. */
1239 int
1240 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1241                                 struct ofpbuf *msg)
1242 {
1243     const struct ofputil_msg_type *type;
1244     int code;
1245
1246     ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1247     code = ofputil_msg_type_code(type);
1248     if (!msg->l2) {
1249         msg->l2 = msg->data;
1250         if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1251             ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1252         } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1253             ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1254         } else {
1255             NOT_REACHED();
1256         }
1257     }
1258
1259     if (!msg->size) {
1260         return EOF;
1261     } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1262         const struct ofp_flow_stats *ofs;
1263         size_t length;
1264
1265         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1266         if (!ofs) {
1267             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1268                          "bytes at end", msg->size);
1269             return EINVAL;
1270         }
1271
1272         length = ntohs(ofs->length);
1273         if (length < sizeof *ofs) {
1274             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1275                          "length %zu", length);
1276             return EINVAL;
1277         }
1278
1279         if (ofputil_pull_actions(msg, length - sizeof *ofs,
1280                                  &fs->actions, &fs->n_actions)) {
1281             return EINVAL;
1282         }
1283
1284         fs->cookie = get_32aligned_be64(&ofs->cookie);
1285         ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1286                                     &fs->rule);
1287         fs->table_id = ofs->table_id;
1288         fs->duration_sec = ntohl(ofs->duration_sec);
1289         fs->duration_nsec = ntohl(ofs->duration_nsec);
1290         fs->idle_timeout = ntohs(ofs->idle_timeout);
1291         fs->hard_timeout = ntohs(ofs->hard_timeout);
1292         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1293         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1294     } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1295         const struct nx_flow_stats *nfs;
1296         size_t match_len, length;
1297
1298         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1299         if (!nfs) {
1300             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1301                          "bytes at end", msg->size);
1302             return EINVAL;
1303         }
1304
1305         length = ntohs(nfs->length);
1306         match_len = ntohs(nfs->match_len);
1307         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1308             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1309                          "claims invalid length %zu", match_len, length);
1310             return EINVAL;
1311         }
1312         if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1313                           NULL, NULL)) {
1314             return EINVAL;
1315         }
1316
1317         if (ofputil_pull_actions(msg,
1318                                  length - sizeof *nfs - ROUND_UP(match_len, 8),
1319                                  &fs->actions, &fs->n_actions)) {
1320             return EINVAL;
1321         }
1322
1323         fs->cookie = nfs->cookie;
1324         fs->table_id = nfs->table_id;
1325         fs->duration_sec = ntohl(nfs->duration_sec);
1326         fs->duration_nsec = ntohl(nfs->duration_nsec);
1327         fs->idle_timeout = ntohs(nfs->idle_timeout);
1328         fs->hard_timeout = ntohs(nfs->hard_timeout);
1329         fs->packet_count = ntohll(nfs->packet_count);
1330         fs->byte_count = ntohll(nfs->byte_count);
1331     } else {
1332         NOT_REACHED();
1333     }
1334
1335     return 0;
1336 }
1337
1338 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1339  *
1340  * We use this in situations where OVS internally uses UINT64_MAX to mean
1341  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1342 static uint64_t
1343 unknown_to_zero(uint64_t count)
1344 {
1345     return count != UINT64_MAX ? count : 0;
1346 }
1347
1348 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1349  * those already present in the list of ofpbufs in 'replies'.  'replies' should
1350  * have been initialized with ofputil_start_stats_reply(). */
1351 void
1352 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1353                                 struct list *replies)
1354 {
1355     size_t act_len = fs->n_actions * sizeof *fs->actions;
1356     const struct ofp_stats_msg *osm;
1357
1358     osm = ofpbuf_from_list(list_back(replies))->data;
1359     if (osm->type == htons(OFPST_FLOW)) {
1360         size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1361         struct ofp_flow_stats *ofs;
1362
1363         ofs = ofputil_append_stats_reply(len, replies);
1364         ofs->length = htons(len);
1365         ofs->table_id = fs->table_id;
1366         ofs->pad = 0;
1367         ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1368         ofs->duration_sec = htonl(fs->duration_sec);
1369         ofs->duration_nsec = htonl(fs->duration_nsec);
1370         ofs->priority = htons(fs->rule.priority);
1371         ofs->idle_timeout = htons(fs->idle_timeout);
1372         ofs->hard_timeout = htons(fs->hard_timeout);
1373         memset(ofs->pad2, 0, sizeof ofs->pad2);
1374         put_32aligned_be64(&ofs->cookie, fs->cookie);
1375         put_32aligned_be64(&ofs->packet_count,
1376                            htonll(unknown_to_zero(fs->packet_count)));
1377         put_32aligned_be64(&ofs->byte_count,
1378                            htonll(unknown_to_zero(fs->byte_count)));
1379         memcpy(ofs->actions, fs->actions, act_len);
1380     } else if (osm->type == htons(OFPST_VENDOR)) {
1381         struct nx_flow_stats *nfs;
1382         struct ofpbuf *msg;
1383         size_t start_len;
1384
1385         msg = ofputil_reserve_stats_reply(
1386             sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1387         start_len = msg->size;
1388
1389         nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1390         nfs->table_id = fs->table_id;
1391         nfs->pad = 0;
1392         nfs->duration_sec = htonl(fs->duration_sec);
1393         nfs->duration_nsec = htonl(fs->duration_nsec);
1394         nfs->priority = htons(fs->rule.priority);
1395         nfs->idle_timeout = htons(fs->idle_timeout);
1396         nfs->hard_timeout = htons(fs->hard_timeout);
1397         nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
1398         memset(nfs->pad2, 0, sizeof nfs->pad2);
1399         nfs->cookie = fs->cookie;
1400         nfs->packet_count = htonll(fs->packet_count);
1401         nfs->byte_count = htonll(fs->byte_count);
1402         ofpbuf_put(msg, fs->actions, act_len);
1403         nfs->length = htons(msg->size - start_len);
1404     } else {
1405         NOT_REACHED();
1406     }
1407 }
1408
1409 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1410  * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */
1411 struct ofpbuf *
1412 ofputil_encode_aggregate_stats_reply(
1413     const struct ofputil_aggregate_stats *stats,
1414     const struct ofp_stats_msg *request)
1415 {
1416     struct ofpbuf *msg;
1417
1418     if (request->type == htons(OFPST_AGGREGATE)) {
1419         struct ofp_aggregate_stats_reply *asr;
1420
1421         asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1422         put_32aligned_be64(&asr->packet_count,
1423                            htonll(unknown_to_zero(stats->packet_count)));
1424         put_32aligned_be64(&asr->byte_count,
1425                            htonll(unknown_to_zero(stats->byte_count)));
1426         asr->flow_count = htonl(stats->flow_count);
1427     } else if (request->type == htons(OFPST_VENDOR)) {
1428         struct nx_aggregate_stats_reply *nasr;
1429
1430         nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1431         assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1432         nasr->packet_count = htonll(stats->packet_count);
1433         nasr->byte_count = htonll(stats->byte_count);
1434         nasr->flow_count = htonl(stats->flow_count);
1435     } else {
1436         NOT_REACHED();
1437     }
1438
1439     return msg;
1440 }
1441
1442 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1443  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
1444  * an OpenFlow error code. */
1445 int
1446 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1447                             const struct ofp_header *oh)
1448 {
1449     const struct ofputil_msg_type *type;
1450     enum ofputil_msg_code code;
1451
1452     ofputil_decode_msg_type(oh, &type);
1453     code = ofputil_msg_type_code(type);
1454     if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1455         const struct ofp_flow_removed *ofr;
1456
1457         ofr = (const struct ofp_flow_removed *) oh;
1458         ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1459                                     &fr->rule);
1460         fr->cookie = ofr->cookie;
1461         fr->reason = ofr->reason;
1462         fr->duration_sec = ntohl(ofr->duration_sec);
1463         fr->duration_nsec = ntohl(ofr->duration_nsec);
1464         fr->idle_timeout = ntohs(ofr->idle_timeout);
1465         fr->packet_count = ntohll(ofr->packet_count);
1466         fr->byte_count = ntohll(ofr->byte_count);
1467     } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1468         struct nx_flow_removed *nfr;
1469         struct ofpbuf b;
1470         int error;
1471
1472         ofpbuf_use_const(&b, oh, ntohs(oh->length));
1473
1474         nfr = ofpbuf_pull(&b, sizeof *nfr);
1475         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1476                               &fr->rule, NULL, NULL);
1477         if (error) {
1478             return error;
1479         }
1480         if (b.size) {
1481             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1482         }
1483
1484         fr->cookie = nfr->cookie;
1485         fr->reason = nfr->reason;
1486         fr->duration_sec = ntohl(nfr->duration_sec);
1487         fr->duration_nsec = ntohl(nfr->duration_nsec);
1488         fr->idle_timeout = ntohs(nfr->idle_timeout);
1489         fr->packet_count = ntohll(nfr->packet_count);
1490         fr->byte_count = ntohll(nfr->byte_count);
1491     } else {
1492         NOT_REACHED();
1493     }
1494
1495     return 0;
1496 }
1497
1498 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1499  * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1500  * message. */
1501 struct ofpbuf *
1502 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1503                             enum nx_flow_format flow_format)
1504 {
1505     struct ofpbuf *msg;
1506
1507     if (flow_format == NXFF_OPENFLOW10) {
1508         struct ofp_flow_removed *ofr;
1509
1510         ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1511                                 &msg);
1512         ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1513         ofr->cookie = fr->cookie;
1514         ofr->priority = htons(fr->rule.priority);
1515         ofr->reason = fr->reason;
1516         ofr->duration_sec = htonl(fr->duration_sec);
1517         ofr->duration_nsec = htonl(fr->duration_nsec);
1518         ofr->idle_timeout = htons(fr->idle_timeout);
1519         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1520         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1521     } else if (flow_format == NXFF_NXM) {
1522         struct nx_flow_removed *nfr;
1523         int match_len;
1524
1525         make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1526         match_len = nx_put_match(msg, &fr->rule, 0, 0);
1527
1528         nfr = msg->data;
1529         nfr->cookie = fr->cookie;
1530         nfr->priority = htons(fr->rule.priority);
1531         nfr->reason = fr->reason;
1532         nfr->duration_sec = htonl(fr->duration_sec);
1533         nfr->duration_nsec = htonl(fr->duration_nsec);
1534         nfr->idle_timeout = htons(fr->idle_timeout);
1535         nfr->match_len = htons(match_len);
1536         nfr->packet_count = htonll(fr->packet_count);
1537         nfr->byte_count = htonll(fr->byte_count);
1538     } else {
1539         NOT_REACHED();
1540     }
1541
1542     return msg;
1543 }
1544
1545 int
1546 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
1547                          const struct ofp_header *oh)
1548 {
1549     const struct ofputil_msg_type *type;
1550     enum ofputil_msg_code code;
1551
1552     ofputil_decode_msg_type(oh, &type);
1553     code = ofputil_msg_type_code(type);
1554     memset(pin, 0, sizeof *pin);
1555
1556     if (code == OFPUTIL_OFPT_PACKET_IN) {
1557         const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
1558
1559         pin->packet = opi->data;
1560         pin->packet_len = ntohs(opi->header.length)
1561             - offsetof(struct ofp_packet_in, data);
1562
1563         pin->in_port = ntohs(opi->in_port);
1564         pin->reason = opi->reason;
1565         pin->buffer_id = ntohl(opi->buffer_id);
1566         pin->total_len = ntohs(opi->total_len);
1567     } else {
1568         NOT_REACHED();
1569     }
1570
1571     return 0;
1572 }
1573
1574 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1575  * and returns the message. */
1576 struct ofpbuf *
1577 ofputil_encode_packet_in(const struct ofputil_packet_in *pin)
1578 {
1579     struct ofp_packet_in opi;
1580     struct ofpbuf *rw_packet;
1581
1582     rw_packet = ofpbuf_clone_data_with_headroom(
1583         pin->packet, MIN(pin->send_len, pin->packet_len),
1584         offsetof(struct ofp_packet_in, data));
1585
1586     /* Add OFPT_PACKET_IN. */
1587     memset(&opi, 0, sizeof opi);
1588     opi.header.version = OFP_VERSION;
1589     opi.header.type = OFPT_PACKET_IN;
1590     opi.total_len = htons(pin->packet_len);
1591     opi.in_port = htons(pin->in_port);
1592     opi.reason = pin->reason;
1593     opi.buffer_id = htonl(pin->buffer_id);
1594     ofpbuf_push(rw_packet, &opi, offsetof(struct ofp_packet_in, data));
1595     update_openflow_length(rw_packet);
1596
1597     return rw_packet;
1598 }
1599
1600 /* Returns a string representing the message type of 'type'.  The string is the
1601  * enumeration constant for the type, e.g. "OFPT_HELLO".  For statistics
1602  * messages, the constant is followed by "request" or "reply",
1603  * e.g. "OFPST_AGGREGATE reply". */
1604 const char *
1605 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1606 {
1607     return type->name;
1608 }
1609 \f
1610 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1611  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1612  * an arbitrary transaction id.  Allocated bytes beyond the header, if any, are
1613  * zeroed.
1614  *
1615  * The caller is responsible for freeing '*bufferp' when it is no longer
1616  * needed.
1617  *
1618  * The OpenFlow header length is initially set to 'openflow_len'; if the
1619  * message is later extended, the length should be updated with
1620  * update_openflow_length() before sending.
1621  *
1622  * Returns the header. */
1623 void *
1624 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1625 {
1626     *bufferp = ofpbuf_new(openflow_len);
1627     return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1628 }
1629
1630 /* Similar to make_openflow() but creates a Nicira vendor extension message
1631  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1632 void *
1633 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1634 {
1635     return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1636 }
1637
1638 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1639  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1640  * transaction id 'xid'.  Allocated bytes beyond the header, if any, are
1641  * zeroed.
1642  *
1643  * The caller is responsible for freeing '*bufferp' when it is no longer
1644  * needed.
1645  *
1646  * The OpenFlow header length is initially set to 'openflow_len'; if the
1647  * message is later extended, the length should be updated with
1648  * update_openflow_length() before sending.
1649  *
1650  * Returns the header. */
1651 void *
1652 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1653                   struct ofpbuf **bufferp)
1654 {
1655     *bufferp = ofpbuf_new(openflow_len);
1656     return put_openflow_xid(openflow_len, type, xid, *bufferp);
1657 }
1658
1659 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1660  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1661 void *
1662 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1663                struct ofpbuf **bufferp)
1664 {
1665     *bufferp = ofpbuf_new(openflow_len);
1666     return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1667 }
1668
1669 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1670  * with the given 'type' and an arbitrary transaction id.  Allocated bytes
1671  * beyond the header, if any, are zeroed.
1672  *
1673  * The OpenFlow header length is initially set to 'openflow_len'; if the
1674  * message is later extended, the length should be updated with
1675  * update_openflow_length() before sending.
1676  *
1677  * Returns the header. */
1678 void *
1679 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1680 {
1681     return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1682 }
1683
1684 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1685  * with the given 'type' and an transaction id 'xid'.  Allocated bytes beyond
1686  * the header, if any, are zeroed.
1687  *
1688  * The OpenFlow header length is initially set to 'openflow_len'; if the
1689  * message is later extended, the length should be updated with
1690  * update_openflow_length() before sending.
1691  *
1692  * Returns the header. */
1693 void *
1694 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1695                  struct ofpbuf *buffer)
1696 {
1697     struct ofp_header *oh;
1698
1699     assert(openflow_len >= sizeof *oh);
1700     assert(openflow_len <= UINT16_MAX);
1701
1702     oh = ofpbuf_put_uninit(buffer, openflow_len);
1703     oh->version = OFP_VERSION;
1704     oh->type = type;
1705     oh->length = htons(openflow_len);
1706     oh->xid = xid;
1707     memset(oh + 1, 0, openflow_len - sizeof *oh);
1708     return oh;
1709 }
1710
1711 /* Similar to put_openflow() but append a Nicira vendor extension message with
1712  * the specific 'subtype'.  'subtype' should be in host byte order. */
1713 void *
1714 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1715 {
1716     return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1717 }
1718
1719 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1720  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1721 void *
1722 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1723               struct ofpbuf *buffer)
1724 {
1725     struct nicira_header *nxh;
1726
1727     nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1728     nxh->vendor = htonl(NX_VENDOR_ID);
1729     nxh->subtype = htonl(subtype);
1730     return nxh;
1731 }
1732
1733 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1734  * 'buffer->size'. */
1735 void
1736 update_openflow_length(struct ofpbuf *buffer)
1737 {
1738     struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1739     oh->length = htons(buffer->size);
1740 }
1741
1742 static void
1743 put_stats__(ovs_be32 xid, uint8_t ofp_type,
1744             ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
1745             struct ofpbuf *msg)
1746 {
1747     if (ofpst_type == htons(OFPST_VENDOR)) {
1748         struct nicira_stats_msg *nsm;
1749
1750         nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
1751         nsm->vsm.osm.type = ofpst_type;
1752         nsm->vsm.vendor = htonl(NX_VENDOR_ID);
1753         nsm->subtype = nxst_subtype;
1754     } else {
1755         struct ofp_stats_msg *osm;
1756
1757         osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
1758         osm->type = ofpst_type;
1759     }
1760 }
1761
1762 /* Creates a statistics request message with total length 'openflow_len'
1763  * (including all headers) and the given 'ofpst_type', and stores the buffer
1764  * containing the new message in '*bufferp'.  If 'ofpst_type' is OFPST_VENDOR
1765  * then 'nxst_subtype' is used as the Nicira vendor extension statistics
1766  * subtype (otherwise 'nxst_subtype' is ignored).
1767  *
1768  * Initializes bytes following the headers to all-bits-zero.
1769  *
1770  * Returns the first byte of the new message. */
1771 void *
1772 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
1773                            uint32_t nxst_subtype, struct ofpbuf **bufferp)
1774 {
1775     struct ofpbuf *msg;
1776
1777     msg = *bufferp = ofpbuf_new(openflow_len);
1778     put_stats__(alloc_xid(), OFPT_STATS_REQUEST,
1779                 htons(ofpst_type), htonl(nxst_subtype), msg);
1780     ofpbuf_padto(msg, openflow_len);
1781
1782     return msg->data;
1783 }
1784
1785 static void
1786 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
1787 {
1788     assert(request->header.type == OFPT_STATS_REQUEST ||
1789            request->header.type == OFPT_STATS_REPLY);
1790     put_stats__(request->header.xid, OFPT_STATS_REPLY, request->type,
1791                 (request->type != htons(OFPST_VENDOR)
1792                  ? htonl(0)
1793                  : ((const struct nicira_stats_msg *) request)->subtype),
1794                 msg);
1795 }
1796
1797 /* Creates a statistics reply message with total length 'openflow_len'
1798  * (including all headers) and the same type (either a standard OpenFlow
1799  * statistics type or a Nicira extension type and subtype) as 'request', and
1800  * stores the buffer containing the new message in '*bufferp'.
1801  *
1802  * Initializes bytes following the headers to all-bits-zero.
1803  *
1804  * Returns the first byte of the new message. */
1805 void *
1806 ofputil_make_stats_reply(size_t openflow_len,
1807                          const struct ofp_stats_msg *request,
1808                          struct ofpbuf **bufferp)
1809 {
1810     struct ofpbuf *msg;
1811
1812     msg = *bufferp = ofpbuf_new(openflow_len);
1813     put_stats_reply__(request, msg);
1814     ofpbuf_padto(msg, openflow_len);
1815
1816     return msg->data;
1817 }
1818
1819 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
1820  * replies to 'request', which should be an OpenFlow or Nicira extension
1821  * statistics request.  Initially 'replies' will have a single reply message
1822  * that has only a header.  The functions ofputil_reserve_stats_reply() and
1823  * ofputil_append_stats_reply() may be used to add to the reply. */
1824 void
1825 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
1826                           struct list *replies)
1827 {
1828     struct ofpbuf *msg;
1829
1830     msg = ofpbuf_new(1024);
1831     put_stats_reply__(request, msg);
1832
1833     list_init(replies);
1834     list_push_back(replies, &msg->list_node);
1835 }
1836
1837 /* Prepares to append up to 'len' bytes to the series of statistics replies in
1838  * 'replies', which should have been initialized with
1839  * ofputil_start_stats_reply().  Returns an ofpbuf with at least 'len' bytes of
1840  * tailroom.  (The 'len' bytes have not actually be allocated; the caller must
1841  * do so with e.g. ofpbuf_put_uninit().) */
1842 struct ofpbuf *
1843 ofputil_reserve_stats_reply(size_t len, struct list *replies)
1844 {
1845     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1846     struct ofp_stats_msg *osm = msg->data;
1847
1848     if (msg->size + len <= UINT16_MAX) {
1849         ofpbuf_prealloc_tailroom(msg, len);
1850     } else {
1851         osm->flags |= htons(OFPSF_REPLY_MORE);
1852
1853         msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
1854         put_stats_reply__(osm, msg);
1855         list_push_back(replies, &msg->list_node);
1856     }
1857     return msg;
1858 }
1859
1860 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
1861  * returns the first byte. */
1862 void *
1863 ofputil_append_stats_reply(size_t len, struct list *replies)
1864 {
1865     return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
1866 }
1867
1868 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
1869 const void *
1870 ofputil_stats_body(const struct ofp_header *oh)
1871 {
1872     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1873     return (const struct ofp_stats_msg *) oh + 1;
1874 }
1875
1876 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
1877 size_t
1878 ofputil_stats_body_len(const struct ofp_header *oh)
1879 {
1880     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1881     return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
1882 }
1883
1884 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
1885 const void *
1886 ofputil_nxstats_body(const struct ofp_header *oh)
1887 {
1888     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1889     return ((const struct nicira_stats_msg *) oh) + 1;
1890 }
1891
1892 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
1893 size_t
1894 ofputil_nxstats_body_len(const struct ofp_header *oh)
1895 {
1896     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1897     return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1898 }
1899
1900 struct ofpbuf *
1901 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1902               size_t actions_len)
1903 {
1904     struct ofp_flow_mod *ofm;
1905     size_t size = sizeof *ofm + actions_len;
1906     struct ofpbuf *out = ofpbuf_new(size);
1907     ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1908     ofm->header.version = OFP_VERSION;
1909     ofm->header.type = OFPT_FLOW_MOD;
1910     ofm->header.length = htons(size);
1911     ofm->cookie = 0;
1912     ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1913     ofputil_cls_rule_to_match(rule, &ofm->match);
1914     ofm->command = htons(command);
1915     return out;
1916 }
1917
1918 struct ofpbuf *
1919 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1920               uint16_t idle_timeout, size_t actions_len)
1921 {
1922     struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1923     struct ofp_flow_mod *ofm = out->data;
1924     ofm->idle_timeout = htons(idle_timeout);
1925     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1926     ofm->buffer_id = htonl(buffer_id);
1927     return out;
1928 }
1929
1930 struct ofpbuf *
1931 make_del_flow(const struct cls_rule *rule)
1932 {
1933     struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1934     struct ofp_flow_mod *ofm = out->data;
1935     ofm->out_port = htons(OFPP_NONE);
1936     return out;
1937 }
1938
1939 struct ofpbuf *
1940 make_add_simple_flow(const struct cls_rule *rule,
1941                      uint32_t buffer_id, uint16_t out_port,
1942                      uint16_t idle_timeout)
1943 {
1944     if (out_port != OFPP_NONE) {
1945         struct ofp_action_output *oao;
1946         struct ofpbuf *buffer;
1947
1948         buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1949         ofputil_put_OFPAT_OUTPUT(buffer)->port = htons(out_port);
1950         return buffer;
1951     } else {
1952         return make_add_flow(rule, buffer_id, idle_timeout, 0);
1953     }
1954 }
1955
1956 struct ofpbuf *
1957 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1958                const struct ofpbuf *payload, int max_send_len)
1959 {
1960     struct ofp_packet_in *opi;
1961     struct ofpbuf *buf;
1962     int send_len;
1963
1964     send_len = MIN(max_send_len, payload->size);
1965     buf = ofpbuf_new(sizeof *opi + send_len);
1966     opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1967                            OFPT_PACKET_IN, 0, buf);
1968     opi->buffer_id = htonl(buffer_id);
1969     opi->total_len = htons(payload->size);
1970     opi->in_port = htons(in_port);
1971     opi->reason = reason;
1972     ofpbuf_put(buf, payload->data, send_len);
1973     update_openflow_length(buf);
1974
1975     return buf;
1976 }
1977
1978 struct ofpbuf *
1979 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1980                 uint16_t in_port,
1981                 const struct ofp_action_header *actions, size_t n_actions)
1982 {
1983     size_t actions_len = n_actions * sizeof *actions;
1984     struct ofp_packet_out *opo;
1985     size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1986     struct ofpbuf *out = ofpbuf_new(size);
1987
1988     opo = ofpbuf_put_uninit(out, sizeof *opo);
1989     opo->header.version = OFP_VERSION;
1990     opo->header.type = OFPT_PACKET_OUT;
1991     opo->header.length = htons(size);
1992     opo->header.xid = htonl(0);
1993     opo->buffer_id = htonl(buffer_id);
1994     opo->in_port = htons(in_port);
1995     opo->actions_len = htons(actions_len);
1996     ofpbuf_put(out, actions, actions_len);
1997     if (packet) {
1998         ofpbuf_put(out, packet->data, packet->size);
1999     }
2000     return out;
2001 }
2002
2003 struct ofpbuf *
2004 make_unbuffered_packet_out(const struct ofpbuf *packet,
2005                            uint16_t in_port, uint16_t out_port)
2006 {
2007     struct ofp_action_output action;
2008     action.type = htons(OFPAT_OUTPUT);
2009     action.len = htons(sizeof action);
2010     action.port = htons(out_port);
2011     return make_packet_out(packet, UINT32_MAX, in_port,
2012                            (struct ofp_action_header *) &action, 1);
2013 }
2014
2015 struct ofpbuf *
2016 make_buffered_packet_out(uint32_t buffer_id,
2017                          uint16_t in_port, uint16_t out_port)
2018 {
2019     if (out_port != OFPP_NONE) {
2020         struct ofp_action_output action;
2021         action.type = htons(OFPAT_OUTPUT);
2022         action.len = htons(sizeof action);
2023         action.port = htons(out_port);
2024         return make_packet_out(NULL, buffer_id, in_port,
2025                                (struct ofp_action_header *) &action, 1);
2026     } else {
2027         return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
2028     }
2029 }
2030
2031 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
2032 struct ofpbuf *
2033 make_echo_request(void)
2034 {
2035     struct ofp_header *rq;
2036     struct ofpbuf *out = ofpbuf_new(sizeof *rq);
2037     rq = ofpbuf_put_uninit(out, sizeof *rq);
2038     rq->version = OFP_VERSION;
2039     rq->type = OFPT_ECHO_REQUEST;
2040     rq->length = htons(sizeof *rq);
2041     rq->xid = htonl(0);
2042     return out;
2043 }
2044
2045 /* Creates and returns an OFPT_ECHO_REPLY message matching the
2046  * OFPT_ECHO_REQUEST message in 'rq'. */
2047 struct ofpbuf *
2048 make_echo_reply(const struct ofp_header *rq)
2049 {
2050     size_t size = ntohs(rq->length);
2051     struct ofpbuf *out = ofpbuf_new(size);
2052     struct ofp_header *reply = ofpbuf_put(out, rq, size);
2053     reply->type = OFPT_ECHO_REPLY;
2054     return out;
2055 }
2056
2057 const char *
2058 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
2059 {
2060     switch (flags & OFPC_FRAG_MASK) {
2061     case OFPC_FRAG_NORMAL:   return "normal";
2062     case OFPC_FRAG_DROP:     return "drop";
2063     case OFPC_FRAG_REASM:    return "reassemble";
2064     case OFPC_FRAG_NX_MATCH: return "nx-match";
2065     }
2066
2067     NOT_REACHED();
2068 }
2069
2070 bool
2071 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
2072 {
2073     if (!strcasecmp(s, "normal")) {
2074         *flags = OFPC_FRAG_NORMAL;
2075     } else if (!strcasecmp(s, "drop")) {
2076         *flags = OFPC_FRAG_DROP;
2077     } else if (!strcasecmp(s, "reassemble")) {
2078         *flags = OFPC_FRAG_REASM;
2079     } else if (!strcasecmp(s, "nx-match")) {
2080         *flags = OFPC_FRAG_NX_MATCH;
2081     } else {
2082         return false;
2083     }
2084     return true;
2085 }
2086
2087 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
2088  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
2089  * 'port' is valid, otherwise an ofp_mkerr() return code. */
2090 int
2091 ofputil_check_output_port(uint16_t port, int max_ports)
2092 {
2093     switch (port) {
2094     case OFPP_IN_PORT:
2095     case OFPP_TABLE:
2096     case OFPP_NORMAL:
2097     case OFPP_FLOOD:
2098     case OFPP_ALL:
2099     case OFPP_CONTROLLER:
2100     case OFPP_LOCAL:
2101         return 0;
2102
2103     default:
2104         if (port < max_ports) {
2105             return 0;
2106         }
2107         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
2108     }
2109 }
2110
2111 #define OFPUTIL_NAMED_PORTS                     \
2112         OFPUTIL_NAMED_PORT(IN_PORT)             \
2113         OFPUTIL_NAMED_PORT(TABLE)               \
2114         OFPUTIL_NAMED_PORT(NORMAL)              \
2115         OFPUTIL_NAMED_PORT(FLOOD)               \
2116         OFPUTIL_NAMED_PORT(ALL)                 \
2117         OFPUTIL_NAMED_PORT(CONTROLLER)          \
2118         OFPUTIL_NAMED_PORT(LOCAL)               \
2119         OFPUTIL_NAMED_PORT(NONE)
2120
2121 /* Checks whether 's' is the string representation of an OpenFlow port number,
2122  * either as an integer or a string name (e.g. "LOCAL").  If it is, stores the
2123  * number in '*port' and returns true.  Otherwise, returns false. */
2124 bool
2125 ofputil_port_from_string(const char *name, uint16_t *port)
2126 {
2127     struct pair {
2128         const char *name;
2129         uint16_t value;
2130     };
2131     static const struct pair pairs[] = {
2132 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
2133         OFPUTIL_NAMED_PORTS
2134 #undef OFPUTIL_NAMED_PORT
2135     };
2136     static const int n_pairs = ARRAY_SIZE(pairs);
2137     int i;
2138
2139     if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
2140         *port = i;
2141         return true;
2142     }
2143
2144     for (i = 0; i < n_pairs; i++) {
2145         if (!strcasecmp(name, pairs[i].name)) {
2146             *port = pairs[i].value;
2147             return true;
2148         }
2149     }
2150     return false;
2151 }
2152
2153 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
2154  * Most ports' string representation is just the port number, but for special
2155  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
2156 void
2157 ofputil_format_port(uint16_t port, struct ds *s)
2158 {
2159     const char *name;
2160
2161     switch (port) {
2162 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
2163         OFPUTIL_NAMED_PORTS
2164 #undef OFPUTIL_NAMED_PORT
2165
2166     default:
2167         ds_put_format(s, "%"PRIu16, port);
2168         return;
2169     }
2170     ds_put_cstr(s, name);
2171 }
2172
2173 static int
2174 check_resubmit_table(const struct nx_action_resubmit *nar)
2175 {
2176     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
2177         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2178     }
2179     return 0;
2180 }
2181
2182 static int
2183 check_output_reg(const struct nx_action_output_reg *naor,
2184                  const struct flow *flow)
2185 {
2186     size_t i;
2187
2188     for (i = 0; i < sizeof naor->zero; i++) {
2189         if (naor->zero[i]) {
2190             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2191         }
2192     }
2193
2194     return nxm_src_check(naor->src, nxm_decode_ofs(naor->ofs_nbits),
2195                          nxm_decode_n_bits(naor->ofs_nbits), flow);
2196 }
2197
2198 int
2199 validate_actions(const union ofp_action *actions, size_t n_actions,
2200                  const struct flow *flow, int max_ports)
2201 {
2202     const union ofp_action *a;
2203     size_t left;
2204
2205     OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
2206         uint16_t port;
2207         int error;
2208         int code;
2209
2210         code = ofputil_decode_action(a);
2211         if (code < 0) {
2212             char *msg;
2213
2214             error = -code;
2215             msg = ofputil_error_to_string(error);
2216             VLOG_WARN_RL(&bad_ofmsg_rl,
2217                          "action decoding error at offset %td (%s)",
2218                          (a - actions) * sizeof *a, msg);
2219             free(msg);
2220
2221             return error;
2222         }
2223
2224         error = 0;
2225         switch ((enum ofputil_action_code) code) {
2226         case OFPUTIL_OFPAT_OUTPUT:
2227             error = ofputil_check_output_port(ntohs(a->output.port),
2228                                               max_ports);
2229             break;
2230
2231         case OFPUTIL_OFPAT_SET_VLAN_VID:
2232             if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
2233                 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2234             }
2235             break;
2236
2237         case OFPUTIL_OFPAT_SET_VLAN_PCP:
2238             if (a->vlan_pcp.vlan_pcp & ~7) {
2239                 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2240             }
2241             break;
2242
2243         case OFPUTIL_OFPAT_ENQUEUE:
2244             port = ntohs(((const struct ofp_action_enqueue *) a)->port);
2245             if (port >= max_ports && port != OFPP_IN_PORT
2246                 && port != OFPP_LOCAL) {
2247                 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
2248             }
2249             break;
2250
2251         case OFPUTIL_NXAST_REG_MOVE:
2252             error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
2253                                        flow);
2254             break;
2255
2256         case OFPUTIL_NXAST_REG_LOAD:
2257             error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
2258                                        flow);
2259             break;
2260
2261         case OFPUTIL_NXAST_MULTIPATH:
2262             error = multipath_check((const struct nx_action_multipath *) a,
2263                                     flow);
2264             break;
2265
2266         case OFPUTIL_NXAST_AUTOPATH:
2267             error = autopath_check((const struct nx_action_autopath *) a,
2268                                    flow);
2269             break;
2270
2271         case OFPUTIL_NXAST_BUNDLE:
2272         case OFPUTIL_NXAST_BUNDLE_LOAD:
2273             error = bundle_check((const struct nx_action_bundle *) a,
2274                                  max_ports, flow);
2275             break;
2276
2277         case OFPUTIL_NXAST_OUTPUT_REG:
2278             error = check_output_reg((const struct nx_action_output_reg *) a,
2279                                      flow);
2280             break;
2281
2282         case OFPUTIL_NXAST_RESUBMIT_TABLE:
2283             error = check_resubmit_table(
2284                 (const struct nx_action_resubmit *) a);
2285             break;
2286
2287         case OFPUTIL_NXAST_LEARN:
2288             error = learn_check((const struct nx_action_learn *) a, flow);
2289             break;
2290
2291         case OFPUTIL_OFPAT_STRIP_VLAN:
2292         case OFPUTIL_OFPAT_SET_NW_SRC:
2293         case OFPUTIL_OFPAT_SET_NW_DST:
2294         case OFPUTIL_OFPAT_SET_NW_TOS:
2295         case OFPUTIL_OFPAT_SET_TP_SRC:
2296         case OFPUTIL_OFPAT_SET_TP_DST:
2297         case OFPUTIL_OFPAT_SET_DL_SRC:
2298         case OFPUTIL_OFPAT_SET_DL_DST:
2299         case OFPUTIL_NXAST_RESUBMIT:
2300         case OFPUTIL_NXAST_SET_TUNNEL:
2301         case OFPUTIL_NXAST_SET_QUEUE:
2302         case OFPUTIL_NXAST_POP_QUEUE:
2303         case OFPUTIL_NXAST_NOTE:
2304         case OFPUTIL_NXAST_SET_TUNNEL64:
2305         case OFPUTIL_NXAST_EXIT:
2306             break;
2307         }
2308
2309         if (error) {
2310             char *msg = ofputil_error_to_string(error);
2311             VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
2312                          (a - actions) * sizeof *a, msg);
2313             free(msg);
2314             return error;
2315         }
2316     }
2317     if (left) {
2318         VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
2319                      (n_actions - left) * sizeof *a);
2320         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2321     }
2322     return 0;
2323 }
2324
2325 struct ofputil_action {
2326     int code;
2327     unsigned int min_len;
2328     unsigned int max_len;
2329 };
2330
2331 static const struct ofputil_action action_bad_type
2332     = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE),   0, UINT_MAX };
2333 static const struct ofputil_action action_bad_len
2334     = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_LEN),    0, UINT_MAX };
2335 static const struct ofputil_action action_bad_vendor
2336     = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR), 0, UINT_MAX };
2337
2338 static const struct ofputil_action *
2339 ofputil_decode_ofpat_action(const union ofp_action *a)
2340 {
2341     enum ofp_action_type type = ntohs(a->type);
2342
2343     switch (type) {
2344 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                    \
2345         case ENUM: {                                        \
2346             static const struct ofputil_action action = {   \
2347                 OFPUTIL_##ENUM,                             \
2348                 sizeof(struct STRUCT),                      \
2349                 sizeof(struct STRUCT)                       \
2350             };                                              \
2351             return &action;                                 \
2352         }
2353 #include "ofp-util.def"
2354
2355     case OFPAT_VENDOR:
2356     default:
2357         return &action_bad_type;
2358     }
2359 }
2360
2361 static const struct ofputil_action *
2362 ofputil_decode_nxast_action(const union ofp_action *a)
2363 {
2364     const struct nx_action_header *nah = (const struct nx_action_header *) a;
2365     enum nx_action_subtype subtype = ntohs(nah->subtype);
2366
2367     switch (subtype) {
2368 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
2369         case ENUM: {                                            \
2370             static const struct ofputil_action action = {       \
2371                 OFPUTIL_##ENUM,                                 \
2372                 sizeof(struct STRUCT),                          \
2373                 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT)   \
2374             };                                                  \
2375             return &action;                                     \
2376         }
2377 #include "ofp-util.def"
2378
2379     case NXAST_SNAT__OBSOLETE:
2380     case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
2381     default:
2382         return &action_bad_type;
2383     }
2384 }
2385
2386 /* Parses 'a' to determine its type.  Returns a nonnegative OFPUTIL_OFPAT_* or
2387  * OFPUTIL_NXAST_* constant if successful, otherwise a negative OpenFlow error
2388  * code (as returned by ofp_mkerr()).
2389  *
2390  * The caller must have already verified that 'a''s length is correct (that is,
2391  * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
2392  * longer than the amount of space allocated to 'a').
2393  *
2394  * This function verifies that 'a''s length is correct for the type of action
2395  * that it represents. */
2396 int
2397 ofputil_decode_action(const union ofp_action *a)
2398 {
2399     const struct ofputil_action *action;
2400     uint16_t len = ntohs(a->header.len);
2401
2402     if (a->type != htons(OFPAT_VENDOR)) {
2403         action = ofputil_decode_ofpat_action(a);
2404     } else {
2405         switch (ntohl(a->vendor.vendor)) {
2406         case NX_VENDOR_ID:
2407             if (len < sizeof(struct nx_action_header)) {
2408                 return -ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2409             }
2410             action = ofputil_decode_nxast_action(a);
2411             break;
2412         default:
2413             action = &action_bad_vendor;
2414             break;
2415         }
2416     }
2417
2418     return (len >= action->min_len && len <= action->max_len
2419             ? action->code
2420             : -ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN));
2421 }
2422
2423 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT_* or OFPUTIL_NXAST_*
2424  * constant.  The caller must have already validated that 'a' is a valid action
2425  * understood by Open vSwitch (e.g. by a previous successful call to
2426  * ofputil_decode_action()). */
2427 enum ofputil_action_code
2428 ofputil_decode_action_unsafe(const union ofp_action *a)
2429 {
2430     const struct ofputil_action *action;
2431
2432     if (a->type != htons(OFPAT_VENDOR)) {
2433         action = ofputil_decode_ofpat_action(a);
2434     } else {
2435         action = ofputil_decode_nxast_action(a);
2436     }
2437
2438     return action->code;
2439 }
2440
2441 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
2442  * 'name' is "output" then the return value is OFPUTIL_OFPAT_OUTPUT), or -1 if
2443  * 'name' is not the name of any action.
2444  *
2445  * ofp-util.def lists the mapping from names to action. */
2446 int
2447 ofputil_action_code_from_name(const char *name)
2448 {
2449     static const char *names[OFPUTIL_N_ACTIONS] = {
2450 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             NAME,
2451 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
2452 #include "ofp-util.def"
2453     };
2454
2455     const char **p;
2456
2457     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
2458         if (*p && !strcasecmp(name, *p)) {
2459             return p - names;
2460         }
2461     }
2462     return -1;
2463 }
2464
2465 /* Appends an action of the type specified by 'code' to 'buf' and returns the
2466  * action.  Initializes the parts of 'action' that identify it as having type
2467  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
2468  * have variable length, the length used and cleared is that of struct
2469  * <STRUCT>.  */
2470 void *
2471 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
2472 {
2473     switch (code) {
2474 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                    \
2475     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2476 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
2477     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2478 #include "ofp-util.def"
2479     }
2480     NOT_REACHED();
2481 }
2482
2483 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                        \
2484     void                                                        \
2485     ofputil_init_##ENUM(struct STRUCT *s)                       \
2486     {                                                           \
2487         memset(s, 0, sizeof *s);                                \
2488         s->type = htons(ENUM);                                  \
2489         s->len = htons(sizeof *s);                              \
2490     }                                                           \
2491                                                                 \
2492     struct STRUCT *                                             \
2493     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
2494     {                                                           \
2495         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
2496         ofputil_init_##ENUM(s);                                 \
2497         return s;                                               \
2498     }
2499 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
2500     void                                                        \
2501     ofputil_init_##ENUM(struct STRUCT *s)                       \
2502     {                                                           \
2503         memset(s, 0, sizeof *s);                                \
2504         s->type = htons(OFPAT_VENDOR);                          \
2505         s->len = htons(sizeof *s);                              \
2506         s->vendor = htonl(NX_VENDOR_ID);                        \
2507         s->subtype = htons(ENUM);                               \
2508     }                                                           \
2509                                                                 \
2510     struct STRUCT *                                             \
2511     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
2512     {                                                           \
2513         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
2514         ofputil_init_##ENUM(s);                                 \
2515         return s;                                               \
2516     }
2517 #include "ofp-util.def"
2518
2519 /* Returns true if 'action' outputs to 'port', false otherwise. */
2520 bool
2521 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2522 {
2523     switch (ntohs(action->type)) {
2524     case OFPAT_OUTPUT:
2525         return action->output.port == port;
2526     case OFPAT_ENQUEUE:
2527         return ((const struct ofp_action_enqueue *) action)->port == port;
2528     default:
2529         return false;
2530     }
2531 }
2532
2533 /* "Normalizes" the wildcards in 'rule'.  That means:
2534  *
2535  *    1. If the type of level N is known, then only the valid fields for that
2536  *       level may be specified.  For example, ARP does not have a TOS field,
2537  *       so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2538  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2539  *       ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2540  *       IPv4 flow.
2541  *
2542  *    2. If the type of level N is not known (or not understood by Open
2543  *       vSwitch), then no fields at all for that level may be specified.  For
2544  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2545  *       L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2546  *       SCTP flow.
2547  *
2548  * 'flow_format' specifies the format of the flow as received or as intended to
2549  * be sent.  This is important for IPv6 and ARP, for which NXM supports more
2550  * detailed matching. */
2551 void
2552 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2553 {
2554     enum {
2555         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
2556         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
2557         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
2558         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
2559         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
2560         MAY_ARP_THA     = 1 << 5, /* arp_tha */
2561         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
2562         MAY_ND_TARGET   = 1 << 7  /* nd_target */
2563     } may_match;
2564
2565     struct flow_wildcards wc;
2566
2567     /* Figure out what fields may be matched. */
2568     if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2569         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
2570         if (rule->flow.nw_proto == IPPROTO_TCP ||
2571             rule->flow.nw_proto == IPPROTO_UDP ||
2572             rule->flow.nw_proto == IPPROTO_ICMP) {
2573             may_match |= MAY_TP_ADDR;
2574         }
2575     } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2576                && flow_format == NXFF_NXM) {
2577         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
2578         if (rule->flow.nw_proto == IPPROTO_TCP ||
2579             rule->flow.nw_proto == IPPROTO_UDP) {
2580             may_match |= MAY_TP_ADDR;
2581         } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2582             may_match |= MAY_TP_ADDR;
2583             if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2584                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2585             } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2586                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2587             }
2588         }
2589     } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2590         may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2591         if (flow_format == NXFF_NXM) {
2592             may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2593         }
2594     } else {
2595         may_match = 0;
2596     }
2597
2598     /* Clear the fields that may not be matched. */
2599     wc = rule->wc;
2600     if (!(may_match & MAY_NW_ADDR)) {
2601         wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2602     }
2603     if (!(may_match & MAY_TP_ADDR)) {
2604         wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2605     }
2606     if (!(may_match & MAY_NW_PROTO)) {
2607         wc.wildcards |= FWW_NW_PROTO;
2608     }
2609     if (!(may_match & MAY_IPVx)) {
2610         wc.wildcards |= FWW_NW_DSCP;
2611         wc.wildcards |= FWW_NW_ECN;
2612         wc.wildcards |= FWW_NW_TTL;
2613     }
2614     if (!(may_match & MAY_ARP_SHA)) {
2615         wc.wildcards |= FWW_ARP_SHA;
2616     }
2617     if (!(may_match & MAY_ARP_THA)) {
2618         wc.wildcards |= FWW_ARP_THA;
2619     }
2620     if (!(may_match & MAY_IPV6)) {
2621         wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2622         wc.wildcards |= FWW_IPV6_LABEL;
2623     }
2624     if (!(may_match & MAY_ND_TARGET)) {
2625         wc.wildcards |= FWW_ND_TARGET;
2626     }
2627
2628     /* Log any changes. */
2629     if (!flow_wildcards_equal(&wc, &rule->wc)) {
2630         bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2631         char *pre = log ? cls_rule_to_string(rule) : NULL;
2632
2633         rule->wc = wc;
2634         cls_rule_zero_wildcarded_fields(rule);
2635
2636         if (log) {
2637             char *post = cls_rule_to_string(rule);
2638             VLOG_INFO("normalization changed ofp_match, details:");
2639             VLOG_INFO(" pre: %s", pre);
2640             VLOG_INFO("post: %s", post);
2641             free(pre);
2642             free(post);
2643         }
2644     }
2645 }
2646
2647 static uint32_t
2648 vendor_code_to_id(uint8_t code)
2649 {
2650     switch (code) {
2651 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2652         OFPUTIL_VENDORS
2653 #undef OFPUTIL_VENDOR
2654     default:
2655         return UINT32_MAX;
2656     }
2657 }
2658
2659 static int
2660 vendor_id_to_code(uint32_t id)
2661 {
2662     switch (id) {
2663 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2664         OFPUTIL_VENDORS
2665 #undef OFPUTIL_VENDOR
2666     default:
2667         return -1;
2668     }
2669 }
2670
2671 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2672  * information taken from 'error', whose encoding must be as described in the
2673  * large comment in ofp-util.h.  If 'oh' is nonnull, then the error will use
2674  * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2675  * of 'oh'.
2676  *
2677  * Returns NULL if 'error' is not an OpenFlow error code. */
2678 struct ofpbuf *
2679 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2680 {
2681     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2682
2683     struct ofpbuf *buf;
2684     const void *data;
2685     size_t len;
2686     uint8_t vendor;
2687     uint16_t type;
2688     uint16_t code;
2689     ovs_be32 xid;
2690
2691     if (!is_ofp_error(error)) {
2692         /* We format 'error' with strerror() here since it seems likely to be
2693          * a system errno value. */
2694         VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2695                      error, strerror(error));
2696         return NULL;
2697     }
2698
2699     if (oh) {
2700         xid = oh->xid;
2701         data = oh;
2702         len = ntohs(oh->length);
2703         if (len > 64) {
2704             len = 64;
2705         }
2706     } else {
2707         xid = 0;
2708         data = NULL;
2709         len = 0;
2710     }
2711
2712     vendor = get_ofp_err_vendor(error);
2713     type = get_ofp_err_type(error);
2714     code = get_ofp_err_code(error);
2715     if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2716         struct ofp_error_msg *oem;
2717
2718         oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2719         oem->type = htons(type);
2720         oem->code = htons(code);
2721     } else {
2722         struct ofp_error_msg *oem;
2723         struct nx_vendor_error *nve;
2724         uint32_t vendor_id;
2725
2726         vendor_id = vendor_code_to_id(vendor);
2727         if (vendor_id == UINT32_MAX) {
2728             VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2729                          error, vendor);
2730             return NULL;
2731         }
2732
2733         oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2734                                 OFPT_ERROR, xid, &buf);
2735         oem->type = htons(NXET_VENDOR);
2736         oem->code = htons(NXVC_VENDOR_ERROR);
2737
2738         nve = (struct nx_vendor_error *)oem->data;
2739         nve->vendor = htonl(vendor_id);
2740         nve->type = htons(type);
2741         nve->code = htons(code);
2742     }
2743
2744     if (len) {
2745         buf->size -= len;
2746         ofpbuf_put(buf, data, len);
2747     }
2748
2749     return buf;
2750 }
2751
2752 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2753  * Open vSwitch internal error code in the format described in the large
2754  * comment in ofp-util.h.
2755  *
2756  * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2757  * to the payload starting from 'oh' and on failure it is set to 0. */
2758 int
2759 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2760 {
2761     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2762
2763     const struct ofp_error_msg *oem;
2764     uint16_t type, code;
2765     struct ofpbuf b;
2766     int vendor;
2767
2768     if (payload_ofs) {
2769         *payload_ofs = 0;
2770     }
2771     if (oh->type != OFPT_ERROR) {
2772         return EPROTO;
2773     }
2774
2775     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2776     oem = ofpbuf_try_pull(&b, sizeof *oem);
2777     if (!oem) {
2778         return EPROTO;
2779     }
2780
2781     type = ntohs(oem->type);
2782     code = ntohs(oem->code);
2783     if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2784         const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2785         if (!nve) {
2786             return EPROTO;
2787         }
2788
2789         vendor = vendor_id_to_code(ntohl(nve->vendor));
2790         if (vendor < 0) {
2791             VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2792                          ntohl(nve->vendor));
2793             return EPROTO;
2794         }
2795         type = ntohs(nve->type);
2796         code = ntohs(nve->code);
2797     } else {
2798         vendor = OFPUTIL_VENDOR_OPENFLOW;
2799     }
2800
2801     if (type >= 1024) {
2802         VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2803                      "supported maximum value 1023", type);
2804         return EPROTO;
2805     }
2806
2807     if (payload_ofs) {
2808         *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2809     }
2810     return ofp_mkerr_vendor(vendor, type, code);
2811 }
2812
2813 void
2814 ofputil_format_error(struct ds *s, int error)
2815 {
2816     if (is_errno(error)) {
2817         ds_put_cstr(s, strerror(error));
2818     } else {
2819         uint16_t type = get_ofp_err_type(error);
2820         uint16_t code = get_ofp_err_code(error);
2821         const char *type_s = ofp_error_type_to_string(type);
2822         const char *code_s = ofp_error_code_to_string(type, code);
2823
2824         ds_put_format(s, "type ");
2825         if (type_s) {
2826             ds_put_cstr(s, type_s);
2827         } else {
2828             ds_put_format(s, "%"PRIu16, type);
2829         }
2830
2831         ds_put_cstr(s, ", code ");
2832         if (code_s) {
2833             ds_put_cstr(s, code_s);
2834         } else {
2835             ds_put_format(s, "%"PRIu16, code);
2836         }
2837     }
2838 }
2839
2840 char *
2841 ofputil_error_to_string(int error)
2842 {
2843     struct ds s = DS_EMPTY_INITIALIZER;
2844     ofputil_format_error(&s, error);
2845     return ds_steal_cstr(&s);
2846 }
2847
2848 /* Attempts to pull 'actions_len' bytes from the front of 'b'.  Returns 0 if
2849  * successful, otherwise an OpenFlow error.
2850  *
2851  * If successful, the first action is stored in '*actionsp' and the number of
2852  * "union ofp_action" size elements into '*n_actionsp'.  Otherwise NULL and 0
2853  * are stored, respectively.
2854  *
2855  * This function does not check that the actions are valid (the caller should
2856  * do so, with validate_actions()).  The caller is also responsible for making
2857  * sure that 'b->data' is initially aligned appropriately for "union
2858  * ofp_action". */
2859 int
2860 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2861                      union ofp_action **actionsp, size_t *n_actionsp)
2862 {
2863     if (actions_len % OFP_ACTION_ALIGN != 0) {
2864         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2865                      "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2866         goto error;
2867     }
2868
2869     *actionsp = ofpbuf_try_pull(b, actions_len);
2870     if (*actionsp == NULL) {
2871         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2872                      "exceeds remaining message length (%zu)",
2873                      actions_len, b->size);
2874         goto error;
2875     }
2876
2877     *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2878     return 0;
2879
2880 error:
2881     *actionsp = NULL;
2882     *n_actionsp = 0;
2883     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2884 }
2885
2886 bool
2887 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
2888                       const union ofp_action *b, size_t n_b)
2889 {
2890     return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
2891 }
2892
2893 union ofp_action *
2894 ofputil_actions_clone(const union ofp_action *actions, size_t n)
2895 {
2896     return n ? xmemdup(actions, n * sizeof *actions) : NULL;
2897 }
2898
2899 /* Parses a key or a key-value pair from '*stringp'.
2900  *
2901  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
2902  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
2903  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
2904  * are substrings of '*stringp' created by replacing some of its bytes by null
2905  * terminators.  Returns true.
2906  *
2907  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
2908  * NULL and returns false. */
2909 bool
2910 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
2911 {
2912     char *pos, *key, *value;
2913     size_t key_len;
2914
2915     pos = *stringp;
2916     pos += strspn(pos, ", \t\r\n");
2917     if (*pos == '\0') {
2918         *keyp = *valuep = NULL;
2919         return false;
2920     }
2921
2922     key = pos;
2923     key_len = strcspn(pos, ":=(, \t\r\n");
2924     if (key[key_len] == ':' || key[key_len] == '=') {
2925         /* The value can be separated by a colon. */
2926         size_t value_len;
2927
2928         value = key + key_len + 1;
2929         value_len = strcspn(value, ", \t\r\n");
2930         pos = value + value_len + (value[value_len] != '\0');
2931         value[value_len] = '\0';
2932     } else if (key[key_len] == '(') {
2933         /* The value can be surrounded by balanced parentheses.  The outermost
2934          * set of parentheses is removed. */
2935         int level = 1;
2936         size_t value_len;
2937
2938         value = key + key_len + 1;
2939         for (value_len = 0; level > 0; value_len++) {
2940             switch (value[value_len]) {
2941             case '\0':
2942                 ovs_fatal(0, "unbalanced parentheses in argument to %s", key);
2943
2944             case '(':
2945                 level++;
2946                 break;
2947
2948             case ')':
2949                 level--;
2950                 break;
2951             }
2952         }
2953         value[value_len - 1] = '\0';
2954         pos = value + value_len;
2955     } else {
2956         /* There might be no value at all. */
2957         value = key + key_len;  /* Will become the empty string below. */
2958         pos = key + key_len + (key[key_len] != '\0');
2959     }
2960     key[key_len] = '\0';
2961
2962     *stringp = pos;
2963     *keyp = key;
2964     *valuep = value;
2965     return true;
2966 }