[mirror_iproute2.git] / tc / q_sfq.c

/*
 * q_sfq.c		SFQ.
 *
 *		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 <fcntl.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <string.h>
#include <math.h>

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

static void explain(void)
{
	fprintf(stderr,
		"Usage: ... sfq	[ limit NUMBER ] [ perturb SECS ] [ quantum BYTES ]\n"
		"		[ divisor NUMBER ] [ flows NUMBER] [ depth NUMBER ]\n"
		"		[ headdrop ]\n"
		"		[ redflowlimit BYTES ] [ min BYTES ] [ max BYTES ]\n"
		"		[ avpkt BYTES ] [ burst PACKETS ] [ probability P ]\n"
		"		[ ecn ] [ harddrop ]\n");
}

static int sfq_parse_opt(struct qdisc_util *qu, int argc, char **argv, struct nlmsghdr *n, const char *dev)
{
	int ok = 0, red = 0;
	struct tc_sfq_qopt_v1 opt = {};
	unsigned int burst = 0;
	int wlog;
	unsigned int avpkt = 1000;
	double probability = 0.02;

	while (argc > 0) {
		if (strcmp(*argv, "quantum") == 0) {
			NEXT_ARG();
			if (get_size(&opt.v0.quantum, *argv)) {
				fprintf(stderr, "Illegal \"limit\"\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "perturb") == 0) {
			NEXT_ARG();
			if (get_integer(&opt.v0.perturb_period, *argv, 0)) {
				fprintf(stderr, "Illegal \"perturb\"\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "limit") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.v0.limit, *argv, 0)) {
				fprintf(stderr, "Illegal \"limit\"\n");
				return -1;
			}
			if (opt.v0.limit < 2) {
				fprintf(stderr, "Illegal \"limit\", must be > 1\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "divisor") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.v0.divisor, *argv, 0)) {
				fprintf(stderr, "Illegal \"divisor\"\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "flows") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.v0.flows, *argv, 0)) {
				fprintf(stderr, "Illegal \"flows\"\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "depth") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.depth, *argv, 0)) {
				fprintf(stderr, "Illegal \"flows\"\n");
				return -1;
			}
			ok++;
		} else if (strcmp(*argv, "headdrop") == 0) {
			opt.headdrop = 1;
			ok++;
		} else if (strcmp(*argv, "redflowlimit") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.limit, *argv, 0)) {
				fprintf(stderr, "Illegal \"redflowlimit\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "min") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.qth_min, *argv, 0)) {
				fprintf(stderr, "Illegal \"min\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "max") == 0) {
			NEXT_ARG();
			if (get_u32(&opt.qth_max, *argv, 0)) {
				fprintf(stderr, "Illegal \"max\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "burst") == 0) {
			NEXT_ARG();
			if (get_unsigned(&burst, *argv, 0)) {
				fprintf(stderr, "Illegal \"burst\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "avpkt") == 0) {
			NEXT_ARG();
			if (get_size(&avpkt, *argv)) {
				fprintf(stderr, "Illegal \"avpkt\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "probability") == 0) {
			NEXT_ARG();
			if (sscanf(*argv, "%lg", &probability) != 1) {
				fprintf(stderr, "Illegal \"probability\"\n");
				return -1;
			}
			red++;
		} else if (strcmp(*argv, "ecn") == 0) {
			opt.flags |= TC_RED_ECN;
			red++;
		} else if (strcmp(*argv, "harddrop") == 0) {
			opt.flags |= TC_RED_HARDDROP;
			red++;
		} else if (strcmp(*argv, "help") == 0) {
			explain();
			return -1;
		} else {
			fprintf(stderr, "What is \"%s\"?\n", *argv);
			explain();
			return -1;
		}
		argc--; argv++;
	}
	if (red) {
		if (!opt.limit) {
			fprintf(stderr, "Required parameter (redflowlimit) is missing\n");
			return -1;
		}
		/* Compute default min/max thresholds based on
		   Sally Floyd's recommendations:
		   http://www.icir.org/floyd/REDparameters.txt
		*/
		if (!opt.qth_max)
			opt.qth_max = opt.limit / 4;
		if (!opt.qth_min)
			opt.qth_min = opt.qth_max / 3;
		if (!burst)
			burst = (2 * opt.qth_min + opt.qth_max) / (3 * avpkt);

		if (opt.qth_max > opt.limit) {
			fprintf(stderr, "\"max\" is larger than \"limit\"\n");
			return -1;
		}

		if (opt.qth_min >= opt.qth_max) {
			fprintf(stderr, "\"min\" is not smaller than \"max\"\n");
			return -1;
		}

		wlog = tc_red_eval_ewma(opt.qth_min, burst, avpkt);
		if (wlog < 0) {
			fprintf(stderr, "SFQ: failed to calculate EWMA constant.\n");
			return -1;
		}
		if (wlog >= 10)
			fprintf(stderr, "SFQ: WARNING. Burst %u seems to be too large.\n", burst);
		opt.Wlog = wlog;

		wlog = tc_red_eval_P(opt.qth_min, opt.qth_max, probability);
		if (wlog < 0) {
			fprintf(stderr, "SFQ: failed to calculate probability.\n");
			return -1;
		}
		opt.Plog = wlog;
		opt.max_P = probability * pow(2, 32);
	}

	if (ok || red)
		addattr_l(n, 1024, TCA_OPTIONS, &opt, sizeof(opt));
	return 0;
}

