xref: /openbmc/linux/net/netfilter/xt_rateest.c (revision d2912cb1)
1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
250c164a8SPatrick McHardy /*
350c164a8SPatrick McHardy  * (C) 2007 Patrick McHardy <kaber@trash.net>
450c164a8SPatrick McHardy  */
550c164a8SPatrick McHardy #include <linux/module.h>
650c164a8SPatrick McHardy #include <linux/skbuff.h>
750c164a8SPatrick McHardy #include <linux/gen_stats.h>
850c164a8SPatrick McHardy 
950c164a8SPatrick McHardy #include <linux/netfilter/x_tables.h>
1050c164a8SPatrick McHardy #include <linux/netfilter/xt_rateest.h>
1150c164a8SPatrick McHardy #include <net/netfilter/xt_rateest.h>
1250c164a8SPatrick McHardy 
1350c164a8SPatrick McHardy 
14f7108a20SJan Engelhardt static bool
xt_rateest_mt(const struct sk_buff * skb,struct xt_action_param * par)1562fc8051SJan Engelhardt xt_rateest_mt(const struct sk_buff *skb, struct xt_action_param *par)
1650c164a8SPatrick McHardy {
17f7108a20SJan Engelhardt 	const struct xt_rateest_match_info *info = par->matchinfo;
181c0d32fdSEric Dumazet 	struct gnet_stats_rate_est64 sample = {0};
1950c164a8SPatrick McHardy 	u_int32_t bps1, bps2, pps1, pps2;
2050c164a8SPatrick McHardy 	bool ret = true;
2150c164a8SPatrick McHardy 
221c0d32fdSEric Dumazet 	gen_estimator_read(&info->est1->rate_est, &sample);
231c0d32fdSEric Dumazet 
2450c164a8SPatrick McHardy 	if (info->flags & XT_RATEEST_MATCH_DELTA) {
251c0d32fdSEric Dumazet 		bps1 = info->bps1 >= sample.bps ? info->bps1 - sample.bps : 0;
261c0d32fdSEric Dumazet 		pps1 = info->pps1 >= sample.pps ? info->pps1 - sample.pps : 0;
2750c164a8SPatrick McHardy 	} else {
281c0d32fdSEric Dumazet 		bps1 = sample.bps;
291c0d32fdSEric Dumazet 		pps1 = sample.pps;
3050c164a8SPatrick McHardy 	}
3150c164a8SPatrick McHardy 
3250c164a8SPatrick McHardy 	if (info->flags & XT_RATEEST_MATCH_ABS) {
3350c164a8SPatrick McHardy 		bps2 = info->bps2;
3450c164a8SPatrick McHardy 		pps2 = info->pps2;
3550c164a8SPatrick McHardy 	} else {
361c0d32fdSEric Dumazet 		gen_estimator_read(&info->est2->rate_est, &sample);
371c0d32fdSEric Dumazet 
3850c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_DELTA) {
391c0d32fdSEric Dumazet 			bps2 = info->bps2 >= sample.bps ? info->bps2 - sample.bps : 0;
401c0d32fdSEric Dumazet 			pps2 = info->pps2 >= sample.pps ? info->pps2 - sample.pps : 0;
4150c164a8SPatrick McHardy 		} else {
421c0d32fdSEric Dumazet 			bps2 = sample.bps;
431c0d32fdSEric Dumazet 			pps2 = sample.pps;
4450c164a8SPatrick McHardy 		}
4550c164a8SPatrick McHardy 	}
4650c164a8SPatrick McHardy 
4750c164a8SPatrick McHardy 	switch (info->mode) {
4850c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_LT:
4950c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_BPS)
5050c164a8SPatrick McHardy 			ret &= bps1 < bps2;
5150c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_PPS)
5250c164a8SPatrick McHardy 			ret &= pps1 < pps2;
5350c164a8SPatrick McHardy 		break;
5450c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_GT:
5550c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_BPS)
5650c164a8SPatrick McHardy 			ret &= bps1 > bps2;
5750c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_PPS)
5850c164a8SPatrick McHardy 			ret &= pps1 > pps2;
5950c164a8SPatrick McHardy 		break;
6050c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_EQ:
6150c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_BPS)
6250c164a8SPatrick McHardy 			ret &= bps1 == bps2;
6350c164a8SPatrick McHardy 		if (info->flags & XT_RATEEST_MATCH_PPS)
644d900f9dSPatrick McHardy 			ret &= pps1 == pps2;
6550c164a8SPatrick McHardy 		break;
6650c164a8SPatrick McHardy 	}
6750c164a8SPatrick McHardy 
6850c164a8SPatrick McHardy 	ret ^= info->flags & XT_RATEEST_MATCH_INVERT ? true : false;
6950c164a8SPatrick McHardy 	return ret;
7050c164a8SPatrick McHardy }
7150c164a8SPatrick McHardy 
xt_rateest_mt_checkentry(const struct xt_mtchk_param * par)72b0f38452SJan Engelhardt static int xt_rateest_mt_checkentry(const struct xt_mtchk_param *par)
7350c164a8SPatrick McHardy {
749b4fce7aSJan Engelhardt 	struct xt_rateest_match_info *info = par->matchinfo;
7550c164a8SPatrick McHardy 	struct xt_rateest *est1, *est2;
7600fe1ae9SEric Dumazet 	int ret = -EINVAL;
7750c164a8SPatrick McHardy 
7850c164a8SPatrick McHardy 	if (hweight32(info->flags & (XT_RATEEST_MATCH_ABS |
7950c164a8SPatrick McHardy 				     XT_RATEEST_MATCH_REL)) != 1)
8050c164a8SPatrick McHardy 		goto err1;
8150c164a8SPatrick McHardy 
8250c164a8SPatrick McHardy 	if (!(info->flags & (XT_RATEEST_MATCH_BPS | XT_RATEEST_MATCH_PPS)))
8350c164a8SPatrick McHardy 		goto err1;
8450c164a8SPatrick McHardy 
8550c164a8SPatrick McHardy 	switch (info->mode) {
8650c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_EQ:
8750c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_LT:
8850c164a8SPatrick McHardy 	case XT_RATEEST_MATCH_GT:
8950c164a8SPatrick McHardy 		break;
9050c164a8SPatrick McHardy 	default:
9150c164a8SPatrick McHardy 		goto err1;
9250c164a8SPatrick McHardy 	}
9350c164a8SPatrick McHardy 
944a5a5c73SJan Engelhardt 	ret  = -ENOENT;
953427b2abSCong Wang 	est1 = xt_rateest_lookup(par->net, info->name1);
9650c164a8SPatrick McHardy 	if (!est1)
9750c164a8SPatrick McHardy 		goto err1;
9850c164a8SPatrick McHardy 
9900fe1ae9SEric Dumazet 	est2 = NULL;
10050c164a8SPatrick McHardy 	if (info->flags & XT_RATEEST_MATCH_REL) {
1013427b2abSCong Wang 		est2 = xt_rateest_lookup(par->net, info->name2);
10250c164a8SPatrick McHardy 		if (!est2)
10350c164a8SPatrick McHardy 			goto err2;
10400fe1ae9SEric Dumazet 	}
10550c164a8SPatrick McHardy 
10650c164a8SPatrick McHardy 	info->est1 = est1;
10750c164a8SPatrick McHardy 	info->est2 = est2;
108bd414ee6SJan Engelhardt 	return 0;
10950c164a8SPatrick McHardy 
11050c164a8SPatrick McHardy err2:
1113427b2abSCong Wang 	xt_rateest_put(par->net, est1);
11250c164a8SPatrick McHardy err1:
11300fe1ae9SEric Dumazet 	return ret;
11450c164a8SPatrick McHardy }
11550c164a8SPatrick McHardy 
xt_rateest_mt_destroy(const struct xt_mtdtor_param * par)1166be3d859SJan Engelhardt static void xt_rateest_mt_destroy(const struct xt_mtdtor_param *par)
11750c164a8SPatrick McHardy {
1186be3d859SJan Engelhardt 	struct xt_rateest_match_info *info = par->matchinfo;
11950c164a8SPatrick McHardy 
1203427b2abSCong Wang 	xt_rateest_put(par->net, info->est1);
12150c164a8SPatrick McHardy 	if (info->est2)
1223427b2abSCong Wang 		xt_rateest_put(par->net, info->est2);
12350c164a8SPatrick McHardy }
12450c164a8SPatrick McHardy 
12555b69e91SJan Engelhardt static struct xt_match xt_rateest_mt_reg __read_mostly = {
12650c164a8SPatrick McHardy 	.name       = "rateest",
12755b69e91SJan Engelhardt 	.revision   = 0,
12855b69e91SJan Engelhardt 	.family     = NFPROTO_UNSPEC,
12950c164a8SPatrick McHardy 	.match      = xt_rateest_mt,
13050c164a8SPatrick McHardy 	.checkentry = xt_rateest_mt_checkentry,
13150c164a8SPatrick McHardy 	.destroy    = xt_rateest_mt_destroy,
13250c164a8SPatrick McHardy 	.matchsize  = sizeof(struct xt_rateest_match_info),
133ec231890SWillem de Bruijn 	.usersize   = offsetof(struct xt_rateest_match_info, est1),
13450c164a8SPatrick McHardy 	.me         = THIS_MODULE,
13550c164a8SPatrick McHardy };
13650c164a8SPatrick McHardy 
xt_rateest_mt_init(void)13750c164a8SPatrick McHardy static int __init xt_rateest_mt_init(void)
13850c164a8SPatrick McHardy {
13955b69e91SJan Engelhardt 	return xt_register_match(&xt_rateest_mt_reg);
14050c164a8SPatrick McHardy }
14150c164a8SPatrick McHardy 
xt_rateest_mt_fini(void)14250c164a8SPatrick McHardy static void __exit xt_rateest_mt_fini(void)
14350c164a8SPatrick McHardy {
14455b69e91SJan Engelhardt 	xt_unregister_match(&xt_rateest_mt_reg);
14550c164a8SPatrick McHardy }
14650c164a8SPatrick McHardy 
14750c164a8SPatrick McHardy MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
14850c164a8SPatrick McHardy MODULE_LICENSE("GPL");
14950c164a8SPatrick McHardy MODULE_DESCRIPTION("xtables rate estimator match");
15050c164a8SPatrick McHardy MODULE_ALIAS("ipt_rateest");
15150c164a8SPatrick McHardy MODULE_ALIAS("ip6t_rateest");
15250c164a8SPatrick McHardy module_init(xt_rateest_mt_init);
15350c164a8SPatrick McHardy module_exit(xt_rateest_mt_fini);
154