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

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

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

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

struct tcf_idrinfo {
	struct mutex	lock;
	struct idr	action_idr;
	struct net	*net;
};

struct tc_action_ops;

struct tc_action {
	const struct tc_action_ops	*ops;
	__u32				type; /* for backward compat(TCA_OLD_COMPAT) */
	struct tcf_idrinfo		*idrinfo;

	u32				tcfa_index;
	refcount_t			tcfa_refcnt;
	atomic_t			tcfa_bindcnt;
	int				tcfa_action;
	struct tcf_t			tcfa_tm;
	struct gnet_stats_basic_packed	tcfa_bstats;
	struct gnet_stats_basic_packed	tcfa_bstats_hw;
	struct gnet_stats_queue		tcfa_qstats;
	struct net_rate_estimator __rcu *tcfa_rate_est;
	spinlock_t			tcfa_lock;
	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
	struct gnet_stats_basic_cpu __percpu *cpu_bstats_hw;
	struct gnet_stats_queue __percpu *cpu_qstats;
	struct tc_cookie	__rcu *act_cookie;
	struct tcf_chain	__rcu *goto_chain;
	u32			tcfa_flags;
	u8			hw_stats;
	u8			used_hw_stats;
	bool			used_hw_stats_valid;
};
#define tcf_index	common.tcfa_index
#define tcf_refcnt	common.tcfa_refcnt
#define tcf_bindcnt	common.tcfa_bindcnt
#define tcf_action	common.tcfa_action
#define tcf_tm		common.tcfa_tm
#define tcf_bstats	common.tcfa_bstats
#define tcf_qstats	common.tcfa_qstats
#define tcf_rate_est	common.tcfa_rate_est
#define tcf_lock	common.tcfa_lock

#define TCA_ACT_HW_STATS_ANY (TCA_ACT_HW_STATS_IMMEDIATE | \
			      TCA_ACT_HW_STATS_DELAYED)

/* 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);
}

#ifdef CONFIG_NET_CLS_ACT

#define ACT_P_CREATED 1
#define ACT_P_DELETED 1

typedef void (*tc_action_priv_destructor)(void *priv);

struct tc_action_ops {
	struct list_head head;
	char    kind[IFNAMSIZ];
	enum tca_id  id; /* identifier should match kind */
	size_t	size;
	struct module		*owner;
	int     (*act)(struct sk_buff *, const struct tc_action *,
		       struct tcf_result *); /* called under RCU BH lock*/
	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
	void	(*cleanup)(struct tc_action *);
	int     (*lookup)(struct net *net, struct tc_action **a, u32 index);
	int     (*init)(struct net *net, struct nlattr *nla,
			struct nlattr *est, struct tc_action **act, int ovr,
			int bind, bool rtnl_held, struct tcf_proto *tp,
			u32 flags, struct netlink_ext_ack *extack);
	int     (*walk)(struct net *, struct sk_buff *,
			struct netlink_callback *, int,
			const struct tc_action_ops *,
			struct netlink_ext_ack *);
	void	(*stats_update)(struct tc_action *, u64, u32, u64, bool);
	size_t  (*get_fill_size)(const struct tc_action *act);
	struct net_device *(*get_dev)(const struct tc_action *a,
				      tc_action_priv_destructor *destructor);
	struct psample_group *
	(*get_psample_group)(const struct tc_action *a,
			     tc_action_priv_destructor *destructor);
};

struct tc_action_net {
	struct tcf_idrinfo *idrinfo;
	const struct tc_action_ops *ops;
};

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

	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
	if (!tn->idrinfo)
		return -ENOMEM;
	tn->ops = ops;
	tn->idrinfo->net = net;
	mutex_init(&tn->idrinfo->lock);
	idr_init(&tn->idrinfo->action_idr);
	return err;
}

void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
			 struct tcf_idrinfo *idrinfo);

static inline void tc_action_net_exit(struct list_head *net_list,
				      unsigned int id)
{
	struct net *net;

	rtnl_lock();
	list_for_each_entry(net, net_list, exit_list) {
		struct tc_action_net *tn = net_generic(net, id);

		tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
		kfree(tn->idrinfo);
	}
	rtnl_unlock();
}

