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