[mirror_ubuntu-jammy-kernel.git] / include / net / act_api.h

#ifndef __NET_ACT_API_H
#define __NET_ACT_API_H

/*
 * Public action API for classifiers/qdiscs
*/

#include <net/sch_generic.h>
#include <net/pkt_sched.h>
#include <net/net_namespace.h>
#include <net/netns/generic.h>

struct tcf_common {
	struct hlist_node		tcfc_head;
	u32				tcfc_index;
	int				tcfc_refcnt;
	int				tcfc_bindcnt;
	u32				tcfc_capab;
	int				tcfc_action;
	struct tcf_t			tcfc_tm;
	struct gnet_stats_basic_packed	tcfc_bstats;
	struct gnet_stats_queue		tcfc_qstats;
	struct gnet_stats_rate_est64	tcfc_rate_est;
	spinlock_t			tcfc_lock;
	struct rcu_head			tcfc_rcu;
	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
	struct gnet_stats_queue __percpu *cpu_qstats;
};
#define tcf_head	common.tcfc_head
#define tcf_index	common.tcfc_index
#define tcf_refcnt	common.tcfc_refcnt
#define tcf_bindcnt	common.tcfc_bindcnt
#define tcf_capab	common.tcfc_capab
#define tcf_action	common.tcfc_action
#define tcf_tm		common.tcfc_tm
#define tcf_bstats	common.tcfc_bstats
#define tcf_qstats	common.tcfc_qstats
#define tcf_rate_est	common.tcfc_rate_est
#define tcf_lock	common.tcfc_lock
#define tcf_rcu		common.tcfc_rcu

struct tcf_hashinfo {
	struct hlist_head	*htab;
	unsigned int		hmask;
	spinlock_t		lock;
	u32			index;
};

static inline unsigned int tcf_hash(u32 index, unsigned int hmask)
{
	return index & hmask;
}

static inline int tcf_hashinfo_init(struct tcf_hashinfo *hf, unsigned int mask)
{
	int i;

	spin_lock_init(&hf->lock);
	hf->index = 0;
	hf->hmask = mask;
	hf->htab = kzalloc((mask + 1) * sizeof(struct hlist_head),
			   GFP_KERNEL);
	if (!hf->htab)
		return -ENOMEM;
	for (i = 0; i < mask + 1; i++)
		INIT_HLIST_HEAD(&hf->htab[i]);
	return 0;
}

/* Update lastuse only if needed, to avoid dirtying a cache line.
 * We use a temp variable to avoid fetching jiffies twice.
 */
static inline void tcf_lastuse_update(struct tcf_t *tm)
{
	unsigned long now = jiffies;

	if (tm->lastuse != now)
		tm->lastuse = now;
	if (unlikely(!tm->firstuse))
		tm->firstuse = now;
}

static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
{
	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
	dtm->expires = jiffies_to_clock_t(stm->expires);
}

struct tc_action {
	void			*priv;
	const struct tc_action_ops	*ops;
	__u32			type; /* for backward compat(TCA_OLD_COMPAT) */
	__u32			order;
	struct list_head	list;
	struct tcf_hashinfo	*hinfo;
};

#ifdef CONFIG_NET_CLS_ACT

#define ACT_P_CREATED 1
#define ACT_P_DELETED 1

struct tc_action_ops {
	struct list_head head;
	char    kind[IFNAMSIZ];
	__u32   type; /* TBD to match kind */
	struct module		*owner;
	int     (*act)(struct sk_buff *, const struct tc_action *,
		       struct tcf_result *);
	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
	void	(*cleanup)(struct tc_action *, int bind);
	int     (*lookup)(struct net *, struct tc_action *, u32);
	int     (*init)(struct net *net, struct nlattr *nla,
			struct nlattr *est, struct tc_action *act, int ovr,
			int bind);
	int     (*walk)(struct net *, struct sk_buff *,
			struct netlink_callback *, int, struct tc_action *);
	void	(*stats_update)(struct tc_action *, u64, u32, u64);
};

struct tc_action_net {
	struct tcf_hashinfo *hinfo;
	const struct tc_action_ops *ops;
};

static inline
int tc_action_net_init(struct tc_action_net *tn,
		       const struct tc_action_ops *ops, unsigned int mask)
{
	int err = 0;

	tn->hinfo = kmalloc(sizeof(*tn->hinfo), GFP_KERNEL);
	if (!tn->hinfo)
		return -ENOMEM;
	tn->ops = ops;
	err = tcf_hashinfo_init(tn->hinfo, mask);
	if (err)
		kfree(tn->hinfo);
	return err;
}

