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