lib/meta-flow.c

   1 /*
   2  * Copyright (c) 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "meta-flow.h"
  20
  21 #include <errno.h>
  22 #include <limits.h>
  23 #include <netinet/icmp6.h>
  24 #include <netinet/ip6.h>
  25
  26 #include "classifier.h"
  27 #include "dynamic-string.h"
  28 #include "ofp-errors.h"
  29 #include "ofp-util.h"
  30 #include "ovs-thread.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 FLOW_U32OFS(FIELD)                                              \
  41     offsetof(struct flow, FIELD) % 4 ? -1 : offsetof(struct flow, FIELD) / 4
  42
  43 #define MF_FIELD_SIZES(MEMBER)                  \
  44     sizeof ((union mf_value *)0)->MEMBER,       \
  45     8 * sizeof ((union mf_value *)0)->MEMBER
  46
  47 extern const struct mf_field mf_fields[MFF_N_IDS]; /* Silence a warning. */
  48
  49 const struct mf_field mf_fields[MFF_N_IDS] = {
  50     /* ## -------- ## */
  51     /* ## metadata ## */
  52     /* ## -------- ## */
  53
  54     {
  55         MFF_TUN_ID, "tun_id", "tunnel_id",
  56         MF_FIELD_SIZES(be64),
  57         MFM_FULLY,
  58         MFS_HEXADECIMAL,
  59         MFP_NONE,
  60         true,
  61         NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
  62         OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
  63         OFPUTIL_P_NXM_OXM_ANY,
  64         OFPUTIL_P_NXM_OXM_ANY,
  65         FLOW_U32OFS(tunnel.tun_id),
  66     }, {
  67         MFF_TUN_SRC, "tun_src", NULL,
  68         MF_FIELD_SIZES(be32),
  69         MFM_FULLY,
  70         MFS_IPV4,
  71         MFP_NONE,
  72         true,
  73         NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
  74         NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
  75         OFPUTIL_P_NXM_OXM_ANY,
  76         OFPUTIL_P_NXM_OXM_ANY,
  77         FLOW_U32OFS(tunnel.ip_src),
  78     }, {
  79         MFF_TUN_DST, "tun_dst", NULL,
  80         MF_FIELD_SIZES(be32),
  81         MFM_FULLY,
  82         MFS_IPV4,
  83         MFP_NONE,
  84         true,
  85         NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
  86         NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
  87         OFPUTIL_P_NXM_OXM_ANY,
  88         OFPUTIL_P_NXM_OXM_ANY,
  89         FLOW_U32OFS(tunnel.ip_dst),
  90     }, {
  91         MFF_TUN_FLAGS, "tun_flags", NULL,
  92         MF_FIELD_SIZES(be16),
  93         MFM_NONE,
  94         MFS_TNL_FLAGS,
  95         MFP_NONE,
  96         false,
  97         0, NULL,
  98         0, NULL,
  99         OFPUTIL_P_NONE,
 100         OFPUTIL_P_NONE,
 101         -1,
 102     }, {
 103         MFF_TUN_TTL, "tun_ttl", NULL,
 104         MF_FIELD_SIZES(u8),
 105         MFM_NONE,
 106         MFS_DECIMAL,
 107         MFP_NONE,
 108         false,
 109         0, NULL,
 110         0, NULL,
 111         OFPUTIL_P_NONE,
 112         OFPUTIL_P_NONE,
 113         -1,
 114     }, {
 115         MFF_TUN_TOS, "tun_tos", NULL,
 116         MF_FIELD_SIZES(u8),
 117         MFM_NONE,
 118         MFS_DECIMAL,
 119         MFP_NONE,
 120         false,
 121         0, NULL,
 122         0, NULL,
 123         OFPUTIL_P_NONE,
 124         OFPUTIL_P_NONE,
 125         -1,
 126     }, {
 127         MFF_METADATA, "metadata", NULL,
 128         MF_FIELD_SIZES(be64),
 129         MFM_FULLY,
 130         MFS_HEXADECIMAL,
 131         MFP_NONE,
 132         true,
 133         OXM_OF_METADATA, "OXM_OF_METADATA",
 134         OXM_OF_METADATA, "OXM_OF_METADATA",
 135         OFPUTIL_P_NXM_OF11_UP,
 136         OFPUTIL_P_NXM_OF11_UP,
 137         -1,
 138     }, {
 139         MFF_IN_PORT, "in_port", NULL,
 140         MF_FIELD_SIZES(be16),
 141         MFM_NONE,
 142         MFS_OFP_PORT,
 143         MFP_NONE,
 144         true,
 145         NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
 146         NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
 147         OFPUTIL_P_ANY,   /* OF11+ via mapping to 32 bits. */
 148         OFPUTIL_P_NONE,
 149         -1,
 150     }, {
 151         MFF_IN_PORT_OXM, "in_port_oxm", NULL,
 152         MF_FIELD_SIZES(be32),
 153         MFM_NONE,
 154         MFS_OFP_PORT_OXM,
 155         MFP_NONE,
 156         true,
 157         OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
 158         OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
 159         OFPUTIL_P_OF11_UP,
 160         OFPUTIL_P_NONE,
 161         -1,
 162     }, {
 163         MFF_SKB_PRIORITY, "skb_priority", NULL,
 164         MF_FIELD_SIZES(be32),
 165         MFM_NONE,
 166         MFS_HEXADECIMAL,
 167         MFP_NONE,
 168         false,
 169         0, NULL,
 170         0, NULL,
 171         OFPUTIL_P_NONE,
 172         OFPUTIL_P_NONE,
 173         -1,
 174     }, {
 175         MFF_PKT_MARK, "pkt_mark", NULL,
 176         MF_FIELD_SIZES(be32),
 177         MFM_FULLY,
 178         MFS_HEXADECIMAL,
 179         MFP_NONE,
 180         true,
 181         NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
 182         NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
 183         OFPUTIL_P_NXM_OXM_ANY,
 184         OFPUTIL_P_NXM_OXM_ANY,
 185         -1,
 186     },
 187
 188 #define REGISTER(IDX)                           \
 189     {                                           \
 190         MFF_REG##IDX, "reg" #IDX, NULL,         \
 191         MF_FIELD_SIZES(be32),                   \
 192         MFM_FULLY,                              \
 193         MFS_HEXADECIMAL,                        \
 194         MFP_NONE,                               \
 195         true,                                   \
 196         NXM_NX_REG(IDX), "NXM_NX_REG" #IDX,     \
 197         NXM_NX_REG(IDX), "NXM_NX_REG" #IDX,     \
 198         OFPUTIL_P_NXM_OXM_ANY,                  \
 199         OFPUTIL_P_NXM_OXM_ANY,                  \
 200         -1,                                     \
 201     }
 202 #if FLOW_N_REGS > 0
 203     REGISTER(0),
 204 #endif
 205 #if FLOW_N_REGS > 1
 206     REGISTER(1),
 207 #endif
 208 #if FLOW_N_REGS > 2
 209     REGISTER(2),
 210 #endif
 211 #if FLOW_N_REGS > 3
 212     REGISTER(3),
 213 #endif
 214 #if FLOW_N_REGS > 4
 215     REGISTER(4),
 216 #endif
 217 #if FLOW_N_REGS > 5
 218     REGISTER(5),
 219 #endif
 220 #if FLOW_N_REGS > 6
 221     REGISTER(6),
 222 #endif
 223 #if FLOW_N_REGS > 7
 224     REGISTER(7),
 225 #endif
 226 #if FLOW_N_REGS > 8
 227 #error
 228 #endif
 229
 230     /* ## -- ## */
 231     /* ## L2 ## */
 232     /* ## -- ## */
 233
 234     {
 235         MFF_ETH_SRC, "eth_src", "dl_src",
 236         MF_FIELD_SIZES(mac),
 237         MFM_FULLY,
 238         MFS_ETHERNET,
 239         MFP_NONE,
 240         true,
 241         NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
 242         OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
 243         OFPUTIL_P_ANY,
 244         OFPUTIL_P_NXM_OF11_UP,   /* Bitwise masking only with NXM and OF11+! */
 245         -1,
 246     }, {
 247         MFF_ETH_DST, "eth_dst", "dl_dst",
 248         MF_FIELD_SIZES(mac),
 249         MFM_FULLY,
 250         MFS_ETHERNET,
 251         MFP_NONE,
 252         true,
 253         NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
 254         OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
 255         OFPUTIL_P_ANY,
 256         OFPUTIL_P_NXM_OF11_UP,   /* Bitwise masking only with NXM and OF11+! */
 257         -1,
 258     }, {
 259         MFF_ETH_TYPE, "eth_type", "dl_type",
 260         MF_FIELD_SIZES(be16),
 261         MFM_NONE,
 262         MFS_HEXADECIMAL,
 263         MFP_NONE,
 264         false,
 265         NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
 266         OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
 267         OFPUTIL_P_ANY,
 268         OFPUTIL_P_NONE,
 269         -1,
 270     },
 271
 272     {
 273         MFF_VLAN_TCI, "vlan_tci", NULL,
 274         MF_FIELD_SIZES(be16),
 275         MFM_FULLY,
 276         MFS_HEXADECIMAL,
 277         MFP_NONE,
 278         true,
 279         NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
 280         NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
 281         OFPUTIL_P_ANY,
 282         OFPUTIL_P_NXM_OXM_ANY,
 283         -1,
 284     }, {
 285         MFF_DL_VLAN, "dl_vlan", NULL,
 286         sizeof(ovs_be16), 12,
 287         MFM_NONE,
 288         MFS_DECIMAL,
 289         MFP_NONE,
 290         true,
 291         0, NULL,
 292         0, NULL,
 293         OFPUTIL_P_ANY,
 294         OFPUTIL_P_NXM_OXM_ANY,
 295         -1,
 296     }, {
 297         MFF_VLAN_VID, "vlan_vid", NULL,
 298         sizeof(ovs_be16), 12,
 299         MFM_FULLY,
 300         MFS_DECIMAL,
 301         MFP_NONE,
 302         true,
 303         OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
 304         OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
 305         OFPUTIL_P_ANY,
 306         OFPUTIL_P_NXM_OXM_ANY,
 307         -1,
 308     }, {
 309         MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
 310         1, 3,
 311         MFM_NONE,
 312         MFS_DECIMAL,
 313         MFP_NONE,
 314         true,
 315         0, NULL,
 316         0, NULL,
 317         OFPUTIL_P_ANY,   /* Will be mapped to NXM and OXM. */
 318         OFPUTIL_P_NONE,
 319         -1,
 320     }, {
 321         MFF_VLAN_PCP, "vlan_pcp", NULL,
 322         1, 3,
 323         MFM_NONE,
 324         MFS_DECIMAL,
 325         MFP_VLAN_VID,
 326         true,
 327         OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
 328         OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
 329         OFPUTIL_P_ANY,   /* Will be mapped to OF10 and NXM. */
 330         OFPUTIL_P_NONE,
 331         -1,
 332     },
 333
 334     /* ## ---- ## */
 335     /* ## L2.5 ## */
 336     /* ## ---- ## */
 337     {
 338         MFF_MPLS_LABEL, "mpls_label", NULL,
 339         4, 20,
 340         MFM_NONE,
 341         MFS_DECIMAL,
 342         MFP_MPLS,
 343         true,
 344         OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
 345         OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
 346         OFPUTIL_P_NXM_OF11_UP,
 347         OFPUTIL_P_NONE,
 348         -1,
 349     }, {
 350         MFF_MPLS_TC, "mpls_tc", NULL,
 351         1, 3,
 352         MFM_NONE,
 353         MFS_DECIMAL,
 354         MFP_MPLS,
 355         true,
 356         OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
 357         OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
 358         OFPUTIL_P_NXM_OF11_UP,
 359         OFPUTIL_P_NONE,
 360         -1,
 361     }, {
 362         MFF_MPLS_BOS, "mpls_bos", NULL,
 363         1, 1,
 364         MFM_NONE,
 365         MFS_DECIMAL,
 366         MFP_MPLS,
 367         false,
 368         OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
 369         OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
 370         OFPUTIL_P_NXM_OXM_ANY,
 371         OFPUTIL_P_NONE,
 372         -1,
 373     },
 374
 375     /* ## -- ## */
 376     /* ## L3 ## */
 377     /* ## -- ## */
 378
 379     {
 380         MFF_IPV4_SRC, "ip_src", "nw_src",
 381         MF_FIELD_SIZES(be32),
 382         MFM_FULLY,
 383         MFS_IPV4,
 384         MFP_IPV4,
 385         true,
 386         NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
 387         OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
 388         OFPUTIL_P_ANY,
 389         OFPUTIL_P_NXM_OF11_UP,
 390         FLOW_U32OFS(nw_src),
 391     }, {
 392         MFF_IPV4_DST, "ip_dst", "nw_dst",
 393         MF_FIELD_SIZES(be32),
 394         MFM_FULLY,
 395         MFS_IPV4,
 396         MFP_IPV4,
 397         true,
 398         NXM_OF_IP_DST, "NXM_OF_IP_DST",
 399         OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
 400         OFPUTIL_P_ANY,
 401         OFPUTIL_P_NXM_OF11_UP,
 402         FLOW_U32OFS(nw_dst),
 403     },
 404
 405     {
 406         MFF_IPV6_SRC, "ipv6_src", NULL,
 407         MF_FIELD_SIZES(ipv6),
 408         MFM_FULLY,
 409         MFS_IPV6,
 410         MFP_IPV6,
 411         true,
 412         NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
 413         OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
 414         OFPUTIL_P_NXM_OXM_ANY,
 415         OFPUTIL_P_NXM_OXM_ANY,
 416         FLOW_U32OFS(ipv6_src),
 417     }, {
 418         MFF_IPV6_DST, "ipv6_dst", NULL,
 419         MF_FIELD_SIZES(ipv6),
 420         MFM_FULLY,
 421         MFS_IPV6,
 422         MFP_IPV6,
 423         true,
 424         NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
 425         OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
 426         OFPUTIL_P_NXM_OXM_ANY,
 427         OFPUTIL_P_NXM_OXM_ANY,
 428         FLOW_U32OFS(ipv6_dst),
 429     },
 430     {
 431         MFF_IPV6_LABEL, "ipv6_label", NULL,
 432         4, 20,
 433         MFM_FULLY,
 434         MFS_HEXADECIMAL,
 435         MFP_IPV6,
 436         false,
 437         NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
 438         OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
 439         OFPUTIL_P_NXM_OXM_ANY,
 440         OFPUTIL_P_NXM_OXM_ANY,
 441         -1,
 442     },
 443
 444     {
 445         MFF_IP_PROTO, "nw_proto", "ip_proto",
 446         MF_FIELD_SIZES(u8),
 447         MFM_NONE,
 448         MFS_DECIMAL,
 449         MFP_IP_ANY,
 450         false,
 451         NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
 452         OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
 453         OFPUTIL_P_ANY,
 454         OFPUTIL_P_NONE,
 455         -1,
 456     }, {
 457         MFF_IP_DSCP, "nw_tos", NULL,
 458         MF_FIELD_SIZES(u8),
 459         MFM_NONE,
 460         MFS_DECIMAL,
 461         MFP_IP_ANY,
 462         true,
 463         NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
 464         NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
 465         OFPUTIL_P_ANY,   /* Will be shifted for OXM. */
 466         OFPUTIL_P_NONE,
 467         -1,
 468     }, {
 469         MFF_IP_DSCP_SHIFTED, "ip_dscp", NULL,
 470         1, 6,
 471         MFM_NONE,
 472         MFS_DECIMAL,
 473         MFP_IP_ANY,
 474         true,
 475         OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
 476         OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
 477         OFPUTIL_P_ANY,   /* Will be shifted for non-OXM. */
 478         OFPUTIL_P_NONE,
 479         -1,
 480     }, {
 481         MFF_IP_ECN, "nw_ecn", "ip_ecn",
 482         1, 2,
 483         MFM_NONE,
 484         MFS_DECIMAL,
 485         MFP_IP_ANY,
 486         true,
 487         NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
 488         OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
 489         OFPUTIL_P_NXM_OXM_ANY,
 490         OFPUTIL_P_NONE,
 491         -1,
 492     }, {
 493         MFF_IP_TTL, "nw_ttl", NULL,
 494         MF_FIELD_SIZES(u8),
 495         MFM_NONE,
 496         MFS_DECIMAL,
 497         MFP_IP_ANY,
 498         true,
 499         NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
 500         NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
 501         OFPUTIL_P_NXM_OXM_ANY,
 502         OFPUTIL_P_NONE,
 503         -1,
 504     }, {
 505         MFF_IP_FRAG, "ip_frag", NULL,
 506         1, 2,
 507         MFM_FULLY,
 508         MFS_FRAG,
 509         MFP_IP_ANY,
 510         false,
 511         NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
 512         NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
 513         OFPUTIL_P_NXM_OXM_ANY,
 514         OFPUTIL_P_NXM_OXM_ANY,
 515         -1,
 516     },
 517
 518     {
 519         MFF_ARP_OP, "arp_op", NULL,
 520         MF_FIELD_SIZES(be16),
 521         MFM_NONE,
 522         MFS_DECIMAL,
 523         MFP_ARP,
 524         true,
 525         NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
 526         OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
 527         OFPUTIL_P_ANY,
 528         OFPUTIL_P_NONE,
 529         -1,
 530     }, {
 531         MFF_ARP_SPA, "arp_spa", NULL,
 532         MF_FIELD_SIZES(be32),
 533         MFM_FULLY,
 534         MFS_IPV4,
 535         MFP_ARP,
 536         true,
 537         NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
 538         OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
 539         OFPUTIL_P_ANY,
 540         OFPUTIL_P_NXM_OF11_UP,
 541         -1,
 542     }, {
 543         MFF_ARP_TPA, "arp_tpa", NULL,
 544         MF_FIELD_SIZES(be32),
 545         MFM_FULLY,
 546         MFS_IPV4,
 547         MFP_ARP,
 548         true,
 549         NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
 550         OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
 551         OFPUTIL_P_ANY,
 552         OFPUTIL_P_NXM_OF11_UP,
 553         -1,
 554     }, {
 555         MFF_ARP_SHA, "arp_sha", NULL,
 556         MF_FIELD_SIZES(mac),
 557         MFM_FULLY,
 558         MFS_ETHERNET,
 559         MFP_ARP,
 560         true,
 561         NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
 562         OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
 563         OFPUTIL_P_NXM_OXM_ANY,
 564         OFPUTIL_P_NXM_OXM_ANY,
 565         -1,
 566     }, {
 567         MFF_ARP_THA, "arp_tha", NULL,
 568         MF_FIELD_SIZES(mac),
 569         MFM_FULLY,
 570         MFS_ETHERNET,
 571         MFP_ARP,
 572         true,
 573         NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
 574         OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
 575         OFPUTIL_P_NXM_OXM_ANY,
 576         OFPUTIL_P_NXM_OXM_ANY,
 577         -1,
 578     },
 579
 580     /* ## -- ## */
 581     /* ## L4 ## */
 582     /* ## -- ## */
 583
 584     {
 585         MFF_TCP_SRC, "tcp_src", "tp_src",
 586         MF_FIELD_SIZES(be16),
 587         MFM_FULLY,
 588         MFS_DECIMAL,
 589         MFP_TCP,
 590         true,
 591         NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
 592         OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
 593         OFPUTIL_P_ANY,
 594         OFPUTIL_P_NXM_OXM_ANY,
 595         -1,
 596     }, {
 597         MFF_TCP_DST, "tcp_dst", "tp_dst",
 598         MF_FIELD_SIZES(be16),
 599         MFM_FULLY,
 600         MFS_DECIMAL,
 601         MFP_TCP,
 602         true,
 603         NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
 604         OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
 605         OFPUTIL_P_ANY,
 606         OFPUTIL_P_NXM_OXM_ANY,
 607         -1,
 608     }, {
 609         MFF_TCP_FLAGS, "tcp_flags", NULL,
 610         2, 12,
 611         MFM_FULLY,
 612         MFS_TCP_FLAGS,
 613         MFP_TCP,
 614         false,
 615         NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
 616         NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
 617         OFPUTIL_P_NXM_OXM_ANY,
 618         OFPUTIL_P_NXM_OXM_ANY,
 619         -1,
 620     },
 621
 622     {
 623         MFF_UDP_SRC, "udp_src", NULL,
 624         MF_FIELD_SIZES(be16),
 625         MFM_FULLY,
 626         MFS_DECIMAL,
 627         MFP_UDP,
 628         true,
 629         NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
 630         OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
 631         OFPUTIL_P_ANY,
 632         OFPUTIL_P_NXM_OXM_ANY,
 633         -1,
 634     }, {
 635         MFF_UDP_DST, "udp_dst", NULL,
 636         MF_FIELD_SIZES(be16),
 637         MFM_FULLY,
 638         MFS_DECIMAL,
 639         MFP_UDP,
 640         true,
 641         NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
 642         OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
 643         OFPUTIL_P_ANY,
 644         OFPUTIL_P_NXM_OXM_ANY,
 645         -1,
 646     },
 647
 648     {
 649         MFF_SCTP_SRC, "sctp_src", NULL,
 650         MF_FIELD_SIZES(be16),
 651         MFM_FULLY,
 652         MFS_DECIMAL,
 653         MFP_SCTP,
 654         true,
 655         OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
 656         OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
 657         OFPUTIL_P_NXM_OF11_UP,
 658         OFPUTIL_P_NXM_OXM_ANY,
 659         -1,
 660     }, {
 661         MFF_SCTP_DST, "sctp_dst", NULL,
 662         MF_FIELD_SIZES(be16),
 663         MFM_FULLY,
 664         MFS_DECIMAL,
 665         MFP_SCTP,
 666         true,
 667         OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
 668         OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
 669         OFPUTIL_P_NXM_OF11_UP,
 670         OFPUTIL_P_NXM_OXM_ANY,
 671         -1,
 672     },
 673
 674     {
 675         MFF_ICMPV4_TYPE, "icmp_type", NULL,
 676         MF_FIELD_SIZES(u8),
 677         MFM_NONE,
 678         MFS_DECIMAL,
 679         MFP_ICMPV4,
 680         false,
 681         NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
 682         OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
 683         OFPUTIL_P_ANY,
 684         OFPUTIL_P_NONE,
 685         -1,
 686     }, {
 687         MFF_ICMPV4_CODE, "icmp_code", NULL,
 688         MF_FIELD_SIZES(u8),
 689         MFM_NONE,
 690         MFS_DECIMAL,
 691         MFP_ICMPV4,
 692         false,
 693         NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
 694         OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
 695         OFPUTIL_P_ANY,
 696         OFPUTIL_P_NONE,
 697         -1,
 698     },
 699
 700     {
 701         MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
 702         MF_FIELD_SIZES(u8),
 703         MFM_NONE,
 704         MFS_DECIMAL,
 705         MFP_ICMPV6,
 706         false,
 707         NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
 708         OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
 709         OFPUTIL_P_NXM_OXM_ANY,
 710         OFPUTIL_P_NONE,
 711         -1,
 712     }, {
 713         MFF_ICMPV6_CODE, "icmpv6_code", NULL,
 714         MF_FIELD_SIZES(u8),
 715         MFM_NONE,
 716         MFS_DECIMAL,
 717         MFP_ICMPV6,
 718         false,
 719         NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
 720         OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
 721         OFPUTIL_P_NXM_OXM_ANY,
 722         OFPUTIL_P_NONE,
 723         -1,
 724     },
 725
 726     /* ## ---- ## */
 727     /* ## L"5" ## */
 728     /* ## ---- ## */
 729
 730     {
 731         MFF_ND_TARGET, "nd_target", NULL,
 732         MF_FIELD_SIZES(ipv6),
 733         MFM_FULLY,
 734         MFS_IPV6,
 735         MFP_ND,
 736         false,
 737         NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
 738         OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
 739         OFPUTIL_P_NXM_OXM_ANY,
 740         OFPUTIL_P_NXM_OXM_ANY,
 741         -1,
 742     }, {
 743         MFF_ND_SLL, "nd_sll", NULL,
 744         MF_FIELD_SIZES(mac),
 745         MFM_FULLY,
 746         MFS_ETHERNET,
 747         MFP_ND_SOLICIT,
 748         false,
 749         NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
 750         OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
 751         OFPUTIL_P_NXM_OXM_ANY,
 752         OFPUTIL_P_NXM_OXM_ANY,
 753         -1,
 754     }, {
 755         MFF_ND_TLL, "nd_tll", NULL,
 756         MF_FIELD_SIZES(mac),
 757         MFM_FULLY,
 758         MFS_ETHERNET,
 759         MFP_ND_ADVERT,
 760         false,
 761         NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
 762         OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
 763         OFPUTIL_P_NXM_OXM_ANY,
 764         OFPUTIL_P_NXM_OXM_ANY,
 765         -1,
 766     }
 767 };
 768
 769 /* Maps an NXM or OXM header value to an mf_field. */
 770 struct nxm_field {
 771     struct hmap_node hmap_node; /* In 'all_fields' hmap. */
 772     uint32_t header;            /* NXM or OXM header value. */
 773     const struct mf_field *mf;
 774 };
 775
 776 /* Contains 'struct nxm_field's. */
 777 static struct hmap all_fields;
 778
 779 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
 780 static struct shash mf_by_name;
 781
 782 /* Rate limit for parse errors.  These always indicate a bug in an OpenFlow
 783  * controller and so there's not much point in showing a lot of them. */
 784 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 785
 786 const struct mf_field *mf_from_nxm_header__(uint32_t header);
 787 static void nxm_init(void);
 788
 789 /* Returns the field with the given 'name', or a null pointer if no field has
 790  * that name. */
 791 const struct mf_field *
 792 mf_from_name(const char *name)
 793 {
 794     nxm_init();
 795     return shash_find_data(&mf_by_name, name);
 796 }
 797
 798 static void
 799 add_nxm_field(uint32_t header, const struct mf_field *mf)
 800 {
 801     struct nxm_field *f;
 802
 803     f = xmalloc(sizeof *f);
 804     hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
 805     f->header = header;
 806     f->mf = mf;
 807 }
 808
 809 static void
 810 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
 811 {
 812     if (header) {
 813         ovs_assert(!mf_from_nxm_header__(header));
 814         add_nxm_field(header, mf);
 815         if (mf->maskable != MFM_NONE) {
 816             add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
 817         }
 818     }
 819 }
 820
 821 static void
 822 nxm_do_init(void)
 823 {
 824     int i;
 825
 826     hmap_init(&all_fields);
 827     shash_init(&mf_by_name);
 828     for (i = 0; i < MFF_N_IDS; i++) {
 829         const struct mf_field *mf = &mf_fields[i];
 830
 831         ovs_assert(mf->id == i); /* Fields must be in the enum order. */
 832
 833         nxm_init_add_field(mf, mf->nxm_header);
 834         if (mf->oxm_header != mf->nxm_header) {
 835             nxm_init_add_field(mf, mf->oxm_header);
 836         }
 837
 838         shash_add_once(&mf_by_name, mf->name, mf);
 839         if (mf->extra_name) {
 840             shash_add_once(&mf_by_name, mf->extra_name, mf);
 841         }
 842     }
 843 }
 844
 845 static void
 846 nxm_init(void)
 847 {
 848     static pthread_once_t once = PTHREAD_ONCE_INIT;
 849     pthread_once(&once, nxm_do_init);
 850 }
 851
 852 const struct mf_field *
 853 mf_from_nxm_header(uint32_t header)
 854 {
 855     nxm_init();
 856     return mf_from_nxm_header__(header);
 857 }
 858
 859 const struct mf_field *
 860 mf_from_nxm_header__(uint32_t header)
 861 {
 862     const struct nxm_field *f;
 863
 864     HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
 865         if (f->header == header) {
 866             return f->mf;
 867         }
 868     }
 869
 870     return NULL;
 871 }
 872
 873 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
 874  * specifies at least one bit in the field.
 875  *
 876  * The caller is responsible for ensuring that 'wc' corresponds to a flow that
 877  * meets 'mf''s prerequisites. */
 878 bool
 879 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
 880 {
 881     switch (mf->id) {
 882     case MFF_TUN_SRC:
 883         return !wc->masks.tunnel.ip_src;
 884     case MFF_TUN_DST:
 885         return !wc->masks.tunnel.ip_dst;
 886     case MFF_TUN_ID:
 887     case MFF_TUN_TOS:
 888     case MFF_TUN_TTL:
 889     case MFF_TUN_FLAGS:
 890         return !wc->masks.tunnel.tun_id;
 891     case MFF_METADATA:
 892         return !wc->masks.metadata;
 893     case MFF_IN_PORT:
 894     case MFF_IN_PORT_OXM:
 895         return !wc->masks.in_port.ofp_port;
 896     case MFF_SKB_PRIORITY:
 897         return !wc->masks.skb_priority;
 898     case MFF_PKT_MARK:
 899         return !wc->masks.pkt_mark;
 900     CASE_MFF_REGS:
 901         return !wc->masks.regs[mf->id - MFF_REG0];
 902
 903     case MFF_ETH_SRC:
 904         return eth_addr_is_zero(wc->masks.dl_src);
 905     case MFF_ETH_DST:
 906         return eth_addr_is_zero(wc->masks.dl_dst);
 907     case MFF_ETH_TYPE:
 908         return !wc->masks.dl_type;
 909
 910     case MFF_ARP_SHA:
 911     case MFF_ND_SLL:
 912         return eth_addr_is_zero(wc->masks.arp_sha);
 913
 914     case MFF_ARP_THA:
 915     case MFF_ND_TLL:
 916         return eth_addr_is_zero(wc->masks.arp_tha);
 917
 918     case MFF_VLAN_TCI:
 919         return !wc->masks.vlan_tci;
 920     case MFF_DL_VLAN:
 921         return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
 922     case MFF_VLAN_VID:
 923         return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
 924     case MFF_DL_VLAN_PCP:
 925     case MFF_VLAN_PCP:
 926         return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
 927
 928     case MFF_MPLS_LABEL:
 929         return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
 930     case MFF_MPLS_TC:
 931         return !(wc->masks.mpls_lse[1] & htonl(MPLS_TC_MASK));
 932     case MFF_MPLS_BOS:
 933         return !(wc->masks.mpls_lse[2] & htonl(MPLS_BOS_MASK));
 934
 935     case MFF_IPV4_SRC:
 936         return !wc->masks.nw_src;
 937     case MFF_IPV4_DST:
 938         return !wc->masks.nw_dst;
 939
 940     case MFF_IPV6_SRC:
 941         return ipv6_mask_is_any(&wc->masks.ipv6_src);
 942     case MFF_IPV6_DST:
 943         return ipv6_mask_is_any(&wc->masks.ipv6_dst);
 944
 945     case MFF_IPV6_LABEL:
 946         return !wc->masks.ipv6_label;
 947
 948     case MFF_IP_PROTO:
 949         return !wc->masks.nw_proto;
 950     case MFF_IP_DSCP:
 951     case MFF_IP_DSCP_SHIFTED:
 952         return !(wc->masks.nw_tos & IP_DSCP_MASK);
 953     case MFF_IP_ECN:
 954         return !(wc->masks.nw_tos & IP_ECN_MASK);
 955     case MFF_IP_TTL:
 956         return !wc->masks.nw_ttl;
 957
 958     case MFF_ND_TARGET:
 959         return ipv6_mask_is_any(&wc->masks.nd_target);
 960
 961     case MFF_IP_FRAG:
 962         return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
 963
 964     case MFF_ARP_OP:
 965         return !wc->masks.nw_proto;
 966     case MFF_ARP_SPA:
 967         return !wc->masks.nw_src;
 968     case MFF_ARP_TPA:
 969         return !wc->masks.nw_dst;
 970
 971     case MFF_TCP_SRC:
 972     case MFF_UDP_SRC:
 973     case MFF_SCTP_SRC:
 974     case MFF_ICMPV4_TYPE:
 975     case MFF_ICMPV6_TYPE:
 976         return !wc->masks.tp_src;
 977     case MFF_TCP_DST:
 978     case MFF_UDP_DST:
 979     case MFF_SCTP_DST:
 980     case MFF_ICMPV4_CODE:
 981     case MFF_ICMPV6_CODE:
 982         return !wc->masks.tp_dst;
 983     case MFF_TCP_FLAGS:
 984         return !wc->masks.tcp_flags;
 985
 986     case MFF_N_IDS:
 987     default:
 988         OVS_NOT_REACHED();
 989     }
 990 }
 991
 992 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
 993  * Each bit in 'mask' will be set to 1 if the bit is significant for matching
 994  * purposes, or to 0 if it is wildcarded.
 995  *
 996  * The caller is responsible for ensuring that 'wc' corresponds to a flow that
 997  * meets 'mf''s prerequisites. */
 998 void
 999 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
