[linux-2.6-block.git] / net / sched / act_police.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * net/sched/act_police.c	Input police filter
 *
 * Authors:	Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
 * 		J Hadi Salim (action changes)
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/skbuff.h>
#include <linux/rtnetlink.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <net/act_api.h>
#include <net/gso.h>
#include <net/netlink.h>
#include <net/pkt_cls.h>
#include <net/tc_act/tc_police.h>
#include <net/tc_wrapper.h>

/* Each policer is serialized by its individual spinlock */

static struct tc_action_ops act_police_ops;

static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
	[TCA_POLICE_RATE]	= { .len = TC_RTAB_SIZE },
	[TCA_POLICE_PEAKRATE]	= { .len = TC_RTAB_SIZE },
	[TCA_POLICE_AVRATE]	= { .type = NLA_U32 },
	[TCA_POLICE_RESULT]	= { .type = NLA_U32 },
	[TCA_POLICE_RATE64]     = { .type = NLA_U64 },
	[TCA_POLICE_PEAKRATE64] = { .type = NLA_U64 },
	[TCA_POLICE_PKTRATE64]  = { .type = NLA_U64, .min = 1 },
	[TCA_POLICE_PKTBURST64] = { .type = NLA_U64, .min = 1 },
};

static int tcf_police_init(struct net *net, struct nlattr *nla,
			       struct nlattr *est, struct tc_action **a,
			       struct tcf_proto *tp, u32 flags,
			       struct netlink_ext_ack *extack)
{
	int ret = 0, tcfp_result = TC_ACT_OK, err, size;
	bool bind = flags & TCA_ACT_FLAGS_BIND;
	struct nlattr *tb[TCA_POLICE_MAX + 1];
	struct tcf_chain *goto_ch = NULL;
	struct tc_police *parm;
	struct tcf_police *police;
	struct qdisc_rate_table *R_tab = NULL, *P_tab = NULL;
	struct tc_action_net *tn = net_generic(net, act_police_ops.net_id);
	struct tcf_police_params *new;
	bool exists = false;
	u32 index;
	u64 rate64, prate64;
	u64 pps, ppsburst;

	if (nla == NULL)
		return -EINVAL;

	err = nla_parse_nested_deprecated(tb, TCA_POLICE_MAX, nla,
					  police_policy, NULL);
	if (err < 0)
		return err;

	if (tb[TCA_POLICE_TBF] == NULL)
		return -EINVAL;
	size = nla_len(tb[TCA_POLICE_TBF]);
	if (size != sizeof(*parm) && size != sizeof(struct tc_police_compat))
		return -EINVAL;

	parm = nla_data(tb[TCA_POLICE_TBF]);
	index = parm->index;
	err = tcf_idr_check_alloc(tn, &index, a, bind);
	if (err < 0)
		return err;
	exists = err;
	if (exists && bind)
		return 0;

	if (!exists) {
		ret = tcf_idr_create(tn, index, NULL, a,
				     &act_police_ops, bind, true, flags);
		if (ret) {
			tcf_idr_cleanup(tn, index);
			return ret;
		}
		ret = ACT_P_CREATED;
		spin_lock_init(&(to_police(*a)->tcfp_lock));
	} else if (!(flags & TCA_ACT_FLAGS_REPLACE)) {
		tcf_idr_release(*a, bind);
		return -EEXIST;
	}
	err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
	if (err < 0)
		goto release_idr;

	police = to_police(*a);
	if (parm->rate.rate) {
		err = -ENOMEM;
		R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE], NULL);
		if (R_tab == NULL)
			goto failure;

		if (parm->peakrate.rate) {
			P_tab = qdisc_get_rtab(&parm->peakrate,
					       tb[TCA_POLICE_PEAKRATE], NULL);
			if (P_tab == NULL)
				goto failure;
		}
	}

	if (est) {
		err = gen_replace_estimator(&police->tcf_bstats,
					    police->common.cpu_bstats,
					    &police->tcf_rate_est,
					    &police->tcf_lock,
					    false, est);
		if (err)
			goto failure;
	} else if (tb[TCA_POLICE_AVRATE] &&
		   (ret == ACT_P_CREATED ||
		    !gen_estimator_active(&police->tcf_rate_est))) {
		err = -EINVAL;
		goto failure;
	}

	if (tb[TCA_POLICE_RESULT]) {
		tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
		if (TC_ACT_EXT_CMP(tcfp_result, TC_ACT_GOTO_CHAIN)) {
			NL_SET_ERR_MSG(extack,
				       "goto chain not allowed on fallback");
			err = -EINVAL;
			goto failure;
		}
	}

	if ((tb[TCA_POLICE_PKTRATE64] && !tb[TCA_POLICE_PKTBURST64]) ||
	    (!tb[TCA_POLICE_PKTRATE64] && tb[TCA_POLICE_PKTBURST64])) {
		NL_SET_ERR_MSG(extack,
			       "Both or neither packet-per-second burst and rate must be provided");
		err = -EINVAL;
		goto failure;
	}

	if (tb[TCA_POLICE_PKTRATE64] && R_tab) {
		NL_SET_ERR_MSG(extack,
			       "packet-per-second and byte-per-second rate limits not allowed in same action");
		err = -EINVAL;
		goto failure;
	}

	new = kzalloc(sizeof(*new), GFP_KERNEL);
	if (unlikely(!new)) {
		err = -ENOMEM;
		goto failure;
	}

	/* No failure allowed after this point */
	new->tcfp_result = tcfp_result;
	new->tcfp_mtu = parm->mtu;
	if (!new->tcfp_mtu) {
		new->tcfp_mtu = ~0;
		if (R_tab)
			new->tcfp_mtu = 255 << R_tab->rate.cell_log;
	}
	if (R_tab) {
		new->rate_present = true;
		rate64 = tb[TCA_POLICE_RATE64] ?
			 nla_get_u64(tb[TCA_POLICE_RATE64]) : 0;
		psched_ratecfg_precompute(&new->rate, &R_tab->rate, rate64);
		qdisc_put_rtab(R_tab);
	} else {
		new->rate_present = false;
	}
	if (P_tab) {
		new->peak_present = true;
		prate64 = tb[TCA_POLICE_PEAKRATE64] ?
			  nla_get_u64(tb[TCA_POLICE_PEAKRATE64]) : 0;
		psched_ratecfg_precompute(&new->peak, &P_tab->rate, prate64);
		qdisc_put_rtab(P_tab);
	} else {
		new->peak_present = false;
	}

	new->tcfp_burst = PSCHED_TICKS2NS(parm->burst);
	if (new->peak_present)
		new->tcfp_mtu_ptoks = (s64)psched_l2t_ns(&new->peak,
							 new->tcfp_mtu);

	if (tb[TCA_POLICE_AVRATE])
		new->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);

	if (tb[TCA_POLICE_PKTRATE64]) {
		pps = nla_get_u64(tb[TCA_POLICE_PKTRATE64]);
		ppsburst = nla_get_u64(tb[TCA_POLICE_PKTBURST64]);
		new->pps_present = true;
		new->tcfp_pkt_burst = PSCHED_TICKS2NS(ppsburst);
		psched_ppscfg_precompute(&new->ppsrate, pps);
	}

	spin_lock_bh(&police->tcf_lock);
	spin_lock_bh(&police->tcfp_lock);
	police->tcfp_t_c = ktime_get_ns();
	police->tcfp_toks = new->tcfp_burst;
	if (new->peak_present)
		police->tcfp_ptoks = new->tcfp_mtu_ptoks;
	spin_unlock_bh(&police->tcfp_lock);
	goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
	new = rcu_replace_pointer(police->params,
				  new,
				  lockdep_is_held(&police->tcf_lock));
	spin_unlock_bh(&police->tcf_lock);

	if (goto_ch)
		tcf_chain_put_by_act(goto_ch);
	if (new)
		kfree_rcu(new, rcu);

	return ret;

