Re: [PATCH v6 09/15] mm/madvise: introduce MADV_COLLAPSE sync hugepage collapse

[Yang Shi <shy828301@gmail.com>]

On Tue, Jun 7, 2022 at 3:48 PM Zach O'Keefe <zokeefe@google.com> wrote:
>
> On Mon, Jun 6, 2022 at 4:53 PM Yang Shi <shy828301@gmail.com> wrote:
> >
> > On Fri, Jun 3, 2022 at 5:40 PM Zach O'Keefe <zokeefe@google.com> wrote:
> > >
> > > This idea was introduced by David Rientjes[1].
> > >
> > > Introduce a new madvise mode, MADV_COLLAPSE, that allows users to request a
> > > synchronous collapse of memory at their own expense.
> > >
> > > The benefits of this approach are:
> > >
> > > * CPU is charged to the process that wants to spend the cycles for the
> > >   THP
> > > * Avoid unpredictable timing of khugepaged collapse
> > >
> > > An immediate user of this new functionality are malloc() implementations
> > > that manage memory in hugepage-sized chunks, but sometimes subrelease
> > > memory back to the system in native-sized chunks via MADV_DONTNEED;
> > > zapping the pmd.  Later, when the memory is hot, the implementation
> > > could madvise(MADV_COLLAPSE) to re-back the memory by THPs to regain
> > > hugepage coverage and dTLB performance.  TCMalloc is such an
> > > implementation that could benefit from this[2].
> > >
> > > Only privately-mapped anon memory is supported for now, but it is
> > > expected that file and shmem support will be added later to support the
> > > use-case of backing executable text by THPs.  Current support provided
> > > by CONFIG_READ_ONLY_THP_FOR_FS may take a long time on a large system
> > > which might impair services from serving at their full rated load after
> > > (re)starting.  Tricks like mremap(2)'ing text onto anonymous memory to
> > > immediately realize iTLB performance prevents page sharing and demand
> > > paging, both of which increase steady state memory footprint.  With
> > > MADV_COLLAPSE, we get the best of both worlds: Peak upfront performance
> > > and lower RAM footprints.
> > >
> > > This call is independent of the system-wide THP sysfs settings, but will
> > > fail for memory marked VM_NOHUGEPAGE.
> > >
> > > THP allocation may enter direct reclaim and/or compaction.
> > >
> > > [1] https://lore.kernel.org/linux-mm/d098c392-273a-36a4-1a29-59731cdf5d3d@google.com/
> > > [2] https://github.com/google/tcmalloc/tree/master/tcmalloc
> > >
> > > Suggested-by: David Rientjes <rientjes@google.com>
> > > Signed-off-by: Zach O'Keefe <zokeefe@google.com>
> > > ---
> > >  arch/alpha/include/uapi/asm/mman.h     |   2 +
> > >  arch/mips/include/uapi/asm/mman.h      |   2 +
> > >  arch/parisc/include/uapi/asm/mman.h    |   2 +
> > >  arch/xtensa/include/uapi/asm/mman.h    |   2 +
> > >  include/linux/huge_mm.h                |  12 +++
> > >  include/uapi/asm-generic/mman-common.h |   2 +
> > >  mm/khugepaged.c                        | 124 +++++++++++++++++++++++++
> > >  mm/madvise.c                           |   5 +
> > >  8 files changed, 151 insertions(+)
> > >
> > > diff --git a/arch/alpha/include/uapi/asm/mman.h b/arch/alpha/include/uapi/asm/mman.h
> > > index 4aa996423b0d..763929e814e9 100644
> > > --- a/arch/alpha/include/uapi/asm/mman.h
> > > +++ b/arch/alpha/include/uapi/asm/mman.h
> > > @@ -76,6 +76,8 @@
> > >
> > >  #define MADV_DONTNEED_LOCKED   24      /* like DONTNEED, but drop locked pages too */
> > >
> > > +#define MADV_COLLAPSE  25              /* Synchronous hugepage collapse */
> > > +
> > >  /* compatibility flags */
> > >  #define MAP_FILE       0
> > >
> > > diff --git a/arch/mips/include/uapi/asm/mman.h b/arch/mips/include/uapi/asm/mman.h
> > > index 1be428663c10..c6e1fc77c996 100644
> > > --- a/arch/mips/include/uapi/asm/mman.h
> > > +++ b/arch/mips/include/uapi/asm/mman.h
> > > @@ -103,6 +103,8 @@
> > >
> > >  #define MADV_DONTNEED_LOCKED   24      /* like DONTNEED, but drop locked pages too */
> > >
> > > +#define MADV_COLLAPSE  25              /* Synchronous hugepage collapse */
> > > +
> > >  /* compatibility flags */
> > >  #define MAP_FILE       0
> > >
> > > diff --git a/arch/parisc/include/uapi/asm/mman.h b/arch/parisc/include/uapi/asm/mman.h
> > > index a7ea3204a5fa..22133a6a506e 100644
> > > --- a/arch/parisc/include/uapi/asm/mman.h
> > > +++ b/arch/parisc/include/uapi/asm/mman.h
> > > @@ -70,6 +70,8 @@
> > >  #define MADV_WIPEONFORK 71             /* Zero memory on fork, child only */
> > >  #define MADV_KEEPONFORK 72             /* Undo MADV_WIPEONFORK */
> > >
> > > +#define MADV_COLLAPSE  73              /* Synchronous hugepage collapse */
> > > +
> > >  #define MADV_HWPOISON     100          /* poison a page for testing */
> > >  #define MADV_SOFT_OFFLINE 101          /* soft offline page for testing */
> > >
> > > diff --git a/arch/xtensa/include/uapi/asm/mman.h b/arch/xtensa/include/uapi/asm/mman.h
> > > index 7966a58af472..1ff0c858544f 100644
> > > --- a/arch/xtensa/include/uapi/asm/mman.h
> > > +++ b/arch/xtensa/include/uapi/asm/mman.h
> > > @@ -111,6 +111,8 @@
> > >
> > >  #define MADV_DONTNEED_LOCKED   24      /* like DONTNEED, but drop locked pages too */
> > >
> > > +#define MADV_COLLAPSE  25              /* Synchronous hugepage collapse */
> > > +
> > >  /* compatibility flags */
> > >  #define MAP_FILE       0
> > >
> > > diff --git a/include/linux/huge_mm.h b/include/linux/huge_mm.h
> > > index 648cb3ce7099..2ca2f3b41fc8 100644
> > > --- a/include/linux/huge_mm.h
> > > +++ b/include/linux/huge_mm.h
> > > @@ -240,6 +240,9 @@ void __split_huge_pud(struct vm_area_struct *vma, pud_t *pud,
> > >
> > >  int hugepage_madvise(struct vm_area_struct *vma, unsigned long *vm_flags,
> > >                      int advice);
> > > +int madvise_collapse(struct vm_area_struct *vma,
> > > +                    struct vm_area_struct **prev,
> > > +                    unsigned long start, unsigned long end);
> > >  void vma_adjust_trans_huge(struct vm_area_struct *vma, unsigned long start,
> > >                            unsigned long end, long adjust_next);
> > >  spinlock_t *__pmd_trans_huge_lock(pmd_t *pmd, struct vm_area_struct *vma);
> > > @@ -395,6 +398,15 @@ static inline int hugepage_madvise(struct vm_area_struct *vma,
> > >         BUG();
> > >         return 0;
> > >  }
> > > +
> > > +static inline int madvise_collapse(struct vm_area_struct *vma,
> > > +                                  struct vm_area_struct **prev,
> > > +                                  unsigned long start, unsigned long end)
> > > +{
> > > +       BUG();
> > > +       return 0;
> >
> > I wish -ENOSYS could have been returned, but it seems madvise()
> > doesn't support this return value.
>
> This is somewhat tangential, but I agree that ENOSYS (or some other
> errno, but ENOSYS makes most sense to me, after EINVAL, (ENOTSUP?))
> should be anointed the dedicated return value for "madvise mode not
> supported". Ran into this recently when wanting some form of feature
> detection for MADV_COLLAPSE where EINVAL is overloaded  (including
> madvise mode not supported). Happy to move this forward if others
> agree.

I did a quick test by calling MADV_HUGEPAGE on !THP kernel, madvise()
actually returns -EINVAL by madvise_behavior_valid(). So
madvise_collapse() won't be called at all. So madvise_collapse() is
basically used to make !THP compile happy.

I think we could just return -EINVAL.

>
> > > +}
> > > +
> > >  static inline void vma_adjust_trans_huge(struct vm_area_struct *vma,
> > >                                          unsigned long start,
> > >                                          unsigned long end,
> > > diff --git a/include/uapi/asm-generic/mman-common.h b/include/uapi/asm-generic/mman-common.h
> > > index 6c1aa92a92e4..6ce1f1ceb432 100644
> > > --- a/include/uapi/asm-generic/mman-common.h
> > > +++ b/include/uapi/asm-generic/mman-common.h
> > > @@ -77,6 +77,8 @@
> > >
> > >  #define MADV_DONTNEED_LOCKED   24      /* like DONTNEED, but drop locked pages too */
> > >
> > > +#define MADV_COLLAPSE  25              /* Synchronous hugepage collapse */
> > > +
> > >  /* compatibility flags */
> > >  #define MAP_FILE       0
> > >
> > > diff --git a/mm/khugepaged.c b/mm/khugepaged.c
> > > index 4ad04f552347..073d6bb03b37 100644
> > > --- a/mm/khugepaged.c
> > > +++ b/mm/khugepaged.c
> > > @@ -2404,3 +2404,127 @@ void khugepaged_min_free_kbytes_update(void)
> > >                 set_recommended_min_free_kbytes();
> > >         mutex_unlock(&khugepaged_mutex);
> > >  }
> > > +
> > > +static int madvise_collapse_errno(enum scan_result r)
> > > +{
> > > +       switch (r) {
> > > +       case SCAN_PMD_NULL:
> > > +       case SCAN_ADDRESS_RANGE:
> > > +       case SCAN_VMA_NULL:
> > > +       case SCAN_PTE_NON_PRESENT:
> > > +       case SCAN_PAGE_NULL:
> > > +               /*
> > > +                * Addresses in the specified range are not currently mapped,
> > > +                * or are outside the AS of the process.
> > > +                */
> > > +               return -ENOMEM;
> > > +       case SCAN_ALLOC_HUGE_PAGE_FAIL:
> > > +       case SCAN_CGROUP_CHARGE_FAIL:
> > > +               /* A kernel resource was temporarily unavailable. */
> > > +               return -EAGAIN;
> >
> > I thought this should return -ENOMEM too.
>
> Do you mean specifically SCAN_CGROUP_CHARGE_FAIL?

No, I mean both.

>
> At least going by the comment above do_madvise(), and in the man
> pages, for ENOMEM: "Addresses in the specified range are not currently
> mapped, or are outside the address space of the process." doesn't
> really apply here (though I don't know if "A kernel resource was
> temporarily unavailable" applies any better).

Yes, the man page does say so. But IIRC some MADV_ operations do
return -ENOMEM for memory allocation failure, for example,
MADV_POPULATE_READ/WRITE. Typically the man pages don't cover all
cases.

>
> That said, should we differentiate between allocation and charging
> failure? At least in the case of a userspace agent using
> process_madvise(2) to collapse memory on behalf of others, knowing
> "this memcg is at its limit" vs "no THPs available" would be valuable.
> Maybe the former should be EBUSY?

IMHO we don't have to differentiate allocation and charging.

>
> > > +       default:
> > > +               return -EINVAL;
> > > +       }
> > > +}
> > > +
> > > +int madvise_collapse(struct vm_area_struct *vma, struct vm_area_struct **prev,
> > > +                    unsigned long start, unsigned long end)
> > > +{
> > > +       struct collapse_control cc = {
> > > +               .enforce_page_heuristics = false,
> > > +               .enforce_thp_enabled = false,
> > > +               .last_target_node = NUMA_NO_NODE,
> > > +               .gfp = GFP_TRANSHUGE | __GFP_THISNODE,
> > > +       };
> > > +       struct mm_struct *mm = vma->vm_mm;
> > > +       unsigned long hstart, hend, addr;
> > > +       int thps = 0, last_fail = SCAN_FAIL;
> > > +       bool mmap_locked = true;
> > > +
> > > +       BUG_ON(vma->vm_start > start);
> > > +       BUG_ON(vma->vm_end < end);
> > > +
> > > +       *prev = vma;
> > > +
> > > +       /* TODO: Support file/shmem */
> > > +       if (!vma->anon_vma || !vma_is_anonymous(vma))
> > > +               return -EINVAL;
> > > +
> > > +       hstart = (start + ~HPAGE_PMD_MASK) & HPAGE_PMD_MASK;
> > > +       hend = end & HPAGE_PMD_MASK;
> > > +
> > > +       /*
> > > +        * Set VM_HUGEPAGE so that hugepage_vma_check() can pass even if
> > > +        * TRANSPARENT_HUGEPAGE_REQ_MADV_FLAG is set (i.e. "madvise" mode).
> > > +        * Note that hugepage_vma_check() doesn't enforce that
> > > +        * TRANSPARENT_HUGEPAGE_FLAG or TRANSPARENT_HUGEPAGE_REQ_MADV_FLAG
> > > +        * must be set (i.e. "never" mode)
> > > +        */
> > > +       if (!hugepage_vma_check(vma, vma->vm_flags | VM_HUGEPAGE))
> >
> > hugepage_vma_check() doesn't check vma size, so MADV_COLLAPSE may be
> > running for a unsuitable vma, hugepage_vma_revalidate() called by
> > khugepaged_scan_pmd() may find it out finally, but it is a huge waste
> > of effort. So, it is better to check vma size upfront.
>
> This actually does check the vma size, but it's subtle. hstart and
> hend are clamped to the first/last
> hugepaged-aligned address covered by [start,end], which are themselves
> contained in vma->vm_start/vma->vm_end, respectively. We then check
> that addr = hstart < hend ; so if the main loop passes the first
> check, we know that vma->vm_start <= addr and addr + HPAGE_PMD_SIZE <=

Aha, yes, I overlooked that.

> vma->vma_end. Agreed that we might be needlessly doing mmgrab() and
> lru_add_drain() needlessly though.

Yeah

>
> > BTW, my series moved the vma size check in hugepage_vma_check(), so if
> > your series could be based on top of that, you get that for free.
>
> I'll try rebasing on top of your series, thank you!

You don't have to do it right now. I don't know what series will be
merged to mm tree first. Just a heads up.

>
> > > +               return -EINVAL;
> > > +
> > > +       mmgrab(mm);
> > > +       lru_add_drain();
> > > +
> > > +       for (addr = hstart; addr < hend; addr += HPAGE_PMD_SIZE) {
> > > +               int result = SCAN_FAIL;
> > > +               bool retry = true;  /* Allow one retry per hugepage */
> > > +retry:
> > > +               if (!mmap_locked) {
> > > +                       cond_resched();
> > > +                       mmap_read_lock(mm);
> "> > +                       mmap_locked = true;
> > > +                       result = hugepage_vma_revalidate(mm, addr, &vma, &cc);
> >
> > How's about making hugepage_vma_revalidate() return SCAN_SUCCEED too?
> > It seems more consistent.
>
> Ya, I didn't like this either.  I'll add this to "mm/khugepaged: pipe
> enum scan_result codes back to callers"
>
> > > +                       if (result) {
> > > +                               last_fail = result;
> > > +                               goto out_nolock;
> > > +                       }
> > > +               }
> > > +               mmap_assert_locked(mm);
> > > +               memset(cc.node_load, 0, sizeof(cc.node_load));
> > > +               result = khugepaged_scan_pmd(mm, vma, addr, &mmap_locked, &cc);
> > > +               if (!mmap_locked)
> > > +                       *prev = NULL;  /* Tell caller we dropped mmap_lock */
> > > +
> > > +               switch (result) {
> > > +               case SCAN_SUCCEED:
> > > +               case SCAN_PMD_MAPPED:
> > > +                       ++thps;
> > > +                       break;
> > > +               /* Whitelisted set of results where continuing OK */
> > > +               case SCAN_PMD_NULL:
> > > +               case SCAN_PTE_NON_PRESENT:
> > > +               case SCAN_PTE_UFFD_WP:
> > > +               case SCAN_PAGE_RO:
> > > +               case SCAN_LACK_REFERENCED_PAGE:
> > > +               case SCAN_PAGE_NULL:
> > > +               case SCAN_PAGE_COUNT:
> > > +               case SCAN_PAGE_LOCK:
> > > +               case SCAN_PAGE_COMPOUND:
> > > +                       last_fail = result;
> > > +                       break;
> > > +               case SCAN_PAGE_LRU:
> > > +                       if (retry) {
> > > +                               lru_add_drain_all();
> > > +                               retry = false;
> > > +                               goto retry;
> >
> > I'm not sure whether the retry logic is necessary or not, do you have
> > any data about how retry improves the success rate? You could just
> > replace lru_add_drain() to lru_add_drain_all() and remove the retry
> > logic IMHO. I'd prefer to keep it simple at the moment personally.
>
> Transparently, I've only had success hitting this logic on small vms
> under selftests.  That said, it does happen, and I can't imagine this
> hurting, especially on larger systems + tasks using lots of mem.
> Originally, I didn't plan to do this, but as things shook out and we
> had SCAN_PAGE_LRU so readily available, it seemed like we got this for
> free.

"small vms" mean small virtual machines?

When the logic is hit, does lru_add_drain_all() help to improve the
success rate?

I don't mean this hurts anything. I'm just thinking about whether the
extra complexity is worth it or not. And calling lru_add_drain_all()
with holding mmap_lock might have some scalability issues since
draining lru for all is not cheap.


>
> > > +                       }
> > > +                       fallthrough;
> > > +               default:
> > > +                       last_fail = result;
> > > +                       /* Other error, exit */
> > > +                       goto out_maybelock;
> > > +               }
> > > +       }
> > > +
> > > +out_maybelock:
> > > +       /* Caller expects us to hold mmap_lock on return */
> > > +       if (!mmap_locked)
> > > +               mmap_read_lock(mm);
> > > +out_nolock:
> > > +       mmap_assert_locked(mm);
> > > +       mmdrop(mm);
> > > +
> > > +       return thps == ((hend - hstart) >> HPAGE_PMD_SHIFT) ? 0
> > > +                       : madvise_collapse_errno(last_fail);
> > > +}
> > > diff --git a/mm/madvise.c b/mm/madvise.c
> > > index 46feb62ce163..eccac2620226 100644
> > > --- a/mm/madvise.c
> > > +++ b/mm/madvise.c
> > > @@ -59,6 +59,7 @@ static int madvise_need_mmap_write(int behavior)
> > >         case MADV_FREE:
> > >         case MADV_POPULATE_READ:
> > >         case MADV_POPULATE_WRITE:
> > > +       case MADV_COLLAPSE:
> > >                 return 0;
> > >         default:
> > >                 /* be safe, default to 1. list exceptions explicitly */
> > > @@ -1057,6 +1058,8 @@ static int madvise_vma_behavior(struct vm_area_struct *vma,
> > >                 if (error)
> > >                         goto out;
> > >                 break;
> > > +       case MADV_COLLAPSE:
> > > +               return madvise_collapse(vma, prev, start, end);
> > >         }
> > >
> > >         anon_name = anon_vma_name(vma);
> > > @@ -1150,6 +1153,7 @@ madvise_behavior_valid(int behavior)
> > >  #ifdef CONFIG_TRANSPARENT_HUGEPAGE
> > >         case MADV_HUGEPAGE:
> > >         case MADV_NOHUGEPAGE:
> > > +       case MADV_COLLAPSE:
> > >  #endif
> > >         case MADV_DONTDUMP:
> > >         case MADV_DODUMP:
> > > @@ -1339,6 +1343,7 @@ int madvise_set_anon_name(struct mm_struct *mm, unsigned long start,
> > >   *  MADV_NOHUGEPAGE - mark the given range as not worth being backed by
> > >   *             transparent huge pages so the existing pages will not be
> > >   *             coalesced into THP and new pages will not be allocated as THP.
> > > + *  MADV_COLLAPSE - synchronously coalesce pages into new THP.
> > >   *  MADV_DONTDUMP - the application wants to prevent pages in the given range
> > >   *             from being included in its core dump.
> > >   *  MADV_DODUMP - cancel MADV_DONTDUMP: no longer exclude from core dump.
> > > --
> > > 2.36.1.255.ge46751e96f-goog
> > >