• David Hildenbrand's avatar
    mm/gup: consistently name GUP-fast functions · 23babe19
    David Hildenbrand authored
    Patch series "mm/gup: consistently call it GUP-fast".
    
    Some cleanups around function names, comments and the config option of
    "GUP-fast" -- GUP without "lock" safety belts on.
    
    With this cleanup it's easy to judge which functions are GUP-fast
    specific.  We now consistently call it "GUP-fast", avoiding mixing it with
    "fast GUP", "lockless", or simply "gup" (which I always considered
    confusing in the ode).
    
    So the magic now happens in functions that contain "gup_fast", whereby
    gup_fast() is the entry point into that magic.  Comments consistently
    reference either "GUP-fast" or "gup_fast()".
    
    
    This patch (of 3):
    
    Let's consistently call the "fast-only" part of GUP "GUP-fast" and rename
    all relevant internal functions to start with "gup_fast", to make it
    clearer that this is not ordinary GUP.  The current mixture of "lockless",
    "gup" and "gup_fast" is confusing.
    
    Further, avoid the term "huge" when talking about a "leaf" -- for example,
    we nowadays check pmd_leaf() because pmd_huge() is gone.  For the
    "hugepd"/"hugepte" stuff, it's part of the name ("is_hugepd"), so that
    stays.
    
    What remains is the "external" interface:
    * get_user_pages_fast_only()
    * get_user_pages_fast()
    * pin_user_pages_fast()
    
    The high-level internal functions for GUP-fast (+slow fallback) are now:
    * internal_get_user_pages_fast() -> gup_fast_fallback()
    * lockless_pages_from_mm() -> gup_fast()
    
    The basic GUP-fast walker functions:
    * gup_pgd_range() -> gup_fast_pgd_range()
    * gup_p4d_range() -> gup_fast_p4d_range()
    * gup_pud_range() -> gup_fast_pud_range()
    * gup_pmd_range() -> gup_fast_pmd_range()
    * gup_pte_range() -> gup_fast_pte_range()
    * gup_huge_pgd()  -> gup_fast_pgd_leaf()
    * gup_huge_pud()  -> gup_fast_pud_leaf()
    * gup_huge_pmd()  -> gup_fast_pmd_leaf()
    
    The weird hugepd stuff:
    * gup_huge_pd() -> gup_fast_hugepd()
    * gup_hugepte() -> gup_fast_hugepte()
    
    The weird devmap stuff:
    * __gup_device_huge_pud() -> gup_fast_devmap_pud_leaf()
    * __gup_device_huge_pmd   -> gup_fast_devmap_pmd_leaf()
    * __gup_device_huge()     -> gup_fast_devmap_leaf()
    * undo_dev_pagemap()      -> gup_fast_undo_dev_pagemap()
    
    Helper functions:
    * unpin_user_pages_lockless() -> gup_fast_unpin_user_pages()
    * gup_fast_folio_allowed() is already properly named
    * gup_fast_permitted() is already properly named
    
    With "gup_fast()", we now even have a function that is referred to in
    comment in mm/mmu_gather.c.
    
    Link: https://lkml.kernel.org/r/20240402125516.223131-1-david@redhat.com
    Link: https://lkml.kernel.org/r/20240402125516.223131-2-david@redhat.comSigned-off-by: default avatarDavid Hildenbrand <david@redhat.com>
    Reviewed-by: default avatarJason Gunthorpe <jgg@nvidia.com>
    Reviewed-by: default avatarMike Rapoport (IBM) <rppt@kernel.org>
    Reviewed-by: default avatarJohn Hubbard <jhubbard@nvidia.com>
    Cc: Peter Xu <peterx@redhat.com>
    Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
    23babe19
gup.c 103 KB