xref: /linux/include/net/act_api.h (revision 96c63fa7393d0a346acfe5a91e0c7d4c7782641b)
1 #ifndef __NET_ACT_API_H
2 #define __NET_ACT_API_H
3 
4 /*
5  * Public action API for classifiers/qdiscs
6 */
7 
8 #include <net/sch_generic.h>
9 #include <net/pkt_sched.h>
10 #include <net/net_namespace.h>
11 #include <net/netns/generic.h>
12 
13 struct tcf_common {
14 	struct hlist_node		tcfc_head;
15 	u32				tcfc_index;
16 	int				tcfc_refcnt;
17 	int				tcfc_bindcnt;
18 	u32				tcfc_capab;
19 	int				tcfc_action;
20 	struct tcf_t			tcfc_tm;
21 	struct gnet_stats_basic_packed	tcfc_bstats;
22 	struct gnet_stats_queue		tcfc_qstats;
23 	struct gnet_stats_rate_est64	tcfc_rate_est;
24 	spinlock_t			tcfc_lock;
25 	struct rcu_head			tcfc_rcu;
26 	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
27 	struct gnet_stats_queue __percpu *cpu_qstats;
28 };
29 #define tcf_head	common.tcfc_head
30 #define tcf_index	common.tcfc_index
31 #define tcf_refcnt	common.tcfc_refcnt
32 #define tcf_bindcnt	common.tcfc_bindcnt
33 #define tcf_capab	common.tcfc_capab
34 #define tcf_action	common.tcfc_action
35 #define tcf_tm		common.tcfc_tm
36 #define tcf_bstats	common.tcfc_bstats
37 #define tcf_qstats	common.tcfc_qstats
38 #define tcf_rate_est	common.tcfc_rate_est
39 #define tcf_lock	common.tcfc_lock
40 #define tcf_rcu		common.tcfc_rcu
41 
42 struct tcf_hashinfo {
43 	struct hlist_head	*htab;
44 	unsigned int		hmask;
45 	spinlock_t		lock;
46 	u32			index;
47 };
48 
49 static inline unsigned int tcf_hash(u32 index, unsigned int hmask)
50 {
51 	return index & hmask;
52 }
53 
54 static inline int tcf_hashinfo_init(struct tcf_hashinfo *hf, unsigned int mask)
55 {
56 	int i;
57 
58 	spin_lock_init(&hf->lock);
59 	hf->index = 0;
60 	hf->hmask = mask;
61 	hf->htab = kzalloc((mask + 1) * sizeof(struct hlist_head),
62 			   GFP_KERNEL);
63 	if (!hf->htab)
64 		return -ENOMEM;
65 	for (i = 0; i < mask + 1; i++)
66 		INIT_HLIST_HEAD(&hf->htab[i]);
67 	return 0;
68 }
69 
70 /* Update lastuse only if needed, to avoid dirtying a cache line.
71  * We use a temp variable to avoid fetching jiffies twice.
72  */
73 static inline void tcf_lastuse_update(struct tcf_t *tm)
74 {
75 	unsigned long now = jiffies;
76 
77 	if (tm->lastuse != now)
78 		tm->lastuse = now;
79 	if (unlikely(!tm->firstuse))
80 		tm->firstuse = now;
81 }
82 
83 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
84 {
85 	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
86 	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
87 	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
88 	dtm->expires = jiffies_to_clock_t(stm->expires);
89 }
90 
91 struct tc_action {
92 	void			*priv;
93 	const struct tc_action_ops	*ops;
94 	__u32			type; /* for backward compat(TCA_OLD_COMPAT) */
95 	__u32			order;
96 	struct list_head	list;
97 	struct tcf_hashinfo	*hinfo;
98 };
99 
100 #ifdef CONFIG_NET_CLS_ACT
101 
102 #define ACT_P_CREATED 1
103 #define ACT_P_DELETED 1
104 
105 struct tc_action_ops {
106 	struct list_head head;
107 	char    kind[IFNAMSIZ];
108 	__u32   type; /* TBD to match kind */
109 	struct module		*owner;
110 	int     (*act)(struct sk_buff *, const struct tc_action *,
111 		       struct tcf_result *);
112 	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
113 	void	(*cleanup)(struct tc_action *, int bind);
114 	int     (*lookup)(struct net *, struct tc_action *, u32);
115 	int     (*init)(struct net *net, struct nlattr *nla,
116 			struct nlattr *est, struct tc_action *act, int ovr,
117 			int bind);
118 	int     (*walk)(struct net *, struct sk_buff *,
119 			struct netlink_callback *, int, struct tc_action *);
120 	void	(*stats_update)(struct tc_action *, u64, u32, u64);
121 };
122 
123 struct tc_action_net {
124 	struct tcf_hashinfo *hinfo;
125 	const struct tc_action_ops *ops;
126 };
127 
128 static inline
129 int tc_action_net_init(struct tc_action_net *tn,
130 		       const struct tc_action_ops *ops, unsigned int mask)
131 {
132 	int err = 0;
133 
134 	tn->hinfo = kmalloc(sizeof(*tn->hinfo), GFP_KERNEL);
135 	if (!tn->hinfo)
136 		return -ENOMEM;
137 	tn->ops = ops;
138 	err = tcf_hashinfo_init(tn->hinfo, mask);
139 	if (err)
140 		kfree(tn->hinfo);
141 	return err;
142 }
143 
144 void tcf_hashinfo_destroy(const struct tc_action_ops *ops,
145 			  struct tcf_hashinfo *hinfo);
146 
147 static inline void tc_action_net_exit(struct tc_action_net *tn)
148 {
149 	tcf_hashinfo_destroy(tn->ops, tn->hinfo);
150 	kfree(tn->hinfo);
151 }
152 
153 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
154 		       struct netlink_callback *cb, int type,
155 		       struct tc_action *a);
156 int tcf_hash_search(struct tc_action_net *tn, struct tc_action *a, u32 index);
157 u32 tcf_hash_new_index(struct tc_action_net *tn);
158 int tcf_hash_check(struct tc_action_net *tn, u32 index, struct tc_action *a,
159 		   int bind);
160 int tcf_hash_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
161 		    struct tc_action *a, int size, int bind, bool cpustats);
162 void tcf_hash_cleanup(struct tc_action *a, struct nlattr *est);
163 void tcf_hash_insert(struct tc_action_net *tn, struct tc_action *a);
164 
165 int __tcf_hash_release(struct tc_action *a, bool bind, bool strict);
166 
167 static inline int tcf_hash_release(struct tc_action *a, bool bind)
168 {
169 	return __tcf_hash_release(a, bind, false);
170 }
171 
172 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
173 int tcf_unregister_action(struct tc_action_ops *a,
174 			  struct pernet_operations *ops);
175 int tcf_action_destroy(struct list_head *actions, int bind);
176 int tcf_action_exec(struct sk_buff *skb, const struct list_head *actions,
177 		    struct tcf_result *res);
178 int tcf_action_init(struct net *net, struct nlattr *nla,
179 				  struct nlattr *est, char *n, int ovr,
180 				  int bind, struct list_head *);
181 struct tc_action *tcf_action_init_1(struct net *net, struct nlattr *nla,
182 				    struct nlattr *est, char *n, int ovr,
183 				    int bind);
184 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
185 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
186 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
187 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
188 
189 #define tc_no_actions(_exts) \
190 	(list_empty(&(_exts)->actions))
191 
192 #define tc_for_each_action(_a, _exts) \
193 	list_for_each_entry(a, &(_exts)->actions, list)
194 
195 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
196 					   u64 packets, u64 lastuse)
197 {
198 	if (!a->ops->stats_update)
199 		return;
200 
201 	a->ops->stats_update(a, bytes, packets, lastuse);
202 }
203 
204 #else /* CONFIG_NET_CLS_ACT */
205 
206 #define tc_no_actions(_exts) true
207 #define tc_for_each_action(_a, _exts) while ((void)(_a), 0)
208 #define tcf_action_stats_update(a, bytes, packets, lastuse)
209 
210 #endif /* CONFIG_NET_CLS_ACT */
211 #endif
212