failure:
	qdisc_put_rtab(P_tab);
	qdisc_put_rtab(R_tab);
	if (goto_ch)
		tcf_chain_put_by_act(goto_ch);
release_idr:
	tcf_idr_release(*a, bind);
	return err;
}

static bool tcf_police_mtu_check(struct sk_buff *skb, u32 limit)
{
	u32 len;

	if (skb_is_gso(skb))
		return skb_gso_validate_mac_len(skb, limit);

	len = qdisc_pkt_len(skb);
	if (skb_at_tc_ingress(skb))
		len += skb->mac_len;

	return len <= limit;
}

TC_INDIRECT_SCOPE int tcf_police_act(struct sk_buff *skb,
				     const struct tc_action *a,
				     struct tcf_result *res)
{
	struct tcf_police *police = to_police(a);
	s64 now, toks, ppstoks = 0, ptoks = 0;
	struct tcf_police_params *p;
	int ret;

	tcf_lastuse_update(&police->tcf_tm);
	bstats_update(this_cpu_ptr(police->common.cpu_bstats), skb);

	ret = READ_ONCE(police->tcf_action);
	p = rcu_dereference_bh(police->params);

	if (p->tcfp_ewma_rate) {
		struct gnet_stats_rate_est64 sample;

		if (!gen_estimator_read(&police->tcf_rate_est, &sample) ||
		    sample.bps >= p->tcfp_ewma_rate)
			goto inc_overlimits;
	}

	if (tcf_police_mtu_check(skb, p->tcfp_mtu)) {
		if (!p->rate_present && !p->pps_present) {
			ret = p->tcfp_result;
			goto end;
		}

		now = ktime_get_ns();
		spin_lock_bh(&police->tcfp_lock);
		toks = min_t(s64, now - police->tcfp_t_c, p->tcfp_burst);
		if (p->peak_present) {
			ptoks = toks + police->tcfp_ptoks;
			if (ptoks > p->tcfp_mtu_ptoks)
				ptoks = p->tcfp_mtu_ptoks;
			ptoks -= (s64)psched_l2t_ns(&p->peak,
						    qdisc_pkt_len(skb));
		}
		if (p->rate_present) {
			toks += police->tcfp_toks;
			if (toks > p->tcfp_burst)
				toks = p->tcfp_burst;
			toks -= (s64)psched_l2t_ns(&p->rate, qdisc_pkt_len(skb));
		} else if (p->pps_present) {
			ppstoks = min_t(s64, now - police->tcfp_t_c, p->tcfp_pkt_burst);
			ppstoks += police->tcfp_pkttoks;
			if (ppstoks > p->tcfp_pkt_burst)
				ppstoks = p->tcfp_pkt_burst;
			ppstoks -= (s64)psched_pkt2t_ns(&p->ppsrate, 1);
		}
		if ((toks | ptoks | ppstoks) >= 0) {
			police->tcfp_t_c = now;
			police->tcfp_toks = toks;
			police->tcfp_ptoks = ptoks;
			police->tcfp_pkttoks = ppstoks;
			spin_unlock_bh(&police->tcfp_lock);
			ret = p->tcfp_result;
			goto inc_drops;
		}
		spin_unlock_bh(&police->tcfp_lock);
	}

inc_overlimits:
	qstats_overlimit_inc(this_cpu_ptr(police->common.cpu_qstats));
inc_drops:
	if (ret == TC_ACT_SHOT)
		qstats_drop_inc(this_cpu_ptr(police->common.cpu_qstats));
end:
	return ret;
}

static void tcf_police_cleanup(struct tc_action *a)
{
	struct tcf_police *police = to_police(a);
	struct tcf_police_params *p;

	p = rcu_dereference_protected(police->params, 1);
	if (p)
		kfree_rcu(p, rcu);
}

static void tcf_police_stats_update(struct tc_action *a,
				    u64 bytes, u64 packets, u64 drops,
				    u64 lastuse, bool hw)
{
	struct tcf_police *police = to_police(a);
	struct tcf_t *tm = &police->tcf_tm;

	tcf_action_update_stats(a, bytes, packets, drops, hw);
	tm->lastuse = max_t(u64, tm->lastuse, lastuse);
}

