Home | History | Annotate | Download | only in tc
      1 /*
      2  * m_police.c		Parse/print policing module options.
      3  *
      4  *		This program is free software; you can u32istribute 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 (at) ms2.inr.ac.ru>
     10  * FIXES:       19990619 - J Hadi Salim (hadi (at) cyberus.ca)
     11  *		simple addattr packaging fix.
     12  *		2002: J Hadi Salim - Add tc action extensions syntax
     13  *
     14  */
     15 
     16 #include <stdio.h>
     17 #include <stdlib.h>
     18 #include <unistd.h>
     19 #include <syslog.h>
     20 #include <fcntl.h>
     21 #include <sys/socket.h>
     22 #include <netinet/in.h>
     23 #include <arpa/inet.h>
     24 #include <string.h>
     25 
     26 #include "utils.h"
     27 #include "tc_util.h"
     28 
     29 struct action_util police_action_util = {
     30 	.id = "police",
     31 	.parse_aopt = act_parse_police,
     32 	.print_aopt = print_police,
     33 };
     34 
     35 static void usage(void)
     36 {
     37 	fprintf(stderr, "Usage: ... police rate BPS burst BYTES[/BYTES] [ mtu BYTES[/BYTES] ]\n");
     38 	fprintf(stderr, "                [ peakrate BPS ] [ avrate BPS ] [ overhead BYTES ]\n");
     39 	fprintf(stderr, "                [ linklayer TYPE ] [ ACTIONTERM ]\n");
     40 
     41 	fprintf(stderr, "New Syntax ACTIONTERM := conform-exceed <EXCEEDACT>[/NOTEXCEEDACT] \n");
     42 	fprintf(stderr, "Where: *EXCEEDACT := pipe | ok | reclassify | drop | continue \n");
     43 	fprintf(stderr, "Where:  pipe is only valid for new syntax \n");
     44 	exit(-1);
     45 }
     46 
     47 static void explain1(char *arg)
     48 {
     49 	fprintf(stderr, "Illegal \"%s\"\n", arg);
     50 }
     51 
     52 static const char *police_action_n2a(int action, char *buf, int len)
     53 {
     54 	switch (action) {
     55 	case -1:
     56 		return "continue";
     57 		break;
     58 	case TC_POLICE_OK:
     59 		return "pass";
     60 		break;
     61 	case TC_POLICE_SHOT:
     62 		return "drop";
     63 		break;
     64 	case TC_POLICE_RECLASSIFY:
     65 		return "reclassify";
     66 	case TC_POLICE_PIPE:
     67 		return "pipe";
     68 	default:
     69 		snprintf(buf, len, "%d", action);
     70 		return buf;
     71 	}
     72 }
     73 
     74 static int police_action_a2n(const char *arg, int *result)
     75 {
     76 	int res;
     77 
     78 	if (matches(arg, "continue") == 0)
     79 		res = -1;
     80 	else if (matches(arg, "drop") == 0)
     81 		res = TC_POLICE_SHOT;
     82 	else if (matches(arg, "shot") == 0)
     83 		res = TC_POLICE_SHOT;
     84 	else if (matches(arg, "pass") == 0)
     85 		res = TC_POLICE_OK;
     86 	else if (strcmp(arg, "ok") == 0)
     87 		res = TC_POLICE_OK;
     88 	else if (matches(arg, "reclassify") == 0)
     89 		res = TC_POLICE_RECLASSIFY;
     90 	else if (matches(arg, "pipe") == 0)
     91 		res = TC_POLICE_PIPE;
     92 	else {
     93 		char dummy;
     94 		if (sscanf(arg, "%d%c", &res, &dummy) != 1)
     95 			return -1;
     96 	}
     97 	*result = res;
     98 	return 0;
     99 }
    100 
    101 
    102 static int get_police_result(int *action, int *result, char *arg)
    103 {
    104 	char *p = strchr(arg, '/');
    105 
    106 	if (p)
    107 		*p = 0;
    108 
    109 	if (police_action_a2n(arg, action)) {
    110 		if (p)
    111 			*p = '/';
    112 		return -1;
    113 	}
    114 
    115 	if (p) {
    116 		*p = '/';
    117 		if (police_action_a2n(p+1, result))
    118 			return -1;
    119 	}
    120 	return 0;
    121 }
    122 
    123 
    124 int act_parse_police(struct action_util *a,int *argc_p, char ***argv_p, int tca_id, struct nlmsghdr *n)
    125 {
    126 	int argc = *argc_p;
    127 	char **argv = *argv_p;
    128 	int res = -1;
    129 	int ok=0;
    130 	struct tc_police p;
    131 	__u32 rtab[256];
    132 	__u32 ptab[256];
    133 	__u32 avrate = 0;
    134 	int presult = 0;
    135 	unsigned buffer=0, mtu=0, mpu=0;
    136 	unsigned short overhead=0;
    137 	unsigned int linklayer = LINKLAYER_ETHERNET; /* Assume ethernet */
    138 	int Rcell_log=-1, Pcell_log = -1;
    139 	struct rtattr *tail;
    140 
    141 	memset(&p, 0, sizeof(p));
    142 	p.action = TC_POLICE_RECLASSIFY;
    143 
    144 	if (a) /* new way of doing things */
    145 		NEXT_ARG();
    146 
    147 	if (argc <= 0)
    148 		return -1;
    149 
    150 	while (argc > 0) {
    151 
    152 		if (matches(*argv, "index") == 0) {
    153 			NEXT_ARG();
    154 			if (get_u32(&p.index, *argv, 10)) {
    155 				fprintf(stderr, "Illegal \"index\"\n");
    156 				return -1;
    157 			}
    158 		} else if (matches(*argv, "burst") == 0 ||
    159 			strcmp(*argv, "buffer") == 0 ||
    160 			strcmp(*argv, "maxburst") == 0) {
    161 			NEXT_ARG();
    162 			if (buffer) {
    163 				fprintf(stderr, "Double \"buffer/burst\" spec\n");
    164 				return -1;
    165 			}
    166 			if (get_size_and_cell(&buffer, &Rcell_log, *argv) < 0) {
    167 				explain1("buffer");
    168 				return -1;
    169 			}
    170 		} else if (strcmp(*argv, "mtu") == 0 ||
    171 			   strcmp(*argv, "minburst") == 0) {
    172 			NEXT_ARG();
    173 			if (mtu) {
    174 				fprintf(stderr, "Double \"mtu/minburst\" spec\n");
    175 				return -1;
    176 			}
    177 			if (get_size_and_cell(&mtu, &Pcell_log, *argv) < 0) {
    178 				explain1("mtu");
    179 				return -1;
    180 			}
    181 		} else if (strcmp(*argv, "mpu") == 0) {
    182 			NEXT_ARG();
    183 			if (mpu) {
    184 				fprintf(stderr, "Double \"mpu\" spec\n");
    185 				return -1;
    186 			}
    187 			if (get_size(&mpu, *argv)) {
    188 				explain1("mpu");
    189 				return -1;
    190 			}
    191 		} else if (strcmp(*argv, "rate") == 0) {
    192 			NEXT_ARG();
    193 			if (p.rate.rate) {
    194 				fprintf(stderr, "Double \"rate\" spec\n");
    195 				return -1;
    196 			}
    197 			if (get_rate(&p.rate.rate, *argv)) {
    198 				explain1("rate");
    199 				return -1;
    200 			}
    201 		} else if (strcmp(*argv, "avrate") == 0) {
    202 			NEXT_ARG();
    203 			if (avrate) {
    204 				fprintf(stderr, "Double \"avrate\" spec\n");
    205 				return -1;
    206 			}
    207 			if (get_rate(&avrate, *argv)) {
    208 				explain1("avrate");
    209 				return -1;
    210 			}
    211 		} else if (matches(*argv, "peakrate") == 0) {
    212 			NEXT_ARG();
    213 			if (p.peakrate.rate) {
    214 				fprintf(stderr, "Double \"peakrate\" spec\n");
    215 				return -1;
    216 			}
    217 			if (get_rate(&p.peakrate.rate, *argv)) {
    218 				explain1("peakrate");
    219 				return -1;
    220 			}
    221 		} else if (matches(*argv, "reclassify") == 0) {
    222 			p.action = TC_POLICE_RECLASSIFY;
    223 		} else if (matches(*argv, "drop") == 0 ||
    224 			   matches(*argv, "shot") == 0) {
    225 			p.action = TC_POLICE_SHOT;
    226 		} else if (matches(*argv, "continue") == 0) {
    227 			p.action = TC_POLICE_UNSPEC;
    228 		} else if (matches(*argv, "pass") == 0) {
    229 			p.action = TC_POLICE_OK;
    230 		} else if (matches(*argv, "pipe") == 0) {
    231 			p.action = TC_POLICE_PIPE;
    232 		} else if (strcmp(*argv, "conform-exceed") == 0) {
    233 			NEXT_ARG();
    234 			if (get_police_result(&p.action, &presult, *argv)) {
    235 				fprintf(stderr, "Illegal \"action\"\n");
    236 				return -1;
    237 			}
    238 		} else if (matches(*argv, "overhead") == 0) {
    239 			NEXT_ARG();
    240 			if (get_u16(&overhead, *argv, 10)) {
    241 				explain1("overhead"); return -1;
    242 			}
    243 		} else if (matches(*argv, "linklayer") == 0) {
    244 			NEXT_ARG();
    245 			if (get_linklayer(&linklayer, *argv)) {
    246 				explain1("linklayer"); return -1;
    247 			}
    248 		} else if (strcmp(*argv, "help") == 0) {
    249 			usage();
    250 		} else {
    251 			break;
    252 		}
    253 		ok++;
    254 		argc--; argv++;
    255 	}
    256 
    257 	if (!ok)
    258 		return -1;
    259 
    260 	if (p.rate.rate && !buffer) {
    261 		fprintf(stderr, "\"burst\" requires \"rate\".\n");
    262 		return -1;
    263 	}
    264 	if (p.peakrate.rate) {
    265 		if (!p.rate.rate) {
    266 			fprintf(stderr, "\"peakrate\" requires \"rate\".\n");
    267 			return -1;
    268 		}
    269 		if (!mtu) {
    270 			fprintf(stderr, "\"mtu\" is required, if \"peakrate\" is requested.\n");
    271 			return -1;
    272 		}
    273 	}
    274 
    275 	if (p.rate.rate) {
    276 		p.rate.mpu = mpu;
    277 		p.rate.overhead = overhead;
    278 		if (tc_calc_rtable(&p.rate, rtab, Rcell_log, mtu, linklayer) < 0) {
    279 			fprintf(stderr, "TBF: failed to calculate rate table.\n");
    280 			return -1;
    281 		}
    282 		p.burst = tc_calc_xmittime(p.rate.rate, buffer);
    283 	}
    284 	p.mtu = mtu;
    285 	if (p.peakrate.rate) {
    286 		p.peakrate.mpu = mpu;
    287 		p.peakrate.overhead = overhead;
    288 		if (tc_calc_rtable(&p.peakrate, ptab, Pcell_log, mtu, linklayer) < 0) {
    289 			fprintf(stderr, "POLICE: failed to calculate peak rate table.\n");
    290 			return -1;
    291 		}
    292 	}
    293 
    294 	tail = NLMSG_TAIL(n);
    295 	addattr_l(n, MAX_MSG, tca_id, NULL, 0);
    296 	addattr_l(n, MAX_MSG, TCA_POLICE_TBF, &p, sizeof(p));
    297 	if (p.rate.rate)
    298 		addattr_l(n, MAX_MSG, TCA_POLICE_RATE, rtab, 1024);
    299 	if (p.peakrate.rate)
    300                 addattr_l(n, MAX_MSG, TCA_POLICE_PEAKRATE, ptab, 1024);
    301 	if (avrate)
    302 		addattr32(n, MAX_MSG, TCA_POLICE_AVRATE, avrate);
    303 	if (presult)
    304 		addattr32(n, MAX_MSG, TCA_POLICE_RESULT, presult);
    305 
    306 	tail->rta_len = (void *) NLMSG_TAIL(n) - (void *) tail;
    307 	res = 0;
    308 
    309 	*argc_p = argc;
    310 	*argv_p = argv;
    311 	return res;
    312 }
    313 
    314 int parse_police(int *argc_p, char ***argv_p, int tca_id, struct nlmsghdr *n)
    315 {
    316 	return act_parse_police(NULL,argc_p,argv_p,tca_id,n);
    317 }
    318 
    319 int
    320 print_police(struct action_util *a, FILE *f, struct rtattr *arg)
    321 {
    322 	SPRINT_BUF(b1);
    323 	SPRINT_BUF(b2);
    324 	struct tc_police *p;
    325 	struct rtattr *tb[TCA_POLICE_MAX+1];
    326 	unsigned buffer;
    327 	unsigned int linklayer;
    328 
    329 	if (arg == NULL)
    330 		return 0;
    331 
    332 	parse_rtattr_nested(tb, TCA_POLICE_MAX, arg);
    333 
    334 	if (tb[TCA_POLICE_TBF] == NULL) {
    335 		fprintf(f, "[NULL police tbf]");
    336 		return 0;
    337 	}
    338 #ifndef STOOPID_8BYTE
    339 	if (RTA_PAYLOAD(tb[TCA_POLICE_TBF])  < sizeof(*p)) {
    340 		fprintf(f, "[truncated police tbf]");
    341 		return -1;
    342 	}
    343 #endif
    344 	p = RTA_DATA(tb[TCA_POLICE_TBF]);
    345 
    346 	fprintf(f, " police 0x%x ", p->index);
    347 	fprintf(f, "rate %s ", sprint_rate(p->rate.rate, b1));
    348 	buffer = tc_calc_xmitsize(p->rate.rate, p->burst);
    349 	fprintf(f, "burst %s ", sprint_size(buffer, b1));
    350 	fprintf(f, "mtu %s ", sprint_size(p->mtu, b1));
    351 	if (show_raw)
    352 		fprintf(f, "[%08x] ", p->burst);
    353 	if (p->peakrate.rate)
    354 		fprintf(f, "peakrate %s ", sprint_rate(p->peakrate.rate, b1));
    355 	if (tb[TCA_POLICE_AVRATE])
    356 		fprintf(f, "avrate %s ", sprint_rate(rta_getattr_u32(tb[TCA_POLICE_AVRATE]), b1));
    357 	fprintf(f, "action %s", police_action_n2a(p->action, b1, sizeof(b1)));
    358 	if (tb[TCA_POLICE_RESULT]) {
    359 		fprintf(f, "/%s ", police_action_n2a(*(int*)RTA_DATA(tb[TCA_POLICE_RESULT]), b1, sizeof(b1)));
    360 	} else
    361 		fprintf(f, " ");
    362 	fprintf(f, "overhead %ub ", p->rate.overhead);
    363 	linklayer = (p->rate.linklayer & TC_LINKLAYER_MASK);
    364 	if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
    365 		fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b2));
    366 	fprintf(f, "\nref %d bind %d\n",p->refcnt, p->bindcnt);
    367 
    368 	return 0;
    369 }
    370 
    371 int
    372 tc_print_police(FILE *f, struct rtattr *arg) {
    373 	return print_police(&police_action_util,f,arg);
    374 }
    375