pintos-os.org Git - openvswitch/blob - lib/ofp-util.c

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