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