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