[2/3] Integrate XSK maps into the core XDP datapath

.github/workflows/test.yml

@@ -196,17 +196,17 @@ jobs:
       if: matrix.vec.os == 'WinServerPrerelease'
       shell: pwsh
       timeout-minutes: 120
-      run: scripts/test.ps1 -Config ${{ matrix.vec.config }} -Arch ${{ matrix.vec.arch }} -Tls ${{ matrix.vec.tls }} -GHA -LogProfile ${{ matrix.vec.log || (inputs.log_level || 'Full.Light') }} -GenerateXmlResults ${{ matrix.vec.xdp }} ${{ matrix.vec.qtip }} ${{ inputs.filter && '-Filter' }} ${{ inputs.filter || '' }}
+      run: scripts/test.ps1 -Config ${{ matrix.vec.config }} -Arch ${{ matrix.vec.arch }} -Tls ${{ matrix.vec.tls }} -GHA -LogProfile ${{ matrix.vec.log || (inputs.log_level || 'Full.Light') }} -GenerateXmlResults ${{ matrix.vec.xdp }} ${{ matrix.vec.qtip }} ${{ matrix.vec.xdpmapmode }} ${{ (matrix.vec.testfilter || inputs.filter) && '-Filter' || '' }} ${{ matrix.vec.testfilter || inputs.filter || '' }}
     - name: Test
       if: matrix.vec.os != 'WinServerPrerelease'
       shell: pwsh
       timeout-minutes: 120
-      run: scripts/test.ps1 -Config ${{ matrix.vec.config }} -Arch ${{ matrix.vec.arch }} -Tls ${{ matrix.vec.tls }} -OsRunner ${{ matrix.vec.os }} -GHA -LogProfile ${{ matrix.vec.log || (inputs.log_level || 'Full.Light') }} -GenerateXmlResults ${{ matrix.vec.xdp }} ${{ matrix.vec.qtip }} ${{ inputs.filter && '-Filter' }} ${{ inputs.filter || '' }}
+      run: scripts/test.ps1 -Config ${{ matrix.vec.config }} -Arch ${{ matrix.vec.arch }} -Tls ${{ matrix.vec.tls }} -OsRunner ${{ matrix.vec.os }} -GHA -LogProfile ${{ matrix.vec.log || (inputs.log_level || 'Full.Light') }} -GenerateXmlResults ${{ matrix.vec.xdp }} ${{ matrix.vec.qtip }} ${{ matrix.vec.xdpmapmode }} ${{ (matrix.vec.testfilter || inputs.filter) && '-Filter' || '' }} ${{ matrix.vec.testfilter || inputs.filter || '' }}
     - name: Upload on Failure or Cancellation
       uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
       if: failure() || cancelled()
       with:
-        name: BVT-${{ matrix.vec.config }}-${{ matrix.vec.plat }}-${{ matrix.vec.os }}-${{ matrix.vec.arch }}-${{ matrix.vec.tls }}${{ matrix.vec.xdp }}${{ matrix.vec.iouring }}${{ matrix.vec.qtip }}${{ matrix.vec.systemcrypto }}${{ matrix.vec.sanitize }}
+        name: BVT-${{ matrix.vec.config }}-${{ matrix.vec.plat }}-${{ matrix.vec.os }}-${{ matrix.vec.arch }}-${{ matrix.vec.tls }}${{ matrix.vec.xdp }}${{ matrix.vec.iouring }}${{ matrix.vec.qtip }}${{ matrix.vec.xdpmapmode }}${{ matrix.vec.systemcrypto }}${{ matrix.vec.sanitize }}
         path: artifacts
 
   bvt-kernel:

scripts/run-gtest.ps1

@@ -62,6 +62,9 @@ as necessary.
 .PARAMETER DuoNic
     Uses DuoNic instead of loopback.
 
