lib/ofp-util.c

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