1721109 - Preparations for profiler-get-symbols update

Status: RESOLVED FIXED

(DevTools :: Performance Tools (Profiler/Timeline), task, P3)

Description

[Markus Stange [:mstange]]

To fix bug 1615066, we'll need to make ProfilerGetSymbols.jsm use a new version of the profiler-get-symbols wasm blob. This new version has a very different API, because it lays the groundwork for adding a queryAPI endpoint which can look up symbols for multiple libraries in a single request. Specifically, the API wants to do two things in the worker which currently happen outside the worker:

• Resolution of (debugName, breakpadId) to absolute paths
• Trying multiple candidate paths, to satisfy the "check objdirs first" use case.

The patches in this bug will incrementally transform our current code into a state where these two things happen inside the worker. Then the actual update in bug 1615066 will be simple.

Comment 1

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Split createLibraryMap into two functions. r=canaltinova

Depends on D120166

Comment 2

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move sharedLibraries extraction out of createMultiModalGetSymbolTableFn. r=canaltinova

Depends on D120167

Comment 3

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Use createMultiModalGetSymbolTableFn from captureProfile. r=canaltinova

This reduces some code duplication.

Depends on D120168

Comment 4

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Rename createMultiModalGetSymbolTableFn to createLocalSymbolicationService and wrap the getSymbolTable function in SymbolicationService interface. r=canaltinova

At some point in the future, I'm planning to add another method to the SymbolicationService interface: queryAPI.

Depends on D120169

Comment 5

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move createLocalSymbolicationService into symbolication.jsm.js. r=canaltinova

Depends on D120170

Comment 6

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Create a LocalSymbolicationService class. r=canaltinova

Depends on D120171

Comment 7

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Check all local files in the same loop, both files in objdirs and the regular absolute path of the library. r=canaltinova

This may look odd now but it's a temporary step on the way to the final state.

Depends on D120173

Comment 8

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move getSymbolTableMultiModal into the getSymbolTable method. r=canaltinova

Depends on D120174

Comment 9

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Make getCandidatePaths a method of LocalSymbolicationService. r=canaltinova

Depends on D120175

Comment 10

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Split out LocalSymbolicationServiceWithRemoteSymbolTableFallback. r=canaltinova

Depends on D120176

Comment 11

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move library lookup into _getCandidatePaths. r=canaltinova

Depends on D120177

Comment 12

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Stop using createLibraryMap in LocalSymbolicationServiceWithRemoteSymbolTableFallback. r=canaltinova

Depends on D120178

Comment 13

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Make the geckoProfiler WebExtension API use createLocalSymbolicationService. r=canaltinova

Depends on D120179

Comment 14

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Update TypeScript dependencies. r=canaltinova

The old version didn't have Worker.onmessageerror in its DOM type definitions.

Depends on D120180

Comment 15

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move ProfilerGetSymbols code out of toolkit/components/extensions and into devtools directories. r=canaltinova

Depends on D120181

Comment 16

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Split getResultFromWorker out of getSymbolTableFromLocalBinary. r=canaltinova

Depends on D120182

Comment 17

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Add type coverage for the initial worker message. r=canaltinova

After I wrote this patch, I noticed that the worker isn't actually covered
by TypeScript because it doesn't have a // @ts-check comment.
But it seems to be rather non-trivial to make it pass type checking, especially
around module import. For example, I don't know how to tell TypeScript that
this code runs in a worker global scope which has an importScripts function.

So I'm just going to leave the worker uncovered for now. I hope the JSDoc
comment doesn't give the wrong impression.

Depends on D120183

Comment 18

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Inline-away getSymbolTableFromLocalBinary. r=canaltinova

Depends on D120184

Comment 19

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Remove createLibraryMap. r=canaltinova

Depends on D120185

Comment 20

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Factor out getCompactSymbolTableFromPath in the worker. r=canaltinova

Depends on D120186

Comment 21

[Markus Stange [:mstange]]

Attachment: Bug 1721109 - Move candidate path handling and lib info map lookup into the worker. r=canaltinova

This prepares the worker for an upcoming update to a new profiler-get-symbols version;
this way of doing things is a much better match for the new API.

For requesting a single symbol table, this may look unnecessarily complicated, and it is.
But it paves the way for requesting symbols for multiple libraries in a single message.
In the future, rather than requesting a full symbol table for a single library, we will
want to have a queryAPI endpoint which lets us request symbols for multiple libraries
with a single message. This is just elaborate preparation for that step.

