lib/meta-flow.c

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