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