xref: /linux/include/net/act_api.h (revision e0fcfb086fbbb6233de1062d4b2f05e9afedab3b)
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 	struct mutex	lock;
17 	struct idr	action_idr;
18 	struct net	*net;
19 };
20 
21 struct tc_action_ops;
22 
23 struct tc_action {
24 	const struct tc_action_ops	*ops;
25 	__u32				type; /* for backward compat(TCA_OLD_COMPAT) */
26 	__u32				order;
27 	struct tcf_idrinfo		*idrinfo;
28 
29 	u32				tcfa_index;
30 	refcount_t			tcfa_refcnt;
31 	atomic_t			tcfa_bindcnt;
32 	int				tcfa_action;
33 	struct tcf_t			tcfa_tm;
34 	struct gnet_stats_basic_packed	tcfa_bstats;
35 	struct gnet_stats_basic_packed	tcfa_bstats_hw;
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_basic_cpu __percpu *cpu_bstats_hw;
41 	struct gnet_stats_queue __percpu *cpu_qstats;
42 	struct tc_cookie	__rcu *act_cookie;
43 	struct tcf_chain	__rcu *goto_chain;
44 };
45 #define tcf_index	common.tcfa_index
46 #define tcf_refcnt	common.tcfa_refcnt
47 #define tcf_bindcnt	common.tcfa_bindcnt
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 	enum tca_id  id; /* identifier should 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 	int     (*init)(struct net *net, struct nlattr *nla,
93 			struct nlattr *est, struct tc_action **act, int ovr,
94 			int bind, bool rtnl_held, struct tcf_proto *tp,
95 			struct netlink_ext_ack *extack);
96 	int     (*walk)(struct net *, struct sk_buff *,
97 			struct netlink_callback *, int,
98 			const struct tc_action_ops *,
99 			struct netlink_ext_ack *);
100 	void	(*stats_update)(struct tc_action *, u64, u32, u64, bool);
101 	size_t  (*get_fill_size)(const struct tc_action *act);
102 	struct net_device *(*get_dev)(const struct tc_action *a);
103 	void	(*put_dev)(struct net_device *dev);
104 };
105 
106 struct tc_action_net {
107 	struct tcf_idrinfo *idrinfo;
108 	const struct tc_action_ops *ops;
109 };
110 
111 static inline
112 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
113 		       const struct tc_action_ops *ops)
114 {
115 	int err = 0;
116 
117 	tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
118 	if (!tn->idrinfo)
119 		return -ENOMEM;
120 	tn->ops = ops;
121 	tn->idrinfo->net = net;
122 	mutex_init(&tn->idrinfo->lock);
123 	idr_init(&tn->idrinfo->action_idr);
124 	return err;
125 }
126 
127 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
128 			 struct tcf_idrinfo *idrinfo);
129 
130 static inline void tc_action_net_exit(struct list_head *net_list,
131 				      unsigned int id)
132 {
133 	struct net *net;
134 
135 	rtnl_lock();
136 	list_for_each_entry(net, net_list, exit_list) {
137 		struct tc_action_net *tn = net_generic(net, id);
138 
139 		tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
140 		kfree(tn->idrinfo);
141 	}
142 	rtnl_unlock();
143 }
144 
145 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
146 		       struct netlink_callback *cb, int type,
147 		       const struct tc_action_ops *ops,
148 		       struct netlink_ext_ack *extack);
149 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
150 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
151 		   struct tc_action **a, const struct tc_action_ops *ops,
152 		   int bind, bool cpustats);
153 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
154 
155 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
156 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
157 			struct tc_action **a, int bind);
158 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
159 
160 static inline int tcf_idr_release(struct tc_action *a, bool bind)
161 {
162 	return __tcf_idr_release(a, bind, false);
163 }
164 
165 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
166 int tcf_unregister_action(struct tc_action_ops *a,
167 			  struct pernet_operations *ops);
168 int tcf_action_destroy(struct tc_action *actions[], int bind);
169 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
170 		    int nr_actions, struct tcf_result *res);
171 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
172 		    struct nlattr *est, char *name, int ovr, int bind,
173 		    struct tc_action *actions[], size_t *attr_size,
174 		    bool rtnl_held, struct netlink_ext_ack *extack);
175 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
176 				    struct nlattr *nla, struct nlattr *est,
177 				    char *name, int ovr, int bind,
178 				    bool rtnl_held,
179 				    struct netlink_ext_ack *extack);
180 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
181 		    int ref);
182 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
183 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
184 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
185 
186 int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
187 			     struct tcf_chain **handle,
188 			     struct netlink_ext_ack *newchain);
189 struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
190 					 struct tcf_chain *newchain);
191 #endif /* CONFIG_NET_CLS_ACT */
192 
193 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
194 					   u64 packets, u64 lastuse, bool hw)
195 {
196 #ifdef CONFIG_NET_CLS_ACT
197 	if (!a->ops->stats_update)
198 		return;
199 
200 	a->ops->stats_update(a, bytes, packets, lastuse, hw);
201 #endif
202 }
203 
204 
205 #endif
206