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 == 22);
  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 = OVS_BE16_MAX;
 110     }
 111     if (!(ofpfw & OFPFW10_TP_DST)) {
 112         wc->masks.tp_dst = OVS_BE16_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 = OVS_BE16_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 'ofmatch' into a struct match in 'match'.
 300  * Returns 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 = OVS_BE16_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 void
1104 ofputil_format_version(struct ds *msg, enum ofp_version version)
1105 {
1106     ds_put_format(msg, "0x%02x", version);
1107 }
1108
1109 void
1110 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1111 {
1112     ds_put_cstr(msg, ofputil_version_to_string(version));
1113 }
1114
1115 static void
1116 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1117                                 void (*format_version)(struct ds *msg,
1118                                                        enum ofp_version))
1119 {
1120     while (bitmap) {
1121         format_version(msg, raw_ctz(bitmap));
1122         bitmap = zero_rightmost_1bit(bitmap);
1123         if (bitmap) {
1124             ds_put_cstr(msg, ", ");
1125         }
1126     }
1127 }
1128
1129 void
1130 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1131 {
1132     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1133 }
1134
1135 void
1136 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1137 {
1138     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1139 }
1140
1141 static bool
1142 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1143                             uint32_t *allowed_versionsp)
1144 {
1145     uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1146     const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1147     uint32_t allowed_versions;
1148
1149     if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1150         return false;
1151     }
1152
1153     /* Only use the first 32-bit element of the bitmap as that is all the
1154      * current implementation supports.  Subsequent elements are ignored which
1155      * should have no effect on session negotiation until Open vSwtich supports
1156      * wire-protocol versions greater than 31.
1157      */
1158     allowed_versions = ntohl(bitmap[0]);
1159
1160     if (allowed_versions & 1) {
1161         /* There's no OpenFlow version 0. */
1162         VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1163                      "version 0x00");
1164         allowed_versions &= ~1u;
1165     }
1166
1167     if (!allowed_versions) {
1168         VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1169                      "version (between 0x01 and 0x1f)");
1170         return false;
1171     }
1172
1173     *allowed_versionsp = allowed_versions;
1174     return true;
1175 }
1176
1177 static uint32_t
1178 version_bitmap_from_version(uint8_t ofp_version)
1179 {
1180     return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1181 }
1182
1183 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1184  * the set of OpenFlow versions for which 'oh' announces support.
1185  *
1186  * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1187  * successful, and thus '*allowed_versions' is always initialized.  However, it
1188  * returns false if 'oh' contains some data that could not be fully understood,
1189  * true if 'oh' was completely parsed. */
1190 bool
1191 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1192 {
1193     struct ofpbuf msg;
1194     bool ok = true;
1195
1196     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1197     ofpbuf_pull(&msg, sizeof *oh);
1198
1199     *allowed_versions = version_bitmap_from_version(oh->version);
1200     while (msg.size) {
1201         const struct ofp_hello_elem_header *oheh;
1202         unsigned int len;
1203
1204         if (msg.size < sizeof *oheh) {
1205             return false;
1206         }
1207
1208         oheh = msg.data;
1209         len = ntohs(oheh->length);
1210         if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1211             return false;
1212         }
1213
1214         if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1215             || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1216             ok = false;
1217         }
1218     }
1219
1220     return ok;
1221 }
1222
1223 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1224  * bitmap to be correctly expressed in an OFPT_HELLO message. */
1225 static bool
1226 should_send_version_bitmap(uint32_t allowed_versions)
1227 {
1228     return !is_pow2((allowed_versions >> 1) + 1);
1229 }
1230
1231 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1232  * versions in the 'allowed_versions' bitmaps and returns the message. */
1233 struct ofpbuf *
1234 ofputil_encode_hello(uint32_t allowed_versions)
1235 {
1236     enum ofp_version ofp_version;
1237     struct ofpbuf *msg;
1238
1239     ofp_version = leftmost_1bit_idx(allowed_versions);
1240     msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1241
1242     if (should_send_version_bitmap(allowed_versions)) {
1243         struct ofp_hello_elem_header *oheh;
1244         uint16_t map_len;
1245
1246         map_len = sizeof allowed_versions;
1247         oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1248         oheh->type = htons(OFPHET_VERSIONBITMAP);
1249         oheh->length = htons(map_len + sizeof *oheh);
1250         *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1251
1252         ofpmsg_update_length(msg);
1253     }
1254
1255     return msg;
1256 }
1257
1258 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1259  * protocol is 'current', at least partly transitions the protocol to 'want'.
1260  * Stores in '*next' the protocol that will be in effect on the OpenFlow
1261  * connection if the switch processes the returned message correctly.  (If
1262  * '*next != want' then the caller will have to iterate.)
1263  *
1264  * If 'current == want', or if it is not possible to transition from 'current'
1265  * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1266  * protocol versions), returns NULL and stores 'current' in '*next'. */
1267 struct ofpbuf *
1268 ofputil_encode_set_protocol(enum ofputil_protocol current,
1269                             enum ofputil_protocol want,
1270                             enum ofputil_protocol *next)
1271 {
1272     enum ofp_version cur_version, want_version;
1273     enum ofputil_protocol cur_base, want_base;
1274     bool cur_tid, want_tid;
1275
1276     cur_version = ofputil_protocol_to_ofp_version(current);
1277     want_version = ofputil_protocol_to_ofp_version(want);
1278     if (cur_version != want_version) {
1279         *next = current;
1280         return NULL;
1281     }
1282
1283     cur_base = ofputil_protocol_to_base(current);
1284     want_base = ofputil_protocol_to_base(want);
1285     if (cur_base != want_base) {
1286         *next = ofputil_protocol_set_base(current, want_base);
1287
1288         switch (want_base) {
1289         case OFPUTIL_P_OF10_NXM:
1290             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1291
1292         case OFPUTIL_P_OF10_STD:
1293             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1294
1295         case OFPUTIL_P_OF11_STD:
1296         case OFPUTIL_P_OF12_OXM:
1297         case OFPUTIL_P_OF13_OXM:
1298             /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1299              * verified above that we're not trying to change versions. */
1300             NOT_REACHED();
1301
1302         case OFPUTIL_P_OF10_STD_TID:
1303         case OFPUTIL_P_OF10_NXM_TID:
1304             NOT_REACHED();
1305         }
1306     }
1307
1308     cur_tid = (current & OFPUTIL_P_TID) != 0;
1309     want_tid = (want & OFPUTIL_P_TID) != 0;
1310     if (cur_tid != want_tid) {
1311         *next = ofputil_protocol_set_tid(current, want_tid);
1312         return ofputil_make_flow_mod_table_id(want_tid);
1313     }
1314
1315     ovs_assert(current == want);
1316
1317     *next = current;
1318     return NULL;
1319 }
1320
1321 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1322  * format to 'nxff'.  */
1323 struct ofpbuf *
1324 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1325 {
1326     struct nx_set_flow_format *sff;
1327     struct ofpbuf *msg;
1328
1329     ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1330
1331     msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1332     sff = ofpbuf_put_zeros(msg, sizeof *sff);
1333     sff->format = htonl(nxff);
1334
1335     return msg;
1336 }
1337
1338 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1339  * otherwise. */
1340 enum ofputil_protocol
1341 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1342 {
1343     switch (flow_format) {
1344     case NXFF_OPENFLOW10:
1345         return OFPUTIL_P_OF10_STD;
1346
1347     case NXFF_NXM:
1348         return OFPUTIL_P_OF10_NXM;
1349
1350     default:
1351         return 0;
1352     }
1353 }
1354
1355 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1356 bool
1357 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1358 {
1359     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1360 }
1361
1362 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1363  * value. */
1364 const char *
1365 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1366 {
1367     switch (flow_format) {
1368     case NXFF_OPENFLOW10:
1369         return "openflow10";
1370     case NXFF_NXM:
1371         return "nxm";
1372     default:
1373         NOT_REACHED();
1374     }
1375 }
1376
1377 struct ofpbuf *
1378 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1379                                   enum nx_packet_in_format packet_in_format)
1380 {
1381     struct nx_set_packet_in_format *spif;
1382     struct ofpbuf *msg;
1383
1384     msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1385     spif = ofpbuf_put_zeros(msg, sizeof *spif);
1386     spif->format = htonl(packet_in_format);
1387
1388     return msg;
1389 }
1390
1391 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1392  * extension on or off (according to 'flow_mod_table_id'). */
1393 struct ofpbuf *
1394 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1395 {
1396     struct nx_flow_mod_table_id *nfmti;
1397     struct ofpbuf *msg;
1398
1399     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1400     nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1401     nfmti->set = flow_mod_table_id;
1402     return msg;
1403 }
1404
1405 struct ofputil_flow_mod_flag {
1406     uint16_t raw_flag;
1407     enum ofp_version min_version, max_version;
1408     enum ofputil_flow_mod_flags flag;
1409 };
1410
1411 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1412     { OFPFF_SEND_FLOW_REM,   OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1413     { OFPFF_CHECK_OVERLAP,   OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1414     { OFPFF10_EMERG,         OFP10_VERSION, OFP10_VERSION,
1415       OFPUTIL_FF_EMERG },
1416     { OFPFF12_RESET_COUNTS,  OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1417     { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1418     { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1419     { 0, 0, 0, 0 },
1420 };
1421
1422 static enum ofperr
1423 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1424                               enum ofp_flow_mod_command command,
1425                               enum ofp_version version,
1426                               enum ofputil_flow_mod_flags *flagsp)
1427 {
1428     uint16_t raw_flags = ntohs(raw_flags_);
1429     const struct ofputil_flow_mod_flag *f;
1430
1431     *flagsp = 0;
1432     for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1433         if (raw_flags & f->raw_flag
1434             && version >= f->min_version
1435             && (!f->max_version || version <= f->max_version)) {
1436             raw_flags &= ~f->raw_flag;
1437             *flagsp |= f->flag;
1438         }
1439     }
1440
1441     /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1442      * never do.
1443      *
1444      * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1445      * resets counters. */
1446     if ((version == OFP10_VERSION || version == OFP11_VERSION)
1447         && command == OFPFC_ADD) {
1448         *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1449     }
1450
1451     return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1452 }
1453
1454 static ovs_be16
1455 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1456                               enum ofp_version version)
1457 {
1458     const struct ofputil_flow_mod_flag *f;
1459     uint16_t raw_flags;
1460
1461     raw_flags = 0;
1462     for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1463         if (f->flag & flags
1464             && version >= f->min_version
1465             && (!f->max_version || version <= f->max_version)) {
1466             raw_flags |= f->raw_flag;
1467         }
1468     }
1469
1470     return htons(raw_flags);
1471 }
1472
1473 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1474  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1475  * code.
1476  *
1477  * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1478  * The caller must initialize 'ofpacts' and retains ownership of it.
1479  * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1480  *
1481  * Does not validate the flow_mod actions.  The caller should do that, with
1482  * ofpacts_check(). */
1483 enum ofperr
1484 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1485                         const struct ofp_header *oh,
1486                         enum ofputil_protocol protocol,
1487                         struct ofpbuf *ofpacts,
1488                         ofp_port_t max_port, uint8_t max_table)
1489 {
1490     ovs_be16 raw_flags;
1491     enum ofperr error;
1492     struct ofpbuf b;
1493     enum ofpraw raw;
1494
1495     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1496     raw = ofpraw_pull_assert(&b);
1497     if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1498         /* Standard OpenFlow 1.1+ flow_mod. */
1499         const struct ofp11_flow_mod *ofm;
1500
1501         ofm = ofpbuf_pull(&b, sizeof *ofm);
1502
1503         error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1504         if (error) {
1505             return error;
1506         }
1507
1508         error = ofpacts_pull_openflow_instructions(&b, b.size, oh->version,
1509                                                    ofpacts);
1510         if (error) {
1511             return error;
1512         }
1513
1514         /* Translate the message. */
1515         fm->priority = ntohs(ofm->priority);
1516         if (ofm->command == OFPFC_ADD
1517             || (oh->version == OFP11_VERSION
1518                 && (ofm->command == OFPFC_MODIFY ||
1519                     ofm->command == OFPFC_MODIFY_STRICT)
1520                 && ofm->cookie_mask == htonll(0))) {
1521             /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1522              * not match on the cookie is treated as an "add" if there is no
1523              * match. */
1524             fm->cookie = htonll(0);
1525             fm->cookie_mask = htonll(0);
1526             fm->new_cookie = ofm->cookie;
1527         } else {
1528             fm->cookie = ofm->cookie;
1529             fm->cookie_mask = ofm->cookie_mask;
1530             fm->new_cookie = OVS_BE64_MAX;
1531         }
1532         fm->modify_cookie = false;
1533         fm->command = ofm->command;
1534
1535         /* Get table ID.
1536          *
1537          * OF1.1 entirely forbids table_id == 255.
1538          * OF1.2+ allows table_id == 255 only for deletes. */
1539         fm->table_id = ofm->table_id;
1540         if (fm->table_id == 255
1541             && (oh->version == OFP11_VERSION
1542                 || (ofm->command != OFPFC_DELETE &&
1543                     ofm->command != OFPFC_DELETE_STRICT))) {
1544             return OFPERR_OFPFMFC_BAD_TABLE_ID;
1545         }
1546
1547         fm->idle_timeout = ntohs(ofm->idle_timeout);
1548         fm->hard_timeout = ntohs(ofm->hard_timeout);
1549         fm->buffer_id = ntohl(ofm->buffer_id);
1550         error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1551         if (error) {
1552             return error;
1553         }
1554         fm->out_group = ntohl(ofm->out_group);
1555
1556         if ((ofm->command == OFPFC_DELETE
1557              || ofm->command == OFPFC_DELETE_STRICT)
1558             && ofm->out_group != htonl(OFPG_ANY)) {
1559             return OFPERR_OFPFMFC_UNKNOWN;
1560         }
1561         raw_flags = ofm->flags;
1562     } else {
1563         uint16_t command;
1564
1565         if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1566             /* Standard OpenFlow 1.0 flow_mod. */
1567             const struct ofp10_flow_mod *ofm;
1568
1569             /* Get the ofp10_flow_mod. */
1570             ofm = ofpbuf_pull(&b, sizeof *ofm);
1571
1572             /* Translate the rule. */
1573             ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1574             ofputil_normalize_match(&fm->match);
1575
1576             /* Now get the actions. */
1577             error = ofpacts_pull_openflow_actions(&b, b.size, oh->version,
1578                                                   ofpacts);
1579             if (error) {
1580                 return error;
1581             }
1582
1583             /* OpenFlow 1.0 says that exact-match rules have to have the
1584              * highest possible priority. */
1585             fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1586                             ? ntohs(ofm->priority)
1587                             : UINT16_MAX);
1588
1589             /* Translate the message. */
1590             command = ntohs(ofm->command);
1591             fm->cookie = htonll(0);
1592             fm->cookie_mask = htonll(0);
1593             fm->new_cookie = ofm->cookie;
1594             fm->idle_timeout = ntohs(ofm->idle_timeout);
1595             fm->hard_timeout = ntohs(ofm->hard_timeout);
1596             fm->buffer_id = ntohl(ofm->buffer_id);
1597             fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1598             fm->out_group = OFPG11_ANY;
1599             raw_flags = ofm->flags;
1600         } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1601             /* Nicira extended flow_mod. */
1602             const struct nx_flow_mod *nfm;
1603
1604             /* Dissect the message. */
1605             nfm = ofpbuf_pull(&b, sizeof *nfm);
1606             error = nx_pull_match(&b, ntohs(nfm->match_len),
1607                                   &fm->match, &fm->cookie, &fm->cookie_mask);
1608             if (error) {
1609                 return error;
1610             }
1611             error = ofpacts_pull_openflow_actions(&b, b.size, oh->version,
1612                                                   ofpacts);
1613             if (error) {
1614                 return error;
1615             }
1616
1617             /* Translate the message. */
1618             command = ntohs(nfm->command);
1619             if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1620                 /* Flow additions may only set a new cookie, not match an
1621                  * existing cookie. */
1622                 return OFPERR_NXBRC_NXM_INVALID;
1623             }
1624             fm->priority = ntohs(nfm->priority);
1625             fm->new_cookie = nfm->cookie;
1626             fm->idle_timeout = ntohs(nfm->idle_timeout);
1627             fm->hard_timeout = ntohs(nfm->hard_timeout);
1628             fm->buffer_id = ntohl(nfm->buffer_id);
1629             fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1630             fm->out_group = OFPG11_ANY;
1631             raw_flags = nfm->flags;
1632         } else {
1633             NOT_REACHED();
1634         }
1635
1636         fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1637         if (protocol & OFPUTIL_P_TID) {
1638             fm->command = command & 0xff;
1639             fm->table_id = command >> 8;
1640         } else {
1641             fm->command = command;
1642             fm->table_id = 0xff;
1643         }
1644     }
1645
1646     fm->ofpacts = ofpacts->data;
1647     fm->ofpacts_len = ofpacts->size;
1648
1649     error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1650                                           oh->version, &fm->flags);
1651     if (error) {
1652         return error;
1653     }
1654
1655     if (fm->flags & OFPUTIL_FF_EMERG) {
1656         /* We do not support the OpenFlow 1.0 emergency flow cache, which
1657          * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1658          *
1659          * OpenFlow 1.0 specifies the error code to use when idle_timeout
1660          * or hard_timeout is nonzero.  Otherwise, there is no good error
1661          * code, so just state that the flow table is full. */
1662         return (fm->hard_timeout || fm->idle_timeout
1663                 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1664                 : OFPERR_OFPFMFC_TABLE_FULL);
1665     }
1666
1667     return ofpacts_check(fm->ofpacts, fm->ofpacts_len, &fm->match.flow,
1668                          oh->version > OFP10_VERSION, max_port,
1669                          fm->table_id, max_table);
1670 }
1671
1672 static enum ofperr
1673 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1674                    struct ofpbuf *bands)
1675 {
1676     const struct ofp13_meter_band_header *ombh;
1677     struct ofputil_meter_band *mb;
1678     uint16_t n = 0;
1679
1680     ombh = ofpbuf_try_pull(msg, len);
1681     if (!ombh) {
1682         return OFPERR_OFPBRC_BAD_LEN;
1683     }
1684
1685     while (len >= sizeof (struct ofp13_meter_band_drop)) {
1686         size_t ombh_len = ntohs(ombh->len);
1687         /* All supported band types have the same length. */
1688         if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1689             return OFPERR_OFPBRC_BAD_LEN;
1690         }
1691         mb = ofpbuf_put_uninit(bands, sizeof *mb);
1692         mb->type = ntohs(ombh->type);
1693         mb->rate = ntohl(ombh->rate);
1694         mb->burst_size = ntohl(ombh->burst_size);
1695         mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1696             ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1697         n++;
1698         len -= ombh_len;
1699         ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1700                             (char *) ombh + ombh_len);
1701     }
1702     if (len) {
1703         return OFPERR_OFPBRC_BAD_LEN;
1704     }
1705     *n_bands = n;
1706     return 0;
1707 }
1708
1709 enum ofperr
1710 ofputil_decode_meter_mod(const struct ofp_header *oh,
1711                          struct ofputil_meter_mod *mm,
1712                          struct ofpbuf *bands)
1713 {
1714     const struct ofp13_meter_mod *omm;
1715     struct ofpbuf b;
1716
1717     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1718     ofpraw_pull_assert(&b);
1719     omm = ofpbuf_pull(&b, sizeof *omm);
1720
1721     /* Translate the message. */
1722     mm->command = ntohs(omm->command);
1723     mm->meter.meter_id = ntohl(omm->meter_id);
1724
1725     if (mm->command == OFPMC13_DELETE) {
1726         mm->meter.flags = 0;
1727         mm->meter.n_bands = 0;
1728         mm->meter.bands = NULL;
1729     } else {
1730         enum ofperr error;
1731
1732         mm->meter.flags = ntohs(omm->flags);
1733         mm->meter.bands = bands->data;
1734
1735         error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1736         if (error) {
1737             return error;
1738         }
1739     }
1740     return 0;
1741 }
1742
1743 void
1744 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1745 {
1746     const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1747     *meter_id = ntohl(omr->meter_id);
1748 }
1749
1750 struct ofpbuf *
1751 ofputil_encode_meter_request(enum ofp_version ofp_version,
1752                              enum ofputil_meter_request_type type,
1753                              uint32_t meter_id)
1754 {
1755     struct ofpbuf *msg;
1756
1757     enum ofpraw raw;
1758
1759     switch (type) {
1760     case OFPUTIL_METER_CONFIG:
1761         raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1762         break;
1763     case OFPUTIL_METER_STATS:
1764         raw = OFPRAW_OFPST13_METER_REQUEST;
1765         break;
1766     default:
1767     case OFPUTIL_METER_FEATURES:
1768         raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1769         break;
1770     }
1771
1772     msg = ofpraw_alloc(raw, ofp_version, 0);
1773
1774     if (type != OFPUTIL_METER_FEATURES) {
1775         struct ofp13_meter_multipart_request *omr;
1776         omr = ofpbuf_put_zeros(msg, sizeof *omr);
1777         omr->meter_id = htonl(meter_id);
1778     }
1779     return msg;
1780 }
1781
1782 static void
1783 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1784                   struct ofpbuf *msg)
1785 {
1786     uint16_t n = 0;
1787
1788     for (n = 0; n < n_bands; ++n) {
1789         /* Currently all band types have same size. */
1790         struct ofp13_meter_band_dscp_remark *ombh;
1791         size_t ombh_len = sizeof *ombh;
1792
1793         ombh = ofpbuf_put_zeros(msg, ombh_len);
1794
1795         ombh->type = htons(mb->type);
1796         ombh->len = htons(ombh_len);
1797         ombh->rate = htonl(mb->rate);
1798         ombh->burst_size = htonl(mb->burst_size);
1799         ombh->prec_level = mb->prec_level;
1800
1801         mb++;
1802     }
1803 }
1804
1805 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1806 void
1807 ofputil_append_meter_config(struct list *replies,
1808                             const struct ofputil_meter_config *mc)
1809 {
1810     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1811     size_t start_ofs = msg->size;
1812     struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1813     reply->flags = htons(mc->flags);
1814     reply->meter_id = htonl(mc->meter_id);
1815
1816     ofputil_put_bands(mc->n_bands, mc->bands, msg);
1817
1818     reply->length = htons(msg->size - start_ofs);
1819
1820     ofpmp_postappend(replies, start_ofs);
1821 }
1822
1823 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1824 void
1825 ofputil_append_meter_stats(struct list *replies,
1826                            const struct ofputil_meter_stats *ms)
1827 {
1828     struct ofp13_meter_stats *reply;
1829     uint16_t n = 0;
1830     uint16_t len;
1831
1832     len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1833     reply = ofpmp_append(replies, len);
1834
1835     reply->meter_id = htonl(ms->meter_id);
1836     reply->len = htons(len);
1837     memset(reply->pad, 0, sizeof reply->pad);
1838     reply->flow_count = htonl(ms->flow_count);
1839     reply->packet_in_count = htonll(ms->packet_in_count);
1840     reply->byte_in_count = htonll(ms->byte_in_count);
1841     reply->duration_sec = htonl(ms->duration_sec);
1842     reply->duration_nsec = htonl(ms->duration_nsec);
1843
1844     for (n = 0; n < ms->n_bands; ++n) {
1845         const struct ofputil_meter_band_stats *src = &ms->bands[n];
1846         struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1847
1848         dst->packet_band_count = htonll(src->packet_count);
1849         dst->byte_band_count = htonll(src->byte_count);
1850     }
1851 }
1852
1853 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1854  * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1855  * 'bands'.  The caller must have initialized 'bands' and retains ownership of
1856  * it across the call.
1857  *
1858  * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1859  * message.  Calling this function multiple times for a single 'msg' iterates
1860  * through the replies.  'bands' is cleared for each reply.
1861  *
1862  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1863  * otherwise a positive errno value. */
1864 int
1865 ofputil_decode_meter_config(struct ofpbuf *msg,
1866                             struct ofputil_meter_config *mc,
1867                             struct ofpbuf *bands)
1868 {
1869     const struct ofp13_meter_config *omc;
1870     enum ofperr err;
1871
1872     /* Pull OpenFlow headers for the first call. */
1873     if (!msg->l2) {
1874         ofpraw_pull_assert(msg);
1875     }
1876
1877     if (!msg->size) {
1878         return EOF;
1879     }
1880
1881     omc = ofpbuf_try_pull(msg, sizeof *omc);
1882     if (!omc) {
1883         VLOG_WARN_RL(&bad_ofmsg_rl,
1884                      "OFPMP_METER_CONFIG reply has %zu leftover bytes at end",
1885                      msg->size);
1886         return OFPERR_OFPBRC_BAD_LEN;
1887     }
1888
1889     ofpbuf_clear(bands);
1890     err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
1891                              &mc->n_bands, bands);
1892     if (err) {
1893         return err;
1894     }
1895     mc->meter_id = ntohl(omc->meter_id);
1896     mc->flags = ntohs(omc->flags);
1897     mc->bands = bands->data;
1898
1899     return 0;
1900 }
1901
1902 static enum ofperr
1903 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1904                         struct ofpbuf *bands)
1905 {
1906     const struct ofp13_meter_band_stats *ombs;
1907     struct ofputil_meter_band_stats *mbs;
1908     uint16_t n, i;
1909
1910     ombs = ofpbuf_try_pull(msg, len);
1911     if (!ombs) {
1912         return OFPERR_OFPBRC_BAD_LEN;
1913     }
1914
1915     n = len / sizeof *ombs;
1916     if (len != n * sizeof *ombs) {
1917         return OFPERR_OFPBRC_BAD_LEN;
1918     }
1919
1920     mbs = ofpbuf_put_uninit(bands, len);
1921
1922     for (i = 0; i < n; ++i) {
1923         mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1924         mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1925     }
1926     *n_bands = n;
1927     return 0;
1928 }
1929
1930 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1931  * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1932  * decoded into 'bands'.
1933  *
1934  * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1935  * message.  Calling this function multiple times for a single 'msg' iterates
1936  * through the replies.  'bands' is cleared for each reply.
1937  *
1938  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1939  * otherwise a positive errno value. */
1940 int
1941 ofputil_decode_meter_stats(struct ofpbuf *msg,
1942                            struct ofputil_meter_stats *ms,
1943                            struct ofpbuf *bands)
1944 {
1945     const struct ofp13_meter_stats *oms;
1946     enum ofperr err;
1947
1948     /* Pull OpenFlow headers for the first call. */
1949     if (!msg->l2) {
1950         ofpraw_pull_assert(msg);
1951     }
1952
1953     if (!msg->size) {
1954         return EOF;
1955     }
1956
1957     oms = ofpbuf_try_pull(msg, sizeof *oms);
1958     if (!oms) {
1959         VLOG_WARN_RL(&bad_ofmsg_rl,
1960                      "OFPMP_METER reply has %zu leftover bytes at end",
1961                      msg->size);
1962         return OFPERR_OFPBRC_BAD_LEN;
1963     }
1964
1965     ofpbuf_clear(bands);
1966     err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
1967                                   &ms->n_bands, bands);
1968     if (err) {
1969         return err;
1970     }
1971     ms->meter_id = ntohl(oms->meter_id);
1972     ms->flow_count = ntohl(oms->flow_count);
1973     ms->packet_in_count = ntohll(oms->packet_in_count);
1974     ms->byte_in_count = ntohll(oms->byte_in_count);
1975     ms->duration_sec = ntohl(oms->duration_sec);
1976     ms->duration_nsec = ntohl(oms->duration_nsec);
1977     ms->bands = bands->data;
1978
1979     return 0;
1980 }
1981
1982 void
1983 ofputil_decode_meter_features(const struct ofp_header *oh,
1984                               struct ofputil_meter_features *mf)
1985 {
1986     const struct ofp13_meter_features *omf = ofpmsg_body(oh);
1987
1988     mf->max_meters = ntohl(omf->max_meter);
1989     mf->band_types = ntohl(omf->band_types);
1990     mf->capabilities = ntohl(omf->capabilities);
1991     mf->max_bands = omf->max_bands;
1992     mf->max_color = omf->max_color;
1993 }
1994
1995 struct ofpbuf *
1996 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
1997                                     const struct ofp_header *request)
1998 {
1999     struct ofpbuf *reply;
2000     struct ofp13_meter_features *omf;
2001
2002     reply = ofpraw_alloc_stats_reply(request, 0);
2003     omf = ofpbuf_put_zeros(reply, sizeof *omf);
2004
2005     omf->max_meter = htonl(mf->max_meters);
2006     omf->band_types = htonl(mf->band_types);
2007     omf->capabilities = htonl(mf->capabilities);
2008     omf->max_bands = mf->max_bands;
2009     omf->max_color = mf->max_color;
2010
2011     return reply;
2012 }
2013
2014 struct ofpbuf *
2015 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2016                          const struct ofputil_meter_mod *mm)
2017 {
2018     struct ofpbuf *msg;
2019
2020     struct ofp13_meter_mod *omm;
2021
2022     msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2023                        NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2024     omm = ofpbuf_put_zeros(msg, sizeof *omm);
2025     omm->command = htons(mm->command);
2026     if (mm->command != OFPMC13_DELETE) {
2027         omm->flags = htons(mm->meter.flags);
2028     }
2029     omm->meter_id = htonl(mm->meter.meter_id);
2030
2031     ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2032
2033     ofpmsg_update_length(msg);
2034     return msg;
2035 }
2036
2037 static ovs_be16
2038 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2039                     enum ofputil_protocol protocol)
2040 {
2041     return htons(protocol & OFPUTIL_P_TID
2042                  ? (fm->command & 0xff) | (fm->table_id << 8)
2043                  : fm->command);
2044 }
2045
2046 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2047  * 'protocol' and returns the message. */
2048 struct ofpbuf *
2049 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2050                         enum ofputil_protocol protocol)
2051 {
2052     enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2053     ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2054     struct ofpbuf *msg;
2055
2056     switch (protocol) {
2057     case OFPUTIL_P_OF11_STD:
2058     case OFPUTIL_P_OF12_OXM:
2059     case OFPUTIL_P_OF13_OXM: {
2060         struct ofp11_flow_mod *ofm;
2061         int tailroom;
2062
2063         tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2064         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2065         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2066         if ((protocol == OFPUTIL_P_OF11_STD
2067              && (fm->command == OFPFC_MODIFY ||
2068                  fm->command == OFPFC_MODIFY_STRICT)
2069              && fm->cookie_mask == htonll(0))
2070             || fm->command == OFPFC_ADD) {
2071             ofm->cookie = fm->new_cookie;
2072         } else {
2073             ofm->cookie = fm->cookie;
2074         }
2075         ofm->cookie_mask = fm->cookie_mask;
2076         if (fm->table_id != 255
2077             || (protocol != OFPUTIL_P_OF11_STD
2078                 && (fm->command == OFPFC_DELETE ||
2079                     fm->command == OFPFC_DELETE_STRICT))) {
2080             ofm->table_id = fm->table_id;
2081         } else {
2082             ofm->table_id = 0;
2083         }
2084         ofm->command = fm->command;
2085         ofm->idle_timeout = htons(fm->idle_timeout);
2086         ofm->hard_timeout = htons(fm->hard_timeout);
2087         ofm->priority = htons(fm->priority);
2088         ofm->buffer_id = htonl(fm->buffer_id);
2089         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2090         ofm->out_group = htonl(fm->out_group);
2091         ofm->flags = raw_flags;
2092         ofputil_put_ofp11_match(msg, &fm->match, protocol);
2093         ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2094                                           version);
2095         break;
2096     }
2097
2098     case OFPUTIL_P_OF10_STD:
2099     case OFPUTIL_P_OF10_STD_TID: {
2100         struct ofp10_flow_mod *ofm;
2101
2102         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2103                            fm->ofpacts_len);
2104         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2105         ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2106         ofm->cookie = fm->new_cookie;
2107         ofm->command = ofputil_tid_command(fm, protocol);
2108         ofm->idle_timeout = htons(fm->idle_timeout);
2109         ofm->hard_timeout = htons(fm->hard_timeout);
2110         ofm->priority = htons(fm->priority);
2111         ofm->buffer_id = htonl(fm->buffer_id);
2112         ofm->out_port = htons(ofp_to_u16(fm->out_port));
2113         ofm->flags = raw_flags;
2114         ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2115                                      version);
2116         break;
2117     }
2118
2119     case OFPUTIL_P_OF10_NXM:
2120     case OFPUTIL_P_OF10_NXM_TID: {
2121         struct nx_flow_mod *nfm;
2122         int match_len;
2123
2124         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2125                            NXM_TYPICAL_LEN + fm->ofpacts_len);
2126         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2127         nfm->command = ofputil_tid_command(fm, protocol);
2128         nfm->cookie = fm->new_cookie;
2129         match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2130         nfm = msg->l3;
2131         nfm->idle_timeout = htons(fm->idle_timeout);
2132         nfm->hard_timeout = htons(fm->hard_timeout);
2133         nfm->priority = htons(fm->priority);
2134         nfm->buffer_id = htonl(fm->buffer_id);
2135         nfm->out_port = htons(ofp_to_u16(fm->out_port));
2136         nfm->flags = raw_flags;
2137         nfm->match_len = htons(match_len);
2138         ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2139                                      version);
2140         break;
2141     }
2142
2143     default:
2144         NOT_REACHED();
2145     }
2146
2147     ofpmsg_update_length(msg);
2148     return msg;
2149 }
2150
2151 static enum ofperr
2152 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2153                                     const struct ofp10_flow_stats_request *ofsr,
2154                                     bool aggregate)
2155 {
2156     fsr->aggregate = aggregate;
2157     ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2158     fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2159     fsr->out_group = OFPG11_ANY;
2160     fsr->table_id = ofsr->table_id;
2161     fsr->cookie = fsr->cookie_mask = htonll(0);
2162
2163     return 0;
2164 }
2165
2166 static enum ofperr
2167 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2168                                     struct ofpbuf *b, bool aggregate)
2169 {
2170     const struct ofp11_flow_stats_request *ofsr;
2171     enum ofperr error;
2172
2173     ofsr = ofpbuf_pull(b, sizeof *ofsr);
2174     fsr->aggregate = aggregate;
2175     fsr->table_id = ofsr->table_id;
2176     error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2177     if (error) {
2178         return error;
2179     }
2180     fsr->out_group = ntohl(ofsr->out_group);
2181     fsr->cookie = ofsr->cookie;
2182     fsr->cookie_mask = ofsr->cookie_mask;
2183     error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2184     if (error) {
2185         return error;
2186     }
2187
2188     return 0;
2189 }
2190
2191 static enum ofperr
2192 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2193                                  struct ofpbuf *b, bool aggregate)
2194 {
2195     const struct nx_flow_stats_request *nfsr;
2196     enum ofperr error;
2197
2198     nfsr = ofpbuf_pull(b, sizeof *nfsr);
2199     error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2200                           &fsr->cookie, &fsr->cookie_mask);
2201     if (error) {
2202         return error;
2203     }
2204     if (b->size) {
2205         return OFPERR_OFPBRC_BAD_LEN;
2206     }
2207
2208     fsr->aggregate = aggregate;
2209     fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2210     fsr->out_group = OFPG11_ANY;
2211     fsr->table_id = nfsr->table_id;
2212
2213     return 0;
2214 }
2215
2216 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2217  * 'port', suitable for OpenFlow version 'version'. */
2218 struct ofpbuf *
2219 ofputil_encode_queue_get_config_request(enum ofp_version version,
2220                                         ofp_port_t port)
2221 {
2222     struct ofpbuf *request;
2223
2224     if (version == OFP10_VERSION) {
2225         struct ofp10_queue_get_config_request *qgcr10;
2226
2227         request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2228                                version, 0);
2229         qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2230         qgcr10->port = htons(ofp_to_u16(port));
2231     } else {
2232         struct ofp11_queue_get_config_request *qgcr11;
2233
2234         request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2235                                version, 0);
2236         qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2237         qgcr11->port = ofputil_port_to_ofp11(port);
2238     }
2239
2240     return request;
2241 }
2242
2243 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2244  * request into '*port'.  Returns 0 if successful, otherwise an OpenFlow error
2245  * code. */
2246 enum ofperr
2247 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2248                                         ofp_port_t *port)
2249 {
2250     const struct ofp10_queue_get_config_request *qgcr10;
2251     const struct ofp11_queue_get_config_request *qgcr11;
2252     enum ofpraw raw;
2253     struct ofpbuf b;
2254
2255     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2256     raw = ofpraw_pull_assert(&b);
2257
2258     switch ((int) raw) {
2259     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2260         qgcr10 = b.data;
2261         *port = u16_to_ofp(ntohs(qgcr10->port));
2262         return 0;
2263
2264     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2265         qgcr11 = b.data;
2266         return ofputil_port_from_ofp11(qgcr11->port, port);
2267     }
2268
2269     NOT_REACHED();
2270 }
2271
2272 /* Constructs and returns the beginning of a reply to
2273  * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'.  The caller may append information about
2274  * individual queues with ofputil_append_queue_get_config_reply(). */
2275 struct ofpbuf *
2276 ofputil_encode_queue_get_config_reply(const struct ofp_header *oh)
2277 {
2278     struct ofp10_queue_get_config_reply *qgcr10;
2279     struct ofp11_queue_get_config_reply *qgcr11;
2280     struct ofpbuf *reply;
2281     enum ofperr error;
2282     struct ofpbuf b;
2283     enum ofpraw raw;
2284     ofp_port_t port;
2285
2286     error = ofputil_decode_queue_get_config_request(oh, &port);
2287     ovs_assert(!error);
2288
2289     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2290     raw = ofpraw_pull_assert(&b);
2291
2292     switch ((int) raw) {
2293     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2294         reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2295                                    oh, 0);
2296         qgcr10 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2297         qgcr10->port = htons(ofp_to_u16(port));
2298         break;
2299
2300     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2301         reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2302                                    oh, 0);
2303         qgcr11 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2304         qgcr11->port = ofputil_port_to_ofp11(port);
2305         break;
2306
2307     default:
2308         NOT_REACHED();
2309     }
2310
2311     return reply;
2312 }
2313
2314 static void
2315 put_queue_rate(struct ofpbuf *reply, enum ofp_queue_properties property,
2316                uint16_t rate)
2317 {
2318     if (rate != UINT16_MAX) {
2319         struct ofp_queue_prop_rate *oqpr;
2320
2321         oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2322         oqpr->prop_header.property = htons(property);
2323         oqpr->prop_header.len = htons(sizeof *oqpr);
2324         oqpr->rate = htons(rate);
2325     }
2326 }
2327
2328 /* Appends a queue description for 'queue_id' to the
2329  * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2330 void
2331 ofputil_append_queue_get_config_reply(struct ofpbuf *reply,
2332                                       const struct ofputil_queue_config *oqc)
2333 {
2334     const struct ofp_header *oh = reply->data;
2335     size_t start_ofs, len_ofs;
2336     ovs_be16 *len;
2337
2338     start_ofs = reply->size;
2339     if (oh->version < OFP12_VERSION) {
2340         struct ofp10_packet_queue *opq10;
2341
2342         opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2343         opq10->queue_id = htonl(oqc->queue_id);
2344         len_ofs = (char *) &opq10->len - (char *) reply->data;
2345     } else {
2346         struct ofp11_queue_get_config_reply *qgcr11;
2347         struct ofp12_packet_queue *opq12;
2348         ovs_be32 port;
2349
2350         qgcr11 = reply->l3;
2351         port = qgcr11->port;
2352
2353         opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2354         opq12->port = port;
2355         opq12->queue_id = htonl(oqc->queue_id);
2356         len_ofs = (char *) &opq12->len - (char *) reply->data;
2357     }
2358
2359     put_queue_rate(reply, OFPQT_MIN_RATE, oqc->min_rate);
2360     put_queue_rate(reply, OFPQT_MAX_RATE, oqc->max_rate);
2361
2362     len = ofpbuf_at(reply, len_ofs, sizeof *len);
2363     *len = htons(reply->size - start_ofs);
2364 }
2365
2366 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2367  * stores in '*port' the port that the reply is about.  The caller may call
2368  * ofputil_pull_queue_get_config_reply() to obtain information about individual
2369  * queues included in the reply.  Returns 0 if successful, otherwise an
2370  * ofperr.*/
2371 enum ofperr
2372 ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, ofp_port_t *port)
2373 {
2374     const struct ofp10_queue_get_config_reply *qgcr10;
2375     const struct ofp11_queue_get_config_reply *qgcr11;
2376     enum ofpraw raw;
2377
2378     raw = ofpraw_pull_assert(reply);
2379     switch ((int) raw) {
2380     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY:
2381         qgcr10 = ofpbuf_pull(reply, sizeof *qgcr10);
2382         *port = u16_to_ofp(ntohs(qgcr10->port));
2383         return 0;
2384
2385     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY:
2386         qgcr11 = ofpbuf_pull(reply, sizeof *qgcr11);
2387         return ofputil_port_from_ofp11(qgcr11->port, port);
2388     }
2389
2390     NOT_REACHED();
2391 }
2392
2393 static enum ofperr
2394 parse_queue_rate(const struct ofp_queue_prop_header *hdr, uint16_t *rate)
2395 {
2396     const struct ofp_queue_prop_rate *oqpr;
2397
2398     if (hdr->len == htons(sizeof *oqpr)) {
2399         oqpr = (const struct ofp_queue_prop_rate *) hdr;
2400         *rate = ntohs(oqpr->rate);
2401         return 0;
2402     } else {
2403         return OFPERR_OFPBRC_BAD_LEN;
2404     }
2405 }
2406
2407 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2408  * 'reply' and stores it in '*queue'.  ofputil_decode_queue_get_config_reply()
2409  * must already have pulled off the main header.
2410  *
2411  * This function returns EOF if the last queue has already been decoded, 0 if a
2412  * queue was successfully decoded into '*queue', or an ofperr if there was a
2413  * problem decoding 'reply'. */
2414 int
2415 ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
2416                                     struct ofputil_queue_config *queue)
2417 {
2418     const struct ofp_header *oh;
2419     unsigned int opq_len;
2420     unsigned int len;
2421
2422     if (!reply->size) {
2423         return EOF;
2424     }
2425
2426     queue->min_rate = UINT16_MAX;
2427     queue->max_rate = UINT16_MAX;
2428
2429     oh = reply->l2;
2430     if (oh->version < OFP12_VERSION) {
2431         const struct ofp10_packet_queue *opq10;
2432
2433         opq10 = ofpbuf_try_pull(reply, sizeof *opq10);
2434         if (!opq10) {
2435             return OFPERR_OFPBRC_BAD_LEN;
2436         }
2437         queue->queue_id = ntohl(opq10->queue_id);
2438         len = ntohs(opq10->len);
2439         opq_len = sizeof *opq10;
2440     } else {
2441         const struct ofp12_packet_queue *opq12;
2442
2443         opq12 = ofpbuf_try_pull(reply, sizeof *opq12);
2444         if (!opq12) {
2445             return OFPERR_OFPBRC_BAD_LEN;
2446         }
2447         queue->queue_id = ntohl(opq12->queue_id);
2448         len = ntohs(opq12->len);
2449         opq_len = sizeof *opq12;
2450     }
2451
2452     if (len < opq_len || len > reply->size + opq_len || len % 8) {
2453         return OFPERR_OFPBRC_BAD_LEN;
2454     }
2455     len -= opq_len;
2456
2457     while (len > 0) {
2458         const struct ofp_queue_prop_header *hdr;
2459         unsigned int property;
2460         unsigned int prop_len;
2461         enum ofperr error = 0;
2462
2463         hdr = ofpbuf_at_assert(reply, 0, sizeof *hdr);
2464         prop_len = ntohs(hdr->len);
2465         if (prop_len < sizeof *hdr || prop_len > reply->size || prop_len % 8) {
2466             return OFPERR_OFPBRC_BAD_LEN;
2467         }
2468
2469         property = ntohs(hdr->property);
2470         switch (property) {
2471         case OFPQT_MIN_RATE:
2472             error = parse_queue_rate(hdr, &queue->min_rate);
2473             break;
2474
2475         case OFPQT_MAX_RATE:
2476             error = parse_queue_rate(hdr, &queue->max_rate);
2477             break;
2478
2479         default:
2480             VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2481             break;
2482         }
2483         if (error) {
2484             return error;
2485         }
2486
2487         ofpbuf_pull(reply, prop_len);
2488         len -= prop_len;
2489     }
2490     return 0;
2491 }
2492
2493 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2494  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
2495  * successful, otherwise an OpenFlow error code. */
2496 enum ofperr
2497 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2498                                   const struct ofp_header *oh)
2499 {
2500     enum ofpraw raw;
2501     struct ofpbuf b;
2502
2503     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2504     raw = ofpraw_pull_assert(&b);
2505     switch ((int) raw) {
2506     case OFPRAW_OFPST10_FLOW_REQUEST:
2507         return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2508
2509     case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2510         return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2511
2512     case OFPRAW_OFPST11_FLOW_REQUEST:
2513         return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2514
2515     case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2516         return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2517
2518     case OFPRAW_NXST_FLOW_REQUEST:
2519         return ofputil_decode_nxst_flow_request(fsr, &b, false);
2520
2521     case OFPRAW_NXST_AGGREGATE_REQUEST:
2522         return ofputil_decode_nxst_flow_request(fsr, &b, true);
2523
2524     default:
2525         /* Hey, the caller lied. */
2526         NOT_REACHED();
2527     }
2528 }
2529
2530 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2531  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2532  * 'protocol', and returns the message. */
2533 struct ofpbuf *
2534 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2535                                   enum ofputil_protocol protocol)
2536 {
2537     struct ofpbuf *msg;
2538     enum ofpraw raw;
2539
2540     switch (protocol) {
2541     case OFPUTIL_P_OF11_STD:
2542     case OFPUTIL_P_OF12_OXM:
2543     case OFPUTIL_P_OF13_OXM: {
2544         struct ofp11_flow_stats_request *ofsr;
2545
2546         raw = (fsr->aggregate
2547                ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2548                : OFPRAW_OFPST11_FLOW_REQUEST);
2549         msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2550                            ofputil_match_typical_len(protocol));
2551         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2552         ofsr->table_id = fsr->table_id;
2553         ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2554         ofsr->out_group = htonl(fsr->out_group);
2555         ofsr->cookie = fsr->cookie;
2556         ofsr->cookie_mask = fsr->cookie_mask;
2557         ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2558         break;
2559     }
2560
2561     case OFPUTIL_P_OF10_STD:
2562     case OFPUTIL_P_OF10_STD_TID: {
2563         struct ofp10_flow_stats_request *ofsr;
2564
2565         raw = (fsr->aggregate
2566                ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2567                : OFPRAW_OFPST10_FLOW_REQUEST);
2568         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2569         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2570         ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2571         ofsr->table_id = fsr->table_id;
2572         ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2573         break;
2574     }
2575
2576     case OFPUTIL_P_OF10_NXM:
2577     case OFPUTIL_P_OF10_NXM_TID: {
2578         struct nx_flow_stats_request *nfsr;
2579         int match_len;
2580
2581         raw = (fsr->aggregate
2582                ? OFPRAW_NXST_AGGREGATE_REQUEST
2583                : OFPRAW_NXST_FLOW_REQUEST);
2584         msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2585         ofpbuf_put_zeros(msg, sizeof *nfsr);
2586         match_len = nx_put_match(msg, &fsr->match,
2587                                  fsr->cookie, fsr->cookie_mask);
2588
2589         nfsr = msg->l3;
2590         nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2591         nfsr->match_len = htons(match_len);
2592         nfsr->table_id = fsr->table_id;
2593         break;
2594     }
2595
2596     default:
2597         NOT_REACHED();
2598     }
2599
2600     return msg;
2601 }
2602
2603 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2604  * ofputil_flow_stats in 'fs'.
2605  *
2606  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2607  * OpenFlow message.  Calling this function multiple times for a single 'msg'
2608  * iterates through the replies.  The caller must initially leave 'msg''s layer
2609  * pointers null and not modify them between calls.
2610  *
2611  * Most switches don't send the values needed to populate fs->idle_age and
2612  * fs->hard_age, so those members will usually be set to 0.  If the switch from
2613  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2614  * 'flow_age_extension' as true so that the contents of 'msg' determine the
2615  * 'idle_age' and 'hard_age' members in 'fs'.
2616  *
2617  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2618  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
2619  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
2620  *
2621  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2622  * otherwise a positive errno value. */
2623 int
2624 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2625                                 struct ofpbuf *msg,
2626                                 bool flow_age_extension,
2627                                 struct ofpbuf *ofpacts)
2628 {
2629     const struct ofp_header *oh;
2630     enum ofperr error;
2631     enum ofpraw raw;
2632
2633     error = (msg->l2
2634              ? ofpraw_decode(&raw, msg->l2)
2635              : ofpraw_pull(&raw, msg));
2636     if (error) {
2637         return error;
2638     }
2639     oh = msg->l2;
2640
2641     if (!msg->size) {
2642         return EOF;
2643     } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2644                || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2645         const struct ofp11_flow_stats *ofs;
2646         size_t length;
2647         uint16_t padded_match_len;
2648
2649         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2650         if (!ofs) {
2651             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2652                          "bytes at end", msg->size);
2653             return EINVAL;
2654         }
2655
2656         length = ntohs(ofs->length);
2657         if (length < sizeof *ofs) {
2658             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2659                          "length %zu", length);
2660             return EINVAL;
2661         }
2662
2663         if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2664             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2665             return EINVAL;
2666         }
2667
2668         if (ofpacts_pull_openflow_instructions(msg, length - sizeof *ofs -
2669                                                padded_match_len, oh->version,
2670                                                ofpacts)) {
2671             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2672             return EINVAL;
2673         }
2674
2675         fs->priority = ntohs(ofs->priority);
2676         fs->table_id = ofs->table_id;
2677         fs->duration_sec = ntohl(ofs->duration_sec);
2678         fs->duration_nsec = ntohl(ofs->duration_nsec);
2679         fs->idle_timeout = ntohs(ofs->idle_timeout);
2680         fs->hard_timeout = ntohs(ofs->hard_timeout);
2681         if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2682             error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2683                                                   &fs->flags);
2684             if (error) {
2685                 return error;
2686             }
2687         } else {
2688             fs->flags = 0;
2689         }
2690         fs->idle_age = -1;
2691         fs->hard_age = -1;
2692         fs->cookie = ofs->cookie;
2693         fs->packet_count = ntohll(ofs->packet_count);
2694         fs->byte_count = ntohll(ofs->byte_count);
2695     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2696         const struct ofp10_flow_stats *ofs;
2697         size_t length;
2698
2699         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2700         if (!ofs) {
2701             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2702                          "bytes at end", msg->size);
2703             return EINVAL;
2704         }
2705
2706         length = ntohs(ofs->length);
2707         if (length < sizeof *ofs) {
2708             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2709                          "length %zu", length);
2710             return EINVAL;
2711         }
2712
2713         if (ofpacts_pull_openflow_actions(msg, length - sizeof *ofs,
2714                                           oh->version, ofpacts)) {
2715             return EINVAL;
2716         }
2717
2718         fs->cookie = get_32aligned_be64(&ofs->cookie);
2719         ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2720         fs->priority = ntohs(ofs->priority);
2721         fs->table_id = ofs->table_id;
2722         fs->duration_sec = ntohl(ofs->duration_sec);
2723         fs->duration_nsec = ntohl(ofs->duration_nsec);
2724         fs->idle_timeout = ntohs(ofs->idle_timeout);
2725         fs->hard_timeout = ntohs(ofs->hard_timeout);
2726         fs->idle_age = -1;
2727         fs->hard_age = -1;
2728         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2729         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2730         fs->flags = 0;
2731     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2732         const struct nx_flow_stats *nfs;
2733         size_t match_len, actions_len, length;
2734
2735         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2736         if (!nfs) {
2737             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2738                          "bytes at end", msg->size);
2739             return EINVAL;
2740         }
2741
2742         length = ntohs(nfs->length);
2743         match_len = ntohs(nfs->match_len);
2744         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2745             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2746                          "claims invalid length %zu", match_len, length);
2747             return EINVAL;
2748         }
2749         if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2750             return EINVAL;
2751         }
2752
2753         actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2754         if (ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
2755                                           ofpacts)) {
2756             return EINVAL;
2757         }
2758
2759         fs->cookie = nfs->cookie;
2760         fs->table_id = nfs->table_id;
2761         fs->duration_sec = ntohl(nfs->duration_sec);
2762         fs->duration_nsec = ntohl(nfs->duration_nsec);
2763         fs->priority = ntohs(nfs->priority);
2764         fs->idle_timeout = ntohs(nfs->idle_timeout);
2765         fs->hard_timeout = ntohs(nfs->hard_timeout);
2766         fs->idle_age = -1;
2767         fs->hard_age = -1;
2768         if (flow_age_extension) {
2769             if (nfs->idle_age) {
2770                 fs->idle_age = ntohs(nfs->idle_age) - 1;
2771             }
2772             if (nfs->hard_age) {
2773                 fs->hard_age = ntohs(nfs->hard_age) - 1;
2774             }
2775         }
2776         fs->packet_count = ntohll(nfs->packet_count);
2777         fs->byte_count = ntohll(nfs->byte_count);
2778         fs->flags = 0;
2779     } else {
2780         NOT_REACHED();
2781     }
2782
2783     fs->ofpacts = ofpacts->data;
2784     fs->ofpacts_len = ofpacts->size;
2785
2786     return 0;
2787 }
2788
2789 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2790  *
2791  * We use this in situations where OVS internally uses UINT64_MAX to mean
2792  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2793 static uint64_t
2794 unknown_to_zero(uint64_t count)
2795 {
2796     return count != UINT64_MAX ? count : 0;
2797 }
2798
2799 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2800  * those already present in the list of ofpbufs in 'replies'.  'replies' should
2801  * have been initialized with ofpmp_init(). */
2802 void
2803 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2804                                 struct list *replies)
2805 {
2806     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2807     size_t start_ofs = reply->size;
2808     enum ofpraw raw;
2809     enum ofp_version version = ((struct ofp_header *)reply->data)->version;
2810
2811     ofpraw_decode_partial(&raw, reply->data, reply->size);
2812     if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2813         struct ofp11_flow_stats *ofs;
2814
2815         ofpbuf_put_uninit(reply, sizeof *ofs);
2816         oxm_put_match(reply, &fs->match);
2817         ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
2818                                           version);
2819
2820         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2821         ofs->length = htons(reply->size - start_ofs);
2822         ofs->table_id = fs->table_id;
2823         ofs->pad = 0;
2824         ofs->duration_sec = htonl(fs->duration_sec);
2825         ofs->duration_nsec = htonl(fs->duration_nsec);
2826         ofs->priority = htons(fs->priority);
2827         ofs->idle_timeout = htons(fs->idle_timeout);
2828         ofs->hard_timeout = htons(fs->hard_timeout);
2829         if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2830             ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
2831         } else {
2832             ofs->flags = 0;
2833         }
2834         memset(ofs->pad2, 0, sizeof ofs->pad2);
2835         ofs->cookie = fs->cookie;
2836         ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2837         ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2838     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2839         struct ofp10_flow_stats *ofs;
2840
2841         ofpbuf_put_uninit(reply, sizeof *ofs);
2842         ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
2843                                      version);
2844         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2845         ofs->length = htons(reply->size - start_ofs);
2846         ofs->table_id = fs->table_id;
2847         ofs->pad = 0;
2848         ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2849         ofs->duration_sec = htonl(fs->duration_sec);
2850         ofs->duration_nsec = htonl(fs->duration_nsec);
2851         ofs->priority = htons(fs->priority);
2852         ofs->idle_timeout = htons(fs->idle_timeout);
2853         ofs->hard_timeout = htons(fs->hard_timeout);
2854         memset(ofs->pad2, 0, sizeof ofs->pad2);
2855         put_32aligned_be64(&ofs->cookie, fs->cookie);
2856         put_32aligned_be64(&ofs->packet_count,
2857                            htonll(unknown_to_zero(fs->packet_count)));
2858         put_32aligned_be64(&ofs->byte_count,
2859                            htonll(unknown_to_zero(fs->byte_count)));
2860     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2861         struct nx_flow_stats *nfs;
2862         int match_len;
2863
2864         ofpbuf_put_uninit(reply, sizeof *nfs);
2865         match_len = nx_put_match(reply, &fs->match, 0, 0);
2866         ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
2867                                      version);
2868         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2869         nfs->length = htons(reply->size - start_ofs);
2870         nfs->table_id = fs->table_id;
2871         nfs->pad = 0;
2872         nfs->duration_sec = htonl(fs->duration_sec);
2873         nfs->duration_nsec = htonl(fs->duration_nsec);
2874         nfs->priority = htons(fs->priority);
2875         nfs->idle_timeout = htons(fs->idle_timeout);
2876         nfs->hard_timeout = htons(fs->hard_timeout);
2877         nfs->idle_age = htons(fs->idle_age < 0 ? 0
2878                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2879                               : UINT16_MAX);
2880         nfs->hard_age = htons(fs->hard_age < 0 ? 0
2881                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2882                               : UINT16_MAX);
2883         nfs->match_len = htons(match_len);
2884         nfs->cookie = fs->cookie;
2885         nfs->packet_count = htonll(fs->packet_count);
2886         nfs->byte_count = htonll(fs->byte_count);
2887     } else {
2888         NOT_REACHED();
2889     }
2890
2891     ofpmp_postappend(replies, start_ofs);
2892 }
2893
2894 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2895  * NXST_AGGREGATE reply matching 'request', and returns the message. */
2896 struct ofpbuf *
2897 ofputil_encode_aggregate_stats_reply(
2898     const struct ofputil_aggregate_stats *stats,
2899     const struct ofp_header *request)
2900 {
2901     struct ofp_aggregate_stats_reply *asr;
2902     uint64_t packet_count;
2903     uint64_t byte_count;
2904     struct ofpbuf *msg;
2905     enum ofpraw raw;
2906
2907     ofpraw_decode(&raw, request);
2908     if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2909         packet_count = unknown_to_zero(stats->packet_count);
2910         byte_count = unknown_to_zero(stats->byte_count);
2911     } else {
2912         packet_count = stats->packet_count;
2913         byte_count = stats->byte_count;
2914     }
2915
2916     msg = ofpraw_alloc_stats_reply(request, 0);
2917     asr = ofpbuf_put_zeros(msg, sizeof *asr);
2918     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2919     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2920     asr->flow_count = htonl(stats->flow_count);
2921
2922     return msg;
2923 }
2924
2925 enum ofperr
2926 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2927                                      const struct ofp_header *reply)
2928 {
2929     struct ofp_aggregate_stats_reply *asr;
2930     struct ofpbuf msg;
2931
2932     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2933     ofpraw_pull_assert(&msg);
2934
2935     asr = msg.l3;
2936     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2937     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2938     stats->flow_count = ntohl(asr->flow_count);
2939
2940     return 0;
2941 }
2942
2943 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2944  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
2945  * an OpenFlow error code. */
2946 enum ofperr
2947 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2948                             const struct ofp_header *oh)
2949 {
2950     enum ofpraw raw;
2951     struct ofpbuf b;
2952
2953     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2954     raw = ofpraw_pull_assert(&b);
2955     if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2956         const struct ofp12_flow_removed *ofr;
2957         enum ofperr error;
2958
2959         ofr = ofpbuf_pull(&b, sizeof *ofr);
2960
2961         error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2962         if (error) {
2963             return error;
2964         }
2965
2966         fr->priority = ntohs(ofr->priority);
2967         fr->cookie = ofr->cookie;
2968         fr->reason = ofr->reason;
2969         fr->table_id = ofr->table_id;
2970         fr->duration_sec = ntohl(ofr->duration_sec);
2971         fr->duration_nsec = ntohl(ofr->duration_nsec);
2972         fr->idle_timeout = ntohs(ofr->idle_timeout);
2973         fr->hard_timeout = ntohs(ofr->hard_timeout);
2974         fr->packet_count = ntohll(ofr->packet_count);
2975         fr->byte_count = ntohll(ofr->byte_count);
2976     } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2977         const struct ofp10_flow_removed *ofr;
2978
2979         ofr = ofpbuf_pull(&b, sizeof *ofr);
2980
2981         ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2982         fr->priority = ntohs(ofr->priority);
2983         fr->cookie = ofr->cookie;
2984         fr->reason = ofr->reason;
2985         fr->table_id = 255;
2986         fr->duration_sec = ntohl(ofr->duration_sec);
2987         fr->duration_nsec = ntohl(ofr->duration_nsec);
2988         fr->idle_timeout = ntohs(ofr->idle_timeout);
2989         fr->hard_timeout = 0;
2990         fr->packet_count = ntohll(ofr->packet_count);
2991         fr->byte_count = ntohll(ofr->byte_count);
2992     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2993         struct nx_flow_removed *nfr;
2994         enum ofperr error;
2995
2996         nfr = ofpbuf_pull(&b, sizeof *nfr);
2997         error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2998                               NULL, NULL);
2999         if (error) {
3000             return error;
3001         }
3002         if (b.size) {
3003             return OFPERR_OFPBRC_BAD_LEN;
3004         }
3005
3006         fr->priority = ntohs(nfr->priority);
3007         fr->cookie = nfr->cookie;
3008         fr->reason = nfr->reason;
3009         fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3010         fr->duration_sec = ntohl(nfr->duration_sec);
3011         fr->duration_nsec = ntohl(nfr->duration_nsec);
3012         fr->idle_timeout = ntohs(nfr->idle_timeout);
3013         fr->hard_timeout = 0;
3014         fr->packet_count = ntohll(nfr->packet_count);
3015         fr->byte_count = ntohll(nfr->byte_count);
3016     } else {
3017         NOT_REACHED();
3018     }
3019
3020     return 0;
3021 }
3022
3023 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3024  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3025  * message. */
3026 struct ofpbuf *
3027 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3028                             enum ofputil_protocol protocol)
3029 {
3030     struct ofpbuf *msg;
3031
3032     switch (protocol) {
3033     case OFPUTIL_P_OF11_STD:
3034     case OFPUTIL_P_OF12_OXM:
3035     case OFPUTIL_P_OF13_OXM: {
3036         struct ofp12_flow_removed *ofr;
3037
3038         msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3039                                ofputil_protocol_to_ofp_version(protocol),
3040                                htonl(0),
3041                                ofputil_match_typical_len(protocol));
3042         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3043         ofr->cookie = fr->cookie;
3044         ofr->priority = htons(fr->priority);
3045         ofr->reason = fr->reason;
3046         ofr->table_id = fr->table_id;
3047         ofr->duration_sec = htonl(fr->duration_sec);
3048         ofr->duration_nsec = htonl(fr->duration_nsec);
3049         ofr->idle_timeout = htons(fr->idle_timeout);
3050         ofr->hard_timeout = htons(fr->hard_timeout);
3051         ofr->packet_count = htonll(fr->packet_count);
3052         ofr->byte_count = htonll(fr->byte_count);
3053         ofputil_put_ofp11_match(msg, &fr->match, protocol);
3054         break;
3055     }
3056
3057     case OFPUTIL_P_OF10_STD:
3058     case OFPUTIL_P_OF10_STD_TID: {
3059         struct ofp10_flow_removed *ofr;
3060
3061         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3062                                htonl(0), 0);
3063         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3064         ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3065         ofr->cookie = fr->cookie;
3066         ofr->priority = htons(fr->priority);
3067         ofr->reason = fr->reason;
3068         ofr->duration_sec = htonl(fr->duration_sec);
3069         ofr->duration_nsec = htonl(fr->duration_nsec);
3070         ofr->idle_timeout = htons(fr->idle_timeout);
3071         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3072         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3073         break;
3074     }
3075
3076     case OFPUTIL_P_OF10_NXM:
3077     case OFPUTIL_P_OF10_NXM_TID: {
3078         struct nx_flow_removed *nfr;
3079         int match_len;
3080
3081         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3082                                htonl(0), NXM_TYPICAL_LEN);
3083         nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
3084         match_len = nx_put_match(msg, &fr->match, 0, 0);
3085
3086         nfr = msg->l3;
3087         nfr->cookie = fr->cookie;
3088         nfr->priority = htons(fr->priority);
3089         nfr->reason = fr->reason;
3090         nfr->table_id = fr->table_id + 1;
3091         nfr->duration_sec = htonl(fr->duration_sec);
3092         nfr->duration_nsec = htonl(fr->duration_nsec);
3093         nfr->idle_timeout = htons(fr->idle_timeout);
3094         nfr->match_len = htons(match_len);
3095         nfr->packet_count = htonll(fr->packet_count);
3096         nfr->byte_count = htonll(fr->byte_count);
3097         break;
3098     }
3099
3100     default:
3101         NOT_REACHED();
3102     }
3103
3104     return msg;
3105 }
3106
3107 static void
3108 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
3109                                 struct match *match, struct ofpbuf *b)
3110 {
3111     pin->packet = b->data;
3112     pin->packet_len = b->size;
3113
3114     pin->fmd.in_port = match->flow.in_port.ofp_port;
3115     pin->fmd.tun_id = match->flow.tunnel.tun_id;
3116     pin->fmd.tun_src = match->flow.tunnel.ip_src;
3117     pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
3118     pin->fmd.metadata = match->flow.metadata;
3119     memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
3120     pin->fmd.pkt_mark = match->flow.pkt_mark;
3121 }
3122
3123 enum ofperr
3124 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
3125                          const struct ofp_header *oh)
3126 {
3127     enum ofpraw raw;
3128     struct ofpbuf b;
3129
3130     memset(pin, 0, sizeof *pin);
3131     pin->cookie = OVS_BE64_MAX;
3132
3133     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3134     raw = ofpraw_pull_assert(&b);
3135     if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3136         const struct ofp13_packet_in *opi;
3137         struct match match;
3138         int error;
3139         size_t packet_in_size;
3140
3141         if (raw == OFPRAW_OFPT12_PACKET_IN) {
3142             packet_in_size = sizeof (struct ofp12_packet_in);
3143         } else {
3144             packet_in_size = sizeof (struct ofp13_packet_in);
3145         }
3146
3147         opi = ofpbuf_pull(&b, packet_in_size);
3148         error = oxm_pull_match_loose(&b, &match);
3149         if (error) {
3150             return error;
3151         }
3152
3153         if (!ofpbuf_try_pull(&b, 2)) {
3154             return OFPERR_OFPBRC_BAD_LEN;
3155         }
3156
3157         pin->reason = opi->pi.reason;
3158         pin->table_id = opi->pi.table_id;
3159         pin->buffer_id = ntohl(opi->pi.buffer_id);
3160         pin->total_len = ntohs(opi->pi.total_len);
3161
3162         if (raw == OFPRAW_OFPT13_PACKET_IN) {
3163             pin->cookie = opi->cookie;
3164         }
3165
3166         ofputil_decode_packet_in_finish(pin, &match, &b);
3167     } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3168         const struct ofp10_packet_in *opi;
3169
3170         opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3171
3172         pin->packet = opi->data;
3173         pin->packet_len = b.size;
3174
3175         pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
3176         pin->reason = opi->reason;
3177         pin->buffer_id = ntohl(opi->buffer_id);
3178         pin->total_len = ntohs(opi->total_len);
3179     } else if (raw == OFPRAW_NXT_PACKET_IN) {
3180         const struct nx_packet_in *npi;
3181         struct match match;
3182         int error;
3183
3184         npi = ofpbuf_pull(&b, sizeof *npi);
3185         error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
3186                                     NULL);
3187         if (error) {
3188             return error;
3189         }
3190
3191         if (!ofpbuf_try_pull(&b, 2)) {
3192             return OFPERR_OFPBRC_BAD_LEN;
3193         }
3194
3195         pin->reason = npi->reason;
3196         pin->table_id = npi->table_id;
3197         pin->cookie = npi->cookie;
3198
3199         pin->buffer_id = ntohl(npi->buffer_id);
3200         pin->total_len = ntohs(npi->total_len);
3201
3202         ofputil_decode_packet_in_finish(pin, &match, &b);
3203     } else {
3204         NOT_REACHED();
3205     }
3206
3207     return 0;
3208 }
3209
3210 static void
3211 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
3212                            struct match *match)
3213 {
3214     int i;
3215
3216     match_init_catchall(match);
3217     if (pin->fmd.tun_id != htonll(0)) {
3218         match_set_tun_id(match, pin->fmd.tun_id);
3219     }
3220     if (pin->fmd.tun_src != htonl(0)) {
3221         match_set_tun_src(match, pin->fmd.tun_src);
3222     }
3223     if (pin->fmd.tun_dst != htonl(0)) {
3224         match_set_tun_dst(match, pin->fmd.tun_dst);
3225     }
3226     if (pin->fmd.metadata != htonll(0)) {
3227         match_set_metadata(match, pin->fmd.metadata);
3228     }
3229
3230     for (i = 0; i < FLOW_N_REGS; i++) {
3231         if (pin->fmd.regs[i]) {
3232             match_set_reg(match, i, pin->fmd.regs[i]);
3233         }
3234     }
3235
3236     if (pin->fmd.pkt_mark != 0) {
3237         match_set_pkt_mark(match, pin->fmd.pkt_mark);
3238     }
3239
3240     match_set_in_port(match, pin->fmd.in_port);
3241 }
3242
3243 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3244  * in the format specified by 'packet_in_format'.  */
3245 struct ofpbuf *
3246 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3247                          enum ofputil_protocol protocol,
3248                          enum nx_packet_in_format packet_in_format)
3249 {
3250     struct ofpbuf *packet;
3251
3252     /* Add OFPT_PACKET_IN. */
3253     if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
3254         struct ofp13_packet_in *opi;
3255         struct match match;
3256         enum ofpraw packet_in_raw;
3257         enum ofp_version packet_in_version;
3258         size_t packet_in_size;
3259
3260         if (protocol == OFPUTIL_P_OF12_OXM) {
3261             packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3262             packet_in_version = OFP12_VERSION;
3263             packet_in_size = sizeof (struct ofp12_packet_in);
3264         } else {
3265             packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3266             packet_in_version = OFP13_VERSION;
3267             packet_in_size = sizeof (struct ofp13_packet_in);
3268         }
3269
3270         ofputil_packet_in_to_match(pin, &match);
3271
3272         /* The final argument is just an estimate of the space required. */
3273         packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3274                                   htonl(0), (sizeof(struct flow_metadata) * 2
3275                                              + 2 + pin->packet_len));
3276         ofpbuf_put_zeros(packet, packet_in_size);
3277         oxm_put_match(packet, &match);
3278         ofpbuf_put_zeros(packet, 2);
3279         ofpbuf_put(packet, pin->packet, pin->packet_len);
3280
3281         opi = packet->l3;
3282         opi->pi.buffer_id = htonl(pin->buffer_id);
3283         opi->pi.total_len = htons(pin->total_len);
3284         opi->pi.reason = pin->reason;
3285         opi->pi.table_id = pin->table_id;
3286         if (protocol == OFPUTIL_P_OF13_OXM) {
3287             opi->cookie = pin->cookie;
3288         }
3289     } else if (packet_in_format == NXPIF_OPENFLOW10) {
3290         struct ofp10_packet_in *opi;
3291
3292         packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3293                                   htonl(0), pin->packet_len);
3294         opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3295         opi->total_len = htons(pin->total_len);
3296         opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
3297         opi->reason = pin->reason;
3298         opi->buffer_id = htonl(pin->buffer_id);
3299
3300         ofpbuf_put(packet, pin->packet, pin->packet_len);
3301     } else if (packet_in_format == NXPIF_NXM) {
3302         struct nx_packet_in *npi;
3303         struct match match;
3304         size_t match_len;
3305
3306         ofputil_packet_in_to_match(pin, &match);
3307
3308         /* The final argument is just an estimate of the space required. */
3309         packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3310                                   htonl(0), (sizeof(struct flow_metadata) * 2
3311                                              + 2 + pin->packet_len));
3312         ofpbuf_put_zeros(packet, sizeof *npi);
3313         match_len = nx_put_match(packet, &match, 0, 0);
3314         ofpbuf_put_zeros(packet, 2);
3315         ofpbuf_put(packet, pin->packet, pin->packet_len);
3316
3317         npi = packet->l3;
3318         npi->buffer_id = htonl(pin->buffer_id);
3319         npi->total_len = htons(pin->total_len);
3320         npi->reason = pin->reason;
3321         npi->table_id = pin->table_id;
3322         npi->cookie = pin->cookie;
3323         npi->match_len = htons(match_len);
3324     } else {
3325         NOT_REACHED();
3326     }
3327     ofpmsg_update_length(packet);
3328
3329     return packet;
3330 }
3331
3332 /* Returns a string form of 'reason'.  The return value is either a statically
3333  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3334  * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3335 const char *
3336 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3337                                    char *reasonbuf, size_t bufsize)
3338 {
3339     switch (reason) {
3340     case OFPR_NO_MATCH:
3341         return "no_match";
3342     case OFPR_ACTION:
3343         return "action";
3344     case OFPR_INVALID_TTL:
3345         return "invalid_ttl";
3346
3347     case OFPR_N_REASONS:
3348     default:
3349         snprintf(reasonbuf, bufsize, "%d", (int) reason);
3350         return reasonbuf;
3351     }
3352 }
3353
3354 bool
3355 ofputil_packet_in_reason_from_string(const char *s,
3356                                      enum ofp_packet_in_reason *reason)
3357 {
3358     int i;
3359
3360     for (i = 0; i < OFPR_N_REASONS; i++) {
3361         char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3362         const char *reason_s;
3363
3364         reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3365                                                       sizeof reasonbuf);
3366         if (!strcasecmp(s, reason_s)) {
3367             *reason = i;
3368             return true;
3369         }
3370     }
3371     return false;
3372 }
3373
3374 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3375  * 'po'.
3376  *
3377  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3378  * message's actions.  The caller must initialize 'ofpacts' and retains
3379  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
3380  *
3381  * Returns 0 if successful, otherwise an OFPERR_* value. */
3382 enum ofperr
3383 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3384                           const struct ofp_header *oh,
3385                           struct ofpbuf *ofpacts)
3386 {
3387     enum ofpraw raw;
3388     struct ofpbuf b;
3389
3390     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3391     raw = ofpraw_pull_assert(&b);
3392
3393     if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3394         enum ofperr error;
3395         const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3396
3397         po->buffer_id = ntohl(opo->buffer_id);
3398         error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3399         if (error) {
3400             return error;
3401         }
3402
3403         error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3404                                               oh->version, ofpacts);
3405         if (error) {
3406             return error;
3407         }
3408     } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3409         enum ofperr error;
3410         const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3411
3412         po->buffer_id = ntohl(opo->buffer_id);
3413         po->in_port = u16_to_ofp(ntohs(opo->in_port));
3414
3415         error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3416                                               oh->version, ofpacts);
3417         if (error) {
3418             return error;
3419         }
3420     } else {
3421         NOT_REACHED();
3422     }
3423
3424     if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3425         && po->in_port != OFPP_LOCAL
3426         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3427         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3428                      po->in_port);
3429         return OFPERR_OFPBRC_BAD_PORT;
3430     }
3431
3432     po->ofpacts = ofpacts->data;
3433     po->ofpacts_len = ofpacts->size;
3434
3435     if (po->buffer_id == UINT32_MAX) {
3436         po->packet = b.data;
3437         po->packet_len = b.size;
3438     } else {
3439         po->packet = NULL;
3440         po->packet_len = 0;
3441     }
3442
3443     return 0;
3444 }
3445 \f
3446 /* ofputil_phy_port */
3447
3448 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3449 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
3450 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
3451 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
3452 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
3453 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
3454 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
3455 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
3456
3457 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3458 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3459 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3460 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3461 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3462 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3463
3464 static enum netdev_features
3465 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3466 {
3467     uint32_t ofp10 = ntohl(ofp10_);
3468     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3469 }
3470
3471 static ovs_be32
3472 netdev_port_features_to_ofp10(enum netdev_features features)
3473 {
3474     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3475 }
3476
3477 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
3478 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
3479 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
3480 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
3481 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
3482 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
3483 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
3484 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
3485 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
3486 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
3487 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
3488 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
3489 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
3490 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
3491 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
3492 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3493
3494 static enum netdev_features
3495 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3496 {
3497     return ntohl(ofp11) & 0xffff;
3498 }
3499
3500 static ovs_be32
3501 netdev_port_features_to_ofp11(enum netdev_features features)
3502 {
3503     return htonl(features & 0xffff);
3504 }
3505
3506 static enum ofperr
3507 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3508                               const struct ofp10_phy_port *opp)
3509 {
3510     memset(pp, 0, sizeof *pp);
3511
3512     pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3513     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3514     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3515
3516     pp->config = ntohl(opp->config) & OFPPC10_ALL;
3517     pp->state = ntohl(opp->state) & OFPPS10_ALL;
3518
3519     pp->curr = netdev_port_features_from_ofp10(opp->curr);
3520     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3521     pp->supported = netdev_port_features_from_ofp10(opp->supported);
3522     pp->peer = netdev_port_features_from_ofp10(opp->peer);
3523
3524     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3525     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3526
3527     return 0;
3528 }
3529
3530 static enum ofperr
3531 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3532                           const struct ofp11_port *op)
3533 {
3534     enum ofperr error;
3535
3536     memset(pp, 0, sizeof *pp);
3537
3538     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3539     if (error) {
3540         return error;
3541     }
3542     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3543     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3544
3545     pp->config = ntohl(op->config) & OFPPC11_ALL;
3546     pp->state = ntohl(op->state) & OFPPC11_ALL;
3547
3548     pp->curr = netdev_port_features_from_ofp11(op->curr);
3549     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3550     pp->supported = netdev_port_features_from_ofp11(op->supported);
3551     pp->peer = netdev_port_features_from_ofp11(op->peer);
3552
3553     pp->curr_speed = ntohl(op->curr_speed);
3554     pp->max_speed = ntohl(op->max_speed);
3555
3556     return 0;
3557 }
3558
3559 static size_t
3560 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3561 {
3562     switch (ofp_version) {
3563     case OFP10_VERSION:
3564         return sizeof(struct ofp10_phy_port);
3565     case OFP11_VERSION:
3566     case OFP12_VERSION:
3567     case OFP13_VERSION:
3568         return sizeof(struct ofp11_port);
3569     default:
3570         NOT_REACHED();
3571     }
3572 }
3573
3574 static void
3575 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3576                               struct ofp10_phy_port *opp)
3577 {
3578     memset(opp, 0, sizeof *opp);
3579
3580     opp->port_no = htons(ofp_to_u16(pp->port_no));
3581     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3582     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3583
3584     opp->config = htonl(pp->config & OFPPC10_ALL);
3585     opp->state = htonl(pp->state & OFPPS10_ALL);
3586
3587     opp->curr = netdev_port_features_to_ofp10(pp->curr);
3588     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3589     opp->supported = netdev_port_features_to_ofp10(pp->supported);
3590     opp->peer = netdev_port_features_to_ofp10(pp->peer);
3591 }
3592
3593 static void
3594 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3595                           struct ofp11_port *op)
3596 {
3597     memset(op, 0, sizeof *op);
3598
3599     op->port_no = ofputil_port_to_ofp11(pp->port_no);
3600     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3601     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3602
3603     op->config = htonl(pp->config & OFPPC11_ALL);
3604     op->state = htonl(pp->state & OFPPS11_ALL);
3605
3606     op->curr = netdev_port_features_to_ofp11(pp->curr);
3607     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3608     op->supported = netdev_port_features_to_ofp11(pp->supported);
3609     op->peer = netdev_port_features_to_ofp11(pp->peer);
3610
3611     op->curr_speed = htonl(pp->curr_speed);
3612     op->max_speed = htonl(pp->max_speed);
3613 }
3614
3615 static void
3616 ofputil_put_phy_port(enum ofp_version ofp_version,
3617                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
3618 {
3619     switch (ofp_version) {
3620     case OFP10_VERSION: {
3621         struct ofp10_phy_port *opp;
3622         if (b->size + sizeof *opp <= UINT16_MAX) {
3623             opp = ofpbuf_put_uninit(b, sizeof *opp);
3624             ofputil_encode_ofp10_phy_port(pp, opp);
3625         }
3626         break;
3627     }
3628
3629     case OFP11_VERSION:
3630     case OFP12_VERSION:
3631     case OFP13_VERSION: {
3632         struct ofp11_port *op;
3633         if (b->size + sizeof *op <= UINT16_MAX) {
3634             op = ofpbuf_put_uninit(b, sizeof *op);
3635             ofputil_encode_ofp11_port(pp, op);
3636         }
3637         break;
3638     }
3639
3640     default:
3641         NOT_REACHED();
3642     }
3643 }
3644
3645 void
3646 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3647                                      const struct ofputil_phy_port *pp,
3648                                      struct list *replies)
3649 {
3650     switch (ofp_version) {
3651     case OFP10_VERSION: {
3652         struct ofp10_phy_port *opp;
3653
3654         opp = ofpmp_append(replies, sizeof *opp);
3655         ofputil_encode_ofp10_phy_port(pp, opp);
3656         break;
3657     }
3658
3659     case OFP11_VERSION:
3660     case OFP12_VERSION:
3661     case OFP13_VERSION: {
3662         struct ofp11_port *op;
3663
3664         op = ofpmp_append(replies, sizeof *op);
3665         ofputil_encode_ofp11_port(pp, op);
3666         break;
3667     }
3668
3669     default:
3670       NOT_REACHED();
3671     }
3672 }
3673 \f
3674 /* ofputil_switch_features */
3675
3676 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3677                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
3678 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3679 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3680 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3681 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3682 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3683 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3684
3685 struct ofputil_action_bit_translation {
3686     enum ofputil_action_bitmap ofputil_bit;
3687     int of_bit;
3688 };
3689
3690 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3691     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
3692     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3693     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3694     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
3695     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
3696     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
3697     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
3698     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
3699     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
3700     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
3701     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
3702     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
3703     { 0, 0 },
3704 };
3705
3706 static enum ofputil_action_bitmap
3707 decode_action_bits(ovs_be32 of_actions,
3708                    const struct ofputil_action_bit_translation *x)
3709 {
3710     enum ofputil_action_bitmap ofputil_actions;
3711
3712     ofputil_actions = 0;
3713     for (; x->ofputil_bit; x++) {
3714         if (of_actions & htonl(1u << x->of_bit)) {
3715             ofputil_actions |= x->ofputil_bit;
3716         }
3717     }
3718     return ofputil_actions;
3719 }
3720
3721 static uint32_t
3722 ofputil_capabilities_mask(enum ofp_version ofp_version)
3723 {
3724     /* Handle capabilities whose bit is unique for all Open Flow versions */
3725     switch (ofp_version) {
3726     case OFP10_VERSION:
3727     case OFP11_VERSION:
3728         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3729     case OFP12_VERSION:
3730     case OFP13_VERSION:
3731         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3732     default:
3733         /* Caller needs to check osf->header.version itself */
3734         return 0;
3735     }
3736 }
3737
3738 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3739  * abstract representation in '*features'.  Initializes '*b' to iterate over
3740  * the OpenFlow port structures following 'osf' with later calls to
3741  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
3742  * OFPERR_* value.  */
3743 enum ofperr
3744 ofputil_decode_switch_features(const struct ofp_header *oh,
3745                                struct ofputil_switch_features *features,
3746                                struct ofpbuf *b)
3747 {
3748     const struct ofp_switch_features *osf;
3749     enum ofpraw raw;
3750
3751     ofpbuf_use_const(b, oh, ntohs(oh->length));
3752     raw = ofpraw_pull_assert(b);
3753
3754     osf = ofpbuf_pull(b, sizeof *osf);
3755     features->datapath_id = ntohll(osf->datapath_id);
3756     features->n_buffers = ntohl(osf->n_buffers);
3757     features->n_tables = osf->n_tables;
3758     features->auxiliary_id = 0;
3759
3760     features->capabilities = ntohl(osf->capabilities) &
3761         ofputil_capabilities_mask(oh->version);
3762
3763     if (b->size % ofputil_get_phy_port_size(oh->version)) {
3764         return OFPERR_OFPBRC_BAD_LEN;
3765     }
3766
3767     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3768         if (osf->capabilities & htonl(OFPC10_STP)) {
3769             features->capabilities |= OFPUTIL_C_STP;
3770         }
3771         features->actions = decode_action_bits(osf->actions, of10_action_bits);
3772     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3773                || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3774         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3775             features->capabilities |= OFPUTIL_C_GROUP_STATS;
3776         }
3777         features->actions = 0;
3778         if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3779             features->auxiliary_id = osf->auxiliary_id;
3780         }
3781     } else {
3782         return OFPERR_OFPBRC_BAD_VERSION;
3783     }
3784
3785     return 0;
3786 }
3787
3788 /* Returns true if the maximum number of ports are in 'oh'. */
3789 static bool
3790 max_ports_in_features(const struct ofp_header *oh)
3791 {
3792     size_t pp_size = ofputil_get_phy_port_size(oh->version);
3793     return ntohs(oh->length) + pp_size > UINT16_MAX;
3794 }
3795
3796 /* Given a buffer 'b' that contains a Features Reply message, checks if
3797  * it contains the maximum number of ports that will fit.  If so, it
3798  * returns true and removes the ports from the message.  The caller
3799  * should then send an OFPST_PORT_DESC stats request to get the ports,
3800  * since the switch may have more ports than could be represented in the
3801  * Features Reply.  Otherwise, returns false.
3802  */
3803 bool
3804 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3805 {
3806     struct ofp_header *oh = b->data;
3807
3808     if (max_ports_in_features(oh)) {
3809         /* Remove all the ports. */
3810         b->size = (sizeof(struct ofp_header)
3811                    + sizeof(struct ofp_switch_features));
3812         ofpmsg_update_length(b);
3813
3814         return true;
3815     }
3816
3817     return false;
3818 }
3819
3820 static ovs_be32
3821 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3822                    const struct ofputil_action_bit_translation *x)
3823 {
3824     uint32_t of_actions;
3825
3826     of_actions = 0;
3827     for (; x->ofputil_bit; x++) {
3828         if (ofputil_actions & x->ofputil_bit) {
3829             of_actions |= 1 << x->of_bit;
3830         }
3831     }
3832     return htonl(of_actions);
3833 }
3834
3835 /* Returns a buffer owned by the caller that encodes 'features' in the format
3836  * required by 'protocol' with the given 'xid'.  The caller should append port
3837  * information to the buffer with subsequent calls to
3838  * ofputil_put_switch_features_port(). */
3839 struct ofpbuf *
3840 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3841                                enum ofputil_protocol protocol, ovs_be32 xid)
3842 {
3843     struct ofp_switch_features *osf;
3844     struct ofpbuf *b;
3845     enum ofp_version version;
3846     enum ofpraw raw;
3847
3848     version = ofputil_protocol_to_ofp_version(protocol);
3849     switch (version) {
3850     case OFP10_VERSION:
3851         raw = OFPRAW_OFPT10_FEATURES_REPLY;
3852         break;
3853     case OFP11_VERSION:
3854     case OFP12_VERSION:
3855         raw = OFPRAW_OFPT11_FEATURES_REPLY;
3856         break;
3857     case OFP13_VERSION:
3858         raw = OFPRAW_OFPT13_FEATURES_REPLY;
3859         break;
3860     default:
3861         NOT_REACHED();
3862     }
3863     b = ofpraw_alloc_xid(raw, version, xid, 0);
3864     osf = ofpbuf_put_zeros(b, sizeof *osf);
3865     osf->datapath_id = htonll(features->datapath_id);
3866     osf->n_buffers = htonl(features->n_buffers);
3867     osf->n_tables = features->n_tables;
3868
3869     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3870     osf->capabilities = htonl(features->capabilities &
3871                               ofputil_capabilities_mask(version));
3872     switch (version) {
3873     case OFP10_VERSION:
3874         if (features->capabilities & OFPUTIL_C_STP) {
3875             osf->capabilities |= htonl(OFPC10_STP);
3876         }
3877         osf->actions = encode_action_bits(features->actions, of10_action_bits);
3878         break;
3879     case OFP13_VERSION:
3880         osf->auxiliary_id = features->auxiliary_id;
3881         /* fall through */
3882     case OFP11_VERSION:
3883     case OFP12_VERSION:
3884         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3885             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3886         }
3887         break;
3888     default:
3889         NOT_REACHED();
3890     }
3891
3892     return b;
3893 }
3894
3895 /* Encodes 'pp' into the format required by the switch_features message already
3896  * in 'b', which should have been returned by ofputil_encode_switch_features(),
3897  * and appends the encoded version to 'b'. */
3898 void
3899 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3900                                  struct ofpbuf *b)
3901 {
3902     const struct ofp_header *oh = b->data;
3903
3904     if (oh->version < OFP13_VERSION) {
3905         ofputil_put_phy_port(oh->version, pp, b);
3906     }
3907 }
3908 \f
3909 /* ofputil_port_status */
3910
3911 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3912  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3913 enum ofperr
3914 ofputil_decode_port_status(const struct ofp_header *oh,
3915                            struct ofputil_port_status *ps)
3916 {
3917     const struct ofp_port_status *ops;
3918     struct ofpbuf b;
3919     int retval;
3920
3921     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3922     ofpraw_pull_assert(&b);
3923     ops = ofpbuf_pull(&b, sizeof *ops);
3924
3925     if (ops->reason != OFPPR_ADD &&
3926         ops->reason != OFPPR_DELETE &&
3927         ops->reason != OFPPR_MODIFY) {
3928         return OFPERR_NXBRC_BAD_REASON;
3929     }
3930     ps->reason = ops->reason;
3931
3932     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3933     ovs_assert(retval != EOF);
3934     return retval;
3935 }
3936
3937 /* Converts the abstract form of a "port status" message in '*ps' into an
3938  * OpenFlow message suitable for 'protocol', and returns that encoded form in
3939  * a buffer owned by the caller. */
3940 struct ofpbuf *
3941 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3942                            enum ofputil_protocol protocol)
3943 {
3944     struct ofp_port_status *ops;
3945     struct ofpbuf *b;
3946     enum ofp_version version;
3947     enum ofpraw raw;
3948
3949     version = ofputil_protocol_to_ofp_version(protocol);
3950     switch (version) {
3951     case OFP10_VERSION:
3952         raw = OFPRAW_OFPT10_PORT_STATUS;
3953         break;
3954
3955     case OFP11_VERSION:
3956     case OFP12_VERSION:
3957     case OFP13_VERSION:
3958         raw = OFPRAW_OFPT11_PORT_STATUS;
3959         break;
3960
3961     default:
3962         NOT_REACHED();
3963     }
3964
3965     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3966     ops = ofpbuf_put_zeros(b, sizeof *ops);
3967     ops->reason = ps->reason;
3968     ofputil_put_phy_port(version, &ps->desc, b);
3969     ofpmsg_update_length(b);
3970     return b;
3971 }
3972
3973 /* ofputil_port_mod */
3974
3975 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3976  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3977 enum ofperr
3978 ofputil_decode_port_mod(const struct ofp_header *oh,
3979                         struct ofputil_port_mod *pm)
3980 {
3981     enum ofpraw raw;
3982     struct ofpbuf b;
3983
3984     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3985     raw = ofpraw_pull_assert(&b);
3986
3987     if (raw == OFPRAW_OFPT10_PORT_MOD) {
3988         const struct ofp10_port_mod *opm = b.data;
3989
3990         pm->port_no = u16_to_ofp(ntohs(opm->port_no));
3991         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3992         pm->config = ntohl(opm->config) & OFPPC10_ALL;
3993         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3994         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3995     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3996         const struct ofp11_port_mod *opm = b.data;
3997         enum ofperr error;
3998
3999         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4000         if (error) {
4001             return error;
4002         }
4003
4004         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
4005         pm->config = ntohl(opm->config) & OFPPC11_ALL;
4006         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4007         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4008     } else {
4009         return OFPERR_OFPBRC_BAD_TYPE;
4010     }
4011
4012     pm->config &= pm->mask;
4013     return 0;
4014 }
4015
4016 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4017  * message suitable for 'protocol', and returns that encoded form in a buffer
4018  * owned by the caller. */
4019 struct ofpbuf *
4020 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
4021                         enum ofputil_protocol protocol)
4022 {
4023     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4024     struct ofpbuf *b;
4025
4026     switch (ofp_version) {
4027     case OFP10_VERSION: {
4028         struct ofp10_port_mod *opm;
4029
4030         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
4031         opm = ofpbuf_put_zeros(b, sizeof *opm);
4032         opm->port_no = htons(ofp_to_u16(pm->port_no));
4033         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
4034         opm->config = htonl(pm->config & OFPPC10_ALL);
4035         opm->mask = htonl(pm->mask & OFPPC10_ALL);
4036         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
4037         break;
4038     }
4039
4040     case OFP11_VERSION:
4041     case OFP12_VERSION:
4042     case OFP13_VERSION: {
4043         struct ofp11_port_mod *opm;
4044
4045         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
4046         opm = ofpbuf_put_zeros(b, sizeof *opm);
4047         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4048         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
4049         opm->config = htonl(pm->config & OFPPC11_ALL);
4050         opm->mask = htonl(pm->mask & OFPPC11_ALL);
4051         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
4052         break;
4053     }
4054     default:
4055         NOT_REACHED();
4056     }
4057
4058     return b;
4059 }
4060
4061 /* ofputil_table_mod */
4062
4063 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
4064  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
4065 enum ofperr
4066 ofputil_decode_table_mod(const struct ofp_header *oh,
4067                          struct ofputil_table_mod *pm)
4068 {
4069     enum ofpraw raw;
4070     struct ofpbuf b;
4071
4072     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4073     raw = ofpraw_pull_assert(&b);
4074
4075     if (raw == OFPRAW_OFPT11_TABLE_MOD) {
4076         const struct ofp11_table_mod *otm = b.data;
4077
4078         pm->table_id = otm->table_id;
4079         pm->config = ntohl(otm->config);
4080     } else {
4081         return OFPERR_OFPBRC_BAD_TYPE;
4082     }
4083
4084     return 0;
4085 }
4086
4087 /* Converts the abstract form of a "table mod" message in '*pm' into an OpenFlow
4088  * message suitable for 'protocol', and returns that encoded form in a buffer
4089  * owned by the caller. */
4090 struct ofpbuf *
4091 ofputil_encode_table_mod(const struct ofputil_table_mod *pm,
4092                         enum ofputil_protocol protocol)
4093 {
4094     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4095     struct ofpbuf *b;
4096
4097     switch (ofp_version) {
4098     case OFP10_VERSION: {
4099         ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
4100                      "(\'-O OpenFlow11\')");
4101         break;
4102     }
4103     case OFP11_VERSION:
4104     case OFP12_VERSION:
4105     case OFP13_VERSION: {
4106         struct ofp11_table_mod *otm;
4107
4108         b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
4109         otm = ofpbuf_put_zeros(b, sizeof *otm);
4110         otm->table_id = pm->table_id;
4111         otm->config = htonl(pm->config);
4112         break;
4113     }
4114     default:
4115         NOT_REACHED();
4116     }
4117
4118     return b;
4119 }
4120 \f
4121 /* ofputil_role_request */
4122
4123 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
4124  * an abstract form in '*rr'.  Returns 0 if successful, otherwise an
4125  * OFPERR_* value. */
4126 enum ofperr
4127 ofputil_decode_role_message(const struct ofp_header *oh,
4128                             struct ofputil_role_request *rr)
4129 {
4130     struct ofpbuf b;
4131     enum ofpraw raw;
4132
4133     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4134     raw = ofpraw_pull_assert(&b);
4135
4136     if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
4137         raw == OFPRAW_OFPT12_ROLE_REPLY) {
4138         const struct ofp12_role_request *orr = b.l3;
4139
4140         if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
4141             orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
4142             orr->role != htonl(OFPCR12_ROLE_MASTER) &&
4143             orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
4144             return OFPERR_OFPRRFC_BAD_ROLE;
4145         }
4146
4147         rr->role = ntohl(orr->role);
4148         if (raw == OFPRAW_OFPT12_ROLE_REQUEST
4149             ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
4150             : orr->generation_id == OVS_BE64_MAX) {
4151             rr->have_generation_id = false;
4152             rr->generation_id = 0;
4153         } else {
4154             rr->have_generation_id = true;
4155             rr->generation_id = ntohll(orr->generation_id);
4156         }
4157     } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
4158                raw == OFPRAW_NXT_ROLE_REPLY) {
4159         const struct nx_role_request *nrr = b.l3;
4160
4161         BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
4162         BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
4163         BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
4164
4165         if (nrr->role != htonl(NX_ROLE_OTHER) &&
4166             nrr->role != htonl(NX_ROLE_MASTER) &&
4167             nrr->role != htonl(NX_ROLE_SLAVE)) {
4168             return OFPERR_OFPRRFC_BAD_ROLE;
4169         }
4170
4171         rr->role = ntohl(nrr->role) + 1;
4172         rr->have_generation_id = false;
4173         rr->generation_id = 0;
4174     } else {
4175         NOT_REACHED();
4176     }
4177
4178     return 0;
4179 }
4180
4181 /* Returns an encoded form of a role reply suitable for the "request" in a
4182  * buffer owned by the caller. */
4183 struct ofpbuf *
4184 ofputil_encode_role_reply(const struct ofp_header *request,
4185                           const struct ofputil_role_request *rr)
4186 {
4187     struct ofpbuf *buf;
4188     enum ofpraw raw;
4189
4190     raw = ofpraw_decode_assert(request);
4191     if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
4192         struct ofp12_role_request *orr;
4193
4194         buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
4195         orr = ofpbuf_put_zeros(buf, sizeof *orr);
4196
4197         orr->role = htonl(rr->role);
4198         orr->generation_id = htonll(rr->have_generation_id
4199                                     ? rr->generation_id
4200                                     : UINT64_MAX);
4201     } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
4202         struct nx_role_request *nrr;
4203
4204         BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
4205         BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
4206         BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
4207
4208         buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
4209         nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
4210         nrr->role = htonl(rr->role - 1);
4211     } else {
4212         NOT_REACHED();
4213     }
4214
4215     return buf;
4216 }
4217 \f
4218 struct ofpbuf *
4219 ofputil_encode_role_status(const struct ofputil_role_status *status,
4220                            enum ofputil_protocol protocol)
4221 {
4222     struct ofpbuf *buf;
4223     enum ofp_version version;
4224     struct ofp14_role_status *rstatus;
4225
4226     version = ofputil_protocol_to_ofp_version(protocol);
4227     buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0), 0);
4228     rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
4229     rstatus->role = htonl(status->role);
4230     rstatus->reason = status->reason;
4231     rstatus->generation_id = htonll(status->generation_id);
4232
4233     return buf;
4234 }
4235
4236 enum ofperr
4237 ofputil_decode_role_status(const struct ofp_header *oh,
4238                            struct ofputil_role_status *rs)
4239 {
4240     struct ofpbuf b;
4241     enum ofpraw raw;
4242     const struct ofp14_role_status *r;
4243
4244     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4245     raw = ofpraw_pull_assert(&b);
4246     ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
4247
4248     r = b.l3;
4249     if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
4250         r->role != htonl(OFPCR12_ROLE_EQUAL) &&
4251         r->role != htonl(OFPCR12_ROLE_MASTER) &&
4252         r->role != htonl(OFPCR12_ROLE_SLAVE)) {
4253         return OFPERR_OFPRRFC_BAD_ROLE;
4254     }
4255
4256     rs->role = ntohl(r->role);
4257     rs->generation_id = ntohll(r->generation_id);
4258     rs->reason = r->reason;
4259
4260     return 0;
4261 }
4262
4263 /* Table stats. */
4264
4265 static void
4266 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
4267                               struct ofpbuf *buf)
4268 {
4269     struct wc_map {
4270         enum ofp10_flow_wildcards wc10;
4271         enum oxm12_ofb_match_fields mf12;
4272     };
4273
4274     static const struct wc_map wc_map[] = {
4275         { OFPFW10_IN_PORT,     OFPXMT12_OFB_IN_PORT },
4276         { OFPFW10_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
4277         { OFPFW10_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
4278         { OFPFW10_DL_DST,      OFPXMT12_OFB_ETH_DST},
4279         { OFPFW10_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
4280         { OFPFW10_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
4281         { OFPFW10_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
4282         { OFPFW10_TP_DST,      OFPXMT12_OFB_TCP_DST },
4283         { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
4284         { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
4285         { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4286         { OFPFW10_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
4287     };
4288
4289     struct ofp10_table_stats *out;
4290     const struct wc_map *p;
4291
4292     out = ofpbuf_put_zeros(buf, sizeof *out);
4293     out->table_id = in->table_id;
4294     ovs_strlcpy(out->name, in->name, sizeof out->name);
4295     out->wildcards = 0;
4296     for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
4297         if (in->wildcards & htonll(1ULL << p->mf12)) {
4298             out->wildcards |= htonl(p->wc10);
4299         }
4300     }
4301     out->max_entries = in->max_entries;
4302     out->active_count = in->active_count;
4303     put_32aligned_be64(&out->lookup_count, in->lookup_count);
4304     put_32aligned_be64(&out->matched_count, in->matched_count);
4305 }
4306
4307 static ovs_be32
4308 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
4309 {
4310     struct map {
4311         enum ofp11_flow_match_fields fmf11;
4312         enum oxm12_ofb_match_fields mf12;
4313     };
4314
4315     static const struct map map[] = {
4316         { OFPFMF11_IN_PORT,     OFPXMT12_OFB_IN_PORT },
4317         { OFPFMF11_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
4318         { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
4319         { OFPFMF11_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
4320         { OFPFMF11_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
4321         { OFPFMF11_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
4322         { OFPFMF11_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
4323         { OFPFMF11_TP_DST,      OFPXMT12_OFB_TCP_DST },
4324         { OFPFMF11_MPLS_LABEL,  OFPXMT12_OFB_MPLS_LABEL },
4325         { OFPFMF11_MPLS_TC,     OFPXMT12_OFB_MPLS_TC },
4326         /* I don't know what OFPFMF11_TYPE means. */
4327         { OFPFMF11_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
4328         { OFPFMF11_DL_DST,      OFPXMT12_OFB_ETH_DST },
4329         { OFPFMF11_NW_SRC,      OFPXMT12_OFB_IPV4_SRC },
4330         { OFPFMF11_NW_DST,      OFPXMT12_OFB_IPV4_DST },
4331         { OFPFMF11_METADATA,    OFPXMT12_OFB_METADATA },
4332     };
4333
4334     const struct map *p;
4335     uint32_t fmf11;
4336
4337     fmf11 = 0;
4338     for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
4339         if (oxm12 & htonll(1ULL << p->mf12)) {
4340             fmf11 |= p->fmf11;
4341         }
4342     }
4343     return htonl(fmf11);
4344 }
4345
4346 static void
4347 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
4348                               struct ofpbuf *buf)
4349 {
4350     struct ofp11_table_stats *out;
4351
4352     out = ofpbuf_put_zeros(buf, sizeof *out);
4353     out->table_id = in->table_id;
4354     ovs_strlcpy(out->name, in->name, sizeof out->name);
4355     out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
4356     out->match = oxm12_to_ofp11_flow_match_fields(in->match);
4357     out->instructions = in->instructions;
4358     out->write_actions = in->write_actions;
4359     out->apply_actions = in->apply_actions;
4360     out->config = in->config;
4361     out->max_entries = in->max_entries;
4362     out->active_count = in->active_count;
4363     out->lookup_count = in->lookup_count;
4364     out->matched_count = in->matched_count;
4365 }
4366
4367 static void
4368 ofputil_put_ofp12_table_stats(const struct ofp12_table_stats *in,
4369                               struct ofpbuf *buf)
4370 {
4371     struct ofp12_table_stats *out = ofpbuf_put(buf, in, sizeof *in);
4372
4373     /* Trim off OF1.3-only capabilities. */
4374     out->match &= htonll(OFPXMT12_MASK);
4375     out->wildcards &= htonll(OFPXMT12_MASK);
4376     out->write_setfields &= htonll(OFPXMT12_MASK);
4377     out->apply_setfields &= htonll(OFPXMT12_MASK);
4378 }
4379
4380 static void
4381 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
4382                               struct ofpbuf *buf)
4383 {
4384     struct ofp13_table_stats *out;
4385
4386     /* OF 1.3 splits table features off the ofp_table_stats,
4387      * so there is not much here. */
4388
4389     out = ofpbuf_put_uninit(buf, sizeof *out);
4390     out->table_id = in->table_id;
4391     out->active_count = in->active_count;
4392     out->lookup_count = in->lookup_count;
4393     out->matched_count = in->matched_count;
4394 }
4395
4396 struct ofpbuf *
4397 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
4398                                  const struct ofp_header *request)
4399 {
4400     struct ofpbuf *reply;
4401     int i;
4402
4403     reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
4404
4405     for (i = 0; i < n; i++) {
4406         switch ((enum ofp_version) request->version) {
4407         case OFP10_VERSION:
4408             ofputil_put_ofp10_table_stats(&stats[i], reply);
4409             break;
4410
4411         case OFP11_VERSION:
4412             ofputil_put_ofp11_table_stats(&stats[i], reply);
4413             break;
4414
4415         case OFP12_VERSION:
4416             ofputil_put_ofp12_table_stats(&stats[i], reply);
4417             break;
4418
4419         case OFP13_VERSION:
4420             ofputil_put_ofp13_table_stats(&stats[i], reply);
4421             break;
4422
4423         default:
4424             NOT_REACHED();
4425         }
4426     }
4427
4428     return reply;
4429 }
4430 \f
4431 /* ofputil_flow_monitor_request */
4432
4433 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4434  * ofputil_flow_monitor_request in 'rq'.
4435  *
4436  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4437  * message.  Calling this function multiple times for a single 'msg' iterates
4438  * through the requests.  The caller must initially leave 'msg''s layer
4439  * pointers null and not modify them between calls.
4440  *
4441  * Returns 0 if successful, EOF if no requests were left in this 'msg',
4442  * otherwise an OFPERR_* value. */
4443 int
4444 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4445                                     struct ofpbuf *msg)
4446 {
4447     struct nx_flow_monitor_request *nfmr;
4448     uint16_t flags;
4449
4450     if (!msg->l2) {
4451         msg->l2 = msg->data;
4452         ofpraw_pull_assert(msg);
4453     }
4454
4455     if (!msg->size) {
4456         return EOF;
4457     }
4458
4459     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4460     if (!nfmr) {
4461         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
4462                      "leftover bytes at end", msg->size);
4463         return OFPERR_OFPBRC_BAD_LEN;
4464     }
4465
4466     flags = ntohs(nfmr->flags);
4467     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4468         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4469                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4470         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4471                      flags);
4472         return OFPERR_NXBRC_FM_BAD_FLAGS;
4473     }
4474
4475     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4476         return OFPERR_NXBRC_MUST_BE_ZERO;
4477     }
4478
4479     rq->id = ntohl(nfmr->id);
4480     rq->flags = flags;
4481     rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4482     rq->table_id = nfmr->table_id;
4483
4484     return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4485 }
4486
4487 void
4488 ofputil_append_flow_monitor_request(
4489     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4490 {
4491     struct nx_flow_monitor_request *nfmr;
4492     size_t start_ofs;
4493     int match_len;
4494
4495     if (!msg->size) {
4496         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4497     }
4498
4499     start_ofs = msg->size;
4500     ofpbuf_put_zeros(msg, sizeof *nfmr);
4501     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4502
4503     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4504     nfmr->id = htonl(rq->id);
4505     nfmr->flags = htons(rq->flags);
4506     nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4507     nfmr->match_len = htons(match_len);
4508     nfmr->table_id = rq->table_id;
4509 }
4510
4511 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4512  * into an abstract ofputil_flow_update in 'update'.  The caller must have
4513  * initialized update->match to point to space allocated for a match.
4514  *
4515  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4516  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
4517  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
4518  * will point into the 'ofpacts' buffer.
4519  *
4520  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
4521  * this function multiple times for a single 'msg' iterates through the
4522  * updates.  The caller must initially leave 'msg''s layer pointers null and
4523  * not modify them between calls.
4524  *
4525  * Returns 0 if successful, EOF if no updates were left in this 'msg',
4526  * otherwise an OFPERR_* value. */
4527 int
4528 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4529                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
4530 {
4531     struct nx_flow_update_header *nfuh;
4532     unsigned int length;
4533     struct ofp_header *oh;
4534
4535     if (!msg->l2) {
4536         msg->l2 = msg->data;
4537         ofpraw_pull_assert(msg);
4538     }
4539
4540     if (!msg->size) {
4541         return EOF;
4542     }
4543
4544     if (msg->size < sizeof(struct nx_flow_update_header)) {
4545         goto bad_len;
4546     }
4547
4548     oh = msg->l2;
4549
4550     nfuh = msg->data;
4551     update->event = ntohs(nfuh->event);
4552     length = ntohs(nfuh->length);
4553     if (length > msg->size || length % 8) {
4554         goto bad_len;
4555     }
4556
4557     if (update->event == NXFME_ABBREV) {
4558         struct nx_flow_update_abbrev *nfua;
4559
4560         if (length != sizeof *nfua) {
4561             goto bad_len;
4562         }
4563
4564         nfua = ofpbuf_pull(msg, sizeof *nfua);
4565         update->xid = nfua->xid;
4566         return 0;
4567     } else if (update->event == NXFME_ADDED
4568                || update->event == NXFME_DELETED
4569                || update->event == NXFME_MODIFIED) {
4570         struct nx_flow_update_full *nfuf;
4571         unsigned int actions_len;
4572         unsigned int match_len;
4573         enum ofperr error;
4574
4575         if (length < sizeof *nfuf) {
4576             goto bad_len;
4577         }
4578
4579         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4580         match_len = ntohs(nfuf->match_len);
4581         if (sizeof *nfuf + match_len > length) {
4582             goto bad_len;
4583         }
4584
4585         update->reason = ntohs(nfuf->reason);
4586         update->idle_timeout = ntohs(nfuf->idle_timeout);
4587         update->hard_timeout = ntohs(nfuf->hard_timeout);
4588         update->table_id = nfuf->table_id;
4589         update->cookie = nfuf->cookie;
4590         update->priority = ntohs(nfuf->priority);
4591
4592         error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4593         if (error) {
4594             return error;
4595         }
4596
4597         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4598         error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
4599                                               ofpacts);
4600         if (error) {
4601             return error;
4602         }
4603
4604         update->ofpacts = ofpacts->data;
4605         update->ofpacts_len = ofpacts->size;
4606         return 0;
4607     } else {
4608         VLOG_WARN_RL(&bad_ofmsg_rl,
4609                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4610                      ntohs(nfuh->event));
4611         return OFPERR_NXBRC_FM_BAD_EVENT;
4612     }
4613
4614 bad_len:
4615     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
4616                  "leftover bytes at end", msg->size);
4617     return OFPERR_OFPBRC_BAD_LEN;
4618 }
4619
4620 uint32_t
4621 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4622 {
4623     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4624
4625     return ntohl(cancel->id);
4626 }
4627
4628 struct ofpbuf *
4629 ofputil_encode_flow_monitor_cancel(uint32_t id)
4630 {
4631     struct nx_flow_monitor_cancel *nfmc;
4632     struct ofpbuf *msg;
4633
4634     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4635     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4636     nfmc->id = htonl(id);
4637     return msg;
4638 }
4639
4640 void
4641 ofputil_start_flow_update(struct list *replies)
4642 {
4643     struct ofpbuf *msg;
4644
4645     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4646                            htonl(0), 1024);
4647
4648     list_init(replies);
4649     list_push_back(replies, &msg->list_node);
4650 }
4651
4652 void
4653 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4654                            struct list *replies)
4655 {
4656     struct nx_flow_update_header *nfuh;
4657     struct ofpbuf *msg;
4658     size_t start_ofs;
4659     enum ofp_version version;
4660
4661     msg = ofpbuf_from_list(list_back(replies));
4662     start_ofs = msg->size;
4663     version = ((struct ofp_header *)msg->l2)->version;
4664
4665     if (update->event == NXFME_ABBREV) {
4666         struct nx_flow_update_abbrev *nfua;
4667
4668         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4669         nfua->xid = update->xid;
4670     } else {
4671         struct nx_flow_update_full *nfuf;
4672         int match_len;
4673
4674         ofpbuf_put_zeros(msg, sizeof *nfuf);
4675         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4676         ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
4677                                      version);
4678         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4679         nfuf->reason = htons(update->reason);
4680         nfuf->priority = htons(update->priority);
4681         nfuf->idle_timeout = htons(update->idle_timeout);
4682         nfuf->hard_timeout = htons(update->hard_timeout);
4683         nfuf->match_len = htons(match_len);
4684         nfuf->table_id = update->table_id;
4685         nfuf->cookie = update->cookie;
4686     }
4687
4688     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4689     nfuh->length = htons(msg->size - start_ofs);
4690     nfuh->event = htons(update->event);
4691
4692     ofpmp_postappend(replies, start_ofs);
4693 }
4694 \f
4695 struct ofpbuf *
4696 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4697                           enum ofputil_protocol protocol)
4698 {
4699     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4700     struct ofpbuf *msg;
4701     size_t size;
4702
4703     size = po->ofpacts_len;
4704     if (po->buffer_id == UINT32_MAX) {
4705         size += po->packet_len;
4706     }
4707
4708     switch (ofp_version) {
4709     case OFP10_VERSION: {
4710         struct ofp10_packet_out *opo;
4711         size_t actions_ofs;
4712
4713         msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4714         ofpbuf_put_zeros(msg, sizeof *opo);
4715         actions_ofs = msg->size;
4716         ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
4717                                      ofp_version);
4718
4719         opo = msg->l3;
4720         opo->buffer_id = htonl(po->buffer_id);
4721         opo->in_port = htons(ofp_to_u16(po->in_port));
4722         opo->actions_len = htons(msg->size - actions_ofs);
4723         break;
4724     }
4725
4726     case OFP11_VERSION:
4727     case OFP12_VERSION:
4728     case OFP13_VERSION: {
4729         struct ofp11_packet_out *opo;
4730         size_t len;
4731
4732         msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4733         ofpbuf_put_zeros(msg, sizeof *opo);
4734         len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
4735                                            ofp_version);
4736         opo = msg->l3;
4737         opo->buffer_id = htonl(po->buffer_id);
4738         opo->in_port = ofputil_port_to_ofp11(po->in_port);
4739         opo->actions_len = htons(len);
4740         break;
4741     }
4742
4743     default:
4744         NOT_REACHED();
4745     }
4746
4747     if (po->buffer_id == UINT32_MAX) {
4748         ofpbuf_put(msg, po->packet, po->packet_len);
4749     }
4750
4751     ofpmsg_update_length(msg);
4752
4753     return msg;
4754 }
4755 \f
4756 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4757 struct ofpbuf *
4758 make_echo_request(enum ofp_version ofp_version)
4759 {
4760     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4761                             htonl(0), 0);
4762 }
4763
4764 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4765  * OFPT_ECHO_REQUEST message in 'rq'. */
4766 struct ofpbuf *
4767 make_echo_reply(const struct ofp_header *rq)
4768 {
4769     struct ofpbuf rq_buf;
4770     struct ofpbuf *reply;
4771
4772     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4773     ofpraw_pull_assert(&rq_buf);
4774
4775     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4776     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4777     return reply;
4778 }
4779
4780 struct ofpbuf *
4781 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4782 {
4783     enum ofpraw type;
4784
4785     switch (ofp_version) {
4786     case OFP13_VERSION:
4787     case OFP12_VERSION:
4788     case OFP11_VERSION:
4789         type = OFPRAW_OFPT11_BARRIER_REQUEST;
4790         break;
4791
4792     case OFP10_VERSION:
4793         type = OFPRAW_OFPT10_BARRIER_REQUEST;
4794         break;
4795
4796     default:
4797         NOT_REACHED();
4798     }
4799
4800     return ofpraw_alloc(type, ofp_version, 0);
4801 }
4802
4803 const char *
4804 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4805 {
4806     switch (flags & OFPC_FRAG_MASK) {
4807     case OFPC_FRAG_NORMAL:   return "normal";
4808     case OFPC_FRAG_DROP:     return "drop";
4809     case OFPC_FRAG_REASM:    return "reassemble";
4810     case OFPC_FRAG_NX_MATCH: return "nx-match";
4811     }
4812
4813     NOT_REACHED();
4814 }
4815
4816 bool
4817 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4818 {
4819     if (!strcasecmp(s, "normal")) {
4820         *flags = OFPC_FRAG_NORMAL;
4821     } else if (!strcasecmp(s, "drop")) {
4822         *flags = OFPC_FRAG_DROP;
4823     } else if (!strcasecmp(s, "reassemble")) {
4824         *flags = OFPC_FRAG_REASM;
4825     } else if (!strcasecmp(s, "nx-match")) {
4826         *flags = OFPC_FRAG_NX_MATCH;
4827     } else {
4828         return false;
4829     }
4830     return true;
4831 }
4832
4833 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4834  * port number and stores the latter in '*ofp10_port', for the purpose of
4835  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
4836  * otherwise an OFPERR_* number.  On error, stores OFPP_NONE in '*ofp10_port'.
4837  *
4838  * See the definition of OFP11_MAX for an explanation of the mapping. */
4839 enum ofperr
4840 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4841 {
4842     uint32_t ofp11_port_h = ntohl(ofp11_port);
4843
4844     if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4845         *ofp10_port = u16_to_ofp(ofp11_port_h);
4846         return 0;
4847     } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4848         *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4849         return 0;
4850     } else {
4851         *ofp10_port = OFPP_NONE;
4852         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4853                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4854                      ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4855                      ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4856         return OFPERR_OFPBAC_BAD_OUT_PORT;
4857     }
4858 }
4859
4860 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4861  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4862  *
4863  * See the definition of OFP11_MAX for an explanation of the mapping. */
4864 ovs_be32
4865 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4866 {
4867     return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4868                  ? ofp_to_u16(ofp10_port)
4869                  : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4870 }
4871
4872 #define OFPUTIL_NAMED_PORTS                     \
4873         OFPUTIL_NAMED_PORT(IN_PORT)             \
4874         OFPUTIL_NAMED_PORT(TABLE)               \
4875         OFPUTIL_NAMED_PORT(NORMAL)              \
4876         OFPUTIL_NAMED_PORT(FLOOD)               \
4877         OFPUTIL_NAMED_PORT(ALL)                 \
4878         OFPUTIL_NAMED_PORT(CONTROLLER)          \
4879         OFPUTIL_NAMED_PORT(LOCAL)               \
4880         OFPUTIL_NAMED_PORT(ANY)
4881
4882 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4883 #define OFPUTIL_NAMED_PORTS_WITH_NONE           \
4884         OFPUTIL_NAMED_PORTS                     \
4885         OFPUTIL_NAMED_PORT(NONE)
4886
4887 /* Stores the port number represented by 's' into '*portp'.  's' may be an
4888  * integer or, for reserved ports, the standard OpenFlow name for the port
4889  * (e.g. "LOCAL").
4890  *
4891  * Returns true if successful, false if 's' is not a valid OpenFlow port number
4892  * or name.  The caller should issue an error message in this case, because
4893  * this function usually does not.  (This gives the caller an opportunity to
4894  * look up the port name another way, e.g. by contacting the switch and listing
4895  * the names of all its ports).
4896  *
4897  * This function accepts OpenFlow 1.0 port numbers.  It also accepts a subset
4898  * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4899  * range as described in include/openflow/openflow-1.1.h. */
4900 bool
4901 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4902 {
4903     uint32_t port32;
4904
4905     *portp = 0;
4906     if (str_to_uint(s, 10, &port32)) {
4907         if (port32 < ofp_to_u16(OFPP_MAX)) {
4908             /* Pass. */
4909         } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4910             VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4911                       "be translated to %u when talking to an OF1.1 or "
4912                       "later controller", port32, port32 + OFPP11_OFFSET);
4913         } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4914             char name[OFP_MAX_PORT_NAME_LEN];
4915
4916             ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4917             VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4918                            "for compatibility with OpenFlow 1.1 and later",
4919                            name, port32);
4920         } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4921             VLOG_WARN("port %u is outside the supported range 0 through "
4922                       "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4923                       UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4924             return false;
4925         } else {
4926             port32 -= OFPP11_OFFSET;
4927         }
4928
4929         *portp = u16_to_ofp(port32);
4930         return true;
4931     } else {
4932         struct pair {
4933             const char *name;
4934             ofp_port_t value;
4935         };
4936         static const struct pair pairs[] = {
4937 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4938             OFPUTIL_NAMED_PORTS_WITH_NONE
4939 #undef OFPUTIL_NAMED_PORT
4940         };
4941         const struct pair *p;
4942
4943         for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4944             if (!strcasecmp(s, p->name)) {
4945                 *portp = p->value;
4946                 return true;
4947             }
4948         }
4949         return false;
4950     }
4951 }
4952
4953 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4954  * Most ports' string representation is just the port number, but for special
4955  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4956 void
4957 ofputil_format_port(ofp_port_t port, struct ds *s)
4958 {
4959     char name[OFP_MAX_PORT_NAME_LEN];
4960
4961     ofputil_port_to_string(port, name, sizeof name);
4962     ds_put_cstr(s, name);
4963 }
4964
4965 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
4966  * representation of OpenFlow port number 'port'.  Most ports are represented
4967  * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
4968  * by name, e.g. "LOCAL". */
4969 void
4970 ofputil_port_to_string(ofp_port_t port,
4971                        char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
4972 {
4973     switch (port) {
4974 #define OFPUTIL_NAMED_PORT(NAME)                        \
4975         case OFPP_##NAME:                               \
4976             ovs_strlcpy(namebuf, #NAME, bufsize);       \
4977             break;
4978         OFPUTIL_NAMED_PORTS
4979 #undef OFPUTIL_NAMED_PORT
4980
4981     default:
4982         snprintf(namebuf, bufsize, "%"PRIu16, port);
4983         break;
4984     }
4985 }
4986
4987 /* Stores the group id represented by 's' into '*group_idp'.  's' may be an
4988  * integer or, for reserved group IDs, the standard OpenFlow name for the group
4989  * (either "ANY" or "ALL").
4990  *
4991  * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
4992  * name. */
4993 bool
4994 ofputil_group_from_string(const char *s, uint32_t *group_idp)
4995 {
4996     if (!strcasecmp(s, "any")) {
4997         *group_idp = OFPG11_ANY;
4998     } else if (!strcasecmp(s, "all")) {
4999         *group_idp = OFPG11_ALL;
5000     } else if (!str_to_uint(s, 10, group_idp)) {
5001         VLOG_WARN("%s is not a valid group ID.  (Valid group IDs are "
5002                   "32-bit nonnegative integers or the keywords ANY or "
5003                   "ALL.)", s);
5004         return false;
5005     }
5006
5007     return true;
5008 }
5009
5010 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
5011  * Most groups' string representation is just the number, but for special
5012  * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */
5013 void
5014 ofputil_format_group(uint32_t group_id, struct ds *s)
5015 {
5016     char name[MAX_GROUP_NAME_LEN];
5017
5018     ofputil_group_to_string(group_id, name, sizeof name);
5019     ds_put_cstr(s, name);
5020 }
5021
5022
5023 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5024  * representation of OpenFlow group ID 'group_id'.  Most group are represented
5025  * as just their number, but special groups, e.g. OFPG11_ALL, are represented
5026  * by name, e.g. "ALL". */
5027 void
5028 ofputil_group_to_string(uint32_t group_id,
5029                         char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
5030 {
5031     switch (group_id) {
5032     case OFPG11_ALL:
5033         ovs_strlcpy(namebuf, "ALL", bufsize);
5034         break;
5035
5036     case OFPG11_ANY:
5037         ovs_strlcpy(namebuf, "ANY", bufsize);
5038         break;
5039
5040     default:
5041         snprintf(namebuf, bufsize, "%"PRIu32, group_id);
5042         break;
5043     }
5044 }
5045
5046 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5047  * 'ofp_version', tries to pull the first element from the array.  If
5048  * successful, initializes '*pp' with an abstract representation of the
5049  * port and returns 0.  If no ports remain to be decoded, returns EOF.
5050  * On an error, returns a positive OFPERR_* value. */
5051 int
5052 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
5053                       struct ofputil_phy_port *pp)
5054 {
5055     switch (ofp_version) {
5056     case OFP10_VERSION: {
5057         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
5058         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
5059     }
5060     case OFP11_VERSION:
5061     case OFP12_VERSION:
5062     case OFP13_VERSION: {
5063         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
5064         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
5065     }
5066     default:
5067         NOT_REACHED();
5068     }
5069 }
5070
5071 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5072  * 'ofp_version', returns the number of elements. */
5073 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
5074 {
5075     return b->size / ofputil_get_phy_port_size(ofp_version);
5076 }
5077
5078 /* ofp-util.def lists the mapping from names to action. */
5079 static const char *const names[OFPUTIL_N_ACTIONS] = {
5080     NULL,
5081 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
5082 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5083 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   NAME,
5084 #include "ofp-util.def"
5085 };
5086
5087 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
5088  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1
5089  * if 'name' is not the name of any action. */
5090 int
5091 ofputil_action_code_from_name(const char *name)
5092 {
5093     const char *const *p;
5094
5095     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
5096         if (*p && !strcasecmp(name, *p)) {
5097             return p - names;
5098         }
5099     }
5100     return -1;
5101 }
5102
5103 /* Returns name corresponding to the 'enum ofputil_action_code',
5104  * or "Unkonwn action", if the name is not available. */
5105 const char *
5106 ofputil_action_name_from_code(enum ofputil_action_code code)
5107 {
5108     return code < (int)OFPUTIL_N_ACTIONS && names[code] ? names[code]
5109         : "Unknown action";
5110 }
5111
5112 /* Appends an action of the type specified by 'code' to 'buf' and returns the
5113  * action.  Initializes the parts of 'action' that identify it as having type
5114  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
5115  * have variable length, the length used and cleared is that of struct
5116  * <STRUCT>.  */
5117 void *
5118 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
5119 {
5120     switch (code) {
5121     case OFPUTIL_ACTION_INVALID:
5122         NOT_REACHED();
5123
5124 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                  \
5125     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5126 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)      \
5127     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5128 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
5129     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5130 #include "ofp-util.def"
5131     }
5132     NOT_REACHED();
5133 }
5134
5135 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
5136     void                                                        \
5137     ofputil_init_##ENUM(struct STRUCT *s)                       \
5138     {                                                           \
5139         memset(s, 0, sizeof *s);                                \
5140         s->type = htons(ENUM);                                  \
5141         s->len = htons(sizeof *s);                              \
5142     }                                                           \
5143                                                                 \
5144     struct STRUCT *                                             \
5145     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
5146     {                                                           \
5147         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
5148         ofputil_init_##ENUM(s);                                 \
5149         return s;                                               \
5150     }
5151 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5152     OFPAT10_ACTION(ENUM, STRUCT, NAME)
5153 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
5154     void                                                        \
5155     ofputil_init_##ENUM(struct STRUCT *s)                       \
5156     {                                                           \
5157         memset(s, 0, sizeof *s);                                \
5158         s->type = htons(OFPAT10_VENDOR);                        \
5159         s->len = htons(sizeof *s);                              \
5160         s->vendor = htonl(NX_VENDOR_ID);                        \
5161         s->subtype = htons(ENUM);                               \
5162     }                                                           \
5163                                                                 \
5164     struct STRUCT *                                             \
5165     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
5166     {                                                           \
5167         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
5168         ofputil_init_##ENUM(s);                                 \
5169         return s;                                               \
5170     }
5171 #include "ofp-util.def"
5172
5173 static void
5174 ofputil_normalize_match__(struct match *match, bool may_log)
5175 {
5176     enum {
5177         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
5178         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
5179         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
5180         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
5181         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
5182         MAY_ARP_THA     = 1 << 5, /* arp_tha */
5183         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
5184         MAY_ND_TARGET   = 1 << 7, /* nd_target */
5185         MAY_MPLS        = 1 << 8, /* mpls label and tc */
5186     } may_match;
5187
5188     struct flow_wildcards wc;
5189
5190     /* Figure out what fields may be matched. */
5191     if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
5192         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
5193         if (match->flow.nw_proto == IPPROTO_TCP ||
5194             match->flow.nw_proto == IPPROTO_UDP ||
5195             match->flow.nw_proto == IPPROTO_SCTP ||
5196             match->flow.nw_proto == IPPROTO_ICMP) {
5197             may_match |= MAY_TP_ADDR;
5198         }
5199     } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
5200         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
5201         if (match->flow.nw_proto == IPPROTO_TCP ||
5202             match->flow.nw_proto == IPPROTO_UDP ||
5203             match->flow.nw_proto == IPPROTO_SCTP) {
5204             may_match |= MAY_TP_ADDR;
5205         } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
5206             may_match |= MAY_TP_ADDR;
5207             if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
5208                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
5209             } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
5210                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
5211             }
5212         }
5213     } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
5214                match->flow.dl_type == htons(ETH_TYPE_RARP)) {
5215         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
5216     } else if (eth_type_mpls(match->flow.dl_type)) {
5217         may_match = MAY_MPLS;
5218     } else {
5219         may_match = 0;
5220     }
5221
5222     /* Clear the fields that may not be matched. */
5223     wc = match->wc;
5224     if (!(may_match & MAY_NW_ADDR)) {
5225         wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
5226     }
5227     if (!(may_match & MAY_TP_ADDR)) {
5228         wc.masks.tp_src = wc.masks.tp_dst = htons(0);
5229     }
5230     if (!(may_match & MAY_NW_PROTO)) {
5231         wc.masks.nw_proto = 0;
5232     }
5233     if (!(may_match & MAY_IPVx)) {
5234         wc.masks.nw_tos = 0;
5235         wc.masks.nw_ttl = 0;
5236     }
5237     if (!(may_match & MAY_ARP_SHA)) {
5238         memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
5239     }
5240     if (!(may_match & MAY_ARP_THA)) {
5241         memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
5242     }
5243     if (!(may_match & MAY_IPV6)) {
5244         wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
5245         wc.masks.ipv6_label = htonl(0);
5246     }
5247     if (!(may_match & MAY_ND_TARGET)) {
5248         wc.masks.nd_target = in6addr_any;
5249     }
5250     if (!(may_match & MAY_MPLS)) {
5251         wc.masks.mpls_lse = htonl(0);
5252     }
5253
5254     /* Log any changes. */
5255     if (!flow_wildcards_equal(&wc, &match->wc)) {
5256         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
5257         char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
5258
5259         match->wc = wc;
5260         match_zero_wildcarded_fields(match);
5261
5262         if (log) {
5263             char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
5264             VLOG_INFO("normalization changed ofp_match, details:");
5265             VLOG_INFO(" pre: %s", pre);
5266             VLOG_INFO("post: %s", post);
5267             free(pre);
5268             free(post);
5269         }
5270     }
5271 }
5272
5273 /* "Normalizes" the wildcards in 'match'.  That means:
5274  *
5275  *    1. If the type of level N is known, then only the valid fields for that
5276  *       level may be specified.  For example, ARP does not have a TOS field,
5277  *       so nw_tos must be wildcarded if 'match' specifies an ARP flow.
5278  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
5279  *       ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
5280  *       IPv4 flow.
5281  *
5282  *    2. If the type of level N is not known (or not understood by Open
5283  *       vSwitch), then no fields at all for that level may be specified.  For
5284  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
5285  *       L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
5286  *       SCTP flow.
5287  *
5288  * If this function changes 'match', it logs a rate-limited informational
5289  * message. */
5290 void
5291 ofputil_normalize_match(struct match *match)
5292 {
5293     ofputil_normalize_match__(match, true);
5294 }
5295
5296 /* Same as ofputil_normalize_match() without the logging.  Thus, this function
5297  * is suitable for a program's internal use, whereas ofputil_normalize_match()
5298  * sense for use on flows received from elsewhere (so that a bug in the program
5299  * that sent them can be reported and corrected). */
5300 void
5301 ofputil_normalize_match_quiet(struct match *match)
5302 {
5303     ofputil_normalize_match__(match, false);
5304 }
5305
5306 /* Parses a key or a key-value pair from '*stringp'.
5307  *
5308  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
5309  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
5310  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
5311  * are substrings of '*stringp' created by replacing some of its bytes by null
5312  * terminators.  Returns true.
5313  *
5314  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
5315  * NULL and returns false. */
5316 bool
5317 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
5318 {
5319     char *pos, *key, *value;
5320     size_t key_len;
5321
5322     pos = *stringp;
5323     pos += strspn(pos, ", \t\r\n");
5324     if (*pos == '\0') {
5325         *keyp = *valuep = NULL;
5326         return false;
5327     }
5328
5329     key = pos;
5330     key_len = strcspn(pos, ":=(, \t\r\n");
5331     if (key[key_len] == ':' || key[key_len] == '=') {
5332         /* The value can be separated by a colon. */
5333         size_t value_len;
5334
5335         value = key + key_len + 1;
5336         value_len = strcspn(value, ", \t\r\n");
5337         pos = value + value_len + (value[value_len] != '\0');
5338         value[value_len] = '\0';
5339     } else if (key[key_len] == '(') {
5340         /* The value can be surrounded by balanced parentheses.  The outermost
5341          * set of parentheses is removed. */
5342         int level = 1;
5343         size_t value_len;
5344
5345         value = key + key_len + 1;
5346         for (value_len = 0; level > 0; value_len++) {
5347             switch (value[value_len]) {
5348             case '\0':
5349                 level = 0;
5350                 break;
5351
5352             case '(':
5353                 level++;
5354                 break;
5355
5356             case ')':
5357                 level--;
5358                 break;
5359             }
5360         }
5361         value[value_len - 1] = '\0';
5362         pos = value + value_len;
5363     } else {
5364         /* There might be no value at all. */
5365         value = key + key_len;  /* Will become the empty string below. */
5366         pos = key + key_len + (key[key_len] != '\0');
5367     }
5368     key[key_len] = '\0';
5369
5370     *stringp = pos;
5371     *keyp = key;
5372     *valuep = value;
5373     return true;
5374 }
5375
5376 /* Encode a dump ports request for 'port', the encoded message
5377  * will be for Open Flow version 'ofp_version'. Returns message
5378  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5379 struct ofpbuf *
5380 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
5381 {
5382     struct ofpbuf *request;
5383
5384     switch (ofp_version) {
5385     case OFP10_VERSION: {
5386         struct ofp10_port_stats_request *req;
5387         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
5388         req = ofpbuf_put_zeros(request, sizeof *req);
5389         req->port_no = htons(ofp_to_u16(port));
5390         break;
5391     }
5392     case OFP11_VERSION:
5393     case OFP12_VERSION:
5394     case OFP13_VERSION: {
5395         struct ofp11_port_stats_request *req;
5396         request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
5397         req = ofpbuf_put_zeros(request, sizeof *req);
5398         req->port_no = ofputil_port_to_ofp11(port);
5399         break;
5400     }
5401     default:
5402         NOT_REACHED();
5403     }
5404
5405     return request;
5406 }
5407
5408 static void
5409 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
5410                             struct ofp10_port_stats *ps10)
5411 {
5412     ps10->port_no = htons(ofp_to_u16(ops->port_no));
5413     memset(ps10->pad, 0, sizeof ps10->pad);
5414     put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
5415     put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
5416     put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
5417     put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
5418     put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
5419     put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
5420     put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
5421     put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
5422     put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
5423     put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
5424     put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
5425     put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
5426 }
5427
5428 static void
5429 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
5430                             struct ofp11_port_stats *ps11)
5431 {
5432     ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
5433     memset(ps11->pad, 0, sizeof ps11->pad);
5434     ps11->rx_packets = htonll(ops->stats.rx_packets);
5435     ps11->tx_packets = htonll(ops->stats.tx_packets);
5436     ps11->rx_bytes = htonll(ops->stats.rx_bytes);
5437     ps11->tx_bytes = htonll(ops->stats.tx_bytes);
5438     ps11->rx_dropped = htonll(ops->stats.rx_dropped);
5439     ps11->tx_dropped = htonll(ops->stats.tx_dropped);
5440     ps11->rx_errors = htonll(ops->stats.rx_errors);
5441     ps11->tx_errors = htonll(ops->stats.tx_errors);
5442     ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
5443     ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
5444     ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
5445     ps11->collisions = htonll(ops->stats.collisions);
5446 }
5447
5448 static void
5449 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
5450                             struct ofp13_port_stats *ps13)
5451 {
5452     ofputil_port_stats_to_ofp11(ops, &ps13->ps);
5453     ps13->duration_sec = htonl(ops->duration_sec);
5454     ps13->duration_nsec = htonl(ops->duration_nsec);
5455 }
5456
5457
5458 /* Encode a ports stat for 'ops' and append it to 'replies'. */
5459 void
5460 ofputil_append_port_stat(struct list *replies,
5461                          const struct ofputil_port_stats *ops)
5462 {
5463     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5464     struct ofp_header *oh = msg->data;
5465
5466     switch ((enum ofp_version)oh->version) {
5467     case OFP13_VERSION: {
5468         struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5469         ofputil_port_stats_to_ofp13(ops, reply);
5470         break;
5471     }
5472     case OFP12_VERSION:
5473     case OFP11_VERSION: {
5474         struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5475         ofputil_port_stats_to_ofp11(ops, reply);
5476         break;
5477     }
5478
5479     case OFP10_VERSION: {
5480         struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5481         ofputil_port_stats_to_ofp10(ops, reply);
5482         break;
5483     }
5484
5485     default:
5486         NOT_REACHED();
5487     }
5488 }
5489
5490 static enum ofperr
5491 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5492                               const struct ofp10_port_stats *ps10)
5493 {
5494     memset(ops, 0, sizeof *ops);
5495
5496     ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5497     ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5498     ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5499     ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5500     ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5501     ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5502     ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5503     ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5504     ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5505     ops->stats.rx_frame_errors =
5506         ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5507     ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5508     ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5509     ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5510     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5511
5512     return 0;
5513 }
5514
5515 static enum ofperr
5516 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5517                               const struct ofp11_port_stats *ps11)
5518 {
5519     enum ofperr error;
5520
5521     memset(ops, 0, sizeof *ops);
5522     error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5523     if (error) {
5524         return error;
5525     }
5526
5527     ops->stats.rx_packets = ntohll(ps11->rx_packets);
5528     ops->stats.tx_packets = ntohll(ps11->tx_packets);
5529     ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5530     ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5531     ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5532     ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5533     ops->stats.rx_errors = ntohll(ps11->rx_errors);
5534     ops->stats.tx_errors = ntohll(ps11->tx_errors);
5535     ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5536     ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5537     ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5538     ops->stats.collisions = ntohll(ps11->collisions);
5539     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5540
5541     return 0;
5542 }
5543
5544 static enum ofperr
5545 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5546                               const struct ofp13_port_stats *ps13)
5547 {
5548     enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5549     if (!error) {
5550         ops->duration_sec = ntohl(ps13->duration_sec);
5551         ops->duration_nsec = ntohl(ps13->duration_nsec);
5552     }
5553     return error;
5554 }
5555
5556 static size_t
5557 ofputil_get_port_stats_size(enum ofp_version ofp_version)
5558 {
5559     switch (ofp_version) {
5560     case OFP10_VERSION:
5561         return sizeof(struct ofp10_port_stats);
5562     case OFP11_VERSION:
5563     case OFP12_VERSION:
5564         return sizeof(struct ofp11_port_stats);
5565     case OFP13_VERSION:
5566         return sizeof(struct ofp13_port_stats);
5567     default:
5568         NOT_REACHED();
5569     }
5570 }
5571
5572 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5573  * message 'oh'. */
5574 size_t
5575 ofputil_count_port_stats(const struct ofp_header *oh)
5576 {
5577     struct ofpbuf b;
5578
5579     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5580     ofpraw_pull_assert(&b);
5581
5582     return b.size / ofputil_get_port_stats_size(oh->version);
5583 }
5584
5585 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5586  * ofputil_port_stats in 'ps'.
5587  *
5588  * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5589  * message.  Calling this function multiple times for a single 'msg' iterates
5590  * through the replies.  The caller must initially leave 'msg''s layer pointers
5591  * null and not modify them between calls.
5592  *
5593  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5594  * otherwise a positive errno value. */
5595 int
5596 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5597 {
5598     enum ofperr error;
5599     enum ofpraw raw;
5600
5601     error = (msg->l2
5602              ? ofpraw_decode(&raw, msg->l2)
5603              : ofpraw_pull(&raw, msg));
5604     if (error) {
5605         return error;
5606     }
5607
5608     if (!msg->size) {
5609         return EOF;
5610     } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5611         const struct ofp13_port_stats *ps13;
5612
5613         ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5614         if (!ps13) {
5615             goto bad_len;
5616         }
5617         return ofputil_port_stats_from_ofp13(ps, ps13);
5618     } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5619         const struct ofp11_port_stats *ps11;
5620
5621         ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5622         if (!ps11) {
5623             goto bad_len;
5624         }
5625         return ofputil_port_stats_from_ofp11(ps, ps11);
5626     } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5627         const struct ofp10_port_stats *ps10;
5628
5629         ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5630         if (!ps10) {
5631             goto bad_len;
5632         }
5633         return ofputil_port_stats_from_ofp10(ps, ps10);
5634     } else {
5635         NOT_REACHED();
5636     }
5637
5638  bad_len:
5639     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
5640                  "bytes at end", msg->size);
5641     return OFPERR_OFPBRC_BAD_LEN;
5642 }
5643
5644 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5645  * port number and stores the latter in '*ofp10_port'.
5646  * Returns 0 if successful, otherwise an OFPERR_* number. */
5647 enum ofperr
5648 ofputil_decode_port_stats_request(const struct ofp_header *request,
5649                                   ofp_port_t *ofp10_port)
5650 {
5651     switch ((enum ofp_version)request->version) {
5652     case OFP13_VERSION:
5653     case OFP12_VERSION:
5654     case OFP11_VERSION: {
5655         const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5656         return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5657     }
5658
5659     case OFP10_VERSION: {
5660         const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5661         *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5662         return 0;
5663     }
5664
5665     default:
5666         NOT_REACHED();
5667     }
5668 }
5669
5670 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
5671 void
5672 ofputil_bucket_list_destroy(struct list *buckets)
5673 {
5674     struct ofputil_bucket *bucket, *next_bucket;
5675
5676     LIST_FOR_EACH_SAFE (bucket, next_bucket, list_node, buckets) {
5677         list_remove(&bucket->list_node);
5678         free(bucket->ofpacts);
5679         free(bucket);
5680     }
5681 }
5682
5683 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
5684  * that requests stats for group 'group_id'.  (Use OFPG_ALL to request stats
5685  * for all groups.)
5686  *
5687  * Group statistics include packet and byte counts for each group. */
5688 struct ofpbuf *
5689 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
5690                                    uint32_t group_id)
5691 {
5692     struct ofpbuf *request;
5693
5694     switch (ofp_version) {
5695     case OFP10_VERSION:
5696         ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
5697                      "(\'-O OpenFlow11\')");
5698     case OFP11_VERSION:
5699     case OFP12_VERSION:
5700     case OFP13_VERSION: {
5701         struct ofp11_group_stats_request *req;
5702         request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
5703         req = ofpbuf_put_zeros(request, sizeof *req);
5704         req->group_id = htonl(group_id);
5705         break;
5706     }
5707     default:
5708         NOT_REACHED();
5709     }
5710
5711     return request;
5712 }
5713
5714 /* Returns an OpenFlow group description request for OpenFlow version
5715  * 'ofp_version', that requests stats for group 'group_id'.  (Use OFPG_ALL to
5716  * request stats for all groups.)
5717  *
5718  * Group descriptions include the bucket and action configuration for each
5719  * group. */
5720 struct ofpbuf *
5721 ofputil_encode_group_desc_request(enum ofp_version ofp_version)
5722 {
5723     struct ofpbuf *request;
5724
5725     switch (ofp_version) {
5726     case OFP10_VERSION:
5727         ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
5728                      "(\'-O OpenFlow11\')");
5729     case OFP11_VERSION:
5730     case OFP12_VERSION:
5731     case OFP13_VERSION: {
5732         request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST, ofp_version, 0);
5733         break;
5734     }
5735     default:
5736         NOT_REACHED();
5737     }
5738
5739     return request;
5740 }
5741
5742 static void *
5743 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *ogs,
5744                              size_t base_len, struct list *replies)
5745 {
5746     struct ofp11_bucket_counter *bc11;
5747     struct ofp11_group_stats *gs11;
5748     size_t length;
5749     int i;
5750
5751     length = base_len + sizeof(struct ofp11_bucket_counter) * ogs->n_buckets;
5752
5753     gs11 = ofpmp_append(replies, length);
5754     memset(gs11, 0, base_len);
5755     gs11->length = htons(length);
5756     gs11->group_id = htonl(ogs->group_id);
5757     gs11->ref_count = htonl(ogs->ref_count);
5758     gs11->packet_count = htonll(ogs->packet_count);
5759     gs11->byte_count = htonll(ogs->byte_count);
5760
5761     bc11 = (void *) (((uint8_t *) gs11) + base_len);
5762     for (i = 0; i < ogs->n_buckets; i++) {
5763         const struct bucket_counter *obc = &ogs->bucket_stats[i];
5764
5765         bc11[i].packet_count = htonll(obc->packet_count);
5766         bc11[i].byte_count = htonll(obc->byte_count);
5767     }
5768
5769     return gs11;
5770 }
5771
5772 static void
5773 ofputil_append_of13_group_stats(const struct ofputil_group_stats *ogs,
5774                                 struct list *replies)
5775 {
5776     struct ofp13_group_stats *gs13;
5777
5778     gs13 = ofputil_group_stats_to_ofp11(ogs, sizeof *gs13, replies);
5779     gs13->duration_sec = htonl(ogs->duration_sec);
5780     gs13->duration_nsec = htonl(ogs->duration_nsec);
5781 }
5782
5783 /* Encodes 'ogs' properly for the format of the list of group statistics
5784  * replies already begun in 'replies' and appends it to the list.  'replies'
5785  * must have originally been initialized with ofpmp_init(). */
5786 void
5787 ofputil_append_group_stats(struct list *replies,
5788                            const struct ofputil_group_stats *ogs)
5789 {
5790     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5791     struct ofp_header *oh = msg->data;
5792
5793     switch ((enum ofp_version)oh->version) {
5794     case OFP11_VERSION:
5795     case OFP12_VERSION:
5796         ofputil_group_stats_to_ofp11(ogs, sizeof(struct ofp11_group_stats),
5797                                      replies);
5798         break;
5799
5800     case OFP13_VERSION:
5801         ofputil_append_of13_group_stats(ogs, replies);
5802         break;
5803
5804     case OFP10_VERSION:
5805     default:
5806         NOT_REACHED();
5807     }
5808 }
5809
5810 /* Returns an OpenFlow group features request for OpenFlow version
5811  * 'ofp_version'. */
5812 struct ofpbuf *
5813 ofputil_encode_group_features_request(enum ofp_version ofp_version)
5814 {
5815     struct ofpbuf *request = NULL;
5816
5817     switch (ofp_version) {
5818     case OFP10_VERSION:
5819     case OFP11_VERSION:
5820         ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
5821                      "(\'-O OpenFlow12\')");
5822     case OFP12_VERSION:
5823     case OFP13_VERSION: {
5824         request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
5825                                         ofp_version, 0);
5826         break;
5827     }
5828     default:
5829         NOT_REACHED();
5830     }
5831
5832     return request;
5833 }
5834
5835 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
5836  * group features request 'request'. */
5837 struct ofpbuf *
5838 ofputil_encode_group_features_reply(
5839     const struct ofputil_group_features *features,
5840     const struct ofp_header *request)
5841 {
5842     struct ofp12_group_features_stats *ogf;
5843     struct ofpbuf *reply;
5844
5845     reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
5846                              request->version, request->xid, 0);
5847     ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
5848     ogf->types = htonl(features->types);
5849     ogf->capabilities = htonl(features->capabilities);
5850     ogf->max_groups[0] = htonl(features->max_groups[0]);
5851     ogf->max_groups[1] = htonl(features->max_groups[1]);
5852     ogf->max_groups[2] = htonl(features->max_groups[2]);
5853     ogf->max_groups[3] = htonl(features->max_groups[3]);
5854     ogf->actions[0] = htonl(features->actions[0]);
5855     ogf->actions[1] = htonl(features->actions[1]);
5856     ogf->actions[2] = htonl(features->actions[2]);
5857     ogf->actions[3] = htonl(features->actions[3]);
5858
5859     return reply;
5860 }
5861
5862 /* Decodes group features reply 'oh' into 'features'. */
5863 void
5864 ofputil_decode_group_features_reply(const struct ofp_header *oh,
5865                                     struct ofputil_group_features *features)
5866 {
5867     const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
5868
5869     features->types = ntohl(ogf->types);
5870     features->capabilities = ntohl(ogf->capabilities);
5871     features->max_groups[0] = ntohl(ogf->max_groups[0]);
5872     features->max_groups[1] = ntohl(ogf->max_groups[1]);
5873     features->max_groups[2] = ntohl(ogf->max_groups[2]);
5874     features->max_groups[3] = ntohl(ogf->max_groups[3]);
5875     features->actions[0] = ntohl(ogf->actions[0]);
5876     features->actions[1] = ntohl(ogf->actions[1]);
5877     features->actions[2] = ntohl(ogf->actions[2]);
5878     features->actions[3] = ntohl(ogf->actions[3]);
5879 }
5880
5881 /* Parse a group status request message into a 32 bit OpenFlow 1.1
5882  * group ID and stores the latter in '*group_id'.
5883  * Returns 0 if successful, otherwise an OFPERR_* number. */
5884 enum ofperr
5885 ofputil_decode_group_stats_request(const struct ofp_header *request,
5886                                    uint32_t *group_id)
5887 {
5888     const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
5889     *group_id = ntohl(gsr11->group_id);
5890     return 0;
5891 }
5892
5893 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
5894  * in 'gs'.  Assigns freshly allocated memory to gs->bucket_stats for the
5895  * caller to eventually free.
5896  *
5897  * Multiple group stats replies can be packed into a single OpenFlow message.
5898  * Calling this function multiple times for a single 'msg' iterates through the
5899  * replies.  The caller must initially leave 'msg''s layer pointers null and
5900  * not modify them between calls.
5901  *
5902  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5903  * otherwise a positive errno value. */
5904 int
5905 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
5906                                  struct ofputil_group_stats *gs)
5907 {
5908     struct ofp11_bucket_counter *obc;
5909     struct ofp11_group_stats *ogs11;
5910     enum ofpraw raw;
5911     enum ofperr error;
5912     size_t base_len;
5913     size_t length;
5914     size_t i;
5915
5916     gs->bucket_stats = NULL;
5917     error = (msg->l2
5918              ? ofpraw_decode(&raw, msg->l2)
5919              : ofpraw_pull(&raw, msg));
5920     if (error) {
5921         return error;
5922     }
5923
5924     if (!msg->size) {
5925         return EOF;
5926     }
5927
5928     if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
5929         base_len = sizeof *ogs11;
5930         ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
5931         gs->duration_sec = gs->duration_nsec = UINT32_MAX;
5932     } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
5933         struct ofp13_group_stats *ogs13;
5934
5935         base_len = sizeof *ogs13;
5936         ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
5937         if (ogs13) {
5938             ogs11 = &ogs13->gs;
5939             gs->duration_sec = ntohl(ogs13->duration_sec);
5940             gs->duration_nsec = ntohl(ogs13->duration_nsec);
5941         } else {
5942             ogs11 = NULL;
5943         }
5944     } else {
5945         NOT_REACHED();
5946     }
5947
5948     if (!ogs11) {
5949         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %zu leftover bytes at end",
5950                      ofpraw_get_name(raw), msg->size);
5951         return OFPERR_OFPBRC_BAD_LEN;
5952     }
5953     length = ntohs(ogs11->length);
5954     if (length < sizeof base_len) {
5955         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %zu",
5956                      ofpraw_get_name(raw), length);
5957         return OFPERR_OFPBRC_BAD_LEN;
5958     }
5959
5960     gs->group_id = ntohl(ogs11->group_id);
5961     gs->ref_count = ntohl(ogs11->ref_count);
5962     gs->packet_count = ntohll(ogs11->packet_count);
5963     gs->byte_count = ntohll(ogs11->byte_count);
5964
5965     gs->n_buckets = (length - base_len) / sizeof *obc;
5966     obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
5967     if (!obc) {
5968         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %zu leftover bytes at end",
5969                      ofpraw_get_name(raw), msg->size);
5970         return OFPERR_OFPBRC_BAD_LEN;
5971     }
5972
5973     gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
5974     for (i = 0; i < gs->n_buckets; i++) {
5975         gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
5976         gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
5977     }
5978
5979     return 0;
5980 }
5981
5982 /* Appends a group stats reply that contains the data in 'gds' to those already
5983  * present in the list of ofpbufs in 'replies'.  'replies' should have been
5984  * initialized with ofpmp_init(). */
5985 void
5986 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
5987                                 struct list *buckets,
5988                                 struct list *replies)
5989 {
5990     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
5991     struct ofp11_group_desc_stats *ogds;
5992     struct ofputil_bucket *bucket;
5993     size_t start_ogds;
5994     enum ofp_version version = ((struct ofp_header *)reply->data)->version;
5995
5996     start_ogds = reply->size;
5997     ofpbuf_put_zeros(reply, sizeof *ogds);
5998     LIST_FOR_EACH (bucket, list_node, buckets) {
5999         struct ofp11_bucket *ob;
6000         size_t start_ob;
6001
6002         start_ob = reply->size;
6003         ofpbuf_put_zeros(reply, sizeof *ob);
6004         ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
6005                                      reply, version);
6006         ob = ofpbuf_at_assert(reply, start_ob, sizeof *ob);
6007         ob->len = htons(reply->size - start_ob);
6008         ob->weight = htons(bucket->weight);
6009         ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
6010         ob->watch_group = htonl(bucket->watch_group);
6011     }
6012     ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
6013     ogds->length = htons(reply->size - start_ogds);
6014     ogds->type = gds->type;
6015     ogds->group_id = htonl(gds->group_id);
6016
6017     ofpmp_postappend(replies, start_ogds);
6018 }
6019
6020 static enum ofperr
6021 ofputil_pull_buckets(struct ofpbuf *msg, size_t buckets_length,
6022                      enum ofp_version version, struct list *buckets)
6023 {
6024     struct ofp11_bucket *ob;
6025
6026     list_init(buckets);
6027     while (buckets_length > 0) {
6028         struct ofputil_bucket *bucket;
6029         struct ofpbuf ofpacts;
6030         enum ofperr error;
6031         size_t ob_len;
6032
6033         ob = (buckets_length >= sizeof *ob
6034               ? ofpbuf_try_pull(msg, sizeof *ob)
6035               : NULL);
6036         if (!ob) {
6037             VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %zu leftover bytes",
6038                          buckets_length);
6039         }
6040
6041         ob_len = ntohs(ob->len);
6042         if (ob_len < sizeof *ob) {
6043             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
6044                          "%zu is not valid", ob_len);
6045             return OFPERR_OFPGMFC_BAD_BUCKET;
6046         } else if (ob_len > buckets_length) {
6047             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
6048                          "%zu exceeds remaining buckets data size %zu",
6049                          ob_len, buckets_length);
6050             return OFPERR_OFPGMFC_BAD_BUCKET;
6051         }
6052         buckets_length -= ob_len;
6053
6054         ofpbuf_init(&ofpacts, 0);
6055         error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
6056                                               version, &ofpacts);
6057         if (error) {
6058             ofpbuf_uninit(&ofpacts);
6059             ofputil_bucket_list_destroy(buckets);
6060             return error;
6061         }
6062
6063         bucket = xzalloc(sizeof *bucket);
6064         bucket->weight = ntohs(ob->weight);
6065         error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
6066         if (error) {
6067             ofpbuf_uninit(&ofpacts);
6068             ofputil_bucket_list_destroy(buckets);
6069             return OFPERR_OFPGMFC_BAD_WATCH;
6070         }
6071         bucket->watch_group = ntohl(ob->watch_group);
6072         bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
6073         bucket->ofpacts_len = ofpacts.size;
6074         list_push_back(buckets, &bucket->list_node);
6075     }
6076
6077     return 0;
6078 }
6079
6080 /* Converts a group description reply in 'msg' into an abstract
6081  * ofputil_group_desc in 'gd'.
6082  *
6083  * Multiple group description replies can be packed into a single OpenFlow
6084  * message.  Calling this function multiple times for a single 'msg' iterates
6085  * through the replies.  The caller must initially leave 'msg''s layer pointers
6086  * null and not modify them between calls.
6087  *
6088  * Returns 0 if successful, EOF if no replies were left in this 'msg',
6089  * otherwise a positive errno value. */
6090 int
6091 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
6092                                 struct ofpbuf *msg, enum ofp_version version)
6093 {
6094     struct ofp11_group_desc_stats *ogds;
6095     size_t length;
6096
6097     if (!msg->l2) {
6098         ofpraw_pull_assert(msg);
6099     }
6100
6101     if (!msg->size) {
6102         return EOF;
6103     }
6104
6105     ogds = ofpbuf_try_pull(msg, sizeof *ogds);
6106     if (!ogds) {
6107         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %zu "
6108                      "leftover bytes at end", msg->size);
6109         return OFPERR_OFPBRC_BAD_LEN;
6110     }
6111     gd->type = ogds->type;
6112     gd->group_id = ntohl(ogds->group_id);
6113
6114     length = ntohs(ogds->length);
6115     if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
6116         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
6117                      "length %zu", length);
6118         return OFPERR_OFPBRC_BAD_LEN;
6119     }
6120
6121     return ofputil_pull_buckets(msg, length - sizeof *ogds, version,
6122                                 &gd->buckets);
6123 }
6124
6125 /* Converts abstract group mod 'gm' into a message for OpenFlow version
6126  * 'ofp_version' and returns the message. */
6127 struct ofpbuf *
6128 ofputil_encode_group_mod(enum ofp_version ofp_version,
6129                          const struct ofputil_group_mod *gm)
6130 {
6131     struct ofpbuf *b;
6132     struct ofp11_group_mod *ogm;
6133     size_t start_ogm;
6134     size_t start_bucket;
6135     struct ofputil_bucket *bucket;
6136     struct ofp11_bucket *ob;
6137
6138     switch (ofp_version) {
6139     case OFP10_VERSION: {
6140         if (gm->command == OFPGC11_ADD) {
6141             ovs_fatal(0, "add-group needs OpenFlow 1.1 or later "
6142                          "(\'-O OpenFlow11\')");
6143         } else if (gm->command == OFPGC11_MODIFY) {
6144             ovs_fatal(0, "mod-group needs OpenFlow 1.1 or later "
6145                          "(\'-O OpenFlow11\')");
6146         } else {
6147             ovs_fatal(0, "del-groups needs OpenFlow 1.1 or later "
6148                          "(\'-O OpenFlow11\')");
6149         }
6150     }
6151
6152     case OFP11_VERSION:
6153     case OFP12_VERSION:
6154     case OFP13_VERSION: {
6155         b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
6156         start_ogm = b->size;
6157         ofpbuf_put_uninit(b, sizeof *ogm);
6158
6159         LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
6160             start_bucket = b->size;
6161             ofpbuf_put_uninit(b, sizeof *ob);
6162             if (bucket->ofpacts && bucket->ofpacts_len) {
6163                 ofpacts_put_openflow_actions(bucket->ofpacts,
6164                                              bucket->ofpacts_len, b,
6165                                              ofp_version);
6166             }
6167             ob = ofpbuf_at_assert(b, start_bucket, sizeof *ob);
6168             ob->len = htons(b->size - start_bucket);;
6169             ob->weight = htons(bucket->weight);
6170             ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
6171             ob->watch_group = htonl(bucket->watch_group);
6172         }
6173         ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
6174         ogm->command = htons(gm->command);
6175         ogm->type = gm->type;
6176         ogm->pad = 0;
6177         ogm->group_id = htonl(gm->group_id);
6178
6179         break;
6180     }
6181
6182     default:
6183         NOT_REACHED();
6184     }
6185
6186     return b;
6187 }
6188
6189 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
6190  * 'gm'.  Returns 0 if successful, otherwise an OpenFlow error code. */
6191 enum ofperr
6192 ofputil_decode_group_mod(const struct ofp_header *oh,
6193                          struct ofputil_group_mod *gm)
6194 {
6195     const struct ofp11_group_mod *ogm;
6196     struct ofpbuf msg;
6197
6198     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
6199     ofpraw_pull_assert(&msg);
6200
6201     ogm = ofpbuf_pull(&msg, sizeof *ogm);
6202     gm->command = ntohs(ogm->command);
6203     gm->type = ogm->type;
6204     gm->group_id = ntohl(ogm->group_id);
6205
6206     return ofputil_pull_buckets(&msg, msg.size, oh->version, &gm->buckets);
6207 }
6208
6209 /* Parse a queue status request message into 'oqsr'.
6210  * Returns 0 if successful, otherwise an OFPERR_* number. */
6211 enum ofperr
6212 ofputil_decode_queue_stats_request(const struct ofp_header *request,
6213                                    struct ofputil_queue_stats_request *oqsr)
6214 {
6215     switch ((enum ofp_version)request->version) {
6216     case OFP13_VERSION:
6217     case OFP12_VERSION:
6218     case OFP11_VERSION: {
6219         const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
6220         oqsr->queue_id = ntohl(qsr11->queue_id);
6221         return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
6222     }
6223
6224     case OFP10_VERSION: {
6225         const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
6226         oqsr->queue_id = ntohl(qsr10->queue_id);
6227         oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
6228         /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
6229         if (oqsr->port_no == OFPP_ALL) {
6230             oqsr->port_no = OFPP_ANY;
6231         }
6232         return 0;
6233     }
6234
6235     default:
6236         NOT_REACHED();
6237     }
6238 }
6239
6240 /* Encode a queue statsrequest for 'oqsr', the encoded message
6241  * will be fore Open Flow version 'ofp_version'. Returns message
6242  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6243 struct ofpbuf *
6244 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
6245                                    const struct ofputil_queue_stats_request *oqsr)
6246 {
6247     struct ofpbuf *request;
6248
6249     switch (ofp_version) {
6250     case OFP11_VERSION:
6251     case OFP12_VERSION:
6252     case OFP13_VERSION: {
6253         struct ofp11_queue_stats_request *req;
6254         request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
6255         req = ofpbuf_put_zeros(request, sizeof *req);
6256         req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
6257         req->queue_id = htonl(oqsr->queue_id);
6258         break;
6259     }
6260     case OFP10_VERSION: {
6261         struct ofp10_queue_stats_request *req;
6262         request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
6263         req = ofpbuf_put_zeros(request, sizeof *req);
6264         /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
6265         req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
6266                                         ? OFPP_ALL : oqsr->port_no));
6267         req->queue_id = htonl(oqsr->queue_id);
6268         break;
6269     }
6270     default:
6271         NOT_REACHED();
6272     }
6273
6274     return request;
6275 }
6276
6277 static size_t
6278 ofputil_get_queue_stats_size(enum ofp_version ofp_version)
6279 {
6280     switch (ofp_version) {
6281     case OFP10_VERSION:
6282         return sizeof(struct ofp10_queue_stats);
6283     case OFP11_VERSION:
6284     case OFP12_VERSION:
6285         return sizeof(struct ofp11_queue_stats);
6286     case OFP13_VERSION:
6287         return sizeof(struct ofp13_queue_stats);
6288     default:
6289         NOT_REACHED();
6290     }
6291 }
6292
6293 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
6294  * message 'oh'. */
6295 size_t
6296 ofputil_count_queue_stats(const struct ofp_header *oh)
6297 {
6298     struct ofpbuf b;
6299
6300     ofpbuf_use_const(&b, oh, ntohs(oh->length));
6301     ofpraw_pull_assert(&b);
6302
6303     return b.size / ofputil_get_queue_stats_size(oh->version);
6304 }
6305
6306 static enum ofperr
6307 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
6308                                const struct ofp10_queue_stats *qs10)
6309 {
6310     oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
6311     oqs->queue_id = ntohl(qs10->queue_id);
6312     oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
6313     oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
6314     oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
6315     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
6316
6317     return 0;
6318 }
6319
6320 static enum ofperr
6321 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
6322                                const struct ofp11_queue_stats *qs11)
6323 {
6324     enum ofperr error;
6325
6326     error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
6327     if (error) {
6328         return error;
6329     }
6330
6331     oqs->queue_id = ntohl(qs11->queue_id);
6332     oqs->tx_bytes = ntohll(qs11->tx_bytes);
6333     oqs->tx_packets = ntohll(qs11->tx_packets);
6334     oqs->tx_errors = ntohll(qs11->tx_errors);
6335     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
6336
6337     return 0;
6338 }
6339
6340 static enum ofperr
6341 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
6342                                const struct ofp13_queue_stats *qs13)
6343 {
6344     enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
6345     if (!error) {
6346         oqs->duration_sec = ntohl(qs13->duration_sec);
6347         oqs->duration_nsec = ntohl(qs13->duration_nsec);
6348     }
6349
6350     return error;
6351 }
6352
6353 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
6354  * ofputil_queue_stats in 'qs'.
6355  *
6356  * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
6357  * message.  Calling this function multiple times for a single 'msg' iterates
6358  * through the replies.  The caller must initially leave 'msg''s layer pointers
6359  * null and not modify them between calls.
6360  *
6361  * Returns 0 if successful, EOF if no replies were left in this 'msg',
6362  * otherwise a positive errno value. */
6363 int
6364 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
6365 {
6366     enum ofperr error;
6367     enum ofpraw raw;
6368
6369     error = (msg->l2
6370              ? ofpraw_decode(&raw, msg->l2)
6371              : ofpraw_pull(&raw, msg));
6372     if (error) {
6373         return error;
6374     }
6375
6376     if (!msg->size) {
6377         return EOF;
6378     } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
6379         const struct ofp13_queue_stats *qs13;
6380
6381         qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
6382         if (!qs13) {
6383             goto bad_len;
6384         }
6385         return ofputil_queue_stats_from_ofp13(qs, qs13);
6386     } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
6387         const struct ofp11_queue_stats *qs11;
6388
6389         qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
6390         if (!qs11) {
6391             goto bad_len;
6392         }
6393         return ofputil_queue_stats_from_ofp11(qs, qs11);
6394     } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
6395         const struct ofp10_queue_stats *qs10;
6396
6397         qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
6398         if (!qs10) {
6399             goto bad_len;
6400         }
6401         return ofputil_queue_stats_from_ofp10(qs, qs10);
6402     } else {
6403         NOT_REACHED();
6404     }
6405
6406  bad_len:
6407     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
6408                  "bytes at end", msg->size);
6409     return OFPERR_OFPBRC_BAD_LEN;
6410 }
6411
6412 static void
6413 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
6414                              struct ofp10_queue_stats *qs10)
6415 {
6416     qs10->port_no = htons(ofp_to_u16(oqs->port_no));
6417     memset(qs10->pad, 0, sizeof qs10->pad);
6418     qs10->queue_id = htonl(oqs->queue_id);
6419     put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
6420     put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
6421     put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
6422 }
6423
6424 static void
6425 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
6426                              struct ofp11_queue_stats *qs11)
6427 {
6428     qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
6429     qs11->queue_id = htonl(oqs->queue_id);
6430     qs11->tx_bytes = htonll(oqs->tx_bytes);
6431     qs11->tx_packets = htonll(oqs->tx_packets);
6432     qs11->tx_errors = htonll(oqs->tx_errors);
6433 }
6434
6435 static void
6436 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
6437                              struct ofp13_queue_stats *qs13)
6438 {
6439     ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
6440     if (oqs->duration_sec != UINT32_MAX) {
6441         qs13->duration_sec = htonl(oqs->duration_sec);
6442         qs13->duration_nsec = htonl(oqs->duration_nsec);
6443     } else {
6444         qs13->duration_sec = OVS_BE32_MAX;
6445         qs13->duration_nsec = OVS_BE32_MAX;
6446     }
6447 }
6448
6449 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
6450 void
6451 ofputil_append_queue_stat(struct list *replies,
6452                           const struct ofputil_queue_stats *oqs)
6453 {
6454     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
6455     struct ofp_header *oh = msg->data;
6456
6457     switch ((enum ofp_version)oh->version) {
6458     case OFP13_VERSION: {
6459         struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6460         ofputil_queue_stats_to_ofp13(oqs, reply);
6461         break;
6462     }
6463
6464     case OFP12_VERSION:
6465     case OFP11_VERSION: {
6466         struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6467         ofputil_queue_stats_to_ofp11(oqs, reply);
6468         break;
6469     }
6470
6471     case OFP10_VERSION: {
6472         struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
6473         ofputil_queue_stats_to_ofp10(oqs, reply);
6474         break;
6475     }
6476
6477     default:
6478         NOT_REACHED();
6479     }
6480 }