Merge branch 'sparc-dev' of ssh://waterman@scm.millennium.berkeley.edu/project/cs...
[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 = kpage_alloc(&pgdir);
140         if(r < 0) return r;
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(LA2PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
166         e->env_pgdir[PDX(UVPT)] = PTE(LA2PPN(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(upage_alloc(e, &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(upage_alloc(e, &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(upage_alloc(e, &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 static void
236 proc_init_procinfo(struct proc* p)
237 {
238         p->env_procinfo->id = (p->env_id & 0x3FF);
239
240         // TODO: maybe do something smarter here
241         p->env_procinfo->max_harts = num_cpus > 1 ? num_cpus-1 : 1;
242 }
243
244 // Sets up argc/argv in procinfo.  Returns number of
245 // args successfully imported (because of size restrictions).
246 // The procinfo pages must have been mapped into the user's
247 // address space before this function can be called.
248 static size_t
249 proc_init_argc_argv_v(struct proc* p, size_t nargs, va_list args)
250 {
251         // TODO: right now we assume procinfo can be directly addressed
252         // by the kernel (i.e. it's continguous.
253         static_assert(sizeof(struct procinfo) <= PGSIZE);
254
255         if(nargs > PROCINFO_MAX_ARGC)
256                 nargs = PROCINFO_MAX_ARGC;
257
258         char* argv[PROCINFO_MAX_ARGC] = {0};
259         static_assert(sizeof(argv) == sizeof(p->env_procinfo->argv));
260
261         size_t size = 0, argc;
262         for(argc = 0; argc < nargs; argc++)
263         {
264                 const char* arg = va_arg(args,const char*);
265                 size_t len = strnlen(arg,PROCINFO_MAX_ARGV_SIZE);
266                 if(size+len+1 > PROCINFO_MAX_ARGV_SIZE)
267                         break;
268                 memcpy(&p->env_procinfo->argv_buf[size],arg,len+1);
269                 argv[argc] = (char*)(UINFO+offsetof(struct procinfo,argv_buf)+size);
270                 size += len+1;
271         }
272
273         p->env_procinfo->argc = argc;
274         memcpy(p->env_procinfo->argv,argv,sizeof(argv));
275
276         return argc;
277 }
278
279 size_t
280 proc_init_argc_argv(struct proc* p, size_t nargs, ...)
281 {
282         size_t ret;
283
284         va_list list;
285         va_start(list,nargs);
286
287         ret = proc_init_argc_argv_v(p,nargs,list);
288
289         va_end(list);
290
291         return ret;
292 }
293
294 //
295 // Allocates and initializes a new environment.
296 // On success, the new environment is stored in *newenv_store.
297 //
298 // Returns 0 on success, < 0 on failure.  Errors include:
299 //      -ENOFREEENV if all NENVS environments are allocated
300 //      -ENOMEM on memory exhaustion
301 //
302 int
303 env_alloc(env_t **newenv_store, envid_t parent_id)
304 {
305         int32_t generation;
306         int r;
307         env_t *e;
308
309         spin_lock(&freelist_lock);
310         e = TAILQ_FIRST(&proc_freelist);
311         if (e) {
312                 TAILQ_REMOVE(&proc_freelist, e, proc_link);
313                 spin_unlock(&freelist_lock);
314         } else {
315                 spin_unlock(&freelist_lock);
316                 return -ENOFREEENV;
317         }
318
319     { INITSTRUCT(*e)
320
321         // Setup the default map of where to get cache colors from
322         e->cache_colors_map = global_cache_colors_map;
323         e->next_cache_color = 0;
324
325         // Allocate and set up the page directory for this environment.
326         if ((r = env_setup_vm(e)) < 0) {
327                 spin_lock(&freelist_lock);
328                 TAILQ_INSERT_HEAD(&proc_freelist, e, proc_link);
329                 spin_unlock(&freelist_lock);
330                 return r;
331         }
332
333         // Generate an env_id for this environment.
334         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
335         if (generation <= 0)    // Don't create a negative env_id.
336                 generation = 1 << ENVGENSHIFT;
337         e->env_id = generation | (e - envs);
338
339         // Set the basic status variables.
340         e->proc_lock = 0;
341         e->env_parent_id = parent_id;
342         proc_set_state(e, PROC_CREATED);
343         e->env_runs = 0;
344         e->env_refcnt = 1;
345         e->env_flags = 0;
346         e->env_entry = 0; // cheating.  this really gets set in load_icode
347         e->num_vcores = 0;
348         for (int i = 0; i < MAX_NUM_CPUS; i++)
349                 e->vcoremap[i] = -1;
350         memset(&e->resources, 0, sizeof(e->resources));
351
352         memset(&e->env_ancillary_state, 0, sizeof(e->env_ancillary_state));
353         memset(&e->env_tf, 0, sizeof(e->env_tf));
354         proc_init_trapframe(&e->env_tf);
355
356         proc_init_procinfo(e);
357
358         /*
359          * Initialize the contents of the e->env_procdata structure
360          */
361         // Initialize the generic syscall ring buffer
362         SHARED_RING_INIT(&e->env_procdata->syscallring);
363         // Initialize the backend of the syscall ring buffer
364         BACK_RING_INIT(&e->syscallbackring,
365                        &e->env_procdata->syscallring,
366                        SYSCALLRINGSIZE);
367
368         // Initialize the generic sysevent ring buffer
369         SHARED_RING_INIT(&e->env_procdata->syseventring);
370         // Initialize the frontend of the sysevent ring buffer
371         FRONT_RING_INIT(&e->syseventfrontring,
372                         &e->env_procdata->syseventring,
373                         SYSEVENTRINGSIZE);
374
375         *newenv_store = e;
376         atomic_inc(&num_envs);
377
378         printk("[%08x] new env %08x\n", current ? current->env_id : 0, e->env_id);
379         } // INIT_STRUCT
380         return 0;
381 }
382
383 //
384 // Allocate len bytes of physical memory for environment env,
385 // and map it at virtual address va in the environment's address space.
386 // Does not zero or otherwise initialize the mapped pages in any way.
387 // Pages should be writable by user and kernel.
388 // Panic if any allocation attempt fails.
389 //
390 void
391 env_segment_alloc(env_t *e, void *SNT va, size_t len)
392 {
393         void *SNT start, *SNT end;
394         size_t num_pages;
395         int i, r;
396         page_t *page;
397         pte_t *pte;
398
399         start = ROUNDDOWN(va, PGSIZE);
400         end = ROUNDUP(va + len, PGSIZE);
401         if (start >= end)
402                 panic("Wrap-around in memory allocation addresses!");
403         if ((uintptr_t)end > UTOP)
404                 panic("Attempting to map above UTOP!");
405         // page_insert/pgdir_walk alloc a page and read/write to it via its address
406         // starting from pgdir (e's), so we need to be using e's pgdir
407         assert(e->env_cr3 == rcr3());
408         num_pages = LA2PPN(end - start);
409
410         for (i = 0; i < num_pages; i++, start += PGSIZE) {
411                 // skip if a page is already mapped.  yes, page_insert will page_remove
412                 // whatever page was already there, but if we are seg allocing adjacent
413                 // regions, we don't want to destroy that old mapping/page
414                 // though later on we are told we can ignore this...
415                 pte = pgdir_walk(e->env_pgdir, start, 0);
416                 if (pte && *pte & PTE_P)
417                         continue;
418                 if ((r = upage_alloc(e, &page)) < 0)
419                         panic("env_segment_alloc: %e", r);
420                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
421         }
422 }
423
424 void
425 env_segment_free(env_t *e, void *SNT va, size_t len)
426 {
427         void *SNT start, *SNT end;
428         size_t num_pages;
429         page_t *page;
430         pte_t *pte;
431
432         // Round this up this time so we don't free the page that va is actually on
433         start = ROUNDUP(va, PGSIZE);
434         end = ROUNDUP(va + len, PGSIZE);
435         if (start >= end)
436                 panic("Wrap-around in memory free addresses!");
437         if ((uintptr_t)end > UTOP)
438                 panic("Attempting to unmap above UTOP!");
439         // page_insert/pgdir_walk alloc a page and read/write to it via its address
440         // starting from pgdir (e's), so we need to be using e's pgdir
441         assert(e->env_cr3 == rcr3());
442         num_pages = LA2PPN(end - start);
443
444         for (int i = 0; i < num_pages; i++, start += PGSIZE) {
445                 // skip if a page is already unmapped. 
446                 pte = pgdir_walk(e->env_pgdir, start, 0);
447                 if (pte && *pte & PTE_P)
448                         page_remove(e->env_pgdir,start);
449         }
450 }
451
452 //
453 // Set up the initial program binary, stack, and processor flags
454 // for a user process.
455 //
456 // This function loads all loadable segments from the ELF binary image
457 // into the environment's user memory, starting at the appropriate
458 // virtual addresses indicated in the ELF program header.
459 // At the same time it clears to zero any portions of these segments
460 // that are marked in the program header as being mapped
461 // but not actually present in the ELF file - i.e., the program's bss section.
462 //
463 // Finally, this function maps one page for the program's initial stack.
464 static void*
465 load_icode(env_t *SAFE e, uint8_t *COUNT(size) binary, size_t size)
466 {
467         // asw: copy the headers because they might not be aligned.
468         elf_t elfhdr;
469         proghdr_t phdr;
470         void* _end = 0;
471         memcpy(&elfhdr, binary, sizeof(elfhdr));
472
473         int i, r;
474
475         // is this an elf?
476         assert(elfhdr.e_magic == ELF_MAGIC);
477         // make sure we have proghdrs to load
478         assert(elfhdr.e_phnum);
479
480         // to actually access any pages alloc'd for this environment, we
481         // need to have the hardware use this environment's page tables.
482         uintreg_t old_cr3 = rcr3();
483         /*
484          * Even though we'll decref later and no one should be killing us at this
485          * stage, we're still going to wrap the lcr3s with incref/decref.
486          *
487          * Note we never decref on the old_cr3, since we aren't willing to let it
488          * die.  It's also not clear who the previous process is - sometimes it
489          * isn't even a process (when the kernel loads on its own, and not in
490          * response to a syscall).  Probably need to think more about this (TODO)
491          *
492          * This can get a bit tricky if this code blocks (will need to think about a
493          * decref then), if we try to change states, etc.
494          */
495         proc_incref(e);
496         lcr3(e->env_cr3);
497
498         // TODO: how do we do a runtime COUNT?
499         {TRUSTEDBLOCK // zra: TRUSTEDBLOCK until validation is done.
500         for (i = 0; i < elfhdr.e_phnum; i++) {
501                 memcpy(&phdr, binary + elfhdr.e_phoff + i*sizeof(phdr), sizeof(phdr));
502                 if (phdr.p_type != ELF_PROG_LOAD)
503                         continue;
504                 // TODO: validate elf header fields!
505                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
506                 // this, there will be issues with overlapping sections
507                 _end = MAX(_end, (void*)(phdr.p_va + phdr.p_memsz));
508                 env_segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
509                 memcpy((void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz);
510                 memset((void*)phdr.p_va + phdr.p_filesz, 0, 
511                               phdr.p_memsz - phdr.p_filesz);
512         }}
513
514         proc_set_program_counter(&e->env_tf, elfhdr.e_entry);
515         e->env_entry = elfhdr.e_entry;
516
517         // Now map USTACK_NUM_PAGES pages for the program's initial stack
518         // starting at virtual address USTACKTOP - USTACK_NUM_PAGES*PGSIZE.
519         env_segment_alloc(e, (void*SNT)(USTACKTOP - USTACK_NUM_PAGES*PGSIZE), 
520                           USTACK_NUM_PAGES*PGSIZE);
521
522         // reload the original address space
523         lcr3(old_cr3);
524         proc_decref(e);
525         
526         return _end;
527 }
528
529 //
530 // Allocates a new env and loads the named elf binary into it.
531 //
532 env_t* env_create(uint8_t *binary, size_t size)
533 {
534         env_t *e;
535         int r;
536         envid_t curid;
537
538         curid = (current ? current->env_id : 0);
539         if ((r = env_alloc(&e, curid)) < 0)
540                 panic("env_create: %e", r);
541         
542         /* Load the binary and set the current locations of the elf segments.
543          * All end-of-segment pointers are page aligned (invariant) */
544         e->end_text_segment = load_icode(e, binary, size);
545         e->end_data_segment = e->end_text_segment;
546
547         return e;
548 }
549
550 //
551 // Frees env e and all memory it uses.
552 //
553 void
554 env_free(env_t *e)
555 {
556         physaddr_t pa;
557
558         // Note the environment's demise.
559         printk("[%08x] free env %08x\n", current ? current->env_id : 0, e->env_id);
560         // All parts of the kernel should have decref'd before env_free was called.
561         assert(e->env_refcnt == 0);
562
563         // Free any colors allocated to this process
564         if(e->cache_colors_map != global_cache_colors_map) {
565                 for(int i=0; i<llc_cache->num_colors; i++)
566                         cache_color_free(llc_cache, e->cache_colors_map);
567                 cache_colors_map_free(e->cache_colors_map);
568         }
569
570         // Flush all mapped pages in the user portion of the address space
571         env_user_mem_free(e);
572
573         // free the page directory
574         pa = e->env_cr3;
575         e->env_pgdir = 0;
576         e->env_cr3 = 0;
577         page_decref(pa2page(pa));
578
579         // return the environment to the free list
580         e->state = ENV_FREE;
581         spin_lock(&freelist_lock);
582         TAILQ_INSERT_HEAD(&proc_freelist, e, proc_link);
583         spin_unlock(&freelist_lock);
584 }
585
586
587 #define PER_CPU_THING(type,name)\
588 type SLOCKED(name##_lock) * RWPROTECT name;\
589 type SLOCKED(name##_lock) *\
590 (get_per_cpu_##name)()\
591 {\
592         { R_PERMITTED(global(name))\
593                 return &name[core_id()];\
594         }\
595 }
596
597
598 /* This is the top-half of an interrupt handler, where the bottom half is
599  * proc_run (which never returns).  Just add it to the delayed work queue,
600  * which (incidentally) can only hold one item at this point.
601  *
602  * Note this is rather old, and meant to run a RUNNABLE_S on a worker core.
603  */
604 #ifdef __IVY__
605 void run_env_handler(trapframe_t *tf, env_t * data)
606 #else
607 void run_env_handler(trapframe_t *tf, void * data)
608 #endif
609 {
610         assert(data);
611         struct work TP(env_t *) job;
612         struct workqueue TP(env_t *) *CT(1) workqueue =
613             TC(&per_cpu_info[core_id()].workqueue);
614         // this doesn't work, and making it a TP(env_t) is wrong
615         // zra: When you want to use other types, let me know, and I can help
616     // make something that Ivy is happy with. 
617 #ifdef __IVY__
618         job.func = proc_run;
619 #else
620         job.func = (func_t)proc_run;
621 #endif
622         job.data = data;
623         if (enqueue_work(workqueue, &job))
624                 panic("Failed to enqueue work!");
625 }