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