f293d63debaa7b26c356a7b6d54d19ff4cfe272f
[akaros.git] / Documentation / process-internals.txt
1 process-internals.txt
2 Barret Rhoden
3
4 This discusses core issues with process design and implementation.  Most of this
5 info is available in the source in the comments (but may not be in the future).
6 For now, it's a dumping ground for topics that people ought to understand before
7 they muck with how processes work.
8
9 Contents:
10 1. Reference Counting
11 2. When Do We Really Leave "Process Context"?
12 3. Leaving the Kernel Stack:
13 4. Preemption and Notification Issues:
14 5. TBD
15
16 1. Reference Counting
17 ===========================
18 1.1 Basics:
19 ---------------------------
20 Reference counts (proc_refcnt) exist to keep a process alive.  Eventually, this
21 will probably turn into a regular "kernel design pattern", like it is in Linux
22 (http://lwn.net/Articles/336224/).  The style of reference counting we use for
23 processes is similar to a kref:
24 - Can only incref if the current value is greater than 0, meaning there is
25   already a reference to it.  It is a bug to try to incref on something that has
26   no references, so always make sure you incref something that you know has a
27   reference.  If you don't know, you need to get it manually (CAREFULLY!) or use
28   pid2proc (which is a careful way of doing this).  If you incref and there are
29   0 references, the kernel will panic.  Fix your bug / don't incref random
30   pointers.
31 - Can always decref.
32 - When the decref returns 0, perform some operation.  This does some final
33   cleanup on the object.
34
35 For a process, proc_destroy() decrefs, and other codes using the proc also
36 decref.  The last one to decref calls proc_free to do the final cleanup.
37
38 1.2 Brief History of the Refcnt:
39 ---------------------------
40 Originally, the refcnt was created to keep page tables from being destroyed (in
41 proc_free()) while cores were still using them, which is what was happens during
42 an ARSC (async remote syscall).  It was then defined to be a count of places in
43 the kernel that had an interest in the process staying alive, practically just
44 to protect current/cr3.  This 'interest' actually extends to any code holding a
45 pointer to the proc, such as one acquired via pid2proc(), which is its current
46 meaning.
47
48 1.3 Quick Aside: The current Macro:
49 ---------------------------
50 current is a pointer to the proc that is currently loaded/running on any given
51 core.  It is stored in the per_cpu_info struct, and set/managed by low-level
52 process code.  It is necessary for the kernel to quickly figure out who is
53 running on its code, especially when servicing interrupts and traps.  current is
54 protected by a refcnt.
55
56 1.4 Reference Counting Rules:
57 ---------------------------
58 +1 for existing.
59 - The fact that the process is supposed to exist is worth +1.  When it is time
60   to die, we decref, and it will eventually be cleaned up.
61
62 +1 for someone using it or planning to use it.
63 - This includes simply having a pointer to the proc, since presumably you will
64   use it.  pid2proc() will incref for you.  When you are done, decref.
65 - Functions that create a process and return a pointer (like proc_create() or
66   kfs_proc_create()) will also up the refcnt for you.  Decref when you're done.
67 - If the *proc is stored somewhere where it will be used again, such as in an IO
68   continuation, it needs to be refcnt'd.  Note that if you already had a
69   reference from pid2proc(), simply don't decref after you store the pointer.
70
71 +1 for current.
72 - current counts as someone using it (expressing interest in the core), but is
73   also a source of the pointer, so its a bit different.
74 - You have a reference from current and can use it without refcnting, but
75   anything that needs to eat a reference or store/use it needs an incref first.
76   To be clear, your reference is *NOT* edible.  It protects the cr3, guarantees
77   the process won't die, and serves as a bootstrappable reference.
78 - Specifically, if you get a ref from current, but then save it somewhere (like
79   an IO continuation request), then clearly you must incref, since it's both
80   current and stored/used.
81 - If you don't know what might be downstream from your function, then incref
82   before passing the reference, and decref when it returns.  Like when handling
83   syscalls, for example.
84
85 All functions that take a *proc have a refcnt'd reference, though it may not be
86 edible (it could be current).  It is the callers responsibility to make sure
87 it'd edible if it necessary.  It is the callees responsibility to incref if it
88 stores or makes a copy of the reference.
89
90 1.5 Functions That Don't or Might Not Return:
91 ---------------------------
92 Refcnting and especially decreffing gets tricky when there are functions that
93 MAY not return.  proc_restartcore() does not return (it pops into userspace).
94 proc_run() might not return, if the core it was called on will pop into
95 userspace (if it was a _S, or if the core is part of the vcoremap for a _M).
96
97 Functions that MAY not return will "eat" your reference *IF* they do not return.
98 This means that you must have a reference when you call them (like always), and
99 that reference will be consumed / decref'd for you if the function doesn't
100 return.  Or something similarly appropriate.
101
102 We do this because when the function does not return, you will not have the
103 chance to decref (your decref code will never run).  We need the reference when
104 going in to keep the object alive (like with any other refcnt).  We can't have
105 the function always eat the reference, since you cannot simply re-incref the
106 pointer (not allowed to incref unless you know you had a good reference).  You'd
107 have to do something like p = pid2proc(p_pid);  It's clunky to do that, easy to
108 screw up, and semantically, if the function returns, then we may still have an
109 interest in p and should decref later.
110
111 The downside is that functions need to determine if they will return or not,
112 which can be a pain (a linear time search when running an _M, for instance,
113 which can suck if we are trying to use a broadcast/logical IPI).
114
115 As the caller, you usually won't know if the function will return or not, so you
116 need to provide a consumable reference.  Current doesn't count.  For example,
117 proc_run() requires a reference.  You can proc_run(p), and use p afterwards, and
118 later decref.  You need to make sure you have a reference, so things like
119 proc_run(pid2proc(55)) works, since pid2proc() increfs for you.  But you cannot
120 proc_run(current), unless you incref current in advance.  Incidentally,
121 proc_running current doesn't make a lot of sense.
122
123 As another example, __proc_startcore() will take your reference and store it
124 in current.  Since it is used by both the __startcore and the interrupt return
125 paths (proc_restartcore() now, formerly called proc_startcore()), we're
126 currently going with the model of "caller makes sure there is a ref for
127 current".  Check its comments for details.
128
129 1.6 Runnable List:
130 ---------------------------
131 Procs on the runnable list need to have a refcnt (other than the +1 for
132 existing).  It's something that cares that the process exists.  We could have
133 had it implicitly be refcnt'd (the fact that it's on the list is enough, sort of
134 as if it was part of the +1 for existing), but that complicates things.  For
135 instance, it is a source of a reference (for the scheduler) and you could not
136 proc_run() a process from the runnable list without worrying about increfing it
137 before hand.  Remember that proc_run() might consume your reference (which
138 actually turns into a current reference, which is later destroyed by decref in
139 abandon_core()).
140
141 1.7 Internal Details for Specific Functions:
142 ---------------------------
143 proc_run(): makes sure enough refcnts are in place for all places that will
144 install current.  This also makes it easier on the system (one big incref(n),
145 instead of n increfs of (1) from multiple cores).  In the off chance current was
146 already set for a core receiving the kernel message, __startcore will decref.
147 Also note that while proc_run() consumes your reference, it's not actually
148 decreffing, so there's no danger within proc_run() of the process dying /
149 __proc_free()ing.
150
151 __proc_startcore(): assumes all references to p are sorted.  *p is already
152 accounted for as if it was current on the core startcore runs on. (there is only
153 one refcnt for both *p and current, not 2 separate ones).
154
155 proc_destroy(): it might not return (if the calling core belongs to the
156 process), so it may eat your reference and you must have an edible reference.
157 It is possible you called proc_destroy(current).  The cleanup of the current
158 will be its own decref, so you need to have a usable/real reference (current
159 doesn't count as an edible reference).  So incref before doing that.  Even if p
160 == current, proc_destroy() can't tell if you sent it p (and had a reference) or
161 current and didn't.
162
163 proc_yield(): this never returns, so it eats your reference.  It will also
164 decref when it abandon_core()s.
165
166 __proc_give_cores() and friends: you call this while holding the lock, but it is
167 possible that your core is in the corelist you gave it.  In this case, it will
168 detect it, and return a bool signalling if an IPI is pending.  It will not
169 consume your reference.  The reasoning behind this is that it is an internal
170 function, and you may want to do other things before decreffing.  There is also
171 a helper function that will unlock and possibly decref/wait for the IPI, called
172 __proc_unlock_ipi_pending().  Use this when it is time to unlock.  It's just a
173 helper, which may go away.
174
175 abandon_core(): it was not given a reference, so it doesn't eat one.  It will
176 decref when it unloads the cr3.  Note that this is a potential performance
177 issue.  When preempting or killing, there are n cores that are fighting for the
178 cacheline to decref.  An alternative would be to have one core decref for all n
179 cores, after it knows all cores unloaded the cr3.  This would be a good use of
180 the checklist (possibly with one cacheline per core).  It would take a large
181 amount of memory for better scalability.
182
183 1.8 Core Request:
184 ---------------------------
185 core_request() is run outside of the process code (for now), though it is fairly
186 intricate.  It's another function that might not return, but the reasons for
187 this vary:
188         1: The process is moving from _S to _M so the return path to userspace won't
189         happen (and sort of will on the new core / the other side), but that will
190         happen when popping into userspace.
191         2: The scheduler is giving the current core to the process, which can kick
192         in via either proc_run() or __proc_give_cores().
193         3: It was a request to give up all cores, which means the current core will
194         receive an IPI (if it wasn't an async call, which isn't handled yet).
195
196 For these reasons, core_request() needs to have an edible reference.
197
198 Also, since core_request calls functions that might not return, there are cases
199 where it will not be able to call abandon_core() and leave process context.
200 This is an example of why we have the fallback case of leaving process context
201 in proc_startcore().  See the section below about process context for more
202 information.
203
204 Eventually, core_request() will be split better, probably with the brutal logic
205 in process.c that would call out some functions in resource.c that actually make
206 choices.
207
208 1.9 Things I Could Have Done But Didn't And Why:
209 ---------------------------
210 Q: Could we have the first reference (existence) mean it could be on the runnable
211 list or otherwise in the proc system (but not other subsystems)?  In this case,
212 proc_run() won't need to eat a reference at all - it will just incref for every
213 current it will set up.
214
215 A: No: if you pid2proc(), then proc_run() but never return, you have (and lose)
216 an extra reference.  We need proc_run() to eat the reference when it does not
217 return.  If you decref between pid2proc() and proc_run(), there's a (rare) race
218 where the refcnt hits 0 by someone else trying to kill it.  While proc_run()
219 will check to see if someone else is trying to kill it, there's a slight chance
220 that the struct will be reused and recreated.  It'll probably never happen, but
221 it could, and out of principle we shouldn't be referencing memory after it's
222 been deallocated.  Avoiding races like this is one of the reasons for our refcnt
223 discipline.
224
225 Q: Could proc_run() always eat your reference, which would make it easier for
226 its implementation?
227
228 A: Yeah, technically, but it'd be a pain, as mentioned above.  You'd need to
229 reaquire a reference via pid2proc, and is rather easy to mess up.
230
231 Q: Could we have made proc_destroy() take a flag, saying whether or not it was
232 called on current and needed a decref instead of wasting an incref?
233
234 A: We could, but won't.  This is one case where the external caller is the one
235 that knows the function needs to decref or not.  But it breaks the convention a
236 bit, doesn't mirror proc_create() as well, and we need to pull in the cacheline
237 with the refcnt anyways.  So for now, no.
238
239 Q: Could we make __proc_give_cores() simply not return if an IPI is coming?
240
241 A: I did this originally, and manually unlocked and __wait_for_ipi()d.  Though
242 we'd then need to deal with it like that for all of the related functions, which
243 doesn't work if you wanted to do something afterwards (like schedule(p)).  Also
244 these functions are meant to be internal helpers, so returning the bool makes
245 more sense.  It eventually led to having __proc_unlock_ipi_pending(), which made
246 proc_destroy() much cleaner and helped with a general model of dealing with
247 these issues.  Win-win.
248
249 2. When Do We Really Leave "Process Context"?
250 ===========================
251 2.1 Overview
252 ---------------------------
253 First off, it's not really "process context" in the way Linux deals with it.  We
254 aren't operating in kernel mode on behalf of the process (always).  We are
255 specifically talking about when a process's cr3 is loaded on a core.  Usually,
256 current is also set (the exception for now is when processing ARSCs).
257
258 There are a couple different ways to do this.  One is to never unload a context
259 until something new is being run there (handled solely in __proc_startcore()).
260 Another way is to always explicitly leave the core, like by abandon_core()ing.
261
262 The issue with the former is that you could have contexts sitting around for a
263 while, and also would have a bit of extra latency when __proc_free()ing during
264 someone *else's* __proc_startcore() (though that could be avoided if it becomes
265 a real issue, via some form of reaping).  You'll also probably have excessive
266 decrefs (based on the interactions between proc_run() and __startcore()).
267
268 The issue with the latter is excessive TLB shootdowns and corner cases.  There
269 could be some weird cases (in core_request() for example) where the core you are
270 running on has the context loaded for proc A on a mgmt core, but decides to give
271 it to proc B.
272
273 If no process is running there, current == 0 and boot_cr3 is loaded, meaning no
274 process's context is loaded.
275
276 2.2 Here's how it is done now:
277 ---------------------------
278 We try to proactively leave, but have the ability to stay in context til
279 __proc_startcore() to handle the corner cases (and to maybe cut down the TLB
280 flushes later).  To stop proactively leaving, just change abandon_core() to not
281 do anything with current/cr3.  You'll see weird things like processes that won't
282 die until their old cores are reused.  The reason we proactively leave context
283 is to help with sanity for these issues, and also to avoid decref's in
284 __startcore().
285
286 A couple other details: __startcore() sorts the extra increfs, and
287 __proc_startcore() sorts leaving the old context.  Anytime a __startcore kernel
288 message is sent, the sender increfs in advance for the current refcnt.  If that
289 was in error, __startcore decrefs.  __proc_startcore(), which the last moment
290 before we *must* have the cr3/current issues sorted, does the actual check if
291 there was an old process there or not, while it handles the lcr3 (if necessary).
292 In general, lcr3's ought to have refcnts near them, or else comments explaining
293 why not.
294
295 So we leave process context when told to do so (__death/abandon_core()) or if
296 another process is run there.  The _M code is such that a proc will stay on its
297 core until it receives a message, and that message would cleanup/restore a
298 generic context (boot_cr3).  A _S could stay on its core until another _S came
299 in.  This is much simpler for cases when a timer interrupt goes off to force a
300 schedule() decision.  It also avoids a TLB flush in case the scheduler picked
301 that same proc to run again.  This could also happen to an _M, if for some
302 reason it was given a management core (!!!) or some other event happened that
303 caused some management/scheduling function to run on one of it's cores (perhaps
304 it asked).
305
306 proc_yield() abandons the core / leaves context.
307
308 2.3 Other issues:
309 ---------------------------
310 Note that dealing with interrupting processes that are in the kernel is tricky.
311 There is no true process context, so we can't leave a core until the kernel is
312 in a "safe place", i.e. it's state is bundled enough that it can be recontinued
313 later.  Calls of this type are routine kernel messages, executed at a convenient
314 time (specifically, before we return to userspace in proc_restartcore().
315
316 This same thing applies to __death messages.  Even though a process is dying, it
317 doesn't mean we can just drop whatever the kernel was doing on its behalf.  For
318 instance, it might be holding a reference that will never get decreffed if its
319 stack gets dropped.
320
321 3. Leaving the Kernel Stack:
322 ===========================
323 Just because a message comes in saying to kill a process, it does not mean we
324 should immediately abandon_core().  The problem is more obvious when there is
325 a preempt message, instead of a death message, but either way there is state
326 that needs cleaned up (refcnts that need downed, etc).
327
328 The solution to this is rather simple: don't abandon right away.  That was
329 always somewhat the plan for preemption, but was never done for death.  And
330 there are several other cases to worry about too.  To enforce this, we expand
331 the old "active messages" into a generic work execution message (a kernel
332 message) that can be delayed or shipped to another core.  These types of
333 messages will not be executed immediately on the receiving pcore - instead they
334 are on the queue for "when there's nothing else to do in the kernel", which is
335 checked in smp_idle() and before returning to userspace in proc_restartcore().
336 Additionally, these kernel messages can also be queued on an alarm queue,
337 delaying their activation as part of a generic kernel alarm facility.
338
339 One subtlety is that __proc_startcore() shouldn't check for messages, since it
340 is called by __startcore (a message).  Checking there would run the messages out
341 of order, which is exactly what we are trying to avoid (total chaos).  No one
342 should call __proc_startcore, other than proc_restartcore() or __startcore().
343 If we ever have functions that do so, if they are not called from a message,
344 they must check for outstanding messages.
345
346 This last subtlety is why we needed to change proc_run()'s _S case to use a
347 local message instead of calling proc_starcore (and why no one should ever call
348 proc_startcore()).  We could unlock, thereby freeing another core to change the
349 proc state and send a message to us, then try to proc_startcore, and then
350 reading the message before we had installed current or had a userspace TF to
351 preempt, and probably a few other things.  Treating _S as a local message is
352 cleaner, begs to be merged in the code with _M's code, and uses the messaging
353 infrastructure to avoid all the races that it was created to handle.
354
355 Incidentally, we don't need to worry about missing messages while trying to pop
356 back to userspace from __proc_startcore, since an IPI will be on the way
357 (possibly a self-ipi caused by the __kernel_message() handler).  This is also
358 why we needed to make process_routine_kmsg() keep interrupts disabled when it
359 stops (there's a race between checking the queue and disabling ints).
360
361 4. Preemption and Notification Issues:
362 ===========================
363 4.1: Message Ordering and Local Calls:
364 ---------------------------
365 Since we go with the model of cores being told what to do, there are issues
366 with messages being received in the wrong order.  That is why we have the
367 kernel messages (guaranteed, in-order delivery), with the proc-lock protecting
368 the send order.  However, this is not enough for some rare races.
369
370 Local calls can also perform the same tasks as messages (calling
371 proc_destroy() while a death IPI is on its way). We refer to these calls as
372 messing with "local fate" (compared to global state (we're clever).
373 Preempting a single vcore doesn't change the process's state).  These calls
374 are a little different, because they also involve a check to see if it should
375 perform the function or other action (e.g., death just idling and waiting for
376 an IPI instead of trying to kill itself), instead of just blindly doing
377 something.
378
379 4.1.1: Possible Solutions
380 ----------------
381 There are two ways to deal with this.  One (and the better one, I think) is to
382 check state, and determine if it should proceed or abort.  This requires that
383 all local-fate dependent calls always have enough state, meaning that any
384 function that results in sending a directive to a vcore store enough info in
385 the proc struct that a local call can determine if it should take action or
386 abort.  This might be sufficient.  This works for death already, since you
387 aren't supposed to do anything other than die (and restore any invariants
388 first, handled in Section 3).  We'll go with this way.
389
390 The other way is to send the work (including the checks) in a self-ipi kernel
391 message.  This will guarantee that the message is executed after any existing
392 messages (making the k_msg queue the authority for what should happen to a
393 core).  The check is also performed later (when the k_msg executes).  There
394 are a couple issues with this: if we allow the local core to send itself an
395 k_msg that could be out of order (meaning it should not be sent, and is only
396 sent due to ignorance of its sealed fate), AND if we return the core to the
397 idle-core-list once its fate is sealed, we need to detect that the message is
398 for the wrong process and that the process is in the wrong state.  To do this,
399 we probably need local versioning on the pcore so it can detect that the
400 message is late/wrong.  We might get by with just the proc* (though that is
401 tricky with death and proc reuse), so long as we don't allow new startcores
402 for a proc until AFTER the preemption is completed.
403
404 4.2: Preempt-Served Flag
405 ----------------
406 We want to be able to consider a pcore free once its owning proc has dealt
407 with removing it (not necessarily taken from the vcoremap, but at least it is
408 a done-deal that the core will go away and the messages are sent).  This
409 allows a scheduler-like function to easily take a core and then give it to
410 someone else, without waiting for each vcore to respond, saying that the pcore
411 is free/idle.
412
413 Since we want to keep the pcore in the vcoremap, we need another signal to let
414 a process know a message is already on its way.  preempt_pending is a signal
415 to userspace that the alarm was set, not that an actual message is on its way
416 and that a vcore's fate is sealed.  Since we can't use a pcore's presence in
417 the vcoremap to determine that the core should be revoked, we have to check
418 the "fate sealed"/preempt-served flag. 
419
420 It's a bit of a pain to have this flag, just to resolve this race in the
421 kernel, though the local call would have to check the vcoremap anyway,
422 incurring a cache miss if we go with using the vcoremap to signal the
423 impending message.
424
425 The preempt_pending flag is actual a timestamp, with the expiration time of
426 the core at which the message will be sent.  We could try to use that, but
427 since alarms aren't fired at exactly the time they are scheduled, the message
428 might not actually be sent yet (though it will, really soon).  Still, we'll
429 just go with the preempt-served flag for now.
430
431 4.3: Impending Notifications
432 ----------------
433 It's also possible that there is an impending notification.  There's no change
434 in fate (though there could be a fate-changing preempt on its way), just the
435 user wants a notification handler to run.  We need a flag anyways for this
436 (discussed below), so proc_yield() or whatever other local call we have can
437 check this flag as well.  
438
439 Though for proc_yield(), it doesn't care if a notification is on its way (can
440 be dependent on a flag to yield from userspace, based on the nature of the
441 yield (which still needs to be sorted)).  If the yield is in response to a
442 preempt_pending, it actually should yield and not receive the notification.
443 So it should destroy its vcoreid->pcoreid mapping and abandon_core().  When
444 that notification hits, it will be for a proc that isn't current, and will be
445 ignored (it will get run the next time that vcore fires up, handled below).
446
447 There is a slight chance that the same proc will run on that pcore, but with a
448 different vcore.  In the off chance this happens, the new vcore will get a
449 spurious notification.  Userspace needs to be able to handle spurious
450 notifications anyways, (there are a couple other cases, and in general it's
451 not hard to do), so this is not a problem.  Instead of trying to have the
452 kernel ignore the notification, we just send a spurious one.  A crappy
453 alternative would be to send the vcoreid with the notification, but that would
454 mean we can't send a generic message (broadcast) to a bunch of cores, which
455 will probably be a problem later.
456
457 Note that this specific case is because the "local work message" gets
458 processed out of order with respect to the notification.  And we want this in
459 that case, since that proc_yield() is more important than the notification.
460
461 4.4: Preemption / Allocation Phases and Alarm Delays
462 ---------------------------
463 A per-vcore preemption phase starts when the kernel marks the core's
464 preempt_pending flag/counter and can includes the time when an alarm is
465 waiting to go off to reclaim the core.  The phase ends when the vcore's pcore
466 is reclaimed, either as a result of the kernel taking control, or because a
467 process voluntarily yielded.
468
469 Specifically, the preempt_pending variable is actually a timestamp for when
470 the core will be revoked (this assumes some form of global time, which we need
471 anyways).  If its value is 0, then there is no preempt-pending, it is not in a
472 phase, and the vcore can be given out again. 
473
474 When a preempt alarm goes off, the alarm only means to check a process for
475 expired vcores.  If the vcore has been yielded while the alarm was pending,
476 the preempt_pending flag will be reset to 0.  To speed up the search for
477 vcores to preempt, there's a circular buffer corelist in the proc struct, with
478 vcoreids of potential suspects.  Or at least this will exist at some point.
479 Also note that the preemption list isn't bound to a specific alarm: you can
480 check the list at any time (not necessarily on a specific alarm), and you can
481 have spurious alarms (the list is empty, so it'll be a noop).
482
483 Likewise, a global preemption phase is when an entire MCP is getting
484 gang_prempted, and the global deadline is set.  A function can quickly check
485 to see if the process responded, since the list of vcores with preemptions
486 pending will be empty.
487
488 It seems obvious, but we do not allow allocation of a vcore during its
489 preemption phase.  The main reason is that it can potentially break
490 assumptions about the vcore->pcore mapping and can result in multiple
491 instances of the same vcore on different pcores.  Imagine a preempt message
492 sent to a pcore (after the alarm goes off), meanwhile that vcore/pcore yields
493 and the vcore reactivates somewhere else.  There is a potential race on the
494 preempt_tf state: the new vcore is reading while the old is writing.  This
495 issue is sorted naturally: the vcore entry in the vcoremap isn't cleared until
496 the vcore/pcore is actually yielded/taken away, so the code looking for a free
497 vcoreid slot will not try to use it.
498
499 Note that if we didn't design the alarm system to simply check for
500 preemptions (perhaps it has a stored list of vcores to preempt), then we
501 couldn't end the preempt-phase until the alarm was sorted.  If that is the
502 case, we could easily give out a vcore that had been yielded but was still in
503 a preempt-phase.  Stopping an alarm would be tricky too, since there could be
504 lots of vcores in different states that need to be sorted by the alarm (so
505 ripping it out isn't enough).  Setting a flag might not be enough either.
506 Vcore version numbers/history (as well as global proc histories) is a pain I'd
507 like to avoid too.  So don't change the alarm / delayed preemption system
508 without thinking about this.
509
510 Also, allowing a vcore to restart while preemptions are pending also mucks
511 with keeping the vcore mapping "old" (while the message is in flight).  A
512 pcore will want to use that to determine which vcore is running on it.  It
513 would be possible to keep a pcoremap for the reverse mapping out of sync, but
514 that seems like a bad idea.  In general, having the pcoremap is a good idea
515 (whenever we talk about a vcoremap, we're usually talking about both
516 directions: "the vcore->pcore mapping").
517
518 4.5: Global Preemption Flags
519 ---------------------------
520 If we are trying to preempt an entire process at the same time, instead of
521 playing with the circular buffer of vcores pending preemption, we could have a
522 global timer as well.  This avoids some O(n) operations, though it means that
523 userspace needs to check two "flags" (expiration dates) when grabbing its
524 preempt-critical locks.
525
526 4.6: Notifications Mixed with Preemption and Sleeping
527 ---------------------------
528 It is possible that notifications will mix with preemptions or come while a
529 process is not running.  Ultimately, the process wants to be notified on a
530 given vcore.  Whenever we send an active notification, we set a flag in
531 procdata.  If the vcore is offline or is in a preempt-phase, we don't bother
532 sending the IPI/notif message.  The kernel will make sure it runs the
533 notification handler (as well as restoring the preempt_tf) the next time that
534 vcore is restarted.  Note that userspace can toggle this, so they can handle
535 the notifications from a different core if it likes, or they can independently
536 send a notification.
537  
538 4.7: Notifs While a Preempt Message is Served
539 ---------------------------
540 It is possible to have the kernel handling a notification k_msg and to have a
541 preempt k_msg in the queue (preempt-served flag is set).  Ultimately, what we
542 want is for the core to be preempted and the notification handler to run on
543 the next execution.  Both messages are in the k_msg queue for "a convenient
544 time to leave the kernel" (I'll have a better name for that later).  What we
545 do is execute the notification handler and jump to userspace.  Since there is
546 still an k_msg in the queue (and we self_ipi'd ourselves, it's part of how
547 k_msgs work), the IPI will fire and push us right back into the kernel to
548 execute the preemption, and the notif handler's context will be saved in the
549 preempt_tf (ready to go when the vcore gets started again).
550
551 We could try to just set the notif_pending flag and ignore the message, but
552 that would involve inspecting the queue for the preempt k_msg.  Additionally,
553 a preempt k_msg can arrive anyway.  Finally, it's possible to have another
554 message in the queue between the notif and the preempt, and it gets ugly
555 quickly trying to determine what to do.
556
557 4.8: When a Pcore is "Free"
558 ---------------------------
559 There are a couple ways to handle pcores.  One approach would be to not
560 consider them free and able to be given to another process until the old
561 process is completely removed (abandon_core()).  Another approach is to free
562 the core once its fate is sealed (which we do).  This probably gives more
563 flexibility in schedule()-like functions (no need to wait to give the core
564 out), quicker dispatch latencies, less contention on shared structs (like the
565 idle-core-map), etc.
566
567 Also, we don't remove the pcore from the vcoremap, even if it is being
568 allocated to another core (the same pcore can exist in two vcoremaps, contrary
569 to older statements).  Taking the pcore from the vcoremap would mean some
570 non-fate related local calls (sys_get_vcoreid()) will fail, since the vcoreid
571 is gone!  Additionally, we don't need a vcoreid in the k_msg (we would have if
572 we could not use the vcore/pcoremappings).  There should not be any issues
573 with the new process sending messages to the pcore before the core is sorted,
574 since k_msgs are delivered in order.
575
576 Another tricky part is the seq_ctr used to signal userspace of changes to the
577 coremap or num_vcores (coremap_seqctr).  While we may not even need this in the
578 long run, it still seems like it could be useful.  The trickiness comes from
579 when we update the seq_ctr when we are unmapping vcores on the receive side of a
580 message (like __death or __preempt).  We'd rather not have each pcore contend on
581 the seq_ctr cache line (let alone any locking) while they perform a somewhat
582 data-parallel task.  So we continue to have the sending core handle the seq_ctr
583 upping and downing.  This works, since the "unlocking" happens after messages
584 are sent, which means the receiving core is no longer in userspace (if there is
585 a delay, it is because the remote core is in the kernel, possibly with
586 interrupts disabled).  Because of this, userspace will be unable to read the new
587 value of the seq_ctr before the IPI hits and does the unmapping that the seq_ctr
588 protects/advertises.  This is most likely true.  It wouldn't be if the "last IPI
589 was sent" flag clears before the IPI actually hit the other core.
590
591 4.9: Future Broadcast/Messaging Needs
592 ---------------------------
593 Currently, messaging is serialized.  Broadcast IPIs exist, but the kernel
594 message system is based on adding an k_msg to a list in a pcore's
595 per_cpu_info.  Further the sending of these messages is in a loop.  In the
596 future, we would like to have broadcast messaging of some sort (literally a
597 broadcast, like the IPIs, and if not that, then a communication tree of
598 sorts).  
599
600 Given those desires, we want to make sure that no message we send needs
601 details specific to a pcore (such as the vcoreid running on it, a history
602 number, or anything like that).  Thus no k_msg related to process management
603 should have anything that cannot apply to the entire process.  At this point,
604 most just have a struct proc *.  A pcore ought to be able to figure out what
605 is happening based on the pcoremap, information in the struct proc, and in the
606 preempt struct in procdata.
607
608 4.10: Other Things We Thought of but Don't Like
609 ---------------------------
610 All local fate-related work is sent as a self k_msg, to enforce ordering.
611 It doesn't capture the difference between a local call and a remote k_msg.
612 The k_msg has already considered state and made its decision.  The local call
613 is an attempt.  It is also unnecessary, if we put in enough information to
614 make a decision in the proc struct.  Finally, it caused a few other problems
615 (like needing to detect arbitrary stale messages).
616
617 Overall message history: doesn't work well when you do per-core stuff, since
618 it will invalidate other messages for the process.  We then though of a pcore
619 history counter to detect stale messages.  Don't like that either.  We'd have
620 to send the history in the message, since it's a per-message, per-core
621 expiration.  There might be other ways around this, but this doesn't seem
622 necessary.
623
624 Alarms have pointers to a list of which cores should be preempted when that
625 specific alarm goes off (saved with the alarm).  Ugh.  It gets ugly with
626 multiple outstanding preemptions and cores getting yielded while the alarms
627 sleep (and possibly could get reallocated, though we'd make a rule to prevent
628 that).  Like with notifications, being able to handle spurious alarms and
629 thinking of an alarm as just a prod to check somewhere is much more flexible
630 and simple.  It is similar to generic messages that have the actual important
631 information stored somewhere else (as with allowing broadcasts, with different
632 receivers performing slightly different operations).
633
634 Synchrony for messages (wanting a response to a preempt k_msg, for example)
635 sucks.  Just encode the state of impending fate in the proc struct, where it
636 belongs.  Additionally, we don't want to hold the proc lock even longer than
637 we do now (which is probably too long as it is).  Finally, it breaks a golden
638 rule: never wait while holding a lock: you will deadlock the system (e.g. if
639 the receiver is already in the kernel spinning on the lock).  We'd have to
640 send messages, unlock (which might cause a message to hit the calling pcore,
641 as in the case of locally called proc_destroy()), and in the meantime some
642 useful invariant might be broken.
643
644 We also considered using the transition stack as a signal that a process is in
645 a notification handler.  The kernel can inspect the stack pointer to determine
646 this.  It's possible, but unnecessary.
647
648 5. TBD
649 ===========================