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