[mirror_ubuntu-eoan-kernel.git] / include / linux / netfilter.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __LINUX_NETFILTER_H
#define __LINUX_NETFILTER_H

#include <linux/init.h>
#include <linux/skbuff.h>
#include <linux/net.h>
#include <linux/if.h>
#include <linux/in.h>
#include <linux/in6.h>
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/static_key.h>
#include <linux/netfilter_defs.h>
#include <linux/netdevice.h>
#include <net/net_namespace.h>

#ifdef CONFIG_NETFILTER
static inline int NF_DROP_GETERR(int verdict)
{
	return -(verdict >> NF_VERDICT_QBITS);
}

static inline int nf_inet_addr_cmp(const union nf_inet_addr *a1,
				   const union nf_inet_addr *a2)
{
	return a1->all[0] == a2->all[0] &&
	       a1->all[1] == a2->all[1] &&
	       a1->all[2] == a2->all[2] &&
	       a1->all[3] == a2->all[3];
}

static inline void nf_inet_addr_mask(const union nf_inet_addr *a1,
				     union nf_inet_addr *result,
				     const union nf_inet_addr *mask)
{
	result->all[0] = a1->all[0] & mask->all[0];
	result->all[1] = a1->all[1] & mask->all[1];
	result->all[2] = a1->all[2] & mask->all[2];
	result->all[3] = a1->all[3] & mask->all[3];
}

int netfilter_init(void);

struct sk_buff;

struct nf_hook_ops;

struct sock;

struct nf_hook_state {
	unsigned int hook;
	u_int8_t pf;
	struct net_device *in;
	struct net_device *out;
	struct sock *sk;
	struct net *net;
	int (*okfn)(struct net *, struct sock *, struct sk_buff *);
};

typedef unsigned int nf_hookfn(void *priv,
			       struct sk_buff *skb,
			       const struct nf_hook_state *state);
struct nf_hook_ops {
	/* User fills in from here down. */
	nf_hookfn		*hook;
	struct net_device	*dev;
	void			*priv;
	u_int8_t		pf;
	unsigned int		hooknum;
	/* Hooks are ordered in ascending priority. */
	int			priority;
};

struct nf_hook_entry {
	nf_hookfn			*hook;
	void				*priv;
};

struct nf_hook_entries_rcu_head {
	struct rcu_head head;
	void	*allocation;
};

struct nf_hook_entries {
	u16				num_hook_entries;
	/* padding */
	struct nf_hook_entry		hooks[];

	/* trailer: pointers to original orig_ops of each hook,
	 * followed by rcu_head and scratch space used for freeing
	 * the structure via call_rcu.
	 *
	 *   This is not part of struct nf_hook_entry since its only
	 *   needed in slow path (hook register/unregister):
	 * const struct nf_hook_ops     *orig_ops[]
	 *
	 *   For the same reason, we store this at end -- its
	 *   only needed when a hook is deleted, not during
	 *   packet path processing:
	 * struct nf_hook_entries_rcu_head     head
	 */
};

static inline struct nf_hook_ops **nf_hook_entries_get_hook_ops(const struct nf_hook_entries *e)
{
	unsigned int n = e->num_hook_entries;
	const void *hook_end;

	hook_end = &e->hooks[n]; /* this is *past* ->hooks[]! */

	return (struct nf_hook_ops **)hook_end;
}

static inline int
nf_hook_entry_hookfn(const struct nf_hook_entry *entry, struct sk_buff *skb,
		     struct nf_hook_state *state)
{
	return entry->hook(entry->priv, skb, state);
}

static inline void nf_hook_state_init(struct nf_hook_state *p,
				      unsigned int hook,
				      u_int8_t pf,
				      struct net_device *indev,
				      struct net_device *outdev,
				      struct sock *sk,
				      struct net *net,
				      int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	p->hook = hook;
	p->pf = pf;
	p->in = indev;
	p->out = outdev;
	p->sk = sk;
	p->net = net;
	p->okfn = okfn;
}


struct nf_sockopt_ops {
	struct list_head list;

	u_int8_t pf;

	/* Non-inclusive ranges: use 0/0/NULL to never get called. */
	int set_optmin;
	int set_optmax;
	int (*set)(struct sock *sk, int optval, void __user *user, unsigned int len);
#ifdef CONFIG_COMPAT
	int (*compat_set)(struct sock *sk, int optval,
			void __user *user, unsigned int len);
#endif
	int get_optmin;
	int get_optmax;
	int (*get)(struct sock *sk, int optval, void __user *user, int *len);
#ifdef CONFIG_COMPAT
	int (*compat_get)(struct sock *sk, int optval,
			void __user *user, int *len);
#endif
	/* Use the module struct to lock set/get code in place */
	struct module *owner;
};

