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
 759 /* Returns a string representing the message type of 'type'.  The string is the
 760  * enumeration constant for the type, e.g. "OFPT_HELLO".  For statistics
 761  * messages, the constant is followed by "request" or "reply",
 762  * e.g. "OFPST_AGGREGATE reply". */
 763 const char *
 764 ofputil_msg_type_name(const struct ofputil_msg_type *type)
 765 {
 766     return type->name;
 767 }
 768 \f
 769 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
 770  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
 771  * an arbitrary transaction id.  Allocated bytes beyond the header, if any, are
 772  * zeroed.
 773  *
 774  * The caller is responsible for freeing '*bufferp' when it is no longer
 775  * needed.
 776  *
 777  * The OpenFlow header length is initially set to 'openflow_len'; if the
 778  * message is later extended, the length should be updated with
 779  * update_openflow_length() before sending.
 780  *
 781  * Returns the header. */
 782 void *
 783 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
 784 {
 785     *bufferp = ofpbuf_new(openflow_len);
 786     return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
 787 }
 788
 789 /* Similar to make_openflow() but creates a Nicira vendor extension message
 790  * with the specific 'subtype'.  'subtype' should be in host byte order. */
 791 void *
 792 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
 793 {
 794     return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
 795 }
 796
 797 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
 798  * 'openflow_len', starting with an OpenFlow header with the given 'type' and
 799  * transaction id 'xid'.  Allocated bytes beyond the header, if any, are
 800  * zeroed.
 801  *
 802  * The caller is responsible for freeing '*bufferp' when it is no longer
 803  * needed.
 804  *
 805  * The OpenFlow header length is initially set to 'openflow_len'; if the
 806  * message is later extended, the length should be updated with
 807  * update_openflow_length() before sending.
 808  *
 809  * Returns the header. */
 810 void *
 811 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 812                   struct ofpbuf **bufferp)
 813 {
 814     *bufferp = ofpbuf_new(openflow_len);
 815     return put_openflow_xid(openflow_len, type, xid, *bufferp);
 816 }
 817
 818 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
 819  * with the specific 'subtype'.  'subtype' should be in host byte order. */
 820 void *
 821 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 822                struct ofpbuf **bufferp)
 823 {
 824     *bufferp = ofpbuf_new(openflow_len);
 825     return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
 826 }
 827
 828 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
 829  * with the given 'type' and an arbitrary transaction id.  Allocated bytes
 830  * beyond the header, if any, are zeroed.
 831  *
 832  * The OpenFlow header length is initially set to 'openflow_len'; if the
 833  * message is later extended, the length should be updated with
 834  * update_openflow_length() before sending.
 835  *
 836  * Returns the header. */
 837 void *
 838 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
 839 {
 840     return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
 841 }
 842
 843 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
 844  * with the given 'type' and an transaction id 'xid'.  Allocated bytes beyond
 845  * the header, if any, are zeroed.
 846  *
 847  * The OpenFlow header length is initially set to 'openflow_len'; if the
 848  * message is later extended, the length should be updated with
 849  * update_openflow_length() before sending.
 850  *
 851  * Returns the header. */
 852 void *
 853 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 854                  struct ofpbuf *buffer)
 855 {
 856     struct ofp_header *oh;
 857
 858     assert(openflow_len >= sizeof *oh);
 859     assert(openflow_len <= UINT16_MAX);
 860
 861     oh = ofpbuf_put_uninit(buffer, openflow_len);
 862     oh->version = OFP_VERSION;
 863     oh->type = type;
 864     oh->length = htons(openflow_len);
 865     oh->xid = xid;
 866     memset(oh + 1, 0, openflow_len - sizeof *oh);
 867     return oh;
 868 }
 869
 870 /* Similar to put_openflow() but append a Nicira vendor extension message with
 871  * the specific 'subtype'.  'subtype' should be in host byte order. */
 872 void *
 873 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
 874 {
 875     return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
 876 }
 877
 878 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
 879  * with the specific 'subtype'.  'subtype' should be in host byte order. */
 880 void *
 881 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 882               struct ofpbuf *buffer)
 883 {
 884     struct nicira_header *nxh;
 885
 886     nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
 887     nxh->vendor = htonl(NX_VENDOR_ID);
 888     nxh->subtype = htonl(subtype);
 889     return nxh;
 890 }
 891
 892 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
 893  * 'buffer->size'. */
 894 void
 895 update_openflow_length(struct ofpbuf *buffer)
 896 {
 897     struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
 898     oh->length = htons(buffer->size);
 899 }
 900
 901 /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
 902  * space allocated for the 'body' member.  Returns the first byte of the 'body'
 903  * member. */
 904 void *
 905 ofputil_make_stats_request(size_t body_len, uint16_t type,
 906                            struct ofpbuf **bufferp)
 907 {
 908     struct ofp_stats_request *osr;
 909     osr = make_openflow((offsetof(struct ofp_stats_request, body)
 910                         + body_len), OFPT_STATS_REQUEST, bufferp);
 911     osr->type = htons(type);
 912     osr->flags = htons(0);
 913     return osr->body;
 914 }
 915
 916 /* Creates a stats request message with Nicira as vendor and the given
 917  * 'subtype', of total length 'openflow_len'.  Returns the message. */
 918 void *
 919 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
 920                              struct ofpbuf **bufferp)
 921 {
 922     struct nicira_stats_msg *nsm;
 923
 924     nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
 925     nsm->type = htons(OFPST_VENDOR);
 926     nsm->flags = htons(0);
 927     nsm->vendor = htonl(NX_VENDOR_ID);
 928     nsm->subtype = htonl(subtype);
 929     return nsm;
 930 }
 931
 932 /* Returns the first byte of the 'body' member of the ofp_stats_request or
 933  * ofp_stats_reply in 'oh'. */
 934 const void *
 935 ofputil_stats_body(const struct ofp_header *oh)
 936 {
 937     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
 938     return ((const struct ofp_stats_request *) oh)->body;
 939 }
 940
 941 /* Returns the length of the 'body' member of the ofp_stats_request or
 942  * ofp_stats_reply in 'oh'. */
 943 size_t
 944 ofputil_stats_body_len(const struct ofp_header *oh)
 945 {
 946     assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
 947     return ntohs(oh->length) - sizeof(struct ofp_stats_request);
 948 }
 949
 950 struct ofpbuf *
 951 make_flow_mod(uint16_t command, const struct cls_rule *rule,
 952               size_t actions_len)
 953 {
 954     struct ofp_flow_mod *ofm;
 955     size_t size = sizeof *ofm + actions_len;
 956     struct ofpbuf *out = ofpbuf_new(size);
 957     ofm = ofpbuf_put_zeros(out, sizeof *ofm);
 958     ofm->header.version = OFP_VERSION;
 959     ofm->header.type = OFPT_FLOW_MOD;
 960     ofm->header.length = htons(size);
 961     ofm->cookie = 0;
 962     ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
 963     ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match);
 964     ofm->command = htons(command);
 965     return out;
 966 }
 967
 968 struct ofpbuf *
 969 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
 970               uint16_t idle_timeout, size_t actions_len)
 971 {
 972     struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
 973     struct ofp_flow_mod *ofm = out->data;
 974     ofm->idle_timeout = htons(idle_timeout);
 975     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
 976     ofm->buffer_id = htonl(buffer_id);
 977     return out;
 978 }
 979
 980 struct ofpbuf *
 981 make_del_flow(const struct cls_rule *rule)
 982 {
 983     struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
 984     struct ofp_flow_mod *ofm = out->data;
 985     ofm->out_port = htons(OFPP_NONE);
 986     return out;
 987 }
 988
 989 struct ofpbuf *
 990 make_add_simple_flow(const struct cls_rule *rule,
 991                      uint32_t buffer_id, uint16_t out_port,
 992                      uint16_t idle_timeout)
 993 {
 994     if (out_port != OFPP_NONE) {
 995         struct ofp_action_output *oao;
 996         struct ofpbuf *buffer;
 997
 998         buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
 999         oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1000         oao->type = htons(OFPAT_OUTPUT);
1001         oao->len = htons(sizeof *oao);
1002         oao->port = htons(out_port);
1003         return buffer;
1004     } else {
1005         return make_add_flow(rule, buffer_id, idle_timeout, 0);
1006     }
1007 }
1008
1009 struct ofpbuf *
1010 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1011                const struct ofpbuf *payload, int max_send_len)
1012 {
1013     struct ofp_packet_in *opi;
1014     struct ofpbuf *buf;
1015     int send_len;
1016
1017     send_len = MIN(max_send_len, payload->size);
1018     buf = ofpbuf_new(sizeof *opi + send_len);
1019     opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1020                            OFPT_PACKET_IN, 0, buf);
1021     opi->buffer_id = htonl(buffer_id);
1022     opi->total_len = htons(payload->size);
1023     opi->in_port = htons(in_port);
1024     opi->reason = reason;
1025     ofpbuf_put(buf, payload->data, send_len);
1026     update_openflow_length(buf);
1027
1028     return buf;
1029 }
1030
1031 struct ofpbuf *
1032 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1033                 uint16_t in_port,
1034                 const struct ofp_action_header *actions, size_t n_actions)
1035 {
1036     size_t actions_len = n_actions * sizeof *actions;
1037     struct ofp_packet_out *opo;
1038     size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1039     struct ofpbuf *out = ofpbuf_new(size);
1040
1041     opo = ofpbuf_put_uninit(out, sizeof *opo);
1042     opo->header.version = OFP_VERSION;
1043     opo->header.type = OFPT_PACKET_OUT;
1044     opo->header.length = htons(size);
1045     opo->header.xid = htonl(0);
1046     opo->buffer_id = htonl(buffer_id);
1047     opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1048     opo->actions_len = htons(actions_len);
1049     ofpbuf_put(out, actions, actions_len);
1050     if (packet) {
1051         ofpbuf_put(out, packet->data, packet->size);
1052     }
1053     return out;
1054 }
1055
1056 struct ofpbuf *
1057 make_unbuffered_packet_out(const struct ofpbuf *packet,
1058                            uint16_t in_port, uint16_t out_port)
1059 {
1060     struct ofp_action_output action;
1061     action.type = htons(OFPAT_OUTPUT);
1062     action.len = htons(sizeof action);
1063     action.port = htons(out_port);
1064     return make_packet_out(packet, UINT32_MAX, in_port,
1065                            (struct ofp_action_header *) &action, 1);
1066 }
1067
1068 struct ofpbuf *
1069 make_buffered_packet_out(uint32_t buffer_id,
1070                          uint16_t in_port, uint16_t out_port)
1071 {
1072     if (out_port != OFPP_NONE) {
1073         struct ofp_action_output action;
1074         action.type = htons(OFPAT_OUTPUT);
1075         action.len = htons(sizeof action);
1076         action.port = htons(out_port);
1077         return make_packet_out(NULL, buffer_id, in_port,
1078                                (struct ofp_action_header *) &action, 1);
1079     } else {
1080         return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1081     }
1082 }
1083
1084 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1085 struct ofpbuf *
1086 make_echo_request(void)
1087 {
1088     struct ofp_header *rq;
1089     struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1090     rq = ofpbuf_put_uninit(out, sizeof *rq);
1091     rq->version = OFP_VERSION;
1092     rq->type = OFPT_ECHO_REQUEST;
1093     rq->length = htons(sizeof *rq);
1094     rq->xid = htonl(0);
1095     return out;
1096 }
1097
1098 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1099  * OFPT_ECHO_REQUEST message in 'rq'. */
1100 struct ofpbuf *
1101 make_echo_reply(const struct ofp_header *rq)
1102 {
1103     size_t size = ntohs(rq->length);
1104     struct ofpbuf *out = ofpbuf_new(size);
1105     struct ofp_header *reply = ofpbuf_put(out, rq, size);
1106     reply->type = OFPT_ECHO_REPLY;
1107     return out;
1108 }
1109
1110 const struct ofp_flow_stats *
1111 flow_stats_first(struct flow_stats_iterator *iter,
1112                  const struct ofp_stats_reply *osr)
1113 {
1114     iter->pos = osr->body;
1115     iter->end = osr->body + (ntohs(osr->header.length)
1116                              - offsetof(struct ofp_stats_reply, body));
1117     return flow_stats_next(iter);
1118 }
1119
1120 const struct ofp_flow_stats *
1121 flow_stats_next(struct flow_stats_iterator *iter)
1122 {
1123     ptrdiff_t bytes_left = iter->end - iter->pos;
1124     const struct ofp_flow_stats *fs;
1125     size_t length;
1126
1127     if (bytes_left < sizeof *fs) {
1128         if (bytes_left != 0) {
1129             VLOG_WARN_RL(&bad_ofmsg_rl,
1130                          "%td leftover bytes in flow stats reply", bytes_left);
1131         }
1132         return NULL;
1133     }
1134
1135     fs = (const void *) iter->pos;
1136     length = ntohs(fs->length);
1137     if (length < sizeof *fs) {
1138         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than "
1139                      "min %zu", length, sizeof *fs);
1140         return NULL;
1141     } else if (length > bytes_left) {
1142         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td "
1143                      "bytes left", length, bytes_left);
1144         return NULL;
1145     } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
1146         VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes "
1147                      "left over in final action", length,
1148                      (length - sizeof *fs) % sizeof fs->actions[0]);
1149         return NULL;
1150     }
1151     iter->pos += length;
1152     return fs;
1153 }
1154
1155 static int
1156 check_action_exact_len(const union ofp_action *a, unsigned int len,
1157                        unsigned int required_len)
1158 {
1159     if (len != required_len) {
1160         VLOG_DBG_RL(&bad_ofmsg_rl,
1161                     "action %u has invalid length %"PRIu16" (must be %u)\n",
1162                     a->type, ntohs(a->header.len), required_len);
1163         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1164     }
1165     return 0;
1166 }
1167
1168 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1169  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
1170  * 'port' is valid, otherwise an ofp_mkerr() return code. */
1171 static int
1172 check_output_port(uint16_t port, int max_ports)
1173 {
1174     switch (port) {
1175     case OFPP_IN_PORT:
1176     case OFPP_TABLE:
1177     case OFPP_NORMAL:
1178     case OFPP_FLOOD:
1179     case OFPP_ALL:
1180     case OFPP_CONTROLLER:
1181     case OFPP_LOCAL:
1182         return 0;
1183
1184     default:
1185         if (port < max_ports) {
1186             return 0;
1187         }
1188         VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1189         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1190     }
1191 }
1192
1193 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1194  * will never have more than 'max_ports' ports.  Returns 0 if 'port' is valid,
1195  * otherwise an ofp_mkerr() return code. */
1196 static int
1197 check_enqueue_action(const union ofp_action *a, unsigned int len,
1198                      int max_ports)
1199 {
1200     const struct ofp_action_enqueue *oae;
1201     uint16_t port;
1202     int error;
1203
1204     error = check_action_exact_len(a, len, 16);
1205     if (error) {
1206         return error;
1207     }
1208
1209     oae = (const struct ofp_action_enqueue *) a;
1210     port = ntohs(oae->port);
1211     if (port < max_ports || port == OFPP_IN_PORT) {
1212         return 0;
1213     }
1214     VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1215     return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1216 }
1217
1218 static int
1219 check_nicira_action(const union ofp_action *a, unsigned int len,
1220                     const struct flow *flow)
1221 {
1222     const struct nx_action_header *nah;
1223     int error;
1224
1225     if (len < 16) {
1226         VLOG_DBG_RL(&bad_ofmsg_rl,
1227                     "Nicira vendor action only %u bytes", len);
1228         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1229     }
1230     nah = (const struct nx_action_header *) a;
1231
1232     switch (ntohs(nah->subtype)) {
1233     case NXAST_RESUBMIT:
1234     case NXAST_SET_TUNNEL:
1235     case NXAST_DROP_SPOOFED_ARP:
1236     case NXAST_SET_QUEUE:
1237     case NXAST_POP_QUEUE:
1238         return check_action_exact_len(a, len, 16);
1239
1240     case NXAST_REG_MOVE:
1241         error = check_action_exact_len(a, len,
1242                                        sizeof(struct nx_action_reg_move));
1243         if (error) {
1244             return error;
1245         }
1246         return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1247
1248     case NXAST_REG_LOAD:
1249         error = check_action_exact_len(a, len,
1250                                        sizeof(struct nx_action_reg_load));
1251         if (error) {
1252             return error;
1253         }
1254         return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1255
1256     case NXAST_NOTE:
1257         return 0;
1258
1259     default:
1260         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1261     }
1262 }
1263
1264 static int
1265 check_action(const union ofp_action *a, unsigned int len,
1266              const struct flow *flow, int max_ports)
1267 {
1268     int error;
1269
1270     switch (ntohs(a->type)) {
1271     case OFPAT_OUTPUT:
1272         error = check_action_exact_len(a, len, 8);
1273         if (error) {
1274             return error;
1275         }
1276         return check_output_port(ntohs(a->output.port), max_ports);
1277
1278     case OFPAT_SET_VLAN_VID:
1279         error = check_action_exact_len(a, len, 8);
1280         if (error) {
1281             return error;
1282         }
1283         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1284             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1285         }
1286         return 0;
1287
1288     case OFPAT_SET_VLAN_PCP:
1289         error = check_action_exact_len(a, len, 8);
1290         if (error) {
1291             return error;
1292         }
1293         if (a->vlan_vid.vlan_vid & ~7) {
1294             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1295         }
1296         return 0;
1297
1298     case OFPAT_STRIP_VLAN:
1299     case OFPAT_SET_NW_SRC:
1300     case OFPAT_SET_NW_DST:
1301     case OFPAT_SET_NW_TOS:
1302     case OFPAT_SET_TP_SRC:
1303     case OFPAT_SET_TP_DST:
1304         return check_action_exact_len(a, len, 8);
1305
1306     case OFPAT_SET_DL_SRC:
1307     case OFPAT_SET_DL_DST:
1308         return check_action_exact_len(a, len, 16);
1309
1310     case OFPAT_VENDOR:
1311         return (a->vendor.vendor == htonl(NX_VENDOR_ID)
1312                 ? check_nicira_action(a, len, flow)
1313                 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
1314
1315     case OFPAT_ENQUEUE:
1316         return check_enqueue_action(a, len, max_ports);
1317
1318     default:
1319         VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %"PRIu16,
1320                 ntohs(a->type));
1321         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
1322     }
1323 }
1324
1325 int
1326 validate_actions(const union ofp_action *actions, size_t n_actions,
1327                  const struct flow *flow, int max_ports)
1328 {
1329     size_t i;
1330
1331     for (i = 0; i < n_actions; ) {
1332         const union ofp_action *a = &actions[i];
1333         unsigned int len = ntohs(a->header.len);
1334         unsigned int n_slots = len / OFP_ACTION_ALIGN;
1335         unsigned int slots_left = &actions[n_actions] - a;
1336         int error;
1337
1338         if (n_slots > slots_left) {
1339             VLOG_DBG_RL(&bad_ofmsg_rl,
1340                         "action requires %u slots but only %u remain",
1341                         n_slots, slots_left);
1342             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1343         } else if (!len) {
1344             VLOG_DBG_RL(&bad_ofmsg_rl, "action has invalid length 0");
1345             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1346         } else if (len % OFP_ACTION_ALIGN) {
1347             VLOG_DBG_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
1348                         "of %d", len, OFP_ACTION_ALIGN);
1349             return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1350         }
1351
1352         error = check_action(a, len, flow, max_ports);
1353         if (error) {
1354             return error;
1355         }
1356         i += n_slots;
1357     }
1358     return 0;
1359 }
1360
1361 /* Returns true if 'action' outputs to 'port' (which must be in network byte
1362  * order), false otherwise. */
1363 bool
1364 action_outputs_to_port(const union ofp_action *action, uint16_t port)
1365 {
1366     switch (ntohs(action->type)) {
1367     case OFPAT_OUTPUT:
1368         return action->output.port == port;
1369     case OFPAT_ENQUEUE:
1370         return ((const struct ofp_action_enqueue *) action)->port == port;
1371     default:
1372         return false;
1373     }
1374 }
1375
1376 /* The set of actions must either come from a trusted source or have been
1377  * previously validated with validate_actions(). */
1378 const union ofp_action *
1379 actions_first(struct actions_iterator *iter,
1380               const union ofp_action *oa, size_t n_actions)
1381 {
1382     iter->pos = oa;
1383     iter->end = oa + n_actions;
1384     return actions_next(iter);
1385 }
1386
1387 const union ofp_action *
1388 actions_next(struct actions_iterator *iter)
1389 {
1390     if (iter->pos != iter->end) {
1391         const union ofp_action *a = iter->pos;
1392         unsigned int len = ntohs(a->header.len);
1393         iter->pos += len / OFP_ACTION_ALIGN;
1394         return a;
1395     } else {
1396         return NULL;
1397     }
1398 }
1399
1400 void
1401 normalize_match(struct ofp_match *m)
1402 {
1403     enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
1404                        | OFPFW_NW_TOS) };
1405     enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
1406     uint32_t wc;
1407
1408     wc = ntohl(m->wildcards) & OVSFW_ALL;
1409     if (wc & OFPFW_DL_TYPE) {
1410         m->dl_type = 0;
1411
1412         /* Can't sensibly match on network or transport headers if the
1413          * data link type is unknown. */
1414         wc |= OFPFW_NW | OFPFW_TP;
1415         m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
1416         m->tp_src = m->tp_dst = 0;
1417     } else if (m->dl_type == htons(ETH_TYPE_IP)) {
1418         if (wc & OFPFW_NW_PROTO) {
1419             m->nw_proto = 0;
1420
1421             /* Can't sensibly match on transport headers if the network
1422              * protocol is unknown. */
1423             wc |= OFPFW_TP;
1424             m->tp_src = m->tp_dst = 0;
1425         } else if (m->nw_proto == IPPROTO_TCP ||
1426                    m->nw_proto == IPPROTO_UDP ||
1427                    m->nw_proto == IPPROTO_ICMP) {
1428             if (wc & OFPFW_TP_SRC) {
1429                 m->tp_src = 0;
1430             }
1431             if (wc & OFPFW_TP_DST) {
1432                 m->tp_dst = 0;
1433             }
1434         } else {
1435             /* Transport layer fields will always be extracted as zeros, so we
1436              * can do an exact-match on those values.  */
1437             wc &= ~OFPFW_TP;
1438             m->tp_src = m->tp_dst = 0;
1439         }
1440         if (wc & OFPFW_NW_SRC_MASK) {
1441             m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1442         }
1443         if (wc & OFPFW_NW_DST_MASK) {
1444             m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1445         }
1446         if (wc & OFPFW_NW_TOS) {
1447             m->nw_tos = 0;
1448         } else {
1449             m->nw_tos &= IP_DSCP_MASK;
1450         }
1451     } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
1452         if (wc & OFPFW_NW_PROTO) {
1453             m->nw_proto = 0;
1454         }
1455         if (wc & OFPFW_NW_SRC_MASK) {
1456             m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1457         }
1458         if (wc & OFPFW_NW_DST_MASK) {
1459             m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1460         }
1461         m->tp_src = m->tp_dst = m->nw_tos = 0;
1462     } else {
1463         /* Network and transport layer fields will always be extracted as
1464          * zeros, so we can do an exact-match on those values. */
1465         wc &= ~(OFPFW_NW | OFPFW_TP);
1466         m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
1467         m->tp_src = m->tp_dst = 0;
1468     }
1469     if (wc & OFPFW_DL_SRC) {
1470         memset(m->dl_src, 0, sizeof m->dl_src);
1471     }
1472     if (wc & OFPFW_DL_DST) {
1473         memset(m->dl_dst, 0, sizeof m->dl_dst);
1474     }
1475     m->wildcards = htonl(wc);
1476 }
1477
1478 /* Returns a string that describes 'match' in a very literal way, without
1479  * interpreting its contents except in a very basic fashion.  The returned
1480  * string is intended to be fixed-length, so that it is easy to see differences
1481  * between two such strings if one is put above another.  This is useful for
1482  * describing changes made by normalize_match().
1483  *
1484  * The caller must free the returned string (with free()). */
1485 char *
1486 ofp_match_to_literal_string(const struct ofp_match *match)
1487 {
1488     return xasprintf("wildcards=%#10"PRIx32" "
1489                      " in_port=%5"PRId16" "
1490                      " dl_src="ETH_ADDR_FMT" "
1491                      " dl_dst="ETH_ADDR_FMT" "
1492                      " dl_vlan=%5"PRId16" "
1493                      " dl_vlan_pcp=%3"PRId8" "
1494                      " dl_type=%#6"PRIx16" "
1495                      " nw_tos=%#4"PRIx8" "
1496                      " nw_proto=%#4"PRIx16" "
1497                      " nw_src=%#10"PRIx32" "
1498                      " nw_dst=%#10"PRIx32" "
1499                      " tp_src=%5"PRId16" "
1500                      " tp_dst=%5"PRId16,
1501                      ntohl(match->wildcards),
1502                      ntohs(match->in_port),
1503                      ETH_ADDR_ARGS(match->dl_src),
1504                      ETH_ADDR_ARGS(match->dl_dst),
1505                      ntohs(match->dl_vlan),
1506                      match->dl_vlan_pcp,
1507                      ntohs(match->dl_type),
1508                      match->nw_tos,
1509                      match->nw_proto,
1510                      ntohl(match->nw_src),
1511                      ntohl(match->nw_dst),
1512                      ntohs(match->tp_src),
1513                      ntohs(match->tp_dst));
1514 }
1515
1516 static uint32_t
1517 vendor_code_to_id(uint8_t code)
1518 {
1519     switch (code) {
1520 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
1521         OFPUTIL_VENDORS
1522 #undef OFPUTIL_VENDOR
1523     default:
1524         return UINT32_MAX;
1525     }
1526 }
1527
1528 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
1529  * information taken from 'error', whose encoding must be as described in the
1530  * large comment in ofp-util.h.  If 'oh' is nonnull, then the error will use
1531  * oh->xid as its transaction ID, and it will include up to the first 64 bytes
1532  * of 'oh'.
1533  *
1534  * Returns NULL if 'error' is not an OpenFlow error code. */
1535 struct ofpbuf *
1536 make_ofp_error_msg(int error, const struct ofp_header *oh)
1537 {
1538     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1539
1540     struct ofpbuf *buf;
1541     const void *data;
1542     size_t len;
1543     uint8_t vendor;
1544     uint16_t type;
1545     uint16_t code;
1546     ovs_be32 xid;
1547
1548     if (!is_ofp_error(error)) {
1549         /* We format 'error' with strerror() here since it seems likely to be
1550          * a system errno value. */
1551         VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
1552                      error, strerror(error));
1553         return NULL;
1554     }
1555
1556     if (oh) {
1557         xid = oh->xid;
1558         data = oh;
1559         len = ntohs(oh->length);
1560         if (len > 64) {
1561             len = 64;
1562         }
1563     } else {
1564         xid = 0;
1565         data = NULL;
1566         len = 0;
1567     }
1568
1569     vendor = get_ofp_err_vendor(error);
1570     type = get_ofp_err_type(error);
1571     code = get_ofp_err_code(error);
1572     if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
1573         struct ofp_error_msg *oem;
1574
1575         oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
1576         oem->type = htons(type);
1577         oem->code = htons(code);
1578     } else {
1579         struct ofp_error_msg *oem;
1580         struct nx_vendor_error *nve;
1581         uint32_t vendor_id;
1582
1583         vendor_id = vendor_code_to_id(vendor);
1584         if (vendor_id == UINT32_MAX) {
1585             VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
1586                          error, vendor);
1587             return NULL;
1588         }
1589
1590         oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
1591                                 OFPT_ERROR, xid, &buf);
1592         oem->type = htons(NXET_VENDOR);
1593         oem->code = htons(NXVC_VENDOR_ERROR);
1594
1595         nve = ofpbuf_put_uninit(buf, sizeof *nve);
1596         nve->vendor = htonl(vendor_id);
1597         nve->type = htons(type);
1598         nve->code = htons(code);
1599     }
1600
1601     if (len) {
1602         ofpbuf_put(buf, data, len);
1603     }
1604
1605     return buf;
1606 }
1607
1608 /* Attempts to pull 'actions_len' bytes from the front of 'b'.  Returns 0 if
1609  * successful, otherwise an OpenFlow error.
1610  *
1611  * If successful, the first action is stored in '*actionsp' and the number of
1612  * "union ofp_action" size elements into '*n_actionsp'.  Otherwise NULL and 0
1613  * are stored, respectively.
1614  *
1615  * This function does not check that the actions are valid (the caller should
1616  * do so, with validate_actions()).  The caller is also responsible for making
1617  * sure that 'b->data' is initially aligned appropriately for "union
1618  * ofp_action". */
1619 int
1620 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
1621                      union ofp_action **actionsp, size_t *n_actionsp)
1622 {
1623     if (actions_len % OFP_ACTION_ALIGN != 0) {
1624         VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
1625                     "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
1626         goto error;
1627     }
1628
1629     *actionsp = ofpbuf_try_pull(b, actions_len);
1630     if (*actionsp == NULL) {
1631         VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
1632                     "exceeds remaining message length (%zu)",
1633                     actions_len, b->size);
1634         goto error;
1635     }
1636
1637     *n_actionsp = actions_len / OFP_ACTION_ALIGN;
1638     return 0;
1639
1640 error:
1641     *actionsp = NULL;
1642     *n_actionsp = 0;
1643     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1644 }