Skip to content

[pull] main from emscripten-core:main #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 16, 2025
Merged

Conversation

pull[bot]
Copy link

@pull pull bot commented Jun 16, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Add support for source-based code coverage by integrating Compiler-RT coverage mapping infrastructure and tests, update test harness and browser tests, and record these changes in the ChangeLog.

New Features:

  • Support source-based coverage mapping via -fprofile-instr-generate and -fcoverage-mapping
  • Integrate llvm-profdata and llvm-cov tools into Emscripten for merging and showing coverage
  • Add core test test_fcoverage_mapping to validate coverage mapping output

Enhancements:

  • Register .mjs MIME type for ES modules in the test server
  • Enhance assert_out_queue_empty to include detailed responses on failure
  • Update WebGL browser test to use WebGL 2 by adding -sMIN_WEBGL_VERSION=2

Build:

  • Extend libcompiler_rt build configuration to include coverage and profiling sources and flags
  • Expose LLVM_PROFDATA and LLVM_COV tool paths for coverage tests

Documentation:

  • Document coverage mapping support in ChangeLog.md

Tests:

  • Add and wire up a new coverage mapping test in test_core.py

juj and others added 5 commits June 16, 2025 21:33
GL_UNPACK_ROW_LENGTH is a WebGL2/GLES3 API that is not present in WebGL
1.

Chrome seems to be lazy and allow it in WebGL 1 as well, but Firefox is
strict and this test fails if not run against WebGL 2.
Main introduction is porting `llvm-project/compiler_rt/lib/profile`
`into system/lib/compiler_rt/lib/profile`

Related
#13072
llvm/llvm-project#111332

No modifications were required for what was ported. llvm-cov worked fine
for me with simple project.

* `-g` is required to produce a properly instrumented binary `error:
failed to load coverage: 'my.wasm': no coverage data found`
@pull pull bot added the ⤵️ pull label Jun 16, 2025
Copy link

gitnotebooks bot commented Jun 16, 2025

Review these changes at https://app.gitnotebooks.com/Stars1233/emscripten/pull/104

@pull pull bot merged commit e1692b4 into Stars1233:main Jun 16, 2025
Copy link

gitstream-cm bot commented Jun 16, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 250/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

sourcery-ai bot commented Jun 16, 2025

Reviewer's Guide

This PR adds full support for LLVM’s source-based code coverage by integrating compiler-rt’s coverage mapping runtime into Emscripten, updates build flags and shared tools to generate and merge coverage data, and applies targeted fixes to tests and browser behaviors.

Class diagram for new and updated code coverage runtime types

classDiagram
    class ValueProfRecord {
        +uint32_t Kind
        +uint32_t NumValueSites
        +uint8_t SiteCountArray[1]
        // ...
    }
    class ValueProfData {
        +uint32_t TotalSize
        +uint32_t NumValueKinds
        // ...
    }
    class InstrProfValueData {
        +uint64_t Value
        +uint64_t Count
    }
    class lprofFilename {
        +const char* FilenamePat
        +unsigned OwnsFilenamePat
        +const char* ProfilePathPrefix
        +char PidChars[MAX_PID_SIZE]
        +char* TmpDir
        +char Hostname[COMPILER_RT_MAX_HOSTLEN]
        +unsigned NumPids
        +unsigned NumHosts
        +unsigned MergePoolSize
        +ProfileNameSpecifier PNS
    }
    ValueProfData "1" *-- "many" ValueProfRecord
    ValueProfRecord "1" *-- "many" InstrProfValueData
Loading

Class diagram for GCDAProfiling.c callback and function list management

classDiagram
    class fn_node {
        +dynamic_object_id id
        +fn_ptr fn
        +fn_node* next
    }
    class fn_list {
        +fn_node* head
        +fn_node* tail
    }
    fn_list "1" o-- "many" fn_node
Loading

File-Level Changes

Change Details Files
Introduce a new core test for coverage mapping and document source-based code coverage support test/test_core.py
ChangeLog.md
Integrate compiler-rt profiling runtime sources for coverage mapping and merging
  • Add full compiler-rt profile runtime under system/lib/compiler-rt/lib/profile
  • Include profile headers and data templates in system/lib/compiler-rt/include/profile
  • Update update_compiler_rt.py to copy new profile sources
  • Register value profiling, GCDA, and merge file support
system/lib/compiler-rt/lib/profile/
system/lib/compiler-rt/include/profile/
system/lib/update_compiler_rt.py
Update build flags and shared tool definitions for coverage tooling
  • Extend libcompiler_rt cflags and includes to cover profiling and atomics
  • Include profile source files in libcompiler_rt src_files
  • Define LLVM_PROFDATA and LLVM_COV in tools/shared.py
tools/system_libs.py
tools/shared.py
Enhance the local HTTP test harness for .mjs and debugging
  • Set correct MIME type for .mjs in SimpleHTTPRequestHandler
  • Improve assert_out_queue_empty to capture and report excess responses
test/common.py
Fix browser test scripts for WebGL and update test arguments
  • Change windows.close to window.close in webgl_multi_draw_test.c
  • Add -sMIN_WEBGL_VERSION=2 flag to cubegeom row length reftest in test_browser.py
test/browser/webgl_multi_draw_test.c
test/test_browser.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

coderabbitai bot commented Jun 16, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants