[PATCH] docs/vm: update page owner doc with additional information

[Shuah Khan]

Update page owner doc with additional information such as example
output, implementation and usages details. Made changes for clarity
and fix spelling errors.

Signed-off-by: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
---
 Documentation/vm/page_owner.rst | 130 +++++++++++++++++++++-----------
 1 file changed, 86 insertions(+), 44 deletions(-)

diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
index 9a3af6aafa09..af270102b2c6 100644
--- a/Documentation/vm/page_owner.rst
+++ b/Documentation/vm/page_owner.rst
@@ -1,38 +1,42 @@
+.. SPDX-License-Identifier: GPL-2.0
 .. _page_owner:
 
-==================================================
-page owner: Tracking about who allocated each page
-==================================================
+============================================
+page owner: Tracking who allocated each page
+============================================
 
 Introduction
-============
+------------
 
-page owner is for the tracking about who allocated each page.
-It can be used to debug memory leak or to find a memory hogger.
-When allocation happens, information about allocation such as call stack
-and order of pages is stored into certain storage for each page.
-When we need to know about status of all pages, we can get and analyze
-this information.
+Kernel debug page owner feature is for the tracking who allocated each
+page. It can be used to debug memory leaks or to find a memory hogger.
+When page allocation happens, information about allocation such as
+call stack and order of pages is stored into certain storage for
+each page. When we need to know about status of all pages, we can
+get and analyze this information.
 
 Although we already have tracepoint for tracing page allocation/free,
-using it for analyzing who allocate each page is rather complex. We need
-to enlarge the trace buffer for preventing overlapping until userspace
-program launched. And, launched program continually dump out the trace
-buffer for later analysis and it would change system behaviour with more
-possibility rather than just keeping it in memory, so bad for debugging.
+using it for analyzing who allocated each page is rather complex. We
+need to enlarge the trace buffer for preventing overlapping until
+userspace program launched. And, launched program continually dump out
+the trace buffer for later analysis and it would change system behaviour
+with more possibility rather than just keeping it in memory, so bad for
+debugging.
 
 page owner can also be used for various purposes. For example, accurate
 fragmentation statistics can be obtained through gfp flag information of
 each page. It is already implemented and activated if page owner is
 enabled. Other usages are more than welcome.
 
-page owner is disabled in default. So, if you'd like to use it, you need
-to add "page_owner=on" into your boot cmdline. If the kernel is built
-with page owner and page owner is disabled in runtime due to no enabling
-boot option, runtime overhead is marginal. If disabled in runtime, it
-doesn't require memory to store owner information, so there is no runtime
-memory overhead. And, page owner inserts just two unlikely branches into
-the page allocator hotpath and if not enabled, then allocation is done
+page owner is disabled by default. So, if you'd like to use it, you need
+to enable **CONFIG_PAGE_OWNER** configuration option and boot the kernel
+with "**page_owner=on**" boot parameter to enable page owner at run-time.
+
+If the kernel is built with page owner and page owner is disabled in runtime
+due to no enabling boot option, runtime overhead is marginal. If disabled in
+runtime, it doesn't require memory to store owner information, so there is no
+runtime memory overhead. And, page owner inserts just two unlikely branches
+into the page allocator hot-path and if not enabled, then allocation is done
 like as the kernel without page owner. These two unlikely branches should
 not affect to allocation performance, especially if the static keys jump
 label patching functionality is available. Following is the kernel's code
@@ -51,7 +55,7 @@ size change due to this facility.
    1025       8       8    1041     411 mm/page_ext.o
 
 Although, roughly, 8 KB code is added in total, page_alloc.o increase by
-520 bytes and less than half of it is in hotpath. Building the kernel with
+520 bytes and less than half of it is in hot-path. Building the kernel with
 page owner and turning it on if needed would be great option to debug
 kernel memory problem.
 
@@ -64,47 +68,85 @@ pages are investigated and marked as allocated in initialization phase.
 Although it doesn't mean that they have the right owner information,
 at least, we can tell whether the page is allocated or not,
 more accurately. On 2GB memory x86-64 VM box, 13343 early allocated pages
-are catched and marked, although they are mostly allocated from struct
+are cached and marked, although they are mostly allocated from struct
 page extension feature. Anyway, after that, no page is left in
 un-tracking state.
 
 Usage
-=====
+-----
 
-1) Build user-space helper::
+**Build user-space helper**::
 
 	cd tools/vm
 	make page_owner_sort
 
-2) Enable page owner: add "page_owner=on" to boot cmdline.
+**Enable page owner config option**::
+
+        CONFIG_PAGE_OWNER=y
 
-3) Do the job what you want to debug
+**Enable page owner run-time: pass "page_owner=on" to boot parameter**::
 
-4) Analyze information from page owner::
+        cat /proc/cmdline
+        BOOT_IMAGE=/boot/vmlinuz-5.16.0-rc5+ root=UUID=---- page_owner=on
+
+**Analyze information from page owner**::
 
 	cat /sys/kernel/debug/page_owner > page_owner_full.txt
 	./page_owner_sort page_owner_full.txt sorted_page_owner.txt
 
-   The general output of ``page_owner_full.txt`` is as follows:
+- The general output of ``page_owner_full.txt`` is as follows::
 
-	Page allocated via order XXX, ...
-	PFN XXX ...
-	// Detailed stack
+	        Page allocated via order XXX, ...
+	        PFN XXX ...
+	        Detailed stack
 
-	Page allocated via order XXX, ...
-	PFN XXX ...
-	// Detailed stack
+- Example output::
+
+                Page allocated via order 0, mask 0x0(), pid 1, ts 357726668 ns, free_ts 0 ns
+                PFN 5124 type Unmovable Block 10 type Unmovable Flags 0xfffffc0000000(node=0|zone=1|lastcpupid=0x1fffff)
+                register_early_stack+0x6d/0xc0
+                init_page_owner+0x3c/0x370
+                page_ext_init+0x252/0x26d
+                kernel_init_freeable+0x2cc/0x495
 
-   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.
+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.
 
-   See the result about who allocated each page
-   in the ``sorted_page_owner.txt``. General output:
+- The general output of ``sorted_page_owner.txt`` is as follows::
 
 	XXX times, XXX pages:
 	Page allocated via order XXX, ...
-	// Detailed stack
+	Detailed stack
+
+- Example output::
+
+        1 times, 1 pages:
+        Page allocated via order 0, mask 0x12a20(GFP_ATOMIC|__GFP_NOWARN|__GFP_NORETRY), pid 1159, ts 57047661660 ns, free_ts 57035322260 ns
+        register_dummy_stack+0x6d/0xc0
+        init_page_owner+0x32/0x370
+        page_ext_init+0x252/0x26d
+        kernel_init_freeable+0x2cc/0x495
+
+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.
+
+Additional Imformation
+----------------------
+
+A few important details to know about this feature:
+
+- PAGE_OWNER_STACK_DEPTH is 16
+
+- Bulk allocator impact: PAGE_OWNER may recurse into the allocator to
+  allocate space to save the stack with pagesets.lock held. Releasing
+  and reacquiring removes much of the performance benefit of bulk
+  allocation. Hence ``__alloc_pages_bulk()`` forces the caller to allocate
+  one page at a time when if page_owner_inited is enabled. The reason
+  being, it'll have similar performance to added complexity to the bulk
+  allocator.
+
+- Eats a fair amount of memory if enabled.
 
-   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.
+- KASAN usage: Enable Page owner (CONFIG_PAGE_OWNER and page_owner=on) to
+  get include alloc and free stack traces of affected physical pages
-- 
2.32.0