Move 'KFOP' helpers to umem.c
[akaros.git] / kern / src / umem.c
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.  The user_mem ones need
7  * to involve some form of pinning (TODO), and that global static needs to go. */
8
9 #include <ros/common.h>
10 #include <arch/uaccess.h>
11 #include <umem.h>
12 #include <process.h>
13 #include <error.h>
14 #include <kmalloc.h>
15 #include <assert.h>
16 #include <pmap.h>
17 #include <smp.h>
18
19 static int string_copy_from_user(char *dst, const char *src)
20 {
21         int error;
22         const char *top = src + valid_user_rbytes_from(src);
23
24         for (;; dst++, src++) {
25                 if (unlikely(src >= top))
26                         return -EFAULT;
27                 error = __get_user(dst, src, 1);
28                 if (unlikely(error))
29                         return error;
30                 if (unlikely(!*dst))
31                         break;
32         }
33
34         return 0;
35 }
36
37 static int string_copy_to_user(char *dst, const char *src)
38 {
39         int error;
40         char *top = dst + valid_user_rwbytes_from(dst);
41
42         for (;; dst++, src++) {
43                 if (unlikely(dst >= top))
44                         return -EFAULT;
45                 error = __put_user(dst, src, 1);
46                 if (unlikely(error))
47                         return error;
48                 if (unlikely(!*src))
49                         break;
50         }
51
52         return 0;
53 }
54
55 int strcpy_from_user(struct proc *p, char *dst, const char *src)
56 {
57         uintptr_t prev = switch_to(p);
58         int error = string_copy_from_user(dst, src);
59
60         switch_back(p, prev);
61
62         return error;
63 }
64
65 int strcpy_to_user(struct proc *p, char *dst, const char *src)
66 {
67         uintptr_t prev = switch_to(p);
68         int error = string_copy_to_user(dst, src);
69
70         switch_back(p, prev);
71
72         return error;
73 }
74
75 int memcpy_from_user(struct proc *p, void *dest, const void *va, size_t len)
76 {
77         uintptr_t prev = switch_to(p);
78         int error = copy_from_user(dest, va, len);
79
80         switch_back(p, prev);
81
82         return error;
83 }
84
85 int memcpy_to_user(struct proc *p, void *dest, const void *src, size_t len)
86 {
87         uintptr_t prev = switch_to(p);
88         int error = copy_to_user(dest, src, len);
89
90         switch_back(p, prev);
91
92         return error;
93 }
94
95 /* Same as above, but sets errno */
96 int memcpy_from_user_errno(struct proc *p, void *dst, const void *src, int len)
97 {
98         int error = memcpy_from_user(p, dst, src, len);
99
100         if (unlikely(error < 0))
101                 set_errno(-error);
102
103         return error;
104 }
105
106 /* Same as above, but sets errno */
107 int memcpy_to_user_errno(struct proc *p, void *dst, const void *src, int len)
108 {
109         int error = memcpy_to_user(p, dst, src, len);
110
111         if (unlikely(error < 0))
112                 set_errno(-error);
113
114         return error;
115 }
116
117 /* Helpers for FSs that don't care if they copy to the user or the kernel.
118  *
119  * TODO: (KFOP) Probably shouldn't do this.  Either memcpy directly, or split
120  * out the is_user_r(w)addr from copy_{to,from}_user().  Or throw from the fault
121  * handler.  Right now, we ignore the ret/errors completely. */
122 void memcpy_to_safe(void *dst, const void *src, size_t amt)
123 {
124         if (!is_ktask(per_cpu_info[core_id()].cur_kthread))
125                 memcpy_to_user(current, dst, src, amt);
126         else
127                 memcpy(dst, src, amt);
128 }
129
130 void memcpy_from_safe(void *dst, const void *src, size_t amt)
131 {
132         if (!is_ktask(per_cpu_info[core_id()].cur_kthread))
133                 memcpy_from_user(current, dst, src, amt);
134         else
135                 memcpy(dst, src, amt);
136 }
137
138 /* Creates a buffer (kmalloc) and safely copies into it from va.  Can return an
139  * error code.  Check its response with IS_ERR().  Must be paired with
140  * user_memdup_free() if this succeeded. */
141 void *user_memdup(struct proc *p, const void *va, int len)
142 {
143         void* kva = NULL;
144         if (len < 0 || (kva = kmalloc(len, 0)) == NULL)
145                 return ERR_PTR(-ENOMEM);
146         if (memcpy_from_user(p, kva, va, len)) {
147                 kfree(kva);
148                 return ERR_PTR(-EFAULT);
149         }
150         return kva;
151 }
152
153 void *user_memdup_errno(struct proc *p, const void *va, int len)
154 {
155         void *kva = user_memdup(p, va, len);
156         if (IS_ERR(kva)) {
157                 set_errno(-PTR_ERR(kva));
158                 return NULL;
159         }
160         return kva;
161 }
162
163 void user_memdup_free(struct proc *p, void *va)
164 {
165         kfree(va);
166 }
167
168 /* Same as memdup, but just does strings, and needs to know the actual strlen.
169  * Still needs memdup_free()d.  This will enforce that the string is null
170  * terminated.  The parameter strlen does not include the \0, though it can if
171  * someone else is playing it safe.  Since strlen() doesn't count the \0, we'll
172  * play it safe here. */
173 char *user_strdup(struct proc *p, const char *u_string, size_t strlen)
174 {
175         char *k_string = user_memdup(p, u_string, strlen + 1);
176         if (!IS_ERR(k_string))
177                 k_string[strlen] = '\0';
178         return k_string;
179 }
180
181 /* user_strdup, but this handles the errno.  0 on failure, ptr on success */
182 char *user_strdup_errno(struct proc *p, const char *u_string, size_t strlen)
183 {
184         void *k_string = user_strdup(p, u_string, strlen);
185         if (IS_ERR(k_string)) {
186                 set_errno(-PTR_ERR(k_string));
187                 return NULL;
188         }
189         return k_string;
190 }
191
192 void *kmalloc_errno(int len)
193 {
194         void *kva = NULL;
195         if (len < 0 || (kva = kmalloc(len, 0)) == NULL)
196                 set_errno(ENOMEM);
197         return kva;
198 }
199
200 /* Returns true if uva and kva both resolve to the same phys addr.  If uva is
201  * unmapped, it will return FALSE.  This is probably what you want, since after
202  * all uva isn't kva. */
203 bool uva_is_kva(struct proc *p, void *uva, void *kva)
204 {
205         struct page *u_page;
206         assert(kva);                            /* catch bugs */
207         /* Check offsets first */
208         if (PGOFF(uva) != PGOFF(kva))
209                 return FALSE;
210         /* Check to see if it is the same physical page */
211         u_page = page_lookup(p->env_pgdir, uva, 0);
212         if (!u_page)
213                 return FALSE;
214         return (kva2page(kva) == u_page) ? TRUE : FALSE;
215 }
216
217 /* Given a proc and a user virtual address, gives us the KVA.  Useful for
218  * debugging.  Returns 0 if the page is unmapped (page lookup fails).  This
219  * doesn't play nice with Jumbo pages. */
220 uintptr_t uva2kva(struct proc *p, void *uva, size_t len, int prot)
221 {
222         struct page *u_page;
223         uintptr_t offset = PGOFF(uva);
224         if (!p)
225                 return 0;
226         if (prot & PROT_WRITE) {
227                 if (!is_user_rwaddr(uva, len))
228                         return 0;
229         } else {
230                 if (!is_user_raddr(uva, len))
231                         return 0;
232         }
233         u_page = page_lookup(p->env_pgdir, uva, 0);
234         if (!u_page)
235                 return 0;
236         return (uintptr_t)page2kva(u_page) + offset;
237 }
238
239 /* Helper, copies a pathname from the process into the kernel.  Returns a string
240  * on success, which you must free with free_path.  Returns 0 on failure and
241  * sets errno. */
242 char *copy_in_path(struct proc *p, const char *path, size_t path_l)
243 {
244         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
245         char *t_path;
246
247         /* PATH_MAX includes the \0 */
248         if (path_l > PATH_MAX) {
249                 set_errno(ENAMETOOLONG);
250                 return 0;
251         }
252         t_path = user_strdup_errno(p, path, path_l);
253         if (!t_path)
254                 return 0;
255         return t_path;
256 }
257
258 /* Helper, frees a path that was allocated with copy_in_path. */
259 void free_path(struct proc *p, char *t_path)
260 {
261         user_memdup_free(p, t_path);
262 }