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