Adding support for the brk system call
[akaros.git] / kern / src / env.c
1 /* See COPYRIGHT for copyright information. */
2
3 #ifdef __SHARC__
4 #pragma nosharc
5 #endif
6
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <elf.h>
10 #include <smp.h>
11
12 #include <atomic.h>
13 #include <string.h>
14 #include <assert.h>
15 #include <process.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <monitor.h>
19 #include <manager.h>
20 #include <stdio.h>
21 #include <schedule.h>
22
23 #include <ros/syscall.h>
24 #include <ros/error.h>
25
26 env_t *envs = NULL;             // All environments
27 atomic_t num_envs;
28 // TODO: make this a struct of info including the pointer and cacheline-align it
29 // This lets the kernel know what process is running on the core it traps into.
30 // A lot of the Env business, including this and its usage, will change when we
31 // redesign the env as a multi-process.
32 env_t* (RO curenvs)[MAX_NUM_CPUS] = {[0 ... (MAX_NUM_CPUS-1)] NULL};
33
34 #define ENVGENSHIFT     12              // >= LOGNENV
35
36 //
37 // Converts an envid to an env pointer.
38 //
39 // RETURNS
40 //   0 on success, -EBADENV on error.
41 //   On success, sets *env_store to the environment.
42 //   On error, sets *env_store to NULL.
43 //
44 int
45 envid2env(envid_t envid, env_t **env_store, bool checkperm)
46 {
47         env_t *e;
48
49         // If envid is zero, return the current environment.
50         if (envid == 0) {
51                 *env_store = current;
52                 return 0;
53         }
54
55         // Look up the Env structure via the index part of the envid,
56         // then check the env_id field in that env_t
57         // to ensure that the envid is not stale
58         // (i.e., does not refer to a _previous_ environment
59         // that used the same slot in the envs[] array).
60         e = &envs[ENVX(envid)];
61         if (e->state == ENV_FREE || e->env_id != envid) {
62                 *env_store = 0;
63                 return -EBADENV;
64         }
65
66         // Check that the calling environment has legitimate permission
67         // to manipulate the specified environment.
68         // If checkperm is set, the specified environment
69         // must be either the current environment
70         // or an immediate child of the current environment.
71         // TODO: should check for current being null
72         if (checkperm && e != current && e->env_parent_id != current->env_id) {
73                 *env_store = 0;
74                 return -EBADENV;
75         }
76
77         *env_store = e;
78         return 0;
79 }
80
81 //
82 // Mark all environments in 'envs' as free, set their env_ids to 0,
83 // and insert them into the proc_freelist.
84 // Insert in reverse order, so that the first call to env_alloc()
85 // returns envs[0].
86 // TODO: get rid of this whole array bullshit
87 //
88 void
89 env_init(void)
90 {
91         int i;
92
93         schedule_init();
94         // core 0 is not idle, all others are (for now)
95         spin_lock(&idle_lock);
96         num_idlecores = num_cpus - 1;
97         for (i = 0; i < num_idlecores; i++)
98                 idlecoremap[i] = i + 1;
99         spin_unlock(&idle_lock);
100         atomic_init(&num_envs, 0);
101         TAILQ_INIT(&proc_freelist);
102         assert(envs != NULL);
103         for (i = NENV-1; i >= 0; i--) {
104                 // these should already be set from when i memset'd the array to 0
105                 envs[i].state = ENV_FREE;
106                 envs[i].end_text_segment = (void*)UTEXT;
107                 envs[i].end_data_segment = (void*)UTEXT;
108                 envs[i].env_id = 0;
109                 TAILQ_INSERT_HEAD(&proc_freelist, &envs[i], proc_link);
110         }
111
112 }
113
114 //
115 // Initialize the kernel virtual memory layout for environment e.
116 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
117 // and initialize the kernel portion of the new environment's address space.
118 // Do NOT (yet) map anything into the user portion
119 // of the environment's virtual address space.
120 //
121 // Returns 0 on success, < 0 on error.  Errors include:
122 //      -ENOMEM if page directory or table could not be allocated.
123 //
124 static int
125 env_setup_vm(env_t *e)
126 WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_procdata)
127 {
128         int i, r;
129         page_t *pgdir = NULL;
130         page_t *pginfo[PROCINFO_NUM_PAGES] = {NULL};
131         page_t *pgdata[PROCDATA_NUM_PAGES] = {NULL};
132         static page_t * RO shared_page = 0;
133
134         /*
135          * First, allocate a page for the pgdir of this process and up
136          * its reference count since this will never be done elsewhere
137          */
138         r = page_alloc(&pgdir);
139         if(r < 0) return r;
140         page_incref(pgdir);
141
142         /*
143          * Next, set up the e->env_pgdir and e->env_cr3 pointers to point
144          * to this newly allocated page and clear its contents
145          */
146         memset(page2kva(pgdir), 0, PGSIZE);
147         e->env_pgdir = (pde_t *COUNT(NPDENTRIES)) TC(page2kva(pgdir));
148         e->env_cr3 =   (physaddr_t) TC(page2pa(pgdir));
149
150         /*
151          * Now start filling in the pgdir with mappings required by all newly
152          * created address spaces
153          */
154
155         // Map in the kernel to the top of every address space
156         // should be able to do this so long as boot_pgdir never has
157         // anything put below UTOP
158         // TODO check on this!  had a nasty bug because of it
159         // this is a bit wonky, since if it's not PGSIZE, lots of other things are
160         // screwed up...
161         memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
162
163         // VPT and UVPT map the env's own page table, with
164         // different permissions.
165         e->env_pgdir[PDX(VPT)]  = PTE(PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
166         e->env_pgdir[PDX(UVPT)] = PTE(PPN(e->env_cr3), PTE_P | PTE_USER_RO);
167
168         /*
169          * Now allocate and insert all pages required for the shared
170          * procinfo structure into the page table
171          */
172         for(int i=0; i<PROCINFO_NUM_PAGES; i++) {
173                 if(page_alloc(&pginfo[i]) < 0)
174                         goto env_setup_vm_error;
175                 if(page_insert(e->env_pgdir, pginfo[i], (void*SNT)(UINFO + i*PGSIZE),
176                                PTE_USER_RO) < 0)
177                         goto env_setup_vm_error;
178         }
179
180         /*
181          * Now allocate and insert all pages required for the shared
182          * procdata structure into the page table
183          */
184         for(int i=0; i<PROCDATA_NUM_PAGES; i++) {
185                 if(page_alloc(&pgdata[i]) < 0)
186                         goto env_setup_vm_error;
187                 if(page_insert(e->env_pgdir, pgdata[i], (void*SNT)(UDATA + i*PGSIZE),
188                                PTE_USER_RW) < 0)
189                         goto env_setup_vm_error;
190         }
191
192         /*
193          * Now, set e->env_procinfo, and e->env_procdata to point to
194          * the proper pages just allocated and clear them out.
195          */
196         e->env_procinfo = (procinfo_t *SAFE) TC(page2kva(pginfo[0]));
197         e->env_procdata = (procdata_t *SAFE) TC(page2kva(pgdata[0]));
198
199         memset(e->env_procinfo, 0, sizeof(procinfo_t));
200         memset(e->env_procdata, 0, sizeof(procdata_t));
201
202         /* Finally, set up the Global Shared Data page for all processes.
203          * Can't be trusted, but still very useful at this stage for us.
204          * Consider removing when we have real processes.
205          * (TODO).  Note the page is alloced only the first time through
206          */
207         if (!shared_page) {
208                 if(page_alloc(&shared_page) < 0)
209                         goto env_setup_vm_error;
210                 // Up it, so it never goes away.  One per user, plus one from page_alloc
211                 // This is necessary, since it's in the per-process range of memory that
212                 // gets freed during page_free.
213                 page_incref(shared_page);
214         }
215
216         // Inserted into every process's address space at UGDATA
217         if(page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_USER_RW) < 0)
218                 goto env_setup_vm_error;
219
220         return 0;
221
222 env_setup_vm_error:
223         page_free(shared_page);
224         for(int i=0; i< PROCDATA_NUM_PAGES; i++) {
225                 page_free(pgdata[i]);
226         }
227         for(int i=0; i< PROCINFO_NUM_PAGES; i++) {
228                 page_free(pginfo[i]);
229         }
230         env_user_mem_free(e);
231         page_free(pgdir);
232         return -ENOMEM;
233 }
234
235 //
236 // Allocates and initializes a new environment.
237 // On success, the new environment is stored in *newenv_store.
238 //
239 // Returns 0 on success, < 0 on failure.  Errors include:
240 //      -ENOFREEENV if all NENVS environments are allocated
241 //      -ENOMEM on memory exhaustion
242 //
243 int
244 env_alloc(env_t **newenv_store, envid_t parent_id)
245 {
246         int32_t generation;
247         int r;
248         env_t *e;
249
250         spin_lock(&freelist_lock);
251         e = TAILQ_FIRST(&proc_freelist);
252         if (e) {
253                 TAILQ_REMOVE(&proc_freelist, e, proc_link);
254                 spin_unlock(&freelist_lock);
255         } else {
256                 spin_unlock(&freelist_lock);
257                 return -ENOFREEENV;
258         }
259
260     { INITSTRUCT(*e)
261
262         // Allocate and set up the page directory for this environment.
263         if ((r = env_setup_vm(e)) < 0) {
264                 spin_lock(&freelist_lock);
265                 TAILQ_INSERT_HEAD(&proc_freelist, e, proc_link);
266                 spin_unlock(&freelist_lock);
267                 return r;
268         }
269
270         // Generate an env_id for this environment.
271         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
272         if (generation <= 0)    // Don't create a negative env_id.
273                 generation = 1 << ENVGENSHIFT;
274         e->env_id = generation | (e - envs);
275
276         // Set the basic status variables.
277     e->proc_lock = 0;
278         e->env_parent_id = parent_id;
279         proc_set_state(e, PROC_CREATED);
280         e->env_runs = 0;
281         e->env_refcnt = 1;
282         e->env_flags = 0;
283         e->env_entry = 0; // cheating.  this really gets set in load_icode
284         e->num_vcores = 0;
285         for (int i = 0; i < MAX_NUM_CPUS; i++)
286                 e->vcoremap[i] = -1;
287         memset(&e->resources, 0, sizeof(e->resources));
288
289         memset(&e->env_ancillary_state, 0, sizeof(e->env_ancillary_state));
290         memset(&e->env_tf, 0, sizeof(e->env_tf));
291         proc_init_trapframe(&e->env_tf);
292
293         /*
294          * Initialize the contents of the e->env_procinfo structure
295          */
296         e->env_procinfo->id = (e->env_id & 0x3FF);
297
298         /*
299          * Initialize the contents of the e->env_procdata structure
300          */
301         // Initialize the generic syscall ring buffer
302         SHARED_RING_INIT(&e->env_procdata->syscallring);
303         // Initialize the backend of the syscall ring buffer
304         BACK_RING_INIT(&e->syscallbackring,
305                        &e->env_procdata->syscallring,
306                        SYSCALLRINGSIZE);
307
308         // Initialize the generic sysevent ring buffer
309         SHARED_RING_INIT(&e->env_procdata->syseventring);
310         // Initialize the frontend of the sysevent ring buffer
311         FRONT_RING_INIT(&e->syseventfrontring,
312                         &e->env_procdata->syseventring,
313                         SYSEVENTRINGSIZE);
314
315         *newenv_store = e;
316         atomic_inc(&num_envs);
317
318         printk("[%08x] new env %08x\n", current ? current->env_id : 0, e->env_id);
319         } // INIT_STRUCT
320         return 0;
321 }
322
323 //
324 // Allocate len bytes of physical memory for environment env,
325 // and map it at virtual address va in the environment's address space.
326 // Does not zero or otherwise initialize the mapped pages in any way.
327 // Pages should be writable by user and kernel.
328 // Panic if any allocation attempt fails.
329 //
330 void
331 env_segment_alloc(env_t *e, void *SNT va, size_t len)
332 {
333         void *SNT start, *SNT end;
334         size_t num_pages;
335         int i, r;
336         page_t *page;
337         pte_t *pte;
338
339         start = ROUNDDOWN(va, PGSIZE);
340         end = ROUNDUP(va + len, PGSIZE);
341         if (start >= end)
342                 panic("Wrap-around in memory allocation addresses!");
343         if ((uintptr_t)end > UTOP)
344                 panic("Attempting to map above UTOP!");
345         // page_insert/pgdir_walk alloc a page and read/write to it via its address
346         // starting from pgdir (e's), so we need to be using e's pgdir
347         assert(e->env_cr3 == rcr3());
348         num_pages = PPN(end - start);
349
350         for (i = 0; i < num_pages; i++, start += PGSIZE) {
351                 // skip if a page is already mapped.  yes, page_insert will page_remove
352                 // whatever page was already there, but if we are seg allocing adjacent
353                 // regions, we don't want to destroy that old mapping/page
354                 // though later on we are told we can ignore this...
355                 pte = pgdir_walk(e->env_pgdir, start, 0);
356                 if (pte && *pte & PTE_P)
357                         continue;
358                 if ((r = page_alloc(&page)) < 0)
359                         panic("env_segment_alloc: %e", r);
360                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
361         }
362 }
363
364 void
365 env_segment_free(env_t *e, void *SNT va, size_t len)
366 {
367         void *SNT start, *SNT end;
368         size_t num_pages;
369         page_t *page;
370         pte_t *pte;
371
372         // Round this up this time so we don't free the page that va is actually on
373         start = ROUNDUP(va, PGSIZE);
374         end = ROUNDUP(va + len, PGSIZE);
375         if (start >= end)
376                 panic("Wrap-around in memory free addresses!");
377         if ((uintptr_t)end > UTOP)
378                 panic("Attempting to unmap above UTOP!");
379         // page_insert/pgdir_walk alloc a page and read/write to it via its address
380         // starting from pgdir (e's), so we need to be using e's pgdir
381         assert(e->env_cr3 == rcr3());
382         num_pages = PPN(end - start);
383
384         for (int i = 0; i < num_pages; i++, start += PGSIZE) {
385                 // skip if a page is already unmapped. 
386                 pte = pgdir_walk(e->env_pgdir, start, 0);
387                 if (pte && *pte & PTE_P)
388                         page_decref(ppn2page(PPN(*pte)));
389         }
390 }
391
392 //
393 // Set up the initial program binary, stack, and processor flags
394 // for a user process.
395 //
396 // This function loads all loadable segments from the ELF binary image
397 // into the environment's user memory, starting at the appropriate
398 // virtual addresses indicated in the ELF program header.
399 // At the same time it clears to zero any portions of these segments
400 // that are marked in the program header as being mapped
401 // but not actually present in the ELF file - i.e., the program's bss section.
402 //
403 // Finally, this function maps one page for the program's initial stack.
404 static void*
405 load_icode(env_t *SAFE e, uint8_t *COUNT(size) binary, size_t size)
406 {
407         // asw: copy the headers because they might not be aligned.
408         elf_t elfhdr;
409         proghdr_t phdr;
410         void* _end = 0;
411         memcpy(&elfhdr, binary, sizeof(elfhdr));
412
413         int i, r;
414
415         // is this an elf?
416         assert(elfhdr.e_magic == ELF_MAGIC);
417         // make sure we have proghdrs to load
418         assert(elfhdr.e_phnum);
419
420         // to actually access any pages alloc'd for this environment, we
421         // need to have the hardware use this environment's page tables.
422         uintreg_t old_cr3 = rcr3();
423         /*
424          * Even though we'll decref later and no one should be killing us at this
425          * stage, we're still going to wrap the lcr3s with incref/decref.
426          *
427          * Note we never decref on the old_cr3, since we aren't willing to let it
428          * die.  It's also not clear who the previous process is - sometimes it
429          * isn't even a process (when the kernel loads on its own, and not in
430          * response to a syscall).  Probably need to think more about this (TODO)
431          *
432          * This can get a bit tricky if this code blocks (will need to think about a
433          * decref then), if we try to change states, etc.
434          */
435         proc_incref(e);
436         lcr3(e->env_cr3);
437
438         // TODO: how do we do a runtime COUNT?
439         {TRUSTEDBLOCK // zra: TRUSTEDBLOCK until validation is done.
440         for (i = 0; i < elfhdr.e_phnum; i++) {
441                 memcpy(&phdr, binary + elfhdr.e_phoff + i*sizeof(phdr), sizeof(phdr));
442                 if (phdr.p_type != ELF_PROG_LOAD)
443                         continue;
444         // TODO: validate elf header fields!
445                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
446                 // this, there will be issues with overlapping sections
447                 _end = MAX(_end, (void*)(phdr.p_va + phdr.p_memsz));
448                 env_segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
449                 memcpy((void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz);
450                 memset((void*)phdr.p_va + phdr.p_filesz, 0, 
451                               phdr.p_memsz - phdr.p_filesz);
452         }}
453
454         proc_set_program_counter(&e->env_tf, elfhdr.e_entry);
455         e->env_entry = elfhdr.e_entry;
456
457         // Now map USTACK_NUM_PAGES pages for the program's initial stack
458         // starting at virtual address USTACKTOP - USTACK_NUM_PAGES*PGSIZE.
459         env_segment_alloc(e, (void*SNT)(USTACKTOP - USTACK_NUM_PAGES*PGSIZE), 
460                           USTACK_NUM_PAGES*PGSIZE);
461
462         // reload the original address space
463         lcr3(old_cr3);
464         proc_decref(e);
465         
466         return _end;
467 }
468
469 //
470 // Allocates a new env and loads the named elf binary into it.
471 //
472 env_t* env_create(uint8_t *binary, size_t size)
473 {
474         env_t *e;
475         int r;
476         envid_t curid;
477
478         curid = (current ? current->env_id : 0);
479         if ((r = env_alloc(&e, curid)) < 0)
480                 panic("env_create: %e", r);
481         
482         /* Load the binary and set the current locations of the elf segments.
483          * All end-of-segment pointers are page aligned (invariant) */
484         e->end_text_segment = load_icode(e, binary, size);
485         e->end_data_segment = e->end_text_segment;
486
487         return e;
488 }
489
490 //
491 // Frees env e and all memory it uses.
492 //
493 void
494 env_free(env_t *e)
495 {
496         physaddr_t pa;
497
498         // Note the environment's demise.
499         printk("[%08x] free env %08x\n", current ? current->env_id : 0, e->env_id);
500         // All parts of the kernel should have decref'd before env_free was called.
501         assert(e->env_refcnt == 0);
502
503         // Flush all mapped pages in the user portion of the address space
504         env_user_mem_free(e);
505
506         // free the page directory
507         pa = e->env_cr3;
508         e->env_pgdir = 0;
509         e->env_cr3 = 0;
510         page_decref(pa2page(pa));
511
512         // return the environment to the free list
513         e->state = ENV_FREE;
514         spin_lock(&freelist_lock);
515         TAILQ_INSERT_HEAD(&proc_freelist, e, proc_link);
516         spin_unlock(&freelist_lock);
517 }
518
519
520 #define PER_CPU_THING(type,name)\
521 type SLOCKED(name##_lock) * RWPROTECT name;\
522 type SLOCKED(name##_lock) *\
523 (get_per_cpu_##name)()\
524 {\
525         { R_PERMITTED(global(name))\
526                 return &name[core_id()];\
527         }\
528 }
529
530
531 /* This is the top-half of an interrupt handler, where the bottom half is
532  * proc_run (which never returns).  Just add it to the delayed work queue,
533  * which (incidentally) can only hold one item at this point.
534  *
535  * Note this is rather old, and meant to run a RUNNABLE_S on a worker core.
536  */
537 #ifdef __IVY__
538 void run_env_handler(trapframe_t *tf, env_t * data)
539 #else
540 void run_env_handler(trapframe_t *tf, void * data)
541 #endif
542 {
543         assert(data);
544         struct work TP(env_t *) job;
545         struct workqueue TP(env_t *) *CT(1) workqueue =
546             TC(&per_cpu_info[core_id()].workqueue);
547         // this doesn't work, and making it a TP(env_t) is wrong
548         // zra: When you want to use other types, let me know, and I can help
549     // make something that Ivy is happy with. 
550 #ifdef __IVY__
551         job.func = proc_run;
552 #else
553         job.func = (func_t)proc_run;
554 #endif
555         job.data = data;
556         if (enqueue_work(workqueue, &job))
557                 panic("Failed to enqueue work!");
558 }