int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
		       struct netlink_callback *cb, int type,
		       const struct tc_action_ops *ops,
		       struct netlink_ext_ack *extack);
int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
		   struct tc_action **a, const struct tc_action_ops *ops,
		   int bind, bool cpustats, u32 flags);
int tcf_idr_create_from_flags(struct tc_action_net *tn, u32 index,
			      struct nlattr *est, struct tc_action **a,
			      const struct tc_action_ops *ops, int bind,
			      u32 flags);
void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);

void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
			struct tc_action **a, int bind);
int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);

static inline int tcf_idr_release(struct tc_action *a, bool bind)
{
	return __tcf_idr_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 tc_action *actions[], int bind);
int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
		    int nr_actions, struct tcf_result *res);
int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
		    struct nlattr *est, char *name, int ovr, int bind,
		    struct tc_action *actions[], size_t *attr_size,
		    bool rtnl_held, struct netlink_ext_ack *extack);
struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
				    struct nlattr *nla, struct nlattr *est,
				    char *name, int ovr, int bind,
				    bool rtnl_held,
				    struct netlink_ext_ack *extack);
int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
		    int ref);
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);

static inline void tcf_action_update_bstats(struct tc_action *a,
					    struct sk_buff *skb)
{
	if (likely(a->cpu_bstats)) {
		bstats_cpu_update(this_cpu_ptr(a->cpu_bstats), skb);
		return;
	}
	spin_lock(&a->tcfa_lock);
	bstats_update(&a->tcfa_bstats, skb);
	spin_unlock(&a->tcfa_lock);
}

static inline void tcf_action_inc_drop_qstats(struct tc_action *a)
{
	if (likely(a->cpu_qstats)) {
		qstats_drop_inc(this_cpu_ptr(a->cpu_qstats));
		return;
	}
	spin_lock(&a->tcfa_lock);
	qstats_drop_inc(&a->tcfa_qstats);
	spin_unlock(&a->tcfa_lock);
}

static inline void tcf_action_inc_overlimit_qstats(struct tc_action *a)
{
	if (likely(a->cpu_qstats)) {
		qstats_overlimit_inc(this_cpu_ptr(a->cpu_qstats));
		return;
	}
	spin_lock(&a->tcfa_lock);
	qstats_overlimit_inc(&a->tcfa_qstats);
	spin_unlock(&a->tcfa_lock);
}

void tcf_action_update_stats(struct tc_action *a, u64 bytes, u32 packets,
			     bool drop, bool hw);
int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);

int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
			     struct tcf_chain **handle,
			     struct netlink_ext_ack *newchain);
struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
					 struct tcf_chain *newchain);
#endif /* CONFIG_NET_CLS_ACT */

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

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


#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __NET_ACT_API_H
	3	#define __NET_ACT_API_H
	4
	5	/*
0b0f43fe JHS	6	* Public action API for classifiers/qdiscs
0b0f43fe JHS	7	*/
1da177e4	8
036bb443	9	#include <linux/refcount.h>
1da177e4 LT	10	#include <net/sch_generic.h>
1da177e4 LT	11	#include <net/pkt_sched.h>
ddf97ccd WC	12	#include <net/net_namespace.h>
ddf97ccd WC	13	#include <net/netns/generic.h>
1da177e4	14
65a206c0	15	struct tcf_idrinfo {
95278dda	16	struct mutex lock;
65a206c0	17	struct idr action_idr;
981471bd	18	struct net *net;
a85a970a WC	19	};
	20
	21	struct tc_action_ops;
	22
	23	struct tc_action {
	24	const struct tc_action_ops *ops;
ec0595cc	25	__u32 type; /* for backward compat(TCA_OLD_COMPAT) */
65a206c0	26	struct tcf_idrinfo *idrinfo;
a85a970a	27
ec0595cc	28	u32 tcfa_index;
036bb443 VB	29	refcount_t tcfa_refcnt;
036bb443 VB	30	atomic_t tcfa_bindcnt;
ec0595cc WC	31	int tcfa_action;
	32	struct tcf_t tcfa_tm;
	33	struct gnet_stats_basic_packed tcfa_bstats;
28169aba	34	struct gnet_stats_basic_packed tcfa_bstats_hw;
ec0595cc	35	struct gnet_stats_queue tcfa_qstats;
1c0d32fd	36	struct net_rate_estimator __rcu *tcfa_rate_est;
ec0595cc	37	spinlock_t tcfa_lock;
519c818e	38	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
28169aba	39	struct gnet_stats_basic_cpu __percpu *cpu_bstats_hw;
519c818e	40	struct gnet_stats_queue __percpu *cpu_qstats;
eec94fdb	41	struct tc_cookie __rcu *act_cookie;
ee3bbfe8	42	struct tcf_chain __rcu *goto_chain;
e3822678	43	u32 tcfa_flags;
0dfb2d82	44	u8 hw_stats;
93a129eb JP	45	u8 used_hw_stats;
93a129eb JP	46	bool used_hw_stats_valid;
e9ce1cd3	47	};
ec0595cc WC	48	#define tcf_index common.tcfa_index
	49	#define tcf_refcnt common.tcfa_refcnt
	50	#define tcf_bindcnt common.tcfa_bindcnt
