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