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