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