void tcf_hashinfo_destroy(const struct tc_action_ops *ops,
			  struct tcf_hashinfo *hinfo);

static inline void tc_action_net_exit(struct tc_action_net *tn)
{
	tcf_hashinfo_destroy(tn->ops, tn->hinfo);
	kfree(tn->hinfo);
}

int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
		       struct netlink_callback *cb, int type,
		       struct tc_action *a);
int tcf_hash_search(struct tc_action_net *tn, struct tc_action *a, u32 index);
u32 tcf_hash_new_index(struct tc_action_net *tn);
bool tcf_hash_check(struct tc_action_net *tn, u32 index, struct tc_action *a,
		    int bind);
int tcf_hash_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
		    struct tc_action *a, int size, int bind, bool cpustats);
void tcf_hash_cleanup(struct tc_action *a, struct nlattr *est);
void tcf_hash_insert(struct tc_action_net *tn, struct tc_action *a);

int __tcf_hash_release(struct tc_action *a, bool bind, bool strict);

static inline int tcf_hash_release(struct tc_action *a, bool bind)
{
	return __tcf_hash_release(a, bind, false);
}

int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
int tcf_unregister_action(struct tc_action_ops *a,
			  struct pernet_operations *ops);
int tcf_action_destroy(struct list_head *actions, int bind);
int tcf_action_exec(struct sk_buff *skb, const struct list_head *actions,
		    struct tcf_result *res);
int tcf_action_init(struct net *net, struct nlattr *nla,
				  struct nlattr *est, char *n, int ovr,
				  int bind, struct list_head *);
struct tc_action *tcf_action_init_1(struct net *net, struct nlattr *nla,
				    struct nlattr *est, char *n, int ovr,
				    int bind);
int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);

#define tc_no_actions(_exts) \
	(list_empty(&(_exts)->actions))

#define tc_for_each_action(_a, _exts) \
	list_for_each_entry(a, &(_exts)->actions, list)

static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
					   u64 packets, u64 lastuse)
{
	if (!a->ops->stats_update)
		return;

	a->ops->stats_update(a, bytes, packets, lastuse);
}

#else /* CONFIG_NET_CLS_ACT */

#define tc_no_actions(_exts) true
#define tc_for_each_action(_a, _exts) while ((void)(_a), 0)
#define tcf_action_stats_update(a, bytes, packets, lastuse)

#endif /* CONFIG_NET_CLS_ACT */
#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef __NET_ACT_API_H
	2	#define __NET_ACT_API_H
	3
	4	/*
0b0f43fe JHS	5	* Public action API for classifiers/qdiscs
0b0f43fe JHS	6	*/
1da177e4 LT	7
	8	#include <net/sch_generic.h>
	9	#include <net/pkt_sched.h>
ddf97ccd WC	10	#include <net/net_namespace.h>
ddf97ccd WC	11	#include <net/netns/generic.h>
1da177e4	12
e9ce1cd3	13	struct tcf_common {
89819dc0	14	struct hlist_node tcfc_head;
e9ce1cd3 DM	15	u32 tcfc_index;
	16	int tcfc_refcnt;
	17	int tcfc_bindcnt;
	18	u32 tcfc_capab;
	19	int tcfc_action;
	20	struct tcf_t tcfc_tm;
c1a8f1f1	21	struct gnet_stats_basic_packed tcfc_bstats;
e9ce1cd3	22	struct gnet_stats_queue tcfc_qstats;
45203a3b	23	struct gnet_stats_rate_est64 tcfc_rate_est;
e9ce1cd3	24	spinlock_t tcfc_lock;
c7de2cf0	25	struct rcu_head tcfc_rcu;
519c818e ED	26	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
519c818e ED	27	struct gnet_stats_queue __percpu *cpu_qstats;
e9ce1cd3	28	};
89819dc0	29	#define tcf_head common.tcfc_head
e9ce1cd3 DM	30	#define tcf_index common.tcfc_index
	31	#define tcf_refcnt common.tcfc_refcnt
	32	#define tcf_bindcnt common.tcfc_bindcnt
	33	#define tcf_capab common.tcfc_capab
	34	#define tcf_action common.tcfc_action
	35	#define tcf_tm common.tcfc_tm
	36	#define tcf_bstats common.tcfc_bstats
	37	#define tcf_qstats common.tcfc_qstats
	38	#define tcf_rate_est common.tcfc_rate_est
