lib/ofp-util.c

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