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