[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 <net/sch_generic.h>
#include <net/pkt_sched.h>
#include <net/net_namespace.h>
#include <net/netns/generic.h>

struct tcf_idrinfo {
	spinlock_t	lock;
	struct idr	action_idr;
};

struct tc_action_ops;

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

	u32				tcfa_index;
	int				tcfa_refcnt;
	int				tcfa_bindcnt;
	u32				tcfa_capab;
	int				tcfa_action;
	struct tcf_t			tcfa_tm;
	struct gnet_stats_basic_packed	tcfa_bstats;
	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_queue __percpu *cpu_qstats;
	struct tc_cookie	*act_cookie;
	struct tcf_chain	*goto_chain;
};
#define tcf_index	common.tcfa_index
#define tcf_refcnt	common.tcfa_refcnt
#define tcf_bindcnt	common.tcfa_bindcnt
#define tcf_capab	common.tcfa_capab
#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

/* 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

struct tc_action_ops {
	struct list_head head;
	char    kind[IFNAMSIZ];
	__u32   type; /* TBD to match kind */
	size_t	size;
	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     (*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, struct netlink_ext_ack *extack);
	int     (*walk)(struct net *, struct sk_buff *,
			struct netlink_callback *, int,
			const struct tc_action_ops *);
	void	(*stats_update)(struct tc_action *, u64, u32, u64);
	struct net_device *(*get_dev)(const struct tc_action *a);
};

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

static inline
int tc_action_net_init(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;
	spin_lock_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);
int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
		    int bind);
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);
void tcf_idr_cleanup(struct tc_action *a, struct nlattr *est);
void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);

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 list_head *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 list_head *actions, 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,
				    struct netlink_ext_ack *extack);
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);

#endif /* CONFIG_NET_CLS_ACT */

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

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

typedef int tc_setup_cb_t(enum tc_setup_type type,
			  void *type_data, void *cb_priv);

#ifdef CONFIG_NET_CLS_ACT
int tc_setup_cb_egdev_register(const struct net_device *dev,
			       tc_setup_cb_t *cb, void *cb_priv);
void tc_setup_cb_egdev_unregister(const struct net_device *dev,
				  tc_setup_cb_t *cb, void *cb_priv);
int tc_setup_cb_egdev_call(const struct net_device *dev,
			   enum tc_setup_type type, void *type_data,
			   bool err_stop);
#else
static inline
int tc_setup_cb_egdev_register(const struct net_device *dev,
			       tc_setup_cb_t *cb, void *cb_priv)
{
	return 0;
}

static inline
void tc_setup_cb_egdev_unregister(const struct net_device *dev,
				  tc_setup_cb_t *cb, void *cb_priv)
{
}

static inline
int tc_setup_cb_egdev_call(const struct net_device *dev,
			   enum tc_setup_type type, void *type_data,
			   bool err_stop)
{
	return 0;
}
#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 LT	8
	9	#include <net/sch_generic.h>
	10	#include <net/pkt_sched.h>
ddf97ccd WC	11	#include <net/net_namespace.h>
ddf97ccd WC	12	#include <net/netns/generic.h>
1da177e4	13
65a206c0 CM	14	struct tcf_idrinfo {
	15	spinlock_t lock;
	16	struct idr action_idr;
a85a970a WC	17	};
	18
	19	struct tc_action_ops;
	20
	21	struct tc_action {
	22	const struct tc_action_ops *ops;
ec0595cc WC	23	__u32 type; /* for backward compat(TCA_OLD_COMPAT) */
	24	__u32 order;
	25	struct list_head list;
65a206c0	26	struct tcf_idrinfo *idrinfo;
a85a970a	27
ec0595cc WC	28	u32 tcfa_index;
	29	int tcfa_refcnt;
	30	int tcfa_bindcnt;
	31	u32 tcfa_capab;
	32	int tcfa_action;
	33	struct tcf_t tcfa_tm;
	34	struct gnet_stats_basic_packed tcfa_bstats;
	35	struct gnet_stats_queue tcfa_qstats;
1c0d32fd	36	struct net_rate_estimator __rcu *tcfa_rate_est;
ec0595cc	37	spinlock_t tcfa_lock;
519c818e ED	38	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
519c818e ED	39	struct gnet_stats_queue __percpu *cpu_qstats;
1045ba77	40	struct tc_cookie *act_cookie;
db50514f	41	struct tcf_chain *goto_chain;
e9ce1cd3	42	};
ec0595cc WC	43	#define tcf_index common.tcfa_index
	44	#define tcf_refcnt common.tcfa_refcnt
	45	#define tcf_bindcnt common.tcfa_bindcnt
	46	#define tcf_capab common.tcfa_capab
	47	#define tcf_action common.tcfa_action
	48	#define tcf_tm common.tcfa_tm
	49	#define tcf_bstats common.tcfa_bstats
	50	#define tcf_qstats common.tcfa_qstats
	51	#define tcf_rate_est common.tcfa_rate_est
	52	#define tcf_lock common.tcfa_lock