e9ce1cd3	39	#define tcf_lock common.tcfc_lock
c7de2cf0	40	#define tcf_rcu common.tcfc_rcu
e9ce1cd3	41
e9ce1cd3	42	struct tcf_hashinfo {
89819dc0	43	struct hlist_head *htab;
e9ce1cd3	44	unsigned int hmask;
89819dc0	45	spinlock_t lock;
ddafd34f	46	u32 index;
e9ce1cd3 DM	47	};
	48
	49	static inline unsigned int tcf_hash(u32 index, unsigned int hmask)
	50	{
	51	return index & hmask;
	52	}
1da177e4	53
369ba567 WC	54	static inline int tcf_hashinfo_init(struct tcf_hashinfo *hf, unsigned int mask)
369ba567 WC	55	{
89819dc0 WC	56	int i;
	57
	58	spin_lock_init(&hf->lock);
ddafd34f	59	hf->index = 0;
369ba567	60	hf->hmask = mask;
89819dc0	61	hf->htab = kzalloc((mask + 1) * sizeof(struct hlist_head),
369ba567 WC	62	GFP_KERNEL);
	63	if (!hf->htab)
	64	return -ENOMEM;
89819dc0 WC	65	for (i = 0; i < mask + 1; i++)
89819dc0 WC	66	INIT_HLIST_HEAD(&hf->htab[i]);
369ba567 WC	67	return 0;
	68	}
	69
56e5d1ca ED	70	/* Update lastuse only if needed, to avoid dirtying a cache line.
	71	* We use a temp variable to avoid fetching jiffies twice.
	72	*/
	73	static inline void tcf_lastuse_update(struct tcf_t *tm)
	74	{
	75	unsigned long now = jiffies;
	76
	77	if (tm->lastuse != now)
	78	tm->lastuse = now;
53eb440f JHS	79	if (unlikely(!tm->firstuse))
53eb440f JHS	80	tm->firstuse = now;
56e5d1ca ED	81	}
56e5d1ca ED	82
48d8ee16 JHS	83	static inline void tcf_tm_dump(struct tcf_t dtm, const struct tcf_t stm)
	84	{
	85	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
	86	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
	87	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
	88	dtm->expires = jiffies_to_clock_t(stm->expires);
	89	}
	90
e9ce1cd3 DM	91	struct tc_action {
e9ce1cd3 DM	92	void *priv;
dc7f9f6e	93	const struct tc_action_ops *ops;
e9ce1cd3 DM	94	__u32 type; /* for backward compat(TCA_OLD_COMPAT) */
e9ce1cd3 DM	95	__u32 order;
33be6271	96	struct list_head list;
ddf97ccd	97	struct tcf_hashinfo *hinfo;
1da177e4 LT	98	};
1da177e4 LT	99
00175aec AV	100	#ifdef CONFIG_NET_CLS_ACT
	101
	102	#define ACT_P_CREATED 1
	103	#define ACT_P_DELETED 1
	104
