Commit 7bd1fa0d authored by Baoquan He's avatar Baoquan He Committed by Andrew Morton
Browse files

mm/mmu_gather: clean up the stale code comment 

In commit d7f861b9 ("mm/mmu_gather: add __tlb_remove_folio_pages()"),
helper function __tlb_remove_folio_pages_size() was added.  And based on
the helper, wrapper functions __tlb_remove_folio_pages() and
__tlb_remove_page_size() are created and used by upper level functions.

So let's update the code comment to reflect the current code about
tlb_remove_page()/tlb_remove_page_size(), etc.

Link: https://lkml.kernel.org/r/20250211034348.39531-2-bhe@redhat.com


Signed-off-by: default avatarBaoquan He <bhe@redhat.com>
Cc: "Aneesh Kumar K.V" <aneesh.kumar@kernel.org>
Cc: Nicholas Piggin <npiggin@gmail.com>
Cc: Peter Zijlstra (Intel) <peterz@infradead.org>
Cc: Qi Zheng <zhengqi.arch@bytedance.com>
Cc: Will Deacon <will@kernel.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 1d23b940

include/asm-generic/tlb.h

+10 −11
Original line number Diff line number Diff line
@@ -67,22 +67,21 @@ 
 *

 *    See also MMU_GATHER_TABLE_FREE and MMU_GATHER_RCU_TABLE_FREE.

 *

 *  - tlb_remove_page() / __tlb_remove_page()

 *  - tlb_remove_page_size() / __tlb_remove_page_size()

 *  - __tlb_remove_folio_pages()

 *  - tlb_remove_page() / tlb_remove_page_size()

 *  - __tlb_remove_folio_pages() / __tlb_remove_page_size()

 *  - __tlb_remove_folio_pages_size()

 *

 *    __tlb_remove_page_size() is the basic primitive that queues a page for

 *    freeing. __tlb_remove_page() assumes PAGE_SIZE. Both will return a

 *    boolean indicating if the queue is (now) full and a call to

 *    tlb_flush_mmu() is required.

 *    __tlb_remove_folio_pages_size() is the basic primitive that queues pages

 *    for freeing. It will return a boolean indicating if the queue is (now)

 *    full and a call to tlb_flush_mmu() is required.

 *

 *    tlb_remove_page() and tlb_remove_page_size() imply the call to

 *    tlb_flush_mmu() when required and has no return value.

 *

 *    __tlb_remove_folio_pages() is similar to __tlb_remove_page(), however,

 *    instead of removing a single page, remove the given number of consecutive

 *    pages that are all part of the same (large) folio: just like calling

 *    __tlb_remove_page() on each page individually.

 *    __tlb_remove_folio_pages() is similar to __tlb_remove_page_size(),

 *    however, instead of removing a single page, assume PAGE_SIZE and remove

 *    the given number of consecutive pages that are all part of the

 *    same (large) folio.

 *

 *  - tlb_change_page_size()

 *