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, bands);
1697         if (error) {
1698             return error;
1699         }
1700     }
1701     return 0;
1702 }
1703
1704 void
1705 ofputil_decode_meter_request(const struct ofp_header *oh, uint32_t *meter_id)
1706 {
1707     const struct ofp13_meter_multipart_request *omr = ofpmsg_body(oh);
1708     *meter_id = ntohl(omr->meter_id);
1709 }
1710
1711 struct ofpbuf *
1712 ofputil_encode_meter_request(enum ofp_version ofp_version,
1713                              enum ofputil_meter_request_type type,
1714                              uint32_t meter_id)
1715 {
1716     struct ofpbuf *msg;
1717
1718     enum ofpraw raw;
1719
1720     switch (type) {
1721     case OFPUTIL_METER_CONFIG:
1722         raw = OFPRAW_OFPST13_METER_CONFIG_REQUEST;
1723         break;
1724     case OFPUTIL_METER_STATS:
1725         raw = OFPRAW_OFPST13_METER_REQUEST;
1726         break;
1727     default:
1728     case OFPUTIL_METER_FEATURES:
1729         raw = OFPRAW_OFPST13_METER_FEATURES_REQUEST;
1730         break;
1731     }
1732
1733     msg = ofpraw_alloc(raw, ofp_version, 0);
1734
1735     if (type != OFPUTIL_METER_FEATURES) {
1736         struct ofp13_meter_multipart_request *omr;
1737         omr = ofpbuf_put_zeros(msg, sizeof *omr);
1738         omr->meter_id = htonl(meter_id);
1739     }
1740     return msg;
1741 }
1742
1743 static void
1744 ofputil_put_bands(uint16_t n_bands, const struct ofputil_meter_band *mb,
1745                   struct ofpbuf *msg)
1746 {
1747     uint16_t n = 0;
1748
1749     for (n = 0; n < n_bands; ++n) {
1750         /* Currently all band types have same size. */
1751         struct ofp13_meter_band_dscp_remark *ombh;
1752         size_t ombh_len = sizeof *ombh;
1753
1754         ombh = ofpbuf_put_zeros(msg, ombh_len);
1755
1756         ombh->type = htons(mb->type);
1757         ombh->len = htons(ombh_len);
1758         ombh->rate = htonl(mb->rate);
1759         ombh->burst_size = htonl(mb->burst_size);
1760         ombh->prec_level = mb->prec_level;
1761
1762         mb++;
1763     }
1764 }
1765
1766 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1767 void
1768 ofputil_append_meter_config(struct list *replies,
1769                             const struct ofputil_meter_config *mc)
1770 {
1771     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1772     size_t start_ofs = msg->size;
1773     struct ofp13_meter_config *reply = ofpbuf_put_uninit(msg, sizeof *reply);
1774     reply->flags = htons(mc->flags);
1775     reply->meter_id = htonl(mc->meter_id);
1776
1777     ofputil_put_bands(mc->n_bands, mc->bands, msg);
1778
1779     reply->length = htons(msg->size - start_ofs);
1780
1781     ofpmp_postappend(replies, start_ofs);
1782 }
1783
1784 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1785 void
1786 ofputil_append_meter_stats(struct list *replies,
1787                            const struct ofputil_meter_stats *ms)
1788 {
1789     struct ofp13_meter_stats *reply;
1790     uint16_t n = 0;
1791     uint16_t len;
1792
1793     len = sizeof *reply + ms->n_bands * sizeof(struct ofp13_meter_band_stats);
1794     reply = ofpmp_append(replies, len);
1795
1796     reply->meter_id = htonl(ms->meter_id);
1797     reply->len = htons(len);
1798     memset(reply->pad, 0, sizeof reply->pad);
1799     reply->flow_count = htonl(ms->flow_count);
1800     reply->packet_in_count = htonll(ms->packet_in_count);
1801     reply->byte_in_count = htonll(ms->byte_in_count);
1802     reply->duration_sec = htonl(ms->duration_sec);
1803     reply->duration_nsec = htonl(ms->duration_nsec);
1804
1805     for (n = 0; n < ms->n_bands; ++n) {
1806         const struct ofputil_meter_band_stats *src = &ms->bands[n];
1807         struct ofp13_meter_band_stats *dst = &reply->band_stats[n];
1808
1809         dst->packet_band_count = htonll(src->packet_count);
1810         dst->byte_band_count = htonll(src->byte_count);
1811     }
1812 }
1813
1814 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1815  * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1816  * 'bands'.  The caller must have initialized 'bands' and retains ownership of
1817  * it across the call.
1818  *
1819  * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1820  * message.  Calling this function multiple times for a single 'msg' iterates
1821  * through the replies.  'bands' is cleared for each reply.
1822  *
1823  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1824  * otherwise a positive errno value. */
1825 int
1826 ofputil_decode_meter_config(struct ofpbuf *msg,
1827                             struct ofputil_meter_config *mc,
1828                             struct ofpbuf *bands)
1829 {
1830     const struct ofp13_meter_config *omc;
1831     enum ofperr err;
1832
1833     /* Pull OpenFlow headers for the first call. */
1834     if (!msg->l2) {
1835         ofpraw_pull_assert(msg);
1836     }
1837
1838     if (!msg->size) {
1839         return EOF;
1840     }
1841
1842     omc = ofpbuf_try_pull(msg, sizeof *omc);
1843     if (!omc) {
1844         VLOG_WARN_RL(&bad_ofmsg_rl,
1845                      "OFPMP_METER_CONFIG reply has %zu leftover bytes at end",
1846                      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     ombs = ofpbuf_try_pull(msg, len);
1872     if (!ombs) {
1873         return OFPERR_OFPBRC_BAD_LEN;
1874     }
1875
1876     n = len / sizeof *ombs;
1877     if (len != n * sizeof *ombs) {
1878         return OFPERR_OFPBRC_BAD_LEN;
1879     }
1880
1881     mbs = ofpbuf_put_uninit(bands, len);
1882
1883     for (i = 0; i < n; ++i) {
1884         mbs[i].packet_count = ntohll(ombs[i].packet_band_count);
1885         mbs[i].byte_count = ntohll(ombs[i].byte_band_count);
1886     }
1887     *n_bands = n;
1888     return 0;
1889 }
1890
1891 /* Converts an OFPMP_METER reply in 'msg' into an abstract
1892  * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
1893  * decoded into 'bands'.
1894  *
1895  * Multiple OFPMP_METER replies can be packed into a single OpenFlow
1896  * message.  Calling this function multiple times for a single 'msg' iterates
1897  * through the replies.  'bands' is cleared for each reply.
1898  *
1899  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1900  * otherwise a positive errno value. */
1901 int
1902 ofputil_decode_meter_stats(struct ofpbuf *msg,
1903                            struct ofputil_meter_stats *ms,
1904                            struct ofpbuf *bands)
1905 {
1906     const struct ofp13_meter_stats *oms;
1907     enum ofperr err;
1908
1909     /* Pull OpenFlow headers for the first call. */
1910     if (!msg->l2) {
1911         ofpraw_pull_assert(msg);
1912     }
1913
1914     if (!msg->size) {
1915         return EOF;
1916     }
1917
1918     oms = ofpbuf_try_pull(msg, sizeof *oms);
1919     if (!oms) {
1920         VLOG_WARN_RL(&bad_ofmsg_rl,
1921                      "OFPMP_METER reply has %zu leftover bytes at end",
1922                      msg->size);
1923         return OFPERR_OFPBRC_BAD_LEN;
1924     }
1925
1926     ofpbuf_clear(bands);
1927     err = ofputil_pull_band_stats(msg, ntohs(oms->len) - sizeof *oms,
1928                                   &ms->n_bands, bands);
1929     if (err) {
1930         return err;
1931     }
1932     ms->meter_id = ntohl(oms->meter_id);
1933     ms->flow_count = ntohl(oms->flow_count);
1934     ms->packet_in_count = ntohll(oms->packet_in_count);
1935     ms->byte_in_count = ntohll(oms->byte_in_count);
1936     ms->duration_sec = ntohl(oms->duration_sec);
1937     ms->duration_nsec = ntohl(oms->duration_nsec);
1938     ms->bands = bands->data;
1939
1940     return 0;
1941 }
1942
1943 void
1944 ofputil_decode_meter_features(const struct ofp_header *oh,
1945                               struct ofputil_meter_features *mf)
1946 {
1947     const struct ofp13_meter_features *omf = ofpmsg_body(oh);
1948
1949     mf->max_meters = ntohl(omf->max_meter);
1950     mf->band_types = ntohl(omf->band_types);
1951     mf->capabilities = ntohl(omf->capabilities);
1952     mf->max_bands = omf->max_bands;
1953     mf->max_color = omf->max_color;
1954 }
1955
1956 struct ofpbuf *
1957 ofputil_encode_meter_features_reply(const struct ofputil_meter_features *mf,
1958                                     const struct ofp_header *request)
1959 {
1960     struct ofpbuf *reply;
1961     struct ofp13_meter_features *omf;
1962
1963     reply = ofpraw_alloc_stats_reply(request, 0);
1964     omf = ofpbuf_put_zeros(reply, sizeof *omf);
1965
1966     omf->max_meter = htonl(mf->max_meters);
1967     omf->band_types = htonl(mf->band_types);
1968     omf->capabilities = htonl(mf->capabilities);
1969     omf->max_bands = mf->max_bands;
1970     omf->max_color = mf->max_color;
1971
1972     return reply;
1973 }
1974
1975 struct ofpbuf *
1976 ofputil_encode_meter_mod(enum ofp_version ofp_version,
1977                          const struct ofputil_meter_mod *mm)
1978 {
1979     struct ofpbuf *msg;
1980
1981     struct ofp13_meter_mod *omm;
1982
1983     msg = ofpraw_alloc(OFPRAW_OFPT13_METER_MOD, ofp_version,
1984                        NXM_TYPICAL_LEN + mm->meter.n_bands * 16);
1985     omm = ofpbuf_put_zeros(msg, sizeof *omm);
1986     omm->command = htons(mm->command);
1987     if (mm->command != OFPMC13_DELETE) {
1988         omm->flags = htons(mm->meter.flags);
1989     }
1990     omm->meter_id = htonl(mm->meter.meter_id);
1991
1992     ofputil_put_bands(mm->meter.n_bands, mm->meter.bands, msg);
1993
1994     ofpmsg_update_length(msg);
1995     return msg;
1996 }
1997
1998 static ovs_be16
1999 ofputil_tid_command(const struct ofputil_flow_mod *fm,
2000                     enum ofputil_protocol protocol)
2001 {
2002     return htons(protocol & OFPUTIL_P_TID
2003                  ? (fm->command & 0xff) | (fm->table_id << 8)
2004                  : fm->command);
2005 }
2006
2007 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2008  * 'protocol' and returns the message. */
2009 struct ofpbuf *
2010 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
2011                         enum ofputil_protocol protocol)
2012 {
2013     struct ofpbuf *msg;
2014
2015     switch (protocol) {
2016     case OFPUTIL_P_OF12_OXM:
2017     case OFPUTIL_P_OF13_OXM: {
2018         struct ofp11_flow_mod *ofm;
2019
2020         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD,
2021                            ofputil_protocol_to_ofp_version(protocol),
2022                            NXM_TYPICAL_LEN + fm->ofpacts_len);
2023         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2024         if (fm->command == OFPFC_ADD) {
2025             ofm->cookie = fm->new_cookie;
2026         } else {
2027             ofm->cookie = fm->cookie;
2028         }
2029         ofm->cookie_mask = fm->cookie_mask;
2030         ofm->table_id = fm->table_id;
2031         ofm->command = fm->command;
2032         ofm->idle_timeout = htons(fm->idle_timeout);
2033         ofm->hard_timeout = htons(fm->hard_timeout);
2034         ofm->priority = htons(fm->priority);
2035         ofm->buffer_id = htonl(fm->buffer_id);
2036         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
2037         ofm->out_group = htonl(OFPG11_ANY);
2038         ofm->flags = htons(fm->flags);
2039         oxm_put_match(msg, &fm->match);
2040         ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
2041         break;
2042     }
2043
2044     case OFPUTIL_P_OF10_STD:
2045     case OFPUTIL_P_OF10_STD_TID: {
2046         struct ofp10_flow_mod *ofm;
2047
2048         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
2049                            fm->ofpacts_len);
2050         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
2051         ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
2052         ofm->cookie = fm->new_cookie;
2053         ofm->command = ofputil_tid_command(fm, protocol);
2054         ofm->idle_timeout = htons(fm->idle_timeout);
2055         ofm->hard_timeout = htons(fm->hard_timeout);
2056         ofm->priority = htons(fm->priority);
2057         ofm->buffer_id = htonl(fm->buffer_id);
2058         ofm->out_port = htons(ofp_to_u16(fm->out_port));
2059         ofm->flags = htons(fm->flags);
2060         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2061         break;
2062     }
2063
2064     case OFPUTIL_P_OF10_NXM:
2065     case OFPUTIL_P_OF10_NXM_TID: {
2066         struct nx_flow_mod *nfm;
2067         int match_len;
2068
2069         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
2070                            NXM_TYPICAL_LEN + fm->ofpacts_len);
2071         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
2072         nfm->command = ofputil_tid_command(fm, protocol);
2073         nfm->cookie = fm->new_cookie;
2074         match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
2075         nfm = msg->l3;
2076         nfm->idle_timeout = htons(fm->idle_timeout);
2077         nfm->hard_timeout = htons(fm->hard_timeout);
2078         nfm->priority = htons(fm->priority);
2079         nfm->buffer_id = htonl(fm->buffer_id);
2080         nfm->out_port = htons(ofp_to_u16(fm->out_port));
2081         nfm->flags = htons(fm->flags);
2082         nfm->match_len = htons(match_len);
2083         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
2084         break;
2085     }
2086
2087     default:
2088         NOT_REACHED();
2089     }
2090
2091     ofpmsg_update_length(msg);
2092     return msg;
2093 }
2094
2095 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2096  * send all of the 'n_fm's flow table modification requests in 'fms', and a
2097  * 0-bit for each protocol that is inadequate.
2098  *
2099  * (The return value will have at least one 1-bit.) */
2100 enum ofputil_protocol
2101 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
2102                                   size_t n_fms)
2103 {
2104     enum ofputil_protocol usable_protocols;
2105     size_t i;
2106
2107     usable_protocols = OFPUTIL_P_ANY;
2108     for (i = 0; i < n_fms; i++) {
2109         const struct ofputil_flow_mod *fm = &fms[i];
2110
2111         usable_protocols &= ofputil_usable_protocols(&fm->match);
2112         if (fm->table_id != 0xff) {
2113             usable_protocols &= OFPUTIL_P_TID;
2114         }
2115
2116         /* Matching of the cookie is only supported through NXM or OF1.1+. */
2117         if (fm->cookie_mask != htonll(0)) {
2118             usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
2119                 | OFPUTIL_P_OF13_OXM;
2120         }
2121     }
2122
2123     return usable_protocols;
2124 }
2125
2126 static enum ofperr
2127 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
2128                                     const struct ofp10_flow_stats_request *ofsr,
2129                                     bool aggregate)
2130 {
2131     fsr->aggregate = aggregate;
2132     ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
2133     fsr->out_port = u16_to_ofp(ntohs(ofsr->out_port));
2134     fsr->table_id = ofsr->table_id;
2135     fsr->cookie = fsr->cookie_mask = htonll(0);
2136
2137     return 0;
2138 }
2139
2140 static enum ofperr
2141 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
2142                                     struct ofpbuf *b, bool aggregate)
2143 {
2144     const struct ofp11_flow_stats_request *ofsr;
2145     enum ofperr error;
2146
2147     ofsr = ofpbuf_pull(b, sizeof *ofsr);
2148     fsr->aggregate = aggregate;
2149     fsr->table_id = ofsr->table_id;
2150     error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
2151     if (error) {
2152         return error;
2153     }
2154     if (ofsr->out_group != htonl(OFPG11_ANY)) {
2155         return OFPERR_OFPFMFC_UNKNOWN;
2156     }
2157     fsr->cookie = ofsr->cookie;
2158     fsr->cookie_mask = ofsr->cookie_mask;
2159     error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
2160     if (error) {
2161         return error;
2162     }
2163
2164     return 0;
2165 }
2166
2167 static enum ofperr
2168 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
2169                                  struct ofpbuf *b, bool aggregate)
2170 {
2171     const struct nx_flow_stats_request *nfsr;
2172     enum ofperr error;
2173
2174     nfsr = ofpbuf_pull(b, sizeof *nfsr);
2175     error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
2176                           &fsr->cookie, &fsr->cookie_mask);
2177     if (error) {
2178         return error;
2179     }
2180     if (b->size) {
2181         return OFPERR_OFPBRC_BAD_LEN;
2182     }
2183
2184     fsr->aggregate = aggregate;
2185     fsr->out_port = u16_to_ofp(ntohs(nfsr->out_port));
2186     fsr->table_id = nfsr->table_id;
2187
2188     return 0;
2189 }
2190
2191 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2192  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
2193  * successful, otherwise an OpenFlow error code. */
2194 enum ofperr
2195 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
2196                                   const struct ofp_header *oh)
2197 {
2198     enum ofpraw raw;
2199     struct ofpbuf b;
2200
2201     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2202     raw = ofpraw_pull_assert(&b);
2203     switch ((int) raw) {
2204     case OFPRAW_OFPST10_FLOW_REQUEST:
2205         return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
2206
2207     case OFPRAW_OFPST10_AGGREGATE_REQUEST:
2208         return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
2209
2210     case OFPRAW_OFPST11_FLOW_REQUEST:
2211         return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
2212
2213     case OFPRAW_OFPST11_AGGREGATE_REQUEST:
2214         return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
2215
2216     case OFPRAW_NXST_FLOW_REQUEST:
2217         return ofputil_decode_nxst_flow_request(fsr, &b, false);
2218
2219     case OFPRAW_NXST_AGGREGATE_REQUEST:
2220         return ofputil_decode_nxst_flow_request(fsr, &b, true);
2221
2222     default:
2223         /* Hey, the caller lied. */
2224         NOT_REACHED();
2225     }
2226 }
2227
2228 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2229  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2230  * 'protocol', and returns the message. */
2231 struct ofpbuf *
2232 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
2233                                   enum ofputil_protocol protocol)
2234 {
2235     struct ofpbuf *msg;
2236     enum ofpraw raw;
2237
2238     switch (protocol) {
2239     case OFPUTIL_P_OF12_OXM:
2240     case OFPUTIL_P_OF13_OXM: {
2241         struct ofp11_flow_stats_request *ofsr;
2242
2243         raw = (fsr->aggregate
2244                ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2245                : OFPRAW_OFPST11_FLOW_REQUEST);
2246         msg = ofpraw_alloc(raw, ofputil_protocol_to_ofp_version(protocol),
2247                            NXM_TYPICAL_LEN);
2248         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2249         ofsr->table_id = fsr->table_id;
2250         ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
2251         ofsr->out_group = htonl(OFPG11_ANY);
2252         ofsr->cookie = fsr->cookie;
2253         ofsr->cookie_mask = fsr->cookie_mask;
2254         oxm_put_match(msg, &fsr->match);
2255         break;
2256     }
2257
2258     case OFPUTIL_P_OF10_STD:
2259     case OFPUTIL_P_OF10_STD_TID: {
2260         struct ofp10_flow_stats_request *ofsr;
2261
2262         raw = (fsr->aggregate
2263                ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2264                : OFPRAW_OFPST10_FLOW_REQUEST);
2265         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
2266         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
2267         ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
2268         ofsr->table_id = fsr->table_id;
2269         ofsr->out_port = htons(ofp_to_u16(fsr->out_port));
2270         break;
2271     }
2272
2273     case OFPUTIL_P_OF10_NXM:
2274     case OFPUTIL_P_OF10_NXM_TID: {
2275         struct nx_flow_stats_request *nfsr;
2276         int match_len;
2277
2278         raw = (fsr->aggregate
2279                ? OFPRAW_NXST_AGGREGATE_REQUEST
2280                : OFPRAW_NXST_FLOW_REQUEST);
2281         msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
2282         ofpbuf_put_zeros(msg, sizeof *nfsr);
2283         match_len = nx_put_match(msg, &fsr->match,
2284                                  fsr->cookie, fsr->cookie_mask);
2285
2286         nfsr = msg->l3;
2287         nfsr->out_port = htons(ofp_to_u16(fsr->out_port));
2288         nfsr->match_len = htons(match_len);
2289         nfsr->table_id = fsr->table_id;
2290         break;
2291     }
2292
2293     default:
2294         NOT_REACHED();
2295     }
2296
2297     return msg;
2298 }
2299
2300 /* Returns a bitmask with a 1-bit for each protocol that could be used to
2301  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
2302  *
2303  * (The return value will have at least one 1-bit.) */
2304 enum ofputil_protocol
2305 ofputil_flow_stats_request_usable_protocols(
2306     const struct ofputil_flow_stats_request *fsr)
2307 {
2308     enum ofputil_protocol usable_protocols;
2309
2310     usable_protocols = ofputil_usable_protocols(&fsr->match);
2311     if (fsr->cookie_mask != htonll(0)) {
2312         usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM
2313             | OFPUTIL_P_OF13_OXM;
2314     }
2315     return usable_protocols;
2316 }
2317
2318 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2319  * ofputil_flow_stats in 'fs'.
2320  *
2321  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2322  * OpenFlow message.  Calling this function multiple times for a single 'msg'
2323  * iterates through the replies.  The caller must initially leave 'msg''s layer
2324  * pointers null and not modify them between calls.
2325  *
2326  * Most switches don't send the values needed to populate fs->idle_age and
2327  * fs->hard_age, so those members will usually be set to 0.  If the switch from
2328  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2329  * 'flow_age_extension' as true so that the contents of 'msg' determine the
2330  * 'idle_age' and 'hard_age' members in 'fs'.
2331  *
2332  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2333  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
2334  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
2335  *
2336  * Returns 0 if successful, EOF if no replies were left in this 'msg',
2337  * otherwise a positive errno value. */
2338 int
2339 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2340                                 struct ofpbuf *msg,
2341                                 bool flow_age_extension,
2342                                 struct ofpbuf *ofpacts)
2343 {
2344     enum ofperr error;
2345     enum ofpraw raw;
2346
2347     error = (msg->l2
2348              ? ofpraw_decode(&raw, msg->l2)
2349              : ofpraw_pull(&raw, msg));
2350     if (error) {
2351         return error;
2352     }
2353
2354     if (!msg->size) {
2355         return EOF;
2356     } else if (raw == OFPRAW_OFPST11_FLOW_REPLY
2357                || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2358         const struct ofp11_flow_stats *ofs;
2359         size_t length;
2360         uint16_t padded_match_len;
2361
2362         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2363         if (!ofs) {
2364             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2365                          "bytes at end", msg->size);
2366             return EINVAL;
2367         }
2368
2369         length = ntohs(ofs->length);
2370         if (length < sizeof *ofs) {
2371             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2372                          "length %zu", length);
2373             return EINVAL;
2374         }
2375
2376         if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
2377             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
2378             return EINVAL;
2379         }
2380
2381         if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
2382                                                  padded_match_len,
2383                                                  ofs->table_id, ofpacts)) {
2384             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
2385             return EINVAL;
2386         }
2387
2388         fs->priority = ntohs(ofs->priority);
2389         fs->table_id = ofs->table_id;
2390         fs->duration_sec = ntohl(ofs->duration_sec);
2391         fs->duration_nsec = ntohl(ofs->duration_nsec);
2392         fs->idle_timeout = ntohs(ofs->idle_timeout);
2393         fs->hard_timeout = ntohs(ofs->hard_timeout);
2394         fs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? ntohs(ofs->flags) : 0;
2395         fs->idle_age = -1;
2396         fs->hard_age = -1;
2397         fs->cookie = ofs->cookie;
2398         fs->packet_count = ntohll(ofs->packet_count);
2399         fs->byte_count = ntohll(ofs->byte_count);
2400     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2401         const struct ofp10_flow_stats *ofs;
2402         size_t length;
2403
2404         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2405         if (!ofs) {
2406             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2407                          "bytes at end", msg->size);
2408             return EINVAL;
2409         }
2410
2411         length = ntohs(ofs->length);
2412         if (length < sizeof *ofs) {
2413             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2414                          "length %zu", length);
2415             return EINVAL;
2416         }
2417
2418         if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2419             return EINVAL;
2420         }
2421
2422         fs->cookie = get_32aligned_be64(&ofs->cookie);
2423         ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
2424         fs->priority = ntohs(ofs->priority);
2425         fs->table_id = ofs->table_id;
2426         fs->duration_sec = ntohl(ofs->duration_sec);
2427         fs->duration_nsec = ntohl(ofs->duration_nsec);
2428         fs->idle_timeout = ntohs(ofs->idle_timeout);
2429         fs->hard_timeout = ntohs(ofs->hard_timeout);
2430         fs->idle_age = -1;
2431         fs->hard_age = -1;
2432         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2433         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2434         fs->flags = 0;
2435     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2436         const struct nx_flow_stats *nfs;
2437         size_t match_len, actions_len, length;
2438
2439         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2440         if (!nfs) {
2441             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2442                          "bytes at end", msg->size);
2443             return EINVAL;
2444         }
2445
2446         length = ntohs(nfs->length);
2447         match_len = ntohs(nfs->match_len);
2448         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2449             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2450                          "claims invalid length %zu", match_len, length);
2451             return EINVAL;
2452         }
2453         if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
2454             return EINVAL;
2455         }
2456
2457         actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2458         if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2459             return EINVAL;
2460         }
2461
2462         fs->cookie = nfs->cookie;
2463         fs->table_id = nfs->table_id;
2464         fs->duration_sec = ntohl(nfs->duration_sec);
2465         fs->duration_nsec = ntohl(nfs->duration_nsec);
2466         fs->priority = ntohs(nfs->priority);
2467         fs->idle_timeout = ntohs(nfs->idle_timeout);
2468         fs->hard_timeout = ntohs(nfs->hard_timeout);
2469         fs->idle_age = -1;
2470         fs->hard_age = -1;
2471         if (flow_age_extension) {
2472             if (nfs->idle_age) {
2473                 fs->idle_age = ntohs(nfs->idle_age) - 1;
2474             }
2475             if (nfs->hard_age) {
2476                 fs->hard_age = ntohs(nfs->hard_age) - 1;
2477             }
2478         }
2479         fs->packet_count = ntohll(nfs->packet_count);
2480         fs->byte_count = ntohll(nfs->byte_count);
2481         fs->flags = 0;
2482     } else {
2483         NOT_REACHED();
2484     }
2485
2486     fs->ofpacts = ofpacts->data;
2487     fs->ofpacts_len = ofpacts->size;
2488
2489     return 0;
2490 }
2491
2492 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2493  *
2494  * We use this in situations where OVS internally uses UINT64_MAX to mean
2495  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2496 static uint64_t
2497 unknown_to_zero(uint64_t count)
2498 {
2499     return count != UINT64_MAX ? count : 0;
2500 }
2501
2502 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2503  * those already present in the list of ofpbufs in 'replies'.  'replies' should
2504  * have been initialized with ofputil_start_stats_reply(). */
2505 void
2506 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2507                                 struct list *replies)
2508 {
2509     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2510     size_t start_ofs = reply->size;
2511     enum ofpraw raw;
2512
2513     ofpraw_decode_partial(&raw, reply->data, reply->size);
2514     if (raw == OFPRAW_OFPST11_FLOW_REPLY || raw == OFPRAW_OFPST13_FLOW_REPLY) {
2515         struct ofp11_flow_stats *ofs;
2516
2517         ofpbuf_put_uninit(reply, sizeof *ofs);
2518         oxm_put_match(reply, &fs->match);
2519         ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2520                                             reply);
2521
2522         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2523         ofs->length = htons(reply->size - start_ofs);
2524         ofs->table_id = fs->table_id;
2525         ofs->pad = 0;
2526         ofs->duration_sec = htonl(fs->duration_sec);
2527         ofs->duration_nsec = htonl(fs->duration_nsec);
2528         ofs->priority = htons(fs->priority);
2529         ofs->idle_timeout = htons(fs->idle_timeout);
2530         ofs->hard_timeout = htons(fs->hard_timeout);
2531         ofs->flags = (raw == OFPRAW_OFPST13_FLOW_REPLY) ? htons(fs->flags) : 0;
2532         memset(ofs->pad2, 0, sizeof ofs->pad2);
2533         ofs->cookie = fs->cookie;
2534         ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2535         ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2536     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2537         struct ofp10_flow_stats *ofs;
2538
2539         ofpbuf_put_uninit(reply, sizeof *ofs);
2540         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2541
2542         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2543         ofs->length = htons(reply->size - start_ofs);
2544         ofs->table_id = fs->table_id;
2545         ofs->pad = 0;
2546         ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2547         ofs->duration_sec = htonl(fs->duration_sec);
2548         ofs->duration_nsec = htonl(fs->duration_nsec);
2549         ofs->priority = htons(fs->priority);
2550         ofs->idle_timeout = htons(fs->idle_timeout);
2551         ofs->hard_timeout = htons(fs->hard_timeout);
2552         memset(ofs->pad2, 0, sizeof ofs->pad2);
2553         put_32aligned_be64(&ofs->cookie, fs->cookie);
2554         put_32aligned_be64(&ofs->packet_count,
2555                            htonll(unknown_to_zero(fs->packet_count)));
2556         put_32aligned_be64(&ofs->byte_count,
2557                            htonll(unknown_to_zero(fs->byte_count)));
2558     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2559         struct nx_flow_stats *nfs;
2560         int match_len;
2561
2562         ofpbuf_put_uninit(reply, sizeof *nfs);
2563         match_len = nx_put_match(reply, &fs->match, 0, 0);
2564         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2565
2566         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2567         nfs->length = htons(reply->size - start_ofs);
2568         nfs->table_id = fs->table_id;
2569         nfs->pad = 0;
2570         nfs->duration_sec = htonl(fs->duration_sec);
2571         nfs->duration_nsec = htonl(fs->duration_nsec);
2572         nfs->priority = htons(fs->priority);
2573         nfs->idle_timeout = htons(fs->idle_timeout);
2574         nfs->hard_timeout = htons(fs->hard_timeout);
2575         nfs->idle_age = htons(fs->idle_age < 0 ? 0
2576                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2577                               : UINT16_MAX);
2578         nfs->hard_age = htons(fs->hard_age < 0 ? 0
2579                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2580                               : UINT16_MAX);
2581         nfs->match_len = htons(match_len);
2582         nfs->cookie = fs->cookie;
2583         nfs->packet_count = htonll(fs->packet_count);
2584         nfs->byte_count = htonll(fs->byte_count);
2585     } else {
2586         NOT_REACHED();
2587     }
2588
2589     ofpmp_postappend(replies, start_ofs);
2590 }
2591
2592 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2593  * NXST_AGGREGATE reply matching 'request', and returns the message. */
2594 struct ofpbuf *
2595 ofputil_encode_aggregate_stats_reply(
2596     const struct ofputil_aggregate_stats *stats,
2597     const struct ofp_header *request)
2598 {
2599     struct ofp_aggregate_stats_reply *asr;
2600     uint64_t packet_count;
2601     uint64_t byte_count;
2602     struct ofpbuf *msg;
2603     enum ofpraw raw;
2604
2605     ofpraw_decode(&raw, request);
2606     if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2607         packet_count = unknown_to_zero(stats->packet_count);
2608         byte_count = unknown_to_zero(stats->byte_count);
2609     } else {
2610         packet_count = stats->packet_count;
2611         byte_count = stats->byte_count;
2612     }
2613
2614     msg = ofpraw_alloc_stats_reply(request, 0);
2615     asr = ofpbuf_put_zeros(msg, sizeof *asr);
2616     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2617     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2618     asr->flow_count = htonl(stats->flow_count);
2619
2620     return msg;
2621 }
2622
2623 enum ofperr
2624 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2625                                      const struct ofp_header *reply)
2626 {
2627     struct ofp_aggregate_stats_reply *asr;
2628     struct ofpbuf msg;
2629
2630     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2631     ofpraw_pull_assert(&msg);
2632
2633     asr = msg.l3;
2634     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2635     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2636     stats->flow_count = ntohl(asr->flow_count);
2637
2638     return 0;
2639 }
2640
2641 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2642  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
2643  * an OpenFlow error code. */
2644 enum ofperr
2645 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2646                             const struct ofp_header *oh)
2647 {
2648     enum ofpraw raw;
2649     struct ofpbuf b;
2650
2651     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2652     raw = ofpraw_pull_assert(&b);
2653     if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2654         const struct ofp12_flow_removed *ofr;
2655         enum ofperr error;
2656
2657         ofr = ofpbuf_pull(&b, sizeof *ofr);
2658
2659         error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2660         if (error) {
2661             return error;
2662         }
2663
2664         fr->priority = ntohs(ofr->priority);
2665         fr->cookie = ofr->cookie;
2666         fr->reason = ofr->reason;
2667         fr->table_id = ofr->table_id;
2668         fr->duration_sec = ntohl(ofr->duration_sec);
2669         fr->duration_nsec = ntohl(ofr->duration_nsec);
2670         fr->idle_timeout = ntohs(ofr->idle_timeout);
2671         fr->hard_timeout = ntohs(ofr->hard_timeout);
2672         fr->packet_count = ntohll(ofr->packet_count);
2673         fr->byte_count = ntohll(ofr->byte_count);
2674     } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2675         const struct ofp10_flow_removed *ofr;
2676
2677         ofr = ofpbuf_pull(&b, sizeof *ofr);
2678
2679         ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2680         fr->priority = ntohs(ofr->priority);
2681         fr->cookie = ofr->cookie;
2682         fr->reason = ofr->reason;
2683         fr->table_id = 255;
2684         fr->duration_sec = ntohl(ofr->duration_sec);
2685         fr->duration_nsec = ntohl(ofr->duration_nsec);
2686         fr->idle_timeout = ntohs(ofr->idle_timeout);
2687         fr->hard_timeout = 0;
2688         fr->packet_count = ntohll(ofr->packet_count);
2689         fr->byte_count = ntohll(ofr->byte_count);
2690     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2691         struct nx_flow_removed *nfr;
2692         enum ofperr error;
2693
2694         nfr = ofpbuf_pull(&b, sizeof *nfr);
2695         error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2696                               NULL, NULL);
2697         if (error) {
2698             return error;
2699         }
2700         if (b.size) {
2701             return OFPERR_OFPBRC_BAD_LEN;
2702         }
2703
2704         fr->priority = ntohs(nfr->priority);
2705         fr->cookie = nfr->cookie;
2706         fr->reason = nfr->reason;
2707         fr->table_id = nfr->table_id ? nfr->table_id - 1 : 255;
2708         fr->duration_sec = ntohl(nfr->duration_sec);
2709         fr->duration_nsec = ntohl(nfr->duration_nsec);
2710         fr->idle_timeout = ntohs(nfr->idle_timeout);
2711         fr->hard_timeout = 0;
2712         fr->packet_count = ntohll(nfr->packet_count);
2713         fr->byte_count = ntohll(nfr->byte_count);
2714     } else {
2715         NOT_REACHED();
2716     }
2717
2718     return 0;
2719 }
2720
2721 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2722  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2723  * message. */
2724 struct ofpbuf *
2725 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2726                             enum ofputil_protocol protocol)
2727 {
2728     struct ofpbuf *msg;
2729
2730     switch (protocol) {
2731     case OFPUTIL_P_OF12_OXM:
2732     case OFPUTIL_P_OF13_OXM: {
2733         struct ofp12_flow_removed *ofr;
2734
2735         msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2736                                ofputil_protocol_to_ofp_version(protocol),
2737                                htonl(0), NXM_TYPICAL_LEN);
2738         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2739         ofr->cookie = fr->cookie;
2740         ofr->priority = htons(fr->priority);
2741         ofr->reason = fr->reason;
2742         ofr->table_id = fr->table_id;
2743         ofr->duration_sec = htonl(fr->duration_sec);
2744         ofr->duration_nsec = htonl(fr->duration_nsec);
2745         ofr->idle_timeout = htons(fr->idle_timeout);
2746         ofr->hard_timeout = htons(fr->hard_timeout);
2747         ofr->packet_count = htonll(fr->packet_count);
2748         ofr->byte_count = htonll(fr->byte_count);
2749         oxm_put_match(msg, &fr->match);
2750         break;
2751     }
2752
2753     case OFPUTIL_P_OF10_STD:
2754     case OFPUTIL_P_OF10_STD_TID: {
2755         struct ofp10_flow_removed *ofr;
2756
2757         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2758                                htonl(0), 0);
2759         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2760         ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2761         ofr->cookie = fr->cookie;
2762         ofr->priority = htons(fr->priority);
2763         ofr->reason = fr->reason;
2764         ofr->duration_sec = htonl(fr->duration_sec);
2765         ofr->duration_nsec = htonl(fr->duration_nsec);
2766         ofr->idle_timeout = htons(fr->idle_timeout);
2767         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2768         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2769         break;
2770     }
2771
2772     case OFPUTIL_P_OF10_NXM:
2773     case OFPUTIL_P_OF10_NXM_TID: {
2774         struct nx_flow_removed *nfr;
2775         int match_len;
2776
2777         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2778                                htonl(0), NXM_TYPICAL_LEN);
2779         nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2780         match_len = nx_put_match(msg, &fr->match, 0, 0);
2781
2782         nfr = msg->l3;
2783         nfr->cookie = fr->cookie;
2784         nfr->priority = htons(fr->priority);
2785         nfr->reason = fr->reason;
2786         nfr->table_id = fr->table_id + 1;
2787         nfr->duration_sec = htonl(fr->duration_sec);
2788         nfr->duration_nsec = htonl(fr->duration_nsec);
2789         nfr->idle_timeout = htons(fr->idle_timeout);
2790         nfr->match_len = htons(match_len);
2791         nfr->packet_count = htonll(fr->packet_count);
2792         nfr->byte_count = htonll(fr->byte_count);
2793         break;
2794     }
2795
2796     default:
2797         NOT_REACHED();
2798     }
2799
2800     return msg;
2801 }
2802
2803 static void
2804 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2805                                 struct match *match, struct ofpbuf *b)
2806 {
2807     pin->packet = b->data;
2808     pin->packet_len = b->size;
2809
2810     pin->fmd.in_port = match->flow.in_port.ofp_port;
2811     pin->fmd.tun_id = match->flow.tunnel.tun_id;
2812     pin->fmd.tun_src = match->flow.tunnel.ip_src;
2813     pin->fmd.tun_dst = match->flow.tunnel.ip_dst;
2814     pin->fmd.metadata = match->flow.metadata;
2815     memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2816 }
2817
2818 enum ofperr
2819 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2820                          const struct ofp_header *oh)
2821 {
2822     enum ofpraw raw;
2823     struct ofpbuf b;
2824
2825     memset(pin, 0, sizeof *pin);
2826
2827     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2828     raw = ofpraw_pull_assert(&b);
2829     if (raw == OFPRAW_OFPT13_PACKET_IN || raw == OFPRAW_OFPT12_PACKET_IN) {
2830         const struct ofp13_packet_in *opi;
2831         struct match match;
2832         int error;
2833         size_t packet_in_size;
2834
2835         if (raw == OFPRAW_OFPT12_PACKET_IN) {
2836             packet_in_size = sizeof (struct ofp12_packet_in);
2837         } else {
2838             packet_in_size = sizeof (struct ofp13_packet_in);
2839         }
2840
2841         opi = ofpbuf_pull(&b, packet_in_size);
2842         error = oxm_pull_match_loose(&b, &match);
2843         if (error) {
2844             return error;
2845         }
2846
2847         if (!ofpbuf_try_pull(&b, 2)) {
2848             return OFPERR_OFPBRC_BAD_LEN;
2849         }
2850
2851         pin->reason = opi->pi.reason;
2852         pin->table_id = opi->pi.table_id;
2853         pin->buffer_id = ntohl(opi->pi.buffer_id);
2854         pin->total_len = ntohs(opi->pi.total_len);
2855
2856         if (raw == OFPRAW_OFPT13_PACKET_IN) {
2857             pin->cookie = opi->cookie;
2858         }
2859
2860         ofputil_decode_packet_in_finish(pin, &match, &b);
2861     } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2862         const struct ofp10_packet_in *opi;
2863
2864         opi = ofpbuf_pull(&b, offsetof(struct ofp10_packet_in, data));
2865
2866         pin->packet = opi->data;
2867         pin->packet_len = b.size;
2868
2869         pin->fmd.in_port = u16_to_ofp(ntohs(opi->in_port));
2870         pin->reason = opi->reason;
2871         pin->buffer_id = ntohl(opi->buffer_id);
2872         pin->total_len = ntohs(opi->total_len);
2873     } else if (raw == OFPRAW_NXT_PACKET_IN) {
2874         const struct nx_packet_in *npi;
2875         struct match match;
2876         int error;
2877
2878         npi = ofpbuf_pull(&b, sizeof *npi);
2879         error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2880                                     NULL);
2881         if (error) {
2882             return error;
2883         }
2884
2885         if (!ofpbuf_try_pull(&b, 2)) {
2886             return OFPERR_OFPBRC_BAD_LEN;
2887         }
2888
2889         pin->reason = npi->reason;
2890         pin->table_id = npi->table_id;
2891         pin->cookie = npi->cookie;
2892
2893         pin->buffer_id = ntohl(npi->buffer_id);
2894         pin->total_len = ntohs(npi->total_len);
2895
2896         ofputil_decode_packet_in_finish(pin, &match, &b);
2897     } else {
2898         NOT_REACHED();
2899     }
2900
2901     return 0;
2902 }
2903
2904 static void
2905 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2906                            struct match *match)
2907 {
2908     int i;
2909
2910     match_init_catchall(match);
2911     if (pin->fmd.tun_id != htonll(0)) {
2912         match_set_tun_id(match, pin->fmd.tun_id);
2913     }
2914     if (pin->fmd.tun_src != htonl(0)) {
2915         match_set_tun_src(match, pin->fmd.tun_src);
2916     }
2917     if (pin->fmd.tun_dst != htonl(0)) {
2918         match_set_tun_dst(match, pin->fmd.tun_dst);
2919     }
2920     if (pin->fmd.metadata != htonll(0)) {
2921         match_set_metadata(match, pin->fmd.metadata);
2922     }
2923
2924     for (i = 0; i < FLOW_N_REGS; i++) {
2925         if (pin->fmd.regs[i]) {
2926             match_set_reg(match, i, pin->fmd.regs[i]);
2927         }
2928     }
2929
2930     match_set_in_port(match, pin->fmd.in_port);
2931 }
2932
2933 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2934  * in the format specified by 'packet_in_format'.  */
2935 struct ofpbuf *
2936 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2937                          enum ofputil_protocol protocol,
2938                          enum nx_packet_in_format packet_in_format)
2939 {
2940     size_t send_len = MIN(pin->send_len, pin->packet_len);
2941     struct ofpbuf *packet;
2942
2943     /* Add OFPT_PACKET_IN. */
2944     if (protocol == OFPUTIL_P_OF13_OXM || protocol == OFPUTIL_P_OF12_OXM) {
2945         struct ofp13_packet_in *opi;
2946         struct match match;
2947         enum ofpraw packet_in_raw;
2948         enum ofp_version packet_in_version;
2949         size_t packet_in_size;
2950
2951         if (protocol == OFPUTIL_P_OF12_OXM) {
2952             packet_in_raw = OFPRAW_OFPT12_PACKET_IN;
2953             packet_in_version = OFP12_VERSION;
2954             packet_in_size = sizeof (struct ofp12_packet_in);
2955         } else {
2956             packet_in_raw = OFPRAW_OFPT13_PACKET_IN;
2957             packet_in_version = OFP13_VERSION;
2958             packet_in_size = sizeof (struct ofp13_packet_in);
2959         }
2960
2961         ofputil_packet_in_to_match(pin, &match);
2962
2963         /* The final argument is just an estimate of the space required. */
2964         packet = ofpraw_alloc_xid(packet_in_raw, packet_in_version,
2965                                   htonl(0), (sizeof(struct flow_metadata) * 2
2966                                              + 2 + send_len));
2967         ofpbuf_put_zeros(packet, packet_in_size);
2968         oxm_put_match(packet, &match);
2969         ofpbuf_put_zeros(packet, 2);
2970         ofpbuf_put(packet, pin->packet, send_len);
2971
2972         opi = packet->l3;
2973         opi->pi.buffer_id = htonl(pin->buffer_id);
2974         opi->pi.total_len = htons(pin->total_len);
2975         opi->pi.reason = pin->reason;
2976         opi->pi.table_id = pin->table_id;
2977         if (protocol == OFPUTIL_P_OF13_OXM) {
2978             opi->cookie = pin->cookie;
2979         }
2980     } else if (packet_in_format == NXPIF_OPENFLOW10) {
2981         struct ofp10_packet_in *opi;
2982
2983         packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2984                                   htonl(0), send_len);
2985         opi = ofpbuf_put_zeros(packet, offsetof(struct ofp10_packet_in, data));
2986         opi->total_len = htons(pin->total_len);
2987         opi->in_port = htons(ofp_to_u16(pin->fmd.in_port));
2988         opi->reason = pin->reason;
2989         opi->buffer_id = htonl(pin->buffer_id);
2990
2991         ofpbuf_put(packet, pin->packet, send_len);
2992     } else if (packet_in_format == NXPIF_NXM) {
2993         struct nx_packet_in *npi;
2994         struct match match;
2995         size_t match_len;
2996
2997         ofputil_packet_in_to_match(pin, &match);
2998
2999         /* The final argument is just an estimate of the space required. */
3000         packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
3001                                   htonl(0), (sizeof(struct flow_metadata) * 2
3002                                              + 2 + send_len));
3003         ofpbuf_put_zeros(packet, sizeof *npi);
3004         match_len = nx_put_match(packet, &match, 0, 0);
3005         ofpbuf_put_zeros(packet, 2);
3006         ofpbuf_put(packet, pin->packet, send_len);
3007
3008         npi = packet->l3;
3009         npi->buffer_id = htonl(pin->buffer_id);
3010         npi->total_len = htons(pin->total_len);
3011         npi->reason = pin->reason;
3012         npi->table_id = pin->table_id;
3013         npi->cookie = pin->cookie;
3014         npi->match_len = htons(match_len);
3015     } else {
3016         NOT_REACHED();
3017     }
3018     ofpmsg_update_length(packet);
3019
3020     return packet;
3021 }
3022
3023 /* Returns a string form of 'reason'.  The return value is either a statically
3024  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3025  * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3026 const char *
3027 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason,
3028                                    char *reasonbuf, size_t bufsize)
3029 {
3030     switch (reason) {
3031     case OFPR_NO_MATCH:
3032         return "no_match";
3033     case OFPR_ACTION:
3034         return "action";
3035     case OFPR_INVALID_TTL:
3036         return "invalid_ttl";
3037
3038     case OFPR_N_REASONS:
3039     default:
3040         snprintf(reasonbuf, bufsize, "%d", (int) reason);
3041         return reasonbuf;
3042     }
3043 }
3044
3045 bool
3046 ofputil_packet_in_reason_from_string(const char *s,
3047                                      enum ofp_packet_in_reason *reason)
3048 {
3049     int i;
3050
3051     for (i = 0; i < OFPR_N_REASONS; i++) {
3052         char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3053         const char *reason_s;
3054
3055         reason_s = ofputil_packet_in_reason_to_string(i, reasonbuf,
3056                                                       sizeof reasonbuf);
3057         if (!strcasecmp(s, reason_s)) {
3058             *reason = i;
3059             return true;
3060         }
3061     }
3062     return false;
3063 }
3064
3065 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3066  * 'po'.
3067  *
3068  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3069  * message's actions.  The caller must initialize 'ofpacts' and retains
3070  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
3071  *
3072  * Returns 0 if successful, otherwise an OFPERR_* value. */
3073 enum ofperr
3074 ofputil_decode_packet_out(struct ofputil_packet_out *po,
3075                           const struct ofp_header *oh,
3076                           struct ofpbuf *ofpacts)
3077 {
3078     enum ofpraw raw;
3079     struct ofpbuf b;
3080
3081     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3082     raw = ofpraw_pull_assert(&b);
3083
3084     if (raw == OFPRAW_OFPT11_PACKET_OUT) {
3085         enum ofperr error;
3086         const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3087
3088         po->buffer_id = ntohl(opo->buffer_id);
3089         error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
3090         if (error) {
3091             return error;
3092         }
3093
3094         error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
3095                                                 ofpacts);
3096         if (error) {
3097             return error;
3098         }
3099     } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
3100         enum ofperr error;
3101         const struct ofp10_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
3102
3103         po->buffer_id = ntohl(opo->buffer_id);
3104         po->in_port = u16_to_ofp(ntohs(opo->in_port));
3105
3106         error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
3107         if (error) {
3108             return error;
3109         }
3110     } else {
3111         NOT_REACHED();
3112     }
3113
3114     if (ofp_to_u16(po->in_port) >= ofp_to_u16(OFPP_MAX)
3115         && po->in_port != OFPP_LOCAL
3116         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
3117         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
3118                      po->in_port);
3119         return OFPERR_OFPBRC_BAD_PORT;
3120     }
3121
3122     po->ofpacts = ofpacts->data;
3123     po->ofpacts_len = ofpacts->size;
3124
3125     if (po->buffer_id == UINT32_MAX) {
3126         po->packet = b.data;
3127         po->packet_len = b.size;
3128     } else {
3129         po->packet = NULL;
3130         po->packet_len = 0;
3131     }
3132
3133     return 0;
3134 }
3135 \f
3136 /* ofputil_phy_port */
3137
3138 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3139 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
3140 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
3141 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
3142 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
3143 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
3144 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
3145 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
3146
3147 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3148 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
3149 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
3150 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
3151 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
3152 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
3153
3154 static enum netdev_features
3155 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
3156 {
3157     uint32_t ofp10 = ntohl(ofp10_);
3158     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
3159 }
3160
3161 static ovs_be32
3162 netdev_port_features_to_ofp10(enum netdev_features features)
3163 {
3164     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
3165 }
3166
3167 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
3168 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
3169 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
3170 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
3171 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
3172 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
3173 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
3174 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
3175 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
3176 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
3177 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
3178 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
3179 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
3180 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
3181 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
3182 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
3183
3184 static enum netdev_features
3185 netdev_port_features_from_ofp11(ovs_be32 ofp11)
3186 {
3187     return ntohl(ofp11) & 0xffff;
3188 }
3189
3190 static ovs_be32
3191 netdev_port_features_to_ofp11(enum netdev_features features)
3192 {
3193     return htonl(features & 0xffff);
3194 }
3195
3196 static enum ofperr
3197 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
3198                               const struct ofp10_phy_port *opp)
3199 {
3200     memset(pp, 0, sizeof *pp);
3201
3202     pp->port_no = u16_to_ofp(ntohs(opp->port_no));
3203     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
3204     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
3205
3206     pp->config = ntohl(opp->config) & OFPPC10_ALL;
3207     pp->state = ntohl(opp->state) & OFPPS10_ALL;
3208
3209     pp->curr = netdev_port_features_from_ofp10(opp->curr);
3210     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
3211     pp->supported = netdev_port_features_from_ofp10(opp->supported);
3212     pp->peer = netdev_port_features_from_ofp10(opp->peer);
3213
3214     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
3215     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
3216
3217     return 0;
3218 }
3219
3220 static enum ofperr
3221 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
3222                           const struct ofp11_port *op)
3223 {
3224     enum ofperr error;
3225
3226     memset(pp, 0, sizeof *pp);
3227
3228     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
3229     if (error) {
3230         return error;
3231     }
3232     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
3233     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
3234
3235     pp->config = ntohl(op->config) & OFPPC11_ALL;
3236     pp->state = ntohl(op->state) & OFPPC11_ALL;
3237
3238     pp->curr = netdev_port_features_from_ofp11(op->curr);
3239     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
3240     pp->supported = netdev_port_features_from_ofp11(op->supported);
3241     pp->peer = netdev_port_features_from_ofp11(op->peer);
3242
3243     pp->curr_speed = ntohl(op->curr_speed);
3244     pp->max_speed = ntohl(op->max_speed);
3245
3246     return 0;
3247 }
3248
3249 static size_t
3250 ofputil_get_phy_port_size(enum ofp_version ofp_version)
3251 {
3252     switch (ofp_version) {
3253     case OFP10_VERSION:
3254         return sizeof(struct ofp10_phy_port);
3255     case OFP11_VERSION:
3256     case OFP12_VERSION:
3257     case OFP13_VERSION:
3258         return sizeof(struct ofp11_port);
3259     default:
3260         NOT_REACHED();
3261     }
3262 }
3263
3264 static void
3265 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
3266                               struct ofp10_phy_port *opp)
3267 {
3268     memset(opp, 0, sizeof *opp);
3269
3270     opp->port_no = htons(ofp_to_u16(pp->port_no));
3271     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3272     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3273
3274     opp->config = htonl(pp->config & OFPPC10_ALL);
3275     opp->state = htonl(pp->state & OFPPS10_ALL);
3276
3277     opp->curr = netdev_port_features_to_ofp10(pp->curr);
3278     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
3279     opp->supported = netdev_port_features_to_ofp10(pp->supported);
3280     opp->peer = netdev_port_features_to_ofp10(pp->peer);
3281 }
3282
3283 static void
3284 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
3285                           struct ofp11_port *op)
3286 {
3287     memset(op, 0, sizeof *op);
3288
3289     op->port_no = ofputil_port_to_ofp11(pp->port_no);
3290     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
3291     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
3292
3293     op->config = htonl(pp->config & OFPPC11_ALL);
3294     op->state = htonl(pp->state & OFPPS11_ALL);
3295
3296     op->curr = netdev_port_features_to_ofp11(pp->curr);
3297     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
3298     op->supported = netdev_port_features_to_ofp11(pp->supported);
3299     op->peer = netdev_port_features_to_ofp11(pp->peer);
3300
3301     op->curr_speed = htonl(pp->curr_speed);
3302     op->max_speed = htonl(pp->max_speed);
3303 }
3304
3305 static void
3306 ofputil_put_phy_port(enum ofp_version ofp_version,
3307                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
3308 {
3309     switch (ofp_version) {
3310     case OFP10_VERSION: {
3311         struct ofp10_phy_port *opp;
3312         if (b->size + sizeof *opp <= UINT16_MAX) {
3313             opp = ofpbuf_put_uninit(b, sizeof *opp);
3314             ofputil_encode_ofp10_phy_port(pp, opp);
3315         }
3316         break;
3317     }
3318
3319     case OFP11_VERSION:
3320     case OFP12_VERSION:
3321     case OFP13_VERSION: {
3322         struct ofp11_port *op;
3323         if (b->size + sizeof *op <= UINT16_MAX) {
3324             op = ofpbuf_put_uninit(b, sizeof *op);
3325             ofputil_encode_ofp11_port(pp, op);
3326         }
3327         break;
3328     }
3329
3330     default:
3331         NOT_REACHED();
3332     }
3333 }
3334
3335 void
3336 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
3337                                      const struct ofputil_phy_port *pp,
3338                                      struct list *replies)
3339 {
3340     switch (ofp_version) {
3341     case OFP10_VERSION: {
3342         struct ofp10_phy_port *opp;
3343
3344         opp = ofpmp_append(replies, sizeof *opp);
3345         ofputil_encode_ofp10_phy_port(pp, opp);
3346         break;
3347     }
3348
3349     case OFP11_VERSION:
3350     case OFP12_VERSION:
3351     case OFP13_VERSION: {
3352         struct ofp11_port *op;
3353
3354         op = ofpmp_append(replies, sizeof *op);
3355         ofputil_encode_ofp11_port(pp, op);
3356         break;
3357     }
3358
3359     default:
3360       NOT_REACHED();
3361     }
3362 }
3363 \f
3364 /* ofputil_switch_features */
3365
3366 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3367                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
3368 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
3369 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
3370 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
3371 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
3372 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
3373 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
3374
3375 struct ofputil_action_bit_translation {
3376     enum ofputil_action_bitmap ofputil_bit;
3377     int of_bit;
3378 };
3379
3380 static const struct ofputil_action_bit_translation of10_action_bits[] = {
3381     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
3382     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
3383     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
3384     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
3385     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
3386     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
3387     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
3388     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
3389     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
3390     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
3391     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
3392     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
3393     { 0, 0 },
3394 };
3395
3396 static enum ofputil_action_bitmap
3397 decode_action_bits(ovs_be32 of_actions,
3398                    const struct ofputil_action_bit_translation *x)
3399 {
3400     enum ofputil_action_bitmap ofputil_actions;
3401
3402     ofputil_actions = 0;
3403     for (; x->ofputil_bit; x++) {
3404         if (of_actions & htonl(1u << x->of_bit)) {
3405             ofputil_actions |= x->ofputil_bit;
3406         }
3407     }
3408     return ofputil_actions;
3409 }
3410
3411 static uint32_t
3412 ofputil_capabilities_mask(enum ofp_version ofp_version)
3413 {
3414     /* Handle capabilities whose bit is unique for all Open Flow versions */
3415     switch (ofp_version) {
3416     case OFP10_VERSION:
3417     case OFP11_VERSION:
3418         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
3419     case OFP12_VERSION:
3420     case OFP13_VERSION:
3421         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
3422     default:
3423         /* Caller needs to check osf->header.version itself */
3424         return 0;
3425     }
3426 }
3427
3428 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
3429  * abstract representation in '*features'.  Initializes '*b' to iterate over
3430  * the OpenFlow port structures following 'osf' with later calls to
3431  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
3432  * OFPERR_* value.  */
3433 enum ofperr
3434 ofputil_decode_switch_features(const struct ofp_header *oh,
3435                                struct ofputil_switch_features *features,
3436                                struct ofpbuf *b)
3437 {
3438     const struct ofp_switch_features *osf;
3439     enum ofpraw raw;
3440
3441     ofpbuf_use_const(b, oh, ntohs(oh->length));
3442     raw = ofpraw_pull_assert(b);
3443
3444     osf = ofpbuf_pull(b, sizeof *osf);
3445     features->datapath_id = ntohll(osf->datapath_id);
3446     features->n_buffers = ntohl(osf->n_buffers);
3447     features->n_tables = osf->n_tables;
3448     features->auxiliary_id = 0;
3449
3450     features->capabilities = ntohl(osf->capabilities) &
3451         ofputil_capabilities_mask(oh->version);
3452
3453     if (b->size % ofputil_get_phy_port_size(oh->version)) {
3454         return OFPERR_OFPBRC_BAD_LEN;
3455     }
3456
3457     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
3458         if (osf->capabilities & htonl(OFPC10_STP)) {
3459             features->capabilities |= OFPUTIL_C_STP;
3460         }
3461         features->actions = decode_action_bits(osf->actions, of10_action_bits);
3462     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY
3463                || raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3464         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
3465             features->capabilities |= OFPUTIL_C_GROUP_STATS;
3466         }
3467         features->actions = 0;
3468         if (raw == OFPRAW_OFPT13_FEATURES_REPLY) {
3469             features->auxiliary_id = osf->auxiliary_id;
3470         }
3471     } else {
3472         return OFPERR_OFPBRC_BAD_VERSION;
3473     }
3474
3475     return 0;
3476 }
3477
3478 /* Returns true if the maximum number of ports are in 'oh'. */
3479 static bool
3480 max_ports_in_features(const struct ofp_header *oh)
3481 {
3482     size_t pp_size = ofputil_get_phy_port_size(oh->version);
3483     return ntohs(oh->length) + pp_size > UINT16_MAX;
3484 }
3485
3486 /* Given a buffer 'b' that contains a Features Reply message, checks if
3487  * it contains the maximum number of ports that will fit.  If so, it
3488  * returns true and removes the ports from the message.  The caller
3489  * should then send an OFPST_PORT_DESC stats request to get the ports,
3490  * since the switch may have more ports than could be represented in the
3491  * Features Reply.  Otherwise, returns false.
3492  */
3493 bool
3494 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
3495 {
3496     struct ofp_header *oh = b->data;
3497
3498     if (max_ports_in_features(oh)) {
3499         /* Remove all the ports. */
3500         b->size = (sizeof(struct ofp_header)
3501                    + sizeof(struct ofp_switch_features));
3502         ofpmsg_update_length(b);
3503
3504         return true;
3505     }
3506
3507     return false;
3508 }
3509
3510 static ovs_be32
3511 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
3512                    const struct ofputil_action_bit_translation *x)
3513 {
3514     uint32_t of_actions;
3515
3516     of_actions = 0;
3517     for (; x->ofputil_bit; x++) {
3518         if (ofputil_actions & x->ofputil_bit) {
3519             of_actions |= 1 << x->of_bit;
3520         }
3521     }
3522     return htonl(of_actions);
3523 }
3524
3525 /* Returns a buffer owned by the caller that encodes 'features' in the format
3526  * required by 'protocol' with the given 'xid'.  The caller should append port
3527  * information to the buffer with subsequent calls to
3528  * ofputil_put_switch_features_port(). */
3529 struct ofpbuf *
3530 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
3531                                enum ofputil_protocol protocol, ovs_be32 xid)
3532 {
3533     struct ofp_switch_features *osf;
3534     struct ofpbuf *b;
3535     enum ofp_version version;
3536     enum ofpraw raw;
3537
3538     version = ofputil_protocol_to_ofp_version(protocol);
3539     switch (version) {
3540     case OFP10_VERSION:
3541         raw = OFPRAW_OFPT10_FEATURES_REPLY;
3542         break;
3543     case OFP11_VERSION:
3544     case OFP12_VERSION:
3545         raw = OFPRAW_OFPT11_FEATURES_REPLY;
3546         break;
3547     case OFP13_VERSION:
3548         raw = OFPRAW_OFPT13_FEATURES_REPLY;
3549         break;
3550     default:
3551         NOT_REACHED();
3552     }
3553     b = ofpraw_alloc_xid(raw, version, xid, 0);
3554     osf = ofpbuf_put_zeros(b, sizeof *osf);
3555     osf->datapath_id = htonll(features->datapath_id);
3556     osf->n_buffers = htonl(features->n_buffers);
3557     osf->n_tables = features->n_tables;
3558
3559     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
3560     osf->capabilities = htonl(features->capabilities &
3561                               ofputil_capabilities_mask(version));
3562     switch (version) {
3563     case OFP10_VERSION:
3564         if (features->capabilities & OFPUTIL_C_STP) {
3565             osf->capabilities |= htonl(OFPC10_STP);
3566         }
3567         osf->actions = encode_action_bits(features->actions, of10_action_bits);
3568         break;
3569     case OFP13_VERSION:
3570         osf->auxiliary_id = features->auxiliary_id;
3571         /* fall through */
3572     case OFP11_VERSION:
3573     case OFP12_VERSION:
3574         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
3575             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
3576         }
3577         break;
3578     default:
3579         NOT_REACHED();
3580     }
3581
3582     return b;
3583 }
3584
3585 /* Encodes 'pp' into the format required by the switch_features message already
3586  * in 'b', which should have been returned by ofputil_encode_switch_features(),
3587  * and appends the encoded version to 'b'. */
3588 void
3589 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3590                                  struct ofpbuf *b)
3591 {
3592     const struct ofp_header *oh = b->data;
3593
3594     if (oh->version < OFP13_VERSION) {
3595         ofputil_put_phy_port(oh->version, pp, b);
3596     }
3597 }
3598 \f
3599 /* ofputil_port_status */
3600
3601 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3602  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3603 enum ofperr
3604 ofputil_decode_port_status(const struct ofp_header *oh,
3605                            struct ofputil_port_status *ps)
3606 {
3607     const struct ofp_port_status *ops;
3608     struct ofpbuf b;
3609     int retval;
3610
3611     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3612     ofpraw_pull_assert(&b);
3613     ops = ofpbuf_pull(&b, sizeof *ops);
3614
3615     if (ops->reason != OFPPR_ADD &&
3616         ops->reason != OFPPR_DELETE &&
3617         ops->reason != OFPPR_MODIFY) {
3618         return OFPERR_NXBRC_BAD_REASON;
3619     }
3620     ps->reason = ops->reason;
3621
3622     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3623     ovs_assert(retval != EOF);
3624     return retval;
3625 }
3626
3627 /* Converts the abstract form of a "port status" message in '*ps' into an
3628  * OpenFlow message suitable for 'protocol', and returns that encoded form in
3629  * a buffer owned by the caller. */
3630 struct ofpbuf *
3631 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3632                            enum ofputil_protocol protocol)
3633 {
3634     struct ofp_port_status *ops;
3635     struct ofpbuf *b;
3636     enum ofp_version version;
3637     enum ofpraw raw;
3638
3639     version = ofputil_protocol_to_ofp_version(protocol);
3640     switch (version) {
3641     case OFP10_VERSION:
3642         raw = OFPRAW_OFPT10_PORT_STATUS;
3643         break;
3644
3645     case OFP11_VERSION:
3646     case OFP12_VERSION:
3647     case OFP13_VERSION:
3648         raw = OFPRAW_OFPT11_PORT_STATUS;
3649         break;
3650
3651     default:
3652         NOT_REACHED();
3653     }
3654
3655     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3656     ops = ofpbuf_put_zeros(b, sizeof *ops);
3657     ops->reason = ps->reason;
3658     ofputil_put_phy_port(version, &ps->desc, b);
3659     ofpmsg_update_length(b);
3660     return b;
3661 }
3662 \f
3663 /* ofputil_port_mod */
3664
3665 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3666  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3667 enum ofperr
3668 ofputil_decode_port_mod(const struct ofp_header *oh,
3669                         struct ofputil_port_mod *pm)
3670 {
3671     enum ofpraw raw;
3672     struct ofpbuf b;
3673
3674     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3675     raw = ofpraw_pull_assert(&b);
3676
3677     if (raw == OFPRAW_OFPT10_PORT_MOD) {
3678         const struct ofp10_port_mod *opm = b.data;
3679
3680         pm->port_no = u16_to_ofp(ntohs(opm->port_no));
3681         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3682         pm->config = ntohl(opm->config) & OFPPC10_ALL;
3683         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3684         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3685     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3686         const struct ofp11_port_mod *opm = b.data;
3687         enum ofperr error;
3688
3689         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3690         if (error) {
3691             return error;
3692         }
3693
3694         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3695         pm->config = ntohl(opm->config) & OFPPC11_ALL;
3696         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3697         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3698     } else {
3699         return OFPERR_OFPBRC_BAD_TYPE;
3700     }
3701
3702     pm->config &= pm->mask;
3703     return 0;
3704 }
3705
3706 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3707  * message suitable for 'protocol', and returns that encoded form in a buffer
3708  * owned by the caller. */
3709 struct ofpbuf *
3710 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3711                         enum ofputil_protocol protocol)
3712 {
3713     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3714     struct ofpbuf *b;
3715
3716     switch (ofp_version) {
3717     case OFP10_VERSION: {
3718         struct ofp10_port_mod *opm;
3719
3720         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3721         opm = ofpbuf_put_zeros(b, sizeof *opm);
3722         opm->port_no = htons(ofp_to_u16(pm->port_no));
3723         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3724         opm->config = htonl(pm->config & OFPPC10_ALL);
3725         opm->mask = htonl(pm->mask & OFPPC10_ALL);
3726         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3727         break;
3728     }
3729
3730     case OFP11_VERSION:
3731     case OFP12_VERSION:
3732     case OFP13_VERSION: {
3733         struct ofp11_port_mod *opm;
3734
3735         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3736         opm = ofpbuf_put_zeros(b, sizeof *opm);
3737         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3738         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3739         opm->config = htonl(pm->config & OFPPC11_ALL);
3740         opm->mask = htonl(pm->mask & OFPPC11_ALL);
3741         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3742         break;
3743     }
3744
3745     default:
3746         NOT_REACHED();
3747     }
3748
3749     return b;
3750 }
3751 \f
3752 /* ofputil_role_request */
3753
3754 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
3755  * an abstract form in '*rr'.  Returns 0 if successful, otherwise an
3756  * OFPERR_* value. */
3757 enum ofperr
3758 ofputil_decode_role_message(const struct ofp_header *oh,
3759                             struct ofputil_role_request *rr)
3760 {
3761     struct ofpbuf b;
3762     enum ofpraw raw;
3763
3764     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3765     raw = ofpraw_pull_assert(&b);
3766
3767     if (raw == OFPRAW_OFPT12_ROLE_REQUEST ||
3768         raw == OFPRAW_OFPT12_ROLE_REPLY) {
3769         const struct ofp12_role_request *orr = b.l3;
3770
3771         if (orr->role != htonl(OFPCR12_ROLE_NOCHANGE) &&
3772             orr->role != htonl(OFPCR12_ROLE_EQUAL) &&
3773             orr->role != htonl(OFPCR12_ROLE_MASTER) &&
3774             orr->role != htonl(OFPCR12_ROLE_SLAVE)) {
3775             return OFPERR_OFPRRFC_BAD_ROLE;
3776         }
3777
3778         rr->role = ntohl(orr->role);
3779         if (raw == OFPRAW_OFPT12_ROLE_REQUEST
3780             ? orr->role == htonl(OFPCR12_ROLE_NOCHANGE)
3781             : orr->generation_id == htonll(UINT64_MAX)) {
3782             rr->have_generation_id = false;
3783             rr->generation_id = 0;
3784         } else {
3785             rr->have_generation_id = true;
3786             rr->generation_id = ntohll(orr->generation_id);
3787         }
3788     } else if (raw == OFPRAW_NXT_ROLE_REQUEST ||
3789                raw == OFPRAW_NXT_ROLE_REPLY) {
3790         const struct nx_role_request *nrr = b.l3;
3791
3792         BUILD_ASSERT(NX_ROLE_OTHER + 1 == OFPCR12_ROLE_EQUAL);
3793         BUILD_ASSERT(NX_ROLE_MASTER + 1 == OFPCR12_ROLE_MASTER);
3794         BUILD_ASSERT(NX_ROLE_SLAVE + 1 == OFPCR12_ROLE_SLAVE);
3795
3796         if (nrr->role != htonl(NX_ROLE_OTHER) &&
3797             nrr->role != htonl(NX_ROLE_MASTER) &&
3798             nrr->role != htonl(NX_ROLE_SLAVE)) {
3799             return OFPERR_OFPRRFC_BAD_ROLE;
3800         }
3801
3802         rr->role = ntohl(nrr->role) + 1;
3803         rr->have_generation_id = false;
3804         rr->generation_id = 0;
3805     } else {
3806         NOT_REACHED();
3807     }
3808
3809     return 0;
3810 }
3811
3812 /* Returns an encoded form of a role reply suitable for the "request" in a
3813  * buffer owned by the caller. */
3814 struct ofpbuf *
3815 ofputil_encode_role_reply(const struct ofp_header *request,
3816                           const struct ofputil_role_request *rr)
3817 {
3818     struct ofpbuf *buf;
3819     enum ofpraw raw;
3820
3821     raw = ofpraw_decode_assert(request);
3822     if (raw == OFPRAW_OFPT12_ROLE_REQUEST) {
3823         struct ofp12_role_request *orr;
3824
3825         buf = ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY, request, 0);
3826         orr = ofpbuf_put_zeros(buf, sizeof *orr);
3827
3828         orr->role = htonl(rr->role);
3829         orr->generation_id = htonll(rr->have_generation_id
3830                                     ? rr->generation_id
3831                                     : UINT64_MAX);
3832     } else if (raw == OFPRAW_NXT_ROLE_REQUEST) {
3833         struct nx_role_request *nrr;
3834
3835         BUILD_ASSERT(NX_ROLE_OTHER == OFPCR12_ROLE_EQUAL - 1);
3836         BUILD_ASSERT(NX_ROLE_MASTER == OFPCR12_ROLE_MASTER - 1);
3837         BUILD_ASSERT(NX_ROLE_SLAVE == OFPCR12_ROLE_SLAVE - 1);
3838
3839         buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, request, 0);
3840         nrr = ofpbuf_put_zeros(buf, sizeof *nrr);
3841         nrr->role = htonl(rr->role - 1);
3842     } else {
3843         NOT_REACHED();
3844     }
3845
3846     return buf;
3847 }
3848 \f
3849 /* Table stats. */
3850
3851 static void
3852 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3853                               struct ofpbuf *buf)
3854 {
3855     struct wc_map {
3856         enum ofp10_flow_wildcards wc10;
3857         enum oxm12_ofb_match_fields mf12;
3858     };
3859
3860     static const struct wc_map wc_map[] = {
3861         { OFPFW10_IN_PORT,     OFPXMT12_OFB_IN_PORT },
3862         { OFPFW10_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
3863         { OFPFW10_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
3864         { OFPFW10_DL_DST,      OFPXMT12_OFB_ETH_DST},
3865         { OFPFW10_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
3866         { OFPFW10_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
3867         { OFPFW10_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
3868         { OFPFW10_TP_DST,      OFPXMT12_OFB_TCP_DST },
3869         { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3870         { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3871         { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3872         { OFPFW10_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
3873     };
3874
3875     struct ofp10_table_stats *out;
3876     const struct wc_map *p;
3877
3878     out = ofpbuf_put_zeros(buf, sizeof *out);
3879     out->table_id = in->table_id;
3880     ovs_strlcpy(out->name, in->name, sizeof out->name);
3881     out->wildcards = 0;
3882     for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3883         if (in->wildcards & htonll(1ULL << p->mf12)) {
3884             out->wildcards |= htonl(p->wc10);
3885         }
3886     }
3887     out->max_entries = in->max_entries;
3888     out->active_count = in->active_count;
3889     put_32aligned_be64(&out->lookup_count, in->lookup_count);
3890     put_32aligned_be64(&out->matched_count, in->matched_count);
3891 }
3892
3893 static ovs_be32
3894 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
3895 {
3896     struct map {
3897         enum ofp11_flow_match_fields fmf11;
3898         enum oxm12_ofb_match_fields mf12;
3899     };
3900
3901     static const struct map map[] = {
3902         { OFPFMF11_IN_PORT,     OFPXMT12_OFB_IN_PORT },
3903         { OFPFMF11_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
3904         { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3905         { OFPFMF11_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
3906         { OFPFMF11_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
3907         { OFPFMF11_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
3908         { OFPFMF11_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
3909         { OFPFMF11_TP_DST,      OFPXMT12_OFB_TCP_DST },
3910         { OFPFMF11_MPLS_LABEL,  OFPXMT12_OFB_MPLS_LABEL },
3911         { OFPFMF11_MPLS_TC,     OFPXMT12_OFB_MPLS_TC },
3912         /* I don't know what OFPFMF11_TYPE means. */
3913         { OFPFMF11_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
3914         { OFPFMF11_DL_DST,      OFPXMT12_OFB_ETH_DST },
3915         { OFPFMF11_NW_SRC,      OFPXMT12_OFB_IPV4_SRC },
3916         { OFPFMF11_NW_DST,      OFPXMT12_OFB_IPV4_DST },
3917         { OFPFMF11_METADATA,    OFPXMT12_OFB_METADATA },
3918     };
3919
3920     const struct map *p;
3921     uint32_t fmf11;
3922
3923     fmf11 = 0;
3924     for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3925         if (oxm12 & htonll(1ULL << p->mf12)) {
3926             fmf11 |= p->fmf11;
3927         }
3928     }
3929     return htonl(fmf11);
3930 }
3931
3932 static void
3933 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3934                               struct ofpbuf *buf)
3935 {
3936     struct ofp11_table_stats *out;
3937
3938     out = ofpbuf_put_zeros(buf, sizeof *out);
3939     out->table_id = in->table_id;
3940     ovs_strlcpy(out->name, in->name, sizeof out->name);
3941     out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3942     out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3943     out->instructions = in->instructions;
3944     out->write_actions = in->write_actions;
3945     out->apply_actions = in->apply_actions;
3946     out->config = in->config;
3947     out->max_entries = in->max_entries;
3948     out->active_count = in->active_count;
3949     out->lookup_count = in->lookup_count;
3950     out->matched_count = in->matched_count;
3951 }
3952
3953 static void
3954 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats *in,
3955                               struct ofpbuf *buf)
3956 {
3957     struct ofp13_table_stats *out;
3958
3959     /* OF 1.3 splits table features off the ofp_table_stats,
3960      * so there is not much here. */
3961
3962     out = ofpbuf_put_uninit(buf, sizeof *out);
3963     out->table_id = in->table_id;
3964     out->active_count = in->active_count;
3965     out->lookup_count = in->lookup_count;
3966     out->matched_count = in->matched_count;
3967 }
3968
3969 struct ofpbuf *
3970 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3971                                  const struct ofp_header *request)
3972 {
3973     struct ofpbuf *reply;
3974     int i;
3975
3976     reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3977
3978     switch ((enum ofp_version) request->version) {
3979     case OFP10_VERSION:
3980         for (i = 0; i < n; i++) {
3981             ofputil_put_ofp10_table_stats(&stats[i], reply);
3982         }
3983         break;
3984
3985     case OFP11_VERSION:
3986         for (i = 0; i < n; i++) {
3987             ofputil_put_ofp11_table_stats(&stats[i], reply);
3988         }
3989         break;
3990
3991     case OFP12_VERSION:
3992         ofpbuf_put(reply, stats, n * sizeof *stats);
3993         break;
3994
3995     case OFP13_VERSION:
3996         for (i = 0; i < n; i++) {
3997             ofputil_put_ofp13_table_stats(&stats[i], reply);
3998         }
3999         break;
4000
4001     default:
4002         NOT_REACHED();
4003     }
4004
4005     return reply;
4006 }
4007 \f
4008 /* ofputil_flow_monitor_request */
4009
4010 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
4011  * ofputil_flow_monitor_request in 'rq'.
4012  *
4013  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
4014  * message.  Calling this function multiple times for a single 'msg' iterates
4015  * through the requests.  The caller must initially leave 'msg''s layer
4016  * pointers null and not modify them between calls.
4017  *
4018  * Returns 0 if successful, EOF if no requests were left in this 'msg',
4019  * otherwise an OFPERR_* value. */
4020 int
4021 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
4022                                     struct ofpbuf *msg)
4023 {
4024     struct nx_flow_monitor_request *nfmr;
4025     uint16_t flags;
4026
4027     if (!msg->l2) {
4028         msg->l2 = msg->data;
4029         ofpraw_pull_assert(msg);
4030     }
4031
4032     if (!msg->size) {
4033         return EOF;
4034     }
4035
4036     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
4037     if (!nfmr) {
4038         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
4039                      "leftover bytes at end", msg->size);
4040         return OFPERR_OFPBRC_BAD_LEN;
4041     }
4042
4043     flags = ntohs(nfmr->flags);
4044     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
4045         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
4046                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
4047         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
4048                      flags);
4049         return OFPERR_NXBRC_FM_BAD_FLAGS;
4050     }
4051
4052     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
4053         return OFPERR_NXBRC_MUST_BE_ZERO;
4054     }
4055
4056     rq->id = ntohl(nfmr->id);
4057     rq->flags = flags;
4058     rq->out_port = u16_to_ofp(ntohs(nfmr->out_port));
4059     rq->table_id = nfmr->table_id;
4060
4061     return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
4062 }
4063
4064 void
4065 ofputil_append_flow_monitor_request(
4066     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
4067 {
4068     struct nx_flow_monitor_request *nfmr;
4069     size_t start_ofs;
4070     int match_len;
4071
4072     if (!msg->size) {
4073         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
4074     }
4075
4076     start_ofs = msg->size;
4077     ofpbuf_put_zeros(msg, sizeof *nfmr);
4078     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
4079
4080     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
4081     nfmr->id = htonl(rq->id);
4082     nfmr->flags = htons(rq->flags);
4083     nfmr->out_port = htons(ofp_to_u16(rq->out_port));
4084     nfmr->match_len = htons(match_len);
4085     nfmr->table_id = rq->table_id;
4086 }
4087
4088 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
4089  * into an abstract ofputil_flow_update in 'update'.  The caller must have
4090  * initialized update->match to point to space allocated for a match.
4091  *
4092  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
4093  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
4094  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
4095  * will point into the 'ofpacts' buffer.
4096  *
4097  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
4098  * this function multiple times for a single 'msg' iterates through the
4099  * updates.  The caller must initially leave 'msg''s layer pointers null and
4100  * not modify them between calls.
4101  *
4102  * Returns 0 if successful, EOF if no updates were left in this 'msg',
4103  * otherwise an OFPERR_* value. */
4104 int
4105 ofputil_decode_flow_update(struct ofputil_flow_update *update,
4106                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
4107 {
4108     struct nx_flow_update_header *nfuh;
4109     unsigned int length;
4110
4111     if (!msg->l2) {
4112         msg->l2 = msg->data;
4113         ofpraw_pull_assert(msg);
4114     }
4115
4116     if (!msg->size) {
4117         return EOF;
4118     }
4119
4120     if (msg->size < sizeof(struct nx_flow_update_header)) {
4121         goto bad_len;
4122     }
4123
4124     nfuh = msg->data;
4125     update->event = ntohs(nfuh->event);
4126     length = ntohs(nfuh->length);
4127     if (length > msg->size || length % 8) {
4128         goto bad_len;
4129     }
4130
4131     if (update->event == NXFME_ABBREV) {
4132         struct nx_flow_update_abbrev *nfua;
4133
4134         if (length != sizeof *nfua) {
4135             goto bad_len;
4136         }
4137
4138         nfua = ofpbuf_pull(msg, sizeof *nfua);
4139         update->xid = nfua->xid;
4140         return 0;
4141     } else if (update->event == NXFME_ADDED
4142                || update->event == NXFME_DELETED
4143                || update->event == NXFME_MODIFIED) {
4144         struct nx_flow_update_full *nfuf;
4145         unsigned int actions_len;
4146         unsigned int match_len;
4147         enum ofperr error;
4148
4149         if (length < sizeof *nfuf) {
4150             goto bad_len;
4151         }
4152
4153         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
4154         match_len = ntohs(nfuf->match_len);
4155         if (sizeof *nfuf + match_len > length) {
4156             goto bad_len;
4157         }
4158
4159         update->reason = ntohs(nfuf->reason);
4160         update->idle_timeout = ntohs(nfuf->idle_timeout);
4161         update->hard_timeout = ntohs(nfuf->hard_timeout);
4162         update->table_id = nfuf->table_id;
4163         update->cookie = nfuf->cookie;
4164         update->priority = ntohs(nfuf->priority);
4165
4166         error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
4167         if (error) {
4168             return error;
4169         }
4170
4171         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
4172         error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
4173         if (error) {
4174             return error;
4175         }
4176
4177         update->ofpacts = ofpacts->data;
4178         update->ofpacts_len = ofpacts->size;
4179         return 0;
4180     } else {
4181         VLOG_WARN_RL(&bad_ofmsg_rl,
4182                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
4183                      ntohs(nfuh->event));
4184         return OFPERR_NXBRC_FM_BAD_EVENT;
4185     }
4186
4187 bad_len:
4188     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
4189                  "leftover bytes at end", msg->size);
4190     return OFPERR_OFPBRC_BAD_LEN;
4191 }
4192
4193 uint32_t
4194 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
4195 {
4196     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
4197
4198     return ntohl(cancel->id);
4199 }
4200
4201 struct ofpbuf *
4202 ofputil_encode_flow_monitor_cancel(uint32_t id)
4203 {
4204     struct nx_flow_monitor_cancel *nfmc;
4205     struct ofpbuf *msg;
4206
4207     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
4208     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
4209     nfmc->id = htonl(id);
4210     return msg;
4211 }
4212
4213 void
4214 ofputil_start_flow_update(struct list *replies)
4215 {
4216     struct ofpbuf *msg;
4217
4218     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
4219                            htonl(0), 1024);
4220
4221     list_init(replies);
4222     list_push_back(replies, &msg->list_node);
4223 }
4224
4225 void
4226 ofputil_append_flow_update(const struct ofputil_flow_update *update,
4227                            struct list *replies)
4228 {
4229     struct nx_flow_update_header *nfuh;
4230     struct ofpbuf *msg;
4231     size_t start_ofs;
4232
4233     msg = ofpbuf_from_list(list_back(replies));
4234     start_ofs = msg->size;
4235
4236     if (update->event == NXFME_ABBREV) {
4237         struct nx_flow_update_abbrev *nfua;
4238
4239         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
4240         nfua->xid = update->xid;
4241     } else {
4242         struct nx_flow_update_full *nfuf;
4243         int match_len;
4244
4245         ofpbuf_put_zeros(msg, sizeof *nfuf);
4246         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
4247         ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
4248
4249         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
4250         nfuf->reason = htons(update->reason);
4251         nfuf->priority = htons(update->priority);
4252         nfuf->idle_timeout = htons(update->idle_timeout);
4253         nfuf->hard_timeout = htons(update->hard_timeout);
4254         nfuf->match_len = htons(match_len);
4255         nfuf->table_id = update->table_id;
4256         nfuf->cookie = update->cookie;
4257     }
4258
4259     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
4260     nfuh->length = htons(msg->size - start_ofs);
4261     nfuh->event = htons(update->event);
4262
4263     ofpmp_postappend(replies, start_ofs);
4264 }
4265 \f
4266 struct ofpbuf *
4267 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
4268                           enum ofputil_protocol protocol)
4269 {
4270     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
4271     struct ofpbuf *msg;
4272     size_t size;
4273
4274     size = po->ofpacts_len;
4275     if (po->buffer_id == UINT32_MAX) {
4276         size += po->packet_len;
4277     }
4278
4279     switch (ofp_version) {
4280     case OFP10_VERSION: {
4281         struct ofp10_packet_out *opo;
4282         size_t actions_ofs;
4283
4284         msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
4285         ofpbuf_put_zeros(msg, sizeof *opo);
4286         actions_ofs = msg->size;
4287         ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
4288
4289         opo = msg->l3;
4290         opo->buffer_id = htonl(po->buffer_id);
4291         opo->in_port = htons(ofp_to_u16(po->in_port));
4292         opo->actions_len = htons(msg->size - actions_ofs);
4293         break;
4294     }
4295
4296     case OFP11_VERSION:
4297     case OFP12_VERSION:
4298     case OFP13_VERSION: {
4299         struct ofp11_packet_out *opo;
4300         size_t len;
4301
4302         msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
4303         ofpbuf_put_zeros(msg, sizeof *opo);
4304         len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
4305
4306         opo = msg->l3;
4307         opo->buffer_id = htonl(po->buffer_id);
4308         opo->in_port = ofputil_port_to_ofp11(po->in_port);
4309         opo->actions_len = htons(len);
4310         break;
4311     }
4312
4313     default:
4314         NOT_REACHED();
4315     }
4316
4317     if (po->buffer_id == UINT32_MAX) {
4318         ofpbuf_put(msg, po->packet, po->packet_len);
4319     }
4320
4321     ofpmsg_update_length(msg);
4322
4323     return msg;
4324 }
4325 \f
4326 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
4327 struct ofpbuf *
4328 make_echo_request(enum ofp_version ofp_version)
4329 {
4330     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
4331                             htonl(0), 0);
4332 }
4333
4334 /* Creates and returns an OFPT_ECHO_REPLY message matching the
4335  * OFPT_ECHO_REQUEST message in 'rq'. */
4336 struct ofpbuf *
4337 make_echo_reply(const struct ofp_header *rq)
4338 {
4339     struct ofpbuf rq_buf;
4340     struct ofpbuf *reply;
4341
4342     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
4343     ofpraw_pull_assert(&rq_buf);
4344
4345     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
4346     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
4347     return reply;
4348 }
4349
4350 struct ofpbuf *
4351 ofputil_encode_barrier_request(enum ofp_version ofp_version)
4352 {
4353     enum ofpraw type;
4354
4355     switch (ofp_version) {
4356     case OFP13_VERSION:
4357     case OFP12_VERSION:
4358     case OFP11_VERSION:
4359         type = OFPRAW_OFPT11_BARRIER_REQUEST;
4360         break;
4361
4362     case OFP10_VERSION:
4363         type = OFPRAW_OFPT10_BARRIER_REQUEST;
4364         break;
4365
4366     default:
4367         NOT_REACHED();
4368     }
4369
4370     return ofpraw_alloc(type, ofp_version, 0);
4371 }
4372
4373 const char *
4374 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
4375 {
4376     switch (flags & OFPC_FRAG_MASK) {
4377     case OFPC_FRAG_NORMAL:   return "normal";
4378     case OFPC_FRAG_DROP:     return "drop";
4379     case OFPC_FRAG_REASM:    return "reassemble";
4380     case OFPC_FRAG_NX_MATCH: return "nx-match";
4381     }
4382
4383     NOT_REACHED();
4384 }
4385
4386 bool
4387 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
4388 {
4389     if (!strcasecmp(s, "normal")) {
4390         *flags = OFPC_FRAG_NORMAL;
4391     } else if (!strcasecmp(s, "drop")) {
4392         *flags = OFPC_FRAG_DROP;
4393     } else if (!strcasecmp(s, "reassemble")) {
4394         *flags = OFPC_FRAG_REASM;
4395     } else if (!strcasecmp(s, "nx-match")) {
4396         *flags = OFPC_FRAG_NX_MATCH;
4397     } else {
4398         return false;
4399     }
4400     return true;
4401 }
4402
4403 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
4404  * port number and stores the latter in '*ofp10_port', for the purpose of
4405  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
4406  * otherwise an OFPERR_* number.  On error, stores OFPP_NONE in '*ofp10_port'.
4407  *
4408  * See the definition of OFP11_MAX for an explanation of the mapping. */
4409 enum ofperr
4410 ofputil_port_from_ofp11(ovs_be32 ofp11_port, ofp_port_t *ofp10_port)
4411 {
4412     uint32_t ofp11_port_h = ntohl(ofp11_port);
4413
4414     if (ofp11_port_h < ofp_to_u16(OFPP_MAX)) {
4415         *ofp10_port = u16_to_ofp(ofp11_port_h);
4416         return 0;
4417     } else if (ofp11_port_h >= ofp11_to_u32(OFPP11_MAX)) {
4418         *ofp10_port = u16_to_ofp(ofp11_port_h - OFPP11_OFFSET);
4419         return 0;
4420     } else {
4421         *ofp10_port = OFPP_NONE;
4422         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
4423                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
4424                      ofp11_port_h, ofp_to_u16(OFPP_MAX) - 1,
4425                      ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4426         return OFPERR_OFPBAC_BAD_OUT_PORT;
4427     }
4428 }
4429
4430 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
4431  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
4432  *
4433  * See the definition of OFP11_MAX for an explanation of the mapping. */
4434 ovs_be32
4435 ofputil_port_to_ofp11(ofp_port_t ofp10_port)
4436 {
4437     return htonl(ofp_to_u16(ofp10_port) < ofp_to_u16(OFPP_MAX)
4438                  ? ofp_to_u16(ofp10_port)
4439                  : ofp_to_u16(ofp10_port) + OFPP11_OFFSET);
4440 }
4441
4442 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
4443  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
4444  * 'port' is valid, otherwise an OpenFlow return code. */
4445 enum ofperr
4446 ofputil_check_output_port(ofp_port_t port, ofp_port_t max_ports)
4447 {
4448     switch (port) {
4449     case OFPP_IN_PORT:
4450     case OFPP_TABLE:
4451     case OFPP_NORMAL:
4452     case OFPP_FLOOD:
4453     case OFPP_ALL:
4454     case OFPP_CONTROLLER:
4455     case OFPP_NONE:
4456     case OFPP_LOCAL:
4457         return 0;
4458
4459     default:
4460         if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
4461             return 0;
4462         }
4463         return OFPERR_OFPBAC_BAD_OUT_PORT;
4464     }
4465 }
4466
4467 #define OFPUTIL_NAMED_PORTS                     \
4468         OFPUTIL_NAMED_PORT(IN_PORT)             \
4469         OFPUTIL_NAMED_PORT(TABLE)               \
4470         OFPUTIL_NAMED_PORT(NORMAL)              \
4471         OFPUTIL_NAMED_PORT(FLOOD)               \
4472         OFPUTIL_NAMED_PORT(ALL)                 \
4473         OFPUTIL_NAMED_PORT(CONTROLLER)          \
4474         OFPUTIL_NAMED_PORT(LOCAL)               \
4475         OFPUTIL_NAMED_PORT(ANY)
4476
4477 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
4478 #define OFPUTIL_NAMED_PORTS_WITH_NONE           \
4479         OFPUTIL_NAMED_PORTS                     \
4480         OFPUTIL_NAMED_PORT(NONE)
4481
4482 /* Stores the port number represented by 's' into '*portp'.  's' may be an
4483  * integer or, for reserved ports, the standard OpenFlow name for the port
4484  * (e.g. "LOCAL").
4485  *
4486  * Returns true if successful, false if 's' is not a valid OpenFlow port number
4487  * or name.  The caller should issue an error message in this case, because
4488  * this function usually does not.  (This gives the caller an opportunity to
4489  * look up the port name another way, e.g. by contacting the switch and listing
4490  * the names of all its ports).
4491  *
4492  * This function accepts OpenFlow 1.0 port numbers.  It also accepts a subset
4493  * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
4494  * range as described in include/openflow/openflow-1.1.h. */
4495 bool
4496 ofputil_port_from_string(const char *s, ofp_port_t *portp)
4497 {
4498     uint32_t port32;
4499
4500     *portp = 0;
4501     if (str_to_uint(s, 10, &port32)) {
4502         if (port32 < ofp_to_u16(OFPP_MAX)) {
4503             /* Pass. */
4504         } else if (port32 < ofp_to_u16(OFPP_FIRST_RESV)) {
4505             VLOG_WARN("port %u is a reserved OF1.0 port number that will "
4506                       "be translated to %u when talking to an OF1.1 or "
4507                       "later controller", port32, port32 + OFPP11_OFFSET);
4508         } else if (port32 <= ofp_to_u16(OFPP_LAST_RESV)) {
4509             char name[OFP_MAX_PORT_NAME_LEN];
4510
4511             ofputil_port_to_string(u16_to_ofp(port32), name, sizeof name);
4512             VLOG_WARN_ONCE("referring to port %s as %"PRIu32" is deprecated "
4513                            "for compatibility with OpenFlow 1.1 and later",
4514                            name, port32);
4515         } else if (port32 < ofp11_to_u32(OFPP11_MAX)) {
4516             VLOG_WARN("port %u is outside the supported range 0 through "
4517                       "%"PRIx16" or 0x%x through 0x%"PRIx32, port32,
4518                       UINT16_MAX, ofp11_to_u32(OFPP11_MAX), UINT32_MAX);
4519             return false;
4520         } else {
4521             port32 -= OFPP11_OFFSET;
4522         }
4523
4524         *portp = u16_to_ofp(port32);
4525         return true;
4526     } else {
4527         struct pair {
4528             const char *name;
4529             ofp_port_t value;
4530         };
4531         static const struct pair pairs[] = {
4532 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
4533             OFPUTIL_NAMED_PORTS_WITH_NONE
4534 #undef OFPUTIL_NAMED_PORT
4535         };
4536         const struct pair *p;
4537
4538         for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
4539             if (!strcasecmp(s, p->name)) {
4540                 *portp = p->value;
4541                 return true;
4542             }
4543         }
4544         return false;
4545     }
4546 }
4547
4548 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
4549  * Most ports' string representation is just the port number, but for special
4550  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
4551 void
4552 ofputil_format_port(ofp_port_t port, struct ds *s)
4553 {
4554     char name[OFP_MAX_PORT_NAME_LEN];
4555
4556     ofputil_port_to_string(port, name, sizeof name);
4557     ds_put_cstr(s, name);
4558 }
4559
4560 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
4561  * representation of OpenFlow port number 'port'.  Most ports are represented
4562  * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
4563  * by name, e.g. "LOCAL". */
4564 void
4565 ofputil_port_to_string(ofp_port_t port,
4566                        char namebuf[OFP_MAX_PORT_NAME_LEN], size_t bufsize)
4567 {
4568     switch (port) {
4569 #define OFPUTIL_NAMED_PORT(NAME)                        \
4570         case OFPP_##NAME:                               \
4571             ovs_strlcpy(namebuf, #NAME, bufsize);       \
4572             break;
4573         OFPUTIL_NAMED_PORTS
4574 #undef OFPUTIL_NAMED_PORT
4575
4576     default:
4577         snprintf(namebuf, bufsize, "%"PRIu16, port);
4578         break;
4579     }
4580 }
4581
4582 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4583  * 'ofp_version', tries to pull the first element from the array.  If
4584  * successful, initializes '*pp' with an abstract representation of the
4585  * port and returns 0.  If no ports remain to be decoded, returns EOF.
4586  * On an error, returns a positive OFPERR_* value. */
4587 int
4588 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
4589                       struct ofputil_phy_port *pp)
4590 {
4591     switch (ofp_version) {
4592     case OFP10_VERSION: {
4593         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
4594         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
4595     }
4596     case OFP11_VERSION:
4597     case OFP12_VERSION:
4598     case OFP13_VERSION: {
4599         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
4600         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
4601     }
4602     default:
4603         NOT_REACHED();
4604     }
4605 }
4606
4607 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
4608  * 'ofp_version', returns the number of elements. */
4609 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
4610 {
4611     return b->size / ofputil_get_phy_port_size(ofp_version);
4612 }
4613
4614 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
4615  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
4616  * 'name' is not the name of any action.
4617  *
4618  * ofp-util.def lists the mapping from names to action. */
4619 int
4620 ofputil_action_code_from_name(const char *name)
4621 {
4622     static const char *const names[OFPUTIL_N_ACTIONS] = {
4623         NULL,
4624 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
4625 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
4626 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   NAME,
4627 #include "ofp-util.def"
4628     };
4629
4630     const char *const *p;
4631
4632     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
4633         if (*p && !strcasecmp(name, *p)) {
4634             return p - names;
4635         }
4636     }
4637     return -1;
4638 }
4639
4640 /* Appends an action of the type specified by 'code' to 'buf' and returns the
4641  * action.  Initializes the parts of 'action' that identify it as having type
4642  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
4643  * have variable length, the length used and cleared is that of struct
4644  * <STRUCT>.  */
4645 void *
4646 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
4647 {
4648     switch (code) {
4649     case OFPUTIL_ACTION_INVALID:
4650         NOT_REACHED();
4651
4652 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                  \
4653     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4654 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)      \
4655     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4656 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
4657     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
4658 #include "ofp-util.def"
4659     }
4660     NOT_REACHED();
4661 }
4662
4663 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
4664     void                                                        \
4665     ofputil_init_##ENUM(struct STRUCT *s)                       \
4666     {                                                           \
4667         memset(s, 0, sizeof *s);                                \
4668         s->type = htons(ENUM);                                  \
4669         s->len = htons(sizeof *s);                              \
4670     }                                                           \
4671                                                                 \
4672     struct STRUCT *                                             \
4673     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
4674     {                                                           \
4675         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
4676         ofputil_init_##ENUM(s);                                 \
4677         return s;                                               \
4678     }
4679 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4680     OFPAT10_ACTION(ENUM, STRUCT, NAME)
4681 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
4682     void                                                        \
4683     ofputil_init_##ENUM(struct STRUCT *s)                       \
4684     {                                                           \
4685         memset(s, 0, sizeof *s);                                \
4686         s->type = htons(OFPAT10_VENDOR);                        \
4687         s->len = htons(sizeof *s);                              \
4688         s->vendor = htonl(NX_VENDOR_ID);                        \
4689         s->subtype = htons(ENUM);                               \
4690     }                                                           \
4691                                                                 \
4692     struct STRUCT *                                             \
4693     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
4694     {                                                           \
4695         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
4696         ofputil_init_##ENUM(s);                                 \
4697         return s;                                               \
4698     }
4699 #include "ofp-util.def"
4700
4701 static void
4702 ofputil_normalize_match__(struct match *match, bool may_log)
4703 {
4704     enum {
4705         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
4706         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
4707         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
4708         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
4709         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
4710         MAY_ARP_THA     = 1 << 5, /* arp_tha */
4711         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4712         MAY_ND_TARGET   = 1 << 7, /* nd_target */
4713         MAY_MPLS        = 1 << 8, /* mpls label and tc */
4714     } may_match;
4715
4716     struct flow_wildcards wc;
4717
4718     /* Figure out what fields may be matched. */
4719     if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4720         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4721         if (match->flow.nw_proto == IPPROTO_TCP ||
4722             match->flow.nw_proto == IPPROTO_UDP ||
4723             match->flow.nw_proto == IPPROTO_ICMP) {
4724             may_match |= MAY_TP_ADDR;
4725         }
4726     } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4727         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4728         if (match->flow.nw_proto == IPPROTO_TCP ||
4729             match->flow.nw_proto == IPPROTO_UDP) {
4730             may_match |= MAY_TP_ADDR;
4731         } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4732             may_match |= MAY_TP_ADDR;
4733             if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4734                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4735             } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4736                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4737             }
4738         }
4739     } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4740                match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4741         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4742     } else if (eth_type_mpls(match->flow.dl_type)) {
4743         may_match = MAY_MPLS;
4744     } else {
4745         may_match = 0;
4746     }
4747
4748     /* Clear the fields that may not be matched. */
4749     wc = match->wc;
4750     if (!(may_match & MAY_NW_ADDR)) {
4751         wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4752     }
4753     if (!(may_match & MAY_TP_ADDR)) {
4754         wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4755     }
4756     if (!(may_match & MAY_NW_PROTO)) {
4757         wc.masks.nw_proto = 0;
4758     }
4759     if (!(may_match & MAY_IPVx)) {
4760         wc.masks.nw_tos = 0;
4761         wc.masks.nw_ttl = 0;
4762     }
4763     if (!(may_match & MAY_ARP_SHA)) {
4764         memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4765     }
4766     if (!(may_match & MAY_ARP_THA)) {
4767         memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4768     }
4769     if (!(may_match & MAY_IPV6)) {
4770         wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4771         wc.masks.ipv6_label = htonl(0);
4772     }
4773     if (!(may_match & MAY_ND_TARGET)) {
4774         wc.masks.nd_target = in6addr_any;
4775     }
4776     if (!(may_match & MAY_MPLS)) {
4777         wc.masks.mpls_lse = htonl(0);
4778         wc.masks.mpls_depth = 0;
4779     }
4780
4781     /* Log any changes. */
4782     if (!flow_wildcards_equal(&wc, &match->wc)) {
4783         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4784         char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4785
4786         match->wc = wc;
4787         match_zero_wildcarded_fields(match);
4788
4789         if (log) {
4790             char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4791             VLOG_INFO("normalization changed ofp_match, details:");
4792             VLOG_INFO(" pre: %s", pre);
4793             VLOG_INFO("post: %s", post);
4794             free(pre);
4795             free(post);
4796         }
4797     }
4798 }
4799
4800 /* "Normalizes" the wildcards in 'match'.  That means:
4801  *
4802  *    1. If the type of level N is known, then only the valid fields for that
4803  *       level may be specified.  For example, ARP does not have a TOS field,
4804  *       so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4805  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4806  *       ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4807  *       IPv4 flow.
4808  *
4809  *    2. If the type of level N is not known (or not understood by Open
4810  *       vSwitch), then no fields at all for that level may be specified.  For
4811  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4812  *       L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4813  *       SCTP flow.
4814  *
4815  * If this function changes 'match', it logs a rate-limited informational
4816  * message. */
4817 void
4818 ofputil_normalize_match(struct match *match)
4819 {
4820     ofputil_normalize_match__(match, true);
4821 }
4822
4823 /* Same as ofputil_normalize_match() without the logging.  Thus, this function
4824  * is suitable for a program's internal use, whereas ofputil_normalize_match()
4825  * sense for use on flows received from elsewhere (so that a bug in the program
4826  * that sent them can be reported and corrected). */
4827 void
4828 ofputil_normalize_match_quiet(struct match *match)
4829 {
4830     ofputil_normalize_match__(match, false);
4831 }
4832
4833 /* Parses a key or a key-value pair from '*stringp'.
4834  *
4835  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
4836  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
4837  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
4838  * are substrings of '*stringp' created by replacing some of its bytes by null
4839  * terminators.  Returns true.
4840  *
4841  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4842  * NULL and returns false. */
4843 bool
4844 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4845 {
4846     char *pos, *key, *value;
4847     size_t key_len;
4848
4849     pos = *stringp;
4850     pos += strspn(pos, ", \t\r\n");
4851     if (*pos == '\0') {
4852         *keyp = *valuep = NULL;
4853         return false;
4854     }
4855
4856     key = pos;
4857     key_len = strcspn(pos, ":=(, \t\r\n");
4858     if (key[key_len] == ':' || key[key_len] == '=') {
4859         /* The value can be separated by a colon. */
4860         size_t value_len;
4861
4862         value = key + key_len + 1;
4863         value_len = strcspn(value, ", \t\r\n");
4864         pos = value + value_len + (value[value_len] != '\0');
4865         value[value_len] = '\0';
4866     } else if (key[key_len] == '(') {
4867         /* The value can be surrounded by balanced parentheses.  The outermost
4868          * set of parentheses is removed. */
4869         int level = 1;
4870         size_t value_len;
4871
4872         value = key + key_len + 1;
4873         for (value_len = 0; level > 0; value_len++) {
4874             switch (value[value_len]) {
4875             case '\0':
4876                 level = 0;
4877                 break;
4878
4879             case '(':
4880                 level++;
4881                 break;
4882
4883             case ')':
4884                 level--;
4885                 break;
4886             }
4887         }
4888         value[value_len - 1] = '\0';
4889         pos = value + value_len;
4890     } else {
4891         /* There might be no value at all. */
4892         value = key + key_len;  /* Will become the empty string below. */
4893         pos = key + key_len + (key[key_len] != '\0');
4894     }
4895     key[key_len] = '\0';
4896
4897     *stringp = pos;
4898     *keyp = key;
4899     *valuep = value;
4900     return true;
4901 }
4902
4903 /* Encode a dump ports request for 'port', the encoded message
4904  * will be for Open Flow version 'ofp_version'. Returns message
4905  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4906 struct ofpbuf *
4907 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, ofp_port_t port)
4908 {
4909     struct ofpbuf *request;
4910
4911     switch (ofp_version) {
4912     case OFP10_VERSION: {
4913         struct ofp10_port_stats_request *req;
4914         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
4915         req = ofpbuf_put_zeros(request, sizeof *req);
4916         req->port_no = htons(ofp_to_u16(port));
4917         break;
4918     }
4919     case OFP11_VERSION:
4920     case OFP12_VERSION:
4921     case OFP13_VERSION: {
4922         struct ofp11_port_stats_request *req;
4923         request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
4924         req = ofpbuf_put_zeros(request, sizeof *req);
4925         req->port_no = ofputil_port_to_ofp11(port);
4926         break;
4927     }
4928     default:
4929         NOT_REACHED();
4930     }
4931
4932     return request;
4933 }
4934
4935 static void
4936 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
4937                             struct ofp10_port_stats *ps10)
4938 {
4939     ps10->port_no = htons(ofp_to_u16(ops->port_no));
4940     memset(ps10->pad, 0, sizeof ps10->pad);
4941     put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
4942     put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
4943     put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
4944     put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
4945     put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
4946     put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
4947     put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
4948     put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
4949     put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
4950     put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
4951     put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
4952     put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
4953 }
4954
4955 static void
4956 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
4957                             struct ofp11_port_stats *ps11)
4958 {
4959     ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
4960     memset(ps11->pad, 0, sizeof ps11->pad);
4961     ps11->rx_packets = htonll(ops->stats.rx_packets);
4962     ps11->tx_packets = htonll(ops->stats.tx_packets);
4963     ps11->rx_bytes = htonll(ops->stats.rx_bytes);
4964     ps11->tx_bytes = htonll(ops->stats.tx_bytes);
4965     ps11->rx_dropped = htonll(ops->stats.rx_dropped);
4966     ps11->tx_dropped = htonll(ops->stats.tx_dropped);
4967     ps11->rx_errors = htonll(ops->stats.rx_errors);
4968     ps11->tx_errors = htonll(ops->stats.tx_errors);
4969     ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
4970     ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
4971     ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
4972     ps11->collisions = htonll(ops->stats.collisions);
4973 }
4974
4975 static void
4976 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats *ops,
4977                             struct ofp13_port_stats *ps13)
4978 {
4979     ofputil_port_stats_to_ofp11(ops, &ps13->ps);
4980     ps13->duration_sec = htonl(ops->duration_sec);
4981     ps13->duration_nsec = htonl(ops->duration_nsec);
4982 }
4983
4984
4985 /* Encode a ports stat for 'ops' and append it to 'replies'. */
4986 void
4987 ofputil_append_port_stat(struct list *replies,
4988                          const struct ofputil_port_stats *ops)
4989 {
4990     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4991     struct ofp_header *oh = msg->data;
4992
4993     switch ((enum ofp_version)oh->version) {
4994     case OFP13_VERSION: {
4995         struct ofp13_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4996         ofputil_port_stats_to_ofp13(ops, reply);
4997         break;
4998     }
4999     case OFP12_VERSION:
5000     case OFP11_VERSION: {
5001         struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5002         ofputil_port_stats_to_ofp11(ops, reply);
5003         break;
5004     }
5005
5006     case OFP10_VERSION: {
5007         struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
5008         ofputil_port_stats_to_ofp10(ops, reply);
5009         break;
5010     }
5011
5012     default:
5013         NOT_REACHED();
5014     }
5015 }
5016
5017 static enum ofperr
5018 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
5019                               const struct ofp10_port_stats *ps10)
5020 {
5021     memset(ops, 0, sizeof *ops);
5022
5023     ops->port_no = u16_to_ofp(ntohs(ps10->port_no));
5024     ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
5025     ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
5026     ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
5027     ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
5028     ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
5029     ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
5030     ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
5031     ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
5032     ops->stats.rx_frame_errors =
5033         ntohll(get_32aligned_be64(&ps10->rx_frame_err));
5034     ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
5035     ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
5036     ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
5037     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5038
5039     return 0;
5040 }
5041
5042 static enum ofperr
5043 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
5044                               const struct ofp11_port_stats *ps11)
5045 {
5046     enum ofperr error;
5047
5048     memset(ops, 0, sizeof *ops);
5049     error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
5050     if (error) {
5051         return error;
5052     }
5053
5054     ops->stats.rx_packets = ntohll(ps11->rx_packets);
5055     ops->stats.tx_packets = ntohll(ps11->tx_packets);
5056     ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
5057     ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
5058     ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
5059     ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
5060     ops->stats.rx_errors = ntohll(ps11->rx_errors);
5061     ops->stats.tx_errors = ntohll(ps11->tx_errors);
5062     ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
5063     ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
5064     ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
5065     ops->stats.collisions = ntohll(ps11->collisions);
5066     ops->duration_sec = ops->duration_nsec = UINT32_MAX;
5067
5068     return 0;
5069 }
5070
5071 static enum ofperr
5072 ofputil_port_stats_from_ofp13(struct ofputil_port_stats *ops,
5073                               const struct ofp13_port_stats *ps13)
5074 {
5075     enum ofperr error = ofputil_port_stats_from_ofp11(ops, &ps13->ps);
5076     if (!error) {
5077         ops->duration_sec = ntohl(ps13->duration_sec);
5078         ops->duration_nsec = ntohl(ps13->duration_nsec);
5079     }
5080     return error;
5081 }
5082
5083
5084 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
5085  * message 'oh'. */
5086 size_t
5087 ofputil_count_port_stats(const struct ofp_header *oh)
5088 {
5089     struct ofpbuf b;
5090
5091     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5092     ofpraw_pull_assert(&b);
5093
5094     BUILD_ASSERT(sizeof(struct ofp10_port_stats) ==
5095                  sizeof(struct ofp11_port_stats));
5096     return b.size / sizeof(struct ofp10_port_stats);
5097 }
5098
5099 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
5100  * ofputil_port_stats in 'ps'.
5101  *
5102  * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
5103  * message.  Calling this function multiple times for a single 'msg' iterates
5104  * through the replies.  The caller must initially leave 'msg''s layer pointers
5105  * null and not modify them between calls.
5106  *
5107  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5108  * otherwise a positive errno value. */
5109 int
5110 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
5111 {
5112     enum ofperr error;
5113     enum ofpraw raw;
5114
5115     error = (msg->l2
5116              ? ofpraw_decode(&raw, msg->l2)
5117              : ofpraw_pull(&raw, msg));
5118     if (error) {
5119         return error;
5120     }
5121
5122     if (!msg->size) {
5123         return EOF;
5124     } else if (raw == OFPRAW_OFPST13_PORT_REPLY) {
5125         const struct ofp13_port_stats *ps13;
5126
5127         ps13 = ofpbuf_try_pull(msg, sizeof *ps13);
5128         if (!ps13) {
5129             goto bad_len;
5130         }
5131         return ofputil_port_stats_from_ofp13(ps, ps13);
5132     } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
5133         const struct ofp11_port_stats *ps11;
5134
5135         ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
5136         if (!ps11) {
5137             goto bad_len;
5138         }
5139         return ofputil_port_stats_from_ofp11(ps, ps11);
5140     } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
5141         const struct ofp10_port_stats *ps10;
5142
5143         ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
5144         if (!ps10) {
5145             goto bad_len;
5146         }
5147         return ofputil_port_stats_from_ofp10(ps, ps10);
5148     } else {
5149         NOT_REACHED();
5150     }
5151
5152  bad_len:
5153     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
5154                  "bytes at end", msg->size);
5155     return OFPERR_OFPBRC_BAD_LEN;
5156 }
5157
5158 /* Parse a port status request message into a 16 bit OpenFlow 1.0
5159  * port number and stores the latter in '*ofp10_port'.
5160  * Returns 0 if successful, otherwise an OFPERR_* number. */
5161 enum ofperr
5162 ofputil_decode_port_stats_request(const struct ofp_header *request,
5163                                   ofp_port_t *ofp10_port)
5164 {
5165     switch ((enum ofp_version)request->version) {
5166     case OFP13_VERSION:
5167     case OFP12_VERSION:
5168     case OFP11_VERSION: {
5169         const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
5170         return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
5171     }
5172
5173     case OFP10_VERSION: {
5174         const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
5175         *ofp10_port = u16_to_ofp(ntohs(psr10->port_no));
5176         return 0;
5177     }
5178
5179     default:
5180         NOT_REACHED();
5181     }
5182 }
5183
5184 /* Parse a queue status request message into 'oqsr'.
5185  * Returns 0 if successful, otherwise an OFPERR_* number. */
5186 enum ofperr
5187 ofputil_decode_queue_stats_request(const struct ofp_header *request,
5188                                    struct ofputil_queue_stats_request *oqsr)
5189 {
5190     switch ((enum ofp_version)request->version) {
5191     case OFP13_VERSION:
5192     case OFP12_VERSION:
5193     case OFP11_VERSION: {
5194         const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
5195         oqsr->queue_id = ntohl(qsr11->queue_id);
5196         return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
5197     }
5198
5199     case OFP10_VERSION: {
5200         const struct ofp10_queue_stats_request *qsr10 = ofpmsg_body(request);
5201         oqsr->queue_id = ntohl(qsr10->queue_id);
5202         oqsr->port_no = u16_to_ofp(ntohs(qsr10->port_no));
5203         /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
5204         if (oqsr->port_no == OFPP_ALL) {
5205             oqsr->port_no = OFPP_ANY;
5206         }
5207         return 0;
5208     }
5209
5210     default:
5211         NOT_REACHED();
5212     }
5213 }
5214
5215 /* Encode a queue statsrequest for 'oqsr', the encoded message
5216  * will be fore Open Flow version 'ofp_version'. Returns message
5217  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
5218 struct ofpbuf *
5219 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
5220                                    const struct ofputil_queue_stats_request *oqsr)
5221 {
5222     struct ofpbuf *request;
5223
5224     switch (ofp_version) {
5225     case OFP11_VERSION:
5226     case OFP12_VERSION:
5227     case OFP13_VERSION: {
5228         struct ofp11_queue_stats_request *req;
5229         request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
5230         req = ofpbuf_put_zeros(request, sizeof *req);
5231         req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
5232         req->queue_id = htonl(oqsr->queue_id);
5233         break;
5234     }
5235     case OFP10_VERSION: {
5236         struct ofp10_queue_stats_request *req;
5237         request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
5238         req = ofpbuf_put_zeros(request, sizeof *req);
5239         /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
5240         req->port_no = htons(ofp_to_u16(oqsr->port_no == OFPP_ANY
5241                                         ? OFPP_ALL : oqsr->port_no));
5242         req->queue_id = htonl(oqsr->queue_id);
5243         break;
5244     }
5245     default:
5246         NOT_REACHED();
5247     }
5248
5249     return request;
5250 }
5251
5252 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
5253  * message 'oh'. */
5254 size_t
5255 ofputil_count_queue_stats(const struct ofp_header *oh)
5256 {
5257     struct ofpbuf b;
5258
5259     ofpbuf_use_const(&b, oh, ntohs(oh->length));
5260     ofpraw_pull_assert(&b);
5261
5262     BUILD_ASSERT(sizeof(struct ofp10_queue_stats) ==
5263                  sizeof(struct ofp11_queue_stats));
5264     return b.size / sizeof(struct ofp10_queue_stats);
5265 }
5266
5267 static enum ofperr
5268 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
5269                                const struct ofp10_queue_stats *qs10)
5270 {
5271     oqs->port_no = u16_to_ofp(ntohs(qs10->port_no));
5272     oqs->queue_id = ntohl(qs10->queue_id);
5273     oqs->stats.tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
5274     oqs->stats.tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
5275     oqs->stats.tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
5276
5277     return 0;
5278 }
5279
5280 static enum ofperr
5281 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
5282                                const struct ofp11_queue_stats *qs11)
5283 {
5284     enum ofperr error;
5285
5286     error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
5287     if (error) {
5288         return error;
5289     }
5290
5291     oqs->queue_id = ntohl(qs11->queue_id);
5292     oqs->stats.tx_bytes = ntohll(qs11->tx_bytes);
5293     oqs->stats.tx_packets = ntohll(qs11->tx_packets);
5294     oqs->stats.tx_errors = ntohll(qs11->tx_errors);
5295
5296     return 0;
5297 }
5298
5299 static enum ofperr
5300 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats *oqs,
5301                                const struct ofp13_queue_stats *qs13)
5302 {
5303     enum ofperr error
5304         = ofputil_queue_stats_from_ofp11(oqs, &qs13->qs);
5305     if (!error) {
5306         /* FIXME: Get qs13->duration_sec and qs13->duration_nsec,
5307          * Add to netdev_queue_stats? */
5308     }
5309
5310     return error;
5311 }
5312
5313 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
5314  * ofputil_queue_stats in 'qs'.
5315  *
5316  * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
5317  * message.  Calling this function multiple times for a single 'msg' iterates
5318  * through the replies.  The caller must initially leave 'msg''s layer pointers
5319  * null and not modify them between calls.
5320  *
5321  * Returns 0 if successful, EOF if no replies were left in this 'msg',
5322  * otherwise a positive errno value. */
5323 int
5324 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
5325 {
5326     enum ofperr error;
5327     enum ofpraw raw;
5328
5329     error = (msg->l2
5330              ? ofpraw_decode(&raw, msg->l2)
5331              : ofpraw_pull(&raw, msg));
5332     if (error) {
5333         return error;
5334     }
5335
5336     if (!msg->size) {
5337         return EOF;
5338     } else if (raw == OFPRAW_OFPST13_QUEUE_REPLY) {
5339         const struct ofp13_queue_stats *qs13;
5340
5341         qs13 = ofpbuf_try_pull(msg, sizeof *qs13);
5342         if (!qs13) {
5343             goto bad_len;
5344         }
5345         return ofputil_queue_stats_from_ofp13(qs, qs13);
5346     } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
5347         const struct ofp11_queue_stats *qs11;
5348
5349         qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
5350         if (!qs11) {
5351             goto bad_len;
5352         }
5353         return ofputil_queue_stats_from_ofp11(qs, qs11);
5354     } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
5355         const struct ofp10_queue_stats *qs10;
5356
5357         qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
5358         if (!qs10) {
5359             goto bad_len;
5360         }
5361         return ofputil_queue_stats_from_ofp10(qs, qs10);
5362     } else {
5363         NOT_REACHED();
5364     }
5365
5366  bad_len:
5367     VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
5368                  "bytes at end", msg->size);
5369     return OFPERR_OFPBRC_BAD_LEN;
5370 }
5371
5372 static void
5373 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
5374                              struct ofp10_queue_stats *qs10)
5375 {
5376     qs10->port_no = htons(ofp_to_u16(oqs->port_no));
5377     memset(qs10->pad, 0, sizeof qs10->pad);
5378     qs10->queue_id = htonl(oqs->queue_id);
5379     put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->stats.tx_bytes));
5380     put_32aligned_be64(&qs10->tx_packets, htonll(oqs->stats.tx_packets));
5381     put_32aligned_be64(&qs10->tx_errors, htonll(oqs->stats.tx_errors));
5382 }
5383
5384 static void
5385 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
5386                              struct ofp11_queue_stats *qs11)
5387 {
5388     qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
5389     qs11->queue_id = htonl(oqs->queue_id);
5390     qs11->tx_bytes = htonll(oqs->stats.tx_bytes);
5391     qs11->tx_packets = htonll(oqs->stats.tx_packets);
5392     qs11->tx_errors = htonll(oqs->stats.tx_errors);
5393 }
5394
5395 static void
5396 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats *oqs,
5397                              struct ofp13_queue_stats *qs13)
5398 {
5399     ofputil_queue_stats_to_ofp11(oqs, &qs13->qs);
5400     /* OF 1.3 adds duration fields */
5401     /* FIXME: Need to implement queue alive duration (sec + nsec) */
5402     qs13->duration_sec = htonl(~0);
5403     qs13->duration_nsec = htonl(~0);
5404 }
5405
5406 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
5407 void
5408 ofputil_append_queue_stat(struct list *replies,
5409                           const struct ofputil_queue_stats *oqs)
5410 {
5411     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
5412     struct ofp_header *oh = msg->data;
5413
5414     switch ((enum ofp_version)oh->version) {
5415     case OFP13_VERSION: {
5416         struct ofp13_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5417         ofputil_queue_stats_to_ofp13(oqs, reply);
5418         break;
5419     }
5420
5421     case OFP12_VERSION:
5422     case OFP11_VERSION: {
5423         struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5424         ofputil_queue_stats_to_ofp11(oqs, reply);
5425         break;
5426     }
5427
5428     case OFP10_VERSION: {
5429         struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);
5430         ofputil_queue_stats_to_ofp10(oqs, reply);
5431         break;
5432     }
5433
5434     default:
5435         NOT_REACHED();
5436     }
5437 }