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