userfaultfd.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /*
  2. * include/linux/userfaultfd.h
  3. *
  4. * Copyright (C) 2007 Davide Libenzi <davidel@xmailserver.org>
  5. * Copyright (C) 2015 Red Hat, Inc.
  6. *
  7. */
  8. #ifndef _LINUX_USERFAULTFD_H
  9. #define _LINUX_USERFAULTFD_H
  10. #include <linux/types.h>
  11. #define UFFD_API ((__u64)0xAA)
  12. /* FIXME: add "|UFFD_FEATURE_WP" to UFFD_API_FEATURES after implementing it */
  13. #define UFFD_API_FEATURES (UFFD_FEATURE_WRITE_BIT)
  14. #define UFFD_API_IOCTLS \
  15. ((__u64)1 << _UFFDIO_REGISTER | \
  16. (__u64)1 << _UFFDIO_UNREGISTER | \
  17. (__u64)1 << _UFFDIO_API)
  18. #define UFFD_API_RANGE_IOCTLS \
  19. ((__u64)1 << _UFFDIO_WAKE)
  20. /*
  21. * Valid ioctl command number range with this API is from 0x00 to
  22. * 0x3F. UFFDIO_API is the fixed number, everything else can be
  23. * changed by implementing a different UFFD_API. If sticking to the
  24. * same UFFD_API more ioctl can be added and userland will be aware of
  25. * which ioctl the running kernel implements through the ioctl command
  26. * bitmask written by the UFFDIO_API.
  27. */
  28. #define _UFFDIO_REGISTER (0x00)
  29. #define _UFFDIO_UNREGISTER (0x01)
  30. #define _UFFDIO_WAKE (0x02)
  31. #define _UFFDIO_API (0x3F)
  32. /* userfaultfd ioctl ids */
  33. #define UFFDIO 0xAA
  34. #define UFFDIO_API _IOWR(UFFDIO, _UFFDIO_API, \
  35. struct uffdio_api)
  36. #define UFFDIO_REGISTER _IOWR(UFFDIO, _UFFDIO_REGISTER, \
  37. struct uffdio_register)
  38. #define UFFDIO_UNREGISTER _IOR(UFFDIO, _UFFDIO_UNREGISTER, \
  39. struct uffdio_range)
  40. #define UFFDIO_WAKE _IOR(UFFDIO, _UFFDIO_WAKE, \
  41. struct uffdio_range)
  42. /*
  43. * Valid bits below PAGE_SHIFT in the userfault address read through
  44. * the read() syscall.
  45. */
  46. #define UFFD_BIT_WRITE (1<<0) /* this was a write fault, MISSING or WP */
  47. #define UFFD_BIT_WP (1<<1) /* handle_userfault() reason VM_UFFD_WP */
  48. #define UFFD_BITS 2 /* two above bits used for UFFD_BIT_* mask */
  49. /*
  50. * Features reported in uffdio_api.features field
  51. */
  52. #define UFFD_FEATURE_WRITE_BIT (1<<0) /* Corresponds to UFFD_BIT_WRITE */
  53. #define UFFD_FEATURE_WP_BIT (1<<1) /* Corresponds to UFFD_BIT_WP */
  54. struct uffdio_api {
  55. /* userland asks for an API number */
  56. __u64 api;
  57. /* kernel answers below with the available features for the API */
  58. __u64 features;
  59. __u64 ioctls;
  60. };
  61. struct uffdio_range {
  62. __u64 start;
  63. __u64 len;
  64. };
  65. struct uffdio_register {
  66. struct uffdio_range range;
  67. #define UFFDIO_REGISTER_MODE_MISSING ((__u64)1<<0)
  68. #define UFFDIO_REGISTER_MODE_WP ((__u64)1<<1)
  69. __u64 mode;
  70. /*
  71. * kernel answers which ioctl commands are available for the
  72. * range, keep at the end as the last 8 bytes aren't read.
  73. */
  74. __u64 ioctls;
  75. };
  76. #endif /* _LINUX_USERFAULTFD_H */