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