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