include/asm-ppc64/uaccess.h

   1 #ifndef _PPC64_UACCESS_H
   2 #define _PPC64_UACCESS_H
   3
   4 /*
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version
   8  * 2 of the License, or (at your option) any later version.
   9  */
  10
  11 #ifndef __ASSEMBLY__
  12 #include <linux/sched.h>
  13 #include <linux/errno.h>
  14 #include <asm/processor.h>
  15
  16 #define VERIFY_READ     0
  17 #define VERIFY_WRITE    1
  18
  19 /*
  20  * The fs value determines whether argument validity checking should be
  21  * performed or not.  If get_fs() == USER_DS, checking is performed, with
  22  * get_fs() == KERNEL_DS, checking is bypassed.
  23  *
  24  * For historical reasons, these macros are grossly misnamed.
  25  */
  26
  27 #define MAKE_MM_SEG(s)  ((mm_segment_t) { (s) })
  28
  29 #define KERNEL_DS       MAKE_MM_SEG(0UL)
  30 #define USER_DS         MAKE_MM_SEG(0xf000000000000000UL)
  31
  32 #define get_ds()        (KERNEL_DS)
  33 #define get_fs()        (current->thread.fs)
  34 #define set_fs(val)     (current->thread.fs = (val))
  35
  36 #define segment_eq(a,b) ((a).seg == (b).seg)
  37
  38 /*
  39  * Use the alpha trick for checking ranges:
  40  *
  41  * Is a address valid? This does a straightforward calculation rather
  42  * than tests.
  43  *
  44  * Address valid if:
  45  *  - "addr" doesn't have any high-bits set
  46  *  - AND "size" doesn't have any high-bits set
  47  *  - OR we are in kernel mode.
  48  *
  49  * We dont have to check for high bits in (addr+size) because the first
  50  * two checks force the maximum result to be below the start of the
  51  * kernel region.
  52  */
  53 #define __access_ok(addr,size,segment) \
  54         (((segment).seg & (addr | size )) == 0)
  55
  56 #define access_ok(type,addr,size) \
  57         __access_ok(((__force unsigned long)(addr)),(size),get_fs())
  58
  59 static inline int verify_area(int type, const void __user *addr, unsigned long size)
  60 {
  61         return access_ok(type,addr,size) ? 0 : -EFAULT;
  62 }
  63
  64
  65 /*
  66  * The exception table consists of pairs of addresses: the first is the
  67  * address of an instruction that is allowed to fault, and the second is
  68  * the address at which the program should continue.  No registers are
  69  * modified, so it is entirely up to the continuation code to figure out
  70  * what to do.
  71  *
  72  * All the routines below use bits of fixup code that are out of line
  73  * with the main instruction path.  This means when everything is well,
  74  * we don't even have to jump over them.  Further, they do not intrude
  75  * on our cache or tlb entries.
  76  */
  77
  78 struct exception_table_entry
  79 {
  80         unsigned long insn, fixup;
  81 };
  82
  83 /* Returns 0 if exception not found and fixup otherwise.  */
  84 extern unsigned long search_exception_table(unsigned long);
  85
  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  * As we use the same address space for kernel and user data on the
 101  * PowerPC, we can just do these as direct assignments.  (Of course, the
 102  * exception handling means that it's no longer "just"...)
 103  */
 104 #define get_user(x,ptr) \
 105   __get_user_check((x),(ptr),sizeof(*(ptr)))
 106 #define put_user(x,ptr) \
 107   __put_user_check((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
 108
 109 #define __get_user(x,ptr) \
 110   __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
 111 #define __put_user(x,ptr) \
 112   __put_user_nocheck((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
 113
 114 #define __get_user_unaligned __get_user
 115 #define __put_user_unaligned __put_user
 116
 117 extern long __put_user_bad(void);
 118
 119 #define __put_user_nocheck(x,ptr,size)                          \
 120 ({                                                              \
 121         long __pu_err;                                          \
 122         __chk_user_ptr(ptr);                                    \
 123         __put_user_size((x),(ptr),(size),__pu_err,-EFAULT);     \
 124         __pu_err;                                               \
 125 })
 126
 127 #define __put_user_check(x,ptr,size)                                    \
 128 ({                                                                      \
 129         long __pu_err = -EFAULT;                                        \
 130         void __user *__pu_addr = (ptr);                                 \
 131         if (access_ok(VERIFY_WRITE,__pu_addr,size))                     \
 132                 __put_user_size((x),__pu_addr,(size),__pu_err,-EFAULT); \
 133         __pu_err;                                                       \
 134 })
 135
 136 #define __put_user_size(x,ptr,size,retval,errret)                       \
 137 do {                                                                    \
 138         might_sleep();                                                  \
 139         retval = 0;                                                     \
 140         switch (size) {                                                 \
 141           case 1: __put_user_asm(x,ptr,retval,"stb",errret); break;     \
 142           case 2: __put_user_asm(x,ptr,retval,"sth",errret); break;     \
 143           case 4: __put_user_asm(x,ptr,retval,"stw",errret); break;     \
 144           case 8: __put_user_asm(x,ptr,retval,"std",errret); break;     \
 145           default: __put_user_bad();                                    \
 146         }                                                               \
 147 } while (0)
 148
 149 /*
 150  * We don't tell gcc that we are accessing memory, but this is OK
 151  * because we do not write to any memory gcc knows about, so there
 152  * are no aliasing issues.
 153  */
 154 #define __put_user_asm(x, addr, err, op, errret)                \
 155         __asm__ __volatile__(                                   \
 156                 "1:     "op" %1,0(%2)   # put_user\n"           \
 157                 "2:\n"                                          \
 158                 ".section .fixup,\"ax\"\n"                      \
 159                 "3:     li %0,%3\n"                             \
 160                 "       b 2b\n"                                 \
 161                 ".previous\n"                                   \
 162                 ".section __ex_table,\"a\"\n"                   \
 163                 "       .align 3\n"                             \
 164                 "       .llong 1b,3b\n"                         \
 165                 ".previous"                                     \
 166                 : "=r"(err)                                     \
 167                 : "r"(x), "b"(addr), "i"(errret), "0"(err))
 168
 169
 170 #define __get_user_nocheck(x,ptr,size)                          \
 171 ({                                                              \
 172         long __gu_err, __gu_val;                                \
 173         __get_user_size(__gu_val,(ptr),(size),__gu_err,-EFAULT);\
 174         (x) = (__typeof__(*(ptr)))__gu_val;                     \
 175         __gu_err;                                               \
 176 })
 177
 178 #define __get_user_check(x,ptr,size)                                    \
 179 ({                                                                      \
 180         long __gu_err = -EFAULT, __gu_val = 0;                          \
 181         const __typeof__(*(ptr)) __user *__gu_addr = (ptr);             \
 182         if (access_ok(VERIFY_READ,__gu_addr,size))                      \
 183                 __get_user_size(__gu_val,__gu_addr,(size),__gu_err,-EFAULT);\
 184         (x) = (__typeof__(*(ptr)))__gu_val;                             \
 185         __gu_err;                                                       \
 186 })
 187
 188 extern long __get_user_bad(void);
 189
 190 #define __get_user_size(x,ptr,size,retval,errret)                       \
 191 do {                                                                    \
 192         might_sleep();                                                  \
 193         retval = 0;                                                     \
 194         __chk_user_ptr(ptr);                                            \
 195         switch (size) {                                                 \
 196           case 1: __get_user_asm(x,ptr,retval,"lbz",errret); break;     \
 197           case 2: __get_user_asm(x,ptr,retval,"lhz",errret); break;     \
 198           case 4: __get_user_asm(x,ptr,retval,"lwz",errret); break;     \
 199           case 8: __get_user_asm(x,ptr,retval,"ld",errret);  break;     \
 200           default: (x) = __get_user_bad();                              \
 201         }                                                               \
 202 } while (0)
 203
 204 #define __get_user_asm(x, addr, err, op, errret)        \
 205         __asm__ __volatile__(                           \
 206                 "1:     "op" %1,0(%2)   # get_user\n"   \
 207                 "2:\n"                                  \
 208                 ".section .fixup,\"ax\"\n"              \
 209                 "3:     li %0,%3\n"                     \
 210                 "       li %1,0\n"                      \
 211                 "       b 2b\n"                         \
 212                 ".previous\n"                           \
 213                 ".section __ex_table,\"a\"\n"           \
 214                 "       .align 3\n"                     \
 215                 "       .llong 1b,3b\n"                 \
 216                 ".previous"                             \
 217                 : "=r"(err), "=r"(x)                    \
 218                 : "b"(addr), "i"(errret), "0"(err))
 219
 220 /* more complex routines */
 221
 222 extern unsigned long __copy_tofrom_user(void __user *to, const void __user *from,
 223                                         unsigned long size);
 224
 225 static inline unsigned long
 226 __copy_from_user(void *to, const void __user *from, unsigned long n)
 227 {
 228         might_sleep();
 229         if (__builtin_constant_p(n)) {
 230                 unsigned long ret;
 231
 232                 switch (n) {
 233                 case 1:
 234                         __get_user_size(*(u8 *)to, from, 1, ret, 1);
 235                         return ret;
 236                 case 2:
 237                         __get_user_size(*(u16 *)to, from, 2, ret, 2);
 238                         return ret;
 239                 case 4:
 240                         __get_user_size(*(u32 *)to, from, 4, ret, 4);
 241                         return ret;
 242                 case 8:
 243                         __get_user_size(*(u64 *)to, from, 8, ret, 8);
 244                         return ret;
 245                 }
 246         }
 247         return __copy_tofrom_user((__force void __user *) to, from, n);
 248 }
 249
 250 static inline unsigned long
 251 __copy_to_user(void __user *to, const void *from, unsigned long n)
 252 {
 253         might_sleep();
 254         if (__builtin_constant_p(n)) {
 255                 unsigned long ret;
 256
 257                 switch (n) {
 258                 case 1:
 259                         __put_user_size(*(u8 *)from, (u8 __user *)to, 1, ret, 1);
 260                         return ret;
 261                 case 2:
 262                         __put_user_size(*(u16 *)from, (u16 __user *)to, 2, ret, 2);
 263                         return ret;
 264                 case 4:
 265                         __put_user_size(*(u32 *)from, (u32 __user *)to, 4, ret, 4);
 266                         return ret;
 267                 case 8:
 268                         __put_user_size(*(u64 *)from, (u64 __user *)to, 8, ret, 8);
 269                         return ret;
 270                 }
 271         }
 272         return __copy_tofrom_user(to, (__force const void __user *) from, n);
 273 }
 274
 275 #define __copy_in_user(to, from, size) \
 276         __copy_tofrom_user((to), (from), (size))
 277
 278 extern unsigned long copy_from_user(void *to, const void __user *from,
 279                                     unsigned long n);
 280 extern unsigned long copy_to_user(void __user *to, const void *from,
 281                                   unsigned long n);
 282 extern unsigned long copy_in_user(void __user *to, const void __user *from,
 283                                   unsigned long n);
 284
 285 extern unsigned long __clear_user(void __user *addr, unsigned long size);
 286
 287 #define __copy_to_user_inatomic __copy_to_user
 288 #define __copy_from_user_inatomic __copy_from_user
 289
 290 static inline unsigned long
 291 clear_user(void __user *addr, unsigned long size)
 292 {
 293         might_sleep();
 294         if (likely(access_ok(VERIFY_WRITE, addr, size)))
 295                 size = __clear_user(addr, size);
 296         return size;
 297 }
 298
 299 extern int __strncpy_from_user(char *dst, const char __user *src, long count);
 300
 301 static inline long
 302 strncpy_from_user(char *dst, const char __user *src, long count)
 303 {
 304         might_sleep();
 305         if (likely(access_ok(VERIFY_READ, src, 1)))
 306                 return __strncpy_from_user(dst, src, count);
 307         return -EFAULT;
 308 }
 309
 310 /*
 311  * Return the size of a string (including the ending 0)
 312  *
 313  * Return 0 for error
 314  */
 315 extern int __strnlen_user(const char __user *str, long len);
 316
 317 /*
 318  * Returns the length of the string at str (including the null byte),
 319  * or 0 if we hit a page we can't access,
 320  * or something > len if we didn't find a null byte.
 321  */
 322 static inline int strnlen_user(const char __user *str, long len)
 323 {
 324         might_sleep();
 325         if (likely(access_ok(VERIFY_READ, str, 1)))
 326                 return __strnlen_user(str, len);
 327         return 0;
 328 }
 329
 330 #define strlen_user(str)        strnlen_user((str), 0x7ffffffe)
 331
 332 #endif  /* __ASSEMBLY__ */
 333
 334 #endif  /* _PPC64_UACCESS_H */