[linux-block.git] / net / netfilter / xt_rateest.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * (C) 2007 Patrick McHardy <kaber@trash.net>
 */
#include <linux/module.h>
#include <linux/skbuff.h>
#include <linux/gen_stats.h>

#include <linux/netfilter/x_tables.h>
#include <linux/netfilter/xt_rateest.h>
#include <net/netfilter/xt_rateest.h>


static bool
xt_rateest_mt(const struct sk_buff *skb, struct xt_action_param *par)
{
	const struct xt_rateest_match_info *info = par->matchinfo;
	struct gnet_stats_rate_est64 sample = {0};
	u_int32_t bps1, bps2, pps1, pps2;
	bool ret = true;

	gen_estimator_read(&info->est1->rate_est, &sample);

	if (info->flags & XT_RATEEST_MATCH_DELTA) {
		bps1 = info->bps1 >= sample.bps ? info->bps1 - sample.bps : 0;
		pps1 = info->pps1 >= sample.pps ? info->pps1 - sample.pps : 0;
	} else {
		bps1 = sample.bps;
		pps1 = sample.pps;
	}

	if (info->flags & XT_RATEEST_MATCH_ABS) {
		bps2 = info->bps2;
		pps2 = info->pps2;
	} else {
		gen_estimator_read(&info->est2->rate_est, &sample);

		if (info->flags & XT_RATEEST_MATCH_DELTA) {
			bps2 = info->bps2 >= sample.bps ? info->bps2 - sample.bps : 0;
			pps2 = info->pps2 >= sample.pps ? info->pps2 - sample.pps : 0;
		} else {
			bps2 = sample.bps;
			pps2 = sample.pps;
		}
	}

	switch (info->mode) {
	case XT_RATEEST_MATCH_LT:
		if (info->flags & XT_RATEEST_MATCH_BPS)
			ret &= bps1 < bps2;
		if (info->flags & XT_RATEEST_MATCH_PPS)
			ret &= pps1 < pps2;
		break;
	case XT_RATEEST_MATCH_GT:
		if (info->flags & XT_RATEEST_MATCH_BPS)
			ret &= bps1 > bps2;
		if (info->flags & XT_RATEEST_MATCH_PPS)
			ret &= pps1 > pps2;
		break;
	case XT_RATEEST_MATCH_EQ:
		if (info->flags & XT_RATEEST_MATCH_BPS)
			ret &= bps1 == bps2;
		if (info->flags & XT_RATEEST_MATCH_PPS)
			ret &= pps1 == pps2;
		break;
	}

	ret ^= info->flags & XT_RATEEST_MATCH_INVERT ? true : false;
	return ret;
}

static int xt_rateest_mt_checkentry(const struct xt_mtchk_param *par)
{
	struct xt_rateest_match_info *info = par->matchinfo;
	struct xt_rateest *est1, *est2;
	int ret = -EINVAL;

	if (hweight32(info->flags & (XT_RATEEST_MATCH_ABS |
				     XT_RATEEST_MATCH_REL)) != 1)
		goto err1;

	if (!(info->flags & (XT_RATEEST_MATCH_BPS | XT_RATEEST_MATCH_PPS)))
		goto err1;

	switch (info->mode) {
	case XT_RATEEST_MATCH_EQ:
	case XT_RATEEST_MATCH_LT:
	case XT_RATEEST_MATCH_GT:
		break;
	default:
		goto err1;
	}

	ret  = -ENOENT;
	est1 = xt_rateest_lookup(par->net, info->name1);
	if (!est1)
		goto err1;

	est2 = NULL;
	if (info->flags & XT_RATEEST_MATCH_REL) {
		est2 = xt_rateest_lookup(par->net, info->name2);
		if (!est2)
			goto err2;
	}

	info->est1 = est1;
	info->est2 = est2;
	return 0;

err2:
	xt_rateest_put(par->net, est1);
err1:
	return ret;
}

static void xt_rateest_mt_destroy(const struct xt_mtdtor_param *par)
{
	struct xt_rateest_match_info *info = par->matchinfo;

	xt_rateest_put(par->net, info->est1);
	if (info->est2)
		xt_rateest_put(par->net, info->est2);
}

