xref: /openbmc/linux/include/net/act_api.h (revision 2eb3ed33e55d003d721d4d1a5e72fe323c12b4c0)
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 	struct net	*net;
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 	int				tcfa_refcnt;
31 	int				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	*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 *);
89 	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
90 	void	(*cleanup)(struct tc_action *, int bind);
91 	int     (*lookup)(struct net *, struct tc_action **, u32);
92 	int     (*init)(struct net *net, struct nlattr *nla,
93 			struct nlattr *est, struct tc_action **act, int ovr,
94 			int bind);
95 	int     (*walk)(struct net *, struct sk_buff *,
96 			struct netlink_callback *, int, const struct tc_action_ops *);
97 	void	(*stats_update)(struct tc_action *, u64, u32, u64);
98 	struct net_device *(*get_dev)(const struct tc_action *a);
99 };
100 
101 struct tc_action_net {
102 	struct tcf_idrinfo *idrinfo;
103 	const struct tc_action_ops *ops;
104 };
105 
106 static inline
107 int tc_action_net_init(struct tc_action_net *tn,
108 		       const struct tc_action_ops *ops, struct net *net)
109 {
110 	int err = 0;
111 
112 	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
113 	if (!tn->idrinfo)
114 		return -ENOMEM;
115 	tn->ops = ops;
116 	tn->idrinfo->net = net;
117 	spin_lock_init(&tn->idrinfo->lock);
118 	idr_init(&tn->idrinfo->action_idr);
119 	return err;
120 }
121 
122 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
123 			 struct tcf_idrinfo *idrinfo);
124 
125 static inline void tc_action_net_exit(struct tc_action_net *tn)
126 {
127 	rtnl_lock();
128 	tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
129 	rtnl_unlock();
130 	kfree(tn->idrinfo);
131 }
132 
133 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
134 		       struct netlink_callback *cb, int type,
135 		       const struct tc_action_ops *ops);
136 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
137 bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
138 		    int bind);
139 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
140 		   struct tc_action **a, const struct tc_action_ops *ops,
141 		   int bind, bool cpustats);
142 void tcf_idr_cleanup(struct tc_action *a, struct nlattr *est);
143 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
144 
145 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
146 
147 static inline int tcf_idr_release(struct tc_action *a, bool bind)
148 {
149 	return __tcf_idr_release(a, bind, false);
150 }
151 
152 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
153 int tcf_unregister_action(struct tc_action_ops *a,
154 			  struct pernet_operations *ops);
155 int tcf_action_destroy(struct list_head *actions, int bind);
156 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
157 		    int nr_actions, struct tcf_result *res);
158 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
159 		    struct nlattr *est, char *name, int ovr, int bind,
160 		    struct list_head *actions);
161 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
162 				    struct nlattr *nla, struct nlattr *est,
163 				    char *name, int ovr, int bind);
164 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
165 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
166 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
167 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
168 
169 #endif /* CONFIG_NET_CLS_ACT */
170 
171 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
172 					   u64 packets, u64 lastuse)
173 {
174 #ifdef CONFIG_NET_CLS_ACT
175 	if (!a->ops->stats_update)
176 		return;
177 
178 	a->ops->stats_update(a, bytes, packets, lastuse);
179 #endif
180 }
181 
182 typedef int tc_setup_cb_t(enum tc_setup_type type,
183 			  void *type_data, void *cb_priv);
184 
185 #ifdef CONFIG_NET_CLS_ACT
186 int tc_setup_cb_egdev_register(const struct net_device *dev,
187 			       tc_setup_cb_t *cb, void *cb_priv);
188 void tc_setup_cb_egdev_unregister(const struct net_device *dev,
189 				  tc_setup_cb_t *cb, void *cb_priv);
190 int tc_setup_cb_egdev_call(const struct net_device *dev,
191 			   enum tc_setup_type type, void *type_data,
192 			   bool err_stop);
193 #else
194 static inline
195 int tc_setup_cb_egdev_register(const struct net_device *dev,
196 			       tc_setup_cb_t *cb, void *cb_priv)
197 {
198 	return 0;
199 }
200 
201 static inline
202 void tc_setup_cb_egdev_unregister(const struct net_device *dev,
203 				  tc_setup_cb_t *cb, void *cb_priv)
204 {
205 }
206 
207 static inline
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 {
212 	return 0;
213 }
214 #endif
215 
216 #endif
217