1 #ifndef __LINUX_NETFILTER_H
2 #define __LINUX_NETFILTER_H
5 #include <linux/init.h>
6 #include <linux/types.h>
7 #include <linux/skbuff.h>
10 #include <linux/wait.h>
11 #include <linux/list.h>
13 #include <linux/compiler.h>
15 /* Responses from hook functions. */
22 #define NF_MAX_VERDICT NF_STOP
24 /* we overload the higher bits for encoding auxiliary data such as the queue
25 * number. Not nice, but better than additional function arguments. */
26 #define NF_VERDICT_MASK 0x0000ffff
27 #define NF_VERDICT_BITS 16
29 #define NF_VERDICT_QMASK 0xffff0000
30 #define NF_VERDICT_QBITS 16
32 #define NF_QUEUE_NR(x) (((x << NF_VERDICT_QBITS) & NF_VERDICT_QMASK) | NF_QUEUE)
34 /* only for userspace compatibility */
36 /* Generic cache responses from hook functions.
37 <= 0x2000 is used for protocol-flags. */
38 #define NFC_UNKNOWN 0x4000
39 #define NFC_ALTERED 0x8000
43 #ifdef CONFIG_NETFILTER
45 extern void netfilter_init(void);
47 /* Largest hook number + 1 */
48 #define NF_MAX_HOOKS 8
53 typedef unsigned int nf_hookfn(unsigned int hooknum,
55 const struct net_device *in,
56 const struct net_device *out,
57 int (*okfn)(struct sk_buff *));
61 struct list_head list;
63 /* User fills in from here down. */
68 /* Hooks are ordered in ascending priority. */
74 struct list_head list;
78 /* Non-inclusive ranges: use 0/0/NULL to never get called. */
81 int (*set)(struct sock *sk, int optval, void __user *user, unsigned int len);
82 int (*compat_set)(struct sock *sk, int optval,
83 void __user *user, unsigned int len);
87 int (*get)(struct sock *sk, int optval, void __user *user, int *len);
88 int (*compat_get)(struct sock *sk, int optval,
89 void __user *user, int *len);
91 /* Number of users inside set() or get(). */
93 struct task_struct *cleanup_task;
96 /* Each queued (to userspace) skbuff has one of these. */
99 /* The ops struct which sent us to userspace. */
100 struct nf_hook_ops *elem;
102 /* If we're sent to userspace, this keeps housekeeping info */
105 struct net_device *indev, *outdev;
106 int (*okfn)(struct sk_buff *);
109 /* Function to register/unregister hook points. */
110 int nf_register_hook(struct nf_hook_ops *reg);
111 void nf_unregister_hook(struct nf_hook_ops *reg);
112 int nf_register_hooks(struct nf_hook_ops *reg, unsigned int n);
113 void nf_unregister_hooks(struct nf_hook_ops *reg, unsigned int n);
115 /* Functions to register get/setsockopt ranges (non-inclusive). You
116 need to check permissions yourself! */
117 int nf_register_sockopt(struct nf_sockopt_ops *reg);
118 void nf_unregister_sockopt(struct nf_sockopt_ops *reg);
121 /* Sysctl registration */
122 struct ctl_table_header *nf_register_sysctl_table(struct ctl_table *path,
123 struct ctl_table *table);
124 void nf_unregister_sysctl_table(struct ctl_table_header *header,
125 struct ctl_table *table);
126 extern struct ctl_table nf_net_netfilter_sysctl_path[];
127 extern struct ctl_table nf_net_ipv4_netfilter_sysctl_path[];
128 #endif /* CONFIG_SYSCTL */
130 extern struct list_head nf_hooks[NPROTO][NF_MAX_HOOKS];
132 /* those NF_LOG_* defines and struct nf_loginfo are legacy definitios that will
133 * disappear once iptables is replaced with pkttables. Please DO NOT use them
134 * for any new code! */
135 #define NF_LOG_TCPSEQ 0x01 /* Log TCP sequence numbers */
136 #define NF_LOG_TCPOPT 0x02 /* Log TCP options */
137 #define NF_LOG_IPOPT 0x04 /* Log IP options */
138 #define NF_LOG_UID 0x08 /* Log UID owning local socket */
139 #define NF_LOG_MASK 0x0f
141 #define NF_LOG_TYPE_LOG 0x01
142 #define NF_LOG_TYPE_ULOG 0x02
150 u_int16_t qthreshold;
159 typedef void nf_logfn(unsigned int pf,
160 unsigned int hooknum,
161 const struct sk_buff *skb,
162 const struct net_device *in,
163 const struct net_device *out,
164 const struct nf_loginfo *li,
173 /* Function to register/unregister log function. */
174 int nf_log_register(int pf, struct nf_logger *logger);
175 void nf_log_unregister(struct nf_logger *logger);
176 void nf_log_unregister_pf(int pf);
178 /* Calls the registered backend logging function */
179 void nf_log_packet(int pf,
180 unsigned int hooknum,
181 const struct sk_buff *skb,
182 const struct net_device *in,
183 const struct net_device *out,
184 struct nf_loginfo *li,
185 const char *fmt, ...);
187 int nf_hook_slow(int pf, unsigned int hook, struct sk_buff **pskb,
188 struct net_device *indev, struct net_device *outdev,
189 int (*okfn)(struct sk_buff *), int thresh);
192 * nf_hook_thresh - call a netfilter hook
194 * Returns 1 if the hook has allowed the packet to pass. The function
195 * okfn must be invoked by the caller in this case. Any other return
196 * value indicates the packet has been consumed by the hook.
198 static inline int nf_hook_thresh(int pf, unsigned int hook,
199 struct sk_buff **pskb,
200 struct net_device *indev,
201 struct net_device *outdev,
202 int (*okfn)(struct sk_buff *), int thresh,
207 #ifndef CONFIG_NETFILTER_DEBUG
208 if (list_empty(&nf_hooks[pf][hook]))
211 return nf_hook_slow(pf, hook, pskb, indev, outdev, okfn, thresh);
214 static inline int nf_hook(int pf, unsigned int hook, struct sk_buff **pskb,
215 struct net_device *indev, struct net_device *outdev,
216 int (*okfn)(struct sk_buff *))
218 return nf_hook_thresh(pf, hook, pskb, indev, outdev, okfn, INT_MIN, 1);
221 /* Activate hook; either okfn or kfree_skb called, unless a hook
222 returns NF_STOLEN (in which case, it's up to the hook to deal with
225 Returns -ERRNO if packet dropped. Zero means queued, stolen or
230 > I don't want nf_hook to return anything because people might forget
231 > about async and trust the return value to mean "packet was ok".
234 Just document it clearly, then you can expect some sense from kernel
238 /* This is gross, but inline doesn't cut it for avoiding the function
239 call in fast path: gcc doesn't inline (needs value tracking?). --RR */
241 /* HX: It's slightly less gross now. */
243 #define NF_HOOK_THRESH(pf, hook, skb, indev, outdev, okfn, thresh) \
245 if ((__ret=nf_hook_thresh(pf, hook, &(skb), indev, outdev, okfn, thresh, 1)) == 1)\
246 __ret = (okfn)(skb); \
249 #define NF_HOOK_COND(pf, hook, skb, indev, outdev, okfn, cond) \
251 if ((__ret=nf_hook_thresh(pf, hook, &(skb), indev, outdev, okfn, INT_MIN, cond)) == 1)\
252 __ret = (okfn)(skb); \
255 #define NF_HOOK(pf, hook, skb, indev, outdev, okfn) \
256 NF_HOOK_THRESH(pf, hook, skb, indev, outdev, okfn, INT_MIN)
258 /* Call setsockopt() */
259 int nf_setsockopt(struct sock *sk, int pf, int optval, char __user *opt,
261 int nf_getsockopt(struct sock *sk, int pf, int optval, char __user *opt,
264 int compat_nf_setsockopt(struct sock *sk, int pf, int optval,
265 char __user *opt, int len);
266 int compat_nf_getsockopt(struct sock *sk, int pf, int optval,
267 char __user *opt, int *len);
270 struct nf_queue_handler {
271 int (*outfn)(struct sk_buff *skb, struct nf_info *info,
272 unsigned int queuenum, void *data);
276 extern int nf_register_queue_handler(int pf,
277 struct nf_queue_handler *qh);
278 extern int nf_unregister_queue_handler(int pf,
279 struct nf_queue_handler *qh);
280 extern void nf_unregister_queue_handlers(struct nf_queue_handler *qh);
281 extern void nf_reinject(struct sk_buff *skb,
282 struct nf_info *info,
283 unsigned int verdict);
285 /* FIXME: Before cache is ever used, this must be implemented for real. */
286 extern void nf_invalidate_cache(int pf);
288 /* Call this before modifying an existing packet: ensures it is
289 modifiable and linear to the point you care about (writable_len).
290 Returns true or false. */
291 extern int skb_make_writable(struct sk_buff **pskb, unsigned int writable_len);
293 static inline void nf_csum_replace4(__sum16 *sum, __be32 from, __be32 to)
295 __be32 diff[] = { ~from, to };
297 *sum = csum_fold(csum_partial((char *)diff, sizeof(diff), ~csum_unfold(*sum)));
300 static inline void nf_csum_replace2(__sum16 *sum, __be16 from, __be16 to)
302 nf_csum_replace4(sum, (__force __be32)from, (__force __be32)to);
305 extern void nf_proto_csum_replace4(__sum16 *sum, struct sk_buff *skb,
306 __be32 from, __be32 to, int pseudohdr);
308 static inline void nf_proto_csum_replace2(__sum16 *sum, struct sk_buff *skb,
309 __be16 from, __be16 to, int pseudohdr)
311 nf_proto_csum_replace4(sum, skb, (__force __be32)from,
312 (__force __be32)to, pseudohdr);
316 unsigned short family;
317 __sum16 (*checksum)(struct sk_buff *skb, unsigned int hook,
318 unsigned int dataoff, u_int8_t protocol);
319 void (*saveroute)(const struct sk_buff *skb,
320 struct nf_info *info);
321 int (*reroute)(struct sk_buff **skb,
322 const struct nf_info *info);
326 extern struct nf_afinfo *nf_afinfo[];
327 static inline struct nf_afinfo *nf_get_afinfo(unsigned short family)
329 return rcu_dereference(nf_afinfo[family]);
332 static inline __sum16
333 nf_checksum(struct sk_buff *skb, unsigned int hook, unsigned int dataoff,
334 u_int8_t protocol, unsigned short family)
336 struct nf_afinfo *afinfo;
340 afinfo = nf_get_afinfo(family);
342 csum = afinfo->checksum(skb, hook, dataoff, protocol);
347 extern int nf_register_afinfo(struct nf_afinfo *afinfo);
348 extern void nf_unregister_afinfo(struct nf_afinfo *afinfo);
350 #define nf_info_reroute(x) ((void *)x + sizeof(struct nf_info))
352 #include <net/flow.h>
353 extern void (*ip_nat_decode_session)(struct sk_buff *, struct flowi *);
356 nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, int family)
358 #if defined(CONFIG_IP_NF_NAT_NEEDED) || defined(CONFIG_NF_NAT_NEEDED)
359 void (*decodefn)(struct sk_buff *, struct flowi *);
361 if (family == AF_INET && (decodefn = ip_nat_decode_session) != NULL)
366 #ifdef CONFIG_PROC_FS
367 #include <linux/proc_fs.h>
368 extern struct proc_dir_entry *proc_net_netfilter;
371 #else /* !CONFIG_NETFILTER */
372 #define NF_HOOK(pf, hook, skb, indev, outdev, okfn) (okfn)(skb)
373 #define NF_HOOK_COND(pf, hook, skb, indev, outdev, okfn, cond) (okfn)(skb)
374 static inline int nf_hook_thresh(int pf, unsigned int hook,
375 struct sk_buff **pskb,
376 struct net_device *indev,
377 struct net_device *outdev,
378 int (*okfn)(struct sk_buff *), int thresh,
383 static inline int nf_hook(int pf, unsigned int hook, struct sk_buff **pskb,
384 struct net_device *indev, struct net_device *outdev,
385 int (*okfn)(struct sk_buff *))
391 nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, int family) {}
392 #endif /*CONFIG_NETFILTER*/
394 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
395 extern void (*ip_ct_attach)(struct sk_buff *, struct sk_buff *);
396 extern void nf_ct_attach(struct sk_buff *, struct sk_buff *);
397 extern void (*nf_ct_destroy)(struct nf_conntrack *);
399 static inline void nf_ct_attach(struct sk_buff *new, struct sk_buff *skb) {}
402 #endif /*__KERNEL__*/
403 #endif /*__LINUX_NETFILTER_H*/