1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NET_ACT_API_H
3 #define __NET_ACT_API_H
6 * Public action API for classifiers/qdiscs
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>
18 struct idr action_idr;
25 const struct tc_action_ops *ops;
26 __u32 type; /* for backward compat(TCA_OLD_COMPAT) */
27 struct tcf_idrinfo *idrinfo;
30 refcount_t tcfa_refcnt;
31 atomic_t tcfa_bindcnt;
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;
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;
47 bool used_hw_stats_valid;
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
60 #define TCA_ACT_HW_STATS_ANY (TCA_ACT_HW_STATS_IMMEDIATE | \
61 TCA_ACT_HW_STATS_DELAYED)
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))
71 /* Update lastuse only if needed, to avoid dirtying a cache line.
72 * We use a temp variable to avoid fetching jiffies twice.
74 static inline void tcf_lastuse_update(struct tcf_t *tm)
76 unsigned long now = jiffies;
78 if (tm->lastuse != now)
80 if (unlikely(!tm->firstuse))
84 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
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);
93 static inline enum flow_action_hw_stats tc_act_hw_stats(u8 hw_stats)
95 if (WARN_ON_ONCE(hw_stats > TCA_ACT_HW_STATS_ANY))
96 return FLOW_ACTION_HW_STATS_DONT_CARE;
98 return FLOW_ACTION_HW_STATS_DISABLED;
103 #ifdef CONFIG_NET_CLS_ACT
105 #define ACT_P_CREATED 1
106 #define ACT_P_DELETED 1
108 typedef void (*tc_action_priv_destructor)(void *priv);
110 struct tc_action_ops {
111 struct list_head head;
113 enum tca_id id; /* identifier should match kind */
116 struct module *owner;
117 int (*act)(struct sk_buff *, const struct tc_action *,
118 struct tcf_result *); /* called under RCU BH lock*/
119 int (*dump)(struct sk_buff *, struct tc_action *, int, int);
120 void (*cleanup)(struct tc_action *);
121 int (*lookup)(struct net *net, struct tc_action **a, u32 index);
122 int (*init)(struct net *net, struct nlattr *nla,
123 struct nlattr *est, struct tc_action **act,
124 struct tcf_proto *tp,
125 u32 flags, struct netlink_ext_ack *extack);
126 int (*walk)(struct net *, struct sk_buff *,
127 struct netlink_callback *, int,
128 const struct tc_action_ops *,
129 struct netlink_ext_ack *);
130 void (*stats_update)(struct tc_action *, u64, u64, u64, u64, bool);
131 size_t (*get_fill_size)(const struct tc_action *act);
132 struct net_device *(*get_dev)(const struct tc_action *a,
133 tc_action_priv_destructor *destructor);
134 struct psample_group *
135 (*get_psample_group)(const struct tc_action *a,
136 tc_action_priv_destructor *destructor);
137 int (*offload_act_setup)(struct tc_action *act, void *entry_data,
138 u32 *index_inc, bool bind,
139 struct netlink_ext_ack *extack);
142 struct tc_action_net {
143 struct tcf_idrinfo *idrinfo;
144 const struct tc_action_ops *ops;
148 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
149 const struct tc_action_ops *ops)
153 tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
157 tn->idrinfo->net = net;
158 mutex_init(&tn->idrinfo->lock);
159 idr_init(&tn->idrinfo->action_idr);
163 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
164 struct tcf_idrinfo *idrinfo);
166 static inline void tc_action_net_exit(struct list_head *net_list,
172 list_for_each_entry(net, net_list, exit_list) {
173 struct tc_action_net *tn = net_generic(net, id);
175 tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
181 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
182 struct netlink_callback *cb, int type,
183 const struct tc_action_ops *ops,
184 struct netlink_ext_ack *extack);
185 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
186 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
187 struct tc_action **a, const struct tc_action_ops *ops,
188 int bind, bool cpustats, u32 flags);
189 int tcf_idr_create_from_flags(struct tc_action_net *tn, u32 index,
190 struct nlattr *est, struct tc_action **a,
191 const struct tc_action_ops *ops, int bind,
193 void tcf_idr_insert_many(struct tc_action *actions[]);
194 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
195 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
196 struct tc_action **a, int bind);
197 int tcf_idr_release(struct tc_action *a, bool bind);
199 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
200 int tcf_unregister_action(struct tc_action_ops *a,
201 struct pernet_operations *ops);
202 int tcf_action_destroy(struct tc_action *actions[], int bind);
203 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
204 int nr_actions, struct tcf_result *res);
205 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
207 struct tc_action *actions[], int init_res[], size_t *attr_size,
208 u32 flags, u32 fl_flags, struct netlink_ext_ack *extack);
209 struct tc_action_ops *tc_action_load_ops(struct nlattr *nla, bool police,
211 struct netlink_ext_ack *extack);
212 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
213 struct nlattr *nla, struct nlattr *est,
214 struct tc_action_ops *a_o, int *init_res,
215 u32 flags, struct netlink_ext_ack *extack);
216 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
217 int ref, bool terse);
218 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
219 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
221 static inline void tcf_action_update_bstats(struct tc_action *a,
224 if (likely(a->cpu_bstats)) {
225 bstats_update(this_cpu_ptr(a->cpu_bstats), skb);
228 spin_lock(&a->tcfa_lock);
229 bstats_update(&a->tcfa_bstats, skb);
230 spin_unlock(&a->tcfa_lock);
233 static inline void tcf_action_inc_drop_qstats(struct tc_action *a)
235 if (likely(a->cpu_qstats)) {
236 qstats_drop_inc(this_cpu_ptr(a->cpu_qstats));
239 spin_lock(&a->tcfa_lock);
240 qstats_drop_inc(&a->tcfa_qstats);
241 spin_unlock(&a->tcfa_lock);
244 static inline void tcf_action_inc_overlimit_qstats(struct tc_action *a)
246 if (likely(a->cpu_qstats)) {
247 qstats_overlimit_inc(this_cpu_ptr(a->cpu_qstats));
250 spin_lock(&a->tcfa_lock);
251 qstats_overlimit_inc(&a->tcfa_qstats);
252 spin_unlock(&a->tcfa_lock);
255 void tcf_action_update_stats(struct tc_action *a, u64 bytes, u64 packets,
257 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
259 int tcf_action_update_hw_stats(struct tc_action *action);
260 int tcf_action_reoffload_cb(flow_indr_block_bind_cb_t *cb,
261 void *cb_priv, bool add);
262 int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
263 struct tcf_chain **handle,
264 struct netlink_ext_ack *newchain);
265 struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
266 struct tcf_chain *newchain);
269 DECLARE_STATIC_KEY_FALSE(tcf_frag_xmit_count);
272 int tcf_dev_queue_xmit(struct sk_buff *skb, int (*xmit)(struct sk_buff *skb));
274 #else /* !CONFIG_NET_CLS_ACT */
276 static inline int tcf_action_reoffload_cb(flow_indr_block_bind_cb_t *cb,
277 void *cb_priv, bool add) {
281 #endif /* CONFIG_NET_CLS_ACT */
283 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
284 u64 packets, u64 drops,
285 u64 lastuse, bool hw)
287 #ifdef CONFIG_NET_CLS_ACT
288 if (!a->ops->stats_update)
291 a->ops->stats_update(a, bytes, packets, drops, lastuse, hw);