Closes files in proc_destroy()
[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 <arch/arch.h>
11 #include <arch/bitmask.h>
12 #include <process.h>
13 #include <atomic.h>
14 #include <smp.h>
15 #include <pmap.h>
16 #include <trap.h>
17 #include <schedule.h>
18 #include <manager.h>
19 #include <stdio.h>
20 #include <assert.h>
21 #include <timing.h>
22 #include <hashtable.h>
23 #include <slab.h>
24 #include <sys/queue.h>
25 #include <frontend.h>
26 #include <monitor.h>
27 #include <resource.h>
28 #include <elf.h>
29 #include <arsc_server.h>
30 #include <devfs.h>
31
32 /* Process Lists */
33 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
34 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
35 struct kmem_cache *proc_cache;
36
37 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
38  * physical coreid of an unallocated core. */
39 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
40 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
41 uint32_t LCKD(&idle_lock) num_idlecores = 0;
42 uint32_t num_mgmtcores = 1;
43
44 /* Helper function to return a core to the idlemap.  It causes some more lock
45  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
46  * we might be able to do this without locks (for the putting). */
47 void put_idle_core(uint32_t coreid)
48 {
49         spin_lock(&idle_lock);
50         idlecoremap[num_idlecores++] = coreid;
51         spin_unlock(&idle_lock);
52 }
53
54 /* Other helpers, implemented later. */
55 static void __proc_startcore(struct proc *p, trapframe_t *tf);
56 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
57 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
58 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
59 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
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          * W   -> RBS
116          * RGS -> RBM
117          * RBM -> RGM
118          * RGM -> RBM
119          * RGM -> RBS
120          * RGS -> D
121          * RGM -> D
122          *
123          * These ought to be implemented later (allowed, not thought through yet).
124          * RBS -> D
125          * RBM -> D
126          */
127         #if 1 // some sort of correctness flag
128         switch (curstate) {
129                 case PROC_CREATED:
130                         if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
131                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
132                         break;
133                 case PROC_RUNNABLE_S:
134                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
135                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
136                         break;
137                 case PROC_RUNNING_S:
138                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
139                                        PROC_DYING)))
140                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
141                         break;
142                 case PROC_WAITING:
143                         if (state != PROC_RUNNABLE_S)
144                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
145                         break;
146                 case PROC_DYING:
147                         if (state != PROC_CREATED) // when it is reused (TODO)
148                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
149                         break;
150                 case PROC_RUNNABLE_M:
151                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
152                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
153                         break;
154                 case PROC_RUNNING_M:
155                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
156                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
157                         break;
158         }
159         #endif
160         p->state = state;
161         return 0;
162 }
163
164 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
165  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
166  * process is dying and we should not have the ref (and thus return 0).  We need
167  * to lock to protect us from getting p, (someone else removes and frees p),
168  * then get_not_zero() on p.
169  * Don't push the locking into the hashtable without dealing with this. */
170 struct proc *pid2proc(pid_t pid)
171 {
172         spin_lock(&pid_hash_lock);
173         struct proc *p = hashtable_search(pid_hash, (void*)pid);
174         if (p)
175                 if (!kref_get_not_zero(&p->kref, 1))
176                         p = 0;
177         spin_unlock(&pid_hash_lock);
178         return p;
179 }
180
181 /* Performs any initialization related to processes, such as create the proc
182  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
183  * any process related function. */
184 void proc_init(void)
185 {
186         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
187                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
188         /* Init PID mask and hash.  pid 0 is reserved. */
189         SET_BITMASK_BIT(pid_bmask, 0);
190         spinlock_init(&pid_hash_lock);
191         spin_lock(&pid_hash_lock);
192         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
193         spin_unlock(&pid_hash_lock);
194         schedule_init();
195         /* Init idle cores. Core 0 is the management core. */
196         spin_lock(&idle_lock);
197 #ifdef __CONFIG_DISABLE_SMT__
198         /* assumes core0 is the only management core (NIC and monitor functionality
199          * are run there too.  it just adds the odd cores to the idlecoremap */
200         assert(!(num_cpus % 2));
201         // TODO: consider checking x86 for machines that actually hyperthread
202         num_idlecores = num_cpus >> 1;
203 #ifdef __CONFIG_ARSC_SERVER__
204         // Dedicate one core (core 2) to sysserver, might be able to share wit NIC
205         num_mgmtcores++;
206         assert(num_cpus >= num_mgmtcores);
207         send_kernel_message(2, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
208 #endif
209         for (int i = 0; i < num_idlecores; i++)
210                 idlecoremap[i] = (i * 2) + 1;
211 #else
212         // __CONFIG_DISABLE_SMT__
213         #ifdef __CONFIG_NETWORKING__
214         num_mgmtcores++; // Next core is dedicated to the NIC
215         assert(num_cpus >= num_mgmtcores);
216         #endif
217         #ifdef __CONFIG_APPSERVER__
218         #ifdef __CONFIG_DEDICATED_MONITOR__
219         num_mgmtcores++; // Next core dedicated to running the kernel monitor
220         assert(num_cpus >= num_mgmtcores);
221         // Need to subtract 1 from the num_mgmtcores # to get the cores index
222         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
223         #endif
224         #endif
225 #ifdef __CONFIG_ARSC_SERVER__
226         // Dedicate one core (core 2) to sysserver, might be able to share wit NIC
227         num_mgmtcores++;
228         assert(num_cpus >= num_mgmtcores);
229         send_kernel_message(num_mgmtcores-1, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
230 #endif
231         num_idlecores = num_cpus - num_mgmtcores;
232         for (int i = 0; i < num_idlecores; i++)
233                 idlecoremap[i] = i + num_mgmtcores;
234 #endif /* __CONFIG_DISABLE_SMT__ */
235
236         spin_unlock(&idle_lock);
237         atomic_init(&num_envs, 0);
238 }
239
240 void
241 proc_init_procinfo(struct proc* p)
242 {
243         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
244         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
245         p->procinfo->num_vcores = 0;
246         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
247         // TODO: change these too
248         p->procinfo->pid = p->pid;
249         p->procinfo->ppid = p->ppid;
250         p->procinfo->tsc_freq = system_timing.tsc_freq;
251         // TODO: maybe do something smarter here
252 #ifdef __CONFIG_DISABLE_SMT__
253         p->procinfo->max_vcores = num_cpus >> 1;
254 #else
255         p->procinfo->max_vcores = MAX(1,num_cpus-num_mgmtcores);
256 #endif /* __CONFIG_DISABLE_SMT__ */
257 }
258
259 /* Allocates and initializes a process, with the given parent.  Currently
260  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
261  * Errors include:
262  *  - ENOFREEPID if it can't get a PID
263  *  - ENOMEM on memory exhaustion */
264 error_t proc_alloc(struct proc **pp, struct proc *parent)
265 {
266         error_t r;
267         struct proc *p;
268
269         if (!(p = kmem_cache_alloc(proc_cache, 0)))
270                 return -ENOMEM;
271
272         { INITSTRUCT(*p)
273
274         /* one reference for the proc existing, and one for the ref we pass back. */
275         kref_init(&p->kref, __proc_free, 2);
276         // Setup the default map of where to get cache colors from
277         p->cache_colors_map = global_cache_colors_map;
278         p->next_cache_color = 0;
279         /* Initialize the address space */
280         if ((r = env_setup_vm(p)) < 0) {
281                 kmem_cache_free(proc_cache, p);
282                 return r;
283         }
284         if (!(p->pid = get_free_pid())) {
285                 kmem_cache_free(proc_cache, p);
286                 return -ENOFREEPID;
287         }
288         /* Set the basic status variables. */
289         spinlock_init(&p->proc_lock);
290         p->exitcode = 0;
291         p->ppid = parent ? parent->pid : 0;
292         p->state = PROC_CREATED; /* shouldn't go through state machine for init */
293         p->env_flags = 0;
294         p->env_entry = 0; // cheating.  this really gets set later
295         p->procinfo->heap_bottom = (void*)UTEXT;
296         p->heap_top = (void*)UTEXT;
297         memset(&p->resources, 0, sizeof(p->resources));
298         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
299         memset(&p->env_tf, 0, sizeof(p->env_tf));
300         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
301
302         /* Initialize the contents of the e->procinfo structure */
303         proc_init_procinfo(p);
304         /* Initialize the contents of the e->procdata structure */
305
306         /* Initialize the generic syscall ring buffer */
307         SHARED_RING_INIT(&p->procdata->syscallring);
308         /* Initialize the backend of the syscall ring buffer */
309         BACK_RING_INIT(&p->syscallbackring,
310                        &p->procdata->syscallring,
311                        SYSCALLRINGSIZE);
312
313         /* Initialize the generic sysevent ring buffer */
314         SHARED_RING_INIT(&p->procdata->syseventring);
315         /* Initialize the frontend of the sysevent ring buffer */
316         FRONT_RING_INIT(&p->syseventfrontring,
317                         &p->procdata->syseventring,
318                         SYSEVENTRINGSIZE);
319
320         /* Init FS structures TODO: cleanup (might pull this out) */
321         kref_get(&default_ns.kref, 1);
322         p->ns = &default_ns;
323         spinlock_init(&p->fs_env.lock);
324         p->fs_env.umask = parent ? parent->fs_env.umask : S_IWGRP | S_IWOTH;
325         p->fs_env.root = p->ns->root->mnt_root;
326         kref_get(&p->fs_env.root->d_kref, 1);
327         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
328         kref_get(&p->fs_env.pwd->d_kref, 1);
329         memset(&p->open_files, 0, sizeof(p->open_files));       /* slightly ghetto */
330         spinlock_init(&p->open_files.lock);
331         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
332         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
333         p->open_files.fd = p->open_files.fd_array;
334         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
335
336         atomic_inc(&num_envs);
337         frontend_proc_init(p);
338         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
339         } // INIT_STRUCT
340         *pp = p;
341         return 0;
342 }
343
344 /* We have a bunch of different ways to make processes.  Call this once the
345  * process is ready to be used by the rest of the system.  For now, this just
346  * means when it is ready to be named via the pidhash.  In the future, we might
347  * push setting the state to CREATED into here. */
348 void __proc_ready(struct proc *p)
349 {
350         spin_lock(&pid_hash_lock);
351         hashtable_insert(pid_hash, (void*)p->pid, p);
352         spin_unlock(&pid_hash_lock);
353 }
354
355 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
356  * rid of proc_alloc's style, but it is so quaint... */
357 struct proc *proc_create(struct file *prog, char **argv, char **envp)
358 {
359         struct proc *p;
360         error_t r;
361         if ((r = proc_alloc(&p, current)) < 0)
362                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
363         procinfo_pack_args(p->procinfo, argv, envp);
364         assert(load_elf(p, prog) == 0);
365         /* Connect to stdin, stdout, stderr */
366         assert(insert_file(&p->open_files, dev_stdin,  0) == 0);
367         assert(insert_file(&p->open_files, dev_stdout, 0) == 1);
368         assert(insert_file(&p->open_files, dev_stderr, 0) == 2);
369         __proc_ready(p);
370         return p;
371 }
372
373 /* This is called by kref_put(), once the last reference to the process is
374  * gone.  Don't call this otherwise (it will panic).  It will clean up the
375  * address space and deallocate any other used memory. */
376 static void __proc_free(struct kref *kref)
377 {
378         struct proc *p = container_of(kref, struct proc, kref);
379         physaddr_t pa;
380
381         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
382         // All parts of the kernel should have decref'd before __proc_free is called
383         assert(kref_refcnt(&p->kref) == 0);
384
385         kref_put(&p->fs_env.root->d_kref);
386         kref_put(&p->fs_env.pwd->d_kref);
387         destroy_vmrs(p);
388         frontend_proc_free(p);  /* TODO: please remove me one day */
389         /* Free any colors allocated to this process */
390         if (p->cache_colors_map != global_cache_colors_map) {
391                 for(int i = 0; i < llc_cache->num_colors; i++)
392                         cache_color_free(llc_cache, p->cache_colors_map);
393                 cache_colors_map_free(p->cache_colors_map);
394         }
395         /* Remove us from the pid_hash and give our PID back (in that order). */
396         spin_lock(&pid_hash_lock);
397         if (!hashtable_remove(pid_hash, (void*)p->pid))
398                 panic("Proc not in the pid table in %s", __FUNCTION__);
399         spin_unlock(&pid_hash_lock);
400         put_free_pid(p->pid);
401         /* Flush all mapped pages in the user portion of the address space */
402         env_user_mem_free(p, 0, UVPT);
403         /* These need to be free again, since they were allocated with a refcnt. */
404         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
405         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
406
407         env_pagetable_free(p);
408         p->env_pgdir = 0;
409         p->env_cr3 = 0;
410
411         atomic_dec(&num_envs);
412
413         /* Dealloc the struct proc */
414         kmem_cache_free(proc_cache, p);
415 }
416
417 /* Whether or not actor can control target.  Note we currently don't need
418  * locking for this. TODO: think about that, esp wrt proc's dying. */
419 bool proc_controls(struct proc *actor, struct proc *target)
420 {
421         return ((actor == target) || (target->ppid == actor->pid));
422 }
423
424 /* Helper, makes p the 'current' process, dropping the old current/cr3.  Don't
425  * incref - this assumes the passed in reference already counted 'current'. */
426 static void __set_proc_current(struct proc *p)
427 {
428         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
429          * though who know how expensive/painful they are. */
430         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
431         /* If the process wasn't here, then we need to load its address space. */
432         if (p != pcpui->cur_proc) {
433                 /* Do not incref here.  We were given the reference to current,
434                  * pre-upped. */
435                 lcr3(p->env_cr3);
436                 /* This is "leaving the process context" of the previous proc.  The
437                  * previous lcr3 unloaded the previous proc's context.  This should
438                  * rarely happen, since we usually proactively leave process context,
439                  * but this is the fallback. */
440                 if (pcpui->cur_proc)
441                         kref_put(&pcpui->cur_proc->kref);
442                 pcpui->cur_proc = p;
443         }
444 }
445
446 /* Dispatches a process to run, either on the current core in the case of a
447  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
448  * never be called to "restart" a core.  This expects that the "instructions"
449  * for which core(s) to run this on will be in the vcoremap, which needs to be
450  * set externally.
451  *
452  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
453  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
454  * it's old core0 context, and the other cores will come in at the entry point.
455  * Including in the case of preemption.
456  *
457  * This won't return if the current core is going to be one of the processes
458  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
459  * eat your reference if it does not return. */
460 void proc_run(struct proc *p)
461 {
462         bool self_ipi_pending = FALSE;
463         spin_lock(&p->proc_lock);
464
465         switch (p->state) {
466                 case (PROC_DYING):
467                         spin_unlock(&p->proc_lock);
468                         printk("Process %d not starting due to async death\n", p->pid);
469                         // if we're a worker core, smp_idle, o/w return
470                         if (!management_core())
471                                 smp_idle(); // this never returns
472                         return;
473                 case (PROC_RUNNABLE_S):
474                         assert(current != p);
475                         __proc_set_state(p, PROC_RUNNING_S);
476                         /* We will want to know where this process is running, even if it is
477                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
478                          * Also, this is the signal used in trap.c to know to save the tf in
479                          * env_tf. */
480                         __seq_start_write(&p->procinfo->coremap_seqctr);
481                         p->procinfo->num_vcores = 0;
482                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
483                         __seq_end_write(&p->procinfo->coremap_seqctr);
484                         /* __set_proc_current assumes the reference we give it is for
485                          * current.  Decref if current is already properly set, otherwise
486                          * ensure current is set. */
487                         if (p == current)
488                                 kref_put(&p->kref);
489                         else
490                                 __set_proc_current(p);
491                         /* We restartcore, instead of startcore, since startcore is a bit
492                          * lower level and we want a chance to process kmsgs before starting
493                          * the process. */
494                         spin_unlock(&p->proc_lock);
495                         current_tf = &p->env_tf;
496                         proc_restartcore();
497                         break;
498                 case (PROC_RUNNABLE_M):
499                         /* vcoremap[i] holds the coreid of the physical core allocated to
500                          * this process.  It is set outside proc_run.  For the kernel
501                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
502                         if (p->procinfo->num_vcores) {
503                                 __proc_set_state(p, PROC_RUNNING_M);
504                                 /* Up the refcnt, since num_vcores are going to start using this
505                                  * process and have it loaded in their 'current'. */
506                                 kref_get(&p->kref, p->procinfo->num_vcores);
507                                 /* If the core we are running on is in the vcoremap, we will get
508                                  * an IPI (once we reenable interrupts) and never return. */
509                                 if (is_mapped_vcore(p, core_id()))
510                                         self_ipi_pending = TRUE;
511                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
512                                         send_kernel_message(get_pcoreid(p, i), __startcore, p, 0,
513                                                             0, KMSG_ROUTINE);
514                         } else {
515                                 warn("Tried to proc_run() an _M with no vcores!");
516                         }
517                         /* Unlock and decref/wait for the IPI if one is pending.  This will
518                          * eat the reference if we aren't returning.
519                          *
520                          * There a subtle race avoidance here.  __proc_startcore can handle
521                          * a death message, but we can't have the startcore come after the
522                          * death message.  Otherwise, it would look like a new process.  So
523                          * we hold the lock til after we send our message, which prevents a
524                          * possible death message.
525                          * - Note there is no guarantee this core's interrupts were on, so
526                          *   it may not get the message for a while... */
527                         spin_unlock(&p->proc_lock);
528                         __proc_kmsg_pending(p, self_ipi_pending);
529                         break;
530                 default:
531                         spin_unlock(&p->proc_lock);
532                         panic("Invalid process state %p in proc_run()!!", p->state);
533         }
534 }
535
536 /* Actually runs the given context (trapframe) of process p on the core this
537  * code executes on.  This is called directly by __startcore, which needs to
538  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
539  *
540  * A note on refcnting: this function will not return, and your proc reference
541  * will end up stored in current.  This will make no changes to p's refcnt, so
542  * do your accounting such that there is only the +1 for current.  This means if
543  * it is already in current (like in the trap return path), don't up it.  If
544  * it's already in current and you have another reference (like pid2proc or from
545  * an IPI), then down it (which is what happens in __startcore()).  If it's not
546  * in current and you have one reference, like proc_run(non_current_p), then
547  * also do nothing.  The refcnt for your *p will count for the reference stored
548  * in current. */
549 static void __proc_startcore(struct proc *p, trapframe_t *tf)
550 {
551         assert(!irq_is_enabled());
552         __set_proc_current(p);
553         /* need to load our silly state, preferably somewhere other than here so we
554          * can avoid the case where the context was just running here.  it's not
555          * sufficient to do it in the "new process" if-block above (could be things
556          * like page faults that cause us to keep the same process, but want a
557          * different context.
558          * for now, we load this silly state here. (TODO) (HSS)
559          * We also need this to be per trapframe, and not per process...
560          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
561          * __startcore.  */
562         if (p->state == PROC_RUNNING_S)
563                 env_pop_ancillary_state(p);
564         /* Clear the current_tf, since it is no longer used */
565         current_tf = 0;
566         env_pop_tf(tf);
567 }
568
569 /* Restarts/runs the current_tf, which must be for the current process, on the
570  * core this code executes on.  Calls an internal function to do the work.
571  *
572  * In case there are pending routine messages, like __death, __preempt, or
573  * __notify, we need to run them.  Alternatively, if there are any, we could
574  * self_ipi, and run the messages immediately after popping back to userspace,
575  * but that would have crappy overhead.
576  *
577  * Refcnting: this will not return, and it assumes that you've accounted for
578  * your reference as if it was the ref for "current" (which is what happens when
579  * returning from local traps and such. */
580 void proc_restartcore(void)
581 {
582         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
583         /* If there is no cur_tf, it is because the old one was already restarted
584          * (and we weren't interrupting another one to finish).  In which case, we
585          * should just smp_idle() */
586         if (!pcpui->cur_tf) {
587                 assert(!current);       /* might be wrong, but i want to know if it is */
588                 smp_idle();
589         }
590         /* TODO: this is where we can decide to smp_idle() if there is no cur_tf */
591         /* Need ints disabled when we return from processing (race) */
592         disable_irq();
593         /* Need to be current (set by the caller), in case a kmsg is there that
594          * tries to clobber us. */
595         process_routine_kmsg(pcpui->cur_tf);
596         __proc_startcore(pcpui->cur_proc, pcpui->cur_tf);
597 }
598
599 /*
600  * Destroys the given process.  This may be called from another process, a light
601  * kernel thread (no real process context), asynchronously/cross-core, or from
602  * the process on its own core.
603  *
604  * Here's the way process death works:
605  * 0. grab the lock (protects state transition and core map)
606  * 1. set state to dying.  that keeps the kernel from doing anything for the
607  * process (like proc_running it).
608  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
609  * 3. IPI to clean up those cores (decref, etc).
610  * 4. Unlock
611  * 5. Clean up your core, if applicable
612  * (Last core/kernel thread to decref cleans up and deallocates resources.)
613  *
614  * Note that some cores can be processing async calls, but will eventually
615  * decref.  Should think about this more, like some sort of callback/revocation.
616  *
617  * This will eat your reference if it won't return.  Note that this function
618  * needs to change anyways when we make __death more like __preempt.  (TODO) */
619 void proc_destroy(struct proc *p)
620 {
621         bool self_ipi_pending = FALSE;
622         
623         spin_lock(&p->proc_lock);
624         /* TODO: (DEATH) look at this again when we sort the __death IPI */
625         if (current == p)
626                 self_ipi_pending = TRUE;
627
628         switch (p->state) {
629                 case PROC_DYING: // someone else killed this already.
630                         spin_unlock(&p->proc_lock);
631                         __proc_kmsg_pending(p, self_ipi_pending);
632                         return;
633                 case PROC_RUNNABLE_M:
634                         /* Need to reclaim any cores this proc might have, even though it's
635                          * not running yet. */
636                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
637                         // fallthrough
638                 case PROC_RUNNABLE_S:
639                         // Think about other lists, like WAITING, or better ways to do this
640                         deschedule_proc(p);
641                         break;
642                 case PROC_RUNNING_S:
643                         #if 0
644                         // here's how to do it manually
645                         if (current == p) {
646                                 lcr3(boot_cr3);
647                                 kref_put(&p->kref);             /* this decref is for the cr3 */
648                                 current = NULL;
649                         }
650                         #endif
651                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
652                                             KMSG_ROUTINE);
653                         __seq_start_write(&p->procinfo->coremap_seqctr);
654                         // TODO: might need to sort num_vcores too later (VC#)
655                         /* vcore is unmapped on the receive side */
656                         __seq_end_write(&p->procinfo->coremap_seqctr);
657                         #if 0
658                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
659                          * managed by the idlecoremap.  so don't do this yet. */
660                         put_idle_core(get_pcoreid(p, 0));
661                         #endif
662                         break;
663                 case PROC_RUNNING_M:
664                         /* Send the DEATH message to every core running this process, and
665                          * deallocate the cores.
666                          * The rule is that the vcoremap is set before proc_run, and reset
667                          * within proc_destroy */
668                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
669                                              (void *SNT)0);
670                         break;
671                 case PROC_CREATED:
672                         break;
673                 default:
674                         panic("Weird state(%s) in %s()", procstate2str(p->state),
675                               __FUNCTION__);
676         }
677         __proc_set_state(p, PROC_DYING);
678         /* This prevents processes from accessing their old files while dying, and
679          * will help if these files (or similar objects in the future) hold
680          * references to p (preventing a __proc_free()). */
681         close_all_files(&p->open_files, FALSE);
682         /* This kref_put() is for the process's existence. */
683         kref_put(&p->kref);
684         /* Unlock and possible decref and wait.  A death IPI should be on its way,
685          * either from the RUNNING_S one, or from proc_take_cores with a __death.
686          * in general, interrupts should be on when you call proc_destroy locally,
687          * but currently aren't for all things (like traphandlers). */
688         spin_unlock(&p->proc_lock);
689         /* at this point, we normally have one ref to be eaten in kmsg_pending and
690          * one for every 'current'.  and maybe one for a parent */
691         __proc_kmsg_pending(p, self_ipi_pending);
692         return;
693 }
694
695 /* Helper function.  Starting from prev, it will find the next free vcoreid,
696  * which is the next vcore that is not valid.
697  * You better hold the lock before calling this. */
698 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
699 {
700         uint32_t i;
701         for (i = prev; i < MAX_NUM_CPUS; i++)
702                 if (!p->procinfo->vcoremap[i].valid)
703                         break;
704         if (i + 1 >= MAX_NUM_CPUS)
705                 warn("At the end of the vcorelist.  Might want to check that out.");
706         return i;
707 }
708
709 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
710  * which is the next vcore that is valid.
711  * You better hold the lock before calling this. */
712 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
713 {
714         uint32_t i;
715         for (i = prev; i < MAX_NUM_CPUS; i++)
716                 if (p->procinfo->vcoremap[i].valid)
717                         break;
718         if (i + 1 >= MAX_NUM_CPUS)
719                 warn("At the end of the vcorelist.  Might want to check that out.");
720         return i;
721 }
722
723 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
724  * careful. */
725 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
726 {
727         return p->procinfo->pcoremap[pcoreid].valid;
728 }
729
730 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
731  * No locking involved, be careful.  Panics on failure. */
732 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
733 {
734         assert(is_mapped_vcore(p, pcoreid));
735         return p->procinfo->pcoremap[pcoreid].vcoreid;
736 }
737
738 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
739  * No locking involved, be careful.  Panics on failure. */
740 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
741 {
742         assert(p->procinfo->vcoremap[vcoreid].valid);
743         return p->procinfo->vcoremap[vcoreid].pcoreid;
744 }
745
746 /* Helper function: yields / wraps up current_tf and schedules the _S */
747 void __proc_yield_s(struct proc *p, struct trapframe *tf)
748 {
749         assert(p->state == PROC_RUNNING_S);
750         p->env_tf= *tf;
751         env_push_ancillary_state(p);                    /* TODO: (HSS) */
752         __proc_set_state(p, PROC_RUNNABLE_S);
753         schedule_proc(p);
754 }
755
756 /* Yields the calling core.  Must be called locally (not async) for now.
757  * - If RUNNING_S, you just give up your time slice and will eventually return.
758  * - If RUNNING_M, you give up the current vcore (which never returns), and
759  *   adjust the amount of cores wanted/granted.
760  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
761  *   you'll have one guaranteed core, starting from the entry point.
762  *
763  * - RES_CORES amt_wanted will be the amount running after taking away the
764  *   yielder, unless there are none left, in which case it will be 1.
765  *
766  * If the call is being nice, it means that it is in response to a preemption
767  * (which needs to be checked).  If there is no preemption pending, just return.
768  * No matter what, don't adjust the number of cores wanted.
769  *
770  * This usually does not return (abandon_core()), so it will eat your reference.
771  * */
772 void proc_yield(struct proc *SAFE p, bool being_nice)
773 {
774         uint32_t vcoreid = get_vcoreid(p, core_id());
775         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
776
777         /* no reason to be nice, return */
778         if (being_nice && !vc->preempt_pending)
779                 return;
780
781         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
782
783         /* fate is sealed, return and take the preempt message on the way out.
784          * we're making this check while holding the lock, since the preemptor
785          * should hold the lock when sending messages. */
786         if (vc->preempt_served) {
787                 spin_unlock(&p->proc_lock);
788                 return;
789         }
790         /* no need to preempt later, since we are yielding (nice or otherwise) */
791         if (vc->preempt_pending)
792                 vc->preempt_pending = 0;
793
794         switch (p->state) {
795                 case (PROC_RUNNING_S):
796                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
797                         break;
798                 case (PROC_RUNNING_M):
799                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
800                                get_vcoreid(p, core_id()));
801                         /* TODO: (RMS) the Scheduler cannot handle the Runnable Ms (RMS), so
802                          * don't yield the last vcore. */
803                         if (p->procinfo->num_vcores == 1) {
804                                 spin_unlock(&p->proc_lock);
805                                 return;
806                         }
807                         __seq_start_write(&p->procinfo->coremap_seqctr);
808                         // give up core
809                         __unmap_vcore(p, get_vcoreid(p, core_id()));
810                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
811                         if (!being_nice)
812                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
813                         __seq_end_write(&p->procinfo->coremap_seqctr);
814                         // add to idle list
815                         put_idle_core(core_id());
816                         // last vcore?  then we really want 1, and to yield the gang
817                         // TODO: (RMS) will actually do this.
818                         if (p->procinfo->num_vcores == 0) {
819                                 p->resources[RES_CORES].amt_wanted = 1;
820                                 __proc_set_state(p, PROC_RUNNABLE_M);
821                                 schedule_proc(p);
822                         }
823                         break;
824                 default:
825                         // there are races that can lead to this (async death, preempt, etc)
826                         panic("Weird state(%s) in %s()", procstate2str(p->state),
827                               __FUNCTION__);
828         }
829         spin_unlock(&p->proc_lock);
830         kref_put(&p->kref);                     /* need to eat the ref passed in */
831         /* TODO: (RMS) If there was a change to the idle cores, try and give our
832          * core to someone who was preempted. */
833         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
834          * manager, which will call schedule() and will repick the yielding proc. */
835         abandon_core();
836         smp_idle();
837 }
838
839 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
840 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
841                struct notif_event *ne)
842 {
843         printd("sending notif %d to proc %p\n", notif, p);
844         assert(notif < MAX_NR_NOTIF);
845         if (ne)
846                 assert(notif == ne->ne_type);
847
848         struct notif_method *nm = &p->procdata->notif_methods[notif];
849         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
850
851         printd("nm = %p, vcpd = %p\n", nm, vcpd);
852         /* enqueue notif message or toggle bits */
853         if (ne && nm->flags & NOTIF_MSG) {
854                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
855                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
856                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
857                 }
858         } else {
859                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
860         }
861
862         /* Active notification */
863         /* TODO: Currently, there is a race for notif_pending, and multiple senders
864          * can send an IPI.  Worst thing is that the process gets interrupted
865          * briefly and the kernel immediately returns back once it realizes notifs
866          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
867          * use a bool. (wrong answer). */
868         if (nm->flags & NOTIF_IPI && !vcpd->notif_pending) {
869                 vcpd->notif_pending = TRUE;
870                 if (vcpd->notif_enabled) {
871                         /* GIANT WARNING: we aren't using the proc-lock to protect the
872                          * vcoremap.  We want to be able to use this from interrupt context,
873                          * and don't want the proc_lock to be an irqsave.
874                          */
875                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
876                                       (p->procinfo->vcoremap[vcoreid].valid)) {
877                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
878                                 send_kernel_message(get_pcoreid(p, vcoreid), __notify, p, 0, 0,
879                                                     KMSG_ROUTINE);
880                         } else { // TODO: think about this, fallback, etc
881                                 warn("Vcore unmapped, not receiving an active notif");
882                         }
883                 }
884         }
885 }
886
887 /* Sends notification number notif to proc p.  Meant for generic notifications /
888  * reference implementation.  do_notify does the real work.  This one mostly
889  * just determines where the notif should be sent, other checks, etc.
890  * Specifically, it handles the parameters of notif_methods.  If you happen to
891  * notify yourself, make sure you process routine kmsgs. */
892 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
893 {
894         assert(notif < MAX_NR_NOTIF); // notifs start at 0
895         struct notif_method *nm = &p->procdata->notif_methods[notif];
896         struct notif_event local_ne;
897
898         /* Caller can opt to not send an NE, in which case we use the notif */
899         if (!ne) {
900                 ne = &local_ne;
901                 ne->ne_type = notif;
902         }
903
904         if (!(nm->flags & NOTIF_WANTED))
905                 return;
906         do_notify(p, nm->vcoreid, ne->ne_type, ne);
907 }
908
909 /************************  Preemption Functions  ******************************
910  * Don't rely on these much - I'll be sure to change them up a bit.
911  *
912  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
913  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
914  * flux.  The num_vcores is changed after take_cores, but some of the messages
915  * (or local traps) may not yet be ready to handle seeing their future state.
916  * But they should be, so fix those when they pop up.
917  *
918  * TODO: (RMS) we need to actually make the scheduler handle RUNNABLE_Ms and
919  * then schedule these, or change proc_destroy to not assume they need to be
920  * descheduled.
921  *
922  * Another thing to do would be to make the _core functions take a pcorelist,
923  * and not just one pcoreid. */
924
925 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
926  * about locking, do it before calling.  Takes a vcoreid! */
927 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
928 {
929         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
930          * since it is unmapped and not dealt with (TODO)*/
931         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
932         /* notify, if they want to hear about this event.  regardless of how they
933          * want it, we can send this as a bit.  Subject to change. */
934         if (p->procdata->notif_methods[NE_PREEMPT_PENDING].flags | NOTIF_WANTED)
935                 do_notify(p, vcoreid, NE_PREEMPT_PENDING, 0);
936         /* TODO: consider putting in some lookup place for the alarm to find it.
937          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
938 }
939
940 /* Warns all active vcores of an impending preemption.  Hold the lock if you
941  * care about the mapping (and you should). */
942 void __proc_preempt_warnall(struct proc *p, uint64_t when)
943 {
944         uint32_t active_vcoreid = 0;
945         for (int i = 0; i < p->procinfo->num_vcores; i++) {
946                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
947                 __proc_preempt_warn(p, active_vcoreid, when);
948                 active_vcoreid++;
949         }
950         /* TODO: consider putting in some lookup place for the alarm to find it.
951          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
952 }
953
954 // TODO: function to set an alarm, if none is outstanding
955
956 /* Raw function to preempt a single core.  Returns TRUE if the calling core will
957  * get a kmsg.  If you care about locking, do it before calling. */
958 bool __proc_preempt_core(struct proc *p, uint32_t pcoreid)
959 {
960         uint32_t vcoreid = get_vcoreid(p, pcoreid);
961
962         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
963         // expects a pcorelist.  assumes pcore is mapped and running_m
964         return __proc_take_cores(p, &pcoreid, 1, __preempt, p, 0, 0);
965 }
966
967 /* Raw function to preempt every vcore.  Returns TRUE if the calling core will
968  * get a kmsg.  If you care about locking, do it before calling. */
969 bool __proc_preempt_all(struct proc *p)
970 {
971         /* instead of doing this, we could just preempt_served all possible vcores,
972          * and not just the active ones.  We would need to sort out a way to deal
973          * with stale preempt_serveds first.  This might be just as fast anyways. */
974         uint32_t active_vcoreid = 0;
975         for (int i = 0; i < p->procinfo->num_vcores; i++) {
976                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
977                 p->procinfo->vcoremap[active_vcoreid].preempt_served = TRUE;
978                 active_vcoreid++;
979         }
980         return __proc_take_allcores(p, __preempt, p, 0, 0);
981 }
982
983 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
984  * warning will be for u usec from now. */
985 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
986 {
987         bool self_ipi_pending = FALSE;
988         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
989
990         /* DYING could be okay */
991         if (p->state != PROC_RUNNING_M) {
992                 warn("Tried to preempt from a non RUNNING_M proc!");
993                 return;
994         }
995         spin_lock(&p->proc_lock);
996         if (is_mapped_vcore(p, pcoreid)) {
997                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
998                 self_ipi_pending = __proc_preempt_core(p, pcoreid);
999         } else {
1000                 warn("Pcore doesn't belong to the process!!");
1001         }
1002         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1003          * to schedule it */
1004         #if 0
1005         if (!p->procinfo->num_vcores) {
1006                 __proc_set_state(p, PROC_RUNNABLE_M);
1007                 schedule_proc(p);
1008         }
1009         #endif
1010         spin_unlock(&p->proc_lock);
1011         __proc_kmsg_pending(p, self_ipi_pending);
1012 }
1013
1014 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1015  * warning will be for u usec from now. */
1016 void proc_preempt_all(struct proc *p, uint64_t usec)
1017 {
1018         bool self_ipi_pending = FALSE;
1019         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1020
1021         spin_lock(&p->proc_lock);
1022         /* DYING could be okay */
1023         if (p->state != PROC_RUNNING_M) {
1024                 warn("Tried to preempt from a non RUNNING_M proc!");
1025                 spin_unlock(&p->proc_lock);
1026                 return;
1027         }
1028         __proc_preempt_warnall(p, warn_time);
1029         self_ipi_pending = __proc_preempt_all(p);
1030         assert(!p->procinfo->num_vcores);
1031         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1032          * to schedule it */
1033         #if 0
1034         __proc_set_state(p, PROC_RUNNABLE_M);
1035         schedule_proc(p);
1036         #endif
1037         spin_unlock(&p->proc_lock);
1038         __proc_kmsg_pending(p, self_ipi_pending);
1039 }
1040
1041 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1042  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1043  * free, etc. */
1044 void proc_give(struct proc *p, uint32_t pcoreid)
1045 {
1046         bool self_ipi_pending = FALSE;
1047
1048         spin_lock(&p->proc_lock);
1049         // expects a pcorelist, we give it a list of one
1050         self_ipi_pending = __proc_give_cores(p, &pcoreid, 1);
1051         spin_unlock(&p->proc_lock);
1052         __proc_kmsg_pending(p, self_ipi_pending);
1053 }
1054
1055 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1056  * out). */
1057 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1058 {
1059         uint32_t vcoreid;
1060         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1061         spin_lock(&p->proc_lock);
1062         switch (p->state) {
1063                 case PROC_RUNNING_S:
1064                         spin_unlock(&p->proc_lock);
1065                         return 0; // TODO: here's the ugly part
1066                 case PROC_RUNNING_M:
1067                         vcoreid = get_vcoreid(p, pcoreid);
1068                         spin_unlock(&p->proc_lock);
1069                         return vcoreid;
1070                 case PROC_DYING: // death message is on the way
1071                         spin_unlock(&p->proc_lock);
1072                         return 0;
1073                 default:
1074                         spin_unlock(&p->proc_lock);
1075                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1076                               __FUNCTION__);
1077         }
1078 }
1079
1080 /* Gives process p the additional num cores listed in pcorelist.  You must be
1081  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1082  * startup your new cores at the entry point with their virtual IDs (or restore
1083  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1084  * that the process can start to use its cores.
1085  *
1086  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1087  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1088  * Then call proc_run().
1089  *
1090  * The reason I didn't bring the _S cases from core_request over here is so we
1091  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1092  * this is called from another core, and to avoid the need_to_idle business.
1093  * The other way would be to have this function have the side effect of changing
1094  * state, and finding another way to do the need_to_idle.
1095  *
1096  * The returned bool signals whether or not a stack-crushing IPI will come in
1097  * once you unlock after this function.
1098  *
1099  * WARNING: You must hold the proc_lock before calling this! */
1100 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1101 { TRUSTEDBLOCK
1102         bool self_ipi_pending = FALSE;
1103         uint32_t free_vcoreid = 0;
1104         switch (p->state) {
1105                 case (PROC_RUNNABLE_S):
1106                 case (PROC_RUNNING_S):
1107                         panic("Don't give cores to a process in a *_S state!\n");
1108                         break;
1109                 case (PROC_DYING):
1110                         panic("Attempted to give cores to a DYING process.\n");
1111                         break;
1112                 case (PROC_RUNNABLE_M):
1113                         // set up vcoremap.  list should be empty, but could be called
1114                         // multiple times before proc_running (someone changed their mind?)
1115                         if (p->procinfo->num_vcores) {
1116                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1117                                 // debugging: if we aren't packed, then there's a problem
1118                                 // somewhere, like someone forgot to take vcores after
1119                                 // preempting.
1120                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1121                                         assert(p->procinfo->vcoremap[i].valid);
1122                         }
1123                         // add new items to the vcoremap
1124                         __seq_start_write(&p->procinfo->coremap_seqctr);
1125                         for (int i = 0; i < num; i++) {
1126                                 // find the next free slot, which should be the next one
1127                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1128                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1129                                        pcorelist[i]);
1130                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1131                                 p->procinfo->num_vcores++;
1132                         }
1133                         __seq_end_write(&p->procinfo->coremap_seqctr);
1134                         break;
1135                 case (PROC_RUNNING_M):
1136                         /* Up the refcnt, since num cores are going to start using this
1137                          * process and have it loaded in their 'current'. */
1138                         kref_get(&p->kref, num);
1139                         __seq_start_write(&p->procinfo->coremap_seqctr);
1140                         for (int i = 0; i < num; i++) {
1141                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1142                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1143                                        pcorelist[i]);
1144                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1145                                 p->procinfo->num_vcores++;
1146                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1147                                                     KMSG_ROUTINE);
1148                                 if (pcorelist[i] == core_id())
1149                                         self_ipi_pending = TRUE;
1150                         }
1151                         __seq_end_write(&p->procinfo->coremap_seqctr);
1152                         break;
1153                 default:
1154                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1155                               __FUNCTION__);
1156         }
1157         p->resources[RES_CORES].amt_granted += num;
1158         return self_ipi_pending;
1159 }
1160
1161 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1162  * needs to know what cores are free after this call (removed, failed, etc).
1163  * This info will be returned via corelist and *num.  This will send message to
1164  * any cores that are getting removed.
1165  *
1166  * Before implementing this, we should probably think about when this will be
1167  * used.  Implies preempting for the message.  The more that I think about this,
1168  * the less I like it.  For now, don't use this, and think hard before
1169  * implementing it.
1170  *
1171  * WARNING: You must hold the proc_lock before calling this! */
1172 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1173                          size_t *num, amr_t message,TV(a0t) arg0,
1174                          TV(a1t) arg1, TV(a2t) arg2)
1175 {
1176         panic("Set all cores not implemented.\n");
1177 }
1178
1179 /* Takes from process p the num cores listed in pcorelist, using the given
1180  * message for the kernel message (__death, __preempt, etc).  Like the others
1181  * in this function group, bool signals whether or not an IPI is pending.
1182  *
1183  * WARNING: You must hold the proc_lock before calling this! */
1184 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1185                        size_t num, amr_t message, TV(a0t) arg0,
1186                        TV(a1t) arg1, TV(a2t) arg2)
1187 { TRUSTEDBLOCK
1188         uint32_t vcoreid, pcoreid;
1189         bool self_ipi_pending = FALSE;
1190         switch (p->state) {
1191                 case (PROC_RUNNABLE_M):
1192                         assert(!message);
1193                         break;
1194                 case (PROC_RUNNING_M):
1195                         assert(message);
1196                         break;
1197                 default:
1198                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1199                               __FUNCTION__);
1200         }
1201         spin_lock(&idle_lock);
1202         assert((num <= p->procinfo->num_vcores) &&
1203                (num_idlecores + num <= num_cpus));
1204         spin_unlock(&idle_lock);
1205         __seq_start_write(&p->procinfo->coremap_seqctr);
1206         for (int i = 0; i < num; i++) {
1207                 vcoreid = get_vcoreid(p, pcorelist[i]);
1208                 // while ugly, this is done to facilitate merging with take_all_cores
1209                 pcoreid = get_pcoreid(p, vcoreid);
1210                 assert(pcoreid == pcorelist[i]);
1211                 if (message) {
1212                         if (pcoreid == core_id())
1213                                 self_ipi_pending = TRUE;
1214                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1215                                             KMSG_ROUTINE);
1216                 } else {
1217                         /* if there was a msg, the vcore is unmapped on the receive side.
1218                          * o/w, we need to do it here. */
1219                         __unmap_vcore(p, vcoreid);
1220                 }
1221                 // give the pcore back to the idlecoremap
1222                 put_idle_core(pcoreid);
1223         }
1224         p->procinfo->num_vcores -= num;
1225         __seq_end_write(&p->procinfo->coremap_seqctr);
1226         p->resources[RES_CORES].amt_granted -= num;
1227         return self_ipi_pending;
1228 }
1229
1230 /* Takes all cores from a process, which must be in an _M state.  Cores are
1231  * placed back in the idlecoremap.  If there's a message, such as __death or
1232  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1233  * IPI is coming in once you unlock.
1234  *
1235  * WARNING: You must hold the proc_lock before calling this! */
1236 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1237                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1238 {
1239         uint32_t active_vcoreid = 0, pcoreid;
1240         bool self_ipi_pending = FALSE;
1241         switch (p->state) {
1242                 case (PROC_RUNNABLE_M):
1243                         assert(!message);
1244                         break;
1245                 case (PROC_RUNNING_M):
1246                         assert(message);
1247                         break;
1248                 default:
1249                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1250                               __FUNCTION__);
1251         }
1252         spin_lock(&idle_lock);
1253         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1254         spin_unlock(&idle_lock);
1255         __seq_start_write(&p->procinfo->coremap_seqctr);
1256         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1257                 // find next active vcore
1258                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1259                 pcoreid = get_pcoreid(p, active_vcoreid);
1260                 if (message) {
1261                         if (pcoreid == core_id())
1262                                 self_ipi_pending = TRUE;
1263                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1264                                             KMSG_ROUTINE);
1265                 } else {
1266                         /* if there was a msg, the vcore is unmapped on the receive side.
1267                          * o/w, we need to do it here. */
1268                         __unmap_vcore(p, active_vcoreid);
1269                 }
1270                 // give the pcore back to the idlecoremap
1271                 put_idle_core(pcoreid);
1272                 active_vcoreid++; // for the next loop, skip the one we just used
1273         }
1274         p->procinfo->num_vcores = 0;
1275         __seq_end_write(&p->procinfo->coremap_seqctr);
1276         p->resources[RES_CORES].amt_granted = 0;
1277         return self_ipi_pending;
1278 }
1279
1280 /* Helper, to be used when a proc management kmsg should be on its way.  This
1281  * used to also unlock and then handle the message, back when the proc_lock was
1282  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1283  * is pending, this needs to decref (to eat the reference of the caller) and
1284  * then process the message.  Unlock before calling this, since you might not
1285  * return.
1286  *
1287  * There should already be a kmsg waiting for us, since when we checked state to
1288  * see a message was coming, the message had already been sent before unlocking.
1289  * Note we do not need interrupts enabled for this to work (you can receive a
1290  * message before its IPI by polling), though in most cases they will be.
1291  *
1292  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1293  * core_request(). */
1294 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1295 {
1296         if (ipi_pending) {
1297                 kref_put(&p->kref);
1298                 process_routine_kmsg(0);
1299                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1300         }
1301 }
1302
1303 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1304  * calling. */
1305 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1306 {
1307         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1308         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1309         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1310         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1311 }
1312
1313 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1314  * calling. */
1315 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1316 {
1317         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1318         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1319 }
1320
1321 /* Stop running whatever context is on this core, load a known-good cr3, and
1322  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1323  * process's context. */
1324 void abandon_core(void)
1325 {
1326         if (current) {
1327                 current_tf = 0;
1328                 __abandon_core();
1329         }
1330 }
1331
1332 /* Will send a TLB shootdown message to every vcore in the main address space
1333  * (aka, all vcores for now).  The message will take the start and end virtual
1334  * addresses as well, in case we want to be more clever about how much we
1335  * shootdown and batching our messages.  Should do the sanity about rounding up
1336  * and down in this function too.
1337  *
1338  * Hold the proc_lock before calling this.
1339  *
1340  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1341  * message to the calling core (interrupting it, possibly while holding the
1342  * proc_lock).  We don't need to process routine messages since it's an
1343  * immediate message. */
1344 void __proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1345 {
1346         uint32_t active_vcoreid = 0;
1347         switch (p->state) {
1348                 case (PROC_RUNNING_S):
1349                         tlbflush();
1350                         break;
1351                 case (PROC_RUNNING_M):
1352                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1353                         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1354                                 /* find next active vcore */
1355                                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1356                                 send_kernel_message(get_pcoreid(p, active_vcoreid),
1357                                                     __tlbshootdown, (void*)start, (void*)end,
1358                                                     0, KMSG_IMMEDIATE);
1359                                 active_vcoreid++; /* next loop, skip the one we just used */
1360                         }
1361                         break;
1362                 default:
1363                         /* will probably get this when we have the short handlers */
1364                         warn("Unexpected case in %s\n", __FUNCTION__);
1365         }
1366 }
1367
1368 /* Kernel message handler to start a process's context on this core.  Tightly
1369  * coupled with proc_run().  Interrupts are disabled. */
1370 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1371 {
1372         uint32_t pcoreid = core_id(), vcoreid;
1373         struct proc *p_to_run = (struct proc *CT(1))a0;
1374         struct trapframe local_tf;
1375         struct preempt_data *vcpd;
1376
1377         assert(p_to_run);
1378         /* the sender of the amsg increfed, thinking we weren't running current. */
1379         if (p_to_run == current)
1380                 kref_put(&p_to_run->kref);
1381         vcoreid = get_vcoreid(p_to_run, pcoreid);
1382         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1383         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1384                pcoreid, p_to_run->pid, vcoreid);
1385
1386         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1387                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1388                 restore_fp_state(&vcpd->preempt_anc);
1389                 /* notif_pending and enabled means the proc wants to receive the IPI,
1390                  * but might have missed it.  copy over the tf so they can restart it
1391                  * later, and give them a fresh vcore. */
1392                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1393                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1394                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1395                                             vcpd->transition_stack);
1396                         vcpd->notif_enabled = FALSE;
1397                         vcpd->notif_pending = FALSE;
1398                 } else {
1399                         /* copy-in the tf we'll pop, then set all security-related fields */
1400                         local_tf = vcpd->preempt_tf;
1401                         proc_secure_trapframe(&local_tf);
1402                 }
1403         } else { /* not restarting from a preemption, use a fresh vcore */
1404                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1405                                     vcpd->transition_stack);
1406                 /* Disable/mask active notifications for fresh vcores */
1407                 vcpd->notif_enabled = FALSE;
1408         }
1409         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1410 }
1411
1412 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1413  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1414  * grab locks or write access to anything that isn't per-core in here. */
1415 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1416 {
1417         struct user_trapframe local_tf;
1418         struct preempt_data *vcpd;
1419         uint32_t vcoreid;
1420         struct proc *p = (struct proc*)a0;
1421
1422         if (p != current)
1423                 return;
1424         assert(!in_kernel(tf));
1425         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1426          * mapping would only happen if the vcore was free, which it isn't until
1427          * after we unmap. */
1428         vcoreid = get_vcoreid(p, core_id());
1429         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1430         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1431                p->procinfo->pid, vcoreid, core_id());
1432         /* sort signals.  notifs are now masked, like an interrupt gate */
1433         if (!vcpd->notif_enabled)
1434                 return;
1435         vcpd->notif_enabled = FALSE;
1436         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1437         /* save the old tf in the notify slot, build and pop a new one.  Note that
1438          * silly state isn't our business for a notification. */
1439         // TODO: this is assuming the struct user_tf is the same as a regular TF
1440         vcpd->notif_tf = *tf;
1441         memset(&local_tf, 0, sizeof(local_tf));
1442         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1443                             vcpd->transition_stack);
1444         __proc_startcore(p, &local_tf);
1445 }
1446
1447 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1448 {
1449         struct preempt_data *vcpd;
1450         uint32_t vcoreid, coreid = core_id();
1451         struct proc *p = (struct proc*)a0;
1452
1453         if (p != current)
1454                 panic("__preempt arrived for a process (%p) that was not current (%p)!",
1455                       p, current);
1456         assert(!in_kernel(tf));
1457         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1458          * mapping would only happen if the vcore was free, which it isn't until
1459          * after we unmap. */
1460         vcoreid = get_vcoreid(p, coreid);
1461         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1462         /* either __preempt or proc_yield() ends the preempt phase. */
1463         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1464         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1465         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1466                p->procinfo->pid, vcoreid, core_id());
1467
1468         /* save the old tf in the preempt slot, save the silly state, and signal the
1469          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1470          * seq_ctrs so userspace can tell between different valid versions.  If the
1471          * TF was already valid, it will panic (if CONFIGed that way). */
1472         // TODO: this is assuming the struct user_tf is the same as a regular TF
1473         vcpd->preempt_tf = *tf;
1474         save_fp_state(&vcpd->preempt_anc);
1475         __seq_start_write(&vcpd->preempt_tf_valid);
1476         __unmap_vcore(p, vcoreid);
1477         abandon_core();
1478         smp_idle();
1479 }
1480
1481 /* Kernel message handler to clean up the core when a process is dying.
1482  * Note this leaves no trace of what was running.
1483  * It's okay if death comes to a core that's already idling and has no current.
1484  * It could happen if a process decref'd before __proc_startcore could incref. */
1485 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1486              void *SNT a2)
1487 {
1488         uint32_t vcoreid, coreid = core_id();
1489         if (current) {
1490                 vcoreid = get_vcoreid(current, coreid);
1491                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1492                        coreid, current->pid, vcoreid);
1493                 __unmap_vcore(current, vcoreid);
1494         }
1495         abandon_core();
1496         smp_idle();
1497 }
1498
1499 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1500  * addresses from a0 to a1. */
1501 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
1502                     void *a2)
1503 {
1504         /* TODO: (TLB) something more intelligent with the range */
1505         tlbflush();
1506 }
1507
1508 void print_idlecoremap(void)
1509 {
1510         spin_lock(&idle_lock);
1511         printk("There are %d idle cores.\n", num_idlecores);
1512         for (int i = 0; i < num_idlecores; i++)
1513                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1514         spin_unlock(&idle_lock);
1515 }
1516
1517 void print_allpids(void)
1518 {
1519         spin_lock(&pid_hash_lock);
1520         if (hashtable_count(pid_hash)) {
1521                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1522                 printk("PID      STATE    \n");
1523                 printk("------------------\n");
1524                 do {
1525                         struct proc *p = hashtable_iterator_value(phtable_i);
1526                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1527                                p ? procstate2str(p->state) : "(null)");
1528                 } while (hashtable_iterator_advance(phtable_i));
1529         }
1530         spin_unlock(&pid_hash_lock);
1531 }
1532
1533 void print_proc_info(pid_t pid)
1534 {
1535         int j = 0;
1536         struct proc *p = pid2proc(pid);
1537         if (!p) {
1538                 printk("Bad PID.\n");
1539                 return;
1540         }
1541         spinlock_debug(&p->proc_lock);
1542         //spin_lock(&p->proc_lock); // No locking!!
1543         printk("struct proc: %p\n", p);
1544         printk("PID: %d\n", p->pid);
1545         printk("PPID: %d\n", p->ppid);
1546         printk("State: 0x%08x\n", p->state);
1547         printk("Refcnt: %d\n", atomic_read(&p->kref.refcount) - 1);
1548         printk("Flags: 0x%08x\n", p->env_flags);
1549         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1550         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1551         printk("Vcoremap:\n");
1552         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1553                 j = get_busy_vcoreid(p, j);
1554                 printk("\tVcore %d: Pcore %d\n", j, get_pcoreid(p, j));
1555                 j++;
1556         }
1557         printk("Resources:\n");
1558         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1559                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1560                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1561         printk("Open Files:\n");
1562         struct files_struct *files = &p->open_files;
1563         spin_lock(&files->lock);
1564         for (int i = 0; i < files->max_files; i++)
1565                 if (files->fd_array[i].fd_file) {
1566                         printk("\tFD: %02d, File: %08p, File name: %s\n", i,
1567                                files->fd_array[i].fd_file,
1568                                file_name(files->fd_array[i].fd_file));
1569                 }
1570         spin_unlock(&files->lock);
1571         /* No one cares, and it clutters the terminal */
1572         //printk("Vcore 0's Last Trapframe:\n");
1573         //print_trapframe(&p->env_tf);
1574         /* no locking / unlocking or refcnting */
1575         // spin_unlock(&p->proc_lock);
1576         kref_put(&p->kref);
1577 }