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