-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chromium Visual Debugger tool initial release
The Visual Debugger is essentially a type aware printf that is useful for debugging and prototyping. See READMEs for more info: //components/viz/service/debugger/README.md //tools/visual_debugger/README.md Bug: 1228113 Change-Id: I34d31dd75fb6d3f860a5f463c8f621bdaf752e0d Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3538742 Reviewed-by: Sadrul Chowdhury <sadrul@chromium.org> Reviewed-by: Bruce Dawson <brucedawson@chromium.org> Commit-Queue: Peter McNeeley <petermcneeley@chromium.org> Cr-Commit-Position: refs/heads/main@{#988199}
- Loading branch information
1 parent
e5f0b2f
commit ad3b2a5
Showing
12 changed files
with
1,616 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
petermcneeley@google.com | ||
sadrul@chromium.org | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
|
||
# //tools/visual_debugger/ | ||
|
||
## Chromium Visual Debugger App | ||
|
||
The Chromium Visual Debugger App is the viewer for the debug stream from a (remote) chromium instance. | ||
For information on the chromium integration of debug capture see: `//components/viz/service/debugger/README.md` | ||
|
||
### Launching | ||
To use the Visual Debugger, Chromium must be launch with remote debugging support. | ||
|
||
` --remote-debugging-port=7777` | ||
|
||
To launch the Debugging App simply run the python server from this directory. The default port is 7777. | ||
|
||
` ./server.py [portnumber]` | ||
|
||
This command will also launch the debugger as a Web App in a separate instance of the default browser. | ||
|
||
In official builds (`is_official_build=true` gn arg) the debugger is disabled by default but can be force enabled locally with the flag below in **args.gn**. | ||
|
||
` use_viz_debugger=true` | ||
|
||
### Usage | ||
|
||
Once the Debugging App launches one should be able to simply click **Connect** to establish a remote debugging stream to the live instance of chromium. | ||
|
||
The in App filters `frame.root.quad` and `frame.root.damage` have been provided by default to give immediate feedback and intuition. The debug macros corresponding to these filters, and all others, can be found directly in the source. | ||
|
||
[Default Filter Debug Macros](https://source.chromium.org/chromium/chromium/src/+/main:components/viz/service/display/display.cc;l=640;drc=5af781c328bdc091651764b5d9ea0f6d77828fed?q=display.cc&ss=chromium%2Fchromium%2Fsrc) | ||
|
||
### Operation | ||
The debugging macros feed information into the VizDebugger static instance. At the end of each frame this cached information is fed upstream and eventually reaches the remote client. | ||
|
||
![Viz Debugger Communication](visual_debugger_communications.png) | ||
|
||
|
||
### Performance | ||
The Debugger App preforms nominally in most basic debugging situations. | ||
Excessive debug logging, specifically text, can make the App feel sluggish. | ||
It is recommended to delete unused filters and disable filters to improve App performance. | ||
|
||
|
||
### Security | ||
|
||
For official builds all visual debug macros are compiled out and the VizDebugger is reduced to a selective few method stubs. This means there are no security concerns for this system with exception of mutable side effects in the creation of input variables to the logging macros. These concerns for mutable side effects already exist for any other code; so no special attention is warranted for these macros. | ||
|
||
For non-official (debug) builds the dev-tools remote debugging port command line argument must be provided for the viz debugger to collect and stream data. Thus the security of this new system is identical to that of the remote dev tools for the case of debugging builds. |
Oops, something went wrong.