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 #define TCQ_F_CAN_BYPASS        8
  49 #define TCQ_F_WARN_NONWC        (1 << 16)
  50         int                     padded;
  51         struct Qdisc_ops        *ops;
  52         struct qdisc_size_table *stab;
  53         struct list_head        list;
  54         u32                     handle;
  55         u32                     parent;
  56         atomic_t                refcnt;
  57         struct gnet_stats_rate_est      rate_est;
  58         int                     (*reshape_fail)(struct sk_buff *skb,
  59                                         struct Qdisc *q);
  60
  61         void                    *u32_node;
  62
  63         /* This field is deprecated, but it is still used by CBQ
  64          * and it will live until better solution will be invented.
  65          */
  66         struct Qdisc            *__parent;
  67         struct netdev_queue     *dev_queue;
  68         struct Qdisc            *next_sched;
  69
  70         struct sk_buff          *gso_skb;
  71         /*
  72          * For performance sake on SMP, we put highly modified fields at the end
  73          */
  74         unsigned long           state;
  75         struct sk_buff_head     q;
  76         struct gnet_stats_basic_packed bstats;
  77         struct gnet_stats_queue qstats;
  78 };
  79
  80 struct Qdisc_class_ops
  81 {
  82         /* Child qdisc manipulation */
  83         unsigned int            (*select_queue)(struct Qdisc *, struct tcmsg *);
  84         int                     (*graft)(struct Qdisc *, unsigned long cl,
  85                                         struct Qdisc *, struct Qdisc **);
  86         struct Qdisc *          (*leaf)(struct Qdisc *, unsigned long cl);
  87         void                    (*qlen_notify)(struct Qdisc *, unsigned long);
  88
  89         /* Class manipulation routines */
  90         unsigned long           (*get)(struct Qdisc *, u32 classid);
  91         void                    (*put)(struct Qdisc *, unsigned long);
  92         int                     (*change)(struct Qdisc *, u32, u32,
  93                                         struct nlattr **, unsigned long *);
  94         int                     (*delete)(struct Qdisc *, unsigned long);
  95         void                    (*walk)(struct Qdisc *, struct qdisc_walker * arg);
  96
  97         /* Filter manipulation */
  98         struct tcf_proto **     (*tcf_chain)(struct Qdisc *, unsigned long);
  99         unsigned long           (*bind_tcf)(struct Qdisc *, unsigned long,
 100                                         u32 classid);
 101         void                    (*unbind_tcf)(struct Qdisc *, unsigned long);
 102
 103         /* rtnetlink specific */
 104         int                     (*dump)(struct Qdisc *, unsigned long,
 105                                         struct sk_buff *skb, struct tcmsg*);
 106         int                     (*dump_stats)(struct Qdisc *, unsigned long,
 107                                         struct gnet_dump *);
 108 };
 109
 110 struct Qdisc_ops
 111 {
 112         struct Qdisc_ops        *next;
 113         const struct Qdisc_class_ops    *cl_ops;
 114         char                    id[IFNAMSIZ];
 115         int                     priv_size;
 116
 117         int                     (*enqueue)(struct sk_buff *, struct Qdisc *);
 118         struct sk_buff *        (*dequeue)(struct Qdisc *);
 119         struct sk_buff *        (*peek)(struct Qdisc *);
 120         unsigned int            (*drop)(struct Qdisc *);
 121
 122         int                     (*init)(struct Qdisc *, struct nlattr *arg);
 123         void                    (*reset)(struct Qdisc *);
 124         void                    (*destroy)(struct Qdisc *);
 125         int                     (*change)(struct Qdisc *, struct nlattr *arg);
 126         void                    (*attach)(struct Qdisc *);
 127
 128         int                     (*dump)(struct Qdisc *, struct sk_buff *);
 129         int                     (*dump_stats)(struct Qdisc *, struct gnet_dump *);
 130
 131         struct module           *owner;
 132 };
 133
 134
 135 struct tcf_result
 136 {
 137         unsigned long   class;
 138         u32             classid;
 139 };
 140
 141 struct tcf_proto_ops
 142 {
 143         struct tcf_proto_ops    *next;
 144         char                    kind[IFNAMSIZ];
 145
 146         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
 147                                         struct tcf_result *);
 148         int                     (*init)(struct tcf_proto*);
 149         void                    (*destroy)(struct tcf_proto*);
 150
 151         unsigned long           (*get)(struct tcf_proto*, u32 handle);
 152         void                    (*put)(struct tcf_proto*, unsigned long);
 153         int                     (*change)(struct tcf_proto*, unsigned long,
 154                                         u32 handle, struct nlattr **,
 155                                         unsigned long *);
 156         int                     (*delete)(struct tcf_proto*, unsigned long);
 157         void                    (*walk)(struct tcf_proto*, struct tcf_walker *arg);
 158
 159         /* rtnetlink specific */
 160         int                     (*dump)(struct tcf_proto*, unsigned long,
 161                                         struct sk_buff *skb, struct tcmsg*);
 162
 163         struct module           *owner;
 164 };
 165
 166 struct tcf_proto
 167 {
 168         /* Fast access part */
 169         struct tcf_proto        *next;
 170         void                    *root;
 171         int                     (*classify)(struct sk_buff*, struct tcf_proto*,
 172                                         struct tcf_result *);
 173         __be16                  protocol;
 174
 175         /* All the rest */
 176         u32                     prio;
 177         u32                     classid;
 178         struct Qdisc            *q;
 179         void                    *data;
 180         struct tcf_proto_ops    *ops;
 181 };
 182
 183 struct qdisc_skb_cb {
 184         unsigned int            pkt_len;
 185         char                    data[];
 186 };
 187
 188 static inline int qdisc_qlen(struct Qdisc *q)
 189 {
 190         return q->q.qlen;
 191 }
 192
 193 static inline struct qdisc_skb_cb *qdisc_skb_cb(struct sk_buff *skb)
 194 {
 195         return (struct qdisc_skb_cb *)skb->cb;
 196 }
 197
 198 static inline spinlock_t *qdisc_lock(struct Qdisc *qdisc)
 199 {
 200         return &qdisc->q.lock;
 201 }
 202
 203 static inline struct Qdisc *qdisc_root(struct Qdisc *qdisc)
 204 {
 205         return qdisc->dev_queue->qdisc;
 206 }
 207
 208 static inline struct Qdisc *qdisc_root_sleeping(struct Qdisc *qdisc)
 209 {
 210         return qdisc->dev_queue->qdisc_sleeping;
 211 }
 212
 213 /* The qdisc root lock is a mechanism by which to top level
 214  * of a qdisc tree can be locked from any qdisc node in the
 215  * forest.  This allows changing the configuration of some
 216  * aspect of the qdisc tree while blocking out asynchronous
 217  * qdisc access in the packet processing paths.
 218  *
 219  * It is only legal to do this when the root will not change
 220  * on us.  Otherwise we'll potentially lock the wrong qdisc
 221  * root.  This is enforced by holding the RTNL semaphore, which
 222  * all users of this lock accessor must do.
 223  */
 224 static inline spinlock_t *qdisc_root_lock(struct Qdisc *qdisc)
 225 {
 226         struct Qdisc *root = qdisc_root(qdisc);
 227
 228         ASSERT_RTNL();
 229         return qdisc_lock(root);
 230 }
 231
 232 static inline spinlock_t *qdisc_root_sleeping_lock(struct Qdisc *qdisc)
 233 {
 234         struct Qdisc *root = qdisc_root_sleeping(qdisc);
 235
 236         ASSERT_RTNL();
 237         return qdisc_lock(root);
 238 }
 239
 240 static inline struct net_device *qdisc_dev(struct Qdisc *qdisc)
 241 {
 242         return qdisc->dev_queue->dev;
 243 }
 244
 245 static inline void sch_tree_lock(struct Qdisc *q)
 246 {
 247         spin_lock_bh(qdisc_root_sleeping_lock(q));
 248 }
 249
 250 static inline void sch_tree_unlock(struct Qdisc *q)
 251 {
 252         spin_unlock_bh(qdisc_root_sleeping_lock(q));
 253 }
 254
 255 #define tcf_tree_lock(tp)       sch_tree_lock((tp)->q)
 256 #define tcf_tree_unlock(tp)     sch_tree_unlock((tp)->q)
 257
 258 extern struct Qdisc noop_qdisc;
 259 extern struct Qdisc_ops noop_qdisc_ops;
 260 extern struct Qdisc_ops pfifo_fast_ops;
 261 extern struct Qdisc_ops mq_qdisc_ops;
 262
 263 struct Qdisc_class_common
 264 {
 265         u32                     classid;
 266         struct hlist_node       hnode;
 267 };
 268
 269 struct Qdisc_class_hash
 270 {
 271         struct hlist_head       *hash;
 272         unsigned int            hashsize;
 273         unsigned int            hashmask;
 274         unsigned int            hashelems;
 275 };
 276
 277 static inline unsigned int qdisc_class_hash(u32 id, u32 mask)
 278 {
 279         id ^= id >> 8;
 280         id ^= id >> 4;
 281         return id & mask;
 282 }
 283
 284 static inline struct Qdisc_class_common *
 285 qdisc_class_find(struct Qdisc_class_hash *hash, u32 id)
 286 {
 287         struct Qdisc_class_common *cl;
 288         struct hlist_node *n;
 289         unsigned int h;
 290
 291         h = qdisc_class_hash(id, hash->hashmask);
 292         hlist_for_each_entry(cl, n, &hash->hash[h], hnode) {
 293                 if (cl->classid == id)
 294                         return cl;
 295         }
 296         return NULL;
 297 }
 298
 299 extern int qdisc_class_hash_init(struct Qdisc_class_hash *);
 300 extern void qdisc_class_hash_insert(struct Qdisc_class_hash *, struct Qdisc_class_common *);
 301 extern void qdisc_class_hash_remove(struct Qdisc_class_hash *, struct Qdisc_class_common *);
 302 extern void qdisc_class_hash_grow(struct Qdisc *, struct Qdisc_class_hash *);
 303 extern void qdisc_class_hash_destroy(struct Qdisc_class_hash *);
 304
 305 extern void dev_init_scheduler(struct net_device *dev);
 306 extern void dev_shutdown(struct net_device *dev);
 307 extern void dev_activate(struct net_device *dev);
 308 extern void dev_deactivate(struct net_device *dev);
 309 extern struct Qdisc *dev_graft_qdisc(struct netdev_queue *dev_queue,
 310                                      struct Qdisc *qdisc);
 311 extern void qdisc_reset(struct Qdisc *qdisc);
 312 extern void qdisc_destroy(struct Qdisc *qdisc);
 313 extern void qdisc_tree_decrease_qlen(struct Qdisc *qdisc, unsigned int n);
 314 extern struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
 315                                  struct Qdisc_ops *ops);
 316 extern struct Qdisc *qdisc_create_dflt(struct net_device *dev,
 317                                        struct netdev_queue *dev_queue,
 318                                        struct Qdisc_ops *ops, u32 parentid);
 319 extern void qdisc_calculate_pkt_len(struct sk_buff *skb,
 320                                    struct qdisc_size_table *stab);
 321 extern void tcf_destroy(struct tcf_proto *tp);
 322 extern void tcf_destroy_chain(struct tcf_proto **fl);
 323
 324 /* Reset all TX qdiscs of a device.  */
 325 static inline void qdisc_reset_all_tx(struct net_device *dev)
 326 {
 327         unsigned int i;
 328         for (i = 0; i < dev->num_tx_queues; i++)
 329                 qdisc_reset(netdev_get_tx_queue(dev, i)->qdisc);
 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 struct sk_buff *__qdisc_dequeue_tail(struct Qdisc *sch,
 440                                                    struct sk_buff_head *list)
 441 {
 442         struct sk_buff *skb = __skb_dequeue_tail(list);
 443
 444         if (likely(skb != NULL))
 445                 sch->qstats.backlog -= qdisc_pkt_len(skb);
 446
 447         return skb;
 448 }
 449
 450 static inline struct sk_buff *qdisc_dequeue_tail(struct Qdisc *sch)
 451 {
 452         return __qdisc_dequeue_tail(sch, &sch->q);
 453 }
 454
 455 static inline struct sk_buff *qdisc_peek_head(struct Qdisc *sch)
 456 {
 457         return skb_peek(&sch->q);
 458 }
 459
 460 /* generic pseudo peek method for non-work-conserving qdisc */
 461 static inline struct sk_buff *qdisc_peek_dequeued(struct Qdisc *sch)
 462 {
 463         /* we can reuse ->gso_skb because peek isn't called for root qdiscs */
 464         if (!sch->gso_skb) {
 465                 sch->gso_skb = sch->dequeue(sch);
 466                 if (sch->gso_skb)
 467                         /* it's still part of the queue */
 468                         sch->q.qlen++;
 469         }
 470
 471         return sch->gso_skb;
 472 }
 473
 474 /* use instead of qdisc->dequeue() for all qdiscs queried with ->peek() */
 475 static inline struct sk_buff *qdisc_dequeue_peeked(struct Qdisc *sch)
 476 {
 477         struct sk_buff *skb = sch->gso_skb;
 478
 479         if (skb) {
 480                 sch->gso_skb = NULL;
 481                 sch->q.qlen--;
 482         } else {
 483                 skb = sch->dequeue(sch);
 484         }
 485
 486         return skb;
 487 }
 488
 489 static inline void __qdisc_reset_queue(struct Qdisc *sch,
 490                                        struct sk_buff_head *list)
 491 {
 492         /*
 493          * We do not know the backlog in bytes of this list, it
 494          * is up to the caller to correct it
 495          */
 496         __skb_queue_purge(list);
 497 }
 498
 499 static inline void qdisc_reset_queue(struct Qdisc *sch)
 500 {
 501         __qdisc_reset_queue(sch, &sch->q);
 502         sch->qstats.backlog = 0;
 503 }
 504
 505 static inline unsigned int __qdisc_queue_drop(struct Qdisc *sch,
 506                                               struct sk_buff_head *list)
 507 {
 508         struct sk_buff *skb = __qdisc_dequeue_tail(sch, list);
 509
 510         if (likely(skb != NULL)) {
 511                 unsigned int len = qdisc_pkt_len(skb);
 512                 kfree_skb(skb);
 513                 return len;
 514         }
 515
 516         return 0;
 517 }
 518
 519 static inline unsigned int qdisc_queue_drop(struct Qdisc *sch)
 520 {
 521         return __qdisc_queue_drop(sch, &sch->q);
 522 }
 523
 524 static inline int qdisc_drop(struct sk_buff *skb, struct Qdisc *sch)
 525 {
 526         kfree_skb(skb);
 527         sch->qstats.drops++;
 528
 529         return NET_XMIT_DROP;
 530 }
 531
 532 static inline int qdisc_reshape_fail(struct sk_buff *skb, struct Qdisc *sch)
 533 {
 534         sch->qstats.drops++;
 535
 536 #ifdef CONFIG_NET_CLS_ACT
 537         if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
 538                 goto drop;
 539
 540         return NET_XMIT_SUCCESS;
 541
 542 drop:
 543 #endif
 544         kfree_skb(skb);
 545         return NET_XMIT_DROP;
 546 }
 547
 548 /* Length to Time (L2T) lookup in a qdisc_rate_table, to determine how
 549    long it will take to send a packet given its size.
 550  */
 551 static inline u32 qdisc_l2t(struct qdisc_rate_table* rtab, unsigned int pktlen)
 552 {
 553         int slot = pktlen + rtab->rate.cell_align + rtab->rate.overhead;
 554         if (slot < 0)
 555                 slot = 0;
 556         slot >>= rtab->rate.cell_log;
 557         if (slot > 255)
 558                 return (rtab->data[255]*(slot >> 8) + rtab->data[slot & 0xFF]);
 559         return rtab->data[slot];
 560 }
 561
 562 #ifdef CONFIG_NET_CLS_ACT
 563 static inline struct sk_buff *skb_act_clone(struct sk_buff *skb, gfp_t gfp_mask)
 564 {
 565         struct sk_buff *n = skb_clone(skb, gfp_mask);
 566
 567         if (n) {
 568                 n->tc_verd = SET_TC_VERD(n->tc_verd, 0);
 569                 n->tc_verd = CLR_TC_OK2MUNGE(n->tc_verd);
 570                 n->tc_verd = CLR_TC_MUNGED(n->tc_verd);
 571         }
 572         return n;
 573 }
 574 #endif
 575
 576 #endif