History

xsk: new descriptor addressing scheme

Currently, AF_XDP only supports a fixed frame-size memory scheme where each frame is referenced via an index (idx). A user passes the frame index to the kernel, and the kernel acts upon the data. Some NICs, however, do not have a fixed frame-size model, instead they have a model where a memory window is passed to the hardware and multiple frames are filled into that window (referred to as the "type-writer" model). By changing the descriptor format from the current frame index addressing scheme, AF_XDP can in the future be extended to support these kinds of NICs. In the index-based model, an idx refers to a frame of size frame_size. Addressing a frame in the UMEM is done by offseting the UMEM starting address by a global offset, idx * frame_size + offset. Communicating via the fill- and completion-rings are done by means of idx. In this commit, the idx is removed in favor of an address (addr), which is a relative address ranging over the UMEM. To convert an idx-based address to the new addr is simply: addr = idx * frame_size + offset. We also stop referring to the UMEM "frame" as a frame. Instead it is simply called a chunk. To transfer ownership of a chunk to the kernel, the addr of the chunk is passed in the fill-ring. Note, that the kernel will mask addr to make it chunk aligned, so there is no need for userspace to do that. E.g., for a chunk size of 2k, passing an addr of 2048, 2050 or 3000 to the fill-ring will refer to the same chunk. On the completion-ring, the addr will match that of the Tx descriptor, passed to the kernel. Changing the descriptor format to use chunks/addr will allow for future changes to move to a type-writer based model, where multiple frames can reside in one chunk. In this model passing one single chunk into the fill-ring, would potentially result in multiple Rx descriptors. This commit changes the uapi of AF_XDP sockets, and updates the documentation.

Björn Töpel committed 8 years ago

Commit bbff2f31 parent a509a958 files · +123 −129Browse files

Showing the changes to include/uapi/linux (1 of 8 files). Show all

Unified · Split

include/uapi/linux/if_xdp.h+5−7
@@ -48,8 +48,8 @@ struct xdp_mmap_offsets { · 47 unmodified lines
4848 struct xdp_umem_reg {
4949 __u64 addr; /* Start of packet data area */
5050 __u64 len; /* Length of packet data area */
51− __u32 frame_size; /* Frame size */
52− __u32 frame_headroom; /* Frame head room */
51+ __u32 chunk_size;
52+ __u32 headroom;
5353 };
5454
5555 struct xdp_statistics {
@@ -66,13 +66,11 @@ struct xdp_statistics { · 10 unmodified lines
6666
6767 /* Rx/Tx descriptor */
6868 struct xdp_desc {
69− __u32 idx;
69+ __u64 addr;
7070 __u32 len;
71− __u16 offset;
72− __u8 flags;
73− __u8 padding[5];
71+ __u32 options;
7472 };
7573
76−/* UMEM descriptor is __u32 */
74+/* UMEM descriptor is __u64 */
7775
7876 #endif /* _LINUX_IF_XDP_H */