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