Commit 1dfe086d authored by Vladimir Oltean's avatar Vladimir Oltean Committed by David S. Miller
Browse files

net/sched: taprio: centralize mqprio qopt validation 



There is a lot of code in taprio which is "borrowed" from mqprio.
It makes sense to put a stop to the "borrowing" and start actually
reusing code.

Because taprio and mqprio are built as part of different kernel modules,
code reuse can only take place either by writing it as static inline
(limiting), putting it in sch_generic.o (not generic enough), or
creating a third auto-selectable kernel module which only holds library
code. I opted for the third variant.

In a previous change, mqprio gained support for reverse TC:TXQ mappings,
something which taprio still denies. Make taprio use the same validation
logic so that it supports this configuration as well.

The taprio code didn't enforce TXQ overlaps in txtime-assist mode and
that looks intentional, even if I've no idea why that might be. Preserve
that, but add a comment.

There isn't any dedicated MAINTAINERS entry for mqprio, so nothing to
update there.

Signed-off-by: default avatarVladimir Oltean <vladimir.oltean@nxp.com>
Reviewed-by: default avatarSimon Horman <simon.horman@corigine.com>
Reviewed-by: default avatarGerhard Engleder <gerhard@engleder-embedded.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent d404959f

net/sched/Kconfig

+7 −0
Original line number Diff line number Diff line
@@ -195,8 +195,14 @@ config NET_SCH_ETF 
	  To compile this code as a module, choose M here: the

	  module will be called sch_etf.



config NET_SCH_MQPRIO_LIB

	tristate

	help

	  Common library for manipulating mqprio queue configurations.



config NET_SCH_TAPRIO

	tristate "Time Aware Priority (taprio) Scheduler"

	select NET_SCH_MQPRIO_LIB

	help

	  Say Y here if you want to use the Time Aware Priority (taprio) packet

	  scheduling algorithm.
@@ -253,6 +259,7 @@ config NET_SCH_DRR 


config NET_SCH_MQPRIO

	tristate "Multi-queue priority scheduler (MQPRIO)"

	select NET_SCH_MQPRIO_LIB

	help

	  Say Y here if you want to use the Multi-queue Priority scheduler.

	  This scheduler allows QOS to be offloaded on NICs that have support

net/sched/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -52,6 +52,7 @@ obj-$(CONFIG_NET_SCH_DRR) += sch_drr.o 
obj-$(CONFIG_NET_SCH_PLUG)	+= sch_plug.o

obj-$(CONFIG_NET_SCH_ETS)	+= sch_ets.o

obj-$(CONFIG_NET_SCH_MQPRIO)	+= sch_mqprio.o

obj-$(CONFIG_NET_SCH_MQPRIO_LIB) += sch_mqprio_lib.o

obj-$(CONFIG_NET_SCH_SKBPRIO)	+= sch_skbprio.o

obj-$(CONFIG_NET_SCH_CHOKE)	+= sch_choke.o

obj-$(CONFIG_NET_SCH_QFQ)	+= sch_qfq.o

net/sched/sch_mqprio.c

+8 −69
Original line number Diff line number Diff line
@@ -17,6 +17,8 @@ 
#include <net/sch_generic.h>

#include <net/pkt_cls.h>



#include "sch_mqprio_lib.h"



struct mqprio_sched {

	struct Qdisc		**qdiscs;

	u16 mode;
@@ -27,59 +29,6 @@ struct mqprio_sched { 
	u64 max_rate[TC_QOPT_MAX_QUEUE];

};



/* Returns true if the intervals [a, b) and [c, d) overlap. */

static bool intervals_overlap(int a, int b, int c, int d)

{

	int left = max(a, c), right = min(b, d);



	return left < right;

}



static int mqprio_validate_queue_counts(struct net_device *dev,

					const struct tc_mqprio_qopt *qopt,

					struct netlink_ext_ack *extack)

{

	int i, j;



	for (i = 0; i < qopt->num_tc; i++) {

		unsigned int last = qopt->offset[i] + qopt->count[i];



		if (!qopt->count[i]) {

			NL_SET_ERR_MSG_FMT_MOD(extack, "No queues for TC %d",

					       i);

			return -EINVAL;

		}



		/* Verify the queue count is in tx range being equal to the

		 * real_num_tx_queues indicates the last queue is in use.

		 */

		if (qopt->offset[i] >= dev->real_num_tx_queues ||

		    last > dev->real_num_tx_queues) {

			NL_SET_ERR_MSG_FMT_MOD(extack,

					       "Queues %d:%d for TC %d exceed the %d TX queues available",

					       qopt->count[i], qopt->offset[i],

					       i, dev->real_num_tx_queues);

			return -EINVAL;

		}



		/* Verify that the offset and counts do not overlap */

		for (j = i + 1; j < qopt->num_tc; j++) {

			if (intervals_overlap(qopt->offset[i], last,

					      qopt->offset[j],

					      qopt->offset[j] +

					      qopt->count[j])) {

				NL_SET_ERR_MSG_FMT_MOD(extack,

						       "TC %d queues %d@%d overlap with TC %d queues %d@%d",

						       i, qopt->count[i], qopt->offset[i],

						       j, qopt->count[j], qopt->offset[j]);

				return -EINVAL;

			}

		}

	}



