net/sched/sch_tbf.c

   1 /*
   2  * net/sched/sch_tbf.c  Token Bucket Filter queue.
   3  *
   4  *              This program is free software; you can redistribute it and/or
   5  *              modify it under the terms of the GNU General Public License
   6  *              as published by the Free Software Foundation; either version
   7  *              2 of the License, or (at your option) any later version.
   8  *
   9  * Authors:     Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
  10  *              Dmitry Torokhov <dtor@mail.ru> - allow attaching inner qdiscs -
  11  *                                               original idea by Martin Devera
  12  *
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/types.h>
  17 #include <linux/kernel.h>
  18 #include <linux/string.h>
  19 #include <linux/errno.h>
  20 #include <linux/skbuff.h>
  21 #include <net/netlink.h>
  22 #include <net/pkt_sched.h>
  23
  24
  25 /*      Simple Token Bucket Filter.
  26         =======================================
  27
  28         SOURCE.
  29         -------
  30
  31         None.
  32
  33         Description.
  34         ------------
  35
  36         A data flow obeys TBF with rate R and depth B, if for any
  37         time interval t_i...t_f the number of transmitted bits
  38         does not exceed B + R*(t_f-t_i).
  39
  40         Packetized version of this definition:
  41         The sequence of packets of sizes s_i served at moments t_i
  42         obeys TBF, if for any i<=k:
  43
  44         s_i+....+s_k <= B + R*(t_k - t_i)
  45
  46         Algorithm.
  47         ----------
  48
  49         Let N(t_i) be B/R initially and N(t) grow continuously with time as:
  50
  51         N(t+delta) = min{B/R, N(t) + delta}
  52
  53         If the first packet in queue has length S, it may be
  54         transmitted only at the time t_* when S/R <= N(t_*),
  55         and in this case N(t) jumps:
  56
  57         N(t_* + 0) = N(t_* - 0) - S/R.
  58
  59
  60
  61         Actually, QoS requires two TBF to be applied to a data stream.
  62         One of them controls steady state burst size, another
  63         one with rate P (peak rate) and depth M (equal to link MTU)
  64         limits bursts at a smaller time scale.
  65
  66         It is easy to see that P>R, and B>M. If P is infinity, this double
  67         TBF is equivalent to a single one.
  68
  69         When TBF works in reshaping mode, latency is estimated as:
  70
  71         lat = max ((L-B)/R, (L-M)/P)
  72
  73
  74         NOTES.
  75         ------
  76
  77         If TBF throttles, it starts a watchdog timer, which will wake it up
  78         when it is ready to transmit.
  79         Note that the minimal timer resolution is 1/HZ.
  80         If no new packets arrive during this period,
  81         or if the device is not awaken by EOI for some previous packet,
  82         TBF can stop its activity for 1/HZ.
  83
  84
  85         This means, that with depth B, the maximal rate is
  86
  87         R_crit = B*HZ
  88
  89         F.e. for 10Mbit ethernet and HZ=100 the minimal allowed B is ~10Kbytes.
  90
  91         Note that the peak rate TBF is much more tough: with MTU 1500
  92         P_crit = 150Kbytes/sec. So, if you need greater peak
  93         rates, use alpha with HZ=1000 :-)
  94
  95         With classful TBF, limit is just kept for backwards compatibility.
  96         It is passed to the default bfifo qdisc - if the inner qdisc is
  97         changed the limit is not effective anymore.
  98 */
  99
 100 struct tbf_sched_data
 101 {
 102 /* Parameters */
 103         u32             limit;          /* Maximal length of backlog: bytes */
 104         u32             buffer;         /* Token bucket depth/rate: MUST BE >= MTU/B */
 105         u32             mtu;
 106         u32             max_size;
 107         struct qdisc_rate_table *R_tab;
 108         struct qdisc_rate_table *P_tab;
 109
 110 /* Variables */
 111         long    tokens;                 /* Current number of B tokens */
 112         long    ptokens;                /* Current number of P tokens */
 113         psched_time_t   t_c;            /* Time check-point */
 114         struct Qdisc    *qdisc;         /* Inner qdisc, default - bfifo queue */
 115         struct qdisc_watchdog watchdog; /* Watchdog timer */
 116 };
 117
 118 #define L2T(q,L)   qdisc_l2t((q)->R_tab,L)
 119 #define L2T_P(q,L) qdisc_l2t((q)->P_tab,L)
 120
 121 static int tbf_enqueue(struct sk_buff *skb, struct Qdisc* sch)
 122 {
 123         struct tbf_sched_data *q = qdisc_priv(sch);
 124         int ret;
 125
 126         if (skb->len > q->max_size) {
 127                 sch->qstats.drops++;
 128 #ifdef CONFIG_NET_CLS_ACT
 129                 if (sch->reshape_fail == NULL || sch->reshape_fail(skb, sch))
 130 #endif
 131                         kfree_skb(skb);
 132
 133                 return NET_XMIT_DROP;
 134         }
 135
 136         if ((ret = q->qdisc->enqueue(skb, q->qdisc)) != 0) {
 137                 sch->qstats.drops++;
 138                 return ret;
 139         }
 140
 141         sch->q.qlen++;
 142         sch->bstats.bytes += skb->len;
 143         sch->bstats.packets++;
 144         return 0;
 145 }
 146
 147 static int tbf_requeue(struct sk_buff *skb, struct Qdisc* sch)
 148 {
 149         struct tbf_sched_data *q = qdisc_priv(sch);
 150         int ret;
 151
 152         if ((ret = q->qdisc->ops->requeue(skb, q->qdisc)) == 0) {
 153                 sch->q.qlen++;
 154                 sch->qstats.requeues++;
 155         }
 156
 157         return ret;
 158 }
 159
 160 static unsigned int tbf_drop(struct Qdisc* sch)
 161 {
 162         struct tbf_sched_data *q = qdisc_priv(sch);
 163         unsigned int len = 0;
 164
 165         if (q->qdisc->ops->drop && (len = q->qdisc->ops->drop(q->qdisc)) != 0) {
 166                 sch->q.qlen--;
 167                 sch->qstats.drops++;
 168         }
 169         return len;
 170 }
 171
 172 static struct sk_buff *tbf_dequeue(struct Qdisc* sch)
 173 {
 174         struct tbf_sched_data *q = qdisc_priv(sch);
 175         struct sk_buff *skb;
 176
 177         skb = q->qdisc->dequeue(q->qdisc);
 178
 179         if (skb) {
 180                 psched_time_t now;
 181                 long toks;
 182                 long ptoks = 0;
 183                 unsigned int len = skb->len;
 184
 185                 now = psched_get_time();
 186                 toks = psched_tdiff_bounded(now, q->t_c, q->buffer);
 187
 188                 if (q->P_tab) {
 189                         ptoks = toks + q->ptokens;
 190                         if (ptoks > (long)q->mtu)
 191                                 ptoks = q->mtu;
 192                         ptoks -= L2T_P(q, len);
 193                 }
 194                 toks += q->tokens;
 195                 if (toks > (long)q->buffer)
 196                         toks = q->buffer;
 197                 toks -= L2T(q, len);
 198
 199                 if ((toks|ptoks) >= 0) {
 200                         q->t_c = now;
 201                         q->tokens = toks;
 202                         q->ptokens = ptoks;
 203                         sch->q.qlen--;
 204                         sch->flags &= ~TCQ_F_THROTTLED;
 205                         return skb;
 206                 }
 207
 208                 qdisc_watchdog_schedule(&q->watchdog,
 209                                         now + max_t(long, -toks, -ptoks));
 210
 211                 /* Maybe we have a shorter packet in the queue,
 212                    which can be sent now. It sounds cool,
 213                    but, however, this is wrong in principle.
 214                    We MUST NOT reorder packets under these circumstances.
 215
 216                    Really, if we split the flow into independent
 217                    subflows, it would be a very good solution.
 218                    This is the main idea of all FQ algorithms
 219                    (cf. CSZ, HPFQ, HFSC)
 220                  */
 221
 222                 if (q->qdisc->ops->requeue(skb, q->qdisc) != NET_XMIT_SUCCESS) {
 223                         /* When requeue fails skb is dropped */
 224                         qdisc_tree_decrease_qlen(q->qdisc, 1);
 225                         sch->qstats.drops++;
 226                 }
 227
 228                 sch->qstats.overlimits++;
 229         }
 230         return NULL;
 231 }
 232
 233 static void tbf_reset(struct Qdisc* sch)
 234 {
 235         struct tbf_sched_data *q = qdisc_priv(sch);
 236
 237         qdisc_reset(q->qdisc);
 238         sch->q.qlen = 0;
 239         q->t_c = psched_get_time();
 240         q->tokens = q->buffer;
 241         q->ptokens = q->mtu;
 242         qdisc_watchdog_cancel(&q->watchdog);
 243 }
 244
 245 static const struct nla_policy tbf_policy[TCA_TBF_MAX + 1] = {
 246         [TCA_TBF_PARMS] = { .len = sizeof(struct tc_tbf_qopt) },
 247         [TCA_TBF_RTAB]  = { .type = NLA_BINARY, .len = TC_RTAB_SIZE },
 248         [TCA_TBF_PTAB]  = { .type = NLA_BINARY, .len = TC_RTAB_SIZE },
 249 };
 250
 251 static int tbf_change(struct Qdisc* sch, struct nlattr *opt)
 252 {
 253         int err;
 254         struct tbf_sched_data *q = qdisc_priv(sch);
 255         struct nlattr *tb[TCA_TBF_PTAB + 1];
 256         struct tc_tbf_qopt *qopt;
 257         struct qdisc_rate_table *rtab = NULL;
 258         struct qdisc_rate_table *ptab = NULL;
 259         struct Qdisc *child = NULL;
 260         int max_size,n;
 261
 262         err = nla_parse_nested(tb, TCA_TBF_PTAB, opt, tbf_policy);
 263         if (err < 0)
 264                 return err;
 265
 266         err = -EINVAL;
 267         if (tb[TCA_TBF_PARMS] == NULL)
 268                 goto done;
 269
 270         qopt = nla_data(tb[TCA_TBF_PARMS]);
 271         rtab = qdisc_get_rtab(&qopt->rate, tb[TCA_TBF_RTAB]);
 272         if (rtab == NULL)
 273                 goto done;
 274
 275         if (qopt->peakrate.rate) {
 276                 if (qopt->peakrate.rate > qopt->rate.rate)
 277                         ptab = qdisc_get_rtab(&qopt->peakrate, tb[TCA_TBF_PTAB]);
 278                 if (ptab == NULL)
 279                         goto done;
 280         }
 281
 282         for (n = 0; n < 256; n++)
 283                 if (rtab->data[n] > qopt->buffer) break;
 284         max_size = (n << qopt->rate.cell_log)-1;
 285         if (ptab) {
 286                 int size;
 287
 288                 for (n = 0; n < 256; n++)
 289                         if (ptab->data[n] > qopt->mtu) break;
 290                 size = (n << qopt->peakrate.cell_log)-1;
 291                 if (size < max_size) max_size = size;
 292         }
 293         if (max_size < 0)
 294                 goto done;
 295
 296         if (qopt->limit > 0) {
 297                 child = fifo_create_dflt(sch, &bfifo_qdisc_ops, qopt->limit);
 298                 if (IS_ERR(child)) {
 299                         err = PTR_ERR(child);
 300                         goto done;
 301                 }
 302         }
 303
 304         sch_tree_lock(sch);
 305         if (child) {
 306                 qdisc_tree_decrease_qlen(q->qdisc, q->qdisc->q.qlen);
 307                 qdisc_destroy(xchg(&q->qdisc, child));
 308         }
 309         q->limit = qopt->limit;
 310         q->mtu = qopt->mtu;
 311         q->max_size = max_size;
 312         q->buffer = qopt->buffer;
 313         q->tokens = q->buffer;
 314         q->ptokens = q->mtu;
 315         rtab = xchg(&q->R_tab, rtab);
 316         ptab = xchg(&q->P_tab, ptab);
 317         sch_tree_unlock(sch);
 318         err = 0;
 319 done:
 320         if (rtab)
 321                 qdisc_put_rtab(rtab);
 322         if (ptab)
 323                 qdisc_put_rtab(ptab);
 324         return err;
 325 }
 326
 327 static int tbf_init(struct Qdisc* sch, struct nlattr *opt)
 328 {
 329         struct tbf_sched_data *q = qdisc_priv(sch);
 330
 331         if (opt == NULL)
 332                 return -EINVAL;
 333
 334         q->t_c = psched_get_time();
 335         qdisc_watchdog_init(&q->watchdog, sch);
 336         q->qdisc = &noop_qdisc;
 337
 338         return tbf_change(sch, opt);
 339 }
 340
 341 static void tbf_destroy(struct Qdisc *sch)
 342 {
 343         struct tbf_sched_data *q = qdisc_priv(sch);
 344
 345         qdisc_watchdog_cancel(&q->watchdog);
 346
 347         if (q->P_tab)
 348                 qdisc_put_rtab(q->P_tab);
 349         if (q->R_tab)
 350                 qdisc_put_rtab(q->R_tab);
 351
 352         qdisc_destroy(q->qdisc);
 353 }
 354
 355 static int tbf_dump(struct Qdisc *sch, struct sk_buff *skb)
 356 {
 357         struct tbf_sched_data *q = qdisc_priv(sch);
 358         struct nlattr *nest;
 359         struct tc_tbf_qopt opt;
 360
 361         nest = nla_nest_start(skb, TCA_OPTIONS);
 362         if (nest == NULL)
 363                 goto nla_put_failure;
 364
 365         opt.limit = q->limit;
 366         opt.rate = q->R_tab->rate;
 367         if (q->P_tab)
 368                 opt.peakrate = q->P_tab->rate;
 369         else
 370                 memset(&opt.peakrate, 0, sizeof(opt.peakrate));
 371         opt.mtu = q->mtu;
 372         opt.buffer = q->buffer;
 373         NLA_PUT(skb, TCA_TBF_PARMS, sizeof(opt), &opt);
 374
 375         nla_nest_end(skb, nest);
 376         return skb->len;
 377
 378 nla_put_failure:
 379         nla_nest_cancel(skb, nest);
 380         return -1;
 381 }
 382
 383 static int tbf_dump_class(struct Qdisc *sch, unsigned long cl,
 384                           struct sk_buff *skb, struct tcmsg *tcm)
 385 {
 386         struct tbf_sched_data *q = qdisc_priv(sch);
 387
 388         if (cl != 1)    /* only one class */
 389                 return -ENOENT;
 390
 391         tcm->tcm_handle |= TC_H_MIN(1);
 392         tcm->tcm_info = q->qdisc->handle;
 393
 394         return 0;
 395 }
 396
 397 static int tbf_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
 398                      struct Qdisc **old)
 399 {
 400         struct tbf_sched_data *q = qdisc_priv(sch);
 401
 402         if (new == NULL)
 403                 new = &noop_qdisc;
 404
 405         sch_tree_lock(sch);
 406         *old = xchg(&q->qdisc, new);
 407         qdisc_tree_decrease_qlen(*old, (*old)->q.qlen);
 408         qdisc_reset(*old);
 409         sch_tree_unlock(sch);
 410
 411         return 0;
 412 }
 413
 414 static struct Qdisc *tbf_leaf(struct Qdisc *sch, unsigned long arg)
 415 {
 416         struct tbf_sched_data *q = qdisc_priv(sch);
 417         return q->qdisc;
 418 }
 419
 420 static unsigned long tbf_get(struct Qdisc *sch, u32 classid)
 421 {
 422         return 1;
 423 }
 424
 425 static void tbf_put(struct Qdisc *sch, unsigned long arg)
 426 {
 427 }
 428
 429 static int tbf_change_class(struct Qdisc *sch, u32 classid, u32 parentid,
 430                             struct nlattr **tca, unsigned long *arg)
 431 {
 432         return -ENOSYS;
 433 }
 434
 435 static int tbf_delete(struct Qdisc *sch, unsigned long arg)
 436 {
 437         return -ENOSYS;
 438 }
 439
 440 static void tbf_walk(struct Qdisc *sch, struct qdisc_walker *walker)
 441 {
 442         if (!walker->stop) {
 443                 if (walker->count >= walker->skip)
 444                         if (walker->fn(sch, 1, walker) < 0) {
 445                                 walker->stop = 1;
 446                                 return;
 447                         }
 448                 walker->count++;
 449         }
 450 }
 451
 452 static struct tcf_proto **tbf_find_tcf(struct Qdisc *sch, unsigned long cl)
 453 {
 454         return NULL;
 455 }
 456
 457 static const struct Qdisc_class_ops tbf_class_ops =
 458 {
 459         .graft          =       tbf_graft,
 460         .leaf           =       tbf_leaf,
 461         .get            =       tbf_get,
 462         .put            =       tbf_put,
 463         .change         =       tbf_change_class,
 464         .delete         =       tbf_delete,
 465         .walk           =       tbf_walk,
 466         .tcf_chain      =       tbf_find_tcf,
 467         .dump           =       tbf_dump_class,
 468 };
 469
 470 static struct Qdisc_ops tbf_qdisc_ops __read_mostly = {
 471         .next           =       NULL,
 472         .cl_ops         =       &tbf_class_ops,
 473         .id             =       "tbf",
 474         .priv_size      =       sizeof(struct tbf_sched_data),
 475         .enqueue        =       tbf_enqueue,
 476         .dequeue        =       tbf_dequeue,
 477         .requeue        =       tbf_requeue,
 478         .drop           =       tbf_drop,
 479         .init           =       tbf_init,
 480         .reset          =       tbf_reset,
 481         .destroy        =       tbf_destroy,
 482         .change         =       tbf_change,
 483         .dump           =       tbf_dump,
 484         .owner          =       THIS_MODULE,
 485 };
 486
 487 static int __init tbf_module_init(void)
 488 {
 489         return register_qdisc(&tbf_qdisc_ops);
 490 }
 491
 492 static void __exit tbf_module_exit(void)
 493 {
 494         unregister_qdisc(&tbf_qdisc_ops);
 495 }
 496 module_init(tbf_module_init)
 497 module_exit(tbf_module_exit)
 498 MODULE_LICENSE("GPL");