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