Vcore management uses the lists
[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. Locking!
16 7. TLB Coherency
17 8. Process Management
18 9. TBD
19
20 1. Reference Counting
21 ===========================
22 1.1 Basics:
23 ---------------------------
24 Reference counts exist to keep a process alive.  We use krefs for this, similar
25 to Linux's kref:
26 - Can only incref if the current value is greater than 0, meaning there is
27   already a reference to it.  It is a bug to try to incref on something that has
28   no references, so always make sure you incref something that you know has a
29   reference.  If you don't know, you need to get it from pid2proc (which is a
30   careful way of doing this - pid2proc kref_get_not_zero()s on the reference that is
31   stored inside it).  If you incref and there are 0 references, the kernel will
32   panic.  Fix your bug / don't incref random pointers.
33 - Can always decref.
34 - When the decref returns 0, perform some operation.  This does some final
35   cleanup on the object.
36 - Process code is trickier since we frequently make references from 'current'
37   (which isn't too bad), but also because we often do not return and need to be
38   careful about the references we passed in to a no-return function.
39
40 1.2 Brief History of the Refcnt:
41 ---------------------------
42 Originally, the refcnt was created to keep page tables from being destroyed (in
43 proc_free()) while cores were still using them, which is what was happens during
44 an ARSC (async remote syscall).  It was then defined to be a count of places in
45 the kernel that had an interest in the process staying alive, practically just
46 to protect current/cr3.  This 'interest' actually extends to any code holding a
47 pointer to the proc, such as one acquired via pid2proc(), which is its current
48 meaning.
49
50 1.3 Quick Aside: The current Macro:
51 ---------------------------
52 current is a pointer to the proc that is currently loaded/running on any given
53 core.  It is stored in the per_cpu_info struct, and set/managed by low-level
54 process code.  It is necessary for the kernel to quickly figure out who is
55 running on its code, especially when servicing interrupts and traps.  current is
56 protected by a refcnt.
57
58 1.4 Reference Counting Rules:
59 ---------------------------
60 +1 for existing.
61 - The fact that the process is supposed to exist is worth +1.  When it is time
62   to die, we decref, and it will eventually be cleaned up.  This existence is
63   explicitly kref_put()d in proc_destroy().
64 - The hash table is a bit tricky.  We need to kref_get_not_zero() when it is
65   locked, so we know we aren't racing with proc_free freeing the proc and
66   removing it from the list.  After removing it from the hash, we don't need to
67   kref_put it, since it was an internal ref.  The kref (i.e. external) isn't for
68   being on the hash list, it's for existing.  This separation allows us to
69   remove the proc from the hash list in the "release" function.  See kref.txt
70   for more details.
71
72 +1 for someone using it or planning to use it.
73 - This includes simply having a pointer to the proc, since presumably you will
74   use it.  pid2proc() will incref for you.  When you are done, decref.
75 - Functions that create a process and return a pointer (like proc_create() or
76   kfs_proc_create()) will also up the refcnt for you.  Decref when you're done.
77 - If the *proc is stored somewhere where it will be used again, such as in an IO
78   continuation, it needs to be refcnt'd.  Note that if you already had a
79   reference from pid2proc(), simply don't decref after you store the pointer.
80
81 +1 for current.
82 - current counts as someone using it (expressing interest in the core), but is
83   also a source of the pointer, so its a bit different.  Note that all kref's
84   are sources of a pointer.  Technically, to even use 'current', we should kref
85   it and pass it around as a proc.  We don't for performance reasons.  When we
86   are running on a core that has current loaded, the ref is both for its usage
87   as well as for being the current process.
88 - You have a reference from current and can use it without refcnting, but
89   anything that needs to eat a reference or store/use it needs an incref first.
90   To be clear, your reference is *NOT* edible.  It protects the cr3, guarantees
91   the process won't die, and serves as a bootstrappable reference.
92 - Specifically, if you get a ref from current, but then save it somewhere (like
93   an IO continuation request), then clearly you must incref, since it's both
94   current and stored/used.
95 - If you don't know what might be downstream from your function, then incref
96   before passing the reference, and decref when it returns.  We used to do this
97   for all syscalls, but now only do it for calls that might not return and
98   expect to receive reference (like proc_yield).
99
100 All functions that take a *proc have a refcnt'd reference, though it may not be
101 edible (it could be current).  It is the callers responsibility to make sure
102 it'd edible if it necessary.  It is the callees responsibility to incref if it
103 stores or makes a copy of the reference.
104
105 1.5 Functions That Don't or Might Not Return:
106 ---------------------------
107 Refcnting and especially decreffing gets tricky when there are functions that
108 MAY not return.  proc_restartcore() does not return (it pops into userspace).
109 proc_run() might not return, if the core it was called on will pop into
110 userspace (if it was a _S, or if the core is part of the vcoremap for a _M).
111
112 Functions that MAY not return will "eat" your reference *IF* they do not return.
113 This means that you must have a reference when you call them (like always), and
114 that reference will be consumed / decref'd for you if the function doesn't
115 return.  Or something similarly appropriate.
116
117 Arguably, for functions that MAY not return, but will always be called with
118 current's reference (proc_yield()), we could get away without giving it an
119 edible reference, and then never eating the ref.  Yield needs to be reworked
120 anyway, so it's not a bit deal yet.
121
122 We do this because when the function does not return, you will not have the
123 chance to decref (your decref code will never run).  We need the reference when
124 going in to keep the object alive (like with any other refcnt).  We can't have
125 the function always eat the reference, since you cannot simply re-incref the
126 pointer (not allowed to incref unless you know you had a good reference).  You'd
127 have to do something like p = pid2proc(p_pid);  It's clunky to do that, easy to
128 screw up, and semantically, if the function returns, then we may still have an
129 interest in p and should decref later.
130
131 The downside is that functions need to determine if they will return or not,
132 which can be a pain (a linear time search when running an _M, for instance,
133 which can suck if we are trying to use a broadcast/logical IPI).
134
135 As the caller, you usually won't know if the function will return or not, so you
136 need to provide a consumable reference.  Current doesn't count.  For example,
137 proc_run() requires a reference.  You can proc_run(p), and use p afterwards, and
138 later decref.  You need to make sure you have a reference, so things like
139 proc_run(pid2proc(55)) works, since pid2proc() increfs for you.  But you cannot
140 proc_run(current), unless you incref current in advance.  Incidentally,
141 proc_running current doesn't make a lot of sense.
142
143 As another example, __proc_startcore() will take your reference and store it
144 in current.  Since it is used by both the __startcore and the interrupt return
145 paths (proc_restartcore() now, formerly called proc_startcore()), we're
146 currently going with the model of "caller makes sure there is a ref for
147 current".  Check its comments for details.
148
149 1.6 Runnable List:
150 ---------------------------
151 Procs on the runnable list need to have a refcnt (other than the +1 for
152 existing).  It's something that cares that the process exists.  We could have
153 had it implicitly be refcnt'd (the fact that it's on the list is enough, sort of
154 as if it was part of the +1 for existing), but that complicates things.  For
155 instance, it is a source of a reference (for the scheduler) and you could not
156 proc_run() a process from the runnable list without worrying about increfing it
157 before hand.  Remember that proc_run() might consume your reference (which
158 actually turns into a current reference, which is later destroyed by decref in
159 abandon_core()).
160
161 1.7 Internal Details for Specific Functions:
162 ---------------------------
163 proc_run(): makes sure enough refcnts are in place for all places that will
164 install current.  This also makes it easier on the system (one big incref(n),
165 instead of n increfs of (1) from multiple cores).  In the off chance current was
166 already set for a core receiving the kernel message, __startcore will decref.
167 Also note that while proc_run() consumes your reference, it's not actually
168 decreffing, so there's no danger within proc_run() of the process dying /
169 __proc_free()ing.
170
171 __proc_startcore(): assumes all references to p are sorted.  *p is already
172 accounted for as if it was current on the core startcore runs on. (there is only
173 one refcnt for both *p and current, not 2 separate ones).
174
175 proc_destroy(): it might not return (if the calling core belongs to the
176 process), so it may eat your reference and you must have an edible reference.
177 It is possible you called proc_destroy(current).  The cleanup of the current
178 will be its own decref, so you need to have a usable/real reference (current
179 doesn't count as an edible reference).  So incref before doing that.  Even if p
180 == current, proc_destroy() can't tell if you sent it p (and had a reference) or
181 current and didn't.
182
183 proc_yield(): this never returns, so it eats your reference.  It will also
184 decref when it abandon_core()s.
185
186 __proc_give_cores() and friends: you call this while holding the lock, but it is
187 possible that your core is in the corelist you gave it.  In this case, it will
188 detect it, and return a bool signalling if an IPI is pending.  It will not
189 consume your reference.  The reasoning behind this is that it is an internal
190 function, and you may want to do other things before decreffing.  There is also
191 a helper function that will unlock and possibly decref/wait for the IPI, called
192 __proc_unlock_ipi_pending().  Use this when it is time to unlock.  It's just a
193 helper, which may go away.
194
195 abandon_core(): it was not given a reference, so it doesn't eat one.  It will
196 decref when it unloads the cr3.  Note that this is a potential performance
197 issue.  When preempting or killing, there are n cores that are fighting for the
198 cacheline to decref.  An alternative would be to have one core decref for all n
199 cores, after it knows all cores unloaded the cr3.  This would be a good use of
200 the checklist (possibly with one cacheline per core).  It would take a large
201 amount of memory for better scalability.
202
203 1.8 Core Request:
204 ---------------------------
205 core_request() is run outside of the process code (for now), though it is fairly
206 intricate.  It's another function that might not return, but the reasons for
207 this vary:
208         1: The process is moving from _S to _M so the return path to userspace won't
209         happen (and sort of will on the new core / the other side), but that will
210         happen when popping into userspace.
211         2: The scheduler is giving the current core to the process, which can kick
212         in via either proc_run() or __proc_give_cores().
213         3: It was a request to give up all cores, which means the current core will
214         receive an IPI (if it wasn't an async call, which isn't handled yet).
215
216 For these reasons, core_request() needs to have an edible reference.
217
218 Also, since core_request calls functions that might not return, there are cases
219 where it will not be able to call abandon_core() and leave process context.
220 This is an example of why we have the fallback case of leaving process context
221 in proc_startcore().  See the section below about process context for more
222 information.
223
224 Eventually, core_request() will be split better, probably with the brutal logic
225 in process.c that would call out some functions in resource.c that actually make
226 choices.
227
228 1.9 Things I Could Have Done But Didn't And Why:
229 ---------------------------
230 Q: Could we have the first reference (existence) mean it could be on the runnable
231 list or otherwise in the proc system (but not other subsystems)?  In this case,
232 proc_run() won't need to eat a reference at all - it will just incref for every
233 current it will set up.
234
235 A: No: if you pid2proc(), then proc_run() but never return, you have (and lose)
236 an extra reference.  We need proc_run() to eat the reference when it does not
237 return.  If you decref between pid2proc() and proc_run(), there's a (rare) race
238 where the refcnt hits 0 by someone else trying to kill it.  While proc_run()
239 will check to see if someone else is trying to kill it, there's a slight chance
240 that the struct will be reused and recreated.  It'll probably never happen, but
241 it could, and out of principle we shouldn't be referencing memory after it's
242 been deallocated.  Avoiding races like this is one of the reasons for our refcnt
243 discipline.
244
245 Q: Could proc_run() always eat your reference, which would make it easier for
246 its implementation?
247
248 A: Yeah, technically, but it'd be a pain, as mentioned above.  You'd need to
249 reaquire a reference via pid2proc, and is rather easy to mess up.
250
251 Q: Could we have made proc_destroy() take a flag, saying whether or not it was
252 called on current and needed a decref instead of wasting an incref?
253
254 A: We could, but won't.  This is one case where the external caller is the one
255 that knows the function needs to decref or not.  But it breaks the convention a
256 bit, doesn't mirror proc_create() as well, and we need to pull in the cacheline
257 with the refcnt anyways.  So for now, no.
258
259 Q: Could we make __proc_give_cores() simply not return if an IPI is coming?
260
261 A: I did this originally, and manually unlocked and __wait_for_ipi()d.  Though
262 we'd then need to deal with it like that for all of the related functions, which
263 doesn't work if you wanted to do something afterwards (like schedule(p)).  Also
264 these functions are meant to be internal helpers, so returning the bool makes
265 more sense.  It eventually led to having __proc_unlock_ipi_pending(), which made
266 proc_destroy() much cleaner and helped with a general model of dealing with
267 these issues.  Win-win.
268
269 2. When Do We Really Leave "Process Context"?
270 ===========================
271 2.1 Overview
272 ---------------------------
273 First off, it's not really "process context" in the way Linux deals with it.  We
274 aren't operating in kernel mode on behalf of the process (always).  We are
275 specifically talking about when a process's cr3 is loaded on a core.  Usually,
276 current is also set (the exception for now is when processing ARSCs).
277
278 There are a couple different ways to do this.  One is to never unload a context
279 until something new is being run there (handled solely in __proc_startcore()).
280 Another way is to always explicitly leave the core, like by abandon_core()ing.
281
282 The issue with the former is that you could have contexts sitting around for a
283 while, and also would have a bit of extra latency when __proc_free()ing during
284 someone *else's* __proc_startcore() (though that could be avoided if it becomes
285 a real issue, via some form of reaping).  You'll also probably have excessive
286 decrefs (based on the interactions between proc_run() and __startcore()).
287
288 The issue with the latter is excessive TLB shootdowns and corner cases.  There
289 could be some weird cases (in core_request() for example) where the core you are
290 running on has the context loaded for proc A on a mgmt core, but decides to give
291 it to proc B.
292
293 If no process is running there, current == 0 and boot_cr3 is loaded, meaning no
294 process's context is loaded.
295
296 2.2 Here's how it is done now:
297 ---------------------------
298 We try to proactively leave, but have the ability to stay in context til
299 __proc_startcore() to handle the corner cases (and to maybe cut down the TLB
300 flushes later).  To stop proactively leaving, just change abandon_core() to not
301 do anything with current/cr3.  You'll see weird things like processes that won't
302 die until their old cores are reused.  The reason we proactively leave context
303 is to help with sanity for these issues, and also to avoid decref's in
304 __startcore().
305
306 A couple other details: __startcore() sorts the extra increfs, and
307 __proc_startcore() sorts leaving the old context.  Anytime a __startcore kernel
308 message is sent, the sender increfs in advance for the current refcnt.  If that
309 was in error, __startcore decrefs.  __proc_startcore(), which the last moment
310 before we *must* have the cr3/current issues sorted, does the actual check if
311 there was an old process there or not, while it handles the lcr3 (if necessary).
312 In general, lcr3's ought to have refcnts near them, or else comments explaining
313 why not.
314
315 So we leave process context when told to do so (__death/abandon_core()) or if
316 another process is run there.  The _M code is such that a proc will stay on its
317 core until it receives a message, and that message would cleanup/restore a
318 generic context (boot_cr3).  A _S could stay on its core until another _S came
319 in.  This is much simpler for cases when a timer interrupt goes off to force a
320 schedule() decision.  It also avoids a TLB flush in case the scheduler picked
321 that same proc to run again.  This could also happen to an _M, if for some
322 reason it was given a management core (!!!) or some other event happened that
323 caused some management/scheduling function to run on one of it's cores (perhaps
324 it asked).
325
326 proc_yield() abandons the core / leaves context.
327
328 2.3 Other issues:
329 ---------------------------
330 Note that dealing with interrupting processes that are in the kernel is tricky.
331 There is no true process context, so we can't leave a core until the kernel is
332 in a "safe place", i.e. it's state is bundled enough that it can be recontinued
333 later.  Calls of this type are routine kernel messages, executed at a convenient
334 time (specifically, before we return to userspace in proc_restartcore().
335
336 This same thing applies to __death messages.  Even though a process is dying, it
337 doesn't mean we can just drop whatever the kernel was doing on its behalf.  For
338 instance, it might be holding a reference that will never get decreffed if its
339 stack gets dropped.
340
341 3. Leaving the Kernel Stack:
342 ===========================
343 Just because a message comes in saying to kill a process, it does not mean we
344 should immediately abandon_core().  The problem is more obvious when there is
345 a preempt message, instead of a death message, but either way there is state
346 that needs cleaned up (refcnts that need downed, etc).
347
348 The solution to this is rather simple: don't abandon right away.  That was
349 always somewhat the plan for preemption, but was never done for death.  And
350 there are several other cases to worry about too.  To enforce this, we expand
351 the old "active messages" into a generic work execution message (a kernel
352 message) that can be delayed or shipped to another core.  These types of
353 messages will not be executed immediately on the receiving pcore - instead they
354 are on the queue for "when there's nothing else to do in the kernel", which is
355 checked in smp_idle() and before returning to userspace in proc_restartcore().
356 Additionally, these kernel messages can also be queued on an alarm queue,
357 delaying their activation as part of a generic kernel alarm facility.
358
359 One subtlety is that __proc_startcore() shouldn't check for messages, since it
360 is called by __startcore (a message).  Checking there would run the messages out
361 of order, which is exactly what we are trying to avoid (total chaos).  No one
362 should call __proc_startcore, other than proc_restartcore() or __startcore().
363 If we ever have functions that do so, if they are not called from a message,
364 they must check for outstanding messages.
365
366 This last subtlety is why we needed to change proc_run()'s _S case to use a
367 local message instead of calling proc_starcore (and why no one should ever call
368 proc_startcore()).  We could unlock, thereby freeing another core to change the
369 proc state and send a message to us, then try to proc_startcore, and then
370 reading the message before we had installed current or had a userspace TF to
371 preempt, and probably a few other things.  Treating _S as a local message is
372 cleaner, begs to be merged in the code with _M's code, and uses the messaging
373 infrastructure to avoid all the races that it was created to handle.
374
375 Incidentally, we don't need to worry about missing messages while trying to pop
376 back to userspace from __proc_startcore, since an IPI will be on the way
377 (possibly a self-ipi caused by the __kernel_message() handler).  This is also
378 why we needed to make process_routine_kmsg() keep interrupts disabled when it
379 stops (there's a race between checking the queue and disabling ints).
380
381 4. Preemption and Notification Issues:
382 ===========================
383 4.1: Message Ordering and Local Calls:
384 ---------------------------
385 Since we go with the model of cores being told what to do, there are issues
386 with messages being received in the wrong order.  That is why we have the
387 kernel messages (guaranteed, in-order delivery), with the proc-lock protecting
388 the send order.  However, this is not enough for some rare races.
389
390 Local calls can also perform the same tasks as messages (calling
391 proc_destroy() while a death IPI is on its way). We refer to these calls as
392 messing with "local fate" (compared to global state (we're clever).
393 Preempting a single vcore doesn't change the process's state).  These calls
394 are a little different, because they also involve a check to see if it should
395 perform the function or other action (e.g., death just idling and waiting for
396 an IPI instead of trying to kill itself), instead of just blindly doing
397 something.
398
399 4.1.1: Possible Solutions
400 ----------------
401 There are two ways to deal with this.  One (and the better one, I think) is to
402 check state, and determine if it should proceed or abort.  This requires that
403 all local-fate dependent calls always have enough state, meaning that any
404 function that results in sending a directive to a vcore store enough info in
405 the proc struct that a local call can determine if it should take action or
406 abort.  This might be sufficient.  This works for death already, since you
407 aren't supposed to do anything other than die (and restore any invariants
408 first, handled in Section 3).  We'll go with this way.
409
410 The other way is to send the work (including the checks) in a self-ipi kernel
411 message.  This will guarantee that the message is executed after any existing
412 messages (making the k_msg queue the authority for what should happen to a
413 core).  The check is also performed later (when the k_msg executes).  There
414 are a couple issues with this: if we allow the local core to send itself an
415 k_msg that could be out of order (meaning it should not be sent, and is only
416 sent due to ignorance of its sealed fate), AND if we return the core to the
417 idle-core-list once its fate is sealed, we need to detect that the message is
418 for the wrong process and that the process is in the wrong state.  To do this,
419 we probably need local versioning on the pcore so it can detect that the
420 message is late/wrong.  We might get by with just the proc* (though that is
421 tricky with death and proc reuse), so long as we don't allow new startcores
422 for a proc until AFTER the preemption is completed.
423
424 4.2: Preempt-Served Flag
425 ----------------
426 We want to be able to consider a pcore free once its owning proc has dealt
427 with removing it (not necessarily taken from the vcoremap, but at least it is
428 a done-deal that the core will go away and the messages are sent).  This
429 allows a scheduler-like function to easily take a core and then give it to
430 someone else, without waiting for each vcore to respond, saying that the pcore
431 is free/idle.
432
433 Since we want to keep the pcore in the vcoremap, we need another signal to let
434 a process know a message is already on its way.  preempt_pending is a signal
435 to userspace that the alarm was set, not that an actual message is on its way
436 and that a vcore's fate is sealed.  Since we can't use a pcore's presence in
437 the vcoremap to determine that the core should be revoked, we have to check
438 the "fate sealed"/preempt-served flag. 
439
440 It's a bit of a pain to have this flag, just to resolve this race in the
441 kernel, though the local call would have to check the vcoremap anyway,
442 incurring a cache miss if we go with using the vcoremap to signal the
443 impending message.
444
445 The preempt_pending flag is actual a timestamp, with the expiration time of
446 the core at which the message will be sent.  We could try to use that, but
447 since alarms aren't fired at exactly the time they are scheduled, the message
448 might not actually be sent yet (though it will, really soon).  Still, we'll
449 just go with the preempt-served flag for now.
450
451 4.3: Impending Notifications
452 ----------------
453 It's also possible that there is an impending notification.  There's no change
454 in fate (though there could be a fate-changing preempt on its way), just the
455 user wants a notification handler to run.  We need a flag anyways for this
456 (discussed below), so proc_yield() or whatever other local call we have can
457 check this flag as well.  
458
459 Though for proc_yield(), it doesn't care if a notification is on its way (can
460 be dependent on a flag to yield from userspace, based on the nature of the
461 yield (which still needs to be sorted)).  If the yield is in response to a
462 preempt_pending, it actually should yield and not receive the notification.
463 So it should destroy its vcoreid->pcoreid mapping and abandon_core().  When
464 that notification hits, it will be for a proc that isn't current, and will be
465 ignored (it will get run the next time that vcore fires up, handled below).
466
467 There is a slight chance that the same proc will run on that pcore, but with a
468 different vcoreid.  In the off chance this happens, the new vcore will get a
469 spurious notification.  Userspace needs to be able to handle spurious
470 notifications anyways, (there are a couple other cases, and in general it's
471 not hard to do), so this is not a problem.  Instead of trying to have the
472 kernel ignore the notification, we just send a spurious one.  A crappy
473 alternative would be to send the vcoreid with the notification, but that would
474 mean we can't send a generic message (broadcast) to a bunch of cores, which
475 will probably be a problem later.
476
477 Note that this specific case is because the "local work message" gets
478 processed out of order with respect to the notification.  And we want this in
479 that case, since that proc_yield() is more important than the notification.
480
481 4.4: Preemption / Allocation Phases and Alarm Delays
482 ---------------------------
483 A per-vcore preemption phase starts when the kernel marks the core's
484 preempt_pending flag/counter and can includes the time when an alarm is
485 waiting to go off to reclaim the core.  The phase ends when the vcore's pcore
486 is reclaimed, either as a result of the kernel taking control, or because a
487 process voluntarily yielded.
488
489 Specifically, the preempt_pending variable is actually a timestamp for when
490 the core will be revoked (this assumes some form of global time, which we need
491 anyways).  If its value is 0, then there is no preempt-pending, it is not in a
492 phase, and the vcore can be given out again. 
493
494 When a preempt alarm goes off, the alarm only means to check a process for
495 expired vcores.  If the vcore has been yielded while the alarm was pending,
496 the preempt_pending flag will be reset to 0.  To speed up the search for
497 vcores to preempt, there's a circular buffer corelist in the proc struct, with
498 vcoreids of potential suspects.  Or at least this will exist at some point.
499 Also note that the preemption list isn't bound to a specific alarm: you can
500 check the list at any time (not necessarily on a specific alarm), and you can
501 have spurious alarms (the list is empty, so it'll be a noop).
502
503 Likewise, a global preemption phase is when an entire MCP is getting
504 gang_prempted, and the global deadline is set.  A function can quickly check
505 to see if the process responded, since the list of vcores with preemptions
506 pending will be empty.
507
508 It seems obvious, but we do not allow allocation of a vcore during its
509 preemption phase.  The main reason is that it can potentially break
510 assumptions about the vcore->pcore mapping and can result in multiple
511 instances of the same vcore on different pcores.  Imagine a preempt message
512 sent to a pcore (after the alarm goes off), meanwhile that vcore/pcore yields
513 and the vcore reactivates somewhere else.  There is a potential race on the
514 preempt_tf state: the new vcore is reading while the old is writing.  This
515 issue is sorted naturally: the vcore entry in the vcoremap isn't cleared until
516 the vcore/pcore is actually yielded/taken away, so the code looking for a free
517 vcoreid slot will not try to use it.
518
519 Note that if we didn't design the alarm system to simply check for
520 preemptions (perhaps it has a stored list of vcores to preempt), then we
521 couldn't end the preempt-phase until the alarm was sorted.  If that is the
522 case, we could easily give out a vcore that had been yielded but was still in
523 a preempt-phase.  Stopping an alarm would be tricky too, since there could be
524 lots of vcores in different states that need to be sorted by the alarm (so
525 ripping it out isn't enough).  Setting a flag might not be enough either.
526 Vcore version numbers/history (as well as global proc histories) is a pain I'd
527 like to avoid too.  So don't change the alarm / delayed preemption system
528 without thinking about this.
529
530 Also, allowing a vcore to restart while preemptions are pending also mucks
531 with keeping the vcore mapping "old" (while the message is in flight).  A
532 pcore will want to use that to determine which vcore is running on it.  It
533 would be possible to keep a pcoremap for the reverse mapping out of sync, but
534 that seems like a bad idea.  In general, having the pcoremap is a good idea
535 (whenever we talk about a vcoremap, we're usually talking about both
536 directions: "the vcore->pcore mapping").
537
538 4.5: Global Preemption Flags
539 ---------------------------
540 If we are trying to preempt an entire process at the same time, instead of
541 playing with the circular buffer of vcores pending preemption, we could have a
542 global timer as well.  This avoids some O(n) operations, though it means that
543 userspace needs to check two "flags" (expiration dates) when grabbing its
544 preempt-critical locks.
545
546 4.6: Notifications Mixed with Preemption and Sleeping
547 ---------------------------
548 It is possible that notifications will mix with preemptions or come while a
549 process is not running.  Ultimately, the process wants to be notified on a
550 given vcore.  Whenever we send an active notification, we set a flag in procdata
551 (notif_pending).  If the vcore is offline, we don't bother sending the IPI/notif
552 message.  The kernel will make sure it runs the notification handler (as well as
553 restoring the preempt_tf) the next time that vcore is restarted.  Note that
554 userspace can toggle this, so they can handle the notifications from a different
555 core if it likes, or they can independently send a notification.
556
557 Note we use notif_pending to detect if an IPI was missed while notifs were
558 disabled (this is done in pop_ros_tf() by userspace).  The overall meaning of
559 notif_pending is that a vcore wants to be IPI'd.  The IPI could be in-flight, or
560 it could be missed.  Since notification IPIs can be spurious, when we have
561 potential races, we err on the side of sending.  This happens when pop_ros_tf()
562 notifies itself, and when the kernel starts a vcore in it's notif handler if it
563 was preempted and notif was pending.  In the latter case, the kernel will put
564 the preempt_tf in the notif_tf, so userspace can restart that at its leisure.
565
566 If a vcore has a preempt_pending, we will still send the active notification
567 (IPI).  The core ought to get a notification for the preemption anyway, so we
568 need to be able to send one.  Additionally, once the vcore is handling that
569 preemption notification, it will have notifs disabled, which will prevent us
570 from sending any extra notifications anyways.
571  
572 4.7: Notifs While a Preempt Message is Served
573 ---------------------------
574 It is possible to have the kernel handling a notification k_msg and to have a
575 preempt k_msg in the queue (preempt-served flag is set).  Ultimately, what we
576 want is for the core to be preempted and the notification handler to run on
577 the next execution.  Both messages are in the k_msg queue for "a convenient
578 time to leave the kernel" (I'll have a better name for that later).  What we
579 do is execute the notification handler and jump to userspace.  Since there is
580 still an k_msg in the queue (and we self_ipi'd ourselves, it's part of how
581 k_msgs work), the IPI will fire and push us right back into the kernel to
582 execute the preemption, and the notif handler's context will be saved in the
583 preempt_tf (ready to go when the vcore gets started again).
584
585 We could try to just leave the notif_pending flag set and ignore the message,
586 but that would involve inspecting the queue for the preempt k_msg.
587 Additionally, a preempt k_msg can arrive anyway.  Finally, it's possible to have
588 another message in the queue between the notif and the preempt, and it gets ugly
589 quickly trying to determine what to do.
590
591 4.8: When a Pcore is "Free"
592 ---------------------------
593 There are a couple ways to handle pcores.  One approach would be to not
594 consider them free and able to be given to another process until the old
595 process is completely removed (abandon_core()).  Another approach is to free
596 the core once its fate is sealed (which we do).  This probably gives more
597 flexibility in schedule()-like functions (no need to wait to give the core
598 out), quicker dispatch latencies, less contention on shared structs (like the
599 idle-core-map), etc.
600
601 Also, we don't remove the pcore from the vcoremap, even if it is being
602 allocated to another core (the same pcore can exist in two vcoremaps, contrary
603 to older statements).  Taking the pcore from the vcoremap would mean some
604 non-fate related local calls (sys_get_vcoreid()) will fail, since the vcoreid
605 is gone!  Additionally, we don't need a vcoreid in the k_msg (we would have if
606 we could not use the vcore/pcoremappings).  There should not be any issues
607 with the new process sending messages to the pcore before the core is sorted,
608 since k_msgs are delivered in order.
609
610 Another tricky part is the seq_ctr used to signal userspace of changes to the
611 coremap or num_vcores (coremap_seqctr).  While we may not even need this in the
612 long run, it still seems like it could be useful.  The trickiness comes from
613 when we update the seq_ctr when we are unmapping vcores on the receive side of a
614 message (like __death or __preempt).  We'd rather not have each pcore contend on
615 the seq_ctr cache line (let alone any locking) while they perform a somewhat
616 data-parallel task.  So we continue to have the sending core handle the seq_ctr
617 upping and downing.  This works, since the "unlocking" happens after messages
618 are sent, which means the receiving core is no longer in userspace (if there is
619 a delay, it is because the remote core is in the kernel, possibly with
620 interrupts disabled).  Because of this, userspace will be unable to read the new
621 value of the seq_ctr before the IPI hits and does the unmapping that the seq_ctr
622 protects/advertises.  This is most likely true.  It wouldn't be if the "last IPI
623 was sent" flag clears before the IPI actually hit the other core.
624
625 4.9: Future Broadcast/Messaging Needs
626 ---------------------------
627 Currently, messaging is serialized.  Broadcast IPIs exist, but the kernel
628 message system is based on adding an k_msg to a list in a pcore's
629 per_cpu_info.  Further the sending of these messages is in a loop.  In the
630 future, we would like to have broadcast messaging of some sort (literally a
631 broadcast, like the IPIs, and if not that, then a communication tree of
632 sorts).  
633
634 Given those desires, we want to make sure that no message we send needs
635 details specific to a pcore (such as the vcoreid running on it, a history
636 number, or anything like that).  Thus no k_msg related to process management
637 should have anything that cannot apply to the entire process.  At this point,
638 most just have a struct proc *.  A pcore ought to be able to figure out what
639 is happening based on the pcoremap, information in the struct proc, and in the
640 preempt struct in procdata.
641
642 4.10: Other Things We Thought of but Don't Like
643 ---------------------------
644 All local fate-related work is sent as a self k_msg, to enforce ordering.
645 It doesn't capture the difference between a local call and a remote k_msg.
646 The k_msg has already considered state and made its decision.  The local call
647 is an attempt.  It is also unnecessary, if we put in enough information to
648 make a decision in the proc struct.  Finally, it caused a few other problems
649 (like needing to detect arbitrary stale messages).
650
651 Overall message history: doesn't work well when you do per-core stuff, since
652 it will invalidate other messages for the process.  We then though of a pcore
653 history counter to detect stale messages.  Don't like that either.  We'd have
654 to send the history in the message, since it's a per-message, per-core
655 expiration.  There might be other ways around this, but this doesn't seem
656 necessary.
657
658 Alarms have pointers to a list of which cores should be preempted when that
659 specific alarm goes off (saved with the alarm).  Ugh.  It gets ugly with
660 multiple outstanding preemptions and cores getting yielded while the alarms
661 sleep (and possibly could get reallocated, though we'd make a rule to prevent
662 that).  Like with notifications, being able to handle spurious alarms and
663 thinking of an alarm as just a prod to check somewhere is much more flexible
664 and simple.  It is similar to generic messages that have the actual important
665 information stored somewhere else (as with allowing broadcasts, with different
666 receivers performing slightly different operations).
667
668 Synchrony for messages (wanting a response to a preempt k_msg, for example)
669 sucks.  Just encode the state of impending fate in the proc struct, where it
670 belongs.  Additionally, we don't want to hold the proc lock even longer than
671 we do now (which is probably too long as it is).  Finally, it breaks a golden
672 rule: never wait while holding a lock: you will deadlock the system (e.g. if
673 the receiver is already in the kernel spinning on the lock).  We'd have to
674 send messages, unlock (which might cause a message to hit the calling pcore,
675 as in the case of locally called proc_destroy()), and in the meantime some
676 useful invariant might be broken.
677
678 We also considered using the transition stack as a signal that a process is in
679 a notification handler.  The kernel can inspect the stack pointer to determine
680 this.  It's possible, but unnecessary.
681
682 5. current_tf
683 ===========================
684 current_tf is a per-core macro that returns a struct trapframe * that points
685 back on the kernel stack to the user context that was running on the given core
686 when an interrupt or trap happened.  Saving the reference to the TF helps
687 simplify code that needs to do something with the TF (like save it and pop
688 another TF).  This way, we don't need to pass the context all over the place,
689 especially through code that might not care.
690
691 current_tf should go along with current.  It's the current_tf of the current
692 process.  Withouth 'current', it has no meaning.
693
694 It does not point to kernel trapframes, which is important when we receive an
695 interrupt in the kernel.  At one point, we were (hypothetically) clobbering the
696 reference to the user trapframe, and were unable to recover.  We can get away
697 with this because the kernel always returns to its previous context from a
698 nested handler (via iret on x86).  
699
700 In the future, we may need to save kernel contexts and may not always return via
701 iret.  At which point, if the code path is deep enough that we don't want to
702 carry the TF pointer, we may revisit this.  Until then, current_tf is just for
703 userspace contexts, and is simply stored in per_cpu_info.
704
705 6. Locking!
706 ===========================
707 6.1: proc_lock
708 ---------------------------
709 Currently, all locking is done on the proc_lock.  It's main goal is to protect
710 the vcore mapping (vcore->pcore and vice versa).  As of Apr 2010, it's also used
711 to protect changes to the address space and the refcnt.  Eventually the refcnt
712 will be handled with atomics, and the address space will have it's own MM lock.  
713
714 We grab the proc_lock all over the place, but we try to avoid it whereever
715 possible - especially in kernel messages or other places that will be executed
716 in parallel.  One place we do grab it but would like to not is in proc_yield().  
717 We don't always need to grab the proc lock.  Here are some examples:
718
719 6.1.1: Lockless Notifications:
720 -------------
721 We don't lock when sending a notification.  We want the proc_lock to not be an
722 irqsave lock (discussed below).  Since we might want to send a notification from
723 interrupt context, we can't grab the proc_lock if it's a regular lock.  
724
725 This is okay, since the proc_lock is only protecting the vcoremapping.  We could
726 accidentally send the notification to the wrong pcore.  The __notif handler
727 checks to make sure it is the right process, and all _M processes should be able
728 to handle spurious notifications.  This assumes they are still _M.
729
730 If we send it to the wrong pcore, there is a danger of losing the notif, since
731 it didn't go to the correct vcore.  That would happen anyway, (the vcore is
732 unmapped, or in the process of mapping).  The notif_pending flag will be caught
733 when the vcore is started up next time (and that flag was set before reading the
734 vcoremap).
735
736 6.1.2: Local get_vcoreid():
737 -------------
738 It's not necessary to lock while checking the vcoremap if you are checking for
739 the core you are running on (e.g. pcoreid == core_id()).  This is because all
740 unmappings of a vcore are done on the receive side of a routine kmsg, and that
741 code cannot run concurrently with the code you are running.  
742
743 6.2: irqsave
744 ---------------------------
745 The proc_lock used to be an irqsave lock (meaning it disables interrupts and can
746 be grabbed from interrupt context).  We made it a regular lock for a couple
747 reasons.  The immediate one was it was causing deadlocks due to some other
748 ghetto things (blocking on the frontend server, for instance).  More generally,
749 we don't want to disable interrupts for long periods of time, so it was
750 something worth doing anyway.  
751
752 This means that we cannot grab the proc_lock from interrupt context.  This
753 includes having schedule called from an interrupt handler (like the
754 timer_interrupt() handler), since it will call proc_run.  Right now, we actually
755 do this, which we shouldn't, and that will eventually get fixed.  The right
756 answer is that the actual work of running the scheduler should be a routine
757 kmsg, similar to how Linux sets a bit in the kernel that it checks on the way
758 out to see if it should run the scheduler or not.
759
760 7. TLB Coherency
761 ===========================
762 When changing or removing memory mappings, we need to do some form of a TLB
763 shootdown.  Normally, this will require sending an IPI (immediate kmsg) to
764 every vcore of a process to unmap the affected page.  Before allocating that
765 page back out, we need to make sure that every TLB has been flushed.  
766
767 One reason to use a kmsg over a simple handler is that we often want to pass a
768 virtual address to flush for those architectures (like x86) that can
769 invalidate a specific page.  Ideally, we'd use a broadcast kmsg (doesn't exist
770 yet), though we already have simple broadcast IPIs.
771
772 7.1 Initial Stuff
773 ---------------------------
774 One big issue is whether or not to wait for a response from the other vcores
775 that they have unmapped.  There are two concerns: 1) Page reuse and 2) User
776 semantics.  We cannot give out the physical page while it may still be in a
777 TLB (even to the same process.  Ask us about the pthread_test bug).
778
779 The second case is a little more detailed.  The application may not like it if
780 it thinks a page is unmapped or protected, and it does not generate a fault.
781 I am less concerned about this, especially since we know that even if we don't
782 wait to hear from every vcore, we know that the message was delivered and the
783 IPI sent.  Any cores that are in userspace will have trapped and eventually
784 handle the shootdown before having a chance to execute other user code.  The
785 delays in the shootdown response are due to being in the kernel with
786 interrupts disabled (it was an IMMEDIATE kmsg).
787
788 7.2 RCU
789 ---------------------------
790 One approach is similar to RCU.  Unmap the page, but don't put it on the free
791 list.  Instead, don't reallocate it until we are sure every core (possibly
792 just affected cores) had a chance to run its kmsg handlers.  This time is
793 similar to the RCU grace periods.  Once the period is over, we can then truly
794 free the page.
795
796 This would require some sort of RCU-like mechanism and probably a per-core
797 variable that has the timestamp of the last quiescent period.  Code caring
798 about when this page (or pages) can be freed would have to check on all of the
799 cores (probably in a bitmask for what needs to be freed).  It would make sense
800 to amortize this over several RCU-like operations.
801
802 7.3 Checklist
803 ---------------------------
804 It might not suck that much to wait for a response if you already sent an IPI,
805 though it incurs some more cache misses.  If you wanted to ensure all vcores
806 ran the shootdown handler, you'd have them all toggle their bit in a checklist
807 (unused for a while, check smp.c).  The only one who waits would be the
808 caller, but there still are a bunch of cache misses in the handlers.  Maybe
809 this isn't that big of a deal, and the RCU thing is an unnecessary
810 optimization.
811
812 7.4 Just Wait til a Context Switch
813 ---------------------------
814 Another option is to not bother freeing the page until the entire process is
815 descheduled.  This could be a very long time, and also will mess with
816 userspace's semantics.  They would be running user code that could still
817 access the old page, so in essence this is a lazy munmap/mprotect.  The
818 process basically has the page in pergatory: it can't be reallocated, and it
819 might be accessible, but can't be guaranteed to work.
820
821 The main benefit of this is that you don't need to send the TLB shootdown IPI
822 at all - so you don't interfere with the app.  Though in return, they have
823 possibly weird semantics.  One aspect of these weird semantics is that the
824 same virtual address could map to two different pages - that seems like a
825 disaster waiting to happen.  We could also block that range of the virtual
826 address space from being reallocated, but that gets even more tricky.
827
828 One issue with just waiting and RCU is memory pressure.  If we actually need
829 the page, we will need to enforce an unmapping, which sucks a little.
830
831 7.5 Bulk vs Single
832 ---------------------------
833 If there are a lot of pages being shot down, it'd be best to amortize the cost
834 of the kernel messages, as well as the invlpg calls (single page shootdowns).
835 One option would be for the kmsg to take a range, and not just a single
836 address.  This would help with bulk munmap/mprotects.  Based on the number of
837 these, perhaps a raw tlbflush (the entire TLB) would be worth while, instead
838 of n single shots.  Odds are, that number is arch and possibly workload
839 specific.
840
841 For now, the plan will be to send a range and have them individually shot
842 down.
843
844 7.6 Don't do it
845 ---------------------------
846 Either way, munmap/mprotect sucks in an MCP.  I recommend not doing it, and
847 doing the appropriate mmap/munmap/mprotects in _S mode.  Unfortunately, even
848 our crap pthread library munmaps on demand as threads are created and
849 destroyed.  The vcore code probably does in the bowels of glibc's TLS code
850 too, though at least that isn't on every user context switch.
851
852 7.7 Local memory
853 ---------------------------
854 Private local memory would help with this too.  If each vcore has its own
855 range, we won't need to send TLB shootdowns for those areas, and we won't have
856 to worry about weird application semantics.  The downside is we would need to
857 do these mmaps in certain ranges in advance, and might not easily be able to
858 do them remotely.  More on this when we actually design and build it.
859
860 7.8 Future Hardware Support
861 ---------------------------
862 It would be cool and interesting if we had the ability to remotely shootdown
863 TLBs.  For instance, all cores with cr3 == X, shootdown range Y..Z.  It's
864 basically what we'll do with the kernel message and the vcoremap, but with
865 magic hardware.
866
867 7.9 Current Status
868 ---------------------------
869 For now, we just send a kernel message to all vcores to do a full TLB flush,
870 and not to worry about checklists, waiting, or anything.  This is due to being
871 short on time and not wanting to sort out the issue with ranges.  The way
872 it'll get changed to is to send the kmsg with the range to the appropriate
873 cores, and then maybe put the page on the end of the freelist (instead of the
874 head).  More to come.
875
876 8. Process Management
877 ===========================
878 8.1 Vcore lists
879 ---------------------------
880 We have three lists to track a process's vcores.  The vcores themselves sit in
881 the vcoremap in procinfo; they aren't dynamically allocated (memory) or
882 anything like that.  The lists greatly eases vcore discovery and management.
883
884 A vcore is on exactly one of three lists: online (mapped and running vcores,
885 sometimes called 'active'), bulk_preempt (was online when the process was bulk
886 preempted (like a timeslice)), and inactive (yielded, hasn't come on yet,
887 etc).  When writes are complete (unlocked), either the online list or the
888 bulk_preempt list should be empty.
889
890 List modifications are protected by the proc_lock.  You can concurrently read,
891 but note you may get some weird behavior, such as a vcore on multiple lists, a
892 vcore on no lists, online and bulk_preempt both having items, etc.  Currently,
893 event code will read these lists when hunting for a suitable core, and will
894 have to be careful about races.  I want to avoid event FALLBACK code from
895 grabbing the proc_lock.
896
897 Another slight thing to be careful of is that the vcore lists don't always
898 agree with the vcore mapping.  However, it will always agree with what the
899 state of the process will be when all kmsgs are processed (fate).
900 Specifically, when we take vcores, the unmapping happens with the lock not
901 held on the vcore itself (as discussed elsewhere).  The vcore lists represent
902 the result of those pending unmaps.
903
904 Before we used the lists, we scanned the vcoremap in a painful, clunky manner.
905 In the old style, when you asked for a vcore, the first one you got was the
906 first hole in the vcoremap.  Ex: Vcore0 would always be granted if it was
907 offline.  That's no longer true; the most recent vcore yielded will be given
908 out next.  This will help with cache locality, and also cuts down on the
909 scenarios on which the kernel gives out a vcore that userspace wasn't
910 expecting.  This can still happen if they ask for more vcores than they set up
911 for, or if a vcore doesn't *want* to come online (there's a couple scenarios
912 with preemption recovery where that may come up).
913
914 So the plan with the bulk preempt list is that vcores on it were preempted,
915 and the kernel will attempt to restart all of them (and move them to the online
916 list).  Any leftovers will be moved to the inactive list, and have preemption
917 recovery messages sent out.  Any shortages (they want more vcores than were
918 bulk_preempted) will be taken from the yield list.  This all means that
919 whether or not a vcore needs to be preempt-recovered or if there is a message
920 out about its preemption doesn't really affect which list it is on.  You could
921 have a vcore on the inactive list that was bulk preempted (and not turned back
922 on), and then that vcore gets granted in the next round of vcore_requests().
923 The preemption recovery handlers will need to deal with concurrent handlers
924 and the vcore itself starting back up.
925
926 9. TBD
927 ===========================