xref: /linux-6.15/include/uapi/linux/if_xdp.h (revision bbff2f32)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * if_xdp: XDP socket user-space interface
4  * Copyright(c) 2018 Intel Corporation.
5  *
6  * Author(s): Björn Töpel <[email protected]>
7  *	      Magnus Karlsson <[email protected]>
8  */
9 
10 #ifndef _LINUX_IF_XDP_H
11 #define _LINUX_IF_XDP_H
12 
13 #include <linux/types.h>
14 
15 /* Options for the sxdp_flags field */
16 #define XDP_SHARED_UMEM 1
17 
18 struct sockaddr_xdp {
19 	__u16 sxdp_family;
20 	__u16 sxdp_flags;
21 	__u32 sxdp_ifindex;
22 	__u32 sxdp_queue_id;
23 	__u32 sxdp_shared_umem_fd;
24 };
25 
26 struct xdp_ring_offset {
27 	__u64 producer;
28 	__u64 consumer;
29 	__u64 desc;
30 };
31 
32 struct xdp_mmap_offsets {
33 	struct xdp_ring_offset rx;
34 	struct xdp_ring_offset tx;
35 	struct xdp_ring_offset fr; /* Fill */
36 	struct xdp_ring_offset cr; /* Completion */
37 };
38 
39 /* XDP socket options */
40 #define XDP_MMAP_OFFSETS		1
41 #define XDP_RX_RING			2
42 #define XDP_TX_RING			3
43 #define XDP_UMEM_REG			4
44 #define XDP_UMEM_FILL_RING		5
45 #define XDP_UMEM_COMPLETION_RING	6
46 #define XDP_STATISTICS			7
47 
48 struct xdp_umem_reg {
49 	__u64 addr; /* Start of packet data area */
50 	__u64 len; /* Length of packet data area */
51 	__u32 chunk_size;
52 	__u32 headroom;
53 };
54 
55 struct xdp_statistics {
56 	__u64 rx_dropped; /* Dropped for reasons other than invalid desc */
57 	__u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
58 	__u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
59 };
60 
61 /* Pgoff for mmaping the rings */
62 #define XDP_PGOFF_RX_RING			  0
63 #define XDP_PGOFF_TX_RING		 0x80000000
64 #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
65 #define XDP_UMEM_PGOFF_COMPLETION_RING	0x180000000
66 
67 /* Rx/Tx descriptor */
68 struct xdp_desc {
69 	__u64 addr;
70 	__u32 len;
71 	__u32 options;
72 };
73 
74 /* UMEM descriptor is __u64 */
75 
76 #endif /* _LINUX_IF_XDP_H */
77