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