mm: treewide: clarify pgtable_page_{ctor,dtor}() naming
authorMark Rutland <mark.rutland@arm.com>
Wed, 25 Sep 2019 23:49:46 +0000 (16:49 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Thu, 26 Sep 2019 17:10:44 +0000 (10:10 -0700)
The naming of pgtable_page_{ctor,dtor}() seems to have confused a few
people, and until recently arm64 used these erroneously/pointlessly for
other levels of page table.

To make it incredibly clear that these only apply to the PTE level, and to
align with the naming of pgtable_pmd_page_{ctor,dtor}(), let's rename them
to pgtable_pte_page_{ctor,dtor}().

These changes were generated with the following shell script:

----
git grep -lw 'pgtable_page_.tor' | while read FILE; do
    sed -i '{s/pgtable_page_ctor/pgtable_pte_page_ctor/}' $FILE;
    sed -i '{s/pgtable_page_dtor/pgtable_pte_page_dtor/}' $FILE;
done
----

... with the documentation re-flowed to remain under 80 columns, and
whitespace fixed up in macros to keep backslashes aligned.

There should be no functional change as a result of this patch.

Link: http://lkml.kernel.org/r/20190722141133.3116-1-mark.rutland@arm.com
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Reviewed-by: Mike Rapoport <rppt@linux.ibm.com>
Acked-by: Geert Uytterhoeven <geert@linux-m68k.org> [m68k]
Cc: Anshuman Khandual <anshuman.khandual@arm.com>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Michal Hocko <mhocko@suse.com>
Cc: Yu Zhao <yuzhao@google.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
26 files changed:
Documentation/vm/split_page_table_lock.rst
arch/arc/include/asm/pgalloc.h
arch/arm/include/asm/tlb.h
arch/arm/mm/mmu.c
arch/arm64/include/asm/tlb.h
arch/arm64/mm/mmu.c
arch/csky/include/asm/pgalloc.h
arch/hexagon/include/asm/pgalloc.h
arch/m68k/include/asm/mcf_pgalloc.h
arch/m68k/include/asm/motorola_pgalloc.h
arch/m68k/include/asm/sun3_pgalloc.h
arch/mips/include/asm/pgalloc.h
arch/nios2/include/asm/pgalloc.h
arch/openrisc/include/asm/pgalloc.h
arch/powerpc/mm/pgtable-frag.c
arch/riscv/include/asm/pgalloc.h
arch/s390/mm/pgalloc.c
arch/sh/include/asm/pgalloc.h
arch/sparc/mm/init_64.c
arch/sparc/mm/srmmu.c
arch/um/include/asm/pgalloc.h
arch/unicore32/include/asm/tlb.h
arch/x86/mm/pgtable.c
arch/xtensa/include/asm/pgalloc.h
include/asm-generic/pgalloc.h
include/linux/mm.h

index 889b00b..ff51f4a 100644 (file)
@@ -54,9 +54,9 @@ Hugetlb-specific helpers:
 Support of split page table lock by an architecture
 ===================================================
 
-There's no need in special enabling of PTE split page table lock:
-everything required is done by pgtable_page_ctor() and pgtable_page_dtor(),
-which must be called on PTE table allocation / freeing.
+There's no need in special enabling of PTE split page table lock: everything
+required is done by pgtable_pte_page_ctor() and pgtable_pte_page_dtor(), which
+must be called on PTE table allocation / freeing.
 
 Make sure the architecture doesn't use slab allocator for page table
 allocation: slab uses page->slab_cache for its pages.
@@ -74,7 +74,7 @@ paths: i.e X86_PAE preallocate few PMDs on pgd_alloc().
 
 With everything in place you can set CONFIG_ARCH_ENABLE_SPLIT_PMD_PTLOCK.
 
-NOTE: pgtable_page_ctor() and pgtable_pmd_page_ctor() can fail -- it must
+NOTE: pgtable_pte_page_ctor() and pgtable_pmd_page_ctor() can fail -- it must
 be handled properly.
 
 page->ptl
@@ -94,7 +94,7 @@ trick:
    split lock with enabled DEBUG_SPINLOCK or DEBUG_LOCK_ALLOC, but costs
    one more cache line for indirect access;
 
-The spinlock_t allocated in pgtable_page_ctor() for PTE table and in
+The spinlock_t allocated in pgtable_pte_page_ctor() for PTE table and in
 pgtable_pmd_page_ctor() for PMD table.
 
 Please, never access page->ptl directly -- use appropriate helper.
index 4751f22..b747f2e 100644 (file)
@@ -108,7 +108,7 @@ pte_alloc_one(struct mm_struct *mm)
                return 0;
        memzero((void *)pte_pg, PTRS_PER_PTE * sizeof(pte_t));
        page = virt_to_page(pte_pg);
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return 0;
        }
