Commit | Line | Data |
---|---|---|
ccb1352e | 1 | /* |
9dd7f890 | 2 | * Copyright (c) 2007-2017 Nicira, Inc. |
ccb1352e JG |
3 | * |
4 | * This program is free software; you can redistribute it and/or | |
5 | * modify it under the terms of version 2 of the GNU General Public | |
6 | * License as published by the Free Software Foundation. | |
7 | * | |
8 | * This program is distributed in the hope that it will be useful, but | |
9 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
11 | * General Public License for more details. | |
12 | * | |
13 | * You should have received a copy of the GNU General Public License | |
14 | * along with this program; if not, write to the Free Software | |
15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
16 | * 02110-1301, USA | |
17 | */ | |
18 | ||
19 | #ifndef FLOW_H | |
20 | #define FLOW_H 1 | |
21 | ||
e298e505 | 22 | #include <linux/cache.h> |
ccb1352e JG |
23 | #include <linux/kernel.h> |
24 | #include <linux/netlink.h> | |
25 | #include <linux/openvswitch.h> | |
26 | #include <linux/spinlock.h> | |
27 | #include <linux/types.h> | |
28 | #include <linux/rcupdate.h> | |
29 | #include <linux/if_ether.h> | |
30 | #include <linux/in6.h> | |
31 | #include <linux/jiffies.h> | |
32 | #include <linux/time.h> | |
33 | #include <linux/flex_array.h> | |
34 | #include <net/inet_ecn.h> | |
1d8fff90 | 35 | #include <net/ip_tunnels.h> |
34ae932a | 36 | #include <net/dst_metadata.h> |
ccb1352e JG |
37 | |
38 | struct sk_buff; | |
ccb1352e | 39 | |
329f45bc JB |
40 | enum sw_flow_mac_proto { |
41 | MAC_PROTO_NONE = 0, | |
42 | MAC_PROTO_ETHERNET, | |
43 | }; | |
44 | #define SW_FLOW_KEY_INVALID 0x80 | |
45 | ||
f5796684 JG |
46 | /* Store options at the end of the array if they are less than the |
47 | * maximum size. This allows us to get the benefits of variable length | |
48 | * matching for small options. | |
49 | */ | |
d91641d9 TG |
50 | #define TUN_METADATA_OFFSET(opt_len) \ |
51 | (FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len) | |
52 | #define TUN_METADATA_OPTS(flow_key, opt_len) \ | |
53 | ((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len))) | |
f5796684 | 54 | |
34ae932a TG |
55 | struct ovs_tunnel_info { |
56 | struct metadata_dst *tun_dst; | |
57 | }; | |
58 | ||
018c1dda EG |
59 | struct vlan_head { |
60 | __be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/ | |
61 | __be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */ | |
62 | }; | |
63 | ||
8f0aad6f WZ |
64 | #define OVS_SW_FLOW_KEY_METADATA_SIZE \ |
65 | (offsetof(struct sw_flow_key, recirc_id) + \ | |
66 | FIELD_SIZEOF(struct sw_flow_key, recirc_id)) | |
67 | ||
ccb1352e | 68 | struct sw_flow_key { |
fca5fdf6 | 69 | u8 tun_opts[IP_TUNNEL_OPTS_MAX]; |
f5796684 | 70 | u8 tun_opts_len; |
1d8fff90 | 71 | struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */ |
ccb1352e JG |
72 | struct { |
73 | u32 priority; /* Packet QoS priority. */ | |
39c7caeb | 74 | u32 skb_mark; /* SKB mark. */ |
15eac2a7 | 75 | u16 in_port; /* Input switch port (or DP_MAX_PORTS). */ |
1139e241 | 76 | } __packed phy; /* Safe when right after 'tun_key'. */ |
329f45bc | 77 | u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */ |
00a93bab | 78 | u8 tun_proto; /* Protocol of encapsulating tunnel. */ |
971427f3 AZ |
79 | u32 ovs_flow_hash; /* Datapath computed hash value. */ |
80 | u32 recirc_id; /* Recirculation ID. */ | |
ccb1352e JG |
81 | struct { |
82 | u8 src[ETH_ALEN]; /* Ethernet source address. */ | |
83 | u8 dst[ETH_ALEN]; /* Ethernet destination address. */ | |
018c1dda EG |
84 | struct vlan_head vlan; |
85 | struct vlan_head cvlan; | |
ccb1352e JG |
86 | __be16 type; /* Ethernet frame type. */ |
87 | } eth; | |
25cd9ba0 SH |
88 | union { |
89 | struct { | |
90 | __be32 top_lse; /* top label stack entry */ | |
91 | } mpls; | |
92 | struct { | |
93 | u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */ | |
94 | u8 tos; /* IP ToS. */ | |
95 | u8 ttl; /* IP TTL/hop limit. */ | |
96 | u8 frag; /* One of OVS_FRAG_TYPE_*. */ | |
97 | } ip; | |
98 | }; | |
1139e241 JR |
99 | struct { |
100 | __be16 src; /* TCP/UDP/SCTP source port. */ | |
101 | __be16 dst; /* TCP/UDP/SCTP destination port. */ | |
102 | __be16 flags; /* TCP flags. */ | |
103 | } tp; | |
ccb1352e JG |
104 | union { |
105 | struct { | |
106 | struct { | |
107 | __be32 src; /* IP source address. */ | |
108 | __be32 dst; /* IP destination address. */ | |
109 | } addr; | |
9dd7f890 JR |
110 | union { |
111 | struct { | |
112 | __be32 src; | |
113 | __be32 dst; | |
114 | } ct_orig; /* Conntrack original direction fields. */ | |
115 | struct { | |
116 | u8 sha[ETH_ALEN]; /* ARP source hardware address. */ | |
117 | u8 tha[ETH_ALEN]; /* ARP target hardware address. */ | |
118 | } arp; | |
119 | }; | |
ccb1352e JG |
120 | } ipv4; |
121 | struct { | |
122 | struct { | |
123 | struct in6_addr src; /* IPv6 source address. */ | |
124 | struct in6_addr dst; /* IPv6 destination address. */ | |
125 | } addr; | |
126 | __be32 label; /* IPv6 flow label. */ | |
9dd7f890 JR |
127 | union { |
128 | struct { | |
129 | struct in6_addr src; | |
130 | struct in6_addr dst; | |
131 | } ct_orig; /* Conntrack original direction fields. */ | |
132 | struct { | |
133 | struct in6_addr target; /* ND target address. */ | |
134 | u8 sll[ETH_ALEN]; /* ND source link layer address. */ | |
135 | u8 tll[ETH_ALEN]; /* ND target link layer address. */ | |
136 | } nd; | |
137 | }; | |
ccb1352e JG |
138 | } ipv6; |
139 | }; | |
7f8a436e JS |
140 | struct { |
141 | /* Connection tracking fields. */ | |
9dd7f890 JR |
142 | u8 state; |
143 | u8 orig_proto; /* CT orig tuple IP protocol. */ | |
7f8a436e | 144 | u16 zone; |
182e3042 | 145 | u32 mark; |
9dd7f890 JR |
146 | struct { |
147 | __be16 src; /* CT orig tuple tp src port. */ | |
148 | __be16 dst; /* CT orig tuple tp dst port. */ | |
149 | } orig_tp; | |
150 | ||
33db4125 | 151 | struct ovs_key_ct_labels labels; |
7f8a436e JS |
152 | } ct; |
153 | ||
0d40f75b | 154 | } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */ |
ccb1352e | 155 | |
9dd7f890 JR |
156 | static inline bool sw_flow_key_is_nd(const struct sw_flow_key *key) |
157 | { | |
158 | return key->eth.type == htons(ETH_P_IPV6) && | |
159 | key->ip.proto == NEXTHDR_ICMP && | |
160 | key->tp.dst == 0 && | |
161 | (key->tp.src == htons(NDISC_NEIGHBOUR_SOLICITATION) || | |
162 | key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT)); | |
163 | } | |
164 | ||
e6445719 | 165 | struct sw_flow_key_range { |
8f49ce11 BP |
166 | unsigned short int start; |
167 | unsigned short int end; | |
e6445719 PS |
168 | }; |
169 | ||
170 | struct sw_flow_mask { | |
171 | int ref_count; | |
172 | struct rcu_head rcu; | |
173 | struct list_head list; | |
174 | struct sw_flow_key_range range; | |
175 | struct sw_flow_key key; | |
176 | }; | |
177 | ||
178 | struct sw_flow_match { | |
179 | struct sw_flow_key *key; | |
180 | struct sw_flow_key_range range; | |
181 | struct sw_flow_mask *mask; | |
182 | }; | |
183 | ||
74ed7ab9 JS |
184 | #define MAX_UFID_LENGTH 16 /* 128 bits */ |
185 | ||
186 | struct sw_flow_id { | |
187 | u32 ufid_len; | |
188 | union { | |
189 | u32 ufid[MAX_UFID_LENGTH / 4]; | |
190 | struct sw_flow_key *unmasked_key; | |
191 | }; | |
192 | }; | |
193 | ||
e6445719 PS |
194 | struct sw_flow_actions { |
195 | struct rcu_head rcu; | |
8e2fed1c | 196 | size_t orig_len; /* From flow_cmd_new netlink actions size */ |
e6445719 PS |
197 | u32 actions_len; |
198 | struct nlattr actions[]; | |
199 | }; | |
200 | ||
e298e505 PS |
201 | struct flow_stats { |
202 | u64 packet_count; /* Number of packets matched. */ | |
203 | u64 byte_count; /* Number of bytes matched. */ | |
204 | unsigned long used; /* Last used time (in jiffies). */ | |
205 | spinlock_t lock; /* Lock for atomic stats update. */ | |
206 | __be16 tcp_flags; /* Union of seen TCP flags. */ | |
207 | }; | |
208 | ||
ccb1352e JG |
209 | struct sw_flow { |
210 | struct rcu_head rcu; | |
74ed7ab9 JS |
211 | struct { |
212 | struct hlist_node node[2]; | |
213 | u32 hash; | |
214 | } flow_table, ufid_table; | |
db74a333 | 215 | int stats_last_writer; /* CPU id of the last writer on |
63e7959c JR |
216 | * 'stats[0]'. |
217 | */ | |
ccb1352e | 218 | struct sw_flow_key key; |
74ed7ab9 | 219 | struct sw_flow_id id; |
03f0d916 | 220 | struct sw_flow_mask *mask; |
ccb1352e | 221 | struct sw_flow_actions __rcu *sf_acts; |
db74a333 | 222 | struct flow_stats __rcu *stats[]; /* One for each CPU. First one |
63e7959c JR |
223 | * is allocated at flow creation time, |
224 | * the rest are allocated on demand | |
225 | * while holding the 'stats[0].lock'. | |
226 | */ | |
ccb1352e JG |
227 | }; |
228 | ||
229 | struct arp_eth_header { | |
230 | __be16 ar_hrd; /* format of hardware address */ | |
231 | __be16 ar_pro; /* format of protocol address */ | |
232 | unsigned char ar_hln; /* length of hardware address */ | |
233 | unsigned char ar_pln; /* length of protocol address */ | |
234 | __be16 ar_op; /* ARP opcode (command) */ | |
235 | ||
236 | /* Ethernet+IPv4 specific members. */ | |
237 | unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */ | |
238 | unsigned char ar_sip[4]; /* sender IP address */ | |
239 | unsigned char ar_tha[ETH_ALEN]; /* target hardware address */ | |
240 | unsigned char ar_tip[4]; /* target IP address */ | |
241 | } __packed; | |
242 | ||
329f45bc JB |
243 | static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key) |
244 | { | |
245 | return key->mac_proto & ~SW_FLOW_KEY_INVALID; | |
246 | } | |
247 | ||
248 | static inline u16 __ovs_mac_header_len(u8 mac_proto) | |
249 | { | |
250 | return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0; | |
251 | } | |
252 | ||
253 | static inline u16 ovs_mac_header_len(const struct sw_flow_key *key) | |
254 | { | |
255 | return __ovs_mac_header_len(ovs_key_mac_proto(key)); | |
256 | } | |
257 | ||
74ed7ab9 JS |
258 | static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid) |
259 | { | |
260 | return sfid->ufid_len; | |
261 | } | |
262 | ||
263 | static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid) | |
264 | { | |
265 | return !ovs_identifier_is_ufid(sfid); | |
266 | } | |
267 | ||
ad552007 | 268 | void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags, |
12eb18f7 | 269 | const struct sk_buff *); |
86ec8dba | 270 | void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *, |
e298e505 | 271 | unsigned long *used, __be16 *tcp_flags); |
86ec8dba | 272 | void ovs_flow_stats_clear(struct sw_flow *); |
ccb1352e | 273 | u64 ovs_flow_used_time(unsigned long flow_jiffies); |
ccb1352e | 274 | |
971427f3 | 275 | int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key); |
1d8fff90 | 276 | int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info, |
12eb18f7 | 277 | struct sk_buff *skb, |
f0b128c1 | 278 | struct sw_flow_key *key); |
83c8df26 | 279 | /* Extract key from packet coming from userspace. */ |
c2ac6673 | 280 | int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr, |
83c8df26 | 281 | struct sk_buff *skb, |
05da5898 | 282 | struct sw_flow_key *key, bool log); |
03f0d916 | 283 | |
ccb1352e | 284 | #endif /* flow.h */ |