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