[linux-block.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 {
	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;
	refcount_t			tcfa_refcnt;
	atomic_t			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	__rcu *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 *); /* 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,
			  struct netlink_ext_ack *extack);
	int     (*init)(struct net *net, struct nlattr *nla,
			struct nlattr *est, struct tc_action **act, int ovr,
			int bind, bool rtnl_held,
			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);
	size_t  (*get_fill_size)(const struct tc_action *act);
	struct net_device *(*get_dev)(const struct tc_action *a);
	void	(*put_dev)(struct net_device *dev);
	int     (*delete)(struct net *net, u32 index);
};

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,
		       struct netlink_ext_ack *extack);
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_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_delete_index(struct tc_action_net *tn, u32 index);
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);
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
}

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