1000             union mf_value *mask)
1001 {
1002     mf_get_value(mf, &wc->masks, mask);
1003 }
1004
1005 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'.  Returns true
1006  * if the mask is valid, false otherwise. */
1007 bool
1008 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
1009 {
1010     switch (mf->maskable) {
1011     case MFM_NONE:
1012         return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
1013                 is_all_ones((const uint8_t *) mask, mf->n_bytes));
1014
1015     case MFM_FULLY:
1016         return true;
1017     }
1018
1019     OVS_NOT_REACHED();
1020 }
1021
1022 static bool
1023 is_icmpv4(const struct flow *flow)
1024 {
1025     return (flow->dl_type == htons(ETH_TYPE_IP)
1026             && flow->nw_proto == IPPROTO_ICMP);
1027 }
1028
1029 static bool
1030 is_icmpv6(const struct flow *flow)
1031 {
1032     return (flow->dl_type == htons(ETH_TYPE_IPV6)
1033             && flow->nw_proto == IPPROTO_ICMPV6);
1034 }
1035
1036 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1037 bool
1038 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
1039 {
1040     switch (mf->prereqs) {
1041     case MFP_NONE:
1042         return true;
1043
1044     case MFP_ARP:
1045       return (flow->dl_type == htons(ETH_TYPE_ARP) ||
1046               flow->dl_type == htons(ETH_TYPE_RARP));
1047     case MFP_IPV4:
1048         return flow->dl_type == htons(ETH_TYPE_IP);
1049     case MFP_IPV6:
1050         return flow->dl_type == htons(ETH_TYPE_IPV6);
1051     case MFP_VLAN_VID:
1052         return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
1053     case MFP_MPLS:
1054         return eth_type_mpls(flow->dl_type);
1055     case MFP_IP_ANY:
1056         return is_ip_any(flow);
1057
1058     case MFP_TCP:
1059         return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
1060     case MFP_UDP:
1061         return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1062     case MFP_SCTP:
1063         return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1064     case MFP_ICMPV4:
1065         return is_icmpv4(flow);
1066     case MFP_ICMPV6:
1067         return is_icmpv6(flow);
1068
1069     case MFP_ND:
1070         return (is_icmpv6(flow)
1071                 && flow->tp_dst == htons(0)
1072                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1073                     flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1074     case MFP_ND_SOLICIT:
1075         return (is_icmpv6(flow)
1076                 && flow->tp_dst == htons(0)
1077                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1078     case MFP_ND_ADVERT:
1079         return (is_icmpv6(flow)
1080                 && flow->tp_dst == htons(0)
1081                 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1082     }
1083
1084     OVS_NOT_REACHED();
1085 }
1086
1087 /* Set field and it's prerequisities in the mask.
1088  * This is only ever called for writeable 'mf's, but we do not make the
1089  * distinction here. */
1090 void
1091 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1092 {
1093     static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1094
1095     mf_set_flow_value(mf, &exact_match_mask, mask);
1096
1097     switch (mf->prereqs) {
1098     case MFP_ND:
1099     case MFP_ND_SOLICIT:
1100     case MFP_ND_ADVERT:
1101         mask->tp_src = OVS_BE16_MAX;
1102         mask->tp_dst = OVS_BE16_MAX;
1103         /* Fall through. */
1104     case MFP_TCP:
1105     case MFP_UDP:
1106     case MFP_SCTP:
1107     case MFP_ICMPV4:
1108     case MFP_ICMPV6:
1109         mask->nw_proto = 0xff;
1110         /* Fall through. */
1111     case MFP_ARP:
1112     case MFP_IPV4:
1113     case MFP_IPV6:
1114     case MFP_MPLS:
1115     case MFP_IP_ANY:
1116         mask->dl_type = OVS_BE16_MAX;
1117         break;
1118     case MFP_VLAN_VID:
1119         mask->vlan_tci |= htons(VLAN_CFI);
1120         break;
1121     case MFP_NONE:
1122         break;
1123     }
1124 }
1125
1126
1127 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1128  * false otherwise.
1129  *
1130  * A value is not rejected just because it is not valid for the field in
1131  * question, but only if it doesn't make sense to test the bits in question at
1132  * all.  For example, the MFF_VLAN_TCI field will never have a nonzero value
1133  * without the VLAN_CFI bit being set, but we can't reject those values because
1134  * it is still legitimate to test just for those bits (see the documentation
1135  * for NXM_OF_VLAN_TCI in nicira-ext.h).  On the other hand, there is never a
1136  * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1137 bool
1138 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1139 {
1140     switch (mf->id) {
1141     case MFF_TUN_ID:
1142     case MFF_TUN_SRC:
1143     case MFF_TUN_DST:
1144     case MFF_TUN_TOS:
1145     case MFF_TUN_TTL:
1146     case MFF_TUN_FLAGS:
1147     case MFF_METADATA:
1148     case MFF_IN_PORT:
1149     case MFF_SKB_PRIORITY:
1150     case MFF_PKT_MARK:
1151     CASE_MFF_REGS:
1152     case MFF_ETH_SRC:
1153     case MFF_ETH_DST:
1154     case MFF_ETH_TYPE:
1155     case MFF_VLAN_TCI:
1156     case MFF_IPV4_SRC:
1157     case MFF_IPV4_DST:
1158     case MFF_IPV6_SRC:
1159     case MFF_IPV6_DST:
1160     case MFF_IP_PROTO:
1161     case MFF_IP_TTL:
1162     case MFF_ARP_SPA:
1163     case MFF_ARP_TPA:
1164     case MFF_ARP_SHA:
1165     case MFF_ARP_THA:
1166     case MFF_TCP_SRC:
1167     case MFF_TCP_DST:
1168     case MFF_UDP_SRC:
1169     case MFF_UDP_DST:
1170     case MFF_SCTP_SRC:
1171     case MFF_SCTP_DST:
1172     case MFF_ICMPV4_TYPE:
1173     case MFF_ICMPV4_CODE:
1174     case MFF_ICMPV6_TYPE:
1175     case MFF_ICMPV6_CODE:
1176     case MFF_ND_TARGET:
1177     case MFF_ND_SLL:
1178     case MFF_ND_TLL:
1179         return true;
1180
1181     case MFF_IN_PORT_OXM: {
1182         ofp_port_t port;
1183         return !ofputil_port_from_ofp11(value->be32, &port);
1184     }
1185
1186     case MFF_IP_DSCP:
1187         return !(value->u8 & ~IP_DSCP_MASK);
1188     case MFF_IP_DSCP_SHIFTED:
1189         return !(value->u8 & (~IP_DSCP_MASK >> 2));
1190     case MFF_IP_ECN:
1191         return !(value->u8 & ~IP_ECN_MASK);
1192     case MFF_IP_FRAG:
1193         return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1194     case MFF_TCP_FLAGS:
1195         return !(value->be16 & ~htons(0x0fff));
1196
1197     case MFF_ARP_OP:
1198         return !(value->be16 & htons(0xff00));
1199
1200     case MFF_DL_VLAN:
1201         return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1202     case MFF_VLAN_VID:
1203         return !(value->be16 & htons(VLAN_PCP_MASK));
1204
1205     case MFF_DL_VLAN_PCP:
1206     case MFF_VLAN_PCP:
1207         return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1208
1209     case MFF_IPV6_LABEL:
1210         return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1211
1212     case MFF_MPLS_LABEL:
1213         return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1214
1215     case MFF_MPLS_TC:
1216         return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1217
1218     case MFF_MPLS_BOS:
1219         return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1220
1221     case MFF_N_IDS:
1222     default:
1223         OVS_NOT_REACHED();
1224     }
1225 }
1226
1227 /* Copies the value of field 'mf' from 'flow' into 'value'.  The caller is
1228  * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1229 void
1230 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1231              union mf_value *value)
1232 {
1233     switch (mf->id) {
1234     case MFF_TUN_ID:
1235         value->be64 = flow->tunnel.tun_id;
1236         break;
1237     case MFF_TUN_SRC:
1238         value->be32 = flow->tunnel.ip_src;
1239         break;
1240     case MFF_TUN_DST:
1241         value->be32 = flow->tunnel.ip_dst;
1242         break;
1243     case MFF_TUN_FLAGS:
1244         value->be16 = htons(flow->tunnel.flags);
1245         break;
1246     case MFF_TUN_TTL:
1247         value->u8 = flow->tunnel.ip_ttl;
1248         break;
1249     case MFF_TUN_TOS:
1250         value->u8 = flow->tunnel.ip_tos;
1251         break;
1252
1253     case MFF_METADATA:
1254         value->be64 = flow->metadata;
1255         break;
1256
1257     case MFF_IN_PORT:
1258         value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1259         break;
1260     case MFF_IN_PORT_OXM:
1261         value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1262         break;
1263
1264     case MFF_SKB_PRIORITY:
1265         value->be32 = htonl(flow->skb_priority);
1266         break;
1267
1268     case MFF_PKT_MARK:
1269         value->be32 = htonl(flow->pkt_mark);
1270         break;
1271
1272     CASE_MFF_REGS:
1273         value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1274         break;
1275
1276     case MFF_ETH_SRC:
1277         memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1278         break;
1279
1280     case MFF_ETH_DST:
1281         memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1282         break;
1283
1284     case MFF_ETH_TYPE:
1285         value->be16 = flow->dl_type;
1286         break;
1287
1288     case MFF_VLAN_TCI:
1289         value->be16 = flow->vlan_tci;
1290         break;
1291
1292     case MFF_DL_VLAN:
1293         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1294         break;
1295     case MFF_VLAN_VID:
1296         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1297         break;
1298
1299     case MFF_DL_VLAN_PCP:
1300     case MFF_VLAN_PCP:
1301         value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1302         break;
1303
1304     case MFF_MPLS_LABEL:
1305         value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
1306         break;
1307
1308     case MFF_MPLS_TC:
1309         value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
1310         break;
1311
1312     case MFF_MPLS_BOS:
1313         value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
1314         break;
1315         break;
1316
1317     case MFF_IPV4_SRC:
1318         value->be32 = flow->nw_src;
1319         break;
1320
1321     case MFF_IPV4_DST:
1322         value->be32 = flow->nw_dst;
1323         break;
1324
1325     case MFF_IPV6_SRC:
1326         value->ipv6 = flow->ipv6_src;
1327         break;
1328
1329     case MFF_IPV6_DST:
1330         value->ipv6 = flow->ipv6_dst;
1331         break;
1332
1333     case MFF_IPV6_LABEL:
1334         value->be32 = flow->ipv6_label;
1335         break;
1336
1337     case MFF_IP_PROTO:
1338         value->u8 = flow->nw_proto;
1339         break;
1340
1341     case MFF_IP_DSCP:
1342         value->u8 = flow->nw_tos & IP_DSCP_MASK;
1343         break;
1344
1345     case MFF_IP_DSCP_SHIFTED:
1346         value->u8 = flow->nw_tos >> 2;
1347         break;
1348
1349     case MFF_IP_ECN:
1350         value->u8 = flow->nw_tos & IP_ECN_MASK;
1351         break;
1352
1353     case MFF_IP_TTL:
1354         value->u8 = flow->nw_ttl;
1355         break;
1356
1357     case MFF_IP_FRAG:
1358         value->u8 = flow->nw_frag;
1359         break;
1360
1361     case MFF_ARP_OP:
1362         value->be16 = htons(flow->nw_proto);
1363         break;
1364
1365     case MFF_ARP_SPA:
1366         value->be32 = flow->nw_src;
1367         break;
1368
1369     case MFF_ARP_TPA:
1370         value->be32 = flow->nw_dst;
1371         break;
1372
1373     case MFF_ARP_SHA:
1374     case MFF_ND_SLL:
1375         memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1376         break;
1377
1378     case MFF_ARP_THA:
1379     case MFF_ND_TLL:
1380         memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1381         break;
1382
1383     case MFF_TCP_SRC:
1384     case MFF_UDP_SRC:
1385     case MFF_SCTP_SRC:
1386         value->be16 = flow->tp_src;
1387         break;
1388
1389     case MFF_TCP_DST:
1390     case MFF_UDP_DST:
1391     case MFF_SCTP_DST:
1392         value->be16 = flow->tp_dst;
1393         break;
1394
1395     case MFF_TCP_FLAGS:
1396         value->be16 = flow->tcp_flags;
1397         break;
1398
1399     case MFF_ICMPV4_TYPE:
1400     case MFF_ICMPV6_TYPE:
1401         value->u8 = ntohs(flow->tp_src);
1402         break;
1403
1404     case MFF_ICMPV4_CODE:
1405     case MFF_ICMPV6_CODE:
1406         value->u8 = ntohs(flow->tp_dst);
1407         break;
1408
1409     case MFF_ND_TARGET:
1410         value->ipv6 = flow->nd_target;
1411         break;
1412
1413     case MFF_N_IDS:
1414     default:
1415         OVS_NOT_REACHED();
1416     }
1417 }
1418
1419 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1420  * 'value'.  The caller is responsible for ensuring that 'match' meets 'mf''s
1421  * prerequisites. */
1422 void
1423 mf_set_value(const struct mf_field *mf,
1424              const union mf_value *value, struct match *match)
1425 {
1426     switch (mf->id) {
1427     case MFF_TUN_ID:
1428         match_set_tun_id(match, value->be64);
1429         break;
1430     case MFF_TUN_SRC:
1431         match_set_tun_src(match, value->be32);
1432         break;
1433     case MFF_TUN_DST:
1434         match_set_tun_dst(match, value->be32);
1435         break;
1436     case MFF_TUN_FLAGS:
1437         match_set_tun_flags(match, ntohs(value->be16));
1438         break;
1439     case MFF_TUN_TOS:
1440         match_set_tun_tos(match, value->u8);
1441         break;
1442     case MFF_TUN_TTL:
1443         match_set_tun_ttl(match, value->u8);
1444         break;
1445
1446     case MFF_METADATA:
1447         match_set_metadata(match, value->be64);
1448         break;
1449
1450     case MFF_IN_PORT:
1451         match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1452         break;
1453
1454     case MFF_IN_PORT_OXM: {
1455         ofp_port_t port;
1456         ofputil_port_from_ofp11(value->be32, &port);
1457         match_set_in_port(match, port);
1458         break;
1459     }
1460
1461     case MFF_SKB_PRIORITY:
1462         match_set_skb_priority(match, ntohl(value->be32));
1463         break;
1464
1465     case MFF_PKT_MARK:
1466         match_set_pkt_mark(match, ntohl(value->be32));
1467         break;
1468
1469     CASE_MFF_REGS:
1470         match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1471         break;
1472
1473     case MFF_ETH_SRC:
1474         match_set_dl_src(match, value->mac);
1475         break;
1476
1477     case MFF_ETH_DST:
1478         match_set_dl_dst(match, value->mac);
1479         break;
1480
1481     case MFF_ETH_TYPE:
1482         match_set_dl_type(match, value->be16);
1483         break;
1484
1485     case MFF_VLAN_TCI:
1486         match_set_dl_tci(match, value->be16);
1487         break;
1488
1489     case MFF_DL_VLAN:
1490         match_set_dl_vlan(match, value->be16);
1491         break;
1492     case MFF_VLAN_VID:
1493         match_set_vlan_vid(match, value->be16);
1494         break;
1495
1496     case MFF_DL_VLAN_PCP:
1497     case MFF_VLAN_PCP:
1498         match_set_dl_vlan_pcp(match, value->u8);
1499         break;
1500
1501     case MFF_MPLS_LABEL:
1502         match_set_mpls_label(match, 0, value->be32);
1503         break;
1504
1505     case MFF_MPLS_TC:
1506         match_set_mpls_tc(match, 0, value->u8);
1507         break;
1508
1509     case MFF_MPLS_BOS:
1510         match_set_mpls_bos(match, 0, value->u8);
1511         break;
1512         break;
1513
1514     case MFF_IPV4_SRC:
1515         match_set_nw_src(match, value->be32);
1516         break;
1517
1518     case MFF_IPV4_DST:
1519         match_set_nw_dst(match, value->be32);
1520         break;
1521
1522     case MFF_IPV6_SRC:
1523         match_set_ipv6_src(match, &value->ipv6);
1524         break;
1525
1526     case MFF_IPV6_DST:
1527         match_set_ipv6_dst(match, &value->ipv6);
1528         break;
1529
1530     case MFF_IPV6_LABEL:
1531         match_set_ipv6_label(match, value->be32);
1532         break;
1533
1534     case MFF_IP_PROTO:
1535         match_set_nw_proto(match, value->u8);
1536         break;
1537
1538     case MFF_IP_DSCP:
1539         match_set_nw_dscp(match, value->u8);
1540         break;
1541
1542     case MFF_IP_DSCP_SHIFTED:
1543         match_set_nw_dscp(match, value->u8 << 2);
1544         break;
1545
1546     case MFF_IP_ECN:
1547         match_set_nw_ecn(match, value->u8);
1548         break;
1549
1550     case MFF_IP_TTL:
1551         match_set_nw_ttl(match, value->u8);
1552         break;
1553
1554     case MFF_IP_FRAG:
1555         match_set_nw_frag(match, value->u8);
1556         break;
1557
1558     case MFF_ARP_OP:
1559         match_set_nw_proto(match, ntohs(value->be16));
1560         break;
1561
1562     case MFF_ARP_SPA:
1563         match_set_nw_src(match, value->be32);
1564         break;
1565
1566     case MFF_ARP_TPA:
1567         match_set_nw_dst(match, value->be32);
1568         break;
1569
1570     case MFF_ARP_SHA:
1571     case MFF_ND_SLL:
1572         match_set_arp_sha(match, value->mac);
1573         break;
1574
1575     case MFF_ARP_THA:
1576     case MFF_ND_TLL:
1577         match_set_arp_tha(match, value->mac);
1578         break;
1579
1580     case MFF_TCP_SRC:
1581     case MFF_UDP_SRC:
1582     case MFF_SCTP_SRC:
1583         match_set_tp_src(match, value->be16);
1584         break;
1585
1586     case MFF_TCP_DST:
1587     case MFF_UDP_DST:
1588     case MFF_SCTP_DST:
1589         match_set_tp_dst(match, value->be16);
1590         break;
1591
1592     case MFF_TCP_FLAGS:
1593         match_set_tcp_flags(match, value->be16);
1594         break;
1595
1596     case MFF_ICMPV4_TYPE:
1597     case MFF_ICMPV6_TYPE:
1598         match_set_icmp_type(match, value->u8);
1599         break;
1600
1601     case MFF_ICMPV4_CODE:
1602     case MFF_ICMPV6_CODE:
1603         match_set_icmp_code(match, value->u8);
1604         break;
1605
1606     case MFF_ND_TARGET:
1607         match_set_nd_target(match, &value->ipv6);
1608         break;
1609
1610     case MFF_N_IDS:
1611     default:
1612         OVS_NOT_REACHED();
1613     }
1614 }
1615
1616 /* Unwildcard 'mask' member field described by 'mf'.  The caller is
1617  * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1618 void
1619 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1620 {
1621     static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1622
1623     /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1624      * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1625      * special case. For the rest, calling mf_set_flow_value() is good
1626      * enough. */
1627     if (mf->id == MFF_DL_VLAN) {
1628         flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1629     } else {
1630         mf_set_flow_value(mf, &exact_match_mask, mask);
1631     }
1632 }
1633
1634 /* Sets 'flow' member field described by 'mf' to 'value'.  The caller is
1635  * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1636 void
1637 mf_set_flow_value(const struct mf_field *mf,
1638                   const union mf_value *value, struct flow *flow)
1639 {
1640     switch (mf->id) {
1641     case MFF_TUN_ID:
1642         flow->tunnel.tun_id = value->be64;
1643         break;
1644     case MFF_TUN_SRC:
1645         flow->tunnel.ip_src = value->be32;
1646         break;
1647     case MFF_TUN_DST:
1648         flow->tunnel.ip_dst = value->be32;
1649         break;
1650     case MFF_TUN_FLAGS:
1651         flow->tunnel.flags = ntohs(value->be16);
1652         break;
1653     case MFF_TUN_TOS:
1654         flow->tunnel.ip_tos = value->u8;
1655         break;
1656     case MFF_TUN_TTL:
1657         flow->tunnel.ip_ttl = value->u8;
1658         break;
1659
1660     case MFF_METADATA:
1661         flow->metadata = value->be64;
1662         break;
1663
1664     case MFF_IN_PORT:
1665         flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1666         break;
1667
1668     case MFF_IN_PORT_OXM: {
1669         ofp_port_t port;
1670         ofputil_port_from_ofp11(value->be32, &port);
1671         flow->in_port.ofp_port = port;
1672         break;
1673     }
1674
1675     case MFF_SKB_PRIORITY:
1676         flow->skb_priority = ntohl(value->be32);
1677         break;
1678
1679     case MFF_PKT_MARK:
1680         flow->pkt_mark = ntohl(value->be32);
1681         break;
1682
1683     CASE_MFF_REGS:
1684         flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1685         break;
1686
1687     case MFF_ETH_SRC:
1688         memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1689         break;
1690
1691     case MFF_ETH_DST:
1692         memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1693         break;
1694
1695     case MFF_ETH_TYPE:
1696         flow->dl_type = value->be16;
1697         break;
1698
1699     case MFF_VLAN_TCI:
1700         flow->vlan_tci = value->be16;
1701         break;
1702
1703     case MFF_DL_VLAN:
1704         flow_set_dl_vlan(flow, value->be16);
1705         break;
1706     case MFF_VLAN_VID:
1707         flow_set_vlan_vid(flow, value->be16);
1708         break;
1709
1710     case MFF_DL_VLAN_PCP:
1711     case MFF_VLAN_PCP:
1712         flow_set_vlan_pcp(flow, value->u8);
1713         break;
1714
1715     case MFF_MPLS_LABEL:
1716         flow_set_mpls_label(flow, 0, value->be32);
1717         break;
1718
1719     case MFF_MPLS_TC:
1720         flow_set_mpls_tc(flow, 0, value->u8);
1721         break;
1722
1723     case MFF_MPLS_BOS:
1724         flow_set_mpls_bos(flow, 0, value->u8);
1725         break;
1726         break;
1727
1728     case MFF_IPV4_SRC:
1729         flow->nw_src = value->be32;
1730         break;
1731
1732     case MFF_IPV4_DST:
1733         flow->nw_dst = value->be32;
1734         break;
1735
1736     case MFF_IPV6_SRC:
1737         flow->ipv6_src = value->ipv6;
1738         break;
1739
1740     case MFF_IPV6_DST:
1741         flow->ipv6_dst = value->ipv6;
1742         break;
1743
1744     case MFF_IPV6_LABEL:
1745         flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1746         break;
1747
1748     case MFF_IP_PROTO:
1749         flow->nw_proto = value->u8;
1750         break;
1751
1752     case MFF_IP_DSCP:
1753         flow->nw_tos &= ~IP_DSCP_MASK;
1754         flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1755         break;
1756
1757     case MFF_IP_DSCP_SHIFTED:
1758         flow->nw_tos &= ~IP_DSCP_MASK;
1759         flow->nw_tos |= value->u8 << 2;
1760         break;
1761
1762     case MFF_IP_ECN:
1763         flow->nw_tos &= ~IP_ECN_MASK;
1764         flow->nw_tos |= value->u8 & IP_ECN_MASK;
1765         break;
1766
1767     case MFF_IP_TTL:
1768         flow->nw_ttl = value->u8;
1769         break;
1770
1771     case MFF_IP_FRAG:
1772         flow->nw_frag &= value->u8;
1773         break;
1774
1775     case MFF_ARP_OP:
1776         flow->nw_proto = ntohs(value->be16);
1777         break;
1778
1779     case MFF_ARP_SPA:
1780         flow->nw_src = value->be32;
1781         break;
1782
1783     case MFF_ARP_TPA:
1784         flow->nw_dst = value->be32;
1785         break;
1786
1787     case MFF_ARP_SHA:
1788     case MFF_ND_SLL:
1789         memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1790         break;
1791
1792     case MFF_ARP_THA:
1793     case MFF_ND_TLL:
1794         memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1795         break;
1796
1797     case MFF_TCP_SRC:
1798     case MFF_UDP_SRC:
1799     case MFF_SCTP_SRC:
1800         flow->tp_src = value->be16;
1801         break;
1802
1803     case MFF_TCP_DST:
1804     case MFF_UDP_DST:
1805     case MFF_SCTP_DST:
1806         flow->tp_dst = value->be16;
1807         break;
1808
1809     case MFF_TCP_FLAGS:
1810         flow->tcp_flags = value->be16;
1811         break;
1812
1813     case MFF_ICMPV4_TYPE:
1814     case MFF_ICMPV6_TYPE:
1815         flow->tp_src = htons(value->u8);
1816         break;
1817
1818     case MFF_ICMPV4_CODE:
1819     case MFF_ICMPV6_CODE:
1820         flow->tp_dst = htons(value->u8);
1821         break;
1822
1823     case MFF_ND_TARGET:
1824         flow->nd_target = value->ipv6;
1825         break;
1826
1827     case MFF_N_IDS:
1828     default:
1829         OVS_NOT_REACHED();
1830     }
1831 }
1832
1833 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1834  *
1835  * The caller is responsible for ensuring that 'flow' meets 'mf''s
1836  * prerequisites. */
1837 bool
1838 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1839 {
1840     union mf_value value;
1841
1842     mf_get_value(mf, flow, &value);
1843     return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1844 }
1845
1846 /* Makes 'match' wildcard field 'mf'.
1847  *
1848  * The caller is responsible for ensuring that 'match' meets 'mf''s
1849  * prerequisites. */
1850 void
1851 mf_set_wild(const struct mf_field *mf, struct match *match)
1852 {
1853     switch (mf->id) {
1854     case MFF_TUN_ID:
1855         match_set_tun_id_masked(match, htonll(0), htonll(0));
1856         break;
1857     case MFF_TUN_SRC:
1858         match_set_tun_src_masked(match, htonl(0), htonl(0));
1859         break;
1860     case MFF_TUN_DST:
1861         match_set_tun_dst_masked(match, htonl(0), htonl(0));
1862         break;
1863     case MFF_TUN_FLAGS:
1864         match_set_tun_flags_masked(match, 0, 0);
1865         break;
1866     case MFF_TUN_TOS:
1867         match_set_tun_tos_masked(match, 0, 0);
1868         break;
1869     case MFF_TUN_TTL:
1870         match_set_tun_ttl_masked(match, 0, 0);
1871         break;
1872
1873     case MFF_METADATA:
1874         match_set_metadata_masked(match, htonll(0), htonll(0));
1875         break;
1876
1877     case MFF_IN_PORT:
1878     case MFF_IN_PORT_OXM:
1879         match->flow.in_port.ofp_port = 0;
1880         match->wc.masks.in_port.ofp_port = 0;
1881         break;
1882
1883     case MFF_SKB_PRIORITY:
1884         match->flow.skb_priority = 0;
1885         match->wc.masks.skb_priority = 0;
1886         break;
1887
1888     case MFF_PKT_MARK:
1889         match->flow.pkt_mark = 0;
1890         match->wc.masks.pkt_mark = 0;
1891         break;
1892
1893     CASE_MFF_REGS:
1894         match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1895         break;
1896
1897     case MFF_ETH_SRC:
1898         memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1899         memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1900         break;
1901
1902     case MFF_ETH_DST:
1903         memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1904         memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1905         break;
1906
1907     case MFF_ETH_TYPE:
1908         match->flow.dl_type = htons(0);
1909         match->wc.masks.dl_type = htons(0);
1910         break;
1911
1912     case MFF_VLAN_TCI:
1913         match_set_dl_tci_masked(match, htons(0), htons(0));
1914         break;
1915
1916     case MFF_DL_VLAN:
1917     case MFF_VLAN_VID:
1918         match_set_any_vid(match);
1919         break;
1920
1921     case MFF_DL_VLAN_PCP:
1922     case MFF_VLAN_PCP:
1923         match_set_any_pcp(match);
1924         break;
1925
1926     case MFF_MPLS_LABEL:
1927         match_set_any_mpls_label(match, 0);
1928         break;
1929
1930     case MFF_MPLS_TC:
1931         match_set_any_mpls_tc(match, 0);
1932         break;
1933
1934     case MFF_MPLS_BOS:
1935         match_set_any_mpls_bos(match, 0);
1936         break;
1937         break;
1938
1939     case MFF_IPV4_SRC:
1940     case MFF_ARP_SPA:
1941         match_set_nw_src_masked(match, htonl(0), htonl(0));
1942         break;
1943
1944     case MFF_IPV4_DST:
1945     case MFF_ARP_TPA:
1946         match_set_nw_dst_masked(match, htonl(0), htonl(0));
1947         break;
1948
1949     case MFF_IPV6_SRC:
1950         memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1951         memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1952         break;
1953
1954     case MFF_IPV6_DST:
1955         memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1956         memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1957         break;
1958
1959     case MFF_IPV6_LABEL:
1960         match->wc.masks.ipv6_label = htonl(0);
1961         match->flow.ipv6_label = htonl(0);
1962         break;
1963
1964     case MFF_IP_PROTO:
1965         match->wc.masks.nw_proto = 0;
1966         match->flow.nw_proto = 0;
1967         break;
1968
1969     case MFF_IP_DSCP:
1970     case MFF_IP_DSCP_SHIFTED:
1971         match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1972         match->flow.nw_tos &= ~IP_DSCP_MASK;
1973         break;
1974
1975     case MFF_IP_ECN:
1976         match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1977         match->flow.nw_tos &= ~IP_ECN_MASK;
1978         break;
1979
1980     case MFF_IP_TTL:
1981         match->wc.masks.nw_ttl = 0;
1982         match->flow.nw_ttl = 0;
1983         break;
1984
1985     case MFF_IP_FRAG:
1986         match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1987         match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1988         break;
1989
1990     case MFF_ARP_OP:
1991         match->wc.masks.nw_proto = 0;
1992         match->flow.nw_proto = 0;
1993         break;
1994
1995     case MFF_ARP_SHA:
1996     case MFF_ND_SLL:
1997         memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1998         memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1999         break;
2000
2001     case MFF_ARP_THA:
2002     case MFF_ND_TLL:
2003         memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
2004         memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
2005         break;
2006
2007     case MFF_TCP_SRC:
2008     case MFF_UDP_SRC:
2009     case MFF_SCTP_SRC:
2010     case MFF_ICMPV4_TYPE:
2011     case MFF_ICMPV6_TYPE:
2012         match->wc.masks.tp_src = htons(0);
2013         match->flow.tp_src = htons(0);
2014         break;
2015
2016     case MFF_TCP_DST:
2017     case MFF_UDP_DST:
2018     case MFF_SCTP_DST:
2019     case MFF_ICMPV4_CODE:
2020     case MFF_ICMPV6_CODE:
2021         match->wc.masks.tp_dst = htons(0);
2022         match->flow.tp_dst = htons(0);
2023         break;
2024
2025     case MFF_TCP_FLAGS:
2026         match->wc.masks.tcp_flags = htons(0);
2027         match->flow.tcp_flags = htons(0);
2028         break;
2029
2030     case MFF_ND_TARGET:
2031         memset(&match->wc.masks.nd_target, 0,
2032                sizeof match->wc.masks.nd_target);
2033         memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
2034         break;
2035
2036     case MFF_N_IDS:
2037     default:
2038         OVS_NOT_REACHED();
2039     }
2040 }
2041
2042 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2043  * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2044  * with a 1-bit indicating that the corresponding value bit must match and a
2045  * 0-bit indicating a don't-care.
2046  *
2047  * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2048  * mf_set_value(mf, value, match).  If 'mask' points to all-0-bits, then this
2049  * call is equivalent to mf_set_wild(mf, match).
2050  *
2051  * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()).  The caller
2052  * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2053 enum ofputil_protocol
2054 mf_set(const struct mf_field *mf,
2055        const union mf_value *value, const union mf_value *mask,
2056        struct match *match)
2057 {
2058     if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2059         mf_set_value(mf, value, match);
2060         return mf->usable_protocols;
2061     } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2062         mf_set_wild(mf, match);
2063         return OFPUTIL_P_ANY;
2064     }
2065
2066     switch (mf->id) {
2067     case MFF_IN_PORT:
2068     case MFF_IN_PORT_OXM:
2069     case MFF_SKB_PRIORITY:
2070     case MFF_ETH_TYPE:
2071     case MFF_DL_VLAN:
2072     case MFF_DL_VLAN_PCP:
2073     case MFF_VLAN_PCP:
2074     case MFF_MPLS_LABEL:
2075     case MFF_MPLS_TC:
2076     case MFF_MPLS_BOS:
2077     case MFF_IP_PROTO:
2078     case MFF_IP_TTL:
2079     case MFF_IP_DSCP:
2080     case MFF_IP_DSCP_SHIFTED:
2081     case MFF_IP_ECN:
2082     case MFF_ARP_OP:
2083     case MFF_ICMPV4_TYPE:
2084     case MFF_ICMPV4_CODE:
2085     case MFF_ICMPV6_TYPE:
2086     case MFF_ICMPV6_CODE:
2087         return OFPUTIL_P_NONE;
2088
2089     case MFF_TUN_ID:
2090         match_set_tun_id_masked(match, value->be64, mask->be64);
2091         break;
2092     case MFF_TUN_SRC:
2093         match_set_tun_src_masked(match, value->be32, mask->be32);
2094         break;
2095     case MFF_TUN_DST:
2096         match_set_tun_dst_masked(match, value->be32, mask->be32);
2097         break;
2098     case MFF_TUN_FLAGS:
2099         match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
2100         break;
2101     case MFF_TUN_TTL:
2102         match_set_tun_ttl_masked(match, value->u8, mask->u8);
2103         break;
2104     case MFF_TUN_TOS:
2105         match_set_tun_tos_masked(match, value->u8, mask->u8);
2106         break;
2107
2108     case MFF_METADATA:
2109         match_set_metadata_masked(match, value->be64, mask->be64);
2110         break;
2111
2112     CASE_MFF_REGS:
2113         match_set_reg_masked(match, mf->id - MFF_REG0,
2114                              ntohl(value->be32), ntohl(mask->be32));
2115         break;
2116
2117     case MFF_PKT_MARK:
2118         match_set_pkt_mark_masked(match, ntohl(value->be32),
2119                                   ntohl(mask->be32));
2120         break;
2121
2122     case MFF_ETH_DST:
2123         match_set_dl_dst_masked(match, value->mac, mask->mac);
2124         break;
2125
2126     case MFF_ETH_SRC:
2127         match_set_dl_src_masked(match, value->mac, mask->mac);
2128         break;
2129
2130     case MFF_ARP_SHA:
2131     case MFF_ND_SLL:
2132         match_set_arp_sha_masked(match, value->mac, mask->mac);
2133         break;
2134
2135     case MFF_ARP_THA:
2136     case MFF_ND_TLL:
2137         match_set_arp_tha_masked(match, value->mac, mask->mac);
2138         break;
2139
2140     case MFF_VLAN_TCI:
2141         match_set_dl_tci_masked(match, value->be16, mask->be16);
2142         break;
2143
2144     case MFF_VLAN_VID:
2145         match_set_vlan_vid_masked(match, value->be16, mask->be16);
2146         break;
2147
2148     case MFF_IPV4_SRC:
2149         match_set_nw_src_masked(match, value->be32, mask->be32);
2150         goto cidr_check;
2151
2152     case MFF_IPV4_DST:
2153         match_set_nw_dst_masked(match, value->be32, mask->be32);
2154         goto cidr_check;
2155
2156     case MFF_IPV6_SRC:
2157         match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2158         break;
2159
2160     case MFF_IPV6_DST:
2161         match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2162         break;
2163
2164     case MFF_IPV6_LABEL:
2165         if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2166             mf_set_value(mf, value, match);
2167         } else {
2168             match_set_ipv6_label_masked(match, value->be32, mask->be32);
2169         }
2170         break;
2171
2172     case MFF_ND_TARGET:
2173         match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2174         break;
2175
2176     case MFF_IP_FRAG:
2177         match_set_nw_frag_masked(match, value->u8, mask->u8);
2178         break;
2179
2180     case MFF_ARP_SPA:
2181         match_set_nw_src_masked(match, value->be32, mask->be32);
2182         goto cidr_check;
2183
2184     case MFF_ARP_TPA:
2185         match_set_nw_dst_masked(match, value->be32, mask->be32);
2186         goto cidr_check;
2187
2188     case MFF_TCP_SRC:
2189     case MFF_UDP_SRC:
2190     case MFF_SCTP_SRC:
2191         match_set_tp_src_masked(match, value->be16, mask->be16);
2192         break;
2193
2194     case MFF_TCP_DST:
2195     case MFF_UDP_DST:
2196     case MFF_SCTP_DST:
2197         match_set_tp_dst_masked(match, value->be16, mask->be16);
2198         break;
2199
2200     case MFF_TCP_FLAGS:
2201         match_set_tcp_flags_masked(match, value->be16, mask->be16);
2202         break;
2203
2204     case MFF_N_IDS:
2205     default:
2206         OVS_NOT_REACHED();
2207     }
2208
2209     return mf->usable_protocols_bitwise;
2210
2211 cidr_check:
2212     return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2213             mf->usable_protocols_bitwise;
2214 }
2215
2216 static enum ofperr
2217 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2218            const char *type)
2219 {
2220     if (!sf->field) {
2221         VLOG_WARN_RL(&rl, "unknown %s field", type);
2222         return OFPERR_OFPBAC_BAD_SET_TYPE;
2223     } else if (!sf->n_bits) {
2224         VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2225         return OFPERR_OFPBAC_BAD_SET_LEN;
2226     } else if (sf->ofs >= sf->field->n_bits) {
2227         VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2228                      sf->ofs, sf->field->n_bits, type, sf->field->name);
2229         return OFPERR_OFPBAC_BAD_SET_LEN;
2230     } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2231         VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2232                      "of %s field %s", sf->ofs, sf->n_bits,
2233                      sf->field->n_bits, type, sf->field->name);
2234         return OFPERR_OFPBAC_BAD_SET_LEN;
2235     } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2236         VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2237                      type, sf->field->name);
2238         return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2239     } else {
2240         return 0;
2241     }
2242 }
2243
2244 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'.  Returns
2245  * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2246  * ofp_mkerr()).  */
2247 enum ofperr
2248 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2249 {
2250     return mf_check__(sf, flow, "source");
2251 }
2252
2253 /* Checks whether 'sf' is valid for writing a subfield into 'flow'.  Returns 0
2254  * if so, otherwise an OpenFlow error code (e.g. as returned by
2255  * ofp_mkerr()). */
2256 enum ofperr
2257 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2258 {
2259     int error = mf_check__(sf, flow, "destination");
2260     if (!error && !sf->field->writable) {
2261         VLOG_WARN_RL(&rl, "destination field %s is not writable",
2262                      sf->field->name);
2263         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2264     }
2265     return error;
2266 }
2267
2268 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2269  * 'value' and 'mask', respectively. */
2270 void
2271 mf_get(const struct mf_field *mf, const struct match *match,
2272        union mf_value *value, union mf_value *mask)
2273 {
2274     mf_get_value(mf, &match->flow, value);
2275     mf_get_mask(mf, &match->wc, mask);
2276 }
2277
2278 static char *
2279 mf_from_integer_string(const struct mf_field *mf, const char *s,
2280                        uint8_t *valuep, uint8_t *maskp)
2281 {
2282     unsigned long long int integer, mask;
2283     char *tail;
2284     int i;
2285
2286     errno = 0;
2287     integer = strtoull(s, &tail, 0);
2288     if (errno || (*tail != '\0' && *tail != '/')) {
2289         goto syntax_error;
2290     }
2291
2292     if (*tail == '/') {
2293         mask = strtoull(tail + 1, &tail, 0);
2294         if (errno || *tail != '\0') {
2295             goto syntax_error;
2296         }
2297     } else {
2298         mask = ULLONG_MAX;
2299     }
2300
2301     for (i = mf->n_bytes - 1; i >= 0; i--) {
2302         valuep[i] = integer;
2303         maskp[i] = mask;
2304         integer >>= 8;
2305         mask >>= 8;
2306     }
2307     if (integer) {
2308         return xasprintf("%s: value too large for %u-byte field %s",
2309                          s, mf->n_bytes, mf->name);
2310     }
2311     return NULL;
2312
2313 syntax_error:
2314     return xasprintf("%s: bad syntax for %s", s, mf->name);
2315 }
2316
2317 static char *
2318 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2319                         uint8_t mac[ETH_ADDR_LEN],
2320                         uint8_t mask[ETH_ADDR_LEN])
2321 {
2322     int n;
2323
2324     ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2325
2326     n = -1;
2327     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n)
2328         && n == strlen(s)) {
2329         memset(mask, 0xff, ETH_ADDR_LEN);
2330         return NULL;
2331     }
2332
2333     n = -1;
2334     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2335                  ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n)
2336         && n == strlen(s)) {
2337         return NULL;
2338     }
2339
2340     return xasprintf("%s: invalid Ethernet address", s);
2341 }
2342
2343 static char *
2344 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2345                     ovs_be32 *ip, ovs_be32 *mask)
2346 {
2347     int prefix;
2348
2349     ovs_assert(mf->n_bytes == sizeof *ip);
2350
2351     if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2352                  IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
2353         /* OK. */
2354     } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
2355         if (prefix <= 0 || prefix > 32) {
2356             return xasprintf("%s: network prefix bits not between 1 and "
2357                              "32", s);
2358         } else if (prefix == 32) {
2359             *mask = OVS_BE32_MAX;
2360         } else {
2361             *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2362         }
2363     } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
2364         *mask = OVS_BE32_MAX;
2365     } else {
2366         return xasprintf("%s: invalid IP address", s);
2367     }
2368     return NULL;
2369 }
2370
2371 static char *
2372 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2373                     struct in6_addr *value, struct in6_addr *mask)
2374 {
2375     char *str = xstrdup(s);
2376     char *save_ptr = NULL;
2377     const char *name, *netmask;
2378     int retval;
2379
2380     ovs_assert(mf->n_bytes == sizeof *value);
2381
2382     name = strtok_r(str, "/", &save_ptr);
2383     retval = name ? lookup_ipv6(name, value) : EINVAL;
2384     if (retval) {
2385         char *err;
2386
2387         err = xasprintf("%s: could not convert to IPv6 address", str);
2388         free(str);
2389
2390         return err;
2391     }
2392
2393     netmask = strtok_r(NULL, "/", &save_ptr);
2394     if (netmask) {
2395         if (inet_pton(AF_INET6, netmask, mask) != 1) {
2396             int prefix = atoi(netmask);
2397             if (prefix <= 0 || prefix > 128) {
2398                 free(str);
2399                 return xasprintf("%s: prefix bits not between 1 and 128", s);
2400             } else {
2401                 *mask = ipv6_create_mask(prefix);
2402             }
2403         }
2404     } else {
2405         *mask = in6addr_exact;
2406     }
2407     free(str);
2408
2409     return NULL;
2410 }
2411
2412 static char *
2413 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2414                         ovs_be16 *valuep, ovs_be16 *maskp)
2415 {
2416     ofp_port_t port;
2417
2418     ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2419
2420     if (ofputil_port_from_string(s, &port)) {
2421         *valuep = htons(ofp_to_u16(port));
2422         *maskp = OVS_BE16_MAX;
2423         return NULL;
2424     }
2425     return xasprintf("%s: port value out of range for %s", s, mf->name);
2426 }
2427
2428 static char *
2429 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2430                           ovs_be32 *valuep, ovs_be32 *maskp)
2431 {
2432     ofp_port_t port;
2433
2434     ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2435     if (ofputil_port_from_string(s, &port)) {
2436         *valuep = ofputil_port_to_ofp11(port);
2437         *maskp = OVS_BE32_MAX;
2438         return NULL;
2439     }
2440     return xasprintf("%s: port value out of range for %s", s, mf->name);
2441 }
2442
2443 struct frag_handling {
2444     const char *name;
2445     uint8_t mask;
2446     uint8_t value;
2447 };
2448
2449 static const struct frag_handling all_frags[] = {
2450 #define A FLOW_NW_FRAG_ANY
2451 #define L FLOW_NW_FRAG_LATER
2452     /* name               mask  value */
2453
2454     { "no",               A|L,  0     },
2455     { "first",            A|L,  A     },
2456     { "later",            A|L,  A|L   },
2457
2458     { "no",               A,    0     },
2459     { "yes",              A,    A     },
2460
2461     { "not_later",        L,    0     },
2462     { "later",            L,    L     },
2463 #undef A
2464 #undef L
2465 };
2466
2467 static char *
2468 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2469 {
2470     const struct frag_handling *h;
2471
2472     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2473         if (!strcasecmp(s, h->name)) {
2474             /* We force the upper bits of the mask on to make mf_parse_value()
2475              * happy (otherwise it will never think it's an exact match.) */
2476             *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2477             *valuep = h->value;
2478             return NULL;
2479         }
2480     }
2481
2482     return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2483                      "\"yes\", \"first\", \"later\", \"not_first\"", s);
2484 }
2485
2486 static int
2487 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2488                      ovs_be16 *res)
2489 {
2490     uint32_t result = 0;
2491     char *save_ptr = NULL;
2492     char *name;
2493     int rc = 0;
2494     char *s = xstrdup(s_);
2495
2496     for (name = strtok_r((char *)s, " |", &save_ptr); name;
2497          name = strtok_r(NULL, " |", &save_ptr)) {
2498         int name_len;
2499         unsigned long long int flags;
2500         uint32_t bit;
2501
2502         if (ovs_scan(name, "%lli", &flags)) {
2503             result |= flags;
2504             continue;
2505         }
2506         name_len = strlen(name);
2507         for (bit = 1; bit; bit <<= 1) {
2508             const char *fname = bit_to_string(bit);
2509             size_t len;
2510
2511             if (!fname) {
2512                 continue;
2513             }
2514
2515             len = strlen(fname);
2516             if (len != name_len) {
2517                 continue;
2518             }
2519             if (!strncmp(name, fname, len)) {
2520                 result |= bit;
2521                 break;
2522             }
2523         }
2524
2525         if (!bit) {
2526             rc = -ENOENT;
2527             goto out;
2528         }
2529     }
2530
2531     *res = htons(result);
2532 out:
2533     free(s);
2534     return rc;
2535 }
2536
2537 static char *
2538 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2539 {
2540     if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2541         *maskp = OVS_BE16_MAX;
2542         return NULL;
2543     }
2544
2545     return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2546                      "\"csum\", \"key\")", s);
2547 }
2548
2549 static char *
2550 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2551 {
2552     uint16_t flags = 0;
2553     uint16_t mask = 0;
2554     uint16_t bit;
2555     int n;
2556
2557     if (ovs_scan(s, "%"SCNi16"/%"SCNi16"%n", &flags, &mask, &n) && !s[n]) {
2558         *flagsp = htons(flags);
2559         *maskp = htons(mask);
2560         return NULL;
2561     }
2562     if (ovs_scan(s, "%"SCNi16"%n", &flags, &n) && !s[n]) {
2563         *flagsp = htons(flags);
2564         *maskp = OVS_BE16_MAX;
2565         return NULL;
2566     }
2567
2568     while (*s != '\0') {
2569         bool set;
2570         int name_len;
2571
2572         switch (*s) {
2573         case '+':
2574             set = true;
2575             break;
2576         case '-':
2577             set = false;
2578             break;
2579         default:
2580             return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2581                              "or '-' (NOT SET)", s);
2582         }
2583         s++;
2584
2585         name_len = strcspn(s,"+-");
2586
2587         for (bit = 1; bit; bit <<= 1) {
2588             const char *fname = packet_tcp_flag_to_string(bit);
2589             size_t len;
2590
2591             if (!fname) {
2592                 continue;
2593             }
2594
2595             len = strlen(fname);
2596             if (len != name_len) {
2597                 continue;
2598             }
2599             if (!strncmp(s, fname, len)) {
2600                 if (mask & bit) {
2601                     return xasprintf("%s: Each TCP flag can be specified only "
2602                                      "once", s);
2603                 }
2604                 if (set) {
2605                     flags |= bit;
2606                 }
2607                 mask |= bit;
2608                 break;
2609             }
2610         }
2611
2612         if (!bit) {
2613             return xasprintf("%s: unknown TCP flag(s)", s);
2614         }
2615         s += name_len;
2616     }
2617
2618     *flagsp = htons(flags);
2619     *maskp = htons(mask);
2620     return NULL;
2621 }
2622
2623
2624 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'.  Returns
2625  * NULL if successful, otherwise a malloc()'d string describing the error. */
2626 char *
2627 mf_parse(const struct mf_field *mf, const char *s,
2628          union mf_value *value, union mf_value *mask)
2629 {
2630     char *error;
2631
2632     if (!strcmp(s, "*")) {
2633         memset(value, 0, mf->n_bytes);
2634         memset(mask, 0, mf->n_bytes);
2635         return NULL;
2636     }
2637
2638     switch (mf->string) {
2639     case MFS_DECIMAL:
2640     case MFS_HEXADECIMAL:
2641         error = mf_from_integer_string(mf, s,
2642                                        (uint8_t *) value, (uint8_t *) mask);
2643         break;
2644
2645     case MFS_ETHERNET:
2646         error = mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2647         break;
2648
2649     case MFS_IPV4:
2650         error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2651         break;
2652
2653     case MFS_IPV6:
2654         error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2655         break;
2656
2657     case MFS_OFP_PORT:
2658         error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2659         break;
2660
2661     case MFS_OFP_PORT_OXM:
2662         error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2663         break;
2664
2665     case MFS_FRAG:
2666         error = mf_from_frag_string(s, &value->u8, &mask->u8);
2667         break;
2668
2669     case MFS_TNL_FLAGS:
2670         ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2671         error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2672         break;
2673
2674     case MFS_TCP_FLAGS:
2675         ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2676         error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2677         break;
2678
2679     default:
2680         OVS_NOT_REACHED();
2681     }
2682
2683     if (!error && !mf_is_mask_valid(mf, mask)) {
2684         error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2685     }
2686     return error;
2687 }
2688
2689 /* Parses 's', a string value for field 'mf', into 'value'.  Returns NULL if
2690  * successful, otherwise a malloc()'d string describing the error. */
2691 char *
2692 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2693 {
2694     union mf_value mask;
2695     char *error;
2696
2697     error = mf_parse(mf, s, value, &mask);
2698     if (error) {
2699         return error;
2700     }
2701
2702     if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2703         return xasprintf("%s: wildcards not allowed here", s);
2704     }
2705     return NULL;
2706 }
2707
2708 static void
2709 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2710                          const uint8_t *maskp, struct ds *s)
2711 {
2712     unsigned long long int integer;
2713     int i;
2714
2715     ovs_assert(mf->n_bytes <= 8);
2716
2717     integer = 0;
2718     for (i = 0; i < mf->n_bytes; i++) {
2719         integer = (integer << 8) | valuep[i];
2720     }
2721     if (mf->string == MFS_HEXADECIMAL) {
2722         ds_put_format(s, "%#llx", integer);
2723     } else {
2724         ds_put_format(s, "%lld", integer);
2725     }
2726
2727     if (maskp) {
2728         unsigned long long int mask;
2729
2730         mask = 0;
2731         for (i = 0; i < mf->n_bytes; i++) {
2732             mask = (mask << 8) | maskp[i];
2733         }
2734
2735         /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2736          * not sure that that a bit-mask written in decimal is ever easier to
2737          * understand than the same bit-mask written in hexadecimal. */
2738         ds_put_format(s, "/%#llx", mask);
2739     }
2740 }
2741
2742 static void
2743 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2744 {
2745     const struct frag_handling *h;
2746
2747     mask &= FLOW_NW_FRAG_MASK;
2748     value &= mask;
2749
2750     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2751         if (value == h->value && mask == h->mask) {
2752             ds_put_cstr(s, h->name);
2753             return;
2754         }
2755     }
2756     ds_put_cstr(s, "<error>");
2757 }
2758
2759 static void
2760 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2761 {
2762     format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2763 }
2764
2765 static void
2766 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2767 {
2768     format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2769                         TCP_FLAGS(mask));
2770 }
2771
2772 /* Appends to 's' a string representation of field 'mf' whose value is in
2773  * 'value' and 'mask'.  'mask' may be NULL to indicate an exact match. */
2774 void
2775 mf_format(const struct mf_field *mf,
2776           const union mf_value *value, const union mf_value *mask,
2777           struct ds *s)
2778 {
2779     if (mask) {
2780         if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2781             ds_put_cstr(s, "ANY");
2782             return;
2783         } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2784             mask = NULL;
2785         }
2786     }
2787
2788     switch (mf->string) {
2789     case MFS_OFP_PORT_OXM:
2790         if (!mask) {
2791             ofp_port_t port;
2792             ofputil_port_from_ofp11(value->be32, &port);
2793             ofputil_format_port(port, s);
2794             break;
2795         }
2796         /* fall through */
2797     case MFS_OFP_PORT:
2798         if (!mask) {
2799             ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2800             break;
2801         }
2802         /* fall through */
2803     case MFS_DECIMAL:
2804     case MFS_HEXADECIMAL:
2805         mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2806         break;
2807
2808     case MFS_ETHERNET:
2809         eth_format_masked(value->mac, mask->mac, s);
2810         break;
2811
2812     case MFS_IPV4:
2813         ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2814         break;
2815
2816     case MFS_IPV6:
2817         print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2818         break;
2819
2820     case MFS_FRAG:
2821         mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2822         break;
2823
2824     case MFS_TNL_FLAGS:
2825         mf_format_tnl_flags_string(&value->be16, s);
2826         break;
2827
2828     case MFS_TCP_FLAGS:
2829         mf_format_tcp_flags_string(value->be16,
2830                                    mask ? mask->be16 : OVS_BE16_MAX, s);
2831         break;
2832
2833     default:
2834         OVS_NOT_REACHED();
2835     }
2836 }
2837 \f
2838 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2839  * least-significant bits in 'x'.
2840  */
2841 void
2842 mf_write_subfield_flow(const struct mf_subfield *sf,
2843                        const union mf_subvalue *x, struct flow *flow)
2844 {
2845     const struct mf_field *field = sf->field;
2846     union mf_value value;
2847
2848     mf_get_value(field, flow, &value);
2849     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2850                  sf->ofs, sf->n_bits);
2851     mf_set_flow_value(field, &value, flow);
2852 }
2853
2854 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2855  * least-significant bits in 'x'.
2856  */
2857 void
2858 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2859                   struct match *match)
2860 {
2861     const struct mf_field *field = sf->field;
2862     union mf_value value, mask;
2863
2864     mf_get(field, match, &value, &mask);
2865     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2866     bitwise_one (                 &mask,  field->n_bytes, sf->ofs, sf->n_bits);
2867     mf_set(field, &value, &mask, match);
2868 }
2869
2870 /* Initializes 'x' to the value of 'sf' within 'flow'.  'sf' must be valid for
2871  * reading 'flow', e.g. as checked by mf_check_src(). */
2872 void
2873 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2874                  union mf_subvalue *x)
2875 {
2876     union mf_value value;
2877
2878     mf_get_value(sf->field, flow, &value);
2879
2880     memset(x, 0, sizeof *x);
2881     bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2882                  x, sizeof *x, 0,
2883                  sf->n_bits);
2884 }
2885
2886 /* Returns the value of 'sf' within 'flow'.  'sf' must be valid for reading
2887  * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2888  * less. */
2889 uint64_t
2890 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2891 {
2892     union mf_value value;
2893
2894     mf_get_value(sf->field, flow, &value);
2895     return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2896 }
2897
2898 /* Formats 'sf' into 's' in a format normally acceptable to
2899  * mf_parse_subfield().  (It won't be acceptable if sf->field is NULL or if
2900  * sf->field has no NXM name.) */
2901 void
2902 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2903 {
2904     if (!sf->field) {
2905         ds_put_cstr(s, "<unknown>");
2906     } else if (sf->field->nxm_name) {
2907         ds_put_cstr(s, sf->field->nxm_name);
2908     } else if (sf->field->nxm_header) {
2909         uint32_t header = sf->field->nxm_header;
2910         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2911     } else {
2912         ds_put_cstr(s, sf->field->name);
2913     }
2914
2915     if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2916         ds_put_cstr(s, "[]");
2917     } else if (sf->n_bits == 1) {
2918         ds_put_format(s, "[%d]", sf->ofs);
2919     } else {
2920         ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2921     }
2922 }
2923
2924 static const struct mf_field *
2925 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2926 {
2927     int i;
2928
2929     *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2930     if (*wild) {
2931         name_len -= 2;
2932     }
2933
2934     for (i = 0; i < MFF_N_IDS; i++) {
2935         const struct mf_field *mf = mf_from_id(i);
2936
2937         if (mf->nxm_name
2938             && !strncmp(mf->nxm_name, name, name_len)
2939             && mf->nxm_name[name_len] == '\0') {
2940             return mf;
2941         }
2942         if (mf->oxm_name
2943             && !strncmp(mf->oxm_name, name, name_len)
2944             && mf->oxm_name[name_len] == '\0') {
2945             return mf;
2946         }
2947     }
2948
2949     return NULL;
2950 }
2951
2952 /* Parses a subfield from the beginning of '*sp' into 'sf'.  If successful,
2953  * returns NULL and advances '*sp' to the first byte following the parsed
2954  * string.  On failure, returns a malloc()'d error message, does not modify
2955  * '*sp', and does not properly initialize 'sf'.
2956  *
2957  * The syntax parsed from '*sp' takes the form "header[start..end]" where
2958  * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2959  * bit indexes.  "..end" may be omitted to indicate a single bit.  "start..end"
2960  * may both be omitted (the [] are still required) to indicate an entire
2961  * field. */
2962 char * WARN_UNUSED_RESULT
2963 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2964 {
2965     const struct mf_field *field;
2966     const char *name;
2967     int start, end;
2968     const char *s;
2969     int name_len;
2970     bool wild;
2971
2972     s = *sp;
2973     name = s;
2974     name_len = strcspn(s, "[");
2975     if (s[name_len] != '[') {
2976         return xasprintf("%s: missing [ looking for field name", *sp);
2977     }
2978
2979     field = mf_parse_subfield_name(name, name_len, &wild);
2980     if (!field) {
2981         return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2982     }
2983
2984     s += name_len;
2985     if (ovs_scan(s, "[%d..%d]", &start, &end)) {
2986         /* Nothing to do. */
2987     } else if (ovs_scan(s, "[%d]", &start)) {
2988         end = start;
2989     } else if (!strncmp(s, "[]", 2)) {
2990         start = 0;
2991         end = field->n_bits - 1;
2992     } else {
2993         return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2994                          "[<start>..<end>]", *sp);
2995     }
2996     s = strchr(s, ']') + 1;
2997
2998     if (start > end) {
2999         return xasprintf("%s: starting bit %d is after ending bit %d",
3000                          *sp, start, end);
3001     } else if (start >= field->n_bits) {
3002         return xasprintf("%s: starting bit %d is not valid because field is "
3003                          "only %d bits wide", *sp, start, field->n_bits);
3004     } else if (end >= field->n_bits){
3005         return xasprintf("%s: ending bit %d is not valid because field is "
3006                          "only %d bits wide", *sp, end, field->n_bits);
3007     }
3008
3009     sf->field = field;
3010     sf->ofs = start;
3011     sf->n_bits = end - start + 1;
3012
3013     *sp = s;
3014     return NULL;
3015 }
3016
3017 /* Parses a subfield from the entirety of 's' into 'sf'.  Returns NULL if
3018  * successful, otherwise a malloc()'d string describing the error.  The caller
3019  * is responsible for freeing the returned string.
3020  *
3021  * The syntax parsed from 's' takes the form "header[start..end]" where
3022  * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3023  * bit indexes.  "..end" may be omitted to indicate a single bit.  "start..end"
3024  * may both be omitted (the [] are still required) to indicate an entire
3025  * field.  */
3026 char * WARN_UNUSED_RESULT
3027 mf_parse_subfield(struct mf_subfield *sf, const char *s)
3028 {
3029     char *error = mf_parse_subfield__(sf, &s);
3030     if (!error && s[0]) {
3031         error = xstrdup("unexpected input following field syntax");
3032     }
3033     return error;
3034 }
3035
3036 void
3037 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
3038 {
3039     int i;
3040
3041     for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
3042         if (subvalue->u8[i]) {
3043             ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
3044             for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
3045                 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
3046             }
3047             return;
3048         }
3049     }
3050     ds_put_char(s, '0');
3051 }