1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* AF_XDP internal functions
3 * Copyright(c) 2018 Intel Corporation.
6 #ifndef _LINUX_XDP_SOCK_H
7 #define _LINUX_XDP_SOCK_H
9 #include <linux/workqueue.h>
10 #include <linux/if_xdp.h>
11 #include <linux/mutex.h>
12 #include <linux/spinlock.h>
19 /* Masks for xdp_umem_page flags.
20 * The low 12-bits of the addr will be 0 since this is the page address, so we
21 * can use them for flags.
23 #define XSK_NEXT_PG_CONTIG_SHIFT 0
24 #define XSK_NEXT_PG_CONTIG_MASK (1ULL << XSK_NEXT_PG_CONTIG_SHIFT)
26 struct xdp_umem_page {
31 struct xdp_umem_fq_reuse {
37 /* Flags for the umem flags field.
39 * The NEED_WAKEUP flag is 1 due to the reuse of the flags field for public
40 * flags. See inlude/uapi/include/linux/if_xdp.h.
42 #define XDP_UMEM_USES_NEED_WAKEUP (1 << 1)
47 struct xdp_umem_page *pages;
52 struct user_struct *user;
53 unsigned long address;
55 struct work_struct work;
62 struct net_device *dev;
63 struct xdp_umem_fq_reuse *fq_reuse;
65 spinlock_t xsk_list_lock;
66 struct list_head xsk_list;
69 /* Nodes are linked in the struct xdp_sock map_list field, and used to
70 * track which maps a certain socket reside in.
75 struct list_head __percpu *flush_list;
76 spinlock_t lock; /* Synchronize map updates */
77 struct xdp_sock *xsk_map[];
81 struct list_head node;
83 struct xdp_sock **map_entry;
87 /* struct sock must be the first member of struct xdp_sock */
90 struct net_device *dev;
91 struct xdp_umem *umem;
92 struct list_head flush_node;
100 /* Protects multiple processes in the control path */
102 struct xsk_queue *tx ____cacheline_aligned_in_smp;
103 struct list_head list;
104 /* Mutual exclusion of NAPI TX thread and sendmsg error paths
105 * in the SKB destructor callback.
107 spinlock_t tx_completion_lock;
108 /* Protects generic receive. */
111 struct list_head map_list;
112 /* Protects map_list */
113 spinlock_t map_list_lock;
117 #ifdef CONFIG_XDP_SOCKETS
118 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp);
119 bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs);
120 /* Used from netdev driver */
121 bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt);
122 u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr);
123 void xsk_umem_discard_addr(struct xdp_umem *umem);
124 void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries);
125 bool xsk_umem_consume_tx(struct xdp_umem *umem, struct xdp_desc *desc);
126 void xsk_umem_consume_tx_done(struct xdp_umem *umem);
127 struct xdp_umem_fq_reuse *xsk_reuseq_prepare(u32 nentries);
128 struct xdp_umem_fq_reuse *xsk_reuseq_swap(struct xdp_umem *umem,
129 struct xdp_umem_fq_reuse *newq);
130 void xsk_reuseq_free(struct xdp_umem_fq_reuse *rq);
131 struct xdp_umem *xdp_get_umem_from_qid(struct net_device *dev, u16 queue_id);
132 void xsk_set_rx_need_wakeup(struct xdp_umem *umem);
133 void xsk_set_tx_need_wakeup(struct xdp_umem *umem);
134 void xsk_clear_rx_need_wakeup(struct xdp_umem *umem);
135 void xsk_clear_tx_need_wakeup(struct xdp_umem *umem);
136 bool xsk_umem_uses_need_wakeup(struct xdp_umem *umem);
138 void xsk_map_try_sock_delete(struct xsk_map *map, struct xdp_sock *xs,
139 struct xdp_sock **map_entry);
140 int xsk_map_inc(struct xsk_map *map);
141 void xsk_map_put(struct xsk_map *map);
142 int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
143 struct xdp_sock *xs);
144 void __xsk_map_flush(struct bpf_map *map);
146 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
149 struct xsk_map *m = container_of(map, struct xsk_map, map);
152 if (key >= map->max_entries)
155 xs = READ_ONCE(m->xsk_map[key]);
159 static inline u64 xsk_umem_extract_addr(u64 addr)
161 return addr & XSK_UNALIGNED_BUF_ADDR_MASK;
164 static inline u64 xsk_umem_extract_offset(u64 addr)
166 return addr >> XSK_UNALIGNED_BUF_OFFSET_SHIFT;
169 static inline u64 xsk_umem_add_offset_to_addr(u64 addr)
171 return xsk_umem_extract_addr(addr) + xsk_umem_extract_offset(addr);
174 static inline char *xdp_umem_get_data(struct xdp_umem *umem, u64 addr)
176 unsigned long page_addr;
178 addr = xsk_umem_add_offset_to_addr(addr);
179 page_addr = (unsigned long)umem->pages[addr >> PAGE_SHIFT].addr;
181 return (char *)(page_addr & PAGE_MASK) + (addr & ~PAGE_MASK);
184 static inline dma_addr_t xdp_umem_get_dma(struct xdp_umem *umem, u64 addr)
186 addr = xsk_umem_add_offset_to_addr(addr);
188 return umem->pages[addr >> PAGE_SHIFT].dma + (addr & ~PAGE_MASK);
191 /* Reuse-queue aware version of FILL queue helpers */
192 static inline bool xsk_umem_has_addrs_rq(struct xdp_umem *umem, u32 cnt)
194 struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
196 if (rq->length >= cnt)
199 return xsk_umem_has_addrs(umem, cnt - rq->length);
202 static inline u64 *xsk_umem_peek_addr_rq(struct xdp_umem *umem, u64 *addr)
204 struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
207 return xsk_umem_peek_addr(umem, addr);
209 *addr = rq->handles[rq->length - 1];
213 static inline void xsk_umem_discard_addr_rq(struct xdp_umem *umem)
215 struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
218 xsk_umem_discard_addr(umem);
223 static inline void xsk_umem_fq_reuse(struct xdp_umem *umem, u64 addr)
225 struct xdp_umem_fq_reuse *rq = umem->fq_reuse;
227 rq->handles[rq->length++] = addr;
230 /* Handle the offset appropriately depending on aligned or unaligned mode.
231 * For unaligned mode, we store the offset in the upper 16-bits of the address.
232 * For aligned mode, we simply add the offset to the address.
234 static inline u64 xsk_umem_adjust_offset(struct xdp_umem *umem, u64 address,
237 if (umem->flags & XDP_UMEM_UNALIGNED_CHUNK_FLAG)
238 return address + (offset << XSK_UNALIGNED_BUF_OFFSET_SHIFT);
240 return address + offset;
243 static inline int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
248 static inline bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs)
253 static inline bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt)
258 static inline u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr)
263 static inline void xsk_umem_discard_addr(struct xdp_umem *umem)
267 static inline void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries)
271 static inline bool xsk_umem_consume_tx(struct xdp_umem *umem,
272 struct xdp_desc *desc)
277 static inline void xsk_umem_consume_tx_done(struct xdp_umem *umem)
281 static inline struct xdp_umem_fq_reuse *xsk_reuseq_prepare(u32 nentries)
286 static inline struct xdp_umem_fq_reuse *xsk_reuseq_swap(
287 struct xdp_umem *umem,
288 struct xdp_umem_fq_reuse *newq)
292 static inline void xsk_reuseq_free(struct xdp_umem_fq_reuse *rq)
296 static inline struct xdp_umem *xdp_get_umem_from_qid(struct net_device *dev,
302 static inline u64 xsk_umem_extract_addr(u64 addr)
307 static inline u64 xsk_umem_extract_offset(u64 addr)
312 static inline u64 xsk_umem_add_offset_to_addr(u64 addr)
317 static inline char *xdp_umem_get_data(struct xdp_umem *umem, u64 addr)
322 static inline dma_addr_t xdp_umem_get_dma(struct xdp_umem *umem, u64 addr)
327 static inline bool xsk_umem_has_addrs_rq(struct xdp_umem *umem, u32 cnt)
332 static inline u64 *xsk_umem_peek_addr_rq(struct xdp_umem *umem, u64 *addr)
337 static inline void xsk_umem_discard_addr_rq(struct xdp_umem *umem)
341 static inline void xsk_umem_fq_reuse(struct xdp_umem *umem, u64 addr)
345 static inline void xsk_set_rx_need_wakeup(struct xdp_umem *umem)
349 static inline void xsk_set_tx_need_wakeup(struct xdp_umem *umem)
353 static inline void xsk_clear_rx_need_wakeup(struct xdp_umem *umem)
357 static inline void xsk_clear_tx_need_wakeup(struct xdp_umem *umem)
361 static inline bool xsk_umem_uses_need_wakeup(struct xdp_umem *umem)
366 static inline u64 xsk_umem_adjust_offset(struct xdp_umem *umem, u64 handle,
372 static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
378 static inline void __xsk_map_flush(struct bpf_map *map)
382 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
387 #endif /* CONFIG_XDP_SOCKETS */
389 #endif /* _LINUX_XDP_SOCK_H */