/* Function to register/unregister hook points. */
int nf_register_net_hook(struct net *net, const struct nf_hook_ops *ops);
void nf_unregister_net_hook(struct net *net, const struct nf_hook_ops *ops);
int nf_register_net_hooks(struct net *net, const struct nf_hook_ops *reg,
			  unsigned int n);
void nf_unregister_net_hooks(struct net *net, const struct nf_hook_ops *reg,
			     unsigned int n);

/* Functions to register get/setsockopt ranges (non-inclusive).  You
   need to check permissions yourself! */
int nf_register_sockopt(struct nf_sockopt_ops *reg);
void nf_unregister_sockopt(struct nf_sockopt_ops *reg);

#ifdef HAVE_JUMP_LABEL
extern struct static_key nf_hooks_needed[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
#endif

int nf_hook_slow(struct sk_buff *skb, struct nf_hook_state *state,
		 const struct nf_hook_entries *e, unsigned int i);

/**
 *	nf_hook - call a netfilter hook
 *
 *	Returns 1 if the hook has allowed the packet to pass.  The function
 *	okfn must be invoked by the caller in this case.  Any other return
 *	value indicates the packet has been consumed by the hook.
 */
static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
			  struct sock *sk, struct sk_buff *skb,
			  struct net_device *indev, struct net_device *outdev,
			  int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	struct nf_hook_entries *hook_head = NULL;
	int ret = 1;

#ifdef HAVE_JUMP_LABEL
	if (__builtin_constant_p(pf) &&
	    __builtin_constant_p(hook) &&
	    !static_key_false(&nf_hooks_needed[pf][hook]))
		return 1;
#endif

	rcu_read_lock();
	switch (pf) {
	case NFPROTO_IPV4:
		hook_head = rcu_dereference(net->nf.hooks_ipv4[hook]);
		break;
	case NFPROTO_IPV6:
		hook_head = rcu_dereference(net->nf.hooks_ipv6[hook]);
		break;
	case NFPROTO_ARP:
#ifdef CONFIG_NETFILTER_FAMILY_ARP
		if (WARN_ON_ONCE(hook >= ARRAY_SIZE(net->nf.hooks_arp)))
			break;
		hook_head = rcu_dereference(net->nf.hooks_arp[hook]);
#endif
		break;
	case NFPROTO_BRIDGE:
#ifdef CONFIG_NETFILTER_FAMILY_BRIDGE
		hook_head = rcu_dereference(net->nf.hooks_bridge[hook]);
#endif
		break;
#if IS_ENABLED(CONFIG_DECNET)
	case NFPROTO_DECNET:
		hook_head = rcu_dereference(net->nf.hooks_decnet[hook]);
		break;
#endif
	default:
		WARN_ON_ONCE(1);
		break;
	}

	if (hook_head) {
		struct nf_hook_state state;

		nf_hook_state_init(&state, hook, pf, indev, outdev,
				   sk, net, okfn);

		ret = nf_hook_slow(skb, &state, hook_head, 0);
	}
	rcu_read_unlock();

	return ret;
}

/* Activate hook; either okfn or kfree_skb called, unless a hook
   returns NF_STOLEN (in which case, it's up to the hook to deal with
   the consequences).

   Returns -ERRNO if packet dropped.  Zero means queued, stolen or
   accepted.
*/

/* RR:
   > I don't want nf_hook to return anything because people might forget
   > about async and trust the return value to mean "packet was ok".

   AK:
   Just document it clearly, then you can expect some sense from kernel
   coders :)
*/

static inline int
NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
	     struct sk_buff *skb, struct net_device *in, struct net_device *out,
	     int (*okfn)(struct net *, struct sock *, struct sk_buff *),
	     bool cond)
{
	int ret;

	if (!cond ||
	    ((ret = nf_hook(pf, hook, net, sk, skb, in, out, okfn)) == 1))
		ret = okfn(net, sk, skb);
	return ret;
}

static inline int
NF_HOOK(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk, struct sk_buff *skb,
	struct net_device *in, struct net_device *out,
	int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	int ret = nf_hook(pf, hook, net, sk, skb, in, out, okfn);
	if (ret == 1)
		ret = okfn(net, sk, skb);
	return ret;
}

static inline void
NF_HOOK_LIST(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
	     struct list_head *head, struct net_device *in, struct net_device *out,
	     int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	struct sk_buff *skb, *next;
	struct list_head sublist;

	INIT_LIST_HEAD(&sublist);
	list_for_each_entry_safe(skb, next, head, list) {
		list_del(&skb->list);
		if (nf_hook(pf, hook, net, sk, skb, in, out, okfn) == 1)
			list_add_tail(&skb->list, &sublist);
	}
	/* Put passed packets back on main list */
	list_splice(&sublist, head);
}

/* Call setsockopt() */
int nf_setsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
		  unsigned int len);
