lib/meta-flow.c

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