lib/ofp-util.c

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