migrate_timers: add comment, use spinlock_irq()
[linux-2.6/mini2440.git] / include / net / sch_generic.h
blob84d25f2e6188764931268b5b6b6a3b70e4516c18
1 #ifndef __NET_SCHED_GENERIC_H
2 #define __NET_SCHED_GENERIC_H
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>
13 struct Qdisc_ops;
14 struct qdisc_walker;
15 struct tcf_walker;
16 struct module;
18 struct qdisc_rate_table
20 struct tc_ratespec rate;
21 u32 data[256];
22 struct qdisc_rate_table *next;
23 int refcnt;
26 enum qdisc_state_t
28 __QDISC_STATE_RUNNING,
29 __QDISC_STATE_SCHED,
30 __QDISC_STATE_DEACTIVATED,
33 struct qdisc_size_table {
34 struct list_head list;
35 struct tc_sizespec szopts;
36 int refcnt;
37 u16 data[];
40 struct Qdisc
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;
61 struct gnet_stats_basic bstats;
62 struct gnet_stats_queue qstats;
63 struct gnet_stats_rate_est rate_est;
64 int (*reshape_fail)(struct sk_buff *skb,
65 struct Qdisc *q);
67 void *u32_node;
69 /* This field is deprecated, but it is still used by CBQ
70 * and it will live until better solution will be invented.
72 struct Qdisc *__parent;
75 struct Qdisc_class_ops
77 /* Child qdisc manipulation */
78 int (*graft)(struct Qdisc *, unsigned long cl,
79 struct Qdisc *, struct Qdisc **);
80 struct Qdisc * (*leaf)(struct Qdisc *, unsigned long cl);
81 void (*qlen_notify)(struct Qdisc *, unsigned long);
83 /* Class manipulation routines */
84 unsigned long (*get)(struct Qdisc *, u32 classid);
85 void (*put)(struct Qdisc *, unsigned long);
86 int (*change)(struct Qdisc *, u32, u32,
87 struct nlattr **, unsigned long *);
88 int (*delete)(struct Qdisc *, unsigned long);
89 void (*walk)(struct Qdisc *, struct qdisc_walker * arg);
91 /* Filter manipulation */
92 struct tcf_proto ** (*tcf_chain)(struct Qdisc *, unsigned long);
93 unsigned long (*bind_tcf)(struct Qdisc *, unsigned long,
94 u32 classid);
95 void (*unbind_tcf)(struct Qdisc *, unsigned long);
97 /* rtnetlink specific */
98 int (*dump)(struct Qdisc *, unsigned long,
99 struct sk_buff *skb, struct tcmsg*);
100 int (*dump_stats)(struct Qdisc *, unsigned long,
101 struct gnet_dump *);
104 struct Qdisc_ops
106 struct Qdisc_ops *next;
107 const struct Qdisc_class_ops *cl_ops;
108 char id[IFNAMSIZ];
109 int priv_size;
111 int (*enqueue)(struct sk_buff *, struct Qdisc *);
112 struct sk_buff * (*dequeue)(struct Qdisc *);
113 int (*requeue)(struct sk_buff *, struct Qdisc *);
114 unsigned int (*drop)(struct Qdisc *);
116 int (*init)(struct Qdisc *, struct nlattr *arg);
117 void (*reset)(struct Qdisc *);
118 void (*destroy)(struct Qdisc *);
119 int (*change)(struct Qdisc *, struct nlattr *arg);
121 int (*dump)(struct Qdisc *, struct sk_buff *);
122 int (*dump_stats)(struct Qdisc *, struct gnet_dump *);
124 struct module *owner;
128 struct tcf_result
130 unsigned long class;
131 u32 classid;
134 struct tcf_proto_ops
136 struct tcf_proto_ops *next;
137 char kind[IFNAMSIZ];
139 int (*classify)(struct sk_buff*, struct tcf_proto*,
140 struct tcf_result *);
141 int (*init)(struct tcf_proto*);
142 void (*destroy)(struct tcf_proto*);
144 unsigned long (*get)(struct tcf_proto*, u32 handle);
145 void (*put)(struct tcf_proto*, unsigned long);
146 int (*change)(struct tcf_proto*, unsigned long,
147 u32 handle, struct nlattr **,
148 unsigned long *);
149 int (*delete)(struct tcf_proto*, unsigned long);
150 void (*walk)(struct tcf_proto*, struct tcf_walker *arg);
152 /* rtnetlink specific */
153 int (*dump)(struct tcf_proto*, unsigned long,
154 struct sk_buff *skb, struct tcmsg*);
156 struct module *owner;
159 struct tcf_proto
161 /* Fast access part */
162 struct tcf_proto *next;
163 void *root;
164 int (*classify)(struct sk_buff*, struct tcf_proto*,
165 struct tcf_result *);
166 __be16 protocol;
168 /* All the rest */
169 u32 prio;
170 u32 classid;
171 struct Qdisc *q;
172 void *data;
173 struct tcf_proto_ops *ops;
176 struct qdisc_skb_cb {
177 unsigned int pkt_len;
178 char data[];
181 static inline struct qdisc_skb_cb *qdisc_skb_cb(struct sk_buff *skb)
183 return (struct qdisc_skb_cb *)skb->cb;
186 static inline spinlock_t *qdisc_lock(struct Qdisc *qdisc)
188 return &qdisc->q.lock;
191 static inline struct Qdisc *qdisc_root(struct Qdisc *qdisc)
193 return qdisc->dev_queue->qdisc;
196 /* The qdisc root lock is a mechanism by which to top level
197 * of a qdisc tree can be locked from any qdisc node in the
198 * forest. This allows changing the configuration of some
199 * aspect of the qdisc tree while blocking out asynchronous
200 * qdisc access in the packet processing paths.
202 * It is only legal to do this when the root will not change
203 * on us. Otherwise we'll potentially lock the wrong qdisc
204 * root. This is enforced by holding the RTNL semaphore, which
205 * all users of this lock accessor must do.
207 static inline spinlock_t *qdisc_root_lock(struct Qdisc *qdisc)
209 struct Qdisc *root = qdisc_root(qdisc);
211 ASSERT_RTNL();
212 return qdisc_lock(root);
215 static inline struct net_device *qdisc_dev(struct Qdisc *qdisc)
217 return qdisc->dev_queue->dev;
220 static inline void sch_tree_lock(struct Qdisc *q)
222 spin_lock_bh(qdisc_root_lock(q));
225 static inline void sch_tree_unlock(struct Qdisc *q)
227 spin_unlock_bh(qdisc_root_lock(q));
230 #define tcf_tree_lock(tp) sch_tree_lock((tp)->q)
231 #define tcf_tree_unlock(tp) sch_tree_unlock((tp)->q)
233 extern struct Qdisc noop_qdisc;
234 extern struct Qdisc_ops noop_qdisc_ops;
236 struct Qdisc_class_common
238 u32 classid;
239 struct hlist_node hnode;
242 struct Qdisc_class_hash
244 struct hlist_head *hash;
245 unsigned int hashsize;
246 unsigned int hashmask;
247 unsigned int hashelems;
250 static inline unsigned int qdisc_class_hash(u32 id, u32 mask)
252 id ^= id >> 8;
253 id ^= id >> 4;
254 return id & mask;
257 static inline struct Qdisc_class_common *
258 qdisc_class_find(struct Qdisc_class_hash *hash, u32 id)
260 struct Qdisc_class_common *cl;
261 struct hlist_node *n;
262 unsigned int h;
264 h = qdisc_class_hash(id, hash->hashmask);
265 hlist_for_each_entry(cl, n, &hash->hash[h], hnode) {
266 if (cl->classid == id)
267 return cl;
269 return NULL;
272 extern int qdisc_class_hash_init(struct Qdisc_class_hash *);
273 extern void qdisc_class_hash_insert(struct Qdisc_class_hash *, struct Qdisc_class_common *);
274 extern void qdisc_class_hash_remove(struct Qdisc_class_hash *, struct Qdisc_class_common *);
275 extern void qdisc_class_hash_grow(struct Qdisc *, struct Qdisc_class_hash *);
276 extern void qdisc_class_hash_destroy(struct Qdisc_class_hash *);
278 extern void dev_init_scheduler(struct net_device *dev);
279 extern void dev_shutdown(struct net_device *dev);
280 extern void dev_activate(struct net_device *dev);
281 extern void dev_deactivate(struct net_device *dev);
282 extern void qdisc_reset(struct Qdisc *qdisc);
283 extern void qdisc_destroy(struct Qdisc *qdisc);
284 extern void qdisc_tree_decrease_qlen(struct Qdisc *qdisc, unsigned int n);
285 extern struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
286 struct Qdisc_ops *ops);
287 extern struct Qdisc *qdisc_create_dflt(struct net_device *dev,
288 struct netdev_queue *dev_queue,
289 struct Qdisc_ops *ops, u32 parentid);
290 extern void qdisc_calculate_pkt_len(struct sk_buff *skb,
291 struct qdisc_size_table *stab);
292 extern void tcf_destroy(struct tcf_proto *tp);
293 extern void tcf_destroy_chain(struct tcf_proto **fl);
295 /* Reset all TX qdiscs of a device. */
296 static inline void qdisc_reset_all_tx(struct net_device *dev)
298 unsigned int i;
299 for (i = 0; i < dev->num_tx_queues; i++)
300 qdisc_reset(netdev_get_tx_queue(dev, i)->qdisc);
303 /* Are all TX queues of the device empty? */
304 static inline bool qdisc_all_tx_empty(const struct net_device *dev)
306 unsigned int i;
307 for (i = 0; i < dev->num_tx_queues; i++) {
308 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
309 const struct Qdisc *q = txq->qdisc;
311 if (q->q.qlen)
312 return false;
314 return true;
317 /* Are any of the TX qdiscs changing? */
318 static inline bool qdisc_tx_changing(struct net_device *dev)
320 unsigned int i;
321 for (i = 0; i < dev->num_tx_queues; i++) {
322 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
323 if (txq->qdisc != txq->qdisc_sleeping)
324 return true;
326 return false;
329 /* Is the device using the noop qdisc on all queues? */
330 static inline bool qdisc_tx_is_noop(const struct net_device *dev)
332 unsigned int i;
333 for (i = 0; i < dev->num_tx_queues; i++) {
334 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
335 if (txq->qdisc != &noop_qdisc)
336 return false;
338 return true;
341 static inline unsigned int qdisc_pkt_len(struct sk_buff *skb)
343 return qdisc_skb_cb(skb)->pkt_len;
346 /* additional qdisc xmit flags (NET_XMIT_MASK in linux/netdevice.h) */
347 enum net_xmit_qdisc_t {
348 __NET_XMIT_STOLEN = 0x00010000,
349 __NET_XMIT_BYPASS = 0x00020000,
352 #ifdef CONFIG_NET_CLS_ACT
353 #define net_xmit_drop_count(e) ((e) & __NET_XMIT_STOLEN ? 0 : 1)
354 #else
355 #define net_xmit_drop_count(e) (1)
356 #endif
358 static inline int qdisc_enqueue(struct sk_buff *skb, struct Qdisc *sch)
360 #ifdef CONFIG_NET_SCHED
361 if (sch->stab)
362 qdisc_calculate_pkt_len(skb, sch->stab);
363 #endif
364 return sch->enqueue(skb, sch);
367 static inline int qdisc_enqueue_root(struct sk_buff *skb, struct Qdisc *sch)
369 qdisc_skb_cb(skb)->pkt_len = skb->len;
370 return qdisc_enqueue(skb, sch) & NET_XMIT_MASK;
373 static inline int __qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch,
374 struct sk_buff_head *list)
376 __skb_queue_tail(list, skb);
377 sch->qstats.backlog += qdisc_pkt_len(skb);
378 sch->bstats.bytes += qdisc_pkt_len(skb);
379 sch->bstats.packets++;
381 return NET_XMIT_SUCCESS;
384 static inline int qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch)
386 return __qdisc_enqueue_tail(skb, sch, &sch->q);
389 static inline struct sk_buff *__qdisc_dequeue_head(struct Qdisc *sch,
390 struct sk_buff_head *list)
392 struct sk_buff *skb = __skb_dequeue(list);
394 if (likely(skb != NULL))
395 sch->qstats.backlog -= qdisc_pkt_len(skb);
397 return skb;
400 static inline struct sk_buff *qdisc_dequeue_head(struct Qdisc *sch)
402 return __qdisc_dequeue_head(sch, &sch->q);
405 static inline struct sk_buff *__qdisc_dequeue_tail(struct Qdisc *sch,
406 struct sk_buff_head *list)
408 struct sk_buff *skb = __skb_dequeue_tail(list);
410 if (likely(skb != NULL))
411 sch->qstats.backlog -= qdisc_pkt_len(skb);
413 return skb;
416 static inline struct sk_buff *qdisc_dequeue_tail(struct Qdisc *sch)
418 return __qdisc_dequeue_tail(sch, &sch->q);
421 static inline int __qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch,
422 struct sk_buff_head *list)
424 __skb_queue_head(list, skb);
425 sch->qstats.backlog += qdisc_pkt_len(skb);
426 sch->qstats.requeues++;
428 return NET_XMIT_SUCCESS;
431 static inline int qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch)
433 return __qdisc_requeue(skb, sch, &sch->q);
436 static inline void __qdisc_reset_queue(struct Qdisc *sch,
437 struct sk_buff_head *list)
440 * We do not know the backlog in bytes of this list, it
441 * is up to the caller to correct it
443 __skb_queue_purge(list);
446 static inline void qdisc_reset_queue(struct Qdisc *sch)
448 __qdisc_reset_queue(sch, &sch->q);
449 sch->qstats.backlog = 0;
452 static inline unsigned int __qdisc_queue_drop(struct Qdisc *sch,
453 struct sk_buff_head *list)
455 struct sk_buff *skb = __qdisc_dequeue_tail(sch, list);
457 if (likely(skb != NULL)) {
458 unsigned int len = qdisc_pkt_len(skb);
459 kfree_skb(skb);
460 return len;
463 return 0;
466 static inline unsigned int qdisc_queue_drop(struct Qdisc *sch)
468 return __qdisc_queue_drop(sch, &sch->q);
471 static inline int qdisc_drop(struct sk_buff *skb, struct Qdisc *sch)
473 kfree_skb(skb);
474 sch->qstats.drops++;
476 return NET_XMIT_DROP;
479 static inline int qdisc_reshape_fail(struct sk_buff *skb, struct Qdisc *sch)
481 sch->qstats.drops++;
483 #ifdef CONFIG_NET_CLS_ACT
484 if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
485 goto drop;
487 return NET_XMIT_SUCCESS;
489 drop:
490 #endif
491 kfree_skb(skb);
492 return NET_XMIT_DROP;
495 /* Length to Time (L2T) lookup in a qdisc_rate_table, to determine how
496 long it will take to send a packet given its size.
498 static inline u32 qdisc_l2t(struct qdisc_rate_table* rtab, unsigned int pktlen)
500 int slot = pktlen + rtab->rate.cell_align + rtab->rate.overhead;
501 if (slot < 0)
502 slot = 0;
503 slot >>= rtab->rate.cell_log;
504 if (slot > 255)
505 return (rtab->data[255]*(slot >> 8) + rtab->data[slot & 0xFF]);
506 return rtab->data[slot];
509 #ifdef CONFIG_NET_CLS_ACT
510 static inline struct sk_buff *skb_act_clone(struct sk_buff *skb, gfp_t gfp_mask)
512 struct sk_buff *n = skb_clone(skb, gfp_mask);
514 if (n) {
515 n->tc_verd = SET_TC_VERD(n->tc_verd, 0);
516 n->tc_verd = CLR_TC_OK2MUNGE(n->tc_verd);
517 n->tc_verd = CLR_TC_MUNGED(n->tc_verd);
519 return n;
521 #endif
523 #endif