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