/*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef FLOW_H
#define FLOW_H 1
+#include <sys/types.h>
#include <netinet/in.h>
#include <stdbool.h>
#include <stdint.h>
#include <string.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 ofp_match;
struct ofpbuf;
-typedef struct odp_flow_key flow_t;
+struct flow {
+ ovs_be32 tun_id; /* Encapsulating tunnel ID. */
+ ovs_be32 nw_src; /* IP source address. */
+ ovs_be32 nw_dst; /* IP destination address. */
+ uint16_t in_port; /* Input switch port. */
+ ovs_be16 dl_vlan; /* Input VLAN. */
+ 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 dl_vlan_pcp; /* Input VLAN priority. */
+ uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
+};
+
+/* 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 37
+#define FLOW_PAD_SIZE 3
+BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
+BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
+BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
-int flow_extract(struct ofpbuf *, uint16_t in_port, flow_t *);
-void flow_extract_stats(const flow_t *flow, struct ofpbuf *packet,
+int flow_extract(struct ofpbuf *, ovs_be32 tun_id, uint16_t in_port,
+ struct flow *);
+void flow_extract_stats(const struct flow *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_to_match(const struct flow *, uint32_t wildcards, bool tun_id_cookie,
+ struct ofp_match *);
+void flow_from_match(const struct ofp_match *, bool tun_id_from_cookie,
+ ovs_be64 cookie, struct flow *, uint32_t *wildcards);
+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(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);
static inline int
-flow_compare(const flow_t *a, const flow_t *b)
+flow_compare(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);
}
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. */
+/* Information on wildcards for a flow, as a supplement to "struct flow".
+ *
+ * The flow_wildcards_*() functions below both depend on and maintain the
+ * following important invariants:
+ *
+ * 1. 'wildcards' is nonzero if and only if at least one bit or field is
+ * wildcarded.
+ *
+ * 2. Bits in 'wildcards' not included in OVSFW_ALL are set to 0. (This is a
+ * corollary to invariant #1.)
+ *
+ * 3. The fields in 'wildcards' masked by OFPFW_NW_SRC_MASK and
+ * OFPFW_NW_DST_MASK have values between 0 and 32, inclusive.
+ *
+ * 4. The fields masked by OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK correspond
+ * correctly to the masks in 'nw_src_mask' and 'nw_dst_mask', respectively.
+ */
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. */
+ uint32_t wildcards; /* enum ofp_flow_wildcards. */
+ 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. */
};
-/* 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;
-}
+ovs_be32 flow_nw_bits_to_mask(uint32_t wildcards, int shift);
+void flow_wildcards_init(struct flow_wildcards *, uint32_t wildcards);
+void flow_wildcards_init_exact(struct flow_wildcards *);
-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);
-}
+bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
+bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
+
+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 *);
+bool flow_wildcards_equal(const struct flow_wildcards *,
+ const struct flow_wildcards *);
#endif /* flow.h */
git://git.onelab.eu / sliver-openvswitch.git / blobdiff