int nf_getsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
		  int *len);
#ifdef CONFIG_COMPAT
int compat_nf_setsockopt(struct sock *sk, u_int8_t pf, int optval,
		char __user *opt, unsigned int len);
int compat_nf_getsockopt(struct sock *sk, u_int8_t pf, int optval,
		char __user *opt, int *len);
#endif

/* Call this before modifying an existing packet: ensures it is
   modifiable and linear to the point you care about (writable_len).
   Returns true or false. */
int skb_make_writable(struct sk_buff *skb, unsigned int writable_len);

struct flowi;
struct nf_queue_entry;

__sum16 nf_checksum(struct sk_buff *skb, unsigned int hook,
		    unsigned int dataoff, u_int8_t protocol,
		    unsigned short family);

__sum16 nf_checksum_partial(struct sk_buff *skb, unsigned int hook,
			    unsigned int dataoff, unsigned int len,
			    u_int8_t protocol, unsigned short family);
int nf_route(struct net *net, struct dst_entry **dst, struct flowi *fl,
	     bool strict, unsigned short family);
int nf_reroute(struct sk_buff *skb, struct nf_queue_entry *entry);

#include <net/flow.h>

struct nf_conn;
enum nf_nat_manip_type;
struct nlattr;
enum ip_conntrack_dir;

struct nf_nat_hook {
	int (*parse_nat_setup)(struct nf_conn *ct, enum nf_nat_manip_type manip,
			       const struct nlattr *attr);
	void (*decode_session)(struct sk_buff *skb, struct flowi *fl);
	unsigned int (*manip_pkt)(struct sk_buff *skb, struct nf_conn *ct,
				  enum nf_nat_manip_type mtype,
				  enum ip_conntrack_dir dir);
};

extern struct nf_nat_hook __rcu *nf_nat_hook;

static inline void
nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
{
#ifdef CONFIG_NF_NAT_NEEDED
	struct nf_nat_hook *nat_hook;

	rcu_read_lock();
	nat_hook = rcu_dereference(nf_nat_hook);
	if (nat_hook && nat_hook->decode_session)
		nat_hook->decode_session(skb, fl);
	rcu_read_unlock();
#endif
}

#else /* !CONFIG_NETFILTER */
static inline int
NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
	     struct sk_buff *skb, struct net_device *in, struct net_device *out,
	     int (*okfn)(struct net *, struct sock *, struct sk_buff *),
	     bool cond)
{
	return okfn(net, sk, skb);
}

static inline int
NF_HOOK(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
	struct sk_buff *skb, struct net_device *in, struct net_device *out,
	int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	return okfn(net, sk, skb);
}

static inline void
NF_HOOK_LIST(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
	     struct list_head *head, struct net_device *in, struct net_device *out,
	     int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	/* nothing to do */
}

static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
			  struct sock *sk, struct sk_buff *skb,
			  struct net_device *indev, struct net_device *outdev,
			  int (*okfn)(struct net *, struct sock *, struct sk_buff *))
{
	return 1;
}
struct flowi;
static inline void
nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
{
}
#endif /*CONFIG_NETFILTER*/

#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
#include <linux/netfilter/nf_conntrack_zones_common.h>

extern void (*ip_ct_attach)(struct sk_buff *, const struct sk_buff *) __rcu;
void nf_ct_attach(struct sk_buff *, const struct sk_buff *);
struct nf_conntrack_tuple;
bool nf_ct_get_tuple_skb(struct nf_conntrack_tuple *dst_tuple,
			 const struct sk_buff *skb);
#else
static inline void nf_ct_attach(struct sk_buff *new, struct sk_buff *skb) {}
struct nf_conntrack_tuple;
static inline bool nf_ct_get_tuple_skb(struct nf_conntrack_tuple *dst_tuple,
				       const struct sk_buff *skb)
{
	return false;
}
#endif

struct nf_conn;
enum ip_conntrack_info;

struct nf_ct_hook {
	int (*update)(struct net *net, struct sk_buff *skb);
	void (*destroy)(struct nf_conntrack *);
	bool (*get_tuple_skb)(struct nf_conntrack_tuple *,
			      const struct sk_buff *);
};
extern struct nf_ct_hook __rcu *nf_ct_hook;

struct nlattr;

struct nfnl_ct_hook {
	struct nf_conn *(*get_ct)(const struct sk_buff *skb,
				  enum ip_conntrack_info *ctinfo);
	size_t (*build_size)(const struct nf_conn *ct);
	int (*build)(struct sk_buff *skb, struct nf_conn *ct,
		     enum ip_conntrack_info ctinfo,
		     u_int16_t ct_attr, u_int16_t ct_info_attr);
	int (*parse)(const struct nlattr *attr, struct nf_conn *ct);
	int (*attach_expect)(const struct nlattr *attr, struct nf_conn *ct,
			     u32 portid, u32 report);
	void (*seq_adjust)(struct sk_buff *skb, struct nf_conn *ct,
			   enum ip_conntrack_info ctinfo, s32 off);
};
extern struct nfnl_ct_hook __rcu *nfnl_ct_hook;

