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_STD_ANY, "OpenFlow10" },
 586     { OFPUTIL_P_OF10_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_OF10_NXM,
 592     OFPUTIL_P_OF10_STD,
 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_STD;
 607     case OFP12_VERSION:
 608         return OFPUTIL_P_OF12_OXM;
 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_STD:
 622     case OFPUTIL_P_OF10_STD_TID:
 623     case OFPUTIL_P_OF10_NXM:
 624     case OFPUTIL_P_OF10_NXM_TID:
 625         return OFP10_VERSION;
 626     case OFPUTIL_P_OF12_OXM:
 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_STD:
 656     case OFPUTIL_P_OF10_STD_TID:
 657         return enable ? OFPUTIL_P_OF10_STD_TID : OFPUTIL_P_OF10_STD;
 658
 659     case OFPUTIL_P_OF10_NXM:
 660     case OFPUTIL_P_OF10_NXM_TID:
 661         return enable ? OFPUTIL_P_OF10_NXM_TID : OFPUTIL_P_OF10_NXM;
 662
 663     case OFPUTIL_P_OF12_OXM:
 664         return OFPUTIL_P_OF12_OXM;
 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_STD:
 690     case OFPUTIL_P_OF10_STD_TID:
 691         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD, tid);
 692
 693     case OFPUTIL_P_OF10_NXM:
 694     case OFPUTIL_P_OF10_NXM_TID:
 695         return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM, tid);
 696
 697     case OFPUTIL_P_OF12_OXM:
 698         return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM, 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_OF10_NXM:
 717         return "NXM-table_id";
 718
 719     case OFPUTIL_P_OF10_NXM_TID:
 720         return "NXM+table_id";
 721
 722     case OFPUTIL_P_OF10_STD:
 723         return "OpenFlow10-table_id";
 724
 725     case OFPUTIL_P_OF10_STD_TID:
 726         return "OpenFlow10+table_id";
 727
 728     case OFPUTIL_P_OF12_OXM:
 729         return "OXM";
 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, OXM, and OF1.1 support 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_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
 976     }
 977     if (!eth_mask_is_exact(wc->masks.dl_dst)
 978         && !eth_addr_is_zero(wc->masks.dl_dst)) {
 979         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
 980     }
 981
 982     /* NXM, OXM, and OF1.1+ support matching metadata. */
 983     if (wc->masks.metadata != htonll(0)) {
 984         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
 985     }
 986
 987     /* NXM and OXM support 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_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
 991     }
 992
 993     /* NXM and OXM support matching IPv6 traffic. */
 994     if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
 995         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
 996     }
 997
 998     /* NXM and OXM support matching registers. */
 999     if (!regs_fully_wildcarded(wc)) {
1000         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1001     }
1002
1003     /* NXM and OXM support matching tun_id. */
1004     if (wc->masks.tunnel.tun_id != htonll(0)) {
1005         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1006     }
1007
1008     /* NXM and OXM support matching fragments. */
1009     if (wc->masks.nw_frag) {
1010         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1011     }
1012
1013     /* NXM and OXM support matching IPv6 flow label. */
1014     if (wc->masks.ipv6_label) {
1015         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1016     }
1017
1018     /* NXM and OXM support matching IP ECN bits. */
1019     if (wc->masks.nw_tos & IP_ECN_MASK) {
1020         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1021     }
1022
1023     /* NXM and OXM support matching IP TTL/hop limit. */
1024     if (wc->masks.nw_ttl) {
1025         return OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1026     }
1027
1028     /* NXM and OXM support 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_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1031     }
1032
1033     /* NXM and OXM support 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_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
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         ofpmsg_update_length(msg);
1193     }
1194
1195     return msg;
1196 }
1197
1198 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1199  * protocol is 'current', at least partly transitions the protocol to 'want'.
1200  * Stores in '*next' the protocol that will be in effect on the OpenFlow
1201  * connection if the switch processes the returned message correctly.  (If
1202  * '*next != want' then the caller will have to iterate.)
1203  *
1204  * If 'current == want', or if it is not possible to transition from 'current'
1205  * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1206  * protocol versions), returns NULL and stores 'current' in '*next'. */
1207 struct ofpbuf *
1208 ofputil_encode_set_protocol(enum ofputil_protocol current,
1209                             enum ofputil_protocol want,
1210                             enum ofputil_protocol *next)
1211 {
1212     enum ofp_version cur_version, want_version;
1213     enum ofputil_protocol cur_base, want_base;
1214     bool cur_tid, want_tid;
1215
1216     cur_version = ofputil_protocol_to_ofp_version(current);
1217     want_version = ofputil_protocol_to_ofp_version(want);
1218     if (cur_version != want_version) {
1219         *next = current;
1220         return NULL;
1221     }
1222
1223     cur_base = ofputil_protocol_to_base(current);
1224     want_base = ofputil_protocol_to_base(want);
1225     if (cur_base != want_base) {
1226         *next = ofputil_protocol_set_base(current, want_base);
1227
1228         switch (want_base) {
1229         case OFPUTIL_P_OF10_NXM:
1230             return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1231
1232         case OFPUTIL_P_OF10_STD:
1233             return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1234
1235         case OFPUTIL_P_OF12_OXM:
1236             /* There's only one OpenFlow 1.2 protocol and we already verified
1237              * above that we're not trying to change versions. */
1238             NOT_REACHED();
1239
1240         case OFPUTIL_P_OF10_STD_TID:
1241         case OFPUTIL_P_OF10_NXM_TID:
1242             NOT_REACHED();
1243         }
1244     }
1245
1246     cur_tid = (current & OFPUTIL_P_TID) != 0;
1247     want_tid = (want & OFPUTIL_P_TID) != 0;
1248     if (cur_tid != want_tid) {
1249         *next = ofputil_protocol_set_tid(current, want_tid);
1250         return ofputil_make_flow_mod_table_id(want_tid);
1251     }
1252
1253     assert(current == want);
1254
1255     *next = current;
1256     return NULL;
1257 }
1258
1259 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1260  * format to 'nxff'.  */
1261 struct ofpbuf *
1262 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1263 {
1264     struct nx_set_flow_format *sff;
1265     struct ofpbuf *msg;
1266
1267     assert(ofputil_nx_flow_format_is_valid(nxff));
1268
1269     msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1270     sff = ofpbuf_put_zeros(msg, sizeof *sff);
1271     sff->format = htonl(nxff);
1272
1273     return msg;
1274 }
1275
1276 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1277  * otherwise. */
1278 enum ofputil_protocol
1279 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1280 {
1281     switch (flow_format) {
1282     case NXFF_OPENFLOW10:
1283         return OFPUTIL_P_OF10_STD;
1284
1285     case NXFF_NXM:
1286         return OFPUTIL_P_OF10_NXM;
1287
1288     default:
1289         return 0;
1290     }
1291 }
1292
1293 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1294 bool
1295 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1296 {
1297     return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1298 }
1299
1300 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1301  * value. */
1302 const char *
1303 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1304 {
1305     switch (flow_format) {
1306     case NXFF_OPENFLOW10:
1307         return "openflow10";
1308     case NXFF_NXM:
1309         return "nxm";
1310     default:
1311         NOT_REACHED();
1312     }
1313 }
1314
1315 struct ofpbuf *
1316 ofputil_make_set_packet_in_format(enum ofp_version ofp_version,
1317                                   enum nx_packet_in_format packet_in_format)
1318 {
1319     struct nx_set_packet_in_format *spif;
1320     struct ofpbuf *msg;
1321
1322     msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, ofp_version, 0);
1323     spif = ofpbuf_put_zeros(msg, sizeof *spif);
1324     spif->format = htonl(packet_in_format);
1325
1326     return msg;
1327 }
1328
1329 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1330  * extension on or off (according to 'flow_mod_table_id'). */
1331 struct ofpbuf *
1332 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1333 {
1334     struct nx_flow_mod_table_id *nfmti;
1335     struct ofpbuf *msg;
1336
1337     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1338     nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1339     nfmti->set = flow_mod_table_id;
1340     return msg;
1341 }
1342
1343 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1344  * flow_mod in 'fm'.  Returns 0 if successful, otherwise an OpenFlow error
1345  * code.
1346  *
1347  * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1348  * The caller must initialize 'ofpacts' and retains ownership of it.
1349  * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1350  *
1351  * Does not validate the flow_mod actions.  The caller should do that, with
1352  * ofpacts_check(). */
1353 enum ofperr
1354 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1355                         const struct ofp_header *oh,
1356                         enum ofputil_protocol protocol,
1357                         struct ofpbuf *ofpacts)
1358 {
1359     uint16_t command;
1360     struct ofpbuf b;
1361     enum ofpraw raw;
1362
1363     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1364     raw = ofpraw_pull_assert(&b);
1365     if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1366         /* Standard OpenFlow 1.1 flow_mod. */
1367         const struct ofp11_flow_mod *ofm;
1368         enum ofperr error;
1369
1370         ofm = ofpbuf_pull(&b, sizeof *ofm);
1371
1372         error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1373         if (error) {
1374             return error;
1375         }
1376
1377         error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1378         if (error) {
1379             return error;
1380         }
1381
1382         /* Translate the message. */
1383         fm->priority = ntohs(ofm->priority);
1384         if (ofm->command == OFPFC_ADD) {
1385             fm->cookie = htonll(0);
1386             fm->cookie_mask = htonll(0);
1387             fm->new_cookie = ofm->cookie;
1388         } else {
1389             fm->cookie = ofm->cookie;
1390             fm->cookie_mask = ofm->cookie_mask;
1391             fm->new_cookie = htonll(UINT64_MAX);
1392         }
1393         fm->command = ofm->command;
1394         fm->table_id = ofm->table_id;
1395         fm->idle_timeout = ntohs(ofm->idle_timeout);
1396         fm->hard_timeout = ntohs(ofm->hard_timeout);
1397         fm->buffer_id = ntohl(ofm->buffer_id);
1398         error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1399         if (error) {
1400             return error;
1401         }
1402         if (ofm->out_group != htonl(OFPG_ANY)) {
1403             return OFPERR_OFPFMFC_UNKNOWN;
1404         }
1405         fm->flags = ntohs(ofm->flags);
1406     } else {
1407         if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1408             /* Standard OpenFlow 1.0 flow_mod. */
1409             const struct ofp10_flow_mod *ofm;
1410             enum ofperr error;
1411
1412             /* Get the ofp10_flow_mod. */
1413             ofm = ofpbuf_pull(&b, sizeof *ofm);
1414
1415             /* Translate the rule. */
1416             ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1417             ofputil_normalize_match(&fm->match);
1418
1419             /* Now get the actions. */
1420             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1421             if (error) {
1422                 return error;
1423             }
1424
1425             /* OpenFlow 1.0 says that exact-match rules have to have the
1426              * highest possible priority. */
1427             fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1428                             ? ntohs(ofm->priority)
1429                             : UINT16_MAX);
1430
1431             /* Translate the message. */
1432             command = ntohs(ofm->command);
1433             fm->cookie = htonll(0);
1434             fm->cookie_mask = htonll(0);
1435             fm->new_cookie = ofm->cookie;
1436             fm->idle_timeout = ntohs(ofm->idle_timeout);
1437             fm->hard_timeout = ntohs(ofm->hard_timeout);
1438             fm->buffer_id = ntohl(ofm->buffer_id);
1439             fm->out_port = ntohs(ofm->out_port);
1440             fm->flags = ntohs(ofm->flags);
1441         } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1442             /* Nicira extended flow_mod. */
1443             const struct nx_flow_mod *nfm;
1444             enum ofperr error;
1445
1446             /* Dissect the message. */
1447             nfm = ofpbuf_pull(&b, sizeof *nfm);
1448             error = nx_pull_match(&b, ntohs(nfm->match_len),
1449                                   &fm->match, &fm->cookie, &fm->cookie_mask);
1450             if (error) {
1451                 return error;
1452             }
1453             error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1454             if (error) {
1455                 return error;
1456             }
1457
1458             /* Translate the message. */
1459             command = ntohs(nfm->command);
1460             if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1461                 /* Flow additions may only set a new cookie, not match an
1462                  * existing cookie. */
1463                 return OFPERR_NXBRC_NXM_INVALID;
1464             }
1465             fm->priority = ntohs(nfm->priority);
1466             fm->new_cookie = nfm->cookie;
1467             fm->idle_timeout = ntohs(nfm->idle_timeout);
1468             fm->hard_timeout = ntohs(nfm->hard_timeout);
1469             fm->buffer_id = ntohl(nfm->buffer_id);
1470             fm->out_port = ntohs(nfm->out_port);
1471             fm->flags = ntohs(nfm->flags);
1472         } else {
1473             NOT_REACHED();
1474         }
1475
1476         if (protocol & OFPUTIL_P_TID) {
1477             fm->command = command & 0xff;
1478             fm->table_id = command >> 8;
1479         } else {
1480             fm->command = command;
1481             fm->table_id = 0xff;
1482         }
1483     }
1484
1485     fm->ofpacts = ofpacts->data;
1486     fm->ofpacts_len = ofpacts->size;
1487
1488     return 0;
1489 }
1490
1491 static ovs_be16
1492 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1493                     enum ofputil_protocol protocol)
1494 {
1495     return htons(protocol & OFPUTIL_P_TID
1496                  ? (fm->command & 0xff) | (fm->table_id << 8)
1497                  : fm->command);
1498 }
1499
1500 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1501  * 'protocol' and returns the message. */
1502 struct ofpbuf *
1503 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1504                         enum ofputil_protocol protocol)
1505 {
1506     struct ofpbuf *msg;
1507
1508     switch (protocol) {
1509     case OFPUTIL_P_OF12_OXM: {
1510         struct ofp11_flow_mod *ofm;
1511
1512         msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1513                            NXM_TYPICAL_LEN + fm->ofpacts_len);
1514         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1515         if (fm->command == OFPFC_ADD) {
1516             ofm->cookie = fm->new_cookie;
1517         } else {
1518             ofm->cookie = fm->cookie;
1519         }
1520         ofm->cookie_mask = fm->cookie_mask;
1521         ofm->table_id = fm->table_id;
1522         ofm->command = fm->command;
1523         ofm->idle_timeout = htons(fm->idle_timeout);
1524         ofm->hard_timeout = htons(fm->hard_timeout);
1525         ofm->priority = htons(fm->priority);
1526         ofm->buffer_id = htonl(fm->buffer_id);
1527         ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1528         ofm->out_group = htonl(OFPG11_ANY);
1529         ofm->flags = htons(fm->flags);
1530         oxm_put_match(msg, &fm->match);
1531         ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1532         break;
1533     }
1534
1535     case OFPUTIL_P_OF10_STD:
1536     case OFPUTIL_P_OF10_STD_TID: {
1537         struct ofp10_flow_mod *ofm;
1538
1539         msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1540                            fm->ofpacts_len);
1541         ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1542         ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
1543         ofm->cookie = fm->new_cookie;
1544         ofm->command = ofputil_tid_command(fm, protocol);
1545         ofm->idle_timeout = htons(fm->idle_timeout);
1546         ofm->hard_timeout = htons(fm->hard_timeout);
1547         ofm->priority = htons(fm->priority);
1548         ofm->buffer_id = htonl(fm->buffer_id);
1549         ofm->out_port = htons(fm->out_port);
1550         ofm->flags = htons(fm->flags);
1551         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1552         break;
1553     }
1554
1555     case OFPUTIL_P_OF10_NXM:
1556     case OFPUTIL_P_OF10_NXM_TID: {
1557         struct nx_flow_mod *nfm;
1558         int match_len;
1559
1560         msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1561                            NXM_TYPICAL_LEN + fm->ofpacts_len);
1562         nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1563         nfm->command = ofputil_tid_command(fm, protocol);
1564         nfm->cookie = fm->new_cookie;
1565         match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
1566         nfm = msg->l3;
1567         nfm->idle_timeout = htons(fm->idle_timeout);
1568         nfm->hard_timeout = htons(fm->hard_timeout);
1569         nfm->priority = htons(fm->priority);
1570         nfm->buffer_id = htonl(fm->buffer_id);
1571         nfm->out_port = htons(fm->out_port);
1572         nfm->flags = htons(fm->flags);
1573         nfm->match_len = htons(match_len);
1574         ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1575         break;
1576     }
1577
1578     default:
1579         NOT_REACHED();
1580     }
1581
1582     ofpmsg_update_length(msg);
1583     return msg;
1584 }
1585
1586 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1587  * send all of the 'n_fm's flow table modification requests in 'fms', and a
1588  * 0-bit for each protocol that is inadequate.
1589  *
1590  * (The return value will have at least one 1-bit.) */
1591 enum ofputil_protocol
1592 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1593                                   size_t n_fms)
1594 {
1595     enum ofputil_protocol usable_protocols;
1596     size_t i;
1597
1598     usable_protocols = OFPUTIL_P_ANY;
1599     for (i = 0; i < n_fms; i++) {
1600         const struct ofputil_flow_mod *fm = &fms[i];
1601
1602         usable_protocols &= ofputil_usable_protocols(&fm->match);
1603         if (fm->table_id != 0xff) {
1604             usable_protocols &= OFPUTIL_P_TID;
1605         }
1606
1607         /* Matching of the cookie is only supported through NXM or OF1.1+. */
1608         if (fm->cookie_mask != htonll(0)) {
1609             usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1610         }
1611     }
1612     assert(usable_protocols);
1613
1614     return usable_protocols;
1615 }
1616
1617 static enum ofperr
1618 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1619                                     const struct ofp10_flow_stats_request *ofsr,
1620                                     bool aggregate)
1621 {
1622     fsr->aggregate = aggregate;
1623     ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
1624     fsr->out_port = ntohs(ofsr->out_port);
1625     fsr->table_id = ofsr->table_id;
1626     fsr->cookie = fsr->cookie_mask = htonll(0);
1627
1628     return 0;
1629 }
1630
1631 static enum ofperr
1632 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1633                                     struct ofpbuf *b, bool aggregate)
1634 {
1635     const struct ofp11_flow_stats_request *ofsr;
1636     enum ofperr error;
1637
1638     ofsr = ofpbuf_pull(b, sizeof *ofsr);
1639     fsr->aggregate = aggregate;
1640     fsr->table_id = ofsr->table_id;
1641     error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1642     if (error) {
1643         return error;
1644     }
1645     if (ofsr->out_group != htonl(OFPG11_ANY)) {
1646         return OFPERR_OFPFMFC_UNKNOWN;
1647     }
1648     fsr->cookie = ofsr->cookie;
1649     fsr->cookie_mask = ofsr->cookie_mask;
1650     error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
1651     if (error) {
1652         return error;
1653     }
1654
1655     return 0;
1656 }
1657
1658 static enum ofperr
1659 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1660                                  struct ofpbuf *b, bool aggregate)
1661 {
1662     const struct nx_flow_stats_request *nfsr;
1663     enum ofperr error;
1664
1665     nfsr = ofpbuf_pull(b, sizeof *nfsr);
1666     error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
1667                           &fsr->cookie, &fsr->cookie_mask);
1668     if (error) {
1669         return error;
1670     }
1671     if (b->size) {
1672         return OFPERR_OFPBRC_BAD_LEN;
1673     }
1674
1675     fsr->aggregate = aggregate;
1676     fsr->out_port = ntohs(nfsr->out_port);
1677     fsr->table_id = nfsr->table_id;
1678
1679     return 0;
1680 }
1681
1682 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1683  * request 'oh', into an abstract flow_stats_request in 'fsr'.  Returns 0 if
1684  * successful, otherwise an OpenFlow error code. */
1685 enum ofperr
1686 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1687                                   const struct ofp_header *oh)
1688 {
1689     enum ofpraw raw;
1690     struct ofpbuf b;
1691
1692     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1693     raw = ofpraw_pull_assert(&b);
1694     switch ((int) raw) {
1695     case OFPRAW_OFPST10_FLOW_REQUEST:
1696         return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1697
1698     case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1699         return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1700
1701     case OFPRAW_OFPST11_FLOW_REQUEST:
1702         return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1703
1704     case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1705         return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1706
1707     case OFPRAW_NXST_FLOW_REQUEST:
1708         return ofputil_decode_nxst_flow_request(fsr, &b, false);
1709
1710     case OFPRAW_NXST_AGGREGATE_REQUEST:
1711         return ofputil_decode_nxst_flow_request(fsr, &b, true);
1712
1713     default:
1714         /* Hey, the caller lied. */
1715         NOT_REACHED();
1716     }
1717 }
1718
1719 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1720  * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1721  * 'protocol', and returns the message. */
1722 struct ofpbuf *
1723 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1724                                   enum ofputil_protocol protocol)
1725 {
1726     struct ofpbuf *msg;
1727     enum ofpraw raw;
1728
1729     switch (protocol) {
1730     case OFPUTIL_P_OF12_OXM: {
1731         struct ofp11_flow_stats_request *ofsr;
1732
1733         raw = (fsr->aggregate
1734                ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1735                : OFPRAW_OFPST11_FLOW_REQUEST);
1736         msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1737         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1738         ofsr->table_id = fsr->table_id;
1739         ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1740         ofsr->out_group = htonl(OFPG11_ANY);
1741         ofsr->cookie = fsr->cookie;
1742         ofsr->cookie_mask = fsr->cookie_mask;
1743         oxm_put_match(msg, &fsr->match);
1744         break;
1745     }
1746
1747     case OFPUTIL_P_OF10_STD:
1748     case OFPUTIL_P_OF10_STD_TID: {
1749         struct ofp10_flow_stats_request *ofsr;
1750
1751         raw = (fsr->aggregate
1752                ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1753                : OFPRAW_OFPST10_FLOW_REQUEST);
1754         msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1755         ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1756         ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
1757         ofsr->table_id = fsr->table_id;
1758         ofsr->out_port = htons(fsr->out_port);
1759         break;
1760     }
1761
1762     case OFPUTIL_P_OF10_NXM:
1763     case OFPUTIL_P_OF10_NXM_TID: {
1764         struct nx_flow_stats_request *nfsr;
1765         int match_len;
1766
1767         raw = (fsr->aggregate
1768                ? OFPRAW_NXST_AGGREGATE_REQUEST
1769                : OFPRAW_NXST_FLOW_REQUEST);
1770         msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1771         ofpbuf_put_zeros(msg, sizeof *nfsr);
1772         match_len = nx_put_match(msg, &fsr->match,
1773                                  fsr->cookie, fsr->cookie_mask);
1774
1775         nfsr = msg->l3;
1776         nfsr->out_port = htons(fsr->out_port);
1777         nfsr->match_len = htons(match_len);
1778         nfsr->table_id = fsr->table_id;
1779         break;
1780     }
1781
1782     default:
1783         NOT_REACHED();
1784     }
1785
1786     return msg;
1787 }
1788
1789 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1790  * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1791  *
1792  * (The return value will have at least one 1-bit.) */
1793 enum ofputil_protocol
1794 ofputil_flow_stats_request_usable_protocols(
1795     const struct ofputil_flow_stats_request *fsr)
1796 {
1797     enum ofputil_protocol usable_protocols;
1798
1799     usable_protocols = ofputil_usable_protocols(&fsr->match);
1800     if (fsr->cookie_mask != htonll(0)) {
1801         usable_protocols &= OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF12_OXM;
1802     }
1803     return usable_protocols;
1804 }
1805
1806 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1807  * ofputil_flow_stats in 'fs'.
1808  *
1809  * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1810  * OpenFlow message.  Calling this function multiple times for a single 'msg'
1811  * iterates through the replies.  The caller must initially leave 'msg''s layer
1812  * pointers null and not modify them between calls.
1813  *
1814  * Most switches don't send the values needed to populate fs->idle_age and
1815  * fs->hard_age, so those members will usually be set to 0.  If the switch from
1816  * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1817  * 'flow_age_extension' as true so that the contents of 'msg' determine the
1818  * 'idle_age' and 'hard_age' members in 'fs'.
1819  *
1820  * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1821  * reply's actions.  The caller must initialize 'ofpacts' and retains ownership
1822  * of it.  'fs->ofpacts' will point into the 'ofpacts' buffer.
1823  *
1824  * Returns 0 if successful, EOF if no replies were left in this 'msg',
1825  * otherwise a positive errno value. */
1826 int
1827 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1828                                 struct ofpbuf *msg,
1829                                 bool flow_age_extension,
1830                                 struct ofpbuf *ofpacts)
1831 {
1832     enum ofperr error;
1833     enum ofpraw raw;
1834
1835     error = (msg->l2
1836              ? ofpraw_decode(&raw, msg->l2)
1837              : ofpraw_pull(&raw, msg));
1838     if (error) {
1839         return error;
1840     }
1841
1842     if (!msg->size) {
1843         return EOF;
1844     } else if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1845         const struct ofp11_flow_stats *ofs;
1846         size_t length;
1847         uint16_t padded_match_len;
1848
1849         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1850         if (!ofs) {
1851             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1852                          "bytes at end", msg->size);
1853             return EINVAL;
1854         }
1855
1856         length = ntohs(ofs->length);
1857         if (length < sizeof *ofs) {
1858             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1859                          "length %zu", length);
1860             return EINVAL;
1861         }
1862
1863         if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
1864             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
1865             return EINVAL;
1866         }
1867
1868         if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
1869                                                  padded_match_len, ofpacts)) {
1870             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
1871             return EINVAL;
1872         }
1873
1874         fs->priority = ntohs(ofs->priority);
1875         fs->table_id = ofs->table_id;
1876         fs->duration_sec = ntohl(ofs->duration_sec);
1877         fs->duration_nsec = ntohl(ofs->duration_nsec);
1878         fs->idle_timeout = ntohs(ofs->idle_timeout);
1879         fs->hard_timeout = ntohs(ofs->hard_timeout);
1880         fs->idle_age = -1;
1881         fs->hard_age = -1;
1882         fs->cookie = ofs->cookie;
1883         fs->packet_count = ntohll(ofs->packet_count);
1884         fs->byte_count = ntohll(ofs->byte_count);
1885     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1886         const struct ofp10_flow_stats *ofs;
1887         size_t length;
1888
1889         ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1890         if (!ofs) {
1891             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1892                          "bytes at end", msg->size);
1893             return EINVAL;
1894         }
1895
1896         length = ntohs(ofs->length);
1897         if (length < sizeof *ofs) {
1898             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1899                          "length %zu", length);
1900             return EINVAL;
1901         }
1902
1903         if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1904             return EINVAL;
1905         }
1906
1907         fs->cookie = get_32aligned_be64(&ofs->cookie);
1908         ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
1909         fs->priority = ntohs(ofs->priority);
1910         fs->table_id = ofs->table_id;
1911         fs->duration_sec = ntohl(ofs->duration_sec);
1912         fs->duration_nsec = ntohl(ofs->duration_nsec);
1913         fs->idle_timeout = ntohs(ofs->idle_timeout);
1914         fs->hard_timeout = ntohs(ofs->hard_timeout);
1915         fs->idle_age = -1;
1916         fs->hard_age = -1;
1917         fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1918         fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1919     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1920         const struct nx_flow_stats *nfs;
1921         size_t match_len, actions_len, length;
1922
1923         nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1924         if (!nfs) {
1925             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1926                          "bytes at end", msg->size);
1927             return EINVAL;
1928         }
1929
1930         length = ntohs(nfs->length);
1931         match_len = ntohs(nfs->match_len);
1932         if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1933             VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1934                          "claims invalid length %zu", match_len, length);
1935             return EINVAL;
1936         }
1937         if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
1938             return EINVAL;
1939         }
1940
1941         actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1942         if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1943             return EINVAL;
1944         }
1945
1946         fs->cookie = nfs->cookie;
1947         fs->table_id = nfs->table_id;
1948         fs->duration_sec = ntohl(nfs->duration_sec);
1949         fs->duration_nsec = ntohl(nfs->duration_nsec);
1950         fs->priority = ntohs(nfs->priority);
1951         fs->idle_timeout = ntohs(nfs->idle_timeout);
1952         fs->hard_timeout = ntohs(nfs->hard_timeout);
1953         fs->idle_age = -1;
1954         fs->hard_age = -1;
1955         if (flow_age_extension) {
1956             if (nfs->idle_age) {
1957                 fs->idle_age = ntohs(nfs->idle_age) - 1;
1958             }
1959             if (nfs->hard_age) {
1960                 fs->hard_age = ntohs(nfs->hard_age) - 1;
1961             }
1962         }
1963         fs->packet_count = ntohll(nfs->packet_count);
1964         fs->byte_count = ntohll(nfs->byte_count);
1965     } else {
1966         NOT_REACHED();
1967     }
1968
1969     fs->ofpacts = ofpacts->data;
1970     fs->ofpacts_len = ofpacts->size;
1971
1972     return 0;
1973 }
1974
1975 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1976  *
1977  * We use this in situations where OVS internally uses UINT64_MAX to mean
1978  * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1979 static uint64_t
1980 unknown_to_zero(uint64_t count)
1981 {
1982     return count != UINT64_MAX ? count : 0;
1983 }
1984
1985 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1986  * those already present in the list of ofpbufs in 'replies'.  'replies' should
1987  * have been initialized with ofputil_start_stats_reply(). */
1988 void
1989 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1990                                 struct list *replies)
1991 {
1992     struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1993     size_t start_ofs = reply->size;
1994     enum ofpraw raw;
1995
1996     ofpraw_decode_partial(&raw, reply->data, reply->size);
1997     if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1998         struct ofp11_flow_stats *ofs;
1999
2000         ofpbuf_put_uninit(reply, sizeof *ofs);
2001         oxm_put_match(reply, &fs->match);
2002         ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
2003                                             reply);
2004
2005         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2006         ofs->length = htons(reply->size - start_ofs);
2007         ofs->table_id = fs->table_id;
2008         ofs->pad = 0;
2009         ofs->duration_sec = htonl(fs->duration_sec);
2010         ofs->duration_nsec = htonl(fs->duration_nsec);
2011         ofs->priority = htons(fs->priority);
2012         ofs->idle_timeout = htons(fs->idle_timeout);
2013         ofs->hard_timeout = htons(fs->hard_timeout);
2014         memset(ofs->pad2, 0, sizeof ofs->pad2);
2015         ofs->cookie = fs->cookie;
2016         ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
2017         ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
2018     } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
2019         struct ofp10_flow_stats *ofs;
2020
2021         ofpbuf_put_uninit(reply, sizeof *ofs);
2022         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2023
2024         ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2025         ofs->length = htons(reply->size - start_ofs);
2026         ofs->table_id = fs->table_id;
2027         ofs->pad = 0;
2028         ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
2029         ofs->duration_sec = htonl(fs->duration_sec);
2030         ofs->duration_nsec = htonl(fs->duration_nsec);
2031         ofs->priority = htons(fs->priority);
2032         ofs->idle_timeout = htons(fs->idle_timeout);
2033         ofs->hard_timeout = htons(fs->hard_timeout);
2034         memset(ofs->pad2, 0, sizeof ofs->pad2);
2035         put_32aligned_be64(&ofs->cookie, fs->cookie);
2036         put_32aligned_be64(&ofs->packet_count,
2037                            htonll(unknown_to_zero(fs->packet_count)));
2038         put_32aligned_be64(&ofs->byte_count,
2039                            htonll(unknown_to_zero(fs->byte_count)));
2040     } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
2041         struct nx_flow_stats *nfs;
2042         int match_len;
2043
2044         ofpbuf_put_uninit(reply, sizeof *nfs);
2045         match_len = nx_put_match(reply, &fs->match, 0, 0);
2046         ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2047
2048         nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2049         nfs->length = htons(reply->size - start_ofs);
2050         nfs->table_id = fs->table_id;
2051         nfs->pad = 0;
2052         nfs->duration_sec = htonl(fs->duration_sec);
2053         nfs->duration_nsec = htonl(fs->duration_nsec);
2054         nfs->priority = htons(fs->priority);
2055         nfs->idle_timeout = htons(fs->idle_timeout);
2056         nfs->hard_timeout = htons(fs->hard_timeout);
2057         nfs->idle_age = htons(fs->idle_age < 0 ? 0
2058                               : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2059                               : UINT16_MAX);
2060         nfs->hard_age = htons(fs->hard_age < 0 ? 0
2061                               : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2062                               : UINT16_MAX);
2063         nfs->match_len = htons(match_len);
2064         nfs->cookie = fs->cookie;
2065         nfs->packet_count = htonll(fs->packet_count);
2066         nfs->byte_count = htonll(fs->byte_count);
2067     } else {
2068         NOT_REACHED();
2069     }
2070
2071     ofpmp_postappend(replies, start_ofs);
2072 }
2073
2074 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2075  * NXST_AGGREGATE reply matching 'request', and returns the message. */
2076 struct ofpbuf *
2077 ofputil_encode_aggregate_stats_reply(
2078     const struct ofputil_aggregate_stats *stats,
2079     const struct ofp_header *request)
2080 {
2081     struct ofp_aggregate_stats_reply *asr;
2082     uint64_t packet_count;
2083     uint64_t byte_count;
2084     struct ofpbuf *msg;
2085     enum ofpraw raw;
2086
2087     ofpraw_decode(&raw, request);
2088     if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
2089         packet_count = unknown_to_zero(stats->packet_count);
2090         byte_count = unknown_to_zero(stats->byte_count);
2091     } else {
2092         packet_count = stats->packet_count;
2093         byte_count = stats->byte_count;
2094     }
2095
2096     msg = ofpraw_alloc_stats_reply(request, 0);
2097     asr = ofpbuf_put_zeros(msg, sizeof *asr);
2098     put_32aligned_be64(&asr->packet_count, htonll(packet_count));
2099     put_32aligned_be64(&asr->byte_count, htonll(byte_count));
2100     asr->flow_count = htonl(stats->flow_count);
2101
2102     return msg;
2103 }
2104
2105 enum ofperr
2106 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
2107                                      const struct ofp_header *reply)
2108 {
2109     struct ofp_aggregate_stats_reply *asr;
2110     struct ofpbuf msg;
2111
2112     ofpbuf_use_const(&msg, reply, ntohs(reply->length));
2113     ofpraw_pull_assert(&msg);
2114
2115     asr = msg.l3;
2116     stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
2117     stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
2118     stats->flow_count = ntohl(asr->flow_count);
2119
2120     return 0;
2121 }
2122
2123 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2124  * abstract ofputil_flow_removed in 'fr'.  Returns 0 if successful, otherwise
2125  * an OpenFlow error code. */
2126 enum ofperr
2127 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2128                             const struct ofp_header *oh)
2129 {
2130     enum ofpraw raw;
2131     struct ofpbuf b;
2132
2133     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2134     raw = ofpraw_pull_assert(&b);
2135     if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
2136         const struct ofp12_flow_removed *ofr;
2137         enum ofperr error;
2138
2139         ofr = ofpbuf_pull(&b, sizeof *ofr);
2140
2141         error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
2142         if (error) {
2143             return error;
2144         }
2145
2146         fr->priority = ntohs(ofr->priority);
2147         fr->cookie = ofr->cookie;
2148         fr->reason = ofr->reason;
2149         fr->table_id = ofr->table_id;
2150         fr->duration_sec = ntohl(ofr->duration_sec);
2151         fr->duration_nsec = ntohl(ofr->duration_nsec);
2152         fr->idle_timeout = ntohs(ofr->idle_timeout);
2153         fr->hard_timeout = ntohs(ofr->hard_timeout);
2154         fr->packet_count = ntohll(ofr->packet_count);
2155         fr->byte_count = ntohll(ofr->byte_count);
2156     } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
2157         const struct ofp_flow_removed *ofr;
2158
2159         ofr = ofpbuf_pull(&b, sizeof *ofr);
2160
2161         ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
2162         fr->priority = ntohs(ofr->priority);
2163         fr->cookie = ofr->cookie;
2164         fr->reason = ofr->reason;
2165         fr->table_id = 255;
2166         fr->duration_sec = ntohl(ofr->duration_sec);
2167         fr->duration_nsec = ntohl(ofr->duration_nsec);
2168         fr->idle_timeout = ntohs(ofr->idle_timeout);
2169         fr->hard_timeout = 0;
2170         fr->packet_count = ntohll(ofr->packet_count);
2171         fr->byte_count = ntohll(ofr->byte_count);
2172     } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
2173         struct nx_flow_removed *nfr;
2174         enum ofperr error;
2175
2176         nfr = ofpbuf_pull(&b, sizeof *nfr);
2177         error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
2178                               NULL, NULL);
2179         if (error) {
2180             return error;
2181         }
2182         if (b.size) {
2183             return OFPERR_OFPBRC_BAD_LEN;
2184         }
2185
2186         fr->priority = ntohs(nfr->priority);
2187         fr->cookie = nfr->cookie;
2188         fr->reason = nfr->reason;
2189         fr->table_id = 255;
2190         fr->duration_sec = ntohl(nfr->duration_sec);
2191         fr->duration_nsec = ntohl(nfr->duration_nsec);
2192         fr->idle_timeout = ntohs(nfr->idle_timeout);
2193         fr->hard_timeout = 0;
2194         fr->packet_count = ntohll(nfr->packet_count);
2195         fr->byte_count = ntohll(nfr->byte_count);
2196     } else {
2197         NOT_REACHED();
2198     }
2199
2200     return 0;
2201 }
2202
2203 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2204  * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2205  * message. */
2206 struct ofpbuf *
2207 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2208                             enum ofputil_protocol protocol)
2209 {
2210     struct ofpbuf *msg;
2211
2212     switch (protocol) {
2213     case OFPUTIL_P_OF12_OXM: {
2214         struct ofp12_flow_removed *ofr;
2215
2216         msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
2217                                ofputil_protocol_to_ofp_version(protocol),
2218                                htonl(0), NXM_TYPICAL_LEN);
2219         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2220         ofr->cookie = fr->cookie;
2221         ofr->priority = htons(fr->priority);
2222         ofr->reason = fr->reason;
2223         ofr->table_id = fr->table_id;
2224         ofr->duration_sec = htonl(fr->duration_sec);
2225         ofr->duration_nsec = htonl(fr->duration_nsec);
2226         ofr->idle_timeout = htons(fr->idle_timeout);
2227         ofr->hard_timeout = htons(fr->hard_timeout);
2228         ofr->packet_count = htonll(fr->packet_count);
2229         ofr->byte_count = htonll(fr->byte_count);
2230         oxm_put_match(msg, &fr->match);
2231         break;
2232     }
2233
2234     case OFPUTIL_P_OF10_STD:
2235     case OFPUTIL_P_OF10_STD_TID: {
2236         struct ofp_flow_removed *ofr;
2237
2238         msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2239                                htonl(0), 0);
2240         ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2241         ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2242         ofr->cookie = fr->cookie;
2243         ofr->priority = htons(fr->priority);
2244         ofr->reason = fr->reason;
2245         ofr->duration_sec = htonl(fr->duration_sec);
2246         ofr->duration_nsec = htonl(fr->duration_nsec);
2247         ofr->idle_timeout = htons(fr->idle_timeout);
2248         ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2249         ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2250         break;
2251     }
2252
2253     case OFPUTIL_P_OF10_NXM:
2254     case OFPUTIL_P_OF10_NXM_TID: {
2255         struct nx_flow_removed *nfr;
2256         int match_len;
2257
2258         msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2259                                htonl(0), NXM_TYPICAL_LEN);
2260         nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2261         match_len = nx_put_match(msg, &fr->match, 0, 0);
2262
2263         nfr = msg->l3;
2264         nfr->cookie = fr->cookie;
2265         nfr->priority = htons(fr->priority);
2266         nfr->reason = fr->reason;
2267         nfr->duration_sec = htonl(fr->duration_sec);
2268         nfr->duration_nsec = htonl(fr->duration_nsec);
2269         nfr->idle_timeout = htons(fr->idle_timeout);
2270         nfr->match_len = htons(match_len);
2271         nfr->packet_count = htonll(fr->packet_count);
2272         nfr->byte_count = htonll(fr->byte_count);
2273         break;
2274     }
2275
2276     default:
2277         NOT_REACHED();
2278     }
2279
2280     return msg;
2281 }
2282
2283 static void
2284 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2285                                 struct match *match, struct ofpbuf *b)
2286 {
2287     pin->packet = b->data;
2288     pin->packet_len = b->size;
2289
2290     pin->fmd.in_port = match->flow.in_port;
2291     pin->fmd.tun_id = match->flow.tunnel.tun_id;
2292     pin->fmd.metadata = match->flow.metadata;
2293     memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2294 }
2295
2296 enum ofperr
2297 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2298                          const struct ofp_header *oh)
2299 {
2300     enum ofpraw raw;
2301     struct ofpbuf b;
2302
2303     memset(pin, 0, sizeof *pin);
2304
2305     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2306     raw = ofpraw_pull_assert(&b);
2307     if (raw == OFPRAW_OFPT12_PACKET_IN) {
2308         const struct ofp12_packet_in *opi;
2309         struct match match;
2310         int error;
2311
2312         opi = ofpbuf_pull(&b, sizeof *opi);
2313         error = oxm_pull_match_loose(&b, &match);
2314         if (error) {
2315             return error;
2316         }
2317
2318         if (!ofpbuf_try_pull(&b, 2)) {
2319             return OFPERR_OFPBRC_BAD_LEN;
2320         }
2321
2322         pin->reason = opi->reason;
2323         pin->table_id = opi->table_id;
2324
2325         pin->buffer_id = ntohl(opi->buffer_id);
2326         pin->total_len = ntohs(opi->total_len);
2327
2328         ofputil_decode_packet_in_finish(pin, &match, &b);
2329     } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2330         const struct ofp_packet_in *opi;
2331
2332         opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2333
2334         pin->packet = opi->data;
2335         pin->packet_len = b.size;
2336
2337         pin->fmd.in_port = ntohs(opi->in_port);
2338         pin->reason = opi->reason;
2339         pin->buffer_id = ntohl(opi->buffer_id);
2340         pin->total_len = ntohs(opi->total_len);
2341     } else if (raw == OFPRAW_NXT_PACKET_IN) {
2342         const struct nx_packet_in *npi;
2343         struct match match;
2344         int error;
2345
2346         npi = ofpbuf_pull(&b, sizeof *npi);
2347         error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2348                                     NULL);
2349         if (error) {
2350             return error;
2351         }
2352
2353         if (!ofpbuf_try_pull(&b, 2)) {
2354             return OFPERR_OFPBRC_BAD_LEN;
2355         }
2356
2357         pin->reason = npi->reason;
2358         pin->table_id = npi->table_id;
2359         pin->cookie = npi->cookie;
2360
2361         pin->buffer_id = ntohl(npi->buffer_id);
2362         pin->total_len = ntohs(npi->total_len);
2363
2364         ofputil_decode_packet_in_finish(pin, &match, &b);
2365     } else {
2366         NOT_REACHED();
2367     }
2368
2369     return 0;
2370 }
2371
2372 static void
2373 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2374                            struct match *match)
2375 {
2376     int i;
2377
2378     match_init_catchall(match);
2379     if (pin->fmd.tun_id != htonll(0)) {
2380         match_set_tun_id(match, pin->fmd.tun_id);
2381     }
2382     if (pin->fmd.metadata != htonll(0)) {
2383         match_set_metadata(match, pin->fmd.metadata);
2384     }
2385
2386     for (i = 0; i < FLOW_N_REGS; i++) {
2387         if (pin->fmd.regs[i]) {
2388             match_set_reg(match, i, pin->fmd.regs[i]);
2389         }
2390     }
2391
2392     match_set_in_port(match, pin->fmd.in_port);
2393 }
2394
2395 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2396  * in the format specified by 'packet_in_format'.  */
2397 struct ofpbuf *
2398 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2399                          enum ofputil_protocol protocol,
2400                          enum nx_packet_in_format packet_in_format)
2401 {
2402     size_t send_len = MIN(pin->send_len, pin->packet_len);
2403     struct ofpbuf *packet;
2404
2405     /* Add OFPT_PACKET_IN. */
2406     if (protocol == OFPUTIL_P_OF12_OXM) {
2407         struct ofp12_packet_in *opi;
2408         struct match match;
2409
2410         ofputil_packet_in_to_match(pin, &match);
2411
2412         /* The final argument is just an estimate of the space required. */
2413         packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2414                                   htonl(0), (sizeof(struct flow_metadata) * 2
2415                                              + 2 + send_len));
2416         ofpbuf_put_zeros(packet, sizeof *opi);
2417         oxm_put_match(packet, &match);
2418         ofpbuf_put_zeros(packet, 2);
2419         ofpbuf_put(packet, pin->packet, send_len);
2420
2421         opi = packet->l3;
2422         opi->buffer_id = htonl(pin->buffer_id);
2423         opi->total_len = htons(pin->total_len);
2424         opi->reason = pin->reason;
2425         opi->table_id = pin->table_id;
2426    } else if (packet_in_format == NXPIF_OPENFLOW10) {
2427         struct ofp_packet_in *opi;
2428
2429         packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2430                                   htonl(0), send_len);
2431         opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2432         opi->total_len = htons(pin->total_len);
2433         opi->in_port = htons(pin->fmd.in_port);
2434         opi->reason = pin->reason;
2435         opi->buffer_id = htonl(pin->buffer_id);
2436
2437         ofpbuf_put(packet, pin->packet, send_len);
2438     } else if (packet_in_format == NXPIF_NXM) {
2439         struct nx_packet_in *npi;
2440         struct match match;
2441         size_t match_len;
2442
2443         ofputil_packet_in_to_match(pin, &match);
2444
2445         /* The final argument is just an estimate of the space required. */
2446         packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2447                                   htonl(0), (sizeof(struct flow_metadata) * 2
2448                                              + 2 + send_len));
2449         ofpbuf_put_zeros(packet, sizeof *npi);
2450         match_len = nx_put_match(packet, &match, 0, 0);
2451         ofpbuf_put_zeros(packet, 2);
2452         ofpbuf_put(packet, pin->packet, send_len);
2453
2454         npi = packet->l3;
2455         npi->buffer_id = htonl(pin->buffer_id);
2456         npi->total_len = htons(pin->total_len);
2457         npi->reason = pin->reason;
2458         npi->table_id = pin->table_id;
2459         npi->cookie = pin->cookie;
2460         npi->match_len = htons(match_len);
2461     } else {
2462         NOT_REACHED();
2463     }
2464     ofpmsg_update_length(packet);
2465
2466     return packet;
2467 }
2468
2469 const char *
2470 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2471 {
2472     static char s[INT_STRLEN(int) + 1];
2473
2474     switch (reason) {
2475     case OFPR_NO_MATCH:
2476         return "no_match";
2477     case OFPR_ACTION:
2478         return "action";
2479     case OFPR_INVALID_TTL:
2480         return "invalid_ttl";
2481
2482     case OFPR_N_REASONS:
2483     default:
2484         sprintf(s, "%d", (int) reason);
2485         return s;
2486     }
2487 }
2488
2489 bool
2490 ofputil_packet_in_reason_from_string(const char *s,
2491                                      enum ofp_packet_in_reason *reason)
2492 {
2493     int i;
2494
2495     for (i = 0; i < OFPR_N_REASONS; i++) {
2496         if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2497             *reason = i;
2498             return true;
2499         }
2500     }
2501     return false;
2502 }
2503
2504 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2505  * 'po'.
2506  *
2507  * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2508  * message's actions.  The caller must initialize 'ofpacts' and retains
2509  * ownership of it.  'po->ofpacts' will point into the 'ofpacts' buffer.
2510  *
2511  * Returns 0 if successful, otherwise an OFPERR_* value. */
2512 enum ofperr
2513 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2514                           const struct ofp_header *oh,
2515                           struct ofpbuf *ofpacts)
2516 {
2517     enum ofpraw raw;
2518     struct ofpbuf b;
2519
2520     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2521     raw = ofpraw_pull_assert(&b);
2522
2523     if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2524         enum ofperr error;
2525         const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2526
2527         po->buffer_id = ntohl(opo->buffer_id);
2528         error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2529         if (error) {
2530             return error;
2531         }
2532
2533         error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2534                                                 ofpacts);
2535         if (error) {
2536             return error;
2537         }
2538     } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2539         enum ofperr error;
2540         const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2541
2542         po->buffer_id = ntohl(opo->buffer_id);
2543         po->in_port = ntohs(opo->in_port);
2544
2545         error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2546         if (error) {
2547             return error;
2548         }
2549     } else {
2550         NOT_REACHED();
2551     }
2552
2553     if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2554         && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2555         VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2556                      po->in_port);
2557         return OFPERR_OFPBRC_BAD_PORT;
2558     }
2559
2560     po->ofpacts = ofpacts->data;
2561     po->ofpacts_len = ofpacts->size;
2562
2563     if (po->buffer_id == UINT32_MAX) {
2564         po->packet = b.data;
2565         po->packet_len = b.size;
2566     } else {
2567         po->packet = NULL;
2568         po->packet_len = 0;
2569     }
2570
2571     return 0;
2572 }
2573 \f
2574 /* ofputil_phy_port */
2575
2576 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2577 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);  /* bit 0 */
2578 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);  /* bit 1 */
2579 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD); /* bit 2 */
2580 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD); /* bit 3 */
2581 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);   /* bit 4 */
2582 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);   /* bit 5 */
2583 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);  /* bit 6 */
2584
2585 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2586 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2587 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2588 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2589 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2590 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2591
2592 static enum netdev_features
2593 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2594 {
2595     uint32_t ofp10 = ntohl(ofp10_);
2596     return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2597 }
2598
2599 static ovs_be32
2600 netdev_port_features_to_ofp10(enum netdev_features features)
2601 {
2602     return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2603 }
2604
2605 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD    == OFPPF_10MB_HD);     /* bit 0 */
2606 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD    == OFPPF_10MB_FD);     /* bit 1 */
2607 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD   == OFPPF_100MB_HD);    /* bit 2 */
2608 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD   == OFPPF_100MB_FD);    /* bit 3 */
2609 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD     == OFPPF_1GB_HD);      /* bit 4 */
2610 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD     == OFPPF_1GB_FD);      /* bit 5 */
2611 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD    == OFPPF_10GB_FD);     /* bit 6 */
2612 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD    == OFPPF11_40GB_FD);   /* bit 7 */
2613 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD   == OFPPF11_100GB_FD);  /* bit 8 */
2614 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD     == OFPPF11_1TB_FD);    /* bit 9 */
2615 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER      == OFPPF11_OTHER);     /* bit 10 */
2616 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER     == OFPPF11_COPPER);    /* bit 11 */
2617 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER      == OFPPF11_FIBER);     /* bit 12 */
2618 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG    == OFPPF11_AUTONEG);   /* bit 13 */
2619 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE      == OFPPF11_PAUSE);     /* bit 14 */
2620 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2621
2622 static enum netdev_features
2623 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2624 {
2625     return ntohl(ofp11) & 0xffff;
2626 }
2627
2628 static ovs_be32
2629 netdev_port_features_to_ofp11(enum netdev_features features)
2630 {
2631     return htonl(features & 0xffff);
2632 }
2633
2634 static enum ofperr
2635 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2636                               const struct ofp10_phy_port *opp)
2637 {
2638     memset(pp, 0, sizeof *pp);
2639
2640     pp->port_no = ntohs(opp->port_no);
2641     memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2642     ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2643
2644     pp->config = ntohl(opp->config) & OFPPC10_ALL;
2645     pp->state = ntohl(opp->state) & OFPPS10_ALL;
2646
2647     pp->curr = netdev_port_features_from_ofp10(opp->curr);
2648     pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2649     pp->supported = netdev_port_features_from_ofp10(opp->supported);
2650     pp->peer = netdev_port_features_from_ofp10(opp->peer);
2651
2652     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2653     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2654
2655     return 0;
2656 }
2657
2658 static enum ofperr
2659 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2660                           const struct ofp11_port *op)
2661 {
2662     enum ofperr error;
2663
2664     memset(pp, 0, sizeof *pp);
2665
2666     error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2667     if (error) {
2668         return error;
2669     }
2670     memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2671     ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2672
2673     pp->config = ntohl(op->config) & OFPPC11_ALL;
2674     pp->state = ntohl(op->state) & OFPPC11_ALL;
2675
2676     pp->curr = netdev_port_features_from_ofp11(op->curr);
2677     pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2678     pp->supported = netdev_port_features_from_ofp11(op->supported);
2679     pp->peer = netdev_port_features_from_ofp11(op->peer);
2680
2681     pp->curr_speed = ntohl(op->curr_speed);
2682     pp->max_speed = ntohl(op->max_speed);
2683
2684     return 0;
2685 }
2686
2687 static size_t
2688 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2689 {
2690     switch (ofp_version) {
2691     case OFP10_VERSION:
2692         return sizeof(struct ofp10_phy_port);
2693     case OFP11_VERSION:
2694     case OFP12_VERSION:
2695         return sizeof(struct ofp11_port);
2696     default:
2697         NOT_REACHED();
2698     }
2699 }
2700
2701 static void
2702 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2703                               struct ofp10_phy_port *opp)
2704 {
2705     memset(opp, 0, sizeof *opp);
2706
2707     opp->port_no = htons(pp->port_no);
2708     memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2709     ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2710
2711     opp->config = htonl(pp->config & OFPPC10_ALL);
2712     opp->state = htonl(pp->state & OFPPS10_ALL);
2713
2714     opp->curr = netdev_port_features_to_ofp10(pp->curr);
2715     opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2716     opp->supported = netdev_port_features_to_ofp10(pp->supported);
2717     opp->peer = netdev_port_features_to_ofp10(pp->peer);
2718 }
2719
2720 static void
2721 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2722                           struct ofp11_port *op)
2723 {
2724     memset(op, 0, sizeof *op);
2725
2726     op->port_no = ofputil_port_to_ofp11(pp->port_no);
2727     memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2728     ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2729
2730     op->config = htonl(pp->config & OFPPC11_ALL);
2731     op->state = htonl(pp->state & OFPPS11_ALL);
2732
2733     op->curr = netdev_port_features_to_ofp11(pp->curr);
2734     op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2735     op->supported = netdev_port_features_to_ofp11(pp->supported);
2736     op->peer = netdev_port_features_to_ofp11(pp->peer);
2737
2738     op->curr_speed = htonl(pp->curr_speed);
2739     op->max_speed = htonl(pp->max_speed);
2740 }
2741
2742 static void
2743 ofputil_put_phy_port(enum ofp_version ofp_version,
2744                      const struct ofputil_phy_port *pp, struct ofpbuf *b)
2745 {
2746     switch (ofp_version) {
2747     case OFP10_VERSION: {
2748         struct ofp10_phy_port *opp;
2749         if (b->size + sizeof *opp <= UINT16_MAX) {
2750             opp = ofpbuf_put_uninit(b, sizeof *opp);
2751             ofputil_encode_ofp10_phy_port(pp, opp);
2752         }
2753         break;
2754     }
2755
2756     case OFP11_VERSION:
2757     case OFP12_VERSION: {
2758         struct ofp11_port *op;
2759         if (b->size + sizeof *op <= UINT16_MAX) {
2760             op = ofpbuf_put_uninit(b, sizeof *op);
2761             ofputil_encode_ofp11_port(pp, op);
2762         }
2763         break;
2764     }
2765
2766     default:
2767         NOT_REACHED();
2768     }
2769 }
2770
2771 void
2772 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2773                                      const struct ofputil_phy_port *pp,
2774                                      struct list *replies)
2775 {
2776     switch (ofp_version) {
2777     case OFP10_VERSION: {
2778         struct ofp10_phy_port *opp;
2779
2780         opp = ofpmp_append(replies, sizeof *opp);
2781         ofputil_encode_ofp10_phy_port(pp, opp);
2782         break;
2783     }
2784
2785     case OFP11_VERSION:
2786     case OFP12_VERSION: {
2787         struct ofp11_port *op;
2788
2789         op = ofpmp_append(replies, sizeof *op);
2790         ofputil_encode_ofp11_port(pp, op);
2791         break;
2792     }
2793
2794     default:
2795       NOT_REACHED();
2796     }
2797 }
2798 \f
2799 /* ofputil_switch_features */
2800
2801 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2802                      OFPC_IP_REASM | OFPC_QUEUE_STATS)
2803 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2804 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2805 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2806 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2807 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2808 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2809
2810 struct ofputil_action_bit_translation {
2811     enum ofputil_action_bitmap ofputil_bit;
2812     int of_bit;
2813 };
2814
2815 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2816     { OFPUTIL_A_OUTPUT,       OFPAT10_OUTPUT },
2817     { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2818     { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2819     { OFPUTIL_A_STRIP_VLAN,   OFPAT10_STRIP_VLAN },
2820     { OFPUTIL_A_SET_DL_SRC,   OFPAT10_SET_DL_SRC },
2821     { OFPUTIL_A_SET_DL_DST,   OFPAT10_SET_DL_DST },
2822     { OFPUTIL_A_SET_NW_SRC,   OFPAT10_SET_NW_SRC },
2823     { OFPUTIL_A_SET_NW_DST,   OFPAT10_SET_NW_DST },
2824     { OFPUTIL_A_SET_NW_TOS,   OFPAT10_SET_NW_TOS },
2825     { OFPUTIL_A_SET_TP_SRC,   OFPAT10_SET_TP_SRC },
2826     { OFPUTIL_A_SET_TP_DST,   OFPAT10_SET_TP_DST },
2827     { OFPUTIL_A_ENQUEUE,      OFPAT10_ENQUEUE },
2828     { 0, 0 },
2829 };
2830
2831 static enum ofputil_action_bitmap
2832 decode_action_bits(ovs_be32 of_actions,
2833                    const struct ofputil_action_bit_translation *x)
2834 {
2835     enum ofputil_action_bitmap ofputil_actions;
2836
2837     ofputil_actions = 0;
2838     for (; x->ofputil_bit; x++) {
2839         if (of_actions & htonl(1u << x->of_bit)) {
2840             ofputil_actions |= x->ofputil_bit;
2841         }
2842     }
2843     return ofputil_actions;
2844 }
2845
2846 static uint32_t
2847 ofputil_capabilities_mask(enum ofp_version ofp_version)
2848 {
2849     /* Handle capabilities whose bit is unique for all Open Flow versions */
2850     switch (ofp_version) {
2851     case OFP10_VERSION:
2852     case OFP11_VERSION:
2853         return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2854     case OFP12_VERSION:
2855         return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2856     default:
2857         /* Caller needs to check osf->header.version itself */
2858         return 0;
2859     }
2860 }
2861
2862 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2863  * abstract representation in '*features'.  Initializes '*b' to iterate over
2864  * the OpenFlow port structures following 'osf' with later calls to
2865  * ofputil_pull_phy_port().  Returns 0 if successful, otherwise an
2866  * OFPERR_* value.  */
2867 enum ofperr
2868 ofputil_decode_switch_features(const struct ofp_header *oh,
2869                                struct ofputil_switch_features *features,
2870                                struct ofpbuf *b)
2871 {
2872     const struct ofp_switch_features *osf;
2873     enum ofpraw raw;
2874
2875     ofpbuf_use_const(b, oh, ntohs(oh->length));
2876     raw = ofpraw_pull_assert(b);
2877
2878     osf = ofpbuf_pull(b, sizeof *osf);
2879     features->datapath_id = ntohll(osf->datapath_id);
2880     features->n_buffers = ntohl(osf->n_buffers);
2881     features->n_tables = osf->n_tables;
2882
2883     features->capabilities = ntohl(osf->capabilities) &
2884         ofputil_capabilities_mask(oh->version);
2885
2886     if (b->size % ofputil_get_phy_port_size(oh->version)) {
2887         return OFPERR_OFPBRC_BAD_LEN;
2888     }
2889
2890     if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2891         if (osf->capabilities & htonl(OFPC10_STP)) {
2892             features->capabilities |= OFPUTIL_C_STP;
2893         }
2894         features->actions = decode_action_bits(osf->actions, of10_action_bits);
2895     } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2896         if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2897             features->capabilities |= OFPUTIL_C_GROUP_STATS;
2898         }
2899         features->actions = 0;
2900     } else {
2901         return OFPERR_OFPBRC_BAD_VERSION;
2902     }
2903
2904     return 0;
2905 }
2906
2907 /* Returns true if the maximum number of ports are in 'oh'. */
2908 static bool
2909 max_ports_in_features(const struct ofp_header *oh)
2910 {
2911     size_t pp_size = ofputil_get_phy_port_size(oh->version);
2912     return ntohs(oh->length) + pp_size > UINT16_MAX;
2913 }
2914
2915 /* Given a buffer 'b' that contains a Features Reply message, checks if
2916  * it contains the maximum number of ports that will fit.  If so, it
2917  * returns true and removes the ports from the message.  The caller
2918  * should then send an OFPST_PORT_DESC stats request to get the ports,
2919  * since the switch may have more ports than could be represented in the
2920  * Features Reply.  Otherwise, returns false.
2921  */
2922 bool
2923 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2924 {
2925     struct ofp_header *oh = b->data;
2926
2927     if (max_ports_in_features(oh)) {
2928         /* Remove all the ports. */
2929         b->size = (sizeof(struct ofp_header)
2930                    + sizeof(struct ofp_switch_features));
2931         ofpmsg_update_length(b);
2932
2933         return true;
2934     }
2935
2936     return false;
2937 }
2938
2939 static ovs_be32
2940 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2941                    const struct ofputil_action_bit_translation *x)
2942 {
2943     uint32_t of_actions;
2944
2945     of_actions = 0;
2946     for (; x->ofputil_bit; x++) {
2947         if (ofputil_actions & x->ofputil_bit) {
2948             of_actions |= 1 << x->of_bit;
2949         }
2950     }
2951     return htonl(of_actions);
2952 }
2953
2954 /* Returns a buffer owned by the caller that encodes 'features' in the format
2955  * required by 'protocol' with the given 'xid'.  The caller should append port
2956  * information to the buffer with subsequent calls to
2957  * ofputil_put_switch_features_port(). */
2958 struct ofpbuf *
2959 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2960                                enum ofputil_protocol protocol, ovs_be32 xid)
2961 {
2962     struct ofp_switch_features *osf;
2963     struct ofpbuf *b;
2964     enum ofp_version version;
2965     enum ofpraw raw;
2966
2967     version = ofputil_protocol_to_ofp_version(protocol);
2968     switch (version) {
2969     case OFP10_VERSION:
2970         raw = OFPRAW_OFPT10_FEATURES_REPLY;
2971         break;
2972     case OFP11_VERSION:
2973     case OFP12_VERSION:
2974         raw = OFPRAW_OFPT11_FEATURES_REPLY;
2975         break;
2976     default:
2977         NOT_REACHED();
2978     }
2979     b = ofpraw_alloc_xid(raw, version, xid, 0);
2980     osf = ofpbuf_put_zeros(b, sizeof *osf);
2981     osf->datapath_id = htonll(features->datapath_id);
2982     osf->n_buffers = htonl(features->n_buffers);
2983     osf->n_tables = features->n_tables;
2984
2985     osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2986     osf->capabilities = htonl(features->capabilities &
2987                               ofputil_capabilities_mask(version));
2988     switch (version) {
2989     case OFP10_VERSION:
2990         if (features->capabilities & OFPUTIL_C_STP) {
2991             osf->capabilities |= htonl(OFPC10_STP);
2992         }
2993         osf->actions = encode_action_bits(features->actions, of10_action_bits);
2994         break;
2995     case OFP11_VERSION:
2996     case OFP12_VERSION:
2997         if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2998             osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2999         }
3000         break;
3001     default:
3002         NOT_REACHED();
3003     }
3004
3005     return b;
3006 }
3007
3008 /* Encodes 'pp' into the format required by the switch_features message already
3009  * in 'b', which should have been returned by ofputil_encode_switch_features(),
3010  * and appends the encoded version to 'b'. */
3011 void
3012 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
3013                                  struct ofpbuf *b)
3014 {
3015     const struct ofp_header *oh = b->data;
3016
3017     ofputil_put_phy_port(oh->version, pp, b);
3018 }
3019 \f
3020 /* ofputil_port_status */
3021
3022 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
3023  * in '*ps'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3024 enum ofperr
3025 ofputil_decode_port_status(const struct ofp_header *oh,
3026                            struct ofputil_port_status *ps)
3027 {
3028     const struct ofp_port_status *ops;
3029     struct ofpbuf b;
3030     int retval;
3031
3032     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3033     ofpraw_pull_assert(&b);
3034     ops = ofpbuf_pull(&b, sizeof *ops);
3035
3036     if (ops->reason != OFPPR_ADD &&
3037         ops->reason != OFPPR_DELETE &&
3038         ops->reason != OFPPR_MODIFY) {
3039         return OFPERR_NXBRC_BAD_REASON;
3040     }
3041     ps->reason = ops->reason;
3042
3043     retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
3044     assert(retval != EOF);
3045     return retval;
3046 }
3047
3048 /* Converts the abstract form of a "port status" message in '*ps' into an
3049  * OpenFlow message suitable for 'protocol', and returns that encoded form in
3050  * a buffer owned by the caller. */
3051 struct ofpbuf *
3052 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3053                            enum ofputil_protocol protocol)
3054 {
3055     struct ofp_port_status *ops;
3056     struct ofpbuf *b;
3057     enum ofp_version version;
3058     enum ofpraw raw;
3059
3060     version = ofputil_protocol_to_ofp_version(protocol);
3061     switch (version) {
3062     case OFP10_VERSION:
3063         raw = OFPRAW_OFPT10_PORT_STATUS;
3064         break;
3065
3066     case OFP11_VERSION:
3067     case OFP12_VERSION:
3068         raw = OFPRAW_OFPT11_PORT_STATUS;
3069         break;
3070
3071     default:
3072         NOT_REACHED();
3073     }
3074
3075     b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
3076     ops = ofpbuf_put_zeros(b, sizeof *ops);
3077     ops->reason = ps->reason;
3078     ofputil_put_phy_port(version, &ps->desc, b);
3079     ofpmsg_update_length(b);
3080     return b;
3081 }
3082 \f
3083 /* ofputil_port_mod */
3084
3085 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3086  * '*pm'.  Returns 0 if successful, otherwise an OFPERR_* value. */
3087 enum ofperr
3088 ofputil_decode_port_mod(const struct ofp_header *oh,
3089                         struct ofputil_port_mod *pm)
3090 {
3091     enum ofpraw raw;
3092     struct ofpbuf b;
3093
3094     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3095     raw = ofpraw_pull_assert(&b);
3096
3097     if (raw == OFPRAW_OFPT10_PORT_MOD) {
3098         const struct ofp10_port_mod *opm = b.data;
3099
3100         pm->port_no = ntohs(opm->port_no);
3101         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3102         pm->config = ntohl(opm->config) & OFPPC10_ALL;
3103         pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3104         pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3105     } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
3106         const struct ofp11_port_mod *opm = b.data;
3107         enum ofperr error;
3108
3109         error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3110         if (error) {
3111             return error;
3112         }
3113
3114         memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3115         pm->config = ntohl(opm->config) & OFPPC11_ALL;
3116         pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3117         pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3118     } else {
3119         return OFPERR_OFPBRC_BAD_TYPE;
3120     }
3121
3122     pm->config &= pm->mask;
3123     return 0;
3124 }
3125
3126 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3127  * message suitable for 'protocol', and returns that encoded form in a buffer
3128  * owned by the caller. */
3129 struct ofpbuf *
3130 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3131                         enum ofputil_protocol protocol)
3132 {
3133     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3134     struct ofpbuf *b;
3135
3136     switch (ofp_version) {
3137     case OFP10_VERSION: {
3138         struct ofp10_port_mod *opm;
3139
3140         b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
3141         opm = ofpbuf_put_zeros(b, sizeof *opm);
3142         opm->port_no = htons(pm->port_no);
3143         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3144         opm->config = htonl(pm->config & OFPPC10_ALL);
3145         opm->mask = htonl(pm->mask & OFPPC10_ALL);
3146         opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3147         break;
3148     }
3149
3150     case OFP11_VERSION:
3151     case OFP12_VERSION: {
3152         struct ofp11_port_mod *opm;
3153
3154         b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
3155         opm = ofpbuf_put_zeros(b, sizeof *opm);
3156         opm->port_no = ofputil_port_to_ofp11(pm->port_no);
3157         memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3158         opm->config = htonl(pm->config & OFPPC11_ALL);
3159         opm->mask = htonl(pm->mask & OFPPC11_ALL);
3160         opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3161         break;
3162     }
3163
3164     default:
3165         NOT_REACHED();
3166     }
3167
3168     return b;
3169 }
3170 \f
3171 /* Table stats. */
3172
3173 static void
3174 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
3175                               struct ofpbuf *buf)
3176 {
3177     struct wc_map {
3178         enum ofp_flow_wildcards wc10;
3179         enum oxm12_ofb_match_fields mf12;
3180     };
3181
3182     static const struct wc_map wc_map[] = {
3183         { OFPFW10_IN_PORT,     OFPXMT12_OFB_IN_PORT },
3184         { OFPFW10_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
3185         { OFPFW10_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
3186         { OFPFW10_DL_DST,      OFPXMT12_OFB_ETH_DST},
3187         { OFPFW10_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
3188         { OFPFW10_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
3189         { OFPFW10_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
3190         { OFPFW10_TP_DST,      OFPXMT12_OFB_TCP_DST },
3191         { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
3192         { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
3193         { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3194         { OFPFW10_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
3195     };
3196
3197     struct ofp10_table_stats *out;
3198     const struct wc_map *p;
3199
3200     out = ofpbuf_put_uninit(buf, sizeof *out);
3201     out->table_id = in->table_id;
3202     strcpy(out->name, in->name);
3203     out->wildcards = 0;
3204     for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
3205         if (in->wildcards & htonll(1ULL << p->mf12)) {
3206             out->wildcards |= htonl(p->wc10);
3207         }
3208     }
3209     out->max_entries = in->max_entries;
3210     out->active_count = in->active_count;
3211     put_32aligned_be64(&out->lookup_count, in->lookup_count);
3212     put_32aligned_be64(&out->matched_count, in->matched_count);
3213 }
3214
3215 static ovs_be32
3216 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
3217 {
3218     struct map {
3219         enum ofp11_flow_match_fields fmf11;
3220         enum oxm12_ofb_match_fields mf12;
3221     };
3222
3223     static const struct map map[] = {
3224         { OFPFMF11_IN_PORT,     OFPXMT12_OFB_IN_PORT },
3225         { OFPFMF11_DL_VLAN,     OFPXMT12_OFB_VLAN_VID },
3226         { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
3227         { OFPFMF11_DL_TYPE,     OFPXMT12_OFB_ETH_TYPE },
3228         { OFPFMF11_NW_TOS,      OFPXMT12_OFB_IP_DSCP },
3229         { OFPFMF11_NW_PROTO,    OFPXMT12_OFB_IP_PROTO },
3230         { OFPFMF11_TP_SRC,      OFPXMT12_OFB_TCP_SRC },
3231         { OFPFMF11_TP_DST,      OFPXMT12_OFB_TCP_DST },
3232         { OFPFMF11_MPLS_LABEL,  OFPXMT12_OFB_MPLS_LABEL },
3233         { OFPFMF11_MPLS_TC,     OFPXMT12_OFB_MPLS_TC },
3234         /* I don't know what OFPFMF11_TYPE means. */
3235         { OFPFMF11_DL_SRC,      OFPXMT12_OFB_ETH_SRC },
3236         { OFPFMF11_DL_DST,      OFPXMT12_OFB_ETH_DST },
3237         { OFPFMF11_NW_SRC,      OFPXMT12_OFB_IPV4_SRC },
3238         { OFPFMF11_NW_DST,      OFPXMT12_OFB_IPV4_DST },
3239         { OFPFMF11_METADATA,    OFPXMT12_OFB_METADATA },
3240     };
3241
3242     const struct map *p;
3243     uint32_t fmf11;
3244
3245     fmf11 = 0;
3246     for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3247         if (oxm12 & htonll(1ULL << p->mf12)) {
3248             fmf11 |= p->fmf11;
3249         }
3250     }
3251     return htonl(fmf11);
3252 }
3253
3254 static void
3255 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3256                               struct ofpbuf *buf)
3257 {
3258     struct ofp11_table_stats *out;
3259
3260     out = ofpbuf_put_uninit(buf, sizeof *out);
3261     out->table_id = in->table_id;
3262     strcpy(out->name, in->name);
3263     out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3264     out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3265     out->instructions = in->instructions;
3266     out->write_actions = in->write_actions;
3267     out->apply_actions = in->apply_actions;
3268     out->config = in->config;
3269     out->max_entries = in->max_entries;
3270     out->active_count = in->active_count;
3271     out->lookup_count = in->lookup_count;
3272     out->matched_count = in->matched_count;
3273 }
3274
3275 struct ofpbuf *
3276 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3277                                  const struct ofp_header *request)
3278 {
3279     struct ofpbuf *reply;
3280     int i;
3281
3282     reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3283
3284     switch ((enum ofp_version) request->version) {
3285     case OFP10_VERSION:
3286         for (i = 0; i < n; i++) {
3287             ofputil_put_ofp10_table_stats(&stats[i], reply);
3288         }
3289         break;
3290
3291     case OFP11_VERSION:
3292         for (i = 0; i < n; i++) {
3293             ofputil_put_ofp11_table_stats(&stats[i], reply);
3294         }
3295         break;
3296
3297     case OFP12_VERSION:
3298         ofpbuf_put(reply, stats, n * sizeof *stats);
3299         break;
3300
3301     default:
3302         NOT_REACHED();
3303     }
3304
3305     return reply;
3306 }
3307 \f
3308 /* ofputil_flow_monitor_request */
3309
3310 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3311  * ofputil_flow_monitor_request in 'rq'.
3312  *
3313  * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3314  * message.  Calling this function multiple times for a single 'msg' iterates
3315  * through the requests.  The caller must initially leave 'msg''s layer
3316  * pointers null and not modify them between calls.
3317  *
3318  * Returns 0 if successful, EOF if no requests were left in this 'msg',
3319  * otherwise an OFPERR_* value. */
3320 int
3321 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3322                                     struct ofpbuf *msg)
3323 {
3324     struct nx_flow_monitor_request *nfmr;
3325     uint16_t flags;
3326
3327     if (!msg->l2) {
3328         msg->l2 = msg->data;
3329         ofpraw_pull_assert(msg);
3330     }
3331
3332     if (!msg->size) {
3333         return EOF;
3334     }
3335
3336     nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3337     if (!nfmr) {
3338         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3339                      "leftover bytes at end", msg->size);
3340         return OFPERR_OFPBRC_BAD_LEN;
3341     }
3342
3343     flags = ntohs(nfmr->flags);
3344     if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3345         || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3346                      | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3347         VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3348                      flags);
3349         return OFPERR_NXBRC_FM_BAD_FLAGS;
3350     }
3351
3352     if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3353         return OFPERR_NXBRC_MUST_BE_ZERO;
3354     }
3355
3356     rq->id = ntohl(nfmr->id);
3357     rq->flags = flags;
3358     rq->out_port = ntohs(nfmr->out_port);
3359     rq->table_id = nfmr->table_id;
3360
3361     return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
3362 }
3363
3364 void
3365 ofputil_append_flow_monitor_request(
3366     const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3367 {
3368     struct nx_flow_monitor_request *nfmr;
3369     size_t start_ofs;
3370     int match_len;
3371
3372     if (!msg->size) {
3373         ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3374     }
3375
3376     start_ofs = msg->size;
3377     ofpbuf_put_zeros(msg, sizeof *nfmr);
3378     match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3379
3380     nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3381     nfmr->id = htonl(rq->id);
3382     nfmr->flags = htons(rq->flags);
3383     nfmr->out_port = htons(rq->out_port);
3384     nfmr->match_len = htons(match_len);
3385     nfmr->table_id = rq->table_id;
3386 }
3387
3388 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3389  * into an abstract ofputil_flow_update in 'update'.  The caller must have
3390  * initialized update->match to point to space allocated for a match.
3391  *
3392  * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3393  * actions (except for NXFME_ABBREV, which never includes actions).  The caller
3394  * must initialize 'ofpacts' and retains ownership of it.  'update->ofpacts'
3395  * will point into the 'ofpacts' buffer.
3396  *
3397  * Multiple flow updates can be packed into a single OpenFlow message.  Calling
3398  * this function multiple times for a single 'msg' iterates through the
3399  * updates.  The caller must initially leave 'msg''s layer pointers null and
3400  * not modify them between calls.
3401  *
3402  * Returns 0 if successful, EOF if no updates were left in this 'msg',
3403  * otherwise an OFPERR_* value. */
3404 int
3405 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3406                            struct ofpbuf *msg, struct ofpbuf *ofpacts)
3407 {
3408     struct nx_flow_update_header *nfuh;
3409     unsigned int length;
3410
3411     if (!msg->l2) {
3412         msg->l2 = msg->data;
3413         ofpraw_pull_assert(msg);
3414     }
3415
3416     if (!msg->size) {
3417         return EOF;
3418     }
3419
3420     if (msg->size < sizeof(struct nx_flow_update_header)) {
3421         goto bad_len;
3422     }
3423
3424     nfuh = msg->data;
3425     update->event = ntohs(nfuh->event);
3426     length = ntohs(nfuh->length);
3427     if (length > msg->size || length % 8) {
3428         goto bad_len;
3429     }
3430
3431     if (update->event == NXFME_ABBREV) {
3432         struct nx_flow_update_abbrev *nfua;
3433
3434         if (length != sizeof *nfua) {
3435             goto bad_len;
3436         }
3437
3438         nfua = ofpbuf_pull(msg, sizeof *nfua);
3439         update->xid = nfua->xid;
3440         return 0;
3441     } else if (update->event == NXFME_ADDED
3442                || update->event == NXFME_DELETED
3443                || update->event == NXFME_MODIFIED) {
3444         struct nx_flow_update_full *nfuf;
3445         unsigned int actions_len;
3446         unsigned int match_len;
3447         enum ofperr error;
3448
3449         if (length < sizeof *nfuf) {
3450             goto bad_len;
3451         }
3452
3453         nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3454         match_len = ntohs(nfuf->match_len);
3455         if (sizeof *nfuf + match_len > length) {
3456             goto bad_len;
3457         }
3458
3459         update->reason = ntohs(nfuf->reason);
3460         update->idle_timeout = ntohs(nfuf->idle_timeout);
3461         update->hard_timeout = ntohs(nfuf->hard_timeout);
3462         update->table_id = nfuf->table_id;
3463         update->cookie = nfuf->cookie;
3464         update->priority = ntohs(nfuf->priority);
3465
3466         error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
3467         if (error) {
3468             return error;
3469         }
3470
3471         actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3472         error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3473         if (error) {
3474             return error;
3475         }
3476
3477         update->ofpacts = ofpacts->data;
3478         update->ofpacts_len = ofpacts->size;
3479         return 0;
3480     } else {
3481         VLOG_WARN_RL(&bad_ofmsg_rl,
3482                      "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3483                      ntohs(nfuh->event));
3484         return OFPERR_OFPET_BAD_REQUEST;
3485     }
3486
3487 bad_len:
3488     VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3489                  "leftover bytes at end", msg->size);
3490     return OFPERR_OFPBRC_BAD_LEN;
3491 }
3492
3493 uint32_t
3494 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3495 {
3496     const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3497
3498     return ntohl(cancel->id);
3499 }
3500
3501 struct ofpbuf *
3502 ofputil_encode_flow_monitor_cancel(uint32_t id)
3503 {
3504     struct nx_flow_monitor_cancel *nfmc;
3505     struct ofpbuf *msg;
3506
3507     msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3508     nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3509     nfmc->id = htonl(id);
3510     return msg;
3511 }
3512
3513 void
3514 ofputil_start_flow_update(struct list *replies)
3515 {
3516     struct ofpbuf *msg;
3517
3518     msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3519                            htonl(0), 1024);
3520
3521     list_init(replies);
3522     list_push_back(replies, &msg->list_node);
3523 }
3524
3525 void
3526 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3527                            struct list *replies)
3528 {
3529     struct nx_flow_update_header *nfuh;
3530     struct ofpbuf *msg;
3531     size_t start_ofs;
3532
3533     msg = ofpbuf_from_list(list_back(replies));
3534     start_ofs = msg->size;
3535
3536     if (update->event == NXFME_ABBREV) {
3537         struct nx_flow_update_abbrev *nfua;
3538
3539         nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3540         nfua->xid = update->xid;
3541     } else {
3542         struct nx_flow_update_full *nfuf;
3543         int match_len;
3544
3545         ofpbuf_put_zeros(msg, sizeof *nfuf);
3546         match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3547         ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3548
3549         nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3550         nfuf->reason = htons(update->reason);
3551         nfuf->priority = htons(update->priority);
3552         nfuf->idle_timeout = htons(update->idle_timeout);
3553         nfuf->hard_timeout = htons(update->hard_timeout);
3554         nfuf->match_len = htons(match_len);
3555         nfuf->table_id = update->table_id;
3556         nfuf->cookie = update->cookie;
3557     }
3558
3559     nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3560     nfuh->length = htons(msg->size - start_ofs);
3561     nfuh->event = htons(update->event);
3562
3563     ofpmp_postappend(replies, start_ofs);
3564 }
3565 \f
3566 struct ofpbuf *
3567 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3568                           enum ofputil_protocol protocol)
3569 {
3570     enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3571     struct ofpbuf *msg;
3572     size_t size;
3573
3574     size = po->ofpacts_len;
3575     if (po->buffer_id == UINT32_MAX) {
3576         size += po->packet_len;
3577     }
3578
3579     switch (ofp_version) {
3580     case OFP10_VERSION: {
3581         struct ofp_packet_out *opo;
3582         size_t actions_ofs;
3583
3584         msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3585         ofpbuf_put_zeros(msg, sizeof *opo);
3586         actions_ofs = msg->size;
3587         ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3588
3589         opo = msg->l3;
3590         opo->buffer_id = htonl(po->buffer_id);
3591         opo->in_port = htons(po->in_port);
3592         opo->actions_len = htons(msg->size - actions_ofs);
3593         break;
3594     }
3595
3596     case OFP11_VERSION:
3597     case OFP12_VERSION: {
3598         struct ofp11_packet_out *opo;
3599         size_t len;
3600
3601         msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3602         ofpbuf_put_zeros(msg, sizeof *opo);
3603         len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3604
3605         opo = msg->l3;
3606         opo->buffer_id = htonl(po->buffer_id);
3607         opo->in_port = ofputil_port_to_ofp11(po->in_port);
3608         opo->actions_len = htons(len);
3609         break;
3610     }
3611
3612     default:
3613         NOT_REACHED();
3614     }
3615
3616     if (po->buffer_id == UINT32_MAX) {
3617         ofpbuf_put(msg, po->packet, po->packet_len);
3618     }
3619
3620     ofpmsg_update_length(msg);
3621
3622     return msg;
3623 }
3624 \f
3625 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3626 struct ofpbuf *
3627 make_echo_request(enum ofp_version ofp_version)
3628 {
3629     return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3630                             htonl(0), 0);
3631 }
3632
3633 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3634  * OFPT_ECHO_REQUEST message in 'rq'. */
3635 struct ofpbuf *
3636 make_echo_reply(const struct ofp_header *rq)
3637 {
3638     struct ofpbuf rq_buf;
3639     struct ofpbuf *reply;
3640
3641     ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3642     ofpraw_pull_assert(&rq_buf);
3643
3644     reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3645     ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3646     return reply;
3647 }
3648
3649 struct ofpbuf *
3650 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3651 {
3652     enum ofpraw type;
3653
3654     switch (ofp_version) {
3655     case OFP12_VERSION:
3656     case OFP11_VERSION:
3657         type = OFPRAW_OFPT11_BARRIER_REQUEST;
3658         break;
3659
3660     case OFP10_VERSION:
3661         type = OFPRAW_OFPT10_BARRIER_REQUEST;
3662         break;
3663
3664     default:
3665         NOT_REACHED();
3666     }
3667
3668     return ofpraw_alloc(type, ofp_version, 0);
3669 }
3670
3671 const char *
3672 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3673 {
3674     switch (flags & OFPC_FRAG_MASK) {
3675     case OFPC_FRAG_NORMAL:   return "normal";
3676     case OFPC_FRAG_DROP:     return "drop";
3677     case OFPC_FRAG_REASM:    return "reassemble";
3678     case OFPC_FRAG_NX_MATCH: return "nx-match";
3679     }
3680
3681     NOT_REACHED();
3682 }
3683
3684 bool
3685 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3686 {
3687     if (!strcasecmp(s, "normal")) {
3688         *flags = OFPC_FRAG_NORMAL;
3689     } else if (!strcasecmp(s, "drop")) {
3690         *flags = OFPC_FRAG_DROP;
3691     } else if (!strcasecmp(s, "reassemble")) {
3692         *flags = OFPC_FRAG_REASM;
3693     } else if (!strcasecmp(s, "nx-match")) {
3694         *flags = OFPC_FRAG_NX_MATCH;
3695     } else {
3696         return false;
3697     }
3698     return true;
3699 }
3700
3701 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3702  * port number and stores the latter in '*ofp10_port', for the purpose of
3703  * decoding OpenFlow 1.1+ protocol messages.  Returns 0 if successful,
3704  * otherwise an OFPERR_* number.
3705  *
3706  * See the definition of OFP11_MAX for an explanation of the mapping. */
3707 enum ofperr
3708 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3709 {
3710     uint32_t ofp11_port_h = ntohl(ofp11_port);
3711
3712     if (ofp11_port_h < OFPP_MAX) {
3713         *ofp10_port = ofp11_port_h;
3714         return 0;
3715     } else if (ofp11_port_h >= OFPP11_MAX) {
3716         *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3717         return 0;
3718     } else {
3719         VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3720                      "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3721                      ofp11_port_h, OFPP_MAX - 1,
3722                      (uint32_t) OFPP11_MAX, UINT32_MAX);
3723         return OFPERR_OFPBAC_BAD_OUT_PORT;
3724     }
3725 }
3726
3727 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3728  * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3729  *
3730  * See the definition of OFP11_MAX for an explanation of the mapping. */
3731 ovs_be32
3732 ofputil_port_to_ofp11(uint16_t ofp10_port)
3733 {
3734     return htonl(ofp10_port < OFPP_MAX
3735                  ? ofp10_port
3736                  : ofp10_port + OFPP11_OFFSET);
3737 }
3738
3739 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3740  * that the switch will never have more than 'max_ports' ports.  Returns 0 if
3741  * 'port' is valid, otherwise an OpenFlow return code. */
3742 enum ofperr
3743 ofputil_check_output_port(uint16_t port, int max_ports)
3744 {
3745     switch (port) {
3746     case OFPP_IN_PORT:
3747     case OFPP_TABLE:
3748     case OFPP_NORMAL:
3749     case OFPP_FLOOD:
3750     case OFPP_ALL:
3751     case OFPP_CONTROLLER:
3752     case OFPP_NONE:
3753     case OFPP_LOCAL:
3754         return 0;
3755
3756     default:
3757         if (port < max_ports) {
3758             return 0;
3759         }
3760         return OFPERR_OFPBAC_BAD_OUT_PORT;
3761     }
3762 }
3763
3764 #define OFPUTIL_NAMED_PORTS                     \
3765         OFPUTIL_NAMED_PORT(IN_PORT)             \
3766         OFPUTIL_NAMED_PORT(TABLE)               \
3767         OFPUTIL_NAMED_PORT(NORMAL)              \
3768         OFPUTIL_NAMED_PORT(FLOOD)               \
3769         OFPUTIL_NAMED_PORT(ALL)                 \
3770         OFPUTIL_NAMED_PORT(CONTROLLER)          \
3771         OFPUTIL_NAMED_PORT(LOCAL)               \
3772         OFPUTIL_NAMED_PORT(NONE)
3773
3774 /* Stores the port number represented by 's' into '*portp'.  's' may be an
3775  * integer or, for reserved ports, the standard OpenFlow name for the port
3776  * (e.g. "LOCAL").
3777  *
3778  * Returns true if successful, false if 's' is not a valid OpenFlow port number
3779  * or name.  The caller should issue an error message in this case, because
3780  * this function usually does not.  (This gives the caller an opportunity to
3781  * look up the port name another way, e.g. by contacting the switch and listing
3782  * the names of all its ports).
3783  *
3784  * This function accepts OpenFlow 1.0 port numbers.  It also accepts a subset
3785  * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
3786  * range as described in include/openflow/openflow-1.1.h. */
3787 bool
3788 ofputil_port_from_string(const char *s, uint16_t *portp)
3789 {
3790     unsigned int port32;
3791
3792     *portp = 0;
3793     if (str_to_uint(s, 10, &port32)) {
3794         if (port32 < OFPP_MAX) {
3795             *portp = port32;
3796             return true;
3797         } else if (port32 < OFPP_FIRST_RESV) {
3798             VLOG_WARN("port %u is a reserved OF1.0 port number that will "
3799                       "be translated to %u when talking to an OF1.1 or "
3800                       "later controller", port32, port32 + OFPP11_OFFSET);
3801             *portp = port32;
3802             return true;
3803         } else if (port32 <= OFPP_LAST_RESV) {
3804             struct ds s;
3805
3806             ds_init(&s);
3807             ofputil_format_port(port32, &s);
3808             VLOG_WARN_ONCE("referring to port %s as %u is deprecated for "
3809                            "compatibility with future versions of OpenFlow",
3810                            ds_cstr(&s), port32);
3811             ds_destroy(&s);
3812
3813             *portp = port32;
3814             return true;
3815         } else if (port32 < OFPP11_MAX) {
3816             VLOG_WARN("port %u is outside the supported range 0 through "
3817                       "%"PRIx16"or 0x%x through 0x%"PRIx32, port32,
3818                       UINT16_MAX, (unsigned int) OFPP11_MAX, UINT32_MAX);
3819             return false;
3820         } else {
3821             *portp = port32 - OFPP11_OFFSET;
3822             return true;
3823         }
3824     } else {
3825         struct pair {
3826             const char *name;
3827             uint16_t value;
3828         };
3829         static const struct pair pairs[] = {
3830 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3831             OFPUTIL_NAMED_PORTS
3832 #undef OFPUTIL_NAMED_PORT
3833         };
3834         const struct pair *p;
3835
3836         for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
3837             if (!strcasecmp(s, p->name)) {
3838                 *portp = p->value;
3839                 return true;
3840             }
3841         }
3842         return false;
3843     }
3844 }
3845
3846 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3847  * Most ports' string representation is just the port number, but for special
3848  * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3849 void
3850 ofputil_format_port(uint16_t port, struct ds *s)
3851 {
3852     const char *name;
3853
3854     switch (port) {
3855 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3856         OFPUTIL_NAMED_PORTS
3857 #undef OFPUTIL_NAMED_PORT
3858
3859     default:
3860         ds_put_format(s, "%"PRIu16, port);
3861         return;
3862     }
3863     ds_put_cstr(s, name);
3864 }
3865
3866 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3867  * 'ofp_version', tries to pull the first element from the array.  If
3868  * successful, initializes '*pp' with an abstract representation of the
3869  * port and returns 0.  If no ports remain to be decoded, returns EOF.
3870  * On an error, returns a positive OFPERR_* value. */
3871 int
3872 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3873                       struct ofputil_phy_port *pp)
3874 {
3875     switch (ofp_version) {
3876     case OFP10_VERSION: {
3877         const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3878         return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3879     }
3880     case OFP11_VERSION:
3881     case OFP12_VERSION: {
3882         const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3883         return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3884     }
3885     default:
3886         NOT_REACHED();
3887     }
3888 }
3889
3890 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3891  * 'ofp_version', returns the number of elements. */
3892 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3893 {
3894     return b->size / ofputil_get_phy_port_size(ofp_version);
3895 }
3896
3897 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3898  * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3899  * 'name' is not the name of any action.
3900  *
3901  * ofp-util.def lists the mapping from names to action. */
3902 int
3903 ofputil_action_code_from_name(const char *name)
3904 {
3905     static const char *names[OFPUTIL_N_ACTIONS] = {
3906         NULL,
3907 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             NAME,
3908 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3909 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   NAME,
3910 #include "ofp-util.def"
3911     };
3912
3913     const char **p;
3914
3915     for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3916         if (*p && !strcasecmp(name, *p)) {
3917             return p - names;
3918         }
3919     }
3920     return -1;
3921 }
3922
3923 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3924  * action.  Initializes the parts of 'action' that identify it as having type
3925  * <ENUM> and length 'sizeof *action' and zeros the rest.  For actions that
3926  * have variable length, the length used and cleared is that of struct
3927  * <STRUCT>.  */
3928 void *
3929 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3930 {
3931     switch (code) {
3932     case OFPUTIL_ACTION_INVALID:
3933         NOT_REACHED();
3934
3935 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                  \
3936     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3937 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)      \
3938     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3939 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)        \
3940     case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3941 #include "ofp-util.def"
3942     }
3943     NOT_REACHED();
3944 }
3945
3946 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                        \
3947     void                                                        \
3948     ofputil_init_##ENUM(struct STRUCT *s)                       \
3949     {                                                           \
3950         memset(s, 0, sizeof *s);                                \
3951         s->type = htons(ENUM);                                  \
3952         s->len = htons(sizeof *s);                              \
3953     }                                                           \
3954                                                                 \
3955     struct STRUCT *                                             \
3956     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3957     {                                                           \
3958         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3959         ofputil_init_##ENUM(s);                                 \
3960         return s;                                               \
3961     }
3962 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3963     OFPAT10_ACTION(ENUM, STRUCT, NAME)
3964 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)            \
3965     void                                                        \
3966     ofputil_init_##ENUM(struct STRUCT *s)                       \
3967     {                                                           \
3968         memset(s, 0, sizeof *s);                                \
3969         s->type = htons(OFPAT10_VENDOR);                        \
3970         s->len = htons(sizeof *s);                              \
3971         s->vendor = htonl(NX_VENDOR_ID);                        \
3972         s->subtype = htons(ENUM);                               \
3973     }                                                           \
3974                                                                 \
3975     struct STRUCT *                                             \
3976     ofputil_put_##ENUM(struct ofpbuf *buf)                      \
3977     {                                                           \
3978         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
3979         ofputil_init_##ENUM(s);                                 \
3980         return s;                                               \
3981     }
3982 #include "ofp-util.def"
3983
3984 static void
3985 ofputil_normalize_match__(struct match *match, bool may_log)
3986 {
3987     enum {
3988         MAY_NW_ADDR     = 1 << 0, /* nw_src, nw_dst */
3989         MAY_TP_ADDR     = 1 << 1, /* tp_src, tp_dst */
3990         MAY_NW_PROTO    = 1 << 2, /* nw_proto */
3991         MAY_IPVx        = 1 << 3, /* tos, frag, ttl */
3992         MAY_ARP_SHA     = 1 << 4, /* arp_sha */
3993         MAY_ARP_THA     = 1 << 5, /* arp_tha */
3994         MAY_IPV6        = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3995         MAY_ND_TARGET   = 1 << 7  /* nd_target */
3996     } may_match;
3997
3998     struct flow_wildcards wc;
3999
4000     /* Figure out what fields may be matched. */
4001     if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
4002         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4003         if (match->flow.nw_proto == IPPROTO_TCP ||
4004             match->flow.nw_proto == IPPROTO_UDP ||
4005             match->flow.nw_proto == IPPROTO_ICMP) {
4006             may_match |= MAY_TP_ADDR;
4007         }
4008     } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4009         may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4010         if (match->flow.nw_proto == IPPROTO_TCP ||
4011             match->flow.nw_proto == IPPROTO_UDP) {
4012             may_match |= MAY_TP_ADDR;
4013         } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
4014             may_match |= MAY_TP_ADDR;
4015             if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4016                 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4017             } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4018                 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4019             }
4020         }
4021     } else if (match->flow.dl_type == htons(ETH_TYPE_ARP) ||
4022                match->flow.dl_type == htons(ETH_TYPE_RARP)) {
4023         may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4024     } else {
4025         may_match = 0;
4026     }
4027
4028     /* Clear the fields that may not be matched. */
4029     wc = match->wc;
4030     if (!(may_match & MAY_NW_ADDR)) {
4031         wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
4032     }
4033     if (!(may_match & MAY_TP_ADDR)) {
4034         wc.masks.tp_src = wc.masks.tp_dst = htons(0);
4035     }
4036     if (!(may_match & MAY_NW_PROTO)) {
4037         wc.masks.nw_proto = 0;
4038     }
4039     if (!(may_match & MAY_IPVx)) {
4040         wc.masks.nw_tos = 0;
4041         wc.masks.nw_ttl = 0;
4042     }
4043     if (!(may_match & MAY_ARP_SHA)) {
4044         memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
4045     }
4046     if (!(may_match & MAY_ARP_THA)) {
4047         memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
4048     }
4049     if (!(may_match & MAY_IPV6)) {
4050         wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
4051         wc.masks.ipv6_label = htonl(0);
4052     }
4053     if (!(may_match & MAY_ND_TARGET)) {
4054         wc.masks.nd_target = in6addr_any;
4055     }
4056
4057     /* Log any changes. */
4058     if (!flow_wildcards_equal(&wc, &match->wc)) {
4059         bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
4060         char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
4061
4062         match->wc = wc;
4063         match_zero_wildcarded_fields(match);
4064
4065         if (log) {
4066             char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
4067             VLOG_INFO("normalization changed ofp_match, details:");
4068             VLOG_INFO(" pre: %s", pre);
4069             VLOG_INFO("post: %s", post);
4070             free(pre);
4071             free(post);
4072         }
4073     }
4074 }
4075
4076 /* "Normalizes" the wildcards in 'match'.  That means:
4077  *
4078  *    1. If the type of level N is known, then only the valid fields for that
4079  *       level may be specified.  For example, ARP does not have a TOS field,
4080  *       so nw_tos must be wildcarded if 'match' specifies an ARP flow.
4081  *       Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4082  *       ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
4083  *       IPv4 flow.
4084  *
4085  *    2. If the type of level N is not known (or not understood by Open
4086  *       vSwitch), then no fields at all for that level may be specified.  For
4087  *       example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4088  *       L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
4089  *       SCTP flow.
4090  *
4091  * If this function changes 'match', it logs a rate-limited informational
4092  * message. */
4093 void
4094 ofputil_normalize_match(struct match *match)
4095 {
4096     ofputil_normalize_match__(match, true);
4097 }
4098
4099 /* Same as ofputil_normalize_match() without the logging.  Thus, this function
4100  * is suitable for a program's internal use, whereas ofputil_normalize_match()
4101  * sense for use on flows received from elsewhere (so that a bug in the program
4102  * that sent them can be reported and corrected). */
4103 void
4104 ofputil_normalize_match_quiet(struct match *match)
4105 {
4106     ofputil_normalize_match__(match, false);
4107 }
4108
4109 /* Parses a key or a key-value pair from '*stringp'.
4110  *
4111  * On success: Stores the key into '*keyp'.  Stores the value, if present, into
4112  * '*valuep', otherwise an empty string.  Advances '*stringp' past the end of
4113  * the key-value pair, preparing it for another call.  '*keyp' and '*valuep'
4114  * are substrings of '*stringp' created by replacing some of its bytes by null
4115  * terminators.  Returns true.
4116  *
4117  * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4118  * NULL and returns false. */
4119 bool
4120 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4121 {
4122     char *pos, *key, *value;
4123     size_t key_len;
4124
4125     pos = *stringp;
4126     pos += strspn(pos, ", \t\r\n");
4127     if (*pos == '\0') {
4128         *keyp = *valuep = NULL;
4129         return false;
4130     }
4131
4132     key = pos;
4133     key_len = strcspn(pos, ":=(, \t\r\n");
4134     if (key[key_len] == ':' || key[key_len] == '=') {
4135         /* The value can be separated by a colon. */
4136         size_t value_len;
4137
4138         value = key + key_len + 1;
4139         value_len = strcspn(value, ", \t\r\n");
4140         pos = value + value_len + (value[value_len] != '\0');
4141         value[value_len] = '\0';
4142     } else if (key[key_len] == '(') {
4143         /* The value can be surrounded by balanced parentheses.  The outermost
4144          * set of parentheses is removed. */
4145         int level = 1;
4146         size_t value_len;
4147
4148         value = key + key_len + 1;
4149         for (value_len = 0; level > 0; value_len++) {
4150             switch (value[value_len]) {
4151             case '\0':
4152                 level = 0;
4153                 break;
4154
4155             case '(':
4156                 level++;
4157                 break;
4158
4159             case ')':
4160                 level--;
4161                 break;
4162             }
4163         }
4164         value[value_len - 1] = '\0';
4165         pos = value + value_len;
4166     } else {
4167         /* There might be no value at all. */
4168         value = key + key_len;  /* Will become the empty string below. */
4169         pos = key + key_len + (key[key_len] != '\0');
4170     }
4171     key[key_len] = '\0';
4172
4173     *stringp = pos;
4174     *keyp = key;
4175     *valuep = value;
4176     return true;
4177 }
4178
4179 /* Encode a dump ports request for 'port', the encoded message
4180  * will be fore Open Flow version 'ofp_version'. Returns message
4181  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4182 struct ofpbuf *
4183 ofputil_encode_dump_ports_request(enum ofp_version ofp_version, int16_t port)
4184 {
4185     struct ofpbuf *request;
4186
4187     switch (ofp_version) {
4188     case OFP10_VERSION: {
4189         struct ofp10_port_stats_request *req;
4190         request = ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST, ofp_version, 0);
4191         req = ofpbuf_put_zeros(request, sizeof *req);
4192         req->port_no = htons(port);
4193         break;
4194     }
4195     case OFP11_VERSION:
4196     case OFP12_VERSION: {
4197         struct ofp11_port_stats_request *req;
4198         request = ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST, ofp_version, 0);
4199         req = ofpbuf_put_zeros(request, sizeof *req);
4200         req->port_no = ofputil_port_to_ofp11(port);
4201         break;
4202     }
4203     default:
4204         NOT_REACHED();
4205     }
4206
4207     return request;
4208 }
4209
4210 static void
4211 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats *ops,
4212                             struct ofp10_port_stats *ps10)
4213 {
4214     ps10->port_no = htons(ops->port_no);
4215     memset(ps10->pad, 0, sizeof ps10->pad);
4216     put_32aligned_be64(&ps10->rx_packets, htonll(ops->stats.rx_packets));
4217     put_32aligned_be64(&ps10->tx_packets, htonll(ops->stats.tx_packets));
4218     put_32aligned_be64(&ps10->rx_bytes, htonll(ops->stats.rx_bytes));
4219     put_32aligned_be64(&ps10->tx_bytes, htonll(ops->stats.tx_bytes));
4220     put_32aligned_be64(&ps10->rx_dropped, htonll(ops->stats.rx_dropped));
4221     put_32aligned_be64(&ps10->tx_dropped, htonll(ops->stats.tx_dropped));
4222     put_32aligned_be64(&ps10->rx_errors, htonll(ops->stats.rx_errors));
4223     put_32aligned_be64(&ps10->tx_errors, htonll(ops->stats.tx_errors));
4224     put_32aligned_be64(&ps10->rx_frame_err, htonll(ops->stats.rx_frame_errors));
4225     put_32aligned_be64(&ps10->rx_over_err, htonll(ops->stats.rx_over_errors));
4226     put_32aligned_be64(&ps10->rx_crc_err, htonll(ops->stats.rx_crc_errors));
4227     put_32aligned_be64(&ps10->collisions, htonll(ops->stats.collisions));
4228 }
4229
4230 static void
4231 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats *ops,
4232                             struct ofp11_port_stats *ps11)
4233 {
4234     ps11->port_no = ofputil_port_to_ofp11(ops->port_no);
4235     memset(ps11->pad, 0, sizeof ps11->pad);
4236     ps11->rx_packets = htonll(ops->stats.rx_packets);
4237     ps11->tx_packets = htonll(ops->stats.tx_packets);
4238     ps11->rx_bytes = htonll(ops->stats.rx_bytes);
4239     ps11->tx_bytes = htonll(ops->stats.tx_bytes);
4240     ps11->rx_dropped = htonll(ops->stats.rx_dropped);
4241     ps11->tx_dropped = htonll(ops->stats.tx_dropped);
4242     ps11->rx_errors = htonll(ops->stats.rx_errors);
4243     ps11->tx_errors = htonll(ops->stats.tx_errors);
4244     ps11->rx_frame_err = htonll(ops->stats.rx_frame_errors);
4245     ps11->rx_over_err = htonll(ops->stats.rx_over_errors);
4246     ps11->rx_crc_err = htonll(ops->stats.rx_crc_errors);
4247     ps11->collisions = htonll(ops->stats.collisions);
4248 }
4249
4250 /* Encode a ports stat for 'ops' and append it to 'replies'. */
4251 void
4252 ofputil_append_port_stat(struct list *replies,
4253                          const struct ofputil_port_stats *ops)
4254 {
4255     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4256     struct ofp_header *oh = msg->data;
4257
4258     switch ((enum ofp_version)oh->version) {
4259     case OFP12_VERSION:
4260     case OFP11_VERSION: {
4261         struct ofp11_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4262         ofputil_port_stats_to_ofp11(ops, reply);
4263         break;
4264     }
4265
4266     case OFP10_VERSION: {
4267         struct ofp10_port_stats *reply = ofpmp_append(replies, sizeof *reply);
4268         ofputil_port_stats_to_ofp10(ops, reply);
4269         break;
4270     }
4271
4272     default:
4273         NOT_REACHED();
4274     }
4275 }
4276
4277 static enum ofperr
4278 ofputil_port_stats_from_ofp10(struct ofputil_port_stats *ops,
4279                               const struct ofp10_port_stats *ps10)
4280 {
4281     memset(ops, 0, sizeof *ops);
4282
4283     ops->port_no = ntohs(ps10->port_no);
4284     ops->stats.rx_packets = ntohll(get_32aligned_be64(&ps10->rx_packets));
4285     ops->stats.tx_packets = ntohll(get_32aligned_be64(&ps10->tx_packets));
4286     ops->stats.rx_bytes = ntohll(get_32aligned_be64(&ps10->rx_bytes));
4287     ops->stats.tx_bytes = ntohll(get_32aligned_be64(&ps10->tx_bytes));
4288     ops->stats.rx_dropped = ntohll(get_32aligned_be64(&ps10->rx_dropped));
4289     ops->stats.tx_dropped = ntohll(get_32aligned_be64(&ps10->tx_dropped));
4290     ops->stats.rx_errors = ntohll(get_32aligned_be64(&ps10->rx_errors));
4291     ops->stats.tx_errors = ntohll(get_32aligned_be64(&ps10->tx_errors));
4292     ops->stats.rx_frame_errors =
4293         ntohll(get_32aligned_be64(&ps10->rx_frame_err));
4294     ops->stats.rx_over_errors = ntohll(get_32aligned_be64(&ps10->rx_over_err));
4295     ops->stats.rx_crc_errors = ntohll(get_32aligned_be64(&ps10->rx_crc_err));
4296     ops->stats.collisions = ntohll(get_32aligned_be64(&ps10->collisions));
4297
4298     return 0;
4299 }
4300
4301 static enum ofperr
4302 ofputil_port_stats_from_ofp11(struct ofputil_port_stats *ops,
4303                               const struct ofp11_port_stats *ps11)
4304 {
4305     enum ofperr error;
4306
4307     memset(ops, 0, sizeof *ops);
4308     error = ofputil_port_from_ofp11(ps11->port_no, &ops->port_no);
4309     if (error) {
4310         return error;
4311     }
4312
4313     ops->stats.rx_packets = ntohll(ps11->rx_packets);
4314     ops->stats.tx_packets = ntohll(ps11->tx_packets);
4315     ops->stats.rx_bytes = ntohll(ps11->rx_bytes);
4316     ops->stats.tx_bytes = ntohll(ps11->tx_bytes);
4317     ops->stats.rx_dropped = ntohll(ps11->rx_dropped);
4318     ops->stats.tx_dropped = ntohll(ps11->tx_dropped);
4319     ops->stats.rx_errors = ntohll(ps11->rx_errors);
4320     ops->stats.tx_errors = ntohll(ps11->tx_errors);
4321     ops->stats.rx_frame_errors = ntohll(ps11->rx_frame_err);
4322     ops->stats.rx_over_errors = ntohll(ps11->rx_over_err);
4323     ops->stats.rx_crc_errors = ntohll(ps11->rx_crc_err);
4324     ops->stats.collisions = ntohll(ps11->collisions);
4325
4326     return 0;
4327 }
4328
4329 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
4330  * message 'oh'. */
4331 size_t
4332 ofputil_count_port_stats(const struct ofp_header *oh)
4333 {
4334     struct ofpbuf b;
4335
4336     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4337     ofpraw_pull_assert(&b);
4338
4339     BUILD_ASSERT(sizeof(struct ofp10_port_stats) ==
4340                  sizeof(struct ofp11_port_stats));
4341     return b.size / sizeof(struct ofp10_port_stats);
4342 }
4343
4344 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
4345  * ofputil_port_stats in 'ps'.
4346  *
4347  * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
4348  * message.  Calling this function multiple times for a single 'msg' iterates
4349  * through the replies.  The caller must initially leave 'msg''s layer pointers
4350  * null and not modify them between calls.
4351  *
4352  * Returns 0 if successful, EOF if no replies were left in this 'msg',
4353  * otherwise a positive errno value. */
4354 int
4355 ofputil_decode_port_stats(struct ofputil_port_stats *ps, struct ofpbuf *msg)
4356 {
4357     enum ofperr error;
4358     enum ofpraw raw;
4359
4360     error = (msg->l2
4361              ? ofpraw_decode(&raw, msg->l2)
4362              : ofpraw_pull(&raw, msg));
4363     if (error) {
4364         return error;
4365     }
4366
4367     if (!msg->size) {
4368         return EOF;
4369     } else if (raw == OFPRAW_OFPST11_PORT_REPLY) {
4370         const struct ofp11_port_stats *ps11;
4371
4372         ps11 = ofpbuf_try_pull(msg, sizeof *ps11);
4373         if (!ps11) {
4374             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4375                          "bytes at end", msg->size);
4376             return OFPERR_OFPBRC_BAD_LEN;
4377         }
4378         return ofputil_port_stats_from_ofp11(ps, ps11);
4379     } else if (raw == OFPRAW_OFPST10_PORT_REPLY) {
4380         const struct ofp10_port_stats *ps10;
4381
4382         ps10 = ofpbuf_try_pull(msg, sizeof *ps10);
4383         if (!ps10) {
4384             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_PORT reply has %zu leftover "
4385                          "bytes at end", msg->size);
4386             return OFPERR_OFPBRC_BAD_LEN;
4387         }
4388         return ofputil_port_stats_from_ofp10(ps, ps10);
4389     } else {
4390         NOT_REACHED();
4391     }
4392
4393 }
4394
4395 /* Parse a port status request message into a 16 bit OpenFlow 1.0
4396  * port number and stores the latter in '*ofp10_port'.
4397  * Returns 0 if successful, otherwise an OFPERR_* number. */
4398 enum ofperr
4399 ofputil_decode_port_stats_request(const struct ofp_header *request,
4400                                   uint16_t *ofp10_port)
4401 {
4402     switch ((enum ofp_version)request->version) {
4403     case OFP12_VERSION:
4404     case OFP11_VERSION: {
4405         const struct ofp11_port_stats_request *psr11 = ofpmsg_body(request);
4406         return ofputil_port_from_ofp11(psr11->port_no, ofp10_port);
4407     }
4408
4409     case OFP10_VERSION: {
4410         const struct ofp10_port_stats_request *psr10 = ofpmsg_body(request);
4411         *ofp10_port = ntohs(psr10->port_no);
4412         return 0;
4413     }
4414
4415     default:
4416         NOT_REACHED();
4417     }
4418 }
4419
4420 /* Parse a queue status request message into 'oqsr'.
4421  * Returns 0 if successful, otherwise an OFPERR_* number. */
4422 enum ofperr
4423 ofputil_decode_queue_stats_request(const struct ofp_header *request,
4424                                    struct ofputil_queue_stats_request *oqsr)
4425 {
4426     switch ((enum ofp_version)request->version) {
4427     case OFP12_VERSION:
4428     case OFP11_VERSION: {
4429         const struct ofp11_queue_stats_request *qsr11 = ofpmsg_body(request);
4430         oqsr->queue_id = ntohl(qsr11->queue_id);
4431         return ofputil_port_from_ofp11(qsr11->port_no, &oqsr->port_no);
4432     }
4433
4434     case OFP10_VERSION: {
4435         const struct ofp10_queue_stats_request *qsr11 = ofpmsg_body(request);
4436         oqsr->queue_id = ntohl(qsr11->queue_id);
4437         oqsr->port_no = ntohs(qsr11->port_no);
4438         return 0;
4439     }
4440
4441     default:
4442         NOT_REACHED();
4443     }
4444 }
4445
4446 /* Encode a queue statsrequest for 'oqsr', the encoded message
4447  * will be fore Open Flow version 'ofp_version'. Returns message
4448  * as a struct ofpbuf. Returns encoded message on success, NULL on error */
4449 struct ofpbuf *
4450 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
4451                                    const struct ofputil_queue_stats_request *oqsr)
4452 {
4453     struct ofpbuf *request;
4454
4455     switch (ofp_version) {
4456     case OFP11_VERSION:
4457     case OFP12_VERSION: {
4458         struct ofp11_queue_stats_request *req;
4459         request = ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST, ofp_version, 0);
4460         req = ofpbuf_put_zeros(request, sizeof *req);
4461         req->port_no = ofputil_port_to_ofp11(oqsr->port_no);
4462         req->queue_id = htonl(oqsr->queue_id);
4463         break;
4464     }
4465     case OFP10_VERSION: {
4466         struct ofp10_queue_stats_request *req;
4467         request = ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST, ofp_version, 0);
4468         req = ofpbuf_put_zeros(request, sizeof *req);
4469         req->port_no = htons(oqsr->port_no);
4470         req->queue_id = htonl(oqsr->queue_id);
4471         break;
4472     }
4473     default:
4474         NOT_REACHED();
4475     }
4476
4477     return request;
4478 }
4479
4480 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
4481  * message 'oh'. */
4482 size_t
4483 ofputil_count_queue_stats(const struct ofp_header *oh)
4484 {
4485     struct ofpbuf b;
4486
4487     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4488     ofpraw_pull_assert(&b);
4489
4490     BUILD_ASSERT(sizeof(struct ofp10_queue_stats) ==
4491                  sizeof(struct ofp11_queue_stats));
4492     return b.size / sizeof(struct ofp10_queue_stats);
4493 }
4494
4495 static enum ofperr
4496 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats *oqs,
4497                                const struct ofp10_queue_stats *qs10)
4498 {
4499     oqs->port_no = ntohs(qs10->port_no);
4500     oqs->queue_id = ntohl(qs10->queue_id);
4501     oqs->stats.tx_bytes = ntohll(get_32aligned_be64(&qs10->tx_bytes));
4502     oqs->stats.tx_packets = ntohll(get_32aligned_be64(&qs10->tx_packets));
4503     oqs->stats.tx_errors = ntohll(get_32aligned_be64(&qs10->tx_errors));
4504
4505     return 0;
4506 }
4507
4508 static enum ofperr
4509 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats *oqs,
4510                                const struct ofp11_queue_stats *qs11)
4511 {
4512     enum ofperr error;
4513
4514     error = ofputil_port_from_ofp11(qs11->port_no, &oqs->port_no);
4515     if (error) {
4516         return error;
4517     }
4518
4519     oqs->queue_id = ntohl(qs11->queue_id);
4520     oqs->stats.tx_bytes = ntohll(qs11->tx_bytes);
4521     oqs->stats.tx_packets = ntohll(qs11->tx_packets);
4522     oqs->stats.tx_errors = ntohll(qs11->tx_errors);
4523
4524     return 0;
4525 }
4526
4527 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
4528  * ofputil_queue_stats in 'qs'.
4529  *
4530  * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
4531  * message.  Calling this function multiple times for a single 'msg' iterates
4532  * through the replies.  The caller must initially leave 'msg''s layer pointers
4533  * null and not modify them between calls.
4534  *
4535  * Returns 0 if successful, EOF if no replies were left in this 'msg',
4536  * otherwise a positive errno value. */
4537 int
4538 ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg)
4539 {
4540     enum ofperr error;
4541     enum ofpraw raw;
4542
4543     error = (msg->l2
4544              ? ofpraw_decode(&raw, msg->l2)
4545              : ofpraw_pull(&raw, msg));
4546     if (error) {
4547         return error;
4548     }
4549
4550     if (!msg->size) {
4551         return EOF;
4552     } else if (raw == OFPRAW_OFPST11_QUEUE_REPLY) {
4553         const struct ofp11_queue_stats *qs11;
4554
4555         qs11 = ofpbuf_try_pull(msg, sizeof *qs11);
4556         if (!qs11) {
4557             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4558                          "bytes at end", msg->size);
4559             return OFPERR_OFPBRC_BAD_LEN;
4560         }
4561         return ofputil_queue_stats_from_ofp11(qs, qs11);
4562     } else if (raw == OFPRAW_OFPST10_QUEUE_REPLY) {
4563         const struct ofp10_queue_stats *qs10;
4564
4565         qs10 = ofpbuf_try_pull(msg, sizeof *qs10);
4566         if (!qs10) {
4567             VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_QUEUE reply has %zu leftover "
4568                          "bytes at end", msg->size);
4569             return OFPERR_OFPBRC_BAD_LEN;
4570         }
4571         return ofputil_queue_stats_from_ofp10(qs, qs10);
4572     } else {
4573         NOT_REACHED();
4574     }
4575 }
4576
4577 static void
4578 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats *oqs,
4579                              struct ofp10_queue_stats *qs10)
4580 {
4581     qs10->port_no = htons(oqs->port_no);
4582     memset(qs10->pad, 0, sizeof qs10->pad);
4583     qs10->queue_id = htonl(oqs->queue_id);
4584     put_32aligned_be64(&qs10->tx_bytes, htonll(oqs->stats.tx_bytes));
4585     put_32aligned_be64(&qs10->tx_packets, htonll(oqs->stats.tx_packets));
4586     put_32aligned_be64(&qs10->tx_errors, htonll(oqs->stats.tx_errors));
4587 }
4588
4589 static void
4590 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats *oqs,
4591                              struct ofp11_queue_stats *qs11)
4592 {
4593     qs11->port_no = ofputil_port_to_ofp11(oqs->port_no);
4594     qs11->queue_id = htonl(oqs->queue_id);
4595     qs11->tx_bytes = htonll(oqs->stats.tx_bytes);
4596     qs11->tx_packets = htonll(oqs->stats.tx_packets);
4597     qs11->tx_errors = htonll(oqs->stats.tx_errors);
4598 }
4599
4600 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
4601 void
4602 ofputil_append_queue_stat(struct list *replies,
4603                           const struct ofputil_queue_stats *oqs)
4604 {
4605     struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
4606     struct ofp_header *oh = msg->data;
4607
4608     switch ((enum ofp_version)oh->version) {
4609     case OFP12_VERSION:
4610     case OFP11_VERSION: {
4611         struct ofp11_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4612         ofputil_queue_stats_to_ofp11(oqs, reply);
4613         break;
4614     }
4615
4616     case OFP10_VERSION: {
4617         struct ofp10_queue_stats *reply = ofpmp_append(replies, sizeof *reply);;
4618         ofputil_queue_stats_to_ofp10(oqs, reply);
4619         break;
4620     }
4621
4622     default:
4623         NOT_REACHED();
4624     }
4625 }