Handles syscall-event overflow in pthreads
[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 puts the
158 thread on a "syscall pending" list and registers the syscall to respond to an
159 event (described in detail elsewhere in this doc).  When the event comes in,
160 meaning the syscall is complete, the thread is put on the runnable list.
161
162 Details:
163 - A pointer to the struct pthread is stored in the syscall's void*.  You need
164   to be on the pending list before registering for the event (due to how we
165   handle event overflow recovery).  When the syscall is done, we normally get
166   a message from the kernel, and the payload tells us the syscall is done,
167   which tells us which thread to unblock. 
168 - The pthread code also always asks for an IPI and event message for every
169   syscall that completes.  This is far from ideal.  Still, the basics are the
170   same for any threading library.  Once you know a thread is done, you need to
171   do something about it.
172 - The pthread code does syscall blocking/ pending lists and event notification
173   on a per-core basis.
174 - There's a race between the 2LS trying to sign up for events and the kernel
175   finishing the event.  We handle this in uthread code, so use the helper to
176   register_evq(), which does the the right thing (atomics, careful ordering
177   with writes, etc).
178 - If as syscall has an ev_q*, it is on the pending list.  It can be on the
179   pending list without an ev_q.
180
181 2.2.1 Recovering from Event Overflow
182 ---------------
183 The pthread code expects to receive an event somehow to unblock a thread
184 once its syscall is done.  One limitation to our messaging systems is that you
185 can't send an infinite amount of event messages.  (By messages, I mean a chunk
186 of memory with a payload, in this case consisting of a struct syscall *).
187 Event delivery degrades to a bit in the case of the message queue being full
188 (more details on that later).
189
190 The pthread code (and any similar 2LS) needs to handle waking up syscalls when
191 the event message was lost and all we know is that some syscall that was meant
192 to have a message sent to a particular event queue (per-core in the case of
193 pthread stuff (actually the VCPD for now)).  The basic idea is to poll all
194 outstanding system calls and unblock whoever is done.
195
196 The key problem is due to a race: for a given syscall we don't know if we're
197 going to get a message for a syscall or not.  There could be a completion
198 message in the queue for the syscall while we are going through the list of
199 blocked threads.  If we assume we already got the message (or it was lost in
200 the overflow), but didn't really, then if we finish as SC and free its memory
201 (free or return up the stack), we could later get a message for it, and all
202 sorts of things would go wrong (like trying to unblock a pointer that is
203 gibberish).
204
205 Here's what we do:
206 1) Set a "handling overflow" flag so we don't recurse.
207 2) Turn off event delivery for all syscalls on our list
208 3) Handle any event messages.  This is how we make a distinction between
209 finished syscalls that had a message sent and those that didn't.  We're doing
210 the message-sent ones here.
211 4) For any left on the list, check to see if they are done.  We actually do
212 this by attempting to turn on event delivery for them.  Turning on event
213 delivery can fail if the call is already done.  So if it fails, they are done
214 and we unblock them (similar to how we block the threads in the first place).
215 If it doesn't fail, they are now ready to receive messages.  This can be
216 tweaked a bit.
217 5) Unset the overflow-handling flag.
218
219 There are a couple implications of this style.  If you have a shared event
220 queue (with other event sources), those events can get mixed in with the
221 recovery.  Don't leave the vcore context due to other events.  This'll
222 probably need work.  The other thing is that completed syscalls can get
223 handled in a different order than they were signaled.  Shouldn't be a big
224 deal.
225
226 Note on the overflow handling flag and unsetting it.  There should not be any
227 races with this.  The flag prevented us from handling overflows on the event
228 queue.  Other than when we checked for events that had been succesfully sent,
229 we didn't try to handle events.  We can unset the flag, and at that point we
230 can start handling missed events.  If there was an overflow after we last
231 checked the list, but before we cleared the overflow-handling flag, we'll
232 still catch it since we haven't tried handling events in between checking the
233 list and clearing the flag.  That flag doesn't even matter until we want to
234 handle_events, so we aren't missing anything.  the next handle_events() will
235 deal with everything from scratch.
236
237 For blocking threads that block concurrently with the overflow handling: in
238 the pthread case, this can't happen since everything is per-vcore.  If you do
239 have process-wide thread blocking/syscall management, we can add new ones, but
240 they must have event delivery turned off when they are added to the list.  And
241 you'll need to lock the list, etc.  This should work in part due to new
242 syscalls being added to the end of the list, and the overflow-handler
243 proceeding linearly through the list.
244
245 Also note that we shouldn't handle the event for unblocking a syscall on a
246 different core than the one it was submitted to.  This could result in
247 concurrent modifications to the original core's TAILQ (bad).  This restriction
248 is dependent on how a 2LS does its thread handling/blocking.
249
250 Eventually, we'll want a way to detect and handle excessive overflow, since
251 it's probably quite expensive.  Perhaps turn it off and periodically poll the
252 syscalls for completion (but don't bother turning on the ev_q).
253
254 3. Event Delivery / Notification
255 ====================
256 3.1 Basics
257 ----------------------------------------------
258 The mbox (mailbox) is where the actual messages go, or the overflow of a
259 message is tracked.
260
261         struct ev_mbox {
262                 bcq of notif_events     /* bounded buffer, multi-consumer/producer */
263                 overflow_count
264                 msg_bitmap
265         }
266         struct ev_queue {                       /* aka, event_q, ev_q, etc. */
267                 struct ev_mbox * 
268                 void handler(struct event_q *)
269                 vcore_to_be_told
270                 flags                                   /* IPI_WANTED, RR, 2L-handle-it, etc */
271         }
272         struct ev_queue_big {
273                 struct ev_mbox *                /* pointing to the internal storage */
274                 vcore_to_be_told
275                 flags                                   /* IPI_WANTED, RR, 2L-handle-it, etc */
276                 struct ev_mbox { }              /* never access this directly */
277         }
278
279 The purpose of the big one is to simply embed some storage.  Still, only
280 access the mbox via the pointer.  The big one can be casted (and stored as)
281 the regular, so long as you know to dealloc a big one (free() knows, custom
282 styles or slabs would need some help).
283
284 The ev_mbox says where to put the actual message, and the flags handle things
285 such as whether or not an IPI is wanted.
286
287 Using pointers for the ev_q like this allows multiple event queues to use the
288 same mbox.  For example, we could use the vcpd queue for both kernel-generated
289 events as well as async syscall responses.  The notification table is actually
290 a bunch of ev_qs, many of which could be pointing to the same vcore/vcpd-mbox,
291 albeit with different flags.
292
293 3.2 Kernel Notification Using Event Queues
294 ----------------------------------------------
295 The notif_tbl/notif_methods (kernel-generated 'one-sided' events) is just an
296 array of struct ev_queue*s.  Handling a notification is like any other time
297 when we want to send an event.  Follow a pointer, send a message, etc.  As
298 with all ev_qs, ev_mbox* points to where you want the message for the event,
299 which usually is the vcpd's mbox.  If the ev_q pointer is 0, then we know the
300 process doesn't want the event (equivalent to the older 'NOTIF_WANTED' flag).
301 Theoretically, we can send kernel notifs to user threads.  While it isn't
302 clear that anyone will ever want this, it is possible (barring other issues),
303 since they are just events.
304
305 Also note the flag EVENT_VCORE_APPRO.  Processes should set this for certain
306 types of events where they want the kernel to send the event/IPI to the
307 'appropriate' vcore.  For example, when sending a message about a preemption
308 coming in, it makes sense for the kernel to send it to the vcore that is going
309 to get preempted, but the application could choose to ignore the notification.
310 When this flag is set, the kernel will also use the vcore's ev_mbox, ignoring
311 the process's choice.  We can change this later, but it doesn't really make
312 sense for a process to pick an mbox and also say VCORE_APPRO.
313
314 There are also interfaces in the kernel to put a message in an ev_mbox
315 regardless of the process's wishes (post_vcore_event()), and can send an IPI
316 at any time (proc_notify()).
317
318 3.3 IPIs and Indirection Events
319 ----------------------------------------------
320 When an ev_q calls for an IPI, the kernel finds out what vcore the process
321 wants.  The code already sent the message to the ev_q's mbox.  If the vcore's
322 vcpd mbox is the same as the ev_q's mbox (pointer check), then just send the
323 IPI.  If it is different, we need to put a message in the vcpd's mbox telling
324 them "ev_q*", so the vcore knows why it got an IPI.  This level of indirection
325 is only necessary when the ev_q requests an IPI and it is not the vcore using
326 its vcpd mbox.  The vcore needs to know why it received an IPI.  The IPI
327 (active notifcation) is merely a prodding, and the vcore needs a known place
328 to look for why it was woken up.  This is a little different when dealing with
329 non-specific IPIs (like Round-Robin).
330
331 If the vcore gets an indirection message, it will be of type NE_EVENT (or
332 whatever), with an ev_q* as the payload.
333
334 In the event there are issues with this, we can introduce a flag that says we
335 don't need a separate notif_event explaining the IPI: prodding the vcore was
336 enough.  Either way, we can deliver event messages directly to the vcore's
337 mbox / bcq.
338
339 There's a slight race on changing the mbox* and the vcore number within the
340 event_q.  The message could have gone to the wrong (old) vcore, but not the
341 IPI.  Not a big deal - IPIs can be spurious, and the other vcore will
342 eventually get it.  The real way around this is create a new ev_q and change
343 the pointer (thus atomically changing the entire ev_q's contents), though this
344 can be a bit tricky if you have multiple places pointing to the same ev_q
345 (can't change them all at once).
346
347 If you want to receive an event when a syscall completes or has a change in
348 status, simply allocate an event_q, and point the syscall at it.  syscall:
349 ev_q* -> "vcore for IPI, syscall message in the ev_q mbox", etc.  You can also
350 point it to an existing ev_q.
351
352 3.4 Application-specific Event Handling
353 ---------------------------------------
354 So what happens when the vcore/2LS isn't handling an event queue, but has been
355 "told" about it?  This "telling" is in the form of an IPI.  The vcore was
356 prodded, but is not supposed to handle the event.  This is actually what
357 happens now in Linux when you send signals for AIO.  It's all about who (which
358 thread, in their world) is being interrupted to process the work in an
359 application specific way.  The app sets the handler, with the option to have a
360 thread spawned (instead of a sighandler), etc.
361
362 This is not exactly the same as the case above where the ev_mbox* pointed to
363 the vcore's default mbox.  That issue was just about avoiding extra messages
364 (and messages in weird orders).  A vcore won't handle an ev_q if the
365 message/contents of the queue aren't meant for the vcore/2LS.  For example, a
366 thread can want to run its own handler, perhaps because it performs its own
367 asynchronous I/O (compared to relying on the 2LS to schedule synchronous
368 blocking u_threads).
369
370 There are a couple ways to handle this.  Ultimately, the application is supposed
371 to handle the event.  If it asked for an IPI, it is because something ought to
372 be done, which really means running a handler.  If the application sets
373 EVENT_THREAD in the ev_q's flags, the 2LS ought to spawn a thread to run the
374 ev_q's handler.  If EVENT_JUSTHANDLEIT is set, the vcore will execute the
375 handler itself.  Careful with this, since the only memory it touches must be
376 pinned, the function must not block (this is only true for the handlers called
377 directly out of vcore context), and it should return quickly.
378
379 Note that in either case, vcore-written code (library code) does not look at
380 the contents of the notification event.  Also note the handler takes the whole
381 event_queue, and not a specific message.  It is more flexible, can handle
382 multiple specific events, and doesn't require the vcore code to dequeue the
383 event and either pass by value or allocate more memory.
384
385 These ev_q handlers are different than ev_handlers.  The former handles an
386 event_queue.  The latter is the 2LS's way to handle specific types of messages.
387 If an app wants to process specific messages, have them sent to an ev_q under
388 its control; don't mess with ev_handlers unless you're the 2LS (or example
389 code).
390
391 Continuing the analogy between vcores getting IPIs and the OS getting HW
392 interrupts, what goes on in vcore context is like what goes on in interrupt
393 context, and the threaded handler is like running a threaded interrupt handler
394 (in Linux).  In the ROS world, it is like having the interrupt handler kick
395 off a kernel message to defer the work out of interrupt context.
396
397 If neither of the application-specific handling flags are set, the vcore will
398 respond to the IPI by attempting to handle the event on its own (lookup table
399 based on the type of event (like "syscall complete")).  If you didn't want the
400 vcore to handle it, then you shouldn't have asked for an IPI.  Those flags are
401 the means by which the vcore can distinguish between its event_qs and the
402 applications.  It does not make sense otherwise to send the vcore an IPI and
403 an event_q, but not tell give the code the info it needs to handle it.
404
405 In the future, we might have the ability to block a u_thread on an event_q, so
406 we'll have other EV_ flags to express this, and probably a void*.  This may
407 end up being redudant, since u_threads will be able to block on syscalls (and
408 not necessarily IPIs sent to vcores).
409
410 As a side note, a vcore can turn off the IPI wanted flag at any time.  For
411 instance, when it spawns a thread to handle an ev_q, the vcore can turn off
412 IPI wanted on that event_q, and the thread handler can turn it back on when it
413 is done processing and wants to be re-IPId.  The reason for this is to avoid
414 taking future IPIs (once we leave vcore context, IPIs are enabled) to let us
415 know about an event for which a handler is already running.
416
417 3.5 Overflowed/Missed Messages in the VCPD 
418 ---------------------------------------
419 All event_q's requesting IPIs ought to register with the 2LS.  This is for
420 recovering in case the vcpd's mbox overflowed, and the vcore knows it missed a
421 NE_EVENT type message.  At that point, it would have to check all of its
422 IPI-based queues.  To do so, it could check to see if the mbox has any
423 messages, though in all likelihood, we'll just act as if there was a message
424 on each of the queues (all such handlers should be able to handle spurious
425 IPIs anyways).  This is analagous to how the OS's block drivers don't solely
426 rely on receiving an interrupt (they deal with it via timeouts).  Any user
427 code requiring an IPI must do this.  Any code that runs better due to getting
428 the IPI ought to do this.
429
430 We could imagine having a thread spawned to handle an ev_q, and the vcore
431 never has to touch the ev_q (which might make it easier for memory
432 allocation).  This isn't a great idea, but I'll still explain it.  In the
433 notif_ev message sent to the vcore, it has the event_q*.  We could also send a
434 flag with the same info as in the event_q's flags, and also send the handler.
435 The problem with this is that it isn't resilient to failure.  If there was a
436 message overflow, it would have the check the event_q (which was registered
437 before) anyway, and could potentially page fault there.  Also the kernel would
438 have faulted on it (and read it in) back when it tried to read those values.
439 It's somewhat moot, since we're going to have an allocator that pins event_qs.
440
441 3.6 Round-Robin or Other IPI-delivery styles
442 ---------------------------------------
443 In the same way that the IOAPIC can deliver interrupts to a group of cores,
444 round-robinning between them, so can we imagine processes wanting to
445 distribute the IPI/active notification of events across its vcores.  This is
446 only meaningful is the NOTIF_IPI_WANTED flag is set.
447
448 Eventually we'll support this, via a flag in the event_q.  When
449 NE_ROUND_ROBIN, or whatever, is set a couple things will happen.  First, the
450 vcore field will be used in a "delivery-specific" manner.  In the case of RR,
451 it will probably be the most recent destination.  Perhaps it will be a bitmask
452 of vcores available to receive.  More important is the event_mbox*.  If it is
453 set, then the event message will be sent there.  Whichever vcore gets selected
454 will receive an IPI, and its vcpd mbox will get a NE_EVENT message.  If the
455 event_mbox* is 0, then the actual message will get delivered to the vcore's
456 vcpd mbox (the default location).
457
458 3.7 Event_q-less Notifications
459 ---------------------------------------
460 Some events needs to be delivered directly to the vcore, regardless of any
461 event_qs.  This happens currently when we bypass the notification table (e.g.,
462 sys_self_notify(), preemptions, etc).  These notifs will just use the vcore's
463 default mbox.  In essence, the ev_q is being generated/sent with the call.
464 The implied/fake ev_q points to the vcpd's mbox, with the given vcore set, and
465 with IPI_WANTED set.  It is tempting to make those functions take a
466 dynamically generated ev_q, though more likely we'll just use the lower level
467 functions in the kernel, much like the Round Robin set will need to do.  No
468 need to force things to fit just for the sake of using a 'solution'.  We want
469 tools to make solutions, not packaged solutions.
470
471 4. Misc Things That Aren't Sorted Completely:
472 ====================
473 4.1 What about short handlers?
474 ---------------------------------------
475 Once we sort the other issues, we can ask for them via a flag in the event_q,
476 and run the handler in the event_q struct.
477
478 4.2 What about blocking on a syscall?
479 ---------------------------------------
480 The current plan is to set a flag, and let the kernel go from there.  The
481 kernel knows which process it is, since that info is saved in the kthread that
482 blocked.  One issue is that the process could muck with that flag and then go
483 to sleep forever.  To deal with that, maybe we'd have a long running timer to
484 reap those.  Arguably, it's like having a process while(1).  You can screw
485 yourself, etc.  Killing the process would still work.