lib/ofp-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "id-pool.h"
  36 #include "ofp-actions.h"
  37 #include "ofp-errors.h"
  38 #include "ofp-msgs.h"
  39 #include "ofp-util.h"
  40 #include "ofpbuf.h"
  41 #include "openflow/netronome-ext.h"
  42 #include "packets.h"
  43 #include "random.h"
  44 #include "tun-metadata.h"
  45 #include "unaligned.h"
  46 #include "type-props.h"
  47 #include "openvswitch/vlog.h"
  48 #include "bitmap.h"
  49
  50 VLOG_DEFINE_THIS_MODULE(ofp_util);
  51
  52 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  53  * in the peer and so there's not much point in showing a lot of them. */
  54 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  55
  56 static enum ofputil_table_vacancy ofputil_decode_table_vacancy(
  57     ovs_be32 config, enum ofp_version);
  58 static enum ofputil_table_eviction ofputil_decode_table_eviction(
  59     ovs_be32 config, enum ofp_version);
  60 static ovs_be32 ofputil_encode_table_config(enum ofputil_table_miss,
  61                                             enum ofputil_table_eviction,
  62                                             enum ofputil_table_vacancy,
  63                                             enum ofp_version);
  64
  65 struct ofp_prop_header {
  66     ovs_be16 type;
  67     ovs_be16 len;
  68 };
  69
  70 struct ofp_prop_experimenter {
  71     ovs_be16 type;          /* OFP*_EXPERIMENTER. */
  72     ovs_be16 length;        /* Length in bytes of this property. */
  73     ovs_be32 experimenter;  /* Experimenter ID which takes the same form as
  74                              * in struct ofp_experimenter_header. */
  75     ovs_be32 exp_type;      /* Experimenter defined. */
  76 };
  77
  78 /* Pulls a property, beginning with struct ofp_prop_header, from the beginning
  79  * of 'msg'.  Stores the type of the property in '*typep' and, if 'property' is
  80  * nonnull, the entire property, including the header, in '*property'.  Returns
  81  * 0 if successful, otherwise an error code.
  82  *
  83  * This function pulls the property's stated size padded out to a multiple of
  84  * 'alignment' bytes.  The common case in OpenFlow is an 'alignment' of 8, so
  85  * you can use ofputil_pull_property() for that case. */
  86 static enum ofperr
  87 ofputil_pull_property__(struct ofpbuf *msg, struct ofpbuf *property,
  88                         unsigned int alignment, uint16_t *typep)
  89 {
  90     struct ofp_prop_header *oph;
  91     unsigned int padded_len;
  92     unsigned int len;
  93
  94     if (msg->size < sizeof *oph) {
  95         return OFPERR_OFPBPC_BAD_LEN;
  96     }
  97
  98     oph = msg->data;
  99     len = ntohs(oph->len);
 100     padded_len = ROUND_UP(len, alignment);
 101     if (len < sizeof *oph || padded_len > msg->size) {
 102         return OFPERR_OFPBPC_BAD_LEN;
 103     }
 104
 105     *typep = ntohs(oph->type);
 106     if (property) {
 107         ofpbuf_use_const(property, msg->data, len);
 108     }
 109     ofpbuf_pull(msg, padded_len);
 110     return 0;
 111 }
 112
 113 /* Pulls a property, beginning with struct ofp_prop_header, from the beginning
 114  * of 'msg'.  Stores the type of the property in '*typep' and, if 'property' is
 115  * nonnull, the entire property, including the header, in '*property'.  Returns
 116  * 0 if successful, otherwise an error code.
 117  *
 118  * This function pulls the property's stated size padded out to a multiple of
 119  * 8 bytes, which is the common case for OpenFlow properties. */
 120 static enum ofperr
 121 ofputil_pull_property(struct ofpbuf *msg, struct ofpbuf *property,
 122                       uint16_t *typep)
 123 {
 124     return ofputil_pull_property__(msg, property, 8, typep);
 125 }
 126
 127 static void OVS_PRINTF_FORMAT(2, 3)
 128 log_property(bool loose, const char *message, ...)
 129 {
 130     enum vlog_level level = loose ? VLL_DBG : VLL_WARN;
 131     if (!vlog_should_drop(THIS_MODULE, level, &bad_ofmsg_rl)) {
 132         va_list args;
 133
 134         va_start(args, message);
 135         vlog_valist(THIS_MODULE, level, message, args);
 136         va_end(args);
 137     }
 138 }
 139
 140 static enum ofperr
 141 ofputil_check_mask(uint16_t type, uint32_t mask)
 142 {
 143     switch (type) {
 144     case OFPACPT_PACKET_IN_SLAVE:
 145     case OFPACPT_PACKET_IN_MASTER:
 146         if (mask > MAXIMUM_MASK_PACKET_IN) {
 147             return OFPERR_OFPACFC_INVALID;
 148         }
 149         break;
 150
 151     case OFPACPT_FLOW_REMOVED_SLAVE:
 152     case OFPACPT_FLOW_REMOVED_MASTER:
 153         if (mask > MAXIMUM_MASK_FLOW_REMOVED) {
 154             return OFPERR_OFPACFC_INVALID;
 155         }
 156         break;
 157
 158     case OFPACPT_PORT_STATUS_SLAVE:
 159     case OFPACPT_PORT_STATUS_MASTER:
 160         if (mask > MAXIMUM_MASK_PORT_STATUS) {
 161             return OFPERR_OFPACFC_INVALID;
 162         }
 163         break;
 164
 165     case OFPACPT_ROLE_STATUS_SLAVE:
 166     case OFPACPT_ROLE_STATUS_MASTER:
 167         if (mask > MAXIMUM_MASK_ROLE_STATUS) {
 168             return OFPERR_OFPACFC_INVALID;
 169         }
 170         break;
 171
 172     case OFPACPT_TABLE_STATUS_SLAVE:
 173     case OFPACPT_TABLE_STATUS_MASTER:
 174         if ((mask < MINIMUM_MASK_TABLE_STATUS && mask != 0) |
 175             (mask > MAXIMUM_MASK_TABLE_STATUS)) {
 176             return OFPERR_OFPACFC_INVALID;
 177         }
 178         break;
 179
 180     case OFPACPT_REQUESTFORWARD_SLAVE:
 181     case OFPACPT_REQUESTFORWARD_MASTER:
 182         if (mask > MAXIMUM_MASK_REQUESTFORWARD) {
 183             return OFPERR_OFPACFC_INVALID;
 184         }
 185         break;
 186     }
 187     return 0;
 188 }
 189
 190 static size_t
 191 start_property(struct ofpbuf *msg, uint16_t type)
 192 {
 193     size_t start_ofs = msg->size;
 194     struct ofp_prop_header *oph;
 195
 196     oph = ofpbuf_put_uninit(msg, sizeof *oph);
 197     oph->type = htons(type);
 198     oph->len = htons(4);        /* May be updated later by end_property(). */
 199     return start_ofs;
 200 }
 201
 202 static void
 203 end_property(struct ofpbuf *msg, size_t start_ofs)
 204 {
 205     struct ofp_prop_header *oph;
 206
 207     oph = ofpbuf_at_assert(msg, start_ofs, sizeof *oph);
 208     oph->len = htons(msg->size - start_ofs);
 209     ofpbuf_padto(msg, ROUND_UP(msg->size, 8));
 210 }
 211
 212 static void
 213 put_bitmap_properties(struct ofpbuf *msg, uint64_t bitmap)
 214 {
 215     for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
 216         start_property(msg, rightmost_1bit_idx(bitmap));
 217     }
 218 }
 219
 220 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
 221  * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
 222  * is wildcarded.
 223  *
 224  * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
 225  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
 226  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
 227  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
 228  * wildcarded. */
 229 ovs_be32
 230 ofputil_wcbits_to_netmask(int wcbits)
 231 {
 232     wcbits &= 0x3f;
 233     return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
 234 }
 235
 236 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
 237  * that it wildcards, that is, the number of 0-bits in 'netmask', a number
 238  * between 0 and 32 inclusive.
 239  *
 240  * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
 241  * still be in the valid range but isn't otherwise meaningful. */
 242 int
 243 ofputil_netmask_to_wcbits(ovs_be32 netmask)
 244 {
 245     return 32 - ip_count_cidr_bits(netmask);
 246 }
 247
 248 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
 249  * flow_wildcards in 'wc' for use in struct match.  It is the caller's
 250  * responsibility to handle the special case where the flow match's dl_vlan is
 251  * set to OFP_VLAN_NONE. */
 252 void
 253 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
 254 {
 255     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
 256
 257     /* Initialize most of wc. */
 258     flow_wildcards_init_catchall(wc);
 259
 260     if (!(ofpfw & OFPFW10_IN_PORT)) {
 261         wc->masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
 262     }
 263
 264     if (!(ofpfw & OFPFW10_NW_TOS)) {
 265         wc->masks.nw_tos |= IP_DSCP_MASK;
 266     }
 267
 268     if (!(ofpfw & OFPFW10_NW_PROTO)) {
 269         wc->masks.nw_proto = UINT8_MAX;
 270     }
 271     wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
 272                                                  >> OFPFW10_NW_SRC_SHIFT);
 273     wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
 274                                                  >> OFPFW10_NW_DST_SHIFT);
 275
 276     if (!(ofpfw & OFPFW10_TP_SRC)) {
 277         wc->masks.tp_src = OVS_BE16_MAX;
 278     }
 279     if (!(ofpfw & OFPFW10_TP_DST)) {
 280         wc->masks.tp_dst = OVS_BE16_MAX;
 281     }
 282
 283     if (!(ofpfw & OFPFW10_DL_SRC)) {
 284         WC_MASK_FIELD(wc, dl_src);
 285     }
 286     if (!(ofpfw & OFPFW10_DL_DST)) {
 287         WC_MASK_FIELD(wc, dl_dst);
 288     }
 289     if (!(ofpfw & OFPFW10_DL_TYPE)) {
 290         wc->masks.dl_type = OVS_BE16_MAX;
 291     }
 292
 293     /* VLAN TCI mask. */
 294     if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
 295         wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
 296     }
 297     if (!(ofpfw & OFPFW10_DL_VLAN)) {
 298         wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 299     }
 300 }
 301
 302 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
 303 void
 304 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
 305                                struct match *match)
 306 {
 307     uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
 308
 309     /* Initialize match->wc. */
 310     memset(&match->flow, 0, sizeof match->flow);
 311     ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
 312
 313     /* Initialize most of match->flow. */
 314     match->flow.nw_src = ofmatch->nw_src;
 315     match->flow.nw_dst = ofmatch->nw_dst;
 316     match->flow.in_port.ofp_port = u16_to_ofp(ntohs(ofmatch->in_port));
 317     match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
 318     match->flow.tp_src = ofmatch->tp_src;
 319     match->flow.tp_dst = ofmatch->tp_dst;
 320     match->flow.dl_src = ofmatch->dl_src;
 321     match->flow.dl_dst = ofmatch->dl_dst;
 322     match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
 323     match->flow.nw_proto = ofmatch->nw_proto;
 324
 325     /* Translate VLANs. */
 326     if (!(ofpfw & OFPFW10_DL_VLAN) &&
 327         ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
 328         /* Match only packets without 802.1Q header.
 329          *
 330          * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
 331          *
 332          * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
 333          * because we can't have a specific PCP without an 802.1Q header.
 334          * However, older versions of OVS treated this as matching packets
 335          * withut an 802.1Q header, so we do here too. */
 336         match->flow.vlan_tci = htons(0);
 337         match->wc.masks.vlan_tci = htons(0xffff);
 338     } else {
 339         ovs_be16 vid, pcp, tci;
 340         uint16_t hpcp;
 341
 342         vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
 343         hpcp = (ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK;
 344         pcp = htons(hpcp);
 345         tci = vid | pcp | htons(VLAN_CFI);
 346         match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
 347     }
 348
 349     /* Clean up. */
 350     match_zero_wildcarded_fields(match);
 351 }
 352
 353 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
 354 void
 355 ofputil_match_to_ofp10_match(const struct match *match,
 356                              struct ofp10_match *ofmatch)
 357 {
 358     const struct flow_wildcards *wc = &match->wc;
 359     uint32_t ofpfw;
 360
 361     /* Figure out most OpenFlow wildcards. */
 362     ofpfw = 0;
 363     if (!wc->masks.in_port.ofp_port) {
 364         ofpfw |= OFPFW10_IN_PORT;
 365     }
 366     if (!wc->masks.dl_type) {
 367         ofpfw |= OFPFW10_DL_TYPE;
 368     }
 369     if (!wc->masks.nw_proto) {
 370         ofpfw |= OFPFW10_NW_PROTO;
 371     }
 372     ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
 373               << OFPFW10_NW_SRC_SHIFT);
 374     ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
 375               << OFPFW10_NW_DST_SHIFT);
 376     if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
 377         ofpfw |= OFPFW10_NW_TOS;
 378     }
 379     if (!wc->masks.tp_src) {
 380         ofpfw |= OFPFW10_TP_SRC;
 381     }
 382     if (!wc->masks.tp_dst) {
 383         ofpfw |= OFPFW10_TP_DST;
 384     }
 385     if (eth_addr_is_zero(wc->masks.dl_src)) {
 386         ofpfw |= OFPFW10_DL_SRC;
 387     }
 388     if (eth_addr_is_zero(wc->masks.dl_dst)) {
 389         ofpfw |= OFPFW10_DL_DST;
 390     }
 391
 392     /* Translate VLANs. */
 393     ofmatch->dl_vlan = htons(0);
 394     ofmatch->dl_vlan_pcp = 0;
 395     if (match->wc.masks.vlan_tci == htons(0)) {
 396         ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
 397     } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
 398                && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
 399         ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
 400     } else {
 401         if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
 402             ofpfw |= OFPFW10_DL_VLAN;
 403         } else {
 404             ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
 405         }
 406
 407         if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
 408             ofpfw |= OFPFW10_DL_VLAN_PCP;
 409         } else {
 410             ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
 411         }
 412     }
 413
 414     /* Compose most of the match structure. */
 415     ofmatch->wildcards = htonl(ofpfw);
 416     ofmatch->in_port = htons(ofp_to_u16(match->flow.in_port.ofp_port));
 417     ofmatch->dl_src = match->flow.dl_src;
 418     ofmatch->dl_dst = match->flow.dl_dst;
 419     ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
 420     ofmatch->nw_src = match->flow.nw_src;
 421     ofmatch->nw_dst = match->flow.nw_dst;
 422     ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
 423     ofmatch->nw_proto = match->flow.nw_proto;
 424     ofmatch->tp_src = match->flow.tp_src;
 425     ofmatch->tp_dst = match->flow.tp_dst;
 426     memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
 427     memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
 428 }
 429
 430 enum ofperr
 431 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
 432                          uint16_t *padded_match_len)
 433 {
 434     struct ofp11_match_header *omh = buf->data;
 435     uint16_t match_len;
 436
 437     if (buf->size < sizeof *omh) {
 438         return OFPERR_OFPBMC_BAD_LEN;
 439     }
 440
 441     match_len = ntohs(omh->length);
 442
 443     switch (ntohs(omh->type)) {
 444     case OFPMT_STANDARD: {
 445         struct ofp11_match *om;
 446
 447         if (match_len != sizeof *om || buf->size < sizeof *om) {
 448             return OFPERR_OFPBMC_BAD_LEN;
 449         }
 450         om = ofpbuf_pull(buf, sizeof *om);
 451         if (padded_match_len) {
 452             *padded_match_len = match_len;
 453         }
 454         return ofputil_match_from_ofp11_match(om, match);
 455     }
 456
 457     case OFPMT_OXM:
 458         if (padded_match_len) {
 459             *padded_match_len = ROUND_UP(match_len, 8);
 460         }
 461         return oxm_pull_match(buf, match);
 462
 463     default:
 464         return OFPERR_OFPBMC_BAD_TYPE;
 465     }
 466 }
 467
 468 /* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'.
 469  * Returns 0 if successful, otherwise an OFPERR_* value. */
 470 enum ofperr
 471 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
 472                                struct match *match)
 473 {
 474     uint16_t wc = ntohl(ofmatch->wildcards);
 475     bool ipv4, arp, rarp;
 476
 477     match_init_catchall(match);
 478
 479     if (!(wc & OFPFW11_IN_PORT)) {
 480         ofp_port_t ofp_port;
 481         enum ofperr error;
 482
 483         error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
 484         if (error) {
 485             return OFPERR_OFPBMC_BAD_VALUE;
 486         }
 487         match_set_in_port(match, ofp_port);
 488     }
 489
 490     match_set_dl_src_masked(match, ofmatch->dl_src,
 491                             eth_addr_invert(ofmatch->dl_src_mask));
 492     match_set_dl_dst_masked(match, ofmatch->dl_dst,
 493                             eth_addr_invert(ofmatch->dl_dst_mask));
 494
 495     if (!(wc & OFPFW11_DL_VLAN)) {
 496         if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
 497             /* Match only packets without a VLAN tag. */
 498             match->flow.vlan_tci = htons(0);
 499             match->wc.masks.vlan_tci = OVS_BE16_MAX;
 500         } else {
 501             if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
 502                 /* Match any packet with a VLAN tag regardless of VID. */
 503                 match->flow.vlan_tci = htons(VLAN_CFI);
 504                 match->wc.masks.vlan_tci = htons(VLAN_CFI);
 505             } else if (ntohs(ofmatch->dl_vlan) < 4096) {
 506                 /* Match only packets with the specified VLAN VID. */
 507                 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
 508                 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
 509             } else {
 510                 /* Invalid VID. */
 511                 return OFPERR_OFPBMC_BAD_VALUE;
 512             }
 513
 514             if (!(wc & OFPFW11_DL_VLAN_PCP)) {
 515                 if (ofmatch->dl_vlan_pcp <= 7) {
 516                     match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
 517                                                   << VLAN_PCP_SHIFT);
 518                     match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
 519                 } else {
 520                     /* Invalid PCP. */
 521                     return OFPERR_OFPBMC_BAD_VALUE;
 522                 }
 523             }
 524         }
 525     }
 526
 527     if (!(wc & OFPFW11_DL_TYPE)) {
 528         match_set_dl_type(match,
 529                           ofputil_dl_type_from_openflow(ofmatch->dl_type));
 530     }
 531
 532     ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
 533     arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
 534     rarp = match->flow.dl_type == htons(ETH_TYPE_RARP);
 535
 536     if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
 537         if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
 538             /* Invalid TOS. */
 539             return OFPERR_OFPBMC_BAD_VALUE;
 540         }
 541
 542         match_set_nw_dscp(match, ofmatch->nw_tos);
 543     }
 544
 545     if (ipv4 || arp || rarp) {
 546         if (!(wc & OFPFW11_NW_PROTO)) {
 547             match_set_nw_proto(match, ofmatch->nw_proto);
 548         }
 549         match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
 550         match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
 551     }
 552
 553 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
 554     if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
 555         switch (match->flow.nw_proto) {
 556         case IPPROTO_ICMP:
 557             /* "A.2.3 Flow Match Structures" in OF1.1 says:
 558              *
 559              *    The tp_src and tp_dst fields will be ignored unless the
 560              *    network protocol specified is as TCP, UDP or SCTP.
 561              *
 562              * but I'm pretty sure we should support ICMP too, otherwise
 563              * that's a regression from OF1.0. */
 564             if (!(wc & OFPFW11_TP_SRC)) {
 565                 uint16_t icmp_type = ntohs(ofmatch->tp_src);
 566                 if (icmp_type < 0x100) {
 567                     match_set_icmp_type(match, icmp_type);
 568                 } else {
 569                     return OFPERR_OFPBMC_BAD_FIELD;
 570                 }
 571             }
 572             if (!(wc & OFPFW11_TP_DST)) {
 573                 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
 574                 if (icmp_code < 0x100) {
 575                     match_set_icmp_code(match, icmp_code);
 576                 } else {
 577                     return OFPERR_OFPBMC_BAD_FIELD;
 578                 }
 579             }
 580             break;
 581
 582         case IPPROTO_TCP:
 583         case IPPROTO_UDP:
 584         case IPPROTO_SCTP:
 585             if (!(wc & (OFPFW11_TP_SRC))) {
 586                 match_set_tp_src(match, ofmatch->tp_src);
 587             }
 588             if (!(wc & (OFPFW11_TP_DST))) {
 589                 match_set_tp_dst(match, ofmatch->tp_dst);
 590             }
 591             break;
 592
 593         default:
 594             /* OF1.1 says explicitly to ignore this. */
 595             break;
 596         }
 597     }
 598
 599     if (eth_type_mpls(match->flow.dl_type)) {
 600         if (!(wc & OFPFW11_MPLS_LABEL)) {
 601             match_set_mpls_label(match, 0, ofmatch->mpls_label);
 602         }
 603         if (!(wc & OFPFW11_MPLS_TC)) {
 604             match_set_mpls_tc(match, 0, ofmatch->mpls_tc);
 605         }
 606     }
 607
 608     match_set_metadata_masked(match, ofmatch->metadata,
 609                               ~ofmatch->metadata_mask);
 610
 611     return 0;
 612 }
 613
 614 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
 615 void
 616 ofputil_match_to_ofp11_match(const struct match *match,
 617                              struct ofp11_match *ofmatch)
 618 {
 619     uint32_t wc = 0;
 620
 621     memset(ofmatch, 0, sizeof *ofmatch);
 622     ofmatch->omh.type = htons(OFPMT_STANDARD);
 623     ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
 624
 625     if (!match->wc.masks.in_port.ofp_port) {
 626         wc |= OFPFW11_IN_PORT;
 627     } else {
 628         ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port.ofp_port);
 629     }
 630
 631     ofmatch->dl_src = match->flow.dl_src;
 632     ofmatch->dl_src_mask = eth_addr_invert(match->wc.masks.dl_src);
 633     ofmatch->dl_dst = match->flow.dl_dst;
 634     ofmatch->dl_dst_mask = eth_addr_invert(match->wc.masks.dl_dst);
 635
 636     if (match->wc.masks.vlan_tci == htons(0)) {
 637         wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
 638     } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
 639                && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
 640         ofmatch->dl_vlan = htons(OFPVID11_NONE);
 641         wc |= OFPFW11_DL_VLAN_PCP;
 642     } else {
 643         if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
 644             ofmatch->dl_vlan = htons(OFPVID11_ANY);
 645         } else {
 646             ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
 647         }
 648
 649         if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
 650             wc |= OFPFW11_DL_VLAN_PCP;
 651         } else {
 652             ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
 653         }
 654     }
 655
 656     if (!match->wc.masks.dl_type) {
 657         wc |= OFPFW11_DL_TYPE;
 658     } else {
 659         ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
 660     }
 661
 662     if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
 663         wc |= OFPFW11_NW_TOS;
 664     } else {
 665         ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
 666     }
 667
 668     if (!match->wc.masks.nw_proto) {
 669         wc |= OFPFW11_NW_PROTO;
 670     } else {
 671         ofmatch->nw_proto = match->flow.nw_proto;
 672     }
 673
 674     ofmatch->nw_src = match->flow.nw_src;
 675     ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
 676     ofmatch->nw_dst = match->flow.nw_dst;
 677     ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
 678
 679     if (!match->wc.masks.tp_src) {
 680         wc |= OFPFW11_TP_SRC;
 681     } else {
 682         ofmatch->tp_src = match->flow.tp_src;
 683     }
 684
 685     if (!match->wc.masks.tp_dst) {
 686         wc |= OFPFW11_TP_DST;
 687     } else {
 688         ofmatch->tp_dst = match->flow.tp_dst;
 689     }
 690
 691     if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK))) {
 692         wc |= OFPFW11_MPLS_LABEL;
 693     } else {
 694         ofmatch->mpls_label = htonl(mpls_lse_to_label(
 695                                         match->flow.mpls_lse[0]));
 696     }
 697
 698     if (!(match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK))) {
 699         wc |= OFPFW11_MPLS_TC;
 700     } else {
 701         ofmatch->mpls_tc = mpls_lse_to_tc(match->flow.mpls_lse[0]);
 702     }
 703
 704     ofmatch->metadata = match->flow.metadata;
 705     ofmatch->metadata_mask = ~match->wc.masks.metadata;
 706
 707     ofmatch->wildcards = htonl(wc);
 708 }
 709
 710 /* Returns the "typical" length of a match for 'protocol', for use in
 711  * estimating space to preallocate. */
 712 int
 713 ofputil_match_typical_len(enum ofputil_protocol protocol)
 714 {
 715     switch (protocol) {
 716     case OFPUTIL_P_OF10_STD:
 717     case OFPUTIL_P_OF10_STD_TID:
 718         return sizeof(struct ofp10_match);
 719
 720     case OFPUTIL_P_OF10_NXM:
 721     case OFPUTIL_P_OF10_NXM_TID:
 722         return NXM_TYPICAL_LEN;
 723
 724     case OFPUTIL_P_OF11_STD:
 725         return sizeof(struct ofp11_match);
 726
 727     case OFPUTIL_P_OF12_OXM:
 728     case OFPUTIL_P_OF13_OXM:
 729     case OFPUTIL_P_OF14_OXM:
 730     case OFPUTIL_P_OF15_OXM:
 731         return NXM_TYPICAL_LEN;
 732
 733     default:
 734         OVS_NOT_REACHED();
 735     }
 736 }
 737
 738 /* Appends to 'b' an struct ofp11_match_header followed by a match that
 739  * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
 740  * data appended out to a multiple of 8.  'protocol' must be one that is usable
 741  * in OpenFlow 1.1 or later.
 742  *
 743  * This function can cause 'b''s data to be reallocated.
 744  *
 745  * Returns the number of bytes appended to 'b', excluding the padding.  Never
 746  * returns zero. */
 747 int
 748 ofputil_put_ofp11_match(struct ofpbuf *b, const struct match *match,
 749                         enum ofputil_protocol protocol)
 750 {
 751     switch (protocol) {
 752     case OFPUTIL_P_OF10_STD:
 753     case OFPUTIL_P_OF10_STD_TID:
 754     case OFPUTIL_P_OF10_NXM:
 755     case OFPUTIL_P_OF10_NXM_TID:
 756         OVS_NOT_REACHED();
 757
 758     case OFPUTIL_P_OF11_STD: {
 759         struct ofp11_match *om;
 760
 761         /* Make sure that no padding is needed. */
 762         BUILD_ASSERT_DECL(sizeof *om % 8 == 0);
 763
 764         om = ofpbuf_put_uninit(b, sizeof *om);
 765         ofputil_match_to_ofp11_match(match, om);
 766         return sizeof *om;
 767     }
 768
 769     case OFPUTIL_P_OF12_OXM:
 770     case OFPUTIL_P_OF13_OXM:
 771     case OFPUTIL_P_OF14_OXM:
 772     case OFPUTIL_P_OF15_OXM:
 773         return oxm_put_match(b, match,
 774                              ofputil_protocol_to_ofp_version(protocol));
 775     }
 776
 777     OVS_NOT_REACHED();
 778 }
 779
 780 /* Given a 'dl_type' value in the format used in struct flow, returns the
 781  * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
 782  * structure. */
 783 ovs_be16
 784 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
 785 {
 786     return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
 787             ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 788             : flow_dl_type);
 789 }
 790
 791 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
 792  * structure, returns the corresponding 'dl_type' value for use in struct
 793  * flow. */
 794 ovs_be16
 795 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
 796 {
 797     return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
 798             ? htons(FLOW_DL_TYPE_NONE)
 799             : ofp_dl_type);
 800 }
 801 \f
 802 /* Protocols. */
 803
 804 struct proto_abbrev {
 805     enum ofputil_protocol protocol;
 806     const char *name;
 807 };
 808
 809 /* Most users really don't care about some of the differences between
 810  * protocols.  These abbreviations help with that. */
 811 static const struct proto_abbrev proto_abbrevs[] = {
 812     { OFPUTIL_P_ANY,          "any" },
 813     { OFPUTIL_P_OF10_STD_ANY, "OpenFlow10" },
 814     { OFPUTIL_P_OF10_NXM_ANY, "NXM" },
 815     { OFPUTIL_P_ANY_OXM,      "OXM" },
 816 };
 817 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
 818
 819 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
 820     OFPUTIL_P_OF15_OXM,
 821     OFPUTIL_P_OF14_OXM,
 822     OFPUTIL_P_OF13_OXM,
 823     OFPUTIL_P_OF12_OXM,
 824     OFPUTIL_P_OF11_STD,
 825     OFPUTIL_P_OF10_NXM,
 826     OFPUTIL_P_OF10_STD,
 827 };
 828 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
 829
 830 /* Returns the set of ofputil_protocols that are supported with the given
 831  * OpenFlow 'version'.  'version' should normally be an 8-bit OpenFlow version
 832  * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1).  Returns 0
 833  * if 'version' is not supported or outside the valid range.  */
 834 enum ofputil_protocol
 835 ofputil_protocols_from_ofp_version(enum ofp_version version)
 836 {
 837     switch (version) {
 838     case OFP10_VERSION:
 839         return OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY;
 840     case OFP11_VERSION:
 841         return OFPUTIL_P_OF11_STD;
 842     case OFP12_VERSION:
 843         return OFPUTIL_P_OF12_OXM;
 844     case OFP13_VERSION:
 845         return OFPUTIL_P_OF13_OXM;
 846     case OFP14_VERSION:
 847         return OFPUTIL_P_OF14_OXM;
 848     case OFP15_VERSION:
 849         return OFPUTIL_P_OF15_OXM;
 850     default:
 851         return 0;
 852     }
 853 }
 854
 855 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
 856  * connection that has negotiated the given 'version'.  'version' should
 857  * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
 858  * 1.0, 0x02 for OpenFlow 1.1).  Returns 0 if 'version' is not supported or
 859  * outside the valid range.  */
 860 enum ofputil_protocol
 861 ofputil_protocol_from_ofp_version(enum ofp_version version)
 862 {
 863     return rightmost_1bit(ofputil_protocols_from_ofp_version(version));
 864 }
 865
 866 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
 867  * etc.) that corresponds to 'protocol'. */
 868 enum ofp_version
 869 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
 870 {
 871     switch (protocol) {
 872     case OFPUTIL_P_OF10_STD:
 873     case OFPUTIL_P_OF10_STD_TID:
 874     case OFPUTIL_P_OF10_NXM:
 875     case OFPUTIL_P_OF10_NXM_TID:
 876         return OFP10_VERSION;
 877     case OFPUTIL_P_OF11_STD:
 878         return OFP11_VERSION;
 879     case OFPUTIL_P_OF12_OXM:
 880         return OFP12_VERSION;
 881     case OFPUTIL_P_OF13_OXM:
 882         return OFP13_VERSION;
 883     case OFPUTIL_P_OF14_OXM:
 884         return OFP14_VERSION;
 885     case OFPUTIL_P_OF15_OXM:
 886         return OFP15_VERSION;
 887     }
 888
 889     OVS_NOT_REACHED();
 890 }
 891
 892 /* Returns a bitmap of OpenFlow versions that are supported by at
 893  * least one of the 'protocols'. */
 894 uint32_t
 895 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols)
 896 {
 897     uint32_t bitmap = 0;
 898
 899     for (; protocols; protocols = zero_rightmost_1bit(protocols)) {
 900         enum ofputil_protocol protocol = rightmost_1bit(protocols);
 901
 902         bitmap |= 1u << ofputil_protocol_to_ofp_version(protocol);
 903     }
 904
 905     return bitmap;
 906 }
 907
 908 /* Returns the set of protocols that are supported on top of the
 909  * OpenFlow versions included in 'bitmap'. */
 910 enum ofputil_protocol
 911 ofputil_protocols_from_version_bitmap(uint32_t bitmap)
 912 {
 913     enum ofputil_protocol protocols = 0;
 914
 915     for (; bitmap; bitmap = zero_rightmost_1bit(bitmap)) {
 916         enum ofp_version version = rightmost_1bit_idx(bitmap);
 917
 918         protocols |= ofputil_protocols_from_ofp_version(version);
 919     }
 920
 921     return protocols;
 922 }
 923
 924 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
 925  * otherwise. */
 926 bool
 927 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
 928 {
 929     return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
 930 }
 931
 932 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
 933  * extension turned on or off if 'enable' is true or false, respectively.
 934  *
 935  * This extension is only useful for protocols whose "standard" version does
 936  * not allow specific tables to be modified.  In particular, this is true of
 937  * OpenFlow 1.0.  In later versions of OpenFlow, a flow_mod request always
 938  * specifies a table ID and so there is no need for such an extension.  When
 939  * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
 940  * extension, this function just returns its 'protocol' argument unchanged
 941  * regardless of the value of 'enable'.  */
 942 enum ofputil_protocol
 943 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
 944 {
 945     switch (protocol) {
 946     case OFPUTIL_P_OF10_STD:
 947     case OFPUTIL_P_OF10_STD_TID:
 948         return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
 949
 950     case OFPUTIL_P_OF10_NXM:
 951     case OFPUTIL_P_OF10_NXM_TID:
 952         return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
 953
 954     case OFPUTIL_P_OF11_STD:
 955         return OFPUTIL_P_OF11_STD;
 956
 957     case OFPUTIL_P_OF12_OXM:
 958         return OFPUTIL_P_OF12_OXM;
 959
 960     case OFPUTIL_P_OF13_OXM:
 961         return OFPUTIL_P_OF13_OXM;
 962
 963     case OFPUTIL_P_OF14_OXM:
 964         return OFPUTIL_P_OF14_OXM;
 965
 966     case OFPUTIL_P_OF15_OXM:
 967         return OFPUTIL_P_OF15_OXM;
 968
 969     default:
 970         OVS_NOT_REACHED();
 971     }
 972 }
 973
 974 /* Returns the "base" version of 'protocol'.  That is, if 'protocol' includes
 975  * some extension to a standard protocol version, the return value is the
 976  * standard version of that protocol without any extension.  If 'protocol' is a
 977  * standard protocol version, returns 'protocol' unchanged. */
 978 enum ofputil_protocol
 979 ofputil_protocol_to_base(enum ofputil_protocol protocol)
 980 {
 981     return ofputil_protocol_set_tid(protocol, false);
 982 }
 983
 984 /* Returns 'new_base' with any extensions taken from 'cur'. */
 985 enum ofputil_protocol
 986 ofputil_protocol_set_base(enum ofputil_protocol cur,
 987                           enum ofputil_protocol new_base)
 988 {
 989     bool tid = (cur & OFPUTIL_P_TID) != 0;
 990
 991     switch (new_base) {
 992     case OFPUTIL_P_OF10_STD:
 993     case OFPUTIL_P_OF10_STD_TID:
 994         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
 995
 996     case OFPUTIL_P_OF10_NXM:
 997     case OFPUTIL_P_OF10_NXM_TID:
 998         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
 999
1000     case OFPUTIL_P_OF11_STD:
1001         return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD, tid);
1002
1003     case OFPUTIL_P_OF12_OXM:
1004         return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, tid);
1005
1006     case OFPUTIL_P_OF13_OXM:
1007         return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM, tid);
1008
1009     case OFPUTIL_P_OF14_OXM:
1010         return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM, tid);
1011
1012     case OFPUTIL_P_OF15_OXM:
1013         return ofputil_protocol_set_tid(OFPUTIL_P_OF15_OXM, tid);
1014
1015     default:
1016         OVS_NOT_REACHED();
1017     }
1018 }
1019
1020 /* Returns a string form of 'protocol', if a simple form exists (that is, if
1021  * 'protocol' is either a single protocol or it is a combination of protocols
1022  * that have a single abbreviation).  Otherwise, returns NULL. */
1023 const char *
1024 ofputil_protocol_to_string(enum ofputil_protocol protocol)
1025 {
1026     const struct proto_abbrev *p;
1027
1028     /* Use a "switch" statement for single-bit names so that we get a compiler
1029      * warning if we forget any. */
1030     switch (protocol) {
1031     case OFPUTIL_P_OF10_NXM:
1032         return "NXM-table_id";
1033
1034     case OFPUTIL_P_OF10_NXM_TID:
1035         return "NXM+table_id";
1036
1037     case OFPUTIL_P_OF10_STD:
1038         return "OpenFlow10-table_id";
1039
1040     case OFPUTIL_P_OF10_STD_TID:
1041         return "OpenFlow10+table_id";
1042
1043     case OFPUTIL_P_OF11_STD:
1044         return "OpenFlow11";
1045
1046     case OFPUTIL_P_OF12_OXM:
1047         return "OXM-OpenFlow12";
1048
1049     case OFPUTIL_P_OF13_OXM:
1050         return "OXM-OpenFlow13";
1051
1052     case OFPUTIL_P_OF14_OXM:
1053         return "OXM-OpenFlow14";
1054
1055     case OFPUTIL_P_OF15_OXM:
1056         return "OXM-OpenFlow15";
1057     }
1058
1059     /* Check abbreviations. */
1060     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1061         if (protocol == p->protocol) {
1062             return p->name;
1063         }
1064     }
1065
1066     return NULL;
1067 }
1068
1069 /* Returns a string that represents 'protocols'.  The return value might be a
1070  * comma-separated list if 'protocols' doesn't have a simple name.  The return
1071  * value is "none" if 'protocols' is 0.
1072  *
1073  * The caller must free the returned string (with free()). */
1074 char *
1075 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1076 {
1077     struct ds s;
1078
1079     ovs_assert(!(protocols & ~OFPUTIL_P_ANY));
1080     if (protocols == 0) {
1081         return xstrdup("none");
1082     }
1083
1084     ds_init(&s);
1085     while (protocols) {
1086         const struct proto_abbrev *p;
1087         int i;
1088
1089         if (s.length) {
1090             ds_put_char(&s, ',');
1091         }
1092
1093         for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1094             if ((protocols & p->protocol) == p->protocol) {
1095                 ds_put_cstr(&s, p->name);
1096                 protocols &= ~p->protocol;
1097                 goto match;
1098             }
1099         }
1100
1101         for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1102             enum ofputil_protocol bit = 1u << i;
1103
1104             if (protocols & bit) {
1105                 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1106                 protocols &= ~bit;
1107                 goto match;
1108             }
1109         }
1110         OVS_NOT_REACHED();
1111
1112     match: ;
1113     }
1114     return ds_steal_cstr(&s);
1115 }
1116
1117 static enum ofputil_protocol
1118 ofputil_protocol_from_string__(const char *s, size_t n)
1119 {
1120     const struct proto_abbrev *p;
1121     int i;
1122
1123     for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1124         enum ofputil_protocol bit = 1u << i;
1125         const char *name = ofputil_protocol_to_string(bit);
1126
1127         if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1128             return bit;
1129         }
1130     }
1131
1132     for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1133         if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1134             return p->protocol;
1135         }
1136     }
1137
1138     return 0;
1139 }
1140
1141 /* Returns the nonempty set of protocols represented by 's', which can be a
1142  * single protocol name or abbreviation or a comma-separated list of them.
1143  *
1144  * Aborts the program with an error message if 's' is invalid. */
1145 enum ofputil_protocol
1146 ofputil_protocols_from_string(const char *s)
1147 {
1148     const char *orig_s = s;
1149     enum ofputil_protocol protocols;
1150
1151     protocols = 0;
1152     while (*s) {
1153         enum ofputil_protocol p;
1154         size_t n;
1155
1156         n = strcspn(s, ",");
1157         if (n == 0) {
1158             s++;
1159             continue;
1160         }
1161
1162         p = ofputil_protocol_from_string__(s, n);
1163         if (!p) {
1164             ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1165         }
1166         protocols |= p;
1167
1168         s += n;
1169     }
1170
1171     if (!protocols) {
1172         ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1173     }
1174     return protocols;
1175 }
1176
1177 enum ofp_version
1178 ofputil_version_from_string(const char *s)
1179 {
1180     if (!strcasecmp(s, "OpenFlow10")) {
1181         return OFP10_VERSION;
1182     }
1183     if (!strcasecmp(s, "OpenFlow11")) {
1184         return OFP11_VERSION;
1185     }
1186     if (!strcasecmp(s, "OpenFlow12")) {
1187         return OFP12_VERSION;
1188     }
1189     if (!strcasecmp(s, "OpenFlow13")) {
1190         return OFP13_VERSION;
1191     }
1192     if (!strcasecmp(s, "OpenFlow14")) {
1193         return OFP14_VERSION;
1194     }
1195     if (!strcasecmp(s, "OpenFlow15")) {
1196         return OFP15_VERSION;
1197     }
1198     return 0;
1199 }
1200
1201 static bool
1202 is_delimiter(unsigned char c)
1203 {
1204     return isspace(c) || c == ',';
1205 }
1206
1207 uint32_t
1208 ofputil_versions_from_string(const char *s)
1209 {
1210     size_t i = 0;
1211     uint32_t bitmap = 0;
1212
1213     while (s[i]) {
1214         size_t j;
1215         int version;
1216         char *key;
1217
1218         if (is_delimiter(s[i])) {
1219             i++;
1220             continue;
1221         }
1222         j = 0;
1223         while (s[i + j] && !is_delimiter(s[i + j])) {
1224             j++;
1225         }
1226         key = xmemdup0(s + i, j);
1227         version = ofputil_version_from_string(key);
1228         if (!version) {
1229             VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key);
1230         }
1231         free(key);
1232         bitmap |= 1u << version;
1233         i += j;
1234     }
1235
1236     return bitmap;
1237 }
1238
1239 uint32_t
1240 ofputil_versions_from_strings(char ** const s, size_t count)
1241 {
1242     uint32_t bitmap = 0;
1243
1244     while (count--) {
1245         int version = ofputil_version_from_string(s[count]);
1246         if (!version) {
1247             VLOG_WARN("Unknown OpenFlow version: \"%s\"", s[count]);
1248         } else {
1249             bitmap |= 1u << version;
1250         }
1251     }
1252
1253     return bitmap;
1254 }
1255
1256 const char *
1257 ofputil_version_to_string(enum ofp_version ofp_version)
1258 {
1259     switch (ofp_version) {
1260     case OFP10_VERSION:
1261         return "OpenFlow10";
1262     case OFP11_VERSION:
1263         return "OpenFlow11";
1264     case OFP12_VERSION:
1265         return "OpenFlow12";
1266     case OFP13_VERSION:
1267         return "OpenFlow13";
1268     case OFP14_VERSION:
1269         return "OpenFlow14";
1270     case OFP15_VERSION:
1271         return "OpenFlow15";
1272     default:
1273         OVS_NOT_REACHED();
1274     }
1275 }
1276
1277 bool
1278 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1279 {
1280     switch (packet_in_format) {
1281     case NXPIF_OPENFLOW10:
1282     case NXPIF_NXM:
1283         return true;
1284     }
1285
1286     return false;
1287 }
1288
1289 const char *
1290 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1291 {
1292     switch (packet_in_format) {
1293     case NXPIF_OPENFLOW10:
1294         return "openflow10";
1295     case NXPIF_NXM:
1296         return "nxm";
1297     default:
1298         OVS_NOT_REACHED();
1299     }
1300 }
1301
1302 int
1303 ofputil_packet_in_format_from_string(const char *s)
1304 {
1305     return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1306             : !strcmp(s, "nxm") ? NXPIF_NXM
1307             : -1);
1308 }
1309
1310 void
1311 ofputil_format_version(struct ds *msg, enum ofp_version version)
1312 {
1313     ds_put_format(msg, "0x%02x", version);
1314 }
1315
1316 void
1317 ofputil_format_version_name(struct ds *msg, enum ofp_version version)
1318 {
1319     ds_put_cstr(msg, ofputil_version_to_string(version));
1320 }
1321
1322 static void
1323 ofputil_format_version_bitmap__(struct ds *msg, uint32_t bitmap,
1324                                 void (*format_version)(struct ds *msg,
1325                                                        enum ofp_version))
1326 {
1327     while (bitmap) {
1328         format_version(msg, raw_ctz(bitmap));
1329         bitmap = zero_rightmost_1bit(bitmap);
1330         if (bitmap) {
1331             ds_put_cstr(msg, ", ");
1332         }
1333     }
1334 }
1335
1336 void
1337 ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap)
1338 {
1339     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version);
1340 }
1341
1342 void
1343 ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap)
1344 {
1345     ofputil_format_version_bitmap__(msg, bitmap, ofputil_format_version_name);
1346 }
1347
1348 static bool
1349 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header *oheh,
1350                             uint32_t *allowed_versionsp)
1351 {
1352     uint16_t bitmap_len = ntohs(oheh->length) - sizeof *oheh;
1353     const ovs_be32 *bitmap = ALIGNED_CAST(const ovs_be32 *, oheh + 1);
1354     uint32_t allowed_versions;
1355
1356     if (!bitmap_len || bitmap_len % sizeof *bitmap) {
1357         return false;
1358     }
1359
1360     /* Only use the first 32-bit element of the bitmap as that is all the
1361      * current implementation supports.  Subsequent elements are ignored which
1362      * should have no effect on session negotiation until Open vSwitch supports
1363      * wire-protocol versions greater than 31.
1364      */
1365     allowed_versions = ntohl(bitmap[0]);
1366
1367     if (allowed_versions & 1) {
1368         /* There's no OpenFlow version 0. */
1369         VLOG_WARN_RL(&bad_ofmsg_rl, "peer claims to support invalid OpenFlow "
1370                      "version 0x00");
1371         allowed_versions &= ~1u;
1372     }
1373
1374     if (!allowed_versions) {
1375         VLOG_WARN_RL(&bad_ofmsg_rl, "peer does not support any OpenFlow "
1376                      "version (between 0x01 and 0x1f)");
1377         return false;
1378     }
1379
1380     *allowed_versionsp = allowed_versions;
1381     return true;
1382 }
1383
1384 static uint32_t
1385 version_bitmap_from_version(uint8_t ofp_version)
1386 {
1387     return ((ofp_version < 32 ? 1u << ofp_version : 0) - 1) << 1;
1388 }
1389
1390 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1391  * the set of OpenFlow versions for which 'oh' announces support.
1392  *
1393  * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1394  * successful, and thus '*allowed_versions' is always initialized.  However, it
1395  * returns false if 'oh' contains some data that could not be fully understood,
1396  * true if 'oh' was completely parsed. */
1397 bool
1398 ofputil_decode_hello(const struct ofp_header *oh, uint32_t *allowed_versions)
1399 {
1400     struct ofpbuf msg;
1401     bool ok = true;
1402
1403     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
1404     ofpbuf_pull(&msg, sizeof *oh);
1405
1406     *allowed_versions = version_bitmap_from_version(oh->version);
1407     while (msg.size) {
1408         const struct ofp_hello_elem_header *oheh;
1409         unsigned int len;
1410
1411         if (msg.size < sizeof *oheh) {
1412             return false;
1413         }
1414
1415         oheh = msg.data;
1416         len = ntohs(oheh->length);
1417         if (len < sizeof *oheh || !ofpbuf_try_pull(&msg, ROUND_UP(len, 8))) {
1418             return false;
1419         }
1420
1421         if (oheh->type != htons(OFPHET_VERSIONBITMAP)
1422             || !ofputil_decode_hello_bitmap(oheh, allowed_versions)) {
1423             ok = false;
1424         }
1425     }
1426
1427     return ok;
1428 }
1429
1430 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1431  * bitmap to be correctly expressed in an OFPT_HELLO message. */
1432 static bool
1433 should_send_version_bitmap(uint32_t allowed_versions)
1434 {
1435     return !is_pow2((allowed_versions >> 1) + 1);
1436 }
1437
1438 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1439  * versions in the 'allowed_versions' bitmaps and returns the message. */
1440 struct ofpbuf *
1441 ofputil_encode_hello(uint32_t allowed_versions)
1442 {
1443     enum ofp_version ofp_version;
1444     struct ofpbuf *msg;
1445
1446     ofp_version = leftmost_1bit_idx(allowed_versions);
1447     msg = ofpraw_alloc(OFPRAW_OFPT_HELLO, ofp_version, 0);
1448
1449     if (should_send_version_bitmap(allowed_versions)) {
1450         struct ofp_hello_elem_header *oheh;
1451         uint16_t map_len;
1452
1453         map_len = sizeof allowed_versions;
1454         oheh = ofpbuf_put_zeros(msg, ROUND_UP(map_len + sizeof *oheh, 8));
1455         oheh->type = htons(OFPHET_VERSIONBITMAP);
1456         oheh->length = htons(map_len + sizeof *oheh);
1457         *ALIGNED_CAST(ovs_be32 *, oheh + 1) = htonl(allowed_versions);
1458
1459         ofpmsg_update_length(msg);
1460     }
1461
1462     return msg;
1463 }
1464
1465 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1466  * protocol is 'current', at least partly transitions the protocol to 'want'.
1467  * Stores in '*next' the protocol that will be in effect on the OpenFlow
1468  * connection if the switch processes the returned message correctly.  (If
1469  * '*next != want' then the caller will have to iterate.)
1470  *
1471  * If 'current == want', or if it is not possible to transition from 'current'
1472  * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1473  * protocol versions), returns NULL and stores 'current' in '*next'. */
1474 struct ofpbuf *
1475 ofputil_encode_set_protocol(enum ofputil_protocol current,
1476                             enum ofputil_protocol want,
1477                             enum ofputil_protocol *next)
1478 {
1479     enum ofp_version cur_version, want_version;
1480     enum ofputil_protocol cur_base, want_base;
1481     bool cur_tid, want_tid;
1482
1483     cur_version = ofputil_protocol_to_ofp_version(current);
1484     want_version = ofputil_protocol_to_ofp_version(want);
1485     if (cur_version != want_version) {
1486         *next = current;
1487         return NULL;
1488     }
1489
1490     cur_base = ofputil_protocol_to_base(current);
1491     want_base = ofputil_protocol_to_base(want);
1492     if (cur_base != want_base) {
1493         *next = ofputil_protocol_set_base(current, want_base);
1494
1495         switch (want_base) {
1496         case OFPUTIL_P_OF10_NXM:
1497             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1498
1499         case OFPUTIL_P_OF10_STD:
1500             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1501
1502         case OFPUTIL_P_OF11_STD:
1503         case OFPUTIL_P_OF12_OXM:
1504         case OFPUTIL_P_OF13_OXM:
1505         case OFPUTIL_P_OF14_OXM:
1506         case OFPUTIL_P_OF15_OXM:
1507             /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1508              * verified above that we're not trying to change versions. */
1509             OVS_NOT_REACHED();
1510
1511         case OFPUTIL_P_OF10_STD_TID:
1512         case OFPUTIL_P_OF10_NXM_TID:
1513             OVS_NOT_REACHED();
1514         }
1515     }
1516
1517     cur_tid = (current & OFPUTIL_P_TID) != 0;
1518     want_tid = (want & OFPUTIL_P_TID) != 0;
1519     if (cur_tid != want_tid) {
1520         *next = ofputil_protocol_set_tid(current, want_tid);
1521         return ofputil_make_flow_mod_table_id(want_tid);
1522     }
1523
1524     ovs_assert(current == want);
1525
1526     *next = current;
1527     return NULL;
1528 }
1529
1530 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1531  * format to 'nxff'.  */
1532 struct ofpbuf *
1533 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1534 {
1535     struct nx_set_flow_format *sff;
1536     struct ofpbuf *msg;
1537
1538     ovs_assert(ofputil_nx_flow_format_is_valid(nxff));
1539
1540     msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1541     sff = ofpbuf_put_zeros(msg, sizeof *sff);
1542     sff->format = htonl(nxff);
1543
1544     return msg;
1545 }
1546
1547 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1548  * otherwise. */
1549 enum ofputil_protocol
1550 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1551 {
1552     switch (flow_format) {
1553     case NXFF_OPENFLOW10:
1554         return OFPUTIL_P_OF10_STD;
1555
1556     case NXFF_NXM:
1557         return OFPUTIL_P_OF10_NXM;
1558
1559     default:
1560         return 0;
1561     }
1562 }
1563
1564 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1565 bool
1566 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1567 {
1568     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1569 }
1570
1571 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1572  * value. */
1573 const char *
1574 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1575 {
1576     switch (flow_format) {
1577     case NXFF_OPENFLOW10:
1578         return "openflow10";
1579     case NXFF_NXM:
1580         return "nxm";
1581     default:
1582         OVS_NOT_REACHED();
1583     }
1584 }
1585
1586 struct ofpbuf *
1587 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1588                                   enum nx_packet_in_format packet_in_format)
1589 {
1590     struct nx_set_packet_in_format *spif;
1591     struct ofpbuf *msg;
1592
1593     msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1594     spif = ofpbuf_put_zeros(msg, sizeof *spif);
1595     spif->format = htonl(packet_in_format);
1596
1597     return msg;
1598 }
1599
1600 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1601  * extension on or off (according to 'flow_mod_table_id'). */
1602 struct ofpbuf *
1603 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1604 {
1605     struct nx_flow_mod_table_id *nfmti;
1606     struct ofpbuf *msg;
1607
1608     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1609     nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1610     nfmti->set = flow_mod_table_id;
1611     return msg;
1612 }
1613
1614 struct ofputil_flow_mod_flag {
1615     uint16_t raw_flag;
1616     enum ofp_version min_version, max_version;
1617     enum ofputil_flow_mod_flags flag;
1618 };
1619
1620 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags[] = {
1621     { OFPFF_SEND_FLOW_REM,   OFP10_VERSION, 0, OFPUTIL_FF_SEND_FLOW_REM },
1622     { OFPFF_CHECK_OVERLAP,   OFP10_VERSION, 0, OFPUTIL_FF_CHECK_OVERLAP },
1623     { OFPFF10_EMERG,         OFP10_VERSION, OFP10_VERSION,
1624       OFPUTIL_FF_EMERG },
1625     { OFPFF12_RESET_COUNTS,  OFP12_VERSION, 0, OFPUTIL_FF_RESET_COUNTS },
1626     { OFPFF13_NO_PKT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_PKT_COUNTS },
1627     { OFPFF13_NO_BYT_COUNTS, OFP13_VERSION, 0, OFPUTIL_FF_NO_BYT_COUNTS },
1628     { 0, 0, 0, 0 },
1629 };
1630
1631 static enum ofperr
1632 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_,
1633                               enum ofp_flow_mod_command command,
1634                               enum ofp_version version,
1635                               enum ofputil_flow_mod_flags *flagsp)
1636 {
1637     uint16_t raw_flags = ntohs(raw_flags_);
1638     const struct ofputil_flow_mod_flag *f;
1639
1640     *flagsp = 0;
1641     for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1642         if (raw_flags & f->raw_flag
1643             && version >= f->min_version
1644             && (!f->max_version || version <= f->max_version)) {
1645             raw_flags &= ~f->raw_flag;
1646             *flagsp |= f->flag;
1647         }
1648     }
1649
1650     /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1651      * never do.
1652      *
1653      * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1654      * resets counters. */
1655     if ((version == OFP10_VERSION || version == OFP11_VERSION)
1656         && command == OFPFC_ADD) {
1657         *flagsp |= OFPUTIL_FF_RESET_COUNTS;
1658     }
1659
1660     return raw_flags ? OFPERR_OFPFMFC_BAD_FLAGS : 0;
1661 }
1662
1663 static ovs_be16
1664 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags,
1665                               enum ofp_version version)
1666 {
1667     const struct ofputil_flow_mod_flag *f;
1668     uint16_t raw_flags;
1669
1670     raw_flags = 0;
1671     for (f = ofputil_flow_mod_flags; f->raw_flag; f++) {
1672         if (f->flag & flags
1673             && version >= f->min_version
1674             && (!f->max_version || version <= f->max_version)) {
1675             raw_flags |= f->raw_flag;
1676         }
1677     }
1678
1679     return htons(raw_flags);
1680 }
1681
1682 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1683  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1684  * code.
1685  *
1686  * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1687  * The caller must initialize 'ofpacts' and retains ownership of it.
1688  * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1689  *
1690  * Does not validate the flow_mod actions.  The caller should do that, with
1691  * ofpacts_check(). */
1692 enum ofperr
1693 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1694                         const struct ofp_header *oh,
1695                         enum ofputil_protocol protocol,
1696                         struct ofpbuf *ofpacts,
1697                         ofp_port_t max_port, uint8_t max_table)
1698 {
1699     ovs_be16 raw_flags;
1700     enum ofperr error;
1701     struct ofpbuf b;
1702     enum ofpraw raw;
1703
1704     /* Ignored for non-delete actions */
1705     fm->delete_reason = OFPRR_DELETE;
1706
1707     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1708     raw = ofpraw_pull_assert(&b);
1709     if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1710         /* Standard OpenFlow 1.1+ flow_mod. */
1711         const struct ofp11_flow_mod *ofm;
1712
1713         ofm = ofpbuf_pull(&b, sizeof *ofm);
1714
1715         error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1716         if (error) {
1717             return error;
1718         }
1719
1720         /* Translate the message. */
1721         fm->priority = ntohs(ofm->priority);
1722         if (ofm->command == OFPFC_ADD
1723             || (oh->version == OFP11_VERSION
1724                 && (ofm->command == OFPFC_MODIFY ||
1725                     ofm->command == OFPFC_MODIFY_STRICT)
1726                 && ofm->cookie_mask == htonll(0))) {
1727             /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1728              * not match on the cookie is treated as an "add" if there is no
1729              * match. */
1730             fm->cookie = htonll(0);
1731             fm->cookie_mask = htonll(0);
1732             fm->new_cookie = ofm->cookie;
1733         } else {
1734             fm->cookie = ofm->cookie;
1735             fm->cookie_mask = ofm->cookie_mask;
1736             fm->new_cookie = OVS_BE64_MAX;
1737         }
1738         fm->modify_cookie = false;
1739         fm->command = ofm->command;
1740
1741         /* Get table ID.
1742          *
1743          * OF1.1 entirely forbids table_id == OFPTT_ALL.
1744          * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1745         fm->table_id = ofm->table_id;
1746         if (fm->table_id == OFPTT_ALL
1747             && (oh->version == OFP11_VERSION
1748                 || (ofm->command != OFPFC_DELETE &&
1749                     ofm->command != OFPFC_DELETE_STRICT))) {
1750             return OFPERR_OFPFMFC_BAD_TABLE_ID;
1751         }
1752
1753         fm->idle_timeout = ntohs(ofm->idle_timeout);
1754         fm->hard_timeout = ntohs(ofm->hard_timeout);
1755         if (oh->version >= OFP14_VERSION && ofm->command == OFPFC_ADD) {
1756             fm->importance = ntohs(ofm->importance);
1757         } else {
1758             fm->importance = 0;
1759         }
1760         fm->buffer_id = ntohl(ofm->buffer_id);
1761         error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1762         if (error) {
1763             return error;
1764         }
1765
1766         fm->out_group = (ofm->command == OFPFC_DELETE ||
1767                          ofm->command == OFPFC_DELETE_STRICT
1768                          ? ntohl(ofm->out_group)
1769                          : OFPG_ANY);
1770         raw_flags = ofm->flags;
1771     } else {
1772         uint16_t command;
1773
1774         if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1775             /* Standard OpenFlow 1.0 flow_mod. */
1776             const struct ofp10_flow_mod *ofm;
1777
1778             /* Get the ofp10_flow_mod. */
1779             ofm = ofpbuf_pull(&b, sizeof *ofm);
1780
1781             /* Translate the rule. */
1782             ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1783             ofputil_normalize_match(&fm->match);
1784
1785             /* OpenFlow 1.0 says that exact-match rules have to have the
1786              * highest possible priority. */
1787             fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1788                             ? ntohs(ofm->priority)
1789                             : UINT16_MAX);
1790
1791             /* Translate the message. */
1792             command = ntohs(ofm->command);
1793             fm->cookie = htonll(0);
1794             fm->cookie_mask = htonll(0);
1795             fm->new_cookie = ofm->cookie;
1796             fm->idle_timeout = ntohs(ofm->idle_timeout);
1797             fm->hard_timeout = ntohs(ofm->hard_timeout);
1798             fm->importance = 0;
1799             fm->buffer_id = ntohl(ofm->buffer_id);
1800             fm->out_port = u16_to_ofp(ntohs(ofm->out_port));
1801             fm->out_group = OFPG_ANY;
1802             raw_flags = ofm->flags;
1803         } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1804             /* Nicira extended flow_mod. */
1805             const struct nx_flow_mod *nfm;
1806
1807             /* Dissect the message. */
1808             nfm = ofpbuf_pull(&b, sizeof *nfm);
1809             error = nx_pull_match(&b, ntohs(nfm->match_len),
1810                                   &fm->match, &fm->cookie, &fm->cookie_mask);
1811             if (error) {
1812                 return error;
1813             }
1814
1815             /* Translate the message. */
1816             command = ntohs(nfm->command);
1817             if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1818                 /* Flow additions may only set a new cookie, not match an
1819                  * existing cookie. */
1820                 return OFPERR_NXBRC_NXM_INVALID;
1821             }
1822             fm->priority = ntohs(nfm->priority);
1823             fm->new_cookie = nfm->cookie;
1824             fm->idle_timeout = ntohs(nfm->idle_timeout);
1825             fm->hard_timeout = ntohs(nfm->hard_timeout);
1826             fm->importance = 0;
1827             fm->buffer_id = ntohl(nfm->buffer_id);
1828             fm->out_port = u16_to_ofp(ntohs(nfm->out_port));
1829             fm->out_group = OFPG_ANY;
1830             raw_flags = nfm->flags;
1831         } else {
1832             OVS_NOT_REACHED();
1833         }
1834
1835         fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
1836         if (protocol & OFPUTIL_P_TID) {
1837             fm->command = command & 0xff;
1838             fm->table_id = command >> 8;
1839         } else {
1840             if (command > 0xff) {
1841                 VLOG_WARN_RL(&bad_ofmsg_rl, "flow_mod has explicit table_id "
1842                              "but flow_mod_table_id extension is not enabled");
1843             }
1844             fm->command = command;
1845             fm->table_id = 0xff;
1846         }
1847     }
1848
1849     if (fm->command > OFPFC_DELETE_STRICT) {
1850         return OFPERR_OFPFMFC_BAD_COMMAND;
1851     }
1852
1853     error = ofpacts_pull_openflow_instructions(&b, b.size,
1854                                                oh->version, ofpacts);
1855     if (error) {
1856         return error;
1857     }
1858     fm->ofpacts = ofpacts->data;
1859     fm->ofpacts_len = ofpacts->size;
1860
1861     error = ofputil_decode_flow_mod_flags(raw_flags, fm->command,
1862                                           oh->version, &fm->flags);
1863     if (error) {
1864         return error;
1865     }
1866
1867     if (fm->flags & OFPUTIL_FF_EMERG) {
1868         /* We do not support the OpenFlow 1.0 emergency flow cache, which
1869          * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1870          *
1871          * OpenFlow 1.0 specifies the error code to use when idle_timeout
1872          * or hard_timeout is nonzero.  Otherwise, there is no good error
1873          * code, so just state that the flow table is full. */
1874         return (fm->hard_timeout || fm->idle_timeout
1875                 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1876                 : OFPERR_OFPFMFC_TABLE_FULL);
1877     }
1878
1879     return ofpacts_check_consistency(fm->ofpacts, fm->ofpacts_len,
1880                                      &fm->match.flow, max_port,
1881                                      fm->table_id, max_table, protocol);
1882 }
1883
1884 static enum ofperr
1885 ofputil_pull_bands(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
1886                    struct ofpbuf *bands)
1887 {
1888     const struct ofp13_meter_band_header *ombh;
1889     struct ofputil_meter_band *mb;
1890     uint16_t n = 0;
1891
1892     ombh = ofpbuf_try_pull(msg, len);
1893     if (!ombh) {
1894         return OFPERR_OFPBRC_BAD_LEN;
1895     }
1896
1897     while (len >= sizeof (struct ofp13_meter_band_drop)) {
1898         size_t ombh_len = ntohs(ombh->len);
1899         /* All supported band types have the same length. */
1900         if (ombh_len != sizeof (struct ofp13_meter_band_drop)) {
1901             return OFPERR_OFPBRC_BAD_LEN;
1902         }
1903         mb = ofpbuf_put_uninit(bands, sizeof *mb);
1904         mb->type = ntohs(ombh->type);
1905         if (mb->type != OFPMBT13_DROP && mb->type != OFPMBT13_DSCP_REMARK) {
1906             return OFPERR_OFPMMFC_BAD_BAND;
1907         }
1908         mb->rate = ntohl(ombh->rate);
1909         mb->burst_size = ntohl(ombh->burst_size);
1910         mb->prec_level = (mb->type == OFPMBT13_DSCP_REMARK) ?
1911             ((struct ofp13_meter_band_dscp_remark *)ombh)->prec_level : 0;
1912         n++;
1913         len -= ombh_len;
1914         ombh = ALIGNED_CAST(struct ofp13_meter_band_header *,
1915                             (char *) ombh + ombh_len);
1916     }
1917     if (len) {
1918         return OFPERR_OFPBRC_BAD_LEN;
1919     }
1920     *n_bands = n;
1921     return 0;
1922 }
1923
1924 enum ofperr
1925 ofputil_decode_meter_mod(const struct ofp_header *oh,
1926                          struct ofputil_meter_mod *mm,
1927                          struct ofpbuf *bands)
1928 {
1929     const struct ofp13_meter_mod *omm;
1930     struct ofpbuf b;
1931
1932     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1933     ofpraw_pull_assert(&b);
1934     omm = ofpbuf_pull(&b, sizeof *omm);
1935
1936     /* Translate the message. */
1937     mm->command = ntohs(omm->command);
1938     if (mm->command != OFPMC13_ADD &&
1939         mm->command != OFPMC13_MODIFY &&
1940         mm->command != OFPMC13_DELETE) {
1941         return OFPERR_OFPMMFC_BAD_COMMAND;
1942     }
1943     mm->meter.meter_id = ntohl(omm->meter_id);
1944
1945     if (mm->command == OFPMC13_DELETE) {
1946         mm->meter.flags = 0;
1947         mm->meter.n_bands = 0;
1948         mm->meter.bands = NULL;
1949     } else {
1950         enum ofperr error;
1951
1952         mm->meter.flags = ntohs(omm->flags);
1953         if (mm->meter.flags & OFPMF13_KBPS &&
1954             mm->meter.flags & OFPMF13_PKTPS) {
1955             return OFPERR_OFPMMFC_BAD_FLAGS;
1956         }
1957         mm->meter.bands = bands->data;
1958
1959         error = ofputil_pull_bands(&b, b.size, &mm->meter.n_bands, bands);
1960         if (error) {
1961             return error;
1962         }
1963     }
1964     return 0;
1965 }
1966
1967 void
1968 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1969 {
1970     const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1971     *meter_id = ntohl(omr->meter_id);
1972 }
1973
1974 struct ofpbuf *
1975 ofputil_encode_meter_request(enum ofp_version ofp_version,
1976                              enum ofputil_meter_request_type type,
1977                              uint32_t meter_id)
1978 {
1979     struct ofpbuf *msg;
1980
1981     enum ofpraw raw;
1982
1983     switch (type) {
1984     case OFPUTIL_METER_CONFIG:
1985         raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1986         break;
1987     case OFPUTIL_METER_STATS:
1988         raw = OFPRAW_OFPST13_METER_REQUEST;
1989         break;
1990     default:
1991     case OFPUTIL_METER_FEATURES:
1992         raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1993         break;
1994     }
1995
1996     msg = ofpraw_alloc(raw, ofp_version, 0);
1997
1998     if (type != OFPUTIL_METER_FEATURES) {
1999         struct ofp13_meter_multipart_request *omr;
2000         omr = ofpbuf_put_zeros(msg, sizeof *omr);
2001         omr->meter_id = htonl(meter_id);
2002     }
2003     return msg;
2004 }
2005
2006 static void
2007 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
2008                   struct ofpbuf *msg)
2009 {
2010     uint16_t n = 0;
2011
2012     for (n = 0; n < n_bands; ++n) {
2013         /* Currently all band types have same size. */
2014         struct ofp13_meter_band_dscp_remark *ombh;
2015         size_t ombh_len = sizeof *ombh;
2016
2017         ombh = ofpbuf_put_zeros(msg, ombh_len);
2018
2019         ombh->type = htons(mb->type);
2020         ombh->len = htons(ombh_len);
2021         ombh->rate = htonl(mb->rate);
2022         ombh->burst_size = htonl(mb->burst_size);
2023         ombh->prec_level = mb->prec_level;
2024
2025         mb++;
2026     }
2027 }
2028
2029 /* Encode a meter stat for 'mc' and append it to 'replies'. */
2030 void
2031 ofputil_append_meter_config(struct ovs_list *replies,
2032                             const struct ofputil_meter_config *mc)
2033 {
2034     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
2035     size_t start_ofs = msg->size;
2036     struct ofp13_meter_config *reply;
2037
2038     ofpbuf_put_uninit(msg, sizeof *reply);
2039     ofputil_put_bands(mc->n_bands, mc->bands, msg);
2040
2041     reply = ofpbuf_at_assert(msg, start_ofs, sizeof *reply);
2042     reply->flags = htons(mc->flags);
2043     reply->meter_id = htonl(mc->meter_id);
2044     reply->length = htons(msg->size - start_ofs);
2045
2046     ofpmp_postappend(replies, start_ofs);
2047 }
2048
2049 /* Encode a meter stat for 'ms' and append it to 'replies'. */
2050 void
2051 ofputil_append_meter_stats(struct ovs_list *replies,
2052                            const struct ofputil_meter_stats *ms)
2053 {
2054     struct ofp13_meter_stats *reply;
2055     uint16_t n = 0;
2056     uint16_t len;
2057
2058     len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
2059     reply = ofpmp_append(replies, len);
2060
2061     reply->meter_id = htonl(ms->meter_id);
2062     reply->len = htons(len);
2063     memset(reply->pad, 0, sizeof reply->pad);
2064     reply->flow_count = htonl(ms->flow_count);
2065     reply->packet_in_count = htonll(ms->packet_in_count);
2066     reply->byte_in_count = htonll(ms->byte_in_count);
2067     reply->duration_sec = htonl(ms->duration_sec);
2068     reply->duration_nsec = htonl(ms->duration_nsec);
2069
2070     for (n = 0; n < ms->n_bands; ++n) {
2071         const struct ofputil_meter_band_stats *src = &ms->bands[n];
2072         struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
2073
2074         dst->packet_band_count = htonll(src->packet_count);
2075         dst->byte_band_count = htonll(src->byte_count);
2076     }
2077 }
2078
2079 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
2080  * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
2081  * 'bands'.  The caller must have initialized 'bands' and retains ownership of
2082  * it across the call.
2083  *
2084  * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
2085  * message.  Calling this function multiple times for a single 'msg' iterates
2086  * through the replies.  'bands' is cleared for each reply.
2087  *
2088  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2089  * otherwise a positive errno value. */
2090 int
2091 ofputil_decode_meter_config(struct ofpbuf *msg,
2092                             struct ofputil_meter_config *mc,
2093                             struct ofpbuf *bands)
2094 {
2095     const struct ofp13_meter_config *omc;
2096     enum ofperr err;
2097
2098     /* Pull OpenFlow headers for the first call. */
2099     if (!msg->header) {
2100         ofpraw_pull_assert(msg);
2101     }
2102
2103     if (!msg->size) {
2104         return EOF;
2105     }
2106
2107     omc = ofpbuf_try_pull(msg, sizeof *omc);
2108     if (!omc) {
2109         VLOG_WARN_RL(&bad_ofmsg_rl,
2110                      "OFPMP_METER_CONFIG reply has %"PRIu32" leftover bytes at end",
2111                      msg->size);
2112         return OFPERR_OFPBRC_BAD_LEN;
2113     }
2114
2115     ofpbuf_clear(bands);
2116     err = ofputil_pull_bands(msg, ntohs(omc->length) - sizeof *omc,
2117                              &mc->n_bands, bands);
2118     if (err) {
2119         return err;
2120     }
2121     mc->meter_id = ntohl(omc->meter_id);
2122     mc->flags = ntohs(omc->flags);
2123     mc->bands = bands->data;
2124
2125     return 0;
2126 }
2127
2128 static enum ofperr
2129 ofputil_pull_band_stats(struct ofpbuf *msg, size_t len, uint16_t *n_bands,
2130                         struct ofpbuf *bands)
2131 {
2132     const struct ofp13_meter_band_stats *ombs;
2133     struct ofputil_meter_band_stats *mbs;
2134     uint16_t n, i;
2135
2136     ombs = ofpbuf_try_pull(msg, len);
2137     if (!ombs) {
2138         return OFPERR_OFPBRC_BAD_LEN;
2139     }
2140
2141     n = len / sizeof *ombs;
2142     if (len != n * sizeof *ombs) {
2143         return OFPERR_OFPBRC_BAD_LEN;
2144     }
2145
2146     mbs = ofpbuf_put_uninit(bands, len);
2147
2148     for (i = 0; i < n; ++i) {
2149         mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
2150         mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
2151     }
2152     *n_bands = n;
2153     return 0;
2154 }
2155
2156 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2157  * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2158  * decoded into 'bands'.
2159  *
2160  * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2161  * message.  Calling this function multiple times for a single 'msg' iterates
2162  * through the replies.  'bands' is cleared for each reply.
2163  *
2164  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2165  * otherwise a positive errno value. */
2166 int
2167 ofputil_decode_meter_stats(struct ofpbuf *msg,
2168                            struct ofputil_meter_stats *ms,
2169                            struct ofpbuf *bands)
2170 {
2171     const struct ofp13_meter_stats *oms;
2172     enum ofperr err;
2173
2174     /* Pull OpenFlow headers for the first call. */
2175     if (!msg->header) {
2176         ofpraw_pull_assert(msg);
2177     }
2178
2179     if (!msg->size) {
2180         return EOF;
2181     }
2182
2183     oms = ofpbuf_try_pull(msg, sizeof *oms);
2184     if (!oms) {
2185         VLOG_WARN_RL(&bad_ofmsg_rl,
2186                      "OFPMP_METER reply has %"PRIu32" leftover bytes at end",
2187                      msg->size);
2188         return OFPERR_OFPBRC_BAD_LEN;
2189     }
2190
2191     ofpbuf_clear(bands);
2192     err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
2193                                   &ms->n_bands, bands);
2194     if (err) {
2195         return err;
2196     }
2197     ms->meter_id = ntohl(oms->meter_id);
2198     ms->flow_count = ntohl(oms->flow_count);
2199     ms->packet_in_count = ntohll(oms->packet_in_count);
2200     ms->byte_in_count = ntohll(oms->byte_in_count);
2201     ms->duration_sec = ntohl(oms->duration_sec);
2202     ms->duration_nsec = ntohl(oms->duration_nsec);
2203     ms->bands = bands->data;
2204
2205     return 0;
2206 }
2207
2208 void
2209 ofputil_decode_meter_features(const struct ofp_header *oh,
2210                               struct ofputil_meter_features *mf)
2211 {
2212     const struct ofp13_meter_features *omf = ofpmsg_body(oh);
2213
2214     mf->max_meters = ntohl(omf->max_meter);
2215     mf->band_types = ntohl(omf->band_types);
2216     mf->capabilities = ntohl(omf->capabilities);
2217     mf->max_bands = omf->max_bands;
2218     mf->max_color = omf->max_color;
2219 }
2220
2221 struct ofpbuf *
2222 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
2223                                     const struct ofp_header *request)
2224 {
2225     struct ofpbuf *reply;
2226     struct ofp13_meter_features *omf;
2227
2228     reply = ofpraw_alloc_stats_reply(request, 0);
2229     omf = ofpbuf_put_zeros(reply, sizeof *omf);
2230
2231     omf->max_meter = htonl(mf->max_meters);
2232     omf->band_types = htonl(mf->band_types);
2233     omf->capabilities = htonl(mf->capabilities);
2234     omf->max_bands = mf->max_bands;
2235     omf->max_color = mf->max_color;
2236
2237     return reply;
2238 }
2239
2240 struct ofpbuf *
2241 ofputil_encode_meter_mod(enum ofp_version ofp_version,
2242                          const struct ofputil_meter_mod *mm)
2243 {
2244     struct ofpbuf *msg;
2245
2246     struct ofp13_meter_mod *omm;
2247
2248     msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
2249                        NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
2250     omm = ofpbuf_put_zeros(msg, sizeof *omm);
2251     omm->command = htons(mm->command);
2252     if (mm->command != OFPMC13_DELETE) {
2253         omm->flags = htons(mm->meter.flags);
2254     }
2255     omm->meter_id = htonl(mm->meter.meter_id);
2256
2257     ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
2258
2259     ofpmsg_update_length(msg);
2260     return msg;
2261 }
2262
2263 static ovs_be16
2264 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2265                     enum ofputil_protocol protocol)
2266 {
2267     return htons(protocol & OFPUTIL_P_TID
2268                  ? (fm->command & 0xff) | (fm->table_id << 8)
2269                  : fm->command);
2270 }
2271
2272 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2273  * 'protocol' and returns the message. */
2274 struct ofpbuf *
2275 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2276                         enum ofputil_protocol protocol)
2277 {
2278     enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
2279     ovs_be16 raw_flags = ofputil_encode_flow_mod_flags(fm->flags, version);
2280     struct ofpbuf *msg;
2281
2282     switch (protocol) {
2283     case OFPUTIL_P_OF11_STD:
2284     case OFPUTIL_P_OF12_OXM:
2285     case OFPUTIL_P_OF13_OXM:
2286     case OFPUTIL_P_OF14_OXM:
2287     case OFPUTIL_P_OF15_OXM: {
2288         struct ofp11_flow_mod *ofm;
2289         int tailroom;
2290
2291         tailroom = ofputil_match_typical_len(protocol) + fm->ofpacts_len;
2292         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, version, tailroom);
2293         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2294         if ((protocol == OFPUTIL_P_OF11_STD
2295              && (fm->command == OFPFC_MODIFY ||
2296                  fm->command == OFPFC_MODIFY_STRICT)
2297              && fm->cookie_mask == htonll(0))
2298             || fm->command == OFPFC_ADD) {
2299             ofm->cookie = fm->new_cookie;
2300         } else {
2301             ofm->cookie = fm->cookie & fm->cookie_mask;
2302         }
2303         ofm->cookie_mask = fm->cookie_mask;
2304         if (fm->table_id != OFPTT_ALL
2305             || (protocol != OFPUTIL_P_OF11_STD
2306                 && (fm->command == OFPFC_DELETE ||
2307                     fm->command == OFPFC_DELETE_STRICT))) {
2308             ofm->table_id = fm->table_id;
2309         } else {
2310             ofm->table_id = 0;
2311         }
2312         ofm->command = fm->command;
2313         ofm->idle_timeout = htons(fm->idle_timeout);
2314         ofm->hard_timeout = htons(fm->hard_timeout);
2315         ofm->priority = htons(fm->priority);
2316         ofm->buffer_id = htonl(fm->buffer_id);
2317         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2318         ofm->out_group = htonl(fm->out_group);
2319         ofm->flags = raw_flags;
2320         if (version >= OFP14_VERSION && fm->command == OFPFC_ADD) {
2321             ofm->importance = htons(fm->importance);
2322         } else {
2323             ofm->importance = 0;
2324         }
2325         ofputil_put_ofp11_match(msg, &fm->match, protocol);
2326         ofpacts_put_openflow_instructions(fm->ofpacts, fm->ofpacts_len, msg,
2327                                           version);
2328         break;
2329     }
2330
2331     case OFPUTIL_P_OF10_STD:
2332     case OFPUTIL_P_OF10_STD_TID: {
2333         struct ofp10_flow_mod *ofm;
2334
2335         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2336                            fm->ofpacts_len);
2337         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2338         ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2339         ofm->cookie = fm->new_cookie;
2340         ofm->command = ofputil_tid_command(fm, protocol);
2341         ofm->idle_timeout = htons(fm->idle_timeout);
2342         ofm->hard_timeout = htons(fm->hard_timeout);
2343         ofm->priority = htons(fm->priority);
2344         ofm->buffer_id = htonl(fm->buffer_id);
2345         ofm->out_port = htons(ofp_to_u16(fm->out_port));
2346         ofm->flags = raw_flags;
2347         ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2348                                      version);
2349         break;
2350     }
2351
2352     case OFPUTIL_P_OF10_NXM:
2353     case OFPUTIL_P_OF10_NXM_TID: {
2354         struct nx_flow_mod *nfm;
2355         int match_len;
2356
2357         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2358                            NXM_TYPICAL_LEN + fm->ofpacts_len);
2359         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2360         nfm->command = ofputil_tid_command(fm, protocol);
2361         nfm->cookie = fm->new_cookie;
2362         match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2363         nfm = msg->msg;
2364         nfm->idle_timeout = htons(fm->idle_timeout);
2365         nfm->hard_timeout = htons(fm->hard_timeout);
2366         nfm->priority = htons(fm->priority);
2367         nfm->buffer_id = htonl(fm->buffer_id);
2368         nfm->out_port = htons(ofp_to_u16(fm->out_port));
2369         nfm->flags = raw_flags;
2370         nfm->match_len = htons(match_len);
2371         ofpacts_put_openflow_actions(fm->ofpacts, fm->ofpacts_len, msg,
2372                                      version);
2373         break;
2374     }
2375
2376     default:
2377         OVS_NOT_REACHED();
2378     }
2379
2380     ofpmsg_update_length(msg);
2381     return msg;
2382 }
2383
2384 static enum ofperr
2385 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2386                                     const struct ofp10_flow_stats_request *ofsr,
2387                                     bool aggregate)
2388 {
2389     fsr->aggregate = aggregate;
2390     ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2391     fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2392     fsr->out_group = OFPG_ANY;
2393     fsr->table_id = ofsr->table_id;
2394     fsr->cookie = fsr->cookie_mask = htonll(0);
2395
2396     return 0;
2397 }
2398
2399 static enum ofperr
2400 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2401                                     struct ofpbuf *b, bool aggregate)
2402 {
2403     const struct ofp11_flow_stats_request *ofsr;
2404     enum ofperr error;
2405
2406     ofsr = ofpbuf_pull(b, sizeof *ofsr);
2407     fsr->aggregate = aggregate;
2408     fsr->table_id = ofsr->table_id;
2409     error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2410     if (error) {
2411         return error;
2412     }
2413     fsr->out_group = ntohl(ofsr->out_group);
2414     fsr->cookie = ofsr->cookie;
2415     fsr->cookie_mask = ofsr->cookie_mask;
2416     error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2417     if (error) {
2418         return error;
2419     }
2420
2421     return 0;
2422 }
2423
2424 static enum ofperr
2425 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2426                                  struct ofpbuf *b, bool aggregate)
2427 {
2428     const struct nx_flow_stats_request *nfsr;
2429     enum ofperr error;
2430
2431     nfsr = ofpbuf_pull(b, sizeof *nfsr);
2432     error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2433                           &fsr->cookie, &fsr->cookie_mask);
2434     if (error) {
2435         return error;
2436     }
2437     if (b->size) {
2438         return OFPERR_OFPBRC_BAD_LEN;
2439     }
2440
2441     fsr->aggregate = aggregate;
2442     fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2443     fsr->out_group = OFPG_ANY;
2444     fsr->table_id = nfsr->table_id;
2445
2446     return 0;
2447 }
2448
2449 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2450  * 'port', suitable for OpenFlow version 'version'. */
2451 struct ofpbuf *
2452 ofputil_encode_queue_get_config_request(enum ofp_version version,
2453                                         ofp_port_t port)
2454 {
2455     struct ofpbuf *request;
2456
2457     if (version == OFP10_VERSION) {
2458         struct ofp10_queue_get_config_request *qgcr10;
2459
2460         request = ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
2461                                version, 0);
2462         qgcr10 = ofpbuf_put_zeros(request, sizeof *qgcr10);
2463         qgcr10->port = htons(ofp_to_u16(port));
2464     } else {
2465         struct ofp11_queue_get_config_request *qgcr11;
2466
2467         request = ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
2468                                version, 0);
2469         qgcr11 = ofpbuf_put_zeros(request, sizeof *qgcr11);
2470         qgcr11->port = ofputil_port_to_ofp11(port);
2471     }
2472
2473     return request;
2474 }
2475
2476 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2477  * request into '*port'.  Returns 0 if successful, otherwise an OpenFlow error
2478  * code. */
2479 enum ofperr
2480 ofputil_decode_queue_get_config_request(const struct ofp_header *oh,
2481                                         ofp_port_t *port)
2482 {
2483     const struct ofp10_queue_get_config_request *qgcr10;
2484     const struct ofp11_queue_get_config_request *qgcr11;
2485     enum ofpraw raw;
2486     struct ofpbuf b;
2487
2488     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2489     raw = ofpraw_pull_assert(&b);
2490
2491     switch ((int) raw) {
2492     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2493         qgcr10 = b.data;
2494         *port = u16_to_ofp(ntohs(qgcr10->port));
2495         break;
2496
2497     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2498         qgcr11 = b.data;
2499         enum ofperr error = ofputil_port_from_ofp11(qgcr11->port, port);
2500         if (error || *port == OFPP_ANY) {
2501             return error;
2502         }
2503         break;
2504
2505     default:
2506         OVS_NOT_REACHED();
2507     }
2508
2509     return (ofp_to_u16(*port) < ofp_to_u16(OFPP_MAX)
2510             ? 0
2511             : OFPERR_OFPQOFC_BAD_PORT);
2512 }
2513
2514 /* Constructs and returns the beginning of a reply to
2515  * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'.  The caller may append information about
2516  * individual queues with ofputil_append_queue_get_config_reply(). */
2517 struct ofpbuf *
2518 ofputil_encode_queue_get_config_reply(const struct ofp_header *oh)
2519 {
2520     struct ofp10_queue_get_config_reply *qgcr10;
2521     struct ofp11_queue_get_config_reply *qgcr11;
2522     struct ofpbuf *reply;
2523     enum ofperr error;
2524     struct ofpbuf b;
2525     enum ofpraw raw;
2526     ofp_port_t port;
2527
2528     error = ofputil_decode_queue_get_config_request(oh, &port);
2529     ovs_assert(!error);
2530
2531     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2532     raw = ofpraw_pull_assert(&b);
2533
2534     switch ((int) raw) {
2535     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST:
2536         reply = ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
2537                                    oh, 0);
2538         qgcr10 = ofpbuf_put_zeros(reply, sizeof *qgcr10);
2539         qgcr10->port = htons(ofp_to_u16(port));
2540         break;
2541
2542     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST:
2543         reply = ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
2544                                    oh, 0);
2545         qgcr11 = ofpbuf_put_zeros(reply, sizeof *qgcr11);
2546         qgcr11->port = ofputil_port_to_ofp11(port);
2547         break;
2548
2549     default:
2550         OVS_NOT_REACHED();
2551     }
2552
2553     return reply;
2554 }
2555
2556 static void
2557 put_queue_rate(struct ofpbuf *reply, enum ofp_queue_properties property,
2558                uint16_t rate)
2559 {
2560     if (rate != UINT16_MAX) {
2561         struct ofp_queue_prop_rate *oqpr;
2562
2563         oqpr = ofpbuf_put_zeros(reply, sizeof *oqpr);
2564         oqpr->prop_header.property = htons(property);
2565         oqpr->prop_header.len = htons(sizeof *oqpr);
2566         oqpr->rate = htons(rate);
2567     }
2568 }
2569
2570 /* Appends a queue description for 'queue_id' to the
2571  * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2572 void
2573 ofputil_append_queue_get_config_reply(struct ofpbuf *reply,
2574                                       const struct ofputil_queue_config *oqc)
2575 {
2576     const struct ofp_header *oh = reply->data;
2577     size_t start_ofs, len_ofs;
2578     ovs_be16 *len;
2579
2580     start_ofs = reply->size;
2581     if (oh->version < OFP12_VERSION) {
2582         struct ofp10_packet_queue *opq10;
2583
2584         opq10 = ofpbuf_put_zeros(reply, sizeof *opq10);
2585         opq10->queue_id = htonl(oqc->queue_id);
2586         len_ofs = (char *) &opq10->len - (char *) reply->data;
2587     } else {
2588         struct ofp12_packet_queue *opq12;
2589
2590         opq12 = ofpbuf_put_zeros(reply, sizeof *opq12);
2591         opq12->port = ofputil_port_to_ofp11(oqc->port);
2592         opq12->queue_id = htonl(oqc->queue_id);
2593         len_ofs = (char *) &opq12->len - (char *) reply->data;
2594     }
2595
2596     put_queue_rate(reply, OFPQT_MIN_RATE, oqc->min_rate);
2597     put_queue_rate(reply, OFPQT_MAX_RATE, oqc->max_rate);
2598
2599     len = ofpbuf_at(reply, len_ofs, sizeof *len);
2600     *len = htons(reply->size - start_ofs);
2601 }
2602
2603 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2604  * stores in '*port' the port that the reply is about.  The caller may call
2605  * ofputil_pull_queue_get_config_reply() to obtain information about individual
2606  * queues included in the reply.  Returns 0 if successful, otherwise an
2607  * ofperr.*/
2608 enum ofperr
2609 ofputil_decode_queue_get_config_reply(struct ofpbuf *reply, ofp_port_t *port)
2610 {
2611     const struct ofp10_queue_get_config_reply *qgcr10;
2612     const struct ofp11_queue_get_config_reply *qgcr11;
2613     enum ofpraw raw;
2614
2615     raw = ofpraw_pull_assert(reply);
2616     switch ((int) raw) {
2617     case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY:
2618         qgcr10 = ofpbuf_pull(reply, sizeof *qgcr10);
2619         *port = u16_to_ofp(ntohs(qgcr10->port));
2620         return 0;
2621
2622     case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY:
2623         qgcr11 = ofpbuf_pull(reply, sizeof *qgcr11);
2624         return ofputil_port_from_ofp11(qgcr11->port, port);
2625     }
2626
2627     OVS_NOT_REACHED();
2628 }
2629
2630 static enum ofperr
2631 parse_queue_rate(const struct ofp_queue_prop_header *hdr, uint16_t *rate)
2632 {
2633     const struct ofp_queue_prop_rate *oqpr;
2634
2635     if (hdr->len == htons(sizeof *oqpr)) {
2636         oqpr = (const struct ofp_queue_prop_rate *) hdr;
2637         *rate = ntohs(oqpr->rate);
2638         return 0;
2639     } else {
2640         return OFPERR_OFPBRC_BAD_LEN;
2641     }
2642 }
2643
2644 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2645  * 'reply' and stores it in '*queue'.  ofputil_decode_queue_get_config_reply()
2646  * must already have pulled off the main header.
2647  *
2648  * This function returns EOF if the last queue has already been decoded, 0 if a
2649  * queue was successfully decoded into '*queue', or an ofperr if there was a
2650  * problem decoding 'reply'. */
2651 int
2652 ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
2653                                     struct ofputil_queue_config *queue)
2654 {
2655     const struct ofp_header *oh;
2656     unsigned int opq_len;
2657     unsigned int len;
2658
2659     if (!reply->size) {
2660         return EOF;
2661     }
2662
2663     queue->min_rate = UINT16_MAX;
2664     queue->max_rate = UINT16_MAX;
2665
2666     oh = reply->header;
2667     if (oh->version < OFP12_VERSION) {
2668         const struct ofp10_packet_queue *opq10;
2669
2670         opq10 = ofpbuf_try_pull(reply, sizeof *opq10);
2671         if (!opq10) {
2672             return OFPERR_OFPBRC_BAD_LEN;
2673         }
2674         queue->queue_id = ntohl(opq10->queue_id);
2675         len = ntohs(opq10->len);
2676         opq_len = sizeof *opq10;
2677     } else {
2678         const struct ofp12_packet_queue *opq12;
2679
2680         opq12 = ofpbuf_try_pull(reply, sizeof *opq12);
2681         if (!opq12) {
2682             return OFPERR_OFPBRC_BAD_LEN;
2683         }
2684         queue->queue_id = ntohl(opq12->queue_id);
2685         len = ntohs(opq12->len);
2686         opq_len = sizeof *opq12;
2687     }
2688
2689     if (len < opq_len || len > reply->size + opq_len || len % 8) {
2690         return OFPERR_OFPBRC_BAD_LEN;
2691     }
2692     len -= opq_len;
2693
2694     while (len > 0) {
2695         const struct ofp_queue_prop_header *hdr;
2696         unsigned int property;
2697         unsigned int prop_len;
2698         enum ofperr error = 0;
2699
2700         hdr = ofpbuf_at_assert(reply, 0, sizeof *hdr);
2701         prop_len = ntohs(hdr->len);
2702         if (prop_len < sizeof *hdr || prop_len > reply->size || prop_len % 8) {
2703             return OFPERR_OFPBRC_BAD_LEN;
2704         }
2705
2706         property = ntohs(hdr->property);
2707         switch (property) {
2708         case OFPQT_MIN_RATE:
2709             error = parse_queue_rate(hdr, &queue->min_rate);
2710             break;
2711
2712         case OFPQT_MAX_RATE:
2713             error = parse_queue_rate(hdr, &queue->max_rate);
2714             break;
2715
2716         default:
2717             VLOG_INFO_RL(&bad_ofmsg_rl, "unknown queue property %u", property);
2718             break;
2719         }
2720         if (error) {
2721             return error;
2722         }
2723
2724         ofpbuf_pull(reply, prop_len);
2725         len -= prop_len;
2726     }
2727     return 0;
2728 }
2729
2730 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2731  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
2732  * successful, otherwise an OpenFlow error code. */
2733 enum ofperr
2734 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2735                                   const struct ofp_header *oh)
2736 {
2737     enum ofpraw raw;
2738     struct ofpbuf b;
2739
2740     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2741     raw = ofpraw_pull_assert(&b);
2742     switch ((int) raw) {
2743     case OFPRAW_OFPST10_FLOW_REQUEST:
2744         return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2745
2746     case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2747         return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2748
2749     case OFPRAW_OFPST11_FLOW_REQUEST:
2750         return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2751
2752     case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2753         return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2754
2755     case OFPRAW_NXST_FLOW_REQUEST:
2756         return ofputil_decode_nxst_flow_request(fsr, &b, false);
2757
2758     case OFPRAW_NXST_AGGREGATE_REQUEST:
2759         return ofputil_decode_nxst_flow_request(fsr, &b, true);
2760
2761     default:
2762         /* Hey, the caller lied. */
2763         OVS_NOT_REACHED();
2764     }
2765 }
2766
2767 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2768  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2769  * 'protocol', and returns the message. */
2770 struct ofpbuf *
2771 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2772                                   enum ofputil_protocol protocol)
2773 {
2774     struct ofpbuf *msg;
2775     enum ofpraw raw;
2776
2777     switch (protocol) {
2778     case OFPUTIL_P_OF11_STD:
2779     case OFPUTIL_P_OF12_OXM:
2780     case OFPUTIL_P_OF13_OXM:
2781     case OFPUTIL_P_OF14_OXM:
2782     case OFPUTIL_P_OF15_OXM: {
2783         struct ofp11_flow_stats_request *ofsr;
2784
2785         raw = (fsr->aggregate
2786                ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2787                : OFPRAW_OFPST11_FLOW_REQUEST);
2788         msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2789                            ofputil_match_typical_len(protocol));
2790         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2791         ofsr->table_id = fsr->table_id;
2792         ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2793         ofsr->out_group = htonl(fsr->out_group);
2794         ofsr->cookie = fsr->cookie;
2795         ofsr->cookie_mask = fsr->cookie_mask;
2796         ofputil_put_ofp11_match(msg, &fsr->match, protocol);
2797         break;
2798     }
2799
2800     case OFPUTIL_P_OF10_STD:
2801     case OFPUTIL_P_OF10_STD_TID: {
2802         struct ofp10_flow_stats_request *ofsr;
2803
2804         raw = (fsr->aggregate
2805                ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2806                : OFPRAW_OFPST10_FLOW_REQUEST);
2807         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2808         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2809         ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2810         ofsr->table_id = fsr->table_id;
2811         ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2812         break;
2813     }
2814
2815     case OFPUTIL_P_OF10_NXM:
2816     case OFPUTIL_P_OF10_NXM_TID: {
2817         struct nx_flow_stats_request *nfsr;
2818         int match_len;
2819
2820         raw = (fsr->aggregate
2821                ? OFPRAW_NXST_AGGREGATE_REQUEST
2822                : OFPRAW_NXST_FLOW_REQUEST);
2823         msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2824         ofpbuf_put_zeros(msg, sizeof *nfsr);
2825         match_len = nx_put_match(msg, &fsr->match,
2826                                  fsr->cookie, fsr->cookie_mask);
2827
2828         nfsr = msg->msg;
2829         nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2830         nfsr->match_len = htons(match_len);
2831         nfsr->table_id = fsr->table_id;
2832         break;
2833     }
2834
2835     default:
2836         OVS_NOT_REACHED();
2837     }
2838
2839     return msg;
2840 }
2841
2842 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2843  * ofputil_flow_stats in 'fs'.
2844  *
2845  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2846  * OpenFlow message.  Calling this function multiple times for a single 'msg'
2847  * iterates through the replies.  The caller must initially leave 'msg''s layer
2848  * pointers null and not modify them between calls.
2849  *
2850  * Most switches don't send the values needed to populate fs->idle_age and
2851  * fs->hard_age, so those members will usually be set to 0.  If the switch from
2852  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2853  * 'flow_age_extension' as true so that the contents of 'msg' determine the
2854  * 'idle_age' and 'hard_age' members in 'fs'.
2855  *
2856  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2857  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
2858  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
2859  *
2860  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2861  * otherwise a positive errno value. */
2862 int
2863 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2864                                 struct ofpbuf *msg,
2865                                 bool flow_age_extension,
2866                                 struct ofpbuf *ofpacts)
2867 {
2868     const struct ofp_header *oh;
2869     size_t instructions_len;
2870     enum ofperr error;
2871     enum ofpraw raw;
2872
2873     error = (msg->header ? ofpraw_decode(&raw, msg->header)
2874              : ofpraw_pull(&raw, msg));
2875     if (error) {
2876         return error;
2877     }
2878     oh = msg->header;
2879
2880     if (!msg->size) {
2881         return EOF;
2882     } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2883                || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2884         const struct ofp11_flow_stats *ofs;
2885         size_t length;
2886         uint16_t padded_match_len;
2887
2888         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2889         if (!ofs) {
2890             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2891                          "bytes at end", msg->size);
2892             return EINVAL;
2893         }
2894
2895         length = ntohs(ofs->length);
2896         if (length < sizeof *ofs) {
2897             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2898                          "length %"PRIuSIZE, length);
2899             return EINVAL;
2900         }
2901
2902         if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2903             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2904             return EINVAL;
2905         }
2906         instructions_len = length - sizeof *ofs - padded_match_len;
2907
2908         fs->priority = ntohs(ofs->priority);
2909         fs->table_id = ofs->table_id;
2910         fs->duration_sec = ntohl(ofs->duration_sec);
2911         fs->duration_nsec = ntohl(ofs->duration_nsec);
2912         fs->idle_timeout = ntohs(ofs->idle_timeout);
2913         fs->hard_timeout = ntohs(ofs->hard_timeout);
2914         if (oh->version >= OFP14_VERSION) {
2915             fs->importance = ntohs(ofs->importance);
2916         } else {
2917             fs->importance = 0;
2918         }
2919         if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
2920             error = ofputil_decode_flow_mod_flags(ofs->flags, -1, oh->version,
2921                                                   &fs->flags);
2922             if (error) {
2923                 return error;
2924             }
2925         } else {
2926             fs->flags = 0;
2927         }
2928         fs->idle_age = -1;
2929         fs->hard_age = -1;
2930         fs->cookie = ofs->cookie;
2931         fs->packet_count = ntohll(ofs->packet_count);
2932         fs->byte_count = ntohll(ofs->byte_count);
2933     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2934         const struct ofp10_flow_stats *ofs;
2935         size_t length;
2936
2937         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2938         if (!ofs) {
2939             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %"PRIu32" leftover "
2940                          "bytes at end", msg->size);
2941             return EINVAL;
2942         }
2943
2944         length = ntohs(ofs->length);
2945         if (length < sizeof *ofs) {
2946             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2947                          "length %"PRIuSIZE, length);
2948             return EINVAL;
2949         }
2950         instructions_len = length - sizeof *ofs;
2951
2952         fs->cookie = get_32aligned_be64(&ofs->cookie);
2953         ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2954         fs->priority = ntohs(ofs->priority);
2955         fs->table_id = ofs->table_id;
2956         fs->duration_sec = ntohl(ofs->duration_sec);
2957         fs->duration_nsec = ntohl(ofs->duration_nsec);
2958         fs->idle_timeout = ntohs(ofs->idle_timeout);
2959         fs->hard_timeout = ntohs(ofs->hard_timeout);
2960         fs->importance = 0;
2961         fs->idle_age = -1;
2962         fs->hard_age = -1;
2963         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2964         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2965         fs->flags = 0;
2966     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2967         const struct nx_flow_stats *nfs;
2968         size_t match_len, length;
2969
2970         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2971         if (!nfs) {
2972             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %"PRIu32" leftover "
2973                          "bytes at end", msg->size);
2974             return EINVAL;
2975         }
2976
2977         length = ntohs(nfs->length);
2978         match_len = ntohs(nfs->match_len);
2979         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2980             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%"PRIuSIZE" "
2981                          "claims invalid length %"PRIuSIZE, match_len, length);
2982             return EINVAL;
2983         }
2984         if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2985             return EINVAL;
2986         }
2987         instructions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2988
2989         fs->cookie = nfs->cookie;
2990         fs->table_id = nfs->table_id;
2991         fs->duration_sec = ntohl(nfs->duration_sec);
2992         fs->duration_nsec = ntohl(nfs->duration_nsec);
2993         fs->priority = ntohs(nfs->priority);
2994         fs->idle_timeout = ntohs(nfs->idle_timeout);
2995         fs->hard_timeout = ntohs(nfs->hard_timeout);
2996         fs->importance = 0;
2997         fs->idle_age = -1;
2998         fs->hard_age = -1;
2999         if (flow_age_extension) {
3000             if (nfs->idle_age) {
3001                 fs->idle_age = ntohs(nfs->idle_age) - 1;
3002             }
3003             if (nfs->hard_age) {
3004                 fs->hard_age = ntohs(nfs->hard_age) - 1;
3005             }
3006         }
3007         fs->packet_count = ntohll(nfs->packet_count);
3008         fs->byte_count = ntohll(nfs->byte_count);
3009         fs->flags = 0;
3010     } else {
3011         OVS_NOT_REACHED();
3012     }
3013
3014     if (ofpacts_pull_openflow_instructions(msg, instructions_len, oh->version,
3015                                            ofpacts)) {
3016         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
3017         return EINVAL;
3018     }
3019     fs->ofpacts = ofpacts->data;
3020     fs->ofpacts_len = ofpacts->size;
3021
3022     return 0;
3023 }
3024
3025 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
3026  *
3027  * We use this in situations where OVS internally uses UINT64_MAX to mean
3028  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
3029 static uint64_t
3030 unknown_to_zero(uint64_t count)
3031 {
3032     return count != UINT64_MAX ? count : 0;
3033 }
3034
3035 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
3036  * those already present in the list of ofpbufs in 'replies'.  'replies' should
3037  * have been initialized with ofpmp_init(). */
3038 void
3039 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
3040                                 struct ovs_list *replies)
3041 {
3042     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
3043     size_t start_ofs = reply->size;
3044     enum ofp_version version = ofpmp_version(replies);
3045     enum ofpraw raw = ofpmp_decode_raw(replies);
3046
3047     if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
3048         struct ofp11_flow_stats *ofs;
3049
3050         ofpbuf_put_uninit(reply, sizeof *ofs);
3051         oxm_put_match(reply, &fs->match, version);
3052         ofpacts_put_openflow_instructions(fs->ofpacts, fs->ofpacts_len, reply,
3053                                           version);
3054
3055         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3056         ofs->length = htons(reply->size - start_ofs);
3057         ofs->table_id = fs->table_id;
3058         ofs->pad = 0;
3059         ofs->duration_sec = htonl(fs->duration_sec);
3060         ofs->duration_nsec = htonl(fs->duration_nsec);
3061         ofs->priority = htons(fs->priority);
3062         ofs->idle_timeout = htons(fs->idle_timeout);
3063         ofs->hard_timeout = htons(fs->hard_timeout);
3064         if (version >= OFP14_VERSION) {
3065             ofs->importance = htons(fs->importance);
3066         } else {
3067             ofs->importance = 0;
3068         }
3069         if (raw == OFPRAW_OFPST13_FLOW_REPLY) {
3070             ofs->flags = ofputil_encode_flow_mod_flags(fs->flags, version);
3071         } else {
3072             ofs->flags = 0;
3073         }
3074         memset(ofs->pad2, 0, sizeof ofs->pad2);
3075         ofs->cookie = fs->cookie;
3076         ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
3077         ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
3078     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
3079         struct ofp10_flow_stats *ofs;
3080
3081         ofpbuf_put_uninit(reply, sizeof *ofs);
3082         ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3083                                      version);
3084         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
3085         ofs->length = htons(reply->size - start_ofs);
3086         ofs->table_id = fs->table_id;
3087         ofs->pad = 0;
3088         ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
3089         ofs->duration_sec = htonl(fs->duration_sec);
3090         ofs->duration_nsec = htonl(fs->duration_nsec);
3091         ofs->priority = htons(fs->priority);
3092         ofs->idle_timeout = htons(fs->idle_timeout);
3093         ofs->hard_timeout = htons(fs->hard_timeout);
3094         memset(ofs->pad2, 0, sizeof ofs->pad2);
3095         put_32aligned_be64(&ofs->cookie, fs->cookie);
3096         put_32aligned_be64(&ofs->packet_count,
3097                            htonll(unknown_to_zero(fs->packet_count)));
3098         put_32aligned_be64(&ofs->byte_count,
3099                            htonll(unknown_to_zero(fs->byte_count)));
3100     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
3101         struct nx_flow_stats *nfs;
3102         int match_len;
3103
3104         ofpbuf_put_uninit(reply, sizeof *nfs);
3105         match_len = nx_put_match(reply, &fs->match, 0, 0);
3106         ofpacts_put_openflow_actions(fs->ofpacts, fs->ofpacts_len, reply,
3107                                      version);
3108         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
3109         nfs->length = htons(reply->size - start_ofs);
3110         nfs->table_id = fs->table_id;
3111         nfs->pad = 0;
3112         nfs->duration_sec = htonl(fs->duration_sec);
3113         nfs->duration_nsec = htonl(fs->duration_nsec);
3114         nfs->priority = htons(fs->priority);
3115         nfs->idle_timeout = htons(fs->idle_timeout);
3116         nfs->hard_timeout = htons(fs->hard_timeout);
3117         nfs->idle_age = htons(fs->idle_age < 0 ? 0
3118                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
3119                               : UINT16_MAX);
3120         nfs->hard_age = htons(fs->hard_age < 0 ? 0
3121                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
3122                               : UINT16_MAX);
3123         nfs->match_len = htons(match_len);
3124         nfs->cookie = fs->cookie;
3125         nfs->packet_count = htonll(fs->packet_count);
3126         nfs->byte_count = htonll(fs->byte_count);
3127     } else {
3128         OVS_NOT_REACHED();
3129     }
3130
3131     ofpmp_postappend(replies, start_ofs);
3132 }
3133
3134 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
3135  * NXST_AGGREGATE reply matching 'request', and returns the message. */
3136 struct ofpbuf *
3137 ofputil_encode_aggregate_stats_reply(
3138     const struct ofputil_aggregate_stats *stats,
3139     const struct ofp_header *request)
3140 {
3141     struct ofp_aggregate_stats_reply *asr;
3142     uint64_t packet_count;
3143     uint64_t byte_count;
3144     struct ofpbuf *msg;
3145     enum ofpraw raw;
3146
3147     ofpraw_decode(&raw, request);
3148     if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
3149         packet_count = unknown_to_zero(stats->packet_count);
3150         byte_count = unknown_to_zero(stats->byte_count);
3151     } else {
3152         packet_count = stats->packet_count;
3153         byte_count = stats->byte_count;
3154     }
3155
3156     msg = ofpraw_alloc_stats_reply(request, 0);
3157     asr = ofpbuf_put_zeros(msg, sizeof *asr);
3158     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
3159     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
3160     asr->flow_count = htonl(stats->flow_count);
3161
3162     return msg;
3163 }
3164
3165 enum ofperr
3166 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
3167                                      const struct ofp_header *reply)
3168 {
3169     struct ofp_aggregate_stats_reply *asr;
3170     struct ofpbuf msg;
3171
3172     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
3173     ofpraw_pull_assert(&msg);
3174
3175     asr = msg.msg;
3176     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
3177     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
3178     stats->flow_count = ntohl(asr->flow_count);
3179
3180     return 0;
3181 }
3182
3183 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3184  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
3185  * an OpenFlow error code. */
3186 enum ofperr
3187 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
3188                             const struct ofp_header *oh)
3189 {
3190     enum ofpraw raw;
3191     struct ofpbuf b;
3192
3193     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3194     raw = ofpraw_pull_assert(&b);
3195     if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
3196         const struct ofp12_flow_removed *ofr;
3197         enum ofperr error;
3198
3199         ofr = ofpbuf_pull(&b, sizeof *ofr);
3200
3201         error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
3202         if (error) {
3203             return error;
3204         }
3205
3206         fr->priority = ntohs(ofr->priority);
3207         fr->cookie = ofr->cookie;
3208         fr->reason = ofr->reason;
3209         fr->table_id = ofr->table_id;
3210         fr->duration_sec = ntohl(ofr->duration_sec);
3211         fr->duration_nsec = ntohl(ofr->duration_nsec);
3212         fr->idle_timeout = ntohs(ofr->idle_timeout);
3213         fr->hard_timeout = ntohs(ofr->hard_timeout);
3214         fr->packet_count = ntohll(ofr->packet_count);
3215         fr->byte_count = ntohll(ofr->byte_count);
3216     } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
3217         const struct ofp10_flow_removed *ofr;
3218
3219         ofr = ofpbuf_pull(&b, sizeof *ofr);
3220
3221         ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
3222         fr->priority = ntohs(ofr->priority);
3223         fr->cookie = ofr->cookie;
3224         fr->reason = ofr->reason;
3225         fr->table_id = 255;
3226         fr->duration_sec = ntohl(ofr->duration_sec);
3227         fr->duration_nsec = ntohl(ofr->duration_nsec);
3228         fr->idle_timeout = ntohs(ofr->idle_timeout);
3229         fr->hard_timeout = 0;
3230         fr->packet_count = ntohll(ofr->packet_count);
3231         fr->byte_count = ntohll(ofr->byte_count);
3232     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
3233         struct nx_flow_removed *nfr;
3234         enum ofperr error;
3235
3236         nfr = ofpbuf_pull(&b, sizeof *nfr);
3237         error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
3238                               NULL, NULL);
3239         if (error) {
3240             return error;
3241         }
3242         if (b.size) {
3243             return OFPERR_OFPBRC_BAD_LEN;
3244         }
3245
3246         fr->priority = ntohs(nfr->priority);
3247         fr->cookie = nfr->cookie;
3248         fr->reason = nfr->reason;
3249         fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
3250         fr->duration_sec = ntohl(nfr->duration_sec);
3251         fr->duration_nsec = ntohl(nfr->duration_nsec);
3252         fr->idle_timeout = ntohs(nfr->idle_timeout);
3253         fr->hard_timeout = 0;
3254         fr->packet_count = ntohll(nfr->packet_count);
3255         fr->byte_count = ntohll(nfr->byte_count);
3256     } else {
3257         OVS_NOT_REACHED();
3258     }
3259
3260     return 0;
3261 }
3262
3263 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3264  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3265  * message. */
3266 struct ofpbuf *
3267 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
3268                             enum ofputil_protocol protocol)
3269 {
3270     struct ofpbuf *msg;
3271     enum ofp_flow_removed_reason reason = fr->reason;
3272
3273     if (reason == OFPRR_METER_DELETE && !(protocol & OFPUTIL_P_OF14_UP)) {
3274         reason = OFPRR_DELETE;
3275     }
3276
3277     switch (protocol) {
3278     case OFPUTIL_P_OF11_STD:
3279     case OFPUTIL_P_OF12_OXM:
3280     case OFPUTIL_P_OF13_OXM:
3281     case OFPUTIL_P_OF14_OXM:
3282     case OFPUTIL_P_OF15_OXM: {
3283         struct ofp12_flow_removed *ofr;
3284
3285         msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
3286                                ofputil_protocol_to_ofp_version(protocol),
3287                                htonl(0),
3288                                ofputil_match_typical_len(protocol));
3289         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3290         ofr->cookie = fr->cookie;
3291         ofr->priority = htons(fr->priority);
3292         ofr->reason = reason;
3293         ofr->table_id = fr->table_id;
3294         ofr->duration_sec = htonl(fr->duration_sec);
3295         ofr->duration_nsec = htonl(fr->duration_nsec);
3296         ofr->idle_timeout = htons(fr->idle_timeout);
3297         ofr->hard_timeout = htons(fr->hard_timeout);
3298         ofr->packet_count = htonll(fr->packet_count);
3299         ofr->byte_count = htonll(fr->byte_count);
3300         ofputil_put_ofp11_match(msg, &fr->match, protocol);
3301         break;
3302     }
3303
3304     case OFPUTIL_P_OF10_STD:
3305     case OFPUTIL_P_OF10_STD_TID: {
3306         struct ofp10_flow_removed *ofr;
3307
3308         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
3309                                htonl(0), 0);
3310         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
3311         ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
3312         ofr->cookie = fr->cookie;
3313         ofr->priority = htons(fr->priority);
3314         ofr->reason = reason;
3315         ofr->duration_sec = htonl(fr->duration_sec);
3316         ofr->duration_nsec = htonl(fr->duration_nsec);
3317         ofr->idle_timeout = htons(fr->idle_timeout);
3318         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
3319         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
3320         break;
3321     }
3322
3323     case OFPUTIL_P_OF10_NXM:
3324     case OFPUTIL_P_OF10_NXM_TID: {
3325         struct nx_flow_removed *nfr;
3326         int match_len;
3327
3328         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
3329                                htonl(0), NXM_TYPICAL_LEN);
3330         ofpbuf_put_zeros(msg, sizeof *nfr);
3331         match_len = nx_put_match(msg, &fr->match, 0, 0);
3332
3333         nfr = msg->msg;
3334         nfr->cookie = fr->cookie;
3335         nfr->priority = htons(fr->priority);
3336         nfr->reason = reason;
3337         nfr->table_id = fr->table_id + 1;
3338         nfr->duration_sec = htonl(fr->duration_sec);
3339         nfr->duration_nsec = htonl(fr->duration_nsec);
3340         nfr->idle_timeout = htons(fr->idle_timeout);
3341         nfr->match_len = htons(match_len);
3342         nfr->packet_count = htonll(fr->packet_count);
3343         nfr->byte_count = htonll(fr->byte_count);
3344         break;
3345     }
3346
3347     default:
3348         OVS_NOT_REACHED();
3349     }
3350
3351     return msg;
3352 }
3353
3354 enum ofperr
3355 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
3356                          const struct ofp_header *oh)
3357 {
3358     enum ofpraw raw;
3359     struct ofpbuf b;
3360
3361     memset(pin, 0, sizeof *pin);
3362     pin->cookie = OVS_BE64_MAX;
3363
3364     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3365     raw = ofpraw_pull_assert(&b);
3366     if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
3367         const struct ofp13_packet_in *opi;
3368         int error;
3369         size_t packet_in_size;
3370
3371         if (raw == OFPRAW_OFPT12_PACKET_IN) {
3372             packet_in_size = sizeof (struct ofp12_packet_in);
3373         } else {
3374             packet_in_size = sizeof (struct ofp13_packet_in);
3375         }
3376
3377         opi = ofpbuf_pull(&b, packet_in_size);
3378         error = oxm_pull_match_loose(&b, &pin->flow_metadata);
3379         if (error) {
3380             return error;
3381         }
3382
3383         if (!ofpbuf_try_pull(&b, 2)) {
3384             return OFPERR_OFPBRC_BAD_LEN;
3385         }
3386
3387         pin->reason = opi->pi.reason;
3388         pin->table_id = opi->pi.table_id;
3389         pin->buffer_id = ntohl(opi->pi.buffer_id);
3390         pin->total_len = ntohs(opi->pi.total_len);
3391
3392         if (raw == OFPRAW_OFPT13_PACKET_IN) {
3393             pin->cookie = opi->cookie;
3394         }
3395
3396         pin->packet = b.data;
3397         pin->packet_len = b.size;
3398     } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
3399         const struct ofp10_packet_in *opi;
3400
3401         opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
3402
3403         pin->packet = opi->data;
3404         pin->packet_len = b.size;
3405
3406         match_init_catchall(&pin->flow_metadata);
3407         match_set_in_port(&pin->flow_metadata, u16_to_ofp(ntohs(opi->in_port)));
3408         pin->reason = opi->reason;
3409         pin->buffer_id = ntohl(opi->buffer_id);
3410         pin->total_len = ntohs(opi->total_len);
3411     } else if (raw == OFPRAW_OFPT11_PACKET_IN) {
3412         const struct ofp11_packet_in *opi;
3413         ofp_port_t in_port;
3414         enum ofperr error;
3415
3416         opi = ofpbuf_pull(&b, sizeof *opi);
3417
3418         pin->packet = b.data;
3419         pin->packet_len = b.size;
3420
3421         pin->buffer_id = ntohl(opi->buffer_id);
3422         error = ofputil_port_from_ofp11(opi->in_port, &in_port);
3423         if (error) {
3424             return error;
3425         }
3426         match_init_catchall(&pin->flow_metadata);
3427         match_set_in_port(&pin->flow_metadata, in_port);
3428         pin->total_len = ntohs(opi->total_len);
3429         pin->reason = opi->reason;
3430         pin->table_id = opi->table_id;
3431     } else if (raw == OFPRAW_NXT_PACKET_IN) {
3432         const struct nx_packet_in *npi;
3433         int error;
3434
3435         npi = ofpbuf_pull(&b, sizeof *npi);
3436         error = nx_pull_match_loose(&b, ntohs(npi->match_len),
3437                                     &pin->flow_metadata, NULL, NULL);
3438         if (error) {
3439             return error;
3440         }
3441
3442         if (!ofpbuf_try_pull(&b, 2)) {
3443             return OFPERR_OFPBRC_BAD_LEN;
3444         }
3445
3446         pin->reason = npi->reason;
3447         pin->table_id = npi->table_id;
3448         pin->cookie = npi->cookie;
3449
3450         pin->buffer_id = ntohl(npi->buffer_id);
3451         pin->total_len = ntohs(npi->total_len);
3452
3453         pin->packet = b.data;
3454         pin->packet_len = b.size;
3455     } else {
3456         OVS_NOT_REACHED();
3457     }
3458
3459     return 0;
3460 }
3461
3462 static struct ofpbuf *
3463 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in *pin)
3464 {
3465     struct ofp10_packet_in *opi;
3466     struct ofpbuf *packet;
3467
3468     packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
3469                               htonl(0), pin->packet_len);
3470     opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
3471     opi->total_len = htons(pin->total_len);
3472     opi->in_port = htons(ofp_to_u16(pin->flow_metadata.flow.in_port.ofp_port));
3473     opi->reason = pin->reason;
3474     opi->buffer_id = htonl(pin->buffer_id);
3475
3476     ofpbuf_put(packet, pin->packet, pin->packet_len);
3477
3478     return packet;
3479 }
3480
3481 static struct ofpbuf *
3482 ofputil_encode_nx_packet_in(const struct ofputil_packet_in *pin)
3483 {
3484     struct nx_packet_in *npi;
3485     struct ofpbuf *packet;
3486     size_t match_len;
3487
3488     /* The final argument is just an estimate of the space required. */
3489     packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3490                               htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3491     ofpbuf_put_zeros(packet, sizeof *npi);
3492     match_len = nx_put_match(packet, &pin->flow_metadata, 0, 0);
3493     ofpbuf_put_zeros(packet, 2);
3494     ofpbuf_put(packet, pin->packet, pin->packet_len);
3495
3496     npi = packet->msg;
3497     npi->buffer_id = htonl(pin->buffer_id);
3498     npi->total_len = htons(pin->total_len);
3499     npi->reason = pin->reason;
3500     npi->table_id = pin->table_id;
3501     npi->cookie = pin->cookie;
3502     npi->match_len = htons(match_len);
3503
3504     return packet;
3505 }
3506
3507 static struct ofpbuf *
3508 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in *pin)
3509 {
3510     struct ofp11_packet_in *opi;
3511     struct ofpbuf *packet;
3512
3513     packet = ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN, OFP11_VERSION,
3514                               htonl(0), pin->packet_len);
3515     opi = ofpbuf_put_zeros(packet, sizeof *opi);
3516     opi->buffer_id = htonl(pin->buffer_id);
3517     opi->in_port = ofputil_port_to_ofp11(pin->flow_metadata.flow.in_port.ofp_port);
3518     opi->in_phy_port = opi->in_port;
3519     opi->total_len = htons(pin->total_len);
3520     opi->reason = pin->reason;
3521     opi->table_id = pin->table_id;
3522
3523     ofpbuf_put(packet, pin->packet, pin->packet_len);
3524
3525     return packet;
3526 }
3527
3528 static struct ofpbuf *
3529 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in *pin,
3530                                enum ofputil_protocol protocol)
3531 {
3532     struct ofp13_packet_in *opi;
3533     enum ofpraw packet_in_raw;
3534     enum ofp_version packet_in_version;
3535     size_t packet_in_size;
3536     struct ofpbuf *packet;
3537
3538     if (protocol == OFPUTIL_P_OF12_OXM) {
3539         packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
3540         packet_in_version = OFP12_VERSION;
3541         packet_in_size = sizeof (struct ofp12_packet_in);
3542     } else {
3543         packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
3544         packet_in_version = ofputil_protocol_to_ofp_version(protocol);
3545         packet_in_size = sizeof (struct ofp13_packet_in);
3546     }
3547
3548     /* The final argument is just an estimate of the space required. */
3549     packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
3550                               htonl(0), NXM_TYPICAL_LEN + 2 + pin->packet_len);
3551     ofpbuf_put_zeros(packet, packet_in_size);
3552     oxm_put_match(packet, &pin->flow_metadata,
3553                   ofputil_protocol_to_ofp_version(protocol));
3554     ofpbuf_put_zeros(packet, 2);
3555     ofpbuf_put(packet, pin->packet, pin->packet_len);
3556
3557     opi = packet->msg;
3558     opi->pi.buffer_id = htonl(pin->buffer_id);
3559     opi->pi.total_len = htons(pin->total_len);
3560     opi->pi.reason = pin->reason;
3561     opi->pi.table_id = pin->table_id;
3562     if (protocol != OFPUTIL_P_OF12_OXM) {
3563         opi->cookie = pin->cookie;
3564     }
3565
3566     return packet;
3567 }
3568
3569 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3570  * in the format specified by 'packet_in_format'.  */
3571 struct ofpbuf *
3572 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
3573                          enum ofputil_protocol protocol,
3574                          enum nx_packet_in_format packet_in_format)
3575 {
3576     struct ofpbuf *packet;
3577
3578     switch (protocol) {
3579     case OFPUTIL_P_OF10_STD:
3580     case OFPUTIL_P_OF10_STD_TID:
3581     case OFPUTIL_P_OF10_NXM:
3582     case OFPUTIL_P_OF10_NXM_TID:
3583         packet = (packet_in_format == NXPIF_NXM
3584                   ? ofputil_encode_nx_packet_in(pin)
3585                   : ofputil_encode_ofp10_packet_in(pin));
3586         break;
3587
3588     case OFPUTIL_P_OF11_STD:
3589         packet = ofputil_encode_ofp11_packet_in(pin);
3590         break;
3591
3592     case OFPUTIL_P_OF12_OXM:
3593     case OFPUTIL_P_OF13_OXM:
3594     case OFPUTIL_P_OF14_OXM:
3595     case OFPUTIL_P_OF15_OXM:
3596         packet = ofputil_encode_ofp12_packet_in(pin, protocol);
3597         break;
3598
3599     default:
3600         OVS_NOT_REACHED();
3601     }
3602
3603     ofpmsg_update_length(packet);
3604     return packet;
3605 }
3606
3607 /* Returns a string form of 'reason'.  The return value is either a statically
3608  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3609  * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3610 const char *
3611 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3612                                    char *reasonbuf, size_t bufsize)
3613 {
3614     switch (reason) {
3615     case OFPR_NO_MATCH:
3616         return "no_match";
3617     case OFPR_ACTION:
3618         return "action";
3619     case OFPR_INVALID_TTL:
3620         return "invalid_ttl";
3621     case OFPR_ACTION_SET:
3622         return "action_set";
3623     case OFPR_GROUP:
3624         return "group";
3625     case OFPR_PACKET_OUT:
3626         return "packet_out";
3627
3628     case OFPR_N_REASONS:
3629     default:
3630         snprintf(reasonbuf, bufsize, "%d", (int) reason);
3631         return reasonbuf;
3632     }
3633 }
3634
3635 bool
3636 ofputil_packet_in_reason_from_string(const char *s,
3637                                      enum ofp_packet_in_reason *reason)
3638 {
3639     int i;
3640
3641     for (i = 0; i < OFPR_N_REASONS; i++) {
3642         char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3643         const char *reason_s;
3644
3645         reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3646                                                       sizeof reasonbuf);
3647         if (!strcasecmp(s, reason_s)) {
3648             *reason = i;
3649             return true;
3650         }
3651     }
3652     return false;
3653 }
3654
3655 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3656  * 'po'.
3657  *
3658  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3659  * message's actions.  The caller must initialize 'ofpacts' and retains
3660  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
3661  *
3662  * Returns 0 if successful, otherwise an OFPERR_* value. */
3663 enum ofperr
3664 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3665                           const struct ofp_header *oh,
3666                           struct ofpbuf *ofpacts)
3667 {
3668     enum ofpraw raw;
3669     struct ofpbuf b;
3670
3671     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3672     raw = ofpraw_pull_assert(&b);
3673
3674     if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3675         enum ofperr error;
3676         const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3677
3678         po->buffer_id = ntohl(opo->buffer_id);
3679         error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3680         if (error) {
3681             return error;
3682         }
3683
3684         error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3685                                               oh->version, ofpacts);
3686         if (error) {
3687             return error;
3688         }
3689     } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3690         enum ofperr error;
3691         const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3692
3693         po->buffer_id = ntohl(opo->buffer_id);
3694         po->in_port = u16_to_ofp(ntohs(opo->in_port));
3695
3696         error = ofpacts_pull_openflow_actions(&b, ntohs(opo->actions_len),
3697                                               oh->version, ofpacts);
3698         if (error) {
3699             return error;
3700         }
3701     } else {
3702         OVS_NOT_REACHED();
3703     }
3704
3705     if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3706         && po->in_port != OFPP_LOCAL
3707         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3708         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3709                      po->in_port);
3710         return OFPERR_OFPBRC_BAD_PORT;
3711     }
3712
3713     po->ofpacts = ofpacts->data;
3714     po->ofpacts_len = ofpacts->size;
3715
3716     if (po->buffer_id == UINT32_MAX) {
3717         po->packet = b.data;
3718         po->packet_len = b.size;
3719     } else {
3720         po->packet = NULL;
3721         po->packet_len = 0;
3722     }
3723
3724     return 0;
3725 }
3726 \f
3727 /* ofputil_phy_port */
3728
3729 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3730 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
3731 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
3732 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
3733 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
3734 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
3735 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
3736 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
3737
3738 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3739 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3740 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3741 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3742 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3743 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3744
3745 static enum netdev_features
3746 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3747 {
3748     uint32_t ofp10 = ntohl(ofp10_);
3749     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3750 }
3751
3752 static ovs_be32
3753 netdev_port_features_to_ofp10(enum netdev_features features)
3754 {
3755     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3756 }
3757
3758 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
3759 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
3760 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
3761 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
3762 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
3763 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
3764 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
3765 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
3766 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
3767 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
3768 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
3769 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
3770 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
3771 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
3772 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
3773 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3774
3775 static enum netdev_features
3776 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3777 {
3778     return ntohl(ofp11) & 0xffff;
3779 }
3780
3781 static ovs_be32
3782 netdev_port_features_to_ofp11(enum netdev_features features)
3783 {
3784     return htonl(features & 0xffff);
3785 }
3786
3787 static enum ofperr
3788 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3789                               const struct ofp10_phy_port *opp)
3790 {
3791     pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3792     pp->hw_addr = opp->hw_addr;
3793     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3794
3795     pp->config = ntohl(opp->config) & OFPPC10_ALL;
3796     pp->state = ntohl(opp->state) & OFPPS10_ALL;
3797
3798     pp->curr = netdev_port_features_from_ofp10(opp->curr);
3799     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3800     pp->supported = netdev_port_features_from_ofp10(opp->supported);
3801     pp->peer = netdev_port_features_from_ofp10(opp->peer);
3802
3803     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3804     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3805
3806     return 0;
3807 }
3808
3809 static enum ofperr
3810 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3811                           const struct ofp11_port *op)
3812 {
3813     enum ofperr error;
3814
3815     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3816     if (error) {
3817         return error;
3818     }
3819     pp->hw_addr = op->hw_addr;
3820     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3821
3822     pp->config = ntohl(op->config) & OFPPC11_ALL;
3823     pp->state = ntohl(op->state) & OFPPS11_ALL;
3824
3825     pp->curr = netdev_port_features_from_ofp11(op->curr);
3826     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3827     pp->supported = netdev_port_features_from_ofp11(op->supported);
3828     pp->peer = netdev_port_features_from_ofp11(op->peer);
3829
3830     pp->curr_speed = ntohl(op->curr_speed);
3831     pp->max_speed = ntohl(op->max_speed);
3832
3833     return 0;
3834 }
3835
3836 static enum ofperr
3837 parse_ofp14_port_ethernet_property(const struct ofpbuf *payload,
3838                                    struct ofputil_phy_port *pp)
3839 {
3840     struct ofp14_port_desc_prop_ethernet *eth = payload->data;
3841
3842     if (payload->size != sizeof *eth) {
3843         return OFPERR_OFPBPC_BAD_LEN;
3844     }
3845
3846     pp->curr = netdev_port_features_from_ofp11(eth->curr);
3847     pp->advertised = netdev_port_features_from_ofp11(eth->advertised);
3848     pp->supported = netdev_port_features_from_ofp11(eth->supported);
3849     pp->peer = netdev_port_features_from_ofp11(eth->peer);
3850
3851     pp->curr_speed = ntohl(eth->curr_speed);
3852     pp->max_speed = ntohl(eth->max_speed);
3853
3854     return 0;
3855 }
3856
3857 static enum ofperr
3858 ofputil_pull_ofp14_port(struct ofputil_phy_port *pp, struct ofpbuf *msg)
3859 {
3860     struct ofpbuf properties;
3861     struct ofp14_port *op;
3862     enum ofperr error;
3863     size_t len;
3864
3865     op = ofpbuf_try_pull(msg, sizeof *op);
3866     if (!op) {
3867         return OFPERR_OFPBRC_BAD_LEN;
3868     }
3869
3870     len = ntohs(op->length);
3871     if (len < sizeof *op || len - sizeof *op > msg->size) {
3872         return OFPERR_OFPBRC_BAD_LEN;
3873     }
3874     len -= sizeof *op;
3875     ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
3876
3877     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3878     if (error) {
3879         return error;
3880     }
3881     pp->hw_addr = op->hw_addr;
3882     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3883
3884     pp->config = ntohl(op->config) & OFPPC11_ALL;
3885     pp->state = ntohl(op->state) & OFPPS11_ALL;
3886
3887     while (properties.size > 0) {
3888         struct ofpbuf payload;
3889         enum ofperr error;
3890         uint16_t type;
3891
3892         error = ofputil_pull_property(&properties, &payload, &type);
3893         if (error) {
3894             return error;
3895         }
3896
3897         switch (type) {
3898         case OFPPDPT14_ETHERNET:
3899             error = parse_ofp14_port_ethernet_property(&payload, pp);
3900             break;
3901
3902         default:
3903             log_property(true, "unknown port property %"PRIu16, type);
3904             error = 0;
3905             break;
3906         }
3907
3908         if (error) {
3909             return error;
3910         }
3911     }
3912
3913     return 0;
3914 }
3915
3916 static void
3917 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3918                               struct ofp10_phy_port *opp)
3919 {
3920     memset(opp, 0, sizeof *opp);
3921
3922     opp->port_no = htons(ofp_to_u16(pp->port_no));
3923     opp->hw_addr = pp->hw_addr;
3924     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3925
3926     opp->config = htonl(pp->config & OFPPC10_ALL);
3927     opp->state = htonl(pp->state & OFPPS10_ALL);
3928
3929     opp->curr = netdev_port_features_to_ofp10(pp->curr);
3930     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3931     opp->supported = netdev_port_features_to_ofp10(pp->supported);
3932     opp->peer = netdev_port_features_to_ofp10(pp->peer);
3933 }
3934
3935 static void
3936 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3937                           struct ofp11_port *op)
3938 {
3939     memset(op, 0, sizeof *op);
3940
3941     op->port_no = ofputil_port_to_ofp11(pp->port_no);
3942     op->hw_addr = pp->hw_addr;
3943     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3944
3945     op->config = htonl(pp->config & OFPPC11_ALL);
3946     op->state = htonl(pp->state & OFPPS11_ALL);
3947
3948     op->curr = netdev_port_features_to_ofp11(pp->curr);
3949     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3950     op->supported = netdev_port_features_to_ofp11(pp->supported);
3951     op->peer = netdev_port_features_to_ofp11(pp->peer);
3952
3953     op->curr_speed = htonl(pp->curr_speed);
3954     op->max_speed = htonl(pp->max_speed);
3955 }
3956
3957 static void
3958 ofputil_put_ofp14_port(const struct ofputil_phy_port *pp,
3959                        struct ofpbuf *b)
3960 {
3961     struct ofp14_port *op;
3962     struct ofp14_port_desc_prop_ethernet *eth;
3963
3964     ofpbuf_prealloc_tailroom(b, sizeof *op + sizeof *eth);
3965
3966     op = ofpbuf_put_zeros(b, sizeof *op);
3967     op->port_no = ofputil_port_to_ofp11(pp->port_no);
3968     op->length = htons(sizeof *op + sizeof *eth);
3969     op->hw_addr = pp->hw_addr;
3970     ovs_strlcpy(op->name, pp->name, sizeof op->name);
3971     op->config = htonl(pp->config & OFPPC11_ALL);
3972     op->state = htonl(pp->state & OFPPS11_ALL);
3973
3974     eth = ofpbuf_put_zeros(b, sizeof *eth);
3975     eth->type = htons(OFPPDPT14_ETHERNET);
3976     eth->length = htons(sizeof *eth);
3977     eth->curr = netdev_port_features_to_ofp11(pp->curr);
3978     eth->advertised = netdev_port_features_to_ofp11(pp->advertised);
3979     eth->supported = netdev_port_features_to_ofp11(pp->supported);
3980     eth->peer = netdev_port_features_to_ofp11(pp->peer);
3981     eth->curr_speed = htonl(pp->curr_speed);
3982     eth->max_speed = htonl(pp->max_speed);
3983 }
3984
3985 static void
3986 ofputil_put_phy_port(enum ofp_version ofp_version,
3987                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
3988 {
3989     switch (ofp_version) {
3990     case OFP10_VERSION: {
3991         struct ofp10_phy_port *opp = ofpbuf_put_uninit(b, sizeof *opp);
3992         ofputil_encode_ofp10_phy_port(pp, opp);
3993         break;
3994     }
3995
3996     case OFP11_VERSION:
3997     case OFP12_VERSION:
3998     case OFP13_VERSION: {
3999         struct ofp11_port *op = ofpbuf_put_uninit(b, sizeof *op);
4000         ofputil_encode_ofp11_port(pp, op);
4001         break;
4002     }
4003
4004     case OFP14_VERSION:
4005     case OFP15_VERSION:
4006         ofputil_put_ofp14_port(pp, b);
4007         break;
4008
4009     default:
4010         OVS_NOT_REACHED();
4011     }
4012 }
4013
4014 enum ofperr
4015 ofputil_decode_port_desc_stats_request(const struct ofp_header *request,
4016                                        ofp_port_t *port)
4017 {
4018     struct ofpbuf b;
4019     enum ofpraw raw;
4020
4021     ofpbuf_use_const(&b, request, ntohs(request->length));
4022     raw = ofpraw_pull_assert(&b);
4023     if (raw == OFPRAW_OFPST10_PORT_DESC_REQUEST) {
4024         *port = OFPP_ANY;
4025         return 0;
4026     } else if (raw == OFPRAW_OFPST15_PORT_DESC_REQUEST) {
4027         ovs_be32 *ofp11_port;
4028
4029         ofp11_port = ofpbuf_pull(&b, sizeof *ofp11_port);
4030         return ofputil_port_from_ofp11(*ofp11_port, port);
4031     } else {
4032         OVS_NOT_REACHED();
4033     }
4034 }
4035
4036 struct ofpbuf *
4037 ofputil_encode_port_desc_stats_request(enum ofp_version ofp_version,
4038                                        ofp_port_t port)
4039 {
4040     struct ofpbuf *request;
4041
4042     switch (ofp_version) {
4043     case OFP10_VERSION:
4044     case OFP11_VERSION:
4045     case OFP12_VERSION:
4046     case OFP13_VERSION:
4047     case OFP14_VERSION:
4048         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_DESC_REQUEST,
4049                                ofp_version, 0);
4050         break;
4051     case OFP15_VERSION:{
4052         struct ofp15_port_desc_request *req;
4053         request = ofpraw_alloc(OFPRAW_OFPST15_PORT_DESC_REQUEST,
4054                                ofp_version, 0);
4055         req = ofpbuf_put_zeros(request, sizeof *req);
4056         req->port_no = ofputil_port_to_ofp11(port);
4057         break;
4058     }
4059     default:
4060         OVS_NOT_REACHED();
4061     }
4062
4063     return request;
4064 }
4065
4066 void
4067 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
4068                                      struct ovs_list *replies)
4069 {
4070     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4071     size_t start_ofs = reply->size;
4072
4073     ofputil_put_phy_port(ofpmp_version(replies), pp, reply);
4074     ofpmp_postappend(replies, start_ofs);
4075 }
4076 \f
4077 /* ofputil_switch_features */
4078
4079 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
4080                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
4081 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
4082 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
4083 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
4084 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
4085 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
4086 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
4087
4088 static uint32_t
4089 ofputil_capabilities_mask(enum ofp_version ofp_version)
4090 {
4091     /* Handle capabilities whose bit is unique for all OpenFlow versions */
4092     switch (ofp_version) {
4093     case OFP10_VERSION:
4094     case OFP11_VERSION:
4095         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
4096     case OFP12_VERSION:
4097     case OFP13_VERSION:
4098     case OFP14_VERSION:
4099     case OFP15_VERSION:
4100         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
4101     default:
4102         /* Caller needs to check osf->header.version itself */
4103         return 0;
4104     }
4105 }
4106
4107 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
4108  * abstract representation in '*features'.  Initializes '*b' to iterate over
4109  * the OpenFlow port structures following 'osf' with later calls to
4110  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
4111  * OFPERR_* value.  */
4112 enum ofperr
4113 ofputil_decode_switch_features(const struct ofp_header *oh,
4114                                struct ofputil_switch_features *features,
4115                                struct ofpbuf *b)
4116 {
4117     const struct ofp_switch_features *osf;
4118     enum ofpraw raw;
4119
4120     ofpbuf_use_const(b, oh, ntohs(oh->length));
4121     raw = ofpraw_pull_assert(b);
4122
4123     osf = ofpbuf_pull(b, sizeof *osf);
4124     features->datapath_id = ntohll(osf->datapath_id);
4125     features->n_buffers = ntohl(osf->n_buffers);
4126     features->n_tables = osf->n_tables;
4127     features->auxiliary_id = 0;
4128
4129     features->capabilities = ntohl(osf->capabilities) &
4130         ofputil_capabilities_mask(oh->version);
4131
4132     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
4133         if (osf->capabilities & htonl(OFPC10_STP)) {
4134             features->capabilities |= OFPUTIL_C_STP;
4135         }
4136         features->ofpacts = ofpact_bitmap_from_openflow(osf->actions,
4137                                                         OFP10_VERSION);
4138     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
4139                || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4140         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
4141             features->capabilities |= OFPUTIL_C_GROUP_STATS;
4142         }
4143         features->ofpacts = 0;
4144         if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
4145             features->auxiliary_id = osf->auxiliary_id;
4146         }
4147     } else {
4148         return OFPERR_OFPBRC_BAD_VERSION;
4149     }
4150
4151     return 0;
4152 }
4153
4154 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4155  * switch's ports, unless there are too many to fit.  In OpenFlow 1.3 and
4156  * later, an OFPT_FEATURES_REPLY does not list ports at all.
4157  *
4158  * Given a buffer 'b' that contains a Features Reply message, this message
4159  * checks if it contains a complete list of the switch's ports.  Returns true,
4160  * if so.  Returns false if the list is missing (OF1.3+) or incomplete
4161  * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4162  * message.
4163  *
4164  * When this function returns false, the caller should send an OFPST_PORT_DESC
4165  * stats request to get the ports. */
4166 bool
4167 ofputil_switch_features_has_ports(struct ofpbuf *b)
4168 {
4169     struct ofp_header *oh = b->data;
4170     size_t phy_port_size;
4171
4172     if (oh->version >= OFP13_VERSION) {
4173         /* OpenFlow 1.3+ never has ports in the feature reply. */
4174         return false;
4175     }
4176
4177     phy_port_size = (oh->version == OFP10_VERSION
4178                      ? sizeof(struct ofp10_phy_port)
4179                      : sizeof(struct ofp11_port));
4180     if (ntohs(oh->length) + phy_port_size <= UINT16_MAX) {
4181         /* There's room for additional ports in the feature reply.
4182          * Assume that the list is complete. */
4183         return true;
4184     }
4185
4186     /* The feature reply has no room for more ports.  Probably the list is
4187      * truncated.  Drop the ports and tell the caller to retrieve them with
4188      * OFPST_PORT_DESC. */
4189     b->size = sizeof *oh + sizeof(struct ofp_switch_features);
4190     ofpmsg_update_length(b);
4191     return false;
4192 }
4193
4194 /* Returns a buffer owned by the caller that encodes 'features' in the format
4195  * required by 'protocol' with the given 'xid'.  The caller should append port
4196  * information to the buffer with subsequent calls to
4197  * ofputil_put_switch_features_port(). */
4198 struct ofpbuf *
4199 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
4200                                enum ofputil_protocol protocol, ovs_be32 xid)
4201 {
4202     struct ofp_switch_features *osf;
4203     struct ofpbuf *b;
4204     enum ofp_version version;
4205     enum ofpraw raw;
4206
4207     version = ofputil_protocol_to_ofp_version(protocol);
4208     switch (version) {
4209     case OFP10_VERSION:
4210         raw = OFPRAW_OFPT10_FEATURES_REPLY;
4211         break;
4212     case OFP11_VERSION:
4213     case OFP12_VERSION:
4214         raw = OFPRAW_OFPT11_FEATURES_REPLY;
4215         break;
4216     case OFP13_VERSION:
4217     case OFP14_VERSION:
4218     case OFP15_VERSION:
4219         raw = OFPRAW_OFPT13_FEATURES_REPLY;
4220         break;
4221     default:
4222         OVS_NOT_REACHED();
4223     }
4224     b = ofpraw_alloc_xid(raw, version, xid, 0);
4225     osf = ofpbuf_put_zeros(b, sizeof *osf);
4226     osf->datapath_id = htonll(features->datapath_id);
4227     osf->n_buffers = htonl(features->n_buffers);
4228     osf->n_tables = features->n_tables;
4229
4230     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
4231     osf->capabilities = htonl(features->capabilities &
4232                               ofputil_capabilities_mask(version));
4233     switch (version) {
4234     case OFP10_VERSION:
4235         if (features->capabilities & OFPUTIL_C_STP) {
4236             osf->capabilities |= htonl(OFPC10_STP);
4237         }
4238         osf->actions = ofpact_bitmap_to_openflow(features->ofpacts,
4239                                                  OFP10_VERSION);
4240         break;
4241     case OFP13_VERSION:
4242     case OFP14_VERSION:
4243     case OFP15_VERSION:
4244         osf->auxiliary_id = features->auxiliary_id;
4245         /* fall through */
4246     case OFP11_VERSION:
4247     case OFP12_VERSION:
4248         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
4249             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
4250         }
4251         break;
4252     default:
4253         OVS_NOT_REACHED();
4254     }
4255
4256     return b;
4257 }
4258
4259 /* Encodes 'pp' into the format required by the switch_features message already
4260  * in 'b', which should have been returned by ofputil_encode_switch_features(),
4261  * and appends the encoded version to 'b'. */
4262 void
4263 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
4264                                  struct ofpbuf *b)
4265 {
4266     const struct ofp_header *oh = b->data;
4267
4268     if (oh->version < OFP13_VERSION) {
4269         /* Try adding a port description to the message, but drop it again if
4270          * the buffer overflows.  (This possibility for overflow is why
4271          * OpenFlow 1.3+ moved port descriptions into a multipart message.)  */
4272         size_t start_ofs = b->size;
4273         ofputil_put_phy_port(oh->version, pp, b);
4274         if (b->size > UINT16_MAX) {
4275             b->size = start_ofs;
4276         }
4277     }
4278 }
4279 \f
4280 /* ofputil_port_status */
4281
4282 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4283  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
4284 enum ofperr
4285 ofputil_decode_port_status(const struct ofp_header *oh,
4286                            struct ofputil_port_status *ps)
4287 {
4288     const struct ofp_port_status *ops;
4289     struct ofpbuf b;
4290     int retval;
4291
4292     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4293     ofpraw_pull_assert(&b);
4294     ops = ofpbuf_pull(&b, sizeof *ops);
4295
4296     if (ops->reason != OFPPR_ADD &&
4297         ops->reason != OFPPR_DELETE &&
4298         ops->reason != OFPPR_MODIFY) {
4299         return OFPERR_NXBRC_BAD_REASON;
4300     }
4301     ps->reason = ops->reason;
4302
4303     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
4304     ovs_assert(retval != EOF);
4305     return retval;
4306 }
4307
4308 /* Converts the abstract form of a "port status" message in '*ps' into an
4309  * OpenFlow message suitable for 'protocol', and returns that encoded form in
4310  * a buffer owned by the caller. */
4311 struct ofpbuf *
4312 ofputil_encode_port_status(const struct ofputil_port_status *ps,
4313                            enum ofputil_protocol protocol)
4314 {
4315     struct ofp_port_status *ops;
4316     struct ofpbuf *b;
4317     enum ofp_version version;
4318     enum ofpraw raw;
4319
4320     version = ofputil_protocol_to_ofp_version(protocol);
4321     switch (version) {
4322     case OFP10_VERSION:
4323         raw = OFPRAW_OFPT10_PORT_STATUS;
4324         break;
4325
4326     case OFP11_VERSION:
4327     case OFP12_VERSION:
4328     case OFP13_VERSION:
4329         raw = OFPRAW_OFPT11_PORT_STATUS;
4330         break;
4331
4332     case OFP14_VERSION:
4333     case OFP15_VERSION:
4334         raw = OFPRAW_OFPT14_PORT_STATUS;
4335         break;
4336
4337     default:
4338         OVS_NOT_REACHED();
4339     }
4340
4341     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
4342     ops = ofpbuf_put_zeros(b, sizeof *ops);
4343     ops->reason = ps->reason;
4344     ofputil_put_phy_port(version, &ps->desc, b);
4345     ofpmsg_update_length(b);
4346     return b;
4347 }
4348
4349 /* ofputil_port_mod */
4350
4351 static enum ofperr
4352 parse_port_mod_ethernet_property(struct ofpbuf *property,
4353                                  struct ofputil_port_mod *pm)
4354 {
4355     struct ofp14_port_mod_prop_ethernet *eth = property->data;
4356
4357     if (property->size != sizeof *eth) {
4358         return OFPERR_OFPBRC_BAD_LEN;
4359     }
4360
4361     pm->advertise = netdev_port_features_from_ofp11(eth->advertise);
4362     return 0;
4363 }
4364
4365 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4366  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
4367 enum ofperr
4368 ofputil_decode_port_mod(const struct ofp_header *oh,
4369                         struct ofputil_port_mod *pm, bool loose)
4370 {
4371     enum ofpraw raw;
4372     struct ofpbuf b;
4373
4374     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4375     raw = ofpraw_pull_assert(&b);
4376
4377     if (raw == OFPRAW_OFPT10_PORT_MOD) {
4378         const struct ofp10_port_mod *opm = b.data;
4379
4380         pm->port_no = u16_to_ofp(ntohs(opm->port_no));
4381         pm->hw_addr = opm->hw_addr;
4382         pm->config = ntohl(opm->config) & OFPPC10_ALL;
4383         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
4384         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
4385     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
4386         const struct ofp11_port_mod *opm = b.data;
4387         enum ofperr error;
4388
4389         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4390         if (error) {
4391             return error;
4392         }
4393
4394         pm->hw_addr = opm->hw_addr;
4395         pm->config = ntohl(opm->config) & OFPPC11_ALL;
4396         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4397         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
4398     } else if (raw == OFPRAW_OFPT14_PORT_MOD) {
4399         const struct ofp14_port_mod *opm = ofpbuf_pull(&b, sizeof *opm);
4400         enum ofperr error;
4401
4402         memset(pm, 0, sizeof *pm);
4403
4404         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
4405         if (error) {
4406             return error;
4407         }
4408
4409         pm->hw_addr = opm->hw_addr;
4410         pm->config = ntohl(opm->config) & OFPPC11_ALL;
4411         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
4412
4413         while (b.size > 0) {
4414             struct ofpbuf property;
4415             enum ofperr error;
4416             uint16_t type;
4417
4418             error = ofputil_pull_property(&b, &property, &type);
4419             if (error) {
4420                 return error;
4421             }
4422
4423             switch (type) {
4424             case OFPPMPT14_ETHERNET:
4425                 error = parse_port_mod_ethernet_property(&property, pm);
4426                 break;
4427
4428             default:
4429                 log_property(loose, "unknown port_mod property %"PRIu16, type);
4430                 if (loose) {
4431                     error = 0;
4432                 } else if (type == OFPPMPT14_EXPERIMENTER) {
4433                     error = OFPERR_OFPBPC_BAD_EXPERIMENTER;
4434                 } else {
4435                     error = OFPERR_OFPBRC_BAD_TYPE;
4436                 }
4437                 break;
4438             }
4439
4440             if (error) {
4441                 return error;
4442             }
4443         }
4444     } else {
4445         return OFPERR_OFPBRC_BAD_TYPE;
4446     }
4447
4448     pm->config &= pm->mask;
4449     return 0;
4450 }
4451
4452 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4453  * message suitable for 'protocol', and returns that encoded form in a buffer
4454  * owned by the caller. */
4455 struct ofpbuf *
4456 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
4457                         enum ofputil_protocol protocol)
4458 {
4459     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4460     struct ofpbuf *b;
4461
4462     switch (ofp_version) {
4463     case OFP10_VERSION: {
4464         struct ofp10_port_mod *opm;
4465
4466         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
4467         opm = ofpbuf_put_zeros(b, sizeof *opm);
4468         opm->port_no = htons(ofp_to_u16(pm->port_no));
4469         opm->hw_addr = pm->hw_addr;
4470         opm->config = htonl(pm->config & OFPPC10_ALL);
4471         opm->mask = htonl(pm->mask & OFPPC10_ALL);
4472         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
4473         break;
4474     }
4475
4476     case OFP11_VERSION:
4477     case OFP12_VERSION:
4478     case OFP13_VERSION: {
4479         struct ofp11_port_mod *opm;
4480
4481         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
4482         opm = ofpbuf_put_zeros(b, sizeof *opm);
4483         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4484         opm->hw_addr = pm->hw_addr;
4485         opm->config = htonl(pm->config & OFPPC11_ALL);
4486         opm->mask = htonl(pm->mask & OFPPC11_ALL);
4487         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
4488         break;
4489     }
4490     case OFP14_VERSION:
4491     case OFP15_VERSION: {
4492         struct ofp14_port_mod_prop_ethernet *eth;
4493         struct ofp14_port_mod *opm;
4494
4495         b = ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD, ofp_version, sizeof *eth);
4496         opm = ofpbuf_put_zeros(b, sizeof *opm);
4497         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
4498         opm->hw_addr = pm->hw_addr;
4499         opm->config = htonl(pm->config & OFPPC11_ALL);
4500         opm->mask = htonl(pm->mask & OFPPC11_ALL);
4501
4502         if (pm->advertise) {
4503             eth = ofpbuf_put_zeros(b, sizeof *eth);
4504             eth->type = htons(OFPPMPT14_ETHERNET);
4505             eth->length = htons(sizeof *eth);
4506             eth->advertise = netdev_port_features_to_ofp11(pm->advertise);
4507         }
4508         break;
4509     }
4510     default:
4511         OVS_NOT_REACHED();
4512     }
4513
4514     return b;
4515 }
4516 \f
4517 /* Table features. */
4518
4519 static enum ofperr
4520 pull_table_feature_property(struct ofpbuf *msg, struct ofpbuf *payload,
4521                             uint16_t *typep)
4522 {
4523     enum ofperr error;
4524
4525     error = ofputil_pull_property(msg, payload, typep);
4526     if (payload && !error) {
4527         ofpbuf_pull(payload, sizeof(struct ofp_prop_header));
4528     }
4529     return error;
4530 }
4531
4532 static enum ofperr
4533 parse_action_bitmap(struct ofpbuf *payload, enum ofp_version ofp_version,
4534                     uint64_t *ofpacts)
4535 {
4536     uint32_t types = 0;
4537
4538     while (payload->size > 0) {
4539         uint16_t type;
4540         enum ofperr error;
4541
4542         error = ofputil_pull_property__(payload, NULL, 1, &type);
4543         if (error) {
4544             return error;
4545         }
4546         if (type < CHAR_BIT * sizeof types) {
4547             types |= 1u << type;
4548         }
4549     }
4550
4551     *ofpacts = ofpact_bitmap_from_openflow(htonl(types), ofp_version);
4552     return 0;
4553 }
4554
4555 static enum ofperr
4556 parse_instruction_ids(struct ofpbuf *payload, bool loose, uint32_t *insts)
4557 {
4558     *insts = 0;
4559     while (payload->size > 0) {
4560         enum ovs_instruction_type inst;
4561         enum ofperr error;
4562         uint16_t ofpit;
4563
4564         /* OF1.3 and OF1.4 aren't clear about padding in the instruction IDs.
4565          * It seems clear that they aren't padded to 8 bytes, though, because
4566          * both standards say that "non-experimenter instructions are 4 bytes"
4567          * and do not mention any padding before the first instruction ID.
4568          * (There wouldn't be any point in padding to 8 bytes if the IDs were
4569          * aligned on an odd 4-byte boundary.)
4570          *
4571          * Anyway, we just assume they're all glommed together on byte
4572          * boundaries. */
4573         error = ofputil_pull_property__(payload, NULL, 1, &ofpit);
4574         if (error) {
4575             return error;
4576         }
4577
4578         error = ovs_instruction_type_from_inst_type(&inst, ofpit);
4579         if (!error) {
4580             *insts |= 1u << inst;
4581         } else if (!loose) {
4582             return error;
4583         }
4584     }
4585     return 0;
4586 }
4587
4588 static enum ofperr
4589 parse_table_features_next_table(struct ofpbuf *payload,
4590                                 unsigned long int *next_tables)
4591 {
4592     size_t i;
4593
4594     memset(next_tables, 0, bitmap_n_bytes(255));
4595     for (i = 0; i < payload->size; i++) {
4596         uint8_t id = ((const uint8_t *) payload->data)[i];
4597         if (id >= 255) {
4598             return OFPERR_OFPBPC_BAD_VALUE;
4599         }
4600         bitmap_set1(next_tables, id);
4601     }
4602     return 0;
4603 }
4604
4605 static enum ofperr
4606 parse_oxms(struct ofpbuf *payload, bool loose,
4607            struct mf_bitmap *exactp, struct mf_bitmap *maskedp)
4608 {
4609     struct mf_bitmap exact = MF_BITMAP_INITIALIZER;
4610     struct mf_bitmap masked = MF_BITMAP_INITIALIZER;
4611
4612     while (payload->size > 0) {
4613         const struct mf_field *field;
4614         enum ofperr error;
4615         bool hasmask;
4616
4617         error = nx_pull_header(payload, &field, &hasmask);
4618         if (!error) {
4619             bitmap_set1(hasmask ? masked.bm : exact.bm, field->id);
4620         } else if (error != OFPERR_OFPBMC_BAD_FIELD || !loose) {
4621             return error;
4622         }
4623     }
4624     if (exactp) {
4625         *exactp = exact;
4626     } else if (!bitmap_is_all_zeros(exact.bm, MFF_N_IDS)) {
4627         return OFPERR_OFPBMC_BAD_MASK;
4628     }
4629     if (maskedp) {
4630         *maskedp = masked;
4631     } else if (!bitmap_is_all_zeros(masked.bm, MFF_N_IDS)) {
4632         return OFPERR_OFPBMC_BAD_MASK;
4633     }
4634     return 0;
4635 }
4636
4637 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
4638  * ofputil_table_features in 'tf'.
4639  *
4640  * If 'loose' is true, this function ignores properties and values that it does
4641  * not understand, as a controller would want to do when interpreting
4642  * capabilities provided by a switch.  If 'loose' is false, this function
4643  * treats unknown properties and values as an error, as a switch would want to
4644  * do when interpreting a configuration request made by a controller.
4645  *
4646  * A single OpenFlow message can specify features for multiple tables.  Calling
4647  * this function multiple times for a single 'msg' iterates through the tables
4648  * in the message.  The caller must initially leave 'msg''s layer pointers null
4649  * and not modify them between calls.
4650  *
4651  * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
4652  * a positive "enum ofperr" value. */
4653 int
4654 ofputil_decode_table_features(struct ofpbuf *msg,
4655                               struct ofputil_table_features *tf, bool loose)
4656 {
4657     const struct ofp_header *oh;
4658     struct ofp13_table_features *otf;
4659     struct ofpbuf properties;
4660     unsigned int len;
4661
4662     memset(tf, 0, sizeof *tf);
4663
4664     if (!msg->header) {
4665         ofpraw_pull_assert(msg);
4666     }
4667     oh = msg->header;
4668
4669     if (!msg->size) {
4670         return EOF;
4671     }
4672
4673     if (msg->size < sizeof *otf) {
4674         return OFPERR_OFPBPC_BAD_LEN;
4675     }
4676
4677     otf = msg->data;
4678     len = ntohs(otf->length);
4679     if (len < sizeof *otf || len % 8 || len > msg->size) {
4680         return OFPERR_OFPBPC_BAD_LEN;
4681     }
4682     ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
4683     ofpbuf_pull(&properties, sizeof *otf);
4684
4685     tf->table_id = otf->table_id;
4686     if (tf->table_id == OFPTT_ALL) {
4687         return OFPERR_OFPTFFC_BAD_TABLE;
4688     }
4689
4690     ovs_strlcpy(tf->name, otf->name, OFP_MAX_TABLE_NAME_LEN);
4691     tf->metadata_match = otf->metadata_match;
4692     tf->metadata_write = otf->metadata_write;
4693     tf->miss_config = OFPUTIL_TABLE_MISS_DEFAULT;
4694     if (oh->version >= OFP14_VERSION) {
4695         uint32_t caps = ntohl(otf->capabilities);
4696         tf->supports_eviction = (caps & OFPTC14_EVICTION) != 0;
4697         tf->supports_vacancy_events = (caps & OFPTC14_VACANCY_EVENTS) != 0;
4698     } else {
4699         tf->supports_eviction = -1;
4700         tf->supports_vacancy_events = -1;
4701     }
4702     tf->max_entries = ntohl(otf->max_entries);
4703
4704     while (properties.size > 0) {
4705         struct ofpbuf payload;
4706         enum ofperr error;
4707         uint16_t type;
4708
4709         error = pull_table_feature_property(&properties, &payload, &type);
4710         if (error) {
4711             return error;
4712         }
4713
4714         switch ((enum ofp13_table_feature_prop_type) type) {
4715         case OFPTFPT13_INSTRUCTIONS:
4716             error = parse_instruction_ids(&payload, loose,
4717                                           &tf->nonmiss.instructions);
4718             break;
4719         case OFPTFPT13_INSTRUCTIONS_MISS:
4720             error = parse_instruction_ids(&payload, loose,
4721                                           &tf->miss.instructions);
4722             break;
4723
4724         case OFPTFPT13_NEXT_TABLES:
4725             error = parse_table_features_next_table(&payload,
4726                                                     tf->nonmiss.next);
4727             break;
4728         case OFPTFPT13_NEXT_TABLES_MISS:
4729             error = parse_table_features_next_table(&payload, tf->miss.next);
4730             break;
4731
4732         case OFPTFPT13_WRITE_ACTIONS:
4733             error = parse_action_bitmap(&payload, oh->version,
4734                                         &tf->nonmiss.write.ofpacts);
4735             break;
4736         case OFPTFPT13_WRITE_ACTIONS_MISS:
4737             error = parse_action_bitmap(&payload, oh->version,
4738                                         &tf->miss.write.ofpacts);
4739             break;
4740
4741         case OFPTFPT13_APPLY_ACTIONS:
4742             error = parse_action_bitmap(&payload, oh->version,
4743                                         &tf->nonmiss.apply.ofpacts);
4744             break;
4745         case OFPTFPT13_APPLY_ACTIONS_MISS:
4746             error = parse_action_bitmap(&payload, oh->version,
4747                                         &tf->miss.apply.ofpacts);
4748             break;
4749
4750         case OFPTFPT13_MATCH:
4751             error = parse_oxms(&payload, loose, &tf->match, &tf->mask);
4752             break;
4753         case OFPTFPT13_WILDCARDS:
4754             error = parse_oxms(&payload, loose, &tf->wildcard, NULL);
4755             break;
4756
4757         case OFPTFPT13_WRITE_SETFIELD:
4758             error = parse_oxms(&payload, loose,
4759                                &tf->nonmiss.write.set_fields, NULL);
4760             break;
4761         case OFPTFPT13_WRITE_SETFIELD_MISS:
4762             error = parse_oxms(&payload, loose,
4763                                &tf->miss.write.set_fields, NULL);
4764             break;
4765         case OFPTFPT13_APPLY_SETFIELD:
4766             error = parse_oxms(&payload, loose,
4767                                &tf->nonmiss.apply.set_fields, NULL);
4768             break;
4769         case OFPTFPT13_APPLY_SETFIELD_MISS:
4770             error = parse_oxms(&payload, loose,
4771                                &tf->miss.apply.set_fields, NULL);
4772             break;
4773
4774         case OFPTFPT13_EXPERIMENTER:
4775         case OFPTFPT13_EXPERIMENTER_MISS:
4776         default:
4777             log_property(loose, "unknown table features property %"PRIu16,
4778                          type);
4779             error = loose ? 0 : OFPERR_OFPBPC_BAD_TYPE;
4780             break;
4781         }
4782         if (error) {
4783             return error;
4784         }
4785     }
4786
4787     /* Fix inconsistencies:
4788      *
4789      *     - Turn on 'match' bits that are set in 'mask', because maskable
4790      *       fields are matchable.
4791      *
4792      *     - Turn on 'wildcard' bits that are set in 'mask', because a field
4793      *       that is arbitrarily maskable can be wildcarded entirely.
4794      *
4795      *     - Turn off 'wildcard' bits that are not in 'match', because a field
4796      *       must be matchable for it to be meaningfully wildcarded. */
4797     bitmap_or(tf->match.bm, tf->mask.bm, MFF_N_IDS);
4798     bitmap_or(tf->wildcard.bm, tf->mask.bm, MFF_N_IDS);
4799     bitmap_and(tf->wildcard.bm, tf->match.bm, MFF_N_IDS);
4800
4801     return 0;
4802 }
4803
4804 /* Encodes and returns a request to obtain the table features of a switch.
4805  * The message is encoded for OpenFlow version 'ofp_version'. */
4806 struct ofpbuf *
4807 ofputil_encode_table_features_request(enum ofp_version ofp_version)
4808 {
4809     struct ofpbuf *request = NULL;
4810
4811     switch (ofp_version) {
4812     case OFP10_VERSION:
4813     case OFP11_VERSION:
4814     case OFP12_VERSION:
4815         ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
4816                      "(\'-O OpenFlow13\')");
4817     case OFP13_VERSION:
4818     case OFP14_VERSION:
4819     case OFP15_VERSION:
4820         request = ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
4821                                ofp_version, 0);
4822         break;
4823     default:
4824         OVS_NOT_REACHED();
4825     }
4826
4827     return request;
4828 }
4829
4830 static void
4831 put_fields_property(struct ofpbuf *reply,
4832                     const struct mf_bitmap *fields,
4833                     const struct mf_bitmap *masks,
4834                     enum ofp13_table_feature_prop_type property,
4835                     enum ofp_version version)
4836 {
4837     size_t start_ofs;
4838     int field;
4839
4840     start_ofs = start_property(reply, property);
4841     BITMAP_FOR_EACH_1 (field, MFF_N_IDS, fields->bm) {
4842         nx_put_header(reply, field, version,
4843                       masks && bitmap_is_set(masks->bm, field));
4844     }
4845     end_property(reply, start_ofs);
4846 }
4847
4848 static void
4849 put_table_action_features(struct ofpbuf *reply,
4850                           const struct ofputil_table_action_features *taf,
4851                           enum ofp13_table_feature_prop_type actions_type,
4852                           enum ofp13_table_feature_prop_type set_fields_type,
4853                           int miss_offset, enum ofp_version version)
4854 {
4855     size_t start_ofs;
4856
4857     start_ofs = start_property(reply, actions_type + miss_offset);
4858     put_bitmap_properties(reply,
4859                           ntohl(ofpact_bitmap_to_openflow(taf->ofpacts,
4860                                                           version)));
4861     end_property(reply, start_ofs);
4862
4863     put_fields_property(reply, &taf->set_fields, NULL,
4864                         set_fields_type + miss_offset, version);
4865 }
4866
4867 static void
4868 put_table_instruction_features(
4869     struct ofpbuf *reply, const struct ofputil_table_instruction_features *tif,
4870     int miss_offset, enum ofp_version version)
4871 {
4872     size_t start_ofs;
4873     uint8_t table_id;
4874
4875     start_ofs = start_property(reply, OFPTFPT13_INSTRUCTIONS + miss_offset);
4876     put_bitmap_properties(reply,
4877                           ntohl(ovsinst_bitmap_to_openflow(tif->instructions,
4878                                                            version)));
4879     end_property(reply, start_ofs);
4880
4881     start_ofs = start_property(reply, OFPTFPT13_NEXT_TABLES + miss_offset);
4882     BITMAP_FOR_EACH_1 (table_id, 255, tif->next) {
4883         ofpbuf_put(reply, &table_id, 1);
4884     }
4885     end_property(reply, start_ofs);
4886
4887     put_table_action_features(reply, &tif->write,
4888                               OFPTFPT13_WRITE_ACTIONS,
4889                               OFPTFPT13_WRITE_SETFIELD, miss_offset, version);
4890     put_table_action_features(reply, &tif->apply,
4891                               OFPTFPT13_APPLY_ACTIONS,
4892                               OFPTFPT13_APPLY_SETFIELD, miss_offset, version);
4893 }
4894
4895 void
4896 ofputil_append_table_features_reply(const struct ofputil_table_features *tf,
4897                                     struct ovs_list *replies)
4898 {
4899     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
4900     enum ofp_version version = ofpmp_version(replies);
4901     size_t start_ofs = reply->size;
4902     struct ofp13_table_features *otf;
4903
4904     otf = ofpbuf_put_zeros(reply, sizeof *otf);
4905     otf->table_id = tf->table_id;
4906     ovs_strlcpy(otf->name, tf->name, sizeof otf->name);
4907     otf->metadata_match = tf->metadata_match;
4908     otf->metadata_write = tf->metadata_write;
4909     if (version >= OFP14_VERSION) {
4910         if (tf->supports_eviction) {
4911             otf->capabilities |= htonl(OFPTC14_EVICTION);
4912         }
4913         if (tf->supports_vacancy_events) {
4914             otf->capabilities |= htonl(OFPTC14_VACANCY_EVENTS);
4915         }
4916     }
4917     otf->max_entries = htonl(tf->max_entries);
4918
4919     put_table_instruction_features(reply, &tf->nonmiss, 0, version);
4920     put_table_instruction_features(reply, &tf->miss, 1, version);
4921
4922     put_fields_property(reply, &tf->match, &tf->mask,
4923                         OFPTFPT13_MATCH, version);
4924     put_fields_property(reply, &tf->wildcard, NULL,
4925                         OFPTFPT13_WILDCARDS, version);
4926
4927     otf = ofpbuf_at_assert(reply, start_ofs, sizeof *otf);
4928     otf->length = htons(reply->size - start_ofs);
4929     ofpmp_postappend(replies, start_ofs);
4930 }
4931
4932 static enum ofperr
4933 parse_table_desc_eviction_property(struct ofpbuf *property,
4934                                    struct ofputil_table_desc *td)
4935 {
4936     struct ofp14_table_mod_prop_eviction *ote = property->data;
4937
4938     if (property->size != sizeof *ote) {
4939         return OFPERR_OFPBPC_BAD_LEN;
4940     }
4941
4942     td->eviction_flags = ntohl(ote->flags);
4943     return 0;
4944 }
4945
4946 static enum ofperr
4947 parse_table_desc_vacancy_property(struct ofpbuf *property,
4948                                   struct ofputil_table_desc *td)
4949 {
4950     struct ofp14_table_mod_prop_vacancy *otv = property->data;
4951
4952     if (property->size != sizeof *otv) {
4953         return OFPERR_OFPBPC_BAD_LEN;
4954     }
4955
4956     td->table_vacancy.vacancy_down = otv->vacancy_down;
4957     td->table_vacancy.vacancy_up = otv->vacancy_up;
4958     td->table_vacancy.vacancy = otv->vacancy;
4959     return 0;
4960 }
4961
4962 /* Decodes the next OpenFlow "table desc" message (of possibly several) from
4963  * 'msg' into an abstract form in '*td'.  Returns 0 if successful, EOF if the
4964  * last "table desc" in 'msg' was already decoded, otherwise an OFPERR_*
4965  * value. */
4966 int
4967 ofputil_decode_table_desc(struct ofpbuf *msg,
4968                           struct ofputil_table_desc *td,
4969                           enum ofp_version version)
4970 {
4971     struct ofp14_table_desc *otd;
4972     struct ofpbuf properties;
4973     size_t length;
4974
4975     memset(td, 0, sizeof *td);
4976
4977     if (!msg->header) {
4978         ofpraw_pull_assert(msg);
4979     }
4980
4981     if (!msg->size) {
4982         return EOF;
4983     }
4984
4985     otd = ofpbuf_try_pull(msg, sizeof *otd);
4986     if (!otd) {
4987         VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply has %"PRIu32" "
4988                      "leftover bytes at end", msg->size);
4989         return OFPERR_OFPBRC_BAD_LEN;
4990     }
4991
4992     td->table_id = otd->table_id;
4993     length = ntohs(otd->length);
4994     if (length < sizeof *otd || length - sizeof *otd > msg->size) {
4995         VLOG_WARN_RL(&bad_ofmsg_rl, "OFP14_TABLE_DESC reply claims invalid "
4996                      "length %"PRIuSIZE, length);
4997         return OFPERR_OFPBRC_BAD_LEN;
4998     }
4999     length -= sizeof *otd;
5000     ofpbuf_use_const(&properties, ofpbuf_pull(msg, length), length);
5001
5002     td->eviction = ofputil_decode_table_eviction(otd->config, version);
5003     td->vacancy = ofputil_decode_table_vacancy(otd->config, version);
5004     td->eviction_flags = UINT32_MAX;
5005
5006     while (properties.size > 0) {
5007         struct ofpbuf payload;
5008         enum ofperr error;
5009         uint16_t type;
5010
5011         error = ofputil_pull_property(&properties, &payload, &type);
5012         if (error) {
5013             return error;
5014         }
5015
5016         switch (type) {
5017         case OFPTMPT14_EVICTION:
5018             error = parse_table_desc_eviction_property(&payload, td);
5019             break;
5020
5021         case OFPTMPT14_VACANCY:
5022             error = parse_table_desc_vacancy_property(&payload, td);
5023             break;
5024
5025         default:
5026             log_property(true, "unknown table_desc property %"PRIu16, type);
5027             error = 0;
5028             break;
5029         }
5030
5031         if (error) {
5032             return error;
5033         }
5034     }
5035
5036     return 0;
5037 }
5038
5039 /* Encodes and returns a request to obtain description of tables of a switch.
5040  * The message is encoded for OpenFlow version 'ofp_version'. */
5041 struct ofpbuf *
5042 ofputil_encode_table_desc_request(enum ofp_version ofp_version)
5043 {
5044     struct ofpbuf *request = NULL;
5045
5046     if (ofp_version >= OFP14_VERSION) {
5047         request = ofpraw_alloc(OFPRAW_OFPST14_TABLE_DESC_REQUEST,
5048                                ofp_version, 0);
5049     } else {
5050         ovs_fatal(0, "dump-table-desc needs OpenFlow 1.4 or later "
5051                   "(\'-O OpenFlow14\')");
5052     }
5053
5054     return request;
5055 }
5056
5057 /* Function to append Table desc information in a reply list. */
5058 void
5059 ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
5060                                 struct ovs_list *replies,
5061                                 enum ofp_version version)
5062 {
5063     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
5064     size_t start_otd;
5065     struct ofp14_table_desc *otd;
5066
5067     start_otd = reply->size;
5068     ofpbuf_put_zeros(reply, sizeof *otd);
5069     if (td->eviction_flags != UINT32_MAX) {
5070         struct ofp14_table_mod_prop_eviction *ote;
5071
5072         ote = ofpbuf_put_zeros(reply, sizeof *ote);
5073         ote->type = htons(OFPTMPT14_EVICTION);
5074         ote->length = htons(sizeof *ote);
5075         ote->flags = htonl(td->eviction_flags);
5076     }
5077     if (td->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5078         struct ofp14_table_mod_prop_vacancy *otv;
5079
5080         otv = ofpbuf_put_zeros(reply, sizeof *otv);
5081         otv->type = htons(OFPTMPT14_VACANCY);
5082         otv->length = htons(sizeof *otv);
5083         otv->vacancy_down = td->table_vacancy.vacancy_down;
5084         otv->vacancy_up = td->table_vacancy.vacancy_up;
5085         otv->vacancy = td->table_vacancy.vacancy;
5086     }
5087
5088     otd = ofpbuf_at_assert(reply, start_otd, sizeof *otd);
5089     otd->length = htons(reply->size - start_otd);
5090     otd->table_id = td->table_id;
5091     otd->config = ofputil_encode_table_config(OFPUTIL_TABLE_MISS_DEFAULT,
5092                                               td->eviction, td->vacancy,
5093                                               version);
5094     ofpmp_postappend(replies, start_otd);
5095 }
5096
5097 /* This function parses Vacancy property, and decodes the
5098  * ofp14_table_mod_prop_vacancy in ofputil_table_mod.
5099  * Returns OFPERR_OFPBPC_BAD_VALUE error code when vacancy_down is
5100  * greater than vacancy_up and also when current vacancy has non-zero
5101  * value. Returns 0 on success. */
5102 static enum ofperr
5103 parse_table_mod_vacancy_property(struct ofpbuf *property,
5104                                  struct ofputil_table_mod *tm)
5105 {
5106     struct ofp14_table_mod_prop_vacancy *otv = property->data;
5107
5108     if (property->size != sizeof *otv) {
5109         return OFPERR_OFPBPC_BAD_LEN;
5110     }
5111     tm->table_vacancy.vacancy_down = otv->vacancy_down;
5112     tm->table_vacancy.vacancy_up = otv->vacancy_up;
5113     if (tm->table_vacancy.vacancy_down > tm->table_vacancy.vacancy_up) {
5114         log_property(false, "Value of vacancy_down is greater than "
5115                      "vacancy_up");
5116         return OFPERR_OFPBPC_BAD_VALUE;
5117     }
5118     if (tm->table_vacancy.vacancy_down > 100 ||
5119         tm->table_vacancy.vacancy_up > 100) {
5120         log_property(false, "Vacancy threshold percentage should not be"
5121                      "greater than 100");
5122         return OFPERR_OFPBPC_BAD_VALUE;
5123     }
5124     tm->table_vacancy.vacancy = otv->vacancy;
5125     if (tm->table_vacancy.vacancy) {
5126         log_property(false, "Vacancy value should be zero for table-mod "
5127                      "messages");
5128         return OFPERR_OFPBPC_BAD_VALUE;
5129     }
5130     return 0;
5131 }
5132
5133 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5134  * table configuration (a table mod, table stats, or table features message),
5135  * returns the table vacancy configuration that it specifies.
5136  *
5137  * Only OpenFlow 1.4 and later specify table vacancy configuration this way,
5138  * so for other 'version' this function always returns
5139  * OFPUTIL_TABLE_VACANCY_DEFAULT. */
5140 static enum ofputil_table_vacancy
5141 ofputil_decode_table_vacancy(ovs_be32 config, enum ofp_version version)
5142 {
5143     return (version < OFP14_VERSION ? OFPUTIL_TABLE_VACANCY_DEFAULT
5144             : config & htonl(OFPTC14_VACANCY_EVENTS) ? OFPUTIL_TABLE_VACANCY_ON
5145             : OFPUTIL_TABLE_VACANCY_OFF);
5146 }
5147
5148 static enum ofperr
5149 parse_table_mod_eviction_property(struct ofpbuf *property,
5150                                   struct ofputil_table_mod *tm)
5151 {
5152     struct ofp14_table_mod_prop_eviction *ote = property->data;
5153
5154     if (property->size != sizeof *ote) {
5155         return OFPERR_OFPBPC_BAD_LEN;
5156     }
5157
5158     tm->eviction_flags = ntohl(ote->flags);
5159     return 0;
5160 }
5161
5162 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5163  * table configuration (a table mod, table stats, or table features message),
5164  * returns the table eviction configuration that it specifies.
5165  *
5166  * Only OpenFlow 1.4 and later specify table eviction configuration this way,
5167  * so for other 'version' values this function always returns
5168  * OFPUTIL_TABLE_EVICTION_DEFAULT. */
5169 static enum ofputil_table_eviction
5170 ofputil_decode_table_eviction(ovs_be32 config, enum ofp_version version)
5171 {
5172     return (version < OFP14_VERSION ? OFPUTIL_TABLE_EVICTION_DEFAULT
5173             : config & htonl(OFPTC14_EVICTION) ? OFPUTIL_TABLE_EVICTION_ON
5174             : OFPUTIL_TABLE_EVICTION_OFF);
5175 }
5176
5177 /* Returns a bitmap of OFPTC* values suitable for 'config' fields in various
5178  * OpenFlow messages of the given 'version', based on the provided 'miss' and
5179  * 'eviction' values. */
5180 static ovs_be32
5181 ofputil_encode_table_config(enum ofputil_table_miss miss,
5182                             enum ofputil_table_eviction eviction,
5183                             enum ofputil_table_vacancy vacancy,
5184                             enum ofp_version version)
5185 {
5186     uint32_t config = 0;
5187     /* See the section "OFPTC_* Table Configuration" in DESIGN.md for more
5188      * information on the crazy evolution of this field. */
5189     switch (version) {
5190     case OFP10_VERSION:
5191         /* OpenFlow 1.0 didn't have such a field, any value ought to do. */
5192         return htonl(0);
5193
5194     case OFP11_VERSION:
5195     case OFP12_VERSION:
5196         /* OpenFlow 1.1 and 1.2 define only OFPTC11_TABLE_MISS_*. */
5197         switch (miss) {
5198         case OFPUTIL_TABLE_MISS_DEFAULT:
5199             /* Really this shouldn't be used for encoding (the caller should
5200              * provide a specific value) but I can't imagine that defaulting to
5201              * the fall-through case here will hurt. */
5202         case OFPUTIL_TABLE_MISS_CONTROLLER:
5203         default:
5204             return htonl(OFPTC11_TABLE_MISS_CONTROLLER);
5205         case OFPUTIL_TABLE_MISS_CONTINUE:
5206             return htonl(OFPTC11_TABLE_MISS_CONTINUE);
5207         case OFPUTIL_TABLE_MISS_DROP:
5208             return htonl(OFPTC11_TABLE_MISS_DROP);
5209         }
5210         OVS_NOT_REACHED();
5211
5212     case OFP13_VERSION:
5213         /* OpenFlow 1.3 removed OFPTC11_TABLE_MISS_* and didn't define any new
5214          * flags, so this is correct. */
5215         return htonl(0);
5216
5217     case OFP14_VERSION:
5218     case OFP15_VERSION:
5219         /* OpenFlow 1.4 introduced OFPTC14_EVICTION and
5220          * OFPTC14_VACANCY_EVENTS. */
5221         if (eviction == OFPUTIL_TABLE_EVICTION_ON) {
5222             config |= OFPTC14_EVICTION;
5223         }
5224         if (vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5225             config |= OFPTC14_VACANCY_EVENTS;
5226         }
5227         return htonl(config);
5228     }
5229
5230     OVS_NOT_REACHED();
5231 }
5232
5233 /* Given 'config', taken from an OpenFlow 'version' message that specifies
5234  * table configuration (a table mod, table stats, or table features message),
5235  * returns the table miss configuration that it specifies.
5236  *
5237  * Only OpenFlow 1.1 and 1.2 specify table miss configurations this way, so for
5238  * other 'version' values this function always returns
5239  * OFPUTIL_TABLE_MISS_DEFAULT. */
5240 static enum ofputil_table_miss
5241 ofputil_decode_table_miss(ovs_be32 config_, enum ofp_version version)
5242 {
5243     uint32_t config = ntohl(config_);
5244
5245     if (version == OFP11_VERSION || version == OFP12_VERSION) {
5246         switch (config & OFPTC11_TABLE_MISS_MASK) {
5247         case OFPTC11_TABLE_MISS_CONTROLLER:
5248             return OFPUTIL_TABLE_MISS_CONTROLLER;
5249
5250         case OFPTC11_TABLE_MISS_CONTINUE:
5251             return OFPUTIL_TABLE_MISS_CONTINUE;
5252
5253         case OFPTC11_TABLE_MISS_DROP:
5254             return OFPUTIL_TABLE_MISS_DROP;
5255
5256         default:
5257             VLOG_WARN_RL(&bad_ofmsg_rl, "bad table miss config %d", config);
5258             return OFPUTIL_TABLE_MISS_CONTROLLER;
5259         }
5260     } else {
5261         return OFPUTIL_TABLE_MISS_DEFAULT;
5262     }
5263 }
5264
5265 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
5266  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
5267 enum ofperr
5268 ofputil_decode_table_mod(const struct ofp_header *oh,
5269                          struct ofputil_table_mod *pm)
5270 {
5271     enum ofpraw raw;
5272     struct ofpbuf b;
5273
5274     memset(pm, 0, sizeof *pm);
5275     pm->miss = OFPUTIL_TABLE_MISS_DEFAULT;
5276     pm->eviction = OFPUTIL_TABLE_EVICTION_DEFAULT;
5277     pm->eviction_flags = UINT32_MAX;
5278     pm->vacancy = OFPUTIL_TABLE_VACANCY_DEFAULT;
5279     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5280     raw = ofpraw_pull_assert(&b);
5281
5282     if (raw == OFPRAW_OFPT11_TABLE_MOD) {
5283         const struct ofp11_table_mod *otm = b.data;
5284
5285         pm->table_id = otm->table_id;
5286         pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5287     } else if (raw == OFPRAW_OFPT14_TABLE_MOD) {
5288         const struct ofp14_table_mod *otm = ofpbuf_pull(&b, sizeof *otm);
5289
5290         pm->table_id = otm->table_id;
5291         pm->miss = ofputil_decode_table_miss(otm->config, oh->version);
5292         pm->eviction = ofputil_decode_table_eviction(otm->config, oh->version);
5293         pm->vacancy = ofputil_decode_table_vacancy(otm->config, oh->version);
5294         while (b.size > 0) {
5295             struct ofpbuf property;
5296             enum ofperr error;
5297             uint16_t type;
5298
5299             error = ofputil_pull_property(&b, &property, &type);
5300             if (error) {
5301                 return error;
5302             }
5303
5304             switch (type) {
5305             case OFPTMPT14_EVICTION:
5306                 error = parse_table_mod_eviction_property(&property, pm);
5307                 break;
5308
5309             case OFPTMPT14_VACANCY:
5310                 error = parse_table_mod_vacancy_property(&property, pm);
5311                 break;
5312
5313             default:
5314                 error = OFPERR_OFPBRC_BAD_TYPE;
5315                 break;
5316             }
5317
5318             if (error) {
5319                 return error;
5320             }
5321         }
5322     } else {
5323         return OFPERR_OFPBRC_BAD_TYPE;
5324     }
5325
5326     return 0;
5327 }
5328
5329 /* Converts the abstract form of a "table mod" message in '*tm' into an
5330  * OpenFlow message suitable for 'protocol', and returns that encoded form in a
5331  * buffer owned by the caller. */
5332 struct ofpbuf *
5333 ofputil_encode_table_mod(const struct ofputil_table_mod *tm,
5334                         enum ofputil_protocol protocol)
5335 {
5336     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5337     struct ofpbuf *b;
5338
5339     switch (ofp_version) {
5340     case OFP10_VERSION: {
5341         ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
5342                      "(\'-O OpenFlow11\')");
5343         break;
5344     }
5345     case OFP11_VERSION:
5346     case OFP12_VERSION:
5347     case OFP13_VERSION: {
5348         struct ofp11_table_mod *otm;
5349
5350         b = ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD, ofp_version, 0);
5351         otm = ofpbuf_put_zeros(b, sizeof *otm);
5352         otm->table_id = tm->table_id;
5353         otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5354                                                   tm->vacancy, ofp_version);
5355         break;
5356     }
5357     case OFP14_VERSION:
5358     case OFP15_VERSION: {
5359         struct ofp14_table_mod *otm;
5360         struct ofp14_table_mod_prop_eviction *ote;
5361         struct ofp14_table_mod_prop_vacancy *otv;
5362
5363         b = ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD, ofp_version, 0);
5364         otm = ofpbuf_put_zeros(b, sizeof *otm);
5365         otm->table_id = tm->table_id;
5366         otm->config = ofputil_encode_table_config(tm->miss, tm->eviction,
5367                                                   tm->vacancy, ofp_version);
5368
5369         if (tm->eviction_flags != UINT32_MAX) {
5370             ote = ofpbuf_put_zeros(b, sizeof *ote);
5371             ote->type = htons(OFPTMPT14_EVICTION);
5372             ote->length = htons(sizeof *ote);
5373             ote->flags = htonl(tm->eviction_flags);
5374         }
5375         if (tm->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
5376             otv = ofpbuf_put_zeros(b, sizeof *otv);
5377             otv->type = htons(OFPTMPT14_VACANCY);
5378             otv->length = htons(sizeof *otv);
5379             otv->vacancy_down = tm->table_vacancy.vacancy_down;
5380             otv->vacancy_up = tm->table_vacancy.vacancy_up;
5381         }
5382         break;
5383     }
5384     default:
5385         OVS_NOT_REACHED();
5386     }
5387
5388     return b;
5389 }
5390 \f
5391 /* ofputil_role_request */
5392
5393 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
5394  * an abstract form in '*rr'.  Returns 0 if successful, otherwise an
5395  * OFPERR_* value. */
5396 enum ofperr
5397 ofputil_decode_role_message(const struct ofp_header *oh,
5398                             struct ofputil_role_request *rr)
5399 {
5400     struct ofpbuf b;
5401     enum ofpraw raw;
5402
5403     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5404     raw = ofpraw_pull_assert(&b);
5405
5406     if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
5407         raw == OFPRAW_OFPT12_ROLE_REPLY) {
5408         const struct ofp12_role_request *orr = b.msg;
5409
5410         if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5411             orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
5412             orr->role != htonl(OFPCR12_ROLE_MASTER) &&
5413             orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
5414             return OFPERR_OFPRRFC_BAD_ROLE;
5415         }
5416
5417         rr->role = ntohl(orr->role);
5418         if (raw == OFPRAW_OFPT12_ROLE_REQUEST
5419             ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
5420             : orr->generation_id == OVS_BE64_MAX) {
5421             rr->have_generation_id = false;
5422             rr->generation_id = 0;
5423         } else {
5424             rr->have_generation_id = true;
5425             rr->generation_id = ntohll(orr->generation_id);
5426         }
5427     } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
5428                raw == OFPRAW_NXT_ROLE_REPLY) {
5429         const struct nx_role_request *nrr = b.msg;
5430
5431         BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
5432         BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
5433         BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
5434
5435         if (nrr->role != htonl(NX_ROLE_OTHER) &&
5436             nrr->role != htonl(NX_ROLE_MASTER) &&
5437             nrr->role != htonl(NX_ROLE_SLAVE)) {
5438             return OFPERR_OFPRRFC_BAD_ROLE;
5439         }
5440
5441         rr->role = ntohl(nrr->role) + 1;
5442         rr->have_generation_id = false;
5443         rr->generation_id = 0;
5444     } else {
5445         OVS_NOT_REACHED();
5446     }
5447
5448     return 0;
5449 }
5450
5451 /* Returns an encoded form of a role reply suitable for the "request" in a
5452  * buffer owned by the caller. */
5453 struct ofpbuf *
5454 ofputil_encode_role_reply(const struct ofp_header *request,
5455                           const struct ofputil_role_request *rr)
5456 {
5457     struct ofpbuf *buf;
5458     enum ofpraw raw;
5459
5460     raw = ofpraw_decode_assert(request);
5461     if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
5462         struct ofp12_role_request *orr;
5463
5464         buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
5465         orr = ofpbuf_put_zeros(buf, sizeof *orr);
5466
5467         orr->role = htonl(rr->role);
5468         orr->generation_id = htonll(rr->have_generation_id
5469                                     ? rr->generation_id
5470                                     : UINT64_MAX);
5471     } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
5472         struct nx_role_request *nrr;
5473
5474         BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
5475         BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
5476         BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
5477
5478         buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
5479         nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
5480         nrr->role = htonl(rr->role - 1);
5481     } else {
5482         OVS_NOT_REACHED();
5483     }
5484
5485     return buf;
5486 }
5487 \f
5488 /* Encodes "role status" message 'status' for sending in the given
5489  * 'protocol'.  Returns the role status message, if 'protocol' supports them,
5490  * otherwise a null pointer. */
5491 struct ofpbuf *
5492 ofputil_encode_role_status(const struct ofputil_role_status *status,
5493                            enum ofputil_protocol protocol)
5494 {
5495     enum ofp_version version;
5496
5497     version = ofputil_protocol_to_ofp_version(protocol);
5498     if (version >= OFP14_VERSION) {
5499         struct ofp14_role_status *rstatus;
5500         struct ofpbuf *buf;
5501
5502         buf = ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS, version, htonl(0),
5503                                0);
5504         rstatus = ofpbuf_put_zeros(buf, sizeof *rstatus);
5505         rstatus->role = htonl(status->role);
5506         rstatus->reason = status->reason;
5507         rstatus->generation_id = htonll(status->generation_id);
5508
5509         return buf;
5510     } else {
5511         return NULL;
5512     }
5513 }
5514
5515 enum ofperr
5516 ofputil_decode_role_status(const struct ofp_header *oh,
5517                            struct ofputil_role_status *rs)
5518 {
5519     struct ofpbuf b;
5520     enum ofpraw raw;
5521     const struct ofp14_role_status *r;
5522
5523     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5524     raw = ofpraw_pull_assert(&b);
5525     ovs_assert(raw == OFPRAW_OFPT14_ROLE_STATUS);
5526
5527     r = b.msg;
5528     if (r->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
5529         r->role != htonl(OFPCR12_ROLE_EQUAL) &&
5530         r->role != htonl(OFPCR12_ROLE_MASTER) &&
5531         r->role != htonl(OFPCR12_ROLE_SLAVE)) {
5532         return OFPERR_OFPRRFC_BAD_ROLE;
5533     }
5534
5535     rs->role = ntohl(r->role);
5536     rs->generation_id = ntohll(r->generation_id);
5537     rs->reason = r->reason;
5538
5539     return 0;
5540 }
5541
5542 /* Encodes 'rf' according to 'protocol', and returns the encoded message.
5543  * 'protocol' must be for OpenFlow 1.4 or later. */
5544 struct ofpbuf *
5545 ofputil_encode_requestforward(const struct ofputil_requestforward *rf,
5546                               enum ofputil_protocol protocol)
5547 {
5548     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
5549     struct ofpbuf *inner;
5550
5551     switch (rf->reason) {
5552     case OFPRFR_GROUP_MOD:
5553         inner = ofputil_encode_group_mod(ofp_version, rf->group_mod);
5554         break;
5555
5556     case OFPRFR_METER_MOD:
5557         inner = ofputil_encode_meter_mod(ofp_version, rf->meter_mod);
5558         break;
5559
5560     case OFPRFR_N_REASONS:
5561     default:
5562         OVS_NOT_REACHED();
5563     }
5564
5565     struct ofp_header *inner_oh = inner->data;
5566     inner_oh->xid = rf->xid;
5567     inner_oh->length = htons(inner->size);
5568
5569     struct ofpbuf *outer = ofpraw_alloc_xid(OFPRAW_OFPT14_REQUESTFORWARD,
5570                                             ofp_version, htonl(0),
5571                                             inner->size);
5572     ofpbuf_put(outer, inner->data, inner->size);
5573     ofpbuf_delete(inner);
5574
5575     return outer;
5576 }
5577
5578 /* Decodes OFPT_REQUESTFORWARD message 'outer'.  On success, puts the decoded
5579  * form into '*rf' and returns 0, and the caller is later responsible for
5580  * freeing the content of 'rf', with ofputil_destroy_requestforward(rf).  On
5581  * failure, returns an ofperr and '*rf' is indeterminate. */
5582 enum ofperr
5583 ofputil_decode_requestforward(const struct ofp_header *outer,
5584                               struct ofputil_requestforward *rf)
5585 {
5586     struct ofpbuf b;
5587     enum ofperr error;
5588
5589     ofpbuf_use_const(&b, outer, ntohs(outer->length));
5590
5591     /* Skip past outer message. */
5592     enum ofpraw outer_raw = ofpraw_pull_assert(&b);
5593     ovs_assert(outer_raw == OFPRAW_OFPT14_REQUESTFORWARD);
5594
5595     /* Validate inner message. */
5596     if (b.size < sizeof(struct ofp_header)) {
5597         return OFPERR_OFPBFC_MSG_BAD_LEN;
5598     }
5599     const struct ofp_header *inner = b.data;
5600     unsigned int inner_len = ntohs(inner->length);
5601     if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
5602         return OFPERR_OFPBFC_MSG_BAD_LEN;
5603     }
5604     if (inner->version != outer->version) {
5605         return OFPERR_OFPBRC_BAD_VERSION;
5606     }
5607
5608     /* Parse inner message. */
5609     enum ofptype type;
5610     error = ofptype_decode(&type, inner);
5611     if (error) {
5612         return error;
5613     }
5614
5615     rf->xid = inner->xid;
5616     if (type == OFPTYPE_GROUP_MOD) {
5617         rf->reason = OFPRFR_GROUP_MOD;
5618         rf->group_mod = xmalloc(sizeof *rf->group_mod);
5619         error = ofputil_decode_group_mod(inner, rf->group_mod);
5620         if (error) {
5621             free(rf->group_mod);
5622             return error;
5623         }
5624     } else if (type == OFPTYPE_METER_MOD) {
5625         rf->reason = OFPRFR_METER_MOD;
5626         rf->meter_mod = xmalloc(sizeof *rf->meter_mod);
5627         ofpbuf_init(&rf->bands, 64);
5628         error = ofputil_decode_meter_mod(inner, rf->meter_mod, &rf->bands);
5629         if (error) {
5630             free(rf->meter_mod);
5631             ofpbuf_uninit(&rf->bands);
5632             return error;
5633         }
5634     } else {
5635         return OFPERR_OFPBFC_MSG_UNSUP;
5636     }
5637
5638     return 0;
5639 }
5640
5641 /* Frees the content of 'rf', which should have been initialized through a
5642  * successful call to ofputil_decode_requestforward(). */
5643 void
5644 ofputil_destroy_requestforward(struct ofputil_requestforward *rf)
5645 {
5646     if (!rf) {
5647         return;
5648     }
5649
5650     switch (rf->reason) {
5651     case OFPRFR_GROUP_MOD:
5652         ofputil_uninit_group_mod(rf->group_mod);
5653         free(rf->group_mod);
5654         break;
5655
5656     case OFPRFR_METER_MOD:
5657         ofpbuf_uninit(&rf->bands);
5658         free(rf->meter_mod);
5659         break;
5660
5661     case OFPRFR_N_REASONS:
5662         OVS_NOT_REACHED();
5663     }
5664 }
5665
5666 /* Table stats. */
5667
5668 /* OpenFlow 1.0 and 1.1 don't distinguish between a field that cannot be
5669  * matched and a field that must be wildcarded.  This function returns a bitmap
5670  * that contains both kinds of fields. */
5671 static struct mf_bitmap
5672 wild_or_nonmatchable_fields(const struct ofputil_table_features *features)
5673 {
5674     struct mf_bitmap wc = features->match;
5675     bitmap_not(wc.bm, MFF_N_IDS);
5676     bitmap_or(wc.bm, features->wildcard.bm, MFF_N_IDS);
5677     return wc;
5678 }
5679
5680 struct ofp10_wc_map {
5681     enum ofp10_flow_wildcards wc10;
5682     enum mf_field_id mf;
5683 };
5684
5685 static const struct ofp10_wc_map ofp10_wc_map[] = {
5686     { OFPFW10_IN_PORT,     MFF_IN_PORT },
5687     { OFPFW10_DL_VLAN,     MFF_VLAN_VID },
5688     { OFPFW10_DL_SRC,      MFF_ETH_SRC },
5689     { OFPFW10_DL_DST,      MFF_ETH_DST},
5690     { OFPFW10_DL_TYPE,     MFF_ETH_TYPE },
5691     { OFPFW10_NW_PROTO,    MFF_IP_PROTO },
5692     { OFPFW10_TP_SRC,      MFF_TCP_SRC },
5693     { OFPFW10_TP_DST,      MFF_TCP_DST },
5694     { OFPFW10_NW_SRC_MASK, MFF_IPV4_SRC },
5695     { OFPFW10_NW_DST_MASK, MFF_IPV4_DST },
5696     { OFPFW10_DL_VLAN_PCP, MFF_VLAN_PCP },
5697     { OFPFW10_NW_TOS,      MFF_IP_DSCP },
5698 };
5699
5700 static ovs_be32
5701 mf_bitmap_to_of10(const struct mf_bitmap *fields)
5702 {
5703     const struct ofp10_wc_map *p;
5704     uint32_t wc10 = 0;
5705
5706     for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
5707         if (bitmap_is_set(fields->bm, p->mf)) {
5708             wc10 |= p->wc10;
5709         }
5710     }
5711     return htonl(wc10);
5712 }
5713
5714 static struct mf_bitmap
5715 mf_bitmap_from_of10(ovs_be32 wc10_)
5716 {
5717     struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
5718     const struct ofp10_wc_map *p;
5719     uint32_t wc10 = ntohl(wc10_);
5720
5721     for (p = ofp10_wc_map; p < &ofp10_wc_map[ARRAY_SIZE(ofp10_wc_map)]; p++) {
5722         if (wc10 & p->wc10) {
5723             bitmap_set1(fields.bm, p->mf);
5724         }
5725     }
5726     return fields;
5727 }
5728
5729 static void
5730 ofputil_put_ofp10_table_stats(const struct ofputil_table_stats *stats,
5731                               const struct ofputil_table_features *features,
5732                               struct ofpbuf *buf)
5733 {
5734     struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
5735     struct ofp10_table_stats *out;
5736
5737     out = ofpbuf_put_zeros(buf, sizeof *out);
5738     out->table_id = features->table_id;
5739     ovs_strlcpy(out->name, features->name, sizeof out->name);
5740     out->wildcards = mf_bitmap_to_of10(&wc);
5741     out->max_entries = htonl(features->max_entries);
5742     out->active_count = htonl(stats->active_count);
5743     put_32aligned_be64(&out->lookup_count, htonll(stats->lookup_count));
5744     put_32aligned_be64(&out->matched_count, htonll(stats->matched_count));
5745 }
5746
5747 struct ofp11_wc_map {
5748     enum ofp11_flow_match_fields wc11;
5749     enum mf_field_id mf;
5750 };
5751
5752 static const struct ofp11_wc_map ofp11_wc_map[] = {
5753     { OFPFMF11_IN_PORT,     MFF_IN_PORT },
5754     { OFPFMF11_DL_VLAN,     MFF_VLAN_VID },
5755     { OFPFMF11_DL_VLAN_PCP, MFF_VLAN_PCP },
5756     { OFPFMF11_DL_TYPE,     MFF_ETH_TYPE },
5757     { OFPFMF11_NW_TOS,      MFF_IP_DSCP },
5758     { OFPFMF11_NW_PROTO,    MFF_IP_PROTO },
5759     { OFPFMF11_TP_SRC,      MFF_TCP_SRC },
5760     { OFPFMF11_TP_DST,      MFF_TCP_DST },
5761     { OFPFMF11_MPLS_LABEL,  MFF_MPLS_LABEL },
5762     { OFPFMF11_MPLS_TC,     MFF_MPLS_TC },
5763     /* I don't know what OFPFMF11_TYPE means. */
5764     { OFPFMF11_DL_SRC,      MFF_ETH_SRC },
5765     { OFPFMF11_DL_DST,      MFF_ETH_DST },
5766     { OFPFMF11_NW_SRC,      MFF_IPV4_SRC },
5767     { OFPFMF11_NW_DST,      MFF_IPV4_DST },
5768     { OFPFMF11_METADATA,    MFF_METADATA },
5769 };
5770
5771 static ovs_be32
5772 mf_bitmap_to_of11(const struct mf_bitmap *fields)
5773 {
5774     const struct ofp11_wc_map *p;
5775     uint32_t wc11 = 0;
5776
5777     for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
5778         if (bitmap_is_set(fields->bm, p->mf)) {
5779             wc11 |= p->wc11;
5780         }
5781     }
5782     return htonl(wc11);
5783 }
5784
5785 static struct mf_bitmap
5786 mf_bitmap_from_of11(ovs_be32 wc11_)
5787 {
5788     struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
5789     const struct ofp11_wc_map *p;
5790     uint32_t wc11 = ntohl(wc11_);
5791
5792     for (p = ofp11_wc_map; p < &ofp11_wc_map[ARRAY_SIZE(ofp11_wc_map)]; p++) {
5793         if (wc11 & p->wc11) {
5794             bitmap_set1(fields.bm, p->mf);
5795         }
5796     }
5797     return fields;
5798 }
5799
5800 static void
5801 ofputil_put_ofp11_table_stats(const struct ofputil_table_stats *stats,
5802                               const struct ofputil_table_features *features,
5803                               struct ofpbuf *buf)
5804 {
5805     struct mf_bitmap wc = wild_or_nonmatchable_fields(features);
5806     struct ofp11_table_stats *out;
5807
5808     out = ofpbuf_put_zeros(buf, sizeof *out);
5809     out->table_id = features->table_id;
5810     ovs_strlcpy(out->name, features->name, sizeof out->name);
5811     out->wildcards = mf_bitmap_to_of11(&wc);
5812     out->match = mf_bitmap_to_of11(&features->match);
5813     out->instructions = ovsinst_bitmap_to_openflow(
5814         features->nonmiss.instructions, OFP11_VERSION);
5815     out->write_actions = ofpact_bitmap_to_openflow(
5816         features->nonmiss.write.ofpacts, OFP11_VERSION);
5817     out->apply_actions = ofpact_bitmap_to_openflow(
5818         features->nonmiss.apply.ofpacts, OFP11_VERSION);
5819     out->config = htonl(features->miss_config);
5820     out->max_entries = htonl(features->max_entries);
5821     out->active_count = htonl(stats->active_count);
5822     out->lookup_count = htonll(stats->lookup_count);
5823     out->matched_count = htonll(stats->matched_count);
5824 }
5825
5826 static void
5827 ofputil_put_ofp12_table_stats(const struct ofputil_table_stats *stats,
5828                               const struct ofputil_table_features *features,
5829                               struct ofpbuf *buf)
5830 {
5831     struct ofp12_table_stats *out;
5832
5833     out = ofpbuf_put_zeros(buf, sizeof *out);
5834     out->table_id = features->table_id;
5835     ovs_strlcpy(out->name, features->name, sizeof out->name);
5836     out->match = oxm_bitmap_from_mf_bitmap(&features->match, OFP12_VERSION);
5837     out->wildcards = oxm_bitmap_from_mf_bitmap(&features->wildcard,
5838                                              OFP12_VERSION);
5839     out->write_actions = ofpact_bitmap_to_openflow(
5840         features->nonmiss.write.ofpacts, OFP12_VERSION);
5841     out->apply_actions = ofpact_bitmap_to_openflow(
5842         features->nonmiss.apply.ofpacts, OFP12_VERSION);
5843     out->write_setfields = oxm_bitmap_from_mf_bitmap(
5844         &features->nonmiss.write.set_fields, OFP12_VERSION);
5845     out->apply_setfields = oxm_bitmap_from_mf_bitmap(
5846         &features->nonmiss.apply.set_fields, OFP12_VERSION);
5847     out->metadata_match = features->metadata_match;
5848     out->metadata_write = features->metadata_write;
5849     out->instructions = ovsinst_bitmap_to_openflow(
5850         features->nonmiss.instructions, OFP12_VERSION);
5851     out->config = ofputil_encode_table_config(features->miss_config,
5852                                               OFPUTIL_TABLE_EVICTION_DEFAULT,
5853                                               OFPUTIL_TABLE_VACANCY_DEFAULT,
5854                                               OFP12_VERSION);
5855     out->max_entries = htonl(features->max_entries);
5856     out->active_count = htonl(stats->active_count);
5857     out->lookup_count = htonll(stats->lookup_count);
5858     out->matched_count = htonll(stats->matched_count);
5859 }
5860
5861 static void
5862 ofputil_put_ofp13_table_stats(const struct ofputil_table_stats *stats,
5863                               struct ofpbuf *buf)
5864 {
5865     struct ofp13_table_stats *out;
5866
5867     out = ofpbuf_put_zeros(buf, sizeof *out);
5868     out->table_id = stats->table_id;
5869     out->active_count = htonl(stats->active_count);
5870     out->lookup_count = htonll(stats->lookup_count);
5871     out->matched_count = htonll(stats->matched_count);
5872 }
5873
5874 struct ofpbuf *
5875 ofputil_encode_table_stats_reply(const struct ofp_header *request)
5876 {
5877     return ofpraw_alloc_stats_reply(request, 0);
5878 }
5879
5880 void
5881 ofputil_append_table_stats_reply(struct ofpbuf *reply,
5882                                  const struct ofputil_table_stats *stats,
5883                                  const struct ofputil_table_features *features)
5884 {
5885     struct ofp_header *oh = reply->header;
5886
5887     ovs_assert(stats->table_id == features->table_id);
5888
5889     switch ((enum ofp_version) oh->version) {
5890     case OFP10_VERSION:
5891         ofputil_put_ofp10_table_stats(stats, features, reply);
5892         break;
5893
5894     case OFP11_VERSION:
5895         ofputil_put_ofp11_table_stats(stats, features, reply);
5896         break;
5897
5898     case OFP12_VERSION:
5899         ofputil_put_ofp12_table_stats(stats, features, reply);
5900         break;
5901
5902     case OFP13_VERSION:
5903     case OFP14_VERSION:
5904     case OFP15_VERSION:
5905         ofputil_put_ofp13_table_stats(stats, reply);
5906         break;
5907
5908     default:
5909         OVS_NOT_REACHED();
5910     }
5911 }
5912
5913 static int
5914 ofputil_decode_ofp10_table_stats(struct ofpbuf *msg,
5915                                  struct ofputil_table_stats *stats,
5916                                  struct ofputil_table_features *features)
5917 {
5918     struct ofp10_table_stats *ots;
5919
5920     ots = ofpbuf_try_pull(msg, sizeof *ots);
5921     if (!ots) {
5922         return OFPERR_OFPBRC_BAD_LEN;
5923     }
5924
5925     features->table_id = ots->table_id;
5926     ovs_strlcpy(features->name, ots->name, sizeof features->name);
5927     features->max_entries = ntohl(ots->max_entries);
5928     features->match = features->wildcard = mf_bitmap_from_of10(ots->wildcards);
5929
5930     stats->table_id = ots->table_id;
5931     stats->active_count = ntohl(ots->active_count);
5932     stats->lookup_count = ntohll(get_32aligned_be64(&ots->lookup_count));
5933     stats->matched_count = ntohll(get_32aligned_be64(&ots->matched_count));
5934
5935     return 0;
5936 }
5937
5938 static int
5939 ofputil_decode_ofp11_table_stats(struct ofpbuf *msg,
5940                                  struct ofputil_table_stats *stats,
5941                                  struct ofputil_table_features *features)
5942 {
5943     struct ofp11_table_stats *ots;
5944
5945     ots = ofpbuf_try_pull(msg, sizeof *ots);
5946     if (!ots) {
5947         return OFPERR_OFPBRC_BAD_LEN;
5948     }
5949
5950     features->table_id = ots->table_id;
5951     ovs_strlcpy(features->name, ots->name, sizeof features->name);
5952     features->max_entries = ntohl(ots->max_entries);
5953     features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
5954         ots->instructions, OFP11_VERSION);
5955     features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
5956         ots->write_actions, OFP11_VERSION);
5957     features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
5958         ots->write_actions, OFP11_VERSION);
5959     features->miss = features->nonmiss;
5960     features->miss_config = ofputil_decode_table_miss(ots->config,
5961                                                       OFP11_VERSION);
5962     features->match = mf_bitmap_from_of11(ots->match);
5963     features->wildcard = mf_bitmap_from_of11(ots->wildcards);
5964     bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
5965
5966     stats->table_id = ots->table_id;
5967     stats->active_count = ntohl(ots->active_count);
5968     stats->lookup_count = ntohll(ots->lookup_count);
5969     stats->matched_count = ntohll(ots->matched_count);
5970
5971     return 0;
5972 }
5973
5974 static int
5975 ofputil_decode_ofp12_table_stats(struct ofpbuf *msg,
5976                                  struct ofputil_table_stats *stats,
5977                                  struct ofputil_table_features *features)
5978 {
5979     struct ofp12_table_stats *ots;
5980
5981     ots = ofpbuf_try_pull(msg, sizeof *ots);
5982     if (!ots) {
5983         return OFPERR_OFPBRC_BAD_LEN;
5984     }
5985
5986     features->table_id = ots->table_id;
5987     ovs_strlcpy(features->name, ots->name, sizeof features->name);
5988     features->metadata_match = ots->metadata_match;
5989     features->metadata_write = ots->metadata_write;
5990     features->miss_config = ofputil_decode_table_miss(ots->config,
5991                                                       OFP12_VERSION);
5992     features->max_entries = ntohl(ots->max_entries);
5993
5994     features->nonmiss.instructions = ovsinst_bitmap_from_openflow(
5995         ots->instructions, OFP12_VERSION);
5996     features->nonmiss.write.ofpacts = ofpact_bitmap_from_openflow(
5997         ots->write_actions, OFP12_VERSION);
5998     features->nonmiss.apply.ofpacts = ofpact_bitmap_from_openflow(
5999         ots->apply_actions, OFP12_VERSION);
6000     features->nonmiss.write.set_fields = oxm_bitmap_to_mf_bitmap(
6001         ots->write_setfields, OFP12_VERSION);
6002     features->nonmiss.apply.set_fields = oxm_bitmap_to_mf_bitmap(
6003         ots->apply_setfields, OFP12_VERSION);
6004     features->miss = features->nonmiss;
6005
6006     features->match = oxm_bitmap_to_mf_bitmap(ots->match, OFP12_VERSION);
6007     features->wildcard = oxm_bitmap_to_mf_bitmap(ots->wildcards,
6008                                                  OFP12_VERSION);
6009     bitmap_or(features->match.bm, features->wildcard.bm, MFF_N_IDS);
6010
6011     stats->table_id = ots->table_id;
6012     stats->active_count = ntohl(ots->active_count);
6013     stats->lookup_count = ntohll(ots->lookup_count);
6014     stats->matched_count = ntohll(ots->matched_count);
6015
6016     return 0;
6017 }
6018
6019 static int
6020 ofputil_decode_ofp13_table_stats(struct ofpbuf *msg,
6021                                  struct ofputil_table_stats *stats,
6022                                  struct ofputil_table_features *features)
6023 {
6024     struct ofp13_table_stats *ots;
6025
6026     ots = ofpbuf_try_pull(msg, sizeof *ots);
6027     if (!ots) {
6028         return OFPERR_OFPBRC_BAD_LEN;
6029     }
6030
6031     features->table_id = ots->table_id;
6032
6033     stats->table_id = ots->table_id;
6034     stats->active_count = ntohl(ots->active_count);
6035     stats->lookup_count = ntohll(ots->lookup_count);
6036     stats->matched_count = ntohll(ots->matched_count);
6037
6038     return 0;
6039 }
6040
6041 int
6042 ofputil_decode_table_stats_reply(struct ofpbuf *msg,
6043                                  struct ofputil_table_stats *stats,
6044                                  struct ofputil_table_features *features)
6045 {
6046     const struct ofp_header *oh;
6047
6048     if (!msg->header) {
6049         ofpraw_pull_assert(msg);
6050     }
6051     oh = msg->header;
6052
6053     if (!msg->size) {
6054         return EOF;
6055     }
6056
6057     memset(stats, 0, sizeof *stats);
6058     memset(features, 0, sizeof *features);
6059     features->supports_eviction = -1;
6060     features->supports_vacancy_events = -1;
6061
6062     switch ((enum ofp_version) oh->version) {
6063     case OFP10_VERSION:
6064         return ofputil_decode_ofp10_table_stats(msg, stats, features);
6065
6066     case OFP11_VERSION:
6067         return ofputil_decode_ofp11_table_stats(msg, stats, features);
6068
6069     case OFP12_VERSION:
6070         return ofputil_decode_ofp12_table_stats(msg, stats, features);
6071
6072     case OFP13_VERSION:
6073     case OFP14_VERSION:
6074     case OFP15_VERSION:
6075         return ofputil_decode_ofp13_table_stats(msg, stats, features);
6076
6077     default:
6078         OVS_NOT_REACHED();
6079     }
6080 }
6081 \f
6082 /* ofputil_flow_monitor_request */
6083
6084 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
6085  * ofputil_flow_monitor_request in 'rq'.
6086  *
6087  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
6088  * message.  Calling this function multiple times for a single 'msg' iterates
6089  * through the requests.  The caller must initially leave 'msg''s layer
6090  * pointers null and not modify them between calls.
6091  *
6092  * Returns 0 if successful, EOF if no requests were left in this 'msg',
6093  * otherwise an OFPERR_* value. */
6094 int
6095 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
6096                                     struct ofpbuf *msg)
6097 {
6098     struct nx_flow_monitor_request *nfmr;
6099     uint16_t flags;
6100
6101     if (!msg->header) {
6102         ofpraw_pull_assert(msg);
6103     }
6104
6105     if (!msg->size) {
6106         return EOF;
6107     }
6108
6109     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
6110     if (!nfmr) {
6111         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %"PRIu32" "
6112                      "leftover bytes at end", msg->size);
6113         return OFPERR_OFPBRC_BAD_LEN;
6114     }
6115
6116     flags = ntohs(nfmr->flags);
6117     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
6118         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
6119                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
6120         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
6121                      flags);
6122         return OFPERR_OFPMOFC_BAD_FLAGS;
6123     }
6124
6125     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
6126         return OFPERR_NXBRC_MUST_BE_ZERO;
6127     }
6128
6129     rq->id = ntohl(nfmr->id);
6130     rq->flags = flags;
6131     rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
6132     rq->table_id = nfmr->table_id;
6133
6134     return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
6135 }
6136
6137 void
6138 ofputil_append_flow_monitor_request(
6139     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
6140 {
6141     struct nx_flow_monitor_request *nfmr;
6142     size_t start_ofs;
6143     int match_len;
6144
6145     if (!msg->size) {
6146         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
6147     }
6148
6149     start_ofs = msg->size;
6150     ofpbuf_put_zeros(msg, sizeof *nfmr);
6151     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
6152
6153     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
6154     nfmr->id = htonl(rq->id);
6155     nfmr->flags = htons(rq->flags);
6156     nfmr->out_port = htons(ofp_to_u16(rq->out_port));
6157     nfmr->match_len = htons(match_len);
6158     nfmr->table_id = rq->table_id;
6159 }
6160
6161 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
6162  * into an abstract ofputil_flow_update in 'update'.  The caller must have
6163  * initialized update->match to point to space allocated for a match.
6164  *
6165  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
6166  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
6167  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
6168  * will point into the 'ofpacts' buffer.
6169  *
6170  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
6171  * this function multiple times for a single 'msg' iterates through the
6172  * updates.  The caller must initially leave 'msg''s layer pointers null and
6173  * not modify them between calls.
6174  *
6175  * Returns 0 if successful, EOF if no updates were left in this 'msg',
6176  * otherwise an OFPERR_* value. */
6177 int
6178 ofputil_decode_flow_update(struct ofputil_flow_update *update,
6179                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
6180 {
6181     struct nx_flow_update_header *nfuh;
6182     unsigned int length;
6183     struct ofp_header *oh;
6184
6185     if (!msg->header) {
6186         ofpraw_pull_assert(msg);
6187     }
6188
6189     if (!msg->size) {
6190         return EOF;
6191     }
6192
6193     if (msg->size < sizeof(struct nx_flow_update_header)) {
6194         goto bad_len;
6195     }
6196
6197     oh = msg->header;
6198
6199     nfuh = msg->data;
6200     update->event = ntohs(nfuh->event);
6201     length = ntohs(nfuh->length);
6202     if (length > msg->size || length % 8) {
6203         goto bad_len;
6204     }
6205
6206     if (update->event == NXFME_ABBREV) {
6207         struct nx_flow_update_abbrev *nfua;
6208
6209         if (length != sizeof *nfua) {
6210             goto bad_len;
6211         }
6212
6213         nfua = ofpbuf_pull(msg, sizeof *nfua);
6214         update->xid = nfua->xid;
6215         return 0;
6216     } else if (update->event == NXFME_ADDED
6217                || update->event == NXFME_DELETED
6218                || update->event == NXFME_MODIFIED) {
6219         struct nx_flow_update_full *nfuf;
6220         unsigned int actions_len;
6221         unsigned int match_len;
6222         enum ofperr error;
6223
6224         if (length < sizeof *nfuf) {
6225             goto bad_len;
6226         }
6227
6228         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
6229         match_len = ntohs(nfuf->match_len);
6230         if (sizeof *nfuf + match_len > length) {
6231             goto bad_len;
6232         }
6233
6234         update->reason = ntohs(nfuf->reason);
6235         update->idle_timeout = ntohs(nfuf->idle_timeout);
6236         update->hard_timeout = ntohs(nfuf->hard_timeout);
6237         update->table_id = nfuf->table_id;
6238         update->cookie = nfuf->cookie;
6239         update->priority = ntohs(nfuf->priority);
6240
6241         error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
6242         if (error) {
6243             return error;
6244         }
6245
6246         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
6247         error = ofpacts_pull_openflow_actions(msg, actions_len, oh->version,
6248                                               ofpacts);
6249         if (error) {
6250             return error;
6251         }
6252
6253         update->ofpacts = ofpacts->data;
6254         update->ofpacts_len = ofpacts->size;
6255         return 0;
6256     } else {
6257         VLOG_WARN_RL(&bad_ofmsg_rl,
6258                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
6259                      ntohs(nfuh->event));
6260         return OFPERR_NXBRC_FM_BAD_EVENT;
6261     }
6262
6263 bad_len:
6264     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %"PRIu32" "
6265                  "leftover bytes at end", msg->size);
6266     return OFPERR_OFPBRC_BAD_LEN;
6267 }
6268
6269 uint32_t
6270 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
6271 {
6272     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
6273
6274     return ntohl(cancel->id);
6275 }
6276
6277 struct ofpbuf *
6278 ofputil_encode_flow_monitor_cancel(uint32_t id)
6279 {
6280     struct nx_flow_monitor_cancel *nfmc;
6281     struct ofpbuf *msg;
6282
6283     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
6284     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
6285     nfmc->id = htonl(id);
6286     return msg;
6287 }
6288
6289 void
6290 ofputil_start_flow_update(struct ovs_list *replies)
6291 {
6292     struct ofpbuf *msg;
6293
6294     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
6295                            htonl(0), 1024);
6296
6297     list_init(replies);
6298     list_push_back(replies, &msg->list_node);
6299 }
6300
6301 void
6302 ofputil_append_flow_update(const struct ofputil_flow_update *update,
6303                            struct ovs_list *replies)
6304 {
6305     enum ofp_version version = ofpmp_version(replies);
6306     struct nx_flow_update_header *nfuh;
6307     struct ofpbuf *msg;
6308     size_t start_ofs;
6309
6310     msg = ofpbuf_from_list(list_back(replies));
6311     start_ofs = msg->size;
6312
6313     if (update->event == NXFME_ABBREV) {
6314         struct nx_flow_update_abbrev *nfua;
6315
6316         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
6317         nfua->xid = update->xid;
6318     } else {
6319         struct nx_flow_update_full *nfuf;
6320         int match_len;
6321
6322         ofpbuf_put_zeros(msg, sizeof *nfuf);
6323         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
6324         ofpacts_put_openflow_actions(update->ofpacts, update->ofpacts_len, msg,
6325                                      version);
6326         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
6327         nfuf->reason = htons(update->reason);
6328         nfuf->priority = htons(update->priority);
6329         nfuf->idle_timeout = htons(update->idle_timeout);
6330         nfuf->hard_timeout = htons(update->hard_timeout);
6331         nfuf->match_len = htons(match_len);
6332         nfuf->table_id = update->table_id;
6333         nfuf->cookie = update->cookie;
6334     }
6335
6336     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
6337     nfuh->length = htons(msg->size - start_ofs);
6338     nfuh->event = htons(update->event);
6339
6340     ofpmp_postappend(replies, start_ofs);
6341 }
6342 \f
6343 struct ofpbuf *
6344 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
6345                           enum ofputil_protocol protocol)
6346 {
6347     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
6348     struct ofpbuf *msg;
6349     size_t size;
6350
6351     size = po->ofpacts_len;
6352     if (po->buffer_id == UINT32_MAX) {
6353         size += po->packet_len;
6354     }
6355
6356     switch (ofp_version) {
6357     case OFP10_VERSION: {
6358         struct ofp10_packet_out *opo;
6359         size_t actions_ofs;
6360
6361         msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
6362         ofpbuf_put_zeros(msg, sizeof *opo);
6363         actions_ofs = msg->size;
6364         ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6365                                      ofp_version);
6366
6367         opo = msg->msg;
6368         opo->buffer_id = htonl(po->buffer_id);
6369         opo->in_port = htons(ofp_to_u16(po->in_port));
6370         opo->actions_len = htons(msg->size - actions_ofs);
6371         break;
6372     }
6373
6374     case OFP11_VERSION:
6375     case OFP12_VERSION:
6376     case OFP13_VERSION:
6377     case OFP14_VERSION:
6378     case OFP15_VERSION: {
6379         struct ofp11_packet_out *opo;
6380         size_t len;
6381
6382         msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
6383         ofpbuf_put_zeros(msg, sizeof *opo);
6384         len = ofpacts_put_openflow_actions(po->ofpacts, po->ofpacts_len, msg,
6385                                            ofp_version);
6386         opo = msg->msg;
6387         opo->buffer_id = htonl(po->buffer_id);
6388         opo->in_port = ofputil_port_to_ofp11(po->in_port);
6389         opo->actions_len = htons(len);
6390         break;
6391     }
6392
6393     default:
6394         OVS_NOT_REACHED();
6395     }
6396
6397     if (po->buffer_id == UINT32_MAX) {
6398         ofpbuf_put(msg, po->packet, po->packet_len);
6399     }
6400
6401     ofpmsg_update_length(msg);
6402
6403     return msg;
6404 }
6405 \f
6406 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
6407 struct ofpbuf *
6408 make_echo_request(enum ofp_version ofp_version)
6409 {
6410     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
6411                             htonl(0), 0);
6412 }
6413
6414 /* Creates and returns an OFPT_ECHO_REPLY message matching the
6415  * OFPT_ECHO_REQUEST message in 'rq'. */
6416 struct ofpbuf *
6417 make_echo_reply(const struct ofp_header *rq)
6418 {
6419     struct ofpbuf rq_buf;
6420     struct ofpbuf *reply;
6421
6422     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
6423     ofpraw_pull_assert(&rq_buf);
6424
6425     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
6426     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
6427     return reply;
6428 }
6429
6430 struct ofpbuf *
6431 ofputil_encode_barrier_request(enum ofp_version ofp_version)
6432 {
6433     enum ofpraw type;
6434
6435     switch (ofp_version) {
6436     case OFP15_VERSION:
6437     case OFP14_VERSION:
6438     case OFP13_VERSION:
6439     case OFP12_VERSION:
6440     case OFP11_VERSION:
6441         type = OFPRAW_OFPT11_BARRIER_REQUEST;
6442         break;
6443
6444     case OFP10_VERSION:
6445         type = OFPRAW_OFPT10_BARRIER_REQUEST;
6446         break;
6447
6448     default:
6449         OVS_NOT_REACHED();
6450     }
6451
6452     return ofpraw_alloc(type, ofp_version, 0);
6453 }
6454
6455 const char *
6456 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
6457 {
6458     switch (flags & OFPC_FRAG_MASK) {
6459     case OFPC_FRAG_NORMAL:   return "normal";
6460     case OFPC_FRAG_DROP:     return "drop";
6461     case OFPC_FRAG_REASM:    return "reassemble";
6462     case OFPC_FRAG_NX_MATCH: return "nx-match";
6463     }
6464
6465     OVS_NOT_REACHED();
6466 }
6467
6468 bool
6469 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
6470 {
6471     if (!strcasecmp(s, "normal")) {
6472         *flags = OFPC_FRAG_NORMAL;
6473     } else if (!strcasecmp(s, "drop")) {
6474         *flags = OFPC_FRAG_DROP;
6475     } else if (!strcasecmp(s, "reassemble")) {
6476         *flags = OFPC_FRAG_REASM;
6477     } else if (!strcasecmp(s, "nx-match")) {
6478         *flags = OFPC_FRAG_NX_MATCH;
6479     } else {
6480         return false;
6481     }
6482     return true;
6483 }
6484
6485 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
6486  * port number and stores the latter in '*ofp10_port', for the purpose of
6487  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
6488  * otherwise an OFPERR_* number.  On error, stores OFPP_NONE in '*ofp10_port'.
6489  *
6490  * See the definition of OFP11_MAX for an explanation of the mapping. */
6491 enum ofperr
6492 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
6493 {
6494     uint32_t ofp11_port_h = ntohl(ofp11_port);
6495
6496     if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
6497         *ofp10_port = u16_to_ofp(ofp11_port_h);
6498         return 0;
6499     } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
6500         *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
6501         return 0;
6502     } else {
6503         *ofp10_port = OFPP_NONE;
6504         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
6505                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
6506                      ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
6507                      ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6508         return OFPERR_OFPBAC_BAD_OUT_PORT;
6509     }
6510 }
6511
6512 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
6513  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
6514  *
6515  * See the definition of OFP11_MAX for an explanation of the mapping. */
6516 ovs_be32
6517 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
6518 {
6519     return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
6520                  ? ofp_to_u16(ofp10_port)
6521                  : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
6522 }
6523
6524 #define OFPUTIL_NAMED_PORTS                     \
6525         OFPUTIL_NAMED_PORT(IN_PORT)             \
6526         OFPUTIL_NAMED_PORT(TABLE)               \
6527         OFPUTIL_NAMED_PORT(NORMAL)              \
6528         OFPUTIL_NAMED_PORT(FLOOD)               \
6529         OFPUTIL_NAMED_PORT(ALL)                 \
6530         OFPUTIL_NAMED_PORT(CONTROLLER)          \
6531         OFPUTIL_NAMED_PORT(LOCAL)               \
6532         OFPUTIL_NAMED_PORT(ANY)                 \
6533         OFPUTIL_NAMED_PORT(UNSET)
6534
6535 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
6536 #define OFPUTIL_NAMED_PORTS_WITH_NONE           \
6537         OFPUTIL_NAMED_PORTS                     \
6538         OFPUTIL_NAMED_PORT(NONE)
6539
6540 /* Stores the port number represented by 's' into '*portp'.  's' may be an
6541  * integer or, for reserved ports, the standard OpenFlow name for the port
6542  * (e.g. "LOCAL").
6543  *
6544  * Returns true if successful, false if 's' is not a valid OpenFlow port number
6545  * or name.  The caller should issue an error message in this case, because
6546  * this function usually does not.  (This gives the caller an opportunity to
6547  * look up the port name another way, e.g. by contacting the switch and listing
6548  * the names of all its ports).
6549  *
6550  * This function accepts OpenFlow 1.0 port numbers.  It also accepts a subset
6551  * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
6552  * range as described in include/openflow/openflow-1.1.h. */
6553 bool
6554 ofputil_port_from_string(const char *s, ofp_port_t *portp)
6555 {
6556     unsigned int port32; /* int is at least 32 bits wide. */
6557
6558     if (*s == '-') {
6559         VLOG_WARN("Negative value %s is not a valid port number.", s);
6560         return false;
6561     }
6562     *portp = 0;
6563     if (str_to_uint(s, 10, &port32)) {
6564         if (port32 < ofp_to_u16(OFPP_MAX)) {
6565             /* Pass. */
6566         } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
6567             VLOG_WARN("port %u is a reserved OF1.0 port number that will "
6568                       "be translated to %u when talking to an OF1.1 or "
6569                       "later controller", port32, port32 + OFPP11_OFFSET);
6570         } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
6571             char name[OFP_MAX_PORT_NAME_LEN];
6572
6573             ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
6574             VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
6575                            "for compatibility with OpenFlow 1.1 and later",
6576                            name, port32);
6577         } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
6578             VLOG_WARN("port %u is outside the supported range 0 through "
6579                       "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
6580                       UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
6581             return false;
6582         } else {
6583             port32 -= OFPP11_OFFSET;
6584         }
6585
6586         *portp = u16_to_ofp(port32);
6587         return true;
6588     } else {
6589         struct pair {
6590             const char *name;
6591             ofp_port_t value;
6592         };
6593         static const struct pair pairs[] = {
6594 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
6595             OFPUTIL_NAMED_PORTS_WITH_NONE
6596 #undef OFPUTIL_NAMED_PORT
6597         };
6598         const struct pair *p;
6599
6600         for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
6601             if (!strcasecmp(s, p->name)) {
6602                 *portp = p->value;
6603                 return true;
6604             }
6605         }
6606         return false;
6607     }
6608 }
6609
6610 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
6611  * Most ports' string representation is just the port number, but for special
6612  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
6613 void
6614 ofputil_format_port(ofp_port_t port, struct ds *s)
6615 {
6616     char name[OFP_MAX_PORT_NAME_LEN];
6617
6618     ofputil_port_to_string(port, name, sizeof name);
6619     ds_put_cstr(s, name);
6620 }
6621
6622 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
6623  * representation of OpenFlow port number 'port'.  Most ports are represented
6624  * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
6625  * by name, e.g. "LOCAL". */
6626 void
6627 ofputil_port_to_string(ofp_port_t port,
6628                        char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
6629 {
6630     switch (port) {
6631 #define OFPUTIL_NAMED_PORT(NAME)                        \
6632         case OFPP_##NAME:                               \
6633             ovs_strlcpy(namebuf, #NAME, bufsize);       \
6634             break;
6635         OFPUTIL_NAMED_PORTS
6636 #undef OFPUTIL_NAMED_PORT
6637
6638     default:
6639         snprintf(namebuf, bufsize, "%"PRIu16, port);
6640         break;
6641     }
6642 }
6643
6644 /* Stores the group id represented by 's' into '*group_idp'.  's' may be an
6645  * integer or, for reserved group IDs, the standard OpenFlow name for the group
6646  * (either "ANY" or "ALL").
6647  *
6648  * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
6649  * name. */
6650 bool
6651 ofputil_group_from_string(const char *s, uint32_t *group_idp)
6652 {
6653     if (!strcasecmp(s, "any")) {
6654         *group_idp = OFPG_ANY;
6655     } else if (!strcasecmp(s, "all")) {
6656         *group_idp = OFPG_ALL;
6657     } else if (!str_to_uint(s, 10, group_idp)) {
6658         VLOG_WARN("%s is not a valid group ID.  (Valid group IDs are "
6659                   "32-bit nonnegative integers or the keywords ANY or "
6660                   "ALL.)", s);
6661         return false;
6662     }
6663
6664     return true;
6665 }
6666
6667 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
6668  * Most groups' string representation is just the number, but for special
6669  * groups, e.g. OFPG_ALL, it is the name, e.g. "ALL". */
6670 void
6671 ofputil_format_group(uint32_t group_id, struct ds *s)
6672 {
6673     char name[MAX_GROUP_NAME_LEN];
6674
6675     ofputil_group_to_string(group_id, name, sizeof name);
6676     ds_put_cstr(s, name);
6677 }
6678
6679
6680 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
6681  * representation of OpenFlow group ID 'group_id'.  Most group are represented
6682  * as just their number, but special groups, e.g. OFPG_ALL, are represented
6683  * by name, e.g. "ALL". */
6684 void
6685 ofputil_group_to_string(uint32_t group_id,
6686                         char namebuf[MAX_GROUP_NAME_LEN + 1], size_t bufsize)
6687 {
6688     switch (group_id) {
6689     case OFPG_ALL:
6690         ovs_strlcpy(namebuf, "ALL", bufsize);
6691         break;
6692
6693     case OFPG_ANY:
6694         ovs_strlcpy(namebuf, "ANY", bufsize);
6695         break;
6696
6697     default:
6698         snprintf(namebuf, bufsize, "%"PRIu32, group_id);
6699         break;
6700     }
6701 }
6702
6703 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
6704  * 'ofp_version', tries to pull the first element from the array.  If
6705  * successful, initializes '*pp' with an abstract representation of the
6706  * port and returns 0.  If no ports remain to be decoded, returns EOF.
6707  * On an error, returns a positive OFPERR_* value. */
6708 int
6709 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
6710                       struct ofputil_phy_port *pp)
6711 {
6712     memset(pp, 0, sizeof *pp);
6713
6714     switch (ofp_version) {
6715     case OFP10_VERSION: {
6716         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
6717         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
6718     }
6719     case OFP11_VERSION:
6720     case OFP12_VERSION:
6721     case OFP13_VERSION: {
6722         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
6723         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
6724     }
6725     case OFP14_VERSION:
6726     case OFP15_VERSION:
6727         return b->size ? ofputil_pull_ofp14_port(pp, b) : EOF;
6728     default:
6729         OVS_NOT_REACHED();
6730     }
6731 }
6732
6733 static void
6734 ofputil_normalize_match__(struct match *match, bool may_log)
6735 {
6736     enum {
6737         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
6738         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
6739         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
6740         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
6741         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
6742         MAY_ARP_THA     = 1 << 5, /* arp_tha */
6743         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
6744         MAY_ND_TARGET   = 1 << 7, /* nd_target */
6745         MAY_MPLS        = 1 << 8, /* mpls label and tc */
6746     } may_match;
6747
6748     struct flow_wildcards wc;
6749
6750     /* Figure out what fields may be matched. */
6751     if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
6752         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
6753         if (match->flow.nw_proto == IPPROTO_TCP ||
6754             match->flow.nw_proto == IPPROTO_UDP ||
6755             match->flow.nw_proto == IPPROTO_SCTP ||
6756             match->flow.nw_proto == IPPROTO_ICMP) {
6757             may_match |= MAY_TP_ADDR;
6758         }
6759     } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
6760         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
6761         if (match->flow.nw_proto == IPPROTO_TCP ||
6762             match->flow.nw_proto == IPPROTO_UDP ||
6763             match->flow.nw_proto == IPPROTO_SCTP) {
6764             may_match |= MAY_TP_ADDR;
6765         } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
6766             may_match |= MAY_TP_ADDR;
6767             if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
6768                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
6769             } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
6770                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
6771             }
6772         }
6773     } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
6774                match->flow.dl_type == htons(ETH_TYPE_RARP)) {
6775         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
6776     } else if (eth_type_mpls(match->flow.dl_type)) {
6777         may_match = MAY_MPLS;
6778     } else {
6779         may_match = 0;
6780     }
6781
6782     /* Clear the fields that may not be matched. */
6783     wc = match->wc;
6784     if (!(may_match & MAY_NW_ADDR)) {
6785         wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
6786     }
6787     if (!(may_match & MAY_TP_ADDR)) {
6788         wc.masks.tp_src = wc.masks.tp_dst = htons(0);
6789     }
6790     if (!(may_match & MAY_NW_PROTO)) {
6791         wc.masks.nw_proto = 0;
6792     }
6793     if (!(may_match & MAY_IPVx)) {
6794         wc.masks.nw_tos = 0;
6795         wc.masks.nw_ttl = 0;
6796     }
6797     if (!(may_match & MAY_ARP_SHA)) {
6798         WC_UNMASK_FIELD(&wc, arp_sha);
6799     }
6800     if (!(may_match & MAY_ARP_THA)) {
6801         WC_UNMASK_FIELD(&wc, arp_tha);
6802     }
6803     if (!(may_match & MAY_IPV6)) {
6804         wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
6805         wc.masks.ipv6_label = htonl(0);
6806     }
6807     if (!(may_match & MAY_ND_TARGET)) {
6808         wc.masks.nd_target = in6addr_any;
6809     }
6810     if (!(may_match & MAY_MPLS)) {
6811         memset(wc.masks.mpls_lse, 0, sizeof wc.masks.mpls_lse);
6812     }
6813
6814     /* Log any changes. */
6815     if (!flow_wildcards_equal(&wc, &match->wc)) {
6816         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
6817         char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
6818
6819         match->wc = wc;
6820         match_zero_wildcarded_fields(match);
6821
6822         if (log) {
6823             char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
6824             VLOG_INFO("normalization changed ofp_match, details:");
6825             VLOG_INFO(" pre: %s", pre);
6826             VLOG_INFO("post: %s", post);
6827             free(pre);
6828             free(post);
6829         }
6830     }
6831 }
6832
6833 /* "Normalizes" the wildcards in 'match'.  That means:
6834  *
6835  *    1. If the type of level N is known, then only the valid fields for that
6836  *       level may be specified.  For example, ARP does not have a TOS field,
6837  *       so nw_tos must be wildcarded if 'match' specifies an ARP flow.
6838  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
6839  *       ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
6840  *       IPv4 flow.
6841  *
6842  *    2. If the type of level N is not known (or not understood by Open
6843  *       vSwitch), then no fields at all for that level may be specified.  For
6844  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
6845  *       L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
6846  *       SCTP flow.
6847  *
6848  * If this function changes 'match', it logs a rate-limited informational
6849  * message. */
6850 void
6851 ofputil_normalize_match(struct match *match)
6852 {
6853     ofputil_normalize_match__(match, true);
6854 }
6855
6856 /* Same as ofputil_normalize_match() without the logging.  Thus, this function
6857  * is suitable for a program's internal use, whereas ofputil_normalize_match()
6858  * sense for use on flows received from elsewhere (so that a bug in the program
6859  * that sent them can be reported and corrected). */
6860 void
6861 ofputil_normalize_match_quiet(struct match *match)
6862 {
6863     ofputil_normalize_match__(match, false);
6864 }
6865
6866 /* Parses a key or a key-value pair from '*stringp'.
6867  *
6868  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
6869  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
6870  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
6871  * are substrings of '*stringp' created by replacing some of its bytes by null
6872  * terminators.  Returns true.
6873  *
6874  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
6875  * NULL and returns false. */
6876 bool
6877 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
6878 {
6879     char *pos, *key, *value;
6880     size_t key_len;
6881
6882     pos = *stringp;
6883     pos += strspn(pos, ", \t\r\n");
6884     if (*pos == '\0') {
6885         *keyp = *valuep = NULL;
6886         return false;
6887     }
6888
6889     key = pos;
6890     key_len = strcspn(pos, ":=(, \t\r\n");
6891     if (key[key_len] == ':' || key[key_len] == '=') {
6892         /* The value can be separated by a colon. */
6893         size_t value_len;
6894
6895         value = key + key_len + 1;
6896         value_len = strcspn(value, ", \t\r\n");
6897         pos = value + value_len + (value[value_len] != '\0');
6898         value[value_len] = '\0';
6899     } else if (key[key_len] == '(') {
6900         /* The value can be surrounded by balanced parentheses.  The outermost
6901          * set of parentheses is removed. */
6902         int level = 1;
6903         size_t value_len;
6904
6905         value = key + key_len + 1;
6906         for (value_len = 0; level > 0; value_len++) {
6907             switch (value[value_len]) {
6908             case '\0':
6909                 level = 0;
6910                 break;
6911
6912             case '(':
6913                 level++;
6914                 break;
6915
6916             case ')':
6917                 level--;
6918                 break;
6919             }
6920         }
6921         value[value_len - 1] = '\0';
6922         pos = value + value_len;
6923     } else {
6924         /* There might be no value at all. */
6925         value = key + key_len;  /* Will become the empty string below. */
6926         pos = key + key_len + (key[key_len] != '\0');
6927     }
6928     key[key_len] = '\0';
6929
6930     *stringp = pos;
6931     *keyp = key;
6932     *valuep = value;
6933     return true;
6934 }
6935
6936 /* Encode a dump ports request for 'port', the encoded message
6937  * will be for OpenFlow version 'ofp_version'. Returns message
6938  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6939 struct ofpbuf *
6940 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
6941 {
6942     struct ofpbuf *request;
6943
6944     switch (ofp_version) {
6945     case OFP10_VERSION: {
6946         struct ofp10_port_stats_request *req;
6947         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
6948         req = ofpbuf_put_zeros(request, sizeof *req);
6949         req->port_no = htons(ofp_to_u16(port));
6950         break;
6951     }
6952     case OFP11_VERSION:
6953     case OFP12_VERSION:
6954     case OFP13_VERSION:
6955     case OFP14_VERSION:
6956     case OFP15_VERSION: {
6957         struct ofp11_port_stats_request *req;
6958         request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
6959         req = ofpbuf_put_zeros(request, sizeof *req);
6960         req->port_no = ofputil_port_to_ofp11(port);
6961         break;
6962     }
6963     default:
6964         OVS_NOT_REACHED();
6965     }
6966
6967     return request;
6968 }
6969
6970 static void
6971 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
6972                             struct ofp10_port_stats *ps10)
6973 {
6974     ps10->port_no = htons(ofp_to_u16(ops->port_no));
6975     memset(ps10->pad, 0, sizeof ps10->pad);
6976     put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
6977     put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
6978     put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
6979     put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
6980     put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
6981     put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
6982     put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
6983     put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
6984     put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
6985     put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
6986     put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
6987     put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
6988 }
6989
6990 static void
6991 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
6992                             struct ofp11_port_stats *ps11)
6993 {
6994     ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
6995     memset(ps11->pad, 0, sizeof ps11->pad);
6996     ps11->rx_packets = htonll(ops->stats.rx_packets);
6997     ps11->tx_packets = htonll(ops->stats.tx_packets);
6998     ps11->rx_bytes = htonll(ops->stats.rx_bytes);
6999     ps11->tx_bytes = htonll(ops->stats.tx_bytes);
7000     ps11->rx_dropped = htonll(ops->stats.rx_dropped);
7001     ps11->tx_dropped = htonll(ops->stats.tx_dropped);
7002     ps11->rx_errors = htonll(ops->stats.rx_errors);
7003     ps11->tx_errors = htonll(ops->stats.tx_errors);
7004     ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7005     ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
7006     ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7007     ps11->collisions = htonll(ops->stats.collisions);
7008 }
7009
7010 static void
7011 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
7012                             struct ofp13_port_stats *ps13)
7013 {
7014     ofputil_port_stats_to_ofp11(ops, &ps13->ps);
7015     ps13->duration_sec = htonl(ops->duration_sec);
7016     ps13->duration_nsec = htonl(ops->duration_nsec);
7017 }
7018
7019 static void
7020 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats *ops,
7021                                 struct ovs_list *replies)
7022 {
7023     struct ofp14_port_stats_prop_ethernet *eth;
7024     struct ofp14_port_stats *ps14;
7025     struct ofpbuf *reply;
7026
7027     reply = ofpmp_reserve(replies, sizeof *ps14 + sizeof *eth);
7028
7029     ps14 = ofpbuf_put_uninit(reply, sizeof *ps14);
7030     ps14->length = htons(sizeof *ps14 + sizeof *eth);
7031     memset(ps14->pad, 0, sizeof ps14->pad);
7032     ps14->port_no = ofputil_port_to_ofp11(ops->port_no);
7033     ps14->duration_sec = htonl(ops->duration_sec);
7034     ps14->duration_nsec = htonl(ops->duration_nsec);
7035     ps14->rx_packets = htonll(ops->stats.rx_packets);
7036     ps14->tx_packets = htonll(ops->stats.tx_packets);
7037     ps14->rx_bytes = htonll(ops->stats.rx_bytes);
7038     ps14->tx_bytes = htonll(ops->stats.tx_bytes);
7039     ps14->rx_dropped = htonll(ops->stats.rx_dropped);
7040     ps14->tx_dropped = htonll(ops->stats.tx_dropped);
7041     ps14->rx_errors = htonll(ops->stats.rx_errors);
7042     ps14->tx_errors = htonll(ops->stats.tx_errors);
7043
7044     eth = ofpbuf_put_uninit(reply, sizeof *eth);
7045     eth->type = htons(OFPPSPT14_ETHERNET);
7046     eth->length = htons(sizeof *eth);
7047     memset(eth->pad, 0, sizeof eth->pad);
7048     eth->rx_frame_err = htonll(ops->stats.rx_frame_errors);
7049     eth->rx_over_err = htonll(ops->stats.rx_over_errors);
7050     eth->rx_crc_err = htonll(ops->stats.rx_crc_errors);
7051     eth->collisions = htonll(ops->stats.collisions);
7052 }
7053
7054 /* Encode a ports stat for 'ops' and append it to 'replies'. */
7055 void
7056 ofputil_append_port_stat(struct ovs_list *replies,
7057                          const struct ofputil_port_stats *ops)
7058 {
7059     switch (ofpmp_version(replies)) {
7060     case OFP13_VERSION: {
7061         struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7062         ofputil_port_stats_to_ofp13(ops, reply);
7063         break;
7064     }
7065     case OFP12_VERSION:
7066     case OFP11_VERSION: {
7067         struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7068         ofputil_port_stats_to_ofp11(ops, reply);
7069         break;
7070     }
7071
7072     case OFP10_VERSION: {
7073         struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
7074         ofputil_port_stats_to_ofp10(ops, reply);
7075         break;
7076     }
7077
7078     case OFP14_VERSION:
7079     case OFP15_VERSION:
7080         ofputil_append_ofp14_port_stats(ops, replies);
7081         break;
7082
7083     default:
7084         OVS_NOT_REACHED();
7085     }
7086 }
7087
7088 static enum ofperr
7089 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
7090                               const struct ofp10_port_stats *ps10)
7091 {
7092     memset(ops, 0, sizeof *ops);
7093
7094     ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
7095     ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
7096     ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
7097     ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
7098     ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
7099     ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
7100     ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
7101     ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
7102     ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
7103     ops->stats.rx_frame_errors =
7104         ntohll(get_32aligned_be64(&ps10->rx_frame_err));
7105     ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
7106     ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
7107     ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
7108     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7109
7110     return 0;
7111 }
7112
7113 static enum ofperr
7114 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
7115                               const struct ofp11_port_stats *ps11)
7116 {
7117     enum ofperr error;
7118
7119     memset(ops, 0, sizeof *ops);
7120     error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
7121     if (error) {
7122         return error;
7123     }
7124
7125     ops->stats.rx_packets = ntohll(ps11->rx_packets);
7126     ops->stats.tx_packets = ntohll(ps11->tx_packets);
7127     ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
7128     ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
7129     ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
7130     ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
7131     ops->stats.rx_errors = ntohll(ps11->rx_errors);
7132     ops->stats.tx_errors = ntohll(ps11->tx_errors);
7133     ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
7134     ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
7135     ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
7136     ops->stats.collisions = ntohll(ps11->collisions);
7137     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
7138
7139     return 0;
7140 }
7141
7142 static enum ofperr
7143 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
7144                               const struct ofp13_port_stats *ps13)
7145 {
7146     enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
7147     if (!error) {
7148         ops->duration_sec = ntohl(ps13->duration_sec);
7149         ops->duration_nsec = ntohl(ps13->duration_nsec);
7150     }
7151     return error;
7152 }
7153
7154 static enum ofperr
7155 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf *payload,
7156                                          struct ofputil_port_stats *ops)
7157 {
7158     const struct ofp14_port_stats_prop_ethernet *eth = payload->data;
7159
7160     if (payload->size != sizeof *eth) {
7161         return OFPERR_OFPBPC_BAD_LEN;
7162     }
7163
7164     ops->stats.rx_frame_errors = ntohll(eth->rx_frame_err);
7165     ops->stats.rx_over_errors = ntohll(eth->rx_over_err);
7166     ops->stats.rx_crc_errors = ntohll(eth->rx_crc_err);
7167     ops->stats.collisions = ntohll(eth->collisions);
7168
7169     return 0;
7170 }
7171
7172 static enum ofperr
7173 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats *ops,
7174                               struct ofpbuf *msg)
7175 {
7176     const struct ofp14_port_stats *ps14;
7177     struct ofpbuf properties;
7178     enum ofperr error;
7179     size_t len;
7180
7181     ps14 = ofpbuf_try_pull(msg, sizeof *ps14);
7182     if (!ps14) {
7183         return OFPERR_OFPBRC_BAD_LEN;
7184     }
7185
7186     len = ntohs(ps14->length);
7187     if (len < sizeof *ps14 || len - sizeof *ps14 > msg->size) {
7188         return OFPERR_OFPBRC_BAD_LEN;
7189     }
7190     len -= sizeof *ps14;
7191     ofpbuf_use_const(&properties, ofpbuf_pull(msg, len), len);
7192
7193     error = ofputil_port_from_ofp11(ps14->port_no, &ops->port_no);
7194     if (error) {
7195         return error;
7196     }
7197
7198     ops->duration_sec = ntohl(ps14->duration_sec);
7199     ops->duration_nsec = ntohl(ps14->duration_nsec);
7200     ops->stats.rx_packets = ntohll(ps14->rx_packets);
7201     ops->stats.tx_packets = ntohll(ps14->tx_packets);
7202     ops->stats.rx_bytes = ntohll(ps14->rx_bytes);
7203     ops->stats.tx_bytes = ntohll(ps14->tx_bytes);
7204     ops->stats.rx_dropped = ntohll(ps14->rx_dropped);
7205     ops->stats.tx_dropped = ntohll(ps14->tx_dropped);
7206     ops->stats.rx_errors = ntohll(ps14->rx_errors);
7207     ops->stats.tx_errors = ntohll(ps14->tx_errors);
7208     ops->stats.rx_frame_errors = UINT64_MAX;
7209     ops->stats.rx_over_errors = UINT64_MAX;
7210     ops->stats.rx_crc_errors = UINT64_MAX;
7211     ops->stats.collisions = UINT64_MAX;
7212
7213     while (properties.size > 0) {
7214         struct ofpbuf payload;
7215         enum ofperr error;
7216         uint16_t type;
7217
7218         error = ofputil_pull_property(&properties, &payload, &type);
7219         if (error) {
7220             return error;
7221         }
7222
7223         switch (type) {
7224         case OFPPSPT14_ETHERNET:
7225             error = parse_ofp14_port_stats_ethernet_property(&payload, ops);
7226             break;
7227
7228         default:
7229             log_property(true, "unknown port stats property %"PRIu16, type);
7230             error = 0;
7231             break;
7232         }
7233
7234         if (error) {
7235             return error;
7236         }
7237     }
7238
7239     return 0;
7240 }
7241
7242 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
7243  * message 'oh'. */
7244 size_t
7245 ofputil_count_port_stats(const struct ofp_header *oh)
7246 {
7247     struct ofputil_port_stats ps;
7248     struct ofpbuf b;
7249     size_t n = 0;
7250
7251     ofpbuf_use_const(&b, oh, ntohs(oh->length));
7252     ofpraw_pull_assert(&b);
7253     while (!ofputil_decode_port_stats(&ps, &b)) {
7254         n++;
7255     }
7256     return n;
7257 }
7258
7259 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
7260  * ofputil_port_stats in 'ps'.
7261  *
7262  * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
7263  * message.  Calling this function multiple times for a single 'msg' iterates
7264  * through the replies.  The caller must initially leave 'msg''s layer pointers
7265  * null and not modify them between calls.
7266  *
7267  * Returns 0 if successful, EOF if no replies were left in this 'msg',
7268  * otherwise a positive errno value. */
7269 int
7270 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
7271 {
7272     enum ofperr error;
7273     enum ofpraw raw;
7274
7275     error = (msg->header ? ofpraw_decode(&raw, msg->header)
7276              : ofpraw_pull(&raw, msg));
7277     if (error) {
7278         return error;
7279     }
7280
7281     if (!msg->size) {
7282         return EOF;
7283     } else if (raw == OFPRAW_OFPST14_PORT_REPLY) {
7284         return ofputil_pull_ofp14_port_stats(ps, msg);
7285     } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
7286         const struct ofp13_port_stats *ps13;
7287
7288         ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
7289         if (!ps13) {
7290             goto bad_len;
7291         }
7292         return ofputil_port_stats_from_ofp13(ps, ps13);
7293     } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
7294         const struct ofp11_port_stats *ps11;
7295
7296         ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
7297         if (!ps11) {
7298             goto bad_len;
7299         }
7300         return ofputil_port_stats_from_ofp11(ps, ps11);
7301     } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
7302         const struct ofp10_port_stats *ps10;
7303
7304         ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
7305         if (!ps10) {
7306             goto bad_len;
7307         }
7308         return ofputil_port_stats_from_ofp10(ps, ps10);
7309     } else {
7310         OVS_NOT_REACHED();
7311     }
7312
7313  bad_len:
7314     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %"PRIu32" leftover "
7315                  "bytes at end", msg->size);
7316     return OFPERR_OFPBRC_BAD_LEN;
7317 }
7318
7319 /* Parse a port status request message into a 16 bit OpenFlow 1.0
7320  * port number and stores the latter in '*ofp10_port'.
7321  * Returns 0 if successful, otherwise an OFPERR_* number. */
7322 enum ofperr
7323 ofputil_decode_port_stats_request(const struct ofp_header *request,
7324                                   ofp_port_t *ofp10_port)
7325 {
7326     switch ((enum ofp_version)request->version) {
7327     case OFP15_VERSION:
7328     case OFP14_VERSION:
7329     case OFP13_VERSION:
7330     case OFP12_VERSION:
7331     case OFP11_VERSION: {
7332         const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
7333         return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
7334     }
7335
7336     case OFP10_VERSION: {
7337         const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
7338         *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
7339         return 0;
7340     }
7341
7342     default:
7343         OVS_NOT_REACHED();
7344     }
7345 }
7346
7347 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
7348 void
7349 ofputil_bucket_list_destroy(struct ovs_list *buckets)
7350 {
7351     struct ofputil_bucket *bucket;
7352
7353     LIST_FOR_EACH_POP (bucket, list_node, buckets) {
7354         free(bucket->ofpacts);
7355         free(bucket);
7356     }
7357 }
7358
7359 /* Clones 'bucket' and its ofpacts data */
7360 static struct ofputil_bucket *
7361 ofputil_bucket_clone_data(const struct ofputil_bucket *bucket)
7362 {
7363     struct ofputil_bucket *new;
7364
7365     new = xmemdup(bucket, sizeof *bucket);
7366     new->ofpacts = xmemdup(bucket->ofpacts, bucket->ofpacts_len);
7367
7368     return new;
7369 }
7370
7371 /* Clones each of the buckets in the list 'src' appending them
7372  * in turn to 'dest' which should be an initialised list.
7373  * An exception is that if the pointer value of a bucket in 'src'
7374  * matches 'skip' then it is not cloned or appended to 'dest'.
7375  * This allows all of 'src' or 'all of 'src' except 'skip' to
7376  * be cloned and appended to 'dest'. */
7377 void
7378 ofputil_bucket_clone_list(struct ovs_list *dest, const struct ovs_list *src,
7379                           const struct ofputil_bucket *skip)
7380 {
7381     struct ofputil_bucket *bucket;
7382
7383     LIST_FOR_EACH (bucket, list_node, src) {
7384         struct ofputil_bucket *new_bucket;
7385
7386         if (bucket == skip) {
7387             continue;
7388         }
7389
7390         new_bucket = ofputil_bucket_clone_data(bucket);
7391         list_push_back(dest, &new_bucket->list_node);
7392     }
7393 }
7394
7395 /* Find a bucket in the list 'buckets' whose bucket id is 'bucket_id'
7396  * Returns the first bucket found or NULL if no buckets are found. */
7397 struct ofputil_bucket *
7398 ofputil_bucket_find(const struct ovs_list *buckets, uint32_t bucket_id)
7399 {
7400     struct ofputil_bucket *bucket;
7401
7402     if (bucket_id > OFPG15_BUCKET_MAX) {
7403         return NULL;
7404     }
7405
7406     LIST_FOR_EACH (bucket, list_node, buckets) {
7407         if (bucket->bucket_id == bucket_id) {
7408             return bucket;
7409         }
7410     }
7411
7412     return NULL;
7413 }
7414
7415 /* Returns true if more than one bucket in the list 'buckets'
7416  * have the same bucket id. Returns false otherwise. */
7417 bool
7418 ofputil_bucket_check_duplicate_id(const struct ovs_list *buckets)
7419 {
7420     struct ofputil_bucket *i, *j;
7421
7422     LIST_FOR_EACH (i, list_node, buckets) {
7423         LIST_FOR_EACH_REVERSE (j, list_node, buckets) {
7424             if (i == j) {
7425                 break;
7426             }
7427             if (i->bucket_id == j->bucket_id) {
7428                 return true;
7429             }
7430         }
7431     }
7432
7433     return false;
7434 }
7435
7436 /* Returns the bucket at the front of the list 'buckets'.
7437  * Undefined if 'buckets is empty. */
7438 struct ofputil_bucket *
7439 ofputil_bucket_list_front(const struct ovs_list *buckets)
7440 {
7441     static struct ofputil_bucket *bucket;
7442
7443     ASSIGN_CONTAINER(bucket, list_front(buckets), list_node);
7444
7445     return bucket;
7446 }
7447
7448 /* Returns the bucket at the back of the list 'buckets'.
7449  * Undefined if 'buckets is empty. */
7450 struct ofputil_bucket *
7451 ofputil_bucket_list_back(const struct ovs_list *buckets)
7452 {
7453     static struct ofputil_bucket *bucket;
7454
7455     ASSIGN_CONTAINER(bucket, list_back(buckets), list_node);
7456
7457     return bucket;
7458 }
7459
7460 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
7461  * that requests stats for group 'group_id'.  (Use OFPG_ALL to request stats
7462  * for all groups.)
7463  *
7464  * Group statistics include packet and byte counts for each group. */
7465 struct ofpbuf *
7466 ofputil_encode_group_stats_request(enum ofp_version ofp_version,
7467                                    uint32_t group_id)
7468 {
7469     struct ofpbuf *request;
7470
7471     switch (ofp_version) {
7472     case OFP10_VERSION:
7473         ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
7474                      "(\'-O OpenFlow11\')");
7475     case OFP11_VERSION:
7476     case OFP12_VERSION:
7477     case OFP13_VERSION:
7478     case OFP14_VERSION:
7479     case OFP15_VERSION: {
7480         struct ofp11_group_stats_request *req;
7481         request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST, ofp_version, 0);
7482         req = ofpbuf_put_zeros(request, sizeof *req);
7483         req->group_id = htonl(group_id);
7484         break;
7485     }
7486     default:
7487         OVS_NOT_REACHED();
7488     }
7489
7490     return request;
7491 }
7492
7493 void
7494 ofputil_uninit_group_desc(struct ofputil_group_desc *gd)
7495 {
7496     ofputil_bucket_list_destroy(&gd->buckets);
7497     free(&gd->props.fields);
7498 }
7499
7500 /* Decodes the OpenFlow group description request in 'oh', returning the group
7501  * whose description is requested, or OFPG_ALL if stats for all groups was
7502  * requested. */
7503 uint32_t
7504 ofputil_decode_group_desc_request(const struct ofp_header *oh)
7505 {
7506     struct ofpbuf request;
7507     enum ofpraw raw;
7508
7509     ofpbuf_use_const(&request, oh, ntohs(oh->length));
7510     raw = ofpraw_pull_assert(&request);
7511     if (raw == OFPRAW_OFPST11_GROUP_DESC_REQUEST) {
7512         return OFPG_ALL;
7513     } else if (raw == OFPRAW_OFPST15_GROUP_DESC_REQUEST) {
7514         ovs_be32 *group_id = ofpbuf_pull(&request, sizeof *group_id);
7515         return ntohl(*group_id);
7516     } else {
7517         OVS_NOT_REACHED();
7518     }
7519 }
7520
7521 /* Returns an OpenFlow group description request for OpenFlow version
7522  * 'ofp_version', that requests stats for group 'group_id'.  Use OFPG_ALL to
7523  * request stats for all groups (OpenFlow 1.4 and earlier always request all
7524  * groups).
7525  *
7526  * Group descriptions include the bucket and action configuration for each
7527  * group. */
7528 struct ofpbuf *
7529 ofputil_encode_group_desc_request(enum ofp_version ofp_version,
7530                                   uint32_t group_id)
7531 {
7532     struct ofpbuf *request;
7533
7534     switch (ofp_version) {
7535     case OFP10_VERSION:
7536         ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
7537                      "(\'-O OpenFlow11\')");
7538     case OFP11_VERSION:
7539     case OFP12_VERSION:
7540     case OFP13_VERSION:
7541     case OFP14_VERSION:
7542         request = ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST,
7543                                ofp_version, 0);
7544         break;
7545     case OFP15_VERSION:{
7546         struct ofp15_group_desc_request *req;
7547         request = ofpraw_alloc(OFPRAW_OFPST15_GROUP_DESC_REQUEST,
7548                                ofp_version, 0);
7549         req = ofpbuf_put_zeros(request, sizeof *req);
7550         req->group_id = htonl(group_id);
7551         break;
7552     }
7553     default:
7554         OVS_NOT_REACHED();
7555     }
7556
7557     return request;
7558 }
7559
7560 static void
7561 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats *gs,
7562                                     struct ofp11_bucket_counter bucket_cnts[])
7563 {
7564     int i;
7565
7566     for (i = 0; i < gs->n_buckets; i++) {
7567        bucket_cnts[i].packet_count = htonll(gs->bucket_stats[i].packet_count);
7568        bucket_cnts[i].byte_count = htonll(gs->bucket_stats[i].byte_count);
7569     }
7570 }
7571
7572 static void
7573 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats *gs,
7574                              struct ofp11_group_stats *gs11, size_t length,
7575                              struct ofp11_bucket_counter bucket_cnts[])
7576 {
7577     memset(gs11, 0, sizeof *gs11);
7578     gs11->length = htons(length);
7579     gs11->group_id = htonl(gs->group_id);
7580     gs11->ref_count = htonl(gs->ref_count);
7581     gs11->packet_count = htonll(gs->packet_count);
7582     gs11->byte_count = htonll(gs->byte_count);
7583     ofputil_group_bucket_counters_to_ofp11(gs, bucket_cnts);
7584 }
7585
7586 static void
7587 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats *gs,
7588                              struct ofp13_group_stats *gs13, size_t length,
7589                              struct ofp11_bucket_counter bucket_cnts[])
7590 {
7591     ofputil_group_stats_to_ofp11(gs, &gs13->gs, length, bucket_cnts);
7592     gs13->duration_sec = htonl(gs->duration_sec);
7593     gs13->duration_nsec = htonl(gs->duration_nsec);
7594
7595 }
7596
7597 /* Encodes 'gs' properly for the format of the list of group statistics
7598  * replies already begun in 'replies' and appends it to the list.  'replies'
7599  * must have originally been initialized with ofpmp_init(). */
7600 void
7601 ofputil_append_group_stats(struct ovs_list *replies,
7602                            const struct ofputil_group_stats *gs)
7603 {
7604     size_t bucket_counter_size;
7605     struct ofp11_bucket_counter *bucket_counters;
7606     size_t length;
7607
7608     bucket_counter_size = gs->n_buckets * sizeof(struct ofp11_bucket_counter);
7609
7610     switch (ofpmp_version(replies)) {
7611     case OFP11_VERSION:
7612     case OFP12_VERSION:{
7613             struct ofp11_group_stats *gs11;
7614
7615             length = sizeof *gs11 + bucket_counter_size;
7616             gs11 = ofpmp_append(replies, length);
7617             bucket_counters = (struct ofp11_bucket_counter *)(gs11 + 1);
7618             ofputil_group_stats_to_ofp11(gs, gs11, length, bucket_counters);
7619             break;
7620         }
7621
7622     case OFP13_VERSION:
7623     case OFP14_VERSION:
7624     case OFP15_VERSION: {
7625             struct ofp13_group_stats *gs13;
7626
7627             length = sizeof *gs13 + bucket_counter_size;
7628             gs13 = ofpmp_append(replies, length);
7629             bucket_counters = (struct ofp11_bucket_counter *)(gs13 + 1);
7630             ofputil_group_stats_to_ofp13(gs, gs13, length, bucket_counters);
7631             break;
7632         }
7633
7634     case OFP10_VERSION:
7635     default:
7636         OVS_NOT_REACHED();
7637     }
7638 }
7639 /* Returns an OpenFlow group features request for OpenFlow version
7640  * 'ofp_version'. */
7641 struct ofpbuf *
7642 ofputil_encode_group_features_request(enum ofp_version ofp_version)
7643 {
7644     struct ofpbuf *request = NULL;
7645
7646     switch (ofp_version) {
7647     case OFP10_VERSION:
7648     case OFP11_VERSION:
7649         ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
7650                      "(\'-O OpenFlow12\')");
7651     case OFP12_VERSION:
7652     case OFP13_VERSION:
7653     case OFP14_VERSION:
7654     case OFP15_VERSION:
7655         request = ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
7656                                ofp_version, 0);
7657         break;
7658     default:
7659         OVS_NOT_REACHED();
7660     }
7661
7662     return request;
7663 }
7664
7665 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
7666  * group features request 'request'. */
7667 struct ofpbuf *
7668 ofputil_encode_group_features_reply(
7669     const struct ofputil_group_features *features,
7670     const struct ofp_header *request)
7671 {
7672     struct ofp12_group_features_stats *ogf;
7673     struct ofpbuf *reply;
7674     int i;
7675
7676     reply = ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
7677                              request->version, request->xid, 0);
7678     ogf = ofpbuf_put_zeros(reply, sizeof *ogf);
7679     ogf->types = htonl(features->types);
7680     ogf->capabilities = htonl(features->capabilities);
7681     for (i = 0; i < OFPGT12_N_TYPES; i++) {
7682         ogf->max_groups[i] = htonl(features->max_groups[i]);
7683         ogf->actions[i] = ofpact_bitmap_to_openflow(features->ofpacts[i],
7684                                                     request->version);
7685     }
7686
7687     return reply;
7688 }
7689
7690 /* Decodes group features reply 'oh' into 'features'. */
7691 void
7692 ofputil_decode_group_features_reply(const struct ofp_header *oh,
7693                                     struct ofputil_group_features *features)
7694 {
7695     const struct ofp12_group_features_stats *ogf = ofpmsg_body(oh);
7696     int i;
7697
7698     features->types = ntohl(ogf->types);
7699     features->capabilities = ntohl(ogf->capabilities);
7700     for (i = 0; i < OFPGT12_N_TYPES; i++) {
7701         features->max_groups[i] = ntohl(ogf->max_groups[i]);
7702         features->ofpacts[i] = ofpact_bitmap_from_openflow(
7703             ogf->actions[i], oh->version);
7704     }
7705 }
7706
7707 /* Parse a group status request message into a 32 bit OpenFlow 1.1
7708  * group ID and stores the latter in '*group_id'.
7709  * Returns 0 if successful, otherwise an OFPERR_* number. */
7710 enum ofperr
7711 ofputil_decode_group_stats_request(const struct ofp_header *request,
7712                                    uint32_t *group_id)
7713 {
7714     const struct ofp11_group_stats_request *gsr11 = ofpmsg_body(request);
7715     *group_id = ntohl(gsr11->group_id);
7716     return 0;
7717 }
7718
7719 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
7720  * in 'gs'.  Assigns freshly allocated memory to gs->bucket_stats for the
7721  * caller to eventually free.
7722  *
7723  * Multiple group stats replies can be packed into a single OpenFlow message.
7724  * Calling this function multiple times for a single 'msg' iterates through the
7725  * replies.  The caller must initially leave 'msg''s layer pointers null and
7726  * not modify them between calls.
7727  *
7728  * Returns 0 if successful, EOF if no replies were left in this 'msg',
7729  * otherwise a positive errno value. */
7730 int
7731 ofputil_decode_group_stats_reply(struct ofpbuf *msg,
7732                                  struct ofputil_group_stats *gs)
7733 {
7734     struct ofp11_bucket_counter *obc;
7735     struct ofp11_group_stats *ogs11;
7736     enum ofpraw raw;
7737     enum ofperr error;
7738     size_t base_len;
7739     size_t length;
7740     size_t i;
7741
7742     gs->bucket_stats = NULL;
7743     error = (msg->header ? ofpraw_decode(&raw, msg->header)
7744              : ofpraw_pull(&raw, msg));
7745     if (error) {
7746         return error;
7747     }
7748
7749     if (!msg->size) {
7750         return EOF;
7751     }
7752
7753     if (raw == OFPRAW_OFPST11_GROUP_REPLY) {
7754         base_len = sizeof *ogs11;
7755         ogs11 = ofpbuf_try_pull(msg, sizeof *ogs11);
7756         gs->duration_sec = gs->duration_nsec = UINT32_MAX;
7757     } else if (raw == OFPRAW_OFPST13_GROUP_REPLY) {
7758         struct ofp13_group_stats *ogs13;
7759
7760         base_len = sizeof *ogs13;
7761         ogs13 = ofpbuf_try_pull(msg, sizeof *ogs13);
7762         if (ogs13) {
7763             ogs11 = &ogs13->gs;
7764             gs->duration_sec = ntohl(ogs13->duration_sec);
7765             gs->duration_nsec = ntohl(ogs13->duration_nsec);
7766         } else {
7767             ogs11 = NULL;
7768         }
7769     } else {
7770         OVS_NOT_REACHED();
7771     }
7772
7773     if (!ogs11) {
7774         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
7775                      ofpraw_get_name(raw), msg->size);
7776         return OFPERR_OFPBRC_BAD_LEN;
7777     }
7778     length = ntohs(ogs11->length);
7779     if (length < sizeof base_len) {
7780         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply claims invalid length %"PRIuSIZE,
7781                      ofpraw_get_name(raw), length);
7782         return OFPERR_OFPBRC_BAD_LEN;
7783     }
7784
7785     gs->group_id = ntohl(ogs11->group_id);
7786     gs->ref_count = ntohl(ogs11->ref_count);
7787     gs->packet_count = ntohll(ogs11->packet_count);
7788     gs->byte_count = ntohll(ogs11->byte_count);
7789
7790     gs->n_buckets = (length - base_len) / sizeof *obc;
7791     obc = ofpbuf_try_pull(msg, gs->n_buckets * sizeof *obc);
7792     if (!obc) {
7793         VLOG_WARN_RL(&bad_ofmsg_rl, "%s reply has %"PRIu32" leftover bytes at end",
7794                      ofpraw_get_name(raw), msg->size);
7795         return OFPERR_OFPBRC_BAD_LEN;
7796     }
7797
7798     gs->bucket_stats = xmalloc(gs->n_buckets * sizeof *gs->bucket_stats);
7799     for (i = 0; i < gs->n_buckets; i++) {
7800         gs->bucket_stats[i].packet_count = ntohll(obc[i].packet_count);
7801         gs->bucket_stats[i].byte_count = ntohll(obc[i].byte_count);
7802     }
7803
7804     return 0;
7805 }
7806
7807 static void
7808 ofputil_put_ofp11_bucket(const struct ofputil_bucket *bucket,
7809                          struct ofpbuf *openflow, enum ofp_version ofp_version)
7810 {
7811     struct ofp11_bucket *ob;
7812     size_t start;
7813
7814     start = openflow->size;
7815     ofpbuf_put_zeros(openflow, sizeof *ob);
7816     ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
7817                                 openflow, ofp_version);
7818     ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
7819     ob->len = htons(openflow->size - start);
7820     ob->weight = htons(bucket->weight);
7821     ob->watch_port = ofputil_port_to_ofp11(bucket->watch_port);
7822     ob->watch_group = htonl(bucket->watch_group);
7823 }
7824
7825 static void
7826 ofputil_put_ofp15_group_bucket_prop_weight(ovs_be16 weight,
7827                                            struct ofpbuf *openflow)
7828 {
7829     size_t start_ofs;
7830     struct ofp15_group_bucket_prop_weight *prop;
7831
7832     start_ofs = start_property(openflow, OFPGBPT15_WEIGHT);
7833     ofpbuf_put_zeros(openflow, sizeof *prop - sizeof(struct ofp_prop_header));
7834     prop = ofpbuf_at_assert(openflow, start_ofs, sizeof *prop);
7835     prop->weight = weight;
7836     end_property(openflow, start_ofs);
7837 }
7838
7839 static void
7840 ofputil_put_ofp15_group_bucket_prop_watch(ovs_be32 watch, uint16_t type,
7841                                           struct ofpbuf *openflow)
7842 {
7843     size_t start_ofs;
7844     struct ofp15_group_bucket_prop_watch *prop;
7845
7846     start_ofs = start_property(openflow, type);
7847     ofpbuf_put_zeros(openflow, sizeof *prop - sizeof(struct ofp_prop_header));
7848     prop = ofpbuf_at_assert(openflow, start_ofs, sizeof *prop);
7849     prop->watch = watch;
7850     end_property(openflow, start_ofs);
7851 }
7852
7853 static void
7854 ofputil_put_ofp15_bucket(const struct ofputil_bucket *bucket,
7855                          uint32_t bucket_id, enum ofp11_group_type group_type,
7856                          struct ofpbuf *openflow, enum ofp_version ofp_version)
7857 {
7858     struct ofp15_bucket *ob;
7859     size_t start, actions_start, actions_len;
7860
7861     start = openflow->size;
7862     ofpbuf_put_zeros(openflow, sizeof *ob);
7863
7864     actions_start = openflow->size;
7865     ofpacts_put_openflow_actions(bucket->ofpacts, bucket->ofpacts_len,
7866                                  openflow, ofp_version);
7867     actions_len = openflow->size - actions_start;
7868
7869     if (group_type == OFPGT11_SELECT) {
7870         ofputil_put_ofp15_group_bucket_prop_weight(htons(bucket->weight),
7871                                                    openflow);
7872     }
7873     if (bucket->watch_port != OFPP_ANY) {
7874         ovs_be32 port = ofputil_port_to_ofp11(bucket->watch_port);
7875         ofputil_put_ofp15_group_bucket_prop_watch(port,
7876                                                   OFPGBPT15_WATCH_PORT,
7877                                                   openflow);
7878     }
7879     if (bucket->watch_group != OFPG_ANY) {
7880         ovs_be32 group = htonl(bucket->watch_group);
7881         ofputil_put_ofp15_group_bucket_prop_watch(group,
7882                                                   OFPGBPT15_WATCH_GROUP,
7883                                                   openflow);
7884     }
7885
7886     ob = ofpbuf_at_assert(openflow, start, sizeof *ob);
7887     ob->len = htons(openflow->size - start);
7888     ob->action_array_len = htons(actions_len);
7889     ob->bucket_id = htonl(bucket_id);
7890 }
7891
7892 static void
7893 ofputil_put_group_prop_ntr_selection_method(enum ofp_version ofp_version,
7894                                             const struct ofputil_group_props *gp,
7895                                             struct ofpbuf *openflow)
7896 {
7897     struct ntr_group_prop_selection_method *prop;
7898     size_t start;
7899
7900     start = openflow->size;
7901     ofpbuf_put_zeros(openflow, sizeof *prop);
7902     oxm_put_field_array(openflow, &gp->fields, ofp_version);
7903     prop = ofpbuf_at_assert(openflow, start, sizeof *prop);
7904     prop->type = htons(OFPGPT15_EXPERIMENTER);
7905     prop->experimenter = htonl(NTR_VENDOR_ID);
7906     prop->exp_type = htonl(NTRT_SELECTION_METHOD);
7907     strcpy(prop->selection_method, gp->selection_method);
7908     prop->selection_method_param = htonll(gp->selection_method_param);
7909     end_property(openflow, start);
7910 }
7911
7912 static void
7913 ofputil_append_ofp11_group_desc_reply(const struct ofputil_group_desc *gds,
7914                                       const struct ovs_list *buckets,
7915                                       struct ovs_list *replies,
7916                                       enum ofp_version version)
7917 {
7918     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
7919     struct ofp11_group_desc_stats *ogds;
7920     struct ofputil_bucket *bucket;
7921     size_t start_ogds;
7922
7923     start_ogds = reply->size;
7924     ofpbuf_put_zeros(reply, sizeof *ogds);
7925     LIST_FOR_EACH (bucket, list_node, buckets) {
7926         ofputil_put_ofp11_bucket(bucket, reply, version);
7927     }
7928     ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
7929     ogds->length = htons(reply->size - start_ogds);
7930     ogds->type = gds->type;
7931     ogds->group_id = htonl(gds->group_id);
7932
7933     ofpmp_postappend(replies, start_ogds);
7934 }
7935
7936 static void
7937 ofputil_append_ofp15_group_desc_reply(const struct ofputil_group_desc *gds,
7938                                       const struct ovs_list *buckets,
7939                                       struct ovs_list *replies,
7940                                       enum ofp_version version)
7941 {
7942     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
7943     struct ofp15_group_desc_stats *ogds;
7944     struct ofputil_bucket *bucket;
7945     size_t start_ogds, start_buckets;
7946
7947     start_ogds = reply->size;
7948     ofpbuf_put_zeros(reply, sizeof *ogds);
7949     start_buckets = reply->size;
7950     LIST_FOR_EACH (bucket, list_node, buckets) {
7951         ofputil_put_ofp15_bucket(bucket, bucket->bucket_id,
7952                                  gds->type, reply, version);
7953     }
7954     ogds = ofpbuf_at_assert(reply, start_ogds, sizeof *ogds);
7955     ogds->type = gds->type;
7956     ogds->group_id = htonl(gds->group_id);
7957     ogds->bucket_list_len =  htons(reply->size - start_buckets);
7958
7959     /* Add group properties */
7960     if (gds->props.selection_method[0]) {
7961         ofputil_put_group_prop_ntr_selection_method(version, &gds->props,
7962                                                     reply);
7963     }
7964     ogds->length = htons(reply->size - start_ogds);
7965
7966     ofpmp_postappend(replies, start_ogds);
7967 }
7968
7969 /* Appends a group stats reply that contains the data in 'gds' to those already
7970  * present in the list of ofpbufs in 'replies'.  'replies' should have been
7971  * initialized with ofpmp_init(). */
7972 void
7973 ofputil_append_group_desc_reply(const struct ofputil_group_desc *gds,
7974                                 const struct ovs_list *buckets,
7975                                 struct ovs_list *replies)
7976 {
7977     enum ofp_version version = ofpmp_version(replies);
7978
7979     switch (version)
7980     {
7981     case OFP11_VERSION:
7982     case OFP12_VERSION:
7983     case OFP13_VERSION:
7984     case OFP14_VERSION:
7985         ofputil_append_ofp11_group_desc_reply(gds, buckets, replies, version);
7986         break;
7987
7988     case OFP15_VERSION:
7989         ofputil_append_ofp15_group_desc_reply(gds, buckets, replies, version);
7990         break;
7991
7992     case OFP10_VERSION:
7993     default:
7994         OVS_NOT_REACHED();
7995     }
7996 }
7997
7998 static enum ofperr
7999 ofputil_pull_ofp11_buckets(struct ofpbuf *msg, size_t buckets_length,
8000                            enum ofp_version version, struct ovs_list *buckets)
8001 {
8002     struct ofp11_bucket *ob;
8003     uint32_t bucket_id = 0;
8004
8005     list_init(buckets);
8006     while (buckets_length > 0) {
8007         struct ofputil_bucket *bucket;
8008         struct ofpbuf ofpacts;
8009         enum ofperr error;
8010         size_t ob_len;
8011
8012         ob = (buckets_length >= sizeof *ob
8013               ? ofpbuf_try_pull(msg, sizeof *ob)
8014               : NULL);
8015         if (!ob) {
8016             VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE" leftover bytes",
8017                          buckets_length);
8018             return OFPERR_OFPGMFC_BAD_BUCKET;
8019         }
8020
8021         ob_len = ntohs(ob->len);
8022         if (ob_len < sizeof *ob) {
8023             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8024                          "%"PRIuSIZE" is not valid", ob_len);
8025             return OFPERR_OFPGMFC_BAD_BUCKET;
8026         } else if (ob_len > buckets_length) {
8027             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8028                          "%"PRIuSIZE" exceeds remaining buckets data size %"PRIuSIZE,
8029                          ob_len, buckets_length);
8030             return OFPERR_OFPGMFC_BAD_BUCKET;
8031         }
8032         buckets_length -= ob_len;
8033
8034         ofpbuf_init(&ofpacts, 0);
8035         error = ofpacts_pull_openflow_actions(msg, ob_len - sizeof *ob,
8036                                               version, &ofpacts);
8037         if (error) {
8038             ofpbuf_uninit(&ofpacts);
8039             ofputil_bucket_list_destroy(buckets);
8040             return error;
8041         }
8042
8043         bucket = xzalloc(sizeof *bucket);
8044         bucket->weight = ntohs(ob->weight);
8045         error = ofputil_port_from_ofp11(ob->watch_port, &bucket->watch_port);
8046         if (error) {
8047             ofpbuf_uninit(&ofpacts);
8048             ofputil_bucket_list_destroy(buckets);
8049             return OFPERR_OFPGMFC_BAD_WATCH;
8050         }
8051         bucket->watch_group = ntohl(ob->watch_group);
8052         bucket->bucket_id = bucket_id++;
8053
8054         bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8055         bucket->ofpacts_len = ofpacts.size;
8056         list_push_back(buckets, &bucket->list_node);
8057     }
8058
8059     return 0;
8060 }
8061
8062 static enum ofperr
8063 parse_ofp15_group_bucket_prop_weight(const struct ofpbuf *payload,
8064                                      ovs_be16 *weight)
8065 {
8066     struct ofp15_group_bucket_prop_weight *prop = payload->data;
8067
8068     if (payload->size != sizeof *prop) {
8069         log_property(false, "OpenFlow bucket weight property length "
8070                      "%u is not valid", payload->size);
8071         return OFPERR_OFPBPC_BAD_LEN;
8072     }
8073
8074     *weight = prop->weight;
8075
8076     return 0;
8077 }
8078
8079 static enum ofperr
8080 parse_ofp15_group_bucket_prop_watch(const struct ofpbuf *payload,
8081                                     ovs_be32 *watch)
8082 {
8083     struct ofp15_group_bucket_prop_watch *prop = payload->data;
8084
8085     if (payload->size != sizeof *prop) {
8086         log_property(false, "OpenFlow bucket watch port or group "
8087                      "property length %u is not valid", payload->size);
8088         return OFPERR_OFPBPC_BAD_LEN;
8089     }
8090
8091     *watch = prop->watch;
8092
8093     return 0;
8094 }
8095
8096 static enum ofperr
8097 ofputil_pull_ofp15_buckets(struct ofpbuf *msg, size_t buckets_length,
8098                            enum ofp_version version, uint8_t group_type,
8099                            struct ovs_list *buckets)
8100 {
8101     struct ofp15_bucket *ob;
8102
8103     list_init(buckets);
8104     while (buckets_length > 0) {
8105         struct ofputil_bucket *bucket = NULL;
8106         struct ofpbuf ofpacts;
8107         enum ofperr err = OFPERR_OFPGMFC_BAD_BUCKET;
8108         struct ofpbuf properties;
8109         size_t ob_len, actions_len, properties_len;
8110         ovs_be32 watch_port = ofputil_port_to_ofp11(OFPP_ANY);
8111         ovs_be32 watch_group = htonl(OFPG_ANY);
8112         ovs_be16 weight = htons(group_type == OFPGT11_SELECT ? 1 : 0);
8113
8114         ofpbuf_init(&ofpacts, 0);
8115
8116         ob = ofpbuf_try_pull(msg, sizeof *ob);
8117         if (!ob) {
8118             VLOG_WARN_RL(&bad_ofmsg_rl, "buckets end with %"PRIuSIZE
8119                          " leftover bytes", buckets_length);
8120             goto err;
8121         }
8122
8123         ob_len = ntohs(ob->len);
8124         actions_len = ntohs(ob->action_array_len);
8125
8126         if (ob_len < sizeof *ob) {
8127             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8128                          "%"PRIuSIZE" is not valid", ob_len);
8129             goto err;
8130         } else if (ob_len > buckets_length) {
8131             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket length "
8132                          "%"PRIuSIZE" exceeds remaining buckets data size %"
8133                          PRIuSIZE, ob_len, buckets_length);
8134             goto err;
8135         } else if (actions_len > ob_len - sizeof *ob) {
8136             VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message bucket actions "
8137                          "length %"PRIuSIZE" exceeds remaining bucket "
8138                          "data size %"PRIuSIZE, actions_len,
8139                          ob_len - sizeof *ob);
8140             goto err;
8141         }
8142         buckets_length -= ob_len;
8143
8144         err = ofpacts_pull_openflow_actions(msg, actions_len, version,
8145                                             &ofpacts);
8146         if (err) {
8147             goto err;
8148         }
8149
8150         properties_len = ob_len - sizeof *ob - actions_len;
8151         ofpbuf_use_const(&properties, ofpbuf_pull(msg, properties_len),
8152                          properties_len);
8153
8154         while (properties.size > 0) {
8155             struct ofpbuf payload;
8156             uint16_t type;
8157
8158             err = ofputil_pull_property(&properties, &payload, &type);
8159             if (err) {
8160                 goto err;
8161             }
8162
8163             switch (type) {
8164             case OFPGBPT15_WEIGHT:
8165                 err = parse_ofp15_group_bucket_prop_weight(&payload, &weight);
8166                 break;
8167
8168             case OFPGBPT15_WATCH_PORT:
8169                 err = parse_ofp15_group_bucket_prop_watch(&payload,
8170                                                           &watch_port);
8171                 break;
8172
8173             case OFPGBPT15_WATCH_GROUP:
8174                 err = parse_ofp15_group_bucket_prop_watch(&payload,
8175                                                           &watch_group);
8176                 break;
8177
8178             default:
8179                 log_property(false, "unknown group bucket property %"PRIu16,
8180                              type);
8181                 err = OFPERR_OFPBPC_BAD_TYPE;
8182                 break;
8183             }
8184
8185             if (err) {
8186                 goto err;
8187             }
8188         }
8189
8190         bucket = xzalloc(sizeof *bucket);
8191
8192         bucket->weight = ntohs(weight);
8193         err = ofputil_port_from_ofp11(watch_port, &bucket->watch_port);
8194         if (err) {
8195             err = OFPERR_OFPGMFC_BAD_WATCH;
8196             goto err;
8197         }
8198         bucket->watch_group = ntohl(watch_group);
8199         bucket->bucket_id = ntohl(ob->bucket_id);
8200         if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8201             VLOG_WARN_RL(&bad_ofmsg_rl, "bucket id (%u) is out of range",
8202                          bucket->bucket_id);
8203             err = OFPERR_OFPGMFC_BAD_BUCKET;
8204             goto err;
8205         }
8206
8207         bucket->ofpacts = ofpbuf_steal_data(&ofpacts);
8208         bucket->ofpacts_len = ofpacts.size;
8209         list_push_back(buckets, &bucket->list_node);
8210
8211         continue;
8212
8213     err:
8214         free(bucket);
8215         ofpbuf_uninit(&ofpacts);
8216         ofputil_bucket_list_destroy(buckets);
8217         return err;
8218     }
8219
8220     if (ofputil_bucket_check_duplicate_id(buckets)) {
8221         VLOG_WARN_RL(&bad_ofmsg_rl, "Duplicate bucket id");
8222         ofputil_bucket_list_destroy(buckets);
8223         return OFPERR_OFPGMFC_BAD_BUCKET;
8224     }
8225
8226     return 0;
8227 }
8228
8229 static void
8230 ofputil_init_group_properties(struct ofputil_group_props *gp)
8231 {
8232     memset(gp, 0, sizeof *gp);
8233 }
8234
8235 static enum ofperr
8236 parse_group_prop_ntr_selection_method(struct ofpbuf *payload,
8237                                       enum ofp11_group_type group_type,
8238                                       enum ofp15_group_mod_command group_cmd,
8239                                       struct ofputil_group_props *gp)
8240 {
8241     struct ntr_group_prop_selection_method *prop = payload->data;
8242     size_t fields_len, method_len;
8243     enum ofperr error;
8244
8245     switch (group_type) {
8246     case OFPGT11_SELECT:
8247         break;
8248     case OFPGT11_ALL:
8249     case OFPGT11_INDIRECT:
8250     case OFPGT11_FF:
8251         log_property(false, "ntr selection method property is only allowed "
8252                      "for select groups");
8253         return OFPERR_OFPBPC_BAD_VALUE;
8254     default:
8255         OVS_NOT_REACHED();
8256     }
8257
8258     switch (group_cmd) {
8259     case OFPGC15_ADD:
8260     case OFPGC15_MODIFY:
8261         break;
8262     case OFPGC15_DELETE:
8263     case OFPGC15_INSERT_BUCKET:
8264     case OFPGC15_REMOVE_BUCKET:
8265         log_property(false, "ntr selection method property is only allowed "
8266                      "for add and delete group modifications");
8267         return OFPERR_OFPBPC_BAD_VALUE;
8268     default:
8269         OVS_NOT_REACHED();
8270     }
8271
8272     if (payload->size < sizeof *prop) {
8273         log_property(false, "ntr selection method property length "
8274                      "%u is not valid", payload->size);
8275         return OFPERR_OFPBPC_BAD_LEN;
8276     }
8277
8278     method_len = strnlen(prop->selection_method, NTR_MAX_SELECTION_METHOD_LEN);
8279
8280     if (method_len == NTR_MAX_SELECTION_METHOD_LEN) {
8281         log_property(false, "ntr selection method is not null terminated");
8282         return OFPERR_OFPBPC_BAD_VALUE;
8283     }
8284
8285     if (strcmp("hash", prop->selection_method)) {
8286         log_property(false, "ntr selection method '%s' is not supported",
8287                      prop->selection_method);
8288         return OFPERR_OFPBPC_BAD_VALUE;
8289     }
8290
8291     strcpy(gp->selection_method, prop->selection_method);
8292     gp->selection_method_param = ntohll(prop->selection_method_param);
8293
8294     if (!method_len && gp->selection_method_param) {
8295         log_property(false, "ntr selection method parameter is non-zero but "
8296                      "selection method is empty");
8297         return OFPERR_OFPBPC_BAD_VALUE;
8298     }
8299
8300     ofpbuf_pull(payload, sizeof *prop);
8301
8302     fields_len = ntohs(prop->length) - sizeof *prop;
8303     if (!method_len && fields_len) {
8304         log_property(false, "ntr selection method parameter is zero "
8305                      "but fields are provided");
8306         return OFPERR_OFPBPC_BAD_VALUE;
8307     }
8308
8309     error = oxm_pull_field_array(payload->data, fields_len,
8310                                  &gp->fields);
8311     if (error) {
8312         log_property(false, "ntr selection method fields are invalid");
8313         return error;
8314     }
8315
8316     return 0;
8317 }
8318
8319 static enum ofperr
8320 parse_group_prop_ntr(struct ofpbuf *payload, uint32_t exp_type,
8321                      enum ofp11_group_type group_type,
8322                      enum ofp15_group_mod_command group_cmd,
8323                      struct ofputil_group_props *gp)
8324 {
8325     enum ofperr error;
8326
8327     switch (exp_type) {
8328     case NTRT_SELECTION_METHOD:
8329         error = parse_group_prop_ntr_selection_method(payload, group_type,
8330                                                       group_cmd, gp);
8331         break;
8332
8333     default:
8334         log_property(false, "unknown group property ntr experimenter type "
8335                      "%"PRIu32, exp_type);
8336         error = OFPERR_OFPBPC_BAD_TYPE;
8337         break;
8338     }
8339
8340     return error;
8341 }
8342
8343 static enum ofperr
8344 parse_ofp15_group_prop_exp(struct ofpbuf *payload,
8345                            enum ofp11_group_type group_type,
8346                            enum ofp15_group_mod_command group_cmd,
8347                            struct ofputil_group_props *gp)
8348 {
8349     struct ofp_prop_experimenter *prop = payload->data;
8350     uint16_t experimenter;
8351     uint32_t exp_type;
8352     enum ofperr error;
8353
8354     if (payload->size < sizeof *prop) {
8355         return OFPERR_OFPBPC_BAD_LEN;
8356     }
8357
8358     experimenter = ntohl(prop->experimenter);
8359     exp_type = ntohl(prop->exp_type);
8360
8361     switch (experimenter) {
8362     case NTR_VENDOR_ID:
8363     case NTR_COMPAT_VENDOR_ID:
8364         error = parse_group_prop_ntr(payload, exp_type, group_type,
8365                                      group_cmd, gp);
8366         break;
8367
8368     default:
8369         log_property(false, "unknown group property experimenter %"PRIu16,
8370                      experimenter);
8371         error = OFPERR_OFPBPC_BAD_EXPERIMENTER;
8372         break;
8373     }
8374
8375     return error;
8376 }
8377
8378 static enum ofperr
8379 parse_ofp15_group_properties(struct ofpbuf *msg,
8380                              enum ofp11_group_type group_type,
8381                              enum ofp15_group_mod_command group_cmd,
8382                              struct ofputil_group_props *gp,
8383                              size_t properties_len)
8384 {
8385     struct ofpbuf properties;
8386
8387     ofpbuf_use_const(&properties, ofpbuf_pull(msg, properties_len),
8388                      properties_len);
8389
8390     while (properties.size > 0) {
8391         struct ofpbuf payload;
8392         enum ofperr error;
8393         uint16_t type;
8394
8395         error = ofputil_pull_property(&properties, &payload, &type);
8396         if (error) {
8397             return error;
8398         }
8399
8400         switch (type) {
8401         case OFPGPT15_EXPERIMENTER:
8402             error = parse_ofp15_group_prop_exp(&payload, group_type,
8403                                                group_cmd, gp);
8404             break;
8405
8406         default:
8407             log_property(false, "unknown group property %"PRIu16, type);
8408             error = OFPERR_OFPBPC_BAD_TYPE;
8409             break;
8410         }
8411
8412         if (error) {
8413             return error;
8414         }
8415     }
8416
8417     return 0;
8418 }
8419
8420 static int
8421 ofputil_decode_ofp11_group_desc_reply(struct ofputil_group_desc *gd,
8422                                       struct ofpbuf *msg,
8423                                       enum ofp_version version)
8424 {
8425     struct ofp11_group_desc_stats *ogds;
8426     size_t length;
8427
8428     if (!msg->header) {
8429         ofpraw_pull_assert(msg);
8430     }
8431
8432     if (!msg->size) {
8433         return EOF;
8434     }
8435
8436     ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8437     if (!ogds) {
8438         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8439                      "leftover bytes at end", msg->size);
8440         return OFPERR_OFPBRC_BAD_LEN;
8441     }
8442     gd->type = ogds->type;
8443     gd->group_id = ntohl(ogds->group_id);
8444
8445     length = ntohs(ogds->length);
8446     if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8447         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8448                      "length %"PRIuSIZE, length);
8449         return OFPERR_OFPBRC_BAD_LEN;
8450     }
8451
8452     return ofputil_pull_ofp11_buckets(msg, length - sizeof *ogds, version,
8453                                       &gd->buckets);
8454 }
8455
8456 static int
8457 ofputil_decode_ofp15_group_desc_reply(struct ofputil_group_desc *gd,
8458                                       struct ofpbuf *msg,
8459                                       enum ofp_version version)
8460 {
8461     struct ofp15_group_desc_stats *ogds;
8462     uint16_t length, bucket_list_len;
8463     int error;
8464
8465     if (!msg->header) {
8466         ofpraw_pull_assert(msg);
8467     }
8468
8469     if (!msg->size) {
8470         return EOF;
8471     }
8472
8473     ogds = ofpbuf_try_pull(msg, sizeof *ogds);
8474     if (!ogds) {
8475         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply has %"PRIu32" "
8476                      "leftover bytes at end", msg->size);
8477         return OFPERR_OFPBRC_BAD_LEN;
8478     }
8479     gd->type = ogds->type;
8480     gd->group_id = ntohl(ogds->group_id);
8481
8482     length = ntohs(ogds->length);
8483     if (length < sizeof *ogds || length - sizeof *ogds > msg->size) {
8484         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8485                      "length %u", length);
8486         return OFPERR_OFPBRC_BAD_LEN;
8487     }
8488
8489     bucket_list_len = ntohs(ogds->bucket_list_len);
8490     if (length < bucket_list_len + sizeof *ogds) {
8491         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST11_GROUP_DESC reply claims invalid "
8492                      "bucket list length %u", bucket_list_len);
8493         return OFPERR_OFPBRC_BAD_LEN;
8494     }
8495     error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, version, gd->type,
8496                                        &gd->buckets);
8497     if (error) {
8498         return error;
8499     }
8500
8501     /* By definition group desc messages don't have a group mod command.
8502      * However, parse_group_prop_ntr_selection_method() checks to make sure
8503      * that the command is OFPGC15_ADD or OFPGC15_DELETE to guard
8504      * against group mod messages with other commands supplying
8505      * a NTR selection method group experimenter property.
8506      * Such properties are valid for group desc replies so
8507      * claim that the group mod command is OFPGC15_ADD to
8508      * satisfy the check in parse_group_prop_ntr_selection_method() */
8509     return parse_ofp15_group_properties(msg, gd->type, OFPGC15_ADD, &gd->props,
8510                                         length - sizeof *ogds - bucket_list_len);
8511 }
8512
8513 /* Converts a group description reply in 'msg' into an abstract
8514  * ofputil_group_desc in 'gd'.
8515  *
8516  * Multiple group description replies can be packed into a single OpenFlow
8517  * message.  Calling this function multiple times for a single 'msg' iterates
8518  * through the replies.  The caller must initially leave 'msg''s layer pointers
8519  * null and not modify them between calls.
8520  *
8521  * Returns 0 if successful, EOF if no replies were left in this 'msg',
8522  * otherwise a positive errno value. */
8523 int
8524 ofputil_decode_group_desc_reply(struct ofputil_group_desc *gd,
8525                                 struct ofpbuf *msg, enum ofp_version version)
8526 {
8527     ofputil_init_group_properties(&gd->props);
8528
8529     switch (version)
8530     {
8531     case OFP11_VERSION:
8532     case OFP12_VERSION:
8533     case OFP13_VERSION:
8534     case OFP14_VERSION:
8535         return ofputil_decode_ofp11_group_desc_reply(gd, msg, version);
8536
8537     case OFP15_VERSION:
8538         return ofputil_decode_ofp15_group_desc_reply(gd, msg, version);
8539
8540     case OFP10_VERSION:
8541     default:
8542         OVS_NOT_REACHED();
8543     }
8544 }
8545
8546 void
8547 ofputil_uninit_group_mod(struct ofputil_group_mod *gm)
8548 {
8549     ofputil_bucket_list_destroy(&gm->buckets);
8550 }
8551
8552 static struct ofpbuf *
8553 ofputil_encode_ofp11_group_mod(enum ofp_version ofp_version,
8554                                const struct ofputil_group_mod *gm)
8555 {
8556     struct ofpbuf *b;
8557     struct ofp11_group_mod *ogm;
8558     size_t start_ogm;
8559     struct ofputil_bucket *bucket;
8560
8561     b = ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD, ofp_version, 0);
8562     start_ogm = b->size;
8563     ofpbuf_put_zeros(b, sizeof *ogm);
8564
8565     LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8566         ofputil_put_ofp11_bucket(bucket, b, ofp_version);
8567     }
8568     ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8569     ogm->command = htons(gm->command);
8570     ogm->type = gm->type;
8571     ogm->group_id = htonl(gm->group_id);
8572
8573     return b;
8574 }
8575
8576 static struct ofpbuf *
8577 ofputil_encode_ofp15_group_mod(enum ofp_version ofp_version,
8578                                const struct ofputil_group_mod *gm)
8579 {
8580     struct ofpbuf *b;
8581     struct ofp15_group_mod *ogm;
8582     size_t start_ogm;
8583     struct ofputil_bucket *bucket;
8584     struct id_pool *bucket_ids = NULL;
8585
8586     b = ofpraw_alloc(OFPRAW_OFPT15_GROUP_MOD, ofp_version, 0);
8587     start_ogm = b->size;
8588     ofpbuf_put_zeros(b, sizeof *ogm);
8589
8590     LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8591         uint32_t bucket_id;
8592
8593         /* Generate a bucket id if none was supplied */
8594         if (bucket->bucket_id > OFPG15_BUCKET_MAX) {
8595             if (!bucket_ids) {
8596                 const struct ofputil_bucket *bkt;
8597
8598                 bucket_ids = id_pool_create(0, OFPG15_BUCKET_MAX + 1);
8599
8600                 /* Mark all bucket_ids that are present in gm
8601                  * as used in the pool. */
8602                 LIST_FOR_EACH_REVERSE (bkt, list_node, &gm->buckets) {
8603                     if (bkt == bucket) {
8604                         break;
8605                     }
8606                     if (bkt->bucket_id <= OFPG15_BUCKET_MAX) {
8607                         id_pool_add(bucket_ids, bkt->bucket_id);
8608                     }
8609                 }
8610             }
8611
8612             if (!id_pool_alloc_id(bucket_ids, &bucket_id)) {
8613                 OVS_NOT_REACHED();
8614             }
8615         } else {
8616             bucket_id = bucket->bucket_id;
8617         }
8618
8619         ofputil_put_ofp15_bucket(bucket, bucket_id, gm->type, b, ofp_version);
8620     }
8621     ogm = ofpbuf_at_assert(b, start_ogm, sizeof *ogm);
8622     ogm->command = htons(gm->command);
8623     ogm->type = gm->type;
8624     ogm->group_id = htonl(gm->group_id);
8625     ogm->command_bucket_id = htonl(gm->command_bucket_id);
8626     ogm->bucket_array_len = htons(b->size - start_ogm - sizeof *ogm);
8627
8628     /* Add group properties */
8629     if (gm->props.selection_method[0]) {
8630         ofputil_put_group_prop_ntr_selection_method(ofp_version, &gm->props, b);
8631     }
8632
8633     id_pool_destroy(bucket_ids);
8634     return b;
8635 }
8636
8637 static void
8638 bad_group_cmd(enum ofp15_group_mod_command cmd)
8639 {
8640     const char *opt_version;
8641     const char *version;
8642     const char *cmd_str;
8643
8644     switch (cmd) {
8645     case OFPGC15_ADD:
8646     case OFPGC15_MODIFY:
8647     case OFPGC15_DELETE:
8648         version = "1.1";
8649         opt_version = "11";
8650         break;
8651
8652     case OFPGC15_INSERT_BUCKET:
8653     case OFPGC15_REMOVE_BUCKET:
8654         version = "1.5";
8655         opt_version = "15";
8656         break;
8657
8658     default:
8659         OVS_NOT_REACHED();
8660     }
8661
8662     switch (cmd) {
8663     case OFPGC15_ADD:
8664         cmd_str = "add-group";
8665         break;
8666
8667     case OFPGC15_MODIFY:
8668         cmd_str = "mod-group";
8669         break;
8670
8671     case OFPGC15_DELETE:
8672         cmd_str = "del-group";
8673         break;
8674
8675     case OFPGC15_INSERT_BUCKET:
8676         cmd_str = "insert-bucket";
8677         break;
8678
8679     case OFPGC15_REMOVE_BUCKET:
8680         cmd_str = "remove-bucket";
8681         break;
8682
8683     default:
8684         OVS_NOT_REACHED();
8685     }
8686
8687     ovs_fatal(0, "%s needs OpenFlow %s or later (\'-O OpenFlow%s\')",
8688               cmd_str, version, opt_version);
8689
8690 }
8691
8692 /* Converts abstract group mod 'gm' into a message for OpenFlow version
8693  * 'ofp_version' and returns the message. */
8694 struct ofpbuf *
8695 ofputil_encode_group_mod(enum ofp_version ofp_version,
8696                          const struct ofputil_group_mod *gm)
8697 {
8698
8699     switch (ofp_version) {
8700     case OFP10_VERSION:
8701         bad_group_cmd(gm->command);
8702
8703     case OFP11_VERSION:
8704     case OFP12_VERSION:
8705     case OFP13_VERSION:
8706     case OFP14_VERSION:
8707         if (gm->command > OFPGC11_DELETE) {
8708             bad_group_cmd(gm->command);
8709         }
8710         return ofputil_encode_ofp11_group_mod(ofp_version, gm);
8711
8712     case OFP15_VERSION:
8713         return ofputil_encode_ofp15_group_mod(ofp_version, gm);
8714
8715     default:
8716         OVS_NOT_REACHED();
8717     }
8718 }
8719
8720 static enum ofperr
8721 ofputil_pull_ofp11_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
8722                              struct ofputil_group_mod *gm)
8723 {
8724     const struct ofp11_group_mod *ogm;
8725     enum ofperr error;
8726
8727     ogm = ofpbuf_pull(msg, sizeof *ogm);
8728     gm->command = ntohs(ogm->command);
8729     gm->type = ogm->type;
8730     gm->group_id = ntohl(ogm->group_id);
8731     gm->command_bucket_id = OFPG15_BUCKET_ALL;
8732
8733     error = ofputil_pull_ofp11_buckets(msg, msg->size, ofp_version,
8734                                        &gm->buckets);
8735
8736     /* OF1.3.5+ prescribes an error when an OFPGC_DELETE includes buckets. */
8737     if (!error
8738         && ofp_version >= OFP13_VERSION
8739         && gm->command == OFPGC11_DELETE
8740         && !list_is_empty(&gm->buckets)) {
8741         error = OFPERR_OFPGMFC_INVALID_GROUP;
8742     }
8743
8744     return error;
8745 }
8746
8747 static enum ofperr
8748 ofputil_pull_ofp15_group_mod(struct ofpbuf *msg, enum ofp_version ofp_version,
8749                              struct ofputil_group_mod *gm)
8750 {
8751     const struct ofp15_group_mod *ogm;
8752     uint16_t bucket_list_len;
8753     enum ofperr error = OFPERR_OFPGMFC_BAD_BUCKET;
8754
8755     ogm = ofpbuf_pull(msg, sizeof *ogm);
8756     gm->command = ntohs(ogm->command);
8757     gm->type = ogm->type;
8758     gm->group_id = ntohl(ogm->group_id);
8759
8760     gm->command_bucket_id = ntohl(ogm->command_bucket_id);
8761     switch (gm->command) {
8762     case OFPGC15_REMOVE_BUCKET:
8763         if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
8764             error = 0;
8765         }
8766         /* Fall through */
8767     case OFPGC15_INSERT_BUCKET:
8768         if (gm->command_bucket_id <= OFPG15_BUCKET_MAX ||
8769             gm->command_bucket_id == OFPG15_BUCKET_FIRST
8770             || gm->command_bucket_id == OFPG15_BUCKET_LAST) {
8771             error = 0;
8772         }
8773         break;
8774
8775     case OFPGC11_ADD:
8776     case OFPGC11_MODIFY:
8777     case OFPGC11_DELETE:
8778     default:
8779         if (gm->command_bucket_id == OFPG15_BUCKET_ALL) {
8780             error = 0;
8781         }
8782         break;
8783     }
8784     if (error) {
8785         VLOG_WARN_RL(&bad_ofmsg_rl,
8786                      "group command bucket id (%u) is out of range",
8787                      gm->command_bucket_id);
8788         return OFPERR_OFPGMFC_BAD_BUCKET;
8789     }
8790
8791     bucket_list_len = ntohs(ogm->bucket_array_len);
8792     error = ofputil_pull_ofp15_buckets(msg, bucket_list_len, ofp_version,
8793                                        gm->type, &gm->buckets);
8794     if (error) {
8795         return error;
8796     }
8797
8798     return parse_ofp15_group_properties(msg, gm->type, gm->command, &gm->props,
8799                                         msg->size);
8800 }
8801
8802 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
8803  * 'gm'.  Returns 0 if successful, otherwise an OpenFlow error code. */
8804 enum ofperr
8805 ofputil_decode_group_mod(const struct ofp_header *oh,
8806                          struct ofputil_group_mod *gm)
8807 {
8808     enum ofp_version ofp_version = oh->version;
8809     struct ofpbuf msg;
8810     struct ofputil_bucket *bucket;
8811     enum ofperr err;
8812
8813     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
8814     ofpraw_pull_assert(&msg);
8815
8816     ofputil_init_group_properties(&gm->props);
8817
8818     switch (ofp_version)
8819     {
8820     case OFP11_VERSION:
8821     case OFP12_VERSION:
8822     case OFP13_VERSION:
8823     case OFP14_VERSION:
8824         err = ofputil_pull_ofp11_group_mod(&msg, ofp_version, gm);
8825         break;
8826
8827     case OFP15_VERSION:
8828         err = ofputil_pull_ofp15_group_mod(&msg, ofp_version, gm);
8829         break;
8830
8831     case OFP10_VERSION:
8832     default:
8833         OVS_NOT_REACHED();
8834     }
8835
8836     if (err) {
8837         return err;
8838     }
8839
8840     switch (gm->type) {
8841     case OFPGT11_INDIRECT:
8842         if (!list_is_singleton(&gm->buckets)) {
8843             return OFPERR_OFPGMFC_INVALID_GROUP;
8844         }
8845         break;
8846     case OFPGT11_ALL:
8847     case OFPGT11_SELECT:
8848     case OFPGT11_FF:
8849         break;
8850     default:
8851         return OFPERR_OFPGMFC_BAD_TYPE;
8852     }
8853
8854     switch (gm->command) {
8855     case OFPGC11_ADD:
8856     case OFPGC11_MODIFY:
8857     case OFPGC11_DELETE:
8858     case OFPGC15_INSERT_BUCKET:
8859         break;
8860     case OFPGC15_REMOVE_BUCKET:
8861         if (!list_is_empty(&gm->buckets)) {
8862             return OFPERR_OFPGMFC_BAD_BUCKET;
8863         }
8864         break;
8865     default:
8866         return OFPERR_OFPGMFC_BAD_COMMAND;
8867     }
8868
8869     LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
8870         if (bucket->weight && gm->type != OFPGT11_SELECT) {
8871             return OFPERR_OFPGMFC_INVALID_GROUP;
8872         }
8873
8874         switch (gm->type) {
8875         case OFPGT11_ALL:
8876         case OFPGT11_INDIRECT:
8877             if (ofputil_bucket_has_liveness(bucket)) {
8878                 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED;
8879             }
8880             break;
8881         case OFPGT11_SELECT:
8882             break;
8883         case OFPGT11_FF:
8884             if (!ofputil_bucket_has_liveness(bucket)) {
8885                 return OFPERR_OFPGMFC_INVALID_GROUP;
8886             }
8887             break;
8888         default:
8889             /* Returning BAD TYPE to be consistent
8890              * though gm->type has been checked already. */
8891             return OFPERR_OFPGMFC_BAD_TYPE;
8892         }
8893     }
8894
8895     return 0;
8896 }
8897
8898 /* Parse a queue status request message into 'oqsr'.
8899  * Returns 0 if successful, otherwise an OFPERR_* number. */
8900 enum ofperr
8901 ofputil_decode_queue_stats_request(const struct ofp_header *request,
8902                                    struct ofputil_queue_stats_request *oqsr)
8903 {
8904     switch ((enum ofp_version)request->version) {
8905     case OFP15_VERSION:
8906     case OFP14_VERSION:
8907     case OFP13_VERSION:
8908     case OFP12_VERSION:
8909     case OFP11_VERSION: {
8910         const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
8911         oqsr->queue_id = ntohl(qsr11->queue_id);
8912         return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
8913     }
8914
8915     case OFP10_VERSION: {
8916         const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
8917         oqsr->queue_id = ntohl(qsr10->queue_id);
8918         oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
8919         /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
8920         if (oqsr->port_no == OFPP_ALL) {
8921             oqsr->port_no = OFPP_ANY;
8922         }
8923         return 0;
8924     }
8925
8926     default:
8927         OVS_NOT_REACHED();
8928     }
8929 }
8930
8931 /* Encode a queue stats request for 'oqsr', the encoded message
8932  * will be for OpenFlow version 'ofp_version'. Returns message
8933  * as a struct ofpbuf. Returns encoded message on success, NULL on error. */
8934 struct ofpbuf *
8935 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
8936                                    const struct ofputil_queue_stats_request *oqsr)
8937 {
8938     struct ofpbuf *request;
8939
8940     switch (ofp_version) {
8941     case OFP11_VERSION:
8942     case OFP12_VERSION:
8943     case OFP13_VERSION:
8944     case OFP14_VERSION:
8945     case OFP15_VERSION: {
8946         struct ofp11_queue_stats_request *req;
8947         request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
8948         req = ofpbuf_put_zeros(request, sizeof *req);
8949         req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
8950         req->queue_id = htonl(oqsr->queue_id);
8951         break;
8952     }
8953     case OFP10_VERSION: {
8954         struct ofp10_queue_stats_request *req;
8955         request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
8956         req = ofpbuf_put_zeros(request, sizeof *req);
8957         /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
8958         req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
8959                                         ? OFPP_ALL : oqsr->port_no));
8960         req->queue_id = htonl(oqsr->queue_id);
8961         break;
8962     }
8963     default:
8964         OVS_NOT_REACHED();
8965     }
8966
8967     return request;
8968 }
8969
8970 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
8971  * message 'oh'. */
8972 size_t
8973 ofputil_count_queue_stats(const struct ofp_header *oh)
8974 {
8975     struct ofputil_queue_stats qs;
8976     struct ofpbuf b;
8977     size_t n = 0;
8978
8979     ofpbuf_use_const(&b, oh, ntohs(oh->length));
8980     ofpraw_pull_assert(&b);
8981     while (!ofputil_decode_queue_stats(&qs, &b)) {
8982         n++;
8983     }
8984     return n;
8985 }
8986
8987 static enum ofperr
8988 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
8989                                const struct ofp10_queue_stats *qs10)
8990 {
8991     oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
8992     oqs->queue_id = ntohl(qs10->queue_id);
8993     oqs->tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
8994     oqs->tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
8995     oqs->tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
8996     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
8997
8998     return 0;
8999 }
9000
9001 static enum ofperr
9002 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
9003                                const struct ofp11_queue_stats *qs11)
9004 {
9005     enum ofperr error;
9006
9007     error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
9008     if (error) {
9009         return error;
9010     }
9011
9012     oqs->queue_id = ntohl(qs11->queue_id);
9013     oqs->tx_bytes = ntohll(qs11->tx_bytes);
9014     oqs->tx_packets = ntohll(qs11->tx_packets);
9015     oqs->tx_errors = ntohll(qs11->tx_errors);
9016     oqs->duration_sec = oqs->duration_nsec = UINT32_MAX;
9017
9018     return 0;
9019 }
9020
9021 static enum ofperr
9022 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
9023                                const struct ofp13_queue_stats *qs13)
9024 {
9025     enum ofperr error = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
9026     if (!error) {
9027         oqs->duration_sec = ntohl(qs13->duration_sec);
9028         oqs->duration_nsec = ntohl(qs13->duration_nsec);
9029     }
9030
9031     return error;
9032 }
9033
9034 static enum ofperr
9035 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats *oqs,
9036                                struct ofpbuf *msg)
9037 {
9038     const struct ofp14_queue_stats *qs14;
9039     size_t len;
9040
9041     qs14 = ofpbuf_try_pull(msg, sizeof *qs14);
9042     if (!qs14) {
9043         return OFPERR_OFPBRC_BAD_LEN;
9044     }
9045
9046     len = ntohs(qs14->length);
9047     if (len < sizeof *qs14 || len - sizeof *qs14 > msg->size) {
9048         return OFPERR_OFPBRC_BAD_LEN;
9049     }
9050     ofpbuf_pull(msg, len - sizeof *qs14);
9051
9052     /* No properties yet defined, so ignore them for now. */
9053
9054     return ofputil_queue_stats_from_ofp13(oqs, &qs14->qs);
9055 }
9056
9057 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
9058  * ofputil_queue_stats in 'qs'.
9059  *
9060  * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
9061  * message.  Calling this function multiple times for a single 'msg' iterates
9062  * through the replies.  The caller must initially leave 'msg''s layer pointers
9063  * null and not modify them between calls.
9064  *
9065  * Returns 0 if successful, EOF if no replies were left in this 'msg',
9066  * otherwise a positive errno value. */
9067 int
9068 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
9069 {
9070     enum ofperr error;
9071     enum ofpraw raw;
9072
9073     error = (msg->header ? ofpraw_decode(&raw, msg->header)
9074              : ofpraw_pull(&raw, msg));
9075     if (error) {
9076         return error;
9077     }
9078
9079     if (!msg->size) {
9080         return EOF;
9081     } else if (raw == OFPRAW_OFPST14_QUEUE_REPLY) {
9082         return ofputil_pull_ofp14_queue_stats(qs, msg);
9083     } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
9084         const struct ofp13_queue_stats *qs13;
9085
9086         qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
9087         if (!qs13) {
9088             goto bad_len;
9089         }
9090         return ofputil_queue_stats_from_ofp13(qs, qs13);
9091     } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
9092         const struct ofp11_queue_stats *qs11;
9093
9094         qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
9095         if (!qs11) {
9096             goto bad_len;
9097         }
9098         return ofputil_queue_stats_from_ofp11(qs, qs11);
9099     } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
9100         const struct ofp10_queue_stats *qs10;
9101
9102         qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
9103         if (!qs10) {
9104             goto bad_len;
9105         }
9106         return ofputil_queue_stats_from_ofp10(qs, qs10);
9107     } else {
9108         OVS_NOT_REACHED();
9109     }
9110
9111  bad_len:
9112     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %"PRIu32" leftover "
9113                  "bytes at end", msg->size);
9114     return OFPERR_OFPBRC_BAD_LEN;
9115 }
9116
9117 static void
9118 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
9119                              struct ofp10_queue_stats *qs10)
9120 {
9121     qs10->port_no = htons(ofp_to_u16(oqs->port_no));
9122     memset(qs10->pad, 0, sizeof qs10->pad);
9123     qs10->queue_id = htonl(oqs->queue_id);
9124     put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->tx_bytes));
9125     put_32aligned_be64(&qs10->tx_packets, htonll(oqs->tx_packets));
9126     put_32aligned_be64(&qs10->tx_errors, htonll(oqs->tx_errors));
9127 }
9128
9129 static void
9130 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
9131                              struct ofp11_queue_stats *qs11)
9132 {
9133     qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
9134     qs11->queue_id = htonl(oqs->queue_id);
9135     qs11->tx_bytes = htonll(oqs->tx_bytes);
9136     qs11->tx_packets = htonll(oqs->tx_packets);
9137     qs11->tx_errors = htonll(oqs->tx_errors);
9138 }
9139
9140 static void
9141 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
9142                              struct ofp13_queue_stats *qs13)
9143 {
9144     ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
9145     if (oqs->duration_sec != UINT32_MAX) {
9146         qs13->duration_sec = htonl(oqs->duration_sec);
9147         qs13->duration_nsec = htonl(oqs->duration_nsec);
9148     } else {
9149         qs13->duration_sec = OVS_BE32_MAX;
9150         qs13->duration_nsec = OVS_BE32_MAX;
9151     }
9152 }
9153
9154 static void
9155 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats *oqs,
9156                              struct ofp14_queue_stats *qs14)
9157 {
9158     qs14->length = htons(sizeof *qs14);
9159     memset(qs14->pad, 0, sizeof qs14->pad);
9160     ofputil_queue_stats_to_ofp13(oqs, &qs14->qs);
9161 }
9162
9163
9164 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
9165 void
9166 ofputil_append_queue_stat(struct ovs_list *replies,
9167                           const struct ofputil_queue_stats *oqs)
9168 {
9169     switch (ofpmp_version(replies)) {
9170     case OFP13_VERSION: {
9171         struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9172         ofputil_queue_stats_to_ofp13(oqs, reply);
9173         break;
9174     }
9175
9176     case OFP12_VERSION:
9177     case OFP11_VERSION: {
9178         struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9179         ofputil_queue_stats_to_ofp11(oqs, reply);
9180         break;
9181     }
9182
9183     case OFP10_VERSION: {
9184         struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9185         ofputil_queue_stats_to_ofp10(oqs, reply);
9186         break;
9187     }
9188
9189     case OFP14_VERSION:
9190     case OFP15_VERSION: {
9191         struct ofp14_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
9192         ofputil_queue_stats_to_ofp14(oqs, reply);
9193         break;
9194     }
9195
9196     default:
9197         OVS_NOT_REACHED();
9198     }
9199 }
9200
9201 enum ofperr
9202 ofputil_decode_bundle_ctrl(const struct ofp_header *oh,
9203                            struct ofputil_bundle_ctrl_msg *msg)
9204 {
9205     struct ofpbuf b;
9206     enum ofpraw raw;
9207     const struct ofp14_bundle_ctrl_msg *m;
9208
9209     ofpbuf_use_const(&b, oh, ntohs(oh->length));
9210     raw = ofpraw_pull_assert(&b);
9211     ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_CONTROL);
9212
9213     m = b.msg;
9214     msg->bundle_id = ntohl(m->bundle_id);
9215     msg->type = ntohs(m->type);
9216     msg->flags = ntohs(m->flags);
9217
9218     return 0;
9219 }
9220
9221 struct ofpbuf *
9222 ofputil_encode_bundle_ctrl_request(enum ofp_version ofp_version,
9223                                    struct ofputil_bundle_ctrl_msg *bc)
9224 {
9225     struct ofpbuf *request;
9226     struct ofp14_bundle_ctrl_msg *m;
9227
9228     switch (ofp_version) {
9229     case OFP10_VERSION:
9230     case OFP11_VERSION:
9231     case OFP12_VERSION:
9232     case OFP13_VERSION:
9233         ovs_fatal(0, "bundles need OpenFlow 1.4 or later "
9234                      "(\'-O OpenFlow14\')");
9235     case OFP14_VERSION:
9236     case OFP15_VERSION:
9237         request = ofpraw_alloc(OFPRAW_OFPT14_BUNDLE_CONTROL, ofp_version, 0);
9238         m = ofpbuf_put_zeros(request, sizeof *m);
9239
9240         m->bundle_id = htonl(bc->bundle_id);
9241         m->type = htons(bc->type);
9242         m->flags = htons(bc->flags);
9243         break;
9244     default:
9245         OVS_NOT_REACHED();
9246     }
9247
9248     return request;
9249 }
9250
9251 struct ofpbuf *
9252 ofputil_encode_bundle_ctrl_reply(const struct ofp_header *oh,
9253                                  struct ofputil_bundle_ctrl_msg *msg)
9254 {
9255     struct ofpbuf *buf;
9256     struct ofp14_bundle_ctrl_msg *m;
9257
9258     buf = ofpraw_alloc_reply(OFPRAW_OFPT14_BUNDLE_CONTROL, oh, 0);
9259     m = ofpbuf_put_zeros(buf, sizeof *m);
9260
9261     m->bundle_id = htonl(msg->bundle_id);
9262     m->type = htons(msg->type);
9263     m->flags = htons(msg->flags);
9264
9265     return buf;
9266 }
9267
9268 /* Return true for bundlable state change requests, false for other messages.
9269  */
9270 static bool
9271 ofputil_is_bundlable(enum ofptype type)
9272 {
9273     switch (type) {
9274         /* Minimum required by OpenFlow 1.4. */
9275     case OFPTYPE_PORT_MOD:
9276     case OFPTYPE_FLOW_MOD:
9277         return true;
9278
9279         /* Nice to have later. */
9280     case OFPTYPE_FLOW_MOD_TABLE_ID:
9281     case OFPTYPE_GROUP_MOD:
9282     case OFPTYPE_TABLE_MOD:
9283     case OFPTYPE_METER_MOD:
9284     case OFPTYPE_PACKET_OUT:
9285     case OFPTYPE_NXT_TLV_TABLE_MOD:
9286
9287         /* Not to be bundlable. */
9288     case OFPTYPE_ECHO_REQUEST:
9289     case OFPTYPE_FEATURES_REQUEST:
9290     case OFPTYPE_GET_CONFIG_REQUEST:
9291     case OFPTYPE_SET_CONFIG:
9292     case OFPTYPE_BARRIER_REQUEST:
9293     case OFPTYPE_ROLE_REQUEST:
9294     case OFPTYPE_ECHO_REPLY:
9295     case OFPTYPE_SET_FLOW_FORMAT:
9296     case OFPTYPE_SET_PACKET_IN_FORMAT:
9297     case OFPTYPE_SET_CONTROLLER_ID:
9298     case OFPTYPE_FLOW_AGE:
9299     case OFPTYPE_FLOW_MONITOR_CANCEL:
9300     case OFPTYPE_SET_ASYNC_CONFIG:
9301     case OFPTYPE_GET_ASYNC_REQUEST:
9302     case OFPTYPE_DESC_STATS_REQUEST:
9303     case OFPTYPE_FLOW_STATS_REQUEST:
9304     case OFPTYPE_AGGREGATE_STATS_REQUEST:
9305     case OFPTYPE_TABLE_STATS_REQUEST:
9306     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
9307     case OFPTYPE_TABLE_DESC_REQUEST:
9308     case OFPTYPE_PORT_STATS_REQUEST:
9309     case OFPTYPE_QUEUE_STATS_REQUEST:
9310     case OFPTYPE_PORT_DESC_STATS_REQUEST:
9311     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
9312     case OFPTYPE_METER_STATS_REQUEST:
9313     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
9314     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
9315     case OFPTYPE_GROUP_STATS_REQUEST:
9316     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
9317     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
9318     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
9319     case OFPTYPE_BUNDLE_CONTROL:
9320     case OFPTYPE_BUNDLE_ADD_MESSAGE:
9321     case OFPTYPE_HELLO:
9322     case OFPTYPE_ERROR:
9323     case OFPTYPE_FEATURES_REPLY:
9324     case OFPTYPE_GET_CONFIG_REPLY:
9325     case OFPTYPE_PACKET_IN:
9326     case OFPTYPE_FLOW_REMOVED:
9327     case OFPTYPE_PORT_STATUS:
9328     case OFPTYPE_BARRIER_REPLY:
9329     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
9330     case OFPTYPE_DESC_STATS_REPLY:
9331     case OFPTYPE_FLOW_STATS_REPLY:
9332     case OFPTYPE_QUEUE_STATS_REPLY:
9333     case OFPTYPE_PORT_STATS_REPLY:
9334     case OFPTYPE_TABLE_STATS_REPLY:
9335     case OFPTYPE_AGGREGATE_STATS_REPLY:
9336     case OFPTYPE_PORT_DESC_STATS_REPLY:
9337     case OFPTYPE_ROLE_REPLY:
9338     case OFPTYPE_FLOW_MONITOR_PAUSED:
9339     case OFPTYPE_FLOW_MONITOR_RESUMED:
9340     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
9341     case OFPTYPE_GET_ASYNC_REPLY:
9342     case OFPTYPE_GROUP_STATS_REPLY:
9343     case OFPTYPE_GROUP_DESC_STATS_REPLY:
9344     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
9345     case OFPTYPE_METER_STATS_REPLY:
9346     case OFPTYPE_METER_CONFIG_STATS_REPLY:
9347     case OFPTYPE_METER_FEATURES_STATS_REPLY:
9348     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
9349     case OFPTYPE_TABLE_DESC_REPLY:
9350     case OFPTYPE_ROLE_STATUS:
9351     case OFPTYPE_REQUESTFORWARD:
9352     case OFPTYPE_NXT_TLV_TABLE_REQUEST:
9353     case OFPTYPE_NXT_TLV_TABLE_REPLY:
9354         break;
9355     }
9356
9357     return false;
9358 }
9359
9360 enum ofperr
9361 ofputil_decode_bundle_add(const struct ofp_header *oh,
9362                           struct ofputil_bundle_add_msg *msg,
9363                           enum ofptype *type_ptr)
9364 {
9365     const struct ofp14_bundle_ctrl_msg *m;
9366     struct ofpbuf b;
9367     enum ofpraw raw;
9368     size_t inner_len;
9369     enum ofperr error;
9370     enum ofptype type;
9371
9372     ofpbuf_use_const(&b, oh, ntohs(oh->length));
9373     raw = ofpraw_pull_assert(&b);
9374     ovs_assert(raw == OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE);
9375
9376     m = ofpbuf_pull(&b, sizeof *m);
9377     msg->bundle_id = ntohl(m->bundle_id);
9378     msg->flags = ntohs(m->flags);
9379
9380     msg->msg = b.data;
9381     if (msg->msg->version != oh->version) {
9382         return OFPERR_NXBFC_BAD_VERSION;
9383     }
9384     inner_len = ntohs(msg->msg->length);
9385     if (inner_len < sizeof(struct ofp_header) || inner_len > b.size) {
9386         return OFPERR_OFPBFC_MSG_BAD_LEN;
9387     }
9388     if (msg->msg->xid != oh->xid) {
9389         return OFPERR_OFPBFC_MSG_BAD_XID;
9390     }
9391
9392     /* Reject unbundlable messages. */
9393     if (!type_ptr) {
9394         type_ptr = &type;
9395     }
9396     error = ofptype_decode(type_ptr, msg->msg);
9397     if (error) {
9398         VLOG_WARN_RL(&bad_ofmsg_rl, "OFPT14_BUNDLE_ADD_MESSAGE contained "
9399                      "message is unparsable (%s)", ofperr_get_name(error));
9400         return OFPERR_OFPBFC_MSG_UNSUP; /* 'error' would be confusing. */
9401     }
9402
9403     if (!ofputil_is_bundlable(*type_ptr)) {
9404         VLOG_WARN_RL(&bad_ofmsg_rl, "%s message not allowed inside "
9405                      "OFPT14_BUNDLE_ADD_MESSAGE", ofptype_get_name(*type_ptr));
9406         return OFPERR_OFPBFC_MSG_UNSUP;
9407     }
9408
9409     return 0;
9410 }
9411
9412 struct ofpbuf *
9413 ofputil_encode_bundle_add(enum ofp_version ofp_version,
9414                           struct ofputil_bundle_add_msg *msg)
9415 {
9416     struct ofpbuf *request;
9417     struct ofp14_bundle_ctrl_msg *m;
9418
9419     /* Must use the same xid as the embedded message. */
9420     request = ofpraw_alloc_xid(OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE, ofp_version,
9421                                msg->msg->xid, 0);
9422     m = ofpbuf_put_zeros(request, sizeof *m);
9423
9424     m->bundle_id = htonl(msg->bundle_id);
9425     m->flags = htons(msg->flags);
9426     ofpbuf_put(request, msg->msg, ntohs(msg->msg->length));
9427
9428     return request;
9429 }
9430
9431 static void
9432 encode_tlv_table_mappings(struct ofpbuf *b, struct ovs_list *mappings)
9433 {
9434     struct ofputil_tlv_map *map;
9435
9436     LIST_FOR_EACH (map, list_node, mappings) {
9437         struct nx_tlv_map *nx_map;
9438
9439         nx_map = ofpbuf_put_zeros(b, sizeof *nx_map);
9440         nx_map->option_class = htons(map->option_class);
9441         nx_map->option_type = map->option_type;
9442         nx_map->option_len = map->option_len;
9443         nx_map->index = htons(map->index);
9444     }
9445 }
9446
9447 struct ofpbuf *
9448 ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
9449                                 struct ofputil_tlv_table_mod *ttm)
9450 {
9451     struct ofpbuf *b;
9452     struct nx_tlv_table_mod *nx_ttm;
9453
9454     b = ofpraw_alloc(OFPRAW_NXT_TLV_TABLE_MOD, ofp_version, 0);
9455     nx_ttm = ofpbuf_put_zeros(b, sizeof *nx_ttm);
9456     nx_ttm->command = htons(ttm->command);
9457     encode_tlv_table_mappings(b, &ttm->mappings);
9458
9459     return b;
9460 }
9461
9462 static enum ofperr
9463 decode_tlv_table_mappings(struct ofpbuf *msg, unsigned int max_fields,
9464                              struct ovs_list *mappings)
9465 {
9466     list_init(mappings);
9467
9468     while (msg->size) {
9469         struct nx_tlv_map *nx_map;
9470         struct ofputil_tlv_map *map;
9471
9472         nx_map = ofpbuf_pull(msg, sizeof *nx_map);
9473         map = xmalloc(sizeof *map);
9474         list_push_back(mappings, &map->list_node);
9475
9476         map->option_class = ntohs(nx_map->option_class);
9477         map->option_type = nx_map->option_type;
9478
9479         map->option_len = nx_map->option_len;
9480         if (map->option_len % 4 || map->option_len > TLV_MAX_OPT_SIZE) {
9481             VLOG_WARN_RL(&bad_ofmsg_rl,
9482                          "tlv table option length (%u) is not a valid option size",
9483                          map->option_len);
9484             ofputil_uninit_tlv_table(mappings);
9485             return OFPERR_NXTTMFC_BAD_OPT_LEN;
9486         }
9487
9488         map->index = ntohs(nx_map->index);
9489         if (map->index >= max_fields) {
9490             VLOG_WARN_RL(&bad_ofmsg_rl,
9491                          "tlv table field index (%u) is too large (max %u)",
9492                          map->index, max_fields - 1);
9493             ofputil_uninit_tlv_table(mappings);
9494             return OFPERR_NXTTMFC_BAD_FIELD_IDX;
9495         }
9496     }
9497
9498     return 0;
9499 }
9500
9501 enum ofperr
9502 ofputil_decode_tlv_table_mod(const struct ofp_header *oh,
9503                                 struct ofputil_tlv_table_mod *ttm)
9504 {
9505     struct ofpbuf msg;
9506     struct nx_tlv_table_mod *nx_ttm;
9507
9508     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
9509     ofpraw_pull_assert(&msg);
9510
9511     nx_ttm = ofpbuf_pull(&msg, sizeof *nx_ttm);
9512     ttm->command = ntohs(nx_ttm->command);
9513     if (ttm->command > NXTTMC_CLEAR) {
9514         VLOG_WARN_RL(&bad_ofmsg_rl,
9515                      "tlv table mod command (%u) is out of range",
9516                      ttm->command);
9517         return OFPERR_NXTTMFC_BAD_COMMAND;
9518     }
9519
9520     return decode_tlv_table_mappings(&msg, TUN_METADATA_NUM_OPTS,
9521                                         &ttm->mappings);
9522 }
9523
9524 struct ofpbuf *
9525 ofputil_encode_tlv_table_reply(const struct ofp_header *oh,
9526                                   struct ofputil_tlv_table_reply *ttr)
9527 {
9528     struct ofpbuf *b;
9529     struct nx_tlv_table_reply *nx_ttr;
9530
9531     b = ofpraw_alloc_reply(OFPRAW_NXT_TLV_TABLE_REPLY, oh, 0);
9532     nx_ttr = ofpbuf_put_zeros(b, sizeof *nx_ttr);
9533     nx_ttr->max_option_space = htonl(ttr->max_option_space);
9534     nx_ttr->max_fields = htons(ttr->max_fields);
9535
9536     encode_tlv_table_mappings(b, &ttr->mappings);
9537
9538     return b;
9539 }
9540
9541 /* Decodes the NXT_TLV_TABLE_REPLY message in 'oh' into '*ttr'.  Returns 0
9542  * if successful, otherwise an ofperr.
9543  *
9544  * The decoder verifies that the indexes in 'ttr->mappings' are less than
9545  * 'ttr->max_fields', but the caller must ensure, if necessary, that they are
9546  * less than TUN_METADATA_NUM_OPTS. */
9547 enum ofperr
9548 ofputil_decode_tlv_table_reply(const struct ofp_header *oh,
9549                                   struct ofputil_tlv_table_reply *ttr)
9550 {
9551     struct ofpbuf msg;
9552     struct nx_tlv_table_reply *nx_ttr;
9553
9554     ofpbuf_use_const(&msg, oh, ntohs(oh->length));
9555     ofpraw_pull_assert(&msg);
9556
9557     nx_ttr = ofpbuf_pull(&msg, sizeof *nx_ttr);
9558     ttr->max_option_space = ntohl(nx_ttr->max_option_space);
9559     ttr->max_fields = ntohs(nx_ttr->max_fields);
9560
9561     return decode_tlv_table_mappings(&msg, ttr->max_fields, &ttr->mappings);
9562 }
9563
9564 void
9565 ofputil_uninit_tlv_table(struct ovs_list *mappings)
9566 {
9567     struct ofputil_tlv_map *map;
9568
9569     LIST_FOR_EACH_POP (map, list_node, mappings) {
9570         free(map);
9571     }
9572 }
9573
9574 /* Decodes the OpenFlow "set async config" request and "get async config
9575  * reply" message in '*oh' into an abstract form in 'master' and 'slave'.
9576  *
9577  * If 'loose' is true, this function ignores properties and values that it does
9578  * not understand, as a controller would want to do when interpreting
9579  * capabilities provided by a switch.  If 'loose' is false, this function
9580  * treats unknown properties and values as an error, as a switch would want to
9581  * do when interpreting a configuration request made by a controller.
9582  *
9583  * Returns 0 if successful, otherwise an OFPERR_* value.
9584  *
9585  * Returns error code OFPERR_OFPACFC_INVALID if the value of mask is not in
9586  * the valid range of mask.
9587  *
9588  * Returns error code OFPERR_OFPACFC_UNSUPPORTED if the configuration is not
9589  * supported.*/
9590 enum ofperr
9591 ofputil_decode_set_async_config(const struct ofp_header *oh,
9592                                 uint32_t master[OAM_N_TYPES],
9593                                 uint32_t slave[OAM_N_TYPES],
9594                                 bool loose)
9595 {
9596     enum ofpraw raw;
9597     struct ofpbuf b;
9598
9599     ofpbuf_use_const(&b, oh, ntohs(oh->length));
9600     raw = ofpraw_pull_assert(&b);
9601
9602     if (raw == OFPRAW_OFPT13_SET_ASYNC ||
9603         raw == OFPRAW_NXT_SET_ASYNC_CONFIG ||
9604         raw == OFPRAW_OFPT13_GET_ASYNC_REPLY) {
9605         const struct nx_async_config *msg = ofpmsg_body(oh);
9606
9607         master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
9608         master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
9609         master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
9610
9611         slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
9612         slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
9613         slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
9614
9615     } else if (raw == OFPRAW_OFPT14_SET_ASYNC ||
9616                raw == OFPRAW_OFPT14_GET_ASYNC_REPLY) {
9617
9618         while (b.size > 0) {
9619             struct ofp14_async_config_prop_reasons *msg;
9620             struct ofpbuf property;
9621             enum ofperr error;
9622             uint16_t type;
9623
9624             error = ofputil_pull_property(&b, &property, &type);
9625             if (error) {
9626                 return error;
9627             }
9628
9629             msg = property.data;
9630
9631             if (property.size != sizeof *msg) {
9632                 return OFPERR_OFPBRC_BAD_LEN;
9633             }
9634
9635             if (!loose) {
9636                 error = ofputil_check_mask(type, ntohl(msg->mask));
9637                 if (error) {
9638                     return error;
9639                 }
9640              }
9641
9642             switch (type) {
9643             case OFPACPT_PACKET_IN_SLAVE:
9644                 slave[OAM_PACKET_IN] = ntohl(msg->mask);
9645                 break;
9646
9647             case OFPACPT_PACKET_IN_MASTER:
9648                 master[OAM_PACKET_IN] = ntohl(msg->mask);
9649                 break;
9650
9651             case OFPACPT_PORT_STATUS_SLAVE:
9652                 slave[OAM_PORT_STATUS] = ntohl(msg->mask);
9653                 break;
9654
9655             case OFPACPT_PORT_STATUS_MASTER:
9656                 master[OAM_PORT_STATUS] = ntohl(msg->mask);
9657                 break;
9658
9659             case OFPACPT_FLOW_REMOVED_SLAVE:
9660                 slave[OAM_FLOW_REMOVED] = ntohl(msg->mask);
9661                 break;
9662
9663             case OFPACPT_FLOW_REMOVED_MASTER:
9664                 master[OAM_FLOW_REMOVED] = ntohl(msg->mask);
9665                 break;
9666
9667             case OFPACPT_ROLE_STATUS_SLAVE:
9668                 slave[OAM_ROLE_STATUS] = ntohl(msg->mask);
9669                 break;
9670
9671             case OFPACPT_ROLE_STATUS_MASTER:
9672                 master[OAM_ROLE_STATUS] = ntohl(msg->mask);
9673                 break;
9674
9675             case OFPACPT_TABLE_STATUS_SLAVE:
9676                 slave[OAM_TABLE_STATUS] = ntohl(msg->mask);
9677                 break;
9678
9679             case OFPACPT_TABLE_STATUS_MASTER:
9680                 master[OAM_TABLE_STATUS] = ntohl(msg->mask);
9681                 break;
9682
9683             case OFPACPT_REQUESTFORWARD_SLAVE:
9684                 slave[OAM_REQUESTFORWARD] = ntohl(msg->mask);
9685                 break;
9686
9687             case OFPACPT_REQUESTFORWARD_MASTER:
9688                 master[OAM_REQUESTFORWARD] = ntohl(msg->mask);
9689                 break;
9690
9691             default:
9692                 error = loose ? 0 : OFPERR_OFPACFC_UNSUPPORTED;
9693                 return error;
9694             }
9695         }
9696     } else {
9697         return OFPERR_OFPBRC_BAD_VERSION;
9698     }
9699     return 0;
9700 }
9701
9702 /* Append all asynchronous configuration properties in GET_ASYNC_REPLY
9703  * message, describing if various set of asynchronous messages are enabled
9704  * or not. */
9705 static enum ofperr
9706 ofputil_get_async_reply(struct ofpbuf *buf, const uint32_t master_mask,
9707                         const uint32_t slave_mask, const uint32_t type)
9708 {
9709     int role;
9710
9711     for (role = 0; role < 2; role++) {
9712         struct ofp14_async_config_prop_reasons *msg;
9713
9714         msg = ofpbuf_put_zeros(buf, sizeof *msg);
9715
9716         switch (type) {
9717         case OAM_PACKET_IN:
9718             msg->type = (role ? htons(OFPACPT_PACKET_IN_SLAVE)
9719                               : htons(OFPACPT_PACKET_IN_MASTER));
9720             break;
9721
9722         case OAM_PORT_STATUS:
9723             msg->type = (role ? htons(OFPACPT_PORT_STATUS_SLAVE)
9724                               : htons(OFPACPT_PORT_STATUS_MASTER));
9725             break;
9726
9727         case OAM_FLOW_REMOVED:
9728             msg->type = (role ? htons(OFPACPT_FLOW_REMOVED_SLAVE)
9729                               : htons(OFPACPT_FLOW_REMOVED_MASTER));
9730             break;
9731
9732         case OAM_ROLE_STATUS:
9733             msg->type = (role ? htons(OFPACPT_ROLE_STATUS_SLAVE)
9734                               : htons(OFPACPT_ROLE_STATUS_MASTER));
9735             break;
9736
9737         case OAM_TABLE_STATUS:
9738             msg->type = (role ? htons(OFPACPT_TABLE_STATUS_SLAVE)
9739                               : htons(OFPACPT_TABLE_STATUS_MASTER));
9740             break;
9741
9742         case OAM_REQUESTFORWARD:
9743             msg->type = (role ? htons(OFPACPT_REQUESTFORWARD_SLAVE)
9744                               : htons(OFPACPT_REQUESTFORWARD_MASTER));
9745             break;
9746
9747         default:
9748             return OFPERR_OFPBRC_BAD_TYPE;
9749         }
9750         msg->length = htons(sizeof *msg);
9751         msg->mask = (role ? htonl(slave_mask) : htonl(master_mask));
9752     }
9753
9754     return 0;
9755 }
9756
9757 /* Returns a OpenFlow message that encodes 'asynchronous configuration' properly
9758  * as a reply to get async config request. */
9759 struct ofpbuf *
9760 ofputil_encode_get_async_config(const struct ofp_header *oh,
9761                                 uint32_t master[OAM_N_TYPES],
9762                                 uint32_t slave[OAM_N_TYPES])
9763 {
9764     struct ofpbuf *buf;
9765     uint32_t type;
9766
9767     buf = ofpraw_alloc_reply((oh->version < OFP14_VERSION
9768                               ? OFPRAW_OFPT13_GET_ASYNC_REPLY
9769                               : OFPRAW_OFPT14_GET_ASYNC_REPLY), oh, 0);
9770
9771     if (oh->version < OFP14_VERSION) {
9772         struct nx_async_config *msg;
9773         msg = ofpbuf_put_zeros(buf, sizeof *msg);
9774
9775         msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
9776         msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
9777         msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
9778
9779         msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
9780         msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
9781         msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
9782     } else if (oh->version == OFP14_VERSION) {
9783         for (type = 0; type < OAM_N_TYPES; type++) {
9784             ofputil_get_async_reply(buf, master[type], slave[type], type);
9785         }
9786     }
9787
9788     return buf;
9789 }