/**
 * nf_skb_duplicated - TEE target has sent a packet
 *
 * When a xtables target sends a packet, the OUTPUT and POSTROUTING
 * hooks are traversed again, i.e. nft and xtables are invoked recursively.
 *
 * This is used by xtables TEE target to prevent the duplicated skb from
 * being duplicated again.
 */
DECLARE_PER_CPU(bool, nf_skb_duplicated);

#endif /*__LINUX_NETFILTER_H*/
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __LINUX_NETFILTER_H
	3	#define __LINUX_NETFILTER_H
	4
1da177e4	5	#include <linux/init.h>
1da177e4 LT	6	#include <linux/skbuff.h>
	7	#include <linux/net.h>
	8	#include <linux/if.h>
2e3075a2 JE	9	#include <linux/in.h>
2e3075a2 JE	10	#include <linux/in6.h>
1da177e4 LT	11	#include <linux/wait.h>
1da177e4 LT	12	#include <linux/list.h>
d1c85c2e	13	#include <linux/static_key.h>
a263653e	14	#include <linux/netfilter_defs.h>
085db2c0 EB	15	#include <linux/netdevice.h>
085db2c0 EB	16	#include <net/net_namespace.h>
a263653e	17
1da177e4	18	#ifdef CONFIG_NETFILTER
f615df76 FW	19	static inline int NF_DROP_GETERR(int verdict)
	20	{
	21	return -(verdict >> NF_VERDICT_QBITS);
	22	}
1da177e4	23
b8beedd2 PM	24	static inline int nf_inet_addr_cmp(const union nf_inet_addr *a1,
	25	const union nf_inet_addr *a2)
	26	{
	27	return a1->all[0] == a2->all[0] &&
	28	a1->all[1] == a2->all[1] &&
	29	a1->all[2] == a2->all[2] &&
	30	a1->all[3] == a2->all[3];
	31	}
	32
efdedd54 DF	33	static inline void nf_inet_addr_mask(const union nf_inet_addr *a1,
	34	union nf_inet_addr *result,
	35	const union nf_inet_addr *mask)
	36	{
	37	result->all[0] = a1->all[0] & mask->all[0];
	38	result->all[1] = a1->all[1] & mask->all[1];
	39	result->all[2] = a1->all[2] & mask->all[2];
	40	result->all[3] = a1->all[3] & mask->all[3];
	41	}
	42
a0f4ecf3	43	int netfilter_init(void);
1da177e4	44
1da177e4	45	struct sk_buff;
1da177e4	46
795aa6ef	47	struct nf_hook_ops;
cfdfab31	48
1c984f8a DM	49	struct sock;
1c984f8a DM	50
cfdfab31 DM	51	struct nf_hook_state {
cfdfab31 DM	52	unsigned int hook;
cfdfab31 DM	53	u_int8_t pf;
	54	struct net_device *in;
	55	struct net_device *out;
1c984f8a	56	struct sock *sk;
b11b1f65	57	struct net *net;
0c4b51f0	58	int (okfn)(struct net , struct sock , struct sk_buff );
cfdfab31 DM	59	};
cfdfab31 DM	60
e3b37f11 AC	61	typedef unsigned int nf_hookfn(void *priv,
	62	struct sk_buff *skb,
	63	const struct nf_hook_state *state);
	64	struct nf_hook_ops {
e3b37f11 AC	65	/* User fills in from here down. */
	66	nf_hookfn *hook;
	67	struct net_device *dev;
	68	void *priv;
	69	u_int8_t pf;
	70	unsigned int hooknum;
	71	/* Hooks are ordered in ascending priority. */
	72	int priority;
	73	};
	74
	75	struct nf_hook_entry {
d415b9eb AC	76	nf_hookfn *hook;
d415b9eb AC	77	void *priv;
e3b37f11 AC	78	};
e3b37f11 AC	79
8c873e21 FW	80	struct nf_hook_entries_rcu_head {
	81	struct rcu_head head;
	82	void *allocation;
	83	};
	84
