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