static int sfq_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
{
	struct tc_sfq_qopt *qopt;
	struct tc_sfq_qopt_v1 *qopt_ext = NULL;

	SPRINT_BUF(b1);
	SPRINT_BUF(b2);
	SPRINT_BUF(b3);
	if (opt == NULL)
		return 0;

	if (RTA_PAYLOAD(opt)  < sizeof(*qopt))
		return -1;
	if (RTA_PAYLOAD(opt) >= sizeof(*qopt_ext))
		qopt_ext = RTA_DATA(opt);
	qopt = RTA_DATA(opt);

	print_uint(PRINT_ANY, "limit", "limit %up ", qopt->limit);
	print_uint(PRINT_JSON, "quantum", NULL, qopt->quantum);
	print_string(PRINT_FP, NULL, "quantum %s ",
		     sprint_size(qopt->quantum, b1));

	if (qopt_ext && qopt_ext->depth)
		print_uint(PRINT_ANY, "depth", "depth %u ", qopt_ext->depth);
	if (qopt_ext && qopt_ext->headdrop)
		print_bool(PRINT_ANY, "headdrop", "headdrop ", true);
	if (show_details)
		print_uint(PRINT_ANY, "flows", "flows %u ", qopt->flows);

	print_uint(PRINT_ANY, "divisor", "divisor %u ", qopt->divisor);

	if (qopt->perturb_period)
		print_int(PRINT_ANY, "perturb", "perturb %dsec ",
			   qopt->perturb_period);
	if (qopt_ext && qopt_ext->qth_min) {
		print_uint(PRINT_ANY, "ewma", "ewma %u ", qopt_ext->Wlog);
		print_uint(PRINT_JSON, "min", NULL, qopt_ext->qth_min);
		print_string(PRINT_FP, NULL, "min %s ",
			     sprint_size(qopt_ext->qth_min, b2));
		print_uint(PRINT_JSON, "max", NULL, qopt_ext->qth_max);
		print_string(PRINT_FP, NULL, "max %s ",
			     sprint_size(qopt_ext->qth_max, b3));
		print_float(PRINT_ANY, "probability", "probability %lg ",
			    qopt_ext->max_P / pow(2, 32));
		tc_red_print_flags(qopt_ext->flags);
		if (show_stats) {
			print_nl();
			print_uint(PRINT_ANY, "prob_mark", "  prob_mark %u",
				   qopt_ext->stats.prob_mark);
			print_uint(PRINT_ANY, "prob_mark_head",
				   " prob_mark_head %u",
				   qopt_ext->stats.prob_mark_head);
			print_uint(PRINT_ANY, "prob_drop", " prob_drop %u",
				   qopt_ext->stats.prob_drop);
			print_nl();
			print_uint(PRINT_ANY, "forced_mark",
				   "  forced_mark %u",
				   qopt_ext->stats.forced_mark);
			print_uint(PRINT_ANY, "forced_mark_head",
				   " forced_mark_head %u",
				   qopt_ext->stats.forced_mark_head);
			print_uint(PRINT_ANY, "forced_drop", " forced_drop %u",
				   qopt_ext->stats.forced_drop);
		}
	}
	return 0;
}

static int sfq_print_xstats(struct qdisc_util *qu, FILE *f,
			    struct rtattr *xstats)
{
	struct tc_sfq_xstats *st;

	if (xstats == NULL)
		return 0;
	if (RTA_PAYLOAD(xstats) < sizeof(*st))
		return -1;
	st = RTA_DATA(xstats);

	print_int(PRINT_ANY, "allot", "  allot %d", st->allot);

	return 0;
}