960632ec AC	85	struct nf_hook_entries {
	86	u16 num_hook_entries;
	87	/* padding */
	88	struct nf_hook_entry hooks[];
	89
8c873e21 FW	90	/* trailer: pointers to original orig_ops of each hook,
	91	* followed by rcu_head and scratch space used for freeing
	92	* the structure via call_rcu.
960632ec	93	*
8c873e21 FW	94	* This is not part of struct nf_hook_entry since its only
8c873e21 FW	95	* needed in slow path (hook register/unregister):
960632ec	96	* const struct nf_hook_ops *orig_ops[]
8c873e21 FW	97	*
	98	* For the same reason, we store this at end -- its
	99	* only needed when a hook is deleted, not during
	100	* packet path processing:
	101	* struct nf_hook_entries_rcu_head head
960632ec AC	102	*/
960632ec AC	103	};
0aa8c57a	104
960632ec	105	static inline struct nf_hook_ops *nf_hook_entries_get_hook_ops(const struct nf_hook_entries e)
0aa8c57a	106	{
960632ec AC	107	unsigned int n = e->num_hook_entries;
	108	const void *hook_end;
	109
	110	hook_end = &e->hooks[n]; /* this is past ->hooks[]! */
	111
	112	return (struct nf_hook_ops **)hook_end;
0aa8c57a AC	113	}
	114
	115	static inline int
	116	nf_hook_entry_hookfn(const struct nf_hook_entry entry, struct sk_buff skb,
	117	struct nf_hook_state *state)
	118	{
d415b9eb	119	return entry->hook(entry->priv, skb, state);
0aa8c57a AC	120	}
0aa8c57a AC	121
107a9f4d DM	122	static inline void nf_hook_state_init(struct nf_hook_state *p,
107a9f4d DM	123	unsigned int hook,
1610a73c	124	u_int8_t pf,
107a9f4d DM	125	struct net_device *indev,
107a9f4d DM	126	struct net_device *outdev,
1c984f8a	127	struct sock *sk,
b11b1f65	128	struct net *net,
0c4b51f0	129	int (okfn)(struct net , struct sock , struct sk_buff ))
107a9f4d DM	130	{
107a9f4d DM	131	p->hook = hook;
107a9f4d DM	132	p->pf = pf;
	133	p->in = indev;
	134	p->out = outdev;
1c984f8a	135	p->sk = sk;
b11b1f65	136	p->net = net;
107a9f4d DM	137	p->okfn = okfn;
	138	}
	139
1da177e4	140
1da177e4	141
d94d9fee	142	struct nf_sockopt_ops {
1da177e4 LT	143	struct list_head list;
1da177e4 LT	144
76108cea	145	u_int8_t pf;
1da177e4 LT	146
	147	/* Non-inclusive ranges: use 0/0/NULL to never get called. */
	148	int set_optmin;
	149	int set_optmax;
	150	int (set)(struct sock sk, int optval, void __user *user, unsigned int len);
c30f540b	151	#ifdef CONFIG_COMPAT
3fdadf7d DM	152	int (compat_set)(struct sock sk, int optval,
3fdadf7d DM	153	void __user *user, unsigned int len);
c30f540b	154	#endif
1da177e4 LT	155	int get_optmin;
	156	int get_optmax;
	157	int (get)(struct sock sk, int optval, void __user user, int len);
c30f540b	158	#ifdef CONFIG_COMPAT
3fdadf7d DM	159	int (compat_get)(struct sock sk, int optval,
3fdadf7d DM	160	void __user user, int len);
c30f540b	161	#endif
16fcec35 NH	162	/* Use the module struct to lock set/get code in place */
16fcec35 NH	163	struct module *owner;
1da177e4 LT	164	};
1da177e4 LT	165
1da177e4	166	/* Function to register/unregister hook points. */
085db2c0 EB	167	int nf_register_net_hook(struct net net, const struct nf_hook_ops ops);
	168	void nf_unregister_net_hook(struct net net, const struct nf_hook_ops ops);
	169	int nf_register_net_hooks(struct net net, const struct nf_hook_ops reg,
	170	unsigned int n);
	171	void nf_unregister_net_hooks(struct net net, const struct nf_hook_ops reg,
	172	unsigned int n);
	173
1da177e4 LT	174	/* Functions to register get/setsockopt ranges (non-inclusive). You
	175	need to check permissions yourself! */
	176	int nf_register_sockopt(struct nf_sockopt_ops *reg);
	177	void nf_unregister_sockopt(struct nf_sockopt_ops *reg);
	178
d1c85c2e	179	#ifdef HAVE_JUMP_LABEL
c5905afb	180	extern struct static_key nf_hooks_needed[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
a2d7ec58 ED	181	#endif
a2d7ec58 ED	182
01886bd9	183	int nf_hook_slow(struct sk_buff skb, struct nf_hook_state state,
960632ec	184	const struct nf_hook_entries *e, unsigned int i);
16a6677f PM	185
16a6677f PM	186	/**
1610a73c	187	* nf_hook - call a netfilter hook
b8d0aad0	188	*
16a6677f PM	189	* Returns 1 if the hook has allowed the packet to pass. The function
	190	* okfn must be invoked by the caller in this case. Any other return
	191	* value indicates the packet has been consumed by the hook.
	192	*/
1610a73c PNA	193	static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
	194	struct sock sk, struct sk_buff skb,
	195	struct net_device indev, struct net_device outdev,
	196	int (okfn)(struct net , struct sock , struct sk_buff ))
