lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 <ctype.h>
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23 #include <netinet/in.h>
  24 #include <netinet/icmp6.h>
  25 #include <stdlib.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 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
  81  * flow_wildcards in 'wc' for use in struct match.  It is the caller's
  82  * responsibility to handle the special case where the flow match's dl_vlan is
  83  * set to OFP_VLAN_NONE. */
  84 void
  85 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
  86 {
  87     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
  88
  89     /* Initialize most of wc. */
  90     flow_wildcards_init_catchall(wc);
  91
  92     if (!(ofpfw & OFPFW10_IN_PORT)) {
  93         wc->masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
  94     }
  95
  96     if (!(ofpfw & OFPFW10_NW_TOS)) {
  97         wc->masks.nw_tos |= IP_DSCP_MASK;
  98     }
  99
 100     if (!(ofpfw & OFPFW10_NW_PROTO)) {
 101         wc->masks.nw_proto = UINT8_MAX;
 102     }
 103     wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
 104                                                  >> OFPFW10_NW_SRC_SHIFT);
 105     wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
 106                                                  >> OFPFW10_NW_DST_SHIFT);
 107
 108     if (!(ofpfw & OFPFW10_TP_SRC)) {
 109         wc->masks.tp_src = htons(UINT16_MAX);
 110     }
 111     if (!(ofpfw & OFPFW10_TP_DST)) {
 112         wc->masks.tp_dst = htons(UINT16_MAX);
 113     }
 114
 115     if (!(ofpfw & OFPFW10_DL_SRC)) {
 116         memset(wc->masks.dl_src, 0xff, ETH_ADDR_LEN);
 117     }
 118     if (!(ofpfw & OFPFW10_DL_DST)) {
 119         memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN);
 120     }
 121     if (!(ofpfw & OFPFW10_DL_TYPE)) {
 122         wc->masks.dl_type = htons(UINT16_MAX);
 123     }
 124
 125     /* VLAN TCI mask. */
 126     if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
 127         wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
 128     }
 129     if (!(ofpfw & OFPFW10_DL_VLAN)) {
 130         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 131     }
 132 }
 133
 134 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
 135 void
 136 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
 137                                struct match *match)
 138 {
 139     uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
 140
 141     /* Initialize match->wc. */
 142     memset(&match->flow, 0, sizeof match->flow);
 143     ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
 144
 145     /* Initialize most of match->flow. */
 146     match->flow.nw_src = ofmatch->nw_src;
 147     match->flow.nw_dst = ofmatch->nw_dst;
 148     match->flow.in_port.ofp_port = u16_to_ofp(ntohs(ofmatch->in_port));
 149     match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
 150     match->flow.tp_src = ofmatch->tp_src;
 151     match->flow.tp_dst = ofmatch->tp_dst;
 152     memcpy(match->flow.dl_src, ofmatch->dl_src, ETH_ADDR_LEN);
 153     memcpy(match->flow.dl_dst, ofmatch->dl_dst, ETH_ADDR_LEN);
 154     match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
 155     match->flow.nw_proto = ofmatch->nw_proto;
 156
 157     /* Translate VLANs. */
 158     if (!(ofpfw & OFPFW10_DL_VLAN) &&
 159         ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
 160         /* Match only packets without 802.1Q header.
 161          *
 162          * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
 163          *
 164          * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
 165          * because we can't have a specific PCP without an 802.1Q header.
 166          * However, older versions of OVS treated this as matching packets
 167          * withut an 802.1Q header, so we do here too. */
 168         match->flow.vlan_tci = htons(0);
 169         match->wc.masks.vlan_tci = htons(0xffff);
 170     } else {
 171         ovs_be16 vid, pcp, tci;
 172
 173         vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
 174         pcp = htons((ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
 175         tci = vid | pcp | htons(VLAN_CFI);
 176         match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
 177     }
 178
 179     /* Clean up. */
 180     match_zero_wildcarded_fields(match);
 181 }
 182
 183 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
 184 void
 185 ofputil_match_to_ofp10_match(const struct match *match,
 186                              struct ofp10_match *ofmatch)
 187 {
 188     const struct flow_wildcards *wc = &match->wc;
 189     uint32_t ofpfw;
 190
 191     /* Figure out most OpenFlow wildcards. */
 192     ofpfw = 0;
 193     if (!wc->masks.in_port.ofp_port) {
 194         ofpfw |= OFPFW10_IN_PORT;
 195     }
 196     if (!wc->masks.dl_type) {
 197         ofpfw |= OFPFW10_DL_TYPE;
 198     }
 199     if (!wc->masks.nw_proto) {
 200         ofpfw |= OFPFW10_NW_PROTO;
 201     }
 202     ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
 203               << OFPFW10_NW_SRC_SHIFT);
 204     ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
 205               << OFPFW10_NW_DST_SHIFT);
 206     if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
 207         ofpfw |= OFPFW10_NW_TOS;
 208     }
 209     if (!wc->masks.tp_src) {
 210         ofpfw |= OFPFW10_TP_SRC;
 211     }
 212     if (!wc->masks.tp_dst) {
 213         ofpfw |= OFPFW10_TP_DST;
 214     }
 215     if (eth_addr_is_zero(wc->masks.dl_src)) {
 216         ofpfw |= OFPFW10_DL_SRC;
 217     }
 218     if (eth_addr_is_zero(wc->masks.dl_dst)) {
 219         ofpfw |= OFPFW10_DL_DST;
 220     }
 221
 222     /* Translate VLANs. */
 223     ofmatch->dl_vlan = htons(0);
 224     ofmatch->dl_vlan_pcp = 0;
 225     if (match->wc.masks.vlan_tci == htons(0)) {
 226         ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
 227     } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
 228                && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
 229         ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
 230         ofpfw |= OFPFW10_DL_VLAN_PCP;
 231     } else {
 232         if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
 233             ofpfw |= OFPFW10_DL_VLAN;
 234         } else {
 235             ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
 236         }
 237
 238         if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
 239             ofpfw |= OFPFW10_DL_VLAN_PCP;
 240         } else {
 241             ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
 242         }
 243     }
 244
 245     /* Compose most of the match structure. */
 246     ofmatch->wildcards = htonl(ofpfw);
 247     ofmatch->in_port = htons(ofp_to_u16(match->flow.in_port.ofp_port));
 248     memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
 249     memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
 250     ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
 251     ofmatch->nw_src = match->flow.nw_src;
 252     ofmatch->nw_dst = match->flow.nw_dst;
 253     ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
 254     ofmatch->nw_proto = match->flow.nw_proto;
 255     ofmatch->tp_src = match->flow.tp_src;
 256     ofmatch->tp_dst = match->flow.tp_dst;
 257     memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
 258     memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
 259 }
 260
 261 enum ofperr
 262 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
 263                          uint16_t *padded_match_len)
 264 {
 265     struct ofp11_match_header *omh = buf->data;
 266     uint16_t match_len;
 267
 268     if (buf->size < sizeof *omh) {
 269         return OFPERR_OFPBMC_BAD_LEN;
 270     }
 271
 272     match_len = ntohs(omh->length);
 273
 274     switch (ntohs(omh->type)) {
 275     case OFPMT_STANDARD: {
 276         struct ofp11_match *om;
 277
 278         if (match_len != sizeof *om || buf->size < sizeof *om) {
 279             return OFPERR_OFPBMC_BAD_LEN;
 280         }
 281         om = ofpbuf_pull(buf, sizeof *om);
 282         if (padded_match_len) {
 283             *padded_match_len = match_len;
 284         }
 285         return ofputil_match_from_ofp11_match(om, match);
 286     }
 287
 288     case OFPMT_OXM:
 289         if (padded_match_len) {
 290             *padded_match_len = ROUND_UP(match_len, 8);
 291         }
 292         return oxm_pull_match(buf, match);
 293
 294     default:
 295         return OFPERR_OFPBMC_BAD_TYPE;
 296     }
 297 }
 298
 299 /* Converts the ofp11_match in 'match' into a struct match in 'match.  Returns
 300  * 0 if successful, otherwise an OFPERR_* value. */
 301 enum ofperr
 302 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
 303                                struct match *match)
 304 {
 305     uint16_t wc = ntohl(ofmatch->wildcards);
 306     uint8_t dl_src_mask[ETH_ADDR_LEN];
 307     uint8_t dl_dst_mask[ETH_ADDR_LEN];
 308     bool ipv4, arp, rarp;
 309     int i;
 310
 311     match_init_catchall(match);
 312
 313     if (!(wc & OFPFW11_IN_PORT)) {
 314         ofp_port_t ofp_port;
 315         enum ofperr error;
 316
 317         error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
 318         if (error) {
 319             return OFPERR_OFPBMC_BAD_VALUE;
 320         }
 321         match_set_in_port(match, ofp_port);
 322     }
 323
 324     for (i = 0; i < ETH_ADDR_LEN; i++) {
 325         dl_src_mask[i] = ~ofmatch->dl_src_mask[i];
 326     }
 327     match_set_dl_src_masked(match, ofmatch->dl_src, dl_src_mask);
 328
 329     for (i = 0; i < ETH_ADDR_LEN; i++) {
 330         dl_dst_mask[i] = ~ofmatch->dl_dst_mask[i];
 331     }
 332     match_set_dl_dst_masked(match, ofmatch->dl_dst, dl_dst_mask);
 333
 334     if (!(wc & OFPFW11_DL_VLAN)) {
 335         if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
 336             /* Match only packets without a VLAN tag. */
 337             match->flow.vlan_tci = htons(0);
 338             match->wc.masks.vlan_tci = htons(UINT16_MAX);
 339         } else {
 340             if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
 341                 /* Match any packet with a VLAN tag regardless of VID. */
 342                 match->flow.vlan_tci = htons(VLAN_CFI);
 343                 match->wc.masks.vlan_tci = htons(VLAN_CFI);
 344             } else if (ntohs(ofmatch->dl_vlan) < 4096) {
 345                 /* Match only packets with the specified VLAN VID. */
 346                 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
 347                 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
 348             } else {
 349                 /* Invalid VID. */
 350                 return OFPERR_OFPBMC_BAD_VALUE;
 351             }
 352
 353             if (!(wc & OFPFW11_DL_VLAN_PCP)) {
 354                 if (ofmatch->dl_vlan_pcp <= 7) {
 355                     match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
 356                                                   << VLAN_PCP_SHIFT);
 357                     match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
 358                 } else {
 359                     /* Invalid PCP. */
 360                     return OFPERR_OFPBMC_BAD_VALUE;
 361                 }
 362             }
 363         }
 364     }
 365
 366     if (!(wc & OFPFW11_DL_TYPE)) {
 367         match_set_dl_type(match,
 368                           ofputil_dl_type_from_openflow(ofmatch->dl_type));
 369     }
 370
 371     ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
 372     arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
 373     rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
 374
 375     if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
 376         if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
 377             /* Invalid TOS. */
 378             return OFPERR_OFPBMC_BAD_VALUE;
 379         }
 380
 381         match_set_nw_dscp(match, ofmatch->nw_tos);
 382     }
 383
 384     if (ipv4 || arp || rarp) {
 385         if (!(wc & OFPFW11_NW_PROTO)) {
 386             match_set_nw_proto(match, ofmatch->nw_proto);
 387         }
 388         match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
 389         match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
 390     }
 391
 392 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
 393     if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
 394         switch (match->flow.nw_proto) {
 395         case IPPROTO_ICMP:
 396             /* "A.2.3 Flow Match Structures" in OF1.1 says:
 397              *
 398              *    The tp_src and tp_dst fields will be ignored unless the
 399              *    network protocol specified is as TCP, UDP or SCTP.
 400              *
 401              * but I'm pretty sure we should support ICMP too, otherwise
 402              * that's a regression from OF1.0. */
 403             if (!(wc & OFPFW11_TP_SRC)) {
 404                 uint16_t icmp_type = ntohs(ofmatch->tp_src);
 405                 if (icmp_type < 0x100) {
 406                     match_set_icmp_type(match, icmp_type);
 407                 } else {
 408                     return OFPERR_OFPBMC_BAD_FIELD;
 409                 }
 410             }
 411             if (!(wc & OFPFW11_TP_DST)) {
 412                 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
 413                 if (icmp_code < 0x100) {
 414                     match_set_icmp_code(match, icmp_code);
 415                 } else {
 416                     return OFPERR_OFPBMC_BAD_FIELD;
 417                 }
 418             }
 419             break;
 420
 421         case IPPROTO_TCP:
 422         case IPPROTO_UDP:
 423         case IPPROTO_SCTP:
 424             if (!(wc & (OFPFW11_TP_SRC))) {
 425                 match_set_tp_src(match, ofmatch->tp_src);
 426             }
 427             if (!(wc & (OFPFW11_TP_DST))) {
 428                 match_set_tp_dst(match, ofmatch->tp_dst);
 429             }
 430             break;
 431
 432         default:
 433             /* OF1.1 says explicitly to ignore this. */
 434             break;
 435         }
 436     }
 437
 438     if (eth_type_mpls(match->flow.dl_type)) {
 439         enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
 440
 441         if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
 442             /* MPLS not supported. */
 443             return OFPERR_OFPBMC_BAD_TAG;
 444         }
 445     }
 446
 447     match_set_metadata_masked(match, ofmatch->metadata,
 448                               ~ofmatch->metadata_mask);
 449
 450     return 0;
 451 }
 452
 453 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
 454 void
 455 ofputil_match_to_ofp11_match(const struct match *match,
 456                              struct ofp11_match *ofmatch)
 457 {
 458     uint32_t wc = 0;
 459     int i;
 460
 461     memset(ofmatch, 0, sizeof *ofmatch);
 462     ofmatch->omh.type = htons(OFPMT_STANDARD);
 463     ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
 464
 465     if (!match->wc.masks.in_port.ofp_port) {
 466         wc |= OFPFW11_IN_PORT;
 467     } else {
 468         ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
 469     }
 470
 471     memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
 472     for (i = 0; i < ETH_ADDR_LEN; i++) {
 473         ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
 474     }
 475
 476     memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
 477     for (i = 0; i < ETH_ADDR_LEN; i++) {
 478         ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
 479     }
 480
 481     if (match->wc.masks.vlan_tci == htons(0)) {
 482         wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
 483     } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
 484                && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
 485         ofmatch->dl_vlan = htons(OFPVID11_NONE);
 486         wc |= OFPFW11_DL_VLAN_PCP;
 487     } else {
 488         if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
 489             ofmatch->dl_vlan = htons(OFPVID11_ANY);
 490         } else {
 491             ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
 492         }
 493
 494         if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
 495             wc |= OFPFW11_DL_VLAN_PCP;
 496         } else {
 497             ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
 498         }
 499     }
 500
 501     if (!match->wc.masks.dl_type) {
 502         wc |= OFPFW11_DL_TYPE;
 503     } else {
 504         ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
 505     }
 506
 507     if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
 508         wc |= OFPFW11_NW_TOS;
 509     } else {
 510         ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
 511     }
 512
 513     if (!match->wc.masks.nw_proto) {
 514         wc |= OFPFW11_NW_PROTO;
 515     } else {
 516         ofmatch->nw_proto = match->flow.nw_proto;
 517     }
 518
 519     ofmatch->nw_src = match->flow.nw_src;
 520     ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
 521     ofmatch->nw_dst = match->flow.nw_dst;
 522     ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
 523
 524     if (!match->wc.masks.tp_src) {
 525         wc |= OFPFW11_TP_SRC;
 526     } else {
 527         ofmatch->tp_src = match->flow.tp_src;
 528     }
 529
 530     if (!match->wc.masks.tp_dst) {
 531         wc |= OFPFW11_TP_DST;
 532     } else {
 533         ofmatch->tp_dst = match->flow.tp_dst;
 534     }
 535
 536     /* MPLS not supported. */
 537     wc |= OFPFW11_MPLS_LABEL;
 538     wc |= OFPFW11_MPLS_TC;
 539
 540     ofmatch->metadata = match->flow.metadata;
 541     ofmatch->metadata_mask = ~match->wc.masks.metadata;
 542
 543     ofmatch->wildcards = htonl(wc);
 544 }
 545
 546 /* Returns the "typical" length of a match for 'protocol', for use in
 547  * estimating space to preallocate. */
 548 int
 549 ofputil_match_typical_len(enum ofputil_protocol protocol)
 550 {
 551     switch (protocol) {
 552     case OFPUTIL_P_OF10_STD:
 553     case OFPUTIL_P_OF10_STD_TID:
 554         return sizeof(struct ofp10_match);
 555
 556     case OFPUTIL_P_OF10_NXM:
 557     case OFPUTIL_P_OF10_NXM_TID:
 558         return NXM_TYPICAL_LEN;
 559
 560     case OFPUTIL_P_OF11_STD:
 561         return sizeof(struct ofp11_match);
 562
 563     case OFPUTIL_P_OF12_OXM:
 564     case OFPUTIL_P_OF13_OXM:
 565         return NXM_TYPICAL_LEN;
 566
 567     default:
 568         NOT_REACHED();
 569     }
 570 }
 571
 572 /* Appends to 'b' an struct ofp11_match_header followed by a match that
 573  * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
 574  * data appended out to a multiple of 8.  'protocol' must be one that is usable
 575  * in OpenFlow 1.1 or later.
 576  *
 577  * This function can cause 'b''s data to be reallocated.
 578  *
 579  * Returns the number of bytes appended to 'b', excluding the padding.  Never
 580  * returns zero. */
 581 int
 582 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
 583                         enum ofputil_protocol protocol)
 584 {
 585     switch (protocol) {
 586     case OFPUTIL_P_OF10_STD:
 587     case OFPUTIL_P_OF10_STD_TID:
 588     case OFPUTIL_P_OF10_NXM:
 589     case OFPUTIL_P_OF10_NXM_TID:
 590         NOT_REACHED();
 591
 592     case OFPUTIL_P_OF11_STD: {
 593         struct ofp11_match *om;
 594
 595         /* Make sure that no padding is needed. */
 596         BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
 597
 598         om = ofpbuf_put_uninit(b, sizeof *om);
 599         ofputil_match_to_ofp11_match(match, om);
 600         return sizeof *om;
 601     }
 602
 603     case OFPUTIL_P_OF12_OXM:
 604     case OFPUTIL_P_OF13_OXM:
 605         return oxm_put_match(b, match);
 606     }
 607
 608     NOT_REACHED();
 609 }
 610
 611 /* Given a 'dl_type' value in the format used in struct flow, returns the
 612  * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
 613  * structure. */
 614 ovs_be16
 615 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
 616 {
 617     return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
 618             ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 619             : flow_dl_type);
 620 }
 621
 622 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
 623  * structure, returns the corresponding 'dl_type' value for use in struct
 624  * flow. */
 625 ovs_be16
 626 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
 627 {
 628     return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 629             ? htons(FLOW_DL_TYPE_NONE)
 630             : ofp_dl_type);
 631 }
 632 \f
 633 /* Protocols. */
 634
 635 struct proto_abbrev {
 636     enum ofputil_protocol protocol;
 637     const char *name;
 638 };
 639
 640 /* Most users really don't care about some of the differences between
 641  * protocols.  These abbreviations help with that. */
 642 static const struct proto_abbrev proto_abbrevs[] = {
 643     { OFPUTIL_P_ANY,          "any" },
 644     { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
 645     { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
 646     { OFPUTIL_P_ANY_OXM,      "OXM" },
 647 };
 648 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
 649
 650 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
 651     OFPUTIL_P_OF13_OXM,
 652     OFPUTIL_P_OF12_OXM,
 653     OFPUTIL_P_OF11_STD,
 654     OFPUTIL_P_OF10_NXM,
 655     OFPUTIL_P_OF10_STD,
 656 };
 657 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
 658
 659 /* Returns the set of ofputil_protocols that are supported with the given
 660  * OpenFlow 'version'.  'version' should normally be an 8-bit OpenFlow version
 661  * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1).  Returns 0
 662  * if 'version' is not supported or outside the valid range.  */
 663 enum ofputil_protocol
 664 ofputil_protocols_from_ofp_version(enum ofp_version version)
 665 {
 666     switch (version) {
 667     case OFP10_VERSION:
 668         return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
 669     case OFP11_VERSION:
 670         return OFPUTIL_P_OF11_STD;
 671     case OFP12_VERSION:
 672         return OFPUTIL_P_OF12_OXM;
 673     case OFP13_VERSION:
 674         return OFPUTIL_P_OF13_OXM;
 675     default:
 676         return 0;
 677     }
 678 }
 679
 680 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
 681  * connection that has negotiated the given 'version'.  'version' should
 682  * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
 683  * 1.0, 0x02 for OpenFlow 1.1).  Returns 0 if 'version' is not supported or
 684  * outside the valid range.  */
 685 enum ofputil_protocol
 686 ofputil_protocol_from_ofp_version(enum ofp_version version)
 687 {
 688     return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
 689 }
 690
 691 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
 692  * etc.) that corresponds to 'protocol'. */
 693 enum ofp_version
 694 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
 695 {
 696     switch (protocol) {
 697     case OFPUTIL_P_OF10_STD:
 698     case OFPUTIL_P_OF10_STD_TID:
 699     case OFPUTIL_P_OF10_NXM:
 700     case OFPUTIL_P_OF10_NXM_TID:
 701         return OFP10_VERSION;
 702     case OFPUTIL_P_OF11_STD:
 703         return OFP11_VERSION;
 704     case OFPUTIL_P_OF12_OXM:
 705         return OFP12_VERSION;
 706     case OFPUTIL_P_OF13_OXM:
 707         return OFP13_VERSION;
 708     }
 709
 710     NOT_REACHED();
 711 }
 712
 713 /* Returns a bitmap of OpenFlow versions that are supported by at
 714  * least one of the 'protocols'. */
 715 uint32_t
 716 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
 717 {
 718     uint32_t bitmap = 0;
 719
 720     for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
 721         enum ofputil_protocol protocol = rightmost_1bit(protocols);
 722
 723         bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
 724     }
 725
 726     return bitmap;
 727 }
 728
 729 /* Returns the set of protocols that are supported on top of the
 730  * OpenFlow versions included in 'bitmap'. */
 731 enum ofputil_protocol
 732 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
 733 {
 734     enum ofputil_protocol protocols = 0;
 735
 736     for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
 737         enum ofp_version version = rightmost_1bit_idx(bitmap);
 738
 739         protocols |= ofputil_protocols_from_ofp_version(version);
 740     }
 741
 742     return protocols;
 743 }
 744
 745 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
 746  * otherwise. */
 747 bool
 748 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
 749 {
 750     return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
 751 }
 752
 753 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
 754  * extension turned on or off if 'enable' is true or false, respectively.
 755  *
 756  * This extension is only useful for protocols whose "standard" version does
 757  * not allow specific tables to be modified.  In particular, this is true of
 758  * OpenFlow 1.0.  In later versions of OpenFlow, a flow_mod request always
 759  * specifies a table ID and so there is no need for such an extension.  When
 760  * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
 761  * extension, this function just returns its 'protocol' argument unchanged
 762  * regardless of the value of 'enable'.  */
 763 enum ofputil_protocol
 764 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
 765 {
 766     switch (protocol) {
 767     case OFPUTIL_P_OF10_STD:
 768     case OFPUTIL_P_OF10_STD_TID:
 769         return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
 770
 771     case OFPUTIL_P_OF10_NXM:
 772     case OFPUTIL_P_OF10_NXM_TID:
 773         return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
 774
 775     case OFPUTIL_P_OF11_STD:
 776         return OFPUTIL_P_OF11_STD;
 777
 778     case OFPUTIL_P_OF12_OXM:
 779         return OFPUTIL_P_OF12_OXM;
 780
 781     case OFPUTIL_P_OF13_OXM:
 782         return OFPUTIL_P_OF13_OXM;
 783
 784     default:
 785         NOT_REACHED();
 786     }
 787 }
 788
 789 /* Returns the "base" version of 'protocol'.  That is, if 'protocol' includes
 790  * some extension to a standard protocol version, the return value is the
 791  * standard version of that protocol without any extension.  If 'protocol' is a
 792  * standard protocol version, returns 'protocol' unchanged. */
 793 enum ofputil_protocol
 794 ofputil_protocol_to_base(enum ofputil_protocol protocol)
 795 {
 796     return ofputil_protocol_set_tid(protocol, false);
 797 }
 798
 799 /* Returns 'new_base' with any extensions taken from 'cur'. */
 800 enum ofputil_protocol
 801 ofputil_protocol_set_base(enum ofputil_protocol cur,
 802                           enum ofputil_protocol new_base)
 803 {
 804     bool tid = (cur & OFPUTIL_P_TID) != 0;
 805
 806     switch (new_base) {
 807     case OFPUTIL_P_OF10_STD:
 808     case OFPUTIL_P_OF10_STD_TID:
 809         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
 810
 811     case OFPUTIL_P_OF10_NXM:
 812     case OFPUTIL_P_OF10_NXM_TID:
 813         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
 814
 815     case OFPUTIL_P_OF11_STD:
 816         return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
 817
 818     case OFPUTIL_P_OF12_OXM:
 819         return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
 820
 821     case OFPUTIL_P_OF13_OXM:
 822         return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
 823
 824     default:
 825         NOT_REACHED();
 826     }
 827 }
 828
 829 /* Returns a string form of 'protocol', if a simple form exists (that is, if
 830  * 'protocol' is either a single protocol or it is a combination of protocols
 831  * that have a single abbreviation).  Otherwise, returns NULL. */
 832 const char *
 833 ofputil_protocol_to_string(enum ofputil_protocol protocol)
 834 {
 835     const struct proto_abbrev *p;
 836
 837     /* Use a "switch" statement for single-bit names so that we get a compiler
 838      * warning if we forget any. */
 839     switch (protocol) {
 840     case OFPUTIL_P_OF10_NXM:
 841         return "NXM-table_id";
 842
 843     case OFPUTIL_P_OF10_NXM_TID:
 844         return "NXM+table_id";
 845
 846     case OFPUTIL_P_OF10_STD:
 847         return "OpenFlow10-table_id";
 848
 849     case OFPUTIL_P_OF10_STD_TID:
 850         return "OpenFlow10+table_id";
 851
 852     case OFPUTIL_P_OF11_STD:
 853         return "OpenFlow11";
 854
 855     case OFPUTIL_P_OF12_OXM:
 856         return "OXM-OpenFlow12";
 857
 858     case OFPUTIL_P_OF13_OXM:
 859         return "OXM-OpenFlow13";
 860     }
 861
 862     /* Check abbreviations. */
 863     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 864         if (protocol == p->protocol) {
 865             return p->name;
 866         }
 867     }
 868
 869     return NULL;
 870 }
 871
 872 /* Returns a string that represents 'protocols'.  The return value might be a
 873  * comma-separated list if 'protocols' doesn't have a simple name.  The return
 874  * value is "none" if 'protocols' is 0.
 875  *
 876  * The caller must free the returned string (with free()). */
 877 char *
 878 ofputil_protocols_to_string(enum ofputil_protocol protocols)
 879 {
 880     struct ds s;
 881
 882     ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
 883     if (protocols == 0) {
 884         return xstrdup("none");
 885     }
 886
 887     ds_init(&s);
 888     while (protocols) {
 889         const struct proto_abbrev *p;
 890         int i;
 891
 892         if (s.length) {
 893             ds_put_char(&s, ',');
 894         }
 895
 896         for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 897             if ((protocols & p->protocol) == p->protocol) {
 898                 ds_put_cstr(&s, p->name);
 899                 protocols &= ~p->protocol;
 900                 goto match;
 901             }
 902         }
 903
 904         for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
 905             enum ofputil_protocol bit = 1u << i;
 906
 907             if (protocols & bit) {
 908                 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
 909                 protocols &= ~bit;
 910                 goto match;
 911             }
 912         }
 913         NOT_REACHED();
 914
 915     match: ;
 916     }
 917     return ds_steal_cstr(&s);
 918 }
 919
 920 static enum ofputil_protocol
 921 ofputil_protocol_from_string__(const char *s, size_t n)
 922 {
 923     const struct proto_abbrev *p;
 924     int i;
 925
 926     for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
 927         enum ofputil_protocol bit = 1u << i;
 928         const char *name = ofputil_protocol_to_string(bit);
 929
 930         if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
 931             return bit;
 932         }
 933     }
 934
 935     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
 936         if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
 937             return p->protocol;
 938         }
 939     }
 940
 941     return 0;
 942 }
 943
 944 /* Returns the nonempty set of protocols represented by 's', which can be a
 945  * single protocol name or abbreviation or a comma-separated list of them.
 946  *
 947  * Aborts the program with an error message if 's' is invalid. */
 948 enum ofputil_protocol
 949 ofputil_protocols_from_string(const char *s)
 950 {
 951     const char *orig_s = s;
 952     enum ofputil_protocol protocols;
 953
 954     protocols = 0;
 955     while (*s) {
 956         enum ofputil_protocol p;
 957         size_t n;
 958
 959         n = strcspn(s, ",");
 960         if (n == 0) {
 961             s++;
 962             continue;
 963         }
 964
 965         p = ofputil_protocol_from_string__(s, n);
 966         if (!p) {
 967             ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
 968         }
 969         protocols |= p;
 970
 971         s += n;
 972     }
 973
 974     if (!protocols) {
 975         ovs_fatal(0, "%s: no flow protocol specified", orig_s);
 976     }
 977     return protocols;
 978 }
 979
 980 static int
 981 ofputil_version_from_string(const char *s)
 982 {
 983     if (!strcasecmp(s, "OpenFlow10")) {
 984         return OFP10_VERSION;
 985     }
 986     if (!strcasecmp(s, "OpenFlow11")) {
 987         return OFP11_VERSION;
 988     }
 989     if (!strcasecmp(s, "OpenFlow12")) {
 990         return OFP12_VERSION;
 991     }
 992     if (!strcasecmp(s, "OpenFlow13")) {
 993         return OFP13_VERSION;
 994     }
 995     return 0;
 996 }
 997
 998 static bool
 999 is_delimiter(unsigned char c)
