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