lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   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 "meta-flow.h"
  32 #include "multipath.h"
  33 #include "netdev.h"
  34 #include "nx-match.h"
  35 #include "ofp-errors.h"
  36 #include "ofp-util.h"
  37 #include "ofpbuf.h"
  38 #include "packets.h"
  39 #include "random.h"
  40 #include "unaligned.h"
  41 #include "type-props.h"
  42 #include "vlog.h"
  43
  44 VLOG_DEFINE_THIS_MODULE(ofp_util);
  45
  46 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  47  * in the peer and so there's not much point in showing a lot of them. */
  48 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  49
  50 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
  51  * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
  52  * is wildcarded.
  53  *
  54  * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
  55  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
  56  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
  57  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
  58  * wildcarded. */
  59 ovs_be32
  60 ofputil_wcbits_to_netmask(int wcbits)
  61 {
  62     wcbits &= 0x3f;
  63     return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
  64 }
  65
  66 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
  67  * that it wildcards, that is, the number of 0-bits in 'netmask'.  'netmask'
  68  * must be a CIDR netmask (see ip_is_cidr()). */
  69 int
  70 ofputil_netmask_to_wcbits(ovs_be32 netmask)
  71 {
  72     return 32 - ip_count_cidr_bits(netmask);
  73 }
  74
  75 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
  76  * name. */
  77 #define WC_INVARIANT_LIST \
  78     WC_INVARIANT_BIT(IN_PORT) \
  79     WC_INVARIANT_BIT(DL_TYPE) \
  80     WC_INVARIANT_BIT(NW_PROTO)
  81
  82 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
  83  * actually have the same names and values. */
  84 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
  85     WC_INVARIANT_LIST
  86 #undef WC_INVARIANT_BIT
  87
  88 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
  89  * OR'd together. */
  90 static const flow_wildcards_t WC_INVARIANTS = 0
  91 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
  92     WC_INVARIANT_LIST
  93 #undef WC_INVARIANT_BIT
  94 ;
  95
  96 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
  97  * struct cls_rule.  It is the caller's responsibility to handle the special
  98  * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
  99 void
 100 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
 101 {
 102     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
 103
 104     /* Initialize most of rule->wc. */
 105     flow_wildcards_init_catchall(wc);
 106     wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
 107
 108     /* Wildcard fields that aren't defined by ofp_match or tun_id. */
 109     wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
 110                       | FWW_IPV6_LABEL);
 111
 112     if (ofpfw & OFPFW_NW_TOS) {
 113         /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
 114          * the enum than we can use. */
 115         wc->wildcards |= FWW_NW_DSCP;
 116     }
 117
 118     wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
 119     wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
 120
 121     if (!(ofpfw & OFPFW_TP_SRC)) {
 122         wc->tp_src_mask = htons(UINT16_MAX);
 123     }
 124     if (!(ofpfw & OFPFW_TP_DST)) {
 125         wc->tp_dst_mask = htons(UINT16_MAX);
 126     }
 127
 128     if (!(ofpfw & OFPFW_DL_SRC)) {
 129         memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
 130     }
 131     if (!(ofpfw & OFPFW_DL_DST)) {
 132         memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
 133     }
 134
 135     /* VLAN TCI mask. */
 136     if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
 137         wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
 138     }
 139     if (!(ofpfw & OFPFW_DL_VLAN)) {
 140         wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
 141     }
 142 }
 143
 144 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
 145  * 'priority'. */
 146 void
 147 ofputil_cls_rule_from_match(const struct ofp_match *match,
 148                             unsigned int priority, struct cls_rule *rule)
 149 {
 150     uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
 151
 152     /* Initialize rule->priority, rule->wc. */
 153     rule->priority = !ofpfw ? UINT16_MAX : priority;
 154     ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
 155
 156     /* Initialize most of rule->flow. */
 157     rule->flow.nw_src = match->nw_src;
 158     rule->flow.nw_dst = match->nw_dst;
 159     rule->flow.in_port = ntohs(match->in_port);
 160     rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
 161     rule->flow.tp_src = match->tp_src;
 162     rule->flow.tp_dst = match->tp_dst;
 163     memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
 164     memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
 165     rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
 166     rule->flow.nw_proto = match->nw_proto;
 167
 168     /* Translate VLANs. */
 169     if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
 170         /* Match only packets without 802.1Q header.
 171          *
 172          * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
 173          *
 174          * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
 175          * because we can't have a specific PCP without an 802.1Q header.
 176          * However, older versions of OVS treated this as matching packets
 177          * withut an 802.1Q header, so we do here too. */
 178         rule->flow.vlan_tci = htons(0);
 179         rule->wc.vlan_tci_mask = htons(0xffff);
 180     } else {
 181         ovs_be16 vid, pcp, tci;
 182
 183         vid = match->dl_vlan & htons(VLAN_VID_MASK);
 184         pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
 185         tci = vid | pcp | htons(VLAN_CFI);
 186         rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
 187     }
 188
 189     /* Clean up. */
 190     cls_rule_zero_wildcarded_fields(rule);
 191 }
 192
 193 /* Convert 'rule' into the OpenFlow match structure 'match'. */
 194 void
 195 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
 196 {
 197     const struct flow_wildcards *wc = &rule->wc;
 198     uint32_t ofpfw;
 199
 200     /* Figure out most OpenFlow wildcards. */
 201     ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
 202     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
 203     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
 204     if (wc->wildcards & FWW_NW_DSCP) {
 205         ofpfw |= OFPFW_NW_TOS;
 206     }
 207     if (!wc->tp_src_mask) {
 208         ofpfw |= OFPFW_TP_SRC;
 209     }
 210     if (!wc->tp_dst_mask) {
 211         ofpfw |= OFPFW_TP_DST;
 212     }
 213     if (eth_addr_is_zero(wc->dl_src_mask)) {
 214         ofpfw |= OFPFW_DL_SRC;
 215     }
 216     if (eth_addr_is_zero(wc->dl_dst_mask)) {
 217         ofpfw |= OFPFW_DL_DST;
 218     }
 219
 220     /* Translate VLANs. */
 221     match->dl_vlan = htons(0);
 222     match->dl_vlan_pcp = 0;
 223     if (rule->wc.vlan_tci_mask == htons(0)) {
 224         ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
 225     } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
 226                && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
 227         match->dl_vlan = htons(OFP_VLAN_NONE);
 228     } else {
 229         if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
 230             ofpfw |= OFPFW_DL_VLAN;
 231         } else {
 232             match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
 233         }
 234
 235         if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
 236             ofpfw |= OFPFW_DL_VLAN_PCP;
 237         } else {
 238             match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
 239         }
 240     }
 241
 242     /* Compose most of the match structure. */
 243     match->wildcards = htonl(ofpfw);
 244     match->in_port = htons(rule->flow.in_port);
 245     memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
 246     memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
 247     match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
 248     match->nw_src = rule->flow.nw_src;
 249     match->nw_dst = rule->flow.nw_dst;
 250     match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
 251     match->nw_proto = rule->flow.nw_proto;
 252     match->tp_src = rule->flow.tp_src;
 253     match->tp_dst = rule->flow.tp_dst;
 254     memset(match->pad1, '\0', sizeof match->pad1);
 255     memset(match->pad2, '\0', sizeof match->pad2);
 256 }
 257
 258 /* Given a 'dl_type' value in the format used in struct flow, returns the
 259  * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
 260 ovs_be16
 261 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
 262 {
 263     return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
 264             ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 265             : flow_dl_type);
 266 }
 267
 268 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
 269  * structure, returns the corresponding 'dl_type' value for use in struct
 270  * flow. */
 271 ovs_be16
 272 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
 273 {
 274     return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 275             ? htons(FLOW_DL_TYPE_NONE)
 276             : ofp_dl_type);
 277 }
 278
 279 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
 280 static ovs_be32
 281 alloc_xid(void)
 282 {
 283     static uint32_t next_xid = 1;
 284     return htonl(next_xid++);
 285 }
 286 \f
 287 /* Basic parsing of OpenFlow messages. */
 288
 289 struct ofputil_msg_type {
 290     enum ofputil_msg_code code; /* OFPUTIL_*. */
 291     uint8_t ofp_version;        /* An OpenFlow version or 0 for "any". */
 292     uint32_t value;             /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
 293     const char *name;           /* e.g. "OFPT_FLOW_REMOVED". */
 294     unsigned int min_size;      /* Minimum total message size in bytes. */
 295     /* 0 if 'min_size' is the exact size that the message must be.  Otherwise,
 296      * the message may exceed 'min_size' by an even multiple of this value. */
 297     unsigned int extra_multiple;
 298 };
 299
 300 /* Represents a malformed OpenFlow message. */
 301 static const struct ofputil_msg_type ofputil_invalid_type = {
 302     OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0
 303 };
 304
 305 struct ofputil_msg_category {
 306     const char *name;           /* e.g. "OpenFlow message" */
 307     const struct ofputil_msg_type *types;
 308     size_t n_types;
 309     enum ofperr missing_error;  /* Error value for missing type. */
 310 };
 311
 312 static enum ofperr
 313 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
 314 {
 315     switch (type->extra_multiple) {
 316     case 0:
 317         if (size != type->min_size) {
 318             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 319                          "length %u (expected length %u)",
 320                          type->name, size, type->min_size);
 321             return OFPERR_OFPBRC_BAD_LEN;
 322         }
 323         return 0;
 324
 325     case 1:
 326         if (size < type->min_size) {
 327             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 328                          "length %u (expected length at least %u bytes)",
 329                          type->name, size, type->min_size);
 330             return OFPERR_OFPBRC_BAD_LEN;
 331         }
 332         return 0;
 333
 334     default:
 335         if (size < type->min_size
 336             || (size - type->min_size) % type->extra_multiple) {
 337             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
 338                          "length %u (must be exactly %u bytes or longer "
 339                          "by an integer multiple of %u bytes)",
 340                          type->name, size,
 341                          type->min_size, type->extra_multiple);
 342             return OFPERR_OFPBRC_BAD_LEN;
 343         }
 344         return 0;
 345     }
 346 }
 347
 348 static enum ofperr
 349 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
 350                                 uint8_t version, uint32_t value,
 351                                 const struct ofputil_msg_type **typep)
 352 {
 353     const struct ofputil_msg_type *type;
 354
 355     for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
 356         if (type->value == value
 357             && (!type->ofp_version || version == type->ofp_version)) {
 358             *typep = type;
 359             return 0;
 360         }
 361     }
 362
 363     VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
 364                  cat->name, value);
 365     return cat->missing_error;
 366 }
 367
 368 static enum ofperr
 369 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
 370                       const struct ofputil_msg_type **typep)
 371 {
 372     static const struct ofputil_msg_type nxt_messages[] = {
 373         { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION,
 374           NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
 375           sizeof(struct nx_role_request), 0 },
 376
 377         { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION,
 378           NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
 379           sizeof(struct nx_role_request), 0 },
 380
 381         { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION,
 382           NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
 383           sizeof(struct nx_set_flow_format), 0 },
 384
 385         { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION,
 386           NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
 387           sizeof(struct nx_set_packet_in_format), 0 },
 388
 389         { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION,
 390           NXT_PACKET_IN, "NXT_PACKET_IN",
 391           sizeof(struct nx_packet_in), 1 },
 392
 393         { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION,
 394           NXT_FLOW_MOD, "NXT_FLOW_MOD",
 395           sizeof(struct nx_flow_mod), 8 },
 396
 397         { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION,
 398           NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
 399           sizeof(struct nx_flow_removed), 8 },
 400
 401         { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION,
 402           NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
 403           sizeof(struct nx_flow_mod_table_id), 0 },
 404
 405         { OFPUTIL_NXT_FLOW_AGE, OFP10_VERSION,
 406           NXT_FLOW_AGE, "NXT_FLOW_AGE",
 407           sizeof(struct nicira_header), 0 },
 408
 409         { OFPUTIL_NXT_SET_ASYNC_CONFIG, OFP10_VERSION,
 410           NXT_SET_ASYNC_CONFIG, "NXT_SET_ASYNC_CONFIG",
 411           sizeof(struct nx_async_config), 0 },
 412
 413         { OFPUTIL_NXT_SET_CONTROLLER_ID, OFP10_VERSION,
 414           NXT_SET_CONTROLLER_ID, "NXT_SET_CONTROLLER_ID",
 415           sizeof(struct nx_controller_id), 0 },
 416     };
 417
 418     static const struct ofputil_msg_category nxt_category = {
 419         "Nicira extension message",
 420         nxt_messages, ARRAY_SIZE(nxt_messages),
 421         OFPERR_OFPBRC_BAD_SUBTYPE
 422     };
 423
 424     const struct ofp_vendor_header *ovh;
 425     const struct nicira_header *nh;
 426
 427     if (length < sizeof(struct ofp_vendor_header)) {
 428         if (length == ntohs(oh->length)) {
 429             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
 430         }
 431         return OFPERR_OFPBRC_BAD_LEN;
 432     }
 433
 434     ovh = (const struct ofp_vendor_header *) oh;
 435     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
 436         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
 437                      "vendor %"PRIx32, ntohl(ovh->vendor));
 438         return OFPERR_OFPBRC_BAD_VENDOR;
 439     }
 440
 441     if (length < sizeof(struct nicira_header)) {
 442         if (length == ntohs(oh->length)) {
 443             VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
 444                          "length %u (expected at least %zu)",
 445                          ntohs(ovh->header.length),
 446                          sizeof(struct nicira_header));
 447         }
 448         return OFPERR_OFPBRC_BAD_LEN;
 449     }
 450
 451     nh = (const struct nicira_header *) oh;
 452     return ofputil_lookup_openflow_message(&nxt_category, oh->version,
 453                                            ntohl(nh->subtype), typep);
 454 }
 455
 456 static enum ofperr
 457 check_nxstats_msg(const struct ofp_header *oh, size_t length)
 458 {
 459     const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
 460     ovs_be32 vendor;
 461
 462     if (length < sizeof(struct ofp_vendor_stats_msg)) {
 463         if (length == ntohs(oh->length)) {
 464             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
 465         }
 466         return OFPERR_OFPBRC_BAD_LEN;
 467     }
 468
 469     memcpy(&vendor, osm + 1, sizeof vendor);
 470     if (vendor != htonl(NX_VENDOR_ID)) {
 471         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
 472                      "unknown vendor %"PRIx32, ntohl(vendor));
 473         return OFPERR_OFPBRC_BAD_VENDOR;
 474     }
 475
 476     if (length < sizeof(struct nicira_stats_msg)) {
 477         if (length == ntohs(osm->header.length)) {
 478             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
 479         }
 480         return OFPERR_OFPBRC_BAD_LEN;
 481     }
 482
 483     return 0;
 484 }
 485
 486 static enum ofperr
 487 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
 488                             const struct ofputil_msg_type **typep)
 489 {
 490     static const struct ofputil_msg_type nxst_requests[] = {
 491         { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION,
 492           NXST_FLOW, "NXST_FLOW request",
 493           sizeof(struct nx_flow_stats_request), 8 },
 494
 495         { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION,
 496           NXST_AGGREGATE, "NXST_AGGREGATE request",
 497           sizeof(struct nx_aggregate_stats_request), 8 },
 498     };
 499
 500     static const struct ofputil_msg_category nxst_request_category = {
 501         "Nicira extension statistics request",
 502         nxst_requests, ARRAY_SIZE(nxst_requests),
 503         OFPERR_OFPBRC_BAD_SUBTYPE
 504     };
 505
 506     const struct nicira_stats_msg *nsm;
 507     enum ofperr error;
 508
 509     error = check_nxstats_msg(oh, length);
 510     if (error) {
 511         return error;
 512     }
 513
 514     nsm = (struct nicira_stats_msg *) oh;
 515     return ofputil_lookup_openflow_message(&nxst_request_category, oh->version,
 516                                            ntohl(nsm->subtype), typep);
 517 }
 518
 519 static enum ofperr
 520 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
 521                           const struct ofputil_msg_type **typep)
 522 {
 523     static const struct ofputil_msg_type nxst_replies[] = {
 524         { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION,
 525           NXST_FLOW, "NXST_FLOW reply",
 526           sizeof(struct nicira_stats_msg), 8 },
 527
 528         { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION,
 529           NXST_AGGREGATE, "NXST_AGGREGATE reply",
 530           sizeof(struct nx_aggregate_stats_reply), 0 },
 531     };
 532
 533     static const struct ofputil_msg_category nxst_reply_category = {
 534         "Nicira extension statistics reply",
 535         nxst_replies, ARRAY_SIZE(nxst_replies),
 536         OFPERR_OFPBRC_BAD_SUBTYPE
 537     };
 538
 539     const struct nicira_stats_msg *nsm;
 540     enum ofperr error;
 541
 542     error = check_nxstats_msg(oh, length);
 543     if (error) {
 544         return error;
 545     }
 546
 547     nsm = (struct nicira_stats_msg *) oh;
 548     return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version,
 549                                            ntohl(nsm->subtype), typep);
 550 }
 551
 552 static enum ofperr
 553 check_stats_msg(const struct ofp_header *oh, size_t length)
 554 {
 555     if (length < sizeof(struct ofp_stats_msg)) {
 556         if (length == ntohs(oh->length)) {
 557             VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
 558         }
 559         return OFPERR_OFPBRC_BAD_LEN;
 560     }
 561
 562     return 0;
 563 }
 564
 565 static enum ofperr
 566 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
 567                              const struct ofputil_msg_type **typep)
 568 {
 569     static const struct ofputil_msg_type ofpst_requests[] = {
 570         { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
 571           OFPST_DESC, "OFPST_DESC request",
 572           sizeof(struct ofp_stats_msg), 0 },
 573
 574         { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
 575           OFPST_FLOW, "OFPST_FLOW request",
 576           sizeof(struct ofp_flow_stats_request), 0 },
 577
 578         { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
 579           OFPST_AGGREGATE, "OFPST_AGGREGATE request",
 580           sizeof(struct ofp_flow_stats_request), 0 },
 581
 582         { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
 583           OFPST_TABLE, "OFPST_TABLE request",
 584           sizeof(struct ofp_stats_msg), 0 },
 585
 586         { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
 587           OFPST_PORT, "OFPST_PORT request",
 588           sizeof(struct ofp_port_stats_request), 0 },
 589
 590         { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
 591           OFPST_QUEUE, "OFPST_QUEUE request",
 592           sizeof(struct ofp_queue_stats_request), 0 },
 593
 594         { OFPUTIL_OFPST_PORT_DESC_REQUEST, OFP10_VERSION,
 595           OFPST_PORT_DESC, "OFPST_PORT_DESC request",
 596           sizeof(struct ofp_stats_msg), 0 },
 597
 598         { 0, 0,
 599           OFPST_VENDOR, "OFPST_VENDOR request",
 600           sizeof(struct ofp_vendor_stats_msg), 1 },
 601     };
 602
 603     static const struct ofputil_msg_category ofpst_request_category = {
 604         "OpenFlow statistics",
 605         ofpst_requests, ARRAY_SIZE(ofpst_requests),
 606         OFPERR_OFPBRC_BAD_STAT
 607     };
 608
 609     const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
 610     enum ofperr error;
 611
 612     error = check_stats_msg(oh, length);
 613     if (error) {
 614         return error;
 615     }
 616
 617     error = ofputil_lookup_openflow_message(&ofpst_request_category,
 618                                             oh->version, ntohs(request->type),
 619                                             typep);
 620     if (!error && request->type == htons(OFPST_VENDOR)) {
 621         error = ofputil_decode_nxst_request(oh, length, typep);
 622     }
 623     return error;
 624 }
 625
 626 static enum ofperr
 627 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
 628                            const struct ofputil_msg_type **typep)
 629 {
 630     static const struct ofputil_msg_type ofpst_replies[] = {
 631         { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
 632           OFPST_DESC, "OFPST_DESC reply",
 633           sizeof(struct ofp_desc_stats), 0 },
 634
 635         { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
 636           OFPST_FLOW, "OFPST_FLOW reply",
 637           sizeof(struct ofp_stats_msg), 1 },
 638
 639         { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
 640           OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
 641           sizeof(struct ofp_aggregate_stats_reply), 0 },
 642
 643         { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
 644           OFPST_TABLE, "OFPST_TABLE reply",
 645           sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
 646
 647         { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION,
 648           OFPST_PORT, "OFPST_PORT reply",
 649           sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
 650
 651         { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION,
 652           OFPST_QUEUE, "OFPST_QUEUE reply",
 653           sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
 654
 655         { OFPUTIL_OFPST_PORT_DESC_REPLY, OFP10_VERSION,
 656           OFPST_PORT_DESC, "OFPST_PORT_DESC reply",
 657           sizeof(struct ofp_stats_msg), sizeof(struct ofp10_phy_port) },
 658
 659         { 0, 0,
 660           OFPST_VENDOR, "OFPST_VENDOR reply",
 661           sizeof(struct ofp_vendor_stats_msg), 1 },
 662     };
 663
 664     static const struct ofputil_msg_category ofpst_reply_category = {
 665         "OpenFlow statistics",
 666         ofpst_replies, ARRAY_SIZE(ofpst_replies),
 667         OFPERR_OFPBRC_BAD_STAT
 668     };
 669
 670     const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
 671     enum ofperr error;
 672
 673     error = check_stats_msg(oh, length);
 674     if (error) {
 675         return error;
 676     }
 677
 678     error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version,
 679                                            ntohs(reply->type), typep);
 680     if (!error && reply->type == htons(OFPST_VENDOR)) {
 681         error = ofputil_decode_nxst_reply(oh, length, typep);
 682     }
 683     return error;
 684 }
 685
 686 static enum ofperr
 687 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
 688                           const struct ofputil_msg_type **typep)
 689 {
 690     static const struct ofputil_msg_type ofpt_messages[] = {
 691         { OFPUTIL_OFPT_HELLO, OFP10_VERSION,
 692           OFPT_HELLO, "OFPT_HELLO",
 693           sizeof(struct ofp_hello), 1 },
 694
 695         { OFPUTIL_OFPT_ERROR, 0,
 696           OFPT_ERROR, "OFPT_ERROR",
 697           sizeof(struct ofp_error_msg), 1 },
 698
 699         { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION,
 700           OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
 701           sizeof(struct ofp_header), 1 },
 702
 703         { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION,
 704           OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
 705           sizeof(struct ofp_header), 1 },
 706
 707         { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION,
 708           OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
 709           sizeof(struct ofp_header), 0 },
 710
 711         { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION,
 712           OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
 713           sizeof(struct ofp_switch_features), sizeof(struct ofp10_phy_port) },
 714         { OFPUTIL_OFPT_FEATURES_REPLY, OFP11_VERSION,
 715           OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
 716           sizeof(struct ofp_switch_features), sizeof(struct ofp11_port) },
 717
 718         { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION,
 719           OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
 720           sizeof(struct ofp_header), 0 },
 721
 722         { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION,
 723           OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
 724           sizeof(struct ofp_switch_config), 0 },
 725
 726         { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION,
 727           OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
 728           sizeof(struct ofp_switch_config), 0 },
 729
 730         { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION,
 731           OFPT_PACKET_IN, "OFPT_PACKET_IN",
 732           offsetof(struct ofp_packet_in, data), 1 },
 733
 734         { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION,
 735           OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
 736           sizeof(struct ofp_flow_removed), 0 },
 737
 738         { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION,
 739           OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
 740           sizeof(struct ofp_port_status) + sizeof(struct ofp10_phy_port), 0 },
 741         { OFPUTIL_OFPT_PORT_STATUS, OFP11_VERSION,
 742           OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
 743           sizeof(struct ofp_port_status) + sizeof(struct ofp11_port), 0 },
 744
 745         { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
 746           OFPT10_PACKET_OUT, "OFPT_PACKET_OUT",
 747           sizeof(struct ofp_packet_out), 1 },
 748
 749         { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
 750           OFPT10_FLOW_MOD, "OFPT_FLOW_MOD",
 751           sizeof(struct ofp_flow_mod), 1 },
 752
 753         { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
 754           OFPT10_PORT_MOD, "OFPT_PORT_MOD",
 755           sizeof(struct ofp10_port_mod), 0 },
 756         { OFPUTIL_OFPT_PORT_MOD, OFP11_VERSION,
 757           OFPT11_PORT_MOD, "OFPT_PORT_MOD",
 758           sizeof(struct ofp11_port_mod), 0 },
 759
 760         { 0, OFP10_VERSION,
 761           OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST",
 762           sizeof(struct ofp_stats_msg), 1 },
 763
 764         { 0, OFP10_VERSION,
 765           OFPT10_STATS_REPLY, "OFPT_STATS_REPLY",
 766           sizeof(struct ofp_stats_msg), 1 },
 767
 768         { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION,
 769           OFPT10_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
 770           sizeof(struct ofp_header), 0 },
 771
 772         { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION,
 773           OFPT10_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
 774           sizeof(struct ofp_header), 0 },
 775
 776         { 0, 0,
 777           OFPT_VENDOR, "OFPT_VENDOR",
 778           sizeof(struct ofp_vendor_header), 1 },
 779     };
 780
 781     static const struct ofputil_msg_category ofpt_category = {
 782         "OpenFlow message",
 783         ofpt_messages, ARRAY_SIZE(ofpt_messages),
 784         OFPERR_OFPBRC_BAD_TYPE
 785     };
 786
 787     enum ofperr error;
 788
 789     error = ofputil_lookup_openflow_message(&ofpt_category, oh->version,
 790                                             oh->type, typep);
 791     if (!error) {
 792         switch ((oh->version << 8) | oh->type) {
 793         case (OFP10_VERSION << 8) | OFPT_VENDOR:
 794         case (OFP11_VERSION << 8) | OFPT_VENDOR:
 795             error = ofputil_decode_vendor(oh, length, typep);
 796             break;
 797
 798         case (OFP10_VERSION << 8) | OFPT10_STATS_REQUEST:
 799         case (OFP11_VERSION << 8) | OFPT11_STATS_REQUEST:
 800             error = ofputil_decode_ofpst_request(oh, length, typep);
 801             break;
 802
 803         case (OFP10_VERSION << 8) | OFPT10_STATS_REPLY:
 804         case (OFP11_VERSION << 8) | OFPT11_STATS_REPLY:
 805             error = ofputil_decode_ofpst_reply(oh, length, typep);
 806
 807         default:
 808             break;
 809         }
 810     }
 811     return error;
 812 }
 813
 814 /* Decodes the message type represented by 'oh'.  Returns 0 if successful or an
 815  * OpenFlow error code on failure.  Either way, stores in '*typep' a type
 816  * structure that can be inspected with the ofputil_msg_type_*() functions.
 817  *
 818  * oh->length must indicate the correct length of the message (and must be at
 819  * least sizeof(struct ofp_header)).
 820  *
 821  * Success indicates that 'oh' is at least as long as the minimum-length
 822  * message of its type. */
 823 enum ofperr
 824 ofputil_decode_msg_type(const struct ofp_header *oh,
 825                         const struct ofputil_msg_type **typep)
 826 {
 827     size_t length = ntohs(oh->length);
 828     enum ofperr error;
 829
 830     error = ofputil_decode_msg_type__(oh, length, typep);
 831     if (!error) {
 832         error = ofputil_check_length(*typep, length);
 833     }
 834     if (error) {
 835         *typep = &ofputil_invalid_type;
 836     }
 837     return error;
 838 }
 839
 840 /* Decodes the message type represented by 'oh', of which only the first
 841  * 'length' bytes are available.  Returns 0 if successful or an OpenFlow error
 842  * code on failure.  Either way, stores in '*typep' a type structure that can
 843  * be inspected with the ofputil_msg_type_*() functions.  */
 844 enum ofperr
 845 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
 846                                 const struct ofputil_msg_type **typep)
 847 {
 848     enum ofperr error;
 849
 850     error = (length >= sizeof *oh
 851              ? ofputil_decode_msg_type__(oh, length, typep)
 852              : OFPERR_OFPBRC_BAD_LEN);
 853     if (error) {
 854         *typep = &ofputil_invalid_type;
 855     }
 856     return error;
 857 }
 858
 859 /* Returns an OFPUTIL_* message type code for 'type'. */
 860 enum ofputil_msg_code
 861 ofputil_msg_type_code(const struct ofputil_msg_type *type)
 862 {
 863     return type->code;
 864 }
 865 \f
 866 /* Protocols. */
 867
 868 struct proto_abbrev {
 869     enum ofputil_protocol protocol;
 870     const char *name;
 871 };
 872
 873 /* Most users really don't care about some of the differences between
 874  * protocols.  These abbreviations help with that. */
 875 static const struct proto_abbrev proto_abbrevs[] = {
 876     { OFPUTIL_P_ANY,      "any" },
 877     { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
 878     { OFPUTIL_P_NXM_ANY,  "NXM" },
 879 };
 880 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
 881
 882 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
 883     OFPUTIL_P_NXM,
 884     OFPUTIL_P_OF10,
 885 };
 886 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
 887
 888 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
 889  * connection that has negotiated the given 'version'.  'version' should
 890  * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
 891  * 1.0, 0x02 for OpenFlow 1.1).  Returns 0 if 'version' is not supported or
 892  * outside the valid range.  */
 893 enum ofputil_protocol
 894 ofputil_protocol_from_ofp_version(int version)
 895 {
 896     switch (version) {
 897     case OFP10_VERSION: return OFPUTIL_P_OF10;
 898     default: return 0;
 899     }
 900 }
 901
 902 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION or
 903  * OFP11_VERSION) that corresponds to 'protocol'. */
 904 uint8_t
 905 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
 906 {
 907     switch (protocol) {
 908     case OFPUTIL_P_OF10:
 909     case OFPUTIL_P_OF10_TID:
 910     case OFPUTIL_P_NXM:
 911     case OFPUTIL_P_NXM_TID:
 912         return OFP10_VERSION;
 913     }
 914
 915     NOT_REACHED();
 916 }
 917
 918 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
 919  * otherwise. */
 920 bool
 921 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
 922 {
 923     return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
 924 }
 925
 926 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
 927  * extension turned on or off if 'enable' is true or false, respectively.
 928  *
 929  * This extension is only useful for protocols whose "standard" version does
 930  * not allow specific tables to be modified.  In particular, this is true of
 931  * OpenFlow 1.0.  In later versions of OpenFlow, a flow_mod request always
 932  * specifies a table ID and so there is no need for such an extension.  When
 933  * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
 934  * extension, this function just returns its 'protocol' argument unchanged
 935  * regardless of the value of 'enable'.  */
 936 enum ofputil_protocol
 937 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
 938 {
 939     switch (protocol) {
 940     case OFPUTIL_P_OF10:
 941     case OFPUTIL_P_OF10_TID:
 942         return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
 943
 944     case OFPUTIL_P_NXM:
 945     case OFPUTIL_P_NXM_TID:
 946         return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
 947
 948     default:
 949         NOT_REACHED();
 950     }
 951 }
 952
 953 /* Returns the "base" version of 'protocol'.  That is, if 'protocol' includes
 954  * some extension to a standard protocol version, the return value is the
 955  * standard version of that protocol without any extension.  If 'protocol' is a
 956  * standard protocol version, returns 'protocol' unchanged. */
 957 enum ofputil_protocol
 958 ofputil_protocol_to_base(enum ofputil_protocol protocol)
 959 {
 960     return ofputil_protocol_set_tid(protocol, false);
 961 }
 962
 963 /* Returns 'new_base' with any extensions taken from 'cur'. */
 964 enum ofputil_protocol
 965 ofputil_protocol_set_base(enum ofputil_protocol cur,
 966                           enum ofputil_protocol new_base)
 967 {
 968     bool tid = (cur & OFPUTIL_P_TID) != 0;
 969
 970     switch (new_base) {
 971     case OFPUTIL_P_OF10:
 972     case OFPUTIL_P_OF10_TID:
 973         return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
 974
 975     case OFPUTIL_P_NXM:
 976     case OFPUTIL_P_NXM_TID:
 977         return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
 978
 979     default:
 980         NOT_REACHED();
 981     }
 982 }
 983
 984 /* Returns a string form of 'protocol', if a simple form exists (that is, if
 985  * 'protocol' is either a single protocol or it is a combination of protocols
 986  * that have a single abbreviation).  Otherwise, returns NULL. */
 987 const char *
 988 ofputil_protocol_to_string(enum ofputil_protocol protocol)
 989 {
 990     const struct proto_abbrev *p;
 991
 992     /* Use a "switch" statement for single-bit names so that we get a compiler
 993      * warning if we forget any. */
 994     switch (protocol) {
 995     case OFPUTIL_P_NXM:
 996         return "NXM-table_id";
 997
 998     case OFPUTIL_P_NXM_TID:
 999         return "NXM+table_id";
1000
1001     case OFPUTIL_P_OF10:
1002         return "OpenFlow10-table_id";
1003
1004     case OFPUTIL_P_OF10_TID:
1005         return "OpenFlow10+table_id";
1006     }
1007
1008     /* Check abbreviations. */
1009     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1010         if (protocol == p->protocol) {
1011             return p->name;
1012         }
1013     }
1014
1015     return NULL;
1016 }
1017
1018 /* Returns a string that represents 'protocols'.  The return value might be a
1019  * comma-separated list if 'protocols' doesn't have a simple name.  The return
1020  * value is "none" if 'protocols' is 0.
1021  *
1022  * The caller must free the returned string (with free()). */
1023 char *
1024 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1025 {
1026     struct ds s;
1027
1028     assert(!(protocols & ~OFPUTIL_P_ANY));
1029     if (protocols == 0) {
1030         return xstrdup("none");
1031     }
1032
1033     ds_init(&s);
1034     while (protocols) {
1035         const struct proto_abbrev *p;
1036         int i;
1037
1038         if (s.length) {
1039             ds_put_char(&s, ',');
1040         }
1041
1042         for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1043             if ((protocols & p->protocol) == p->protocol) {
1044                 ds_put_cstr(&s, p->name);
1045                 protocols &= ~p->protocol;
1046                 goto match;
1047             }
1048         }
1049
1050         for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1051             enum ofputil_protocol bit = 1u << i;
1052
1053             if (protocols & bit) {
1054                 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1055                 protocols &= ~bit;
1056                 goto match;
1057             }
1058         }
1059         NOT_REACHED();
1060
1061     match: ;
1062     }
1063     return ds_steal_cstr(&s);
1064 }
1065
1066 static enum ofputil_protocol
1067 ofputil_protocol_from_string__(const char *s, size_t n)
1068 {
1069     const struct proto_abbrev *p;
1070     int i;
1071
1072     for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1073         enum ofputil_protocol bit = 1u << i;
1074         const char *name = ofputil_protocol_to_string(bit);
1075
1076         if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1077             return bit;
1078         }
1079     }
1080
1081     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1082         if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1083             return p->protocol;
1084         }
1085     }
1086
1087     return 0;
1088 }
1089
1090 /* Returns the nonempty set of protocols represented by 's', which can be a
1091  * single protocol name or abbreviation or a comma-separated list of them.
1092  *
1093  * Aborts the program with an error message if 's' is invalid. */
1094 enum ofputil_protocol
1095 ofputil_protocols_from_string(const char *s)
1096 {
1097     const char *orig_s = s;
1098     enum ofputil_protocol protocols;
1099
1100     protocols = 0;
1101     while (*s) {
1102         enum ofputil_protocol p;
1103         size_t n;
1104
1105         n = strcspn(s, ",");
1106         if (n == 0) {
1107             s++;
1108             continue;
1109         }
1110
1111         p = ofputil_protocol_from_string__(s, n);
1112         if (!p) {
1113             ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1114         }
1115         protocols |= p;
1116
1117         s += n;
1118     }
1119
1120     if (!protocols) {
1121         ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1122     }
1123     return protocols;
1124 }
1125
1126 bool
1127 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1128 {
1129     switch (packet_in_format) {
1130     case NXPIF_OPENFLOW10:
1131     case NXPIF_NXM:
1132         return true;
1133     }
1134
1135     return false;
1136 }
1137
1138 const char *
1139 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1140 {
1141     switch (packet_in_format) {
1142     case NXPIF_OPENFLOW10:
1143         return "openflow10";
1144     case NXPIF_NXM:
1145         return "nxm";
1146     default:
1147         NOT_REACHED();
1148     }
1149 }
1150
1151 int
1152 ofputil_packet_in_format_from_string(const char *s)
1153 {
1154     return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1155             : !strcmp(s, "nxm") ? NXPIF_NXM
1156             : -1);
1157 }
1158
1159 static bool
1160 regs_fully_wildcarded(const struct flow_wildcards *wc)
1161 {
1162     int i;
1163
1164     for (i = 0; i < FLOW_N_REGS; i++) {
1165         if (wc->reg_masks[i] != 0) {
1166             return false;
1167         }
1168     }
1169     return true;
1170 }
1171
1172 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
1173  * to a switch (e.g. to add or remove a flow).  Only NXM can handle tunnel IDs,
1174  * registers, or fixing the Ethernet multicast bit.  Otherwise, it's better to
1175  * use OpenFlow 1.0 protocol for backward compatibility. */
1176 enum ofputil_protocol
1177 ofputil_usable_protocols(const struct cls_rule *rule)
1178 {
1179     const struct flow_wildcards *wc = &rule->wc;
1180
1181     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
1182
1183     /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
1184     if (!eth_mask_is_exact(wc->dl_src_mask)
1185         && !eth_addr_is_zero(wc->dl_src_mask)) {
1186         return OFPUTIL_P_NXM_ANY;
1187     }
1188     if (!eth_mask_is_exact(wc->dl_dst_mask)
1189         && !eth_addr_is_zero(wc->dl_dst_mask)) {
1190         return OFPUTIL_P_NXM_ANY;
1191     }
1192
1193     /* Only NXM supports matching ARP hardware addresses. */
1194     if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
1195         return OFPUTIL_P_NXM_ANY;
1196     }
1197
1198     /* Only NXM supports matching IPv6 traffic. */
1199     if (!(wc->wildcards & FWW_DL_TYPE)
1200             && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
1201         return OFPUTIL_P_NXM_ANY;
1202     }
1203
1204     /* Only NXM supports matching registers. */
1205     if (!regs_fully_wildcarded(wc)) {
1206         return OFPUTIL_P_NXM_ANY;
1207     }
1208
1209     /* Only NXM supports matching tun_id. */
1210     if (wc->tun_id_mask != htonll(0)) {
1211         return OFPUTIL_P_NXM_ANY;
1212     }
1213
1214     /* Only NXM supports matching fragments. */
1215     if (wc->nw_frag_mask) {
1216         return OFPUTIL_P_NXM_ANY;
1217     }
1218
1219     /* Only NXM supports matching IPv6 flow label. */
1220     if (!(wc->wildcards & FWW_IPV6_LABEL)) {
1221         return OFPUTIL_P_NXM_ANY;
1222     }
1223
1224     /* Only NXM supports matching IP ECN bits. */
1225     if (!(wc->wildcards & FWW_NW_ECN)) {
1226         return OFPUTIL_P_NXM_ANY;
1227     }
1228
1229     /* Only NXM supports matching IP TTL/hop limit. */
1230     if (!(wc->wildcards & FWW_NW_TTL)) {
1231         return OFPUTIL_P_NXM_ANY;
1232     }
1233
1234     /* Only NXM supports bitwise matching on transport port. */
1235     if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
1236         (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
1237         return OFPUTIL_P_NXM_ANY;
1238     }
1239
1240     /* Other formats can express this rule. */
1241     return OFPUTIL_P_ANY;
1242 }
1243
1244 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1245  * protocol is 'current', at least partly transitions the protocol to 'want'.
1246  * Stores in '*next' the protocol that will be in effect on the OpenFlow
1247  * connection if the switch processes the returned message correctly.  (If
1248  * '*next != want' then the caller will have to iterate.)
1249  *
1250  * If 'current == want', returns NULL and stores 'current' in '*next'. */
1251 struct ofpbuf *
1252 ofputil_encode_set_protocol(enum ofputil_protocol current,
1253                             enum ofputil_protocol want,
1254                             enum ofputil_protocol *next)
1255 {
1256     enum ofputil_protocol cur_base, want_base;
1257     bool cur_tid, want_tid;
1258
1259     cur_base = ofputil_protocol_to_base(current);
1260     want_base = ofputil_protocol_to_base(want);
1261     if (cur_base != want_base) {
1262         *next = ofputil_protocol_set_base(current, want_base);
1263
1264         switch (want_base) {
1265         case OFPUTIL_P_NXM:
1266             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1267
1268         case OFPUTIL_P_OF10:
1269             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1270
1271         case OFPUTIL_P_OF10_TID:
1272         case OFPUTIL_P_NXM_TID:
1273             NOT_REACHED();
1274         }
1275     }
1276
1277     cur_tid = (current & OFPUTIL_P_TID) != 0;
1278     want_tid = (want & OFPUTIL_P_TID) != 0;
1279     if (cur_tid != want_tid) {
1280         *next = ofputil_protocol_set_tid(current, want_tid);
1281         return ofputil_make_flow_mod_table_id(want_tid);
1282     }
1283
1284     assert(current == want);
1285
1286     *next = current;
1287     return NULL;
1288 }
1289
1290 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1291  * format to 'nxff'.  */
1292 struct ofpbuf *
1293 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1294 {
1295     struct nx_set_flow_format *sff;
1296     struct ofpbuf *msg;
1297
1298     assert(ofputil_nx_flow_format_is_valid(nxff));
1299
1300     sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
1301     sff->format = htonl(nxff);
1302
1303     return msg;
1304 }
1305
1306 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1307  * otherwise. */
1308 enum ofputil_protocol
1309 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1310 {
1311     switch (flow_format) {
1312     case NXFF_OPENFLOW10:
1313         return OFPUTIL_P_OF10;
1314
1315     case NXFF_NXM:
1316         return OFPUTIL_P_NXM;
1317
1318     default:
1319         return 0;
1320     }
1321 }
1322
1323 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1324 bool
1325 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1326 {
1327     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1328 }
1329
1330 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1331  * value. */
1332 const char *
1333 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1334 {
1335     switch (flow_format) {
1336     case NXFF_OPENFLOW10:
1337         return "openflow10";
1338     case NXFF_NXM:
1339         return "nxm";
1340     default:
1341         NOT_REACHED();
1342     }
1343 }
1344
1345 struct ofpbuf *
1346 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1347 {
1348     struct nx_set_packet_in_format *spif;
1349     struct ofpbuf *msg;
1350
1351     spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg);
1352     spif->format = htonl(packet_in_format);
1353
1354     return msg;
1355 }
1356
1357 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1358  * extension on or off (according to 'flow_mod_table_id'). */
1359 struct ofpbuf *
1360 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1361 {
1362     struct nx_flow_mod_table_id *nfmti;
1363     struct ofpbuf *msg;
1364
1365     nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
1366     nfmti->set = flow_mod_table_id;
1367     return msg;
1368 }
1369
1370 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1371  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1372  * code.
1373  *
1374  * Does not validate the flow_mod actions. */
1375 enum ofperr
1376 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1377                         const struct ofp_header *oh,
1378                         enum ofputil_protocol protocol)
1379 {
1380     const struct ofputil_msg_type *type;
1381     uint16_t command;
1382     struct ofpbuf b;
1383
1384     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1385
1386     ofputil_decode_msg_type(oh, &type);
1387     if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
1388         /* Standard OpenFlow flow_mod. */
1389         const struct ofp_flow_mod *ofm;
1390         uint16_t priority;
1391         enum ofperr error;
1392
1393         /* Dissect the message. */
1394         ofm = ofpbuf_pull(&b, sizeof *ofm);
1395         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1396         if (error) {
1397             return error;
1398         }
1399
1400         /* Set priority based on original wildcards.  Normally we'd allow
1401          * ofputil_cls_rule_from_match() to do this for us, but
1402          * ofputil_normalize_rule() can put wildcards where the original flow
1403          * didn't have them. */
1404         priority = ntohs(ofm->priority);
1405         if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
1406             priority = UINT16_MAX;
1407         }
1408
1409         /* Translate the rule. */
1410         ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
1411         ofputil_normalize_rule(&fm->cr);
1412
1413         /* Translate the message. */
1414         command = ntohs(ofm->command);
1415         fm->cookie = htonll(0);
1416         fm->cookie_mask = htonll(0);
1417         fm->new_cookie = ofm->cookie;
1418         fm->idle_timeout = ntohs(ofm->idle_timeout);
1419         fm->hard_timeout = ntohs(ofm->hard_timeout);
1420         fm->buffer_id = ntohl(ofm->buffer_id);
1421         fm->out_port = ntohs(ofm->out_port);
1422         fm->flags = ntohs(ofm->flags);
1423     } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1424         /* Nicira extended flow_mod. */
1425         const struct nx_flow_mod *nfm;
1426         enum ofperr error;
1427
1428         /* Dissect the message. */
1429         nfm = ofpbuf_pull(&b, sizeof *nfm);
1430         error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1431                               &fm->cr, &fm->cookie, &fm->cookie_mask);
1432         if (error) {
1433             return error;
1434         }
1435         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1436         if (error) {
1437             return error;
1438         }
1439
1440         /* Translate the message. */
1441         command = ntohs(nfm->command);
1442         if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1443             /* Flow additions may only set a new cookie, not match an
1444              * existing cookie. */
1445             return OFPERR_NXBRC_NXM_INVALID;
1446         }
1447         fm->new_cookie = nfm->cookie;
1448         fm->idle_timeout = ntohs(nfm->idle_timeout);
1449         fm->hard_timeout = ntohs(nfm->hard_timeout);
1450         fm->buffer_id = ntohl(nfm->buffer_id);
1451         fm->out_port = ntohs(nfm->out_port);
1452         fm->flags = ntohs(nfm->flags);
1453     } else {
1454         NOT_REACHED();
1455     }
1456
1457     if (protocol & OFPUTIL_P_TID) {
1458         fm->command = command & 0xff;
1459         fm->table_id = command >> 8;
1460     } else {
1461         fm->command = command;
1462         fm->table_id = 0xff;
1463     }
1464
1465     return 0;
1466 }
1467
1468 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1469  * 'protocol' and returns the message. */
1470 struct ofpbuf *
1471 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1472                         enum ofputil_protocol protocol)
1473 {
1474     size_t actions_len = fm->n_actions * sizeof *fm->actions;
1475     struct ofp_flow_mod *ofm;
1476     struct nx_flow_mod *nfm;
1477     struct ofpbuf *msg;
1478     uint16_t command;
1479     int match_len;
1480
1481     command = (protocol & OFPUTIL_P_TID
1482                ? (fm->command & 0xff) | (fm->table_id << 8)
1483                : fm->command);
1484
1485     switch (protocol) {
1486     case OFPUTIL_P_OF10:
1487     case OFPUTIL_P_OF10_TID:
1488         msg = ofpbuf_new(sizeof *ofm + actions_len);
1489         ofm = put_openflow(sizeof *ofm, OFPT10_FLOW_MOD, msg);
1490         ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
1491         ofm->cookie = fm->new_cookie;
1492         ofm->command = htons(command);
1493         ofm->idle_timeout = htons(fm->idle_timeout);
1494         ofm->hard_timeout = htons(fm->hard_timeout);
1495         ofm->priority = htons(fm->cr.priority);
1496         ofm->buffer_id = htonl(fm->buffer_id);
1497         ofm->out_port = htons(fm->out_port);
1498         ofm->flags = htons(fm->flags);
1499         break;
1500
1501     case OFPUTIL_P_NXM:
1502     case OFPUTIL_P_NXM_TID:
1503         msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1504         put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1505         nfm = msg->data;
1506         nfm->command = htons(command);
1507         nfm->cookie = fm->new_cookie;
1508         match_len = nx_put_match(msg, false, &fm->cr,
1509                                  fm->cookie, fm->cookie_mask);
1510         nfm->idle_timeout = htons(fm->idle_timeout);
1511         nfm->hard_timeout = htons(fm->hard_timeout);
1512         nfm->priority = htons(fm->cr.priority);
1513         nfm->buffer_id = htonl(fm->buffer_id);
1514         nfm->out_port = htons(fm->out_port);
1515         nfm->flags = htons(fm->flags);
1516         nfm->match_len = htons(match_len);
1517         break;
1518
1519     default:
1520         NOT_REACHED();
1521     }
1522
1523     ofpbuf_put(msg, fm->actions, actions_len);
1524     update_openflow_length(msg);
1525     return msg;
1526 }
1527
1528 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1529  * send all of the 'n_fm's flow table modification requests in 'fms', and a
1530  * 0-bit for each protocol that is inadequate.
1531  *
1532  * (The return value will have at least one 1-bit.) */
1533 enum ofputil_protocol
1534 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1535                                   size_t n_fms)
1536 {
1537     enum ofputil_protocol usable_protocols;
1538     size_t i;
1539
1540     usable_protocols = OFPUTIL_P_ANY;
1541     for (i = 0; i < n_fms; i++) {
1542         const struct ofputil_flow_mod *fm = &fms[i];
1543
1544         usable_protocols &= ofputil_usable_protocols(&fm->cr);
1545         if (fm->table_id != 0xff) {
1546             usable_protocols &= OFPUTIL_P_TID;
1547         }
1548
1549         /* Matching of the cookie is only supported through NXM. */
1550         if (fm->cookie_mask != htonll(0)) {
1551             usable_protocols &= OFPUTIL_P_NXM_ANY;
1552         }
1553     }
1554     assert(usable_protocols);
1555
1556     return usable_protocols;
1557 }
1558
1559 static enum ofperr
1560 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1561                                   const struct ofp_header *oh,
1562                                   bool aggregate)
1563 {
1564     const struct ofp_flow_stats_request *ofsr =
1565         (const struct ofp_flow_stats_request *) oh;
1566
1567     fsr->aggregate = aggregate;
1568     ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1569     fsr->out_port = ntohs(ofsr->out_port);
1570     fsr->table_id = ofsr->table_id;
1571     fsr->cookie = fsr->cookie_mask = htonll(0);
1572
1573     return 0;
1574 }
1575
1576 static enum ofperr
1577 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1578                                  const struct ofp_header *oh,
1579                                  bool aggregate)
1580 {
1581     const struct nx_flow_stats_request *nfsr;
1582     struct ofpbuf b;
1583     enum ofperr error;
1584
1585     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1586
1587     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1588     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1589                           &fsr->cookie, &fsr->cookie_mask);
1590     if (error) {
1591         return error;
1592     }
1593     if (b.size) {
1594         return OFPERR_OFPBRC_BAD_LEN;
1595     }
1596
1597     fsr->aggregate = aggregate;
1598     fsr->out_port = ntohs(nfsr->out_port);
1599     fsr->table_id = nfsr->table_id;
1600
1601     return 0;
1602 }
1603
1604 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1605  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
1606  * successful, otherwise an OpenFlow error code. */
1607 enum ofperr
1608 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1609                                   const struct ofp_header *oh)
1610 {
1611     const struct ofputil_msg_type *type;
1612     struct ofpbuf b;
1613     int code;
1614
1615     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1616
1617     ofputil_decode_msg_type(oh, &type);
1618     code = ofputil_msg_type_code(type);
1619     switch (code) {
1620     case OFPUTIL_OFPST_FLOW_REQUEST:
1621         return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1622
1623     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1624         return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1625
1626     case OFPUTIL_NXST_FLOW_REQUEST:
1627         return ofputil_decode_nxst_flow_request(fsr, oh, false);
1628
1629     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1630         return ofputil_decode_nxst_flow_request(fsr, oh, true);
1631
1632     default:
1633         /* Hey, the caller lied. */
1634         NOT_REACHED();
1635     }
1636 }
1637
1638 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1639  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1640  * 'protocol', and returns the message. */
1641 struct ofpbuf *
1642 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1643                                   enum ofputil_protocol protocol)
1644 {
1645     struct ofpbuf *msg;
1646
1647     switch (protocol) {
1648     case OFPUTIL_P_OF10:
1649     case OFPUTIL_P_OF10_TID: {
1650         struct ofp_flow_stats_request *ofsr;
1651         int type;
1652
1653         type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1654         ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1655         ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1656         ofsr->table_id = fsr->table_id;
1657         ofsr->out_port = htons(fsr->out_port);
1658         break;
1659     }
1660
1661     case OFPUTIL_P_NXM:
1662     case OFPUTIL_P_NXM_TID: {
1663         struct nx_flow_stats_request *nfsr;
1664         int match_len;
1665         int subtype;
1666
1667         subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1668         ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1669         match_len = nx_put_match(msg, false, &fsr->match,
1670                                  fsr->cookie, fsr->cookie_mask);
1671
1672         nfsr = msg->data;
1673         nfsr->out_port = htons(fsr->out_port);
1674         nfsr->match_len = htons(match_len);
1675         nfsr->table_id = fsr->table_id;
1676         break;
1677     }
1678
1679     default:
1680         NOT_REACHED();
1681     }
1682
1683     return msg;
1684 }
1685
1686 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1687  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1688  *
1689  * (The return value will have at least one 1-bit.) */
1690 enum ofputil_protocol
1691 ofputil_flow_stats_request_usable_protocols(
1692     const struct ofputil_flow_stats_request *fsr)
1693 {
1694     enum ofputil_protocol usable_protocols;
1695
1696     usable_protocols = ofputil_usable_protocols(&fsr->match);
1697     if (fsr->cookie_mask != htonll(0)) {
1698         usable_protocols &= OFPUTIL_P_NXM_ANY;
1699     }
1700     return usable_protocols;
1701 }
1702
1703 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1704  * ofputil_flow_stats in 'fs'.
1705  *
1706  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1707  * OpenFlow message.  Calling this function multiple times for a single 'msg'
1708  * iterates through the replies.  The caller must initially leave 'msg''s layer
1709  * pointers null and not modify them between calls.
1710  *
1711  * Most switches don't send the values needed to populate fs->idle_age and
1712  * fs->hard_age, so those members will usually be set to 0.  If the switch from
1713  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1714  * 'flow_age_extension' as true so that the contents of 'msg' determine the
1715  * 'idle_age' and 'hard_age' members in 'fs'.
1716  *
1717  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1718  * otherwise a positive errno value. */
1719 int
1720 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1721                                 struct ofpbuf *msg,
1722                                 bool flow_age_extension)
1723 {
1724     const struct ofputil_msg_type *type;
1725     int code;
1726
1727     ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1728     code = ofputil_msg_type_code(type);
1729     if (!msg->l2) {
1730         msg->l2 = msg->data;
1731         if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1732             ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1733         } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1734             ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1735         } else {
1736             NOT_REACHED();
1737         }
1738     }
1739
1740     if (!msg->size) {
1741         return EOF;
1742     } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1743         const struct ofp_flow_stats *ofs;
1744         size_t length;
1745
1746         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1747         if (!ofs) {
1748             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1749                          "bytes at end", msg->size);
1750             return EINVAL;
1751         }
1752
1753         length = ntohs(ofs->length);
1754         if (length < sizeof *ofs) {
1755             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1756                          "length %zu", length);
1757             return EINVAL;
1758         }
1759
1760         if (ofputil_pull_actions(msg, length - sizeof *ofs,
1761                                  &fs->actions, &fs->n_actions)) {
1762             return EINVAL;
1763         }
1764
1765         fs->cookie = get_32aligned_be64(&ofs->cookie);
1766         ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1767                                     &fs->rule);
1768         fs->table_id = ofs->table_id;
1769         fs->duration_sec = ntohl(ofs->duration_sec);
1770         fs->duration_nsec = ntohl(ofs->duration_nsec);
1771         fs->idle_timeout = ntohs(ofs->idle_timeout);
1772         fs->hard_timeout = ntohs(ofs->hard_timeout);
1773         fs->idle_age = -1;
1774         fs->hard_age = -1;
1775         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1776         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1777     } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1778         const struct nx_flow_stats *nfs;
1779         size_t match_len, length;
1780
1781         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1782         if (!nfs) {
1783             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1784                          "bytes at end", msg->size);
1785             return EINVAL;
1786         }
1787
1788         length = ntohs(nfs->length);
1789         match_len = ntohs(nfs->match_len);
1790         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1791             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1792                          "claims invalid length %zu", match_len, length);
1793             return EINVAL;
1794         }
1795         if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1796                           NULL, NULL)) {
1797             return EINVAL;
1798         }
1799
1800         if (ofputil_pull_actions(msg,
1801                                  length - sizeof *nfs - ROUND_UP(match_len, 8),
1802                                  &fs->actions, &fs->n_actions)) {
1803             return EINVAL;
1804         }
1805
1806         fs->cookie = nfs->cookie;
1807         fs->table_id = nfs->table_id;
1808         fs->duration_sec = ntohl(nfs->duration_sec);
1809         fs->duration_nsec = ntohl(nfs->duration_nsec);
1810         fs->idle_timeout = ntohs(nfs->idle_timeout);
1811         fs->hard_timeout = ntohs(nfs->hard_timeout);
1812         fs->idle_age = -1;
1813         fs->hard_age = -1;
1814         if (flow_age_extension) {
1815             if (nfs->idle_age) {
1816                 fs->idle_age = ntohs(nfs->idle_age) - 1;
1817             }
1818             if (nfs->hard_age) {
1819                 fs->hard_age = ntohs(nfs->hard_age) - 1;
1820             }
1821         }
1822         fs->packet_count = ntohll(nfs->packet_count);
1823         fs->byte_count = ntohll(nfs->byte_count);
1824     } else {
1825         NOT_REACHED();
1826     }
1827
1828     return 0;
1829 }
1830
1831 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1832  *
1833  * We use this in situations where OVS internally uses UINT64_MAX to mean
1834  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1835 static uint64_t
1836 unknown_to_zero(uint64_t count)
1837 {
1838     return count != UINT64_MAX ? count : 0;
1839 }
1840
1841 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1842  * those already present in the list of ofpbufs in 'replies'.  'replies' should
1843  * have been initialized with ofputil_start_stats_reply(). */
1844 void
1845 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1846                                 struct list *replies)
1847 {
1848     size_t act_len = fs->n_actions * sizeof *fs->actions;
1849     const struct ofp_stats_msg *osm;
1850
1851     osm = ofpbuf_from_list(list_back(replies))->data;
1852     if (osm->type == htons(OFPST_FLOW)) {
1853         size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1854         struct ofp_flow_stats *ofs;
1855
1856         ofs = ofputil_append_stats_reply(len, replies);
1857         ofs->length = htons(len);
1858         ofs->table_id = fs->table_id;
1859         ofs->pad = 0;
1860         ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1861         ofs->duration_sec = htonl(fs->duration_sec);
1862         ofs->duration_nsec = htonl(fs->duration_nsec);
1863         ofs->priority = htons(fs->rule.priority);
1864         ofs->idle_timeout = htons(fs->idle_timeout);
1865         ofs->hard_timeout = htons(fs->hard_timeout);
1866         memset(ofs->pad2, 0, sizeof ofs->pad2);
1867         put_32aligned_be64(&ofs->cookie, fs->cookie);
1868         put_32aligned_be64(&ofs->packet_count,
1869                            htonll(unknown_to_zero(fs->packet_count)));
1870         put_32aligned_be64(&ofs->byte_count,
1871                            htonll(unknown_to_zero(fs->byte_count)));
1872         memcpy(ofs->actions, fs->actions, act_len);
1873     } else if (osm->type == htons(OFPST_VENDOR)) {
1874         struct nx_flow_stats *nfs;
1875         struct ofpbuf *msg;
1876         size_t start_len;
1877
1878         msg = ofputil_reserve_stats_reply(
1879             sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1880         start_len = msg->size;
1881
1882         nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1883         nfs->table_id = fs->table_id;
1884         nfs->pad = 0;
1885         nfs->duration_sec = htonl(fs->duration_sec);
1886         nfs->duration_nsec = htonl(fs->duration_nsec);
1887         nfs->priority = htons(fs->rule.priority);
1888         nfs->idle_timeout = htons(fs->idle_timeout);
1889         nfs->hard_timeout = htons(fs->hard_timeout);
1890         nfs->idle_age = htons(fs->idle_age < 0 ? 0
1891                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1892                               : UINT16_MAX);
1893         nfs->hard_age = htons(fs->hard_age < 0 ? 0
1894                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1895                               : UINT16_MAX);
1896         nfs->match_len = htons(nx_put_match(msg, false, &fs->rule, 0, 0));
1897         nfs->cookie = fs->cookie;
1898         nfs->packet_count = htonll(fs->packet_count);
1899         nfs->byte_count = htonll(fs->byte_count);
1900         ofpbuf_put(msg, fs->actions, act_len);
1901         nfs->length = htons(msg->size - start_len);
1902     } else {
1903         NOT_REACHED();
1904     }
1905 }
1906
1907 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1908  * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
1909 struct ofpbuf *
1910 ofputil_encode_aggregate_stats_reply(
1911     const struct ofputil_aggregate_stats *stats,
1912     const struct ofp_stats_msg *request)
1913 {
1914     struct ofpbuf *msg;
1915
1916     if (request->type == htons(OFPST_AGGREGATE)) {
1917         struct ofp_aggregate_stats_reply *asr;
1918
1919         asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1920         put_32aligned_be64(&asr->packet_count,
1921                            htonll(unknown_to_zero(stats->packet_count)));
1922         put_32aligned_be64(&asr->byte_count,
1923                            htonll(unknown_to_zero(stats->byte_count)));
1924         asr->flow_count = htonl(stats->flow_count);
1925     } else if (request->type == htons(OFPST_VENDOR)) {
1926         struct nx_aggregate_stats_reply *nasr;
1927
1928         nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1929         assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1930         nasr->packet_count = htonll(stats->packet_count);
1931         nasr->byte_count = htonll(stats->byte_count);
1932         nasr->flow_count = htonl(stats->flow_count);
1933     } else {
1934         NOT_REACHED();
1935     }
1936
1937     return msg;
1938 }
1939
1940 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1941  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
1942  * an OpenFlow error code. */
1943 enum ofperr
1944 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1945                             const struct ofp_header *oh)
1946 {
1947     const struct ofputil_msg_type *type;
1948     enum ofputil_msg_code code;
1949
1950     ofputil_decode_msg_type(oh, &type);
1951     code = ofputil_msg_type_code(type);
1952     if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1953         const struct ofp_flow_removed *ofr;
1954
1955         ofr = (const struct ofp_flow_removed *) oh;
1956         ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1957                                     &fr->rule);
1958         fr->cookie = ofr->cookie;
1959         fr->reason = ofr->reason;
1960         fr->duration_sec = ntohl(ofr->duration_sec);
1961         fr->duration_nsec = ntohl(ofr->duration_nsec);
1962         fr->idle_timeout = ntohs(ofr->idle_timeout);
1963         fr->packet_count = ntohll(ofr->packet_count);
1964         fr->byte_count = ntohll(ofr->byte_count);
1965     } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1966         struct nx_flow_removed *nfr;
1967         struct ofpbuf b;
1968         int error;
1969
1970         ofpbuf_use_const(&b, oh, ntohs(oh->length));
1971
1972         nfr = ofpbuf_pull(&b, sizeof *nfr);
1973         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1974                               &fr->rule, NULL, NULL);
1975         if (error) {
1976             return error;
1977         }
1978         if (b.size) {
1979             return OFPERR_OFPBRC_BAD_LEN;
1980         }
1981
1982         fr->cookie = nfr->cookie;
1983         fr->reason = nfr->reason;
1984         fr->duration_sec = ntohl(nfr->duration_sec);
1985         fr->duration_nsec = ntohl(nfr->duration_nsec);
1986         fr->idle_timeout = ntohs(nfr->idle_timeout);
1987         fr->packet_count = ntohll(nfr->packet_count);
1988         fr->byte_count = ntohll(nfr->byte_count);
1989     } else {
1990         NOT_REACHED();
1991     }
1992
1993     return 0;
1994 }
1995
1996 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1997  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1998  * message. */
1999 struct ofpbuf *
2000 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2001                             enum ofputil_protocol protocol)
2002 {
2003     struct ofpbuf *msg;
2004
2005     switch (protocol) {
2006     case OFPUTIL_P_OF10:
2007     case OFPUTIL_P_OF10_TID: {
2008         struct ofp_flow_removed *ofr;
2009
2010         ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
2011                                 &msg);
2012         ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
2013         ofr->cookie = fr->cookie;
2014         ofr->priority = htons(fr->rule.priority);
2015         ofr->reason = fr->reason;
2016         ofr->duration_sec = htonl(fr->duration_sec);
2017         ofr->duration_nsec = htonl(fr->duration_nsec);
2018         ofr->idle_timeout = htons(fr->idle_timeout);
2019         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2020         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2021         break;
2022     }
2023
2024     case OFPUTIL_P_NXM:
2025     case OFPUTIL_P_NXM_TID: {
2026         struct nx_flow_removed *nfr;
2027         int match_len;
2028
2029         make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
2030         match_len = nx_put_match(msg, false, &fr->rule, 0, 0);
2031
2032         nfr = msg->data;
2033         nfr->cookie = fr->cookie;
2034         nfr->priority = htons(fr->rule.priority);
2035         nfr->reason = fr->reason;
2036         nfr->duration_sec = htonl(fr->duration_sec);
2037         nfr->duration_nsec = htonl(fr->duration_nsec);
2038         nfr->idle_timeout = htons(fr->idle_timeout);
2039         nfr->match_len = htons(match_len);
2040         nfr->packet_count = htonll(fr->packet_count);
2041         nfr->byte_count = htonll(fr->byte_count);
2042         break;
2043     }
2044
2045     default:
2046         NOT_REACHED();
2047     }
2048
2049     return msg;
2050 }
2051
2052 int
2053 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2054                          const struct ofp_header *oh)
2055 {
2056     const struct ofputil_msg_type *type;
2057     enum ofputil_msg_code code;
2058
2059     ofputil_decode_msg_type(oh, &type);
2060     code = ofputil_msg_type_code(type);
2061     memset(pin, 0, sizeof *pin);
2062
2063     if (code == OFPUTIL_OFPT_PACKET_IN) {
2064         const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
2065
2066         pin->packet = opi->data;
2067         pin->packet_len = ntohs(opi->header.length)
2068             - offsetof(struct ofp_packet_in, data);
2069
2070         pin->fmd.in_port = ntohs(opi->in_port);
2071         pin->reason = opi->reason;
2072         pin->buffer_id = ntohl(opi->buffer_id);
2073         pin->total_len = ntohs(opi->total_len);
2074     } else if (code == OFPUTIL_NXT_PACKET_IN) {
2075         const struct nx_packet_in *npi;
2076         struct cls_rule rule;
2077         struct ofpbuf b;
2078         int error;
2079
2080         ofpbuf_use_const(&b, oh, ntohs(oh->length));
2081
2082         npi = ofpbuf_pull(&b, sizeof *npi);
2083         error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2084                                     NULL);
2085         if (error) {
2086             return error;
2087         }
2088
2089         if (!ofpbuf_try_pull(&b, 2)) {
2090             return OFPERR_OFPBRC_BAD_LEN;
2091         }
2092
2093         pin->packet = b.data;
2094         pin->packet_len = b.size;
2095         pin->reason = npi->reason;
2096         pin->table_id = npi->table_id;
2097         pin->cookie = npi->cookie;
2098
2099         pin->fmd.in_port = rule.flow.in_port;
2100
2101         pin->fmd.tun_id = rule.flow.tun_id;
2102         pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
2103
2104         memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
2105         memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
2106                sizeof pin->fmd.reg_masks);
2107
2108         pin->buffer_id = ntohl(npi->buffer_id);
2109         pin->total_len = ntohs(npi->total_len);
2110     } else {
2111         NOT_REACHED();
2112     }
2113
2114     return 0;
2115 }
2116
2117 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2118  * in the format specified by 'packet_in_format'.  */
2119 struct ofpbuf *
2120 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2121                          enum nx_packet_in_format packet_in_format)
2122 {
2123     size_t send_len = MIN(pin->send_len, pin->packet_len);
2124     struct ofpbuf *packet;
2125
2126     /* Add OFPT_PACKET_IN. */
2127     if (packet_in_format == NXPIF_OPENFLOW10) {
2128         size_t header_len = offsetof(struct ofp_packet_in, data);
2129         struct ofp_packet_in *opi;
2130
2131         packet = ofpbuf_new(send_len + header_len);
2132         opi = ofpbuf_put_zeros(packet, header_len);
2133         opi->header.version = OFP10_VERSION;
2134         opi->header.type = OFPT_PACKET_IN;
2135         opi->total_len = htons(pin->total_len);
2136         opi->in_port = htons(pin->fmd.in_port);
2137         opi->reason = pin->reason;
2138         opi->buffer_id = htonl(pin->buffer_id);
2139
2140         ofpbuf_put(packet, pin->packet, send_len);
2141     } else if (packet_in_format == NXPIF_NXM) {
2142         struct nx_packet_in *npi;
2143         struct cls_rule rule;
2144         size_t match_len;
2145         size_t i;
2146
2147         /* Estimate of required PACKET_IN length includes the NPI header, space
2148          * for the match (2 times sizeof the metadata seems like enough), 2
2149          * bytes for padding, and the packet length. */
2150         packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
2151                             + 2 + send_len);
2152
2153         cls_rule_init_catchall(&rule, 0);
2154         cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
2155                                    pin->fmd.tun_id_mask);
2156
2157         for (i = 0; i < FLOW_N_REGS; i++) {
2158             cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
2159                                     pin->fmd.reg_masks[i]);
2160         }
2161
2162         cls_rule_set_in_port(&rule, pin->fmd.in_port);
2163
2164         ofpbuf_put_zeros(packet, sizeof *npi);
2165         match_len = nx_put_match(packet, false, &rule, 0, 0);
2166         ofpbuf_put_zeros(packet, 2);
2167         ofpbuf_put(packet, pin->packet, send_len);
2168
2169         npi = packet->data;
2170         npi->nxh.header.version = OFP10_VERSION;
2171         npi->nxh.header.type = OFPT_VENDOR;
2172         npi->nxh.vendor = htonl(NX_VENDOR_ID);
2173         npi->nxh.subtype = htonl(NXT_PACKET_IN);
2174
2175         npi->buffer_id = htonl(pin->buffer_id);
2176         npi->total_len = htons(pin->total_len);
2177         npi->reason = pin->reason;
2178         npi->table_id = pin->table_id;
2179         npi->cookie = pin->cookie;
2180         npi->match_len = htons(match_len);
2181     } else {
2182         NOT_REACHED();
2183     }
2184     update_openflow_length(packet);
2185
2186     return packet;
2187 }
2188
2189 const char *
2190 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2191 {
2192     static char s[INT_STRLEN(int) + 1];
2193
2194     switch (reason) {
2195     case OFPR_NO_MATCH:
2196         return "no_match";
2197     case OFPR_ACTION:
2198         return "action";
2199     case OFPR_INVALID_TTL:
2200         return "invalid_ttl";
2201
2202     case OFPR_N_REASONS:
2203     default:
2204         sprintf(s, "%d", (int) reason);
2205         return s;
2206     }
2207 }
2208
2209 bool
2210 ofputil_packet_in_reason_from_string(const char *s,
2211                                      enum ofp_packet_in_reason *reason)
2212 {
2213     int i;
2214
2215     for (i = 0; i < OFPR_N_REASONS; i++) {
2216         if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2217             *reason = i;
2218             return true;
2219         }
2220     }
2221     return false;
2222 }
2223
2224 enum ofperr
2225 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2226                           const struct ofp_packet_out *opo)
2227 {
2228     enum ofperr error;
2229     struct ofpbuf b;
2230
2231     po->buffer_id = ntohl(opo->buffer_id);
2232     po->in_port = ntohs(opo->in_port);
2233     if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2234         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2235         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2236                      po->in_port);
2237         return OFPERR_NXBRC_BAD_IN_PORT;
2238     }
2239
2240     ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
2241     ofpbuf_pull(&b, sizeof *opo);
2242
2243     error = ofputil_pull_actions(&b, ntohs(opo->actions_len),
2244                                  &po->actions, &po->n_actions);
2245     if (error) {
2246         return error;
2247     }
2248
2249     if (po->buffer_id == UINT32_MAX) {
2250         po->packet = b.data;
2251         po->packet_len = b.size;
2252     } else {
2253         po->packet = NULL;
2254         po->packet_len = 0;
2255     }
2256
2257     return 0;
2258 }
2259 \f
2260 /* ofputil_phy_port */
2261
2262 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2263 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
2264 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
2265 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
2266 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
2267 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
2268 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
2269 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
2270
2271 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2272 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2273 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2274 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2275 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2276 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2277
2278 static enum netdev_features
2279 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2280 {
2281     uint32_t ofp10 = ntohl(ofp10_);
2282     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2283 }
2284
2285 static ovs_be32
2286 netdev_port_features_to_ofp10(enum netdev_features features)
2287 {
2288     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2289 }
2290
2291 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
2292 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
2293 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
2294 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
2295 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
2296 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
2297 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
2298 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
2299 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
2300 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
2301 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
2302 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
2303 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
2304 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
2305 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
2306 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2307
2308 static enum netdev_features
2309 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2310 {
2311     return ntohl(ofp11) & 0xffff;
2312 }
2313
2314 static ovs_be32
2315 netdev_port_features_to_ofp11(enum netdev_features features)
2316 {
2317     return htonl(features & 0xffff);
2318 }
2319
2320 static enum ofperr
2321 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2322                               const struct ofp10_phy_port *opp)
2323 {
2324     memset(pp, 0, sizeof *pp);
2325
2326     pp->port_no = ntohs(opp->port_no);
2327     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2328     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2329
2330     pp->config = ntohl(opp->config) & OFPPC10_ALL;
2331     pp->state = ntohl(opp->state) & OFPPS10_ALL;
2332
2333     pp->curr = netdev_port_features_from_ofp10(opp->curr);
2334     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2335     pp->supported = netdev_port_features_from_ofp10(opp->supported);
2336     pp->peer = netdev_port_features_from_ofp10(opp->peer);
2337
2338     pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2339     pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2340
2341     return 0;
2342 }
2343
2344 static enum ofperr
2345 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2346                           const struct ofp11_port *op)
2347 {
2348     enum ofperr error;
2349
2350     memset(pp, 0, sizeof *pp);
2351
2352     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2353     if (error) {
2354         return error;
2355     }
2356     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2357     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2358
2359     pp->config = ntohl(op->config) & OFPPC11_ALL;
2360     pp->state = ntohl(op->state) & OFPPC11_ALL;
2361
2362     pp->curr = netdev_port_features_from_ofp11(op->curr);
2363     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2364     pp->supported = netdev_port_features_from_ofp11(op->supported);
2365     pp->peer = netdev_port_features_from_ofp11(op->peer);
2366
2367     pp->curr_speed = ntohl(op->curr_speed);
2368     pp->max_speed = ntohl(op->max_speed);
2369
2370     return 0;
2371 }
2372
2373 static size_t
2374 ofputil_get_phy_port_size(uint8_t ofp_version)
2375 {
2376     return ofp_version == OFP10_VERSION ? sizeof(struct ofp10_phy_port)
2377                                         : sizeof(struct ofp11_port);
2378 }
2379
2380 static void
2381 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2382                               struct ofp10_phy_port *opp)
2383 {
2384     memset(opp, 0, sizeof *opp);
2385
2386     opp->port_no = htons(pp->port_no);
2387     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2388     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2389
2390     opp->config = htonl(pp->config & OFPPC10_ALL);
2391     opp->state = htonl(pp->state & OFPPS10_ALL);
2392
2393     opp->curr = netdev_port_features_to_ofp10(pp->curr);
2394     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2395     opp->supported = netdev_port_features_to_ofp10(pp->supported);
2396     opp->peer = netdev_port_features_to_ofp10(pp->peer);
2397 }
2398
2399 static void
2400 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2401                           struct ofp11_port *op)
2402 {
2403     memset(op, 0, sizeof *op);
2404
2405     op->port_no = ofputil_port_to_ofp11(pp->port_no);
2406     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2407     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2408
2409     op->config = htonl(pp->config & OFPPC11_ALL);
2410     op->state = htonl(pp->state & OFPPS11_ALL);
2411
2412     op->curr = netdev_port_features_to_ofp11(pp->curr);
2413     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2414     op->supported = netdev_port_features_to_ofp11(pp->supported);
2415     op->peer = netdev_port_features_to_ofp11(pp->peer);
2416
2417     op->curr_speed = htonl(pp->curr_speed);
2418     op->max_speed = htonl(pp->max_speed);
2419 }
2420
2421 static void
2422 ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
2423                      struct ofpbuf *b)
2424 {
2425     if (ofp_version == OFP10_VERSION) {
2426         struct ofp10_phy_port *opp;
2427         if (b->size + sizeof *opp <= UINT16_MAX) {
2428             opp = ofpbuf_put_uninit(b, sizeof *opp);
2429             ofputil_encode_ofp10_phy_port(pp, opp);
2430         }
2431     } else {
2432         struct ofp11_port *op;
2433         if (b->size + sizeof *op <= UINT16_MAX) {
2434             op = ofpbuf_put_uninit(b, sizeof *op);
2435             ofputil_encode_ofp11_port(pp, op);
2436         }
2437     }
2438 }
2439
2440 void
2441 ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
2442                                      const struct ofputil_phy_port *pp,
2443                                      struct list *replies)
2444 {
2445     if (ofp_version == OFP10_VERSION) {
2446         struct ofp10_phy_port *opp;
2447
2448         opp = ofputil_append_stats_reply(sizeof *opp, replies);
2449         ofputil_encode_ofp10_phy_port(pp, opp);
2450     } else {
2451         struct ofp11_port *op;
2452
2453         op = ofputil_append_stats_reply(sizeof *op, replies);
2454         ofputil_encode_ofp11_port(pp, op);
2455     }
2456 }
2457 \f
2458 /* ofputil_switch_features */
2459
2460 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2461                      OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
2462 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2463 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2464 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2465 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2466 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2467 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2468
2469 struct ofputil_action_bit_translation {
2470     enum ofputil_action_bitmap ofputil_bit;
2471     int of_bit;
2472 };
2473
2474 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2475     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
2476     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2477     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2478     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
2479     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
2480     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
2481     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
2482     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
2483     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
2484     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
2485     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
2486     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
2487     { 0, 0 },
2488 };
2489
2490 static const struct ofputil_action_bit_translation of11_action_bits[] = {
2491     { OFPUTIL_A_OUTPUT,         OFPAT11_OUTPUT },
2492     { OFPUTIL_A_SET_VLAN_VID,   OFPAT11_SET_VLAN_VID },
2493     { OFPUTIL_A_SET_VLAN_PCP,   OFPAT11_SET_VLAN_PCP },
2494     { OFPUTIL_A_SET_DL_SRC,     OFPAT11_SET_DL_SRC },
2495     { OFPUTIL_A_SET_DL_DST,     OFPAT11_SET_DL_DST },
2496     { OFPUTIL_A_SET_NW_SRC,     OFPAT11_SET_NW_SRC },
2497     { OFPUTIL_A_SET_NW_DST,     OFPAT11_SET_NW_DST },
2498     { OFPUTIL_A_SET_NW_TOS,     OFPAT11_SET_NW_TOS },
2499     { OFPUTIL_A_SET_NW_ECN,     OFPAT11_SET_NW_ECN },
2500     { OFPUTIL_A_SET_TP_SRC,     OFPAT11_SET_TP_SRC },
2501     { OFPUTIL_A_SET_TP_DST,     OFPAT11_SET_TP_DST },
2502     { OFPUTIL_A_COPY_TTL_OUT,   OFPAT11_COPY_TTL_OUT },
2503     { OFPUTIL_A_COPY_TTL_IN,    OFPAT11_COPY_TTL_IN },
2504     { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
2505     { OFPUTIL_A_SET_MPLS_TC,    OFPAT11_SET_MPLS_TC },
2506     { OFPUTIL_A_SET_MPLS_TTL,   OFPAT11_SET_MPLS_TTL },
2507     { OFPUTIL_A_DEC_MPLS_TTL,   OFPAT11_DEC_MPLS_TTL },
2508     { OFPUTIL_A_PUSH_VLAN,      OFPAT11_PUSH_VLAN },
2509     { OFPUTIL_A_POP_VLAN,       OFPAT11_POP_VLAN },
2510     { OFPUTIL_A_PUSH_MPLS,      OFPAT11_PUSH_MPLS },
2511     { OFPUTIL_A_POP_MPLS,       OFPAT11_POP_MPLS },
2512     { OFPUTIL_A_SET_QUEUE,      OFPAT11_SET_QUEUE },
2513     { OFPUTIL_A_GROUP,          OFPAT11_GROUP },
2514     { OFPUTIL_A_SET_NW_TTL,     OFPAT11_SET_NW_TTL },
2515     { OFPUTIL_A_DEC_NW_TTL,     OFPAT11_DEC_NW_TTL },
2516     { 0, 0 },
2517 };
2518
2519 static enum ofputil_action_bitmap
2520 decode_action_bits(ovs_be32 of_actions,
2521                    const struct ofputil_action_bit_translation *x)
2522 {
2523     enum ofputil_action_bitmap ofputil_actions;
2524
2525     ofputil_actions = 0;
2526     for (; x->ofputil_bit; x++) {
2527         if (of_actions & htonl(1u << x->of_bit)) {
2528             ofputil_actions |= x->ofputil_bit;
2529         }
2530     }
2531     return ofputil_actions;
2532 }
2533
2534 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2535  * abstract representation in '*features'.  Initializes '*b' to iterate over
2536  * the OpenFlow port structures following 'osf' with later calls to
2537  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
2538  * OFPERR_* value.  */
2539 enum ofperr
2540 ofputil_decode_switch_features(const struct ofp_switch_features *osf,
2541                                struct ofputil_switch_features *features,
2542                                struct ofpbuf *b)
2543 {
2544     ofpbuf_use_const(b, osf, ntohs(osf->header.length));
2545     ofpbuf_pull(b, sizeof *osf);
2546
2547     features->datapath_id = ntohll(osf->datapath_id);
2548     features->n_buffers = ntohl(osf->n_buffers);
2549     features->n_tables = osf->n_tables;
2550
2551     features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
2552
2553     if (b->size % ofputil_get_phy_port_size(osf->header.version)) {
2554         return OFPERR_OFPBRC_BAD_LEN;
2555     }
2556
2557     if (osf->header.version == OFP10_VERSION) {
2558         if (osf->capabilities & htonl(OFPC10_STP)) {
2559             features->capabilities |= OFPUTIL_C_STP;
2560         }
2561         features->actions = decode_action_bits(osf->actions, of10_action_bits);
2562     } else if (osf->header.version == OFP11_VERSION) {
2563         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2564             features->capabilities |= OFPUTIL_C_GROUP_STATS;
2565         }
2566         features->actions = decode_action_bits(osf->actions, of11_action_bits);
2567     } else {
2568         return OFPERR_OFPBRC_BAD_VERSION;
2569     }
2570
2571     return 0;
2572 }
2573
2574 /* Returns true if the maximum number of ports are in 'osf'. */
2575 static bool
2576 max_ports_in_features(const struct ofp_switch_features *osf)
2577 {
2578     size_t pp_size = ofputil_get_phy_port_size(osf->header.version);
2579     return ntohs(osf->header.length) + pp_size > UINT16_MAX;
2580 }
2581
2582 /* Given a buffer 'b' that contains a Features Reply message, checks if
2583  * it contains the maximum number of ports that will fit.  If so, it
2584  * returns true and removes the ports from the message.  The caller
2585  * should then send an OFPST_PORT_DESC stats request to get the ports,
2586  * since the switch may have more ports than could be represented in the
2587  * Features Reply.  Otherwise, returns false.
2588  */
2589 bool
2590 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2591 {
2592     struct ofp_switch_features *osf = b->data;
2593
2594     if (max_ports_in_features(osf)) {
2595         /* Remove all the ports. */
2596         b->size = sizeof(*osf);
2597         update_openflow_length(b);
2598
2599         return true;
2600     }
2601
2602     return false;
2603 }
2604
2605 static ovs_be32
2606 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2607                    const struct ofputil_action_bit_translation *x)
2608 {
2609     uint32_t of_actions;
2610
2611     of_actions = 0;
2612     for (; x->ofputil_bit; x++) {
2613         if (ofputil_actions & x->ofputil_bit) {
2614             of_actions |= 1 << x->of_bit;
2615         }
2616     }
2617     return htonl(of_actions);
2618 }
2619
2620 /* Returns a buffer owned by the caller that encodes 'features' in the format
2621  * required by 'protocol' with the given 'xid'.  The caller should append port
2622  * information to the buffer with subsequent calls to
2623  * ofputil_put_switch_features_port(). */
2624 struct ofpbuf *
2625 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2626                                enum ofputil_protocol protocol, ovs_be32 xid)
2627 {
2628     struct ofp_switch_features *osf;
2629     struct ofpbuf *b;
2630
2631     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
2632     osf->header.version = ofputil_protocol_to_ofp_version(protocol);
2633     osf->datapath_id = htonll(features->datapath_id);
2634     osf->n_buffers = htonl(features->n_buffers);
2635     osf->n_tables = features->n_tables;
2636
2637     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2638     if (osf->header.version == OFP10_VERSION) {
2639         if (features->capabilities & OFPUTIL_C_STP) {
2640             osf->capabilities |= htonl(OFPC10_STP);
2641         }
2642         osf->actions = encode_action_bits(features->actions, of10_action_bits);
2643     } else {
2644         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2645             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2646         }
2647         osf->actions = encode_action_bits(features->actions, of11_action_bits);
2648     }
2649
2650     return b;
2651 }
2652
2653 /* Encodes 'pp' into the format required by the switch_features message already
2654  * in 'b', which should have been returned by ofputil_encode_switch_features(),
2655  * and appends the encoded version to 'b'. */
2656 void
2657 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2658                                  struct ofpbuf *b)
2659 {
2660     const struct ofp_switch_features *osf = b->data;
2661
2662     ofputil_put_phy_port(osf->header.version, pp, b);
2663 }
2664 \f
2665 /* ofputil_port_status */
2666
2667 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2668  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2669 enum ofperr
2670 ofputil_decode_port_status(const struct ofp_port_status *ops,
2671                            struct ofputil_port_status *ps)
2672 {
2673     struct ofpbuf b;
2674     int retval;
2675
2676     if (ops->reason != OFPPR_ADD &&
2677         ops->reason != OFPPR_DELETE &&
2678         ops->reason != OFPPR_MODIFY) {
2679         return OFPERR_NXBRC_BAD_REASON;
2680     }
2681     ps->reason = ops->reason;
2682
2683     ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
2684     ofpbuf_pull(&b, sizeof *ops);
2685     retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
2686     assert(retval != EOF);
2687     return retval;
2688 }
2689
2690 /* Converts the abstract form of a "port status" message in '*ps' into an
2691  * OpenFlow message suitable for 'protocol', and returns that encoded form in
2692  * a buffer owned by the caller. */
2693 struct ofpbuf *
2694 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2695                            enum ofputil_protocol protocol)
2696 {
2697     struct ofp_port_status *ops;
2698     struct ofpbuf *b;
2699
2700     b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
2701     ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
2702     ops->header.version = ofputil_protocol_to_ofp_version(protocol);
2703     ops->reason = ps->reason;
2704     ofputil_put_phy_port(ops->header.version, &ps->desc, b);
2705     update_openflow_length(b);
2706     return b;
2707 }
2708 \f
2709 /* ofputil_port_mod */
2710
2711 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2712  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2713 enum ofperr
2714 ofputil_decode_port_mod(const struct ofp_header *oh,
2715                         struct ofputil_port_mod *pm)
2716 {
2717     if (oh->version == OFP10_VERSION) {
2718         const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
2719
2720         if (oh->length != htons(sizeof *opm)) {
2721             return OFPERR_OFPBRC_BAD_LEN;
2722         }
2723
2724         pm->port_no = ntohs(opm->port_no);
2725         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2726         pm->config = ntohl(opm->config) & OFPPC10_ALL;
2727         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2728         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2729     } else if (oh->version == OFP11_VERSION) {
2730         const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
2731         enum ofperr error;
2732
2733         if (oh->length != htons(sizeof *opm)) {
2734             return OFPERR_OFPBRC_BAD_LEN;
2735         }
2736
2737         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2738         if (error) {
2739             return error;
2740         }
2741
2742         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2743         pm->config = ntohl(opm->config) & OFPPC11_ALL;
2744         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2745         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2746     } else {
2747         return OFPERR_OFPBRC_BAD_VERSION;
2748     }
2749
2750     pm->config &= pm->mask;
2751     return 0;
2752 }
2753
2754 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2755  * message suitable for 'protocol', and returns that encoded form in a buffer
2756  * owned by the caller. */
2757 struct ofpbuf *
2758 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2759                         enum ofputil_protocol protocol)
2760 {
2761     uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
2762     struct ofpbuf *b;
2763
2764     if (ofp_version == OFP10_VERSION) {
2765         struct ofp10_port_mod *opm;
2766
2767         opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
2768         opm->port_no = htons(pm->port_no);
2769         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2770         opm->config = htonl(pm->config & OFPPC10_ALL);
2771         opm->mask = htonl(pm->mask & OFPPC10_ALL);
2772         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2773     } else if (ofp_version == OFP11_VERSION) {
2774         struct ofp11_port_mod *opm;
2775
2776         opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
2777         opm->port_no = htonl(pm->port_no);
2778         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2779         opm->config = htonl(pm->config & OFPPC11_ALL);
2780         opm->mask = htonl(pm->mask & OFPPC11_ALL);
2781         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2782     } else {
2783         NOT_REACHED();
2784     }
2785
2786     return b;
2787 }
2788
2789 struct ofpbuf *
2790 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
2791 {
2792     struct ofp_packet_out *opo;
2793     size_t actions_len;
2794     struct ofpbuf *msg;
2795     size_t size;
2796
2797     actions_len = po->n_actions * sizeof *po->actions;
2798     size = sizeof *opo + actions_len;
2799     if (po->buffer_id == UINT32_MAX) {
2800         size += po->packet_len;
2801     }
2802
2803     msg = ofpbuf_new(size);
2804     opo = put_openflow(sizeof *opo, OFPT10_PACKET_OUT, msg);
2805     opo->buffer_id = htonl(po->buffer_id);
2806     opo->in_port = htons(po->in_port);
2807     opo->actions_len = htons(actions_len);
2808     ofpbuf_put(msg, po->actions, actions_len);
2809     if (po->buffer_id == UINT32_MAX) {
2810         ofpbuf_put(msg, po->packet, po->packet_len);
2811     }
2812     update_openflow_length(msg);
2813
2814     return msg;
2815 }
2816
2817 /* Returns a string representing the message type of 'type'.  The string is the
2818  * enumeration constant for the type, e.g. "OFPT_HELLO".  For statistics
2819  * messages, the constant is followed by "request" or "reply",
2820  * e.g. "OFPST_AGGREGATE reply". */
2821 const char *
2822 ofputil_msg_type_name(const struct ofputil_msg_type *type)
2823 {
2824     return type->name;
2825 }
2826 \f
2827 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2828  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2829  * an arbitrary transaction id.  Allocated bytes beyond the header, if any, are
2830  * zeroed.
2831  *
2832  * The caller is responsible for freeing '*bufferp' when it is no longer
2833  * needed.
2834  *
2835  * The OpenFlow header length is initially set to 'openflow_len'; if the
2836  * message is later extended, the length should be updated with
2837  * update_openflow_length() before sending.
2838  *
2839  * Returns the header. */
2840 void *
2841 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
2842 {
2843     *bufferp = ofpbuf_new(openflow_len);
2844     return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
2845 }
2846
2847 /* Similar to make_openflow() but creates a Nicira vendor extension message
2848  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2849 void *
2850 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
2851 {
2852     return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
2853 }
2854
2855 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2856  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2857  * transaction id 'xid'.  Allocated bytes beyond the header, if any, are
2858  * zeroed.
2859  *
2860  * The caller is responsible for freeing '*bufferp' when it is no longer
2861  * needed.
2862  *
2863  * The OpenFlow header length is initially set to 'openflow_len'; if the
2864  * message is later extended, the length should be updated with
2865  * update_openflow_length() before sending.
2866  *
2867  * Returns the header. */
2868 void *
2869 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2870                   struct ofpbuf **bufferp)
2871 {
2872     *bufferp = ofpbuf_new(openflow_len);
2873     return put_openflow_xid(openflow_len, type, xid, *bufferp);
2874 }
2875
2876 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
2877  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2878 void *
2879 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2880                struct ofpbuf **bufferp)
2881 {
2882     *bufferp = ofpbuf_new(openflow_len);
2883     return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
2884 }
2885
2886 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2887  * with the given 'type' and an arbitrary transaction id.  Allocated bytes
2888  * beyond the header, if any, are zeroed.
2889  *
2890  * The OpenFlow header length is initially set to 'openflow_len'; if the
2891  * message is later extended, the length should be updated with
2892  * update_openflow_length() before sending.
2893  *
2894  * Returns the header. */
2895 void *
2896 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
2897 {
2898     return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
2899 }
2900
2901 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2902  * with the given 'type' and an transaction id 'xid'.  Allocated bytes beyond
2903  * the header, if any, are zeroed.
2904  *
2905  * The OpenFlow header length is initially set to 'openflow_len'; if the
2906  * message is later extended, the length should be updated with
2907  * update_openflow_length() before sending.
2908  *
2909  * Returns the header. */
2910 void *
2911 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2912                  struct ofpbuf *buffer)
2913 {
2914     struct ofp_header *oh;
2915
2916     assert(openflow_len >= sizeof *oh);
2917     assert(openflow_len <= UINT16_MAX);
2918
2919     oh = ofpbuf_put_uninit(buffer, openflow_len);
2920     oh->version = OFP10_VERSION;
2921     oh->type = type;
2922     oh->length = htons(openflow_len);
2923     oh->xid = xid;
2924     memset(oh + 1, 0, openflow_len - sizeof *oh);
2925     return oh;
2926 }
2927
2928 /* Similar to put_openflow() but append a Nicira vendor extension message with
2929  * the specific 'subtype'.  'subtype' should be in host byte order. */
2930 void *
2931 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
2932 {
2933     return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
2934 }
2935
2936 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
2937  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2938 void *
2939 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2940               struct ofpbuf *buffer)
2941 {
2942     struct nicira_header *nxh;
2943
2944     nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
2945     nxh->vendor = htonl(NX_VENDOR_ID);
2946     nxh->subtype = htonl(subtype);
2947     return nxh;
2948 }
2949
2950 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
2951  * 'buffer->size'. */
2952 void
2953 update_openflow_length(struct ofpbuf *buffer)
2954 {
2955     struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
2956     oh->length = htons(buffer->size);
2957 }
2958
2959 static void
2960 put_stats__(ovs_be32 xid, uint8_t ofp_type,
2961             ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
2962             struct ofpbuf *msg)
2963 {
2964     if (ofpst_type == htons(OFPST_VENDOR)) {
2965         struct nicira_stats_msg *nsm;
2966
2967         nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
2968         nsm->vsm.osm.type = ofpst_type;
2969         nsm->vsm.vendor = htonl(NX_VENDOR_ID);
2970         nsm->subtype = nxst_subtype;
2971     } else {
2972         struct ofp_stats_msg *osm;
2973
2974         osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
2975         osm->type = ofpst_type;
2976     }
2977 }
2978
2979 /* Creates a statistics request message with total length 'openflow_len'
2980  * (including all headers) and the given 'ofpst_type', and stores the buffer
2981  * containing the new message in '*bufferp'.  If 'ofpst_type' is OFPST_VENDOR
2982  * then 'nxst_subtype' is used as the Nicira vendor extension statistics
2983  * subtype (otherwise 'nxst_subtype' is ignored).
2984  *
2985  * Initializes bytes following the headers to all-bits-zero.
2986  *
2987  * Returns the first byte of the new message. */
2988 void *
2989 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
2990                            uint32_t nxst_subtype, struct ofpbuf **bufferp)
2991 {
2992     struct ofpbuf *msg;
2993
2994     msg = *bufferp = ofpbuf_new(openflow_len);
2995     put_stats__(alloc_xid(), OFPT10_STATS_REQUEST,
2996                 htons(ofpst_type), htonl(nxst_subtype), msg);
2997     ofpbuf_padto(msg, openflow_len);
2998
2999     return msg->data;
3000 }
3001
3002 static void
3003 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
3004 {
3005     assert(request->header.type == OFPT10_STATS_REQUEST ||
3006            request->header.type == OFPT10_STATS_REPLY);
3007     put_stats__(request->header.xid, OFPT10_STATS_REPLY, request->type,
3008                 (request->type != htons(OFPST_VENDOR)
3009                  ? htonl(0)
3010                  : ((const struct nicira_stats_msg *) request)->subtype),
3011                 msg);
3012 }
3013
3014 /* Creates a statistics reply message with total length 'openflow_len'
3015  * (including all headers) and the same type (either a standard OpenFlow
3016  * statistics type or a Nicira extension type and subtype) as 'request', and
3017  * stores the buffer containing the new message in '*bufferp'.
3018  *
3019  * Initializes bytes following the headers to all-bits-zero.
3020  *
3021  * Returns the first byte of the new message. */
3022 void *
3023 ofputil_make_stats_reply(size_t openflow_len,
3024                          const struct ofp_stats_msg *request,
3025                          struct ofpbuf **bufferp)
3026 {
3027     struct ofpbuf *msg;
3028
3029     msg = *bufferp = ofpbuf_new(openflow_len);
3030     put_stats_reply__(request, msg);
3031     ofpbuf_padto(msg, openflow_len);
3032
3033     return msg->data;
3034 }
3035
3036 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
3037  * replies to 'request', which should be an OpenFlow or Nicira extension
3038  * statistics request.  Initially 'replies' will have a single reply message
3039  * that has only a header.  The functions ofputil_reserve_stats_reply() and
3040  * ofputil_append_stats_reply() may be used to add to the reply. */
3041 void
3042 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
3043                           struct list *replies)
3044 {
3045     struct ofpbuf *msg;
3046
3047     msg = ofpbuf_new(1024);
3048     put_stats_reply__(request, msg);
3049
3050     list_init(replies);
3051     list_push_back(replies, &msg->list_node);
3052 }
3053
3054 /* Prepares to append up to 'len' bytes to the series of statistics replies in
3055  * 'replies', which should have been initialized with
3056  * ofputil_start_stats_reply().  Returns an ofpbuf with at least 'len' bytes of
3057  * tailroom.  (The 'len' bytes have not actually be allocated; the caller must
3058  * do so with e.g. ofpbuf_put_uninit().) */
3059 struct ofpbuf *
3060 ofputil_reserve_stats_reply(size_t len, struct list *replies)
3061 {
3062     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3063     struct ofp_stats_msg *osm = msg->data;
3064
3065     if (msg->size + len <= UINT16_MAX) {
3066         ofpbuf_prealloc_tailroom(msg, len);
3067     } else {
3068         osm->flags |= htons(OFPSF_REPLY_MORE);
3069
3070         msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
3071         put_stats_reply__(osm, msg);
3072         list_push_back(replies, &msg->list_node);
3073     }
3074     return msg;
3075 }
3076
3077 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
3078  * returns the first byte. */
3079 void *
3080 ofputil_append_stats_reply(size_t len, struct list *replies)
3081 {
3082     return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
3083 }
3084
3085 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
3086 const void *
3087 ofputil_stats_body(const struct ofp_header *oh)
3088 {
3089     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3090     return (const struct ofp_stats_msg *) oh + 1;
3091 }
3092
3093 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
3094 size_t
3095 ofputil_stats_body_len(const struct ofp_header *oh)
3096 {
3097     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3098     return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
3099 }
3100
3101 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
3102 const void *
3103 ofputil_nxstats_body(const struct ofp_header *oh)
3104 {
3105     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3106     return ((const struct nicira_stats_msg *) oh) + 1;
3107 }
3108
3109 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
3110 size_t
3111 ofputil_nxstats_body_len(const struct ofp_header *oh)
3112 {
3113     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3114     return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
3115 }
3116
3117 struct ofpbuf *
3118 make_flow_mod(uint16_t command, const struct cls_rule *rule,
3119               size_t actions_len)
3120 {
3121     struct ofp_flow_mod *ofm;
3122     size_t size = sizeof *ofm + actions_len;
3123     struct ofpbuf *out = ofpbuf_new(size);
3124     ofm = ofpbuf_put_zeros(out, sizeof *ofm);
3125     ofm->header.version = OFP10_VERSION;
3126     ofm->header.type = OFPT10_FLOW_MOD;
3127     ofm->header.length = htons(size);
3128     ofm->cookie = 0;
3129     ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
3130     ofputil_cls_rule_to_match(rule, &ofm->match);
3131     ofm->command = htons(command);
3132     return out;
3133 }
3134
3135 struct ofpbuf *
3136 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
3137               uint16_t idle_timeout, size_t actions_len)
3138 {
3139     struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
3140     struct ofp_flow_mod *ofm = out->data;
3141     ofm->idle_timeout = htons(idle_timeout);
3142     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
3143     ofm->buffer_id = htonl(buffer_id);
3144     return out;
3145 }
3146
3147 struct ofpbuf *
3148 make_del_flow(const struct cls_rule *rule)
3149 {
3150     struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
3151     struct ofp_flow_mod *ofm = out->data;
3152     ofm->out_port = htons(OFPP_NONE);
3153     return out;
3154 }
3155
3156 struct ofpbuf *
3157 make_add_simple_flow(const struct cls_rule *rule,
3158                      uint32_t buffer_id, uint16_t out_port,
3159                      uint16_t idle_timeout)
3160 {
3161     if (out_port != OFPP_NONE) {
3162         struct ofp_action_output *oao;
3163         struct ofpbuf *buffer;
3164
3165         buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
3166         ofputil_put_OFPAT10_OUTPUT(buffer)->port = htons(out_port);
3167         return buffer;
3168     } else {
3169         return make_add_flow(rule, buffer_id, idle_timeout, 0);
3170     }
3171 }
3172
3173 struct ofpbuf *
3174 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
3175                const struct ofpbuf *payload, int max_send_len)
3176 {
3177     struct ofp_packet_in *opi;
3178     struct ofpbuf *buf;
3179     int send_len;
3180
3181     send_len = MIN(max_send_len, payload->size);
3182     buf = ofpbuf_new(sizeof *opi + send_len);
3183     opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
3184                            OFPT_PACKET_IN, 0, buf);
3185     opi->buffer_id = htonl(buffer_id);
3186     opi->total_len = htons(payload->size);
3187     opi->in_port = htons(in_port);
3188     opi->reason = reason;
3189     ofpbuf_put(buf, payload->data, send_len);
3190     update_openflow_length(buf);
3191
3192     return buf;
3193 }
3194
3195 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3196 struct ofpbuf *
3197 make_echo_request(void)
3198 {
3199     struct ofp_header *rq;
3200     struct ofpbuf *out = ofpbuf_new(sizeof *rq);
3201     rq = ofpbuf_put_uninit(out, sizeof *rq);
3202     rq->version = OFP10_VERSION;
3203     rq->type = OFPT_ECHO_REQUEST;
3204     rq->length = htons(sizeof *rq);
3205     rq->xid = htonl(0);
3206     return out;
3207 }
3208
3209 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3210  * OFPT_ECHO_REQUEST message in 'rq'. */
3211 struct ofpbuf *
3212 make_echo_reply(const struct ofp_header *rq)
3213 {
3214     size_t size = ntohs(rq->length);
3215     struct ofpbuf *out = ofpbuf_new(size);
3216     struct ofp_header *reply = ofpbuf_put(out, rq, size);
3217     reply->type = OFPT_ECHO_REPLY;
3218     return out;
3219 }
3220
3221 struct ofpbuf *
3222 ofputil_encode_barrier_request(void)
3223 {
3224     struct ofpbuf *msg;
3225
3226     make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
3227     return msg;
3228 }
3229
3230 const char *
3231 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3232 {
3233     switch (flags & OFPC_FRAG_MASK) {
3234     case OFPC_FRAG_NORMAL:   return "normal";
3235     case OFPC_FRAG_DROP:     return "drop";
3236     case OFPC_FRAG_REASM:    return "reassemble";
3237     case OFPC_FRAG_NX_MATCH: return "nx-match";
3238     }
3239
3240     NOT_REACHED();
3241 }
3242
3243 bool
3244 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3245 {
3246     if (!strcasecmp(s, "normal")) {
3247         *flags = OFPC_FRAG_NORMAL;
3248     } else if (!strcasecmp(s, "drop")) {
3249         *flags = OFPC_FRAG_DROP;
3250     } else if (!strcasecmp(s, "reassemble")) {
3251         *flags = OFPC_FRAG_REASM;
3252     } else if (!strcasecmp(s, "nx-match")) {
3253         *flags = OFPC_FRAG_NX_MATCH;
3254     } else {
3255         return false;
3256     }
3257     return true;
3258 }
3259
3260 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3261  * port number and stores the latter in '*ofp10_port', for the purpose of
3262  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
3263  * otherwise an OFPERR_* number.
3264  *
3265  * See the definition of OFP11_MAX for an explanation of the mapping. */
3266 enum ofperr
3267 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3268 {
3269     uint32_t ofp11_port_h = ntohl(ofp11_port);
3270
3271     if (ofp11_port_h < OFPP_MAX) {
3272         *ofp10_port = ofp11_port_h;
3273         return 0;
3274     } else if (ofp11_port_h >= OFPP11_MAX) {
3275         *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3276         return 0;
3277     } else {
3278         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3279                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3280                      ofp11_port_h, OFPP_MAX - 1,
3281                      (uint32_t) OFPP11_MAX, UINT32_MAX);
3282         return OFPERR_OFPBAC_BAD_OUT_PORT;
3283     }
3284 }
3285
3286 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3287  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3288  *
3289  * See the definition of OFP11_MAX for an explanation of the mapping. */
3290 ovs_be32
3291 ofputil_port_to_ofp11(uint16_t ofp10_port)
3292 {
3293     return htonl(ofp10_port < OFPP_MAX
3294                  ? ofp10_port
3295                  : ofp10_port + OFPP11_OFFSET);
3296 }
3297
3298 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3299  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
3300  * 'port' is valid, otherwise an OpenFlow return code. */
3301 enum ofperr
3302 ofputil_check_output_port(uint16_t port, int max_ports)
3303 {
3304     switch (port) {
3305     case OFPP_IN_PORT:
3306     case OFPP_TABLE:
3307     case OFPP_NORMAL:
3308     case OFPP_FLOOD:
3309     case OFPP_ALL:
3310     case OFPP_CONTROLLER:
3311     case OFPP_NONE:
3312     case OFPP_LOCAL:
3313         return 0;
3314
3315     default:
3316         if (port < max_ports) {
3317             return 0;
3318         }
3319         return OFPERR_OFPBAC_BAD_OUT_PORT;
3320     }
3321 }
3322
3323 #define OFPUTIL_NAMED_PORTS                     \
3324         OFPUTIL_NAMED_PORT(IN_PORT)             \
3325         OFPUTIL_NAMED_PORT(TABLE)               \
3326         OFPUTIL_NAMED_PORT(NORMAL)              \
3327         OFPUTIL_NAMED_PORT(FLOOD)               \
3328         OFPUTIL_NAMED_PORT(ALL)                 \
3329         OFPUTIL_NAMED_PORT(CONTROLLER)          \
3330         OFPUTIL_NAMED_PORT(LOCAL)               \
3331         OFPUTIL_NAMED_PORT(NONE)
3332
3333 /* Checks whether 's' is the string representation of an OpenFlow port number,
3334  * either as an integer or a string name (e.g. "LOCAL").  If it is, stores the
3335  * number in '*port' and returns true.  Otherwise, returns false. */
3336 bool
3337 ofputil_port_from_string(const char *name, uint16_t *port)
3338 {
3339     struct pair {
3340         const char *name;
3341         uint16_t value;
3342     };
3343     static const struct pair pairs[] = {
3344 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3345         OFPUTIL_NAMED_PORTS
3346 #undef OFPUTIL_NAMED_PORT
3347     };
3348     static const int n_pairs = ARRAY_SIZE(pairs);
3349     int i;
3350
3351     if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3352         *port = i;
3353         return true;
3354     }
3355
3356     for (i = 0; i < n_pairs; i++) {
3357         if (!strcasecmp(name, pairs[i].name)) {
3358             *port = pairs[i].value;
3359             return true;
3360         }
3361     }
3362     return false;
3363 }
3364
3365 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3366  * Most ports' string representation is just the port number, but for special
3367  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3368 void
3369 ofputil_format_port(uint16_t port, struct ds *s)
3370 {
3371     const char *name;
3372
3373     switch (port) {
3374 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3375         OFPUTIL_NAMED_PORTS
3376 #undef OFPUTIL_NAMED_PORT
3377
3378     default:
3379         ds_put_format(s, "%"PRIu16, port);
3380         return;
3381     }
3382     ds_put_cstr(s, name);
3383 }
3384
3385 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3386  * 'ofp_version', tries to pull the first element from the array.  If
3387  * successful, initializes '*pp' with an abstract representation of the
3388  * port and returns 0.  If no ports remain to be decoded, returns EOF.
3389  * On an error, returns a positive OFPERR_* value. */
3390 int
3391 ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
3392                       struct ofputil_phy_port *pp)
3393 {
3394     if (ofp_version == OFP10_VERSION) {
3395         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3396         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3397     } else {
3398         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3399         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3400     }
3401 }
3402
3403 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3404  * 'ofp_version', returns the number of elements. */
3405 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3406 {
3407     return b->size / ofputil_get_phy_port_size(ofp_version);
3408 }
3409
3410 static enum ofperr
3411 check_resubmit_table(const struct nx_action_resubmit *nar)
3412 {
3413     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
3414         return OFPERR_OFPBAC_BAD_ARGUMENT;
3415     }
3416     return 0;
3417 }
3418
3419 static enum ofperr
3420 check_output_reg(const struct nx_action_output_reg *naor,
3421                  const struct flow *flow)
3422 {
3423     struct mf_subfield src;
3424     size_t i;
3425
3426     for (i = 0; i < sizeof naor->zero; i++) {
3427         if (naor->zero[i]) {
3428             return OFPERR_OFPBAC_BAD_ARGUMENT;
3429         }
3430     }
3431
3432     nxm_decode(&src, naor->src, naor->ofs_nbits);
3433     return mf_check_src(&src, flow);
3434 }
3435
3436 enum ofperr
3437 validate_actions(const union ofp_action *actions, size_t n_actions,
3438                  const struct flow *flow, int max_ports)
3439 {
3440     const union ofp_action *a;
3441     size_t left;
3442
3443     OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
3444         enum ofperr error;
3445         uint16_t port;
3446         int code;
3447
3448         code = ofputil_decode_action(a);
3449         if (code < 0) {
3450             error = -code;
3451             VLOG_WARN_RL(&bad_ofmsg_rl,
3452                          "action decoding error at offset %td (%s)",
3453                          (a - actions) * sizeof *a, ofperr_get_name(error));
3454
3455             return error;
3456         }
3457
3458         error = 0;
3459         switch ((enum ofputil_action_code) code) {
3460         case OFPUTIL_OFPAT10_OUTPUT:
3461             error = ofputil_check_output_port(ntohs(a->output.port),
3462                                               max_ports);
3463             break;
3464
3465         case OFPUTIL_OFPAT10_SET_VLAN_VID:
3466             if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
3467                 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3468             }
3469             break;
3470
3471         case OFPUTIL_OFPAT10_SET_VLAN_PCP:
3472             if (a->vlan_pcp.vlan_pcp & ~7) {
3473                 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3474             }
3475             break;
3476
3477         case OFPUTIL_OFPAT10_ENQUEUE:
3478             port = ntohs(((const struct ofp_action_enqueue *) a)->port);
3479             if (port >= max_ports && port != OFPP_IN_PORT
3480                 && port != OFPP_LOCAL) {
3481                 error = OFPERR_OFPBAC_BAD_OUT_PORT;
3482             }
3483             break;
3484
3485         case OFPUTIL_NXAST_REG_MOVE:
3486             error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
3487                                        flow);
3488             break;
3489
3490         case OFPUTIL_NXAST_REG_LOAD:
3491             error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
3492                                        flow);
3493             break;
3494
3495         case OFPUTIL_NXAST_MULTIPATH:
3496             error = multipath_check((const struct nx_action_multipath *) a,
3497                                     flow);
3498             break;
3499
3500         case OFPUTIL_NXAST_AUTOPATH:
3501             error = autopath_check((const struct nx_action_autopath *) a,
3502                                    flow);
3503             break;
3504
3505         case OFPUTIL_NXAST_BUNDLE:
3506         case OFPUTIL_NXAST_BUNDLE_LOAD:
3507             error = bundle_check((const struct nx_action_bundle *) a,
3508                                  max_ports, flow);
3509             break;
3510
3511         case OFPUTIL_NXAST_OUTPUT_REG:
3512             error = check_output_reg((const struct nx_action_output_reg *) a,
3513                                      flow);
3514             break;
3515
3516         case OFPUTIL_NXAST_RESUBMIT_TABLE:
3517             error = check_resubmit_table(
3518                 (const struct nx_action_resubmit *) a);
3519             break;
3520
3521         case OFPUTIL_NXAST_LEARN:
3522             error = learn_check((const struct nx_action_learn *) a, flow);
3523             break;
3524
3525         case OFPUTIL_NXAST_CONTROLLER:
3526             if (((const struct nx_action_controller *) a)->zero) {
3527                 error = OFPERR_NXBAC_MUST_BE_ZERO;
3528             }
3529             break;
3530
3531         case OFPUTIL_OFPAT10_STRIP_VLAN:
3532         case OFPUTIL_OFPAT10_SET_NW_SRC:
3533         case OFPUTIL_OFPAT10_SET_NW_DST:
3534         case OFPUTIL_OFPAT10_SET_NW_TOS:
3535         case OFPUTIL_OFPAT10_SET_TP_SRC:
3536         case OFPUTIL_OFPAT10_SET_TP_DST:
3537         case OFPUTIL_OFPAT10_SET_DL_SRC:
3538         case OFPUTIL_OFPAT10_SET_DL_DST:
3539         case OFPUTIL_NXAST_RESUBMIT:
3540         case OFPUTIL_NXAST_SET_TUNNEL:
3541         case OFPUTIL_NXAST_SET_QUEUE:
3542         case OFPUTIL_NXAST_POP_QUEUE:
3543         case OFPUTIL_NXAST_NOTE:
3544         case OFPUTIL_NXAST_SET_TUNNEL64:
3545         case OFPUTIL_NXAST_EXIT:
3546         case OFPUTIL_NXAST_DEC_TTL:
3547         case OFPUTIL_NXAST_FIN_TIMEOUT:
3548             break;
3549         }
3550
3551         if (error) {
3552             VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
3553                          (a - actions) * sizeof *a, ofperr_get_name(error));
3554             return error;
3555         }
3556     }
3557     if (left) {
3558         VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
3559                      (n_actions - left) * sizeof *a);
3560         return OFPERR_OFPBAC_BAD_LEN;
3561     }
3562     return 0;
3563 }
3564
3565 struct ofputil_action {
3566     int code;
3567     unsigned int min_len;
3568     unsigned int max_len;
3569 };
3570
3571 static const struct ofputil_action action_bad_type
3572     = { -OFPERR_OFPBAC_BAD_TYPE,   0, UINT_MAX };
3573 static const struct ofputil_action action_bad_len
3574     = { -OFPERR_OFPBAC_BAD_LEN,    0, UINT_MAX };
3575 static const struct ofputil_action action_bad_vendor
3576     = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX };
3577
3578 static const struct ofputil_action *
3579 ofputil_decode_ofpat_action(const union ofp_action *a)
3580 {
3581     enum ofp10_action_type type = ntohs(a->type);
3582
3583     switch (type) {
3584 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                    \
3585         case ENUM: {                                        \
3586             static const struct ofputil_action action = {   \
3587                 OFPUTIL_##ENUM,                             \
3588                 sizeof(struct STRUCT),                      \
3589                 sizeof(struct STRUCT)                       \
3590             };                                              \
3591             return &action;                                 \
3592         }
3593 #include "ofp-util.def"
3594
3595     case OFPAT10_VENDOR:
3596     default:
3597         return &action_bad_type;
3598     }
3599 }
3600
3601 static const struct ofputil_action *
3602 ofputil_decode_nxast_action(const union ofp_action *a)
3603 {
3604     const struct nx_action_header *nah = (const struct nx_action_header *) a;
3605     enum nx_action_subtype subtype = ntohs(nah->subtype);
3606
3607     switch (subtype) {
3608 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3609         case ENUM: {                                            \
3610             static const struct ofputil_action action = {       \
3611                 OFPUTIL_##ENUM,                                 \
3612                 sizeof(struct STRUCT),                          \
3613                 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT)   \
3614             };                                                  \
3615             return &action;                                     \
3616         }
3617 #include "ofp-util.def"
3618
3619     case NXAST_SNAT__OBSOLETE:
3620     case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
3621     default:
3622         return &action_bad_type;
3623     }
3624 }
3625
3626 /* Parses 'a' to determine its type.  Returns a nonnegative OFPUTIL_OFPAT10_* or
3627  * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error
3628  * code.
3629  *
3630  * The caller must have already verified that 'a''s length is correct (that is,
3631  * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
3632  * longer than the amount of space allocated to 'a').
3633  *
3634  * This function verifies that 'a''s length is correct for the type of action
3635  * that it represents. */
3636 int
3637 ofputil_decode_action(const union ofp_action *a)
3638 {
3639     const struct ofputil_action *action;
3640     uint16_t len = ntohs(a->header.len);
3641
3642     if (a->type != htons(OFPAT10_VENDOR)) {
3643         action = ofputil_decode_ofpat_action(a);
3644     } else {
3645         switch (ntohl(a->vendor.vendor)) {
3646         case NX_VENDOR_ID:
3647             if (len < sizeof(struct nx_action_header)) {
3648                 return -OFPERR_OFPBAC_BAD_LEN;
3649             }
3650             action = ofputil_decode_nxast_action(a);
3651             break;
3652         default:
3653             action = &action_bad_vendor;
3654             break;
3655         }
3656     }
3657
3658     return (len >= action->min_len && len <= action->max_len
3659             ? action->code
3660             : -OFPERR_OFPBAC_BAD_LEN);
3661 }
3662
3663 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT10_* or OFPUTIL_NXAST_*
3664  * constant.  The caller must have already validated that 'a' is a valid action
3665  * understood by Open vSwitch (e.g. by a previous successful call to
3666  * ofputil_decode_action()). */
3667 enum ofputil_action_code
3668 ofputil_decode_action_unsafe(const union ofp_action *a)
3669 {
3670     const struct ofputil_action *action;
3671
3672     if (a->type != htons(OFPAT10_VENDOR)) {
3673         action = ofputil_decode_ofpat_action(a);
3674     } else {
3675         action = ofputil_decode_nxast_action(a);
3676     }
3677
3678     return action->code;
3679 }
3680
3681 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3682  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3683  * 'name' is not the name of any action.
3684  *
3685  * ofp-util.def lists the mapping from names to action. */
3686 int
3687 ofputil_action_code_from_name(const char *name)
3688 {
3689     static const char *names[OFPUTIL_N_ACTIONS] = {
3690 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
3691 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3692 #include "ofp-util.def"
3693     };
3694
3695     const char **p;
3696
3697     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3698         if (*p && !strcasecmp(name, *p)) {
3699             return p - names;
3700         }
3701     }
3702     return -1;
3703 }
3704
3705 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3706  * action.  Initializes the parts of 'action' that identify it as having type
3707  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
3708  * have variable length, the length used and cleared is that of struct
3709  * <STRUCT>.  */
3710 void *
3711 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3712 {
3713     switch (code) {
3714 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                    \
3715     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3716 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
3717     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3718 #include "ofp-util.def"
3719     }
3720     NOT_REACHED();
3721 }
3722
3723 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
3724     void                                                        \
3725     ofputil_init_##ENUM(struct STRUCT *s)                       \
3726     {                                                           \
3727         memset(s, 0, sizeof *s);                                \
3728         s->type = htons(ENUM);                                  \
3729         s->len = htons(sizeof *s);                              \
3730     }                                                           \
3731                                                                 \
3732     struct STRUCT *                                             \
3733     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3734     {                                                           \
3735         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3736         ofputil_init_##ENUM(s);                                 \
3737         return s;                                               \
3738     }
3739 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3740     void                                                        \
3741     ofputil_init_##ENUM(struct STRUCT *s)                       \
3742     {                                                           \
3743         memset(s, 0, sizeof *s);                                \
3744         s->type = htons(OFPAT10_VENDOR);                        \
3745         s->len = htons(sizeof *s);                              \
3746         s->vendor = htonl(NX_VENDOR_ID);                        \
3747         s->subtype = htons(ENUM);                               \
3748     }                                                           \
3749                                                                 \
3750     struct STRUCT *                                             \
3751     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3752     {                                                           \
3753         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3754         ofputil_init_##ENUM(s);                                 \
3755         return s;                                               \
3756     }
3757 #include "ofp-util.def"
3758
3759 /* Returns true if 'action' outputs to 'port', false otherwise. */
3760 bool
3761 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
3762 {
3763     switch (ofputil_decode_action(action)) {
3764     case OFPUTIL_OFPAT10_OUTPUT:
3765         return action->output.port == port;
3766     case OFPUTIL_OFPAT10_ENQUEUE:
3767         return ((const struct ofp_action_enqueue *) action)->port == port;
3768     case OFPUTIL_NXAST_CONTROLLER:
3769         return port == htons(OFPP_CONTROLLER);
3770     default:
3771         return false;
3772     }
3773 }
3774
3775 /* "Normalizes" the wildcards in 'rule'.  That means:
3776  *
3777  *    1. If the type of level N is known, then only the valid fields for that
3778  *       level may be specified.  For example, ARP does not have a TOS field,
3779  *       so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3780  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3781  *       ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3782  *       IPv4 flow.
3783  *
3784  *    2. If the type of level N is not known (or not understood by Open
3785  *       vSwitch), then no fields at all for that level may be specified.  For
3786  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3787  *       L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3788  *       SCTP flow.
3789  */
3790 void
3791 ofputil_normalize_rule(struct cls_rule *rule)
3792 {
3793     enum {
3794         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
3795         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
3796         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
3797         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
3798         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
3799         MAY_ARP_THA     = 1 << 5, /* arp_tha */
3800         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3801         MAY_ND_TARGET   = 1 << 7  /* nd_target */
3802     } may_match;
3803
3804     struct flow_wildcards wc;
3805
3806     /* Figure out what fields may be matched. */
3807     if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3808         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3809         if (rule->flow.nw_proto == IPPROTO_TCP ||
3810             rule->flow.nw_proto == IPPROTO_UDP ||
3811             rule->flow.nw_proto == IPPROTO_ICMP) {
3812             may_match |= MAY_TP_ADDR;
3813         }
3814     } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3815         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3816         if (rule->flow.nw_proto == IPPROTO_TCP ||
3817             rule->flow.nw_proto == IPPROTO_UDP) {
3818             may_match |= MAY_TP_ADDR;
3819         } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3820             may_match |= MAY_TP_ADDR;
3821             if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3822                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3823             } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3824                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3825             }
3826         }
3827     } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3828         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3829     } else {
3830         may_match = 0;
3831     }
3832
3833     /* Clear the fields that may not be matched. */
3834     wc = rule->wc;
3835     if (!(may_match & MAY_NW_ADDR)) {
3836         wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3837     }
3838     if (!(may_match & MAY_TP_ADDR)) {
3839         wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3840     }
3841     if (!(may_match & MAY_NW_PROTO)) {
3842         wc.wildcards |= FWW_NW_PROTO;
3843     }
3844     if (!(may_match & MAY_IPVx)) {
3845         wc.wildcards |= FWW_NW_DSCP;
3846         wc.wildcards |= FWW_NW_ECN;
3847         wc.wildcards |= FWW_NW_TTL;
3848     }
3849     if (!(may_match & MAY_ARP_SHA)) {
3850         wc.wildcards |= FWW_ARP_SHA;
3851     }
3852     if (!(may_match & MAY_ARP_THA)) {
3853         wc.wildcards |= FWW_ARP_THA;
3854     }
3855     if (!(may_match & MAY_IPV6)) {
3856         wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3857         wc.wildcards |= FWW_IPV6_LABEL;
3858     }
3859     if (!(may_match & MAY_ND_TARGET)) {
3860         wc.nd_target_mask = in6addr_any;
3861     }
3862
3863     /* Log any changes. */
3864     if (!flow_wildcards_equal(&wc, &rule->wc)) {
3865         bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
3866         char *pre = log ? cls_rule_to_string(rule) : NULL;
3867
3868         rule->wc = wc;
3869         cls_rule_zero_wildcarded_fields(rule);
3870
3871         if (log) {
3872             char *post = cls_rule_to_string(rule);
3873             VLOG_INFO("normalization changed ofp_match, details:");
3874             VLOG_INFO(" pre: %s", pre);
3875             VLOG_INFO("post: %s", post);
3876             free(pre);
3877             free(post);
3878         }
3879     }
3880 }
3881
3882 /* Attempts to pull 'actions_len' bytes from the front of 'b'.  Returns 0 if
3883  * successful, otherwise an OpenFlow error.
3884  *
3885  * If successful, the first action is stored in '*actionsp' and the number of
3886  * "union ofp_action" size elements into '*n_actionsp'.  Otherwise NULL and 0
3887  * are stored, respectively.
3888  *
3889  * This function does not check that the actions are valid (the caller should
3890  * do so, with validate_actions()).  The caller is also responsible for making
3891  * sure that 'b->data' is initially aligned appropriately for "union
3892  * ofp_action". */
3893 enum ofperr
3894 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
3895                      union ofp_action **actionsp, size_t *n_actionsp)
3896 {
3897     if (actions_len % OFP_ACTION_ALIGN != 0) {
3898         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3899                      "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
3900         goto error;
3901     }
3902
3903     *actionsp = ofpbuf_try_pull(b, actions_len);
3904     if (*actionsp == NULL) {
3905         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3906                      "exceeds remaining message length (%zu)",
3907                      actions_len, b->size);
3908         goto error;
3909     }
3910
3911     *n_actionsp = actions_len / OFP_ACTION_ALIGN;
3912     return 0;
3913
3914 error:
3915     *actionsp = NULL;
3916     *n_actionsp = 0;
3917     return OFPERR_OFPBRC_BAD_LEN;
3918 }
3919
3920 bool
3921 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
3922                       const union ofp_action *b, size_t n_b)
3923 {
3924     return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
3925 }
3926
3927 union ofp_action *
3928 ofputil_actions_clone(const union ofp_action *actions, size_t n)
3929 {
3930     return n ? xmemdup(actions, n * sizeof *actions) : NULL;
3931 }
3932
3933 /* Parses a key or a key-value pair from '*stringp'.
3934  *
3935  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
3936  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
3937  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
3938  * are substrings of '*stringp' created by replacing some of its bytes by null
3939  * terminators.  Returns true.
3940  *
3941  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3942  * NULL and returns false. */
3943 bool
3944 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3945 {
3946     char *pos, *key, *value;
3947     size_t key_len;
3948
3949     pos = *stringp;
3950     pos += strspn(pos, ", \t\r\n");
3951     if (*pos == '\0') {
3952         *keyp = *valuep = NULL;
3953         return false;
3954     }
3955
3956     key = pos;
3957     key_len = strcspn(pos, ":=(, \t\r\n");
3958     if (key[key_len] == ':' || key[key_len] == '=') {
3959         /* The value can be separated by a colon. */
3960         size_t value_len;
3961
3962         value = key + key_len + 1;
3963         value_len = strcspn(value, ", \t\r\n");
3964         pos = value + value_len + (value[value_len] != '\0');
3965         value[value_len] = '\0';
3966     } else if (key[key_len] == '(') {
3967         /* The value can be surrounded by balanced parentheses.  The outermost
3968          * set of parentheses is removed. */
3969         int level = 1;
3970         size_t value_len;
3971
3972         value = key + key_len + 1;
3973         for (value_len = 0; level > 0; value_len++) {
3974             switch (value[value_len]) {
3975             case '\0':
3976                 level = 0;
3977                 break;
3978
3979             case '(':
3980                 level++;
3981                 break;
3982
3983             case ')':
3984                 level--;
3985                 break;
3986             }
3987         }
3988         value[value_len - 1] = '\0';
3989         pos = value + value_len;
3990     } else {
3991         /* There might be no value at all. */
3992         value = key + key_len;  /* Will become the empty string below. */
3993         pos = key + key_len + (key[key_len] != '\0');
3994     }
3995     key[key_len] = '\0';
3996
3997     *stringp = pos;
3998     *keyp = key;
3999     *valuep = value;
4000     return true;
4001 }