1 /* $Id: uaccess.h,v 1.24 2001/10/30 04:32:24 davem Exp $
2 * uaccess.h: User space memore access functions.
4 * Copyright (C) 1996 David S. Miller (davem@caip.rutgers.edu)
5 * Copyright (C) 1996,1997 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
11 #include <linux/compiler.h>
12 #include <linux/sched.h>
13 #include <linux/string.h>
14 #include <linux/errno.h>
15 #include <asm/vac-ops.h>
16 #include <asm/a.out.h>
21 /* Sparc is not segmented, however we need to be able to fool verify_area()
22 * when doing system calls from kernel mode legitimately.
24 * "For historical reasons, these macros are grossly misnamed." -Linus
27 #define KERNEL_DS ((mm_segment_t) { 0 })
28 #define USER_DS ((mm_segment_t) { -1 })
31 #define VERIFY_WRITE 1
33 #define get_ds() (KERNEL_DS)
34 #define get_fs() (current->thread.current_ds)
35 #define set_fs(val) ((current->thread.current_ds) = (val))
37 #define segment_eq(a,b) ((a).seg == (b).seg)
39 /* We have there a nice not-mapped page at PAGE_OFFSET - PAGE_SIZE, so that this test
40 * can be fairly lightweight.
41 * No one can read/write anything from userland in the kernel space by setting
42 * large size and address near to PAGE_OFFSET - a fault will break his intentions.
44 #define __user_ok(addr,size) ((addr) < STACK_TOP)
45 #define __kernel_ok (segment_eq(get_fs(), KERNEL_DS))
46 #define __access_ok(addr,size) (__user_ok((addr) & get_fs().seg,(size)))
47 #define access_ok(type,addr,size) __access_ok((unsigned long)(addr),(size))
49 static inline int verify_area(int type, const void __user * addr, unsigned long size)
51 return access_ok(type,addr,size)?0:-EFAULT;
55 * The exception table consists of pairs of addresses: the first is the
56 * address of an instruction that is allowed to fault, and the second is
57 * the address at which the program should continue. No registers are
58 * modified, so it is entirely up to the continuation code to figure out
61 * All the routines below use bits of fixup code that are out of line
62 * with the main instruction path. This means when everything is well,
63 * we don't even have to jump over them. Further, they do not intrude
64 * on our cache or tlb entries.
66 * There is a special way how to put a range of potentially faulting
67 * insns (like twenty ldd/std's with now intervening other instructions)
68 * You specify address of first in insn and 0 in fixup and in the next
69 * exception_table_entry you specify last potentially faulting insn + 1
70 * and in fixup the routine which should handle the fault.
71 * That fixup code will get
72 * (faulting_insn_address - first_insn_in_the_range_address)/4
73 * in %g2 (ie. index of the faulting instruction in the range).
76 struct exception_table_entry
78 unsigned long insn, fixup;
81 /* Returns 0 if exception not found and fixup otherwise. */
82 extern unsigned long search_extables_range(unsigned long addr, unsigned long *g2);
84 extern void __ret_efault(void);
86 extern long not_a_user_address;
87 #define check_user_ptr(x) \
88 (void) ({ void __user * __userptr = (__typeof__(*(x)) *)¬_a_user_address; __userptr; })
90 /* Uh, these should become the main single-value transfer routines..
91 * They automatically use the right size if we just have the right
94 * This gets kind of ugly. We want to return _two_ values in "get_user()"
95 * and yet we don't want to do any pointers, because that is too much
96 * of a performance impact. Thus we have a few rather ugly macros here,
97 * and hide all the ugliness from the user.
99 #define put_user(x,ptr) ({ \
100 unsigned long __pu_addr = (unsigned long)(ptr); \
101 check_user_ptr(ptr); \
102 __put_user_check((__typeof__(*(ptr)))(x),__pu_addr,sizeof(*(ptr))); })
104 #define get_user(x,ptr) ({ \
105 unsigned long __gu_addr = (unsigned long)(ptr); \
106 check_user_ptr(ptr); \
107 __get_user_check((x),__gu_addr,sizeof(*(ptr)),__typeof__(*(ptr))); })
110 * The "__xxx" versions do not do address space checking, useful when
111 * doing multiple accesses to the same area (the user has to do the
112 * checks by hand with "access_ok()")
114 #define __put_user(x,ptr) __put_user_nocheck((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
115 #define __get_user(x,ptr) __get_user_nocheck((x),(ptr),sizeof(*(ptr)),__typeof__(*(ptr)))
117 struct __large_struct { unsigned long buf[100]; };
118 #define __m(x) ((struct __large_struct *)(x))
120 #define __put_user_check(x,addr,size) ({ \
121 register int __pu_ret; \
122 if (__access_ok(addr,size)) { \
124 case 1: __put_user_asm(x,b,addr,__pu_ret); break; \
125 case 2: __put_user_asm(x,h,addr,__pu_ret); break; \
126 case 4: __put_user_asm(x,,addr,__pu_ret); break; \
127 case 8: __put_user_asm(x,d,addr,__pu_ret); break; \
128 default: __pu_ret = __put_user_bad(); break; \
129 } } else { __pu_ret = -EFAULT; } __pu_ret; })
131 #define __put_user_check_ret(x,addr,size,retval) ({ \
132 register int __foo __asm__ ("l1"); \
133 if (__access_ok(addr,size)) { \
135 case 1: __put_user_asm_ret(x,b,addr,retval,__foo); break; \
136 case 2: __put_user_asm_ret(x,h,addr,retval,__foo); break; \
137 case 4: __put_user_asm_ret(x,,addr,retval,__foo); break; \
138 case 8: __put_user_asm_ret(x,d,addr,retval,__foo); break; \
139 default: if (__put_user_bad()) return retval; break; \
140 } } else return retval; })
142 #define __put_user_nocheck(x,addr,size) ({ \
143 register int __pu_ret; \
145 case 1: __put_user_asm(x,b,addr,__pu_ret); break; \
146 case 2: __put_user_asm(x,h,addr,__pu_ret); break; \
147 case 4: __put_user_asm(x,,addr,__pu_ret); break; \
148 case 8: __put_user_asm(x,d,addr,__pu_ret); break; \
149 default: __pu_ret = __put_user_bad(); break; \
152 #define __put_user_nocheck_ret(x,addr,size,retval) ({ \
153 register int __foo __asm__ ("l1"); \
155 case 1: __put_user_asm_ret(x,b,addr,retval,__foo); break; \
156 case 2: __put_user_asm_ret(x,h,addr,retval,__foo); break; \
157 case 4: __put_user_asm_ret(x,,addr,retval,__foo); break; \
158 case 8: __put_user_asm_ret(x,d,addr,retval,__foo); break; \
159 default: if (__put_user_bad()) return retval; break; \
162 #define __put_user_asm(x,size,addr,ret) \
163 __asm__ __volatile__( \
164 "/* Put user asm, inline. */\n" \
165 "1:\t" "st"#size " %1, %2\n\t" \
168 ".section .fixup,#alloc,#execinstr\n\t" \
174 ".section __ex_table,#alloc\n\t" \
178 : "=&r" (ret) : "r" (x), "m" (*__m(addr)), \
181 #define __put_user_asm_ret(x,size,addr,ret,foo) \
182 if (__builtin_constant_p(ret) && ret == -EFAULT) \
183 __asm__ __volatile__( \
184 "/* Put user asm ret, inline. */\n" \
185 "1:\t" "st"#size " %1, %2\n\n\t" \
186 ".section __ex_table,#alloc\n\t" \
188 ".word 1b, __ret_efault\n\n\t" \
190 : "=r" (foo) : "r" (x), "m" (*__m(addr))); \
192 __asm__ __volatile( \
193 "/* Put user asm ret, inline. */\n" \
194 "1:\t" "st"#size " %1, %2\n\n\t" \
195 ".section .fixup,#alloc,#execinstr\n\t" \
199 " restore %%g0, %3, %%o0\n\t" \
201 ".section __ex_table,#alloc\n\t" \
203 ".word 1b, 3b\n\n\t" \
205 : "=r" (foo) : "r" (x), "m" (*__m(addr)), "i" (ret))
207 extern int __put_user_bad(void);
209 #define __get_user_check(x,addr,size,type) ({ \
210 register int __gu_ret; \
211 register unsigned long __gu_val; \
212 if (__access_ok(addr,size)) { \
214 case 1: __get_user_asm(__gu_val,ub,addr,__gu_ret); break; \
215 case 2: __get_user_asm(__gu_val,uh,addr,__gu_ret); break; \
216 case 4: __get_user_asm(__gu_val,,addr,__gu_ret); break; \
217 case 8: __get_user_asm(__gu_val,d,addr,__gu_ret); break; \
218 default: __gu_val = 0; __gu_ret = __get_user_bad(); break; \
219 } } else { __gu_val = 0; __gu_ret = -EFAULT; } x = (type) __gu_val; __gu_ret; })
221 #define __get_user_check_ret(x,addr,size,type,retval) ({ \
222 register unsigned long __gu_val __asm__ ("l1"); \
223 if (__access_ok(addr,size)) { \
225 case 1: __get_user_asm_ret(__gu_val,ub,addr,retval); break; \
226 case 2: __get_user_asm_ret(__gu_val,uh,addr,retval); break; \
227 case 4: __get_user_asm_ret(__gu_val,,addr,retval); break; \
228 case 8: __get_user_asm_ret(__gu_val,d,addr,retval); break; \
229 default: if (__get_user_bad()) return retval; \
230 } x = (type) __gu_val; } else return retval; })
232 #define __get_user_nocheck(x,addr,size,type) ({ \
233 register int __gu_ret; \
234 register unsigned long __gu_val; \
236 case 1: __get_user_asm(__gu_val,ub,addr,__gu_ret); break; \
237 case 2: __get_user_asm(__gu_val,uh,addr,__gu_ret); break; \
238 case 4: __get_user_asm(__gu_val,,addr,__gu_ret); break; \
239 case 8: __get_user_asm(__gu_val,d,addr,__gu_ret); break; \
240 default: __gu_val = 0; __gu_ret = __get_user_bad(); break; \
241 } x = (type) __gu_val; __gu_ret; })
243 #define __get_user_nocheck_ret(x,addr,size,type,retval) ({ \
244 register unsigned long __gu_val __asm__ ("l1"); \
246 case 1: __get_user_asm_ret(__gu_val,ub,addr,retval); break; \
247 case 2: __get_user_asm_ret(__gu_val,uh,addr,retval); break; \
248 case 4: __get_user_asm_ret(__gu_val,,addr,retval); break; \
249 case 8: __get_user_asm_ret(__gu_val,d,addr,retval); break; \
250 default: if (__get_user_bad()) return retval; \
251 } x = (type) __gu_val; })
253 #define __get_user_asm(x,size,addr,ret) \
254 __asm__ __volatile__( \
255 "/* Get user asm, inline. */\n" \
256 "1:\t" "ld"#size " %2, %1\n\t" \
259 ".section .fixup,#alloc,#execinstr\n\t" \
264 " mov %3, %0\n\n\t" \
266 ".section __ex_table,#alloc\n\t" \
268 ".word 1b, 3b\n\n\t" \
270 : "=&r" (ret), "=&r" (x) : "m" (*__m(addr)), \
273 #define __get_user_asm_ret(x,size,addr,retval) \
274 if (__builtin_constant_p(retval) && retval == -EFAULT) \
275 __asm__ __volatile__( \
276 "/* Get user asm ret, inline. */\n" \
277 "1:\t" "ld"#size " %1, %0\n\n\t" \
278 ".section __ex_table,#alloc\n\t" \
280 ".word 1b,__ret_efault\n\n\t" \
282 : "=&r" (x) : "m" (*__m(addr))); \
284 __asm__ __volatile__( \
285 "/* Get user asm ret, inline. */\n" \
286 "1:\t" "ld"#size " %1, %0\n\n\t" \
287 ".section .fixup,#alloc,#execinstr\n\t" \
291 " restore %%g0, %2, %%o0\n\n\t" \
293 ".section __ex_table,#alloc\n\t" \
295 ".word 1b, 3b\n\n\t" \
297 : "=&r" (x) : "m" (*__m(addr)), "i" (retval))
299 extern int __get_user_bad(void);
301 extern unsigned long __copy_user(void __user *to, const void __user *from, unsigned long size);
303 static inline unsigned long copy_to_user(void __user *to, const void *from, unsigned long n)
305 if (n && __access_ok((unsigned long) to, n))
306 return __copy_user(to, (void __user *) from, n);
311 static inline unsigned long __copy_to_user(void __user *to, const void *from, unsigned long n)
313 return __copy_user(to, (void __user *) from, n);
316 static inline unsigned long copy_from_user(void *to, const void __user *from, unsigned long n)
318 if (n && __access_ok((unsigned long) from, n))
319 return __copy_user((void __user *) to, from, n);
324 static inline unsigned long __copy_from_user(void *to, const void __user *from, unsigned long n)
326 return __copy_user((void __user *) to, from, n);
329 static inline unsigned long __clear_user(void __user *addr, unsigned long size)
333 __asm__ __volatile__ (
334 ".section __ex_table,#alloc\n\t"
343 : "=r" (ret) : "r" (addr), "r" (size) :
344 "o0", "o1", "o2", "o3", "o4", "o5", "o7",
345 "g1", "g2", "g3", "g4", "g5", "g7", "cc");
350 static inline unsigned long clear_user(void __user *addr, unsigned long n)
352 if (n && __access_ok((unsigned long) addr, n))
353 return __clear_user(addr, n);
358 extern long __strncpy_from_user(char *dest, const char __user *src, long count);
360 static inline long strncpy_from_user(char *dest, const char __user *src, long count)
362 if (__access_ok((unsigned long) src, count))
363 return __strncpy_from_user(dest, src, count);
368 extern long __strlen_user(const char __user *);
369 extern long __strnlen_user(const char __user *, long len);
371 static inline long strlen_user(const char __user *str)
373 if (!access_ok(VERIFY_READ, str, 0))
376 return __strlen_user(str);
379 static inline long strnlen_user(const char __user *str, long len)
381 if (!access_ok(VERIFY_READ, str, 0))
384 return __strnlen_user(str, len);
387 #endif /* __ASSEMBLY__ */
389 #endif /* _ASM_UACCESS_H */