lib/ofp-util.c

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