XDP - revision history

Dank at 02:43, 29 June 2023

2023-06-29T02:43:22Z

← Older revision		Revision as of 02:43, 29 June 2023
Line 231:		Line 231:
	* [https://lwn.net/Articles/750845/ Accelerating networking with AF_XDP], LWN 2018-04-09		* [https://lwn.net/Articles/750845/ Accelerating networking with AF_XDP], LWN 2018-04-09
	* [https://blog.packagecloud.io/monitoring-tuning-linux-networking-stack-receiving-data/ Monitoring and tuning the Linux Networking Stack: Receiving Data], PackageCloud 2016-06-21		* [https://blog.packagecloud.io/monitoring-tuning-linux-networking-stack-receiving-data/ Monitoring and tuning the Linux Networking Stack: Receiving Data], PackageCloud 2016-06-21

			[[CATEGORY: Networking]]

Dank: /* Driver details */

2023-06-13T10:59:45Z

Driver details

← Older revision		Revision as of 10:59, 13 June 2023
Line 194:		Line 194:
	\|-		\|-
	\| ixgbe (Intel) \|\| Y \|\| Y \|\| Native \|\| Y \|\| Y		\| ixgbe (Intel) \|\| Y \|\| Y \|\| Native \|\| Y \|\| Y
			\|-
			\| cxgb3 (Chelsio) \|\| N \|\| N \|\| N \|\| Y \|\| N
	\|-		\|-
	\| mvneta (Marvell) \|\| ? \|\| Y \|\| ? \|\| Y \|\| ?		\| mvneta (Marvell) \|\| ? \|\| Y \|\| ? \|\| Y \|\| ?

Dank: /* Using XDP */

2023-05-27T20:03:37Z

Using XDP

← Older revision		Revision as of 20:03, 27 May 2023
Line 28:		Line 28:
	* <tt>XDP_TX</tt>: emit the packet back out the interface on which it was received		* <tt>XDP_TX</tt>: emit the packet back out the interface on which it was received
	* <tt>XDP_REDIRECT</tt>: send the packet to another NIC or an <tt>AF_XDP</tt> socket		* <tt>XDP_REDIRECT</tt>: send the packet to another NIC or an <tt>AF_XDP</tt> socket
	Think of <tt>XDP_ABORTED</tt> as returning -1 from the eBPF program; it's meant to indicate an internal error. Theoretically, the packet could continue through the stack (as it would have if no XDP program had been running), but XDP uses "fail-close" semantics. Edits to the packet are carried through all XDP paths. Note that everything up through and including <tt>XDP_TX</tt> can be represented in two bits; this will be important later when passing flags to bpf helpers.		Think of <tt>XDP_ABORTED</tt> as returning -1 from the eBPF program; it's meant to indicate an internal error. Theoretically, the packet could continue through the stack (as it would have if no XDP program had been running, or <tt>XDP_PASS</tt> was returned), but XDP uses "fail-close" semantics. Edits to the packet are carried through all XDP paths. Note that everything up through and including <tt>XDP_TX</tt> can be represented in two bits; this will be important later when passing flags to bpf helpers.

	<tt>xdp-loader status</tt> will list NICs and show details regarding any attached XDP programs. <tt>ethtool -S</tt> shows XDP statistics. <tt>ip link</tt> will also show a summary of devices' XDP chains. <tt>xdp_dispatcher</tt> is a metaprogram loaded by <tt>xdp-loader</tt> to support chaining multiple XDP programs; it will be present whenever programs were loaded using <tt>xdp-loader</tt>.		<tt>xdp-loader status</tt> will list NICs and show details regarding any attached XDP programs. <tt>ethtool -S</tt> shows XDP statistics. <tt>ip link</tt> will also show a summary of devices' XDP chains. <tt>xdp_dispatcher</tt> is a metaprogram loaded by <tt>xdp-loader</tt> to support chaining multiple XDP programs; it will be present whenever programs were loaded using <tt>xdp-loader</tt>.

Dank: /* AF_XDP */

2023-05-02T11:26:56Z

AF_XDP

← Older revision		Revision as of 11:26, 2 May 2023
Line 76:		Line 76:
	XSKs come in two varieties: <tt>XDP_SKB</tt> and <tt>XDP_DRV</tt>. <tt>XDP_DRV</tt> corresponds to Native Mode/Offload Mode XDP, and is faster than the generic <tt>XDP_SKB</tt>, but requires driver support. True zero-copy requires the use of <tt>XDP_DRV</tt> XSKs together with <tt>XDP_MODE_HW</tt> or <tt>XDP_MODE_NATIVE</tt> XDP programs.		XSKs come in two varieties: <tt>XDP_SKB</tt> and <tt>XDP_DRV</tt>. <tt>XDP_DRV</tt> corresponds to Native Mode/Offload Mode XDP, and is faster than the generic <tt>XDP_SKB</tt>, but requires driver support. True zero-copy requires the use of <tt>XDP_DRV</tt> XSKs together with <tt>XDP_MODE_HW</tt> or <tt>XDP_MODE_NATIVE</tt> XDP programs.

	How is <tt>AF_XDP</tt> different from [[Packet sockets\|<tt>AF_PACKET</tt>]] (especially when the latter is backed with kernel-shared ringbuffers via <tt>PACKET_RX_RING</tt>)? Without mapped ringbuffers, packet sockets will always take an skbuff allocation (see diagram to the right) into which they will clone the packet, whereas XDP can avoid this outside of Generic Mode. Even with mapped ringbuffers, there is a ~~copy--the~~ packet socket fundamentally <i>clones</i> frames. XDP furthermore allows more direct control over parallelism, and can be tied into the NIC's hardware Receiver-Side Scaling. XDP allows RX and TX descriptors to point into the same memory pool, potentially avoiding copies. Note that the [https://lwn.net/Articles/737947/ AF_PACKETv4] proposal also used distinct descriptor rings.		How is <tt>AF_XDP</tt> different from [[Packet sockets\|<tt>AF_PACKET</tt>]] (especially when the latter is backed with kernel-shared ringbuffers via <tt>PACKET_RX_RING</tt>)? Without mapped ringbuffers, packet sockets will always take an skbuff allocation (see diagram to the right) into which they will clone the packet, whereas XDP can avoid this outside of Generic Mode. Even with mapped ringbuffers, there is a copy—the packet socket fundamentally <i>clones</i> frames. XDP furthermore allows more direct control over parallelism, and can be tied into the NIC's hardware Receiver-Side Scaling. XDP allows RX and TX descriptors to point into the same memory pool, potentially avoiding copies. Note that the [https://lwn.net/Articles/737947/ AF_PACKETv4] proposal also used distinct descriptor rings.

	Each XSK has either one or both of two RX and TX descriptor ringbuffers, along with a data ringbuffer (the UMEM) into which all descriptor rings point. The descriptor rings are registered with the kernel using <tt>XDP_RX_RING</tt>/<tt>XDP_UMEM_FILL_RING</tt> and <tt>XDP_TX_RING</tt>/<tt>XDP_UMEM_COMPLETION_RING</tt> with <tt>setsockopt(2)</tt>. UMEM is a virtually contiguous area divided into equally-sized chunks (chunk size is up to the user; it should usually be the MTU plus XDP overhead), and registered with the <tt>XDP_UMEM_REG</tt> sockopt. Packets will be written to distinct chunks. <tt>bind(2)</tt> then associates the XSK with a particular device and queueid, at which point traffic begins to flow. It is expected that chunks will be a multiple of the page size, but this does not appear to be necessary—in particular, success has been had doubling up two 2KB chunks on a 1500B MTU, despite amd64's minimum 4KB page size.		Each XSK has either one or both of two RX and TX descriptor ringbuffers, along with a data ringbuffer (the UMEM) into which all descriptor rings point. The descriptor rings are registered with the kernel using <tt>XDP_RX_RING</tt>/<tt>XDP_UMEM_FILL_RING</tt> and <tt>XDP_TX_RING</tt>/<tt>XDP_UMEM_COMPLETION_RING</tt> with <tt>setsockopt(2)</tt>. UMEM is a virtually contiguous area divided into equally-sized chunks (chunk size is up to the user; it should usually be the MTU plus XDP overhead), and registered with the <tt>XDP_UMEM_REG</tt> sockopt. Packets will be written to distinct chunks. <tt>bind(2)</tt> then associates the XSK with a particular device and queueid, at which point traffic begins to flow. It is expected that chunks will be a multiple of the page size, but this does not appear to be necessary—in particular, success has been had doubling up two 2KB chunks on a 1500B MTU, despite amd64's minimum 4KB page size.

Dank: /* Sizing the maps */ RX is a consumer ring for userspace

2023-04-30T12:01:49Z

Sizing the maps: RX is a consumer ring for userspace

← Older revision		Revision as of 12:01, 30 April 2023
Line 168:		Line 168:
	XDP requires that all the map entry counts be powers of two. The UMEM may not be more than 2**32 times the smallest page size; as this would be 16TiB on a 4KiB page, you probably needn't worry about that requirement.		XDP requires that all the map entry counts be powers of two. The UMEM may not be more than 2**32 times the smallest page size; as this would be 16TiB on a 4KiB page, you probably needn't worry about that requirement.

	The constants <tt>XSK_RING_CONS__DEFAULT_NUM_DESCS</tt> and <tt>XSK_RING_PROD__DEFAULT_NUM_DESCS</tt> (henceforth <tt>CONSDEF</tt> and <tt>PRODDEF</tt> respectively) are provided by libxdp; let's assume our consumer and producer rings respectively to have these as minimum sizes (if you'd like to hold more than ~~PRODDEF~~, just shift it however many positions to the left). If we have ''n'' threads, each with their own RX ring of at least <tt>~~PRODDEF~~</tt> entries, that implies backing by at least ''n * ~~PRODDEF~~'' UMEM entries (assuming equal distribution among threads). AFAIK there is no way to fill a packet and dispatch it to an RX ring later, so if our RX rings are full, we can't use any more than at most one extra fill descriptor. So our fill ring ought hold at least ''n * ~~PRODDEF~~'' descriptors, but the UMEM needn't support more than ''n * ~~PRODDEF~~ + 1'', and can reasonably get away with ''n * ~~PRODDEF~~''.		The constants <tt>XSK_RING_CONS__DEFAULT_NUM_DESCS</tt> and <tt>XSK_RING_PROD__DEFAULT_NUM_DESCS</tt> (henceforth <tt>CONSDEF</tt> and <tt>PRODDEF</tt> respectively) are provided by libxdp; let's assume our consumer and producer rings respectively to have these as minimum sizes (if you'd like to hold more than CONSDEF, just shift it however many positions to the left). If we have ''n'' threads, each with their own RX ring of at least <tt>CONSDEF</tt> entries, that implies backing by at least ''n * CONSDEF'' UMEM entries (assuming equal distribution among threads). AFAIK there is no way to fill a packet and dispatch it to an RX ring later, so if our RX rings are full, we can't use any more than at most one extra fill descriptor. So our fill ring ought hold at least ''n * CONSDEF'' descriptors, but the UMEM needn't support more than ''n * CONSDEF + 1'', and can reasonably get away with ''n * CONSDEF''.

	Only one of these maps (the UMEM) is mapped in userspace. The descriptor rings are all mapped in the kernel, based off the size we provide. We probably want to use [[Pages\|huge pages]] to back the UMEM (they're not currently available for the descriptor rings), and if so, it must be a multiple of some huge page size. Assuming amd64, 1GB is probably a bit much (256Ki 4KiB chunks), so that means a multiple of 2MiB (''is 1GB really too much? With an admittedly sky-high 800ms round trip time, 1GB is exactly one bandwidth-delay-product for 10Gbps...''). To minimize total allocation, then minimize waste, while satisfying our other constraints:		Only one of these maps (the UMEM) is mapped in userspace. The descriptor rings are all mapped in the kernel, based off the size we provide. We probably want to use [[Pages\|huge pages]] to back the UMEM (they're not currently available for the descriptor rings), and if so, it must be a multiple of some huge page size. Assuming amd64, 1GB is probably a bit much (256Ki 4KiB chunks), so that means a multiple of 2MiB (''is 1GB really too much? With an admittedly sky-high 800ms round trip time, 1GB is exactly one bandwidth-delay-product for 10Gbps...''). To minimize total allocation, then minimize waste, while satisfying our other constraints:

	* ''UMEM_min'' is ''n * ~~PRODDEF~~ * chunksize'' bytes		* ''UMEM_min'' is ''n * CONSDEF * chunksize'' bytes
	* ''UMEM_max'' is the minimum multiple of the desired huge page size such that ''UMEM_max >= UMEM_min''		* ''UMEM_max'' is the minimum multiple of the desired huge page size such that ''UMEM_max >= UMEM_min''
	* Set ''descs = ~~PRODDEF~~''		* Set ''descs = CONSDEF''
	* While ''n * (descs << 1) * chunksize <= UMEM_max'', ''descs <<= 1''		* While ''n * (descs << 1) * chunksize <= UMEM_max'', ''descs <<= 1''

Dank: /* Sizing the maps */

2023-04-30T00:17:03Z

Sizing the maps

← Older revision		Revision as of 00:17, 30 April 2023
Line 179:		Line 179:
	''UMEM_max'' is the size of your UMEM in bytes, with support for ''n * descs'' chunks of ''chunksize'' bytes each. ''UMEM_max - n * descs * chunksize'' number of bytes wasted in this allocation. Each of 'n' RX rings supports ''descs'' descriptors (the actual size of the descriptor rings is somewhat larger than this would imply, and set by the kernel). The fill ring supports ''n * descs'' descriptors.		''UMEM_max'' is the size of your UMEM in bytes, with support for ''n * descs'' chunks of ''chunksize'' bytes each. ''UMEM_max - n * descs * chunksize'' number of bytes wasted in this allocation. Each of 'n' RX rings supports ''descs'' descriptors (the actual size of the descriptor rings is somewhat larger than this would imply, and set by the kernel). The fill ring supports ''n * descs'' descriptors.

	Fill ring descriptors are currently eight bytes, while RX ring descriptors are sixteen. On a 64-byte cacheline, it thus might make sense to fetch packets four at a time per thread, and perhaps prefetch subsequent packet data.		Fill ring descriptors are currently eight bytes, while RX ring descriptors are sixteen. On a 64-byte cacheline, it thus might make sense to fetch packets four at a time per thread, and perhaps prefetch subsequent packet data. Of course, this wouldn't be useful if your packet data is already resident in cache thanks to e.g. [[DDIO]].

	==Driver details==		==Driver details==

Dank: /* See Also */

2023-04-30T00:15:08Z

Dank: /* Rings and ring descriptors */

2023-04-30T00:13:16Z

Rings and ring descriptors

@@ Line 161: / Line 161: @@
 The producer and consumer variables tend to be placed 64 bytes apart, presumably so that their cachelines do not interact. See the kernel's [https://www.kernel.org/doc/html/latest/core-api/circular-buffers.html circular buffer documentation]. XDP works in producer/consumer mode, not "overwrite" mode, and thus loses newer events when the ring is full. The producer writes to the index specified by <tt>producer</tt>, then increments it. The consumer reads from the index specified by <tt>consumer</tt>, then increments it. The consumer may not read when <tt>producer == consumer</tt>, as the buffer is empty. The producer may not write when <tt>succ(producer) == consumer</tt>, as the buffer is full. Both wrap to 0 when incremented beyond the end of the ring. Userspace is a producer for the FILL and TX rings, and a consumer for the COMPLETION and RX rings.
-The population of the buffer is <tt>CIRC_CNT(prod, cons, size)</tt> aka <tt>((prod) - (cons)) & ((size)-1)</tt>. The space in the buffer is <tt>CIRC_SPACE(prod, cons, size)</tt> aka <tt>CIRC_CNT(cons, prod + 1, size)</tt>. Note that kernel
+The population of the buffer is <tt>CIRC_CNT(prod, cons, size)</tt> aka <tt>((prod) - (cons)) & ((size)-1)</tt>. The space in the buffer is <tt>CIRC_SPACE(prod, cons, size)</tt> aka <tt>CIRC_CNT(cons, prod + 1, size)</tt>.
 ==Driver details==

Dank: /* The UMEM */

2023-04-29T23:26:09Z

The UMEM

← Older revision		Revision as of 23:26, 29 April 2023
Line 96:		Line 96:
	<tt>XDP_UMEM_REG</tt> wants a <tt>struct xdp_umem_reg</tt>, containing <tt>addr</tt> (a pointer to the map as <tt>uintptr_t</tt>), <tt>len</tt> (length of the map in bytes), <tt>chunk_size</tt> and <tt>headroom</tt>. regarding <tt>chunk_size</tt>, if you're getting <tt>EINVAL</tt>, consult the kernel's <tt>xdp_umem_reg()</tt> (from 6.1.7):		<tt>XDP_UMEM_REG</tt> wants a <tt>struct xdp_umem_reg</tt>, containing <tt>addr</tt> (a pointer to the map as <tt>uintptr_t</tt>), <tt>len</tt> (length of the map in bytes), <tt>chunk_size</tt> and <tt>headroom</tt>. regarding <tt>chunk_size</tt>, if you're getting <tt>EINVAL</tt>, consult the kernel's <tt>xdp_umem_reg()</tt> (from 6.1.7):
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	if (chunk_size < XDP_UMEM_MIN_CHUNK_SIZE \|\| chunk_size > PAGE_SIZE) {		if (chunk_size < XDP_UMEM_MIN_CHUNK_SIZE \|\| chunk_size > PAGE_SIZE) {
	/* Strictly speaking we could support this, if:		/* Strictly speaking we could support this, if:
	* - huge pages, or*		* - huge pages, or
	* - using an IOMMU, or		* - using an IOMMU, or
	* - making sure the memory area is consecutive		* - making sure the memory area is consecutive
	* but for now, we simply say "computer says no".		* but for now, we simply say "computer says no".
	*/		*/
	return -EINVAL;		return -EINVAL;
	}		}

	if (mr->flags & ~XDP_UMEM_UNALIGNED_CHUNK_FLAG)		if (mr->flags & ~XDP_UMEM_UNALIGNED_CHUNK_FLAG)
	return -EINVAL;		return -EINVAL;

	if (!unaligned_chunks && !is_power_of_2(chunk_size))		if (!unaligned_chunks && !is_power_of_2(chunk_size))
	return -EINVAL;		return -EINVAL;

	if (!PAGE_ALIGNED(addr)) {		if (!PAGE_ALIGNED(addr)) {
	/* Memory area has to be page size aligned. For		/* Memory area has to be page size aligned. For
	* simplicity, this might change.		* simplicity, this might change.
	*/		*/
	return -EINVAL;		return -EINVAL;
	}		}

	if ((addr + size) < addr)		if ((addr + size) < addr)
	return -EINVAL;		return -EINVAL;

	npgs = div_u64_rem(size, PAGE_SIZE, &npgs_rem);		npgs = div_u64_rem(size, PAGE_SIZE, &npgs_rem);
	if (npgs_rem)		if (npgs_rem)
	npgs++;		npgs++;
	if (npgs > U32_MAX)		if (npgs > U32_MAX)
	return -EINVAL;		return -EINVAL;

	chunks = (unsigned int)div_u64_rem(size, chunk_size, &chunks_rem);		chunks = (unsigned int)div_u64_rem(size, chunk_size, &chunks_rem);
	if (chunks == 0)		if (chunks == 0)
	return -EINVAL;		return -EINVAL;

	if (!unaligned_chunks && chunks_rem)		if (!unaligned_chunks && chunks_rem)
	return -EINVAL;		return -EINVAL;

	if (headroom >= chunk_size - XDP_PACKET_HEADROOM)		if (headroom >= chunk_size - XDP_PACKET_HEADROOM)
	return -EINVAL;		return -EINVAL;
	</syntaxhighlight>		</syntaxhighlight>

	===Rings and ring descriptors===		===Rings and ring descriptors===
	The RX and TX descriptor rings are arrays of <tt>struct xdp_desc</tt>, a 16-byte structure:		The RX and TX descriptor rings are arrays of <tt>struct xdp_desc</tt>, a 16-byte structure:

Dank: /* Using XDP */

2023-04-22T12:11:27Z

Using XDP

← Older revision		Revision as of 12:11, 22 April 2023
Line 32:		Line 32:
	<tt>xdp-loader status</tt> will list NICs and show details regarding any attached XDP programs. <tt>ethtool -S</tt> shows XDP statistics. <tt>ip link</tt> will also show a summary of devices' XDP chains. <tt>xdp_dispatcher</tt> is a metaprogram loaded by <tt>xdp-loader</tt> to support chaining multiple XDP programs; it will be present whenever programs were loaded using <tt>xdp-loader</tt>.		<tt>xdp-loader status</tt> will list NICs and show details regarding any attached XDP programs. <tt>ethtool -S</tt> shows XDP statistics. <tt>ip link</tt> will also show a summary of devices' XDP chains. <tt>xdp_dispatcher</tt> is a metaprogram loaded by <tt>xdp-loader</tt> to support chaining multiple XDP programs; it will be present whenever programs were loaded using <tt>xdp-loader</tt>.

	Note that XDP runs prior to the packet socket copies which drive <tt>tcpdump</tt>, and thus packets dropped or redirected in XDP will not show up there. It's better to use <tt>xdpdump</tt> when interacting with XDP programs; this also shows the XDP decision made for each packet. Similarly, packets hit XDP before being evaluated by [[nftables]], and thus represent a means of firewall bypass. Note also that locally-generated self-directed packets do not appear to traverse XDP.		Note that XDP runs prior to the packet socket copies which drive <tt>tcpdump</tt>, and thus packets dropped or redirected in XDP will not show up there. It's better to use <tt>xdpdump</tt> when interacting with XDP programs; this also shows the XDP decision made for each packet. Similarly, packets hit XDP before being evaluated by [[nftables]], and thus represent a means of firewall bypass. Note also that locally-generated self-directed packets do not appear to traverse XDP (update: they do, just they always traverse the loopback device).

	===Writing XDP programs===		===Writing XDP programs===

← Older revision		Revision as of 00:15, 30 April 2023
Line 222:		Line 222:
	* [[Io_uring\|iouring]]		* [[Io_uring\|iouring]]
	* [[100GbE]]		* [[100GbE]]
			* "[[Extended_disquisitions_pertaining_to_eXpress_data_paths_(XDP)\|eXtended Disquisitions Pertaining to eXpress Data Paths]]", a [[Dankblog\|DANKBLOG]] post from 2023-04-20

	==External links==		==External links==