+.PARAMETER XdpMapMode
+    Uses XDP map mode with DuoNic.
+
 #>
 
 param (
@@ -133,6 +136,9 @@ param (
     [Parameter(Mandatory = $false)]
     [switch]$DuoNic = $false,
 
+    [Parameter(Mandatory = $false)]
+    [switch]$XdpMapMode = $false,
+
     [Parameter(Mandatory = $false)]
     [string]$OsRunner = "",
 
@@ -403,6 +409,9 @@ function Start-TestCase([String]$Name) {
     if ($DuoNic) {
         $Arguments += " --duoNic"
     }
+    if ($XdpMapMode) {
+        $Arguments += " --xdpMapMode"
+    }
     if ($UseQtip) {
         $Arguments += " --useQTIP"
     }
@@ -450,6 +459,9 @@ function Start-AllTestCases {
     if ($DuoNic) {
         $Arguments += " --duoNic"
     }
+    if ($XdpMapMode) {
+        $Arguments += " --xdpMapMode"
+    }
     if ($UseQtip) {
         $Arguments += " --useQTIP"
     }

scripts/test.ps1

@@ -70,6 +70,9 @@ This script runs the MsQuic tests.
 .Parameter DuoNic
     Uses DuoNic instead of loopback (DuoNic must already be installed via 'prepare-machine.ps1 -InstallDuoNic').
 
+.Parameter XdpMapMode
+    Uses XDP map mode with DuoNic (Windows user-mode only, requires XDP + DuoNic).
+
 .Parameter NumIterations
     Number of times to run this particular command. Catches tricky edge cases due to random nature of networks.
 
@@ -178,6 +181,9 @@ param (
     [Parameter(Mandatory = $false)]
     [switch]$DuoNic = $false,
 
+    [Parameter(Mandatory = $false)]
+    [switch]$XdpMapMode = $false,
+
     [Parameter(Mandatory = $false)]
     [switch]$UseXdp = $false,
 
@@ -235,6 +241,11 @@ if ($UseXdp) {
     $DuoNic = $true
 }
 
+if ($XdpMapMode) {
+    # Map mode implies DuoNic
+    $DuoNic = $true
+}
+
 # Root directory of the project.
 $RootDir = Split-Path $PSScriptRoot -Parent
 
@@ -298,6 +309,9 @@ $TestArguments =  "-IsolationMode $IsolationMode -PfxPath $PfxFile"
 if ($DuoNic) {
     $TestArguments += " -DuoNic"
 }
+if ($XdpMapMode) {
+    $TestArguments += " -XdpMapMode"
+}
 if ($Kernel) {
     $TestArguments += " -Kernel $KernelPath"
 }

scripts/update-sidecar.ps1

@@ -33,10 +33,15 @@ if (Test-Path $OutputDir) {
     }
 }
 
+$TmpOutputDir = Join-Path $RootDir "build" "tmp"
+
+# Clean stale generated files so removed/renamed sources don't leave orphans
+if (Test-Path $TmpOutputDir) {
+    Remove-Item $TmpOutputDir -Recurse -Force
+}
+
 $Sidecar = Join-Path $SrcDir "manifest" "clog.sidecar"
 $ConfigFile = Join-Path $SrcDir "manifest" "msquic.clog_config"
-
-$TmpOutputDir = Join-Path $RootDir "build" "tmp"
 $ClogDir = Join-Path $RootDir "build" "clog"
 
 # Create directories

src/core/library.c

@@ -915,6 +915,8 @@ QuicLibraryLazyInitialize(
 
     CXPLAT_DATAPATH_INIT_CONFIG InitConfig = {0};
     InitConfig.EnableDscpOnRecv = MsQuicLib.EnableDscpOnRecv;
+    InitConfig.XdpMapConfigs = MsQuicLib.XdpMapConfigs;
+    InitConfig.XdpMapConfigCount = MsQuicLib.XdpMapConfigCount;
 
     Status =
         CxPlatDataPathInitialize(

src/core/settings.c

@@ -712,6 +712,18 @@ QuicSettingApply(
         Destination->IsSet.ReliableResetEnabled = TRUE;
     }
 
+    //
+    // If XDP map mode is active (XdpMapConfigCount > 0), XDP is implicitly
+    // enabled for all sockets. Reject an explicit XdpEnabled = FALSE since
+    // it contradicts map mode — there is no OS datapath to fall back to.
+    //
+    if (Source->IsSet.XdpEnabled && !Source->XdpEnabled && MsQuicLib.XdpMapConfigCount > 0) {
+        QuicTraceLogError(
+            SettingXdpDisabledInMapMode,
+            "[ lib] Error: XdpEnabled cannot be set to FALSE when XDP map mode is active.");
+        return FALSE;
+    }
+
     if (Source->IsSet.XdpEnabled && (!Destination->IsSet.XdpEnabled || OverWrite)) {
         Destination->XdpEnabled = Source->XdpEnabled;
         Destination->IsSet.XdpEnabled = TRUE;

src/generated/linux/datapath_raw.c.clog.h

@@ -14,13 +14,35 @@
 #include "datapath_raw.c.clog.h.lttng.h"
 #endif
 #include <lttng/tracepoint-event.h>
+#ifndef _clog_MACRO_QuicTraceLogVerbose
+#define _clog_MACRO_QuicTraceLogVerbose  1
+#define QuicTraceLogVerbose(a, ...) _clog_CAT(_clog_ARGN_SELECTOR(__VA_ARGS__), _clog_CAT(_,a(#a, __VA_ARGS__)))
+#endif
 #ifndef _clog_MACRO_QuicTraceEvent
 #define _clog_MACRO_QuicTraceEvent  1
 #define QuicTraceEvent(a, ...) _clog_CAT(_clog_ARGN_SELECTOR(__VA_ARGS__), _clog_CAT(_,a(#a, __VA_ARGS__)))
 #endif
 #ifdef __cplusplus
 extern "C" {
 #endif
+/*----------------------------------------------------------
+// Decoder Ring for DatapathRawMapInsertFail
+// [  dp] XDP map mode: failed to insert XSK sockets into map, status:%d
+// QuicTraceLogVerbose(
+                DatapathRawMapInsertFail,
+                "[  dp] XDP map mode: failed to insert XSK sockets into map, status:%d",
+                Status);
+// arg2 = arg2 = Status = arg2
+----------------------------------------------------------*/
+#ifndef _clog_3_ARGS_TRACE_DatapathRawMapInsertFail
+#define _clog_3_ARGS_TRACE_DatapathRawMapInsertFail(uniqueId, encoded_arg_string, arg2)\
+tracepoint(CLOG_DATAPATH_RAW_C, DatapathRawMapInsertFail , arg2);\
+
+#endif
+
+
+
+
 /*----------------------------------------------------------
 // Decoder Ring for AllocFailure
 // Allocation of '%s' failed. (%llu bytes)

src/generated/linux/datapath_raw.c.clog.h.lttng.h

@@ -1,6 +1,25 @@
 
 
 
+/*----------------------------------------------------------
+// Decoder Ring for DatapathRawMapInsertFail
+// [  dp] XDP map mode: failed to insert XSK sockets into map, status:%d
+// QuicTraceLogVerbose(
+                DatapathRawMapInsertFail,
+                "[  dp] XDP map mode: failed to insert XSK sockets into map, status:%d",
+                Status);
+// arg2 = arg2 = Status = arg2
+----------------------------------------------------------*/
+TRACEPOINT_EVENT(CLOG_DATAPATH_RAW_C, DatapathRawMapInsertFail,
+    TP_ARGS(
+        int, arg2), 
+    TP_FIELDS(
+        ctf_integer(int, arg2, arg2)
+    )
+)
+
+
+
 /*----------------------------------------------------------
 // Decoder Ring for AllocFailure
 // Allocation of '%s' failed. (%llu bytes)

src/generated/linux/datapath_raw_xdp_win.c.clog.h

@@ -332,6 +332,54 @@ tracepoint(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpPartitionShutdownComplete , arg2);\
 
 
 
+/*----------------------------------------------------------
+// Decoder Ring for XdpMapInsertFailed
+// [ixdp][%p] XdpMapInsert failed for IfIndex=%u, QueueId=%u, XskMap=%p, RxXsk=%p
+// QuicTraceLogVerbose(
+                XdpMapInsertFailed,
+                "[ixdp][%p] XdpMapInsert failed for IfIndex=%u, QueueId=%u, XskMap=%p, RxXsk=%p",
+                Interface,
+                Interface->IfIndex,
+                j,
+                XskMap,
+                Queue->RxXsk);
+// arg2 = arg2 = Interface = arg2
+// arg3 = arg3 = Interface->IfIndex = arg3
+// arg4 = arg4 = j = arg4
+// arg5 = arg5 = XskMap = arg5
+// arg6 = arg6 = Queue->RxXsk = arg6
+----------------------------------------------------------*/
+#ifndef _clog_7_ARGS_TRACE_XdpMapInsertFailed
+#define _clog_7_ARGS_TRACE_XdpMapInsertFailed(uniqueId, encoded_arg_string, arg2, arg3, arg4, arg5, arg6)\
+tracepoint(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpMapInsertFailed , arg2, arg3, arg4, arg5, arg6);\
+
+#endif
+
+
+
+
+/*----------------------------------------------------------
+// Decoder Ring for XdpMapModeConfigured
+// [ixdp][%p] Map mode configured for IfIndex=%u (MapHandle=%p)
+// QuicTraceLogVerbose(
+                    XdpMapModeConfigured,
+                    "[ixdp][%p] Map mode configured for IfIndex=%u (MapHandle=%p)",
+                    Interface,
+                    Interface->IfIndex,
+                    XskMap);
+// arg2 = arg2 = Interface = arg2
+// arg3 = arg3 = Interface->IfIndex = arg3
+// arg4 = arg4 = XskMap = arg4
+----------------------------------------------------------*/
+#ifndef _clog_5_ARGS_TRACE_XdpMapModeConfigured
+#define _clog_5_ARGS_TRACE_XdpMapModeConfigured(uniqueId, encoded_arg_string, arg2, arg3, arg4)\
+tracepoint(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpMapModeConfigured , arg2, arg3, arg4);\
+
+#endif
+
+
+
+
 /*----------------------------------------------------------
 // Decoder Ring for LibraryErrorStatus
 // [ lib] ERROR, %u, %s.

src/generated/linux/datapath_raw_xdp_win.c.clog.h.lttng.h

@@ -336,6 +336,68 @@ TRACEPOINT_EVENT(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpPartitionShutdownComplete,
 
 
 
+/*----------------------------------------------------------
+// Decoder Ring for XdpMapInsertFailed
+// [ixdp][%p] XdpMapInsert failed for IfIndex=%u, QueueId=%u, XskMap=%p, RxXsk=%p
+// QuicTraceLogVerbose(
+                XdpMapInsertFailed,
+                "[ixdp][%p] XdpMapInsert failed for IfIndex=%u, QueueId=%u, XskMap=%p, RxXsk=%p",
+                Interface,
+                Interface->IfIndex,
+                j,
+                XskMap,
+                Queue->RxXsk);
+// arg2 = arg2 = Interface = arg2
+// arg3 = arg3 = Interface->IfIndex = arg3
+// arg4 = arg4 = j = arg4
+// arg5 = arg5 = XskMap = arg5
+// arg6 = arg6 = Queue->RxXsk = arg6
+----------------------------------------------------------*/
+TRACEPOINT_EVENT(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpMapInsertFailed,
+    TP_ARGS(
+        const void *, arg2,
+        unsigned int, arg3,
+        unsigned int, arg4,
+        const void *, arg5,
+        const void *, arg6), 
+    TP_FIELDS(
+        ctf_integer_hex(uint64_t, arg2, (uint64_t)arg2)
+        ctf_integer(unsigned int, arg3, arg3)
+        ctf_integer(unsigned int, arg4, arg4)
+        ctf_integer_hex(uint64_t, arg5, (uint64_t)arg5)
+        ctf_integer_hex(uint64_t, arg6, (uint64_t)arg6)
+    )
+)
+
+
+
+/*----------------------------------------------------------
+// Decoder Ring for XdpMapModeConfigured
+// [ixdp][%p] Map mode configured for IfIndex=%u (MapHandle=%p)
+// QuicTraceLogVerbose(
+                    XdpMapModeConfigured,
+                    "[ixdp][%p] Map mode configured for IfIndex=%u (MapHandle=%p)",
+                    Interface,
+                    Interface->IfIndex,
+                    XskMap);
+// arg2 = arg2 = Interface = arg2
+// arg3 = arg3 = Interface->IfIndex = arg3
+// arg4 = arg4 = XskMap = arg4
+----------------------------------------------------------*/
+TRACEPOINT_EVENT(CLOG_DATAPATH_RAW_XDP_WIN_C, XdpMapModeConfigured,
+    TP_ARGS(
+        const void *, arg2,
+        unsigned int, arg3,
+        const void *, arg4), 
+    TP_FIELDS(
+        ctf_integer_hex(uint64_t, arg2, (uint64_t)arg2)
+        ctf_integer(unsigned int, arg3, arg3)
+        ctf_integer_hex(uint64_t, arg4, (uint64_t)arg4)
+    )
+)
+
+
+
 /*----------------------------------------------------------
 // Decoder Ring for LibraryErrorStatus
 // [ lib] ERROR, %u, %s.