tc/q_fq_codel.c

   1 /*
   2  * Fair Queue Codel
   3  *
   4  *  Copyright (C) 2012,2015 Eric Dumazet <edumazet@google.com>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The names of the authors may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * Alternatively, provided that this notice is retained in full, this
  19  * software may be distributed under the terms of the GNU General
  20  * Public License ("GPL") version 2, in which case the provisions of the
  21  * GPL apply INSTEAD OF those given above.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  34  * DAMAGE.
  35  *
  36  */
  37
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <unistd.h>
  41 #include <fcntl.h>
  42 #include <sys/socket.h>
  43 #include <netinet/in.h>
  44 #include <arpa/inet.h>
  45 #include <string.h>
  46
  47 #include "utils.h"
  48 #include "tc_util.h"
  49
  50 static void explain(void)
  51 {
  52         fprintf(stderr, "Usage: ... fq_codel [ limit PACKETS ] [ flows NUMBER ]\n");
  53         fprintf(stderr, "                    [ target TIME ] [ interval TIME ]\n");
  54         fprintf(stderr, "                    [ quantum BYTES ] [ [no]ecn ]\n");
  55         fprintf(stderr, "                    [ ce_threshold TIME ]\n");
  56 }
  57
  58 static int fq_codel_parse_opt(struct qdisc_util *qu, int argc, char **argv,
  59                               struct nlmsghdr *n, const char *dev)
  60 {
  61         unsigned int limit = 0;
  62         unsigned int flows = 0;
  63         unsigned int target = 0;
  64         unsigned int interval = 0;
  65         unsigned int quantum = 0;
  66         unsigned int ce_threshold = ~0U;
  67         unsigned int memory = ~0U;
  68         int ecn = -1;
  69         struct rtattr *tail;
  70
  71         while (argc > 0) {
  72                 if (strcmp(*argv, "limit") == 0) {
  73                         NEXT_ARG();
  74                         if (get_unsigned(&limit, *argv, 0)) {
  75                                 fprintf(stderr, "Illegal \"limit\"\n");
  76                                 return -1;
  77                         }
  78                 } else if (strcmp(*argv, "flows") == 0) {
  79                         NEXT_ARG();
  80                         if (get_unsigned(&flows, *argv, 0)) {
  81                                 fprintf(stderr, "Illegal \"flows\"\n");
  82                                 return -1;
  83                         }
  84                 } else if (strcmp(*argv, "quantum") == 0) {
  85                         NEXT_ARG();
  86                         if (get_unsigned(&quantum, *argv, 0)) {
  87                                 fprintf(stderr, "Illegal \"quantum\"\n");
  88                                 return -1;
  89                         }
  90                 } else if (strcmp(*argv, "target") == 0) {
  91                         NEXT_ARG();
  92                         if (get_time(&target, *argv)) {
  93                                 fprintf(stderr, "Illegal \"target\"\n");
  94                                 return -1;
  95                         }
  96                 } else if (strcmp(*argv, "ce_threshold") == 0) {
  97                         NEXT_ARG();
  98                         if (get_time(&ce_threshold, *argv)) {
  99                                 fprintf(stderr, "Illegal \"ce_threshold\"\n");
 100                                 return -1;
 101                         }
 102                 } else if (strcmp(*argv, "memory_limit") == 0) {
 103                         NEXT_ARG();
 104                         if (get_size(&memory, *argv)) {
 105                                 fprintf(stderr, "Illegal \"memory_limit\"\n");
 106                                 return -1;
 107                         }
 108                 } else if (strcmp(*argv, "interval") == 0) {
 109                         NEXT_ARG();
 110                         if (get_time(&interval, *argv)) {
 111                                 fprintf(stderr, "Illegal \"interval\"\n");
 112                                 return -1;
 113                         }
 114                 } else if (strcmp(*argv, "ecn") == 0) {
 115                         ecn = 1;
 116                 } else if (strcmp(*argv, "noecn") == 0) {
 117                         ecn = 0;
 118                 } else if (strcmp(*argv, "help") == 0) {
 119                         explain();
 120                         return -1;
 121                 } else {
 122                         fprintf(stderr, "What is \"%s\"?\n", *argv);
 123                         explain();
 124                         return -1;
 125                 }
 126                 argc--; argv++;
 127         }
 128
 129         tail = addattr_nest(n, 1024, TCA_OPTIONS);
 130         if (limit)
 131                 addattr_l(n, 1024, TCA_FQ_CODEL_LIMIT, &limit, sizeof(limit));
 132         if (flows)
 133                 addattr_l(n, 1024, TCA_FQ_CODEL_FLOWS, &flows, sizeof(flows));
 134         if (quantum)
 135                 addattr_l(n, 1024, TCA_FQ_CODEL_QUANTUM, &quantum, sizeof(quantum));
 136         if (interval)
 137                 addattr_l(n, 1024, TCA_FQ_CODEL_INTERVAL, &interval, sizeof(interval));
 138         if (target)
 139                 addattr_l(n, 1024, TCA_FQ_CODEL_TARGET, &target, sizeof(target));
 140         if (ecn != -1)
 141                 addattr_l(n, 1024, TCA_FQ_CODEL_ECN, &ecn, sizeof(ecn));
 142         if (ce_threshold != ~0U)
 143                 addattr_l(n, 1024, TCA_FQ_CODEL_CE_THRESHOLD,
 144                           &ce_threshold, sizeof(ce_threshold));
 145         if (memory != ~0U)
 146                 addattr_l(n, 1024, TCA_FQ_CODEL_MEMORY_LIMIT,
 147                           &memory, sizeof(memory));
 148
 149         addattr_nest_end(n, tail);
 150         return 0;
 151 }
 152
 153 static int fq_codel_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 154 {
 155         struct rtattr *tb[TCA_FQ_CODEL_MAX + 1];
 156         unsigned int limit;
 157         unsigned int flows;
 158         unsigned int interval;
 159         unsigned int target;
 160         unsigned int ecn;
 161         unsigned int quantum;
 162         unsigned int ce_threshold;
 163         unsigned int memory_limit;
 164
 165         SPRINT_BUF(b1);
 166
 167         if (opt == NULL)
 168                 return 0;
 169
 170         parse_rtattr_nested(tb, TCA_FQ_CODEL_MAX, opt);
 171
 172         if (tb[TCA_FQ_CODEL_LIMIT] &&
 173             RTA_PAYLOAD(tb[TCA_FQ_CODEL_LIMIT]) >= sizeof(__u32)) {
 174                 limit = rta_getattr_u32(tb[TCA_FQ_CODEL_LIMIT]);
 175                 print_uint(PRINT_ANY, "limit", "limit %up ", limit);
 176         }
 177         if (tb[TCA_FQ_CODEL_FLOWS] &&
 178             RTA_PAYLOAD(tb[TCA_FQ_CODEL_FLOWS]) >= sizeof(__u32)) {
 179                 flows = rta_getattr_u32(tb[TCA_FQ_CODEL_FLOWS]);
 180                 print_uint(PRINT_ANY, "flows", "flows %u ", flows);
 181         }
 182         if (tb[TCA_FQ_CODEL_QUANTUM] &&
 183             RTA_PAYLOAD(tb[TCA_FQ_CODEL_QUANTUM]) >= sizeof(__u32)) {
 184                 quantum = rta_getattr_u32(tb[TCA_FQ_CODEL_QUANTUM]);
 185                 print_uint(PRINT_ANY, "quantum", "quantum %u ", quantum);
 186         }
 187         if (tb[TCA_FQ_CODEL_TARGET] &&
 188             RTA_PAYLOAD(tb[TCA_FQ_CODEL_TARGET]) >= sizeof(__u32)) {
 189                 target = rta_getattr_u32(tb[TCA_FQ_CODEL_TARGET]);
 190                 print_uint(PRINT_JSON, "target", NULL, target);
 191                 print_string(PRINT_FP, NULL, "target %s ",
 192                              sprint_time(target, b1));
 193         }
 194         if (tb[TCA_FQ_CODEL_CE_THRESHOLD] &&
 195             RTA_PAYLOAD(tb[TCA_FQ_CODEL_CE_THRESHOLD]) >= sizeof(__u32)) {
 196                 ce_threshold = rta_getattr_u32(tb[TCA_FQ_CODEL_CE_THRESHOLD]);
 197                 print_uint(PRINT_JSON, "ce_threshold", NULL, ce_threshold);
 198                 print_string(PRINT_FP, NULL, "ce_threshold %s ",
 199                              sprint_time(ce_threshold, b1));
 200         }
 201         if (tb[TCA_FQ_CODEL_INTERVAL] &&
 202             RTA_PAYLOAD(tb[TCA_FQ_CODEL_INTERVAL]) >= sizeof(__u32)) {
 203                 interval = rta_getattr_u32(tb[TCA_FQ_CODEL_INTERVAL]);
 204                 print_uint(PRINT_JSON, "interval", NULL, interval);
 205                 print_string(PRINT_FP, NULL, "interval %s ",
 206                              sprint_time(interval, b1));
 207         }
 208         if (tb[TCA_FQ_CODEL_MEMORY_LIMIT] &&
 209             RTA_PAYLOAD(tb[TCA_FQ_CODEL_MEMORY_LIMIT]) >= sizeof(__u32)) {
 210                 memory_limit = rta_getattr_u32(tb[TCA_FQ_CODEL_MEMORY_LIMIT]);
 211                 print_uint(PRINT_JSON, "memory_limit", NULL, memory_limit);
 212                 print_string(PRINT_FP, NULL, "memory_limit %s ",
 213                              sprint_size(memory_limit, b1));
 214         }
 215         if (tb[TCA_FQ_CODEL_ECN] &&
 216             RTA_PAYLOAD(tb[TCA_FQ_CODEL_ECN]) >= sizeof(__u32)) {
 217                 ecn = rta_getattr_u32(tb[TCA_FQ_CODEL_ECN]);
 218                 if (ecn)
 219                         print_bool(PRINT_ANY, "ecn", "ecn ", true);
 220         }
 221
 222         return 0;
 223 }
 224
 225 static int fq_codel_print_xstats(struct qdisc_util *qu, FILE *f,
 226                                  struct rtattr *xstats)
 227 {
 228         struct tc_fq_codel_xstats _st = {}, *st;
 229
 230         SPRINT_BUF(b1);
 231
 232         if (xstats == NULL)
 233                 return 0;
 234
 235         st = RTA_DATA(xstats);
 236         if (RTA_PAYLOAD(xstats) < sizeof(*st)) {
 237                 memcpy(&_st, st, RTA_PAYLOAD(xstats));
 238                 st = &_st;
 239         }
 240         if (st->type == TCA_FQ_CODEL_XSTATS_QDISC) {
 241                 fprintf(f, "  maxpacket %u drop_overlimit %u new_flow_count %u ecn_mark %u",
 242                         st->qdisc_stats.maxpacket,
 243                         st->qdisc_stats.drop_overlimit,
 244                         st->qdisc_stats.new_flow_count,
 245                         st->qdisc_stats.ecn_mark);
 246                 if (st->qdisc_stats.ce_mark)
 247                         fprintf(f, " ce_mark %u", st->qdisc_stats.ce_mark);
 248                 if (st->qdisc_stats.memory_usage)
 249                         fprintf(f, " memory_used %u", st->qdisc_stats.memory_usage);
 250                 if (st->qdisc_stats.drop_overmemory)
 251                         fprintf(f, " drop_overmemory %u", st->qdisc_stats.drop_overmemory);
 252                 fprintf(f, "\n  new_flows_len %u old_flows_len %u",
 253                         st->qdisc_stats.new_flows_len,
 254                         st->qdisc_stats.old_flows_len);
 255         }
 256         if (st->type == TCA_FQ_CODEL_XSTATS_CLASS) {
 257                 fprintf(f, "  deficit %d count %u lastcount %u ldelay %s",
 258                         st->class_stats.deficit,
 259                         st->class_stats.count,
 260                         st->class_stats.lastcount,
 261                         sprint_time(st->class_stats.ldelay, b1));
 262                 if (st->class_stats.dropping) {
 263                         fprintf(f, " dropping");
 264                         if (st->class_stats.drop_next < 0)
 265                                 fprintf(f, " drop_next -%s",
 266                                         sprint_time(-st->class_stats.drop_next, b1));
 267                         else
 268                                 fprintf(f, " drop_next %s",
 269                                         sprint_time(st->class_stats.drop_next, b1));
 270                 }
 271         }
 272         return 0;
 273
 274 }
 275
 276 struct qdisc_util fq_codel_qdisc_util = {
 277         .id             = "fq_codel",
 278         .parse_qopt     = fq_codel_parse_opt,
 279         .print_qopt     = fq_codel_print_opt,
 280         .print_xstats   = fq_codel_print_xstats,
 281 };