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