e9ce1cd3	53
56e5d1ca ED	54	/* Update lastuse only if needed, to avoid dirtying a cache line.
	55	* We use a temp variable to avoid fetching jiffies twice.
	56	*/
	57	static inline void tcf_lastuse_update(struct tcf_t *tm)
	58	{
	59	unsigned long now = jiffies;
	60
	61	if (tm->lastuse != now)
	62	tm->lastuse = now;
53eb440f JHS	63	if (unlikely(!tm->firstuse))
53eb440f JHS	64	tm->firstuse = now;
56e5d1ca ED	65	}
56e5d1ca ED	66
48d8ee16 JHS	67	static inline void tcf_tm_dump(struct tcf_t dtm, const struct tcf_t stm)
	68	{
	69	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
	70	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
	71	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
	72	dtm->expires = jiffies_to_clock_t(stm->expires);
	73	}
	74
00175aec AV	75	#ifdef CONFIG_NET_CLS_ACT
	76
	77	#define ACT_P_CREATED 1
	78	#define ACT_P_DELETED 1
	79
e9ce1cd3	80	struct tc_action_ops {
1f747c26	81	struct list_head head;
1da177e4 LT	82	char kind[IFNAMSIZ];
1da177e4 LT	83	__u32 type; /* TBD to match kind */
a85a970a	84	size_t size;
1da177e4	85	struct module *owner;
0b0f43fe JHS	86	int (act)(struct sk_buff , const struct tc_action *,
0b0f43fe JHS	87	struct tcf_result *);
e9ce1cd3	88	int (dump)(struct sk_buff , struct tc_action *, int, int);
9a63b255	89	void (cleanup)(struct tc_action );
1af85155	90	int (lookup)(struct net net, struct tc_action **a, u32 index);
c1b52739	91	int (init)(struct net net, struct nlattr *nla,
a85a970a	92	struct nlattr est, struct tc_action *act, int ovr,
589dad6d	93	int bind, struct netlink_ext_ack *extack);
ddf97ccd	94	int (walk)(struct net , struct sk_buff *,
1af85155 AA	95	struct netlink_callback *, int,
1af85155 AA	96	const struct tc_action_ops *);
38040702	97	void (stats_update)(struct tc_action , u64, u32, u64);
843e79d0	98	struct net_device (get_dev)(const struct tc_action *a);
ddf97ccd WC	99	};
	100
	101	struct tc_action_net {
65a206c0	102	struct tcf_idrinfo *idrinfo;
ddf97ccd	103	const struct tc_action_ops *ops;
1da177e4 LT	104	};
1da177e4 LT	105
ddf97ccd	106	static inline
0b0f43fe	107	int tc_action_net_init(struct tc_action_net *tn,
c7e460ce	108	const struct tc_action_ops *ops)
ddf97ccd WC	109	{
	110	int err = 0;
	111
65a206c0 CM	112	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
65a206c0 CM	113	if (!tn->idrinfo)
ddf97ccd WC	114	return -ENOMEM;
ddf97ccd WC	115	tn->ops = ops;
65a206c0 CM	116	spin_lock_init(&tn->idrinfo->lock);
65a206c0 CM	117	idr_init(&tn->idrinfo->action_idr);
ddf97ccd WC	118	return err;
	119	}
	120
