xref: /linux/include/net/xdp_sock.h (revision 3839a7460721b87501134697b7b90c45dcc7825d)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* AF_XDP internal functions
3  * Copyright(c) 2018 Intel Corporation.
4  */
5 
6 #ifndef _LINUX_XDP_SOCK_H
7 #define _LINUX_XDP_SOCK_H
8 
9 #include <linux/workqueue.h>
10 #include <linux/if_xdp.h>
11 #include <linux/mutex.h>
12 #include <linux/spinlock.h>
13 #include <linux/mm.h>
14 #include <net/sock.h>
15 
16 struct net_device;
17 struct xsk_queue;
18 struct xdp_buff;
19 
20 struct xdp_umem {
21 	struct xsk_queue *fq;
22 	struct xsk_queue *cq;
23 	struct xsk_buff_pool *pool;
24 	u64 size;
25 	u32 headroom;
26 	u32 chunk_size;
27 	struct user_struct *user;
28 	refcount_t users;
29 	struct work_struct work;
30 	struct page **pgs;
31 	u32 npgs;
32 	u16 queue_id;
33 	u8 need_wakeup;
34 	u8 flags;
35 	int id;
36 	struct net_device *dev;
37 	bool zc;
38 	spinlock_t xsk_tx_list_lock;
39 	struct list_head xsk_tx_list;
40 };
41 
42 struct xsk_map {
43 	struct bpf_map map;
44 	spinlock_t lock; /* Synchronize map updates */
45 	struct xdp_sock *xsk_map[];
46 };
47 
48 struct xdp_sock {
49 	/* struct sock must be the first member of struct xdp_sock */
50 	struct sock sk;
51 	struct xsk_queue *rx;
52 	struct net_device *dev;
53 	struct xdp_umem *umem;
54 	struct list_head flush_node;
55 	u16 queue_id;
56 	bool zc;
57 	enum {
58 		XSK_READY = 0,
59 		XSK_BOUND,
60 		XSK_UNBOUND,
61 	} state;
62 	/* Protects multiple processes in the control path */
63 	struct mutex mutex;
64 	struct xsk_queue *tx ____cacheline_aligned_in_smp;
65 	struct list_head list;
66 	/* Mutual exclusion of NAPI TX thread and sendmsg error paths
67 	 * in the SKB destructor callback.
68 	 */
69 	spinlock_t tx_completion_lock;
70 	/* Protects generic receive. */
71 	spinlock_t rx_lock;
72 	u64 rx_dropped;
73 	struct list_head map_list;
74 	/* Protects map_list */
75 	spinlock_t map_list_lock;
76 };
77 
78 #ifdef CONFIG_XDP_SOCKETS
79 
80 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp);
81 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp);
82 void __xsk_map_flush(void);
83 
84 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
85 						     u32 key)
86 {
87 	struct xsk_map *m = container_of(map, struct xsk_map, map);
88 	struct xdp_sock *xs;
89 
90 	if (key >= map->max_entries)
91 		return NULL;
92 
93 	xs = READ_ONCE(m->xsk_map[key]);
94 	return xs;
95 }
96 
97 #else
98 
99 static inline int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
100 {
101 	return -ENOTSUPP;
102 }
103 
104 static inline int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
105 {
106 	return -EOPNOTSUPP;
107 }
108 
109 static inline void __xsk_map_flush(void)
110 {
111 }
112 
113 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
114 						     u32 key)
115 {
116 	return NULL;
117 }
118 
119 #endif /* CONFIG_XDP_SOCKETS */
120 
121 #endif /* _LINUX_XDP_SOCK_H */
122