1 /* vi: set sw=4 ts=4: */
3 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
5 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
7 * Bernhard Reutner-Fischer adjusted for busybox
10 //config: bool "tc (8.3 kb)"
13 //config: Show / manipulate traffic control settings
15 //config:config FEATURE_TC_INGRESS
16 //config: bool "Enable ingress"
18 //config: depends on TC
20 //applet:IF_TC(APPLET(tc, BB_DIR_SBIN, BB_SUID_DROP))
22 //kbuild:lib-$(CONFIG_TC) += tc.o
24 //usage:#define tc_trivial_usage
25 /* //usage: "[OPTIONS] OBJECT CMD [dev STRING]" */
26 //usage: "OBJECT CMD [dev STRING]"
27 //usage:#define tc_full_usage "\n\n"
28 //usage: "OBJECT: qdisc|class|filter\n"
29 //usage: "CMD: add|del|change|replace|show\n"
31 //usage: "qdisc [handle QHANDLE] [root|"IF_FEATURE_TC_INGRESS("ingress|")"parent CLASSID]\n"
32 /* //usage: "[estimator INTERVAL TIME_CONSTANT]\n" */
33 //usage: " [[QDISC_KIND] [help|OPTIONS]]\n"
34 //usage: " QDISC_KIND := [p|b]fifo|tbf|prio|cbq|red|etc.\n"
35 //usage: "qdisc show [dev STRING]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n"
36 //usage: "class [classid CLASSID] [root|parent CLASSID]\n"
37 //usage: " [[QDISC_KIND] [help|OPTIONS] ]\n"
38 //usage: "class show [ dev STRING ] [root|parent CLASSID]\n"
39 //usage: "filter [pref PRIO] [protocol PROTO]\n"
40 /* //usage: "\t[estimator INTERVAL TIME_CONSTANT]\n" */
41 //usage: " [root|classid CLASSID] [handle FILTERID]\n"
42 //usage: " [[FILTER_TYPE] [help|OPTIONS]]\n"
43 //usage: "filter show [dev STRING] [root|parent CLASSID]"
46 #include "common_bufsiz.h"
48 #include "libiproute/utils.h"
49 #include "libiproute/ip_common.h"
50 #include "libiproute/rt_names.h"
51 #include <linux/pkt_sched.h> /* for the TC_H_* macros */
53 /* This is the deprecated multiqueue interface */
61 #define TCA_PRIO_MAX (__TCA_PRIO_MAX - 1)
64 #define parse_rtattr_nested(tb, max, rta) \
65 (parse_rtattr((tb), (max), RTA_DATA(rta), RTA_PAYLOAD(rta)))
67 /* nullifies tb on error */
68 #define __parse_rtattr_nested_compat(tb, max, rta, len) \
70 if ((RTA_PAYLOAD(rta) >= len) \
71 && (RTA_PAYLOAD(rta) >= RTA_ALIGN(len) + sizeof(struct rtattr)) \
73 rta = RTA_DATA(rta) + RTA_ALIGN(len); \
74 parse_rtattr_nested(tb, max, rta); \
76 memset(tb, 0, sizeof(struct rtattr *) * (max + 1)); \
79 #define parse_rtattr_nested_compat(tb, max, rta, data, len) \
81 data = RTA_PAYLOAD(rta) >= len ? RTA_DATA(rta) : NULL; \
82 __parse_rtattr_nested_compat(tb, max, rta, len); \
85 #define show_details (0) /* not implemented. Does anyone need it? */
86 #define use_iec (0) /* not currently documented in the upstream manpage */
91 uint32_t filter_qdisc;
92 uint32_t filter_parent;
94 uint32_t filter_proto;
96 #define G (*(struct globals*)bb_common_bufsiz1)
97 #define filter_ifindex (G.filter_ifindex)
98 #define filter_qdisc (G.filter_qdisc)
99 #define filter_parent (G.filter_parent)
100 #define filter_prio (G.filter_prio)
101 #define filter_proto (G.filter_proto)
102 #define INIT_G() do { \
103 setup_common_bufsiz(); \
104 BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
107 /* Allocates a buffer containing the name of a class id.
108 * The caller must free the returned memory. */
109 static char* print_tc_classid(uint32_t cid)
111 #if 0 /* IMPOSSIBLE */
112 if (cid == TC_H_ROOT)
113 return xasprintf("root");
116 if (cid == TC_H_UNSPEC)
117 return xasprintf("none");
118 else if (TC_H_MAJ(cid) == 0)
119 return xasprintf(":%x", TC_H_MIN(cid));
120 else if (TC_H_MIN(cid) == 0)
121 return xasprintf("%x:", TC_H_MAJ(cid)>>16);
123 return xasprintf("%x:%x", TC_H_MAJ(cid)>>16, TC_H_MIN(cid));
126 /* Get a qdisc handle. Return 0 on success, !0 otherwise. */
127 static int get_qdisc_handle(uint32_t *h, const char *str)
133 if (strcmp(str, "none") == 0)
135 maj = strtoul(str, &p, 16);
139 if (*p != ':' && *p != '\0')
146 /* Get class ID. Return 0 on success, !0 otherwise. */
147 static int get_tc_classid(uint32_t *h, const char *str)
153 if (strcmp(str, "root") == 0)
156 if (strcmp(str, "none") == 0)
158 maj = strtoul(str, &p, 16);
169 min = strtoul(str, &p, 16);
170 //FIXME: check for "" too?
171 if (*p != '\0' || min >= (1<<16))
181 static void print_rate(char *buf, int len, uint32_t rate)
183 double tmp = (double)rate*8;
186 if (tmp >= 1000*1024*1024)
187 snprintf(buf, len, "%.0fMibit", tmp/(1024*1024));
188 else if (tmp >= 1000*1024)
189 snprintf(buf, len, "%.0fKibit", tmp/1024);
191 snprintf(buf, len, "%.0fbit", tmp);
193 if (tmp >= 1000*1000000)
194 snprintf(buf, len, "%.0fMbit", tmp/1000000);
195 else if (tmp >= 1000*1000)
196 snprintf(buf, len, "%.0fKbit", tmp/1000);
198 snprintf(buf, len, "%.0fbit", tmp);
203 /* This is "pfifo_fast". */
204 static int prio_parse_opt(int argc, char **argv, struct nlmsghdr *n)
209 static int prio_print_opt(struct rtattr *opt)
212 struct tc_prio_qopt *qopt;
213 struct rtattr *tb[TCA_PRIO_MAX+1];
217 parse_rtattr_nested_compat(tb, TCA_PRIO_MAX, opt, qopt, sizeof(*qopt));
220 printf("bands %u priomap ", qopt->bands);
221 for (i=0; i<=TC_PRIO_MAX; i++)
222 printf(" %d", qopt->priomap[i]);
225 printf(" multiqueue: o%s ",
226 *(unsigned char *)RTA_DATA(tb[TCA_PRIO_MQ]) ? "n" : "ff");
232 /* Class Based Queue */
233 static int cbq_parse_opt(int argc, char **argv, struct nlmsghdr *n)
238 static int cbq_print_opt(struct rtattr *opt)
240 struct rtattr *tb[TCA_CBQ_MAX+1];
241 struct tc_ratespec *r = NULL;
242 struct tc_cbq_lssopt *lss = NULL;
243 struct tc_cbq_wrropt *wrr = NULL;
244 struct tc_cbq_fopt *fopt = NULL;
245 struct tc_cbq_ovl *ovl = NULL;
246 const char *const error = "CBQ: too short %s opt";
251 parse_rtattr_nested(tb, TCA_CBQ_MAX, opt);
253 if (tb[TCA_CBQ_RATE]) {
254 if (RTA_PAYLOAD(tb[TCA_CBQ_RATE]) < sizeof(*r))
255 bb_error_msg(error, "rate");
257 r = RTA_DATA(tb[TCA_CBQ_RATE]);
259 if (tb[TCA_CBQ_LSSOPT]) {
260 if (RTA_PAYLOAD(tb[TCA_CBQ_LSSOPT]) < sizeof(*lss))
261 bb_error_msg(error, "lss");
263 lss = RTA_DATA(tb[TCA_CBQ_LSSOPT]);
265 if (tb[TCA_CBQ_WRROPT]) {
266 if (RTA_PAYLOAD(tb[TCA_CBQ_WRROPT]) < sizeof(*wrr))
267 bb_error_msg(error, "wrr");
269 wrr = RTA_DATA(tb[TCA_CBQ_WRROPT]);
271 if (tb[TCA_CBQ_FOPT]) {
272 if (RTA_PAYLOAD(tb[TCA_CBQ_FOPT]) < sizeof(*fopt))
273 bb_error_msg(error, "fopt");
275 fopt = RTA_DATA(tb[TCA_CBQ_FOPT]);
277 if (tb[TCA_CBQ_OVL_STRATEGY]) {
278 if (RTA_PAYLOAD(tb[TCA_CBQ_OVL_STRATEGY]) < sizeof(*ovl))
279 bb_error_msg("CBQ: too short overlimit strategy %u/%u",
280 (unsigned) RTA_PAYLOAD(tb[TCA_CBQ_OVL_STRATEGY]),
281 (unsigned) sizeof(*ovl));
283 ovl = RTA_DATA(tb[TCA_CBQ_OVL_STRATEGY]);
287 print_rate(buf, sizeof(buf), r->rate);
288 printf("rate %s ", buf);
290 printf("cell %ub ", 1<<r->cell_log);
292 printf("mpu %ub ", r->mpu);
294 printf("overhead %ub ", r->overhead);
297 if (lss && lss->flags) {
300 if (lss->flags&TCF_CBQ_LSS_BOUNDED) {
304 if (lss->flags&TCF_CBQ_LSS_ISOLATED) {
312 if (wrr->priority != TC_CBQ_MAXPRIO)
313 printf("prio %u", wrr->priority);
315 printf("prio no-transmit");
317 printf("/%u ", wrr->cpriority);
318 if (wrr->weight != 1) {
319 print_rate(buf, sizeof(buf), wrr->weight);
320 printf("weight %s ", buf);
323 printf("allot %ub ", wrr->allot);
330 static FAST_FUNC int print_qdisc(
331 const struct sockaddr_nl *who UNUSED_PARAM,
332 struct nlmsghdr *hdr,
333 void *arg UNUSED_PARAM)
335 struct tcmsg *msg = NLMSG_DATA(hdr);
336 int len = hdr->nlmsg_len;
337 struct rtattr * tb[TCA_MAX+1];
340 if (hdr->nlmsg_type != RTM_NEWQDISC && hdr->nlmsg_type != RTM_DELQDISC) {
341 /* bb_error_msg("not a qdisc"); */
342 return 0; /* ??? mimic upstream; should perhaps return -1 */
344 len -= NLMSG_LENGTH(sizeof(*msg));
346 /* bb_error_msg("wrong len %d", len); */
349 /* not the desired interface? */
350 if (filter_ifindex && filter_ifindex != msg->tcm_ifindex)
352 memset (tb, 0, sizeof(tb));
353 parse_rtattr(tb, TCA_MAX, TCA_RTA(msg), len);
354 if (tb[TCA_KIND] == NULL) {
355 /* bb_error_msg("%s: NULL kind", "qdisc"); */
358 if (hdr->nlmsg_type == RTM_DELQDISC)
360 name = (char*)RTA_DATA(tb[TCA_KIND]);
361 printf("qdisc %s %x: ", name, msg->tcm_handle>>16);
362 if (filter_ifindex == 0)
363 printf("dev %s ", ll_index_to_name(msg->tcm_ifindex));
364 if (msg->tcm_parent == TC_H_ROOT)
366 else if (msg->tcm_parent) {
367 char *classid = print_tc_classid(msg->tcm_parent);
368 printf("parent %s ", classid);
369 if (ENABLE_FEATURE_CLEAN_UP)
372 if (msg->tcm_info != 1)
373 printf("refcnt %d ", msg->tcm_info);
374 if (tb[TCA_OPTIONS]) {
375 static const char _q_[] ALIGN1 = "pfifo_fast\0""cbq\0";
376 int qqq = index_in_strings(_q_, name);
377 if (qqq == 0) { /* pfifo_fast aka prio */
378 prio_print_opt(tb[TCA_OPTIONS]);
379 } else if (qqq == 1) { /* class based queuing */
380 cbq_print_opt(tb[TCA_OPTIONS]);
382 bb_error_msg("unknown %s", name);
388 static FAST_FUNC int print_class(
389 const struct sockaddr_nl *who UNUSED_PARAM,
390 struct nlmsghdr *hdr,
391 void *arg UNUSED_PARAM)
393 struct tcmsg *msg = NLMSG_DATA(hdr);
394 int len = hdr->nlmsg_len;
395 struct rtattr * tb[TCA_MAX+1];
396 char *name, *classid;
398 /*XXX Eventually factor out common code */
400 if (hdr->nlmsg_type != RTM_NEWTCLASS && hdr->nlmsg_type != RTM_DELTCLASS) {
401 /* bb_error_msg("not a class"); */
402 return 0; /* ??? mimic upstream; should perhaps return -1 */
404 len -= NLMSG_LENGTH(sizeof(*msg));
406 /* bb_error_msg("wrong len %d", len); */
409 /* not the desired interface? */
410 if (filter_qdisc && TC_H_MAJ(msg->tcm_handle^filter_qdisc))
412 memset (tb, 0, sizeof(tb));
413 parse_rtattr(tb, TCA_MAX, TCA_RTA(msg), len);
414 if (tb[TCA_KIND] == NULL) {
415 /* bb_error_msg("%s: NULL kind", "class"); */
418 if (hdr->nlmsg_type == RTM_DELTCLASS)
421 name = (char*)RTA_DATA(tb[TCA_KIND]);
422 classid = !msg->tcm_handle ? NULL : print_tc_classid(
423 filter_qdisc ? TC_H_MIN(msg->tcm_parent) : msg->tcm_parent);
424 printf ("class %s %s", name, classid);
425 if (ENABLE_FEATURE_CLEAN_UP)
428 if (filter_ifindex == 0)
429 printf("dev %s ", ll_index_to_name(msg->tcm_ifindex));
430 if (msg->tcm_parent == TC_H_ROOT)
432 else if (msg->tcm_parent) {
433 classid = print_tc_classid(filter_qdisc ?
434 TC_H_MIN(msg->tcm_parent) : msg->tcm_parent);
435 printf("parent %s ", classid);
436 if (ENABLE_FEATURE_CLEAN_UP)
440 printf("leaf %x ", msg->tcm_info >> 16);
441 /* Do that get_qdisc_kind(RTA_DATA(tb[TCA_KIND])). */
442 if (tb[TCA_OPTIONS]) {
443 static const char _q_[] ALIGN1 = "pfifo_fast\0""cbq\0";
444 int qqq = index_in_strings(_q_, name);
445 if (qqq == 0) { /* pfifo_fast aka prio */
446 /* nothing. */ /*prio_print_opt(tb[TCA_OPTIONS]);*/
447 } else if (qqq == 1) { /* class based queuing */
448 /* cbq_print_copt() is identical to cbq_print_opt(). */
449 cbq_print_opt(tb[TCA_OPTIONS]);
451 bb_error_msg("unknown %s", name);
458 static FAST_FUNC int print_filter(
459 const struct sockaddr_nl *who UNUSED_PARAM,
460 struct nlmsghdr *hdr UNUSED_PARAM,
461 void *arg UNUSED_PARAM)
466 int tc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
467 int tc_main(int argc UNUSED_PARAM, char **argv)
469 static const char objects[] ALIGN1 =
470 "qdisc\0""class\0""filter\0"
472 enum { OBJ_qdisc = 0, OBJ_class, OBJ_filter };
473 static const char commands[] ALIGN1 =
474 "add\0""delete\0""change\0"
475 "link\0" /* only qdisc */
480 CMD_add = 0, CMD_del, CMD_change,
485 static const char args[] ALIGN1 =
486 "dev\0" /* qdisc, class, filter */
487 "root\0" /* class, filter */
488 "parent\0" /* class, filter */
489 "qdisc\0" /* class */
490 "handle\0" /* change: qdisc, class(classid) list: filter */
491 "classid\0" /* change: for class use "handle" */
492 "preference\0""priority\0""protocol\0" /* filter */
501 ARG_pref, ARG_prio, ARG_proto
503 struct rtnl_handle rth;
505 int ret, obj, cmd, arg;
515 obj = index_in_substrings(objects, *argv++);
520 cmd = CMD_show; /* list is the default */
522 cmd = index_in_substrings(commands, *argv);
524 invarg_1_to_2(*argv, argv[-1]);
528 memset(&msg, 0, sizeof(msg));
530 msg.tcm_family = AF_UNSPEC;
534 arg = index_in_substrings(args, *argv);
535 if (arg == ARG_dev) {
538 duparg2("dev", *argv);
540 msg.tcm_ifindex = xll_name_to_index(dev);
542 filter_ifindex = msg.tcm_ifindex;
544 if ((arg == ARG_qdisc && obj == OBJ_class && cmd >= CMD_show)
545 || (arg == ARG_handle && obj == OBJ_qdisc && cmd == CMD_change)
548 /* We don't care about duparg2("qdisc handle",*argv) for now */
549 if (get_qdisc_handle(&filter_qdisc, *argv))
550 invarg_1_to_2(*argv, "qdisc");
555 || (obj == OBJ_filter && arg >= ARG_pref)
560 invarg_1_to_2(*argv, "command");
563 if (arg == ARG_root) {
565 duparg("parent", *argv);
566 msg.tcm_parent = TC_H_ROOT;
567 if (obj == OBJ_filter)
568 filter_parent = TC_H_ROOT;
570 if (arg == ARG_parent) {
573 duparg(*argv, "parent");
574 if (get_tc_classid(&handle, *argv))
575 invarg_1_to_2(*argv, "parent");
576 msg.tcm_parent = handle;
577 if (obj == OBJ_filter)
578 filter_parent = handle;
580 if (arg == ARG_handle) { /* filter::list */
582 duparg(*argv, "handle");
583 /* reject LONG_MIN || LONG_MAX */
585 slash = strchr(handle, '/');
589 msg.tcm_handle = get_u32(*argv, "handle");
590 /* if (slash) {if (get_u32(uint32_t &mask, slash+1, NULL)) inv mask; addattr32(n, MAX_MSG, TCA_FW_MASK, mask); */
592 if (arg == ARG_classid
598 if (arg == ARG_pref || arg == ARG_prio) { /* filter::list */
600 duparg(*argv, "priority");
601 filter_prio = get_u32(*argv, "priority");
603 if (arg == ARG_proto) { /* filter::list */
606 duparg(*argv, "protocol");
607 if (ll_proto_a2n(&tmp, *argv))
608 invarg_1_to_2(*argv, "protocol");
613 if (cmd >= CMD_show) { /* show or list */
614 if (obj == OBJ_filter)
615 msg.tcm_info = TC_H_MAKE(filter_prio<<16, filter_proto);
616 if (rtnl_dump_request(&rth, obj == OBJ_qdisc ? RTM_GETQDISC :
617 obj == OBJ_class ? RTM_GETTCLASS : RTM_GETTFILTER,
618 &msg, sizeof(msg)) < 0)
619 bb_simple_perror_msg_and_die("can't send dump request");
621 xrtnl_dump_filter(&rth, obj == OBJ_qdisc ? print_qdisc :
622 obj == OBJ_class ? print_class : print_filter,
625 if (ENABLE_FEATURE_CLEAN_UP) {