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