lib/meta-flow.c

   1 /*
   2  * Copyright (c) 2011, 2012, 2013, 2014 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
  19 #include "meta-flow.h"
  20
  21 #include <errno.h>
  22 #include <limits.h>
  23 #include <netinet/icmp6.h>
  24 #include <netinet/ip6.h>
  25
  26 #include "classifier.h"
  27 #include "dynamic-string.h"
  28 #include "nx-match.h"
  29 #include "ofp-errors.h"
  30 #include "ofp-util.h"
  31 #include "ovs-thread.h"
  32 #include "packets.h"
  33 #include "random.h"
  34 #include "shash.h"
  35 #include "socket-util.h"
  36 #include "unaligned.h"
  37 #include "util.h"
  38 #include "openvswitch/vlog.h"
  39
  40 VLOG_DEFINE_THIS_MODULE(meta_flow);
  41
  42 #define FLOW_U32OFS(FIELD)                                              \
  43     offsetof(struct flow, FIELD) % 4 ? -1 : offsetof(struct flow, FIELD) / 4
  44
  45 #define MF_FIELD_SIZES(MEMBER)                  \
  46     sizeof ((union mf_value *)0)->MEMBER,       \
  47     8 * sizeof ((union mf_value *)0)->MEMBER
  48
  49 extern const struct mf_field mf_fields[MFF_N_IDS]; /* Silence a warning. */
  50
  51 const struct mf_field mf_fields[MFF_N_IDS] = {
  52 #include "meta-flow.inc"
  53 };
  54
  55 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
  56 static struct shash mf_by_name;
  57
  58 /* Rate limit for parse errors.  These always indicate a bug in an OpenFlow
  59  * controller and so there's not much point in showing a lot of them. */
  60 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  61
  62 static void nxm_init(void);
  63
  64 /* Returns the field with the given 'name', or a null pointer if no field has
  65  * that name. */
  66 const struct mf_field *
  67 mf_from_name(const char *name)
  68 {
  69     nxm_init();
  70     return shash_find_data(&mf_by_name, name);
  71 }
  72
  73 static void
  74 nxm_do_init(void)
  75 {
  76     int i;
  77
  78     shash_init(&mf_by_name);
  79     for (i = 0; i < MFF_N_IDS; i++) {
  80         const struct mf_field *mf = &mf_fields[i];
  81
  82         ovs_assert(mf->id == i); /* Fields must be in the enum order. */
  83
  84         shash_add_once(&mf_by_name, mf->name, mf);
  85         if (mf->extra_name) {
  86             shash_add_once(&mf_by_name, mf->extra_name, mf);
  87         }
  88     }
  89 }
  90
  91 static void
  92 nxm_init(void)
  93 {
  94     static pthread_once_t once = PTHREAD_ONCE_INIT;
  95     pthread_once(&once, nxm_do_init);
  96 }
  97
  98 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
  99  * specifies at least one bit in the field.
 100  *
 101  * The caller is responsible for ensuring that 'wc' corresponds to a flow that
 102  * meets 'mf''s prerequisites. */
 103 bool
 104 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
 105 {
 106     switch (mf->id) {
 107     case MFF_DP_HASH:
 108         return !wc->masks.dp_hash;
 109     case MFF_RECIRC_ID:
 110         return !wc->masks.recirc_id;
 111     case MFF_TUN_SRC:
 112         return !wc->masks.tunnel.ip_src;
 113     case MFF_TUN_DST:
 114         return !wc->masks.tunnel.ip_dst;
 115     case MFF_TUN_ID:
 116     case MFF_TUN_TOS:
 117     case MFF_TUN_TTL:
 118     case MFF_TUN_FLAGS:
 119         return !wc->masks.tunnel.tun_id;
 120     case MFF_METADATA:
 121         return !wc->masks.metadata;
 122     case MFF_IN_PORT:
 123     case MFF_IN_PORT_OXM:
 124         return !wc->masks.in_port.ofp_port;
 125     case MFF_SKB_PRIORITY:
 126         return !wc->masks.skb_priority;
 127     case MFF_PKT_MARK:
 128         return !wc->masks.pkt_mark;
 129     CASE_MFF_REGS:
 130         return !wc->masks.regs[mf->id - MFF_REG0];
 131     CASE_MFF_XREGS:
 132         return !flow_get_xreg(&wc->masks, mf->id - MFF_XREG0);
 133     case MFF_ACTSET_OUTPUT:
 134         return !wc->masks.actset_output;
 135
 136     case MFF_ETH_SRC:
 137         return eth_addr_is_zero(wc->masks.dl_src);
 138     case MFF_ETH_DST:
 139         return eth_addr_is_zero(wc->masks.dl_dst);
 140     case MFF_ETH_TYPE:
 141         return !wc->masks.dl_type;
 142
 143     case MFF_ARP_SHA:
 144     case MFF_ND_SLL:
 145         return eth_addr_is_zero(wc->masks.arp_sha);
 146
 147     case MFF_ARP_THA:
 148     case MFF_ND_TLL:
 149         return eth_addr_is_zero(wc->masks.arp_tha);
 150
 151     case MFF_VLAN_TCI:
 152         return !wc->masks.vlan_tci;
 153     case MFF_DL_VLAN:
 154         return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
 155     case MFF_VLAN_VID:
 156         return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
 157     case MFF_DL_VLAN_PCP:
 158     case MFF_VLAN_PCP:
 159         return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
 160
 161     case MFF_MPLS_LABEL:
 162         return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
 163     case MFF_MPLS_TC:
 164         return !(wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK));
 165     case MFF_MPLS_BOS:
 166         return !(wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK));
 167
 168     case MFF_IPV4_SRC:
 169         return !wc->masks.nw_src;
 170     case MFF_IPV4_DST:
 171         return !wc->masks.nw_dst;
 172
 173     case MFF_IPV6_SRC:
 174         return ipv6_mask_is_any(&wc->masks.ipv6_src);
 175     case MFF_IPV6_DST:
 176         return ipv6_mask_is_any(&wc->masks.ipv6_dst);
 177
 178     case MFF_IPV6_LABEL:
 179         return !wc->masks.ipv6_label;
 180
 181     case MFF_IP_PROTO:
 182         return !wc->masks.nw_proto;
 183     case MFF_IP_DSCP:
 184     case MFF_IP_DSCP_SHIFTED:
 185         return !(wc->masks.nw_tos & IP_DSCP_MASK);
 186     case MFF_IP_ECN:
 187         return !(wc->masks.nw_tos & IP_ECN_MASK);
 188     case MFF_IP_TTL:
 189         return !wc->masks.nw_ttl;
 190
 191     case MFF_ND_TARGET:
 192         return ipv6_mask_is_any(&wc->masks.nd_target);
 193
 194     case MFF_IP_FRAG:
 195         return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
 196
 197     case MFF_ARP_OP:
 198         return !wc->masks.nw_proto;
 199     case MFF_ARP_SPA:
 200         return !wc->masks.nw_src;
 201     case MFF_ARP_TPA:
 202         return !wc->masks.nw_dst;
 203
 204     case MFF_TCP_SRC:
 205     case MFF_UDP_SRC:
 206     case MFF_SCTP_SRC:
 207     case MFF_ICMPV4_TYPE:
 208     case MFF_ICMPV6_TYPE:
 209         return !wc->masks.tp_src;
 210     case MFF_TCP_DST:
 211     case MFF_UDP_DST:
 212     case MFF_SCTP_DST:
 213     case MFF_ICMPV4_CODE:
 214     case MFF_ICMPV6_CODE:
 215         return !wc->masks.tp_dst;
 216     case MFF_TCP_FLAGS:
 217         return !wc->masks.tcp_flags;
 218
 219     case MFF_N_IDS:
 220     default:
 221         OVS_NOT_REACHED();
 222     }
 223 }
 224
 225 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
 226  * Each bit in 'mask' will be set to 1 if the bit is significant for matching
 227  * purposes, or to 0 if it is wildcarded.
 228  *
 229  * The caller is responsible for ensuring that 'wc' corresponds to a flow that
 230  * meets 'mf''s prerequisites. */
 231 void
 232 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
 233             union mf_value *mask)
 234 {
 235     mf_get_value(mf, &wc->masks, mask);
 236 }
 237
 238 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'.  Returns true
 239  * if the mask is valid, false otherwise. */
 240 bool
 241 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
 242 {
 243     switch (mf->maskable) {
 244     case MFM_NONE:
 245         return (is_all_zeros(mask, mf->n_bytes) ||
 246                 is_all_ones(mask, mf->n_bytes));
 247
 248     case MFM_FULLY:
 249         return true;
 250     }
 251
 252     OVS_NOT_REACHED();
 253 }
 254
 255 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
 256 bool
 257 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
 258 {
 259     switch (mf->prereqs) {
 260     case MFP_NONE:
 261         return true;
 262
 263     case MFP_ARP:
 264       return (flow->dl_type == htons(ETH_TYPE_ARP) ||
 265               flow->dl_type == htons(ETH_TYPE_RARP));
 266     case MFP_IPV4:
 267         return flow->dl_type == htons(ETH_TYPE_IP);
 268     case MFP_IPV6:
 269         return flow->dl_type == htons(ETH_TYPE_IPV6);
 270     case MFP_VLAN_VID:
 271         return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
 272     case MFP_MPLS:
 273         return eth_type_mpls(flow->dl_type);
 274     case MFP_IP_ANY:
 275         return is_ip_any(flow);
 276
 277     case MFP_TCP:
 278         return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP
 279             && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
 280     case MFP_UDP:
 281         return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP
 282             && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
 283     case MFP_SCTP:
 284         return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP
 285             && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
 286     case MFP_ICMPV4:
 287         return is_icmpv4(flow);
 288     case MFP_ICMPV6:
 289         return is_icmpv6(flow);
 290
 291     case MFP_ND:
 292         return (is_icmpv6(flow)
 293                 && flow->tp_dst == htons(0)
 294                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
 295                     flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
 296     case MFP_ND_SOLICIT:
 297         return (is_icmpv6(flow)
 298                 && flow->tp_dst == htons(0)
 299                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
 300     case MFP_ND_ADVERT:
 301         return (is_icmpv6(flow)
 302                 && flow->tp_dst == htons(0)
 303                 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
 304     }
 305
 306     OVS_NOT_REACHED();
 307 }
 308
 309 /* Set field and it's prerequisities in the mask.
 310  * This is only ever called for writeable 'mf's, but we do not make the
 311  * distinction here. */
 312 void
 313 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
 314 {
 315     static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
 316
 317     mf_set_flow_value(mf, &exact_match_mask, mask);
 318
 319     switch (mf->prereqs) {
 320     case MFP_ND:
 321     case MFP_ND_SOLICIT:
 322     case MFP_ND_ADVERT:
 323         mask->tp_src = OVS_BE16_MAX;
 324         mask->tp_dst = OVS_BE16_MAX;
 325         /* Fall through. */
 326     case MFP_TCP:
 327     case MFP_UDP:
 328     case MFP_SCTP:
 329     case MFP_ICMPV4:
 330     case MFP_ICMPV6:
 331         /* nw_frag always unwildcarded. */
 332         mask->nw_proto = 0xff;
 333         /* Fall through. */
 334     case MFP_ARP:
 335     case MFP_IPV4:
 336     case MFP_IPV6:
 337     case MFP_MPLS:
 338     case MFP_IP_ANY:
 339         mask->dl_type = OVS_BE16_MAX;
 340         break;
 341     case MFP_VLAN_VID:
 342         mask->vlan_tci |= htons(VLAN_CFI);
 343         break;
 344     case MFP_NONE:
 345         break;
 346     }
 347 }
 348
 349
 350 /* Returns true if 'value' may be a valid value *as part of a masked match*,
 351  * false otherwise.
 352  *
 353  * A value is not rejected just because it is not valid for the field in
 354  * question, but only if it doesn't make sense to test the bits in question at
 355  * all.  For example, the MFF_VLAN_TCI field will never have a nonzero value
 356  * without the VLAN_CFI bit being set, but we can't reject those values because
 357  * it is still legitimate to test just for those bits (see the documentation
 358  * for NXM_OF_VLAN_TCI in nicira-ext.h).  On the other hand, there is never a
 359  * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
 360 bool
 361 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
 362 {
 363     switch (mf->id) {
 364     case MFF_DP_HASH:
 365     case MFF_RECIRC_ID:
 366     case MFF_TUN_ID:
 367     case MFF_TUN_SRC:
 368     case MFF_TUN_DST:
 369     case MFF_TUN_TOS:
 370     case MFF_TUN_TTL:
 371     case MFF_TUN_FLAGS:
 372     case MFF_METADATA:
 373     case MFF_IN_PORT:
 374     case MFF_SKB_PRIORITY:
 375     case MFF_PKT_MARK:
 376     CASE_MFF_REGS:
 377     CASE_MFF_XREGS:
 378     case MFF_ETH_SRC:
 379     case MFF_ETH_DST:
 380     case MFF_ETH_TYPE:
 381     case MFF_VLAN_TCI:
 382     case MFF_IPV4_SRC:
 383     case MFF_IPV4_DST:
 384     case MFF_IPV6_SRC:
 385     case MFF_IPV6_DST:
 386     case MFF_IP_PROTO:
 387     case MFF_IP_TTL:
 388     case MFF_ARP_SPA:
 389     case MFF_ARP_TPA:
 390     case MFF_ARP_SHA:
 391     case MFF_ARP_THA:
 392     case MFF_TCP_SRC:
 393     case MFF_TCP_DST:
 394     case MFF_UDP_SRC:
 395     case MFF_UDP_DST:
 396     case MFF_SCTP_SRC:
 397     case MFF_SCTP_DST:
 398     case MFF_ICMPV4_TYPE:
 399     case MFF_ICMPV4_CODE:
 400     case MFF_ICMPV6_TYPE:
 401     case MFF_ICMPV6_CODE:
 402     case MFF_ND_TARGET:
 403     case MFF_ND_SLL:
 404     case MFF_ND_TLL:
 405         return true;
 406
 407     case MFF_IN_PORT_OXM:
 408     case MFF_ACTSET_OUTPUT: {
 409         ofp_port_t port;
 410         return !ofputil_port_from_ofp11(value->be32, &port);
 411     }
 412
 413     case MFF_IP_DSCP:
 414         return !(value->u8 & ~IP_DSCP_MASK);
 415     case MFF_IP_DSCP_SHIFTED:
 416         return !(value->u8 & (~IP_DSCP_MASK >> 2));
 417     case MFF_IP_ECN:
 418         return !(value->u8 & ~IP_ECN_MASK);
 419     case MFF_IP_FRAG:
 420         return !(value->u8 & ~FLOW_NW_FRAG_MASK);
 421     case MFF_TCP_FLAGS:
 422         return !(value->be16 & ~htons(0x0fff));
 423
 424     case MFF_ARP_OP:
 425         return !(value->be16 & htons(0xff00));
 426
 427     case MFF_DL_VLAN:
 428         return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
 429     case MFF_VLAN_VID:
 430         return !(value->be16 & htons(VLAN_PCP_MASK));
 431
 432     case MFF_DL_VLAN_PCP:
 433     case MFF_VLAN_PCP:
 434         return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
 435
 436     case MFF_IPV6_LABEL:
 437         return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
 438
 439     case MFF_MPLS_LABEL:
 440         return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
 441
 442     case MFF_MPLS_TC:
 443         return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
 444
 445     case MFF_MPLS_BOS:
 446         return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
 447
 448     case MFF_N_IDS:
 449     default:
 450         OVS_NOT_REACHED();
 451     }
 452 }
 453
 454 /* Copies the value of field 'mf' from 'flow' into 'value'.  The caller is
 455  * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
 456 void
 457 mf_get_value(const struct mf_field *mf, const struct flow *flow,
 458              union mf_value *value)
 459 {
 460     switch (mf->id) {
 461     case MFF_DP_HASH:
 462         value->be32 = htonl(flow->dp_hash);
 463         break;
 464     case MFF_RECIRC_ID:
 465         value->be32 = htonl(flow->recirc_id);
 466         break;
 467     case MFF_TUN_ID:
 468         value->be64 = flow->tunnel.tun_id;
 469         break;
 470     case MFF_TUN_SRC:
 471         value->be32 = flow->tunnel.ip_src;
 472         break;
 473     case MFF_TUN_DST:
 474         value->be32 = flow->tunnel.ip_dst;
 475         break;
 476     case MFF_TUN_FLAGS:
 477         value->be16 = htons(flow->tunnel.flags);
 478         break;
 479     case MFF_TUN_TTL:
 480         value->u8 = flow->tunnel.ip_ttl;
 481         break;
 482     case MFF_TUN_TOS:
 483         value->u8 = flow->tunnel.ip_tos;
 484         break;
 485
 486     case MFF_METADATA:
 487         value->be64 = flow->metadata;
 488         break;
 489
 490     case MFF_IN_PORT:
 491         value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
 492         break;
 493     case MFF_IN_PORT_OXM:
 494         value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
 495         break;
 496     case MFF_ACTSET_OUTPUT:
 497         value->be32 = ofputil_port_to_ofp11(flow->actset_output);
 498         break;
 499
 500     case MFF_SKB_PRIORITY:
 501         value->be32 = htonl(flow->skb_priority);
 502         break;
 503
 504     case MFF_PKT_MARK:
 505         value->be32 = htonl(flow->pkt_mark);
 506         break;
 507
 508     CASE_MFF_REGS:
 509         value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
 510         break;
 511
 512     CASE_MFF_XREGS:
 513         value->be64 = htonll(flow_get_xreg(flow, mf->id - MFF_XREG0));
 514         break;
 515
 516     case MFF_ETH_SRC:
 517         memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
 518         break;
 519
 520     case MFF_ETH_DST:
 521         memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
 522         break;
 523
 524     case MFF_ETH_TYPE:
 525         value->be16 = flow->dl_type;
 526         break;
 527
 528     case MFF_VLAN_TCI:
 529         value->be16 = flow->vlan_tci;
 530         break;
 531
 532     case MFF_DL_VLAN:
 533         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
 534         break;
 535     case MFF_VLAN_VID:
 536         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
 537         break;
 538
 539     case MFF_DL_VLAN_PCP:
 540     case MFF_VLAN_PCP:
 541         value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
 542         break;
 543
 544     case MFF_MPLS_LABEL:
 545         value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
 546         break;
 547
 548     case MFF_MPLS_TC:
 549         value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
 550         break;
 551
 552     case MFF_MPLS_BOS:
 553         value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
 554         break;
 555
 556     case MFF_IPV4_SRC:
 557         value->be32 = flow->nw_src;
 558         break;
 559
 560     case MFF_IPV4_DST:
 561         value->be32 = flow->nw_dst;
 562         break;
 563
 564     case MFF_IPV6_SRC:
 565         value->ipv6 = flow->ipv6_src;
 566         break;
 567
 568     case MFF_IPV6_DST:
 569         value->ipv6 = flow->ipv6_dst;
 570         break;
 571
 572     case MFF_IPV6_LABEL:
 573         value->be32 = flow->ipv6_label;
 574         break;
 575
 576     case MFF_IP_PROTO:
 577         value->u8 = flow->nw_proto;
 578         break;
 579
 580     case MFF_IP_DSCP:
 581         value->u8 = flow->nw_tos & IP_DSCP_MASK;
 582         break;
 583
 584     case MFF_IP_DSCP_SHIFTED:
 585         value->u8 = flow->nw_tos >> 2;
 586         break;
 587
 588     case MFF_IP_ECN:
 589         value->u8 = flow->nw_tos & IP_ECN_MASK;
 590         break;
 591
 592     case MFF_IP_TTL:
 593         value->u8 = flow->nw_ttl;
 594         break;
 595
 596     case MFF_IP_FRAG:
 597         value->u8 = flow->nw_frag;
 598         break;
 599
 600     case MFF_ARP_OP:
 601         value->be16 = htons(flow->nw_proto);
 602         break;
 603
 604     case MFF_ARP_SPA:
 605         value->be32 = flow->nw_src;
 606         break;
 607
 608     case MFF_ARP_TPA:
 609         value->be32 = flow->nw_dst;
 610         break;
 611
 612     case MFF_ARP_SHA:
 613     case MFF_ND_SLL:
 614         memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
 615         break;
 616
 617     case MFF_ARP_THA:
 618     case MFF_ND_TLL:
 619         memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
 620         break;
 621
 622     case MFF_TCP_SRC:
 623     case MFF_UDP_SRC:
 624     case MFF_SCTP_SRC:
 625         value->be16 = flow->tp_src;
 626         break;
 627
 628     case MFF_TCP_DST:
 629     case MFF_UDP_DST:
 630     case MFF_SCTP_DST:
 631         value->be16 = flow->tp_dst;
 632         break;
 633
 634     case MFF_TCP_FLAGS:
 635         value->be16 = flow->tcp_flags;
 636         break;
 637
 638     case MFF_ICMPV4_TYPE:
 639     case MFF_ICMPV6_TYPE:
 640         value->u8 = ntohs(flow->tp_src);
 641         break;
 642
 643     case MFF_ICMPV4_CODE:
 644     case MFF_ICMPV6_CODE:
 645         value->u8 = ntohs(flow->tp_dst);
 646         break;
 647
 648     case MFF_ND_TARGET:
 649         value->ipv6 = flow->nd_target;
 650         break;
 651
 652     case MFF_N_IDS:
 653     default:
 654         OVS_NOT_REACHED();
 655     }
 656 }
 657
 658 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
 659  * 'value'.  The caller is responsible for ensuring that 'match' meets 'mf''s
 660  * prerequisites. */
 661 void
 662 mf_set_value(const struct mf_field *mf,
 663              const union mf_value *value, struct match *match)
 664 {
 665     switch (mf->id) {
 666     case MFF_DP_HASH:
 667         match_set_dp_hash(match, ntohl(value->be32));
 668         break;
 669     case MFF_RECIRC_ID:
 670         match_set_recirc_id(match, ntohl(value->be32));
 671         break;
 672     case MFF_TUN_ID:
 673         match_set_tun_id(match, value->be64);
 674         break;
 675     case MFF_TUN_SRC:
 676         match_set_tun_src(match, value->be32);
 677         break;
 678     case MFF_TUN_DST:
 679         match_set_tun_dst(match, value->be32);
 680         break;
 681     case MFF_TUN_FLAGS:
 682         match_set_tun_flags(match, ntohs(value->be16));
 683         break;
 684     case MFF_TUN_TOS:
 685         match_set_tun_tos(match, value->u8);
 686         break;
 687     case MFF_TUN_TTL:
 688         match_set_tun_ttl(match, value->u8);
 689         break;
 690
 691     case MFF_METADATA:
 692         match_set_metadata(match, value->be64);
 693         break;
 694
 695     case MFF_IN_PORT:
 696         match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
 697         break;
 698
 699     case MFF_IN_PORT_OXM: {
 700         ofp_port_t port;
 701         ofputil_port_from_ofp11(value->be32, &port);
 702         match_set_in_port(match, port);
 703         break;
 704     }
 705     case MFF_ACTSET_OUTPUT: {
 706         ofp_port_t port;
 707         ofputil_port_from_ofp11(value->be32, &port);
 708         match_set_actset_output(match, port);
 709         break;
 710     }
 711
 712     case MFF_SKB_PRIORITY:
 713         match_set_skb_priority(match, ntohl(value->be32));
 714         break;
 715
 716     case MFF_PKT_MARK:
 717         match_set_pkt_mark(match, ntohl(value->be32));
 718         break;
 719
 720     CASE_MFF_REGS:
 721         match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
 722         break;
 723
 724     CASE_MFF_XREGS:
 725         match_set_xreg(match, mf->id - MFF_XREG0, ntohll(value->be64));
 726         break;
 727
 728     case MFF_ETH_SRC:
 729         match_set_dl_src(match, value->mac);
 730         break;
 731
 732     case MFF_ETH_DST:
 733         match_set_dl_dst(match, value->mac);
 734         break;
 735
 736     case MFF_ETH_TYPE:
 737         match_set_dl_type(match, value->be16);
 738         break;
 739
 740     case MFF_VLAN_TCI:
 741         match_set_dl_tci(match, value->be16);
 742         break;
 743
 744     case MFF_DL_VLAN:
 745         match_set_dl_vlan(match, value->be16);
 746         break;
 747     case MFF_VLAN_VID:
 748         match_set_vlan_vid(match, value->be16);
 749         break;
 750
 751     case MFF_DL_VLAN_PCP:
 752     case MFF_VLAN_PCP:
 753         match_set_dl_vlan_pcp(match, value->u8);
 754         break;
 755
 756     case MFF_MPLS_LABEL:
 757         match_set_mpls_label(match, 0, value->be32);
 758         break;
 759
 760     case MFF_MPLS_TC:
 761         match_set_mpls_tc(match, 0, value->u8);
 762         break;
 763
 764     case MFF_MPLS_BOS:
 765         match_set_mpls_bos(match, 0, value->u8);
 766         break;
 767
 768     case MFF_IPV4_SRC:
 769         match_set_nw_src(match, value->be32);
 770         break;
 771
 772     case MFF_IPV4_DST:
 773         match_set_nw_dst(match, value->be32);
 774         break;
 775
 776     case MFF_IPV6_SRC:
 777         match_set_ipv6_src(match, &value->ipv6);
 778         break;
 779
 780     case MFF_IPV6_DST:
 781         match_set_ipv6_dst(match, &value->ipv6);
 782         break;
 783
 784     case MFF_IPV6_LABEL:
 785         match_set_ipv6_label(match, value->be32);
 786         break;
 787
 788     case MFF_IP_PROTO:
 789         match_set_nw_proto(match, value->u8);
 790         break;
 791
 792     case MFF_IP_DSCP:
 793         match_set_nw_dscp(match, value->u8);
 794         break;
 795
 796     case MFF_IP_DSCP_SHIFTED:
 797         match_set_nw_dscp(match, value->u8 << 2);
 798         break;
 799
 800     case MFF_IP_ECN:
 801         match_set_nw_ecn(match, value->u8);
 802         break;
 803
 804     case MFF_IP_TTL:
 805         match_set_nw_ttl(match, value->u8);
 806         break;
 807
 808     case MFF_IP_FRAG:
 809         match_set_nw_frag(match, value->u8);
 810         break;
 811
 812     case MFF_ARP_OP:
 813         match_set_nw_proto(match, ntohs(value->be16));
 814         break;
 815
 816     case MFF_ARP_SPA:
 817         match_set_nw_src(match, value->be32);
 818         break;
 819
 820     case MFF_ARP_TPA:
 821         match_set_nw_dst(match, value->be32);
 822         break;
 823
 824     case MFF_ARP_SHA:
 825     case MFF_ND_SLL:
 826         match_set_arp_sha(match, value->mac);
 827         break;
 828
 829     case MFF_ARP_THA:
 830     case MFF_ND_TLL:
 831         match_set_arp_tha(match, value->mac);
 832         break;
 833
 834     case MFF_TCP_SRC:
 835     case MFF_UDP_SRC:
 836     case MFF_SCTP_SRC:
 837         match_set_tp_src(match, value->be16);
 838         break;
 839
 840     case MFF_TCP_DST:
 841     case MFF_UDP_DST:
 842     case MFF_SCTP_DST:
 843         match_set_tp_dst(match, value->be16);
 844         break;
 845
 846     case MFF_TCP_FLAGS:
 847         match_set_tcp_flags(match, value->be16);
 848         break;
 849
 850     case MFF_ICMPV4_TYPE:
 851     case MFF_ICMPV6_TYPE:
 852         match_set_icmp_type(match, value->u8);
 853         break;
 854
 855     case MFF_ICMPV4_CODE:
 856     case MFF_ICMPV6_CODE:
 857         match_set_icmp_code(match, value->u8);
 858         break;
 859
 860     case MFF_ND_TARGET:
 861         match_set_nd_target(match, &value->ipv6);
 862         break;
 863
 864     case MFF_N_IDS:
 865     default:
 866         OVS_NOT_REACHED();
 867     }
 868 }
 869
 870 /* Unwildcard 'mask' member field described by 'mf'.  The caller is
 871  * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
 872 void
 873 mf_mask_field(const struct mf_field *mf, struct flow *mask)
 874 {
 875     static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
 876
 877     /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
 878      * as that will be considered as OFP10_VLAN_NONE. So consider it as a
 879      * special case. For the rest, calling mf_set_flow_value() is good
 880      * enough. */
 881     if (mf->id == MFF_DL_VLAN) {
 882         flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
 883     } else {
 884         mf_set_flow_value(mf, &exact_match_mask, mask);
 885     }
 886 }
 887
 888 /* Sets 'flow' member field described by 'mf' to 'value'.  The caller is
 889  * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
 890 void
 891 mf_set_flow_value(const struct mf_field *mf,
 892                   const union mf_value *value, struct flow *flow)
 893 {
 894     switch (mf->id) {
 895     case MFF_DP_HASH:
 896         flow->dp_hash = ntohl(value->be32);
 897         break;
 898     case MFF_RECIRC_ID:
 899         flow->recirc_id = ntohl(value->be32);
 900         break;
 901     case MFF_TUN_ID:
 902         flow->tunnel.tun_id = value->be64;
 903         break;
 904     case MFF_TUN_SRC:
 905         flow->tunnel.ip_src = value->be32;
 906         break;
 907     case MFF_TUN_DST:
 908         flow->tunnel.ip_dst = value->be32;
 909         break;
 910     case MFF_TUN_FLAGS:
 911         flow->tunnel.flags = ntohs(value->be16);
 912         break;
 913     case MFF_TUN_TOS:
 914         flow->tunnel.ip_tos = value->u8;
 915         break;
 916     case MFF_TUN_TTL:
 917         flow->tunnel.ip_ttl = value->u8;
 918         break;
 919
 920     case MFF_METADATA:
 921         flow->metadata = value->be64;
 922         break;
 923
 924     case MFF_IN_PORT:
 925         flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
 926         break;
 927
 928     case MFF_IN_PORT_OXM:
 929         ofputil_port_from_ofp11(value->be32, &flow->in_port.ofp_port);
 930         break;
 931     case MFF_ACTSET_OUTPUT:
 932         ofputil_port_from_ofp11(value->be32, &flow->actset_output);
 933         break;
 934
 935     case MFF_SKB_PRIORITY:
 936         flow->skb_priority = ntohl(value->be32);
 937         break;
 938
 939     case MFF_PKT_MARK:
 940         flow->pkt_mark = ntohl(value->be32);
 941         break;
 942
 943     CASE_MFF_REGS:
 944         flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
 945         break;
 946
 947     CASE_MFF_XREGS:
 948         flow_set_xreg(flow, mf->id - MFF_XREG0, ntohll(value->be64));
 949         break;
 950
 951     case MFF_ETH_SRC:
 952         memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
 953         break;
 954
 955     case MFF_ETH_DST:
 956         memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
 957         break;
 958
 959     case MFF_ETH_TYPE:
 960         flow->dl_type = value->be16;
 961         break;
 962
 963     case MFF_VLAN_TCI:
 964         flow->vlan_tci = value->be16;
 965         break;
 966
 967     case MFF_DL_VLAN:
 968         flow_set_dl_vlan(flow, value->be16);
 969         break;
 970     case MFF_VLAN_VID:
 971         flow_set_vlan_vid(flow, value->be16);
 972         break;
 973
 974     case MFF_DL_VLAN_PCP:
 975     case MFF_VLAN_PCP:
 976         flow_set_vlan_pcp(flow, value->u8);
 977         break;
 978
 979     case MFF_MPLS_LABEL:
 980         flow_set_mpls_label(flow, 0, value->be32);
 981         break;
 982
 983     case MFF_MPLS_TC:
 984         flow_set_mpls_tc(flow, 0, value->u8);
 985         break;
 986
 987     case MFF_MPLS_BOS:
 988         flow_set_mpls_bos(flow, 0, value->u8);
 989         break;
 990
 991     case MFF_IPV4_SRC:
 992         flow->nw_src = value->be32;
 993         break;
 994
 995     case MFF_IPV4_DST:
 996         flow->nw_dst = value->be32;
 997         break;
 998
 999     case MFF_IPV6_SRC:
1000         flow->ipv6_src = value->ipv6;
1001         break;
1002
1003     case MFF_IPV6_DST:
1004         flow->ipv6_dst = value->ipv6;
1005         break;
1006
1007     case MFF_IPV6_LABEL:
1008         flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1009         break;
1010
1011     case MFF_IP_PROTO:
1012         flow->nw_proto = value->u8;
1013         break;
1014
1015     case MFF_IP_DSCP:
1016         flow->nw_tos &= ~IP_DSCP_MASK;
1017         flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1018         break;
1019
1020     case MFF_IP_DSCP_SHIFTED:
1021         flow->nw_tos &= ~IP_DSCP_MASK;
1022         flow->nw_tos |= value->u8 << 2;
1023         break;
1024
1025     case MFF_IP_ECN:
1026         flow->nw_tos &= ~IP_ECN_MASK;
1027         flow->nw_tos |= value->u8 & IP_ECN_MASK;
1028         break;
1029
1030     case MFF_IP_TTL:
1031         flow->nw_ttl = value->u8;
1032         break;
1033
1034     case MFF_IP_FRAG:
1035         flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1036         break;
1037
1038     case MFF_ARP_OP:
1039         flow->nw_proto = ntohs(value->be16);
1040         break;
1041
1042     case MFF_ARP_SPA:
1043         flow->nw_src = value->be32;
1044         break;
1045
1046     case MFF_ARP_TPA:
1047         flow->nw_dst = value->be32;
1048         break;
1049
1050     case MFF_ARP_SHA:
1051     case MFF_ND_SLL:
1052         memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1053         break;
1054
1055     case MFF_ARP_THA:
1056     case MFF_ND_TLL:
1057         memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1058         break;
1059
1060     case MFF_TCP_SRC:
1061     case MFF_UDP_SRC:
1062     case MFF_SCTP_SRC:
1063         flow->tp_src = value->be16;
1064         break;
1065
1066     case MFF_TCP_DST:
1067     case MFF_UDP_DST:
1068     case MFF_SCTP_DST:
1069         flow->tp_dst = value->be16;
1070         break;
1071
1072     case MFF_TCP_FLAGS:
1073         flow->tcp_flags = value->be16;
1074         break;
1075
1076     case MFF_ICMPV4_TYPE:
1077     case MFF_ICMPV6_TYPE:
1078         flow->tp_src = htons(value->u8);
1079         break;
1080
1081     case MFF_ICMPV4_CODE:
1082     case MFF_ICMPV6_CODE:
1083         flow->tp_dst = htons(value->u8);
1084         break;
1085
1086     case MFF_ND_TARGET:
1087         flow->nd_target = value->ipv6;
1088         break;
1089
1090     case MFF_N_IDS:
1091     default:
1092         OVS_NOT_REACHED();
1093     }
1094 }
1095
1096 /* Consider each of 'src', 'mask', and 'dst' as if they were arrays of 8*n
1097  * bits.  Then, for each 0 <= i < 8 * n such that mask[i] == 1, sets dst[i] =
1098  * src[i].  */
1099 static void
1100 apply_mask(const uint8_t *src, const uint8_t *mask, uint8_t *dst, size_t n)
1101 {
1102     size_t i;
1103
1104     for (i = 0; i < n; i++) {
1105         dst[i] = (src[i] & mask[i]) | (dst[i] & ~mask[i]);
1106     }
1107 }
1108
1109 /* Sets 'flow' member field described by 'field' to 'value', except that bits
1110  * for which 'mask' has a 0-bit keep their existing values.  The caller is
1111  * responsible for ensuring that 'flow' meets 'field''s prerequisites.*/
1112 void
1113 mf_set_flow_value_masked(const struct mf_field *field,
1114                          const union mf_value *value,
1115                          const union mf_value *mask,
1116                          struct flow *flow)
1117 {
1118     union mf_value tmp;
1119
1120     mf_get_value(field, flow, &tmp);
1121     apply_mask((const uint8_t *) value, (const uint8_t *) mask,
1122                (uint8_t *) &tmp, field->n_bytes);
1123     mf_set_flow_value(field, &tmp, flow);
1124 }
1125
1126 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1127  *
1128  * The caller is responsible for ensuring that 'flow' meets 'mf''s
1129  * prerequisites. */
1130 bool
1131 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1132 {
1133     union mf_value value;
1134
1135     mf_get_value(mf, flow, &value);
1136     return is_all_zeros(&value, mf->n_bytes);
1137 }
1138
1139 /* Makes 'match' wildcard field 'mf'.
1140  *
1141  * The caller is responsible for ensuring that 'match' meets 'mf''s
1142  * prerequisites. */
1143 void
1144 mf_set_wild(const struct mf_field *mf, struct match *match)
1145 {
1146     switch (mf->id) {
1147     case MFF_DP_HASH:
1148         match->flow.dp_hash = 0;
1149         match->wc.masks.dp_hash = 0;
1150         break;
1151     case MFF_RECIRC_ID:
1152         match->flow.recirc_id = 0;
1153         match->wc.masks.recirc_id = 0;
1154         break;
1155     case MFF_TUN_ID:
1156         match_set_tun_id_masked(match, htonll(0), htonll(0));
1157         break;
1158     case MFF_TUN_SRC:
1159         match_set_tun_src_masked(match, htonl(0), htonl(0));
1160         break;
1161     case MFF_TUN_DST:
1162         match_set_tun_dst_masked(match, htonl(0), htonl(0));
1163         break;
1164     case MFF_TUN_FLAGS:
1165         match_set_tun_flags_masked(match, 0, 0);
1166         break;
1167     case MFF_TUN_TOS:
1168         match_set_tun_tos_masked(match, 0, 0);
1169         break;
1170     case MFF_TUN_TTL:
1171         match_set_tun_ttl_masked(match, 0, 0);
1172         break;
1173
1174     case MFF_METADATA:
1175         match_set_metadata_masked(match, htonll(0), htonll(0));
1176         break;
1177
1178     case MFF_IN_PORT:
1179     case MFF_IN_PORT_OXM:
1180         match->flow.in_port.ofp_port = 0;
1181         match->wc.masks.in_port.ofp_port = 0;
1182         break;
1183     case MFF_ACTSET_OUTPUT:
1184         match->flow.actset_output = 0;
1185         match->wc.masks.actset_output = 0;
1186         break;
1187
1188     case MFF_SKB_PRIORITY:
1189         match->flow.skb_priority = 0;
1190         match->wc.masks.skb_priority = 0;
1191         break;
1192
1193     case MFF_PKT_MARK:
1194         match->flow.pkt_mark = 0;
1195         match->wc.masks.pkt_mark = 0;
1196         break;
1197
1198     CASE_MFF_REGS:
1199         match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1200         break;
1201
1202     CASE_MFF_XREGS:
1203         match_set_xreg_masked(match, mf->id - MFF_XREG0, 0, 0);
1204         break;
1205
1206     case MFF_ETH_SRC:
1207         memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1208         memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1209         break;
1210
1211     case MFF_ETH_DST:
1212         memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1213         memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1214         break;
1215
1216     case MFF_ETH_TYPE:
1217         match->flow.dl_type = htons(0);
1218         match->wc.masks.dl_type = htons(0);
1219         break;
1220
1221     case MFF_VLAN_TCI:
1222         match_set_dl_tci_masked(match, htons(0), htons(0));
1223         break;
1224
1225     case MFF_DL_VLAN:
1226     case MFF_VLAN_VID:
1227         match_set_any_vid(match);
1228         break;
1229
1230     case MFF_DL_VLAN_PCP:
1231     case MFF_VLAN_PCP:
1232         match_set_any_pcp(match);
1233         break;
1234
1235     case MFF_MPLS_LABEL:
1236         match_set_any_mpls_label(match, 0);
1237         break;
1238
1239     case MFF_MPLS_TC:
1240         match_set_any_mpls_tc(match, 0);
1241         break;
1242
1243     case MFF_MPLS_BOS:
1244         match_set_any_mpls_bos(match, 0);
1245         break;
1246
1247     case MFF_IPV4_SRC:
1248     case MFF_ARP_SPA:
1249         match_set_nw_src_masked(match, htonl(0), htonl(0));
1250         break;
1251
1252     case MFF_IPV4_DST:
1253     case MFF_ARP_TPA:
1254         match_set_nw_dst_masked(match, htonl(0), htonl(0));
1255         break;
1256
1257     case MFF_IPV6_SRC:
1258         memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1259         memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1260         break;
1261
1262     case MFF_IPV6_DST:
1263         memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1264         memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1265         break;
1266
1267     case MFF_IPV6_LABEL:
1268         match->wc.masks.ipv6_label = htonl(0);
1269         match->flow.ipv6_label = htonl(0);
1270         break;
1271
1272     case MFF_IP_PROTO:
1273         match->wc.masks.nw_proto = 0;
1274         match->flow.nw_proto = 0;
1275         break;
1276
1277     case MFF_IP_DSCP:
1278     case MFF_IP_DSCP_SHIFTED:
1279         match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1280         match->flow.nw_tos &= ~IP_DSCP_MASK;
1281         break;
1282
1283     case MFF_IP_ECN:
1284         match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1285         match->flow.nw_tos &= ~IP_ECN_MASK;
1286         break;
1287
1288     case MFF_IP_TTL:
1289         match->wc.masks.nw_ttl = 0;
1290         match->flow.nw_ttl = 0;
1291         break;
1292
1293     case MFF_IP_FRAG:
1294         match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1295         match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1296         break;
1297
1298     case MFF_ARP_OP:
1299         match->wc.masks.nw_proto = 0;
1300         match->flow.nw_proto = 0;
1301         break;
1302
1303     case MFF_ARP_SHA:
1304     case MFF_ND_SLL:
1305         memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1306         memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1307         break;
1308
1309     case MFF_ARP_THA:
1310     case MFF_ND_TLL:
1311         memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1312         memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1313         break;
1314
1315     case MFF_TCP_SRC:
1316     case MFF_UDP_SRC:
1317     case MFF_SCTP_SRC:
1318     case MFF_ICMPV4_TYPE:
1319     case MFF_ICMPV6_TYPE:
1320         match->wc.masks.tp_src = htons(0);
1321         match->flow.tp_src = htons(0);
1322         break;
1323
1324     case MFF_TCP_DST:
1325     case MFF_UDP_DST:
1326     case MFF_SCTP_DST:
1327     case MFF_ICMPV4_CODE:
1328     case MFF_ICMPV6_CODE:
1329         match->wc.masks.tp_dst = htons(0);
1330         match->flow.tp_dst = htons(0);
1331         break;
1332
1333     case MFF_TCP_FLAGS:
1334         match->wc.masks.tcp_flags = htons(0);
1335         match->flow.tcp_flags = htons(0);
1336         break;
1337
1338     case MFF_ND_TARGET:
1339         memset(&match->wc.masks.nd_target, 0,
1340                sizeof match->wc.masks.nd_target);
1341         memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1342         break;
1343
1344     case MFF_N_IDS:
1345     default:
1346         OVS_NOT_REACHED();
1347     }
1348 }
1349
1350 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1351  * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1352  * with a 1-bit indicating that the corresponding value bit must match and a
1353  * 0-bit indicating a don't-care.
1354  *
1355  * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1356  * mf_set_value(mf, value, match).  If 'mask' points to all-0-bits, then this
1357  * call is equivalent to mf_set_wild(mf, match).
1358  *
1359  * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()).  The caller
1360  * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1361 enum ofputil_protocol
1362 mf_set(const struct mf_field *mf,
1363        const union mf_value *value, const union mf_value *mask,
1364        struct match *match)
1365 {
1366     if (!mask || is_all_ones(mask, mf->n_bytes)) {
1367         mf_set_value(mf, value, match);
1368         return mf->usable_protocols_exact;
1369     } else if (is_all_zeros(mask, mf->n_bytes)) {
1370         mf_set_wild(mf, match);
1371         return OFPUTIL_P_ANY;
1372     }
1373
1374     switch (mf->id) {
1375     case MFF_RECIRC_ID:
1376     case MFF_IN_PORT:
1377     case MFF_IN_PORT_OXM:
1378     case MFF_ACTSET_OUTPUT:
1379     case MFF_SKB_PRIORITY:
1380     case MFF_ETH_TYPE:
1381     case MFF_DL_VLAN:
1382     case MFF_DL_VLAN_PCP:
1383     case MFF_VLAN_PCP:
1384     case MFF_MPLS_LABEL:
1385     case MFF_MPLS_TC:
1386     case MFF_MPLS_BOS:
1387     case MFF_IP_PROTO:
1388     case MFF_IP_TTL:
1389     case MFF_IP_DSCP:
1390     case MFF_IP_DSCP_SHIFTED:
1391     case MFF_IP_ECN:
1392     case MFF_ARP_OP:
1393     case MFF_ICMPV4_TYPE:
1394     case MFF_ICMPV4_CODE:
1395     case MFF_ICMPV6_TYPE:
1396     case MFF_ICMPV6_CODE:
1397         return OFPUTIL_P_NONE;
1398
1399     case MFF_DP_HASH:
1400         match_set_dp_hash_masked(match, ntohl(value->be32), ntohl(mask->be32));
1401         break;
1402     case MFF_TUN_ID:
1403         match_set_tun_id_masked(match, value->be64, mask->be64);
1404         break;
1405     case MFF_TUN_SRC:
1406         match_set_tun_src_masked(match, value->be32, mask->be32);
1407         break;
1408     case MFF_TUN_DST:
1409         match_set_tun_dst_masked(match, value->be32, mask->be32);
1410         break;
1411     case MFF_TUN_FLAGS:
1412         match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1413         break;
1414     case MFF_TUN_TTL:
1415         match_set_tun_ttl_masked(match, value->u8, mask->u8);
1416         break;
1417     case MFF_TUN_TOS:
1418         match_set_tun_tos_masked(match, value->u8, mask->u8);
1419         break;
1420
1421     case MFF_METADATA:
1422         match_set_metadata_masked(match, value->be64, mask->be64);
1423         break;
1424
1425     CASE_MFF_REGS:
1426         match_set_reg_masked(match, mf->id - MFF_REG0,
1427                              ntohl(value->be32), ntohl(mask->be32));
1428         break;
1429
1430     CASE_MFF_XREGS:
1431         match_set_xreg_masked(match, mf->id - MFF_XREG0,
1432                               ntohll(value->be64), ntohll(mask->be64));
1433         break;
1434
1435     case MFF_PKT_MARK:
1436         match_set_pkt_mark_masked(match, ntohl(value->be32),
1437                                   ntohl(mask->be32));
1438         break;
1439
1440     case MFF_ETH_DST:
1441         match_set_dl_dst_masked(match, value->mac, mask->mac);
1442         break;
1443
1444     case MFF_ETH_SRC:
1445         match_set_dl_src_masked(match, value->mac, mask->mac);
1446         break;
1447
1448     case MFF_ARP_SHA:
1449     case MFF_ND_SLL:
1450         match_set_arp_sha_masked(match, value->mac, mask->mac);
1451         break;
1452
1453     case MFF_ARP_THA:
1454     case MFF_ND_TLL:
1455         match_set_arp_tha_masked(match, value->mac, mask->mac);
1456         break;
1457
1458     case MFF_VLAN_TCI:
1459         match_set_dl_tci_masked(match, value->be16, mask->be16);
1460         break;
1461
1462     case MFF_VLAN_VID:
1463         match_set_vlan_vid_masked(match, value->be16, mask->be16);
1464         break;
1465
1466     case MFF_IPV4_SRC:
1467         match_set_nw_src_masked(match, value->be32, mask->be32);
1468         break;
1469
1470     case MFF_IPV4_DST:
1471         match_set_nw_dst_masked(match, value->be32, mask->be32);
1472         break;
1473
1474     case MFF_IPV6_SRC:
1475         match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1476         break;
1477
1478     case MFF_IPV6_DST:
1479         match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1480         break;
1481
1482     case MFF_IPV6_LABEL:
1483         if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1484             mf_set_value(mf, value, match);
1485         } else {
1486             match_set_ipv6_label_masked(match, value->be32, mask->be32);
1487         }
1488         break;
1489
1490     case MFF_ND_TARGET:
1491         match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1492         break;
1493
1494     case MFF_IP_FRAG:
1495         match_set_nw_frag_masked(match, value->u8, mask->u8);
1496         break;
1497
1498     case MFF_ARP_SPA:
1499         match_set_nw_src_masked(match, value->be32, mask->be32);
1500         break;
1501
1502     case MFF_ARP_TPA:
1503         match_set_nw_dst_masked(match, value->be32, mask->be32);
1504         break;
1505
1506     case MFF_TCP_SRC:
1507     case MFF_UDP_SRC:
1508     case MFF_SCTP_SRC:
1509         match_set_tp_src_masked(match, value->be16, mask->be16);
1510         break;
1511
1512     case MFF_TCP_DST:
1513     case MFF_UDP_DST:
1514     case MFF_SCTP_DST:
1515         match_set_tp_dst_masked(match, value->be16, mask->be16);
1516         break;
1517
1518     case MFF_TCP_FLAGS:
1519         match_set_tcp_flags_masked(match, value->be16, mask->be16);
1520         break;
1521
1522     case MFF_N_IDS:
1523     default:
1524         OVS_NOT_REACHED();
1525     }
1526
1527     return ((mf->usable_protocols_bitwise == mf->usable_protocols_cidr
1528              || ip_is_cidr(mask->be32))
1529             ? mf->usable_protocols_cidr
1530             : mf->usable_protocols_bitwise);
1531 }
1532
1533 static enum ofperr
1534 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1535            const char *type)
1536 {
1537     if (!sf->field) {
1538         VLOG_WARN_RL(&rl, "unknown %s field", type);
1539         return OFPERR_OFPBAC_BAD_SET_TYPE;
1540     } else if (!sf->n_bits) {
1541         VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1542         return OFPERR_OFPBAC_BAD_SET_LEN;
1543     } else if (sf->ofs >= sf->field->n_bits) {
1544         VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1545                      sf->ofs, sf->field->n_bits, type, sf->field->name);
1546         return OFPERR_OFPBAC_BAD_SET_LEN;
1547     } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1548         VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1549                      "of %s field %s", sf->ofs, sf->n_bits,
1550                      sf->field->n_bits, type, sf->field->name);
1551         return OFPERR_OFPBAC_BAD_SET_LEN;
1552     } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1553         VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1554                      type, sf->field->name);
1555         return OFPERR_OFPBAC_MATCH_INCONSISTENT;
1556     } else {
1557         return 0;
1558     }
1559 }
1560
1561 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'.  Returns
1562  * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1563  * ofp_mkerr()).  */
1564 enum ofperr
1565 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1566 {
1567     return mf_check__(sf, flow, "source");
1568 }
1569
1570 /* Checks whether 'sf' is valid for writing a subfield into 'flow'.  Returns 0
1571  * if so, otherwise an OpenFlow error code (e.g. as returned by
1572  * ofp_mkerr()). */
1573 enum ofperr
1574 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1575 {
1576     int error = mf_check__(sf, flow, "destination");
1577     if (!error && !sf->field->writable) {
1578         VLOG_WARN_RL(&rl, "destination field %s is not writable",
1579                      sf->field->name);
1580         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
1581     }
1582     return error;
1583 }
1584
1585 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1586  * 'value' and 'mask', respectively. */
1587 void
1588 mf_get(const struct mf_field *mf, const struct match *match,
1589        union mf_value *value, union mf_value *mask)
1590 {
1591     mf_get_value(mf, &match->flow, value);
1592     mf_get_mask(mf, &match->wc, mask);
1593 }
1594
1595 static char *
1596 mf_from_integer_string(const struct mf_field *mf, const char *s,
1597                        uint8_t *valuep, uint8_t *maskp)
1598 {
1599     unsigned long long int integer, mask;
1600     char *tail;
1601     int i;
1602
1603     errno = 0;
1604     integer = strtoull(s, &tail, 0);
1605     if (errno || (*tail != '\0' && *tail != '/')) {
1606         goto syntax_error;
1607     }
1608
1609     if (*tail == '/') {
1610         mask = strtoull(tail + 1, &tail, 0);
1611         if (errno || *tail != '\0') {
1612             goto syntax_error;
1613         }
1614     } else {
1615         mask = ULLONG_MAX;
1616     }
1617
1618     for (i = mf->n_bytes - 1; i >= 0; i--) {
1619         valuep[i] = integer;
1620         maskp[i] = mask;
1621         integer >>= 8;
1622         mask >>= 8;
1623     }
1624     if (integer) {
1625         return xasprintf("%s: value too large for %u-byte field %s",
1626                          s, mf->n_bytes, mf->name);
1627     }
1628     return NULL;
1629
1630 syntax_error:
1631     return xasprintf("%s: bad syntax for %s", s, mf->name);
1632 }
1633
1634 static char *
1635 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1636                         uint8_t mac[ETH_ADDR_LEN],
1637                         uint8_t mask[ETH_ADDR_LEN])
1638 {
1639     int n;
1640
1641     ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
1642
1643     n = -1;
1644     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n)
1645         && n == strlen(s)) {
1646         memset(mask, 0xff, ETH_ADDR_LEN);
1647         return NULL;
1648     }
1649
1650     n = -1;
1651     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
1652                  ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n)
1653         && n == strlen(s)) {
1654         return NULL;
1655     }
1656
1657     return xasprintf("%s: invalid Ethernet address", s);
1658 }
1659
1660 static char *
1661 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1662                     ovs_be32 *ip, ovs_be32 *mask)
1663 {
1664     int prefix;
1665
1666     ovs_assert(mf->n_bytes == sizeof *ip);
1667
1668     if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1669                  IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
1670         /* OK. */
1671     } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
1672         if (prefix <= 0 || prefix > 32) {
1673             return xasprintf("%s: network prefix bits not between 0 and "
1674                              "32", s);
1675         }
1676         *mask = be32_prefix_mask(prefix);
1677     } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
1678         *mask = OVS_BE32_MAX;
1679     } else {
1680         return xasprintf("%s: invalid IP address", s);
1681     }
1682     return NULL;
1683 }
1684
1685 static char *
1686 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1687                     struct in6_addr *value, struct in6_addr *mask)
1688 {
1689     char *str = xstrdup(s);
1690     char *save_ptr = NULL;
1691     const char *name, *netmask;
1692     int retval;
1693
1694     ovs_assert(mf->n_bytes == sizeof *value);
1695
1696     name = strtok_r(str, "/", &save_ptr);
1697     retval = name ? lookup_ipv6(name, value) : EINVAL;
1698     if (retval) {
1699         char *err;
1700
1701         err = xasprintf("%s: could not convert to IPv6 address", str);
1702         free(str);
1703
1704         return err;
1705     }
1706
1707     netmask = strtok_r(NULL, "/", &save_ptr);
1708     if (netmask) {
1709         if (inet_pton(AF_INET6, netmask, mask) != 1) {
1710             int prefix = atoi(netmask);
1711             if (prefix <= 0 || prefix > 128) {
1712                 free(str);
1713                 return xasprintf("%s: prefix bits not between 1 and 128", s);
1714             } else {
1715                 *mask = ipv6_create_mask(prefix);
1716             }
1717         }
1718     } else {
1719         *mask = in6addr_exact;
1720     }
1721     free(str);
1722
1723     return NULL;
1724 }
1725
1726 static char *
1727 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
1728                         ovs_be16 *valuep, ovs_be16 *maskp)
1729 {
1730     ofp_port_t port;
1731
1732     ovs_assert(mf->n_bytes == sizeof(ovs_be16));
1733
1734     if (ofputil_port_from_string(s, &port)) {
1735         *valuep = htons(ofp_to_u16(port));
1736         *maskp = OVS_BE16_MAX;
1737         return NULL;
1738     }
1739     return xasprintf("%s: port value out of range for %s", s, mf->name);
1740 }
1741
1742 static char *
1743 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
1744                           ovs_be32 *valuep, ovs_be32 *maskp)
1745 {
1746     ofp_port_t port;
1747
1748     ovs_assert(mf->n_bytes == sizeof(ovs_be32));
1749     if (ofputil_port_from_string(s, &port)) {
1750         *valuep = ofputil_port_to_ofp11(port);
1751         *maskp = OVS_BE32_MAX;
1752         return NULL;
1753     }
1754     return xasprintf("%s: port value out of range for %s", s, mf->name);
1755 }
1756
1757 struct frag_handling {
1758     const char *name;
1759     uint8_t mask;
1760     uint8_t value;
1761 };
1762
1763 static const struct frag_handling all_frags[] = {
1764 #define A FLOW_NW_FRAG_ANY
1765 #define L FLOW_NW_FRAG_LATER
1766     /* name               mask  value */
1767
1768     { "no",               A|L,  0     },
1769     { "first",            A|L,  A     },
1770     { "later",            A|L,  A|L   },
1771
1772     { "no",               A,    0     },
1773     { "yes",              A,    A     },
1774
1775     { "not_later",        L,    0     },
1776     { "later",            L,    L     },
1777 #undef A
1778 #undef L
1779 };
1780
1781 static char *
1782 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
1783 {
1784     const struct frag_handling *h;
1785
1786     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
1787         if (!strcasecmp(s, h->name)) {
1788             /* We force the upper bits of the mask on to make mf_parse_value()
1789              * happy (otherwise it will never think it's an exact match.) */
1790             *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
1791             *valuep = h->value;
1792             return NULL;
1793         }
1794     }
1795
1796     return xasprintf("%s: unknown fragment type (valid types are \"no\", "
1797                      "\"yes\", \"first\", \"later\", \"not_first\"", s);
1798 }
1799
1800 static int
1801 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
1802                      ovs_be16 *res)
1803 {
1804     uint32_t result = 0;
1805     char *save_ptr = NULL;
1806     char *name;
1807     int rc = 0;
1808     char *s = xstrdup(s_);
1809
1810     for (name = strtok_r((char *)s, " |", &save_ptr); name;
1811          name = strtok_r(NULL, " |", &save_ptr)) {
1812         int name_len;
1813         unsigned long long int flags;
1814         uint32_t bit;
1815
1816         if (ovs_scan(name, "%lli", &flags)) {
1817             result |= flags;
1818             continue;
1819         }
1820         name_len = strlen(name);
1821         for (bit = 1; bit; bit <<= 1) {
1822             const char *fname = bit_to_string(bit);
1823             size_t len;
1824
1825             if (!fname) {
1826                 continue;
1827             }
1828
1829             len = strlen(fname);
1830             if (len != name_len) {
1831                 continue;
1832             }
1833             if (!strncmp(name, fname, len)) {
1834                 result |= bit;
1835                 break;
1836             }
1837         }
1838
1839         if (!bit) {
1840             rc = -ENOENT;
1841             goto out;
1842         }
1843     }
1844
1845     *res = htons(result);
1846 out:
1847     free(s);
1848     return rc;
1849 }
1850
1851 static char *
1852 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
1853 {
1854     if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
1855         *maskp = OVS_BE16_MAX;
1856         return NULL;
1857     }
1858
1859     return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
1860                      "\"csum\", \"key\")", s);
1861 }
1862
1863 static char *
1864 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
1865 {
1866     uint16_t flags = 0;
1867     uint16_t mask = 0;
1868     uint16_t bit;
1869     int n;
1870
1871     if (ovs_scan(s, "%"SCNi16"/%"SCNi16"%n", &flags, &mask, &n) && !s[n]) {
1872         *flagsp = htons(flags);
1873         *maskp = htons(mask);
1874         return NULL;
1875     }
1876     if (ovs_scan(s, "%"SCNi16"%n", &flags, &n) && !s[n]) {
1877         *flagsp = htons(flags);
1878         *maskp = OVS_BE16_MAX;
1879         return NULL;
1880     }
1881
1882     while (*s != '\0') {
1883         bool set;
1884         int name_len;
1885
1886         switch (*s) {
1887         case '+':
1888             set = true;
1889             break;
1890         case '-':
1891             set = false;
1892             break;
1893         default:
1894             return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
1895                              "or '-' (NOT SET)", s);
1896         }
1897         s++;
1898
1899         name_len = strcspn(s,"+-");
1900
1901         for (bit = 1; bit; bit <<= 1) {
1902             const char *fname = packet_tcp_flag_to_string(bit);
1903             size_t len;
1904
1905             if (!fname) {
1906                 continue;
1907             }
1908
1909             len = strlen(fname);
1910             if (len != name_len) {
1911                 continue;
1912             }
1913             if (!strncmp(s, fname, len)) {
1914                 if (mask & bit) {
1915                     return xasprintf("%s: Each TCP flag can be specified only "
1916                                      "once", s);
1917                 }
1918                 if (set) {
1919                     flags |= bit;
1920                 }
1921                 mask |= bit;
1922                 break;
1923             }
1924         }
1925
1926         if (!bit) {
1927             return xasprintf("%s: unknown TCP flag(s)", s);
1928         }
1929         s += name_len;
1930     }
1931
1932     *flagsp = htons(flags);
1933     *maskp = htons(mask);
1934     return NULL;
1935 }
1936
1937
1938 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'.  Returns
1939  * NULL if successful, otherwise a malloc()'d string describing the error. */
1940 char *
1941 mf_parse(const struct mf_field *mf, const char *s,
1942          union mf_value *value, union mf_value *mask)
1943 {
1944     char *error;
1945
1946     if (!strcmp(s, "*")) {
1947         memset(value, 0, mf->n_bytes);
1948         memset(mask, 0, mf->n_bytes);
1949         return NULL;
1950     }
1951
1952     switch (mf->string) {
1953     case MFS_DECIMAL:
1954     case MFS_HEXADECIMAL:
1955         error = mf_from_integer_string(mf, s,
1956                                        (uint8_t *) value, (uint8_t *) mask);
1957         break;
1958
1959     case MFS_ETHERNET:
1960         error = mf_from_ethernet_string(mf, s, value->mac, mask->mac);
1961         break;
1962
1963     case MFS_IPV4:
1964         error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
1965         break;
1966
1967     case MFS_IPV6:
1968         error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
1969         break;
1970
1971     case MFS_OFP_PORT:
1972         error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
1973         break;
1974
1975     case MFS_OFP_PORT_OXM:
1976         error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
1977         break;
1978
1979     case MFS_FRAG:
1980         error = mf_from_frag_string(s, &value->u8, &mask->u8);
1981         break;
1982
1983     case MFS_TNL_FLAGS:
1984         ovs_assert(mf->n_bytes == sizeof(ovs_be16));
1985         error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
1986         break;
1987
1988     case MFS_TCP_FLAGS:
1989         ovs_assert(mf->n_bytes == sizeof(ovs_be16));
1990         error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
1991         break;
1992
1993     default:
1994         OVS_NOT_REACHED();
1995     }
1996
1997     if (!error && !mf_is_mask_valid(mf, mask)) {
1998         error = xasprintf("%s: invalid mask for field %s", s, mf->name);
1999     }
2000     return error;
2001 }
2002
2003 /* Parses 's', a string value for field 'mf', into 'value'.  Returns NULL if
2004  * successful, otherwise a malloc()'d string describing the error. */
2005 char *
2006 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2007 {
2008     union mf_value mask;
2009     char *error;
2010
2011     error = mf_parse(mf, s, value, &mask);
2012     if (error) {
2013         return error;
2014     }
2015
2016     if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2017         return xasprintf("%s: wildcards not allowed here", s);
2018     }
2019     return NULL;
2020 }
2021
2022 static void
2023 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2024                          const uint8_t *maskp, struct ds *s)
2025 {
2026     unsigned long long int integer;
2027     int i;
2028
2029     ovs_assert(mf->n_bytes <= 8);
2030
2031     integer = 0;
2032     for (i = 0; i < mf->n_bytes; i++) {
2033         integer = (integer << 8) | valuep[i];
2034     }
2035     if (mf->string == MFS_HEXADECIMAL) {
2036         ds_put_format(s, "%#llx", integer);
2037     } else {
2038         ds_put_format(s, "%lld", integer);
2039     }
2040
2041     if (maskp) {
2042         unsigned long long int mask;
2043
2044         mask = 0;
2045         for (i = 0; i < mf->n_bytes; i++) {
2046             mask = (mask << 8) | maskp[i];
2047         }
2048
2049         /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2050          * not sure that that a bit-mask written in decimal is ever easier to
2051          * understand than the same bit-mask written in hexadecimal. */
2052         ds_put_format(s, "/%#llx", mask);
2053     }
2054 }
2055
2056 static void
2057 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2058 {
2059     const struct frag_handling *h;
2060
2061     mask &= FLOW_NW_FRAG_MASK;
2062     value &= mask;
2063
2064     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2065         if (value == h->value && mask == h->mask) {
2066             ds_put_cstr(s, h->name);
2067             return;
2068         }
2069     }
2070     ds_put_cstr(s, "<error>");
2071 }
2072
2073 static void
2074 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2075 {
2076     format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2077 }
2078
2079 static void
2080 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2081 {
2082     format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2083                         TCP_FLAGS(mask));
2084 }
2085
2086 /* Appends to 's' a string representation of field 'mf' whose value is in
2087  * 'value' and 'mask'.  'mask' may be NULL to indicate an exact match. */
2088 void
2089 mf_format(const struct mf_field *mf,
2090           const union mf_value *value, const union mf_value *mask,
2091           struct ds *s)
2092 {
2093     if (mask) {
2094         if (is_all_zeros(mask, mf->n_bytes)) {
2095             ds_put_cstr(s, "ANY");
2096             return;
2097         } else if (is_all_ones(mask, mf->n_bytes)) {
2098             mask = NULL;
2099         }
2100     }
2101
2102     switch (mf->string) {
2103     case MFS_OFP_PORT_OXM:
2104         if (!mask) {
2105             ofp_port_t port;
2106             ofputil_port_from_ofp11(value->be32, &port);
2107             ofputil_format_port(port, s);
2108             break;
2109         }
2110         /* fall through */
2111     case MFS_OFP_PORT:
2112         if (!mask) {
2113             ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2114             break;
2115         }
2116         /* fall through */
2117     case MFS_DECIMAL:
2118     case MFS_HEXADECIMAL:
2119         mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2120         break;
2121
2122     case MFS_ETHERNET:
2123         eth_format_masked(value->mac, mask->mac, s);
2124         break;
2125
2126     case MFS_IPV4:
2127         ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2128         break;
2129
2130     case MFS_IPV6:
2131         print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2132         break;
2133
2134     case MFS_FRAG:
2135         mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2136         break;
2137
2138     case MFS_TNL_FLAGS:
2139         mf_format_tnl_flags_string(&value->be16, s);
2140         break;
2141
2142     case MFS_TCP_FLAGS:
2143         mf_format_tcp_flags_string(value->be16,
2144                                    mask ? mask->be16 : OVS_BE16_MAX, s);
2145         break;
2146
2147     default:
2148         OVS_NOT_REACHED();
2149     }
2150 }
2151 \f
2152 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2153  * least-significant bits in 'x'.
2154  */
2155 void
2156 mf_write_subfield_flow(const struct mf_subfield *sf,
2157                        const union mf_subvalue *x, struct flow *flow)
2158 {
2159     const struct mf_field *field = sf->field;
2160     union mf_value value;
2161
2162     mf_get_value(field, flow, &value);
2163     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2164                  sf->ofs, sf->n_bits);
2165     mf_set_flow_value(field, &value, flow);
2166 }
2167
2168 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2169  * least-significant bits in 'x'.
2170  */
2171 void
2172 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2173                   struct match *match)
2174 {
2175     const struct mf_field *field = sf->field;
2176     union mf_value value, mask;
2177
2178     mf_get(field, match, &value, &mask);
2179     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2180     bitwise_one (                 &mask,  field->n_bytes, sf->ofs, sf->n_bits);
2181     mf_set(field, &value, &mask, match);
2182 }
2183
2184 /* Initializes 'x' to the value of 'sf' within 'flow'.  'sf' must be valid for
2185  * reading 'flow', e.g. as checked by mf_check_src(). */
2186 void
2187 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2188                  union mf_subvalue *x)
2189 {
2190     union mf_value value;
2191
2192     mf_get_value(sf->field, flow, &value);
2193
2194     memset(x, 0, sizeof *x);
2195     bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2196                  x, sizeof *x, 0,
2197                  sf->n_bits);
2198 }
2199
2200 /* Returns the value of 'sf' within 'flow'.  'sf' must be valid for reading
2201  * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2202  * less. */
2203 uint64_t
2204 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2205 {
2206     union mf_value value;
2207
2208     mf_get_value(sf->field, flow, &value);
2209     return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2210 }
2211
2212 void
2213 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2214 {
2215     int i;
2216
2217     for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2218         if (subvalue->u8[i]) {
2219             ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2220             for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2221                 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2222             }
2223             return;
2224         }
2225     }
2226     ds_put_char(s, '0');
2227 }