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