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