struct qdisc_util sfq_qdisc_util = {
	.id		= "sfq",
	.parse_qopt	= sfq_parse_opt,
	.print_qopt	= sfq_print_opt,
	.print_xstats	= sfq_print_xstats,
};
Commit	Line	Data
aba5acdf SH	1	/*
	2	* q_sfq.c SFQ.
	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>
aba5acdf SH	16	#include <fcntl.h>
	17	#include <sys/socket.h>
	18	#include <netinet/in.h>
	19	#include <arpa/inet.h>
	20	#include <string.h>
6987ecf0	21	#include <math.h>
aba5acdf SH	22
	23	#include "utils.h"
	24	#include "tc_util.h"
6987ecf0	25	#include "tc_red.h"
aba5acdf SH	26
	27	static void explain(void)
	28	{
8589eb4e MC	29	fprintf(stderr,
	30	"Usage: ... sfq [ limit NUMBER ] [ perturb SECS ] [ quantum BYTES ]\n"
	31	" [ divisor NUMBER ] [ flows NUMBER] [ depth NUMBER ]\n"
	32	" [ headdrop ]\n"
	33	" [ redflowlimit BYTES ] [ min BYTES ] [ max BYTES ]\n"
	34	" [ avpkt BYTES ] [ burst PACKETS ] [ probability P ]\n"
	35	" [ ecn ] [ harddrop ]\n");
aba5acdf SH	36	}
aba5acdf SH	37
927e3cfb	38	static int sfq_parse_opt(struct qdisc_util qu, int argc, char argv, struct nlmsghdr n, const char *dev)
aba5acdf	39	{
6987ecf0	40	int ok = 0, red = 0;
d17b136f	41	struct tc_sfq_qopt_v1 opt = {};
6987ecf0 ED	42	unsigned int burst = 0;
	43	int wlog;
	44	unsigned int avpkt = 1000;
	45	double probability = 0.02;
aba5acdf	46
aba5acdf SH	47	while (argc > 0) {
	48	if (strcmp(*argv, "quantum") == 0) {
	49	NEXT_ARG();
6987ecf0	50	if (get_size(&opt.v0.quantum, *argv)) {
aba5acdf SH	51	fprintf(stderr, "Illegal \"limit\"\n");
	52	return -1;
	53	}
	54	ok++;
	55	} else if (strcmp(*argv, "perturb") == 0) {
	56	NEXT_ARG();
6987ecf0	57	if (get_integer(&opt.v0.perturb_period, *argv, 0)) {
aba5acdf SH	58	fprintf(stderr, "Illegal \"perturb\"\n");
	59	return -1;
	60	}
	61	ok++;
	62	} else if (strcmp(*argv, "limit") == 0) {
	63	NEXT_ARG();
6987ecf0	64	if (get_u32(&opt.v0.limit, *argv, 0)) {
aba5acdf SH	65	fprintf(stderr, "Illegal \"limit\"\n");
	66	return -1;
	67	}
6987ecf0	68	if (opt.v0.limit < 2) {
aba5acdf SH	69	fprintf(stderr, "Illegal \"limit\", must be > 1\n");
	70	return -1;
	71	}
	72	ok++;
f3f28c21 ED	73	} else if (strcmp(*argv, "divisor") == 0) {
f3f28c21 ED	74	NEXT_ARG();
6987ecf0	75	if (get_u32(&opt.v0.divisor, *argv, 0)) {
f3f28c21 ED	76	fprintf(stderr, "Illegal \"divisor\"\n");
	77	return -1;
	78	}
	79	ok++;
6987ecf0 ED	80	} else if (strcmp(*argv, "flows") == 0) {
	81	NEXT_ARG();
	82	if (get_u32(&opt.v0.flows, *argv, 0)) {
	83	fprintf(stderr, "Illegal \"flows\"\n");
	84	return -1;
	85	}
	86	ok++;
	87	} else if (strcmp(*argv, "depth") == 0) {
	88	NEXT_ARG();
	89	if (get_u32(&opt.depth, *argv, 0)) {
	90	fprintf(stderr, "Illegal \"flows\"\n");
	91	return -1;
	92	}
	93	ok++;
	94	} else if (strcmp(*argv, "headdrop") == 0) {
	95	opt.headdrop = 1;
	96	ok++;
	97	} else if (strcmp(*argv, "redflowlimit") == 0) {
	98	NEXT_ARG();
	99	if (get_u32(&opt.limit, *argv, 0)) {
	100	fprintf(stderr, "Illegal \"redflowlimit\"\n");
	101	return -1;
	102	}
	103	red++;
	104	} else if (strcmp(*argv, "min") == 0) {
	105	NEXT_ARG();
	106	if (get_u32(&opt.qth_min, *argv, 0)) {
	107	fprintf(stderr, "Illegal \"min\"\n");
	108	return -1;
	109	}
	110	red++;
	111	} else if (strcmp(*argv, "max") == 0) {
	112	NEXT_ARG();
	113	if (get_u32(&opt.qth_max, *argv, 0)) {
	114	fprintf(stderr, "Illegal \"max\"\n");
	115	return -1;
	116	}
	117	red++;
	118	} else if (strcmp(*argv, "burst") == 0) {
	119	NEXT_ARG();
	120	if (get_unsigned(&burst, *argv, 0)) {
	121	fprintf(stderr, "Illegal \"burst\"\n");
	122	return -1;
	123	}
	124	red++;
	125	} else if (strcmp(*argv, "avpkt") == 0) {
	126	NEXT_ARG();
	127	if (get_size(&avpkt, *argv)) {
	128	fprintf(stderr, "Illegal \"avpkt\"\n");
	129	return -1;
	130	}
	131	red++;
	132	} else if (strcmp(*argv, "probability") == 0) {
	133	NEXT_ARG();
	134	if (sscanf(*argv, "%lg", &probability) != 1) {
	135	fprintf(stderr, "Illegal \"probability\"\n");
	136	return -1;
	137	}
	138	red++;
	139	} else if (strcmp(*argv, "ecn") == 0) {
	140	opt.flags \|= TC_RED_ECN;
	141	red++;
	142	} else if (strcmp(*argv, "harddrop") == 0) {
	143	opt.flags \|= TC_RED_HARDDROP;
144	red++;
aba5acdf SH	145	} else if (strcmp(*argv, "help") == 0) {
	146	explain();
	147	return -1;
	148	} else {
	149	fprintf(stderr, "What is \"%s\"?\n", *argv);
	150	explain();
	151	return -1;
	152	}
	153	argc--; argv++;
	154	}
6987ecf0 ED	155	if (red) {
	156	if (!opt.limit) {
	157	fprintf(stderr, "Required parameter (redflowlimit) is missing\n");
	158	return -1;
	159	}
3d0b7439	160	/* Compute default min/max thresholds based on
6987ecf0 ED	161	Sally Floyd's recommendations:
	162	http://www.icir.org/floyd/REDparameters.txt
	163	*/
