Skip to content

Add JavaScript and WASM symbols conventions #5096

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.

Sign up for GitHub

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
hoyosjs merged 3 commits into from
Dec 11, 2024
Merged

Add JavaScript and WASM symbols conventions #5096

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12e70e5
Add JavaScript and WASM symbols conventions
robpaveza Dec 10, 2024
1b44a9c
Missed a Ctrl+S
robpaveza Dec 10, 2024
51e1807
Feedback incorporated
robpaveza Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions documentation/symbols/SSQP_Key_Conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,31 @@ Example:
**Version at pseudo-rva 0xFFFFFFFE:** `1`

**Lookup key:** `system.private.corelib.ni.r2rmap/r2rmap-v1-f5fddf60efb0bee79ef02a19c3decba9/system.private.corelib.ni.r2rmap`


### JavaScript Source Maps

JavaScript source maps, which are used by browser developer tools to provide source-level debugging experiences, are [standardized](https://sourcemaps.info). These can be indexed by the
[SHA-256 hash of the script file they map](https://chromedevtools.github.io/devtools-protocol/tot/Debugger/#event-scriptParsed)
(see the `hash` property of the linked event).

Example:

**File name:** `main.js`

**SHA-256 of file:** `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855`

**Lookup key:**: `main.js.map/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855/main.js.map`


### WASM (WebAssembly) Modules

WebAssembly symbols, which can be used by browser developer tools to provide source-level debugging experiences, are based on the DWARF format. These are indexed by their DWARF Build ID
(built with `-Wl,--build-id` arguments) and the name of the module being debugged via the
[buildId property](https://chromedevtools.github.io/devtools-protocol/tot/Debugger/#event-scriptParsed), and the symbol file itself is suffixed with `.s` to disambiguate from the WASM file.

**File name:** `main.wasm`

**Build ID of file:** `e3b0c44298fc1c149afbf4c8996fb92427ae41e4`

**Lookup key:**: `main.wasm.s/e3b0c44298fc1c149afbf4c8996fb92427ae41e4/main.wasm.s`