lib/ofp-util.c

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