xref: /linux-6.15/include/uapi/linux/if_xdp.h (revision dac09149)
1*dac09149SBjörn Töpel /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*dac09149SBjörn Töpel /*
3c0c77d8fSBjörn Töpel  * if_xdp: XDP socket user-space interface
4c0c77d8fSBjörn Töpel  * Copyright(c) 2018 Intel Corporation.
5c0c77d8fSBjörn Töpel  *
6c0c77d8fSBjörn Töpel  * Author(s): Björn Töpel <[email protected]>
7c0c77d8fSBjörn Töpel  *	      Magnus Karlsson <[email protected]>
8c0c77d8fSBjörn Töpel  */
9c0c77d8fSBjörn Töpel 
10c0c77d8fSBjörn Töpel #ifndef _LINUX_IF_XDP_H
11c0c77d8fSBjörn Töpel #define _LINUX_IF_XDP_H
12c0c77d8fSBjörn Töpel 
13c0c77d8fSBjörn Töpel #include <linux/types.h>
14c0c77d8fSBjörn Töpel 
15965a9909SMagnus Karlsson /* Options for the sxdp_flags field */
16965a9909SMagnus Karlsson #define XDP_SHARED_UMEM 1
17965a9909SMagnus Karlsson 
18965a9909SMagnus Karlsson struct sockaddr_xdp {
19965a9909SMagnus Karlsson 	__u16 sxdp_family;
20965a9909SMagnus Karlsson 	__u32 sxdp_ifindex;
21965a9909SMagnus Karlsson 	__u32 sxdp_queue_id;
22965a9909SMagnus Karlsson 	__u32 sxdp_shared_umem_fd;
23965a9909SMagnus Karlsson 	__u16 sxdp_flags;
24965a9909SMagnus Karlsson };
25965a9909SMagnus Karlsson 
26c0c77d8fSBjörn Töpel /* XDP socket options */
27b9b6b68eSBjörn Töpel #define XDP_RX_RING			1
28f6145903SMagnus Karlsson #define XDP_TX_RING			2
29c0c77d8fSBjörn Töpel #define XDP_UMEM_REG			3
30423f3832SMagnus Karlsson #define XDP_UMEM_FILL_RING		4
31fe230832SMagnus Karlsson #define XDP_UMEM_COMPLETION_RING	5
32af75d9e0SMagnus Karlsson #define XDP_STATISTICS			6
33c0c77d8fSBjörn Töpel 
34c0c77d8fSBjörn Töpel struct xdp_umem_reg {
35c0c77d8fSBjörn Töpel 	__u64 addr; /* Start of packet data area */
36c0c77d8fSBjörn Töpel 	__u64 len; /* Length of packet data area */
37c0c77d8fSBjörn Töpel 	__u32 frame_size; /* Frame size */
38c0c77d8fSBjörn Töpel 	__u32 frame_headroom; /* Frame head room */
39c0c77d8fSBjörn Töpel };
40c0c77d8fSBjörn Töpel 
41af75d9e0SMagnus Karlsson struct xdp_statistics {
42af75d9e0SMagnus Karlsson 	__u64 rx_dropped; /* Dropped for reasons other than invalid desc */
43af75d9e0SMagnus Karlsson 	__u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
44af75d9e0SMagnus Karlsson 	__u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
45af75d9e0SMagnus Karlsson };
46af75d9e0SMagnus Karlsson 
47423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */
48b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING			  0
49f6145903SMagnus Karlsson #define XDP_PGOFF_TX_RING		 0x80000000
50423f3832SMagnus Karlsson #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
51fe230832SMagnus Karlsson #define XDP_UMEM_PGOFF_COMPLETION_RING	0x180000000
52423f3832SMagnus Karlsson 
53b9b6b68eSBjörn Töpel struct xdp_desc {
54b9b6b68eSBjörn Töpel 	__u32 idx;
55b9b6b68eSBjörn Töpel 	__u32 len;
56b9b6b68eSBjörn Töpel 	__u16 offset;
57b9b6b68eSBjörn Töpel 	__u8 flags;
58b9b6b68eSBjörn Töpel 	__u8 padding[5];
59b9b6b68eSBjörn Töpel };
60b9b6b68eSBjörn Töpel 
61423f3832SMagnus Karlsson struct xdp_ring {
62423f3832SMagnus Karlsson 	__u32 producer __attribute__((aligned(64)));
63423f3832SMagnus Karlsson 	__u32 consumer __attribute__((aligned(64)));
64423f3832SMagnus Karlsson };
65423f3832SMagnus Karlsson 
66b9b6b68eSBjörn Töpel /* Used for the RX and TX queues for packets */
67b9b6b68eSBjörn Töpel struct xdp_rxtx_ring {
68b9b6b68eSBjörn Töpel 	struct xdp_ring ptrs;
69b9b6b68eSBjörn Töpel 	struct xdp_desc desc[0] __attribute__((aligned(64)));
70b9b6b68eSBjörn Töpel };
71b9b6b68eSBjörn Töpel 
72423f3832SMagnus Karlsson /* Used for the fill and completion queues for buffers */
73423f3832SMagnus Karlsson struct xdp_umem_ring {
74423f3832SMagnus Karlsson 	struct xdp_ring ptrs;
75423f3832SMagnus Karlsson 	__u32 desc[0] __attribute__((aligned(64)));
76423f3832SMagnus Karlsson };
77423f3832SMagnus Karlsson 
78c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */
79