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