xref: /linux/include/net/act_api.h (revision 791d3ef2e11100449837dc0b6fe884e60ca3a484)
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 *);
90 	int     (*lookup)(struct net *net, struct tc_action **a, u32 index,
91 			  struct netlink_ext_ack *extack);
92 	int     (*init)(struct net *net, struct nlattr *nla,
93 			struct nlattr *est, struct tc_action **act, int ovr,
94 			int bind, struct netlink_ext_ack *extack);
95 	int     (*walk)(struct net *, struct sk_buff *,
96 			struct netlink_callback *, int,
97 			const struct tc_action_ops *,
98 			struct netlink_ext_ack *);
99 	void	(*stats_update)(struct tc_action *, u64, u32, u64);
100 	size_t  (*get_fill_size)(const struct tc_action *act);
101 	struct net_device *(*get_dev)(const struct tc_action *a);
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 bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
148 		    int bind);
149 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
150 		   struct tc_action **a, const struct tc_action_ops *ops,
151 		   int bind, bool cpustats);
152 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
153 
154 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
155 
156 static inline int tcf_idr_release(struct tc_action *a, bool bind)
157 {
158 	return __tcf_idr_release(a, bind, false);
159 }
160 
161 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
162 int tcf_unregister_action(struct tc_action_ops *a,
163 			  struct pernet_operations *ops);
164 int tcf_action_destroy(struct list_head *actions, int bind);
165 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
166 		    int nr_actions, struct tcf_result *res);
167 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
168 		    struct nlattr *est, char *name, int ovr, int bind,
169 		    struct list_head *actions, size_t *attr_size,
170 		    struct netlink_ext_ack *extack);
171 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
172 				    struct nlattr *nla, struct nlattr *est,
173 				    char *name, int ovr, int bind,
174 				    struct netlink_ext_ack *extack);
175 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
176 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
177 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
178 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
179 
180 #endif /* CONFIG_NET_CLS_ACT */
181 
182 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
183 					   u64 packets, u64 lastuse)
184 {
185 #ifdef CONFIG_NET_CLS_ACT
186 	if (!a->ops->stats_update)
187 		return;
188 
189 	a->ops->stats_update(a, bytes, packets, lastuse);
190 #endif
191 }
192 
193 typedef int tc_setup_cb_t(enum tc_setup_type type,
194 			  void *type_data, void *cb_priv);
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