UFFDIO_POISON(2const) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | STANDARDS | HISTORY | EXAMPLES | SEE ALSO | COLOPHON

UFFDIO_POISON(2const)                              UFFDIO_POISON(2const)

NAME         top

       UFFDIO_POISON - mark an address range as "poisoned"

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <linux/userfaultfd.h>  /* Definition of UFFD* constants */
       #include <sys/ioctl.h>

       int ioctl(int fd, UFFDIO_POISON, ...);

       #include <linux/userfaultfd.h>

       struct uffdio_poison {
            struct uffdio_range  range;
                              /* Range to install poison PTE markers in */
            __u64   mode;     /* Flags controlling the behavior of poison */
            __s64   updated;  /* Number of bytes poisoned, or negated error */
       };

DESCRIPTION         top

       Mark an address range as "poisoned".  Future accesses to these
       addresses will raise a SIGBUS signal.  Unlike MADV_HWPOISON this
       works by installing page table entries, rather than "really"
       poisoning the underlying physical pages.  This means it only
       affects this particular address space.

       The following value may be bitwise ORed in mode to change the
       behavior of the UFFDIO_POISON operation:

       UFFDIO_POISON_MODE_DONTWAKE
              Do not wake up the thread that waits for page-fault
              resolution.

       The updated field is used by the kernel to return the number of
       bytes that were actually poisoned, or an error in the same manner
       as UFFDIO_COPY.  If the value returned in the updated field
       doesn't match the value that was specified in range.len, the
       operation fails with the error EAGAIN.  The updated field is
       output-only; it is not read by the UFFDIO_POISON operation.

RETURN VALUE         top

       On success, 0 is returned.  In this case, the entire area was
       poisoned.

       On error, -1 is returned and errno is set to indicate the error.

ERRORS         top

       EAGAIN The number of bytes mapped (i.e., the value returned in
              the updated field) does not equal the value that was
              specified in the range.len field.

       EINVAL Either range.start or range.len was not a multiple of the
              system page size; or range.len was zero; or the range
              specified was invalid.

       EINVAL An invalid bit was specified in the mode field.

       EEXIST One or more pages were already mapped in the given range.

       ENOENT The faulting process has changed its virtual memory layout
              simultaneously with an outstanding UFFDIO_POISON
              operation.

       ENOMEM Allocating memory for page table entries failed.

       ESRCH  The faulting process has exited at the time of a
              UFFDIO_POISON operation.

STANDARDS         top

       Linux.

HISTORY         top

       Linux 6.6.

EXAMPLES         top

       See userfaultfd(2).

SEE ALSO         top

       ioctl(2), ioctl_userfaultfd(2), userfaultfd(2)

       linux.git/Documentation/admin-guide/mm/userfaultfd.rst

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       [email protected]

Linux man-pages 6.9.1          2024-06-17          UFFDIO_POISON(2const)

Pages that refer to this page: ioctl_userfaultfd(2)