diff mbox series

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

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

Commit Message

Xianting Tian Oct. 14, 2022, 1:41 p.m. UTC 
  The following interrelated definitions and ranges are needed by the kdump
crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
    VA_BITS,
    PAGE_OFFSET,
    phys_ram_base,
    MODULES_VADDR ~ MODULES_END,
    VMALLOC_START ~ VMALLOC_END,
    VMEMMAP_START ~ VMEMMAP_END,
    KASAN_SHADOW_START ~ KASAN_SHADOW_END,
    KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END

Document these RISCV64 exports above.

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

Comments

Conor Dooley Oct. 17, 2022, 7:40 p.m. UTC | #1 
On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
> The following interrelated definitions and ranges are needed by the kdump
> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
>     VA_BITS,
>     PAGE_OFFSET,
>     phys_ram_base,
>     MODULES_VADDR ~ MODULES_END,
>     VMALLOC_START ~ VMALLOC_END,
>     VMEMMAP_START ~ VMEMMAP_END,
>     KASAN_SHADOW_START ~ KASAN_SHADOW_END,
>     KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END
> 
> Document these RISCV64 exports above.
> 
> Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>
> ---
>  .../admin-guide/kdump/vmcoreinfo.rst          | 30 +++++++++++++++++++
>  1 file changed, 30 insertions(+)
> 
> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> index 6726f439958c..8e2e164cf3db 100644
> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> @@ -595,3 +595,33 @@ 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 direct-mapped RAM region.

Apologies for not seeing this sooner, but should there not be a "the"
prior to "direct-mapped"?

> +
> +phys_ram_base
> +-------------
> +
> +Indicates the start physical RAM address.
> +
> +MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> +----------------------------------------------------------------------------------------------------------------------------------------------------
> +
> +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 region, used for struct page array.

Since I'm in pedant mode, it does look a little odd that you're using
region for vmemmap but space for the others but idc that much.

Thanks,
Conor.

> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
> -- 
> 2.17.1
> 
>
Xianting Tian Oct. 18, 2022, 2:41 a.m. UTC | #2 
在 2022/10/18 上午3:40, Conor Dooley 写道:
> On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
>> The following interrelated definitions and ranges are needed by the kdump
>> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
>>      VA_BITS,
>>      PAGE_OFFSET,
>>      phys_ram_base,
>>      MODULES_VADDR ~ MODULES_END,
>>      VMALLOC_START ~ VMALLOC_END,
>>      VMEMMAP_START ~ VMEMMAP_END,
>>      KASAN_SHADOW_START ~ KASAN_SHADOW_END,
>>      KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END
>>
>> Document these RISCV64 exports above.
>>
>> Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>
>> ---
>>   .../admin-guide/kdump/vmcoreinfo.rst          | 30 +++++++++++++++++++
>>   1 file changed, 30 insertions(+)
>>
>> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> index 6726f439958c..8e2e164cf3db 100644
>> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> @@ -595,3 +595,33 @@ 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 direct-mapped RAM region.
> Apologies for not seeing this sooner, but should there not be a "the"
> prior to "direct-mapped"?
will fix in v3
>
>> +
>> +phys_ram_base
>> +-------------
>> +
>> +Indicates the start physical RAM address.
>> +
>> +MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
>> +----------------------------------------------------------------------------------------------------------------------------------------------------
>> +
>> +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 region, used for struct page array.
> Since I'm in pedant mode, it does look a little odd that you're using
> region for vmemmap but space for the others but idc that much.

Sorry, I didn't get your point :(

it contains vmemmap area with reference wth arch/arm64/kernel/crash_core.c.

>
> Thanks,
> Conor.
>
>> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
>> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
>> -- 
>> 2.17.1
>>
>>
Bagas Sanjaya Oct. 18, 2022, 3:19 a.m. UTC | #3 
On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
> The following interrelated definitions and ranges are needed by the kdump
> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":

Better say "..., which are exported by ..."

> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> index 6726f439958c..8e2e164cf3db 100644
> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> @@ -595,3 +595,33 @@ 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 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|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> +----------------------------------------------------------------------------------------------------------------------------------------------------
> +
> +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 region, used for struct page array.
> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.

The documentation LGTM, thanks.

When the patch subject is fixed,

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Xianting Tian Oct. 18, 2022, 5:32 a.m. UTC | #4 
在 2022/10/18 上午11:19, Bagas Sanjaya 写道:
> On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
>> The following interrelated definitions and ranges are needed by the kdump
>> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
> Better say "..., which are exported by ..."

will fix it in v3

thanks

