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