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