Documentation/admin-guide/mm/userfaultfd.rst

   1 .. _userfaultfd:
   2
   3 ===========
   4 Userfaultfd
   5 ===========
   6
   7 Objective
   8 =========
   9
  10 Userfaults allow the implementation of on-demand paging from userland
  11 and more generally they allow userland to take control of various
  12 memory page faults, something otherwise only the kernel code could do.
  13
  14 For example userfaults allows a proper and more optimal implementation
  15 of the ``PROT_NONE+SIGSEGV`` trick.
  16
  17 Design
  18 ======
  19
  20 Userfaults are delivered and resolved through the ``userfaultfd`` syscall.
  21
  22 The ``userfaultfd`` (aside from registering and unregistering virtual
  23 memory ranges) provides two primary functionalities:
  24
  25 1) ``read/POLLIN`` protocol to notify a userland thread of the faults
  26    happening
  27
  28 2) various ``UFFDIO_*`` ioctls that can manage the virtual memory regions
  29    registered in the ``userfaultfd`` that allows userland to efficiently
  30    resolve the userfaults it receives via 1) or to manage the virtual
  31    memory in the background
  32
  33 The real advantage of userfaults if compared to regular virtual memory
  34 management of mremap/mprotect is that the userfaults in all their
  35 operations never involve heavyweight structures like vmas (in fact the
  36 ``userfaultfd`` runtime load never takes the mmap_lock for writing).
  37
  38 Vmas are not suitable for page- (or hugepage) granular fault tracking
  39 when dealing with virtual address spaces that could span
  40 Terabytes. Too many vmas would be needed for that.
  41
  42 The ``userfaultfd`` once opened by invoking the syscall, can also be
  43 passed using unix domain sockets to a manager process, so the same
  44 manager process could handle the userfaults of a multitude of
  45 different processes without them being aware about what is going on
  46 (well of course unless they later try to use the ``userfaultfd``
  47 themselves on the same region the manager is already tracking, which
  48 is a corner case that would currently return ``-EBUSY``).
  49
  50 API
  51 ===
  52
  53 When first opened the ``userfaultfd`` must be enabled invoking the
  54 ``UFFDIO_API`` ioctl specifying a ``uffdio_api.api`` value set to ``UFFD_API`` (or
  55 a later API version) which will specify the ``read/POLLIN`` protocol
  56 userland intends to speak on the ``UFFD`` and the ``uffdio_api.features``
  57 userland requires. The ``UFFDIO_API`` ioctl if successful (i.e. if the
  58 requested ``uffdio_api.api`` is spoken also by the running kernel and the
  59 requested features are going to be enabled) will return into
  60 ``uffdio_api.features`` and ``uffdio_api.ioctls`` two 64bit bitmasks of
  61 respectively all the available features of the read(2) protocol and
  62 the generic ioctl available.
  63
  64 The ``uffdio_api.features`` bitmask returned by the ``UFFDIO_API`` ioctl
  65 defines what memory types are supported by the ``userfaultfd`` and what
  66 events, except page fault notifications, may be generated:
  67
  68 - The ``UFFD_FEATURE_EVENT_*`` flags indicate that various other events
  69   other than page faults are supported. These events are described in more
  70   detail below in the `Non-cooperative userfaultfd`_ section.
  71
  72 - ``UFFD_FEATURE_MISSING_HUGETLBFS`` and ``UFFD_FEATURE_MISSING_SHMEM``
  73   indicate that the kernel supports ``UFFDIO_REGISTER_MODE_MISSING``
  74   registrations for hugetlbfs and shared memory (covering all shmem APIs,
  75   i.e. tmpfs, ``IPCSHM``, ``/dev/zero``, ``MAP_SHARED``, ``memfd_create``,
  76   etc) virtual memory areas, respectively.
  77
  78 - ``UFFD_FEATURE_MINOR_HUGETLBFS`` indicates that the kernel supports
  79   ``UFFDIO_REGISTER_MODE_MINOR`` registration for hugetlbfs virtual memory
  80   areas.
  81
  82 The userland application should set the feature flags it intends to use
  83 when invoking the ``UFFDIO_API`` ioctl, to request that those features be
  84 enabled if supported.
  85
  86 Once the ``userfaultfd`` API has been enabled the ``UFFDIO_REGISTER``
  87 ioctl should be invoked (if present in the returned ``uffdio_api.ioctls``
  88 bitmask) to register a memory range in the ``userfaultfd`` by setting the
  89 uffdio_register structure accordingly. The ``uffdio_register.mode``
  90 bitmask will specify to the kernel which kind of faults to track for
  91 the range. The ``UFFDIO_REGISTER`` ioctl will return the
  92 ``uffdio_register.ioctls`` bitmask of ioctls that are suitable to resolve
  93 userfaults on the range registered. Not all ioctls will necessarily be
  94 supported for all memory types (e.g. anonymous memory vs. shmem vs.
  95 hugetlbfs), or all types of intercepted faults.
  96
  97 Userland can use the ``uffdio_register.ioctls`` to manage the virtual
  98 address space in the background (to add or potentially also remove
  99 memory from the ``userfaultfd`` registered range). This means a userfault
 100 could be triggering just before userland maps in the background the
 101 user-faulted page.
 102
 103 Resolving Userfaults
 104 --------------------
 105
 106 There are three basic ways to resolve userfaults:
 107
 108 - ``UFFDIO_COPY`` atomically copies some existing page contents from
 109   userspace.
 110
 111 - ``UFFDIO_ZEROPAGE`` atomically zeros the new page.
 112
 113 - ``UFFDIO_CONTINUE`` maps an existing, previously-populated page.
 114
 115 These operations are atomic in the sense that they guarantee nothing can
 116 see a half-populated page, since readers will keep userfaulting until the
 117 operation has finished.
 118
 119 By default, these wake up userfaults blocked on the range in question.
 120 They support a ``UFFDIO_*_MODE_DONTWAKE`` ``mode`` flag, which indicates
 121 that waking will be done separately at some later time.
 122
 123 Which ioctl to choose depends on the kind of page fault, and what we'd
 124 like to do to resolve it:
 125
 126 - For ``UFFDIO_REGISTER_MODE_MISSING`` faults, the fault needs to be
 127   resolved by either providing a new page (``UFFDIO_COPY``), or mapping
 128   the zero page (``UFFDIO_ZEROPAGE``). By default, the kernel would map
 129   the zero page for a missing fault. With userfaultfd, userspace can
 130   decide what content to provide before the faulting thread continues.
 131
 132 - For ``UFFDIO_REGISTER_MODE_MINOR`` faults, there is an existing page (in
 133   the page cache). Userspace has the option of modifying the page's
 134   contents before resolving the fault. Once the contents are correct
 135   (modified or not), userspace asks the kernel to map the page and let the
 136   faulting thread continue with ``UFFDIO_CONTINUE``.
 137
 138 Notes:
 139
 140 - You can tell which kind of fault occurred by examining
 141   ``pagefault.flags`` within the ``uffd_msg``, checking for the
 142   ``UFFD_PAGEFAULT_FLAG_*`` flags.
 143
 144 - None of the page-delivering ioctls default to the range that you
 145   registered with.  You must fill in all fields for the appropriate
 146   ioctl struct including the range.
 147
 148 - You get the address of the access that triggered the missing page
 149   event out of a struct uffd_msg that you read in the thread from the
 150   uffd.  You can supply as many pages as you want with these IOCTLs.
 151   Keep in mind that unless you used DONTWAKE then the first of any of
 152   those IOCTLs wakes up the faulting thread.
 153
 154 - Be sure to test for all errors including
 155   (``pollfd[0].revents & POLLERR``).  This can happen, e.g. when ranges
 156   supplied were incorrect.
 157
 158 Write Protect Notifications
 159 ---------------------------
 160
 161 This is equivalent to (but faster than) using mprotect and a SIGSEGV
 162 signal handler.
 163
 164 Firstly you need to register a range with ``UFFDIO_REGISTER_MODE_WP``.
 165 Instead of using mprotect(2) you use
 166 ``ioctl(uffd, UFFDIO_WRITEPROTECT, struct *uffdio_writeprotect)``
 167 while ``mode = UFFDIO_WRITEPROTECT_MODE_WP``
 168 in the struct passed in.  The range does not default to and does not
 169 have to be identical to the range you registered with.  You can write
 170 protect as many ranges as you like (inside the registered range).
 171 Then, in the thread reading from uffd the struct will have
 172 ``msg.arg.pagefault.flags & UFFD_PAGEFAULT_FLAG_WP`` set. Now you send
 173 ``ioctl(uffd, UFFDIO_WRITEPROTECT, struct *uffdio_writeprotect)``
 174 again while ``pagefault.mode`` does not have ``UFFDIO_WRITEPROTECT_MODE_WP``
 175 set. This wakes up the thread which will continue to run with writes. This
 176 allows you to do the bookkeeping about the write in the uffd reading
 177 thread before the ioctl.
 178
 179 If you registered with both ``UFFDIO_REGISTER_MODE_MISSING`` and
 180 ``UFFDIO_REGISTER_MODE_WP`` then you need to think about the sequence in
 181 which you supply a page and undo write protect.  Note that there is a
 182 difference between writes into a WP area and into a !WP area.  The
 183 former will have ``UFFD_PAGEFAULT_FLAG_WP`` set, the latter
 184 ``UFFD_PAGEFAULT_FLAG_WRITE``.  The latter did not fail on protection but
 185 you still need to supply a page when ``UFFDIO_REGISTER_MODE_MISSING`` was
 186 used.
 187
 188 QEMU/KVM
 189 ========
 190
 191 QEMU/KVM is using the ``userfaultfd`` syscall to implement postcopy live
 192 migration. Postcopy live migration is one form of memory
 193 externalization consisting of a virtual machine running with part or
 194 all of its memory residing on a different node in the cloud. The
 195 ``userfaultfd`` abstraction is generic enough that not a single line of
 196 KVM kernel code had to be modified in order to add postcopy live
 197 migration to QEMU.
 198
 199 Guest async page faults, ``FOLL_NOWAIT`` and all other ``GUP*`` features work
 200 just fine in combination with userfaults. Userfaults trigger async
 201 page faults in the guest scheduler so those guest processes that
 202 aren't waiting for userfaults (i.e. network bound) can keep running in
 203 the guest vcpus.
 204
 205 It is generally beneficial to run one pass of precopy live migration
 206 just before starting postcopy live migration, in order to avoid
 207 generating userfaults for readonly guest regions.
 208
 209 The implementation of postcopy live migration currently uses one
 210 single bidirectional socket but in the future two different sockets
 211 will be used (to reduce the latency of the userfaults to the minimum
 212 possible without having to decrease ``/proc/sys/net/ipv4/tcp_wmem``).
 213
 214 The QEMU in the source node writes all pages that it knows are missing
 215 in the destination node, into the socket, and the migration thread of
 216 the QEMU running in the destination node runs ``UFFDIO_COPY|ZEROPAGE``
 217 ioctls on the ``userfaultfd`` in order to map the received pages into the
 218 guest (``UFFDIO_ZEROCOPY`` is used if the source page was a zero page).
 219
 220 A different postcopy thread in the destination node listens with
 221 poll() to the ``userfaultfd`` in parallel. When a ``POLLIN`` event is
 222 generated after a userfault triggers, the postcopy thread read() from
 223 the ``userfaultfd`` and receives the fault address (or ``-EAGAIN`` in case the
 224 userfault was already resolved and waken by a ``UFFDIO_COPY|ZEROPAGE`` run
 225 by the parallel QEMU migration thread).
 226
 227 After the QEMU postcopy thread (running in the destination node) gets
 228 the userfault address it writes the information about the missing page
 229 into the socket. The QEMU source node receives the information and
 230 roughly "seeks" to that page address and continues sending all
 231 remaining missing pages from that new page offset. Soon after that
 232 (just the time to flush the tcp_wmem queue through the network) the
 233 migration thread in the QEMU running in the destination node will
 234 receive the page that triggered the userfault and it'll map it as
 235 usual with the ``UFFDIO_COPY|ZEROPAGE`` (without actually knowing if it
 236 was spontaneously sent by the source or if it was an urgent page
 237 requested through a userfault).
 238
 239 By the time the userfaults start, the QEMU in the destination node
 240 doesn't need to keep any per-page state bitmap relative to the live
 241 migration around and a single per-page bitmap has to be maintained in
 242 the QEMU running in the source node to know which pages are still
 243 missing in the destination node. The bitmap in the source node is
 244 checked to find which missing pages to send in round robin and we seek
 245 over it when receiving incoming userfaults. After sending each page of
 246 course the bitmap is updated accordingly. It's also useful to avoid
 247 sending the same page twice (in case the userfault is read by the
 248 postcopy thread just before ``UFFDIO_COPY|ZEROPAGE`` runs in the migration
 249 thread).
 250
 251 Non-cooperative userfaultfd
 252 ===========================
 253
 254 When the ``userfaultfd`` is monitored by an external manager, the manager
 255 must be able to track changes in the process virtual memory
 256 layout. Userfaultfd can notify the manager about such changes using
 257 the same read(2) protocol as for the page fault notifications. The
 258 manager has to explicitly enable these events by setting appropriate
 259 bits in ``uffdio_api.features`` passed to ``UFFDIO_API`` ioctl:
 260
 261 ``UFFD_FEATURE_EVENT_FORK``
 262         enable ``userfaultfd`` hooks for fork(). When this feature is
 263         enabled, the ``userfaultfd`` context of the parent process is
 264         duplicated into the newly created process. The manager
 265         receives ``UFFD_EVENT_FORK`` with file descriptor of the new
 266         ``userfaultfd`` context in the ``uffd_msg.fork``.
 267
 268 ``UFFD_FEATURE_EVENT_REMAP``
 269         enable notifications about mremap() calls. When the
 270         non-cooperative process moves a virtual memory area to a
 271         different location, the manager will receive
 272         ``UFFD_EVENT_REMAP``. The ``uffd_msg.remap`` will contain the old and
 273         new addresses of the area and its original length.
 274
 275 ``UFFD_FEATURE_EVENT_REMOVE``
 276         enable notifications about madvise(MADV_REMOVE) and
 277         madvise(MADV_DONTNEED) calls. The event ``UFFD_EVENT_REMOVE`` will
 278         be generated upon these calls to madvise(). The ``uffd_msg.remove``
 279         will contain start and end addresses of the removed area.
 280
 281 ``UFFD_FEATURE_EVENT_UNMAP``
 282         enable notifications about memory unmapping. The manager will
 283         get ``UFFD_EVENT_UNMAP`` with ``uffd_msg.remove`` containing start and
 284         end addresses of the unmapped area.
 285
 286 Although the ``UFFD_FEATURE_EVENT_REMOVE`` and ``UFFD_FEATURE_EVENT_UNMAP``
 287 are pretty similar, they quite differ in the action expected from the
 288 ``userfaultfd`` manager. In the former case, the virtual memory is
 289 removed, but the area is not, the area remains monitored by the
 290 ``userfaultfd``, and if a page fault occurs in that area it will be
 291 delivered to the manager. The proper resolution for such page fault is
 292 to zeromap the faulting address. However, in the latter case, when an
 293 area is unmapped, either explicitly (with munmap() system call), or
 294 implicitly (e.g. during mremap()), the area is removed and in turn the
 295 ``userfaultfd`` context for such area disappears too and the manager will
 296 not get further userland page faults from the removed area. Still, the
 297 notification is required in order to prevent manager from using
 298 ``UFFDIO_COPY`` on the unmapped area.
 299
 300 Unlike userland page faults which have to be synchronous and require
 301 explicit or implicit wakeup, all the events are delivered
 302 asynchronously and the non-cooperative process resumes execution as
 303 soon as manager executes read(). The ``userfaultfd`` manager should
 304 carefully synchronize calls to ``UFFDIO_COPY`` with the events
 305 processing. To aid the synchronization, the ``UFFDIO_COPY`` ioctl will
 306 return ``-ENOSPC`` when the monitored process exits at the time of
 307 ``UFFDIO_COPY``, and ``-ENOENT``, when the non-cooperative process has changed
 308 its virtual memory layout simultaneously with outstanding ``UFFDIO_COPY``
 309 operation.
 310
 311 The current asynchronous model of the event delivery is optimal for
 312 single threaded non-cooperative ``userfaultfd`` manager implementations. A
 313 synchronous event delivery model can be added later as a new
 314 ``userfaultfd`` feature to facilitate multithreading enhancements of the
 315 non cooperative manager, for example to allow ``UFFDIO_COPY`` ioctls to
 316 run in parallel to the event reception. Single threaded
 317 implementations should continue to use the current async event
 318 delivery model instead.