VSadov/Satori
1
0
Fork 0
mirror of https://github.com/VSadov/Satori.git synced 2025-06-10 18:11:04 +09:00
Code Activity

Improve JIT dump related docs (#35166)

Browse source 
* Update viewing-jit-dumps.md

* Add jitconfigvalues.h for the sources of env. variables
* Add JitDumpASCII in the list of useful env. variables

* Fix casings for JitDumpASCII env var

* Environment variables on UNIX OSes are case sensitive
This commit is contained in:
Ganbarukamo41 2020-04-28 23:30:36 +09:00 • committed by GitHub
parent 3b7bbd9b94
commit 7cbf0a7011
Signed by: github
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/design/coreclr/jit/ryujit-overview.md
View file

@ -843,7 +843,7 @@ bad tree and wish to understand how it got corrupted, you can place a conditiona
`gtNewNode` to see when it is created, and then a data breakpoint on the field that you believe is corrupted.
The trees are connected by line characters (either in ASCII, by default, or in slightly more readable Unicode when
`COMPlus_JitDumpAscii=0` is specified), to make it a bit easier to read.
`COMPlus_JitDumpASCII=0` is specified), to make it a bit easier to read.
## Variable naming

3
docs/design/coreclr/jit/viewing-jit-dumps.md
View file

@ -98,7 +98,7 @@ The first thing to do is setup the .NET Core app we want to dump. Here are the s
## Setting configuration variables
The behavior of the JIT can be controlled via a number of configuration variables. These are declared in [inc/clrconfigvalues.h](/src/coreclr/src/inc/clrconfigvalues.h). When used as an environment variable, the string name generally has `COMPlus_` prepended. When used as a registry value name, the configuration name is used directly.
The behavior of the JIT can be controlled via a number of configuration variables. These are declared in [inc/clrconfigvalues.h](/src/coreclr/src/inc/clrconfigvalues.h) and [jit/jitconfigvalues.h](/src/coreclr/src/jit/jitconfigvalues.h). When used as an environment variable, the string name generally has `COMPlus_` prepended. When used as a registry value name, the configuration name is used directly.
These can be set in one of three ways:
@ -149,6 +149,7 @@ The wildcard character `*` can be used for `<ClassName>` and `<MethodName>`. In
Below are some of the most useful `COMPlus` variables. Where {method-list} is specified in the list below, you can supply a space-separated list of either fully-qualified or simple method names (the former is useful when running something that has many methods of the same name), or you can specify `*` to mean all methods.
* `COMPlus_JitDump`={method-list} – dump lots of useful information about what the JIT is doing. See [Reading a JitDump](ryujit-overview.md#reading-a-jitdump) for more on how to analyze this data.
* `COMPlus_JitDumpASCII`={1 or 0} - Specifies whether the JIT dump should be ASCII only (Defaults to 1). Disabling this generates more readable expression trees.
* `COMPlus_JitDisasm`={method-list} – dump a disassembly listing of each method.
* `COMPlus_JitDiffableDasm` – set to 1 to tell the JIT to avoid printing things like pointer values that can change from one invocation to the next, so that the disassembly can be more easily compared.
* `COMPlus_JitGCDump`={method-list} – dump the GC information.