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