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