16a6677f	197	{
b0f38338	198	struct nf_hook_entries *hook_head = NULL;
e3b37f11	199	int ret = 1;
af4610c3 FW	200
	201	#ifdef HAVE_JUMP_LABEL
	202	if (__builtin_constant_p(pf) &&
	203	__builtin_constant_p(hook) &&
	204	!static_key_false(&nf_hooks_needed[pf][hook]))
	205	return 1;
	206	#endif
	207
e3b37f11	208	rcu_read_lock();
b0f38338 FW	209	switch (pf) {
	210	case NFPROTO_IPV4:
	211	hook_head = rcu_dereference(net->nf.hooks_ipv4[hook]);
	212	break;
	213	case NFPROTO_IPV6:
	214	hook_head = rcu_dereference(net->nf.hooks_ipv6[hook]);
	215	break;
	216	case NFPROTO_ARP:
2a95183a	217	#ifdef CONFIG_NETFILTER_FAMILY_ARP
421c119f FW	218	if (WARN_ON_ONCE(hook >= ARRAY_SIZE(net->nf.hooks_arp)))
421c119f FW	219	break;
b0f38338	220	hook_head = rcu_dereference(net->nf.hooks_arp[hook]);
2a95183a	221	#endif
b0f38338 FW	222	break;
b0f38338 FW	223	case NFPROTO_BRIDGE:
2a95183a	224	#ifdef CONFIG_NETFILTER_FAMILY_BRIDGE
b0f38338	225	hook_head = rcu_dereference(net->nf.hooks_bridge[hook]);
2a95183a	226	#endif
b0f38338	227	break;
bb4badf3	228	#if IS_ENABLED(CONFIG_DECNET)
b0f38338 FW	229	case NFPROTO_DECNET:
	230	hook_head = rcu_dereference(net->nf.hooks_decnet[hook]);
	231	break;
bb4badf3	232	#endif
b0f38338 FW	233	default:
	234	WARN_ON_ONCE(1);
	235	break;
	236	}
	237
e3b37f11	238	if (hook_head) {
107a9f4d	239	struct nf_hook_state state;
cfdfab31	240
01886bd9	241	nf_hook_state_init(&state, hook, pf, indev, outdev,
1610a73c	242	sk, net, okfn);
fe72926b	243
960632ec	244	ret = nf_hook_slow(skb, &state, hook_head, 0);
cfdfab31	245	}
e3b37f11 AC	246	rcu_read_unlock();
	247
	248	return ret;
16a6677f PM	249	}
16a6677f PM	250
1da177e4 LT	251	/* Activate hook; either okfn or kfree_skb called, unless a hook
	252	returns NF_STOLEN (in which case, it's up to the hook to deal with
	253	the consequences).
	254
	255	Returns -ERRNO if packet dropped. Zero means queued, stolen or
	256	accepted.
	257	*/
	258
	259	/* RR:
	260	> I don't want nf_hook to return anything because people might forget
	261	> about async and trust the return value to mean "packet was ok".
	262
	263	AK:
	264	Just document it clearly, then you can expect some sense from kernel
	265	coders :)
	266	*/
	267
