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