]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/sch_generic.h
net_sched: move dev_graft_qdisc() to sch_generic.c
[mirror_ubuntu-bionic-kernel.git] / include / net / sch_generic.h
CommitLineData
1da177e4
LT
1#ifndef __NET_SCHED_GENERIC_H
2#define __NET_SCHED_GENERIC_H
3
1da177e4
LT
4#include <linux/netdevice.h>
5#include <linux/types.h>
6#include <linux/rcupdate.h>
7#include <linux/module.h>
1da177e4
LT
8#include <linux/pkt_sched.h>
9#include <linux/pkt_cls.h>
10#include <net/gen_stats.h>
be577ddc 11#include <net/rtnetlink.h>
1da177e4
LT
12
13struct Qdisc_ops;
14struct qdisc_walker;
15struct tcf_walker;
16struct module;
17
18struct qdisc_rate_table
19{
20 struct tc_ratespec rate;
21 u32 data[256];
22 struct qdisc_rate_table *next;
23 int refcnt;
24};
25
e2627c8c
DM
26enum qdisc_state_t
27{
28 __QDISC_STATE_RUNNING,
37437bb2 29 __QDISC_STATE_SCHED,
a9312ae8 30 __QDISC_STATE_DEACTIVATED,
e2627c8c
DM
31};
32
175f9c1b
JK
33struct qdisc_size_table {
34 struct list_head list;
35 struct tc_sizespec szopts;
36 int refcnt;
37 u16 data[];
38};
39
1da177e4
LT
40struct Qdisc
41{
42 int (*enqueue)(struct sk_buff *skb, struct Qdisc *dev);
43 struct sk_buff * (*dequeue)(struct Qdisc *dev);
44 unsigned flags;
b00355db
JP
45#define TCQ_F_BUILTIN 1
46#define TCQ_F_THROTTLED 2
47#define TCQ_F_INGRESS 4
bbd8a0d3 48#define TCQ_F_CAN_BYPASS 8
b00355db 49#define TCQ_F_WARN_NONWC (1 << 16)
1da177e4
LT
50 int padded;
51 struct Qdisc_ops *ops;
175f9c1b 52 struct qdisc_size_table *stab;
5e140dfc 53 struct list_head list;
1da177e4
LT
54 u32 handle;
55 u32 parent;
56 atomic_t refcnt;
1da177e4 57 struct gnet_stats_rate_est rate_est;
1da177e4
LT
58 int (*reshape_fail)(struct sk_buff *skb,
59 struct Qdisc *q);
60
72b25a91
DM
61 void *u32_node;
62
1da177e4
LT
63 /* This field is deprecated, but it is still used by CBQ
64 * and it will live until better solution will be invented.
65 */
66 struct Qdisc *__parent;
5e140dfc
ED
67 struct netdev_queue *dev_queue;
68 struct Qdisc *next_sched;
69
70 struct sk_buff *gso_skb;
71 /*
72 * For performance sake on SMP, we put highly modified fields at the end
73 */
74 unsigned long state;
75 struct sk_buff_head q;
c1a8f1f1 76 struct gnet_stats_basic_packed bstats;
5e140dfc 77 struct gnet_stats_queue qstats;
1da177e4
LT
78};
79
80struct Qdisc_class_ops
81{
82 /* Child qdisc manipulation */
83 int (*graft)(struct Qdisc *, unsigned long cl,
84 struct Qdisc *, struct Qdisc **);
85 struct Qdisc * (*leaf)(struct Qdisc *, unsigned long cl);
43effa1e 86 void (*qlen_notify)(struct Qdisc *, unsigned long);
1da177e4
LT
87
88 /* Class manipulation routines */
89 unsigned long (*get)(struct Qdisc *, u32 classid);
90 void (*put)(struct Qdisc *, unsigned long);
91 int (*change)(struct Qdisc *, u32, u32,
1e90474c 92 struct nlattr **, unsigned long *);
1da177e4
LT
93 int (*delete)(struct Qdisc *, unsigned long);
94 void (*walk)(struct Qdisc *, struct qdisc_walker * arg);
95
96 /* Filter manipulation */
97 struct tcf_proto ** (*tcf_chain)(struct Qdisc *, unsigned long);
98 unsigned long (*bind_tcf)(struct Qdisc *, unsigned long,
99 u32 classid);
100 void (*unbind_tcf)(struct Qdisc *, unsigned long);
101
102 /* rtnetlink specific */
103 int (*dump)(struct Qdisc *, unsigned long,
104 struct sk_buff *skb, struct tcmsg*);
105 int (*dump_stats)(struct Qdisc *, unsigned long,
106 struct gnet_dump *);
107};
108
109struct Qdisc_ops
110{
111 struct Qdisc_ops *next;
20fea08b 112 const struct Qdisc_class_ops *cl_ops;
1da177e4
LT
113 char id[IFNAMSIZ];
114 int priv_size;
115
116 int (*enqueue)(struct sk_buff *, struct Qdisc *);
117 struct sk_buff * (*dequeue)(struct Qdisc *);
90d841fd 118 struct sk_buff * (*peek)(struct Qdisc *);
1da177e4
LT
119 unsigned int (*drop)(struct Qdisc *);
120
1e90474c 121 int (*init)(struct Qdisc *, struct nlattr *arg);
1da177e4
LT
122 void (*reset)(struct Qdisc *);
123 void (*destroy)(struct Qdisc *);
1e90474c 124 int (*change)(struct Qdisc *, struct nlattr *arg);
1da177e4
LT
125
126 int (*dump)(struct Qdisc *, struct sk_buff *);
127 int (*dump_stats)(struct Qdisc *, struct gnet_dump *);
128
129 struct module *owner;
130};
131
132
133struct tcf_result
134{
135 unsigned long class;
136 u32 classid;
137};
138
139struct tcf_proto_ops
140{
141 struct tcf_proto_ops *next;
142 char kind[IFNAMSIZ];
143
144 int (*classify)(struct sk_buff*, struct tcf_proto*,
145 struct tcf_result *);
146 int (*init)(struct tcf_proto*);
147 void (*destroy)(struct tcf_proto*);
148
149 unsigned long (*get)(struct tcf_proto*, u32 handle);
150 void (*put)(struct tcf_proto*, unsigned long);
151 int (*change)(struct tcf_proto*, unsigned long,
add93b61 152 u32 handle, struct nlattr **,
1da177e4
LT
153 unsigned long *);
154 int (*delete)(struct tcf_proto*, unsigned long);
155 void (*walk)(struct tcf_proto*, struct tcf_walker *arg);
156
157 /* rtnetlink specific */
158 int (*dump)(struct tcf_proto*, unsigned long,
159 struct sk_buff *skb, struct tcmsg*);
160
161 struct module *owner;
162};
163
164struct tcf_proto
165{
166 /* Fast access part */
167 struct tcf_proto *next;
168 void *root;
169 int (*classify)(struct sk_buff*, struct tcf_proto*,
170 struct tcf_result *);
66c6f529 171 __be16 protocol;
1da177e4
LT
172
173 /* All the rest */
174 u32 prio;
175 u32 classid;
176 struct Qdisc *q;
177 void *data;
178 struct tcf_proto_ops *ops;
179};
180
175f9c1b
JK
181struct qdisc_skb_cb {
182 unsigned int pkt_len;
183 char data[];
184};
185
bbd8a0d3
KK
186static inline int qdisc_qlen(struct Qdisc *q)
187{
188 return q->q.qlen;
189}
190
175f9c1b
JK
191static inline struct qdisc_skb_cb *qdisc_skb_cb(struct sk_buff *skb)
192{
193 return (struct qdisc_skb_cb *)skb->cb;
194}
195
83874000
DM
196static inline spinlock_t *qdisc_lock(struct Qdisc *qdisc)
197{
198 return &qdisc->q.lock;
199}
200
7698b4fc
DM
201static inline struct Qdisc *qdisc_root(struct Qdisc *qdisc)
202{
203 return qdisc->dev_queue->qdisc;
204}
205
2540e051
JP
206static inline struct Qdisc *qdisc_root_sleeping(struct Qdisc *qdisc)
207{
208 return qdisc->dev_queue->qdisc_sleeping;
209}
210
7e43f112
DM
211/* The qdisc root lock is a mechanism by which to top level
212 * of a qdisc tree can be locked from any qdisc node in the
213 * forest. This allows changing the configuration of some
214 * aspect of the qdisc tree while blocking out asynchronous
215 * qdisc access in the packet processing paths.
216 *
217 * It is only legal to do this when the root will not change
218 * on us. Otherwise we'll potentially lock the wrong qdisc
219 * root. This is enforced by holding the RTNL semaphore, which
220 * all users of this lock accessor must do.
221 */
7698b4fc
DM
222static inline spinlock_t *qdisc_root_lock(struct Qdisc *qdisc)
223{
224 struct Qdisc *root = qdisc_root(qdisc);
225
7e43f112 226 ASSERT_RTNL();
83874000 227 return qdisc_lock(root);
7698b4fc
DM
228}
229
f6f9b93f
JP
230static inline spinlock_t *qdisc_root_sleeping_lock(struct Qdisc *qdisc)
231{
232 struct Qdisc *root = qdisc_root_sleeping(qdisc);
233
234 ASSERT_RTNL();
235 return qdisc_lock(root);
236}
237
5ce2d488
DM
238static inline struct net_device *qdisc_dev(struct Qdisc *qdisc)
239{
240 return qdisc->dev_queue->dev;
241}
1da177e4 242
78a5b30b
DM
243static inline void sch_tree_lock(struct Qdisc *q)
244{
fe439dd0 245 spin_lock_bh(qdisc_root_sleeping_lock(q));
78a5b30b
DM
246}
247
248static inline void sch_tree_unlock(struct Qdisc *q)
249{
fe439dd0 250 spin_unlock_bh(qdisc_root_sleeping_lock(q));
78a5b30b
DM
251}
252
253#define tcf_tree_lock(tp) sch_tree_lock((tp)->q)
254#define tcf_tree_unlock(tp) sch_tree_unlock((tp)->q)
1da177e4 255
e41a33e6
TG
256extern struct Qdisc noop_qdisc;
257extern struct Qdisc_ops noop_qdisc_ops;
258
6fe1c7a5
PM
259struct Qdisc_class_common
260{
261 u32 classid;
262 struct hlist_node hnode;
263};
264
265struct Qdisc_class_hash
266{
267 struct hlist_head *hash;
268 unsigned int hashsize;
269 unsigned int hashmask;
270 unsigned int hashelems;
271};
272
273static inline unsigned int qdisc_class_hash(u32 id, u32 mask)
274{
275 id ^= id >> 8;
276 id ^= id >> 4;
277 return id & mask;
278}
279
280static inline struct Qdisc_class_common *
281qdisc_class_find(struct Qdisc_class_hash *hash, u32 id)
282{
283 struct Qdisc_class_common *cl;
284 struct hlist_node *n;
285 unsigned int h;
286
287 h = qdisc_class_hash(id, hash->hashmask);
288 hlist_for_each_entry(cl, n, &hash->hash[h], hnode) {
289 if (cl->classid == id)
290 return cl;
291 }
292 return NULL;
293}
294
295extern int qdisc_class_hash_init(struct Qdisc_class_hash *);
296extern void qdisc_class_hash_insert(struct Qdisc_class_hash *, struct Qdisc_class_common *);
297extern void qdisc_class_hash_remove(struct Qdisc_class_hash *, struct Qdisc_class_common *);
298extern void qdisc_class_hash_grow(struct Qdisc *, struct Qdisc_class_hash *);
299extern void qdisc_class_hash_destroy(struct Qdisc_class_hash *);
300
e41a33e6
TG
301extern void dev_init_scheduler(struct net_device *dev);
302extern void dev_shutdown(struct net_device *dev);
303extern void dev_activate(struct net_device *dev);
304extern void dev_deactivate(struct net_device *dev);
589983cd
PM
305extern struct Qdisc *dev_graft_qdisc(struct netdev_queue *dev_queue,
306 struct Qdisc *qdisc);
e41a33e6
TG
307extern void qdisc_reset(struct Qdisc *qdisc);
308extern void qdisc_destroy(struct Qdisc *qdisc);
43effa1e 309extern void qdisc_tree_decrease_qlen(struct Qdisc *qdisc, unsigned int n);
5ce2d488 310extern struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
bb949fbd 311 struct Qdisc_ops *ops);
e41a33e6 312extern struct Qdisc *qdisc_create_dflt(struct net_device *dev,
bb949fbd 313 struct netdev_queue *dev_queue,
9f9afec4 314 struct Qdisc_ops *ops, u32 parentid);
175f9c1b
JK
315extern void qdisc_calculate_pkt_len(struct sk_buff *skb,
316 struct qdisc_size_table *stab);
a48b5a61 317extern void tcf_destroy(struct tcf_proto *tp);
ff31ab56 318extern void tcf_destroy_chain(struct tcf_proto **fl);
1da177e4 319
5aa70995
DM
320/* Reset all TX qdiscs of a device. */
321static inline void qdisc_reset_all_tx(struct net_device *dev)
322{
e8a0464c
DM
323 unsigned int i;
324 for (i = 0; i < dev->num_tx_queues; i++)
325 qdisc_reset(netdev_get_tx_queue(dev, i)->qdisc);
5aa70995
DM
326}
327
3e745dd6
DM
328/* Are all TX queues of the device empty? */
329static inline bool qdisc_all_tx_empty(const struct net_device *dev)
330{
e8a0464c
DM
331 unsigned int i;
332 for (i = 0; i < dev->num_tx_queues; i++) {
333 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
334 const struct Qdisc *q = txq->qdisc;
3e745dd6 335
e8a0464c
DM
336 if (q->q.qlen)
337 return false;
338 }
339 return true;
3e745dd6
DM
340}
341
6fa9864b
DM
342/* Are any of the TX qdiscs changing? */
343static inline bool qdisc_tx_changing(struct net_device *dev)
344{
e8a0464c
DM
345 unsigned int i;
346 for (i = 0; i < dev->num_tx_queues; i++) {
347 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
348 if (txq->qdisc != txq->qdisc_sleeping)
349 return true;
350 }
351 return false;
6fa9864b
DM
352}
353
e8a0464c 354/* Is the device using the noop qdisc on all queues? */
05297949
DM
355static inline bool qdisc_tx_is_noop(const struct net_device *dev)
356{
e8a0464c
DM
357 unsigned int i;
358 for (i = 0; i < dev->num_tx_queues; i++) {
359 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
360 if (txq->qdisc != &noop_qdisc)
361 return false;
362 }
363 return true;
05297949
DM
364}
365
0abf77e5
JK
366static inline unsigned int qdisc_pkt_len(struct sk_buff *skb)
367{
175f9c1b 368 return qdisc_skb_cb(skb)->pkt_len;
0abf77e5
JK
369}
370
c27f339a 371/* additional qdisc xmit flags (NET_XMIT_MASK in linux/netdevice.h) */
378a2f09
JP
372enum net_xmit_qdisc_t {
373 __NET_XMIT_STOLEN = 0x00010000,
c27f339a 374 __NET_XMIT_BYPASS = 0x00020000,
378a2f09
JP
375};
376
c27f339a 377#ifdef CONFIG_NET_CLS_ACT
378a2f09 378#define net_xmit_drop_count(e) ((e) & __NET_XMIT_STOLEN ? 0 : 1)
378a2f09
JP
379#else
380#define net_xmit_drop_count(e) (1)
381#endif
382
5f86173b
JK
383static inline int qdisc_enqueue(struct sk_buff *skb, struct Qdisc *sch)
384{
3a682fbd 385#ifdef CONFIG_NET_SCHED
175f9c1b
JK
386 if (sch->stab)
387 qdisc_calculate_pkt_len(skb, sch->stab);
3a682fbd 388#endif
5f86173b
JK
389 return sch->enqueue(skb, sch);
390}
391
392static inline int qdisc_enqueue_root(struct sk_buff *skb, struct Qdisc *sch)
393{
175f9c1b 394 qdisc_skb_cb(skb)->pkt_len = skb->len;
378a2f09 395 return qdisc_enqueue(skb, sch) & NET_XMIT_MASK;
5f86173b
JK
396}
397
bbd8a0d3
KK
398static inline void __qdisc_update_bstats(struct Qdisc *sch, unsigned int len)
399{
400 sch->bstats.bytes += len;
401 sch->bstats.packets++;
402}
403
9972b25d
TG
404static inline int __qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch,
405 struct sk_buff_head *list)
406{
407 __skb_queue_tail(list, skb);
0abf77e5 408 sch->qstats.backlog += qdisc_pkt_len(skb);
bbd8a0d3 409 __qdisc_update_bstats(sch, qdisc_pkt_len(skb));
9972b25d
TG
410
411 return NET_XMIT_SUCCESS;
412}
413
414static inline int qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch)
415{
416 return __qdisc_enqueue_tail(skb, sch, &sch->q);
417}
418
419static inline struct sk_buff *__qdisc_dequeue_head(struct Qdisc *sch,
420 struct sk_buff_head *list)
421{
422 struct sk_buff *skb = __skb_dequeue(list);
423
424 if (likely(skb != NULL))
0abf77e5 425 sch->qstats.backlog -= qdisc_pkt_len(skb);
9972b25d
TG
426
427 return skb;
428}
429
430static inline struct sk_buff *qdisc_dequeue_head(struct Qdisc *sch)
431{
432 return __qdisc_dequeue_head(sch, &sch->q);
433}
434
435static inline struct sk_buff *__qdisc_dequeue_tail(struct Qdisc *sch,
436 struct sk_buff_head *list)
437{
438 struct sk_buff *skb = __skb_dequeue_tail(list);
439
440 if (likely(skb != NULL))
0abf77e5 441 sch->qstats.backlog -= qdisc_pkt_len(skb);
9972b25d
TG
442
443 return skb;
444}
445
446static inline struct sk_buff *qdisc_dequeue_tail(struct Qdisc *sch)
447{
448 return __qdisc_dequeue_tail(sch, &sch->q);
449}
450
48a8f519
PM
451static inline struct sk_buff *qdisc_peek_head(struct Qdisc *sch)
452{
453 return skb_peek(&sch->q);
454}
455
77be155c
JP
456/* generic pseudo peek method for non-work-conserving qdisc */
457static inline struct sk_buff *qdisc_peek_dequeued(struct Qdisc *sch)
458{
459 /* we can reuse ->gso_skb because peek isn't called for root qdiscs */
61c9eaf9 460 if (!sch->gso_skb) {
77be155c 461 sch->gso_skb = sch->dequeue(sch);
61c9eaf9
JP
462 if (sch->gso_skb)
463 /* it's still part of the queue */
464 sch->q.qlen++;
465 }
77be155c
JP
466
467 return sch->gso_skb;
468}
469
470/* use instead of qdisc->dequeue() for all qdiscs queried with ->peek() */
471static inline struct sk_buff *qdisc_dequeue_peeked(struct Qdisc *sch)
472{
473 struct sk_buff *skb = sch->gso_skb;
474
61c9eaf9 475 if (skb) {
77be155c 476 sch->gso_skb = NULL;
61c9eaf9
JP
477 sch->q.qlen--;
478 } else {
77be155c 479 skb = sch->dequeue(sch);
61c9eaf9 480 }
77be155c
JP
481
482 return skb;
483}
484
9972b25d
TG
485static inline void __qdisc_reset_queue(struct Qdisc *sch,
486 struct sk_buff_head *list)
487{
488 /*
489 * We do not know the backlog in bytes of this list, it
490 * is up to the caller to correct it
491 */
93245dd6 492 __skb_queue_purge(list);
9972b25d
TG
493}
494
495static inline void qdisc_reset_queue(struct Qdisc *sch)
496{
497 __qdisc_reset_queue(sch, &sch->q);
498 sch->qstats.backlog = 0;
499}
500
501static inline unsigned int __qdisc_queue_drop(struct Qdisc *sch,
502 struct sk_buff_head *list)
503{
504 struct sk_buff *skb = __qdisc_dequeue_tail(sch, list);
505
506 if (likely(skb != NULL)) {
0abf77e5 507 unsigned int len = qdisc_pkt_len(skb);
9972b25d
TG
508 kfree_skb(skb);
509 return len;
510 }
511
512 return 0;
513}
514
515static inline unsigned int qdisc_queue_drop(struct Qdisc *sch)
516{
517 return __qdisc_queue_drop(sch, &sch->q);
518}
519
520static inline int qdisc_drop(struct sk_buff *skb, struct Qdisc *sch)
521{
522 kfree_skb(skb);
523 sch->qstats.drops++;
524
525 return NET_XMIT_DROP;
526}
527
528static inline int qdisc_reshape_fail(struct sk_buff *skb, struct Qdisc *sch)
529{
530 sch->qstats.drops++;
531
c3bc7cff 532#ifdef CONFIG_NET_CLS_ACT
9972b25d
TG
533 if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
534 goto drop;
535
536 return NET_XMIT_SUCCESS;
537
538drop:
539#endif
540 kfree_skb(skb);
541 return NET_XMIT_DROP;
542}
543
e9bef55d
JDB
544/* Length to Time (L2T) lookup in a qdisc_rate_table, to determine how
545 long it will take to send a packet given its size.
546 */
547static inline u32 qdisc_l2t(struct qdisc_rate_table* rtab, unsigned int pktlen)
548{
e08b0998
JDB
549 int slot = pktlen + rtab->rate.cell_align + rtab->rate.overhead;
550 if (slot < 0)
551 slot = 0;
e9bef55d
JDB
552 slot >>= rtab->rate.cell_log;
553 if (slot > 255)
554 return (rtab->data[255]*(slot >> 8) + rtab->data[slot & 0xFF]);
555 return rtab->data[slot];
556}
557
12da81d1
JHS
558#ifdef CONFIG_NET_CLS_ACT
559static inline struct sk_buff *skb_act_clone(struct sk_buff *skb, gfp_t gfp_mask)
560{
561 struct sk_buff *n = skb_clone(skb, gfp_mask);
562
563 if (n) {
564 n->tc_verd = SET_TC_VERD(n->tc_verd, 0);
565 n->tc_verd = CLR_TC_OK2MUNGE(n->tc_verd);
566 n->tc_verd = CLR_TC_MUNGED(n->tc_verd);
12da81d1
JHS
567 }
568 return n;
569}
570#endif
571
1da177e4 572#endif