lib/meta-flow.h

   1 /*
   2  * Copyright (c) 2011, 2012, 2013, 2014 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 #ifndef META_FLOW_H
  18 #define META_FLOW_H 1
  19
  20 #include <sys/types.h>
  21 #include <netinet/in.h>
  22 #include <netinet/ip6.h>
  23 #include "bitmap.h"
  24 #include "flow.h"
  25 #include "ofp-errors.h"
  26 #include "packets.h"
  27 #include "util.h"
  28
  29 struct ds;
  30 struct match;
  31
  32 /* Open vSwitch fields
  33  * ===================
  34  *
  35  * A "field" is a property of a packet.  Most familiarly, "data fields" are
  36  * fields that can be extracted from a packet.
  37  *
  38  * Some data fields are always present as a consequence of the basic networking
  39  * technology in use.  Ethernet is the assumed base technology for current
  40  * versions of OpenFlow and Open vSwitch, so Ethernet header fields are always
  41  * available.
  42  *
  43  * Other data fields are not always present.  A packet contains ARP fields, for
  44  * example, only when its Ethernet header indicates the Ethertype for ARP,
  45  * 0x0806.  We say that a field is "applicable" when it is it present in a
  46  * packet, and "inapplicable" when it is not, and refer to the conditions that
  47  * determine whether a field is applicable as "prerequisites".  Some
  48  * VLAN-related fields are a special case: these fields are always applicable,
  49  * but have a designated value or bit that indicates whether a VLAN header is
  50  * present, with the remaining values or bits indicating the VLAN header's
  51  * content (if it is present).  See MFF_VLAN_TCI for an example.
  52  *
  53  * Conceptually, an inapplicable field does not have a value, not even a
  54  * nominal ``value'' such as all-zero-bits.  In many circumstances, OpenFlow
  55  * and Open vSwitch allow references only to applicable fields.  For example,
  56  * one may match a given field only if the match includes the field's
  57  * prerequisite, e.g. matching an ARP field is only allowed if one also matches
  58  * on Ethertype 0x0806.
  59  *
  60  * (Practically, however, OVS represents a field's value as some fixed member
  61  * in its "struct flow", so accessing that member will obtain some value.  Some
  62  * members are used for more than one purpose, e.g. the "tp_src" member
  63  * represents the TCP, UDP, and SCTP source port, so the value read may not
  64  * even make sense.  For this reason, it is important to know whether a field's
  65  * prerequisites are satisfied before attempting to read it.)
  66  *
  67  * Sometimes a packet may contain multiple instances of a header.  For example,
  68  * a packet may contain multiple VLAN or MPLS headers, and tunnels can cause
  69  * any data field to recur.  OpenFlow and Open vSwitch do not address these
  70  * cases uniformly.  For VLAN and MPLS headers, only the outermost header is
  71  * accessible, so that inner headers may be accessed only by ``popping''
  72  * (removing) the outer header.  (Open vSwitch supports only a single VLAN
  73  * header in any case.)  For tunnels, e.g. GRE or VXLAN, the outer header and
  74  * inner headers are treated as different data fields.
  75  *
  76  * OpenFlow and Open vSwitch support some fields other than data fields.
  77  * "Metadata fields" relate to the origin or treatment of a packet, but they
  78  * are not extracted from the packet data itself.  One example is the physical
  79  * port on which a packet arrived at the switch.  "Register fields" act like
  80  * variables: they give an OpenFlow switch space for temporary storage while
  81  * processing a packet.  Existing metadata and register fields have no
  82  * prerequisites.
  83  *
  84  * A field's value consists of an integral number of bytes.  Most data fields
  85  * are copied directly from protocol headers, e.g. at layer 2, MFF_ETH_SRC is
  86  * copied from the Ethernet source address and MFF_ETH_DST from the destination
  87  * address.  Other data fields are copied from a packet with padding, usually
  88  * with zeros and in the most significant positions (see e.g. MFF_MPLS_LABEL)
  89  * but not always (see e.g. MFF_IP_DSCP).  A final category of data fields is
  90  * transformed in other ways as they are copied from the packets, to make them
  91  * more useful for matching, e.g. MFF_IP_FRAG describes whether a packet is a
  92  * fragment but it is not copied directly from the IP header.
  93  *
  94  *
  95  * Field specifications
  96  * ====================
  97  *
  98  * Each of the enumeration values below represents a field.  The comments
  99  * preceding each enum must be in a stylized form that is parsed at compile
 100  * time by the extract-ofp-fields program.  The comment itself consists of a
 101  * series of paragraphs separate by blank lines.  The paragraphs consist of:
 102  *
 103  *     - The first paragraph gives the user-visible name of the field as a
 104  *       quoted string.  This is the name used for parsing and formatting the
 105  *       field.
 106  *
 107  *       For historical reasons, some fields have an additional name that is
 108  *       accepted as an alternative in parsing.  This name, when there is one,
 109  *       is given as a quoted string in parentheses along with "aka".  For
 110  *       example:
 111  *
 112  *           "tun_id" (aka "tunnel_id").
 113  *
 114  *       New fields should have only one name.
 115  *
 116  *     - Any number of paragraphs of free text that describe the field.  This
 117  *       is meant for human readers, so extract-ofp-fields ignores it.
 118  *
 119  *     - A final paragraph that consists of a series of key-value pairs, one
 120  *       per line, in the form "key: value." where the period at the end of the
 121  *       line is a mandatory part of the syntax.
 122  *
 123  * Every field must specify the following key-value pairs:
 124  *
 125  *   Type:
 126  *
 127  *     The format and size of the field's value.  Some possible values are
 128  *     generic:
 129  *
 130  *         u8: A one-byte field.
 131  *         be16: A two-byte field.
 132  *         be32: A four-byte field.
 133  *         be64: An eight-byte field.
 134  *
 135  *     The remaining values imply more about the value's semantics, though OVS
 136  *     does not currently take advantage of this additional information:
 137  *
 138  *         MAC: A six-byte field whose value is an Ethernet address.
 139  *         IPv6: A 16-byte field whose value is an IPv6 address.
 140  *
 141  *   Maskable:
 142  *
 143  *     Either "bitwise", if OVS supports matching any subset of bits in the
 144  *     field, or "no", if OVS only supports matching or wildcarding the entire
 145  *     field.
 146  *
 147  *   Formatting:
 148  *
 149  *     Explains how a field's value is formatted and parsed for human
 150  *     consumption.  Some of the options are fairly generally useful:
 151  *
 152  *       decimal: Formats the value as a decimal number.  On parsing, accepts
 153  *         decimal (with no prefix), hexadecimal with 0x prefix, or octal
 154  *         with 0 prefix.
 155  *
 156  *       hexadecimal: Same as decimal except nonzero values are formatted in
 157  *         hex with 0x prefix.  The default for parsing is *not* hexadecimal:
 158  *         only with a 0x prefix is the input in hexadecimal.
 159  *
 160  *       Ethernet: Formats and accepts the common format xx:xx:xx:xx:xx:xx.
 161  *         6-byte fields only.
 162  *
 163  *       IPv4: Formats and accepts the common format w.x.y.z.  4-byte fields
 164  *         only.
 165  *
 166  *       IPv6: Formats and accepts the common IPv6 formats.  16-byte fields
 167  *         only.
 168  *
 169  *       OpenFlow 1.0 port: Accepts an OpenFlow well-known port name
 170  *         (e.g. "IN_PORT") in uppercase or lowercase, or a 16-bit port
 171  *         number in decimal.  Formats ports using their well-known names in
 172  *         uppercase, or in decimal otherwise.  2-byte fields only.
 173  *
 174  *       OpenFlow 1.1+ port: Same syntax as for OpenFlow 1.0 ports but for
 175  *         4-byte OpenFlow 1.1+ port number fields.
 176  *
 177  *     Others are very specific to particular fields:
 178  *
 179  *       frag: One of the strings "no", "first", "later", "yes", "not_later"
 180  *         describing which IPv4/v6 fragments are matched.
 181  *
 182  *       tunnel flags: Any number of the strings "df", "csum", "key", or
 183  *         "oam" separated by "|".
 184  *
 185  *       TCP flags: See the description of tcp_flags in ovs-ofctl(8).
 186  *
 187  *   Prerequisites:
 188  *
 189  *     The field's prerequisites.  The values should be straightfoward.
 190  *
 191  *   Access:
 192  *
 193  *     Either "read-only", for a field that cannot be changed via OpenFlow, or
 194  *     "read/write" for a modifiable field.
 195  *
 196  *   NXM:
 197  *
 198  *     If the field has an NXM field assignment, then this specifies the NXM
 199  *     name of the field (e.g. "NXM_OF_ETH_SRC"), followed by its nxm_type in
 200  *     parentheses, followed by "since v<x>.<y>" specifying the version of Open
 201  *     vSwitch that first supported this field in NXM (e.g. "since v1.1" if it
 202  *     was introduced in Open vSwitch 1.1).
 203  *
 204  *     The NXM name must begin with NXM_OF_ or NXM_NX_.  This allows OVS to
 205  *     determine the correct NXM class.
 206  *
 207  *     If the field does not have an NXM field assignment, specify "none".
 208  *
 209  *   OXM:
 210  *
 211  *     If the field has an OXM field assignment, then this specifies the OXM
 212  *     name of the field (e.g. "OXM_OF_ETH_SRC"), followed by its nxm_type in
 213  *     parentheses, followed by "since OF<a>.<b> v<x>.<y>" specifying the
 214  *     versions of OpenFlow and Open vSwitch that first supported this field in
 215  *     OXM (e.g. "since OF1.3 and v1.10" if it was introduced in OpenFlow 1.3
 216  *     and first supported by Open vSwitch in version 1.10).
 217  *
 218  *     Some fields have more than one OXM field assignment.  For example,
 219  *     actset_output has an experimenter OXM assignment in OpenFlow 1.3 and a
 220  *     standard OXM assignment in OpenFlow 1.5.  In such a case, specify both,
 221  *     separated by commas.
 222  *
 223  *     OVS uses the start of the OXM field name to determine the correct OXM
 224  *     class.  To support a new OXM class, edit the mapping table in
 225  *     build-aux/extract-ofp-fields.
 226  *
 227  *     If the field does not have an OXM field assignment, specify "none".
 228  *
 229  * The following key-value pairs are optional.  Open vSwitch already supports
 230  * all the fields to which they apply, so new fields should probably not
 231  * include these pairs:
 232  *
 233  *   OF1.0:
 234  *
 235  *     Specify this as "exact match" if OpenFlow 1.0 can match or wildcard the
 236  *     entire field, or as "CIDR mask" if OpenFlow 1.0 can match any CIDR
 237  *     prefix of the field.  (OpenFlow 1.0 did not support bitwise matching.)
 238  *     Omit, if OpenFlow 1.0 did not support this field.
 239  *
 240  *   OF1.1:
 241  *
 242  *     Specify this as "exact match" if OpenFlow 1.1 can match or wildcard the
 243  *     entire field, or as "bitwise" if OpenFlow 1.1 can match any subset of
 244  *     bits in the field.  Omit, if OpenFlow 1.1 did not support this field.
 245  *
 246  * The following key-value pair is optional:
 247  *
 248  *   Prefix lookup member:
 249  *
 250  *     If this field makes sense for use with classifier_set_prefix_fields(),
 251  *     specify the name of the "struct flow" member that corresponds to the
 252  *     field.
 253  *
 254  * Finally, a few "register" fields have very similar names and purposes,
 255  * e.g. MFF_REG0 through MFF_REG7.  For these, the comments may be merged
 256  * together using <N> as a metasyntactic variable for the numeric suffix.
 257  * Lines in the comment that are specific to one of the particular fields by
 258  * writing, e.g. <1>, to consider that line only for e.g. MFF_REG1.
 259  */
 260
 261 enum OVS_PACKED_ENUM mf_field_id {
 262 /* ## -------- ## */
 263 /* ## Metadata ## */
 264 /* ## -------- ## */
 265
 266     /* "dp_hash".
 267      *
 268      * Flow hash computed in the datapath.  Internal use only, not programmable
 269      * from controller.
 270      *
 271      * The OXM code point for this is an attempt to test OXM experimenter
 272      * support, which is otherwise difficult to test due to the dearth of use
 273      * out in the wild.  Because controllers can't add flows that match on
 274      * dp_hash, this doesn't commit OVS to supporting this OXM experimenter
 275      * code point in the future.
 276      *
 277      * Type: be32.
 278      * Maskable: bitwise.
 279      * Formatting: hexadecimal.
 280      * Prerequisites: none.
 281      * Access: read-only.
 282      * NXM: NXM_NX_DP_HASH(35) since v2.2.
 283      * OXM: NXOXM_ET_DP_HASH(0) since OF1.5 and v2.4.
 284      */
 285     MFF_DP_HASH,
 286
 287     /* "recirc_id".
 288      *
 289      * ID for recirculation.  The value 0 is reserved for initially received
 290      * packets.  Internal use only, not programmable from controller.
 291      *
 292      * Type: be32.
 293      * Maskable: no.
 294      * Formatting: decimal.
 295      * Prerequisites: none.
 296      * Access: read-only.
 297      * NXM: NXM_NX_RECIRC_ID(36) since v2.2.
 298      * OXM: none.
 299      */
 300     MFF_RECIRC_ID,
 301
 302     /* "tun_id" (aka "tunnel_id").
 303      *
 304      * The "key" or "tunnel ID" or "VNI" in a packet received via a keyed
 305      * tunnel.  For protocols in which the key is shorter than 64 bits, the key
 306      * is stored in the low bits and the high bits are zeroed.  For non-keyed
 307      * tunnels and packets not received via a tunnel, the value is 0.
 308      *
 309      * Type: be64.
 310      * Maskable: bitwise.
 311      * Formatting: hexadecimal.
 312      * Prerequisites: none.
 313      * Access: read/write.
 314      * NXM: NXM_NX_TUN_ID(16) since v1.1.
 315      * OXM: OXM_OF_TUNNEL_ID(38) since OF1.3 and v1.10.
 316      * Prefix lookup member: tunnel.tun_id.
 317      */
 318     MFF_TUN_ID,
 319
 320     /* "tun_src".
 321      *
 322      * The IPv4 source address in the outer IP header of a tunneled packet.
 323      *
 324      * For non-tunneled packets, the value is 0.
 325      *
 326      * Type: be32.
 327      * Maskable: bitwise.
 328      * Formatting: IPv4.
 329      * Prerequisites: none.
 330      * Access: read/write.
 331      * NXM: NXM_NX_TUN_IPV4_SRC(31) since v2.0.
 332      * OXM: none.
 333      * Prefix lookup member: tunnel.ip_src.
 334      */
 335     MFF_TUN_SRC,
 336
 337     /* "tun_dst".
 338      *
 339      * The IPv4 destination address in the outer IP header of a tunneled
 340      * packet.
 341      *
 342      * For non-tunneled packets, the value is 0.
 343      *
 344      * Type: be32.
 345      * Maskable: bitwise.
 346      * Formatting: IPv4.
 347      * Prerequisites: none.
 348      * Access: read/write.
 349      * NXM: NXM_NX_TUN_IPV4_DST(32) since v2.0.
 350      * OXM: none.
 351      * Prefix lookup member: tunnel.ip_dst.
 352      */
 353     MFF_TUN_DST,
 354
 355     /* "tun_flags".
 356      *
 357      * Combination of FLOW_TNL_F_* bitmapped flags that indicate properties of
 358      * a tunneled packet.  Internal use only, not programmable from controller.
 359      *
 360      * For non-tunneled packets, the value is 0.
 361      *
 362      * Type: be16.
 363      * Maskable: no.
 364      * Formatting: tunnel flags.
 365      * Prerequisites: none.
 366      * Access: read-only.
 367      * NXM: none.
 368      * OXM: none.
 369      */
 370     MFF_TUN_FLAGS,
 371
 372     /* "tun_ttl".
 373      *
 374      * The TTL in the outer IP header of a tunneled packet.  Internal use only,
 375      * not programmable from controller.
 376      *
 377      * For non-tunneled packets, the value is 0.
 378      *
 379      * Type: u8.
 380      * Maskable: no.
 381      * Formatting: decimal.
 382      * Prerequisites: none.
 383      * Access: read-only.
 384      * NXM: none.
 385      * OXM: none.
 386      */
 387     MFF_TUN_TTL,
 388
 389     /* "tun_tos".
 390      *
 391      * The ToS value in the outer IP header of a tunneled packet.  Internal use
 392      * only, not programmable from controller.
 393      *
 394      * Type: u8.
 395      * Maskable: no.
 396      * Formatting: decimal.
 397      * Prerequisites: none.
 398      * Access: read-only.
 399      * NXM: none.
 400      * OXM: none.
 401      */
 402     MFF_TUN_TOS,
 403
 404     /* "metadata".
 405      *
 406      * A scratch pad value standardized in OpenFlow 1.1+.  Initially zero, at
 407      * the beginning of the pipeline.
 408      *
 409      * Type: be64.
 410      * Maskable: bitwise.
 411      * Formatting: hexadecimal.
 412      * Prerequisites: none.
 413      * Access: read/write.
 414      * NXM: none.
 415      * OXM: OXM_OF_METADATA(2) since OF1.2 and v1.8.
 416      * OF1.1: bitwise mask.
 417      */
 418     MFF_METADATA,
 419
 420     /* "in_port".
 421      *
 422      * 16-bit (OpenFlow 1.0) view of the physical or virtual port on which the
 423      * packet was received.
 424      *
 425      * Type: be16.
 426      * Maskable: no.
 427      * Formatting: OpenFlow 1.0 port.
 428      * Prerequisites: none.
 429      * Access: read/write.
 430      * NXM: NXM_OF_IN_PORT(0) since v1.1.
 431      * OXM: none.
 432      * OF1.0: exact match.
 433      * OF1.1: exact match.
 434      */
 435     MFF_IN_PORT,
 436
 437     /* "in_port_oxm".
 438      *
 439      * 32-bit (OpenFlow 1.1+) view of the physical or virtual port on which the
 440      * packet was received.
 441      *
 442      * Type: be32.
 443      * Maskable: no.
 444      * Formatting: OpenFlow 1.1+ port.
 445      * Prerequisites: none.
 446      * Access: read/write.
 447      * NXM: none.
 448      * OXM: OXM_OF_IN_PORT(0) since OF1.2 and v1.7.
 449      * OF1.1: exact match.
 450      */
 451     MFF_IN_PORT_OXM,
 452
 453     /* "skb_priority".
 454      *
 455      * Designates the queue to which output will be directed.  The value in
 456      * this field is not necessarily the OpenFlow queue number; with the Linux
 457      * kernel switch, it instead has a pair of subfields designating the
 458      * "major" and "minor" numbers of a Linux kernel qdisc handle.
 459      *
 460      * This field is "semi-internal" in that it can be set with the "set_queue"
 461      * action but not matched or read or written other ways.
 462      *
 463      * Type: be32.
 464      * Maskable: no.
 465      * Formatting: hexadecimal.
 466      * Prerequisites: none.
 467      * Access: read-only.
 468      * NXM: none.
 469      * OXM: none.
 470      */
 471     MFF_SKB_PRIORITY,
 472
 473     /* "pkt_mark".
 474      *
 475      * Packet metadata mark.  The mark may be passed into other system
 476      * components in order to facilitate interaction between subsystems.  On
 477      * Linux this corresponds to struct sk_buff's "skb_mark" member but the
 478      * exact implementation is platform-dependent.
 479      *
 480      * Type: be32.
 481      * Maskable: bitwise.
 482      * Formatting: hexadecimal.
 483      * Prerequisites: none.
 484      * Access: read/write.
 485      * NXM: NXM_NX_PKT_MARK(33) since v2.0.
 486      * OXM: none.
 487      */
 488     MFF_PKT_MARK,
 489
 490 #if FLOW_N_REGS == 8
 491     /* "reg<N>".
 492      *
 493      * Nicira extension scratch pad register with initial value 0.
 494      *
 495      * Type: be32.
 496      * Maskable: bitwise.
 497      * Formatting: hexadecimal.
 498      * Prerequisites: none.
 499      * Access: read/write.
 500      * NXM: NXM_NX_REG0(0) since v1.1.        <0>
 501      * NXM: NXM_NX_REG1(1) since v1.1.        <1>
 502      * NXM: NXM_NX_REG2(2) since v1.1.        <2>
 503      * NXM: NXM_NX_REG3(3) since v1.1.        <3>
 504      * NXM: NXM_NX_REG4(4) since v1.3.        <4>
 505      * NXM: NXM_NX_REG5(5) since v1.7.        <5>
 506      * NXM: NXM_NX_REG6(6) since v1.7.        <6>
 507      * NXM: NXM_NX_REG7(7) since v1.7.        <7>
 508      * OXM: none.
 509      */
 510     MFF_REG0,
 511     MFF_REG1,
 512     MFF_REG2,
 513     MFF_REG3,
 514     MFF_REG4,
 515     MFF_REG5,
 516     MFF_REG6,
 517     MFF_REG7,
 518 #else
 519 #error "Need to update MFF_REG* to match FLOW_N_REGS"
 520 #endif
 521
 522 #if FLOW_N_XREGS == 4
 523     /* "xreg<N>".
 524      *
 525      * OpenFlow 1.5 (draft) ``extended register".  Each extended register
 526      * overlays two of the Nicira extension 32-bit registers: xreg0 overlays
 527      * reg0 and reg1, with reg0 supplying the most-significant bits of xreg0
 528      * and reg1 the least-significant.  xreg1 similarly overlays reg2 and reg3,
 529      * and so on.
 530      *
 531      * Type: be64.
 532      * Maskable: bitwise.
 533      * Formatting: hexadecimal.
 534      * Prerequisites: none.
 535      * Access: read/write.
 536      * NXM: none.
 537      * OXM: OXM_OF_PKT_REG<N>(<N>) since OF1.5 and v2.4.
 538      */
 539     MFF_XREG0,
 540     MFF_XREG1,
 541     MFF_XREG2,
 542     MFF_XREG3,
 543 #else
 544 #error "Need to update MFF_REG* to match FLOW_N_XREGS"
 545 #endif
 546
 547 /* ## -------- ## */
 548 /* ## Ethernet ## */
 549 /* ## -------- ## */
 550
 551     /* "eth_src" (aka "dl_src").
 552      *
 553      * Source address in Ethernet header.
 554      *
 555      * This field was not maskable before Open vSwitch 1.8.
 556      *
 557      * Type: MAC.
 558      * Maskable: bitwise.
 559      * Formatting: Ethernet.
 560      * Prerequisites: none.
 561      * Access: read/write.
 562      * NXM: NXM_OF_ETH_SRC(2) since v1.1.
 563      * OXM: OXM_OF_ETH_SRC(4) since OF1.2 and v1.7.
 564      * OF1.0: exact match.
 565      * OF1.1: bitwise mask.
 566      */
 567     MFF_ETH_SRC,
 568
 569     /* "eth_dst" (aka "dl_dst").
 570      *
 571      * Destination address in Ethernet header.
 572      *
 573      * Before Open vSwitch 1.8, the allowed masks were restricted to
 574      * 00:00:00:00:00:00, fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00,
 575      * ff:ff:ff:ff:ff:ff.
 576      *
 577      * Type: MAC.
 578      * Maskable: bitwise.
 579      * Formatting: Ethernet.
 580      * Prerequisites: none.
 581      * Access: read/write.
 582      * NXM: NXM_OF_ETH_DST(1) since v1.1.
 583      * OXM: OXM_OF_ETH_DST(3) since OF1.2 and v1.7.
 584      * OF1.0: exact match.
 585      * OF1.1: bitwise mask.
 586      */
 587     MFF_ETH_DST,
 588
 589     /* "eth_type" (aka "dl_type").
 590      *
 591      * Packet's Ethernet type.
 592      *
 593      * For an Ethernet II packet this is taken from the Ethernet header.  For
 594      * an 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP
 595      * header.  A packet that has neither format has value 0x05ff
 596      * (OFP_DL_TYPE_NOT_ETH_TYPE).
 597      *
 598      * For a packet with an 802.1Q header, this is the type of the encapsulated
 599      * frame.
 600      *
 601      * Type: be16.
 602      * Maskable: no.
 603      * Formatting: hexadecimal.
 604      * Prerequisites: none.
 605      * Access: read-only.
 606      * NXM: NXM_OF_ETH_TYPE(3) since v1.1.
 607      * OXM: OXM_OF_ETH_TYPE(5) since OF1.2 and v1.7.
 608      * OF1.0: exact match.
 609      * OF1.1: exact match.
 610      */
 611     MFF_ETH_TYPE,
 612
 613 /* ## ---- ## */
 614 /* ## VLAN ## */
 615 /* ## ---- ## */
 616
 617 /* It looks odd for vlan_tci, vlan_vid, and vlan_pcp to say that they are
 618  * supported in OF1.0 and OF1.1, since the detailed semantics of these fields
 619  * only apply to NXM or OXM.  They are marked as supported for exact matches in
 620  * OF1.0 and OF1.1 because exact matches on those fields can be successfully
 621  * translated into the OF1.0 and OF1.1 flow formats. */
 622
 623     /* "vlan_tci".
 624      *
 625      * 802.1Q TCI.
 626      *
 627      * For a packet with an 802.1Q header, this is the Tag Control Information
 628      * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
 629      * header, this has value 0.
 630      *
 631      * This field can be used in various ways:
 632      *
 633      *   - If it is not constrained at all, the nx_match matches packets
 634      *     without an 802.1Q header or with an 802.1Q header that has any TCI
 635      *     value.
 636      *
 637      *   - Testing for an exact match with 0 matches only packets without an
 638      *     802.1Q header.
 639      *
 640      *   - Testing for an exact match with a TCI value with CFI=1 matches
 641      *     packets that have an 802.1Q header with a specified VID and PCP.
 642      *
 643      *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
 644      *     not make sense.  The switch may reject this combination.
 645      *
 646      *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
 647      *     packets that have an 802.1Q header with that VID (and any PCP).
 648      *
 649      *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
 650      *     packets that have an 802.1Q header with that PCP (and any VID).
 651      *
 652      *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no
 653      *     802.1Q header or with an 802.1Q header with a VID of 0.
 654      *
 655      *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no
 656      *     802.1Q header or with an 802.1Q header with a PCP of 0.
 657      *
 658      *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no
 659      *     802.1Q header or with an 802.1Q header with both VID and PCP of 0.
 660      *
 661      * Type: be16.
 662      * Maskable: bitwise.
 663      * Formatting: hexadecimal.
 664      * Prerequisites: none.
 665      * Access: read/write.
 666      * NXM: NXM_OF_VLAN_TCI(4) since v1.1.
 667      * OXM: none.
 668      * OF1.0: exact match.
 669      * OF1.1: exact match.
 670      */
 671     MFF_VLAN_TCI,
 672
 673     /* "dl_vlan" (OpenFlow 1.0).
 674      *
 675      * VLAN ID field.  Zero if no 802.1Q header is present.
 676      *
 677      * Type: be16 (low 12 bits).
 678      * Maskable: no.
 679      * Formatting: decimal.
 680      * Prerequisites: none.
 681      * Access: read/write.
 682      * NXM: none.
 683      * OXM: none.
 684      * OF1.0: exact match.
 685      * OF1.1: exact match.
 686      */
 687     MFF_DL_VLAN,
 688
 689     /* "vlan_vid" (OpenFlow 1.2+).
 690      *
 691      * If an 802.1Q header is present, this field's value is 0x1000
 692      * bitwise-or'd with the VLAN ID.  If no 802.1Q is present, this field's
 693      * value is 0.
 694      *
 695      * Type: be16 (low 12 bits).
 696      * Maskable: bitwise.
 697      * Formatting: decimal.
 698      * Prerequisites: none.
 699      * Access: read/write.
 700      * NXM: none.
 701      * OXM: OXM_OF_VLAN_VID(6) since OF1.2 and v1.7.
 702      * OF1.0: exact match.
 703      * OF1.1: exact match.
 704      */
 705     MFF_VLAN_VID,
 706
 707     /* "dl_vlan_pcp" (OpenFlow 1.0).
 708      *
 709      * VLAN priority (PCP) field.  Zero if no 802.1Q header is present.
 710      *
 711      * Type: u8 (low 3 bits).
 712      * Maskable: no.
 713      * Formatting: decimal.
 714      * Prerequisites: none.
 715      * Access: read/write.
 716      * NXM: none.
 717      * OXM: none.
 718      * OF1.0: exact match.
 719      * OF1.1: exact match.
 720      */
 721     MFF_DL_VLAN_PCP,
 722
 723     /* "vlan_pcp" (OpenFlow 1.2+).
 724      *
 725      * VLAN priority (PCP) field.  Zero if no 802.1Q header is present.
 726      *
 727      * Type: u8 (low 3 bits).
 728      * Maskable: no.
 729      * Formatting: decimal.
 730      * Prerequisites: VLAN VID.
 731      * Access: read/write.
 732      * NXM: none.
 733      * OXM: OXM_OF_VLAN_PCP(7) since OF1.2 and v1.7.
 734      * OF1.0: exact match.
 735      * OF1.1: exact match.
 736      */
 737     MFF_VLAN_PCP,
 738
 739 /* ## ---- ## */
 740 /* ## MPLS ## */
 741 /* ## ---- ## */
 742
 743     /* "mpls_label".
 744      *
 745      * The outermost MPLS label, or 0 if no MPLS labels are present.
 746      *
 747      * Type: be32 (low 20 bits).
 748      * Maskable: no.
 749      * Formatting: decimal.
 750      * Prerequisites: MPLS.
 751      * Access: read/write.
 752      * NXM: none.
 753      * OXM: OXM_OF_MPLS_LABEL(34) since OF1.2 and v1.11.
 754      * OF1.1: exact match.
 755      */
 756     MFF_MPLS_LABEL,
 757
 758     /* "mpls_tc".
 759      *
 760      * The outermost MPLS label's traffic control (TC) field, or 0 if no MPLS
 761      * labels are present.
 762      *
 763      * Type: u8 (low 3 bits).
 764      * Maskable: no.
 765      * Formatting: decimal.
 766      * Prerequisites: MPLS.
 767      * Access: read/write.
 768      * NXM: none.
 769      * OXM: OXM_OF_MPLS_TC(35) since OF1.2 and v1.11.
 770      * OF1.1: exact match.
 771      */
 772     MFF_MPLS_TC,
 773
 774     /* "mpls_bos".
 775      *
 776      * The outermost MPLS label's bottom of stack (BoS) field, or 0 if no MPLS
 777      * labels are present.
 778      *
 779      * Type: u8 (low 1 bits).
 780      * Maskable: no.
 781      * Formatting: decimal.
 782      * Prerequisites: MPLS.
 783      * Access: read-only.
 784      * NXM: none.
 785      * OXM: OXM_OF_MPLS_BOS(36) since OF1.3 and v1.11.
 786      */
 787     MFF_MPLS_BOS,
 788
 789 /* ## ---- ## */
 790 /* ## IPv4 ## */
 791 /* ## ---- ## */
 792
 793 /* Update mf_is_l3_or_higher() if MFF_IPV4_SRC is no longer the first element
 794  * for a field of layer 3 or higher */
 795
 796     /* "ip_src" (aka "nw_src").
 797      *
 798      * The source address in the IPv4 header.
 799      *
 800      * Before Open vSwitch 1.8, only CIDR masks were supported.
 801      *
 802      * Type: be32.
 803      * Maskable: bitwise.
 804      * Formatting: IPv4.
 805      * Prerequisites: IPv4.
 806      * Access: read/write.
 807      * NXM: NXM_OF_IP_SRC(7) since v1.1.
 808      * OXM: OXM_OF_IPV4_SRC(11) since OF1.2 and v1.7.
 809      * OF1.0: CIDR mask.
 810      * OF1.1: bitwise mask.
 811      * Prefix lookup member: nw_src.
 812      */
 813     MFF_IPV4_SRC,
 814
 815     /* "ip_dst" (aka "nw_dst").
 816      *
 817      * The destination address in the IPv4 header.
 818      *
 819      * Before Open vSwitch 1.8, only CIDR masks were supported.
 820      *
 821      * Type: be32.
 822      * Maskable: bitwise.
 823      * Formatting: IPv4.
 824      * Prerequisites: IPv4.
 825      * Access: read/write.
 826      * NXM: NXM_OF_IP_DST(8) since v1.1.
 827      * OXM: OXM_OF_IPV4_DST(12) since OF1.2 and v1.7.
 828      * OF1.0: CIDR mask.
 829      * OF1.1: bitwise mask.
 830      * Prefix lookup member: nw_dst.
 831      */
 832     MFF_IPV4_DST,
 833
 834 /* ## ---- ## */
 835 /* ## IPv6 ## */
 836 /* ## ---- ## */
 837
 838     /* "ipv6_src".
 839      *
 840      * The source address in the IPv6 header.
 841      *
 842      * Type: IPv6.
 843      * Maskable: bitwise.
 844      * Formatting: IPv6.
 845      * Prerequisites: IPv6.
 846      * Access: read/write.
 847      * NXM: NXM_NX_IPV6_SRC(19) since v1.1.
 848      * OXM: OXM_OF_IPV6_SRC(26) since OF1.2 and v1.1.
 849      * Prefix lookup member: ipv6_src.
 850      */
 851     MFF_IPV6_SRC,
 852
 853     /* "ipv6_dst".
 854      *
 855      * The destination address in the IPv6 header.
 856      *
 857      * Type: IPv6.
 858      * Maskable: bitwise.
 859      * Formatting: IPv6.
 860      * Prerequisites: IPv6.
 861      * Access: read/write.
 862      * NXM: NXM_NX_IPV6_DST(20) since v1.1.
 863      * OXM: OXM_OF_IPV6_DST(27) since OF1.2 and v1.1.
 864      * Prefix lookup member: ipv6_dst.
 865      */
 866     MFF_IPV6_DST,
 867
 868     /* "ipv6_label".
 869      *
 870      * The flow label in the IPv6 header.
 871      *
 872      * Type: be32 (low 20 bits).
 873      * Maskable: bitwise.
 874      * Formatting: hexadecimal.
 875      * Prerequisites: IPv6.
 876      * Access: read-only.
 877      * NXM: NXM_NX_IPV6_LABEL(27) since v1.4.
 878      * OXM: OXM_OF_IPV6_FLABEL(28) since OF1.2 and v1.7.
 879      */
 880     MFF_IPV6_LABEL,
 881
 882 /* ## ----------------------- ## */
 883 /* ## IPv4/IPv6 common fields ## */
 884 /* ## ----------------------- ## */
 885
 886     /* "nw_proto" (aka "ip_proto").
 887      *
 888      * The "protocol" byte in the IPv4 or IPv6 header.
 889      *
 890      * Type: u8.
 891      * Maskable: no.
 892      * Formatting: decimal.
 893      * Prerequisites: IPv4/IPv6.
 894      * Access: read-only.
 895      * NXM: NXM_OF_IP_PROTO(6) since v1.1.
 896      * OXM: OXM_OF_IP_PROTO(10) since OF1.2 and v1.7.
 897      * OF1.0: exact match.
 898      * OF1.1: exact match.
 899      */
 900     MFF_IP_PROTO,
 901
 902 /* Both views of the DSCP below are marked as supported in all of the versions
 903  * of OpenFlow because a match on either view can be successfully translated
 904  * into every OpenFlow flow format. */
 905
 906     /* "nw_tos" (OpenFlow 1.0/1.1).
 907      *
 908      * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6
 909      * header, with the ECN bits forced to 0.  (That is, bits 2-7 contain the
 910      * type of service and bits 0-1 are zero.)
 911      *
 912      * Type: u8.
 913      * Maskable: no.
 914      * Formatting: decimal.
 915      * Prerequisites: IPv4/IPv6.
 916      * Access: read/write.
 917      * NXM: NXM_OF_IP_TOS(5) since v1.1.
 918      * OXM: none.
 919      * OF1.0: exact match.
 920      * OF1.1: exact match.
 921      */
 922     MFF_IP_DSCP,
 923
 924     /* "ip_dscp" (OpenFlow 1.2+).
 925      *
 926      * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6
 927      * header, shifted right 2 bits.  (That is, bits 0-5 contain the type of
 928      * service and bits 6-7 are zero.)
 929      *
 930      * Type: u8 (low 6 bits).
 931      * Maskable: no.
 932      * Formatting: decimal.
 933      * Prerequisites: IPv4/IPv6.
 934      * Access: read/write.
 935      * NXM: none.
 936      * OXM: OXM_OF_IP_DSCP(8) since OF1.2 and v1.7.
 937      * OF1.0: exact match.
 938      * OF1.1: exact match.
 939      */
 940     MFF_IP_DSCP_SHIFTED,
 941
 942     /* "nw_ecn" (aka "ip_ecn").
 943      *
 944      * The ECN bits in the IPv4 or IPv6 header.
 945      *
 946      * Type: u8 (low 2 bits).
 947      * Maskable: no.
 948      * Formatting: decimal.
 949      * Prerequisites: IPv4/IPv6.
 950      * Access: read/write.
 951      * NXM: NXM_NX_IP_ECN(28) since v1.4.
 952      * OXM: OXM_OF_IP_ECN(9) since OF1.2 and v1.7.
 953      */
 954     MFF_IP_ECN,
 955
 956     /* "nw_ttl".
 957      *
 958      * The time-to-live (TTL) in the IPv4 header or hop limit in the IPv6
 959      * header.
 960      *
 961      * Type: u8.
 962      * Maskable: no.
 963      * Formatting: decimal.
 964      * Prerequisites: IPv4/IPv6.
 965      * Access: read/write.
 966      * NXM: NXM_NX_IP_TTL(29) since v1.4.
 967      * OXM: none.
 968      */
 969     MFF_IP_TTL,
 970
 971     /* "ip_frag".
 972      *
 973      * IP fragment information.
 974      *
 975      * This field has three possible values:
 976      *
 977      *   - A packet that is not an IP fragment has value 0.
 978      *
 979      *   - A packet that is an IP fragment with offset 0 (the first fragment)
 980      *     has bit 0 set and thus value 1.
 981      *
 982      *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1
 983      *     set and thus value 3.
 984      *
 985      * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically
 986      * represent the meanings of bits 0 and 1.
 987      *
 988      * The switch may reject matches against values that can never appear.
 989      *
 990      * It is important to understand how this field interacts with the OpenFlow
 991      * IP fragment handling mode:
 992      *
 993      *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
 994      *     before they reach the flow table, so every packet that is available
 995      *     for matching will have value 0 in this field.
 996      *
 997      *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did
 998      *     then IP fragments would be reassembled before they reached the flow
 999      *     table and again every packet available for matching would always
1000      *     have value 0.
1001      *
1002      *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but
1003      *     OpenFlow 1.0 says that fragments' transport ports are always 0, even
1004      *     for the first fragment, so this does not provide much extra
1005      *     information.
1006      *
1007      *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1008      *     fragments with offset 0, Open vSwitch makes L4 header information
1009      *     available.
1010      *
1011      * Type: u8 (low 2 bits).
1012      * Maskable: bitwise.
1013      * Formatting: frag.
1014      * Prerequisites: IPv4/IPv6.
1015      * Access: read-only.
1016      * NXM: NXM_NX_IP_FRAG(26) since v1.3.
1017      * OXM: none.
1018      */
1019     MFF_IP_FRAG,
1020
1021 /* ## --- ## */
1022 /* ## ARP ## */
1023 /* ## --- ## */
1024
1025     /* "arp_op".
1026      *
1027      * ARP opcode.
1028      *
1029      * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1030      * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1031      * matching.
1032      *
1033      * Type: be16.
1034      * Maskable: no.
1035      * Formatting: decimal.
1036      * Prerequisites: ARP.
1037      * Access: read/write.
1038      * NXM: NXM_OF_ARP_OP(15) since v1.1.
1039      * OXM: OXM_OF_ARP_OP(21) since OF1.2 and v1.7.
1040      * OF1.0: exact match.
1041      * OF1.1: exact match.
1042      */
1043     MFF_ARP_OP,
1044
1045     /* "arp_spa".
1046      *
1047      * For an Ethernet+IP ARP packet, the source protocol (IPv4) address in the
1048      * ARP header.  Always 0 otherwise.
1049      *
1050      * Before Open vSwitch 1.8, only CIDR masks were supported.
1051      *
1052      * Type: be32.
1053      * Maskable: bitwise.
1054      * Formatting: IPv4.
1055      * Prerequisites: ARP.
1056      * Access: read/write.
1057      * NXM: NXM_OF_ARP_SPA(16) since v1.1.
1058      * OXM: OXM_OF_ARP_SPA(22) since OF1.2 and v1.7.
1059      * OF1.0: CIDR mask.
1060      * OF1.1: bitwise mask.
1061      */
1062     MFF_ARP_SPA,
1063
1064     /* "arp_tpa".
1065      *
1066      * For an Ethernet+IP ARP packet, the target protocol (IPv4) address in the
1067      * ARP header.  Always 0 otherwise.
1068      *
1069      * Before Open vSwitch 1.8, only CIDR masks were supported.
1070      *
1071      * Type: be32.
1072      * Maskable: bitwise.
1073      * Formatting: IPv4.
1074      * Prerequisites: ARP.
1075      * Access: read/write.
1076      * NXM: NXM_OF_ARP_TPA(17) since v1.1.
1077      * OXM: OXM_OF_ARP_TPA(23) since OF1.2 and v1.7.
1078      * OF1.0: CIDR mask.
1079      * OF1.1: bitwise mask.
1080      */
1081     MFF_ARP_TPA,
1082
1083     /* "arp_sha".
1084      *
1085      * For an Ethernet+IP ARP packet, the source hardware (Ethernet) address in
1086      * the ARP header.  Always 0 otherwise.
1087      *
1088      * Type: MAC.
1089      * Maskable: bitwise.
1090      * Formatting: Ethernet.
1091      * Prerequisites: ARP.
1092      * Access: read/write.
1093      * NXM: NXM_NX_ARP_SHA(17) since v1.1.
1094      * OXM: OXM_OF_ARP_SHA(24) since OF1.2 and v1.7.
1095      */
1096     MFF_ARP_SHA,
1097
1098     /* "arp_tha".
1099      *
1100      * For an Ethernet+IP ARP packet, the target hardware (Ethernet) address in
1101      * the ARP header.  Always 0 otherwise.
1102      *
1103      * Type: MAC.
1104      * Maskable: bitwise.
1105      * Formatting: Ethernet.
1106      * Prerequisites: ARP.
1107      * Access: read/write.
1108      * NXM: NXM_NX_ARP_THA(18) since v1.1.
1109      * OXM: OXM_OF_ARP_THA(25) since OF1.2 and v1.7.
1110      */
1111     MFF_ARP_THA,
1112
1113 /* ## --- ## */
1114 /* ## TCP ## */
1115 /* ## --- ## */
1116
1117     /* "tcp_src" (aka "tp_src").
1118      *
1119      * TCP source port.
1120      *
1121      * Type: be16.
1122      * Maskable: bitwise.
1123      * Formatting: decimal.
1124      * Prerequisites: TCP.
1125      * Access: read/write.
1126      * NXM: NXM_OF_TCP_SRC(9) since v1.1.
1127      * OXM: OXM_OF_TCP_SRC(13) since OF1.2 and v1.7.
1128      * OF1.0: exact match.
1129      * OF1.1: exact match.
1130      */
1131     MFF_TCP_SRC,
1132
1133     /* "tcp_dst" (aka "tp_dst").
1134      *
1135      * TCP destination port.
1136      *
1137      * Type: be16.
1138      * Maskable: bitwise.
1139      * Formatting: decimal.
1140      * Prerequisites: TCP.
1141      * Access: read/write.
1142      * NXM: NXM_OF_TCP_DST(10) since v1.1.
1143      * OXM: OXM_OF_TCP_DST(14) since OF1.2 and v1.7.
1144      * OF1.0: exact match.
1145      * OF1.1: exact match.
1146      */
1147     MFF_TCP_DST,
1148
1149     /* "tcp_flags".
1150      *
1151      * Flags in the TCP header.
1152      *
1153      * TCP currently defines 9 flag bits, and additional 3 bits are reserved
1154      * (must be transmitted as zero).  See RFCs 793, 3168, and 3540.
1155      *
1156      * Type: be16 (low 12 bits).
1157      * Maskable: bitwise.
1158      * Formatting: TCP flags.
1159      * Prerequisites: TCP.
1160      * Access: read-only.
1161      * NXM: NXM_NX_TCP_FLAGS(34) since v2.1.
1162      * OXM: OXM_OF_TCP_FLAGS(42) since OF1.5 and v2.3.
1163      */
1164     MFF_TCP_FLAGS,
1165
1166 /* ## --- ## */
1167 /* ## UDP ## */
1168 /* ## --- ## */
1169
1170     /* "udp_src".
1171      *
1172      * UDP source port.
1173      *
1174      * Type: be16.
1175      * Maskable: bitwise.
1176      * Formatting: decimal.
1177      * Prerequisites: UDP.
1178      * Access: read/write.
1179      * NXM: NXM_OF_UDP_SRC(11) since v1.1.
1180      * OXM: OXM_OF_UDP_SRC(15) since OF1.2 and v1.7.
1181      * OF1.0: exact match.
1182      * OF1.1: exact match.
1183      */
1184     MFF_UDP_SRC,
1185
1186     /* "udp_dst".
1187      *
1188      * UDP destination port
1189      *
1190      * Type: be16.
1191      * Maskable: bitwise.
1192      * Formatting: decimal.
1193      * Prerequisites: UDP.
1194      * Access: read/write.
1195      * NXM: NXM_OF_UDP_DST(12) since v1.1.
1196      * OXM: OXM_OF_UDP_DST(16) since OF1.2 and v1.7.
1197      * OF1.0: exact match.
1198      * OF1.1: exact match.
1199      */
1200     MFF_UDP_DST,
1201
1202 /* ## ---- ## */
1203 /* ## SCTP ## */
1204 /* ## ---- ## */
1205
1206     /* "sctp_src".
1207      *
1208      * SCTP source port.
1209      *
1210      * Type: be16.
1211      * Maskable: bitwise.
1212      * Formatting: decimal.
1213      * Prerequisites: SCTP.
1214      * Access: read/write.
1215      * NXM: none.
1216      * OXM: OXM_OF_SCTP_SRC(17) since OF1.2 and v2.0.
1217      * OF1.1: exact match.
1218      */
1219     MFF_SCTP_SRC,
1220
1221     /* "sctp_dst".
1222      *
1223      * SCTP destination port.
1224      *
1225      * Type: be16.
1226      * Maskable: bitwise.
1227      * Formatting: decimal.
1228      * Prerequisites: SCTP.
1229      * Access: read/write.
1230      * NXM: none.
1231      * OXM: OXM_OF_SCTP_DST(18) since OF1.2 and v2.0.
1232      * OF1.1: exact match.
1233      */
1234     MFF_SCTP_DST,
1235
1236 /* ## ---- ## */
1237 /* ## ICMP ## */
1238 /* ## ---- ## */
1239
1240     /* "icmp_type".
1241      *
1242      * ICMPv4 type.
1243      *
1244      * Type: u8.
1245      * Maskable: no.
1246      * Formatting: decimal.
1247      * Prerequisites: ICMPv4.
1248      * Access: read-only.
1249      * NXM: NXM_OF_ICMP_TYPE(13) since v1.1.
1250      * OXM: OXM_OF_ICMPV4_TYPE(19) since OF1.2 and v1.7.
1251      * OF1.0: exact match.
1252      * OF1.1: exact match.
1253      */
1254     MFF_ICMPV4_TYPE,
1255
1256     /* "icmp_code".
1257      *
1258      * ICMPv4 code.
1259      *
1260      * Type: u8.
1261      * Maskable: no.
1262      * Formatting: decimal.
1263      * Prerequisites: ICMPv4.
1264      * Access: read-only.
1265      * NXM: NXM_OF_ICMP_CODE(14) since v1.1.
1266      * OXM: OXM_OF_ICMPV4_CODE(20) since OF1.2 and v1.7.
1267      * OF1.0: exact match.
1268      * OF1.1: exact match.
1269      */
1270     MFF_ICMPV4_CODE,
1271
1272     /* "icmpv6_type".
1273      *
1274      * ICMPv6 type.
1275      *
1276      * Type: u8.
1277      * Maskable: no.
1278      * Formatting: decimal.
1279      * Prerequisites: ICMPv6.
1280      * Access: read-only.
1281      * NXM: NXM_NX_ICMPV6_TYPE(21) since v1.1.
1282      * OXM: OXM_OF_ICMPV6_TYPE(29) since OF1.2 and v1.7.
1283      */
1284     MFF_ICMPV6_TYPE,
1285
1286     /* "icmpv6_code".
1287      *
1288      * ICMPv6 code.
1289      *
1290      * Type: u8.
1291      * Maskable: no.
1292      * Formatting: decimal.
1293      * Prerequisites: ICMPv6.
1294      * Access: read-only.
1295      * NXM: NXM_NX_ICMPV6_CODE(22) since v1.1.
1296      * OXM: OXM_OF_ICMPV6_CODE(30) since OF1.2 and v1.7.
1297      */
1298     MFF_ICMPV6_CODE,
1299
1300 /* ## ------------------------- ## */
1301 /* ## ICMPv6 Neighbor Discovery ## */
1302 /* ## ------------------------- ## */
1303
1304     /* "nd_target".
1305      *
1306      * The target address in an IPv6 Neighbor Discovery message.
1307      *
1308      * Before Open vSwitch 1.8, only CIDR masks were supported.
1309      *
1310      * Type: IPv6.
1311      * Maskable: bitwise.
1312      * Formatting: IPv6.
1313      * Prerequisites: ND.
1314      * Access: read-only.
1315      * NXM: NXM_NX_ND_TARGET(23) since v1.1.
1316      * OXM: OXM_OF_IPV6_ND_TARGET(31) since OF1.2 and v1.7.
1317      */
1318     MFF_ND_TARGET,
1319
1320     /* "nd_sll".
1321      *
1322      * The source link layer address in an IPv6 Neighbor Discovery message.
1323      *
1324      * Type: MAC.
1325      * Maskable: bitwise.
1326      * Formatting: Ethernet.
1327      * Prerequisites: ND solicit.
1328      * Access: read-only.
1329      * NXM: NXM_NX_ND_SLL(24) since v1.1.
1330      * OXM: OXM_OF_IPV6_ND_SLL(32) since OF1.2 and v1.7.
1331      */
1332     MFF_ND_SLL,
1333
1334     /* "nd_tll".
1335      *
1336      * The target link layer address in an IPv6 Neighbor Discovery message.
1337      *
1338      * Type: MAC.
1339      * Maskable: bitwise.
1340      * Formatting: Ethernet.
1341      * Prerequisites: ND advert.
1342      * Access: read-only.
1343      * NXM: NXM_NX_ND_TLL(25) since v1.1.
1344      * OXM: OXM_OF_IPV6_ND_TLL(33) since OF1.2 and v1.7.
1345      */
1346     MFF_ND_TLL,
1347
1348     MFF_N_IDS
1349 };
1350
1351 /* A set of mf_field_ids. */
1352 struct mf_bitmap {
1353     unsigned long bm[BITMAP_N_LONGS(MFF_N_IDS)];
1354 };
1355 #define MF_BITMAP_INITIALIZER { { [0] = 0 } }
1356
1357 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
1358  * MFF_REGn cases. */
1359 #if FLOW_N_REGS == 8
1360 #define CASE_MFF_REGS                                           \
1361     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
1362     case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
1363 #else
1364 #error "Need to update CASE_MFF_REGS to match FLOW_N_REGS"
1365 #endif
1366
1367 /* Use this macro as CASE_MFF_XREGS: in a switch statement to choose all of the
1368  * MFF_REGn cases. */
1369 #if FLOW_N_XREGS == 4
1370 #define CASE_MFF_XREGS                                              \
1371     case MFF_XREG0: case MFF_XREG1: case MFF_XREG2: case MFF_XREG3
1372 #else
1373 #error "Need to update CASE_MFF_XREGS to match FLOW_N_XREGS"
1374 #endif
1375
1376 /* Prerequisites for matching a field.
1377  *
1378  * A field may only be matched if the correct lower-level protocols are also
1379  * matched.  For example, the TCP port may be matched only if the Ethernet type
1380  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
1381 enum OVS_PACKED_ENUM mf_prereqs {
1382     MFP_NONE,
1383
1384     /* L2 requirements. */
1385     MFP_ARP,
1386     MFP_VLAN_VID,
1387     MFP_IPV4,
1388     MFP_IPV6,
1389     MFP_IP_ANY,
1390
1391     /* L2.5 requirements. */
1392     MFP_MPLS,
1393
1394     /* L2+L3 requirements. */
1395     MFP_TCP,                    /* On IPv4 or IPv6. */
1396     MFP_UDP,                    /* On IPv4 or IPv6. */
1397     MFP_SCTP,                   /* On IPv4 or IPv6. */
1398     MFP_ICMPV4,
1399     MFP_ICMPV6,
1400
1401     /* L2+L3+L4 requirements. */
1402     MFP_ND,
1403     MFP_ND_SOLICIT,
1404     MFP_ND_ADVERT
1405 };
1406
1407 /* Forms of partial-field masking allowed for a field.
1408  *
1409  * Every field may be masked as a whole. */
1410 enum OVS_PACKED_ENUM mf_maskable {
1411     MFM_NONE,                   /* No sub-field masking. */
1412     MFM_FULLY,                  /* Every bit is individually maskable. */
1413 };
1414
1415 /* How to format or parse a field's value. */
1416 enum OVS_PACKED_ENUM mf_string {
1417     /* Integer formats.
1418      *
1419      * The particular MFS_* constant sets the output format.  On input, either
1420      * decimal or hexadecimal (prefixed with 0x) is accepted. */
1421     MFS_DECIMAL,
1422     MFS_HEXADECIMAL,
1423
1424     /* Other formats. */
1425     MFS_ETHERNET,
1426     MFS_IPV4,
1427     MFS_IPV6,
1428     MFS_OFP_PORT,               /* 16-bit OpenFlow 1.0 port number or name. */
1429     MFS_OFP_PORT_OXM,           /* 32-bit OpenFlow 1.1+ port number or name. */
1430     MFS_FRAG,                   /* no, yes, first, later, not_later */
1431     MFS_TNL_FLAGS,              /* FLOW_TNL_F_* flags */
1432     MFS_TCP_FLAGS,              /* TCP_* flags */
1433 };
1434
1435 struct mf_field {
1436     /* Identification. */
1437     enum mf_field_id id;        /* MFF_*. */
1438     const char *name;           /* Name of this field, e.g. "eth_type". */
1439     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
1440
1441     /* Size.
1442      *
1443      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
1444      *
1445      *     - "dl_vlan" is 2 bytes but only 12 bits.
1446      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
1447      *     - "is_frag" is 1 byte but only 2 bits.
1448      *     - "ipv6_label" is 4 bytes but only 20 bits.
1449      *     - "mpls_label" is 4 bytes but only 20 bits.
1450      *     - "mpls_tc"    is 1 byte but only 3 bits.
1451      *     - "mpls_bos"   is 1 byte but only 1 bit.
1452      */
1453     unsigned int n_bytes;       /* Width of the field in bytes. */
1454     unsigned int n_bits;        /* Number of significant bits in field. */
1455
1456     /* Properties. */
1457     enum mf_maskable maskable;
1458     enum mf_string string;
1459     enum mf_prereqs prereqs;
1460     bool writable;              /* May be written by actions? */
1461
1462     /* Usable protocols.
1463      *
1464      * NXM and OXM are extensible, allowing later extensions to be sent in
1465      * earlier protocol versions, so this does not necessarily correspond to
1466      * the OpenFlow protocol version the field was introduced in.
1467      * Also, some field types are tranparently mapped to each other via the
1468      * struct flow (like vlan and dscp/tos fields), so each variant supports
1469      * all protocols.
1470      *
1471      * These are combinations of OFPUTIL_P_*.  (They are not declared as type
1472      * enum ofputil_protocol because that would give meta-flow.h and ofp-util.h
1473      * a circular dependency.) */
1474     uint32_t usable_protocols_exact;   /* Matching or setting whole field. */
1475     uint32_t usable_protocols_cidr;    /* Matching a CIDR mask in field. */
1476     uint32_t usable_protocols_bitwise; /* Matching arbitrary bits in field. */
1477
1478     int flow_be32ofs;  /* Field's be32 offset in "struct flow", if prefix tree
1479                         * lookup is supported for the field, or -1. */
1480 };
1481
1482 /* The representation of a field's value. */
1483 union mf_value {
1484     struct in6_addr ipv6;
1485     uint8_t mac[ETH_ADDR_LEN];
1486     ovs_be64 be64;
1487     ovs_be32 be32;
1488     ovs_be16 be16;
1489     uint8_t u8;
1490 };
1491 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
1492
1493 #define MF_EXACT_MASK_INITIALIZER { IN6ADDR_EXACT_INIT }
1494
1495 /* Part of a field. */
1496 struct mf_subfield {
1497     const struct mf_field *field;
1498     unsigned int ofs;           /* Bit offset. */
1499     unsigned int n_bits;        /* Number of bits. */
1500 };
1501
1502 /* Data for some part of an mf_field.
1503  *
1504  * The data is stored "right-justified".  For example, if "union mf_subvalue
1505  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
1506  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
1507 union mf_subvalue {
1508     uint8_t u8[16];
1509     ovs_be16 be16[8];
1510     ovs_be32 be32[4];
1511     ovs_be64 be64[2];
1512 };
1513 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
1514
1515 /* Finding mf_fields. */
1516 const struct mf_field *mf_from_name(const char *name);
1517
1518 static inline const struct mf_field *
1519 mf_from_id(enum mf_field_id id)
1520 {
1521     extern const struct mf_field mf_fields[MFF_N_IDS];
1522     ovs_assert((unsigned int) id < MFF_N_IDS);
1523     return &mf_fields[id];
1524 }
1525
1526 /* Inspecting wildcarded bits. */
1527 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
1528
1529 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
1530 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
1531                  union mf_value *mask);
1532
1533 /* Prerequisites. */
1534 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
1535 void mf_mask_field_and_prereqs(const struct mf_field *, struct flow *mask);
1536
1537 static inline bool
1538 mf_is_l3_or_higher(const struct mf_field *mf)
1539 {
1540     return mf->id >= MFF_IPV4_SRC;
1541 }
1542
1543 /* Field values. */
1544 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
1545
1546 void mf_get_value(const struct mf_field *, const struct flow *,
1547                   union mf_value *value);
1548 void mf_set_value(const struct mf_field *, const union mf_value *value,
1549                   struct match *);
1550 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
1551                        struct flow *);
1552 void mf_set_flow_value_masked(const struct mf_field *,
1553                               const union mf_value *value,
1554                               const union mf_value *mask,
1555                               struct flow *);
1556 bool mf_is_zero(const struct mf_field *, const struct flow *);
1557 void mf_mask_field(const struct mf_field *, struct flow *);
1558
1559 void mf_get(const struct mf_field *, const struct match *,
1560             union mf_value *value, union mf_value *mask);
1561
1562 /* Returns the set of usable protocols. */
1563 enum ofputil_protocol mf_set(const struct mf_field *,
1564                              const union mf_value *value,
1565                              const union mf_value *mask,
1566                              struct match *);
1567
1568 void mf_set_wild(const struct mf_field *, struct match *);
1569
1570 /* Subfields. */
1571 void mf_write_subfield_flow(const struct mf_subfield *,
1572                             const union mf_subvalue *, struct flow *);
1573 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
1574                        struct match *);
1575
1576 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
1577                       union mf_subvalue *);
1578 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
1579
1580
1581 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
1582 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
1583
1584 /* Parsing and formatting. */
1585 char *mf_parse(const struct mf_field *, const char *,
1586                union mf_value *value, union mf_value *mask);
1587 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
1588 void mf_format(const struct mf_field *,
1589                const union mf_value *value, const union mf_value *mask,
1590                struct ds *);
1591 void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s);
1592
1593 #endif /* meta-flow.h */