linux-kernel - [PATCH] Documentation/vm/page_owner.rst: Update the documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20211214134736.2569-1-hanshenghong2019@email.szu.edu.cn>
Date:   Tue, 14 Dec 2021 21:47:36 +0800
From:   Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
To:     corbet@....net
Cc:     akpm@...ux-foundation.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, vbabka@...e.cz,
        georgi.djakov@...aro.org, lmark@...eaurora.org,
        tangbin@...s.chinamobile.com, zhangshengju@...s.chinamobile.com,
        weizhenliang@...wei.com, nixiaoming@...wei.com,
        Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
Subject: [PATCH] Documentation/vm/page_owner.rst: Update the documentation

Update the documentation of ``page_owner``.

Signed-off-by: Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
---
 Documentation/vm/page_owner.rst | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
index 9837fc8147dd..7a28e7b0d9c2 100644
--- a/Documentation/vm/page_owner.rst
+++ b/Documentation/vm/page_owner.rst
@@ -97,7 +97,7 @@ Usage
 
    The ``page_owner_sort`` tool ignores ``PFN`` rows, puts the remaining rows
    in buf, uses regexp to extract the page order value, counts the times
-   and pages of buf, and finally sorts them according to the times.
+   and pages of buf, and finally sorts them according to the parameter(s).
 
    See the result about who allocated each page
    in the ``sorted_page_owner.txt``. General output:
@@ -108,3 +108,22 @@ Usage
 
    By default, ``page_owner_sort`` is sorted according to the times of buf.
    If you want to sort by the pages nums of buf, use the ``-m`` parameter.
+   The detail parameters are shown as follows:
+
+   fundamental function:
+
+	Sort:
+		-a		Sort by memory allocate time.
+		-m		Sort by total memory.
+		-p		Sort by pid.
+		-r		Sort by memory release time.
+		-s		Sort by the stack trace.
+		-t		Sort by times (default).
+
+   additional function:
+
+	Cull:
+		-c		Cull by comparing stacktrace instead of total block.
+
+	Filter:
+		-f		Filter out the information of blocks whose memory has not been released.
-- 
2.30.1