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