xref: /linux-6.15/include/uapi/linux/if_xdp.h (revision b3a9e0be)
1dac09149SBjörn Töpel /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2dac09149SBjö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;
20ad75646cSBjörn Töpel 	__u16 sxdp_flags;
21965a9909SMagnus Karlsson 	__u32 sxdp_ifindex;
22965a9909SMagnus Karlsson 	__u32 sxdp_queue_id;
23965a9909SMagnus Karlsson 	__u32 sxdp_shared_umem_fd;
24965a9909SMagnus Karlsson };
25965a9909SMagnus Karlsson 
26*b3a9e0beSBjörn Töpel struct xdp_ring_offset {
27*b3a9e0beSBjörn Töpel 	__u64 producer;
28*b3a9e0beSBjörn Töpel 	__u64 consumer;
29*b3a9e0beSBjörn Töpel 	__u64 desc;
30*b3a9e0beSBjörn Töpel };
31*b3a9e0beSBjörn Töpel 
32*b3a9e0beSBjörn Töpel struct xdp_mmap_offsets {
33*b3a9e0beSBjörn Töpel 	struct xdp_ring_offset rx;
34*b3a9e0beSBjörn Töpel 	struct xdp_ring_offset tx;
35*b3a9e0beSBjörn Töpel 	struct xdp_ring_offset fr; /* Fill */
36*b3a9e0beSBjörn Töpel 	struct xdp_ring_offset cr; /* Completion */
37*b3a9e0beSBjörn Töpel };
38*b3a9e0beSBjörn Töpel 
39c0c77d8fSBjörn Töpel /* XDP socket options */
40*b3a9e0beSBjörn Töpel #define XDP_MMAP_OFFSETS		1
41*b3a9e0beSBjörn Töpel #define XDP_RX_RING			2
42*b3a9e0beSBjörn Töpel #define XDP_TX_RING			3
43*b3a9e0beSBjörn Töpel #define XDP_UMEM_REG			4
44*b3a9e0beSBjörn Töpel #define XDP_UMEM_FILL_RING		5
45*b3a9e0beSBjörn Töpel #define XDP_UMEM_COMPLETION_RING	6
46*b3a9e0beSBjörn Töpel #define XDP_STATISTICS			7
47c0c77d8fSBjörn Töpel 
48c0c77d8fSBjörn Töpel struct xdp_umem_reg {
49c0c77d8fSBjörn Töpel 	__u64 addr; /* Start of packet data area */
50c0c77d8fSBjörn Töpel 	__u64 len; /* Length of packet data area */
51c0c77d8fSBjörn Töpel 	__u32 frame_size; /* Frame size */
52c0c77d8fSBjörn Töpel 	__u32 frame_headroom; /* Frame head room */
53c0c77d8fSBjörn Töpel };
54c0c77d8fSBjörn Töpel 
55af75d9e0SMagnus Karlsson struct xdp_statistics {
56af75d9e0SMagnus Karlsson 	__u64 rx_dropped; /* Dropped for reasons other than invalid desc */
57af75d9e0SMagnus Karlsson 	__u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
58af75d9e0SMagnus Karlsson 	__u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
59af75d9e0SMagnus Karlsson };
60af75d9e0SMagnus Karlsson 
61423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */
62b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING			  0
63f6145903SMagnus Karlsson #define XDP_PGOFF_TX_RING		 0x80000000
64423f3832SMagnus Karlsson #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
65fe230832SMagnus Karlsson #define XDP_UMEM_PGOFF_COMPLETION_RING	0x180000000
66423f3832SMagnus Karlsson 
67*b3a9e0beSBjörn Töpel /* Rx/Tx descriptor */
68b9b6b68eSBjörn Töpel struct xdp_desc {
69b9b6b68eSBjörn Töpel 	__u32 idx;
70b9b6b68eSBjörn Töpel 	__u32 len;
71b9b6b68eSBjörn Töpel 	__u16 offset;
72b9b6b68eSBjörn Töpel 	__u8 flags;
73b9b6b68eSBjörn Töpel 	__u8 padding[5];
74b9b6b68eSBjörn Töpel };
75b9b6b68eSBjörn Töpel 
76*b3a9e0beSBjörn Töpel /* UMEM descriptor is __u32 */
77423f3832SMagnus Karlsson 
78c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */
79