ec0595cc WC	51	#define tcf_action common.tcfa_action
	52	#define tcf_tm common.tcfa_tm
	53	#define tcf_bstats common.tcfa_bstats
	54	#define tcf_qstats common.tcfa_qstats
	55	#define tcf_rate_est common.tcfa_rate_est
	56	#define tcf_lock common.tcfa_lock
e9ce1cd3	57
0dfb2d82 JK	58	#define TCA_ACT_HW_STATS_ANY (TCA_ACT_HW_STATS_IMMEDIATE \| \
0dfb2d82 JK	59	TCA_ACT_HW_STATS_DELAYED)
44f86580	60
56e5d1ca ED	61	/* Update lastuse only if needed, to avoid dirtying a cache line.
	62	* We use a temp variable to avoid fetching jiffies twice.
	63	*/
	64	static inline void tcf_lastuse_update(struct tcf_t *tm)
	65	{
	66	unsigned long now = jiffies;
	67
	68	if (tm->lastuse != now)
	69	tm->lastuse = now;
53eb440f JHS	70	if (unlikely(!tm->firstuse))
53eb440f JHS	71	tm->firstuse = now;
56e5d1ca ED	72	}
56e5d1ca ED	73
48d8ee16 JHS	74	static inline void tcf_tm_dump(struct tcf_t dtm, const struct tcf_t stm)
	75	{
	76	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
	77	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
	78	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
	79	dtm->expires = jiffies_to_clock_t(stm->expires);
	80	}
	81
00175aec AV	82	#ifdef CONFIG_NET_CLS_ACT
	83
	84	#define ACT_P_CREATED 1
	85	#define ACT_P_DELETED 1
	86
