xref: /linux-6.15/include/uapi/linux/if_xdp.h (revision f6145903)
1c0c77d8fSBjörn Töpel /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note
2c0c77d8fSBjö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  * This program is free software; you can redistribute it and/or modify it
7c0c77d8fSBjörn Töpel  * under the terms and conditions of the GNU General Public License,
8c0c77d8fSBjörn Töpel  * version 2, as published by the Free Software Foundation.
9c0c77d8fSBjörn Töpel  *
10c0c77d8fSBjörn Töpel  * This program is distributed in the hope it will be useful, but WITHOUT
11c0c77d8fSBjörn Töpel  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12c0c77d8fSBjörn Töpel  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13c0c77d8fSBjörn Töpel  * more details.
14c0c77d8fSBjörn Töpel  *
15c0c77d8fSBjörn Töpel  * Author(s): Björn Töpel <[email protected]>
16c0c77d8fSBjörn Töpel  *	      Magnus Karlsson <[email protected]>
17c0c77d8fSBjörn Töpel  */
18c0c77d8fSBjörn Töpel 
19c0c77d8fSBjörn Töpel #ifndef _LINUX_IF_XDP_H
20c0c77d8fSBjörn Töpel #define _LINUX_IF_XDP_H
21c0c77d8fSBjörn Töpel 
22c0c77d8fSBjörn Töpel #include <linux/types.h>
23c0c77d8fSBjörn Töpel 
24965a9909SMagnus Karlsson /* Options for the sxdp_flags field */
25965a9909SMagnus Karlsson #define XDP_SHARED_UMEM 1
26965a9909SMagnus Karlsson 
27965a9909SMagnus Karlsson struct sockaddr_xdp {
28965a9909SMagnus Karlsson 	__u16 sxdp_family;
29965a9909SMagnus Karlsson 	__u32 sxdp_ifindex;
30965a9909SMagnus Karlsson 	__u32 sxdp_queue_id;
31965a9909SMagnus Karlsson 	__u32 sxdp_shared_umem_fd;
32965a9909SMagnus Karlsson 	__u16 sxdp_flags;
33965a9909SMagnus Karlsson };
34965a9909SMagnus Karlsson 
35c0c77d8fSBjörn Töpel /* XDP socket options */
36b9b6b68eSBjörn Töpel #define XDP_RX_RING			1
37*f6145903SMagnus Karlsson #define XDP_TX_RING			2
38c0c77d8fSBjörn Töpel #define XDP_UMEM_REG			3
39423f3832SMagnus Karlsson #define XDP_UMEM_FILL_RING		4
40fe230832SMagnus Karlsson #define XDP_UMEM_COMPLETION_RING	5
41c0c77d8fSBjörn Töpel 
42c0c77d8fSBjörn Töpel struct xdp_umem_reg {
43c0c77d8fSBjörn Töpel 	__u64 addr; /* Start of packet data area */
44c0c77d8fSBjörn Töpel 	__u64 len; /* Length of packet data area */
45c0c77d8fSBjörn Töpel 	__u32 frame_size; /* Frame size */
46c0c77d8fSBjörn Töpel 	__u32 frame_headroom; /* Frame head room */
47c0c77d8fSBjörn Töpel };
48c0c77d8fSBjörn Töpel 
49423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */
50b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING			  0
51*f6145903SMagnus Karlsson #define XDP_PGOFF_TX_RING		 0x80000000
52423f3832SMagnus Karlsson #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
53fe230832SMagnus Karlsson #define XDP_UMEM_PGOFF_COMPLETION_RING	0x180000000
54423f3832SMagnus Karlsson 
55b9b6b68eSBjörn Töpel struct xdp_desc {
56b9b6b68eSBjörn Töpel 	__u32 idx;
57b9b6b68eSBjörn Töpel 	__u32 len;
58b9b6b68eSBjörn Töpel 	__u16 offset;
59b9b6b68eSBjörn Töpel 	__u8 flags;
60b9b6b68eSBjörn Töpel 	__u8 padding[5];
61b9b6b68eSBjörn Töpel };
62b9b6b68eSBjörn Töpel 
63423f3832SMagnus Karlsson struct xdp_ring {
64423f3832SMagnus Karlsson 	__u32 producer __attribute__((aligned(64)));
65423f3832SMagnus Karlsson 	__u32 consumer __attribute__((aligned(64)));
66423f3832SMagnus Karlsson };
67423f3832SMagnus Karlsson 
68b9b6b68eSBjörn Töpel /* Used for the RX and TX queues for packets */
69b9b6b68eSBjörn Töpel struct xdp_rxtx_ring {
70b9b6b68eSBjörn Töpel 	struct xdp_ring ptrs;
71b9b6b68eSBjörn Töpel 	struct xdp_desc desc[0] __attribute__((aligned(64)));
72b9b6b68eSBjörn Töpel };
73b9b6b68eSBjörn Töpel 
74423f3832SMagnus Karlsson /* Used for the fill and completion queues for buffers */
75423f3832SMagnus Karlsson struct xdp_umem_ring {
76423f3832SMagnus Karlsson 	struct xdp_ring ptrs;
77423f3832SMagnus Karlsson 	__u32 desc[0] __attribute__((aligned(64)));
78423f3832SMagnus Karlsson };
79423f3832SMagnus Karlsson 
80c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */
81