lib/meta-flow.h

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