4a5da47d VB	87	typedef void (tc_action_priv_destructor)(void priv);
4a5da47d VB	88
e9ce1cd3	89	struct tc_action_ops {
1f747c26	90	struct list_head head;
1da177e4	91	char kind[IFNAMSIZ];
eddd2cf1	92	enum tca_id id; /* identifier should match kind */
a85a970a	93	size_t size;
1da177e4	94	struct module *owner;
0b0f43fe	95	int (act)(struct sk_buff , const struct tc_action *,
7fd4b288	96	struct tcf_result ); / called under RCU BH lock*/
e9ce1cd3	97	int (dump)(struct sk_buff , struct tc_action *, int, int);
9a63b255	98	void (cleanup)(struct tc_action );
f061b48c	99	int (lookup)(struct net net, struct tc_action **a, u32 index);
c1b52739	100	int (init)(struct net net, struct nlattr *nla,
a85a970a	101	struct nlattr est, struct tc_action *act, int ovr,
85d0966f	102	int bind, bool rtnl_held, struct tcf_proto *tp,
abbb0d33	103	u32 flags, struct netlink_ext_ack *extack);
ddf97ccd	104	int (walk)(struct net , struct sk_buff *,
1af85155	105	struct netlink_callback *, int,
41780105 AA	106	const struct tc_action_ops *,
41780105 AA	107	struct netlink_ext_ack *);
28169aba	108	void (stats_update)(struct tc_action , u64, u32, u64, bool);
a03b91b1	109	size_t (get_fill_size)(const struct tc_action act);
470d5060 VB	110	struct net_device (get_dev)(const struct tc_action *a,
470d5060 VB	111	tc_action_priv_destructor *destructor);
4a5da47d VB	112	struct psample_group *
	113	(get_psample_group)(const struct tc_action a,
	114	tc_action_priv_destructor *destructor);
ddf97ccd WC	115	};
	116
	117	struct tc_action_net {
65a206c0	118	struct tcf_idrinfo *idrinfo;
ddf97ccd	119	const struct tc_action_ops *ops;
1da177e4 LT	120	};
1da177e4 LT	121
ddf97ccd	122	static inline
981471bd	123	int tc_action_net_init(struct net net, struct tc_action_net tn,
c7e460ce	124	const struct tc_action_ops *ops)
ddf97ccd WC	125	{
	126	int err = 0;
	127
65a206c0 CM	128	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
65a206c0 CM	129	if (!tn->idrinfo)
ddf97ccd WC	130	return -ENOMEM;
ddf97ccd WC	131	tn->ops = ops;
981471bd	132	tn->idrinfo->net = net;
95278dda	133	mutex_init(&tn->idrinfo->lock);
65a206c0	134	idr_init(&tn->idrinfo->action_idr);
ddf97ccd WC	135	return err;
	136	}
	137
65a206c0 CM	138	void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
65a206c0 CM	139	struct tcf_idrinfo *idrinfo);
ddf97ccd	140
039af9c6 CW	141	static inline void tc_action_net_exit(struct list_head *net_list,
039af9c6 CW	142	unsigned int id)
ddf97ccd	143	{
039af9c6 CW	144	struct net *net;
039af9c6 CW	145
a159d3c4	146	rtnl_lock();
039af9c6 CW	147	list_for_each_entry(net, net_list, exit_list) {
	148	struct tc_action_net *tn = net_generic(net, id);
	149
	150	tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
	151	kfree(tn->idrinfo);
	152	}
a159d3c4	153	rtnl_unlock();
ddf97ccd WC	154	}
	155
	156	int tcf_generic_walker(struct tc_action_net tn, struct sk_buff skb,
	157	struct netlink_callback *cb, int type,
b3620145 AA	158	const struct tc_action_ops *ops,
b3620145 AA	159	struct netlink_ext_ack *extack);
65a206c0	160	int tcf_idr_search(struct tc_action_net tn, struct tc_action *a, u32 index);
65a206c0 CM	161	int tcf_idr_create(struct tc_action_net tn, u32 index, struct nlattr est,
65a206c0 CM	162	struct tc_action *a, const struct tc_action_ops ops,
e3822678 VB	163	int bind, bool cpustats, u32 flags);
	164	int tcf_idr_create_from_flags(struct tc_action_net *tn, u32 index,
	165	struct nlattr est, struct tc_action *a,
	166	const struct tc_action_ops *ops, int bind,
	167	u32 flags);
65a206c0	168	void tcf_idr_insert(struct tc_action_net tn, struct tc_action a);
e9ce1cd3	169
0190c1d4 VB	170	void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
	171	int tcf_idr_check_alloc(struct tc_action_net tn, u32 index,
	172	struct tc_action **a, int bind);
