]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/netfilter/nf_conntrack.h
Merge remote-tracking branches 'spi/topic/devprop', 'spi/topic/fsl', 'spi/topic/fsl...
[mirror_ubuntu-bionic-kernel.git] / include / net / netfilter / nf_conntrack.h
CommitLineData
9fb9cbb1
YK
1/*
2 * Connection state tracking for netfilter. This is separated from,
3 * but required by, the (future) NAT layer; it can also be used by an iptables
4 * extension.
5 *
6 * 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
7 * - generalize L3 protocol dependent part.
8 *
9 * Derived from include/linux/netfiter_ipv4/ip_conntrack.h
10 */
11
12#ifndef _NF_CONNTRACK_H
13#define _NF_CONNTRACK_H
14
15#include <linux/netfilter/nf_conntrack_common.h>
16
9fb9cbb1
YK
17#include <linux/bitops.h>
18#include <linux/compiler.h>
60063497 19#include <linux/atomic.h>
870190a9 20#include <linux/rhashtable.h>
9fb9cbb1
YK
21
22#include <linux/netfilter/nf_conntrack_tcp.h>
2bc78049 23#include <linux/netfilter/nf_conntrack_dccp.h>
9fb9cbb1 24#include <linux/netfilter/nf_conntrack_sctp.h>
f09943fe 25#include <linux/netfilter/nf_conntrack_proto_gre.h>
9fb9cbb1
YK
26#include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>
27
28#include <net/netfilter/nf_conntrack_tuple.h>
29
30/* per conntrack: protocol private data */
31union nf_conntrack_proto {
32 /* insert conntrack proto private data here */
2bc78049 33 struct nf_ct_dccp dccp;
9fb9cbb1
YK
34 struct ip_ct_sctp sctp;
35 struct ip_ct_tcp tcp;
f09943fe 36 struct nf_ct_gre gre;
c74454fa 37 unsigned int tmpl_padto;
9fb9cbb1
YK
38};
39
40union nf_conntrack_expect_proto {
41 /* insert expect proto private data here */
42};
43
9fb9cbb1
YK
44#include <linux/types.h>
45#include <linux/skbuff.h>
46
47#ifdef CONFIG_NETFILTER_DEBUG
55871d04 48#define NF_CT_ASSERT(x) WARN_ON(!(x))
9fb9cbb1
YK
49#else
50#define NF_CT_ASSERT(x)
51#endif
52
53struct nf_conntrack_helper;
54
6002f266 55/* Must be kept in sync with the classes defined by helpers */
9d288dff 56#define NF_CT_MAX_EXPECT_CLASSES 4
6002f266 57
dc808fe2
HW
58/* nf_conn feature for connections that have a helper */
59struct nf_conn_help {
60 /* Helper. if any */
0906a372 61 struct nf_conntrack_helper __rcu *helper;
dc808fe2 62
b560580a
PM
63 struct hlist_head expectations;
64
dc808fe2 65 /* Current number of expected connections */
6002f266 66 u8 expecting[NF_CT_MAX_EXPECT_CLASSES];
1afc5679
PNA
67
68 /* private helper information. */
69 char data[];
dc808fe2
HW
70};
71
9fb9cbb1 72#include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
f8eb24a8
PM
73#include <net/netfilter/ipv6/nf_conntrack_ipv6.h>
74
ea781f19 75struct nf_conn {
f330a7fd 76 /* Usage count in here is 1 for hash table, 1 per skb,
b476b72a
JDB
77 * plus 1 for any connection(s) we are `master' for
78 *
a9e419dc 79 * Hint, SKB address this struct and refcnt via skb->_nfct and
b476b72a
JDB
80 * helpers nf_conntrack_get() and nf_conntrack_put().
81 * Helper nf_ct_put() equals nf_conntrack_put() by dec refcnt,
82 * beware nf_ct_get() is different and don't inc refcnt.
83 */
9fb9cbb1
YK
84 struct nf_conntrack ct_general;
85
b7779d06
JDB
86 spinlock_t lock;
87 u16 cpu;
440f0d58 88
6c8dee98
FW
89#ifdef CONFIG_NF_CONNTRACK_ZONES
90 struct nf_conntrack_zone zone;
91#endif
9fb9cbb1
YK
92 /* XXX should I move this to the tail ? - Y.K */
93 /* These are my tuples; original and reply */
94 struct nf_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
95
96 /* Have we seen traffic both ways yet? (bitset) */
97 unsigned long status;
98
f330a7fd
FW
99 /* jiffies32 when this ct is considered dead */
100 u32 timeout;
9fb9cbb1 101
0c5c9fb5
EB
102 possible_net_t ct_net;
103
5173bc67
FW
104#if IS_ENABLED(CONFIG_NF_NAT)
105 struct rhlist_head nat_bysource;
106#endif
c41884ce
FW
107 /* all members below initialized via memset */
108 u8 __nfct_init_offset[0];
109
110 /* If we were expected by an expectation, this will be it */
111 struct nf_conn *master;
112
9fb9cbb1
YK
113#if defined(CONFIG_NF_CONNTRACK_MARK)
114 u_int32_t mark;
115#endif
116
7c9728c3
JM
117#ifdef CONFIG_NF_CONNTRACK_SECMARK
118 u_int32_t secmark;
119#endif
120
ecfab2c9
YK
121 /* Extensions */
122 struct nf_ct_ext *ext;
e5fc9e7a
CG
123
124 /* Storage reserved for other modules, must be the last member */
125 union nf_conntrack_proto proto;
9fb9cbb1
YK
126};
127
9fb9cbb1
YK
128static inline struct nf_conn *
129nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash *hash)
130{
131 return container_of(hash, struct nf_conn,
132 tuplehash[hash->tuple.dst.dir]);
133}
134
5e8fbe2a
PM
135static inline u_int16_t nf_ct_l3num(const struct nf_conn *ct)
136{
137 return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.src.l3num;
138}
139
140static inline u_int8_t nf_ct_protonum(const struct nf_conn *ct)
141{
142 return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.dst.protonum;
143}
144
f2f3e38c
PNA
145#define nf_ct_tuple(ct, dir) (&(ct)->tuplehash[dir].tuple)
146
9fb9cbb1
YK
147/* get master conntrack via master expectation */
148#define master_ct(conntr) (conntr->master)
149
5a1fb391
AD
150extern struct net init_net;
151
152static inline struct net *nf_ct_net(const struct nf_conn *ct)
153{
c2d9ba9b 154 return read_pnet(&ct->ct_net);
5a1fb391
AD
155}
156
9fb9cbb1 157/* Alter reply tuple (maybe alter helper). */
4e77be46
JP
158void nf_conntrack_alter_reply(struct nf_conn *ct,
159 const struct nf_conntrack_tuple *newreply);
9fb9cbb1
YK
160
161/* Is this tuple taken? (ignoring any belonging to the given
162 conntrack). */
4e77be46
JP
163int nf_conntrack_tuple_taken(const struct nf_conntrack_tuple *tuple,
164 const struct nf_conn *ignored_conntrack);
9fb9cbb1 165
30322309 166#define NFCT_INFOMASK 7UL
a9e419dc 167#define NFCT_PTRMASK ~(NFCT_INFOMASK)
30322309 168
9fb9cbb1
YK
169/* Return conntrack_info and tuple hash for given skb. */
170static inline struct nf_conn *
171nf_ct_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
172{
a9e419dc
FW
173 *ctinfo = skb->_nfct & NFCT_INFOMASK;
174
175 return (struct nf_conn *)(skb->_nfct & NFCT_PTRMASK);
9fb9cbb1
YK
176}
177
178/* decrement reference count on a conntrack */
179static inline void nf_ct_put(struct nf_conn *ct)
180{
181 NF_CT_ASSERT(ct);
182 nf_conntrack_put(&ct->ct_general);
183}
184
b9f78f9f 185/* Protocol module loading */
4e77be46
JP
186int nf_ct_l3proto_try_module_get(unsigned short l3proto);
187void nf_ct_l3proto_module_put(unsigned short l3proto);
b9f78f9f 188
ecb2421b
FW
189/* load module; enable/disable conntrack in this namespace */
190int nf_ct_netns_get(struct net *net, u8 nfproto);
191void nf_ct_netns_put(struct net *net, u8 nfproto);
192
ea781f19
ED
193/*
194 * Allocate a hashtable of hlist_head (if nulls == 0),
195 * or hlist_nulls_head (if nulls == 1)
196 */
4e77be46 197void *nf_ct_alloc_hashtable(unsigned int *sizep, int nulls);
ea781f19 198
4e77be46 199void nf_ct_free_hashtable(void *hash, unsigned int size);
ac565e5f 200
4e77be46 201int nf_conntrack_hash_check_insert(struct nf_conn *ct);
02982c27 202bool nf_ct_delete(struct nf_conn *ct, u32 pid, int report);
c1d10adb 203
4e77be46 204bool nf_ct_get_tuplepr(const struct sk_buff *skb, unsigned int nhoff,
a31f1adc
EB
205 u_int16_t l3num, struct net *net,
206 struct nf_conntrack_tuple *tuple);
4e77be46
JP
207bool nf_ct_invert_tuplepr(struct nf_conntrack_tuple *inverse,
208 const struct nf_conntrack_tuple *orig);
9fb9cbb1 209
4e77be46
JP
210void __nf_ct_refresh_acct(struct nf_conn *ct, enum ip_conntrack_info ctinfo,
211 const struct sk_buff *skb,
212 unsigned long extra_jiffies, int do_acct);
9fb9cbb1
YK
213
214/* Refresh conntrack for this many jiffies and do accounting */
215static inline void nf_ct_refresh_acct(struct nf_conn *ct,
216 enum ip_conntrack_info ctinfo,
217 const struct sk_buff *skb,
218 unsigned long extra_jiffies)
219{
220 __nf_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
221}
222
223/* Refresh conntrack for this many jiffies */
224static inline void nf_ct_refresh(struct nf_conn *ct,
225 const struct sk_buff *skb,
226 unsigned long extra_jiffies)
227{
228 __nf_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
229}
230
718d4ad9 231/* kill conntrack and do accounting */
ad66713f
FW
232bool nf_ct_kill_acct(struct nf_conn *ct, enum ip_conntrack_info ctinfo,
233 const struct sk_buff *skb);
718d4ad9
FH
234
235/* kill conntrack without accounting */
4c889498 236static inline bool nf_ct_kill(struct nf_conn *ct)
718d4ad9 237{
ad66713f 238 return nf_ct_delete(ct, 0, 0);
718d4ad9 239}
51091764 240
9fb9cbb1 241/* These are for NAT. Icky. */
2d89c68a 242extern s32 (*nf_ct_nat_offset)(const struct nf_conn *ct,
f9dd09c7
JK
243 enum ip_conntrack_dir dir,
244 u32 seq);
9fb9cbb1 245
9fb9cbb1 246/* Fake conntrack entry for untracked connections */
170a1fb9 247DECLARE_PER_CPU_ALIGNED(struct nf_conn, nf_conntrack_untracked);
5bfddbd4
ED
248static inline struct nf_conn *nf_ct_untracked_get(void)
249{
903ceff7 250 return raw_cpu_ptr(&nf_conntrack_untracked);
5bfddbd4 251}
4e77be46 252void nf_ct_untracked_status_or(unsigned long bits);
9fb9cbb1 253
9fb9cbb1 254/* Iterate over all conntracks: if iter returns true, it's deleted. */
4e77be46
JP
255void nf_ct_iterate_cleanup(struct net *net,
256 int (*iter)(struct nf_conn *i, void *data),
257 void *data, u32 portid, int report);
308ac914
DB
258
259struct nf_conntrack_zone;
260
4e77be46 261void nf_conntrack_free(struct nf_conn *ct);
308ac914
DB
262struct nf_conn *nf_conntrack_alloc(struct net *net,
263 const struct nf_conntrack_zone *zone,
4e77be46
JP
264 const struct nf_conntrack_tuple *orig,
265 const struct nf_conntrack_tuple *repl,
266 gfp_t gfp);
9fb9cbb1 267
b2a15a60
PM
268static inline int nf_ct_is_template(const struct nf_conn *ct)
269{
270 return test_bit(IPS_TEMPLATE_BIT, &ct->status);
271}
272
9fb9cbb1 273/* It's confirmed if it is, or has been in the hash table. */
d51ed836 274static inline int nf_ct_is_confirmed(const struct nf_conn *ct)
9fb9cbb1
YK
275{
276 return test_bit(IPS_CONFIRMED_BIT, &ct->status);
277}
278
d51ed836 279static inline int nf_ct_is_dying(const struct nf_conn *ct)
9fb9cbb1
YK
280{
281 return test_bit(IPS_DYING_BIT, &ct->status);
282}
283
5bfddbd4 284static inline int nf_ct_is_untracked(const struct nf_conn *ct)
587aa641 285{
5bfddbd4 286 return test_bit(IPS_UNTRACKED_BIT, &ct->status);
587aa641
PM
287}
288
42c1edd3
JA
289/* Packet is received from loopback */
290static inline bool nf_is_loopback_packet(const struct sk_buff *skb)
291{
292 return skb->dev && skb->skb_iif && skb->dev->flags & IFF_LOOPBACK;
293}
294
f330a7fd
FW
295#define nfct_time_stamp ((u32)(jiffies))
296
c8607e02
FW
297/* jiffies until ct expires, 0 if already expired */
298static inline unsigned long nf_ct_expires(const struct nf_conn *ct)
299{
f330a7fd 300 s32 timeout = ct->timeout - nfct_time_stamp;
c8607e02
FW
301
302 return timeout > 0 ? timeout : 0;
303}
304
f330a7fd
FW
305static inline bool nf_ct_is_expired(const struct nf_conn *ct)
306{
307 return (__s32)(ct->timeout - nfct_time_stamp) <= 0;
308}
309
310/* use after obtaining a reference count */
311static inline bool nf_ct_should_gc(const struct nf_conn *ct)
312{
313 return nf_ct_is_expired(ct) && nf_ct_is_confirmed(ct) &&
314 !nf_ct_is_dying(ct);
315}
316
34641c6d
PG
317struct kernel_param;
318
4e77be46 319int nf_conntrack_set_hashsize(const char *val, struct kernel_param *kp);
3183ab89 320int nf_conntrack_hash_resize(unsigned int hashsize);
92e47ba8
LZ
321
322extern struct hlist_nulls_head *nf_conntrack_hash;
9fb9cbb1 323extern unsigned int nf_conntrack_htable_size;
92e47ba8 324extern seqcount_t nf_conntrack_generation;
e478075c 325extern unsigned int nf_conntrack_max;
9fb9cbb1 326
92e47ba8
LZ
327/* must be called with rcu read lock held */
328static inline void
329nf_conntrack_get_ht(struct hlist_nulls_head **hash, unsigned int *hsize)
330{
331 struct hlist_nulls_head *hptr;
332 unsigned int sequence, hsz;
333
334 do {
335 sequence = read_seqcount_begin(&nf_conntrack_generation);
336 hsz = nf_conntrack_htable_size;
337 hptr = nf_conntrack_hash;
338 } while (read_seqcount_retry(&nf_conntrack_generation, sequence));
339
340 *hash = hptr;
341 *hsize = hsz;
342}
343
308ac914
DB
344struct nf_conn *nf_ct_tmpl_alloc(struct net *net,
345 const struct nf_conntrack_zone *zone,
346 gfp_t flags);
9cf94eab 347void nf_ct_tmpl_free(struct nf_conn *tmpl);
e53376be 348
c74454fa
FW
349static inline void
350nf_ct_set(struct sk_buff *skb, struct nf_conn *ct, enum ip_conntrack_info info)
351{
a9e419dc 352 skb->_nfct = (unsigned long)ct | info;
c74454fa
FW
353}
354
ac3a546a
ED
355#define NF_CT_STAT_INC(net, count) __this_cpu_inc((net)->ct.stat->count)
356#define NF_CT_STAT_INC_ATOMIC(net, count) this_cpu_inc((net)->ct.stat->count)
242922a0 357#define NF_CT_STAT_ADD_ATOMIC(net, count, v) this_cpu_add((net)->ct.stat->count, (v))
9fb9cbb1 358
4dc06f96
PNA
359#define MODULE_ALIAS_NFCT_HELPER(helper) \
360 MODULE_ALIAS("nfct-helper-" helper)
361
9fb9cbb1 362#endif /* _NF_CONNTRACK_H */