65a206c0 CM	121	void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
65a206c0 CM	122	struct tcf_idrinfo *idrinfo);
ddf97ccd	123
039af9c6 CW	124	static inline void tc_action_net_exit(struct list_head *net_list,
039af9c6 CW	125	unsigned int id)
ddf97ccd	126	{
039af9c6 CW	127	struct net *net;
039af9c6 CW	128
a159d3c4	129	rtnl_lock();
039af9c6 CW	130	list_for_each_entry(net, net_list, exit_list) {
	131	struct tc_action_net *tn = net_generic(net, id);
	132
	133	tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
	134	kfree(tn->idrinfo);
	135	}
a159d3c4	136	rtnl_unlock();
ddf97ccd WC	137	}
	138
	139	int tcf_generic_walker(struct tc_action_net tn, struct sk_buff skb,
	140	struct netlink_callback *cb, int type,
a85a970a	141	const struct tc_action_ops *ops);
65a206c0 CM	142	int tcf_idr_search(struct tc_action_net tn, struct tc_action *a, u32 index);
65a206c0 CM	143	bool tcf_idr_check(struct tc_action_net tn, u32 index, struct tc_action *a,
b2313077	144	int bind);
65a206c0 CM	145	int tcf_idr_create(struct tc_action_net tn, u32 index, struct nlattr est,
	146	struct tc_action *a, const struct tc_action_ops ops,
	147	int bind, bool cpustats);
	148	void tcf_idr_cleanup(struct tc_action a, struct nlattr est);
	149	void tcf_idr_insert(struct tc_action_net tn, struct tc_action a);
e9ce1cd3	150
65a206c0	151	int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
28e6b67f	152
65a206c0	153	static inline int tcf_idr_release(struct tc_action *a, bool bind)
28e6b67f	154	{
65a206c0	155	return __tcf_idr_release(a, bind, false);
28e6b67f DB	156	}
28e6b67f DB	157
ddf97ccd	158	int tcf_register_action(struct tc_action_ops a, struct pernet_operations ops);
0b0f43fe JHS	159	int tcf_unregister_action(struct tc_action_ops *a,
0b0f43fe JHS	160	struct pernet_operations *ops);
55334a5d	161	int tcf_action_destroy(struct list_head *actions, int bind);
22dc13c8 WC	162	int tcf_action_exec(struct sk_buff skb, struct tc_action *actions,
22dc13c8 WC	163	int nr_actions, struct tcf_result *res);
9fb9f251 JP	164	int tcf_action_init(struct net net, struct tcf_proto tp, struct nlattr *nla,
9fb9f251 JP	165	struct nlattr est, char name, int ovr, int bind,
aea0d727	166	struct list_head actions, struct netlink_ext_ack extack);
9fb9f251 JP	167	struct tc_action tcf_action_init_1(struct net net, struct tcf_proto *tp,
9fb9f251 JP	168	struct nlattr nla, struct nlattr est,
aea0d727 AA	169	char *name, int ovr, int bind,
aea0d727 AA	170	struct netlink_ext_ack *extack);
33be6271	171	int tcf_action_dump(struct sk_buff skb, struct list_head , int, int);
5c15257f JP	172	int tcf_action_dump_old(struct sk_buff skb, struct tc_action a, int, int);
	173	int tcf_action_dump_1(struct sk_buff skb, struct tc_action a, int, int);
	174	int tcf_action_copy_stats(struct sk_buff , struct tc_action , int);
00175aec	175
2734437e	176	#endif /* CONFIG_NET_CLS_ACT */
86cb13e4	177
38040702 AV	178	static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
	179	u64 packets, u64 lastuse)
	180	{
2734437e	181	#ifdef CONFIG_NET_CLS_ACT
38040702 AV	182	if (!a->ops->stats_update)
	183	return;
	184
	185	a->ops->stats_update(a, bytes, packets, lastuse);
2734437e	186	#endif
38040702 AV	187	}
38040702 AV	188
b3f55bdd JP	189	typedef int tc_setup_cb_t(enum tc_setup_type type,
	190	void type_data, void cb_priv);
	191
	192	#ifdef CONFIG_NET_CLS_ACT
	193	int tc_setup_cb_egdev_register(const struct net_device *dev,
	194	tc_setup_cb_t cb, void cb_priv);
	195	void tc_setup_cb_egdev_unregister(const struct net_device *dev,
	196	tc_setup_cb_t cb, void cb_priv);
	197	int tc_setup_cb_egdev_call(const struct net_device *dev,
	198	enum tc_setup_type type, void *type_data,
	199	bool err_stop);
	200	#else
	201	static inline
	202	int tc_setup_cb_egdev_register(const struct net_device *dev,
	203	tc_setup_cb_t cb, void cb_priv)
	204	{
	205	return 0;
	206	}
	207
	208	static inline
	209	void tc_setup_cb_egdev_unregister(const struct net_device *dev,
	210	tc_setup_cb_t cb, void cb_priv)
	211	{
	212	}
	213
	214	static inline
	215	int tc_setup_cb_egdev_call(const struct net_device *dev,
	216	enum tc_setup_type type, void *type_data,
	217	bool err_stop)
	218	{
	219	return 0;
	220	}
	221	#endif
	222
1da177e4	223	#endif