lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <sys/types.h>
  22 #include <netinet/in.h>
  23 #include <netinet/icmp6.h>
  24 #include <stdlib.h>
  25 #include "autopath.h"
  26 #include "bundle.h"
  27 #include "byte-order.h"
  28 #include "classifier.h"
  29 #include "dynamic-string.h"
  30 #include "learn.h"
  31 #include "meta-flow.h"
  32 #include "multipath.h"
  33 #include "netdev.h"
  34 #include "nx-match.h"
  35 #include "ofp-actions.h"
  36 #include "ofp-errors.h"
  37 #include "ofp-msgs.h"
  38 #include "ofp-util.h"
  39 #include "ofpbuf.h"
  40 #include "packets.h"
  41 #include "random.h"
  42 #include "unaligned.h"
  43 #include "type-props.h"
  44 #include "vlog.h"
  45
  46 VLOG_DEFINE_THIS_MODULE(ofp_util);
  47
  48 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  49  * in the peer and so there's not much point in showing a lot of them. */
  50 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  51
  52 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
  53  * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
  54  * is wildcarded.
  55  *
  56  * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
  57  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
  58  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
  59  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
  60  * wildcarded. */
  61 ovs_be32
  62 ofputil_wcbits_to_netmask(int wcbits)
  63 {
  64     wcbits &= 0x3f;
  65     return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
  66 }
  67
  68 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
  69  * that it wildcards, that is, the number of 0-bits in 'netmask', a number
  70  * between 0 and 32 inclusive.
  71  *
  72  * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
  73  * still be in the valid range but isn't otherwise meaningful. */
  74 int
  75 ofputil_netmask_to_wcbits(ovs_be32 netmask)
  76 {
  77     return 32 - ip_count_cidr_bits(netmask);
  78 }
  79
  80 /* A list of the FWW_* and OFPFW10_ bits that have the same value, meaning, and
  81  * name. */
  82 #define WC_INVARIANT_LIST \
  83     WC_INVARIANT_BIT(IN_PORT) \
  84     WC_INVARIANT_BIT(DL_TYPE) \
  85     WC_INVARIANT_BIT(NW_PROTO)
  86
  87 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
  88  * actually have the same names and values. */
  89 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW10_##NAME);
  90     WC_INVARIANT_LIST
  91 #undef WC_INVARIANT_BIT
  92
  93 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
  94  * OR'd together. */
  95 static const flow_wildcards_t WC_INVARIANTS = 0
  96 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
  97     WC_INVARIANT_LIST
  98 #undef WC_INVARIANT_BIT
  99 ;
 100
 101 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
 102  * flow_wildcards in 'wc' for use in struct cls_rule.  It is the caller's
 103  * responsibility to handle the special case where the flow match's dl_vlan is
 104  * set to OFP_VLAN_NONE. */
 105 void
 106 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
 107 {
 108     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
 109
 110     /* Initialize most of rule->wc. */
 111     flow_wildcards_init_catchall(wc);
 112     wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
 113
 114     /* Wildcard fields that aren't defined by ofp10_match. */
 115     wc->wildcards |= FWW_NW_ECN | FWW_NW_TTL;
 116
 117     if (ofpfw & OFPFW10_NW_TOS) {
 118         /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
 119          * the enum than we can use. */
 120         wc->wildcards |= FWW_NW_DSCP;
 121     }
 122
 123     wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
 124     wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
 125
 126     if (!(ofpfw & OFPFW10_TP_SRC)) {
 127         wc->tp_src_mask = htons(UINT16_MAX);
 128     }
 129     if (!(ofpfw & OFPFW10_TP_DST)) {
 130         wc->tp_dst_mask = htons(UINT16_MAX);
 131     }
 132
 133     if (!(ofpfw & OFPFW10_DL_SRC)) {
 134         memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
 135     }
 136     if (!(ofpfw & OFPFW10_DL_DST)) {
 137         memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
 138     }
 139
 140     /* VLAN TCI mask. */
 141     if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
 142         wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
 143     }
 144     if (!(ofpfw & OFPFW10_DL_VLAN)) {
 145         wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
 146     }
 147 }
 148
 149 /* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
 150  * given 'priority'. */
 151 void
 152 ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
 153                                   unsigned int priority, struct cls_rule *rule)
 154 {
 155     uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
 156
 157     /* Initialize rule->priority, rule->wc. */
 158     rule->priority = !ofpfw ? UINT16_MAX : priority;
 159     ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
 160
 161     /* Initialize most of rule->flow. */
 162     rule->flow.nw_src = match->nw_src;
 163     rule->flow.nw_dst = match->nw_dst;
 164     rule->flow.in_port = ntohs(match->in_port);
 165     rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
 166     rule->flow.tp_src = match->tp_src;
 167     rule->flow.tp_dst = match->tp_dst;
 168     memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
 169     memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
 170     rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
 171     rule->flow.nw_proto = match->nw_proto;
 172
 173     /* Translate VLANs. */
 174     if (!(ofpfw & OFPFW10_DL_VLAN) &&
 175         match->dl_vlan == htons(OFP10_VLAN_NONE)) {
 176         /* Match only packets without 802.1Q header.
 177          *
 178          * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
 179          *
 180          * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
 181          * because we can't have a specific PCP without an 802.1Q header.
 182          * However, older versions of OVS treated this as matching packets
 183          * withut an 802.1Q header, so we do here too. */
 184         rule->flow.vlan_tci = htons(0);
 185         rule->wc.vlan_tci_mask = htons(0xffff);
 186     } else {
 187         ovs_be16 vid, pcp, tci;
 188
 189         vid = match->dl_vlan & htons(VLAN_VID_MASK);
 190         pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
 191         tci = vid | pcp | htons(VLAN_CFI);
 192         rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
 193     }
 194
 195     /* Clean up. */
 196     cls_rule_zero_wildcarded_fields(rule);
 197 }
 198
 199 /* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
 200 void
 201 ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
 202                                 struct ofp10_match *match)
 203 {
 204     const struct flow_wildcards *wc = &rule->wc;
 205     uint32_t ofpfw;
 206
 207     /* Figure out most OpenFlow wildcards. */
 208     ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
 209     ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
 210               << OFPFW10_NW_SRC_SHIFT);
 211     ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
 212               << OFPFW10_NW_DST_SHIFT);
 213     if (wc->wildcards & FWW_NW_DSCP) {
 214         ofpfw |= OFPFW10_NW_TOS;
 215     }
 216     if (!wc->tp_src_mask) {
 217         ofpfw |= OFPFW10_TP_SRC;
 218     }
 219     if (!wc->tp_dst_mask) {
 220         ofpfw |= OFPFW10_TP_DST;
 221     }
 222     if (eth_addr_is_zero(wc->dl_src_mask)) {
 223         ofpfw |= OFPFW10_DL_SRC;
 224     }
 225     if (eth_addr_is_zero(wc->dl_dst_mask)) {
 226         ofpfw |= OFPFW10_DL_DST;
 227     }
 228
 229     /* Translate VLANs. */
 230     match->dl_vlan = htons(0);
 231     match->dl_vlan_pcp = 0;
 232     if (rule->wc.vlan_tci_mask == htons(0)) {
 233         ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
 234     } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
 235                && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
 236         match->dl_vlan = htons(OFP10_VLAN_NONE);
 237         ofpfw |= OFPFW10_DL_VLAN_PCP;
 238     } else {
 239         if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
 240             ofpfw |= OFPFW10_DL_VLAN;
 241         } else {
 242             match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
 243         }
 244
 245         if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
 246             ofpfw |= OFPFW10_DL_VLAN_PCP;
 247         } else {
 248             match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
 249         }
 250     }
 251
 252     /* Compose most of the match structure. */
 253     match->wildcards = htonl(ofpfw);
 254     match->in_port = htons(rule->flow.in_port);
 255     memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
 256     memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
 257     match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
 258     match->nw_src = rule->flow.nw_src;
 259     match->nw_dst = rule->flow.nw_dst;
 260     match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
 261     match->nw_proto = rule->flow.nw_proto;
 262     match->tp_src = rule->flow.tp_src;
 263     match->tp_dst = rule->flow.tp_dst;
 264     memset(match->pad1, '\0', sizeof match->pad1);
 265     memset(match->pad2, '\0', sizeof match->pad2);
 266 }
 267
 268 enum ofperr
 269 ofputil_pull_ofp11_match(struct ofpbuf *buf, unsigned int priority,
 270                          struct cls_rule *rule, uint16_t *padded_match_len)
 271 {
 272     struct ofp11_match_header *omh = buf->data;
 273     uint16_t match_len;
 274
 275     if (buf->size < sizeof *omh) {
 276         return OFPERR_OFPBMC_BAD_LEN;
 277     }
 278
 279     match_len = ntohs(omh->length);
 280
 281     switch (ntohs(omh->type)) {
 282     case OFPMT_STANDARD: {
 283         struct ofp11_match *om;
 284
 285         if (match_len != sizeof *om || buf->size < sizeof *om) {
 286             return OFPERR_OFPBMC_BAD_LEN;
 287         }
 288         om = ofpbuf_pull(buf, sizeof *om);
 289         if (padded_match_len) {
 290             *padded_match_len = match_len;
 291         }
 292         return ofputil_cls_rule_from_ofp11_match(om, priority, rule);
 293     }
 294
 295     case OFPMT_OXM:
 296         if (padded_match_len) {
 297             *padded_match_len = ROUND_UP(match_len, 8);
 298         }
 299         return oxm_pull_match(buf, priority, rule);
 300
 301     default:
 302         return OFPERR_OFPBMC_BAD_TYPE;
 303     }
 304 }
 305
 306 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
 307  * given 'priority'.  Returns 0 if successful, otherwise an OFPERR_* value. */
 308 enum ofperr
 309 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
 310                                   unsigned int priority,
 311                                   struct cls_rule *rule)
 312 {
 313     uint16_t wc = ntohl(match->wildcards);
 314     uint8_t dl_src_mask[ETH_ADDR_LEN];
 315     uint8_t dl_dst_mask[ETH_ADDR_LEN];
 316     bool ipv4, arp;
 317     int i;
 318
 319     cls_rule_init_catchall(rule, priority);
 320
 321     if (!(wc & OFPFW11_IN_PORT)) {
 322         uint16_t ofp_port;
 323         enum ofperr error;
 324
 325         error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
 326         if (error) {
 327             return OFPERR_OFPBMC_BAD_VALUE;
 328         }
 329         cls_rule_set_in_port(rule, ofp_port);
 330     }
 331
 332     for (i = 0; i < ETH_ADDR_LEN; i++) {
 333         dl_src_mask[i] = ~match->dl_src_mask[i];
 334     }
 335     cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
 336
 337     for (i = 0; i < ETH_ADDR_LEN; i++) {
 338         dl_dst_mask[i] = ~match->dl_dst_mask[i];
 339     }
 340     cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
 341
 342     if (!(wc & OFPFW11_DL_VLAN)) {
 343         if (match->dl_vlan == htons(OFPVID11_NONE)) {
 344             /* Match only packets without a VLAN tag. */
 345             rule->flow.vlan_tci = htons(0);
 346             rule->wc.vlan_tci_mask = htons(UINT16_MAX);
 347         } else {
 348             if (match->dl_vlan == htons(OFPVID11_ANY)) {
 349                 /* Match any packet with a VLAN tag regardless of VID. */
 350                 rule->flow.vlan_tci = htons(VLAN_CFI);
 351                 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
 352             } else if (ntohs(match->dl_vlan) < 4096) {
 353                 /* Match only packets with the specified VLAN VID. */
 354                 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
 355                 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
 356             } else {
 357                 /* Invalid VID. */
 358                 return OFPERR_OFPBMC_BAD_VALUE;
 359             }
 360
 361             if (!(wc & OFPFW11_DL_VLAN_PCP)) {
 362                 if (match->dl_vlan_pcp <= 7) {
 363                     rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
 364                                                  << VLAN_PCP_SHIFT);
 365                     rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
 366                 } else {
 367                     /* Invalid PCP. */
 368                     return OFPERR_OFPBMC_BAD_VALUE;
 369                 }
 370             }
 371         }
 372     }
 373
 374     if (!(wc & OFPFW11_DL_TYPE)) {
 375         cls_rule_set_dl_type(rule,
 376                              ofputil_dl_type_from_openflow(match->dl_type));
 377     }
 378
 379     ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
 380     arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
 381
 382     if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
 383         if (match->nw_tos & ~IP_DSCP_MASK) {
 384             /* Invalid TOS. */
 385             return OFPERR_OFPBMC_BAD_VALUE;
 386         }
 387
 388         cls_rule_set_nw_dscp(rule, match->nw_tos);
 389     }
 390
 391     if (ipv4 || arp) {
 392         if (!(wc & OFPFW11_NW_PROTO)) {
 393             cls_rule_set_nw_proto(rule, match->nw_proto);
 394         }
 395         cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
 396         cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
 397     }
 398
 399 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
 400     if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
 401         switch (rule->flow.nw_proto) {
 402         case IPPROTO_ICMP:
 403             /* "A.2.3 Flow Match Structures" in OF1.1 says:
 404              *
 405              *    The tp_src and tp_dst fields will be ignored unless the
 406              *    network protocol specified is as TCP, UDP or SCTP.
 407              *
 408              * but I'm pretty sure we should support ICMP too, otherwise
 409              * that's a regression from OF1.0. */
 410             if (!(wc & OFPFW11_TP_SRC)) {
 411                 uint16_t icmp_type = ntohs(match->tp_src);
 412                 if (icmp_type < 0x100) {
 413                     cls_rule_set_icmp_type(rule, icmp_type);
 414                 } else {
 415                     return OFPERR_OFPBMC_BAD_FIELD;
 416                 }
 417             }
 418             if (!(wc & OFPFW11_TP_DST)) {
 419                 uint16_t icmp_code = ntohs(match->tp_dst);
 420                 if (icmp_code < 0x100) {
 421                     cls_rule_set_icmp_code(rule, icmp_code);
 422                 } else {
 423                     return OFPERR_OFPBMC_BAD_FIELD;
 424                 }
 425             }
 426             break;
 427
 428         case IPPROTO_TCP:
 429         case IPPROTO_UDP:
 430             if (!(wc & (OFPFW11_TP_SRC))) {
 431                 cls_rule_set_tp_src(rule, match->tp_src);
 432             }
 433             if (!(wc & (OFPFW11_TP_DST))) {
 434                 cls_rule_set_tp_dst(rule, match->tp_dst);
 435             }
 436             break;
 437
 438         case IPPROTO_SCTP:
 439             /* We don't support SCTP and it seems that we should tell the
 440              * controller, since OF1.1 implementations are supposed to. */
 441             return OFPERR_OFPBMC_BAD_FIELD;
 442
 443         default:
 444             /* OF1.1 says explicitly to ignore this. */
 445             break;
 446         }
 447     }
 448
 449     if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
 450         rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
 451         enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
 452
 453         if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
 454             /* MPLS not supported. */
 455             return OFPERR_OFPBMC_BAD_TAG;
 456         }
 457     }
 458
 459     if (match->metadata_mask != htonll(UINT64_MAX)) {
 460         cls_rule_set_metadata_masked(rule, match->metadata,
 461                                      ~match->metadata_mask);
 462     }
 463
 464     return 0;
 465 }
 466
 467 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
 468 void
 469 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
 470                                 struct ofp11_match *match)
 471 {
 472     uint32_t wc = 0;
 473     int i;
 474
 475     memset(match, 0, sizeof *match);
 476     match->omh.type = htons(OFPMT_STANDARD);
 477     match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
 478
 479     if (rule->wc.wildcards & FWW_IN_PORT) {
 480         wc |= OFPFW11_IN_PORT;
 481     } else {
 482         match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
 483     }
 484
 485     memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
 486     for (i = 0; i < ETH_ADDR_LEN; i++) {
 487         match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
 488     }
 489
 490     memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
 491     for (i = 0; i < ETH_ADDR_LEN; i++) {
 492         match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
 493     }
 494
 495     if (rule->wc.vlan_tci_mask == htons(0)) {
 496         wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
 497     } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
 498                && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
 499         match->dl_vlan = htons(OFPVID11_NONE);
 500         wc |= OFPFW11_DL_VLAN_PCP;
 501     } else {
 502         if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
 503             match->dl_vlan = htons(OFPVID11_ANY);
 504         } else {
 505             match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
 506         }
 507
 508         if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
 509             wc |= OFPFW11_DL_VLAN_PCP;
 510         } else {
 511             match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
 512         }
 513     }
 514
 515     if (rule->wc.wildcards & FWW_DL_TYPE) {
 516         wc |= OFPFW11_DL_TYPE;
 517     } else {
 518         match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
 519     }
 520
 521     if (rule->wc.wildcards & FWW_NW_DSCP) {
 522         wc |= OFPFW11_NW_TOS;
 523     } else {
 524         match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
 525     }
 526
 527     if (rule->wc.wildcards & FWW_NW_PROTO) {
 528         wc |= OFPFW11_NW_PROTO;
 529     } else {
 530         match->nw_proto = rule->flow.nw_proto;
 531     }
 532
 533     match->nw_src = rule->flow.nw_src;
 534     match->nw_src_mask = ~rule->wc.nw_src_mask;
 535     match->nw_dst = rule->flow.nw_dst;
 536     match->nw_dst_mask = ~rule->wc.nw_dst_mask;
 537
 538     if (!rule->wc.tp_src_mask) {
 539         wc |= OFPFW11_TP_SRC;
 540     } else {
 541         match->tp_src = rule->flow.tp_src;
 542     }
 543
 544     if (!rule->wc.tp_dst_mask) {
 545         wc |= OFPFW11_TP_DST;
 546     } else {
 547         match->tp_dst = rule->flow.tp_dst;
 548     }
 549
 550     /* MPLS not supported. */
 551     wc |= OFPFW11_MPLS_LABEL;
 552     wc |= OFPFW11_MPLS_TC;
 553
 554     match->metadata = rule->flow.metadata;
 555     match->metadata_mask = ~rule->wc.metadata_mask;
 556
 557     match->wildcards = htonl(wc);
 558 }
 559
 560 /* Given a 'dl_type' value in the format used in struct flow, returns the
 561  * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
 562  * structure. */
 563 ovs_be16
 564 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
 565 {
 566     return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
 567             ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 568             : flow_dl_type);
 569 }
 570
 571 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
 572  * structure, returns the corresponding 'dl_type' value for use in struct
 573  * flow. */
 574 ovs_be16
 575 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
 576 {
 577     return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 578             ? htons(FLOW_DL_TYPE_NONE)
 579             : ofp_dl_type);
 580 }
 581 \f
 582 /* Protocols. */
 583
 584 struct proto_abbrev {
 585     enum ofputil_protocol protocol;
 586     const char *name;
 587 };
 588
 589 /* Most users really don't care about some of the differences between
 590  * protocols.  These abbreviations help with that. */
 591 static const struct proto_abbrev proto_abbrevs[] = {
 592     { OFPUTIL_P_ANY,      "any" },
 593     { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
 594     { OFPUTIL_P_NXM_ANY,  "NXM" },
 595 };
 596 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
 597
 598 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
 599     OFPUTIL_P_NXM,
 600     OFPUTIL_P_OF10,
 601 };
 602 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
 603
 604 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
 605  * connection that has negotiated the given 'version'.  'version' should
 606  * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
 607  * 1.0, 0x02 for OpenFlow 1.1).  Returns 0 if 'version' is not supported or
 608  * outside the valid range.  */
 609 enum ofputil_protocol
 610 ofputil_protocol_from_ofp_version(enum ofp_version version)
 611 {
 612     switch (version) {
 613     case OFP10_VERSION:
 614         return OFPUTIL_P_OF10;
 615     case OFP12_VERSION:
 616         return OFPUTIL_P_OF12;
 617     case OFP11_VERSION:
 618     default:
 619         return 0;
 620     }
 621 }
 622
 623 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
 624  * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
 625 enum ofp_version
 626 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
 627 {
 628     switch (protocol) {
 629     case OFPUTIL_P_OF10:
 630     case OFPUTIL_P_OF10_TID:
 631     case OFPUTIL_P_NXM:
 632     case OFPUTIL_P_NXM_TID:
 633         return OFP10_VERSION;
 634     case OFPUTIL_P_OF12:
 635         return OFP12_VERSION;
 636     }
 637
 638     NOT_REACHED();
 639 }
 640
 641 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
 642  * otherwise. */
 643 bool
 644 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
 645 {
 646     return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
 647 }
 648
 649 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
 650  * extension turned on or off if 'enable' is true or false, respectively.
 651  *
 652  * This extension is only useful for protocols whose "standard" version does
 653  * not allow specific tables to be modified.  In particular, this is true of
 654  * OpenFlow 1.0.  In later versions of OpenFlow, a flow_mod request always
 655  * specifies a table ID and so there is no need for such an extension.  When
 656  * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
 657  * extension, this function just returns its 'protocol' argument unchanged
 658  * regardless of the value of 'enable'.  */
 659 enum ofputil_protocol
 660 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
 661 {
 662     switch (protocol) {
 663     case OFPUTIL_P_OF10:
 664     case OFPUTIL_P_OF10_TID:
 665         return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
 666
 667     case OFPUTIL_P_NXM:
 668     case OFPUTIL_P_NXM_TID:
 669         return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
 670
 671     case OFPUTIL_P_OF12:
 672         return OFPUTIL_P_OF12;
 673
 674     default:
 675         NOT_REACHED();
 676     }
 677 }
 678
 679 /* Returns the "base" version of 'protocol'.  That is, if 'protocol' includes
 680  * some extension to a standard protocol version, the return value is the
 681  * standard version of that protocol without any extension.  If 'protocol' is a
 682  * standard protocol version, returns 'protocol' unchanged. */
 683 enum ofputil_protocol
 684 ofputil_protocol_to_base(enum ofputil_protocol protocol)
 685 {
 686     return ofputil_protocol_set_tid(protocol, false);
 687 }
 688
 689 /* Returns 'new_base' with any extensions taken from 'cur'. */
 690 enum ofputil_protocol
 691 ofputil_protocol_set_base(enum ofputil_protocol cur,
 692                           enum ofputil_protocol new_base)
 693 {
 694     bool tid = (cur & OFPUTIL_P_TID) != 0;
 695
 696     switch (new_base) {
 697     case OFPUTIL_P_OF10:
 698     case OFPUTIL_P_OF10_TID:
 699         return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
 700
 701     case OFPUTIL_P_NXM:
 702     case OFPUTIL_P_NXM_TID:
 703         return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
 704
 705     case OFPUTIL_P_OF12:
 706         return ofputil_protocol_set_tid(OFPUTIL_P_OF12, tid);
 707
 708     default:
 709         NOT_REACHED();
 710     }
 711 }
 712
 713 /* Returns a string form of 'protocol', if a simple form exists (that is, if
 714  * 'protocol' is either a single protocol or it is a combination of protocols
 715  * that have a single abbreviation).  Otherwise, returns NULL. */
 716 const char *
 717 ofputil_protocol_to_string(enum ofputil_protocol protocol)
 718 {
 719     const struct proto_abbrev *p;
 720
 721     /* Use a "switch" statement for single-bit names so that we get a compiler
 722      * warning if we forget any. */
 723     switch (protocol) {
 724     case OFPUTIL_P_NXM:
 725         return "NXM-table_id";
 726
 727     case OFPUTIL_P_NXM_TID:
 728         return "NXM+table_id";
 729
 730     case OFPUTIL_P_OF10:
 731         return "OpenFlow10-table_id";
 732
 733     case OFPUTIL_P_OF10_TID:
 734         return "OpenFlow10+table_id";
 735
 736     case OFPUTIL_P_OF12:
 737         return NULL;
 738     }
 739
 740     /* Check abbreviations. */
 741     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 742         if (protocol == p->protocol) {
 743             return p->name;
 744         }
 745     }
 746
 747     return NULL;
 748 }
 749
 750 /* Returns a string that represents 'protocols'.  The return value might be a
 751  * comma-separated list if 'protocols' doesn't have a simple name.  The return
 752  * value is "none" if 'protocols' is 0.
 753  *
 754  * The caller must free the returned string (with free()). */
 755 char *
 756 ofputil_protocols_to_string(enum ofputil_protocol protocols)
 757 {
 758     struct ds s;
 759
 760     assert(!(protocols & ~OFPUTIL_P_ANY));
 761     if (protocols == 0) {
 762         return xstrdup("none");
 763     }
 764
 765     ds_init(&s);
 766     while (protocols) {
 767         const struct proto_abbrev *p;
 768         int i;
 769
 770         if (s.length) {
 771             ds_put_char(&s, ',');
 772         }
 773
 774         for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 775             if ((protocols & p->protocol) == p->protocol) {
 776                 ds_put_cstr(&s, p->name);
 777                 protocols &= ~p->protocol;
 778                 goto match;
 779             }
 780         }
 781
 782         for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
 783             enum ofputil_protocol bit = 1u << i;
 784
 785             if (protocols & bit) {
 786                 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
 787                 protocols &= ~bit;
 788                 goto match;
 789             }
 790         }
 791         NOT_REACHED();
 792
 793     match: ;
 794     }
 795     return ds_steal_cstr(&s);
 796 }
 797
 798 static enum ofputil_protocol
 799 ofputil_protocol_from_string__(const char *s, size_t n)
 800 {
 801     const struct proto_abbrev *p;
 802     int i;
 803
 804     for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
 805         enum ofputil_protocol bit = 1u << i;
 806         const char *name = ofputil_protocol_to_string(bit);
 807
 808         if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
 809             return bit;
 810         }
 811     }
 812
 813     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 814         if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
 815             return p->protocol;
 816         }
 817     }
 818
 819     return 0;
 820 }
 821
 822 /* Returns the nonempty set of protocols represented by 's', which can be a
 823  * single protocol name or abbreviation or a comma-separated list of them.
 824  *
 825  * Aborts the program with an error message if 's' is invalid. */
 826 enum ofputil_protocol
 827 ofputil_protocols_from_string(const char *s)
 828 {
 829     const char *orig_s = s;
 830     enum ofputil_protocol protocols;
 831
 832     protocols = 0;
 833     while (*s) {
 834         enum ofputil_protocol p;
 835         size_t n;
 836
 837         n = strcspn(s, ",");
 838         if (n == 0) {
 839             s++;
 840             continue;
 841         }
 842
 843         p = ofputil_protocol_from_string__(s, n);
 844         if (!p) {
 845             ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
 846         }
 847         protocols |= p;
 848
 849         s += n;
 850     }
 851
 852     if (!protocols) {
 853         ovs_fatal(0, "%s: no flow protocol specified", orig_s);
 854     }
 855     return protocols;
 856 }
 857
 858 bool
 859 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
 860 {
 861     switch (packet_in_format) {
 862     case NXPIF_OPENFLOW10:
 863     case NXPIF_NXM:
 864         return true;
 865     }
 866
 867     return false;
 868 }
 869
 870 const char *
 871 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
 872 {
 873     switch (packet_in_format) {
 874     case NXPIF_OPENFLOW10:
 875         return "openflow10";
 876     case NXPIF_NXM:
 877         return "nxm";
 878     default:
 879         NOT_REACHED();
 880     }
 881 }
 882
 883 int
 884 ofputil_packet_in_format_from_string(const char *s)
 885 {
 886     return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
 887             : !strcmp(s, "nxm") ? NXPIF_NXM
 888             : -1);
 889 }
 890
 891 static bool
 892 regs_fully_wildcarded(const struct flow_wildcards *wc)
 893 {
 894     int i;
 895
 896     for (i = 0; i < FLOW_N_REGS; i++) {
 897         if (wc->reg_masks[i] != 0) {
 898             return false;
 899         }
 900     }
 901     return true;
 902 }
 903
 904 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
 905  * to a switch (e.g. to add or remove a flow).  Only NXM can handle tunnel IDs,
 906  * registers, or fixing the Ethernet multicast bit.  Otherwise, it's better to
 907  * use OpenFlow 1.0 protocol for backward compatibility. */
 908 enum ofputil_protocol
 909 ofputil_usable_protocols(const struct cls_rule *rule)
 910 {
 911     const struct flow_wildcards *wc = &rule->wc;
 912
 913     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
 914
 915     /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
 916     if (!eth_mask_is_exact(wc->dl_src_mask)
 917         && !eth_addr_is_zero(wc->dl_src_mask)) {
 918         return OFPUTIL_P_NXM_ANY;
 919     }
 920     if (!eth_mask_is_exact(wc->dl_dst_mask)
 921         && !eth_addr_is_zero(wc->dl_dst_mask)) {
 922         return OFPUTIL_P_NXM_ANY;
 923     }
 924
 925     /* NXM and OF1.1+ support matching metadata. */
 926     if (wc->metadata_mask != htonll(0)) {
 927         return OFPUTIL_P_NXM_ANY;
 928     }
 929
 930     /* Only NXM supports matching ARP hardware addresses. */
 931     if (!eth_addr_is_zero(wc->arp_sha_mask) ||
 932         !eth_addr_is_zero(wc->arp_tha_mask)) {
 933         return OFPUTIL_P_NXM_ANY;
 934     }
 935
 936     /* Only NXM supports matching IPv6 traffic. */
 937     if (!(wc->wildcards & FWW_DL_TYPE)
 938             && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
 939         return OFPUTIL_P_NXM_ANY;
 940     }
 941
 942     /* Only NXM supports matching registers. */
 943     if (!regs_fully_wildcarded(wc)) {
 944         return OFPUTIL_P_NXM_ANY;
 945     }
 946
 947     /* Only NXM supports matching tun_id. */
 948     if (wc->tun_id_mask != htonll(0)) {
 949         return OFPUTIL_P_NXM_ANY;
 950     }
 951
 952     /* Only NXM supports matching fragments. */
 953     if (wc->nw_frag_mask) {
 954         return OFPUTIL_P_NXM_ANY;
 955     }
 956
 957     /* Only NXM supports matching IPv6 flow label. */
 958     if (wc->ipv6_label_mask) {
 959         return OFPUTIL_P_NXM_ANY;
 960     }
 961
 962     /* Only NXM supports matching IP ECN bits. */
 963     if (!(wc->wildcards & FWW_NW_ECN)) {
 964         return OFPUTIL_P_NXM_ANY;
 965     }
 966
 967     /* Only NXM supports matching IP TTL/hop limit. */
 968     if (!(wc->wildcards & FWW_NW_TTL)) {
 969         return OFPUTIL_P_NXM_ANY;
 970     }
 971
 972     /* Only NXM supports non-CIDR IPv4 address masks. */
 973     if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
 974         return OFPUTIL_P_NXM_ANY;
 975     }
 976
 977     /* Only NXM supports bitwise matching on transport port. */
 978     if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
 979         (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
 980         return OFPUTIL_P_NXM_ANY;
 981     }
 982
 983     /* Other formats can express this rule. */
 984     return OFPUTIL_P_ANY;
 985 }
 986
 987 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
 988  * protocol is 'current', at least partly transitions the protocol to 'want'.
 989  * Stores in '*next' the protocol that will be in effect on the OpenFlow
 990  * connection if the switch processes the returned message correctly.  (If
 991  * '*next != want' then the caller will have to iterate.)
 992  *
 993  * If 'current == want', returns NULL and stores 'current' in '*next'. */
 994 struct ofpbuf *
 995 ofputil_encode_set_protocol(enum ofputil_protocol current,
 996                             enum ofputil_protocol want,
 997                             enum ofputil_protocol *next)
 998 {
 999     enum ofputil_protocol cur_base, want_base;
1000     bool cur_tid, want_tid;
1001
1002     cur_base = ofputil_protocol_to_base(current);
1003     want_base = ofputil_protocol_to_base(want);
1004     if (cur_base != want_base) {
1005         *next = ofputil_protocol_set_base(current, want_base);
1006
1007         switch (want_base) {
1008         case OFPUTIL_P_NXM:
1009             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1010
1011         case OFPUTIL_P_OF10:
1012             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1013
1014         case OFPUTIL_P_OF12:
1015             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1016
1017         case OFPUTIL_P_OF10_TID:
1018         case OFPUTIL_P_NXM_TID:
1019             NOT_REACHED();
1020         }
1021     }
1022
1023     cur_tid = (current & OFPUTIL_P_TID) != 0;
1024     want_tid = (want & OFPUTIL_P_TID) != 0;
1025     if (cur_tid != want_tid) {
1026         *next = ofputil_protocol_set_tid(current, want_tid);
1027         return ofputil_make_flow_mod_table_id(want_tid);
1028     }
1029
1030     assert(current == want);
1031
1032     *next = current;
1033     return NULL;
1034 }
1035
1036 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1037  * format to 'nxff'.  */
1038 struct ofpbuf *
1039 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1040 {
1041     struct nx_set_flow_format *sff;
1042     struct ofpbuf *msg;
1043
1044     assert(ofputil_nx_flow_format_is_valid(nxff));
1045
1046     msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1047     sff = ofpbuf_put_zeros(msg, sizeof *sff);
1048     sff->format = htonl(nxff);
1049
1050     return msg;
1051 }
1052
1053 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1054  * otherwise. */
1055 enum ofputil_protocol
1056 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1057 {
1058     switch (flow_format) {
1059     case NXFF_OPENFLOW10:
1060         return OFPUTIL_P_OF10;
1061
1062     case NXFF_NXM:
1063         return OFPUTIL_P_NXM;
1064
1065     case NXFF_OPENFLOW12:
1066         return OFPUTIL_P_OF12;
1067
1068     default:
1069         return 0;
1070     }
1071 }
1072
1073 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1074 bool
1075 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1076 {
1077     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1078 }
1079
1080 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1081  * value. */
1082 const char *
1083 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1084 {
1085     switch (flow_format) {
1086     case NXFF_OPENFLOW10:
1087         return "openflow10";
1088     case NXFF_NXM:
1089         return "nxm";
1090     case NXFF_OPENFLOW12:
1091         return "openflow12";
1092     default:
1093         NOT_REACHED();
1094     }
1095 }
1096
1097 struct ofpbuf *
1098 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1099 {
1100     struct nx_set_packet_in_format *spif;
1101     struct ofpbuf *msg;
1102
1103     msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, 0);
1104     spif = ofpbuf_put_zeros(msg, sizeof *spif);
1105     spif->format = htonl(packet_in_format);
1106
1107     return msg;
1108 }
1109
1110 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1111  * extension on or off (according to 'flow_mod_table_id'). */
1112 struct ofpbuf *
1113 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1114 {
1115     struct nx_flow_mod_table_id *nfmti;
1116     struct ofpbuf *msg;
1117
1118     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1119     nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1120     nfmti->set = flow_mod_table_id;
1121     return msg;
1122 }
1123
1124 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1125  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1126  * code.
1127  *
1128  * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1129  * The caller must initialize 'ofpacts' and retains ownership of it.
1130  * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1131  *
1132  * Does not validate the flow_mod actions.  The caller should do that, with
1133  * ofpacts_check(). */
1134 enum ofperr
1135 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1136                         const struct ofp_header *oh,
1137                         enum ofputil_protocol protocol,
1138                         struct ofpbuf *ofpacts)
1139 {
1140     uint16_t command;
1141     struct ofpbuf b;
1142     enum ofpraw raw;
1143
1144     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1145     raw = ofpraw_pull_assert(&b);
1146     if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1147         /* Standard OpenFlow 1.1 flow_mod. */
1148         const struct ofp11_flow_mod *ofm;
1149         enum ofperr error;
1150
1151         ofm = ofpbuf_pull(&b, sizeof *ofm);
1152
1153         error = ofputil_pull_ofp11_match(&b, ntohs(ofm->priority), &fm->cr,
1154                                          NULL);
1155         if (error) {
1156             return error;
1157         }
1158
1159         error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1160         if (error) {
1161             return error;
1162         }
1163
1164         /* Translate the message. */
1165         if (ofm->command == OFPFC_ADD) {
1166             fm->cookie = htonll(0);
1167             fm->cookie_mask = htonll(0);
1168             fm->new_cookie = ofm->cookie;
1169         } else {
1170             /* XXX */
1171             fm->cookie = ofm->cookie;
1172             fm->cookie_mask = ofm->cookie_mask;
1173             fm->new_cookie = htonll(UINT64_MAX);
1174         }
1175         fm->command = ofm->command;
1176         fm->table_id = ofm->table_id;
1177         fm->idle_timeout = ntohs(ofm->idle_timeout);
1178         fm->hard_timeout = ntohs(ofm->hard_timeout);
1179         fm->buffer_id = ntohl(ofm->buffer_id);
1180         error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1181         if (error) {
1182             return error;
1183         }
1184         if (ofm->out_group != htonl(OFPG_ANY)) {
1185             return OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED;
1186         }
1187         fm->flags = ntohs(ofm->flags);
1188     } else {
1189         if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1190             /* Standard OpenFlow 1.0 flow_mod. */
1191             const struct ofp10_flow_mod *ofm;
1192             uint16_t priority;
1193             enum ofperr error;
1194
1195             /* Get the ofp10_flow_mod. */
1196             ofm = ofpbuf_pull(&b, sizeof *ofm);
1197
1198             /* Set priority based on original wildcards.  Normally we'd allow
1199              * ofputil_cls_rule_from_match() to do this for us, but
1200              * ofputil_normalize_rule() can put wildcards where the original
1201              * flow didn't have them. */
1202             priority = ntohs(ofm->priority);
1203             if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1204                 priority = UINT16_MAX;
1205             }
1206
1207             /* Translate the rule. */
1208             ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1209             ofputil_normalize_rule(&fm->cr);
1210
1211             /* Now get the actions. */
1212             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1213             if (error) {
1214                 return error;
1215             }
1216
1217             /* Translate the message. */
1218             command = ntohs(ofm->command);
1219             fm->cookie = htonll(0);
1220             fm->cookie_mask = htonll(0);
1221             fm->new_cookie = ofm->cookie;
1222             fm->idle_timeout = ntohs(ofm->idle_timeout);
1223             fm->hard_timeout = ntohs(ofm->hard_timeout);
1224             fm->buffer_id = ntohl(ofm->buffer_id);
1225             fm->out_port = ntohs(ofm->out_port);
1226             fm->flags = ntohs(ofm->flags);
1227         } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1228             /* Nicira extended flow_mod. */
1229             const struct nx_flow_mod *nfm;
1230             enum ofperr error;
1231
1232             /* Dissect the message. */
1233             nfm = ofpbuf_pull(&b, sizeof *nfm);
1234             error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1235                                   &fm->cr, &fm->cookie, &fm->cookie_mask);
1236             if (error) {
1237                 return error;
1238             }
1239             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1240             if (error) {
1241                 return error;
1242             }
1243
1244             /* Translate the message. */
1245             command = ntohs(nfm->command);
1246             if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1247                 /* Flow additions may only set a new cookie, not match an
1248                  * existing cookie. */
1249                 return OFPERR_NXBRC_NXM_INVALID;
1250             }
1251             fm->new_cookie = nfm->cookie;
1252             fm->idle_timeout = ntohs(nfm->idle_timeout);
1253             fm->hard_timeout = ntohs(nfm->hard_timeout);
1254             fm->buffer_id = ntohl(nfm->buffer_id);
1255             fm->out_port = ntohs(nfm->out_port);
1256             fm->flags = ntohs(nfm->flags);
1257         } else {
1258             NOT_REACHED();
1259         }
1260
1261         if (protocol & OFPUTIL_P_TID) {
1262             fm->command = command & 0xff;
1263             fm->table_id = command >> 8;
1264         } else {
1265             fm->command = command;
1266             fm->table_id = 0xff;
1267         }
1268     }
1269
1270     fm->ofpacts = ofpacts->data;
1271     fm->ofpacts_len = ofpacts->size;
1272
1273     return 0;
1274 }
1275
1276 static ovs_be16
1277 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1278                     enum ofputil_protocol protocol)
1279 {
1280     return htons(protocol & OFPUTIL_P_TID
1281                  ? (fm->command & 0xff) | (fm->table_id << 8)
1282                  : fm->command);
1283 }
1284
1285 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1286  * 'protocol' and returns the message. */
1287 struct ofpbuf *
1288 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1289                         enum ofputil_protocol protocol)
1290 {
1291     struct ofpbuf *msg;
1292
1293     switch (protocol) {
1294     case OFPUTIL_P_OF12: {
1295         struct ofp11_flow_mod *ofm;
1296
1297         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1298                            NXM_TYPICAL_LEN + fm->ofpacts_len);
1299         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1300         ofm->cookie = fm->new_cookie;
1301         ofm->cookie_mask = fm->cookie_mask;
1302         ofm->table_id = fm->table_id;
1303         ofm->command = fm->command;
1304         ofm->idle_timeout = htons(fm->idle_timeout);
1305         ofm->hard_timeout = htons(fm->hard_timeout);
1306         ofm->priority = htons(fm->cr.priority);
1307         ofm->buffer_id = htonl(fm->buffer_id);
1308         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1309         ofm->out_group = htonl(OFPG11_ANY);
1310         ofm->flags = htons(fm->flags);
1311         oxm_put_match(msg, &fm->cr);
1312         if (fm->ofpacts) {
1313             ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len,
1314                                                 msg);
1315         }
1316         break;
1317     }
1318
1319     case OFPUTIL_P_OF10:
1320     case OFPUTIL_P_OF10_TID: {
1321         struct ofp10_flow_mod *ofm;
1322
1323         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1324                            fm->ofpacts_len);
1325         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1326         ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1327         ofm->cookie = fm->new_cookie;
1328         ofm->command = ofputil_tid_command(fm, protocol);
1329         ofm->idle_timeout = htons(fm->idle_timeout);
1330         ofm->hard_timeout = htons(fm->hard_timeout);
1331         ofm->priority = htons(fm->cr.priority);
1332         ofm->buffer_id = htonl(fm->buffer_id);
1333         ofm->out_port = htons(fm->out_port);
1334         ofm->flags = htons(fm->flags);
1335         if (fm->ofpacts) {
1336             ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1337         }
1338         break;
1339     }
1340
1341     case OFPUTIL_P_NXM:
1342     case OFPUTIL_P_NXM_TID: {
1343         struct nx_flow_mod *nfm;
1344         int match_len;
1345
1346         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1347                            NXM_TYPICAL_LEN + fm->ofpacts_len);
1348         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1349         nfm->command = ofputil_tid_command(fm, protocol);
1350         nfm->cookie = fm->new_cookie;
1351         match_len = nx_put_match(msg, &fm->cr, fm->cookie, fm->cookie_mask);
1352         nfm = msg->l3;
1353         nfm->idle_timeout = htons(fm->idle_timeout);
1354         nfm->hard_timeout = htons(fm->hard_timeout);
1355         nfm->priority = htons(fm->cr.priority);
1356         nfm->buffer_id = htonl(fm->buffer_id);
1357         nfm->out_port = htons(fm->out_port);
1358         nfm->flags = htons(fm->flags);
1359         nfm->match_len = htons(match_len);
1360         if (fm->ofpacts) {
1361             ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1362         }
1363         break;
1364     }
1365
1366     default:
1367         NOT_REACHED();
1368     }
1369
1370     ofpmsg_update_length(msg);
1371     return msg;
1372 }
1373
1374 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1375  * send all of the 'n_fm's flow table modification requests in 'fms', and a
1376  * 0-bit for each protocol that is inadequate.
1377  *
1378  * (The return value will have at least one 1-bit.) */
1379 enum ofputil_protocol
1380 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1381                                   size_t n_fms)
1382 {
1383     enum ofputil_protocol usable_protocols;
1384     size_t i;
1385
1386     usable_protocols = OFPUTIL_P_ANY;
1387     for (i = 0; i < n_fms; i++) {
1388         const struct ofputil_flow_mod *fm = &fms[i];
1389
1390         usable_protocols &= ofputil_usable_protocols(&fm->cr);
1391         if (fm->table_id != 0xff) {
1392             usable_protocols &= OFPUTIL_P_TID;
1393         }
1394
1395         /* Matching of the cookie is only supported through NXM. */
1396         if (fm->cookie_mask != htonll(0)) {
1397             usable_protocols &= OFPUTIL_P_NXM_ANY;
1398         }
1399     }
1400     assert(usable_protocols);
1401
1402     return usable_protocols;
1403 }
1404
1405 static enum ofperr
1406 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1407                                   const struct ofp10_flow_stats_request *ofsr,
1408                                   bool aggregate)
1409 {
1410     fsr->aggregate = aggregate;
1411     ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1412     fsr->out_port = ntohs(ofsr->out_port);
1413     fsr->table_id = ofsr->table_id;
1414     fsr->cookie = fsr->cookie_mask = htonll(0);
1415
1416     return 0;
1417 }
1418
1419 static enum ofperr
1420 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1421                                  struct ofpbuf *b, bool aggregate)
1422 {
1423     const struct nx_flow_stats_request *nfsr;
1424     enum ofperr error;
1425
1426     nfsr = ofpbuf_pull(b, sizeof *nfsr);
1427     error = nx_pull_match(b, ntohs(nfsr->match_len), 0, &fsr->match,
1428                           &fsr->cookie, &fsr->cookie_mask);
1429     if (error) {
1430         return error;
1431     }
1432     if (b->size) {
1433         return OFPERR_OFPBRC_BAD_LEN;
1434     }
1435
1436     fsr->aggregate = aggregate;
1437     fsr->out_port = ntohs(nfsr->out_port);
1438     fsr->table_id = nfsr->table_id;
1439
1440     return 0;
1441 }
1442
1443 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1444  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
1445  * successful, otherwise an OpenFlow error code. */
1446 enum ofperr
1447 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1448                                   const struct ofp_header *oh)
1449 {
1450     enum ofpraw raw;
1451     struct ofpbuf b;
1452
1453     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1454     raw = ofpraw_pull_assert(&b);
1455     switch ((int) raw) {
1456     case OFPRAW_OFPST_FLOW_REQUEST:
1457         return ofputil_decode_ofpst_flow_request(fsr, b.data, false);
1458
1459     case OFPRAW_OFPST_AGGREGATE_REQUEST:
1460         return ofputil_decode_ofpst_flow_request(fsr, b.data, true);
1461
1462     case OFPRAW_NXST_FLOW_REQUEST:
1463         return ofputil_decode_nxst_flow_request(fsr, &b, false);
1464
1465     case OFPRAW_NXST_AGGREGATE_REQUEST:
1466         return ofputil_decode_nxst_flow_request(fsr, &b, true);
1467
1468     default:
1469         /* Hey, the caller lied. */
1470         NOT_REACHED();
1471     }
1472 }
1473
1474 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1475  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1476  * 'protocol', and returns the message. */
1477 struct ofpbuf *
1478 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1479                                   enum ofputil_protocol protocol)
1480 {
1481     struct ofpbuf *msg;
1482     enum ofpraw raw;
1483
1484     switch (protocol) {
1485     case OFPUTIL_P_OF10:
1486     case OFPUTIL_P_OF10_TID: {
1487         struct ofp10_flow_stats_request *ofsr;
1488
1489         raw = (fsr->aggregate
1490                ? OFPRAW_OFPST_AGGREGATE_REQUEST
1491                : OFPRAW_OFPST_FLOW_REQUEST);
1492         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1493         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1494         ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1495         ofsr->table_id = fsr->table_id;
1496         ofsr->out_port = htons(fsr->out_port);
1497         break;
1498     }
1499
1500     case OFPUTIL_P_NXM:
1501     case OFPUTIL_P_NXM_TID: {
1502         struct nx_flow_stats_request *nfsr;
1503         int match_len;
1504
1505         raw = (fsr->aggregate
1506                ? OFPRAW_NXST_AGGREGATE_REQUEST
1507                : OFPRAW_NXST_FLOW_REQUEST);
1508         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1509         ofpbuf_put_zeros(msg, sizeof *nfsr);
1510         match_len = nx_put_match(msg, &fsr->match,
1511                                  fsr->cookie, fsr->cookie_mask);
1512
1513         nfsr = msg->l3;
1514         nfsr->out_port = htons(fsr->out_port);
1515         nfsr->match_len = htons(match_len);
1516         nfsr->table_id = fsr->table_id;
1517         break;
1518     }
1519
1520     case OFPUTIL_P_OF12:
1521     default:
1522         NOT_REACHED();
1523     }
1524
1525     return msg;
1526 }
1527
1528 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1529  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1530  *
1531  * (The return value will have at least one 1-bit.) */
1532 enum ofputil_protocol
1533 ofputil_flow_stats_request_usable_protocols(
1534     const struct ofputil_flow_stats_request *fsr)
1535 {
1536     enum ofputil_protocol usable_protocols;
1537
1538     usable_protocols = ofputil_usable_protocols(&fsr->match);
1539     if (fsr->cookie_mask != htonll(0)) {
1540         usable_protocols &= OFPUTIL_P_NXM_ANY;
1541     }
1542     return usable_protocols;
1543 }
1544
1545 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1546  * ofputil_flow_stats in 'fs'.
1547  *
1548  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1549  * OpenFlow message.  Calling this function multiple times for a single 'msg'
1550  * iterates through the replies.  The caller must initially leave 'msg''s layer
1551  * pointers null and not modify them between calls.
1552  *
1553  * Most switches don't send the values needed to populate fs->idle_age and
1554  * fs->hard_age, so those members will usually be set to 0.  If the switch from
1555  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1556  * 'flow_age_extension' as true so that the contents of 'msg' determine the
1557  * 'idle_age' and 'hard_age' members in 'fs'.
1558  *
1559  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1560  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
1561  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
1562  *
1563  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1564  * otherwise a positive errno value. */
1565 int
1566 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1567                                 struct ofpbuf *msg,
1568                                 bool flow_age_extension,
1569                                 struct ofpbuf *ofpacts)
1570 {
1571     enum ofperr error;
1572     enum ofpraw raw;
1573
1574     error = (msg->l2
1575              ? ofpraw_decode(&raw, msg->l2)
1576              : ofpraw_pull(&raw, msg));
1577     if (error) {
1578         return error;
1579     }
1580
1581     if (!msg->size) {
1582         return EOF;
1583     } else if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1584         const struct ofp10_flow_stats *ofs;
1585         size_t length;
1586
1587         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1588         if (!ofs) {
1589             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1590                          "bytes at end", msg->size);
1591             return EINVAL;
1592         }
1593
1594         length = ntohs(ofs->length);
1595         if (length < sizeof *ofs) {
1596             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1597                          "length %zu", length);
1598             return EINVAL;
1599         }
1600
1601         if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1602             return EINVAL;
1603         }
1604
1605         fs->cookie = get_32aligned_be64(&ofs->cookie);
1606         ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
1607                                           &fs->rule);
1608         fs->table_id = ofs->table_id;
1609         fs->duration_sec = ntohl(ofs->duration_sec);
1610         fs->duration_nsec = ntohl(ofs->duration_nsec);
1611         fs->idle_timeout = ntohs(ofs->idle_timeout);
1612         fs->hard_timeout = ntohs(ofs->hard_timeout);
1613         fs->idle_age = -1;
1614         fs->hard_age = -1;
1615         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1616         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1617     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1618         const struct nx_flow_stats *nfs;
1619         size_t match_len, actions_len, length;
1620
1621         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1622         if (!nfs) {
1623             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1624                          "bytes at end", msg->size);
1625             return EINVAL;
1626         }
1627
1628         length = ntohs(nfs->length);
1629         match_len = ntohs(nfs->match_len);
1630         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1631             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1632                          "claims invalid length %zu", match_len, length);
1633             return EINVAL;
1634         }
1635         if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1636                           NULL, NULL)) {
1637             return EINVAL;
1638         }
1639
1640         actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1641         if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1642             return EINVAL;
1643         }
1644
1645         fs->cookie = nfs->cookie;
1646         fs->table_id = nfs->table_id;
1647         fs->duration_sec = ntohl(nfs->duration_sec);
1648         fs->duration_nsec = ntohl(nfs->duration_nsec);
1649         fs->idle_timeout = ntohs(nfs->idle_timeout);
1650         fs->hard_timeout = ntohs(nfs->hard_timeout);
1651         fs->idle_age = -1;
1652         fs->hard_age = -1;
1653         if (flow_age_extension) {
1654             if (nfs->idle_age) {
1655                 fs->idle_age = ntohs(nfs->idle_age) - 1;
1656             }
1657             if (nfs->hard_age) {
1658                 fs->hard_age = ntohs(nfs->hard_age) - 1;
1659             }
1660         }
1661         fs->packet_count = ntohll(nfs->packet_count);
1662         fs->byte_count = ntohll(nfs->byte_count);
1663     } else {
1664         NOT_REACHED();
1665     }
1666
1667     fs->ofpacts = ofpacts->data;
1668     fs->ofpacts_len = ofpacts->size;
1669
1670     return 0;
1671 }
1672
1673 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1674  *
1675  * We use this in situations where OVS internally uses UINT64_MAX to mean
1676  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1677 static uint64_t
1678 unknown_to_zero(uint64_t count)
1679 {
1680     return count != UINT64_MAX ? count : 0;
1681 }
1682
1683 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1684  * those already present in the list of ofpbufs in 'replies'.  'replies' should
1685  * have been initialized with ofputil_start_stats_reply(). */
1686 void
1687 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1688                                 struct list *replies)
1689 {
1690     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1691     size_t start_ofs = reply->size;
1692     enum ofpraw raw;
1693
1694     ofpraw_decode_partial(&raw, reply->data, reply->size);
1695     if (raw == OFPRAW_OFPST_FLOW_REPLY) {
1696         struct ofp10_flow_stats *ofs;
1697
1698         ofpbuf_put_uninit(reply, sizeof *ofs);
1699         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1700
1701         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1702         ofs->length = htons(reply->size - start_ofs);
1703         ofs->table_id = fs->table_id;
1704         ofs->pad = 0;
1705         ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
1706         ofs->duration_sec = htonl(fs->duration_sec);
1707         ofs->duration_nsec = htonl(fs->duration_nsec);
1708         ofs->priority = htons(fs->rule.priority);
1709         ofs->idle_timeout = htons(fs->idle_timeout);
1710         ofs->hard_timeout = htons(fs->hard_timeout);
1711         memset(ofs->pad2, 0, sizeof ofs->pad2);
1712         put_32aligned_be64(&ofs->cookie, fs->cookie);
1713         put_32aligned_be64(&ofs->packet_count,
1714                            htonll(unknown_to_zero(fs->packet_count)));
1715         put_32aligned_be64(&ofs->byte_count,
1716                            htonll(unknown_to_zero(fs->byte_count)));
1717     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1718         struct nx_flow_stats *nfs;
1719         int match_len;
1720
1721         ofpbuf_put_uninit(reply, sizeof *nfs);
1722         match_len = nx_put_match(reply, &fs->rule, 0, 0);
1723         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1724
1725         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
1726         nfs->length = htons(reply->size - start_ofs);
1727         nfs->table_id = fs->table_id;
1728         nfs->pad = 0;
1729         nfs->duration_sec = htonl(fs->duration_sec);
1730         nfs->duration_nsec = htonl(fs->duration_nsec);
1731         nfs->priority = htons(fs->rule.priority);
1732         nfs->idle_timeout = htons(fs->idle_timeout);
1733         nfs->hard_timeout = htons(fs->hard_timeout);
1734         nfs->idle_age = htons(fs->idle_age < 0 ? 0
1735                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1736                               : UINT16_MAX);
1737         nfs->hard_age = htons(fs->hard_age < 0 ? 0
1738                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1739                               : UINT16_MAX);
1740         nfs->match_len = htons(match_len);
1741         nfs->cookie = fs->cookie;
1742         nfs->packet_count = htonll(fs->packet_count);
1743         nfs->byte_count = htonll(fs->byte_count);
1744     } else {
1745         NOT_REACHED();
1746     }
1747
1748     ofpmp_postappend(replies, start_ofs);
1749 }
1750
1751 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1752  * NXST_AGGREGATE reply matching 'request', and returns the message. */
1753 struct ofpbuf *
1754 ofputil_encode_aggregate_stats_reply(
1755     const struct ofputil_aggregate_stats *stats,
1756     const struct ofp_header *request)
1757 {
1758     struct ofp_aggregate_stats_reply *asr;
1759     uint64_t packet_count;
1760     uint64_t byte_count;
1761     struct ofpbuf *msg;
1762     enum ofpraw raw;
1763
1764     ofpraw_decode(&raw, request);
1765     if (raw == OFPRAW_OFPST_AGGREGATE_REQUEST) {
1766         packet_count = unknown_to_zero(stats->packet_count);
1767         byte_count = unknown_to_zero(stats->byte_count);
1768     } else {
1769         packet_count = stats->packet_count;
1770         byte_count = stats->byte_count;
1771     }
1772
1773     msg = ofpraw_alloc_stats_reply(request, 0);
1774     asr = ofpbuf_put_zeros(msg, sizeof *asr);
1775     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
1776     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
1777     asr->flow_count = htonl(stats->flow_count);
1778
1779     return msg;
1780 }
1781
1782 enum ofperr
1783 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
1784                                      const struct ofp_header *reply)
1785 {
1786     struct ofp_aggregate_stats_reply *asr;
1787     struct ofpbuf msg;
1788
1789     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
1790     ofpraw_pull_assert(&msg);
1791
1792     asr = msg.l3;
1793     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
1794     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
1795     stats->flow_count = ntohl(asr->flow_count);
1796
1797     return 0;
1798 }
1799
1800 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1801  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
1802  * an OpenFlow error code. */
1803 enum ofperr
1804 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1805                             const struct ofp_header *oh)
1806 {
1807     enum ofpraw raw;
1808     struct ofpbuf b;
1809
1810     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1811     raw = ofpraw_pull_assert(&b);
1812     if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
1813         const struct ofp_flow_removed *ofr;
1814
1815         ofr = ofpbuf_pull(&b, sizeof *ofr);
1816
1817         ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
1818                                           &fr->rule);
1819         fr->cookie = ofr->cookie;
1820         fr->reason = ofr->reason;
1821         fr->duration_sec = ntohl(ofr->duration_sec);
1822         fr->duration_nsec = ntohl(ofr->duration_nsec);
1823         fr->idle_timeout = ntohs(ofr->idle_timeout);
1824         fr->packet_count = ntohll(ofr->packet_count);
1825         fr->byte_count = ntohll(ofr->byte_count);
1826     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
1827         struct nx_flow_removed *nfr;
1828         int error;
1829
1830         nfr = ofpbuf_pull(&b, sizeof *nfr);
1831         error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1832                               &fr->rule, NULL, NULL);
1833         if (error) {
1834             return error;
1835         }
1836         if (b.size) {
1837             return OFPERR_OFPBRC_BAD_LEN;
1838         }
1839
1840         fr->cookie = nfr->cookie;
1841         fr->reason = nfr->reason;
1842         fr->duration_sec = ntohl(nfr->duration_sec);
1843         fr->duration_nsec = ntohl(nfr->duration_nsec);
1844         fr->idle_timeout = ntohs(nfr->idle_timeout);
1845         fr->packet_count = ntohll(nfr->packet_count);
1846         fr->byte_count = ntohll(nfr->byte_count);
1847     } else {
1848         NOT_REACHED();
1849     }
1850
1851     return 0;
1852 }
1853
1854 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1855  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1856  * message. */
1857 struct ofpbuf *
1858 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1859                             enum ofputil_protocol protocol)
1860 {
1861     struct ofpbuf *msg;
1862
1863     switch (protocol) {
1864     case OFPUTIL_P_OF10:
1865     case OFPUTIL_P_OF10_TID: {
1866         struct ofp_flow_removed *ofr;
1867
1868         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
1869                                htonl(0), 0);
1870         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1871         ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
1872         ofr->cookie = fr->cookie;
1873         ofr->priority = htons(fr->rule.priority);
1874         ofr->reason = fr->reason;
1875         ofr->duration_sec = htonl(fr->duration_sec);
1876         ofr->duration_nsec = htonl(fr->duration_nsec);
1877         ofr->idle_timeout = htons(fr->idle_timeout);
1878         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1879         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1880         break;
1881     }
1882
1883     case OFPUTIL_P_NXM:
1884     case OFPUTIL_P_NXM_TID: {
1885         struct nx_flow_removed *nfr;
1886         int match_len;
1887
1888         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
1889                                htonl(0), NXM_TYPICAL_LEN);
1890         nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
1891         match_len = nx_put_match(msg, &fr->rule, 0, 0);
1892
1893         nfr = msg->l3;
1894         nfr->cookie = fr->cookie;
1895         nfr->priority = htons(fr->rule.priority);
1896         nfr->reason = fr->reason;
1897         nfr->duration_sec = htonl(fr->duration_sec);
1898         nfr->duration_nsec = htonl(fr->duration_nsec);
1899         nfr->idle_timeout = htons(fr->idle_timeout);
1900         nfr->match_len = htons(match_len);
1901         nfr->packet_count = htonll(fr->packet_count);
1902         nfr->byte_count = htonll(fr->byte_count);
1903         break;
1904     }
1905
1906     case OFPUTIL_P_OF12:
1907     default:
1908         NOT_REACHED();
1909     }
1910
1911     return msg;
1912 }
1913
1914 enum ofperr
1915 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
1916                          const struct ofp_header *oh)
1917 {
1918     enum ofpraw raw;
1919     struct ofpbuf b;
1920
1921     memset(pin, 0, sizeof *pin);
1922
1923     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1924     raw = ofpraw_pull_assert(&b);
1925     if (raw == OFPRAW_OFPT10_PACKET_IN) {
1926         const struct ofp_packet_in *opi;
1927
1928         opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
1929
1930         pin->packet = opi->data;
1931         pin->packet_len = b.size;
1932
1933         pin->fmd.in_port = ntohs(opi->in_port);
1934         pin->reason = opi->reason;
1935         pin->buffer_id = ntohl(opi->buffer_id);
1936         pin->total_len = ntohs(opi->total_len);
1937     } else if (raw == OFPRAW_NXT_PACKET_IN) {
1938         const struct nx_packet_in *npi;
1939         struct cls_rule rule;
1940         int error;
1941
1942         npi = ofpbuf_pull(&b, sizeof *npi);
1943         error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
1944                                     NULL);
1945         if (error) {
1946             return error;
1947         }
1948
1949         if (!ofpbuf_try_pull(&b, 2)) {
1950             return OFPERR_OFPBRC_BAD_LEN;
1951         }
1952
1953         pin->packet = b.data;
1954         pin->packet_len = b.size;
1955         pin->reason = npi->reason;
1956         pin->table_id = npi->table_id;
1957         pin->cookie = npi->cookie;
1958
1959         pin->fmd.in_port = rule.flow.in_port;
1960
1961         pin->fmd.tun_id = rule.flow.tun_id;
1962         pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
1963
1964         pin->fmd.metadata = rule.flow.metadata;
1965         pin->fmd.metadata_mask = rule.wc.metadata_mask;
1966
1967         memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
1968         memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
1969                sizeof pin->fmd.reg_masks);
1970
1971         pin->buffer_id = ntohl(npi->buffer_id);
1972         pin->total_len = ntohs(npi->total_len);
1973     } else {
1974         NOT_REACHED();
1975     }
1976
1977     return 0;
1978 }
1979
1980 static void
1981 ofputil_packet_in_to_rule(const struct ofputil_packet_in *pin,
1982                           struct cls_rule *rule)
1983 {
1984     int i;
1985
1986     cls_rule_init_catchall(rule, 0);
1987     cls_rule_set_tun_id_masked(rule, pin->fmd.tun_id,
1988                                pin->fmd.tun_id_mask);
1989     cls_rule_set_metadata_masked(rule, pin->fmd.metadata,
1990                                  pin->fmd.metadata_mask);
1991
1992     for (i = 0; i < FLOW_N_REGS; i++) {
1993         cls_rule_set_reg_masked(rule, i, pin->fmd.regs[i],
1994                                 pin->fmd.reg_masks[i]);
1995     }
1996
1997     cls_rule_set_in_port(rule, pin->fmd.in_port);
1998 }
1999
2000 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2001  * in the format specified by 'packet_in_format'.  */
2002 struct ofpbuf *
2003 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2004                          enum ofputil_protocol protocol,
2005                          enum nx_packet_in_format packet_in_format)
2006 {
2007     size_t send_len = MIN(pin->send_len, pin->packet_len);
2008     struct ofpbuf *packet;
2009
2010     /* Add OFPT_PACKET_IN. */
2011     if (protocol == OFPUTIL_P_OF12) {
2012         struct ofp12_packet_in *opi;
2013         struct cls_rule rule;
2014
2015         ofputil_packet_in_to_rule(pin, &rule);
2016
2017         /* The final argument is just an estimate of the space required. */
2018         packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2019                                   htonl(0), (sizeof(struct flow_metadata) * 2
2020                                              + 2 + send_len));
2021         ofpbuf_put_zeros(packet, sizeof *opi);
2022         oxm_put_match(packet, &rule);
2023         ofpbuf_put_zeros(packet, 2);
2024         ofpbuf_put(packet, pin->packet, send_len);
2025
2026         opi = packet->l3;
2027         opi->buffer_id = htonl(pin->buffer_id);
2028         opi->total_len = htons(pin->total_len);
2029         opi->reason = pin->reason;
2030         opi->table_id = pin->table_id;
2031    } else if (packet_in_format == NXPIF_OPENFLOW10) {
2032         struct ofp_packet_in *opi;
2033
2034         packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2035                                   htonl(0), send_len);
2036         opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2037         opi->total_len = htons(pin->total_len);
2038         opi->in_port = htons(pin->fmd.in_port);
2039         opi->reason = pin->reason;
2040         opi->buffer_id = htonl(pin->buffer_id);
2041
2042         ofpbuf_put(packet, pin->packet, send_len);
2043     } else if (packet_in_format == NXPIF_NXM) {
2044         struct nx_packet_in *npi;
2045         struct cls_rule rule;
2046         size_t match_len;
2047
2048         ofputil_packet_in_to_rule(pin, &rule);
2049
2050         /* The final argument is just an estimate of the space required. */
2051         packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2052                                   htonl(0), (sizeof(struct flow_metadata) * 2
2053                                              + 2 + send_len));
2054         ofpbuf_put_zeros(packet, sizeof *npi);
2055         match_len = nx_put_match(packet, &rule, 0, 0);
2056         ofpbuf_put_zeros(packet, 2);
2057         ofpbuf_put(packet, pin->packet, send_len);
2058
2059         npi = packet->l3;
2060         npi->buffer_id = htonl(pin->buffer_id);
2061         npi->total_len = htons(pin->total_len);
2062         npi->reason = pin->reason;
2063         npi->table_id = pin->table_id;
2064         npi->cookie = pin->cookie;
2065         npi->match_len = htons(match_len);
2066     } else {
2067         NOT_REACHED();
2068     }
2069     ofpmsg_update_length(packet);
2070
2071     return packet;
2072 }
2073
2074 const char *
2075 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2076 {
2077     static char s[INT_STRLEN(int) + 1];
2078
2079     switch (reason) {
2080     case OFPR_NO_MATCH:
2081         return "no_match";
2082     case OFPR_ACTION:
2083         return "action";
2084     case OFPR_INVALID_TTL:
2085         return "invalid_ttl";
2086
2087     case OFPR_N_REASONS:
2088     default:
2089         sprintf(s, "%d", (int) reason);
2090         return s;
2091     }
2092 }
2093
2094 bool
2095 ofputil_packet_in_reason_from_string(const char *s,
2096                                      enum ofp_packet_in_reason *reason)
2097 {
2098     int i;
2099
2100     for (i = 0; i < OFPR_N_REASONS; i++) {
2101         if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2102             *reason = i;
2103             return true;
2104         }
2105     }
2106     return false;
2107 }
2108
2109 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2110  * 'po'.
2111  *
2112  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2113  * message's actions.  The caller must initialize 'ofpacts' and retains
2114  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
2115  *
2116  * Returns 0 if successful, otherwise an OFPERR_* value. */
2117 enum ofperr
2118 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2119                           const struct ofp_header *oh,
2120                           struct ofpbuf *ofpacts)
2121 {
2122     const struct ofp_packet_out *opo;
2123     enum ofperr error;
2124     enum ofpraw raw;
2125     struct ofpbuf b;
2126
2127     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2128     raw = ofpraw_pull_assert(&b);
2129     assert(raw == OFPRAW_OFPT10_PACKET_OUT);
2130
2131     opo = ofpbuf_pull(&b, sizeof *opo);
2132     po->buffer_id = ntohl(opo->buffer_id);
2133     po->in_port = ntohs(opo->in_port);
2134     if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2135         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2136         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2137                      po->in_port);
2138         return OFPERR_NXBRC_BAD_IN_PORT;
2139     }
2140
2141     error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2142     if (error) {
2143         return error;
2144     }
2145     po->ofpacts = ofpacts->data;
2146     po->ofpacts_len = ofpacts->size;
2147
2148     if (po->buffer_id == UINT32_MAX) {
2149         po->packet = b.data;
2150         po->packet_len = b.size;
2151     } else {
2152         po->packet = NULL;
2153         po->packet_len = 0;
2154     }
2155
2156     return 0;
2157 }
2158 \f
2159 /* ofputil_phy_port */
2160
2161 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2162 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
2163 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
2164 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
2165 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
2166 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
2167 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
2168 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
2169
2170 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2171 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2172 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2173 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2174 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2175 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2176
2177 static enum netdev_features
2178 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2179 {
2180     uint32_t ofp10 = ntohl(ofp10_);
2181     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2182 }
2183
2184 static ovs_be32
2185 netdev_port_features_to_ofp10(enum netdev_features features)
2186 {
2187     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2188 }
2189
2190 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
2191 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
2192 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
2193 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
2194 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
2195 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
2196 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
2197 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
2198 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
2199 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
2200 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
2201 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
2202 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
2203 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
2204 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
2205 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2206
2207 static enum netdev_features
2208 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2209 {
2210     return ntohl(ofp11) & 0xffff;
2211 }
2212
2213 static ovs_be32
2214 netdev_port_features_to_ofp11(enum netdev_features features)
2215 {
2216     return htonl(features & 0xffff);
2217 }
2218
2219 static enum ofperr
2220 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2221                               const struct ofp10_phy_port *opp)
2222 {
2223     memset(pp, 0, sizeof *pp);
2224
2225     pp->port_no = ntohs(opp->port_no);
2226     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2227     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2228
2229     pp->config = ntohl(opp->config) & OFPPC10_ALL;
2230     pp->state = ntohl(opp->state) & OFPPS10_ALL;
2231
2232     pp->curr = netdev_port_features_from_ofp10(opp->curr);
2233     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2234     pp->supported = netdev_port_features_from_ofp10(opp->supported);
2235     pp->peer = netdev_port_features_from_ofp10(opp->peer);
2236
2237     pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2238     pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2239
2240     return 0;
2241 }
2242
2243 static enum ofperr
2244 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2245                           const struct ofp11_port *op)
2246 {
2247     enum ofperr error;
2248
2249     memset(pp, 0, sizeof *pp);
2250
2251     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2252     if (error) {
2253         return error;
2254     }
2255     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2256     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2257
2258     pp->config = ntohl(op->config) & OFPPC11_ALL;
2259     pp->state = ntohl(op->state) & OFPPC11_ALL;
2260
2261     pp->curr = netdev_port_features_from_ofp11(op->curr);
2262     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2263     pp->supported = netdev_port_features_from_ofp11(op->supported);
2264     pp->peer = netdev_port_features_from_ofp11(op->peer);
2265
2266     pp->curr_speed = ntohl(op->curr_speed);
2267     pp->max_speed = ntohl(op->max_speed);
2268
2269     return 0;
2270 }
2271
2272 static size_t
2273 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2274 {
2275     switch (ofp_version) {
2276     case OFP10_VERSION:
2277         return sizeof(struct ofp10_phy_port);
2278     case OFP11_VERSION:
2279     case OFP12_VERSION:
2280         return sizeof(struct ofp11_port);
2281     default:
2282         NOT_REACHED();
2283     }
2284 }
2285
2286 static void
2287 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2288                               struct ofp10_phy_port *opp)
2289 {
2290     memset(opp, 0, sizeof *opp);
2291
2292     opp->port_no = htons(pp->port_no);
2293     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2294     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2295
2296     opp->config = htonl(pp->config & OFPPC10_ALL);
2297     opp->state = htonl(pp->state & OFPPS10_ALL);
2298
2299     opp->curr = netdev_port_features_to_ofp10(pp->curr);
2300     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2301     opp->supported = netdev_port_features_to_ofp10(pp->supported);
2302     opp->peer = netdev_port_features_to_ofp10(pp->peer);
2303 }
2304
2305 static void
2306 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2307                           struct ofp11_port *op)
2308 {
2309     memset(op, 0, sizeof *op);
2310
2311     op->port_no = ofputil_port_to_ofp11(pp->port_no);
2312     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2313     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2314
2315     op->config = htonl(pp->config & OFPPC11_ALL);
2316     op->state = htonl(pp->state & OFPPS11_ALL);
2317
2318     op->curr = netdev_port_features_to_ofp11(pp->curr);
2319     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2320     op->supported = netdev_port_features_to_ofp11(pp->supported);
2321     op->peer = netdev_port_features_to_ofp11(pp->peer);
2322
2323     op->curr_speed = htonl(pp->curr_speed);
2324     op->max_speed = htonl(pp->max_speed);
2325 }
2326
2327 static void
2328 ofputil_put_phy_port(enum ofp_version ofp_version,
2329                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
2330 {
2331     switch (ofp_version) {
2332     case OFP10_VERSION: {
2333         struct ofp10_phy_port *opp;
2334         if (b->size + sizeof *opp <= UINT16_MAX) {
2335             opp = ofpbuf_put_uninit(b, sizeof *opp);
2336             ofputil_encode_ofp10_phy_port(pp, opp);
2337         }
2338         break;
2339     }
2340
2341     case OFP11_VERSION:
2342     case OFP12_VERSION: {
2343         struct ofp11_port *op;
2344         if (b->size + sizeof *op <= UINT16_MAX) {
2345             op = ofpbuf_put_uninit(b, sizeof *op);
2346             ofputil_encode_ofp11_port(pp, op);
2347         }
2348         break;
2349     }
2350
2351     default:
2352         NOT_REACHED();
2353     }
2354 }
2355
2356 void
2357 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2358                                      const struct ofputil_phy_port *pp,
2359                                      struct list *replies)
2360 {
2361     switch (ofp_version) {
2362     case OFP10_VERSION: {
2363         struct ofp10_phy_port *opp;
2364
2365         opp = ofpmp_append(replies, sizeof *opp);
2366         ofputil_encode_ofp10_phy_port(pp, opp);
2367         break;
2368     }
2369
2370     case OFP11_VERSION:
2371     case OFP12_VERSION: {
2372         struct ofp11_port *op;
2373
2374         op = ofpmp_append(replies, sizeof *op);
2375         ofputil_encode_ofp11_port(pp, op);
2376         break;
2377     }
2378
2379     default:
2380       NOT_REACHED();
2381     }
2382 }
2383 \f
2384 /* ofputil_switch_features */
2385
2386 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2387                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
2388 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2389 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2390 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2391 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2392 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2393 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2394
2395 struct ofputil_action_bit_translation {
2396     enum ofputil_action_bitmap ofputil_bit;
2397     int of_bit;
2398 };
2399
2400 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2401     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
2402     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2403     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2404     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
2405     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
2406     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
2407     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
2408     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
2409     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
2410     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
2411     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
2412     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
2413     { 0, 0 },
2414 };
2415
2416 static enum ofputil_action_bitmap
2417 decode_action_bits(ovs_be32 of_actions,
2418                    const struct ofputil_action_bit_translation *x)
2419 {
2420     enum ofputil_action_bitmap ofputil_actions;
2421
2422     ofputil_actions = 0;
2423     for (; x->ofputil_bit; x++) {
2424         if (of_actions & htonl(1u << x->of_bit)) {
2425             ofputil_actions |= x->ofputil_bit;
2426         }
2427     }
2428     return ofputil_actions;
2429 }
2430
2431 static uint32_t
2432 ofputil_capabilities_mask(enum ofp_version ofp_version)
2433 {
2434     /* Handle capabilities whose bit is unique for all Open Flow versions */
2435     switch (ofp_version) {
2436     case OFP10_VERSION:
2437     case OFP11_VERSION:
2438         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2439     case OFP12_VERSION:
2440         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2441     default:
2442         /* Caller needs to check osf->header.version itself */
2443         return 0;
2444     }
2445 }
2446
2447 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2448  * abstract representation in '*features'.  Initializes '*b' to iterate over
2449  * the OpenFlow port structures following 'osf' with later calls to
2450  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
2451  * OFPERR_* value.  */
2452 enum ofperr
2453 ofputil_decode_switch_features(const struct ofp_header *oh,
2454                                struct ofputil_switch_features *features,
2455                                struct ofpbuf *b)
2456 {
2457     const struct ofp_switch_features *osf;
2458     enum ofpraw raw;
2459
2460     ofpbuf_use_const(b, oh, ntohs(oh->length));
2461     raw = ofpraw_pull_assert(b);
2462
2463     osf = ofpbuf_pull(b, sizeof *osf);
2464     features->datapath_id = ntohll(osf->datapath_id);
2465     features->n_buffers = ntohl(osf->n_buffers);
2466     features->n_tables = osf->n_tables;
2467
2468     features->capabilities = ntohl(osf->capabilities) &
2469         ofputil_capabilities_mask(oh->version);
2470
2471     if (b->size % ofputil_get_phy_port_size(oh->version)) {
2472         return OFPERR_OFPBRC_BAD_LEN;
2473     }
2474
2475     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2476         if (osf->capabilities & htonl(OFPC10_STP)) {
2477             features->capabilities |= OFPUTIL_C_STP;
2478         }
2479         features->actions = decode_action_bits(osf->actions, of10_action_bits);
2480     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2481         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2482             features->capabilities |= OFPUTIL_C_GROUP_STATS;
2483         }
2484         features->actions = 0;
2485     } else {
2486         return OFPERR_OFPBRC_BAD_VERSION;
2487     }
2488
2489     return 0;
2490 }
2491
2492 /* Returns true if the maximum number of ports are in 'oh'. */
2493 static bool
2494 max_ports_in_features(const struct ofp_header *oh)
2495 {
2496     size_t pp_size = ofputil_get_phy_port_size(oh->version);
2497     return ntohs(oh->length) + pp_size > UINT16_MAX;
2498 }
2499
2500 /* Given a buffer 'b' that contains a Features Reply message, checks if
2501  * it contains the maximum number of ports that will fit.  If so, it
2502  * returns true and removes the ports from the message.  The caller
2503  * should then send an OFPST_PORT_DESC stats request to get the ports,
2504  * since the switch may have more ports than could be represented in the
2505  * Features Reply.  Otherwise, returns false.
2506  */
2507 bool
2508 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2509 {
2510     struct ofp_header *oh = b->data;
2511
2512     if (max_ports_in_features(oh)) {
2513         /* Remove all the ports. */
2514         b->size = (sizeof(struct ofp_header)
2515                    + sizeof(struct ofp_switch_features));
2516         ofpmsg_update_length(b);
2517
2518         return true;
2519     }
2520
2521     return false;
2522 }
2523
2524 static ovs_be32
2525 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2526                    const struct ofputil_action_bit_translation *x)
2527 {
2528     uint32_t of_actions;
2529
2530     of_actions = 0;
2531     for (; x->ofputil_bit; x++) {
2532         if (ofputil_actions & x->ofputil_bit) {
2533             of_actions |= 1 << x->of_bit;
2534         }
2535     }
2536     return htonl(of_actions);
2537 }
2538
2539 /* Returns a buffer owned by the caller that encodes 'features' in the format
2540  * required by 'protocol' with the given 'xid'.  The caller should append port
2541  * information to the buffer with subsequent calls to
2542  * ofputil_put_switch_features_port(). */
2543 struct ofpbuf *
2544 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2545                                enum ofputil_protocol protocol, ovs_be32 xid)
2546 {
2547     struct ofp_switch_features *osf;
2548     struct ofpbuf *b;
2549     enum ofp_version version;
2550     enum ofpraw raw;
2551
2552     version = ofputil_protocol_to_ofp_version(protocol);
2553     switch (version) {
2554     case OFP10_VERSION:
2555         raw = OFPRAW_OFPT10_FEATURES_REPLY;
2556         break;
2557     case OFP11_VERSION:
2558     case OFP12_VERSION:
2559         raw = OFPRAW_OFPT11_FEATURES_REPLY;
2560         break;
2561     default:
2562         NOT_REACHED();
2563     }
2564     b = ofpraw_alloc_xid(raw, version, xid, 0);
2565     osf = ofpbuf_put_zeros(b, sizeof *osf);
2566     osf->datapath_id = htonll(features->datapath_id);
2567     osf->n_buffers = htonl(features->n_buffers);
2568     osf->n_tables = features->n_tables;
2569
2570     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2571     osf->capabilities = htonl(features->capabilities &
2572                               ofputil_capabilities_mask(version));
2573     switch (version) {
2574     case OFP10_VERSION:
2575         if (features->capabilities & OFPUTIL_C_STP) {
2576             osf->capabilities |= htonl(OFPC10_STP);
2577         }
2578         osf->actions = encode_action_bits(features->actions, of10_action_bits);
2579         break;
2580     case OFP11_VERSION:
2581     case OFP12_VERSION:
2582         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2583             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2584         }
2585         break;
2586     default:
2587         NOT_REACHED();
2588     }
2589
2590     return b;
2591 }
2592
2593 /* Encodes 'pp' into the format required by the switch_features message already
2594  * in 'b', which should have been returned by ofputil_encode_switch_features(),
2595  * and appends the encoded version to 'b'. */
2596 void
2597 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2598                                  struct ofpbuf *b)
2599 {
2600     const struct ofp_header *oh = b->data;
2601
2602     ofputil_put_phy_port(oh->version, pp, b);
2603 }
2604 \f
2605 /* ofputil_port_status */
2606
2607 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2608  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2609 enum ofperr
2610 ofputil_decode_port_status(const struct ofp_header *oh,
2611                            struct ofputil_port_status *ps)
2612 {
2613     const struct ofp_port_status *ops;
2614     struct ofpbuf b;
2615     int retval;
2616
2617     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2618     ofpraw_pull_assert(&b);
2619     ops = ofpbuf_pull(&b, sizeof *ops);
2620
2621     if (ops->reason != OFPPR_ADD &&
2622         ops->reason != OFPPR_DELETE &&
2623         ops->reason != OFPPR_MODIFY) {
2624         return OFPERR_NXBRC_BAD_REASON;
2625     }
2626     ps->reason = ops->reason;
2627
2628     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
2629     assert(retval != EOF);
2630     return retval;
2631 }
2632
2633 /* Converts the abstract form of a "port status" message in '*ps' into an
2634  * OpenFlow message suitable for 'protocol', and returns that encoded form in
2635  * a buffer owned by the caller. */
2636 struct ofpbuf *
2637 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2638                            enum ofputil_protocol protocol)
2639 {
2640     struct ofp_port_status *ops;
2641     struct ofpbuf *b;
2642     enum ofp_version version;
2643     enum ofpraw raw;
2644
2645     version = ofputil_protocol_to_ofp_version(protocol);
2646     switch (version) {
2647     case OFP10_VERSION:
2648         raw = OFPRAW_OFPT10_PORT_STATUS;
2649         break;
2650
2651     case OFP11_VERSION:
2652     case OFP12_VERSION:
2653         raw = OFPRAW_OFPT11_PORT_STATUS;
2654         break;
2655
2656     default:
2657         NOT_REACHED();
2658     }
2659
2660     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
2661     ops = ofpbuf_put_zeros(b, sizeof *ops);
2662     ops->reason = ps->reason;
2663     ofputil_put_phy_port(version, &ps->desc, b);
2664     ofpmsg_update_length(b);
2665     return b;
2666 }
2667 \f
2668 /* ofputil_port_mod */
2669
2670 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2671  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
2672 enum ofperr
2673 ofputil_decode_port_mod(const struct ofp_header *oh,
2674                         struct ofputil_port_mod *pm)
2675 {
2676     enum ofpraw raw;
2677     struct ofpbuf b;
2678
2679     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2680     raw = ofpraw_pull_assert(&b);
2681
2682     if (raw == OFPRAW_OFPT10_PORT_MOD) {
2683         const struct ofp10_port_mod *opm = b.data;
2684
2685         pm->port_no = ntohs(opm->port_no);
2686         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2687         pm->config = ntohl(opm->config) & OFPPC10_ALL;
2688         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2689         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2690     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
2691         const struct ofp11_port_mod *opm = b.data;
2692         enum ofperr error;
2693
2694         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2695         if (error) {
2696             return error;
2697         }
2698
2699         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2700         pm->config = ntohl(opm->config) & OFPPC11_ALL;
2701         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2702         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2703     } else {
2704         return OFPERR_OFPBRC_BAD_TYPE;
2705     }
2706
2707     pm->config &= pm->mask;
2708     return 0;
2709 }
2710
2711 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2712  * message suitable for 'protocol', and returns that encoded form in a buffer
2713  * owned by the caller. */
2714 struct ofpbuf *
2715 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2716                         enum ofputil_protocol protocol)
2717 {
2718     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
2719     struct ofpbuf *b;
2720
2721     switch (ofp_version) {
2722     case OFP10_VERSION: {
2723         struct ofp10_port_mod *opm;
2724
2725         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
2726         opm = ofpbuf_put_zeros(b, sizeof *opm);
2727         opm->port_no = htons(pm->port_no);
2728         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2729         opm->config = htonl(pm->config & OFPPC10_ALL);
2730         opm->mask = htonl(pm->mask & OFPPC10_ALL);
2731         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2732         break;
2733     }
2734
2735     case OFP11_VERSION: {
2736         struct ofp11_port_mod *opm;
2737
2738         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
2739         opm = ofpbuf_put_zeros(b, sizeof *opm);
2740         opm->port_no = htonl(pm->port_no);
2741         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2742         opm->config = htonl(pm->config & OFPPC11_ALL);
2743         opm->mask = htonl(pm->mask & OFPPC11_ALL);
2744         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2745         break;
2746     }
2747
2748     case OFP12_VERSION:
2749     default:
2750         NOT_REACHED();
2751     }
2752
2753     return b;
2754 }
2755 \f
2756 /* ofputil_flow_monitor_request */
2757
2758 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
2759  * ofputil_flow_monitor_request in 'rq'.
2760  *
2761  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
2762  * message.  Calling this function multiple times for a single 'msg' iterates
2763  * through the requests.  The caller must initially leave 'msg''s layer
2764  * pointers null and not modify them between calls.
2765  *
2766  * Returns 0 if successful, EOF if no requests were left in this 'msg',
2767  * otherwise an OFPERR_* value. */
2768 int
2769 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
2770                                     struct ofpbuf *msg)
2771 {
2772     struct nx_flow_monitor_request *nfmr;
2773     uint16_t flags;
2774
2775     if (!msg->l2) {
2776         msg->l2 = msg->data;
2777         ofpraw_pull_assert(msg);
2778     }
2779
2780     if (!msg->size) {
2781         return EOF;
2782     }
2783
2784     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
2785     if (!nfmr) {
2786         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
2787                      "leftover bytes at end", msg->size);
2788         return OFPERR_OFPBRC_BAD_LEN;
2789     }
2790
2791     flags = ntohs(nfmr->flags);
2792     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
2793         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
2794                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
2795         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
2796                      flags);
2797         return OFPERR_NXBRC_FM_BAD_FLAGS;
2798     }
2799
2800     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
2801         return OFPERR_NXBRC_MUST_BE_ZERO;
2802     }
2803
2804     rq->id = ntohl(nfmr->id);
2805     rq->flags = flags;
2806     rq->out_port = ntohs(nfmr->out_port);
2807     rq->table_id = nfmr->table_id;
2808
2809     return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
2810                          &rq->match, NULL, NULL);
2811 }
2812
2813 void
2814 ofputil_append_flow_monitor_request(
2815     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
2816 {
2817     struct nx_flow_monitor_request *nfmr;
2818     size_t start_ofs;
2819     int match_len;
2820
2821     if (!msg->size) {
2822         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
2823     }
2824
2825     start_ofs = msg->size;
2826     ofpbuf_put_zeros(msg, sizeof *nfmr);
2827     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
2828
2829     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
2830     nfmr->id = htonl(rq->id);
2831     nfmr->flags = htons(rq->flags);
2832     nfmr->out_port = htons(rq->out_port);
2833     nfmr->match_len = htons(match_len);
2834     nfmr->table_id = rq->table_id;
2835 }
2836
2837 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
2838  * into an abstract ofputil_flow_update in 'update'.  The caller must have
2839  * initialized update->match to point to space allocated for a cls_rule.
2840  *
2841  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
2842  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
2843  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
2844  * will point into the 'ofpacts' buffer.
2845  *
2846  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
2847  * this function multiple times for a single 'msg' iterates through the
2848  * updates.  The caller must initially leave 'msg''s layer pointers null and
2849  * not modify them between calls.
2850  *
2851  * Returns 0 if successful, EOF if no updates were left in this 'msg',
2852  * otherwise an OFPERR_* value. */
2853 int
2854 ofputil_decode_flow_update(struct ofputil_flow_update *update,
2855                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
2856 {
2857     struct nx_flow_update_header *nfuh;
2858     unsigned int length;
2859
2860     if (!msg->l2) {
2861         msg->l2 = msg->data;
2862         ofpraw_pull_assert(msg);
2863     }
2864
2865     if (!msg->size) {
2866         return EOF;
2867     }
2868
2869     if (msg->size < sizeof(struct nx_flow_update_header)) {
2870         goto bad_len;
2871     }
2872
2873     nfuh = msg->data;
2874     update->event = ntohs(nfuh->event);
2875     length = ntohs(nfuh->length);
2876     if (length > msg->size || length % 8) {
2877         goto bad_len;
2878     }
2879
2880     if (update->event == NXFME_ABBREV) {
2881         struct nx_flow_update_abbrev *nfua;
2882
2883         if (length != sizeof *nfua) {
2884             goto bad_len;
2885         }
2886
2887         nfua = ofpbuf_pull(msg, sizeof *nfua);
2888         update->xid = nfua->xid;
2889         return 0;
2890     } else if (update->event == NXFME_ADDED
2891                || update->event == NXFME_DELETED
2892                || update->event == NXFME_MODIFIED) {
2893         struct nx_flow_update_full *nfuf;
2894         unsigned int actions_len;
2895         unsigned int match_len;
2896         enum ofperr error;
2897
2898         if (length < sizeof *nfuf) {
2899             goto bad_len;
2900         }
2901
2902         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
2903         match_len = ntohs(nfuf->match_len);
2904         if (sizeof *nfuf + match_len > length) {
2905             goto bad_len;
2906         }
2907
2908         update->reason = ntohs(nfuf->reason);
2909         update->idle_timeout = ntohs(nfuf->idle_timeout);
2910         update->hard_timeout = ntohs(nfuf->hard_timeout);
2911         update->table_id = nfuf->table_id;
2912         update->cookie = nfuf->cookie;
2913
2914         error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
2915                               update->match, NULL, NULL);
2916         if (error) {
2917             return error;
2918         }
2919
2920         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
2921         error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
2922         if (error) {
2923             return error;
2924         }
2925
2926         update->ofpacts = ofpacts->data;
2927         update->ofpacts_len = ofpacts->size;
2928         return 0;
2929     } else {
2930         VLOG_WARN_RL(&bad_ofmsg_rl,
2931                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
2932                      ntohs(nfuh->event));
2933         return OFPERR_OFPET_BAD_REQUEST;
2934     }
2935
2936 bad_len:
2937     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
2938                  "leftover bytes at end", msg->size);
2939     return OFPERR_OFPBRC_BAD_LEN;
2940 }
2941
2942 uint32_t
2943 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
2944 {
2945     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
2946
2947     return ntohl(cancel->id);
2948 }
2949
2950 struct ofpbuf *
2951 ofputil_encode_flow_monitor_cancel(uint32_t id)
2952 {
2953     struct nx_flow_monitor_cancel *nfmc;
2954     struct ofpbuf *msg;
2955
2956     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
2957     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
2958     nfmc->id = htonl(id);
2959     return msg;
2960 }
2961
2962 void
2963 ofputil_start_flow_update(struct list *replies)
2964 {
2965     struct ofpbuf *msg;
2966
2967     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
2968                            htonl(0), 1024);
2969
2970     list_init(replies);
2971     list_push_back(replies, &msg->list_node);
2972 }
2973
2974 void
2975 ofputil_append_flow_update(const struct ofputil_flow_update *update,
2976                            struct list *replies)
2977 {
2978     struct nx_flow_update_header *nfuh;
2979     struct ofpbuf *msg;
2980     size_t start_ofs;
2981
2982     msg = ofpbuf_from_list(list_back(replies));
2983     start_ofs = msg->size;
2984
2985     if (update->event == NXFME_ABBREV) {
2986         struct nx_flow_update_abbrev *nfua;
2987
2988         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
2989         nfua->xid = update->xid;
2990     } else {
2991         struct nx_flow_update_full *nfuf;
2992         int match_len;
2993
2994         ofpbuf_put_zeros(msg, sizeof *nfuf);
2995         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
2996         ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
2997
2998         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
2999         nfuf->reason = htons(update->reason);
3000         nfuf->priority = htons(update->match->priority);
3001         nfuf->idle_timeout = htons(update->idle_timeout);
3002         nfuf->hard_timeout = htons(update->hard_timeout);
3003         nfuf->match_len = htons(match_len);
3004         nfuf->table_id = update->table_id;
3005         nfuf->cookie = update->cookie;
3006     }
3007
3008     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3009     nfuh->length = htons(msg->size - start_ofs);
3010     nfuh->event = htons(update->event);
3011
3012     ofpmp_postappend(replies, start_ofs);
3013 }
3014 \f
3015 struct ofpbuf *
3016 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
3017 {
3018     struct ofp_packet_out *opo;
3019     size_t actions_ofs;
3020     struct ofpbuf *msg;
3021     size_t size;
3022
3023     size = po->ofpacts_len;
3024     if (po->buffer_id == UINT32_MAX) {
3025         size += po->packet_len;
3026     }
3027
3028     msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3029     ofpbuf_put_zeros(msg, sizeof *opo);
3030     actions_ofs = msg->size;
3031     ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3032
3033     opo = msg->l3;
3034     opo->buffer_id = htonl(po->buffer_id);
3035     opo->in_port = htons(po->in_port);
3036     opo->actions_len = htons(msg->size - actions_ofs);
3037
3038     if (po->buffer_id == UINT32_MAX) {
3039         ofpbuf_put(msg, po->packet, po->packet_len);
3040     }
3041
3042     ofpmsg_update_length(msg);
3043
3044     return msg;
3045 }
3046 \f
3047 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3048 struct ofpbuf *
3049 make_echo_request(enum ofp_version ofp_version)
3050 {
3051     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3052                             htonl(0), 0);
3053 }
3054
3055 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3056  * OFPT_ECHO_REQUEST message in 'rq'. */
3057 struct ofpbuf *
3058 make_echo_reply(const struct ofp_header *rq)
3059 {
3060     struct ofpbuf rq_buf;
3061     struct ofpbuf *reply;
3062
3063     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3064     ofpraw_pull_assert(&rq_buf);
3065
3066     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3067     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3068     return reply;
3069 }
3070
3071 struct ofpbuf *
3072 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3073 {
3074     enum ofpraw type;
3075
3076     switch (ofp_version) {
3077     case OFP12_VERSION:
3078     case OFP11_VERSION:
3079         type = OFPRAW_OFPT11_BARRIER_REQUEST;
3080         break;
3081
3082     case OFP10_VERSION:
3083         type = OFPRAW_OFPT10_BARRIER_REQUEST;
3084         break;
3085
3086     default:
3087         NOT_REACHED();
3088     }
3089
3090     return ofpraw_alloc(type, ofp_version, 0);
3091 }
3092
3093 const char *
3094 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3095 {
3096     switch (flags & OFPC_FRAG_MASK) {
3097     case OFPC_FRAG_NORMAL:   return "normal";
3098     case OFPC_FRAG_DROP:     return "drop";
3099     case OFPC_FRAG_REASM:    return "reassemble";
3100     case OFPC_FRAG_NX_MATCH: return "nx-match";
3101     }
3102
3103     NOT_REACHED();
3104 }
3105
3106 bool
3107 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3108 {
3109     if (!strcasecmp(s, "normal")) {
3110         *flags = OFPC_FRAG_NORMAL;
3111     } else if (!strcasecmp(s, "drop")) {
3112         *flags = OFPC_FRAG_DROP;
3113     } else if (!strcasecmp(s, "reassemble")) {
3114         *flags = OFPC_FRAG_REASM;
3115     } else if (!strcasecmp(s, "nx-match")) {
3116         *flags = OFPC_FRAG_NX_MATCH;
3117     } else {
3118         return false;
3119     }
3120     return true;
3121 }
3122
3123 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3124  * port number and stores the latter in '*ofp10_port', for the purpose of
3125  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
3126  * otherwise an OFPERR_* number.
3127  *
3128  * See the definition of OFP11_MAX for an explanation of the mapping. */
3129 enum ofperr
3130 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3131 {
3132     uint32_t ofp11_port_h = ntohl(ofp11_port);
3133
3134     if (ofp11_port_h < OFPP_MAX) {
3135         *ofp10_port = ofp11_port_h;
3136         return 0;
3137     } else if (ofp11_port_h >= OFPP11_MAX) {
3138         *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3139         return 0;
3140     } else {
3141         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3142                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3143                      ofp11_port_h, OFPP_MAX - 1,
3144                      (uint32_t) OFPP11_MAX, UINT32_MAX);
3145         return OFPERR_OFPBAC_BAD_OUT_PORT;
3146     }
3147 }
3148
3149 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3150  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3151  *
3152  * See the definition of OFP11_MAX for an explanation of the mapping. */
3153 ovs_be32
3154 ofputil_port_to_ofp11(uint16_t ofp10_port)
3155 {
3156     return htonl(ofp10_port < OFPP_MAX
3157                  ? ofp10_port
3158                  : ofp10_port + OFPP11_OFFSET);
3159 }
3160
3161 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3162  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
3163  * 'port' is valid, otherwise an OpenFlow return code. */
3164 enum ofperr
3165 ofputil_check_output_port(uint16_t port, int max_ports)
3166 {
3167     switch (port) {
3168     case OFPP_IN_PORT:
3169     case OFPP_TABLE:
3170     case OFPP_NORMAL:
3171     case OFPP_FLOOD:
3172     case OFPP_ALL:
3173     case OFPP_CONTROLLER:
3174     case OFPP_NONE:
3175     case OFPP_LOCAL:
3176         return 0;
3177
3178     default:
3179         if (port < max_ports) {
3180             return 0;
3181         }
3182         return OFPERR_OFPBAC_BAD_OUT_PORT;
3183     }
3184 }
3185
3186 #define OFPUTIL_NAMED_PORTS                     \
3187         OFPUTIL_NAMED_PORT(IN_PORT)             \
3188         OFPUTIL_NAMED_PORT(TABLE)               \
3189         OFPUTIL_NAMED_PORT(NORMAL)              \
3190         OFPUTIL_NAMED_PORT(FLOOD)               \
3191         OFPUTIL_NAMED_PORT(ALL)                 \
3192         OFPUTIL_NAMED_PORT(CONTROLLER)          \
3193         OFPUTIL_NAMED_PORT(LOCAL)               \
3194         OFPUTIL_NAMED_PORT(NONE)
3195
3196 /* Checks whether 's' is the string representation of an OpenFlow port number,
3197  * either as an integer or a string name (e.g. "LOCAL").  If it is, stores the
3198  * number in '*port' and returns true.  Otherwise, returns false. */
3199 bool
3200 ofputil_port_from_string(const char *name, uint16_t *port)
3201 {
3202     struct pair {
3203         const char *name;
3204         uint16_t value;
3205     };
3206     static const struct pair pairs[] = {
3207 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3208         OFPUTIL_NAMED_PORTS
3209 #undef OFPUTIL_NAMED_PORT
3210     };
3211     static const int n_pairs = ARRAY_SIZE(pairs);
3212     int i;
3213
3214     if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3215         *port = i;
3216         return true;
3217     }
3218
3219     for (i = 0; i < n_pairs; i++) {
3220         if (!strcasecmp(name, pairs[i].name)) {
3221             *port = pairs[i].value;
3222             return true;
3223         }
3224     }
3225     return false;
3226 }
3227
3228 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3229  * Most ports' string representation is just the port number, but for special
3230  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3231 void
3232 ofputil_format_port(uint16_t port, struct ds *s)
3233 {
3234     const char *name;
3235
3236     switch (port) {
3237 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3238         OFPUTIL_NAMED_PORTS
3239 #undef OFPUTIL_NAMED_PORT
3240
3241     default:
3242         ds_put_format(s, "%"PRIu16, port);
3243         return;
3244     }
3245     ds_put_cstr(s, name);
3246 }
3247
3248 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3249  * 'ofp_version', tries to pull the first element from the array.  If
3250  * successful, initializes '*pp' with an abstract representation of the
3251  * port and returns 0.  If no ports remain to be decoded, returns EOF.
3252  * On an error, returns a positive OFPERR_* value. */
3253 int
3254 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3255                       struct ofputil_phy_port *pp)
3256 {
3257     switch (ofp_version) {
3258     case OFP10_VERSION: {
3259         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3260         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3261     }
3262     case OFP11_VERSION:
3263     case OFP12_VERSION: {
3264         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3265         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3266     }
3267     default:
3268         NOT_REACHED();
3269     }
3270 }
3271
3272 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3273  * 'ofp_version', returns the number of elements. */
3274 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3275 {
3276     return b->size / ofputil_get_phy_port_size(ofp_version);
3277 }
3278
3279 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3280  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3281  * 'name' is not the name of any action.
3282  *
3283  * ofp-util.def lists the mapping from names to action. */
3284 int
3285 ofputil_action_code_from_name(const char *name)
3286 {
3287     static const char *names[OFPUTIL_N_ACTIONS] = {
3288         NULL,
3289 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)           NAME,
3290 #define OFPAT11_ACTION(ENUM, STRUCT, NAME)           NAME,
3291 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3292 #include "ofp-util.def"
3293     };
3294
3295     const char **p;
3296
3297     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3298         if (*p && !strcasecmp(name, *p)) {
3299             return p - names;
3300         }
3301     }
3302     return -1;
3303 }
3304
3305 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3306  * action.  Initializes the parts of 'action' that identify it as having type
3307  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
3308  * have variable length, the length used and cleared is that of struct
3309  * <STRUCT>.  */
3310 void *
3311 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3312 {
3313     switch (code) {
3314     case OFPUTIL_ACTION_INVALID:
3315         NOT_REACHED();
3316
3317 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                    \
3318     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3319 #define OFPAT11_ACTION OFPAT10_ACTION
3320 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
3321     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3322 #include "ofp-util.def"
3323     }
3324     NOT_REACHED();
3325 }
3326
3327 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
3328     void                                                        \
3329     ofputil_init_##ENUM(struct STRUCT *s)                       \
3330     {                                                           \
3331         memset(s, 0, sizeof *s);                                \
3332         s->type = htons(ENUM);                                  \
3333         s->len = htons(sizeof *s);                              \
3334     }                                                           \
3335                                                                 \
3336     struct STRUCT *                                             \
3337     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3338     {                                                           \
3339         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3340         ofputil_init_##ENUM(s);                                 \
3341         return s;                                               \
3342     }
3343 #define OFPAT11_ACTION OFPAT10_ACTION
3344 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3345     void                                                        \
3346     ofputil_init_##ENUM(struct STRUCT *s)                       \
3347     {                                                           \
3348         memset(s, 0, sizeof *s);                                \
3349         s->type = htons(OFPAT10_VENDOR);                        \
3350         s->len = htons(sizeof *s);                              \
3351         s->vendor = htonl(NX_VENDOR_ID);                        \
3352         s->subtype = htons(ENUM);                               \
3353     }                                                           \
3354                                                                 \
3355     struct STRUCT *                                             \
3356     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3357     {                                                           \
3358         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3359         ofputil_init_##ENUM(s);                                 \
3360         return s;                                               \
3361     }
3362 #include "ofp-util.def"
3363
3364 static void
3365 ofputil_normalize_rule__(struct cls_rule *rule, bool may_log)
3366 {
3367     enum {
3368         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
3369         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
3370         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
3371         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
3372         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
3373         MAY_ARP_THA     = 1 << 5, /* arp_tha */
3374         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3375         MAY_ND_TARGET   = 1 << 7  /* nd_target */
3376     } may_match;
3377
3378     struct flow_wildcards wc;
3379
3380     /* Figure out what fields may be matched. */
3381     if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3382         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3383         if (rule->flow.nw_proto == IPPROTO_TCP ||
3384             rule->flow.nw_proto == IPPROTO_UDP ||
3385             rule->flow.nw_proto == IPPROTO_ICMP) {
3386             may_match |= MAY_TP_ADDR;
3387         }
3388     } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3389         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3390         if (rule->flow.nw_proto == IPPROTO_TCP ||
3391             rule->flow.nw_proto == IPPROTO_UDP) {
3392             may_match |= MAY_TP_ADDR;
3393         } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3394             may_match |= MAY_TP_ADDR;
3395             if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3396                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3397             } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3398                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3399             }
3400         }
3401     } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3402         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3403     } else {
3404         may_match = 0;
3405     }
3406
3407     /* Clear the fields that may not be matched. */
3408     wc = rule->wc;
3409     if (!(may_match & MAY_NW_ADDR)) {
3410         wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3411     }
3412     if (!(may_match & MAY_TP_ADDR)) {
3413         wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3414     }
3415     if (!(may_match & MAY_NW_PROTO)) {
3416         wc.wildcards |= FWW_NW_PROTO;
3417     }
3418     if (!(may_match & MAY_IPVx)) {
3419         wc.wildcards |= FWW_NW_DSCP;
3420         wc.wildcards |= FWW_NW_ECN;
3421         wc.wildcards |= FWW_NW_TTL;
3422     }
3423     if (!(may_match & MAY_ARP_SHA)) {
3424         memset(wc.arp_sha_mask, 0, ETH_ADDR_LEN);
3425     }
3426     if (!(may_match & MAY_ARP_THA)) {
3427         memset(wc.arp_tha_mask, 0, ETH_ADDR_LEN);
3428     }
3429     if (!(may_match & MAY_IPV6)) {
3430         wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3431         wc.ipv6_label_mask = htonl(0);
3432     }
3433     if (!(may_match & MAY_ND_TARGET)) {
3434         wc.nd_target_mask = in6addr_any;
3435     }
3436
3437     /* Log any changes. */
3438     if (!flow_wildcards_equal(&wc, &rule->wc)) {
3439         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
3440         char *pre = log ? cls_rule_to_string(rule) : NULL;
3441
3442         rule->wc = wc;
3443         cls_rule_zero_wildcarded_fields(rule);
3444
3445         if (log) {
3446             char *post = cls_rule_to_string(rule);
3447             VLOG_INFO("normalization changed ofp_match, details:");
3448             VLOG_INFO(" pre: %s", pre);
3449             VLOG_INFO("post: %s", post);
3450             free(pre);
3451             free(post);
3452         }
3453     }
3454 }
3455
3456 /* "Normalizes" the wildcards in 'rule'.  That means:
3457  *
3458  *    1. If the type of level N is known, then only the valid fields for that
3459  *       level may be specified.  For example, ARP does not have a TOS field,
3460  *       so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3461  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3462  *       ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3463  *       IPv4 flow.
3464  *
3465  *    2. If the type of level N is not known (or not understood by Open
3466  *       vSwitch), then no fields at all for that level may be specified.  For
3467  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3468  *       L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3469  *       SCTP flow.
3470  *
3471  * If this function changes 'rule', it logs a rate-limited informational
3472  * message. */
3473 void
3474 ofputil_normalize_rule(struct cls_rule *rule)
3475 {
3476     ofputil_normalize_rule__(rule, true);
3477 }
3478
3479 /* Same as ofputil_normalize_rule() without the logging.  Thus, this function
3480  * is suitable for a program's internal use, whereas ofputil_normalize_rule()
3481  * sense for use on flows received from elsewhere (so that a bug in the program
3482  * that sent them can be reported and corrected). */
3483 void
3484 ofputil_normalize_rule_quiet(struct cls_rule *rule)
3485 {
3486     ofputil_normalize_rule__(rule, false);
3487 }
3488
3489 /* Parses a key or a key-value pair from '*stringp'.
3490  *
3491  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
3492  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
3493  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
3494  * are substrings of '*stringp' created by replacing some of its bytes by null
3495  * terminators.  Returns true.
3496  *
3497  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3498  * NULL and returns false. */
3499 bool
3500 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3501 {
3502     char *pos, *key, *value;
3503     size_t key_len;
3504
3505     pos = *stringp;
3506     pos += strspn(pos, ", \t\r\n");
3507     if (*pos == '\0') {
3508         *keyp = *valuep = NULL;
3509         return false;
3510     }
3511
3512     key = pos;
3513     key_len = strcspn(pos, ":=(, \t\r\n");
3514     if (key[key_len] == ':' || key[key_len] == '=') {
3515         /* The value can be separated by a colon. */
3516         size_t value_len;
3517
3518         value = key + key_len + 1;
3519         value_len = strcspn(value, ", \t\r\n");
3520         pos = value + value_len + (value[value_len] != '\0');
3521         value[value_len] = '\0';
3522     } else if (key[key_len] == '(') {
3523         /* The value can be surrounded by balanced parentheses.  The outermost
3524          * set of parentheses is removed. */
3525         int level = 1;
3526         size_t value_len;
3527
3528         value = key + key_len + 1;
3529         for (value_len = 0; level > 0; value_len++) {
3530             switch (value[value_len]) {
3531             case '\0':
3532                 level = 0;
3533                 break;
3534
3535             case '(':
3536                 level++;
3537                 break;
3538
3539             case ')':
3540                 level--;
3541                 break;
3542             }
3543         }
3544         value[value_len - 1] = '\0';
3545         pos = value + value_len;
3546     } else {
3547         /* There might be no value at all. */
3548         value = key + key_len;  /* Will become the empty string below. */
3549         pos = key + key_len + (key[key_len] != '\0');
3550     }
3551     key[key_len] = '\0';
3552
3553     *stringp = pos;
3554     *keyp = key;
3555     *valuep = value;
3556     return true;
3557 }