3d0b7439	164	if (!opt.qth_max)
6987ecf0 ED	165	opt.qth_max = opt.limit / 4;
	166	if (!opt.qth_min)
	167	opt.qth_min = opt.qth_max / 3;
	168	if (!burst)
	169	burst = (2 * opt.qth_min + opt.qth_max) / (3 * avpkt);
	170
	171	if (opt.qth_max > opt.limit) {
	172	fprintf(stderr, "\"max\" is larger than \"limit\"\n");
	173	return -1;
	174	}
	175
	176	if (opt.qth_min >= opt.qth_max) {
	177	fprintf(stderr, "\"min\" is not smaller than \"max\"\n");
	178	return -1;
	179	}
	180
	181	wlog = tc_red_eval_ewma(opt.qth_min, burst, avpkt);
	182	if (wlog < 0) {
	183	fprintf(stderr, "SFQ: failed to calculate EWMA constant.\n");
	184	return -1;
	185	}
	186	if (wlog >= 10)
	187	fprintf(stderr, "SFQ: WARNING. Burst %u seems to be too large.\n", burst);
	188	opt.Wlog = wlog;
	189
	190	wlog = tc_red_eval_P(opt.qth_min, opt.qth_max, probability);
	191	if (wlog < 0) {
	192	fprintf(stderr, "SFQ: failed to calculate probability.\n");
	193	return -1;
	194	}
	195	opt.Plog = wlog;
	196	opt.max_P = probability * pow(2, 32);
	197	}
