uaccess.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. #ifndef _ASM_UACCES_H_
  2. #define _ASM_UACCES_H_
  3. /*
  4. * User space memory access functions
  5. */
  6. #include <linux/errno.h>
  7. #include <linux/compiler.h>
  8. #include <linux/thread_info.h>
  9. #include <linux/prefetch.h>
  10. #include <linux/string.h>
  11. #include <asm/asm.h>
  12. #include <asm/page.h>
  13. #define VERIFY_READ 0
  14. #define VERIFY_WRITE 1
  15. /*
  16. * The fs value determines whether argument validity checking should be
  17. * performed or not. If get_fs() == USER_DS, checking is performed, with
  18. * get_fs() == KERNEL_DS, checking is bypassed.
  19. *
  20. * For historical reasons, these macros are grossly misnamed.
  21. */
  22. #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
  23. #define KERNEL_DS MAKE_MM_SEG(-1UL)
  24. #define USER_DS MAKE_MM_SEG(PAGE_OFFSET)
  25. #define get_ds() (KERNEL_DS)
  26. #define get_fs() (current_thread_info()->addr_limit)
  27. #define set_fs(x) (current_thread_info()->addr_limit = (x))
  28. #define segment_eq(a, b) ((a).seg == (b).seg)
  29. #define __addr_ok(addr) \
  30. ((unsigned long __force)(addr) < \
  31. (current_thread_info()->addr_limit.seg))
  32. /*
  33. * Test whether a block of memory is a valid user space address.
  34. * Returns 0 if the range is valid, nonzero otherwise.
  35. *
  36. * This is equivalent to the following test:
  37. * (u33)addr + (u33)size >= (u33)current->addr_limit.seg (u65 for x86_64)
  38. *
  39. * This needs 33-bit (65-bit for x86_64) arithmetic. We have a carry...
  40. */
  41. #define __range_not_ok(addr, size) \
  42. ({ \
  43. unsigned long flag, roksum; \
  44. __chk_user_ptr(addr); \
  45. asm("add %3,%1 ; sbb %0,%0 ; cmp %1,%4 ; sbb $0,%0" \
  46. : "=&r" (flag), "=r" (roksum) \
  47. : "1" (addr), "g" ((long)(size)), \
  48. "rm" (current_thread_info()->addr_limit.seg)); \
  49. flag; \
  50. })
  51. /**
  52. * access_ok: - Checks if a user space pointer is valid
  53. * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
  54. * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
  55. * to write to a block, it is always safe to read from it.
  56. * @addr: User space pointer to start of block to check
  57. * @size: Size of block to check
  58. *
  59. * Context: User context only. This function may sleep.
  60. *
  61. * Checks if a pointer to a block of memory in user space is valid.
  62. *
  63. * Returns true (nonzero) if the memory block may be valid, false (zero)
  64. * if it is definitely invalid.
  65. *
  66. * Note that, depending on architecture, this function probably just
  67. * checks that the pointer is in the user space range - after calling
  68. * this function, memory access functions may still return -EFAULT.
  69. */
  70. #define access_ok(type, addr, size) (likely(__range_not_ok(addr, size) == 0))
  71. /*
  72. * The exception table consists of pairs of addresses: the first is the
  73. * address of an instruction that is allowed to fault, and the second is
  74. * the address at which the program should continue. No registers are
  75. * modified, so it is entirely up to the continuation code to figure out
  76. * what to do.
  77. *
  78. * All the routines below use bits of fixup code that are out of line
  79. * with the main instruction path. This means when everything is well,
  80. * we don't even have to jump over them. Further, they do not intrude
  81. * on our cache or tlb entries.
  82. */
  83. struct exception_table_entry {
  84. unsigned long insn, fixup;
  85. };
  86. extern int fixup_exception(struct pt_regs *regs);
  87. /*
  88. * These are the main single-value transfer routines. They automatically
  89. * use the right size if we just have the right pointer type.
  90. *
  91. * This gets kind of ugly. We want to return _two_ values in "get_user()"
  92. * and yet we don't want to do any pointers, because that is too much
  93. * of a performance impact. Thus we have a few rather ugly macros here,
  94. * and hide all the ugliness from the user.
  95. *
  96. * The "__xxx" versions of the user access functions are versions that
  97. * do not verify the address space, that must have been done previously
  98. * with a separate "access_ok()" call (this is used when we do multiple
  99. * accesses to the same area of user memory).
  100. */
  101. extern int __get_user_1(void);
  102. extern int __get_user_2(void);
  103. extern int __get_user_4(void);
  104. extern int __get_user_8(void);
  105. extern int __get_user_bad(void);
  106. #define __get_user_x(size, ret, x, ptr) \
  107. asm volatile("call __get_user_" #size \
  108. : "=a" (ret),"=d" (x) \
  109. : "0" (ptr)) \
  110. /* Careful: we have to cast the result to the type of the pointer
  111. * for sign reasons */
  112. /**
  113. * get_user: - Get a simple variable from user space.
  114. * @x: Variable to store result.
  115. * @ptr: Source address, in user space.
  116. *
  117. * Context: User context only. This function may sleep.
  118. *
  119. * This macro copies a single simple variable from user space to kernel
  120. * space. It supports simple types like char and int, but not larger
  121. * data types like structures or arrays.
  122. *
  123. * @ptr must have pointer-to-simple-variable type, and the result of
  124. * dereferencing @ptr must be assignable to @x without a cast.
  125. *
  126. * Returns zero on success, or -EFAULT on error.
  127. * On error, the variable @x is set to zero.
  128. */
  129. #ifdef CONFIG_X86_32
  130. #define __get_user_8(__ret_gu, __val_gu, ptr) \
  131. __get_user_x(X, __ret_gu, __val_gu, ptr)
  132. #else
  133. #define __get_user_8(__ret_gu, __val_gu, ptr) \
  134. __get_user_x(8, __ret_gu, __val_gu, ptr)
  135. #endif
  136. #define get_user(x, ptr) \
  137. ({ \
  138. int __ret_gu; \
  139. unsigned long __val_gu; \
  140. __chk_user_ptr(ptr); \
  141. switch (sizeof(*(ptr))) { \
  142. case 1: \
  143. __get_user_x(1, __ret_gu, __val_gu, ptr); \
  144. break; \
  145. case 2: \
  146. __get_user_x(2, __ret_gu, __val_gu, ptr); \
  147. break; \
  148. case 4: \
  149. __get_user_x(4, __ret_gu, __val_gu, ptr); \
  150. break; \
  151. case 8: \
  152. __get_user_8(__ret_gu, __val_gu, ptr); \
  153. break; \
  154. default: \
  155. __get_user_x(X, __ret_gu, __val_gu, ptr); \
  156. break; \
  157. } \
  158. (x) = (__typeof__(*(ptr)))__val_gu; \
  159. __ret_gu; \
  160. })
  161. #ifdef CONFIG_X86_32
  162. # include "uaccess_32.h"
  163. #else
  164. # include "uaccess_64.h"
  165. #endif
  166. #endif