linux.git/Documentation/RCU/Design, branch v4.11

doc: Quick-Quiz answers are now inline

2017-01-15T05:30:33+00:00

Now that quick-quiz answers are inline, there is no separate section
containing those answers.  This commit therefore removes the dangling
reference from the RCU data-structures design documentation.

Signed-off-by: Paul E. McKenney 
Reviewed-by: Josh Triplett

doc: Fix RCU requirements typos

2017-01-15T05:29:10+00:00

Signed-off-by: Tetsuo Handa 
Signed-off-by: Paul E. McKenney 
Reviewed-by: Josh Triplett

rcu: Design documentation for expedited grace periods

2017-01-15T05:28:58+00:00

This commit adds design documentation for expedited grace periods.
This documentation is in HTML rather than the new documentation
format because (1) I have prototype documentation already in HTML,
and (2) Attempting to learn the new documentation format while
creating the design documentation seems likely to result in neither
happening in a timely fashion.

Once the design documentation is complete, we can start a conversion effort.

Signed-off-by: Paul E. McKenney 
Reviewed-by: Josh Triplett

documentation: Present updated RCU guarantee

2016-11-14T18:39:36+00:00

Recent memory-model work deduces the relationships of RCU read-side
critical sections and grace periods based on the relationships of
accesses within a critical section and accesses preceding and following
the grace period.  This commit therefore adds this viewpoint.

Signed-off-by: Paul E. McKenney

documentation: Record reason for rcu_head two-byte alignment

2016-08-22T16:25:33+00:00

There is an assertion in __call_rcu() that checks only the bottom
bit of the rcu_head pointer, rather than the bottom two (as might be
expected for 32-bit systems) or the bottom three (as might be expected
for 64-bit systems).  This choice might be a bit surprising in these days
of ubiquitous 32-bit and 64-bit systems.  This commit therefore records
the reason for this odd alignment check, namely that m68k guarantees
only two-byte alignment despite being a 32-bit architectures.

Signed-off-by: Paul E. McKenney

documentation: Add RCU_NONIDLE() restrictions to requirements

2016-06-14T23:00:59+00:00

Signed-off-by: Paul E. McKenney

documentation: Add documentation for RCU's major data structures

2016-04-19T21:48:12+00:00

This commit adds documentation for RCU's major data structures,
including rcu_state, rcu_node, rcu_data, rcu_dynticks, and rcu_head.

Signed-off-by: Paul E. McKenney

documentation: Emphasize the call_rcu() is illegal from idle

2016-03-31T20:33:23+00:00

Although call_rcu()'s fastpath works just fine on an idle CPU,
some branches of the slowpath invoke the scheduler, which uses
RCU.  Therefore, this commit emphasizes the fact that call_rcu()
must not be invoked from an idle CPU.

Signed-off-by: Paul E. McKenney

documentation: Sharpen up the no-readers quick quiz

2016-03-31T20:33:23+00:00

Signed-off-by: Paul E. McKenney

documentation: Get rid of duplicate .htmlx file

2016-03-31T20:33:22+00:00

This commit uses colors to obscure the quick-quiz answers, thus getting
rid of the .htmlx file.  Use your mouse to select the answer in order
to see the text.  Alternatively, use your favorite scripting language
to remove all occurences of "" from the file.

Reported-by: Linus Torvalds 
Signed-off-by: Paul E. McKenney