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