static struct xt_match xt_rateest_mt_reg __read_mostly = {
	.name       = "rateest",
	.revision   = 0,
	.family     = NFPROTO_UNSPEC,
	.match      = xt_rateest_mt,
	.checkentry = xt_rateest_mt_checkentry,
	.destroy    = xt_rateest_mt_destroy,
	.matchsize  = sizeof(struct xt_rateest_match_info),
	.usersize   = offsetof(struct xt_rateest_match_info, est1),
	.me         = THIS_MODULE,
};

static int __init xt_rateest_mt_init(void)
{
	return xt_register_match(&xt_rateest_mt_reg);
}

static void __exit xt_rateest_mt_fini(void)
{
	xt_unregister_match(&xt_rateest_mt_reg);
}

MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("xtables rate estimator match");
MODULE_ALIAS("ipt_rateest");
MODULE_ALIAS("ip6t_rateest");
module_init(xt_rateest_mt_init);
module_exit(xt_rateest_mt_fini);
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
50c164a8 PM	2	/*
50c164a8 PM	3	* (C) 2007 Patrick McHardy <kaber@trash.net>
50c164a8 PM	4	*/
	5	#include <linux/module.h>
	6	#include <linux/skbuff.h>
	7	#include <linux/gen_stats.h>
	8
	9	#include <linux/netfilter/x_tables.h>
	10	#include <linux/netfilter/xt_rateest.h>
	11	#include <net/netfilter/xt_rateest.h>
	12
	13
f7108a20	14	static bool
62fc8051	15	xt_rateest_mt(const struct sk_buff skb, struct xt_action_param par)
50c164a8	16	{
f7108a20	17	const struct xt_rateest_match_info *info = par->matchinfo;
1c0d32fd	18	struct gnet_stats_rate_est64 sample = {0};
50c164a8 PM	19	u_int32_t bps1, bps2, pps1, pps2;
	20	bool ret = true;
	21
1c0d32fd ED	22	gen_estimator_read(&info->est1->rate_est, &sample);
1c0d32fd ED	23
50c164a8	24	if (info->flags & XT_RATEEST_MATCH_DELTA) {
1c0d32fd ED	25	bps1 = info->bps1 >= sample.bps ? info->bps1 - sample.bps : 0;
1c0d32fd ED	26	pps1 = info->pps1 >= sample.pps ? info->pps1 - sample.pps : 0;
50c164a8	27	} else {
1c0d32fd ED	28	bps1 = sample.bps;
1c0d32fd ED	29	pps1 = sample.pps;
50c164a8	30	}
50c164a8 PM	31
	32	if (info->flags & XT_RATEEST_MATCH_ABS) {
	33	bps2 = info->bps2;
	34	pps2 = info->pps2;
	35	} else {
1c0d32fd ED	36	gen_estimator_read(&info->est2->rate_est, &sample);
1c0d32fd ED	37
50c164a8	38	if (info->flags & XT_RATEEST_MATCH_DELTA) {
1c0d32fd ED	39	bps2 = info->bps2 >= sample.bps ? info->bps2 - sample.bps : 0;
1c0d32fd ED	40	pps2 = info->pps2 >= sample.pps ? info->pps2 - sample.pps : 0;
50c164a8	41	} else {
1c0d32fd ED	42	bps2 = sample.bps;
1c0d32fd ED	43	pps2 = sample.pps;
50c164a8	44	}
50c164a8 PM	45	}
	46
	47	switch (info->mode) {
	48	case XT_RATEEST_MATCH_LT:
	49	if (info->flags & XT_RATEEST_MATCH_BPS)
	50	ret &= bps1 < bps2;
	51	if (info->flags & XT_RATEEST_MATCH_PPS)
	52	ret &= pps1 < pps2;
	53	break;
	54	case XT_RATEEST_MATCH_GT:
	55	if (info->flags & XT_RATEEST_MATCH_BPS)
	56	ret &= bps1 > bps2;
	57	if (info->flags & XT_RATEEST_MATCH_PPS)
	58	ret &= pps1 > pps2;
	59	break;
	60	case XT_RATEEST_MATCH_EQ:
	61	if (info->flags & XT_RATEEST_MATCH_BPS)
	62	ret &= bps1 == bps2;
	63	if (info->flags & XT_RATEEST_MATCH_PPS)
4d900f9d	64	ret &= pps1 == pps2;
50c164a8 PM	65	break;
	66	}
	67
	68	ret ^= info->flags & XT_RATEEST_MATCH_INVERT ? true : false;
	69	return ret;
	70	}
	71