@@ -123,7 +123,7 @@ static inline void pte_free_kernel(struct mm_struct *mm, pte_t *pte)
 
 static inline void pte_free(struct mm_struct *mm, pgtable_t ptep)
 {
-       pgtable_page_dtor(virt_to_page(ptep));
+       pgtable_pte_page_dtor(virt_to_page(ptep));
        free_pages((unsigned long)ptep, __get_order_pte());
 }
 
index b75ea15..669474a 100644 (file)
@@ -44,7 +44,7 @@ static inline void __tlb_remove_table(void *_table)
 static inline void
 __pte_free_tlb(struct mmu_gather *tlb, pgtable_t pte, unsigned long addr)
 {
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
 
 #ifndef CONFIG_ARM_LPAE
        /*
index 25da9b2..48c2888 100644 (file)
@@ -731,7 +731,7 @@ static void *__init late_alloc(unsigned long sz)
 {
        void *ptr = (void *)__get_free_pages(GFP_PGTABLE_KERNEL, get_order(sz));
 
-       if (!ptr || !pgtable_page_ctor(virt_to_page(ptr)))
+       if (!ptr || !pgtable_pte_page_ctor(virt_to_page(ptr)))
                BUG();
        return ptr;
 }
index a95d1fc..b76df82 100644 (file)
@@ -44,7 +44,7 @@ static inline void tlb_flush(struct mmu_gather *tlb)
 static inline void __pte_free_tlb(struct mmu_gather *tlb, pgtable_t pte,
                                  unsigned long addr)
 {
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
        tlb_remove_table(tlb, pte);
 }
 
index 53dc6f2..60c929f 100644 (file)
@@ -384,7 +384,7 @@ static phys_addr_t pgd_pgtable_alloc(int shift)
         * folded, and if so pgtable_pmd_page_ctor() becomes nop.
         */
        if (shift == PAGE_SHIFT)
-               BUG_ON(!pgtable_page_ctor(phys_to_page(pa)));
+               BUG_ON(!pgtable_pte_page_ctor(phys_to_page(pa)));
        else if (shift == PMD_SHIFT)
                BUG_ON(!pgtable_pmd_page_ctor(phys_to_page(pa)));
 
index d089113..c7c1ed2 100644 (file)
@@ -71,7 +71,7 @@ static inline pgd_t *pgd_alloc(struct mm_struct *mm)
 
 #define __pte_free_tlb(tlb, pte, address)              \
 do {                                                   \
-       pgtable_page_dtor(pte);                         \
+       pgtable_pte_page_dtor(pte);                     \
        tlb_remove_page(tlb, pte);                      \
 } while (0)
 
index 5a6e79e..cc9be51 100644 (file)
@@ -94,7 +94,7 @@ static inline void pmd_populate_kernel(struct mm_struct *mm, pmd_t *pmd,
 
 #define __pte_free_tlb(tlb, pte, addr)         \
 do {                                           \
-       pgtable_page_dtor((pte));               \
+       pgtable_pte_page_dtor((pte));           \
        tlb_remove_page((tlb), (pte));          \
 } while (0)
 
index 4399d71..b34d44d 100644 (file)
@@ -41,7 +41,7 @@ extern inline pmd_t *pmd_alloc_kernel(pgd_t *pgd, unsigned long address)
 static inline void __pte_free_tlb(struct mmu_gather *tlb, pgtable_t page,
                                  unsigned long address)
 {
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        __free_page(page);
 }
 
@@ -54,7 +54,7 @@ static inline struct page *pte_alloc_one(struct mm_struct *mm)
 
        if (!page)
                return NULL;
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return NULL;
        }
@@ -73,7 +73,7 @@ static inline struct page *pte_alloc_one(struct mm_struct *mm)
 
 static inline void pte_free(struct mm_struct *mm, struct page *page)
 {
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        __free_page(page);
 }
 
index d04d9ba..acab315 100644 (file)
@@ -36,7 +36,7 @@ static inline pgtable_t pte_alloc_one(struct mm_struct *mm)
        page = alloc_pages(GFP_KERNEL|__GFP_ZERO, 0);
        if(!page)
                return NULL;
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return NULL;
        }