static int tcf_police_dump(struct sk_buff *skb, struct tc_action *a,
			       int bind, int ref)
{
	unsigned char *b = skb_tail_pointer(skb);
	struct tcf_police *police = to_police(a);
	struct tcf_police_params *p;
	struct tc_police opt = {
		.index = police->tcf_index,
		.refcnt = refcount_read(&police->tcf_refcnt) - ref,
		.bindcnt = atomic_read(&police->tcf_bindcnt) - bind,
	};
	struct tcf_t t;

	spin_lock_bh(&police->tcf_lock);
	opt.action = police->tcf_action;
	p = rcu_dereference_protected(police->params,
				      lockdep_is_held(&police->tcf_lock));
	opt.mtu = p->tcfp_mtu;
	opt.burst = PSCHED_NS2TICKS(p->tcfp_burst);
	if (p->rate_present) {
		psched_ratecfg_getrate(&opt.rate, &p->rate);
		if ((p->rate.rate_bytes_ps >= (1ULL << 32)) &&
		    nla_put_u64_64bit(skb, TCA_POLICE_RATE64,
				      p->rate.rate_bytes_ps,
				      TCA_POLICE_PAD))
			goto nla_put_failure;
	}
	if (p->peak_present) {
		psched_ratecfg_getrate(&opt.peakrate, &p->peak);
		if ((p->peak.rate_bytes_ps >= (1ULL << 32)) &&
		    nla_put_u64_64bit(skb, TCA_POLICE_PEAKRATE64,
				      p->peak.rate_bytes_ps,
				      TCA_POLICE_PAD))
			goto nla_put_failure;
	}
	if (p->pps_present) {
		if (nla_put_u64_64bit(skb, TCA_POLICE_PKTRATE64,
				      p->ppsrate.rate_pkts_ps,
				      TCA_POLICE_PAD))
			goto nla_put_failure;
		if (nla_put_u64_64bit(skb, TCA_POLICE_PKTBURST64,
				      PSCHED_NS2TICKS(p->tcfp_pkt_burst),
				      TCA_POLICE_PAD))
			goto nla_put_failure;
	}
	if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
		goto nla_put_failure;
	if (p->tcfp_result &&
	    nla_put_u32(skb, TCA_POLICE_RESULT, p->tcfp_result))
		goto nla_put_failure;
	if (p->tcfp_ewma_rate &&
	    nla_put_u32(skb, TCA_POLICE_AVRATE, p->tcfp_ewma_rate))
		goto nla_put_failure;

	tcf_tm_dump(&t, &police->tcf_tm);
	if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD))
		goto nla_put_failure;
	spin_unlock_bh(&police->tcf_lock);

	return skb->len;

nla_put_failure:
	spin_unlock_bh(&police->tcf_lock);
	nlmsg_trim(skb, b);
	return -1;
}

static int tcf_police_act_to_flow_act(int tc_act, u32 *extval,
				      struct netlink_ext_ack *extack)
{
	int act_id = -EOPNOTSUPP;

	if (!TC_ACT_EXT_OPCODE(tc_act)) {
		if (tc_act == TC_ACT_OK)
			act_id = FLOW_ACTION_ACCEPT;
		else if (tc_act ==  TC_ACT_SHOT)
			act_id = FLOW_ACTION_DROP;
		else if (tc_act == TC_ACT_PIPE)
			act_id = FLOW_ACTION_PIPE;
		else if (tc_act == TC_ACT_RECLASSIFY)
			NL_SET_ERR_MSG_MOD(extack, "Offload not supported when conform/exceed action is \"reclassify\"");
		else
			NL_SET_ERR_MSG_MOD(extack, "Unsupported conform/exceed action offload");
	} else if (TC_ACT_EXT_CMP(tc_act, TC_ACT_GOTO_CHAIN)) {
		act_id = FLOW_ACTION_GOTO;
		*extval = tc_act & TC_ACT_EXT_VAL_MASK;
	} else if (TC_ACT_EXT_CMP(tc_act, TC_ACT_JUMP)) {
		act_id = FLOW_ACTION_JUMP;
		*extval = tc_act & TC_ACT_EXT_VAL_MASK;
	} else if (tc_act == TC_ACT_UNSPEC) {
		act_id = FLOW_ACTION_CONTINUE;
	} else {
		NL_SET_ERR_MSG_MOD(extack, "Unsupported conform/exceed action offload");
	}

	return act_id;
}

static int tcf_police_offload_act_setup(struct tc_action *act, void *entry_data,
					u32 *index_inc, bool bind,
					struct netlink_ext_ack *extack)
{
	if (bind) {
		struct flow_action_entry *entry = entry_data;
		struct tcf_police *police = to_police(act);
		struct tcf_police_params *p;
		int act_id;

		p = rcu_dereference_protected(police->params,
					      lockdep_is_held(&police->tcf_lock));

		entry->id = FLOW_ACTION_POLICE;
		entry->police.burst = tcf_police_burst(act);
		entry->police.rate_bytes_ps =
			tcf_police_rate_bytes_ps(act);
		entry->police.peakrate_bytes_ps = tcf_police_peakrate_bytes_ps(act);
		entry->police.avrate = tcf_police_tcfp_ewma_rate(act);
		entry->police.overhead = tcf_police_rate_overhead(act);
		entry->police.burst_pkt = tcf_police_burst_pkt(act);
		entry->police.rate_pkt_ps =
			tcf_police_rate_pkt_ps(act);
		entry->police.mtu = tcf_police_tcfp_mtu(act);

		act_id = tcf_police_act_to_flow_act(police->tcf_action,
						    &entry->police.exceed.extval,
						    extack);
		if (act_id < 0)
			return act_id;

		entry->police.exceed.act_id = act_id;

		act_id = tcf_police_act_to_flow_act(p->tcfp_result,
						    &entry->police.notexceed.extval,
						    extack);
		if (act_id < 0)
			return act_id;

		entry->police.notexceed.act_id = act_id;

		*index_inc = 1;
	} else {
		struct flow_offload_action *fl_action = entry_data;

		fl_action->id = FLOW_ACTION_POLICE;
	}

