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