lib/meta-flow.h

   1 /*
   2  * Copyright (c) 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #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 "flow.h"
  24 #include "ofp-errors.h"
  25 #include "ofp-util.h"
  26 #include "packets.h"
  27 #include "util.h"
  28
  29 struct ds;
  30 struct match;
  31
  32 /* The comment on each of these indicates the member in "union mf_value" used
  33  * to represent its value. */
  34 enum OVS_PACKED_ENUM mf_field_id {
  35     /* Metadata. */
  36     MFF_DP_HASH,                /* be32 */
  37     MFF_RECIRC_ID,              /* be32 */
  38     MFF_TUN_ID,                 /* be64 */
  39     MFF_TUN_SRC,                /* be32 */
  40     MFF_TUN_DST,                /* be32 */
  41     MFF_TUN_FLAGS,              /* be16 */
  42     MFF_TUN_TTL,                /* u8 */
  43     MFF_TUN_TOS,                /* u8 */
  44     MFF_METADATA,               /* be64 */
  45     MFF_IN_PORT,                /* be16 */
  46     MFF_IN_PORT_OXM,            /* be32 */
  47     MFF_SKB_PRIORITY,           /* be32 */
  48     MFF_PKT_MARK,               /* be32 */
  49
  50 #if FLOW_N_REGS > 0
  51     MFF_REG0,                   /* be32 */
  52 #endif
  53 #if FLOW_N_REGS > 1
  54     MFF_REG1,                   /* be32 */
  55 #endif
  56 #if FLOW_N_REGS > 2
  57     MFF_REG2,                   /* be32 */
  58 #endif
  59 #if FLOW_N_REGS > 3
  60     MFF_REG3,                   /* be32 */
  61 #endif
  62 #if FLOW_N_REGS > 4
  63     MFF_REG4,                   /* be32 */
  64 #endif
  65 #if FLOW_N_REGS > 5
  66     MFF_REG5,                   /* be32 */
  67 #endif
  68 #if FLOW_N_REGS > 6
  69     MFF_REG6,                   /* be32 */
  70 #endif
  71 #if FLOW_N_REGS > 7
  72     MFF_REG7,                   /* be32 */
  73 #endif
  74
  75     /* L2. */
  76     MFF_ETH_SRC,                /* mac */
  77     MFF_ETH_DST,                /* mac */
  78     MFF_ETH_TYPE,               /* be16 */
  79
  80     MFF_VLAN_TCI,               /* be16 */
  81     MFF_DL_VLAN,                /* be16 (OpenFlow 1.0 compatibility) */
  82     MFF_VLAN_VID,               /* be16 (OpenFlow 1.2 compatibility) */
  83     MFF_DL_VLAN_PCP,            /* u8 (OpenFlow 1.0 compatibility) */
  84     MFF_VLAN_PCP,               /* be16 (OpenFlow 1.2 compatibility) */
  85
  86     /* L2.5 */
  87     MFF_MPLS_LABEL,             /* be32 */
  88     MFF_MPLS_TC,                /* u8 */
  89     MFF_MPLS_BOS,               /* u8 */
  90
  91     /* L3. */
  92     /* Update mf_is_l3_or_higher() if MFF_IPV4_SRC is
  93      * no longer the first element for a field of layer 3 or higher */
  94     MFF_IPV4_SRC,               /* be32 */
  95     MFF_IPV4_DST,               /* be32 */
  96
  97     MFF_IPV6_SRC,               /* ipv6 */
  98     MFF_IPV6_DST,               /* ipv6 */
  99     MFF_IPV6_LABEL,             /* be32 */
 100
 101     /* The IPv4/IPv6 DSCP field has two different views:
 102      *
 103      *   - MFF_IP_DSCP has the DSCP in bits 2-7, their bit positions in the
 104      *     IPv4 and IPv6 "traffic class" field, as used in OpenFlow 1.0 and 1.1
 105      *     flow format and in NXM's NXM_OF_IP_TOS
 106      *
 107      *   - MFF_IP_DSCP has the DSCP in bits 0-5, shifted right two bits from
 108      *     their positions in the IPv4 and IPv6 "traffic class" field, as used
 109      *     in OpenFlow 1.2+ OXM's OXM_OF_IP_DSCP. */
 110     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
 111     MFF_IP_DSCP,                /* u8 (used for IPv4 or IPv6) */
 112     MFF_IP_DSCP_SHIFTED,        /* u8 (used for IPv4 or IPv6) (OF1.2 compat) */
 113     MFF_IP_ECN,                 /* u8 (used for IPv4 or IPv6) */
 114     MFF_IP_TTL,                 /* u8 (used for IPv4 or IPv6) */
 115     MFF_IP_FRAG,                /* u8 (used for IPv4 or IPv6) */
 116
 117     MFF_ARP_OP,                 /* be16 */
 118     MFF_ARP_SPA,                /* be32 */
 119     MFF_ARP_TPA,                /* be32 */
 120     MFF_ARP_SHA,                /* mac */
 121     MFF_ARP_THA,                /* mac */
 122
 123     /* L4. */
 124     MFF_TCP_SRC,                /* be16 (used for IPv4 or IPv6) */
 125     MFF_TCP_DST,                /* be16 (used for IPv4 or IPv6) */
 126     MFF_TCP_FLAGS,              /* be16, 12 bits (4 MSB zeroed,
 127                                  * used for IPv4 or IPv6) */
 128
 129     MFF_UDP_SRC,                /* be16 (used for IPv4 or IPv6) */
 130     MFF_UDP_DST,                /* be16 (used for IPv4 or IPv6) */
 131
 132     MFF_SCTP_SRC,               /* be16 (used for IPv4 or IPv6) */
 133     MFF_SCTP_DST,               /* be16 (used for IPv4 or IPv6) */
 134
 135     MFF_ICMPV4_TYPE,            /* u8 */
 136     MFF_ICMPV4_CODE,            /* u8 */
 137
 138     MFF_ICMPV6_TYPE,            /* u8 */
 139     MFF_ICMPV6_CODE,            /* u8 */
 140
 141     /* ICMPv6 Neighbor Discovery. */
 142     MFF_ND_TARGET,              /* ipv6 */
 143     MFF_ND_SLL,                 /* mac */
 144     MFF_ND_TLL,                 /* mac */
 145
 146     MFF_N_IDS
 147 };
 148
 149 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
 150  * MFF_REGx cases. */
 151 #if FLOW_N_REGS == 1
 152 # define CASE_MFF_REGS                                          \
 153     case MFF_REG0
 154 #elif FLOW_N_REGS == 2
 155 # define CASE_MFF_REGS                                          \
 156     case MFF_REG0: case MFF_REG1
 157 #elif FLOW_N_REGS == 3
 158 # define CASE_MFF_REGS                                          \
 159     case MFF_REG0: case MFF_REG1: case MFF_REG2
 160 #elif FLOW_N_REGS == 4
 161 # define CASE_MFF_REGS                                          \
 162     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3
 163 #elif FLOW_N_REGS == 5
 164 # define CASE_MFF_REGS                                          \
 165     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
 166     case MFF_REG4
 167 #elif FLOW_N_REGS == 6
 168 # define CASE_MFF_REGS                                          \
 169     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
 170     case MFF_REG4: case MFF_REG5
 171 #elif FLOW_N_REGS == 7
 172 # define CASE_MFF_REGS                                          \
 173     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
 174     case MFF_REG4: case MFF_REG5: case MFF_REG6
 175 #elif FLOW_N_REGS == 8
 176 # define CASE_MFF_REGS                                          \
 177     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
 178     case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
 179 #else
 180 # error
 181 #endif
 182
 183 /* Prerequisites for matching a field.
 184  *
 185  * A field may only be matched if the correct lower-level protocols are also
 186  * matched.  For example, the TCP port may be matched only if the Ethernet type
 187  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
 188 enum OVS_PACKED_ENUM mf_prereqs {
 189     MFP_NONE,
 190
 191     /* L2 requirements. */
 192     MFP_ARP,
 193     MFP_VLAN_VID,
 194     MFP_IPV4,
 195     MFP_IPV6,
 196     MFP_IP_ANY,
 197
 198     /* L2.5 requirements. */
 199     MFP_MPLS,
 200
 201     /* L2+L3 requirements. */
 202     MFP_TCP,                    /* On IPv4 or IPv6. */
 203     MFP_UDP,                    /* On IPv4 or IPv6. */
 204     MFP_SCTP,                   /* On IPv4 or IPv6. */
 205     MFP_ICMPV4,
 206     MFP_ICMPV6,
 207
 208     /* L2+L3+L4 requirements. */
 209     MFP_ND,
 210     MFP_ND_SOLICIT,
 211     MFP_ND_ADVERT
 212 };
 213
 214 /* Forms of partial-field masking allowed for a field.
 215  *
 216  * Every field may be masked as a whole. */
 217 enum OVS_PACKED_ENUM mf_maskable {
 218     MFM_NONE,                   /* No sub-field masking. */
 219     MFM_FULLY,                  /* Every bit is individually maskable. */
 220 };
 221
 222 /* How to format or parse a field's value. */
 223 enum OVS_PACKED_ENUM mf_string {
 224     /* Integer formats.
 225      *
 226      * The particular MFS_* constant sets the output format.  On input, either
 227      * decimal or hexadecimal (prefixed with 0x) is accepted. */
 228     MFS_DECIMAL,
 229     MFS_HEXADECIMAL,
 230
 231     /* Other formats. */
 232     MFS_ETHERNET,
 233     MFS_IPV4,
 234     MFS_IPV6,
 235     MFS_OFP_PORT,               /* An OpenFlow port number or name. */
 236     MFS_OFP_PORT_OXM,           /* An OpenFlow port number or name (32-bit). */
 237     MFS_FRAG,                   /* no, yes, first, later, not_later */
 238     MFS_TNL_FLAGS,              /* FLOW_TNL_F_* flags */
 239     MFS_TCP_FLAGS,              /* TCP_* flags */
 240 };
 241
 242 struct mf_field {
 243     /* Identification. */
 244     enum mf_field_id id;        /* MFF_*. */
 245     const char *name;           /* Name of this field, e.g. "eth_type". */
 246     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
 247
 248     /* Size.
 249      *
 250      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
 251      *
 252      *     - "dl_vlan" is 2 bytes but only 12 bits.
 253      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
 254      *     - "is_frag" is 1 byte but only 2 bits.
 255      *     - "ipv6_label" is 4 bytes but only 20 bits.
 256      *     - "mpls_label" is 4 bytes but only 20 bits.
 257      *     - "mpls_tc"    is 1 byte but only 3 bits.
 258      *     - "mpls_bos"   is 1 byte but only 1 bit.
 259      */
 260     unsigned int n_bytes;       /* Width of the field in bytes. */
 261     unsigned int n_bits;        /* Number of significant bits in field. */
 262
 263     /* Properties. */
 264     enum mf_maskable maskable;
 265     enum mf_string string;
 266     enum mf_prereqs prereqs;
 267     bool writable;              /* May be written by actions? */
 268
 269     /* NXM and OXM properties.
 270      *
 271      * There are the following possibilities for these members for a given
 272      * mf_field:
 273      *
 274      *   - Neither NXM nor OXM defines such a field: these members will all be
 275      *     zero or NULL.
 276      *
 277      *   - NXM and OXM both define such a field: nxm_header and oxm_header will
 278      *     both be nonzero and different, similarly for nxm_name and oxm_name.
 279      *
 280      *   - Only NXM or only OXM defines such a field: nxm_header and oxm_header
 281      *     will both have the same value (either an OXM_* or NXM_* value) and
 282      *     similarly for nxm_name and oxm_name.
 283      *
 284      * Thus, 'nxm_header' is the appropriate header to use when outputting an
 285      * NXM formatted match, since it will be an NXM_* constant when possible
 286      * for compatibility with OpenFlow implementations that expect that, with
 287      * OXM_* constants used for fields that OXM adds.  Conversely, 'oxm_header'
 288      * is the header to use when outputting an OXM formatted match. */
 289     uint32_t nxm_header;        /* An NXM_* (or OXM_*) constant. */
 290     const char *nxm_name;       /* The nxm_header constant's name. */
 291     uint32_t oxm_header;        /* An OXM_* (or NXM_*) constant. */
 292     const char *oxm_name;       /* The oxm_header constant's name */
 293
 294     /* Usable protocols.
 295      * NXM and OXM are extensible, allowing later extensions to be sent in
 296      * earlier protocol versions, so this does not necessarily correspond to
 297      * the OpenFlow protocol version the field was introduced in.
 298      * Also, some field types are tranparently mapped to each other via the
 299      * struct flow (like vlan and dscp/tos fields), so each variant supports
 300      * all protocols. */
 301     enum ofputil_protocol usable_protocols; /* If fully/cidr masked. */
 302     /* If partially/non-cidr masked. */
 303     enum ofputil_protocol usable_protocols_bitwise;
 304
 305     int flow_be32ofs;  /* Field's be32 offset in "struct flow", if prefix tree
 306                         * lookup is supported for the field, or -1. */
 307 };
 308
 309 /* The representation of a field's value. */
 310 union mf_value {
 311     struct in6_addr ipv6;
 312     uint8_t mac[ETH_ADDR_LEN];
 313     ovs_be64 be64;
 314     ovs_be32 be32;
 315     ovs_be16 be16;
 316     uint8_t u8;
 317 };
 318 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
 319
 320 #define MF_EXACT_MASK_INITIALIZER { IN6ADDR_EXACT_INIT }
 321
 322 /* Part of a field. */
 323 struct mf_subfield {
 324     const struct mf_field *field;
 325     unsigned int ofs;           /* Bit offset. */
 326     unsigned int n_bits;        /* Number of bits. */
 327 };
 328
 329 /* Data for some part of an mf_field.
 330  *
 331  * The data is stored "right-justified".  For example, if "union mf_subvalue
 332  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
 333  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
 334 union mf_subvalue {
 335     uint8_t u8[16];
 336     ovs_be16 be16[8];
 337     ovs_be32 be32[4];
 338     ovs_be64 be64[2];
 339 };
 340 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
 341
 342 /* Finding mf_fields. */
 343 const struct mf_field *mf_from_name(const char *name);
 344 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
 345 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
 346
 347 static inline const struct mf_field *
 348 mf_from_id(enum mf_field_id id)
 349 {
 350     extern const struct mf_field mf_fields[MFF_N_IDS];
 351     ovs_assert((unsigned int) id < MFF_N_IDS);
 352     return &mf_fields[id];
 353 }
 354
 355 /* Inspecting wildcarded bits. */
 356 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
 357
 358 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
 359 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
 360                  union mf_value *mask);
 361
 362 /* Prerequisites. */
 363 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
 364 void mf_mask_field_and_prereqs(const struct mf_field *, struct flow *mask);
 365
 366 static inline bool
 367 mf_is_l3_or_higher(const struct mf_field *mf)
 368 {
 369     return mf->id >= MFF_IPV4_SRC;
 370 }
 371
 372 /* Field values. */
 373 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
 374
 375 void mf_get_value(const struct mf_field *, const struct flow *,
 376                   union mf_value *value);
 377 void mf_set_value(const struct mf_field *, const union mf_value *value,
 378                   struct match *);
 379 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
 380                        struct flow *);
 381 bool mf_is_zero(const struct mf_field *, const struct flow *);
 382 void mf_mask_field(const struct mf_field *, struct flow *);
 383
 384 void mf_get(const struct mf_field *, const struct match *,
 385             union mf_value *value, union mf_value *mask);
 386
 387 /* Returns the set of usable protocols. */
 388 enum ofputil_protocol mf_set(const struct mf_field *,
 389                              const union mf_value *value,
 390                              const union mf_value *mask,
 391                              struct match *);
 392
 393 void mf_set_wild(const struct mf_field *, struct match *);
 394
 395 /* Subfields. */
 396 void mf_write_subfield_flow(const struct mf_subfield *,
 397                             const union mf_subvalue *, struct flow *);
 398 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
 399                        struct match *);
 400
 401 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
 402                       union mf_subvalue *);
 403 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
 404
 405
 406 void mf_format_subfield(const struct mf_subfield *, struct ds *);
 407 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s)
 408     WARN_UNUSED_RESULT;
 409 char *mf_parse_subfield(struct mf_subfield *, const char *s)
 410     WARN_UNUSED_RESULT;
 411
 412 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
 413 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
 414
 415 /* Parsing and formatting. */
 416 char *mf_parse(const struct mf_field *, const char *,
 417                union mf_value *value, union mf_value *mask);
 418 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
 419 void mf_format(const struct mf_field *,
 420                const union mf_value *value, const union mf_value *mask,
 421                struct ds *);
 422 void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s);
 423
 424 #endif /* meta-flow.h */