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