2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <sys/types.h>
20 #include <netinet/in.h>
24 #include "openflow/nicira-ext.h"
25 #include "openflow/openflow.h"
27 #include "openvswitch/datapath-protocol.h"
31 struct flow_wildcards;
36 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
39 uint32_t regs[FLOW_N_REGS]; /* Registers. */
40 ovs_be32 tun_id; /* Encapsulating tunnel ID. */
41 ovs_be32 nw_src; /* IP source address. */
42 ovs_be32 nw_dst; /* IP destination address. */
43 uint16_t in_port; /* Input switch port. */
44 ovs_be16 dl_vlan; /* Input VLAN. */
45 ovs_be16 dl_type; /* Ethernet frame type. */
46 ovs_be16 tp_src; /* TCP/UDP source port. */
47 ovs_be16 tp_dst; /* TCP/UDP destination port. */
48 uint8_t dl_src[6]; /* Ethernet source address. */
49 uint8_t dl_dst[6]; /* Ethernet destination address. */
50 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
51 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
52 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
55 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
56 * flow", followed by FLOW_PAD_SIZE bytes of padding. */
57 #define FLOW_SIG_SIZE (37 + FLOW_N_REGS * 4)
58 #define FLOW_PAD_SIZE 3
59 BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
60 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
61 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
63 int flow_extract(struct ofpbuf *, ovs_be32 tun_id, uint16_t in_port,
65 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
66 struct odp_flow_stats *stats);
67 void flow_to_match(const struct flow *, uint32_t wildcards, int flow_format,
69 void flow_from_match(const struct ofp_match *, int flow_format,
70 ovs_be64 cookie, struct flow *, struct flow_wildcards *);
71 char *flow_to_string(const struct flow *);
72 void flow_format(struct ds *, const struct flow *);
73 void flow_print(FILE *, const struct flow *);
74 static inline int flow_compare(const struct flow *, const struct flow *);
75 static inline bool flow_equal(const struct flow *, const struct flow *);
76 static inline size_t flow_hash(const struct flow *, uint32_t basis);
79 flow_compare(const struct flow *a, const struct flow *b)
81 return memcmp(a, b, FLOW_SIG_SIZE);
85 flow_equal(const struct flow *a, const struct flow *b)
87 return !flow_compare(a, b);
91 flow_hash(const struct flow *flow, uint32_t basis)
93 return hash_bytes(flow, FLOW_SIG_SIZE, basis);
96 /* Open vSwitch internal-only wildcard bits.
98 * These are used only internally to Open vSwitch, in the 'wildcards' member of
99 * struct flow_wildcards. They never appear in the wire protocol in this
102 /* Set to 1 if any bits in any of the reg_masks are wildcarded. This maintains
103 * the invariant that 'wildcards' is nonzero if and only if any bits are
105 #define FWW_REGS (1u << 31)
107 /* Set to 1 if bit 0 (the multicast bit) of the flow's dl_dst is wildcarded.
109 * (We reinterpret OFPFW_DL_DST as excluding bit 0. Both OFPFW_DL_DST and
110 * FWW_ETH_MCAST have to be set to wildcard the entire Ethernet destination
112 #define FWW_ETH_MCAST (1u << 30)
114 /* Avoid collisions. */
115 #define FWW_ALL (FWW_REGS | FWW_ETH_MCAST)
116 BUILD_ASSERT_DECL(!(FWW_ALL & OVSFW_ALL));
118 /* Information on wildcards for a flow, as a supplement to "struct flow".
120 * The flow_wildcards_*() functions below both depend on and maintain the
121 * following important invariants:
123 * 1. 'wildcards' is nonzero if and only if at least one bit or field is
126 * 2. Bits in 'wildcards' not included in OVSFW_ALL or FWW_ALL are set to 0.
127 * (This is a corollary to invariant #1.)
129 * 3. The fields in 'wildcards' masked by OFPFW_NW_SRC_MASK and
130 * OFPFW_NW_DST_MASK have values between 0 and 32, inclusive.
132 * 4. The fields masked by OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK correspond
133 * correctly to the masks in 'nw_src_mask' and 'nw_dst_mask', respectively.
135 * 5. FWW_REGS is set to 1 in 'wildcards' if and only if at least one bit in
136 * 'reg_masks[]' is nonzero. (This allows wildcarded 'reg_masks[]' to
137 * satisfy invariant #1.)
139 * 6. If FWW_REGS is set to 0 in 'wildcards', then the values of all of the
140 * other members can be correctly predicted based on 'wildcards' alone.
142 struct flow_wildcards {
143 uint32_t wildcards; /* OFPFW_* | OVSFW_* | FWW_*. */
144 uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
145 ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */
146 ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */
149 ovs_be32 flow_nw_bits_to_mask(uint32_t wildcards, int shift);
150 void flow_wildcards_init(struct flow_wildcards *, uint32_t wildcards);
151 void flow_wildcards_init_exact(struct flow_wildcards *);
153 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
154 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
155 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
156 int idx, uint32_t mask);
158 void flow_wildcards_combine(struct flow_wildcards *dst,
159 const struct flow_wildcards *src1,
160 const struct flow_wildcards *src2);
161 bool flow_wildcards_has_extra(const struct flow_wildcards *,
162 const struct flow_wildcards *);
164 uint32_t flow_wildcards_hash(const struct flow_wildcards *);
165 bool flow_wildcards_equal(const struct flow_wildcards *,
166 const struct flow_wildcards *);