uaccess.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582
  1. #ifndef _ASM_X86_UACCESS_H
  2. #define _ASM_X86_UACCESS_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/string.h>
  10. #include <asm/asm.h>
  11. #include <asm/page.h>
  12. #define VERIFY_READ 0
  13. #define VERIFY_WRITE 1
  14. /*
  15. * The fs value determines whether argument validity checking should be
  16. * performed or not. If get_fs() == USER_DS, checking is performed, with
  17. * get_fs() == KERNEL_DS, checking is bypassed.
  18. *
  19. * For historical reasons, these macros are grossly misnamed.
  20. */
  21. #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
  22. #define KERNEL_DS MAKE_MM_SEG(-1UL)
  23. #define USER_DS MAKE_MM_SEG(TASK_SIZE_MAX)
  24. #define get_ds() (KERNEL_DS)
  25. #define get_fs() (current_thread_info()->addr_limit)
  26. #define set_fs(x) (current_thread_info()->addr_limit = (x))
  27. #define segment_eq(a, b) ((a).seg == (b).seg)
  28. #define __addr_ok(addr) \
  29. ((unsigned long __force)(addr) < \
  30. (current_thread_info()->addr_limit.seg))
  31. /*
  32. * Test whether a block of memory is a valid user space address.
  33. * Returns 0 if the range is valid, nonzero otherwise.
  34. *
  35. * This is equivalent to the following test:
  36. * (u33)addr + (u33)size > (u33)current->addr_limit.seg (u65 for x86_64)
  37. *
  38. * This needs 33-bit (65-bit for x86_64) arithmetic. We have a carry...
  39. */
  40. #define __range_not_ok(addr, size) \
  41. ({ \
  42. unsigned long flag, roksum; \
  43. __chk_user_ptr(addr); \
  44. asm("add %3,%1 ; sbb %0,%0 ; cmp %1,%4 ; sbb $0,%0" \
  45. : "=&r" (flag), "=r" (roksum) \
  46. : "1" (addr), "g" ((long)(size)), \
  47. "rm" (current_thread_info()->addr_limit.seg)); \
  48. flag; \
  49. })
  50. /**
  51. * access_ok: - Checks if a user space pointer is valid
  52. * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
  53. * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
  54. * to write to a block, it is always safe to read from it.
  55. * @addr: User space pointer to start of block to check
  56. * @size: Size of block to check
  57. *
  58. * Context: User context only. This function may sleep.
  59. *
  60. * Checks if a pointer to a block of memory in user space is valid.
  61. *
  62. * Returns true (nonzero) if the memory block may be valid, false (zero)
  63. * if it is definitely invalid.
  64. *
  65. * Note that, depending on architecture, this function probably just
  66. * checks that the pointer is in the user space range - after calling
  67. * this function, memory access functions may still return -EFAULT.
  68. */
  69. #define access_ok(type, addr, size) (likely(__range_not_ok(addr, size) == 0))
  70. /*
  71. * The exception table consists of pairs of addresses: the first is the
  72. * address of an instruction that is allowed to fault, and the second is
  73. * the address at which the program should continue. No registers are
  74. * modified, so it is entirely up to the continuation code to figure out
  75. * what to do.
  76. *
  77. * All the routines below use bits of fixup code that are out of line
  78. * with the main instruction path. This means when everything is well,
  79. * we don't even have to jump over them. Further, they do not intrude
  80. * on our cache or tlb entries.
  81. */
  82. struct exception_table_entry {
  83. unsigned long insn, fixup;
  84. };
  85. extern int fixup_exception(struct pt_regs *regs);
  86. /*
  87. * These are the main single-value transfer routines. They automatically
  88. * use the right size if we just have the right pointer type.
  89. *
  90. * This gets kind of ugly. We want to return _two_ values in "get_user()"
  91. * and yet we don't want to do any pointers, because that is too much
  92. * of a performance impact. Thus we have a few rather ugly macros here,
  93. * and hide all the ugliness from the user.
  94. *
  95. * The "__xxx" versions of the user access functions are versions that
  96. * do not verify the address space, that must have been done previously
  97. * with a separate "access_ok()" call (this is used when we do multiple
  98. * accesses to the same area of user memory).
  99. */
  100. extern int __get_user_1(void);
  101. extern int __get_user_2(void);
  102. extern int __get_user_4(void);
  103. extern int __get_user_8(void);
  104. extern int __get_user_bad(void);
  105. #define __get_user_x(size, ret, x, ptr) \
  106. asm volatile("call __get_user_" #size \
  107. : "=a" (ret), "=d" (x) \
  108. : "0" (ptr)) \
  109. /* Careful: we have to cast the result to the type of the pointer
  110. * for sign reasons */
  111. /**
  112. * get_user: - Get a simple variable from user space.
  113. * @x: Variable to store result.
  114. * @ptr: Source address, in user space.
  115. *
  116. * Context: User context only. This function may sleep.
  117. *
  118. * This macro copies a single simple variable from user space to kernel
  119. * space. It supports simple types like char and int, but not larger
  120. * data types like structures or arrays.
  121. *
  122. * @ptr must have pointer-to-simple-variable type, and the result of
  123. * dereferencing @ptr must be assignable to @x without a cast.
  124. *
  125. * Returns zero on success, or -EFAULT on error.
  126. * On error, the variable @x is set to zero.
  127. */
  128. #ifdef CONFIG_X86_32
  129. #define __get_user_8(__ret_gu, __val_gu, ptr) \
  130. __get_user_x(X, __ret_gu, __val_gu, ptr)
  131. #else
  132. #define __get_user_8(__ret_gu, __val_gu, ptr) \
  133. __get_user_x(8, __ret_gu, __val_gu, ptr)
  134. #endif
  135. #define get_user(x, ptr) \
  136. ({ \
  137. int __ret_gu; \
  138. unsigned long __val_gu; \
  139. __chk_user_ptr(ptr); \
  140. might_fault(); \
  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. #define __put_user_x(size, x, ptr, __ret_pu) \
  162. asm volatile("call __put_user_" #size : "=a" (__ret_pu) \
  163. : "0" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
  164. #ifdef CONFIG_X86_32
  165. #define __put_user_asm_u64(x, addr, err, errret) \
  166. asm volatile("1: movl %%eax,0(%2)\n" \
  167. "2: movl %%edx,4(%2)\n" \
  168. "3:\n" \
  169. ".section .fixup,\"ax\"\n" \
  170. "4: movl %3,%0\n" \
  171. " jmp 3b\n" \
  172. ".previous\n" \
  173. _ASM_EXTABLE(1b, 4b) \
  174. _ASM_EXTABLE(2b, 4b) \
  175. : "=r" (err) \
  176. : "A" (x), "r" (addr), "i" (errret), "0" (err))
  177. #define __put_user_asm_ex_u64(x, addr) \
  178. asm volatile("1: movl %%eax,0(%1)\n" \
  179. "2: movl %%edx,4(%1)\n" \
  180. "3:\n" \
  181. _ASM_EXTABLE(1b, 2b - 1b) \
  182. _ASM_EXTABLE(2b, 3b - 2b) \
  183. : : "A" (x), "r" (addr))
  184. #define __put_user_x8(x, ptr, __ret_pu) \
  185. asm volatile("call __put_user_8" : "=a" (__ret_pu) \
  186. : "A" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
  187. #else
  188. #define __put_user_asm_u64(x, ptr, retval, errret) \
  189. __put_user_asm(x, ptr, retval, "q", "", "er", errret)
  190. #define __put_user_asm_ex_u64(x, addr) \
  191. __put_user_asm_ex(x, addr, "q", "", "er")
  192. #define __put_user_x8(x, ptr, __ret_pu) __put_user_x(8, x, ptr, __ret_pu)
  193. #endif
  194. extern void __put_user_bad(void);
  195. /*
  196. * Strange magic calling convention: pointer in %ecx,
  197. * value in %eax(:%edx), return value in %eax. clobbers %rbx
  198. */
  199. extern void __put_user_1(void);
  200. extern void __put_user_2(void);
  201. extern void __put_user_4(void);
  202. extern void __put_user_8(void);
  203. #ifdef CONFIG_X86_WP_WORKS_OK
  204. /**
  205. * put_user: - Write a simple value into user space.
  206. * @x: Value to copy to user space.
  207. * @ptr: Destination address, in user space.
  208. *
  209. * Context: User context only. This function may sleep.
  210. *
  211. * This macro copies a single simple value from kernel space to user
  212. * space. It supports simple types like char and int, but not larger
  213. * data types like structures or arrays.
  214. *
  215. * @ptr must have pointer-to-simple-variable type, and @x must be assignable
  216. * to the result of dereferencing @ptr.
  217. *
  218. * Returns zero on success, or -EFAULT on error.
  219. */
  220. #define put_user(x, ptr) \
  221. ({ \
  222. int __ret_pu; \
  223. __typeof__(*(ptr)) __pu_val; \
  224. __chk_user_ptr(ptr); \
  225. might_fault(); \
  226. __pu_val = x; \
  227. switch (sizeof(*(ptr))) { \
  228. case 1: \
  229. __put_user_x(1, __pu_val, ptr, __ret_pu); \
  230. break; \
  231. case 2: \
  232. __put_user_x(2, __pu_val, ptr, __ret_pu); \
  233. break; \
  234. case 4: \
  235. __put_user_x(4, __pu_val, ptr, __ret_pu); \
  236. break; \
  237. case 8: \
  238. __put_user_x8(__pu_val, ptr, __ret_pu); \
  239. break; \
  240. default: \
  241. __put_user_x(X, __pu_val, ptr, __ret_pu); \
  242. break; \
  243. } \
  244. __ret_pu; \
  245. })
  246. #define __put_user_size(x, ptr, size, retval, errret) \
  247. do { \
  248. retval = 0; \
  249. __chk_user_ptr(ptr); \
  250. switch (size) { \
  251. case 1: \
  252. __put_user_asm(x, ptr, retval, "b", "b", "iq", errret); \
  253. break; \
  254. case 2: \
  255. __put_user_asm(x, ptr, retval, "w", "w", "ir", errret); \
  256. break; \
  257. case 4: \
  258. __put_user_asm(x, ptr, retval, "l", "k", "ir", errret); \
  259. break; \
  260. case 8: \
  261. __put_user_asm_u64((__typeof__(*ptr))(x), ptr, retval, \
  262. errret); \
  263. break; \
  264. default: \
  265. __put_user_bad(); \
  266. } \
  267. } while (0)
  268. #define __put_user_size_ex(x, ptr, size) \
  269. do { \
  270. __chk_user_ptr(ptr); \
  271. switch (size) { \
  272. case 1: \
  273. __put_user_asm_ex(x, ptr, "b", "b", "iq"); \
  274. break; \
  275. case 2: \
  276. __put_user_asm_ex(x, ptr, "w", "w", "ir"); \
  277. break; \
  278. case 4: \
  279. __put_user_asm_ex(x, ptr, "l", "k", "ir"); \
  280. break; \
  281. case 8: \
  282. __put_user_asm_ex_u64((__typeof__(*ptr))(x), ptr); \
  283. break; \
  284. default: \
  285. __put_user_bad(); \
  286. } \
  287. } while (0)
  288. #else
  289. #define __put_user_size(x, ptr, size, retval, errret) \
  290. do { \
  291. __typeof__(*(ptr))__pus_tmp = x; \
  292. retval = 0; \
  293. \
  294. if (unlikely(__copy_to_user_ll(ptr, &__pus_tmp, size) != 0)) \
  295. retval = errret; \
  296. } while (0)
  297. #define put_user(x, ptr) \
  298. ({ \
  299. int __ret_pu; \
  300. __typeof__(*(ptr))__pus_tmp = x; \
  301. __ret_pu = 0; \
  302. if (unlikely(__copy_to_user_ll(ptr, &__pus_tmp, \
  303. sizeof(*(ptr))) != 0)) \
  304. __ret_pu = -EFAULT; \
  305. __ret_pu; \
  306. })
  307. #endif
  308. #ifdef CONFIG_X86_32
  309. #define __get_user_asm_u64(x, ptr, retval, errret) (x) = __get_user_bad()
  310. #define __get_user_asm_ex_u64(x, ptr) (x) = __get_user_bad()
  311. #else
  312. #define __get_user_asm_u64(x, ptr, retval, errret) \
  313. __get_user_asm(x, ptr, retval, "q", "", "=r", errret)
  314. #define __get_user_asm_ex_u64(x, ptr) \
  315. __get_user_asm_ex(x, ptr, "q", "", "=r")
  316. #endif
  317. #define __get_user_size(x, ptr, size, retval, errret) \
  318. do { \
  319. retval = 0; \
  320. __chk_user_ptr(ptr); \
  321. switch (size) { \
  322. case 1: \
  323. __get_user_asm(x, ptr, retval, "b", "b", "=q", errret); \
  324. break; \
  325. case 2: \
  326. __get_user_asm(x, ptr, retval, "w", "w", "=r", errret); \
  327. break; \
  328. case 4: \
  329. __get_user_asm(x, ptr, retval, "l", "k", "=r", errret); \
  330. break; \
  331. case 8: \
  332. __get_user_asm_u64(x, ptr, retval, errret); \
  333. break; \
  334. default: \
  335. (x) = __get_user_bad(); \
  336. } \
  337. } while (0)
  338. #define __get_user_asm(x, addr, err, itype, rtype, ltype, errret) \
  339. asm volatile("1: mov"itype" %2,%"rtype"1\n" \
  340. "2:\n" \
  341. ".section .fixup,\"ax\"\n" \
  342. "3: mov %3,%0\n" \
  343. " xor"itype" %"rtype"1,%"rtype"1\n" \
  344. " jmp 2b\n" \
  345. ".previous\n" \
  346. _ASM_EXTABLE(1b, 3b) \
  347. : "=r" (err), ltype(x) \
  348. : "m" (__m(addr)), "i" (errret), "0" (err))
  349. #define __get_user_size_ex(x, ptr, size) \
  350. do { \
  351. __chk_user_ptr(ptr); \
  352. switch (size) { \
  353. case 1: \
  354. __get_user_asm_ex(x, ptr, "b", "b", "=q"); \
  355. break; \
  356. case 2: \
  357. __get_user_asm_ex(x, ptr, "w", "w", "=r"); \
  358. break; \
  359. case 4: \
  360. __get_user_asm_ex(x, ptr, "l", "k", "=r"); \
  361. break; \
  362. case 8: \
  363. __get_user_asm_ex_u64(x, ptr); \
  364. break; \
  365. default: \
  366. (x) = __get_user_bad(); \
  367. } \
  368. } while (0)
  369. #define __get_user_asm_ex(x, addr, itype, rtype, ltype) \
  370. asm volatile("1: mov"itype" %1,%"rtype"0\n" \
  371. "2:\n" \
  372. _ASM_EXTABLE(1b, 2b - 1b) \
  373. : ltype(x) : "m" (__m(addr)))
  374. #define __put_user_nocheck(x, ptr, size) \
  375. ({ \
  376. int __pu_err; \
  377. __put_user_size((x), (ptr), (size), __pu_err, -EFAULT); \
  378. __pu_err; \
  379. })
  380. #define __get_user_nocheck(x, ptr, size) \
  381. ({ \
  382. int __gu_err; \
  383. unsigned long __gu_val; \
  384. __get_user_size(__gu_val, (ptr), (size), __gu_err, -EFAULT); \
  385. (x) = (__force __typeof__(*(ptr)))__gu_val; \
  386. __gu_err; \
  387. })
  388. /* FIXME: this hack is definitely wrong -AK */
  389. struct __large_struct { unsigned long buf[100]; };
  390. #define __m(x) (*(struct __large_struct __user *)(x))
  391. /*
  392. * Tell gcc we read from memory instead of writing: this is because
  393. * we do not write to any memory gcc knows about, so there are no
  394. * aliasing issues.
  395. */
  396. #define __put_user_asm(x, addr, err, itype, rtype, ltype, errret) \
  397. asm volatile("1: mov"itype" %"rtype"1,%2\n" \
  398. "2:\n" \
  399. ".section .fixup,\"ax\"\n" \
  400. "3: mov %3,%0\n" \
  401. " jmp 2b\n" \
  402. ".previous\n" \
  403. _ASM_EXTABLE(1b, 3b) \
  404. : "=r"(err) \
  405. : ltype(x), "m" (__m(addr)), "i" (errret), "0" (err))
  406. #define __put_user_asm_ex(x, addr, itype, rtype, ltype) \
  407. asm volatile("1: mov"itype" %"rtype"0,%1\n" \
  408. "2:\n" \
  409. _ASM_EXTABLE(1b, 2b - 1b) \
  410. : : ltype(x), "m" (__m(addr)))
  411. /*
  412. * uaccess_try and catch
  413. */
  414. #define uaccess_try do { \
  415. int prev_err = current_thread_info()->uaccess_err; \
  416. current_thread_info()->uaccess_err = 0; \
  417. barrier();
  418. #define uaccess_catch(err) \
  419. (err) |= (current_thread_info()->uaccess_err ? -EFAULT : 0); \
  420. current_thread_info()->uaccess_err = prev_err; \
  421. } while (0)
  422. /**
  423. * __get_user: - Get a simple variable from user space, with less checking.
  424. * @x: Variable to store result.
  425. * @ptr: Source address, in user space.
  426. *
  427. * Context: User context only. This function may sleep.
  428. *
  429. * This macro copies a single simple variable from user space to kernel
  430. * space. It supports simple types like char and int, but not larger
  431. * data types like structures or arrays.
  432. *
  433. * @ptr must have pointer-to-simple-variable type, and the result of
  434. * dereferencing @ptr must be assignable to @x without a cast.
  435. *
  436. * Caller must check the pointer with access_ok() before calling this
  437. * function.
  438. *
  439. * Returns zero on success, or -EFAULT on error.
  440. * On error, the variable @x is set to zero.
  441. */
  442. #define __get_user(x, ptr) \
  443. __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
  444. /**
  445. * __put_user: - Write a simple value into user space, with less checking.
  446. * @x: Value to copy to user space.
  447. * @ptr: Destination address, in user space.
  448. *
  449. * Context: User context only. This function may sleep.
  450. *
  451. * This macro copies a single simple value from kernel space to user
  452. * space. It supports simple types like char and int, but not larger
  453. * data types like structures or arrays.
  454. *
  455. * @ptr must have pointer-to-simple-variable type, and @x must be assignable
  456. * to the result of dereferencing @ptr.
  457. *
  458. * Caller must check the pointer with access_ok() before calling this
  459. * function.
  460. *
  461. * Returns zero on success, or -EFAULT on error.
  462. */
  463. #define __put_user(x, ptr) \
  464. __put_user_nocheck((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
  465. #define __get_user_unaligned __get_user
  466. #define __put_user_unaligned __put_user
  467. /*
  468. * {get|put}_user_try and catch
  469. *
  470. * get_user_try {
  471. * get_user_ex(...);
  472. * } get_user_catch(err)
  473. */
  474. #define get_user_try uaccess_try
  475. #define get_user_catch(err) uaccess_catch(err)
  476. #define get_user_ex(x, ptr) do { \
  477. unsigned long __gue_val; \
  478. __get_user_size_ex((__gue_val), (ptr), (sizeof(*(ptr)))); \
  479. (x) = (__force __typeof__(*(ptr)))__gue_val; \
  480. } while (0)
  481. #ifdef CONFIG_X86_WP_WORKS_OK
  482. #define put_user_try uaccess_try
  483. #define put_user_catch(err) uaccess_catch(err)
  484. #define put_user_ex(x, ptr) \
  485. __put_user_size_ex((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
  486. #else /* !CONFIG_X86_WP_WORKS_OK */
  487. #define put_user_try do { \
  488. int __uaccess_err = 0;
  489. #define put_user_catch(err) \
  490. (err) |= __uaccess_err; \
  491. } while (0)
  492. #define put_user_ex(x, ptr) do { \
  493. __uaccess_err |= __put_user(x, ptr); \
  494. } while (0)
  495. #endif /* CONFIG_X86_WP_WORKS_OK */
  496. extern unsigned long
  497. copy_from_user_nmi(void *to, const void __user *from, unsigned long n);
  498. extern __must_check long
  499. strncpy_from_user(char *dst, const char __user *src, long count);
  500. /*
  501. * movsl can be slow when source and dest are not both 8-byte aligned
  502. */
  503. #ifdef CONFIG_X86_INTEL_USERCOPY
  504. extern struct movsl_mask {
  505. int mask;
  506. } ____cacheline_aligned_in_smp movsl_mask;
  507. #endif
  508. #define ARCH_HAS_NOCACHE_UACCESS 1
  509. #ifdef CONFIG_X86_32
  510. # include "uaccess_32.h"
  511. #else
  512. # include "uaccess_64.h"
  513. #endif
  514. #endif /* _ASM_X86_UACCESS_H */