Guts load_icode and proc_create() takes a path
[akaros.git] / kern / src / process.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details. */
4
5 #ifdef __SHARC__
6 #pragma nosharc
7 #endif
8
9 #include <ros/bcq.h>
10 #include <arch/arch.h>
11 #include <arch/bitmask.h>
12 #include <process.h>
13 #include <atomic.h>
14 #include <smp.h>
15 #include <pmap.h>
16 #include <trap.h>
17 #include <schedule.h>
18 #include <manager.h>
19 #include <stdio.h>
20 #include <assert.h>
21 #include <timing.h>
22 #include <hashtable.h>
23 #include <slab.h>
24 #include <sys/queue.h>
25 #include <frontend.h>
26 #include <monitor.h>
27 #include <resource.h>
28 #include <elf.h>
29
30 /* Process Lists */
31 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
32 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
33 struct kmem_cache *proc_cache;
34
35 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
36  * physical coreid of an unallocated core. */
37 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
38 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
39 uint32_t LCKD(&idle_lock) num_idlecores = 0;
40 uint32_t num_mgmtcores = 1;
41
42 /* Helper function to return a core to the idlemap.  It causes some more lock
43  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
44  * we might be able to do this without locks (for the putting). */
45 void put_idle_core(uint32_t coreid)
46 {
47         spin_lock(&idle_lock);
48         idlecoremap[num_idlecores++] = coreid;
49         spin_unlock(&idle_lock);
50 }
51
52 /* Other helpers, implemented later. */
53 static void __proc_startcore(struct proc *p, trapframe_t *tf);
54 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
55 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
56 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
57 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
58 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid);
59
60 /* PID management. */
61 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
62 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
63 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
64 struct hashtable *pid_hash;
65 spinlock_t pid_hash_lock; // initialized in proc_init
66
67 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
68  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
69  * you'll also see a warning, for now).  Consider doing this with atomics. */
70 static pid_t get_free_pid(void)
71 {
72         static pid_t next_free_pid = 1;
73         pid_t my_pid = 0;
74
75         spin_lock(&pid_bmask_lock);
76         // atomically (can lock for now, then change to atomic_and_return
77         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
78                 // always points to the next to test
79                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
80                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
81                         SET_BITMASK_BIT(pid_bmask, i);
82                         my_pid = i;
83                         break;
84                 }
85         }
86         spin_unlock(&pid_bmask_lock);
87         if (!my_pid)
88                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
89         return my_pid;
90 }
91
92 /* Return a pid to the pid bitmask */
93 static void put_free_pid(pid_t pid)
94 {
95         spin_lock(&pid_bmask_lock);
96         CLR_BITMASK_BIT(pid_bmask, pid);
97         spin_unlock(&pid_bmask_lock);
98 }
99
100 /* While this could be done with just an assignment, this gives us the
101  * opportunity to check for bad transitions.  Might compile these out later, so
102  * we shouldn't rely on them for sanity checking from userspace.  */
103 int __proc_set_state(struct proc *p, uint32_t state)
104 {
105         uint32_t curstate = p->state;
106         /* Valid transitions:
107          * C   -> RBS
108          * RBS -> RGS
109          * RGS -> RBS
110          * RGS -> W
111          * W   -> RBS
112          * RGS -> RBM
113          * RBM -> RGM
114          * RGM -> RBM
115          * RGM -> RBS
116          * RGS -> D
117          * RGM -> D
118          *
119          * These ought to be implemented later (allowed, not thought through yet).
120          * RBS -> D
121          * RBM -> D
122          *
123          * This isn't allowed yet, should be later.  Is definitely causable.
124          * C   -> D
125          */
126         #if 1 // some sort of correctness flag
127         switch (curstate) {
128                 case PROC_CREATED:
129                         if (state != PROC_RUNNABLE_S)
130                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
131                         break;
132                 case PROC_RUNNABLE_S:
133                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
134                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
135                         break;
136                 case PROC_RUNNING_S:
137                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
138                                        PROC_DYING)))
139                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
140                         break;
141                 case PROC_WAITING:
142                         if (state != PROC_RUNNABLE_S)
143                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
144                         break;
145                 case PROC_DYING:
146                         if (state != PROC_CREATED) // when it is reused (TODO)
147                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
148                         break;
149                 case PROC_RUNNABLE_M:
150                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
151                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
152                         break;
153                 case PROC_RUNNING_M:
154                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
155                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
156                         break;
157         }
158         #endif
159         p->state = state;
160         return 0;
161 }
162
163 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
164 struct proc *pid2proc(pid_t pid)
165 {
166         spin_lock(&pid_hash_lock);
167         struct proc *p = hashtable_search(pid_hash, (void*)pid);
168         spin_unlock(&pid_hash_lock);
169         /* if the refcnt was 0, decref and return 0 (we failed). (TODO) */
170         if (p)
171                 proc_incref(p, 1); // TODO:(REF) to do this all atomically and not panic
172         return p;
173 }
174
175 /* Performs any initialization related to processes, such as create the proc
176  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
177  * any process related function. */
178 void proc_init(void)
179 {
180         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
181                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
182         /* Init PID mask and hash.  pid 0 is reserved. */
183         SET_BITMASK_BIT(pid_bmask, 0);
184         spinlock_init(&pid_hash_lock);
185         spin_lock(&pid_hash_lock);
186         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
187         spin_unlock(&pid_hash_lock);
188         schedule_init();
189         /* Init idle cores. Core 0 is the management core. */
190         spin_lock(&idle_lock);
191 #ifdef __CONFIG_DISABLE_SMT__
192         /* assumes core0 is the only management core (NIC and monitor functionality
193          * are run there too.  it just adds the odd cores to the idlecoremap */
194         assert(!(num_cpus % 2));
195         // TODO: consider checking x86 for machines that actually hyperthread
196         num_idlecores = num_cpus >> 1;
197         for (int i = 0; i < num_idlecores; i++)
198                 idlecoremap[i] = (i * 2) + 1;
199 #else
200         #ifdef __CONFIG_NETWORKING__
201         num_mgmtcores++; // Next core is dedicated to the NIC
202         assert(num_cpus >= num_mgmtcores);
203         #endif
204         #ifdef __CONFIG_APPSERVER__
205         #ifdef __CONFIG_DEDICATED_MONITOR__
206         num_mgmtcores++; // Next core dedicated to running the kernel monitor
207         assert(num_cpus >= num_mgmtcores);
208         // Need to subtract 1 from the num_mgmtcores # to get the cores index
209         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
210         #endif
211         #endif
212         num_idlecores = num_cpus - num_mgmtcores;
213         for (int i = 0; i < num_idlecores; i++)
214                 idlecoremap[i] = i + num_mgmtcores;
215 #endif /* __CONFIG_DISABLE_SMT__ */
216         spin_unlock(&idle_lock);
217         atomic_init(&num_envs, 0);
218 }
219
220 void
221 proc_init_procinfo(struct proc* p)
222 {
223         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
224         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
225         p->procinfo->num_vcores = 0;
226         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
227         // TODO: change these too
228         p->procinfo->pid = p->pid;
229         p->procinfo->ppid = p->ppid;
230         p->procinfo->tsc_freq = system_timing.tsc_freq;
231         // TODO: maybe do something smarter here
232 #ifdef __CONFIG_DISABLE_SMT__
233         p->procinfo->max_vcores = num_cpus >> 1;
234 #else
235         p->procinfo->max_vcores = MAX(1,num_cpus-num_mgmtcores);
236 #endif /* __CONFIG_DISABLE_SMT__ */
237 }
238
239 /* Allocates and initializes a process, with the given parent.  Currently
240  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
241  * Errors include:
242  *  - ENOFREEPID if it can't get a PID
243  *  - ENOMEM on memory exhaustion */
244 error_t proc_alloc(struct proc **pp, struct proc *parent)
245 {
246         error_t r;
247         struct proc *p;
248
249         if (!(p = kmem_cache_alloc(proc_cache, 0)))
250                 return -ENOMEM;
251
252         { INITSTRUCT(*p)
253
254         // Setup the default map of where to get cache colors from
255         p->cache_colors_map = global_cache_colors_map;
256         p->next_cache_color = 0;
257
258         /* Initialize the address space */
259         if ((r = env_setup_vm(p)) < 0) {
260                 kmem_cache_free(proc_cache, p);
261                 return r;
262         }
263
264         /* Get a pid, then store a reference in the pid_hash */
265         if (!(p->pid = get_free_pid())) {
266                 kmem_cache_free(proc_cache, p);
267                 return -ENOFREEPID;
268         }
269         spin_lock(&pid_hash_lock);
270         hashtable_insert(pid_hash, (void*)p->pid, p);
271         spin_unlock(&pid_hash_lock);
272
273         /* Set the basic status variables. */
274         spinlock_init(&p->proc_lock);
275         p->exitcode = 0;
276         p->ppid = parent ? parent->pid : 0;
277         p->state = PROC_CREATED; // shouldn't go through state machine for init
278         p->env_refcnt = 2; // one for the object, one for the ref we pass back
279         p->env_flags = 0;
280         p->env_entry = 0; // cheating.  this really gets set later
281         p->procinfo->heap_bottom = (void*)UTEXT;
282         p->heap_top = (void*)UTEXT;
283         memset(&p->resources, 0, sizeof(p->resources));
284         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
285         memset(&p->env_tf, 0, sizeof(p->env_tf));
286         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
287
288         /* Initialize the contents of the e->procinfo structure */
289         proc_init_procinfo(p);
290         /* Initialize the contents of the e->procdata structure */
291
292         /* Initialize the generic syscall ring buffer */
293         SHARED_RING_INIT(&p->procdata->syscallring);
294         /* Initialize the backend of the syscall ring buffer */
295         BACK_RING_INIT(&p->syscallbackring,
296                        &p->procdata->syscallring,
297                        SYSCALLRINGSIZE);
298
299         /* Initialize the generic sysevent ring buffer */
300         SHARED_RING_INIT(&p->procdata->syseventring);
301         /* Initialize the frontend of the sysevent ring buffer */
302         FRONT_RING_INIT(&p->syseventfrontring,
303                         &p->procdata->syseventring,
304                         SYSEVENTRINGSIZE);
305
306         /* Init FS structures TODO: cleanup (might pull this out) */
307         atomic_inc(&default_ns.refcnt);
308         p->ns = &default_ns;
309         spinlock_init(&p->fs_env.lock);
310         p->fs_env.umask = parent ? parent->fs_env.umask : 0002;
311         p->fs_env.root = p->ns->root->mnt_root;
312         atomic_inc(&p->fs_env.root->d_refcnt);
313         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
314         atomic_inc(&p->fs_env.pwd->d_refcnt);
315         spinlock_init(&p->open_files.lock);
316         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
317         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
318         p->open_files.fd = p->open_files.fd_array;
319         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
320         /* 0, 1, and 2 are reserved, but prob shouldn't do it this way */
321         p->open_files.next_fd = 3;
322         for (int i = 0; i < 3; i++)
323                 SET_BITMASK_BIT(p->open_files.open_fds->fds_bits, i);
324
325         *pp = p;
326         atomic_inc(&num_envs);
327
328         frontend_proc_init(p);
329
330         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
331         } // INIT_STRUCT
332         return 0;
333 }
334
335 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
336  * rid of proc_alloc's style, but it is so quaint... */
337 struct proc *proc_create(struct file *prog, char **argv, char **envp)
338 {
339         struct proc *p;
340         error_t r;
341         if ((r = proc_alloc(&p, current)) < 0)
342                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
343         procinfo_pack_args(p->procinfo, argv, envp);
344         assert(load_elf(p, prog) == 0);
345         return p;
346 }
347
348 /* This is called by proc_decref, once the last reference to the process is
349  * gone.  Don't call this otherwise (it will panic).  It will clean up the
350  * address space and deallocate any other used memory. */
351 static void __proc_free(struct proc *p)
352 {
353         physaddr_t pa;
354
355         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
356         // All parts of the kernel should have decref'd before __proc_free is called
357         assert(p->env_refcnt == 0);
358
359         frontend_proc_free(p);
360
361         // Free any colors allocated to this process
362         if(p->cache_colors_map != global_cache_colors_map) {
363                 for(int i=0; i<llc_cache->num_colors; i++)
364                         cache_color_free(llc_cache, p->cache_colors_map);
365                 cache_colors_map_free(p->cache_colors_map);
366         }
367
368         // Flush all mapped pages in the user portion of the address space
369         env_user_mem_free(p, 0, UVPT);
370         /* These need to be free again, since they were allocated with a refcnt. */
371         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
372         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
373
374         env_pagetable_free(p);
375         p->env_pgdir = 0;
376         p->env_cr3 = 0;
377
378         /* Remove self from the pid hash, return PID.  Note the reversed order. */
379         spin_lock(&pid_hash_lock);
380         if (!hashtable_remove(pid_hash, (void*)p->pid))
381                 panic("Proc not in the pid table in %s", __FUNCTION__);
382         spin_unlock(&pid_hash_lock);
383         put_free_pid(p->pid);
384         atomic_dec(&num_envs);
385
386         /* Dealloc the struct proc */
387         kmem_cache_free(proc_cache, p);
388 }
389
390 /* Whether or not actor can control target.  Note we currently don't need
391  * locking for this. TODO: think about that, esp wrt proc's dying. */
392 bool proc_controls(struct proc *actor, struct proc *target)
393 {
394         return ((actor == target) || (target->ppid == actor->pid));
395 }
396
397 /* Dispatches a process to run, either on the current core in the case of a
398  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
399  * never be called to "restart" a core.  This expects that the "instructions"
400  * for which core(s) to run this on will be in the vcoremap, which needs to be
401  * set externally.
402  *
403  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
404  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
405  * it's old core0 context, and the other cores will come in at the entry point.
406  * Including in the case of preemption.
407  *
408  * This won't return if the current core is going to be one of the processes
409  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
410  * eat your reference if it does not return. */
411 void proc_run(struct proc *p)
412 {
413         bool self_ipi_pending = FALSE;
414         spin_lock(&p->proc_lock);
415
416         switch (p->state) {
417                 case (PROC_DYING):
418                         spin_unlock(&p->proc_lock);
419                         printk("Process %d not starting due to async death\n", p->pid);
420                         // if we're a worker core, smp_idle, o/w return
421                         if (!management_core())
422                                 smp_idle(); // this never returns
423                         return;
424                 case (PROC_RUNNABLE_S):
425                         assert(current != p);
426                         __proc_set_state(p, PROC_RUNNING_S);
427                         /* We will want to know where this process is running, even if it is
428                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
429                          * Also, this is the signal used in trap.c to know to save the tf in
430                          * env_tf. */
431                         __seq_start_write(&p->procinfo->coremap_seqctr);
432                         p->procinfo->num_vcores = 0;
433                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
434                         __seq_end_write(&p->procinfo->coremap_seqctr);
435                         /* __proc_startcore assumes the reference we give it is for current.
436                          * Decref if current is already properly set. */
437                         if (p == current)
438                                 p->env_refcnt--; // TODO: (REF) use incref
439                         /* We don't want to process routine messages here, since it's a bit
440                          * different than when we perform a syscall in this process's
441                          * context.  We want interrupts disabled so that if there was a
442                          * routine message on the way, we'll get the interrupt once we pop
443                          * back to userspace.  */
444                         spin_unlock(&p->proc_lock);
445                         disable_irq();
446                         __proc_startcore(p, &p->env_tf);
447                         break;
448                 case (PROC_RUNNABLE_M):
449                         /* vcoremap[i] holds the coreid of the physical core allocated to
450                          * this process.  It is set outside proc_run.  For the kernel
451                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
452                         if (p->procinfo->num_vcores) {
453                                 __proc_set_state(p, PROC_RUNNING_M);
454                                 /* Up the refcnt, since num_vcores are going to start using this
455                                  * process and have it loaded in their 'current'. */
456                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
457                                 /* If the core we are running on is in the vcoremap, we will get
458                                  * an IPI (once we reenable interrupts) and never return. */
459                                 if (is_mapped_vcore(p, core_id()))
460                                         self_ipi_pending = TRUE;
461                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
462                                         send_kernel_message(get_pcoreid(p, i), __startcore, p, 0,
463                                                             0, KMSG_ROUTINE);
464                         } else {
465                                 warn("Tried to proc_run() an _M with no vcores!");
466                         }
467                         /* Unlock and decref/wait for the IPI if one is pending.  This will
468                          * eat the reference if we aren't returning.
469                          *
470                          * There a subtle race avoidance here.  __proc_startcore can handle
471                          * a death message, but we can't have the startcore come after the
472                          * death message.  Otherwise, it would look like a new process.  So
473                          * we hold the lock til after we send our message, which prevents a
474                          * possible death message.
475                          * - Note there is no guarantee this core's interrupts were on, so
476                          *   it may not get the message for a while... */
477                         spin_unlock(&p->proc_lock);
478                         __proc_kmsg_pending(p, self_ipi_pending);
479                         break;
480                 default:
481                         spin_unlock(&p->proc_lock);
482                         panic("Invalid process state %p in proc_run()!!", p->state);
483         }
484 }
485
486 /* Actually runs the given context (trapframe) of process p on the core this
487  * code executes on.  This is called directly by __startcore, which needs to
488  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
489  *
490  * A note on refcnting: this function will not return, and your proc reference
491  * will end up stored in current.  This will make no changes to p's refcnt, so
492  * do your accounting such that there is only the +1 for current.  This means if
493  * it is already in current (like in the trap return path), don't up it.  If
494  * it's already in current and you have another reference (like pid2proc or from
495  * an IPI), then down it (which is what happens in __startcore()).  If it's not
496  * in current and you have one reference, like proc_run(non_current_p), then
497  * also do nothing.  The refcnt for your *p will count for the reference stored
498  * in current. */
499 static void __proc_startcore(struct proc *p, trapframe_t *tf)
500 {
501         assert(!irq_is_enabled());
502         /* If the process wasn't here, then we need to load its address space. */
503         if (p != current) {
504                 /* Do not incref here.  We were given the reference to current,
505                  * pre-upped. */
506                 lcr3(p->env_cr3);
507                 /* This is "leaving the process context" of the previous proc.  The
508                  * previous lcr3 unloaded the previous proc's context.  This should
509                  * rarely happen, since we usually proactively leave process context,
510                  * but is the fallback. */
511                 if (current)
512                         proc_decref(current, 1);
513                 set_current_proc(p);
514         }
515         /* need to load our silly state, preferably somewhere other than here so we
516          * can avoid the case where the context was just running here.  it's not
517          * sufficient to do it in the "new process" if-block above (could be things
518          * like page faults that cause us to keep the same process, but want a
519          * different context.
520          * for now, we load this silly state here. (TODO) (HSS)
521          * We also need this to be per trapframe, and not per process...
522          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
523          * __startcore.  */
524         if (p->state == PROC_RUNNING_S)
525                 env_pop_ancillary_state(p);
526         env_pop_tf(tf);
527 }
528
529 /* Restarts the given context (trapframe) of process p on the core this code
530  * executes on.  Calls an internal function to do the work.
531  *
532  * In case there are pending routine messages, like __death, __preempt, or
533  * __notify, we need to run them.  Alternatively, if there are any, we could
534  * self_ipi, and run the messages immediately after popping back to userspace,
535  * but that would have crappy overhead.
536  *
537  * Refcnting: this will not return, and it assumes that you've accounted for
538  * your reference as if it was the ref for "current" (which is what happens when
539  * returning from local traps and such. */
540 void proc_restartcore(struct proc *p, trapframe_t *tf)
541 {
542         // TODO: proc_restartcore shouldn't ever be called with tf != current_tf,
543         // so the parameter should probably be removed outright.
544         assert(current_tf == tf);
545
546         /* Need ints disabled when we return from processing (race) */
547         disable_irq();
548         process_routine_kmsg();
549         __proc_startcore(p, tf);
550 }
551
552 /*
553  * Destroys the given process.  This may be called from another process, a light
554  * kernel thread (no real process context), asynchronously/cross-core, or from
555  * the process on its own core.
556  *
557  * Here's the way process death works:
558  * 0. grab the lock (protects state transition and core map)
559  * 1. set state to dying.  that keeps the kernel from doing anything for the
560  * process (like proc_running it).
561  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
562  * 3. IPI to clean up those cores (decref, etc).
563  * 4. Unlock
564  * 5. Clean up your core, if applicable
565  * (Last core/kernel thread to decref cleans up and deallocates resources.)
566  *
567  * Note that some cores can be processing async calls, but will eventually
568  * decref.  Should think about this more, like some sort of callback/revocation.
569  *
570  * This will eat your reference if it won't return.  Note that this function
571  * needs to change anyways when we make __death more like __preempt.  (TODO) */
572 void proc_destroy(struct proc *p)
573 {
574         bool self_ipi_pending = FALSE;
575
576         spin_lock(&p->proc_lock);
577
578         /* TODO: (DEATH) look at this again when we sort the __death IPI */
579         if (current == p)
580                 self_ipi_pending = TRUE;
581
582         switch (p->state) {
583                 case PROC_DYING: // someone else killed this already.
584                         spin_unlock(&p->proc_lock);
585                         __proc_kmsg_pending(p, self_ipi_pending);
586                         return;
587                 case PROC_RUNNABLE_M:
588                         /* Need to reclaim any cores this proc might have, even though it's
589                          * not running yet. */
590                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
591                         // fallthrough
592                 case PROC_RUNNABLE_S:
593                         // Think about other lists, like WAITING, or better ways to do this
594                         deschedule_proc(p);
595                         break;
596                 case PROC_RUNNING_S:
597                         #if 0
598                         // here's how to do it manually
599                         if (current == p) {
600                                 lcr3(boot_cr3);
601                                 proc_decref(p, 1); // this decref is for the cr3
602                                 current = NULL;
603                         }
604                         #endif
605                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
606                                             KMSG_ROUTINE);
607                         __seq_start_write(&p->procinfo->coremap_seqctr);
608                         // TODO: might need to sort num_vcores too later (VC#)
609                         /* vcore is unmapped on the receive side */
610                         __seq_end_write(&p->procinfo->coremap_seqctr);
611                         #if 0
612                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
613                          * managed by the idlecoremap.  so don't do this yet. */
614                         put_idle_core(get_pcoreid(p, 0));
615                         #endif
616                         break;
617                 case PROC_RUNNING_M:
618                         /* Send the DEATH message to every core running this process, and
619                          * deallocate the cores.
620                          * The rule is that the vcoremap is set before proc_run, and reset
621                          * within proc_destroy */
622                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
623                                              (void *SNT)0);
624                         break;
625                 default:
626                         panic("Weird state(%s) in %s()", procstate2str(p->state),
627                               __FUNCTION__);
628         }
629         __proc_set_state(p, PROC_DYING);
630         /* this decref is for the process in general */
631         p->env_refcnt--; // TODO (REF)
632         //proc_decref(p, 1);
633
634         /* Unlock and possible decref and wait.  A death IPI should be on its way,
635          * either from the RUNNING_S one, or from proc_take_cores with a __death.
636          * in general, interrupts should be on when you call proc_destroy locally,
637          * but currently aren't for all things (like traphandlers). */
638         spin_unlock(&p->proc_lock);
639         __proc_kmsg_pending(p, self_ipi_pending);
640         return;
641 }
642
643 /* Helper function.  Starting from prev, it will find the next free vcoreid,
644  * which is the next vcore that is not valid.
645  * You better hold the lock before calling this. */
646 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
647 {
648         uint32_t i;
649         for (i = prev; i < MAX_NUM_CPUS; i++)
650                 if (!p->procinfo->vcoremap[i].valid)
651                         break;
652         if (i + 1 >= MAX_NUM_CPUS)
653                 warn("At the end of the vcorelist.  Might want to check that out.");
654         return i;
655 }
656
657 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
658  * which is the next vcore that is valid.
659  * You better hold the lock before calling this. */
660 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
661 {
662         uint32_t i;
663         for (i = prev; i < MAX_NUM_CPUS; i++)
664                 if (p->procinfo->vcoremap[i].valid)
665                         break;
666         if (i + 1 >= MAX_NUM_CPUS)
667                 warn("At the end of the vcorelist.  Might want to check that out.");
668         return i;
669 }
670
671 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
672  * careful. */
673 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
674 {
675         return p->procinfo->pcoremap[pcoreid].valid;
676 }
677
678 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
679  * No locking involved, be careful.  Panics on failure. */
680 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
681 {
682         assert(is_mapped_vcore(p, pcoreid));
683         return p->procinfo->pcoremap[pcoreid].vcoreid;
684 }
685
686 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
687  * No locking involved, be careful.  Panics on failure. */
688 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
689 {
690         assert(p->procinfo->vcoremap[vcoreid].valid);
691         return p->procinfo->vcoremap[vcoreid].pcoreid;
692 }
693
694 /* Yields the calling core.  Must be called locally (not async) for now.
695  * - If RUNNING_S, you just give up your time slice and will eventually return.
696  * - If RUNNING_M, you give up the current vcore (which never returns), and
697  *   adjust the amount of cores wanted/granted.
698  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
699  *   you'll have one guaranteed core, starting from the entry point.
700  *
701  * - RES_CORES amt_wanted will be the amount running after taking away the
702  *   yielder, unless there are none left, in which case it will be 1.
703  *
704  * If the call is being nice, it means that it is in response to a preemption
705  * (which needs to be checked).  If there is no preemption pending, just return.
706  * No matter what, don't adjust the number of cores wanted.
707  *
708  * This usually does not return (abandon_core()), so it will eat your reference.
709  * */
710 void proc_yield(struct proc *SAFE p, bool being_nice)
711 {
712         uint32_t vcoreid = get_vcoreid(p, core_id());
713         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
714
715         /* no reason to be nice, return */
716         if (being_nice && !vc->preempt_pending)
717                 return;
718
719         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
720
721         /* fate is sealed, return and take the preempt message on the way out.
722          * we're making this check while holding the lock, since the preemptor
723          * should hold the lock when sending messages. */
724         if (vc->preempt_served) {
725                 spin_unlock(&p->proc_lock);
726                 return;
727         }
728         /* no need to preempt later, since we are yielding (nice or otherwise) */
729         if (vc->preempt_pending)
730                 vc->preempt_pending = 0;
731
732         switch (p->state) {
733                 case (PROC_RUNNING_S):
734                         p->env_tf= *current_tf;
735                         env_push_ancillary_state(p); // TODO: (HSS)
736                         __proc_set_state(p, PROC_RUNNABLE_S);
737                         schedule_proc(p);
738                         break;
739                 case (PROC_RUNNING_M):
740                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
741                                get_vcoreid(p, core_id()));
742                         /* TODO: (RMS) the Scheduler cannot handle the Runnable Ms (RMS), so
743                          * don't yield the last vcore. */
744                         if (p->procinfo->num_vcores == 1) {
745                                 spin_unlock(&p->proc_lock);
746                                 return;
747                         }
748                         __seq_start_write(&p->procinfo->coremap_seqctr);
749                         // give up core
750                         __unmap_vcore(p, get_vcoreid(p, core_id()));
751                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
752                         if (!being_nice)
753                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
754                         __seq_end_write(&p->procinfo->coremap_seqctr);
755                         // add to idle list
756                         put_idle_core(core_id());
757                         // last vcore?  then we really want 1, and to yield the gang
758                         // TODO: (RMS) will actually do this.
759                         if (p->procinfo->num_vcores == 0) {
760                                 p->resources[RES_CORES].amt_wanted = 1;
761                                 __proc_set_state(p, PROC_RUNNABLE_M);
762                                 schedule_proc(p);
763                         }
764                         break;
765                 default:
766                         // there are races that can lead to this (async death, preempt, etc)
767                         panic("Weird state(%s) in %s()", procstate2str(p->state),
768                               __FUNCTION__);
769         }
770         spin_unlock(&p->proc_lock);
771         proc_decref(p, 1); // need to eat the ref passed in.
772         /* TODO: (RMS) If there was a change to the idle cores, try and give our
773          * core to someone who was preempted. */
774         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
775          * manager, which will call schedule() and will repick the yielding proc. */
776         abandon_core();
777 }
778
779 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
780 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
781                struct notif_event *ne)
782 {
783         printd("sending notif %d to proc %p\n", notif, p);
784         assert(notif < MAX_NR_NOTIF);
785         if (ne)
786                 assert(notif == ne->ne_type);
787
788         struct notif_method *nm = &p->procdata->notif_methods[notif];
789         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
790
791         printd("nm = %p, vcpd = %p\n", nm, vcpd);
792         /* enqueue notif message or toggle bits */
793         if (ne && nm->flags & NOTIF_MSG) {
794                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
795                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
796                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
797                 }
798         } else {
799                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
800         }
801
802         /* Active notification */
803         /* TODO: Currently, there is a race for notif_pending, and multiple senders
804          * can send an IPI.  Worst thing is that the process gets interrupted
805          * briefly and the kernel immediately returns back once it realizes notifs
806          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
807          * use a bool. (wrong answer). */
808         if (nm->flags & NOTIF_IPI && !vcpd->notif_pending) {
809                 vcpd->notif_pending = TRUE;
810                 if (vcpd->notif_enabled) {
811                         /* GIANT WARNING: we aren't using the proc-lock to protect the
812                          * vcoremap.  We want to be able to use this from interrupt context,
813                          * and don't want the proc_lock to be an irqsave.
814                          */
815                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
816                                       (p->procinfo->vcoremap[vcoreid].valid)) {
817                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
818                                 send_kernel_message(get_pcoreid(p, vcoreid), __notify, p, 0, 0,
819                                                     KMSG_ROUTINE);
820                         } else { // TODO: think about this, fallback, etc
821                                 warn("Vcore unmapped, not receiving an active notif");
822                         }
823                 }
824         }
825 }
826
827 /* Sends notification number notif to proc p.  Meant for generic notifications /
828  * reference implementation.  do_notify does the real work.  This one mostly
829  * just determines where the notif should be sent, other checks, etc.
830  * Specifically, it handles the parameters of notif_methods.  If you happen to
831  * notify yourself, make sure you process routine kmsgs. */
832 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
833 {
834         assert(notif < MAX_NR_NOTIF); // notifs start at 0
835         struct notif_method *nm = &p->procdata->notif_methods[notif];
836         struct notif_event local_ne;
837
838         /* Caller can opt to not send an NE, in which case we use the notif */
839         if (!ne) {
840                 ne = &local_ne;
841                 ne->ne_type = notif;
842         }
843
844         if (!(nm->flags & NOTIF_WANTED))
845                 return;
846         do_notify(p, nm->vcoreid, ne->ne_type, ne);
847 }
848
849 /************************  Preemption Functions  ******************************
850  * Don't rely on these much - I'll be sure to change them up a bit.
851  *
852  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
853  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
854  * flux.  The num_vcores is changed after take_cores, but some of the messages
855  * (or local traps) may not yet be ready to handle seeing their future state.
856  * But they should be, so fix those when they pop up.
857  *
858  * TODO: (RMS) we need to actually make the scheduler handle RUNNABLE_Ms and
859  * then schedule these, or change proc_destroy to not assume they need to be
860  * descheduled.
861  *
862  * Another thing to do would be to make the _core functions take a pcorelist,
863  * and not just one pcoreid. */
864
865 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
866  * about locking, do it before calling.  Takes a vcoreid! */
867 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
868 {
869         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
870          * since it is unmapped and not dealt with (TODO)*/
871         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
872         /* notify, if they want to hear about this event.  regardless of how they
873          * want it, we can send this as a bit.  Subject to change. */
874         if (p->procdata->notif_methods[NE_PREEMPT_PENDING].flags | NOTIF_WANTED)
875                 do_notify(p, vcoreid, NE_PREEMPT_PENDING, 0);
876         /* TODO: consider putting in some lookup place for the alarm to find it.
877          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
878 }
879
880 /* Warns all active vcores of an impending preemption.  Hold the lock if you
881  * care about the mapping (and you should). */
882 void __proc_preempt_warnall(struct proc *p, uint64_t when)
883 {
884         uint32_t active_vcoreid = 0;
885         for (int i = 0; i < p->procinfo->num_vcores; i++) {
886                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
887                 __proc_preempt_warn(p, active_vcoreid, when);
888                 active_vcoreid++;
889         }
890         /* TODO: consider putting in some lookup place for the alarm to find it.
891          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
892 }
893
894 // TODO: function to set an alarm, if none is outstanding
895
896 /* Raw function to preempt a single core.  Returns TRUE if the calling core will
897  * get a kmsg.  If you care about locking, do it before calling. */
898 bool __proc_preempt_core(struct proc *p, uint32_t pcoreid)
899 {
900         uint32_t vcoreid = get_vcoreid(p, pcoreid);
901
902         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
903         // expects a pcorelist.  assumes pcore is mapped and running_m
904         return __proc_take_cores(p, &pcoreid, 1, __preempt, p, 0, 0);
905 }
906
907 /* Raw function to preempt every vcore.  Returns TRUE if the calling core will
908  * get a kmsg.  If you care about locking, do it before calling. */
909 bool __proc_preempt_all(struct proc *p)
910 {
911         /* instead of doing this, we could just preempt_served all possible vcores,
912          * and not just the active ones.  We would need to sort out a way to deal
913          * with stale preempt_serveds first.  This might be just as fast anyways. */
914         uint32_t active_vcoreid = 0;
915         for (int i = 0; i < p->procinfo->num_vcores; i++) {
916                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
917                 p->procinfo->vcoremap[active_vcoreid].preempt_served = TRUE;
918                 active_vcoreid++;
919         }
920         return __proc_take_allcores(p, __preempt, p, 0, 0);
921 }
922
923 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
924  * warning will be for u usec from now. */
925 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
926 {
927         bool self_ipi_pending = FALSE;
928         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
929
930         /* DYING could be okay */
931         if (p->state != PROC_RUNNING_M) {
932                 warn("Tried to preempt from a non RUNNING_M proc!");
933                 return;
934         }
935         spin_lock(&p->proc_lock);
936         if (is_mapped_vcore(p, pcoreid)) {
937                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
938                 self_ipi_pending = __proc_preempt_core(p, pcoreid);
939         } else {
940                 warn("Pcore doesn't belong to the process!!");
941         }
942         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
943          * to schedule it */
944         #if 0
945         if (!p->procinfo->num_vcores) {
946                 __proc_set_state(p, PROC_RUNNABLE_M);
947                 schedule_proc(p);
948         }
949         #endif
950         spin_unlock(&p->proc_lock);
951         __proc_kmsg_pending(p, self_ipi_pending);
952 }
953
954 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
955  * warning will be for u usec from now. */
956 void proc_preempt_all(struct proc *p, uint64_t usec)
957 {
958         bool self_ipi_pending = FALSE;
959         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
960
961         spin_lock(&p->proc_lock);
962         /* DYING could be okay */
963         if (p->state != PROC_RUNNING_M) {
964                 warn("Tried to preempt from a non RUNNING_M proc!");
965                 spin_unlock(&p->proc_lock);
966                 return;
967         }
968         __proc_preempt_warnall(p, warn_time);
969         self_ipi_pending = __proc_preempt_all(p);
970         assert(!p->procinfo->num_vcores);
971         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
972          * to schedule it */
973         #if 0
974         __proc_set_state(p, PROC_RUNNABLE_M);
975         schedule_proc(p);
976         #endif
977         spin_unlock(&p->proc_lock);
978         __proc_kmsg_pending(p, self_ipi_pending);
979 }
980
981 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
982  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
983  * free, etc. */
984 void proc_give(struct proc *p, uint32_t pcoreid)
985 {
986         bool self_ipi_pending = FALSE;
987
988         spin_lock(&p->proc_lock);
989         // expects a pcorelist, we give it a list of one
990         self_ipi_pending = __proc_give_cores(p, &pcoreid, 1);
991         spin_unlock(&p->proc_lock);
992         __proc_kmsg_pending(p, self_ipi_pending);
993 }
994
995 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
996  * out). */
997 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
998 {
999         uint32_t vcoreid;
1000         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1001         spin_lock(&p->proc_lock);
1002         switch (p->state) {
1003                 case PROC_RUNNING_S:
1004                         spin_unlock(&p->proc_lock);
1005                         return 0; // TODO: here's the ugly part
1006                 case PROC_RUNNING_M:
1007                         vcoreid = get_vcoreid(p, pcoreid);
1008                         spin_unlock(&p->proc_lock);
1009                         return vcoreid;
1010                 case PROC_DYING: // death message is on the way
1011                         spin_unlock(&p->proc_lock);
1012                         return 0;
1013                 default:
1014                         spin_unlock(&p->proc_lock);
1015                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1016                               __FUNCTION__);
1017         }
1018 }
1019
1020 /* Gives process p the additional num cores listed in pcorelist.  You must be
1021  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1022  * startup your new cores at the entry point with their virtual IDs (or restore
1023  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1024  * that the process can start to use its cores.
1025  *
1026  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1027  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1028  * Then call proc_run().
1029  *
1030  * The reason I didn't bring the _S cases from core_request over here is so we
1031  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1032  * this is called from another core, and to avoid the need_to_idle business.
1033  * The other way would be to have this function have the side effect of changing
1034  * state, and finding another way to do the need_to_idle.
1035  *
1036  * The returned bool signals whether or not a stack-crushing IPI will come in
1037  * once you unlock after this function.
1038  *
1039  * WARNING: You must hold the proc_lock before calling this! */
1040 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1041 { TRUSTEDBLOCK
1042         bool self_ipi_pending = FALSE;
1043         uint32_t free_vcoreid = 0;
1044         switch (p->state) {
1045                 case (PROC_RUNNABLE_S):
1046                 case (PROC_RUNNING_S):
1047                         panic("Don't give cores to a process in a *_S state!\n");
1048                         break;
1049                 case (PROC_DYING):
1050                         panic("Attempted to give cores to a DYING process.\n");
1051                         break;
1052                 case (PROC_RUNNABLE_M):
1053                         // set up vcoremap.  list should be empty, but could be called
1054                         // multiple times before proc_running (someone changed their mind?)
1055                         if (p->procinfo->num_vcores) {
1056                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1057                                 // debugging: if we aren't packed, then there's a problem
1058                                 // somewhere, like someone forgot to take vcores after
1059                                 // preempting.
1060                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1061                                         assert(p->procinfo->vcoremap[i].valid);
1062                         }
1063                         // add new items to the vcoremap
1064                         __seq_start_write(&p->procinfo->coremap_seqctr);
1065                         for (int i = 0; i < num; i++) {
1066                                 // find the next free slot, which should be the next one
1067                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1068                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1069                                        pcorelist[i]);
1070                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1071                                 p->procinfo->num_vcores++;
1072                         }
1073                         __seq_end_write(&p->procinfo->coremap_seqctr);
1074                         break;
1075                 case (PROC_RUNNING_M):
1076                         /* Up the refcnt, since num cores are going to start using this
1077                          * process and have it loaded in their 'current'. */
1078                         // TODO: (REF) use proc_incref once we have atomics
1079                         p->env_refcnt += num;
1080                         __seq_start_write(&p->procinfo->coremap_seqctr);
1081                         for (int i = 0; i < num; i++) {
1082                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1083                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1084                                        pcorelist[i]);
1085                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1086                                 p->procinfo->num_vcores++;
1087                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1088                                                     KMSG_ROUTINE);
1089                                 if (pcorelist[i] == core_id())
1090                                         self_ipi_pending = TRUE;
1091                         }
1092                         __seq_end_write(&p->procinfo->coremap_seqctr);
1093                         break;
1094                 default:
1095                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1096                               __FUNCTION__);
1097         }
1098         p->resources[RES_CORES].amt_granted += num;
1099         return self_ipi_pending;
1100 }
1101
1102 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1103  * needs to know what cores are free after this call (removed, failed, etc).
1104  * This info will be returned via corelist and *num.  This will send message to
1105  * any cores that are getting removed.
1106  *
1107  * Before implementing this, we should probably think about when this will be
1108  * used.  Implies preempting for the message.  The more that I think about this,
1109  * the less I like it.  For now, don't use this, and think hard before
1110  * implementing it.
1111  *
1112  * WARNING: You must hold the proc_lock before calling this! */
1113 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1114                          size_t *num, amr_t message,TV(a0t) arg0,
1115                          TV(a1t) arg1, TV(a2t) arg2)
1116 {
1117         panic("Set all cores not implemented.\n");
1118 }
1119
1120 /* Takes from process p the num cores listed in pcorelist, using the given
1121  * message for the kernel message (__death, __preempt, etc).  Like the others
1122  * in this function group, bool signals whether or not an IPI is pending.
1123  *
1124  * WARNING: You must hold the proc_lock before calling this! */
1125 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1126                        size_t num, amr_t message, TV(a0t) arg0,
1127                        TV(a1t) arg1, TV(a2t) arg2)
1128 { TRUSTEDBLOCK
1129         uint32_t vcoreid, pcoreid;
1130         bool self_ipi_pending = FALSE;
1131         switch (p->state) {
1132                 case (PROC_RUNNABLE_M):
1133                         assert(!message);
1134                         break;
1135                 case (PROC_RUNNING_M):
1136                         assert(message);
1137                         break;
1138                 default:
1139                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1140                               __FUNCTION__);
1141         }
1142         spin_lock(&idle_lock);
1143         assert((num <= p->procinfo->num_vcores) &&
1144                (num_idlecores + num <= num_cpus));
1145         spin_unlock(&idle_lock);
1146         __seq_start_write(&p->procinfo->coremap_seqctr);
1147         for (int i = 0; i < num; i++) {
1148                 vcoreid = get_vcoreid(p, pcorelist[i]);
1149                 // while ugly, this is done to facilitate merging with take_all_cores
1150                 pcoreid = get_pcoreid(p, vcoreid);
1151                 assert(pcoreid == pcorelist[i]);
1152                 if (message) {
1153                         if (pcoreid == core_id())
1154                                 self_ipi_pending = TRUE;
1155                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1156                                             KMSG_ROUTINE);
1157                 } else {
1158                         /* if there was a msg, the vcore is unmapped on the receive side.
1159                          * o/w, we need to do it here. */
1160                         __unmap_vcore(p, vcoreid);
1161                 }
1162                 // give the pcore back to the idlecoremap
1163                 put_idle_core(pcoreid);
1164         }
1165         p->procinfo->num_vcores -= num;
1166         __seq_end_write(&p->procinfo->coremap_seqctr);
1167         p->resources[RES_CORES].amt_granted -= num;
1168         return self_ipi_pending;
1169 }
1170
1171 /* Takes all cores from a process, which must be in an _M state.  Cores are
1172  * placed back in the idlecoremap.  If there's a message, such as __death or
1173  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1174  * IPI is coming in once you unlock.
1175  *
1176  * WARNING: You must hold the proc_lock before calling this! */
1177 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1178                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1179 {
1180         uint32_t active_vcoreid = 0, pcoreid;
1181         bool self_ipi_pending = FALSE;
1182         switch (p->state) {
1183                 case (PROC_RUNNABLE_M):
1184                         assert(!message);
1185                         break;
1186                 case (PROC_RUNNING_M):
1187                         assert(message);
1188                         break;
1189                 default:
1190                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1191                               __FUNCTION__);
1192         }
1193         spin_lock(&idle_lock);
1194         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1195         spin_unlock(&idle_lock);
1196         __seq_start_write(&p->procinfo->coremap_seqctr);
1197         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1198                 // find next active vcore
1199                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1200                 pcoreid = get_pcoreid(p, active_vcoreid);
1201                 if (message) {
1202                         if (pcoreid == core_id())
1203                                 self_ipi_pending = TRUE;
1204                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1205                                             KMSG_ROUTINE);
1206                 } else {
1207                         /* if there was a msg, the vcore is unmapped on the receive side.
1208                          * o/w, we need to do it here. */
1209                         __unmap_vcore(p, active_vcoreid);
1210                 }
1211                 // give the pcore back to the idlecoremap
1212                 put_idle_core(pcoreid);
1213                 active_vcoreid++; // for the next loop, skip the one we just used
1214         }
1215         p->procinfo->num_vcores = 0;
1216         __seq_end_write(&p->procinfo->coremap_seqctr);
1217         p->resources[RES_CORES].amt_granted = 0;
1218         return self_ipi_pending;
1219 }
1220
1221 /* Helper, to be used when a proc management kmsg should be on its way.  This
1222  * used to also unlock and then handle the message, back when the proc_lock was
1223  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1224  * is pending, this needs to decref (to eat the reference of the caller) and
1225  * then process the message.  Unlock before calling this, since you might not
1226  * return.
1227  *
1228  * There should already be a kmsg waiting for us, since when we checked state to
1229  * see a message was coming, the message had already been sent before unlocking.
1230  * Note we do not need interrupts enabled for this to work (you can receive a
1231  * message before its IPI by polling), though in most cases they will be.
1232  *
1233  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1234  * core_request(). */
1235 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1236 {
1237         if (ipi_pending) {
1238                 proc_decref(p, 1);
1239                 process_routine_kmsg();
1240                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1241         }
1242 }
1243
1244 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1245  * calling. */
1246 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1247 {
1248         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1249         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1250         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1251         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1252 }
1253
1254 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1255  * calling. */
1256 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1257 {
1258         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1259         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1260 }
1261
1262 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1263  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1264  * for brutal details about refcnting.
1265  *
1266  * Implementation aside, the important thing is that we atomically increment
1267  * only if it wasn't already 0.  If it was 0, panic.
1268  *
1269  * TODO: (REF) change to use CAS / atomics. */
1270 void proc_incref(struct proc *p, size_t count)
1271 {
1272         spin_lock_irqsave(&p->proc_lock);
1273         if (p->env_refcnt)
1274                 p->env_refcnt += count;
1275         else
1276                 panic("Tried to incref a proc with no existing references!");
1277         spin_unlock_irqsave(&p->proc_lock);
1278 }
1279
1280 /* When the kernel is done with a process, it decrements its reference count.
1281  * When the count hits 0, no one is using it and it should be freed.  "Last one
1282  * out" actually finalizes the death of the process.  This is tightly coupled
1283  * with the previous function (incref)
1284  *
1285  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1286  * the process lock when calling __proc_free().  Think about what order to do
1287  * those calls in (unlock, then decref?), and the race with someone unlocking
1288  * while someone else is __proc_free()ing. */
1289 void proc_decref(struct proc *p, size_t count)
1290 {
1291         spin_lock_irqsave(&p->proc_lock);
1292         p->env_refcnt -= count;
1293         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1294         spin_unlock_irqsave(&p->proc_lock);
1295         // if we hit 0, no one else will increment and we can check outside the lock
1296         if (!refcnt)
1297                 __proc_free(p);
1298         if (refcnt < 0)
1299                 panic("Too many decrefs!");
1300 }
1301
1302 /* Stop running whatever context is on this core, load a known-good cr3, and
1303  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1304  * process's context. */
1305 void abandon_core(void)
1306 {
1307         if (current)
1308                 __abandon_core();
1309         smp_idle();
1310 }
1311
1312 /* Will send a TLB shootdown message to every vcore in the main address space
1313  * (aka, all vcores for now).  The message will take the start and end virtual
1314  * addresses as well, in case we want to be more clever about how much we
1315  * shootdown and batching our messages.  Should do the sanity about rounding up
1316  * and down in this function too.
1317  *
1318  * Hold the proc_lock before calling this.
1319  *
1320  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1321  * message to the calling core (interrupting it, possibly while holding the
1322  * proc_lock).  We don't need to process routine messages since it's an
1323  * immediate message. */
1324 void __proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1325 {
1326         uint32_t active_vcoreid = 0;
1327         /* TODO: (TLB) sanity checks and rounding on the ranges */
1328         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1329                 /* find next active vcore */
1330                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1331                 send_kernel_message(get_pcoreid(p, active_vcoreid), __tlbshootdown,
1332                                     (void*)start, (void*)end, 0, KMSG_IMMEDIATE);
1333                 active_vcoreid++; /* for the next loop, skip the one we just used */
1334         }
1335 }
1336
1337 /* Kernel message handler to start a process's context on this core.  Tightly
1338  * coupled with proc_run().  Interrupts are disabled. */
1339 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1340 {
1341         uint32_t pcoreid = core_id(), vcoreid;
1342         struct proc *p_to_run = (struct proc *CT(1))a0;
1343         struct trapframe local_tf;
1344         struct preempt_data *vcpd;
1345
1346         assert(p_to_run);
1347         /* the sender of the amsg increfed, thinking we weren't running current. */
1348         if (p_to_run == current)
1349                 proc_decref(p_to_run, 1);
1350         vcoreid = get_vcoreid(p_to_run, pcoreid);
1351         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1352         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1353                pcoreid, p_to_run->pid, vcoreid);
1354
1355         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1356                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1357                 restore_fp_state(&vcpd->preempt_anc);
1358                 /* notif_pending and enabled means the proc wants to receive the IPI,
1359                  * but might have missed it.  copy over the tf so they can restart it
1360                  * later, and give them a fresh vcore. */
1361                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1362                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1363                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1364                                             vcpd->transition_stack);
1365                         vcpd->notif_enabled = FALSE;
1366                         vcpd->notif_pending = FALSE;
1367                 } else {
1368                         /* copy-in the tf we'll pop, then set all security-related fields */
1369                         local_tf = vcpd->preempt_tf;
1370                         proc_secure_trapframe(&local_tf);
1371                 }
1372         } else { /* not restarting from a preemption, use a fresh vcore */
1373                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1374                                     vcpd->transition_stack);
1375                 /* Disable/mask active notifications for fresh vcores */
1376                 vcpd->notif_enabled = FALSE;
1377         }
1378         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1379 }
1380
1381 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1382  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1383  * grab locks or write access to anything that isn't per-core in here. */
1384 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1385 {
1386         struct user_trapframe local_tf;
1387         struct preempt_data *vcpd;
1388         uint32_t vcoreid;
1389         struct proc *p = (struct proc*)a0;
1390
1391         if (p != current)
1392                 return;
1393         assert(!in_kernel(tf));
1394         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1395          * mapping would only happen if the vcore was free, which it isn't until
1396          * after we unmap. */
1397         vcoreid = get_vcoreid(p, core_id());
1398         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1399         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1400                p->procinfo->pid, vcoreid, core_id());
1401         /* sort signals.  notifs are now masked, like an interrupt gate */
1402         if (!vcpd->notif_enabled)
1403                 return;
1404         vcpd->notif_enabled = FALSE;
1405         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1406         /* save the old tf in the notify slot, build and pop a new one.  Note that
1407          * silly state isn't our business for a notification. */
1408         // TODO: this is assuming the struct user_tf is the same as a regular TF
1409         vcpd->notif_tf = *tf;
1410         memset(&local_tf, 0, sizeof(local_tf));
1411         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1412                             vcpd->transition_stack);
1413         __proc_startcore(p, &local_tf);
1414 }
1415
1416 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1417 {
1418         struct preempt_data *vcpd;
1419         uint32_t vcoreid, coreid = core_id();
1420         struct proc *p = (struct proc*)a0;
1421
1422         if (p != current)
1423                 panic("__preempt arrived for a process (%p) that was not current (%p)!",
1424                       p, current);
1425         assert(!in_kernel(tf));
1426         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1427          * mapping would only happen if the vcore was free, which it isn't until
1428          * after we unmap. */
1429         vcoreid = get_vcoreid(p, coreid);
1430         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1431         /* either __preempt or proc_yield() ends the preempt phase. */
1432         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1433         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1434         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1435                p->procinfo->pid, vcoreid, core_id());
1436
1437         /* save the old tf in the preempt slot, save the silly state, and signal the
1438          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1439          * seq_ctrs so userspace can tell between different valid versions.  If the
1440          * TF was already valid, it will panic (if CONFIGed that way). */
1441         // TODO: this is assuming the struct user_tf is the same as a regular TF
1442         vcpd->preempt_tf = *tf;
1443         save_fp_state(&vcpd->preempt_anc);
1444         __seq_start_write(&vcpd->preempt_tf_valid);
1445         __unmap_vcore(p, vcoreid);
1446         abandon_core();
1447 }
1448
1449 /* Kernel message handler to clean up the core when a process is dying.
1450  * Note this leaves no trace of what was running.
1451  * It's okay if death comes to a core that's already idling and has no current.
1452  * It could happen if a process decref'd before __proc_startcore could incref. */
1453 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1454              void *SNT a2)
1455 {
1456         uint32_t vcoreid, coreid = core_id();
1457         if (current) {
1458                 vcoreid = get_vcoreid(current, coreid);
1459                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1460                        coreid, current->pid, vcoreid);
1461                 __unmap_vcore(current, vcoreid);
1462         }
1463         abandon_core();
1464 }
1465
1466 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1467  * addresses from a0 to a1. */
1468 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
1469                     void *a2)
1470 {
1471         /* TODO: (TLB) something more intelligent with the range */
1472         tlbflush();
1473 }
1474
1475 void print_idlecoremap(void)
1476 {
1477         spin_lock(&idle_lock);
1478         printk("There are %d idle cores.\n", num_idlecores);
1479         for (int i = 0; i < num_idlecores; i++)
1480                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1481         spin_unlock(&idle_lock);
1482 }
1483
1484 void print_allpids(void)
1485 {
1486         spin_lock(&pid_hash_lock);
1487         if (hashtable_count(pid_hash)) {
1488                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1489                 printk("PID      STATE    \n");
1490                 printk("------------------\n");
1491                 do {
1492                         struct proc *p = hashtable_iterator_value(phtable_i);
1493                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1494                                p ? procstate2str(p->state) : "(null)");
1495                 } while (hashtable_iterator_advance(phtable_i));
1496         }
1497         spin_unlock(&pid_hash_lock);
1498 }
1499
1500 void print_proc_info(pid_t pid)
1501 {
1502         int j = 0;
1503         /* Doing this without the incref! careful! (avoiding deadlocks) TODO (REF)*/
1504         //struct proc *p = pid2proc(pid);
1505         spin_lock(&pid_hash_lock);
1506         struct proc *p = hashtable_search(pid_hash, (void*)pid);
1507         spin_unlock(&pid_hash_lock);
1508         // not concerned with a race on the state...
1509         if (!p) {
1510                 printk("Bad PID.\n");
1511                 return;
1512         }
1513         spinlock_debug(&p->proc_lock);
1514         //spin_lock(&p->proc_lock); // No locking!!
1515         printk("struct proc: %p\n", p);
1516         printk("PID: %d\n", p->pid);
1517         printk("PPID: %d\n", p->ppid);
1518         printk("State: 0x%08x\n", p->state);
1519         printk("Refcnt: %d\n", p->env_refcnt);
1520         printk("Flags: 0x%08x\n", p->env_flags);
1521         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1522         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1523         printk("Vcoremap:\n");
1524         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1525                 j = get_busy_vcoreid(p, j);
1526                 printk("\tVcore %d: Pcore %d\n", j, get_pcoreid(p, j));
1527                 j++;
1528         }
1529         printk("Resources:\n");
1530         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1531                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1532                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1533         /* No one cares, and it clutters the terminal */
1534         //printk("Vcore 0's Last Trapframe:\n");
1535         //print_trapframe(&p->env_tf);
1536         /* no locking / unlocking or refcnting */
1537         // spin_unlock(&p->proc_lock);
1538         // proc_decref(p, 1); /* decref for the pid2proc reference */
1539 }