	return 0;
}

MODULE_AUTHOR("Alexey Kuznetsov");
MODULE_DESCRIPTION("Policing actions");
MODULE_LICENSE("GPL");

static struct tc_action_ops act_police_ops = {
	.kind		=	"police",
	.id		=	TCA_ID_POLICE,
	.owner		=	THIS_MODULE,
	.stats_update	=	tcf_police_stats_update,
	.act		=	tcf_police_act,
	.dump		=	tcf_police_dump,
	.init		=	tcf_police_init,
	.cleanup	=	tcf_police_cleanup,
	.offload_act_setup =	tcf_police_offload_act_setup,
	.size		=	sizeof(struct tcf_police),
};

static __net_init int police_init_net(struct net *net)
{
	struct tc_action_net *tn = net_generic(net, act_police_ops.net_id);

	return tc_action_net_init(net, tn, &act_police_ops);
}

static void __net_exit police_exit_net(struct list_head *net_list)
{
	tc_action_net_exit(net_list, act_police_ops.net_id);
}

static struct pernet_operations police_net_ops = {
	.init = police_init_net,
	.exit_batch = police_exit_net,
	.id   = &act_police_ops.net_id,
	.size = sizeof(struct tc_action_net),
};

static int __init police_init_module(void)
{
	return tcf_register_action(&act_police_ops, &police_net_ops);
}

static void __exit police_cleanup_module(void)
{
	tcf_unregister_action(&act_police_ops, &police_net_ops);
}

module_init(police_init_module);
module_exit(police_cleanup_module);
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4	2	/*
0c6965dd	3	* net/sched/act_police.c Input police filter
1da177e4	4	*
1da177e4 LT	5	* Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
	6	* J Hadi Salim (action changes)
	7	*/
	8
1da177e4 LT	9	#include <linux/module.h>
	10	#include <linux/types.h>
	11	#include <linux/kernel.h>
1da177e4	12	#include <linux/string.h>
1da177e4	13	#include <linux/errno.h>
1da177e4	14	#include <linux/skbuff.h>
1da177e4 LT	15	#include <linux/rtnetlink.h>
1da177e4 LT	16	#include <linux/init.h>
5a0e3ad6	17	#include <linux/slab.h>
1da177e4	18	#include <net/act_api.h>
d457a0e3	19	#include <net/gso.h>
dc5fc579	20	#include <net/netlink.h>
d6124d6b	21	#include <net/pkt_cls.h>
fa762da9	22	#include <net/tc_act/tc_police.h>
871cf386	23	#include <net/tc_wrapper.h>
1e9b3d53	24
e9ce1cd3	25	/* Each policer is serialized by its individual spinlock */
1da177e4	26
a85a970a	27	static struct tc_action_ops act_police_ops;
ddf97ccd	28
53b2bf3f PM	29	static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
	30	[TCA_POLICE_RATE] = { .len = TC_RTAB_SIZE },
	31	[TCA_POLICE_PEAKRATE] = { .len = TC_RTAB_SIZE },
	32	[TCA_POLICE_AVRATE] = { .type = NLA_U32 },
	33	[TCA_POLICE_RESULT] = { .type = NLA_U32 },
