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