Skip to contentSkip to conversation

net: Catch invalid index in XPS mapping

PATCH Applied Nick Child 2 participants 3 messages Mar 21, 2023 – Mar 23, 2023

Subsystems (2)
lore
Share & tools
lore

Nick Child

author
#0 lore raw

PATCH v2 1/2 net: Catch invalid index in XPS mapping

When setting the XPS value of a TX queue, warn the user once if the index of the queue is greater than the number of allocated TX queues.

Previously, this scenario went uncaught. In the best case, it resulted in unnecessary allocations. In the worst case, it resulted in out-of-bounds memory references through calls to netdev_get_tx_queue( dev, index). Therefore, it is important to inform the user but not worth returning an error and risk downing the netdevice.

---
Changes since v1 (respond to Jakubs review):
- send to net-next instead of net
- use WARN_ON_ONCE instead of a conditonal returning error

v1 - https://lore.kernel.org/netdev/[email protected]/

 net/core/dev.c | 2 ++
 1 file changed, 2 insertions(+)
net/core/dev.c +2 -0
index c7853192563d..c278beee6792 100644
@@ -2535,6 +2535,8 @@ int __netif_set_xps_queue(struct net_device *dev, const unsigned long *mask,
 	struct xps_map *map, *new_map;
 	unsigned int nr_ids;
 
+	WARN_ON_ONCE(index >= dev->num_tx_queues);
+
 	if (dev->num_tc) {
 		/* Do not allow XPS on subordinate device directly */
 		num_tc = dev->num_tc;
Signature · 1 line
2.31.1
author
#1 lore raw

PATCH v2 2/2 netdev: Enforce index cap in netdev_get_tx_queue

When requesting a TX queue at a given index, warn on out-of-bounds referencing if the index is greater than the allocated number of queues.

Specifically, since this function is used heavily in the networking stack use DEBUG_NET_WARN_ON_ONCE to avoid executing a new branch on every packet.

---
Changes since v1 (respond to Jakubs review):
- send to net-next instead of net
- use DEBUG_NET_WARN_ON_ONCE instead of a conditonal returning 1st queue

v1 - https://lore.kernel.org/netdev/20230320214942.38395e6e@kicinski-fedora-PC1C0HJN/

 include/linux/netdevice.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/netdevice.h +1 -0
index 23b0d7eaaadd..838b7310a80b 100644
@@ -2482,6 +2482,7 @@ static inline
 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
 					 unsigned int index)
 {
+	DEBUG_NET_WARN_ON_ONCE(index >= dev->num_tx_queues);
 	return &dev->_tx[index];
 }
 
Signature · 1 line
2.31.1
#2 lore raw
In reply to Nick Child
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Quoted 10 lines · On Tue, 21 Mar 2023 10:07:24 -0500 you wrote:

When setting the XPS value of a TX queue, warn the user once if the index of the queue is greater than the number of allocated TX queues.

Previously, this scenario went uncaught. In the best case, it resulted in unnecessary allocations. In the worst case, it resulted in out-of-bounds memory references through calls to netdev_get_tx_queue( dev, index). Therefore, it is important to inform the user but not worth returning an error and risk downing the netdevice.

[...]

Here is the summary with links:
- [net-next,v2,1/2] net: Catch invalid index in XPS mapping

    https://git.kernel.org/netdev/net-next/c/5dd0dfd55bae
  - [net-next,v2,2/2] netdev: Enforce index cap in netdev_get_tx_queue
    https://git.kernel.org/netdev/net-next/c/1cc6571f5627

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html