lib/ofp-util.c

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