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 <bjorn.topel@intel.com> 7c0c77d8fSBjörn Töpel * Magnus Karlsson <magnus.karlsson@intel.com> 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 */ 1977cd0d7bSMagnus Karlsson /* If this option is set, the driver might go sleep and in that case 2077cd0d7bSMagnus Karlsson * the XDP_RING_NEED_WAKEUP flag in the fill and/or Tx rings will be 2177cd0d7bSMagnus Karlsson * set. If it is set, the application need to explicitly wake up the 2277cd0d7bSMagnus Karlsson * driver with a poll() (Rx and Tx) or sendto() (Tx only). If you are 2377cd0d7bSMagnus Karlsson * running the driver and the application on the same core, you should 2477cd0d7bSMagnus Karlsson * use this option so that the kernel will yield to the user space 2577cd0d7bSMagnus Karlsson * application. 2677cd0d7bSMagnus Karlsson */ 2777cd0d7bSMagnus Karlsson #define XDP_USE_NEED_WAKEUP (1 << 3) 2881470b5cSTirthendu Sarkar /* By setting this option, userspace application indicates that it can 2981470b5cSTirthendu Sarkar * handle multiple descriptors per packet thus enabling AF_XDP to split 3081470b5cSTirthendu Sarkar * multi-buffer XDP frames into multiple Rx descriptors. Without this set 3181470b5cSTirthendu Sarkar * such frames will be dropped. 3281470b5cSTirthendu Sarkar */ 3381470b5cSTirthendu Sarkar #define XDP_USE_SG (1 << 4) 34965a9909SMagnus Karlsson 35c05cd364SKevin Laatz /* Flags for xsk_umem_config flags */ 36c05cd364SKevin Laatz #define XDP_UMEM_UNALIGNED_CHUNK_FLAG (1 << 0) 37*11614723SStanislav Fomichev 38*11614723SStanislav Fomichev /* Force checksum calculation in software. Can be used for testing or 39*11614723SStanislav Fomichev * working around potential HW issues. This option causes performance 40*11614723SStanislav Fomichev * degradation and only works in XDP_COPY mode. 41*11614723SStanislav Fomichev */ 42*11614723SStanislav Fomichev #define XDP_UMEM_TX_SW_CSUM (1 << 1) 43c05cd364SKevin Laatz 44965a9909SMagnus Karlsson struct sockaddr_xdp { 45965a9909SMagnus Karlsson __u16 sxdp_family; 46ad75646cSBjörn Töpel __u16 sxdp_flags; 47965a9909SMagnus Karlsson __u32 sxdp_ifindex; 48965a9909SMagnus Karlsson __u32 sxdp_queue_id; 49965a9909SMagnus Karlsson __u32 sxdp_shared_umem_fd; 50965a9909SMagnus Karlsson }; 51965a9909SMagnus Karlsson 5277cd0d7bSMagnus Karlsson /* XDP_RING flags */ 5377cd0d7bSMagnus Karlsson #define XDP_RING_NEED_WAKEUP (1 << 0) 5477cd0d7bSMagnus Karlsson 55b3a9e0beSBjörn Töpel struct xdp_ring_offset { 56b3a9e0beSBjörn Töpel __u64 producer; 57b3a9e0beSBjörn Töpel __u64 consumer; 58b3a9e0beSBjörn Töpel __u64 desc; 5977cd0d7bSMagnus Karlsson __u64 flags; 60b3a9e0beSBjörn Töpel }; 61b3a9e0beSBjörn Töpel 62b3a9e0beSBjörn Töpel struct xdp_mmap_offsets { 63b3a9e0beSBjörn Töpel struct xdp_ring_offset rx; 64b3a9e0beSBjörn Töpel struct xdp_ring_offset tx; 65b3a9e0beSBjörn Töpel struct xdp_ring_offset fr; /* Fill */ 66b3a9e0beSBjörn Töpel struct xdp_ring_offset cr; /* Completion */ 67b3a9e0beSBjörn Töpel }; 68b3a9e0beSBjörn Töpel 69c0c77d8fSBjörn Töpel /* XDP socket options */ 70b3a9e0beSBjörn Töpel #define XDP_MMAP_OFFSETS 1 71b3a9e0beSBjörn Töpel #define XDP_RX_RING 2 72b3a9e0beSBjörn Töpel #define XDP_TX_RING 3 73b3a9e0beSBjörn Töpel #define XDP_UMEM_REG 4 74b3a9e0beSBjörn Töpel #define XDP_UMEM_FILL_RING 5 75b3a9e0beSBjörn Töpel #define XDP_UMEM_COMPLETION_RING 6 76b3a9e0beSBjörn Töpel #define XDP_STATISTICS 7 772640d3c8SMaxim Mikityanskiy #define XDP_OPTIONS 8 78c0c77d8fSBjörn Töpel 79c0c77d8fSBjörn Töpel struct xdp_umem_reg { 80c0c77d8fSBjörn Töpel __u64 addr; /* Start of packet data area */ 81c0c77d8fSBjörn Töpel __u64 len; /* Length of packet data area */ 82bbff2f32SBjörn Töpel __u32 chunk_size; 83bbff2f32SBjörn Töpel __u32 headroom; 84c05cd364SKevin Laatz __u32 flags; 85341ac980SStanislav Fomichev __u32 tx_metadata_len; 86c0c77d8fSBjörn Töpel }; 87c0c77d8fSBjörn Töpel 88af75d9e0SMagnus Karlsson struct xdp_statistics { 898aa5a335SCiara Loftus __u64 rx_dropped; /* Dropped for other reasons */ 90af75d9e0SMagnus Karlsson __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */ 91af75d9e0SMagnus Karlsson __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */ 928aa5a335SCiara Loftus __u64 rx_ring_full; /* Dropped due to rx ring being full */ 938aa5a335SCiara Loftus __u64 rx_fill_ring_empty_descs; /* Failed to retrieve item from fill ring */ 948aa5a335SCiara Loftus __u64 tx_ring_empty_descs; /* Failed to retrieve item from tx ring */ 95af75d9e0SMagnus Karlsson }; 96af75d9e0SMagnus Karlsson 972640d3c8SMaxim Mikityanskiy struct xdp_options { 982640d3c8SMaxim Mikityanskiy __u32 flags; 992640d3c8SMaxim Mikityanskiy }; 1002640d3c8SMaxim Mikityanskiy 1012640d3c8SMaxim Mikityanskiy /* Flags for the flags field of struct xdp_options */ 1022640d3c8SMaxim Mikityanskiy #define XDP_OPTIONS_ZEROCOPY (1 << 0) 1032640d3c8SMaxim Mikityanskiy 104423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */ 105b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING 0 106f6145903SMagnus Karlsson #define XDP_PGOFF_TX_RING 0x80000000 107a5a16e43SGeert Uytterhoeven #define XDP_UMEM_PGOFF_FILL_RING 0x100000000ULL 108a5a16e43SGeert Uytterhoeven #define XDP_UMEM_PGOFF_COMPLETION_RING 0x180000000ULL 109423f3832SMagnus Karlsson 110c05cd364SKevin Laatz /* Masks for unaligned chunks mode */ 111c05cd364SKevin Laatz #define XSK_UNALIGNED_BUF_OFFSET_SHIFT 48 112c05cd364SKevin Laatz #define XSK_UNALIGNED_BUF_ADDR_MASK \ 113c05cd364SKevin Laatz ((1ULL << XSK_UNALIGNED_BUF_OFFSET_SHIFT) - 1) 114c05cd364SKevin Laatz 11548eb03ddSStanislav Fomichev /* Request transmit timestamp. Upon completion, put it into tx_timestamp 11648eb03ddSStanislav Fomichev * field of struct xsk_tx_metadata. 11748eb03ddSStanislav Fomichev */ 11848eb03ddSStanislav Fomichev #define XDP_TXMD_FLAGS_TIMESTAMP (1 << 0) 11948eb03ddSStanislav Fomichev 12048eb03ddSStanislav Fomichev /* Request transmit checksum offload. Checksum start position and offset 12148eb03ddSStanislav Fomichev * are communicated via csum_start and csum_offset fields of struct 12248eb03ddSStanislav Fomichev * xsk_tx_metadata. 12348eb03ddSStanislav Fomichev */ 12448eb03ddSStanislav Fomichev #define XDP_TXMD_FLAGS_CHECKSUM (1 << 1) 12548eb03ddSStanislav Fomichev 12648eb03ddSStanislav Fomichev /* AF_XDP offloads request. 'request' union member is consumed by the driver 12748eb03ddSStanislav Fomichev * when the packet is being transmitted. 'completion' union member is 12848eb03ddSStanislav Fomichev * filled by the driver when the transmit completion arrives. 12948eb03ddSStanislav Fomichev */ 13048eb03ddSStanislav Fomichev struct xsk_tx_metadata { 13148eb03ddSStanislav Fomichev __u64 flags; 13248eb03ddSStanislav Fomichev 13348eb03ddSStanislav Fomichev union { 13448eb03ddSStanislav Fomichev struct { 13548eb03ddSStanislav Fomichev /* XDP_TXMD_FLAGS_CHECKSUM */ 13648eb03ddSStanislav Fomichev 13748eb03ddSStanislav Fomichev /* Offset from desc->addr where checksumming should start. */ 13848eb03ddSStanislav Fomichev __u16 csum_start; 13948eb03ddSStanislav Fomichev /* Offset from csum_start where checksum should be stored. */ 14048eb03ddSStanislav Fomichev __u16 csum_offset; 14148eb03ddSStanislav Fomichev } request; 14248eb03ddSStanislav Fomichev 14348eb03ddSStanislav Fomichev struct { 14448eb03ddSStanislav Fomichev /* XDP_TXMD_FLAGS_TIMESTAMP */ 14548eb03ddSStanislav Fomichev __u64 tx_timestamp; 14648eb03ddSStanislav Fomichev } completion; 14748eb03ddSStanislav Fomichev }; 14848eb03ddSStanislav Fomichev }; 14948eb03ddSStanislav Fomichev 150b3a9e0beSBjörn Töpel /* Rx/Tx descriptor */ 151b9b6b68eSBjörn Töpel struct xdp_desc { 152bbff2f32SBjörn Töpel __u64 addr; 153b9b6b68eSBjörn Töpel __u32 len; 154bbff2f32SBjörn Töpel __u32 options; 155b9b6b68eSBjörn Töpel }; 156b9b6b68eSBjörn Töpel 157bbff2f32SBjörn Töpel /* UMEM descriptor is __u64 */ 158423f3832SMagnus Karlsson 15963a64a56STirthendu Sarkar /* Flag indicating that the packet continues with the buffer pointed out by the 16063a64a56STirthendu Sarkar * next frame in the ring. The end of the packet is signalled by setting this 16163a64a56STirthendu Sarkar * bit to zero. For single buffer packets, every descriptor has 'options' set 16263a64a56STirthendu Sarkar * to 0 and this maintains backward compatibility. 16363a64a56STirthendu Sarkar */ 16463a64a56STirthendu Sarkar #define XDP_PKT_CONTD (1 << 0) 16563a64a56STirthendu Sarkar 16648eb03ddSStanislav Fomichev /* TX packet carries valid metadata. */ 16748eb03ddSStanislav Fomichev #define XDP_TX_METADATA (1 << 1) 16848eb03ddSStanislav Fomichev 169c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */ 170