Andrew's port to sparc
[akaros.git] / kern / src / env.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 //#pragma nodeputy
4 #pragma noasync
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 <env.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <monitor.h>
19 #include <manager.h>
20
21 #include <ros/syscall.h>
22 #include <ros/error.h>
23
24 env_t *envs = NULL;             // All environments
25 atomic_t num_envs = atomic_init(0);
26 // TODO: make this a struct of info including the pointer and cacheline-align it
27 // This lets the kernel know what process is running on the core it traps into.
28 // A lot of the Env business, including this and its usage, will change when we
29 // redesign the env as a multi-process.
30 env_t* curenvs[MAX_NUM_CPUS] = {[0 ... (MAX_NUM_CPUS-1)] NULL};
31 static env_list_t env_free_list;        // Free list
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         env_t* curenv = curenvs[core_id()];
48
49         // If envid is zero, return the current environment.
50         if (envid == 0) {
51                 *env_store = curenv;
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->env_status == 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         if (checkperm && e != curenv && e->env_parent_id != curenv->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 env_free_list.
83 // Insert in reverse order, so that the first call to env_alloc()
84 // returns envs[0].
85 //
86 void
87 env_init(void)
88 {
89         int i;
90         LIST_INIT(&env_free_list);
91         assert(envs != NULL);
92         for (i = NENV-1; i >= 0; i--) { TRUSTEDBLOCK // asw ivy workaround
93                 // these should already be set from when i memset'd the array to 0
94                 envs[i].env_status = ENV_FREE;
95                 envs[i].env_id = 0;
96                 LIST_INSERT_HEAD(&env_free_list, &envs[i], env_link);
97         }
98 }
99
100 //
101 // Initialize the kernel virtual memory layout for environment e.
102 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
103 // and initialize the kernel portion of the new environment's address space.
104 // Do NOT (yet) map anything into the user portion
105 // of the environment's virtual address space.
106 //
107 // Returns 0 on success, < 0 on error.  Errors include:
108 //      -ENOMEM if page directory or table could not be allocated.
109 //
110 static int
111 env_setup_vm(env_t *e)
112 WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_procdata,
113        e->env_sysbackring)
114 {
115         int i, r;
116         page_t *pgdir = NULL, *pginfo = NULL, *pgdata = NULL;
117
118         // Allocate pages for the page directory, shared info, and shared data pages
119         r = page_alloc(&pgdir);
120         r = page_alloc(&pginfo);
121         r = page_alloc(&pgdata);
122         if (r < 0) {
123                 page_free(pgdir);
124                 page_free(pginfo);
125                 return r;
126         }
127
128         // Now, set e->env_pgdir and e->env_cr3,
129         // and initialize the page directory.
130         //
131         // Hint:
132         //    - The VA space of all envs is identical above UTOP
133         //      (except at VPT and UVPT, which we've set below).
134         //      (and not for UINFO either)
135         //      See inc/memlayout.h for permissions and layout.
136         //      Can you use boot_pgdir as a template?  Hint: Yes.
137         //      (Make sure you got the permissions right in Lab 2.)
138         //    - The initial VA below UTOP is empty.
139         //    - You do not need to make any more calls to page_alloc.
140         //    - Note: pp_ref is not maintained for most physical pages
141         //      mapped above UTOP -- but you do need to increment
142         //      env_pgdir's pp_ref!
143
144         // need to up pgdir's reference, since it will never be done elsewhere
145         pgdir->pp_ref++;
146         e->env_pgdir = page2kva(pgdir);
147         e->env_cr3 = page2pa(pgdir);
148         e->env_procinfo = page2kva(pginfo);
149         e->env_procdata = page2kva(pgdata);
150
151         memset(page2kva(pgdir), 0, PGSIZE);
152         memset(e->env_procinfo, 0, PGSIZE);
153         memset(e->env_procdata, 0, PGSIZE);
154
155         // Initialize the generic syscall ring buffer
156         SHARED_RING_INIT((syscall_sring_t *SAFE)e->env_procdata);
157         // Initialize the backend of the ring buffer
158         BACK_RING_INIT(&e->env_sysbackring, (syscall_sring_t *SAFE)e->env_procdata,
159                        PGSIZE);
160
161         // should be able to do this so long as boot_pgdir never has
162         // anything put below UTOP
163         memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
164
165         // something like this.  TODO, if you want
166         //memcpy(&e->env_pgdir[PDX(UTOP)], &boot_pgdir[PDX(UTOP)], PGSIZE - PDX(UTOP));
167         // check with
168         // assert(memcmp(e->env_pgdir, boot_pgdir, PGSIZE) == 0);
169
170         // VPT and UVPT map the env's own page table, with
171         // different permissions.
172         e->env_pgdir[PDX(VPT)]  = PTE(PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
173         e->env_pgdir[PDX(UVPT)] = PTE(PPN(e->env_cr3), PTE_P | PTE_USER_RO);
174
175         // Insert the per-process info and data pages into this process's pgdir
176         // I don't want to do these two pages later (like with the stack), since
177         // the kernel wants to keep pointers to it easily.
178         // Could place all of this with a function that maps a shared memory page
179         // that can work between any two address spaces or something.
180         r = page_insert(e->env_pgdir, pginfo, (void*SNT)UINFO, PTE_USER_RO);
181         r = page_insert(e->env_pgdir, pgdata, (void*SNT)UDATA, PTE_USER_RW);
182         if (r < 0) {
183                 // note that we can't currently deallocate the pages created by
184                 // pgdir_walk (inside insert).  should be able to gather them up when
185                 // we destroy environments and their page tables.
186                 page_free(pgdir);
187                 page_free(pginfo);
188                 page_free(pgdata);
189                 return r;
190         }
191
192         /* Shared page for all processes.  Can't be trusted, but still very useful
193          * at this stage for us.  Consider removing when we have real processes.
194          * (TODO).  Note the page is alloced only the first time through
195          */
196         static page_t* shared_page = 0;
197         if (!shared_page)
198                 page_alloc(&shared_page);
199         // Up it, so it never goes away.  One per user, plus one from page_alloc
200         // This is necessary, since it's in the per-process range of memory that
201         // gets freed during page_free.
202         shared_page->pp_ref++;
203
204         // Inserted into every process's address space at UGDATA
205         page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_USER_RW);
206
207         return 0;
208 }
209
210 //
211 // Allocates and initializes a new environment.
212 // On success, the new environment is stored in *newenv_store.
213 //
214 // Returns 0 on success, < 0 on failure.  Errors include:
215 //      -ENOFREEENV if all NENVS environments are allocated
216 //      -ENOMEM on memory exhaustion
217 //
218 int
219 env_alloc(env_t **newenv_store, envid_t parent_id)
220 {
221         int32_t generation;
222         int r;
223         env_t *e;
224
225         if (!(e = LIST_FIRST(&env_free_list)))
226                 return -ENOFREEENV;
227         
228         //memset((void*)e + sizeof(e->env_link), 0, sizeof(*e) - sizeof(e->env_link));
229
230     { INITSTRUCT(*e)
231
232         // Allocate and set up the page directory for this environment.
233         if ((r = env_setup_vm(e)) < 0)
234                 return r;
235
236         // Generate an env_id for this environment.
237         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
238         if (generation <= 0)    // Don't create a negative env_id.
239                 generation = 1 << ENVGENSHIFT;
240         e->env_id = generation | (e - envs);
241
242         // Set the basic status variables.
243     e->lock = 0;
244         e->env_parent_id = parent_id;
245         e->env_status = ENV_RUNNABLE;
246         e->env_runs = 0;
247         e->env_refcnt = 1;
248         e->env_flags = 0;
249
250         memset(&e->env_ancillary_state,0,sizeof(e->env_ancillary_state));
251         memset(&e->env_tf,0,sizeof(e->env_tf));
252         env_init_trapframe(e);
253
254         // commit the allocation
255         LIST_REMOVE(e, env_link);
256         *newenv_store = e;
257         atomic_inc(&num_envs);
258
259         e->env_tscfreq = system_timing.tsc_freq;
260         // TODO: for now, the only info at procinfo is this env's struct
261         // note that we need to copy this over every time we make a change to env
262         // that we want userspace to see.  also note that we don't even want to
263         // show them all of env, only specific things like PID, PPID, etc
264         memcpy(e->env_procinfo, e, sizeof(env_t));
265
266         env_t* curenv = curenvs[core_id()];
267
268         printk("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
269         } // INIT_STRUCT
270         return 0;
271 }
272
273 //
274 // Allocate len bytes of physical memory for environment env,
275 // and map it at virtual address va in the environment's address space.
276 // Does not zero or otherwise initialize the mapped pages in any way.
277 // Pages should be writable by user and kernel.
278 // Panic if any allocation attempt fails.
279 //
280 static void
281 segment_alloc(env_t *e, void *SNT va, size_t len)
282 {
283         void *SNT start, *SNT end;
284         size_t num_pages;
285         int i, r;
286         page_t *page;
287         pte_t *pte;
288
289         start = ROUNDDOWN(va, PGSIZE);
290         end = ROUNDUP(va + len, PGSIZE);
291         if (start >= end)
292                 panic("Wrap-around in memory allocation addresses!");
293         if ((uintptr_t)end > UTOP)
294                 panic("Attempting to map above UTOP!");
295         // page_insert/pgdir_walk alloc a page and read/write to it via its address
296         // starting from pgdir (e's), so we need to be using e's pgdir
297         assert(e->env_cr3 == rcr3());
298         num_pages = PPN(end - start);
299
300         for (i = 0; i < num_pages; i++, start += PGSIZE) {
301                 // skip if a page is already mapped.  yes, page_insert will page_remove
302                 // whatever page was already there, but if we are seg allocing adjacent
303                 // regions, we don't want to destroy that old mapping/page
304                 // though later on we are told we can ignore this...
305                 pte = pgdir_walk(e->env_pgdir, start, 0);
306                 if (pte && *pte & PTE_P)
307                         continue;
308                 if ((r = page_alloc(&page)) < 0)
309                         panic("segment_alloc: %e", r);
310                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
311         }
312 }
313
314 //
315 // Set up the initial program binary, stack, and processor flags
316 // for a user process.
317 // This function is ONLY called during kernel initialization,
318 // before running the first user-mode environment.
319 //
320 // This function loads all loadable segments from the ELF binary image
321 // into the environment's user memory, starting at the appropriate
322 // virtual addresses indicated in the ELF program header.
323 // At the same time it clears to zero any portions of these segments
324 // that are marked in the program header as being mapped
325 // but not actually present in the ELF file - i.e., the program's bss section.
326 //
327 // All this is very similar to what our boot loader does, except the boot
328 // loader also needs to read the code from disk.  Take a look at
329 // boot/main.c to get ideas.
330 //
331 // Finally, this function maps one page for the program's initial stack.
332 //
333 // load_icode panics if it encounters problems.
334 //  - How might load_icode fail?  What might be wrong with the given input?
335 //
336 static void
337 load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
338 {
339         // Hints:
340         //  Load each program segment into virtual memory
341         //  at the address specified in the ELF section header.
342         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
343         //  Each segment's virtual address can be found in ph->p_va
344         //  and its size in memory can be found in ph->p_memsz.
345         //  The ph->p_filesz bytes from the ELF binary, starting at
346         //  'binary + ph->p_offset', should be copied to virtual address
347         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
348         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
349         //  Use functions from the previous lab to allocate and map pages.
350         //
351         //  All page protection bits should be user read/write for now.
352         //  ELF segments are not necessarily page-aligned, but you can
353         //  assume for this function that no two segments will touch
354         //  the same virtual page.
355         //
356         //  You may find a function like segment_alloc useful.
357         //
358         //  Loading the segments is much simpler if you can move data
359         //  directly into the virtual addresses stored in the ELF binary.
360         //  So which page directory should be in force during
361         //  this function?
362         //
363         // Hint:
364         //  You must also do something with the program's entry point,
365         //  to make sure that the environment starts executing there.
366         //  What?  (See env_run() and env_pop_tf() below.)
367
368         // asw: copy the headers because they might not be aligned.
369         elf_t elfhdr;
370         proghdr_t phdr;
371         memcpy(&elfhdr,binary,sizeof(elfhdr));
372
373         int i, r;
374
375         // is this an elf?
376         assert(elfhdr.e_magic == ELF_MAGIC);
377         // make sure we have proghdrs to load
378         assert(elfhdr.e_phnum);
379
380         // to actually access any pages alloc'd for this environment, we
381         // need to have the hardware use this environment's page tables.
382         // we can use e's tables as long as we want, since it has the same
383         // mappings for the kernel as does boot_pgdir
384         lcr3(e->env_cr3);
385
386         // TODO: how do we do a runtime COUNT?
387         {TRUSTEDBLOCK
388         for (i = 0; i < elfhdr.e_phnum; i++) {
389                 memcpy(&phdr,binary+elfhdr.e_phoff+i*sizeof(phdr),sizeof(phdr));
390         // zra: TRUSTEDBLOCK until validation is done.
391                 if (phdr.p_type != ELF_PROG_LOAD)
392                         continue;
393         // TODO: validate elf header fields!
394                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
395                 // this, there will be issues with overlapping sections
396                 segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
397                 memcpy((void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz);
398                 memset((void*)phdr.p_va + phdr.p_filesz, 0, phdr.p_memsz - phdr.p_filesz);
399         }}
400
401         env_set_program_counter(e,elfhdr.e_entry);
402
403         // Now map one page for the program's initial stack
404         // at virtual address USTACKTOP - PGSIZE.
405
406         segment_alloc(e, (void*SNT)(USTACKTOP - PGSIZE), PGSIZE);
407 }
408
409 //
410 // Allocates a new env and loads the named elf binary into it.
411 //
412 env_t* env_create(uint8_t *binary, size_t size)
413 {
414         env_t *e;
415         int r;
416
417         if ((r = env_alloc(&e, 0)) < 0)
418                 panic("env_create: %e", r);
419         load_icode(e, binary, size);
420         return e;
421 }
422
423 //
424 // Frees env e and all memory it uses.
425 //
426 void
427 env_free(env_t *e)
428 {
429         physaddr_t pa;
430
431         // Note the environment's demise.
432         env_t* curenv = curenvs[core_id()];
433         cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
434
435         // Flush all mapped pages in the user portion of the address space
436         env_user_mem_free(e);
437
438         // Moved to page_decref
439         // need a known good pgdir before releasing the old one
440         //lcr3(PADDR(boot_pgdir));
441
442         // free the page directory
443         pa = e->env_cr3;
444         e->env_pgdir = 0;
445         e->env_cr3 = 0;
446         page_decref(pa2page(pa));
447
448         // return the environment to the free list
449         e->env_status = ENV_FREE;
450         LIST_INSERT_HEAD(&env_free_list, e, env_link);
451 }
452
453 /*
454  * This allows the kernel to keep this process around, in case it is being used
455  * in some asynchronous processing.
456  * The refcnt should always be greater than 0 for processes that aren't dying.
457  * When refcnt is 0, the process is dying and should not allow any more increfs.
458  * TODO: Make sure this is never called from an interrupt handler (irq_save)
459  */
460 error_t env_incref(env_t* e)
461 {
462         error_t retval = 0;
463         spin_lock(&e->lock);
464         if (e->env_refcnt)
465                 e->env_refcnt++;
466         else
467                 retval = -EBADENV;
468         spin_unlock(&e->lock);
469         return retval;
470 }
471
472 /*
473  * When the kernel is done with a process, it decrements its reference count.
474  * When the count hits 0, no one is using it and it should be freed.
475  * env_destroy calls this.
476  * TODO: Make sure this is never called from an interrupt handler (irq_save)
477  */
478 void env_decref(env_t* e)
479 {
480         // need a known good pgdir before releasing the old one
481         // sometimes env_free is called on a different core than decref
482         lcr3(PADDR(boot_pgdir));
483
484         spin_lock(&e->lock);
485         e->env_refcnt--;
486         spin_unlock(&e->lock);
487         // if we hit 0, no one else will increment and we can check outside the lock
488         if (e->env_refcnt == 0)
489                 env_free(e);
490 }
491
492
493 //
494 // Frees environment e.
495 // If e was the current env, then runs a new environment (and does not return
496 // to the caller).
497 //
498 void
499 env_destroy(env_t *e)
500 {
501         // TODO: race condition with env statuses, esp when running / destroying
502         e->env_status = ENV_DYING;
503
504         env_decref(e);
505         atomic_dec(&num_envs);
506
507         // for old envs that die on user cores.  since env run never returns, cores
508         // never get back to their old hlt/relaxed/spin state, so we need to force
509         // them back to an idle function.
510         uint32_t id = core_id();
511         // There is no longer a curenv for this core. (TODO: Think about this.)
512         curenvs[id] = NULL;
513         if (id) {
514                 smp_idle();
515                 panic("should never see me");
516         }
517         // else we're core 0 and can do the usual
518
519         /* Instead of picking a new environment to run, or defaulting to the monitor
520          * like before, for now we'll hop into the manager() function, which
521          * dispatches jobs.  Note that for now we start the manager from the top,
522          * and not from where we left off the last time we called manager.  That
523          * would require us to save some context (and a stack to work on) here.
524          */
525         manager();
526         assert(0); // never get here
527 }
528
529 /* ugly, but for now just linearly search through all possible
530  * environments for a runnable one.
531  * the current *policy* is to round-robin the search
532  */
533 void schedule(void)
534 {
535         env_t *e;
536         static int last_picked = 0;
537         
538         for (int i = 0, j = last_picked + 1; i < NENV; i++, j = (j + 1) % NENV) {
539                 e = &envs[ENVX(j)];
540                 // TODO: race here, if another core is just about to start this env.
541                 // Fix it by setting the status in something like env_dispatch when
542                 // we have multi-contexted processes
543                 if (e && e->env_status == ENV_RUNNABLE) {
544                         last_picked = j;
545                         env_run(e);
546                 }
547         }
548
549         cprintf("Destroyed the only environment - nothing more to do!\n");
550         while (1)
551                 monitor(NULL);
552 }
553
554 //
555 // Context switch from curenv to env e.
556 // Note: if this is the first call to env_run, curenv is NULL.
557 //  (This function does not return.)
558 //
559 void
560 env_run(env_t *e)
561 {
562         // Step 1: If this is a context switch (a new environment is running),
563         //         then set 'curenv' to the new environment,
564         //         update its 'env_runs' counter, and
565         //         and use lcr3() to switch to its address space.
566         // Step 2: Use env_pop_tf() to restore the environment's
567         //         registers and drop into user mode in the
568         //         environment.
569
570         // Hint: This function loads the new environment's state from
571         //      e->env_tf.  Go back through the code you wrote above
572         //      and make sure you have set the relevant parts of
573         //      e->env_tf to sensible values.
574
575         // TODO: race here with env destroy on the status and refcnt
576         // Could up the refcnt and down it when a process is not running
577         e->env_status = ENV_RUNNING;
578         if (e != curenvs[core_id()]) {
579                 curenvs[core_id()] = e;
580                 e->env_runs++;
581                 lcr3(e->env_cr3);
582         }
583
584         env_pop_ancillary_state(e);
585
586         env_pop_tf(&e->env_tf);
587 }
588
589 /* This is the top-half of an interrupt handler, where the bottom half is
590  * env_run (which never returns).  Just add it to the delayed work queue,
591  * which isn't really a queue yet.
592  */
593 void run_env_handler(trapframe_t *tf, void* data)
594 {
595         assert(data);
596         per_cpu_info_t *cpuinfo = &per_cpu_info[core_id()];
597         spin_lock_irqsave(&cpuinfo->lock);
598         { TRUSTEDBLOCK // TODO: how do we make this func_t cast work?
599         cpuinfo->delayed_work.func = (func_t)env_run;
600         cpuinfo->delayed_work.data = data;
601         }
602         spin_unlock_irqsave(&cpuinfo->lock);
603 }