xref: /linux/include/net/act_api.h (revision 636cc3bd12f499c74eaf5dc9a7d5b832f1bb24ed)
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/flow_offload.h>
11 #include <net/sch_generic.h>
12 #include <net/pkt_sched.h>
13 #include <net/net_namespace.h>
14 #include <net/netns/generic.h>
15 
16 struct tcf_idrinfo {
17 	struct mutex	lock;
18 	struct idr	action_idr;
19 	struct net	*net;
20 };
21 
22 struct tc_action_ops;
23 
24 struct tc_action {
25 	const struct tc_action_ops	*ops;
26 	__u32				type; /* for backward compat(TCA_OLD_COMPAT) */
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_sync	tcfa_bstats;
35 	struct gnet_stats_basic_sync	tcfa_bstats_hw;
36 
37 	atomic_t			tcfa_drops;
38 	atomic_t			tcfa_overlimits;
39 
40 	struct net_rate_estimator __rcu *tcfa_rate_est;
41 	spinlock_t			tcfa_lock;
42 	struct gnet_stats_basic_sync __percpu *cpu_bstats;
43 	struct gnet_stats_basic_sync __percpu *cpu_bstats_hw;
44 	struct gnet_stats_queue __percpu *cpu_qstats;
45 	struct tc_cookie	__rcu *user_cookie;
46 	struct tcf_chain	__rcu *goto_chain;
47 	u32			tcfa_flags;
48 	u8			hw_stats;
49 	u8			used_hw_stats;
50 	bool			used_hw_stats_valid;
51 	u32			in_hw_count;
52 };
53 #define tcf_index	common.tcfa_index
54 #define tcf_refcnt	common.tcfa_refcnt
55 #define tcf_bindcnt	common.tcfa_bindcnt
56 #define tcf_action	common.tcfa_action
57 #define tcf_tm		common.tcfa_tm
58 #define tcf_bstats	common.tcfa_bstats
59 #define tcf_rate_est	common.tcfa_rate_est
60 #define tcf_lock	common.tcfa_lock
61 
62 #define TCA_ACT_HW_STATS_ANY (TCA_ACT_HW_STATS_IMMEDIATE | \
63 			      TCA_ACT_HW_STATS_DELAYED)
64 
65 /* Reserve 16 bits for user-space. See TCA_ACT_FLAGS_NO_PERCPU_STATS. */
66 #define TCA_ACT_FLAGS_USER_BITS 16
67 #define TCA_ACT_FLAGS_USER_MASK 0xffff
68 #define TCA_ACT_FLAGS_POLICE	(1U << TCA_ACT_FLAGS_USER_BITS)
69 #define TCA_ACT_FLAGS_BIND	(1U << (TCA_ACT_FLAGS_USER_BITS + 1))
70 #define TCA_ACT_FLAGS_REPLACE	(1U << (TCA_ACT_FLAGS_USER_BITS + 2))
71 #define TCA_ACT_FLAGS_NO_RTNL	(1U << (TCA_ACT_FLAGS_USER_BITS + 3))
72 #define TCA_ACT_FLAGS_AT_INGRESS	(1U << (TCA_ACT_FLAGS_USER_BITS + 4))
73 #define TCA_ACT_FLAGS_AT_INGRESS_OR_CLSACT	(1U << (TCA_ACT_FLAGS_USER_BITS + 5))
74 
75 /* Update lastuse only if needed, to avoid dirtying a cache line.
76  * We use a temp variable to avoid fetching jiffies twice.
77  */
78 static inline void tcf_lastuse_update(struct tcf_t *tm)
79 {
80 	unsigned long now = jiffies;
81 
82 	if (READ_ONCE(tm->lastuse) != now)
83 		WRITE_ONCE(tm->lastuse, now);
84 	if (unlikely(!READ_ONCE(tm->firstuse)))
85 		WRITE_ONCE(tm->firstuse, now);
86 }
87 
88 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
89 {
90 	unsigned long firstuse, now = jiffies;
91 
92 	dtm->install = jiffies_to_clock_t(now - READ_ONCE(stm->install));
93 	dtm->lastuse = jiffies_to_clock_t(now - READ_ONCE(stm->lastuse));
94 
95 	firstuse = READ_ONCE(stm->firstuse);
96 	dtm->firstuse = firstuse ?
97 		jiffies_to_clock_t(now - firstuse) : 0;
98 
99 	dtm->expires = jiffies_to_clock_t(READ_ONCE(stm->expires));
100 }
101 
102 static inline enum flow_action_hw_stats tc_act_hw_stats(u8 hw_stats)
103 {
104 	if (WARN_ON_ONCE(hw_stats > TCA_ACT_HW_STATS_ANY))
105 		return FLOW_ACTION_HW_STATS_DONT_CARE;
106 	else if (!hw_stats)
107 		return FLOW_ACTION_HW_STATS_DISABLED;
108 
109 	return hw_stats;
110 }
111 
112 typedef void (*tc_action_priv_destructor)(void *priv);
113 
114 struct tc_action_ops {
115 	struct list_head head;
116 	char    kind[IFNAMSIZ];
117 	enum tca_id  id; /* identifier should match kind */
118 	unsigned int	net_id;
119 	size_t	size;
120 	struct module		*owner;
121 	int     (*act)(struct sk_buff *, const struct tc_action *,
122 		       struct tcf_result *); /* called under RCU BH lock*/
123 	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
124 	void	(*cleanup)(struct tc_action *);
125 	int     (*lookup)(struct net *net, struct tc_action **a, u32 index);
126 	int     (*init)(struct net *net, struct nlattr *nla,
127 			struct nlattr *est, struct tc_action **act,
128 			struct tcf_proto *tp,
129 			u32 flags, struct netlink_ext_ack *extack);
130 	int     (*walk)(struct net *, struct sk_buff *,
131 			struct netlink_callback *, int,
132 			const struct tc_action_ops *,
133 			struct netlink_ext_ack *);
134 	void	(*stats_update)(struct tc_action *, u64, u64, u64, u64, bool);
135 	size_t  (*get_fill_size)(const struct tc_action *act);
136 	struct net_device *(*get_dev)(const struct tc_action *a,
137 				      tc_action_priv_destructor *destructor);
138 	struct psample_group *
139 	(*get_psample_group)(const struct tc_action *a,
140 			     tc_action_priv_destructor *destructor);
141 	int     (*offload_act_setup)(struct tc_action *act, void *entry_data,
142 				     u32 *index_inc, bool bind,
143 				     struct netlink_ext_ack *extack);
144 };
145 
146 #ifdef CONFIG_NET_CLS_ACT
147 
148 #define ACT_P_BOUND 0
149 #define ACT_P_CREATED 1
150 #define ACT_P_DELETED 1
151 
152 struct tc_action_net {
153 	struct tcf_idrinfo *idrinfo;
154 	const struct tc_action_ops *ops;
155 };
156 
157 static inline
158 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
159 		       const struct tc_action_ops *ops)
160 {
161 	int err = 0;
162 
163 	tn->idrinfo = kmalloc_obj(*tn->idrinfo);
164 	if (!tn->idrinfo)
165 		return -ENOMEM;
166 	tn->ops = ops;
167 	tn->idrinfo->net = net;
168 	mutex_init(&tn->idrinfo->lock);
169 	idr_init(&tn->idrinfo->action_idr);
170 	return err;
171 }
172 
173 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
174 			 struct tcf_idrinfo *idrinfo);
175 
176 static inline void tc_action_net_exit(struct list_head *net_list,
177 				      unsigned int id)
178 {
179 	struct net *net;
180 
181 	list_for_each_entry(net, net_list, exit_list) {
182 		struct tc_action_net *tn = net_generic(net, id);
183 
184 		tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
185 		kfree(tn->idrinfo);
186 	}
187 }
188 
189 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
190 		       struct netlink_callback *cb, int type,
191 		       const struct tc_action_ops *ops,
192 		       struct netlink_ext_ack *extack);
193 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
194 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
195 		   struct tc_action **a, const struct tc_action_ops *ops,
196 		   int bind, bool cpustats, u32 flags);
197 int tcf_idr_create_from_flags(struct tc_action_net *tn, u32 index,
198 			      struct nlattr *est, struct tc_action **a,
199 			      const struct tc_action_ops *ops, int bind,
200 			      u32 flags);
201 void tcf_idr_insert_many(struct tc_action *actions[], int init_res[]);
202 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
203 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
204 			struct tc_action **a, int bind);
205 int tcf_idr_release(struct tc_action *a, bool bind);
206 
207 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
208 int tcf_unregister_action(struct tc_action_ops *a,
209 			  struct pernet_operations *ops);
210 #define NET_ACT_ALIAS_PREFIX "net-act-"
211 #define MODULE_ALIAS_NET_ACT(kind)	MODULE_ALIAS(NET_ACT_ALIAS_PREFIX kind)
212 int tcf_action_destroy(struct tc_action *actions[], int bind);
213 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
214 		    int nr_actions, struct tcf_result *res);
215 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
216 		    struct nlattr *est,
217 		    struct tc_action *actions[], int init_res[], size_t *attr_size,
218 		    u32 flags, u32 fl_flags, struct netlink_ext_ack *extack);
219 struct tc_action_ops *tc_action_load_ops(struct nlattr *nla, u32 flags,
220 					 struct netlink_ext_ack *extack);
221 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
222 				    struct nlattr *nla, struct nlattr *est,
223 				    struct tc_action_ops *a_o, int *init_res,
224 				    u32 flags, struct netlink_ext_ack *extack);
225 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
226 		    int ref, bool terse);
227 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
228 
229 static inline void tcf_action_update_bstats(struct tc_action *a,
230 					    struct sk_buff *skb)
231 {
232 	if (likely(a->cpu_bstats)) {
233 		bstats_update(this_cpu_ptr(a->cpu_bstats), skb);
234 		return;
235 	}
236 	spin_lock(&a->tcfa_lock);
237 	bstats_update(&a->tcfa_bstats, skb);
238 	spin_unlock(&a->tcfa_lock);
239 }
240 
241 static inline void tcf_action_inc_drop_qstats(struct tc_action *a)
242 {
243 	if (likely(a->cpu_qstats)) {
244 		qstats_drop_inc(this_cpu_ptr(a->cpu_qstats));
245 		return;
246 	}
247 	atomic_inc(&a->tcfa_drops);
248 }
249 
250 static inline void tcf_action_inc_overlimit_qstats(struct tc_action *a)
251 {
252 	if (likely(a->cpu_qstats)) {
253 		qstats_overlimit_inc(this_cpu_ptr(a->cpu_qstats));
254 		return;
255 	}
256 	atomic_inc(&a->tcfa_overlimits);
257 }
258 
259 void tcf_action_update_stats(struct tc_action *a, u64 bytes, u64 packets,
260 			     u64 drops, bool hw);
261 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
262 
263 int tcf_action_update_hw_stats(struct tc_action *action);
264 int tcf_action_reoffload_cb(flow_indr_block_bind_cb_t *cb,
265 			    void *cb_priv, bool add);
266 int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
267 			     struct tcf_chain **handle,
268 			     struct netlink_ext_ack *newchain);
269 struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
270 					 struct tcf_chain *newchain);
271 
272 #ifdef CONFIG_INET
273 DECLARE_STATIC_KEY_FALSE(tcf_frag_xmit_count);
274 #endif
275 
276 int tcf_dev_queue_xmit(struct sk_buff *skb, int (*xmit)(struct sk_buff *skb));
277 
278 #else /* !CONFIG_NET_CLS_ACT */
279 
280 static inline int tcf_action_reoffload_cb(flow_indr_block_bind_cb_t *cb,
281 					  void *cb_priv, bool add) {
282 	return 0;
283 }
284 
285 #endif /* CONFIG_NET_CLS_ACT */
286 
287 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
288 					   u64 packets, u64 drops,
289 					   u64 lastuse, bool hw)
290 {
291 #ifdef CONFIG_NET_CLS_ACT
292 	if (!a->ops->stats_update)
293 		return;
294 
295 	a->ops->stats_update(a, bytes, packets, drops, lastuse, hw);
296 #endif
297 }
298 
299 
300 #endif
301