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