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