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