xref: /linux/include/net/act_api.h (revision fd639726bf15fca8ee1a00dce8e0096d0ad9bd18)
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 <net/sch_generic.h>
10 #include <net/pkt_sched.h>
11 #include <net/net_namespace.h>
12 #include <net/netns/generic.h>
13 
14 struct tcf_idrinfo {
15 	spinlock_t	lock;
16 	struct idr	action_idr;
17 };
18 
19 struct tc_action_ops;
20 
21 struct tc_action {
22 	const struct tc_action_ops	*ops;
23 	__u32				type; /* for backward compat(TCA_OLD_COMPAT) */
24 	__u32				order;
25 	struct list_head		list;
26 	struct tcf_idrinfo		*idrinfo;
27 
28 	u32				tcfa_index;
29 	int				tcfa_refcnt;
30 	int				tcfa_bindcnt;
31 	u32				tcfa_capab;
32 	int				tcfa_action;
33 	struct tcf_t			tcfa_tm;
34 	struct gnet_stats_basic_packed	tcfa_bstats;
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_queue __percpu *cpu_qstats;
40 	struct tc_cookie	*act_cookie;
41 	struct tcf_chain	*goto_chain;
42 };
43 #define tcf_index	common.tcfa_index
44 #define tcf_refcnt	common.tcfa_refcnt
45 #define tcf_bindcnt	common.tcfa_bindcnt
46 #define tcf_capab	common.tcfa_capab
47 #define tcf_action	common.tcfa_action
48 #define tcf_tm		common.tcfa_tm
49 #define tcf_bstats	common.tcfa_bstats
50 #define tcf_qstats	common.tcfa_qstats
51 #define tcf_rate_est	common.tcfa_rate_est
52 #define tcf_lock	common.tcfa_lock
53 
54 /* Update lastuse only if needed, to avoid dirtying a cache line.
55  * We use a temp variable to avoid fetching jiffies twice.
56  */
57 static inline void tcf_lastuse_update(struct tcf_t *tm)
58 {
59 	unsigned long now = jiffies;
60 
61 	if (tm->lastuse != now)
62 		tm->lastuse = now;
63 	if (unlikely(!tm->firstuse))
64 		tm->firstuse = now;
65 }
66 
67 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
68 {
69 	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
70 	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
71 	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
72 	dtm->expires = jiffies_to_clock_t(stm->expires);
73 }
74 
75 #ifdef CONFIG_NET_CLS_ACT
76 
77 #define ACT_P_CREATED 1
78 #define ACT_P_DELETED 1
79 
80 struct tc_action_ops {
81 	struct list_head head;
82 	char    kind[IFNAMSIZ];
83 	__u32   type; /* TBD to match kind */
84 	size_t	size;
85 	struct module		*owner;
86 	int     (*act)(struct sk_buff *, const struct tc_action *,
87 		       struct tcf_result *);
88 	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
89 	void	(*cleanup)(struct tc_action *, int bind);
90 	int     (*lookup)(struct net *, struct tc_action **, u32);
91 	int     (*init)(struct net *net, struct nlattr *nla,
92 			struct nlattr *est, struct tc_action **act, int ovr,
93 			int bind);
94 	int     (*walk)(struct net *, struct sk_buff *,
95 			struct netlink_callback *, int, const struct tc_action_ops *);
96 	void	(*stats_update)(struct tc_action *, u64, u32, u64);
97 	struct net_device *(*get_dev)(const struct tc_action *a);
98 };
99 
100 struct tc_action_net {
101 	struct tcf_idrinfo *idrinfo;
102 	const struct tc_action_ops *ops;
103 };
104 
105 static inline
106 int tc_action_net_init(struct tc_action_net *tn,
107 		       const struct tc_action_ops *ops)
108 {
109 	int err = 0;
110 
111 	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
112 	if (!tn->idrinfo)
113 		return -ENOMEM;
114 	tn->ops = ops;
115 	spin_lock_init(&tn->idrinfo->lock);
116 	idr_init(&tn->idrinfo->action_idr);
117 	return err;
118 }
119 
120 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
121 			 struct tcf_idrinfo *idrinfo);
122 
123 static inline void tc_action_net_exit(struct tc_action_net *tn)
124 {
125 	rtnl_lock();
126 	tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
127 	rtnl_unlock();
128 	kfree(tn->idrinfo);
129 }
130 
131 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
132 		       struct netlink_callback *cb, int type,
133 		       const struct tc_action_ops *ops);
134 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
135 bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
136 		    int bind);
137 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
138 		   struct tc_action **a, const struct tc_action_ops *ops,
139 		   int bind, bool cpustats);
140 void tcf_idr_cleanup(struct tc_action *a, struct nlattr *est);
141 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
142 
143 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
144 
145 static inline int tcf_idr_release(struct tc_action *a, bool bind)
146 {
147 	return __tcf_idr_release(a, bind, false);
148 }
149 
150 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
151 int tcf_unregister_action(struct tc_action_ops *a,
152 			  struct pernet_operations *ops);
153 int tcf_action_destroy(struct list_head *actions, int bind);
154 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
155 		    int nr_actions, struct tcf_result *res);
156 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
157 		    struct nlattr *est, char *name, int ovr, int bind,
158 		    struct list_head *actions);
159 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
160 				    struct nlattr *nla, struct nlattr *est,
161 				    char *name, int ovr, int bind);
162 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
163 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
164 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
165 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
166 
167 #endif /* CONFIG_NET_CLS_ACT */
168 
169 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
170 					   u64 packets, u64 lastuse)
171 {
172 #ifdef CONFIG_NET_CLS_ACT
173 	if (!a->ops->stats_update)
174 		return;
175 
176 	a->ops->stats_update(a, bytes, packets, lastuse);
177 #endif
178 }
179 
180 typedef int tc_setup_cb_t(enum tc_setup_type type,
181 			  void *type_data, void *cb_priv);
182 
183 #ifdef CONFIG_NET_CLS_ACT
184 int tc_setup_cb_egdev_register(const struct net_device *dev,
185 			       tc_setup_cb_t *cb, void *cb_priv);
186 void tc_setup_cb_egdev_unregister(const struct net_device *dev,
187 				  tc_setup_cb_t *cb, void *cb_priv);
188 int tc_setup_cb_egdev_call(const struct net_device *dev,
189 			   enum tc_setup_type type, void *type_data,
190 			   bool err_stop);
191 #else
192 static inline
193 int tc_setup_cb_egdev_register(const struct net_device *dev,
194 			       tc_setup_cb_t *cb, void *cb_priv)
195 {
196 	return 0;
197 }
198 
199 static inline
200 void tc_setup_cb_egdev_unregister(const struct net_device *dev,
201 				  tc_setup_cb_t *cb, void *cb_priv)
202 {
203 }
204 
205 static inline
206 int tc_setup_cb_egdev_call(const struct net_device *dev,
207 			   enum tc_setup_type type, void *type_data,
208 			   bool err_stop)
209 {
210 	return 0;
211 }
212 #endif
213 
214 #endif
215