tc/q_hfsc.c

   1 /*
   2  * q_hfsc.c     HFSC.
   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:     Patrick McHardy, <kaber@trash.net>
  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 #include <math.h>
  22
  23 #include "utils.h"
  24 #include "tc_util.h"
  25
  26 static int hfsc_get_sc(int *, char ***,
  27                        struct tc_service_curve *, const char *);
  28
  29 static void
  30 explain_qdisc(void)
  31 {
  32         fprintf(stderr,
  33                 "Usage: ... hfsc [ default CLASSID ]\n"
  34                 "\n"
  35                 " default: default class for unclassified packets\n"
  36         );
  37 }
  38
  39 static void
  40 explain_class(void)
  41 {
  42         fprintf(stderr,
  43                 "Usage: ... hfsc [ [ rt SC ] [ ls SC ] | [ sc SC ] ] [ ul SC ]\n"
  44                 "\n"
  45                 "SC := [ [ m1 BPS ] d SEC ] m2 BPS\n"
  46                 "\n"
  47                 " m1 : slope of first segment\n"
  48                 " d  : x-coordinate of intersection\n"
  49                 " m2 : slope of second segment\n"
  50                 "\n"
  51                 "Alternative format:\n"
  52                 "\n"
  53                 "SC := [ [ umax BYTE ] dmax SEC ] rate BPS\n"
  54                 "\n"
  55                 " umax : maximum unit of work\n"
  56                 " dmax : maximum delay\n"
  57                 " rate : rate\n"
  58                 "\n"
  59                 "Remarks:\n"
  60                 " - at least one of 'rt', 'ls' or 'sc' must be specified\n"
  61                 " - 'ul' can only be specified with 'ls' or 'sc'\n"
  62                 "\n"
  63         );
  64 }
  65
  66 static void
  67 explain1(char *arg)
  68 {
  69         fprintf(stderr, "HFSC: Illegal \"%s\"\n", arg);
  70 }
  71
  72 static int
  73 hfsc_parse_opt(struct qdisc_util *qu, int argc, char **argv,
  74                struct nlmsghdr *n, const char *dev)
  75 {
  76         struct tc_hfsc_qopt qopt = {};
  77
  78         while (argc > 0) {
  79                 if (matches(*argv, "default") == 0) {
  80                         NEXT_ARG();
  81                         if (qopt.defcls != 0) {
  82                                 fprintf(stderr, "HFSC: Double \"default\"\n");
  83                                 return -1;
  84                         }
  85                         if (get_u16(&qopt.defcls, *argv, 16) < 0) {
  86                                 explain1("default");
  87                                 return -1;
  88                         }
  89                 } else if (matches(*argv, "help") == 0) {
  90                         explain_qdisc();
  91                         return -1;
  92                 } else {
  93                         fprintf(stderr, "HFSC: What is \"%s\" ?\n", *argv);
  94                         explain_qdisc();
  95                         return -1;
  96                 }
  97                 argc--, argv++;
  98         }
  99
 100         addattr_l(n, 1024, TCA_OPTIONS, &qopt, sizeof(qopt));
 101         return 0;
 102 }
 103
 104 static int
 105 hfsc_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 106 {
 107         struct tc_hfsc_qopt *qopt;
 108
 109         if (opt == NULL)
 110                 return 0;
 111         if (RTA_PAYLOAD(opt) < sizeof(*qopt))
 112                 return -1;
 113         qopt = RTA_DATA(opt);
 114
 115         if (qopt->defcls != 0)
 116                 fprintf(f, "default %x ", qopt->defcls);
 117
 118         return 0;
 119 }
 120
 121 static int
 122 hfsc_print_xstats(struct qdisc_util *qu, FILE *f, struct rtattr *xstats)
 123 {
 124         struct tc_hfsc_stats *st;
 125
 126         if (xstats == NULL)
 127                 return 0;
 128         if (RTA_PAYLOAD(xstats) < sizeof(*st))
 129                 return -1;
 130         st = RTA_DATA(xstats);
 131
 132         fprintf(f, " period %u ", st->period);
 133         if (st->work != 0)
 134                 fprintf(f, "work %llu bytes ", (unsigned long long) st->work);
 135         if (st->rtwork != 0)
 136                 fprintf(f, "rtwork %llu bytes ", (unsigned long long) st->rtwork);
 137         fprintf(f, "level %u ", st->level);
 138         fprintf(f, "\n");
 139
 140         return 0;
 141 }
 142
 143 static int
 144 hfsc_parse_class_opt(struct qdisc_util *qu, int argc, char **argv,
 145                      struct nlmsghdr *n, const char *dev)
 146 {
 147         struct tc_service_curve rsc = {}, fsc = {}, usc = {};
 148         int rsc_ok = 0, fsc_ok = 0, usc_ok = 0;
 149         struct rtattr *tail;
 150
 151         while (argc > 0) {
 152                 if (matches(*argv, "rt") == 0) {
 153                         NEXT_ARG();
 154                         if (hfsc_get_sc(&argc, &argv, &rsc, dev) < 0) {
 155                                 explain1("rt");
 156                                 return -1;
 157                         }
 158                         rsc_ok = 1;
 159                 } else if (matches(*argv, "ls") == 0) {
 160                         NEXT_ARG();
 161                         if (hfsc_get_sc(&argc, &argv, &fsc, dev) < 0) {
 162                                 explain1("ls");
 163                                 return -1;
 164                         }
 165                         fsc_ok = 1;
 166                 } else if (matches(*argv, "sc") == 0) {
 167                         NEXT_ARG();
 168                         if (hfsc_get_sc(&argc, &argv, &rsc, dev) < 0) {
 169                                 explain1("sc");
 170                                 return -1;
 171                         }
 172                         memcpy(&fsc, &rsc, sizeof(fsc));
 173                         rsc_ok = 1;
 174                         fsc_ok = 1;
 175                 } else if (matches(*argv, "ul") == 0) {
 176                         NEXT_ARG();
 177                         if (hfsc_get_sc(&argc, &argv, &usc, dev) < 0) {
 178                                 explain1("ul");
 179                                 return -1;
 180                         }
 181                         usc_ok = 1;
 182                 } else if (matches(*argv, "help") == 0) {
 183                         explain_class();
 184                         return -1;
 185                 } else {
 186                         fprintf(stderr, "HFSC: What is \"%s\" ?\n", *argv);
 187                         explain_class();
 188                         return -1;
 189                 }
 190                 argc--, argv++;
 191         }
 192
 193         if (!(rsc_ok || fsc_ok || usc_ok)) {
 194                 fprintf(stderr, "HFSC: no parameters given\n");
 195                 explain_class();
 196                 return -1;
 197         }
 198         if (usc_ok && !fsc_ok) {
 199                 fprintf(stderr, "HFSC: Upper-limit Service Curve without Link-Share Service Curve\n");
 200                 explain_class();
 201                 return -1;
 202         }
 203
 204         tail = NLMSG_TAIL(n);
 205
 206         addattr_l(n, 1024, TCA_OPTIONS, NULL, 0);
 207         if (rsc_ok)
 208                 addattr_l(n, 1024, TCA_HFSC_RSC, &rsc, sizeof(rsc));
 209         if (fsc_ok)
 210                 addattr_l(n, 1024, TCA_HFSC_FSC, &fsc, sizeof(fsc));
 211         if (usc_ok)
 212                 addattr_l(n, 1024, TCA_HFSC_USC, &usc, sizeof(usc));
 213
 214         tail->rta_len = (void *) NLMSG_TAIL(n) - (void *) tail;
 215         return 0;
 216 }
 217
 218 static void
 219 hfsc_print_sc(FILE *f, char *name, struct tc_service_curve *sc)
 220 {
 221         SPRINT_BUF(b1);
 222
 223         fprintf(f, "%s ", name);
 224         fprintf(f, "m1 %s ", sprint_rate(sc->m1, b1));
 225         fprintf(f, "d %s ", sprint_time(tc_core_ktime2time(sc->d), b1));
 226         fprintf(f, "m2 %s ", sprint_rate(sc->m2, b1));
 227 }
 228
 229 static int
 230 hfsc_print_class_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 231 {
 232         struct rtattr *tb[TCA_HFSC_MAX+1];
 233         struct tc_service_curve *rsc = NULL, *fsc = NULL, *usc = NULL;
 234
 235         if (opt == NULL)
 236                 return 0;
 237
 238         parse_rtattr_nested(tb, TCA_HFSC_MAX, opt);
 239
 240         if (tb[TCA_HFSC_RSC]) {
 241                 if (RTA_PAYLOAD(tb[TCA_HFSC_RSC]) < sizeof(*rsc))
 242                         fprintf(stderr, "HFSC: truncated realtime option\n");
 243                 else
 244                         rsc = RTA_DATA(tb[TCA_HFSC_RSC]);
 245         }
 246         if (tb[TCA_HFSC_FSC]) {
 247                 if (RTA_PAYLOAD(tb[TCA_HFSC_FSC]) < sizeof(*fsc))
 248                         fprintf(stderr, "HFSC: truncated linkshare option\n");
 249                 else
 250                         fsc = RTA_DATA(tb[TCA_HFSC_FSC]);
 251         }
 252         if (tb[TCA_HFSC_USC]) {
 253                 if (RTA_PAYLOAD(tb[TCA_HFSC_USC]) < sizeof(*usc))
 254                         fprintf(stderr, "HFSC: truncated upperlimit option\n");
 255                 else
 256                         usc = RTA_DATA(tb[TCA_HFSC_USC]);
 257         }
 258
 259
 260         if (rsc != NULL && fsc != NULL &&
 261             memcmp(rsc, fsc, sizeof(*rsc)) == 0)
 262                 hfsc_print_sc(f, "sc", rsc);
 263         else {
 264                 if (rsc != NULL)
 265                         hfsc_print_sc(f, "rt", rsc);
 266                 if (fsc != NULL)
 267                         hfsc_print_sc(f, "ls", fsc);
 268         }
 269         if (usc != NULL)
 270                 hfsc_print_sc(f, "ul", usc);
 271
 272         return 0;
 273 }
 274
 275 struct qdisc_util hfsc_qdisc_util = {
 276         .id             = "hfsc",
 277         .parse_qopt     = hfsc_parse_opt,
 278         .print_qopt     = hfsc_print_opt,
 279         .print_xstats   = hfsc_print_xstats,
 280         .parse_copt     = hfsc_parse_class_opt,
 281         .print_copt     = hfsc_print_class_opt,
 282 };
 283
 284 static int
 285 hfsc_get_sc1(int *argcp, char ***argvp,
 286              struct tc_service_curve *sc, const char *dev)
 287 {
 288         char **argv = *argvp;
 289         int argc = *argcp;
 290         unsigned int m1 = 0, d = 0, m2 = 0;
 291
 292         if (matches(*argv, "m1") == 0) {
 293                 NEXT_ARG();
 294                 if (strchr(*argv, '%')) {
 295                         if (get_percent_rate(&m1, *argv, dev)) {
 296                                 explain1("m1");
 297                                 return -1;
 298                         }
 299                 } else if (get_rate(&m1, *argv) < 0) {
 300                         explain1("m1");
 301                         return -1;
 302                 }
 303                 NEXT_ARG();
 304         }
 305
 306         if (matches(*argv, "d") == 0) {
 307                 NEXT_ARG();
 308                 if (get_time(&d, *argv) < 0) {
 309                         explain1("d");
 310                         return -1;
 311                 }
 312                 NEXT_ARG();
 313         }
 314
 315         if (matches(*argv, "m2") == 0) {
 316                 NEXT_ARG();
 317                 if (strchr(*argv, '%')) {
 318                         if (get_percent_rate(&m2, *argv, dev)) {
 319                                 explain1("m2");
 320                                 return -1;
 321                         }
 322                 } else if (get_rate(&m2, *argv) < 0) {
 323                         explain1("m2");
 324                         return -1;
 325                 }
 326         } else
 327                 return -1;
 328
 329         sc->m1 = m1;
 330         sc->d  = tc_core_time2ktime(d);
 331         sc->m2 = m2;
 332
 333         *argvp = argv;
 334         *argcp = argc;
 335         return 0;
 336 }
 337
 338 static int
 339 hfsc_get_sc2(int *argcp, char ***argvp, struct tc_service_curve *sc, const char *dev)
 340 {
 341         char **argv = *argvp;
 342         int argc = *argcp;
 343         unsigned int umax = 0, dmax = 0, rate = 0;
 344
 345         if (matches(*argv, "umax") == 0) {
 346                 NEXT_ARG();
 347                 if (get_size(&umax, *argv) < 0) {
 348                         explain1("umax");
 349                         return -1;
 350                 }
 351                 NEXT_ARG();
 352         }
 353
 354         if (matches(*argv, "dmax") == 0) {
 355                 NEXT_ARG();
 356                 if (get_time(&dmax, *argv) < 0) {
 357                         explain1("dmax");
 358                         return -1;
 359                 }
 360                 NEXT_ARG();
 361         }
 362
 363         if (matches(*argv, "rate") == 0) {
 364                 NEXT_ARG();
 365                 if (strchr(*argv, '%')) {
 366                         if (get_percent_rate(&rate, *argv, dev)) {
 367                                 explain1("rate");
 368                                 return -1;
 369                         }
 370                 } else if (get_rate(&rate, *argv) < 0) {
 371                         explain1("rate");
 372                         return -1;
 373                 }
 374         } else
 375                 return -1;
 376
 377         if (umax != 0 && dmax == 0) {
 378                 fprintf(stderr, "HFSC: umax given but dmax is zero.\n");
 379                 return -1;
 380         }
 381
 382         if (dmax != 0 && ceil(1.0 * umax * TIME_UNITS_PER_SEC / dmax) > rate) {
 383                 /*
 384                  * concave curve, slope of first segment is umax/dmax,
 385                  * intersection is at dmax
 386                  */
 387                 sc->m1 = ceil(1.0 * umax * TIME_UNITS_PER_SEC / dmax); /* in bps */
 388                 sc->d  = tc_core_time2ktime(dmax);
 389                 sc->m2 = rate;
 390         } else {
 391                 /*
 392                  * convex curve, slope of first segment is 0, intersection
 393                  * is at dmax - umax / rate
 394                  */
 395                 sc->m1 = 0;
 396                 sc->d  = tc_core_time2ktime(ceil(dmax - umax * TIME_UNITS_PER_SEC / rate));
 397                 sc->m2 = rate;
 398         }
 399
 400         *argvp = argv;
 401         *argcp = argc;
 402         return 0;
 403 }
 404
 405 static int
 406 hfsc_get_sc(int *argcp, char ***argvp, struct tc_service_curve *sc, const char *dev)
 407 {
 408         if (hfsc_get_sc1(argcp, argvp, sc, dev) < 0 &&
 409             hfsc_get_sc2(argcp, argvp, sc, dev) < 0)
 410                 return -1;
 411
 412         if (sc->m1 == 0 && sc->m2 == 0) {
 413                 fprintf(stderr, "HFSC: Service Curve has two zero slopes\n");
 414                 return -1;
 415         }
 416
 417         return 0;
 418 }