@@ -51,7 +51,7 @@ static inline pgtable_t pte_alloc_one(struct mm_struct *mm)
 
 static inline void pte_free(struct mm_struct *mm, pgtable_t page)
 {
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        cache_page(kmap(page));
        kunmap(page);
        __free_page(page);
@@ -60,7 +60,7 @@ static inline void pte_free(struct mm_struct *mm, pgtable_t page)
 static inline void __pte_free_tlb(struct mmu_gather *tlb, pgtable_t page,
                                  unsigned long address)
 {
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        cache_page(kmap(page));
        kunmap(page);
        __free_page(page);
index 1a8ddbd..8561211 100644 (file)
@@ -21,7 +21,7 @@ extern const char bad_pmd_string[];
 
 #define __pte_free_tlb(tlb,pte,addr)                   \
 do {                                                   \
-       pgtable_page_dtor(pte);                         \
+       pgtable_pte_page_dtor(pte);                     \
        tlb_remove_page((tlb), pte);                    \
 } while (0)
 
index aa73cb1..1668423 100644 (file)
@@ -54,7 +54,7 @@ static inline void pgd_free(struct mm_struct *mm, pgd_t *pgd)
 
 #define __pte_free_tlb(tlb,pte,address)                        \
 do {                                                   \
-       pgtable_page_dtor(pte);                         \
+       pgtable_pte_page_dtor(pte);                     \
        tlb_remove_page((tlb), pte);                    \
 } while (0)
 
index 750d18d..0b146d7 100644 (file)
@@ -41,7 +41,7 @@ static inline void pgd_free(struct mm_struct *mm, pgd_t *pgd)
 
 #define __pte_free_tlb(tlb, pte, addr)                         \
        do {                                                    \
-               pgtable_page_dtor(pte);                         \
+               pgtable_pte_page_dtor(pte);                     \
                tlb_remove_page((tlb), (pte));                  \
        } while (0)
 
index 787c1b9..da12a4c 100644 (file)
@@ -75,7 +75,7 @@ static inline struct page *pte_alloc_one(struct mm_struct *mm)
        if (!pte)
                return NULL;
        clear_page(page_address(pte));
-       if (!pgtable_page_ctor(pte)) {
+       if (!pgtable_pte_page_ctor(pte)) {
                __free_page(pte);
                return NULL;
        }
@@ -89,13 +89,13 @@ static inline void pte_free_kernel(struct mm_struct *mm, pte_t *pte)
 
 static inline void pte_free(struct mm_struct *mm, struct page *pte)
 {
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
        __free_page(pte);
 }
 
 #define __pte_free_tlb(tlb, pte, addr) \
 do {                                   \
-       pgtable_page_dtor(pte);         \
+       pgtable_pte_page_dtor(pte);     \
        tlb_remove_page((tlb), (pte));  \
 } while (0)
 
index a7b0521..ee4bd6d 100644 (file)
@@ -25,7 +25,7 @@ void pte_frag_destroy(void *pte_frag)
        count = ((unsigned long)pte_frag & ~PAGE_MASK) >> PTE_FRAG_SIZE_SHIFT;
        /* We allow PTE_FRAG_NR fragments from a PTE page */
        if (atomic_sub_and_test(PTE_FRAG_NR - count, &page->pt_frag_refcount)) {
-               pgtable_page_dtor(page);
+               pgtable_pte_page_dtor(page);
                __free_page(page);
        }
 }
@@ -61,7 +61,7 @@ static pte_t *__alloc_for_ptecache(struct mm_struct *mm, int kernel)
                page = alloc_page(PGALLOC_GFP | __GFP_ACCOUNT);
                if (!page)
                        return NULL;
-               if (!pgtable_page_ctor(page)) {
+               if (!pgtable_pte_page_ctor(page)) {
                        __free_page(page);
                        return NULL;
                }
@@ -113,7 +113,7 @@ void pte_fragment_free(unsigned long *table, int kernel)
        BUG_ON(atomic_read(&page->pt_frag_refcount) <= 0);
        if (atomic_dec_and_test(&page->pt_frag_refcount)) {
                if (!kernel)
-                       pgtable_page_dtor(page);
+                       pgtable_pte_page_dtor(page);
                __free_page(page);
        }
 }
index f66a00d..d59ea92 100644 (file)
@@ -78,7 +78,7 @@ static inline void pmd_free(struct mm_struct *mm, pmd_t *pmd)
 
 #define __pte_free_tlb(tlb, pte, buf)   \
 do {                                    \
-       pgtable_page_dtor(pte);         \
+       pgtable_pte_page_dtor(pte);     \
        tlb_remove_page((tlb), pte);    \
 } while (0)
 
index 54fcdf6..3dd253f 100644 (file)
@@ -210,7 +210,7 @@ unsigned long *page_table_alloc(struct mm_struct *mm)
        page = alloc_page(GFP_KERNEL);
        if (!page)
                return NULL;
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return NULL;
        }
@@ -256,7 +256,7 @@ void page_table_free(struct mm_struct *mm, unsigned long *table)
                atomic_xor_bits(&page->_refcount, 3U << 24);
        }
 
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        __free_page(page);
 }
 
