lib/meta-flow.h

   1 /*
   2  * Copyright (c) 2011, 2012 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 "packets.h"
  26
  27 struct cls_rule;
  28 struct ds;
  29
  30 /* The comment on each of these indicates the member in "union mf_value" used
  31  * to represent its value. */
  32 enum mf_field_id {
  33     /* Metadata. */
  34     MFF_TUN_ID,                 /* be64 */
  35     MFF_METADATA,               /* be64 */
  36     MFF_IN_PORT,                /* be16 */
  37
  38 #if FLOW_N_REGS > 0
  39     MFF_REG0,                   /* be32 */
  40 #endif
  41 #if FLOW_N_REGS > 1
  42     MFF_REG1,                   /* be32 */
  43 #endif
  44 #if FLOW_N_REGS > 2
  45     MFF_REG2,                   /* be32 */
  46 #endif
  47 #if FLOW_N_REGS > 3
  48     MFF_REG3,                   /* be32 */
  49 #endif
  50 #if FLOW_N_REGS > 4
  51     MFF_REG4,                   /* be32 */
  52 #endif
  53 #if FLOW_N_REGS > 5
  54     MFF_REG5,                   /* be32 */
  55 #endif
  56 #if FLOW_N_REGS > 6
  57     MFF_REG6,                   /* be32 */
  58 #endif
  59 #if FLOW_N_REGS > 7
  60     MFF_REG7,                   /* be32 */
  61 #endif
  62 #if FLOW_N_REGS > 8
  63 #error
  64 #endif
  65
  66     /* L2. */
  67     MFF_ETH_SRC,                /* mac */
  68     MFF_ETH_DST,                /* mac */
  69     MFF_ETH_TYPE,               /* be16 */
  70
  71     MFF_VLAN_TCI,               /* be16 */
  72     MFF_VLAN_VID,               /* be16 */
  73     MFF_VLAN_PCP,               /* u8 */
  74
  75     /* L3. */
  76     MFF_IPV4_SRC,               /* be32 */
  77     MFF_IPV4_DST,               /* be32 */
  78
  79     MFF_IPV6_SRC,               /* ipv6 */
  80     MFF_IPV6_DST,               /* ipv6 */
  81     MFF_IPV6_LABEL,             /* be32 */
  82
  83     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
  84     MFF_IP_DSCP,                /* u8 (used for IPv4 or IPv6) */
  85     MFF_IP_ECN,                 /* u8 (used for IPv4 or IPv6) */
  86     MFF_IP_TTL,                 /* u8 (used for IPv4 or IPv6) */
  87     MFF_IP_FRAG,                /* u8 (used for IPv4 or IPv6) */
  88
  89     MFF_ARP_OP,                 /* be16 */
  90     MFF_ARP_SPA,                /* be32 */
  91     MFF_ARP_TPA,                /* be32 */
  92     MFF_ARP_SHA,                /* mac */
  93     MFF_ARP_THA,                /* mac */
  94
  95     /* L4. */
  96     MFF_TCP_SRC,                /* be16 (used for IPv4 or IPv6) */
  97     MFF_TCP_DST,                /* be16 (used for IPv4 or IPv6) */
  98
  99     MFF_UDP_SRC,                /* be16 (used for IPv4 or IPv6) */
 100     MFF_UDP_DST,                /* be16 (used for IPv4 or IPv6) */
 101
 102     MFF_ICMPV4_TYPE,            /* u8 */
 103     MFF_ICMPV4_CODE,            /* u8 */
 104
 105     MFF_ICMPV6_TYPE,            /* u8 */
 106     MFF_ICMPV6_CODE,            /* u8 */
 107
 108     /* ICMPv6 Neighbor Discovery. */
 109     MFF_ND_TARGET,              /* ipv6 */
 110     MFF_ND_SLL,                 /* mac */
 111     MFF_ND_TLL,                 /* mac */
 112
 113     MFF_N_IDS
 114 };
 115
 116 /* Prerequisites for matching a field.
 117  *
 118  * A field may only be matched if the correct lower-level protocols are also
 119  * matched.  For example, the TCP port may be matched only if the Ethernet type
 120  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
 121 enum mf_prereqs {
 122     MFP_NONE,
 123
 124     /* L2 requirements. */
 125     MFP_ARP,
 126     MFP_IPV4,
 127     MFP_IPV6,
 128     MFP_IP_ANY,
 129
 130     /* L2+L3 requirements. */
 131     MFP_TCP,                    /* On IPv4 or IPv6. */
 132     MFP_UDP,                    /* On IPv4 or IPv6. */
 133     MFP_ICMPV4,
 134     MFP_ICMPV6,
 135
 136     /* L2+L3+L4 requirements. */
 137     MFP_ND,
 138     MFP_ND_SOLICIT,
 139     MFP_ND_ADVERT
 140 };
 141
 142 /* Forms of partial-field masking allowed for a field.
 143  *
 144  * Every field may be masked as a whole. */
 145 enum mf_maskable {
 146     MFM_NONE,                   /* No sub-field masking. */
 147     MFM_FULLY,                  /* Every bit is individually maskable. */
 148 };
 149
 150 /* How to format or parse a field's value. */
 151 enum mf_string {
 152     /* Integer formats.
 153      *
 154      * The particular MFS_* constant sets the output format.  On input, either
 155      * decimal or hexadecimal (prefixed with 0x) is accepted. */
 156     MFS_DECIMAL,
 157     MFS_HEXADECIMAL,
 158
 159     /* Other formats. */
 160     MFS_ETHERNET,
 161     MFS_IPV4,
 162     MFS_IPV6,
 163     MFS_OFP_PORT,               /* An OpenFlow port number or name. */
 164     MFS_FRAG                    /* no, yes, first, later, not_later */
 165 };
 166
 167 struct mf_field {
 168     /* Identification. */
 169     enum mf_field_id id;        /* MFF_*. */
 170     const char *name;           /* Name of this field, e.g. "eth_type". */
 171     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
 172
 173     /* Size.
 174      *
 175      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
 176      *
 177      *     - "dl_vlan" is 2 bytes but only 12 bits.
 178      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
 179      *     - "is_frag" is 1 byte but only 2 bits.
 180      *     - "ipv6_label" is 4 bytes but only 20 bits.
 181      */
 182     unsigned int n_bytes;       /* Width of the field in bytes. */
 183     unsigned int n_bits;        /* Number of significant bits in field. */
 184
 185     /* Properties. */
 186     enum mf_maskable maskable;
 187     flow_wildcards_t fww_bit;   /* Either 0 or exactly one FWW_* bit. */
 188     enum mf_string string;
 189     enum mf_prereqs prereqs;
 190     bool writable;              /* May be written by actions? */
 191
 192     /* NXM and OXM properties.
 193      *
 194      * There are the following possibilities for these members for a given
 195      * mf_field:
 196      *
 197      *   - Neither NXM nor OXM defines such a field: these members will all be
 198      *     zero or NULL.
 199      *
 200      *   - NXM and OXM both define such a field: nxm_header and oxm_header will
 201      *     both be nonzero and different, similarly for nxm_name and oxm_name.
 202      *
 203      *   - Only NXM or only OXM defines such a field: nxm_header and oxm_header
 204      *     will both have the same value (either an OXM_* or NXM_* value) and
 205      *     similarly for nxm_name and oxm_name.
 206      *
 207      * Thus, 'nxm_header' is the appropriate header to use when outputting an
 208      * NXM formatted match, since it will be an NXM_* constant when possible
 209      * for compatibility with OpenFlow implementations that expect that, with
 210      * OXM_* constants used for fields that OXM adds.  Conversely, 'oxm_header'
 211      * is the header to use when outputting an OXM formatted match. */
 212     uint32_t nxm_header;        /* An NXM_* (or OXM_*) constant. */
 213     const char *nxm_name;       /* The nxm_header constant's name. */
 214     uint32_t oxm_header;        /* An OXM_* (or NXM_*) constant. */
 215     const char *oxm_name;           /* The oxm_header constant's name */
 216 };
 217
 218 /* The representation of a field's value. */
 219 union mf_value {
 220     uint8_t u8;
 221     ovs_be16 be16;
 222     ovs_be32 be32;
 223     ovs_be64 be64;
 224     uint8_t mac[ETH_ADDR_LEN];
 225     struct in6_addr ipv6;
 226 };
 227 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
 228
 229 /* Part of a field. */
 230 struct mf_subfield {
 231     const struct mf_field *field;
 232     unsigned int ofs;           /* Bit offset. */
 233     unsigned int n_bits;        /* Number of bits. */
 234 };
 235
 236 /* Data for some part of an mf_field.
 237  *
 238  * The data is stored "right-justified".  For example, if "union mf_subvalue
 239  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
 240  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
 241 union mf_subvalue {
 242     uint8_t u8[16];
 243     ovs_be16 be16[8];
 244     ovs_be32 be32[4];
 245     ovs_be64 be64[2];
 246 };
 247 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
 248
 249 /* Finding mf_fields. */
 250 const struct mf_field *mf_from_id(enum mf_field_id);
 251 const struct mf_field *mf_from_name(const char *name);
 252 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
 253 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
 254
 255 /* Inspecting wildcarded bits. */
 256 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
 257
 258 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
 259 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
 260                  union mf_value *mask);
 261
 262 /* Prerequisites. */
 263 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
 264 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
 265
 266 /* Field values. */
 267 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
 268
 269 void mf_get_value(const struct mf_field *, const struct flow *,
 270                   union mf_value *value);
 271 void mf_set_value(const struct mf_field *, const union mf_value *value,
 272                   struct cls_rule *);
 273 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
 274                        struct flow *);
 275 bool mf_is_zero(const struct mf_field *, const struct flow *);
 276
 277 void mf_get(const struct mf_field *, const struct cls_rule *,
 278             union mf_value *value, union mf_value *mask);
 279 void mf_set(const struct mf_field *,
 280             const union mf_value *value, const union mf_value *mask,
 281             struct cls_rule *);
 282
 283 void mf_set_wild(const struct mf_field *, struct cls_rule *);
 284
 285 void mf_random_value(const struct mf_field *, union mf_value *value);
 286
 287 /* Subfields. */
 288 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
 289                        struct cls_rule *);
 290 void mf_set_subfield(const struct mf_subfield *, uint64_t value,
 291                      struct cls_rule *);
 292 void mf_set_subfield_value(const struct mf_subfield *, uint64_t value,
 293                            struct flow *);
 294
 295 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
 296                       union mf_subvalue *);
 297 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
 298
 299
 300 void mf_format_subfield(const struct mf_subfield *, struct ds *);
 301 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
 302 const char *mf_parse_subfield(struct mf_subfield *, const char *);
 303
 304 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
 305 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
 306
 307 /* Parsing and formatting. */
 308 char *mf_parse(const struct mf_field *, const char *,
 309                union mf_value *value, union mf_value *mask);
 310 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
 311 void mf_format(const struct mf_field *,
 312                const union mf_value *value, const union mf_value *mask,
 313                struct ds *);
 314
 315 #endif /* meta-flow.h */