Merge origin/netpush (networking code) (XCC)
[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 and owning_proc
15 6. Locking!
16 7. TLB Coherency
17 8. Process Management
18 9. On the Ordering of Messages
19 10. TBD
20
21 1. Reference Counting
22 ===========================
23 1.1 Basics:
24 ---------------------------
25 Reference counts exist to keep a process alive.  We use krefs for this, similar
26 to Linux's kref:
27 - Can only incref if the current value is greater than 0, meaning there is
28   already a reference to it.  It is a bug to try to incref on something that has
29   no references, so always make sure you incref something that you know has a
30   reference.  If you don't know, you need to get it from pid2proc (which is a
31   careful way of doing this - pid2proc kref_get_not_zero()s on the reference that is
32   stored inside it).  If you incref and there are 0 references, the kernel will
33   panic.  Fix your bug / don't incref random pointers.
34 - Can always decref.
35 - When the decref returns 0, perform some operation.  This does some final
36   cleanup on the object.
37 - Process code is trickier since we frequently make references from 'current'
38   (which isn't too bad), but also because we often do not return and need to be
39   careful about the references we passed in to a no-return function.
40
41 1.2 Brief History of the Refcnt:
42 ---------------------------
43 Originally, the refcnt was created to keep page tables from being destroyed (in
44 proc_free()) while cores were still using them, which is what was happens during
45 an ARSC (async remote syscall).  It was then defined to be a count of places in
46 the kernel that had an interest in the process staying alive, practically just
47 to protect current/cr3.  This 'interest' actually extends to any code holding a
48 pointer to the proc, such as one acquired via pid2proc(), which is its current
49 meaning.
50
51 1.3 Quick Aside: The current Macro:
52 ---------------------------
53 current is a pointer to the proc that is currently loaded/running on any given
54 core.  It is stored in the per_cpu_info struct, and set/managed by low-level
55 process code.  It is necessary for the kernel to quickly figure out who is
56 running on its core, especially when servicing interrupts and traps.  current is
57 protected by a refcnt.
58
59 current does not say which process owns / will-run on a core.  The per-cpu
60 variable 'owning_proc' covers that.  'owning_proc' should be treated like
61 'current' (aka, 'cur_proc') when it comes to reference counting.  Like all
62 refcnts, you can use it, but you can't consume it without atomically either
63 upping the refcnt or passing the reference (clearing the variable storing the
64 reference).  Don't pass it to a function that will consume it and not return
65 without upping it.
66
67 1.4 Reference Counting Rules:
68 ---------------------------
69 +1 for existing.
70 - The fact that the process is supposed to exist is worth +1.  When it is time
71   to die, we decref, and it will eventually be cleaned up.  This existence is
72   explicitly kref_put()d in proc_destroy().
73 - The hash table is a bit tricky.  We need to kref_get_not_zero() when it is
74   locked, so we know we aren't racing with proc_free freeing the proc and
75   removing it from the list.  After removing it from the hash, we don't need to
76   kref_put it, since it was an internal ref.  The kref (i.e. external) isn't for
77   being on the hash list, it's for existing.  This separation allows us to
78   remove the proc from the hash list in the "release" function.  See kref.txt
79   for more details.
80
81 +1 for someone using it or planning to use it.
82 - This includes simply having a pointer to the proc, since presumably you will
83   use it.  pid2proc() will incref for you.  When you are done, decref.
84 - Functions that create a process and return a pointer (like proc_create() or
85   kfs_proc_create()) will also up the refcnt for you.  Decref when you're done.
86 - If the *proc is stored somewhere where it will be used again, such as in an IO
87   continuation, it needs to be refcnt'd.  Note that if you already had a
88   reference from pid2proc(), simply don't decref after you store the pointer.
89
90 +1 for current.
91 - current counts as someone using it (expressing interest in the core), but is
92   also a source of the pointer, so its a bit different.  Note that all kref's
93   are sources of a pointer.  When we are running on a core that has current
94   loaded, the ref is both for its usage as well as for being the current
95   process.
96 - You have a reference from current and can use it without refcnting, but
97   anything that needs to eat a reference or store/use it needs an incref first.
98   To be clear, your reference is *NOT* edible.  It protects the cr3, guarantees
99   the process won't die, and serves as a bootstrappable reference.
100 - Specifically, if you get a ref from current, but then save it somewhere (like
101   an IO continuation request), then clearly you must incref, since it's both
102   current and stored/used.
103 - If you don't know what might be downstream from your function, then incref
104   before passing the reference, and decref when it returns.  We used to do this
105   for all syscalls, but now only do it for calls that might not return and
106   expect to receive reference (like proc_yield).
107
108 All functions that take a *proc have a refcnt'd reference, though it may not be
109 edible (it could be current).  It is the callers responsibility to make sure
110 it'd edible if it necessary.  It is the callees responsibility to incref if it
111 stores or makes a copy of the reference.
112
113 1.5 Functions That Don't or Might Not Return:
114 ---------------------------
115 Refcnting and especially decreffing gets tricky when there are functions that
116 MAY not return.  proc_restartcore() does not return (it pops into userspace).
117 proc_run() used to not return, if the core it was called on would pop into
118 userspace (if it was a _S, or if the core is part of the vcoremap for a _M).
119 This doesn't happen anymore, since we have cur_tf in the per-cpu info.
120
121 Functions that MAY not return will "eat" your reference *IF* they do not return.
122 This means that you must have a reference when you call them (like always), and
123 that reference will be consumed / decref'd for you if the function doesn't
124 return.  Or something similarly appropriate.
125
126 Arguably, for functions that MAY not return, but will always be called with
127 current's reference (proc_yield()), we could get away without giving it an
128 edible reference, and then never eating the ref.  Yield needs to be reworked
129 anyway, so it's not a bit deal yet.
130
131 We do this because when the function does not return, you will not have the
132 chance to decref (your decref code will never run).  We need the reference when
133 going in to keep the object alive (like with any other refcnt).  We can't have
134 the function always eat the reference, since you cannot simply re-incref the
135 pointer (not allowed to incref unless you know you had a good reference).  You'd
136 have to do something like p = pid2proc(p_pid);  It's clunky to do that, easy to
137 screw up, and semantically, if the function returns, then we may still have an
138 interest in p and should decref later.
139
140 The downside is that functions need to determine if they will return or not,
141 which can be a pain (for an out-of-date example: a linear time search when
142 running an _M, for instance, which can suck if we are trying to use a
143 broadcast/logical IPI).
144
145 As the caller, you usually won't know if the function will return or not, so you
146 need to provide a consumable reference.  Current doesn't count.  For example,
147 proc_run() requires a reference.  You can proc_run(p), and use p afterwards, and
148 later decref.  You need to make sure you have a reference, so things like
149 proc_run(pid2proc(55)) works, since pid2proc() increfs for you.  But you cannot
150 proc_run(current), unless you incref current in advance.  Incidentally,
151 proc_running current doesn't make a lot of sense.
152
153 1.6 Runnable List:
154 ---------------------------
155 Procs on the runnable list need to have a refcnt (other than the +1 for
156 existing).  It's something that cares that the process exists.  We could have
157 had it implicitly be refcnt'd (the fact that it's on the list is enough, sort of
158 as if it was part of the +1 for existing), but that complicates things.  For
159 instance, it is a source of a reference (for the scheduler) and you could not
160 proc_run() a process from the runnable list without worrying about increfing it
161 before hand.  This isn't true anymore, but the runnable lists are getting
162 overhauled anyway.  We'll see what works nicely.
163
164 1.7 Internal Details for Specific Functions:
165 ---------------------------
166 proc_run()/__proc_give_cores(): makes sure enough refcnts are in place for all
167 places that will install owning_proc.  This also makes it easier on the system
168 (one big incref(n), instead of n increfs of (1) from multiple cores). 
169
170 __set_proc_current() is a helper that makes sure p is the cur_proc.  It will
171 incref if installing a new reference to p.  If it removed an old proc, it will
172 decref.
173
174 __proc_startcore(): assumes all references to p are sorted.  It will not
175 return, and you should not pass it a reference you need to decref().  Passing
176 it 'owning_proc' works, since you don't want to decref owning_proc.
177
178 proc_destroy(): it used to not return, and back then if your reference was
179 from 'current', you needed to incref.  Now that proc_destroy() returns, it
180 isn't a big deal.  Just keep in mind that if you have a function that doesn't
181 return, there's no way for the function to know if it's passed reference is
182 edible.  Even if p == current, proc_destroy() can't tell if you sent it p (and
183 had a reference) or current and didn't.
184
185 proc_yield(): when this doesn't return, it eats your reference.  It will also
186 decref twice.  Once when it clears_owning_proc, and again when it calls
187 abandon_core() (which clears cur_proc).
188
189 abandon_core(): it was not given a reference, so it doesn't eat one.  It will
190 decref when it unloads the cr3.  Note that this is a potential performance
191 issue.  When preempting or killing, there are n cores that are fighting for the
192 cacheline to decref.  An alternative would be to have one core decref for all n
193 cores, after it knows all cores unloaded the cr3.  This would be a good use of
194 the checklist (possibly with one cacheline per core).  It would take a large
195 amount of memory for better scalability.
196
197 1.8 Things I Could Have Done But Didn't And Why:
198 ---------------------------
199 Q: Could we have the first reference (existence) mean it could be on the runnable
200 list or otherwise in the proc system (but not other subsystems)?  In this case,
201 proc_run() won't need to eat a reference at all - it will just incref for every
202 current it will set up.
203
204 New A: Maybe, now that proc_run() returns.
205
206 Old A: No: if you pid2proc(), then proc_run() but never return, you have (and
207 lose) an extra reference.  We need proc_run() to eat the reference when it
208 does not return.  If you decref between pid2proc() and proc_run(), there's a
209 (rare) race where the refcnt hits 0 by someone else trying to kill it.  While
210 proc_run() will check to see if someone else is trying to kill it, there's a
211 slight chance that the struct will be reused and recreated.  It'll probably
212 never happen, but it could, and out of principle we shouldn't be referencing
213 memory after it's been deallocated.  Avoiding races like this is one of the
214 reasons for our refcnt discipline.
215
216 Q: (Moot) Could proc_run() always eat your reference, which would make it
217 easier for its implementation?
218
219 A: Yeah, technically, but it'd be a pain, as mentioned above.  You'd need to
220 reaquire a reference via pid2proc, and is rather easy to mess up.
221
222 Q: (Moot) Could we have made proc_destroy() take a flag, saying whether or not
223 it was called on current and needed a decref instead of wasting an incref?
224
225 A: We could, but won't.  This is one case where the external caller is the one
226 that knows the function needs to decref or not.  But it breaks the convention a
227 bit, doesn't mirror proc_create() as well, and we need to pull in the cacheline
228 with the refcnt anyways.  So for now, no.
229
230 Q: (Moot) Could we make __proc_give_cores() simply not return if an IPI is
231 coming?
232
233 A: I did this originally, and manually unlocked and __wait_for_ipi()d.  Though
234 we'd then need to deal with it like that for all of the related functions, which
235 doesn't work if you wanted to do something afterwards (like schedule(p)).  Also
236 these functions are meant to be internal helpers, so returning the bool makes
237 more sense.  It eventually led to having __proc_unlock_ipi_pending(), which made
238 proc_destroy() much cleaner and helped with a general model of dealing with
239 these issues.  Win-win.
240
241 2. When Do We Really Leave "Process Context"?
242 ===========================
243 2.1 Overview
244 ---------------------------
245 First off, it's not really "process context" in the way Linux deals with it.  We
246 aren't operating in kernel mode on behalf of the process (always).  We are
247 specifically talking about when a process's cr3 is loaded on a core.  Usually,
248 current is also set (the exception for now is when processing ARSCs).
249
250 There are a couple different ways to do this.  One is to never unload a context
251 until something new is being run there (handled solely in __proc_startcore()).
252 Another way is to always explicitly leave the core, like by abandon_core()ing.
253
254 The issue with the former is that you could have contexts sitting around for a
255 while, and also would have a bit of extra latency when __proc_free()ing during
256 someone *else's* __proc_startcore() (though that could be avoided if it becomes
257 a real issue, via some form of reaping).  You'll also probably have excessive
258 decrefs (based on the interactions between proc_run() and __startcore()).
259
260 The issue with the latter is excessive TLB shootdowns and corner cases.  There
261 could be some weird cases (in core_request() for example) where the core you are
262 running on has the context loaded for proc A on a mgmt core, but decides to give
263 it to proc B.
264
265 If no process is running there, current == 0 and boot_cr3 is loaded, meaning no
266 process's context is loaded.
267
268 All changes to cur_proc, owning_proc, and cur_tf need to be done with
269 interrupts disabled, since they change in interrupt handlers.
270
271 2.2 Here's how it is done now:
272 ---------------------------
273 All code is capable of 'spamming' cur_proc (with interrupts disabled!).  If it
274 is 0, feel free to set it to whatever process you want.  All code that
275 requires current to be set will do so (like __proc_startcore()).  The
276 smp_idle() path will make sure current is clear when it halts.  So long as you
277 don't change other concurrent code's expectations, you're okay.  What I mean
278 by that is you don't clear cur_proc while in an interrupt handler.  But if it
279 is already 0, __startcore is allowed to set it to it's future proc (which is
280 an optimization).  Other code didn't have any expectations of it (it was 0).
281 Likewise, kthread code when we sleep_on() doesn't have to keep cur_proc set.
282 A kthread is somewhat an isolated block (codewise), and leaving current set
283 when it is done is solely to avoid a TLB flush (at the cost of an incref).
284
285 In general, we try to proactively leave process context, but have the ability
286 to stay in context til __proc_startcore() to handle the corner cases (and to
287 maybe cut down the TLB flushes later).  To stop proactively leaving, just
288 change abandon_core() to not do anything with current/cr3.  You'll see weird
289 things like processes that won't die until their old cores are reused.  The
290 reason we proactively leave context is to help with sanity for these issues,
291 and also to avoid decref's in __startcore().
292
293 A couple other details: __startcore() sorts the extra increfs, and
294 __proc_startcore() sorts leaving the old context.  Anytime a __startcore kernel
295 message is sent, the sender increfs in advance for the owning_proc refcnt.  As
296 an optimization, we can also incref to *attempt* to set current.  If current
297 was 0, we set it.  If it was already something else, we failed and need to
298 decref.  __proc_startcore(), which the last moment before we *must* have the
299 cr3/current issues sorted, does the actual check if there was an old process
300 there or not, while it handles the lcr3 (if necessary).  In general, lcr3's
301 ought to have refcnts near them, or else comments explaining why not.
302
303 So we leave process context when told to do so (__death/abandon_core()) or if
304 another process is run there.  The _M code is such that a proc will stay on its
305 core until it receives a message, and that message would cleanup/restore a
306 generic context (boot_cr3).  A _S could stay on its core until another _S came
307 in.  This is much simpler for cases when a timer interrupt goes off to force a
308 schedule() decision.  It also avoids a TLB flush in case the scheduler picked
309 that same proc to run again.  This could also happen to an _M, if for some
310 reason it was given a management core (!!!) or some other event happened that
311 caused some management/scheduling function to run on one of it's cores (perhaps
312 it asked).
313
314 proc_yield() abandons the core / leaves context.
315
316 2.3 Other issues:
317 ---------------------------
318 Note that dealing with interrupting processes that are in the kernel is tricky.
319 There is no true process context, so we can't leave a core until the kernel is
320 in a "safe place", i.e. it's state is bundled enough that it can be recontinued
321 later.  Calls of this type are routine kernel messages, executed at a convenient
322 time (specifically, before we return to userspace in proc_restartcore().
323
324 This same thing applies to __death messages.  Even though a process is dying, it
325 doesn't mean we can just drop whatever the kernel was doing on its behalf.  For
326 instance, it might be holding a reference that will never get decreffed if its
327 stack gets dropped.
328
329 3. Leaving the Kernel Stack:
330 ===========================
331 Just because a message comes in saying to kill a process, it does not mean we
332 should immediately abandon_core().  The problem is more obvious when there is
333 a preempt message, instead of a death message, but either way there is state
334 that needs cleaned up (refcnts that need downed, etc).
335
336 The solution to this is rather simple: don't abandon right away.  That was
337 always somewhat the plan for preemption, but was never done for death.  And
338 there are several other cases to worry about too.  To enforce this, we expand
339 the old "active messages" into a generic work execution message (a kernel
340 message) that can be delayed or shipped to another core.  These types of
341 messages will not be executed immediately on the receiving pcore - instead they
342 are on the queue for "when there's nothing else to do in the kernel", which is
343 checked in smp_idle() and before returning to userspace in proc_restartcore().
344 Additionally, these kernel messages can also be queued on an alarm queue,
345 delaying their activation as part of a generic kernel alarm facility.
346
347 One subtlety is that __proc_startcore() shouldn't check for messages, since it
348 is called by __startcore (a message).  Checking there would run the messages out
349 of order, which is exactly what we are trying to avoid (total chaos).  No one
350 should call __proc_startcore, other than proc_restartcore() or __startcore().
351 If we ever have functions that do so, if they are not called from a message,
352 they must check for outstanding messages.
353
354 This last subtlety is why we needed to change proc_run()'s _S case to use a
355 local message instead of calling proc_starcore (and why no one should ever call
356 proc_startcore()).  We could unlock, thereby freeing another core to change the
357 proc state and send a message to us, then try to proc_startcore, and then
358 reading the message before we had installed current or had a userspace TF to
359 preempt, and probably a few other things.  Treating _S as a local message is
360 cleaner, begs to be merged in the code with _M's code, and uses the messaging
361 infrastructure to avoid all the races that it was created to handle.
362
363 Incidentally, we don't need to worry about missing messages while trying to pop
364 back to userspace from __proc_startcore, since an IPI will be on the way
365 (possibly a self-ipi caused by the __kernel_message() handler).  This is also
366 why we needed to make process_routine_kmsg() keep interrupts disabled when it
367 stops (there's a race between checking the queue and disabling ints).
368
369 4. Preemption and Notification Issues:
370 ===========================
371 4.1: Message Ordering and Local Calls:
372 ---------------------------
373 Since we go with the model of cores being told what to do, there are issues
374 with messages being received in the wrong order.  That is why we have the
375 kernel messages (guaranteed, in-order delivery), with the proc-lock protecting
376 the send order.  However, this is not enough for some rare races.
377
378 Local calls can also perform the same tasks as messages (calling
379 proc_destroy() while a death IPI is on its way). We refer to these calls as
380 messing with "local fate" (compared to global state (we're clever).
381 Preempting a single vcore doesn't change the process's state).  These calls
382 are a little different, because they also involve a check to see if it should
383 perform the function or other action (e.g., death just idling and waiting for
384 an IPI instead of trying to kill itself), instead of just blindly doing
385 something.
386
387 4.1.1: Possible Solutions
388 ----------------
389 There are two ways to deal with this.  One (and the better one, I think) is to
390 check state, and determine if it should proceed or abort.  This requires that
391 all local-fate dependent calls always have enough state to do its job.  In the
392 past, this meant that any function that results in sending a directive to a
393 vcore store enough info in the proc struct that a local call can determine if
394 it should take action or abort.  In the past, we used the vcore/pcoremap as a
395 way to send info to the receiver about what vcore they are (or should be).
396 Now, we store that info in pcpui (for '__startcore', we send it as a
397 parameter.  Either way, the general idea is still true: local calls can
398 proceed when they are called, and not self-ipi'd to a nebulous later time.
399
400 The other way is to send the work (including the checks) in a self-ipi kernel
401 message.  This will guarantee that the message is executed after any existing
402 messages (making the k_msg queue the authority for what should happen to a
403 core).  The check is also performed later (when the k_msg executes).  There
404 are a couple issues with this: if we allow the local core to send itself an
405 k_msg that could be out of order (meaning it should not be sent, and is only
406 sent due to ignorance of its sealed fate), AND if we return the core to the
407 idle-core-list once its fate is sealed, we need to detect that the message is
408 for the wrong process and that the process is in the wrong state.  To do this,
409 we probably need local versioning on the pcore so it can detect that the
410 message is late/wrong.  We might get by with just the proc* (though that is
411 tricky with death and proc reuse), so long as we don't allow new startcores
412 for a proc until AFTER the preemption is completed.
413
414 4.2: Preempt-Served Flag
415 ----------------
416 We want to be able to consider a pcore free once its owning proc has dealt
417 with removing it.  This allows a scheduler-like function to easily take a core
418 and then give it to someone else, without waiting for each vcore to respond,
419 saying that the pcore is free/idle.
420
421 We used to not unmap until we were in '__preempt' or '__death', and we needed
422 a flag to tell yield-like calls that a message was already on the way and to
423 not rely on the vcoremap.  This is pretty fucked up for a number of reasons,
424 so we changed that.  But we still wanted to know when a preempt was in
425 progress so that the kernel could avoid giving out the vcore until the preempt
426 was complete.
427
428 Here's the scenario: we send a '__startcore' to core 3 for VC5->PC3.  Then we
429 quickly send a '__preempt' to 3, and then a '__startcore' to core 4 (a
430 different pcore) for VC5->PC4.  Imagine all of this happens before the first
431 '__startcore' gets processed (IRQ delay, fast ksched, whatever).  We need to
432 not run the second '__startcore' on pcore 4 before the preemption has saved
433 all of the state of the VC5.  So we spin on preempt_served (which may get
434 renamed to preempt_in_progress).  We need to do this in the sender, and not
435 the receiver (not in the kmsg), because the kmsgs can't tell which one they
436 are.  Specifically, the first '__startcore' on core 3 runs the same code as
437 the '__startcore' on core 4, working on the same vcore.  Anything we tell VC5
438 will be seen by both PC3 and PC4.  We'd end up deadlocking on PC3 while it
439 spins waiting for the preempt message that also needs to run on PC3.
440
441 The preempt_pending flag is actual a timestamp, with the expiration time of
442 the core at which the message will be sent.  We could try to use that, but
443 since alarms aren't fired at exactly the time they are scheduled, the message
444 might not actually be sent yet (though it will, really soon).  Still, we'll
445 just go with the preempt-served flag for now.
446
447 4.3: Impending Notifications
448 ----------------
449 It's also possible that there is an impending notification.  There's no change
450 in fate (though there could be a fate-changing preempt on its way), just the
451 user wants a notification handler to run.  We need a flag anyways for this
452 (discussed below), so proc_yield() or whatever other local call we have can
453 check this flag as well.  
454
455 Though for proc_yield(), it doesn't care if a notification is on its way (can
456 be dependent on a flag to yield from userspace, based on the nature of the
457 yield (which still needs to be sorted)).  If the yield is in response to a
458 preempt_pending, it actually should yield and not receive the notification.
459 So it should destroy its vcoreid->pcoreid mapping and abandon_core().  When
460 that notification hits, it will be for a proc that isn't current, and will be
461 ignored (it will get run the next time that vcore fires up, handled below).
462
463 There is a slight chance that the same proc will run on that pcore, but with a
464 different vcoreid.  In the off chance this happens, the new vcore will get a
465 spurious notification.  Userspace needs to be able to handle spurious
466 notifications anyways, (there are a couple other cases, and in general it's
467 not hard to do), so this is not a problem.  Instead of trying to have the
468 kernel ignore the notification, we just send a spurious one.  A crappy
469 alternative would be to send the vcoreid with the notification, but that would
470 mean we can't send a generic message (broadcast) to a bunch of cores, which
471 will probably be a problem later.
472
473 Note that this specific case is because the "local work message" gets
474 processed out of order with respect to the notification.  And we want this in
475 that case, since that proc_yield() is more important than the notification.
476
477 4.4: Preemption / Allocation Phases and Alarm Delays
478 ---------------------------
479 A per-vcore preemption phase starts when the kernel marks the core's
480 preempt_pending flag/counter and can includes the time when an alarm is
481 waiting to go off to reclaim the core.  The phase ends when the vcore's pcore
482 is reclaimed, either as a result of the kernel taking control, or because a
483 process voluntarily yielded.
484
485 Specifically, the preempt_pending variable is actually a timestamp for when
486 the core will be revoked (this assumes some form of global time, which we need
487 anyways).  If its value is 0, then there is no preempt-pending, it is not in a
488 phase, and the vcore can be given out again. 
489
490 When a preempt alarm goes off, the alarm only means to check a process for
491 expired vcores.  If the vcore has been yielded while the alarm was pending,
492 the preempt_pending flag will be reset to 0.  To speed up the search for
493 vcores to preempt, there's a circular buffer corelist in the proc struct, with
494 vcoreids of potential suspects.  Or at least this will exist at some point.
495 Also note that the preemption list isn't bound to a specific alarm: you can
496 check the list at any time (not necessarily on a specific alarm), and you can
497 have spurious alarms (the list is empty, so it'll be a noop).
498
499 Likewise, a global preemption phase is when an entire MCP is getting
500 gang_prempted, and the global deadline is set.  A function can quickly check
501 to see if the process responded, since the list of vcores with preemptions
502 pending will be empty.
503
504 It seems obvious, but we do not allow allocation of a vcore during its
505 preemption phase.  The main reason is that it can potentially break
506 assumptions about the vcore->pcore mapping and can result in multiple
507 instances of the same vcore on different pcores.  Imagine a preempt message
508 sent to a pcore (after the alarm goes off), meanwhile that vcore/pcore yields
509 and the vcore reactivates somewhere else.  There is a potential race on the
510 preempt_tf state: the new vcore is reading while the old is writing.  This
511 issue is sorted naturally: the vcore entry in the vcoremap isn't cleared until
512 the vcore/pcore is actually yielded/taken away, so the code looking for a free
513 vcoreid slot will not try to use it.
514
515 Note that if we didn't design the alarm system to simply check for
516 preemptions (perhaps it has a stored list of vcores to preempt), then we
517 couldn't end the preempt-phase until the alarm was sorted.  If that is the
518 case, we could easily give out a vcore that had been yielded but was still in
519 a preempt-phase.  Stopping an alarm would be tricky too, since there could be
520 lots of vcores in different states that need to be sorted by the alarm (so
521 ripping it out isn't enough).  Setting a flag might not be enough either.
522 Vcore version numbers/history (as well as global proc histories) is a pain I'd
523 like to avoid too.  So don't change the alarm / delayed preemption system
524 without thinking about this.
525
526 Also, allowing a vcore to restart while preemptions are pending also mucks
527 with keeping the vcore mapping "old" (while the message is in flight).  A
528 pcore will want to use that to determine which vcore is running on it.  It
529 would be possible to keep a pcoremap for the reverse mapping out of sync, but
530 that seems like a bad idea.  In general, having the pcoremap is a good idea
531 (whenever we talk about a vcoremap, we're usually talking about both
532 directions: "the vcore->pcore mapping").
533
534 4.5: Global Preemption Flags
535 ---------------------------
536 If we are trying to preempt an entire process at the same time, instead of
537 playing with the circular buffer of vcores pending preemption, we could have a
538 global timer as well.  This avoids some O(n) operations, though it means that
539 userspace needs to check two "flags" (expiration dates) when grabbing its
540 preempt-critical locks.
541
542 4.6: Notifications Mixed with Preemption and Sleeping
543 ---------------------------
544 It is possible that notifications will mix with preemptions or come while a
545 process is not running.  Ultimately, the process wants to be notified on a
546 given vcore.  Whenever we send an active notification, we set a flag in procdata
547 (notif_pending).  If the vcore is offline, we don't bother sending the IPI/notif
548 message.  The kernel will make sure it runs the notification handler (as well as
549 restoring the preempt_tf) the next time that vcore is restarted.  Note that
550 userspace can toggle this, so they can handle the notifications from a different
551 core if it likes, or they can independently send a notification.
552
553 Note we use notif_pending to detect if an IPI was missed while notifs were
554 disabled (this is done in pop_ros_tf() by userspace).  The overall meaning of
555 notif_pending is that a vcore wants to be IPI'd.  The IPI could be in-flight, or
556 it could be missed.  Since notification IPIs can be spurious, when we have
557 potential races, we err on the side of sending.  This happens when pop_ros_tf()
558 notifies itself, and when the kernel starts a vcore in it's notif handler if it
559 was preempted and notif was pending.  In the latter case, the kernel will put
560 the preempt_tf in the notif_tf, so userspace can restart that at its leisure.
561
562 If a vcore has a preempt_pending, we will still send the active notification
563 (IPI).  The core ought to get a notification for the preemption anyway, so we
564 need to be able to send one.  Additionally, once the vcore is handling that
565 preemption notification, it will have notifs disabled, which will prevent us
566 from sending any extra notifications anyways.
567  
568 4.7: Notifs While a Preempt Message is Served
569 ---------------------------
570 It is possible to have the kernel handling a notification k_msg and to have a
571 preempt k_msg in the queue (preempt-served flag is set).  Ultimately, what we
572 want is for the core to be preempted and the notification handler to run on
573 the next execution.  Both messages are in the k_msg queue for "a convenient
574 time to leave the kernel" (I'll have a better name for that later).  What we
575 do is execute the notification handler and jump to userspace.  Since there is
576 still an k_msg in the queue (and we self_ipi'd ourselves, it's part of how
577 k_msgs work), the IPI will fire and push us right back into the kernel to
578 execute the preemption, and the notif handler's context will be saved in the
579 preempt_tf (ready to go when the vcore gets started again).
580
581 We could try to just leave the notif_pending flag set and ignore the message,
582 but that would involve inspecting the queue for the preempt k_msg.
583 Additionally, a preempt k_msg can arrive anyway.  Finally, it's possible to have
584 another message in the queue between the notif and the preempt, and it gets ugly
585 quickly trying to determine what to do.
586
587 4.8: When a Pcore is "Free"
588 ---------------------------
589 There are a couple ways to handle pcores.  One approach would be to not
590 consider them free and able to be given to another process until the old
591 process is completely removed (abandon_core()).  Another approach is to free
592 the core once its fate is sealed (which we do).  This probably gives more
593 flexibility in schedule()-like functions (no need to wait to give the core
594 out), quicker dispatch latencies, less contention on shared structs (like the
595 idle-core-map), etc.
596
597 This 'freeing' of the pcore is from the perspective of the kernel scheduler
598 and the proc struct.  Contrary to all previous announcements, vcores are
599 unmapped from pcores when sending k_msgs (technically right after), while
600 holding the lock.  The pcore isn't actually not-running-the-proc until the
601 kmsg completes and we abandon_core().  Previously, we used the vcoremap to
602 communicate to other cores in a lock-free manner, but that was pretty shitty
603 and now we just store the vcoreid in pcpu info.
604
605 Another tricky part is the seq_ctr used to signal userspace of changes to the
606 coremap or num_vcores (coremap_seqctr).  While we may not even need this in the
607 long run, it still seems like it could be useful.  The trickiness comes from
608 when we update the seq_ctr when we are unmapping vcores on the receive side of a
609 message (like __death or __preempt).  We'd rather not have each pcore contend on
610 the seq_ctr cache line (let alone any locking) while they perform a somewhat
611 data-parallel task.  So we continue to have the sending core handle the seq_ctr
612 upping and downing.  This works, since the "unlocking" happens after messages
613 are sent, which means the receiving core is no longer in userspace (if there is
614 a delay, it is because the remote core is in the kernel, possibly with
615 interrupts disabled).  Because of this, userspace will be unable to read the new
616 value of the seq_ctr before the IPI hits and does the unmapping that the seq_ctr
617 protects/advertises.  This is most likely true.  It wouldn't be if the "last IPI
618 was sent" flag clears before the IPI actually hit the other core.
619
620 4.9: Future Broadcast/Messaging Needs
621 ---------------------------
622 Currently, messaging is serialized.  Broadcast IPIs exist, but the kernel
623 message system is based on adding an k_msg to a list in a pcore's
624 per_cpu_info.  Further the sending of these messages is in a loop.  In the
625 future, we would like to have broadcast messaging of some sort (literally a
626 broadcast, like the IPIs, and if not that, then a communication tree of
627 sorts).  
628
629 In the past, (OLD INFO): given those desires, we wanted to make sure that no
630 message we send needs details specific to a pcore (such as the vcoreid running
631 on it, a history number, or anything like that).  Thus no k_msg related to
632 process management would have anything that cannot apply to the entire
633 process.  At this point, most just have a struct proc *.  A pcore was be able
634 to figure out what is happening based on the pcoremap, information in the
635 struct proc, and in the preempt struct in procdata.
636
637 In more recent revisions, the coremap no longer is meant to be used across
638 kmsgs, so some messages ('__startcore') send the vcoreid.  This means we can't
639 easily broadcast the message.  However, many broadcast mechanisms wouldn't
640 handle '__startcore' naturally.  For instance, logical IPIs need something
641 already set in the LAPIC, or maybe need to be sent to a somewhat predetermined
642 group (again, bits in the LAPIC).  If we tried this for '__startcore', we
643 could add something in to the messaging to carry these vcoreids.  More likely,
644 we'll have a broadcast tree.  Keeping vcoreid (or any arg) next to whoever
645 needs to receive the message is a very small amount of bookkeeping on a struct
646 that already does bookkeeping.
647
648 4.10: Other Things We Thought of but Don't Like
649 ---------------------------
650 All local fate-related work is sent as a self k_msg, to enforce ordering.
651 It doesn't capture the difference between a local call and a remote k_msg.
652 The k_msg has already considered state and made its decision.  The local call
653 is an attempt.  It is also unnecessary, if we put in enough information to
654 make a decision in the proc struct.  Finally, it caused a few other problems
655 (like needing to detect arbitrary stale messages).
656
657 Overall message history: doesn't work well when you do per-core stuff, since
658 it will invalidate other messages for the process.  We then though of a pcore
659 history counter to detect stale messages.  Don't like that either.  We'd have
660 to send the history in the message, since it's a per-message, per-core
661 expiration.  There might be other ways around this, but this doesn't seem
662 necessary.
663
664 Alarms have pointers to a list of which cores should be preempted when that
665 specific alarm goes off (saved with the alarm).  Ugh.  It gets ugly with
666 multiple outstanding preemptions and cores getting yielded while the alarms
667 sleep (and possibly could get reallocated, though we'd make a rule to prevent
668 that).  Like with notifications, being able to handle spurious alarms and
669 thinking of an alarm as just a prod to check somewhere is much more flexible
670 and simple.  It is similar to generic messages that have the actual important
671 information stored somewhere else (as with allowing broadcasts, with different
672 receivers performing slightly different operations).
673
674 Synchrony for messages (wanting a response to a preempt k_msg, for example)
675 sucks.  Just encode the state of impending fate in the proc struct, where it
676 belongs.  Additionally, we don't want to hold the proc lock even longer than
677 we do now (which is probably too long as it is).  Finally, it breaks a golden
678 rule: never wait while holding a lock: you will deadlock the system (e.g. if
679 the receiver is already in the kernel spinning on the lock).  We'd have to
680 send messages, unlock (which might cause a message to hit the calling pcore,
681 as in the case of locally called proc_destroy()), and in the meantime some
682 useful invariant might be broken.
683
684 We also considered using the transition stack as a signal that a process is in
685 a notification handler.  The kernel can inspect the stack pointer to determine
686 this.  It's possible, but unnecessary.
687
688 Using the pcoremap as a way to pass info with kmsgs: it worked a little, but
689 had some serious problems, as well as making life difficult.  It had two
690 purposes: help with local fate calls (yield) and allow broadcast messaging.
691 The main issue is that it was using a global struct to pass info with
692 messages, but it was based on the snapshot of state at the time the message
693 was sent.  When you send a bunch of messages, certain state may have changed
694 between messages, and the old snapshot isn't there anymore by the time the
695 message gets there.  To avoid this, we went through some hoops and had some
696 fragile code that would use other signals to avoid those scenarios where the
697 global state change would send the wrong message.  It was tough to understand,
698 and not clear it was correct (hint: it wasn't).  Here's an example (on one
699 pcore): if we send a preempt and we then try to map that pcore to another
700 vcore in the same process before the preempt call checks its pcoremap, we'll
701 clobber the pcore->vcore mapping (used by startcore) and the preempt will
702 think it is the new vcore, not the one it was when the message was sent.
703 While this is a bit convoluted, I can imagine a ksched doing this, and
704 perhaps with weird IRQ delays, the messages might get delayed enough for it to
705 happen.  I'd rather not have to have the ksched worry about this just because
706 proc code was old and ghetto.  Another reason we changed all of this was so
707 that you could trust the vcoremap while holding the lock.  Otherwise, it's
708 actually non-trivial to know the state of a vcore (need to check a combination
709 of preempt_served and is_mapped), and even if you do that, there are some
710 complications with doing this in the ksched.
711
712 5. current_tf and owning_proc
713 ===========================
714 Originally, current_tf is a per-core macro that returns a struct trapframe *
715 that points back on the kernel stack to the user context that was running on
716 the given core when an interrupt or trap happened.  Saving the reference to
717 the TF helps simplify code that needs to do something with the TF (like save
718 it and pop another TF).  This way, we don't need to pass the context all over
719 the place, especially through code that might not care.
720
721 Now, current_tf is more broadly defined as the user context that should be run
722 when the kernel is ready to run a process.  In the older case, it was when the
723 kernel tries to return to userspace from a trap/interrupt.  Now, current_tf
724 can be set by an IPI/KMSG (like '__startcore') so that when the kernel wants
725 to idle, it will find a cur_tf that it needs to run, even though we never
726 trapped in on that context in the first place.
727
728 Further, we now have 'owning_proc', which tells the kernel which process
729 should be run.  'owning_proc' is a bigger deal than 'current_tf', and it is
730 what tells us to run cur_tf.
731
732 Process management KMSGs now simply modify 'owning_proc' and cur_tf, as if we
733 had interrupted a process.  Instead of '__startcore' forcing the kernel to
734 actually run the process and trapframe, it will just mean we will eventually
735 run it.  In the meantime a '__notify' or a '__preempt' can come in, and they
736 will apply to the owning_proc/cur_tf.  This greatly simplifies process code
737 and code calling process code (like the scheduler), since we no longer need to
738 worry about whether or not we are getting a "stack killing" kernel message.
739 Before this, code needed to care where it was running when managing _Ms.
740
741 Note that neither 'current_tf' nor 'owning_proc' rely on 'current'/'cur_proc'.
742 'current' is just what process context we're in, not what process (and which
743 trapframe) we will eventually run.
744
745 cur_tf does not point to kernel trapframes, which is important when we receive an
746 interrupt in the kernel.  At one point, we were (hypothetically) clobbering the
747 reference to the user trapframe, and were unable to recover.  We can get away
748 with this because the kernel always returns to its previous context from a
749 nested handler (via iret on x86).  
750
751 In the future, we may need to save kernel contexts and may not always return via
752 iret.  At which point, if the code path is deep enough that we don't want to
753 carry the TF pointer, we may revisit this.  Until then, current_tf is just for
754 userspace contexts, and is simply stored in per_cpu_info.
755
756 Brief note from the future (months after this paragraph was written): cur_tf
757 has two aspects/jobs:
758 1) tell the kernel what we should do (trap, fault, sysc, etc), how we came
759 into the kernel (the fact that it is a user tf), which is why we copy-out
760 early on
761 2) be a vehicle for us to restart the process/vcore
762
763 We've been focusing on the latter case a lot, since that is what gets
764 removed when preempted, changed during a notify, created during a startcore,
765 etc.  Don't forget it was also an instruction of sorts.  The former case is
766 always true throughout the life of the syscall.  The latter only happens to be
767 true throughout the life of a *non-blocking* trap since preempts are routine
768 KMSGs.  But if we block in a syscall, the cur_tf is no longer the TF we came
769 in on (and possibly the one we are asked to operate on), and that old cur_tf
770 has probably restarted.
771
772 (Note that cur_tf is a pointer, and syscalls/traps actually operate on the TF
773 they came in on regardless of what happens to cur_tf or pcpui->actual_tf.)
774
775 6. Locking!
776 ===========================
777 6.1: proc_lock
778 ---------------------------
779 Currently, all locking is done on the proc_lock.  It's main goal is to protect
780 the vcore mapping (vcore->pcore and vice versa).  As of Apr 2010, it's also used
781 to protect changes to the address space and the refcnt.  Eventually the refcnt
782 will be handled with atomics, and the address space will have it's own MM lock.  
783
784 We grab the proc_lock all over the place, but we try to avoid it whereever
785 possible - especially in kernel messages or other places that will be executed
786 in parallel.  One place we do grab it but would like to not is in proc_yield().  
787 We don't always need to grab the proc lock.  Here are some examples:
788
789 6.1.1: Lockless Notifications:
790 -------------
791 We don't lock when sending a notification.  We want the proc_lock to not be an
792 irqsave lock (discussed below).  Since we might want to send a notification from
793 interrupt context, we can't grab the proc_lock if it's a regular lock.  
794
795 This is okay, since the proc_lock is only protecting the vcoremapping.  We could
796 accidentally send the notification to the wrong pcore.  The __notif handler
797 checks to make sure it is the right process, and all _M processes should be able
798 to handle spurious notifications.  This assumes they are still _M.
799
800 If we send it to the wrong pcore, there is a danger of losing the notif, since
801 it didn't go to the correct vcore.  That would happen anyway, (the vcore is
802 unmapped, or in the process of mapping).  The notif_pending flag will be caught
803 when the vcore is started up next time (and that flag was set before reading the
804 vcoremap).
805
806 6.1.2: Local get_vcoreid():
807 -------------
808 It's not necessary to lock while checking the vcoremap if you are checking for
809 the core you are running on (e.g. pcoreid == core_id()).  This is because all
810 unmappings of a vcore are done on the receive side of a routine kmsg, and that
811 code cannot run concurrently with the code you are running.  
812
813 6.2: irqsave
814 ---------------------------
815 The proc_lock used to be an irqsave lock (meaning it disables interrupts and can
816 be grabbed from interrupt context).  We made it a regular lock for a couple
817 reasons.  The immediate one was it was causing deadlocks due to some other
818 ghetto things (blocking on the frontend server, for instance).  More generally,
819 we don't want to disable interrupts for long periods of time, so it was
820 something worth doing anyway.  
821
822 This means that we cannot grab the proc_lock from interrupt context.  This
823 includes having schedule called from an interrupt handler (like the
824 timer_interrupt() handler), since it will call proc_run.  Right now, we actually
825 do this, which we shouldn't, and that will eventually get fixed.  The right
826 answer is that the actual work of running the scheduler should be a routine
827 kmsg, similar to how Linux sets a bit in the kernel that it checks on the way
828 out to see if it should run the scheduler or not.
829
830 7. TLB Coherency
831 ===========================
832 When changing or removing memory mappings, we need to do some form of a TLB
833 shootdown.  Normally, this will require sending an IPI (immediate kmsg) to
834 every vcore of a process to unmap the affected page.  Before allocating that
835 page back out, we need to make sure that every TLB has been flushed.  
836
837 One reason to use a kmsg over a simple handler is that we often want to pass a
838 virtual address to flush for those architectures (like x86) that can
839 invalidate a specific page.  Ideally, we'd use a broadcast kmsg (doesn't exist
840 yet), though we already have simple broadcast IPIs.
841
842 7.1 Initial Stuff
843 ---------------------------
844 One big issue is whether or not to wait for a response from the other vcores
845 that they have unmapped.  There are two concerns: 1) Page reuse and 2) User
846 semantics.  We cannot give out the physical page while it may still be in a
847 TLB (even to the same process.  Ask us about the pthread_test bug).
848
849 The second case is a little more detailed.  The application may not like it if
850 it thinks a page is unmapped or protected, and it does not generate a fault.
851 I am less concerned about this, especially since we know that even if we don't
852 wait to hear from every vcore, we know that the message was delivered and the
853 IPI sent.  Any cores that are in userspace will have trapped and eventually
854 handle the shootdown before having a chance to execute other user code.  The
855 delays in the shootdown response are due to being in the kernel with
856 interrupts disabled (it was an IMMEDIATE kmsg).
857
858 7.2 RCU
859 ---------------------------
860 One approach is similar to RCU.  Unmap the page, but don't put it on the free
861 list.  Instead, don't reallocate it until we are sure every core (possibly
862 just affected cores) had a chance to run its kmsg handlers.  This time is
863 similar to the RCU grace periods.  Once the period is over, we can then truly
864 free the page.
865
866 This would require some sort of RCU-like mechanism and probably a per-core
867 variable that has the timestamp of the last quiescent period.  Code caring
868 about when this page (or pages) can be freed would have to check on all of the
869 cores (probably in a bitmask for what needs to be freed).  It would make sense
870 to amortize this over several RCU-like operations.
871
872 7.3 Checklist
873 ---------------------------
874 It might not suck that much to wait for a response if you already sent an IPI,
875 though it incurs some more cache misses.  If you wanted to ensure all vcores
876 ran the shootdown handler, you'd have them all toggle their bit in a checklist
877 (unused for a while, check smp.c).  The only one who waits would be the
878 caller, but there still are a bunch of cache misses in the handlers.  Maybe
879 this isn't that big of a deal, and the RCU thing is an unnecessary
880 optimization.
881
882 7.4 Just Wait til a Context Switch
883 ---------------------------
884 Another option is to not bother freeing the page until the entire process is
885 descheduled.  This could be a very long time, and also will mess with
886 userspace's semantics.  They would be running user code that could still
887 access the old page, so in essence this is a lazy munmap/mprotect.  The
888 process basically has the page in pergatory: it can't be reallocated, and it
889 might be accessible, but can't be guaranteed to work.
890
891 The main benefit of this is that you don't need to send the TLB shootdown IPI
892 at all - so you don't interfere with the app.  Though in return, they have
893 possibly weird semantics.  One aspect of these weird semantics is that the
894 same virtual address could map to two different pages - that seems like a
895 disaster waiting to happen.  We could also block that range of the virtual
896 address space from being reallocated, but that gets even more tricky.
897
898 One issue with just waiting and RCU is memory pressure.  If we actually need
899 the page, we will need to enforce an unmapping, which sucks a little.
900
901 7.5 Bulk vs Single
902 ---------------------------
903 If there are a lot of pages being shot down, it'd be best to amortize the cost
904 of the kernel messages, as well as the invlpg calls (single page shootdowns).
905 One option would be for the kmsg to take a range, and not just a single
906 address.  This would help with bulk munmap/mprotects.  Based on the number of
907 these, perhaps a raw tlbflush (the entire TLB) would be worth while, instead
908 of n single shots.  Odds are, that number is arch and possibly workload
909 specific.
910
911 For now, the plan will be to send a range and have them individually shot
912 down.
913
914 7.6 Don't do it
915 ---------------------------
916 Either way, munmap/mprotect sucks in an MCP.  I recommend not doing it, and
917 doing the appropriate mmap/munmap/mprotects in _S mode.  Unfortunately, even
918 our crap pthread library munmaps on demand as threads are created and
919 destroyed.  The vcore code probably does in the bowels of glibc's TLS code
920 too, though at least that isn't on every user context switch.
921
922 7.7 Local memory
923 ---------------------------
924 Private local memory would help with this too.  If each vcore has its own
925 range, we won't need to send TLB shootdowns for those areas, and we won't have
926 to worry about weird application semantics.  The downside is we would need to
927 do these mmaps in certain ranges in advance, and might not easily be able to
928 do them remotely.  More on this when we actually design and build it.
929
930 7.8 Future Hardware Support
931 ---------------------------
932 It would be cool and interesting if we had the ability to remotely shootdown
933 TLBs.  For instance, all cores with cr3 == X, shootdown range Y..Z.  It's
934 basically what we'll do with the kernel message and the vcoremap, but with
935 magic hardware.
936
937 7.9 Current Status
938 ---------------------------
939 For now, we just send a kernel message to all vcores to do a full TLB flush,
940 and not to worry about checklists, waiting, or anything.  This is due to being
941 short on time and not wanting to sort out the issue with ranges.  The way
942 it'll get changed to is to send the kmsg with the range to the appropriate
943 cores, and then maybe put the page on the end of the freelist (instead of the
944 head).  More to come.
945
946 8. Process Management
947 ===========================
948 8.1 Vcore lists
949 ---------------------------
950 We have three lists to track a process's vcores.  The vcores themselves sit in
951 the vcoremap in procinfo; they aren't dynamically allocated (memory) or
952 anything like that.  The lists greatly eases vcore discovery and management.
953
954 A vcore is on exactly one of three lists: online (mapped and running vcores,
955 sometimes called 'active'), bulk_preempt (was online when the process was bulk
956 preempted (like a timeslice)), and inactive (yielded, hasn't come on yet,
957 etc).  When writes are complete (unlocked), either the online list or the
958 bulk_preempt list should be empty.
959
960 List modifications are protected by the proc_lock.  You can concurrently read,
961 but note you may get some weird behavior, such as a vcore on multiple lists, a
962 vcore on no lists, online and bulk_preempt both having items, etc.  Currently,
963 event code will read these lists when hunting for a suitable core, and will
964 have to be careful about races.  I want to avoid event FALLBACK code from
965 grabbing the proc_lock.
966
967 Another slight thing to be careful of is that the vcore lists don't always
968 agree with the vcore mapping.  However, it will always agree with what the
969 state of the process will be when all kmsgs are processed (fate).
970 Specifically, when we take vcores, the unmapping happens with the lock not
971 held on the vcore itself (as discussed elsewhere).  The vcore lists represent
972 the result of those pending unmaps.
973
974 Before we used the lists, we scanned the vcoremap in a painful, clunky manner.
975 In the old style, when you asked for a vcore, the first one you got was the
976 first hole in the vcoremap.  Ex: Vcore0 would always be granted if it was
977 offline.  That's no longer true; the most recent vcore yielded will be given
978 out next.  This will help with cache locality, and also cuts down on the
979 scenarios on which the kernel gives out a vcore that userspace wasn't
980 expecting.  This can still happen if they ask for more vcores than they set up
981 for, or if a vcore doesn't *want* to come online (there's a couple scenarios
982 with preemption recovery where that may come up).
983
984 So the plan with the bulk preempt list is that vcores on it were preempted,
985 and the kernel will attempt to restart all of them (and move them to the online
986 list).  Any leftovers will be moved to the inactive list, and have preemption
987 recovery messages sent out.  Any shortages (they want more vcores than were
988 bulk_preempted) will be taken from the yield list.  This all means that
989 whether or not a vcore needs to be preempt-recovered or if there is a message
990 out about its preemption doesn't really affect which list it is on.  You could
991 have a vcore on the inactive list that was bulk preempted (and not turned back
992 on), and then that vcore gets granted in the next round of vcore_requests().
993 The preemption recovery handlers will need to deal with concurrent handlers
994 and the vcore itself starting back up.
995
996 9. On the Ordering of Messages and Bugs with Old State
997 ===========================
998 This is a sordid tale involving message ordering, message delivery times, and
999 finding out (sometimes too late) that the state you expected is gone and
1000 having to deal with that error.
1001
1002 A few design issues:
1003 - being able to send messages and have them execute in the order they are
1004   sent
1005 - having message handlers resolve issues with global state.  Some need to know
1006   the correct 'world view', and others need to know what was the state at the
1007   time they were sent.
1008 - realizing syscalls, traps, faults, and any non-IRQ entry into the kernel is
1009   really a message.
1010
1011 Process management messages have alternated from ROUTINE to IMMEDIATE and now
1012 back to ROUTINE.  These messages include such family favorites as
1013 '__startcore', '__preempt', etc.  Meanwhile, syscalls were coming in that
1014 needed to know about the core and the process's state (specifically, yield,
1015 change_to, and get_vcoreid).  Finally, we wanted to avoid locking, esp in
1016 KMSGs handlers (imagine all cores grabbing the lock to check the vcoremap or
1017 something).
1018
1019 Incidentally, events were being delivered concurretly to vcores, though that
1020 actually didn't matter much (check out async_events.txt for more on that).
1021
1022 9.1: Design Guidelines
1023 ---------------------------
1024 Initially, we wanted to keep broadcast messaging available as an option.  As
1025 noted elsewhere, we can't really do this well for startcore, since most
1026 hardware broadcast options need some initial per-core setup, and any sort of
1027 broadcast tree we make should be able to handle a small message.  Anyway, this
1028 desire in the early code to keep all messages identical lead to a few
1029 problems.
1030
1031 Another objective of the kernel messaging was to avoid having the message
1032 handlers grab any locks, especially the same lock (the proc lock is used to
1033 protect the vcore map, for instance).
1034
1035 Later on, a few needs popped up that motivated the changes discussed below:
1036 - Being able to find out which proc/vcore was on a pcore
1037 - Not having syscalls/traps require crazy logic if the carpet was pulled out
1038   from under them.
1039 - Having proc management calls return.  This one was sorted out by making all
1040   kmsg handlers return.  It would be a nightmare making a ksched without this.
1041
1042 9.2: Looking at Old State: a New Bug for an Old Problem
1043 ---------------------------
1044 We've always had issues with syscalls coming in and already had the fate of a
1045 core determined.  This is referred to in a few places as "predetermined fate"
1046 vs "local state".  A remote lock holder (ksched) already determined a core
1047 should be unmapped and sent a message.  Only later does some call like
1048 proc_yield() realize its core is already *unmapped*. (I use that term poorly
1049 here).  This sort of code had to realize it was working on an old version of
1050 state and just abort.  This was usually safe, though looking at the vcoremap
1051 was a bad idea.  Initially, we used preempt_served as the signal, which was
1052 okay.  Around 12b06586 yield started to use the vcoremap, which turned out to
1053 be wrong.
1054
1055 A similar issue happens for the vcore messages (startcore, preempt, etc).  The
1056 way startcore used to work was that it would only know what pcore it was on,
1057 and then look into the vcoremap to figure out what vcoreid it should be
1058 running.  This was to keep broadcast messaging available as an option.  The
1059 problem with it is that the vcoremap may have changed between when the
1060 messages were sent and when they were executed.  Imagine a startcore followed
1061 by a preempt, afterwhich the vcore was unmapped.  Well, to get around that, we
1062 had the unmapping happen in the preempt or death handlers.  Yikes!  This was
1063 the case back in the early days of ROS.  This meant the vcoremap wasn't
1064 actually representative of the decisions the ksched made - we also needed to
1065 look at the state we'd have after all outstanding messages executed.  And this
1066 would differ from the vcore lists (which were correct for a lock holder).
1067
1068 This was managable for a little while, until I tried to conclusively know who
1069 owned a particular pcore.  This came up while making a provisioning scheduler.
1070 Given a pcore, tell me which process/vcore (if any) were on it.  It was rather
1071 tough.  Getting the proc wasn't too hard, but knowing which vcore was a little
1072 tougher.  (Note the ksched doesn't care about which vcore is running, and the
1073 process can change vcores on a pcore at will).  But once you start looking at
1074 the process, you can't tell which vcore a certain pcore has.  The vcoremap may
1075 be wrong, since a preempt is already on the way.  You would have had to scan
1076 the vcore lists to see if the proc code thought that vcore was online or not
1077 (which would mean there had been no preempts).  This is the pain I was talking
1078 about back around commit 5343a74e0.
1079
1080 So I changed things so that the vcoremap was always correct for lock holders,
1081 and used pcpui to track owning_vcoreid (for preempt/notify), and used an extra
1082 KMSG variable to tell startcore which vcoreid it should use.  In doing so, we
1083 (re)created the issue that the delayed unmapping dealt with: the vcoremap
1084 would represent *now*, and not the vcoremap of when the messages were first
1085 sent.  However, this had little to do with the KMSGs, which I was originally
1086 worried about.  No one was looking at the vcoremap without the lock, so the
1087 KMSGs were okay, but remember: syscalls are like messages too.  They needed to
1088 figure out what vcore they were on, i.e. what vcore userspace was making
1089 requests on (viewing a trap/fault as a type of request).
1090
1091 Now the problem was that we were using the vcoremap to figure out which vcore
1092 we were supposed to be.  When a syscall finally ran, the vcoremap could be
1093 completely wrong, and with immediate KMSGs (discussed below), the pcpui was
1094 already changed!  We dealt with the problem for KMSGs, but not syscalls, and
1095 basically reintroduced the bug of looking at current state and thinking it
1096 represented the state from when the 'message' was sent (when we trapped into
1097 the kernel, for a syscall/exception).
1098
1099 9.3: Message Delivery, Circular Waiting, and Having the Carpet Pulled Out
1100 ---------------------------
1101 In-order message delivery was what drove me to build the kernel messaging
1102 system in the first place.  It provides in-order messages to a particular
1103 pcore.  This was enough for a few scenarios, such as preempts racing ahead of
1104 startcores, or deaths racing a head of preempts, etc.  However, I also wanted
1105 an ordering of messages related to a particular vcore, and this wasn't
1106 apparent early on.
1107
1108 The issue first popped up with a startcore coming quickly on the heals of a
1109 preempt for the same VC, but on different PCs.  The startcore cannot proceed
1110 until the preempt saved the TF into the VCPD.  The old way of dealing with
1111 this was to spin in '__map_vcore()'.  This was problematic, since it meant we
1112 were spinning while holding a lock, and resulted in some minor bugs and issues
1113 with lock ordering and IRQ disabling (couldn't disable IRQs and then try to
1114 grab the lock, since the lock holder could have sent you a message and is
1115 waiting for you to handle the IRQ/IMMED KMSG).  However, it was doable.  But
1116 what wasn't doable was to have the KMSGs be ROUTINE.  Any syscalls that tried
1117 to grab the proc lock (lots of them) would deadlock, since the lock holder was
1118 waiting on us to handle the preempt (same circular waiting issue as above).
1119
1120 This was fine, albeit subpar, until a new issue showed up.  Sending IMMED
1121 KMSGs worked fine if we were coming from userspace already, but if we were in
1122 the kernel, those messages would run immediately (hence the name), just like
1123 an IRQ handler, and could confuse syscalls that touched cur_tf/pcpui.  If a
1124 preempt came in during a syscall, the process/vcore could be changed before
1125 the syscall took place.  Some syscalls could handle this, albeit poorly.
1126 sys_proc_yield() and sys_change_vcore() delicately tried to detect if they
1127 were still mapped or not and use that to determine if a preemption happened.
1128
1129 As mentioned above, looking at the vcoremap only tells you what is currently
1130 happening, and not what happened in the past.  Specifically, it doesn't tell
1131 you the state of the mapping when a particular core trapped into the kernel
1132 for a syscall (referred to as when the 'message' was sent up above).  Imagine
1133 sys_get_vcoreid(): you trap in, then immediately get preempted, then startcore
1134 for the same process but a different vcoreid.  The syscall would return with
1135 the vcoreid of the new vcore, since it cannot tell there was a change.  The
1136 async syscall would complete and we'd have a wrong answer.  While this never
1137 happened to me, I had a similar issue while debugging some other bugs (I'd get
1138 a vcoreid of 0xdeadbeef, for instance, which was the old poison value for an
1139 unmapped vcoreid).  There are a bunch of other scenarios that trigger similar
1140 disasters, and they are very hard to avoid.
1141
1142 One way out of this was a per-core history counter, that changed whenever we
1143 changed cur_tf.  Then when we trapped in for a syscall, we could save the
1144 value, enable_irqs(), and go about our business.  Later on, we'd have to
1145 disable_irqs() and compare the counters.  If they were different, we'd have to
1146 bail out some how.  This could have worked for change_to and yield, and some
1147 others.  But any syscall that wanted to operate on cur_tf in some way would
1148 fail (imagine a hypothetical sys_change_stack_pointer()).  The context that
1149 trapped has already returned on another core.  I guess we could just fail that
1150 syscall, though it seems a little silly to not be able to do that.
1151
1152 The previous example was a bit contrived, but lets also remember that it isn't
1153 just syscalls: all exceptions have the same issue.  Faults might be fixable,
1154 since if you restart a faulting context, it will start on the faulting
1155 instruction.  However all traps (like syscall) restart on the next
1156 instruction.  Hope we don't want to do anything fancy with breakpoint!  Note
1157 that I had breakpointing contexts restart on other pcores and continue while I
1158 was in the breakpoint handler (noticed while I was debugging some bugs with
1159 lots of preempts).  Yikes.  And don't forget we eventually want to do some
1160 complicated things with the page fault handler, and may want to turn on
1161 interrupts / kthread during a page fault (imaging hitting disk).  Yikes.
1162
1163 So I looked into going back to ROUTINE kernel messages.  With ROUTINE
1164 messages, I didn't have to worry about having the carpet pulled out from under
1165 syscalls and exceptions (traps, faults, etc).  The 'carpet' is stuff like
1166 cur_tf, owning_proc, owning_vcoreid, etc.  We still cannot trust the vcoremap,
1167 unless we *know* there were no preempts or other KMSGs waiting for us.
1168 (Incidentally, in the recent fix a93aa7559, we merely use the vcoremap as a
1169 sanity check).
1170
1171 However, we can't just switch back to ROUTINEs.  Remember: with ROUTINEs,
1172 we will deadlock in '__map_vcore()', when it waits for the completion of
1173 preempt.  Ideally, we would have had startcore spin on the signal.  Since we
1174 already gave up on using x86-style broadcast IPIs for startcore (in
1175 5343a74e0), we might as well pass along a history counter, so it knows to wait
1176 on preempt.
1177
1178 9.4: The Solution
1179 ---------------------------
1180 To fix up all of this, we now detect preemptions in syscalls/traps and order
1181 our kernel messages with two simple per-vcore counters.  Whenever we send a
1182 preempt, we up one counter.  Whenever that preempt finishes, it ups another
1183 counter.  When we send out startcores, we send a copy of the first counter.
1184 This is a way of telling startcore where it belongs in the list of messages.
1185 More specifically, it tells it which preempt happens-before it.
1186
1187 Basically, I wanted a partial ordering on my messages, so that messages sent
1188 to a particular vcore are handled in the order they were sent, even if those
1189 messages run on different physical cores.
1190
1191 It is not sufficient to use a seq counter (one integer, odd values for
1192 'preempt in progress' and even values for 'preempt done').  It is possible to
1193 have multiple preempts in flight for the same vcore, albeit with startcores in
1194 between.  Still, there's no way to encode that scenario in just one counter.
1195
1196 Here's a normal example of traffic to some vcore.  I note both the sending and
1197 the execution of the kmsgs:
1198    nr_pre_sent    nr_pre_done    pcore     message sent/status
1199    -------------------------------------------------------------
1200    0              0              X         startcore (nr_pre_sent == 0)
1201    0              0              X         startcore (executes)
1202    1              0              X         preempt   (kmsg sent)
1203    1              1              Y         preempt   (executes)
1204    1              1              Y         startcore (nr_pre_sent == 1)
1205    1              1              Y         startcore (executes)
1206
1207 Note the messages are always sent by the lockholder in the order of the
1208 example above.
1209
1210 Here's when the startcore gets ahead of the prior preempt:
1211    nr_pre_sent    nr_pre_done    pcore     message sent/status
1212    -------------------------------------------------------------
1213    0              0              X         startcore (nr_pre_sent == 0) 
1214    0              0              X         startcore (executes)
1215    1              0              X         preempt   (kmsg sent)
1216    1              0              Y         startcore (nr_pre_sent == 1)
1217    1              1              X         preempt   (executes)
1218    1              1              Y         startcore (executes)
1219
1220 Note that this can only happen across cores, since KMSGs to a particular core
1221 are handled in order (for a given class of message).  The startcore blocks on
1222 the prior preempt.
1223
1224 Finally, here's an example of what a seq ctr can't handle:
1225    nr_pre_sent    nr_pre_done    pcore     message sent/status
1226    -------------------------------------------------------------
1227    0              0              X         startcore (nr_pre_sent == 0) 
1228    1              0              X         preempt   (kmsg sent)
1229    1              0              Y         startcore (nr_pre_sent == 1)
1230    2              0              Y         preempt   (kmsg sent)
1231    2              0              Z         startcore (nr_pre_sent == 2)
1232    2              1              X         preempt   (executes (upped to 1))
1233    2              1              Y         startcore (executes (needed 1))
1234    2              2              Y         preempt   (executes (upped to 2))
1235    2              Z              Z         startcore (executes (needed 2))
1236
1237 As a nice bonus, it is easy for syscalls that care about the vcoreid (yield,
1238 change_to, get_vcoreid) to check if they have a preempt_served.  Just grab the
1239 lock (to prevent further messages being sent), then check the counters.  If
1240 they are equal, there is no preempt on its way.  This actually was the
1241 original way we checked for preempts in proc_yield back in the day.  It was
1242 just called preempt_served.  Now, it is split into two counters, instead of
1243 just being a bool.  
1244
1245 Regardless of whether or not we were preempted, we still can look at
1246 pcpui->owning_proc and owning_vcoreid to figure out what the vcoreid of the
1247 trap/syscall is, and we know that the cur_tf is still the correct cur_tf (no
1248 carpet pulled out), since while there could be a preempt ROUTINE message
1249 waiting for us, we simply haven't run it yet.  So calls like yield should
1250 still fail (since your core has been unmapped and you need to bail out and run
1251 the preempt handler), but calls like sys_change_stack_pointer can proceed.
1252 More importantly than that old joke syscall, the page fault handler can try to
1253 do some cool things without worrying about really crazy stuff.
1254
1255 9.5: Why We (probably) Don't Deadlock
1256 ---------------------------
1257 It's worth thinking about why this setup of preempts and startcores can't
1258 deadlock.  Anytime we spin in the kernel, we ought to do this.  Perhaps there
1259 is some issue with other KMSGs for other processes, or other vcores, or
1260 something like that that can cause a deadlock.
1261
1262 Hypothetical case: pcore 1 has a startcore for vc1 which is stuck behind vc2's
1263 startcore on PC2, with time going upwards.  In these examples, startcores are
1264 waiting on particular preempts, subject to the nr_preempts_sent parameter sent
1265 along with the startcores.
1266
1267 ^                       
1268 |            _________                 _________
1269 |           |         |               |         |
1270 |           | pr vc 2 |               | pr vc 1 |
1271 |           |_________|               |_________|
1272 |
1273 |            _________                 _________
1274 |           |         |               |         |
1275 |           | sc vc 1 |               | sc vc 2 |
1276 |           |_________|               |_________|
1277 t           
1278 ---------------------------------------------------------------------------
1279               ______                    ______
1280              |      |                  |      |
1281              | PC 1 |                  | PC 2 |
1282              |______|                  |______|
1283
1284 Here's the same picture, but with certain happens-before arrows.  We'll use X --> Y to
1285 mean X happened before Y, was sent before Y.  e.g., a startcore is sent after
1286 a preempt.
1287
1288 ^                       
1289 |            _________                 _________
1290 |           |         |               |         |
1291 |       .-> | pr vc 2 | --.    .----- | pr vc 1 | <-.
1292 |       |   |_________|    \  /   &   |_________|   |  
1293 |     * |                   \/                      | * 
1294 |       |    _________      /\         _________    |  
1295 |       |   |         |    /  \   &   |         |   |  
1296 |       '-- | sc vc 1 | <-'    '----> | sc vc 2 | --'
1297 |           |_________|               |_________|
1298 t           
1299 ---------------------------------------------------------------------------
1300               ______                    ______
1301              |      |                  |      |
1302              | PC 1 |                  | PC 2 |
1303              |______|                  |______|
1304
1305 The arrows marked with * are ordered like that due to the property of KMSGs,
1306 in that we have in order delivery.  Messages are executed in the order in
1307 which they were sent (serialized with a spinlock btw), so on any pcore,
1308 messages that are further ahead in the queue were sent before (and thus will
1309 be run before) other messages.
1310
1311 The arrows marked with a & are ordered like that due to how the proc
1312 management code works.  The kernel won't send out a startcore for a particular
1313 vcore before it sent out a preempt.  (Note that techincally, preempts follow
1314 startcores.  The startcores in this example are when we start up a vcore after
1315 it had been preempted in the past.).
1316
1317 Anyway, note that we have a cycle, where all events happened before each
1318 other, which isn't possible.  The trick to connecting "unrelated" events like
1319 this (unrelated meaning 'not about the same vcore') in a happens-before manner
1320 is the in-order properties of the KMSGs.
1321
1322 Based on this example, we can derive general rules.  Note that 'sc vc 2' could
1323 be any kmsg that waits on another message placed behind 'sc vc 1'.  This would
1324 require us having sent a KMSG that waits on a KMSGs that we send later.  Bad
1325 idea!  (you could have sent that KMSGs to yourself, aside from just being
1326 dangerous).  If you want to spin, make sure you send the work that should
1327 happen-before actually-before the waiter.
1328
1329 In fact, we don't even need 'sc vc 2' to be a KMSG.  It could be miscellaneous
1330 kernel code, like a proc mgmt syscall.  Imagine if we did something like the
1331 old '__map_vcore' call from within the ksched.  That would be code that holds
1332 the lock, and then waits on the execution of a message handler.  That would
1333 deadlock (which is why we don't do it anymore).
1334
1335 Finally, in case this isn't clear, all of the startcores and preempts for
1336 a given vcore exist in a happens-before relation, both in sending and in
1337 execution.  The sending aspect is handled by proc mgmt code.  For execution,
1338 preempts always follow startcores due to the KMSG ordering property.  For
1339 execution of startcores, startcores always spin until the preempt they follow
1340 is complete, ensuring the execution of the main part of their handler happens
1341 after the prior preempt.
1342
1343 Here's some good ideas for the ordering of locks/irqs/messages:
1344 - You can't hold a spinlock of any sort and then wait on a routine kernel
1345   message.  The core where that runs may be waiting on you, or some scenario
1346   like above.
1347         - Similarly, think about how this works with kthreads.  A kthread restart
1348           is a routine KMSG.  You shouldn't be waiting on code that could end up
1349           kthreading, mostly because those calls block!
1350 - You can hold a spinlock and wait on an IMMED kmsg, if the waiters of the
1351   spinlock have irqs enabled while spinning (this is what we used to do with
1352   the proc lock and IMMED kmsgs, and 54c6008 is an example of doing it wrong)
1353         - As a corollary, locks like this cannot be irqsave, since the other
1354           attempted locker will have irq disabled
1355 - For broadcast trees, you'd have to send IMMEDs for the intermediates, and
1356   then it'd be okay to wait on those intermediate, immediate messages (if we
1357   wanted confirmation of the posting of RKM)
1358         - The main thing any broadcast mechanism needs to do is make sure all
1359           messages get delivered in order to particular pcores (the central
1360           premise of KMSGs) (and not deadlock due to waiting on a KMSG improperly)
1361 - Alternatively, we could use routines for the intermediates if we didn't want
1362   to wait for RKMs to hit their destination, we'd need to always use the same
1363   proxy for the same destination pcore, e.g., core 16 always covers 16-31.
1364         - Otherwise, we couldn't guarantee the ordering of SC before PR before
1365           another SC (which the proc_lock and proc mgmt code does); we need the
1366           ordering of intermediate msgs on the message queues of a particular
1367           core.
1368         - All kmsgs would need to use this broadcasting style (couldn't mix
1369           regular direct messages with broadcast), so odds are this style would be
1370           of limited use.
1371         - since we're not waiting on execution of a message, we could use RKMs
1372           (while holding a spinlock)
1373 - There might be some bad effects with kthreads delaying the reception of RKMS
1374   for a while, but probably not catastrophically.
1375
1376 9.6: Things That We Don't Handle Nicely
1377 ---------------------------
1378 If for some reason a syscall or fault handler blocks *unexpectedly*, we could
1379 have issues.  Imagine if change_to happens to block in some early syscall code
1380 (like instrumentation, or who knows what, that blocks in memory allocation).
1381 When the syscall kthread restarts, its old cur_tf is gone.  It may or may not
1382 be running on a core owned by the original process.  If it was, we probably
1383 would accidentally yield that vcore (clearly a bug).  
1384
1385 For now, any of these calls that care about cur_tf/pcpui need to not block
1386 without some sort of protection.  None of them do, but in the future we might
1387 do something that causes them to block.  We could deal with it by having a
1388 pcpu or per-kthread/syscall flag that says if it ever blocked, and possibly
1389 abort.  We get into similar nasty areas as with preempts, but this time, we
1390 can't solve it by making preempt a routine KMSG - we block as part of that
1391 syscall/handler code.  Odds are, we'll just have to outlaw this, now and
1392 forever.  Just note that if a syscall/handler blocks, the TF it came in on is
1393 probably not cur_tf any longer, and that old cur_tf has probably restarted.
1394
1395 10. TBD
1396 ===========================