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