diff mbox series

[V4,2/2] Documentation: kdump: describe VMCOREINFO export for RISCV64

Message ID 20221019103623.7008-3-xianting.tian@linux.alibaba.com
State New
Headers
Series Support VMCOREINFO export for RISCV64 |

Commit Message

Xianting Tian Oct. 19, 2022, 10:36 a.m. UTC 
  The following interrelated definitions and ranges are needed by the kdump
crash tool, which are exported by "arch/riscv/kernel/crash_core.c":
    VA_BITS,
    PAGE_OFFSET,
    phys_ram_base,
    KERNEL_LINK_ADDR,
    MODULES_VADDR ~ MODULES_END,
    VMALLOC_START ~ VMALLOC_END,
    VMEMMAP_START ~ VMEMMAP_END,

Document these RISCV64 exports above.

Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>
---
 .../admin-guide/kdump/vmcoreinfo.rst          | 29 +++++++++++++++++++
 1 file changed, 29 insertions(+)

Comments

Bagas Sanjaya Oct. 20, 2022, 1:56 a.m. UTC | #1 
On 10/19/22 17:36, Xianting Tian wrote:
> The following interrelated definitions and ranges are needed by the kdump
> crash tool, which are exported by "arch/riscv/kernel/crash_core.c":
>     VA_BITS,
>     PAGE_OFFSET,
>     phys_ram_base,
>     KERNEL_LINK_ADDR,
>     MODULES_VADDR ~ MODULES_END,
>     VMALLOC_START ~ VMALLOC_END,
>     VMEMMAP_START ~ VMEMMAP_END,
> 
> Document these RISCV64 exports above.
> 
> Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>

Hi Xianting,

Seems like you forgot to keep carrying my Reviewed-by from v3 [1].
Anyway, here it goes...

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks.

[1]: https://lore.kernel.org/linux-doc/20221018081755.6214-3-xianting.tian@linux.alibaba.com/
Xianting Tian Oct. 20, 2022, 2:26 a.m. UTC | #2 
在 2022/10/20 上午9:56, Bagas Sanjaya 写道:
> On 10/19/22 17:36, Xianting Tian wrote:
>> The following interrelated definitions and ranges are needed by the kdump
>> crash tool, which are exported by "arch/riscv/kernel/crash_core.c":
>>      VA_BITS,
>>      PAGE_OFFSET,
>>      phys_ram_base,
>>      KERNEL_LINK_ADDR,
>>      MODULES_VADDR ~ MODULES_END,
>>      VMALLOC_START ~ VMALLOC_END,
>>      VMEMMAP_START ~ VMEMMAP_END,
>>
>> Document these RISCV64 exports above.
>>
>> Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>
> Hi Xianting,
>
> Seems like you forgot to keep carrying my Reviewed-by from v3 [1].
> Anyway, here it goes...
>
> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Sorry, I forgot... :(
>
> Thanks.
>
> [1]: https://lore.kernel.org/linux-doc/20221018081755.6214-3-xianting.tian@linux.alibaba.com/
>
diff mbox series

Patch

diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
index 6726f439958c..86fd88492870 100644
--- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
+++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
@@ -595,3 +595,32 @@  X2TLB
 -----
 
 Indicates whether the crashed kernel enabled SH extended mode.
+
+RISCV64
+=======
+
+VA_BITS
+-------
+
+The maximum number of bits for virtual addresses. Used to compute the
+virtual memory ranges.
+
+PAGE_OFFSET
+-----------
+
+Indicates the virtual kernel start address of the direct-mapped RAM region.
+
+phys_ram_base
+-------------
+
+Indicates the start physical RAM address.
+
+MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KERNEL_LINK_ADDR
+----------------------------------------------------------------------------------------------
+
+Used to get the correct ranges:
+
+  * MODULES_VADDR ~ MODULES_END : Kernel module space.
+  * VMALLOC_START ~ VMALLOC_END : vmalloc() / ioremap() space.
+  * VMEMMAP_START ~ VMEMMAP_END : vmemmap space, used for struct page array.
+  * KERNEL_LINK_ADDR : start address of Kernel link and BPF