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