d1967e49 DD	34	[TCA_POLICE_RATE64] = { .type = NLA_U64 },
d1967e49 DD	35	[TCA_POLICE_PEAKRATE64] = { .type = NLA_U64 },
2ffe0395 BZ	36	[TCA_POLICE_PKTRATE64] = { .type = NLA_U64, .min = 1 },
2ffe0395 BZ	37	[TCA_POLICE_PKTBURST64] = { .type = NLA_U64, .min = 1 },
53b2bf3f PM	38	};
53b2bf3f PM	39
2ac06347	40	static int tcf_police_init(struct net net, struct nlattr nla,
a85a970a	41	struct nlattr est, struct tc_action *a,
abbb0d33	42	struct tcf_proto *tp, u32 flags,
589dad6d	43	struct netlink_ext_ack *extack)
1da177e4	44	{
fd6d4338	45	int ret = 0, tcfp_result = TC_ACT_OK, err, size;
695176bf	46	bool bind = flags & TCA_ACT_FLAGS_BIND;
7ba699c6	47	struct nlattr *tb[TCA_POLICE_MAX + 1];
d6124d6b	48	struct tcf_chain *goto_ch = NULL;
1da177e4	49	struct tc_police *parm;
e9ce1cd3	50	struct tcf_police *police;
1da177e4	51	struct qdisc_rate_table R_tab = NULL, P_tab = NULL;
acd0a7ab	52	struct tc_action_net *tn = net_generic(net, act_police_ops.net_id);
2d550dba	53	struct tcf_police_params *new;
0852e455	54	bool exists = false;
7be8ef2c	55	u32 index;
d1967e49	56	u64 rate64, prate64;
2ffe0395	57	u64 pps, ppsburst;
1da177e4	58
cee63723	59	if (nla == NULL)
1da177e4 LT	60	return -EINVAL;
1da177e4 LT	61
8cb08174 JB	62	err = nla_parse_nested_deprecated(tb, TCA_POLICE_MAX, nla,
8cb08174 JB	63	police_policy, NULL);
cee63723 PM	64	if (err < 0)
	65	return err;
	66
7ba699c6	67	if (tb[TCA_POLICE_TBF] == NULL)
1e9b3d53	68	return -EINVAL;
7ba699c6	69	size = nla_len(tb[TCA_POLICE_TBF]);
1e9b3d53	70	if (size != sizeof(*parm) && size != sizeof(struct tc_police_compat))
1da177e4	71	return -EINVAL;
0852e455	72
7ba699c6	73	parm = nla_data(tb[TCA_POLICE_TBF]);
7be8ef2c DL	74	index = parm->index;
7be8ef2c DL	75	err = tcf_idr_check_alloc(tn, &index, a, bind);
0190c1d4 VB	76	if (err < 0)
	77	return err;
	78	exists = err;
0852e455 WC	79	if (exists && bind)
0852e455 WC	80	return 0;
1da177e4	81
0852e455	82	if (!exists) {
7be8ef2c	83	ret = tcf_idr_create(tn, index, NULL, a,
40bd094d	84	&act_police_ops, bind, true, flags);
0190c1d4	85	if (ret) {
7be8ef2c	86	tcf_idr_cleanup(tn, index);
a03e6fe5	87	return ret;
0190c1d4	88	}
a03e6fe5	89	ret = ACT_P_CREATED;
484afd1b	90	spin_lock_init(&(to_police(*a)->tcfp_lock));
695176bf	91	} else if (!(flags & TCA_ACT_FLAGS_REPLACE)) {
65a206c0	92	tcf_idr_release(*a, bind);
4e8ddd7f	93	return -EEXIST;
1da177e4	94	}
d6124d6b DC	95	err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
	96	if (err < 0)
	97	goto release_idr;
1da177e4	98
a85a970a	99	police = to_police(*a);
1da177e4 LT	100	if (parm->rate.rate) {
1da177e4 LT	101	err = -ENOMEM;
e9bc3fa2	102	R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE], NULL);
1da177e4 LT	103	if (R_tab == NULL)
1da177e4 LT	104	goto failure;
c1b56878	105
1da177e4 LT	106	if (parm->peakrate.rate) {
1da177e4 LT	107	P_tab = qdisc_get_rtab(&parm->peakrate,
e9bc3fa2	108	tb[TCA_POLICE_PEAKRATE], NULL);
71bcb09a	109	if (P_tab == NULL)
1da177e4	110	goto failure;
1da177e4 LT	111	}
1da177e4 LT	112	}
71bcb09a	113
71bcb09a	114	if (est) {
93be42f9 DC	115	err = gen_replace_estimator(&police->tcf_bstats,
93be42f9 DC	116	police->common.cpu_bstats,
71bcb09a	117	&police->tcf_rate_est,
edb09eb1	118	&police->tcf_lock,
29cbcd85	119	false, est);
71bcb09a	120	if (err)
74030603	121	goto failure;
a883bf56 JP	122	} else if (tb[TCA_POLICE_AVRATE] &&
a883bf56 JP	123	(ret == ACT_P_CREATED \|\|
1c0d32fd	124	!gen_estimator_active(&police->tcf_rate_est))) {
a883bf56	125	err = -EINVAL;
74030603	126	goto failure;
71bcb09a SH	127	}
71bcb09a SH	128
fd6d4338 DC	129	if (tb[TCA_POLICE_RESULT]) {
	130	tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
	131	if (TC_ACT_EXT_CMP(tcfp_result, TC_ACT_GOTO_CHAIN)) {
	132	NL_SET_ERR_MSG(extack,
	133	"goto chain not allowed on fallback");
	134	err = -EINVAL;
	135	goto failure;
	136	}
	137	}
	138
2ffe0395 BZ	139	if ((tb[TCA_POLICE_PKTRATE64] && !tb[TCA_POLICE_PKTBURST64]) \|\|
	140	(!tb[TCA_POLICE_PKTRATE64] && tb[TCA_POLICE_PKTBURST64])) {
	141	NL_SET_ERR_MSG(extack,
	142	"Both or neither packet-per-second burst and rate must be provided");
	143	err = -EINVAL;
	144	goto failure;
	145	}
	146
	147	if (tb[TCA_POLICE_PKTRATE64] && R_tab) {
	148	NL_SET_ERR_MSG(extack,
	149	"packet-per-second and byte-per-second rate limits not allowed in same action");
	150	err = -EINVAL;
	151	goto failure;
	152	}
	153
2d550dba DC	154	new = kzalloc(sizeof(*new), GFP_KERNEL);
	155	if (unlikely(!new)) {
	156	err = -ENOMEM;
	157	goto failure;
	158	}
	159
71bcb09a	160	/* No failure allowed after this point */
fd6d4338	161	new->tcfp_result = tcfp_result;
2d550dba DC	162	new->tcfp_mtu = parm->mtu;
	163	if (!new->tcfp_mtu) {
	164	new->tcfp_mtu = ~0;
c6d14ff1	165	if (R_tab)
2d550dba	166	new->tcfp_mtu = 255 << R_tab->rate.cell_log;
c6d14ff1 JP	167	}
c6d14ff1 JP	168	if (R_tab) {
2d550dba	169	new->rate_present = true;
d1967e49 DD	170	rate64 = tb[TCA_POLICE_RATE64] ?
	171	nla_get_u64(tb[TCA_POLICE_RATE64]) : 0;
	172	psched_ratecfg_precompute(&new->rate, &R_tab->rate, rate64);
c6d14ff1 JP	173	qdisc_put_rtab(R_tab);
c6d14ff1 JP	174	} else {
2d550dba	175	new->rate_present = false;
1da177e4	176	}
c6d14ff1	177	if (P_tab) {
2d550dba	178	new->peak_present = true;
d1967e49 DD	179	prate64 = tb[TCA_POLICE_PEAKRATE64] ?
	180	nla_get_u64(tb[TCA_POLICE_PEAKRATE64]) : 0;
	181	psched_ratecfg_precompute(&new->peak, &P_tab->rate, prate64);
c6d14ff1 JP	182	qdisc_put_rtab(P_tab);
c6d14ff1 JP	183	} else {
2d550dba	184	new->peak_present = false;
1da177e4 LT	185	}
1da177e4 LT	186
2d550dba	187	new->tcfp_burst = PSCHED_TICKS2NS(parm->burst);
f2cbd485	188	if (new->peak_present)
2d550dba DC	189	new->tcfp_mtu_ptoks = (s64)psched_l2t_ns(&new->peak,
2d550dba DC	190	new->tcfp_mtu);
1da177e4	191
7ba699c6	192	if (tb[TCA_POLICE_AVRATE])
2d550dba	193	new->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);
1da177e4	194
2ffe0395 BZ	195	if (tb[TCA_POLICE_PKTRATE64]) {
	196	pps = nla_get_u64(tb[TCA_POLICE_PKTRATE64]);
	197	ppsburst = nla_get_u64(tb[TCA_POLICE_PKTBURST64]);
	198	new->pps_present = true;
	199	new->tcfp_pkt_burst = PSCHED_TICKS2NS(ppsburst);
	200	psched_ppscfg_precompute(&new->ppsrate, pps);
	201	}
	202