@@ -308,7 +308,7 @@ void __tlb_remove_table(void *_table)
        case 3:         /* 4K page table with pgstes */
                if (mask & 3)
                        atomic_xor_bits(&page->_refcount, 3 << 24);
-               pgtable_page_dtor(page);
+               pgtable_pte_page_dtor(page);
                __free_page(page);
                break;
        }
index 8c6341a..22d968b 100644 (file)
@@ -29,7 +29,7 @@ static inline void pmd_populate(struct mm_struct *mm, pmd_t *pmd,
 
 #define __pte_free_tlb(tlb,pte,addr)                   \
 do {                                                   \
-       pgtable_page_dtor(pte);                         \
+       pgtable_pte_page_dtor(pte);                     \
        tlb_remove_page((tlb), (pte));                  \
 } while (0)
 
index 4b099dd..e6d9181 100644 (file)
@@ -2903,7 +2903,7 @@ pgtable_t pte_alloc_one(struct mm_struct *mm)
        struct page *page = alloc_page(GFP_KERNEL | __GFP_ZERO);
        if (!page)
                return NULL;
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                free_unref_page(page);
                return NULL;
        }
@@ -2919,7 +2919,7 @@ static void __pte_free(pgtable_t pte)
 {
        struct page *page = virt_to_page(pte);
 
-       pgtable_page_dtor(page);
+       pgtable_pte_page_dtor(page);
        __free_page(page);
 }
 
index aaebbc0..cc3ad64 100644 (file)
@@ -378,7 +378,7 @@ pgtable_t pte_alloc_one(struct mm_struct *mm)
        if ((pte = (unsigned long)pte_alloc_one_kernel(mm)) == 0)
                return NULL;
        page = pfn_to_page(__nocache_pa(pte) >> PAGE_SHIFT);
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return NULL;
        }
