X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fmeta-flow.h;h=bc402dc0abc2b8193ea92f2943c1e3470937d3e9;hb=4b570f12766f3c4eeb527de69d8eedfd59c34b86;hp=e2079359fb920fe20969883f181ad2a49b9f142c;hpb=a61680c6d15fa1f1ae3072a83c0e3d7ed08f6048;p=sliver-openvswitch.git diff --git a/lib/meta-flow.h b/lib/meta-flow.h index e2079359f..bc402dc0a 100644 --- a/lib/meta-flow.h +++ b/lib/meta-flow.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011 Nicira Networks. + * Copyright (c) 2011, 2012, 2013 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,17 +21,27 @@ #include #include #include "flow.h" +#include "ofp-errors.h" #include "packets.h" -struct cls_rule; struct ds; +struct match; /* The comment on each of these indicates the member in "union mf_value" used * to represent its value. */ 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_SKB_MARK, /* be32 */ #if FLOW_N_REGS > 0 MFF_REG0, /* be32 */ @@ -49,7 +59,13 @@ enum mf_field_id { MFF_REG4, /* be32 */ #endif #if FLOW_N_REGS > 5 -#error + MFF_REG5, /* be32 */ +#endif +#if FLOW_N_REGS > 6 + MFF_REG6, /* be32 */ +#endif +#if FLOW_N_REGS > 7 + MFF_REG7, /* be32 */ #endif /* L2. */ @@ -58,8 +74,15 @@ enum mf_field_id { MFF_ETH_TYPE, /* be16 */ MFF_VLAN_TCI, /* be16 */ - MFF_VLAN_VID, /* be16 */ - MFF_VLAN_PCP, /* u8 */ + 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 */ @@ -69,8 +92,18 @@ enum mf_field_id { 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) */ @@ -88,8 +121,11 @@ enum mf_field_id { MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */ MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */ - MFF_ICMP_TYPE, /* u8 (used for IPv4 or IPv6) */ - MFF_ICMP_CODE, /* u8 (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 */ @@ -99,6 +135,40 @@ enum mf_field_id { MFF_N_IDS }; +/* 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 \ + 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 +#endif + /* Prerequisites for matching a field. * * A field may only be matched if the correct lower-level protocols are also @@ -109,15 +179,19 @@ enum mf_prereqs { /* L2 requirements. */ MFP_ARP, + MFP_VLAN_VID, MFP_IPV4, MFP_IPV6, MFP_IP_ANY, + /* L2.5 requirements. */ + MFP_MPLS, + /* L2+L3 requirements. */ MFP_TCP, /* On IPv4 or IPv6. */ MFP_UDP, /* On IPv4 or IPv6. */ + MFP_ICMPV4, MFP_ICMPV6, - MFP_ICMP_ANY, /* L2+L3+L4 requirements. */ MFP_ND, @@ -131,8 +205,6 @@ enum mf_prereqs { enum mf_maskable { MFM_NONE, /* No sub-field masking. */ MFM_FULLY, /* Every bit is individually maskable. */ - MFM_CIDR, /* Contiguous low-order bits may be masked. */ - MFM_MCAST /* Byte 0, bit 0 is separately maskable. */ }; /* How to format or parse a field's value. */ @@ -149,7 +221,9 @@ enum mf_string { MFS_IPV4, MFS_IPV6, MFS_OFP_PORT, /* An OpenFlow port number or name. */ - MFS_FRAG /* no, yes, first, later, not_later */ + MFS_OFP_PORT_OXM, /* An OpenFlow port number or name (32-bit). */ + MFS_FRAG, /* no, yes, first, later, not_later */ + MFS_TNL_FLAGS, /* FLOW_TNL_F_* flags */ }; struct mf_field { @@ -166,16 +240,43 @@ struct mf_field { * - "dl_vlan_pcp" is 1 byte but only 3 bits. * - "is_frag" is 1 byte but only 2 bits. * - "ipv6_label" is 4 bytes but only 20 bits. + * - "mpls_label" is 4 bytes but only 20 bits. + * - "mpls_tc" is 1 byte but only 3 bits. + * - "mpls_bos" is 1 byte but only 1 bit. */ unsigned int n_bytes; /* Width of the field in bytes. */ unsigned int n_bits; /* Number of significant bits in field. */ /* Properties. */ enum mf_maskable maskable; - flow_wildcards_t fww_bit; /* Either 0 or exactly one FWW_* bit. */ enum mf_string string; enum mf_prereqs prereqs; - uint32_t nxm_header; /* An NXM_* constant (a few fields have 0). */ + 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 */ }; /* The representation of a field's value. */ @@ -187,10 +288,33 @@ union mf_value { uint8_t mac[ETH_ADDR_LEN]; struct in6_addr ipv6; }; +BUILD_ASSERT_DECL(sizeof(union mf_value) == 16); + +/* Part of a field. */ +struct mf_subfield { + const struct mf_field *field; + unsigned int ofs; /* Bit offset. */ + unsigned int n_bits; /* Number of bits. */ +}; + +/* Data for some part of an mf_field. + * + * The data is stored "right-justified". For example, if "union mf_subvalue + * 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]; +}; +BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue)); /* Finding mf_fields. */ const struct mf_field *mf_from_id(enum mf_field_id); 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); /* Inspecting wildcarded bits. */ bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *); @@ -201,7 +325,7 @@ 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_force_prereqs(const struct mf_field *, struct cls_rule *); +void mf_force_prereqs(const struct mf_field *, struct match *); /* Field values. */ bool mf_is_value_valid(const struct mf_field *, const union mf_value *value); @@ -209,20 +333,41 @@ 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 cls_rule *); + struct match *); +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_get(const struct mf_field *, const struct cls_rule *, +void mf_get(const struct mf_field *, const struct match *, union mf_value *value, union mf_value *mask); void mf_set(const struct mf_field *, const union mf_value *value, const union mf_value *mask, - struct cls_rule *); -void mf_set_subfield(const struct mf_field *, uint64_t value, unsigned int ofs, - unsigned int n_bits, struct cls_rule *); + struct match *); -void mf_set_wild(const struct mf_field *, struct cls_rule *); +void mf_set_wild(const struct mf_field *, struct match *); void mf_random_value(const struct mf_field *, union mf_value *value); +/* 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_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 *); + /* Parsing and formatting. */ char *mf_parse(const struct mf_field *, const char *, union mf_value *value, union mf_value *mask); @@ -230,5 +375,6 @@ char *mf_parse_value(const struct mf_field *, const char *, union mf_value *); void mf_format(const struct mf_field *, const union mf_value *value, const union mf_value *mask, struct ds *); +void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s); #endif /* meta-flow.h */