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