Add the documentation for what softoffline_corrected_errors
sysfs interface is for.
Signed-off-by: Jiaqi Yan <jiaqiyan@xxxxxxxxxx>
---
Documentation/admin-guide/mm/hugetlbpage.rst | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/Documentation/admin-guide/mm/hugetlbpage.rst b/Documentation/admin-guide/mm/hugetlbpage.rst
index f34a0d798d5b..7969ae47f5f1 100644
--- a/Documentation/admin-guide/mm/hugetlbpage.rst
+++ b/Documentation/admin-guide/mm/hugetlbpage.rst
@@ -244,7 +244,8 @@ will exist, of the form::
Inside each of these directories, the set of files contained in ``/proc``
will exist. In addition, two additional interfaces for demoting huge
-pages may exist::
+pages, and one additional interface for handling corrected memory errors,
+may exist::
demote
demote_size
@@ -254,6 +255,7 @@ pages may exist::
free_hugepages
resv_hugepages
surplus_hugepages
+ softoffline_corrected_errors
The demote interfaces provide the ability to split a huge page into
smaller huge pages. For example, the x86 architecture supports both
@@ -276,6 +278,17 @@ demote
actually demoted, compare the value of nr_hugepages before and after
writing to the demote interface. demote is a write only interface.
+The interface for handling corrected memory errors is
+
+softoffline_corrected_errors
+ allow userspace to control how to deal with hugepages that have
+ corrected memory errors. When setting to 1, kernel attempts to soft
+ offline the hugepage whenever it thinks needed. If soft offlinging a
+ huge page succeeds, for in-use hugepage, page content is migrated to a
+ new hugepage; however, regardless of in-use or free, capacity of the
+ hugepages will reduce by 1. When setting to 0, kernel won't attempt to
+ soft offline the hugepage of the specific size. Its default value is 1.
+
The interfaces which are the same as in ``/proc`` (all except demote and
demote_size) function as described above for the default huge page-sized case.
--
2.45.1.288.g0e0cd299f1-goog
