1 #ifndef _NF_FLOW_TABLE_H
2 #define _NF_FLOW_TABLE_H
3
4 #include <linux/in.h>
5 #include <linux/in6.h>
6 #include <linux/netdevice.h>
7 #include <linux/rhashtable-types.h>
8 #include <linux/rcupdate.h>
9 #include <linux/netfilter.h>
10 #include <linux/netfilter/nf_conntrack_tuple_common.h>
11 #include <net/flow_offload.h>
12 #include <net/dst.h>
13 #include <linux/if_pppox.h>
14 #include <linux/ppp_defs.h>
15
16 struct nf_flowtable;
17 struct nf_flow_rule;
18 struct flow_offload;
19 enum flow_offload_tuple_dir;
20
21 struct nf_flow_key {
22 struct flow_dissector_key_meta meta;
23 struct flow_dissector_key_control control;
24 struct flow_dissector_key_control enc_control;
25 struct flow_dissector_key_basic basic;
26 struct flow_dissector_key_vlan vlan;
27 struct flow_dissector_key_vlan cvlan;
28 union {
29 struct flow_dissector_key_ipv4_addrs ipv4;
30 struct flow_dissector_key_ipv6_addrs ipv6;
31 };
32 struct flow_dissector_key_keyid enc_key_id;
33 union {
34 struct flow_dissector_key_ipv4_addrs enc_ipv4;
35 struct flow_dissector_key_ipv6_addrs enc_ipv6;
36 };
37 struct flow_dissector_key_tcp tcp;
38 struct flow_dissector_key_ports tp;
39 } __aligned(BITS_PER_LONG / 8); /* Ensure that we can do comparisons as longs. */
40
41 struct nf_flow_match {
42 struct flow_dissector dissector;
43 struct nf_flow_key key;
44 struct nf_flow_key mask;
45 };
46
47 struct nf_flow_rule {
48 struct nf_flow_match match;
49 struct flow_rule *rule;
50 };
51
52 struct nf_flowtable_type {
53 struct list_head list;
54 int family;
55 int (*init)(struct nf_flowtable *ft);
56 int (*setup)(struct nf_flowtable *ft,
57 struct net_device *dev,
58 enum flow_block_command cmd);
59 int (*action)(struct net *net,
60 const struct flow_offload *flow,
61 enum flow_offload_tuple_dir dir,
62 struct nf_flow_rule *flow_rule);
63 void (*free)(struct nf_flowtable *ft);
64 nf_hookfn *hook;
65 struct module *owner;
66 };
67
68 enum nf_flowtable_flags {
69 NF_FLOWTABLE_HW_OFFLOAD = 0x1, /* NFT_FLOWTABLE_HW_OFFLOAD */
70 NF_FLOWTABLE_COUNTER = 0x2, /* NFT_FLOWTABLE_COUNTER */
71 };
72
73 struct nf_flowtable {
74 struct list_head list;
75 struct rhashtable rhashtable;
76 int priority;
77 const struct nf_flowtable_type *type;
78 struct delayed_work gc_work;
79 unsigned int flags;
80 struct flow_block flow_block;
81 struct rw_semaphore flow_block_lock; /* Guards flow_block */
82 possible_net_t net;
83 };
84
nf_flowtable_hw_offload(struct nf_flowtable * flowtable)85 static inline bool nf_flowtable_hw_offload(struct nf_flowtable *flowtable)
86 {
87 return flowtable->flags & NF_FLOWTABLE_HW_OFFLOAD;
88 }
89
90 enum flow_offload_tuple_dir {
91 FLOW_OFFLOAD_DIR_ORIGINAL = IP_CT_DIR_ORIGINAL,
92 FLOW_OFFLOAD_DIR_REPLY = IP_CT_DIR_REPLY,
93 };
94 #define FLOW_OFFLOAD_DIR_MAX IP_CT_DIR_MAX
95
96 enum flow_offload_xmit_type {
97 FLOW_OFFLOAD_XMIT_UNSPEC = 0,
98 FLOW_OFFLOAD_XMIT_NEIGH,
99 FLOW_OFFLOAD_XMIT_XFRM,
100 FLOW_OFFLOAD_XMIT_DIRECT,
101 };
102
103 #define NF_FLOW_TABLE_ENCAP_MAX 2
104
105 struct flow_offload_tuple {
106 union {
107 struct in_addr src_v4;
108 struct in6_addr src_v6;
109 };
110 union {
111 struct in_addr dst_v4;
112 struct in6_addr dst_v6;
113 };
114 struct {
115 __be16 src_port;
116 __be16 dst_port;
117 };
118
119 int iifidx;
120
121 u8 l3proto;
122 u8 l4proto;
123 struct {
124 u16 id;
125 __be16 proto;
126 } encap[NF_FLOW_TABLE_ENCAP_MAX];
127
128 /* All members above are keys for lookups, see flow_offload_hash(). */
129 struct { } __hash;
130
131 u8 dir:2,
132 xmit_type:2,
133 encap_num:2,
134 in_vlan_ingress:2;
135 u16 mtu;
136 union {
137 struct {
138 struct dst_entry *dst_cache;
139 u32 dst_cookie;
140 };
141 struct {
142 u32 ifidx;
143 u32 hw_ifidx;
144 u8 h_source[ETH_ALEN];
145 u8 h_dest[ETH_ALEN];
146 } out;
147 };
148 };
149
150 struct flow_offload_tuple_rhash {
151 struct rhash_head node;
152 struct flow_offload_tuple tuple;
153 };
154
155 enum nf_flow_flags {
156 NF_FLOW_SNAT,
157 NF_FLOW_DNAT,
158 NF_FLOW_TEARDOWN,
159 NF_FLOW_HW,
160 NF_FLOW_HW_DYING,
161 NF_FLOW_HW_DEAD,
162 NF_FLOW_HW_PENDING,
163 };
164
165 enum flow_offload_type {
166 NF_FLOW_OFFLOAD_UNSPEC = 0,
167 NF_FLOW_OFFLOAD_ROUTE,
168 };
169
170 struct flow_offload {
171 struct flow_offload_tuple_rhash tuplehash[FLOW_OFFLOAD_DIR_MAX];
172 struct nf_conn *ct;
173 unsigned long flags;
174 u16 type;
175 u32 timeout;
176 struct rcu_head rcu_head;
177 };
178
179 #define NF_FLOW_TIMEOUT (30 * HZ)
180 #define nf_flowtable_time_stamp (u32)jiffies
181
182 unsigned long flow_offload_get_timeout(struct flow_offload *flow);
183
nf_flow_timeout_delta(unsigned int timeout)184 static inline __s32 nf_flow_timeout_delta(unsigned int timeout)
185 {
186 return (__s32)(timeout - nf_flowtable_time_stamp);
187 }
188
189 struct nf_flow_route {
190 struct {
191 struct dst_entry *dst;
192 struct {
193 u32 ifindex;
194 struct {
195 u16 id;
196 __be16 proto;
197 } encap[NF_FLOW_TABLE_ENCAP_MAX];
198 u8 num_encaps:2,
199 ingress_vlans:2;
200 } in;
201 struct {
202 u32 ifindex;
203 u32 hw_ifindex;
204 u8 h_source[ETH_ALEN];
205 u8 h_dest[ETH_ALEN];
206 } out;
207 enum flow_offload_xmit_type xmit_type;
208 } tuple[FLOW_OFFLOAD_DIR_MAX];
209 };
210
211 struct flow_offload *flow_offload_alloc(struct nf_conn *ct);
212 void flow_offload_free(struct flow_offload *flow);
213
214 static inline int
nf_flow_table_offload_add_cb(struct nf_flowtable * flow_table,flow_setup_cb_t * cb,void * cb_priv)215 nf_flow_table_offload_add_cb(struct nf_flowtable *flow_table,
216 flow_setup_cb_t *cb, void *cb_priv)
217 {
218 struct flow_block *block = &flow_table->flow_block;
219 struct flow_block_cb *block_cb;
220 int err = 0;
221
222 down_write(&flow_table->flow_block_lock);
223 block_cb = flow_block_cb_lookup(block, cb, cb_priv);
224 if (block_cb) {
225 err = -EEXIST;
226 goto unlock;
227 }
228
229 block_cb = flow_block_cb_alloc(cb, cb_priv, cb_priv, NULL);
230 if (IS_ERR(block_cb)) {
231 err = PTR_ERR(block_cb);
232 goto unlock;
233 }
234
235 list_add_tail(&block_cb->list, &block->cb_list);
236
237 unlock:
238 up_write(&flow_table->flow_block_lock);
239 return err;
240 }
241
242 static inline void
nf_flow_table_offload_del_cb(struct nf_flowtable * flow_table,flow_setup_cb_t * cb,void * cb_priv)243 nf_flow_table_offload_del_cb(struct nf_flowtable *flow_table,
244 flow_setup_cb_t *cb, void *cb_priv)
245 {
246 struct flow_block *block = &flow_table->flow_block;
247 struct flow_block_cb *block_cb;
248
249 down_write(&flow_table->flow_block_lock);
250 block_cb = flow_block_cb_lookup(block, cb, cb_priv);
251 if (block_cb) {
252 list_del(&block_cb->list);
253 flow_block_cb_free(block_cb);
254 } else {
255 WARN_ON(true);
256 }
257 up_write(&flow_table->flow_block_lock);
258 }
259
260 void flow_offload_route_init(struct flow_offload *flow,
261 struct nf_flow_route *route);
262
263 int flow_offload_add(struct nf_flowtable *flow_table, struct flow_offload *flow);
264 void flow_offload_refresh(struct nf_flowtable *flow_table,
265 struct flow_offload *flow);
266
267 struct flow_offload_tuple_rhash *flow_offload_lookup(struct nf_flowtable *flow_table,
268 struct flow_offload_tuple *tuple);
269 void nf_flow_table_gc_run(struct nf_flowtable *flow_table);
270 void nf_flow_table_gc_cleanup(struct nf_flowtable *flowtable,
271 struct net_device *dev);
272 void nf_flow_table_cleanup(struct net_device *dev);
273
274 int nf_flow_table_init(struct nf_flowtable *flow_table);
275 void nf_flow_table_free(struct nf_flowtable *flow_table);
276
277 void flow_offload_teardown(struct flow_offload *flow);
278
279 void nf_flow_snat_port(const struct flow_offload *flow,
280 struct sk_buff *skb, unsigned int thoff,
281 u8 protocol, enum flow_offload_tuple_dir dir);
282 void nf_flow_dnat_port(const struct flow_offload *flow,
283 struct sk_buff *skb, unsigned int thoff,
284 u8 protocol, enum flow_offload_tuple_dir dir);
285
286 struct flow_ports {
287 __be16 source, dest;
288 };
289
290 unsigned int nf_flow_offload_ip_hook(void *priv, struct sk_buff *skb,
291 const struct nf_hook_state *state);
292 unsigned int nf_flow_offload_ipv6_hook(void *priv, struct sk_buff *skb,
293 const struct nf_hook_state *state);
294
295 #define MODULE_ALIAS_NF_FLOWTABLE(family) \
296 MODULE_ALIAS("nf-flowtable-" __stringify(family))
297
298 void nf_flow_offload_add(struct nf_flowtable *flowtable,
299 struct flow_offload *flow);
300 void nf_flow_offload_del(struct nf_flowtable *flowtable,
301 struct flow_offload *flow);
302 void nf_flow_offload_stats(struct nf_flowtable *flowtable,
303 struct flow_offload *flow);
304
305 void nf_flow_table_offload_flush(struct nf_flowtable *flowtable);
306 void nf_flow_table_offload_flush_cleanup(struct nf_flowtable *flowtable);
307
308 int nf_flow_table_offload_setup(struct nf_flowtable *flowtable,
309 struct net_device *dev,
310 enum flow_block_command cmd);
311 int nf_flow_rule_route_ipv4(struct net *net, const struct flow_offload *flow,
312 enum flow_offload_tuple_dir dir,
313 struct nf_flow_rule *flow_rule);
314 int nf_flow_rule_route_ipv6(struct net *net, const struct flow_offload *flow,
315 enum flow_offload_tuple_dir dir,
316 struct nf_flow_rule *flow_rule);
317
318 int nf_flow_table_offload_init(void);
319 void nf_flow_table_offload_exit(void);
320
nf_flow_pppoe_proto(const struct sk_buff * skb)321 static inline __be16 nf_flow_pppoe_proto(const struct sk_buff *skb)
322 {
323 __be16 proto;
324
325 proto = *((__be16 *)(skb_mac_header(skb) + ETH_HLEN +
326 sizeof(struct pppoe_hdr)));
327 switch (proto) {
328 case htons(PPP_IP):
329 return htons(ETH_P_IP);
330 case htons(PPP_IPV6):
331 return htons(ETH_P_IPV6);
332 }
333
334 return 0;
335 }
336
337 #endif /* _NF_FLOW_TABLE_H */
338