lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19 #include <inttypes.h>
  20 #include <stdlib.h>
  21 #include "byte-order.h"
  22 #include "classifier.h"
  23 #include "nx-match.h"
  24 #include "ofp-util.h"
  25 #include "ofpbuf.h"
  26 #include "packets.h"
  27 #include "random.h"
  28 #include "type-props.h"
  29 #include "vlog.h"
  30
  31 VLOG_DEFINE_THIS_MODULE(ofp_util);
  32
  33 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  34  * in the peer and so there's not much point in showing a lot of them. */
  35 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  36
  37 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
  38  * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
  39  * is wildcarded.
  40  *
  41  * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
  42  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
  43  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
  44  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
  45  * wildcarded. */
  46 ovs_be32
  47 ofputil_wcbits_to_netmask(int wcbits)
  48 {
  49     wcbits &= 0x3f;
  50     return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
  51 }
  52
  53 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
  54  * that it wildcards.  'netmask' must be a CIDR netmask (see ip_is_cidr()). */
  55 int
  56 ofputil_netmask_to_wcbits(ovs_be32 netmask)
  57 {
  58     assert(ip_is_cidr(netmask));
  59 #if __GNUC__ >= 4
  60     return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask));
  61 #else
  62     int wcbits;
  63
  64     for (wcbits = 32; netmask; wcbits--) {
  65         netmask &= netmask - 1;
  66     }
  67
  68     return wcbits;
  69 #endif
  70 }
  71
  72 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
  73  * name. */
  74 #define WC_INVARIANT_LIST \
  75     WC_INVARIANT_BIT(IN_PORT) \
  76     WC_INVARIANT_BIT(DL_SRC) \
  77     WC_INVARIANT_BIT(DL_DST) \
  78     WC_INVARIANT_BIT(DL_TYPE) \
  79     WC_INVARIANT_BIT(NW_PROTO) \
  80     WC_INVARIANT_BIT(TP_SRC) \
  81     WC_INVARIANT_BIT(TP_DST)
  82
  83 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
  84  * actually have the same names and values. */
  85 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
  86     WC_INVARIANT_LIST
  87 #undef WC_INVARIANT_BIT
  88
  89 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
  90  * OR'd together. */
  91 enum {
  92     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 ofp_match in 'match' into a cls_rule in 'rule', with the given
  99  * 'priority'.
 100  *
 101  * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE.  In
 102  * the latter case only, 'flow''s tun_id field will be taken from the high bits
 103  * of 'cookie', if 'match''s wildcards do not indicate that tun_id is
 104  * wildcarded. */
 105 void
 106 ofputil_cls_rule_from_match(const struct ofp_match *match,
 107                             unsigned int priority,
 108                             enum nx_flow_format flow_format,
 109                             ovs_be64 cookie, struct cls_rule *rule)
 110 {
 111     struct flow_wildcards *wc = &rule->wc;
 112     unsigned int ofpfw;
 113     ovs_be16 vid, pcp;
 114
 115     /* Initialize rule->priority. */
 116     ofpfw = ntohl(match->wildcards);
 117     ofpfw &= flow_format == NXFF_TUN_ID_FROM_COOKIE ? OVSFW_ALL : OFPFW_ALL;
 118     rule->priority = !ofpfw ? UINT16_MAX : priority;
 119
 120     /* Initialize most of rule->wc. */
 121     flow_wildcards_init_catchall(wc);
 122     wc->wildcards = ofpfw & WC_INVARIANTS;
 123     if (ofpfw & OFPFW_NW_TOS) {
 124         wc->wildcards |= FWW_NW_TOS;
 125     }
 126     wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
 127     wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
 128
 129     if (flow_format == NXFF_TUN_ID_FROM_COOKIE && !(ofpfw & NXFW_TUN_ID)) {
 130         rule->flow.tun_id = htonll(ntohll(cookie) >> 32);
 131     } else {
 132         wc->wildcards |= FWW_TUN_ID;
 133         rule->flow.tun_id = htonll(0);
 134     }
 135
 136     if (ofpfw & OFPFW_DL_DST) {
 137         /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
 138          * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
 139          * and FWW_ETH_MCAST. */
 140         wc->wildcards |= FWW_ETH_MCAST;
 141     }
 142
 143     /* Initialize most of rule->flow. */
 144     rule->flow.nw_src = match->nw_src;
 145     rule->flow.nw_dst = match->nw_dst;
 146     rule->flow.in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
 147                      : ntohs(match->in_port));
 148     rule->flow.dl_type = match->dl_type;
 149     rule->flow.tp_src = match->tp_src;
 150     rule->flow.tp_dst = match->tp_dst;
 151     memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
 152     memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
 153     rule->flow.nw_tos = match->nw_tos;
 154     rule->flow.nw_proto = match->nw_proto;
 155
 156     /* Translate VLANs. */
 157     vid = match->dl_vlan & htons(VLAN_VID_MASK);
 158     pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
 159     switch (ofpfw & (OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP)) {
 160     case OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP:
 161         /* Wildcard everything. */
 162         rule->flow.vlan_tci = htons(0);
 163         rule->wc.vlan_tci_mask = htons(0);
 164         break;
 165
 166     case OFPFW_DL_VLAN_PCP:
 167         if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
 168             /* Match only packets without 802.1Q header. */
 169             rule->flow.vlan_tci = htons(0);
 170             rule->wc.vlan_tci_mask = htons(0xffff);
 171         } else {
 172             /* Wildcard PCP, specific VID. */
 173             rule->flow.vlan_tci = vid | htons(VLAN_CFI);
 174             rule->wc.vlan_tci_mask = htons(VLAN_VID_MASK | VLAN_CFI);
 175         }
 176         break;
 177
 178     case OFPFW_DL_VLAN:
 179         /* Wildcard VID, specific PCP. */
 180         rule->flow.vlan_tci = pcp | htons(VLAN_CFI);
 181         rule->wc.vlan_tci_mask = htons(VLAN_PCP_MASK | VLAN_CFI);
 182         break;
 183
 184     case 0:
 185         if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
 186             /* This case is odd, since we can't have a specific PCP without an
 187              * 802.1Q header.  However, older versions of OVS treated this as
 188              * matching packets withut an 802.1Q header, so we do here too. */
 189             rule->flow.vlan_tci = htons(0);
 190             rule->wc.vlan_tci_mask = htons(0xffff);
 191         } else {
 192             /* Specific VID and PCP. */
 193             rule->flow.vlan_tci = vid | pcp | htons(VLAN_CFI);
 194             rule->wc.vlan_tci_mask = htons(0xffff);
 195         }
 196         break;
 197     }
 198
 199     /* Clean up. */
 200     cls_rule_zero_wildcarded_fields(rule);
 201 }
 202
 203 /* Convert 'rule' into the OpenFlow match structure 'match'.  'flow_format'
 204  * must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE.
 205  *
 206  * The NXFF_TUN_ID_FROM_COOKIE flow format requires modifying the flow cookie.
 207  * This function can help with that, if 'cookie_out' is nonnull.  For
 208  * NXFF_OPENFLOW10, or if the tunnel ID is wildcarded, 'cookie_in' will be
 209  * copied directly to '*cookie_out'.  For NXFF_TUN_ID_FROM_COOKIE when tunnel
 210  * ID is matched, 'cookie_in' will be modified appropriately before setting
 211  * '*cookie_out'.
 212  */
 213 void
 214 ofputil_cls_rule_to_match(const struct cls_rule *rule,
 215                           enum nx_flow_format flow_format,
 216                           struct ofp_match *match,
 217                           ovs_be64 cookie_in, ovs_be64 *cookie_out)
 218 {
 219     const struct flow_wildcards *wc = &rule->wc;
 220     unsigned int ofpfw;
 221
 222     /* Figure out most OpenFlow wildcards. */
 223     ofpfw = wc->wildcards & WC_INVARIANTS;
 224     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
 225     ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
 226     if (wc->wildcards & FWW_NW_TOS) {
 227         ofpfw |= OFPFW_NW_TOS;
 228     }
 229
 230     /* Tunnel ID. */
 231     if (flow_format == NXFF_TUN_ID_FROM_COOKIE) {
 232         if (wc->wildcards & FWW_TUN_ID) {
 233             ofpfw |= NXFW_TUN_ID;
 234         } else {
 235             uint32_t cookie_lo = ntohll(cookie_in);
 236             uint32_t cookie_hi = ntohll(rule->flow.tun_id);
 237             cookie_in = htonll(cookie_lo | ((uint64_t) cookie_hi << 32));
 238         }
 239     }
 240     if (cookie_out) {
 241         *cookie_out = cookie_in;
 242     }
 243
 244     /* Translate VLANs. */
 245     match->dl_vlan = htons(0);
 246     match->dl_vlan_pcp = 0;
 247     if (rule->wc.vlan_tci_mask == htons(0)) {
 248         ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
 249     } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
 250                && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
 251         match->dl_vlan = htons(OFP_VLAN_NONE);
 252     } else {
 253         if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
 254             ofpfw |= OFPFW_DL_VLAN;
 255         } else {
 256             match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
 257         }
 258
 259         if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
 260             ofpfw |= OFPFW_DL_VLAN_PCP;
 261         } else {
 262             match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
 263         }
 264     }
 265
 266     /* Compose most of the match structure. */
 267     match->wildcards = htonl(ofpfw);
 268     match->in_port = htons(rule->flow.in_port == ODPP_LOCAL ? OFPP_LOCAL
 269                            : rule->flow.in_port);
 270     memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
 271     memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
 272     match->dl_type = rule->flow.dl_type;
 273     match->nw_src = rule->flow.nw_src;
 274     match->nw_dst = rule->flow.nw_dst;
 275     match->nw_tos = rule->flow.nw_tos;
 276     match->nw_proto = rule->flow.nw_proto;
 277     match->tp_src = rule->flow.tp_src;
 278     match->tp_dst = rule->flow.tp_dst;
 279     memset(match->pad1, '\0', sizeof match->pad1);
 280     memset(match->pad2, '\0', sizeof match->pad2);
 281 }
 282
 283 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
 284 static ovs_be32
 285 alloc_xid(void)
 286 {
 287     static uint32_t next_xid = 1;
 288     return htonl(next_xid++);
 289 }
 290 \f
 291 /* Basic parsing of OpenFlow messages. */
 292
 293 struct ofputil_msg_type {
 294     enum ofputil_msg_code code; /* OFPUTIL_*. */
 295     uint32_t value;             /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
 296     const char *name;           /* e.g. "OFPT_FLOW_REMOVED". */
 297     unsigned int min_size;      /* Minimum total message size in bytes. */
 298     /* 0 if 'min_size' is the exact size that the message must be.  Otherwise,
 299      * the message may exceed 'min_size' by an even multiple of this value. */
 300     unsigned int extra_multiple;
 301 };
 302
 303 struct ofputil_msg_category {
 304     const char *name;           /* e.g. "OpenFlow message" */
 305     const struct ofputil_msg_type *types;
 306     size_t n_types;
 307     int missing_error;          /* ofp_mkerr() value for missing type. */
 308 };
 309
 310 static bool
 311 ofputil_length_ok(const struct ofputil_msg_category *cat,
 312                   const struct ofputil_msg_type *type,
 313                   unsigned int size)
 314 {
 315     switch (type->extra_multiple) {
 316     case 0:
 317         if (size != type->min_size) {
 318             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
 319                          "length %u (expected length %u)",
 320                          cat->name, type->name, size, type->min_size);
 321             return false;
 322         }
 323         return true;
 324
 325     case 1:
 326         if (size < type->min_size) {
 327             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
 328                          "length %u (expected length at least %u bytes)",
 329                          cat->name, type->name, size, type->min_size);
 330             return false;
 331         }
 332         return true;
 333
 334     default:
 335         if (size < type->min_size
 336             || (size - type->min_size) % type->extra_multiple) {
 337             VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
 338                          "length %u (must be exactly %u bytes or longer "
 339                          "by an integer multiple of %u bytes)",
 340                          cat->name, type->name, size,
 341                          type->min_size, type->extra_multiple);
 342             return false;
 343         }
 344         return true;
 345     }
 346 }
 347
 348 static int
 349 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
 350                                 uint32_t value, unsigned int size,
 351                                 const struct ofputil_msg_type **typep)
 352 {
 353     const struct ofputil_msg_type *type;
 354
 355     for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
 356         if (type->value == value) {
 357             if (!ofputil_length_ok(cat, type, size)) {
 358                 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 359             }
 360             *typep = type;
 361             return 0;
 362         }
 363     }
 364
 365     VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %u",
 366                  cat->name, value);
 367     return cat->missing_error;
 368 }
 369
 370 static int
 371 ofputil_decode_vendor(const struct ofp_header *oh,
 372                       const struct ofputil_msg_type **typep)
 373 {
 374     static const struct ofputil_msg_type nxt_messages[] = {
 375         { OFPUTIL_NXT_STATUS_REQUEST,
 376           NXT_STATUS_REQUEST, "NXT_STATUS_REQUEST",
 377           sizeof(struct nicira_header), 1 },
 378
 379         { OFPUTIL_NXT_STATUS_REPLY,
 380           NXT_STATUS_REPLY, "NXT_STATUS_REPLY",
 381           sizeof(struct nicira_header), 1 },
 382
 383         { OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
 384           NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE",
 385           sizeof(struct nxt_tun_id_cookie), 0 },
 386
 387         { OFPUTIL_NXT_ROLE_REQUEST,
 388           NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
 389           sizeof(struct nx_role_request), 0 },
 390
 391         { OFPUTIL_NXT_ROLE_REPLY,
 392           NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
 393           sizeof(struct nx_role_request), 0 },
 394
 395         { OFPUTIL_NXT_SET_FLOW_FORMAT,
 396           NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
 397           sizeof(struct nxt_set_flow_format), 0 },
 398
 399         { OFPUTIL_NXT_FLOW_MOD,
 400           NXT_FLOW_MOD, "NXT_FLOW_MOD",
 401           sizeof(struct nx_flow_mod), 8 },
 402
 403         { OFPUTIL_NXT_FLOW_REMOVED,
 404           NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
 405           sizeof(struct nx_flow_removed), 8 },
 406     };
 407
 408     static const struct ofputil_msg_category nxt_category = {
 409         "Nicira extension message",
 410         nxt_messages, ARRAY_SIZE(nxt_messages),
 411         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 412     };
 413
 414     const struct ofp_vendor_header *ovh;
 415     const struct nicira_header *nh;
 416
 417     ovh = (const struct ofp_vendor_header *) oh;
 418     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
 419         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
 420                      "vendor %"PRIx32, ntohl(ovh->vendor));
 421         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
 422     }
 423
 424     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
 425         VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
 426                      "length %u (expected at least %zu)",
 427                      ntohs(ovh->header.length), sizeof(struct nicira_header));
 428         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 429     }
 430
 431     nh = (const struct nicira_header *) oh;
 432     return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
 433                                            ntohs(oh->length), typep);
 434 }
 435
 436 static int
 437 check_nxstats_msg(const struct ofp_header *oh)
 438 {
 439     const struct ofp_stats_request *osr;
 440     ovs_be32 vendor;
 441
 442     osr = (const struct ofp_stats_request *) oh;
 443
 444     memcpy(&vendor, osr->body, sizeof vendor);
 445     if (vendor != htonl(NX_VENDOR_ID)) {
 446         VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
 447                      "unknown vendor %"PRIx32, ntohl(vendor));
 448         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
 449     }
 450
 451     if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) {
 452         VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
 453         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
 454     }
 455
 456     return 0;
 457 }
 458
 459 static int
 460 ofputil_decode_nxst_request(const struct ofp_header *oh,
 461                             const struct ofputil_msg_type **typep)
 462 {
 463     static const struct ofputil_msg_type nxst_requests[] = {
 464         { OFPUTIL_NXST_FLOW_REQUEST,
 465           NXST_FLOW, "NXST_FLOW request",
 466           sizeof(struct nx_flow_stats_request), 8 },
 467
 468         { OFPUTIL_NXST_AGGREGATE_REQUEST,
 469           NXST_AGGREGATE, "NXST_AGGREGATE request",
 470           sizeof(struct nx_aggregate_stats_request), 8 },
 471     };
 472
 473     static const struct ofputil_msg_category nxst_request_category = {
 474         "Nicira extension statistics",
 475         nxst_requests, ARRAY_SIZE(nxst_requests),
 476         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 477     };
 478
 479     const struct nicira_stats_msg *nsm;
 480     int error;
 481
 482     error = check_nxstats_msg(oh);
 483     if (error) {
 484         return error;
 485     }
 486
 487     nsm = (struct nicira_stats_msg *) oh;
 488     return ofputil_lookup_openflow_message(&nxst_request_category,
 489                                            ntohl(nsm->subtype),
 490                                            ntohs(oh->length), typep);
 491 }
 492
 493 static int
 494 ofputil_decode_nxst_reply(const struct ofp_header *oh,
 495                           const struct ofputil_msg_type **typep)
 496 {
 497     static const struct ofputil_msg_type nxst_replies[] = {
 498         { OFPUTIL_NXST_FLOW_REPLY,
 499           NXST_FLOW, "NXST_FLOW reply",
 500           sizeof(struct nicira_stats_msg), 8 },
 501
 502         { OFPUTIL_NXST_AGGREGATE_REPLY,
 503           NXST_AGGREGATE, "NXST_AGGREGATE reply",
 504           sizeof(struct nx_aggregate_stats_reply), 0 },
 505     };
 506
 507     static const struct ofputil_msg_category nxst_reply_category = {
 508         "Nicira extension statistics",
 509         nxst_replies, ARRAY_SIZE(nxst_replies),
 510         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
 511     };
 512
 513     const struct nicira_stats_msg *nsm;
 514     int error;
 515
 516     error = check_nxstats_msg(oh);
 517     if (error) {
 518         return error;
 519     }
 520
 521     nsm = (struct nicira_stats_msg *) oh;
 522     return ofputil_lookup_openflow_message(&nxst_reply_category,
 523                                            ntohl(nsm->subtype),
 524                                            ntohs(oh->length), typep);
 525 }
 526
 527 static int
 528 ofputil_decode_ofpst_request(const struct ofp_header *oh,
 529                              const struct ofputil_msg_type **typep)
 530 {
 531     enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
 532     static const struct ofputil_msg_type ofpst_requests[] = {
 533         { OFPUTIL_OFPST_DESC_REQUEST,
 534           OFPST_DESC, "OFPST_DESC request",
 535           OSR_SIZE, 0 },
 536
 537         { OFPUTIL_OFPST_FLOW_REQUEST,
 538           OFPST_FLOW, "OFPST_FLOW request",
 539           OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
 540
 541         { OFPUTIL_OFPST_AGGREGATE_REQUEST,
 542           OFPST_AGGREGATE, "OFPST_AGGREGATE request",
 543           OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
 544
 545         { OFPUTIL_OFPST_TABLE_REQUEST,
 546           OFPST_TABLE, "OFPST_TABLE request",
 547           OSR_SIZE, 0 },
 548
 549         { OFPUTIL_OFPST_PORT_REQUEST,
 550           OFPST_PORT, "OFPST_PORT request",
 551           OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
 552
 553         { OFPUTIL_OFPST_QUEUE_REQUEST,
 554           OFPST_QUEUE, "OFPST_QUEUE request",
 555           OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
 556
 557         { 0,
 558           OFPST_VENDOR, "OFPST_VENDOR request",
 559           OSR_SIZE + sizeof(uint32_t), 1 },
 560     };
 561
 562     static const struct ofputil_msg_category ofpst_request_category = {
 563         "OpenFlow statistics",
 564         ofpst_requests, ARRAY_SIZE(ofpst_requests),
 565         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
 566     };
 567
 568     const struct ofp_stats_request *osr;
 569     int error;
 570
 571     osr = (const struct ofp_stats_request *) oh;
 572     error = ofputil_lookup_openflow_message(&ofpst_request_category,
 573                                             ntohs(osr->type),
 574                                             ntohs(oh->length), typep);
 575     if (!error && osr->type == htons(OFPST_VENDOR)) {
 576         error = ofputil_decode_nxst_request(oh, typep);
 577     }
 578     return error;
 579 }
 580
 581 static int
 582 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
 583                            const struct ofputil_msg_type **typep)
 584 {
 585     enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
 586     static const struct ofputil_msg_type ofpst_replies[] = {
 587         { OFPUTIL_OFPST_DESC_REPLY,
 588           OFPST_DESC, "OFPST_DESC reply",
 589           OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
 590
 591         { OFPUTIL_OFPST_FLOW_REPLY,
 592           OFPST_FLOW, "OFPST_FLOW reply",
 593           OSR_SIZE, 1 },
 594
 595         { OFPUTIL_OFPST_AGGREGATE_REPLY,
 596           OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
 597           OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
 598
 599         { OFPUTIL_OFPST_TABLE_REPLY,
 600           OFPST_TABLE, "OFPST_TABLE reply",
 601           OSR_SIZE, sizeof(struct ofp_table_stats) },
 602
 603         { OFPUTIL_OFPST_PORT_REPLY,
 604           OFPST_PORT, "OFPST_PORT reply",
 605           OSR_SIZE, sizeof(struct ofp_port_stats) },
 606
 607         { OFPUTIL_OFPST_QUEUE_REPLY,
 608           OFPST_QUEUE, "OFPST_QUEUE reply",
 609           OSR_SIZE, sizeof(struct ofp_queue_stats) },
 610
 611         { 0,
 612           OFPST_VENDOR, "OFPST_VENDOR reply",
 613           OSR_SIZE + sizeof(uint32_t), 1 },
 614     };
 615
 616     static const struct ofputil_msg_category ofpst_reply_category = {
 617         "OpenFlow statistics",
 618         ofpst_replies, ARRAY_SIZE(ofpst_replies),
 619         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
 620     };
 621
 622     const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh;
 623     int error;
 624
 625     error = ofputil_lookup_openflow_message(&ofpst_reply_category,
 626                                            ntohs(osr->type),
 627                                            ntohs(oh->length), typep);
 628     if (!error && osr->type == htons(OFPST_VENDOR)) {
 629         error = ofputil_decode_nxst_reply(oh, typep);
 630     }
 631     return error;
 632 }
 633
 634 /* Decodes the message type represented by 'oh'.  Returns 0 if successful or
 635  * an OpenFlow error code constructed with ofp_mkerr() on failure.  Either
 636  * way, stores in '*typep' a type structure that can be inspected with the
 637  * ofputil_msg_type_*() functions.
 638  *
 639  * oh->length must indicate the correct length of the message (and must be at
 640  * least sizeof(struct ofp_header)).
 641  *
 642  * Success indicates that 'oh' is at least as long as the minimum-length
 643  * message of its type. */
 644 int
 645 ofputil_decode_msg_type(const struct ofp_header *oh,
 646                         const struct ofputil_msg_type **typep)
 647 {
 648     static const struct ofputil_msg_type ofpt_messages[] = {
 649         { OFPUTIL_OFPT_HELLO,
 650           OFPT_HELLO, "OFPT_HELLO",
 651           sizeof(struct ofp_hello), 1 },
 652
 653         { OFPUTIL_OFPT_ERROR,
 654           OFPT_ERROR, "OFPT_ERROR",
 655           sizeof(struct ofp_error_msg), 1 },
 656
 657         { OFPUTIL_OFPT_ECHO_REQUEST,
 658           OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
 659           sizeof(struct ofp_header), 1 },
 660
 661         { OFPUTIL_OFPT_ECHO_REPLY,
 662           OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
 663           sizeof(struct ofp_header), 1 },
 664
 665         { OFPUTIL_OFPT_FEATURES_REQUEST,
 666           OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
 667           sizeof(struct ofp_header), 0 },
 668
 669         { OFPUTIL_OFPT_FEATURES_REPLY,
 670           OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
 671           sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
 672
 673         { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
 674           OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
 675           sizeof(struct ofp_header), 0 },
 676
 677         { OFPUTIL_OFPT_GET_CONFIG_REPLY,
 678           OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
 679           sizeof(struct ofp_switch_config), 0 },
 680
 681         { OFPUTIL_OFPT_SET_CONFIG,
 682           OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
 683           sizeof(struct ofp_switch_config), 0 },
 684
 685         { OFPUTIL_OFPT_PACKET_IN,
 686           OFPT_PACKET_IN, "OFPT_PACKET_IN",
 687           offsetof(struct ofp_packet_in, data), 1 },
 688
 689         { OFPUTIL_OFPT_FLOW_REMOVED,
 690           OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
 691           sizeof(struct ofp_flow_removed), 0 },
 692
 693         { OFPUTIL_OFPT_PORT_STATUS,
 694           OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
 695           sizeof(struct ofp_port_status), 0 },
 696
 697         { OFPUTIL_OFPT_PACKET_OUT,
 698           OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
 699           sizeof(struct ofp_packet_out), 1 },
 700
 701         { OFPUTIL_OFPT_FLOW_MOD,
 702           OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
 703           sizeof(struct ofp_flow_mod), 1 },
 704
 705         { OFPUTIL_OFPT_PORT_MOD,
 706           OFPT_PORT_MOD, "OFPT_PORT_MOD",
 707           sizeof(struct ofp_port_mod), 0 },
 708
 709         { 0,
 710           OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
 711           sizeof(struct ofp_stats_request), 1 },
 712
 713         { 0,
 714           OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
 715           sizeof(struct ofp_stats_reply), 1 },
 716
 717         { OFPUTIL_OFPT_BARRIER_REQUEST,
 718           OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
 719           sizeof(struct ofp_header), 0 },
 720
 721         { OFPUTIL_OFPT_BARRIER_REPLY,
 722           OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
 723           sizeof(struct ofp_header), 0 },
 724
 725         { 0,
 726           OFPT_VENDOR, "OFPT_VENDOR",
 727           sizeof(struct ofp_vendor_header), 1 },
 728     };
 729
 730     static const struct ofputil_msg_category ofpt_category = {
 731         "OpenFlow message",
 732         ofpt_messages, ARRAY_SIZE(ofpt_messages),
 733         OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
 734     };
 735
 736     int error;
 737
 738     error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
 739                                             ntohs(oh->length), typep);
 740     if (!error) {
 741         switch (oh->type) {
 742         case OFPT_VENDOR:
 743             error = ofputil_decode_vendor(oh, typep);
 744             break;
 745
 746         case OFPT_STATS_REQUEST:
 747             error = ofputil_decode_ofpst_request(oh, typep);
 748             break;
 749
 750         case OFPT_STATS_REPLY:
 751             error = ofputil_decode_ofpst_reply(oh, typep);
 752
 753         default:
 754             break;
 755         }
 756     }
 757     if (error) {
 758         static const struct ofputil_msg_type ofputil_invalid_type = {
 759             OFPUTIL_INVALID,
 760             0, "OFPUTIL_INVALID",
 761             0, 0
 762         };
 763
 764         *typep = &ofputil_invalid_type;
 765     }
 766     return error;
 767 }
 768
 769 /* Returns an OFPUTIL_* message type code for 'type'. */
 770 enum ofputil_msg_code
 771 ofputil_msg_type_code(const struct ofputil_msg_type *type)
 772 {
 773     return type->code;
 774 }
 775 \f
 776 /* Flow formats. */
 777
 778 bool
 779 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
 780 {
 781     switch (flow_format) {
 782     case NXFF_OPENFLOW10:
 783     case NXFF_TUN_ID_FROM_COOKIE:
 784     case NXFF_NXM:
 785         return true;
 786     }
 787
 788     return false;
 789 }
 790
 791 const char *
 792 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
 793 {
 794     switch (flow_format) {
 795     case NXFF_OPENFLOW10:
 796         return "openflow10";
 797     case NXFF_TUN_ID_FROM_COOKIE:
 798         return "tun_id_from_cookie";
 799     case NXFF_NXM:
 800         return "nxm";
 801     default:
 802         NOT_REACHED();
 803     }
 804 }
 805
 806 int
 807 ofputil_flow_format_from_string(const char *s)
 808 {
 809     return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
 810             : !strcmp(s, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE
 811             : !strcmp(s, "nxm") ? NXFF_NXM
 812             : -1);
 813 }
 814
 815 static bool
 816 regs_fully_wildcarded(const struct flow_wildcards *wc)
 817 {
 818     int i;
 819
 820     for (i = 0; i < FLOW_N_REGS; i++) {
 821         if (wc->reg_masks[i] != 0) {
 822             return false;
 823         }
 824     }
 825     return true;
 826 }
 827
 828 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
 829  * (e.g. to add or remove a flow).  'cookie_support' should be true if the
 830  * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for
 831  * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do
 832  * not, for example).  If 'cookie_support' is true, then 'cookie' should be the
 833  * cookie to be sent; otherwise its value is ignored.
 834  *
 835  * The "best" flow format is chosen on this basis:
 836  *
 837  *   - It must be capable of expressing the rule.  NXFF_OPENFLOW10 flows can't
 838  *     handle tunnel IDs.  NXFF_TUN_ID_FROM_COOKIE flows can't handle registers
 839  *     or fixing the Ethernet multicast bit, and can't handle tunnel IDs that
 840  *     conflict with the high 32 bits of the cookie or commands that don't
 841  *     support cookies.
 842  *
 843  *   - Otherwise, the chosen format should be as backward compatible as
 844  *     possible.  (NXFF_OPENFLOW10 is more backward compatible than
 845  *     NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than
 846  *     NXFF_NXM.)
 847  */
 848 enum nx_flow_format
 849 ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support,
 850                         ovs_be64 cookie)
 851 {
 852     const struct flow_wildcards *wc = &rule->wc;
 853     ovs_be32 cookie_hi = htonl(ntohll(cookie) >> 32);
 854
 855     if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)
 856         || !regs_fully_wildcarded(wc)
 857         || (!(wc->wildcards & FWW_TUN_ID)
 858             && (!cookie_support
 859                 || (cookie_hi && cookie_hi != ntohll(rule->flow.tun_id))))) {
 860         return NXFF_NXM;
 861     } else if (!(wc->wildcards & FWW_TUN_ID)) {
 862         return NXFF_TUN_ID_FROM_COOKIE;
 863     } else {
 864         return NXFF_OPENFLOW10;
 865     }
 866 }
 867
 868 /* Returns an OpenFlow message that can be used to set the flow format to
 869  * 'flow_format'.  */
 870 struct ofpbuf *
 871 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
 872 {
 873     struct ofpbuf *msg;
 874
 875     if (flow_format == NXFF_OPENFLOW10
 876         || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
 877         struct nxt_tun_id_cookie *tic;
 878
 879         tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg);
 880         tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE;
 881     } else {
 882         struct nxt_set_flow_format *sff;
 883
 884         sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
 885         sff->format = htonl(flow_format);
 886     }
 887
 888     return msg;
 889 }
 890
 891 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
 892  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
 893  * code.
 894  *
 895  * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format
 896  * at the time when the message was received.  Otherwise 'flow_format' is
 897  * ignored.
 898  *
 899  * Does not validate the flow_mod actions. */
 900 int
 901 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
 902                         enum nx_flow_format flow_format)
 903 {
 904     const struct ofputil_msg_type *type;
 905     struct ofpbuf b;
 906
 907     ofpbuf_use_const(&b, oh, ntohs(oh->length));
 908
 909     ofputil_decode_msg_type(oh, &type);
 910     if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
 911         /* Standard OpenFlow flow_mod. */
 912         struct ofp_match match, orig_match;
 913         const struct ofp_flow_mod *ofm;
 914         int error;
 915
 916         /* Dissect the message. */
 917         ofm = ofpbuf_pull(&b, sizeof *ofm);
 918         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
 919         if (error) {
 920             return error;
 921         }
 922
 923         /* Normalize ofm->match.  If normalization actually changes anything,
 924          * then log the differences. */
 925         match = ofm->match;
 926         match.pad1[0] = match.pad2[0] = 0;
 927         orig_match = match;
 928         normalize_match(&match);
 929         if (memcmp(&match, &orig_match, sizeof orig_match)) {
 930             if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) {
 931                 char *old = ofp_match_to_literal_string(&orig_match);
 932                 char *new = ofp_match_to_literal_string(&match);
 933                 VLOG_INFO("normalization changed ofp_match, details:");
 934                 VLOG_INFO(" pre: %s", old);
 935                 VLOG_INFO("post: %s", new);
 936                 free(old);
 937                 free(new);
 938             }
 939         }
 940
 941         /* Translate the message. */
 942         ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format,
 943                                     ofm->cookie, &fm->cr);
 944         fm->cookie = ofm->cookie;
 945         fm->command = ntohs(ofm->command);
 946         fm->idle_timeout = ntohs(ofm->idle_timeout);
 947         fm->hard_timeout = ntohs(ofm->hard_timeout);
 948         fm->buffer_id = ntohl(ofm->buffer_id);
 949         fm->out_port = ntohs(ofm->out_port);
 950         fm->flags = ntohs(ofm->flags);
 951     } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
 952         /* Nicira extended flow_mod. */
 953         const struct nx_flow_mod *nfm;
 954         int error;
 955
 956         /* Dissect the message. */
 957         nfm = ofpbuf_pull(&b, sizeof *nfm);
 958         error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
 959                               &fm->cr);
 960         if (error) {
 961             return error;
 962         }
 963         error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
 964         if (error) {
 965             return error;
 966         }
 967
 968         /* Translate the message. */
 969         fm->cookie = nfm->cookie;
 970         fm->command = ntohs(nfm->command);
 971         fm->idle_timeout = ntohs(nfm->idle_timeout);
 972         fm->hard_timeout = ntohs(nfm->hard_timeout);
 973         fm->buffer_id = ntohl(nfm->buffer_id);
 974         fm->out_port = ntohs(nfm->out_port);
 975         fm->flags = ntohs(nfm->flags);
 976     } else {
 977         NOT_REACHED();
 978     }
 979
 980     return 0;
 981 }
 982
 983 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
 984  * 'flow_format' and returns the message. */
 985 struct ofpbuf *
 986 ofputil_encode_flow_mod(const struct flow_mod *fm,
 987                         enum nx_flow_format flow_format)
 988 {
 989     size_t actions_len = fm->n_actions * sizeof *fm->actions;
 990     struct ofpbuf *msg;
 991
 992     if (flow_format == NXFF_OPENFLOW10
 993         || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
 994         struct ofp_flow_mod *ofm;
 995
 996         msg = ofpbuf_new(sizeof *ofm + actions_len);
 997         ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
 998         ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match,
 999                                   fm->cookie, &ofm->cookie);
1000         ofm->command = htons(fm->command);
1001         ofm->idle_timeout = htons(fm->idle_timeout);
1002         ofm->hard_timeout = htons(fm->hard_timeout);
1003         ofm->priority = htons(fm->cr.priority);
1004         ofm->buffer_id = htonl(fm->buffer_id);
1005         ofm->out_port = htons(fm->out_port);
1006         ofm->flags = htons(fm->flags);
1007     } else if (flow_format == NXFF_NXM) {
1008         struct nx_flow_mod *nfm;
1009         int match_len;
1010
1011         msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1012         put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1013         match_len = nx_put_match(msg, &fm->cr);
1014
1015         nfm = msg->data;
1016         nfm->cookie = fm->cookie;
1017         nfm->command = htons(fm->command);
1018         nfm->idle_timeout = htons(fm->idle_timeout);
1019         nfm->hard_timeout = htons(fm->hard_timeout);
1020         nfm->priority = htons(fm->cr.priority);
1021         nfm->buffer_id = htonl(fm->buffer_id);
1022         nfm->out_port = htons(fm->out_port);
1023         nfm->flags = htons(fm->flags);
1024         nfm->match_len = htons(match_len);
1025     } else {
1026         NOT_REACHED();
1027     }
1028
1029     ofpbuf_put(msg, fm->actions, actions_len);
1030     update_openflow_length(msg);
1031     return msg;
1032 }
1033
1034 static int
1035 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1036                                   const struct ofp_header *oh,
1037                                   enum nx_flow_format flow_format,
1038                                   bool aggregate)
1039 {
1040     const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
1041
1042     fsr->aggregate = aggregate;
1043     ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match);
1044     fsr->out_port = ntohs(ofsr->out_port);
1045     fsr->table_id = ofsr->table_id;
1046
1047     return 0;
1048 }
1049
1050 static int
1051 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1052                                  const struct ofp_header *oh,
1053                                  bool aggregate)
1054 {
1055     const struct nx_flow_stats_request *nfsr;
1056     struct ofpbuf b;
1057     int error;
1058
1059     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1060
1061     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1062     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1063     if (error) {
1064         return error;
1065     }
1066     if (b.size) {
1067         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1068     }
1069
1070     fsr->aggregate = aggregate;
1071     fsr->out_port = ntohs(nfsr->out_port);
1072     fsr->table_id = nfsr->table_id;
1073
1074     return 0;
1075 }
1076
1077 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1078  * message 'oh', received when the current flow format was 'flow_format', into
1079  * an abstract flow_stats_request in 'fsr'.  Returns 0 if successful, otherwise
1080  * an OpenFlow error code.
1081  *
1082  * For OFPST_FLOW and OFPST_AGGREGATE messages, 'flow_format' should be the
1083  * current flow format at the time when the message was received.  Otherwise
1084  * 'flow_format' is ignored. */
1085 int
1086 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1087                                   const struct ofp_header *oh,
1088                                   enum nx_flow_format flow_format)
1089 {
1090     const struct ofputil_msg_type *type;
1091     struct ofpbuf b;
1092     int code;
1093
1094     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1095
1096     ofputil_decode_msg_type(oh, &type);
1097     code = ofputil_msg_type_code(type);
1098     switch (code) {
1099     case OFPUTIL_OFPST_FLOW_REQUEST:
1100         return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false);
1101
1102     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1103         return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true);
1104
1105     case OFPUTIL_NXST_FLOW_REQUEST:
1106         return ofputil_decode_nxst_flow_request(fsr, oh, false);
1107
1108     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1109         return ofputil_decode_nxst_flow_request(fsr, oh, true);
1110
1111     default:
1112         /* Hey, the caller lied. */
1113         NOT_REACHED();
1114     }
1115 }
1116
1117 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1118  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE message 'oh' according to
1119  * 'flow_format', and returns the message. */
1120 struct ofpbuf *
1121 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1122                                   enum nx_flow_format flow_format)
1123 {
1124     struct ofpbuf *msg;
1125
1126     if (flow_format == NXFF_OPENFLOW10
1127         || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
1128         struct ofp_flow_stats_request *ofsr;
1129         int type;
1130
1131         BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
1132                           == sizeof(struct ofp_aggregate_stats_request));
1133
1134         type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1135         ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
1136         ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match,
1137                                   0, NULL);
1138         ofsr->table_id = fsr->table_id;
1139         ofsr->out_port = htons(fsr->out_port);
1140     } else if (flow_format == NXFF_NXM) {
1141         struct nx_flow_stats_request *nfsr;
1142         int match_len;
1143
1144         ofputil_make_nxstats_request(sizeof *nfsr, NXST_FLOW, &msg);
1145         match_len = nx_put_match(msg, &fsr->match);
1146
1147         nfsr = msg->data;
1148         nfsr->out_port = htons(fsr->out_port);
1149         nfsr->match_len = htons(match_len);
1150         nfsr->table_id = fsr->table_id;
1151     } else {
1152         NOT_REACHED();
1153     }
1154
1155     return msg;
1156 }
1157
1158 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh', received
1159  * when the current flow format was 'flow_format', into an abstract
1160  * ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise an
1161  * OpenFlow error code.
1162  *
1163  * For OFPT_FLOW_REMOVED messages, 'flow_format' should be the current flow
1164  * format at the time when the message was received.  Otherwise 'flow_format'
1165  * is ignored. */
1166 int
1167 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1168                             const struct ofp_header *oh,
1169                             enum nx_flow_format flow_format)
1170 {
1171     const struct ofputil_msg_type *type;
1172     enum ofputil_msg_code code;
1173
1174     ofputil_decode_msg_type(oh, &type);
1175     code = ofputil_msg_type_code(type);
1176     if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1177         const struct ofp_flow_removed *ofr;
1178
1179         ofr = (const struct ofp_flow_removed *) oh;
1180         ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1181                                     flow_format, ofr->cookie, &fr->rule);
1182         fr->cookie = ofr->cookie;
1183         fr->reason = ofr->reason;
1184         fr->duration_sec = ntohl(ofr->duration_sec);
1185         fr->duration_nsec = ntohl(ofr->duration_nsec);
1186         fr->idle_timeout = ntohs(ofr->idle_timeout);
1187         fr->packet_count = ntohll(ofr->packet_count);
1188         fr->byte_count = ntohll(ofr->byte_count);
1189     } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1190         struct nx_flow_removed *nfr;
1191         struct ofpbuf b;
1192         int error;
1193
1194         ofpbuf_use_const(&b, oh, ntohs(oh->length));
1195
1196         nfr = ofpbuf_pull(&b, sizeof *nfr);
1197         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1198                               &fr->rule);
1199         if (error) {
1200             return error;
1201         }
1202         if (b.size) {
1203             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1204         }
1205
1206         fr->cookie = nfr->cookie;
1207         fr->reason = nfr->reason;
1208         fr->duration_sec = ntohl(nfr->duration_sec);
1209         fr->duration_nsec = ntohl(nfr->duration_nsec);
1210         fr->idle_timeout = ntohs(nfr->idle_timeout);
1211         fr->packet_count = ntohll(nfr->packet_count);
1212         fr->byte_count = ntohll(nfr->byte_count);
1213     } else {
1214         NOT_REACHED();
1215     }
1216
1217     return 0;
1218 }
1219
1220 /* Returns a string representing the message type of 'type'.  The string is the
1221  * enumeration constant for the type, e.g. "OFPT_HELLO".  For statistics
1222  * messages, the constant is followed by "request" or "reply",
1223  * e.g. "OFPST_AGGREGATE reply". */
1224 const char *
1225 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1226 {
1227     return type->name;
1228 }
1229 \f
1230 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1231  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1232  * an arbitrary transaction id.  Allocated bytes beyond the header, if any, are
1233  * zeroed.
1234  *
1235  * The caller is responsible for freeing '*bufferp' when it is no longer
1236  * needed.
1237  *
1238  * The OpenFlow header length is initially set to 'openflow_len'; if the
1239  * message is later extended, the length should be updated with
1240  * update_openflow_length() before sending.
1241  *
1242  * Returns the header. */
1243 void *
1244 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1245 {
1246     *bufferp = ofpbuf_new(openflow_len);
1247     return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1248 }
1249
1250 /* Similar to make_openflow() but creates a Nicira vendor extension message
1251  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1252 void *
1253 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1254 {
1255     return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1256 }
1257
1258 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1259  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1260  * transaction id 'xid'.  Allocated bytes beyond the header, if any, are
1261  * zeroed.
1262  *
1263  * The caller is responsible for freeing '*bufferp' when it is no longer
1264  * needed.
1265  *
1266  * The OpenFlow header length is initially set to 'openflow_len'; if the
1267  * message is later extended, the length should be updated with
1268  * update_openflow_length() before sending.
1269  *
1270  * Returns the header. */
1271 void *
1272 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1273                   struct ofpbuf **bufferp)
1274 {
1275     *bufferp = ofpbuf_new(openflow_len);
1276     return put_openflow_xid(openflow_len, type, xid, *bufferp);
1277 }
1278
1279 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1280  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1281 void *
1282 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1283                struct ofpbuf **bufferp)
1284 {
1285     *bufferp = ofpbuf_new(openflow_len);
1286     return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1287 }
1288
1289 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1290  * with the given 'type' and an arbitrary transaction id.  Allocated bytes
1291  * beyond the header, if any, are zeroed.
1292  *
1293  * The OpenFlow header length is initially set to 'openflow_len'; if the
1294  * message is later extended, the length should be updated with
1295  * update_openflow_length() before sending.
1296  *
1297  * Returns the header. */
1298 void *
1299 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1300 {
1301     return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1302 }
1303
1304 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1305  * with the given 'type' and an transaction id 'xid'.  Allocated bytes beyond
1306  * the header, if any, are zeroed.
1307  *
1308  * The OpenFlow header length is initially set to 'openflow_len'; if the
1309  * message is later extended, the length should be updated with
1310  * update_openflow_length() before sending.
1311  *
1312  * Returns the header. */
1313 void *
1314 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1315                  struct ofpbuf *buffer)
1316 {
1317     struct ofp_header *oh;
1318
1319     assert(openflow_len >= sizeof *oh);
1320     assert(openflow_len <= UINT16_MAX);
1321
1322     oh = ofpbuf_put_uninit(buffer, openflow_len);
1323     oh->version = OFP_VERSION;
1324     oh->type = type;
1325     oh->length = htons(openflow_len);
1326     oh->xid = xid;
1327     memset(oh + 1, 0, openflow_len - sizeof *oh);
1328     return oh;
1329 }
1330
1331 /* Similar to put_openflow() but append a Nicira vendor extension message with
1332  * the specific 'subtype'.  'subtype' should be in host byte order. */
1333 void *
1334 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1335 {
1336     return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1337 }
1338
1339 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1340  * with the specific 'subtype'.  'subtype' should be in host byte order. */
1341 void *
1342 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1343               struct ofpbuf *buffer)
1344 {
1345     struct nicira_header *nxh;
1346
1347     nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1348     nxh->vendor = htonl(NX_VENDOR_ID);
1349     nxh->subtype = htonl(subtype);
1350     return nxh;
1351 }
1352
1353 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1354  * 'buffer->size'. */
1355 void
1356 update_openflow_length(struct ofpbuf *buffer)
1357 {
1358     struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1359     oh->length = htons(buffer->size);
1360 }
1361
1362 /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
1363  * space allocated for the 'body' member.  Returns the first byte of the 'body'
1364  * member. */
1365 void *
1366 ofputil_make_stats_request(size_t body_len, uint16_t type,
1367                            struct ofpbuf **bufferp)
1368 {
1369     struct ofp_stats_request *osr;
1370     osr = make_openflow((offsetof(struct ofp_stats_request, body)
1371                         + body_len), OFPT_STATS_REQUEST, bufferp);
1372     osr->type = htons(type);
1373     osr->flags = htons(0);
1374     return osr->body;
1375 }
1376
1377 /* Creates a stats request message with Nicira as vendor and the given
1378  * 'subtype', of total length 'openflow_len'.  Returns the message. */
1379 void *
1380 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
1381                              struct ofpbuf **bufferp)
1382 {
1383     struct nicira_stats_msg *nsm;
1384
1385     nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
1386     nsm->type = htons(OFPST_VENDOR);
1387     nsm->flags = htons(0);
1388     nsm->vendor = htonl(NX_VENDOR_ID);
1389     nsm->subtype = htonl(subtype);
1390     return nsm;
1391 }
1392
1393 /* Returns the first byte of the 'body' member of the ofp_stats_request or
1394  * ofp_stats_reply in 'oh'. */
1395 const void *
1396 ofputil_stats_body(const struct ofp_header *oh)
1397 {
1398     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1399     return ((const struct ofp_stats_request *) oh)->body;
1400 }
1401
1402 /* Returns the length of the 'body' member of the ofp_stats_request or
1403  * ofp_stats_reply in 'oh'. */
1404 size_t
1405 ofputil_stats_body_len(const struct ofp_header *oh)
1406 {
1407     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1408     return ntohs(oh->length) - sizeof(struct ofp_stats_request);
1409 }
1410
1411 /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
1412 const void *
1413 ofputil_nxstats_body(const struct ofp_header *oh)
1414 {
1415     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1416     return ((const struct nicira_stats_msg *) oh) + 1;
1417 }
1418
1419 /* Returns the length of the body of the nicira_stats_msg in 'oh'. */
1420 size_t
1421 ofputil_nxstats_body_len(const struct ofp_header *oh)
1422 {
1423     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1424     return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1425 }
1426
1427 struct ofpbuf *
1428 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1429               size_t actions_len)
1430 {
1431     struct ofp_flow_mod *ofm;
1432     size_t size = sizeof *ofm + actions_len;
1433     struct ofpbuf *out = ofpbuf_new(size);
1434     ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1435     ofm->header.version = OFP_VERSION;
1436     ofm->header.type = OFPT_FLOW_MOD;
1437     ofm->header.length = htons(size);
1438     ofm->cookie = 0;
1439     ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1440     ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match, 0, NULL);
1441     ofm->command = htons(command);
1442     return out;
1443 }
1444
1445 struct ofpbuf *
1446 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1447               uint16_t idle_timeout, size_t actions_len)
1448 {
1449     struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1450     struct ofp_flow_mod *ofm = out->data;
1451     ofm->idle_timeout = htons(idle_timeout);
1452     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1453     ofm->buffer_id = htonl(buffer_id);
1454     return out;
1455 }
1456
1457 struct ofpbuf *
1458 make_del_flow(const struct cls_rule *rule)
1459 {
1460     struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1461     struct ofp_flow_mod *ofm = out->data;
1462     ofm->out_port = htons(OFPP_NONE);
1463     return out;
1464 }
1465
1466 struct ofpbuf *
1467 make_add_simple_flow(const struct cls_rule *rule,
1468                      uint32_t buffer_id, uint16_t out_port,
1469                      uint16_t idle_timeout)
1470 {
1471     if (out_port != OFPP_NONE) {
1472         struct ofp_action_output *oao;
1473         struct ofpbuf *buffer;
1474
1475         buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1476         oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1477         oao->type = htons(OFPAT_OUTPUT);
1478         oao->len = htons(sizeof *oao);
1479         oao->port = htons(out_port);
1480         return buffer;
1481     } else {
1482         return make_add_flow(rule, buffer_id, idle_timeout, 0);
1483     }
1484 }
1485
1486 struct ofpbuf *
1487 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1488                const struct ofpbuf *payload, int max_send_len)
1489 {
1490     struct ofp_packet_in *opi;
1491     struct ofpbuf *buf;
1492     int send_len;
1493
1494     send_len = MIN(max_send_len, payload->size);
1495     buf = ofpbuf_new(sizeof *opi + send_len);
1496     opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1497                            OFPT_PACKET_IN, 0, buf);
1498     opi->buffer_id = htonl(buffer_id);
1499     opi->total_len = htons(payload->size);
1500     opi->in_port = htons(in_port);
1501     opi->reason = reason;
1502     ofpbuf_put(buf, payload->data, send_len);
1503     update_openflow_length(buf);
1504
1505     return buf;
1506 }
1507
1508 struct ofpbuf *
1509 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1510                 uint16_t in_port,
1511                 const struct ofp_action_header *actions, size_t n_actions)
1512 {
1513     size_t actions_len = n_actions * sizeof *actions;
1514     struct ofp_packet_out *opo;
1515     size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1516     struct ofpbuf *out = ofpbuf_new(size);
1517
1518     opo = ofpbuf_put_uninit(out, sizeof *opo);
1519     opo->header.version = OFP_VERSION;
1520     opo->header.type = OFPT_PACKET_OUT;
1521     opo->header.length = htons(size);
1522     opo->header.xid = htonl(0);
1523     opo->buffer_id = htonl(buffer_id);
1524     opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1525     opo->actions_len = htons(actions_len);
1526     ofpbuf_put(out, actions, actions_len);
1527     if (packet) {
1528         ofpbuf_put(out, packet->data, packet->size);
1529     }
1530     return out;
1531 }
1532
1533 struct ofpbuf *
1534 make_unbuffered_packet_out(const struct ofpbuf *packet,
1535                            uint16_t in_port, uint16_t out_port)
1536 {
1537     struct ofp_action_output action;
1538     action.type = htons(OFPAT_OUTPUT);
1539     action.len = htons(sizeof action);
1540     action.port = htons(out_port);
1541     return make_packet_out(packet, UINT32_MAX, in_port,
1542                            (struct ofp_action_header *) &action, 1);
1543 }
1544
1545 struct ofpbuf *
1546 make_buffered_packet_out(uint32_t buffer_id,
1547                          uint16_t in_port, uint16_t out_port)
1548 {
1549     if (out_port != OFPP_NONE) {
1550         struct ofp_action_output action;
1551         action.type = htons(OFPAT_OUTPUT);
1552         action.len = htons(sizeof action);
1553         action.port = htons(out_port);
1554         return make_packet_out(NULL, buffer_id, in_port,
1555                                (struct ofp_action_header *) &action, 1);
1556     } else {
1557         return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1558     }
1559 }
1560
1561 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1562 struct ofpbuf *
1563 make_echo_request(void)
1564 {
1565     struct ofp_header *rq;
1566     struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1567     rq = ofpbuf_put_uninit(out, sizeof *rq);
1568     rq->version = OFP_VERSION;
1569     rq->type = OFPT_ECHO_REQUEST;
1570     rq->length = htons(sizeof *rq);
1571     rq->xid = htonl(0);
1572     return out;
1573 }
1574
1575 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1576  * OFPT_ECHO_REQUEST message in 'rq'. */
1577 struct ofpbuf *
1578 make_echo_reply(const struct ofp_header *rq)
1579 {
1580     size_t size = ntohs(rq->length);
1581     struct ofpbuf *out = ofpbuf_new(size);
1582     struct ofp_header *reply = ofpbuf_put(out, rq, size);
1583     reply->type = OFPT_ECHO_REPLY;
1584     return out;
1585 }
1586
1587 const struct ofp_flow_stats *
1588 flow_stats_first(struct flow_stats_iterator *iter,
1589                  const struct ofp_stats_reply *osr)
1590 {
1591     iter->pos = osr->body;
1592     iter->end = osr->body + (ntohs(osr->header.length)
1593                              - offsetof(struct ofp_stats_reply, body));
1594     return flow_stats_next(iter);
1595 }
1596
1597 const struct ofp_flow_stats *
1598 flow_stats_next(struct flow_stats_iterator *iter)
1599 {
1600     ptrdiff_t bytes_left = iter->end - iter->pos;
1601     const struct ofp_flow_stats *fs;
1602     size_t length;
1603
1604     if (bytes_left < sizeof *fs) {
1605         if (bytes_left != 0) {
1606             VLOG_WARN_RL(&bad_ofmsg_rl,
1607                          "%td leftover bytes in flow stats reply", bytes_left);
1608         }
1609         return NULL;
1610     }
1611
1612     fs = (const void *) iter->pos;
1613     length = ntohs(fs->length);
1614     if (length < sizeof *fs) {
1615         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than "
1616                      "min %zu", length, sizeof *fs);
1617         return NULL;
1618     } else if (length > bytes_left) {
1619         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td "
1620                      "bytes left", length, bytes_left);
1621         return NULL;
1622     } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
1623         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes "
1624                      "left over in final action", length,
1625                      (length - sizeof *fs) % sizeof fs->actions[0]);
1626         return NULL;
1627     }
1628     iter->pos += length;
1629     return fs;
1630 }
1631
1632 static int
1633 check_action_exact_len(const union ofp_action *a, unsigned int len,
1634                        unsigned int required_len)
1635 {
1636     if (len != required_len) {
1637         VLOG_DBG_RL(&bad_ofmsg_rl,
1638                     "action %u has invalid length %"PRIu16" (must be %u)\n",
1639                     a->type, ntohs(a->header.len), required_len);
1640         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1641     }
1642     return 0;
1643 }
1644
1645 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1646  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
1647  * 'port' is valid, otherwise an ofp_mkerr() return code. */
1648 static int
1649 check_output_port(uint16_t port, int max_ports)
1650 {
1651     switch (port) {
1652     case OFPP_IN_PORT:
1653     case OFPP_TABLE:
1654     case OFPP_NORMAL:
1655     case OFPP_FLOOD:
1656     case OFPP_ALL:
1657     case OFPP_CONTROLLER:
1658     case OFPP_LOCAL:
1659         return 0;
1660
1661     default:
1662         if (port < max_ports) {
1663             return 0;
1664         }
1665         VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1666         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1667     }
1668 }
1669
1670 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1671  * will never have more than 'max_ports' ports.  Returns 0 if 'port' is valid,
1672  * otherwise an ofp_mkerr() return code. */
1673 static int
1674 check_enqueue_action(const union ofp_action *a, unsigned int len,
1675                      int max_ports)
1676 {
1677     const struct ofp_action_enqueue *oae;
1678     uint16_t port;
1679     int error;
1680
1681     error = check_action_exact_len(a, len, 16);
1682     if (error) {
1683         return error;
1684     }
1685
1686     oae = (const struct ofp_action_enqueue *) a;
1687     port = ntohs(oae->port);
1688     if (port < max_ports || port == OFPP_IN_PORT) {
1689         return 0;
1690     }
1691     VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1692     return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1693 }
1694
1695 static int
1696 check_nicira_action(const union ofp_action *a, unsigned int len,
1697                     const struct flow *flow)
1698 {
1699     const struct nx_action_header *nah;
1700     uint16_t subtype;
1701     int error;
1702
1703     if (len < 16) {
1704         VLOG_DBG_RL(&bad_ofmsg_rl,
1705                     "Nicira vendor action only %u bytes", len);
1706         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1707     }
1708     nah = (const struct nx_action_header *) a;
1709
1710     subtype = ntohs(nah->subtype);
1711     if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
1712         /* This is necessary because enum nx_action_subtype is probably an
1713          * 8-bit type, so the cast below throws away the top 8 bits. */
1714         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1715     }
1716
1717     switch ((enum nx_action_subtype) subtype) {
1718     case NXAST_RESUBMIT:
1719     case NXAST_SET_TUNNEL:
1720     case NXAST_DROP_SPOOFED_ARP:
1721     case NXAST_SET_QUEUE:
1722     case NXAST_POP_QUEUE:
1723         return check_action_exact_len(a, len, 16);
1724
1725     case NXAST_REG_MOVE:
1726         error = check_action_exact_len(a, len,
1727                                        sizeof(struct nx_action_reg_move));
1728         if (error) {
1729             return error;
1730         }
1731         return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1732
1733     case NXAST_REG_LOAD:
1734         error = check_action_exact_len(a, len,
1735                                        sizeof(struct nx_action_reg_load));
1736         if (error) {
1737             return error;
1738         }
1739         return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1740
1741     case NXAST_NOTE:
1742         return 0;
1743
1744     case NXAST_SET_TUNNEL64:
1745         return check_action_exact_len(a, len,
1746                                       sizeof(struct nx_action_set_tunnel64));
1747
1748     case NXAST_SNAT__OBSOLETE:
1749     default:
1750         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1751     }
1752 }
1753
1754 static int
1755 check_action(const union ofp_action *a, unsigned int len,
1756              const struct flow *flow, int max_ports)
1757 {
1758     enum ofp_action_type type = ntohs(a->type);
1759     int error;
1760
1761     switch (type) {
1762     case OFPAT_OUTPUT:
1763         error = check_action_exact_len(a, len, 8);
1764         if (error) {
1765             return error;
1766         }
1767         return check_output_port(ntohs(a->output.port), max_ports);
1768
1769     case OFPAT_SET_VLAN_VID:
1770         error = check_action_exact_len(a, len, 8);
1771         if (error) {
1772             return error;
1773         }
1774         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1775             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1776         }
1777         return 0;
1778
1779     case OFPAT_SET_VLAN_PCP:
1780         error = check_action_exact_len(a, len, 8);
1781         if (error) {
1782             return error;
1783         }
1784         if (a->vlan_vid.vlan_vid & ~7) {
1785             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1786         }
1787         return 0;
1788
1789     case OFPAT_STRIP_VLAN:
1790     case OFPAT_SET_NW_SRC:
1791     case OFPAT_SET_NW_DST:
1792     case OFPAT_SET_NW_TOS:
1793     case OFPAT_SET_TP_SRC:
1794     case OFPAT_SET_TP_DST:
1795         return check_action_exact_len(a, len, 8);
1796
1797     case OFPAT_SET_DL_SRC:
1798     case OFPAT_SET_DL_DST:
1799         return check_action_exact_len(a, len, 16);
1800
1801     case OFPAT_VENDOR:
1802         return (a->vendor.vendor == htonl(NX_VENDOR_ID)
1803                 ? check_nicira_action(a, len, flow)
1804                 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
1805
1806     case OFPAT_ENQUEUE:
1807         return check_enqueue_action(a, len, max_ports);
1808
1809     default:
1810         VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
1811         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
1812     }
1813 }
1814
1815 int
1816 validate_actions(const union ofp_action *actions, size_t n_actions,
1817                  const struct flow *flow, int max_ports)
1818 {
1819     size_t i;
1820
1821     for (i = 0; i < n_actions; ) {
1822         const union ofp_action *a = &actions[i];
1823         unsigned int len = ntohs(a->header.len);
1824         unsigned int n_slots = len / OFP_ACTION_ALIGN;
1825         unsigned int slots_left = &actions[n_actions] - a;
1826         int error;
1827
1828         if (n_slots > slots_left) {
1829             VLOG_DBG_RL(&bad_ofmsg_rl,
1830                         "action requires %u slots but only %u remain",
1831                         n_slots, slots_left);
1832             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1833         } else if (!len) {
1834             VLOG_DBG_RL(&bad_ofmsg_rl, "action has invalid length 0");
1835             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1836         } else if (len % OFP_ACTION_ALIGN) {
1837             VLOG_DBG_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
1838                         "of %d", len, OFP_ACTION_ALIGN);
1839             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1840         }
1841
1842         error = check_action(a, len, flow, max_ports);
1843         if (error) {
1844             return error;
1845         }
1846         i += n_slots;
1847     }
1848     return 0;
1849 }
1850
1851 /* Returns true if 'action' outputs to 'port' (which must be in network byte
1852  * order), false otherwise. */
1853 bool
1854 action_outputs_to_port(const union ofp_action *action, uint16_t port)
1855 {
1856     switch (ntohs(action->type)) {
1857     case OFPAT_OUTPUT:
1858         return action->output.port == port;
1859     case OFPAT_ENQUEUE:
1860         return ((const struct ofp_action_enqueue *) action)->port == port;
1861     default:
1862         return false;
1863     }
1864 }
1865
1866 /* The set of actions must either come from a trusted source or have been
1867  * previously validated with validate_actions(). */
1868 const union ofp_action *
1869 actions_first(struct actions_iterator *iter,
1870               const union ofp_action *oa, size_t n_actions)
1871 {
1872     iter->pos = oa;
1873     iter->end = oa + n_actions;
1874     return actions_next(iter);
1875 }
1876
1877 const union ofp_action *
1878 actions_next(struct actions_iterator *iter)
1879 {
1880     if (iter->pos != iter->end) {
1881         const union ofp_action *a = iter->pos;
1882         unsigned int len = ntohs(a->header.len);
1883         iter->pos += len / OFP_ACTION_ALIGN;
1884         return a;
1885     } else {
1886         return NULL;
1887     }
1888 }
1889
1890 void
1891 normalize_match(struct ofp_match *m)
1892 {
1893     enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
1894                        | OFPFW_NW_TOS) };
1895     enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
1896     uint32_t wc;
1897
1898     wc = ntohl(m->wildcards) & OVSFW_ALL;
1899     if (wc & OFPFW_DL_TYPE) {
1900         m->dl_type = 0;
1901
1902         /* Can't sensibly match on network or transport headers if the
1903          * data link type is unknown. */
1904         wc |= OFPFW_NW | OFPFW_TP;
1905         m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
1906         m->tp_src = m->tp_dst = 0;
1907     } else if (m->dl_type == htons(ETH_TYPE_IP)) {
1908         if (wc & OFPFW_NW_PROTO) {
1909             m->nw_proto = 0;
1910
1911             /* Can't sensibly match on transport headers if the network
1912              * protocol is unknown. */
1913             wc |= OFPFW_TP;
1914             m->tp_src = m->tp_dst = 0;
1915         } else if (m->nw_proto == IPPROTO_TCP ||
1916                    m->nw_proto == IPPROTO_UDP ||
1917                    m->nw_proto == IPPROTO_ICMP) {
1918             if (wc & OFPFW_TP_SRC) {
1919                 m->tp_src = 0;
1920             }
1921             if (wc & OFPFW_TP_DST) {
1922                 m->tp_dst = 0;
1923             }
1924         } else {
1925             /* Transport layer fields will always be extracted as zeros, so we
1926              * can do an exact-match on those values.  */
1927             wc &= ~OFPFW_TP;
1928             m->tp_src = m->tp_dst = 0;
1929         }
1930         if (wc & OFPFW_NW_SRC_MASK) {
1931             m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1932         }
1933         if (wc & OFPFW_NW_DST_MASK) {
1934             m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1935         }
1936         if (wc & OFPFW_NW_TOS) {
1937             m->nw_tos = 0;
1938         } else {
1939             m->nw_tos &= IP_DSCP_MASK;
1940         }
1941     } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
1942         if (wc & OFPFW_NW_PROTO) {
1943             m->nw_proto = 0;
1944         }
1945         if (wc & OFPFW_NW_SRC_MASK) {
1946             m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1947         }
1948         if (wc & OFPFW_NW_DST_MASK) {
1949             m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1950         }
1951         m->tp_src = m->tp_dst = m->nw_tos = 0;
1952     } else {
1953         /* Network and transport layer fields will always be extracted as
1954          * zeros, so we can do an exact-match on those values. */
1955         wc &= ~(OFPFW_NW | OFPFW_TP);
1956         m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
1957         m->tp_src = m->tp_dst = 0;
1958     }
1959     if (wc & OFPFW_DL_SRC) {
1960         memset(m->dl_src, 0, sizeof m->dl_src);
1961     }
1962     if (wc & OFPFW_DL_DST) {
1963         memset(m->dl_dst, 0, sizeof m->dl_dst);
1964     }
1965     m->wildcards = htonl(wc);
1966 }
1967
1968 /* Returns a string that describes 'match' in a very literal way, without
1969  * interpreting its contents except in a very basic fashion.  The returned
1970  * string is intended to be fixed-length, so that it is easy to see differences
1971  * between two such strings if one is put above another.  This is useful for
1972  * describing changes made by normalize_match().
1973  *
1974  * The caller must free the returned string (with free()). */
1975 char *
1976 ofp_match_to_literal_string(const struct ofp_match *match)
1977 {
1978     return xasprintf("wildcards=%#10"PRIx32" "
1979                      " in_port=%5"PRId16" "
1980                      " dl_src="ETH_ADDR_FMT" "
1981                      " dl_dst="ETH_ADDR_FMT" "
1982                      " dl_vlan=%5"PRId16" "
1983                      " dl_vlan_pcp=%3"PRId8" "
1984                      " dl_type=%#6"PRIx16" "
1985                      " nw_tos=%#4"PRIx8" "
1986                      " nw_proto=%#4"PRIx16" "
1987                      " nw_src=%#10"PRIx32" "
1988                      " nw_dst=%#10"PRIx32" "
1989                      " tp_src=%5"PRId16" "
1990                      " tp_dst=%5"PRId16,
1991                      ntohl(match->wildcards),
1992                      ntohs(match->in_port),
1993                      ETH_ADDR_ARGS(match->dl_src),
1994                      ETH_ADDR_ARGS(match->dl_dst),
1995                      ntohs(match->dl_vlan),
1996                      match->dl_vlan_pcp,
1997                      ntohs(match->dl_type),
1998                      match->nw_tos,
1999                      match->nw_proto,
2000                      ntohl(match->nw_src),
2001                      ntohl(match->nw_dst),
2002                      ntohs(match->tp_src),
2003                      ntohs(match->tp_dst));
2004 }
2005
2006 static uint32_t
2007 vendor_code_to_id(uint8_t code)
2008 {
2009     switch (code) {
2010 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2011         OFPUTIL_VENDORS
2012 #undef OFPUTIL_VENDOR
2013     default:
2014         return UINT32_MAX;
2015     }
2016 }
2017
2018 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2019  * information taken from 'error', whose encoding must be as described in the
2020  * large comment in ofp-util.h.  If 'oh' is nonnull, then the error will use
2021  * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2022  * of 'oh'.
2023  *
2024  * Returns NULL if 'error' is not an OpenFlow error code. */
2025 struct ofpbuf *
2026 make_ofp_error_msg(int error, const struct ofp_header *oh)
2027 {
2028     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2029
2030     struct ofpbuf *buf;
2031     const void *data;
2032     size_t len;
2033     uint8_t vendor;
2034     uint16_t type;
2035     uint16_t code;
2036     ovs_be32 xid;
2037
2038     if (!is_ofp_error(error)) {
2039         /* We format 'error' with strerror() here since it seems likely to be
2040          * a system errno value. */
2041         VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2042                      error, strerror(error));
2043         return NULL;
2044     }
2045
2046     if (oh) {
2047         xid = oh->xid;
2048         data = oh;
2049         len = ntohs(oh->length);
2050         if (len > 64) {
2051             len = 64;
2052         }
2053     } else {
2054         xid = 0;
2055         data = NULL;
2056         len = 0;
2057     }
2058
2059     vendor = get_ofp_err_vendor(error);
2060     type = get_ofp_err_type(error);
2061     code = get_ofp_err_code(error);
2062     if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2063         struct ofp_error_msg *oem;
2064
2065         oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2066         oem->type = htons(type);
2067         oem->code = htons(code);
2068     } else {
2069         struct ofp_error_msg *oem;
2070         struct nx_vendor_error *nve;
2071         uint32_t vendor_id;
2072
2073         vendor_id = vendor_code_to_id(vendor);
2074         if (vendor_id == UINT32_MAX) {
2075             VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2076                          error, vendor);
2077             return NULL;
2078         }
2079
2080         oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2081                                 OFPT_ERROR, xid, &buf);
2082         oem->type = htons(NXET_VENDOR);
2083         oem->code = htons(NXVC_VENDOR_ERROR);
2084
2085         nve = (struct nx_vendor_error *)oem->data;
2086         nve->vendor = htonl(vendor_id);
2087         nve->type = htons(type);
2088         nve->code = htons(code);
2089     }
2090
2091     if (len) {
2092         buf->size -= len;
2093         ofpbuf_put(buf, data, len);
2094     }
2095
2096     return buf;
2097 }
2098
2099 /* Attempts to pull 'actions_len' bytes from the front of 'b'.  Returns 0 if
2100  * successful, otherwise an OpenFlow error.
2101  *
2102  * If successful, the first action is stored in '*actionsp' and the number of
2103  * "union ofp_action" size elements into '*n_actionsp'.  Otherwise NULL and 0
2104  * are stored, respectively.
2105  *
2106  * This function does not check that the actions are valid (the caller should
2107  * do so, with validate_actions()).  The caller is also responsible for making
2108  * sure that 'b->data' is initially aligned appropriately for "union
2109  * ofp_action". */
2110 int
2111 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2112                      union ofp_action **actionsp, size_t *n_actionsp)
2113 {
2114     if (actions_len % OFP_ACTION_ALIGN != 0) {
2115         VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2116                     "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2117         goto error;
2118     }
2119
2120     *actionsp = ofpbuf_try_pull(b, actions_len);
2121     if (*actionsp == NULL) {
2122         VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2123                     "exceeds remaining message length (%zu)",
2124                     actions_len, b->size);
2125         goto error;
2126     }
2127
2128     *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2129     return 0;
2130
2131 error:
2132     *actionsp = NULL;
2133     *n_actionsp = 0;
2134     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2135 }