From: Mike Kravetz <mike.kravetz@oracle.com>
To: linux-man@vger.kernel.org, linux-mm@kvack.org
Cc: Alejandro Colomar <alx.manpages@gmail.com>,
Michael Kerrisk <mtk.manpages@gmail.com>,
David Hildenbrand <david@redhat.com>,
Axel Rasmussen <axelrasmussen@google.com>,
Peter Xu <peterx@redhat.com>,
Mike Kravetz <mike.kravetz@oracle.com>
Subject: [PATCH v2] madvise.2: Clarify addr/length and update hugetlb support
Date: Thu, 26 May 2022 11:09:50 -0700 [thread overview]
Message-ID: <20220526180950.13916-1-mike.kravetz@oracle.com> (raw)
Clarify that madvise only works on full pages, and remove references
to 'bytes'.
Update MADV_DONTNEED and MADV_REMOVE sections to remove notes that
HugeTLB mappings are not supported. Indicate the releases when they
were first supported as well as alignment restrictions.
Signed-off-by: Mike Kravetz <mike.kravetz@oracle.com>
---
v1 -> v2 Added releases when Huge TLB support was added and moved
alignment requirements to corresponding section. (Peter)
man2/madvise.2 | 31 +++++++++++++++++++++----------
1 file changed, 21 insertions(+), 10 deletions(-)
diff --git a/man2/madvise.2 b/man2/madvise.2
index f1f384c0c..50686e7e3 100644
--- a/man2/madvise.2
+++ b/man2/madvise.2
@@ -61,9 +61,13 @@ system call is used to give advice or directions to the kernel
about the address range beginning at address
.I addr
and with size
+.IR length .
+.BR madvise ()
+only operates on whole pages, therefore
+.I addr
+must be page-aligned. The value of
.I length
-bytes
-In most cases,
+is rounded up to a multiple of page size. In most cases,
the goal of such advice is to improve system or application performance.
.PP
Initially, the system call supported a set of "conventional"
@@ -143,7 +147,7 @@ The resident set size (RSS) of the calling process will be immediately
reduced however.
.IP
.B MADV_DONTNEED
-cannot be applied to locked pages, Huge TLB pages, or
+cannot be applied to locked pages, or
.BR VM_PFNMAP
pages.
(Pages marked with the kernel-internal
@@ -153,6 +157,11 @@ flag are special memory areas that are not managed
by the virtual memory subsystem.
Such pages are typically created by device drivers that
map the pages into user space.)
+.IP
+Support for Huge TLB pages was added in Linux v5.18. Addresses within a
+mapping backed by Huge TLB pages must be aligned to the underlying Huge TLB
+page size, and the range length is rounded up to a multiple of the underlying
+Huge TLB page size.
.\"
.\" ======================================================================
.\"
@@ -170,24 +179,24 @@ Note that some of these operations change the semantics of memory accesses.
.\" commit f6b3ec238d12c8cc6cc71490c6e3127988460349
Free up a given range of pages
and its associated backing store.
-This is equivalent to punching a hole in the corresponding byte
+This is equivalent to punching a hole in the corresponding
range of the backing store (see
.BR fallocate (2)).
Subsequent accesses in the specified address range will see
-bytes containing zero.
+pages containing zero.
.\" Databases want to use this feature to drop a section of their
.\" bufferpool (shared memory segments) - without writing back to
.\" disk/swap space. This feature is also useful for supporting
.\" hot-plug memory on UML.
.IP
The specified address range must be mapped shared and writable.
-This flag cannot be applied to locked pages, Huge TLB pages, or
+This flag cannot be applied to locked pages, or
.BR VM_PFNMAP
pages.
.IP
In the initial implementation, only
.BR tmpfs (5)
-was supported
+supported
.BR MADV_REMOVE ;
but since Linux 3.5,
.\" commit 3f31d07571eeea18a7d34db9af21d2285b807a17
@@ -196,10 +205,12 @@ any filesystem which supports the
.BR FALLOC_FL_PUNCH_HOLE
mode also supports
.BR MADV_REMOVE .
-Hugetlbfs fails with the error
-.BR EINVAL
-and other filesystems fail with the error
+Filesystems which do not support
+.BR MADV_REMOVE
+fail with the error
.BR EOPNOTSUPP .
+.IP
+Support for Huge TLB filesystem was added in Linux v4.3.
.TP
.BR MADV_DONTFORK " (since Linux 2.6.16)"
.\" commit f822566165dd46ff5de9bf895cfa6c51f53bb0c4
--
2.35.3
next reply other threads:[~2022-05-26 18:10 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-26 18:09 Mike Kravetz [this message]
2022-05-26 18:21 ` [PATCH v2] madvise.2: Clarify addr/length and update hugetlb support Peter Xu
2022-05-31 9:10 ` David Hildenbrand
2022-06-03 17:02 ` man-pages maintainership (was: Re: [PATCH v2] madvise.2: Clarify addr/length and update hugetlb support) Alejandro Colomar
2022-06-03 17:42 ` Alejandro Colomar
2022-06-07 7:44 ` David Hildenbrand
2022-06-07 9:37 ` Alejandro Colomar
2022-06-08 10:00 ` David Hildenbrand
2022-06-08 11:41 ` Alejandro Colomar
2022-06-06 19:12 ` [PATCH v2] madvise.2: Clarify addr/length and update hugetlb support Alejandro Colomar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220526180950.13916-1-mike.kravetz@oracle.com \
--to=mike.kravetz@oracle.com \
--cc=alx.manpages@gmail.com \
--cc=axelrasmussen@google.com \
--cc=david@redhat.com \
--cc=linux-man@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mtk.manpages@gmail.com \
--cc=peterx@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).