[2/3] Integrate XSK maps into the core XDP datapath by ProjectsByJackHe · Pull Request #6003 · microsoft/msquic

ProjectsByJackHe · 2026-05-18T02:47:11Z

Description

Full E2E demo using tools from this PR : DEMO

Part 2 of the plan: #5982
Fixes #5972

Adds the core msquic datapath integrations for the new API contract defined in #5983

Key design decisions:

If map mode is enabled, then we do not create the WinSock or Epoll or .... datapaths. No more best effort!
Init failures in map mode hard fails the datapath initialization. No silent failures!

Testing

Added datapath unit tests. See the E2E demo.
It's going to be extremely difficult to add automation to exercise what I did in the E2E demo.

Documentation

Will come as part 3 in the plan: #5982

codecov · 2026-05-18T03:39:00Z

Codecov Report

❌ Patch coverage is 60.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.05%. Comparing base (f87bfd3) to head (9716cef).

Files with missing lines	Patch %	Lines
src/core/settings.c	33.33%	2 Missing ⚠️

❌ Your patch check has failed because the patch coverage (60.00%) is below the target coverage (80.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6003      +/-   ##
==========================================
+ Coverage   84.88%   85.05%   +0.16%     
==========================================
  Files          60       60              
  Lines       18797    18802       +5     
==========================================
+ Hits        15956    15992      +36     
+ Misses       2841     2810      -31

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ProjectsByJackHe · 2026-05-19T00:10:48Z

Planning on waiting until #6006 gets resolved to address the next wave of feedback.

mtfriesen · 2026-05-20T19:01:12Z

It's not clear to me why we don't have end-to-end tests exercising everything from providing the XSKMAP before creating a registration through actual XDP data paths flowing? Since we intend to officially support this feature, it is risky for both us and our partners to supply/depend on an API that does not have regression test coverage and a paved pattern to follow.

ProjectsByJackHe · 2026-05-20T19:34:19Z

It's not clear to me why we don't have end-to-end tests exercising everything from providing the XSKMAP before creating a registration through actual XDP data paths flowing? Since we intend to officially support this feature, it is risky for both us and our partners to supply/depend on an API that does not have regression test coverage and a paved pattern to follow.

That's in the works. I took the approach of building up an E2E flow manually first to see the shape of how the datapath integration would look like. There's likely going to be some limitations in the CI environment that prevents some scenarios from being exercised, but I am currently adding coverage for the parts that can be automated now that the skeleton of the general changes is mapped out in the current PR iteration.

mtfriesen · 2026-05-20T20:56:59Z

Let's ensure we add tests with each chunk of work we do. I understand it may be a lot of work to add tests, but the best time to protect the code with automation and review the coverage is when making the change.

tests all working now

ProjectsByJackHe · 2026-05-26T22:02:08Z

Let's ensure we add tests with each chunk of work we do. I understand it may be a lot of work to add tests, but the best time to protect the code with automation and review the coverage is when making the change.

XDP needs to release a new driver version consumable by MsQuic in the CI before I can push my tests.

I have them right now working over a local VM with the latest xdp drivers installed, and find that everything is working.

ProjectsByJackHe · 2026-05-28T23:10:32Z

Either we merge #6034 (or wait until the next XDP release) to add automated coverage, or having a one-off manual dispatch for the tests + manual local VM runs is good enough to give confidence to merge this integration. Let's decide on this first and align timelines. Currently, the map tests are pushed for review, but disabled.

ProjectsByJackHe · 2026-05-28T23:35:09Z

          { config: "Debug", plat: "windows", os: "windows-2022", arch: "x64", tls: "schannel", sanitize: "-SanitizeAddress", build: "-Test", log: "Full.Verbose" },
          { config: "Debug", plat: "windows", os: "windows-2022", arch: "x64", tls: "schannel", xdp: "-UseXdp", sanitize: "-SanitizeAddress", build: "-Test" },
          { config: "Debug", plat: "windows", os: "windows-2022", arch: "x64", tls: "schannel", xdp: "-UseXdp", qtip: "-UseQtip", sanitize: "-SanitizeAddress", build: "-Test" },
+          # { config: "Debug", plat: "windows", os: "windows-2022", arch: "x64", tls: "schannel", xdp: "-UseXdp", xdpmapmode: "-XdpMapMode", sanitize: "-SanitizeAddress", build: "-Test", testfilter: "XdpMapMode*" }, # Disabled until CI has XDP driver with map mode support


Un-comment this when we figure out how to ingest the latest XDP version properly.

guhetier · 2026-05-28T23:52:59Z

+inline
+bool
+QUIC_API
+ListenerAcceptConnectionBasic(


This should not be in a precomp header.

Don't we already have helpers for this? (auto-accept listener?)

guhetier · 2026-05-28T23:54:13Z

    QUIC_STATUS GetLocalAddr(_Out_ QuicAddr &localAddr);
    QUIC_STATUS GetStatistics(_Out_ QUIC_LISTENER_STATISTICS &stats);

+    HQUIC GetListener() const { return QuicListener; }


Extend the class with the helpers you need rather than exposing the handle

guhetier · 2026-05-28T23:59:53Z

+                //
+                // Server port rules.
+                //
+                if (Params.UseCibir) {


This is not the place or file to setup the XDP rule.
This file list tests (and probably already deserved to be split).

Make a new file for rule configuration helpers, and consider invoking your helper at the beginning of the test function rather than hidden in the fixture.

Fixture are good for generic setup that doesn't matter to the test logic, but it makes test hard to understand when it causes important setup to be out of sight.

guhetier · 2026-05-29T00:03:49Z

+    // 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 &&


nit: Style, would likely fit on a line.

guhetier · 2026-05-29T00:07:11Z

 if ($DuoNic) {
    $TestArguments += " -DuoNic"
 }
+if ($XdpMapMode) {


nit: Follow the pattern $useXdp already established above for enabling duonic and xdp
(assuming we do need a map mode here)

guhetier · 2026-05-29T00:09:34Z

+            }
+        }
+    }


no need for these 3 extra contexts.

guhetier · 2026-05-29T00:09:59Z

+    _In_ bool UseQtip
+    )
+{
+    UNREFERENCED_PARAMETER(UseQtip); // QTIP is configured globally by the fixture


If it isn't used, it doesn't need to be a parameter.

guhetier · 2026-05-29T00:12:40Z

+                //
+                // Open a bidirectional stream and send a small ping payload.
+                //
+                auto Stream =


This is the only difference with the handshake test?
Why do we need the two? This one is a strict superset, but also doesn't bring extra validation since once we connection is established, using map or not has no impact over sending stream frames.

guhetier · 2026-05-29T00:18:23Z

+                // and inserts them into the XSKMAPs we provided.
+                //
+                {
+                    MsQuicRegistration TempReg("XdpMapModeInit");


Won't the registration used by the test do that anyway?

guhetier · 2026-05-29T00:44:07Z

            }
-#endif
+#if defined(_WIN32)
+            if (UseXdpMapMode) {


I don't think that relying on the global environment and test parameters is a good approach.

It can work for things that are basically re-running the entire test suite in different conditions like XDP.
But here, this is only for a few specific tests.

This should be part of the fixture for those specific tests (or in a RAII helper called at the start of the test).
Having so much conditional in the test setup cannot scale.

ProjectsByJackHe added 13 commits May 14, 2026 17:46

add tools

0020948

phase 2 looks good so far

9830250

phase 2 improvements

7ba0bf1

better diagnostics

b364f47

phase 3 plumbing...

01df062

phase 3: iter 2

3097b18

bug fixes man

5750131

E2E

bbf64e0

fix comment

c62d7b1

update xdp commit

08ff04e

get rid of tools

b8285dc

get rid of preview features

4546dfe

add unit tests

ba539a7

ProjectsByJackHe requested a review from a team as a code owner May 18, 2026 02:47

ProjectsByJackHe mentioned this pull request May 18, 2026

[2/3] Add CIBIR, XDP, and XSK maps support to the sample tools #5999

Open

CLOG

d15f3a7

guhetier reviewed May 18, 2026

View reviewed changes

fix abi incompat

4fe8094

ProjectsByJackHe added 2 commits May 19, 2026 14:29

address code feedback

47f162d

Merge branch 'main' into jackhe/xdp_map_dp_int_pr_2_core

0b83796

mtfriesen reviewed May 20, 2026

View reviewed changes

Comment thread src/platform/datapath_raw_xdp_win.c Outdated

mtfriesen reviewed May 20, 2026

View reviewed changes

Comment thread src/platform/datapath_raw_xdp_win.c Outdated

ProjectsByJackHe added 3 commits May 20, 2026 14:36

fix dp tests + update logging

f68a1d8

infer xdp enablement if map mode is set

d8fe2d2

set xdpenabled to false explicitly in map mode returns error

96ded75

guhetier requested changes May 21, 2026

View reviewed changes

ProjectsByJackHe added 3 commits May 22, 2026 11:36

fix unit test, address comments

240f0d2

generate clog, fix code pattern

1559660

update comment

892304c

guhetier reviewed May 22, 2026

View reviewed changes

Comment thread src/platform/datapath_xplat.c Outdated

ProjectsByJackHe added 11 commits May 22, 2026 12:57

put map mode flag in rawdatapath

1388f07

rename

c472280

simplify the code

acc113b

fix build

2ae68ba

refactor map into RAW dp

db73b3c

CLOG

4eb0d70

remove bogus test

c9e7b1f

stash changes

c1fa28c

tests all working now

improve tests

3b85f5e

add cibir/qtip matrix

815ff66

add CI to target map mode explicitly

39ce0e6

ProjectsByJackHe added 2 commits May 28, 2026 16:34

comment out map job

3d9d478

Merge branch 'main' into jackhe/xdp_map_dp_int_pr_2_core

9716cef

ProjectsByJackHe commented May 28, 2026

View reviewed changes

guhetier requested changes May 29, 2026

View reviewed changes

Conversation

ProjectsByJackHe commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Documentation

Uh oh!

codecov Bot commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ProjectsByJackHe commented May 19, 2026

Uh oh!

Uh oh!

Uh oh!

mtfriesen commented May 20, 2026

Uh oh!

ProjectsByJackHe commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mtfriesen commented May 20, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ProjectsByJackHe commented May 26, 2026

Uh oh!

ProjectsByJackHe commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ProjectsByJackHe commented May 18, 2026 •

edited

Loading

codecov Bot commented May 18, 2026 •

edited

Loading

ProjectsByJackHe commented May 20, 2026 •

edited

Loading

ProjectsByJackHe commented May 28, 2026 •

edited

Loading