Proc refcnting wrappers
[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->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->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, p_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->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 to incref by val.  Using the helper to help debug/interpose on proc
426  * ref counting.  Note that pid2proc doesn't use this interface. */
427 void proc_incref(struct proc *p, unsigned int val)
428 {
429         kref_get(&p->p_kref, val);
430 }
431
432 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
433 void proc_decref(struct proc *p)
434 {
435         kref_put(&p->p_kref);
436 }
437
438 /* Helper, makes p the 'current' process, dropping the old current/cr3.  Don't
439  * incref - this assumes the passed in reference already counted 'current'. */
440 static void __set_proc_current(struct proc *p)
441 {
442         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
443          * though who know how expensive/painful they are. */
444         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
445         /* If the process wasn't here, then we need to load its address space. */
446         if (p != pcpui->cur_proc) {
447                 /* Do not incref here.  We were given the reference to current,
448                  * pre-upped. */
449                 lcr3(p->env_cr3);
450                 /* This is "leaving the process context" of the previous proc.  The
451                  * previous lcr3 unloaded the previous proc's context.  This should
452                  * rarely happen, since we usually proactively leave process context,
453                  * but this is the fallback. */
454                 if (pcpui->cur_proc)
455                         proc_decref(pcpui->cur_proc);
456                 pcpui->cur_proc = p;
457         }
458 }
459
460 /* Dispatches a process to run, either on the current core in the case of a
461  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
462  * never be called to "restart" a core.  This expects that the "instructions"
463  * for which core(s) to run this on will be in the vcoremap, which needs to be
464  * set externally.
465  *
466  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
467  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
468  * it's old core0 context, and the other cores will come in at the entry point.
469  * Including in the case of preemption.
470  *
471  * This won't return if the current core is going to be one of the processes
472  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
473  * eat your reference if it does not return. */
474 void proc_run(struct proc *p)
475 {
476         bool self_ipi_pending = FALSE;
477         spin_lock(&p->proc_lock);
478
479         switch (p->state) {
480                 case (PROC_DYING):
481                         spin_unlock(&p->proc_lock);
482                         printk("Process %d not starting due to async death\n", p->pid);
483                         // if we're a worker core, smp_idle, o/w return
484                         if (!management_core())
485                                 smp_idle(); // this never returns
486                         return;
487                 case (PROC_RUNNABLE_S):
488                         assert(current != p);
489                         __proc_set_state(p, PROC_RUNNING_S);
490                         /* We will want to know where this process is running, even if it is
491                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
492                          * Also, this is the signal used in trap.c to know to save the tf in
493                          * env_tf. */
494                         __seq_start_write(&p->procinfo->coremap_seqctr);
495                         p->procinfo->num_vcores = 0;
496                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
497                         __seq_end_write(&p->procinfo->coremap_seqctr);
498                         /* __set_proc_current assumes the reference we give it is for
499                          * current.  Decref if current is already properly set, otherwise
500                          * ensure current is set. */
501                         if (p == current)
502                                 proc_decref(p);
503                         else
504                                 __set_proc_current(p);
505                         /* We restartcore, instead of startcore, since startcore is a bit
506                          * lower level and we want a chance to process kmsgs before starting
507                          * the process. */
508                         spin_unlock(&p->proc_lock);
509                         current_tf = &p->env_tf;
510                         proc_restartcore();
511                         break;
512                 case (PROC_RUNNABLE_M):
513                         /* vcoremap[i] holds the coreid of the physical core allocated to
514                          * this process.  It is set outside proc_run.  For the kernel
515                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
516                         if (p->procinfo->num_vcores) {
517                                 __proc_set_state(p, PROC_RUNNING_M);
518                                 /* Up the refcnt, since num_vcores are going to start using this
519                                  * process and have it loaded in their 'current'. */
520                                 proc_incref(p, p->procinfo->num_vcores);
521                                 /* If the core we are running on is in the vcoremap, we will get
522                                  * an IPI (once we reenable interrupts) and never return. */
523                                 if (is_mapped_vcore(p, core_id()))
524                                         self_ipi_pending = TRUE;
525                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
526                                         send_kernel_message(get_pcoreid(p, i), __startcore, p, 0,
527                                                             0, KMSG_ROUTINE);
528                         } else {
529                                 warn("Tried to proc_run() an _M with no vcores!");
530                         }
531                         /* Unlock and decref/wait for the IPI if one is pending.  This will
532                          * eat the reference if we aren't returning.
533                          *
534                          * There a subtle race avoidance here.  __proc_startcore can handle
535                          * a death message, but we can't have the startcore come after the
536                          * death message.  Otherwise, it would look like a new process.  So
537                          * we hold the lock til after we send our message, which prevents a
538                          * possible death message.
539                          * - Note there is no guarantee this core's interrupts were on, so
540                          *   it may not get the message for a while... */
541                         spin_unlock(&p->proc_lock);
542                         __proc_kmsg_pending(p, self_ipi_pending);
543                         break;
544                 default:
545                         spin_unlock(&p->proc_lock);
546                         panic("Invalid process state %p in proc_run()!!", p->state);
547         }
548 }
549
550 /* Actually runs the given context (trapframe) of process p on the core this
551  * code executes on.  This is called directly by __startcore, which needs to
552  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
553  *
554  * A note on refcnting: this function will not return, and your proc reference
555  * will end up stored in current.  This will make no changes to p's refcnt, so
556  * do your accounting such that there is only the +1 for current.  This means if
557  * it is already in current (like in the trap return path), don't up it.  If
558  * it's already in current and you have another reference (like pid2proc or from
559  * an IPI), then down it (which is what happens in __startcore()).  If it's not
560  * in current and you have one reference, like proc_run(non_current_p), then
561  * also do nothing.  The refcnt for your *p will count for the reference stored
562  * in current. */
563 static void __proc_startcore(struct proc *p, trapframe_t *tf)
564 {
565         assert(!irq_is_enabled());
566         __set_proc_current(p);
567         /* need to load our silly state, preferably somewhere other than here so we
568          * can avoid the case where the context was just running here.  it's not
569          * sufficient to do it in the "new process" if-block above (could be things
570          * like page faults that cause us to keep the same process, but want a
571          * different context.
572          * for now, we load this silly state here. (TODO) (HSS)
573          * We also need this to be per trapframe, and not per process...
574          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
575          * __startcore.  */
576         if (p->state == PROC_RUNNING_S)
577                 env_pop_ancillary_state(p);
578         /* Clear the current_tf, since it is no longer used */
579         current_tf = 0;
580         env_pop_tf(tf);
581 }
582
583 /* Restarts/runs the current_tf, which must be for the current process, on the
584  * core this code executes on.  Calls an internal function to do the work.
585  *
586  * In case there are pending routine messages, like __death, __preempt, or
587  * __notify, we need to run them.  Alternatively, if there are any, we could
588  * self_ipi, and run the messages immediately after popping back to userspace,
589  * but that would have crappy overhead.
590  *
591  * Refcnting: this will not return, and it assumes that you've accounted for
592  * your reference as if it was the ref for "current" (which is what happens when
593  * returning from local traps and such. */
594 void proc_restartcore(void)
595 {
596         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
597         /* If there is no cur_tf, it is because the old one was already restarted
598          * (and we weren't interrupting another one to finish).  In which case, we
599          * should just smp_idle() */
600         if (!pcpui->cur_tf) {
601                 assert(!current);       /* might be wrong, but i want to know if it is */
602                 smp_idle();
603         }
604         /* TODO: this is where we can decide to smp_idle() if there is no cur_tf */
605         /* Need ints disabled when we return from processing (race) */
606         disable_irq();
607         /* Need to be current (set by the caller), in case a kmsg is there that
608          * tries to clobber us. */
609         process_routine_kmsg(pcpui->cur_tf);
610         __proc_startcore(pcpui->cur_proc, pcpui->cur_tf);
611 }
612
613 /*
614  * Destroys the given process.  This may be called from another process, a light
615  * kernel thread (no real process context), asynchronously/cross-core, or from
616  * the process on its own core.
617  *
618  * Here's the way process death works:
619  * 0. grab the lock (protects state transition and core map)
620  * 1. set state to dying.  that keeps the kernel from doing anything for the
621  * process (like proc_running it).
622  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
623  * 3. IPI to clean up those cores (decref, etc).
624  * 4. Unlock
625  * 5. Clean up your core, if applicable
626  * (Last core/kernel thread to decref cleans up and deallocates resources.)
627  *
628  * Note that some cores can be processing async calls, but will eventually
629  * decref.  Should think about this more, like some sort of callback/revocation.
630  *
631  * This will eat your reference if it won't return.  Note that this function
632  * needs to change anyways when we make __death more like __preempt.  (TODO) */
633 void proc_destroy(struct proc *p)
634 {
635         bool self_ipi_pending = FALSE;
636         
637         spin_lock(&p->proc_lock);
638         /* TODO: (DEATH) look at this again when we sort the __death IPI */
639         if (current == p)
640                 self_ipi_pending = TRUE;
641
642         switch (p->state) {
643                 case PROC_DYING: // someone else killed this already.
644                         spin_unlock(&p->proc_lock);
645                         __proc_kmsg_pending(p, self_ipi_pending);
646                         return;
647                 case PROC_RUNNABLE_M:
648                         /* Need to reclaim any cores this proc might have, even though it's
649                          * not running yet. */
650                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
651                         // fallthrough
652                 case PROC_RUNNABLE_S:
653                         // Think about other lists, like WAITING, or better ways to do this
654                         deschedule_proc(p);
655                         break;
656                 case PROC_RUNNING_S:
657                         #if 0
658                         // here's how to do it manually
659                         if (current == p) {
660                                 lcr3(boot_cr3);
661                                 proc_decref(p);         /* this decref is for the cr3 */
662                                 current = NULL;
663                         }
664                         #endif
665                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
666                                             KMSG_ROUTINE);
667                         __seq_start_write(&p->procinfo->coremap_seqctr);
668                         // TODO: might need to sort num_vcores too later (VC#)
669                         /* vcore is unmapped on the receive side */
670                         __seq_end_write(&p->procinfo->coremap_seqctr);
671                         #if 0
672                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
673                          * managed by the idlecoremap.  so don't do this yet. */
674                         put_idle_core(get_pcoreid(p, 0));
675                         #endif
676                         break;
677                 case PROC_RUNNING_M:
678                         /* Send the DEATH message to every core running this process, and
679                          * deallocate the cores.
680                          * The rule is that the vcoremap is set before proc_run, and reset
681                          * within proc_destroy */
682                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
683                                              (void *SNT)0);
684                         break;
685                 case PROC_CREATED:
686                         break;
687                 default:
688                         panic("Weird state(%s) in %s()", procstate2str(p->state),
689                               __FUNCTION__);
690         }
691         __proc_set_state(p, PROC_DYING);
692         /* This prevents processes from accessing their old files while dying, and
693          * will help if these files (or similar objects in the future) hold
694          * references to p (preventing a __proc_free()). */
695         close_all_files(&p->open_files, FALSE);
696         /* This decref is for the process's existence. */
697         proc_decref(p);
698         /* Unlock and possible decref and wait.  A death IPI should be on its way,
699          * either from the RUNNING_S one, or from proc_take_cores with a __death.
700          * in general, interrupts should be on when you call proc_destroy locally,
701          * but currently aren't for all things (like traphandlers). */
702         spin_unlock(&p->proc_lock);
703         /* at this point, we normally have one ref to be eaten in kmsg_pending and
704          * one for every 'current'.  and maybe one for a parent */
705         __proc_kmsg_pending(p, self_ipi_pending);
706         return;
707 }
708
709 /* Helper function.  Starting from prev, it will find the next free vcoreid,
710  * which is the next vcore that is not valid.
711  * You better hold the lock before calling this. */
712 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
713 {
714         uint32_t i;
715         for (i = prev; i < MAX_NUM_CPUS; i++)
716                 if (!p->procinfo->vcoremap[i].valid)
717                         break;
718         if (i + 1 >= MAX_NUM_CPUS)
719                 warn("At the end of the vcorelist.  Might want to check that out.");
720         return i;
721 }
722
723 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
724  * which is the next vcore that is valid.
725  * You better hold the lock before calling this. */
726 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
727 {
728         uint32_t i;
729         for (i = prev; i < MAX_NUM_CPUS; i++)
730                 if (p->procinfo->vcoremap[i].valid)
731                         break;
732         if (i + 1 >= MAX_NUM_CPUS)
733                 warn("At the end of the vcorelist.  Might want to check that out.");
734         return i;
735 }
736
737 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
738  * careful. */
739 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
740 {
741         return p->procinfo->pcoremap[pcoreid].valid;
742 }
743
744 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
745  * No locking involved, be careful.  Panics on failure. */
746 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
747 {
748         assert(is_mapped_vcore(p, pcoreid));
749         return p->procinfo->pcoremap[pcoreid].vcoreid;
750 }
751
752 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
753  * No locking involved, be careful.  Panics on failure. */
754 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
755 {
756         assert(p->procinfo->vcoremap[vcoreid].valid);
757         return p->procinfo->vcoremap[vcoreid].pcoreid;
758 }
759
760 /* Helper function: yields / wraps up current_tf and schedules the _S */
761 void __proc_yield_s(struct proc *p, struct trapframe *tf)
762 {
763         assert(p->state == PROC_RUNNING_S);
764         p->env_tf= *tf;
765         env_push_ancillary_state(p);                    /* TODO: (HSS) */
766         __proc_set_state(p, PROC_RUNNABLE_S);
767         schedule_proc(p);
768 }
769
770 /* Yields the calling core.  Must be called locally (not async) for now.
771  * - If RUNNING_S, you just give up your time slice and will eventually return.
772  * - If RUNNING_M, you give up the current vcore (which never returns), and
773  *   adjust the amount of cores wanted/granted.
774  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
775  *   you'll have one guaranteed core, starting from the entry point.
776  *
777  * - RES_CORES amt_wanted will be the amount running after taking away the
778  *   yielder, unless there are none left, in which case it will be 1.
779  *
780  * If the call is being nice, it means that it is in response to a preemption
781  * (which needs to be checked).  If there is no preemption pending, just return.
782  * No matter what, don't adjust the number of cores wanted.
783  *
784  * This usually does not return (abandon_core()), so it will eat your reference.
785  * */
786 void proc_yield(struct proc *SAFE p, bool being_nice)
787 {
788         uint32_t vcoreid = get_vcoreid(p, core_id());
789         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
790
791         /* no reason to be nice, return */
792         if (being_nice && !vc->preempt_pending)
793                 return;
794
795         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
796
797         /* fate is sealed, return and take the preempt message on the way out.
798          * we're making this check while holding the lock, since the preemptor
799          * should hold the lock when sending messages. */
800         if (vc->preempt_served) {
801                 spin_unlock(&p->proc_lock);
802                 return;
803         }
804         /* no need to preempt later, since we are yielding (nice or otherwise) */
805         if (vc->preempt_pending)
806                 vc->preempt_pending = 0;
807
808         switch (p->state) {
809                 case (PROC_RUNNING_S):
810                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
811                         break;
812                 case (PROC_RUNNING_M):
813                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
814                                get_vcoreid(p, core_id()));
815                         /* TODO: (RMS) the Scheduler cannot handle the Runnable Ms (RMS), so
816                          * don't yield the last vcore. */
817                         if (p->procinfo->num_vcores == 1) {
818                                 spin_unlock(&p->proc_lock);
819                                 return;
820                         }
821                         __seq_start_write(&p->procinfo->coremap_seqctr);
822                         // give up core
823                         __unmap_vcore(p, get_vcoreid(p, core_id()));
824                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
825                         if (!being_nice)
826                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
827                         __seq_end_write(&p->procinfo->coremap_seqctr);
828                         // add to idle list
829                         put_idle_core(core_id());
830                         // last vcore?  then we really want 1, and to yield the gang
831                         // TODO: (RMS) will actually do this.
832                         if (p->procinfo->num_vcores == 0) {
833                                 p->resources[RES_CORES].amt_wanted = 1;
834                                 __proc_set_state(p, PROC_RUNNABLE_M);
835                                 schedule_proc(p);
836                         }
837                         break;
838                 case (PROC_DYING):
839                         /* just return and take the death message (which should be otw) */
840                         spin_unlock(&p->proc_lock);
841                         return;
842                 default:
843                         // there are races that can lead to this (async death, preempt, etc)
844                         panic("Weird state(%s) in %s()", procstate2str(p->state),
845                               __FUNCTION__);
846         }
847         spin_unlock(&p->proc_lock);
848         proc_decref(p);                 /* need to eat the ref passed in */
849         /* TODO: (RMS) If there was a change to the idle cores, try and give our
850          * core to someone who was preempted. */
851         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
852          * manager, which will call schedule() and will repick the yielding proc. */
853         abandon_core();
854         smp_idle();
855 }
856
857 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
858  * only send a notification if one isn't already pending and they are enabled.
859  * There's a bunch of weird cases with this, and how pending / enabled are
860  * signals between the user and kernel - check the documentation.
861  *
862  * If you expect to notify yourself, cleanup state and process_routine_kmsg() */
863 void proc_notify(struct proc *p, uint32_t vcoreid)
864 {
865         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
866         /* TODO: Currently, there is a race for notif_pending, and multiple senders
867          * can send an IPI.  Worst thing is that the process gets interrupted
868          * briefly and the kernel immediately returns back once it realizes notifs
869          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
870          * use a bool. (wrong answer). */
871         if (!vcpd->notif_pending) {
872                 vcpd->notif_pending = TRUE;
873                 if (vcpd->notif_enabled) {
874                         /* GIANT WARNING: we aren't using the proc-lock to protect the
875                          * vcoremap.  We want to be able to use this from interrupt context,
876                          * and don't want the proc_lock to be an irqsave. */
877                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
878                                       (p->procinfo->vcoremap[vcoreid].valid)) {
879                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
880                                 send_kernel_message(get_pcoreid(p, vcoreid), __notify, p, 0, 0,
881                                                     KMSG_ROUTINE);
882                         } else { // TODO: think about this, fallback, etc
883                                 warn("Vcore unmapped, not receiving an active notif");
884                         }
885                 }
886         }
887 }
888
889 /************************  Preemption Functions  ******************************
890  * Don't rely on these much - I'll be sure to change them up a bit.
891  *
892  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
893  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
894  * flux.  The num_vcores is changed after take_cores, but some of the messages
895  * (or local traps) may not yet be ready to handle seeing their future state.
896  * But they should be, so fix those when they pop up.
897  *
898  * TODO: (RMS) we need to actually make the scheduler handle RUNNABLE_Ms and
899  * then schedule these, or change proc_destroy to not assume they need to be
900  * descheduled.
901  *
902  * Another thing to do would be to make the _core functions take a pcorelist,
903  * and not just one pcoreid. */
904
905 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
906  * about locking, do it before calling.  Takes a vcoreid! */
907 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
908 {
909         struct event_msg local_msg = {0};
910         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
911          * since it is unmapped and not dealt with (TODO)*/
912         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
913
914         /* Send the event (which internally checks to see how they want it) */
915         local_msg.ev_type = EV_PREEMPT_PENDING;
916         local_msg.ev_arg1 = vcoreid;
917         send_kernel_event(p, &local_msg, vcoreid);
918
919         /* TODO: consider putting in some lookup place for the alarm to find it.
920          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
921 }
922
923 /* Warns all active vcores of an impending preemption.  Hold the lock if you
924  * care about the mapping (and you should). */
925 void __proc_preempt_warnall(struct proc *p, uint64_t when)
926 {
927         uint32_t active_vcoreid = 0;
928         for (int i = 0; i < p->procinfo->num_vcores; i++) {
929                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
930                 __proc_preempt_warn(p, active_vcoreid, when);
931                 active_vcoreid++;
932         }
933         /* TODO: consider putting in some lookup place for the alarm to find it.
934          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
935 }
936
937 // TODO: function to set an alarm, if none is outstanding
938
939 /* Raw function to preempt a single core.  Returns TRUE if the calling core will
940  * get a kmsg.  If you care about locking, do it before calling. */
941 bool __proc_preempt_core(struct proc *p, uint32_t pcoreid)
942 {
943         uint32_t vcoreid = get_vcoreid(p, pcoreid);
944
945         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
946         // expects a pcorelist.  assumes pcore is mapped and running_m
947         return __proc_take_cores(p, &pcoreid, 1, __preempt, p, 0, 0);
948 }
949
950 /* Raw function to preempt every vcore.  Returns TRUE if the calling core will
951  * get a kmsg.  If you care about locking, do it before calling. */
952 bool __proc_preempt_all(struct proc *p)
953 {
954         /* instead of doing this, we could just preempt_served all possible vcores,
955          * and not just the active ones.  We would need to sort out a way to deal
956          * with stale preempt_serveds first.  This might be just as fast anyways. */
957         uint32_t active_vcoreid = 0;
958         for (int i = 0; i < p->procinfo->num_vcores; i++) {
959                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
960                 p->procinfo->vcoremap[active_vcoreid].preempt_served = TRUE;
961                 active_vcoreid++;
962         }
963         return __proc_take_allcores(p, __preempt, p, 0, 0);
964 }
965
966 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
967  * warning will be for u usec from now. */
968 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
969 {
970         bool self_ipi_pending = FALSE;
971         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
972
973         /* DYING could be okay */
974         if (p->state != PROC_RUNNING_M) {
975                 warn("Tried to preempt from a non RUNNING_M proc!");
976                 return;
977         }
978         spin_lock(&p->proc_lock);
979         if (is_mapped_vcore(p, pcoreid)) {
980                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
981                 self_ipi_pending = __proc_preempt_core(p, pcoreid);
982         } else {
983                 warn("Pcore doesn't belong to the process!!");
984         }
985         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
986          * to schedule it */
987         #if 0
988         if (!p->procinfo->num_vcores) {
989                 __proc_set_state(p, PROC_RUNNABLE_M);
990                 schedule_proc(p);
991         }
992         #endif
993         spin_unlock(&p->proc_lock);
994         __proc_kmsg_pending(p, self_ipi_pending);
995 }
996
997 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
998  * warning will be for u usec from now. */
999 void proc_preempt_all(struct proc *p, uint64_t usec)
1000 {
1001         bool self_ipi_pending = FALSE;
1002         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1003
1004         spin_lock(&p->proc_lock);
1005         /* DYING could be okay */
1006         if (p->state != PROC_RUNNING_M) {
1007                 warn("Tried to preempt from a non RUNNING_M proc!");
1008                 spin_unlock(&p->proc_lock);
1009                 return;
1010         }
1011         __proc_preempt_warnall(p, warn_time);
1012         self_ipi_pending = __proc_preempt_all(p);
1013         assert(!p->procinfo->num_vcores);
1014         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1015          * to schedule it */
1016         #if 0
1017         __proc_set_state(p, PROC_RUNNABLE_M);
1018         schedule_proc(p);
1019         #endif
1020         spin_unlock(&p->proc_lock);
1021         __proc_kmsg_pending(p, self_ipi_pending);
1022 }
1023
1024 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1025  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1026  * free, etc. */
1027 void proc_give(struct proc *p, uint32_t pcoreid)
1028 {
1029         bool self_ipi_pending = FALSE;
1030
1031         spin_lock(&p->proc_lock);
1032         // expects a pcorelist, we give it a list of one
1033         self_ipi_pending = __proc_give_cores(p, &pcoreid, 1);
1034         spin_unlock(&p->proc_lock);
1035         __proc_kmsg_pending(p, self_ipi_pending);
1036 }
1037
1038 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1039  * out). */
1040 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1041 {
1042         uint32_t vcoreid;
1043         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1044         spin_lock(&p->proc_lock);
1045         switch (p->state) {
1046                 case PROC_RUNNING_S:
1047                         spin_unlock(&p->proc_lock);
1048                         return 0; // TODO: here's the ugly part
1049                 case PROC_RUNNING_M:
1050                         vcoreid = get_vcoreid(p, pcoreid);
1051                         spin_unlock(&p->proc_lock);
1052                         return vcoreid;
1053                 case PROC_DYING: // death message is on the way
1054                         spin_unlock(&p->proc_lock);
1055                         return 0;
1056                 default:
1057                         spin_unlock(&p->proc_lock);
1058                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1059                               __FUNCTION__);
1060         }
1061 }
1062
1063 /* Gives process p the additional num cores listed in pcorelist.  You must be
1064  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1065  * startup your new cores at the entry point with their virtual IDs (or restore
1066  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1067  * that the process can start to use its cores.
1068  *
1069  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1070  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1071  * Then call proc_run().
1072  *
1073  * The reason I didn't bring the _S cases from core_request over here is so we
1074  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1075  * this is called from another core, and to avoid the need_to_idle business.
1076  * The other way would be to have this function have the side effect of changing
1077  * state, and finding another way to do the need_to_idle.
1078  *
1079  * The returned bool signals whether or not a stack-crushing IPI will come in
1080  * once you unlock after this function.
1081  *
1082  * WARNING: You must hold the proc_lock before calling this! */
1083 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1084 { TRUSTEDBLOCK
1085         bool self_ipi_pending = FALSE;
1086         uint32_t free_vcoreid = 0;
1087         switch (p->state) {
1088                 case (PROC_RUNNABLE_S):
1089                 case (PROC_RUNNING_S):
1090                         panic("Don't give cores to a process in a *_S state!\n");
1091                         break;
1092                 case (PROC_DYING):
1093                         panic("Attempted to give cores to a DYING process.\n");
1094                         break;
1095                 case (PROC_RUNNABLE_M):
1096                         // set up vcoremap.  list should be empty, but could be called
1097                         // multiple times before proc_running (someone changed their mind?)
1098                         if (p->procinfo->num_vcores) {
1099                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1100                                 // debugging: if we aren't packed, then there's a problem
1101                                 // somewhere, like someone forgot to take vcores after
1102                                 // preempting.
1103                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1104                                         assert(p->procinfo->vcoremap[i].valid);
1105                         }
1106                         // add new items to the vcoremap
1107                         __seq_start_write(&p->procinfo->coremap_seqctr);
1108                         for (int i = 0; i < num; i++) {
1109                                 // find the next free slot, which should be the next one
1110                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1111                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1112                                        pcorelist[i]);
1113                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1114                                 p->procinfo->num_vcores++;
1115                         }
1116                         __seq_end_write(&p->procinfo->coremap_seqctr);
1117                         break;
1118                 case (PROC_RUNNING_M):
1119                         /* Up the refcnt, since num cores are going to start using this
1120                          * process and have it loaded in their 'current'. */
1121                         proc_incref(p, num);
1122                         __seq_start_write(&p->procinfo->coremap_seqctr);
1123                         for (int i = 0; i < num; i++) {
1124                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1125                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1126                                        pcorelist[i]);
1127                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1128                                 p->procinfo->num_vcores++;
1129                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1130                                                     KMSG_ROUTINE);
1131                                 if (pcorelist[i] == core_id())
1132                                         self_ipi_pending = TRUE;
1133                         }
1134                         __seq_end_write(&p->procinfo->coremap_seqctr);
1135                         break;
1136                 default:
1137                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1138                               __FUNCTION__);
1139         }
1140         p->resources[RES_CORES].amt_granted += num;
1141         return self_ipi_pending;
1142 }
1143
1144 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1145  * needs to know what cores are free after this call (removed, failed, etc).
1146  * This info will be returned via corelist and *num.  This will send message to
1147  * any cores that are getting removed.
1148  *
1149  * Before implementing this, we should probably think about when this will be
1150  * used.  Implies preempting for the message.  The more that I think about this,
1151  * the less I like it.  For now, don't use this, and think hard before
1152  * implementing it.
1153  *
1154  * WARNING: You must hold the proc_lock before calling this! */
1155 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1156                          size_t *num, amr_t message,TV(a0t) arg0,
1157                          TV(a1t) arg1, TV(a2t) arg2)
1158 {
1159         panic("Set all cores not implemented.\n");
1160 }
1161
1162 /* Takes from process p the num cores listed in pcorelist, using the given
1163  * message for the kernel message (__death, __preempt, etc).  Like the others
1164  * in this function group, bool signals whether or not an IPI is pending.
1165  *
1166  * WARNING: You must hold the proc_lock before calling this! */
1167 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1168                        size_t num, amr_t message, TV(a0t) arg0,
1169                        TV(a1t) arg1, TV(a2t) arg2)
1170 { TRUSTEDBLOCK
1171         uint32_t vcoreid, pcoreid;
1172         bool self_ipi_pending = FALSE;
1173         switch (p->state) {
1174                 case (PROC_RUNNABLE_M):
1175                         assert(!message);
1176                         break;
1177                 case (PROC_RUNNING_M):
1178                         assert(message);
1179                         break;
1180                 default:
1181                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1182                               __FUNCTION__);
1183         }
1184         spin_lock(&idle_lock);
1185         assert((num <= p->procinfo->num_vcores) &&
1186                (num_idlecores + num <= num_cpus));
1187         spin_unlock(&idle_lock);
1188         __seq_start_write(&p->procinfo->coremap_seqctr);
1189         for (int i = 0; i < num; i++) {
1190                 vcoreid = get_vcoreid(p, pcorelist[i]);
1191                 // while ugly, this is done to facilitate merging with take_all_cores
1192                 pcoreid = get_pcoreid(p, vcoreid);
1193                 assert(pcoreid == pcorelist[i]);
1194                 if (message) {
1195                         if (pcoreid == core_id())
1196                                 self_ipi_pending = TRUE;
1197                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1198                                             KMSG_ROUTINE);
1199                 } else {
1200                         /* if there was a msg, the vcore is unmapped on the receive side.
1201                          * o/w, we need to do it here. */
1202                         __unmap_vcore(p, vcoreid);
1203                 }
1204                 // give the pcore back to the idlecoremap
1205                 put_idle_core(pcoreid);
1206         }
1207         p->procinfo->num_vcores -= num;
1208         __seq_end_write(&p->procinfo->coremap_seqctr);
1209         p->resources[RES_CORES].amt_granted -= num;
1210         return self_ipi_pending;
1211 }
1212
1213 /* Takes all cores from a process, which must be in an _M state.  Cores are
1214  * placed back in the idlecoremap.  If there's a message, such as __death or
1215  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1216  * IPI is coming in once you unlock.
1217  *
1218  * WARNING: You must hold the proc_lock before calling this! */
1219 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1220                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1221 {
1222         uint32_t active_vcoreid = 0, pcoreid;
1223         bool self_ipi_pending = FALSE;
1224         switch (p->state) {
1225                 case (PROC_RUNNABLE_M):
1226                         assert(!message);
1227                         break;
1228                 case (PROC_RUNNING_M):
1229                         assert(message);
1230                         break;
1231                 default:
1232                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1233                               __FUNCTION__);
1234         }
1235         spin_lock(&idle_lock);
1236         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1237         spin_unlock(&idle_lock);
1238         __seq_start_write(&p->procinfo->coremap_seqctr);
1239         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1240                 // find next active vcore
1241                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1242                 pcoreid = get_pcoreid(p, active_vcoreid);
1243                 if (message) {
1244                         if (pcoreid == core_id())
1245                                 self_ipi_pending = TRUE;
1246                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1247                                             KMSG_ROUTINE);
1248                 } else {
1249                         /* if there was a msg, the vcore is unmapped on the receive side.
1250                          * o/w, we need to do it here. */
1251                         __unmap_vcore(p, active_vcoreid);
1252                 }
1253                 // give the pcore back to the idlecoremap
1254                 put_idle_core(pcoreid);
1255                 active_vcoreid++; // for the next loop, skip the one we just used
1256         }
1257         p->procinfo->num_vcores = 0;
1258         __seq_end_write(&p->procinfo->coremap_seqctr);
1259         p->resources[RES_CORES].amt_granted = 0;
1260         return self_ipi_pending;
1261 }
1262
1263 /* Helper, to be used when a proc management kmsg should be on its way.  This
1264  * used to also unlock and then handle the message, back when the proc_lock was
1265  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1266  * is pending, this needs to decref (to eat the reference of the caller) and
1267  * then process the message.  Unlock before calling this, since you might not
1268  * return.
1269  *
1270  * There should already be a kmsg waiting for us, since when we checked state to
1271  * see a message was coming, the message had already been sent before unlocking.
1272  * Note we do not need interrupts enabled for this to work (you can receive a
1273  * message before its IPI by polling), though in most cases they will be.
1274  *
1275  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1276  * core_request(). */
1277 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1278 {
1279         if (ipi_pending) {
1280                 proc_decref(p);
1281                 process_routine_kmsg(0);
1282                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1283         }
1284 }
1285
1286 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1287  * calling. */
1288 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1289 {
1290         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1291         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1292         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1293         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1294 }
1295
1296 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1297  * calling. */
1298 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1299 {
1300         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1301         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1302 }
1303
1304 /* Stop running whatever context is on this core, load a known-good cr3, and
1305  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1306  * process's context. */
1307 void abandon_core(void)
1308 {
1309         if (current) {
1310                 current_tf = 0;
1311                 __abandon_core();
1312         }
1313 }
1314
1315 /* Will send a TLB shootdown message to every vcore in the main address space
1316  * (aka, all vcores for now).  The message will take the start and end virtual
1317  * addresses as well, in case we want to be more clever about how much we
1318  * shootdown and batching our messages.  Should do the sanity about rounding up
1319  * and down in this function too.
1320  *
1321  * Hold the proc_lock before calling this.
1322  *
1323  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1324  * message to the calling core (interrupting it, possibly while holding the
1325  * proc_lock).  We don't need to process routine messages since it's an
1326  * immediate message. */
1327 void __proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1328 {
1329         uint32_t active_vcoreid = 0;
1330         switch (p->state) {
1331                 case (PROC_RUNNING_S):
1332                         tlbflush();
1333                         break;
1334                 case (PROC_RUNNING_M):
1335                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1336                         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1337                                 /* find next active vcore */
1338                                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1339                                 send_kernel_message(get_pcoreid(p, active_vcoreid),
1340                                                     __tlbshootdown, (void*)start, (void*)end,
1341                                                     0, KMSG_IMMEDIATE);
1342                                 active_vcoreid++; /* next loop, skip the one we just used */
1343                         }
1344                         break;
1345                 case (PROC_DYING):
1346                         /* if it is dying, death messages are already on the way to all
1347                          * cores, including ours, which will clear the TLB. */
1348                         break;
1349                 default:
1350                         /* will probably get this when we have the short handlers */
1351                         warn("Unexpected case %s in %s", procstate2str(p->state),
1352                              __FUNCTION__);
1353         }
1354 }
1355
1356 /* Kernel message handler to start a process's context on this core.  Tightly
1357  * coupled with proc_run().  Interrupts are disabled. */
1358 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1359 {
1360         uint32_t pcoreid = core_id(), vcoreid;
1361         struct proc *p_to_run = (struct proc *CT(1))a0;
1362         struct trapframe local_tf;
1363         struct preempt_data *vcpd;
1364
1365         assert(p_to_run);
1366         /* the sender of the amsg increfed, thinking we weren't running current. */
1367         if (p_to_run == current)
1368                 proc_decref(p_to_run);
1369         vcoreid = get_vcoreid(p_to_run, pcoreid);
1370         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1371         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1372                pcoreid, p_to_run->pid, vcoreid);
1373
1374         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1375                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1376                 restore_fp_state(&vcpd->preempt_anc);
1377                 /* notif_pending and enabled means the proc wants to receive the IPI,
1378                  * but might have missed it.  copy over the tf so they can restart it
1379                  * later, and give them a fresh vcore. */
1380                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1381                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1382                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1383                                             vcpd->transition_stack);
1384                         if (!vcpd->transition_stack)
1385                                 warn("No transition stack!");
1386                         vcpd->notif_enabled = FALSE;
1387                         vcpd->notif_pending = FALSE;
1388                 } else {
1389                         /* copy-in the tf we'll pop, then set all security-related fields */
1390                         local_tf = vcpd->preempt_tf;
1391                         proc_secure_trapframe(&local_tf);
1392                 }
1393         } else { /* not restarting from a preemption, use a fresh vcore */
1394                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1395                                     vcpd->transition_stack);
1396                 /* Disable/mask active notifications for fresh vcores */
1397                 vcpd->notif_enabled = FALSE;
1398         }
1399         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1400 }
1401
1402 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1403  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1404  * grab locks or write access to anything that isn't per-core in here. */
1405 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1406 {
1407         struct user_trapframe local_tf;
1408         struct preempt_data *vcpd;
1409         uint32_t vcoreid;
1410         struct proc *p = (struct proc*)a0;
1411
1412         if (p != current)
1413                 return;
1414         assert(!in_kernel(tf));
1415         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1416          * mapping would only happen if the vcore was free, which it isn't until
1417          * after we unmap. */
1418         vcoreid = get_vcoreid(p, core_id());
1419         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1420         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1421                p->procinfo->pid, vcoreid, core_id());
1422         /* sort signals.  notifs are now masked, like an interrupt gate */
1423         if (!vcpd->notif_enabled)
1424                 return;
1425         vcpd->notif_enabled = FALSE;
1426         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1427         /* save the old tf in the notify slot, build and pop a new one.  Note that
1428          * silly state isn't our business for a notification. */
1429         // TODO: this is assuming the struct user_tf is the same as a regular TF
1430         vcpd->notif_tf = *tf;
1431         memset(&local_tf, 0, sizeof(local_tf));
1432         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1433                             vcpd->transition_stack);
1434         __proc_startcore(p, &local_tf);
1435 }
1436
1437 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1438 {
1439         struct preempt_data *vcpd;
1440         uint32_t vcoreid, coreid = core_id();
1441         struct proc *p = (struct proc*)a0;
1442
1443         if (p != current)
1444                 panic("__preempt arrived for a process (%p) that was not current (%p)!",
1445                       p, current);
1446         assert(!in_kernel(tf));
1447         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1448          * mapping would only happen if the vcore was free, which it isn't until
1449          * after we unmap. */
1450         vcoreid = get_vcoreid(p, coreid);
1451         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1452         /* either __preempt or proc_yield() ends the preempt phase. */
1453         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1454         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1455         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1456                p->procinfo->pid, vcoreid, core_id());
1457
1458         /* save the old tf in the preempt slot, save the silly state, and signal the
1459          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1460          * seq_ctrs so userspace can tell between different valid versions.  If the
1461          * TF was already valid, it will panic (if CONFIGed that way). */
1462         // TODO: this is assuming the struct user_tf is the same as a regular TF
1463         vcpd->preempt_tf = *tf;
1464         save_fp_state(&vcpd->preempt_anc);
1465         __seq_start_write(&vcpd->preempt_tf_valid);
1466         __unmap_vcore(p, vcoreid);
1467         abandon_core();
1468         smp_idle();
1469 }
1470
1471 /* Kernel message handler to clean up the core when a process is dying.
1472  * Note this leaves no trace of what was running.
1473  * It's okay if death comes to a core that's already idling and has no current.
1474  * It could happen if a process decref'd before __proc_startcore could incref. */
1475 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1476              void *SNT a2)
1477 {
1478         uint32_t vcoreid, coreid = core_id();
1479         if (current) {
1480                 vcoreid = get_vcoreid(current, coreid);
1481                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1482                        coreid, current->pid, vcoreid);
1483                 __unmap_vcore(current, vcoreid);
1484         }
1485         abandon_core();
1486         smp_idle();
1487 }
1488
1489 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1490  * addresses from a0 to a1. */
1491 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
1492                     void *a2)
1493 {
1494         /* TODO: (TLB) something more intelligent with the range */
1495         tlbflush();
1496 }
1497
1498 void print_idlecoremap(void)
1499 {
1500         spin_lock(&idle_lock);
1501         printk("There are %d idle cores.\n", num_idlecores);
1502         for (int i = 0; i < num_idlecores; i++)
1503                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1504         spin_unlock(&idle_lock);
1505 }
1506
1507 void print_allpids(void)
1508 {
1509         spin_lock(&pid_hash_lock);
1510         if (hashtable_count(pid_hash)) {
1511                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1512                 printk("PID      STATE    \n");
1513                 printk("------------------\n");
1514                 do {
1515                         struct proc *p = hashtable_iterator_value(phtable_i);
1516                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1517                                p ? procstate2str(p->state) : "(null)");
1518                 } while (hashtable_iterator_advance(phtable_i));
1519         }
1520         spin_unlock(&pid_hash_lock);
1521 }
1522
1523 void print_proc_info(pid_t pid)
1524 {
1525         int j = 0;
1526         struct proc *p = pid2proc(pid);
1527         if (!p) {
1528                 printk("Bad PID.\n");
1529                 return;
1530         }
1531         spinlock_debug(&p->proc_lock);
1532         //spin_lock(&p->proc_lock); // No locking!!
1533         printk("struct proc: %p\n", p);
1534         printk("PID: %d\n", p->pid);
1535         printk("PPID: %d\n", p->ppid);
1536         printk("State: 0x%08x\n", p->state);
1537         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
1538         printk("Flags: 0x%08x\n", p->env_flags);
1539         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1540         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1541         printk("Vcoremap:\n");
1542         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1543                 j = get_busy_vcoreid(p, j);
1544                 printk("\tVcore %d: Pcore %d\n", j, get_pcoreid(p, j));
1545                 j++;
1546         }
1547         printk("Resources:\n");
1548         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1549                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1550                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1551         printk("Open Files:\n");
1552         struct files_struct *files = &p->open_files;
1553         spin_lock(&files->lock);
1554         for (int i = 0; i < files->max_files; i++)
1555                 if (files->fd_array[i].fd_file) {
1556                         printk("\tFD: %02d, File: %08p, File name: %s\n", i,
1557                                files->fd_array[i].fd_file,
1558                                file_name(files->fd_array[i].fd_file));
1559                 }
1560         spin_unlock(&files->lock);
1561         /* No one cares, and it clutters the terminal */
1562         //printk("Vcore 0's Last Trapframe:\n");
1563         //print_trapframe(&p->env_tf);
1564         /* no locking / unlocking or refcnting */
1565         // spin_unlock(&p->proc_lock);
1566         proc_decref(p);
1567 }