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