iproute2/tc/q_htb.c
<<
>>
Prefs
   1/*
   2 * q_htb.c              HTB.
   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:     Martin Devera, devik@cdi.cz
  10 *
  11 */
  12
  13#include <stdio.h>
  14#include <stdlib.h>
  15#include <unistd.h>
  16#include <fcntl.h>
  17#include <sys/socket.h>
  18#include <netinet/in.h>
  19#include <arpa/inet.h>
  20#include <string.h>
  21
  22#include "utils.h"
  23#include "tc_util.h"
  24
  25#define HTB_TC_VER 0x30003
  26#if HTB_TC_VER >> 16 != TC_HTB_PROTOVER
  27#error "Different kernel and TC HTB versions"
  28#endif
  29
  30static void explain(void)
  31{
  32        fprintf(stderr, "Usage: ... qdisc add ... htb [default N] [r2q N]\n"
  33                "                      [direct_qlen P] [offload]\n"
  34                " default  minor id of class to which unclassified packets are sent {0}\n"
  35                " r2q      DRR quantums are computed as rate in Bps/r2q {10}\n"
  36                " debug    string of 16 numbers each 0-3 {0}\n\n"
  37                " direct_qlen  Limit of the direct queue {in packets}\n"
  38                " offload  enable hardware offload\n"
  39                "... class add ... htb rate R1 [burst B1] [mpu B] [overhead O]\n"
  40                "                      [prio P] [slot S] [pslot PS]\n"
  41                "                      [ceil R2] [cburst B2] [mtu MTU] [quantum Q]\n"
  42                " rate     rate allocated to this class (class can still borrow)\n"
  43                " burst    max bytes burst which can be accumulated during idle period {computed}\n"
  44                " mpu      minimum packet size used in rate computations\n"
  45                " overhead per-packet size overhead used in rate computations\n"
  46                " linklay  adapting to a linklayer e.g. atm\n"
  47                " ceil     definite upper class rate (no borrows) {rate}\n"
  48                " cburst   burst but for ceil {computed}\n"
  49                " mtu      max packet size we create rate map for {1600}\n"
  50                " prio     priority of leaf; lower are served first {0}\n"
  51                " quantum  how much bytes to serve from leaf at once {use r2q}\n"
  52                "\nTC HTB version %d.%d\n", HTB_TC_VER>>16, HTB_TC_VER&0xffff
  53                );
  54}
  55
  56static void explain1(char *arg)
  57{
  58    fprintf(stderr, "Illegal \"%s\"\n", arg);
  59    explain();
  60}
  61
  62static int htb_parse_opt(struct qdisc_util *qu, int argc,
  63                         char **argv, struct nlmsghdr *n, const char *dev)
  64{
  65        unsigned int direct_qlen = ~0U;
  66        struct tc_htb_glob opt = {
  67                .rate2quantum = 10,
  68                .version = 3,
  69        };
  70        struct rtattr *tail;
  71        unsigned int i; char *p;
  72        bool offload = false;
  73
  74        while (argc > 0) {
  75                if (matches(*argv, "r2q") == 0) {
  76                        NEXT_ARG();
  77                        if (get_u32(&opt.rate2quantum, *argv, 10)) {
  78                                explain1("r2q"); return -1;
  79                        }
  80                } else if (matches(*argv, "default") == 0) {
  81                        NEXT_ARG();
  82                        if (get_u32(&opt.defcls, *argv, 16)) {
  83                                explain1("default"); return -1;
  84                        }
  85                } else if (matches(*argv, "debug") == 0) {
  86                        NEXT_ARG(); p = *argv;
  87                        for (i = 0; i < 16; i++, p++) {
  88                                if (*p < '0' || *p > '3') break;
  89                                opt.debug |= (*p-'0')<<(2*i);
  90                        }
  91                } else if (matches(*argv, "direct_qlen") == 0) {
  92                        NEXT_ARG();
  93                        if (get_u32(&direct_qlen, *argv, 10)) {
  94                                explain1("direct_qlen"); return -1;
  95                        }
  96                } else if (matches(*argv, "offload") == 0) {
  97                        offload = true;
  98                } else {
  99                        fprintf(stderr, "What is \"%s\"?\n", *argv);
 100                        explain();
 101                        return -1;
 102                }
 103                argc--; argv++;
 104        }
 105        tail = addattr_nest(n, 1024, TCA_OPTIONS);
 106        addattr_l(n, 2024, TCA_HTB_INIT, &opt, NLMSG_ALIGN(sizeof(opt)));
 107        if (direct_qlen != ~0U)
 108                addattr_l(n, 2024, TCA_HTB_DIRECT_QLEN,
 109                          &direct_qlen, sizeof(direct_qlen));
 110        if (offload)
 111                addattr(n, 2024, TCA_HTB_OFFLOAD);
 112        addattr_nest_end(n, tail);
 113        return 0;
 114}
 115
 116static int htb_parse_class_opt(struct qdisc_util *qu, int argc, char **argv, struct nlmsghdr *n, const char *dev)
 117{
 118        struct tc_htb_opt opt = {};
 119        __u32 rtab[256], ctab[256];
 120        unsigned buffer = 0, cbuffer = 0;
 121        int cell_log =  -1, ccell_log = -1;
 122        unsigned int mtu = 1600; /* eth packet len */
 123        unsigned short mpu = 0;
 124        unsigned short overhead = 0;
 125        unsigned int linklayer  = LINKLAYER_ETHERNET; /* Assume ethernet */
 126        struct rtattr *tail;
 127        __u64 ceil64 = 0, rate64 = 0;
 128        char *param;
 129
 130        while (argc > 0) {
 131                if (matches(*argv, "prio") == 0) {
 132                        NEXT_ARG();
 133                        if (get_u32(&opt.prio, *argv, 10)) {
 134                                explain1("prio"); return -1;
 135                        }
 136                } else if (matches(*argv, "mtu") == 0) {
 137                        NEXT_ARG();
 138                        if (get_u32(&mtu, *argv, 10)) {
 139                                explain1("mtu"); return -1;
 140                        }
 141                } else if (matches(*argv, "mpu") == 0) {
 142                        NEXT_ARG();
 143                        if (get_u16(&mpu, *argv, 10)) {
 144                                explain1("mpu"); return -1;
 145                        }
 146                } else if (matches(*argv, "overhead") == 0) {
 147                        NEXT_ARG();
 148                        if (get_u16(&overhead, *argv, 10)) {
 149                                explain1("overhead"); return -1;
 150                        }
 151                } else if (matches(*argv, "linklayer") == 0) {
 152                        NEXT_ARG();
 153                        if (get_linklayer(&linklayer, *argv)) {
 154                                explain1("linklayer"); return -1;
 155                        }
 156                } else if (matches(*argv, "quantum") == 0) {
 157                        NEXT_ARG();
 158                        if (get_u32(&opt.quantum, *argv, 10)) {
 159                                explain1("quantum"); return -1;
 160                        }
 161                } else if (matches(*argv, "burst") == 0 ||
 162                           strcmp(*argv, "buffer") == 0 ||
 163                           strcmp(*argv, "maxburst") == 0) {
 164                        param = *argv;
 165                        NEXT_ARG();
 166                        if (get_size_and_cell(&buffer, &cell_log, *argv) < 0) {
 167                                explain1(param);
 168                                return -1;
 169                        }
 170                } else if (matches(*argv, "cburst") == 0 ||
 171                           strcmp(*argv, "cbuffer") == 0 ||
 172                           strcmp(*argv, "cmaxburst") == 0) {
 173                        param = *argv;
 174                        NEXT_ARG();
 175                        if (get_size_and_cell(&cbuffer, &ccell_log, *argv) < 0) {
 176                                explain1(param);
 177                                return -1;
 178                        }
 179                } else if (strcmp(*argv, "ceil") == 0) {
 180                        NEXT_ARG();
 181                        if (ceil64) {
 182                                fprintf(stderr, "Double \"ceil\" spec\n");
 183                                return -1;
 184                        }
 185                        if (strchr(*argv, '%')) {
 186                                if (get_percent_rate64(&ceil64, *argv, dev)) {
 187                                        explain1("ceil");
 188                                        return -1;
 189                                }
 190                        } else if (get_rate64(&ceil64, *argv)) {
 191                                explain1("ceil");
 192                                return -1;
 193                        }
 194                } else if (strcmp(*argv, "rate") == 0) {
 195                        NEXT_ARG();
 196                        if (rate64) {
 197                                fprintf(stderr, "Double \"rate\" spec\n");
 198                                return -1;
 199                        }
 200                        if (strchr(*argv, '%')) {
 201                                if (get_percent_rate64(&rate64, *argv, dev)) {
 202                                        explain1("rate");
 203                                        return -1;
 204                                }
 205                        } else if (get_rate64(&rate64, *argv)) {
 206                                explain1("rate");
 207                                return -1;
 208                        }
 209                } else if (strcmp(*argv, "help") == 0) {
 210                        explain();
 211                        return -1;
 212                } else {
 213                        fprintf(stderr, "What is \"%s\"?\n", *argv);
 214                        explain();
 215                        return -1;
 216                }
 217                argc--; argv++;
 218        }
 219
 220        if (!rate64) {
 221                fprintf(stderr, "\"rate\" is required.\n");
 222                return -1;
 223        }
 224        /* if ceil params are missing, use the same as rate */
 225        if (!ceil64)
 226                ceil64 = rate64;
 227
 228        opt.rate.rate = (rate64 >= (1ULL << 32)) ? ~0U : rate64;
 229        opt.ceil.rate = (ceil64 >= (1ULL << 32)) ? ~0U : ceil64;
 230
 231        /* compute minimal allowed burst from rate; mtu is added here to make
 232           sute that buffer is larger than mtu and to have some safeguard space */
 233        if (!buffer)
 234                buffer = rate64 / get_hz() + mtu;
 235        if (!cbuffer)
 236                cbuffer = ceil64 / get_hz() + mtu;
 237
 238        opt.ceil.overhead = overhead;
 239        opt.rate.overhead = overhead;
 240
 241        opt.ceil.mpu = mpu;
 242        opt.rate.mpu = mpu;
 243
 244        if (tc_calc_rtable(&opt.rate, rtab, cell_log, mtu, linklayer) < 0) {
 245                fprintf(stderr, "htb: failed to calculate rate table.\n");
 246                return -1;
 247        }
 248        opt.buffer = tc_calc_xmittime(rate64, buffer);
 249
 250        if (tc_calc_rtable(&opt.ceil, ctab, ccell_log, mtu, linklayer) < 0) {
 251                fprintf(stderr, "htb: failed to calculate ceil rate table.\n");
 252                return -1;
 253        }
 254        opt.cbuffer = tc_calc_xmittime(ceil64, cbuffer);
 255
 256        tail = addattr_nest(n, 1024, TCA_OPTIONS);
 257
 258        if (rate64 >= (1ULL << 32))
 259                addattr_l(n, 1124, TCA_HTB_RATE64, &rate64, sizeof(rate64));
 260
 261        if (ceil64 >= (1ULL << 32))
 262                addattr_l(n, 1224, TCA_HTB_CEIL64, &ceil64, sizeof(ceil64));
 263
 264        addattr_l(n, 2024, TCA_HTB_PARMS, &opt, sizeof(opt));
 265        addattr_l(n, 3024, TCA_HTB_RTAB, rtab, 1024);
 266        addattr_l(n, 4024, TCA_HTB_CTAB, ctab, 1024);
 267        addattr_nest_end(n, tail);
 268        return 0;
 269}
 270
 271static int htb_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 272{
 273        struct rtattr *tb[TCA_HTB_MAX + 1];
 274        struct tc_htb_opt *hopt;
 275        struct tc_htb_glob *gopt;
 276        double buffer, cbuffer;
 277        unsigned int linklayer;
 278        __u64 rate64, ceil64;
 279
 280        SPRINT_BUF(b1);
 281        SPRINT_BUF(b3);
 282
 283        if (opt == NULL)
 284                return 0;
 285
 286        parse_rtattr_nested(tb, TCA_HTB_MAX, opt);
 287
 288        if (tb[TCA_HTB_PARMS]) {
 289                hopt = RTA_DATA(tb[TCA_HTB_PARMS]);
 290                if (RTA_PAYLOAD(tb[TCA_HTB_PARMS])  < sizeof(*hopt)) return -1;
 291
 292                if (!hopt->level) {
 293                        print_int(PRINT_ANY, "prio", "prio %d ", (int)hopt->prio);
 294                        if (show_details)
 295                                print_int(PRINT_ANY, "quantum", "quantum %d ",
 296                                          (int)hopt->quantum);
 297                }
 298
 299                rate64 = hopt->rate.rate;
 300                if (tb[TCA_HTB_RATE64] &&
 301                    RTA_PAYLOAD(tb[TCA_HTB_RATE64]) >= sizeof(rate64)) {
 302                        rate64 = rta_getattr_u64(tb[TCA_HTB_RATE64]);
 303                }
 304
 305                ceil64 = hopt->ceil.rate;
 306                if (tb[TCA_HTB_CEIL64] &&
 307                    RTA_PAYLOAD(tb[TCA_HTB_CEIL64]) >= sizeof(ceil64))
 308                        ceil64 = rta_getattr_u64(tb[TCA_HTB_CEIL64]);
 309
 310                tc_print_rate(PRINT_FP, NULL, "rate %s ", rate64);
 311                if (hopt->rate.overhead)
 312                        fprintf(f, "overhead %u ", hopt->rate.overhead);
 313                buffer = tc_calc_xmitsize(rate64, hopt->buffer);
 314
 315                tc_print_rate(PRINT_FP, NULL, "ceil %s ", ceil64);
 316                cbuffer = tc_calc_xmitsize(ceil64, hopt->cbuffer);
 317                linklayer = (hopt->rate.linklayer & TC_LINKLAYER_MASK);
 318                if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
 319                        fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b3));
 320                if (show_details) {
 321                        print_size(PRINT_FP, NULL, "burst %s/", buffer);
 322                        fprintf(f, "%u ", 1<<hopt->rate.cell_log);
 323                        print_size(PRINT_FP, NULL, "mpu %s ", hopt->rate.mpu);
 324                        print_size(PRINT_FP, NULL, "cburst %s/", cbuffer);
 325                        fprintf(f, "%u ", 1<<hopt->ceil.cell_log);
 326                        print_size(PRINT_FP, NULL, "mpu %s ", hopt->ceil.mpu);
 327                        fprintf(f, "level %d ", (int)hopt->level);
 328                } else {
 329                        print_size(PRINT_FP, NULL, "burst %s ", buffer);
 330                        print_size(PRINT_FP, NULL, "cburst %s ", cbuffer);
 331                }
 332                if (show_raw)
 333                        fprintf(f, "buffer [%08x] cbuffer [%08x] ",
 334                                hopt->buffer, hopt->cbuffer);
 335        }
 336        if (tb[TCA_HTB_INIT]) {
 337                gopt = RTA_DATA(tb[TCA_HTB_INIT]);
 338                if (RTA_PAYLOAD(tb[TCA_HTB_INIT])  < sizeof(*gopt)) return -1;
 339
 340                print_int(PRINT_ANY, "r2q", "r2q %d", gopt->rate2quantum);
 341                print_0xhex(PRINT_ANY, "default", " default %#llx", gopt->defcls);
 342                print_uint(PRINT_ANY, "direct_packets_stat",
 343                           " direct_packets_stat %u", gopt->direct_pkts);
 344                if (show_details) {
 345                        sprintf(b1, "%d.%d", gopt->version >> 16, gopt->version & 0xffff);
 346                        print_string(PRINT_ANY, "ver", " ver %s", b1);
 347                }
 348        }
 349        if (tb[TCA_HTB_DIRECT_QLEN] &&
 350            RTA_PAYLOAD(tb[TCA_HTB_DIRECT_QLEN]) >= sizeof(__u32)) {
 351                __u32 direct_qlen = rta_getattr_u32(tb[TCA_HTB_DIRECT_QLEN]);
 352
 353                print_uint(PRINT_ANY, "direct_qlen", " direct_qlen %u",
 354                           direct_qlen);
 355        }
 356        if (tb[TCA_HTB_OFFLOAD])
 357                print_null(PRINT_ANY, "offload", " offload", NULL);
 358        return 0;
 359}
 360
 361static int htb_print_xstats(struct qdisc_util *qu, FILE *f, struct rtattr *xstats)
 362{
 363        struct tc_htb_xstats *st;
 364
 365        if (xstats == NULL)
 366                return 0;
 367
 368        if (RTA_PAYLOAD(xstats) < sizeof(*st))
 369                return -1;
 370
 371        st = RTA_DATA(xstats);
 372        fprintf(f, " lended: %u borrowed: %u giants: %u\n",
 373                st->lends, st->borrows, st->giants);
 374        fprintf(f, " tokens: %d ctokens: %d\n", st->tokens, st->ctokens);
 375        return 0;
 376}
 377
 378struct qdisc_util htb_qdisc_util = {
 379        .id             = "htb",
 380        .parse_qopt     = htb_parse_opt,
 381        .print_qopt     = htb_print_opt,
 382        .print_xstats   = htb_print_xstats,
 383        .parse_copt     = htb_parse_class_opt,
 384        .print_copt     = htb_print_opt,
 385};
 386