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