b0f38452	72	static int xt_rateest_mt_checkentry(const struct xt_mtchk_param *par)
50c164a8	73	{
9b4fce7a	74	struct xt_rateest_match_info *info = par->matchinfo;
50c164a8	75	struct xt_rateest est1, est2;
00fe1ae9	76	int ret = -EINVAL;
50c164a8 PM	77
	78	if (hweight32(info->flags & (XT_RATEEST_MATCH_ABS \|
	79	XT_RATEEST_MATCH_REL)) != 1)
	80	goto err1;
	81
	82	if (!(info->flags & (XT_RATEEST_MATCH_BPS \| XT_RATEEST_MATCH_PPS)))
	83	goto err1;
	84
	85	switch (info->mode) {
	86	case XT_RATEEST_MATCH_EQ:
	87	case XT_RATEEST_MATCH_LT:
	88	case XT_RATEEST_MATCH_GT:
	89	break;
	90	default:
	91	goto err1;
	92	}
	93
4a5a5c73	94	ret = -ENOENT;
3427b2ab	95	est1 = xt_rateest_lookup(par->net, info->name1);
50c164a8 PM	96	if (!est1)
	97	goto err1;
	98
00fe1ae9	99	est2 = NULL;
50c164a8	100	if (info->flags & XT_RATEEST_MATCH_REL) {
3427b2ab	101	est2 = xt_rateest_lookup(par->net, info->name2);
50c164a8 PM	102	if (!est2)
50c164a8 PM	103	goto err2;
00fe1ae9	104	}
50c164a8 PM	105
	106	info->est1 = est1;
	107	info->est2 = est2;
bd414ee6	108	return 0;
50c164a8 PM	109
50c164a8 PM	110	err2:
3427b2ab	111	xt_rateest_put(par->net, est1);
50c164a8	112	err1:
00fe1ae9	113	return ret;
50c164a8 PM	114	}
50c164a8 PM	115
6be3d859	116	static void xt_rateest_mt_destroy(const struct xt_mtdtor_param *par)
50c164a8	117	{
6be3d859	118	struct xt_rateest_match_info *info = par->matchinfo;
50c164a8	119
3427b2ab	120	xt_rateest_put(par->net, info->est1);
50c164a8	121	if (info->est2)
3427b2ab	122	xt_rateest_put(par->net, info->est2);
50c164a8 PM	123	}
50c164a8 PM	124
55b69e91 JE	125	static struct xt_match xt_rateest_mt_reg __read_mostly = {
	126	.name = "rateest",
	127	.revision = 0,
	128	.family = NFPROTO_UNSPEC,
	129	.match = xt_rateest_mt,
	130	.checkentry = xt_rateest_mt_checkentry,
	131	.destroy = xt_rateest_mt_destroy,
	132	.matchsize = sizeof(struct xt_rateest_match_info),
ec231890	133	.usersize = offsetof(struct xt_rateest_match_info, est1),
55b69e91	134	.me = THIS_MODULE,
50c164a8 PM	135	};
	136
	137	static int __init xt_rateest_mt_init(void)
	138	{
55b69e91	139	return xt_register_match(&xt_rateest_mt_reg);
50c164a8 PM	140	}
	141
	142	static void __exit xt_rateest_mt_fini(void)
	143	{
55b69e91	144	xt_unregister_match(&xt_rateest_mt_reg);
50c164a8 PM	145	}
	146
	147	MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
	148	MODULE_LICENSE("GPL");
	149	MODULE_DESCRIPTION("xtables rate estimator match");
	150	MODULE_ALIAS("ipt_rateest");
	151	MODULE_ALIAS("ip6t_rateest");
	152	module_init(xt_rateest_mt_init);
	153	module_exit(xt_rateest_mt_fini);