lib/ofp-util.c

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