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