>
>> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> index 6726f439958c..8e2e164cf3db 100644
>> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> @@ -595,3 +595,33 @@ 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 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|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
>> +----------------------------------------------------------------------------------------------------------------------------------------------------
>> +
>> +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 region, used for struct page array.
>> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
>> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
> The documentation LGTM, thanks.
>
> When the patch subject is fixed,
>
> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
Xianting Tian Oct. 18, 2022, 6:06 a.m. UTC | #5 
在 2022/10/18 上午11:19, Bagas Sanjaya 写道:
> On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
>> The following interrelated definitions and ranges are needed by the kdump
>> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
> Better say "..., which are exported by ..."
>
>> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> index 6726f439958c..8e2e164cf3db 100644
>> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>> @@ -595,3 +595,33 @@ 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 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|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
>> +----------------------------------------------------------------------------------------------------------------------------------------------------
>> +
>> +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 region, used for struct page array.
>> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
>> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
> The documentation LGTM, thanks.
>
> When the patch subject is fixed,
Could you tell me what patch subject should be changed to ? thanks
>
> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
Conor Dooley Oct. 18, 2022, 7:13 a.m. UTC | #6 
On Tue, Oct 18, 2022 at 10:41:50AM +0800, Xianting Tian wrote:
> 
> 在 2022/10/18 上午3:40, Conor Dooley 写道:
> > On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
> > > The following interrelated definitions and ranges are needed by the kdump
> > > crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
> > >      VA_BITS,
> > >      PAGE_OFFSET,
> > >      phys_ram_base,
> > >      MODULES_VADDR ~ MODULES_END,
> > >      VMALLOC_START ~ VMALLOC_END,
> > >      VMEMMAP_START ~ VMEMMAP_END,
> > >      KASAN_SHADOW_START ~ KASAN_SHADOW_END,
> > >      KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END
> > > 
> > > Document these RISCV64 exports above.
> > > 
> > > Signed-off-by: Xianting Tian <xianting.tian@linux.alibaba.com>
> > > ---
> > >   .../admin-guide/kdump/vmcoreinfo.rst          | 30 +++++++++++++++++++
> > >   1 file changed, 30 insertions(+)
> > > 
> > > diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> > > index 6726f439958c..8e2e164cf3db 100644
> > > --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
> > > +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> > > @@ -595,3 +595,33 @@ 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 direct-mapped RAM region.
> > Apologies for not seeing this sooner, but should there not be a "the"
> > prior to "direct-mapped"?
> will fix in v3
> > 
> > > +
> > > +phys_ram_base
> > > +-------------
> > > +
> > > +Indicates the start physical RAM address.
> > > +
> > > +MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> > > +----------------------------------------------------------------------------------------------------------------------------------------------------
> > > +
> > > +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 region, used for struct page array.
> > Since I'm in pedant mode, it does look a little odd that you're using
> > region for vmemmap but space for the others but idc that much.
> 
> Sorry, I didn't get your point :(
> 
> it contains vmemmap area with reference wth arch/arm64/kernel/crash_core.c.

The wording is different, vmemmap uses space and the others use region.
Not a big deal.

> 
> > 
> > Thanks,
> > Conor.
> > 
> > > +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
> > > +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
> > > -- 
> > > 2.17.1
> > > 
> > > 
> 
> _______________________________________________
> linux-riscv mailing list
> linux-riscv@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-riscv
Bagas Sanjaya Oct. 18, 2022, 7:20 a.m. UTC | #7 
On 10/18/22 13:06, Xianting Tian wrote:
> 
> 在 2022/10/18 上午11:19, Bagas Sanjaya 写道:
>> On Fri, Oct 14, 2022 at 09:41:39PM +0800, Xianting Tian wrote:
>>> The following interrelated definitions and ranges are needed by the kdump
>>> crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
>> Better say "..., which are exported by ..."
>>
>>> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>>> index 6726f439958c..8e2e164cf3db 100644
>>> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
>>> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
>>> @@ -595,3 +595,33 @@ 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 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|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
>>> +----------------------------------------------------------------------------------------------------------------------------------------------------
>>> +
>>> +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 region, used for struct page array.
>>> +  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
>>> +  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.
>> The documentation LGTM, thanks.
>>
>> When the patch subject is fixed,
> Could you tell me what patch subject should be changed to ? thanks

I mean the description, not subject (as in email). That is, fix the description
(see above). The subject shouldn't be changed. Sorry for inconvenience.

Thanks.
diff mbox series

Patch

diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
index 6726f439958c..8e2e164cf3db 100644
--- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
+++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
@@ -595,3 +595,33 @@  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 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|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
+----------------------------------------------------------------------------------------------------------------------------------------------------
+
+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 region, used for struct page array.
+  * KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
+  * KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.