xref: /linux/include/uapi/linux/if_xdp.h (revision 965a990984432cd01a9eb3514c64d86f56704295)
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 <bjorn.topel@intel.com>
16c0c77d8fSBjörn Töpel  *	      Magnus Karlsson <magnus.karlsson@intel.com>
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 
24*965a9909SMagnus Karlsson /* Options for the sxdp_flags field */
25*965a9909SMagnus Karlsson #define XDP_SHARED_UMEM 1
26*965a9909SMagnus Karlsson 
27*965a9909SMagnus Karlsson struct sockaddr_xdp {
28*965a9909SMagnus Karlsson 	__u16 sxdp_family;
29*965a9909SMagnus Karlsson 	__u32 sxdp_ifindex;
30*965a9909SMagnus Karlsson 	__u32 sxdp_queue_id;
31*965a9909SMagnus Karlsson 	__u32 sxdp_shared_umem_fd;
32*965a9909SMagnus Karlsson 	__u16 sxdp_flags;
33*965a9909SMagnus Karlsson };
34*965a9909SMagnus Karlsson 
35c0c77d8fSBjörn Töpel /* XDP socket options */
36b9b6b68eSBjörn Töpel #define XDP_RX_RING			1
37c0c77d8fSBjörn Töpel #define XDP_UMEM_REG			3
38423f3832SMagnus Karlsson #define XDP_UMEM_FILL_RING		4
39c0c77d8fSBjörn Töpel 
40c0c77d8fSBjörn Töpel struct xdp_umem_reg {
41c0c77d8fSBjörn Töpel 	__u64 addr; /* Start of packet data area */
42c0c77d8fSBjörn Töpel 	__u64 len; /* Length of packet data area */
43c0c77d8fSBjörn Töpel 	__u32 frame_size; /* Frame size */
44c0c77d8fSBjörn Töpel 	__u32 frame_headroom; /* Frame head room */
45c0c77d8fSBjörn Töpel };
46c0c77d8fSBjörn Töpel 
47423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */
48b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING			  0
49423f3832SMagnus Karlsson #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
50423f3832SMagnus Karlsson 
51b9b6b68eSBjörn Töpel struct xdp_desc {
52b9b6b68eSBjörn Töpel 	__u32 idx;
53b9b6b68eSBjörn Töpel 	__u32 len;
54b9b6b68eSBjörn Töpel 	__u16 offset;
55b9b6b68eSBjörn Töpel 	__u8 flags;
56b9b6b68eSBjörn Töpel 	__u8 padding[5];
57b9b6b68eSBjörn Töpel };
58b9b6b68eSBjörn Töpel 
59423f3832SMagnus Karlsson struct xdp_ring {
60423f3832SMagnus Karlsson 	__u32 producer __attribute__((aligned(64)));
61423f3832SMagnus Karlsson 	__u32 consumer __attribute__((aligned(64)));
62423f3832SMagnus Karlsson };
63423f3832SMagnus Karlsson 
64b9b6b68eSBjörn Töpel /* Used for the RX and TX queues for packets */
65b9b6b68eSBjörn Töpel struct xdp_rxtx_ring {
66b9b6b68eSBjörn Töpel 	struct xdp_ring ptrs;
67b9b6b68eSBjörn Töpel 	struct xdp_desc desc[0] __attribute__((aligned(64)));
68b9b6b68eSBjörn Töpel };
69b9b6b68eSBjörn Töpel 
70423f3832SMagnus Karlsson /* Used for the fill and completion queues for buffers */
71423f3832SMagnus Karlsson struct xdp_umem_ring {
72423f3832SMagnus Karlsson 	struct xdp_ring ptrs;
73423f3832SMagnus Karlsson 	__u32 desc[0] __attribute__((aligned(64)));
74423f3832SMagnus Karlsson };
75423f3832SMagnus Karlsson 
76c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */
77