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 static bool
 961 is_icmpv4(const struct flow *flow)
 962 {
 963     return (flow->dl_type == htons(ETH_TYPE_IP)
 964             && flow->nw_proto == IPPROTO_ICMP);
 965 }
 966
 967 static bool
 968 is_icmpv6(const struct flow *flow)
 969 {
 970     return (flow->dl_type == htons(ETH_TYPE_IPV6)
 971             && flow->nw_proto == IPPROTO_ICMPV6);
 972 }
 973
 974 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
 975 bool
 976 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
 977 {
 978     switch (mf->prereqs) {
 979     case MFP_NONE:
 980         return true;
 981
 982     case MFP_ARP:
 983       return (flow->dl_type == htons(ETH_TYPE_ARP) ||
 984               flow->dl_type == htons(ETH_TYPE_RARP));
 985     case MFP_IPV4:
 986         return flow->dl_type == htons(ETH_TYPE_IP);
 987     case MFP_IPV6:
 988         return flow->dl_type == htons(ETH_TYPE_IPV6);
 989     case MFP_VLAN_VID:
 990         return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
 991     case MFP_MPLS:
 992         return eth_type_mpls(flow->dl_type);
 993     case MFP_IP_ANY:
 994         return is_ip_any(flow);
 995
 996     case MFP_TCP:
 997         return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
 998     case MFP_UDP:
 999         return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1000     case MFP_SCTP:
1001         return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1002     case MFP_ICMPV4:
1003         return is_icmpv4(flow);
1004     case MFP_ICMPV6:
1005         return is_icmpv6(flow);
1006
1007     case MFP_ND:
1008         return (is_icmpv6(flow)
1009                 && flow->tp_dst == htons(0)
1010                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1011                     flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1012     case MFP_ND_SOLICIT:
1013         return (is_icmpv6(flow)
1014                 && flow->tp_dst == htons(0)
1015                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1016     case MFP_ND_ADVERT:
1017         return (is_icmpv6(flow)
1018                 && flow->tp_dst == htons(0)
1019                 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1020     }
1021
1022     NOT_REACHED();
1023 }
1024
1025 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1026  * false otherwise.
1027  *
1028  * A value is not rejected just because it is not valid for the field in
1029  * question, but only if it doesn't make sense to test the bits in question at
1030  * all.  For example, the MFF_VLAN_TCI field will never have a nonzero value
1031  * without the VLAN_CFI bit being set, but we can't reject those values because
1032  * it is still legitimate to test just for those bits (see the documentation
1033  * for NXM_OF_VLAN_TCI in nicira-ext.h).  On the other hand, there is never a
1034  * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1035 bool
1036 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1037 {
1038     switch (mf->id) {
1039     case MFF_TUN_ID:
1040     case MFF_TUN_SRC:
1041     case MFF_TUN_DST:
1042     case MFF_TUN_TOS:
1043     case MFF_TUN_TTL:
1044     case MFF_TUN_FLAGS:
1045     case MFF_METADATA:
1046     case MFF_IN_PORT:
1047     case MFF_SKB_PRIORITY:
1048     case MFF_PKT_MARK:
1049     CASE_MFF_REGS:
1050     case MFF_ETH_SRC:
1051     case MFF_ETH_DST:
1052     case MFF_ETH_TYPE:
1053     case MFF_VLAN_TCI:
1054     case MFF_IPV4_SRC:
1055     case MFF_IPV4_DST:
1056     case MFF_IPV6_SRC:
1057     case MFF_IPV6_DST:
1058     case MFF_IP_PROTO:
1059     case MFF_IP_TTL:
1060     case MFF_ARP_SPA:
1061     case MFF_ARP_TPA:
1062     case MFF_ARP_SHA:
1063     case MFF_ARP_THA:
1064     case MFF_TCP_SRC:
1065     case MFF_TCP_DST:
1066     case MFF_UDP_SRC:
1067     case MFF_UDP_DST:
1068     case MFF_SCTP_SRC:
1069     case MFF_SCTP_DST:
1070     case MFF_ICMPV4_TYPE:
1071     case MFF_ICMPV4_CODE:
1072     case MFF_ICMPV6_TYPE:
1073     case MFF_ICMPV6_CODE:
1074     case MFF_ND_TARGET:
1075     case MFF_ND_SLL:
1076     case MFF_ND_TLL:
1077         return true;
1078
1079     case MFF_IN_PORT_OXM: {
1080         ofp_port_t port;
1081         return !ofputil_port_from_ofp11(value->be32, &port);
1082     }
1083
1084     case MFF_IP_DSCP:
1085         return !(value->u8 & ~IP_DSCP_MASK);
1086     case MFF_IP_DSCP_SHIFTED:
1087         return !(value->u8 & (~IP_DSCP_MASK >> 2));
1088     case MFF_IP_ECN:
1089         return !(value->u8 & ~IP_ECN_MASK);
1090     case MFF_IP_FRAG:
1091         return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1092
1093     case MFF_ARP_OP:
1094         return !(value->be16 & htons(0xff00));
1095
1096     case MFF_DL_VLAN:
1097         return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1098     case MFF_VLAN_VID:
1099         return !(value->be16 & htons(VLAN_PCP_MASK));
1100
1101     case MFF_DL_VLAN_PCP:
1102     case MFF_VLAN_PCP:
1103         return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1104
1105     case MFF_IPV6_LABEL:
1106         return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1107
1108     case MFF_MPLS_LABEL:
1109         return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1110
1111     case MFF_MPLS_TC:
1112         return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1113
1114     case MFF_MPLS_BOS:
1115         return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1116
1117     case MFF_N_IDS:
1118     default:
1119         NOT_REACHED();
1120     }
1121 }
1122
1123 /* Copies the value of field 'mf' from 'flow' into 'value'.  The caller is
1124  * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1125 void
1126 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1127              union mf_value *value)
1128 {
1129     switch (mf->id) {
1130     case MFF_TUN_ID:
1131         value->be64 = flow->tunnel.tun_id;
1132         break;
1133     case MFF_TUN_SRC:
1134         value->be32 = flow->tunnel.ip_src;
1135         break;
1136     case MFF_TUN_DST:
1137         value->be32 = flow->tunnel.ip_dst;
1138         break;
1139     case MFF_TUN_FLAGS:
1140         value->be16 = htons(flow->tunnel.flags);
1141         break;
1142     case MFF_TUN_TTL:
1143         value->u8 = flow->tunnel.ip_ttl;
1144         break;
1145     case MFF_TUN_TOS:
1146         value->u8 = flow->tunnel.ip_tos;
1147         break;
1148
1149     case MFF_METADATA:
1150         value->be64 = flow->metadata;
1151         break;
1152
1153     case MFF_IN_PORT:
1154         value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1155         break;
1156     case MFF_IN_PORT_OXM:
1157         value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1158         break;
1159
1160     case MFF_SKB_PRIORITY:
1161         value->be32 = htonl(flow->skb_priority);
1162         break;
1163
1164     case MFF_PKT_MARK:
1165         value->be32 = htonl(flow->pkt_mark);
1166         break;
1167
1168     CASE_MFF_REGS:
1169         value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1170         break;
1171
1172     case MFF_ETH_SRC:
1173         memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1174         break;
1175
1176     case MFF_ETH_DST:
1177         memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1178         break;
1179
1180     case MFF_ETH_TYPE:
1181         value->be16 = flow->dl_type;
1182         break;
1183
1184     case MFF_VLAN_TCI:
1185         value->be16 = flow->vlan_tci;
1186         break;
1187
1188     case MFF_DL_VLAN:
1189         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1190         break;
1191     case MFF_VLAN_VID:
1192         value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1193         break;
1194
1195     case MFF_DL_VLAN_PCP:
1196     case MFF_VLAN_PCP:
1197         value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1198         break;
1199
1200     case MFF_MPLS_LABEL:
1201         value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse));
1202         break;
1203
1204     case MFF_MPLS_TC:
1205         value->u8 = mpls_lse_to_tc(flow->mpls_lse);
1206         break;
1207
1208     case MFF_MPLS_BOS:
1209         value->u8 = mpls_lse_to_bos(flow->mpls_lse);
1210         break;
1211
1212     case MFF_IPV4_SRC:
1213         value->be32 = flow->nw_src;
1214         break;
1215
1216     case MFF_IPV4_DST:
1217         value->be32 = flow->nw_dst;
1218         break;
1219
1220     case MFF_IPV6_SRC:
1221         value->ipv6 = flow->ipv6_src;
1222         break;
1223
1224     case MFF_IPV6_DST:
1225         value->ipv6 = flow->ipv6_dst;
1226         break;
1227
1228     case MFF_IPV6_LABEL:
1229         value->be32 = flow->ipv6_label;
1230         break;
1231
1232     case MFF_IP_PROTO:
1233         value->u8 = flow->nw_proto;
1234         break;
1235
1236     case MFF_IP_DSCP:
1237         value->u8 = flow->nw_tos & IP_DSCP_MASK;
1238         break;
1239
1240     case MFF_IP_DSCP_SHIFTED:
1241         value->u8 = flow->nw_tos >> 2;
1242         break;
1243
1244     case MFF_IP_ECN:
1245         value->u8 = flow->nw_tos & IP_ECN_MASK;
1246         break;
1247
1248     case MFF_IP_TTL:
1249         value->u8 = flow->nw_ttl;
1250         break;
1251
1252     case MFF_IP_FRAG:
1253         value->u8 = flow->nw_frag;
1254         break;
1255
1256     case MFF_ARP_OP:
1257         value->be16 = htons(flow->nw_proto);
1258         break;
1259
1260     case MFF_ARP_SPA:
1261         value->be32 = flow->nw_src;
1262         break;
1263
1264     case MFF_ARP_TPA:
1265         value->be32 = flow->nw_dst;
1266         break;
1267
1268     case MFF_ARP_SHA:
1269     case MFF_ND_SLL:
1270         memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1271         break;
1272
1273     case MFF_ARP_THA:
1274     case MFF_ND_TLL:
1275         memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1276         break;
1277
1278     case MFF_TCP_SRC:
1279     case MFF_UDP_SRC:
1280     case MFF_SCTP_SRC:
1281         value->be16 = flow->tp_src;
1282         break;
1283
1284     case MFF_TCP_DST:
1285     case MFF_UDP_DST:
1286     case MFF_SCTP_DST:
1287         value->be16 = flow->tp_dst;
1288         break;
1289
1290     case MFF_ICMPV4_TYPE:
1291     case MFF_ICMPV6_TYPE:
1292         value->u8 = ntohs(flow->tp_src);
1293         break;
1294
1295     case MFF_ICMPV4_CODE:
1296     case MFF_ICMPV6_CODE:
1297         value->u8 = ntohs(flow->tp_dst);
1298         break;
1299
1300     case MFF_ND_TARGET:
1301         value->ipv6 = flow->nd_target;
1302         break;
1303
1304     case MFF_N_IDS:
1305     default:
1306         NOT_REACHED();
1307     }
1308 }
1309
1310 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1311  * 'value'.  The caller is responsible for ensuring that 'match' meets 'mf''s
1312  * prerequisites. */
1313 void
1314 mf_set_value(const struct mf_field *mf,
1315              const union mf_value *value, struct match *match)
1316 {
1317     switch (mf->id) {
1318     case MFF_TUN_ID:
1319         match_set_tun_id(match, value->be64);
1320         break;
1321     case MFF_TUN_SRC:
1322         match_set_tun_src(match, value->be32);
1323         break;
1324     case MFF_TUN_DST:
1325         match_set_tun_dst(match, value->be32);
1326         break;
1327     case MFF_TUN_FLAGS:
1328         match_set_tun_flags(match, ntohs(value->be16));
1329         break;
1330     case MFF_TUN_TOS:
1331         match_set_tun_tos(match, value->u8);
1332         break;
1333     case MFF_TUN_TTL:
1334         match_set_tun_ttl(match, value->u8);
1335         break;
1336
1337     case MFF_METADATA:
1338         match_set_metadata(match, value->be64);
1339         break;
1340
1341     case MFF_IN_PORT:
1342         match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1343         break;
1344
1345     case MFF_IN_PORT_OXM: {
1346         ofp_port_t port;
1347         ofputil_port_from_ofp11(value->be32, &port);
1348         match_set_in_port(match, port);
1349         break;
1350     }
1351
1352     case MFF_SKB_PRIORITY:
1353         match_set_skb_priority(match, ntohl(value->be32));
1354         break;
1355
1356     case MFF_PKT_MARK:
1357         match_set_pkt_mark(match, ntohl(value->be32));
1358         break;
1359
1360     CASE_MFF_REGS:
1361         match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1362         break;
1363
1364     case MFF_ETH_SRC:
1365         match_set_dl_src(match, value->mac);
1366         break;
1367
1368     case MFF_ETH_DST:
1369         match_set_dl_dst(match, value->mac);
1370         break;
1371
1372     case MFF_ETH_TYPE:
1373         match_set_dl_type(match, value->be16);
1374         break;
1375
1376     case MFF_VLAN_TCI:
1377         match_set_dl_tci(match, value->be16);
1378         break;
1379
1380     case MFF_DL_VLAN:
1381         match_set_dl_vlan(match, value->be16);
1382         break;
1383     case MFF_VLAN_VID:
1384         match_set_vlan_vid(match, value->be16);
1385         break;
1386
1387     case MFF_DL_VLAN_PCP:
1388     case MFF_VLAN_PCP:
1389         match_set_dl_vlan_pcp(match, value->u8);
1390         break;
1391
1392     case MFF_MPLS_LABEL:
1393         match_set_mpls_label(match, value->be32);
1394         break;
1395
1396     case MFF_MPLS_TC:
1397         match_set_mpls_tc(match, value->u8);
1398         break;
1399
1400     case MFF_MPLS_BOS:
1401         match_set_mpls_bos(match, value->u8);
1402         break;
1403
1404     case MFF_IPV4_SRC:
1405         match_set_nw_src(match, value->be32);
1406         break;
1407
1408     case MFF_IPV4_DST:
1409         match_set_nw_dst(match, value->be32);
1410         break;
1411
1412     case MFF_IPV6_SRC:
1413         match_set_ipv6_src(match, &value->ipv6);
1414         break;
1415
1416     case MFF_IPV6_DST:
1417         match_set_ipv6_dst(match, &value->ipv6);
1418         break;
1419
1420     case MFF_IPV6_LABEL:
1421         match_set_ipv6_label(match, value->be32);
1422         break;
1423
1424     case MFF_IP_PROTO:
1425         match_set_nw_proto(match, value->u8);
1426         break;
1427
1428     case MFF_IP_DSCP:
1429         match_set_nw_dscp(match, value->u8);
1430         break;
1431
1432     case MFF_IP_DSCP_SHIFTED:
1433         match_set_nw_dscp(match, value->u8 << 2);
1434         break;
1435
1436     case MFF_IP_ECN:
1437         match_set_nw_ecn(match, value->u8);
1438         break;
1439
1440     case MFF_IP_TTL:
1441         match_set_nw_ttl(match, value->u8);
1442         break;
1443
1444     case MFF_IP_FRAG:
1445         match_set_nw_frag(match, value->u8);
1446         break;
1447
1448     case MFF_ARP_OP:
1449         match_set_nw_proto(match, ntohs(value->be16));
1450         break;
1451
1452     case MFF_ARP_SPA:
1453         match_set_nw_src(match, value->be32);
1454         break;
1455
1456     case MFF_ARP_TPA:
1457         match_set_nw_dst(match, value->be32);
1458         break;
1459
1460     case MFF_ARP_SHA:
1461     case MFF_ND_SLL:
1462         match_set_arp_sha(match, value->mac);
1463         break;
1464
1465     case MFF_ARP_THA:
1466     case MFF_ND_TLL:
1467         match_set_arp_tha(match, value->mac);
1468         break;
1469
1470     case MFF_TCP_SRC:
1471     case MFF_UDP_SRC:
1472     case MFF_SCTP_SRC:
1473         match_set_tp_src(match, value->be16);
1474         break;
1475
1476     case MFF_TCP_DST:
1477     case MFF_UDP_DST:
1478     case MFF_SCTP_DST:
1479         match_set_tp_dst(match, value->be16);
1480         break;
1481
1482     case MFF_ICMPV4_TYPE:
1483     case MFF_ICMPV6_TYPE:
1484         match_set_icmp_type(match, value->u8);
1485         break;
1486
1487     case MFF_ICMPV4_CODE:
1488     case MFF_ICMPV6_CODE:
1489         match_set_icmp_code(match, value->u8);
1490         break;
1491
1492     case MFF_ND_TARGET:
1493         match_set_nd_target(match, &value->ipv6);
1494         break;
1495
1496     case MFF_N_IDS:
1497     default:
1498         NOT_REACHED();
1499     }
1500 }
1501
1502 /* Sets 'flow' member field described by 'mf' to 'value'.  The caller is
1503  * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1504 void
1505 mf_set_flow_value(const struct mf_field *mf,
1506                   const union mf_value *value, struct flow *flow)
1507 {
1508     switch (mf->id) {
1509     case MFF_TUN_ID:
1510         flow->tunnel.tun_id = value->be64;
1511         break;
1512     case MFF_TUN_SRC:
1513         flow->tunnel.ip_src = value->be32;
1514         break;
1515     case MFF_TUN_DST:
1516         flow->tunnel.ip_dst = value->be32;
1517         break;
1518     case MFF_TUN_FLAGS:
1519         flow->tunnel.flags = ntohs(value->be16);
1520         break;
1521     case MFF_TUN_TOS:
1522         flow->tunnel.ip_tos = value->u8;
1523         break;
1524     case MFF_TUN_TTL:
1525         flow->tunnel.ip_ttl = value->u8;
1526         break;
1527
1528     case MFF_METADATA:
1529         flow->metadata = value->be64;
1530         break;
1531
1532     case MFF_IN_PORT:
1533         flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1534         break;
1535
1536     case MFF_IN_PORT_OXM: {
1537         ofp_port_t port;
1538         ofputil_port_from_ofp11(value->be32, &port);
1539         flow->in_port.ofp_port = port;
1540         break;
1541     }
1542
1543     case MFF_SKB_PRIORITY:
1544         flow->skb_priority = ntohl(value->be32);
1545         break;
1546
1547     case MFF_PKT_MARK:
1548         flow->pkt_mark = ntohl(value->be32);
1549         break;
1550
1551     CASE_MFF_REGS:
1552         flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1553         break;
1554
1555     case MFF_ETH_SRC:
1556         memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1557         break;
1558
1559     case MFF_ETH_DST:
1560         memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1561         break;
1562
1563     case MFF_ETH_TYPE:
1564         flow->dl_type = value->be16;
1565         break;
1566
1567     case MFF_VLAN_TCI:
1568         flow->vlan_tci = value->be16;
1569         break;
1570
1571     case MFF_DL_VLAN:
1572         flow_set_dl_vlan(flow, value->be16);
1573         break;
1574     case MFF_VLAN_VID:
1575         flow_set_vlan_vid(flow, value->be16);
1576         break;
1577
1578     case MFF_DL_VLAN_PCP:
1579     case MFF_VLAN_PCP:
1580         flow_set_vlan_pcp(flow, value->u8);
1581         break;
1582
1583     case MFF_MPLS_LABEL:
1584         flow_set_mpls_label(flow, value->be32);
1585         break;
1586
1587     case MFF_MPLS_TC:
1588         flow_set_mpls_tc(flow, value->u8);
1589         break;
1590
1591     case MFF_MPLS_BOS:
1592         flow_set_mpls_bos(flow, value->u8);
1593         break;
1594
1595     case MFF_IPV4_SRC:
1596         flow->nw_src = value->be32;
1597         break;
1598
1599     case MFF_IPV4_DST:
1600         flow->nw_dst = value->be32;
1601         break;
1602
1603     case MFF_IPV6_SRC:
1604         flow->ipv6_src = value->ipv6;
1605         break;
1606
1607     case MFF_IPV6_DST:
1608         flow->ipv6_dst = value->ipv6;
1609         break;
1610
1611     case MFF_IPV6_LABEL:
1612         flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1613         break;
1614
1615     case MFF_IP_PROTO:
1616         flow->nw_proto = value->u8;
1617         break;
1618
1619     case MFF_IP_DSCP:
1620         flow->nw_tos &= ~IP_DSCP_MASK;
1621         flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1622         break;
1623
1624     case MFF_IP_DSCP_SHIFTED:
1625         flow->nw_tos &= ~IP_DSCP_MASK;
1626         flow->nw_tos |= value->u8 << 2;
1627         break;
1628
1629     case MFF_IP_ECN:
1630         flow->nw_tos &= ~IP_ECN_MASK;
1631         flow->nw_tos |= value->u8 & IP_ECN_MASK;
1632         break;
1633
1634     case MFF_IP_TTL:
1635         flow->nw_ttl = value->u8;
1636         break;
1637
1638     case MFF_IP_FRAG:
1639         flow->nw_frag &= value->u8;
1640         break;
1641
1642     case MFF_ARP_OP:
1643         flow->nw_proto = ntohs(value->be16);
1644         break;
1645
1646     case MFF_ARP_SPA:
1647         flow->nw_src = value->be32;
1648         break;
1649
1650     case MFF_ARP_TPA:
1651         flow->nw_dst = value->be32;
1652         break;
1653
1654     case MFF_ARP_SHA:
1655     case MFF_ND_SLL:
1656         memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1657         break;
1658
1659     case MFF_ARP_THA:
1660     case MFF_ND_TLL:
1661         memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1662         break;
1663
1664     case MFF_TCP_SRC:
1665     case MFF_UDP_SRC:
1666     case MFF_SCTP_SRC:
1667         flow->tp_src = value->be16;
1668         break;
1669
1670     case MFF_TCP_DST:
1671     case MFF_UDP_DST:
1672     case MFF_SCTP_DST:
1673         flow->tp_dst = value->be16;
1674         break;
1675
1676     case MFF_ICMPV4_TYPE:
1677     case MFF_ICMPV6_TYPE:
1678         flow->tp_src = htons(value->u8);
1679         break;
1680
1681     case MFF_ICMPV4_CODE:
1682     case MFF_ICMPV6_CODE:
1683         flow->tp_dst = htons(value->u8);
1684         break;
1685
1686     case MFF_ND_TARGET:
1687         flow->nd_target = value->ipv6;
1688         break;
1689
1690     case MFF_N_IDS:
1691     default:
1692         NOT_REACHED();
1693     }
1694 }
1695
1696 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1697  *
1698  * The caller is responsible for ensuring that 'flow' meets 'mf''s
1699  * prerequisites. */
1700 bool
1701 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1702 {
1703     union mf_value value;
1704
1705     mf_get_value(mf, flow, &value);
1706     return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1707 }
1708
1709 /* Makes 'match' wildcard field 'mf'.
1710  *
1711  * The caller is responsible for ensuring that 'match' meets 'mf''s
1712  * prerequisites. */
1713 void
1714 mf_set_wild(const struct mf_field *mf, struct match *match)
1715 {
1716     switch (mf->id) {
1717     case MFF_TUN_ID:
1718         match_set_tun_id_masked(match, htonll(0), htonll(0));
1719         break;
1720     case MFF_TUN_SRC:
1721         match_set_tun_src_masked(match, htonl(0), htonl(0));
1722         break;
1723     case MFF_TUN_DST:
1724         match_set_tun_dst_masked(match, htonl(0), htonl(0));
1725         break;
1726     case MFF_TUN_FLAGS:
1727         match_set_tun_flags_masked(match, 0, 0);
1728         break;
1729     case MFF_TUN_TOS:
1730         match_set_tun_tos_masked(match, 0, 0);
1731         break;
1732     case MFF_TUN_TTL:
1733         match_set_tun_ttl_masked(match, 0, 0);
1734         break;
1735
1736     case MFF_METADATA:
1737         match_set_metadata_masked(match, htonll(0), htonll(0));
1738         break;
1739
1740     case MFF_IN_PORT:
1741     case MFF_IN_PORT_OXM:
1742         match->flow.in_port.ofp_port = 0;
1743         match->wc.masks.in_port.ofp_port = 0;
1744         break;
1745
1746     case MFF_SKB_PRIORITY:
1747         match->flow.skb_priority = 0;
1748         match->wc.masks.skb_priority = 0;
1749         break;
1750
1751     case MFF_PKT_MARK:
1752         match->flow.pkt_mark = 0;
1753         match->wc.masks.pkt_mark = 0;
1754         break;
1755
1756     CASE_MFF_REGS:
1757         match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1758         break;
1759
1760     case MFF_ETH_SRC:
1761         memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1762         memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1763         break;
1764
1765     case MFF_ETH_DST:
1766         memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1767         memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1768         break;
1769
1770     case MFF_ETH_TYPE:
1771         match->flow.dl_type = htons(0);
1772         match->wc.masks.dl_type = htons(0);
1773         break;
1774
1775     case MFF_VLAN_TCI:
1776         match_set_dl_tci_masked(match, htons(0), htons(0));
1777         break;
1778
1779     case MFF_DL_VLAN:
1780     case MFF_VLAN_VID:
1781         match_set_any_vid(match);
1782         break;
1783
1784     case MFF_DL_VLAN_PCP:
1785     case MFF_VLAN_PCP:
1786         match_set_any_pcp(match);
1787         break;
1788
1789     case MFF_MPLS_LABEL:
1790         match_set_any_mpls_label(match);
1791         break;
1792
1793     case MFF_MPLS_TC:
1794         match_set_any_mpls_tc(match);
1795         break;
1796
1797     case MFF_MPLS_BOS:
1798         match_set_any_mpls_bos(match);
1799         break;
1800
1801     case MFF_IPV4_SRC:
1802     case MFF_ARP_SPA:
1803         match_set_nw_src_masked(match, htonl(0), htonl(0));
1804         break;
1805
1806     case MFF_IPV4_DST:
1807     case MFF_ARP_TPA:
1808         match_set_nw_dst_masked(match, htonl(0), htonl(0));
1809         break;
1810
1811     case MFF_IPV6_SRC:
1812         memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1813         memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1814         break;
1815
1816     case MFF_IPV6_DST:
1817         memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1818         memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1819         break;
1820
1821     case MFF_IPV6_LABEL:
1822         match->wc.masks.ipv6_label = htonl(0);
1823         match->flow.ipv6_label = htonl(0);
1824         break;
1825
1826     case MFF_IP_PROTO:
1827         match->wc.masks.nw_proto = 0;
1828         match->flow.nw_proto = 0;
1829         break;
1830
1831     case MFF_IP_DSCP:
1832     case MFF_IP_DSCP_SHIFTED:
1833         match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1834         match->flow.nw_tos &= ~IP_DSCP_MASK;
1835         break;
1836
1837     case MFF_IP_ECN:
1838         match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1839         match->flow.nw_tos &= ~IP_ECN_MASK;
1840         break;
1841
1842     case MFF_IP_TTL:
1843         match->wc.masks.nw_ttl = 0;
1844         match->flow.nw_ttl = 0;
1845         break;
1846
1847     case MFF_IP_FRAG:
1848         match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1849         match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1850         break;
1851
1852     case MFF_ARP_OP:
1853         match->wc.masks.nw_proto = 0;
1854         match->flow.nw_proto = 0;
1855         break;
1856
1857     case MFF_ARP_SHA:
1858     case MFF_ND_SLL:
1859         memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1860         memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1861         break;
1862
1863     case MFF_ARP_THA:
1864     case MFF_ND_TLL:
1865         memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1866         memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1867         break;
1868
1869     case MFF_TCP_SRC:
1870     case MFF_UDP_SRC:
1871     case MFF_SCTP_SRC:
1872     case MFF_ICMPV4_TYPE:
1873     case MFF_ICMPV6_TYPE:
1874         match->wc.masks.tp_src = htons(0);
1875         match->flow.tp_src = htons(0);
1876         break;
1877
1878     case MFF_TCP_DST:
1879     case MFF_UDP_DST:
1880     case MFF_SCTP_DST:
1881     case MFF_ICMPV4_CODE:
1882     case MFF_ICMPV6_CODE:
1883         match->wc.masks.tp_dst = htons(0);
1884         match->flow.tp_dst = htons(0);
1885         break;
1886
1887     case MFF_ND_TARGET:
1888         memset(&match->wc.masks.nd_target, 0,
1889                sizeof match->wc.masks.nd_target);
1890         memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1891         break;
1892
1893     case MFF_N_IDS:
1894     default:
1895         NOT_REACHED();
1896     }
1897 }
1898
1899 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1900  * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1901  * with a 1-bit indicating that the corresponding value bit must match and a
1902  * 0-bit indicating a don't-care.
1903  *
1904  * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1905  * mf_set_value(mf, value, match).  If 'mask' points to all-0-bits, then this
1906  * call is equivalent to mf_set_wild(mf, match).
1907  *
1908  * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()).  The caller
1909  * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1910 enum ofputil_protocol
1911 mf_set(const struct mf_field *mf,
1912        const union mf_value *value, const union mf_value *mask,
1913        struct match *match)
1914 {
1915     if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1916         mf_set_value(mf, value, match);
1917         return mf->usable_protocols;
1918     } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1919         mf_set_wild(mf, match);
1920         return OFPUTIL_P_ANY;
1921     }
1922
1923     switch (mf->id) {
1924     case MFF_IN_PORT:
1925     case MFF_IN_PORT_OXM:
1926     case MFF_SKB_PRIORITY:
1927     case MFF_ETH_TYPE:
1928     case MFF_DL_VLAN:
1929     case MFF_DL_VLAN_PCP:
1930     case MFF_VLAN_PCP:
1931     case MFF_MPLS_LABEL:
1932     case MFF_MPLS_TC:
1933     case MFF_MPLS_BOS:
1934     case MFF_IP_PROTO:
1935     case MFF_IP_TTL:
1936     case MFF_IP_DSCP:
1937     case MFF_IP_DSCP_SHIFTED:
1938     case MFF_IP_ECN:
1939     case MFF_ARP_OP:
1940     case MFF_ICMPV4_TYPE:
1941     case MFF_ICMPV4_CODE:
1942     case MFF_ICMPV6_TYPE:
1943     case MFF_ICMPV6_CODE:
1944         NOT_REACHED();
1945
1946     case MFF_TUN_ID:
1947         match_set_tun_id_masked(match, value->be64, mask->be64);
1948         break;
1949     case MFF_TUN_SRC:
1950         match_set_tun_src_masked(match, value->be32, mask->be32);
1951         break;
1952     case MFF_TUN_DST:
1953         match_set_tun_dst_masked(match, value->be32, mask->be32);
1954         break;
1955     case MFF_TUN_FLAGS:
1956         match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1957         break;
1958     case MFF_TUN_TTL:
1959         match_set_tun_ttl_masked(match, value->u8, mask->u8);
1960         break;
1961     case MFF_TUN_TOS:
1962         match_set_tun_tos_masked(match, value->u8, mask->u8);
1963         break;
1964
1965     case MFF_METADATA:
1966         match_set_metadata_masked(match, value->be64, mask->be64);
1967         break;
1968
1969     CASE_MFF_REGS:
1970         match_set_reg_masked(match, mf->id - MFF_REG0,
1971                              ntohl(value->be32), ntohl(mask->be32));
1972         break;
1973
1974     case MFF_PKT_MARK:
1975         match_set_pkt_mark_masked(match, ntohl(value->be32),
1976                                   ntohl(mask->be32));
1977         break;
1978
1979     case MFF_ETH_DST:
1980         match_set_dl_dst_masked(match, value->mac, mask->mac);
1981         break;
1982
1983     case MFF_ETH_SRC:
1984         match_set_dl_src_masked(match, value->mac, mask->mac);
1985         break;
1986
1987     case MFF_ARP_SHA:
1988     case MFF_ND_SLL:
1989         match_set_arp_sha_masked(match, value->mac, mask->mac);
1990         break;
1991
1992     case MFF_ARP_THA:
1993     case MFF_ND_TLL:
1994         match_set_arp_tha_masked(match, value->mac, mask->mac);
1995         break;
1996
1997     case MFF_VLAN_TCI:
1998         match_set_dl_tci_masked(match, value->be16, mask->be16);
1999         break;
2000
2001     case MFF_VLAN_VID:
2002         match_set_vlan_vid_masked(match, value->be16, mask->be16);
2003         break;
2004
2005     case MFF_IPV4_SRC:
2006         match_set_nw_src_masked(match, value->be32, mask->be32);
2007         goto cidr_check;
2008
2009     case MFF_IPV4_DST:
2010         match_set_nw_dst_masked(match, value->be32, mask->be32);
2011         goto cidr_check;
2012
2013     case MFF_IPV6_SRC:
2014         match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2015         break;
2016
2017     case MFF_IPV6_DST:
2018         match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2019         break;
2020
2021     case MFF_IPV6_LABEL:
2022         if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2023             mf_set_value(mf, value, match);
2024         } else {
2025             match_set_ipv6_label_masked(match, value->be32, mask->be32);
2026         }
2027         break;
2028
2029     case MFF_ND_TARGET:
2030         match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2031         break;
2032
2033     case MFF_IP_FRAG:
2034         match_set_nw_frag_masked(match, value->u8, mask->u8);
2035         break;
2036
2037     case MFF_ARP_SPA:
2038         match_set_nw_src_masked(match, value->be32, mask->be32);
2039         goto cidr_check;
2040
2041     case MFF_ARP_TPA:
2042         match_set_nw_dst_masked(match, value->be32, mask->be32);
2043         goto cidr_check;
2044
2045     case MFF_TCP_SRC:
2046     case MFF_UDP_SRC:
2047     case MFF_SCTP_SRC:
2048         match_set_tp_src_masked(match, value->be16, mask->be16);
2049         break;
2050
2051     case MFF_TCP_DST:
2052     case MFF_UDP_DST:
2053     case MFF_SCTP_DST:
2054         match_set_tp_dst_masked(match, value->be16, mask->be16);
2055         break;
2056
2057     case MFF_N_IDS:
2058     default:
2059         NOT_REACHED();
2060     }
2061
2062     return mf->usable_protocols_bitwise;
2063
2064 cidr_check:
2065     return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2066             mf->usable_protocols_bitwise;
2067 }
2068
2069 static enum ofperr
2070 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2071            const char *type)
2072 {
2073     if (!sf->field) {
2074         VLOG_WARN_RL(&rl, "unknown %s field", type);
2075         return OFPERR_OFPBAC_BAD_SET_TYPE;
2076     } else if (!sf->n_bits) {
2077         VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2078         return OFPERR_OFPBAC_BAD_SET_LEN;
2079     } else if (sf->ofs >= sf->field->n_bits) {
2080         VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2081                      sf->ofs, sf->field->n_bits, type, sf->field->name);
2082         return OFPERR_OFPBAC_BAD_SET_LEN;
2083     } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2084         VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2085                      "of %s field %s", sf->ofs, sf->n_bits,
2086                      sf->field->n_bits, type, sf->field->name);
2087         return OFPERR_OFPBAC_BAD_SET_LEN;
2088     } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2089         VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2090                      type, sf->field->name);
2091         return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2092     } else {
2093         return 0;
2094     }
2095 }
2096
2097 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'.  Returns
2098  * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2099  * ofp_mkerr()).  */
2100 enum ofperr
2101 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2102 {
2103     return mf_check__(sf, flow, "source");
2104 }
2105
2106 /* Checks whether 'sf' is valid for writing a subfield into 'flow'.  Returns 0
2107  * if so, otherwise an OpenFlow error code (e.g. as returned by
2108  * ofp_mkerr()). */
2109 enum ofperr
2110 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2111 {
2112     int error = mf_check__(sf, flow, "destination");
2113     if (!error && !sf->field->writable) {
2114         VLOG_WARN_RL(&rl, "destination field %s is not writable",
2115                      sf->field->name);
2116         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2117     }
2118     return error;
2119 }
2120
2121 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2122  * 'value' and 'mask', respectively. */
2123 void
2124 mf_get(const struct mf_field *mf, const struct match *match,
2125        union mf_value *value, union mf_value *mask)
2126 {
2127     mf_get_value(mf, &match->flow, value);
2128     mf_get_mask(mf, &match->wc, mask);
2129 }
2130
2131 /* Assigns a random value for field 'mf' to 'value'. */
2132 void
2133 mf_random_value(const struct mf_field *mf, union mf_value *value)
2134 {
2135     random_bytes(value, mf->n_bytes);
2136
2137     switch (mf->id) {
2138     case MFF_TUN_ID:
2139     case MFF_TUN_SRC:
2140     case MFF_TUN_DST:
2141     case MFF_TUN_TOS:
2142     case MFF_TUN_TTL:
2143     case MFF_TUN_FLAGS:
2144     case MFF_METADATA:
2145     case MFF_IN_PORT:
2146     case MFF_PKT_MARK:
2147     case MFF_SKB_PRIORITY:
2148     CASE_MFF_REGS:
2149     case MFF_ETH_SRC:
2150     case MFF_ETH_DST:
2151     case MFF_ETH_TYPE:
2152     case MFF_VLAN_TCI:
2153     case MFF_IPV4_SRC:
2154     case MFF_IPV4_DST:
2155     case MFF_IPV6_SRC:
2156     case MFF_IPV6_DST:
2157     case MFF_IP_PROTO:
2158     case MFF_IP_TTL:
2159     case MFF_ARP_SPA:
2160     case MFF_ARP_TPA:
2161     case MFF_ARP_SHA:
2162     case MFF_ARP_THA:
2163     case MFF_TCP_SRC:
2164     case MFF_TCP_DST:
2165     case MFF_UDP_SRC:
2166     case MFF_UDP_DST:
2167     case MFF_SCTP_SRC:
2168     case MFF_SCTP_DST:
2169     case MFF_ICMPV4_TYPE:
2170     case MFF_ICMPV4_CODE:
2171     case MFF_ICMPV6_TYPE:
2172     case MFF_ICMPV6_CODE:
2173     case MFF_ND_TARGET:
2174     case MFF_ND_SLL:
2175     case MFF_ND_TLL:
2176         break;
2177
2178     case MFF_IN_PORT_OXM:
2179         value->be32 = ofputil_port_to_ofp11(u16_to_ofp(ntohs(value->be16)));
2180         break;
2181
2182     case MFF_IPV6_LABEL:
2183         value->be32 &= ~htonl(IPV6_LABEL_MASK);
2184         break;
2185
2186     case MFF_IP_DSCP:
2187         value->u8 &= IP_DSCP_MASK;
2188         break;
2189
2190     case MFF_IP_DSCP_SHIFTED:
2191         value->u8 &= IP_DSCP_MASK >> 2;
2192         break;
2193
2194     case MFF_IP_ECN:
2195         value->u8 &= IP_ECN_MASK;
2196         break;
2197
2198     case MFF_IP_FRAG:
2199         value->u8 &= FLOW_NW_FRAG_MASK;
2200         break;
2201
2202     case MFF_ARP_OP:
2203         value->be16 &= htons(0xff);
2204         break;
2205
2206     case MFF_DL_VLAN:
2207         value->be16 &= htons(VLAN_VID_MASK);
2208         break;
2209     case MFF_VLAN_VID:
2210         value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
2211         break;
2212
2213     case MFF_DL_VLAN_PCP:
2214     case MFF_VLAN_PCP:
2215         value->u8 &= 0x07;
2216         break;
2217
2218     case MFF_MPLS_LABEL:
2219         value->be32 &= htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT);
2220         break;
2221
2222     case MFF_MPLS_TC:
2223         value->u8 &= MPLS_TC_MASK >> MPLS_TC_SHIFT;
2224         break;
2225
2226     case MFF_MPLS_BOS:
2227         value->u8 &= MPLS_BOS_MASK >> MPLS_BOS_SHIFT;
2228         break;
2229
2230     case MFF_N_IDS:
2231     default:
2232         NOT_REACHED();
2233     }
2234 }
2235
2236 static char *
2237 mf_from_integer_string(const struct mf_field *mf, const char *s,
2238                        uint8_t *valuep, uint8_t *maskp)
2239 {
2240     unsigned long long int integer, mask;
2241     char *tail;
2242     int i;
2243
2244     errno = 0;
2245     integer = strtoull(s, &tail, 0);
2246     if (errno || (*tail != '\0' && *tail != '/')) {
2247         goto syntax_error;
2248     }
2249
2250     if (*tail == '/') {
2251         mask = strtoull(tail + 1, &tail, 0);
2252         if (errno || *tail != '\0') {
2253             goto syntax_error;
2254         }
2255     } else {
2256         mask = ULLONG_MAX;
2257     }
2258
2259     for (i = mf->n_bytes - 1; i >= 0; i--) {
2260         valuep[i] = integer;
2261         maskp[i] = mask;
2262         integer >>= 8;
2263         mask >>= 8;
2264     }
2265     if (integer) {
2266         return xasprintf("%s: value too large for %u-byte field %s",
2267                          s, mf->n_bytes, mf->name);
2268     }
2269     return NULL;
2270
2271 syntax_error:
2272     return xasprintf("%s: bad syntax for %s", s, mf->name);
2273 }
2274
2275 static char *
2276 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2277                         uint8_t mac[ETH_ADDR_LEN],
2278                         uint8_t mask[ETH_ADDR_LEN])
2279 {
2280     int n;
2281
2282     ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2283
2284     n = -1;
2285     if (sscanf(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n) > 0
2286         && n == strlen(s)) {
2287         memset(mask, 0xff, ETH_ADDR_LEN);
2288         return NULL;
2289     }
2290
2291     n = -1;
2292     if (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2293                ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n) > 0
2294         && n == strlen(s)) {
2295         return NULL;
2296     }
2297
2298     return xasprintf("%s: invalid Ethernet address", s);
2299 }
2300
2301 static char *
2302 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2303                     ovs_be32 *ip, ovs_be32 *mask)
2304 {
2305     int prefix;
2306
2307     ovs_assert(mf->n_bytes == sizeof *ip);
2308
2309     if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2310                IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2311         /* OK. */
2312     } else if (sscanf(s, IP_SCAN_FMT"/%d",
2313                       IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2314         if (prefix <= 0 || prefix > 32) {
2315             return xasprintf("%s: network prefix bits not between 1 and "
2316                              "32", s);
2317         } else if (prefix == 32) {
2318             *mask = htonl(UINT32_MAX);
2319         } else {
2320             *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2321         }
2322     } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2323         *mask = htonl(UINT32_MAX);
2324     } else {
2325         return xasprintf("%s: invalid IP address", s);
2326     }
2327     return NULL;
2328 }
2329
2330 static char *
2331 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2332                     struct in6_addr *value, struct in6_addr *mask)
2333 {
2334     char *str = xstrdup(s);
2335     char *save_ptr = NULL;
2336     const char *name, *netmask;
2337     int retval;
2338
2339     ovs_assert(mf->n_bytes == sizeof *value);
2340
2341     name = strtok_r(str, "/", &save_ptr);
2342     retval = name ? lookup_ipv6(name, value) : EINVAL;
2343     if (retval) {
2344         char *err;
2345
2346         err = xasprintf("%s: could not convert to IPv6 address", str);
2347         free(str);
2348
2349         return err;
2350     }
2351
2352     netmask = strtok_r(NULL, "/", &save_ptr);
2353     if (netmask) {
2354         if (inet_pton(AF_INET6, netmask, mask) != 1) {
2355             int prefix = atoi(netmask);
2356             if (prefix <= 0 || prefix > 128) {
2357                 free(str);
2358                 return xasprintf("%s: prefix bits not between 1 and 128", s);
2359             } else {
2360                 *mask = ipv6_create_mask(prefix);
2361             }
2362         }
2363     } else {
2364         *mask = in6addr_exact;
2365     }
2366     free(str);
2367
2368     return NULL;
2369 }
2370
2371 static char *
2372 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2373                         ovs_be16 *valuep, ovs_be16 *maskp)
2374 {
2375     ofp_port_t port;
2376
2377     ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2378
2379     if (ofputil_port_from_string(s, &port)) {
2380         *valuep = htons(ofp_to_u16(port));
2381         *maskp = htons(UINT16_MAX);
2382         return NULL;
2383     }
2384     return xasprintf("%s: port value out of range for %s", s, mf->name);
2385 }
2386
2387 static char *
2388 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2389                           ovs_be32 *valuep, ovs_be32 *maskp)
2390 {
2391     ofp_port_t port;
2392
2393     ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2394     if (ofputil_port_from_string(s, &port)) {
2395         *valuep = ofputil_port_to_ofp11(port);
2396         *maskp = htonl(UINT32_MAX);
2397         return NULL;
2398     }
2399     return xasprintf("%s: port value out of range for %s", s, mf->name);
2400 }
2401
2402 struct frag_handling {
2403     const char *name;
2404     uint8_t mask;
2405     uint8_t value;
2406 };
2407
2408 static const struct frag_handling all_frags[] = {
2409 #define A FLOW_NW_FRAG_ANY
2410 #define L FLOW_NW_FRAG_LATER
2411     /* name               mask  value */
2412
2413     { "no",               A|L,  0     },
2414     { "first",            A|L,  A     },
2415     { "later",            A|L,  A|L   },
2416
2417     { "no",               A,    0     },
2418     { "yes",              A,    A     },
2419
2420     { "not_later",        L,    0     },
2421     { "later",            L,    L     },
2422 #undef A
2423 #undef L
2424 };
2425
2426 static char *
2427 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2428 {
2429     const struct frag_handling *h;
2430
2431     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2432         if (!strcasecmp(s, h->name)) {
2433             /* We force the upper bits of the mask on to make mf_parse_value()
2434              * happy (otherwise it will never think it's an exact match.) */
2435             *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2436             *valuep = h->value;
2437             return NULL;
2438         }
2439     }
2440
2441     return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2442                      "\"yes\", \"first\", \"later\", \"not_first\"", s);
2443 }
2444
2445 static int
2446 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2447                      ovs_be16 *res)
2448 {
2449     uint32_t result = 0;
2450     char *save_ptr = NULL;
2451     char *name;
2452     int rc = 0;
2453     char *s = xstrdup(s_);
2454
2455     for (name = strtok_r((char *)s, " |", &save_ptr); name;
2456          name = strtok_r(NULL, " |", &save_ptr)) {
2457         int name_len;
2458         unsigned long long int flags;
2459         uint32_t bit;
2460         int n0;
2461
2462         if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2463             result |= flags;
2464             continue;
2465         }
2466         name_len = strlen(name);
2467         for (bit = 1; bit; bit <<= 1) {
2468             const char *fname = bit_to_string(bit);
2469             size_t len;
2470
2471             if (!fname) {
2472                 continue;
2473             }
2474
2475             len = strlen(fname);
2476             if (len != name_len) {
2477                 continue;
2478             }
2479             if (!strncmp(name, fname, len)) {
2480                 result |= bit;
2481                 break;
2482             }
2483         }
2484
2485         if (!bit) {
2486             rc = -ENOENT;
2487             goto out;
2488         }
2489     }
2490
2491     *res = htons(result);
2492 out:
2493     free(s);
2494     return rc;
2495 }
2496
2497 static char *
2498 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2499 {
2500     if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2501         *maskp = htons(UINT16_MAX);
2502         return NULL;
2503     }
2504
2505     return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2506                      "\"csum\", \"key\"", s);
2507 }
2508
2509 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'.  Returns
2510  * NULL if successful, otherwise a malloc()'d string describing the error. */
2511 char *
2512 mf_parse(const struct mf_field *mf, const char *s,
2513          union mf_value *value, union mf_value *mask)
2514 {
2515     if (!strcmp(s, "*")) {
2516         memset(value, 0, mf->n_bytes);
2517         memset(mask, 0, mf->n_bytes);
2518         return NULL;
2519     }
2520
2521     switch (mf->string) {
2522     case MFS_DECIMAL:
2523     case MFS_HEXADECIMAL:
2524         return mf_from_integer_string(mf, s,
2525                                       (uint8_t *) value, (uint8_t *) mask);
2526
2527     case MFS_ETHERNET:
2528         return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2529
2530     case MFS_IPV4:
2531         return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2532
2533     case MFS_IPV6:
2534         return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2535
2536     case MFS_OFP_PORT:
2537         return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2538
2539     case MFS_OFP_PORT_OXM:
2540         return mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2541
2542     case MFS_FRAG:
2543         return mf_from_frag_string(s, &value->u8, &mask->u8);
2544
2545     case MFS_TNL_FLAGS:
2546         ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2547         return mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2548     }
2549     NOT_REACHED();
2550 }
2551
2552 /* Parses 's', a string value for field 'mf', into 'value'.  Returns NULL if
2553  * successful, otherwise a malloc()'d string describing the error. */
2554 char *
2555 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2556 {
2557     union mf_value mask;
2558     char *error;
2559
2560     error = mf_parse(mf, s, value, &mask);
2561     if (error) {
2562         return error;
2563     }
2564
2565     if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2566         return xasprintf("%s: wildcards not allowed here", s);
2567     }
2568     return NULL;
2569 }
2570
2571 static void
2572 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2573                          const uint8_t *maskp, struct ds *s)
2574 {
2575     unsigned long long int integer;
2576     int i;
2577
2578     ovs_assert(mf->n_bytes <= 8);
2579
2580     integer = 0;
2581     for (i = 0; i < mf->n_bytes; i++) {
2582         integer = (integer << 8) | valuep[i];
2583     }
2584     if (mf->string == MFS_HEXADECIMAL) {
2585         ds_put_format(s, "%#llx", integer);
2586     } else {
2587         ds_put_format(s, "%lld", integer);
2588     }
2589
2590     if (maskp) {
2591         unsigned long long int mask;
2592
2593         mask = 0;
2594         for (i = 0; i < mf->n_bytes; i++) {
2595             mask = (mask << 8) | maskp[i];
2596         }
2597
2598         /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2599          * not sure that that a bit-mask written in decimal is ever easier to
2600          * understand than the same bit-mask written in hexadecimal. */
2601         ds_put_format(s, "/%#llx", mask);
2602     }
2603 }
2604
2605 static void
2606 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2607 {
2608     const struct frag_handling *h;
2609
2610     mask &= FLOW_NW_FRAG_MASK;
2611     value &= mask;
2612
2613     for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2614         if (value == h->value && mask == h->mask) {
2615             ds_put_cstr(s, h->name);
2616             return;
2617         }
2618     }
2619     ds_put_cstr(s, "<error>");
2620 }
2621
2622 static void
2623 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2624 {
2625     format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2626 }
2627
2628 /* Appends to 's' a string representation of field 'mf' whose value is in
2629  * 'value' and 'mask'.  'mask' may be NULL to indicate an exact match. */
2630 void
2631 mf_format(const struct mf_field *mf,
2632           const union mf_value *value, const union mf_value *mask,
2633           struct ds *s)
2634 {
2635     if (mask) {
2636         if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2637             ds_put_cstr(s, "ANY");
2638             return;
2639         } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2640             mask = NULL;
2641         }
2642     }
2643
2644     switch (mf->string) {
2645     case MFS_OFP_PORT_OXM:
2646         if (!mask) {
2647             ofp_port_t port;
2648             ofputil_port_from_ofp11(value->be32, &port);
2649             ofputil_format_port(port, s);
2650             break;
2651         }
2652         /* fall through */
2653     case MFS_OFP_PORT:
2654         if (!mask) {
2655             ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2656             break;
2657         }
2658         /* fall through */
2659     case MFS_DECIMAL:
2660     case MFS_HEXADECIMAL:
2661         mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2662         break;
2663
2664     case MFS_ETHERNET:
2665         eth_format_masked(value->mac, mask->mac, s);
2666         break;
2667
2668     case MFS_IPV4:
2669         ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2670                          s);
2671         break;
2672
2673     case MFS_IPV6:
2674         print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2675         break;
2676
2677     case MFS_FRAG:
2678         mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2679         break;
2680
2681     case MFS_TNL_FLAGS:
2682         mf_format_tnl_flags_string(&value->be16, s);
2683         break;
2684
2685     default:
2686         NOT_REACHED();
2687     }
2688 }
2689 \f
2690 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2691  * least-significant bits in 'x'.
2692  */
2693 void
2694 mf_write_subfield_flow(const struct mf_subfield *sf,
2695                        const union mf_subvalue *x, struct flow *flow)
2696 {
2697     const struct mf_field *field = sf->field;
2698     union mf_value value;
2699
2700     mf_get_value(field, flow, &value);
2701     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2702                  sf->ofs, sf->n_bits);
2703     mf_set_flow_value(field, &value, flow);
2704 }
2705
2706 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2707  * least-significant bits in 'x'.
2708  */
2709 void
2710 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2711                   struct match *match)
2712 {
2713     const struct mf_field *field = sf->field;
2714     union mf_value value, mask;
2715
2716     mf_get(field, match, &value, &mask);
2717     bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2718     bitwise_one (                 &mask,  field->n_bytes, sf->ofs, sf->n_bits);
2719     mf_set(field, &value, &mask, match);
2720 }
2721
2722 /* Initializes 'x' to the value of 'sf' within 'flow'.  'sf' must be valid for
2723  * reading 'flow', e.g. as checked by mf_check_src(). */
2724 void
2725 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2726                  union mf_subvalue *x)
2727 {
2728     union mf_value value;
2729
2730     mf_get_value(sf->field, flow, &value);
2731
2732     memset(x, 0, sizeof *x);
2733     bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2734                  x, sizeof *x, 0,
2735                  sf->n_bits);
2736 }
2737
2738 /* Returns the value of 'sf' within 'flow'.  'sf' must be valid for reading
2739  * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2740  * less. */
2741 uint64_t
2742 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2743 {
2744     union mf_value value;
2745
2746     mf_get_value(sf->field, flow, &value);
2747     return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2748 }
2749
2750 /* Formats 'sf' into 's' in a format normally acceptable to
2751  * mf_parse_subfield().  (It won't be acceptable if sf->field is NULL or if
2752  * sf->field has no NXM name.) */
2753 void
2754 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2755 {
2756     if (!sf->field) {
2757         ds_put_cstr(s, "<unknown>");
2758     } else if (sf->field->nxm_name) {
2759         ds_put_cstr(s, sf->field->nxm_name);
2760     } else if (sf->field->nxm_header) {
2761         uint32_t header = sf->field->nxm_header;
2762         ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2763     } else {
2764         ds_put_cstr(s, sf->field->name);
2765     }
2766
2767     if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2768         ds_put_cstr(s, "[]");
2769     } else if (sf->n_bits == 1) {
2770         ds_put_format(s, "[%d]", sf->ofs);
2771     } else {
2772         ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2773     }
2774 }
2775
2776 static const struct mf_field *
2777 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2778 {
2779     int i;
2780
2781     *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2782     if (*wild) {
2783         name_len -= 2;
2784     }
2785
2786     for (i = 0; i < MFF_N_IDS; i++) {
2787         const struct mf_field *mf = mf_from_id(i);
2788
2789         if (mf->nxm_name
2790             && !strncmp(mf->nxm_name, name, name_len)
2791             && mf->nxm_name[name_len] == '\0') {
2792             return mf;
2793         }
2794         if (mf->oxm_name
2795             && !strncmp(mf->oxm_name, name, name_len)
2796             && mf->oxm_name[name_len] == '\0') {
2797             return mf;
2798         }
2799     }
2800
2801     return NULL;
2802 }
2803
2804 /* Parses a subfield from the beginning of '*sp' into 'sf'.  If successful,
2805  * returns NULL and advances '*sp' to the first byte following the parsed
2806  * string.  On failure, returns a malloc()'d error message, does not modify
2807  * '*sp', and does not properly initialize 'sf'.
2808  *
2809  * The syntax parsed from '*sp' takes the form "header[start..end]" where
2810  * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2811  * bit indexes.  "..end" may be omitted to indicate a single bit.  "start..end"
2812  * may both be omitted (the [] are still required) to indicate an entire
2813  * field. */
2814 char * WARN_UNUSED_RESULT
2815 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2816 {
2817     const struct mf_field *field;
2818     const char *name;
2819     int start, end;
2820     const char *s;
2821     int name_len;
2822     bool wild;
2823
2824     s = *sp;
2825     name = s;
2826     name_len = strcspn(s, "[");
2827     if (s[name_len] != '[') {
2828         return xasprintf("%s: missing [ looking for field name", *sp);
2829     }
2830
2831     field = mf_parse_subfield_name(name, name_len, &wild);
2832     if (!field) {
2833         return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2834     }
2835
2836     s += name_len;
2837     if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2838         /* Nothing to do. */
2839     } else if (sscanf(s, "[%d]", &start) == 1) {
2840         end = start;
2841     } else if (!strncmp(s, "[]", 2)) {
2842         start = 0;
2843         end = field->n_bits - 1;
2844     } else {
2845         return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2846                          "[<start>..<end>]", *sp);
2847     }
2848     s = strchr(s, ']') + 1;
2849
2850     if (start > end) {
2851         return xasprintf("%s: starting bit %d is after ending bit %d",
2852                          *sp, start, end);
2853     } else if (start >= field->n_bits) {
2854         return xasprintf("%s: starting bit %d is not valid because field is "
2855                          "only %d bits wide", *sp, start, field->n_bits);
2856     } else if (end >= field->n_bits){
2857         return xasprintf("%s: ending bit %d is not valid because field is "
2858                          "only %d bits wide", *sp, end, field->n_bits);
2859     }
2860
2861     sf->field = field;
2862     sf->ofs = start;
2863     sf->n_bits = end - start + 1;
2864
2865     *sp = s;
2866     return NULL;
2867 }
2868
2869 /* Parses a subfield from the entirety of 's' into 'sf'.  Returns NULL if
2870  * successful, otherwise a malloc()'d string describing the error.  The caller
2871  * is responsible for freeing the returned string.
2872  *
2873  * The syntax parsed from 's' takes the form "header[start..end]" where
2874  * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2875  * bit indexes.  "..end" may be omitted to indicate a single bit.  "start..end"
2876  * may both be omitted (the [] are still required) to indicate an entire
2877  * field.  */
2878 char * WARN_UNUSED_RESULT
2879 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2880 {
2881     char *error = mf_parse_subfield__(sf, &s);
2882     if (!error && s[0]) {
2883         error = xstrdup("unexpected input following field syntax");
2884     }
2885     return error;
2886 }
2887
2888 void
2889 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2890 {
2891     int i;
2892
2893     for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2894         if (subvalue->u8[i]) {
2895             ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2896             for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2897                 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2898             }
2899             return;
2900         }
2901     }
2902     ds_put_char(s, '0');
2903 }