2249065f	268	static inline int
29a26a56	269	NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net net, struct sock sk,
7026b1dd	270	struct sk_buff skb, struct net_device in, struct net_device *out,
0c4b51f0 EB	271	int (okfn)(struct net , struct sock , struct sk_buff ),
0c4b51f0 EB	272	bool cond)
2249065f	273	{
4bac6b18 PM	274	int ret;
	275
	276	if (!cond \|\|
1610a73c	277	((ret = nf_hook(pf, hook, net, sk, skb, in, out, okfn)) == 1))
0c4b51f0	278	ret = okfn(net, sk, skb);
2249065f JE	279	return ret;
2249065f JE	280	}
1da177e4	281
2249065f	282	static inline int
29a26a56	283	NF_HOOK(uint8_t pf, unsigned int hook, struct net net, struct sock sk, struct sk_buff *skb,
2249065f	284	struct net_device in, struct net_device out,
0c4b51f0	285	int (okfn)(struct net , struct sock , struct sk_buff ))
2249065f	286	{
1610a73c PNA	287	int ret = nf_hook(pf, hook, net, sk, skb, in, out, okfn);
	288	if (ret == 1)
	289	ret = okfn(net, sk, skb);
	290	return ret;
2249065f	291	}
1da177e4	292
17266ee9 EC	293	static inline void
	294	NF_HOOK_LIST(uint8_t pf, unsigned int hook, struct net net, struct sock sk,
	295	struct list_head head, struct net_device in, struct net_device *out,
	296	int (okfn)(struct net , struct sock , struct sk_buff ))
	297	{
	298	struct sk_buff skb, next;
9f17dbf0	299	struct list_head sublist;
17266ee9	300
9f17dbf0	301	INIT_LIST_HEAD(&sublist);
17266ee9	302	list_for_each_entry_safe(skb, next, head, list) {
9f17dbf0 EC	303	list_del(&skb->list);
	304	if (nf_hook(pf, hook, net, sk, skb, in, out, okfn) == 1)
	305	list_add_tail(&skb->list, &sublist);
17266ee9	306	}
9f17dbf0 EC	307	/* Put passed packets back on main list */
9f17dbf0 EC	308	list_splice(&sublist, head);
17266ee9 EC	309	}
17266ee9 EC	310
1da177e4	311	/* Call setsockopt() */
76108cea	312	int nf_setsockopt(struct sock sk, u_int8_t pf, int optval, char __user opt,
b7058842	313	unsigned int len);
76108cea	314	int nf_getsockopt(struct sock sk, u_int8_t pf, int optval, char __user opt,
1da177e4	315	int *len);
c30f540b	316	#ifdef CONFIG_COMPAT
76108cea	317	int compat_nf_setsockopt(struct sock *sk, u_int8_t pf, int optval,
b7058842	318	char __user *opt, unsigned int len);
76108cea	319	int compat_nf_getsockopt(struct sock *sk, u_int8_t pf, int optval,
3fdadf7d	320	char __user opt, int len);
c30f540b	321	#endif
3fdadf7d	322
089af26c HW	323	/* Call this before modifying an existing packet: ensures it is
	324	modifiable and linear to the point you care about (writable_len).
	325	Returns true or false. */
a0f4ecf3	326	int skb_make_writable(struct sk_buff *skb, unsigned int writable_len);
089af26c	327
1841a4c7	328	struct flowi;
02f014d8	329	struct nf_queue_entry;
c01cd429	330
ef71fe27 PNA	331	__sum16 nf_checksum(struct sk_buff *skb, unsigned int hook,
	332	unsigned int dataoff, u_int8_t protocol,
	333	unsigned short family);
422c346f	334
f7dcbe2f PNA	335	__sum16 nf_checksum_partial(struct sk_buff *skb, unsigned int hook,
	336	unsigned int dataoff, unsigned int len,
	337	u_int8_t protocol, unsigned short family);
3f87c08c PNA	338	int nf_route(struct net net, struct dst_entry dst, struct flowi fl,
3f87c08c PNA	339	bool strict, unsigned short family);
ce388f45	340	int nf_reroute(struct sk_buff skb, struct nf_queue_entry entry);
d63a6507	341
eb9c7ebe	342	#include <net/flow.h>
2c205dd3 PNA	343
	344	struct nf_conn;
	345	enum nf_nat_manip_type;
	346	struct nlattr;
368982cd	347	enum ip_conntrack_dir;
2c205dd3 PNA	348
	349	struct nf_nat_hook {
	350	int (parse_nat_setup)(struct nf_conn ct, enum nf_nat_manip_type manip,
	351	const struct nlattr *attr);
	352	void (decode_session)(struct sk_buff skb, struct flowi *fl);
368982cd PNA	353	unsigned int (manip_pkt)(struct sk_buff skb, struct nf_conn *ct,
	354	enum nf_nat_manip_type mtype,
	355	enum ip_conntrack_dir dir);
2c205dd3 PNA	356	};
	357
	358	extern struct nf_nat_hook __rcu *nf_nat_hook;
eb9c7ebe PM	359
eb9c7ebe PM	360	static inline void
76108cea	361	nf_nat_decode_session(struct sk_buff skb, struct flowi fl, u_int8_t family)
eb9c7ebe	362	{
051578cc	363	#ifdef CONFIG_NF_NAT_NEEDED
2c205dd3	364	struct nf_nat_hook *nat_hook;
eb9c7ebe	365
c7232c99	366	rcu_read_lock();
2c205dd3	367	nat_hook = rcu_dereference(nf_nat_hook);
155fb5c5	368	if (nat_hook && nat_hook->decode_session)
2c205dd3	369	nat_hook->decode_session(skb, fl);
c7232c99	370	rcu_read_unlock();
eb9c7ebe PM	371	#endif
	372	}
	373
1da177e4	374	#else /* !CONFIG_NETFILTER */
008027c3 AB	375	static inline int
	376	NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net net, struct sock sk,
	377	struct sk_buff skb, struct net_device in, struct net_device *out,
	378	int (okfn)(struct net , struct sock , struct sk_buff ),
	379	bool cond)
	380	{
	381	return okfn(net, sk, skb);
	382	}
	383
	384	static inline int
	385	NF_HOOK(uint8_t pf, unsigned int hook, struct net net, struct sock sk,
	386	struct sk_buff skb, struct net_device in, struct net_device *out,
	387	int (okfn)(struct net , struct sock , struct sk_buff ))
	388	{
	389	return okfn(net, sk, skb);
	390	}
	391
