[mirror_iproute2.git] / tc / q_tbf.c

/*
 * q_tbf.c		TBF.
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 *
 * Authors:	Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
 *
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <syslog.h>
#include <fcntl.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <string.h>

#include "utils.h"
#include "tc_util.h"

static void explain(void)
{
	fprintf(stderr, "Usage: ... tbf limit BYTES burst BYTES[/BYTES] rate KBPS [ mtu BYTES[/BYTES] ]\n");
	fprintf(stderr, "               [ peakrate KBPS ] [ latency TIME ] ");
	fprintf(stderr, "[ overhead BYTES ]\n");
}

static void explain1(char *arg)
{
	fprintf(stderr, "Illegal \"%s\"\n", arg);
}


#define usage() return(-1)

static int tbf_parse_opt(struct qdisc_util *qu, int argc, char **argv, struct nlmsghdr *n)
{
	int ok=0;
	struct tc_tbf_qopt opt;
	__u32 rtab[256];
	__u32 ptab[256];
	unsigned buffer=0, mtu=0, mpu=0, latency=0;
	int Rcell_log=-1, Pcell_log = -1;
	unsigned short overhead=0;
	struct rtattr *tail;

	memset(&opt, 0, sizeof(opt));

	while (argc > 0) {
		if (matches(*argv, "limit") == 0) {
			NEXT_ARG();
			if (opt.limit || latency) {
				fprintf(stderr, "Double \"limit/latency\" spec\n");
				return -1;
			}
			if (get_size(&opt.limit, *argv)) {
				explain1("limit");
				return -1;
			}
			ok++;
		} else if (matches(*argv, "latency") == 0) {
			NEXT_ARG();
			if (opt.limit || latency) {
				fprintf(stderr, "Double \"limit/latency\" spec\n");
				return -1;
			}
			if (get_time(&latency, *argv)) {
				explain1("latency");
				return -1;
			}
			ok++;
		} else if (matches(*argv, "burst") == 0 ||
			strcmp(*argv, "buffer") == 0 ||
			strcmp(*argv, "maxburst") == 0) {
			NEXT_ARG();
			if (buffer) {
				fprintf(stderr, "Double \"buffer/burst\" spec\n");
				return -1;
			}
			if (get_size_and_cell(&buffer, &Rcell_log, *argv) < 0) {
				explain1("buffer");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "mtu") == 0 ||
			   strcmp(*argv, "minburst") == 0) {
			NEXT_ARG();
			if (mtu) {
				fprintf(stderr, "Double \"mtu/minburst\" spec\n");
				return -1;
			}
			if (get_size_and_cell(&mtu, &Pcell_log, *argv) < 0) {
				explain1("mtu");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "mpu") == 0) {
			NEXT_ARG();
			if (mpu) {
				fprintf(stderr, "Double \"mpu\" spec\n");
				return -1;
			}
			if (get_size(&mpu, *argv)) {
				explain1("mpu");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "rate") == 0) {
			NEXT_ARG();
			if (opt.rate.rate) {
				fprintf(stderr, "Double \"rate\" spec\n");
				return -1;
			}
			if (get_rate(&opt.rate.rate, *argv)) {
				explain1("rate");
				return -1;
			}
			ok++;
		} else if (matches(*argv, "peakrate") == 0) {
			NEXT_ARG();
			if (opt.peakrate.rate) {
				fprintf(stderr, "Double \"peakrate\" spec\n");
				return -1;
			}
			if (get_rate(&opt.peakrate.rate, *argv)) {
				explain1("peakrate");
				return -1;
			}
			ok++;
		} else if (matches(*argv, "overhead") == 0) {
			NEXT_ARG();
			if (overhead) {
				fprintf(stderr, "Double \"overhead\" spec\n");
				return -1;
			}
			if (get_u16(&overhead, *argv, 10)) {
				explain1("overhead"); return -1;
			}
		} else if (strcmp(*argv, "help") == 0) {
			explain();
			return -1;
		} else {
			fprintf(stderr, "What is \"%s\"?\n", *argv);
			explain();
			return -1;
		}
		argc--; argv++;
	}

	if (!ok)
		return 0;

	if (opt.rate.rate == 0 || !buffer) {
		fprintf(stderr, "Both \"rate\" and \"burst\" are required.\n");
		return -1;
	}
	if (opt.peakrate.rate) {
		if (!mtu) {
			fprintf(stderr, "\"mtu\" is required, if \"peakrate\" is requested.\n");
			return -1;
		}
	}

	if (opt.limit == 0 && latency == 0) {
		fprintf(stderr, "Either \"limit\" or \"latency\" are required.\n");
		return -1;
	}

	if (opt.limit == 0) {
		double lim = opt.rate.rate*(double)latency/TIME_UNITS_PER_SEC + buffer;
		if (opt.peakrate.rate) {
			double lim2 = opt.peakrate.rate*(double)latency/TIME_UNITS_PER_SEC + mtu;
			if (lim2 < lim)
				lim = lim2;
		}
		opt.limit = lim;
	}

	opt.rate.mpu      = mpu;
	opt.rate.overhead = overhead;
	if (tc_calc_rtable(&opt.rate, rtab, Rcell_log, mtu) < 0) {
		fprintf(stderr, "TBF: failed to calculate rate table.\n");
		return -1;
	}
	opt.buffer = tc_calc_xmittime(opt.rate.rate, buffer);

	if (opt.peakrate.rate) {
		opt.peakrate.mpu      = mpu;
		opt.peakrate.overhead = overhead;
		if (tc_calc_rtable(&opt.peakrate, ptab, Pcell_log, mtu) < 0) {
			fprintf(stderr, "TBF: failed to calculate peak rate table.\n");
			return -1;
		}
		opt.mtu = tc_calc_xmittime(opt.peakrate.rate, mtu);
	}

	tail = NLMSG_TAIL(n);
	addattr_l(n, 1024, TCA_OPTIONS, NULL, 0);
	addattr_l(n, 2024, TCA_TBF_PARMS, &opt, sizeof(opt));
	addattr_l(n, 3024, TCA_TBF_RTAB, rtab, 1024);
	if (opt.peakrate.rate)
		addattr_l(n, 4096, TCA_TBF_PTAB, ptab, 1024);
	tail->rta_len = (void *) NLMSG_TAIL(n) - (void *) tail;
	return 0;
}

static int tbf_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
{
	struct rtattr *tb[TCA_TBF_PTAB+1];
	struct tc_tbf_qopt *qopt;
	double buffer, mtu;
	double latency;
	SPRINT_BUF(b1);
	SPRINT_BUF(b2);

	if (opt == NULL)
		return 0;

	parse_rtattr_nested(tb, TCA_TBF_PTAB, opt);

	if (tb[TCA_TBF_PARMS] == NULL)
		return -1;

	qopt = RTA_DATA(tb[TCA_TBF_PARMS]);
	if (RTA_PAYLOAD(tb[TCA_TBF_PARMS])  < sizeof(*qopt))
		return -1;
	fprintf(f, "rate %s ", sprint_rate(qopt->rate.rate, b1));
	buffer = tc_calc_xmitsize(qopt->rate.rate, qopt->buffer);
	if (show_details) {
		fprintf(f, "burst %s/%u mpu %s ", sprint_size(buffer, b1),
			1<<qopt->rate.cell_log, sprint_size(qopt->rate.mpu, b2));
	} else {
		fprintf(f, "burst %s ", sprint_size(buffer, b1));
	}
	if (show_raw)
		fprintf(f, "[%08x] ", qopt->buffer);
	if (qopt->peakrate.rate) {
		fprintf(f, "peakrate %s ", sprint_rate(qopt->peakrate.rate, b1));
		if (qopt->mtu || qopt->peakrate.mpu) {
			mtu = tc_calc_xmitsize(qopt->peakrate.rate, qopt->mtu);
			if (show_details) {
				fprintf(f, "mtu %s/%u mpu %s ", sprint_size(mtu, b1),
					1<<qopt->peakrate.cell_log, sprint_size(qopt->peakrate.mpu, b2));
			} else {
				fprintf(f, "minburst %s ", sprint_size(mtu, b1));
			}
			if (show_raw)
				fprintf(f, "[%08x] ", qopt->mtu);
		}
	}

	if (show_raw)
		fprintf(f, "limit %s ", sprint_size(qopt->limit, b1));

	latency = TIME_UNITS_PER_SEC*(qopt->limit/(double)qopt->rate.rate) - tc_core_tick2time(qopt->buffer);
	if (qopt->peakrate.rate) {
		double lat2 = TIME_UNITS_PER_SEC*(qopt->limit/(double)qopt->peakrate.rate) - tc_core_tick2time(qopt->mtu);
		if (lat2 > latency)
			latency = lat2;
	}
	fprintf(f, "lat %s ", sprint_time(latency, b1));

	if (qopt->rate.overhead) {
		fprintf(f, "overhead %d", qopt->rate.overhead);
	}

	return 0;
}

struct qdisc_util tbf_qdisc_util = {
	.id		= "tbf",
	.parse_qopt	= tbf_parse_opt,
	.print_qopt	= tbf_print_opt,
};
Commit	Line	Data
aba5acdf SH	1	/*
	2	* q_tbf.c TBF.
	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: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
	10	*
	11	*/
	12
	13	#include <stdio.h>
	14	#include <stdlib.h>
	15	#include <unistd.h>
	16	#include <syslog.h>
	17	#include <fcntl.h>
	18	#include <sys/socket.h>
	19	#include <netinet/in.h>
	20	#include <arpa/inet.h>
	21	#include <string.h>
	22
	23	#include "utils.h"
	24	#include "tc_util.h"
	25
	26	static void explain(void)
	27	{
	28	fprintf(stderr, "Usage: ... tbf limit BYTES burst BYTES[/BYTES] rate KBPS [ mtu BYTES[/BYTES] ]\n");
2c42579f JDB	29	fprintf(stderr, " [ peakrate KBPS ] [ latency TIME ] ");
2c42579f JDB	30	fprintf(stderr, "[ overhead BYTES ]\n");
aba5acdf SH	31	}
	32
	33	static void explain1(char *arg)
	34	{
	35	fprintf(stderr, "Illegal \"%s\"\n", arg);
	36	}
	37
	38
	39	#define usage() return(-1)
	40
	41	static int tbf_parse_opt(struct qdisc_util qu, int argc, char argv, struct nlmsghdr n)
	42	{
	43	int ok=0;
	44	struct tc_tbf_qopt opt;
	45	__u32 rtab[256];
	46	__u32 ptab[256];
	47	unsigned buffer=0, mtu=0, mpu=0, latency=0;
ae665a52	48	int Rcell_log=-1, Pcell_log = -1;
2c42579f	49	unsigned short overhead=0;
aba5acdf SH	50	struct rtattr *tail;
	51
	52	memset(&opt, 0, sizeof(opt));
	53
	54	while (argc > 0) {
	55	if (matches(*argv, "limit") == 0) {
	56	NEXT_ARG();
	57	if (opt.limit \|\| latency) {
	58	fprintf(stderr, "Double \"limit/latency\" spec\n");
	59	return -1;
	60	}
	61	if (get_size(&opt.limit, *argv)) {
	62	explain1("limit");
	63	return -1;
	64	}
	65	ok++;
	66	} else if (matches(*argv, "latency") == 0) {
	67	NEXT_ARG();
	68	if (opt.limit \|\| latency) {
	69	fprintf(stderr, "Double \"limit/latency\" spec\n");
	70	return -1;
	71	}
8f34caaf	72	if (get_time(&latency, *argv)) {
aba5acdf SH	73	explain1("latency");
	74	return -1;
	75	}
	76	ok++;
	77	} else if (matches(*argv, "burst") == 0 \|\|
	78	strcmp(*argv, "buffer") == 0 \|\|
	79	strcmp(*argv, "maxburst") == 0) {
	80	NEXT_ARG();
	81	if (buffer) {
	82	fprintf(stderr, "Double \"buffer/burst\" spec\n");
	83	return -1;
	84	}
	85	if (get_size_and_cell(&buffer, &Rcell_log, *argv) < 0) {
	86	explain1("buffer");
	87	return -1;
	88	}
	89	ok++;
	90	} else if (strcmp(*argv, "mtu") == 0 \|\|
	91	strcmp(*argv, "minburst") == 0) {
	92	NEXT_ARG();
	93	if (mtu) {
	94	fprintf(stderr, "Double \"mtu/minburst\" spec\n");
	95	return -1;
	96	}
	97	if (get_size_and_cell(&mtu, &Pcell_log, *argv) < 0) {
	98	explain1("mtu");
	99	return -1;
	100	}
	101	ok++;
	102	} else if (strcmp(*argv, "mpu") == 0) {
	103	NEXT_ARG();
	104	if (mpu) {
	105	fprintf(stderr, "Double \"mpu\" spec\n");
	106	return -1;
	107	}
	108	if (get_size(&mpu, *argv)) {
	109	explain1("mpu");
	110	return -1;
	111	}
	112	ok++;
	113	} else if (strcmp(*argv, "rate") == 0) {
	114	NEXT_ARG();
	115	if (opt.rate.rate) {
	116	fprintf(stderr, "Double \"rate\" spec\n");
	117	return -1;
	118	}
	119	if (get_rate(&opt.rate.rate, *argv)) {
	120	explain1("rate");
	121	return -1;
	122	}
	123	ok++;
	124	} else if (matches(*argv, "peakrate") == 0) {
	125	NEXT_ARG();
	126	if (opt.peakrate.rate) {
	127	fprintf(stderr, "Double \"peakrate\" spec\n");
	128	return -1;
	129	}
	130	if (get_rate(&opt.peakrate.rate, *argv)) {
	131	explain1("peakrate");
	132	return -1;
	133	}
	134	ok++;
2c42579f JDB	135	} else if (matches(*argv, "overhead") == 0) {
	136	NEXT_ARG();
	137	if (overhead) {
	138	fprintf(stderr, "Double \"overhead\" spec\n");
	139	return -1;
	140	}
	141	if (get_u16(&overhead, *argv, 10)) {
	142	explain1("overhead"); return -1;
	143	}
aba5acdf SH	144	} else if (strcmp(*argv, "help") == 0) {
	145	explain();
	146	return -1;
	147	} else {
	148	fprintf(stderr, "What is \"%s\"?\n", *argv);
	149	explain();
	150	return -1;
	151	}
	152	argc--; argv++;
	153	}
	154
	155	if (!ok)
	156	return 0;
	157
	158	if (opt.rate.rate == 0 \|\| !buffer) {
	159	fprintf(stderr, "Both \"rate\" and \"burst\" are required.\n");
	160	return -1;
	161	}
	162	if (opt.peakrate.rate) {
	163	if (!mtu) {
	164	fprintf(stderr, "\"mtu\" is required, if \"peakrate\" is requested.\n");
	165	return -1;
	166	}
	167	}
	168
	169	if (opt.limit == 0 && latency == 0) {
	170	fprintf(stderr, "Either \"limit\" or \"latency\" are required.\n");
	171	return -1;
	172	}
	173
	174	if (opt.limit == 0) {
f0bda7e5	175	double lim = opt.rate.rate*(double)latency/TIME_UNITS_PER_SEC + buffer;
aba5acdf	176	if (opt.peakrate.rate) {
f0bda7e5	177	double lim2 = opt.peakrate.rate*(double)latency/TIME_UNITS_PER_SEC + mtu;
aba5acdf SH	178	if (lim2 < lim)
	179	lim = lim2;
	180	}
	181	opt.limit = lim;
	182	}
	183
2c42579f JDB	184	opt.rate.mpu = mpu;
2c42579f JDB	185	opt.rate.overhead = overhead;
d5f46f9c	186	if (tc_calc_rtable(&opt.rate, rtab, Rcell_log, mtu) < 0) {
aba5acdf SH	187	fprintf(stderr, "TBF: failed to calculate rate table.\n");
	188	return -1;
	189	}
	190	opt.buffer = tc_calc_xmittime(opt.rate.rate, buffer);
d5f46f9c	191
aba5acdf	192	if (opt.peakrate.rate) {
2c42579f JDB	193	opt.peakrate.mpu = mpu;
2c42579f JDB	194	opt.peakrate.overhead = overhead;
d5f46f9c	195	if (tc_calc_rtable(&opt.peakrate, ptab, Pcell_log, mtu) < 0) {
aba5acdf SH	196	fprintf(stderr, "TBF: failed to calculate peak rate table.\n");
	197	return -1;
	198	}
	199	opt.mtu = tc_calc_xmittime(opt.peakrate.rate, mtu);
aba5acdf SH	200	}
aba5acdf SH	201
228569c3	202	tail = NLMSG_TAIL(n);
aba5acdf SH	203	addattr_l(n, 1024, TCA_OPTIONS, NULL, 0);
	204	addattr_l(n, 2024, TCA_TBF_PARMS, &opt, sizeof(opt));
	205	addattr_l(n, 3024, TCA_TBF_RTAB, rtab, 1024);
	206	if (opt.peakrate.rate)
	207	addattr_l(n, 4096, TCA_TBF_PTAB, ptab, 1024);
228569c3	208	tail->rta_len = (void ) NLMSG_TAIL(n) - (void ) tail;
aba5acdf SH	209	return 0;
	210	}
	211
	212	static int tbf_print_opt(struct qdisc_util qu, FILE f, struct rtattr *opt)
	213	{
	214	struct rtattr *tb[TCA_TBF_PTAB+1];
	215	struct tc_tbf_qopt *qopt;
	216	double buffer, mtu;
	217	double latency;
	218	SPRINT_BUF(b1);
	219	SPRINT_BUF(b2);
	220
	221	if (opt == NULL)
	222	return 0;
	223
3b3ecd31	224	parse_rtattr_nested(tb, TCA_TBF_PTAB, opt);
aba5acdf SH	225
	226	if (tb[TCA_TBF_PARMS] == NULL)
	227	return -1;
	228
	229	qopt = RTA_DATA(tb[TCA_TBF_PARMS]);
	230	if (RTA_PAYLOAD(tb[TCA_TBF_PARMS]) < sizeof(*qopt))
	231	return -1;
	232	fprintf(f, "rate %s ", sprint_rate(qopt->rate.rate, b1));
76dc0aa2	233	buffer = tc_calc_xmitsize(qopt->rate.rate, qopt->buffer);
aba5acdf SH	234	if (show_details) {
	235	fprintf(f, "burst %s/%u mpu %s ", sprint_size(buffer, b1),
	236	1<<qopt->rate.cell_log, sprint_size(qopt->rate.mpu, b2));
	237	} else {
	238	fprintf(f, "burst %s ", sprint_size(buffer, b1));
	239	}
	240	if (show_raw)
	241	fprintf(f, "[%08x] ", qopt->buffer);
	242	if (qopt->peakrate.rate) {
	243	fprintf(f, "peakrate %s ", sprint_rate(qopt->peakrate.rate, b1));
	244	if (qopt->mtu \|\| qopt->peakrate.mpu) {
76dc0aa2	245	mtu = tc_calc_xmitsize(qopt->peakrate.rate, qopt->mtu);
aba5acdf SH	246	if (show_details) {
	247	fprintf(f, "mtu %s/%u mpu %s ", sprint_size(mtu, b1),
	248	1<<qopt->peakrate.cell_log, sprint_size(qopt->peakrate.mpu, b2));
	249	} else {
	250	fprintf(f, "minburst %s ", sprint_size(mtu, b1));
	251	}
	252	if (show_raw)
	253	fprintf(f, "[%08x] ", qopt->mtu);
	254	}
	255	}
	256
	257	if (show_raw)
	258	fprintf(f, "limit %s ", sprint_size(qopt->limit, b1));
	259
8f34caaf	260	latency = TIME_UNITS_PER_SEC*(qopt->limit/(double)qopt->rate.rate) - tc_core_tick2time(qopt->buffer);
aba5acdf	261	if (qopt->peakrate.rate) {
8f34caaf	262	double lat2 = TIME_UNITS_PER_SEC*(qopt->limit/(double)qopt->peakrate.rate) - tc_core_tick2time(qopt->mtu);
aba5acdf SH	263	if (lat2 > latency)
	264	latency = lat2;
	265	}
8f34caaf	266	fprintf(f, "lat %s ", sprint_time(latency, b1));
aba5acdf	267
2c42579f JDB	268	if (qopt->rate.overhead) {
	269	fprintf(f, "overhead %d", qopt->rate.overhead);
	270	}
	271
aba5acdf SH	272	return 0;
	273	}
	274
95812b56	275	struct qdisc_util tbf_qdisc_util = {
f2f99e2e SH	276	.id = "tbf",
	277	.parse_qopt = tbf_parse_opt,
	278	.print_qopt = tbf_print_opt,
aba5acdf SH	279	};
aba5acdf SH	280