2d550dba	203	spin_lock_bh(&police->tcf_lock);
f2cbd485 DC	204	spin_lock_bh(&police->tcfp_lock);
	205	police->tcfp_t_c = ktime_get_ns();
	206	police->tcfp_toks = new->tcfp_burst;
	207	if (new->peak_present)
	208	police->tcfp_ptoks = new->tcfp_mtu_ptoks;
	209	spin_unlock_bh(&police->tcfp_lock);
d6124d6b	210	goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
445d3749 PM	211	new = rcu_replace_pointer(police->params,
	212	new,
	213	lockdep_is_held(&police->tcf_lock));
e9ce1cd3	214	spin_unlock_bh(&police->tcf_lock);
1da177e4	215
d6124d6b DC	216	if (goto_ch)
d6124d6b DC	217	tcf_chain_put_by_act(goto_ch);
2d550dba DC	218	if (new)
2d550dba DC	219	kfree_rcu(new, rcu);
1da177e4	220
1da177e4 LT	221	return ret;
	222
	223	failure:
3b69a4c9 YY	224	qdisc_put_rtab(P_tab);
3b69a4c9 YY	225	qdisc_put_rtab(R_tab);
d6124d6b DC	226	if (goto_ch)
	227	tcf_chain_put_by_act(goto_ch);
	228	release_idr:
4e8ddd7f	229	tcf_idr_release(*a, bind);
1da177e4 LT	230	return err;
	231	}
	232
4ddc844e DC	233	static bool tcf_police_mtu_check(struct sk_buff *skb, u32 limit)
	234	{
	235	u32 len;
	236
	237	if (skb_is_gso(skb))
	238	return skb_gso_validate_mac_len(skb, limit);
	239
	240	len = qdisc_pkt_len(skb);
	241	if (skb_at_tc_ingress(skb))
	242	len += skb->mac_len;
	243
	244	return len <= limit;
	245	}
	246
871cf386 PT	247	TC_INDIRECT_SCOPE int tcf_police_act(struct sk_buff *skb,
	248	const struct tc_action *a,
	249	struct tcf_result *res)
1da177e4	250	{
a85a970a	251	struct tcf_police *police = to_police(a);
2ffe0395	252	s64 now, toks, ppstoks = 0, ptoks = 0;
2d550dba	253	struct tcf_police_params *p;
93be42f9	254	int ret;
1da177e4	255
3d3ed181	256	tcf_lastuse_update(&police->tcf_tm);
50dc9a85	257	bstats_update(this_cpu_ptr(police->common.cpu_bstats), skb);
1da177e4	258
2d550dba DC	259	ret = READ_ONCE(police->tcf_action);
	260	p = rcu_dereference_bh(police->params);
	261
	262	if (p->tcfp_ewma_rate) {
1c0d32fd ED	263	struct gnet_stats_rate_est64 sample;
	264
	265	if (!gen_estimator_read(&police->tcf_rate_est, &sample) \|\|
2d550dba	266	sample.bps >= p->tcfp_ewma_rate)
93be42f9	267	goto inc_overlimits;
1da177e4	268	}
1da177e4	269
4ddc844e	270	if (tcf_police_mtu_check(skb, p->tcfp_mtu)) {
2ffe0395	271	if (!p->rate_present && !p->pps_present) {
2d550dba DC	272	ret = p->tcfp_result;
2d550dba DC	273	goto end;
1da177e4 LT	274	}
1da177e4 LT	275
d2de875c	276	now = ktime_get_ns();
f2cbd485 DC	277	spin_lock_bh(&police->tcfp_lock);
f2cbd485 DC	278	toks = min_t(s64, now - police->tcfp_t_c, p->tcfp_burst);
2d550dba	279	if (p->peak_present) {
f2cbd485	280	ptoks = toks + police->tcfp_ptoks;
2d550dba DC	281	if (ptoks > p->tcfp_mtu_ptoks)
	282	ptoks = p->tcfp_mtu_ptoks;
	283	ptoks -= (s64)psched_l2t_ns(&p->peak,
	284	qdisc_pkt_len(skb));
1da177e4	285	}
2ffe0395 BZ	286	if (p->rate_present) {
	287	toks += police->tcfp_toks;
	288	if (toks > p->tcfp_burst)
	289	toks = p->tcfp_burst;
	290	toks -= (s64)psched_l2t_ns(&p->rate, qdisc_pkt_len(skb));
	291	} else if (p->pps_present) {
	292	ppstoks = min_t(s64, now - police->tcfp_t_c, p->tcfp_pkt_burst);
	293	ppstoks += police->tcfp_pkttoks;
	294	if (ppstoks > p->tcfp_pkt_burst)
	295	ppstoks = p->tcfp_pkt_burst;
	296	ppstoks -= (s64)psched_pkt2t_ns(&p->ppsrate, 1);
	297	}
	298	if ((toks \| ptoks \| ppstoks) >= 0) {
f2cbd485 DC	299	police->tcfp_t_c = now;
	300	police->tcfp_toks = toks;
	301	police->tcfp_ptoks = ptoks;
2ffe0395	302	police->tcfp_pkttoks = ppstoks;
f2cbd485	303	spin_unlock_bh(&police->tcfp_lock);
2d550dba	304	ret = p->tcfp_result;
93be42f9	305	goto inc_drops;
1da177e4	306	}
f2cbd485	307	spin_unlock_bh(&police->tcfp_lock);
1da177e4	308	}
93be42f9 DC	309
	310	inc_overlimits:
	311	qstats_overlimit_inc(this_cpu_ptr(police->common.cpu_qstats));
	312	inc_drops:
	313	if (ret == TC_ACT_SHOT)
	314	qstats_drop_inc(this_cpu_ptr(police->common.cpu_qstats));
2d550dba	315	end:
93be42f9	316	return ret;
1da177e4 LT	317	}
1da177e4 LT	318
2d550dba DC	319	static void tcf_police_cleanup(struct tc_action *a)
	320	{
	321	struct tcf_police *police = to_police(a);
	322	struct tcf_police_params *p;
	323
	324	p = rcu_dereference_protected(police->params, 1);
	325	if (p)
	326	kfree_rcu(p, rcu);
	327	}
	328
