[RESEND RFC PATCH v1 10/20] docs: document general_profit sysfs knob

From: Stefan Roesch
Date: Mon Jan 23 2023 - 13:01:51 EST


This adds documentation for the new /sys/kernel/mm/ksm/general_profit
knob.

Signed-off-by: Stefan Roesch <shr@xxxxxxxxxxxx>
---
Documentation/ABI/testing/sysfs-kernel-mm-ksm | 8 ++++++++
Documentation/admin-guide/mm/ksm.rst | 2 ++
2 files changed, 10 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm
index d244674a9480..7768e90f7a8f 100644
--- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm
+++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm
@@ -51,3 +51,11 @@ Description: Control merging pages across different NUMA nodes.

When it is set to 0 only pages from the same node are merged,
otherwise pages from all nodes can be merged together (default).
+
+What: /sys/kernel/mm/ksm/general_profit
+Date: January 2023
+KernelVersion: 6.1
+Contact: Linux memory management mailing list <linux-mm@xxxxxxxxx>
+Description: Measure how effective KSM is.
+ general_profit: how effective is KSM. The formula for the
+ calculation is in Documentation/admin-guide/mm/ksm.rst.
diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst
index fb6ba2002a4b..72189bf1283e 100644
--- a/Documentation/admin-guide/mm/ksm.rst
+++ b/Documentation/admin-guide/mm/ksm.rst
@@ -159,6 +159,8 @@ stable_node_chains_prune_millisecs

The effectiveness of KSM and MADV_MERGEABLE is shown in ``/sys/kernel/mm/ksm/``:

+general_profit
+ how effective is KSM. The calculation is explained below.
pages_shared
how many shared pages are being used
pages_sharing
--
2.30.2