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