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