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