lib/meta-flow.c

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