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