e9ce1cd3	105	struct tc_action_ops {
1f747c26	106	struct list_head head;
1da177e4 LT	107	char kind[IFNAMSIZ];
1da177e4 LT	108	__u32 type; /* TBD to match kind */
1da177e4	109	struct module *owner;
0b0f43fe JHS	110	int (act)(struct sk_buff , const struct tc_action *,
0b0f43fe JHS	111	struct tcf_result *);
e9ce1cd3	112	int (dump)(struct sk_buff , struct tc_action *, int, int);
a5b5c958	113	void (cleanup)(struct tc_action , int bind);
ddf97ccd	114	int (lookup)(struct net , struct tc_action *, u32);
c1b52739 BL	115	int (init)(struct net net, struct nlattr *nla,
	116	struct nlattr est, struct tc_action act, int ovr,
	117	int bind);
ddf97ccd WC	118	int (walk)(struct net , struct sk_buff *,
ddf97ccd WC	119	struct netlink_callback , int, struct tc_action );
38040702	120	void (stats_update)(struct tc_action , u64, u32, u64);
ddf97ccd WC	121	};
	122
	123	struct tc_action_net {
	124	struct tcf_hashinfo *hinfo;
	125	const struct tc_action_ops *ops;
1da177e4 LT	126	};
1da177e4 LT	127
ddf97ccd	128	static inline
0b0f43fe JHS	129	int tc_action_net_init(struct tc_action_net *tn,
0b0f43fe JHS	130	const struct tc_action_ops *ops, unsigned int mask)
ddf97ccd WC	131	{
	132	int err = 0;
	133
	134	tn->hinfo = kmalloc(sizeof(*tn->hinfo), GFP_KERNEL);
	135	if (!tn->hinfo)
	136	return -ENOMEM;
	137	tn->ops = ops;
	138	err = tcf_hashinfo_init(tn->hinfo, mask);
	139	if (err)
	140	kfree(tn->hinfo);
	141	return err;
	142	}
	143
	144	void tcf_hashinfo_destroy(const struct tc_action_ops *ops,
	145	struct tcf_hashinfo *hinfo);
	146
	147	static inline void tc_action_net_exit(struct tc_action_net *tn)
	148	{
	149	tcf_hashinfo_destroy(tn->ops, tn->hinfo);
18fcf49f	150	kfree(tn->hinfo);
ddf97ccd WC	151	}
	152
	153	int tcf_generic_walker(struct tc_action_net tn, struct sk_buff skb,
	154	struct netlink_callback *cb, int type,
	155	struct tc_action *a);
	156	int tcf_hash_search(struct tc_action_net tn, struct tc_action a, u32 index);
	157	u32 tcf_hash_new_index(struct tc_action_net *tn);
b2313077 WC	158	bool tcf_hash_check(struct tc_action_net tn, u32 index, struct tc_action a,
b2313077 WC	159	int bind);
ddf97ccd WC	160	int tcf_hash_create(struct tc_action_net tn, u32 index, struct nlattr est,
ddf97ccd WC	161	struct tc_action *a, int size, int bind, bool cpustats);
86062033	162	void tcf_hash_cleanup(struct tc_action a, struct nlattr est);
ddf97ccd	163	void tcf_hash_insert(struct tc_action_net tn, struct tc_action a);
e9ce1cd3	164
28e6b67f DB	165	int __tcf_hash_release(struct tc_action *a, bool bind, bool strict);
	166
	167	static inline int tcf_hash_release(struct tc_action *a, bool bind)
	168	{
	169	return __tcf_hash_release(a, bind, false);
	170	}
	171
ddf97ccd	172	int tcf_register_action(struct tc_action_ops a, struct pernet_operations ops);
0b0f43fe JHS	173	int tcf_unregister_action(struct tc_action_ops *a,
0b0f43fe JHS	174	struct pernet_operations *ops);
55334a5d	175	int tcf_action_destroy(struct list_head *actions, int bind);
33be6271	176	int tcf_action_exec(struct sk_buff skb, const struct list_head actions,
5c15257f	177	struct tcf_result *res);
33be6271	178	int tcf_action_init(struct net net, struct nlattr nla,
5c15257f	179	struct nlattr est, char n, int ovr,
33be6271	180	int bind, struct list_head *);
5c15257f JP	181	struct tc_action tcf_action_init_1(struct net net, struct nlattr *nla,
	182	struct nlattr est, char n, int ovr,
	183	int bind);
33be6271	184	int tcf_action_dump(struct sk_buff skb, struct list_head , int, int);
5c15257f JP	185	int tcf_action_dump_old(struct sk_buff skb, struct tc_action a, int, int);
	186	int tcf_action_dump_1(struct sk_buff skb, struct tc_action a, int, int);
	187	int tcf_action_copy_stats(struct sk_buff , struct tc_action , int);
00175aec AV	188
	189	#define tc_no_actions(_exts) \
	190	(list_empty(&(_exts)->actions))
	191
	192	#define tc_for_each_action(_a, _exts) \
	193	list_for_each_entry(a, &(_exts)->actions, list)
38040702 AV	194
	195	static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
	196	u64 packets, u64 lastuse)
	197	{
	198	if (!a->ops->stats_update)
	199	return;
	200
	201	a->ops->stats_update(a, bytes, packets, lastuse);
	202	}
	203
00175aec AV	204	#else /* CONFIG_NET_CLS_ACT */
	205
	206	#define tc_no_actions(_exts) true
e6790fd8	207	#define tc_for_each_action(_a, _exts) while ((void)(_a), 0)
38040702	208	#define tcf_action_stats_update(a, bytes, packets, lastuse)
00175aec	209
1da177e4	210	#endif /* CONFIG_NET_CLS_ACT */
1da177e4	211	#endif