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