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