3abf01eb1a25a596bb63f385f53702f549ba9090
[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         int8_t state = 0;
425         uint32_t coreid = core_id();
426         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
427         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
428         spin_lock(&p->proc_lock);
429         switch (p->state) {
430                 case (PROC_DYING):
431                         spin_unlock(&p->proc_lock);
432                         printk("[kernel] _S %d not starting due to async death\n", p->pid);
433                         return;
434                 case (PROC_RUNNABLE_S):
435                         __proc_set_state(p, PROC_RUNNING_S);
436                         /* We will want to know where this process is running, even if it is
437                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
438                          * Also, this is the signal used in trap.c to know to save the tf in
439                          * env_tf. */
440                         __seq_start_write(&p->procinfo->coremap_seqctr);
441                         p->procinfo->num_vcores = 0;    /* TODO (VC#) */
442                         /* TODO: For now, we won't count this as an active vcore (on the
443                          * lists).  This gets unmapped in resource.c and yield_s, and needs
444                          * work. */
445                         __map_vcore(p, 0, coreid); /* not treated like a true vcore */
446                         __seq_end_write(&p->procinfo->coremap_seqctr);
447                         /* incref, since we're saving a reference in owning proc later */
448                         proc_incref(p, 1);
449                         /* disable interrupts to protect cur_tf, owning_proc, and current */
450                         disable_irqsave(&state);
451                         /* wait til ints are disabled before unlocking, in case someone else
452                          * grabs the lock and IPIs us before we get set up in cur_tf */
453                         spin_unlock(&p->proc_lock);
454                         /* redundant with proc_startcore, might be able to remove that one*/
455                         __set_proc_current(p);
456                         /* set us up as owning_proc.  ksched bug if there is already one,
457                          * for now.  can simply clear_owning if we want to. */
458                         assert(!pcpui->owning_proc);
459                         pcpui->owning_proc = p;
460                         /* TODO: (HSS) set silly state here (__startcore does it instantly) */
461                         /* similar to the old __startcore, start them in vcore context if
462                          * they have notifs and aren't already in vcore context. */
463                         if (!vcpd->notif_disabled && vcpd->notif_pending) {
464                                 vcpd->notif_disabled = TRUE;
465                                 /* save the _S's tf in the notify slot, build and pop a new one
466                                  * in actual/cur_tf. */
467                                 vcpd->notif_tf = p->env_tf;
468                                 pcpui->cur_tf = &pcpui->actual_tf;
469                                 memset(pcpui->cur_tf, 0, sizeof(struct trapframe));
470                                 proc_init_trapframe(pcpui->cur_tf, 0, p->env_entry,
471                                                     vcpd->transition_stack);
472                         } else {
473                                 /* this is one of the few times cur_tf != &actual_tf */
474                                 pcpui->cur_tf = &p->env_tf;
475                         }
476                         enable_irqsave(&state);
477                         /* When the calling core idles, it'll call restartcore and run the
478                          * _S process's context. */
479                         return;
480                 default:
481                         spin_unlock(&p->proc_lock);
482                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
483         }
484 }
485
486 /* Helper: sends preempt messages to all vcores on the bulk preempt list, and
487  * moves them to the inactive list. */
488 static void __send_bulkp_events(struct proc *p)
489 {
490         struct vcore *vc_i, *vc_temp;
491         struct event_msg preempt_msg = {0};
492         /* Send preempt messages for any left on the BP list.  No need to set any
493          * flags, it all was done on the real preempt.  Now we're just telling the
494          * process about any that didn't get restarted and are still preempted. */
495         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
496                 /* Note that if there are no active vcores, send_k_e will post to our
497                  * own vcore, the last of which will be put on the inactive list and be
498                  * the first to be started.  We could have issues with deadlocking,
499                  * since send_k_e() could grab the proclock (if there are no active
500                  * vcores) */
501                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
502                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i);   /* arg2 is 32 bits */
503                 send_kernel_event(p, &preempt_msg, 0);
504                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that.
505                  * We need a loop for the messages, but not necessarily for the list
506                  * changes.  */
507                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
508                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
509         }
510 }
511
512 /* Run an _M.  Can be called safely on one that is already running.  Hold the
513  * lock before calling.  Other than state checks, this just starts up the _M's
514  * vcores, much like the second part of give_cores_running.  More specifically,
515  * give_cores_runnable puts cores on the online list, which this then sends
516  * messages to.  give_cores_running immediately puts them on the list and sends
517  * the message.  the two-step style may go out of fashion soon.
518  *
519  * This expects that the "instructions" for which core(s) to run this on will be
520  * in the vcoremap, which needs to be set externally (give_cores()). */
521 void __proc_run_m(struct proc *p)
522 {
523         struct vcore *vc_i;
524         switch (p->state) {
525                 case (PROC_WAITING):
526                 case (PROC_DYING):
527                         warn("ksched tried to run proc %d in state %s\n", p->pid,
528                              procstate2str(p->state));
529                         return;
530                 case (PROC_RUNNABLE_M):
531                         /* vcoremap[i] holds the coreid of the physical core allocated to
532                          * this process.  It is set outside proc_run.  For the kernel
533                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
534                         if (p->procinfo->num_vcores) {
535                                 __send_bulkp_events(p);
536                                 __proc_set_state(p, PROC_RUNNING_M);
537                                 /* Up the refcnt, to avoid the n refcnt upping on the
538                                  * destination cores.  Keep in sync with __startcore */
539                                 proc_incref(p, p->procinfo->num_vcores * 2);
540                                 /* Send kernel messages to all online vcores (which were added
541                                  * to the list and mapped in __proc_give_cores()), making them
542                                  * turn online */
543                                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
544                                         send_kernel_message(vc_i->pcoreid, __startcore, (long)p,
545                                                             0, 0, KMSG_IMMEDIATE);
546                                 }
547                         } else {
548                                 warn("Tried to proc_run() an _M with no vcores!");
549                         }
550                         /* There a subtle race avoidance here (when we unlock after sending
551                          * the message).  __proc_startcore can handle a death message, but
552                          * we can't have the startcore come after the death message.
553                          * Otherwise, it would look like a new process.  So we hold the lock
554                          * til after we send our message, which prevents a possible death
555                          * message.
556                          * - Note there is no guarantee this core's interrupts were on, so
557                          *   it may not get the message for a while... */
558                         return;
559                 case (PROC_RUNNING_M):
560                         return;
561                 default:
562                         /* unlock just so the monitor can call something that might lock*/
563                         spin_unlock(&p->proc_lock);
564                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
565         }
566 }
567
568 /* Actually runs the given context (trapframe) of process p on the core this
569  * code executes on.  This is called directly by __startcore, which needs to
570  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
571  *
572  * A note on refcnting: this function will not return, and your proc reference
573  * will end up stored in current.  This will make no changes to p's refcnt, so
574  * do your accounting such that there is only the +1 for current.  This means if
575  * it is already in current (like in the trap return path), don't up it.  If
576  * it's already in current and you have another reference (like pid2proc or from
577  * an IPI), then down it (which is what happens in __startcore()).  If it's not
578  * in current and you have one reference, like proc_run(non_current_p), then
579  * also do nothing.  The refcnt for your *p will count for the reference stored
580  * in current. */
581 static void __proc_startcore(struct proc *p, trapframe_t *tf)
582 {
583         assert(!irq_is_enabled());
584         __set_proc_current(p);
585         /* need to load our silly state, preferably somewhere other than here so we
586          * can avoid the case where the context was just running here.  it's not
587          * sufficient to do it in the "new process" if-block above (could be things
588          * like page faults that cause us to keep the same process, but want a
589          * different context.
590          * for now, we load this silly state here. (TODO) (HSS)
591          * We also need this to be per trapframe, and not per process...
592          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
593          * __startcore.  */
594         if (p->state == PROC_RUNNING_S)
595                 env_pop_ancillary_state(p);
596         /* Clear the current_tf, since it is no longer used */
597         current_tf = 0; /* TODO: might not need this... */
598         env_pop_tf(tf);
599 }
600
601 /* Restarts/runs the current_tf, which must be for the current process, on the
602  * core this code executes on.  Calls an internal function to do the work.
603  *
604  * In case there are pending routine messages, like __death, __preempt, or
605  * __notify, we need to run them.  Alternatively, if there are any, we could
606  * self_ipi, and run the messages immediately after popping back to userspace,
607  * but that would have crappy overhead.
608  *
609  * Refcnting: this will not return, and it assumes that you've accounted for
610  * your reference as if it was the ref for "current" (which is what happens when
611  * returning from local traps and such. */
612 void proc_restartcore(void)
613 {
614         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
615         assert(!pcpui->cur_sysc);
616         /* Try and get any interrupts before we pop back to userspace.  If we didn't
617          * do this, we'd just get them in userspace, but this might save us some
618          * effort/overhead. */
619         enable_irq();
620         /* Need ints disabled when we return from processing (race on missing
621          * messages/IPIs) */
622         disable_irq();
623         process_routine_kmsg(pcpui->cur_tf);
624         /* If there is no owning process, just idle, since we don't know what to do.
625          * This could be because the process had been restarted a long time ago and
626          * has since left the core, or due to a KMSG like __preempt or __death. */
627         if (!pcpui->owning_proc) {
628                 abandon_core();
629                 smp_idle();
630         }
631         assert(pcpui->cur_tf);
632         __proc_startcore(pcpui->owning_proc, pcpui->cur_tf);
633 }
634
635 /*
636  * Destroys the given process.  This may be called from another process, a light
637  * kernel thread (no real process context), asynchronously/cross-core, or from
638  * the process on its own core.
639  *
640  * Here's the way process death works:
641  * 0. grab the lock (protects state transition and core map)
642  * 1. set state to dying.  that keeps the kernel from doing anything for the
643  * process (like proc_running it).
644  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
645  * 3. IPI to clean up those cores (decref, etc).
646  * 4. Unlock
647  * 5. Clean up your core, if applicable
648  * (Last core/kernel thread to decref cleans up and deallocates resources.)
649  *
650  * Note that some cores can be processing async calls, but will eventually
651  * decref.  Should think about this more, like some sort of callback/revocation.
652  *
653  * This function will now always return (it used to not return if the calling
654  * core was dying).  However, when it returns, a kernel message will eventually
655  * come in, making you abandon_core, as if you weren't running.  It may be that
656  * the only reference to p is the one you passed in, and when you decref, it'll
657  * get __proc_free()d. */
658 void proc_destroy(struct proc *p)
659 {
660         uint32_t num_revoked = 0;
661         spin_lock(&p->proc_lock);
662         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
663         uint32_t pc_arr[p->procinfo->num_vcores];
664         switch (p->state) {
665                 case PROC_DYING: // someone else killed this already.
666                         spin_unlock(&p->proc_lock);
667                         return;
668                 case PROC_RUNNABLE_M:
669                         /* Need to reclaim any cores this proc might have, even though it's
670                          * not running yet. */
671                         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
672                         // fallthrough
673                 case PROC_RUNNABLE_S:
674                         /* might need to pull from lists, though i'm currently a fan of the
675                          * model where external refs notice DYING (if it matters to them)
676                          * and decref when they are done.  the ksched will notice the proc
677                          * is dying and handle it accordingly (which delay the reaping til
678                          * the next call to schedule()) */
679                         break;
680                 case PROC_RUNNING_S:
681                         #if 0
682                         // here's how to do it manually
683                         if (current == p) {
684                                 lcr3(boot_cr3);
685                                 proc_decref(p);         /* this decref is for the cr3 */
686                                 current = NULL;
687                         }
688                         #endif
689                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
690                                             KMSG_IMMEDIATE);
691                         __seq_start_write(&p->procinfo->coremap_seqctr);
692                         // TODO: might need to sort num_vcores too later (VC#)
693                         /* vcore is unmapped on the receive side */
694                         __seq_end_write(&p->procinfo->coremap_seqctr);
695                         /* If we ever have RUNNING_S run on non-mgmt cores, we'll need to
696                          * tell the ksched about this now-idle core (after unlocking) */
697                         break;
698                 case PROC_RUNNING_M:
699                         /* Send the DEATH message to every core running this process, and
700                          * deallocate the cores.
701                          * The rule is that the vcoremap is set before proc_run, and reset
702                          * within proc_destroy */
703                         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
704                         break;
705                 case PROC_CREATED:
706                         break;
707                 default:
708                         panic("Weird state(%s) in %s()", procstate2str(p->state),
709                               __FUNCTION__);
710         }
711         __proc_set_state(p, PROC_DYING);
712         /* This prevents processes from accessing their old files while dying, and
713          * will help if these files (or similar objects in the future) hold
714          * references to p (preventing a __proc_free()). */
715         close_all_files(&p->open_files, FALSE);
716         /* This decref is for the process's existence. */
717         proc_decref(p);
718         /* Unlock.  A death IPI should be on its way, either from the RUNNING_S one,
719          * or from proc_take_cores with a __death.  in general, interrupts should be
720          * on when you call proc_destroy locally, but currently aren't for all
721          * things (like traphandlers). */
722         spin_unlock(&p->proc_lock);
723         /* Return the cores to the ksched */
724         if (num_revoked)
725                 put_idle_cores(pc_arr, num_revoked);
726         return;
727 }
728
729 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
730  * process.  Currently, this ignores whether or not you are an _M already.  You
731  * should hold the lock before calling. */
732 void __proc_change_to_m(struct proc *p)
733 {
734         int8_t state = 0;
735         switch (p->state) {
736                 case (PROC_RUNNING_S):
737                         /* issue with if we're async or not (need to preempt it)
738                          * either of these should trip it. TODO: (ACR) async core req
739                          * TODO: relies on vcore0 being the caller (VC#) */
740                         if ((current != p) || (get_pcoreid(p, 0) != core_id()))
741                                 panic("We don't handle async RUNNING_S core requests yet.");
742                         /* save the tf so userspace can restart it.  Like in __notify,
743                          * this assumes a user tf is the same as a kernel tf.  We save
744                          * it in the preempt slot so that we can also save the silly
745                          * state. */
746                         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
747                         disable_irqsave(&state);        /* protect cur_tf */
748                         /* Note this won't play well with concurrent proc kmsgs, but
749                          * since we're _S and locked, we shouldn't have any. */
750                         assert(current_tf);
751                         /* Copy uthread0's context to the notif slot */
752                         vcpd->notif_tf = *current_tf;
753                         clear_owning_proc(core_id());   /* so we don't restart */
754                         save_fp_state(&vcpd->preempt_anc);
755                         enable_irqsave(&state);
756                         /* Userspace needs to not fuck with notif_disabled before
757                          * transitioning to _M. */
758                         if (vcpd->notif_disabled) {
759                                 printk("[kernel] user bug: notifs disabled for vcore 0\n");
760                                 vcpd->notif_disabled = FALSE;
761                         }
762                         /* in the async case, we'll need to remotely stop and bundle
763                          * vcore0's TF.  this is already done for the sync case (local
764                          * syscall). */
765                         /* this process no longer runs on its old location (which is
766                          * this core, for now, since we don't handle async calls) */
767                         __seq_start_write(&p->procinfo->coremap_seqctr);
768                         // TODO: (VC#) might need to adjust num_vcores
769                         // TODO: (ACR) will need to unmap remotely (receive-side)
770                         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
771                         __seq_end_write(&p->procinfo->coremap_seqctr);
772                         /* change to runnable_m (it's TF is already saved) */
773                         __proc_set_state(p, PROC_RUNNABLE_M);
774                         p->procinfo->is_mcp = TRUE;
775                         break;
776                 case (PROC_RUNNABLE_S):
777                         /* Issues: being on the runnable_list, proc_set_state not liking
778                          * it, and not clearly thinking through how this would happen.
779                          * Perhaps an async call that gets serviced after you're
780                          * descheduled? */
781                         panic("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
782                         break;
783                 case (PROC_DYING):
784                         warn("Dying, core request coming from %d\n", core_id());
785                 default:
786                         break;
787         }
788 }
789
790 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
791  * becoming the new 'thread0'.  Don't use this.  Caller needs to send in a
792  * pc_arr big enough for all vcores.  Will return the number of cores given up
793  * by the proc. */
794 uint32_t __proc_change_to_s(struct proc *p, uint32_t *pc_arr)
795 {
796         int8_t state = 0;
797         uint32_t num_revoked;
798         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
799         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
800         /* save the context, to be restarted in _S mode */
801         disable_irqsave(&state);        /* protect cur_tf */
802         assert(current_tf);
803         p->env_tf = *current_tf;
804         clear_owning_proc(core_id());   /* so we don't restart */
805         enable_irqsave(&state);
806         env_push_ancillary_state(p); // TODO: (HSS)
807         /* sending death, since it's not our job to save contexts or anything in
808          * this case. */
809         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
810         __proc_set_state(p, PROC_RUNNABLE_S);
811         return num_revoked;
812 }
813
814 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
815  * careful. */
816 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
817 {
818         return p->procinfo->pcoremap[pcoreid].valid;
819 }
820
821 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
822  * No locking involved, be careful.  Panics on failure. */
823 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
824 {
825         assert(is_mapped_vcore(p, pcoreid));
826         return p->procinfo->pcoremap[pcoreid].vcoreid;
827 }
828
829 /* Helper function.  Try to find the pcoreid for a given virtual core id for
830  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
831  * stale or otherwise 'wrong' answer. */
832 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
833 {
834         return p->procinfo->vcoremap[vcoreid].pcoreid;
835 }
836
837 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
838  * No locking involved, be careful.  Panics on failure. */
839 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
840 {
841         assert(vcore_is_mapped(p, vcoreid));
842         return try_get_pcoreid(p, vcoreid);
843 }
844
845 /* Helper function: yields / wraps up current_tf and schedules the _S */
846 void __proc_yield_s(struct proc *p, struct trapframe *tf)
847 {
848         assert(p->state == PROC_RUNNING_S);
849         p->env_tf= *tf;
850         env_push_ancillary_state(p);                    /* TODO: (HSS) */
851         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
852         __proc_set_state(p, PROC_RUNNABLE_S);
853         schedule_scp(p);
854 }
855
856 /* Yields the calling core.  Must be called locally (not async) for now.
857  * - If RUNNING_S, you just give up your time slice and will eventually return.
858  * - If RUNNING_M, you give up the current vcore (which never returns), and
859  *   adjust the amount of cores wanted/granted.
860  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
861  *   you'll have one guaranteed core, starting from the entry point.
862  *
863  * If the call is being nice, it means that it is in response to a preemption
864  * (which needs to be checked).  If there is no preemption pending, just return.
865  * No matter what, don't adjust the number of cores wanted.
866  *
867  * This usually does not return (smp_idle()), so it will eat your reference.
868  * Also note that it needs a non-current/edible reference, since it will abandon
869  * and continue to use the *p (current == 0, no cr3, etc).
870  *
871  * We disable interrupts for most of it too, since we need to protect current_tf
872  * and not race with __notify (which doesn't play well with concurrent
873  * yielders). */
874 void proc_yield(struct proc *SAFE p, bool being_nice)
875 {
876         uint32_t vcoreid, pcoreid = core_id();
877         struct vcore *vc;
878         struct preempt_data *vcpd;
879         int8_t state = 0;
880         /* Need to disable before even reading vcoreid, since we could be unmapped
881          * by a __preempt or __death.  _S also needs ints disabled, so we'll just do
882          * it immediately. */
883         disable_irqsave(&state);
884         /* Need to lock before checking the vcoremap to find out who we are, in case
885          * we're getting __preempted and __startcored, from a remote core (in which
886          * case we might have come in thinking we were vcore X, but had X preempted
887          * and Y restarted on this pcore, and we suddenly are the wrong vcore
888          * yielding).  Arguably, this is incredibly rare, since you'd need to
889          * preempt the core, then decide to give it back with another grant in
890          * between. */
891         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
892         switch (p->state) {
893                 case (PROC_RUNNING_S):
894                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
895                         spin_unlock(&p->proc_lock);
896                         goto out_yield_core;
897                 case (PROC_RUNNING_M):
898                         break;                          /* will handle this stuff below */
899                 case (PROC_DYING):              /* incoming __death */
900                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
901                         goto out_failed;
902                 default:
903                         panic("Weird state(%s) in %s()", procstate2str(p->state),
904                               __FUNCTION__);
905         }
906         /* If we're already unmapped (__preempt or a __death hit us), bail out.
907          * Note that if a __death hit us, we should have bailed when we saw
908          * PROC_DYING. */
909         if (!is_mapped_vcore(p, pcoreid))
910                 goto out_failed;
911         vcoreid = get_vcoreid(p, pcoreid);
912         vc = vcoreid2vcore(p, vcoreid);
913         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
914         /* no reason to be nice, return */
915         if (being_nice && !vc->preempt_pending)
916                 goto out_failed;
917         /* Fate is sealed, return and take the preempt message when we enable_irqs.
918          * Note this keeps us from mucking with our lists, since we were already
919          * removed from the online_list.  We have a similar concern with __death,
920          * but we check for DYING to handle that. */
921         if (vc->preempt_served)
922                 goto out_failed;
923         /* At this point, AFAIK there should be no preempt/death messages on the
924          * way, and we're on the online list.  So we'll go ahead and do the yielding
925          * business. */
926         /* no need to preempt later, since we are yielding (nice or otherwise) */
927         if (vc->preempt_pending)
928                 vc->preempt_pending = 0;
929         /* Don't let them yield if they are missing a notification.  Userspace must
930          * not leave vcore context without dealing with notif_pending.  pop_ros_tf()
931          * handles leaving via uthread context.  This handles leaving via a yield.
932          *
933          * This early check is an optimization.  The real check is below when it
934          * works with the online_vcs list (syncing with event.c and INDIR/IPI
935          * posting). */
936         if (vcpd->notif_pending)
937                 goto out_failed;
938         /* Optional: check to see if we are putting them below amt_wanted (help with
939          * correctness-benign user races) and bail */
940         if (p->procdata->res_req[RES_CORES].amt_wanted >= p->procinfo->num_vcores)
941                 goto out_failed;
942         /* Now we'll actually try to yield */
943         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
944                get_vcoreid(p, coreid));
945         /* Remove from the online list, add to the yielded list, and unmap
946          * the vcore, which gives up the core. */
947         TAILQ_REMOVE(&p->online_vcs, vc, list);
948         /* Now that we're off the online list, check to see if an alert made
949          * it through (event.c sets this) */
950         wrmb(); /* prev write must hit before reading notif_pending */
951         /* Note we need interrupts disabled, since a __notify can come in
952          * and set pending to FALSE */
953         if (vcpd->notif_pending) {
954                 /* We lost, put it back on the list and abort the yield */
955                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
956                 goto out_failed;
957         }
958         /* We won the race with event sending, we can safely yield */
959         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
960         /* Note this protects stuff userspace should look at, which doesn't
961          * include the TAILQs. */
962         __seq_start_write(&p->procinfo->coremap_seqctr);
963         /* Next time the vcore starts, it starts fresh */
964         vcpd->notif_disabled = FALSE;
965         __unmap_vcore(p, vcoreid);
966         p->procinfo->num_vcores--;
967         p->procinfo->res_grant[RES_CORES] = p->procinfo->num_vcores;
968         __seq_end_write(&p->procinfo->coremap_seqctr);
969         /* No more vcores?  Then we wait on an event */
970         if (p->procinfo->num_vcores == 0) {
971                 /* consider a ksched op to tell it about us WAITING */
972                 __proc_set_state(p, PROC_WAITING);
973         }
974         spin_unlock(&p->proc_lock);
975         /* Hand the now-idle core to the ksched */
976         put_idle_core(pcoreid);
977         goto out_yield_core;
978 out_failed:
979         /* for some reason we just want to return, either to take a KMSG that cleans
980          * us up, or because we shouldn't yield (ex: notif_pending). */
981         spin_unlock(&p->proc_lock);
982         enable_irqsave(&state);
983         return;
984 out_yield_core:                         /* successfully yielded the core */
985         proc_decref(p);                 /* need to eat the ref passed in */
986         /* Clean up the core and idle.  Need to do this before enabling interrupts,
987          * since once we put_idle_core() and unlock, we could get a startcore. */
988         clear_owning_proc(pcoreid);     /* so we don't restart */
989         abandon_core();
990         smp_idle();                             /* will reenable interrupts */
991 }
992
993 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
994  * only send a notification if one they are enabled.  There's a bunch of weird
995  * cases with this, and how pending / enabled are signals between the user and
996  * kernel - check the documentation.  Note that pending is more about messages.
997  * The process needs to be in vcore_context, and the reason is usually a
998  * message.  We set pending here in case we were called to prod them into vcore
999  * context (like via a sys_self_notify).  Also note that this works for _S
1000  * procs, if you send to vcore 0 (and the proc is running). */
1001 void proc_notify(struct proc *p, uint32_t vcoreid)
1002 {
1003         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1004         vcpd->notif_pending = TRUE;
1005         wrmb(); /* must write notif_pending before reading notif_disabled */
1006         if (!vcpd->notif_disabled) {
1007                 /* GIANT WARNING: we aren't using the proc-lock to protect the
1008                  * vcoremap.  We want to be able to use this from interrupt context,
1009                  * and don't want the proc_lock to be an irqsave.  Spurious
1010                  * __notify() kmsgs are okay (it checks to see if the right receiver
1011                  * is current). */
1012                 if (vcore_is_mapped(p, vcoreid)) {
1013                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
1014                         /* This use of try_get_pcoreid is racy, might be unmapped */
1015                         send_kernel_message(try_get_pcoreid(p, vcoreid), __notify, (long)p,
1016                                             0, 0, KMSG_IMMEDIATE);
1017                 }
1018         }
1019 }
1020
1021 /* Hold the lock before calling this.  If the process is WAITING, it will wake
1022  * it up and schedule it. */
1023 void __proc_wakeup(struct proc *p)
1024 {
1025         if (p->state != PROC_WAITING)
1026                 return;
1027         if (__proc_is_mcp(p)) {
1028                 /* Need to make sure they want at least 1 vcore, so the ksched gives
1029                  * them something.  Might do this via short handler later. */
1030                 if (!p->procdata->res_req[RES_CORES].amt_wanted)
1031                         p->procdata->res_req[RES_CORES].amt_wanted = 1;
1032                 __proc_set_state(p, PROC_RUNNABLE_M);
1033         } else {
1034                 printk("[kernel] FYI, waking up an _S proc\n");
1035                 __proc_set_state(p, PROC_RUNNABLE_S);
1036                 schedule_scp(p);
1037         }
1038 }
1039
1040 /* Is the process in multi_mode / is an MCP or not?  */
1041 bool __proc_is_mcp(struct proc *p)
1042 {
1043         /* in lieu of using the amount of cores requested, or having a bunch of
1044          * states (like PROC_WAITING_M and _S), I'll just track it with a bool. */
1045         return p->procinfo->is_mcp;
1046 }
1047
1048 /************************  Preemption Functions  ******************************
1049  * Don't rely on these much - I'll be sure to change them up a bit.
1050  *
1051  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1052  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1053  * flux.  The num_vcores is changed after take_cores, but some of the messages
1054  * (or local traps) may not yet be ready to handle seeing their future state.
1055  * But they should be, so fix those when they pop up.
1056  *
1057  * Another thing to do would be to make the _core functions take a pcorelist,
1058  * and not just one pcoreid. */
1059
1060 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1061  * about locking, do it before calling.  Takes a vcoreid! */
1062 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1063 {
1064         struct event_msg local_msg = {0};
1065         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1066          * since it is unmapped and not dealt with (TODO)*/
1067         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1068
1069         /* Send the event (which internally checks to see how they want it) */
1070         local_msg.ev_type = EV_PREEMPT_PENDING;
1071         local_msg.ev_arg1 = vcoreid;
1072         send_kernel_event(p, &local_msg, vcoreid);
1073
1074         /* TODO: consider putting in some lookup place for the alarm to find it.
1075          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1076 }
1077
1078 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1079  * care about the mapping (and you should). */
1080 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1081 {
1082         struct vcore *vc_i;
1083         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1084                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1085         /* TODO: consider putting in some lookup place for the alarm to find it.
1086          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1087 }
1088
1089 // TODO: function to set an alarm, if none is outstanding
1090
1091 /* Raw function to preempt a single core.  If you care about locking, do it
1092  * before calling. */
1093 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1094 {
1095         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1096         struct event_msg preempt_msg = {0};
1097         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1098         // expects a pcorelist.  assumes pcore is mapped and running_m
1099         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1100         /* Send a message about the preemption. */
1101         preempt_msg.ev_type = EV_VCORE_PREEMPT;
1102         preempt_msg.ev_arg2 = vcoreid;
1103         send_kernel_event(p, &preempt_msg, 0);
1104 }
1105
1106 /* Raw function to preempt every vcore.  If you care about locking, do it before
1107  * calling. */
1108 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr)
1109 {
1110         /* instead of doing this, we could just preempt_served all possible vcores,
1111          * and not just the active ones.  We would need to sort out a way to deal
1112          * with stale preempt_serveds first.  This might be just as fast anyways. */
1113         struct vcore *vc_i;
1114         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag, or
1115          * just make us RUNNABLE_M. */
1116         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1117                 vc_i->preempt_served = TRUE;
1118         return __proc_take_allcores(p, pc_arr, TRUE);
1119 }
1120
1121 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1122  * warning will be for u usec from now. */
1123 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1124 {
1125         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1126         bool preempted = FALSE;
1127         /* DYING could be okay */
1128         if (p->state != PROC_RUNNING_M) {
1129                 warn("Tried to preempt from a non RUNNING_M proc!");
1130                 return;
1131         }
1132         spin_lock(&p->proc_lock);
1133         /* TODO: this is racy, could be messages in flight that haven't unmapped
1134          * yet, so we need to do something more complicated */
1135         if (is_mapped_vcore(p, pcoreid)) {
1136                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1137                 __proc_preempt_core(p, pcoreid);
1138                 preempted = TRUE;
1139         } else {
1140                 warn("Pcore doesn't belong to the process!!");
1141         }
1142         if (!p->procinfo->num_vcores) {
1143                 __proc_set_state(p, PROC_RUNNABLE_M);
1144         }
1145         spin_unlock(&p->proc_lock);
1146         if (preempted)
1147                 put_idle_core(pcoreid);
1148 }
1149
1150 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1151  * warning will be for u usec from now. */
1152 void proc_preempt_all(struct proc *p, uint64_t usec)
1153 {
1154         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1155         uint32_t num_revoked = 0;
1156         spin_lock(&p->proc_lock);
1157         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
1158         uint32_t pc_arr[p->procinfo->num_vcores];
1159         /* DYING could be okay */
1160         if (p->state != PROC_RUNNING_M) {
1161                 warn("Tried to preempt from a non RUNNING_M proc!");
1162                 spin_unlock(&p->proc_lock);
1163                 return;
1164         }
1165         __proc_preempt_warnall(p, warn_time);
1166         num_revoked = __proc_preempt_all(p, pc_arr);
1167         assert(!p->procinfo->num_vcores);
1168         __proc_set_state(p, PROC_RUNNABLE_M);
1169         spin_unlock(&p->proc_lock);
1170         /* Return the cores to the ksched */
1171         if (num_revoked)
1172                 put_idle_cores(pc_arr, num_revoked);
1173 }
1174
1175 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1176  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1177  * free, etc. */
1178 void proc_give(struct proc *p, uint32_t pcoreid)
1179 {
1180         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1181         spin_lock(&p->proc_lock);
1182         // expects a pcorelist, we give it a list of one
1183         __proc_give_cores(p, &pcoreid, 1);
1184         spin_unlock(&p->proc_lock);
1185 }
1186
1187 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1188  * out). */
1189 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1190 {
1191         uint32_t vcoreid;
1192         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1193         spin_lock(&p->proc_lock);
1194         switch (p->state) {
1195                 case PROC_RUNNING_S:
1196                         spin_unlock(&p->proc_lock);
1197                         return 0; // TODO: here's the ugly part
1198                 case PROC_RUNNING_M:
1199                         vcoreid = get_vcoreid(p, pcoreid);
1200                         spin_unlock(&p->proc_lock);
1201                         return vcoreid;
1202                 case PROC_DYING: // death message is on the way
1203                         spin_unlock(&p->proc_lock);
1204                         return 0;
1205                 default:
1206                         spin_unlock(&p->proc_lock);
1207                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1208                               __FUNCTION__);
1209         }
1210 }
1211
1212 /* TODO: make all of these static inlines when we gut the env crap */
1213 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1214 {
1215         return p->procinfo->vcoremap[vcoreid].valid;
1216 }
1217
1218 /* Can do this, or just create a new field and save it in the vcoremap */
1219 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1220 {
1221         return (vc - p->procinfo->vcoremap);
1222 }
1223
1224 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1225 {
1226         return &p->procinfo->vcoremap[vcoreid];
1227 }
1228
1229 /********** Core granting (bulk and single) ***********/
1230
1231 /* Helper: gives pcore to the process, mapping it to the next available vcore
1232  * from list vc_list.  Returns TRUE if we succeeded (non-empty). */
1233 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1234                                 struct vcore_tailq *vc_list)
1235 {
1236         struct vcore *new_vc;
1237         new_vc = TAILQ_FIRST(vc_list);
1238         if (!new_vc)
1239                 return FALSE;
1240         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1241                pcorelist[i]);
1242         TAILQ_REMOVE(vc_list, new_vc, list);
1243         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1244         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1245         return TRUE;
1246 }
1247
1248 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1249                                        uint32_t num)
1250 {
1251         assert(p->state == PROC_RUNNABLE_M);
1252         assert(num);    /* catch bugs */
1253         /* add new items to the vcoremap */
1254         __seq_start_write(&p->procinfo->coremap_seqctr);/* unncessary if offline */
1255         p->procinfo->num_vcores += num;
1256         for (int i = 0; i < num; i++) {
1257                 /* Try from the bulk list first */
1258                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs))
1259                         continue;
1260                 /* o/w, try from the inactive list.  at one point, i thought there might
1261                  * be a legit way in which the inactive list could be empty, but that i
1262                  * wanted to catch it via an assert. */
1263                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1264         }
1265         __seq_end_write(&p->procinfo->coremap_seqctr);
1266 }
1267
1268 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1269                                       uint32_t num)
1270 {
1271         /* Up the refcnt, since num cores are going to start using this
1272          * process and have it loaded in their owning_proc and 'current'. */
1273         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1274         __seq_start_write(&p->procinfo->coremap_seqctr);
1275         p->procinfo->num_vcores += num;
1276         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1277         for (int i = 0; i < num; i++) {
1278                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1279                 send_kernel_message(pc_arr[i], __startcore, (long)p, 0, 0,
1280                                     KMSG_IMMEDIATE);
1281         }
1282         __seq_end_write(&p->procinfo->coremap_seqctr);
1283 }
1284
1285 /* Gives process p the additional num cores listed in pcorelist.  If the proc is
1286  * not RUNNABLE_M or RUNNING_M, this will fail and allocate none of the core
1287  * (and return -1).  If you're RUNNING_M, this will startup your new cores at
1288  * the entry point with their virtual IDs (or restore a preemption).  If you're
1289  * RUNNABLE_M, you should call __proc_run_m after this so that the process can
1290  * start to use its cores.  In either case, this returns 0.
1291  *
1292  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1293  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1294  * Then call __proc_run_m().
1295  *
1296  * The reason I didn't bring the _S cases from core_request over here is so we
1297  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1298  * this is called from another core, and to avoid the _S -> _M transition.
1299  *
1300  * WARNING: You must hold the proc_lock before calling this! */
1301 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1302 {
1303         /* should never happen: */
1304         assert(num + p->procinfo->num_vcores <= MAX_NUM_CPUS);
1305         switch (p->state) {
1306                 case (PROC_RUNNABLE_S):
1307                 case (PROC_RUNNING_S):
1308                         warn("Don't give cores to a process in a *_S state!\n");
1309                         return -1;
1310                 case (PROC_DYING):
1311                 case (PROC_WAITING):
1312                         /* can't accept, just fail */
1313                         return -1;
1314                 case (PROC_RUNNABLE_M):
1315                         __proc_give_cores_runnable(p, pc_arr, num);
1316                         break;
1317                 case (PROC_RUNNING_M):
1318                         __proc_give_cores_running(p, pc_arr, num);
1319                         break;
1320                 default:
1321                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1322                               __FUNCTION__);
1323         }
1324         /* TODO: considering moving to the ksched (hard, due to yield) */
1325         p->procinfo->res_grant[RES_CORES] += num;
1326         return 0;
1327 }
1328
1329 /********** Core revocation (bulk and single) ***********/
1330
1331 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1332 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1333 {
1334         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1335         struct preempt_data *vcpd;
1336         if (preempt) {
1337                 /* Lock the vcore's state (necessary for preemption recovery) */
1338                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1339                 atomic_or(&vcpd->flags, VC_K_LOCK);
1340                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0, KMSG_IMMEDIATE);
1341         } else {
1342                 send_kernel_message(pcoreid, __death, 0, 0, 0, KMSG_IMMEDIATE);
1343         }
1344 }
1345
1346 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1347 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1348 {
1349         struct vcore *vc_i;
1350         /* TODO: if we ever get broadcast messaging, use it here (still need to lock
1351          * the vcores' states for preemption) */
1352         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1353                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1354 }
1355
1356 /* Might be faster to scan the vcoremap than to walk the list... */
1357 static void __proc_unmap_allcores(struct proc *p)
1358 {
1359         struct vcore *vc_i;
1360         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1361                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1362 }
1363
1364 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1365  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1366  * Don't use this for taking all of a process's cores.
1367  *
1368  * Make sure you hold the lock when you call this, and make sure that the pcore
1369  * actually belongs to the proc, non-trivial due to other __preempt messages. */
1370 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1371                           bool preempt)
1372 {
1373         struct vcore *vc;
1374         uint32_t vcoreid;
1375         __seq_start_write(&p->procinfo->coremap_seqctr);
1376         for (int i = 0; i < num; i++) {
1377                 vcoreid = get_vcoreid(p, pc_arr[i]);
1378                 /* Sanity check */
1379                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1380                 /* Revoke / unmap core */
1381                 if (p->state == PROC_RUNNING_M) {
1382                         __proc_revoke_core(p, vcoreid, preempt);
1383                 } else {
1384                         assert(p->state == PROC_RUNNABLE_M);
1385                         __unmap_vcore(p, vcoreid);
1386                 }
1387                 /* Change lists for the vcore.  Note, the messages are already in flight
1388                  * (or the vcore is already unmapped), if applicable.  The only code
1389                  * that looks at the lists without holding the lock is event code, and
1390                  * it doesn't care if the vcore was unmapped (it handles that) */
1391                 vc = vcoreid2vcore(p, vcoreid);
1392                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1393                 /* even for single preempts, we use the inactive list.  bulk preempt is
1394                  * only used for when we take everything. */
1395                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1396         }
1397         p->procinfo->num_vcores -= num;
1398         __seq_end_write(&p->procinfo->coremap_seqctr);
1399         p->procinfo->res_grant[RES_CORES] -= num;
1400 }
1401
1402 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1403  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1404  * returns the number of entries in pc_arr.
1405  *
1406  * Make sure pc_arr is big enough to handle num_vcores().
1407  * Make sure you hold the lock when you call this. */
1408 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1409 {
1410         struct vcore *vc_i, *vc_temp;
1411         uint32_t num = 0;
1412         __seq_start_write(&p->procinfo->coremap_seqctr);
1413         /* Write out which pcores we're going to take */
1414         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1415                 pc_arr[num++] = vc_i->pcoreid;
1416         /* Revoke if they are running, o/w unmap.  Both of these need the online
1417          * list to not be changed yet. */
1418         if (p->state == PROC_RUNNING_M) {
1419                 __proc_revoke_allcores(p, preempt);
1420         } else {
1421                 assert(p->state == PROC_RUNNABLE_M);
1422                 __proc_unmap_allcores(p);
1423         }
1424         /* Move the vcores from online to the head of the appropriate list */
1425         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1426                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that */
1427                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1428                 /* Put the cores on the appropriate list */
1429                 if (preempt)
1430                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1431                 else
1432                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1433         }
1434         assert(TAILQ_EMPTY(&p->online_vcs));
1435         assert(num == p->procinfo->num_vcores);
1436         p->procinfo->num_vcores = 0;
1437         __seq_end_write(&p->procinfo->coremap_seqctr);
1438         p->procinfo->res_grant[RES_CORES] = 0;
1439         return num;
1440 }
1441
1442 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1443  * calling. */
1444 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1445 {
1446         while (p->procinfo->vcoremap[vcoreid].valid)
1447                 cpu_relax();
1448         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1449         wmb();
1450         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1451         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1452         wmb();
1453         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1454 }
1455
1456 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1457  * calling. */
1458 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1459 {
1460         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1461         wmb();
1462         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1463 }
1464
1465 /* Stop running whatever context is on this core and load a known-good cr3.
1466  * Note this leaves no trace of what was running. This "leaves the process's
1467  * context.  Also, we want interrupts disabled, to not conflict with kmsgs
1468  * (__launch_kthread, proc mgmt, etc).
1469  *
1470  * This does not clear the owning proc.  Use the other helper for that. */
1471 void abandon_core(void)
1472 {
1473         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1474         assert(!irq_is_enabled());
1475         /* Syscalls that don't return will ultimately call abadon_core(), so we need
1476          * to make sure we don't think we are still working on a syscall. */
1477         pcpui->cur_sysc = 0;
1478         if (pcpui->cur_proc)
1479                 __abandon_core();
1480 }
1481
1482 /* Helper to clear the core's owning processor and manage refcnting.  Pass in
1483  * core_id() to save a couple core_id() calls. */
1484 void clear_owning_proc(uint32_t coreid)
1485 {
1486         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1487         struct proc *p = pcpui->owning_proc;
1488         assert(!irq_is_enabled());
1489         pcpui->owning_proc = 0;
1490         pcpui->cur_tf = 0;                      /* catch bugs for now (will go away soon) */
1491         if (p);
1492                 proc_decref(p);
1493 }
1494
1495 /* Switches to the address space/context of new_p, doing nothing if we are
1496  * already in new_p.  This won't add extra refcnts or anything, and needs to be
1497  * paired with switch_back() at the end of whatever function you are in.  Don't
1498  * migrate cores in the middle of a pair.  Specifically, the uncounted refs are
1499  * one for the old_proc, which is passed back to the caller, and new_p is
1500  * getting placed in cur_proc. */
1501 struct proc *switch_to(struct proc *new_p)
1502 {
1503         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1504         struct proc *old_proc;
1505         int8_t irq_state = 0;
1506         disable_irqsave(&irq_state);
1507         old_proc = pcpui->cur_proc;                                     /* uncounted ref */
1508         /* If we aren't the proc already, then switch to it */
1509         if (old_proc != new_p) {
1510                 pcpui->cur_proc = new_p;                                /* uncounted ref */
1511                 lcr3(new_p->env_cr3);
1512         }
1513         enable_irqsave(&irq_state);
1514         return old_proc;
1515 }
1516
1517 /* This switches back to old_proc from new_p.  Pair it with switch_to(), and
1518  * pass in its return value for old_proc. */
1519 void switch_back(struct proc *new_p, struct proc *old_proc)
1520 {
1521         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1522         int8_t irq_state = 0;
1523         if (old_proc != new_p) {
1524                 disable_irqsave(&irq_state);
1525                 pcpui->cur_proc = old_proc;
1526                 if (old_proc)
1527                         lcr3(old_proc->env_cr3);
1528                 else
1529                         lcr3(boot_cr3);
1530                 enable_irqsave(&irq_state);
1531         }
1532 }
1533
1534 /* Will send a TLB shootdown message to every vcore in the main address space
1535  * (aka, all vcores for now).  The message will take the start and end virtual
1536  * addresses as well, in case we want to be more clever about how much we
1537  * shootdown and batching our messages.  Should do the sanity about rounding up
1538  * and down in this function too.
1539  *
1540  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1541  * message to the calling core (interrupting it, possibly while holding the
1542  * proc_lock).  We don't need to process routine messages since it's an
1543  * immediate message. */
1544 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1545 {
1546         struct vcore *vc_i;
1547         /* TODO: we might be able to avoid locking here in the future (we must hit
1548          * all online, and we can check __mapped).  it'll be complicated. */
1549         spin_lock(&p->proc_lock);
1550         switch (p->state) {
1551                 case (PROC_RUNNING_S):
1552                         tlbflush();
1553                         break;
1554                 case (PROC_RUNNING_M):
1555                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1556                         TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1557                                 send_kernel_message(vc_i->pcoreid, __tlbshootdown, start, end,
1558                                                     0, KMSG_IMMEDIATE);
1559                         }
1560                         break;
1561                 case (PROC_DYING):
1562                         /* if it is dying, death messages are already on the way to all
1563                          * cores, including ours, which will clear the TLB. */
1564                         break;
1565                 default:
1566                         /* will probably get this when we have the short handlers */
1567                         warn("Unexpected case %s in %s", procstate2str(p->state),
1568                              __FUNCTION__);
1569         }
1570         spin_unlock(&p->proc_lock);
1571 }
1572
1573 /* Helper, used by __startcore and change_to_vcore, which sets up cur_tf to run
1574  * a given process's vcore.  Caller needs to set up things like owning_proc and
1575  * whatnot.  Note that we might not have p loaded as current. */
1576 static void __set_curtf_to_vcoreid(struct proc *p, uint32_t vcoreid)
1577 {
1578         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1579         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1580
1581         /* We could let userspace do this, though they come into vcore entry many
1582          * times, and we just need this to happen when the cores comes online the
1583          * first time.  That, and they want this turned on as soon as we know a
1584          * vcore *WILL* be online.  We could also do this earlier, when we map the
1585          * vcore to its pcore, though we don't always have current loaded or
1586          * otherwise mess with the VCPD in those code paths. */
1587         vcpd->can_rcv_msg = TRUE;
1588         /* Mark that this vcore as no longer preempted.  No danger of clobbering
1589          * other writes, since this would get turned on in __preempt (which can't be
1590          * concurrent with this function on this core), and the atomic is just
1591          * toggling the one bit (a concurrent VC_K_LOCK will work) */
1592         atomic_and(&vcpd->flags, ~VC_PREEMPTED);
1593         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1594                core_id(), p->pid, vcoreid);
1595         /* If notifs are disabled, the vcore was in vcore context and we need to
1596          * restart the preempt_tf.  o/w, we give them a fresh vcore (which is also
1597          * what happens the first time a vcore comes online).  No matter what,
1598          * they'll restart in vcore context.  It's just a matter of whether or not
1599          * it is the old, interrupted vcore context. */
1600         if (vcpd->notif_disabled) {
1601                 restore_fp_state(&vcpd->preempt_anc);
1602                 /* copy-in the tf we'll pop, then set all security-related fields */
1603                 pcpui->actual_tf = vcpd->preempt_tf;
1604                 proc_secure_trapframe(&pcpui->actual_tf);
1605         } else { /* not restarting from a preemption, use a fresh vcore */
1606                 assert(vcpd->transition_stack);
1607                 /* TODO: consider 0'ing the FP state.  We're probably leaking. */
1608                 proc_init_trapframe(&pcpui->actual_tf, vcoreid, p->env_entry,
1609                                     vcpd->transition_stack);
1610                 /* Disable/mask active notifications for fresh vcores */
1611                 vcpd->notif_disabled = TRUE;
1612         }
1613         /* cur_tf was built above (in actual_tf), now use it */
1614         pcpui->cur_tf = &pcpui->actual_tf;
1615         /* this cur_tf will get run when the kernel returns / idles */
1616 }
1617
1618 /* Changes calling vcore to be vcoreid.  enable_my_notif tells us about how the
1619  * state calling vcore wants to be left in.  It will look like caller_vcoreid
1620  * was preempted.  Note we don't care about notif_pending.  */
1621 void proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
1622                           bool enable_my_notif)
1623 {
1624         uint32_t caller_vcoreid, pcoreid = core_id();
1625         struct preempt_data *caller_vcpd;
1626         struct vcore *caller_vc, *new_vc;
1627         struct event_msg preempt_msg = {0};
1628         int8_t state = 0;
1629         /* Need to disable before even reading caller_vcoreid, since we could be
1630          * unmapped by a __preempt or __death, like in yield. */
1631         disable_irqsave(&state);
1632         /* Need to lock before reading the vcoremap, like in yield */
1633         spin_lock(&p->proc_lock);
1634         /* new_vcoreid is already runing, abort */
1635         if (vcore_is_mapped(p, new_vcoreid))
1636                 goto out_failed;
1637         /* Need to make sure our vcore is allowed to switch.  We might have a
1638          * __preempt, __death, etc, coming in.  Similar to yield. */
1639         switch (p->state) {
1640                 case (PROC_RUNNING_M):
1641                         break;                          /* the only case we can proceed */
1642                 case (PROC_RUNNING_S):  /* user bug, just return */
1643                 case (PROC_DYING):              /* incoming __death */
1644                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1645                         goto out_failed;
1646                 default:
1647                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1648                               __FUNCTION__);
1649         }
1650         /* Make sure we're still mapped in the proc. */
1651         if (!is_mapped_vcore(p, pcoreid))
1652                 goto out_failed;
1653         /* Get all our info */
1654         caller_vcoreid = get_vcoreid(p, pcoreid);
1655         caller_vcpd = &p->procdata->vcore_preempt_data[caller_vcoreid];
1656         caller_vc = vcoreid2vcore(p, caller_vcoreid);
1657         /* Should only call from vcore context */
1658         if (!caller_vcpd->notif_disabled) {
1659                 printk("[kernel] You tried to change vcores from uthread ctx\n");
1660                 goto out_failed;
1661         }
1662         /* Return and take the preempt message when we enable_irqs. */
1663         if (caller_vc->preempt_served)
1664                 goto out_failed;
1665         /* Ok, we're clear to do the switch.  Lets figure out who the new one is */
1666         new_vc = vcoreid2vcore(p, new_vcoreid);
1667         printd("[kernel] changing vcore %d to vcore %d\n", caller_vcoreid,
1668                new_vcoreid);
1669         /* enable_my_notif signals how we'll be restarted */
1670         if (enable_my_notif) {
1671                 /* if they set this flag, then the vcore can just restart from scratch,
1672                  * and we don't care about either the notif_tf or the preempt_tf. */
1673                 caller_vcpd->notif_disabled = FALSE;
1674         } else {
1675                 /* need to set up the calling vcore's tf so that it'll get restarted by
1676                  * __startcore, to make the caller look like it was preempted. */
1677                 caller_vcpd->preempt_tf = *current_tf;
1678                 save_fp_state(&caller_vcpd->preempt_anc);
1679                 /* Mark our core as preempted (for userspace recovery). */
1680                 atomic_or(&caller_vcpd->flags, VC_PREEMPTED);
1681         }
1682         /* Either way, unmap and offline our current vcore */
1683         /* Move the caller from online to inactive */
1684         TAILQ_REMOVE(&p->online_vcs, caller_vc, list);
1685         /* We don't bother with the notif_pending race.  note that notif_pending
1686          * could still be set.  this was a preempted vcore, and userspace will need
1687          * to deal with missed messages (preempt_recover() will handle that) */
1688         TAILQ_INSERT_HEAD(&p->inactive_vcs, caller_vc, list);
1689         /* Move the new one from inactive to online */
1690         TAILQ_REMOVE(&p->inactive_vcs, new_vc, list);
1691         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1692         /* Change the vcore map (TODO: might get rid of this seqctr) */
1693         __seq_start_write(&p->procinfo->coremap_seqctr);
1694         __unmap_vcore(p, caller_vcoreid);
1695         __map_vcore(p, new_vcoreid, pcoreid);
1696         __seq_end_write(&p->procinfo->coremap_seqctr);
1697         /* Send either a PREEMPT msg or a CHECK_MSGS msg.  If they said to
1698          * enable_my_notif, then all userspace needs is to check messages, not a
1699          * full preemption recovery. */
1700         preempt_msg.ev_type = (enable_my_notif ? EV_CHECK_MSGS : EV_VCORE_PREEMPT);
1701         preempt_msg.ev_arg2 = caller_vcoreid;   /* arg2 is 32 bits */
1702         send_kernel_event(p, &preempt_msg, new_vcoreid);
1703         /* Change cur_tf so we'll be the new vcoreid */
1704         __set_curtf_to_vcoreid(p, new_vcoreid);
1705         /* Fall through to exit (we didn't fail) */
1706 out_failed:
1707         spin_unlock(&p->proc_lock);
1708         enable_irqsave(&state);
1709 }
1710
1711 /* Kernel message handler to start a process's context on this core, when the
1712  * core next considers running a process.  Tightly coupled with __proc_run_m().
1713  * Interrupts are disabled. */
1714 void __startcore(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1715 {
1716         uint32_t vcoreid, coreid = core_id();
1717         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1718         struct proc *p_to_run = (struct proc *CT(1))a0;
1719
1720         assert(p_to_run);
1721         /* Can not be any TF from a process here already */
1722         assert(!pcpui->owning_proc);
1723         /* the sender of the amsg increfed already for this saved ref to p_to_run */
1724         pcpui->owning_proc = p_to_run;
1725         /* sender increfed again, assuming we'd install to cur_proc.  only do this
1726          * if no one else is there.  this is an optimization, since we expect to
1727          * send these __startcores to idles cores, and this saves a scramble to
1728          * incref when all of the cores restartcore/startcore later.  Keep in sync
1729          * with __proc_give_cores() and __proc_run_m(). */
1730         if (!pcpui->cur_proc) {
1731                 pcpui->cur_proc = p_to_run;     /* install the ref to cur_proc */
1732                 lcr3(p_to_run->env_cr3);        /* load the page tables to match cur_proc */
1733         } else {
1734                 proc_decref(p_to_run);          /* can't install, decref the extra one */
1735         }
1736         /* Note we are not necessarily in the cr3 of p_to_run */
1737         vcoreid = get_vcoreid(p_to_run, coreid);
1738         /* Now that we sorted refcnts and know p / which vcore it should be, set up
1739          * pcpui->cur_tf so that it will run that particular vcore */
1740         __set_curtf_to_vcoreid(p_to_run, vcoreid);
1741 }
1742
1743 /* Bail out if it's the wrong process, or if they no longer want a notif.  Don't
1744  * use the TF we passed in, we care about cur_tf.  Try not to grab locks or
1745  * write access to anything that isn't per-core in here. */
1746 void __notify(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1747 {
1748         uint32_t vcoreid, coreid = core_id();
1749         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1750         struct preempt_data *vcpd;
1751         struct proc *p = (struct proc*)a0;
1752
1753         /* Not the right proc */
1754         if (p != pcpui->owning_proc)
1755                 return;
1756         /* Common cur_tf sanity checks.  Note cur_tf could be an _S's env_tf */
1757         assert(pcpui->cur_tf);
1758         assert(!in_kernel(pcpui->cur_tf));
1759         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1760          * mapping would only happen if the vcore was free, which it isn't until
1761          * after we unmap. */
1762         vcoreid = get_vcoreid(p, coreid);
1763         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1764         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1765                p->procinfo->pid, vcoreid, coreid);
1766         /* sort signals.  notifs are now masked, like an interrupt gate */
1767         if (vcpd->notif_disabled)
1768                 return;
1769         vcpd->notif_disabled = TRUE;
1770         /* save the old tf in the notify slot, build and pop a new one.  Note that
1771          * silly state isn't our business for a notification. */
1772         vcpd->notif_tf = *pcpui->cur_tf;
1773         memset(pcpui->cur_tf, 0, sizeof(struct trapframe));
1774         proc_init_trapframe(pcpui->cur_tf, vcoreid, p->env_entry,
1775                             vcpd->transition_stack);
1776         /* this cur_tf will get run when the kernel returns / idles */
1777 }
1778
1779 void __preempt(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1780 {
1781         uint32_t vcoreid, coreid = core_id();
1782         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1783         struct preempt_data *vcpd;
1784         struct proc *p = (struct proc*)a0;
1785
1786         assert(p);
1787         if (p != pcpui->owning_proc) {
1788                 panic("__preempt arrived for a process (%p) that was not owning (%p)!",
1789                       p, pcpui->owning_proc);
1790         }
1791         /* Common cur_tf sanity checks */
1792         assert(pcpui->cur_tf);
1793         assert(pcpui->cur_tf == &pcpui->actual_tf);
1794         assert(!in_kernel(pcpui->cur_tf));
1795         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1796          * mapping would only happen if the vcore was free, which it isn't until
1797          * after we unmap. */
1798         vcoreid = get_vcoreid(p, coreid);
1799         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1800         /* either __preempt or proc_yield() ends the preempt phase. */
1801         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1802         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1803         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1804                p->procinfo->pid, vcoreid, coreid);
1805         /* if notifs are disabled, the vcore is in vcore context (as far as we're
1806          * concerned), and we save it in the preempt slot. o/w, we save the
1807          * process's cur_tf in the notif slot, and it'll appear to the vcore when it
1808          * comes back up that it just took a notification. */
1809         if (vcpd->notif_disabled)
1810                 vcpd->preempt_tf = *pcpui->cur_tf;
1811         else
1812                 vcpd->notif_tf = *pcpui->cur_tf;
1813         /* either way, we save the silly state (FP) */
1814         save_fp_state(&vcpd->preempt_anc);
1815         /* Mark the vcore as preempted and unlock (was locked by the sender). */
1816         atomic_or(&vcpd->flags, VC_PREEMPTED);
1817         atomic_and(&vcpd->flags, ~VC_K_LOCK);
1818         wmb();  /* make sure everything else hits before we unmap */
1819         __unmap_vcore(p, vcoreid);
1820         /* We won't restart the process later.  current gets cleared later when we
1821          * notice there is no owning_proc and we have nothing to do (smp_idle,
1822          * restartcore, etc) */
1823         clear_owning_proc(coreid);
1824 }
1825
1826 /* Kernel message handler to clean up the core when a process is dying.
1827  * Note this leaves no trace of what was running.
1828  * It's okay if death comes to a core that's already idling and has no current.
1829  * It could happen if a process decref'd before __proc_startcore could incref. */
1830 void __death(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1831 {
1832         uint32_t vcoreid, coreid = core_id();
1833         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1834         struct proc *p = pcpui->owning_proc;
1835         if (p) {
1836                 vcoreid = get_vcoreid(p, coreid);
1837                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1838                        coreid, p->pid, vcoreid);
1839                 __unmap_vcore(p, vcoreid);
1840                 /* We won't restart the process later.  current gets cleared later when
1841                  * we notice there is no owning_proc and we have nothing to do
1842                  * (smp_idle, restartcore, etc) */
1843                 clear_owning_proc(coreid);
1844         }
1845 }
1846
1847 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1848  * addresses from a0 to a1. */
1849 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, long a0, long a1,
1850                     long a2)
1851 {
1852         /* TODO: (TLB) something more intelligent with the range */
1853         tlbflush();
1854 }
1855
1856 void print_allpids(void)
1857 {
1858         void print_proc_state(void *item)
1859         {
1860                 struct proc *p = (struct proc*)item;
1861                 assert(p);
1862                 printk("%8d %s\n", p->pid, procstate2str(p->state));
1863         }
1864         printk("PID      STATE    \n");
1865         printk("------------------\n");
1866         spin_lock(&pid_hash_lock);
1867         hash_for_each(pid_hash, print_proc_state);
1868         spin_unlock(&pid_hash_lock);
1869 }
1870
1871 void print_proc_info(pid_t pid)
1872 {
1873         int j = 0;
1874         struct proc *p = pid2proc(pid);
1875         struct vcore *vc_i;
1876         if (!p) {
1877                 printk("Bad PID.\n");
1878                 return;
1879         }
1880         spinlock_debug(&p->proc_lock);
1881         //spin_lock(&p->proc_lock); // No locking!!
1882         printk("struct proc: %p\n", p);
1883         printk("PID: %d\n", p->pid);
1884         printk("PPID: %d\n", p->ppid);
1885         printk("State: %s (%p)\n", procstate2str(p->state), p->state);
1886         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
1887         printk("Flags: 0x%08x\n", p->env_flags);
1888         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1889         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1890         printk("Vcore Lists (may be in flux w/o locking):\n----------------------\n");
1891         printk("Online:\n");
1892         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1893                 printk("\tVcore %d -> Pcore %d\n", vcore2vcoreid(p, vc_i), vc_i->pcoreid);
1894         printk("Bulk Preempted:\n");
1895         TAILQ_FOREACH(vc_i, &p->bulk_preempted_vcs, list)
1896                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1897         printk("Inactive / Yielded:\n");
1898         TAILQ_FOREACH(vc_i, &p->inactive_vcs, list)
1899                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1900         printk("Resources:\n------------------------\n");
1901         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1902                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1903                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
1904         printk("Open Files:\n");
1905         struct files_struct *files = &p->open_files;
1906         spin_lock(&files->lock);
1907         for (int i = 0; i < files->max_files; i++)
1908                 if (files->fd_array[i].fd_file) {
1909                         printk("\tFD: %02d, File: %08p, File name: %s\n", i,
1910                                files->fd_array[i].fd_file,
1911                                file_name(files->fd_array[i].fd_file));
1912                 }
1913         spin_unlock(&files->lock);
1914         /* No one cares, and it clutters the terminal */
1915         //printk("Vcore 0's Last Trapframe:\n");
1916         //print_trapframe(&p->env_tf);
1917         /* no locking / unlocking or refcnting */
1918         // spin_unlock(&p->proc_lock);
1919         proc_decref(p);
1920 }
1921
1922 /* Debugging function, checks what (process, vcore) is supposed to run on this
1923  * pcore.  Meant to be called from smp_idle() before halting. */
1924 void check_my_owner(void)
1925 {
1926         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1927         void shazbot(void *item)
1928         {
1929                 struct proc *p = (struct proc*)item;
1930                 struct vcore *vc_i;
1931                 assert(p);
1932                 spin_lock(&p->proc_lock);
1933                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1934                         /* this isn't true, a __startcore could be on the way and we're
1935                          * already "online" */
1936                         if (vc_i->pcoreid == core_id()) {
1937                                 /* Immediate message was sent, we should get it when we enable
1938                                  * interrupts, which should cause us to skip cpu_halt() */
1939                                 if (!STAILQ_EMPTY(&pcpui->immed_amsgs))
1940                                         continue;
1941                                 printk("Owned pcore (%d) has no owner, by %08p, vc %d!\n",
1942                                        core_id(), p, vcore2vcoreid(p, vc_i));
1943                                 spin_unlock(&p->proc_lock);
1944                                 spin_unlock(&pid_hash_lock);
1945                                 monitor(0);
1946                         }
1947                 }
1948                 spin_unlock(&p->proc_lock);
1949         }
1950         assert(!irq_is_enabled());
1951         extern int booting;
1952         if (!booting && !pcpui->owning_proc) {
1953                 spin_lock(&pid_hash_lock);
1954                 hash_for_each(pid_hash, shazbot);
1955                 spin_unlock(&pid_hash_lock);
1956         }
1957 }