Skip to content

Add WasmFileKeyGenerator for split Wasm symbol files#5853

Open
paolosevMSFT wants to merge 1 commit into
dotnet:mainfrom
paolosevMSFT:SupportWasmSymbolFiles
Open

Add WasmFileKeyGenerator for split Wasm symbol files#5853
paolosevMSFT wants to merge 1 commit into
dotnet:mainfrom
paolosevMSFT:SupportWasmSymbolFiles

Conversation

@paolosevMSFT
Copy link
Copy Markdown

Adds support for indexing WebAssembly modules on symbol servers by introducing a WasmFileKeyGenerator that parses Wasm binaries and extracts the build_id custom section.

This enables uploading and retrieving both halves of split-debug Wasm files. (It follows the same convention as ELF (elf-buildid vs elf-buildid-sym):

  • Stripped Wasm modules => indexed with wasm-buildid prefix
  • Symbol files (containing DWARF .debug_* sections) => indexed with wasm-buildid-sym prefix

Changes:

  • New: WasmFileKeyGenerator class that validates the Wasm header, scans custom sections for build_id, and detects symbol files via .debug_* sections
  • Modified: FileKeyGenerator to include WasmFileKeyGenerator in the auto-detection chain
  • Tests: Added unit tests with synthetic Wasm binaries covering plain modules, symbol files, and files without build IDs

@paolosevMSFT paolosevMSFT requested a review from a team as a code owner May 22, 2026 10:36
Copilot AI review requested due to automatic review settings May 22, 2026 10:36
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

@paolosevMSFT please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds WebAssembly module support to Microsoft.SymbolStore key generation by introducing a WasmFileKeyGenerator that extracts a build_id custom section and distinguishes stripped vs split-debug Wasm files via .debug_* custom sections, enabling symbol-server indexing using wasm-buildid and wasm-buildid-sym prefixes.

Changes:

  • Added WasmFileKeyGenerator to parse Wasm headers/sections, extract build_id, and detect DWARF debug sections.
  • Updated FileKeyGenerator auto-detection chain to include Wasm support.
  • Added unit tests covering Wasm modules, symbol files, and missing build IDs.

Reviewed changes

Copilot reviewed 3 out of 6 changed files in this pull request and generated 3 comments.

File Description
src/tests/Microsoft.SymbolStore.UnitTests/KeyGeneratorTests.cs Adds unit tests for Wasm key generation (module vs symbol file vs missing build_id).
src/Microsoft.SymbolStore/KeyGenerators/WasmFileKeyGenerator.cs Introduces the Wasm key generator and parsing logic for build_id and .debug_* sections.
src/Microsoft.SymbolStore/KeyGenerators/FileKeyGenerator.cs Adds Wasm detection to the generic file key generator chain.
Comments suppressed due to low confidence (1)

src/Microsoft.SymbolStore/KeyGenerators/WasmFileKeyGenerator.cs:184

  • nameStart is assigned but never used here as well; with TreatWarningsAsErrors enabled this breaks the build. Remove the unused local variable.
                    if (sectionId == CustomSectionId)
                    {
                        long nameStart = stream.Position;
                        string name = ReadWasmString(stream);

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +257 to +259
byte[] bytes = new byte[length];
int bytesRead = stream.Read(bytes, 0, (int)length);
if (bytesRead != (int)length)
Comment on lines +105 to +107
long nameStart = stream.Position;
string name = ReadWasmString(stream);
if (name != null && name.StartsWith(".debug_"))
Comment on lines +187 to +191
// The remainder of the section payload is the build ID
int buildIdLength = (int)(sectionEnd - stream.Position);
if (buildIdLength > 0)
{
_buildId = new byte[buildIdLength];
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants