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