aba5acdf	198
6987ecf0	199	if (ok \|\| red)
aba5acdf SH	200	addattr_l(n, 1024, TCA_OPTIONS, &opt, sizeof(opt));
	201	return 0;
	202	}
	203
	204	static int sfq_print_opt(struct qdisc_util qu, FILE f, struct rtattr *opt)
	205	{
	206	struct tc_sfq_qopt *qopt;
6987ecf0	207	struct tc_sfq_qopt_v1 *qopt_ext = NULL;
32a121cb	208
aba5acdf	209	SPRINT_BUF(b1);
6987ecf0 ED	210	SPRINT_BUF(b2);
6987ecf0 ED	211	SPRINT_BUF(b3);
aba5acdf SH	212	if (opt == NULL)
	213	return 0;
	214
	215	if (RTA_PAYLOAD(opt) < sizeof(*qopt))
	216	return -1;
6987ecf0 ED	217	if (RTA_PAYLOAD(opt) >= sizeof(*qopt_ext))
6987ecf0 ED	218	qopt_ext = RTA_DATA(opt);
aba5acdf	219	qopt = RTA_DATA(opt);
85fdef05 LM	220
	221	print_uint(PRINT_ANY, "limit", "limit %up ", qopt->limit);
	222	print_uint(PRINT_JSON, "quantum", NULL, qopt->quantum);
	223	print_string(PRINT_FP, NULL, "quantum %s ",
	224	sprint_size(qopt->quantum, b1));
	225
6987ecf0	226	if (qopt_ext && qopt_ext->depth)
85fdef05	227	print_uint(PRINT_ANY, "depth", "depth %u ", qopt_ext->depth);
6987ecf0	228	if (qopt_ext && qopt_ext->headdrop)
85fdef05 LM	229	print_bool(PRINT_ANY, "headdrop", "headdrop ", true);
	230	if (show_details)
	231	print_uint(PRINT_ANY, "flows", "flows %u ", qopt->flows);
	232
	233	print_uint(PRINT_ANY, "divisor", "divisor %u ", qopt->divisor);
6987ecf0	234
aba5acdf	235	if (qopt->perturb_period)
85fdef05 LM	236	print_int(PRINT_ANY, "perturb", "perturb %dsec ",
85fdef05 LM	237	qopt->perturb_period);
6987ecf0	238	if (qopt_ext && qopt_ext->qth_min) {
85fdef05 LM	239	print_uint(PRINT_ANY, "ewma", "ewma %u ", qopt_ext->Wlog);
	240	print_uint(PRINT_JSON, "min", NULL, qopt_ext->qth_min);
	241	print_string(PRINT_FP, NULL, "min %s ",
	242	sprint_size(qopt_ext->qth_min, b2));
	243	print_uint(PRINT_JSON, "max", NULL, qopt_ext->qth_max);
	244	print_string(PRINT_FP, NULL, "max %s ",
	245	sprint_size(qopt_ext->qth_max, b3));
	246	print_float(PRINT_ANY, "probability", "probability %lg ",
	247	qopt_ext->max_P / pow(2, 32));
33021752	248	tc_red_print_flags(qopt_ext->flags);
6987ecf0	249	if (show_stats) {
85fdef05 LM	250	print_nl();
	251	print_uint(PRINT_ANY, "prob_mark", " prob_mark %u",
	252	qopt_ext->stats.prob_mark);
	253	print_uint(PRINT_ANY, "prob_mark_head",
	254	" prob_mark_head %u",
	255	qopt_ext->stats.prob_mark_head);
	256	print_uint(PRINT_ANY, "prob_drop", " prob_drop %u",
	257	qopt_ext->stats.prob_drop);
	258	print_nl();
	259	print_uint(PRINT_ANY, "forced_mark",
	260	" forced_mark %u",
	261	qopt_ext->stats.forced_mark);
	262	print_uint(PRINT_ANY, "forced_mark_head",
	263	" forced_mark_head %u",
	264	qopt_ext->stats.forced_mark_head);
	265	print_uint(PRINT_ANY, "forced_drop", " forced_drop %u",
	266	qopt_ext->stats.forced_drop);
6987ecf0 ED	267	}
6987ecf0 ED	268	}
aba5acdf SH	269	return 0;
	270	}
	271
5626a24a PM	272	static int sfq_print_xstats(struct qdisc_util qu, FILE f,
	273	struct rtattr *xstats)
	274	{
	275	struct tc_sfq_xstats *st;
	276
	277	if (xstats == NULL)
	278	return 0;
	279	if (RTA_PAYLOAD(xstats) < sizeof(*st))
	280	return -1;
	281	st = RTA_DATA(xstats);
	282
85fdef05 LM	283	print_int(PRINT_ANY, "allot", " allot %d", st->allot);
85fdef05 LM	284
5626a24a PM	285	return 0;
	286	}
	287
95812b56	288	struct qdisc_util sfq_qdisc_util = {
f2f99e2e SH	289	.id = "sfq",
	290	.parse_qopt = sfq_parse_opt,
	291	.print_qopt = sfq_print_opt,
5626a24a	292	.print_xstats = sfq_print_xstats,
aba5acdf	293	};