X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fflow.h;h=d6dc30837cd0688d3855f6aa4f534178aab97f34;hb=7efa3dccd1968535ae32caf59746aa11ce7532f2;hp=35415057c52f18482d7c2f1012051e6574aa968d;hpb=34e63086edddcae06d7c1a4fa84fec0861e50758;p=sliver-openvswitch.git diff --git a/lib/flow.h b/lib/flow.h index 35415057c..d6dc30837 100644 --- a/lib/flow.h +++ b/lib/flow.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,86 +16,463 @@ #ifndef FLOW_H #define FLOW_H 1 +#include #include #include #include #include +#include "byte-order.h" +#include "openflow/nicira-ext.h" #include "openflow/openflow.h" #include "hash.h" -#include "openflow/openflow.h" -#include "openvswitch/datapath-protocol.h" #include "util.h" +struct dpif_flow_stats; struct ds; -struct ofp_match; +struct flow_wildcards; +struct minimask; struct ofpbuf; +struct pkt_metadata; + +/* This sequence number should be incremented whenever anything involving flows + * or the wildcarding of flows changes. This will cause build assertion + * failures in places which likely need to be updated. */ +#define FLOW_WC_SEQ 25 + +#define FLOW_N_REGS 8 +BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS); + +/* Used for struct flow's dl_type member for frames that have no Ethernet + * type, that is, pure 802.2 frames. */ +#define FLOW_DL_TYPE_NONE 0x5ff + +/* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */ +#define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */ +#define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */ +#define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER) + +BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY); +BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER); + +#define FLOW_TNL_F_DONT_FRAGMENT (1 << 0) +#define FLOW_TNL_F_CSUM (1 << 1) +#define FLOW_TNL_F_KEY (1 << 2) + +const char *flow_tun_flag_to_string(uint32_t flags); + +struct flow_tnl { + ovs_be64 tun_id; + ovs_be32 ip_src; + ovs_be32 ip_dst; + uint16_t flags; + uint8_t ip_tos; + uint8_t ip_ttl; +}; + +/* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port + * numbers and other times datapath (dpif) port numbers. This union allows + * access to both. */ +union flow_in_port { + odp_port_t odp_port; + ofp_port_t ofp_port; +}; + +/* Maximum number of supported MPLS labels. */ +#define FLOW_MAX_MPLS_LABELS 3 + +/* + * A flow in the network. + * + * Must be initialized to all zeros to make any compiler-induced padding + * zeroed. Helps also in keeping unused fields (such as mutually exclusive + * IPv4 and IPv6 addresses) zeroed out. + * + * The meaning of 'in_port' is context-dependent. In most cases, it is a + * 16-bit OpenFlow 1.0 port number. In the software datapath interface (dpif) + * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead + * a 32-bit datapath port number. + * + * The fields are organized in four segments to facilitate staged lookup, where + * lower layer fields are first used to determine if the later fields need to + * be looked at. This enables better wildcarding for datapath flows. + */ +struct flow { + /* L1 */ + struct flow_tnl tunnel; /* Encapsulating tunnel parameters. */ + ovs_be64 metadata; /* OpenFlow Metadata. */ + uint32_t regs[FLOW_N_REGS]; /* Registers. */ + uint32_t skb_priority; /* Packet priority for QoS. */ + uint32_t pkt_mark; /* Packet mark. */ + uint32_t recirc_id; /* Must be exact match. */ + union flow_in_port in_port; /* Input port.*/ + + /* L2 */ + uint8_t dl_src[6]; /* Ethernet source address. */ + uint8_t dl_dst[6]; /* Ethernet destination address. */ + ovs_be16 dl_type; /* Ethernet frame type. */ + ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ + ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */ + + /* L3 */ + struct in6_addr ipv6_src; /* IPv6 source address. */ + struct in6_addr ipv6_dst; /* IPv6 destination address. */ + struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */ + ovs_be32 ipv6_label; /* IPv6 flow label. */ + ovs_be32 nw_src; /* IPv4 source address. */ + ovs_be32 nw_dst; /* IPv4 destination address. */ + uint8_t nw_frag; /* FLOW_FRAG_* flags. */ + uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */ + uint8_t nw_ttl; /* IP TTL/Hop Limit. */ + uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */ + uint8_t arp_sha[6]; /* ARP/ND source hardware address. */ + uint8_t arp_tha[6]; /* ARP/ND target hardware address. */ + ovs_be16 tcp_flags; /* TCP flags. With L3 to avoid matching L4. */ + ovs_be16 pad; /* Padding. */ + + /* L4 */ + uint32_t dp_hash; /* Datapath computed hash value. The exact + computation is opaque to the user space.*/ + ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */ + ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. + * Keep last for the BUILD_ASSERT_DECL below */ +}; +BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0); + +#define FLOW_U32S (sizeof(struct flow) / 4) + +/* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */ +BUILD_ASSERT_DECL(offsetof(struct flow, tp_dst) + 2 + == sizeof(struct flow_tnl) + 172 + && FLOW_WC_SEQ == 25); -typedef struct odp_flow_key flow_t; +/* Incremental points at which flow classification may be performed in + * segments. + * This is located here since this is dependent on the structure of the + * struct flow defined above: + * Each offset must be on a distint, successive U32 boundary srtictly + * within the struct flow. */ +enum { + FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_src), + FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src), + FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, dp_hash), +}; +BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0); +BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0); +BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0); +BUILD_ASSERT_DECL( 0 < FLOW_SEGMENT_1_ENDS_AT); +BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT); +BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT); +BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow)); + +extern const uint8_t flow_segment_u32s[]; + +/* Represents the metadata fields of struct flow. */ +struct flow_metadata { + uint32_t dp_hash; /* Datapath computed hash field. */ + uint32_t recirc_id; /* Recirculation ID. */ + ovs_be64 tun_id; /* Encapsulating tunnel ID. */ + ovs_be32 tun_src; /* Tunnel outer IPv4 src addr */ + ovs_be32 tun_dst; /* Tunnel outer IPv4 dst addr */ + ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */ + uint32_t regs[FLOW_N_REGS]; /* Registers. */ + uint32_t pkt_mark; /* Packet mark. */ + ofp_port_t in_port; /* OpenFlow port or zero. */ +}; + +void flow_extract(struct ofpbuf *, const struct pkt_metadata *md, + struct flow *); + +void flow_zero_wildcards(struct flow *, const struct flow_wildcards *); +void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *); +void flow_get_metadata(const struct flow *, struct flow_metadata *); + +char *flow_to_string(const struct flow *); +void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t), + uint32_t flags, char del); +void format_flags_masked(struct ds *ds, const char *name, + const char *(*bit_to_string)(uint32_t), + uint32_t flags, uint32_t mask); -int flow_extract(struct ofpbuf *, uint16_t in_port, flow_t *); -void flow_extract_stats(const flow_t *flow, struct ofpbuf *packet, - struct odp_flow_stats *stats); -void flow_to_match(const flow_t *, uint32_t wildcards, struct ofp_match *); -void flow_from_match(flow_t *, uint32_t *wildcards, const struct ofp_match *); -char *flow_to_string(const flow_t *); -void flow_format(struct ds *, const flow_t *); -void flow_print(FILE *, const flow_t *); -static inline int flow_compare(const flow_t *, const flow_t *); -static inline bool flow_equal(const flow_t *, const flow_t *); -static inline size_t flow_hash(const flow_t *, uint32_t basis); +void flow_format(struct ds *, const struct flow *); +void flow_print(FILE *, const struct flow *); +static inline int flow_compare_3way(const struct flow *, const struct flow *); +static inline bool flow_equal(const struct flow *, const struct flow *); +static inline size_t flow_hash(const struct flow *, uint32_t basis); + +void flow_set_dl_vlan(struct flow *, ovs_be16 vid); +void flow_set_vlan_vid(struct flow *, ovs_be16 vid); +void flow_set_vlan_pcp(struct flow *, uint8_t pcp); + +int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *); +int flow_count_common_mpls_labels(const struct flow *a, int an, + const struct flow *b, int bn, + struct flow_wildcards *wc); +void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type, + struct flow_wildcards *); +bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type, + struct flow_wildcards *); +void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label); +void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl); +void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc); +void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack); +void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse); + +void flow_compose(struct ofpbuf *, const struct flow *); static inline int -flow_compare(const flow_t *a, const flow_t *b) +flow_compare_3way(const struct flow *a, const struct flow *b) { return memcmp(a, b, sizeof *a); } static inline bool -flow_equal(const flow_t *a, const flow_t *b) +flow_equal(const struct flow *a, const struct flow *b) { - return !flow_compare(a, b); + return !flow_compare_3way(a, b); } static inline size_t -flow_hash(const flow_t *flow, uint32_t basis) +flow_hash(const struct flow *flow, uint32_t basis) +{ + return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis); +} + +static inline uint16_t +ofp_to_u16(ofp_port_t ofp_port) +{ + return (OVS_FORCE uint16_t) ofp_port; +} + +static inline uint32_t +odp_to_u32(odp_port_t odp_port) +{ + return (OVS_FORCE uint32_t) odp_port; +} + +static inline uint32_t +ofp11_to_u32(ofp11_port_t ofp11_port) +{ + return (OVS_FORCE uint32_t) ofp11_port; +} + +static inline ofp_port_t +u16_to_ofp(uint16_t port) +{ + return OFP_PORT_C(port); +} + +static inline odp_port_t +u32_to_odp(uint32_t port) +{ + return ODP_PORT_C(port); +} + +static inline ofp11_port_t +u32_to_ofp11(uint32_t port) +{ + return OFP11_PORT_C(port); +} + +static inline uint32_t +hash_ofp_port(ofp_port_t ofp_port) +{ + return hash_int(ofp_to_u16(ofp_port), 0); +} + +static inline uint32_t +hash_odp_port(odp_port_t odp_port) { - BUILD_ASSERT_DECL(!(sizeof *flow % sizeof(uint32_t))); - return hash_words((const uint32_t *) flow, - sizeof *flow / sizeof(uint32_t), basis); + return hash_int(odp_to_u32(odp_port), 0); } -/* Information on wildcards for a flow, as a supplement to flow_t. */ +uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *, + uint32_t basis); +uint32_t flow_hash_in_minimask_range(const struct flow *, + const struct minimask *, + uint8_t start, uint8_t end, + uint32_t *basis); + +/* Wildcards for a flow. + * + * A 1-bit in each bit in 'masks' indicates that the corresponding bit of + * the flow is significant (must match). A 0-bit indicates that the + * corresponding bit of the flow is wildcarded (need not match). */ struct flow_wildcards { - uint32_t wildcards; /* enum ofp_flow_wildcards (in host order). */ - uint32_t nw_src_mask; /* 1-bit in each significant nw_src bit. */ - uint32_t nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ + struct flow masks; +}; + +void flow_wildcards_init_catchall(struct flow_wildcards *); + +void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *); + +bool flow_wildcards_is_catchall(const struct flow_wildcards *); + +void flow_wildcards_set_reg_mask(struct flow_wildcards *, + int idx, uint32_t mask); + +void flow_wildcards_and(struct flow_wildcards *dst, + const struct flow_wildcards *src1, + const struct flow_wildcards *src2); +void flow_wildcards_or(struct flow_wildcards *dst, + const struct flow_wildcards *src1, + const struct flow_wildcards *src2); +bool flow_wildcards_has_extra(const struct flow_wildcards *, + const struct flow_wildcards *); + +void flow_wildcards_fold_minimask(struct flow_wildcards *, + const struct minimask *); +void flow_wildcards_fold_minimask_range(struct flow_wildcards *, + const struct minimask *, + uint8_t start, uint8_t end); + +uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis); +bool flow_wildcards_equal(const struct flow_wildcards *, + const struct flow_wildcards *); +uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis); +uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis); + +/* Initialize a flow with random fields that matter for nx_hash_fields. */ +void flow_random_hash_fields(struct flow *); +void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *, + enum nx_hash_fields); +uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields, + uint16_t basis); +const char *flow_hash_fields_to_str(enum nx_hash_fields); +bool flow_hash_fields_valid(enum nx_hash_fields); + +uint32_t flow_hash_in_wildcards(const struct flow *, + const struct flow_wildcards *, + uint32_t basis); + +bool flow_equal_except(const struct flow *a, const struct flow *b, + const struct flow_wildcards *); + +/* Compressed flow. */ + +#define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8) +BUILD_ASSERT_DECL(FLOW_U32S <= 64); + +/* A sparse representation of a "struct flow". + * + * A "struct flow" is fairly large and tends to be mostly zeros. Sparse + * representation has two advantages. First, it saves memory. Second, it + * saves time when the goal is to iterate over only the nonzero parts of the + * struct. + * + * The 'map' member holds one bit for each uint32_t in a "struct flow". Each + * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it + * *may* be nonzero. + * + * 'values' points to the start of an array that has one element for each 1-bit + * in 'map'. The least-numbered 1-bit is in values[0], the next 1-bit is in + * values[1], and so on. + * + * 'values' may point to a few different locations: + * + * - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to + * 'inline_values'. One hopes that this is the common case. + * + * - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory + * allocated with malloc(). + * + * - The caller could provide storage on the stack for situations where + * that makes sense. So far that's only proved useful for + * minimask_combine(), but the principle works elsewhere. + * + * Elements in 'values' are allowed to be zero. This is useful for "struct + * minimatch", for which ensuring that the miniflow and minimask members have + * same 'map' allows optimization. This allowance applies only to a miniflow + * that is not a mask. That is, a minimask may NOT have zero elements in + * its 'values'. + */ +struct miniflow { + uint64_t map; + uint32_t *values; + uint32_t inline_values[MINI_N_INLINE]; }; -/* Given the wildcard bit count in bits 'shift' through 'shift + 5' (inclusive) - * of 'wildcards', returns a 32-bit bit mask with a 1 in each bit that must - * match and a 0 in each bit that is wildcarded. +void miniflow_init(struct miniflow *, const struct flow *); +void miniflow_init_with_minimask(struct miniflow *, const struct flow *, + const struct minimask *); +void miniflow_clone(struct miniflow *, const struct miniflow *); +void miniflow_move(struct miniflow *dst, struct miniflow *); +void miniflow_destroy(struct miniflow *); + +void miniflow_expand(const struct miniflow *, struct flow *); + +uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs); +uint16_t miniflow_get_vid(const struct miniflow *); +static inline ovs_be64 miniflow_get_metadata(const struct miniflow *); + +bool miniflow_equal(const struct miniflow *a, const struct miniflow *b); +bool miniflow_equal_in_minimask(const struct miniflow *a, + const struct miniflow *b, + const struct minimask *); +bool miniflow_equal_flow_in_minimask(const struct miniflow *a, + const struct flow *b, + const struct minimask *); +uint32_t miniflow_hash(const struct miniflow *, uint32_t basis); +uint32_t miniflow_hash_in_minimask(const struct miniflow *, + const struct minimask *, uint32_t basis); +uint64_t miniflow_get_map_in_range(const struct miniflow *miniflow, + uint8_t start, uint8_t end, + unsigned int *offset); + + +/* Compressed flow wildcards. */ + +/* A sparse representation of a "struct flow_wildcards". * - * The bits in 'wildcards' are in the format used in enum ofp_flow_wildcards: 0 - * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits, - * ..., 32 and higher wildcard the entire field. This is the *opposite* of the - * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are - * wildcarded. + * See the large comment on struct miniflow for details. * - * 'wildcards' is in host byte order. The return value is in network byte - * order. */ -static inline uint32_t -flow_nw_bits_to_mask(uint32_t wildcards, int shift) + * Note: While miniflow can have zero data for a 1-bit in the map, + * a minimask may not! We rely on this in the implementation. */ +struct minimask { + struct miniflow masks; +}; + +void minimask_init(struct minimask *, const struct flow_wildcards *); +void minimask_clone(struct minimask *, const struct minimask *); +void minimask_move(struct minimask *dst, struct minimask *src); +void minimask_combine(struct minimask *dst, + const struct minimask *a, const struct minimask *b, + uint32_t storage[FLOW_U32S]); +void minimask_destroy(struct minimask *); + +void minimask_expand(const struct minimask *, struct flow_wildcards *); + +uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs); +uint16_t minimask_get_vid_mask(const struct minimask *); +static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *); + +bool minimask_equal(const struct minimask *a, const struct minimask *b); +uint32_t minimask_hash(const struct minimask *, uint32_t basis); + +bool minimask_has_extra(const struct minimask *, const struct minimask *); +bool minimask_is_catchall(const struct minimask *); + +/* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */ +static inline ovs_be64 +miniflow_get_metadata(const struct miniflow *flow) { - wildcards = (wildcards >> shift) & 0x3f; - return wildcards < 32 ? htonl(~((1u << wildcards) - 1)) : 0; + enum { MD_OFS = offsetof(struct flow, metadata) }; + BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0); + ovs_be32 hi = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4); + ovs_be32 lo = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4 + 1); + + return htonll(((uint64_t) ntohl(hi) << 32) | ntohl(lo)); } -static inline void -flow_wildcards_init(struct flow_wildcards *wc, uint32_t wildcards) +/* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'. + * + * The return value is all-1-bits if 'mask' matches on the whole value of the + * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field, + * or some other value if the metadata field is partially matched, partially + * wildcarded. */ +static inline ovs_be64 +minimask_get_metadata_mask(const struct minimask *mask) { - wc->wildcards = wildcards & OFPFW_ALL; - wc->nw_src_mask = flow_nw_bits_to_mask(wc->wildcards, OFPFW_NW_SRC_SHIFT); - wc->nw_dst_mask = flow_nw_bits_to_mask(wc->wildcards, OFPFW_NW_DST_SHIFT); + return miniflow_get_metadata(&mask->masks); } #endif /* flow.h */