d35f05c22203b934a8a2b6f316dacb6e53d9ffb8
[akaros.git] / kern / include / umem.h
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * Andrew Waterman <waterman@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * Functions for working with userspace's address space. */
7
8 #include <ros/common.h>
9 #include <process.h>
10
11 /* Is this a valid user pointer for read/write?  It doesn't care if the address
12  * is paged out or even an unmapped region: simply if it is in part of the
13  * address space that could be RW user.  Will also check for len bytes. */
14 static inline bool is_user_rwaddr(void *addr, size_t len);
15 /* Same deal, but read-only */
16 static inline bool is_user_raddr(void *addr, size_t len);
17
18 /* Copy from proc p into the kernel's dest from src */
19 int memcpy_from_user(struct proc *p, void *dest, const void *va,
20                      size_t len);
21
22 /* Copy to proc p into va from the kernel's src */
23 int memcpy_to_user(struct proc *p, void *a, const void *src,
24                    size_t len);
25 /* Same as above, but sets errno */
26 int memcpy_from_user_errno(struct proc *p, void *dst, const void *src, int len);
27 int memcpy_to_user_errno(struct proc *p, void *dst, const void *src, int len);
28                  
29 /* Creates a buffer (kmalloc) and safely copies into it from va.  Can return an
30  * error code.  Check its response with IS_ERR().  Must be paired with
31  * user_memdup_free() if this succeeded. */
32 void *user_memdup(struct proc *p, const void *va, int len);
33 /* Same as above, but sets errno */
34 void *user_memdup_errno(struct proc *p, const void *va, int len);
35 void user_memdup_free(struct proc *p, void *va);
36 /* Same as memdup, but just does strings.  still needs memdup_freed */
37 char *user_strdup(struct proc *p, const char *u_string, size_t strlen);
38 char *user_strdup_errno(struct proc *p, const char *u_string, size_t strlen);
39 void *kmalloc_errno(int len);
40 bool uva_is_kva(struct proc *p, void *uva, void *kva);
41 uintptr_t uva2kva(struct proc *p, void *uva);
42
43 /* Helper for is_user_r{w,}addr.
44  *
45  * These checks are for addresses that the kernel accesses on behalf of the
46  * user, which are mapped into the user's address space.  One interpretation is
47  * whether or not the user is allowed to refer to this memory, hence the
48  * MMAP_LOWEST_VA check.  But note that the user is allowed to attempt virtual
49  * memory accesses outside of this range.  VMM code may interpose on low memory
50  * PFs to emulate certain instructions.  However, the kernel should never be
51  * given such a pointer.
52  *
53  * Without the MMAP_LOWEST_VA check, the kernel would still PF on a bad user
54  * pointer (say the user gave us 0x10; we have nothing mapped at addr 0).
55  * However, it would be more difficult to detect if the PF was the kernel acting
56  * on behalf of the user or if the kernel itself had a null pointer deref.  By
57  * checking early, the kernel will catch low addresses and error out before page
58  * faulting. */
59 static inline bool __is_user_addr(void *addr, size_t len, uintptr_t lim)
60 {
61         if ((MMAP_LOWEST_VA <= (uintptr_t)addr) &&
62             ((uintptr_t)addr < lim) &&
63             ((uintptr_t)addr + len <= lim))
64                 return TRUE;
65         else
66                 return FALSE;
67 }
68
69 /* UWLIM is defined as virtual address below which a process can write */
70 static inline bool is_user_rwaddr(void *addr, size_t len)
71 {
72         return __is_user_addr(addr, len, UWLIM);
73 }
74
75 /* ULIM is defined as virtual address below which a process can read */
76 static inline bool is_user_raddr(void *addr, size_t len)
77 {
78         return __is_user_addr(addr, len, ULIM);
79 }