pkt_sched: Add 'deactivated' state.
[safe/jmp/linux-2.6] / 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     q;
57         struct netdev_queue     *dev_queue;
58         struct Qdisc            *next_sched;
59         struct list_head        list;
60
61         struct gnet_stats_basic bstats;
62         struct gnet_stats_queue qstats;
63         struct gnet_stats_rate_est      rate_est;
64         struct rcu_head         q_rcu;
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         int                     (*requeue)(struct sk_buff *, struct Qdisc *);
115         unsigned int            (*drop)(struct Qdisc *);
116
117         int                     (*init)(struct Qdisc *, struct nlattr *arg);
118         void                    (*reset)(struct Qdisc *);
119         void                    (*destroy)(struct Qdisc *);
120         int                     (*change)(struct Qdisc *, struct nlattr *arg);
121
122         int                     (*dump)(struct Qdisc *, struct sk_buff *);
123         int                     (*dump_stats)(struct Qdisc *, struct gnet_dump *);
124
125         struct module           *owner;
126 };
127
128
129 struct tcf_result
130 {
131         unsigned long   class;
132         u32             classid;
133 };
134
135 struct tcf_proto_ops
136 {
137         struct tcf_proto_ops    *next;
138         char                    kind[IFNAMSIZ];
139
140         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
141                                         struct tcf_result *);
142         int                     (*init)(struct tcf_proto*);
143         void                    (*destroy)(struct tcf_proto*);
144
145         unsigned long           (*get)(struct tcf_proto*, u32 handle);
146         void                    (*put)(struct tcf_proto*, unsigned long);
147         int                     (*change)(struct tcf_proto*, unsigned long,
148                                         u32 handle, struct nlattr **,
149                                         unsigned long *);
150         int                     (*delete)(struct tcf_proto*, unsigned long);
151         void                    (*walk)(struct tcf_proto*, struct tcf_walker *arg);
152
153         /* rtnetlink specific */
154         int                     (*dump)(struct tcf_proto*, unsigned long,
155                                         struct sk_buff *skb, struct tcmsg*);
156
157         struct module           *owner;
158 };
159
160 struct tcf_proto
161 {
162         /* Fast access part */
163         struct tcf_proto        *next;
164         void                    *root;
165         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
166                                         struct tcf_result *);
167         __be16                  protocol;
168
169         /* All the rest */
170         u32                     prio;
171         u32                     classid;
172         struct Qdisc            *q;
173         void                    *data;
174         struct tcf_proto_ops    *ops;
175 };
176
177 struct qdisc_skb_cb {
178         unsigned int            pkt_len;
179         char                    data[];
180 };
181
182 static inline struct qdisc_skb_cb *qdisc_skb_cb(struct sk_buff *skb)
183 {
184         return (struct qdisc_skb_cb *)skb->cb;
185 }
186
187 static inline spinlock_t *qdisc_lock(struct Qdisc *qdisc)
188 {
189         return &qdisc->q.lock;
190 }
191
192 static inline struct Qdisc *qdisc_root(struct Qdisc *qdisc)
193 {
194         return qdisc->dev_queue->qdisc;
195 }
196
197 /* The qdisc root lock is a mechanism by which to top level
198  * of a qdisc tree can be locked from any qdisc node in the
199  * forest.  This allows changing the configuration of some
200  * aspect of the qdisc tree while blocking out asynchronous
201  * qdisc access in the packet processing paths.
202  *
203  * It is only legal to do this when the root will not change
204  * on us.  Otherwise we'll potentially lock the wrong qdisc
205  * root.  This is enforced by holding the RTNL semaphore, which
206  * all users of this lock accessor must do.
207  */
208 static inline spinlock_t *qdisc_root_lock(struct Qdisc *qdisc)
209 {
210         struct Qdisc *root = qdisc_root(qdisc);
211
212         ASSERT_RTNL();
213         return qdisc_lock(root);
214 }
215
216 static inline struct net_device *qdisc_dev(struct Qdisc *qdisc)
217 {
218         return qdisc->dev_queue->dev;
219 }
220
221 static inline void sch_tree_lock(struct Qdisc *q)
222 {
223         spin_lock_bh(qdisc_root_lock(q));
224 }
225
226 static inline void sch_tree_unlock(struct Qdisc *q)
227 {
228         spin_unlock_bh(qdisc_root_lock(q));
229 }
230
231 #define tcf_tree_lock(tp)       sch_tree_lock((tp)->q)
232 #define tcf_tree_unlock(tp)     sch_tree_unlock((tp)->q)
233
234 extern struct Qdisc noop_qdisc;
235 extern struct Qdisc_ops noop_qdisc_ops;
236
237 struct Qdisc_class_common
238 {
239         u32                     classid;
240         struct hlist_node       hnode;
241 };
242
243 struct Qdisc_class_hash
244 {
245         struct hlist_head       *hash;
246         unsigned int            hashsize;
247         unsigned int            hashmask;
248         unsigned int            hashelems;
249 };
250
251 static inline unsigned int qdisc_class_hash(u32 id, u32 mask)
252 {
253         id ^= id >> 8;
254         id ^= id >> 4;
255         return id & mask;
256 }
257
258 static inline struct Qdisc_class_common *
259 qdisc_class_find(struct Qdisc_class_hash *hash, u32 id)
260 {
261         struct Qdisc_class_common *cl;
262         struct hlist_node *n;
263         unsigned int h;
264
265         h = qdisc_class_hash(id, hash->hashmask);
266         hlist_for_each_entry(cl, n, &hash->hash[h], hnode) {
267                 if (cl->classid == id)
268                         return cl;
269         }
270         return NULL;
271 }
272
273 extern int qdisc_class_hash_init(struct Qdisc_class_hash *);
274 extern void qdisc_class_hash_insert(struct Qdisc_class_hash *, struct Qdisc_class_common *);
275 extern void qdisc_class_hash_remove(struct Qdisc_class_hash *, struct Qdisc_class_common *);
276 extern void qdisc_class_hash_grow(struct Qdisc *, struct Qdisc_class_hash *);
277 extern void qdisc_class_hash_destroy(struct Qdisc_class_hash *);
278
279 extern void dev_init_scheduler(struct net_device *dev);
280 extern void dev_shutdown(struct net_device *dev);
281 extern void dev_activate(struct net_device *dev);
282 extern void dev_deactivate(struct net_device *dev);
283 extern void qdisc_reset(struct Qdisc *qdisc);
284 extern void qdisc_destroy(struct Qdisc *qdisc);
285 extern void qdisc_tree_decrease_qlen(struct Qdisc *qdisc, unsigned int n);
286 extern struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
287                                  struct Qdisc_ops *ops);
288 extern struct Qdisc *qdisc_create_dflt(struct net_device *dev,
289                                        struct netdev_queue *dev_queue,
290                                        struct Qdisc_ops *ops, u32 parentid);
291 extern void qdisc_calculate_pkt_len(struct sk_buff *skb,
292                                    struct qdisc_size_table *stab);
293 extern void tcf_destroy(struct tcf_proto *tp);
294 extern void tcf_destroy_chain(struct tcf_proto **fl);
295
296 /* Reset all TX qdiscs of a device.  */
297 static inline void qdisc_reset_all_tx(struct net_device *dev)
298 {
299         unsigned int i;
300         for (i = 0; i < dev->num_tx_queues; i++)
301                 qdisc_reset(netdev_get_tx_queue(dev, i)->qdisc);
302 }
303
304 /* Are all TX queues of the device empty?  */
305 static inline bool qdisc_all_tx_empty(const struct net_device *dev)
306 {
307         unsigned int i;
308         for (i = 0; i < dev->num_tx_queues; i++) {
309                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
310                 const struct Qdisc *q = txq->qdisc;
311
312                 if (q->q.qlen)
313                         return false;
314         }
315         return true;
316 }
317
318 /* Are any of the TX qdiscs changing?  */
319 static inline bool qdisc_tx_changing(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                 if (txq->qdisc != txq->qdisc_sleeping)
325                         return true;
326         }
327         return false;
328 }
329
330 /* Is the device using the noop qdisc on all queues?  */
331 static inline bool qdisc_tx_is_noop(const struct net_device *dev)
332 {
333         unsigned int i;
334         for (i = 0; i < dev->num_tx_queues; i++) {
335                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
336                 if (txq->qdisc != &noop_qdisc)
337                         return false;
338         }
339         return true;
340 }
341
342 static inline unsigned int qdisc_pkt_len(struct sk_buff *skb)
343 {
344         return qdisc_skb_cb(skb)->pkt_len;
345 }
346
347 /* additional qdisc xmit flags (NET_XMIT_MASK in linux/netdevice.h) */
348 enum net_xmit_qdisc_t {
349         __NET_XMIT_STOLEN = 0x00010000,
350         __NET_XMIT_BYPASS = 0x00020000,
351 };
352
353 #ifdef CONFIG_NET_CLS_ACT
354 #define net_xmit_drop_count(e)  ((e) & __NET_XMIT_STOLEN ? 0 : 1)
355 #else
356 #define net_xmit_drop_count(e)  (1)
357 #endif
358
359 static inline int qdisc_enqueue(struct sk_buff *skb, struct Qdisc *sch)
360 {
361 #ifdef CONFIG_NET_SCHED
362         if (sch->stab)
363                 qdisc_calculate_pkt_len(skb, sch->stab);
364 #endif
365         return sch->enqueue(skb, sch);
366 }
367
368 static inline int qdisc_enqueue_root(struct sk_buff *skb, struct Qdisc *sch)
369 {
370         qdisc_skb_cb(skb)->pkt_len = skb->len;
371         return qdisc_enqueue(skb, sch) & NET_XMIT_MASK;
372 }
373
374 static inline int __qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch,
375                                        struct sk_buff_head *list)
376 {
377         __skb_queue_tail(list, skb);
378         sch->qstats.backlog += qdisc_pkt_len(skb);
379         sch->bstats.bytes += qdisc_pkt_len(skb);
380         sch->bstats.packets++;
381
382         return NET_XMIT_SUCCESS;
383 }
384
385 static inline int qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch)
386 {
387         return __qdisc_enqueue_tail(skb, sch, &sch->q);
388 }
389
390 static inline struct sk_buff *__qdisc_dequeue_head(struct Qdisc *sch,
391                                                    struct sk_buff_head *list)
392 {
393         struct sk_buff *skb = __skb_dequeue(list);
394
395         if (likely(skb != NULL))
396                 sch->qstats.backlog -= qdisc_pkt_len(skb);
397
398         return skb;
399 }
400
401 static inline struct sk_buff *qdisc_dequeue_head(struct Qdisc *sch)
402 {
403         return __qdisc_dequeue_head(sch, &sch->q);
404 }
405
406 static inline struct sk_buff *__qdisc_dequeue_tail(struct Qdisc *sch,
407                                                    struct sk_buff_head *list)
408 {
409         struct sk_buff *skb = __skb_dequeue_tail(list);
410
411         if (likely(skb != NULL))
412                 sch->qstats.backlog -= qdisc_pkt_len(skb);
413
414         return skb;
415 }
416
417 static inline struct sk_buff *qdisc_dequeue_tail(struct Qdisc *sch)
418 {
419         return __qdisc_dequeue_tail(sch, &sch->q);
420 }
421
422 static inline int __qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch,
423                                   struct sk_buff_head *list)
424 {
425         __skb_queue_head(list, skb);
426         sch->qstats.backlog += qdisc_pkt_len(skb);
427         sch->qstats.requeues++;
428
429         return NET_XMIT_SUCCESS;
430 }
431
432 static inline int qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch)
433 {
434         return __qdisc_requeue(skb, sch, &sch->q);
435 }
436
437 static inline void __qdisc_reset_queue(struct Qdisc *sch,
438                                        struct sk_buff_head *list)
439 {
440         /*
441          * We do not know the backlog in bytes of this list, it
442          * is up to the caller to correct it
443          */
444         __skb_queue_purge(list);
445 }
446
447 static inline void qdisc_reset_queue(struct Qdisc *sch)
448 {
449         __qdisc_reset_queue(sch, &sch->q);
450         sch->qstats.backlog = 0;
451 }
452
453 static inline unsigned int __qdisc_queue_drop(struct Qdisc *sch,
454                                               struct sk_buff_head *list)
455 {
456         struct sk_buff *skb = __qdisc_dequeue_tail(sch, list);
457
458         if (likely(skb != NULL)) {
459                 unsigned int len = qdisc_pkt_len(skb);
460                 kfree_skb(skb);
461                 return len;
462         }
463
464         return 0;
465 }
466
467 static inline unsigned int qdisc_queue_drop(struct Qdisc *sch)
468 {
469         return __qdisc_queue_drop(sch, &sch->q);
470 }
471
472 static inline int qdisc_drop(struct sk_buff *skb, struct Qdisc *sch)
473 {
474         kfree_skb(skb);
475         sch->qstats.drops++;
476
477         return NET_XMIT_DROP;
478 }
479
480 static inline int qdisc_reshape_fail(struct sk_buff *skb, struct Qdisc *sch)
481 {
482         sch->qstats.drops++;
483
484 #ifdef CONFIG_NET_CLS_ACT
485         if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
486                 goto drop;
487
488         return NET_XMIT_SUCCESS;
489
490 drop:
491 #endif
492         kfree_skb(skb);
493         return NET_XMIT_DROP;
494 }
495
496 /* Length to Time (L2T) lookup in a qdisc_rate_table, to determine how
497    long it will take to send a packet given its size.
498  */
499 static inline u32 qdisc_l2t(struct qdisc_rate_table* rtab, unsigned int pktlen)
500 {
501         int slot = pktlen + rtab->rate.cell_align + rtab->rate.overhead;
502         if (slot < 0)
503                 slot = 0;
504         slot >>= rtab->rate.cell_log;
505         if (slot > 255)
506                 return (rtab->data[255]*(slot >> 8) + rtab->data[slot & 0xFF]);
507         return rtab->data[slot];
508 }
509
510 #ifdef CONFIG_NET_CLS_ACT
511 static inline struct sk_buff *skb_act_clone(struct sk_buff *skb, gfp_t gfp_mask)
512 {
513         struct sk_buff *n = skb_clone(skb, gfp_mask);
514
515         if (n) {
516                 n->tc_verd = SET_TC_VERD(n->tc_verd, 0);
517                 n->tc_verd = CLR_TC_OK2MUNGE(n->tc_verd);
518                 n->tc_verd = CLR_TC_MUNGED(n->tc_verd);
519         }
520         return n;
521 }
522 #endif
523
524 #endif