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