arch/ia64/include/asm/uaccess.h

   1 #ifndef _ASM_IA64_UACCESS_H
   2 #define _ASM_IA64_UACCESS_H
   3
   4 /*
   5  * This file defines various macros to transfer memory areas across
   6  * the user/kernel boundary.  This needs to be done carefully because
   7  * this code is executed in kernel mode and uses user-specified
   8  * addresses.  Thus, we need to be careful not to let the user to
   9  * trick us into accessing kernel memory that would normally be
  10  * inaccessible.  This code is also fairly performance sensitive,
  11  * so we want to spend as little time doing safety checks as
  12  * possible.
  13  *
  14  * To make matters a bit more interesting, these macros sometimes also
  15  * called from within the kernel itself, in which case the address
  16  * validity check must be skipped.  The get_fs() macro tells us what
  17  * to do: if get_fs()==USER_DS, checking is performed, if
  18  * get_fs()==KERNEL_DS, checking is bypassed.
  19  *
  20  * Note that even if the memory area specified by the user is in a
  21  * valid address range, it is still possible that we'll get a page
  22  * fault while accessing it.  This is handled by filling out an
  23  * exception handler fixup entry for each instruction that has the
  24  * potential to fault.  When such a fault occurs, the page fault
  25  * handler checks to see whether the faulting instruction has a fixup
  26  * associated and, if so, sets r8 to -EFAULT and clears r9 to 0 and
  27  * then resumes execution at the continuation point.
  28  *
  29  * Based on <asm-alpha/uaccess.h>.
  30  *
  31  * Copyright (C) 1998, 1999, 2001-2004 Hewlett-Packard Co
  32  *      David Mosberger-Tang <davidm@hpl.hp.com>
  33  */
  34
  35 #include <linux/compiler.h>
  36 #include <linux/errno.h>
  37 #include <linux/sched.h>
  38 #include <linux/page-flags.h>
  39 #include <linux/mm.h>
  40
  41 #include <asm/intrinsics.h>
  42 #include <asm/pgtable.h>
  43 #include <asm/io.h>
  44
  45 /*
  46  * For historical reasons, the following macros are grossly misnamed:
  47  */
  48 #define KERNEL_DS       ((mm_segment_t) { ~0UL })               /* cf. access_ok() */
  49 #define USER_DS         ((mm_segment_t) { TASK_SIZE-1 })        /* cf. access_ok() */
  50
  51 #define get_ds()  (KERNEL_DS)
  52 #define get_fs()  (current_thread_info()->addr_limit)
  53 #define set_fs(x) (current_thread_info()->addr_limit = (x))
  54
  55 #define segment_eq(a, b)        ((a).seg == (b).seg)
  56
  57 /*
  58  * When accessing user memory, we need to make sure the entire area really is in
  59  * user-level space.  In order to do this efficiently, we make sure that the page at
  60  * address TASK_SIZE is never valid.  We also need to make sure that the address doesn't
  61  * point inside the virtually mapped linear page table.
  62  */
  63 #define __access_ok(addr, size, segment)                                                \
  64 ({                                                                                      \
  65         __chk_user_ptr(addr);                                                           \
  66         (likely((unsigned long) (addr) <= (segment).seg)                                \
  67          && ((segment).seg == KERNEL_DS.seg                                             \
  68              || likely(REGION_OFFSET((unsigned long) (addr)) < RGN_MAP_LIMIT)));        \
  69 })
  70 #define access_ok(type, addr, size)     __access_ok((addr), (size), get_fs())
  71
  72 /*
  73  * These are the main single-value transfer routines.  They automatically
  74  * use the right size if we just have the right pointer type.
  75  *
  76  * Careful to not
  77  * (a) re-use the arguments for side effects (sizeof/typeof is ok)
  78  * (b) require any knowledge of processes at this stage
  79  */
  80 #define put_user(x, ptr)        __put_user_check((__typeof__(*(ptr))) (x), (ptr), sizeof(*(ptr)), get_fs())
  81 #define get_user(x, ptr)        __get_user_check((x), (ptr), sizeof(*(ptr)), get_fs())
  82
  83 /*
  84  * The "__xxx" versions do not do address space checking, useful when
  85  * doing multiple accesses to the same area (the programmer has to do the
  86  * checks by hand with "access_ok()")
  87  */
  88 #define __put_user(x, ptr)      __put_user_nocheck((__typeof__(*(ptr))) (x), (ptr), sizeof(*(ptr)))
  89 #define __get_user(x, ptr)      __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
  90
  91 extern long __put_user_unaligned_unknown (void);
  92
  93 #define __put_user_unaligned(x, ptr)                                                            \
  94 ({                                                                                              \
  95         long __ret;                                                                             \
  96         switch (sizeof(*(ptr))) {                                                               \
  97                 case 1: __ret = __put_user((x), (ptr)); break;                                  \
  98                 case 2: __ret = (__put_user((x), (u8 __user *)(ptr)))                           \
  99                         | (__put_user((x) >> 8, ((u8 __user *)(ptr) + 1))); break;              \
 100                 case 4: __ret = (__put_user((x), (u16 __user *)(ptr)))                          \
 101                         | (__put_user((x) >> 16, ((u16 __user *)(ptr) + 1))); break;            \
 102                 case 8: __ret = (__put_user((x), (u32 __user *)(ptr)))                          \
 103                         | (__put_user((x) >> 32, ((u32 __user *)(ptr) + 1))); break;            \
 104                 default: __ret = __put_user_unaligned_unknown();                                \
 105         }                                                                                       \
 106         __ret;                                                                                  \
 107 })
 108
 109 extern long __get_user_unaligned_unknown (void);
 110
 111 #define __get_user_unaligned(x, ptr)                                                            \
 112 ({                                                                                              \
 113         long __ret;                                                                             \
 114         switch (sizeof(*(ptr))) {                                                               \
 115                 case 1: __ret = __get_user((x), (ptr)); break;                                  \
 116                 case 2: __ret = (__get_user((x), (u8 __user *)(ptr)))                           \
 117                         | (__get_user((x) >> 8, ((u8 __user *)(ptr) + 1))); break;              \
 118                 case 4: __ret = (__get_user((x), (u16 __user *)(ptr)))                          \
 119                         | (__get_user((x) >> 16, ((u16 __user *)(ptr) + 1))); break;            \
 120                 case 8: __ret = (__get_user((x), (u32 __user *)(ptr)))                          \
 121                         | (__get_user((x) >> 32, ((u32 __user *)(ptr) + 1))); break;            \
 122                 default: __ret = __get_user_unaligned_unknown();                                \
 123         }                                                                                       \
 124         __ret;                                                                                  \
 125 })
 126
 127 #ifdef ASM_SUPPORTED
 128   struct __large_struct { unsigned long buf[100]; };
 129 # define __m(x) (*(struct __large_struct __user *)(x))
 130
 131 /* We need to declare the __ex_table section before we can use it in .xdata.  */
 132 asm (".section \"__ex_table\", \"a\"\n\t.previous");
 133
 134 # define __get_user_size(val, addr, n, err)                                                     \
 135 do {                                                                                            \
 136         register long __gu_r8 asm ("r8") = 0;                                                   \
 137         register long __gu_r9 asm ("r9");                                                       \
 138         asm ("\n[1:]\tld"#n" %0=%2%P2\t// %0 and %1 get overwritten by exception handler\n"     \
 139              "\t.xdata4 \"__ex_table\", 1b-., 1f-.+4\n"                                         \
 140              "[1:]"                                                                             \
 141              : "=r"(__gu_r9), "=r"(__gu_r8) : "m"(__m(addr)), "1"(__gu_r8));                    \
 142         (err) = __gu_r8;                                                                        \
 143         (val) = __gu_r9;                                                                        \
 144 } while (0)
 145
 146 /*
 147  * The "__put_user_size()" macro tells gcc it reads from memory instead of writing it.  This
 148  * is because they do not write to any memory gcc knows about, so there are no aliasing
 149  * issues.
 150  */
 151 # define __put_user_size(val, addr, n, err)                                                     \
 152 do {                                                                                            \
 153         register long __pu_r8 asm ("r8") = 0;                                                   \
 154         asm volatile ("\n[1:]\tst"#n" %1=%r2%P1\t// %0 gets overwritten by exception handler\n" \
 155                       "\t.xdata4 \"__ex_table\", 1b-., 1f-.\n"                                  \
 156                       "[1:]"                                                                    \
 157                       : "=r"(__pu_r8) : "m"(__m(addr)), "rO"(val), "0"(__pu_r8));               \
 158         (err) = __pu_r8;                                                                        \
 159 } while (0)
 160
 161 #else /* !ASM_SUPPORTED */
 162 # define RELOC_TYPE     2       /* ip-rel */
 163 # define __get_user_size(val, addr, n, err)                             \
 164 do {                                                                    \
 165         __ld_user("__ex_table", (unsigned long) addr, n, RELOC_TYPE);   \
 166         (err) = ia64_getreg(_IA64_REG_R8);                              \
 167         (val) = ia64_getreg(_IA64_REG_R9);                              \
 168 } while (0)
 169 # define __put_user_size(val, addr, n, err)                             \
 170 do {                                                                    \
 171         __st_user("__ex_table", (unsigned long) addr, n, RELOC_TYPE,    \
 172                   (__force unsigned long) (val));                       \
 173         (err) = ia64_getreg(_IA64_REG_R8);                              \
 174 } while (0)
 175 #endif /* !ASM_SUPPORTED */
 176
 177 extern void __get_user_unknown (void);
 178
 179 /*
 180  * Evaluating arguments X, PTR, SIZE, and SEGMENT may involve subroutine-calls, which
 181  * could clobber r8 and r9 (among others).  Thus, be careful not to evaluate it while
 182  * using r8/r9.
 183  */
 184 #define __do_get_user(check, x, ptr, size, segment)                                     \
 185 ({                                                                                      \
 186         const __typeof__(*(ptr)) __user *__gu_ptr = (ptr);                              \
 187         __typeof__ (size) __gu_size = (size);                                           \
 188         long __gu_err = -EFAULT;                                                        \
 189         unsigned long __gu_val = 0;                                                     \
 190         if (!check || __access_ok(__gu_ptr, size, segment))                             \
 191                 switch (__gu_size) {                                                    \
 192                       case 1: __get_user_size(__gu_val, __gu_ptr, 1, __gu_err); break;  \
 193                       case 2: __get_user_size(__gu_val, __gu_ptr, 2, __gu_err); break;  \
 194                       case 4: __get_user_size(__gu_val, __gu_ptr, 4, __gu_err); break;  \
 195                       case 8: __get_user_size(__gu_val, __gu_ptr, 8, __gu_err); break;  \
 196                       default: __get_user_unknown(); break;                             \
 197                 }                                                                       \
 198         (x) = (__force __typeof__(*(__gu_ptr))) __gu_val;                               \
 199         __gu_err;                                                                       \
 200 })
 201
 202 #define __get_user_nocheck(x, ptr, size)        __do_get_user(0, x, ptr, size, KERNEL_DS)
 203 #define __get_user_check(x, ptr, size, segment) __do_get_user(1, x, ptr, size, segment)
 204
 205 extern void __put_user_unknown (void);
 206
 207 /*
 208  * Evaluating arguments X, PTR, SIZE, and SEGMENT may involve subroutine-calls, which
 209  * could clobber r8 (among others).  Thus, be careful not to evaluate them while using r8.
 210  */
 211 #define __do_put_user(check, x, ptr, size, segment)                                     \
 212 ({                                                                                      \
 213         __typeof__ (x) __pu_x = (x);                                                    \
 214         __typeof__ (*(ptr)) __user *__pu_ptr = (ptr);                                   \
 215         __typeof__ (size) __pu_size = (size);                                           \
 216         long __pu_err = -EFAULT;                                                        \
 217                                                                                         \
 218         if (!check || __access_ok(__pu_ptr, __pu_size, segment))                        \
 219                 switch (__pu_size) {                                                    \
 220                       case 1: __put_user_size(__pu_x, __pu_ptr, 1, __pu_err); break;    \
 221                       case 2: __put_user_size(__pu_x, __pu_ptr, 2, __pu_err); break;    \
 222                       case 4: __put_user_size(__pu_x, __pu_ptr, 4, __pu_err); break;    \
 223                       case 8: __put_user_size(__pu_x, __pu_ptr, 8, __pu_err); break;    \
 224                       default: __put_user_unknown(); break;                             \
 225                 }                                                                       \
 226         __pu_err;                                                                       \
 227 })
 228
 229 #define __put_user_nocheck(x, ptr, size)        __do_put_user(0, x, ptr, size, KERNEL_DS)
 230 #define __put_user_check(x, ptr, size, segment) __do_put_user(1, x, ptr, size, segment)
 231
 232 /*
 233  * Complex access routines
 234  */
 235 extern unsigned long __must_check __copy_user (void __user *to, const void __user *from,
 236                                                unsigned long count);
 237
 238 static inline unsigned long
 239 __copy_to_user (void __user *to, const void *from, unsigned long count)
 240 {
 241         check_object_size(from, count, true);
 242
 243         return __copy_user(to, (__force void __user *) from, count);
 244 }
 245
 246 static inline unsigned long
 247 __copy_from_user (void *to, const void __user *from, unsigned long count)
 248 {
 249         check_object_size(to, count, false);
 250
 251         return __copy_user((__force void __user *) to, from, count);
 252 }
 253
 254 #define __copy_to_user_inatomic         __copy_to_user
 255 #define __copy_from_user_inatomic       __copy_from_user
 256 #define copy_to_user(to, from, n)                                                       \
 257 ({                                                                                      \
 258         void __user *__cu_to = (to);                                                    \
 259         const void *__cu_from = (from);                                                 \
 260         long __cu_len = (n);                                                            \
 261                                                                                         \
 262         if (__access_ok(__cu_to, __cu_len, get_fs())) {                                 \
 263                 check_object_size(__cu_from, __cu_len, true);                   \
 264                 __cu_len = __copy_user(__cu_to, (__force void __user *)  __cu_from, __cu_len);  \
 265         }                                                                               \
 266         __cu_len;                                                                       \
 267 })
 268
 269 static inline unsigned long
 270 copy_from_user(void *to, const void __user *from, unsigned long n)
 271 {
 272         check_object_size(to, n, false);
 273         if (likely(__access_ok(from, n, get_fs())))
 274                 n = __copy_user((__force void __user *) to, from, n);
 275         else
 276                 memset(to, 0, n);
 277         return n;
 278 }
 279
 280 #define __copy_in_user(to, from, size)  __copy_user((to), (from), (size))
 281
 282 static inline unsigned long
 283 copy_in_user (void __user *to, const void __user *from, unsigned long n)
 284 {
 285         if (likely(access_ok(VERIFY_READ, from, n) && access_ok(VERIFY_WRITE, to, n)))
 286                 n = __copy_user(to, from, n);
 287         return n;
 288 }
 289
 290 extern unsigned long __do_clear_user (void __user *, unsigned long);
 291
 292 #define __clear_user(to, n)             __do_clear_user(to, n)
 293
 294 #define clear_user(to, n)                                       \
 295 ({                                                              \
 296         unsigned long __cu_len = (n);                           \
 297         if (__access_ok(to, __cu_len, get_fs()))                \
 298                 __cu_len = __do_clear_user(to, __cu_len);       \
 299         __cu_len;                                               \
 300 })
 301
 302
 303 /*
 304  * Returns: -EFAULT if exception before terminator, N if the entire buffer filled, else
 305  * strlen.
 306  */
 307 extern long __must_check __strncpy_from_user (char *to, const char __user *from, long to_len);
 308
 309 #define strncpy_from_user(to, from, n)                                  \
 310 ({                                                                      \
 311         const char __user * __sfu_from = (from);                        \
 312         long __sfu_ret = -EFAULT;                                       \
 313         if (__access_ok(__sfu_from, 0, get_fs()))                       \
 314                 __sfu_ret = __strncpy_from_user((to), __sfu_from, (n)); \
 315         __sfu_ret;                                                      \
 316 })
 317
 318 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
 319 extern unsigned long __strlen_user (const char __user *);
 320
 321 #define strlen_user(str)                                \
 322 ({                                                      \
 323         const char __user *__su_str = (str);            \
 324         unsigned long __su_ret = 0;                     \
 325         if (__access_ok(__su_str, 0, get_fs()))         \
 326                 __su_ret = __strlen_user(__su_str);     \
 327         __su_ret;                                       \
 328 })
 329
 330 /*
 331  * Returns: 0 if exception before NUL or reaching the supplied limit
 332  * (N), a value greater than N if the limit would be exceeded, else
 333  * strlen.
 334  */
 335 extern unsigned long __strnlen_user (const char __user *, long);
 336
 337 #define strnlen_user(str, len)                                  \
 338 ({                                                              \
 339         const char __user *__su_str = (str);                    \
 340         unsigned long __su_ret = 0;                             \
 341         if (__access_ok(__su_str, 0, get_fs()))                 \
 342                 __su_ret = __strnlen_user(__su_str, len);       \
 343         __su_ret;                                               \
 344 })
 345
 346 #define ARCH_HAS_RELATIVE_EXTABLE
 347
 348 struct exception_table_entry {
 349         int insn;       /* location-relative address of insn this fixup is for */
 350         int fixup;      /* location-relative continuation addr.; if bit 2 is set, r9 is set to 0 */
 351 };
 352
 353 #define ARCH_HAS_TRANSLATE_MEM_PTR      1
 354 static __inline__ void *
 355 xlate_dev_mem_ptr(phys_addr_t p)
 356 {
 357         struct page *page;
 358         void *ptr;
 359
 360         page = pfn_to_page(p >> PAGE_SHIFT);
 361         if (PageUncached(page))
 362                 ptr = (void *)p + __IA64_UNCACHED_OFFSET;
 363         else
 364                 ptr = __va(p);
 365
 366         return ptr;
 367 }
 368
 369 /*
 370  * Convert a virtual cached kernel memory pointer to an uncached pointer
 371  */
 372 static __inline__ void *
 373 xlate_dev_kmem_ptr(void *p)
 374 {
 375         struct page *page;
 376         void *ptr;
 377
 378         page = virt_to_page((unsigned long)p);
 379         if (PageUncached(page))
 380                 ptr = (void *)__pa(p) + __IA64_UNCACHED_OFFSET;
 381         else
 382                 ptr = p;
 383
 384         return ptr;
 385 }
 386
 387 #endif /* _ASM_IA64_UACCESS_H */