lib/ofp-util.c

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