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 (3.1 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) {
132 if (strcmp(str, "none") == 0)
134 maj = strtoul(str, &p, 16);
138 if (*p != ':' && *p != '\0')
145 /* Get class ID. Return 0 on success, !0 otherwise. */
146 static int get_tc_classid(uint32_t *h, const char *str) {
151 if (strcmp(str, "root") == 0)
154 if (strcmp(str, "none") == 0)
156 maj = strtoul(str, &p, 16);
167 min = strtoul(str, &p, 16);
168 //FIXME: check for "" too?
169 if (*p != '\0' || min >= (1<<16))
179 static void print_rate(char *buf, int len, uint32_t rate)
181 double tmp = (double)rate*8;
184 if (tmp >= 1000*1024*1024)
185 snprintf(buf, len, "%.0fMibit", tmp/(1024*1024));
186 else if (tmp >= 1000*1024)
187 snprintf(buf, len, "%.0fKibit", tmp/1024);
189 snprintf(buf, len, "%.0fbit", tmp);
191 if (tmp >= 1000*1000000)
192 snprintf(buf, len, "%.0fMbit", tmp/1000000);
193 else if (tmp >= 1000*1000)
194 snprintf(buf, len, "%.0fKbit", tmp/1000);
196 snprintf(buf, len, "%.0fbit", tmp);
201 /* This is "pfifo_fast". */
202 static int prio_parse_opt(int argc, char **argv, struct nlmsghdr *n)
207 static int prio_print_opt(struct rtattr *opt)
210 struct tc_prio_qopt *qopt;
211 struct rtattr *tb[TCA_PRIO_MAX+1];
215 parse_rtattr_nested_compat(tb, TCA_PRIO_MAX, opt, qopt, sizeof(*qopt));
218 printf("bands %u priomap ", qopt->bands);
219 for (i=0; i<=TC_PRIO_MAX; i++)
220 printf(" %d", qopt->priomap[i]);
223 printf(" multiqueue: o%s ",
224 *(unsigned char *)RTA_DATA(tb[TCA_PRIO_MQ]) ? "n" : "ff");
230 /* Class Based Queue */
231 static int cbq_parse_opt(int argc, char **argv, struct nlmsghdr *n)
236 static int cbq_print_opt(struct rtattr *opt)
238 struct rtattr *tb[TCA_CBQ_MAX+1];
239 struct tc_ratespec *r = NULL;
240 struct tc_cbq_lssopt *lss = NULL;
241 struct tc_cbq_wrropt *wrr = NULL;
242 struct tc_cbq_fopt *fopt = NULL;
243 struct tc_cbq_ovl *ovl = NULL;
244 const char *const error = "CBQ: too short %s opt";
249 parse_rtattr_nested(tb, TCA_CBQ_MAX, opt);
251 if (tb[TCA_CBQ_RATE]) {
252 if (RTA_PAYLOAD(tb[TCA_CBQ_RATE]) < sizeof(*r))
253 bb_error_msg(error, "rate");
255 r = RTA_DATA(tb[TCA_CBQ_RATE]);
257 if (tb[TCA_CBQ_LSSOPT]) {
258 if (RTA_PAYLOAD(tb[TCA_CBQ_LSSOPT]) < sizeof(*lss))
259 bb_error_msg(error, "lss");
261 lss = RTA_DATA(tb[TCA_CBQ_LSSOPT]);
263 if (tb[TCA_CBQ_WRROPT]) {
264 if (RTA_PAYLOAD(tb[TCA_CBQ_WRROPT]) < sizeof(*wrr))
265 bb_error_msg(error, "wrr");
267 wrr = RTA_DATA(tb[TCA_CBQ_WRROPT]);
269 if (tb[TCA_CBQ_FOPT]) {
270 if (RTA_PAYLOAD(tb[TCA_CBQ_FOPT]) < sizeof(*fopt))
271 bb_error_msg(error, "fopt");
273 fopt = RTA_DATA(tb[TCA_CBQ_FOPT]);
275 if (tb[TCA_CBQ_OVL_STRATEGY]) {
276 if (RTA_PAYLOAD(tb[TCA_CBQ_OVL_STRATEGY]) < sizeof(*ovl))
277 bb_error_msg("CBQ: too short overlimit strategy %u/%u",
278 (unsigned) RTA_PAYLOAD(tb[TCA_CBQ_OVL_STRATEGY]),
279 (unsigned) sizeof(*ovl));
281 ovl = RTA_DATA(tb[TCA_CBQ_OVL_STRATEGY]);
285 print_rate(buf, sizeof(buf), r->rate);
286 printf("rate %s ", buf);
288 printf("cell %ub ", 1<<r->cell_log);
290 printf("mpu %ub ", r->mpu);
292 printf("overhead %ub ", r->overhead);
295 if (lss && lss->flags) {
298 if (lss->flags&TCF_CBQ_LSS_BOUNDED) {
302 if (lss->flags&TCF_CBQ_LSS_ISOLATED) {
310 if (wrr->priority != TC_CBQ_MAXPRIO)
311 printf("prio %u", wrr->priority);
313 printf("prio no-transmit");
315 printf("/%u ", wrr->cpriority);
316 if (wrr->weight != 1) {
317 print_rate(buf, sizeof(buf), wrr->weight);
318 printf("weight %s ", buf);
321 printf("allot %ub ", wrr->allot);
328 static FAST_FUNC int print_qdisc(
329 const struct sockaddr_nl *who UNUSED_PARAM,
330 struct nlmsghdr *hdr,
331 void *arg UNUSED_PARAM)
333 struct tcmsg *msg = NLMSG_DATA(hdr);
334 int len = hdr->nlmsg_len;
335 struct rtattr * tb[TCA_MAX+1];
338 if (hdr->nlmsg_type != RTM_NEWQDISC && hdr->nlmsg_type != RTM_DELQDISC) {
339 /* bb_error_msg("not a qdisc"); */
340 return 0; /* ??? mimic upstream; should perhaps return -1 */
342 len -= NLMSG_LENGTH(sizeof(*msg));
344 /* bb_error_msg("wrong len %d", len); */
347 /* not the desired interface? */
348 if (filter_ifindex && filter_ifindex != msg->tcm_ifindex)
350 memset (tb, 0, sizeof(tb));
351 parse_rtattr(tb, TCA_MAX, TCA_RTA(msg), len);
352 if (tb[TCA_KIND] == NULL) {
353 /* bb_error_msg("%s: NULL kind", "qdisc"); */
356 if (hdr->nlmsg_type == RTM_DELQDISC)
358 name = (char*)RTA_DATA(tb[TCA_KIND]);
359 printf("qdisc %s %x: ", name, msg->tcm_handle>>16);
360 if (filter_ifindex == 0)
361 printf("dev %s ", ll_index_to_name(msg->tcm_ifindex));
362 if (msg->tcm_parent == TC_H_ROOT)
364 else if (msg->tcm_parent) {
365 char *classid = print_tc_classid(msg->tcm_parent);
366 printf("parent %s ", classid);
367 if (ENABLE_FEATURE_CLEAN_UP)
370 if (msg->tcm_info != 1)
371 printf("refcnt %d ", msg->tcm_info);
372 if (tb[TCA_OPTIONS]) {
373 static const char _q_[] ALIGN1 = "pfifo_fast\0""cbq\0";
374 int qqq = index_in_strings(_q_, name);
375 if (qqq == 0) { /* pfifo_fast aka prio */
376 prio_print_opt(tb[TCA_OPTIONS]);
377 } else if (qqq == 1) { /* class based queuing */
378 cbq_print_opt(tb[TCA_OPTIONS]);
380 bb_error_msg("unknown %s", name);
386 static FAST_FUNC int print_class(
387 const struct sockaddr_nl *who UNUSED_PARAM,
388 struct nlmsghdr *hdr,
389 void *arg UNUSED_PARAM)
391 struct tcmsg *msg = NLMSG_DATA(hdr);
392 int len = hdr->nlmsg_len;
393 struct rtattr * tb[TCA_MAX+1];
394 char *name, *classid;
396 /*XXX Eventually factor out common code */
398 if (hdr->nlmsg_type != RTM_NEWTCLASS && hdr->nlmsg_type != RTM_DELTCLASS) {
399 /* bb_error_msg("not a class"); */
400 return 0; /* ??? mimic upstream; should perhaps return -1 */
402 len -= NLMSG_LENGTH(sizeof(*msg));
404 /* bb_error_msg("wrong len %d", len); */
407 /* not the desired interface? */
408 if (filter_qdisc && TC_H_MAJ(msg->tcm_handle^filter_qdisc))
410 memset (tb, 0, sizeof(tb));
411 parse_rtattr(tb, TCA_MAX, TCA_RTA(msg), len);
412 if (tb[TCA_KIND] == NULL) {
413 /* bb_error_msg("%s: NULL kind", "class"); */
416 if (hdr->nlmsg_type == RTM_DELTCLASS)
419 name = (char*)RTA_DATA(tb[TCA_KIND]);
420 classid = !msg->tcm_handle ? NULL : print_tc_classid(
421 filter_qdisc ? TC_H_MIN(msg->tcm_parent) : msg->tcm_parent);
422 printf ("class %s %s", name, classid);
423 if (ENABLE_FEATURE_CLEAN_UP)
426 if (filter_ifindex == 0)
427 printf("dev %s ", ll_index_to_name(msg->tcm_ifindex));
428 if (msg->tcm_parent == TC_H_ROOT)
430 else if (msg->tcm_parent) {
431 classid = print_tc_classid(filter_qdisc ?
432 TC_H_MIN(msg->tcm_parent) : msg->tcm_parent);
433 printf("parent %s ", classid);
434 if (ENABLE_FEATURE_CLEAN_UP)
438 printf("leaf %x ", msg->tcm_info >> 16);
439 /* Do that get_qdisc_kind(RTA_DATA(tb[TCA_KIND])). */
440 if (tb[TCA_OPTIONS]) {
441 static const char _q_[] ALIGN1 = "pfifo_fast\0""cbq\0";
442 int qqq = index_in_strings(_q_, name);
443 if (qqq == 0) { /* pfifo_fast aka prio */
444 /* nothing. */ /*prio_print_opt(tb[TCA_OPTIONS]);*/
445 } else if (qqq == 1) { /* class based queuing */
446 /* cbq_print_copt() is identical to cbq_print_opt(). */
447 cbq_print_opt(tb[TCA_OPTIONS]);
449 bb_error_msg("unknown %s", name);
456 static FAST_FUNC int print_filter(
457 const struct sockaddr_nl *who UNUSED_PARAM,
458 struct nlmsghdr *hdr UNUSED_PARAM,
459 void *arg UNUSED_PARAM)
464 int tc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
465 int tc_main(int argc UNUSED_PARAM, char **argv)
467 static const char objects[] ALIGN1 =
468 "qdisc\0""class\0""filter\0"
470 enum { OBJ_qdisc = 0, OBJ_class, OBJ_filter };
471 static const char commands[] ALIGN1 =
472 "add\0""delete\0""change\0"
473 "link\0" /* only qdisc */
478 CMD_add = 0, CMD_del, CMD_change,
483 static const char args[] ALIGN1 =
484 "dev\0" /* qdisc, class, filter */
485 "root\0" /* class, filter */
486 "parent\0" /* class, filter */
487 "qdisc\0" /* class */
488 "handle\0" /* change: qdisc, class(classid) list: filter */
489 "classid\0" /* change: for class use "handle" */
490 "preference\0""priority\0""protocol\0" /* filter */
499 ARG_pref, ARG_prio, ARG_proto
501 struct rtnl_handle rth;
503 int ret, obj, cmd, arg;
513 obj = index_in_substrings(objects, *argv++);
518 cmd = CMD_show; /* list is the default */
520 cmd = index_in_substrings(commands, *argv);
522 invarg_1_to_2(*argv, argv[-1]);
526 memset(&msg, 0, sizeof(msg));
528 msg.tcm_family = AF_UNSPEC;
532 arg = index_in_substrings(args, *argv);
533 if (arg == ARG_dev) {
536 duparg2("dev", *argv);
538 msg.tcm_ifindex = xll_name_to_index(dev);
540 filter_ifindex = msg.tcm_ifindex;
542 if ((arg == ARG_qdisc && obj == OBJ_class && cmd >= CMD_show)
543 || (arg == ARG_handle && obj == OBJ_qdisc && cmd == CMD_change)
546 /* We don't care about duparg2("qdisc handle",*argv) for now */
547 if (get_qdisc_handle(&filter_qdisc, *argv))
548 invarg_1_to_2(*argv, "qdisc");
553 || (obj == OBJ_filter && arg >= ARG_pref)
558 invarg_1_to_2(*argv, "command");
561 if (arg == ARG_root) {
563 duparg("parent", *argv);
564 msg.tcm_parent = TC_H_ROOT;
565 if (obj == OBJ_filter)
566 filter_parent = TC_H_ROOT;
568 if (arg == ARG_parent) {
571 duparg(*argv, "parent");
572 if (get_tc_classid(&handle, *argv))
573 invarg_1_to_2(*argv, "parent");
574 msg.tcm_parent = handle;
575 if (obj == OBJ_filter)
576 filter_parent = handle;
578 if (arg == ARG_handle) { /* filter::list */
580 duparg(*argv, "handle");
581 /* reject LONG_MIN || LONG_MAX */
583 slash = strchr(handle, '/');
587 msg.tcm_handle = get_u32(*argv, "handle");
588 /* if (slash) {if (get_u32(uint32_t &mask, slash+1, NULL)) inv mask; addattr32(n, MAX_MSG, TCA_FW_MASK, mask); */
590 if (arg == ARG_classid
596 if (arg == ARG_pref || arg == ARG_prio) { /* filter::list */
598 duparg(*argv, "priority");
599 filter_prio = get_u32(*argv, "priority");
601 if (arg == ARG_proto) { /* filter::list */
604 duparg(*argv, "protocol");
605 if (ll_proto_a2n(&tmp, *argv))
606 invarg_1_to_2(*argv, "protocol");
611 if (cmd >= CMD_show) { /* show or list */
612 if (obj == OBJ_filter)
613 msg.tcm_info = TC_H_MAKE(filter_prio<<16, filter_proto);
614 if (rtnl_dump_request(&rth, obj == OBJ_qdisc ? RTM_GETQDISC :
615 obj == OBJ_class ? RTM_GETTCLASS : RTM_GETTFILTER,
616 &msg, sizeof(msg)) < 0)
617 bb_simple_perror_msg_and_die("can't send dump request");
619 xrtnl_dump_filter(&rth, obj == OBJ_qdisc ? print_qdisc :
620 obj == OBJ_class ? print_class : print_filter,
623 if (ENABLE_FEATURE_CLEAN_UP) {