ev_qs can request fallback to active vcores (XCC)
[akaros.git] / Documentation / async_events.txt
1 async_events.txt
2 Barret Rhoden
3
4 1. Overview
5 2. Async Syscalls and I/O
6 3. Event Delivery / Notification
7 4. Misc Things That Aren't Sorted Completely:
8
9 1. Overview
10 ====================
11 1.1 Event Handling / Notifications / Async IO Issues:
12 ------------------------------------------------------------------
13 Basically, syscalls use the ROS event delivery mechanisms, redefined and
14 described below.  Syscalls use the event delivery just like any other
15 subsystem would that wants to deliver messages to a process.  The only other
16 example we have right now are the "kernel notifications", which are the
17 one-sided, kernel-initiated messages that the kernel sends to a process.
18
19 Overall, there are several analogies from how vcores work to how the OS
20 handles interrupts.  This is a result of trying to make vcores run like
21 virtual multiprocessors, in control of their resources and aware of the lower
22 levels of the system.  This analogy has guided much of how the vcore layer
23 works.  Whenever we have issues with the 2-lsched, realize the amount of
24 control they want means using solutions that the OS must do too.
25
26 Note that there is some pointer chasing going on, though we try to keep it to
27 a minimum.  Any time the kernel chases a pointer, it needs to make sure it is
28 in the R/W section of userspace, though it doesn't need to check if the page
29 is present.  There's more info in the Page Fault sections of the
30 documentation.  (Briefly, if the kernel PFs on a user address, it will either
31 block and handle the PF, or if the address was unmapped, it will kill the
32 process).
33
34 1.2 Some Definitions:
35 ---------------------------------------
36 ev_q, event_queue, event_q: all terms used interchangeably with each other.
37 They are the endpoint for communicating messages to a process, encapsulating
38 the method of delivery (such as IPI or not) with where to save the message.
39
40 Vcore context: the execution context of the virtual core on the "trampoline"
41 stack.  All executions start from the top of this stack, and no stack state is
42 saved between vcore_entry() calls.  All executions on here are non-blocking,
43 notifications (IPIs) are disabled, and there is a specific TLS loaded.  Vcore
44 context is used for running the second level scheduler (2LS), swapping between
45 threads, and handling notifications.  It is analagous to "interrupt context"
46 in the OS.  Any functions called from here should be brief.  Any memory
47 touched must be pinned.  In Lithe terms, vcore context might be called the
48 Hart / hard thread.  People often wonder if they can run out of vcore context
49 directly.  Technically, you can, but you lose the ability to take any fault
50 (page fault) or to get IPIs for notification.  In essence, you lose control,
51 analgous to running an application in the kernel with preemption/interrupts
52 disabled.  See the process documentation for more info.
53
54 2LS: is the second level scheduler/framework.  This code executes in vcore
55 context, and is Lithe / plugs in to Lithe (eventually).  Often used
56 interchangeably with "vcore context", usually when I want to emphasize the
57 scheduling nature of the code.
58
59 VCPD: "virtual core preemption data".  In procdata, there is an array of
60 struct preempt_data, one per vcore.  This is the default location to look for
61 all things related to the management of vcores, such as its event_mbox (queue
62 of incoming messages/notifications/events).  Both the kernel and the vcore
63 code know to look here for a variety of things.
64
65 Notif_table: This is a list of event_q*s that correspond to certain
66 unexpected/"one-sided" events the kernel sends to the process.  It is similar
67 to an IRQ table in the kernel.  Each event_q tells the kernel how the process
68 wants to be told about the specific event type.
69
70 Notifications: used to be a generic event, but now used in terms of the verb
71 'notify' (do_notify()).  In older docs, passive notification is just writing a
72 message somewhere.  Active notification is an IPI delivered to a vcore.  I use
73 that term interchangeably with an IPI, and usually you can tell by context
74 that I'm talking about an IPI going to a process (and not just the kernel).
75 The details of it make it more complicated than just an IPI, but it's
76 analagous.  I've start referring to notification as the IPI, and "passive
77 notification" as just events, though older documentation has both meanings.
78
79 BCQ: "bounded concurrent queue".  It is a fixed size array of messages
80 (structs of notification events, or whatever).  It is non-blocking, supporting
81 multiple producers and consumers, where the producers do not trust the
82 consumers.  It is the primary mechanism for the kernel delivering message
83 payloads into a process's address space.  Note that producers don't trust each
84 other either (in the event of weirdness, the producers give up and say the
85 buffer is full).  This means that a process can produce for one of its ev_qs
86 (which is what they need to do to send message to itself).
87
88 2. Async Syscalls and I/O
89 ====================
90 2.1 Basics
91 ----------------------------------------------
92 The syscall struct is the contract for work with the kernel, including async
93 I/O.  Lots of current OS async packages use epoll or other polling systems.
94 Note the distinction between Polling and Async I/O.  Polling is about finding
95 out if a call will block.  It is primarily used for sockets and pipes.  It
96 does relatively nothing for disk I/O, which requires a separate async I/O
97 system.  By having all syscalls be async, we can make polling a bit easier and
98 more unified with the generic event code that we use for all syscalls.
99
100 For instance, we can have a sys_poll syscall, which is async just like any
101 other syscall.  The call can be a "one shot / non-blocking", like the current
102 systems polling code, or it can also notify on change (not requiring future
103 polls) via the event_q mechanisms.  If you don't want to be IPId, you can
104 "poll" the syscall struct - not requiring another kernel crossing/syscall.
105
106 Note that we do not tie syscalls and polling to FDs.  We do events on
107 syscalls, which can be used to check FDs.  I think a bunch of polling cases
108 will not be needed once we have async syscalls, but for those that remain,
109 we'll have sys_poll() (or whatever).
110
111 To receive an event on a syscall completion or status change, just fill in the
112 event_q pointer.  If it is 0, the kernel will assume you poll the actual
113 syscall struct.
114
115         struct syscall {
116                 current stuff                   /* arguments, retvals */
117                 struct ev_queue *               /* struct used for messaging, including IPIs*/
118                 void *                                  /* used by 2LS, usually a struct u_thread * */
119         }
120
121 One issue with async syscalls is that there can be too many outstanding IOs
122 (normally sync calls provide feedback / don't allow you to over-request).
123 Eventually, processes can exhaust kernel memory (the kthreads, specifically).
124 We need a way to limit the kthreads per proc, etc.  Shouldn't be a big deal.
125
126 Normally, we talk about changing the flag in a syscall to SC_DONE.  Async
127 syscalls can be SC_PROGRESS (new stuff happened on it), which can trigger a
128 notification event.  Some calls, like AIO or bulk accept, exist for a while
129 and slowly get filled in / completed.  In the future, we'll also want a way to
130 abort the in-progress syscalls (possibly any syscall!).
131
132 2.2 Uthreads Blocking on Syscalls
133 ----------------------------------------------
134 Many threading libraries will want some notion of a synchronous, blocking
135 thread.  These threads use regular I/O calls, which are async under the hood,
136 but don't want to bother with call backs or other details of async I/O.  In
137 this section, I'll talk a bit about how this works, esp regarding
138 uthreads/pthreads.
139
140 'Blocking' refers to user threads, and has nothing to do with an actual
141 process blocking/waiting on some kernel event.  The kernel does not know
142 anything about what goes on here.  While a bit confusing, this allows
143 applications to do whatever they want on top of an async interface, and is a
144 consequence of decoupling cores from user-threads from kthreads.
145
146 2.2.1 Basics of Uthread Blocking
147 ---------------
148 When a thread calls a glibc function that makes a system call, if the syscall
149 is not yet complete when the kernel returns to userspace, glibc will check for
150 the existence of a second level scheduler and attempt to use it to yield its
151 uthread.  If there is no 2LS, the code just spins for now.  Eventually, it
152 will try to suspend/yield the process for a while (til the call is done), aka,
153 block in the kernel.
154
155 If there is a 2LS, the current thread will yield, and call out to the 2LS's
156 blockon_sysc() method, which needs a way to stop the thread and be able to
157 restart it when the syscall completes.  Specifically, the pthread 2LS registers
158 the syscall to respond to an event (described in detail elsewhere in this doc).
159 When the event comes in, meaning the syscall is complete, the thread is put on
160 the runnable list.
161
162 Details:
163 - A pointer to the struct pthread is stored in the syscall's void*.  When the
164   syscall is done, we normally get a message from the kernel, and the payload
165   tells us the syscall is done, which tells us which thread to unblock. 
166 - The pthread code also always asks for an IPI and event message for every
167   syscall that completes.  This is far from ideal.  Still, the basics are the
168   same for any threading library.  Once you know a thread is done, you need to
169   do something about it.
170 - The pthread code does syscall blocking and event notification on a per-core
171   basis.  Using the default (VCPD) ev_mbox for this is a bad idea (which we did
172   at some point).
173 - There's a race between the 2LS trying to sign up for events and the kernel
174   finishing the event.  We handle this in uthread code, so use the helper to
175   register_evq(), which does the the right thing (atomics, careful ordering
176   with writes, etc).
177
178 2.2.1 Recovering from Event Overflow
179 ---------------
180 Event overflow recovery is unnecessary, since syscall ev_qs use UCQs now.  this
181 section is kept around for some useful tidbits, such as details about
182 deregistering ev_qs for a syscall:
183
184 ---------------------------
185 The pthread code expects to receive an event somehow to unblock a thread
186 once its syscall is done.  One limitation to our messaging systems is that you
187 can't send an infinite amount of event messages.  (By messages, I mean a chunk
188 of memory with a payload, in this case consisting of a struct syscall *).
189 Event delivery degrades to a bit in the case of the message queue being full
190 (more details on that later).
191
192 The pthread code (and any similar 2LS) needs to handle waking up syscalls when
193 the event message was lost and all we know is that some syscall that was meant
194 to have a message sent to a particular event queue (per-core in the case of
195 pthread stuff (actually the VCPD for now)).  The basic idea is to poll all
196 outstanding system calls and unblock whoever is done.
197
198 The key problem is due to a race: for a given syscall we don't know if we're
199 going to get a message for a syscall or not.  There could be a completion
200 message in the queue for the syscall while we are going through the list of
201 blocked threads.  If we assume we already got the message (or it was lost in
202 the overflow), but didn't really, then if we finish as SC and free its memory
203 (free or return up the stack), we could later get a message for it, and all
204 sorts of things would go wrong (like trying to unblock a pointer that is
205 gibberish).
206
207 Here's what we do:
208 1) Set a "handling overflow" flag so we don't recurse.
209 2) Turn off event delivery for all syscalls on our list
210 3) Handle any event messages.  This is how we make a distinction between
211 finished syscalls that had a message sent and those that didn't.  We're doing
212 the message-sent ones here.
213 4) For any left on the list, check to see if they are done.  We actually do
214 this by attempting to turn on event delivery for them.  Turning on event
215 delivery can fail if the call is already done.  So if it fails, they are done
216 and we unblock them (similar to how we block the threads in the first place).
217 If it doesn't fail, they are now ready to receive messages.  This can be
218 tweaked a bit.
219 5) Unset the overflow-handling flag.
220
221 One thing to be careful of is that when we turn off event delivery, you need to
222 be sure the kernel isn't in the process of sending an event.  This is why we
223 have the SC_K_LOCK syscall flag.  Uthread code will not consider deregistration
224 complete while that flag is set, since the kernel is still mucking with the
225 syscall (and sending an event).  Once the flag is clear, the event has been
226 delivered (the ev_msg is in the ev_mbox), and our assumptions remain true.
227
228 There are a couple implications of this style.  If you have a shared event
229 queue (with other event sources), those events can get mixed in with the
230 recovery.  Don't leave the vcore context due to other events.  This'll
231 probably need work.  The other thing is that completed syscalls can get
232 handled in a different order than they were signaled.  Shouldn't be a big
233 deal.
234
235 Note on the overflow handling flag and unsetting it.  There should not be any
236 races with this.  The flag prevented us from handling overflows on the event
237 queue.  Other than when we checked for events that had been succesfully sent,
238 we didn't try to handle events.  We can unset the flag, and at that point we
239 can start handling missed events.  If there was an overflow after we last
240 checked the list, but before we cleared the overflow-handling flag, we'll
241 still catch it since we haven't tried handling events in between checking the
242 list and clearing the flag.  That flag doesn't even matter until we want to
243 handle_events, so we aren't missing anything.  the next handle_events() will
244 deal with everything from scratch.
245
246 For blocking threads that block concurrently with the overflow handling: in
247 the pthread case, this can't happen since everything is per-vcore.  If you do
248 have process-wide thread blocking/syscall management, we can add new ones, but
249 they must have event delivery turned off when they are added to the list.  And
250 you'll need to lock the list, etc.  This should work in part due to new
251 syscalls being added to the end of the list, and the overflow-handler
252 proceeding linearly through the list.
253
254 Also note that we shouldn't handle the event for unblocking a syscall on a
255 different core than the one it was submitted to.  This could result in
256 concurrent modifications to the original core's TAILQ (bad).  This restriction
257 is dependent on how a 2LS does its thread handling/blocking.
258
259 Eventually, we'll want a way to detect and handle excessive overflow, since
260 it's probably quite expensive.  Perhaps turn it off and periodically poll the
261 syscalls for completion (but don't bother turning on the ev_q).
262 ---------------------------
263
264 3. Event Delivery / Notification
265 ====================
266 3.1 Basics
267 ----------------------------------------------
268 The mbox (mailbox) is where the actual messages go.
269
270         struct ev_mbox {
271                 bcq of notif_events     /* bounded buffer, multi-consumer/producer */
272                 msg_bitmap
273         }
274         struct ev_queue {                       /* aka, event_q, ev_q, etc. */
275                 struct ev_mbox * 
276                 void handler(struct event_q *)
277                 vcore_to_be_told
278                 flags                                   /* IPI_WANTED, RR, 2L-handle-it, etc */
279         }
280         struct ev_queue_big {
281                 struct ev_mbox *                /* pointing to the internal storage */
282                 vcore_to_be_told
283                 flags                                   /* IPI_WANTED, RR, 2L-handle-it, etc */
284                 struct ev_mbox { }              /* never access this directly */
285         }
286
287 The purpose of the big one is to simply embed some storage.  Still, only
288 access the mbox via the pointer.  The big one can be casted (and stored as)
289 the regular, so long as you know to dealloc a big one (free() knows, custom
290 styles or slabs would need some help).
291
292 The ev_mbox says where to put the actual message, and the flags handle things
293 such as whether or not an IPI is wanted.
294
295 Using pointers for the ev_q like this allows multiple event queues to use the
296 same mbox.  For example, we could use the vcpd queue for both kernel-generated
297 events as well as async syscall responses.  The notification table is actually
298 a bunch of ev_qs, many of which could be pointing to the same vcore/vcpd-mbox,
299 albeit with different flags.
300
301 3.2 Kernel Notification Using Event Queues
302 ----------------------------------------------
303 The notif_tbl/notif_methods (kernel-generated 'one-sided' events) is just an
304 array of struct ev_queue*s.  Handling a notification is like any other time
305 when we want to send an event.  Follow a pointer, send a message, etc.  As
306 with all ev_qs, ev_mbox* points to where you want the message for the event,
307 which usually is the vcpd's mbox.  If the ev_q pointer is 0, then we know the
308 process doesn't want the event (equivalent to the older 'NOTIF_WANTED' flag).
309 Theoretically, we can send kernel notifs to user threads.  While it isn't
310 clear that anyone will ever want this, it is possible (barring other issues),
311 since they are just events.
312
313 Also note the flag EVENT_VCORE_APPRO.  Processes should set this for certain
314 types of events where they want the kernel to send the event/IPI to the
315 'appropriate' vcore.  For example, when sending a message about a preemption
316 coming in, it makes sense for the kernel to send it to the vcore that is going
317 to get preempted, but the application could choose to ignore the notification.
318 When this flag is set, the kernel will also use the vcore's ev_mbox, ignoring
319 the process's choice.  We can change this later, but it doesn't really make
320 sense for a process to pick an mbox and also say VCORE_APPRO.
321
322 There are also interfaces in the kernel to put a message in an ev_mbox
323 regardless of the process's wishes (post_vcore_event()), and can send an IPI
324 at any time (proc_notify()).
325
326 3.3 IPIs, Indirection Events, and Fallback
327 ----------------------------------------------
328 An ev_q can ask for an IPI, an indirection event, and a fallback in case a vcore
329 is offline.  Or any combination of these.  Note that these have little to do
330 with the actual message being sent.  The actual message is dropped in the
331 ev_mbox pointed to by the ev_q.
332
333 The main use for all of this is for syscalls.  If you want to receive an event
334 when a syscall completes or has a change in status, simply allocate an event_q,
335 and point the syscall at it.  syscall: ev_q* -> "vcore for IPI, syscall message
336 in the ev_q mbox", etc.  You can also point it to an existing ev_q.  Pthread
337 code has examples of two ways to do this.  Both have per vcore ev_qs, requesting
338 IPIs, INDIRS, and FALLBACK.  One way is to have an ev_mbox per vcore, and
339 another is to have a global ev_mbox that all ev_qs point to.  As a side note, if
340 you do the latter, you don't need to worry about a vcore's ev_q if it gets
341 preempted: just check the global ev_mbox (which is done by checking your own
342 vcore's syscall ev_q).
343
344 3.3.1: IPIs and INDIRs
345 ---------------
346 An EVENT_IPI simply means we'll send an IPI to the given vcore.  Nothing else.
347 This will usually be paired with an Indirection event (EVENT_INDIR).  An INDIR
348 is a message of type EV_EVENT with an ev_q* payload.  It means "check this
349 ev_q".  Most ev_qs that ask for an IPI will also want an INDIR so that the vcore
350 knows why it was IPIed.  You don't have to do this: for instance, your 2LS might
351 poll its own ev_q, so you won't need the indirection event.
352
353 Additionally, note that IPIs and INDIRs can be spurious.  It's not a big deal to
354 receive and IPI and have nothing to do, or to be told to check an empty ev_q.
355 All of the event handling code can deal with this.  The only thing you shouldn't
356 do is have one vcore handle another's VCPD.  That mbox is meant for
357 vcore-business.  Never use a VCPD for messages you might want to receive if that
358 vcore is offline.
359
360 3.3.2: Fallback
361 ---------------
362 Both IPI and INDIR need an actual vcore.  If that vcore is unavailable and if
363 EVENT_FALLBACK is set, the kernel will pick another vcore and send the messages
364 there.  This allows an ev_q to be set up to handle work when the vcore is
365 online, while allowing the program to handle events when that core yields,
366 without having to reset all of its ev_qs to point to "known" available vcores
367 (and avoiding those races).  Note 'online' is synonymous with 'mapped', when
368 talking about vcores.  A vcore technically isn't always online, only destined to
369 be online, when it is mapped to a pcore (kmsg on the way, etc).  It's easiest to
370 think of it being online for the sake of this discussion.
371
372 One question is whether or not 2LSs need a FALLBACK flag for their ev_qs.  The
373 main use for FALLBACK is so that vcores can yield.  (Note that fallback won't
374 help you *miss* INDIR messages in the event of a preemption; you can always lose
375 that race due to it taking too long to process the messages).  An alternative
376 would be for vcores to pick another vcore and change all of its ev_qs to that
377 vcore.  There are a couple problems with this.  One is that it'll be a pain to
378 get those ev_qs back when the vcore comes back online (if ever).  Another issue
379 is that other vcores will build up a list of ev_qs that they aren't aware of,
380 which will be hard to deal with when *they* yield.  FALLBACK avoids all of those
381 problems.
382
383 An important aspect of FALLBACK is that it works with yielded vcores, not
384 preempted vcores.  It could be that there are no cores that are online, but
385 there should always be at least one core that *will* be online in the future, a
386 core that the process didn't want to lose and will deal with in the future.  If
387 not for this distinction, FALLBACK could fail.  An older idea would be to have
388 fallback send the msg to the desired vcore if there were no others.  This would
389 not work if the vcore yielded and then the entire process was preempted or
390 otherwise not running.  Another way to put this is that we need a field to
391 determine whether a vcore is offline temporarily or permanently.
392
393 This is why we have the VCPD field 'can_rcv_msg'.  It tells the kernel's event
394 delivery code that the vcore will check the messages: it is an acceptable
395 destination for a FALLBACK.  There are two reasons to put this in VCPD:
396 1) Userspace can remotely turn off a vcore's msg reception.  This is necessary
397 for handling preemption of a vcore that was in uthread context, so that we can
398 remotely 'yield' the core without having to sys_change_vcore() (which I discuss
399 below, and is meant to 'unstick' a vcore).
400 2) Yield is simplified.  The kernel no longer races with itself nor has to worry
401 about turning off that flag - userspace can do it when it wants to yield.  (turn
402 off the flag, check messages, then yield).
403
404 Two aspects of the code make this work nicely.  The 'can_rcv_msg' flag greatly
405 simplifies the kernel's job.  There are a lot of weird races we'd have to deal
406 with, such as process state (RUNNING_M), whether a mass preempt is going on, or
407 just one core, or a bunch of cores, mass yields, etc.  A flag that does one
408 thing well helps a lot - esp since preemption is not the same as yielding.  The
409 other useful thing is being able to handle spurious events.  Vcore code can
410 handle extra IPIs and INDIRs to non-VCPD ev_qs.  Any vcore can handle an ev_q
411 that is "non-VCPD business".
412
413 Also, in case this comes up, there's a slight race on changing the mbox* and the
414 vcore number within the event_q.  The message could have gone to the wrong (old)
415 vcore, but not the IPI.  Not a big deal - IPIs can be spurious, and the other
416 vcore will eventually get it.  The real way around this is create a new ev_q and
417 change the pointer (thus atomically changing the entire ev_q's contents), though
418 this can be a bit tricky if you have multiple places pointing to the same ev_q
419 (can't change them all at once).
420
421 3.3.3: Fallback and Preemption
422 ---------------
423 FALLBACK doesn't protect you from preemptions.  A vcore can be preempted and
424 have INDIRs in its VCPD.  Dealing with this is part of the 2LSs job.  The 2LS
425 must check the ev_mboxes/ev_qs of all ev_qs that could send INDIRS to the
426 offline vcore.  There could be INDIRS in the VCPD that are just lying there.
427 The 2LS knows which ev_qs these are (such as for completed syscalls), and for
428 many things, this will be a common ev_q (such as for 'vcore-x-was-preempted').
429
430 A couple things will ameliorate this:
431 1) the 2LS can inspect the VCPD of the target.  If it is empty, then we don't
432 have to worry about any INDIRs, and we're done worrying about their messages
433 (though we still have to worry about them being stuck in vcore context and
434 having a uthread).  Also note you only need to check the UCQ, since INDIRs must
435 be messages, not bits.
436 2) the kernel will initiate FALLBACK if the vcore has a preempt pending, which
437 ought to cut down on this happening frequently.
438
439 It is tempting to just use sys_change_vcore(), which will change the calling
440 vcore to the new one.  This should only be used to "unstick" a vcore.  A vcore
441 is stuck when it was preempted while it had notifications disabled.  This is
442 usually when it is vcore context, but also in any lock holding code for locks
443 shared with vcore context (the userspace equivalent of irqsave locks).  With
444 this syscall, you could change to the offline vcore and process its INDIRs.
445
446 The problem with that plan is the calling core (that is trying to save the
447 other) may have extra messages, and that sys_change_vcore does not return.  We
448 need a way to deal with our other messages.  We're back to the same problem we
449 had before, just with different vcores.  The only thing we really accomplished
450 is that we unstuck the other vcore.  We could tell the restarted vcore (via an
451 event) to switch back to us, but by the time it does that, it may have other
452 events that got lost.  So we're back to polling the ev_qs that it might have
453 received INDIRs about.  Note that we still want to send an event with
454 sys_change_vcore().  We want the new vcore to know the old vcore was put
455 offline: a preemption (albeit one that it chose to do, and one that isn't stuck
456 in vcore context).
457
458 3.4 Application-specific Event Handling
459 ---------------------------------------
460 So what happens when the vcore/2LS isn't handling an event queue, but has been
461 "told" about it?  This "telling" is in the form of an IPI.  The vcore was
462 prodded, but is not supposed to handle the event.  This is actually what
463 happens now in Linux when you send signals for AIO.  It's all about who (which
464 thread, in their world) is being interrupted to process the work in an
465 application specific way.  The app sets the handler, with the option to have a
466 thread spawned (instead of a sighandler), etc.
467
468 This is not exactly the same as the case above where the ev_mbox* pointed to
469 the vcore's default mbox.  That issue was just about avoiding extra messages
470 (and messages in weird orders).  A vcore won't handle an ev_q if the
471 message/contents of the queue aren't meant for the vcore/2LS.  For example, a
472 thread can want to run its own handler, perhaps because it performs its own
473 asynchronous I/O (compared to relying on the 2LS to schedule synchronous
474 blocking u_threads).
475
476 There are a couple ways to handle this.  Ultimately, the application is supposed
477 to handle the event.  If it asked for an IPI, it is because something ought to
478 be done, which really means running a handler.  If the application sets
479 EVENT_THREAD in the ev_q's flags, the 2LS ought to spawn a thread to run the
480 ev_q's handler.  If EVENT_JUSTHANDLEIT is set, the vcore will execute the
481 handler itself.  Careful with this, since the only memory it touches must be
482 pinned, the function must not block (this is only true for the handlers called
483 directly out of vcore context), and it should return quickly.
484
485 Note that in either case, vcore-written code (library code) does not look at
486 the contents of the notification event.  Also note the handler takes the whole
487 event_queue, and not a specific message.  It is more flexible, can handle
488 multiple specific events, and doesn't require the vcore code to dequeue the
489 event and either pass by value or allocate more memory.
490
491 These ev_q handlers are different than ev_handlers.  The former handles an
492 event_queue.  The latter is the 2LS's way to handle specific types of messages.
493 If an app wants to process specific messages, have them sent to an ev_q under
494 its control; don't mess with ev_handlers unless you're the 2LS (or example
495 code).
496
497 Continuing the analogy between vcores getting IPIs and the OS getting HW
498 interrupts, what goes on in vcore context is like what goes on in interrupt
499 context, and the threaded handler is like running a threaded interrupt handler
500 (in Linux).  In the ROS world, it is like having the interrupt handler kick
501 off a kernel message to defer the work out of interrupt context.
502
503 If neither of the application-specific handling flags are set, the vcore will
504 respond to the IPI by attempting to handle the event on its own (lookup table
505 based on the type of event (like "syscall complete")).  If you didn't want the
506 vcore to handle it, then you shouldn't have asked for an IPI.  Those flags are
507 the means by which the vcore can distinguish between its event_qs and the
508 applications.  It does not make sense otherwise to send the vcore an IPI and
509 an event_q, but not tell give the code the info it needs to handle it.
510
511 In the future, we might have the ability to block a u_thread on an event_q, so
512 we'll have other EV_ flags to express this, and probably a void*.  This may
513 end up being redudant, since u_threads will be able to block on syscalls (and
514 not necessarily IPIs sent to vcores).
515
516 As a side note, a vcore can turn off the IPI wanted flag at any time.  For
517 instance, when it spawns a thread to handle an ev_q, the vcore can turn off
518 IPI wanted on that event_q, and the thread handler can turn it back on when it
519 is done processing and wants to be re-IPId.  The reason for this is to avoid
520 taking future IPIs (once we leave vcore context, IPIs are enabled) to let us
521 know about an event for which a handler is already running.
522
523 3.5 Overflowed/Missed Messages in the VCPD 
524 ---------------------------------------
525 This too is no longer necessary.  It's useful in that it shows what we don't
526 have to put up with.  Missing messages requires potentially painful
527 infrastructure to handle it:
528
529 -----------------------------
530 All event_q's requesting IPIs ought to register with the 2LS.  This is for
531 recovering in case the vcpd's mbox overflowed, and the vcore knows it missed a
532 NE_EVENT type message.  At that point, it would have to check all of its
533 IPI-based queues.  To do so, it could check to see if the mbox has any
534 messages, though in all likelihood, we'll just act as if there was a message
535 on each of the queues (all such handlers should be able to handle spurious
536 IPIs anyways).  This is analagous to how the OS's block drivers don't solely
537 rely on receiving an interrupt (they deal with it via timeouts).  Any user
538 code requiring an IPI must do this.  Any code that runs better due to getting
539 the IPI ought to do this.
540
541 We could imagine having a thread spawned to handle an ev_q, and the vcore
542 never has to touch the ev_q (which might make it easier for memory
543 allocation).  This isn't a great idea, but I'll still explain it.  In the
544 notif_ev message sent to the vcore, it has the event_q*.  We could also send a
545 flag with the same info as in the event_q's flags, and also send the handler.
546 The problem with this is that it isn't resilient to failure.  If there was a
547 message overflow, it would have the check the event_q (which was registered
548 before) anyway, and could potentially page fault there.  Also the kernel would
549 have faulted on it (and read it in) back when it tried to read those values.
550 It's somewhat moot, since we're going to have an allocator that pins event_qs.
551 -----------------------------
552
553 3.6 Round-Robin or Other IPI-delivery styles
554 ---------------------------------------
555 In the same way that the IOAPIC can deliver interrupts to a group of cores,
556 round-robinning between them, so can we imagine processes wanting to
557 distribute the IPI/active notification of events across its vcores.  This is
558 only meaningful is the NOTIF_IPI_WANTED flag is set.
559
560 Eventually we'll support this, via a flag in the event_q.  When
561 NE_ROUND_ROBIN, or whatever, is set a couple things will happen.  First, the
562 vcore field will be used in a "delivery-specific" manner.  In the case of RR,
563 it will probably be the most recent destination.  Perhaps it will be a bitmask
564 of vcores available to receive.  More important is the event_mbox*.  If it is
565 set, then the event message will be sent there.  Whichever vcore gets selected
566 will receive an IPI, and its vcpd mbox will get a NE_EVENT message.  If the
567 event_mbox* is 0, then the actual message will get delivered to the vcore's
568 vcpd mbox (the default location).
569
570 3.7 Event_q-less Notifications
571 ---------------------------------------
572 Some events needs to be delivered directly to the vcore, regardless of any
573 event_qs.  This happens currently when we bypass the notification table (e.g.,
574 sys_self_notify(), preemptions, etc).  These notifs will just use the vcore's
575 default mbox.  In essence, the ev_q is being generated/sent with the call.
576 The implied/fake ev_q points to the vcpd's mbox, with the given vcore set, and
577 with IPI_WANTED set.  It is tempting to make those functions take a
578 dynamically generated ev_q, though more likely we'll just use the lower level
579 functions in the kernel, much like the Round Robin set will need to do.  No
580 need to force things to fit just for the sake of using a 'solution'.  We want
581 tools to make solutions, not packaged solutions.
582
583 4. Misc Things That Aren't Sorted Completely:
584 ====================
585 4.1 What about short handlers?
586 ---------------------------------------
587 Once we sort the other issues, we can ask for them via a flag in the event_q,
588 and run the handler in the event_q struct.
589
590 4.2 What about blocking on a syscall?
591 ---------------------------------------
592 The current plan is to set a flag, and let the kernel go from there.  The
593 kernel knows which process it is, since that info is saved in the kthread that
594 blocked.  One issue is that the process could muck with that flag and then go
595 to sleep forever.  To deal with that, maybe we'd have a long running timer to
596 reap those.  Arguably, it's like having a process while(1).  You can screw
597 yourself, etc.  Killing the process would still work.