Skip to content
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

Refactor Wasmtime's profiling support #6361

Merged
merged 10 commits into from
May 9, 2023

Conversation

alexcrichton
Copy link
Member

This commit refactors the profiling support for existing agents in Wasmtime. The end goal was to handle #6328 and I ended up doing a fair bit of other cleanup along the way. The profilers are now all centered around "load a single function" rather than dealing with both modules and trampolines. The shared logic of parsing an ELF file is located in one place now in shared support across all profilers.

This also applies refactorings such as removing DWARF support for jitdump which while not problematic hasn't been necessary for me historically. Additionally Wasmtime's support for DWARF is too buggy to enable so it's not getting any use anyway.

This commit is a bit of reorganization around profiling-related code in
Wasmtime with the aim of eventually simplifying it a bit more. The
changes here are:

* All exposed agents are removed and instead only constructor functions
  returning trait objects are now exposed.
* All `*_disabled.rs` files and modules are removed in favor of a
  function that returns a result (less trait impls).
* All `*_linux.rs` files where renamed to just `*.rs`. (less files in
  play)
* The `pid` and `tid` arguments were removed as they were only used by
  the jitdump profiler and now that manages it internally.
* Registering an entire ELF image is now part of the trait rather than
  buried within the trampoline code in Wasmtime.
In general Wasmtime's support for DWARF is not great so this is rarely
used and at least in my experience this hasn't been necessary to get
good information from perf. This commit removes the processing here
which while probably useful is probably not necessary and otherwise
makes the jidump agent a bit of an odd-one-out relative among the other
agents.
Refactor slightly to account for this.
This has been the same as `self.pid` for quite some time but with
`rustix` it's pretty easy to get access to the current thread id.
Add a second argument to registration of an entire module for custom
names to get functions named correctly, and otherwise profilers now only
need to look at individual functions.
@alexcrichton alexcrichton requested review from a team as code owners May 9, 2023 16:35
@alexcrichton alexcrichton requested review from itsrainy and removed request for a team May 9, 2023 16:35
@github-actions github-actions bot added wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime labels May 9, 2023
@github-actions
Copy link

github-actions bot commented May 9, 2023

Subscribe to Label Action

cc @peterhuene

This issue or pull request has been labeled: "wasmtime:api", "wasmtime:config"

Thus the following users have been cc'd because of the following labels:

  • peterhuene: wasmtime:api

To subscribe or unsubscribe from this label, edit the .github/subscribe-to-label.json configuration file.

Learn more.

@github-actions
Copy link

github-actions bot commented May 9, 2023

Label Messager: wasmtime:config

It looks like you are changing Wasmtime's configuration options. Make sure to
complete this check list:

  • If you added a new Config method, you wrote extensive documentation for
    it.

    Our documentation should be of the following form:

    Short, simple summary sentence.
    
    More details. These details can be multiple paragraphs. There should be
    information about not just the method, but its parameters and results as
    well.
    
    Is this method fallible? If so, when can it return an error?
    
    Can this method panic? If so, when does it panic?
    
    # Example
    
    Optional example here.
    
  • If you added a new Config method, or modified an existing one, you
    ensured that this configuration is exercised by the fuzz targets.

    For example, if you expose a new strategy for allocating the next instance
    slot inside the pooling allocator, you should ensure that at least one of our
    fuzz targets exercises that new strategy.

    Often, all that is required of you is to ensure that there is a knob for this
    configuration option in wasmtime_fuzzing::Config (or one
    of its nested structs).

    Rarely, this may require authoring a new fuzz target to specifically test this
    configuration. See our docs on fuzzing for more details.

  • If you are enabling a configuration option by default, make sure that it
    has been fuzzed for at least two weeks before turning it on by default.


To modify this label's message, edit the .github/label-messager/wasmtime-config.md file.

To add new label messages or remove existing label messages, edit the
.github/label-messager.json configuration file.

Learn more.

Copy link
Member

@fitzgen fitzgen left a comment

Choose a reason for hiding this comment

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

Very nice!

@fitzgen fitzgen added this pull request to the merge queue May 9, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 9, 2023
@alexcrichton alexcrichton enabled auto-merge May 9, 2023 19:20
@alexcrichton alexcrichton added this pull request to the merge queue May 9, 2023
Merged via the queue into bytecodealliance:main with commit 4c38a18 May 9, 2023
@alexcrichton alexcrichton deleted the refactor-profiling branch May 9, 2023 20:07
alexcrichton added a commit to alexcrichton/wasmtime that referenced this pull request May 22, 2023
This commit fixes a panic that's easy to hit with native profilers by
accident. This was introduced in bytecodealliance#6262 which made it into the 9.0.0
release but is not present on `main` due to the refactorings of bytecodealliance#6361
which are on `main` but not on 9.0.0.

Closes bytecodealliance#6433
alexcrichton added a commit that referenced this pull request May 22, 2023
This commit fixes a panic that's easy to hit with native profilers by
accident. This was introduced in #6262 which made it into the 9.0.0
release but is not present on `main` due to the refactorings of #6361
which are on `main` but not on 9.0.0.

Closes #6433
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants