xref: /linux/include/net/netdev_rx_queue.h (revision 6be87fbb27763c2999e1c69bbec1f3a63cf05422)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_NETDEV_RX_QUEUE_H
3 #define _LINUX_NETDEV_RX_QUEUE_H
4 
5 #include <linux/kobject.h>
6 #include <linux/netdevice.h>
7 #include <linux/sysfs.h>
8 #include <net/xdp.h>
9 #include <net/page_pool/types.h>
10 
11 /* This structure contains an instance of an RX queue. */
12 struct netdev_rx_queue {
13 	struct xdp_rxq_info		xdp_rxq;
14 #ifdef CONFIG_RPS
15 	struct rps_map __rcu		*rps_map;
16 	struct rps_dev_flow_table __rcu	*rps_flow_table;
17 #endif
18 	struct kobject			kobj;
19 	const struct attribute_group	**groups;
20 	struct net_device		*dev;
21 	netdevice_tracker		dev_tracker;
22 
23 	/* All fields below are "ops protected",
24 	 * see comment about net_device::lock
25 	 */
26 #ifdef CONFIG_XDP_SOCKETS
27 	struct xsk_buff_pool            *pool;
28 #endif
29 	struct napi_struct		*napi;
30 	struct pp_memory_provider_params mp_params;
31 	struct netdev_rx_queue		*lease;
32 	netdevice_tracker		lease_tracker;
33 } ____cacheline_aligned_in_smp;
34 
35 /*
36  * RX queue sysfs structures and functions.
37  */
38 struct rx_queue_attribute {
39 	struct attribute attr;
40 	ssize_t (*show)(struct netdev_rx_queue *queue, char *buf);
41 	ssize_t (*store)(struct netdev_rx_queue *queue,
42 			 const char *buf, size_t len);
43 };
44 
45 static inline struct netdev_rx_queue *
46 __netif_get_rx_queue(struct net_device *dev, unsigned int rxq)
47 {
48 	return dev->_rx + rxq;
49 }
50 
51 static inline unsigned int
52 get_netdev_rx_queue_index(struct netdev_rx_queue *queue)
53 {
54 	struct net_device *dev = queue->dev;
55 	int index = queue - dev->_rx;
56 
57 	BUG_ON(index >= dev->num_rx_queues);
58 	return index;
59 }
60 
61 int netdev_rx_queue_restart(struct net_device *dev, unsigned int rxq);
62 void netdev_rx_queue_lease(struct netdev_rx_queue *rxq_dst,
63 			   struct netdev_rx_queue *rxq_src);
64 void netdev_rx_queue_unlease(struct netdev_rx_queue *rxq_dst,
65 			     struct netdev_rx_queue *rxq_src);
66 bool netif_rx_queue_lease_get_owner(struct net_device **dev, unsigned int *rxq);
67 
68 enum netif_lease_dir {
69 	NETIF_VIRT_TO_PHYS,
70 	NETIF_PHYS_TO_VIRT,
71 };
72 
73 struct netdev_rx_queue *
74 __netif_get_rx_queue_lease(struct net_device **dev, unsigned int *rxq,
75 			   enum netif_lease_dir dir);
76 struct netdev_rx_queue *
77 netif_get_rx_queue_lease_locked(struct net_device **dev, unsigned int *rxq);
78 void netif_put_rx_queue_lease_locked(struct net_device *orig_dev,
79 				     struct net_device *dev);
80 #endif /* _LINUX_NETDEV_RX_QUEUE_H */
81