v8/tools/turbolizer
Santiago Aboy Solanes 433ff6b946 [turbolizer] Solve off-by-one source position error for non-Wasm
Wasm has the attribute sourceLineToBytecodePosition and adds the source
lines via setSourceLineToBytecodePosition in which they are 0-based.
Non-Wasm doesn't have that attribute and uses insertSourcePositions
which is 1-based. In non-wasm we are being off by one.
As a note, the sourcePositionsInRange call in insertSourcePositions
doesn't return a list for Wasm since they rely on
setSourceLineToBytecodePosition and therefore do not have that
off-by-one error.

Drive-by: Several elements have the same source position so update
addHtmlElementToSourcePosition to handle more than one element.

Drive-by: Renames due to having the same name but different
capitalization, which was confusing.

Bug: v8:7327
Change-Id: Ie8a066ca629054a5f5a754deec0ed1917bed2b33
Notry: true
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/3008634
Reviewed-by: Nico Hartmann <nicohartmann@chromium.org>
Commit-Queue: Santiago Aboy Solanes <solanes@chromium.org>
Cr-Commit-Position: refs/heads/master@{#75655}
2021-07-09 09:07:54 +00:00
..
img [turbolizer] Add show control toolbox item for graph view 2019-01-15 09:08:22 +00:00
src [turbolizer] Solve off-by-one source position error for non-Wasm 2021-07-09 09:07:54 +00:00
test [turbolizer] Enable even more tslint checks 2019-01-12 15:47:35 +00:00
deploy.sh [turbolizer] Update deploy script 2019-02-28 11:46:32 +00:00
down-arrow.png [turbolizer] Display live ranges with sequences 2020-05-27 15:50:45 +00:00
index.html [turbolizer] Display live ranges with sequences 2020-05-27 15:50:45 +00:00
info-view.html [turbolizer] Add shortcuts for hide (un)selected nodes 2019-12-04 17:34:22 +00:00
left-arrow.png
OWNERS [turbolizer] Make sigurds@ a turbolizer OWNER 2019-06-07 14:40:38 +00:00
package-lock.json [turbolizer] Updated package through npm 2019-10-16 15:02:50 +00:00
package.json [turbolizer] Updated package through npm 2019-10-16 15:02:50 +00:00
README.md [turbolizer] Update Readme regarding typescript migration 2020-05-14 10:55:23 +00:00
right-arrow.png
rollup.config.js [turbolizer] Version bumps for dependencies 2019-01-04 14:17:04 +00:00
search2.png
tabs.css [turbolizer] Make the resizers permanently big 2019-10-21 13:45:06 +00:00
tsconfig.json [turbolizer] Add info tab with keyboard shortcuts 2019-01-14 13:52:23 +00:00
tsconfig.test.json [turbolizer] Add test suite 2018-10-11 13:29:23 +00:00
tsfmt.json [turbolizer] Display instruction ranges in turbolizer 2018-06-13 18:06:32 +00:00
tslint.json [turbolizer] Enable even more tslint checks 2019-01-12 15:47:35 +00:00
turbo-visualizer-ranges.css [turbolizer] Display live range uses 2020-06-02 15:04:11 +00:00
turbo-visualizer.css [turbolizer] Display live ranges with sequences 2020-05-27 15:50:45 +00:00
turbolizer.png [turbolizer] Add support for inlined functions 2018-05-16 13:43:14 +00:00
up-arrow.png [turbolizer] Display live ranges with sequences 2020-05-27 15:50:45 +00:00
upload-icon.png

Turbolizer

Turbolizer is a HTML-based tool that visualizes optimized code along the various phases of Turbofan's optimization pipeline, allowing easy navigation between source code, Turbofan IR graphs, scheduled IR nodes and generated assembly code.

Turbolizer consumes .json files that are generated per-function by d8 by passing the '--trace-turbo' command-line flag.

Turbolizer is build using npm:

cd tools/turbolizer
npm i
npm run-script build

Afterwards, turbolizer can be hosted locally by starting a web server that serve the contents of the turbolizer directory, e.g.:

python -m SimpleHTTPServer 8000

To deploy to a directory that can be hosted the script deploy can be used. The following command will deploy to the directory /www/turbolizer:

npm run deploy -- /www/turbolizer

Optionally, profiling data generated by the perf tools in linux can be merged with the .json files using the turbolizer-perf.py file included. The following command is an example of using the perf script:

perf script -i perf.data.jitted -s turbolizer-perf.py turbo-main.json

The output of the above command is a json object that can be piped to a file which, when uploaded to turbolizer, will display the event counts from perf next to each instruction in the disassembly. Further detail can be found in the bottom of this document under "Using Perf with Turbo."

Using the python interface in perf script requires python-dev to be installed and perf be recompiled with python support enabled. Once recompiled, the variable PERF_EXEC_PATH must be set to the location of the recompiled perf binaries.

Graph visualization and manipulation based on Mike Bostock's sample code for an interactive tool for creating directed graphs. Original source is at https://github.com/metacademy/directed-graph-creator and released under the MIT/X license.

Icons derived from the "White Olive Collection" created by Breezi released under the Creative Commons BY license.

Using Perf with Turbo

In order to generate perf data that matches exactly with the turbofan trace, you must use either a debug build of v8 or a release build with the flag 'disassembler=on'. This flag ensures that the '--trace-turbo' will output the necessary disassembly for linking with the perf profile.

The basic example of generating the required data is as follows:

perf record -k mono /path/to/d8 --trace-turbo --perf-prof main.js
perf inject -j -i perf.data -o perf.data.jitted
perf script -i perf.data.jitted -s turbolizer-perf.py turbo-main.json

These commands combined will run and profile d8, merge the output into a single 'perf.data.jitted' file, then take the event data from that and link them to the disassembly in the 'turbo-main.json'. Note that, as above, the output of the script command must be piped to a file for uploading to turbolizer.

There are many options that can be added to the first command, for example '-e' can be used to specify the counting of specific events (default: cycles), as well as '--cpu' to specify which CPU to sample.

Turbolizer build process

The typescript sources reside in tools/turbolizer/src, and the typescript compiler will put the JavaScript output into tools/turbolizer/build/. The index.html file is set up to load the JavaScript from that directory.