lib/meta-flow.h

   1 /*
   2  * Copyright (c) 2011, 2012, 2013, 2014, 2015 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  *         tunnelMD: A variable length field, up to 124 bytes, that carries
 141  *                   tunnel metadata.
 142  *
 143  *   Maskable:
 144  *
 145  *     Either "bitwise", if OVS supports matching any subset of bits in the
 146  *     field, or "no", if OVS only supports matching or wildcarding the entire
 147  *     field.
 148  *
 149  *   Formatting:
 150  *
 151  *     Explains how a field's value is formatted and parsed for human
 152  *     consumption.  Some of the options are fairly generally useful:
 153  *
 154  *       decimal: Formats the value as a decimal number.  On parsing, accepts
 155  *         decimal (with no prefix), hexadecimal with 0x prefix, or octal
 156  *         with 0 prefix.
 157  *
 158  *       hexadecimal: Same as decimal except nonzero values are formatted in
 159  *         hex with 0x prefix.  The default for parsing is *not* hexadecimal:
 160  *         only with a 0x prefix is the input in hexadecimal.
 161  *
 162  *       Ethernet: Formats and accepts the common format xx:xx:xx:xx:xx:xx.
 163  *         6-byte fields only.
 164  *
 165  *       IPv4: Formats and accepts the common format w.x.y.z.  4-byte fields
 166  *         only.
 167  *
 168  *       IPv6: Formats and accepts the common IPv6 formats.  16-byte fields
 169  *         only.
 170  *
 171  *       OpenFlow 1.0 port: Accepts an OpenFlow well-known port name
 172  *         (e.g. "IN_PORT") in uppercase or lowercase, or a 16-bit port
 173  *         number in decimal.  Formats ports using their well-known names in
 174  *         uppercase, or in decimal otherwise.  2-byte fields only.
 175  *
 176  *       OpenFlow 1.1+ port: Same syntax as for OpenFlow 1.0 ports but for
 177  *         4-byte OpenFlow 1.1+ port number fields.
 178  *
 179  *     Others are very specific to particular fields:
 180  *
 181  *       frag: One of the strings "no", "first", "later", "yes", "not_later"
 182  *         describing which IPv4/v6 fragments are matched.
 183  *
 184  *       tunnel flags: Any number of the strings "df", "csum", "key", or
 185  *         "oam" separated by "|".
 186  *
 187  *       TCP flags: See the description of tcp_flags in ovs-ofctl(8).
 188  *
 189  *   Prerequisites:
 190  *
 191  *     The field's prerequisites.  The values should be straightfoward.
 192  *
 193  *   Access:
 194  *
 195  *     Either "read-only", for a field that cannot be changed via OpenFlow, or
 196  *     "read/write" for a modifiable field.
 197  *
 198  *   NXM:
 199  *
 200  *     If the field has an NXM field assignment, then this specifies the NXM
 201  *     name of the field (e.g. "NXM_OF_ETH_SRC"), followed by its nxm_type in
 202  *     parentheses, followed by "since v<x>.<y>" specifying the version of Open
 203  *     vSwitch that first supported this field in NXM (e.g. "since v1.1" if it
 204  *     was introduced in Open vSwitch 1.1).
 205  *
 206  *     The NXM name must begin with NXM_OF_ or NXM_NX_.  This allows OVS to
 207  *     determine the correct NXM class.
 208  *
 209  *     If the field does not have an NXM field assignment, specify "none".
 210  *
 211  *   OXM:
 212  *
 213  *     If the field has an OXM field assignment, then this specifies the OXM
 214  *     name of the field (e.g. "OXM_OF_ETH_SRC"), followed by its nxm_type in
 215  *     parentheses, followed by "since OF<a>.<b> v<x>.<y>" specifying the
 216  *     versions of OpenFlow and Open vSwitch that first supported this field in
 217  *     OXM (e.g. "since OF1.3 and v1.10" if it was introduced in OpenFlow 1.3
 218  *     and first supported by Open vSwitch in version 1.10).
 219  *
 220  *     Some fields have more than one OXM field assignment.  For example,
 221  *     actset_output has an experimenter OXM assignment in OpenFlow 1.3 and a
 222  *     standard OXM assignment in OpenFlow 1.5.  In such a case, specify both,
 223  *     separated by commas.
 224  *
 225  *     OVS uses the start of the OXM field name to determine the correct OXM
 226  *     class.  To support a new OXM class, edit the mapping table in
 227  *     build-aux/extract-ofp-fields.
 228  *
 229  *     If the field does not have an OXM field assignment, specify "none".
 230  *
 231  * The following key-value pairs are optional.  Open vSwitch already supports
 232  * all the fields to which they apply, so new fields should probably not
 233  * include these pairs:
 234  *
 235  *   OF1.0:
 236  *
 237  *     Specify this as "exact match" if OpenFlow 1.0 can match or wildcard the
 238  *     entire field, or as "CIDR mask" if OpenFlow 1.0 can match any CIDR
 239  *     prefix of the field.  (OpenFlow 1.0 did not support bitwise matching.)
 240  *     Omit, if OpenFlow 1.0 did not support this field.
 241  *
 242  *   OF1.1:
 243  *
 244  *     Specify this as "exact match" if OpenFlow 1.1 can match or wildcard the
 245  *     entire field, or as "bitwise" if OpenFlow 1.1 can match any subset of
 246  *     bits in the field.  Omit, if OpenFlow 1.1 did not support this field.
 247  *
 248  * The following key-value pair is optional:
 249  *
 250  *   Prefix lookup member:
 251  *
 252  *     If this field makes sense for use with classifier_set_prefix_fields(),
 253  *     specify the name of the "struct flow" member that corresponds to the
 254  *     field.
 255  *
 256  * Finally, a few "register" fields have very similar names and purposes,
 257  * e.g. MFF_REG0 through MFF_REG7.  For these, the comments may be merged
 258  * together using <N> as a metasyntactic variable for the numeric suffix.
 259  * Lines in the comment that are specific to one of the particular fields by
 260  * writing, e.g. <1>, to consider that line only for e.g. MFF_REG1.
 261  */
 262
 263 enum OVS_PACKED_ENUM mf_field_id {
 264 /* ## -------- ## */
 265 /* ## Metadata ## */
 266 /* ## -------- ## */
 267
 268     /* "dp_hash".
 269      *
 270      * Flow hash computed in the datapath.  Internal use only, not programmable
 271      * from controller.
 272      *
 273      * The OXM code point for this is an attempt to test OXM experimenter
 274      * support, which is otherwise difficult to test due to the dearth of use
 275      * out in the wild.  Because controllers can't add flows that match on
 276      * dp_hash, this doesn't commit OVS to supporting this OXM experimenter
 277      * code point in the future.
 278      *
 279      * Type: be32.
 280      * Maskable: bitwise.
 281      * Formatting: hexadecimal.
 282      * Prerequisites: none.
 283      * Access: read-only.
 284      * NXM: NXM_NX_DP_HASH(35) since v2.2.
 285      * OXM: NXOXM_ET_DP_HASH(0) since OF1.5 and v2.4.
 286      */
 287     MFF_DP_HASH,
 288
 289     /* "recirc_id".
 290      *
 291      * ID for recirculation.  The value 0 is reserved for initially received
 292      * packets.  Internal use only, not programmable from controller.
 293      *
 294      * Type: be32.
 295      * Maskable: no.
 296      * Formatting: decimal.
 297      * Prerequisites: none.
 298      * Access: read-only.
 299      * NXM: NXM_NX_RECIRC_ID(36) since v2.2.
 300      * OXM: none.
 301      */
 302     MFF_RECIRC_ID,
 303
 304     /* "conj_id".
 305      *
 306      * ID for "conjunction" actions.  Please refer to ovs-ofctl(8)
 307      * documentation of "conjunction" for details.
 308      *
 309      * Type: be32.
 310      * Maskable: no.
 311      * Formatting: decimal.
 312      * Prerequisites: none.
 313      * Access: read-only.
 314      * NXM: NXM_NX_CONJ_ID(37) since v2.4.
 315      * OXM: none. */
 316     MFF_CONJ_ID,
 317
 318     /* "tun_id" (aka "tunnel_id").
 319      *
 320      * The "key" or "tunnel ID" or "VNI" in a packet received via a keyed
 321      * tunnel.  For protocols in which the key is shorter than 64 bits, the key
 322      * is stored in the low bits and the high bits are zeroed.  For non-keyed
 323      * tunnels and packets not received via a tunnel, the value is 0.
 324      *
 325      * Type: be64.
 326      * Maskable: bitwise.
 327      * Formatting: hexadecimal.
 328      * Prerequisites: none.
 329      * Access: read/write.
 330      * NXM: NXM_NX_TUN_ID(16) since v1.1.
 331      * OXM: OXM_OF_TUNNEL_ID(38) since OF1.3 and v1.10.
 332      * Prefix lookup member: tunnel.tun_id.
 333      */
 334     MFF_TUN_ID,
 335
 336     /* "tun_src".
 337      *
 338      * The IPv4 source address in the outer IP header of a tunneled packet.
 339      *
 340      * For non-tunneled packets, the value is 0.
 341      *
 342      * Type: be32.
 343      * Maskable: bitwise.
 344      * Formatting: IPv4.
 345      * Prerequisites: none.
 346      * Access: read/write.
 347      * NXM: NXM_NX_TUN_IPV4_SRC(31) since v2.0.
 348      * OXM: none.
 349      * Prefix lookup member: tunnel.ip_src.
 350      */
 351     MFF_TUN_SRC,
 352
 353     /* "tun_dst".
 354      *
 355      * The IPv4 destination address in the outer IP header of a tunneled
 356      * packet.
 357      *
 358      * For non-tunneled packets, the value is 0.
 359      *
 360      * Type: be32.
 361      * Maskable: bitwise.
 362      * Formatting: IPv4.
 363      * Prerequisites: none.
 364      * Access: read/write.
 365      * NXM: NXM_NX_TUN_IPV4_DST(32) since v2.0.
 366      * OXM: none.
 367      * Prefix lookup member: tunnel.ip_dst.
 368      */
 369     MFF_TUN_DST,
 370
 371     /* "tun_flags".
 372      *
 373      * Flags representing aspects of tunnel behavior.
 374      *
 375      * This field currently only has a single flag defined:
 376      *
 377      *   - NX_TUN_FLAG_OAM: The tunnel protocol indicated that this is an
 378      *                      OAM control packet.
 379      *
 380      * The switch may reject matches against values that it is not aware of.
 381      *
 382      * Note that it is possible for newer version of Open vSwitch to
 383      * introduce additional flags with varying meaning. It is therefore not
 384      * recommended to use an exact match on this field since the behavior of
 385      * these new flags is unknown and should be ignored.
 386      *
 387      * For non-tunneled packets, the value is 0.
 388      *
 389      * Type: be16 (low 1 bits).
 390      * Maskable: bitwise.
 391      * Formatting: tunnel flags.
 392      * Prerequisites: none.
 393      * Access: read/write.
 394      * NXM: NXM_NX_TUN_FLAGS(104) since v2.5.
 395      * OXM: none.
 396      */
 397     MFF_TUN_FLAGS,
 398
 399     /* "tun_ttl".
 400      *
 401      * The TTL in the outer IP header of a tunneled packet.  Internal use only,
 402      * not programmable from controller.
 403      *
 404      * For non-tunneled packets, the value is 0.
 405      *
 406      * Type: u8.
 407      * Maskable: no.
 408      * Formatting: decimal.
 409      * Prerequisites: none.
 410      * Access: read-only.
 411      * NXM: none.
 412      * OXM: none.
 413      */
 414     MFF_TUN_TTL,
 415
 416     /* "tun_tos".
 417      *
 418      * The ToS value in the outer IP header of a tunneled packet.  Internal use
 419      * only, not programmable from controller.
 420      *
 421      * Type: u8.
 422      * Maskable: no.
 423      * Formatting: decimal.
 424      * Prerequisites: none.
 425      * Access: read-only.
 426      * NXM: none.
 427      * OXM: none.
 428      */
 429     MFF_TUN_TOS,
 430
 431     /* "tun_gbp_id".
 432      *
 433      * VXLAN Group Policy ID
 434      *
 435      * Type: be16.
 436      * Maskable: bitwise.
 437      * Formatting: decimal.
 438      * Prerequisites: none.
 439      * Access: read/write.
 440      * NXM: NXM_NX_TUN_GBP_ID(38) since v2.4.
 441      * OXM: none.
 442      */
 443     MFF_TUN_GBP_ID,
 444
 445     /* "tun_gbp_flags".
 446      *
 447      * VXLAN Group Policy flags
 448      *
 449      * Type: u8.
 450      * Maskable: bitwise.
 451      * Formatting: hexadecimal.
 452      * Prerequisites: none.
 453      * Access: read/write.
 454      * NXM: NXM_NX_TUN_GBP_FLAGS(39) since v2.4.
 455      * OXM: none.
 456      */
 457     MFF_TUN_GBP_FLAGS,
 458
 459 #if TUN_METADATA_NUM_OPTS == 64
 460     /* "tun_metadata<N>".
 461      *
 462      * Encapsulation metadata for tunnels.
 463      *
 464      * Each NXM can be dynamically mapped onto a particular tunnel field using
 465      * OpenFlow commands. The individual NXMs can each carry up to 124 bytes
 466      * of data and a combined total of 256 across all allocated fields.
 467      *
 468      * Type: tunnelMD.
 469      * Maskable: bitwise.
 470      * Formatting: hexadecimal.
 471      * Prerequisites: none.
 472      * Access: read/write.
 473      * NXM: NXM_NX_TUN_METADATA0(40) since v2.5.        <0>
 474      * NXM: NXM_NX_TUN_METADATA1(41) since v2.5.        <1>
 475      * NXM: NXM_NX_TUN_METADATA2(42) since v2.5.        <2>
 476      * NXM: NXM_NX_TUN_METADATA3(43) since v2.5.        <3>
 477      * NXM: NXM_NX_TUN_METADATA4(44) since v2.5.        <4>
 478      * NXM: NXM_NX_TUN_METADATA5(45) since v2.5.        <5>
 479      * NXM: NXM_NX_TUN_METADATA6(46) since v2.5.        <6>
 480      * NXM: NXM_NX_TUN_METADATA7(47) since v2.5.        <7>
 481      * NXM: NXM_NX_TUN_METADATA8(48) since v2.5.        <8>
 482      * NXM: NXM_NX_TUN_METADATA9(49) since v2.5.        <9>
 483      * NXM: NXM_NX_TUN_METADATA10(50) since v2.5.       <10>
 484      * NXM: NXM_NX_TUN_METADATA11(51) since v2.5.       <11>
 485      * NXM: NXM_NX_TUN_METADATA12(52) since v2.5.       <12>
 486      * NXM: NXM_NX_TUN_METADATA13(53) since v2.5.       <13>
 487      * NXM: NXM_NX_TUN_METADATA14(54) since v2.5.       <14>
 488      * NXM: NXM_NX_TUN_METADATA15(55) since v2.5.       <15>
 489      * NXM: NXM_NX_TUN_METADATA16(56) since v2.5.       <16>
 490      * NXM: NXM_NX_TUN_METADATA17(57) since v2.5.       <17>
 491      * NXM: NXM_NX_TUN_METADATA18(58) since v2.5.       <18>
 492      * NXM: NXM_NX_TUN_METADATA19(59) since v2.5.       <19>
 493      * NXM: NXM_NX_TUN_METADATA20(60) since v2.5.       <20>
 494      * NXM: NXM_NX_TUN_METADATA21(61) since v2.5.       <21>
 495      * NXM: NXM_NX_TUN_METADATA22(62) since v2.5.       <22>
 496      * NXM: NXM_NX_TUN_METADATA23(63) since v2.5.       <23>
 497      * NXM: NXM_NX_TUN_METADATA24(64) since v2.5.       <24>
 498      * NXM: NXM_NX_TUN_METADATA25(65) since v2.5.       <25>
 499      * NXM: NXM_NX_TUN_METADATA26(66) since v2.5.       <26>
 500      * NXM: NXM_NX_TUN_METADATA27(67) since v2.5.       <27>
 501      * NXM: NXM_NX_TUN_METADATA28(68) since v2.5.       <28>
 502      * NXM: NXM_NX_TUN_METADATA29(69) since v2.5.       <29>
 503      * NXM: NXM_NX_TUN_METADATA30(70) since v2.5.       <30>
 504      * NXM: NXM_NX_TUN_METADATA31(71) since v2.5.       <31>
 505      * NXM: NXM_NX_TUN_METADATA32(72) since v2.5.       <32>
 506      * NXM: NXM_NX_TUN_METADATA33(73) since v2.5.       <33>
 507      * NXM: NXM_NX_TUN_METADATA34(74) since v2.5.       <34>
 508      * NXM: NXM_NX_TUN_METADATA35(75) since v2.5.       <35>
 509      * NXM: NXM_NX_TUN_METADATA36(76) since v2.5.       <36>
 510      * NXM: NXM_NX_TUN_METADATA37(77) since v2.5.       <37>
 511      * NXM: NXM_NX_TUN_METADATA38(78) since v2.5.       <38>
 512      * NXM: NXM_NX_TUN_METADATA39(79) since v2.5.       <39>
 513      * NXM: NXM_NX_TUN_METADATA40(80) since v2.5.       <40>
 514      * NXM: NXM_NX_TUN_METADATA41(81) since v2.5.       <41>
 515      * NXM: NXM_NX_TUN_METADATA42(82) since v2.5.       <42>
 516      * NXM: NXM_NX_TUN_METADATA43(83) since v2.5.       <43>
 517      * NXM: NXM_NX_TUN_METADATA44(84) since v2.5.       <44>
 518      * NXM: NXM_NX_TUN_METADATA45(85) since v2.5.       <45>
 519      * NXM: NXM_NX_TUN_METADATA46(86) since v2.5.       <46>
 520      * NXM: NXM_NX_TUN_METADATA47(87) since v2.5.       <47>
 521      * NXM: NXM_NX_TUN_METADATA48(88) since v2.5.       <48>
 522      * NXM: NXM_NX_TUN_METADATA49(89) since v2.5.       <49>
 523      * NXM: NXM_NX_TUN_METADATA50(90) since v2.5.       <50>
 524      * NXM: NXM_NX_TUN_METADATA51(91) since v2.5.       <51>
 525      * NXM: NXM_NX_TUN_METADATA52(92) since v2.5.       <52>
 526      * NXM: NXM_NX_TUN_METADATA53(93) since v2.5.       <53>
 527      * NXM: NXM_NX_TUN_METADATA54(94) since v2.5.       <54>
 528      * NXM: NXM_NX_TUN_METADATA55(95) since v2.5.       <55>
 529      * NXM: NXM_NX_TUN_METADATA56(96) since v2.5.       <56>
 530      * NXM: NXM_NX_TUN_METADATA57(97) since v2.5.       <57>
 531      * NXM: NXM_NX_TUN_METADATA58(98) since v2.5.       <58>
 532      * NXM: NXM_NX_TUN_METADATA59(99) since v2.5.       <59>
 533      * NXM: NXM_NX_TUN_METADATA60(100) since v2.5.      <60>
 534      * NXM: NXM_NX_TUN_METADATA61(101) since v2.5.      <61>
 535      * NXM: NXM_NX_TUN_METADATA62(102) since v2.5.      <62>
 536      * NXM: NXM_NX_TUN_METADATA63(103) since v2.5.      <63>
 537      * OXM: none.
 538      */
 539     MFF_TUN_METADATA0,
 540     MFF_TUN_METADATA1,
 541     MFF_TUN_METADATA2,
 542     MFF_TUN_METADATA3,
 543     MFF_TUN_METADATA4,
 544     MFF_TUN_METADATA5,
 545     MFF_TUN_METADATA6,
 546     MFF_TUN_METADATA7,
 547     MFF_TUN_METADATA8,
 548     MFF_TUN_METADATA9,
 549     MFF_TUN_METADATA10,
 550     MFF_TUN_METADATA11,
 551     MFF_TUN_METADATA12,
 552     MFF_TUN_METADATA13,
 553     MFF_TUN_METADATA14,
 554     MFF_TUN_METADATA15,
 555     MFF_TUN_METADATA16,
 556     MFF_TUN_METADATA17,
 557     MFF_TUN_METADATA18,
 558     MFF_TUN_METADATA19,
 559     MFF_TUN_METADATA20,
 560     MFF_TUN_METADATA21,
 561     MFF_TUN_METADATA22,
 562     MFF_TUN_METADATA23,
 563     MFF_TUN_METADATA24,
 564     MFF_TUN_METADATA25,
 565     MFF_TUN_METADATA26,
 566     MFF_TUN_METADATA27,
 567     MFF_TUN_METADATA28,
 568     MFF_TUN_METADATA29,
 569     MFF_TUN_METADATA30,
 570     MFF_TUN_METADATA31,
 571     MFF_TUN_METADATA32,
 572     MFF_TUN_METADATA33,
 573     MFF_TUN_METADATA34,
 574     MFF_TUN_METADATA35,
 575     MFF_TUN_METADATA36,
 576     MFF_TUN_METADATA37,
 577     MFF_TUN_METADATA38,
 578     MFF_TUN_METADATA39,
 579     MFF_TUN_METADATA40,
 580     MFF_TUN_METADATA41,
 581     MFF_TUN_METADATA42,
 582     MFF_TUN_METADATA43,
 583     MFF_TUN_METADATA44,
 584     MFF_TUN_METADATA45,
 585     MFF_TUN_METADATA46,
 586     MFF_TUN_METADATA47,
 587     MFF_TUN_METADATA48,
 588     MFF_TUN_METADATA49,
 589     MFF_TUN_METADATA50,
 590     MFF_TUN_METADATA51,
 591     MFF_TUN_METADATA52,
 592     MFF_TUN_METADATA53,
 593     MFF_TUN_METADATA54,
 594     MFF_TUN_METADATA55,
 595     MFF_TUN_METADATA56,
 596     MFF_TUN_METADATA57,
 597     MFF_TUN_METADATA58,
 598     MFF_TUN_METADATA59,
 599     MFF_TUN_METADATA60,
 600     MFF_TUN_METADATA61,
 601     MFF_TUN_METADATA62,
 602     MFF_TUN_METADATA63,
 603 #else
 604 #error "Need to update MFF_TUN_METADATA* to match TUN_METADATA_NUM_OPTS"
 605 #endif
 606
 607     /* "metadata".
 608      *
 609      * A scratch pad value standardized in OpenFlow 1.1+.  Initially zero, at
 610      * the beginning of the pipeline.
 611      *
 612      * Type: be64.
 613      * Maskable: bitwise.
 614      * Formatting: hexadecimal.
 615      * Prerequisites: none.
 616      * Access: read/write.
 617      * NXM: none.
 618      * OXM: OXM_OF_METADATA(2) since OF1.2 and v1.8.
 619      * OF1.1: bitwise mask.
 620      */
 621     MFF_METADATA,
 622
 623     /* "in_port".
 624      *
 625      * 16-bit (OpenFlow 1.0) view of the physical or virtual port on which the
 626      * packet was received.
 627      *
 628      * Type: be16.
 629      * Maskable: no.
 630      * Formatting: OpenFlow 1.0 port.
 631      * Prerequisites: none.
 632      * Access: read/write.
 633      * NXM: NXM_OF_IN_PORT(0) since v1.1.
 634      * OXM: none.
 635      * OF1.0: exact match.
 636      * OF1.1: exact match.
 637      */
 638     MFF_IN_PORT,
 639
 640     /* "in_port_oxm".
 641      *
 642      * 32-bit (OpenFlow 1.1+) view of the physical or virtual port on which the
 643      * packet was received.
 644      *
 645      * Type: be32.
 646      * Maskable: no.
 647      * Formatting: OpenFlow 1.1+ port.
 648      * Prerequisites: none.
 649      * Access: read/write.
 650      * NXM: none.
 651      * OXM: OXM_OF_IN_PORT(0) since OF1.2 and v1.7.
 652      * OF1.1: exact match.
 653      */
 654     MFF_IN_PORT_OXM,
 655
 656     /* "actset_output".
 657      *
 658      * Type: be32.
 659      * Maskable: no.
 660      * Formatting: OpenFlow 1.1+ port.
 661      * Prerequisites: none.
 662      * Access: read-only.
 663      * NXM: none.
 664      * OXM: ONFOXM_ET_ACTSET_OUTPUT(43) since OF1.3 and v2.4,
 665      *      OXM_OF_ACTSET_OUTPUT(43) since OF1.5 and v2.4.
 666      */
 667     MFF_ACTSET_OUTPUT,
 668
 669     /* "skb_priority".
 670      *
 671      * Designates the queue to which output will be directed.  The value in
 672      * this field is not necessarily the OpenFlow queue number; with the Linux
 673      * kernel switch, it instead has a pair of subfields designating the
 674      * "major" and "minor" numbers of a Linux kernel qdisc handle.
 675      *
 676      * This field is "semi-internal" in that it can be set with the "set_queue"
 677      * action but not matched or read or written other ways.
 678      *
 679      * Type: be32.
 680      * Maskable: no.
 681      * Formatting: hexadecimal.
 682      * Prerequisites: none.
 683      * Access: read-only.
 684      * NXM: none.
 685      * OXM: none.
 686      */
 687     MFF_SKB_PRIORITY,
 688
 689     /* "pkt_mark".
 690      *
 691      * Packet metadata mark.  The mark may be passed into other system
 692      * components in order to facilitate interaction between subsystems.  On
 693      * Linux this corresponds to struct sk_buff's "skb_mark" member but the
 694      * exact implementation is platform-dependent.
 695      *
 696      * Type: be32.
 697      * Maskable: bitwise.
 698      * Formatting: hexadecimal.
 699      * Prerequisites: none.
 700      * Access: read/write.
 701      * NXM: NXM_NX_PKT_MARK(33) since v2.0.
 702      * OXM: none.
 703      */
 704     MFF_PKT_MARK,
 705
 706     /* "ct_state".
 707      *
 708      * Connection tracking state.  The field is populated by the NXAST_CT
 709      * action. The following bit values describe the state of the connection:
 710      *
 711      *   - New (0x01): This is the beginning of a new connection.
 712      *   - Established (0x02): This is part of an already existing connection.
 713      *   - Related (0x04): This is a separate connection that is related to an
 714      *                     existing connection.
 715      *   - Invalid (0x20): This flow could not be associated with a connection.
 716      *                     This could be set for a variety of reasons,
 717      *                     including (but not limited to):
 718      *                     - L3/L4 protocol handler is not loaded/unavailable.
 719      *                     - L3/L4 protocol handler determines that the packet
 720      *                       is malformed or invalid for the current FSM stage.
 721      *                     - Packets are unexpected length for protocol.
 722      *   - Reply (0x40): This flow is in the reply direction, ie it did not
 723      *                   initiate the connection.
 724      *   - Tracked (0x80): Connection tracking has occurred.
 725      *
 726      * The "Tracked" bit corresponds to the packet_state as described in the
 727      * description of NXAST_CT action. The remaining bits correspond to
 728      * connection state. The "New" bit implies that the connection state
 729      * is uncommitted, while "Established" implies that it has previously been
 730      * committed.
 731      *
 732      * There are additional constraints on the ct_state bits, listed in order
 733      * of precedence below:
 734      *
 735      *   - If "Tracked" is unset, no other bits may be set.
 736      *   - If "Tracked" is set, one or more other bits may be set.
 737      *   - If "Invalid" is set, only the "Tracked" bit is also set.
 738      *   - The "New" and "Established" bits are mutually exclusive.
 739      *   - The "New" and "Reply" bits are mutually exclusive.
 740      *   - The "Related" bit may be set in conjunction with any other bits.
 741      *     Connections that are identified as "Related" are separate
 742      *     connections from the originating connection, so must be committed
 743      *     separately. All packets for a related connection will have the
 744      *     "Related" bit set (not just the initial packet).
 745      *
 746      * Type: be32.
 747      * Maskable: bitwise.
 748      * Formatting: ct state.
 749      * Prerequisites: none.
 750      * Access: read-only.
 751      * NXM: NXM_NX_CT_STATE(105) since v2.5.
 752      * OXM: none.
 753      */
 754     MFF_CT_STATE,
 755
 756     /* "ct_zone".
 757      *
 758      * Connection tracking zone.  The field is populated by the
 759      * NXAST_CT action.
 760      *
 761      * Type: be16.
 762      * Maskable: no.
 763      * Formatting: hexadecimal.
 764      * Prerequisites: none.
 765      * Access: read-only.
 766      * NXM: NXM_NX_CT_ZONE(106) since v2.5.
 767      * OXM: none.
 768      */
 769     MFF_CT_ZONE,
 770
 771 #if FLOW_N_REGS == 8
 772     /* "reg<N>".
 773      *
 774      * Nicira extension scratch pad register with initial value 0.
 775      *
 776      * Type: be32.
 777      * Maskable: bitwise.
 778      * Formatting: hexadecimal.
 779      * Prerequisites: none.
 780      * Access: read/write.
 781      * NXM: NXM_NX_REG0(0) since v1.1.        <0>
 782      * NXM: NXM_NX_REG1(1) since v1.1.        <1>
 783      * NXM: NXM_NX_REG2(2) since v1.1.        <2>
 784      * NXM: NXM_NX_REG3(3) since v1.1.        <3>
 785      * NXM: NXM_NX_REG4(4) since v1.3.        <4>
 786      * NXM: NXM_NX_REG5(5) since v1.7.        <5>
 787      * NXM: NXM_NX_REG6(6) since v1.7.        <6>
 788      * NXM: NXM_NX_REG7(7) since v1.7.        <7>
 789      * OXM: none.
 790      */
 791     MFF_REG0,
 792     MFF_REG1,
 793     MFF_REG2,
 794     MFF_REG3,
 795     MFF_REG4,
 796     MFF_REG5,
 797     MFF_REG6,
 798     MFF_REG7,
 799 #else
 800 #error "Need to update MFF_REG* to match FLOW_N_REGS"
 801 #endif
 802
 803 #if FLOW_N_XREGS == 4
 804     /* "xreg<N>".
 805      *
 806      * OpenFlow 1.5 ``extended register".  Each extended register
 807      * overlays two of the Nicira extension 32-bit registers: xreg0 overlays
 808      * reg0 and reg1, with reg0 supplying the most-significant bits of xreg0
 809      * and reg1 the least-significant.  xreg1 similarly overlays reg2 and reg3,
 810      * and so on.
 811      *
 812      * These registers were introduced in OpenFlow 1.5, but EXT-244 in the ONF
 813      * JIRA also publishes them as a (draft) OpenFlow extension to OpenFlow
 814      * 1.3.
 815      *
 816      * Type: be64.
 817      * Maskable: bitwise.
 818      * Formatting: hexadecimal.
 819      * Prerequisites: none.
 820      * Access: read/write.
 821      * NXM: none.
 822      * OXM: OXM_OF_PKT_REG<N>(<N>) since OF1.3 and v2.4.
 823      */
 824     MFF_XREG0,
 825     MFF_XREG1,
 826     MFF_XREG2,
 827     MFF_XREG3,
 828 #else
 829 #error "Need to update MFF_REG* to match FLOW_N_XREGS"
 830 #endif
 831
 832 /* ## -------- ## */
 833 /* ## Ethernet ## */
 834 /* ## -------- ## */
 835
 836     /* "eth_src" (aka "dl_src").
 837      *
 838      * Source address in Ethernet header.
 839      *
 840      * This field was not maskable before Open vSwitch 1.8.
 841      *
 842      * Type: MAC.
 843      * Maskable: bitwise.
 844      * Formatting: Ethernet.
 845      * Prerequisites: none.
 846      * Access: read/write.
 847      * NXM: NXM_OF_ETH_SRC(2) since v1.1.
 848      * OXM: OXM_OF_ETH_SRC(4) since OF1.2 and v1.7.
 849      * OF1.0: exact match.
 850      * OF1.1: bitwise mask.
 851      */
 852     MFF_ETH_SRC,
 853
 854     /* "eth_dst" (aka "dl_dst").
 855      *
 856      * Destination address in Ethernet header.
 857      *
 858      * Before Open vSwitch 1.8, the allowed masks were restricted to
 859      * 00:00:00:00:00:00, fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00,
 860      * ff:ff:ff:ff:ff:ff.
 861      *
 862      * Type: MAC.
 863      * Maskable: bitwise.
 864      * Formatting: Ethernet.
 865      * Prerequisites: none.
 866      * Access: read/write.
 867      * NXM: NXM_OF_ETH_DST(1) since v1.1.
 868      * OXM: OXM_OF_ETH_DST(3) since OF1.2 and v1.7.
 869      * OF1.0: exact match.
 870      * OF1.1: bitwise mask.
 871      */
 872     MFF_ETH_DST,
 873
 874     /* "eth_type" (aka "dl_type").
 875      *
 876      * Packet's Ethernet type.
 877      *
 878      * For an Ethernet II packet this is taken from the Ethernet header.  For
 879      * an 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP
 880      * header.  A packet that has neither format has value 0x05ff
 881      * (OFP_DL_TYPE_NOT_ETH_TYPE).
 882      *
 883      * For a packet with an 802.1Q header, this is the type of the encapsulated
 884      * frame.
 885      *
 886      * Type: be16.
 887      * Maskable: no.
 888      * Formatting: hexadecimal.
 889      * Prerequisites: none.
 890      * Access: read-only.
 891      * NXM: NXM_OF_ETH_TYPE(3) since v1.1.
 892      * OXM: OXM_OF_ETH_TYPE(5) since OF1.2 and v1.7.
 893      * OF1.0: exact match.
 894      * OF1.1: exact match.
 895      */
 896     MFF_ETH_TYPE,
 897
 898 /* ## ---- ## */
 899 /* ## VLAN ## */
 900 /* ## ---- ## */
 901
 902 /* It looks odd for vlan_tci, vlan_vid, and vlan_pcp to say that they are
 903  * supported in OF1.0 and OF1.1, since the detailed semantics of these fields
 904  * only apply to NXM or OXM.  They are marked as supported for exact matches in
 905  * OF1.0 and OF1.1 because exact matches on those fields can be successfully
 906  * translated into the OF1.0 and OF1.1 flow formats. */
 907
 908     /* "vlan_tci".
 909      *
 910      * 802.1Q TCI.
 911      *
 912      * For a packet with an 802.1Q header, this is the Tag Control Information
 913      * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
 914      * header, this has value 0.
 915      *
 916      * This field can be used in various ways:
 917      *
 918      *   - If it is not constrained at all, the nx_match matches packets
 919      *     without an 802.1Q header or with an 802.1Q header that has any TCI
 920      *     value.
 921      *
 922      *   - Testing for an exact match with 0 matches only packets without an
 923      *     802.1Q header.
 924      *
 925      *   - Testing for an exact match with a TCI value with CFI=1 matches
 926      *     packets that have an 802.1Q header with a specified VID and PCP.
 927      *
 928      *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
 929      *     not make sense.  The switch may reject this combination.
 930      *
 931      *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
 932      *     packets that have an 802.1Q header with that VID (and any PCP).
 933      *
 934      *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
 935      *     packets that have an 802.1Q header with that PCP (and any VID).
 936      *
 937      *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no
 938      *     802.1Q header or with an 802.1Q header with a VID of 0.
 939      *
 940      *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no
 941      *     802.1Q header or with an 802.1Q header with a PCP of 0.
 942      *
 943      *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no
 944      *     802.1Q header or with an 802.1Q header with both VID and PCP of 0.
 945      *
 946      * Type: be16.
 947      * Maskable: bitwise.
 948      * Formatting: hexadecimal.
 949      * Prerequisites: none.
 950      * Access: read/write.
 951      * NXM: NXM_OF_VLAN_TCI(4) since v1.1.
 952      * OXM: none.
 953      * OF1.0: exact match.
 954      * OF1.1: exact match.
 955      */
 956     MFF_VLAN_TCI,
 957
 958     /* "dl_vlan" (OpenFlow 1.0).
 959      *
 960      * VLAN ID field.  Zero if no 802.1Q header is present.
 961      *
 962      * Type: be16 (low 12 bits).
 963      * Maskable: no.
 964      * Formatting: decimal.
 965      * Prerequisites: none.
 966      * Access: read/write.
 967      * NXM: none.
 968      * OXM: none.
 969      * OF1.0: exact match.
 970      * OF1.1: exact match.
 971      */
 972     MFF_DL_VLAN,
 973
 974     /* "vlan_vid" (OpenFlow 1.2+).
 975      *
 976      * If an 802.1Q header is present, this field's value is 0x1000
 977      * bitwise-or'd with the VLAN ID.  If no 802.1Q is present, this field's
 978      * value is 0.
 979      *
 980      * Type: be16 (low 12 bits).
 981      * Maskable: bitwise.
 982      * Formatting: decimal.
 983      * Prerequisites: none.
 984      * Access: read/write.
 985      * NXM: none.
 986      * OXM: OXM_OF_VLAN_VID(6) since OF1.2 and v1.7.
 987      * OF1.0: exact match.
 988      * OF1.1: exact match.
 989      */
 990     MFF_VLAN_VID,
 991
 992     /* "dl_vlan_pcp" (OpenFlow 1.0).
 993      *
 994      * VLAN priority (PCP) field.  Zero if no 802.1Q header is present.
 995      *
 996      * Type: u8 (low 3 bits).
 997      * Maskable: no.
 998      * Formatting: decimal.
 999      * Prerequisites: none.
1000      * Access: read/write.
1001      * NXM: none.
1002      * OXM: none.
1003      * OF1.0: exact match.
1004      * OF1.1: exact match.
1005      */
1006     MFF_DL_VLAN_PCP,
1007
1008     /* "vlan_pcp" (OpenFlow 1.2+).
1009      *
1010      * VLAN priority (PCP) field.  Zero if no 802.1Q header is present.
1011      *
1012      * Type: u8 (low 3 bits).
1013      * Maskable: no.
1014      * Formatting: decimal.
1015      * Prerequisites: VLAN VID.
1016      * Access: read/write.
1017      * NXM: none.
1018      * OXM: OXM_OF_VLAN_PCP(7) since OF1.2 and v1.7.
1019      * OF1.0: exact match.
1020      * OF1.1: exact match.
1021      */
1022     MFF_VLAN_PCP,
1023
1024 /* ## ---- ## */
1025 /* ## MPLS ## */
1026 /* ## ---- ## */
1027
1028     /* "mpls_label".
1029      *
1030      * The outermost MPLS label, or 0 if no MPLS labels are present.
1031      *
1032      * Type: be32 (low 20 bits).
1033      * Maskable: no.
1034      * Formatting: decimal.
1035      * Prerequisites: MPLS.
1036      * Access: read/write.
1037      * NXM: none.
1038      * OXM: OXM_OF_MPLS_LABEL(34) since OF1.2 and v1.11.
1039      * OF1.1: exact match.
1040      */
1041     MFF_MPLS_LABEL,
1042
1043     /* "mpls_tc".
1044      *
1045      * The outermost MPLS label's traffic control (TC) field, or 0 if no MPLS
1046      * labels are present.
1047      *
1048      * Type: u8 (low 3 bits).
1049      * Maskable: no.
1050      * Formatting: decimal.
1051      * Prerequisites: MPLS.
1052      * Access: read/write.
1053      * NXM: none.
1054      * OXM: OXM_OF_MPLS_TC(35) since OF1.2 and v1.11.
1055      * OF1.1: exact match.
1056      */
1057     MFF_MPLS_TC,
1058
1059     /* "mpls_bos".
1060      *
1061      * The outermost MPLS label's bottom of stack (BoS) field, or 0 if no MPLS
1062      * labels are present.
1063      *
1064      * Type: u8 (low 1 bits).
1065      * Maskable: no.
1066      * Formatting: decimal.
1067      * Prerequisites: MPLS.
1068      * Access: read-only.
1069      * NXM: none.
1070      * OXM: OXM_OF_MPLS_BOS(36) since OF1.3 and v1.11.
1071      */
1072     MFF_MPLS_BOS,
1073
1074 /* ## ---- ## */
1075 /* ## IPv4 ## */
1076 /* ## ---- ## */
1077
1078 /* Update mf_is_l3_or_higher() if MFF_IPV4_SRC is no longer the first element
1079  * for a field of layer 3 or higher */
1080
1081     /* "ip_src" (aka "nw_src").
1082      *
1083      * The source address in the IPv4 header.
1084      *
1085      * Before Open vSwitch 1.8, only CIDR masks were supported.
1086      *
1087      * Type: be32.
1088      * Maskable: bitwise.
1089      * Formatting: IPv4.
1090      * Prerequisites: IPv4.
1091      * Access: read/write.
1092      * NXM: NXM_OF_IP_SRC(7) since v1.1.
1093      * OXM: OXM_OF_IPV4_SRC(11) since OF1.2 and v1.7.
1094      * OF1.0: CIDR mask.
1095      * OF1.1: bitwise mask.
1096      * Prefix lookup member: nw_src.
1097      */
1098     MFF_IPV4_SRC,
1099
1100     /* "ip_dst" (aka "nw_dst").
1101      *
1102      * The destination address in the IPv4 header.
1103      *
1104      * Before Open vSwitch 1.8, only CIDR masks were supported.
1105      *
1106      * Type: be32.
1107      * Maskable: bitwise.
1108      * Formatting: IPv4.
1109      * Prerequisites: IPv4.
1110      * Access: read/write.
1111      * NXM: NXM_OF_IP_DST(8) since v1.1.
1112      * OXM: OXM_OF_IPV4_DST(12) since OF1.2 and v1.7.
1113      * OF1.0: CIDR mask.
1114      * OF1.1: bitwise mask.
1115      * Prefix lookup member: nw_dst.
1116      */
1117     MFF_IPV4_DST,
1118
1119 /* ## ---- ## */
1120 /* ## IPv6 ## */
1121 /* ## ---- ## */
1122
1123     /* "ipv6_src".
1124      *
1125      * The source address in the IPv6 header.
1126      *
1127      * Type: be128.
1128      * Maskable: bitwise.
1129      * Formatting: IPv6.
1130      * Prerequisites: IPv6.
1131      * Access: read/write.
1132      * NXM: NXM_NX_IPV6_SRC(19) since v1.1.
1133      * OXM: OXM_OF_IPV6_SRC(26) since OF1.2 and v1.1.
1134      * Prefix lookup member: ipv6_src.
1135      */
1136     MFF_IPV6_SRC,
1137
1138     /* "ipv6_dst".
1139      *
1140      * The destination address in the IPv6 header.
1141      *
1142      * Type: be128.
1143      * Maskable: bitwise.
1144      * Formatting: IPv6.
1145      * Prerequisites: IPv6.
1146      * Access: read/write.
1147      * NXM: NXM_NX_IPV6_DST(20) since v1.1.
1148      * OXM: OXM_OF_IPV6_DST(27) since OF1.2 and v1.1.
1149      * Prefix lookup member: ipv6_dst.
1150      */
1151     MFF_IPV6_DST,
1152
1153     /* "ipv6_label".
1154      *
1155      * The flow label in the IPv6 header.
1156      *
1157      * Type: be32 (low 20 bits).
1158      * Maskable: bitwise.
1159      * Formatting: hexadecimal.
1160      * Prerequisites: IPv6.
1161      * Access: read/write.
1162      * NXM: NXM_NX_IPV6_LABEL(27) since v1.4.
1163      * OXM: OXM_OF_IPV6_FLABEL(28) since OF1.2 and v1.7.
1164      */
1165     MFF_IPV6_LABEL,
1166
1167 /* ## ----------------------- ## */
1168 /* ## IPv4/IPv6 common fields ## */
1169 /* ## ----------------------- ## */
1170
1171     /* "nw_proto" (aka "ip_proto").
1172      *
1173      * The "protocol" byte in the IPv4 or IPv6 header.
1174      *
1175      * Type: u8.
1176      * Maskable: no.
1177      * Formatting: decimal.
1178      * Prerequisites: IPv4/IPv6.
1179      * Access: read-only.
1180      * NXM: NXM_OF_IP_PROTO(6) since v1.1.
1181      * OXM: OXM_OF_IP_PROTO(10) since OF1.2 and v1.7.
1182      * OF1.0: exact match.
1183      * OF1.1: exact match.
1184      */
1185     MFF_IP_PROTO,
1186
1187 /* Both views of the DSCP below are marked as supported in all of the versions
1188  * of OpenFlow because a match on either view can be successfully translated
1189  * into every OpenFlow flow format. */
1190
1191     /* "nw_tos" (OpenFlow 1.0/1.1).
1192      *
1193      * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6
1194      * header, with the ECN bits forced to 0.  (That is, bits 2-7 contain the
1195      * type of service and bits 0-1 are zero.)
1196      *
1197      * Type: u8.
1198      * Maskable: no.
1199      * Formatting: decimal.
1200      * Prerequisites: IPv4/IPv6.
1201      * Access: read/write.
1202      * NXM: NXM_OF_IP_TOS(5) since v1.1.
1203      * OXM: none.
1204      * OF1.0: exact match.
1205      * OF1.1: exact match.
1206      */
1207     MFF_IP_DSCP,
1208
1209     /* "ip_dscp" (OpenFlow 1.2+).
1210      *
1211      * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6
1212      * header, shifted right 2 bits.  (That is, bits 0-5 contain the type of
1213      * service and bits 6-7 are zero.)
1214      *
1215      * Type: u8 (low 6 bits).
1216      * Maskable: no.
1217      * Formatting: decimal.
1218      * Prerequisites: IPv4/IPv6.
1219      * Access: read/write.
1220      * NXM: none.
1221      * OXM: OXM_OF_IP_DSCP(8) since OF1.2 and v1.7.
1222      * OF1.0: exact match.
1223      * OF1.1: exact match.
1224      */
1225     MFF_IP_DSCP_SHIFTED,
1226
1227     /* "nw_ecn" (aka "ip_ecn").
1228      *
1229      * The ECN bits in the IPv4 or IPv6 header.
1230      *
1231      * Type: u8 (low 2 bits).
1232      * Maskable: no.
1233      * Formatting: decimal.
1234      * Prerequisites: IPv4/IPv6.
1235      * Access: read/write.
1236      * NXM: NXM_NX_IP_ECN(28) since v1.4.
1237      * OXM: OXM_OF_IP_ECN(9) since OF1.2 and v1.7.
1238      */
1239     MFF_IP_ECN,
1240
1241     /* "nw_ttl".
1242      *
1243      * The time-to-live (TTL) in the IPv4 header or hop limit in the IPv6
1244      * header.
1245      *
1246      * Type: u8.
1247      * Maskable: no.
1248      * Formatting: decimal.
1249      * Prerequisites: IPv4/IPv6.
1250      * Access: read/write.
1251      * NXM: NXM_NX_IP_TTL(29) since v1.4.
1252      * OXM: none.
1253      */
1254     MFF_IP_TTL,
1255
1256     /* "ip_frag".
1257      *
1258      * IP fragment information.
1259      *
1260      * This field has three possible values:
1261      *
1262      *   - A packet that is not an IP fragment has value 0.
1263      *
1264      *   - A packet that is an IP fragment with offset 0 (the first fragment)
1265      *     has bit 0 set and thus value 1.
1266      *
1267      *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1
1268      *     set and thus value 3.
1269      *
1270      * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically
1271      * represent the meanings of bits 0 and 1.
1272      *
1273      * The switch may reject matches against values that can never appear.
1274      *
1275      * It is important to understand how this field interacts with the OpenFlow
1276      * IP fragment handling mode:
1277      *
1278      *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1279      *     before they reach the flow table, so every packet that is available
1280      *     for matching will have value 0 in this field.
1281      *
1282      *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did
1283      *     then IP fragments would be reassembled before they reached the flow
1284      *     table and again every packet available for matching would always
1285      *     have value 0.
1286      *
1287      *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but
1288      *     OpenFlow 1.0 says that fragments' transport ports are always 0, even
1289      *     for the first fragment, so this does not provide much extra
1290      *     information.
1291      *
1292      *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1293      *     fragments with offset 0, Open vSwitch makes L4 header information
1294      *     available.
1295      *
1296      * Type: u8 (low 2 bits).
1297      * Maskable: bitwise.
1298      * Formatting: frag.
1299      * Prerequisites: IPv4/IPv6.
1300      * Access: read-only.
1301      * NXM: NXM_NX_IP_FRAG(26) since v1.3.
1302      * OXM: none.
1303      */
1304     MFF_IP_FRAG,
1305
1306 /* ## --- ## */
1307 /* ## ARP ## */
1308 /* ## --- ## */
1309
1310     /* "arp_op".
1311      *
1312      * ARP opcode.
1313      *
1314      * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1315      * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1316      * matching.
1317      *
1318      * Type: be16.
1319      * Maskable: no.
1320      * Formatting: decimal.
1321      * Prerequisites: ARP.
1322      * Access: read/write.
1323      * NXM: NXM_OF_ARP_OP(15) since v1.1.
1324      * OXM: OXM_OF_ARP_OP(21) since OF1.2 and v1.7.
1325      * OF1.0: exact match.
1326      * OF1.1: exact match.
1327      */
1328     MFF_ARP_OP,
1329
1330     /* "arp_spa".
1331      *
1332      * For an Ethernet+IP ARP packet, the source protocol (IPv4) address in the
1333      * ARP header.  Always 0 otherwise.
1334      *
1335      * Before Open vSwitch 1.8, only CIDR masks were supported.
1336      *
1337      * Type: be32.
1338      * Maskable: bitwise.
1339      * Formatting: IPv4.
1340      * Prerequisites: ARP.
1341      * Access: read/write.
1342      * NXM: NXM_OF_ARP_SPA(16) since v1.1.
1343      * OXM: OXM_OF_ARP_SPA(22) since OF1.2 and v1.7.
1344      * OF1.0: CIDR mask.
1345      * OF1.1: bitwise mask.
1346      */
1347     MFF_ARP_SPA,
1348
1349     /* "arp_tpa".
1350      *
1351      * For an Ethernet+IP ARP packet, the target protocol (IPv4) address in the
1352      * ARP header.  Always 0 otherwise.
1353      *
1354      * Before Open vSwitch 1.8, only CIDR masks were supported.
1355      *
1356      * Type: be32.
1357      * Maskable: bitwise.
1358      * Formatting: IPv4.
1359      * Prerequisites: ARP.
1360      * Access: read/write.
1361      * NXM: NXM_OF_ARP_TPA(17) since v1.1.
1362      * OXM: OXM_OF_ARP_TPA(23) since OF1.2 and v1.7.
1363      * OF1.0: CIDR mask.
1364      * OF1.1: bitwise mask.
1365      */
1366     MFF_ARP_TPA,
1367
1368     /* "arp_sha".
1369      *
1370      * For an Ethernet+IP ARP packet, the source hardware (Ethernet) address in
1371      * the ARP header.  Always 0 otherwise.
1372      *
1373      * Type: MAC.
1374      * Maskable: bitwise.
1375      * Formatting: Ethernet.
1376      * Prerequisites: ARP.
1377      * Access: read/write.
1378      * NXM: NXM_NX_ARP_SHA(17) since v1.1.
1379      * OXM: OXM_OF_ARP_SHA(24) since OF1.2 and v1.7.
1380      */
1381     MFF_ARP_SHA,
1382
1383     /* "arp_tha".
1384      *
1385      * For an Ethernet+IP ARP packet, the target hardware (Ethernet) address in
1386      * the ARP header.  Always 0 otherwise.
1387      *
1388      * Type: MAC.
1389      * Maskable: bitwise.
1390      * Formatting: Ethernet.
1391      * Prerequisites: ARP.
1392      * Access: read/write.
1393      * NXM: NXM_NX_ARP_THA(18) since v1.1.
1394      * OXM: OXM_OF_ARP_THA(25) since OF1.2 and v1.7.
1395      */
1396     MFF_ARP_THA,
1397
1398 /* ## --- ## */
1399 /* ## TCP ## */
1400 /* ## --- ## */
1401
1402     /* "tcp_src" (aka "tp_src").
1403      *
1404      * TCP source port.
1405      *
1406      * Type: be16.
1407      * Maskable: bitwise.
1408      * Formatting: decimal.
1409      * Prerequisites: TCP.
1410      * Access: read/write.
1411      * NXM: NXM_OF_TCP_SRC(9) since v1.1.
1412      * OXM: OXM_OF_TCP_SRC(13) since OF1.2 and v1.7.
1413      * OF1.0: exact match.
1414      * OF1.1: exact match.
1415      */
1416     MFF_TCP_SRC,
1417
1418     /* "tcp_dst" (aka "tp_dst").
1419      *
1420      * TCP destination port.
1421      *
1422      * Type: be16.
1423      * Maskable: bitwise.
1424      * Formatting: decimal.
1425      * Prerequisites: TCP.
1426      * Access: read/write.
1427      * NXM: NXM_OF_TCP_DST(10) since v1.1.
1428      * OXM: OXM_OF_TCP_DST(14) since OF1.2 and v1.7.
1429      * OF1.0: exact match.
1430      * OF1.1: exact match.
1431      */
1432     MFF_TCP_DST,
1433
1434     /* "tcp_flags".
1435      *
1436      * Flags in the TCP header.
1437      *
1438      * TCP currently defines 9 flag bits, and additional 3 bits are reserved
1439      * (must be transmitted as zero).  See RFCs 793, 3168, and 3540.
1440      *
1441      * Type: be16 (low 12 bits).
1442      * Maskable: bitwise.
1443      * Formatting: TCP flags.
1444      * Prerequisites: TCP.
1445      * Access: read-only.
1446      * NXM: NXM_NX_TCP_FLAGS(34) since v2.1.
1447      * OXM: ONFOXM_ET_TCP_FLAGS(42) since OF1.3 and v2.4,
1448      *      OXM_OF_TCP_FLAGS(42) since OF1.5 and v2.3.
1449      */
1450     MFF_TCP_FLAGS,
1451
1452 /* ## --- ## */
1453 /* ## UDP ## */
1454 /* ## --- ## */
1455
1456     /* "udp_src".
1457      *
1458      * UDP source port.
1459      *
1460      * Type: be16.
1461      * Maskable: bitwise.
1462      * Formatting: decimal.
1463      * Prerequisites: UDP.
1464      * Access: read/write.
1465      * NXM: NXM_OF_UDP_SRC(11) since v1.1.
1466      * OXM: OXM_OF_UDP_SRC(15) since OF1.2 and v1.7.
1467      * OF1.0: exact match.
1468      * OF1.1: exact match.
1469      */
1470     MFF_UDP_SRC,
1471
1472     /* "udp_dst".
1473      *
1474      * UDP destination port
1475      *
1476      * Type: be16.
1477      * Maskable: bitwise.
1478      * Formatting: decimal.
1479      * Prerequisites: UDP.
1480      * Access: read/write.
1481      * NXM: NXM_OF_UDP_DST(12) since v1.1.
1482      * OXM: OXM_OF_UDP_DST(16) since OF1.2 and v1.7.
1483      * OF1.0: exact match.
1484      * OF1.1: exact match.
1485      */
1486     MFF_UDP_DST,
1487
1488 /* ## ---- ## */
1489 /* ## SCTP ## */
1490 /* ## ---- ## */
1491
1492     /* "sctp_src".
1493      *
1494      * SCTP source port.
1495      *
1496      * Type: be16.
1497      * Maskable: bitwise.
1498      * Formatting: decimal.
1499      * Prerequisites: SCTP.
1500      * Access: read/write.
1501      * NXM: none.
1502      * OXM: OXM_OF_SCTP_SRC(17) since OF1.2 and v2.0.
1503      * OF1.1: exact match.
1504      */
1505     MFF_SCTP_SRC,
1506
1507     /* "sctp_dst".
1508      *
1509      * SCTP destination port.
1510      *
1511      * Type: be16.
1512      * Maskable: bitwise.
1513      * Formatting: decimal.
1514      * Prerequisites: SCTP.
1515      * Access: read/write.
1516      * NXM: none.
1517      * OXM: OXM_OF_SCTP_DST(18) since OF1.2 and v2.0.
1518      * OF1.1: exact match.
1519      */
1520     MFF_SCTP_DST,
1521
1522 /* ## ---- ## */
1523 /* ## ICMP ## */
1524 /* ## ---- ## */
1525
1526     /* "icmp_type".
1527      *
1528      * ICMPv4 type.
1529      *
1530      * Type: u8.
1531      * Maskable: no.
1532      * Formatting: decimal.
1533      * Prerequisites: ICMPv4.
1534      * Access: read-only.
1535      * NXM: NXM_OF_ICMP_TYPE(13) since v1.1.
1536      * OXM: OXM_OF_ICMPV4_TYPE(19) since OF1.2 and v1.7.
1537      * OF1.0: exact match.
1538      * OF1.1: exact match.
1539      */
1540     MFF_ICMPV4_TYPE,
1541
1542     /* "icmp_code".
1543      *
1544      * ICMPv4 code.
1545      *
1546      * Type: u8.
1547      * Maskable: no.
1548      * Formatting: decimal.
1549      * Prerequisites: ICMPv4.
1550      * Access: read-only.
1551      * NXM: NXM_OF_ICMP_CODE(14) since v1.1.
1552      * OXM: OXM_OF_ICMPV4_CODE(20) since OF1.2 and v1.7.
1553      * OF1.0: exact match.
1554      * OF1.1: exact match.
1555      */
1556     MFF_ICMPV4_CODE,
1557
1558     /* "icmpv6_type".
1559      *
1560      * ICMPv6 type.
1561      *
1562      * Type: u8.
1563      * Maskable: no.
1564      * Formatting: decimal.
1565      * Prerequisites: ICMPv6.
1566      * Access: read-only.
1567      * NXM: NXM_NX_ICMPV6_TYPE(21) since v1.1.
1568      * OXM: OXM_OF_ICMPV6_TYPE(29) since OF1.2 and v1.7.
1569      */
1570     MFF_ICMPV6_TYPE,
1571
1572     /* "icmpv6_code".
1573      *
1574      * ICMPv6 code.
1575      *
1576      * Type: u8.
1577      * Maskable: no.
1578      * Formatting: decimal.
1579      * Prerequisites: ICMPv6.
1580      * Access: read-only.
1581      * NXM: NXM_NX_ICMPV6_CODE(22) since v1.1.
1582      * OXM: OXM_OF_ICMPV6_CODE(30) since OF1.2 and v1.7.
1583      */
1584     MFF_ICMPV6_CODE,
1585
1586 /* ## ------------------------- ## */
1587 /* ## ICMPv6 Neighbor Discovery ## */
1588 /* ## ------------------------- ## */
1589
1590     /* "nd_target".
1591      *
1592      * The target address in an IPv6 Neighbor Discovery message.
1593      *
1594      * Before Open vSwitch 1.8, only CIDR masks were supported.
1595      *
1596      * Type: be128.
1597      * Maskable: bitwise.
1598      * Formatting: IPv6.
1599      * Prerequisites: ND.
1600      * Access: read/write.
1601      * NXM: NXM_NX_ND_TARGET(23) since v1.1.
1602      * OXM: OXM_OF_IPV6_ND_TARGET(31) since OF1.2 and v1.7.
1603      */
1604     MFF_ND_TARGET,
1605
1606     /* "nd_sll".
1607      *
1608      * The source link layer address in an IPv6 Neighbor Discovery message.
1609      *
1610      * Type: MAC.
1611      * Maskable: bitwise.
1612      * Formatting: Ethernet.
1613      * Prerequisites: ND solicit.
1614      * Access: read/write.
1615      * NXM: NXM_NX_ND_SLL(24) since v1.1.
1616      * OXM: OXM_OF_IPV6_ND_SLL(32) since OF1.2 and v1.7.
1617      */
1618     MFF_ND_SLL,
1619
1620     /* "nd_tll".
1621      *
1622      * The target link layer address in an IPv6 Neighbor Discovery message.
1623      *
1624      * Type: MAC.
1625      * Maskable: bitwise.
1626      * Formatting: Ethernet.
1627      * Prerequisites: ND advert.
1628      * Access: read/write.
1629      * NXM: NXM_NX_ND_TLL(25) since v1.1.
1630      * OXM: OXM_OF_IPV6_ND_TLL(33) since OF1.2 and v1.7.
1631      */
1632     MFF_ND_TLL,
1633
1634     MFF_N_IDS
1635 };
1636
1637 /* A set of mf_field_ids. */
1638 struct mf_bitmap {
1639     unsigned long bm[BITMAP_N_LONGS(MFF_N_IDS)];
1640 };
1641 #define MF_BITMAP_INITIALIZER { { [0] = 0 } }
1642
1643 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
1644  * MFF_REGn cases. */
1645 #if FLOW_N_REGS == 8
1646 #define CASE_MFF_REGS                                           \
1647     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
1648     case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
1649 #else
1650 #error "Need to update CASE_MFF_REGS to match FLOW_N_REGS"
1651 #endif
1652
1653 /* Use this macro as CASE_MFF_XREGS: in a switch statement to choose all of the
1654  * MFF_REGn cases. */
1655 #if FLOW_N_XREGS == 4
1656 #define CASE_MFF_XREGS                                              \
1657     case MFF_XREG0: case MFF_XREG1: case MFF_XREG2: case MFF_XREG3
1658 #else
1659 #error "Need to update CASE_MFF_XREGS to match FLOW_N_XREGS"
1660 #endif
1661
1662 /* Use this macro as CASE_MFF_TUN_METADATA: in a switch statement to choose
1663  * all of the MFF_TUN_METADATAn cases. */
1664 #define CASE_MFF_TUN_METADATA                         \
1665     case MFF_TUN_METADATA0: case MFF_TUN_METADATA1:   \
1666     case MFF_TUN_METADATA2: case MFF_TUN_METADATA3:   \
1667     case MFF_TUN_METADATA4: case MFF_TUN_METADATA5:   \
1668     case MFF_TUN_METADATA6: case MFF_TUN_METADATA7:   \
1669     case MFF_TUN_METADATA8: case MFF_TUN_METADATA9:   \
1670     case MFF_TUN_METADATA10: case MFF_TUN_METADATA11: \
1671     case MFF_TUN_METADATA12: case MFF_TUN_METADATA13: \
1672     case MFF_TUN_METADATA14: case MFF_TUN_METADATA15: \
1673     case MFF_TUN_METADATA16: case MFF_TUN_METADATA17: \
1674     case MFF_TUN_METADATA18: case MFF_TUN_METADATA19: \
1675     case MFF_TUN_METADATA20: case MFF_TUN_METADATA21: \
1676     case MFF_TUN_METADATA22: case MFF_TUN_METADATA23: \
1677     case MFF_TUN_METADATA24: case MFF_TUN_METADATA25: \
1678     case MFF_TUN_METADATA26: case MFF_TUN_METADATA27: \
1679     case MFF_TUN_METADATA28: case MFF_TUN_METADATA29: \
1680     case MFF_TUN_METADATA30: case MFF_TUN_METADATA31: \
1681     case MFF_TUN_METADATA32: case MFF_TUN_METADATA33: \
1682     case MFF_TUN_METADATA34: case MFF_TUN_METADATA35: \
1683     case MFF_TUN_METADATA36: case MFF_TUN_METADATA37: \
1684     case MFF_TUN_METADATA38: case MFF_TUN_METADATA39: \
1685     case MFF_TUN_METADATA40: case MFF_TUN_METADATA41: \
1686     case MFF_TUN_METADATA42: case MFF_TUN_METADATA43: \
1687     case MFF_TUN_METADATA44: case MFF_TUN_METADATA45: \
1688     case MFF_TUN_METADATA46: case MFF_TUN_METADATA47: \
1689     case MFF_TUN_METADATA48: case MFF_TUN_METADATA49: \
1690     case MFF_TUN_METADATA50: case MFF_TUN_METADATA51: \
1691     case MFF_TUN_METADATA52: case MFF_TUN_METADATA53: \
1692     case MFF_TUN_METADATA54: case MFF_TUN_METADATA55: \
1693     case MFF_TUN_METADATA56: case MFF_TUN_METADATA57: \
1694     case MFF_TUN_METADATA58: case MFF_TUN_METADATA59: \
1695     case MFF_TUN_METADATA60: case MFF_TUN_METADATA61: \
1696     case MFF_TUN_METADATA62: case MFF_TUN_METADATA63
1697
1698 /* Prerequisites for matching a field.
1699  *
1700  * A field may only be matched if the correct lower-level protocols are also
1701  * matched.  For example, the TCP port may be matched only if the Ethernet type
1702  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
1703 enum OVS_PACKED_ENUM mf_prereqs {
1704     MFP_NONE,
1705
1706     /* L2 requirements. */
1707     MFP_ARP,
1708     MFP_VLAN_VID,
1709     MFP_IPV4,
1710     MFP_IPV6,
1711     MFP_IP_ANY,
1712
1713     /* L2.5 requirements. */
1714     MFP_MPLS,
1715
1716     /* L2+L3 requirements. */
1717     MFP_TCP,                    /* On IPv4 or IPv6. */
1718     MFP_UDP,                    /* On IPv4 or IPv6. */
1719     MFP_SCTP,                   /* On IPv4 or IPv6. */
1720     MFP_ICMPV4,
1721     MFP_ICMPV6,
1722
1723     /* L2+L3+L4 requirements. */
1724     MFP_ND,
1725     MFP_ND_SOLICIT,
1726     MFP_ND_ADVERT
1727 };
1728
1729 /* Forms of partial-field masking allowed for a field.
1730  *
1731  * Every field may be masked as a whole. */
1732 enum OVS_PACKED_ENUM mf_maskable {
1733     MFM_NONE,                   /* No sub-field masking. */
1734     MFM_FULLY,                  /* Every bit is individually maskable. */
1735 };
1736
1737 /* How to format or parse a field's value. */
1738 enum OVS_PACKED_ENUM mf_string {
1739     /* Integer formats.
1740      *
1741      * The particular MFS_* constant sets the output format.  On input, either
1742      * decimal or hexadecimal (prefixed with 0x) is accepted. */
1743     MFS_DECIMAL,
1744     MFS_HEXADECIMAL,
1745
1746     /* Other formats. */
1747     MFS_CT_STATE,               /* Connection tracking state */
1748     MFS_ETHERNET,
1749     MFS_IPV4,
1750     MFS_IPV6,
1751     MFS_OFP_PORT,               /* 16-bit OpenFlow 1.0 port number or name. */
1752     MFS_OFP_PORT_OXM,           /* 32-bit OpenFlow 1.1+ port number or name. */
1753     MFS_FRAG,                   /* no, yes, first, later, not_later */
1754     MFS_TNL_FLAGS,              /* FLOW_TNL_F_* flags */
1755     MFS_TCP_FLAGS,              /* TCP_* flags */
1756 };
1757
1758 struct mf_field {
1759     /* Identification. */
1760     enum mf_field_id id;        /* MFF_*. */
1761     const char *name;           /* Name of this field, e.g. "eth_type". */
1762     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
1763
1764     /* Size.
1765      *
1766      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
1767      *
1768      *     - "dl_vlan" is 2 bytes but only 12 bits.
1769      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
1770      *     - "is_frag" is 1 byte but only 2 bits.
1771      *     - "ipv6_label" is 4 bytes but only 20 bits.
1772      *     - "mpls_label" is 4 bytes but only 20 bits.
1773      *     - "mpls_tc"    is 1 byte but only 3 bits.
1774      *     - "mpls_bos"   is 1 byte but only 1 bit.
1775      */
1776     unsigned int n_bytes;       /* Width of the field in bytes. */
1777     unsigned int n_bits;        /* Number of significant bits in field. */
1778     bool variable_len;          /* Length is variable, if so width is max. */
1779
1780     /* Properties. */
1781     enum mf_maskable maskable;
1782     enum mf_string string;
1783     enum mf_prereqs prereqs;
1784     bool writable;              /* May be written by actions? */
1785
1786     /* Usable protocols.
1787      *
1788      * NXM and OXM are extensible, allowing later extensions to be sent in
1789      * earlier protocol versions, so this does not necessarily correspond to
1790      * the OpenFlow protocol version the field was introduced in.
1791      * Also, some field types are tranparently mapped to each other via the
1792      * struct flow (like vlan and dscp/tos fields), so each variant supports
1793      * all protocols.
1794      *
1795      * These are combinations of OFPUTIL_P_*.  (They are not declared as type
1796      * enum ofputil_protocol because that would give meta-flow.h and ofp-util.h
1797      * a circular dependency.) */
1798     uint32_t usable_protocols_exact;   /* Matching or setting whole field. */
1799     uint32_t usable_protocols_cidr;    /* Matching a CIDR mask in field. */
1800     uint32_t usable_protocols_bitwise; /* Matching arbitrary bits in field. */
1801
1802     int flow_be32ofs;  /* Field's be32 offset in "struct flow", if prefix tree
1803                         * lookup is supported for the field, or -1. */
1804 };
1805
1806 /* The representation of a field's value. */
1807 union mf_value {
1808     uint8_t tun_metadata[128];
1809     struct in6_addr ipv6;
1810     struct eth_addr mac;
1811     ovs_be128 be128;
1812     ovs_be64 be64;
1813     ovs_be32 be32;
1814     ovs_be16 be16;
1815     uint8_t u8;
1816 };
1817 BUILD_ASSERT_DECL(sizeof(union mf_value) == 128);
1818 BUILD_ASSERT_DECL(sizeof(union mf_value) >= GENEVE_MAX_OPT_SIZE);
1819
1820 /* A const mf_value with all bits initialized to ones. */
1821 extern const union mf_value exact_match_mask;
1822
1823 /* Part of a field. */
1824 struct mf_subfield {
1825     const struct mf_field *field;
1826     unsigned int ofs;           /* Bit offset. */
1827     unsigned int n_bits;        /* Number of bits. */
1828 };
1829
1830 /* Data for some part of an mf_field.
1831  *
1832  * The data is stored "right-justified".  For example, if "union mf_subvalue
1833  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
1834  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
1835 union mf_subvalue {
1836     /* Access to full data. */
1837     uint8_t u8[128];
1838     ovs_be16 be16[64];
1839     ovs_be32 be32[32];
1840     ovs_be64 be64[16];
1841
1842     /* Convenient access to just least-significant bits in various forms. */
1843     struct {
1844         ovs_be64 dummy_integer[15];
1845         ovs_be64 integer;
1846     };
1847     struct {
1848         uint8_t dummy_mac[122];
1849         struct eth_addr mac;
1850     };
1851     struct {
1852         ovs_be32 dummy_ipv4[31];
1853         ovs_be32 ipv4;
1854     };
1855     struct {
1856         struct in6_addr dummy_ipv6[7];
1857         struct in6_addr ipv6;
1858     };
1859 };
1860 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
1861
1862 bool mf_subvalue_intersect(const union mf_subvalue *a_value,
1863                            const union mf_subvalue *a_mask,
1864                            const union mf_subvalue *b_value,
1865                            const union mf_subvalue *b_mask,
1866                            union mf_subvalue *dst_value,
1867                            union mf_subvalue *dst_mask);
1868 int mf_subvalue_width(const union mf_subvalue *);
1869 void mf_subvalue_shift(union mf_subvalue *, int n);
1870
1871 /* An array of fields with values */
1872 struct field_array {
1873     struct mf_bitmap used;
1874     union mf_value value[MFF_N_IDS];
1875 };
1876
1877 /* Finding mf_fields. */
1878 const struct mf_field *mf_from_name(const char *name);
1879
1880 static inline const struct mf_field *
1881 mf_from_id(enum mf_field_id id)
1882 {
1883     extern const struct mf_field mf_fields[MFF_N_IDS];
1884     ovs_assert((unsigned int) id < MFF_N_IDS);
1885     return &mf_fields[id];
1886 }
1887
1888 /* Inspecting wildcarded bits. */
1889 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
1890
1891 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
1892 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
1893                  union mf_value *mask);
1894
1895 /* Prerequisites. */
1896 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
1897 void mf_mask_field_and_prereqs(const struct mf_field *,
1898                                struct flow_wildcards *);
1899 void mf_bitmap_set_field_and_prereqs(const struct mf_field *mf, struct
1900                                      mf_bitmap *bm);
1901
1902 static inline bool
1903 mf_is_l3_or_higher(const struct mf_field *mf)
1904 {
1905     return mf->id >= MFF_IPV4_SRC;
1906 }
1907
1908 /* Field values. */
1909 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
1910
1911 void mf_get_value(const struct mf_field *, const struct flow *,
1912                   union mf_value *value);
1913 void mf_set_value(const struct mf_field *, const union mf_value *value,
1914                   struct match *, char **err_str);
1915 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
1916                        struct flow *);
1917 void mf_set_flow_value_masked(const struct mf_field *,
1918                               const union mf_value *value,
1919                               const union mf_value *mask,
1920                               struct flow *);
1921 bool mf_is_tun_metadata(const struct mf_field *);
1922 bool mf_is_set(const struct mf_field *, const struct flow *);
1923 void mf_mask_field(const struct mf_field *, struct flow *);
1924 int mf_field_len(const struct mf_field *, const union mf_value *value,
1925                  const union mf_value *mask, bool *is_masked);
1926
1927 void mf_get(const struct mf_field *, const struct match *,
1928             union mf_value *value, union mf_value *mask);
1929
1930 /* Returns the set of usable protocols. */
1931 uint32_t mf_set(const struct mf_field *, const union mf_value *value,
1932                 const union mf_value *mask, struct match *, char **err_str);
1933
1934 void mf_set_wild(const struct mf_field *, struct match *, char **err_str);
1935
1936 /* Subfields. */
1937 void mf_write_subfield_flow(const struct mf_subfield *,
1938                             const union mf_subvalue *, struct flow *);
1939 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
1940                        struct match *);
1941 void mf_mask_subfield(const struct mf_field *,
1942                       const union mf_subvalue *value,
1943                       const union mf_subvalue *mask,
1944                       struct match *);
1945
1946 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
1947                       union mf_subvalue *);
1948 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
1949
1950
1951 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
1952 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
1953
1954 /* Parsing and formatting. */
1955 char *mf_parse(const struct mf_field *, const char *,
1956                union mf_value *value, union mf_value *mask);
1957 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
1958 void mf_format(const struct mf_field *,
1959                const union mf_value *value, const union mf_value *mask,
1960                struct ds *);
1961 void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s);
1962
1963 /* Field Arrays. */
1964 void field_array_set(enum mf_field_id id, const union mf_value *,
1965                      struct field_array *);
1966
1967 #endif /* meta-flow.h */