1000 {
1001     return isspace(c) || c == ',';
1002 }
1003
1004 uint32_t
1005 ofputil_versions_from_string(const char *s)
1006 {
1007     size_t i = 0;
1008     uint32_t bitmap = 0;
1009
1010     while (s[i]) {
1011         size_t j;
1012         int version;
1013         char *key;
1014
1015         if (is_delimiter(s[i])) {
1016             i++;
1017             continue;
1018         }
1019         j = 0;
1020         while (s[i + j] && !is_delimiter(s[i + j])) {
1021             j++;
1022         }
1023         key = xmemdup0(s + i, j);
1024         version = ofputil_version_from_string(key);
1025         if (!version) {
1026             VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1027         }
1028         free(key);
1029         bitmap |= 1u << version;
1030         i += j;
1031     }
1032
1033     return bitmap;
1034 }
1035
1036 uint32_t
1037 ofputil_versions_from_strings(char ** const s, size_t count)
1038 {
1039     uint32_t bitmap = 0;
1040
1041     while (count--) {
1042         int version = ofputil_version_from_string(s[count]);
1043         if (!version) {
1044             VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1045         } else {
1046             bitmap |= 1u << version;
1047         }
1048     }
1049
1050     return bitmap;
1051 }
1052
1053 const char *
1054 ofputil_version_to_string(enum ofp_version ofp_version)
1055 {
1056     switch (ofp_version) {
1057     case OFP10_VERSION:
1058         return "OpenFlow10";
1059     case OFP11_VERSION:
1060         return "OpenFlow11";
1061     case OFP12_VERSION:
1062         return "OpenFlow12";
1063     case OFP13_VERSION:
1064         return "OpenFlow13";
1065     default:
1066         NOT_REACHED();
1067     }
1068 }
1069
1070 bool
1071 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1072 {
1073     switch (packet_in_format) {
1074     case NXPIF_OPENFLOW10:
1075     case NXPIF_NXM:
1076         return true;
1077     }
1078
1079     return false;
1080 }
1081
1082 const char *
1083 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1084 {
1085     switch (packet_in_format) {
1086     case NXPIF_OPENFLOW10:
1087         return "openflow10";
1088     case NXPIF_NXM:
1089         return "nxm";
1090     default:
1091         NOT_REACHED();
1092     }
1093 }
1094
1095 int
1096 ofputil_packet_in_format_from_string(const char *s)
1097 {
1098     return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1099             : !strcmp(s, "nxm") ? NXPIF_NXM
1100             : -1);
1101 }
1102
1103 static bool
1104 regs_fully_wildcarded(const struct flow_wildcards *wc)
1105 {
1106     int i;
1107
1108     for (i = 0; i < FLOW_N_REGS; i++) {
1109         if (wc->masks.regs[i] != 0) {
1110             return false;
1111         }
1112     }
1113     return true;
1114 }
1115
1116 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
1117  * to a switch (e.g. to add or remove a flow).  Only NXM can handle tunnel IDs,
1118  * registers, or fixing the Ethernet multicast bit.  Otherwise, it's better to
1119  * use OpenFlow 1.0 protocol for backward compatibility. */
1120 enum ofputil_protocol
1121 ofputil_usable_protocols(const struct match *match)
1122 {
1123     const struct flow_wildcards *wc = &match->wc;
1124
1125     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
1126
1127     /* These tunnel params can't be sent in a flow_mod */
1128     if (wc->masks.tunnel.ip_ttl
1129         || wc->masks.tunnel.ip_tos || wc->masks.tunnel.flags) {
1130         return OFPUTIL_P_NONE;
1131     }
1132
1133     /* skb_priority can't be sent in a flow_mod */
1134     if (wc->masks.skb_priority) {
1135         return OFPUTIL_P_NONE;
1136     }
1137
1138     /* NXM and OXM support pkt_mark */
1139     if (wc->masks.pkt_mark) {
1140         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1141             | OFPUTIL_P_OF13_OXM;
1142     }
1143
1144     /* NXM, OXM, and OF1.1 support bitwise matching on ethernet addresses. */
1145     if (!eth_mask_is_exact(wc->masks.dl_src)
1146         && !eth_addr_is_zero(wc->masks.dl_src)) {
1147         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1148             | OFPUTIL_P_OF13_OXM;
1149     }
1150     if (!eth_mask_is_exact(wc->masks.dl_dst)
1151         && !eth_addr_is_zero(wc->masks.dl_dst)) {
1152         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1153             | OFPUTIL_P_OF13_OXM;
1154     }
1155
1156     /* NXM, OXM, and OF1.1+ support matching metadata. */
1157     if (wc->masks.metadata != htonll(0)) {
1158         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1159             | OFPUTIL_P_OF13_OXM;
1160     }
1161
1162     /* NXM and OXM support matching ARP hardware addresses. */
1163     if (!eth_addr_is_zero(wc->masks.arp_sha) ||
1164         !eth_addr_is_zero(wc->masks.arp_tha)) {
1165         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1166             | OFPUTIL_P_OF13_OXM;
1167     }
1168
1169     /* NXM and OXM support matching L3 and L4 fields within IPv6.
1170      *
1171      * (arp_sha, arp_tha, nw_frag, and nw_ttl are covered elsewhere so they
1172      * don't need to be included in this test too.) */
1173     if (match->flow.dl_type == htons(ETH_TYPE_IPV6)
1174         && (!ipv6_mask_is_any(&wc->masks.ipv6_src)
1175             || !ipv6_mask_is_any(&wc->masks.ipv6_dst)
1176             || !ipv6_mask_is_any(&wc->masks.nd_target)
1177             || wc->masks.ipv6_label
1178             || wc->masks.tp_src
1179             || wc->masks.tp_dst
1180             || wc->masks.nw_proto
1181             || wc->masks.nw_tos)) {
1182         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1183             | OFPUTIL_P_OF13_OXM;
1184     }
1185
1186     /* NXM and OXM support matching registers. */
1187     if (!regs_fully_wildcarded(wc)) {
1188         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1189             | OFPUTIL_P_OF13_OXM;
1190     }
1191
1192     /* NXM and OXM support matching tun_id, tun_src, and tun_dst. */
1193     if (wc->masks.tunnel.tun_id != htonll(0)
1194         || wc->masks.tunnel.ip_src != htonl(0)
1195         || wc->masks.tunnel.ip_dst != htonl(0)) {
1196         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1197             | OFPUTIL_P_OF13_OXM;
1198     }
1199
1200     /* NXM and OXM support matching fragments. */
1201     if (wc->masks.nw_frag) {
1202         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1203             | OFPUTIL_P_OF13_OXM;
1204     }
1205
1206     /* NXM and OXM support matching IP ECN bits. */
1207     if (wc->masks.nw_tos & IP_ECN_MASK) {
1208         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1209             | OFPUTIL_P_OF13_OXM;
1210     }
1211
1212     /* NXM and OXM support matching IP TTL/hop limit. */
1213     if (wc->masks.nw_ttl) {
1214         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1215             | OFPUTIL_P_OF13_OXM;
1216     }
1217
1218     /* NXM and OXM support non-CIDR IPv4 address masks. */
1219     if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
1220         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1221             | OFPUTIL_P_OF13_OXM;
1222     }
1223
1224     /* NXM and OXM support bitwise matching on transport port. */
1225     if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
1226         (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
1227         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1228             | OFPUTIL_P_OF13_OXM;
1229     }
1230
1231     /* NXM and OF1.1+ support matching MPLS label */
1232     if (wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK)) {
1233         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1234             | OFPUTIL_P_OF13_OXM;
1235     }
1236
1237     /* NXM and OF1.1+ support matching MPLS TC */
1238     if (wc->masks.mpls_lse & htonl(MPLS_TC_MASK)) {
1239         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1240             | OFPUTIL_P_OF13_OXM;
1241     }
1242
1243     /* NXM and OF1.3+ support matching MPLS stack flag */
1244     /* Allow for OF1.2 as there doesn't seem to be a
1245      * particularly good reason not to */
1246     if (wc->masks.mpls_lse & htonl(MPLS_BOS_MASK)) {
1247         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
1248             | OFPUTIL_P_OF13_OXM;
1249     }
1250
1251     /* Other formats can express this rule. */
1252     return OFPUTIL_P_ANY;
1253 }
1254
1255 void
1256 ofputil_format_version(struct ds *msg, enum ofp_version version)
1257 {
1258     ds_put_format(msg, "0x%02x", version);
1259 }
1260
1261 void
1262 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1263 {
1264     ds_put_cstr(msg, ofputil_version_to_string(version));
1265 }
1266
1267 static void
1268 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1269                                 void (*format_version)(struct ds *msg,
1270                                                        enum ofp_version))
1271 {
1272     while (bitmap) {
1273         format_version(msg, raw_ctz(bitmap));
1274         bitmap = zero_rightmost_1bit(bitmap);
1275         if (bitmap) {
1276             ds_put_cstr(msg, ", ");
1277         }
1278     }
1279 }
1280
1281 void
1282 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1283 {
1284     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1285 }
1286
1287 void
1288 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1289 {
1290     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1291 }
1292
1293 static bool
1294 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1295                             uint32_t *allowed_versionsp)
1296 {
1297     uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1298     const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1299     uint32_t allowed_versions;
1300
1301     if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1302         return false;
1303     }
1304
1305     /* Only use the first 32-bit element of the bitmap as that is all the
1306      * current implementation supports.  Subsequent elements are ignored which
1307      * should have no effect on session negotiation until Open vSwtich supports
1308      * wire-protocol versions greater than 31.
1309      */
1310     allowed_versions = ntohl(bitmap[0]);
1311
1312     if (allowed_versions & 1) {
1313         /* There's no OpenFlow version 0. */
1314         VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1315                      "version 0x00");
1316         allowed_versions &= ~1u;
1317     }
1318
1319     if (!allowed_versions) {
1320         VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1321                      "version (between 0x01 and 0x1f)");
1322         return false;
1323     }
1324
1325     *allowed_versionsp = allowed_versions;
1326     return true;
1327 }
1328
1329 static uint32_t
1330 version_bitmap_from_version(uint8_t ofp_version)
1331 {
1332     return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1333 }
1334
1335 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1336  * the set of OpenFlow versions for which 'oh' announces support.
1337  *
1338  * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1339  * successful, and thus '*allowed_versions' is always initialized.  However, it
1340  * returns false if 'oh' contains some data that could not be fully understood,
1341  * true if 'oh' was completely parsed. */
1342 bool
1343 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1344 {
1345     struct ofpbuf msg;
1346     bool ok = true;
1347
1348     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1349     ofpbuf_pull(&msg, sizeof *oh);
1350
1351     *allowed_versions = version_bitmap_from_version(oh->version);
1352     while (msg.size) {
1353         const struct ofp_hello_elem_header *oheh;
1354         unsigned int len;
1355
1356         if (msg.size < sizeof *oheh) {
1357             return false;
1358         }
1359
1360         oheh = msg.data;
1361         len = ntohs(oheh->length);
1362         if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1363             return false;
1364         }
1365
1366         if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1367             || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1368             ok = false;
1369         }
1370     }
1371
1372     return ok;
1373 }
1374
1375 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1376  * bitmap to be correctly expressed in an OFPT_HELLO message. */
1377 static bool
1378 should_send_version_bitmap(uint32_t allowed_versions)
1379 {
1380     return !is_pow2((allowed_versions >> 1) + 1);
1381 }
1382
1383 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1384  * versions in the 'allowed_versions' bitmaps and returns the message. */
1385 struct ofpbuf *
1386 ofputil_encode_hello(uint32_t allowed_versions)
1387 {
1388     enum ofp_version ofp_version;
1389     struct ofpbuf *msg;
1390
1391     ofp_version = leftmost_1bit_idx(allowed_versions);
1392     msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1393
1394     if (should_send_version_bitmap(allowed_versions)) {
1395         struct ofp_hello_elem_header *oheh;
1396         uint16_t map_len;
1397
1398         map_len = sizeof allowed_versions;
1399         oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1400         oheh->type = htons(OFPHET_VERSIONBITMAP);
1401         oheh->length = htons(map_len + sizeof *oheh);
1402         *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1403
1404         ofpmsg_update_length(msg);
1405     }
1406
1407     return msg;
1408 }
1409
1410 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1411  * protocol is 'current', at least partly transitions the protocol to 'want'.
1412  * Stores in '*next' the protocol that will be in effect on the OpenFlow
1413  * connection if the switch processes the returned message correctly.  (If
1414  * '*next != want' then the caller will have to iterate.)
1415  *
1416  * If 'current == want', or if it is not possible to transition from 'current'
1417  * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1418  * protocol versions), returns NULL and stores 'current' in '*next'. */
1419 struct ofpbuf *
1420 ofputil_encode_set_protocol(enum ofputil_protocol current,
1421                             enum ofputil_protocol want,
1422                             enum ofputil_protocol *next)
1423 {
1424     enum ofp_version cur_version, want_version;
1425     enum ofputil_protocol cur_base, want_base;
1426     bool cur_tid, want_tid;
1427
1428     cur_version = ofputil_protocol_to_ofp_version(current);
1429     want_version = ofputil_protocol_to_ofp_version(want);
1430     if (cur_version != want_version) {
1431         *next = current;
1432         return NULL;
1433     }
1434
1435     cur_base = ofputil_protocol_to_base(current);
1436     want_base = ofputil_protocol_to_base(want);
1437     if (cur_base != want_base) {
1438         *next = ofputil_protocol_set_base(current, want_base);
1439
1440         switch (want_base) {
1441         case OFPUTIL_P_OF10_NXM:
1442             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1443
1444         case OFPUTIL_P_OF10_STD:
1445             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1446
1447         case OFPUTIL_P_OF11_STD:
1448         case OFPUTIL_P_OF12_OXM:
1449         case OFPUTIL_P_OF13_OXM:
1450             /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1451              * verified above that we're not trying to change versions. */
1452             NOT_REACHED();
1453
1454         case OFPUTIL_P_OF10_STD_TID:
1455         case OFPUTIL_P_OF10_NXM_TID:
1456             NOT_REACHED();
1457         }
1458     }
1459
1460     cur_tid = (current & OFPUTIL_P_TID) != 0;
1461     want_tid = (want & OFPUTIL_P_TID) != 0;
1462     if (cur_tid != want_tid) {
1463         *next = ofputil_protocol_set_tid(current, want_tid);
1464         return ofputil_make_flow_mod_table_id(want_tid);
1465     }
1466
1467     ovs_assert(current == want);
1468
1469     *next = current;
1470     return NULL;
1471 }
1472
1473 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1474  * format to 'nxff'.  */
1475 struct ofpbuf *
1476 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1477 {
1478     struct nx_set_flow_format *sff;
1479     struct ofpbuf *msg;
1480
1481     ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1482
1483     msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1484     sff = ofpbuf_put_zeros(msg, sizeof *sff);
1485     sff->format = htonl(nxff);
1486
1487     return msg;
1488 }
1489
1490 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1491  * otherwise. */
1492 enum ofputil_protocol
1493 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1494 {
1495     switch (flow_format) {
1496     case NXFF_OPENFLOW10:
1497         return OFPUTIL_P_OF10_STD;
1498
1499     case NXFF_NXM:
1500         return OFPUTIL_P_OF10_NXM;
1501
1502     default:
1503         return 0;
1504     }
1505 }
1506
1507 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1508 bool
1509 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1510 {
1511     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1512 }
1513
1514 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1515  * value. */
1516 const char *
1517 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1518 {
1519     switch (flow_format) {
1520     case NXFF_OPENFLOW10:
1521         return "openflow10";
1522     case NXFF_NXM:
1523         return "nxm";
1524     default:
1525         NOT_REACHED();
1526     }
1527 }
1528
1529 struct ofpbuf *
1530 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1531                                   enum nx_packet_in_format packet_in_format)
1532 {
1533     struct nx_set_packet_in_format *spif;
1534     struct ofpbuf *msg;
1535
1536     msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1537     spif = ofpbuf_put_zeros(msg, sizeof *spif);
1538     spif->format = htonl(packet_in_format);
1539
1540     return msg;
1541 }
1542
1543 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1544  * extension on or off (according to 'flow_mod_table_id'). */
1545 struct ofpbuf *
1546 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1547 {
1548     struct nx_flow_mod_table_id *nfmti;
1549     struct ofpbuf *msg;
1550
1551     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1552     nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1553     nfmti->set = flow_mod_table_id;
1554     return msg;
1555 }
1556
1557 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1558  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1559  * code.
1560  *
1561  * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1562  * The caller must initialize 'ofpacts' and retains ownership of it.
1563  * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1564  *
1565  * Does not validate the flow_mod actions.  The caller should do that, with
1566  * ofpacts_check(). */
1567 enum ofperr
1568 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1569                         const struct ofp_header *oh,
1570                         enum ofputil_protocol protocol,
1571                         struct ofpbuf *ofpacts)
1572 {
1573     uint16_t command;
1574     struct ofpbuf b;
1575     enum ofpraw raw;
1576
1577     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1578     raw = ofpraw_pull_assert(&b);
1579     if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1580         /* Standard OpenFlow 1.1+ flow_mod. */
1581         const struct ofp11_flow_mod *ofm;
1582         enum ofperr error;
1583
1584         ofm = ofpbuf_pull(&b, sizeof *ofm);
1585
1586         error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1587         if (error) {
1588             return error;
1589         }
1590
1591         error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1592         if (error) {
1593             return error;
1594         }
1595
1596         /* Translate the message. */
1597         fm->priority = ntohs(ofm->priority);
1598         if (ofm->command == OFPFC_ADD
1599             || (oh->version == OFP11_VERSION
1600                 && (ofm->command == OFPFC_MODIFY ||
1601                     ofm->command == OFPFC_MODIFY_STRICT)
1602                 && ofm->cookie_mask == htonll(0))) {
1603             /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1604              * not match on the cookie is treated as an "add" if there is no
1605              * match. */
1606             fm->cookie = htonll(0);
1607             fm->cookie_mask = htonll(0);
1608             fm->new_cookie = ofm->cookie;
1609         } else {
1610             fm->cookie = ofm->cookie;
1611             fm->cookie_mask = ofm->cookie_mask;
1612             fm->new_cookie = htonll(UINT64_MAX);
1613         }
1614         fm->modify_cookie = false;
1615         fm->command = ofm->command;
1616         fm->table_id = ofm->table_id;
1617         fm->idle_timeout = ntohs(ofm->idle_timeout);
1618         fm->hard_timeout = ntohs(ofm->hard_timeout);
1619         fm->buffer_id = ntohl(ofm->buffer_id);
1620         error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1621         if (error) {
1622             return error;
1623         }
1624         if ((ofm->command == OFPFC_DELETE
1625              || ofm->command == OFPFC_DELETE_STRICT)
1626             && ofm->out_group != htonl(OFPG_ANY)) {
1627             return OFPERR_OFPFMFC_UNKNOWN;
1628         }
1629         fm->flags = ntohs(ofm->flags);
1630     } else {
1631         if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1632             /* Standard OpenFlow 1.0 flow_mod. */
1633             const struct ofp10_flow_mod *ofm;
1634             enum ofperr error;
1635
1636             /* Get the ofp10_flow_mod. */
1637             ofm = ofpbuf_pull(&b, sizeof *ofm);
1638
1639             /* Translate the rule. */
1640             ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1641             ofputil_normalize_match(&fm->match);
1642
1643             /* Now get the actions. */
1644             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1645             if (error) {
1646                 return error;
1647             }
1648
1649             /* OpenFlow 1.0 says that exact-match rules have to have the
1650              * highest possible priority. */
1651             fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1652                             ? ntohs(ofm->priority)
1653                             : UINT16_MAX);
1654
1655             /* Translate the message. */
1656             command = ntohs(ofm->command);
1657             fm->cookie = htonll(0);
1658             fm->cookie_mask = htonll(0);
1659             fm->new_cookie = ofm->cookie;
1660             fm->idle_timeout = ntohs(ofm->idle_timeout);
1661             fm->hard_timeout = ntohs(ofm->hard_timeout);
1662             fm->buffer_id = ntohl(ofm->buffer_id);
1663             fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1664             fm->flags = ntohs(ofm->flags);
1665         } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1666             /* Nicira extended flow_mod. */
1667             const struct nx_flow_mod *nfm;
1668             enum ofperr error;
1669
1670             /* Dissect the message. */
1671             nfm = ofpbuf_pull(&b, sizeof *nfm);
1672             error = nx_pull_match(&b, ntohs(nfm->match_len),
1673                                   &fm->match, &fm->cookie, &fm->cookie_mask);
1674             if (error) {
1675                 return error;
1676             }
1677             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1678             if (error) {
1679                 return error;
1680             }
1681
1682             /* Translate the message. */
1683             command = ntohs(nfm->command);
1684             if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1685                 /* Flow additions may only set a new cookie, not match an
1686                  * existing cookie. */
1687                 return OFPERR_NXBRC_NXM_INVALID;
1688             }
1689             fm->priority = ntohs(nfm->priority);
1690             fm->new_cookie = nfm->cookie;
1691             fm->idle_timeout = ntohs(nfm->idle_timeout);
1692             fm->hard_timeout = ntohs(nfm->hard_timeout);
1693             fm->buffer_id = ntohl(nfm->buffer_id);
1694             fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1695             fm->flags = ntohs(nfm->flags);
1696         } else {
1697             NOT_REACHED();
1698         }
1699
1700         if (fm->flags & OFPFF10_EMERG) {
1701             /* We do not support the OpenFlow 1.0 emergency flow cache, which
1702              * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1703              *
1704              * OpenFlow 1.0 specifies the error code to use when idle_timeout
1705              * or hard_timeout is nonzero.  Otherwise, there is no good error
1706              * code, so just state that the flow table is full. */
1707             return (fm->hard_timeout || fm->idle_timeout
1708                     ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1709                     : OFPERR_OFPFMFC_TABLE_FULL);
1710         }
1711
1712         fm->modify_cookie = fm->new_cookie != htonll(UINT64_MAX);
1713         if (protocol & OFPUTIL_P_TID) {
1714             fm->command = command & 0xff;
1715             fm->table_id = command >> 8;
1716         } else {
1717             fm->command = command;
1718             fm->table_id = 0xff;
1719         }
1720     }
1721
1722     fm->ofpacts = ofpacts->data;
1723     fm->ofpacts_len = ofpacts->size;
1724
1725     return 0;
1726 }
1727
1728 static enum ofperr
1729 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1730                    struct ofpbuf *bands)
1731 {
1732     const struct ofp13_meter_band_header *ombh;
1733     struct ofputil_meter_band *mb;
1734     uint16_t n = 0;
1735
1736     ombh = ofpbuf_try_pull(msg, len);
1737     if (!ombh) {
1738         return OFPERR_OFPBRC_BAD_LEN;
1739     }
1740
1741     while (len >= sizeof (struct ofp13_meter_band_drop)) {
1742         size_t ombh_len = ntohs(ombh->len);
1743         /* All supported band types have the same length. */
1744         if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1745             return OFPERR_OFPBRC_BAD_LEN;
1746         }
1747         mb = ofpbuf_put_uninit(bands, sizeof *mb);
1748         mb->type = ntohs(ombh->type);
1749         mb->rate = ntohl(ombh->rate);
1750         mb->burst_size = ntohl(ombh->burst_size);
1751         mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1752             ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1753         n++;
1754         len -= ombh_len;
1755         ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1756                             (char *) ombh + ombh_len);
1757     }
1758     if (len) {
1759         return OFPERR_OFPBRC_BAD_LEN;
1760     }
1761     *n_bands = n;
1762     return 0;
1763 }
1764
1765 enum ofperr
1766 ofputil_decode_meter_mod(const struct ofp_header *oh,
1767                          struct ofputil_meter_mod *mm,
1768                          struct ofpbuf *bands)
1769 {
1770     const struct ofp13_meter_mod *omm;
1771     struct ofpbuf b;
1772
1773     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1774     ofpraw_pull_assert(&b);
1775     omm = ofpbuf_pull(&b, sizeof *omm);
1776
1777     /* Translate the message. */
1778     mm->command = ntohs(omm->command);
1779     mm->meter.meter_id = ntohl(omm->meter_id);
1780
1781     if (mm->command == OFPMC13_DELETE) {
1782         mm->meter.flags = 0;
1783         mm->meter.n_bands = 0;
1784         mm->meter.bands = NULL;
1785     } else {
1786         enum ofperr error;
1787
1788         mm->meter.flags = ntohs(omm->flags);
1789         mm->meter.bands = bands->data;
1790
1791         error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1792         if (error) {
1793             return error;
1794         }
1795     }
1796     return 0;
1797 }
1798
1799 void
1800 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1801 {
1802     const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1803     *meter_id = ntohl(omr->meter_id);
1804 }
1805
1806 struct ofpbuf *
1807 ofputil_encode_meter_request(enum ofp_version ofp_version,
1808                              enum ofputil_meter_request_type type,
1809                              uint32_t meter_id)
1810 {
1811     struct ofpbuf *msg;
1812
1813     enum ofpraw raw;
1814
1815     switch (type) {
1816     case OFPUTIL_METER_CONFIG:
1817         raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1818         break;
1819     case OFPUTIL_METER_STATS:
1820         raw = OFPRAW_OFPST13_METER_REQUEST;
1821         break;
1822     default:
1823     case OFPUTIL_METER_FEATURES:
1824         raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1825         break;
1826     }
1827
1828     msg = ofpraw_alloc(raw, ofp_version, 0);
1829
1830     if (type != OFPUTIL_METER_FEATURES) {
1831         struct ofp13_meter_multipart_request *omr;
1832         omr = ofpbuf_put_zeros(msg, sizeof *omr);
1833         omr->meter_id = htonl(meter_id);
1834     }
1835     return msg;
1836 }
1837
1838 static void
1839 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1840                   struct ofpbuf *msg)
1841 {
1842     uint16_t n = 0;
1843
1844     for (n = 0; n < n_bands; ++n) {
1845         /* Currently all band types have same size. */
1846         struct ofp13_meter_band_dscp_remark *ombh;
1847         size_t ombh_len = sizeof *ombh;
1848
1849         ombh = ofpbuf_put_zeros(msg, ombh_len);
1850
1851         ombh->type = htons(mb->type);
1852         ombh->len = htons(ombh_len);
1853         ombh->rate = htonl(mb->rate);
1854         ombh->burst_size = htonl(mb->burst_size);
1855         ombh->prec_level = mb->prec_level;
1856
1857         mb++;
1858     }
1859 }
1860
1861 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1862 void
1863 ofputil_append_meter_config(struct list *replies,
1864                             const struct ofputil_meter_config *mc)
1865 {
1866     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1867     size_t start_ofs = msg->size;
1868     struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1869     reply->flags = htons(mc->flags);
1870     reply->meter_id = htonl(mc->meter_id);
1871
1872     ofputil_put_bands(mc->n_bands, mc->bands, msg);
1873
1874     reply->length = htons(msg->size - start_ofs);
1875
1876     ofpmp_postappend(replies, start_ofs);
1877 }
1878
1879 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1880 void
1881 ofputil_append_meter_stats(struct list *replies,
1882                            const struct ofputil_meter_stats *ms)
1883 {
1884     struct ofp13_meter_stats *reply;
1885     uint16_t n = 0;
1886     uint16_t len;
1887
1888     len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1889     reply = ofpmp_append(replies, len);
1890
1891     reply->meter_id = htonl(ms->meter_id);
1892     reply->len = htons(len);
1893     memset(reply->pad, 0, sizeof reply->pad);
1894     reply->flow_count = htonl(ms->flow_count);
1895     reply->packet_in_count = htonll(ms->packet_in_count);
1896     reply->byte_in_count = htonll(ms->byte_in_count);
1897     reply->duration_sec = htonl(ms->duration_sec);
1898     reply->duration_nsec = htonl(ms->duration_nsec);
1899
1900     for (n = 0; n < ms->n_bands; ++n) {
1901         const struct ofputil_meter_band_stats *src = &ms->bands[n];
1902         struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1903
1904         dst->packet_band_count = htonll(src->packet_count);
1905         dst->byte_band_count = htonll(src->byte_count);
1906     }
1907 }
1908
1909 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1910  * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1911  * 'bands'.  The caller must have initialized 'bands' and retains ownership of
1912  * it across the call.
1913  *
1914  * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1915  * message.  Calling this function multiple times for a single 'msg' iterates
1916  * through the replies.  'bands' is cleared for each reply.
1917  *
1918  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1919  * otherwise a positive errno value. */
1920 int
1921 ofputil_decode_meter_config(struct ofpbuf *msg,
1922                             struct ofputil_meter_config *mc,
1923                             struct ofpbuf *bands)
1924 {
1925     const struct ofp13_meter_config *omc;
1926     enum ofperr err;
1927
1928     /* Pull OpenFlow headers for the first call. */
1929     if (!msg->l2) {
1930         ofpraw_pull_assert(msg);
1931     }
1932
1933     if (!msg->size) {
1934         return EOF;
1935     }
1936
1937     omc = ofpbuf_try_pull(msg, sizeof *omc);
1938     if (!omc) {
1939         VLOG_WARN_RL(&bad_ofmsg_rl,
1940                      "OFPMP_METER_CONFIG reply has %zu leftover bytes at end",
1941                      msg->size);
1942         return OFPERR_OFPBRC_BAD_LEN;
1943     }
1944
1945     ofpbuf_clear(bands);
1946     err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1947                              &mc->n_bands, bands);
1948     if (err) {
1949         return err;
1950     }
1951     mc->meter_id = ntohl(omc->meter_id);
1952     mc->flags = ntohs(omc->flags);
1953     mc->bands = bands->data;
1954
1955     return 0;
1956 }
1957
1958 static enum ofperr
1959 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1960                         struct ofpbuf *bands)
1961 {
1962     const struct ofp13_meter_band_stats *ombs;
1963     struct ofputil_meter_band_stats *mbs;
1964     uint16_t n, i;
1965
1966     ombs = ofpbuf_try_pull(msg, len);
1967     if (!ombs) {
1968         return OFPERR_OFPBRC_BAD_LEN;
1969     }
1970
1971     n = len / sizeof *ombs;
1972     if (len != n * sizeof *ombs) {
1973         return OFPERR_OFPBRC_BAD_LEN;
1974     }
1975
1976     mbs = ofpbuf_put_uninit(bands, len);
1977
1978     for (i = 0; i < n; ++i) {
1979         mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1980         mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1981     }
1982     *n_bands = n;
1983     return 0;
1984 }
1985
1986 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1987  * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1988  * decoded into 'bands'.
1989  *
1990  * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1991  * message.  Calling this function multiple times for a single 'msg' iterates
1992  * through the replies.  'bands' is cleared for each reply.
1993  *
1994  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1995  * otherwise a positive errno value. */
1996 int
1997 ofputil_decode_meter_stats(struct ofpbuf *msg,
1998                            struct ofputil_meter_stats *ms,
1999                            struct ofpbuf *bands)
2000 {
2001     const struct ofp13_meter_stats *oms;
2002     enum ofperr err;
2003
2004     /* Pull OpenFlow headers for the first call. */
2005     if (!msg->l2) {
2006         ofpraw_pull_assert(msg);
2007     }
2008
2009     if (!msg->size) {
2010         return EOF;
2011     }
2012
2013     oms = ofpbuf_try_pull(msg, sizeof *oms);
2014     if (!oms) {
2015         VLOG_WARN_RL(&bad_ofmsg_rl,
2016                      "OFPMP_METER reply has %zu leftover bytes at end",
2017                      msg->size);
2018         return OFPERR_OFPBRC_BAD_LEN;
2019     }
2020
2021     ofpbuf_clear(bands);
2022     err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2023                                   &ms->n_bands, bands);
2024     if (err) {
2025         return err;
2026     }
2027     ms->meter_id = ntohl(oms->meter_id);
2028     ms->flow_count = ntohl(oms->flow_count);
2029     ms->packet_in_count = ntohll(oms->packet_in_count);
2030     ms->byte_in_count = ntohll(oms->byte_in_count);
2031     ms->duration_sec = ntohl(oms->duration_sec);
2032     ms->duration_nsec = ntohl(oms->duration_nsec);
2033     ms->bands = bands->data;
2034
2035     return 0;
2036 }
2037
2038 void
2039 ofputil_decode_meter_features(const struct ofp_header *oh,
2040                               struct ofputil_meter_features *mf)
2041 {
2042     const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2043
2044     mf->max_meters = ntohl(omf->max_meter);
2045     mf->band_types = ntohl(omf->band_types);
2046     mf->capabilities = ntohl(omf->capabilities);
2047     mf->max_bands = omf->max_bands;
2048     mf->max_color = omf->max_color;
2049 }
2050
2051 struct ofpbuf *
2052 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2053                                     const struct ofp_header *request)
2054 {
2055     struct ofpbuf *reply;
2056     struct ofp13_meter_features *omf;
2057
2058     reply = ofpraw_alloc_stats_reply(request, 0);
2059     omf = ofpbuf_put_zeros(reply, sizeof *omf);
2060
2061     omf->max_meter = htonl(mf->max_meters);
2062     omf->band_types = htonl(mf->band_types);
2063     omf->capabilities = htonl(mf->capabilities);
2064     omf->max_bands = mf->max_bands;
2065     omf->max_color = mf->max_color;
2066
2067     return reply;
2068 }
2069
2070 struct ofpbuf *
2071 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2072                          const struct ofputil_meter_mod *mm)
2073 {
2074     struct ofpbuf *msg;
2075
2076     struct ofp13_meter_mod *omm;
2077
2078     msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2079                        NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2080     omm = ofpbuf_put_zeros(msg, sizeof *omm);
2081     omm->command = htons(mm->command);
2082     if (mm->command != OFPMC13_DELETE) {
2083         omm->flags = htons(mm->meter.flags);
2084     }
2085     omm->meter_id = htonl(mm->meter.meter_id);
2086
2087     ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2088
2089     ofpmsg_update_length(msg);
2090     return msg;
2091 }
2092
2093 static ovs_be16
2094 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2095                     enum ofputil_protocol protocol)
2096 {
2097     return htons(protocol & OFPUTIL_P_TID
2098                  ? (fm->command & 0xff) | (fm->table_id << 8)
2099                  : fm->command);
2100 }
2101
2102 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2103  * 'protocol' and returns the message. */
2104 struct ofpbuf *
2105 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2106                         enum ofputil_protocol protocol)
2107 {
2108     struct ofpbuf *msg;
2109
2110     switch (protocol) {
2111     case OFPUTIL_P_OF11_STD:
2112     case OFPUTIL_P_OF12_OXM:
2113     case OFPUTIL_P_OF13_OXM: {
2114         struct ofp11_flow_mod *ofm;
2115         int tailroom;
2116
2117         tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2118         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD,
2119                            ofputil_protocol_to_ofp_version(protocol),
2120                            tailroom);
2121         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2122         if ((protocol == OFPUTIL_P_OF11_STD
2123              && (fm->command == OFPFC_MODIFY ||
2124                  fm->command == OFPFC_MODIFY_STRICT)
2125              && fm->cookie_mask == htonll(0))
2126             || fm->command == OFPFC_ADD) {
2127             ofm->cookie = fm->new_cookie;
2128         } else {
2129             ofm->cookie = fm->cookie;
2130         }
2131         ofm->cookie_mask = fm->cookie_mask;
2132         ofm->table_id = fm->table_id;
2133         ofm->command = fm->command;
2134         ofm->idle_timeout = htons(fm->idle_timeout);
2135         ofm->hard_timeout = htons(fm->hard_timeout);
2136         ofm->priority = htons(fm->priority);
2137         ofm->buffer_id = htonl(fm->buffer_id);
2138         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2139         ofm->out_group = htonl(OFPG11_ANY);
2140         ofm->flags = htons(fm->flags);
2141         ofputil_put_ofp11_match(msg, &fm->match, protocol);
2142         ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
2143         break;
2144     }
2145
2146     case OFPUTIL_P_OF10_STD:
2147     case OFPUTIL_P_OF10_STD_TID: {
2148         struct ofp10_flow_mod *ofm;
2149
2150         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2151                            fm->ofpacts_len);
2152         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2153         ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2154         ofm->cookie = fm->new_cookie;
2155         ofm->command = ofputil_tid_command(fm, protocol);
2156         ofm->idle_timeout = htons(fm->idle_timeout);
2157         ofm->hard_timeout = htons(fm->hard_timeout);
2158         ofm->priority = htons(fm->priority);
2159         ofm->buffer_id = htonl(fm->buffer_id);
2160         ofm->out_port = htons(ofp_to_u16(fm->out_port));
2161         ofm->flags = htons(fm->flags);
2162         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2163         break;
2164     }
2165
2166     case OFPUTIL_P_OF10_NXM:
2167     case OFPUTIL_P_OF10_NXM_TID: {
2168         struct nx_flow_mod *nfm;
2169         int match_len;
2170
2171         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2172                            NXM_TYPICAL_LEN + fm->ofpacts_len);
2173         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2174         nfm->command = ofputil_tid_command(fm, protocol);
2175         nfm->cookie = fm->new_cookie;
2176         match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2177         nfm = msg->l3;
2178         nfm->idle_timeout = htons(fm->idle_timeout);
2179         nfm->hard_timeout = htons(fm->hard_timeout);
2180         nfm->priority = htons(fm->priority);
2181         nfm->buffer_id = htonl(fm->buffer_id);
2182         nfm->out_port = htons(ofp_to_u16(fm->out_port));
2183         nfm->flags = htons(fm->flags);
2184         nfm->match_len = htons(match_len);
2185         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2186         break;
2187     }
2188
2189     default:
2190         NOT_REACHED();
2191     }
2192
2193     ofpmsg_update_length(msg);
2194     return msg;
2195 }
2196
2197 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2198  * send all of the 'n_fm's flow table modification requests in 'fms', and a
2199  * 0-bit for each protocol that is inadequate.
2200  *
2201  * (The return value will have at least one 1-bit.) */
2202 enum ofputil_protocol
2203 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
2204                                   size_t n_fms)
2205 {
2206     enum ofputil_protocol usable_protocols;
2207     size_t i;
2208
2209     usable_protocols = OFPUTIL_P_ANY;
2210     for (i = 0; i < n_fms; i++) {
2211         const struct ofputil_flow_mod *fm = &fms[i];
2212
2213         usable_protocols &= ofputil_usable_protocols(&fm->match);
2214         if (fm->table_id != 0xff) {
2215             usable_protocols &= OFPUTIL_P_TID;
2216         }
2217
2218         /* Matching of the cookie is only supported through NXM or OF1.1+. */
2219         if (fm->cookie_mask != htonll(0)) {
2220             usable_protocols &= (OFPUTIL_P_OF10_NXM_ANY
2221                                  | OFPUTIL_P_OF11_STD
2222                                  | OFPUTIL_P_OF12_OXM
2223                                  | OFPUTIL_P_OF13_OXM);
2224         }
2225     }
2226
2227     return usable_protocols;
2228 }
2229
2230 static enum ofperr
2231 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2232                                     const struct ofp10_flow_stats_request *ofsr,
2233                                     bool aggregate)
2234 {
2235     fsr->aggregate = aggregate;
2236     ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2237     fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2238     fsr->table_id = ofsr->table_id;
2239     fsr->cookie = fsr->cookie_mask = htonll(0);
2240
2241     return 0;
2242 }
2243
2244 static enum ofperr
2245 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2246                                     struct ofpbuf *b, bool aggregate)
2247 {
2248     const struct ofp11_flow_stats_request *ofsr;
2249     enum ofperr error;
2250
2251     ofsr = ofpbuf_pull(b, sizeof *ofsr);
2252     fsr->aggregate = aggregate;
2253     fsr->table_id = ofsr->table_id;
2254     error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2255     if (error) {
2256         return error;
2257     }
2258     if (ofsr->out_group != htonl(OFPG11_ANY)) {
2259         return OFPERR_OFPFMFC_UNKNOWN;
2260     }
2261     fsr->cookie = ofsr->cookie;
2262     fsr->cookie_mask = ofsr->cookie_mask;
2263     error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2264     if (error) {
2265         return error;
2266     }
2267
2268     return 0;
2269 }
2270
2271 static enum ofperr
2272 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2273                                  struct ofpbuf *b, bool aggregate)
2274 {
2275     const struct nx_flow_stats_request *nfsr;
2276     enum ofperr error;
2277
2278     nfsr = ofpbuf_pull(b, sizeof *nfsr);
2279     error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2280                           &fsr->cookie, &fsr->cookie_mask);
2281     if (error) {
2282         return error;
2283     }
2284     if (b->size) {
2285         return OFPERR_OFPBRC_BAD_LEN;
2286     }
2287
2288     fsr->aggregate = aggregate;
2289     fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2290     fsr->table_id = nfsr->table_id;
2291
2292     return 0;
2293 }
2294
2295 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2296  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
2297  * successful, otherwise an OpenFlow error code. */
2298 enum ofperr
2299 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2300                                   const struct ofp_header *oh)
2301 {
2302     enum ofpraw raw;
2303     struct ofpbuf b;
2304
2305     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2306     raw = ofpraw_pull_assert(&b);
2307     switch ((int) raw) {
2308     case OFPRAW_OFPST10_FLOW_REQUEST:
2309         return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2310
2311     case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2312         return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2313
2314     case OFPRAW_OFPST11_FLOW_REQUEST:
2315         return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2316
2317     case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2318         return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2319
2320     case OFPRAW_NXST_FLOW_REQUEST:
2321         return ofputil_decode_nxst_flow_request(fsr, &b, false);
2322
2323     case OFPRAW_NXST_AGGREGATE_REQUEST:
2324         return ofputil_decode_nxst_flow_request(fsr, &b, true);
2325
2326     default:
2327         /* Hey, the caller lied. */
2328         NOT_REACHED();
2329     }
2330 }
2331
2332 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2333  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2334  * 'protocol', and returns the message. */
2335 struct ofpbuf *
2336 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2337                                   enum ofputil_protocol protocol)
2338 {
2339     struct ofpbuf *msg;
2340     enum ofpraw raw;
2341
2342     switch (protocol) {
2343     case OFPUTIL_P_OF11_STD:
2344     case OFPUTIL_P_OF12_OXM:
2345     case OFPUTIL_P_OF13_OXM: {
2346         struct ofp11_flow_stats_request *ofsr;
2347
2348         raw = (fsr->aggregate
2349                ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2350                : OFPRAW_OFPST11_FLOW_REQUEST);
2351         msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2352                            ofputil_match_typical_len(protocol));
2353         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2354         ofsr->table_id = fsr->table_id;
2355         ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2356         ofsr->out_group = htonl(OFPG11_ANY);
2357         ofsr->cookie = fsr->cookie;
2358         ofsr->cookie_mask = fsr->cookie_mask;
2359         ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2360         break;
2361     }
2362
2363     case OFPUTIL_P_OF10_STD:
2364     case OFPUTIL_P_OF10_STD_TID: {
2365         struct ofp10_flow_stats_request *ofsr;
2366
2367         raw = (fsr->aggregate
2368                ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2369                : OFPRAW_OFPST10_FLOW_REQUEST);
2370         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2371         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2372         ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2373         ofsr->table_id = fsr->table_id;
2374         ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2375         break;
2376     }
2377
2378     case OFPUTIL_P_OF10_NXM:
2379     case OFPUTIL_P_OF10_NXM_TID: {
2380         struct nx_flow_stats_request *nfsr;
2381         int match_len;
2382
2383         raw = (fsr->aggregate
2384                ? OFPRAW_NXST_AGGREGATE_REQUEST
2385                : OFPRAW_NXST_FLOW_REQUEST);
2386         msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2387         ofpbuf_put_zeros(msg, sizeof *nfsr);
2388         match_len = nx_put_match(msg, &fsr->match,
2389                                  fsr->cookie, fsr->cookie_mask);
2390
2391         nfsr = msg->l3;
2392         nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2393         nfsr->match_len = htons(match_len);
2394         nfsr->table_id = fsr->table_id;
2395         break;
2396     }
2397
2398     default:
2399         NOT_REACHED();
2400     }
2401
2402     return msg;
2403 }
2404
2405 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2406  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
2407  *
2408  * (The return value will have at least one 1-bit.) */
2409 enum ofputil_protocol
2410 ofputil_flow_stats_request_usable_protocols(
2411     const struct ofputil_flow_stats_request *fsr)
2412 {
2413     enum ofputil_protocol usable_protocols;
2414
2415     usable_protocols = ofputil_usable_protocols(&fsr->match);
2416     if (fsr->cookie_mask != htonll(0)) {
2417         usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
2418             | OFPUTIL_P_OF13_OXM;
2419     }
2420     return usable_protocols;
2421 }
2422
2423 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2424  * ofputil_flow_stats in 'fs'.
2425  *
2426  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2427  * OpenFlow message.  Calling this function multiple times for a single 'msg'
2428  * iterates through the replies.  The caller must initially leave 'msg''s layer
2429  * pointers null and not modify them between calls.
2430  *
2431  * Most switches don't send the values needed to populate fs->idle_age and
2432  * fs->hard_age, so those members will usually be set to 0.  If the switch from
2433  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2434  * 'flow_age_extension' as true so that the contents of 'msg' determine the
2435  * 'idle_age' and 'hard_age' members in 'fs'.
2436  *
2437  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2438  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
2439  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
2440  *
2441  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2442  * otherwise a positive errno value. */
2443 int
2444 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2445                                 struct ofpbuf *msg,
2446                                 bool flow_age_extension,
2447                                 struct ofpbuf *ofpacts)
2448 {
2449     enum ofperr error;
2450     enum ofpraw raw;
2451
2452     error = (msg->l2
2453              ? ofpraw_decode(&raw, msg->l2)
2454              : ofpraw_pull(&raw, msg));
2455     if (error) {
2456         return error;
2457     }
2458
2459     if (!msg->size) {
2460         return EOF;
2461     } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2462                || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2463         const struct ofp11_flow_stats *ofs;
2464         size_t length;
2465         uint16_t padded_match_len;
2466
2467         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2468         if (!ofs) {
2469             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2470                          "bytes at end", msg->size);
2471             return EINVAL;
2472         }
2473
2474         length = ntohs(ofs->length);
2475         if (length < sizeof *ofs) {
2476             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2477                          "length %zu", length);
2478             return EINVAL;
2479         }
2480
2481         if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2482             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2483             return EINVAL;
2484         }
2485
2486         if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
2487                                                  padded_match_len, ofpacts)) {
2488             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2489             return EINVAL;
2490         }
2491
2492         fs->priority = ntohs(ofs->priority);
2493         fs->table_id = ofs->table_id;
2494         fs->duration_sec = ntohl(ofs->duration_sec);
2495         fs->duration_nsec = ntohl(ofs->duration_nsec);
2496         fs->idle_timeout = ntohs(ofs->idle_timeout);
2497         fs->hard_timeout = ntohs(ofs->hard_timeout);
2498         fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0;
2499         fs->idle_age = -1;
2500         fs->hard_age = -1;
2501         fs->cookie = ofs->cookie;
2502         fs->packet_count = ntohll(ofs->packet_count);
2503         fs->byte_count = ntohll(ofs->byte_count);
2504     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2505         const struct ofp10_flow_stats *ofs;
2506         size_t length;
2507
2508         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2509         if (!ofs) {
2510             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2511                          "bytes at end", msg->size);
2512             return EINVAL;
2513         }
2514
2515         length = ntohs(ofs->length);
2516         if (length < sizeof *ofs) {
2517             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2518                          "length %zu", length);
2519             return EINVAL;
2520         }
2521
2522         if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2523             return EINVAL;
2524         }
2525
2526         fs->cookie = get_32aligned_be64(&ofs->cookie);
2527         ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2528         fs->priority = ntohs(ofs->priority);
2529         fs->table_id = ofs->table_id;
2530         fs->duration_sec = ntohl(ofs->duration_sec);
2531         fs->duration_nsec = ntohl(ofs->duration_nsec);
2532         fs->idle_timeout = ntohs(ofs->idle_timeout);
2533         fs->hard_timeout = ntohs(ofs->hard_timeout);
2534         fs->idle_age = -1;
2535         fs->hard_age = -1;
2536         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2537         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2538         fs->flags = 0;
2539     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2540         const struct nx_flow_stats *nfs;
2541         size_t match_len, actions_len, length;
2542
2543         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2544         if (!nfs) {
2545             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2546                          "bytes at end", msg->size);
2547             return EINVAL;
2548         }
2549
2550         length = ntohs(nfs->length);
2551         match_len = ntohs(nfs->match_len);
2552         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2553             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2554                          "claims invalid length %zu", match_len, length);
2555             return EINVAL;
2556         }
2557         if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2558             return EINVAL;
2559         }
2560
2561         actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2562         if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2563             return EINVAL;
2564         }
2565
2566         fs->cookie = nfs->cookie;
2567         fs->table_id = nfs->table_id;
2568         fs->duration_sec = ntohl(nfs->duration_sec);
2569         fs->duration_nsec = ntohl(nfs->duration_nsec);
2570         fs->priority = ntohs(nfs->priority);
2571         fs->idle_timeout = ntohs(nfs->idle_timeout);
2572         fs->hard_timeout = ntohs(nfs->hard_timeout);
2573         fs->idle_age = -1;
2574         fs->hard_age = -1;
2575         if (flow_age_extension) {
2576             if (nfs->idle_age) {
2577                 fs->idle_age = ntohs(nfs->idle_age) - 1;
2578             }
2579             if (nfs->hard_age) {
2580                 fs->hard_age = ntohs(nfs->hard_age) - 1;
2581             }
2582         }
2583         fs->packet_count = ntohll(nfs->packet_count);
2584         fs->byte_count = ntohll(nfs->byte_count);
2585         fs->flags = 0;
2586     } else {
2587         NOT_REACHED();
2588     }
2589
2590     fs->ofpacts = ofpacts->data;
2591     fs->ofpacts_len = ofpacts->size;
2592
2593     return 0;
2594 }
2595
2596 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2597  *
2598  * We use this in situations where OVS internally uses UINT64_MAX to mean
2599  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2600 static uint64_t
2601 unknown_to_zero(uint64_t count)
2602 {
2603     return count != UINT64_MAX ? count : 0;
2604 }
2605
2606 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2607  * those already present in the list of ofpbufs in 'replies'.  'replies' should
2608  * have been initialized with ofputil_start_stats_reply(). */
2609 void
2610 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2611                                 struct list *replies)
2612 {
2613     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2614     size_t start_ofs = reply->size;
2615     enum ofpraw raw;
2616
2617     ofpraw_decode_partial(&raw, reply->data, reply->size);
2618     if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2619         struct ofp11_flow_stats *ofs;
2620
2621         ofpbuf_put_uninit(reply, sizeof *ofs);
2622         oxm_put_match(reply, &fs->match);
2623         ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2624                                             reply);
2625
2626         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2627         ofs->length = htons(reply->size - start_ofs);
2628         ofs->table_id = fs->table_id;
2629         ofs->pad = 0;
2630         ofs->duration_sec = htonl(fs->duration_sec);
2631         ofs->duration_nsec = htonl(fs->duration_nsec);
2632         ofs->priority = htons(fs->priority);
2633         ofs->idle_timeout = htons(fs->idle_timeout);
2634         ofs->hard_timeout = htons(fs->hard_timeout);
2635         ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0;
2636         memset(ofs->pad2, 0, sizeof ofs->pad2);
2637         ofs->cookie = fs->cookie;
2638         ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2639         ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2640     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2641         struct ofp10_flow_stats *ofs;
2642
2643         ofpbuf_put_uninit(reply, sizeof *ofs);
2644         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2645
2646         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2647         ofs->length = htons(reply->size - start_ofs);
2648         ofs->table_id = fs->table_id;
2649         ofs->pad = 0;
2650         ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2651         ofs->duration_sec = htonl(fs->duration_sec);
2652         ofs->duration_nsec = htonl(fs->duration_nsec);
2653         ofs->priority = htons(fs->priority);
2654         ofs->idle_timeout = htons(fs->idle_timeout);
2655         ofs->hard_timeout = htons(fs->hard_timeout);
2656         memset(ofs->pad2, 0, sizeof ofs->pad2);
2657         put_32aligned_be64(&ofs->cookie, fs->cookie);
2658         put_32aligned_be64(&ofs->packet_count,
2659                            htonll(unknown_to_zero(fs->packet_count)));
2660         put_32aligned_be64(&ofs->byte_count,
2661                            htonll(unknown_to_zero(fs->byte_count)));
2662     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2663         struct nx_flow_stats *nfs;
2664         int match_len;
2665
2666         ofpbuf_put_uninit(reply, sizeof *nfs);
2667         match_len = nx_put_match(reply, &fs->match, 0, 0);
2668         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2669
2670         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2671         nfs->length = htons(reply->size - start_ofs);
2672         nfs->table_id = fs->table_id;
2673         nfs->pad = 0;
2674         nfs->duration_sec = htonl(fs->duration_sec);
2675         nfs->duration_nsec = htonl(fs->duration_nsec);
2676         nfs->priority = htons(fs->priority);
2677         nfs->idle_timeout = htons(fs->idle_timeout);
2678         nfs->hard_timeout = htons(fs->hard_timeout);
2679         nfs->idle_age = htons(fs->idle_age < 0 ? 0
2680                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2681                               : UINT16_MAX);
2682         nfs->hard_age = htons(fs->hard_age < 0 ? 0
2683                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2684                               : UINT16_MAX);
2685         nfs->match_len = htons(match_len);
2686         nfs->cookie = fs->cookie;
2687         nfs->packet_count = htonll(fs->packet_count);
2688         nfs->byte_count = htonll(fs->byte_count);
2689     } else {
2690         NOT_REACHED();
2691     }
2692
2693     ofpmp_postappend(replies, start_ofs);
2694 }
2695
2696 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2697  * NXST_AGGREGATE reply matching 'request', and returns the message. */
2698 struct ofpbuf *
2699 ofputil_encode_aggregate_stats_reply(
2700     const struct ofputil_aggregate_stats *stats,
2701     const struct ofp_header *request)
2702 {
2703     struct ofp_aggregate_stats_reply *asr;
2704     uint64_t packet_count;
2705     uint64_t byte_count;
2706     struct ofpbuf *msg;
2707     enum ofpraw raw;
2708
2709     ofpraw_decode(&raw, request);
2710     if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2711         packet_count = unknown_to_zero(stats->packet_count);
2712         byte_count = unknown_to_zero(stats->byte_count);
2713     } else {
2714         packet_count = stats->packet_count;
2715         byte_count = stats->byte_count;
2716     }
2717
2718     msg = ofpraw_alloc_stats_reply(request, 0);
2719     asr = ofpbuf_put_zeros(msg, sizeof *asr);
2720     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2721     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2722     asr->flow_count = htonl(stats->flow_count);
2723
2724     return msg;
2725 }
2726
2727 enum ofperr
2728 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2729                                      const struct ofp_header *reply)
2730 {
2731     struct ofp_aggregate_stats_reply *asr;
2732     struct ofpbuf msg;
2733
2734     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2735     ofpraw_pull_assert(&msg);
2736
2737     asr = msg.l3;
2738     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2739     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2740     stats->flow_count = ntohl(asr->flow_count);
2741
2742     return 0;
2743 }
2744
2745 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2746  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
2747  * an OpenFlow error code. */
2748 enum ofperr
2749 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2750                             const struct ofp_header *oh)
2751 {
2752     enum ofpraw raw;
2753     struct ofpbuf b;
2754
2755     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2756     raw = ofpraw_pull_assert(&b);
2757     if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2758         const struct ofp12_flow_removed *ofr;
2759         enum ofperr error;
2760
2761         ofr = ofpbuf_pull(&b, sizeof *ofr);
2762
2763         error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2764         if (error) {
2765             return error;
2766         }
2767
2768         fr->priority = ntohs(ofr->priority);
2769         fr->cookie = ofr->cookie;
2770         fr->reason = ofr->reason;
2771         fr->table_id = ofr->table_id;
2772         fr->duration_sec = ntohl(ofr->duration_sec);
2773         fr->duration_nsec = ntohl(ofr->duration_nsec);
2774         fr->idle_timeout = ntohs(ofr->idle_timeout);
2775         fr->hard_timeout = ntohs(ofr->hard_timeout);
2776         fr->packet_count = ntohll(ofr->packet_count);
2777         fr->byte_count = ntohll(ofr->byte_count);
2778     } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2779         const struct ofp10_flow_removed *ofr;
2780
2781         ofr = ofpbuf_pull(&b, sizeof *ofr);
2782
2783         ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2784         fr->priority = ntohs(ofr->priority);
2785         fr->cookie = ofr->cookie;
2786         fr->reason = ofr->reason;
2787         fr->table_id = 255;
2788         fr->duration_sec = ntohl(ofr->duration_sec);
2789         fr->duration_nsec = ntohl(ofr->duration_nsec);
2790         fr->idle_timeout = ntohs(ofr->idle_timeout);
2791         fr->hard_timeout = 0;
2792         fr->packet_count = ntohll(ofr->packet_count);
2793         fr->byte_count = ntohll(ofr->byte_count);
2794     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2795         struct nx_flow_removed *nfr;
2796         enum ofperr error;
2797
2798         nfr = ofpbuf_pull(&b, sizeof *nfr);
2799         error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2800                               NULL, NULL);
2801         if (error) {
2802             return error;
2803         }
2804         if (b.size) {
2805             return OFPERR_OFPBRC_BAD_LEN;
2806         }
2807
2808         fr->priority = ntohs(nfr->priority);
2809         fr->cookie = nfr->cookie;
2810         fr->reason = nfr->reason;
2811         fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
2812         fr->duration_sec = ntohl(nfr->duration_sec);
2813         fr->duration_nsec = ntohl(nfr->duration_nsec);
2814         fr->idle_timeout = ntohs(nfr->idle_timeout);
2815         fr->hard_timeout = 0;
2816         fr->packet_count = ntohll(nfr->packet_count);
2817         fr->byte_count = ntohll(nfr->byte_count);
2818     } else {
2819         NOT_REACHED();
2820     }
2821
2822     return 0;
2823 }
2824
2825 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2826  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2827  * message. */
2828 struct ofpbuf *
2829 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2830                             enum ofputil_protocol protocol)
2831 {
2832     struct ofpbuf *msg;
2833
2834     switch (protocol) {
2835     case OFPUTIL_P_OF11_STD:
2836     case OFPUTIL_P_OF12_OXM:
2837     case OFPUTIL_P_OF13_OXM: {
2838         struct ofp12_flow_removed *ofr;
2839
2840         msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2841                                ofputil_protocol_to_ofp_version(protocol),
2842                                htonl(0),
2843                                ofputil_match_typical_len(protocol));
2844         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2845         ofr->cookie = fr->cookie;
2846         ofr->priority = htons(fr->priority);
2847         ofr->reason = fr->reason;
2848         ofr->table_id = fr->table_id;
2849         ofr->duration_sec = htonl(fr->duration_sec);
2850         ofr->duration_nsec = htonl(fr->duration_nsec);
2851         ofr->idle_timeout = htons(fr->idle_timeout);
2852         ofr->hard_timeout = htons(fr->hard_timeout);
2853         ofr->packet_count = htonll(fr->packet_count);
2854         ofr->byte_count = htonll(fr->byte_count);
2855         ofputil_put_ofp11_match(msg, &fr->match, protocol);
2856         break;
2857     }
2858
2859     case OFPUTIL_P_OF10_STD:
2860     case OFPUTIL_P_OF10_STD_TID: {
2861         struct ofp10_flow_removed *ofr;
2862
2863         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2864                                htonl(0), 0);
2865         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2866         ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2867         ofr->cookie = fr->cookie;
2868         ofr->priority = htons(fr->priority);
2869         ofr->reason = fr->reason;
2870         ofr->duration_sec = htonl(fr->duration_sec);
2871         ofr->duration_nsec = htonl(fr->duration_nsec);
2872         ofr->idle_timeout = htons(fr->idle_timeout);
2873         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2874         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2875         break;
2876     }
2877
2878     case OFPUTIL_P_OF10_NXM:
2879     case OFPUTIL_P_OF10_NXM_TID: {
2880         struct nx_flow_removed *nfr;
2881         int match_len;
2882
2883         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2884                                htonl(0), NXM_TYPICAL_LEN);
2885         nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2886         match_len = nx_put_match(msg, &fr->match, 0, 0);
2887
2888         nfr = msg->l3;
2889         nfr->cookie = fr->cookie;
2890         nfr->priority = htons(fr->priority);
2891         nfr->reason = fr->reason;
2892         nfr->table_id = fr->table_id + 1;
2893         nfr->duration_sec = htonl(fr->duration_sec);
2894         nfr->duration_nsec = htonl(fr->duration_nsec);
2895         nfr->idle_timeout = htons(fr->idle_timeout);
2896         nfr->match_len = htons(match_len);
2897         nfr->packet_count = htonll(fr->packet_count);
2898         nfr->byte_count = htonll(fr->byte_count);
2899         break;
2900     }
2901
2902     default:
2903         NOT_REACHED();
2904     }
2905
2906     return msg;
2907 }
2908
2909 static void
2910 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2911                                 struct match *match, struct ofpbuf *b)
2912 {
2913     pin->packet = b->data;
2914     pin->packet_len = b->size;
2915
2916     pin->fmd.in_port = match->flow.in_port.ofp_port;
2917     pin->fmd.tun_id = match->flow.tunnel.tun_id;
2918     pin->fmd.tun_src = match->flow.tunnel.ip_src;
2919     pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
2920     pin->fmd.metadata = match->flow.metadata;
2921     memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2922     pin->fmd.pkt_mark = match->flow.pkt_mark;
2923 }
2924
2925 enum ofperr
2926 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2927                          const struct ofp_header *oh)
2928 {
2929     enum ofpraw raw;
2930     struct ofpbuf b;
2931
2932     memset(pin, 0, sizeof *pin);
2933
2934     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2935     raw = ofpraw_pull_assert(&b);
2936     if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
2937         const struct ofp13_packet_in *opi;
2938         struct match match;
2939         int error;
2940         size_t packet_in_size;
2941
2942         if (raw == OFPRAW_OFPT12_PACKET_IN) {
2943             packet_in_size = sizeof (struct ofp12_packet_in);
2944         } else {
2945             packet_in_size = sizeof (struct ofp13_packet_in);
2946         }
2947
2948         opi = ofpbuf_pull(&b, packet_in_size);
2949         error = oxm_pull_match_loose(&b, &match);
2950         if (error) {
2951             return error;
2952         }
2953
2954         if (!ofpbuf_try_pull(&b, 2)) {
2955             return OFPERR_OFPBRC_BAD_LEN;
2956         }
2957
2958         pin->reason = opi->pi.reason;
2959         pin->table_id = opi->pi.table_id;
2960         pin->buffer_id = ntohl(opi->pi.buffer_id);
2961         pin->total_len = ntohs(opi->pi.total_len);
2962
2963         if (raw == OFPRAW_OFPT13_PACKET_IN) {
2964             pin->cookie = opi->cookie;
2965         }
2966
2967         ofputil_decode_packet_in_finish(pin, &match, &b);
2968     } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2969         const struct ofp10_packet_in *opi;
2970
2971         opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
2972
2973         pin->packet = opi->data;
2974         pin->packet_len = b.size;
2975
2976         pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
2977         pin->reason = opi->reason;
2978         pin->buffer_id = ntohl(opi->buffer_id);
2979         pin->total_len = ntohs(opi->total_len);
2980     } else if (raw == OFPRAW_NXT_PACKET_IN) {
2981         const struct nx_packet_in *npi;
2982         struct match match;
2983         int error;
2984
2985         npi = ofpbuf_pull(&b, sizeof *npi);
2986         error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2987                                     NULL);
2988         if (error) {
2989             return error;
2990         }
2991
2992         if (!ofpbuf_try_pull(&b, 2)) {
2993             return OFPERR_OFPBRC_BAD_LEN;
2994         }
2995
2996         pin->reason = npi->reason;
2997         pin->table_id = npi->table_id;
2998         pin->cookie = npi->cookie;
2999
3000         pin->buffer_id = ntohl(npi->buffer_id);
3001         pin->total_len = ntohs(npi->total_len);
3002
3003         ofputil_decode_packet_in_finish(pin, &match, &b);
3004     } else {
3005         NOT_REACHED();
3006     }
3007
3008     return 0;
3009 }
3010
3011 static void
3012 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
3013                            struct match *match)
3014 {
3015     int i;
3016
3017     match_init_catchall(match);
3018     if (pin->fmd.tun_id != htonll(0)) {
3019         match_set_tun_id(match, pin->fmd.tun_id);
3020     }
3021     if (pin->fmd.tun_src != htonl(0)) {
3022         match_set_tun_src(match, pin->fmd.tun_src);
3023     }
3024     if (pin->fmd.tun_dst != htonl(0)) {
3025         match_set_tun_dst(match, pin->fmd.tun_dst);
3026     }
3027     if (pin->fmd.metadata != htonll(0)) {
3028         match_set_metadata(match, pin->fmd.metadata);
3029     }
3030
3031     for (i = 0; i < FLOW_N_REGS; i++) {
3032         if (pin->fmd.regs[i]) {
3033             match_set_reg(match, i, pin->fmd.regs[i]);
3034         }
3035     }
3036
3037     if (pin->fmd.pkt_mark != 0) {
3038         match_set_pkt_mark(match, pin->fmd.pkt_mark);
3039     }
3040
3041     match_set_in_port(match, pin->fmd.in_port);
3042 }
3043
3044 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3045  * in the format specified by 'packet_in_format'.  */
3046 struct ofpbuf *
3047 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3048                          enum ofputil_protocol protocol,
3049                          enum nx_packet_in_format packet_in_format)
3050 {
3051     size_t send_len = MIN(pin->send_len, pin->packet_len);
3052     struct ofpbuf *packet;
3053
3054     /* Add OFPT_PACKET_IN. */
3055     if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
3056         struct ofp13_packet_in *opi;
3057         struct match match;
3058         enum ofpraw packet_in_raw;
3059         enum ofp_version packet_in_version;
3060         size_t packet_in_size;
3061
3062         if (protocol == OFPUTIL_P_OF12_OXM) {
3063             packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3064             packet_in_version = OFP12_VERSION;
3065             packet_in_size = sizeof (struct ofp12_packet_in);
3066         } else {
3067             packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3068             packet_in_version = OFP13_VERSION;
3069             packet_in_size = sizeof (struct ofp13_packet_in);
3070         }
3071
3072         ofputil_packet_in_to_match(pin, &match);
3073
3074         /* The final argument is just an estimate of the space required. */
3075         packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3076                                   htonl(0), (sizeof(struct flow_metadata) * 2
3077                                              + 2 + send_len));
3078         ofpbuf_put_zeros(packet, packet_in_size);
3079         oxm_put_match(packet, &match);
3080         ofpbuf_put_zeros(packet, 2);
3081         ofpbuf_put(packet, pin->packet, send_len);
3082
3083         opi = packet->l3;
3084         opi->pi.buffer_id = htonl(pin->buffer_id);
3085         opi->pi.total_len = htons(pin->total_len);
3086         opi->pi.reason = pin->reason;
3087         opi->pi.table_id = pin->table_id;
3088         if (protocol == OFPUTIL_P_OF13_OXM) {
3089             opi->cookie = pin->cookie;
3090         }
3091     } else if (packet_in_format == NXPIF_OPENFLOW10) {
3092         struct ofp10_packet_in *opi;
3093
3094         packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3095                                   htonl(0), send_len);
3096         opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3097         opi->total_len = htons(pin->total_len);
3098         opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
3099         opi->reason = pin->reason;
3100         opi->buffer_id = htonl(pin->buffer_id);
3101
3102         ofpbuf_put(packet, pin->packet, send_len);
3103     } else if (packet_in_format == NXPIF_NXM) {
3104         struct nx_packet_in *npi;
3105         struct match match;
3106         size_t match_len;
3107
3108         ofputil_packet_in_to_match(pin, &match);
3109
3110         /* The final argument is just an estimate of the space required. */
3111         packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3112                                   htonl(0), (sizeof(struct flow_metadata) * 2
3113                                              + 2 + send_len));
3114         ofpbuf_put_zeros(packet, sizeof *npi);
3115         match_len = nx_put_match(packet, &match, 0, 0);
3116         ofpbuf_put_zeros(packet, 2);
3117         ofpbuf_put(packet, pin->packet, send_len);
3118
3119         npi = packet->l3;
3120         npi->buffer_id = htonl(pin->buffer_id);
3121         npi->total_len = htons(pin->total_len);
3122         npi->reason = pin->reason;
3123         npi->table_id = pin->table_id;
3124         npi->cookie = pin->cookie;
3125         npi->match_len = htons(match_len);
3126     } else {
3127         NOT_REACHED();
3128     }
3129     ofpmsg_update_length(packet);
3130
3131     return packet;
3132 }
3133
3134 /* Returns a string form of 'reason'.  The return value is either a statically
3135  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3136  * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3137 const char *
3138 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3139                                    char *reasonbuf, size_t bufsize)
3140 {
3141     switch (reason) {
3142     case OFPR_NO_MATCH:
3143         return "no_match";
3144     case OFPR_ACTION:
3145         return "action";
3146     case OFPR_INVALID_TTL:
3147         return "invalid_ttl";
3148
3149     case OFPR_N_REASONS:
3150     default:
3151         snprintf(reasonbuf, bufsize, "%d", (int) reason);
3152         return reasonbuf;
3153     }
3154 }
3155
3156 bool
3157 ofputil_packet_in_reason_from_string(const char *s,
3158                                      enum ofp_packet_in_reason *reason)
3159 {
3160     int i;
3161
3162     for (i = 0; i < OFPR_N_REASONS; i++) {
3163         char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3164         const char *reason_s;
3165
3166         reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3167                                                       sizeof reasonbuf);
3168         if (!strcasecmp(s, reason_s)) {
3169             *reason = i;
3170             return true;
3171         }
3172     }
3173     return false;
3174 }
3175
3176 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3177  * 'po'.
3178  *
3179  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3180  * message's actions.  The caller must initialize 'ofpacts' and retains
3181  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
3182  *
3183  * Returns 0 if successful, otherwise an OFPERR_* value. */
3184 enum ofperr
3185 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3186                           const struct ofp_header *oh,
3187                           struct ofpbuf *ofpacts)
3188 {
3189     enum ofpraw raw;
3190     struct ofpbuf b;
3191
3192     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3193     raw = ofpraw_pull_assert(&b);
3194
3195     if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3196         enum ofperr error;
3197         const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3198
3199         po->buffer_id = ntohl(opo->buffer_id);
3200         error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3201         if (error) {
3202             return error;
3203         }
3204
3205         error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
3206                                                 ofpacts);
3207         if (error) {
3208             return error;
3209         }
3210     } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3211         enum ofperr error;
3212         const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3213
3214         po->buffer_id = ntohl(opo->buffer_id);
3215         po->in_port = u16_to_ofp(ntohs(opo->in_port));
3216
3217         error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
3218         if (error) {
3219             return error;
3220         }
3221     } else {
3222         NOT_REACHED();
3223     }
3224
3225     if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3226         && po->in_port != OFPP_LOCAL
3227         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3228         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3229                      po->in_port);
3230         return OFPERR_OFPBRC_BAD_PORT;
3231     }
3232
3233     po->ofpacts = ofpacts->data;
3234     po->ofpacts_len = ofpacts->size;
3235
3236     if (po->buffer_id == UINT32_MAX) {
3237         po->packet = b.data;
3238         po->packet_len = b.size;
3239     } else {
3240         po->packet = NULL;
3241         po->packet_len = 0;
3242     }
3243
3244     return 0;
3245 }
3246 \f
3247 /* ofputil_phy_port */
3248
3249 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3250 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
3251 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
3252 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
3253 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
3254 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
3255 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
3256 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
3257
3258 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3259 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3260 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3261 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3262 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3263 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3264
3265 static enum netdev_features
3266 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3267 {
3268     uint32_t ofp10 = ntohl(ofp10_);
3269     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3270 }
3271
3272 static ovs_be32
3273 netdev_port_features_to_ofp10(enum netdev_features features)
3274 {
3275     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3276 }
3277
3278 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
3279 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
3280 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
3281 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
3282 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
3283 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
3284 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
3285 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
3286 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
3287 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
3288 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
3289 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
3290 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
3291 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
3292 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
3293 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3294
3295 static enum netdev_features
3296 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3297 {
3298     return ntohl(ofp11) & 0xffff;
3299 }
3300
3301 static ovs_be32
3302 netdev_port_features_to_ofp11(enum netdev_features features)
3303 {
3304     return htonl(features & 0xffff);
3305 }
3306
3307 static enum ofperr
3308 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3309                               const struct ofp10_phy_port *opp)
3310 {
3311     memset(pp, 0, sizeof *pp);
3312
3313     pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3314     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3315     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3316
3317     pp->config = ntohl(opp->config) & OFPPC10_ALL;
3318     pp->state = ntohl(opp->state) & OFPPS10_ALL;
3319
3320     pp->curr = netdev_port_features_from_ofp10(opp->curr);
3321     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3322     pp->supported = netdev_port_features_from_ofp10(opp->supported);
3323     pp->peer = netdev_port_features_from_ofp10(opp->peer);
3324
3325     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3326     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3327
3328     return 0;
3329 }
3330
3331 static enum ofperr
3332 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3333                           const struct ofp11_port *op)
3334 {
3335     enum ofperr error;
3336
3337     memset(pp, 0, sizeof *pp);
3338
3339     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3340     if (error) {
3341         return error;
3342     }
3343     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3344     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3345
3346     pp->config = ntohl(op->config) & OFPPC11_ALL;
3347     pp->state = ntohl(op->state) & OFPPC11_ALL;
3348
3349     pp->curr = netdev_port_features_from_ofp11(op->curr);
3350     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3351     pp->supported = netdev_port_features_from_ofp11(op->supported);
3352     pp->peer = netdev_port_features_from_ofp11(op->peer);
3353
3354     pp->curr_speed = ntohl(op->curr_speed);
3355     pp->max_speed = ntohl(op->max_speed);
3356
3357     return 0;
3358 }
3359
3360 static size_t
3361 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3362 {
3363     switch (ofp_version) {
3364     case OFP10_VERSION:
3365         return sizeof(struct ofp10_phy_port);
3366     case OFP11_VERSION:
3367     case OFP12_VERSION:
3368     case OFP13_VERSION:
3369         return sizeof(struct ofp11_port);
3370     default:
3371         NOT_REACHED();
3372     }
3373 }
3374
3375 static void
3376 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3377                               struct ofp10_phy_port *opp)
3378 {
3379     memset(opp, 0, sizeof *opp);
3380
3381     opp->port_no = htons(ofp_to_u16(pp->port_no));
3382     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3383     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3384
3385     opp->config = htonl(pp->config & OFPPC10_ALL);
3386     opp->state = htonl(pp->state & OFPPS10_ALL);
3387
3388     opp->curr = netdev_port_features_to_ofp10(pp->curr);
3389     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3390     opp->supported = netdev_port_features_to_ofp10(pp->supported);
3391     opp->peer = netdev_port_features_to_ofp10(pp->peer);
3392 }
3393
3394 static void
3395 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3396                           struct ofp11_port *op)
3397 {
3398     memset(op, 0, sizeof *op);
3399
3400     op->port_no = ofputil_port_to_ofp11(pp->port_no);
3401     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3402     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3403
3404     op->config = htonl(pp->config & OFPPC11_ALL);
3405     op->state = htonl(pp->state & OFPPS11_ALL);
3406
3407     op->curr = netdev_port_features_to_ofp11(pp->curr);
3408     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3409     op->supported = netdev_port_features_to_ofp11(pp->supported);
3410     op->peer = netdev_port_features_to_ofp11(pp->peer);
3411
3412     op->curr_speed = htonl(pp->curr_speed);
3413     op->max_speed = htonl(pp->max_speed);
3414 }
3415
3416 static void
3417 ofputil_put_phy_port(enum ofp_version ofp_version,
3418                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
3419 {
3420     switch (ofp_version) {
3421     case OFP10_VERSION: {
3422         struct ofp10_phy_port *opp;
3423         if (b->size + sizeof *opp <= UINT16_MAX) {
3424             opp = ofpbuf_put_uninit(b, sizeof *opp);
3425             ofputil_encode_ofp10_phy_port(pp, opp);
3426         }
3427         break;
3428     }
3429
3430     case OFP11_VERSION:
3431     case OFP12_VERSION:
3432     case OFP13_VERSION: {
3433         struct ofp11_port *op;
3434         if (b->size + sizeof *op <= UINT16_MAX) {
3435             op = ofpbuf_put_uninit(b, sizeof *op);
3436             ofputil_encode_ofp11_port(pp, op);
3437         }
3438         break;
3439     }
3440
3441     default:
3442         NOT_REACHED();
3443     }
3444 }
3445
3446 void
3447 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3448                                      const struct ofputil_phy_port *pp,
3449                                      struct list *replies)
3450 {
3451     switch (ofp_version) {
3452     case OFP10_VERSION: {
3453         struct ofp10_phy_port *opp;
3454
3455         opp = ofpmp_append(replies, sizeof *opp);
3456         ofputil_encode_ofp10_phy_port(pp, opp);
3457         break;
3458     }
3459
3460     case OFP11_VERSION:
3461     case OFP12_VERSION:
3462     case OFP13_VERSION: {
3463         struct ofp11_port *op;
3464
3465         op = ofpmp_append(replies, sizeof *op);
3466         ofputil_encode_ofp11_port(pp, op);
3467         break;
3468     }
3469
3470     default:
3471       NOT_REACHED();
3472     }
3473 }
3474 \f
3475 /* ofputil_switch_features */
3476
3477 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3478                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
3479 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3480 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3481 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3482 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3483 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3484 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3485
3486 struct ofputil_action_bit_translation {
3487     enum ofputil_action_bitmap ofputil_bit;
3488     int of_bit;
3489 };
3490
3491 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3492     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
3493     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3494     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3495     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
3496     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
3497     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
3498     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
3499     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
3500     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
3501     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
3502     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
3503     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
3504     { 0, 0 },
3505 };
3506
3507 static enum ofputil_action_bitmap
3508 decode_action_bits(ovs_be32 of_actions,
3509                    const struct ofputil_action_bit_translation *x)
3510 {
3511     enum ofputil_action_bitmap ofputil_actions;
3512
3513     ofputil_actions = 0;
3514     for (; x->ofputil_bit; x++) {
3515         if (of_actions & htonl(1u << x->of_bit)) {
3516             ofputil_actions |= x->ofputil_bit;
3517         }
3518     }
3519     return ofputil_actions;
3520 }
3521
3522 static uint32_t
3523 ofputil_capabilities_mask(enum ofp_version ofp_version)
3524 {
3525     /* Handle capabilities whose bit is unique for all Open Flow versions */
3526     switch (ofp_version) {
3527     case OFP10_VERSION:
3528     case OFP11_VERSION:
3529         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3530     case OFP12_VERSION:
3531     case OFP13_VERSION:
3532         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3533     default:
3534         /* Caller needs to check osf->header.version itself */
3535         return 0;
3536     }
3537 }
3538
3539 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3540  * abstract representation in '*features'.  Initializes '*b' to iterate over
3541  * the OpenFlow port structures following 'osf' with later calls to
3542  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
3543  * OFPERR_* value.  */
3544 enum ofperr
3545 ofputil_decode_switch_features(const struct ofp_header *oh,
3546                                struct ofputil_switch_features *features,
3547                                struct ofpbuf *b)
3548 {
3549     const struct ofp_switch_features *osf;
3550     enum ofpraw raw;
3551
3552     ofpbuf_use_const(b, oh, ntohs(oh->length));
3553     raw = ofpraw_pull_assert(b);
3554
3555     osf = ofpbuf_pull(b, sizeof *osf);
3556     features->datapath_id = ntohll(osf->datapath_id);
3557     features->n_buffers = ntohl(osf->n_buffers);
3558     features->n_tables = osf->n_tables;
3559     features->auxiliary_id = 0;
3560
3561     features->capabilities = ntohl(osf->capabilities) &
3562         ofputil_capabilities_mask(oh->version);
3563
3564     if (b->size % ofputil_get_phy_port_size(oh->version)) {
3565         return OFPERR_OFPBRC_BAD_LEN;
3566     }
3567
3568     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3569         if (osf->capabilities & htonl(OFPC10_STP)) {
3570             features->capabilities |= OFPUTIL_C_STP;
3571         }
3572         features->actions = decode_action_bits(osf->actions, of10_action_bits);
3573     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3574                || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3575         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3576             features->capabilities |= OFPUTIL_C_GROUP_STATS;
3577         }
3578         features->actions = 0;
3579         if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3580             features->auxiliary_id = osf->auxiliary_id;
3581         }
3582     } else {
3583         return OFPERR_OFPBRC_BAD_VERSION;
3584     }
3585
3586     return 0;
3587 }
3588
3589 /* Returns true if the maximum number of ports are in 'oh'. */
3590 static bool
3591 max_ports_in_features(const struct ofp_header *oh)
3592 {
3593     size_t pp_size = ofputil_get_phy_port_size(oh->version);
3594     return ntohs(oh->length) + pp_size > UINT16_MAX;
3595 }
3596
3597 /* Given a buffer 'b' that contains a Features Reply message, checks if
3598  * it contains the maximum number of ports that will fit.  If so, it
3599  * returns true and removes the ports from the message.  The caller
3600  * should then send an OFPST_PORT_DESC stats request to get the ports,
3601  * since the switch may have more ports than could be represented in the
3602  * Features Reply.  Otherwise, returns false.
3603  */
3604 bool
3605 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3606 {
3607     struct ofp_header *oh = b->data;
3608
3609     if (max_ports_in_features(oh)) {
3610         /* Remove all the ports. */
3611         b->size = (sizeof(struct ofp_header)
3612                    + sizeof(struct ofp_switch_features));
3613         ofpmsg_update_length(b);
3614
3615         return true;
3616     }
3617
3618     return false;
3619 }
3620
3621 static ovs_be32
3622 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3623                    const struct ofputil_action_bit_translation *x)
3624 {
3625     uint32_t of_actions;
3626
3627     of_actions = 0;
3628     for (; x->ofputil_bit; x++) {
3629         if (ofputil_actions & x->ofputil_bit) {
3630             of_actions |= 1 << x->of_bit;
3631         }
3632     }
3633     return htonl(of_actions);
3634 }
3635
3636 /* Returns a buffer owned by the caller that encodes 'features' in the format
3637  * required by 'protocol' with the given 'xid'.  The caller should append port
3638  * information to the buffer with subsequent calls to
3639  * ofputil_put_switch_features_port(). */
3640 struct ofpbuf *
3641 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3642                                enum ofputil_protocol protocol, ovs_be32 xid)
3643 {
3644     struct ofp_switch_features *osf;
3645     struct ofpbuf *b;
3646     enum ofp_version version;
3647     enum ofpraw raw;
3648
3649     version = ofputil_protocol_to_ofp_version(protocol);
3650     switch (version) {
3651     case OFP10_VERSION:
3652         raw = OFPRAW_OFPT10_FEATURES_REPLY;
3653         break;
3654     case OFP11_VERSION:
3655     case OFP12_VERSION:
3656         raw = OFPRAW_OFPT11_FEATURES_REPLY;
3657         break;
3658     case OFP13_VERSION:
3659         raw = OFPRAW_OFPT13_FEATURES_REPLY;
3660         break;
3661     default:
3662         NOT_REACHED();
3663     }
3664     b = ofpraw_alloc_xid(raw, version, xid, 0);
3665     osf = ofpbuf_put_zeros(b, sizeof *osf);
3666     osf->datapath_id = htonll(features->datapath_id);
3667     osf->n_buffers = htonl(features->n_buffers);
3668     osf->n_tables = features->n_tables;
3669
3670     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3671     osf->capabilities = htonl(features->capabilities &
3672                               ofputil_capabilities_mask(version));
3673     switch (version) {
3674     case OFP10_VERSION:
3675         if (features->capabilities & OFPUTIL_C_STP) {
3676             osf->capabilities |= htonl(OFPC10_STP);
3677         }
3678         osf->actions = encode_action_bits(features->actions, of10_action_bits);
3679         break;
3680     case OFP13_VERSION:
3681         osf->auxiliary_id = features->auxiliary_id;
3682         /* fall through */
3683     case OFP11_VERSION:
3684     case OFP12_VERSION:
3685         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3686             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3687         }
3688         break;
3689     default:
3690         NOT_REACHED();
3691     }
3692
3693     return b;
3694 }
3695
3696 /* Encodes 'pp' into the format required by the switch_features message already
3697  * in 'b', which should have been returned by ofputil_encode_switch_features(),
3698  * and appends the encoded version to 'b'. */
3699 void
3700 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3701                                  struct ofpbuf *b)
3702 {
3703     const struct ofp_header *oh = b->data;
3704
3705     if (oh->version < OFP13_VERSION) {
3706         ofputil_put_phy_port(oh->version, pp, b);
3707     }
3708 }
3709 \f
3710 /* ofputil_port_status */
3711
3712 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3713  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3714 enum ofperr
3715 ofputil_decode_port_status(const struct ofp_header *oh,
3716                            struct ofputil_port_status *ps)
3717 {
3718     const struct ofp_port_status *ops;
3719     struct ofpbuf b;
3720     int retval;
3721
3722     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3723     ofpraw_pull_assert(&b);
3724     ops = ofpbuf_pull(&b, sizeof *ops);
3725
3726     if (ops->reason != OFPPR_ADD &&
3727         ops->reason != OFPPR_DELETE &&
3728         ops->reason != OFPPR_MODIFY) {
3729         return OFPERR_NXBRC_BAD_REASON;
3730     }
3731     ps->reason = ops->reason;
3732
3733     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3734     ovs_assert(retval != EOF);
3735     return retval;
3736 }
3737
3738 /* Converts the abstract form of a "port status" message in '*ps' into an
3739  * OpenFlow message suitable for 'protocol', and returns that encoded form in
3740  * a buffer owned by the caller. */
3741 struct ofpbuf *
3742 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3743                            enum ofputil_protocol protocol)
3744 {
3745     struct ofp_port_status *ops;
3746     struct ofpbuf *b;
3747     enum ofp_version version;
3748     enum ofpraw raw;
3749
3750     version = ofputil_protocol_to_ofp_version(protocol);
3751     switch (version) {
3752     case OFP10_VERSION:
3753         raw = OFPRAW_OFPT10_PORT_STATUS;
3754         break;
3755
3756     case OFP11_VERSION:
3757     case OFP12_VERSION:
3758     case OFP13_VERSION:
3759         raw = OFPRAW_OFPT11_PORT_STATUS;
3760         break;
3761
3762     default:
3763         NOT_REACHED();
3764     }
3765
3766     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3767     ops = ofpbuf_put_zeros(b, sizeof *ops);
3768     ops->reason = ps->reason;
3769     ofputil_put_phy_port(version, &ps->desc, b);
3770     ofpmsg_update_length(b);
3771     return b;
3772 }
3773 \f
3774 /* ofputil_port_mod */
3775
3776 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3777  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3778 enum ofperr
3779 ofputil_decode_port_mod(const struct ofp_header *oh,
3780                         struct ofputil_port_mod *pm)
3781 {
3782     enum ofpraw raw;
3783     struct ofpbuf b;
3784
3785     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3786     raw = ofpraw_pull_assert(&b);
3787
3788     if (raw == OFPRAW_OFPT10_PORT_MOD) {
3789         const struct ofp10_port_mod *opm = b.data;
3790
3791         pm->port_no = u16_to_ofp(ntohs(opm->port_no));
3792         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3793         pm->config = ntohl(opm->config) & OFPPC10_ALL;
3794         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3795         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3796     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3797         const struct ofp11_port_mod *opm = b.data;
3798         enum ofperr error;
3799
3800         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3801         if (error) {
3802             return error;
3803         }
3804
3805         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3806         pm->config = ntohl(opm->config) & OFPPC11_ALL;
3807         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3808         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3809     } else {
3810         return OFPERR_OFPBRC_BAD_TYPE;
3811     }
3812
3813     pm->config &= pm->mask;
3814     return 0;
3815 }
3816
3817 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3818  * message suitable for 'protocol', and returns that encoded form in a buffer
3819  * owned by the caller. */
3820 struct ofpbuf *
3821 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3822                         enum ofputil_protocol protocol)
3823 {
3824     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3825     struct ofpbuf *b;
3826
3827     switch (ofp_version) {
3828     case OFP10_VERSION: {
3829         struct ofp10_port_mod *opm;
3830
3831         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3832         opm = ofpbuf_put_zeros(b, sizeof *opm);
3833         opm->port_no = htons(ofp_to_u16(pm->port_no));
3834         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3835         opm->config = htonl(pm->config & OFPPC10_ALL);
3836         opm->mask = htonl(pm->mask & OFPPC10_ALL);
3837         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3838         break;
3839     }
3840
3841     case OFP11_VERSION:
3842     case OFP12_VERSION:
3843     case OFP13_VERSION: {
3844         struct ofp11_port_mod *opm;
3845
3846         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3847         opm = ofpbuf_put_zeros(b, sizeof *opm);
3848         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3849         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3850         opm->config = htonl(pm->config & OFPPC11_ALL);
3851         opm->mask = htonl(pm->mask & OFPPC11_ALL);
3852         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3853         break;
3854     }
3855
3856     default:
3857         NOT_REACHED();
3858     }
3859
3860     return b;
3861 }
3862 \f
3863 /* ofputil_role_request */
3864
3865 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
3866  * an abstract form in '*rr'.  Returns 0 if successful, otherwise an
3867  * OFPERR_* value. */
3868 enum ofperr
3869 ofputil_decode_role_message(const struct ofp_header *oh,
3870                             struct ofputil_role_request *rr)
3871 {
3872     struct ofpbuf b;
3873     enum ofpraw raw;
3874
3875     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3876     raw = ofpraw_pull_assert(&b);
3877
3878     if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
3879         raw == OFPRAW_OFPT12_ROLE_REPLY) {
3880         const struct ofp12_role_request *orr = b.l3;
3881
3882         if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
3883             orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
3884             orr->role != htonl(OFPCR12_ROLE_MASTER) &&
3885             orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
3886             return OFPERR_OFPRRFC_BAD_ROLE;
3887         }
3888
3889         rr->role = ntohl(orr->role);
3890         if (raw == OFPRAW_OFPT12_ROLE_REQUEST
3891             ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
3892             : orr->generation_id == htonll(UINT64_MAX)) {
3893             rr->have_generation_id = false;
3894             rr->generation_id = 0;
3895         } else {
3896             rr->have_generation_id = true;
3897             rr->generation_id = ntohll(orr->generation_id);
3898         }
3899     } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
3900                raw == OFPRAW_NXT_ROLE_REPLY) {
3901         const struct nx_role_request *nrr = b.l3;
3902
3903         BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
3904         BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
3905         BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
3906
3907         if (nrr->role != htonl(NX_ROLE_OTHER) &&
3908             nrr->role != htonl(NX_ROLE_MASTER) &&
3909             nrr->role != htonl(NX_ROLE_SLAVE)) {
3910             return OFPERR_OFPRRFC_BAD_ROLE;
3911         }
3912
3913         rr->role = ntohl(nrr->role) + 1;
3914         rr->have_generation_id = false;
3915         rr->generation_id = 0;
3916     } else {
3917         NOT_REACHED();
3918     }
3919
3920     return 0;
3921 }
3922
3923 /* Returns an encoded form of a role reply suitable for the "request" in a
3924  * buffer owned by the caller. */
3925 struct ofpbuf *
3926 ofputil_encode_role_reply(const struct ofp_header *request,
3927                           const struct ofputil_role_request *rr)
3928 {
3929     struct ofpbuf *buf;
3930     enum ofpraw raw;
3931
3932     raw = ofpraw_decode_assert(request);
3933     if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
3934         struct ofp12_role_request *orr;
3935
3936         buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
3937         orr = ofpbuf_put_zeros(buf, sizeof *orr);
3938
3939         orr->role = htonl(rr->role);
3940         orr->generation_id = htonll(rr->have_generation_id
3941                                     ? rr->generation_id
3942                                     : UINT64_MAX);
3943     } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
3944         struct nx_role_request *nrr;
3945
3946         BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
3947         BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
3948         BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
3949
3950         buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
3951         nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
3952         nrr->role = htonl(rr->role - 1);
3953     } else {
3954         NOT_REACHED();
3955     }
3956
3957     return buf;
3958 }
3959 \f
3960 /* Table stats. */
3961
3962 static void
3963 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3964                               struct ofpbuf *buf)
3965 {
3966     struct wc_map {
3967         enum ofp10_flow_wildcards wc10;
3968         enum oxm12_ofb_match_fields mf12;
3969     };
3970
3971     static const struct wc_map wc_map[] = {
3972         { OFPFW10_IN_PORT,     OFPXMT12_OFB_IN_PORT },
3973         { OFPFW10_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
3974         { OFPFW10_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
3975         { OFPFW10_DL_DST,      OFPXMT12_OFB_ETH_DST},
3976         { OFPFW10_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
3977         { OFPFW10_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
3978         { OFPFW10_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
3979         { OFPFW10_TP_DST,      OFPXMT12_OFB_TCP_DST },
3980         { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3981         { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3982         { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3983         { OFPFW10_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
3984     };
3985
3986     struct ofp10_table_stats *out;
3987     const struct wc_map *p;
3988
3989     out = ofpbuf_put_zeros(buf, sizeof *out);
3990     out->table_id = in->table_id;
3991     ovs_strlcpy(out->name, in->name, sizeof out->name);
3992     out->wildcards = 0;
3993     for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3994         if (in->wildcards & htonll(1ULL << p->mf12)) {
3995             out->wildcards |= htonl(p->wc10);
3996         }
3997     }
3998     out->max_entries = in->max_entries;
3999     out->active_count = in->active_count;
4000     put_32aligned_be64(&out->lookup_count, in->lookup_count);
4001     put_32aligned_be64(&out->matched_count, in->matched_count);
4002 }
4003
4004 static ovs_be32
4005 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
4006 {
4007     struct map {
4008         enum ofp11_flow_match_fields fmf11;
4009         enum oxm12_ofb_match_fields mf12;
4010     };
4011
4012     static const struct map map[] = {
4013         { OFPFMF11_IN_PORT,     OFPXMT12_OFB_IN_PORT },
4014         { OFPFMF11_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
4015         { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4016         { OFPFMF11_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
4017         { OFPFMF11_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
4018         { OFPFMF11_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
4019         { OFPFMF11_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
4020         { OFPFMF11_TP_DST,      OFPXMT12_OFB_TCP_DST },
4021         { OFPFMF11_MPLS_LABEL,  OFPXMT12_OFB_MPLS_LABEL },
4022         { OFPFMF11_MPLS_TC,     OFPXMT12_OFB_MPLS_TC },
4023         /* I don't know what OFPFMF11_TYPE means. */
4024         { OFPFMF11_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
4025         { OFPFMF11_DL_DST,      OFPXMT12_OFB_ETH_DST },
4026         { OFPFMF11_NW_SRC,      OFPXMT12_OFB_IPV4_SRC },
4027         { OFPFMF11_NW_DST,      OFPXMT12_OFB_IPV4_DST },
4028         { OFPFMF11_METADATA,    OFPXMT12_OFB_METADATA },
4029     };
4030
4031     const struct map *p;
4032     uint32_t fmf11;
4033
4034     fmf11 = 0;
4035     for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
4036         if (oxm12 & htonll(1ULL << p->mf12)) {
4037             fmf11 |= p->fmf11;
4038         }
4039     }
4040     return htonl(fmf11);
4041 }
4042
4043 static void
4044 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
4045                               struct ofpbuf *buf)
4046 {
4047     struct ofp11_table_stats *out;
4048
4049     out = ofpbuf_put_zeros(buf, sizeof *out);
4050     out->table_id = in->table_id;
4051     ovs_strlcpy(out->name, in->name, sizeof out->name);
4052     out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
4053     out->match = oxm12_to_ofp11_flow_match_fields(in->match);
4054     out->instructions = in->instructions;
4055     out->write_actions = in->write_actions;
4056     out->apply_actions = in->apply_actions;
4057     out->config = in->config;
4058     out->max_entries = in->max_entries;
4059     out->active_count = in->active_count;
4060     out->lookup_count = in->lookup_count;
4061     out->matched_count = in->matched_count;
4062 }
4063
4064 static void
4065 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
4066                               struct ofpbuf *buf)
4067 {
4068     struct ofp13_table_stats *out;
4069
4070     /* OF 1.3 splits table features off the ofp_table_stats,
4071      * so there is not much here. */
4072
4073     out = ofpbuf_put_uninit(buf, sizeof *out);
4074     out->table_id = in->table_id;
4075     out->active_count = in->active_count;
4076     out->lookup_count = in->lookup_count;
4077     out->matched_count = in->matched_count;
4078 }
4079
4080 struct ofpbuf *
4081 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
4082                                  const struct ofp_header *request)
4083 {
4084     struct ofpbuf *reply;
4085     int i;
4086
4087     reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
4088
4089     switch ((enum ofp_version) request->version) {
4090     case OFP10_VERSION:
4091         for (i = 0; i < n; i++) {
4092             ofputil_put_ofp10_table_stats(&stats[i], reply);
4093         }
4094         break;
4095
4096     case OFP11_VERSION:
4097         for (i = 0; i < n; i++) {
4098             ofputil_put_ofp11_table_stats(&stats[i], reply);
4099         }
4100         break;
4101
4102     case OFP12_VERSION:
4103         ofpbuf_put(reply, stats, n * sizeof *stats);
4104         break;
4105
4106     case OFP13_VERSION:
4107         for (i = 0; i < n; i++) {
4108             ofputil_put_ofp13_table_stats(&stats[i], reply);
4109         }
4110         break;
4111
4112     default:
4113         NOT_REACHED();
4114     }
4115
4116     return reply;
4117 }
4118 \f
4119 /* ofputil_flow_monitor_request */
4120
4121 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4122  * ofputil_flow_monitor_request in 'rq'.
4123  *
4124  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4125  * message.  Calling this function multiple times for a single 'msg' iterates
4126  * through the requests.  The caller must initially leave 'msg''s layer
4127  * pointers null and not modify them between calls.
4128  *
4129  * Returns 0 if successful, EOF if no requests were left in this 'msg',
4130  * otherwise an OFPERR_* value. */
4131 int
4132 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4133                                     struct ofpbuf *msg)
4134 {
4135     struct nx_flow_monitor_request *nfmr;
4136     uint16_t flags;
4137
4138     if (!msg->l2) {
4139         msg->l2 = msg->data;
4140         ofpraw_pull_assert(msg);
4141     }
4142
4143     if (!msg->size) {
4144         return EOF;
4145     }
4146
4147     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4148     if (!nfmr) {
4149         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
4150                      "leftover bytes at end", msg->size);
4151         return OFPERR_OFPBRC_BAD_LEN;
4152     }
4153
4154     flags = ntohs(nfmr->flags);
4155     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4156         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4157                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4158         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4159                      flags);
4160         return OFPERR_NXBRC_FM_BAD_FLAGS;
4161     }
4162
4163     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4164         return OFPERR_NXBRC_MUST_BE_ZERO;
4165     }
4166
4167     rq->id = ntohl(nfmr->id);
4168     rq->flags = flags;
4169     rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4170     rq->table_id = nfmr->table_id;
4171
4172     return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4173 }
4174
4175 void
4176 ofputil_append_flow_monitor_request(
4177     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4178 {
4179     struct nx_flow_monitor_request *nfmr;
4180     size_t start_ofs;
4181     int match_len;
4182
4183     if (!msg->size) {
4184         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4185     }
4186
4187     start_ofs = msg->size;
4188     ofpbuf_put_zeros(msg, sizeof *nfmr);
4189     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4190
4191     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4192     nfmr->id = htonl(rq->id);
4193     nfmr->flags = htons(rq->flags);
4194     nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4195     nfmr->match_len = htons(match_len);
4196     nfmr->table_id = rq->table_id;
4197 }
4198
4199 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4200  * into an abstract ofputil_flow_update in 'update'.  The caller must have
4201  * initialized update->match to point to space allocated for a match.
4202  *
4203  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4204  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
4205  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
4206  * will point into the 'ofpacts' buffer.
4207  *
4208  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
4209  * this function multiple times for a single 'msg' iterates through the
4210  * updates.  The caller must initially leave 'msg''s layer pointers null and
4211  * not modify them between calls.
4212  *
4213  * Returns 0 if successful, EOF if no updates were left in this 'msg',
4214  * otherwise an OFPERR_* value. */
4215 int
4216 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4217                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
4218 {
4219     struct nx_flow_update_header *nfuh;
4220     unsigned int length;
4221
4222     if (!msg->l2) {
4223         msg->l2 = msg->data;
4224         ofpraw_pull_assert(msg);
4225     }
4226
4227     if (!msg->size) {
4228         return EOF;
4229     }
4230
4231     if (msg->size < sizeof(struct nx_flow_update_header)) {
4232         goto bad_len;
4233     }
4234
4235     nfuh = msg->data;
4236     update->event = ntohs(nfuh->event);
4237     length = ntohs(nfuh->length);
4238     if (length > msg->size || length % 8) {
4239         goto bad_len;
4240     }
4241
4242     if (update->event == NXFME_ABBREV) {
4243         struct nx_flow_update_abbrev *nfua;
4244
4245         if (length != sizeof *nfua) {
4246             goto bad_len;
4247         }
4248
4249         nfua = ofpbuf_pull(msg, sizeof *nfua);
4250         update->xid = nfua->xid;
4251         return 0;
4252     } else if (update->event == NXFME_ADDED
4253                || update->event == NXFME_DELETED
4254                || update->event == NXFME_MODIFIED) {
4255         struct nx_flow_update_full *nfuf;
4256         unsigned int actions_len;
4257         unsigned int match_len;
4258         enum ofperr error;
4259
4260         if (length < sizeof *nfuf) {
4261             goto bad_len;
4262         }
4263
4264         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4265         match_len = ntohs(nfuf->match_len);
4266         if (sizeof *nfuf + match_len > length) {
4267             goto bad_len;
4268         }
4269
4270         update->reason = ntohs(nfuf->reason);
4271         update->idle_timeout = ntohs(nfuf->idle_timeout);
4272         update->hard_timeout = ntohs(nfuf->hard_timeout);
4273         update->table_id = nfuf->table_id;
4274         update->cookie = nfuf->cookie;
4275         update->priority = ntohs(nfuf->priority);
4276
4277         error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4278         if (error) {
4279             return error;
4280         }
4281
4282         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4283         error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
4284         if (error) {
4285             return error;
4286         }
4287
4288         update->ofpacts = ofpacts->data;
4289         update->ofpacts_len = ofpacts->size;
4290         return 0;
4291     } else {
4292         VLOG_WARN_RL(&bad_ofmsg_rl,
4293                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4294                      ntohs(nfuh->event));
4295         return OFPERR_NXBRC_FM_BAD_EVENT;
4296     }
4297
4298 bad_len:
4299     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
4300                  "leftover bytes at end", msg->size);
4301     return OFPERR_OFPBRC_BAD_LEN;
4302 }
4303
4304 uint32_t
4305 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4306 {
4307     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4308
4309     return ntohl(cancel->id);
4310 }
4311
4312 struct ofpbuf *
4313 ofputil_encode_flow_monitor_cancel(uint32_t id)
4314 {
4315     struct nx_flow_monitor_cancel *nfmc;
4316     struct ofpbuf *msg;
4317
4318     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4319     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4320     nfmc->id = htonl(id);
4321     return msg;
4322 }
4323
4324 void
4325 ofputil_start_flow_update(struct list *replies)
4326 {
4327     struct ofpbuf *msg;
4328
4329     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4330                            htonl(0), 1024);
4331
4332     list_init(replies);
4333     list_push_back(replies, &msg->list_node);
4334 }
4335
4336 void
4337 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4338                            struct list *replies)
4339 {
4340     struct nx_flow_update_header *nfuh;
4341     struct ofpbuf *msg;
4342     size_t start_ofs;
4343
4344     msg = ofpbuf_from_list(list_back(replies));
4345     start_ofs = msg->size;
4346
4347     if (update->event == NXFME_ABBREV) {
4348         struct nx_flow_update_abbrev *nfua;
4349
4350         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4351         nfua->xid = update->xid;
4352     } else {
4353         struct nx_flow_update_full *nfuf;
4354         int match_len;
4355
4356         ofpbuf_put_zeros(msg, sizeof *nfuf);
4357         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4358         ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
4359
4360         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4361         nfuf->reason = htons(update->reason);
4362         nfuf->priority = htons(update->priority);
4363         nfuf->idle_timeout = htons(update->idle_timeout);
4364         nfuf->hard_timeout = htons(update->hard_timeout);
4365         nfuf->match_len = htons(match_len);
4366         nfuf->table_id = update->table_id;
4367         nfuf->cookie = update->cookie;
4368     }
4369
4370     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4371     nfuh->length = htons(msg->size - start_ofs);
4372     nfuh->event = htons(update->event);
4373
4374     ofpmp_postappend(replies, start_ofs);
4375 }
4376 \f
4377 struct ofpbuf *
4378 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4379                           enum ofputil_protocol protocol)
4380 {
4381     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4382     struct ofpbuf *msg;
4383     size_t size;
4384
4385     size = po->ofpacts_len;
4386     if (po->buffer_id == UINT32_MAX) {
4387         size += po->packet_len;
4388     }
4389
4390     switch (ofp_version) {
4391     case OFP10_VERSION: {
4392         struct ofp10_packet_out *opo;
4393         size_t actions_ofs;
4394
4395         msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4396         ofpbuf_put_zeros(msg, sizeof *opo);
4397         actions_ofs = msg->size;
4398         ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
4399
4400         opo = msg->l3;
4401         opo->buffer_id = htonl(po->buffer_id);
4402         opo->in_port = htons(ofp_to_u16(po->in_port));
4403         opo->actions_len = htons(msg->size - actions_ofs);
4404         break;
4405     }
4406
4407     case OFP11_VERSION:
4408     case OFP12_VERSION:
4409     case OFP13_VERSION: {
4410         struct ofp11_packet_out *opo;
4411         size_t len;
4412
4413         msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4414         ofpbuf_put_zeros(msg, sizeof *opo);
4415         len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
4416
4417         opo = msg->l3;
4418         opo->buffer_id = htonl(po->buffer_id);
4419         opo->in_port = ofputil_port_to_ofp11(po->in_port);
4420         opo->actions_len = htons(len);
4421         break;
4422     }
4423
4424     default:
4425         NOT_REACHED();
4426     }
4427
4428     if (po->buffer_id == UINT32_MAX) {
4429         ofpbuf_put(msg, po->packet, po->packet_len);
4430     }
4431
4432     ofpmsg_update_length(msg);
4433
4434     return msg;
4435 }
4436 \f
4437 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4438 struct ofpbuf *
4439 make_echo_request(enum ofp_version ofp_version)
4440 {
4441     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4442                             htonl(0), 0);
4443 }
4444
4445 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4446  * OFPT_ECHO_REQUEST message in 'rq'. */
4447 struct ofpbuf *
4448 make_echo_reply(const struct ofp_header *rq)
4449 {
4450     struct ofpbuf rq_buf;
4451     struct ofpbuf *reply;
4452
4453     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4454     ofpraw_pull_assert(&rq_buf);
4455
4456     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4457     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4458     return reply;
4459 }
4460
4461 struct ofpbuf *
4462 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4463 {
4464     enum ofpraw type;
4465
4466     switch (ofp_version) {
4467     case OFP13_VERSION:
4468     case OFP12_VERSION:
4469     case OFP11_VERSION:
4470         type = OFPRAW_OFPT11_BARRIER_REQUEST;
4471         break;
4472
4473     case OFP10_VERSION:
4474         type = OFPRAW_OFPT10_BARRIER_REQUEST;
4475         break;
4476
4477     default:
4478         NOT_REACHED();
4479     }
4480
4481     return ofpraw_alloc(type, ofp_version, 0);
4482 }
4483
4484 const char *
4485 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4486 {
4487     switch (flags & OFPC_FRAG_MASK) {
4488     case OFPC_FRAG_NORMAL:   return "normal";
4489     case OFPC_FRAG_DROP:     return "drop";
4490     case OFPC_FRAG_REASM:    return "reassemble";
4491     case OFPC_FRAG_NX_MATCH: return "nx-match";
4492     }
4493
4494     NOT_REACHED();
4495 }
4496
4497 bool
4498 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4499 {
4500     if (!strcasecmp(s, "normal")) {
4501         *flags = OFPC_FRAG_NORMAL;
4502     } else if (!strcasecmp(s, "drop")) {
4503         *flags = OFPC_FRAG_DROP;
4504     } else if (!strcasecmp(s, "reassemble")) {
4505         *flags = OFPC_FRAG_REASM;
4506     } else if (!strcasecmp(s, "nx-match")) {
4507         *flags = OFPC_FRAG_NX_MATCH;
4508     } else {
4509         return false;
4510     }
4511     return true;
4512 }
4513
4514 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4515  * port number and stores the latter in '*ofp10_port', for the purpose of
4516  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
4517  * otherwise an OFPERR_* number.  On error, stores OFPP_NONE in '*ofp10_port'.
4518  *
4519  * See the definition of OFP11_MAX for an explanation of the mapping. */
4520 enum ofperr
4521 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4522 {
4523     uint32_t ofp11_port_h = ntohl(ofp11_port);
4524
4525     if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4526         *ofp10_port = u16_to_ofp(ofp11_port_h);
4527         return 0;
4528     } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4529         *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4530         return 0;
4531     } else {
4532         *ofp10_port = OFPP_NONE;
4533         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4534                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4535                      ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4536                      ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4537         return OFPERR_OFPBAC_BAD_OUT_PORT;
4538     }
4539 }
4540
4541 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4542  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4543  *
4544  * See the definition of OFP11_MAX for an explanation of the mapping. */
4545 ovs_be32
4546 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4547 {
4548     return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4549                  ? ofp_to_u16(ofp10_port)
4550                  : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4551 }
4552
4553 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
4554  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
4555  * 'port' is valid, otherwise an OpenFlow return code. */
4556 enum ofperr
4557 ofputil_check_output_port(ofp_port_t port, ofp_port_t max_ports)
4558 {
4559     switch (port) {
4560     case OFPP_IN_PORT:
4561     case OFPP_TABLE:
4562     case OFPP_NORMAL:
4563     case OFPP_FLOOD:
4564     case OFPP_ALL:
4565     case OFPP_CONTROLLER:
4566     case OFPP_NONE:
4567     case OFPP_LOCAL:
4568         return 0;
4569
4570     default:
4571         if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
4572             return 0;
4573         }
4574         return OFPERR_OFPBAC_BAD_OUT_PORT;
4575     }
4576 }
4577
4578 #define OFPUTIL_NAMED_PORTS                     \
4579         OFPUTIL_NAMED_PORT(IN_PORT)             \
4580         OFPUTIL_NAMED_PORT(TABLE)               \
4581         OFPUTIL_NAMED_PORT(NORMAL)              \
4582         OFPUTIL_NAMED_PORT(FLOOD)               \
4583         OFPUTIL_NAMED_PORT(ALL)                 \
4584         OFPUTIL_NAMED_PORT(CONTROLLER)          \
4585         OFPUTIL_NAMED_PORT(LOCAL)               \
4586         OFPUTIL_NAMED_PORT(ANY)
4587
4588 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4589 #define OFPUTIL_NAMED_PORTS_WITH_NONE           \
4590         OFPUTIL_NAMED_PORTS                     \
4591         OFPUTIL_NAMED_PORT(NONE)
4592
4593 /* Stores the port number represented by 's' into '*portp'.  's' may be an
4594  * integer or, for reserved ports, the standard OpenFlow name for the port
4595  * (e.g. "LOCAL").
4596  *
4597  * Returns true if successful, false if 's' is not a valid OpenFlow port number
4598  * or name.  The caller should issue an error message in this case, because
4599  * this function usually does not.  (This gives the caller an opportunity to
4600  * look up the port name another way, e.g. by contacting the switch and listing
4601  * the names of all its ports).
4602  *
4603  * This function accepts OpenFlow 1.0 port numbers.  It also accepts a subset
4604  * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4605  * range as described in include/openflow/openflow-1.1.h. */
4606 bool
4607 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4608 {
4609     uint32_t port32;
4610
4611     *portp = 0;
4612     if (str_to_uint(s, 10, &port32)) {
4613         if (port32 < ofp_to_u16(OFPP_MAX)) {
4614             /* Pass. */
4615         } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4616             VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4617                       "be translated to %u when talking to an OF1.1 or "
4618                       "later controller", port32, port32 + OFPP11_OFFSET);
4619         } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4620             char name[OFP_MAX_PORT_NAME_LEN];
4621
4622             ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4623             VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4624                            "for compatibility with OpenFlow 1.1 and later",
4625                            name, port32);
4626         } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4627             VLOG_WARN("port %u is outside the supported range 0 through "
4628                       "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4629                       UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4630             return false;
4631         } else {
4632             port32 -= OFPP11_OFFSET;
4633         }
4634
4635         *portp = u16_to_ofp(port32);
4636         return true;
4637     } else {
4638         struct pair {
4639             const char *name;
4640             ofp_port_t value;
4641         };
4642         static const struct pair pairs[] = {
4643 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4644             OFPUTIL_NAMED_PORTS_WITH_NONE
4645 #undef OFPUTIL_NAMED_PORT
4646         };
4647         const struct pair *p;
4648
4649         for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4650             if (!strcasecmp(s, p->name)) {
4651                 *portp = p->value;
4652                 return true;
4653             }
4654         }
4655         return false;
4656     }
4657 }
4658
4659 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4660  * Most ports' string representation is just the port number, but for special
4661  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4662 void
4663 ofputil_format_port(ofp_port_t port, struct ds *s)
4664 {
4665     char name[OFP_MAX_PORT_NAME_LEN];
4666
4667     ofputil_port_to_string(port, name, sizeof name);
4668     ds_put_cstr(s, name);
4669 }
4670
4671 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
4672  * representation of OpenFlow port number 'port'.  Most ports are represented
4673  * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
4674  * by name, e.g. "LOCAL". */
4675 void
4676 ofputil_port_to_string(ofp_port_t port,
4677                        char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
4678 {
4679     switch (port) {
4680 #define OFPUTIL_NAMED_PORT(NAME)                        \
4681         case OFPP_##NAME:                               \
4682             ovs_strlcpy(namebuf, #NAME, bufsize);       \
4683             break;
4684         OFPUTIL_NAMED_PORTS
4685 #undef OFPUTIL_NAMED_PORT
4686
4687     default:
4688         snprintf(namebuf, bufsize, "%"PRIu16, port);
4689         break;
4690     }
4691 }
4692
4693 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4694  * 'ofp_version', tries to pull the first element from the array.  If
4695  * successful, initializes '*pp' with an abstract representation of the
4696  * port and returns 0.  If no ports remain to be decoded, returns EOF.
4697  * On an error, returns a positive OFPERR_* value. */
4698 int
4699 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
4700                       struct ofputil_phy_port *pp)
4701 {
4702     switch (ofp_version) {
4703     case OFP10_VERSION: {
4704         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
4705         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
4706     }
4707     case OFP11_VERSION:
4708     case OFP12_VERSION:
4709     case OFP13_VERSION: {
4710         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
4711         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
4712     }
4713     default:
4714         NOT_REACHED();
4715     }
4716 }
4717
4718 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4719  * 'ofp_version', returns the number of elements. */
4720 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
4721 {
4722     return b->size / ofputil_get_phy_port_size(ofp_version);
4723 }
4724
4725 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
4726  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
4727  * 'name' is not the name of any action.
4728  *
4729  * ofp-util.def lists the mapping from names to action. */
4730 int
4731 ofputil_action_code_from_name(const char *name)
4732 {
4733     static const char *const names[OFPUTIL_N_ACTIONS] = {
4734         NULL,
4735 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
4736 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4737 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   NAME,
4738 #include "ofp-util.def"
4739     };
4740
4741     const char *const *p;
4742
4743     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
4744         if (*p && !strcasecmp(name, *p)) {
4745             return p - names;
4746         }
4747     }
4748     return -1;
4749 }
4750
4751 /* Appends an action of the type specified by 'code' to 'buf' and returns the
4752  * action.  Initializes the parts of 'action' that identify it as having type
4753  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
4754  * have variable length, the length used and cleared is that of struct
4755  * <STRUCT>.  */
4756 void *
4757 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
4758 {
4759     switch (code) {
4760     case OFPUTIL_ACTION_INVALID:
4761         NOT_REACHED();
4762
4763 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                  \
4764     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4765 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)      \
4766     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4767 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
4768     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4769 #include "ofp-util.def"
4770     }
4771     NOT_REACHED();
4772 }
4773
4774 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
4775     void                                                        \
4776     ofputil_init_##ENUM(struct STRUCT *s)                       \
4777     {                                                           \
4778         memset(s, 0, sizeof *s);                                \
4779         s->type = htons(ENUM);                                  \
4780         s->len = htons(sizeof *s);                              \
4781     }                                                           \
4782                                                                 \
4783     struct STRUCT *                                             \
4784     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
4785     {                                                           \
4786         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
4787         ofputil_init_##ENUM(s);                                 \
4788         return s;                                               \
4789     }
4790 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4791     OFPAT10_ACTION(ENUM, STRUCT, NAME)
4792 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
4793     void                                                        \
4794     ofputil_init_##ENUM(struct STRUCT *s)                       \
4795     {                                                           \
4796         memset(s, 0, sizeof *s);                                \
4797         s->type = htons(OFPAT10_VENDOR);                        \
4798         s->len = htons(sizeof *s);                              \
4799         s->vendor = htonl(NX_VENDOR_ID);                        \
4800         s->subtype = htons(ENUM);                               \
4801     }                                                           \
4802                                                                 \
4803     struct STRUCT *                                             \
4804     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
4805     {                                                           \
4806         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
4807         ofputil_init_##ENUM(s);                                 \
4808         return s;                                               \
4809     }
4810 #include "ofp-util.def"
4811
4812 static void
4813 ofputil_normalize_match__(struct match *match, bool may_log)
4814 {
4815     enum {
4816         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
4817         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
4818         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
4819         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
4820         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
4821         MAY_ARP_THA     = 1 << 5, /* arp_tha */
4822         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4823         MAY_ND_TARGET   = 1 << 7, /* nd_target */
4824         MAY_MPLS        = 1 << 8, /* mpls label and tc */
4825     } may_match;
4826
4827     struct flow_wildcards wc;
4828
4829     /* Figure out what fields may be matched. */
4830     if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4831         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4832         if (match->flow.nw_proto == IPPROTO_TCP ||
4833             match->flow.nw_proto == IPPROTO_UDP ||
4834             match->flow.nw_proto == IPPROTO_SCTP ||
4835             match->flow.nw_proto == IPPROTO_ICMP) {
4836             may_match |= MAY_TP_ADDR;
4837         }
4838     } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4839         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4840         if (match->flow.nw_proto == IPPROTO_TCP ||
4841             match->flow.nw_proto == IPPROTO_UDP ||
4842             match->flow.nw_proto == IPPROTO_SCTP) {
4843             may_match |= MAY_TP_ADDR;
4844         } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4845             may_match |= MAY_TP_ADDR;
4846             if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4847                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4848             } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4849                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4850             }
4851         }
4852     } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4853                match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4854         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4855     } else if (eth_type_mpls(match->flow.dl_type)) {
4856         may_match = MAY_MPLS;
4857     } else {
4858         may_match = 0;
4859     }
4860
4861     /* Clear the fields that may not be matched. */
4862     wc = match->wc;
4863     if (!(may_match & MAY_NW_ADDR)) {
4864         wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4865     }
4866     if (!(may_match & MAY_TP_ADDR)) {
4867         wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4868     }
4869     if (!(may_match & MAY_NW_PROTO)) {
4870         wc.masks.nw_proto = 0;
4871     }
4872     if (!(may_match & MAY_IPVx)) {
4873         wc.masks.nw_tos = 0;
4874         wc.masks.nw_ttl = 0;
4875     }
4876     if (!(may_match & MAY_ARP_SHA)) {
4877         memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4878     }
4879     if (!(may_match & MAY_ARP_THA)) {
4880         memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4881     }
4882     if (!(may_match & MAY_IPV6)) {
4883         wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4884         wc.masks.ipv6_label = htonl(0);
4885     }
4886     if (!(may_match & MAY_ND_TARGET)) {
4887         wc.masks.nd_target = in6addr_any;
4888     }
4889     if (!(may_match & MAY_MPLS)) {
4890         wc.masks.mpls_lse = htonl(0);
4891         wc.masks.mpls_depth = 0;
4892     }
4893
4894     /* Log any changes. */
4895     if (!flow_wildcards_equal(&wc, &match->wc)) {
4896         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4897         char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4898
4899         match->wc = wc;
4900         match_zero_wildcarded_fields(match);
4901
4902         if (log) {
4903             char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4904             VLOG_INFO("normalization changed ofp_match, details:");
4905             VLOG_INFO(" pre: %s", pre);
4906             VLOG_INFO("post: %s", post);
4907             free(pre);
4908             free(post);
4909         }
4910     }
4911 }
4912
4913 /* "Normalizes" the wildcards in 'match'.  That means:
4914  *
4915  *    1. If the type of level N is known, then only the valid fields for that
4916  *       level may be specified.  For example, ARP does not have a TOS field,
4917  *       so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4918  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4919  *       ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4920  *       IPv4 flow.
4921  *
4922  *    2. If the type of level N is not known (or not understood by Open
4923  *       vSwitch), then no fields at all for that level may be specified.  For
4924  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4925  *       L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4926  *       SCTP flow.
4927  *
4928  * If this function changes 'match', it logs a rate-limited informational
4929  * message. */
4930 void
4931 ofputil_normalize_match(struct match *match)
4932 {
4933     ofputil_normalize_match__(match, true);
4934 }
4935
4936 /* Same as ofputil_normalize_match() without the logging.  Thus, this function
4937  * is suitable for a program's internal use, whereas ofputil_normalize_match()
4938  * sense for use on flows received from elsewhere (so that a bug in the program
4939  * that sent them can be reported and corrected). */
4940 void
4941 ofputil_normalize_match_quiet(struct match *match)
4942 {
4943     ofputil_normalize_match__(match, false);
4944 }
4945
4946 /* Parses a key or a key-value pair from '*stringp'.
4947  *
4948  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
4949  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
4950  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
4951  * are substrings of '*stringp' created by replacing some of its bytes by null
4952  * terminators.  Returns true.
4953  *
4954  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4955  * NULL and returns false. */
4956 bool
4957 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4958 {
4959     char *pos, *key, *value;
4960     size_t key_len;
4961
4962     pos = *stringp;
4963     pos += strspn(pos, ", \t\r\n");
4964     if (*pos == '\0') {
4965         *keyp = *valuep = NULL;
4966         return false;
4967     }
4968
4969     key = pos;
4970     key_len = strcspn(pos, ":=(, \t\r\n");
4971     if (key[key_len] == ':' || key[key_len] == '=') {
4972         /* The value can be separated by a colon. */
4973         size_t value_len;
4974
4975         value = key + key_len + 1;
4976         value_len = strcspn(value, ", \t\r\n");
4977         pos = value + value_len + (value[value_len] != '\0');
4978         value[value_len] = '\0';
4979     } else if (key[key_len] == '(') {
4980         /* The value can be surrounded by balanced parentheses.  The outermost
4981          * set of parentheses is removed. */
4982         int level = 1;
4983         size_t value_len;
4984
4985         value = key + key_len + 1;
4986         for (value_len = 0; level > 0; value_len++) {
4987             switch (value[value_len]) {
4988             case '\0':
4989                 level = 0;
4990                 break;
4991
4992             case '(':
4993                 level++;
4994                 break;
4995
4996             case ')':
4997                 level--;
4998                 break;
4999             }
5000         }
5001         value[value_len - 1] = '\0';
5002         pos = value + value_len;
5003     } else {
5004         /* There might be no value at all. */
5005         value = key + key_len;  /* Will become the empty string below. */
5006         pos = key + key_len + (key[key_len] != '\0');
5007     }
5008     key[key_len] = '\0';
5009
5010     *stringp = pos;
5011     *keyp = key;
5012     *valuep = value;
5013     return true;
5014 }
5015
5016 /* Encode a dump ports request for 'port', the encoded message
5017  * will be for Open Flow version 'ofp_version'. Returns message
5018  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5019 struct ofpbuf *
5020 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
5021 {
5022     struct ofpbuf *request;
5023
5024     switch (ofp_version) {
5025     case OFP10_VERSION: {
5026         struct ofp10_port_stats_request *req;
5027         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
5028         req = ofpbuf_put_zeros(request, sizeof *req);
5029         req->port_no = htons(ofp_to_u16(port));
5030         break;
5031     }
5032     case OFP11_VERSION:
5033     case OFP12_VERSION:
5034     case OFP13_VERSION: {
5035         struct ofp11_port_stats_request *req;
5036         request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
5037         req = ofpbuf_put_zeros(request, sizeof *req);
5038         req->port_no = ofputil_port_to_ofp11(port);
5039         break;
5040     }
5041     default:
5042         NOT_REACHED();
5043     }
5044
5045     return request;
5046 }
5047
5048 static void
5049 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
5050                             struct ofp10_port_stats *ps10)
5051 {
5052     ps10->port_no = htons(ofp_to_u16(ops->port_no));
5053     memset(ps10->pad, 0, sizeof ps10->pad);
5054     put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
5055     put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
5056     put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
5057     put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
5058     put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
5059     put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
5060     put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
5061     put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
5062     put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
5063     put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
5064     put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
5065     put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
5066 }
5067
5068 static void
5069 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
5070                             struct ofp11_port_stats *ps11)
5071 {
5072     ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
5073     memset(ps11->pad, 0, sizeof ps11->pad);
5074     ps11->rx_packets = htonll(ops->stats.rx_packets);
5075     ps11->tx_packets = htonll(ops->stats.tx_packets);
5076     ps11->rx_bytes = htonll(ops->stats.rx_bytes);
5077     ps11->tx_bytes = htonll(ops->stats.tx_bytes);
5078     ps11->rx_dropped = htonll(ops->stats.rx_dropped);
5079     ps11->tx_dropped = htonll(ops->stats.tx_dropped);
5080     ps11->rx_errors = htonll(ops->stats.rx_errors);
5081     ps11->tx_errors = htonll(ops->stats.tx_errors);
5082     ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
5083     ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
5084     ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
5085     ps11->collisions = htonll(ops->stats.collisions);
5086 }
5087
5088 static void
5089 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
5090                             struct ofp13_port_stats *ps13)
5091 {
5092     ofputil_port_stats_to_ofp11(ops, &ps13->ps);
5093     ps13->duration_sec = htonl(ops->duration_sec);
5094     ps13->duration_nsec = htonl(ops->duration_nsec);
5095 }
5096
5097
5098 /* Encode a ports stat for 'ops' and append it to 'replies'. */
5099 void
5100 ofputil_append_port_stat(struct list *replies,
5101                          const struct ofputil_port_stats *ops)
5102 {
5103     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5104     struct ofp_header *oh = msg->data;
5105
5106     switch ((enum ofp_version)oh->version) {
5107     case OFP13_VERSION: {
5108         struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5109         ofputil_port_stats_to_ofp13(ops, reply);
5110         break;
5111     }
5112     case OFP12_VERSION:
5113     case OFP11_VERSION: {
5114         struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5115         ofputil_port_stats_to_ofp11(ops, reply);
5116         break;
5117     }
5118
5119     case OFP10_VERSION: {
5120         struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5121         ofputil_port_stats_to_ofp10(ops, reply);
5122         break;
5123     }
5124
5125     default:
5126         NOT_REACHED();
5127     }
5128 }
5129
5130 static enum ofperr
5131 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5132                               const struct ofp10_port_stats *ps10)
5133 {
5134     memset(ops, 0, sizeof *ops);
5135
5136     ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5137     ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5138     ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5139     ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5140     ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5141     ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5142     ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5143     ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5144     ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5145     ops->stats.rx_frame_errors =
5146         ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5147     ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5148     ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5149     ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5150     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5151
5152     return 0;
5153 }
5154
5155 static enum ofperr
5156 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5157                               const struct ofp11_port_stats *ps11)
5158 {
5159     enum ofperr error;
5160
5161     memset(ops, 0, sizeof *ops);
5162     error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5163     if (error) {
5164         return error;
5165     }
5166
5167     ops->stats.rx_packets = ntohll(ps11->rx_packets);
5168     ops->stats.tx_packets = ntohll(ps11->tx_packets);
5169     ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5170     ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5171     ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5172     ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5173     ops->stats.rx_errors = ntohll(ps11->rx_errors);
5174     ops->stats.tx_errors = ntohll(ps11->tx_errors);
5175     ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5176     ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5177     ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5178     ops->stats.collisions = ntohll(ps11->collisions);
5179     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5180
5181     return 0;
5182 }
5183
5184 static enum ofperr
5185 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5186                               const struct ofp13_port_stats *ps13)
5187 {
5188     enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5189     if (!error) {
5190         ops->duration_sec = ntohl(ps13->duration_sec);
5191         ops->duration_nsec = ntohl(ps13->duration_nsec);
5192     }
5193     return error;
5194 }
5195
5196 static size_t
5197 ofputil_get_port_stats_size(enum ofp_version ofp_version)
5198 {
5199     switch (ofp_version) {
5200     case OFP10_VERSION:
5201         return sizeof(struct ofp10_port_stats);
5202     case OFP11_VERSION:
5203     case OFP12_VERSION:
5204         return sizeof(struct ofp11_port_stats);
5205     case OFP13_VERSION:
5206         return sizeof(struct ofp13_port_stats);
5207     default:
5208         NOT_REACHED();
5209     }
5210 }
5211
5212 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5213  * message 'oh'. */
5214 size_t
5215 ofputil_count_port_stats(const struct ofp_header *oh)
5216 {
5217     struct ofpbuf b;
5218
5219     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5220     ofpraw_pull_assert(&b);
5221
5222     return b.size / ofputil_get_port_stats_size(oh->version);
5223 }
5224
5225 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5226  * ofputil_port_stats in 'ps'.
5227  *
5228  * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5229  * message.  Calling this function multiple times for a single 'msg' iterates
5230  * through the replies.  The caller must initially leave 'msg''s layer pointers
5231  * null and not modify them between calls.
5232  *
5233  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5234  * otherwise a positive errno value. */
5235 int
5236 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5237 {
5238     enum ofperr error;
5239     enum ofpraw raw;
5240
5241     error = (msg->l2
5242              ? ofpraw_decode(&raw, msg->l2)
5243              : ofpraw_pull(&raw, msg));
5244     if (error) {
5245         return error;
5246     }
5247
5248     if (!msg->size) {
5249         return EOF;
5250     } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5251         const struct ofp13_port_stats *ps13;
5252
5253         ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5254         if (!ps13) {
5255             goto bad_len;
5256         }
5257         return ofputil_port_stats_from_ofp13(ps, ps13);
5258     } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5259         const struct ofp11_port_stats *ps11;
5260
5261         ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5262         if (!ps11) {
5263             goto bad_len;
5264         }
5265         return ofputil_port_stats_from_ofp11(ps, ps11);
5266     } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5267         const struct ofp10_port_stats *ps10;
5268
5269         ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5270         if (!ps10) {
5271             goto bad_len;
5272         }
5273         return ofputil_port_stats_from_ofp10(ps, ps10);
5274     } else {
5275         NOT_REACHED();
5276     }
5277
5278  bad_len:
5279     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
5280                  "bytes at end", msg->size);
5281     return OFPERR_OFPBRC_BAD_LEN;
5282 }
5283
5284 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5285  * port number and stores the latter in '*ofp10_port'.
5286  * Returns 0 if successful, otherwise an OFPERR_* number. */
5287 enum ofperr
5288 ofputil_decode_port_stats_request(const struct ofp_header *request,
5289                                   ofp_port_t *ofp10_port)
5290 {
5291     switch ((enum ofp_version)request->version) {
5292     case OFP13_VERSION:
5293     case OFP12_VERSION:
5294     case OFP11_VERSION: {
5295         const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5296         return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5297     }
5298
5299     case OFP10_VERSION: {
5300         const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5301         *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5302         return 0;
5303     }
5304
5305     default:
5306         NOT_REACHED();
5307     }
5308 }
5309
5310 /* Parse a queue status request message into 'oqsr'.
5311  * Returns 0 if successful, otherwise an OFPERR_* number. */
5312 enum ofperr
5313 ofputil_decode_queue_stats_request(const struct ofp_header *request,
5314                                    struct ofputil_queue_stats_request *oqsr)
5315 {
5316     switch ((enum ofp_version)request->version) {
5317     case OFP13_VERSION:
5318     case OFP12_VERSION:
5319     case OFP11_VERSION: {
5320         const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
5321         oqsr->queue_id = ntohl(qsr11->queue_id);
5322         return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
5323     }
5324
5325     case OFP10_VERSION: {
5326         const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
5327         oqsr->queue_id = ntohl(qsr10->queue_id);
5328         oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
5329         /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
5330         if (oqsr->port_no == OFPP_ALL) {
5331             oqsr->port_no = OFPP_ANY;
5332         }
5333         return 0;
5334     }
5335
5336     default:
5337         NOT_REACHED();
5338     }
5339 }
5340
5341 /* Encode a queue statsrequest for 'oqsr', the encoded message
5342  * will be fore Open Flow version 'ofp_version'. Returns message
5343  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5344 struct ofpbuf *
5345 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
5346                                    const struct ofputil_queue_stats_request *oqsr)
5347 {
5348     struct ofpbuf *request;
5349
5350     switch (ofp_version) {
5351     case OFP11_VERSION:
5352     case OFP12_VERSION:
5353     case OFP13_VERSION: {
5354         struct ofp11_queue_stats_request *req;
5355         request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
5356         req = ofpbuf_put_zeros(request, sizeof *req);
5357         req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
5358         req->queue_id = htonl(oqsr->queue_id);
5359         break;
5360     }
5361     case OFP10_VERSION: {
5362         struct ofp10_queue_stats_request *req;
5363         request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
5364         req = ofpbuf_put_zeros(request, sizeof *req);
5365         /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
5366         req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
5367                                         ? OFPP_ALL : oqsr->port_no));
5368         req->queue_id = htonl(oqsr->queue_id);
5369         break;
5370     }
5371     default:
5372         NOT_REACHED();
5373     }
5374
5375     return request;
5376 }
5377
5378 static size_t
5379 ofputil_get_queue_stats_size(enum ofp_version ofp_version)
5380 {
5381     switch (ofp_version) {
5382     case OFP10_VERSION:
5383         return sizeof(struct ofp10_queue_stats);
5384     case OFP11_VERSION:
5385     case OFP12_VERSION:
5386         return sizeof(struct ofp11_queue_stats);
5387     case OFP13_VERSION:
5388         return sizeof(struct ofp13_queue_stats);
5389     default:
5390         NOT_REACHED();
5391     }
5392 }
5393
5394 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
5395  * message 'oh'. */
5396 size_t
5397 ofputil_count_queue_stats(const struct ofp_header *oh)
5398 {
5399     struct ofpbuf b;
5400
5401     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5402     ofpraw_pull_assert(&b);
5403
5404     return b.size / ofputil_get_queue_stats_size(oh->version);
5405 }
5406
5407 static enum ofperr
5408 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
5409                                const struct ofp10_queue_stats *qs10)
5410 {
5411     oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
5412     oqs->queue_id = ntohl(qs10->queue_id);
5413     oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
5414     oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
5415     oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
5416     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5417
5418     return 0;
5419 }
5420
5421 static enum ofperr
5422 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
5423                                const struct ofp11_queue_stats *qs11)
5424 {
5425     enum ofperr error;
5426
5427     error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
5428     if (error) {
5429         return error;
5430     }
5431
5432     oqs->queue_id = ntohl(qs11->queue_id);
5433     oqs->tx_bytes = ntohll(qs11->tx_bytes);
5434     oqs->tx_packets = ntohll(qs11->tx_packets);
5435     oqs->tx_errors = ntohll(qs11->tx_errors);
5436     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
5437
5438     return 0;
5439 }
5440
5441 static enum ofperr
5442 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
5443                                const struct ofp13_queue_stats *qs13)
5444 {
5445     enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
5446     if (!error) {
5447         oqs->duration_sec = ntohl(qs13->duration_sec);
5448         oqs->duration_nsec = ntohl(qs13->duration_nsec);
5449     }
5450
5451     return error;
5452 }
5453
5454 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
5455  * ofputil_queue_stats in 'qs'.
5456  *
5457  * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
5458  * message.  Calling this function multiple times for a single 'msg' iterates
5459  * through the replies.  The caller must initially leave 'msg''s layer pointers
5460  * null and not modify them between calls.
5461  *
5462  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5463  * otherwise a positive errno value. */
5464 int
5465 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
5466 {
5467     enum ofperr error;
5468     enum ofpraw raw;
5469
5470     error = (msg->l2
5471              ? ofpraw_decode(&raw, msg->l2)
5472              : ofpraw_pull(&raw, msg));
5473     if (error) {
5474         return error;
5475     }
5476
5477     if (!msg->size) {
5478         return EOF;
5479     } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
5480         const struct ofp13_queue_stats *qs13;
5481
5482         qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
5483         if (!qs13) {
5484             goto bad_len;
5485         }
5486         return ofputil_queue_stats_from_ofp13(qs, qs13);
5487     } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
5488         const struct ofp11_queue_stats *qs11;
5489
5490         qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
5491         if (!qs11) {
5492             goto bad_len;
5493         }
5494         return ofputil_queue_stats_from_ofp11(qs, qs11);
5495     } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
5496         const struct ofp10_queue_stats *qs10;
5497
5498         qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
5499         if (!qs10) {
5500             goto bad_len;
5501         }
5502         return ofputil_queue_stats_from_ofp10(qs, qs10);
5503     } else {
5504         NOT_REACHED();
5505     }
5506
5507  bad_len:
5508     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
5509                  "bytes at end", msg->size);
5510     return OFPERR_OFPBRC_BAD_LEN;
5511 }
5512
5513 static void
5514 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
5515                              struct ofp10_queue_stats *qs10)
5516 {
5517     qs10->port_no = htons(ofp_to_u16(oqs->port_no));
5518     memset(qs10->pad, 0, sizeof qs10->pad);
5519     qs10->queue_id = htonl(oqs->queue_id);
5520     put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
5521     put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
5522     put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
5523 }
5524
5525 static void
5526 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
5527                              struct ofp11_queue_stats *qs11)
5528 {
5529     qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
5530     qs11->queue_id = htonl(oqs->queue_id);
5531     qs11->tx_bytes = htonll(oqs->tx_bytes);
5532     qs11->tx_packets = htonll(oqs->tx_packets);
5533     qs11->tx_errors = htonll(oqs->tx_errors);
5534 }
5535
5536 static void
5537 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
5538                              struct ofp13_queue_stats *qs13)
5539 {
5540     ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
5541     if (oqs->duration_sec != UINT32_MAX) {
5542         qs13->duration_sec = htonl(oqs->duration_sec);
5543         qs13->duration_nsec = htonl(oqs->duration_nsec);
5544     } else {
5545         qs13->duration_sec = htonl(UINT32_MAX);
5546         qs13->duration_nsec = htonl(UINT32_MAX);
5547     }
5548 }
5549
5550 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
5551 void
5552 ofputil_append_queue_stat(struct list *replies,
5553                           const struct ofputil_queue_stats *oqs)
5554 {
5555     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5556     struct ofp_header *oh = msg->data;
5557
5558     switch ((enum ofp_version)oh->version) {
5559     case OFP13_VERSION: {
5560         struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5561         ofputil_queue_stats_to_ofp13(oqs, reply);
5562         break;
5563     }
5564
5565     case OFP12_VERSION:
5566     case OFP11_VERSION: {
5567         struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5568         ofputil_queue_stats_to_ofp11(oqs, reply);
5569         break;
5570     }
5571
5572     case OFP10_VERSION: {
5573         struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5574         ofputil_queue_stats_to_ofp10(oqs, reply);
5575         break;
5576     }
5577
5578     default:
5579         NOT_REACHED();
5580     }
5581 }