X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fflow.h;h=5e78f7963b1dfbb72b1915e4a7089a793f28db90;hb=cc34bc8c8611868474253b8fbd9e79cd66c60c94;hp=cb2010996f43ca1183ef4b4d6af4c95629af6cf8;hpb=f1acd62b54376a425a975f9af501c4c8c5689b39;p=openvswitch diff --git a/lib/flow.h b/lib/flow.h index cb201099..5e78f796 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 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,87 +16,209 @@ #ifndef FLOW_H #define FLOW_H 1 +#include #include #include #include #include +#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 ofpbuf; -typedef struct odp_flow_key flow_t; - -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_to_ovs_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); +/* 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 14 + +#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); + +struct flow { + ovs_be64 tun_id; /* Encapsulating tunnel ID. */ + ovs_be64 metadata; /* OpenFlow Metadata. */ + 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. */ + uint32_t skb_priority; /* Packet priority for QoS. */ + uint32_t regs[FLOW_N_REGS]; /* Registers. */ + ovs_be32 nw_src; /* IPv4 source address. */ + ovs_be32 nw_dst; /* IPv4 destination address. */ + ovs_be32 ipv6_label; /* IPv6 flow label. */ + uint16_t in_port; /* OpenFlow port number of input port. */ + ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ + ovs_be16 dl_type; /* Ethernet frame type. */ + ovs_be16 tp_src; /* TCP/UDP source port. */ + ovs_be16 tp_dst; /* TCP/UDP destination port. */ + uint8_t dl_src[6]; /* Ethernet source address. */ + uint8_t dl_dst[6]; /* Ethernet destination address. */ + uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */ + uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */ + uint8_t arp_sha[6]; /* ARP/ND source hardware address. */ + uint8_t arp_tha[6]; /* ARP/ND target hardware address. */ + uint8_t nw_ttl; /* IP TTL/Hop Limit. */ + uint8_t nw_frag; /* FLOW_FRAG_* flags. */ + uint8_t reserved[2]; /* Reserved for 64-bit packing. */ +}; + +/* Represents the metadata fields of struct flow. The masks are used to + * indicate which metadata fields are relevant in a given context. Typically + * they will be all 1 or all 0. */ +struct flow_metadata { + ovs_be64 tun_id; /* Encapsulating tunnel ID. */ + ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit.*/ + + ovs_be64 metadata; + ovs_be64 metadata_mask; + + uint32_t regs[FLOW_N_REGS]; /* Registers. */ + uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ + + uint16_t in_port; /* OpenFlow port or zero. */ +}; + +/* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct + * flow", followed by FLOW_PAD_SIZE bytes of padding. */ +#define FLOW_SIG_SIZE (118 + FLOW_N_REGS * 4) +#define FLOW_PAD_SIZE 2 +BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) == FLOW_SIG_SIZE - 1); +BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_frag) == 1); +BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE); + +/* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */ +BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 150 && FLOW_WC_SEQ == 14); + +void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id, + uint16_t in_port, struct flow *); +void flow_zero_wildcards(struct flow *, const struct flow_wildcards *); +void flow_get_metadata(const struct flow *, struct flow_metadata *); + +char *flow_to_string(const struct flow *); +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); + +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); + return memcmp(a, b, FLOW_SIG_SIZE); } 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) { - BUILD_ASSERT_DECL(!(sizeof *flow % sizeof(uint32_t))); - return hash_words((const uint32_t *) flow, - sizeof *flow / sizeof(uint32_t), basis); + return hash_bytes(flow, FLOW_SIG_SIZE, basis); } -/* Information on wildcards for a flow, as a supplement to flow_t. */ +/* Open vSwitch flow wildcard bits. + * + * These are used only internally to Open vSwitch, in the 'wildcards' member of + * struct flow_wildcards. They never appear in the wire protocol in this + * form. */ + +typedef unsigned int OVS_BITWISE flow_wildcards_t; + +/* Same values and meanings as corresponding OFPFW10_* bits. */ +#define FWW_IN_PORT ((OVS_FORCE flow_wildcards_t) (1 << 0)) +#define FWW_DL_TYPE ((OVS_FORCE flow_wildcards_t) (1 << 4)) +#define FWW_NW_PROTO ((OVS_FORCE flow_wildcards_t) (1 << 5)) +/* No corresponding OFPFW10_* bits. */ +#define FWW_NW_DSCP ((OVS_FORCE flow_wildcards_t) (1 << 1)) +#define FWW_NW_ECN ((OVS_FORCE flow_wildcards_t) (1 << 2)) +#define FWW_NW_TTL ((OVS_FORCE flow_wildcards_t) (1 << 3)) +#define FWW_ALL ((OVS_FORCE flow_wildcards_t) (((1 << 6)) - 1)) + +/* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */ +BUILD_ASSERT_DECL(FWW_ALL == ((1 << 6) - 1) && FLOW_WC_SEQ == 14); + +/* Information on wildcards for a flow, as a supplement to "struct flow". + * + * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in + * the rest of the members. */ 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. */ + ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */ + ovs_be64 metadata_mask; /* 1-bit in each significant metadata bit. */ + flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */ + uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ + ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */ + ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ + struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */ + struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */ + struct in6_addr nd_target_mask; /* 1-bit in each significant + nd_target bit. */ + ovs_be32 ipv6_label_mask; /* 1 bit in each significant ipv6_label bit. */ + ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */ + ovs_be16 tp_src_mask; /* 1-bit in each significant tp_src bit. */ + ovs_be16 tp_dst_mask; /* 1-bit in each significant tp_dst bit. */ + uint8_t nw_frag_mask; /* 1-bit in each significant nw_frag bit. */ + uint8_t dl_src_mask[6]; /* 1-bit in each significant dl_src bit. */ + uint8_t dl_dst_mask[6]; /* 1-bit in each significant dl_dst bit. */ + uint8_t arp_sha_mask[6]; /* 1-bit in each significant dl_dst bit. */ + uint8_t arp_tha_mask[6]; /* 1-bit in each significant dl_dst bit. */ + uint8_t zeros[1]; /* Padding field set to zero. */ }; -/* 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. - * - * 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. - * - * '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) -{ - wildcards = (wildcards >> shift) & 0x3f; - return wildcards < 32 ? htonl(~((1u << wildcards) - 1)) : 0; -} +/* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */ +BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 144 && FLOW_WC_SEQ == 14); -static inline void -flow_wildcards_init(struct flow_wildcards *wc, uint32_t wildcards) -{ - 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); -} +void flow_wildcards_init_catchall(struct flow_wildcards *); +void flow_wildcards_init_exact(struct flow_wildcards *); + +bool flow_wildcards_is_exact(const 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_combine(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 *); + +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_symmetric_l4(const struct flow *flow, uint32_t basis); + +const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t); +bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]); +flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t, + const uint8_t mask[6]); +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); #endif /* flow.h */