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