Added cache_buster syscall
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 #pragma nodeputy
4 #endif
5
6 #include <arch/types.h>
7 #include <arch/x86.h>
8 #include <arch/console.h>
9 #include <arch/apic.h>
10 #include <arch/timer.h>
11 #include <ros/error.h>
12
13 #include <string.h>
14 #include <assert.h>
15 #include <env.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <syscall.h>
19
20 void syscall_wrapper(struct Trapframe *tf)
21 {
22         env_t* curenv = curenvs[lapic_get_id()];
23     curenv->env_tf = *tf;
24     tf->tf_regs.reg_eax =
25             (intreg_t) syscall(curenv,
26                                tf->tf_regs.reg_eax,
27                                tf->tf_regs.reg_edx,
28                                tf->tf_regs.reg_ecx,
29                                tf->tf_regs.reg_ebx,
30                                tf->tf_regs.reg_edi,
31                                0);
32     return;
33 }
34
35 //Do absolutely nothing.  Used for profiling.
36 static void sys_null(void)
37 {
38         return;
39 }
40
41 //Write a buffer over the serial port
42 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len) 
43 {
44         char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
45         for(int i =0; i<len; i++)
46                 serial_send_byte(buf[i]);       
47         return (ssize_t)len;
48 }
49
50 //Read a buffer over the serial port
51 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS buf, size_t len) 
52 {
53     char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
54         size_t bytes_read = 0;
55         int c;
56         while((c = serial_read_byte()) != -1) {
57                 buf[bytes_read++] = (uint8_t)c;
58                 if(bytes_read == len) break;
59         }
60         return (ssize_t)bytes_read;
61 }
62
63 // Invalidate the cache of this core
64 static void sys_cache_invalidate(void)
65 {
66         wbinvd();
67         return;
68 }
69
70 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
71 // address space.  It's just #defined to be some random 4MB chunk (which ought
72 // to be boot_alloced or something).  Meant to grab exclusive access to cache
73 // lines, to simulate doing something useful.
74 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
75                              uint32_t flags)
76 {
77         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
78         #define MAX_WRITES              1048576*8
79         #define MAX_PAGES               32
80         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
81         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
82         static uint32_t buster_lock = 0;
83         uint64_t ticks;
84         page_t* a_page[MAX_PAGES];
85
86         /* Strided Accesses or Not (adjust to step by cachelines) */
87         uint32_t stride = 1;
88         if (flags & BUSTER_STRIDED) {
89                 stride = 16;
90                 num_writes *= 16;
91         }
92         
93         /* Shared Accesses or Not (adjust to use per-core regions)
94          * Careful, since this gives 8MB to each core, starting around 512MB.
95          * Also, doesn't separate memory for core 0 if it's an async call.
96          */
97         if (!(flags & BUSTER_SHARED))
98                 buster = (uint32_t*)(BUSTER_ADDR + lapic_get_id() * 0x00800000);
99
100         /* Start the timer, if we're asked to print this info*/
101         if (flags & BUSTER_PRINT_TICKS)
102                 ticks = start_timing();
103
104         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
105          * realistic work.  Note we don't write to these pages, even if we pick
106          * unshared.  Mostly due to the inconvenience of having to match up the
107          * number of pages with the number of writes.  And it's unnecessary.
108          */
109         if (num_pages) {
110                 spin_lock(&buster_lock);
111                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
112                         page_alloc(&a_page[i]);
113                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
114                                     PTE_U | PTE_W);
115                 }
116                 spin_unlock(&buster_lock);
117         }
118
119         if (flags & BUSTER_LOCKED)
120                 spin_lock(&buster_lock);
121         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
122                 buster[i] = 0xdeadbeef;
123         if (flags & BUSTER_LOCKED)
124                 spin_unlock(&buster_lock);
125
126         if (num_pages) {
127                 spin_lock(&buster_lock);
128                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
129                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
130                         page_decref(a_page[i]);
131                 }
132                 spin_unlock(&buster_lock);
133         }
134
135         /* Print info */
136         if (flags & BUSTER_PRINT_TICKS) {
137                 ticks = stop_timing(ticks);
138                 printk("%llu,", ticks);
139         }
140         return;
141 }
142
143 // Print a string to the system console.
144 // The string is exactly 'len' characters long.
145 // Destroys the environment on memory errors.
146 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
147 {
148         // Check that the user has permission to read memory [s, s+len).
149         // Destroy the environment if not.
150     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
151
152         // Print the string supplied by the user.
153         printk("%.*s", len, _s);
154         return (ssize_t)len;
155 }
156
157 // Read a character from the system console.
158 // Returns the character.
159 static uint16_t sys_cgetc(env_t* e)
160 {
161         uint16_t c;
162
163         // The cons_getc() primitive doesn't wait for a character,
164         // but the sys_cgetc() system call does.
165         while ((c = cons_getc()) == 0)
166                 cpu_relax();
167
168         return c;
169 }
170
171 // Returns the current environment's envid.
172 static envid_t sys_getenvid(env_t* e)
173 {
174         return e->env_id;
175 }
176
177 // Returns the id of the cpu this syscall is executed on.
178 static envid_t sys_getcpuid(void)
179 {
180         return lapic_get_id();
181 }
182
183 // Destroy a given environment (possibly the currently running environment).
184 //
185 // Returns 0 on success, < 0 on error.  Errors are:
186 //      -E_BAD_ENV if environment envid doesn't currently exist,
187 //              or the caller doesn't have permission to change envid.
188 static error_t sys_env_destroy(env_t* e, envid_t envid)
189 {
190         int r;
191         env_t *env_to_die;
192
193         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
194                 return r;
195         if (env_to_die == e)
196                 printk("[%08x] exiting gracefully\n", e->env_id);
197         else
198                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
199         env_destroy(env_to_die);
200         return 0;
201 }
202
203
204 // TODO: Build a dispatch table instead of switching on the syscallno
205 // Dispatches to the correct kernel function, passing the arguments.
206 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
207                 uint32_t a3, uint32_t a4, uint32_t a5)
208 {
209         // Call the function corresponding to the 'syscallno' parameter.
210         // Return any appropriate return value.
211
212         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
213         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
214         //        syscallno, a1, a2, a3, a4, a5);
215
216         assert(e); // should always have an env for every syscall
217         //printk("Running syscall: %d\n", syscallno);
218         if (INVALID_SYSCALL(syscallno))
219                 return -E_INVAL;
220
221         switch (syscallno) {
222                 case SYS_null:
223                         sys_null();
224                         return 0;
225                 case SYS_serial_write:
226                         //printk("I am here\n");
227                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
228                 case SYS_serial_read:
229                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
230                 case SYS_cache_invalidate:
231                         sys_cache_invalidate();
232                         return 0;
233                 case SYS_cache_buster:
234                         sys_cache_buster(e, a1, a2, a3);
235                         return 0;
236                 case SYS_cputs:
237                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
238                 case SYS_cgetc:
239                         return sys_cgetc(e);
240                 case SYS_getenvid:
241                         return sys_getenvid(e);
242                 case SYS_getcpuid:
243                         return sys_getcpuid();
244                 case SYS_env_destroy:
245                         return sys_env_destroy(e, (envid_t)a1);
246                 default:
247                         // or just return -E_INVAL
248                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
249         }
250         return 0xdeadbeef;
251 }
252
253 intreg_t syscall_async(env_t* e, syscall_req_t *call)
254 {
255         return syscall(e, call->num, call->args[0], call->args[1],
256                        call->args[2], call->args[3], call->args[4]);
257 }
258
259 intreg_t process_generic_syscalls(env_t* e, size_t max)
260 {
261         size_t count = 0;
262         syscall_back_ring_t* sysbr = &e->env_sysbackring;
263
264         // make sure the env is still alive.  incref will return 0 on success.
265         if (env_incref(e))
266                 return -1;
267
268         // max is the most we'll process.  max = 0 means do as many as possible
269         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
270                 if (!count) {
271                         // ASSUME: one queue per process
272                         // only switch cr3 for the very first request for this queue
273                         // need to switch to the right context, so we can handle the user pointer
274                         // that points to a data payload of the syscall
275                         lcr3(e->env_cr3);
276                 }
277                 count++;
278                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
279                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
280                 // might want to think about 0-ing this out, if we aren't
281                 // going to explicitly fill in all fields
282                 syscall_rsp_t rsp;
283                 // this assumes we get our answer immediately for the syscall.
284                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
285                 rsp.retval = syscall_async(e, req);
286                 // write response into the slot it came from
287                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
288                 // update our counter for what we've produced (assumes we went in order!)
289                 (sysbr->rsp_prod_pvt)++;
290                 RING_PUSH_RESPONSES(sysbr);
291                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
292                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
293         }
294         env_decref(e);
295         return (intreg_t)count;
296 }