[PATCH] for_each_possible_cpu: documentaion
[linux-3.10.git] / Documentation / RCU / whatisRCU.txt
1 What is RCU?
2
3 RCU is a synchronization mechanism that was added to the Linux kernel
4 during the 2.5 development effort that is optimized for read-mostly
5 situations.  Although RCU is actually quite simple once you understand it,
6 getting there can sometimes be a challenge.  Part of the problem is that
7 most of the past descriptions of RCU have been written with the mistaken
8 assumption that there is "one true way" to describe RCU.  Instead,
9 the experience has been that different people must take different paths
10 to arrive at an understanding of RCU.  This document provides several
11 different paths, as follows:
12
13 1.      RCU OVERVIEW
14 2.      WHAT IS RCU'S CORE API?
15 3.      WHAT ARE SOME EXAMPLE USES OF CORE RCU API?
16 4.      WHAT IF MY UPDATING THREAD CANNOT BLOCK?
17 5.      WHAT ARE SOME SIMPLE IMPLEMENTATIONS OF RCU?
18 6.      ANALOGY WITH READER-WRITER LOCKING
19 7.      FULL LIST OF RCU APIs
20 8.      ANSWERS TO QUICK QUIZZES
21
22 People who prefer starting with a conceptual overview should focus on
23 Section 1, though most readers will profit by reading this section at
24 some point.  People who prefer to start with an API that they can then
25 experiment with should focus on Section 2.  People who prefer to start
26 with example uses should focus on Sections 3 and 4.  People who need to
27 understand the RCU implementation should focus on Section 5, then dive
28 into the kernel source code.  People who reason best by analogy should
29 focus on Section 6.  Section 7 serves as an index to the docbook API
30 documentation, and Section 8 is the traditional answer key.
31
32 So, start with the section that makes the most sense to you and your
33 preferred method of learning.  If you need to know everything about
34 everything, feel free to read the whole thing -- but if you are really
35 that type of person, you have perused the source code and will therefore
36 never need this document anyway.  ;-)
37
38
39 1.  RCU OVERVIEW
40
41 The basic idea behind RCU is to split updates into "removal" and
42 "reclamation" phases.  The removal phase removes references to data items
43 within a data structure (possibly by replacing them with references to
44 new versions of these data items), and can run concurrently with readers.
45 The reason that it is safe to run the removal phase concurrently with
46 readers is the semantics of modern CPUs guarantee that readers will see
47 either the old or the new version of the data structure rather than a
48 partially updated reference.  The reclamation phase does the work of reclaiming
49 (e.g., freeing) the data items removed from the data structure during the
50 removal phase.  Because reclaiming data items can disrupt any readers
51 concurrently referencing those data items, the reclamation phase must
52 not start until readers no longer hold references to those data items.
53
54 Splitting the update into removal and reclamation phases permits the
55 updater to perform the removal phase immediately, and to defer the
56 reclamation phase until all readers active during the removal phase have
57 completed, either by blocking until they finish or by registering a
58 callback that is invoked after they finish.  Only readers that are active
59 during the removal phase need be considered, because any reader starting
60 after the removal phase will be unable to gain a reference to the removed
61 data items, and therefore cannot be disrupted by the reclamation phase.
62
63 So the typical RCU update sequence goes something like the following:
64
65 a.      Remove pointers to a data structure, so that subsequent
66         readers cannot gain a reference to it.
67
68 b.      Wait for all previous readers to complete their RCU read-side
69         critical sections.
70
71 c.      At this point, there cannot be any readers who hold references
72         to the data structure, so it now may safely be reclaimed
73         (e.g., kfree()d).
74
75 Step (b) above is the key idea underlying RCU's deferred destruction.
76 The ability to wait until all readers are done allows RCU readers to
77 use much lighter-weight synchronization, in some cases, absolutely no
78 synchronization at all.  In contrast, in more conventional lock-based
79 schemes, readers must use heavy-weight synchronization in order to
80 prevent an updater from deleting the data structure out from under them.
81 This is because lock-based updaters typically update data items in place,
82 and must therefore exclude readers.  In contrast, RCU-based updaters
83 typically take advantage of the fact that writes to single aligned
84 pointers are atomic on modern CPUs, allowing atomic insertion, removal,
85 and replacement of data items in a linked structure without disrupting
86 readers.  Concurrent RCU readers can then continue accessing the old
87 versions, and can dispense with the atomic operations, memory barriers,
88 and communications cache misses that are so expensive on present-day
89 SMP computer systems, even in absence of lock contention.
90
91 In the three-step procedure shown above, the updater is performing both
92 the removal and the reclamation step, but it is often helpful for an
93 entirely different thread to do the reclamation, as is in fact the case
94 in the Linux kernel's directory-entry cache (dcache).  Even if the same
95 thread performs both the update step (step (a) above) and the reclamation
96 step (step (c) above), it is often helpful to think of them separately.
97 For example, RCU readers and updaters need not communicate at all,
98 but RCU provides implicit low-overhead communication between readers
99 and reclaimers, namely, in step (b) above.
100
101 So how the heck can a reclaimer tell when a reader is done, given
102 that readers are not doing any sort of synchronization operations???
103 Read on to learn about how RCU's API makes this easy.
104
105
106 2.  WHAT IS RCU'S CORE API?
107
108 The core RCU API is quite small:
109
110 a.      rcu_read_lock()
111 b.      rcu_read_unlock()
112 c.      synchronize_rcu() / call_rcu()
113 d.      rcu_assign_pointer()
114 e.      rcu_dereference()
115
116 There are many other members of the RCU API, but the rest can be
117 expressed in terms of these five, though most implementations instead
118 express synchronize_rcu() in terms of the call_rcu() callback API.
119
120 The five core RCU APIs are described below, the other 18 will be enumerated
121 later.  See the kernel docbook documentation for more info, or look directly
122 at the function header comments.
123
124 rcu_read_lock()
125
126         void rcu_read_lock(void);
127
128         Used by a reader to inform the reclaimer that the reader is
129         entering an RCU read-side critical section.  It is illegal
130         to block while in an RCU read-side critical section, though
131         kernels built with CONFIG_PREEMPT_RCU can preempt RCU read-side
132         critical sections.  Any RCU-protected data structure accessed
133         during an RCU read-side critical section is guaranteed to remain
134         unreclaimed for the full duration of that critical section.
135         Reference counts may be used in conjunction with RCU to maintain
136         longer-term references to data structures.
137
138 rcu_read_unlock()
139
140         void rcu_read_unlock(void);
141
142         Used by a reader to inform the reclaimer that the reader is
143         exiting an RCU read-side critical section.  Note that RCU
144         read-side critical sections may be nested and/or overlapping.
145
146 synchronize_rcu()
147
148         void synchronize_rcu(void);
149
150         Marks the end of updater code and the beginning of reclaimer
151         code.  It does this by blocking until all pre-existing RCU
152         read-side critical sections on all CPUs have completed.
153         Note that synchronize_rcu() will -not- necessarily wait for
154         any subsequent RCU read-side critical sections to complete.
155         For example, consider the following sequence of events:
156
157                  CPU 0                  CPU 1                 CPU 2
158              ----------------- ------------------------- ---------------
159          1.  rcu_read_lock()
160          2.                    enters synchronize_rcu()
161          3.                                               rcu_read_lock()
162          4.  rcu_read_unlock()
163          5.                     exits synchronize_rcu()
164          6.                                              rcu_read_unlock()
165
166         To reiterate, synchronize_rcu() waits only for ongoing RCU
167         read-side critical sections to complete, not necessarily for
168         any that begin after synchronize_rcu() is invoked.
169
170         Of course, synchronize_rcu() does not necessarily return
171         -immediately- after the last pre-existing RCU read-side critical
172         section completes.  For one thing, there might well be scheduling
173         delays.  For another thing, many RCU implementations process
174         requests in batches in order to improve efficiencies, which can
175         further delay synchronize_rcu().
176
177         Since synchronize_rcu() is the API that must figure out when
178         readers are done, its implementation is key to RCU.  For RCU
179         to be useful in all but the most read-intensive situations,
180         synchronize_rcu()'s overhead must also be quite small.
181
182         The call_rcu() API is a callback form of synchronize_rcu(),
183         and is described in more detail in a later section.  Instead of
184         blocking, it registers a function and argument which are invoked
185         after all ongoing RCU read-side critical sections have completed.
186         This callback variant is particularly useful in situations where
187         it is illegal to block.
188
189 rcu_assign_pointer()
190
191         typeof(p) rcu_assign_pointer(p, typeof(p) v);
192
193         Yes, rcu_assign_pointer() -is- implemented as a macro, though it
194         would be cool to be able to declare a function in this manner.
195         (Compiler experts will no doubt disagree.)
196
197         The updater uses this function to assign a new value to an
198         RCU-protected pointer, in order to safely communicate the change
199         in value from the updater to the reader.  This function returns
200         the new value, and also executes any memory-barrier instructions
201         required for a given CPU architecture.
202
203         Perhaps just as important, it serves to document (1) which
204         pointers are protected by RCU and (2) the point at which a
205         given structure becomes accessible to other CPUs.  That said,
206         rcu_assign_pointer() is most frequently used indirectly, via
207         the _rcu list-manipulation primitives such as list_add_rcu().
208
209 rcu_dereference()
210
211         typeof(p) rcu_dereference(p);
212
213         Like rcu_assign_pointer(), rcu_dereference() must be implemented
214         as a macro.
215
216         The reader uses rcu_dereference() to fetch an RCU-protected
217         pointer, which returns a value that may then be safely
218         dereferenced.  Note that rcu_deference() does not actually
219         dereference the pointer, instead, it protects the pointer for
220         later dereferencing.  It also executes any needed memory-barrier
221         instructions for a given CPU architecture.  Currently, only Alpha
222         needs memory barriers within rcu_dereference() -- on other CPUs,
223         it compiles to nothing, not even a compiler directive.
224
225         Common coding practice uses rcu_dereference() to copy an
226         RCU-protected pointer to a local variable, then dereferences
227         this local variable, for example as follows:
228
229                 p = rcu_dereference(head.next);
230                 return p->data;
231
232         However, in this case, one could just as easily combine these
233         into one statement:
234
235                 return rcu_dereference(head.next)->data;
236
237         If you are going to be fetching multiple fields from the
238         RCU-protected structure, using the local variable is of
239         course preferred.  Repeated rcu_dereference() calls look
240         ugly and incur unnecessary overhead on Alpha CPUs.
241
242         Note that the value returned by rcu_dereference() is valid
243         only within the enclosing RCU read-side critical section.
244         For example, the following is -not- legal:
245
246                 rcu_read_lock();
247                 p = rcu_dereference(head.next);
248                 rcu_read_unlock();
249                 x = p->address;
250                 rcu_read_lock();
251                 y = p->data;
252                 rcu_read_unlock();
253
254         Holding a reference from one RCU read-side critical section
255         to another is just as illegal as holding a reference from
256         one lock-based critical section to another!  Similarly,
257         using a reference outside of the critical section in which
258         it was acquired is just as illegal as doing so with normal
259         locking.
260
261         As with rcu_assign_pointer(), an important function of
262         rcu_dereference() is to document which pointers are protected by
263         RCU, in particular, flagging a pointer that is subject to changing
264         at any time, including immediately after the rcu_dereference().
265         And, again like rcu_assign_pointer(), rcu_dereference() is
266         typically used indirectly, via the _rcu list-manipulation
267         primitives, such as list_for_each_entry_rcu().
268
269 The following diagram shows how each API communicates among the
270 reader, updater, and reclaimer.
271
272
273             rcu_assign_pointer()
274                                     +--------+
275             +---------------------->| reader |---------+
276             |                       +--------+         |
277             |                           |              |
278             |                           |              | Protect:
279             |                           |              | rcu_read_lock()
280             |                           |              | rcu_read_unlock()
281             |        rcu_dereference()  |              |
282        +---------+                      |              |
283        | updater |<---------------------+              |
284        +---------+                                     V
285             |                                    +-----------+
286             +----------------------------------->| reclaimer |
287                                                  +-----------+
288               Defer:
289               synchronize_rcu() & call_rcu()
290
291
292 The RCU infrastructure observes the time sequence of rcu_read_lock(),
293 rcu_read_unlock(), synchronize_rcu(), and call_rcu() invocations in
294 order to determine when (1) synchronize_rcu() invocations may return
295 to their callers and (2) call_rcu() callbacks may be invoked.  Efficient
296 implementations of the RCU infrastructure make heavy use of batching in
297 order to amortize their overhead over many uses of the corresponding APIs.
298
299 There are no fewer than three RCU mechanisms in the Linux kernel; the
300 diagram above shows the first one, which is by far the most commonly used.
301 The rcu_dereference() and rcu_assign_pointer() primitives are used for
302 all three mechanisms, but different defer and protect primitives are
303 used as follows:
304
305         Defer                   Protect
306
307 a.      synchronize_rcu()       rcu_read_lock() / rcu_read_unlock()
308         call_rcu()
309
310 b.      call_rcu_bh()           rcu_read_lock_bh() / rcu_read_unlock_bh()
311
312 c.      synchronize_sched()     preempt_disable() / preempt_enable()
313                                 local_irq_save() / local_irq_restore()
314                                 hardirq enter / hardirq exit
315                                 NMI enter / NMI exit
316
317 These three mechanisms are used as follows:
318
319 a.      RCU applied to normal data structures.
320
321 b.      RCU applied to networking data structures that may be subjected
322         to remote denial-of-service attacks.
323
324 c.      RCU applied to scheduler and interrupt/NMI-handler tasks.
325
326 Again, most uses will be of (a).  The (b) and (c) cases are important
327 for specialized uses, but are relatively uncommon.
328
329
330 3.  WHAT ARE SOME EXAMPLE USES OF CORE RCU API?
331
332 This section shows a simple use of the core RCU API to protect a
333 global pointer to a dynamically allocated structure.  More-typical
334 uses of RCU may be found in listRCU.txt, arrayRCU.txt, and NMI-RCU.txt.
335
336         struct foo {
337                 int a;
338                 char b;
339                 long c;
340         };
341         DEFINE_SPINLOCK(foo_mutex);
342
343         struct foo *gbl_foo;
344
345         /*
346          * Create a new struct foo that is the same as the one currently
347          * pointed to by gbl_foo, except that field "a" is replaced
348          * with "new_a".  Points gbl_foo to the new structure, and
349          * frees up the old structure after a grace period.
350          *
351          * Uses rcu_assign_pointer() to ensure that concurrent readers
352          * see the initialized version of the new structure.
353          *
354          * Uses synchronize_rcu() to ensure that any readers that might
355          * have references to the old structure complete before freeing
356          * the old structure.
357          */
358         void foo_update_a(int new_a)
359         {
360                 struct foo *new_fp;
361                 struct foo *old_fp;
362
363                 new_fp = kmalloc(sizeof(*new_fp), GFP_KERNEL);
364                 spin_lock(&foo_mutex);
365                 old_fp = gbl_foo;
366                 *new_fp = *old_fp;
367                 new_fp->a = new_a;
368                 rcu_assign_pointer(gbl_foo, new_fp);
369                 spin_unlock(&foo_mutex);
370                 synchronize_rcu();
371                 kfree(old_fp);
372         }
373
374         /*
375          * Return the value of field "a" of the current gbl_foo
376          * structure.  Use rcu_read_lock() and rcu_read_unlock()
377          * to ensure that the structure does not get deleted out
378          * from under us, and use rcu_dereference() to ensure that
379          * we see the initialized version of the structure (important
380          * for DEC Alpha and for people reading the code).
381          */
382         int foo_get_a(void)
383         {
384                 int retval;
385
386                 rcu_read_lock();
387                 retval = rcu_dereference(gbl_foo)->a;
388                 rcu_read_unlock();
389                 return retval;
390         }
391
392 So, to sum up:
393
394 o       Use rcu_read_lock() and rcu_read_unlock() to guard RCU
395         read-side critical sections.
396
397 o       Within an RCU read-side critical section, use rcu_dereference()
398         to dereference RCU-protected pointers.
399
400 o       Use some solid scheme (such as locks or semaphores) to
401         keep concurrent updates from interfering with each other.
402
403 o       Use rcu_assign_pointer() to update an RCU-protected pointer.
404         This primitive protects concurrent readers from the updater,
405         -not- concurrent updates from each other!  You therefore still
406         need to use locking (or something similar) to keep concurrent
407         rcu_assign_pointer() primitives from interfering with each other.
408
409 o       Use synchronize_rcu() -after- removing a data element from an
410         RCU-protected data structure, but -before- reclaiming/freeing
411         the data element, in order to wait for the completion of all
412         RCU read-side critical sections that might be referencing that
413         data item.
414
415 See checklist.txt for additional rules to follow when using RCU.
416 And again, more-typical uses of RCU may be found in listRCU.txt,
417 arrayRCU.txt, and NMI-RCU.txt.
418
419
420 4.  WHAT IF MY UPDATING THREAD CANNOT BLOCK?
421
422 In the example above, foo_update_a() blocks until a grace period elapses.
423 This is quite simple, but in some cases one cannot afford to wait so
424 long -- there might be other high-priority work to be done.
425
426 In such cases, one uses call_rcu() rather than synchronize_rcu().
427 The call_rcu() API is as follows:
428
429         void call_rcu(struct rcu_head * head,
430                       void (*func)(struct rcu_head *head));
431
432 This function invokes func(head) after a grace period has elapsed.
433 This invocation might happen from either softirq or process context,
434 so the function is not permitted to block.  The foo struct needs to
435 have an rcu_head structure added, perhaps as follows:
436
437         struct foo {
438                 int a;
439                 char b;
440                 long c;
441                 struct rcu_head rcu;
442         };
443
444 The foo_update_a() function might then be written as follows:
445
446         /*
447          * Create a new struct foo that is the same as the one currently
448          * pointed to by gbl_foo, except that field "a" is replaced
449          * with "new_a".  Points gbl_foo to the new structure, and
450          * frees up the old structure after a grace period.
451          *
452          * Uses rcu_assign_pointer() to ensure that concurrent readers
453          * see the initialized version of the new structure.
454          *
455          * Uses call_rcu() to ensure that any readers that might have
456          * references to the old structure complete before freeing the
457          * old structure.
458          */
459         void foo_update_a(int new_a)
460         {
461                 struct foo *new_fp;
462                 struct foo *old_fp;
463
464                 new_fp = kmalloc(sizeof(*new_fp), GFP_KERNEL);
465                 spin_lock(&foo_mutex);
466                 old_fp = gbl_foo;
467                 *new_fp = *old_fp;
468                 new_fp->a = new_a;
469                 rcu_assign_pointer(gbl_foo, new_fp);
470                 spin_unlock(&foo_mutex);
471                 call_rcu(&old_fp->rcu, foo_reclaim);
472         }
473
474 The foo_reclaim() function might appear as follows:
475
476         void foo_reclaim(struct rcu_head *rp)
477         {
478                 struct foo *fp = container_of(rp, struct foo, rcu);
479
480                 kfree(fp);
481         }
482
483 The container_of() primitive is a macro that, given a pointer into a
484 struct, the type of the struct, and the pointed-to field within the
485 struct, returns a pointer to the beginning of the struct.
486
487 The use of call_rcu() permits the caller of foo_update_a() to
488 immediately regain control, without needing to worry further about the
489 old version of the newly updated element.  It also clearly shows the
490 RCU distinction between updater, namely foo_update_a(), and reclaimer,
491 namely foo_reclaim().
492
493 The summary of advice is the same as for the previous section, except
494 that we are now using call_rcu() rather than synchronize_rcu():
495
496 o       Use call_rcu() -after- removing a data element from an
497         RCU-protected data structure in order to register a callback
498         function that will be invoked after the completion of all RCU
499         read-side critical sections that might be referencing that
500         data item.
501
502 Again, see checklist.txt for additional rules governing the use of RCU.
503
504
505 5.  WHAT ARE SOME SIMPLE IMPLEMENTATIONS OF RCU?
506
507 One of the nice things about RCU is that it has extremely simple "toy"
508 implementations that are a good first step towards understanding the
509 production-quality implementations in the Linux kernel.  This section
510 presents two such "toy" implementations of RCU, one that is implemented
511 in terms of familiar locking primitives, and another that more closely
512 resembles "classic" RCU.  Both are way too simple for real-world use,
513 lacking both functionality and performance.  However, they are useful
514 in getting a feel for how RCU works.  See kernel/rcupdate.c for a
515 production-quality implementation, and see:
516
517         http://www.rdrop.com/users/paulmck/RCU
518
519 for papers describing the Linux kernel RCU implementation.  The OLS'01
520 and OLS'02 papers are a good introduction, and the dissertation provides
521 more details on the current implementation as of early 2004.
522
523
524 5A.  "TOY" IMPLEMENTATION #1: LOCKING
525
526 This section presents a "toy" RCU implementation that is based on
527 familiar locking primitives.  Its overhead makes it a non-starter for
528 real-life use, as does its lack of scalability.  It is also unsuitable
529 for realtime use, since it allows scheduling latency to "bleed" from
530 one read-side critical section to another.
531
532 However, it is probably the easiest implementation to relate to, so is
533 a good starting point.
534
535 It is extremely simple:
536
537         static DEFINE_RWLOCK(rcu_gp_mutex);
538
539         void rcu_read_lock(void)
540         {
541                 read_lock(&rcu_gp_mutex);
542         }
543
544         void rcu_read_unlock(void)
545         {
546                 read_unlock(&rcu_gp_mutex);
547         }
548
549         void synchronize_rcu(void)
550         {
551                 write_lock(&rcu_gp_mutex);
552                 write_unlock(&rcu_gp_mutex);
553         }
554
555 [You can ignore rcu_assign_pointer() and rcu_dereference() without
556 missing much.  But here they are anyway.  And whatever you do, don't
557 forget about them when submitting patches making use of RCU!]
558
559         #define rcu_assign_pointer(p, v)        ({ \
560                                                         smp_wmb(); \
561                                                         (p) = (v); \
562                                                 })
563
564         #define rcu_dereference(p)     ({ \
565                                         typeof(p) _________p1 = p; \
566                                         smp_read_barrier_depends(); \
567                                         (_________p1); \
568                                         })
569
570
571 The rcu_read_lock() and rcu_read_unlock() primitive read-acquire
572 and release a global reader-writer lock.  The synchronize_rcu()
573 primitive write-acquires this same lock, then immediately releases
574 it.  This means that once synchronize_rcu() exits, all RCU read-side
575 critical sections that were in progress before synchonize_rcu() was
576 called are guaranteed to have completed -- there is no way that
577 synchronize_rcu() would have been able to write-acquire the lock
578 otherwise.
579
580 It is possible to nest rcu_read_lock(), since reader-writer locks may
581 be recursively acquired.  Note also that rcu_read_lock() is immune
582 from deadlock (an important property of RCU).  The reason for this is
583 that the only thing that can block rcu_read_lock() is a synchronize_rcu().
584 But synchronize_rcu() does not acquire any locks while holding rcu_gp_mutex,
585 so there can be no deadlock cycle.
586
587 Quick Quiz #1:  Why is this argument naive?  How could a deadlock
588                 occur when using this algorithm in a real-world Linux
589                 kernel?  How could this deadlock be avoided?
590
591
592 5B.  "TOY" EXAMPLE #2: CLASSIC RCU
593
594 This section presents a "toy" RCU implementation that is based on
595 "classic RCU".  It is also short on performance (but only for updates) and
596 on features such as hotplug CPU and the ability to run in CONFIG_PREEMPT
597 kernels.  The definitions of rcu_dereference() and rcu_assign_pointer()
598 are the same as those shown in the preceding section, so they are omitted.
599
600         void rcu_read_lock(void) { }
601
602         void rcu_read_unlock(void) { }
603
604         void synchronize_rcu(void)
605         {
606                 int cpu;
607
608                 for_each_possible_cpu(cpu)
609                         run_on(cpu);
610         }
611
612 Note that rcu_read_lock() and rcu_read_unlock() do absolutely nothing.
613 This is the great strength of classic RCU in a non-preemptive kernel:
614 read-side overhead is precisely zero, at least on non-Alpha CPUs.
615 And there is absolutely no way that rcu_read_lock() can possibly
616 participate in a deadlock cycle!
617
618 The implementation of synchronize_rcu() simply schedules itself on each
619 CPU in turn.  The run_on() primitive can be implemented straightforwardly
620 in terms of the sched_setaffinity() primitive.  Of course, a somewhat less
621 "toy" implementation would restore the affinity upon completion rather
622 than just leaving all tasks running on the last CPU, but when I said
623 "toy", I meant -toy-!
624
625 So how the heck is this supposed to work???
626
627 Remember that it is illegal to block while in an RCU read-side critical
628 section.  Therefore, if a given CPU executes a context switch, we know
629 that it must have completed all preceding RCU read-side critical sections.
630 Once -all- CPUs have executed a context switch, then -all- preceding
631 RCU read-side critical sections will have completed.
632
633 So, suppose that we remove a data item from its structure and then invoke
634 synchronize_rcu().  Once synchronize_rcu() returns, we are guaranteed
635 that there are no RCU read-side critical sections holding a reference
636 to that data item, so we can safely reclaim it.
637
638 Quick Quiz #2:  Give an example where Classic RCU's read-side
639                 overhead is -negative-.
640
641 Quick Quiz #3:  If it is illegal to block in an RCU read-side
642                 critical section, what the heck do you do in
643                 PREEMPT_RT, where normal spinlocks can block???
644
645
646 6.  ANALOGY WITH READER-WRITER LOCKING
647
648 Although RCU can be used in many different ways, a very common use of
649 RCU is analogous to reader-writer locking.  The following unified
650 diff shows how closely related RCU and reader-writer locking can be.
651
652         @@ -13,15 +14,15 @@
653                 struct list_head *lp;
654                 struct el *p;
655
656         -       read_lock();
657         -       list_for_each_entry(p, head, lp) {
658         +       rcu_read_lock();
659         +       list_for_each_entry_rcu(p, head, lp) {
660                         if (p->key == key) {
661                                 *result = p->data;
662         -                       read_unlock();
663         +                       rcu_read_unlock();
664                                 return 1;
665                         }
666                 }
667         -       read_unlock();
668         +       rcu_read_unlock();
669                 return 0;
670          }
671
672         @@ -29,15 +30,16 @@
673          {
674                 struct el *p;
675
676         -       write_lock(&listmutex);
677         +       spin_lock(&listmutex);
678                 list_for_each_entry(p, head, lp) {
679                         if (p->key == key) {
680                                 list_del(&p->list);
681         -                       write_unlock(&listmutex);
682         +                       spin_unlock(&listmutex);
683         +                       synchronize_rcu();
684                                 kfree(p);
685                                 return 1;
686                         }
687                 }
688         -       write_unlock(&listmutex);
689         +       spin_unlock(&listmutex);
690                 return 0;
691          }
692
693 Or, for those who prefer a side-by-side listing:
694
695  1 struct el {                          1 struct el {
696  2   struct list_head list;             2   struct list_head list;
697  3   long key;                          3   long key;
698  4   spinlock_t mutex;                  4   spinlock_t mutex;
699  5   int data;                          5   int data;
700  6   /* Other data fields */            6   /* Other data fields */
701  7 };                                   7 };
702  8 spinlock_t listmutex;                8 spinlock_t listmutex;
703  9 struct el head;                      9 struct el head;
704
705  1 int search(long key, int *result)    1 int search(long key, int *result)
706  2 {                                    2 {
707  3   struct list_head *lp;              3   struct list_head *lp;
708  4   struct el *p;                      4   struct el *p;
709  5                                      5
710  6   read_lock();                       6   rcu_read_lock();
711  7   list_for_each_entry(p, head, lp) { 7   list_for_each_entry_rcu(p, head, lp) {
712  8     if (p->key == key) {             8     if (p->key == key) {
713  9       *result = p->data;             9       *result = p->data;
714 10       read_unlock();                10       rcu_read_unlock();
715 11       return 1;                     11       return 1;
716 12     }                               12     }
717 13   }                                 13   }
718 14   read_unlock();                    14   rcu_read_unlock();
719 15   return 0;                         15   return 0;
720 16 }                                   16 }
721
722  1 int delete(long key)                 1 int delete(long key)
723  2 {                                    2 {
724  3   struct el *p;                      3   struct el *p;
725  4                                      4
726  5   write_lock(&listmutex);            5   spin_lock(&listmutex);
727  6   list_for_each_entry(p, head, lp) { 6   list_for_each_entry(p, head, lp) {
728  7     if (p->key == key) {             7     if (p->key == key) {
729  8       list_del(&p->list);            8       list_del(&p->list);
730  9       write_unlock(&listmutex);      9       spin_unlock(&listmutex);
731                                        10       synchronize_rcu();
732 10       kfree(p);                     11       kfree(p);
733 11       return 1;                     12       return 1;
734 12     }                               13     }
735 13   }                                 14   }
736 14   write_unlock(&listmutex);         15   spin_unlock(&listmutex);
737 15   return 0;                         16   return 0;
738 16 }                                   17 }
739
740 Either way, the differences are quite small.  Read-side locking moves
741 to rcu_read_lock() and rcu_read_unlock, update-side locking moves from
742 from a reader-writer lock to a simple spinlock, and a synchronize_rcu()
743 precedes the kfree().
744
745 However, there is one potential catch: the read-side and update-side
746 critical sections can now run concurrently.  In many cases, this will
747 not be a problem, but it is necessary to check carefully regardless.
748 For example, if multiple independent list updates must be seen as
749 a single atomic update, converting to RCU will require special care.
750
751 Also, the presence of synchronize_rcu() means that the RCU version of
752 delete() can now block.  If this is a problem, there is a callback-based
753 mechanism that never blocks, namely call_rcu(), that can be used in
754 place of synchronize_rcu().
755
756
757 7.  FULL LIST OF RCU APIs
758
759 The RCU APIs are documented in docbook-format header comments in the
760 Linux-kernel source code, but it helps to have a full list of the
761 APIs, since there does not appear to be a way to categorize them
762 in docbook.  Here is the list, by category.
763
764 Markers for RCU read-side critical sections:
765
766         rcu_read_lock
767         rcu_read_unlock
768         rcu_read_lock_bh
769         rcu_read_unlock_bh
770
771 RCU pointer/list traversal:
772
773         rcu_dereference
774         list_for_each_rcu               (to be deprecated in favor of
775                                          list_for_each_entry_rcu)
776         list_for_each_entry_rcu
777         list_for_each_continue_rcu      (to be deprecated in favor of new
778                                          list_for_each_entry_continue_rcu)
779         hlist_for_each_entry_rcu
780
781 RCU pointer update:
782
783         rcu_assign_pointer
784         list_add_rcu
785         list_add_tail_rcu
786         list_del_rcu
787         list_replace_rcu
788         hlist_del_rcu
789         hlist_add_head_rcu
790
791 RCU grace period:
792
793         synchronize_kernel (deprecated)
794         synchronize_net
795         synchronize_sched
796         synchronize_rcu
797         call_rcu
798         call_rcu_bh
799
800 See the comment headers in the source code (or the docbook generated
801 from them) for more information.
802
803
804 8.  ANSWERS TO QUICK QUIZZES
805
806 Quick Quiz #1:  Why is this argument naive?  How could a deadlock
807                 occur when using this algorithm in a real-world Linux
808                 kernel?  [Referring to the lock-based "toy" RCU
809                 algorithm.]
810
811 Answer:         Consider the following sequence of events:
812
813                 1.      CPU 0 acquires some unrelated lock, call it
814                         "problematic_lock", disabling irq via
815                         spin_lock_irqsave().
816
817                 2.      CPU 1 enters synchronize_rcu(), write-acquiring
818                         rcu_gp_mutex.
819
820                 3.      CPU 0 enters rcu_read_lock(), but must wait
821                         because CPU 1 holds rcu_gp_mutex.
822
823                 4.      CPU 1 is interrupted, and the irq handler
824                         attempts to acquire problematic_lock.
825
826                 The system is now deadlocked.
827
828                 One way to avoid this deadlock is to use an approach like
829                 that of CONFIG_PREEMPT_RT, where all normal spinlocks
830                 become blocking locks, and all irq handlers execute in
831                 the context of special tasks.  In this case, in step 4
832                 above, the irq handler would block, allowing CPU 1 to
833                 release rcu_gp_mutex, avoiding the deadlock.
834
835                 Even in the absence of deadlock, this RCU implementation
836                 allows latency to "bleed" from readers to other
837                 readers through synchronize_rcu().  To see this,
838                 consider task A in an RCU read-side critical section
839                 (thus read-holding rcu_gp_mutex), task B blocked
840                 attempting to write-acquire rcu_gp_mutex, and
841                 task C blocked in rcu_read_lock() attempting to
842                 read_acquire rcu_gp_mutex.  Task A's RCU read-side
843                 latency is holding up task C, albeit indirectly via
844                 task B.
845
846                 Realtime RCU implementations therefore use a counter-based
847                 approach where tasks in RCU read-side critical sections
848                 cannot be blocked by tasks executing synchronize_rcu().
849
850 Quick Quiz #2:  Give an example where Classic RCU's read-side
851                 overhead is -negative-.
852
853 Answer:         Imagine a single-CPU system with a non-CONFIG_PREEMPT
854                 kernel where a routing table is used by process-context
855                 code, but can be updated by irq-context code (for example,
856                 by an "ICMP REDIRECT" packet).  The usual way of handling
857                 this would be to have the process-context code disable
858                 interrupts while searching the routing table.  Use of
859                 RCU allows such interrupt-disabling to be dispensed with.
860                 Thus, without RCU, you pay the cost of disabling interrupts,
861                 and with RCU you don't.
862
863                 One can argue that the overhead of RCU in this
864                 case is negative with respect to the single-CPU
865                 interrupt-disabling approach.  Others might argue that
866                 the overhead of RCU is merely zero, and that replacing
867                 the positive overhead of the interrupt-disabling scheme
868                 with the zero-overhead RCU scheme does not constitute
869                 negative overhead.
870
871                 In real life, of course, things are more complex.  But
872                 even the theoretical possibility of negative overhead for
873                 a synchronization primitive is a bit unexpected.  ;-)
874
875 Quick Quiz #3:  If it is illegal to block in an RCU read-side
876                 critical section, what the heck do you do in
877                 PREEMPT_RT, where normal spinlocks can block???
878
879 Answer:         Just as PREEMPT_RT permits preemption of spinlock
880                 critical sections, it permits preemption of RCU
881                 read-side critical sections.  It also permits
882                 spinlocks blocking while in RCU read-side critical
883                 sections.
884
885                 Why the apparent inconsistency?  Because it is it
886                 possible to use priority boosting to keep the RCU
887                 grace periods short if need be (for example, if running
888                 short of memory).  In contrast, if blocking waiting
889                 for (say) network reception, there is no way to know
890                 what should be boosted.  Especially given that the
891                 process we need to boost might well be a human being
892                 who just went out for a pizza or something.  And although
893                 a computer-operated cattle prod might arouse serious
894                 interest, it might also provoke serious objections.
895                 Besides, how does the computer know what pizza parlor
896                 the human being went to???
897
898
899 ACKNOWLEDGEMENTS
900
901 My thanks to the people who helped make this human-readable, including
902 Jon Walpole, Josh Triplett, Serge Hallyn, Suzanne Wood, and Alan Stern.
903
904
905 For more information, see http://www.rdrop.com/users/paulmck/RCU.