blob: ae572c1386073cce6c57807c47dc3d4694af0f03 [file] [log] [blame]
Hiro Yoshiokac22ce142006-06-23 02:04:16 -07001#ifndef __LINUX_UACCESS_H__
2#define __LINUX_UACCESS_H__
3
David Hildenbrand8bcbde52015-05-11 17:52:06 +02004#include <linux/sched.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -07005#include <asm/uaccess.h>
6
David Hildenbrand8bcbde52015-05-11 17:52:06 +02007static __always_inline void pagefault_disabled_inc(void)
8{
9 current->pagefault_disabled++;
10}
11
12static __always_inline void pagefault_disabled_dec(void)
13{
14 current->pagefault_disabled--;
15 WARN_ON(current->pagefault_disabled < 0);
16}
17
Peter Zijlstraa8663742006-12-06 20:32:20 -080018/*
David Hildenbrand8bcbde52015-05-11 17:52:06 +020019 * These routines enable/disable the pagefault handler. If disabled, it will
20 * not take any locks and go straight to the fixup table.
Peter Zijlstraa8663742006-12-06 20:32:20 -080021 *
David Hildenbrand8222dbe2015-05-11 17:52:20 +020022 * User access methods will not sleep when called from a pagefault_disabled()
23 * environment.
Peter Zijlstraa8663742006-12-06 20:32:20 -080024 */
25static inline void pagefault_disable(void)
26{
David Hildenbrand8bcbde52015-05-11 17:52:06 +020027 pagefault_disabled_inc();
Peter Zijlstraa8663742006-12-06 20:32:20 -080028 /*
29 * make sure to have issued the store before a pagefault
30 * can hit.
31 */
32 barrier();
33}
34
35static inline void pagefault_enable(void)
36{
37 /*
38 * make sure to issue those last loads/stores before enabling
39 * the pagefault handler again.
40 */
41 barrier();
David Hildenbrand8bcbde52015-05-11 17:52:06 +020042 pagefault_disabled_dec();
Peter Zijlstraa8663742006-12-06 20:32:20 -080043}
44
David Hildenbrand8bcbde52015-05-11 17:52:06 +020045/*
46 * Is the pagefault handler disabled? If so, user access methods will not sleep.
47 */
48#define pagefault_disabled() (current->pagefault_disabled != 0)
49
David Hildenbrand70ffdb92015-05-11 17:52:11 +020050/*
51 * The pagefault handler is in general disabled by pagefault_disable() or
52 * when in irq context (via in_atomic()).
53 *
54 * This function should only be used by the fault handlers. Other users should
55 * stick to pagefault_disabled().
56 * Please NEVER use preempt_disable() to disable the fault handler. With
57 * !CONFIG_PREEMPT_COUNT, this is like a NOP. So the handler won't be disabled.
58 * in_atomic() will report different values based on !CONFIG_PREEMPT_COUNT.
59 */
60#define faulthandler_disabled() (pagefault_disabled() || in_atomic())
61
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070062#ifndef ARCH_HAS_NOCACHE_UACCESS
63
64static inline unsigned long __copy_from_user_inatomic_nocache(void *to,
65 const void __user *from, unsigned long n)
66{
67 return __copy_from_user_inatomic(to, from, n);
68}
69
70static inline unsigned long __copy_from_user_nocache(void *to,
71 const void __user *from, unsigned long n)
72{
73 return __copy_from_user(to, from, n);
74}
75
76#endif /* ARCH_HAS_NOCACHE_UACCESS */
77
Andrew Morton1b79e552006-09-27 01:51:14 -070078/**
79 * probe_kernel_address(): safely attempt to read from a location
80 * @addr: address to read from - its type is type typeof(retval)*
81 * @retval: read into this variable
82 *
83 * Safely read from address @addr into variable @revtal. If a kernel fault
84 * happens, handle that and return -EFAULT.
85 * We ensure that the __get_user() is executed in atomic context so that
86 * do_page_fault() doesn't attempt to take mmap_sem. This makes
87 * probe_kernel_address() suitable for use within regions where the caller
88 * already holds mmap_sem, or other locks which nest inside mmap_sem.
Andrew Morton20aa7b22006-12-06 20:36:40 -080089 * This must be a macro because __get_user() needs to know the types of the
90 * args.
91 *
92 * We don't include enough header files to be able to do the set_fs(). We
93 * require that the probe_kernel_address() caller will do that.
Andrew Morton1b79e552006-09-27 01:51:14 -070094 */
95#define probe_kernel_address(addr, retval) \
96 ({ \
97 long ret; \
Andrew Morton20aa7b22006-12-06 20:36:40 -080098 mm_segment_t old_fs = get_fs(); \
Andrew Morton1b79e552006-09-27 01:51:14 -070099 \
Andrew Morton20aa7b22006-12-06 20:36:40 -0800100 set_fs(KERNEL_DS); \
Peter Zijlstraa8663742006-12-06 20:32:20 -0800101 pagefault_disable(); \
Hiroshi Shimamotofb71e452008-09-15 18:04:26 -0700102 ret = __copy_from_user_inatomic(&(retval), (__force typeof(retval) __user *)(addr), sizeof(retval)); \
Peter Zijlstraa8663742006-12-06 20:32:20 -0800103 pagefault_enable(); \
Andrew Morton20aa7b22006-12-06 20:36:40 -0800104 set_fs(old_fs); \
Andrew Morton1b79e552006-09-27 01:51:14 -0700105 ret; \
106 })
107
Ingo Molnarc33fa9f2008-04-17 20:05:36 +0200108/*
109 * probe_kernel_read(): safely attempt to read from a location
110 * @dst: pointer to the buffer that shall take the data
111 * @src: address to read from
112 * @size: size of the data chunk
113 *
114 * Safely read from address @src to the buffer at @dst. If a kernel fault
115 * happens, handle that and return -EFAULT.
116 */
Steven Rostedtf29c5042011-05-19 14:35:33 -0400117extern long probe_kernel_read(void *dst, const void *src, size_t size);
118extern long __probe_kernel_read(void *dst, const void *src, size_t size);
Ingo Molnarc33fa9f2008-04-17 20:05:36 +0200119
120/*
121 * probe_kernel_write(): safely attempt to write to a location
122 * @dst: address to write to
123 * @src: pointer to the data that shall be written
124 * @size: size of the data chunk
125 *
126 * Safely write to address @dst from the buffer at @src. If a kernel fault
127 * happens, handle that and return -EFAULT.
128 */
Steven Rostedtf29c5042011-05-19 14:35:33 -0400129extern long notrace probe_kernel_write(void *dst, const void *src, size_t size);
130extern long notrace __probe_kernel_write(void *dst, const void *src, size_t size);
Ingo Molnarc33fa9f2008-04-17 20:05:36 +0200131
Hiro Yoshiokac22ce142006-06-23 02:04:16 -0700132#endif /* __LINUX_UACCESS_H__ */