xref: /linux/include/net/act_api.h (revision 1fc31357ad194fb98691f3d122bcd47e59239e83)
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 
14 struct tcf_hashinfo {
15 	struct hlist_head	*htab;
16 	unsigned int		hmask;
17 	spinlock_t		lock;
18 	u32			index;
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 list_head		list;
28 	struct tcf_hashinfo		*hinfo;
29 
30 	struct hlist_node		tcfa_head;
31 	u32				tcfa_index;
32 	int				tcfa_refcnt;
33 	int				tcfa_bindcnt;
34 	u32				tcfa_capab;
35 	int				tcfa_action;
36 	struct tcf_t			tcfa_tm;
37 	struct gnet_stats_basic_packed	tcfa_bstats;
38 	struct gnet_stats_queue		tcfa_qstats;
39 	struct gnet_stats_rate_est64	tcfa_rate_est;
40 	spinlock_t			tcfa_lock;
41 	struct rcu_head			tcfa_rcu;
42 	struct gnet_stats_basic_cpu __percpu *cpu_bstats;
43 	struct gnet_stats_queue __percpu *cpu_qstats;
44 };
45 #define tcf_head	common.tcfa_head
46 #define tcf_index	common.tcfa_index
47 #define tcf_refcnt	common.tcfa_refcnt
48 #define tcf_bindcnt	common.tcfa_bindcnt
49 #define tcf_capab	common.tcfa_capab
50 #define tcf_action	common.tcfa_action
51 #define tcf_tm		common.tcfa_tm
52 #define tcf_bstats	common.tcfa_bstats
53 #define tcf_qstats	common.tcfa_qstats
54 #define tcf_rate_est	common.tcfa_rate_est
55 #define tcf_lock	common.tcfa_lock
56 #define tcf_rcu		common.tcfa_rcu
57 
58 static inline unsigned int tcf_hash(u32 index, unsigned int hmask)
59 {
60 	return index & hmask;
61 }
62 
63 static inline int tcf_hashinfo_init(struct tcf_hashinfo *hf, unsigned int mask)
64 {
65 	int i;
66 
67 	spin_lock_init(&hf->lock);
68 	hf->index = 0;
69 	hf->hmask = mask;
70 	hf->htab = kzalloc((mask + 1) * sizeof(struct hlist_head),
71 			   GFP_KERNEL);
72 	if (!hf->htab)
73 		return -ENOMEM;
74 	for (i = 0; i < mask + 1; i++)
75 		INIT_HLIST_HEAD(&hf->htab[i]);
76 	return 0;
77 }
78 
79 /* Update lastuse only if needed, to avoid dirtying a cache line.
80  * We use a temp variable to avoid fetching jiffies twice.
81  */
82 static inline void tcf_lastuse_update(struct tcf_t *tm)
83 {
84 	unsigned long now = jiffies;
85 
86 	if (tm->lastuse != now)
87 		tm->lastuse = now;
88 	if (unlikely(!tm->firstuse))
89 		tm->firstuse = now;
90 }
91 
92 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
93 {
94 	dtm->install = jiffies_to_clock_t(jiffies - stm->install);
95 	dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
96 	dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
97 	dtm->expires = jiffies_to_clock_t(stm->expires);
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 	size_t	size;
110 	struct module		*owner;
111 	int     (*act)(struct sk_buff *, const struct tc_action *,
112 		       struct tcf_result *);
113 	int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
114 	void	(*cleanup)(struct tc_action *, int bind);
115 	int     (*lookup)(struct net *, struct tc_action **, u32);
116 	int     (*init)(struct net *net, struct nlattr *nla,
117 			struct nlattr *est, struct tc_action **act, int ovr,
118 			int bind);
119 	int     (*walk)(struct net *, struct sk_buff *,
120 			struct netlink_callback *, int, const struct tc_action_ops *);
121 	void	(*stats_update)(struct tc_action *, u64, u32, u64);
122 };
123 
124 struct tc_action_net {
125 	struct tcf_hashinfo *hinfo;
126 	const struct tc_action_ops *ops;
127 };
128 
129 static inline
130 int tc_action_net_init(struct tc_action_net *tn,
131 		       const struct tc_action_ops *ops, unsigned int mask)
132 {
133 	int err = 0;
134 
135 	tn->hinfo = kmalloc(sizeof(*tn->hinfo), GFP_KERNEL);
136 	if (!tn->hinfo)
137 		return -ENOMEM;
138 	tn->ops = ops;
139 	err = tcf_hashinfo_init(tn->hinfo, mask);
140 	if (err)
141 		kfree(tn->hinfo);
142 	return err;
143 }
144 
145 void tcf_hashinfo_destroy(const struct tc_action_ops *ops,
146 			  struct tcf_hashinfo *hinfo);
147 
148 static inline void tc_action_net_exit(struct tc_action_net *tn)
149 {
150 	tcf_hashinfo_destroy(tn->ops, tn->hinfo);
151 	kfree(tn->hinfo);
152 }
153 
154 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
155 		       struct netlink_callback *cb, int type,
156 		       const struct tc_action_ops *ops);
157 int tcf_hash_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
158 u32 tcf_hash_new_index(struct tc_action_net *tn);
159 bool tcf_hash_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
160 		    int bind);
161 int tcf_hash_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
162 		    struct tc_action **a, const struct tc_action_ops *ops, int bind,
163 		    bool cpustats);
164 void tcf_hash_cleanup(struct tc_action *a, struct nlattr *est);
165 void tcf_hash_insert(struct tc_action_net *tn, struct tc_action *a);
166 
167 int __tcf_hash_release(struct tc_action *a, bool bind, bool strict);
168 
169 static inline int tcf_hash_release(struct tc_action *a, bool bind)
170 {
171 	return __tcf_hash_release(a, bind, false);
172 }
173 
174 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
175 int tcf_unregister_action(struct tc_action_ops *a,
176 			  struct pernet_operations *ops);
177 int tcf_action_destroy(struct list_head *actions, int bind);
178 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
179 		    int nr_actions, struct tcf_result *res);
180 int tcf_action_init(struct net *net, struct nlattr *nla,
181 				  struct nlattr *est, char *n, int ovr,
182 				  int bind, struct list_head *);
183 struct tc_action *tcf_action_init_1(struct net *net, struct nlattr *nla,
184 				    struct nlattr *est, char *n, int ovr,
185 				    int bind);
186 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
187 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
188 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
189 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
190 
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)
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);
201 #endif
202 }
203 
204 #endif
205