12f02b6b	329	static void tcf_police_stats_update(struct tc_action *a,
4b61d3e8	330	u64 bytes, u64 packets, u64 drops,
12f02b6b PJV	331	u64 lastuse, bool hw)
	332	{
	333	struct tcf_police *police = to_police(a);
	334	struct tcf_t *tm = &police->tcf_tm;
	335
4b61d3e8	336	tcf_action_update_stats(a, bytes, packets, drops, hw);
12f02b6b PJV	337	tm->lastuse = max_t(u64, tm->lastuse, lastuse);
	338	}
	339
2ac06347	340	static int tcf_police_dump(struct sk_buff skb, struct tc_action a,
5a7a5555	341	int bind, int ref)
1da177e4	342	{
27a884dc	343	unsigned char *b = skb_tail_pointer(skb);
a85a970a	344	struct tcf_police *police = to_police(a);
2d550dba	345	struct tcf_police_params *p;
0f04cfd0 JM	346	struct tc_police opt = {
0f04cfd0 JM	347	.index = police->tcf_index,
036bb443 VB	348	.refcnt = refcount_read(&police->tcf_refcnt) - ref,
036bb443 VB	349	.bindcnt = atomic_read(&police->tcf_bindcnt) - bind,
0f04cfd0	350	};
3d3ed181	351	struct tcf_t t;
0f04cfd0	352
e329bc42 VB	353	spin_lock_bh(&police->tcf_lock);
e329bc42 VB	354	opt.action = police->tcf_action;
2d550dba DC	355	p = rcu_dereference_protected(police->params,
	356	lockdep_is_held(&police->tcf_lock));
	357	opt.mtu = p->tcfp_mtu;
	358	opt.burst = PSCHED_NS2TICKS(p->tcfp_burst);
d1967e49	359	if (p->rate_present) {
2d550dba	360	psched_ratecfg_getrate(&opt.rate, &p->rate);
682881ee	361	if ((p->rate.rate_bytes_ps >= (1ULL << 32)) &&
d1967e49	362	nla_put_u64_64bit(skb, TCA_POLICE_RATE64,
682881ee	363	p->rate.rate_bytes_ps,
d1967e49 DD	364	TCA_POLICE_PAD))
	365	goto nla_put_failure;
	366	}
	367	if (p->peak_present) {
2d550dba	368	psched_ratecfg_getrate(&opt.peakrate, &p->peak);
682881ee	369	if ((p->peak.rate_bytes_ps >= (1ULL << 32)) &&
d1967e49	370	nla_put_u64_64bit(skb, TCA_POLICE_PEAKRATE64,
682881ee	371	p->peak.rate_bytes_ps,
d1967e49 DD	372	TCA_POLICE_PAD))
	373	goto nla_put_failure;
	374	}
2ffe0395 BZ	375	if (p->pps_present) {
2ffe0395 BZ	376	if (nla_put_u64_64bit(skb, TCA_POLICE_PKTRATE64,
682881ee	377	p->ppsrate.rate_pkts_ps,
2ffe0395 BZ	378	TCA_POLICE_PAD))
	379	goto nla_put_failure;
	380	if (nla_put_u64_64bit(skb, TCA_POLICE_PKTBURST64,
	381	PSCHED_NS2TICKS(p->tcfp_pkt_burst),
	382	TCA_POLICE_PAD))
	383	goto nla_put_failure;
	384	}
1b34ec43 DM	385	if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
1b34ec43 DM	386	goto nla_put_failure;
2d550dba DC	387	if (p->tcfp_result &&
2d550dba DC	388	nla_put_u32(skb, TCA_POLICE_RESULT, p->tcfp_result))
1b34ec43	389	goto nla_put_failure;
2d550dba DC	390	if (p->tcfp_ewma_rate &&
2d550dba DC	391	nla_put_u32(skb, TCA_POLICE_AVRATE, p->tcfp_ewma_rate))
1b34ec43	392	goto nla_put_failure;
3d3ed181	393
985fd98a	394	tcf_tm_dump(&t, &police->tcf_tm);
3d3ed181 JHS	395	if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD))
3d3ed181 JHS	396	goto nla_put_failure;
e329bc42	397	spin_unlock_bh(&police->tcf_lock);
3d3ed181	398
1da177e4 LT	399	return skb->len;
1da177e4 LT	400
7ba699c6	401	nla_put_failure:
e329bc42	402	spin_unlock_bh(&police->tcf_lock);
dc5fc579	403	nlmsg_trim(skb, b);
1da177e4 LT	404	return -1;
	405	}
	406
