From: peterx@redhat.com
To: linux-kernel@vger.kernel.org, linux-mm@kvack.org
Cc: Muchun Song <muchun.song@linux.dev>,
Jason Gunthorpe <jgg@nvidia.com>,
x86@kernel.org, peterx@redhat.com,
Matthew Wilcox <willy@infradead.org>,
Mike Rapoport <rppt@kernel.org>,
sparclinux@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
linuxppc-dev@lists.ozlabs.org,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH 13/13] mm: Document pXd_leaf() API
Date: Wed, 13 Mar 2024 17:47:19 -0400 [thread overview]
Message-ID: <20240313214719.253873-14-peterx@redhat.com> (raw)
In-Reply-To: <20240313214719.253873-1-peterx@redhat.com>
From: Peter Xu <peterx@redhat.com>
There's one small section already, but since we're going to remove
pXd_huge(), that comment may start to obsolete.
Rewrite that section with more information, hopefully with that the API is
crystal clear on what it implies.
Reviewed-by: Jason Gunthorpe <jgg@nvidia.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
---
include/linux/pgtable.h | 24 +++++++++++++++++++-----
1 file changed, 19 insertions(+), 5 deletions(-)
diff --git a/include/linux/pgtable.h b/include/linux/pgtable.h
index 85fc7554cd52..6b0d222a7fad 100644
--- a/include/linux/pgtable.h
+++ b/include/linux/pgtable.h
@@ -1770,11 +1770,25 @@ typedef unsigned int pgtbl_mod_mask;
#endif
/*
- * p?d_leaf() - true if this entry is a final mapping to a physical address.
- * This differs from p?d_huge() by the fact that they are always available (if
- * the architecture supports large pages at the appropriate level) even
- * if CONFIG_HUGETLB_PAGE is not defined.
- * Only meaningful when called on a valid entry.
+ * pXd_leaf() is the API to check whether a pgtable entry is a huge page
+ * mapping. It should work globally across all archs, without any
+ * dependency on CONFIG_* options. For architectures that do not support
+ * huge mappings on specific levels, below fallbacks will be used.
+ *
+ * A leaf pgtable entry should always imply the following:
+ *
+ * - It is a "present" entry. IOW, before using this API, please check it
+ * with pXd_present() first. NOTE: it may not always mean the "present
+ * bit" is set. For example, PROT_NONE entries are always "present".
+ *
+ * - It should _never_ be a swap entry of any type. Above "present" check
+ * should have guarded this, but let's be crystal clear on this.
+ *
+ * - It should contain a huge PFN, which points to a huge page larger than
+ * PAGE_SIZE of the platform. The PFN format isn't important here.
+ *
+ * - It should cover all kinds of huge mappings (e.g., pXd_trans_huge(),
+ * pXd_devmap(), or hugetlb mappings).
*/
#ifndef pgd_leaf
#define pgd_leaf(x) false
--
2.44.0
prev parent reply other threads:[~2024-03-13 21:57 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-13 21:47 [PATCH 00/13] mm/treewide: Remove pXd_huge() API peterx
2024-03-13 21:47 ` [PATCH 01/13] mm/hmm: Process pud swap entry without pud_huge() peterx
2024-03-13 21:47 ` [PATCH 02/13] mm/gup: Cache p4d in follow_p4d_mask() peterx
2024-03-13 21:47 ` [PATCH 03/13] mm/gup: Check p4d presence before going on peterx
2024-03-13 21:47 ` [PATCH 04/13] mm/x86: Change pXd_huge() behavior to exclude swap entries peterx
2024-03-13 21:47 ` [PATCH 05/13] mm/sparc: " peterx
2024-03-13 21:47 ` [PATCH 06/13] mm/arm: Use macros to define pmd/pud helpers peterx
2024-03-13 21:47 ` [PATCH 07/13] mm/arm: Redefine pmd_huge() with pmd_leaf() peterx
2024-03-13 21:47 ` [PATCH 08/13] mm/arm64: Merge pXd_huge() and pXd_leaf() definitions peterx
2024-03-13 21:47 ` [PATCH 09/13] mm/powerpc: Redefine pXd_huge() with pXd_leaf() peterx
2024-03-14 8:45 ` Christophe Leroy
2024-03-14 12:53 ` Peter Xu
2024-03-14 13:11 ` Christophe Leroy
2024-03-18 16:15 ` Jason Gunthorpe
2024-03-19 23:07 ` Christophe Leroy
2024-03-19 23:26 ` Jason Gunthorpe
2024-03-20 6:16 ` Christophe Leroy
2024-03-20 16:09 ` Peter Xu
2024-03-20 17:40 ` Christophe Leroy
2024-03-20 20:24 ` Peter Xu
2024-03-13 21:47 ` [PATCH 10/13] mm/gup: Merge pXd huge mapping checks peterx
2024-03-13 21:47 ` [PATCH 11/13] mm/treewide: Replace pXd_huge() with pXd_leaf() peterx
2024-03-14 8:50 ` Christophe Leroy
2024-03-14 12:59 ` Peter Xu
2024-03-18 16:16 ` Jason Gunthorpe
2024-03-13 21:47 ` [PATCH 12/13] mm/treewide: Remove pXd_huge() peterx
2024-03-14 8:56 ` Christophe Leroy
2024-03-14 14:08 ` Peter Xu
2024-03-13 21:47 ` peterx [this message]
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=20240313214719.253873-14-peterx@redhat.com \
--to=peterx@redhat.com \
--cc=akpm@linux-foundation.org \
--cc=jgg@nvidia.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=muchun.song@linux.dev \
--cc=rppt@kernel.org \
--cc=sparclinux@vger.kernel.org \
--cc=willy@infradead.org \
--cc=x86@kernel.org \
/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).