X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=lib%2Fmeta-flow.h;h=d6ffdfa6518db3d126cd7ca8e42f19b2c3054a23;hb=HEAD;hp=cf9255651dc5e8f6d7371c82f62f8def8581391e;hpb=13751fd88c4b7464f9453c03659201c10b3b87a0;p=cascardo%2Fovs.git diff --git a/lib/meta-flow.h b/lib/meta-flow.h index cf9255651..d6ffdfa65 100644 --- a/lib/meta-flow.h +++ b/lib/meta-flow.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011, 2012, 2013 Nicira, Inc. + * Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,162 +20,1769 @@ #include #include #include +#include "bitmap.h" #include "flow.h" #include "ofp-errors.h" -#include "ofp-util.h" #include "packets.h" #include "util.h" struct ds; struct match; -/* The comment on each of these indicates the member in "union mf_value" used - * to represent its value. */ +/* Open vSwitch fields + * =================== + * + * A "field" is a property of a packet. Most familiarly, "data fields" are + * fields that can be extracted from a packet. + * + * Some data fields are always present as a consequence of the basic networking + * technology in use. Ethernet is the assumed base technology for current + * versions of OpenFlow and Open vSwitch, so Ethernet header fields are always + * available. + * + * Other data fields are not always present. A packet contains ARP fields, for + * example, only when its Ethernet header indicates the Ethertype for ARP, + * 0x0806. We say that a field is "applicable" when it is it present in a + * packet, and "inapplicable" when it is not, and refer to the conditions that + * determine whether a field is applicable as "prerequisites". Some + * VLAN-related fields are a special case: these fields are always applicable, + * but have a designated value or bit that indicates whether a VLAN header is + * present, with the remaining values or bits indicating the VLAN header's + * content (if it is present). See MFF_VLAN_TCI for an example. + * + * Conceptually, an inapplicable field does not have a value, not even a + * nominal ``value'' such as all-zero-bits. In many circumstances, OpenFlow + * and Open vSwitch allow references only to applicable fields. For example, + * one may match a given field only if the match includes the field's + * prerequisite, e.g. matching an ARP field is only allowed if one also matches + * on Ethertype 0x0806. + * + * (Practically, however, OVS represents a field's value as some fixed member + * in its "struct flow", so accessing that member will obtain some value. Some + * members are used for more than one purpose, e.g. the "tp_src" member + * represents the TCP, UDP, and SCTP source port, so the value read may not + * even make sense. For this reason, it is important to know whether a field's + * prerequisites are satisfied before attempting to read it.) + * + * Sometimes a packet may contain multiple instances of a header. For example, + * a packet may contain multiple VLAN or MPLS headers, and tunnels can cause + * any data field to recur. OpenFlow and Open vSwitch do not address these + * cases uniformly. For VLAN and MPLS headers, only the outermost header is + * accessible, so that inner headers may be accessed only by ``popping'' + * (removing) the outer header. (Open vSwitch supports only a single VLAN + * header in any case.) For tunnels, e.g. GRE or VXLAN, the outer header and + * inner headers are treated as different data fields. + * + * OpenFlow and Open vSwitch support some fields other than data fields. + * "Metadata fields" relate to the origin or treatment of a packet, but they + * are not extracted from the packet data itself. One example is the physical + * port on which a packet arrived at the switch. "Register fields" act like + * variables: they give an OpenFlow switch space for temporary storage while + * processing a packet. Existing metadata and register fields have no + * prerequisites. + * + * A field's value consists of an integral number of bytes. Most data fields + * are copied directly from protocol headers, e.g. at layer 2, MFF_ETH_SRC is + * copied from the Ethernet source address and MFF_ETH_DST from the destination + * address. Other data fields are copied from a packet with padding, usually + * with zeros and in the most significant positions (see e.g. MFF_MPLS_LABEL) + * but not always (see e.g. MFF_IP_DSCP). A final category of data fields is + * transformed in other ways as they are copied from the packets, to make them + * more useful for matching, e.g. MFF_IP_FRAG describes whether a packet is a + * fragment but it is not copied directly from the IP header. + * + * + * Field specifications + * ==================== + * + * Each of the enumeration values below represents a field. The comments + * preceding each enum must be in a stylized form that is parsed at compile + * time by the extract-ofp-fields program. The comment itself consists of a + * series of paragraphs separate by blank lines. The paragraphs consist of: + * + * - The first paragraph gives the user-visible name of the field as a + * quoted string. This is the name used for parsing and formatting the + * field. + * + * For historical reasons, some fields have an additional name that is + * accepted as an alternative in parsing. This name, when there is one, + * is given as a quoted string in parentheses along with "aka". For + * example: + * + * "tun_id" (aka "tunnel_id"). + * + * New fields should have only one name. + * + * - Any number of paragraphs of free text that describe the field. This + * is meant for human readers, so extract-ofp-fields ignores it. + * + * - A final paragraph that consists of a series of key-value pairs, one + * per line, in the form "key: value." where the period at the end of the + * line is a mandatory part of the syntax. + * + * Every field must specify the following key-value pairs: + * + * Type: + * + * The format and size of the field's value. Some possible values are + * generic: + * + * u8: A one-byte field. + * be16: A two-byte field. + * be32: A four-byte field. + * be64: An eight-byte field. + * + * The remaining values imply more about the value's semantics, though OVS + * does not currently take advantage of this additional information: + * + * MAC: A six-byte field whose value is an Ethernet address. + * IPv6: A 16-byte field whose value is an IPv6 address. + * tunnelMD: A variable length field, up to 124 bytes, that carries + * tunnel metadata. + * + * Maskable: + * + * Either "bitwise", if OVS supports matching any subset of bits in the + * field, or "no", if OVS only supports matching or wildcarding the entire + * field. + * + * Formatting: + * + * Explains how a field's value is formatted and parsed for human + * consumption. Some of the options are fairly generally useful: + * + * decimal: Formats the value as a decimal number. On parsing, accepts + * decimal (with no prefix), hexadecimal with 0x prefix, or octal + * with 0 prefix. + * + * hexadecimal: Same as decimal except nonzero values are formatted in + * hex with 0x prefix. The default for parsing is *not* hexadecimal: + * only with a 0x prefix is the input in hexadecimal. + * + * Ethernet: Formats and accepts the common format xx:xx:xx:xx:xx:xx. + * 6-byte fields only. + * + * IPv4: Formats and accepts the common format w.x.y.z. 4-byte fields + * only. + * + * IPv6: Formats and accepts the common IPv6 formats. 16-byte fields + * only. + * + * OpenFlow 1.0 port: Accepts an OpenFlow well-known port name + * (e.g. "IN_PORT") in uppercase or lowercase, or a 16-bit port + * number in decimal. Formats ports using their well-known names in + * uppercase, or in decimal otherwise. 2-byte fields only. + * + * OpenFlow 1.1+ port: Same syntax as for OpenFlow 1.0 ports but for + * 4-byte OpenFlow 1.1+ port number fields. + * + * Others are very specific to particular fields: + * + * frag: One of the strings "no", "first", "later", "yes", "not_later" + * describing which IPv4/v6 fragments are matched. + * + * tunnel flags: Any number of the strings "df", "csum", "key", or + * "oam" separated by "|". + * + * TCP flags: See the description of tcp_flags in ovs-ofctl(8). + * + * Prerequisites: + * + * The field's prerequisites. The values should be straightfoward. + * + * Access: + * + * Either "read-only", for a field that cannot be changed via OpenFlow, or + * "read/write" for a modifiable field. + * + * NXM: + * + * If the field has an NXM field assignment, then this specifies the NXM + * name of the field (e.g. "NXM_OF_ETH_SRC"), followed by its nxm_type in + * parentheses, followed by "since v." specifying the version of Open + * vSwitch that first supported this field in NXM (e.g. "since v1.1" if it + * was introduced in Open vSwitch 1.1). + * + * The NXM name must begin with NXM_OF_ or NXM_NX_. This allows OVS to + * determine the correct NXM class. + * + * If the field does not have an NXM field assignment, specify "none". + * + * OXM: + * + * If the field has an OXM field assignment, then this specifies the OXM + * name of the field (e.g. "OXM_OF_ETH_SRC"), followed by its nxm_type in + * parentheses, followed by "since OF. v." specifying the + * versions of OpenFlow and Open vSwitch that first supported this field in + * OXM (e.g. "since OF1.3 and v1.10" if it was introduced in OpenFlow 1.3 + * and first supported by Open vSwitch in version 1.10). + * + * Some fields have more than one OXM field assignment. For example, + * actset_output has an experimenter OXM assignment in OpenFlow 1.3 and a + * standard OXM assignment in OpenFlow 1.5. In such a case, specify both, + * separated by commas. + * + * OVS uses the start of the OXM field name to determine the correct OXM + * class. To support a new OXM class, edit the mapping table in + * build-aux/extract-ofp-fields. + * + * If the field does not have an OXM field assignment, specify "none". + * + * The following key-value pairs are optional. Open vSwitch already supports + * all the fields to which they apply, so new fields should probably not + * include these pairs: + * + * OF1.0: + * + * Specify this as "exact match" if OpenFlow 1.0 can match or wildcard the + * entire field, or as "CIDR mask" if OpenFlow 1.0 can match any CIDR + * prefix of the field. (OpenFlow 1.0 did not support bitwise matching.) + * Omit, if OpenFlow 1.0 did not support this field. + * + * OF1.1: + * + * Specify this as "exact match" if OpenFlow 1.1 can match or wildcard the + * entire field, or as "bitwise" if OpenFlow 1.1 can match any subset of + * bits in the field. Omit, if OpenFlow 1.1 did not support this field. + * + * The following key-value pair is optional: + * + * Prefix lookup member: + * + * If this field makes sense for use with classifier_set_prefix_fields(), + * specify the name of the "struct flow" member that corresponds to the + * field. + * + * Finally, a few "register" fields have very similar names and purposes, + * e.g. MFF_REG0 through MFF_REG7. For these, the comments may be merged + * together using as a metasyntactic variable for the numeric suffix. + * Lines in the comment that are specific to one of the particular fields by + * writing, e.g. <1>, to consider that line only for e.g. MFF_REG1. + */ + enum OVS_PACKED_ENUM mf_field_id { - /* Metadata. */ - MFF_TUN_ID, /* be64 */ - MFF_TUN_SRC, /* be32 */ - MFF_TUN_DST, /* be32 */ - MFF_TUN_FLAGS, /* be16 */ - MFF_TUN_TTL, /* u8 */ - MFF_TUN_TOS, /* u8 */ - MFF_METADATA, /* be64 */ - MFF_IN_PORT, /* be16 */ - MFF_IN_PORT_OXM, /* be32 */ - MFF_SKB_PRIORITY, /* be32 */ - MFF_PKT_MARK, /* be32 */ - -#if FLOW_N_REGS > 0 - MFF_REG0, /* be32 */ -#endif -#if FLOW_N_REGS > 1 - MFF_REG1, /* be32 */ -#endif -#if FLOW_N_REGS > 2 - MFF_REG2, /* be32 */ -#endif -#if FLOW_N_REGS > 3 - MFF_REG3, /* be32 */ -#endif -#if FLOW_N_REGS > 4 - MFF_REG4, /* be32 */ -#endif -#if FLOW_N_REGS > 5 - MFF_REG5, /* be32 */ +/* ## -------- ## */ +/* ## Metadata ## */ +/* ## -------- ## */ + + /* "dp_hash". + * + * Flow hash computed in the datapath. Internal use only, not programmable + * from controller. + * + * The OXM code point for this is an attempt to test OXM experimenter + * support, which is otherwise difficult to test due to the dearth of use + * out in the wild. Because controllers can't add flows that match on + * dp_hash, this doesn't commit OVS to supporting this OXM experimenter + * code point in the future. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_NX_DP_HASH(35) since v2.2. + * OXM: NXOXM_ET_DP_HASH(0) since OF1.5 and v2.4. + */ + MFF_DP_HASH, + + /* "recirc_id". + * + * ID for recirculation. The value 0 is reserved for initially received + * packets. Internal use only, not programmable from controller. + * + * Type: be32. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_NX_RECIRC_ID(36) since v2.2. + * OXM: none. + */ + MFF_RECIRC_ID, + + /* "conj_id". + * + * ID for "conjunction" actions. Please refer to ovs-ofctl(8) + * documentation of "conjunction" for details. + * + * Type: be32. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_NX_CONJ_ID(37) since v2.4. + * OXM: none. */ + MFF_CONJ_ID, + + /* "tun_id" (aka "tunnel_id"). + * + * The "key" or "tunnel ID" or "VNI" in a packet received via a keyed + * tunnel. For protocols in which the key is shorter than 64 bits, the key + * is stored in the low bits and the high bits are zeroed. For non-keyed + * tunnels and packets not received via a tunnel, the value is 0. + * + * Type: be64. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_ID(16) since v1.1. + * OXM: OXM_OF_TUNNEL_ID(38) since OF1.3 and v1.10. + * Prefix lookup member: tunnel.tun_id. + */ + MFF_TUN_ID, + + /* "tun_src". + * + * The IPv4 source address in the outer IP header of a tunneled packet. + * + * For non-tunneled packets, the value is 0. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_IPV4_SRC(31) since v2.0. + * OXM: none. + * Prefix lookup member: tunnel.ip_src. + */ + MFF_TUN_SRC, + + /* "tun_dst". + * + * The IPv4 destination address in the outer IP header of a tunneled + * packet. + * + * For non-tunneled packets, the value is 0. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_IPV4_DST(32) since v2.0. + * OXM: none. + * Prefix lookup member: tunnel.ip_dst. + */ + MFF_TUN_DST, + + /* "tun_ipv6_src". + * + * The IPv6 source address in the outer IP header of a tunneled packet. + * + * For non-tunneled packets, the value is 0. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: IPv6. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_IPV6_SRC(109) since v2.5. + * OXM: none. + * Prefix lookup member: tunnel.ipv6_src. + */ + MFF_TUN_IPV6_SRC, + + /* "tun_ipv6_dst". + * + * The IPv6 destination address in the outer IP header of a tunneled + * packet. + * + * For non-tunneled packets, the value is 0. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: IPv6. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_IPV6_DST(110) since v2.5. + * OXM: none. + * Prefix lookup member: tunnel.ipv6_dst. + */ + MFF_TUN_IPV6_DST, + + /* "tun_flags". + * + * Flags representing aspects of tunnel behavior. + * + * This field currently only has a single flag defined: + * + * - NX_TUN_FLAG_OAM: The tunnel protocol indicated that this is an + * OAM control packet. + * + * The switch may reject matches against values that it is not aware of. + * + * Note that it is possible for newer version of Open vSwitch to + * introduce additional flags with varying meaning. It is therefore not + * recommended to use an exact match on this field since the behavior of + * these new flags is unknown and should be ignored. + * + * For non-tunneled packets, the value is 0. + * + * Type: be16 (low 1 bits). + * Maskable: bitwise. + * Formatting: tunnel flags. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_FLAGS(104) since v2.5. + * OXM: none. + */ + MFF_TUN_FLAGS, + + /* "tun_ttl". + * + * The TTL in the outer IP header of a tunneled packet. Internal use only, + * not programmable from controller. + * + * For non-tunneled packets, the value is 0. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read-only. + * NXM: none. + * OXM: none. + */ + MFF_TUN_TTL, + + /* "tun_tos". + * + * The ToS value in the outer IP header of a tunneled packet. Internal use + * only, not programmable from controller. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read-only. + * NXM: none. + * OXM: none. + */ + MFF_TUN_TOS, + + /* "tun_gbp_id". + * + * VXLAN Group Policy ID + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_GBP_ID(38) since v2.4. + * OXM: none. + */ + MFF_TUN_GBP_ID, + + /* "tun_gbp_flags". + * + * VXLAN Group Policy flags + * + * Type: u8. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_GBP_FLAGS(39) since v2.4. + * OXM: none. + */ + MFF_TUN_GBP_FLAGS, + +#if TUN_METADATA_NUM_OPTS == 64 + /* "tun_metadata". + * + * Encapsulation metadata for tunnels. + * + * Each NXM can be dynamically mapped onto a particular tunnel field using + * OpenFlow commands. The individual NXMs can each carry up to 124 bytes + * of data and a combined total of 256 across all allocated fields. + * + * Type: tunnelMD. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_TUN_METADATA0(40) since v2.5. <0> + * NXM: NXM_NX_TUN_METADATA1(41) since v2.5. <1> + * NXM: NXM_NX_TUN_METADATA2(42) since v2.5. <2> + * NXM: NXM_NX_TUN_METADATA3(43) since v2.5. <3> + * NXM: NXM_NX_TUN_METADATA4(44) since v2.5. <4> + * NXM: NXM_NX_TUN_METADATA5(45) since v2.5. <5> + * NXM: NXM_NX_TUN_METADATA6(46) since v2.5. <6> + * NXM: NXM_NX_TUN_METADATA7(47) since v2.5. <7> + * NXM: NXM_NX_TUN_METADATA8(48) since v2.5. <8> + * NXM: NXM_NX_TUN_METADATA9(49) since v2.5. <9> + * NXM: NXM_NX_TUN_METADATA10(50) since v2.5. <10> + * NXM: NXM_NX_TUN_METADATA11(51) since v2.5. <11> + * NXM: NXM_NX_TUN_METADATA12(52) since v2.5. <12> + * NXM: NXM_NX_TUN_METADATA13(53) since v2.5. <13> + * NXM: NXM_NX_TUN_METADATA14(54) since v2.5. <14> + * NXM: NXM_NX_TUN_METADATA15(55) since v2.5. <15> + * NXM: NXM_NX_TUN_METADATA16(56) since v2.5. <16> + * NXM: NXM_NX_TUN_METADATA17(57) since v2.5. <17> + * NXM: NXM_NX_TUN_METADATA18(58) since v2.5. <18> + * NXM: NXM_NX_TUN_METADATA19(59) since v2.5. <19> + * NXM: NXM_NX_TUN_METADATA20(60) since v2.5. <20> + * NXM: NXM_NX_TUN_METADATA21(61) since v2.5. <21> + * NXM: NXM_NX_TUN_METADATA22(62) since v2.5. <22> + * NXM: NXM_NX_TUN_METADATA23(63) since v2.5. <23> + * NXM: NXM_NX_TUN_METADATA24(64) since v2.5. <24> + * NXM: NXM_NX_TUN_METADATA25(65) since v2.5. <25> + * NXM: NXM_NX_TUN_METADATA26(66) since v2.5. <26> + * NXM: NXM_NX_TUN_METADATA27(67) since v2.5. <27> + * NXM: NXM_NX_TUN_METADATA28(68) since v2.5. <28> + * NXM: NXM_NX_TUN_METADATA29(69) since v2.5. <29> + * NXM: NXM_NX_TUN_METADATA30(70) since v2.5. <30> + * NXM: NXM_NX_TUN_METADATA31(71) since v2.5. <31> + * NXM: NXM_NX_TUN_METADATA32(72) since v2.5. <32> + * NXM: NXM_NX_TUN_METADATA33(73) since v2.5. <33> + * NXM: NXM_NX_TUN_METADATA34(74) since v2.5. <34> + * NXM: NXM_NX_TUN_METADATA35(75) since v2.5. <35> + * NXM: NXM_NX_TUN_METADATA36(76) since v2.5. <36> + * NXM: NXM_NX_TUN_METADATA37(77) since v2.5. <37> + * NXM: NXM_NX_TUN_METADATA38(78) since v2.5. <38> + * NXM: NXM_NX_TUN_METADATA39(79) since v2.5. <39> + * NXM: NXM_NX_TUN_METADATA40(80) since v2.5. <40> + * NXM: NXM_NX_TUN_METADATA41(81) since v2.5. <41> + * NXM: NXM_NX_TUN_METADATA42(82) since v2.5. <42> + * NXM: NXM_NX_TUN_METADATA43(83) since v2.5. <43> + * NXM: NXM_NX_TUN_METADATA44(84) since v2.5. <44> + * NXM: NXM_NX_TUN_METADATA45(85) since v2.5. <45> + * NXM: NXM_NX_TUN_METADATA46(86) since v2.5. <46> + * NXM: NXM_NX_TUN_METADATA47(87) since v2.5. <47> + * NXM: NXM_NX_TUN_METADATA48(88) since v2.5. <48> + * NXM: NXM_NX_TUN_METADATA49(89) since v2.5. <49> + * NXM: NXM_NX_TUN_METADATA50(90) since v2.5. <50> + * NXM: NXM_NX_TUN_METADATA51(91) since v2.5. <51> + * NXM: NXM_NX_TUN_METADATA52(92) since v2.5. <52> + * NXM: NXM_NX_TUN_METADATA53(93) since v2.5. <53> + * NXM: NXM_NX_TUN_METADATA54(94) since v2.5. <54> + * NXM: NXM_NX_TUN_METADATA55(95) since v2.5. <55> + * NXM: NXM_NX_TUN_METADATA56(96) since v2.5. <56> + * NXM: NXM_NX_TUN_METADATA57(97) since v2.5. <57> + * NXM: NXM_NX_TUN_METADATA58(98) since v2.5. <58> + * NXM: NXM_NX_TUN_METADATA59(99) since v2.5. <59> + * NXM: NXM_NX_TUN_METADATA60(100) since v2.5. <60> + * NXM: NXM_NX_TUN_METADATA61(101) since v2.5. <61> + * NXM: NXM_NX_TUN_METADATA62(102) since v2.5. <62> + * NXM: NXM_NX_TUN_METADATA63(103) since v2.5. <63> + * OXM: none. + */ + MFF_TUN_METADATA0, + MFF_TUN_METADATA1, + MFF_TUN_METADATA2, + MFF_TUN_METADATA3, + MFF_TUN_METADATA4, + MFF_TUN_METADATA5, + MFF_TUN_METADATA6, + MFF_TUN_METADATA7, + MFF_TUN_METADATA8, + MFF_TUN_METADATA9, + MFF_TUN_METADATA10, + MFF_TUN_METADATA11, + MFF_TUN_METADATA12, + MFF_TUN_METADATA13, + MFF_TUN_METADATA14, + MFF_TUN_METADATA15, + MFF_TUN_METADATA16, + MFF_TUN_METADATA17, + MFF_TUN_METADATA18, + MFF_TUN_METADATA19, + MFF_TUN_METADATA20, + MFF_TUN_METADATA21, + MFF_TUN_METADATA22, + MFF_TUN_METADATA23, + MFF_TUN_METADATA24, + MFF_TUN_METADATA25, + MFF_TUN_METADATA26, + MFF_TUN_METADATA27, + MFF_TUN_METADATA28, + MFF_TUN_METADATA29, + MFF_TUN_METADATA30, + MFF_TUN_METADATA31, + MFF_TUN_METADATA32, + MFF_TUN_METADATA33, + MFF_TUN_METADATA34, + MFF_TUN_METADATA35, + MFF_TUN_METADATA36, + MFF_TUN_METADATA37, + MFF_TUN_METADATA38, + MFF_TUN_METADATA39, + MFF_TUN_METADATA40, + MFF_TUN_METADATA41, + MFF_TUN_METADATA42, + MFF_TUN_METADATA43, + MFF_TUN_METADATA44, + MFF_TUN_METADATA45, + MFF_TUN_METADATA46, + MFF_TUN_METADATA47, + MFF_TUN_METADATA48, + MFF_TUN_METADATA49, + MFF_TUN_METADATA50, + MFF_TUN_METADATA51, + MFF_TUN_METADATA52, + MFF_TUN_METADATA53, + MFF_TUN_METADATA54, + MFF_TUN_METADATA55, + MFF_TUN_METADATA56, + MFF_TUN_METADATA57, + MFF_TUN_METADATA58, + MFF_TUN_METADATA59, + MFF_TUN_METADATA60, + MFF_TUN_METADATA61, + MFF_TUN_METADATA62, + MFF_TUN_METADATA63, +#else +#error "Need to update MFF_TUN_METADATA* to match TUN_METADATA_NUM_OPTS" #endif -#if FLOW_N_REGS > 6 - MFF_REG6, /* be32 */ + + /* "metadata". + * + * A scratch pad value standardized in OpenFlow 1.1+. Initially zero, at + * the beginning of the pipeline. + * + * Type: be64. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_METADATA(2) since OF1.2 and v1.8. + * OF1.1: bitwise mask. + */ + MFF_METADATA, + + /* "in_port". + * + * 16-bit (OpenFlow 1.0) view of the physical or virtual port on which the + * packet was received. + * + * Type: be16. + * Maskable: no. + * Formatting: OpenFlow 1.0 port. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_OF_IN_PORT(0) since v1.1. + * OXM: none. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_IN_PORT, + + /* "in_port_oxm". + * + * 32-bit (OpenFlow 1.1+) view of the physical or virtual port on which the + * packet was received. + * + * Type: be32. + * Maskable: no. + * Formatting: OpenFlow 1.1+ port. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_IN_PORT(0) since OF1.2 and v1.7. + * OF1.1: exact match. + */ + MFF_IN_PORT_OXM, + + /* "actset_output". + * + * Type: be32. + * Maskable: no. + * Formatting: OpenFlow 1.1+ port. + * Prerequisites: none. + * Access: read-only. + * NXM: none. + * OXM: ONFOXM_ET_ACTSET_OUTPUT(43) since OF1.3 and v2.4, + * OXM_OF_ACTSET_OUTPUT(43) since OF1.5 and v2.4. + */ + MFF_ACTSET_OUTPUT, + + /* "skb_priority". + * + * Designates the queue to which output will be directed. The value in + * this field is not necessarily the OpenFlow queue number; with the Linux + * kernel switch, it instead has a pair of subfields designating the + * "major" and "minor" numbers of a Linux kernel qdisc handle. + * + * This field is "semi-internal" in that it can be set with the "set_queue" + * action but not matched or read or written other ways. + * + * Type: be32. + * Maskable: no. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read-only. + * NXM: none. + * OXM: none. + */ + MFF_SKB_PRIORITY, + + /* "pkt_mark". + * + * Packet metadata mark. The mark may be passed into other system + * components in order to facilitate interaction between subsystems. On + * Linux this corresponds to struct sk_buff's "skb_mark" member but the + * exact implementation is platform-dependent. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_PKT_MARK(33) since v2.0. + * OXM: none. + */ + MFF_PKT_MARK, + + /* "ct_state". + * + * Connection tracking state. The field is populated by the NXAST_CT + * action. The following bit values describe the state of the connection: + * + * - New (0x01): This is the beginning of a new connection. + * - Established (0x02): This is part of an already existing connection. + * - Related (0x04): This is a separate connection that is related to an + * existing connection. + * - Reply (0x08): This flow is in the reply direction, ie it did not + * initiate the connection. + * - Invalid (0x10): This flow could not be associated with a connection. + * This could be set for a variety of reasons, + * including (but not limited to): + * - L3/L4 protocol handler is not loaded/unavailable. + * - L3/L4 protocol handler determines that the packet + * is malformed or invalid for the current FSM stage. + * - Packets are unexpected length for protocol. + * - Tracked (0x20): Connection tracking has occurred. + * + * The "Tracked" bit corresponds to the packet_state as described in the + * description of NXAST_CT action. The remaining bits correspond to + * connection state. The "New" bit implies that the connection state + * is uncommitted, while "Established" implies that it has previously been + * committed. + * + * There are additional constraints on the ct_state bits, listed in order + * of precedence below: + * + * - If "Tracked" is unset, no other bits may be set. + * - If "Tracked" is set, one or more other bits may be set. + * - If "Invalid" is set, only the "Tracked" bit is also set. + * - The "New" and "Established" bits are mutually exclusive. + * - The "New" and "Reply" bits are mutually exclusive. + * - The "Related" bit may be set in conjunction with any other bits. + * Connections that are identified as "Related" are separate + * connections from the originating connection, so must be committed + * separately. All packets for a related connection will have the + * "Related" bit set (not just the initial packet). + * + * Type: be32. + * Maskable: bitwise. + * Formatting: ct state. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_NX_CT_STATE(105) since v2.5. + * OXM: none. + */ + MFF_CT_STATE, + + /* "ct_zone". + * + * Connection tracking zone. The field is populated by the + * NXAST_CT action. + * + * Type: be16. + * Maskable: no. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_NX_CT_ZONE(106) since v2.5. + * OXM: none. + */ + MFF_CT_ZONE, + + /* "ct_mark". + * + * Connection tracking mark. The mark is carried with the + * connection tracking state. On Linux this corresponds to the + * nf_conn's "mark" member but the exact implementation is + * platform-dependent. + * + * Writable only from nested actions within the NXAST_CT action. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_CT_MARK(107) since v2.5. + * OXM: none. + */ + MFF_CT_MARK, + + /* "ct_label". + * + * Connection tracking label. The label is carried with the + * connection tracking state. On Linux this is held in the + * conntrack label extension but the exact implementation is + * platform-dependent. + * + * Writable only from nested actions within the NXAST_CT action. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_CT_LABEL(108) since v2.5. + * OXM: none. + */ + MFF_CT_LABEL, + +#if FLOW_N_REGS == 8 + /* "reg". + * + * Nicira extension scratch pad register with initial value 0. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_NX_REG0(0) since v1.1. <0> + * NXM: NXM_NX_REG1(1) since v1.1. <1> + * NXM: NXM_NX_REG2(2) since v1.1. <2> + * NXM: NXM_NX_REG3(3) since v1.1. <3> + * NXM: NXM_NX_REG4(4) since v1.3. <4> + * NXM: NXM_NX_REG5(5) since v1.7. <5> + * NXM: NXM_NX_REG6(6) since v1.7. <6> + * NXM: NXM_NX_REG7(7) since v1.7. <7> + * OXM: none. + */ + MFF_REG0, + MFF_REG1, + MFF_REG2, + MFF_REG3, + MFF_REG4, + MFF_REG5, + MFF_REG6, + MFF_REG7, +#else +#error "Need to update MFF_REG* to match FLOW_N_REGS" #endif -#if FLOW_N_REGS > 7 - MFF_REG7, /* be32 */ + +#if FLOW_N_XREGS == 4 + /* "xreg". + * + * OpenFlow 1.5 ``extended register". Each extended register + * overlays two of the Nicira extension 32-bit registers: xreg0 overlays + * reg0 and reg1, with reg0 supplying the most-significant bits of xreg0 + * and reg1 the least-significant. xreg1 similarly overlays reg2 and reg3, + * and so on. + * + * These registers were introduced in OpenFlow 1.5, but EXT-244 in the ONF + * JIRA also publishes them as a (draft) OpenFlow extension to OpenFlow + * 1.3. + * + * Type: be64. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_PKT_REG() since OF1.3 and v2.4. + */ + MFF_XREG0, + MFF_XREG1, + MFF_XREG2, + MFF_XREG3, +#else +#error "Need to update MFF_REG* to match FLOW_N_XREGS" #endif - /* L2. */ - MFF_ETH_SRC, /* mac */ - MFF_ETH_DST, /* mac */ - MFF_ETH_TYPE, /* be16 */ - - MFF_VLAN_TCI, /* be16 */ - MFF_DL_VLAN, /* be16 (OpenFlow 1.0 compatibility) */ - MFF_VLAN_VID, /* be16 (OpenFlow 1.2 compatibility) */ - MFF_DL_VLAN_PCP, /* u8 (OpenFlow 1.0 compatibility) */ - MFF_VLAN_PCP, /* be16 (OpenFlow 1.2 compatibility) */ - - /* L2.5 */ - MFF_MPLS_LABEL, /* be32 */ - MFF_MPLS_TC, /* u8 */ - MFF_MPLS_BOS, /* u8 */ - - /* L3. */ - MFF_IPV4_SRC, /* be32 */ - MFF_IPV4_DST, /* be32 */ - - MFF_IPV6_SRC, /* ipv6 */ - MFF_IPV6_DST, /* ipv6 */ - MFF_IPV6_LABEL, /* be32 */ - - /* The IPv4/IPv6 DSCP field has two different views: - * - * - MFF_IP_DSCP has the DSCP in bits 2-7, their bit positions in the - * IPv4 and IPv6 "traffic class" field, as used in OpenFlow 1.0 and 1.1 - * flow format and in NXM's NXM_OF_IP_TOS - * - * - MFF_IP_DSCP has the DSCP in bits 0-5, shifted right two bits from - * their positions in the IPv4 and IPv6 "traffic class" field, as used - * in OpenFlow 1.2+ OXM's OXM_OF_IP_DSCP. */ - MFF_IP_PROTO, /* u8 (used for IPv4 or IPv6) */ - MFF_IP_DSCP, /* u8 (used for IPv4 or IPv6) */ - MFF_IP_DSCP_SHIFTED, /* u8 (used for IPv4 or IPv6) (OF1.2 compat) */ - MFF_IP_ECN, /* u8 (used for IPv4 or IPv6) */ - MFF_IP_TTL, /* u8 (used for IPv4 or IPv6) */ - MFF_IP_FRAG, /* u8 (used for IPv4 or IPv6) */ - - MFF_ARP_OP, /* be16 */ - MFF_ARP_SPA, /* be32 */ - MFF_ARP_TPA, /* be32 */ - MFF_ARP_SHA, /* mac */ - MFF_ARP_THA, /* mac */ - - /* L4. */ - MFF_TCP_SRC, /* be16 (used for IPv4 or IPv6) */ - MFF_TCP_DST, /* be16 (used for IPv4 or IPv6) */ - MFF_TCP_FLAGS, /* be16, 12 bits (4 MSB zeroed, - * used for IPv4 or IPv6) */ - - MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */ - MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */ - - MFF_SCTP_SRC, /* be16 (used for IPv4 or IPv6) */ - MFF_SCTP_DST, /* be16 (used for IPv4 or IPv6) */ - - MFF_ICMPV4_TYPE, /* u8 */ - MFF_ICMPV4_CODE, /* u8 */ - - MFF_ICMPV6_TYPE, /* u8 */ - MFF_ICMPV6_CODE, /* u8 */ - - /* ICMPv6 Neighbor Discovery. */ - MFF_ND_TARGET, /* ipv6 */ - MFF_ND_SLL, /* mac */ - MFF_ND_TLL, /* mac */ +/* ## -------- ## */ +/* ## Ethernet ## */ +/* ## -------- ## */ + + /* "eth_src" (aka "dl_src"). + * + * Source address in Ethernet header. + * + * This field was not maskable before Open vSwitch 1.8. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_OF_ETH_SRC(2) since v1.1. + * OXM: OXM_OF_ETH_SRC(4) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: bitwise mask. + */ + MFF_ETH_SRC, + + /* "eth_dst" (aka "dl_dst"). + * + * Destination address in Ethernet header. + * + * Before Open vSwitch 1.8, the allowed masks were restricted to + * 00:00:00:00:00:00, fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, + * ff:ff:ff:ff:ff:ff. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_OF_ETH_DST(1) since v1.1. + * OXM: OXM_OF_ETH_DST(3) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: bitwise mask. + */ + MFF_ETH_DST, + + /* "eth_type" (aka "dl_type"). + * + * Packet's Ethernet type. + * + * For an Ethernet II packet this is taken from the Ethernet header. For + * an 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP + * header. A packet that has neither format has value 0x05ff + * (OFP_DL_TYPE_NOT_ETH_TYPE). + * + * For a packet with an 802.1Q header, this is the type of the encapsulated + * frame. + * + * Type: be16. + * Maskable: no. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read-only. + * NXM: NXM_OF_ETH_TYPE(3) since v1.1. + * OXM: OXM_OF_ETH_TYPE(5) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_ETH_TYPE, + +/* ## ---- ## */ +/* ## VLAN ## */ +/* ## ---- ## */ + +/* It looks odd for vlan_tci, vlan_vid, and vlan_pcp to say that they are + * supported in OF1.0 and OF1.1, since the detailed semantics of these fields + * only apply to NXM or OXM. They are marked as supported for exact matches in + * OF1.0 and OF1.1 because exact matches on those fields can be successfully + * translated into the OF1.0 and OF1.1 flow formats. */ + + /* "vlan_tci". + * + * 802.1Q TCI. + * + * For a packet with an 802.1Q header, this is the Tag Control Information + * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q + * header, this has value 0. + * + * This field can be used in various ways: + * + * - If it is not constrained at all, the nx_match matches packets + * without an 802.1Q header or with an 802.1Q header that has any TCI + * value. + * + * - Testing for an exact match with 0 matches only packets without an + * 802.1Q header. + * + * - Testing for an exact match with a TCI value with CFI=1 matches + * packets that have an 802.1Q header with a specified VID and PCP. + * + * - Testing for an exact match with a nonzero TCI value with CFI=0 does + * not make sense. The switch may reject this combination. + * + * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches + * packets that have an 802.1Q header with that VID (and any PCP). + * + * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches + * packets that have an 802.1Q header with that PCP (and any VID). + * + * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no + * 802.1Q header or with an 802.1Q header with a VID of 0. + * + * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no + * 802.1Q header or with an 802.1Q header with a PCP of 0. + * + * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no + * 802.1Q header or with an 802.1Q header with both VID and PCP of 0. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: none. + * Access: read/write. + * NXM: NXM_OF_VLAN_TCI(4) since v1.1. + * OXM: none. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_VLAN_TCI, + + /* "dl_vlan" (OpenFlow 1.0). + * + * VLAN ID field. Zero if no 802.1Q header is present. + * + * Type: be16 (low 12 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: none. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_DL_VLAN, + + /* "vlan_vid" (OpenFlow 1.2+). + * + * If an 802.1Q header is present, this field's value is 0x1000 + * bitwise-or'd with the VLAN ID. If no 802.1Q is present, this field's + * value is 0. + * + * Type: be16 (low 12 bits). + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_VLAN_VID(6) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_VLAN_VID, + + /* "dl_vlan_pcp" (OpenFlow 1.0). + * + * VLAN priority (PCP) field. Zero if no 802.1Q header is present. + * + * Type: u8 (low 3 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: none. + * Access: read/write. + * NXM: none. + * OXM: none. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_DL_VLAN_PCP, + + /* "vlan_pcp" (OpenFlow 1.2+). + * + * VLAN priority (PCP) field. Zero if no 802.1Q header is present. + * + * Type: u8 (low 3 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: VLAN VID. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_VLAN_PCP(7) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_VLAN_PCP, + +/* ## ---- ## */ +/* ## MPLS ## */ +/* ## ---- ## */ + + /* "mpls_label". + * + * The outermost MPLS label, or 0 if no MPLS labels are present. + * + * Type: be32 (low 20 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: MPLS. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_MPLS_LABEL(34) since OF1.2 and v1.11. + * OF1.1: exact match. + */ + MFF_MPLS_LABEL, + + /* "mpls_tc". + * + * The outermost MPLS label's traffic control (TC) field, or 0 if no MPLS + * labels are present. + * + * Type: u8 (low 3 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: MPLS. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_MPLS_TC(35) since OF1.2 and v1.11. + * OF1.1: exact match. + */ + MFF_MPLS_TC, + + /* "mpls_bos". + * + * The outermost MPLS label's bottom of stack (BoS) field, or 0 if no MPLS + * labels are present. + * + * Type: u8 (low 1 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: MPLS. + * Access: read-only. + * NXM: none. + * OXM: OXM_OF_MPLS_BOS(36) since OF1.3 and v1.11. + */ + MFF_MPLS_BOS, + + /* "mpls_ttl". + * + * The outermost MPLS label's time-to-live (TTL) field, or 0 if no MPLS + * labels are present. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: MPLS. + * Access: read/write. + * NXM: NXM_NX_MPLS_TTL(30) since v2.6. + * OXM: none. + */ + MFF_MPLS_TTL, + +/* ## ---- ## */ +/* ## IPv4 ## */ +/* ## ---- ## */ + +/* Update mf_is_l3_or_higher() if MFF_IPV4_SRC is no longer the first element + * for a field of layer 3 or higher */ + + /* "ip_src" (aka "nw_src"). + * + * The source address in the IPv4 header. + * + * Before Open vSwitch 1.8, only CIDR masks were supported. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: IPv4. + * Access: read/write. + * NXM: NXM_OF_IP_SRC(7) since v1.1. + * OXM: OXM_OF_IPV4_SRC(11) since OF1.2 and v1.7. + * OF1.0: CIDR mask. + * OF1.1: bitwise mask. + * Prefix lookup member: nw_src. + */ + MFF_IPV4_SRC, + + /* "ip_dst" (aka "nw_dst"). + * + * The destination address in the IPv4 header. + * + * Before Open vSwitch 1.8, only CIDR masks were supported. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: IPv4. + * Access: read/write. + * NXM: NXM_OF_IP_DST(8) since v1.1. + * OXM: OXM_OF_IPV4_DST(12) since OF1.2 and v1.7. + * OF1.0: CIDR mask. + * OF1.1: bitwise mask. + * Prefix lookup member: nw_dst. + */ + MFF_IPV4_DST, + +/* ## ---- ## */ +/* ## IPv6 ## */ +/* ## ---- ## */ + + /* "ipv6_src". + * + * The source address in the IPv6 header. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: IPv6. + * Prerequisites: IPv6. + * Access: read/write. + * NXM: NXM_NX_IPV6_SRC(19) since v1.1. + * OXM: OXM_OF_IPV6_SRC(26) since OF1.2 and v1.1. + * Prefix lookup member: ipv6_src. + */ + MFF_IPV6_SRC, + + /* "ipv6_dst". + * + * The destination address in the IPv6 header. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: IPv6. + * Prerequisites: IPv6. + * Access: read/write. + * NXM: NXM_NX_IPV6_DST(20) since v1.1. + * OXM: OXM_OF_IPV6_DST(27) since OF1.2 and v1.1. + * Prefix lookup member: ipv6_dst. + */ + MFF_IPV6_DST, + + /* "ipv6_label". + * + * The flow label in the IPv6 header. + * + * Type: be32 (low 20 bits). + * Maskable: bitwise. + * Formatting: hexadecimal. + * Prerequisites: IPv6. + * Access: read/write. + * NXM: NXM_NX_IPV6_LABEL(27) since v1.4. + * OXM: OXM_OF_IPV6_FLABEL(28) since OF1.2 and v1.7. + */ + MFF_IPV6_LABEL, + +/* ## ----------------------- ## */ +/* ## IPv4/IPv6 common fields ## */ +/* ## ----------------------- ## */ + + /* "nw_proto" (aka "ip_proto"). + * + * The "protocol" byte in the IPv4 or IPv6 header. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: IPv4/IPv6. + * Access: read-only. + * NXM: NXM_OF_IP_PROTO(6) since v1.1. + * OXM: OXM_OF_IP_PROTO(10) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_IP_PROTO, + +/* Both views of the DSCP below are marked as supported in all of the versions + * of OpenFlow because a match on either view can be successfully translated + * into every OpenFlow flow format. */ + + /* "nw_tos" (OpenFlow 1.0/1.1). + * + * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6 + * header, with the ECN bits forced to 0. (That is, bits 2-7 contain the + * type of service and bits 0-1 are zero.) + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: IPv4/IPv6. + * Access: read/write. + * NXM: NXM_OF_IP_TOS(5) since v1.1. + * OXM: none. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_IP_DSCP, + + /* "ip_dscp" (OpenFlow 1.2+). + * + * The DSCP byte in the IPv4 header or the traffic class byte from the IPv6 + * header, shifted right 2 bits. (That is, bits 0-5 contain the type of + * service and bits 6-7 are zero.) + * + * Type: u8 (low 6 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: IPv4/IPv6. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_IP_DSCP(8) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_IP_DSCP_SHIFTED, + + /* "nw_ecn" (aka "ip_ecn"). + * + * The ECN bits in the IPv4 or IPv6 header. + * + * Type: u8 (low 2 bits). + * Maskable: no. + * Formatting: decimal. + * Prerequisites: IPv4/IPv6. + * Access: read/write. + * NXM: NXM_NX_IP_ECN(28) since v1.4. + * OXM: OXM_OF_IP_ECN(9) since OF1.2 and v1.7. + */ + MFF_IP_ECN, + + /* "nw_ttl". + * + * The time-to-live (TTL) in the IPv4 header or hop limit in the IPv6 + * header. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: IPv4/IPv6. + * Access: read/write. + * NXM: NXM_NX_IP_TTL(29) since v1.4. + * OXM: none. + */ + MFF_IP_TTL, + + /* "ip_frag". + * + * IP fragment information. + * + * This field has three possible values: + * + * - A packet that is not an IP fragment has value 0. + * + * - A packet that is an IP fragment with offset 0 (the first fragment) + * has bit 0 set and thus value 1. + * + * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 + * set and thus value 3. + * + * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically + * represent the meanings of bits 0 and 1. + * + * The switch may reject matches against values that can never appear. + * + * It is important to understand how this field interacts with the OpenFlow + * IP fragment handling mode: + * + * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments + * before they reach the flow table, so every packet that is available + * for matching will have value 0 in this field. + * + * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did + * then IP fragments would be reassembled before they reached the flow + * table and again every packet available for matching would always + * have value 0. + * + * - In OFPC_FRAG_NORMAL mode, all three values are possible, but + * OpenFlow 1.0 says that fragments' transport ports are always 0, even + * for the first fragment, so this does not provide much extra + * information. + * + * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For + * fragments with offset 0, Open vSwitch makes L4 header information + * available. + * + * Type: u8 (low 2 bits). + * Maskable: bitwise. + * Formatting: frag. + * Prerequisites: IPv4/IPv6. + * Access: read-only. + * NXM: NXM_NX_IP_FRAG(26) since v1.3. + * OXM: none. + */ + MFF_IP_FRAG, + +/* ## --- ## */ +/* ## ARP ## */ +/* ## --- ## */ + + /* "arp_op". + * + * ARP opcode. + * + * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0 + * otherwise. Only ARP opcodes between 1 and 255 should be specified for + * matching. + * + * Type: be16. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: ARP. + * Access: read/write. + * NXM: NXM_OF_ARP_OP(15) since v1.1. + * OXM: OXM_OF_ARP_OP(21) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_ARP_OP, + + /* "arp_spa". + * + * For an Ethernet+IP ARP packet, the source protocol (IPv4) address in the + * ARP header. Always 0 otherwise. + * + * Before Open vSwitch 1.8, only CIDR masks were supported. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: ARP. + * Access: read/write. + * NXM: NXM_OF_ARP_SPA(16) since v1.1. + * OXM: OXM_OF_ARP_SPA(22) since OF1.2 and v1.7. + * OF1.0: CIDR mask. + * OF1.1: bitwise mask. + */ + MFF_ARP_SPA, + + /* "arp_tpa". + * + * For an Ethernet+IP ARP packet, the target protocol (IPv4) address in the + * ARP header. Always 0 otherwise. + * + * Before Open vSwitch 1.8, only CIDR masks were supported. + * + * Type: be32. + * Maskable: bitwise. + * Formatting: IPv4. + * Prerequisites: ARP. + * Access: read/write. + * NXM: NXM_OF_ARP_TPA(17) since v1.1. + * OXM: OXM_OF_ARP_TPA(23) since OF1.2 and v1.7. + * OF1.0: CIDR mask. + * OF1.1: bitwise mask. + */ + MFF_ARP_TPA, + + /* "arp_sha". + * + * For an Ethernet+IP ARP packet, the source hardware (Ethernet) address in + * the ARP header. Always 0 otherwise. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: ARP. + * Access: read/write. + * NXM: NXM_NX_ARP_SHA(17) since v1.1. + * OXM: OXM_OF_ARP_SHA(24) since OF1.2 and v1.7. + */ + MFF_ARP_SHA, + + /* "arp_tha". + * + * For an Ethernet+IP ARP packet, the target hardware (Ethernet) address in + * the ARP header. Always 0 otherwise. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: ARP. + * Access: read/write. + * NXM: NXM_NX_ARP_THA(18) since v1.1. + * OXM: OXM_OF_ARP_THA(25) since OF1.2 and v1.7. + */ + MFF_ARP_THA, + +/* ## --- ## */ +/* ## TCP ## */ +/* ## --- ## */ + + /* "tcp_src" (aka "tp_src"). + * + * TCP source port. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: TCP. + * Access: read/write. + * NXM: NXM_OF_TCP_SRC(9) since v1.1. + * OXM: OXM_OF_TCP_SRC(13) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_TCP_SRC, + + /* "tcp_dst" (aka "tp_dst"). + * + * TCP destination port. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: TCP. + * Access: read/write. + * NXM: NXM_OF_TCP_DST(10) since v1.1. + * OXM: OXM_OF_TCP_DST(14) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_TCP_DST, + + /* "tcp_flags". + * + * Flags in the TCP header. + * + * TCP currently defines 9 flag bits, and additional 3 bits are reserved + * (must be transmitted as zero). See RFCs 793, 3168, and 3540. + * + * Type: be16 (low 12 bits). + * Maskable: bitwise. + * Formatting: TCP flags. + * Prerequisites: TCP. + * Access: read-only. + * NXM: NXM_NX_TCP_FLAGS(34) since v2.1. + * OXM: ONFOXM_ET_TCP_FLAGS(42) since OF1.3 and v2.4, + * OXM_OF_TCP_FLAGS(42) since OF1.5 and v2.3. + */ + MFF_TCP_FLAGS, + +/* ## --- ## */ +/* ## UDP ## */ +/* ## --- ## */ + + /* "udp_src". + * + * UDP source port. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: UDP. + * Access: read/write. + * NXM: NXM_OF_UDP_SRC(11) since v1.1. + * OXM: OXM_OF_UDP_SRC(15) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_UDP_SRC, + + /* "udp_dst". + * + * UDP destination port + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: UDP. + * Access: read/write. + * NXM: NXM_OF_UDP_DST(12) since v1.1. + * OXM: OXM_OF_UDP_DST(16) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_UDP_DST, + +/* ## ---- ## */ +/* ## SCTP ## */ +/* ## ---- ## */ + + /* "sctp_src". + * + * SCTP source port. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: SCTP. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_SCTP_SRC(17) since OF1.2 and v2.0. + * OF1.1: exact match. + */ + MFF_SCTP_SRC, + + /* "sctp_dst". + * + * SCTP destination port. + * + * Type: be16. + * Maskable: bitwise. + * Formatting: decimal. + * Prerequisites: SCTP. + * Access: read/write. + * NXM: none. + * OXM: OXM_OF_SCTP_DST(18) since OF1.2 and v2.0. + * OF1.1: exact match. + */ + MFF_SCTP_DST, + +/* ## ---- ## */ +/* ## ICMP ## */ +/* ## ---- ## */ + + /* "icmp_type". + * + * ICMPv4 type. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: ICMPv4. + * Access: read/write. + * NXM: NXM_OF_ICMP_TYPE(13) since v1.1. + * OXM: OXM_OF_ICMPV4_TYPE(19) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_ICMPV4_TYPE, + + /* "icmp_code". + * + * ICMPv4 code. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: ICMPv4. + * Access: read/write. + * NXM: NXM_OF_ICMP_CODE(14) since v1.1. + * OXM: OXM_OF_ICMPV4_CODE(20) since OF1.2 and v1.7. + * OF1.0: exact match. + * OF1.1: exact match. + */ + MFF_ICMPV4_CODE, + + /* "icmpv6_type". + * + * ICMPv6 type. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: ICMPv6. + * Access: read/write. + * NXM: NXM_NX_ICMPV6_TYPE(21) since v1.1. + * OXM: OXM_OF_ICMPV6_TYPE(29) since OF1.2 and v1.7. + */ + MFF_ICMPV6_TYPE, + + /* "icmpv6_code". + * + * ICMPv6 code. + * + * Type: u8. + * Maskable: no. + * Formatting: decimal. + * Prerequisites: ICMPv6. + * Access: read/write. + * NXM: NXM_NX_ICMPV6_CODE(22) since v1.1. + * OXM: OXM_OF_ICMPV6_CODE(30) since OF1.2 and v1.7. + */ + MFF_ICMPV6_CODE, + +/* ## ------------------------- ## */ +/* ## ICMPv6 Neighbor Discovery ## */ +/* ## ------------------------- ## */ + + /* "nd_target". + * + * The target address in an IPv6 Neighbor Discovery message. + * + * Before Open vSwitch 1.8, only CIDR masks were supported. + * + * Type: be128. + * Maskable: bitwise. + * Formatting: IPv6. + * Prerequisites: ND. + * Access: read/write. + * NXM: NXM_NX_ND_TARGET(23) since v1.1. + * OXM: OXM_OF_IPV6_ND_TARGET(31) since OF1.2 and v1.7. + */ + MFF_ND_TARGET, + + /* "nd_sll". + * + * The source link layer address in an IPv6 Neighbor Discovery message. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: ND solicit. + * Access: read/write. + * NXM: NXM_NX_ND_SLL(24) since v1.1. + * OXM: OXM_OF_IPV6_ND_SLL(32) since OF1.2 and v1.7. + */ + MFF_ND_SLL, + + /* "nd_tll". + * + * The target link layer address in an IPv6 Neighbor Discovery message. + * + * Type: MAC. + * Maskable: bitwise. + * Formatting: Ethernet. + * Prerequisites: ND advert. + * Access: read/write. + * NXM: NXM_NX_ND_TLL(25) since v1.1. + * OXM: OXM_OF_IPV6_ND_TLL(33) since OF1.2 and v1.7. + */ + MFF_ND_TLL, MFF_N_IDS }; +/* A set of mf_field_ids. */ +struct mf_bitmap { + unsigned long bm[BITMAP_N_LONGS(MFF_N_IDS)]; +}; +#define MF_BITMAP_INITIALIZER { { [0] = 0 } } + /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the - * MFF_REGx cases. */ -#if FLOW_N_REGS == 1 -# define CASE_MFF_REGS \ - case MFF_REG0 -#elif FLOW_N_REGS == 2 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1 -#elif FLOW_N_REGS == 3 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1: case MFF_REG2 -#elif FLOW_N_REGS == 4 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3 -#elif FLOW_N_REGS == 5 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \ - case MFF_REG4 -#elif FLOW_N_REGS == 6 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \ - case MFF_REG4: case MFF_REG5 -#elif FLOW_N_REGS == 7 -# define CASE_MFF_REGS \ - case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \ - case MFF_REG4: case MFF_REG5: case MFF_REG6 -#elif FLOW_N_REGS == 8 -# define CASE_MFF_REGS \ + * MFF_REGn cases. */ +#if FLOW_N_REGS == 8 +#define CASE_MFF_REGS \ case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \ case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7 #else -# error +#error "Need to update CASE_MFF_REGS to match FLOW_N_REGS" +#endif + +/* Use this macro as CASE_MFF_XREGS: in a switch statement to choose all of the + * MFF_REGn cases. */ +#if FLOW_N_XREGS == 4 +#define CASE_MFF_XREGS \ + case MFF_XREG0: case MFF_XREG1: case MFF_XREG2: case MFF_XREG3 +#else +#error "Need to update CASE_MFF_XREGS to match FLOW_N_XREGS" #endif +/* Use this macro as CASE_MFF_TUN_METADATA: in a switch statement to choose + * all of the MFF_TUN_METADATAn cases. */ +#define CASE_MFF_TUN_METADATA \ + case MFF_TUN_METADATA0: case MFF_TUN_METADATA1: \ + case MFF_TUN_METADATA2: case MFF_TUN_METADATA3: \ + case MFF_TUN_METADATA4: case MFF_TUN_METADATA5: \ + case MFF_TUN_METADATA6: case MFF_TUN_METADATA7: \ + case MFF_TUN_METADATA8: case MFF_TUN_METADATA9: \ + case MFF_TUN_METADATA10: case MFF_TUN_METADATA11: \ + case MFF_TUN_METADATA12: case MFF_TUN_METADATA13: \ + case MFF_TUN_METADATA14: case MFF_TUN_METADATA15: \ + case MFF_TUN_METADATA16: case MFF_TUN_METADATA17: \ + case MFF_TUN_METADATA18: case MFF_TUN_METADATA19: \ + case MFF_TUN_METADATA20: case MFF_TUN_METADATA21: \ + case MFF_TUN_METADATA22: case MFF_TUN_METADATA23: \ + case MFF_TUN_METADATA24: case MFF_TUN_METADATA25: \ + case MFF_TUN_METADATA26: case MFF_TUN_METADATA27: \ + case MFF_TUN_METADATA28: case MFF_TUN_METADATA29: \ + case MFF_TUN_METADATA30: case MFF_TUN_METADATA31: \ + case MFF_TUN_METADATA32: case MFF_TUN_METADATA33: \ + case MFF_TUN_METADATA34: case MFF_TUN_METADATA35: \ + case MFF_TUN_METADATA36: case MFF_TUN_METADATA37: \ + case MFF_TUN_METADATA38: case MFF_TUN_METADATA39: \ + case MFF_TUN_METADATA40: case MFF_TUN_METADATA41: \ + case MFF_TUN_METADATA42: case MFF_TUN_METADATA43: \ + case MFF_TUN_METADATA44: case MFF_TUN_METADATA45: \ + case MFF_TUN_METADATA46: case MFF_TUN_METADATA47: \ + case MFF_TUN_METADATA48: case MFF_TUN_METADATA49: \ + case MFF_TUN_METADATA50: case MFF_TUN_METADATA51: \ + case MFF_TUN_METADATA52: case MFF_TUN_METADATA53: \ + case MFF_TUN_METADATA54: case MFF_TUN_METADATA55: \ + case MFF_TUN_METADATA56: case MFF_TUN_METADATA57: \ + case MFF_TUN_METADATA58: case MFF_TUN_METADATA59: \ + case MFF_TUN_METADATA60: case MFF_TUN_METADATA61: \ + case MFF_TUN_METADATA62: case MFF_TUN_METADATA63 + /* Prerequisites for matching a field. * * A field may only be matched if the correct lower-level protocols are also @@ -225,11 +1832,12 @@ enum OVS_PACKED_ENUM mf_string { MFS_HEXADECIMAL, /* Other formats. */ + MFS_CT_STATE, /* Connection tracking state */ MFS_ETHERNET, MFS_IPV4, MFS_IPV6, - MFS_OFP_PORT, /* An OpenFlow port number or name. */ - MFS_OFP_PORT_OXM, /* An OpenFlow port number or name (32-bit). */ + MFS_OFP_PORT, /* 16-bit OpenFlow 1.0 port number or name. */ + MFS_OFP_PORT_OXM, /* 32-bit OpenFlow 1.1+ port number or name. */ MFS_FRAG, /* no, yes, first, later, not_later */ MFS_TNL_FLAGS, /* FLOW_TNL_F_* flags */ MFS_TCP_FLAGS, /* TCP_* flags */ @@ -255,6 +1863,7 @@ struct mf_field { */ unsigned int n_bytes; /* Width of the field in bytes. */ unsigned int n_bits; /* Number of significant bits in field. */ + bool variable_len; /* Length is variable, if so width is max. */ /* Properties. */ enum mf_maskable maskable; @@ -262,41 +1871,21 @@ struct mf_field { enum mf_prereqs prereqs; bool writable; /* May be written by actions? */ - /* NXM and OXM properties. - * - * There are the following possibilities for these members for a given - * mf_field: - * - * - Neither NXM nor OXM defines such a field: these members will all be - * zero or NULL. - * - * - NXM and OXM both define such a field: nxm_header and oxm_header will - * both be nonzero and different, similarly for nxm_name and oxm_name. - * - * - Only NXM or only OXM defines such a field: nxm_header and oxm_header - * will both have the same value (either an OXM_* or NXM_* value) and - * similarly for nxm_name and oxm_name. - * - * Thus, 'nxm_header' is the appropriate header to use when outputting an - * NXM formatted match, since it will be an NXM_* constant when possible - * for compatibility with OpenFlow implementations that expect that, with - * OXM_* constants used for fields that OXM adds. Conversely, 'oxm_header' - * is the header to use when outputting an OXM formatted match. */ - uint32_t nxm_header; /* An NXM_* (or OXM_*) constant. */ - const char *nxm_name; /* The nxm_header constant's name. */ - uint32_t oxm_header; /* An OXM_* (or NXM_*) constant. */ - const char *oxm_name; /* The oxm_header constant's name */ - /* Usable protocols. + * * NXM and OXM are extensible, allowing later extensions to be sent in * earlier protocol versions, so this does not necessarily correspond to * the OpenFlow protocol version the field was introduced in. * Also, some field types are tranparently mapped to each other via the * struct flow (like vlan and dscp/tos fields), so each variant supports - * all protocols. */ - enum ofputil_protocol usable_protocols; /* If fully/cidr masked. */ - /* If partially/non-cidr masked. */ - enum ofputil_protocol usable_protocols_bitwise; + * all protocols. + * + * These are combinations of OFPUTIL_P_*. (They are not declared as type + * enum ofputil_protocol because that would give meta-flow.h and ofp-util.h + * a circular dependency.) */ + uint32_t usable_protocols_exact; /* Matching or setting whole field. */ + uint32_t usable_protocols_cidr; /* Matching a CIDR mask in field. */ + uint32_t usable_protocols_bitwise; /* Matching arbitrary bits in field. */ int flow_be32ofs; /* Field's be32 offset in "struct flow", if prefix tree * lookup is supported for the field, or -1. */ @@ -304,16 +1893,20 @@ struct mf_field { /* The representation of a field's value. */ union mf_value { + uint8_t tun_metadata[128]; struct in6_addr ipv6; - uint8_t mac[ETH_ADDR_LEN]; + struct eth_addr mac; + ovs_be128 be128; ovs_be64 be64; ovs_be32 be32; ovs_be16 be16; uint8_t u8; }; -BUILD_ASSERT_DECL(sizeof(union mf_value) == 16); +BUILD_ASSERT_DECL(sizeof(union mf_value) == 128); +BUILD_ASSERT_DECL(sizeof(union mf_value) >= TLV_MAX_OPT_SIZE); -#define MF_EXACT_MASK_INITIALIZER { IN6ADDR_EXACT_INIT } +/* A const mf_value with all bits initialized to ones. */ +extern const union mf_value exact_match_mask; /* Part of a field. */ struct mf_subfield { @@ -328,17 +1921,50 @@ struct mf_subfield { * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */ union mf_subvalue { - uint8_t u8[16]; - ovs_be16 be16[8]; - ovs_be32 be32[4]; - ovs_be64 be64[2]; + /* Access to full data. */ + uint8_t u8[128]; + ovs_be16 be16[64]; + ovs_be32 be32[32]; + ovs_be64 be64[16]; + + /* Convenient access to just least-significant bits in various forms. */ + struct { + ovs_be64 dummy_integer[15]; + ovs_be64 integer; + }; + struct { + uint8_t dummy_mac[122]; + struct eth_addr mac; + }; + struct { + ovs_be32 dummy_ipv4[31]; + ovs_be32 ipv4; + }; + struct { + struct in6_addr dummy_ipv6[7]; + struct in6_addr ipv6; + }; }; BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue)); +bool mf_subvalue_intersect(const union mf_subvalue *a_value, + const union mf_subvalue *a_mask, + const union mf_subvalue *b_value, + const union mf_subvalue *b_mask, + union mf_subvalue *dst_value, + union mf_subvalue *dst_mask); +int mf_subvalue_width(const union mf_subvalue *); +void mf_subvalue_shift(union mf_subvalue *, int n); +void mf_subvalue_format(const union mf_subvalue *, struct ds *); + +/* An array of fields with values */ +struct field_array { + struct mf_bitmap used; + union mf_value value[MFF_N_IDS]; +}; + /* Finding mf_fields. */ const struct mf_field *mf_from_name(const char *name); -const struct mf_field *mf_from_nxm_header(uint32_t nxm_header); -const struct mf_field *mf_from_nxm_name(const char *nxm_name); static inline const struct mf_field * mf_from_id(enum mf_field_id id) @@ -357,7 +1983,16 @@ void mf_get_mask(const struct mf_field *, const struct flow_wildcards *, /* Prerequisites. */ bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *); -void mf_mask_field_and_prereqs(const struct mf_field *, struct flow *mask); +void mf_mask_field_and_prereqs(const struct mf_field *, + struct flow_wildcards *); +void mf_bitmap_set_field_and_prereqs(const struct mf_field *mf, struct + mf_bitmap *bm); + +static inline bool +mf_is_l3_or_higher(const struct mf_field *mf) +{ + return mf->id >= MFF_IPV4_SRC; +} /* Field values. */ bool mf_is_value_valid(const struct mf_field *, const union mf_value *value); @@ -365,40 +2000,43 @@ bool mf_is_value_valid(const struct mf_field *, const union mf_value *value); void mf_get_value(const struct mf_field *, const struct flow *, union mf_value *value); void mf_set_value(const struct mf_field *, const union mf_value *value, - struct match *); + struct match *, char **err_str); void mf_set_flow_value(const struct mf_field *, const union mf_value *value, struct flow *); -bool mf_is_zero(const struct mf_field *, const struct flow *); +void mf_set_flow_value_masked(const struct mf_field *, + const union mf_value *value, + const union mf_value *mask, + struct flow *); +bool mf_is_tun_metadata(const struct mf_field *); +bool mf_is_set(const struct mf_field *, const struct flow *); void mf_mask_field(const struct mf_field *, struct flow *); +int mf_field_len(const struct mf_field *, const union mf_value *value, + const union mf_value *mask, bool *is_masked); void mf_get(const struct mf_field *, const struct match *, union mf_value *value, union mf_value *mask); /* Returns the set of usable protocols. */ -enum ofputil_protocol mf_set(const struct mf_field *, - const union mf_value *value, - const union mf_value *mask, - struct match *); +uint32_t mf_set(const struct mf_field *, const union mf_value *value, + const union mf_value *mask, struct match *, char **err_str); -void mf_set_wild(const struct mf_field *, struct match *); +void mf_set_wild(const struct mf_field *, struct match *, char **err_str); /* Subfields. */ void mf_write_subfield_flow(const struct mf_subfield *, const union mf_subvalue *, struct flow *); void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *, struct match *); +void mf_mask_subfield(const struct mf_field *, + const union mf_subvalue *value, + const union mf_subvalue *mask, + struct match *); void mf_read_subfield(const struct mf_subfield *, const struct flow *, union mf_subvalue *); uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *); -void mf_format_subfield(const struct mf_subfield *, struct ds *); -char *mf_parse_subfield__(struct mf_subfield *sf, const char **s) - WARN_UNUSED_RESULT; -char *mf_parse_subfield(struct mf_subfield *, const char *s) - WARN_UNUSED_RESULT; - enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *); enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *); @@ -411,4 +2049,8 @@ void mf_format(const struct mf_field *, struct ds *); void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s); +/* Field Arrays. */ +void field_array_set(enum mf_field_id id, const union mf_value *, + struct field_array *); + #endif /* meta-flow.h */