tc/q_tbf.c

   1 /*
   2  * q_tbf.c              TBF.
   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  *
  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 static void explain(void)
  26 {
  27         fprintf(stderr, "Usage: ... tbf limit BYTES burst BYTES[/BYTES] rate KBPS [ mtu BYTES[/BYTES] ]\n");
  28         fprintf(stderr, "               [ peakrate KBPS ] [ latency TIME ] ");
  29         fprintf(stderr, "[ overhead BYTES ] [ linklayer TYPE ]\n");
  30 }
  31
  32 static void explain1(const char *arg, const char *val)
  33 {
  34         fprintf(stderr, "tbf: illegal value for \"%s\": \"%s\"\n", arg, val);
  35 }
  36
  37
  38 static int tbf_parse_opt(struct qdisc_util *qu, int argc, char **argv, struct nlmsghdr *n)
  39 {
  40         int ok = 0;
  41         struct tc_tbf_qopt opt = {};
  42         __u32 rtab[256];
  43         __u32 ptab[256];
  44         unsigned buffer = 0, mtu = 0, mpu = 0, latency = 0;
  45         int Rcell_log =  -1, Pcell_log = -1;
  46         unsigned short overhead = 0;
  47         unsigned int linklayer = LINKLAYER_ETHERNET; /* Assume ethernet */
  48         struct rtattr *tail;
  49         __u64 rate64 = 0, prate64 = 0;
  50
  51         while (argc > 0) {
  52                 if (matches(*argv, "limit") == 0) {
  53                         NEXT_ARG();
  54                         if (opt.limit) {
  55                                 fprintf(stderr, "tbf: duplicate \"limit\" specification\n");
  56                                 return -1;
  57                         }
  58                         if (latency) {
  59                                 fprintf(stderr, "tbf: specifying both \"latency\" and \"limit\" is not allowed\n");
  60                                 return -1;
  61                         }
  62                         if (get_size(&opt.limit, *argv)) {
  63                                 explain1("limit", *argv);
  64                                 return -1;
  65                         }
  66                         ok++;
  67                 } else if (matches(*argv, "latency") == 0) {
  68                         NEXT_ARG();
  69                         if (latency) {
  70                                 fprintf(stderr, "tbf: duplicate \"latency\" specification\n");
  71                                 return -1;
  72                         }
  73                         if (opt.limit) {
  74                                 fprintf(stderr, "tbf: specifying both \"limit\" and \"/latency\" is not allowed\n");
  75                                 return -1;
  76                         }
  77                         if (get_time(&latency, *argv)) {
  78                                 explain1("latency", *argv);
  79                                 return -1;
  80                         }
  81                         ok++;
  82                 } else if (matches(*argv, "burst") == 0 ||
  83                         strcmp(*argv, "buffer") == 0 ||
  84                         strcmp(*argv, "maxburst") == 0) {
  85                         const char *parm_name = *argv;
  86
  87                         NEXT_ARG();
  88                         if (buffer) {
  89                                 fprintf(stderr, "tbf: duplicate \"buffer/burst/maxburst\" specification\n");
  90                                 return -1;
  91                         }
  92                         if (get_size_and_cell(&buffer, &Rcell_log, *argv) < 0) {
  93                                 explain1(parm_name, *argv);
  94                                 return -1;
  95                         }
  96                         ok++;
  97                 } else if (strcmp(*argv, "mtu") == 0 ||
  98                            strcmp(*argv, "minburst") == 0) {
  99                         const char *parm_name = *argv;
 100
 101                         NEXT_ARG();
 102                         if (mtu) {
 103                                 fprintf(stderr, "tbf: duplicate \"mtu/minburst\" specification\n");
 104                                 return -1;
 105                         }
 106                         if (get_size_and_cell(&mtu, &Pcell_log, *argv) < 0) {
 107                                 explain1(parm_name, *argv);
 108                                 return -1;
 109                         }
 110                         ok++;
 111                 } else if (strcmp(*argv, "mpu") == 0) {
 112                         NEXT_ARG();
 113                         if (mpu) {
 114                                 fprintf(stderr, "tbf: duplicate \"mpu\" specification\n");
 115                                 return -1;
 116                         }
 117                         if (get_size(&mpu, *argv)) {
 118                                 explain1("mpu", *argv);
 119                                 return -1;
 120                         }
 121                         ok++;
 122                 } else if (strcmp(*argv, "rate") == 0) {
 123                         NEXT_ARG();
 124                         if (rate64) {
 125                                 fprintf(stderr, "tbf: duplicate \"rate\" specification\n");
 126                                 return -1;
 127                         }
 128                         if (get_rate64(&rate64, *argv)) {
 129                                 explain1("rate", *argv);
 130                                 return -1;
 131                         }
 132                         ok++;
 133                 } else if (matches(*argv, "peakrate") == 0) {
 134                         NEXT_ARG();
 135                         if (prate64) {
 136                                 fprintf(stderr, "tbf: duplicate \"peakrate\" specification\n");
 137                                 return -1;
 138                         }
 139                         if (get_rate64(&prate64, *argv)) {
 140                                 explain1("peakrate", *argv);
 141                                 return -1;
 142                         }
 143                         ok++;
 144                 } else if (matches(*argv, "overhead") == 0) {
 145                         NEXT_ARG();
 146                         if (overhead) {
 147                                 fprintf(stderr, "tbf: duplicate \"overhead\" specification\n");
 148                                 return -1;
 149                         }
 150                         if (get_u16(&overhead, *argv, 10)) {
 151                                 explain1("overhead", *argv); return -1;
 152                         }
 153                 } else if (matches(*argv, "linklayer") == 0) {
 154                         NEXT_ARG();
 155                         if (get_linklayer(&linklayer, *argv)) {
 156                                 explain1("linklayer", *argv); return -1;
 157                         }
 158                 } else if (strcmp(*argv, "help") == 0) {
 159                         explain();
 160                         return -1;
 161                 } else {
 162                         fprintf(stderr, "tbf: unknown parameter \"%s\"\n", *argv);
 163                         explain();
 164                         return -1;
 165                 }
 166                 argc--; argv++;
 167         }
 168
 169         int verdict = 0;
 170
 171         /* Be nice to the user: try to emit all error messages in
 172          * one go rather than reveal one more problem when a
 173          * previous one has been fixed.
 174          */
 175         if (rate64 == 0) {
 176                 fprintf(stderr, "tbf: the \"rate\" parameter is mandatory.\n");
 177                 verdict = -1;
 178         }
 179         if (!buffer) {
 180                 fprintf(stderr, "tbf: the \"burst\" parameter is mandatory.\n");
 181                 verdict = -1;
 182         }
 183         if (prate64) {
 184                 if (!mtu) {
 185                         fprintf(stderr, "tbf: when \"peakrate\" is specified, \"mtu\" must also be specified.\n");
 186                         verdict = -1;
 187                 }
 188         }
 189
 190         if (opt.limit == 0 && latency == 0) {
 191                 fprintf(stderr, "tbf: either \"limit\" or \"latency\" is required.\n");
 192                 verdict = -1;
 193         }
 194
 195         if (verdict != 0) {
 196                 explain();
 197                 return verdict;
 198         }
 199
 200         opt.rate.rate = (rate64 >= (1ULL << 32)) ? ~0U : rate64;
 201         opt.peakrate.rate = (prate64 >= (1ULL << 32)) ? ~0U : prate64;
 202
 203         if (opt.limit == 0) {
 204                 double lim = rate64*(double)latency/TIME_UNITS_PER_SEC + buffer;
 205
 206                 if (prate64) {
 207                         double lim2 = prate64*(double)latency/TIME_UNITS_PER_SEC + mtu;
 208
 209                         if (lim2 < lim)
 210                                 lim = lim2;
 211                 }
 212                 opt.limit = lim;
 213         }
 214
 215         opt.rate.mpu      = mpu;
 216         opt.rate.overhead = overhead;
 217         if (tc_calc_rtable(&opt.rate, rtab, Rcell_log, mtu, linklayer) < 0) {
 218                 fprintf(stderr, "tbf: failed to calculate rate table.\n");
 219                 return -1;
 220         }
 221         opt.buffer = tc_calc_xmittime(opt.rate.rate, buffer);
 222
 223         if (opt.peakrate.rate) {
 224                 opt.peakrate.mpu      = mpu;
 225                 opt.peakrate.overhead = overhead;
 226                 if (tc_calc_rtable(&opt.peakrate, ptab, Pcell_log, mtu, linklayer) < 0) {
 227                         fprintf(stderr, "tbf: failed to calculate peak rate table.\n");
 228                         return -1;
 229                 }
 230                 opt.mtu = tc_calc_xmittime(opt.peakrate.rate, mtu);
 231         }
 232
 233         tail = NLMSG_TAIL(n);
 234         addattr_l(n, 1024, TCA_OPTIONS, NULL, 0);
 235         addattr_l(n, 2024, TCA_TBF_PARMS, &opt, sizeof(opt));
 236         addattr_l(n, 2124, TCA_TBF_BURST, &buffer, sizeof(buffer));
 237         if (rate64 >= (1ULL << 32))
 238                 addattr_l(n, 2124, TCA_TBF_RATE64, &rate64, sizeof(rate64));
 239         addattr_l(n, 3024, TCA_TBF_RTAB, rtab, 1024);
 240         if (opt.peakrate.rate) {
 241                 if (prate64 >= (1ULL << 32))
 242                         addattr_l(n, 3124, TCA_TBF_PRATE64, &prate64, sizeof(prate64));
 243                 addattr_l(n, 3224, TCA_TBF_PBURST, &mtu, sizeof(mtu));
 244                 addattr_l(n, 4096, TCA_TBF_PTAB, ptab, 1024);
 245         }
 246         tail->rta_len = (void *) NLMSG_TAIL(n) - (void *) tail;
 247         return 0;
 248 }
 249
 250 static int tbf_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 251 {
 252         struct rtattr *tb[TCA_TBF_MAX+1];
 253         struct tc_tbf_qopt *qopt;
 254         unsigned int linklayer;
 255         double buffer, mtu;
 256         double latency;
 257         __u64 rate64 = 0, prate64 = 0;
 258
 259         SPRINT_BUF(b1);
 260         SPRINT_BUF(b2);
 261         SPRINT_BUF(b3);
 262
 263         if (opt == NULL)
 264                 return 0;
 265
 266         parse_rtattr_nested(tb, TCA_TBF_MAX, opt);
 267
 268         if (tb[TCA_TBF_PARMS] == NULL)
 269                 return -1;
 270
 271         qopt = RTA_DATA(tb[TCA_TBF_PARMS]);
 272         if (RTA_PAYLOAD(tb[TCA_TBF_PARMS])  < sizeof(*qopt))
 273                 return -1;
 274         rate64 = qopt->rate.rate;
 275         if (tb[TCA_TBF_RATE64] &&
 276             RTA_PAYLOAD(tb[TCA_TBF_RATE64]) >= sizeof(rate64))
 277                 rate64 = rta_getattr_u64(tb[TCA_TBF_RATE64]);
 278         fprintf(f, "rate %s ", sprint_rate(rate64, b1));
 279         buffer = tc_calc_xmitsize(rate64, qopt->buffer);
 280         if (show_details) {
 281                 fprintf(f, "burst %s/%u mpu %s ", sprint_size(buffer, b1),
 282                         1<<qopt->rate.cell_log, sprint_size(qopt->rate.mpu, b2));
 283         } else {
 284                 fprintf(f, "burst %s ", sprint_size(buffer, b1));
 285         }
 286         if (show_raw)
 287                 fprintf(f, "[%08x] ", qopt->buffer);
 288         prate64 = qopt->peakrate.rate;
 289         if (tb[TCA_TBF_PRATE64] &&
 290             RTA_PAYLOAD(tb[TCA_TBF_PRATE64]) >= sizeof(prate64))
 291                 prate64 = rta_getattr_u64(tb[TCA_TBF_PRATE64]);
 292         if (prate64) {
 293                 fprintf(f, "peakrate %s ", sprint_rate(prate64, b1));
 294                 if (qopt->mtu || qopt->peakrate.mpu) {
 295                         mtu = tc_calc_xmitsize(prate64, qopt->mtu);
 296                         if (show_details) {
 297                                 fprintf(f, "mtu %s/%u mpu %s ", sprint_size(mtu, b1),
 298                                         1<<qopt->peakrate.cell_log, sprint_size(qopt->peakrate.mpu, b2));
 299                         } else {
 300                                 fprintf(f, "minburst %s ", sprint_size(mtu, b1));
 301                         }
 302                         if (show_raw)
 303                                 fprintf(f, "[%08x] ", qopt->mtu);
 304                 }
 305         }
 306
 307         latency = TIME_UNITS_PER_SEC*(qopt->limit/(double)rate64) - tc_core_tick2time(qopt->buffer);
 308         if (prate64) {
 309                 double lat2 = TIME_UNITS_PER_SEC*(qopt->limit/(double)prate64) - tc_core_tick2time(qopt->mtu);
 310
 311                 if (lat2 > latency)
 312                         latency = lat2;
 313         }
 314         if (latency >= 0.0)
 315                 fprintf(f, "lat %s ", sprint_time(latency, b1));
 316         if (show_raw || latency < 0.0)
 317                 fprintf(f, "limit %s ", sprint_size(qopt->limit, b1));
 318
 319         if (qopt->rate.overhead) {
 320                 fprintf(f, "overhead %d", qopt->rate.overhead);
 321         }
 322         linklayer = (qopt->rate.linklayer & TC_LINKLAYER_MASK);
 323         if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
 324                 fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b3));
 325
 326         return 0;
 327 }
 328
 329 struct qdisc_util tbf_qdisc_util = {
 330         .id             = "tbf",
 331         .parse_qopt     = tbf_parse_opt,
 332         .print_qopt     = tbf_print_opt,
 333 };