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 struct Qdisc
  27 {
  28         int                     (*enqueue)(struct sk_buff *skb, struct Qdisc *dev);
  29         struct sk_buff *        (*dequeue)(struct Qdisc *dev);
  30         unsigned                flags;
  31 #define TCQ_F_BUILTIN   1
  32 #define TCQ_F_THROTTLED 2
  33 #define TCQ_F_INGRESS   4
  34         int                     padded;
  35         struct Qdisc_ops        *ops;
  36         u32                     handle;
  37         u32                     parent;
  38         atomic_t                refcnt;
  39         struct sk_buff          *gso_skb;
  40         struct sk_buff_head     q;
  41         struct netdev_queue     *dev_queue;
  42         struct list_head        list;
  43
  44         struct gnet_stats_basic bstats;
  45         struct gnet_stats_queue qstats;
  46         struct gnet_stats_rate_est      rate_est;
  47         struct rcu_head         q_rcu;
  48         int                     (*reshape_fail)(struct sk_buff *skb,
  49                                         struct Qdisc *q);
  50
  51         /* This field is deprecated, but it is still used by CBQ
  52          * and it will live until better solution will be invented.
  53          */
  54         struct Qdisc            *__parent;
  55 };
  56
  57 struct Qdisc_class_ops
  58 {
  59         /* Child qdisc manipulation */
  60         int                     (*graft)(struct Qdisc *, unsigned long cl,
  61                                         struct Qdisc *, struct Qdisc **);
  62         struct Qdisc *          (*leaf)(struct Qdisc *, unsigned long cl);
  63         void                    (*qlen_notify)(struct Qdisc *, unsigned long);
  64
  65         /* Class manipulation routines */
  66         unsigned long           (*get)(struct Qdisc *, u32 classid);
  67         void                    (*put)(struct Qdisc *, unsigned long);
  68         int                     (*change)(struct Qdisc *, u32, u32,
  69                                         struct nlattr **, unsigned long *);
  70         int                     (*delete)(struct Qdisc *, unsigned long);
  71         void                    (*walk)(struct Qdisc *, struct qdisc_walker * arg);
  72
  73         /* Filter manipulation */
  74         struct tcf_proto **     (*tcf_chain)(struct Qdisc *, unsigned long);
  75         unsigned long           (*bind_tcf)(struct Qdisc *, unsigned long,
  76                                         u32 classid);
  77         void                    (*unbind_tcf)(struct Qdisc *, unsigned long);
  78
  79         /* rtnetlink specific */
  80         int                     (*dump)(struct Qdisc *, unsigned long,
  81                                         struct sk_buff *skb, struct tcmsg*);
  82         int                     (*dump_stats)(struct Qdisc *, unsigned long,
  83                                         struct gnet_dump *);
  84 };
  85
  86 struct Qdisc_ops
  87 {
  88         struct Qdisc_ops        *next;
  89         const struct Qdisc_class_ops    *cl_ops;
  90         char                    id[IFNAMSIZ];
  91         int                     priv_size;
  92
  93         int                     (*enqueue)(struct sk_buff *, struct Qdisc *);
  94         struct sk_buff *        (*dequeue)(struct Qdisc *);
  95         int                     (*requeue)(struct sk_buff *, struct Qdisc *);
  96         unsigned int            (*drop)(struct Qdisc *);
  97
  98         int                     (*init)(struct Qdisc *, struct nlattr *arg);
  99         void                    (*reset)(struct Qdisc *);
 100         void                    (*destroy)(struct Qdisc *);
 101         int                     (*change)(struct Qdisc *, struct nlattr *arg);
 102
 103         int                     (*dump)(struct Qdisc *, struct sk_buff *);
 104         int                     (*dump_stats)(struct Qdisc *, struct gnet_dump *);
 105
 106         struct module           *owner;
 107 };
 108
 109
 110 struct tcf_result
 111 {
 112         unsigned long   class;
 113         u32             classid;
 114 };
 115
 116 struct tcf_proto_ops
 117 {
 118         struct tcf_proto_ops    *next;
 119         char                    kind[IFNAMSIZ];
 120
 121         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
 122                                         struct tcf_result *);
 123         int                     (*init)(struct tcf_proto*);
 124         void                    (*destroy)(struct tcf_proto*);
 125
 126         unsigned long           (*get)(struct tcf_proto*, u32 handle);
 127         void                    (*put)(struct tcf_proto*, unsigned long);
 128         int                     (*change)(struct tcf_proto*, unsigned long,
 129                                         u32 handle, struct nlattr **,
 130                                         unsigned long *);
 131         int                     (*delete)(struct tcf_proto*, unsigned long);
 132         void                    (*walk)(struct tcf_proto*, struct tcf_walker *arg);
 133
 134         /* rtnetlink specific */
 135         int                     (*dump)(struct tcf_proto*, unsigned long,
 136                                         struct sk_buff *skb, struct tcmsg*);
 137
 138         struct module           *owner;
 139 };
 140
 141 struct tcf_proto
 142 {
 143         /* Fast access part */
 144         struct tcf_proto        *next;
 145         void                    *root;
 146         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
 147                                         struct tcf_result *);
 148         __be16                  protocol;
 149
 150         /* All the rest */
 151         u32                     prio;
 152         u32                     classid;
 153         struct Qdisc            *q;
 154         void                    *data;
 155         struct tcf_proto_ops    *ops;
 156 };
 157
 158 static inline struct net_device *qdisc_dev(struct Qdisc *qdisc)
 159 {
 160         return qdisc->dev_queue->dev;
 161 }
 162
 163 extern void qdisc_lock_tree(struct net_device *dev);
 164 extern void qdisc_unlock_tree(struct net_device *dev);
 165
 166 #define sch_tree_lock(q)        qdisc_lock_tree(qdisc_dev(q))
 167 #define sch_tree_unlock(q)      qdisc_unlock_tree(qdisc_dev(q))
 168 #define tcf_tree_lock(tp)       qdisc_lock_tree(qdisc_dev((tp)->q))
 169 #define tcf_tree_unlock(tp)     qdisc_unlock_tree(qdisc_dev((tp)->q))
 170
 171 extern struct Qdisc noop_qdisc;
 172 extern struct Qdisc_ops noop_qdisc_ops;
 173
 174 struct Qdisc_class_common
 175 {
 176         u32                     classid;
 177         struct hlist_node       hnode;
 178 };
 179
 180 struct Qdisc_class_hash
 181 {
 182         struct hlist_head       *hash;
 183         unsigned int            hashsize;
 184         unsigned int            hashmask;
 185         unsigned int            hashelems;
 186 };
 187
 188 static inline unsigned int qdisc_class_hash(u32 id, u32 mask)
 189 {
 190         id ^= id >> 8;
 191         id ^= id >> 4;
 192         return id & mask;
 193 }
 194
 195 static inline struct Qdisc_class_common *
 196 qdisc_class_find(struct Qdisc_class_hash *hash, u32 id)
 197 {
 198         struct Qdisc_class_common *cl;
 199         struct hlist_node *n;
 200         unsigned int h;
 201
 202         h = qdisc_class_hash(id, hash->hashmask);
 203         hlist_for_each_entry(cl, n, &hash->hash[h], hnode) {
 204                 if (cl->classid == id)
 205                         return cl;
 206         }
 207         return NULL;
 208 }
 209
 210 extern int qdisc_class_hash_init(struct Qdisc_class_hash *);
 211 extern void qdisc_class_hash_insert(struct Qdisc_class_hash *, struct Qdisc_class_common *);
 212 extern void qdisc_class_hash_remove(struct Qdisc_class_hash *, struct Qdisc_class_common *);
 213 extern void qdisc_class_hash_grow(struct Qdisc *, struct Qdisc_class_hash *);
 214 extern void qdisc_class_hash_destroy(struct Qdisc_class_hash *);
 215
 216 extern void dev_init_scheduler(struct net_device *dev);
 217 extern void dev_shutdown(struct net_device *dev);
 218 extern void dev_activate(struct net_device *dev);
 219 extern void dev_deactivate(struct net_device *dev);
 220 extern void qdisc_reset(struct Qdisc *qdisc);
 221 extern void qdisc_destroy(struct Qdisc *qdisc);
 222 extern void qdisc_tree_decrease_qlen(struct Qdisc *qdisc, unsigned int n);
 223 extern struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
 224                                  struct Qdisc_ops *ops);
 225 extern struct Qdisc *qdisc_create_dflt(struct net_device *dev,
 226                                        struct netdev_queue *dev_queue,
 227                                        struct Qdisc_ops *ops, u32 parentid);
 228 extern void tcf_destroy(struct tcf_proto *tp);
 229 extern void tcf_destroy_chain(struct tcf_proto **fl);
 230
 231 /* Reset all TX qdiscs of a device.  */
 232 static inline void qdisc_reset_all_tx(struct net_device *dev)
 233 {
 234         unsigned int i;
 235         for (i = 0; i < dev->num_tx_queues; i++)
 236                 qdisc_reset(netdev_get_tx_queue(dev, i)->qdisc);
 237 }
 238
 239 /* Are all TX queues of the device empty?  */
 240 static inline bool qdisc_all_tx_empty(const struct net_device *dev)
 241 {
 242         unsigned int i;
 243         for (i = 0; i < dev->num_tx_queues; i++) {
 244                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
 245                 const struct Qdisc *q = txq->qdisc;
 246
 247                 if (q->q.qlen)
 248                         return false;
 249         }
 250         return true;
 251 }
 252
 253 /* Are any of the TX qdiscs changing?  */
 254 static inline bool qdisc_tx_changing(struct net_device *dev)
 255 {
 256         unsigned int i;
 257         for (i = 0; i < dev->num_tx_queues; i++) {
 258                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
 259                 if (txq->qdisc != txq->qdisc_sleeping)
 260                         return true;
 261         }
 262         return false;
 263 }
 264
 265 /* Is the device using the noop qdisc on all queues?  */
 266 static inline bool qdisc_tx_is_noop(const struct net_device *dev)
 267 {
 268         unsigned int i;
 269         for (i = 0; i < dev->num_tx_queues; i++) {
 270                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
 271                 if (txq->qdisc != &noop_qdisc)
 272                         return false;
 273         }
 274         return true;
 275 }
 276
 277 static inline int __qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch,
 278                                        struct sk_buff_head *list)
 279 {
 280         __skb_queue_tail(list, skb);
 281         sch->qstats.backlog += skb->len;
 282         sch->bstats.bytes += skb->len;
 283         sch->bstats.packets++;
 284
 285         return NET_XMIT_SUCCESS;
 286 }
 287
 288 static inline int qdisc_enqueue_tail(struct sk_buff *skb, struct Qdisc *sch)
 289 {
 290         return __qdisc_enqueue_tail(skb, sch, &sch->q);
 291 }
 292
 293 static inline struct sk_buff *__qdisc_dequeue_head(struct Qdisc *sch,
 294                                                    struct sk_buff_head *list)
 295 {
 296         struct sk_buff *skb = __skb_dequeue(list);
 297
 298         if (likely(skb != NULL))
 299                 sch->qstats.backlog -= skb->len;
 300
 301         return skb;
 302 }
 303
 304 static inline struct sk_buff *qdisc_dequeue_head(struct Qdisc *sch)
 305 {
 306         return __qdisc_dequeue_head(sch, &sch->q);
 307 }
 308
 309 static inline struct sk_buff *__qdisc_dequeue_tail(struct Qdisc *sch,
 310                                                    struct sk_buff_head *list)
 311 {
 312         struct sk_buff *skb = __skb_dequeue_tail(list);
 313
 314         if (likely(skb != NULL))
 315                 sch->qstats.backlog -= skb->len;
 316
 317         return skb;
 318 }
 319
 320 static inline struct sk_buff *qdisc_dequeue_tail(struct Qdisc *sch)
 321 {
 322         return __qdisc_dequeue_tail(sch, &sch->q);
 323 }
 324
 325 static inline int __qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch,
 326                                   struct sk_buff_head *list)
 327 {
 328         __skb_queue_head(list, skb);
 329         sch->qstats.backlog += skb->len;
 330         sch->qstats.requeues++;
 331
 332         return NET_XMIT_SUCCESS;
 333 }
 334
 335 static inline int qdisc_requeue(struct sk_buff *skb, struct Qdisc *sch)
 336 {
 337         return __qdisc_requeue(skb, sch, &sch->q);
 338 }
 339
 340 static inline void __qdisc_reset_queue(struct Qdisc *sch,
 341                                        struct sk_buff_head *list)
 342 {
 343         /*
 344          * We do not know the backlog in bytes of this list, it
 345          * is up to the caller to correct it
 346          */
 347         skb_queue_purge(list);
 348 }
 349
 350 static inline void qdisc_reset_queue(struct Qdisc *sch)
 351 {
 352         __qdisc_reset_queue(sch, &sch->q);
 353         sch->qstats.backlog = 0;
 354 }
 355
 356 static inline unsigned int __qdisc_queue_drop(struct Qdisc *sch,
 357                                               struct sk_buff_head *list)
 358 {
 359         struct sk_buff *skb = __qdisc_dequeue_tail(sch, list);
 360
 361         if (likely(skb != NULL)) {
 362                 unsigned int len = skb->len;
 363                 kfree_skb(skb);
 364                 return len;
 365         }
 366
 367         return 0;
 368 }
 369
 370 static inline unsigned int qdisc_queue_drop(struct Qdisc *sch)
 371 {
 372         return __qdisc_queue_drop(sch, &sch->q);
 373 }
 374
 375 static inline int qdisc_drop(struct sk_buff *skb, struct Qdisc *sch)
 376 {
 377         kfree_skb(skb);
 378         sch->qstats.drops++;
 379
 380         return NET_XMIT_DROP;
 381 }
 382
 383 static inline int qdisc_reshape_fail(struct sk_buff *skb, struct Qdisc *sch)
 384 {
 385         sch->qstats.drops++;
 386
 387 #ifdef CONFIG_NET_CLS_ACT
 388         if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
 389                 goto drop;
 390
 391         return NET_XMIT_SUCCESS;
 392
 393 drop:
 394 #endif
 395         kfree_skb(skb);
 396         return NET_XMIT_DROP;
 397 }
 398
 399 /* Length to Time (L2T) lookup in a qdisc_rate_table, to determine how
 400    long it will take to send a packet given its size.
 401  */
 402 static inline u32 qdisc_l2t(struct qdisc_rate_table* rtab, unsigned int pktlen)
 403 {
 404         int slot = pktlen + rtab->rate.cell_align + rtab->rate.overhead;
 405         if (slot < 0)
 406                 slot = 0;
 407         slot >>= rtab->rate.cell_log;
 408         if (slot > 255)
 409                 return (rtab->data[255]*(slot >> 8) + rtab->data[slot & 0xFF]);
 410         return rtab->data[slot];
 411 }
 412
 413 #ifdef CONFIG_NET_CLS_ACT
 414 static inline struct sk_buff *skb_act_clone(struct sk_buff *skb, gfp_t gfp_mask)
 415 {
 416         struct sk_buff *n = skb_clone(skb, gfp_mask);
 417
 418         if (n) {
 419                 n->tc_verd = SET_TC_VERD(n->tc_verd, 0);
 420                 n->tc_verd = CLR_TC_OK2MUNGE(n->tc_verd);
 421                 n->tc_verd = CLR_TC_MUNGED(n->tc_verd);
 422         }
 423         return n;
 424 }
 425 #endif
 426
 427 #endif