proc_run() now returns
[akaros.git] / kern / src / process.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details. */
4
5 #ifdef __SHARC__
6 #pragma nosharc
7 #endif
8
9 #include <ros/bcq.h>
10 #include <event.h>
11 #include <arch/arch.h>
12 #include <bitmask.h>
13 #include <process.h>
14 #include <atomic.h>
15 #include <smp.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <schedule.h>
19 #include <manager.h>
20 #include <stdio.h>
21 #include <assert.h>
22 #include <time.h>
23 #include <hashtable.h>
24 #include <slab.h>
25 #include <sys/queue.h>
26 #include <frontend.h>
27 #include <monitor.h>
28 #include <resource.h>
29 #include <elf.h>
30 #include <arsc_server.h>
31 #include <devfs.h>
32
33 /* Process Lists */
34 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
35 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
36 struct kmem_cache *proc_cache;
37
38 /* Other helpers, implemented later. */
39 static void __proc_startcore(struct proc *p, trapframe_t *tf);
40 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
41 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
42 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid);
43 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid);
44 static void __proc_free(struct kref *kref);
45
46 /* PID management. */
47 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
48 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
49 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
50 struct hashtable *pid_hash;
51 spinlock_t pid_hash_lock; // initialized in proc_init
52
53 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
54  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
55  * you'll also see a warning, for now).  Consider doing this with atomics. */
56 static pid_t get_free_pid(void)
57 {
58         static pid_t next_free_pid = 1;
59         pid_t my_pid = 0;
60
61         spin_lock(&pid_bmask_lock);
62         // atomically (can lock for now, then change to atomic_and_return
63         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
64                 // always points to the next to test
65                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
66                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
67                         SET_BITMASK_BIT(pid_bmask, i);
68                         my_pid = i;
69                         break;
70                 }
71         }
72         spin_unlock(&pid_bmask_lock);
73         if (!my_pid)
74                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
75         return my_pid;
76 }
77
78 /* Return a pid to the pid bitmask */
79 static void put_free_pid(pid_t pid)
80 {
81         spin_lock(&pid_bmask_lock);
82         CLR_BITMASK_BIT(pid_bmask, pid);
83         spin_unlock(&pid_bmask_lock);
84 }
85
86 /* While this could be done with just an assignment, this gives us the
87  * opportunity to check for bad transitions.  Might compile these out later, so
88  * we shouldn't rely on them for sanity checking from userspace.  */
89 int __proc_set_state(struct proc *p, uint32_t state)
90 {
91         uint32_t curstate = p->state;
92         /* Valid transitions:
93          * C   -> RBS
94          * C   -> D
95          * RBS -> RGS
96          * RGS -> RBS
97          * RGS -> W
98          * RGM -> W
99          * W   -> RBS
100          * W   -> RBM
101          * RGS -> RBM
102          * RBM -> RGM
103          * RGM -> RBM
104          * RGM -> RBS
105          * RGS -> D
106          * RGM -> D
107          *
108          * These ought to be implemented later (allowed, not thought through yet).
109          * RBS -> D
110          * RBM -> D
111          */
112         #if 1 // some sort of correctness flag
113         switch (curstate) {
114                 case PROC_CREATED:
115                         if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
116                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
117                         break;
118                 case PROC_RUNNABLE_S:
119                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
120                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
121                         break;
122                 case PROC_RUNNING_S:
123                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
124                                        PROC_DYING)))
125                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
126                         break;
127                 case PROC_WAITING:
128                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M)))
129                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
130                         break;
131                 case PROC_DYING:
132                         if (state != PROC_CREATED) // when it is reused (TODO)
133                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
134                         break;
135                 case PROC_RUNNABLE_M:
136                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
137                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
138                         break;
139                 case PROC_RUNNING_M:
140                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
141                                        PROC_DYING)))
142                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
143                         break;
144         }
145         #endif
146         p->state = state;
147         return 0;
148 }
149
150 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
151  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
152  * process is dying and we should not have the ref (and thus return 0).  We need
153  * to lock to protect us from getting p, (someone else removes and frees p),
154  * then get_not_zero() on p.
155  * Don't push the locking into the hashtable without dealing with this. */
156 struct proc *pid2proc(pid_t pid)
157 {
158         spin_lock(&pid_hash_lock);
159         struct proc *p = hashtable_search(pid_hash, (void*)(long)pid);
160         if (p)
161                 if (!kref_get_not_zero(&p->p_kref, 1))
162                         p = 0;
163         spin_unlock(&pid_hash_lock);
164         return p;
165 }
166
167 /* Performs any initialization related to processes, such as create the proc
168  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
169  * any process related function. */
170 void proc_init(void)
171 {
172         /* Catch issues with the vcoremap and TAILQ_ENTRY sizes */
173         static_assert(sizeof(TAILQ_ENTRY(vcore)) == sizeof(void*) * 2);
174         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
175                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
176         /* Init PID mask and hash.  pid 0 is reserved. */
177         SET_BITMASK_BIT(pid_bmask, 0);
178         spinlock_init(&pid_hash_lock);
179         spin_lock(&pid_hash_lock);
180         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
181         spin_unlock(&pid_hash_lock);
182         schedule_init();
183
184         atomic_init(&num_envs, 0);
185 }
186
187 /* Be sure you init'd the vcore lists before calling this. */
188 static void proc_init_procinfo(struct proc* p)
189 {
190         p->procinfo->pid = p->pid;
191         p->procinfo->ppid = p->ppid;
192         p->procinfo->max_vcores = max_vcores(p);
193         p->procinfo->tsc_freq = system_timing.tsc_freq;
194         p->procinfo->heap_bottom = (void*)UTEXT;
195         /* 0'ing the arguments.  Some higher function will need to set them */
196         memset(p->procinfo->argp, 0, sizeof(p->procinfo->argp));
197         memset(p->procinfo->argbuf, 0, sizeof(p->procinfo->argbuf));
198         /* 0'ing the vcore/pcore map.  Will link the vcores later. */
199         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
200         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
201         p->procinfo->num_vcores = 0;
202         p->procinfo->is_mcp = FALSE;
203         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
204         /* For now, we'll go up to the max num_cpus (at runtime).  In the future,
205          * there may be cases where we can have more vcores than num_cpus, but for
206          * now we'll leave it like this. */
207         for (int i = 0; i < num_cpus; i++) {
208                 TAILQ_INSERT_TAIL(&p->inactive_vcs, &p->procinfo->vcoremap[i], list);
209         }
210 }
211
212 static void proc_init_procdata(struct proc *p)
213 {
214         memset(p->procdata, 0, sizeof(struct procdata));
215 }
216
217 /* Allocates and initializes a process, with the given parent.  Currently
218  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
219  * Errors include:
220  *  - ENOFREEPID if it can't get a PID
221  *  - ENOMEM on memory exhaustion */
222 error_t proc_alloc(struct proc **pp, struct proc *parent)
223 {
224         error_t r;
225         struct proc *p;
226
227         if (!(p = kmem_cache_alloc(proc_cache, 0)))
228                 return -ENOMEM;
229
230         { INITSTRUCT(*p)
231
232         /* one reference for the proc existing, and one for the ref we pass back. */
233         kref_init(&p->p_kref, __proc_free, 2);
234         // Setup the default map of where to get cache colors from
235         p->cache_colors_map = global_cache_colors_map;
236         p->next_cache_color = 0;
237         /* Initialize the address space */
238         if ((r = env_setup_vm(p)) < 0) {
239                 kmem_cache_free(proc_cache, p);
240                 return r;
241         }
242         if (!(p->pid = get_free_pid())) {
243                 kmem_cache_free(proc_cache, p);
244                 return -ENOFREEPID;
245         }
246         /* Set the basic status variables. */
247         spinlock_init(&p->proc_lock);
248         p->exitcode = 1337;     /* so we can see processes killed by the kernel */
249         p->ppid = parent ? parent->pid : 0;
250         p->state = PROC_CREATED; /* shouldn't go through state machine for init */
251         p->env_flags = 0;
252         p->env_entry = 0; // cheating.  this really gets set later
253         p->heap_top = (void*)UTEXT;     /* heap_bottom set in proc_init_procinfo */
254         memset(&p->resources, 0, sizeof(p->resources));
255         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
256         memset(&p->env_tf, 0, sizeof(p->env_tf));
257         spinlock_init(&p->mm_lock);
258         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
259         /* Initialize the vcore lists, we'll build the inactive list so that it includes
260          * all vcores when we initialize procinfo.  Do this before initing procinfo. */
261         TAILQ_INIT(&p->online_vcs);
262         TAILQ_INIT(&p->bulk_preempted_vcs);
263         TAILQ_INIT(&p->inactive_vcs);
264         /* Init procinfo/procdata.  Procinfo's argp/argb are 0'd */
265         proc_init_procinfo(p);
266         proc_init_procdata(p);
267
268         /* Initialize the generic sysevent ring buffer */
269         SHARED_RING_INIT(&p->procdata->syseventring);
270         /* Initialize the frontend of the sysevent ring buffer */
271         FRONT_RING_INIT(&p->syseventfrontring,
272                         &p->procdata->syseventring,
273                         SYSEVENTRINGSIZE);
274
275         /* Init FS structures TODO: cleanup (might pull this out) */
276         kref_get(&default_ns.kref, 1);
277         p->ns = &default_ns;
278         spinlock_init(&p->fs_env.lock);
279         p->fs_env.umask = parent ? parent->fs_env.umask : S_IWGRP | S_IWOTH;
280         p->fs_env.root = p->ns->root->mnt_root;
281         kref_get(&p->fs_env.root->d_kref, 1);
282         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
283         kref_get(&p->fs_env.pwd->d_kref, 1);
284         memset(&p->open_files, 0, sizeof(p->open_files));       /* slightly ghetto */
285         spinlock_init(&p->open_files.lock);
286         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
287         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
288         p->open_files.fd = p->open_files.fd_array;
289         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
290         /* Init the ucq hash lock */
291         p->ucq_hashlock = (struct hashlock*)&p->ucq_hl_noref;
292         hashlock_init(p->ucq_hashlock, HASHLOCK_DEFAULT_SZ);
293
294         atomic_inc(&num_envs);
295         frontend_proc_init(p);
296         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
297         } // INIT_STRUCT
298         *pp = p;
299         return 0;
300 }
301
302 /* We have a bunch of different ways to make processes.  Call this once the
303  * process is ready to be used by the rest of the system.  For now, this just
304  * means when it is ready to be named via the pidhash.  In the future, we might
305  * push setting the state to CREATED into here. */
306 void __proc_ready(struct proc *p)
307 {
308         spin_lock(&pid_hash_lock);
309         hashtable_insert(pid_hash, (void*)(long)p->pid, p);
310         spin_unlock(&pid_hash_lock);
311 }
312
313 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
314  * rid of proc_alloc's style, but it is so quaint... */
315 struct proc *proc_create(struct file *prog, char **argv, char **envp)
316 {
317         struct proc *p;
318         error_t r;
319         if ((r = proc_alloc(&p, current)) < 0)
320                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
321         procinfo_pack_args(p->procinfo, argv, envp);
322         assert(load_elf(p, prog) == 0);
323         /* Connect to stdin, stdout, stderr */
324         assert(insert_file(&p->open_files, dev_stdin,  0) == 0);
325         assert(insert_file(&p->open_files, dev_stdout, 0) == 1);
326         assert(insert_file(&p->open_files, dev_stderr, 0) == 2);
327         __proc_ready(p);
328         return p;
329 }
330
331 /* This is called by kref_put(), once the last reference to the process is
332  * gone.  Don't call this otherwise (it will panic).  It will clean up the
333  * address space and deallocate any other used memory. */
334 static void __proc_free(struct kref *kref)
335 {
336         struct proc *p = container_of(kref, struct proc, p_kref);
337         physaddr_t pa;
338
339         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
340         // All parts of the kernel should have decref'd before __proc_free is called
341         assert(kref_refcnt(&p->p_kref) == 0);
342
343         kref_put(&p->fs_env.root->d_kref);
344         kref_put(&p->fs_env.pwd->d_kref);
345         destroy_vmrs(p);
346         frontend_proc_free(p);  /* TODO: please remove me one day */
347         /* Free any colors allocated to this process */
348         if (p->cache_colors_map != global_cache_colors_map) {
349                 for(int i = 0; i < llc_cache->num_colors; i++)
350                         cache_color_free(llc_cache, p->cache_colors_map);
351                 cache_colors_map_free(p->cache_colors_map);
352         }
353         /* Remove us from the pid_hash and give our PID back (in that order). */
354         spin_lock(&pid_hash_lock);
355         if (!hashtable_remove(pid_hash, (void*)(long)p->pid))
356                 panic("Proc not in the pid table in %s", __FUNCTION__);
357         spin_unlock(&pid_hash_lock);
358         put_free_pid(p->pid);
359         /* Flush all mapped pages in the user portion of the address space */
360         env_user_mem_free(p, 0, UVPT);
361         /* These need to be free again, since they were allocated with a refcnt. */
362         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
363         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
364
365         env_pagetable_free(p);
366         p->env_pgdir = 0;
367         p->env_cr3 = 0;
368
369         atomic_dec(&num_envs);
370
371         /* Dealloc the struct proc */
372         kmem_cache_free(proc_cache, p);
373 }
374
375 /* Whether or not actor can control target.  Note we currently don't need
376  * locking for this. TODO: think about that, esp wrt proc's dying. */
377 bool proc_controls(struct proc *actor, struct proc *target)
378 {
379         return ((actor == target) || (target->ppid == actor->pid));
380 }
381
382 /* Helper to incref by val.  Using the helper to help debug/interpose on proc
383  * ref counting.  Note that pid2proc doesn't use this interface. */
384 void proc_incref(struct proc *p, unsigned int val)
385 {
386         kref_get(&p->p_kref, val);
387 }
388
389 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
390 void proc_decref(struct proc *p)
391 {
392         kref_put(&p->p_kref);
393 }
394
395 /* Helper, makes p the 'current' process, dropping the old current/cr3.  This no
396  * longer assumes the passed in reference already counted 'current'.  It will
397  * incref internally when needed. */
398 static void __set_proc_current(struct proc *p)
399 {
400         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
401          * though who know how expensive/painful they are. */
402         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
403         /* If the process wasn't here, then we need to load its address space. */
404         if (p != pcpui->cur_proc) {
405                 proc_incref(p, 1);
406                 lcr3(p->env_cr3);
407                 /* This is "leaving the process context" of the previous proc.  The
408                  * previous lcr3 unloaded the previous proc's context.  This should
409                  * rarely happen, since we usually proactively leave process context,
410                  * but this is the fallback. */
411                 if (pcpui->cur_proc)
412                         proc_decref(pcpui->cur_proc);
413                 pcpui->cur_proc = p;
414         }
415 }
416
417 /* Dispatches a process to run, either on the current core in the case of a
418  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
419  * never be called to "restart" a core.  This expects that the "instructions"
420  * for which core(s) to run this on will be in the vcoremap, which needs to be
421  * set externally (give_cores()).
422  *
423  * This will always return, regardless of whether or not the calling core is
424  * being given to a process. (it used to pop the tf directly, before we had
425  * cur_tf).
426  *
427  * Since it always returns, it will never "eat" your reference (old
428  * documentation talks about this a bit). */
429 void proc_run(struct proc *p)
430 {
431         struct vcore *vc_i;
432         spin_lock(&p->proc_lock);
433         switch (p->state) {
434                 case (PROC_DYING):
435                         spin_unlock(&p->proc_lock);
436                         printk("Process %d not starting due to async death\n", p->pid);
437                         return;
438                 case (PROC_RUNNABLE_S):
439                         assert(current != p);
440                         __proc_set_state(p, PROC_RUNNING_S);
441                         /* We will want to know where this process is running, even if it is
442                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
443                          * Also, this is the signal used in trap.c to know to save the tf in
444                          * env_tf. */
445                         __seq_start_write(&p->procinfo->coremap_seqctr);
446                         p->procinfo->num_vcores = 0;    /* TODO (VC#) */
447                         /* TODO: For now, we won't count this as an active vcore (on the
448                          * lists).  This gets unmapped in resource.c and yield_s, and needs
449                          * work. */
450                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
451                         __seq_end_write(&p->procinfo->coremap_seqctr);
452                         /* incref, since we're saving a reference in current */
453                         proc_incref(p, 1);
454                         __set_proc_current(p);
455                         /* We restartcore, instead of startcore, since startcore is a bit
456                          * lower level and we want a chance to process kmsgs before starting
457                          * the process. */
458                         spin_unlock(&p->proc_lock);
459                         disable_irq();          /* before mucking with cur_tf / owning_proc */
460                         /* this is one of the few times cur_tf != &actual_tf */
461                         current_tf = &p->env_tf;        /* no need for irq disable yet */
462                         /* storing the passed in ref of p in owning_proc */
463                         per_cpu_info[core_id()].owning_proc = p;
464                         /* When the calling core idles, it'll call restartcore and run the
465                          * _S process's context. */
466                         return;
467                 case (PROC_RUNNABLE_M):
468                         /* vcoremap[i] holds the coreid of the physical core allocated to
469                          * this process.  It is set outside proc_run.  For the kernel
470                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
471                         if (p->procinfo->num_vcores) {
472                                 __proc_set_state(p, PROC_RUNNING_M);
473                                 /* Up the refcnt, to avoid the n refcnt upping on the
474                                  * destination cores.  Keep in sync with __startcore */
475                                 proc_incref(p, p->procinfo->num_vcores * 2);
476                                 /* Send kernel messages to all online vcores (which were added
477                                  * to the list and mapped in __proc_give_cores()), making them
478                                  * turn online */
479                                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
480                                         send_kernel_message(vc_i->pcoreid, __startcore, (long)p,
481                                                             0, 0, KMSG_IMMEDIATE);
482                                 }
483                         } else {
484                                 warn("Tried to proc_run() an _M with no vcores!");
485                         }
486                         /* There a subtle race avoidance here.  __proc_startcore can handle
487                          * a death message, but we can't have the startcore come after the
488                          * death message.  Otherwise, it would look like a new process.  So
489                          * we hold the lock til after we send our message, which prevents a
490                          * possible death message.
491                          * - Note there is no guarantee this core's interrupts were on, so
492                          *   it may not get the message for a while... */
493                         spin_unlock(&p->proc_lock);
494                         return;
495                 default:
496                         spin_unlock(&p->proc_lock);
497                         panic("Invalid process state %p in proc_run()!!", p->state);
498         }
499 }
500
501 /* Actually runs the given context (trapframe) of process p on the core this
502  * code executes on.  This is called directly by __startcore, which needs to
503  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
504  *
505  * A note on refcnting: this function will not return, and your proc reference
506  * will end up stored in current.  This will make no changes to p's refcnt, so
507  * do your accounting such that there is only the +1 for current.  This means if
508  * it is already in current (like in the trap return path), don't up it.  If
509  * it's already in current and you have another reference (like pid2proc or from
510  * an IPI), then down it (which is what happens in __startcore()).  If it's not
511  * in current and you have one reference, like proc_run(non_current_p), then
512  * also do nothing.  The refcnt for your *p will count for the reference stored
513  * in current. */
514 static void __proc_startcore(struct proc *p, trapframe_t *tf)
515 {
516         assert(!irq_is_enabled());
517         __set_proc_current(p);
518         /* need to load our silly state, preferably somewhere other than here so we
519          * can avoid the case where the context was just running here.  it's not
520          * sufficient to do it in the "new process" if-block above (could be things
521          * like page faults that cause us to keep the same process, but want a
522          * different context.
523          * for now, we load this silly state here. (TODO) (HSS)
524          * We also need this to be per trapframe, and not per process...
525          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
526          * __startcore.  */
527         if (p->state == PROC_RUNNING_S)
528                 env_pop_ancillary_state(p);
529         /* Clear the current_tf, since it is no longer used */
530         current_tf = 0; /* TODO: might not need this... */
531         env_pop_tf(tf);
532 }
533
534 /* Restarts/runs the current_tf, which must be for the current process, on the
535  * core this code executes on.  Calls an internal function to do the work.
536  *
537  * In case there are pending routine messages, like __death, __preempt, or
538  * __notify, we need to run them.  Alternatively, if there are any, we could
539  * self_ipi, and run the messages immediately after popping back to userspace,
540  * but that would have crappy overhead.
541  *
542  * Refcnting: this will not return, and it assumes that you've accounted for
543  * your reference as if it was the ref for "current" (which is what happens when
544  * returning from local traps and such. */
545 void proc_restartcore(void)
546 {
547         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
548         assert(!pcpui->cur_sysc);
549         /* Try and get any interrupts before we pop back to userspace.  If we didn't
550          * do this, we'd just get them in userspace, but this might save us some
551          * effort/overhead. */
552         enable_irq();
553         /* Need ints disabled when we return from processing (race on missing
554          * messages/IPIs) */
555         disable_irq();
556         process_routine_kmsg(pcpui->cur_tf);
557         /* If there is no owning process, just idle, since we don't know what to do.
558          * This could be because the process had been restarted a long time ago and
559          * has since left the core, or due to a KMSG like __preempt or __death. */
560         if (!pcpui->owning_proc) {
561                 abandon_core();
562                 smp_idle();
563         }
564         assert(pcpui->cur_tf);
565         __proc_startcore(pcpui->owning_proc, pcpui->cur_tf);
566 }
567
568 /*
569  * Destroys the given process.  This may be called from another process, a light
570  * kernel thread (no real process context), asynchronously/cross-core, or from
571  * the process on its own core.
572  *
573  * Here's the way process death works:
574  * 0. grab the lock (protects state transition and core map)
575  * 1. set state to dying.  that keeps the kernel from doing anything for the
576  * process (like proc_running it).
577  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
578  * 3. IPI to clean up those cores (decref, etc).
579  * 4. Unlock
580  * 5. Clean up your core, if applicable
581  * (Last core/kernel thread to decref cleans up and deallocates resources.)
582  *
583  * Note that some cores can be processing async calls, but will eventually
584  * decref.  Should think about this more, like some sort of callback/revocation.
585  *
586  * This function will now always return (it used to not return if the calling
587  * core was dying).  However, when it returns, a kernel message will eventually
588  * come in, making you abandon_core, as if you weren't running.  It may be that
589  * the only reference to p is the one you passed in, and when you decref, it'll
590  * get __proc_free()d. */
591 void proc_destroy(struct proc *p)
592 {
593         spin_lock(&p->proc_lock);
594         switch (p->state) {
595                 case PROC_DYING: // someone else killed this already.
596                         spin_unlock(&p->proc_lock);
597                         return;
598                 case PROC_RUNNABLE_M:
599                         /* Need to reclaim any cores this proc might have, even though it's
600                          * not running yet. */
601                         __proc_take_allcores_dumb(p, FALSE);
602                         // fallthrough
603                 case PROC_RUNNABLE_S:
604                         /* might need to pull from lists, though i'm currently a fan of the
605                          * model where external refs notice DYING (if it matters to them)
606                          * and decref when they are done.  the ksched will notice the proc
607                          * is dying and handle it accordingly (which delay the reaping til
608                          * the next call to schedule()) */
609                         break;
610                 case PROC_RUNNING_S:
611                         #if 0
612                         // here's how to do it manually
613                         if (current == p) {
614                                 lcr3(boot_cr3);
615                                 proc_decref(p);         /* this decref is for the cr3 */
616                                 current = NULL;
617                         }
618                         #endif
619                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
620                                             KMSG_IMMEDIATE);
621                         __seq_start_write(&p->procinfo->coremap_seqctr);
622                         // TODO: might need to sort num_vcores too later (VC#)
623                         /* vcore is unmapped on the receive side */
624                         __seq_end_write(&p->procinfo->coremap_seqctr);
625                         #if 0
626                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
627                          * managed by the idlecoremap.  so don't do this yet. */
628                         put_idle_core(get_pcoreid(p, 0));
629                         #endif
630                         break;
631                 case PROC_RUNNING_M:
632                         /* Send the DEATH message to every core running this process, and
633                          * deallocate the cores.
634                          * The rule is that the vcoremap is set before proc_run, and reset
635                          * within proc_destroy */
636                         __proc_take_allcores_dumb(p, FALSE);
637                         break;
638                 case PROC_CREATED:
639                         break;
640                 default:
641                         panic("Weird state(%s) in %s()", procstate2str(p->state),
642                               __FUNCTION__);
643         }
644         __proc_set_state(p, PROC_DYING);
645         /* This prevents processes from accessing their old files while dying, and
646          * will help if these files (or similar objects in the future) hold
647          * references to p (preventing a __proc_free()). */
648         close_all_files(&p->open_files, FALSE);
649         /* This decref is for the process's existence. */
650         proc_decref(p);
651         /* Unlock.  A death IPI should be on its way, either from the RUNNING_S one,
652          * or from proc_take_cores with a __death.  in general, interrupts should be
653          * on when you call proc_destroy locally, but currently aren't for all
654          * things (like traphandlers). */
655         spin_unlock(&p->proc_lock);
656         return;
657 }
658
659 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
660  * process.  Currently, this ignores whether or not you are an _M already.  You
661  * should hold the lock before calling. */
662 void __proc_switch_to_m(struct proc *p)
663 {
664         int8_t state = 0;
665         switch (p->state) {
666                 case (PROC_RUNNING_S):
667                         /* issue with if we're async or not (need to preempt it)
668                          * either of these should trip it. TODO: (ACR) async core req
669                          * TODO: relies on vcore0 being the caller (VC#) */
670                         if ((current != p) || (get_pcoreid(p, 0) != core_id()))
671                                 panic("We don't handle async RUNNING_S core requests yet.");
672                         /* save the tf so userspace can restart it.  Like in __notify,
673                          * this assumes a user tf is the same as a kernel tf.  We save
674                          * it in the preempt slot so that we can also save the silly
675                          * state. */
676                         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
677                         disable_irqsave(&state);        /* protect cur_tf */
678                         /* Note this won't play well with concurrent proc kmsgs, but
679                          * since we're _S and locked, we shouldn't have any. */
680                         assert(current_tf);
681                         /* Copy uthread0's context to the notif slot */
682                         vcpd->notif_tf = *current_tf;
683                         clear_owning_proc(core_id());   /* so we don't restart */
684                         save_fp_state(&vcpd->preempt_anc);
685                         enable_irqsave(&state);
686                         /* Userspace needs to not fuck with notif_disabled before
687                          * transitioning to _M. */
688                         if (vcpd->notif_disabled) {
689                                 printk("[kernel] user bug: notifs disabled for vcore 0\n");
690                                 vcpd->notif_disabled = FALSE;
691                         }
692                         /* in the async case, we'll need to remotely stop and bundle
693                          * vcore0's TF.  this is already done for the sync case (local
694                          * syscall). */
695                         /* this process no longer runs on its old location (which is
696                          * this core, for now, since we don't handle async calls) */
697                         __seq_start_write(&p->procinfo->coremap_seqctr);
698                         // TODO: (VC#) might need to adjust num_vcores
699                         // TODO: (ACR) will need to unmap remotely (receive-side)
700                         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run _S */
701                         __seq_end_write(&p->procinfo->coremap_seqctr);
702                         /* change to runnable_m (it's TF is already saved) */
703                         __proc_set_state(p, PROC_RUNNABLE_M);
704                         p->procinfo->is_mcp = TRUE;
705                         break;
706                 case (PROC_RUNNABLE_S):
707                         /* Issues: being on the runnable_list, proc_set_state not liking
708                          * it, and not clearly thinking through how this would happen.
709                          * Perhaps an async call that gets serviced after you're
710                          * descheduled? */
711                         panic("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
712                         break;
713                 case (PROC_DYING):
714                         warn("Dying, core request coming from %d\n", core_id());
715                 default:
716                         break;
717         }
718 }
719
720 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
721  * becoming the new 'thread0'.  Don't use this. */
722 void __proc_switch_to_s(struct proc *p)
723 {
724         int8_t state = 0;
725         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
726         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
727         /* save the context, to be restarted in _S mode */
728         disable_irqsave(&state);        /* protect cur_tf */
729         assert(current_tf);
730         p->env_tf = *current_tf;
731         clear_owning_proc(core_id());   /* so we don't restart */
732         enable_irqsave(&state);
733         env_push_ancillary_state(p); // TODO: (HSS)
734         /* sending death, since it's not our job to save contexts or anything in
735          * this case.  also, if this returns true, we will not return down
736          * below, and need to eat the reference to p */
737         __proc_take_allcores_dumb(p, FALSE);
738         __proc_set_state(p, PROC_RUNNABLE_S);
739 }
740
741 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
742  * careful. */
743 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
744 {
745         return p->procinfo->pcoremap[pcoreid].valid;
746 }
747
748 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
749  * No locking involved, be careful.  Panics on failure. */
750 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
751 {
752         assert(is_mapped_vcore(p, pcoreid));
753         return p->procinfo->pcoremap[pcoreid].vcoreid;
754 }
755
756 /* Helper function.  Try to find the pcoreid for a given virtual core id for
757  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
758  * stale or otherwise 'wrong' answer. */
759 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
760 {
761         return p->procinfo->vcoremap[vcoreid].pcoreid;
762 }
763
764 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
765  * No locking involved, be careful.  Panics on failure. */
766 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
767 {
768         assert(vcore_is_mapped(p, vcoreid));
769         return try_get_pcoreid(p, vcoreid);
770 }
771
772 /* Helper function: yields / wraps up current_tf and schedules the _S */
773 void __proc_yield_s(struct proc *p, struct trapframe *tf)
774 {
775         assert(p->state == PROC_RUNNING_S);
776         p->env_tf= *tf;
777         env_push_ancillary_state(p);                    /* TODO: (HSS) */
778         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run _S */
779         __proc_set_state(p, PROC_RUNNABLE_S);
780         schedule_proc(p);
781 }
782
783 /* Yields the calling core.  Must be called locally (not async) for now.
784  * - If RUNNING_S, you just give up your time slice and will eventually return.
785  * - If RUNNING_M, you give up the current vcore (which never returns), and
786  *   adjust the amount of cores wanted/granted.
787  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
788  *   you'll have one guaranteed core, starting from the entry point.
789  *
790  * - RES_CORES amt_wanted will be the amount running after taking away the
791  *   yielder, unless there are none left, in which case it will be 1.
792  *
793  * If the call is being nice, it means that it is in response to a preemption
794  * (which needs to be checked).  If there is no preemption pending, just return.
795  * No matter what, don't adjust the number of cores wanted.
796  *
797  * This usually does not return (smp_idle()), so it will eat your reference.
798  * Also note that it needs a non-current/edible reference, since it will abandon
799  * and continue to use the *p (current == 0, no cr3, etc).
800  *
801  * We disable interrupts for most of it too, since we need to protect current_tf
802  * and not race with __notify (which doesn't play well with concurrent
803  * yielders). */
804 void proc_yield(struct proc *SAFE p, bool being_nice)
805 {
806         uint32_t vcoreid, pcoreid = core_id();
807         struct vcore *vc;
808         struct preempt_data *vcpd;
809         int8_t state = 0;
810         /* Need to disable before even reading vcoreid, since we could be unmapped
811          * by a __preempt or __death.  _S also needs ints disabled, so we'll just do
812          * it immediately. */
813         disable_irqsave(&state);
814         /* Need to lock before checking the vcoremap to find out who we are, in case
815          * we're getting __preempted and __startcored, from a remote core (in which
816          * case we might have come in thinking we were vcore X, but had X preempted
817          * and Y restarted on this pcore, and we suddenly are the wrong vcore
818          * yielding).  Arguably, this is incredibly rare, since you'd need to
819          * preempt the core, then decide to give it back with another grant in
820          * between. */
821         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
822         switch (p->state) {
823                 case (PROC_RUNNING_S):
824                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
825                         goto out_yield_core;
826                 case (PROC_RUNNING_M):
827                         break;                          /* will handle this stuff below */
828                 case (PROC_DYING):              /* incoming __death */
829                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
830                         goto out_failed;
831                 default:
832                         panic("Weird state(%s) in %s()", procstate2str(p->state),
833                               __FUNCTION__);
834         }
835         /* If we're already unmapped (__preempt or a __death hit us), bail out.
836          * Note that if a __death hit us, we should have bailed when we saw
837          * PROC_DYING. */
838         if (!is_mapped_vcore(p, pcoreid))
839                 goto out_failed;
840         vcoreid = get_vcoreid(p, pcoreid);
841         vc = vcoreid2vcore(p, vcoreid);
842         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
843         /* no reason to be nice, return */
844         if (being_nice && !vc->preempt_pending)
845                 goto out_failed;
846         /* Fate is sealed, return and take the preempt message when we enable_irqs.
847          * Note this keeps us from mucking with our lists, since we were already
848          * removed from the online_list.  We have a similar concern with __death,
849          * but we check for DYING to handle that. */
850         if (vc->preempt_served)
851                 goto out_failed;
852         /* At this point, AFAIK there should be no preempt/death messages on the
853          * way, and we're on the online list.  So we'll go ahead and do the yielding
854          * business. */
855         /* no need to preempt later, since we are yielding (nice or otherwise) */
856         if (vc->preempt_pending)
857                 vc->preempt_pending = 0;
858         /* Don't let them yield if they are missing a notification.  Userspace must
859          * not leave vcore context without dealing with notif_pending.  pop_ros_tf()
860          * handles leaving via uthread context.  This handles leaving via a yield.
861          *
862          * This early check is an optimization.  The real check is below when it
863          * works with the online_vcs list (syncing with event.c and INDIR/IPI
864          * posting). */
865         if (vcpd->notif_pending)
866                 goto out_failed;
867         /* Now we'll actually try to yield */
868         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
869                get_vcoreid(p, coreid));
870         /* Remove from the online list, add to the yielded list, and unmap
871          * the vcore, which gives up the core. */
872         TAILQ_REMOVE(&p->online_vcs, vc, list);
873         /* Now that we're off the online list, check to see if an alert made
874          * it through (event.c sets this) */
875         wrmb(); /* prev write must hit before reading notif_pending */
876         /* Note we need interrupts disabled, since a __notify can come in
877          * and set pending to FALSE */
878         if (vcpd->notif_pending) {
879                 /* We lost, put it back on the list and abort the yield */
880                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
881                 goto out_failed;
882         }
883         /* We won the race with event sending, we can safely yield */
884         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
885         /* Note this protects stuff userspace should look at, which doesn't
886          * include the TAILQs. */
887         __seq_start_write(&p->procinfo->coremap_seqctr);
888         /* Next time the vcore starts, it starts fresh */
889         vcpd->notif_disabled = FALSE;
890         __unmap_vcore(p, vcoreid);
891         /* Adjust implied resource desires */
892         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
893         if (!being_nice)
894                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
895         __seq_end_write(&p->procinfo->coremap_seqctr);
896         /* Hand the now-idle core to the ksched */
897         put_idle_core(pcoreid);
898         // last vcore?  then we really want 1, and to yield the gang
899         if (p->procinfo->num_vcores == 0) {
900                 p->resources[RES_CORES].amt_wanted = 1;
901                 /* wait on an event (not supporting 'being nice' for now */
902                 __proc_set_state(p, PROC_WAITING);
903         }
904         goto out_yield_core;
905 out_failed:
906         /* for some reason we just want to return, either to take a KMSG that cleans
907          * us up, or because we shouldn't yield (ex: notif_pending). */
908         spin_unlock(&p->proc_lock);
909         enable_irqsave(&state);
910         return;
911 out_yield_core:                 /* successfully yielded the core */
912         spin_unlock(&p->proc_lock);
913         proc_decref(p);                 /* need to eat the ref passed in */
914         /* Clean up the core and idle.  Need to do this before enabling interrupts,
915          * since once we put_idle_core() and unlock, we could get a startcore. */
916         clear_owning_proc(pcoreid);     /* so we don't restart */
917         abandon_core();
918         smp_idle();                             /* will reenable interrupts */
919 }
920
921 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
922  * only send a notification if one they are enabled.  There's a bunch of weird
923  * cases with this, and how pending / enabled are signals between the user and
924  * kernel - check the documentation.  Note that pending is more about messages.
925  * The process needs to be in vcore_context, and the reason is usually a
926  * message.  We set pending here in case we were called to prod them into vcore
927  * context (like via a sys_self_notify. */
928 void proc_notify(struct proc *p, uint32_t vcoreid)
929 {
930         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
931         vcpd->notif_pending = TRUE;
932         wrmb(); /* must write notif_pending before reading notif_disabled */
933         if (!vcpd->notif_disabled) {
934                 /* GIANT WARNING: we aren't using the proc-lock to protect the
935                  * vcoremap.  We want to be able to use this from interrupt context,
936                  * and don't want the proc_lock to be an irqsave.  Spurious
937                  * __notify() kmsgs are okay (it checks to see if the right receiver
938                  * is current). */
939                 if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
940                               vcore_is_mapped(p, vcoreid)) {
941                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
942                         /* This use of try_get_pcoreid is racy, might be unmapped */
943                         send_kernel_message(try_get_pcoreid(p, vcoreid), __notify, (long)p,
944                                             0, 0, KMSG_IMMEDIATE);
945                 }
946         }
947 }
948
949 /* Hold the lock before calling this.  If the process is WAITING, it will wake
950  * it up and schedule it. */
951 void __proc_wakeup(struct proc *p)
952 {
953         if (p->state != PROC_WAITING)
954                 return;
955         if (__proc_is_mcp(p))
956                 __proc_set_state(p, PROC_RUNNABLE_M);
957         else
958                 __proc_set_state(p, PROC_RUNNABLE_S);
959         schedule_proc(p);
960 }
961
962 /* Is the process in multi_mode / is an MCP or not?  */
963 bool __proc_is_mcp(struct proc *p)
964 {
965         /* in lieu of using the amount of cores requested, or having a bunch of
966          * states (like PROC_WAITING_M and _S), I'll just track it with a bool. */
967         return p->procinfo->is_mcp;
968 }
969
970 /************************  Preemption Functions  ******************************
971  * Don't rely on these much - I'll be sure to change them up a bit.
972  *
973  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
974  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
975  * flux.  The num_vcores is changed after take_cores, but some of the messages
976  * (or local traps) may not yet be ready to handle seeing their future state.
977  * But they should be, so fix those when they pop up.
978  *
979  * Another thing to do would be to make the _core functions take a pcorelist,
980  * and not just one pcoreid. */
981
982 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
983  * about locking, do it before calling.  Takes a vcoreid! */
984 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
985 {
986         struct event_msg local_msg = {0};
987         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
988          * since it is unmapped and not dealt with (TODO)*/
989         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
990
991         /* Send the event (which internally checks to see how they want it) */
992         local_msg.ev_type = EV_PREEMPT_PENDING;
993         local_msg.ev_arg1 = vcoreid;
994         send_kernel_event(p, &local_msg, vcoreid);
995
996         /* TODO: consider putting in some lookup place for the alarm to find it.
997          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
998 }
999
1000 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1001  * care about the mapping (and you should). */
1002 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1003 {
1004         struct vcore *vc_i;
1005         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1006                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1007         /* TODO: consider putting in some lookup place for the alarm to find it.
1008          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1009 }
1010
1011 // TODO: function to set an alarm, if none is outstanding
1012
1013 /* Raw function to preempt a single core.  If you care about locking, do it
1014  * before calling. */
1015 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1016 {
1017         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1018         struct event_msg preempt_msg = {0};
1019         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1020         // expects a pcorelist.  assumes pcore is mapped and running_m
1021         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1022         /* Send a message about the preemption. */
1023         preempt_msg.ev_type = EV_VCORE_PREEMPT;
1024         preempt_msg.ev_arg2 = vcoreid;
1025         send_kernel_event(p, &preempt_msg, 0);
1026 }
1027
1028 /* Raw function to preempt every vcore.  If you care about locking, do it before
1029  * calling. */
1030 void __proc_preempt_all(struct proc *p)
1031 {
1032         /* instead of doing this, we could just preempt_served all possible vcores,
1033          * and not just the active ones.  We would need to sort out a way to deal
1034          * with stale preempt_serveds first.  This might be just as fast anyways. */
1035         struct vcore *vc_i;
1036         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag, or
1037          * just make us RUNNABLE_M. */
1038         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1039                 vc_i->preempt_served = TRUE;
1040         __proc_take_allcores_dumb(p, TRUE);
1041 }
1042
1043 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1044  * warning will be for u usec from now. */
1045 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1046 {
1047         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1048
1049         /* DYING could be okay */
1050         if (p->state != PROC_RUNNING_M) {
1051                 warn("Tried to preempt from a non RUNNING_M proc!");
1052                 return;
1053         }
1054         spin_lock(&p->proc_lock);
1055         if (is_mapped_vcore(p, pcoreid)) {
1056                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1057                 __proc_preempt_core(p, pcoreid);
1058                 put_idle_core(pcoreid);
1059         } else {
1060                 warn("Pcore doesn't belong to the process!!");
1061         }
1062         if (!p->procinfo->num_vcores) {
1063                 __proc_set_state(p, PROC_RUNNABLE_M);
1064                 schedule_proc(p);
1065         }
1066         spin_unlock(&p->proc_lock);
1067 }
1068
1069 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1070  * warning will be for u usec from now. */
1071 void proc_preempt_all(struct proc *p, uint64_t usec)
1072 {
1073         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1074
1075         spin_lock(&p->proc_lock);
1076         /* DYING could be okay */
1077         if (p->state != PROC_RUNNING_M) {
1078                 warn("Tried to preempt from a non RUNNING_M proc!");
1079                 spin_unlock(&p->proc_lock);
1080                 return;
1081         }
1082         __proc_preempt_warnall(p, warn_time);
1083         __proc_preempt_all(p);
1084         assert(!p->procinfo->num_vcores);
1085         __proc_set_state(p, PROC_RUNNABLE_M);
1086         schedule_proc(p);
1087         spin_unlock(&p->proc_lock);
1088 }
1089
1090 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1091  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1092  * free, etc. */
1093 void proc_give(struct proc *p, uint32_t pcoreid)
1094 {
1095         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1096         spin_lock(&p->proc_lock);
1097         // expects a pcorelist, we give it a list of one
1098         __proc_give_cores(p, &pcoreid, 1);
1099         spin_unlock(&p->proc_lock);
1100 }
1101
1102 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1103  * out). */
1104 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1105 {
1106         uint32_t vcoreid;
1107         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1108         spin_lock(&p->proc_lock);
1109         switch (p->state) {
1110                 case PROC_RUNNING_S:
1111                         spin_unlock(&p->proc_lock);
1112                         return 0; // TODO: here's the ugly part
1113                 case PROC_RUNNING_M:
1114                         vcoreid = get_vcoreid(p, pcoreid);
1115                         spin_unlock(&p->proc_lock);
1116                         return vcoreid;
1117                 case PROC_DYING: // death message is on the way
1118                         spin_unlock(&p->proc_lock);
1119                         return 0;
1120                 default:
1121                         spin_unlock(&p->proc_lock);
1122                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1123                               __FUNCTION__);
1124         }
1125 }
1126
1127 /* TODO: make all of these static inlines when we gut the env crap */
1128 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1129 {
1130         return p->procinfo->vcoremap[vcoreid].valid;
1131 }
1132
1133 /* Can do this, or just create a new field and save it in the vcoremap */
1134 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1135 {
1136         return (vc - p->procinfo->vcoremap);
1137 }
1138
1139 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1140 {
1141         return &p->procinfo->vcoremap[vcoreid];
1142 }
1143
1144 /********** Core granting (bulk and single) ***********/
1145
1146 /* Helper: gives pcore to the process, mapping it to the next available vcore
1147  * from list vc_list.  Returns TRUE if we succeeded (non-empty). */
1148 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1149                                 struct vcore_tailq *vc_list)
1150 {
1151         struct vcore *new_vc;
1152         new_vc = TAILQ_FIRST(vc_list);
1153         if (!new_vc)
1154                 return FALSE;
1155         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1156                pcorelist[i]);
1157         TAILQ_REMOVE(vc_list, new_vc, list);
1158         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1159         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1160         return TRUE;
1161 }
1162
1163 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1164                                        uint32_t num)
1165 {
1166         struct vcore *vc_i, *vc_temp;
1167         struct event_msg preempt_msg = {0};
1168         /* They shouldn't have any vcores yet.  One issue with allowing multiple
1169          * calls to _give_cores_ is that the bulk preempt list needs to be handled
1170          * in one shot. */
1171         assert(!p->procinfo->num_vcores);
1172         assert(num);    /* catch bugs */
1173         /* add new items to the vcoremap */
1174         __seq_start_write(&p->procinfo->coremap_seqctr);
1175         p->procinfo->num_vcores += num;
1176         for (int i = 0; i < num; i++) {
1177                 /* Try from the bulk list first */
1178                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs))
1179                         continue;
1180                 /* o/w, try from the inactive list.  at one point, i thought there might
1181                  * be a legit way in which the inactive list could be empty, but that i
1182                  * wanted to catch it via an assert. */
1183                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1184         }
1185         __seq_end_write(&p->procinfo->coremap_seqctr);
1186         /* Send preempt messages for any left on the BP list.  No need to set any
1187          * flags, it all was done on the real preempt.  Now we're just telling the
1188          * process about any that didn't get restarted and are still preempted. */
1189         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
1190                 /* Note that if there are no active vcores, send_k_e will post to our
1191                  * own vcore, the last of which will be put on the inactive list and be
1192                  * the first to be started.  We don't have to worry too much, since
1193                  * we're holding the proc lock */
1194                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
1195                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i);   /* arg2 is 32 bits */
1196                 send_kernel_event(p, &preempt_msg, 0);
1197                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that.
1198                  * We need a loop for the messages, but not necessarily for the list
1199                  * changes.  */
1200                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
1201                 /* TODO: put on the bulk preempt list, if applicable */
1202                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1203         }
1204 }
1205
1206 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1207                                       uint32_t num)
1208 {
1209         /* Up the refcnt, since num cores are going to start using this
1210          * process and have it loaded in their owning_proc and 'current'. */
1211         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1212         __seq_start_write(&p->procinfo->coremap_seqctr);
1213         p->procinfo->num_vcores += num;
1214         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1215         for (int i = 0; i < num; i++) {
1216                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1217                 send_kernel_message(pc_arr[i], __startcore, (long)p, 0, 0,
1218                                     KMSG_IMMEDIATE);
1219         }
1220         __seq_end_write(&p->procinfo->coremap_seqctr);
1221 }
1222
1223 /* Gives process p the additional num cores listed in pcorelist.  You must be
1224  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1225  * startup your new cores at the entry point with their virtual IDs (or restore
1226  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1227  * that the process can start to use its cores.
1228  *
1229  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1230  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1231  * Then call proc_run().
1232  *
1233  * The reason I didn't bring the _S cases from core_request over here is so we
1234  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1235  * this is called from another core, and to avoid the _S -> _M transition.
1236  *
1237  * WARNING: You must hold the proc_lock before calling this! */
1238 void __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1239 {
1240         /* should never happen: */
1241         assert(num + p->procinfo->num_vcores <= MAX_NUM_CPUS);
1242         switch (p->state) {
1243                 case (PROC_RUNNABLE_S):
1244                 case (PROC_RUNNING_S):
1245                         panic("Don't give cores to a process in a *_S state!\n");
1246                         break;
1247                 case (PROC_DYING):
1248                         /* We're dying, give the cores back to the ksched and return */
1249                         for (int i = 0; i < num; i++)
1250                                 put_idle_core(pc_arr[i]);
1251                         return;
1252                 case (PROC_RUNNABLE_M):
1253                         __proc_give_cores_runnable(p, pc_arr, num);
1254                         break;
1255                 case (PROC_RUNNING_M):
1256                         __proc_give_cores_running(p, pc_arr, num);
1257                         break;
1258                 default:
1259                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1260                               __FUNCTION__);
1261         }
1262         p->resources[RES_CORES].amt_granted += num;
1263 }
1264
1265 /********** Core revocation (bulk and single) ***********/
1266
1267 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1268 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1269 {
1270         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1271         struct preempt_data *vcpd;
1272         if (preempt) {
1273                 /* Lock the vcore's state (necessary for preemption recovery) */
1274                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1275                 atomic_or(&vcpd->flags, VC_K_LOCK);
1276                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0, KMSG_IMMEDIATE);
1277         } else {
1278                 send_kernel_message(pcoreid, __death, 0, 0, 0, KMSG_IMMEDIATE);
1279         }
1280 }
1281
1282 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1283 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1284 {
1285         struct vcore *vc_i;
1286         /* TODO: if we ever get broadcast messaging, use it here (still need to lock
1287          * the vcores' states for preemption) */
1288         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1289                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1290 }
1291
1292 /* Might be faster to scan the vcoremap than to walk the list... */
1293 static void __proc_unmap_allcores(struct proc *p)
1294 {
1295         struct vcore *vc_i;
1296         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1297                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1298 }
1299
1300 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1301  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1302  * Don't use this for taking all of a process's cores.
1303  *
1304  * Make sure you hold the lock when you call this. */
1305 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1306                           bool preempt)
1307 {
1308         struct vcore *vc;
1309         uint32_t vcoreid;
1310         __seq_start_write(&p->procinfo->coremap_seqctr);
1311         for (int i = 0; i < num; i++) {
1312                 vcoreid = get_vcoreid(p, pc_arr[i]);
1313                 /* Sanity check */
1314                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1315                 /* Revoke / unmap core */
1316                 if (p->state == PROC_RUNNING_M) {
1317                         __proc_revoke_core(p, vcoreid, preempt);
1318                 } else {
1319                         assert(p->state == PROC_RUNNABLE_M);
1320                         __unmap_vcore(p, vcoreid);
1321                 }
1322                 /* Change lists for the vcore.  Note, the messages are already in flight
1323                  * (or the vcore is already unmapped), if applicable.  The only code
1324                  * that looks at the lists without holding the lock is event code, and
1325                  * it doesn't care if the vcore was unmapped (it handles that) */
1326                 vc = vcoreid2vcore(p, vcoreid);
1327                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1328                 /* even for single preempts, we use the inactive list.  bulk preempt is
1329                  * only used for when we take everything. */
1330                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1331         }
1332         p->procinfo->num_vcores -= num;
1333         __seq_end_write(&p->procinfo->coremap_seqctr);
1334         p->resources[RES_CORES].amt_granted -= num;
1335 }
1336
1337 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1338  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1339  * returns the number of entries in pc_arr.
1340  *
1341  * Make sure pc_arr is big enough to handle num_vcores().
1342  * Make sure you hold the lock when you call this. */
1343 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1344 {
1345         struct vcore *vc_i, *vc_temp;
1346         uint32_t num = 0;
1347         __seq_start_write(&p->procinfo->coremap_seqctr);
1348         /* Write out which pcores we're going to take */
1349         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1350                 pc_arr[num++] = vc_i->pcoreid;
1351         /* Revoke if they are running, o/w unmap.  Both of these need the online
1352          * list to not be changed yet. */
1353         if (p->state == PROC_RUNNING_M) {
1354                 __proc_revoke_allcores(p, preempt);
1355         } else {
1356                 assert(p->state == PROC_RUNNABLE_M);
1357                 __proc_unmap_allcores(p);
1358         }
1359         /* Move the vcores from online to the head of the appropriate list */
1360         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1361                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that */
1362                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1363                 /* Put the cores on the appropriate list */
1364                 if (preempt)
1365                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1366                 else
1367                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1368         }
1369         assert(TAILQ_EMPTY(&p->online_vcs));
1370         assert(num == p->procinfo->num_vcores);
1371         p->procinfo->num_vcores = 0;
1372         __seq_end_write(&p->procinfo->coremap_seqctr);
1373         p->resources[RES_CORES].amt_granted = 0;
1374         return num;
1375 }
1376
1377 /* Dumb legacy helper, simply takes all cores and just puts them on the idle
1378  * core map (which belongs in the scheduler.
1379  *
1380  * TODO: no one should call this; the ksched should handle this internally */
1381 void __proc_take_allcores_dumb(struct proc *p, bool preempt)
1382 {
1383         uint32_t num_revoked;
1384         uint32_t pc_arr[p->procinfo->num_vcores];
1385         num_revoked = __proc_take_allcores(p, pc_arr, preempt);
1386         for (int i = 0; i < num_revoked; i++)
1387                 put_idle_core(pc_arr[i]);
1388 }
1389
1390 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1391  * calling. */
1392 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1393 {
1394         while (p->procinfo->vcoremap[vcoreid].valid)
1395                 cpu_relax();
1396         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1397         wmb();
1398         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1399         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1400         wmb();
1401         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1402 }
1403
1404 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1405  * calling. */
1406 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1407 {
1408         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1409         wmb();
1410         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1411 }
1412
1413 /* Stop running whatever context is on this core and load a known-good cr3.
1414  * Note this leaves no trace of what was running. This "leaves the process's
1415  * context.  Also, we want interrupts disabled, to not conflict with kmsgs
1416  * (__launch_kthread, proc mgmt, etc).
1417  *
1418  * This does not clear the owning proc.  Use the other helper for that. */
1419 void abandon_core(void)
1420 {
1421         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1422         assert(!irq_is_enabled());
1423         /* Syscalls that don't return will ultimately call abadon_core(), so we need
1424          * to make sure we don't think we are still working on a syscall. */
1425         pcpui->cur_sysc = 0;
1426         if (pcpui->cur_proc)
1427                 __abandon_core();
1428 }
1429
1430 /* Helper to clear the core's owning processor and manage refcnting.  Pass in
1431  * core_id() to save a couple core_id() calls. */
1432 void clear_owning_proc(uint32_t coreid)
1433 {
1434         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1435         struct proc *p = pcpui->owning_proc;
1436         assert(!irq_is_enabled());
1437         pcpui->owning_proc = 0;
1438         pcpui->cur_tf = 0;                      /* catch bugs for now (will go away soon) */
1439         if (p);
1440                 proc_decref(p);
1441 }
1442
1443 /* Switches to the address space/context of new_p, doing nothing if we are
1444  * already in new_p.  This won't add extra refcnts or anything, and needs to be
1445  * paired with switch_back() at the end of whatever function you are in.  Don't
1446  * migrate cores in the middle of a pair.  Specifically, the uncounted refs are
1447  * one for the old_proc, which is passed back to the caller, and new_p is
1448  * getting placed in cur_proc. */
1449 struct proc *switch_to(struct proc *new_p)
1450 {
1451         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1452         struct proc *old_proc;
1453         int8_t irq_state = 0;
1454         disable_irqsave(&irq_state);
1455         old_proc = pcpui->cur_proc;                                     /* uncounted ref */
1456         /* If we aren't the proc already, then switch to it */
1457         if (old_proc != new_p) {
1458                 pcpui->cur_proc = new_p;                                /* uncounted ref */
1459                 lcr3(new_p->env_cr3);
1460         }
1461         enable_irqsave(&irq_state);
1462         return old_proc;
1463 }
1464
1465 /* This switches back to old_proc from new_p.  Pair it with switch_to(), and
1466  * pass in its return value for old_proc. */
1467 void switch_back(struct proc *new_p, struct proc *old_proc)
1468 {
1469         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1470         int8_t irq_state = 0;
1471         if (old_proc != new_p) {
1472                 disable_irqsave(&irq_state);
1473                 pcpui->cur_proc = old_proc;
1474                 if (old_proc)
1475                         lcr3(old_proc->env_cr3);
1476                 else
1477                         lcr3(boot_cr3);
1478                 enable_irqsave(&irq_state);
1479         }
1480 }
1481
1482 /* Will send a TLB shootdown message to every vcore in the main address space
1483  * (aka, all vcores for now).  The message will take the start and end virtual
1484  * addresses as well, in case we want to be more clever about how much we
1485  * shootdown and batching our messages.  Should do the sanity about rounding up
1486  * and down in this function too.
1487  *
1488  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1489  * message to the calling core (interrupting it, possibly while holding the
1490  * proc_lock).  We don't need to process routine messages since it's an
1491  * immediate message. */
1492 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1493 {
1494         struct vcore *vc_i;
1495         /* TODO: we might be able to avoid locking here in the future (we must hit
1496          * all online, and we can check __mapped).  it'll be complicated. */
1497         spin_lock(&p->proc_lock);
1498         switch (p->state) {
1499                 case (PROC_RUNNING_S):
1500                         tlbflush();
1501                         break;
1502                 case (PROC_RUNNING_M):
1503                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1504                         TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1505                                 send_kernel_message(vc_i->pcoreid, __tlbshootdown, start, end,
1506                                                     0, KMSG_IMMEDIATE);
1507                         }
1508                         break;
1509                 case (PROC_DYING):
1510                         /* if it is dying, death messages are already on the way to all
1511                          * cores, including ours, which will clear the TLB. */
1512                         break;
1513                 default:
1514                         /* will probably get this when we have the short handlers */
1515                         warn("Unexpected case %s in %s", procstate2str(p->state),
1516                              __FUNCTION__);
1517         }
1518         spin_unlock(&p->proc_lock);
1519 }
1520
1521 /* Helper, used by __startcore and change_to_vcore, which sets up cur_tf to run
1522  * a given process's vcore.  Caller needs to set up things like owning_proc and
1523  * whatnot.  Note that we might not have p loaded as current. */
1524 static void __set_curtf_to_vcoreid(struct proc *p, uint32_t vcoreid)
1525 {
1526         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1527         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1528
1529         /* We could let userspace do this, though they come into vcore entry many
1530          * times, and we just need this to happen when the cores comes online the
1531          * first time.  That, and they want this turned on as soon as we know a
1532          * vcore *WILL* be online.  We could also do this earlier, when we map the
1533          * vcore to its pcore, though we don't always have current loaded or
1534          * otherwise mess with the VCPD in those code paths. */
1535         vcpd->can_rcv_msg = TRUE;
1536         /* Mark that this vcore as no longer preempted.  No danger of clobbering
1537          * other writes, since this would get turned on in __preempt (which can't be
1538          * concurrent with this function on this core), and the atomic is just
1539          * toggling the one bit (a concurrent VC_K_LOCK will work) */
1540         atomic_and(&vcpd->flags, ~VC_PREEMPTED);
1541         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1542                core_id(), p->pid, vcoreid);
1543         /* If notifs are disabled, the vcore was in vcore context and we need to
1544          * restart the preempt_tf.  o/w, we give them a fresh vcore (which is also
1545          * what happens the first time a vcore comes online).  No matter what,
1546          * they'll restart in vcore context.  It's just a matter of whether or not
1547          * it is the old, interrupted vcore context. */
1548         if (vcpd->notif_disabled) {
1549                 restore_fp_state(&vcpd->preempt_anc);
1550                 /* copy-in the tf we'll pop, then set all security-related fields */
1551                 pcpui->actual_tf = vcpd->preempt_tf;
1552                 proc_secure_trapframe(&pcpui->actual_tf);
1553         } else { /* not restarting from a preemption, use a fresh vcore */
1554                 assert(vcpd->transition_stack);
1555                 /* TODO: consider 0'ing the FP state.  We're probably leaking. */
1556                 proc_init_trapframe(&pcpui->actual_tf, vcoreid, p->env_entry,
1557                                     vcpd->transition_stack);
1558                 /* Disable/mask active notifications for fresh vcores */
1559                 vcpd->notif_disabled = TRUE;
1560         }
1561         /* cur_tf was built above (in actual_tf), now use it */
1562         pcpui->cur_tf = &pcpui->actual_tf;
1563         /* this cur_tf will get run when the kernel returns / idles */
1564 }
1565
1566 /* Changes calling vcore to be vcoreid.  enable_my_notif tells us about how the
1567  * state calling vcore wants to be left in.  It will look like caller_vcoreid
1568  * was preempted.  Note we don't care about notif_pending.  */
1569 void proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
1570                           bool enable_my_notif)
1571 {
1572         uint32_t caller_vcoreid, pcoreid = core_id();
1573         struct preempt_data *caller_vcpd;
1574         struct vcore *caller_vc, *new_vc;
1575         struct event_msg preempt_msg = {0};
1576         int8_t state = 0;
1577         /* Need to disable before even reading caller_vcoreid, since we could be
1578          * unmapped by a __preempt or __death, like in yield. */
1579         disable_irqsave(&state);
1580         /* Need to lock before reading the vcoremap, like in yield */
1581         spin_lock(&p->proc_lock);
1582         /* new_vcoreid is already runing, abort */
1583         if (vcore_is_mapped(p, new_vcoreid))
1584                 goto out_failed;
1585         /* Need to make sure our vcore is allowed to switch.  We might have a
1586          * __preempt, __death, etc, coming in.  Similar to yield. */
1587         switch (p->state) {
1588                 case (PROC_RUNNING_M):
1589                         break;                          /* the only case we can proceed */
1590                 case (PROC_RUNNING_S):  /* user bug, just return */
1591                 case (PROC_DYING):              /* incoming __death */
1592                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1593                         goto out_failed;
1594                 default:
1595                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1596                               __FUNCTION__);
1597         }
1598         /* Make sure we're still mapped in the proc. */
1599         if (!is_mapped_vcore(p, pcoreid))
1600                 goto out_failed;
1601         /* Get all our info */
1602         caller_vcoreid = get_vcoreid(p, pcoreid);
1603         caller_vcpd = &p->procdata->vcore_preempt_data[caller_vcoreid];
1604         caller_vc = vcoreid2vcore(p, caller_vcoreid);
1605         /* Should only call from vcore context */
1606         if (!caller_vcpd->notif_disabled) {
1607                 printk("[kernel] You tried to change vcores from uthread ctx\n");
1608                 goto out_failed;
1609         }
1610         /* Return and take the preempt message when we enable_irqs. */
1611         if (caller_vc->preempt_served)
1612                 goto out_failed;
1613         /* Ok, we're clear to do the switch.  Lets figure out who the new one is */
1614         new_vc = vcoreid2vcore(p, new_vcoreid);
1615         printd("[kernel] changing vcore %d to vcore %d\n", caller_vcoreid,
1616                new_vcoreid);
1617         /* enable_my_notif signals how we'll be restarted */
1618         if (enable_my_notif) {
1619                 /* if they set this flag, then the vcore can just restart from scratch,
1620                  * and we don't care about either the notif_tf or the preempt_tf. */
1621                 caller_vcpd->notif_disabled = FALSE;
1622         } else {
1623                 /* need to set up the calling vcore's tf so that it'll get restarted by
1624                  * __startcore, to make the caller look like it was preempted. */
1625                 caller_vcpd->preempt_tf = *current_tf;
1626                 save_fp_state(&caller_vcpd->preempt_anc);
1627                 /* Mark our core as preempted (for userspace recovery). */
1628                 atomic_or(&caller_vcpd->flags, VC_PREEMPTED);
1629         }
1630         /* Either way, unmap and offline our current vcore */
1631         /* Move the caller from online to inactive */
1632         TAILQ_REMOVE(&p->online_vcs, caller_vc, list);
1633         /* We don't bother with the notif_pending race.  note that notif_pending
1634          * could still be set.  this was a preempted vcore, and userspace will need
1635          * to deal with missed messages (preempt_recover() will handle that) */
1636         TAILQ_INSERT_HEAD(&p->inactive_vcs, caller_vc, list);
1637         /* Move the new one from inactive to online */
1638         TAILQ_REMOVE(&p->inactive_vcs, new_vc, list);
1639         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1640         /* Change the vcore map (TODO: might get rid of this seqctr) */
1641         __seq_start_write(&p->procinfo->coremap_seqctr);
1642         __unmap_vcore(p, caller_vcoreid);
1643         __map_vcore(p, new_vcoreid, pcoreid);
1644         __seq_end_write(&p->procinfo->coremap_seqctr);
1645         /* Send either a PREEMPT msg or a CHECK_MSGS msg.  If they said to
1646          * enable_my_notif, then all userspace needs is to check messages, not a
1647          * full preemption recovery. */
1648         preempt_msg.ev_type = (enable_my_notif ? EV_CHECK_MSGS : EV_VCORE_PREEMPT);
1649         preempt_msg.ev_arg2 = caller_vcoreid;   /* arg2 is 32 bits */
1650         send_kernel_event(p, &preempt_msg, new_vcoreid);
1651         /* Change cur_tf so we'll be the new vcoreid */
1652         __set_curtf_to_vcoreid(p, new_vcoreid);
1653         /* Fall through to exit (we didn't fail) */
1654 out_failed:
1655         spin_unlock(&p->proc_lock);
1656         enable_irqsave(&state);
1657 }
1658
1659 /* Kernel message handler to start a process's context on this core, when the
1660  * core next considers running a process.  Tightly coupled with proc_run().
1661  * Interrupts are disabled. */
1662 void __startcore(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1663 {
1664         uint32_t vcoreid, coreid = core_id();
1665         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1666         struct proc *p_to_run = (struct proc *CT(1))a0;
1667
1668         assert(p_to_run);
1669         /* Can not be any TF from a process here already */
1670         assert(!pcpui->owning_proc);
1671         /* the sender of the amsg increfed already for this saved ref to p_to_run */
1672         pcpui->owning_proc = p_to_run;
1673         /* sender increfed again, assuming we'd install to cur_proc.  only do this
1674          * if no one else is there.  this is an optimization, since we expect to
1675          * send these __startcores to idles cores, and this saves a scramble to
1676          * incref when all of the cores restartcore/startcore later.  Keep in sync
1677          * with __proc_give_cores() and proc_run(). */
1678         if (!pcpui->cur_proc) {
1679                 pcpui->cur_proc = p_to_run;     /* install the ref to cur_proc */
1680                 lcr3(p_to_run->env_cr3);        /* load the page tables to match cur_proc */
1681         } else {
1682                 proc_decref(p_to_run);          /* can't install, decref the extra one */
1683         }
1684         /* Note we are not necessarily in the cr3 of p_to_run */
1685         vcoreid = get_vcoreid(p_to_run, coreid);
1686         /* Now that we sorted refcnts and know p / which vcore it should be, set up
1687          * pcpui->cur_tf so that it will run that particular vcore */
1688         __set_curtf_to_vcoreid(p_to_run, vcoreid);
1689 }
1690
1691 /* Bail out if it's the wrong process, or if they no longer want a notif.  Don't
1692  * use the TF we passed in, we care about cur_tf.  Try not to grab locks or
1693  * write access to anything that isn't per-core in here. */
1694 void __notify(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1695 {
1696         uint32_t vcoreid, coreid = core_id();
1697         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1698         struct preempt_data *vcpd;
1699         struct proc *p = (struct proc*)a0;
1700
1701         /* Not the right proc */
1702         if (p != pcpui->owning_proc)
1703                 return;
1704         /* Common cur_tf sanity checks */
1705         assert(pcpui->cur_tf);
1706         assert(pcpui->cur_tf == &pcpui->actual_tf);
1707         assert(!in_kernel(pcpui->cur_tf));
1708         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1709          * mapping would only happen if the vcore was free, which it isn't until
1710          * after we unmap. */
1711         vcoreid = get_vcoreid(p, coreid);
1712         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1713         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1714                p->procinfo->pid, vcoreid, coreid);
1715         /* sort signals.  notifs are now masked, like an interrupt gate */
1716         if (vcpd->notif_disabled)
1717                 return;
1718         vcpd->notif_disabled = TRUE;
1719         /* This bit shouldn't be important anymore */
1720         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1721         /* save the old tf in the notify slot, build and pop a new one.  Note that
1722          * silly state isn't our business for a notification. */
1723         vcpd->notif_tf = *pcpui->cur_tf;
1724         memset(pcpui->cur_tf, 0, sizeof(struct trapframe));
1725         proc_init_trapframe(pcpui->cur_tf, vcoreid, p->env_entry,
1726                             vcpd->transition_stack);
1727         /* this cur_tf will get run when the kernel returns / idles */
1728 }
1729
1730 void __preempt(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1731 {
1732         uint32_t vcoreid, coreid = core_id();
1733         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1734         struct preempt_data *vcpd;
1735         struct proc *p = (struct proc*)a0;
1736
1737         assert(p);
1738         if (p != pcpui->owning_proc) {
1739                 panic("__preempt arrived for a process (%p) that was not owning (%p)!",
1740                       p, pcpui->owning_proc);
1741         }
1742         /* Common cur_tf sanity checks */
1743         assert(pcpui->cur_tf);
1744         assert(pcpui->cur_tf == &pcpui->actual_tf);
1745         assert(!in_kernel(pcpui->cur_tf));
1746         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1747          * mapping would only happen if the vcore was free, which it isn't until
1748          * after we unmap. */
1749         vcoreid = get_vcoreid(p, coreid);
1750         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1751         /* either __preempt or proc_yield() ends the preempt phase. */
1752         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1753         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1754         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1755                p->procinfo->pid, vcoreid, coreid);
1756         /* if notifs are disabled, the vcore is in vcore context (as far as we're
1757          * concerned), and we save it in the preempt slot. o/w, we save the
1758          * process's cur_tf in the notif slot, and it'll appear to the vcore when it
1759          * comes back up that it just took a notification. */
1760         if (vcpd->notif_disabled)
1761                 vcpd->preempt_tf = *pcpui->cur_tf;
1762         else
1763                 vcpd->notif_tf = *pcpui->cur_tf;
1764         /* either way, we save the silly state (FP) */
1765         save_fp_state(&vcpd->preempt_anc);
1766         /* Mark the vcore as preempted and unlock (was locked by the sender). */
1767         atomic_or(&vcpd->flags, VC_PREEMPTED);
1768         atomic_and(&vcpd->flags, ~VC_K_LOCK);
1769         wmb();  /* make sure everything else hits before we unmap */
1770         __unmap_vcore(p, vcoreid);
1771         /* We won't restart the process later.  current gets cleared later when we
1772          * notice there is no owning_proc and we have nothing to do (smp_idle,
1773          * restartcore, etc) */
1774         clear_owning_proc(coreid);
1775 }
1776
1777 /* Kernel message handler to clean up the core when a process is dying.
1778  * Note this leaves no trace of what was running.
1779  * It's okay if death comes to a core that's already idling and has no current.
1780  * It could happen if a process decref'd before __proc_startcore could incref. */
1781 void __death(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1782 {
1783         uint32_t vcoreid, coreid = core_id();
1784         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1785         struct proc *p = pcpui->owning_proc;
1786         if (p) {
1787                 vcoreid = get_vcoreid(p, coreid);
1788                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1789                        coreid, p->pid, vcoreid);
1790                 __unmap_vcore(p, vcoreid);
1791                 /* We won't restart the process later.  current gets cleared later when
1792                  * we notice there is no owning_proc and we have nothing to do
1793                  * (smp_idle, restartcore, etc) */
1794                 clear_owning_proc(coreid);
1795         }
1796 }
1797
1798 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1799  * addresses from a0 to a1. */
1800 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, long a0, long a1,
1801                     long a2)
1802 {
1803         /* TODO: (TLB) something more intelligent with the range */
1804         tlbflush();
1805 }
1806
1807 void print_allpids(void)
1808 {
1809         void print_proc_state(void *item)
1810         {
1811                 struct proc *p = (struct proc*)item;
1812                 assert(p);
1813                 printk("%8d %s\n", p->pid, procstate2str(p->state));
1814         }
1815         printk("PID      STATE    \n");
1816         printk("------------------\n");
1817         spin_lock(&pid_hash_lock);
1818         hash_for_each(pid_hash, print_proc_state);
1819         spin_unlock(&pid_hash_lock);
1820 }
1821
1822 void print_proc_info(pid_t pid)
1823 {
1824         int j = 0;
1825         struct proc *p = pid2proc(pid);
1826         struct vcore *vc_i;
1827         if (!p) {
1828                 printk("Bad PID.\n");
1829                 return;
1830         }
1831         spinlock_debug(&p->proc_lock);
1832         //spin_lock(&p->proc_lock); // No locking!!
1833         printk("struct proc: %p\n", p);
1834         printk("PID: %d\n", p->pid);
1835         printk("PPID: %d\n", p->ppid);
1836         printk("State: %s (%p)\n", procstate2str(p->state), p->state);
1837         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
1838         printk("Flags: 0x%08x\n", p->env_flags);
1839         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1840         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1841         printk("Vcore Lists (may be in flux w/o locking):\n----------------------\n");
1842         printk("Online:\n");
1843         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1844                 printk("\tVcore %d -> Pcore %d\n", vcore2vcoreid(p, vc_i), vc_i->pcoreid);
1845         printk("Bulk Preempted:\n");
1846         TAILQ_FOREACH(vc_i, &p->bulk_preempted_vcs, list)
1847                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1848         printk("Inactive / Yielded:\n");
1849         TAILQ_FOREACH(vc_i, &p->inactive_vcs, list)
1850                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1851         printk("Resources:\n------------------------\n");
1852         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1853                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1854                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1855         printk("Open Files:\n");
1856         struct files_struct *files = &p->open_files;
1857         spin_lock(&files->lock);
1858         for (int i = 0; i < files->max_files; i++)
1859                 if (files->fd_array[i].fd_file) {
1860                         printk("\tFD: %02d, File: %08p, File name: %s\n", i,
1861                                files->fd_array[i].fd_file,
1862                                file_name(files->fd_array[i].fd_file));
1863                 }
1864         spin_unlock(&files->lock);
1865         /* No one cares, and it clutters the terminal */
1866         //printk("Vcore 0's Last Trapframe:\n");
1867         //print_trapframe(&p->env_tf);
1868         /* no locking / unlocking or refcnting */
1869         // spin_unlock(&p->proc_lock);
1870         proc_decref(p);
1871 }
1872
1873 /* Debugging function, checks what (process, vcore) is supposed to run on this
1874  * pcore.  Meant to be called from smp_idle() before halting. */
1875 void check_my_owner(void)
1876 {
1877         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1878         void shazbot(void *item)
1879         {
1880                 struct proc *p = (struct proc*)item;
1881                 struct vcore *vc_i;
1882                 assert(p);
1883                 spin_lock(&p->proc_lock);
1884                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1885                         /* this isn't true, a __startcore could be on the way and we're
1886                          * already "online" */
1887                         if (vc_i->pcoreid == core_id()) {
1888                                 /* Immediate message was sent, we should get it when we enable
1889                                  * interrupts, which should cause us to skip cpu_halt() */
1890                                 if (!STAILQ_EMPTY(&pcpui->immed_amsgs))
1891                                         continue;
1892                                 printk("Owned pcore (%d) has no owner, by %08p, vc %d!\n",
1893                                        core_id(), p, vcore2vcoreid(p, vc_i));
1894                                 spin_unlock(&p->proc_lock);
1895                                 spin_unlock(&pid_hash_lock);
1896                                 monitor(0);
1897                         }
1898                 }
1899                 spin_unlock(&p->proc_lock);
1900         }
1901         assert(!irq_is_enabled());
1902         extern int booting;
1903         if (!booting && !pcpui->owning_proc) {
1904                 spin_lock(&pid_hash_lock);
1905                 hash_for_each(pid_hash, shazbot);
1906                 spin_unlock(&pid_hash_lock);
1907         }
1908 }