lib/ofp-util.c

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