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