diff options
author | Paul E. McKenney <paulmck@linux.vnet.ibm.com> | 2014-03-31 16:36:33 -0400 |
---|---|---|
committer | Paul E. McKenney <paulmck@linux.vnet.ibm.com> | 2014-04-29 11:38:53 -0400 |
commit | d07e6d080d92ea72870c8d800ee2db82a61daac2 (patch) | |
tree | 1707ce812bd38636b12992afede9084e3f790472 /Documentation/RCU | |
parent | b4c5bf353452c49edd860a67845627c9a8f32638 (diff) |
documentation: Update API documentation
This commit updates the list of RCU API members in whatisRCU.txt.
Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Reviewed-by: Josh Triplett <josh@joshtriplett.org>
Diffstat (limited to 'Documentation/RCU')
-rw-r--r-- | Documentation/RCU/whatisRCU.txt | 55 |
1 files changed, 44 insertions, 11 deletions
diff --git a/Documentation/RCU/whatisRCU.txt b/Documentation/RCU/whatisRCU.txt index 0f0fb7c432c2..49b8551a3b68 100644 --- a/Documentation/RCU/whatisRCU.txt +++ b/Documentation/RCU/whatisRCU.txt | |||
@@ -326,11 +326,11 @@ used as follows: | |||
326 | a. synchronize_rcu() rcu_read_lock() / rcu_read_unlock() | 326 | a. synchronize_rcu() rcu_read_lock() / rcu_read_unlock() |
327 | call_rcu() rcu_dereference() | 327 | call_rcu() rcu_dereference() |
328 | 328 | ||
329 | b. call_rcu_bh() rcu_read_lock_bh() / rcu_read_unlock_bh() | 329 | b. synchronize_rcu_bh() rcu_read_lock_bh() / rcu_read_unlock_bh() |
330 | rcu_dereference_bh() | 330 | call_rcu_bh() rcu_dereference_bh() |
331 | 331 | ||
332 | c. synchronize_sched() rcu_read_lock_sched() / rcu_read_unlock_sched() | 332 | c. synchronize_sched() rcu_read_lock_sched() / rcu_read_unlock_sched() |
333 | preempt_disable() / preempt_enable() | 333 | call_rcu_sched() preempt_disable() / preempt_enable() |
334 | local_irq_save() / local_irq_restore() | 334 | local_irq_save() / local_irq_restore() |
335 | hardirq enter / hardirq exit | 335 | hardirq enter / hardirq exit |
336 | NMI enter / NMI exit | 336 | NMI enter / NMI exit |
@@ -794,10 +794,22 @@ in docbook. Here is the list, by category. | |||
794 | 794 | ||
795 | RCU list traversal: | 795 | RCU list traversal: |
796 | 796 | ||
797 | list_entry_rcu | ||
798 | list_first_entry_rcu | ||
799 | list_next_rcu | ||
797 | list_for_each_entry_rcu | 800 | list_for_each_entry_rcu |
801 | list_for_each_entry_continue_rcu | ||
802 | hlist_first_rcu | ||
803 | hlist_next_rcu | ||
804 | hlist_pprev_rcu | ||
798 | hlist_for_each_entry_rcu | 805 | hlist_for_each_entry_rcu |
806 | hlist_for_each_entry_rcu_bh | ||
807 | hlist_for_each_entry_continue_rcu | ||
808 | hlist_for_each_entry_continue_rcu_bh | ||
809 | hlist_nulls_first_rcu | ||
799 | hlist_nulls_for_each_entry_rcu | 810 | hlist_nulls_for_each_entry_rcu |
800 | list_for_each_entry_continue_rcu | 811 | hlist_bl_first_rcu |
812 | hlist_bl_for_each_entry_rcu | ||
801 | 813 | ||
802 | RCU pointer/list update: | 814 | RCU pointer/list update: |
803 | 815 | ||
@@ -806,28 +818,38 @@ RCU pointer/list update: | |||
806 | list_add_tail_rcu | 818 | list_add_tail_rcu |
807 | list_del_rcu | 819 | list_del_rcu |
808 | list_replace_rcu | 820 | list_replace_rcu |
809 | hlist_del_rcu | ||
810 | hlist_add_after_rcu | 821 | hlist_add_after_rcu |
811 | hlist_add_before_rcu | 822 | hlist_add_before_rcu |
812 | hlist_add_head_rcu | 823 | hlist_add_head_rcu |
824 | hlist_del_rcu | ||
825 | hlist_del_init_rcu | ||
813 | hlist_replace_rcu | 826 | hlist_replace_rcu |
814 | list_splice_init_rcu() | 827 | list_splice_init_rcu() |
828 | hlist_nulls_del_init_rcu | ||
829 | hlist_nulls_del_rcu | ||
830 | hlist_nulls_add_head_rcu | ||
831 | hlist_bl_add_head_rcu | ||
832 | hlist_bl_del_init_rcu | ||
833 | hlist_bl_del_rcu | ||
834 | hlist_bl_set_first_rcu | ||
815 | 835 | ||
816 | RCU: Critical sections Grace period Barrier | 836 | RCU: Critical sections Grace period Barrier |
817 | 837 | ||
818 | rcu_read_lock synchronize_net rcu_barrier | 838 | rcu_read_lock synchronize_net rcu_barrier |
819 | rcu_read_unlock synchronize_rcu | 839 | rcu_read_unlock synchronize_rcu |
820 | rcu_dereference synchronize_rcu_expedited | 840 | rcu_dereference synchronize_rcu_expedited |
821 | call_rcu | 841 | rcu_read_lock_held call_rcu |
822 | kfree_rcu | 842 | rcu_dereference_check kfree_rcu |
823 | 843 | rcu_dereference_protected | |
824 | 844 | ||
825 | bh: Critical sections Grace period Barrier | 845 | bh: Critical sections Grace period Barrier |
826 | 846 | ||
827 | rcu_read_lock_bh call_rcu_bh rcu_barrier_bh | 847 | rcu_read_lock_bh call_rcu_bh rcu_barrier_bh |
828 | rcu_read_unlock_bh synchronize_rcu_bh | 848 | rcu_read_unlock_bh synchronize_rcu_bh |
829 | rcu_dereference_bh synchronize_rcu_bh_expedited | 849 | rcu_dereference_bh synchronize_rcu_bh_expedited |
830 | 850 | rcu_dereference_bh_check | |
851 | rcu_dereference_bh_protected | ||
852 | rcu_read_lock_bh_held | ||
831 | 853 | ||
832 | sched: Critical sections Grace period Barrier | 854 | sched: Critical sections Grace period Barrier |
833 | 855 | ||
@@ -835,7 +857,12 @@ sched: Critical sections Grace period Barrier | |||
835 | rcu_read_unlock_sched call_rcu_sched | 857 | rcu_read_unlock_sched call_rcu_sched |
836 | [preempt_disable] synchronize_sched_expedited | 858 | [preempt_disable] synchronize_sched_expedited |
837 | [and friends] | 859 | [and friends] |
860 | rcu_read_lock_sched_notrace | ||
861 | rcu_read_unlock_sched_notrace | ||
838 | rcu_dereference_sched | 862 | rcu_dereference_sched |
863 | rcu_dereference_sched_check | ||
864 | rcu_dereference_sched_protected | ||
865 | rcu_read_lock_sched_held | ||
839 | 866 | ||
840 | 867 | ||
841 | SRCU: Critical sections Grace period Barrier | 868 | SRCU: Critical sections Grace period Barrier |
@@ -843,6 +870,8 @@ SRCU: Critical sections Grace period Barrier | |||
843 | srcu_read_lock synchronize_srcu srcu_barrier | 870 | srcu_read_lock synchronize_srcu srcu_barrier |
844 | srcu_read_unlock call_srcu | 871 | srcu_read_unlock call_srcu |
845 | srcu_dereference synchronize_srcu_expedited | 872 | srcu_dereference synchronize_srcu_expedited |
873 | srcu_dereference_check | ||
874 | srcu_read_lock_held | ||
846 | 875 | ||
847 | SRCU: Initialization/cleanup | 876 | SRCU: Initialization/cleanup |
848 | init_srcu_struct | 877 | init_srcu_struct |
@@ -850,9 +879,13 @@ SRCU: Initialization/cleanup | |||
850 | 879 | ||
851 | All: lockdep-checked RCU-protected pointer access | 880 | All: lockdep-checked RCU-protected pointer access |
852 | 881 | ||
853 | rcu_dereference_check | 882 | rcu_access_index |
854 | rcu_dereference_protected | ||
855 | rcu_access_pointer | 883 | rcu_access_pointer |
884 | rcu_dereference_index_check | ||
885 | rcu_dereference_raw | ||
886 | rcu_lockdep_assert | ||
887 | rcu_sleep_check | ||
888 | RCU_NONIDLE | ||
856 | 889 | ||
857 | See the comment headers in the source code (or the docbook generated | 890 | See the comment headers in the source code (or the docbook generated |
858 | from them) for more information. | 891 | from them) for more information. |