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