include/asm-i386/uaccess.h

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