	return 0;

}



static int mqprio_enable_offload(struct Qdisc *sch,

				 const struct tc_mqprio_qopt *qopt,

				 struct netlink_ext_ack *extack)
@@ -160,17 +109,7 @@ static int mqprio_parse_opt(struct net_device *dev, struct tc_mqprio_qopt *qopt, 
			    const struct tc_mqprio_caps *caps,

			    struct netlink_ext_ack *extack)

{

	int i, err;



	/* Verify num_tc is not out of max range */

	if (qopt->num_tc > TC_MAX_QUEUE)

		return -EINVAL;



	/* Verify priority mapping uses valid tcs */

	for (i = 0; i < TC_BITMASK + 1; i++) {

		if (qopt->prio_tc_map[i] >= qopt->num_tc)

			return -EINVAL;

	}

	int err;



	/* Limit qopt->hw to maximum supported offload value.  Drivers have

	 * the option of overriding this later if they don't support the a
@@ -185,11 +124,11 @@ static int mqprio_parse_opt(struct net_device *dev, struct tc_mqprio_qopt *qopt, 
	 * - validate the provided queue counts by itself (and apply them)

	 * - request queue count validation here (and apply them)

	 */

	if (!qopt->hw || caps->validate_queue_counts) {

		err = mqprio_validate_queue_counts(dev, qopt, extack);

	err = mqprio_validate_qopt(dev, qopt,

				   !qopt->hw || caps->validate_queue_counts,

				   false, extack);

	if (err)

		return err;

	}



	/* If ndo_setup_tc is not present then hardware doesn't support offload

	 * and we should return an error.

net/sched/sch_mqprio_lib.c

0 → 100644
+103 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only



#include <linux/net.h>

#include <linux/netdevice.h>

#include <linux/netlink.h>

#include <linux/types.h>

#include <net/pkt_sched.h>



#include "sch_mqprio_lib.h"



/* Returns true if the intervals [a, b) and [c, d) overlap. */

static bool intervals_overlap(int a, int b, int c, int d)

{

	int left = max(a, c), right = min(b, d);



	return left < right;

}



static int mqprio_validate_queue_counts(struct net_device *dev,

					const struct tc_mqprio_qopt *qopt,

					bool allow_overlapping_txqs,

					struct netlink_ext_ack *extack)

{

	int i, j;



	for (i = 0; i < qopt->num_tc; i++) {

		unsigned int last = qopt->offset[i] + qopt->count[i];



		if (!qopt->count[i]) {

			NL_SET_ERR_MSG_FMT_MOD(extack, "No queues for TC %d",

					       i);

			return -EINVAL;

		}



		/* Verify the queue count is in tx range being equal to the

		 * real_num_tx_queues indicates the last queue is in use.

		 */

		if (qopt->offset[i] >= dev->real_num_tx_queues ||

		    last > dev->real_num_tx_queues) {

			NL_SET_ERR_MSG_FMT_MOD(extack,

					       "Queues %d:%d for TC %d exceed the %d TX queues available",

					       qopt->count[i], qopt->offset[i],

					       i, dev->real_num_tx_queues);

			return -EINVAL;

		}



		if (allow_overlapping_txqs)

			continue;



		/* Verify that the offset and counts do not overlap */

		for (j = i + 1; j < qopt->num_tc; j++) {

			if (intervals_overlap(qopt->offset[i], last,

					      qopt->offset[j],

					      qopt->offset[j] +

					      qopt->count[j])) {

				NL_SET_ERR_MSG_FMT_MOD(extack,

						       "TC %d queues %d@%d overlap with TC %d queues %d@%d",

						       i, qopt->count[i], qopt->offset[i],

						       j, qopt->count[j], qopt->offset[j]);

				return -EINVAL;

			}

		}

	}



	return 0;

}



int mqprio_validate_qopt(struct net_device *dev, struct tc_mqprio_qopt *qopt,

			 bool validate_queue_counts,

			 bool allow_overlapping_txqs,

			 struct netlink_ext_ack *extack)

{

	int i, err;



	/* Verify num_tc is not out of max range */

	if (qopt->num_tc > TC_MAX_QUEUE) {

		NL_SET_ERR_MSG(extack,

			       "Number of traffic classes is outside valid range");

		return -EINVAL;

	}



	/* Verify priority mapping uses valid tcs */

	for (i = 0; i <= TC_BITMASK; i++) {

		if (qopt->prio_tc_map[i] >= qopt->num_tc) {

			NL_SET_ERR_MSG(extack,

				       "Invalid traffic class in priority to traffic class mapping");

			return -EINVAL;

		}

	}



	if (validate_queue_counts) {

		err = mqprio_validate_queue_counts(dev, qopt,

						   allow_overlapping_txqs,

						   extack);

		if (err)

			return err;

	}



	return 0;

}

EXPORT_SYMBOL_GPL(mqprio_validate_qopt);



MODULE_LICENSE("GPL");

net/sched/sch_mqprio_lib.h

0 → 100644
+16 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 */

#ifndef __SCH_MQPRIO_LIB_H

#define __SCH_MQPRIO_LIB_H



#include <linux/types.h>



struct net_device;

struct netlink_ext_ack;

struct tc_mqprio_qopt;



int mqprio_validate_qopt(struct net_device *dev, struct tc_mqprio_qopt *qopt,

			 bool validate_queue_counts,

			 bool allow_overlapping_txqs,

			 struct netlink_ext_ack *extack);



#endif