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