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