summaryrefslogtreecommitdiffstats
path: root/mm/hugetlb.c
diff options
context:
space:
mode:
authorMatthew Wilcox (Oracle) <willy@infradead.org>2023-08-22 19:24:59 +0200
committerAndrew Morton <akpm@linux-foundation.org>2023-08-25 01:20:31 +0200
commit8cfd014efd93e9450fcd4892bbfe8b10f41e53c3 (patch)
tree7ae0d44b0ecb082d32f23dedce5cc6ed184cc33f /mm/hugetlb.c
parentmm: add orphaned kernel-doc to the rst files. (diff)
downloadlinux-8cfd014efd93e9450fcd4892bbfe8b10f41e53c3.tar.xz
linux-8cfd014efd93e9450fcd4892bbfe8b10f41e53c3.zip
hugetlb: add documentation for vma_kernel_pagesize()
This is an exported symbol, so it should have kernel-doc. Update it to mention folios, and point out that they might be larger than the supported page size for this VMA. Link: https://lkml.kernel.org/r/20230822172459.4190699-1-willy@infradead.org Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Cc: Mike Kravetz <mike.kravetz@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Diffstat (limited to 'mm/hugetlb.c')
-rw-r--r--mm/hugetlb.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/mm/hugetlb.c b/mm/hugetlb.c
index cbc25826c9b0..ba6d39b71cb1 100644
--- a/mm/hugetlb.c
+++ b/mm/hugetlb.c
@@ -968,9 +968,14 @@ pgoff_t linear_hugepage_index(struct vm_area_struct *vma,
}
EXPORT_SYMBOL_GPL(linear_hugepage_index);
-/*
- * Return the size of the pages allocated when backing a VMA. In the majority
- * cases this will be same size as used by the page table entries.
+/**
+ * vma_kernel_pagesize - Page size granularity for this VMA.
+ * @vma: The user mapping.
+ *
+ * Folios in this VMA will be aligned to, and at least the size of the
+ * number of bytes returned by this function.
+ *
+ * Return: The default size of the folios allocated when backing a VMA.
*/
unsigned long vma_kernel_pagesize(struct vm_area_struct *vma)
{