netfilter: Use nf_hook_state in nf_queue_entry.
[deliverable/linux.git] / include / linux / netfilter.h
CommitLineData
1da177e4
LT
1#ifndef __LINUX_NETFILTER_H
2#define __LINUX_NETFILTER_H
3
1da177e4 4#include <linux/init.h>
1da177e4
LT
5#include <linux/skbuff.h>
6#include <linux/net.h>
7#include <linux/if.h>
2e3075a2
JE
8#include <linux/in.h>
9#include <linux/in6.h>
1da177e4
LT
10#include <linux/wait.h>
11#include <linux/list.h>
d1c85c2e 12#include <linux/static_key.h>
607ca46e 13#include <uapi/linux/netfilter.h>
1da177e4 14#ifdef CONFIG_NETFILTER
f615df76
FW
15static inline int NF_DROP_GETERR(int verdict)
16{
17 return -(verdict >> NF_VERDICT_QBITS);
18}
1da177e4 19
b8beedd2
PM
20static inline int nf_inet_addr_cmp(const union nf_inet_addr *a1,
21 const union nf_inet_addr *a2)
22{
23 return a1->all[0] == a2->all[0] &&
24 a1->all[1] == a2->all[1] &&
25 a1->all[2] == a2->all[2] &&
26 a1->all[3] == a2->all[3];
27}
28
efdedd54
DF
29static inline void nf_inet_addr_mask(const union nf_inet_addr *a1,
30 union nf_inet_addr *result,
31 const union nf_inet_addr *mask)
32{
33 result->all[0] = a1->all[0] & mask->all[0];
34 result->all[1] = a1->all[1] & mask->all[1];
35 result->all[2] = a1->all[2] & mask->all[2];
36 result->all[3] = a1->all[3] & mask->all[3];
37}
38
a0f4ecf3 39int netfilter_init(void);
1da177e4
LT
40
41/* Largest hook number + 1 */
42#define NF_MAX_HOOKS 8
43
44struct sk_buff;
1da177e4 45
795aa6ef 46struct nf_hook_ops;
cfdfab31
DM
47
48struct nf_hook_state {
49 unsigned int hook;
50 int thresh;
51 u_int8_t pf;
52 struct net_device *in;
53 struct net_device *out;
54 int (*okfn)(struct sk_buff *);
55};
56
795aa6ef 57typedef unsigned int nf_hookfn(const struct nf_hook_ops *ops,
3db05fea 58 struct sk_buff *skb,
1da177e4
LT
59 const struct net_device *in,
60 const struct net_device *out,
61 int (*okfn)(struct sk_buff *));
62
d94d9fee 63struct nf_hook_ops {
1da177e4
LT
64 struct list_head list;
65
66 /* User fills in from here down. */
96518518
PM
67 nf_hookfn *hook;
68 struct module *owner;
69 void *priv;
70 u_int8_t pf;
71 unsigned int hooknum;
1da177e4 72 /* Hooks are ordered in ascending priority. */
96518518 73 int priority;
1da177e4
LT
74};
75
d94d9fee 76struct nf_sockopt_ops {
1da177e4
LT
77 struct list_head list;
78
76108cea 79 u_int8_t pf;
1da177e4
LT
80
81 /* Non-inclusive ranges: use 0/0/NULL to never get called. */
82 int set_optmin;
83 int set_optmax;
84 int (*set)(struct sock *sk, int optval, void __user *user, unsigned int len);
c30f540b 85#ifdef CONFIG_COMPAT
3fdadf7d
DM
86 int (*compat_set)(struct sock *sk, int optval,
87 void __user *user, unsigned int len);
c30f540b 88#endif
1da177e4
LT
89 int get_optmin;
90 int get_optmax;
91 int (*get)(struct sock *sk, int optval, void __user *user, int *len);
c30f540b 92#ifdef CONFIG_COMPAT
3fdadf7d
DM
93 int (*compat_get)(struct sock *sk, int optval,
94 void __user *user, int *len);
c30f540b 95#endif
16fcec35
NH
96 /* Use the module struct to lock set/get code in place */
97 struct module *owner;
1da177e4
LT
98};
99
1da177e4
LT
100/* Function to register/unregister hook points. */
101int nf_register_hook(struct nf_hook_ops *reg);
102void nf_unregister_hook(struct nf_hook_ops *reg);
972d1cb1
PM
103int nf_register_hooks(struct nf_hook_ops *reg, unsigned int n);
104void nf_unregister_hooks(struct nf_hook_ops *reg, unsigned int n);
1da177e4
LT
105
106/* Functions to register get/setsockopt ranges (non-inclusive). You
107 need to check permissions yourself! */
108int nf_register_sockopt(struct nf_sockopt_ops *reg);
109void nf_unregister_sockopt(struct nf_sockopt_ops *reg);
110
7e9c6eeb 111extern struct list_head nf_hooks[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
1da177e4 112
d1c85c2e 113#ifdef HAVE_JUMP_LABEL
c5905afb 114extern struct static_key nf_hooks_needed[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
d1c85c2e 115
a2d7ec58
ED
116static inline bool nf_hooks_active(u_int8_t pf, unsigned int hook)
117{
118 if (__builtin_constant_p(pf) &&
119 __builtin_constant_p(hook))
c5905afb 120 return static_key_false(&nf_hooks_needed[pf][hook]);
a2d7ec58
ED
121
122 return !list_empty(&nf_hooks[pf][hook]);
123}
124#else
125static inline bool nf_hooks_active(u_int8_t pf, unsigned int hook)
126{
127 return !list_empty(&nf_hooks[pf][hook]);
128}
129#endif
130
cfdfab31 131int nf_hook_slow(struct sk_buff *skb, struct nf_hook_state *state);
16a6677f
PM
132
133/**
134 * nf_hook_thresh - call a netfilter hook
135 *
136 * Returns 1 if the hook has allowed the packet to pass. The function
137 * okfn must be invoked by the caller in this case. Any other return
138 * value indicates the packet has been consumed by the hook.
139 */
76108cea 140static inline int nf_hook_thresh(u_int8_t pf, unsigned int hook,
3db05fea 141 struct sk_buff *skb,
16a6677f
PM
142 struct net_device *indev,
143 struct net_device *outdev,
23f3733d 144 int (*okfn)(struct sk_buff *), int thresh)
16a6677f 145{
cfdfab31
DM
146 if (nf_hooks_active(pf, hook)) {
147 struct nf_hook_state state = {
148 .hook = hook,
149 .thresh = thresh,
150 .pf = pf,
151 .in = indev,
152 .out = outdev,
153 .okfn = okfn
154 };
155
156 return nf_hook_slow(skb, &state);
157 }
a2d7ec58 158 return 1;
16a6677f
PM
159}
160
76108cea 161static inline int nf_hook(u_int8_t pf, unsigned int hook, struct sk_buff *skb,
16a6677f
PM
162 struct net_device *indev, struct net_device *outdev,
163 int (*okfn)(struct sk_buff *))
164{
23f3733d 165 return nf_hook_thresh(pf, hook, skb, indev, outdev, okfn, INT_MIN);
16a6677f 166}
1da177e4
LT
167
168/* Activate hook; either okfn or kfree_skb called, unless a hook
169 returns NF_STOLEN (in which case, it's up to the hook to deal with
170 the consequences).
171
172 Returns -ERRNO if packet dropped. Zero means queued, stolen or
173 accepted.
174*/
175
176/* RR:
177 > I don't want nf_hook to return anything because people might forget
178 > about async and trust the return value to mean "packet was ok".
179
180 AK:
181 Just document it clearly, then you can expect some sense from kernel
182 coders :)
183*/
184
2249065f
JE
185static inline int
186NF_HOOK_THRESH(uint8_t pf, unsigned int hook, struct sk_buff *skb,
187 struct net_device *in, struct net_device *out,
188 int (*okfn)(struct sk_buff *), int thresh)
189{
190 int ret = nf_hook_thresh(pf, hook, skb, in, out, okfn, thresh);
191 if (ret == 1)
192 ret = okfn(skb);
193 return ret;
194}
48d5cad8 195
2249065f
JE
196static inline int
197NF_HOOK_COND(uint8_t pf, unsigned int hook, struct sk_buff *skb,
198 struct net_device *in, struct net_device *out,
199 int (*okfn)(struct sk_buff *), bool cond)
200{
4bac6b18
PM
201 int ret;
202
203 if (!cond ||
ac5aa2e3 204 ((ret = nf_hook_thresh(pf, hook, skb, in, out, okfn, INT_MIN)) == 1))
2249065f
JE
205 ret = okfn(skb);
206 return ret;
207}
1da177e4 208
2249065f
JE
209static inline int
210NF_HOOK(uint8_t pf, unsigned int hook, struct sk_buff *skb,
211 struct net_device *in, struct net_device *out,
212 int (*okfn)(struct sk_buff *))
213{
214 return NF_HOOK_THRESH(pf, hook, skb, in, out, okfn, INT_MIN);
215}
1da177e4
LT
216
217/* Call setsockopt() */
76108cea 218int nf_setsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
b7058842 219 unsigned int len);
76108cea 220int nf_getsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
1da177e4 221 int *len);
c30f540b 222#ifdef CONFIG_COMPAT
76108cea 223int compat_nf_setsockopt(struct sock *sk, u_int8_t pf, int optval,
b7058842 224 char __user *opt, unsigned int len);
76108cea 225int compat_nf_getsockopt(struct sock *sk, u_int8_t pf, int optval,
3fdadf7d 226 char __user *opt, int *len);
c30f540b 227#endif
3fdadf7d 228
089af26c
HW
229/* Call this before modifying an existing packet: ensures it is
230 modifiable and linear to the point you care about (writable_len).
231 Returns true or false. */
a0f4ecf3 232int skb_make_writable(struct sk_buff *skb, unsigned int writable_len);
089af26c 233
1841a4c7 234struct flowi;
02f014d8 235struct nf_queue_entry;
c01cd429 236
bce8032e
PM
237struct nf_afinfo {
238 unsigned short family;
b51655b9 239 __sum16 (*checksum)(struct sk_buff *skb, unsigned int hook,
422c346f 240 unsigned int dataoff, u_int8_t protocol);
d63a6507
PM
241 __sum16 (*checksum_partial)(struct sk_buff *skb,
242 unsigned int hook,
243 unsigned int dataoff,
244 unsigned int len,
245 u_int8_t protocol);
31ad3dd6 246 int (*route)(struct net *net, struct dst_entry **dst,
0fae2e77 247 struct flowi *fl, bool strict);
bce8032e 248 void (*saveroute)(const struct sk_buff *skb,
02f014d8 249 struct nf_queue_entry *entry);
3db05fea 250 int (*reroute)(struct sk_buff *skb,
02f014d8 251 const struct nf_queue_entry *entry);
bce8032e 252 int route_key_size;
2cc7d573
HW
253};
254
0e60ebe0 255extern const struct nf_afinfo __rcu *nf_afinfo[NFPROTO_NUMPROTO];
1e796fda 256static inline const struct nf_afinfo *nf_get_afinfo(unsigned short family)
bce8032e
PM
257{
258 return rcu_dereference(nf_afinfo[family]);
259}
2cc7d573 260
b51655b9 261static inline __sum16
422c346f
PM
262nf_checksum(struct sk_buff *skb, unsigned int hook, unsigned int dataoff,
263 u_int8_t protocol, unsigned short family)
264{
1e796fda 265 const struct nf_afinfo *afinfo;
b51655b9 266 __sum16 csum = 0;
422c346f
PM
267
268 rcu_read_lock();
269 afinfo = nf_get_afinfo(family);
270 if (afinfo)
271 csum = afinfo->checksum(skb, hook, dataoff, protocol);
272 rcu_read_unlock();
273 return csum;
274}
275
d63a6507
PM
276static inline __sum16
277nf_checksum_partial(struct sk_buff *skb, unsigned int hook,
278 unsigned int dataoff, unsigned int len,
279 u_int8_t protocol, unsigned short family)
280{
281 const struct nf_afinfo *afinfo;
282 __sum16 csum = 0;
283
284 rcu_read_lock();
285 afinfo = nf_get_afinfo(family);
286 if (afinfo)
287 csum = afinfo->checksum_partial(skb, hook, dataoff, len,
288 protocol);
289 rcu_read_unlock();
290 return csum;
291}
292
a0f4ecf3
JP
293int nf_register_afinfo(const struct nf_afinfo *afinfo);
294void nf_unregister_afinfo(const struct nf_afinfo *afinfo);
bce8032e 295
eb9c7ebe 296#include <net/flow.h>
c7232c99 297extern void (*nf_nat_decode_session_hook)(struct sk_buff *, struct flowi *);
eb9c7ebe
PM
298
299static inline void
76108cea 300nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
eb9c7ebe 301{
051578cc 302#ifdef CONFIG_NF_NAT_NEEDED
eb9c7ebe
PM
303 void (*decodefn)(struct sk_buff *, struct flowi *);
304
c7232c99
PM
305 rcu_read_lock();
306 decodefn = rcu_dereference(nf_nat_decode_session_hook);
307 if (decodefn)
308 decodefn(skb, fl);
309 rcu_read_unlock();
eb9c7ebe
PM
310#endif
311}
312
1da177e4
LT
313#else /* !CONFIG_NETFILTER */
314#define NF_HOOK(pf, hook, skb, indev, outdev, okfn) (okfn)(skb)
48d5cad8 315#define NF_HOOK_COND(pf, hook, skb, indev, outdev, okfn, cond) (okfn)(skb)
76108cea 316static inline int nf_hook_thresh(u_int8_t pf, unsigned int hook,
3db05fea 317 struct sk_buff *skb,
f53b61d8
DM
318 struct net_device *indev,
319 struct net_device *outdev,
23f3733d 320 int (*okfn)(struct sk_buff *), int thresh)
f53b61d8 321{
3db05fea 322 return okfn(skb);
f53b61d8 323}
76108cea 324static inline int nf_hook(u_int8_t pf, unsigned int hook, struct sk_buff *skb,
f53b61d8
DM
325 struct net_device *indev, struct net_device *outdev,
326 int (*okfn)(struct sk_buff *))
327{
9c92d348 328 return 1;
f53b61d8 329}
f53b61d8 330struct flowi;
eb9c7ebe 331static inline void
76108cea
JE
332nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
333{
334}
1da177e4
LT
335#endif /*CONFIG_NETFILTER*/
336
5f79e0f9 337#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
312a0c16 338extern void (*ip_ct_attach)(struct sk_buff *, const struct sk_buff *) __rcu;
a0f4ecf3 339void nf_ct_attach(struct sk_buff *, const struct sk_buff *);
0e60ebe0 340extern void (*nf_ct_destroy)(struct nf_conntrack *) __rcu;
9cb01766
PNA
341
342struct nf_conn;
41d73ec0 343enum ip_conntrack_info;
9cb01766
PNA
344struct nlattr;
345
346struct nfq_ct_hook {
347 size_t (*build_size)(const struct nf_conn *ct);
348 int (*build)(struct sk_buff *skb, struct nf_conn *ct);
349 int (*parse)(const struct nlattr *attr, struct nf_conn *ct);
bd077937
PNA
350 int (*attach_expect)(const struct nlattr *attr, struct nf_conn *ct,
351 u32 portid, u32 report);
8c88f87c 352 void (*seq_adjust)(struct sk_buff *skb, struct nf_conn *ct,
41d73ec0 353 enum ip_conntrack_info ctinfo, s32 off);
9cb01766 354};
41d73ec0 355extern struct nfq_ct_hook __rcu *nfq_ct_hook;
5f79e0f9
YK
356#else
357static inline void nf_ct_attach(struct sk_buff *new, struct sk_buff *skb) {}
358#endif
359
1da177e4 360#endif /*__LINUX_NETFILTER_H*/
This page took 1.467946 seconds and 5 git commands to generate.