@@ -389,7 +389,7 @@ void pte_free(struct mm_struct *mm, pgtable_t pte)
 {
        unsigned long p;
 
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
        p = (unsigned long)page_address(pte);   /* Cached address (for test) */
        if (p == 0)
                BUG();
index 446e0c0..881e76d 100644 (file)
@@ -29,7 +29,7 @@ extern void pgd_free(struct mm_struct *mm, pgd_t *pgd);
 
 #define __pte_free_tlb(tlb,pte, address)               \
 do {                                                   \
-       pgtable_page_dtor(pte);                         \
+       pgtable_pte_page_dtor(pte);                     \
        tlb_remove_page((tlb),(pte));                   \
 } while (0)
 
index 10d2356..4663d8c 100644 (file)
@@ -15,7 +15,7 @@
 
 #define __pte_free_tlb(tlb, pte, addr)                         \
        do {                                                    \
-               pgtable_page_dtor(pte);                         \
+               pgtable_pte_page_dtor(pte);                     \
                tlb_remove_page((tlb), (pte));                  \
        } while (0)
 
index 463940f..3e4b903 100644 (file)
@@ -45,7 +45,7 @@ early_param("userpte", setup_userpte);
 
 void ___pte_free_tlb(struct mmu_gather *tlb, struct page *pte)
 {
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
        paravirt_release_pte(page_to_pfn(pte));
        paravirt_tlb_remove_table(tlb, pte);
 }
index dd744aa..1d38f0e 100644 (file)
@@ -55,7 +55,7 @@ static inline pgtable_t pte_alloc_one(struct mm_struct *mm)
        if (!pte)
                return NULL;
        page = virt_to_page(pte);
-       if (!pgtable_page_ctor(page)) {
+       if (!pgtable_pte_page_ctor(page)) {
                __free_page(page);
                return NULL;
        }
@@ -69,7 +69,7 @@ static inline void pte_free_kernel(struct mm_struct *mm, pte_t *pte)
 
 static inline void pte_free(struct mm_struct *mm, pgtable_t pte)
 {
-       pgtable_page_dtor(pte);
+       pgtable_pte_page_dtor(pte);
        __free_page(pte);
 }
 #define pmd_pgtable(pmd) pmd_page(pmd)
index 6f8cc06..73f7421 100644 (file)
@@ -49,7 +49,7 @@ static inline void pte_free_kernel(struct mm_struct *mm, pte_t *pte)
  * @mm: the mm_struct of the current context
  * @gfp: GFP flags to use for the allocation
  *
- * Allocates a page and runs the pgtable_page_ctor().
+ * Allocates a page and runs the pgtable_pte_page_ctor().
  *
  * This function is intended for architectures that need
  * anything beyond simple page allocation or must have custom GFP flags.
@@ -63,7 +63,7 @@ static inline pgtable_t __pte_alloc_one(struct mm_struct *mm, gfp_t gfp)
        pte = alloc_page(gfp);
        if (!pte)
                return NULL;
-       if (!pgtable_page_ctor(pte)) {
+       if (!pgtable_pte_page_ctor(pte)) {
                __free_page(pte);
                return NULL;
        }
@@ -76,7 +76,7 @@ static inline pgtable_t __pte_alloc_one(struct mm_struct *mm, gfp_t gfp)
  * pte_alloc_one - allocate a page for PTE-level user page table
  * @mm: the mm_struct of the current context
  *
- * Allocates a page and runs the pgtable_page_ctor().
+ * Allocates a page and runs the pgtable_pte_page_ctor().
  *
  * Return: `struct page` initialized as page table or %NULL on error
  */
@@ -98,7 +98,7 @@ static inline pgtable_t pte_alloc_one(struct mm_struct *mm)
  */
 static inline void pte_free(struct mm_struct *mm, struct page *pte_page)
 {
-       pgtable_page_dtor(pte_page);
+       pgtable_pte_page_dtor(pte_page);
        __free_page(pte_page);
 }
 
index 294a67b..cc29227 100644 (file)
@@ -1949,7 +1949,7 @@ static inline void pgtable_init(void)
        pgtable_cache_init();
 }
 
-static inline bool pgtable_page_ctor(struct page *page)
+static inline bool pgtable_pte_page_ctor(struct page *page)
 {
        if (!ptlock_init(page))
                return false;
@@ -1958,7 +1958,7 @@ static inline bool pgtable_page_ctor(struct page *page)
        return true;
 }
 
-static inline void pgtable_page_dtor(struct page *page)
+static inline void pgtable_pte_page_dtor(struct page *page)
 {
        ptlock_free(page);
        __ClearPageTable(page);