17266ee9 EC	392	static inline void
	393	NF_HOOK_LIST(uint8_t pf, unsigned int hook, struct net net, struct sock sk,
	394	struct list_head head, struct net_device in, struct net_device *out,
	395	int (okfn)(struct net , struct sock , struct sk_buff ))
	396	{
	397	/* nothing to do */
	398	}
	399
29a26a56 EB	400	static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
	401	struct sock sk, struct sk_buff skb,
	402	struct net_device indev, struct net_device outdev,
0c4b51f0	403	int (okfn)(struct net , struct sock , struct sk_buff ))
f53b61d8	404	{
9c92d348	405	return 1;
f53b61d8	406	}
f53b61d8	407	struct flowi;
eb9c7ebe	408	static inline void
76108cea JE	409	nf_nat_decode_session(struct sk_buff skb, struct flowi fl, u_int8_t family)
	410	{
	411	}
1da177e4 LT	412	#endif /CONFIG_NETFILTER/
1da177e4 LT	413
5f79e0f9	414	#if defined(CONFIG_NF_CONNTRACK) \|\| defined(CONFIG_NF_CONNTRACK_MODULE)
62da9865 DB	415	#include <linux/netfilter/nf_conntrack_zones_common.h>
62da9865 DB	416
312a0c16	417	extern void (ip_ct_attach)(struct sk_buff , const struct sk_buff *) __rcu;
a0f4ecf3	418	void nf_ct_attach(struct sk_buff , const struct sk_buff );
b60a6040 THJ	419	struct nf_conntrack_tuple;
	420	bool nf_ct_get_tuple_skb(struct nf_conntrack_tuple *dst_tuple,
	421	const struct sk_buff *skb);
b7bd1809 PNA	422	#else
b7bd1809 PNA	423	static inline void nf_ct_attach(struct sk_buff new, struct sk_buff skb) {}
b60a6040 THJ	424	struct nf_conntrack_tuple;
	425	static inline bool nf_ct_get_tuple_skb(struct nf_conntrack_tuple *dst_tuple,
	426	const struct sk_buff *skb)
	427	{
	428	return false;
	429	}
b7bd1809	430	#endif
9cb01766 PNA	431
9cb01766 PNA	432	struct nf_conn;
41d73ec0	433	enum ip_conntrack_info;
1f4b2439 PNA	434
1f4b2439 PNA	435	struct nf_ct_hook {
368982cd	436	int (update)(struct net net, struct sk_buff *skb);
1f4b2439	437	void (destroy)(struct nf_conntrack );
b60a6040 THJ	438	bool (get_tuple_skb)(struct nf_conntrack_tuple ,
b60a6040 THJ	439	const struct sk_buff *);
1f4b2439 PNA	440	};
	441	extern struct nf_ct_hook __rcu *nf_ct_hook;
	442
9cb01766 PNA	443	struct nlattr;
9cb01766 PNA	444
a4b4766c	445	struct nfnl_ct_hook {
224a0597	446	struct nf_conn (get_ct)(const struct sk_buff *skb,
b7bd1809	447	enum ip_conntrack_info *ctinfo);
9cb01766	448	size_t (build_size)(const struct nf_conn ct);
b7bd1809 PNA	449	int (build)(struct sk_buff skb, struct nf_conn *ct,
	450	enum ip_conntrack_info ctinfo,
	451	u_int16_t ct_attr, u_int16_t ct_info_attr);
9cb01766	452	int (parse)(const struct nlattr attr, struct nf_conn *ct);
bd077937 PNA	453	int (attach_expect)(const struct nlattr attr, struct nf_conn *ct,
bd077937 PNA	454	u32 portid, u32 report);
8c88f87c	455	void (seq_adjust)(struct sk_buff skb, struct nf_conn *ct,
41d73ec0	456	enum ip_conntrack_info ctinfo, s32 off);
9cb01766	457	};
a4b4766c	458	extern struct nfnl_ct_hook __rcu *nfnl_ct_hook;
5f79e0f9	459
e7c8899f FW	460	/**
	461	* nf_skb_duplicated - TEE target has sent a packet
	462	*
	463	* When a xtables target sends a packet, the OUTPUT and POSTROUTING
	464	* hooks are traversed again, i.e. nft and xtables are invoked recursively.
	465	*
	466	* This is used by xtables TEE target to prevent the duplicated skb from
	467	* being duplicated again.
	468	*/
	469	DECLARE_PER_CPU(bool, nf_skb_duplicated);
	470
1da177e4	471	#endif /__LINUX_NETFILTER_H/