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