forked from Minki/linux
dd0db88d80
Patch series "userfaultfd non-cooperative further update for 4.11 merge window". Unfortunately I noticed one relevant bug in userfaultfd_exit while doing more testing. I've been doing testing before and this was also tested by kbuild bot and exercised by the selftest, but this bug never reproduced before. I dropped userfaultfd_exit as result. I dropped it because of implementation difficulty in receiving signals in __mmput and because I think -ENOSPC as result from the background UFFDIO_COPY should be enough already. Before I decided to remove userfaultfd_exit, I noticed userfaultfd_exit wasn't exercised by the selftest and when I tried to exercise it, after moving it to a more correct place in __mmput where it would make more sense and where the vma list is stable, it resulted in the event_wait_completion in D state. So then I added the second patch to be sure even if we call userfaultfd_event_wait_completion too late during task exit(), we won't risk to generate tasks in D state. The same check exists in handle_userfault() for the same reason, except it makes a difference there, while here is just a robustness check and it's run under WARN_ON_ONCE. While looking at the userfaultfd_event_wait_completion() function I looked back at its callers too while at it and I think it's not ok to stop executing dup_fctx on the fcs list because we relay on userfaultfd_event_wait_completion to execute userfaultfd_ctx_put(fctx->orig) which is paired against userfaultfd_ctx_get(fctx->orig) in dup_userfault just before list_add(fcs). This change only takes care of fctx->orig but this area also needs further review looking for similar problems in fctx->new. The only patch that is urgent is the first because it's an use after free during a SMP race condition that affects all processes if CONFIG_USERFAULTFD=y. Very hard to reproduce though and probably impossible without SLUB poisoning enabled. This patch (of 3): I once reproduced this oops with the userfaultfd selftest, it's not easily reproducible and it requires SLUB poisoning to reproduce. general protection fault: 0000 [#1] SMP Modules linked in: CPU: 2 PID: 18421 Comm: userfaultfd Tainted: G ------------ T 3.10.0+ #15 Hardware name: QEMU Standard PC (i440FX + PIIX, 1996), BIOS rel-1.10.1-0-g8891697-prebuilt.qemu-project.org 04/01/2014 task: ffff8801f83b9440 ti: ffff8801f833c000 task.ti: ffff8801f833c000 RIP: 0010:[<ffffffff81451299>] [<ffffffff81451299>] userfaultfd_exit+0x29/0xa0 RSP: 0018:ffff8801f833fe80 EFLAGS: 00010202 RAX: ffff8801f833ffd8 RBX: 6b6b6b6b6b6b6b6b RCX: ffff8801f83b9440 RDX: 0000000000000000 RSI: 0000000000000000 RDI: ffff8800baf18600 RBP: ffff8801f833fee8 R08: 0000000000000000 R09: 0000000000000001 R10: 0000000000000000 R11: ffffffff8127ceb3 R12: 0000000000000000 R13: ffff8800baf186b0 R14: ffff8801f83b99f8 R15: 00007faed746c700 FS: 0000000000000000(0000) GS:ffff88023fc80000(0000) knlGS:0000000000000000 CS: 0010 DS: 0000 ES: 0000 CR0: 000000008005003b CR2: 00007faf0966f028 CR3: 0000000001bc6000 CR4: 00000000000006e0 DR0: 0000000000000000 DR1: 0000000000000000 DR2: 0000000000000000 DR3: 0000000000000000 DR6: 00000000ffff0ff0 DR7: 0000000000000400 Call Trace: do_exit+0x297/0xd10 SyS_exit+0x17/0x20 tracesys+0xdd/0xe2 Code: 00 00 66 66 66 66 90 55 48 89 e5 41 54 53 48 83 ec 58 48 8b 1f 48 85 db 75 11 eb 73 66 0f 1f 44 00 00 48 8b 5b 10 48 85 db 74 64 <4c> 8b a3 b8 00 00 00 4d 85 e4 74 eb 41 f6 84 24 2c 01 00 00 80 RIP [<ffffffff81451299>] userfaultfd_exit+0x29/0xa0 RSP <ffff8801f833fe80> ---[ end trace 9fecd6dcb442846a ]--- In the debugger I located the "mm" pointer in the stack and walking mm->mmap->vm_next through the end shows the vma->vm_next list is fully consistent and it is null terminated list as expected. So this has to be an SMP race condition where userfaultfd_exit was running while the vma list was being modified by another CPU. When userfaultfd_exit() run one of the ->vm_next pointers pointed to SLAB_POISON (RBX is the vma pointer and is 0x6b6b..). The reason is that it's not running in __mmput but while there are still other threads running and it's not holding the mmap_sem (it can't as it has to wait the even to be received by the manager). So this is an use after free that was happening for all processes. One more implementation problem aside from the race condition: userfaultfd_exit has really to check a flag in mm->flags before walking the vma or it's going to slowdown the exit() path for regular tasks. One more implementation problem: at that point signals can't be delivered so it would also create a task in D state if the manager doesn't read the event. The major design issue: it overall looks superfluous as the manager can check for -ENOSPC in the background transfer: if (mmget_not_zero(ctx->mm)) { [..] } else { return -ENOSPC; } It's safer to roll it back and re-introduce it later if at all. [rppt@linux.vnet.ibm.com: documentation fixup after removal of UFFD_EVENT_EXIT] Link: http://lkml.kernel.org/r/1488345437-4364-1-git-send-email-rppt@linux.vnet.ibm.com Link: http://lkml.kernel.org/r/20170224181957.19736-2-aarcange@redhat.com Signed-off-by: Andrea Arcangeli <aarcange@redhat.com> Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com> Acked-by: Mike Rapoport <rppt@linux.vnet.ibm.com> Cc: "Dr. David Alan Gilbert" <dgilbert@redhat.com> Cc: Mike Kravetz <mike.kravetz@oracle.com> Cc: Pavel Emelyanov <xemul@parallels.com> Cc: Hillf Danton <hillf.zj@alibaba-inc.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
230 lines
11 KiB
Plaintext
230 lines
11 KiB
Plaintext
= Userfaultfd =
|
|
|
|
== Objective ==
|
|
|
|
Userfaults allow the implementation of on-demand paging from userland
|
|
and more generally they allow userland to take control of various
|
|
memory page faults, something otherwise only the kernel code could do.
|
|
|
|
For example userfaults allows a proper and more optimal implementation
|
|
of the PROT_NONE+SIGSEGV trick.
|
|
|
|
== Design ==
|
|
|
|
Userfaults are delivered and resolved through the userfaultfd syscall.
|
|
|
|
The userfaultfd (aside from registering and unregistering virtual
|
|
memory ranges) provides two primary functionalities:
|
|
|
|
1) read/POLLIN protocol to notify a userland thread of the faults
|
|
happening
|
|
|
|
2) various UFFDIO_* ioctls that can manage the virtual memory regions
|
|
registered in the userfaultfd that allows userland to efficiently
|
|
resolve the userfaults it receives via 1) or to manage the virtual
|
|
memory in the background
|
|
|
|
The real advantage of userfaults if compared to regular virtual memory
|
|
management of mremap/mprotect is that the userfaults in all their
|
|
operations never involve heavyweight structures like vmas (in fact the
|
|
userfaultfd runtime load never takes the mmap_sem for writing).
|
|
|
|
Vmas are not suitable for page- (or hugepage) granular fault tracking
|
|
when dealing with virtual address spaces that could span
|
|
Terabytes. Too many vmas would be needed for that.
|
|
|
|
The userfaultfd once opened by invoking the syscall, can also be
|
|
passed using unix domain sockets to a manager process, so the same
|
|
manager process could handle the userfaults of a multitude of
|
|
different processes without them being aware about what is going on
|
|
(well of course unless they later try to use the userfaultfd
|
|
themselves on the same region the manager is already tracking, which
|
|
is a corner case that would currently return -EBUSY).
|
|
|
|
== API ==
|
|
|
|
When first opened the userfaultfd must be enabled invoking the
|
|
UFFDIO_API ioctl specifying a uffdio_api.api value set to UFFD_API (or
|
|
a later API version) which will specify the read/POLLIN protocol
|
|
userland intends to speak on the UFFD and the uffdio_api.features
|
|
userland requires. The UFFDIO_API ioctl if successful (i.e. if the
|
|
requested uffdio_api.api is spoken also by the running kernel and the
|
|
requested features are going to be enabled) will return into
|
|
uffdio_api.features and uffdio_api.ioctls two 64bit bitmasks of
|
|
respectively all the available features of the read(2) protocol and
|
|
the generic ioctl available.
|
|
|
|
The uffdio_api.features bitmask returned by the UFFDIO_API ioctl
|
|
defines what memory types are supported by the userfaultfd and what
|
|
events, except page fault notifications, may be generated.
|
|
|
|
If the kernel supports registering userfaultfd ranges on hugetlbfs
|
|
virtual memory areas, UFFD_FEATURE_MISSING_HUGETLBFS will be set in
|
|
uffdio_api.features. Similarly, UFFD_FEATURE_MISSING_SHMEM will be
|
|
set if the kernel supports registering userfaultfd ranges on shared
|
|
memory (covering all shmem APIs, i.e. tmpfs, IPCSHM, /dev/zero
|
|
MAP_SHARED, memfd_create, etc).
|
|
|
|
The userland application that wants to use userfaultfd with hugetlbfs
|
|
or shared memory need to set the corresponding flag in
|
|
uffdio_api.features to enable those features.
|
|
|
|
If the userland desires to receive notifications for events other than
|
|
page faults, it has to verify that uffdio_api.features has appropriate
|
|
UFFD_FEATURE_EVENT_* bits set. These events are described in more
|
|
detail below in "Non-cooperative userfaultfd" section.
|
|
|
|
Once the userfaultfd has been enabled the UFFDIO_REGISTER ioctl should
|
|
be invoked (if present in the returned uffdio_api.ioctls bitmask) to
|
|
register a memory range in the userfaultfd by setting the
|
|
uffdio_register structure accordingly. The uffdio_register.mode
|
|
bitmask will specify to the kernel which kind of faults to track for
|
|
the range (UFFDIO_REGISTER_MODE_MISSING would track missing
|
|
pages). The UFFDIO_REGISTER ioctl will return the
|
|
uffdio_register.ioctls bitmask of ioctls that are suitable to resolve
|
|
userfaults on the range registered. Not all ioctls will necessarily be
|
|
supported for all memory types depending on the underlying virtual
|
|
memory backend (anonymous memory vs tmpfs vs real filebacked
|
|
mappings).
|
|
|
|
Userland can use the uffdio_register.ioctls to manage the virtual
|
|
address space in the background (to add or potentially also remove
|
|
memory from the userfaultfd registered range). This means a userfault
|
|
could be triggering just before userland maps in the background the
|
|
user-faulted page.
|
|
|
|
The primary ioctl to resolve userfaults is UFFDIO_COPY. That
|
|
atomically copies a page into the userfault registered range and wakes
|
|
up the blocked userfaults (unless uffdio_copy.mode &
|
|
UFFDIO_COPY_MODE_DONTWAKE is set). Other ioctl works similarly to
|
|
UFFDIO_COPY. They're atomic as in guaranteeing that nothing can see an
|
|
half copied page since it'll keep userfaulting until the copy has
|
|
finished.
|
|
|
|
== QEMU/KVM ==
|
|
|
|
QEMU/KVM is using the userfaultfd syscall to implement postcopy live
|
|
migration. Postcopy live migration is one form of memory
|
|
externalization consisting of a virtual machine running with part or
|
|
all of its memory residing on a different node in the cloud. The
|
|
userfaultfd abstraction is generic enough that not a single line of
|
|
KVM kernel code had to be modified in order to add postcopy live
|
|
migration to QEMU.
|
|
|
|
Guest async page faults, FOLL_NOWAIT and all other GUP features work
|
|
just fine in combination with userfaults. Userfaults trigger async
|
|
page faults in the guest scheduler so those guest processes that
|
|
aren't waiting for userfaults (i.e. network bound) can keep running in
|
|
the guest vcpus.
|
|
|
|
It is generally beneficial to run one pass of precopy live migration
|
|
just before starting postcopy live migration, in order to avoid
|
|
generating userfaults for readonly guest regions.
|
|
|
|
The implementation of postcopy live migration currently uses one
|
|
single bidirectional socket but in the future two different sockets
|
|
will be used (to reduce the latency of the userfaults to the minimum
|
|
possible without having to decrease /proc/sys/net/ipv4/tcp_wmem).
|
|
|
|
The QEMU in the source node writes all pages that it knows are missing
|
|
in the destination node, into the socket, and the migration thread of
|
|
the QEMU running in the destination node runs UFFDIO_COPY|ZEROPAGE
|
|
ioctls on the userfaultfd in order to map the received pages into the
|
|
guest (UFFDIO_ZEROCOPY is used if the source page was a zero page).
|
|
|
|
A different postcopy thread in the destination node listens with
|
|
poll() to the userfaultfd in parallel. When a POLLIN event is
|
|
generated after a userfault triggers, the postcopy thread read() from
|
|
the userfaultfd and receives the fault address (or -EAGAIN in case the
|
|
userfault was already resolved and waken by a UFFDIO_COPY|ZEROPAGE run
|
|
by the parallel QEMU migration thread).
|
|
|
|
After the QEMU postcopy thread (running in the destination node) gets
|
|
the userfault address it writes the information about the missing page
|
|
into the socket. The QEMU source node receives the information and
|
|
roughly "seeks" to that page address and continues sending all
|
|
remaining missing pages from that new page offset. Soon after that
|
|
(just the time to flush the tcp_wmem queue through the network) the
|
|
migration thread in the QEMU running in the destination node will
|
|
receive the page that triggered the userfault and it'll map it as
|
|
usual with the UFFDIO_COPY|ZEROPAGE (without actually knowing if it
|
|
was spontaneously sent by the source or if it was an urgent page
|
|
requested through a userfault).
|
|
|
|
By the time the userfaults start, the QEMU in the destination node
|
|
doesn't need to keep any per-page state bitmap relative to the live
|
|
migration around and a single per-page bitmap has to be maintained in
|
|
the QEMU running in the source node to know which pages are still
|
|
missing in the destination node. The bitmap in the source node is
|
|
checked to find which missing pages to send in round robin and we seek
|
|
over it when receiving incoming userfaults. After sending each page of
|
|
course the bitmap is updated accordingly. It's also useful to avoid
|
|
sending the same page twice (in case the userfault is read by the
|
|
postcopy thread just before UFFDIO_COPY|ZEROPAGE runs in the migration
|
|
thread).
|
|
|
|
== Non-cooperative userfaultfd ==
|
|
|
|
When the userfaultfd is monitored by an external manager, the manager
|
|
must be able to track changes in the process virtual memory
|
|
layout. Userfaultfd can notify the manager about such changes using
|
|
the same read(2) protocol as for the page fault notifications. The
|
|
manager has to explicitly enable these events by setting appropriate
|
|
bits in uffdio_api.features passed to UFFDIO_API ioctl:
|
|
|
|
UFFD_FEATURE_EVENT_FORK - enable userfaultfd hooks for fork(). When
|
|
this feature is enabled, the userfaultfd context of the parent process
|
|
is duplicated into the newly created process. The manager receives
|
|
UFFD_EVENT_FORK with file descriptor of the new userfaultfd context in
|
|
the uffd_msg.fork.
|
|
|
|
UFFD_FEATURE_EVENT_REMAP - enable notifications about mremap()
|
|
calls. When the non-cooperative process moves a virtual memory area to
|
|
a different location, the manager will receive UFFD_EVENT_REMAP. The
|
|
uffd_msg.remap will contain the old and new addresses of the area and
|
|
its original length.
|
|
|
|
UFFD_FEATURE_EVENT_REMOVE - enable notifications about
|
|
madvise(MADV_REMOVE) and madvise(MADV_DONTNEED) calls. The event
|
|
UFFD_EVENT_REMOVE will be generated upon these calls to madvise. The
|
|
uffd_msg.remove will contain start and end addresses of the removed
|
|
area.
|
|
|
|
UFFD_FEATURE_EVENT_UNMAP - enable notifications about memory
|
|
unmapping. The manager will get UFFD_EVENT_UNMAP with uffd_msg.remove
|
|
containing start and end addresses of the unmapped area.
|
|
|
|
Although the UFFD_FEATURE_EVENT_REMOVE and UFFD_FEATURE_EVENT_UNMAP
|
|
are pretty similar, they quite differ in the action expected from the
|
|
userfaultfd manager. In the former case, the virtual memory is
|
|
removed, but the area is not, the area remains monitored by the
|
|
userfaultfd, and if a page fault occurs in that area it will be
|
|
delivered to the manager. The proper resolution for such page fault is
|
|
to zeromap the faulting address. However, in the latter case, when an
|
|
area is unmapped, either explicitly (with munmap() system call), or
|
|
implicitly (e.g. during mremap()), the area is removed and in turn the
|
|
userfaultfd context for such area disappears too and the manager will
|
|
not get further userland page faults from the removed area. Still, the
|
|
notification is required in order to prevent manager from using
|
|
UFFDIO_COPY on the unmapped area.
|
|
|
|
Unlike userland page faults which have to be synchronous and require
|
|
explicit or implicit wakeup, all the events are delivered
|
|
asynchronously and the non-cooperative process resumes execution as
|
|
soon as manager executes read(). The userfaultfd manager should
|
|
carefully synchronize calls to UFFDIO_COPY with the events
|
|
processing. To aid the synchronization, the UFFDIO_COPY ioctl will
|
|
return -ENOSPC when the monitored process exits at the time of
|
|
UFFDIO_COPY, and -ENOENT, when the non-cooperative process has changed
|
|
its virtual memory layout simultaneously with outstanding UFFDIO_COPY
|
|
operation.
|
|
|
|
The current asynchronous model of the event delivery is optimal for
|
|
single threaded non-cooperative userfaultfd manager implementations. A
|
|
synchronous event delivery model can be added later as a new
|
|
userfaultfd feature to facilitate multithreading enhancements of the
|
|
non cooperative manager, for example to allow UFFDIO_COPY ioctls to
|
|
run in parallel to the event reception. Single threaded
|
|
implementations should continue to use the current async event
|
|
delivery model instead.
|