b50e462b IS	407	static int tcf_police_act_to_flow_act(int tc_act, u32 *extval,
b50e462b IS	408	struct netlink_ext_ack *extack)
b8cd5831 JL	409	{
	410	int act_id = -EOPNOTSUPP;
	411
	412	if (!TC_ACT_EXT_OPCODE(tc_act)) {
	413	if (tc_act == TC_ACT_OK)
	414	act_id = FLOW_ACTION_ACCEPT;
	415	else if (tc_act == TC_ACT_SHOT)
	416	act_id = FLOW_ACTION_DROP;
	417	else if (tc_act == TC_ACT_PIPE)
	418	act_id = FLOW_ACTION_PIPE;
b50e462b IS	419	else if (tc_act == TC_ACT_RECLASSIFY)
	420	NL_SET_ERR_MSG_MOD(extack, "Offload not supported when conform/exceed action is \"reclassify\"");
	421	else
	422	NL_SET_ERR_MSG_MOD(extack, "Unsupported conform/exceed action offload");
b8cd5831 JL	423	} else if (TC_ACT_EXT_CMP(tc_act, TC_ACT_GOTO_CHAIN)) {
	424	act_id = FLOW_ACTION_GOTO;
	425	*extval = tc_act & TC_ACT_EXT_VAL_MASK;
	426	} else if (TC_ACT_EXT_CMP(tc_act, TC_ACT_JUMP)) {
	427	act_id = FLOW_ACTION_JUMP;
	428	*extval = tc_act & TC_ACT_EXT_VAL_MASK;
b50e462b	429	} else if (tc_act == TC_ACT_UNSPEC) {
052f744f	430	act_id = FLOW_ACTION_CONTINUE;
b50e462b IS	431	} else {
b50e462b IS	432	NL_SET_ERR_MSG_MOD(extack, "Unsupported conform/exceed action offload");
b8cd5831 JL	433	}
	434
	435	return act_id;
	436	}
	437
c54e1d92	438	static int tcf_police_offload_act_setup(struct tc_action act, void entry_data,
c2ccf84e IS	439	u32 *index_inc, bool bind,
c2ccf84e IS	440	struct netlink_ext_ack *extack)
c54e1d92 BZ	441	{
	442	if (bind) {
	443	struct flow_action_entry *entry = entry_data;
b8cd5831 JL	444	struct tcf_police *police = to_police(act);
	445	struct tcf_police_params *p;
	446	int act_id;
	447
	448	p = rcu_dereference_protected(police->params,
	449	lockdep_is_held(&police->tcf_lock));
c54e1d92 BZ	450
	451	entry->id = FLOW_ACTION_POLICE;
	452	entry->police.burst = tcf_police_burst(act);
	453	entry->police.rate_bytes_ps =
	454	tcf_police_rate_bytes_ps(act);
b8cd5831 JL	455	entry->police.peakrate_bytes_ps = tcf_police_peakrate_bytes_ps(act);
	456	entry->police.avrate = tcf_police_tcfp_ewma_rate(act);
	457	entry->police.overhead = tcf_police_rate_overhead(act);
c54e1d92 BZ	458	entry->police.burst_pkt = tcf_police_burst_pkt(act);
	459	entry->police.rate_pkt_ps =
	460	tcf_police_rate_pkt_ps(act);
	461	entry->police.mtu = tcf_police_tcfp_mtu(act);
b8cd5831 JL	462
b8cd5831 JL	463	act_id = tcf_police_act_to_flow_act(police->tcf_action,
b50e462b IS	464	&entry->police.exceed.extval,
b50e462b IS	465	extack);
b8cd5831 JL	466	if (act_id < 0)
	467	return act_id;
	468
	469	entry->police.exceed.act_id = act_id;
	470
	471	act_id = tcf_police_act_to_flow_act(p->tcfp_result,
b50e462b IS	472	&entry->police.notexceed.extval,
b50e462b IS	473	extack);
b8cd5831 JL	474	if (act_id < 0)
	475	return act_id;
	476
	477	entry->police.notexceed.act_id = act_id;
	478
c54e1d92 BZ	479	*index_inc = 1;
c54e1d92 BZ	480	} else {
8cbfe939 BZ	481	struct flow_offload_action *fl_action = entry_data;
	482
	483	fl_action->id = FLOW_ACTION_POLICE;
c54e1d92 BZ	484	}
	485
	486	return 0;
	487	}
	488
1da177e4 LT	489	MODULE_AUTHOR("Alexey Kuznetsov");
	490	MODULE_DESCRIPTION("Policing actions");
	491	MODULE_LICENSE("GPL");
	492
	493	static struct tc_action_ops act_police_ops = {
	494	.kind = "police",
eddd2cf1	495	.id = TCA_ID_POLICE,
1da177e4	496	.owner = THIS_MODULE,
12f02b6b	497	.stats_update = tcf_police_stats_update,
2ac06347 JHS	498	.act = tcf_police_act,
	499	.dump = tcf_police_dump,
	500	.init = tcf_police_init,
2d550dba	501	.cleanup = tcf_police_cleanup,
c54e1d92	502	.offload_act_setup = tcf_police_offload_act_setup,
a85a970a	503	.size = sizeof(struct tcf_police),
ddf97ccd WC	504	};
	505
	506	static __net_init int police_init_net(struct net *net)
	507	{
acd0a7ab	508	struct tc_action_net *tn = net_generic(net, act_police_ops.net_id);
ddf97ccd	509
981471bd	510	return tc_action_net_init(net, tn, &act_police_ops);
ddf97ccd WC	511	}
ddf97ccd WC	512
039af9c6	513	static void __net_exit police_exit_net(struct list_head *net_list)
ddf97ccd	514	{
acd0a7ab	515	tc_action_net_exit(net_list, act_police_ops.net_id);
ddf97ccd WC	516	}
	517
	518	static struct pernet_operations police_net_ops = {
	519	.init = police_init_net,
039af9c6	520	.exit_batch = police_exit_net,
acd0a7ab	521	.id = &act_police_ops.net_id,
ddf97ccd	522	.size = sizeof(struct tc_action_net),
1da177e4 LT	523	};
1da177e4 LT	524
5a7a5555	525	static int __init police_init_module(void)
1da177e4	526	{
ddf97ccd	527	return tcf_register_action(&act_police_ops, &police_net_ops);
1da177e4 LT	528	}
1da177e4 LT	529
5a7a5555	530	static void __exit police_cleanup_module(void)
1da177e4	531	{
ddf97ccd	532	tcf_unregister_action(&act_police_ops, &police_net_ops);
1da177e4 LT	533	}
	534
	535	module_init(police_init_module);
	536	module_exit(police_cleanup_module);