Depends on D120187

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/efe0ed0e5769
Split createLibraryMap into two functions. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/f0c04013013d
Move sharedLibraries extraction out of createMultiModalGetSymbolTableFn. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/4b795784be29
Use createMultiModalGetSymbolTableFn from captureProfile. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/096b151037d1
Rename createMultiModalGetSymbolTableFn to createLocalSymbolicationService and wrap the getSymbolTable function in SymbolicationService interface. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/592c5a8ec505
Move createLocalSymbolicationService into symbolication.jsm.js. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/74d7ec05b2b8
Create a LocalSymbolicationService class. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/90bf89c32c9b
Check all local files in the same loop, both files in objdirs and the regular absolute path of the library. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/21c92c047f03
Move getSymbolTableMultiModal into the getSymbolTable method. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/e5dd46eb98b0
Make getCandidatePaths a method of LocalSymbolicationService. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/904a2cc6d4e3
Split out LocalSymbolicationServiceWithRemoteSymbolTableFallback. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/d4a18b255872
Move library lookup into _getCandidatePaths. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/62c17de83b93
Stop using createLibraryMap in LocalSymbolicationServiceWithRemoteSymbolTableFallback. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/f7455f096478
Make the geckoProfiler WebExtension API use createLocalSymbolicationService. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/09b3ee7ff4b3
Update TypeScript dependencies. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/ca3603e1f06e
Move ProfilerGetSymbols code out of toolkit/components/extensions and into devtools directories. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/513ef908c863
Split getResultFromWorker out of getSymbolTableFromLocalBinary. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/117862f83a8c
Add type coverage for the initial worker message. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/3f9122389f28
Inline-away getSymbolTableFromLocalBinary. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/ff3e4abbbe0f
Remove createLibraryMap. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/e8e7a7c35254
Factor out getCompactSymbolTableFromPath in the worker. r=canaltinova
https://hg.mozilla.org/integration/autoland/rev/b4687ec28375
Move candidate path handling and lib info map lookup into the worker. r=canaltinova

Comment 23

[Markus Stange [:mstange]]

Attachment: WIP: Bug 1721109 - Rename this getSymbolTable function to prevent some TypeScript confusion.

For some reason, having a function with this name makes TypeScript show an
error for frame-script.js, which also has a function with the same name and
a different signature. Renaming the worker function fixes the TypeScript
error - even though TypeScript doesn't even check the worker script!

Comment 24

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b598037db93c
Rename this getSymbolTable function to prevent some TypeScript confusion. r=fix CLOSED TREE

Comment 25

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/efe0ed0e5769
https://hg.mozilla.org/mozilla-central/rev/f0c04013013d
https://hg.mozilla.org/mozilla-central/rev/4b795784be29
https://hg.mozilla.org/mozilla-central/rev/096b151037d1
https://hg.mozilla.org/mozilla-central/rev/592c5a8ec505
https://hg.mozilla.org/mozilla-central/rev/74d7ec05b2b8
https://hg.mozilla.org/mozilla-central/rev/90bf89c32c9b
https://hg.mozilla.org/mozilla-central/rev/21c92c047f03
https://hg.mozilla.org/mozilla-central/rev/e5dd46eb98b0
https://hg.mozilla.org/mozilla-central/rev/904a2cc6d4e3
https://hg.mozilla.org/mozilla-central/rev/d4a18b255872
https://hg.mozilla.org/mozilla-central/rev/62c17de83b93
https://hg.mozilla.org/mozilla-central/rev/f7455f096478
https://hg.mozilla.org/mozilla-central/rev/09b3ee7ff4b3
https://hg.mozilla.org/mozilla-central/rev/ca3603e1f06e
https://hg.mozilla.org/mozilla-central/rev/513ef908c863
https://hg.mozilla.org/mozilla-central/rev/117862f83a8c
https://hg.mozilla.org/mozilla-central/rev/3f9122389f28
https://hg.mozilla.org/mozilla-central/rev/ff3e4abbbe0f
https://hg.mozilla.org/mozilla-central/rev/e8e7a7c35254
https://hg.mozilla.org/mozilla-central/rev/b4687ec28375
https://hg.mozilla.org/mozilla-central/rev/b598037db93c