65a206c0	173	int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
28e6b67f	174
65a206c0	175	static inline int tcf_idr_release(struct tc_action *a, bool bind)
28e6b67f	176	{
65a206c0	177	return __tcf_idr_release(a, bind, false);
28e6b67f DB	178	}
28e6b67f DB	179
ddf97ccd	180	int tcf_register_action(struct tc_action_ops a, struct pernet_operations ops);
0b0f43fe JHS	181	int tcf_unregister_action(struct tc_action_ops *a,
0b0f43fe JHS	182	struct pernet_operations *ops);
90b73b77	183	int tcf_action_destroy(struct tc_action *actions[], int bind);
22dc13c8 WC	184	int tcf_action_exec(struct sk_buff skb, struct tc_action *actions,
22dc13c8 WC	185	int nr_actions, struct tcf_result *res);
9fb9f251 JP	186	int tcf_action_init(struct net net, struct tcf_proto tp, struct nlattr *nla,
9fb9f251 JP	187	struct nlattr est, char name, int ovr, int bind,
90b73b77	188	struct tc_action actions[], size_t attr_size,
789871bb	189	bool rtnl_held, struct netlink_ext_ack *extack);
9fb9f251 JP	190	struct tc_action tcf_action_init_1(struct net net, struct tcf_proto *tp,
9fb9f251 JP	191	struct nlattr nla, struct nlattr est,
aea0d727	192	char *name, int ovr, int bind,
789871bb	193	bool rtnl_held,
aea0d727	194	struct netlink_ext_ack *extack);
90b73b77 VB	195	int tcf_action_dump(struct sk_buff skb, struct tc_action actions[], int bind,
90b73b77 VB	196	int ref);
5c15257f JP	197	int tcf_action_dump_old(struct sk_buff skb, struct tc_action a, int, int);
5c15257f JP	198	int tcf_action_dump_1(struct sk_buff skb, struct tc_action a, int, int);
5e1ad95b VB	199
	200	static inline void tcf_action_update_bstats(struct tc_action *a,
	201	struct sk_buff *skb)
	202	{
5e174d5e VB	203	if (likely(a->cpu_bstats)) {
	204	bstats_cpu_update(this_cpu_ptr(a->cpu_bstats), skb);
	205	return;
	206	}
	207	spin_lock(&a->tcfa_lock);
	208	bstats_update(&a->tcfa_bstats, skb);
	209	spin_unlock(&a->tcfa_lock);
26b537a8 VB	210	}
	211
	212	static inline void tcf_action_inc_drop_qstats(struct tc_action *a)
	213	{
5e174d5e VB	214	if (likely(a->cpu_qstats)) {
	215	qstats_drop_inc(this_cpu_ptr(a->cpu_qstats));
	216	return;
	217	}
	218	spin_lock(&a->tcfa_lock);
	219	qstats_drop_inc(&a->tcfa_qstats);
	220	spin_unlock(&a->tcfa_lock);
26b537a8 VB	221	}
	222
	223	static inline void tcf_action_inc_overlimit_qstats(struct tc_action *a)
	224	{
5e174d5e VB	225	if (likely(a->cpu_qstats)) {
	226	qstats_overlimit_inc(this_cpu_ptr(a->cpu_qstats));
	227	return;
	228	}
	229	spin_lock(&a->tcfa_lock);
	230	qstats_overlimit_inc(&a->tcfa_qstats);
	231	spin_unlock(&a->tcfa_lock);
26b537a8 VB	232	}
26b537a8 VB	233
c8ecebd0 VB	234	void tcf_action_update_stats(struct tc_action *a, u64 bytes, u32 packets,
c8ecebd0 VB	235	bool drop, bool hw);
5c15257f	236	int tcf_action_copy_stats(struct sk_buff , struct tc_action , int);
00175aec	237
85d0966f DC	238	int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
	239	struct tcf_chain **handle,
	240	struct netlink_ext_ack *newchain);
	241	struct tcf_chain tcf_action_set_ctrlact(struct tc_action a, int action,
	242	struct tcf_chain *newchain);
2734437e	243	#endif /* CONFIG_NET_CLS_ACT */
86cb13e4	244
38040702	245	static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
28169aba	246	u64 packets, u64 lastuse, bool hw)
38040702	247	{
2734437e	248	#ifdef CONFIG_NET_CLS_ACT
38040702 AV	249	if (!a->ops->stats_update)
	250	return;
	251
28169aba	252	a->ops->stats_update(a, bytes, packets, lastuse, hw);
2734437e	253	#endif
38040702 AV	254	}
38040702 AV	255
b3f55bdd	256
1da177e4	257	#endif