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 */ 16173d3adbSBjörn Töpel #define XDP_SHARED_UMEM (1 << 0) 17173d3adbSBjörn Töpel #define XDP_COPY (1 << 1) /* Force copy-mode */ 18173d3adbSBjörn Töpel #define XDP_ZEROCOPY (1 << 2) /* Force zero-copy mode */ 19965a9909SMagnus Karlsson 20965a9909SMagnus Karlsson struct sockaddr_xdp { 21965a9909SMagnus Karlsson __u16 sxdp_family; 22ad75646cSBjörn Töpel __u16 sxdp_flags; 23965a9909SMagnus Karlsson __u32 sxdp_ifindex; 24965a9909SMagnus Karlsson __u32 sxdp_queue_id; 25965a9909SMagnus Karlsson __u32 sxdp_shared_umem_fd; 26965a9909SMagnus Karlsson }; 27965a9909SMagnus Karlsson 28b3a9e0beSBjörn Töpel struct xdp_ring_offset { 29b3a9e0beSBjörn Töpel __u64 producer; 30b3a9e0beSBjörn Töpel __u64 consumer; 31b3a9e0beSBjörn Töpel __u64 desc; 32b3a9e0beSBjörn Töpel }; 33b3a9e0beSBjörn Töpel 34b3a9e0beSBjörn Töpel struct xdp_mmap_offsets { 35b3a9e0beSBjörn Töpel struct xdp_ring_offset rx; 36b3a9e0beSBjörn Töpel struct xdp_ring_offset tx; 37b3a9e0beSBjörn Töpel struct xdp_ring_offset fr; /* Fill */ 38b3a9e0beSBjörn Töpel struct xdp_ring_offset cr; /* Completion */ 39b3a9e0beSBjörn Töpel }; 40b3a9e0beSBjörn Töpel 41c0c77d8fSBjörn Töpel /* XDP socket options */ 42b3a9e0beSBjörn Töpel #define XDP_MMAP_OFFSETS 1 43b3a9e0beSBjörn Töpel #define XDP_RX_RING 2 44b3a9e0beSBjörn Töpel #define XDP_TX_RING 3 45b3a9e0beSBjörn Töpel #define XDP_UMEM_REG 4 46b3a9e0beSBjörn Töpel #define XDP_UMEM_FILL_RING 5 47b3a9e0beSBjörn Töpel #define XDP_UMEM_COMPLETION_RING 6 48b3a9e0beSBjörn Töpel #define XDP_STATISTICS 7 49*2640d3c8SMaxim Mikityanskiy #define XDP_OPTIONS 8 50c0c77d8fSBjörn Töpel 51c0c77d8fSBjörn Töpel struct xdp_umem_reg { 52c0c77d8fSBjörn Töpel __u64 addr; /* Start of packet data area */ 53c0c77d8fSBjörn Töpel __u64 len; /* Length of packet data area */ 54bbff2f32SBjörn Töpel __u32 chunk_size; 55bbff2f32SBjörn Töpel __u32 headroom; 56c0c77d8fSBjörn Töpel }; 57c0c77d8fSBjörn Töpel 58af75d9e0SMagnus Karlsson struct xdp_statistics { 59af75d9e0SMagnus Karlsson __u64 rx_dropped; /* Dropped for reasons other than invalid desc */ 60af75d9e0SMagnus Karlsson __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */ 61af75d9e0SMagnus Karlsson __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */ 62af75d9e0SMagnus Karlsson }; 63af75d9e0SMagnus Karlsson 64*2640d3c8SMaxim Mikityanskiy struct xdp_options { 65*2640d3c8SMaxim Mikityanskiy __u32 flags; 66*2640d3c8SMaxim Mikityanskiy }; 67*2640d3c8SMaxim Mikityanskiy 68*2640d3c8SMaxim Mikityanskiy /* Flags for the flags field of struct xdp_options */ 69*2640d3c8SMaxim Mikityanskiy #define XDP_OPTIONS_ZEROCOPY (1 << 0) 70*2640d3c8SMaxim Mikityanskiy 71423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */ 72b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING 0 73f6145903SMagnus Karlsson #define XDP_PGOFF_TX_RING 0x80000000 74a5a16e43SGeert Uytterhoeven #define XDP_UMEM_PGOFF_FILL_RING 0x100000000ULL 75a5a16e43SGeert Uytterhoeven #define XDP_UMEM_PGOFF_COMPLETION_RING 0x180000000ULL 76423f3832SMagnus Karlsson 77b3a9e0beSBjörn Töpel /* Rx/Tx descriptor */ 78b9b6b68eSBjörn Töpel struct xdp_desc { 79bbff2f32SBjörn Töpel __u64 addr; 80b9b6b68eSBjörn Töpel __u32 len; 81bbff2f32SBjörn Töpel __u32 options; 82b9b6b68eSBjörn Töpel }; 83b9b6b68eSBjörn Töpel 84bbff2f32SBjörn Töpel /* UMEM descriptor is __u64 */ 85423f3832SMagnus Karlsson 86c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */ 87