]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
73f33563 | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
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. | |
064af421 BP |
15 | */ |
16 | #ifndef FLOW_H | |
17 | #define FLOW_H 1 | |
18 | ||
7f3adc00 | 19 | #include <sys/types.h> |
064af421 BP |
20 | #include <netinet/in.h> |
21 | #include <stdbool.h> | |
22 | #include <stdint.h> | |
23 | #include <string.h> | |
659586ef | 24 | #include "openflow/nicira-ext.h" |
064af421 BP |
25 | #include "openflow/openflow.h" |
26 | #include "hash.h" | |
064af421 BP |
27 | #include "util.h" |
28 | ||
c97fb132 | 29 | struct dpif_flow_stats; |
064af421 | 30 | struct ds; |
b63f2ea7 | 31 | struct flow_wildcards; |
064af421 BP |
32 | struct ofp_match; |
33 | struct ofpbuf; | |
34 | ||
a877206f EJ |
35 | /* This sequence number should be incremented whenever anything involving flows |
36 | * or the wildcarding of flows changes. This will cause build assertion | |
37 | * failures in places which likely need to be updated. */ | |
73f33563 | 38 | #define FLOW_WC_SEQ 8 |
a877206f | 39 | |
d2c0fed9 | 40 | #define FLOW_N_REGS 5 |
b6c9e612 BP |
41 | BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS); |
42 | ||
36956a7d BP |
43 | /* Used for struct flow's dl_type member for frames that have no Ethernet |
44 | * type, that is, pure 802.2 frames. */ | |
45 | #define FLOW_DL_TYPE_NONE 0x5ff | |
46 | ||
7257b535 | 47 | /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */ |
eadef313 JP |
48 | #define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */ |
49 | #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */ | |
50 | #define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER) | |
7257b535 | 51 | |
eadef313 JP |
52 | BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY); |
53 | BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER); | |
7257b535 | 54 | |
14608a15 | 55 | struct flow { |
b9298d3f | 56 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ |
5145475f JP |
57 | struct in6_addr ipv6_src; /* IPv6 source address. */ |
58 | struct in6_addr ipv6_dst; /* IPv6 destination address. */ | |
59 | struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */ | |
deedf7e7 | 60 | uint32_t skb_priority; /* Packet priority for QoS. */ |
b6c9e612 | 61 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ |
d31f1109 JP |
62 | ovs_be32 nw_src; /* IPv4 source address. */ |
63 | ovs_be32 nw_dst; /* IPv4 destination address. */ | |
fa8223b7 | 64 | ovs_be32 ipv6_label; /* IPv6 flow label. */ |
abe529af | 65 | uint16_t in_port; /* OpenFlow port number of input port. */ |
66642cb4 | 66 | ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ |
0b3e77bb BP |
67 | ovs_be16 dl_type; /* Ethernet frame type. */ |
68 | ovs_be16 tp_src; /* TCP/UDP source port. */ | |
69 | ovs_be16 tp_dst; /* TCP/UDP destination port. */ | |
14608a15 BP |
70 | uint8_t dl_src[6]; /* Ethernet source address. */ |
71 | uint8_t dl_dst[6]; /* Ethernet destination address. */ | |
72 | uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */ | |
eadef313 | 73 | uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */ |
685a51a5 JP |
74 | uint8_t arp_sha[6]; /* ARP/ND source hardware address. */ |
75 | uint8_t arp_tha[6]; /* ARP/ND target hardware address. */ | |
a61680c6 | 76 | uint8_t nw_ttl; /* IP TTL/Hop Limit. */ |
eadef313 | 77 | uint8_t nw_frag; /* FLOW_FRAG_* flags. */ |
a61680c6 | 78 | uint8_t reserved[6]; /* Reserved for 64-bit packing. */ |
14608a15 BP |
79 | }; |
80 | ||
5d6c3af0 EJ |
81 | /* Represents the metadata fields of struct flow. The masks are used to |
82 | * indicate which metadata fields are relevant in a given context. Typically | |
83 | * they will be all 1 or all 0. */ | |
84 | struct flow_metadata { | |
85 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ | |
86 | ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit.*/ | |
87 | ||
88 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ | |
89 | uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ | |
90 | ||
91 | uint16_t in_port; /* OpenFlow port or zero. */ | |
92 | }; | |
93 | ||
14608a15 BP |
94 | /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct |
95 | * flow", followed by FLOW_PAD_SIZE bytes of padding. */ | |
a61680c6 JP |
96 | #define FLOW_SIG_SIZE (110 + FLOW_N_REGS * 4) |
97 | #define FLOW_PAD_SIZE 6 | |
eadef313 JP |
98 | BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) == FLOW_SIG_SIZE - 1); |
99 | BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_frag) == 1); | |
14608a15 | 100 | BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE); |
064af421 | 101 | |
a877206f | 102 | /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */ |
73f33563 | 103 | BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 130 && FLOW_WC_SEQ == 8); |
a877206f | 104 | |
abff858b PS |
105 | void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id, |
106 | uint16_t in_port, struct flow *); | |
993410fb | 107 | void flow_zero_wildcards(struct flow *, const struct flow_wildcards *); |
5d6c3af0 | 108 | void flow_get_metadata(const struct flow *, struct flow_metadata *); |
993410fb | 109 | |
ae412e7d BP |
110 | char *flow_to_string(const struct flow *); |
111 | void flow_format(struct ds *, const struct flow *); | |
112 | void flow_print(FILE *, const struct flow *); | |
79049a24 | 113 | static inline int flow_compare_3way(const struct flow *, const struct flow *); |
ae412e7d BP |
114 | static inline bool flow_equal(const struct flow *, const struct flow *); |
115 | static inline size_t flow_hash(const struct flow *, uint32_t basis); | |
064af421 | 116 | |
3719455c BP |
117 | void flow_set_vlan_vid(struct flow *, ovs_be16 vid); |
118 | void flow_set_vlan_pcp(struct flow *, uint8_t pcp); | |
119 | ||
8b3b8dd1 BP |
120 | void flow_compose(struct ofpbuf *, const struct flow *); |
121 | ||
064af421 | 122 | static inline int |
79049a24 | 123 | flow_compare_3way(const struct flow *a, const struct flow *b) |
064af421 | 124 | { |
14608a15 | 125 | return memcmp(a, b, FLOW_SIG_SIZE); |
064af421 BP |
126 | } |
127 | ||
128 | static inline bool | |
ae412e7d | 129 | flow_equal(const struct flow *a, const struct flow *b) |
064af421 | 130 | { |
79049a24 | 131 | return !flow_compare_3way(a, b); |
064af421 BP |
132 | } |
133 | ||
134 | static inline size_t | |
ae412e7d | 135 | flow_hash(const struct flow *flow, uint32_t basis) |
064af421 | 136 | { |
14608a15 | 137 | return hash_bytes(flow, FLOW_SIG_SIZE, basis); |
064af421 BP |
138 | } |
139 | ||
d8ae4d67 | 140 | /* Open vSwitch flow wildcard bits. |
b6c9e612 | 141 | * |
1e37a2d7 BP |
142 | * These are used only internally to Open vSwitch, in the 'wildcards' member of |
143 | * struct flow_wildcards. They never appear in the wire protocol in this | |
144 | * form. */ | |
145 | ||
d8ae4d67 BP |
146 | typedef unsigned int OVS_BITWISE flow_wildcards_t; |
147 | ||
148 | /* Same values and meanings as corresponding OFPFW_* bits. */ | |
149 | #define FWW_IN_PORT ((OVS_FORCE flow_wildcards_t) (1 << 0)) | |
d8ae4d67 BP |
150 | #define FWW_DL_SRC ((OVS_FORCE flow_wildcards_t) (1 << 2)) |
151 | #define FWW_DL_DST ((OVS_FORCE flow_wildcards_t) (1 << 3)) | |
152 | /* excluding the multicast bit */ | |
153 | #define FWW_DL_TYPE ((OVS_FORCE flow_wildcards_t) (1 << 4)) | |
154 | #define FWW_NW_PROTO ((OVS_FORCE flow_wildcards_t) (1 << 5)) | |
00794817 | 155 | /* No corresponding OFPFW_* bits. */ |
7257b535 | 156 | #define FWW_ETH_MCAST ((OVS_FORCE flow_wildcards_t) (1 << 1)) |
d8ae4d67 | 157 | /* multicast bit only */ |
73f33563 BP |
158 | #define FWW_NW_DSCP ((OVS_FORCE flow_wildcards_t) (1 << 6)) |
159 | #define FWW_NW_ECN ((OVS_FORCE flow_wildcards_t) (1 << 7)) | |
7257b535 BP |
160 | #define FWW_ARP_SHA ((OVS_FORCE flow_wildcards_t) (1 << 8)) |
161 | #define FWW_ARP_THA ((OVS_FORCE flow_wildcards_t) (1 << 9)) | |
162 | #define FWW_ND_TARGET ((OVS_FORCE flow_wildcards_t) (1 << 10)) | |
fa8223b7 | 163 | #define FWW_IPV6_LABEL ((OVS_FORCE flow_wildcards_t) (1 << 11)) |
a61680c6 | 164 | #define FWW_NW_TTL ((OVS_FORCE flow_wildcards_t) (1 << 12)) |
73f33563 | 165 | #define FWW_ALL ((OVS_FORCE flow_wildcards_t) (((1 << 13)) - 1)) |
b6c9e612 | 166 | |
a877206f | 167 | /* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */ |
73f33563 | 168 | BUILD_ASSERT_DECL(FWW_ALL == ((1 << 13) - 1) && FLOW_WC_SEQ == 8); |
a877206f | 169 | |
b5d97350 BP |
170 | /* Information on wildcards for a flow, as a supplement to "struct flow". |
171 | * | |
d8ae4d67 BP |
172 | * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in |
173 | * the rest of the members. */ | |
064af421 | 174 | struct flow_wildcards { |
8368c090 | 175 | ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */ |
d8ae4d67 | 176 | flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */ |
b6c9e612 | 177 | uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ |
0b3e77bb BP |
178 | ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */ |
179 | ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ | |
d31f1109 JP |
180 | struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */ |
181 | struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */ | |
66642cb4 | 182 | ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */ |
73f33563 BP |
183 | ovs_be16 tp_src_mask; /* 1-bit in each significant tp_src bit. */ |
184 | ovs_be16 tp_dst_mask; /* 1-bit in each significant tp_dst bit. */ | |
eadef313 | 185 | uint8_t nw_frag_mask; /* 1-bit in each significant nw_frag bit. */ |
73f33563 | 186 | uint8_t zeros[1]; /* Padding field set to zero. */ |
064af421 BP |
187 | }; |
188 | ||
a877206f | 189 | /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */ |
73f33563 | 190 | BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 80 && FLOW_WC_SEQ == 8); |
a877206f | 191 | |
d8ae4d67 | 192 | void flow_wildcards_init_catchall(struct flow_wildcards *); |
494e43a5 BP |
193 | void flow_wildcards_init_exact(struct flow_wildcards *); |
194 | ||
00561f41 | 195 | bool flow_wildcards_is_exact(const struct flow_wildcards *); |
ecf1e7ac | 196 | bool flow_wildcards_is_catchall(const struct flow_wildcards *); |
00561f41 | 197 | |
b6c9e612 BP |
198 | void flow_wildcards_set_reg_mask(struct flow_wildcards *, |
199 | int idx, uint32_t mask); | |
064af421 | 200 | |
b5d97350 BP |
201 | void flow_wildcards_combine(struct flow_wildcards *dst, |
202 | const struct flow_wildcards *src1, | |
203 | const struct flow_wildcards *src2); | |
204 | bool flow_wildcards_has_extra(const struct flow_wildcards *, | |
205 | const struct flow_wildcards *); | |
206 | ||
1006cda6 | 207 | uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis); |
b5d97350 BP |
208 | bool flow_wildcards_equal(const struct flow_wildcards *, |
209 | const struct flow_wildcards *); | |
ff55ea1f | 210 | uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis); |
b5d97350 | 211 | |
db7f8281 BP |
212 | const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t); |
213 | bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]); | |
214 | flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t, | |
215 | const uint8_t mask[6]); | |
520e9a2a EJ |
216 | uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields, |
217 | uint16_t basis); | |
218 | const char *flow_hash_fields_to_str(enum nx_hash_fields); | |
219 | bool flow_hash_fields_valid(enum nx_hash_fields); | |
db7f8281 | 220 | |
064af421 | 221 | #endif /* flow.h */ |