lib/meta-flow.c

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