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