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