80795f3ac90352c93b10c4e01f48f50dbeef69c3
[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 #include <event.h>
6 #include <arch/arch.h>
7 #include <bitmask.h>
8 #include <process.h>
9 #include <atomic.h>
10 #include <smp.h>
11 #include <pmap.h>
12 #include <trap.h>
13 #include <umem.h>
14 #include <schedule.h>
15 #include <manager.h>
16 #include <stdio.h>
17 #include <assert.h>
18 #include <time.h>
19 #include <hashtable.h>
20 #include <slab.h>
21 #include <sys/queue.h>
22 #include <monitor.h>
23 #include <elf.h>
24 #include <arsc_server.h>
25 #include <kmalloc.h>
26 #include <ros/procinfo.h>
27 #include <init.h>
28 #include <rcu.h>
29
30 struct kmem_cache *proc_cache;
31
32 /* Other helpers, implemented later. */
33 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
34 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
35 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid);
36 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid);
37 static void __proc_free(struct kref *kref);
38 static bool scp_is_vcctx_ready(struct preempt_data *vcpd);
39 static void save_vc_fp_state(struct preempt_data *vcpd);
40 static void restore_vc_fp_state(struct preempt_data *vcpd);
41
42 /* PID management. */
43 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
44 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
45 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
46 struct hashtable *pid_hash;
47 spinlock_t pid_hash_lock; // initialized in proc_init
48
49 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
50  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
51  * you'll also see a warning, for now).  Consider doing this with atomics. */
52 static pid_t get_free_pid(void)
53 {
54         static pid_t next_free_pid = 1;
55         pid_t my_pid = 0;
56
57         spin_lock(&pid_bmask_lock);
58         // atomically (can lock for now, then change to atomic_and_return
59         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
60                 // always points to the next to test
61                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
62                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
63                         SET_BITMASK_BIT(pid_bmask, i);
64                         my_pid = i;
65                         break;
66                 }
67         }
68         spin_unlock(&pid_bmask_lock);
69         if (!my_pid)
70                 warn("Unable to find a PID!  You need to deal with this!\n");
71         return my_pid;
72 }
73
74 /* Return a pid to the pid bitmask */
75 static void put_free_pid(pid_t pid)
76 {
77         spin_lock(&pid_bmask_lock);
78         CLR_BITMASK_BIT(pid_bmask, pid);
79         spin_unlock(&pid_bmask_lock);
80 }
81
82 /* 'resume' is the time int ticks of the most recent onlining.  'total' is the
83  * amount of time in ticks consumed up to and including the current offlining.
84  *
85  * We could move these to the map and unmap of vcores, though not every place
86  * uses that (SCPs, in particular).  However, maps/unmaps happen remotely;
87  * something to consider.  If we do it remotely, we can batch them up and do one
88  * rdtsc() for all of them.  For now, I want to do them on the core, around when
89  * we do the context change.  It'll also parallelize the accounting a bit. */
90 void vcore_account_online(struct proc *p, uint32_t vcoreid)
91 {
92         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
93
94         vc->resume_ticks = read_tsc();
95 }
96
97 void vcore_account_offline(struct proc *p, uint32_t vcoreid)
98 {
99         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
100         vc->total_ticks += read_tsc() - vc->resume_ticks;
101 }
102
103 uint64_t vcore_account_gettotal(struct proc *p, uint32_t vcoreid)
104 {
105         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
106
107         return vc->total_ticks;
108 }
109
110 /* While this could be done with just an assignment, this gives us the
111  * opportunity to check for bad transitions.  Might compile these out later, so
112  * we shouldn't rely on them for sanity checking from userspace.  */
113 int __proc_set_state(struct proc *p, uint32_t state)
114 {
115         uint32_t curstate = p->state;
116         /* Valid transitions:
117          * C   -> RBS
118          * C   -> D
119          * RBS -> RGS
120          * RGS -> RBS
121          * RGS -> W
122          * RGM -> W
123          * W   -> RBS
124          * W   -> RGS
125          * W   -> RBM
126          * W   -> D
127          * RGS -> RBM
128          * RBM -> RGM
129          * RGM -> RBM
130          * RGM -> RBS
131          * RGS -> D
132          * RGM -> D
133          * D   -> DA
134          *
135          * These ought to be implemented later (allowed, not thought through
136          * yet).
137          * RBS -> D
138          * RBM -> D
139          */
140         #if 1 // some sort of correctness flag
141         switch (curstate) {
142         case PROC_CREATED:
143                 if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
144                         goto invalid_state_transition;
145                 break;
146         case PROC_RUNNABLE_S:
147                 if (!(state & (PROC_RUNNING_S | PROC_DYING)))
148                         goto invalid_state_transition;
149                 break;
150         case PROC_RUNNING_S:
151                 if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING
152                                | PROC_DYING)))
153                         goto invalid_state_transition;
154                 break;
155         case PROC_WAITING:
156                 if (!(state & (PROC_RUNNABLE_S | PROC_RUNNING_S |
157                                PROC_RUNNABLE_M | PROC_DYING)))
158                         goto invalid_state_transition;
159                 break;
160         case PROC_DYING:
161                 if (state != PROC_DYING_ABORT)
162                         goto invalid_state_transition;
163                 break;
164         case PROC_DYING_ABORT:
165                 goto invalid_state_transition;
166         case PROC_RUNNABLE_M:
167                 if (!(state & (PROC_RUNNING_M | PROC_DYING)))
168                         goto invalid_state_transition;
169                 break;
170         case PROC_RUNNING_M:
171                 if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING
172                                | PROC_DYING)))
173                         goto invalid_state_transition;
174                 break;
175 invalid_state_transition:
176                 panic("Invalid State Transition! %s to %02x",
177                       procstate2str(state), state);
178         }
179         #endif
180         p->state = state;
181         return 0;
182 }
183
184 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
185  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
186  * process is dying and we should not have the ref (and thus return 0).  We need
187  * to lock to protect us from getting p, (someone else removes and frees p),
188  * then get_not_zero() on p.
189  * Don't push the locking into the hashtable without dealing with this. */
190 struct proc *pid2proc(pid_t pid)
191 {
192         spin_lock(&pid_hash_lock);
193         struct proc *p = hashtable_search(pid_hash, (void*)(long)pid);
194
195         if (p)
196                 if (!kref_get_not_zero(&p->p_kref, 1))
197                         p = 0;
198         spin_unlock(&pid_hash_lock);
199         return p;
200 }
201
202 /* Used by devproc for successive reads of the proc table.
203  * Returns a pointer to the nth proc, or 0 if there is none.
204  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
205  * process is dying and we should not have the ref (and thus return 0).  We need
206  * to lock to protect us from getting p, (someone else removes and frees p),
207  * then get_not_zero() on p.
208  * Don't push the locking into the hashtable without dealing with this. */
209 struct proc *pid_nth(unsigned int n)
210 {
211         struct proc *p;
212         spin_lock(&pid_hash_lock);
213         if (!hashtable_count(pid_hash)) {
214                 spin_unlock(&pid_hash_lock);
215                 return NULL;
216         }
217         struct hashtable_itr *iter = hashtable_iterator(pid_hash);
218         p = hashtable_iterator_value(iter);
219
220         while (p) {
221                 /* if this process is not valid, it doesn't count,
222                  * so continue
223                  */
224
225                 if (kref_get_not_zero(&p->p_kref, 1)) {
226                         /* this one counts */
227                         if (! n){
228                                 printd("pid_nth: at end, p %p\n", p);
229                                 break;
230                         }
231                         kref_put(&p->p_kref);
232                         n--;
233                 }
234                 if (!hashtable_iterator_advance(iter)) {
235                         p = NULL;
236                         break;
237                 }
238                 p = hashtable_iterator_value(iter);
239         }
240
241         spin_unlock(&pid_hash_lock);
242         kfree(iter);
243         return p;
244 }
245
246 /* Performs any initialization related to processes, such as create the proc
247  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
248  * any process related function. */
249 void proc_init(void)
250 {
251         /* Catch issues with the vcoremap and TAILQ_ENTRY sizes */
252         static_assert(sizeof(TAILQ_ENTRY(vcore)) == sizeof(void*) * 2);
253         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
254                                        MAX(ARCH_CL_SIZE,
255                                        __alignof__(struct proc)), 0, NULL, 0,
256                                        0, NULL);
257         /* Init PID mask and hash.  pid 0 is reserved. */
258         SET_BITMASK_BIT(pid_bmask, 0);
259         spinlock_init(&pid_hash_lock);
260         spin_lock(&pid_hash_lock);
261         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
262         spin_unlock(&pid_hash_lock);
263         schedule_init();
264
265         atomic_init(&num_envs, 0);
266 }
267
268 void proc_set_username(struct proc *p, char *name)
269 {
270         set_username(&p->user, name);
271 }
272
273 /*
274  * Copies username from the parent process. This is the only case where a
275  * reader blocks writing, just to be extra safe during process initialization.
276  *
277  * Note that since this is intended to be called during initialization, the
278  * child's name lock is NOT used for writing. Nothing else should be able to
279  * read or write yet, so this can be a simple memcpy once the parent is locked.
280  */
281 void proc_inherit_parent_username(struct proc *child, struct proc *parent)
282 {
283         spin_lock(&parent->user.name_lock);
284
285         // copy entire parent buffer for constant runtime
286         memcpy(child->user.name, parent->user.name, sizeof(child->user.name));
287
288         spin_unlock(&parent->user.name_lock);
289 }
290
291 void proc_set_progname(struct proc *p, char *name)
292 {
293         if (name == NULL)
294                 name = DEFAULT_PROGNAME;
295
296         /* might have an issue if a dentry name isn't null terminated, and we'd
297          * get extra junk up to progname_sz. Or crash. */
298         strlcpy(p->progname, name, PROC_PROGNAME_SZ);
299 }
300
301 void proc_replace_binary_path(struct proc *p, char *path)
302 {
303         if (p->binary_path)
304                 free_path(p, p->binary_path);
305         p->binary_path = path;
306 }
307
308 /* Be sure you init'd the vcore lists before calling this. */
309 void proc_init_procinfo(struct proc* p)
310 {
311         p->procinfo->pid = p->pid;
312         p->procinfo->ppid = p->ppid;
313         p->procinfo->max_vcores = max_vcores(p);
314         p->procinfo->tsc_freq = __proc_global_info.tsc_freq;
315         p->procinfo->timing_overhead = __proc_global_info.tsc_overhead;
316         p->procinfo->program_end = 0;
317         /* 0'ing the arguments.  Some higher function will need to set them */
318         memset(p->procinfo->res_grant, 0, sizeof(p->procinfo->res_grant));
319         /* 0'ing the vcore/pcore map.  Will link the vcores later. */
320         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
321         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
322         p->procinfo->num_vcores = 0;
323         p->procinfo->is_mcp = FALSE;
324         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
325         /* It's a bug in the kernel if we let them ask for more than max */
326         for (int i = 0; i < p->procinfo->max_vcores; i++) {
327                 TAILQ_INSERT_TAIL(&p->inactive_vcs, &p->procinfo->vcoremap[i],
328                                   list);
329         }
330 }
331
332 void proc_init_procdata(struct proc *p)
333 {
334         memset(p->procdata, 0, sizeof(struct procdata));
335         /* processes can't go into vc context on vc 0 til they unset this.  This
336          * is for processes that block before initing uthread code (like rtld).
337          */
338         atomic_set(&p->procdata->vcore_preempt_data[0].flags, VC_SCP_NOVCCTX);
339 }
340
341 static void proc_open_stdfds(struct proc *p)
342 {
343         int fd;
344         struct proc *old_current = current;
345
346         /* Due to the way the syscall helpers assume the target process is
347          * current, we need to set current temporarily.  We don't use switch_to,
348          * since that actually loads the process's address space, which might be
349          * empty or incomplete.  These syscalls shouldn't access user memory,
350          * especially considering how we're probably in the boot pgdir. */
351         current = p;
352         fd = sysopenat(AT_FDCWD, "#cons/stdin", O_READ, 0);
353         assert(fd == 0);
354         fd = sysopenat(AT_FDCWD, "#cons/stdout", O_WRITE, 0);
355         assert(fd == 1);
356         fd = sysopenat(AT_FDCWD, "#cons/stderr", O_WRITE, 0);
357         assert(fd == 2);
358         current = old_current;
359 }
360
361 /* Allocates and initializes a process, with the given parent.  Currently
362  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
363  * Errors include:
364  *  - ENOFREEPID if it can't get a PID
365  *  - ENOMEM on memory exhaustion */
366 error_t proc_alloc(struct proc **pp, struct proc *parent, int flags)
367 {
368         error_t r;
369         struct proc *p;
370
371         if (!(p = kmem_cache_alloc(proc_cache, 0)))
372                 return -ENOMEM;
373         /* zero everything by default, other specific items are set below */
374         memset(p, 0, sizeof(*p));
375
376         /* only one ref, which we pass back.  the old 'existence' ref is managed
377          * by the ksched */
378         kref_init(&p->p_kref, __proc_free, 1);
379         /* Initialize the address space */
380         if ((r = env_setup_vm(p)) < 0) {
381                 kmem_cache_free(proc_cache, p);
382                 return r;
383         }
384         if (!(p->pid = get_free_pid())) {
385                 kmem_cache_free(proc_cache, p);
386                 return -ENOFREEPID;
387         }
388         if (parent && parent->binary_path)
389                 kstrdup(&p->binary_path, parent->binary_path);
390         /* Set the basic status variables. */
391         spinlock_init(&p->proc_lock);
392         spinlock_init(&p->user.name_lock);
393         /* so we can see processes killed by the kernel */
394         p->exitcode = 1337;
395         if (parent) {
396                 p->ppid = parent->pid;
397                 proc_inherit_parent_username(p, parent);
398                 proc_incref(p, 1);      /* storing a ref in the parent */
399                 /* using the CV's lock to protect anything related to child
400                  * waiting */
401                 cv_lock(&parent->child_wait);
402                 TAILQ_INSERT_TAIL(&parent->children, p, sibling_link);
403                 cv_unlock(&parent->child_wait);
404         } else {
405                 p->ppid = 0;
406                 strlcpy(p->user.name, eve.name, sizeof(p->user.name));
407                 printk("Parentless process assigned username '%s'\n",
408                        p->user.name);
409         }
410         TAILQ_INIT(&p->children);
411         cv_init(&p->child_wait);
412         /* shouldn't go through state machine for init */
413         p->state = PROC_CREATED;
414         p->env_flags = 0;
415         spinlock_init(&p->vmr_lock);
416         spinlock_init(&p->pte_lock);
417         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
418         p->vmr_history = 0;
419         /* Initialize the vcore lists, we'll build the inactive list so that it
420          * includes all vcores when we initialize procinfo.  Do this before
421          * initing procinfo. */
422         TAILQ_INIT(&p->online_vcs);
423         TAILQ_INIT(&p->bulk_preempted_vcs);
424         TAILQ_INIT(&p->inactive_vcs);
425         /* Init procinfo/procdata.  Procinfo's argp/argb are 0'd */
426         proc_init_procinfo(p);
427         proc_init_procdata(p);
428
429         /* Initialize the generic sysevent ring buffer */
430         SHARED_RING_INIT(&p->procdata->syseventring);
431         /* Initialize the frontend of the sysevent ring buffer */
432         FRONT_RING_INIT(&p->syseventfrontring,
433                         &p->procdata->syseventring,
434                         SYSEVENTRINGSIZE);
435
436         /* Init FS structures TODO: cleanup (might pull this out) */
437         p->umask = parent ? parent->umask : S_IWGRP | S_IWOTH;
438         memset(&p->open_files, 0, sizeof(p->open_files)); /* slightly ghetto */
439         spinlock_init(&p->open_files.lock);
440         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
441         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
442         p->open_files.fd = p->open_files.fd_array;
443         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
444         if (parent) {
445                 if (flags & PROC_DUP_FGRP)
446                         clone_fdt(&parent->open_files, &p->open_files);
447         } else {
448                 /* no parent, we're created from the kernel */
449                 proc_open_stdfds(p);
450         }
451         /* Init the ucq hash lock */
452         p->ucq_hashlock = (struct hashlock*)&p->ucq_hl_noref;
453         hashlock_init_irqsave(p->ucq_hashlock, HASHLOCK_DEFAULT_SZ);
454
455         atomic_inc(&num_envs);
456         plan9setup(p, parent, flags);
457         devalarm_init(p);
458         TAILQ_INIT(&p->abortable_sleepers);
459         spinlock_init_irqsave(&p->abort_list_lock);
460         memset(&p->vmm, 0, sizeof(struct vmm));
461         spinlock_init(&p->vmm.lock);
462         qlock_init(&p->vmm.qlock);
463         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
464         *pp = p;
465         return 0;
466 }
467
468 /* We have a bunch of different ways to make processes.  Call this once the
469  * process is ready to be used by the rest of the system.  For now, this just
470  * means when it is ready to be named via the pidhash.  In the future, we might
471  * push setting the state to CREATED into here. */
472 void __proc_ready(struct proc *p)
473 {
474         /* Tell the ksched about us.  TODO: do we need to worry about the ksched
475          * doing stuff to us before we're added to the pid_hash? */
476         __sched_proc_register(p);
477         spin_lock(&pid_hash_lock);
478         hashtable_insert(pid_hash, (void*)(long)p->pid, p);
479         spin_unlock(&pid_hash_lock);
480 }
481
482 /* Creates a process from the specified file, argvs, and envps. */
483 struct proc *proc_create(struct file_or_chan *prog, char **argv, char **envp)
484 {
485         struct proc *p;
486         error_t r;
487         int ret;
488
489         if ((r = proc_alloc(&p, current, 0 /* flags */)) < 0)
490                 panic("proc_create: %d", r);
491         int argc = 0, envc = 0;
492         if(argv) while(argv[argc]) argc++;
493         if(envp) while(envp[envc]) envc++;
494         proc_set_progname(p, argc ? argv[0] : NULL);
495         ret = load_elf(p, prog, argc, argv, envc, envp);
496         assert(ret == 0);
497         __proc_ready(p);
498         return p;
499 }
500
501 static int __cb_assert_no_pg(struct proc *p, pte_t pte, void *va, void *arg)
502 {
503         assert(pte_is_unmapped(pte));
504         return 0;
505 }
506
507 /* This is called by kref_put(), once the last reference to the process is
508  * gone.  Don't call this otherwise (it will panic).  It will clean up the
509  * address space and deallocate any other used memory. */
510 static void __proc_free(struct kref *kref)
511 {
512         struct proc *p = container_of(kref, struct proc, p_kref);
513         void *hash_ret;
514         physaddr_t pa;
515
516         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0,
517                p->pid);
518         // All parts of the kernel should have decref'd before __proc_free is
519         // called
520         assert(kref_refcnt(&p->p_kref) == 0);
521         assert(TAILQ_EMPTY(&p->alarmset.list));
522
523         if (p->strace) {
524                 kref_put(&p->strace->procs);
525                 kref_put(&p->strace->users);
526         }
527         __vmm_struct_cleanup(p);
528         p->progname[0] = 0;
529         free_path(p, p->binary_path);
530         cclose(p->dot);
531         cclose(p->slash);
532         p->dot = p->slash = 0; /* catch bugs */
533         /* now we'll finally decref files for the file-backed vmrs */
534         unmap_and_destroy_vmrs(p);
535         /* Remove us from the pid_hash and give our PID back (in that order). */
536         spin_lock(&pid_hash_lock);
537         hash_ret = hashtable_remove(pid_hash, (void*)(long)p->pid);
538         spin_unlock(&pid_hash_lock);
539         /* might not be in the hash/ready, if we failed during proc creation */
540         if (hash_ret)
541                 put_free_pid(p->pid);
542         else
543                 printd("[kernel] pid %d not in the PID hash in %s\n", p->pid,
544                        __FUNCTION__);
545         /* All memory below UMAPTOP should have been freed via the VMRs.  The
546          * stuff above is the global info/page and procinfo/procdata.  We free
547          * procinfo and procdata, but not the global memory - that's system
548          * wide.  We could clear the PTEs of the upper stuff (UMAPTOP to UVPT),
549          * but we shouldn't need to. */
550         env_user_mem_walk(p, 0, UMAPTOP, __cb_assert_no_pg, 0);
551         kpages_free(p->procinfo, PROCINFO_NUM_PAGES * PGSIZE);
552         kpages_free(p->procdata, PROCDATA_NUM_PAGES * PGSIZE);
553
554         env_pagetable_free(p);
555         arch_pgdir_clear(&p->env_pgdir);
556         p->env_cr3 = 0;
557
558         atomic_dec(&num_envs);
559
560         /* Dealloc the struct proc */
561         kmem_cache_free(proc_cache, p);
562 }
563
564 /* Whether or not actor can control target.  TODO: do something reasonable here.
565  * Just checking for the parent is a bit limiting.  Could walk the parent-child
566  * tree, check user ids, or some combination.  Make sure actors can always
567  * control themselves. */
568 bool proc_controls(struct proc *actor, struct proc *target)
569 {
570         return TRUE;
571         #if 0 /* Example: */
572         return ((actor == target) || (target->ppid == actor->pid));
573         #endif
574 }
575
576 /* Helper to incref by val.  Using the helper to help debug/interpose on proc
577  * ref counting.  Note that pid2proc doesn't use this interface. */
578 void proc_incref(struct proc *p, unsigned int val)
579 {
580         kref_get(&p->p_kref, val);
581 }
582
583 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
584 void proc_decref(struct proc *p)
585 {
586         kref_put(&p->p_kref);
587 }
588
589 /* Helper, makes p the 'current' process, dropping the old current/cr3.  This no
590  * longer assumes the passed in reference already counted 'current'.  It will
591  * incref internally when needed. */
592 static void __set_proc_current(struct proc *p)
593 {
594         /* We use the pcpui to access 'current' to cut down on the core_id()
595          * calls, though who know how expensive/painful they are. */
596         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
597         struct proc *old_proc;
598
599         /* If the process wasn't here, then we need to load its address space */
600         if (p != pcpui->cur_proc) {
601                 proc_incref(p, 1);
602                 lcr3(p->env_cr3);
603                 /* This is "leaving the process context" of the previous proc.
604                  * The previous lcr3 unloaded the previous proc's context.  This
605                  * should rarely happen, since we usually proactively leave
606                  * process context, but this is the fallback. */
607                 old_proc = pcpui->cur_proc;
608                 pcpui->cur_proc = p;
609                 if (old_proc)
610                         proc_decref(old_proc);
611         }
612 }
613
614 /* Flag says if vcore context is not ready, which is set in init_procdata.  The
615  * process must turn off this flag on vcore0 at some point.  It's off by default
616  * on all other vcores. */
617 static bool scp_is_vcctx_ready(struct preempt_data *vcpd)
618 {
619         return !(atomic_read(&vcpd->flags) & VC_SCP_NOVCCTX);
620 }
621
622 /* Dispatches a _S process to run on the current core.  This should never be
623  * called to "restart" a core.
624  *
625  * This will always return, regardless of whether or not the calling core is
626  * being given to a process. (it used to pop the tf directly, before we had
627  * cur_ctx).
628  *
629  * Since it always returns, it will never "eat" your reference (old
630  * documentation talks about this a bit). */
631 void proc_run_s(struct proc *p)
632 {
633         uint32_t coreid = core_id();
634         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
635         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
636
637         spin_lock(&p->proc_lock);
638         switch (p->state) {
639         case (PROC_DYING):
640         case (PROC_DYING_ABORT):
641                 spin_unlock(&p->proc_lock);
642                 printk("[kernel] _S %d not starting: async death\n",
643                        p->pid);
644                 return;
645         case (PROC_RUNNABLE_S):
646                 __proc_set_state(p, PROC_RUNNING_S);
647                 /* SCPs don't have full vcores, but they act like they have
648                  * vcore 0.  We map the vcore, since we will want to know where
649                  * this process is running, even if it is only in RUNNING_S.  We
650                  * can use the vcoremap, which makes death easy.  num_vcores is
651                  * still 0, and we do account the time online and offline. */
652                 __seq_start_write(&p->procinfo->coremap_seqctr);
653                 p->procinfo->num_vcores = 0;
654                 __map_vcore(p, 0, coreid);
655                 vcore_account_online(p, 0);
656                 __seq_end_write(&p->procinfo->coremap_seqctr);
657                 /* incref, since we're saving a reference in owning proc later*/
658                 proc_incref(p, 1);
659                 /* lock was protecting the state and VC mapping, not pcpui stuff
660                  */
661                 spin_unlock(&p->proc_lock);
662                 /* redundant with proc_startcore, might be able to remove that
663                  * one */
664                 __set_proc_current(p);
665                 /* set us up as owning_proc.  ksched bug if there is already
666                  * one, for now.  can simply clear_owning if we want to. */
667                 assert(!pcpui->owning_proc);
668                 pcpui->owning_proc = p;
669                 pcpui->owning_vcoreid = 0;
670                 restore_vc_fp_state(vcpd);
671                 /* similar to the old __startcore, start them in vcore context
672                  * if they have notifs and aren't already in vcore context.
673                  * o/w, start them wherever they were before (could be either vc
674                  * ctx or not) */
675                 if (!vcpd->notif_disabled && vcpd->notif_pending
676                                           && scp_is_vcctx_ready(vcpd)) {
677                         vcpd->notif_disabled = TRUE;
678                         /* save the _S's ctx in the uthread slot, build and pop
679                          * a new one in actual/cur_ctx. */
680                         vcpd->uthread_ctx = p->scp_ctx;
681                         pcpui->cur_ctx = &pcpui->actual_ctx;
682                         memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
683                         proc_init_ctx(pcpui->cur_ctx, 0, vcpd->vcore_entry,
684                                       vcpd->vcore_stack, vcpd->vcore_tls_desc);
685                 } else {
686                         /* If they have no transition stack, then they can't
687                          * receive events.  The most they are getting is a
688                          * wakeup from the kernel.  They won't even turn off
689                          * notif_pending, so we'll do that for them. */
690                         if (!scp_is_vcctx_ready(vcpd))
691                                 vcpd->notif_pending = FALSE;
692                         /* this is one of the few times cur_ctx != &actual_ctx*/
693                         pcpui->cur_ctx = &p->scp_ctx;
694                 }
695                 /* When the calling core idles, it'll call restartcore and run
696                  * the _S process's context. */
697                 return;
698         default:
699                 spin_unlock(&p->proc_lock);
700                 panic("Invalid process state %p in %s()!!", p->state,
701                       __FUNCTION__);
702         }
703 }
704
705 /* Helper: sends preempt messages to all vcores on the bulk preempt list, and
706  * moves them to the inactive list. */
707 static void __send_bulkp_events(struct proc *p)
708 {
709         struct vcore *vc_i, *vc_temp;
710         struct event_msg preempt_msg = {0};
711
712         /* Whenever we send msgs with the proc locked, we need at least 1 online
713          */
714         assert(!TAILQ_EMPTY(&p->online_vcs));
715         /* Send preempt messages for any left on the BP list.  No need to set
716          * any flags, it all was done on the real preempt.  Now we're just
717          * telling the process about any that didn't get restarted and are still
718          * preempted. */
719         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
720                 /* Note that if there are no active vcores, send_k_e will post
721                  * to our own vcore, the last of which will be put on the
722                  * inactive list and be the first to be started.  We could have
723                  * issues with deadlocking, since send_k_e() could grab the
724                  * proclock (if there are no active vcores) */
725                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
726                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i); /* arg2 32 bits */
727                 send_kernel_event(p, &preempt_msg, 0);
728                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does
729                  * that.  We need a loop for the messages, but not necessarily
730                  * for the list changes.  */
731                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
732                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
733         }
734 }
735
736 /* Run an _M.  Can be called safely on one that is already running.  Hold the
737  * lock before calling.  Other than state checks, this just starts up the _M's
738  * vcores, much like the second part of give_cores_running.  More specifically,
739  * give_cores_runnable puts cores on the online list, which this then sends
740  * messages to.  give_cores_running immediately puts them on the list and sends
741  * the message.  the two-step style may go out of fashion soon.
742  *
743  * This expects that the "instructions" for which core(s) to run this on will be
744  * in the vcoremap, which needs to be set externally (give_cores()). */
745 void __proc_run_m(struct proc *p)
746 {
747         struct vcore *vc_i;
748         switch (p->state) {
749         case (PROC_WAITING):
750         case (PROC_DYING):
751         case (PROC_DYING_ABORT):
752                 warn("ksched tried to run proc %d in state %s\n", p->pid,
753                      procstate2str(p->state));
754                 return;
755         case (PROC_RUNNABLE_M):
756                 /* vcoremap[i] holds the coreid of the physical core allocated
757                  * to this process.  It is set outside proc_run. */
758                 if (p->procinfo->num_vcores) {
759                         __send_bulkp_events(p);
760                         __proc_set_state(p, PROC_RUNNING_M);
761                         /* Up the refcnt, to avoid the n refcnt upping on the
762                          * destination cores.  Keep in sync with __startcore */
763                         proc_incref(p, p->procinfo->num_vcores * 2);
764                         /* Send kernel messages to all online vcores (which were
765                          * added to the list and mapped in __proc_give_cores()),
766                          * making them turn online */
767                         TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
768                                 send_kernel_message(vc_i->pcoreid, __startcore,
769                                         (long)p,
770                                         (long)vcore2vcoreid(p, vc_i),
771                                         (long)vc_i->nr_preempts_sent,
772                                         KMSG_ROUTINE);
773                         }
774                 } else {
775                         warn("Tried to proc_run() an _M with no vcores!");
776                 }
777                 /* There a subtle race avoidance here (when we unlock after
778                  * sending the message).  __proc_startcore can handle a death
779                  * message, but we can't have the startcore come after the death
780                  * message.  Otherwise, it would look like a new process.  So we
781                  * hold the lock til after we send our message, which prevents a
782                  * possible death message.
783                  * - Note there is no guarantee this core's interrupts were on,
784                  *   so it may not get the message for a while... */
785                 return;
786         case (PROC_RUNNING_M):
787                 return;
788         default:
789                 /* unlock just so the monitor can call something that might
790                  * lock*/
791                 spin_unlock(&p->proc_lock);
792                 panic("Invalid process state %p in %s()!!", p->state,
793                       __FUNCTION__);
794         }
795 }
796
797 /* You must disable IRQs and PRKM before calling this.
798  *
799  * Actually runs the given context (trapframe) of process p on the core this
800  * code executes on.  This is called directly by __startcore, which needs to
801  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
802  *
803  * A note on refcnting: this function will not return, and your proc reference
804  * will be ignored (not decreffed).  It may be incref'd, if cur_proc was not
805  * set.  Pass in an already-accounted-for ref, such as owning_proc. */
806 void __proc_startcore(struct proc *p, struct user_context *ctx)
807 {
808         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
809
810         assert(!irq_is_enabled());
811         /* Should never have ktask still set.  If we do, future syscalls could
812          * try to block later and lose track of our address space. */
813         assert(!is_ktask(pcpui->cur_kthread));
814         __set_proc_current(p);
815         __set_cpu_state(pcpui, CPU_STATE_USER);
816         proc_pop_ctx(ctx);
817 }
818
819 /* Restarts/runs the current_ctx, which must be for the current process, on the
820  * core this code executes on.
821  *
822  * For now, we just smp_idle.  We used to do something similar, but customized
823  * for expecting to return to the process.  But it was a source of bugs.  If we
824  * want to optimize for the case where we know we had a process current, then we
825  * can do so here.
826  *
827  * Note that PRKM currently calls smp_idle() if it ever has a message, so the
828  * value of optimizing may depend on the semantics of PRKM. */
829 void proc_restartcore(void)
830 {
831         smp_idle();
832 }
833
834 /* Helper for proc_destroy.  Disowns any children. */
835 static void proc_disown_children(struct proc *parent)
836 {
837         struct proc *child_i, *temp;
838         struct proc_list todo = TAILQ_HEAD_INITIALIZER(todo);
839         int ret;
840
841         cv_lock(&parent->child_wait);
842         TAILQ_FOREACH_SAFE(child_i, &parent->children, sibling_link, temp) {
843                 ret = __proc_disown_child(parent, child_i);
844                 /* should never fail, lock should cover the race.  invariant:
845                  * any child on the list should have us as a parent */
846                 assert(!ret);
847                 TAILQ_INSERT_TAIL(&todo, child_i, sibling_link);
848         }
849         cv_unlock(&parent->child_wait);
850
851         TAILQ_FOREACH_SAFE(child_i, &todo, sibling_link, temp)
852                 proc_decref(child_i);
853 }
854
855 /* Destroys the process.  It will destroy the process and return any cores
856  * to the ksched via the __sched_proc_destroy() CB.
857  *
858  * Here's the way process death works:
859  * 0. grab the lock (protects state transition and core map)
860  * 1. set state to dying.  that keeps the kernel from doing anything for the
861  * process (like proc_running it).
862  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
863  * 3. IPI to clean up those cores (decref, etc).
864  * 4. Unlock
865  * 5. Clean up your core, if applicable
866  * (Last core/kernel thread to decref cleans up and deallocates resources.)
867  *
868  * Note that some cores can be processing async calls, but will eventually
869  * decref.  Should think about this more, like some sort of callback/revocation.
870  *
871  * This function will now always return (it used to not return if the calling
872  * core was dying).  However, when it returns, a kernel message will eventually
873  * come in, making you abandon_core, as if you weren't running.  It may be that
874  * the only reference to p is the one you passed in, and when you decref, it'll
875  * get __proc_free()d. */
876 void proc_destroy(struct proc *p)
877 {
878         uint32_t nr_cores_revoked = 0;
879         struct kthread *sleeper;
880         struct proc *child_i, *temp;
881
882         spin_lock(&p->proc_lock);
883         /* storage for pc_arr is alloced at decl, which is after grabbing the
884          * lock*/
885         uint32_t pc_arr[p->procinfo->num_vcores];
886         switch (p->state) {
887         case PROC_DYING: /* someone else killed this already. */
888         case (PROC_DYING_ABORT):
889                 spin_unlock(&p->proc_lock);
890                 return;
891         case PROC_CREATED:
892         case PROC_RUNNABLE_S:
893         case PROC_WAITING:
894                 break;
895         case PROC_RUNNABLE_M:
896         case PROC_RUNNING_M:
897                 /* Need to reclaim any cores this proc might have, even if it's
898                  * not running yet.  Those running will receive a __death */
899                 nr_cores_revoked = __proc_take_allcores(p, pc_arr, FALSE);
900                 break;
901         case PROC_RUNNING_S:
902                 #if 0
903                 // here's how to do it manually
904                 if (current == p) {
905                         lcr3(boot_cr3);
906                         current = NULL;
907                         proc_decref(p);         /* this decref is for the cr3 */
908                 }
909                 #endif
910                 send_kernel_message(get_pcoreid(p, 0), __death, (long)p, 0, 0,
911                                     KMSG_ROUTINE);
912                 __seq_start_write(&p->procinfo->coremap_seqctr);
913                 __unmap_vcore(p, 0);
914                 __seq_end_write(&p->procinfo->coremap_seqctr);
915                 /* If we ever have RUNNING_S run on non-mgmt cores, we'll need
916                  * to tell the ksched about this now-idle core (after unlocking)
917                  */
918                 break;
919         default:
920                 warn("Weird state(%s) in %s()", procstate2str(p->state),
921                      __FUNCTION__);
922                 spin_unlock(&p->proc_lock);
923                 return;
924         }
925         /* At this point, a death IPI should be on its way, either from the
926          * RUNNING_S one, or from proc_take_cores with a __death.  in general,
927          * interrupts should be on when you call proc_destroy locally, but
928          * currently aren't for all things (like traphandlers). */
929         __proc_set_state(p, PROC_DYING);
930         spin_unlock(&p->proc_lock);
931         proc_disown_children(p);
932         /* Wake any of our kthreads waiting on children, so they can abort */
933         cv_broadcast(&p->child_wait);
934         /* we need to close files here, and not in free, since we could have a
935          * refcnt indirectly related to one of our files.  specifically, if we
936          * have a parent sleeping on our pipe, that parent won't wake up to
937          * decref until the pipe closes.  And if the parent doesnt decref, we
938          * don't free.  Even if we send a SIGCHLD to the parent, that would
939          * require that the parent to never ignores that signal (or we risk
940          * never reaping).
941          *
942          * Also note that any mmap'd files will still be mmapped.  You can close
943          * the file after mmapping, with no effect. */
944         close_fdt(&p->open_files, FALSE);
945         /* Abort any abortable syscalls.  This won't catch every sleeper, but
946          * future abortable sleepers are already prevented via the DYING_ABORT
947          * state.  (signalled DYING_ABORT, no new sleepers will block, and now
948          * we wake all old sleepers). */
949         __proc_set_state(p, PROC_DYING_ABORT);
950         abort_all_sysc(p);
951         /* Tell the ksched about our death, and which cores we freed up */
952         __sched_proc_destroy(p, pc_arr, nr_cores_revoked);
953         /* Tell our parent about our state change (to DYING) */
954         proc_signal_parent(p);
955 }
956
957 /* Can use this to signal anything that might cause a parent to wait on the
958  * child, such as termination, or signals.  Change the state or whatever before
959  * calling. */
960 void proc_signal_parent(struct proc *child)
961 {
962         struct kthread *sleeper;
963         struct proc *parent = pid2proc(child->ppid);
964         if (!parent)
965                 return;
966         send_posix_signal(parent, SIGCHLD);
967         /* there could be multiple kthreads sleeping for various reasons.  even
968          * an SCP could have multiple async syscalls. */
969         cv_broadcast(&parent->child_wait);
970         /* if the parent was waiting, there's a __launch kthread KMSG out there
971          */
972         proc_decref(parent);
973 }
974
975 /* Called when a parent is done with its child, and no longer wants to track the
976  * child, nor to allow the child to track it.  Call with a lock (cv) held.
977  * Returns 0 if we disowned, -1 on failure.
978  *
979  * If we disowned, (ret == 0), the caller must decref the child. */
980 int __proc_disown_child(struct proc *parent, struct proc *child)
981 {
982         /* Bail out if the child has already been reaped */
983         if (!child->ppid)
984                 return -1;
985         assert(child->ppid == parent->pid);
986         /* lock protects from concurrent inserts / removals from the list */
987         TAILQ_REMOVE(&parent->children, child, sibling_link);
988         /* After this, the child won't be able to get more refs to us, but it
989          * may still have some references in running code. */
990         child->ppid = 0;
991         return 0;
992 }
993
994 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
995  * process.  Returns 0 if it succeeded, an error code otherwise. */
996 int proc_change_to_m(struct proc *p)
997 {
998         int retval = 0;
999         spin_lock(&p->proc_lock);
1000         /* in case userspace erroneously tries to change more than once */
1001         if (__proc_is_mcp(p))
1002                 goto error_out;
1003         switch (p->state) {
1004         case (PROC_RUNNING_S):
1005                 /* issue with if we're async or not (need to preempt it)
1006                  * either of these should trip it. TODO: (ACR) async core req */
1007                 if ((current != p) || (get_pcoreid(p, 0) != core_id()))
1008                         panic("We don't handle async RUNNING_S core requests");
1009                 struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
1010
1011                 assert(current_ctx);
1012                 /* Copy uthread0's context to VC 0's uthread slot */
1013                 copy_current_ctx_to(&vcpd->uthread_ctx);
1014                 clear_owning_proc(core_id());   /* so we don't restart */
1015                 save_vc_fp_state(vcpd);
1016                 /* Userspace needs to not fuck with notif_disabled before
1017                  * transitioning to _M. */
1018                 if (vcpd->notif_disabled) {
1019                         printk("[kernel] user bug: notifs disabled for vcore 0\n");
1020                         vcpd->notif_disabled = FALSE;
1021                 }
1022                 /* in the async case, we'll need to remotely stop and bundle
1023                  * vcore0's TF.  this is already done for the sync case (local
1024                  * syscall). */
1025                 /* this process no longer runs on its old location (which is
1026                  * this core, for now, since we don't handle async calls) */
1027                 __seq_start_write(&p->procinfo->coremap_seqctr);
1028                 // TODO: (ACR) will need to unmap remotely (receive-side)
1029                 __unmap_vcore(p, 0);
1030                 vcore_account_offline(p, 0);
1031                 __seq_end_write(&p->procinfo->coremap_seqctr);
1032                 /* change to runnable_m (it's TF is already saved) */
1033                 __proc_set_state(p, PROC_RUNNABLE_M);
1034                 p->procinfo->is_mcp = TRUE;
1035                 spin_unlock(&p->proc_lock);
1036                 /* Tell the ksched that we're a real MCP now! */
1037                 __sched_proc_change_to_m(p);
1038                 return 0;
1039         case (PROC_RUNNABLE_S):
1040                 /* Issues: being on the runnable_list, proc_set_state not liking
1041                  * it, and not clearly thinking through how this would happen.
1042                  * Perhaps an async call that gets serviced after you're
1043                  * descheduled? */
1044                 warn("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
1045                 goto error_out;
1046         case (PROC_DYING):
1047         case (PROC_DYING_ABORT):
1048                 warn("Dying, core request coming from %d\n", core_id());
1049                 goto error_out;
1050         default:
1051                 goto error_out;
1052         }
1053 error_out:
1054         spin_unlock(&p->proc_lock);
1055         return -EINVAL;
1056 }
1057
1058 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
1059  * becoming the new 'thread0'.  Don't use this.  Caller needs to send in a
1060  * pc_arr big enough for all vcores.  Will return the number of cores given up
1061  * by the proc. */
1062 uint32_t __proc_change_to_s(struct proc *p, uint32_t *pc_arr)
1063 {
1064         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
1065         uint32_t num_revoked;
1066
1067         /* Not handling vcore accounting.  Do so if we ever use this */
1068         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
1069         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
1070         /* save the context, to be restarted in _S mode */
1071         assert(current_ctx);
1072         copy_current_ctx_to(&p->scp_ctx);
1073         clear_owning_proc(core_id());   /* so we don't restart */
1074         save_vc_fp_state(vcpd);
1075         /* sending death, since it's not our job to save contexts or anything in
1076          * this case. */
1077         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
1078         __proc_set_state(p, PROC_RUNNABLE_S);
1079         return num_revoked;
1080 }
1081
1082 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
1083  * careful. */
1084 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
1085 {
1086         return p->procinfo->pcoremap[pcoreid].valid;
1087 }
1088
1089 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
1090  * No locking involved, be careful.  Panics on failure. */
1091 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
1092 {
1093         assert(is_mapped_vcore(p, pcoreid));
1094         return p->procinfo->pcoremap[pcoreid].vcoreid;
1095 }
1096
1097 /* Helper function.  Try to find the pcoreid for a given virtual core id for
1098  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
1099  * stale or otherwise 'wrong' answer. */
1100 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
1101 {
1102         return p->procinfo->vcoremap[vcoreid].pcoreid;
1103 }
1104
1105 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
1106  * No locking involved, be careful.  Panics on failure. */
1107 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
1108 {
1109         assert(vcore_is_mapped(p, vcoreid));
1110         return try_get_pcoreid(p, vcoreid);
1111 }
1112
1113 /* Saves the FP state of the calling core into VCPD.  Pairs with
1114  * restore_vc_fp_state().  On x86, the best case overhead of the flags:
1115  *              FNINIT: 36 ns
1116  *              FXSAVE: 46 ns
1117  *              FXRSTR: 42 ns
1118  *              Flagged FXSAVE: 50 ns
1119  *              Flagged FXRSTR: 66 ns
1120  *              Excess flagged FXRSTR: 42 ns
1121  * If we don't do it, we'll need to initialize every VCPD at process creation
1122  * time with a good FPU state (x86 control words are initialized as 0s, like the
1123  * rest of VCPD). */
1124 static void save_vc_fp_state(struct preempt_data *vcpd)
1125 {
1126         save_fp_state(&vcpd->preempt_anc);
1127         vcpd->rflags |= VC_FPU_SAVED;
1128 }
1129
1130 /* Conditionally restores the FP state from VCPD.  If the state was not valid,
1131  * we don't bother restoring and just initialize the FPU. */
1132 static void restore_vc_fp_state(struct preempt_data *vcpd)
1133 {
1134         if (vcpd->rflags & VC_FPU_SAVED) {
1135                 restore_fp_state(&vcpd->preempt_anc);
1136                 vcpd->rflags &= ~VC_FPU_SAVED;
1137         } else {
1138                 init_fp_state();
1139         }
1140 }
1141
1142 /* Helper for SCPs, saves the core's FPU state into the VCPD vc0 slot */
1143 void __proc_save_fpu_s(struct proc *p)
1144 {
1145         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
1146
1147         save_vc_fp_state(vcpd);
1148 }
1149
1150 /* Helper: saves the SCP's GP tf state and unmaps vcore 0.  This does *not* save
1151  * the FPU state.
1152  *
1153  * In the future, we'll probably use vc0's space for scp_ctx and the silly
1154  * state.  If we ever do that, we'll need to stop using scp_ctx (soon to be in
1155  * VCPD) as a location for pcpui->cur_ctx to point (dangerous) */
1156 void __proc_save_context_s(struct proc *p)
1157 {
1158         copy_current_ctx_to(&p->scp_ctx);
1159         __seq_start_write(&p->procinfo->coremap_seqctr);
1160         __unmap_vcore(p, 0);
1161         __seq_end_write(&p->procinfo->coremap_seqctr);
1162         vcore_account_offline(p, 0);
1163 }
1164
1165 /* Yields the calling core.  Must be called locally (not async) for now.
1166  * - If RUNNING_S, you just give up your time slice and will eventually return,
1167  *   possibly after WAITING on an event.
1168  * - If RUNNING_M, you give up the current vcore (which never returns), and
1169  *   adjust the amount of cores wanted/granted.
1170  * - If you have only one vcore, you switch to WAITING.  There's no 'classic
1171  *   yield' for MCPs (at least not now).  When you run again, you'll have one
1172  *   guaranteed core, starting from the entry point.
1173  *
1174  * If the call is being nice, it means different things for SCPs and MCPs.  For
1175  * MCPs, it means that it is in response to a preemption (which needs to be
1176  * checked).  If there is no preemption pending, just return.  For SCPs, it
1177  * means the proc wants to give up the core, but still has work to do.  If not,
1178  * the proc is trying to wait on an event.  It's not being nice to others, it
1179  * just has no work to do.
1180  *
1181  * This usually does not return (smp_idle()), so it will eat your reference.
1182  * Also note that it needs a non-current/edible reference, since it will abandon
1183  * and continue to use the *p (current == 0, no cr3, etc).
1184  *
1185  * We disable interrupts for most of it too, since we need to protect
1186  * current_ctx and not race with __notify (which doesn't play well with
1187  * concurrent yielders). */
1188 void proc_yield(struct proc *p, bool being_nice)
1189 {
1190         uint32_t vcoreid, pcoreid = core_id();
1191         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
1192         struct vcore *vc;
1193         struct preempt_data *vcpd;
1194
1195         /* Need to lock to prevent concurrent vcore changes (online, inactive,
1196          * the mapping, etc).  This plus checking the nr_preempts is enough to
1197          * tell if our vcoreid and cur_ctx ought to be here still or if we
1198          * should abort */
1199         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
1200         switch (p->state) {
1201         case (PROC_RUNNING_S):
1202                 if (!being_nice) {
1203                         /* waiting for an event to unblock us */
1204                         vcpd = &p->procdata->vcore_preempt_data[0];
1205                         /* syncing with event's SCP code.  we set waiting, then
1206                          * check pending.  they set pending, then check waiting.
1207                          * it's not possible for us to miss the notif *and* for
1208                          * them to miss WAITING.  one (or both) of us will see
1209                          * and make sure the proc wakes up.  */
1210                         __proc_set_state(p, PROC_WAITING);
1211                         /* don't let the state write pass the notif read */
1212                         wrmb();
1213                         if (vcpd->notif_pending) {
1214                                 __proc_set_state(p, PROC_RUNNING_S);
1215                                 /* they can't handle events, just need to
1216                                  * prevent a yield.  (note the notif_pendings
1217                                  * are collapsed). */
1218                                 if (!scp_is_vcctx_ready(vcpd))
1219                                         vcpd->notif_pending = FALSE;
1220                                 goto out_failed;
1221                         }
1222                         /* if we're here, we want to sleep.  a concurrent event
1223                          * that hasn't already written notif_pending will have
1224                          * seen WAITING, and will be spinning while we do this.
1225                          * */
1226                         __proc_save_context_s(p);
1227                         spin_unlock(&p->proc_lock);
1228                 } else {
1229                         /* yielding to allow other processes to run.  we're
1230                          * briefly WAITING, til we are woken up */
1231                         __proc_set_state(p, PROC_WAITING);
1232                         __proc_save_context_s(p);
1233                         spin_unlock(&p->proc_lock);
1234                         /* immediately wake up the proc (makes it runnable) */
1235                         proc_wakeup(p);
1236                 }
1237                 goto out_yield_core;
1238         case (PROC_RUNNING_M):
1239                 break;                  /* will handle this stuff below */
1240         case (PROC_DYING):              /* incoming __death */
1241         case (PROC_DYING_ABORT):
1242         case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1243                 goto out_failed;
1244         default:
1245                 panic("Weird state(%s) in %s()", procstate2str(p->state),
1246                       __FUNCTION__);
1247         }
1248         /* This is which vcore this pcore thinks it is, regardless of any
1249          * unmappings that may have happened remotely (with __PRs waiting to
1250          * run) */
1251         vcoreid = pcpui->owning_vcoreid;
1252         vc = vcoreid2vcore(p, vcoreid);
1253         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1254         /* This is how we detect whether or not a __PR happened. */
1255         if (vc->nr_preempts_sent != vc->nr_preempts_done)
1256                 goto out_failed;
1257         /* Sanity checks.  If we were preempted or are dying, we should have
1258          * noticed by now. */
1259         assert(is_mapped_vcore(p, pcoreid));
1260         assert(vcoreid == get_vcoreid(p, pcoreid));
1261         /* no reason to be nice, return */
1262         if (being_nice && !vc->preempt_pending)
1263                 goto out_failed;
1264         /* At this point, AFAIK there should be no preempt/death messages on the
1265          * way, and we're on the online list.  So we'll go ahead and do the
1266          * yielding business. */
1267         /* If there's a preempt pending, we don't need to preempt later since we
1268          * are yielding (nice or otherwise).  If not, this is just a regular
1269          * yield. */
1270         if (vc->preempt_pending) {
1271                 vc->preempt_pending = 0;
1272         } else {
1273                 /* Optional: on a normal yield, check to see if we are putting
1274                  * them below amt_wanted (help with user races) and bail. */
1275                 if (p->procdata->res_req[RES_CORES].amt_wanted >=
1276                                        p->procinfo->num_vcores)
1277                         goto out_failed;
1278         }
1279         /* Don't let them yield if they are missing a notification.  Userspace
1280          * must not leave vcore context without dealing with notif_pending.
1281          * pop_user_ctx() handles leaving via uthread context.  This handles
1282          * leaving via a yield.
1283          *
1284          * This early check is an optimization.  The real check is below when it
1285          * works with the online_vcs list (syncing with event.c and INDIR/IPI
1286          * posting). */
1287         if (vcpd->notif_pending)
1288                 goto out_failed;
1289         /* Now we'll actually try to yield */
1290         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
1291                get_vcoreid(p, pcoreid));
1292         /* Remove from the online list, add to the yielded list, and unmap
1293          * the vcore, which gives up the core. */
1294         TAILQ_REMOVE(&p->online_vcs, vc, list);
1295         /* Now that we're off the online list, check to see if an alert made
1296          * it through (event.c sets this) */
1297         wrmb(); /* prev write must hit before reading notif_pending */
1298         /* Note we need interrupts disabled, since a __notify can come in
1299          * and set pending to FALSE */
1300         if (vcpd->notif_pending) {
1301                 /* We lost, put it back on the list and abort the yield.  If we
1302                  * ever build an myield, we'll need a way to deal with this for
1303                  * all vcores */
1304                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
1305                 goto out_failed;
1306         }
1307         /* Not really a kmsg, but it acts like one w.r.t. proc mgmt */
1308         pcpui_trace_kmsg(pcpui, (uintptr_t)proc_yield);
1309         /* We won the race with event sending, we can safely yield */
1310         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1311         /* Note this protects stuff userspace should look at, which doesn't
1312          * include the TAILQs. */
1313         __seq_start_write(&p->procinfo->coremap_seqctr);
1314         /* Next time the vcore starts, it starts fresh */
1315         vcpd->notif_disabled = FALSE;
1316         __unmap_vcore(p, vcoreid);
1317         p->procinfo->num_vcores--;
1318         p->procinfo->res_grant[RES_CORES] = p->procinfo->num_vcores;
1319         __seq_end_write(&p->procinfo->coremap_seqctr);
1320         vcore_account_offline(p, vcoreid);
1321         /* No more vcores?  Then we wait on an event */
1322         if (p->procinfo->num_vcores == 0) {
1323                 /* consider a ksched op to tell it about us WAITING */
1324                 __proc_set_state(p, PROC_WAITING);
1325         }
1326         spin_unlock(&p->proc_lock);
1327         /* We discard the current context, but we still need to restore the core
1328          */
1329         arch_finalize_ctx(pcpui->cur_ctx);
1330         /* Hand the now-idle core to the ksched */
1331         __sched_put_idle_core(p, pcoreid);
1332         goto out_yield_core;
1333 out_failed:
1334         /* for some reason we just want to return, either to take a KMSG that
1335          * cleans us up, or because we shouldn't yield (ex: notif_pending). */
1336         spin_unlock(&p->proc_lock);
1337         return;
1338 out_yield_core:                         /* successfully yielded the core */
1339         proc_decref(p);                 /* need to eat the ref passed in */
1340         /* Clean up the core and idle. */
1341         clear_owning_proc(pcoreid);     /* so we don't restart */
1342         abandon_core();
1343         smp_idle();
1344 }
1345
1346 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
1347  * only send a notification if one they are enabled.  There's a bunch of weird
1348  * cases with this, and how pending / enabled are signals between the user and
1349  * kernel - check the documentation.  Note that pending is more about messages.
1350  * The process needs to be in vcore_context, and the reason is usually a
1351  * message.  We set pending here in case we were called to prod them into vcore
1352  * context (like via a sys_self_notify).  Also note that this works for _S
1353  * procs, if you send to vcore 0 (and the proc is running). */
1354 void proc_notify(struct proc *p, uint32_t vcoreid)
1355 {
1356         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1357
1358         assert(proc_vcoreid_is_safe(p, vcoreid));
1359         /* If you're thinking about checking notif_pending and then returning if
1360          * it is already set, note that some callers (e.g. the event system) set
1361          * notif_pending when they deliver a message, regardless of whether
1362          * there is an IPI or not.  Those callers assume that we don't care
1363          * about notif_pending, only notif_disabled.  So don't change this
1364          * without changing them (probably can't without a lot of thought - that
1365          * notif_pending is about missing messages.  It might be possible to say
1366          * "no IPI, but don't let me miss messages that were delivered." */
1367         vcpd->notif_pending = TRUE;
1368         wrmb(); /* must write notif_pending before reading notif_disabled */
1369         if (!vcpd->notif_disabled) {
1370                 /* GIANT WARNING: we aren't using the proc-lock to protect the
1371                  * vcoremap.  We want to be able to use this from interrupt
1372                  * context, and don't want the proc_lock to be an irqsave.
1373                  * Spurious __notify() kmsgs are okay (it checks to see if the
1374                  * right receiver is current). */
1375                 if (vcore_is_mapped(p, vcoreid)) {
1376                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
1377                         /* This use of try_get_pcoreid is racy, might be
1378                          * unmapped */
1379                         send_kernel_message(try_get_pcoreid(p, vcoreid),
1380                                             __notify, (long)p, 0, 0,
1381                                             KMSG_ROUTINE);
1382                 }
1383         }
1384 }
1385
1386 /* Makes sure p is runnable.  Callers may spam this, so it needs to handle
1387  * repeated calls for the same event.  Callers include event delivery, SCP
1388  * yield, and new SCPs.  Will trigger __sched_.cp_wakeup() CBs.  Will only
1389  * trigger the CB once, regardless of how many times we are called, *until* the
1390  * proc becomes WAITING again, presumably because of something the ksched did.*/
1391 void proc_wakeup(struct proc *p)
1392 {
1393         spin_lock(&p->proc_lock);
1394         if (__proc_is_mcp(p)) {
1395                 /* we only wake up WAITING mcps */
1396                 if (p->state != PROC_WAITING) {
1397                         spin_unlock(&p->proc_lock);
1398                         return;
1399                 }
1400                 __proc_set_state(p, PROC_RUNNABLE_M);
1401                 spin_unlock(&p->proc_lock);
1402                 __sched_mcp_wakeup(p);
1403                 return;
1404         } else {
1405                 /* SCPs can wake up for a variety of reasons.  the only times we
1406                  * need to do something is if it was waiting or just created.
1407                  * other cases are either benign (just go out), or potential
1408                  * bugs (_Ms) */
1409                 switch (p->state) {
1410                 case (PROC_CREATED):
1411                 case (PROC_WAITING):
1412                         __proc_set_state(p, PROC_RUNNABLE_S);
1413                         break;
1414                 case (PROC_RUNNABLE_S):
1415                 case (PROC_RUNNING_S):
1416                 case (PROC_DYING):
1417                 case (PROC_DYING_ABORT):
1418                         spin_unlock(&p->proc_lock);
1419                         return;
1420                 case (PROC_RUNNABLE_M):
1421                 case (PROC_RUNNING_M):
1422                         warn("Weird state(%s) in %s()", procstate2str(p->state),
1423                              __FUNCTION__);
1424                         spin_unlock(&p->proc_lock);
1425                         return;
1426                 }
1427                 /* thanks, past brho! */
1428                 printd("[kernel] FYI, waking up an _S proc\n");
1429                 spin_unlock(&p->proc_lock);
1430                 __sched_scp_wakeup(p);
1431         }
1432 }
1433
1434 /* Is the process in multi_mode / is an MCP or not?  */
1435 bool __proc_is_mcp(struct proc *p)
1436 {
1437         /* in lieu of using the amount of cores requested, or having a bunch of
1438          * states (like PROC_WAITING_M and _S), I'll just track it with a bool.
1439          */
1440         return p->procinfo->is_mcp;
1441 }
1442
1443 bool proc_is_vcctx_ready(struct proc *p)
1444 {
1445         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
1446
1447         return scp_is_vcctx_ready(vcpd);
1448 }
1449
1450 /************************  Preemption Functions  ******************************
1451  * Don't rely on these much - I'll be sure to change them up a bit.
1452  *
1453  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1454  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1455  * flux.  The num_vcores is changed after take_cores, but some of the messages
1456  * (or local traps) may not yet be ready to handle seeing their future state.
1457  * But they should be, so fix those when they pop up.
1458  *
1459  * Another thing to do would be to make the _core functions take a pcorelist,
1460  * and not just one pcoreid. */
1461
1462 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1463  * about locking, do it before calling.  Takes a vcoreid! */
1464 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1465 {
1466         struct event_msg local_msg = {0};
1467
1468         /* danger with doing this unlocked: preempt_pending is set, but never
1469          * 0'd, since it is unmapped and not dealt with (TODO)*/
1470         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1471
1472         /* Send the event (which internally checks to see how they want it) */
1473         local_msg.ev_type = EV_PREEMPT_PENDING;
1474         local_msg.ev_arg1 = vcoreid;
1475         /* Whenever we send msgs with the proc locked, we need at least 1
1476          * online.  Caller needs to make sure the core was online/mapped. */
1477         assert(!TAILQ_EMPTY(&p->online_vcs));
1478         send_kernel_event(p, &local_msg, vcoreid);
1479
1480         /* TODO: consider putting in some lookup place for the alarm to find it.
1481          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1482 }
1483
1484 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1485  * care about the mapping (and you should). */
1486 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1487 {
1488         struct vcore *vc_i;
1489         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1490                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1491         /* TODO: consider putting in some lookup place for the alarm to find it.
1492          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1493 }
1494
1495 // TODO: function to set an alarm, if none is outstanding
1496
1497 /* Raw function to preempt a single core.  If you care about locking, do it
1498  * before calling. */
1499 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1500 {
1501         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1502         struct event_msg preempt_msg = {0};
1503         /* works with nr_preempts_done to signal completion of a preemption */
1504         p->procinfo->vcoremap[vcoreid].nr_preempts_sent++;
1505         // expects a pcorelist.  assumes pcore is mapped and running_m
1506         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1507         /* Only send the message if we have an online core.  o/w, it would fuck
1508          * us up (deadlock), and hey don't need a message.  the core we just
1509          * took will be the first one to be restarted.  It will look like a
1510          * notif.  in the future, we could send the event if we want, but the
1511          * caller needs to do that (after unlocking). */
1512         if (!TAILQ_EMPTY(&p->online_vcs)) {
1513                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
1514                 preempt_msg.ev_arg2 = vcoreid;
1515                 send_kernel_event(p, &preempt_msg, 0);
1516         }
1517 }
1518
1519 /* Raw function to preempt every vcore.  If you care about locking, do it before
1520  * calling. */
1521 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr)
1522 {
1523         struct vcore *vc_i;
1524
1525         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag,
1526          * or just make us RUNNABLE_M.  Note this is also used by __map_vcore.
1527          */
1528         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1529                 vc_i->nr_preempts_sent++;
1530         return __proc_take_allcores(p, pc_arr, TRUE);
1531 }
1532
1533 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1534  * warning will be for u usec from now.  Returns TRUE if the core belonged to
1535  * the proc (and thus preempted), False if the proc no longer has the core. */
1536 bool proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1537 {
1538         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1539         bool retval = FALSE;
1540         if (p->state != PROC_RUNNING_M) {
1541                 /* more of an FYI for brho.  should be harmless to return. */
1542                 warn("Tried to preempt from a non RUNNING_M proc!");
1543                 return FALSE;
1544         }
1545         spin_lock(&p->proc_lock);
1546         if (is_mapped_vcore(p, pcoreid)) {
1547                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1548                 __proc_preempt_core(p, pcoreid);
1549                 /* we might have taken the last core */
1550                 if (!p->procinfo->num_vcores)
1551                         __proc_set_state(p, PROC_RUNNABLE_M);
1552                 retval = TRUE;
1553         }
1554         spin_unlock(&p->proc_lock);
1555         return retval;
1556 }
1557
1558 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1559  * warning will be for u usec from now. */
1560 void proc_preempt_all(struct proc *p, uint64_t usec)
1561 {
1562         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1563         uint32_t num_revoked = 0;
1564
1565         spin_lock(&p->proc_lock);
1566         /* storage for pc_arr is alloced at decl, which is after grabbing the
1567          * lock*/
1568         uint32_t pc_arr[p->procinfo->num_vcores];
1569
1570         /* DYING could be okay */
1571         if (p->state != PROC_RUNNING_M) {
1572                 warn("Tried to preempt from a non RUNNING_M proc!");
1573                 spin_unlock(&p->proc_lock);
1574                 return;
1575         }
1576         __proc_preempt_warnall(p, warn_time);
1577         num_revoked = __proc_preempt_all(p, pc_arr);
1578         assert(!p->procinfo->num_vcores);
1579         __proc_set_state(p, PROC_RUNNABLE_M);
1580         spin_unlock(&p->proc_lock);
1581         /* TODO: when we revise this func, look at __put_idle */
1582         /* Return the cores to the ksched */
1583         if (num_revoked)
1584                 __sched_put_idle_cores(p, pc_arr, num_revoked);
1585 }
1586
1587 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1588  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1589  * free, etc. */
1590 void proc_give(struct proc *p, uint32_t pcoreid)
1591 {
1592         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1593         spin_lock(&p->proc_lock);
1594         // expects a pcorelist, we give it a list of one
1595         __proc_give_cores(p, &pcoreid, 1);
1596         spin_unlock(&p->proc_lock);
1597 }
1598
1599 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1600  * out). */
1601 uint32_t proc_get_vcoreid(struct proc *p)
1602 {
1603         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1604
1605         if (pcpui->owning_proc == p) {
1606                 return pcpui->owning_vcoreid;
1607         } else {
1608                 warn("Asked for vcoreid for %p, but %p is pwns", p,
1609                      pcpui->owning_proc);
1610                 return (uint32_t)-1;
1611         }
1612 }
1613
1614 /* TODO: make all of these static inlines when we gut the env crap */
1615 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1616 {
1617         return p->procinfo->vcoremap[vcoreid].valid;
1618 }
1619
1620 /* Can do this, or just create a new field and save it in the vcoremap */
1621 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1622 {
1623         return (vc - p->procinfo->vcoremap);
1624 }
1625
1626 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1627 {
1628         return &p->procinfo->vcoremap[vcoreid];
1629 }
1630
1631 /********** Core granting (bulk and single) ***********/
1632
1633 /* Helper: gives pcore to the process, mapping it to the next available vcore
1634  * from list vc_list.  Returns TRUE if we succeeded (non-empty).  If you pass in
1635  * **vc, we'll tell you which vcore it was. */
1636 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1637                                 struct vcore_tailq *vc_list, struct vcore **vc)
1638 {
1639         struct vcore *new_vc;
1640
1641         new_vc = TAILQ_FIRST(vc_list);
1642         if (!new_vc)
1643                 return FALSE;
1644         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1645                pcore);
1646         TAILQ_REMOVE(vc_list, new_vc, list);
1647         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1648         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1649         if (vc)
1650                 *vc = new_vc;
1651         return TRUE;
1652 }
1653
1654 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1655                                        uint32_t num)
1656 {
1657         assert(p->state == PROC_RUNNABLE_M);
1658         assert(num);    /* catch bugs */
1659         /* add new items to the vcoremap */
1660         /* unncessary if offline */
1661         __seq_start_write(&p->procinfo->coremap_seqctr);
1662         p->procinfo->num_vcores += num;
1663         for (int i = 0; i < num; i++) {
1664                 /* Try from the bulk list first */
1665                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs,
1666                                         0))
1667                         continue;
1668                 /* o/w, try from the inactive list.  at one point, i thought
1669                  * there might be a legit way in which the inactive list could
1670                  * be empty, but that i wanted to catch it via an assert. */
1671                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs, 0));
1672         }
1673         __seq_end_write(&p->procinfo->coremap_seqctr);
1674 }
1675
1676 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1677                                       uint32_t num)
1678 {
1679         struct vcore *vc_i;
1680         /* Up the refcnt, since num cores are going to start using this
1681          * process and have it loaded in their owning_proc and 'current'. */
1682         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1683         __seq_start_write(&p->procinfo->coremap_seqctr);
1684         p->procinfo->num_vcores += num;
1685         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1686         for (int i = 0; i < num; i++) {
1687                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs,
1688                                            &vc_i));
1689                 send_kernel_message(pc_arr[i], __startcore, (long)p,
1690                                     (long)vcore2vcoreid(p, vc_i),
1691                                     (long)vc_i->nr_preempts_sent, KMSG_ROUTINE);
1692         }
1693         __seq_end_write(&p->procinfo->coremap_seqctr);
1694 }
1695
1696 /* Gives process p the additional num cores listed in pcorelist.  If the proc is
1697  * not RUNNABLE_M or RUNNING_M, this will fail and allocate none of the core
1698  * (and return -1).  If you're RUNNING_M, this will startup your new cores at
1699  * the entry point with their virtual IDs (or restore a preemption).  If you're
1700  * RUNNABLE_M, you should call __proc_run_m after this so that the process can
1701  * start to use its cores.  In either case, this returns 0.
1702  *
1703  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1704  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1705  * Then call __proc_run_m().
1706  *
1707  * The reason I didn't bring the _S cases from core_request over here is so we
1708  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1709  * this is called from another core, and to avoid the _S -> _M transition.
1710  *
1711  * WARNING: You must hold the proc_lock before calling this! */
1712 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1713 {
1714         /* should never happen: */
1715         assert(num + p->procinfo->num_vcores <= MAX_NUM_CORES);
1716         switch (p->state) {
1717         case (PROC_RUNNABLE_S):
1718         case (PROC_RUNNING_S):
1719                 warn("Don't give cores to a process in a *_S state!\n");
1720                 return -1;
1721         case (PROC_DYING):
1722         case (PROC_DYING_ABORT):
1723         case (PROC_WAITING):
1724                 /* can't accept, just fail */
1725                 return -1;
1726         case (PROC_RUNNABLE_M):
1727                 __proc_give_cores_runnable(p, pc_arr, num);
1728                 break;
1729         case (PROC_RUNNING_M):
1730                 __proc_give_cores_running(p, pc_arr, num);
1731                 break;
1732         default:
1733                 panic("Weird state(%s) in %s()", procstate2str(p->state),
1734                       __FUNCTION__);
1735         }
1736         /* TODO: considering moving to the ksched (hard, due to yield) */
1737         p->procinfo->res_grant[RES_CORES] += num;
1738         return 0;
1739 }
1740
1741 /********** Core revocation (bulk and single) ***********/
1742
1743 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1744 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1745 {
1746         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1747         struct preempt_data *vcpd;
1748         if (preempt) {
1749                 /* Lock the vcore's state (necessary for preemption recovery) */
1750                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1751                 atomic_or(&vcpd->flags, VC_K_LOCK);
1752                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0,
1753                                     KMSG_ROUTINE);
1754         } else {
1755                 send_kernel_message(pcoreid, __death, (long)p, 0, 0,
1756                                     KMSG_ROUTINE);
1757         }
1758 }
1759
1760 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1761 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1762 {
1763         struct vcore *vc_i;
1764
1765         /* TODO: if we ever get broadcast messaging, use it here (still need to
1766          * lock the vcores' states for preemption) */
1767         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1768                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1769 }
1770
1771 /* Might be faster to scan the vcoremap than to walk the list... */
1772 static void __proc_unmap_allcores(struct proc *p)
1773 {
1774         struct vcore *vc_i;
1775         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1776                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1777 }
1778
1779 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1780  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1781  * Don't use this for taking all of a process's cores.
1782  *
1783  * Make sure you hold the lock when you call this, and make sure that the pcore
1784  * actually belongs to the proc, non-trivial due to other __preempt messages. */
1785 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1786                           bool preempt)
1787 {
1788         struct vcore *vc;
1789         uint32_t vcoreid;
1790         assert(p->state & (PROC_RUNNING_M | PROC_RUNNABLE_M));
1791         __seq_start_write(&p->procinfo->coremap_seqctr);
1792         for (int i = 0; i < num; i++) {
1793                 vcoreid = get_vcoreid(p, pc_arr[i]);
1794                 /* Sanity check */
1795                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1796                 /* Revoke / unmap core */
1797                 if (p->state == PROC_RUNNING_M)
1798                         __proc_revoke_core(p, vcoreid, preempt);
1799                 __unmap_vcore(p, vcoreid);
1800                 /* Change lists for the vcore.  Note, the vcore is already
1801                  * unmapped and/or the messages are already in flight.  The only
1802                  * code that looks at the lists without holding the lock is
1803                  * event code. */
1804                 vc = vcoreid2vcore(p, vcoreid);
1805                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1806                 /* even for single preempts, we use the inactive list.  bulk
1807                  * preempt is only used for when we take everything. */
1808                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1809         }
1810         p->procinfo->num_vcores -= num;
1811         __seq_end_write(&p->procinfo->coremap_seqctr);
1812         p->procinfo->res_grant[RES_CORES] -= num;
1813 }
1814
1815 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1816  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1817  * returns the number of entries in pc_arr.
1818  *
1819  * Make sure pc_arr is big enough to handle num_vcores().
1820  * Make sure you hold the lock when you call this. */
1821 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1822 {
1823         struct vcore *vc_i, *vc_temp;
1824         uint32_t num = 0;
1825         assert(p->state & (PROC_RUNNING_M | PROC_RUNNABLE_M));
1826         __seq_start_write(&p->procinfo->coremap_seqctr);
1827         /* Write out which pcores we're going to take */
1828         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1829                 pc_arr[num++] = vc_i->pcoreid;
1830         /* Revoke if they are running, and unmap.  Both of these need the online
1831          * list to not be changed yet. */
1832         if (p->state == PROC_RUNNING_M)
1833                 __proc_revoke_allcores(p, preempt);
1834         __proc_unmap_allcores(p);
1835         /* Move the vcores from online to the head of the appropriate list */
1836         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1837                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does
1838                  * that */
1839                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1840                 /* Put the cores on the appropriate list */
1841                 if (preempt)
1842                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1843                 else
1844                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1845         }
1846         assert(TAILQ_EMPTY(&p->online_vcs));
1847         assert(num == p->procinfo->num_vcores);
1848         p->procinfo->num_vcores = 0;
1849         __seq_end_write(&p->procinfo->coremap_seqctr);
1850         p->procinfo->res_grant[RES_CORES] = 0;
1851         return num;
1852 }
1853
1854 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1855  * calling. */
1856 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1857 {
1858         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1859         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1860         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1861         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1862 }
1863
1864 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1865  * calling. */
1866 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1867 {
1868         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid =
1869                 FALSE;
1870         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1871 }
1872
1873 /* Stop running whatever context is on this core and load a known-good cr3.
1874  * Note this leaves no trace of what was running. This "leaves the process's
1875  * context.
1876  *
1877  * This does not clear the owning proc.  Use the other helper for that.
1878  *
1879  * Returns whether or not there was a process present. */
1880 bool abandon_core(void)
1881 {
1882         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1883
1884         /* Syscalls that don't return will ultimately call abadon_core(), so we
1885          * need to make sure we don't think we are still working on a syscall.
1886          * */
1887         pcpui->cur_kthread->sysc = 0;
1888         pcpui->cur_kthread->errbuf = 0; /* just in case */
1889         if (pcpui->cur_proc) {
1890                 __abandon_core();
1891                 return true;
1892         }
1893         return false;
1894 }
1895
1896 /* Helper to clear the core's owning processor and manage refcnting.  Pass in
1897  * core_id() to save a couple core_id() calls. */
1898 void clear_owning_proc(uint32_t coreid)
1899 {
1900         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1901         struct proc *p = pcpui->owning_proc;
1902
1903         __clear_owning_proc(coreid);
1904         pcpui->owning_proc = 0;
1905         pcpui->owning_vcoreid = 0xdeadbeef;
1906         pcpui->cur_ctx = 0;     /* catch bugs for now (may go away) */
1907         if (p)
1908                 proc_decref(p);
1909 }
1910
1911 /* Switches to the address space/context of new_p, doing nothing if we are
1912  * already in new_p.  This won't add extra refcnts or anything, and needs to be
1913  * paired with switch_back() at the end of whatever function you are in.
1914  * Specifically, the uncounted refs are one for the old_proc, which is passed
1915  * back to the caller, and new_p is getting placed in cur_proc. */
1916 uintptr_t switch_to(struct proc *new_p)
1917 {
1918         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1919         struct kthread *kth = pcpui->cur_kthread;
1920         struct proc *old_proc;
1921         uintptr_t ret;
1922
1923         old_proc = pcpui->cur_proc;             /* uncounted ref */
1924         /* If we aren't the proc already, then switch to it */
1925         if (old_proc != new_p) {
1926                 pcpui->cur_proc = new_p;        /* uncounted ref */
1927                 if (new_p)
1928                         lcr3(new_p->env_cr3);
1929                 else
1930                         lcr3(boot_cr3);
1931         }
1932         ret = (uintptr_t)old_proc;
1933         if (is_ktask(kth)) {
1934                 if (!(kth->flags & KTH_SAVE_ADDR_SPACE)) {
1935                         kth->flags |= KTH_SAVE_ADDR_SPACE;
1936                         /* proc pointers are aligned; we can use the lower bit
1937                          * as a signal to turn off SAVE_ADDR_SPACE. */
1938                         ret |= 0x1;
1939                 }
1940         }
1941         return ret;
1942 }
1943
1944 /* This switches back from new_p to the original process.  Pair it with
1945  * switch_to(), and pass in its return value for old_ret. */
1946 void switch_back(struct proc *new_p, uintptr_t old_ret)
1947 {
1948         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1949         struct kthread *kth = pcpui->cur_kthread;
1950         struct proc *old_proc;
1951
1952         if (is_ktask(kth)) {
1953                 if (old_ret & 0x1) {
1954                         kth->flags &= ~KTH_SAVE_ADDR_SPACE;
1955                         old_ret &= ~0x1;
1956                 }
1957         }
1958         old_proc = (struct proc*)old_ret;
1959         if (old_proc != new_p) {
1960                 pcpui->cur_proc = old_proc;
1961                 if (old_proc)
1962                         lcr3(old_proc->env_cr3);
1963                 else
1964                         lcr3(boot_cr3);
1965         }
1966 }
1967
1968 /* Will send a TLB shootdown message to every vcore in the main address space
1969  * (aka, all vcores for now).  The message will take the start and end virtual
1970  * addresses as well, in case we want to be more clever about how much we
1971  * shootdown and batching our messages.  Should do the sanity about rounding up
1972  * and down in this function too.
1973  *
1974  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1975  * message to the calling core (interrupting it, possibly while holding the
1976  * proc_lock).  We don't need to process routine messages since it's an
1977  * immediate message. */
1978 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1979 {
1980         /* TODO: need a better way to find cores running our address space.  we
1981          * can have kthreads running syscalls, async calls, processes being
1982          * created. */
1983         struct vcore *vc_i;
1984
1985         /* TODO: we might be able to avoid locking here in the future (we must
1986          * hit all online, and we can check __mapped).  it'll be complicated. */
1987         spin_lock(&p->proc_lock);
1988         switch (p->state) {
1989         case (PROC_RUNNING_S):
1990                 tlbflush();
1991                 break;
1992         case (PROC_RUNNING_M):
1993                 /* TODO: (TLB) sanity checks and rounding on the ranges.
1994                  *
1995                  * We need to make sure that once a core that was online has
1996                  * been removed from the online list, then it must receive a TLB
1997                  * flush (abandon_core()) before running the process again.
1998                  * Either that, or make other decisions about who to
1999                  * TLB-shootdown. */
2000                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
2001                         send_kernel_message(vc_i->pcoreid, __tlbshootdown,
2002                                             start, end, 0, KMSG_IMMEDIATE);
2003                 }
2004                 break;
2005         default:
2006                 /* TODO: til we fix shootdowns, there are some odd cases where
2007                  * we have the address space loaded, but the state is in
2008                  * transition. */
2009                 if (p == current)
2010                         tlbflush();
2011         }
2012         spin_unlock(&p->proc_lock);
2013 }
2014
2015 /* Helper, used by __startcore and __set_curctx, which sets up cur_ctx to run a
2016  * given process's vcore.  Caller needs to set up things like owning_proc and
2017  * whatnot.  Note that we might not have p loaded as current. */
2018 static void __set_curctx_to_vcoreid(struct proc *p, uint32_t vcoreid,
2019                                     uint32_t old_nr_preempts_sent)
2020 {
2021         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
2022         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
2023         struct vcore *vc = vcoreid2vcore(p, vcoreid);
2024
2025         /* Spin until our vcore's old preemption is done.  When __SC was sent,
2026          * we were told what the nr_preempts_sent was at that time.  Once that
2027          * many are done, it is time for us to run.  This forces a
2028          * 'happens-before' ordering on a __PR of our VC before this __SC of the
2029          * VC.  Note the nr_done should not exceed old_nr_sent, since further
2030          * __PR are behind this __SC in the KMSG queue. */
2031         while (old_nr_preempts_sent != vc->nr_preempts_done)
2032                 cpu_relax();
2033         /* read nr_done before any other rd or wr.  CPU mb in the atomic. */
2034         cmb();
2035         /* Mark that this vcore as no longer preempted.  No danger of clobbering
2036          * other writes, since this would get turned on in __preempt (which
2037          * can't be concurrent with this function on this core), and the atomic
2038          * is just toggling the one bit (a concurrent VC_K_LOCK will work) */
2039         atomic_and(&vcpd->flags, ~VC_PREEMPTED);
2040         /* Once the VC is no longer preempted, we allow it to receive msgs.  We
2041          * could let userspace do it, but handling it here makes it easier for
2042          * them to handle_indirs (when they turn this flag off).  Note the
2043          * atomics provide the needed barriers (cmb and mb on flags). */
2044         atomic_or(&vcpd->flags, VC_CAN_RCV_MSG);
2045         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
2046                core_id(), p->pid, vcoreid);
2047         /* If notifs are disabled, the vcore was in vcore context and we need to
2048          * restart the vcore_ctx.  o/w, we give them a fresh vcore (which is
2049          * also what happens the first time a vcore comes online).  No matter
2050          * what, they'll restart in vcore context.  It's just a matter of
2051          * whether or not it is the old, interrupted vcore context. */
2052         if (vcpd->notif_disabled) {
2053                 /* copy-in the tf we'll pop, then set all security-related
2054                  * fields */
2055                 pcpui->actual_ctx = vcpd->vcore_ctx;
2056                 proc_secure_ctx(&pcpui->actual_ctx);
2057         } else { /* not restarting from a preemption, use a fresh vcore */
2058                 assert(vcpd->vcore_stack);
2059                 proc_init_ctx(&pcpui->actual_ctx, vcoreid, vcpd->vcore_entry,
2060                               vcpd->vcore_stack, vcpd->vcore_tls_desc);
2061                 /* Disable/mask active notifications for fresh vcores */
2062                 vcpd->notif_disabled = TRUE;
2063         }
2064         /* Regardless of whether or not we have a 'fresh' VC, we need to restore
2065          * the FPU state for the VC according to VCPD (which means either a
2066          * saved FPU state or a brand new init).  Starting a fresh VC is just
2067          * referring to the GP context we run.  The vcore itself needs to have
2068          * the FPU state loaded from when it previously ran and was saved (or a
2069          * fresh FPU if it wasn't saved).  For fresh FPUs, the main purpose is
2070          * for limiting info leakage.  I think VCs that don't need FPU state for
2071          * some reason (like having a current_uthread) can handle any sort of
2072          * FPU state, since it gets sorted when they pop their next uthread.
2073          *
2074          * Note this can cause a GP fault on x86 if the state is corrupt.  In
2075          * lieu of reading in the huge FP state and mucking with mxcsr_mask, we
2076          * should handle this like a KPF on user code. */
2077         restore_vc_fp_state(vcpd);
2078         /* cur_ctx was built above (in actual_ctx), now use it */
2079         pcpui->cur_ctx = &pcpui->actual_ctx;
2080         /* this cur_ctx will get run when the kernel returns / idles */
2081         vcore_account_online(p, vcoreid);
2082 }
2083
2084 /* Changes calling vcore to be vcoreid.  enable_my_notif tells us about how the
2085  * state calling vcore wants to be left in.  It will look like caller_vcoreid
2086  * was preempted.  Note we don't care about notif_pending.
2087  *
2088  * Will return:
2089  *      0 if we successfully changed to the target vcore.
2090  *      -EBUSY if the target vcore is already mapped (a good kind of failure)
2091  *      -EAGAIN if we failed for some other reason and need to try again.  For
2092  *      example, the caller could be preempted, and we never even attempted to
2093  *      change.
2094  *      -EINVAL some userspace bug */
2095 int proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
2096                          bool enable_my_notif)
2097 {
2098         uint32_t caller_vcoreid, pcoreid = core_id();
2099         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
2100         struct preempt_data *caller_vcpd;
2101         struct vcore *caller_vc, *new_vc;
2102         struct event_msg preempt_msg = {0};
2103         int retval = -EAGAIN;   /* by default, try again */
2104
2105         /* Need to not reach outside the vcoremap, which might be smaller in the
2106          * future, but should always be as big as max_vcores */
2107         assert(proc_vcoreid_is_safe(p, new_vcoreid));
2108         /* Need to lock to prevent concurrent vcore changes, like in yield. */
2109         spin_lock(&p->proc_lock);
2110         /* new_vcoreid is already runing, abort */
2111         if (vcore_is_mapped(p, new_vcoreid)) {
2112                 retval = -EBUSY;
2113                 goto out_locked;
2114         }
2115         /* Need to make sure our vcore is allowed to switch.  We might have a
2116          * __preempt, __death, etc, coming in.  Similar to yield. */
2117         switch (p->state) {
2118         case (PROC_RUNNING_M):
2119                 break;          /* the only case we can proceed */
2120         case (PROC_RUNNING_S):  /* user bug, just return */
2121         case (PROC_DYING):      /* incoming __death */
2122         case (PROC_DYING_ABORT):
2123         case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
2124                 goto out_locked;
2125         default:
2126                 panic("Weird state(%s) in %s()", procstate2str(p->state),
2127                       __FUNCTION__);
2128         }
2129         /* This is which vcore this pcore thinks it is, regardless of any
2130          * unmappings that may have happened remotely (with __PRs waiting to
2131          * run) */
2132         caller_vcoreid = pcpui->owning_vcoreid;
2133         caller_vc = vcoreid2vcore(p, caller_vcoreid);
2134         caller_vcpd = &p->procdata->vcore_preempt_data[caller_vcoreid];
2135         /* This is how we detect whether or not a __PR happened.  If it did,
2136          * just abort and handle the kmsg.  No new __PRs are coming since we
2137          * hold the lock.  This also detects a __PR followed by a __SC for the
2138          * same VC. */
2139         if (caller_vc->nr_preempts_sent != caller_vc->nr_preempts_done)
2140                 goto out_locked;
2141         /* Sanity checks.  If we were preempted or are dying, we should have
2142          * noticed by now. */
2143         assert(is_mapped_vcore(p, pcoreid));
2144         assert(caller_vcoreid == get_vcoreid(p, pcoreid));
2145         /* Should only call from vcore context */
2146         if (!caller_vcpd->notif_disabled) {
2147                 retval = -EINVAL;
2148                 printk("[kernel] You tried to change vcores from uth ctx\n");
2149                 goto out_locked;
2150         }
2151         /* Ok, we're clear to do the switch.  Lets figure out who the new one is
2152          */
2153         new_vc = vcoreid2vcore(p, new_vcoreid);
2154         printd("[kernel] changing vcore %d to vcore %d\n", caller_vcoreid,
2155                new_vcoreid);
2156         /* enable_my_notif signals how we'll be restarted */
2157         if (enable_my_notif) {
2158                 /* if they set this flag, then the vcore can just restart from
2159                  * scratch, and we don't care about either the uthread_ctx or
2160                  * the vcore_ctx. */
2161                 caller_vcpd->notif_disabled = FALSE;
2162                 /* Don't need to save the FPU.  There should be no uthread or
2163                  * other reason to return to the FPU state.  But we do need to
2164                  * finalize the context, even though we are throwing it away.
2165                  * We need to return the pcore to a state where it can run any
2166                  * context and not be bound to the old context. */
2167                 arch_finalize_ctx(pcpui->cur_ctx);
2168         } else {
2169                 /* need to set up the calling vcore's ctx so that it'll get
2170                  * restarted by __startcore, to make the caller look like it was
2171                  * preempted. */
2172                 copy_current_ctx_to(&caller_vcpd->vcore_ctx);
2173                 save_vc_fp_state(caller_vcpd);
2174         }
2175         /* Mark our core as preempted (for userspace recovery).  Userspace
2176          * checks this in handle_indirs, and it needs to check the mbox
2177          * regardless of enable_my_notif.  This does mean cores that change-to
2178          * with no intent to return will be tracked as PREEMPTED until they
2179          * start back up (maybe forever). */
2180         atomic_or(&caller_vcpd->flags, VC_PREEMPTED);
2181         /* Either way, unmap and offline our current vcore */
2182         /* Move the caller from online to inactive */
2183         TAILQ_REMOVE(&p->online_vcs, caller_vc, list);
2184         /* We don't bother with the notif_pending race.  note that notif_pending
2185          * could still be set.  this was a preempted vcore, and userspace will
2186          * need to deal with missed messages (preempt_recover() will handle
2187          * that) */
2188         TAILQ_INSERT_HEAD(&p->inactive_vcs, caller_vc, list);
2189         /* Move the new one from inactive to online */
2190         TAILQ_REMOVE(&p->inactive_vcs, new_vc, list);
2191         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
2192         /* Change the vcore map */
2193         __seq_start_write(&p->procinfo->coremap_seqctr);
2194         __unmap_vcore(p, caller_vcoreid);
2195         __map_vcore(p, new_vcoreid, pcoreid);
2196         __seq_end_write(&p->procinfo->coremap_seqctr);
2197         vcore_account_offline(p, caller_vcoreid);
2198         /* Send either a PREEMPT msg or a CHECK_MSGS msg.  If they said to
2199          * enable_my_notif, then all userspace needs is to check messages, not a
2200          * full preemption recovery. */
2201         preempt_msg.ev_type = (enable_my_notif ? EV_CHECK_MSGS :
2202                                EV_VCORE_PREEMPT);
2203         preempt_msg.ev_arg2 = caller_vcoreid;   /* arg2 is 32 bits */
2204         /* Whenever we send msgs with the proc locked, we need at least 1
2205          * online.  In this case, it's the one we just changed to. */
2206         assert(!TAILQ_EMPTY(&p->online_vcs));
2207         send_kernel_event(p, &preempt_msg, new_vcoreid);
2208         /* So this core knows which vcore is here. (cur_proc and owning_proc are
2209          * already correct): */
2210         pcpui->owning_vcoreid = new_vcoreid;
2211         /* Until we set_curctx, we don't really have a valid current tf.  The
2212          * stuff in that old one is from our previous vcore, not the current
2213          * owning_vcoreid.  This matters for other KMSGS that will run before
2214          * __set_curctx (like __notify). */
2215         pcpui->cur_ctx = 0;
2216         /* Need to send a kmsg to finish.  We can't set_curctx til the __PR is
2217          * done, but we can't spin right here while holding the lock (can't spin
2218          * while waiting on a message, roughly) */
2219         send_kernel_message(pcoreid, __set_curctx, (long)p, (long)new_vcoreid,
2220                             (long)new_vc->nr_preempts_sent, KMSG_ROUTINE);
2221         retval = 0;
2222         /* Fall through to exit */
2223 out_locked:
2224         spin_unlock(&p->proc_lock);
2225         return retval;
2226 }
2227
2228 /* Kernel message handler to start a process's context on this core, when the
2229  * core next considers running a process.  Tightly coupled with __proc_run_m().
2230  * Interrupts are disabled. */
2231 void __startcore(uint32_t srcid, long a0, long a1, long a2)
2232 {
2233         uint32_t vcoreid = (uint32_t)a1;
2234         uint32_t coreid = core_id();
2235         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2236         struct proc *p_to_run = (struct proc *)a0;
2237         uint32_t old_nr_preempts_sent = (uint32_t)a2;
2238
2239         assert(p_to_run);
2240         /* Can not be any TF from a process here already */
2241         assert(!pcpui->owning_proc);
2242         /* the sender of the kmsg increfed already for this saved ref to
2243          * p_to_run */
2244         pcpui->owning_proc = p_to_run;
2245         pcpui->owning_vcoreid = vcoreid;
2246         /* sender increfed again, assuming we'd install to cur_proc.  only do
2247          * this if no one else is there.  this is an optimization, since we
2248          * expect to send these __startcores to idles cores, and this saves a
2249          * scramble to incref when all of the cores restartcore/startcore later.
2250          * Keep in sync with __proc_give_cores() and __proc_run_m(). */
2251         if (!pcpui->cur_proc) {
2252                 pcpui->cur_proc = p_to_run; /* install the ref to cur_proc */
2253                 lcr3(p_to_run->env_cr3);
2254         } else {
2255                 proc_decref(p_to_run);
2256         }
2257         /* Note we are not necessarily in the cr3 of p_to_run */
2258         /* Now that we sorted refcnts and know p / which vcore it should be, set
2259          * up pcpui->cur_ctx so that it will run that particular vcore */
2260         __set_curctx_to_vcoreid(p_to_run, vcoreid, old_nr_preempts_sent);
2261 }
2262
2263 /* Kernel message handler to load a proc's vcore context on this core.  Similar
2264  * to __startcore, except it is used when p already controls the core (e.g.
2265  * change_to).  Since the core is already controlled, pcpui such as owning proc,
2266  * vcoreid, and cur_proc are all already set. */
2267 void __set_curctx(uint32_t srcid, long a0, long a1, long a2)
2268 {
2269         struct proc *p = (struct proc*)a0;
2270         uint32_t vcoreid = (uint32_t)a1;
2271         uint32_t old_nr_preempts_sent = (uint32_t)a2;
2272         __set_curctx_to_vcoreid(p, vcoreid, old_nr_preempts_sent);
2273 }
2274
2275 /* Bail out if it's the wrong process, or if they no longer want a notif.  Try
2276  * not to grab locks or write access to anything that isn't per-core in here. */
2277 void __notify(uint32_t srcid, long a0, long a1, long a2)
2278 {
2279         uint32_t vcoreid, coreid = core_id();
2280         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2281         struct preempt_data *vcpd;
2282         struct proc *p = (struct proc*)a0;
2283
2284         /* Not the right proc */
2285         if (p != pcpui->owning_proc)
2286                 return;
2287         /* the core might be owned, but not have a valid cur_ctx (if we're in
2288          * the process of changing */
2289         if (!pcpui->cur_ctx)
2290                 return;
2291         /* Common cur_ctx sanity checks.  Note cur_ctx could be an _S's scp_ctx
2292          */
2293         vcoreid = pcpui->owning_vcoreid;
2294         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
2295         /* for SCPs that haven't (and might never) call vc_event_init, like
2296          * rtld.  this is harmless for MCPS to check this */
2297         if (!scp_is_vcctx_ready(vcpd))
2298                 return;
2299         printd("received active notification for proc %d's vcore %d on pcore %d\n",
2300                p->procinfo->pid, vcoreid, coreid);
2301         /* sort signals.  notifs are now masked, like an interrupt gate */
2302         if (vcpd->notif_disabled)
2303                 return;
2304         vcpd->notif_disabled = TRUE;
2305         /* save the old ctx in the uthread slot, build and pop a new one.  Note
2306          * that silly state isn't our business for a notification. */
2307         copy_current_ctx_to(&vcpd->uthread_ctx);
2308         memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
2309         proc_init_ctx(pcpui->cur_ctx, vcoreid, vcpd->vcore_entry,
2310                       vcpd->vcore_stack, vcpd->vcore_tls_desc);
2311         /* this cur_ctx will get run when the kernel returns / idles */
2312 }
2313
2314 void __preempt(uint32_t srcid, long a0, long a1, long a2)
2315 {
2316         uint32_t vcoreid, coreid = core_id();
2317         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2318         struct preempt_data *vcpd;
2319         struct proc *p = (struct proc*)a0;
2320
2321         assert(p);
2322         if (p != pcpui->owning_proc) {
2323                 panic("__preempt arrived for proc (%p) that was not owning (%p)!",
2324                       p, pcpui->owning_proc);
2325         }
2326         /* Common cur_ctx sanity checks */
2327         assert(pcpui->cur_ctx);
2328         assert(pcpui->cur_ctx == &pcpui->actual_ctx);
2329         vcoreid = pcpui->owning_vcoreid;
2330         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
2331         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
2332                p->procinfo->pid, vcoreid, coreid);
2333         /* if notifs are disabled, the vcore is in vcore context (as far as
2334          * we're concerned), and we save it in the vcore slot. o/w, we save the
2335          * process's cur_ctx in the uthread slot, and it'll appear to the vcore
2336          * when it comes back up the uthread just took a notification. */
2337         if (vcpd->notif_disabled)
2338                 copy_current_ctx_to(&vcpd->vcore_ctx);
2339         else
2340                 copy_current_ctx_to(&vcpd->uthread_ctx);
2341         /* Userspace in a preemption handler on another core might be copying FP
2342          * state from memory (VCPD) at the moment, and if so we don't want to
2343          * clobber it.  In this rare case, our current core's FPU state should
2344          * be the same as whatever is in VCPD, so this shouldn't be necessary,
2345          * but the arch-specific save function might do something other than
2346          * write out bit-for-bit the exact same data.  Checking STEALING
2347          * suffices, since we hold the K_LOCK (preventing userspace from
2348          * starting a fresh STEALING phase concurrently). */
2349         if (!(atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING))
2350                 save_vc_fp_state(vcpd);
2351         /* Mark the vcore as preempted and unlock (was locked by the sender). */
2352         atomic_or(&vcpd->flags, VC_PREEMPTED);
2353         atomic_and(&vcpd->flags, ~VC_K_LOCK);
2354         /* either __preempt or proc_yield() ends the preempt phase. */
2355         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
2356         vcore_account_offline(p, vcoreid);
2357         /* make sure everything else hits before we finish the preempt */
2358         wmb();
2359         /* up the nr_done, which signals the next __startcore for this vc */
2360         p->procinfo->vcoremap[vcoreid].nr_preempts_done++;
2361         /* We won't restart the process later.  current gets cleared later when
2362          * we notice there is no owning_proc and we have nothing to do
2363          * (smp_idle, restartcore, etc) */
2364         clear_owning_proc(coreid);
2365 }
2366
2367 /* Kernel message handler to clean up the core when a process is dying.
2368  * Note this leaves no trace of what was running.
2369  * It's okay if death comes to a core that's already idling and has no current.
2370  * It could happen if a process decref'd before __proc_startcore could incref. */
2371 void __death(uint32_t srcid, long a0, long a1, long a2)
2372 {
2373         uint32_t vcoreid, coreid = core_id();
2374         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2375         struct proc *p = (struct proc*)a0;
2376
2377         assert(p);
2378         if (p != pcpui->owning_proc) {
2379                 /* Older versions of Akaros thought it was OK to have a __death
2380                  * hit a core that no longer had a process.  I think it's a bug
2381                  * now. */
2382                 panic("__death arrived for proc (%p) that was not owning (%p)!",
2383                       p, pcpui->owning_proc);
2384         }
2385         vcoreid = pcpui->owning_vcoreid;
2386         printd("[kernel] death on physical core %d for process %d's vcore %d\n",
2387                coreid, p->pid, vcoreid);
2388         vcore_account_offline(p, vcoreid);      /* in case anyone is counting */
2389         /* We won't restart the process later.  current gets cleared later when
2390          * we notice there is no owning_proc and we have nothing to do
2391          * (smp_idle, restartcore, etc). */
2392         arch_finalize_ctx(pcpui->cur_ctx);
2393         clear_owning_proc(coreid);
2394 }
2395
2396 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
2397  * addresses from a0 to a1. */
2398 void __tlbshootdown(uint32_t srcid, long a0, long a1, long a2)
2399 {
2400         /* TODO: (TLB) something more intelligent with the range */
2401         tlbflush();
2402 }
2403
2404 void print_allpids(void)
2405 {
2406         void print_proc_state(void *item, void *opaque)
2407         {
2408                 struct proc *p = (struct proc*)item;
2409                 assert(p);
2410                 /* this actually adds an extra space, since no progname is ever
2411                  * PROGNAME_SZ bytes, due to the \0 counted in PROGNAME. */
2412                 printk("%8d %-*s %-10s %6d\n", p->pid, PROC_PROGNAME_SZ,
2413                        p->progname, procstate2str(p->state), p->ppid);
2414         }
2415         char dashes[PROC_PROGNAME_SZ];
2416         memset(dashes, '-', PROC_PROGNAME_SZ);
2417         dashes[PROC_PROGNAME_SZ - 1] = '\0';
2418         /* -5, for 'Name ' */
2419         printk("     PID Name %-*s State      Parent    \n",
2420                PROC_PROGNAME_SZ - 5, "");
2421         printk("------------------------------%s\n", dashes);
2422         spin_lock(&pid_hash_lock);
2423         hash_for_each(pid_hash, print_proc_state, NULL);
2424         spin_unlock(&pid_hash_lock);
2425 }
2426
2427 void proc_get_set(struct process_set *pset)
2428 {
2429         void enum_proc(void *item, void *opaque)
2430         {
2431                 struct proc *p = (struct proc*) item;
2432                 struct process_set *pset = (struct process_set *) opaque;
2433
2434                 if (pset->num_processes < pset->size) {
2435                         if (!kref_get_not_zero(&p->p_kref, 1))
2436                                 return;
2437
2438                         pset->procs[pset->num_processes] = p;
2439                         pset->num_processes++;
2440                 }
2441         }
2442
2443         static const size_t num_extra_alloc = 16;
2444
2445         pset->procs = NULL;
2446         do {
2447                 if (pset->procs)
2448                         proc_free_set(pset);
2449                 pset->size = atomic_read(&num_envs) + num_extra_alloc;
2450                 pset->num_processes = 0;
2451                 pset->procs = (struct proc **)
2452                         kzmalloc(pset->size * sizeof(struct proc *), MEM_WAIT);
2453
2454                 spin_lock(&pid_hash_lock);
2455                 hash_for_each(pid_hash, enum_proc, pset);
2456                 spin_unlock(&pid_hash_lock);
2457
2458         } while (pset->num_processes == pset->size);
2459 }
2460
2461 void proc_free_set(struct process_set *pset)
2462 {
2463         for (size_t i = 0; i < pset->num_processes; i++)
2464                 proc_decref(pset->procs[i]);
2465         kfree(pset->procs);
2466 }
2467
2468 void print_proc_info(pid_t pid, int verbosity)
2469 {
2470         int j = 0;
2471         uint64_t total_time = 0;
2472         struct proc *child, *p = pid2proc(pid);
2473         struct vcore *vc_i;
2474         struct preempt_data *vcpd;
2475
2476         if (!p) {
2477                 printk("Bad PID.\n");
2478                 return;
2479         }
2480         vcpd = &p->procdata->vcore_preempt_data[0];
2481         print_lock();
2482         spinlock_debug(&p->proc_lock);
2483         //spin_lock(&p->proc_lock); // No locking!!
2484         printk("struct proc: %p\n", p);
2485         printk("Program name: %s\n", p->progname);
2486         printk("PID: %d\n", p->pid);
2487         printk("PPID: %d\n", p->ppid);
2488         printk("State: %s (%p)\n", procstate2str(p->state), p->state);
2489         printk("\tIs %san MCP\n", p->procinfo->is_mcp ? "" : "not ");
2490         if (!scp_is_vcctx_ready(vcpd))
2491                 printk("\tIs NOT vcctx ready\n");
2492         if (verbosity > 0 && !p->procinfo->is_mcp) {
2493                 printk("Last saved SCP context:");
2494                 backtrace_user_ctx(p, &p->scp_ctx);
2495         }
2496         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
2497         printk("Flags: 0x%08x\n", p->env_flags);
2498         printk("CR3(phys): %p\n", p->env_cr3);
2499         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
2500         printk("Vcore Lists (may be in flux w/o locking):\n----------------\n");
2501         printk("Online:\n");
2502         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
2503                 printk("\tVcore %d -> Pcore %d\n", vcore2vcoreid(p, vc_i),
2504                        vc_i->pcoreid);
2505         printk("Bulk Preempted:\n");
2506         TAILQ_FOREACH(vc_i, &p->bulk_preempted_vcs, list)
2507                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
2508         printk("Inactive / Yielded:\n");
2509         TAILQ_FOREACH(vc_i, &p->inactive_vcs, list)
2510                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
2511         if (verbosity > 0) {
2512                 printk("Nsec Online, up to the last offlining:\n");
2513                 printk("------------------------");
2514                 for (int i = 0; i < p->procinfo->max_vcores; i++) {
2515                         uint64_t vc_time = tsc2nsec(vcore_account_gettotal(p,
2516                                                                            i));
2517
2518                         if (i % 4 == 0)
2519                                 printk("\n");
2520                         printk("  VC %3d: %14llu", i, vc_time);
2521                         total_time += vc_time;
2522                 }
2523                 printk("\n");
2524                 printk("Total CPU-NSEC: %llu\n", total_time);
2525         }
2526         printk("Resources:\n------------------------\n");
2527         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
2528                 printk("\tRes type: %02d, amt wanted: %08d amt granted: %08d\n",
2529                        i, p->procdata->res_req[i].amt_wanted,
2530                        p->procinfo->res_grant[i]);
2531         printk("Open Files:\n");
2532         struct fd_table *files = &p->open_files;
2533
2534         if (spin_locked(&files->lock)) {
2535                 spinlock_debug(&files->lock);
2536                 printk("FILE LOCK HELD, ABORTING\n");
2537                 print_unlock();
2538                 proc_decref(p);
2539                 return;
2540         }
2541         spin_lock(&files->lock);
2542         for (int i = 0; i < files->max_files; i++) {
2543                 if (GET_BITMASK_BIT(files->open_fds->fds_bits, i)) {
2544                         printk("\tFD: %02d, ", i);
2545                         assert(files->fd[i].fd_chan);
2546                         print_chaninfo(files->fd[i].fd_chan);
2547                 }
2548         }
2549         spin_unlock(&files->lock);
2550         printk("Children: (PID (struct proc *))\n");
2551         TAILQ_FOREACH(child, &p->children, sibling_link)
2552                 printk("\t%d (%p)\n", child->pid, child);
2553         print_unlock();
2554         /* no locking / unlocking or refcnting */
2555         // spin_unlock(&p->proc_lock);
2556         proc_decref(p);
2557 }
2558
2559 /* Debugging function, checks what (process, vcore) is supposed to run on this
2560  * pcore.  Meant to be called from smp_idle() before halting. */
2561 void check_my_owner(void)
2562 {
2563         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
2564         void shazbot(void *item, void *opaque)
2565         {
2566                 struct proc *p = (struct proc*)item;
2567                 struct vcore *vc_i;
2568                 assert(p);
2569                 spin_lock(&p->proc_lock);
2570                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
2571                         /* this isn't true, a __startcore could be on the way
2572                          * and we're already "online" */
2573                         if (vc_i->pcoreid == core_id()) {
2574                                 /* Immediate message was sent, we should get it
2575                                  * when we enable interrupts, which should cause
2576                                  * us to skip cpu_halt() */
2577                                 if (!STAILQ_EMPTY(&pcpui->immed_amsgs))
2578                                         continue;
2579                                 printk("Owned pcore (%d) has no owner, by %p, vc %d!\n",
2580                                        core_id(), p, vcore2vcoreid(p, vc_i));
2581                                 spin_unlock(&p->proc_lock);
2582                                 spin_unlock(&pid_hash_lock);
2583                                 monitor(0);
2584                         }
2585                 }
2586                 spin_unlock(&p->proc_lock);
2587         }
2588         assert(!irq_is_enabled());
2589         if (!booting && !pcpui->owning_proc) {
2590                 spin_lock(&pid_hash_lock);
2591                 hash_for_each(pid_hash, shazbot, NULL);
2592                 spin_unlock(&pid_hash_lock);
2593         }
2594 }