summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSimon Nattress <nattress@gmail.com>2018-08-28 13:17:05 -0700
committerGitHub <noreply@github.com>2018-08-28 13:17:05 -0700
commit7ae2759c7aefad1a0f10fc3debd5cd7d5bfc2765 (patch)
tree59baaf18721a93edd2f38a70ded27ef78879f0e6 /src
parent4a97250c8878cc507dd41a5d25ec73792c1d8ce6 (diff)
parent241f1ca3d58a23ea298a94a52b5afca7b2ebf136 (diff)
downloadcoreclr-7ae2759c7aefad1a0f10fc3debd5cd7d5bfc2765.tar.gz
coreclr-7ae2759c7aefad1a0f10fc3debd5cd7d5bfc2765.tar.bz2
coreclr-7ae2759c7aefad1a0f10fc3debd5cd7d5bfc2765.zip
Merge pull request #19709 from acmyu/docs
R2RDump - Add tables describing which architectures have been tested
Diffstat (limited to 'src')
-rw-r--r--src/tools/r2rdump/README.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/src/tools/r2rdump/README.md b/src/tools/r2rdump/README.md
index 2d6a6d694e..0d7bdb9ad6 100644
--- a/src/tools/r2rdump/README.md
+++ b/src/tools/r2rdump/README.md
@@ -33,6 +33,24 @@ dotnet R2RDump.dll --in &lt;path to ReadyToRun image&gt;
* -v, --verbose
- Dump disassembly, unwindInfo, gcInfo and section contents
+## Architectures Supported
+
+### R2RDump Architectures
+
+| | x64 | x86 | ARM | ARM64 |
+| ----------- | --- | --------- | --- | ----- |
+| **Windows** | yes | no disasm | | |
+| **Linux** | yes | | | |
+| **OSX** | yes | - | - | - |
+
+### Input Image Architectures
+
+| | x64 | x86 | ARM | ARM64 |
+| ----------- | --- | --- | --------- | ----- |
+| **Windows** | yes | yes | no disasm | yes |
+| **Linux** | yes | yes | no disasm | |
+| **OSX** | yes | - | - | - |
+
## ReadyToRun Format
![R2RFormat](R2RFormat.png)
@@ -106,8 +124,7 @@ In x64/Arm/Arm64, GcTransitions are grouped into chunks where each chunk covers
>> For each slot that changed state in the chunk:
>>> Array of elements consisting of a bit set to 1 and the normCodeOffsetDelta indicating all the code offsets where the slot changed state in the chunk. CodeOffset = normCodeOffsetDelta + normChunkBaseCodeOffset + currentRangeStartOffset - cumInterruptibleLength, where normChunkBaseCodeOffset is the sum of the sizes of all preceeding chunks, currentRangeStartOffset is the start offset of the interruptible range that the transition falls under and cumInterruptibleLength is the sum of the lengths of interruptible ranges that came before it
-
-# Todo
+## Todo
* Support R2RDump on ARM and ARM64 (https://github.com/dotnet/coreclr/issues/19089)