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  *
1466  * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
1467  * enabled, false otherwise. */
1468 struct ofpbuf *
1469 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1470                         enum ofputil_protocol protocol)
1471 {
1472     size_t actions_len = fm->n_actions * sizeof *fm->actions;
1473     struct ofp_flow_mod *ofm;
1474     struct nx_flow_mod *nfm;
1475     struct ofpbuf *msg;
1476     uint16_t command;
1477     int match_len;
1478
1479     command = (protocol & OFPUTIL_P_TID
1480                ? (fm->command & 0xff) | (fm->table_id << 8)
1481                : fm->command);
1482
1483     switch (protocol) {
1484     case OFPUTIL_P_OF10:
1485     case OFPUTIL_P_OF10_TID:
1486         msg = ofpbuf_new(sizeof *ofm + actions_len);
1487         ofm = put_openflow(sizeof *ofm, OFPT10_FLOW_MOD, msg);
1488         ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
1489         ofm->cookie = fm->cookie;
1490         ofm->command = htons(command);
1491         ofm->idle_timeout = htons(fm->idle_timeout);
1492         ofm->hard_timeout = htons(fm->hard_timeout);
1493         ofm->priority = htons(fm->cr.priority);
1494         ofm->buffer_id = htonl(fm->buffer_id);
1495         ofm->out_port = htons(fm->out_port);
1496         ofm->flags = htons(fm->flags);
1497         break;
1498
1499     case OFPUTIL_P_NXM:
1500     case OFPUTIL_P_NXM_TID:
1501         msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1502         put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1503         nfm = msg->data;
1504         nfm->command = htons(command);
1505         if (command == OFPFC_ADD) {
1506             nfm->cookie = fm->cookie;
1507             match_len = nx_put_match(msg, &fm->cr, 0, 0);
1508         } else {
1509             nfm->cookie = 0;
1510             match_len = nx_put_match(msg, &fm->cr,
1511                                      fm->cookie, fm->cookie_mask);
1512         }
1513         nfm->idle_timeout = htons(fm->idle_timeout);
1514         nfm->hard_timeout = htons(fm->hard_timeout);
1515         nfm->priority = htons(fm->cr.priority);
1516         nfm->buffer_id = htonl(fm->buffer_id);
1517         nfm->out_port = htons(fm->out_port);
1518         nfm->flags = htons(fm->flags);
1519         nfm->match_len = htons(match_len);
1520         break;
1521
1522     default:
1523         NOT_REACHED();
1524     }
1525
1526     ofpbuf_put(msg, fm->actions, actions_len);
1527     update_openflow_length(msg);
1528     return msg;
1529 }
1530
1531 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1532  * send all of the 'n_fm's flow table modification requests in 'fms', and a
1533  * 0-bit for each protocol that is inadequate.
1534  *
1535  * (The return value will have at least one 1-bit.) */
1536 enum ofputil_protocol
1537 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1538                                   size_t n_fms)
1539 {
1540     enum ofputil_protocol usable_protocols;
1541     size_t i;
1542
1543     usable_protocols = OFPUTIL_P_ANY;
1544     for (i = 0; i < n_fms; i++) {
1545         const struct ofputil_flow_mod *fm = &fms[i];
1546
1547         usable_protocols &= ofputil_usable_protocols(&fm->cr);
1548         if (fm->table_id != 0xff) {
1549             usable_protocols &= OFPUTIL_P_TID;
1550         }
1551         if (fm->command != OFPFC_ADD && fm->cookie_mask != htonll(0)) {
1552             usable_protocols &= OFPUTIL_P_NXM_ANY;
1553         }
1554     }
1555     assert(usable_protocols);
1556
1557     return usable_protocols;
1558 }
1559
1560 static enum ofperr
1561 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1562                                   const struct ofp_header *oh,
1563                                   bool aggregate)
1564 {
1565     const struct ofp_flow_stats_request *ofsr =
1566         (const struct ofp_flow_stats_request *) oh;
1567
1568     fsr->aggregate = aggregate;
1569     ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1570     fsr->out_port = ntohs(ofsr->out_port);
1571     fsr->table_id = ofsr->table_id;
1572     fsr->cookie = fsr->cookie_mask = htonll(0);
1573
1574     return 0;
1575 }
1576
1577 static enum ofperr
1578 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1579                                  const struct ofp_header *oh,
1580                                  bool aggregate)
1581 {
1582     const struct nx_flow_stats_request *nfsr;
1583     struct ofpbuf b;
1584     enum ofperr error;
1585
1586     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1587
1588     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1589     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1590                           &fsr->cookie, &fsr->cookie_mask);
1591     if (error) {
1592         return error;
1593     }
1594     if (b.size) {
1595         return OFPERR_OFPBRC_BAD_LEN;
1596     }
1597
1598     fsr->aggregate = aggregate;
1599     fsr->out_port = ntohs(nfsr->out_port);
1600     fsr->table_id = nfsr->table_id;
1601
1602     return 0;
1603 }
1604
1605 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1606  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
1607  * successful, otherwise an OpenFlow error code. */
1608 enum ofperr
1609 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1610                                   const struct ofp_header *oh)
1611 {
1612     const struct ofputil_msg_type *type;
1613     struct ofpbuf b;
1614     int code;
1615
1616     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1617
1618     ofputil_decode_msg_type(oh, &type);
1619     code = ofputil_msg_type_code(type);
1620     switch (code) {
1621     case OFPUTIL_OFPST_FLOW_REQUEST:
1622         return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1623
1624     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1625         return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1626
1627     case OFPUTIL_NXST_FLOW_REQUEST:
1628         return ofputil_decode_nxst_flow_request(fsr, oh, false);
1629
1630     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1631         return ofputil_decode_nxst_flow_request(fsr, oh, true);
1632
1633     default:
1634         /* Hey, the caller lied. */
1635         NOT_REACHED();
1636     }
1637 }
1638
1639 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1640  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1641  * 'protocol', and returns the message. */
1642 struct ofpbuf *
1643 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1644                                   enum ofputil_protocol protocol)
1645 {
1646     struct ofpbuf *msg;
1647
1648     switch (protocol) {
1649     case OFPUTIL_P_OF10:
1650     case OFPUTIL_P_OF10_TID: {
1651         struct ofp_flow_stats_request *ofsr;
1652         int type;
1653
1654         type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1655         ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1656         ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1657         ofsr->table_id = fsr->table_id;
1658         ofsr->out_port = htons(fsr->out_port);
1659         break;
1660     }
1661
1662     case OFPUTIL_P_NXM:
1663     case OFPUTIL_P_NXM_TID: {
1664         struct nx_flow_stats_request *nfsr;
1665         int match_len;
1666         int subtype;
1667
1668         subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1669         ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1670         match_len = nx_put_match(msg, &fsr->match,
1671                                  fsr->cookie, fsr->cookie_mask);
1672
1673         nfsr = msg->data;
1674         nfsr->out_port = htons(fsr->out_port);
1675         nfsr->match_len = htons(match_len);
1676         nfsr->table_id = fsr->table_id;
1677         break;
1678     }
1679
1680     default:
1681         NOT_REACHED();
1682     }
1683
1684     return msg;
1685 }
1686
1687 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1688  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1689  *
1690  * (The return value will have at least one 1-bit.) */
1691 enum ofputil_protocol
1692 ofputil_flow_stats_request_usable_protocols(
1693     const struct ofputil_flow_stats_request *fsr)
1694 {
1695     enum ofputil_protocol usable_protocols;
1696
1697     usable_protocols = ofputil_usable_protocols(&fsr->match);
1698     if (fsr->cookie_mask != htonll(0)) {
1699         usable_protocols &= OFPUTIL_P_NXM_ANY;
1700     }
1701     return usable_protocols;
1702 }
1703
1704 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1705  * ofputil_flow_stats in 'fs'.
1706  *
1707  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1708  * OpenFlow message.  Calling this function multiple times for a single 'msg'
1709  * iterates through the replies.  The caller must initially leave 'msg''s layer
1710  * pointers null and not modify them between calls.
1711  *
1712  * Most switches don't send the values needed to populate fs->idle_age and
1713  * fs->hard_age, so those members will usually be set to 0.  If the switch from
1714  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1715  * 'flow_age_extension' as true so that the contents of 'msg' determine the
1716  * 'idle_age' and 'hard_age' members in 'fs'.
1717  *
1718  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1719  * otherwise a positive errno value. */
1720 int
1721 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1722                                 struct ofpbuf *msg,
1723                                 bool flow_age_extension)
1724 {
1725     const struct ofputil_msg_type *type;
1726     int code;
1727
1728     ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1729     code = ofputil_msg_type_code(type);
1730     if (!msg->l2) {
1731         msg->l2 = msg->data;
1732         if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1733             ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1734         } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1735             ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1736         } else {
1737             NOT_REACHED();
1738         }
1739     }
1740
1741     if (!msg->size) {
1742         return EOF;
1743     } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1744         const struct ofp_flow_stats *ofs;
1745         size_t length;
1746
1747         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1748         if (!ofs) {
1749             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1750                          "bytes at end", msg->size);
1751             return EINVAL;
1752         }
1753
1754         length = ntohs(ofs->length);
1755         if (length < sizeof *ofs) {
1756             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1757                          "length %zu", length);
1758             return EINVAL;
1759         }
1760
1761         if (ofputil_pull_actions(msg, length - sizeof *ofs,
1762                                  &fs->actions, &fs->n_actions)) {
1763             return EINVAL;
1764         }
1765
1766         fs->cookie = get_32aligned_be64(&ofs->cookie);
1767         ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1768                                     &fs->rule);
1769         fs->table_id = ofs->table_id;
1770         fs->duration_sec = ntohl(ofs->duration_sec);
1771         fs->duration_nsec = ntohl(ofs->duration_nsec);
1772         fs->idle_timeout = ntohs(ofs->idle_timeout);
1773         fs->hard_timeout = ntohs(ofs->hard_timeout);
1774         fs->idle_age = -1;
1775         fs->hard_age = -1;
1776         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1777         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1778     } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1779         const struct nx_flow_stats *nfs;
1780         size_t match_len, length;
1781
1782         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1783         if (!nfs) {
1784             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1785                          "bytes at end", msg->size);
1786             return EINVAL;
1787         }
1788
1789         length = ntohs(nfs->length);
1790         match_len = ntohs(nfs->match_len);
1791         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1792             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1793                          "claims invalid length %zu", match_len, length);
1794             return EINVAL;
1795         }
1796         if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1797                           NULL, NULL)) {
1798             return EINVAL;
1799         }
1800
1801         if (ofputil_pull_actions(msg,
1802                                  length - sizeof *nfs - ROUND_UP(match_len, 8),
1803                                  &fs->actions, &fs->n_actions)) {
1804             return EINVAL;
1805         }
1806
1807         fs->cookie = nfs->cookie;
1808         fs->table_id = nfs->table_id;
1809         fs->duration_sec = ntohl(nfs->duration_sec);
1810         fs->duration_nsec = ntohl(nfs->duration_nsec);
1811         fs->idle_timeout = ntohs(nfs->idle_timeout);
1812         fs->hard_timeout = ntohs(nfs->hard_timeout);
1813         fs->idle_age = -1;
1814         fs->hard_age = -1;
1815         if (flow_age_extension) {
1816             if (nfs->idle_age) {
1817                 fs->idle_age = ntohs(nfs->idle_age) - 1;
1818             }
1819             if (nfs->hard_age) {
1820                 fs->hard_age = ntohs(nfs->hard_age) - 1;
1821             }
1822         }
1823         fs->packet_count = ntohll(nfs->packet_count);
1824         fs->byte_count = ntohll(nfs->byte_count);
1825     } else {
1826         NOT_REACHED();
1827     }
1828
1829     return 0;
1830 }
1831
1832 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1833  *
1834  * We use this in situations where OVS internally uses UINT64_MAX to mean
1835  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1836 static uint64_t
1837 unknown_to_zero(uint64_t count)
1838 {
1839     return count != UINT64_MAX ? count : 0;
1840 }
1841
1842 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1843  * those already present in the list of ofpbufs in 'replies'.  'replies' should
1844  * have been initialized with ofputil_start_stats_reply(). */
1845 void
1846 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1847                                 struct list *replies)
1848 {
1849     size_t act_len = fs->n_actions * sizeof *fs->actions;
1850     const struct ofp_stats_msg *osm;
1851
1852     osm = ofpbuf_from_list(list_back(replies))->data;
1853     if (osm->type == htons(OFPST_FLOW)) {
1854         size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1855         struct ofp_flow_stats *ofs;
1856
1857         ofs = ofputil_append_stats_reply(len, replies);
1858         ofs->length = htons(len);
1859         ofs->table_id = fs->table_id;
1860         ofs->pad = 0;
1861         ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1862         ofs->duration_sec = htonl(fs->duration_sec);
1863         ofs->duration_nsec = htonl(fs->duration_nsec);
1864         ofs->priority = htons(fs->rule.priority);
1865         ofs->idle_timeout = htons(fs->idle_timeout);
1866         ofs->hard_timeout = htons(fs->hard_timeout);
1867         memset(ofs->pad2, 0, sizeof ofs->pad2);
1868         put_32aligned_be64(&ofs->cookie, fs->cookie);
1869         put_32aligned_be64(&ofs->packet_count,
1870                            htonll(unknown_to_zero(fs->packet_count)));
1871         put_32aligned_be64(&ofs->byte_count,
1872                            htonll(unknown_to_zero(fs->byte_count)));
1873         memcpy(ofs->actions, fs->actions, act_len);
1874     } else if (osm->type == htons(OFPST_VENDOR)) {
1875         struct nx_flow_stats *nfs;
1876         struct ofpbuf *msg;
1877         size_t start_len;
1878
1879         msg = ofputil_reserve_stats_reply(
1880             sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1881         start_len = msg->size;
1882
1883         nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1884         nfs->table_id = fs->table_id;
1885         nfs->pad = 0;
1886         nfs->duration_sec = htonl(fs->duration_sec);
1887         nfs->duration_nsec = htonl(fs->duration_nsec);
1888         nfs->priority = htons(fs->rule.priority);
1889         nfs->idle_timeout = htons(fs->idle_timeout);
1890         nfs->hard_timeout = htons(fs->hard_timeout);
1891         nfs->idle_age = htons(fs->idle_age < 0 ? 0
1892                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1893                               : UINT16_MAX);
1894         nfs->hard_age = htons(fs->hard_age < 0 ? 0
1895                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1896                               : UINT16_MAX);
1897         nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
1898         nfs->cookie = fs->cookie;
1899         nfs->packet_count = htonll(fs->packet_count);
1900         nfs->byte_count = htonll(fs->byte_count);
1901         ofpbuf_put(msg, fs->actions, act_len);
1902         nfs->length = htons(msg->size - start_len);
1903     } else {
1904         NOT_REACHED();
1905     }
1906 }
1907
1908 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1909  * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
1910 struct ofpbuf *
1911 ofputil_encode_aggregate_stats_reply(
1912     const struct ofputil_aggregate_stats *stats,
1913     const struct ofp_stats_msg *request)
1914 {
1915     struct ofpbuf *msg;
1916
1917     if (request->type == htons(OFPST_AGGREGATE)) {
1918         struct ofp_aggregate_stats_reply *asr;
1919
1920         asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1921         put_32aligned_be64(&asr->packet_count,
1922                            htonll(unknown_to_zero(stats->packet_count)));
1923         put_32aligned_be64(&asr->byte_count,
1924                            htonll(unknown_to_zero(stats->byte_count)));
1925         asr->flow_count = htonl(stats->flow_count);
1926     } else if (request->type == htons(OFPST_VENDOR)) {
1927         struct nx_aggregate_stats_reply *nasr;
1928
1929         nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1930         assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1931         nasr->packet_count = htonll(stats->packet_count);
1932         nasr->byte_count = htonll(stats->byte_count);
1933         nasr->flow_count = htonl(stats->flow_count);
1934     } else {
1935         NOT_REACHED();
1936     }
1937
1938     return msg;
1939 }
1940
1941 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1942  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
1943  * an OpenFlow error code. */
1944 enum ofperr
1945 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1946                             const struct ofp_header *oh)
1947 {
1948     const struct ofputil_msg_type *type;
1949     enum ofputil_msg_code code;
1950
1951     ofputil_decode_msg_type(oh, &type);
1952     code = ofputil_msg_type_code(type);
1953     if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1954         const struct ofp_flow_removed *ofr;
1955
1956         ofr = (const struct ofp_flow_removed *) oh;
1957         ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1958                                     &fr->rule);
1959         fr->cookie = ofr->cookie;
1960         fr->reason = ofr->reason;
1961         fr->duration_sec = ntohl(ofr->duration_sec);
1962         fr->duration_nsec = ntohl(ofr->duration_nsec);
1963         fr->idle_timeout = ntohs(ofr->idle_timeout);
1964         fr->packet_count = ntohll(ofr->packet_count);
1965         fr->byte_count = ntohll(ofr->byte_count);
1966     } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1967         struct nx_flow_removed *nfr;
1968         struct ofpbuf b;
1969         int error;
1970
1971         ofpbuf_use_const(&b, oh, ntohs(oh->length));
1972
1973         nfr = ofpbuf_pull(&b, sizeof *nfr);
1974         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1975                               &fr->rule, NULL, NULL);
1976         if (error) {
1977             return error;
1978         }
1979         if (b.size) {
1980             return OFPERR_OFPBRC_BAD_LEN;
1981         }
1982
1983         fr->cookie = nfr->cookie;
1984         fr->reason = nfr->reason;
1985         fr->duration_sec = ntohl(nfr->duration_sec);
1986         fr->duration_nsec = ntohl(nfr->duration_nsec);
1987         fr->idle_timeout = ntohs(nfr->idle_timeout);
1988         fr->packet_count = ntohll(nfr->packet_count);
1989         fr->byte_count = ntohll(nfr->byte_count);
1990     } else {
1991         NOT_REACHED();
1992     }
1993
1994     return 0;
1995 }
1996
1997 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1998  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1999  * message. */
2000 struct ofpbuf *
2001 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2002                             enum ofputil_protocol protocol)
2003 {
2004     struct ofpbuf *msg;
2005
2006     switch (protocol) {
2007     case OFPUTIL_P_OF10:
2008     case OFPUTIL_P_OF10_TID: {
2009         struct ofp_flow_removed *ofr;
2010
2011         ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
2012                                 &msg);
2013         ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
2014         ofr->cookie = fr->cookie;
2015         ofr->priority = htons(fr->rule.priority);
2016         ofr->reason = fr->reason;
2017         ofr->duration_sec = htonl(fr->duration_sec);
2018         ofr->duration_nsec = htonl(fr->duration_nsec);
2019         ofr->idle_timeout = htons(fr->idle_timeout);
2020         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2021         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2022         break;
2023     }
2024
2025     case OFPUTIL_P_NXM:
2026     case OFPUTIL_P_NXM_TID: {
2027         struct nx_flow_removed *nfr;
2028         int match_len;
2029
2030         make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
2031         match_len = nx_put_match(msg, &fr->rule, 0, 0);
2032
2033         nfr = msg->data;
2034         nfr->cookie = fr->cookie;
2035         nfr->priority = htons(fr->rule.priority);
2036         nfr->reason = fr->reason;
2037         nfr->duration_sec = htonl(fr->duration_sec);
2038         nfr->duration_nsec = htonl(fr->duration_nsec);
2039         nfr->idle_timeout = htons(fr->idle_timeout);
2040         nfr->match_len = htons(match_len);
2041         nfr->packet_count = htonll(fr->packet_count);
2042         nfr->byte_count = htonll(fr->byte_count);
2043         break;
2044     }
2045
2046     default:
2047         NOT_REACHED();
2048     }
2049
2050     return msg;
2051 }
2052
2053 int
2054 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2055                          const struct ofp_header *oh)
2056 {
2057     const struct ofputil_msg_type *type;
2058     enum ofputil_msg_code code;
2059
2060     ofputil_decode_msg_type(oh, &type);
2061     code = ofputil_msg_type_code(type);
2062     memset(pin, 0, sizeof *pin);
2063
2064     if (code == OFPUTIL_OFPT_PACKET_IN) {
2065         const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
2066
2067         pin->packet = opi->data;
2068         pin->packet_len = ntohs(opi->header.length)
2069             - offsetof(struct ofp_packet_in, data);
2070
2071         pin->fmd.in_port = ntohs(opi->in_port);
2072         pin->reason = opi->reason;
2073         pin->buffer_id = ntohl(opi->buffer_id);
2074         pin->total_len = ntohs(opi->total_len);
2075     } else if (code == OFPUTIL_NXT_PACKET_IN) {
2076         const struct nx_packet_in *npi;
2077         struct cls_rule rule;
2078         struct ofpbuf b;
2079         int error;
2080
2081         ofpbuf_use_const(&b, oh, ntohs(oh->length));
2082
2083         npi = ofpbuf_pull(&b, sizeof *npi);
2084         error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2085                               NULL);
2086         if (error) {
2087             return error;
2088         }
2089
2090         if (!ofpbuf_try_pull(&b, 2)) {
2091             return OFPERR_OFPBRC_BAD_LEN;
2092         }
2093
2094         pin->packet = b.data;
2095         pin->packet_len = b.size;
2096         pin->reason = npi->reason;
2097         pin->table_id = npi->table_id;
2098         pin->cookie = npi->cookie;
2099
2100         pin->fmd.in_port = rule.flow.in_port;
2101
2102         pin->fmd.tun_id = rule.flow.tun_id;
2103         pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
2104
2105         memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
2106         memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
2107                sizeof pin->fmd.reg_masks);
2108
2109         pin->buffer_id = ntohl(npi->buffer_id);
2110         pin->total_len = ntohs(npi->total_len);
2111     } else {
2112         NOT_REACHED();
2113     }
2114
2115     return 0;
2116 }
2117
2118 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2119  * in the format specified by 'packet_in_format'.  */
2120 struct ofpbuf *
2121 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2122                          enum nx_packet_in_format packet_in_format)
2123 {
2124     size_t send_len = MIN(pin->send_len, pin->packet_len);
2125     struct ofpbuf *packet;
2126
2127     /* Add OFPT_PACKET_IN. */
2128     if (packet_in_format == NXPIF_OPENFLOW10) {
2129         size_t header_len = offsetof(struct ofp_packet_in, data);
2130         struct ofp_packet_in *opi;
2131
2132         packet = ofpbuf_new(send_len + header_len);
2133         opi = ofpbuf_put_zeros(packet, header_len);
2134         opi->header.version = OFP10_VERSION;
2135         opi->header.type = OFPT_PACKET_IN;
2136         opi->total_len = htons(pin->total_len);
2137         opi->in_port = htons(pin->fmd.in_port);
2138         opi->reason = pin->reason;
2139         opi->buffer_id = htonl(pin->buffer_id);
2140
2141         ofpbuf_put(packet, pin->packet, send_len);
2142     } else if (packet_in_format == NXPIF_NXM) {
2143         struct nx_packet_in *npi;
2144         struct cls_rule rule;
2145         size_t match_len;
2146         size_t i;
2147
2148         /* Estimate of required PACKET_IN length includes the NPI header, space
2149          * for the match (2 times sizeof the metadata seems like enough), 2
2150          * bytes for padding, and the packet length. */
2151         packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
2152                             + 2 + send_len);
2153
2154         cls_rule_init_catchall(&rule, 0);
2155         cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
2156                                    pin->fmd.tun_id_mask);
2157
2158         for (i = 0; i < FLOW_N_REGS; i++) {
2159             cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
2160                                     pin->fmd.reg_masks[i]);
2161         }
2162
2163         cls_rule_set_in_port(&rule, pin->fmd.in_port);
2164
2165         ofpbuf_put_zeros(packet, sizeof *npi);
2166         match_len = nx_put_match(packet, &rule, 0, 0);
2167         ofpbuf_put_zeros(packet, 2);
2168         ofpbuf_put(packet, pin->packet, send_len);
2169
2170         npi = packet->data;
2171         npi->nxh.header.version = OFP10_VERSION;
2172         npi->nxh.header.type = OFPT_VENDOR;
2173         npi->nxh.vendor = htonl(NX_VENDOR_ID);
2174         npi->nxh.subtype = htonl(NXT_PACKET_IN);
2175
2176         npi->buffer_id = htonl(pin->buffer_id);
2177         npi->total_len = htons(pin->total_len);
2178         npi->reason = pin->reason;
2179         npi->table_id = pin->table_id;
2180         npi->cookie = pin->cookie;
2181         npi->match_len = htons(match_len);
2182     } else {
2183         NOT_REACHED();
2184     }
2185     update_openflow_length(packet);
2186
2187     return packet;
2188 }
2189
2190 const char *
2191 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2192 {
2193     static char s[INT_STRLEN(int) + 1];
2194
2195     switch (reason) {
2196     case OFPR_NO_MATCH:
2197         return "no_match";
2198     case OFPR_ACTION:
2199         return "action";
2200     case OFPR_INVALID_TTL:
2201         return "invalid_ttl";
2202
2203     case OFPR_N_REASONS:
2204     default:
2205         sprintf(s, "%d", (int) reason);
2206         return s;
2207     }
2208 }
2209
2210 bool
2211 ofputil_packet_in_reason_from_string(const char *s,
2212                                      enum ofp_packet_in_reason *reason)
2213 {
2214     int i;
2215
2216     for (i = 0; i < OFPR_N_REASONS; i++) {
2217         if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2218             *reason = i;
2219             return true;
2220         }
2221     }
2222     return false;
2223 }
2224
2225 enum ofperr
2226 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2227                           const struct ofp_packet_out *opo)
2228 {
2229     enum ofperr error;
2230     struct ofpbuf b;
2231
2232     po->buffer_id = ntohl(opo->buffer_id);
2233     po->in_port = ntohs(opo->in_port);
2234     if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2235         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2236         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2237                      po->in_port);
2238         return OFPERR_NXBRC_BAD_IN_PORT;
2239     }
2240
2241     ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
2242     ofpbuf_pull(&b, sizeof *opo);
2243
2244     error = ofputil_pull_actions(&b, ntohs(opo->actions_len),
2245                                  &po->actions, &po->n_actions);
2246     if (error) {
2247         return error;
2248     }
2249
2250     if (po->buffer_id == UINT32_MAX) {
2251         po->packet = b.data;
2252         po->packet_len = b.size;
2253     } else {
2254         po->packet = NULL;
2255         po->packet_len = 0;
2256     }
2257
2258     return 0;
2259 }
2260 \f
2261 /* ofputil_phy_port */
2262
2263 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2264 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
2265 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
2266 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
2267 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
2268 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
2269 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
2270 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
2271
2272 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2273 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2274 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2275 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2276 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2277 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2278
2279 static enum netdev_features
2280 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2281 {
2282     uint32_t ofp10 = ntohl(ofp10_);
2283     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2284 }
2285
2286 static ovs_be32
2287 netdev_port_features_to_ofp10(enum netdev_features features)
2288 {
2289     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2290 }
2291
2292 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
2293 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
2294 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
2295 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
2296 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
2297 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
2298 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
2299 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
2300 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
2301 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
2302 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
2303 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
2304 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
2305 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
2306 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
2307 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2308
2309 static enum netdev_features
2310 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2311 {
2312     return ntohl(ofp11) & 0xffff;
2313 }
2314
2315 static ovs_be32
2316 netdev_port_features_to_ofp11(enum netdev_features features)
2317 {
2318     return htonl(features & 0xffff);
2319 }
2320
2321 static enum ofperr
2322 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2323                               const struct ofp10_phy_port *opp)
2324 {
2325     memset(pp, 0, sizeof *pp);
2326
2327     pp->port_no = ntohs(opp->port_no);
2328     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2329     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2330
2331     pp->config = ntohl(opp->config) & OFPPC10_ALL;
2332     pp->state = ntohl(opp->state) & OFPPS10_ALL;
2333
2334     pp->curr = netdev_port_features_from_ofp10(opp->curr);
2335     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2336     pp->supported = netdev_port_features_from_ofp10(opp->supported);
2337     pp->peer = netdev_port_features_from_ofp10(opp->peer);
2338
2339     pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2340     pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2341
2342     return 0;
2343 }
2344
2345 static enum ofperr
2346 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2347                           const struct ofp11_port *op)
2348 {
2349     enum ofperr error;
2350
2351     memset(pp, 0, sizeof *pp);
2352
2353     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2354     if (error) {
2355         return error;
2356     }
2357     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2358     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2359
2360     pp->config = ntohl(op->config) & OFPPC11_ALL;
2361     pp->state = ntohl(op->state) & OFPPC11_ALL;
2362
2363     pp->curr = netdev_port_features_from_ofp11(op->curr);
2364     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2365     pp->supported = netdev_port_features_from_ofp11(op->supported);
2366     pp->peer = netdev_port_features_from_ofp11(op->peer);
2367
2368     pp->curr_speed = ntohl(op->curr_speed);
2369     pp->max_speed = ntohl(op->max_speed);
2370
2371     return 0;
2372 }
2373
2374 static void
2375 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2376                               struct ofp10_phy_port *opp)
2377 {
2378     memset(opp, 0, sizeof *opp);
2379
2380     opp->port_no = htons(pp->port_no);
2381     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2382     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2383
2384     opp->config = htonl(pp->config & OFPPC10_ALL);
2385     opp->state = htonl(pp->state & OFPPS10_ALL);
2386
2387     opp->curr = netdev_port_features_to_ofp10(pp->curr);
2388     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2389     opp->supported = netdev_port_features_to_ofp10(pp->supported);
2390     opp->peer = netdev_port_features_to_ofp10(pp->peer);
2391 }
2392
2393 static void
2394 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2395                           struct ofp11_port *op)
2396 {
2397     memset(op, 0, sizeof *op);
2398
2399     op->port_no = ofputil_port_to_ofp11(pp->port_no);
2400     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2401     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2402
2403     op->config = htonl(pp->config & OFPPC11_ALL);
2404     op->state = htonl(pp->state & OFPPS11_ALL);
2405
2406     op->curr = netdev_port_features_to_ofp11(pp->curr);
2407     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2408     op->supported = netdev_port_features_to_ofp11(pp->supported);
2409     op->peer = netdev_port_features_to_ofp11(pp->peer);
2410
2411     op->curr_speed = htonl(pp->curr_speed);
2412     op->max_speed = htonl(pp->max_speed);
2413 }
2414
2415 static void
2416 ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
2417                      struct ofpbuf *b)
2418 {
2419     if (ofp_version == OFP10_VERSION) {
2420         struct ofp10_phy_port *opp;
2421         if (b->size + sizeof *opp <= UINT16_MAX) {
2422             opp = ofpbuf_put_uninit(b, sizeof *opp);
2423             ofputil_encode_ofp10_phy_port(pp, opp);
2424         }
2425     } else {
2426         struct ofp11_port *op;
2427         if (b->size + sizeof *op <= UINT16_MAX) {
2428             op = ofpbuf_put_uninit(b, sizeof *op);
2429             ofputil_encode_ofp11_port(pp, op);
2430         }
2431     }
2432 }
2433
2434 void
2435 ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
2436                                      const struct ofputil_phy_port *pp,
2437                                      struct list *replies)
2438 {
2439     if (ofp_version == OFP10_VERSION) {
2440         struct ofp10_phy_port *opp;
2441
2442         opp = ofputil_append_stats_reply(sizeof *opp, replies);
2443         ofputil_encode_ofp10_phy_port(pp, opp);
2444     } else {
2445         struct ofp11_port *op;
2446
2447         op = ofputil_append_stats_reply(sizeof *op, replies);
2448         ofputil_encode_ofp11_port(pp, op);
2449     }
2450 }
2451 \f
2452 /* ofputil_switch_features */
2453
2454 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2455                      OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
2456 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2457 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2458 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2459 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2460 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2461 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2462
2463 struct ofputil_action_bit_translation {
2464     enum ofputil_action_bitmap ofputil_bit;
2465     int of_bit;
2466 };
2467
2468 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2469     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
2470     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2471     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2472     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
2473     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
2474     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
2475     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
2476     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
2477     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
2478     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
2479     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
2480     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
2481     { 0, 0 },
2482 };
2483
2484 static const struct ofputil_action_bit_translation of11_action_bits[] = {
2485     { OFPUTIL_A_OUTPUT,         OFPAT11_OUTPUT },
2486     { OFPUTIL_A_SET_VLAN_VID,   OFPAT11_SET_VLAN_VID },
2487     { OFPUTIL_A_SET_VLAN_PCP,   OFPAT11_SET_VLAN_PCP },
2488     { OFPUTIL_A_SET_DL_SRC,     OFPAT11_SET_DL_SRC },
2489     { OFPUTIL_A_SET_DL_DST,     OFPAT11_SET_DL_DST },
2490     { OFPUTIL_A_SET_NW_SRC,     OFPAT11_SET_NW_SRC },
2491     { OFPUTIL_A_SET_NW_DST,     OFPAT11_SET_NW_DST },
2492     { OFPUTIL_A_SET_NW_TOS,     OFPAT11_SET_NW_TOS },
2493     { OFPUTIL_A_SET_NW_ECN,     OFPAT11_SET_NW_ECN },
2494     { OFPUTIL_A_SET_TP_SRC,     OFPAT11_SET_TP_SRC },
2495     { OFPUTIL_A_SET_TP_DST,     OFPAT11_SET_TP_DST },
2496     { OFPUTIL_A_COPY_TTL_OUT,   OFPAT11_COPY_TTL_OUT },
2497     { OFPUTIL_A_COPY_TTL_IN,    OFPAT11_COPY_TTL_IN },
2498     { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
2499     { OFPUTIL_A_SET_MPLS_TC,    OFPAT11_SET_MPLS_TC },
2500     { OFPUTIL_A_SET_MPLS_TTL,   OFPAT11_SET_MPLS_TTL },
2501     { OFPUTIL_A_DEC_MPLS_TTL,   OFPAT11_DEC_MPLS_TTL },
2502     { OFPUTIL_A_PUSH_VLAN,      OFPAT11_PUSH_VLAN },
2503     { OFPUTIL_A_POP_VLAN,       OFPAT11_POP_VLAN },
2504     { OFPUTIL_A_PUSH_MPLS,      OFPAT11_PUSH_MPLS },
2505     { OFPUTIL_A_POP_MPLS,       OFPAT11_POP_MPLS },
2506     { OFPUTIL_A_SET_QUEUE,      OFPAT11_SET_QUEUE },
2507     { OFPUTIL_A_GROUP,          OFPAT11_GROUP },
2508     { OFPUTIL_A_SET_NW_TTL,     OFPAT11_SET_NW_TTL },
2509     { OFPUTIL_A_DEC_NW_TTL,     OFPAT11_DEC_NW_TTL },
2510     { 0, 0 },
2511 };
2512
2513 static enum ofputil_action_bitmap
2514 decode_action_bits(ovs_be32 of_actions,
2515                    const struct ofputil_action_bit_translation *x)
2516 {
2517     enum ofputil_action_bitmap ofputil_actions;
2518
2519     ofputil_actions = 0;
2520     for (; x->ofputil_bit; x++) {
2521         if (of_actions & htonl(1u << x->of_bit)) {
2522             ofputil_actions |= x->ofputil_bit;
2523         }
2524     }
2525     return ofputil_actions;
2526 }
2527
2528 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2529  * abstract representation in '*features'.  Initializes '*b' to iterate over
2530  * the OpenFlow port structures following 'osf' with later calls to
2531  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
2532  * OFPERR_* value.  */
2533 enum ofperr
2534 ofputil_decode_switch_features(const struct ofp_switch_features *osf,
2535                                struct ofputil_switch_features *features,
2536                                struct ofpbuf *b)
2537 {
2538     ofpbuf_use_const(b, osf, ntohs(osf->header.length));
2539     ofpbuf_pull(b, sizeof *osf);
2540
2541     features->datapath_id = ntohll(osf->datapath_id);
2542     features->n_buffers = ntohl(osf->n_buffers);
2543     features->n_tables = osf->n_tables;
2544
2545     features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
2546     if (osf->header.version == OFP10_VERSION) {
2547         if (b->size % sizeof(struct ofp10_phy_port)) {
2548             return OFPERR_OFPBRC_BAD_LEN;
2549         }
2550
2551         if (osf->capabilities & htonl(OFPC10_STP)) {
2552             features->capabilities |= OFPUTIL_C_STP;
2553         }
2554         features->actions = decode_action_bits(osf->actions, of10_action_bits);
2555     } else if (osf->header.version == OFP11_VERSION) {
2556         if (b->size % sizeof(struct ofp11_port)) {
2557             return OFPERR_OFPBRC_BAD_LEN;
2558         }
2559
2560         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2561             features->capabilities |= OFPUTIL_C_GROUP_STATS;
2562         }
2563         features->actions = decode_action_bits(osf->actions, of11_action_bits);
2564     } else {
2565         return OFPERR_OFPBRC_BAD_VERSION;
2566     }
2567
2568     return 0;
2569 }
2570
2571 static ovs_be32
2572 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2573                    const struct ofputil_action_bit_translation *x)
2574 {
2575     uint32_t of_actions;
2576
2577     of_actions = 0;
2578     for (; x->ofputil_bit; x++) {
2579         if (ofputil_actions & x->ofputil_bit) {
2580             of_actions |= 1 << x->of_bit;
2581         }
2582     }
2583     return htonl(of_actions);
2584 }
2585
2586 /* Returns a buffer owned by the caller that encodes 'features' in the format
2587  * required by 'protocol' with the given 'xid'.  The caller should append port
2588  * information to the buffer with subsequent calls to
2589  * ofputil_put_switch_features_port(). */
2590 struct ofpbuf *
2591 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2592                                enum ofputil_protocol protocol, ovs_be32 xid)
2593 {
2594     struct ofp_switch_features *osf;
2595     struct ofpbuf *b;
2596
2597     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
2598     osf->header.version = ofputil_protocol_to_ofp_version(protocol);
2599     osf->datapath_id = htonll(features->datapath_id);
2600     osf->n_buffers = htonl(features->n_buffers);
2601     osf->n_tables = features->n_tables;
2602
2603     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2604     if (osf->header.version == OFP10_VERSION) {
2605         if (features->capabilities & OFPUTIL_C_STP) {
2606             osf->capabilities |= htonl(OFPC10_STP);
2607         }
2608         osf->actions = encode_action_bits(features->actions, of10_action_bits);
2609     } else {
2610         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2611             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2612         }
2613         osf->actions = encode_action_bits(features->actions, of11_action_bits);
2614     }
2615
2616     return b;
2617 }
2618
2619 /* Encodes 'pp' into the format required by the switch_features message already
2620  * in 'b', which should have been returned by ofputil_encode_switch_features(),
2621  * and appends the encoded version to 'b'. */
2622 void
2623 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2624                                  struct ofpbuf *b)
2625 {
2626     const struct ofp_switch_features *osf = b->data;
2627
2628     ofputil_put_phy_port(osf->header.version, pp, b);
2629 }
2630 \f
2631 /* ofputil_port_status */
2632
2633 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2634  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2635 enum ofperr
2636 ofputil_decode_port_status(const struct ofp_port_status *ops,
2637                            struct ofputil_port_status *ps)
2638 {
2639     struct ofpbuf b;
2640     int retval;
2641
2642     if (ops->reason != OFPPR_ADD &&
2643         ops->reason != OFPPR_DELETE &&
2644         ops->reason != OFPPR_MODIFY) {
2645         return OFPERR_NXBRC_BAD_REASON;
2646     }
2647     ps->reason = ops->reason;
2648
2649     ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
2650     ofpbuf_pull(&b, sizeof *ops);
2651     retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
2652     assert(retval != EOF);
2653     return retval;
2654 }
2655
2656 /* Converts the abstract form of a "port status" message in '*ps' into an
2657  * OpenFlow message suitable for 'protocol', and returns that encoded form in
2658  * a buffer owned by the caller. */
2659 struct ofpbuf *
2660 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2661                            enum ofputil_protocol protocol)
2662 {
2663     struct ofp_port_status *ops;
2664     struct ofpbuf *b;
2665
2666     b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
2667     ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
2668     ops->header.version = ofputil_protocol_to_ofp_version(protocol);
2669     ops->reason = ps->reason;
2670     ofputil_put_phy_port(ops->header.version, &ps->desc, b);
2671     update_openflow_length(b);
2672     return b;
2673 }
2674 \f
2675 /* ofputil_port_mod */
2676
2677 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2678  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2679 enum ofperr
2680 ofputil_decode_port_mod(const struct ofp_header *oh,
2681                         struct ofputil_port_mod *pm)
2682 {
2683     if (oh->version == OFP10_VERSION) {
2684         const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
2685
2686         if (oh->length != htons(sizeof *opm)) {
2687             return OFPERR_OFPBRC_BAD_LEN;
2688         }
2689
2690         pm->port_no = ntohs(opm->port_no);
2691         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2692         pm->config = ntohl(opm->config) & OFPPC10_ALL;
2693         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2694         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2695     } else if (oh->version == OFP11_VERSION) {
2696         const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
2697         enum ofperr error;
2698
2699         if (oh->length != htons(sizeof *opm)) {
2700             return OFPERR_OFPBRC_BAD_LEN;
2701         }
2702
2703         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2704         if (error) {
2705             return error;
2706         }
2707
2708         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2709         pm->config = ntohl(opm->config) & OFPPC11_ALL;
2710         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2711         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2712     } else {
2713         return OFPERR_OFPBRC_BAD_VERSION;
2714     }
2715
2716     pm->config &= pm->mask;
2717     return 0;
2718 }
2719
2720 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2721  * message suitable for 'protocol', and returns that encoded form in a buffer
2722  * owned by the caller. */
2723 struct ofpbuf *
2724 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2725                         enum ofputil_protocol protocol)
2726 {
2727     uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
2728     struct ofpbuf *b;
2729
2730     if (ofp_version == OFP10_VERSION) {
2731         struct ofp10_port_mod *opm;
2732
2733         opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
2734         opm->port_no = htons(pm->port_no);
2735         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2736         opm->config = htonl(pm->config & OFPPC10_ALL);
2737         opm->mask = htonl(pm->mask & OFPPC10_ALL);
2738         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2739     } else if (ofp_version == OFP11_VERSION) {
2740         struct ofp11_port_mod *opm;
2741
2742         opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
2743         opm->port_no = htonl(pm->port_no);
2744         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2745         opm->config = htonl(pm->config & OFPPC11_ALL);
2746         opm->mask = htonl(pm->mask & OFPPC11_ALL);
2747         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2748     } else {
2749         NOT_REACHED();
2750     }
2751
2752     return b;
2753 }
2754
2755 struct ofpbuf *
2756 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
2757 {
2758     struct ofp_packet_out *opo;
2759     size_t actions_len;
2760     struct ofpbuf *msg;
2761     size_t size;
2762
2763     actions_len = po->n_actions * sizeof *po->actions;
2764     size = sizeof *opo + actions_len;
2765     if (po->buffer_id == UINT32_MAX) {
2766         size += po->packet_len;
2767     }
2768
2769     msg = ofpbuf_new(size);
2770     opo = put_openflow(sizeof *opo, OFPT10_PACKET_OUT, msg);
2771     opo->buffer_id = htonl(po->buffer_id);
2772     opo->in_port = htons(po->in_port);
2773     opo->actions_len = htons(actions_len);
2774     ofpbuf_put(msg, po->actions, actions_len);
2775     if (po->buffer_id == UINT32_MAX) {
2776         ofpbuf_put(msg, po->packet, po->packet_len);
2777     }
2778     update_openflow_length(msg);
2779
2780     return msg;
2781 }
2782
2783 /* Returns a string representing the message type of 'type'.  The string is the
2784  * enumeration constant for the type, e.g. "OFPT_HELLO".  For statistics
2785  * messages, the constant is followed by "request" or "reply",
2786  * e.g. "OFPST_AGGREGATE reply". */
2787 const char *
2788 ofputil_msg_type_name(const struct ofputil_msg_type *type)
2789 {
2790     return type->name;
2791 }
2792 \f
2793 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2794  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2795  * an arbitrary transaction id.  Allocated bytes beyond the header, if any, are
2796  * zeroed.
2797  *
2798  * The caller is responsible for freeing '*bufferp' when it is no longer
2799  * needed.
2800  *
2801  * The OpenFlow header length is initially set to 'openflow_len'; if the
2802  * message is later extended, the length should be updated with
2803  * update_openflow_length() before sending.
2804  *
2805  * Returns the header. */
2806 void *
2807 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
2808 {
2809     *bufferp = ofpbuf_new(openflow_len);
2810     return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
2811 }
2812
2813 /* Similar to make_openflow() but creates a Nicira vendor extension message
2814  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2815 void *
2816 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
2817 {
2818     return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
2819 }
2820
2821 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2822  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2823  * transaction id 'xid'.  Allocated bytes beyond the header, if any, are
2824  * zeroed.
2825  *
2826  * The caller is responsible for freeing '*bufferp' when it is no longer
2827  * needed.
2828  *
2829  * The OpenFlow header length is initially set to 'openflow_len'; if the
2830  * message is later extended, the length should be updated with
2831  * update_openflow_length() before sending.
2832  *
2833  * Returns the header. */
2834 void *
2835 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2836                   struct ofpbuf **bufferp)
2837 {
2838     *bufferp = ofpbuf_new(openflow_len);
2839     return put_openflow_xid(openflow_len, type, xid, *bufferp);
2840 }
2841
2842 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
2843  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2844 void *
2845 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2846                struct ofpbuf **bufferp)
2847 {
2848     *bufferp = ofpbuf_new(openflow_len);
2849     return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
2850 }
2851
2852 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2853  * with the given 'type' and an arbitrary transaction id.  Allocated bytes
2854  * beyond the header, if any, are zeroed.
2855  *
2856  * The OpenFlow header length is initially set to 'openflow_len'; if the
2857  * message is later extended, the length should be updated with
2858  * update_openflow_length() before sending.
2859  *
2860  * Returns the header. */
2861 void *
2862 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
2863 {
2864     return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
2865 }
2866
2867 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2868  * with the given 'type' and an transaction id 'xid'.  Allocated bytes beyond
2869  * the header, if any, are zeroed.
2870  *
2871  * The OpenFlow header length is initially set to 'openflow_len'; if the
2872  * message is later extended, the length should be updated with
2873  * update_openflow_length() before sending.
2874  *
2875  * Returns the header. */
2876 void *
2877 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2878                  struct ofpbuf *buffer)
2879 {
2880     struct ofp_header *oh;
2881
2882     assert(openflow_len >= sizeof *oh);
2883     assert(openflow_len <= UINT16_MAX);
2884
2885     oh = ofpbuf_put_uninit(buffer, openflow_len);
2886     oh->version = OFP10_VERSION;
2887     oh->type = type;
2888     oh->length = htons(openflow_len);
2889     oh->xid = xid;
2890     memset(oh + 1, 0, openflow_len - sizeof *oh);
2891     return oh;
2892 }
2893
2894 /* Similar to put_openflow() but append a Nicira vendor extension message with
2895  * the specific 'subtype'.  'subtype' should be in host byte order. */
2896 void *
2897 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
2898 {
2899     return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
2900 }
2901
2902 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
2903  * with the specific 'subtype'.  'subtype' should be in host byte order. */
2904 void *
2905 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2906               struct ofpbuf *buffer)
2907 {
2908     struct nicira_header *nxh;
2909
2910     nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
2911     nxh->vendor = htonl(NX_VENDOR_ID);
2912     nxh->subtype = htonl(subtype);
2913     return nxh;
2914 }
2915
2916 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
2917  * 'buffer->size'. */
2918 void
2919 update_openflow_length(struct ofpbuf *buffer)
2920 {
2921     struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
2922     oh->length = htons(buffer->size);
2923 }
2924
2925 static void
2926 put_stats__(ovs_be32 xid, uint8_t ofp_type,
2927             ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
2928             struct ofpbuf *msg)
2929 {
2930     if (ofpst_type == htons(OFPST_VENDOR)) {
2931         struct nicira_stats_msg *nsm;
2932
2933         nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
2934         nsm->vsm.osm.type = ofpst_type;
2935         nsm->vsm.vendor = htonl(NX_VENDOR_ID);
2936         nsm->subtype = nxst_subtype;
2937     } else {
2938         struct ofp_stats_msg *osm;
2939
2940         osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
2941         osm->type = ofpst_type;
2942     }
2943 }
2944
2945 /* Creates a statistics request message with total length 'openflow_len'
2946  * (including all headers) and the given 'ofpst_type', and stores the buffer
2947  * containing the new message in '*bufferp'.  If 'ofpst_type' is OFPST_VENDOR
2948  * then 'nxst_subtype' is used as the Nicira vendor extension statistics
2949  * subtype (otherwise 'nxst_subtype' is ignored).
2950  *
2951  * Initializes bytes following the headers to all-bits-zero.
2952  *
2953  * Returns the first byte of the new message. */
2954 void *
2955 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
2956                            uint32_t nxst_subtype, struct ofpbuf **bufferp)
2957 {
2958     struct ofpbuf *msg;
2959
2960     msg = *bufferp = ofpbuf_new(openflow_len);
2961     put_stats__(alloc_xid(), OFPT10_STATS_REQUEST,
2962                 htons(ofpst_type), htonl(nxst_subtype), msg);
2963     ofpbuf_padto(msg, openflow_len);
2964
2965     return msg->data;
2966 }
2967
2968 static void
2969 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
2970 {
2971     assert(request->header.type == OFPT10_STATS_REQUEST ||
2972            request->header.type == OFPT10_STATS_REPLY);
2973     put_stats__(request->header.xid, OFPT10_STATS_REPLY, request->type,
2974                 (request->type != htons(OFPST_VENDOR)
2975                  ? htonl(0)
2976                  : ((const struct nicira_stats_msg *) request)->subtype),
2977                 msg);
2978 }
2979
2980 /* Creates a statistics reply message with total length 'openflow_len'
2981  * (including all headers) and the same type (either a standard OpenFlow
2982  * statistics type or a Nicira extension type and subtype) as 'request', and
2983  * stores the buffer containing the new message in '*bufferp'.
2984  *
2985  * Initializes bytes following the headers to all-bits-zero.
2986  *
2987  * Returns the first byte of the new message. */
2988 void *
2989 ofputil_make_stats_reply(size_t openflow_len,
2990                          const struct ofp_stats_msg *request,
2991                          struct ofpbuf **bufferp)
2992 {
2993     struct ofpbuf *msg;
2994
2995     msg = *bufferp = ofpbuf_new(openflow_len);
2996     put_stats_reply__(request, msg);
2997     ofpbuf_padto(msg, openflow_len);
2998
2999     return msg->data;
3000 }
3001
3002 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
3003  * replies to 'request', which should be an OpenFlow or Nicira extension
3004  * statistics request.  Initially 'replies' will have a single reply message
3005  * that has only a header.  The functions ofputil_reserve_stats_reply() and
3006  * ofputil_append_stats_reply() may be used to add to the reply. */
3007 void
3008 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
3009                           struct list *replies)
3010 {
3011     struct ofpbuf *msg;
3012
3013     msg = ofpbuf_new(1024);
3014     put_stats_reply__(request, msg);
3015
3016     list_init(replies);
3017     list_push_back(replies, &msg->list_node);
3018 }
3019
3020 /* Prepares to append up to 'len' bytes to the series of statistics replies in
3021  * 'replies', which should have been initialized with
3022  * ofputil_start_stats_reply().  Returns an ofpbuf with at least 'len' bytes of
3023  * tailroom.  (The 'len' bytes have not actually be allocated; the caller must
3024  * do so with e.g. ofpbuf_put_uninit().) */
3025 struct ofpbuf *
3026 ofputil_reserve_stats_reply(size_t len, struct list *replies)
3027 {
3028     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3029     struct ofp_stats_msg *osm = msg->data;
3030
3031     if (msg->size + len <= UINT16_MAX) {
3032         ofpbuf_prealloc_tailroom(msg, len);
3033     } else {
3034         osm->flags |= htons(OFPSF_REPLY_MORE);
3035
3036         msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
3037         put_stats_reply__(osm, msg);
3038         list_push_back(replies, &msg->list_node);
3039     }
3040     return msg;
3041 }
3042
3043 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
3044  * returns the first byte. */
3045 void *
3046 ofputil_append_stats_reply(size_t len, struct list *replies)
3047 {
3048     return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
3049 }
3050
3051 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
3052 const void *
3053 ofputil_stats_body(const struct ofp_header *oh)
3054 {
3055     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3056     return (const struct ofp_stats_msg *) oh + 1;
3057 }
3058
3059 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
3060 size_t
3061 ofputil_stats_body_len(const struct ofp_header *oh)
3062 {
3063     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3064     return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
3065 }
3066
3067 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
3068 const void *
3069 ofputil_nxstats_body(const struct ofp_header *oh)
3070 {
3071     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3072     return ((const struct nicira_stats_msg *) oh) + 1;
3073 }
3074
3075 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
3076 size_t
3077 ofputil_nxstats_body_len(const struct ofp_header *oh)
3078 {
3079     assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3080     return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
3081 }
3082
3083 struct ofpbuf *
3084 make_flow_mod(uint16_t command, const struct cls_rule *rule,
3085               size_t actions_len)
3086 {
3087     struct ofp_flow_mod *ofm;
3088     size_t size = sizeof *ofm + actions_len;
3089     struct ofpbuf *out = ofpbuf_new(size);
3090     ofm = ofpbuf_put_zeros(out, sizeof *ofm);
3091     ofm->header.version = OFP10_VERSION;
3092     ofm->header.type = OFPT10_FLOW_MOD;
3093     ofm->header.length = htons(size);
3094     ofm->cookie = 0;
3095     ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
3096     ofputil_cls_rule_to_match(rule, &ofm->match);
3097     ofm->command = htons(command);
3098     return out;
3099 }
3100
3101 struct ofpbuf *
3102 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
3103               uint16_t idle_timeout, size_t actions_len)
3104 {
3105     struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
3106     struct ofp_flow_mod *ofm = out->data;
3107     ofm->idle_timeout = htons(idle_timeout);
3108     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
3109     ofm->buffer_id = htonl(buffer_id);
3110     return out;
3111 }
3112
3113 struct ofpbuf *
3114 make_del_flow(const struct cls_rule *rule)
3115 {
3116     struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
3117     struct ofp_flow_mod *ofm = out->data;
3118     ofm->out_port = htons(OFPP_NONE);
3119     return out;
3120 }
3121
3122 struct ofpbuf *
3123 make_add_simple_flow(const struct cls_rule *rule,
3124                      uint32_t buffer_id, uint16_t out_port,
3125                      uint16_t idle_timeout)
3126 {
3127     if (out_port != OFPP_NONE) {
3128         struct ofp_action_output *oao;
3129         struct ofpbuf *buffer;
3130
3131         buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
3132         ofputil_put_OFPAT10_OUTPUT(buffer)->port = htons(out_port);
3133         return buffer;
3134     } else {
3135         return make_add_flow(rule, buffer_id, idle_timeout, 0);
3136     }
3137 }
3138
3139 struct ofpbuf *
3140 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
3141                const struct ofpbuf *payload, int max_send_len)
3142 {
3143     struct ofp_packet_in *opi;
3144     struct ofpbuf *buf;
3145     int send_len;
3146
3147     send_len = MIN(max_send_len, payload->size);
3148     buf = ofpbuf_new(sizeof *opi + send_len);
3149     opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
3150                            OFPT_PACKET_IN, 0, buf);
3151     opi->buffer_id = htonl(buffer_id);
3152     opi->total_len = htons(payload->size);
3153     opi->in_port = htons(in_port);
3154     opi->reason = reason;
3155     ofpbuf_put(buf, payload->data, send_len);
3156     update_openflow_length(buf);
3157
3158     return buf;
3159 }
3160
3161 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3162 struct ofpbuf *
3163 make_echo_request(void)
3164 {
3165     struct ofp_header *rq;
3166     struct ofpbuf *out = ofpbuf_new(sizeof *rq);
3167     rq = ofpbuf_put_uninit(out, sizeof *rq);
3168     rq->version = OFP10_VERSION;
3169     rq->type = OFPT_ECHO_REQUEST;
3170     rq->length = htons(sizeof *rq);
3171     rq->xid = htonl(0);
3172     return out;
3173 }
3174
3175 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3176  * OFPT_ECHO_REQUEST message in 'rq'. */
3177 struct ofpbuf *
3178 make_echo_reply(const struct ofp_header *rq)
3179 {
3180     size_t size = ntohs(rq->length);
3181     struct ofpbuf *out = ofpbuf_new(size);
3182     struct ofp_header *reply = ofpbuf_put(out, rq, size);
3183     reply->type = OFPT_ECHO_REPLY;
3184     return out;
3185 }
3186
3187 struct ofpbuf *
3188 ofputil_encode_barrier_request(void)
3189 {
3190     struct ofpbuf *msg;
3191
3192     make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
3193     return msg;
3194 }
3195
3196 const char *
3197 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3198 {
3199     switch (flags & OFPC_FRAG_MASK) {
3200     case OFPC_FRAG_NORMAL:   return "normal";
3201     case OFPC_FRAG_DROP:     return "drop";
3202     case OFPC_FRAG_REASM:    return "reassemble";
3203     case OFPC_FRAG_NX_MATCH: return "nx-match";
3204     }
3205
3206     NOT_REACHED();
3207 }
3208
3209 bool
3210 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3211 {
3212     if (!strcasecmp(s, "normal")) {
3213         *flags = OFPC_FRAG_NORMAL;
3214     } else if (!strcasecmp(s, "drop")) {
3215         *flags = OFPC_FRAG_DROP;
3216     } else if (!strcasecmp(s, "reassemble")) {
3217         *flags = OFPC_FRAG_REASM;
3218     } else if (!strcasecmp(s, "nx-match")) {
3219         *flags = OFPC_FRAG_NX_MATCH;
3220     } else {
3221         return false;
3222     }
3223     return true;
3224 }
3225
3226 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3227  * port number and stores the latter in '*ofp10_port', for the purpose of
3228  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
3229  * otherwise an OFPERR_* number.
3230  *
3231  * See the definition of OFP11_MAX for an explanation of the mapping. */
3232 enum ofperr
3233 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3234 {
3235     uint32_t ofp11_port_h = ntohl(ofp11_port);
3236
3237     if (ofp11_port_h < OFPP_MAX) {
3238         *ofp10_port = ofp11_port_h;
3239         return 0;
3240     } else if (ofp11_port_h >= OFPP11_MAX) {
3241         *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3242         return 0;
3243     } else {
3244         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3245                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3246                      ofp11_port_h, OFPP_MAX - 1,
3247                      (uint32_t) OFPP11_MAX, UINT32_MAX);
3248         return OFPERR_OFPBAC_BAD_OUT_PORT;
3249     }
3250 }
3251
3252 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3253  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3254  *
3255  * See the definition of OFP11_MAX for an explanation of the mapping. */
3256 ovs_be32
3257 ofputil_port_to_ofp11(uint16_t ofp10_port)
3258 {
3259     return htonl(ofp10_port < OFPP_MAX
3260                  ? ofp10_port
3261                  : ofp10_port + OFPP11_OFFSET);
3262 }
3263
3264 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3265  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
3266  * 'port' is valid, otherwise an OpenFlow return code. */
3267 enum ofperr
3268 ofputil_check_output_port(uint16_t port, int max_ports)
3269 {
3270     switch (port) {
3271     case OFPP_IN_PORT:
3272     case OFPP_TABLE:
3273     case OFPP_NORMAL:
3274     case OFPP_FLOOD:
3275     case OFPP_ALL:
3276     case OFPP_CONTROLLER:
3277     case OFPP_LOCAL:
3278         return 0;
3279
3280     default:
3281         if (port < max_ports) {
3282             return 0;
3283         }
3284         return OFPERR_OFPBAC_BAD_OUT_PORT;
3285     }
3286 }
3287
3288 #define OFPUTIL_NAMED_PORTS                     \
3289         OFPUTIL_NAMED_PORT(IN_PORT)             \
3290         OFPUTIL_NAMED_PORT(TABLE)               \
3291         OFPUTIL_NAMED_PORT(NORMAL)              \
3292         OFPUTIL_NAMED_PORT(FLOOD)               \
3293         OFPUTIL_NAMED_PORT(ALL)                 \
3294         OFPUTIL_NAMED_PORT(CONTROLLER)          \
3295         OFPUTIL_NAMED_PORT(LOCAL)               \
3296         OFPUTIL_NAMED_PORT(NONE)
3297
3298 /* Checks whether 's' is the string representation of an OpenFlow port number,
3299  * either as an integer or a string name (e.g. "LOCAL").  If it is, stores the
3300  * number in '*port' and returns true.  Otherwise, returns false. */
3301 bool
3302 ofputil_port_from_string(const char *name, uint16_t *port)
3303 {
3304     struct pair {
3305         const char *name;
3306         uint16_t value;
3307     };
3308     static const struct pair pairs[] = {
3309 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3310         OFPUTIL_NAMED_PORTS
3311 #undef OFPUTIL_NAMED_PORT
3312     };
3313     static const int n_pairs = ARRAY_SIZE(pairs);
3314     int i;
3315
3316     if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3317         *port = i;
3318         return true;
3319     }
3320
3321     for (i = 0; i < n_pairs; i++) {
3322         if (!strcasecmp(name, pairs[i].name)) {
3323             *port = pairs[i].value;
3324             return true;
3325         }
3326     }
3327     return false;
3328 }
3329
3330 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3331  * Most ports' string representation is just the port number, but for special
3332  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3333 void
3334 ofputil_format_port(uint16_t port, struct ds *s)
3335 {
3336     const char *name;
3337
3338     switch (port) {
3339 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3340         OFPUTIL_NAMED_PORTS
3341 #undef OFPUTIL_NAMED_PORT
3342
3343     default:
3344         ds_put_format(s, "%"PRIu16, port);
3345         return;
3346     }
3347     ds_put_cstr(s, name);
3348 }
3349
3350 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3351  * 'ofp_version', tries to pull the first element from the array.  If
3352  * successful, initializes '*pp' with an abstract representation of the
3353  * port and returns 0.  If no ports remain to be decoded, returns EOF.
3354  * On an error, returns a positive OFPERR_* value. */
3355 int
3356 ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
3357                       struct ofputil_phy_port *pp)
3358 {
3359     if (ofp_version == OFP10_VERSION) {
3360         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3361         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3362     } else {
3363         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3364         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3365     }
3366 }
3367
3368 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3369  * 'ofp_version', returns the number of elements. */
3370 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3371 {
3372     return (ofp_version == OFP10_VERSION
3373             ? b->size / sizeof(struct ofp10_phy_port)
3374             : b->size / sizeof(struct ofp11_port));
3375 }
3376
3377 static enum ofperr
3378 check_resubmit_table(const struct nx_action_resubmit *nar)
3379 {
3380     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
3381         return OFPERR_OFPBAC_BAD_ARGUMENT;
3382     }
3383     return 0;
3384 }
3385
3386 static enum ofperr
3387 check_output_reg(const struct nx_action_output_reg *naor,
3388                  const struct flow *flow)
3389 {
3390     struct mf_subfield src;
3391     size_t i;
3392
3393     for (i = 0; i < sizeof naor->zero; i++) {
3394         if (naor->zero[i]) {
3395             return OFPERR_OFPBAC_BAD_ARGUMENT;
3396         }
3397     }
3398
3399     nxm_decode(&src, naor->src, naor->ofs_nbits);
3400     return mf_check_src(&src, flow);
3401 }
3402
3403 enum ofperr
3404 validate_actions(const union ofp_action *actions, size_t n_actions,
3405                  const struct flow *flow, int max_ports)
3406 {
3407     const union ofp_action *a;
3408     size_t left;
3409
3410     OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
3411         enum ofperr error;
3412         uint16_t port;
3413         int code;
3414
3415         code = ofputil_decode_action(a);
3416         if (code < 0) {
3417             error = -code;
3418             VLOG_WARN_RL(&bad_ofmsg_rl,
3419                          "action decoding error at offset %td (%s)",
3420                          (a - actions) * sizeof *a, ofperr_get_name(error));
3421
3422             return error;
3423         }
3424
3425         error = 0;
3426         switch ((enum ofputil_action_code) code) {
3427         case OFPUTIL_OFPAT10_OUTPUT:
3428             error = ofputil_check_output_port(ntohs(a->output.port),
3429                                               max_ports);
3430             break;
3431
3432         case OFPUTIL_OFPAT10_SET_VLAN_VID:
3433             if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
3434                 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3435             }
3436             break;
3437
3438         case OFPUTIL_OFPAT10_SET_VLAN_PCP:
3439             if (a->vlan_pcp.vlan_pcp & ~7) {
3440                 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3441             }
3442             break;
3443
3444         case OFPUTIL_OFPAT10_ENQUEUE:
3445             port = ntohs(((const struct ofp_action_enqueue *) a)->port);
3446             if (port >= max_ports && port != OFPP_IN_PORT
3447                 && port != OFPP_LOCAL) {
3448                 error = OFPERR_OFPBAC_BAD_OUT_PORT;
3449             }
3450             break;
3451
3452         case OFPUTIL_NXAST_REG_MOVE:
3453             error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
3454                                        flow);
3455             break;
3456
3457         case OFPUTIL_NXAST_REG_LOAD:
3458             error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
3459                                        flow);
3460             break;
3461
3462         case OFPUTIL_NXAST_MULTIPATH:
3463             error = multipath_check((const struct nx_action_multipath *) a,
3464                                     flow);
3465             break;
3466
3467         case OFPUTIL_NXAST_AUTOPATH:
3468             error = autopath_check((const struct nx_action_autopath *) a,
3469                                    flow);
3470             break;
3471
3472         case OFPUTIL_NXAST_BUNDLE:
3473         case OFPUTIL_NXAST_BUNDLE_LOAD:
3474             error = bundle_check((const struct nx_action_bundle *) a,
3475                                  max_ports, flow);
3476             break;
3477
3478         case OFPUTIL_NXAST_OUTPUT_REG:
3479             error = check_output_reg((const struct nx_action_output_reg *) a,
3480                                      flow);
3481             break;
3482
3483         case OFPUTIL_NXAST_RESUBMIT_TABLE:
3484             error = check_resubmit_table(
3485                 (const struct nx_action_resubmit *) a);
3486             break;
3487
3488         case OFPUTIL_NXAST_LEARN:
3489             error = learn_check((const struct nx_action_learn *) a, flow);
3490             break;
3491
3492         case OFPUTIL_NXAST_CONTROLLER:
3493             if (((const struct nx_action_controller *) a)->zero) {
3494                 error = OFPERR_NXBAC_MUST_BE_ZERO;
3495             }
3496             break;
3497
3498         case OFPUTIL_OFPAT10_STRIP_VLAN:
3499         case OFPUTIL_OFPAT10_SET_NW_SRC:
3500         case OFPUTIL_OFPAT10_SET_NW_DST:
3501         case OFPUTIL_OFPAT10_SET_NW_TOS:
3502         case OFPUTIL_OFPAT10_SET_TP_SRC:
3503         case OFPUTIL_OFPAT10_SET_TP_DST:
3504         case OFPUTIL_OFPAT10_SET_DL_SRC:
3505         case OFPUTIL_OFPAT10_SET_DL_DST:
3506         case OFPUTIL_NXAST_RESUBMIT:
3507         case OFPUTIL_NXAST_SET_TUNNEL:
3508         case OFPUTIL_NXAST_SET_QUEUE:
3509         case OFPUTIL_NXAST_POP_QUEUE:
3510         case OFPUTIL_NXAST_NOTE:
3511         case OFPUTIL_NXAST_SET_TUNNEL64:
3512         case OFPUTIL_NXAST_EXIT:
3513         case OFPUTIL_NXAST_DEC_TTL:
3514         case OFPUTIL_NXAST_FIN_TIMEOUT:
3515             break;
3516         }
3517
3518         if (error) {
3519             VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
3520                          (a - actions) * sizeof *a, ofperr_get_name(error));
3521             return error;
3522         }
3523     }
3524     if (left) {
3525         VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
3526                      (n_actions - left) * sizeof *a);
3527         return OFPERR_OFPBAC_BAD_LEN;
3528     }
3529     return 0;
3530 }
3531
3532 struct ofputil_action {
3533     int code;
3534     unsigned int min_len;
3535     unsigned int max_len;
3536 };
3537
3538 static const struct ofputil_action action_bad_type
3539     = { -OFPERR_OFPBAC_BAD_TYPE,   0, UINT_MAX };
3540 static const struct ofputil_action action_bad_len
3541     = { -OFPERR_OFPBAC_BAD_LEN,    0, UINT_MAX };
3542 static const struct ofputil_action action_bad_vendor
3543     = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX };
3544
3545 static const struct ofputil_action *
3546 ofputil_decode_ofpat_action(const union ofp_action *a)
3547 {
3548     enum ofp10_action_type type = ntohs(a->type);
3549
3550     switch (type) {
3551 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                    \
3552         case ENUM: {                                        \
3553             static const struct ofputil_action action = {   \
3554                 OFPUTIL_##ENUM,                             \
3555                 sizeof(struct STRUCT),                      \
3556                 sizeof(struct STRUCT)                       \
3557             };                                              \
3558             return &action;                                 \
3559         }
3560 #include "ofp-util.def"
3561
3562     case OFPAT10_VENDOR:
3563     default:
3564         return &action_bad_type;
3565     }
3566 }
3567
3568 static const struct ofputil_action *
3569 ofputil_decode_nxast_action(const union ofp_action *a)
3570 {
3571     const struct nx_action_header *nah = (const struct nx_action_header *) a;
3572     enum nx_action_subtype subtype = ntohs(nah->subtype);
3573
3574     switch (subtype) {
3575 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3576         case ENUM: {                                            \
3577             static const struct ofputil_action action = {       \
3578                 OFPUTIL_##ENUM,                                 \
3579                 sizeof(struct STRUCT),                          \
3580                 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT)   \
3581             };                                                  \
3582             return &action;                                     \
3583         }
3584 #include "ofp-util.def"
3585
3586     case NXAST_SNAT__OBSOLETE:
3587     case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
3588     default:
3589         return &action_bad_type;
3590     }
3591 }
3592
3593 /* Parses 'a' to determine its type.  Returns a nonnegative OFPUTIL_OFPAT10_* or
3594  * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error
3595  * code.
3596  *
3597  * The caller must have already verified that 'a''s length is correct (that is,
3598  * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
3599  * longer than the amount of space allocated to 'a').
3600  *
3601  * This function verifies that 'a''s length is correct for the type of action
3602  * that it represents. */
3603 int
3604 ofputil_decode_action(const union ofp_action *a)
3605 {
3606     const struct ofputil_action *action;
3607     uint16_t len = ntohs(a->header.len);
3608
3609     if (a->type != htons(OFPAT10_VENDOR)) {
3610         action = ofputil_decode_ofpat_action(a);
3611     } else {
3612         switch (ntohl(a->vendor.vendor)) {
3613         case NX_VENDOR_ID:
3614             if (len < sizeof(struct nx_action_header)) {
3615                 return -OFPERR_OFPBAC_BAD_LEN;
3616             }
3617             action = ofputil_decode_nxast_action(a);
3618             break;
3619         default:
3620             action = &action_bad_vendor;
3621             break;
3622         }
3623     }
3624
3625     return (len >= action->min_len && len <= action->max_len
3626             ? action->code
3627             : -OFPERR_OFPBAC_BAD_LEN);
3628 }
3629
3630 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT10_* or OFPUTIL_NXAST_*
3631  * constant.  The caller must have already validated that 'a' is a valid action
3632  * understood by Open vSwitch (e.g. by a previous successful call to
3633  * ofputil_decode_action()). */
3634 enum ofputil_action_code
3635 ofputil_decode_action_unsafe(const union ofp_action *a)
3636 {
3637     const struct ofputil_action *action;
3638
3639     if (a->type != htons(OFPAT10_VENDOR)) {
3640         action = ofputil_decode_ofpat_action(a);
3641     } else {
3642         action = ofputil_decode_nxast_action(a);
3643     }
3644
3645     return action->code;
3646 }
3647
3648 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3649  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3650  * 'name' is not the name of any action.
3651  *
3652  * ofp-util.def lists the mapping from names to action. */
3653 int
3654 ofputil_action_code_from_name(const char *name)
3655 {
3656     static const char *names[OFPUTIL_N_ACTIONS] = {
3657 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
3658 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3659 #include "ofp-util.def"
3660     };
3661
3662     const char **p;
3663
3664     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3665         if (*p && !strcasecmp(name, *p)) {
3666             return p - names;
3667         }
3668     }
3669     return -1;
3670 }
3671
3672 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3673  * action.  Initializes the parts of 'action' that identify it as having type
3674  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
3675  * have variable length, the length used and cleared is that of struct
3676  * <STRUCT>.  */
3677 void *
3678 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3679 {
3680     switch (code) {
3681 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                    \
3682     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3683 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
3684     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3685 #include "ofp-util.def"
3686     }
3687     NOT_REACHED();
3688 }
3689
3690 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
3691     void                                                        \
3692     ofputil_init_##ENUM(struct STRUCT *s)                       \
3693     {                                                           \
3694         memset(s, 0, sizeof *s);                                \
3695         s->type = htons(ENUM);                                  \
3696         s->len = htons(sizeof *s);                              \
3697     }                                                           \
3698                                                                 \
3699     struct STRUCT *                                             \
3700     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3701     {                                                           \
3702         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3703         ofputil_init_##ENUM(s);                                 \
3704         return s;                                               \
3705     }
3706 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3707     void                                                        \
3708     ofputil_init_##ENUM(struct STRUCT *s)                       \
3709     {                                                           \
3710         memset(s, 0, sizeof *s);                                \
3711         s->type = htons(OFPAT10_VENDOR);                        \
3712         s->len = htons(sizeof *s);                              \
3713         s->vendor = htonl(NX_VENDOR_ID);                        \
3714         s->subtype = htons(ENUM);                               \
3715     }                                                           \
3716                                                                 \
3717     struct STRUCT *                                             \
3718     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3719     {                                                           \
3720         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3721         ofputil_init_##ENUM(s);                                 \
3722         return s;                                               \
3723     }
3724 #include "ofp-util.def"
3725
3726 /* Returns true if 'action' outputs to 'port', false otherwise. */
3727 bool
3728 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
3729 {
3730     switch (ntohs(action->type)) {
3731     case OFPAT10_OUTPUT:
3732         return action->output.port == port;
3733     case OFPAT10_ENQUEUE:
3734         return ((const struct ofp_action_enqueue *) action)->port == port;
3735     default:
3736         return false;
3737     }
3738 }
3739
3740 /* "Normalizes" the wildcards in 'rule'.  That means:
3741  *
3742  *    1. If the type of level N is known, then only the valid fields for that
3743  *       level may be specified.  For example, ARP does not have a TOS field,
3744  *       so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3745  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3746  *       ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3747  *       IPv4 flow.
3748  *
3749  *    2. If the type of level N is not known (or not understood by Open
3750  *       vSwitch), then no fields at all for that level may be specified.  For
3751  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3752  *       L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3753  *       SCTP flow.
3754  */
3755 void
3756 ofputil_normalize_rule(struct cls_rule *rule)
3757 {
3758     enum {
3759         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
3760         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
3761         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
3762         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
3763         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
3764         MAY_ARP_THA     = 1 << 5, /* arp_tha */
3765         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3766         MAY_ND_TARGET   = 1 << 7  /* nd_target */
3767     } may_match;
3768
3769     struct flow_wildcards wc;
3770
3771     /* Figure out what fields may be matched. */
3772     if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3773         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3774         if (rule->flow.nw_proto == IPPROTO_TCP ||
3775             rule->flow.nw_proto == IPPROTO_UDP ||
3776             rule->flow.nw_proto == IPPROTO_ICMP) {
3777             may_match |= MAY_TP_ADDR;
3778         }
3779     } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3780         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3781         if (rule->flow.nw_proto == IPPROTO_TCP ||
3782             rule->flow.nw_proto == IPPROTO_UDP) {
3783             may_match |= MAY_TP_ADDR;
3784         } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3785             may_match |= MAY_TP_ADDR;
3786             if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3787                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3788             } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3789                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3790             }
3791         }
3792     } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3793         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3794     } else {
3795         may_match = 0;
3796     }
3797
3798     /* Clear the fields that may not be matched. */
3799     wc = rule->wc;
3800     if (!(may_match & MAY_NW_ADDR)) {
3801         wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3802     }
3803     if (!(may_match & MAY_TP_ADDR)) {
3804         wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3805     }
3806     if (!(may_match & MAY_NW_PROTO)) {
3807         wc.wildcards |= FWW_NW_PROTO;
3808     }
3809     if (!(may_match & MAY_IPVx)) {
3810         wc.wildcards |= FWW_NW_DSCP;
3811         wc.wildcards |= FWW_NW_ECN;
3812         wc.wildcards |= FWW_NW_TTL;
3813     }
3814     if (!(may_match & MAY_ARP_SHA)) {
3815         wc.wildcards |= FWW_ARP_SHA;
3816     }
3817     if (!(may_match & MAY_ARP_THA)) {
3818         wc.wildcards |= FWW_ARP_THA;
3819     }
3820     if (!(may_match & MAY_IPV6)) {
3821         wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3822         wc.wildcards |= FWW_IPV6_LABEL;
3823     }
3824     if (!(may_match & MAY_ND_TARGET)) {
3825         wc.nd_target_mask = in6addr_any;
3826     }
3827
3828     /* Log any changes. */
3829     if (!flow_wildcards_equal(&wc, &rule->wc)) {
3830         bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
3831         char *pre = log ? cls_rule_to_string(rule) : NULL;
3832
3833         rule->wc = wc;
3834         cls_rule_zero_wildcarded_fields(rule);
3835
3836         if (log) {
3837             char *post = cls_rule_to_string(rule);
3838             VLOG_INFO("normalization changed ofp_match, details:");
3839             VLOG_INFO(" pre: %s", pre);
3840             VLOG_INFO("post: %s", post);
3841             free(pre);
3842             free(post);
3843         }
3844     }
3845 }
3846
3847 /* Attempts to pull 'actions_len' bytes from the front of 'b'.  Returns 0 if
3848  * successful, otherwise an OpenFlow error.
3849  *
3850  * If successful, the first action is stored in '*actionsp' and the number of
3851  * "union ofp_action" size elements into '*n_actionsp'.  Otherwise NULL and 0
3852  * are stored, respectively.
3853  *
3854  * This function does not check that the actions are valid (the caller should
3855  * do so, with validate_actions()).  The caller is also responsible for making
3856  * sure that 'b->data' is initially aligned appropriately for "union
3857  * ofp_action". */
3858 enum ofperr
3859 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
3860                      union ofp_action **actionsp, size_t *n_actionsp)
3861 {
3862     if (actions_len % OFP_ACTION_ALIGN != 0) {
3863         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3864                      "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
3865         goto error;
3866     }
3867
3868     *actionsp = ofpbuf_try_pull(b, actions_len);
3869     if (*actionsp == NULL) {
3870         VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3871                      "exceeds remaining message length (%zu)",
3872                      actions_len, b->size);
3873         goto error;
3874     }
3875
3876     *n_actionsp = actions_len / OFP_ACTION_ALIGN;
3877     return 0;
3878
3879 error:
3880     *actionsp = NULL;
3881     *n_actionsp = 0;
3882     return OFPERR_OFPBRC_BAD_LEN;
3883 }
3884
3885 bool
3886 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
3887                       const union ofp_action *b, size_t n_b)
3888 {
3889     return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
3890 }
3891
3892 union ofp_action *
3893 ofputil_actions_clone(const union ofp_action *actions, size_t n)
3894 {
3895     return n ? xmemdup(actions, n * sizeof *actions) : NULL;
3896 }
3897
3898 /* Parses a key or a key-value pair from '*stringp'.
3899  *
3900  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
3901  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
3902  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
3903  * are substrings of '*stringp' created by replacing some of its bytes by null
3904  * terminators.  Returns true.
3905  *
3906  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3907  * NULL and returns false. */
3908 bool
3909 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3910 {
3911     char *pos, *key, *value;
3912     size_t key_len;
3913
3914     pos = *stringp;
3915     pos += strspn(pos, ", \t\r\n");
3916     if (*pos == '\0') {
3917         *keyp = *valuep = NULL;
3918         return false;
3919     }
3920
3921     key = pos;
3922     key_len = strcspn(pos, ":=(, \t\r\n");
3923     if (key[key_len] == ':' || key[key_len] == '=') {
3924         /* The value can be separated by a colon. */
3925         size_t value_len;
3926
3927         value = key + key_len + 1;
3928         value_len = strcspn(value, ", \t\r\n");
3929         pos = value + value_len + (value[value_len] != '\0');
3930         value[value_len] = '\0';
3931     } else if (key[key_len] == '(') {
3932         /* The value can be surrounded by balanced parentheses.  The outermost
3933          * set of parentheses is removed. */
3934         int level = 1;
3935         size_t value_len;
3936
3937         value = key + key_len + 1;
3938         for (value_len = 0; level > 0; value_len++) {
3939             switch (value[value_len]) {
3940             case '\0':
3941                 level = 0;
3942                 break;
3943
3944             case '(':
3945                 level++;
3946                 break;
3947
3948             case ')':
3949                 level--;
3950                 break;
3951             }
3952         }
3953         value[value_len - 1] = '\0';
3954         pos = value + value_len;
3955     } else {
3956         /* There might be no value at all. */
3957         value = key + key_len;  /* Will become the empty string below. */
3958         pos = key + key_len + (key[key_len] != '\0');
3959     }
3960     key[key_len] = '\0';
3961
3962     *stringp = pos;
3963     *keyp = key;
3964     *valuep = value;
3965     return true;
3966 }