Re: [PATCH v5] ksm: add ksm involvement information for each process

[David Hildenbrand]

On 10.01.25 10:40, xu.xin16@xxxxxxxxxx wrote:
> From: xu xin <xu.xin16@xxxxxxxxxx>
>
> In /proc/<pid>/ksm_stat, Add two extra ksm involvement items including
> KSM_mergeable and KSM_merge_any. It helps administrators to
> better know the system's KSM behavior at process level.
>
> ksm_merge_any: yes/no
> 	whether the process'mm is added by prctl() into the candidate list
> 	of KSM or not, and fully enabled at process level.
>
> ksm_mergeable: yes/no
>      whether any VMAs of the process'mm are currently applicable to KSM.
>
> Purpose
> =======
> These two items are just to improve the observability of KSM at process
> level, so that users can know if a certain process has enable KSM.

s/enable/enabled/

> For example, if without these two items, when we look at
> /proc/<pid>/ksm_stat and there's no merging pages found, We are not sure
> whether it is because KSM was not enabled or because KSM did not
> successfully merge any pages.
>
> Althrough "mg" in /proc/<pid>/smaps indicate VM_MERGEABLE, it's opaque

s/Althrough/Although/

> and not very obvious for non professionals.
>
> Signed-off-by: xu xin <xu.xin16@xxxxxxxxxx>
> Cc: Wang Yaxin <wang.yaxin@xxxxxxxxxx>
> ---
> Changelog v4 -> v5:
> 1. Update the documentation.
> 2. Correct a comment sentence and add purpose statment in commit message.
> ---
>   Documentation/filesystems/proc.rst | 66 ++++++++++++++++++++++++++++++++++++++
>   fs/proc/base.c                     | 11 +++++++
>   include/linux/ksm.h                |  1 +
>   mm/ksm.c                           | 19 +++++++++++
>   4 files changed, 97 insertions(+)
>
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 6a882c57a7e7..916f83203de0 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -48,6 +48,7 @@ fixes/update part 1.1  Stefani Seibold <stefani@xxxxxxxxxxx>    June 9 2009
>     3.11	/proc/<pid>/patch_state - Livepatch patch operation state
>     3.12	/proc/<pid>/arch_status - Task architecture specific information
>     3.13  /proc/<pid>/fd - List of symlinks to open files
> +  3.14  /proc/<pid/ksm_stat - Information about the process' ksm status.
>
>     4	Configuring procfs
>     4.1	Mount options
> @@ -2232,6 +2233,71 @@ The number of open files for the process is stored in 'size' member
>   of stat() output for /proc/<pid>/fd for fast access.
>   -------------------------------------------------------
>
> +3.14 /proc/<pid/ksm_stat - Information about the process' ksm status
> +--------------------------------------------------------------------
> +When CONFIG_KSM is enabled, each process has this file which displays
> +the information of ksm merging status.
> +
> +Example
> +~~~~~~~
> +
> +::
> +
> +    / # cat /proc/self/ksm_stat
> +    ksm_rmap_items 0
> +    ksm_zero_pages 0
> +    ksm_merging_pages 0
> +    ksm_process_profit 0
> +    ksm_merge_any: no
> +    ksm_mergeable: no
> +
> +Description
> +~~~~~~~~~~~
> +
> +ksm_rmap_items
> +^^^^^^^^^^^^^^
> +
> +The number of ksm_rmap_item structure in use. The structure of

structures

> +ksm_rmap_item is to store the reverse mapping information for virtual

is to store -> stores?

> +addresses. KSM will generate a ksm_rmap_item for each ksm-scanned page
> +of the process.

Is it really each

> +
> +ksm_zero_pages
> +^^^^^^^^^^^^^^
> +
> +When /sys/kernel/mm/ksm/use_zero_pages is enabled, it represent how many
> +empty pages are merged with kernel zero pages by KSM.
> +
> +ksm_merging_pages
> +^^^^^^^^^^^^^^^^^
> +
> +It represents how many pages of this process are involved in KSM merging
> +(not including ksm_zero_pages). It is the same with what
> +/proc/<pid>/ksm_merging_pages shows.
> +> +ksm_process_profit
> +^^^^^^^^^^^^^^^^^^
> +
> +The profit that KSM brings (Saved bytes). KSM can save memory by merging
> +identical pages, but also can consume additional memory, because it needs
> +to generate a number of rmap_items to save each scanned page's brief rmap
> +information. Some of these pages may be merged, but some may not be abled
> +to be merged after being checked several times, which are unprofitable
> +memory consumed.
> +
> +ksm_merge_any
> +^^^^^^^^^^^^^
> +
> +It specifies whether the process'mm is added by prctl() into the candidate list

Shows whether ... ?

> +of KSM or not, and KSM scanning is fully enabled at process level.
> +
> +ksm_mergeable
> +^^^^^^^^^^^^^
> +
> +It specifies whether any VMAs of the process'mm are currently applicable to KSM.

Shows whether ... ?

"any VMA"



Apart from that LGTM

Acked-by: David Hildenbrand <david@xxxxxxxxxx>

--
Cheers,

David / dhildenb