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