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