tree.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634
  1. /*
  2. * Read-Copy Update mechanism for mutual exclusion (tree-based version)
  3. * Internal non-public definitions.
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program; if not, you can access it online at
  17. * http://www.gnu.org/licenses/gpl-2.0.html.
  18. *
  19. * Copyright IBM Corporation, 2008
  20. *
  21. * Author: Ingo Molnar <mingo@elte.hu>
  22. * Paul E. McKenney <paulmck@linux.vnet.ibm.com>
  23. */
  24. #include <linux/cache.h>
  25. #include <linux/spinlock.h>
  26. #include <linux/threads.h>
  27. #include <linux/cpumask.h>
  28. #include <linux/seqlock.h>
  29. /*
  30. * Define shape of hierarchy based on NR_CPUS, CONFIG_RCU_FANOUT, and
  31. * CONFIG_RCU_FANOUT_LEAF.
  32. * In theory, it should be possible to add more levels straightforwardly.
  33. * In practice, this did work well going from three levels to four.
  34. * Of course, your mileage may vary.
  35. */
  36. #ifdef CONFIG_RCU_FANOUT
  37. #define RCU_FANOUT CONFIG_RCU_FANOUT
  38. #else /* #ifdef CONFIG_RCU_FANOUT */
  39. # ifdef CONFIG_64BIT
  40. # define RCU_FANOUT 64
  41. # else
  42. # define RCU_FANOUT 32
  43. # endif
  44. #endif /* #else #ifdef CONFIG_RCU_FANOUT */
  45. #ifdef CONFIG_RCU_FANOUT_LEAF
  46. #define RCU_FANOUT_LEAF CONFIG_RCU_FANOUT_LEAF
  47. #else /* #ifdef CONFIG_RCU_FANOUT_LEAF */
  48. # ifdef CONFIG_64BIT
  49. # define RCU_FANOUT_LEAF 64
  50. # else
  51. # define RCU_FANOUT_LEAF 32
  52. # endif
  53. #endif /* #else #ifdef CONFIG_RCU_FANOUT_LEAF */
  54. #define RCU_FANOUT_1 (RCU_FANOUT_LEAF)
  55. #define RCU_FANOUT_2 (RCU_FANOUT_1 * RCU_FANOUT)
  56. #define RCU_FANOUT_3 (RCU_FANOUT_2 * RCU_FANOUT)
  57. #define RCU_FANOUT_4 (RCU_FANOUT_3 * RCU_FANOUT)
  58. #if NR_CPUS <= RCU_FANOUT_1
  59. # define RCU_NUM_LVLS 1
  60. # define NUM_RCU_LVL_0 1
  61. # define NUM_RCU_NODES NUM_RCU_LVL_0
  62. # define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0 }
  63. # define RCU_NODE_NAME_INIT { "rcu_node_0" }
  64. # define RCU_FQS_NAME_INIT { "rcu_node_fqs_0" }
  65. #elif NR_CPUS <= RCU_FANOUT_2
  66. # define RCU_NUM_LVLS 2
  67. # define NUM_RCU_LVL_0 1
  68. # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
  69. # define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1)
  70. # define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1 }
  71. # define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1" }
  72. # define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1" }
  73. #elif NR_CPUS <= RCU_FANOUT_3
  74. # define RCU_NUM_LVLS 3
  75. # define NUM_RCU_LVL_0 1
  76. # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
  77. # define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
  78. # define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2)
  79. # define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1, NUM_RCU_LVL_2 }
  80. # define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1", "rcu_node_2" }
  81. # define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1", "rcu_node_fqs_2" }
  82. #elif NR_CPUS <= RCU_FANOUT_4
  83. # define RCU_NUM_LVLS 4
  84. # define NUM_RCU_LVL_0 1
  85. # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_3)
  86. # define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
  87. # define NUM_RCU_LVL_3 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
  88. # define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2 + NUM_RCU_LVL_3)
  89. # define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1, NUM_RCU_LVL_2, NUM_RCU_LVL_3 }
  90. # define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1", "rcu_node_2", "rcu_node_3" }
  91. # define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1", "rcu_node_fqs_2", "rcu_node_fqs_3" }
  92. #else
  93. # error "CONFIG_RCU_FANOUT insufficient for NR_CPUS"
  94. #endif /* #if (NR_CPUS) <= RCU_FANOUT_1 */
  95. extern int rcu_num_lvls;
  96. extern int rcu_num_nodes;
  97. /*
  98. * Dynticks per-CPU state.
  99. */
  100. struct rcu_dynticks {
  101. long long dynticks_nesting; /* Track irq/process nesting level. */
  102. /* Process level is worth LLONG_MAX/2. */
  103. int dynticks_nmi_nesting; /* Track NMI nesting level. */
  104. atomic_t dynticks; /* Even value for idle, else odd. */
  105. #ifdef CONFIG_NO_HZ_FULL_SYSIDLE
  106. long long dynticks_idle_nesting;
  107. /* irq/process nesting level from idle. */
  108. atomic_t dynticks_idle; /* Even value for idle, else odd. */
  109. /* "Idle" excludes userspace execution. */
  110. unsigned long dynticks_idle_jiffies;
  111. /* End of last non-NMI non-idle period. */
  112. #endif /* #ifdef CONFIG_NO_HZ_FULL_SYSIDLE */
  113. #ifdef CONFIG_RCU_FAST_NO_HZ
  114. bool all_lazy; /* Are all CPU's CBs lazy? */
  115. unsigned long nonlazy_posted;
  116. /* # times non-lazy CBs posted to CPU. */
  117. unsigned long nonlazy_posted_snap;
  118. /* idle-period nonlazy_posted snapshot. */
  119. unsigned long last_accelerate;
  120. /* Last jiffy CBs were accelerated. */
  121. unsigned long last_advance_all;
  122. /* Last jiffy CBs were all advanced. */
  123. int tick_nohz_enabled_snap; /* Previously seen value from sysfs. */
  124. #endif /* #ifdef CONFIG_RCU_FAST_NO_HZ */
  125. };
  126. /* RCU's kthread states for tracing. */
  127. #define RCU_KTHREAD_STOPPED 0
  128. #define RCU_KTHREAD_RUNNING 1
  129. #define RCU_KTHREAD_WAITING 2
  130. #define RCU_KTHREAD_OFFCPU 3
  131. #define RCU_KTHREAD_YIELDING 4
  132. #define RCU_KTHREAD_MAX 4
  133. /*
  134. * Definition for node within the RCU grace-period-detection hierarchy.
  135. */
  136. struct rcu_node {
  137. raw_spinlock_t lock; /* Root rcu_node's lock protects some */
  138. /* rcu_state fields as well as following. */
  139. unsigned long gpnum; /* Current grace period for this node. */
  140. /* This will either be equal to or one */
  141. /* behind the root rcu_node's gpnum. */
  142. unsigned long completed; /* Last GP completed for this node. */
  143. /* This will either be equal to or one */
  144. /* behind the root rcu_node's gpnum. */
  145. unsigned long qsmask; /* CPUs or groups that need to switch in */
  146. /* order for current grace period to proceed.*/
  147. /* In leaf rcu_node, each bit corresponds to */
  148. /* an rcu_data structure, otherwise, each */
  149. /* bit corresponds to a child rcu_node */
  150. /* structure. */
  151. unsigned long expmask; /* Groups that have ->blkd_tasks */
  152. /* elements that need to drain to allow the */
  153. /* current expedited grace period to */
  154. /* complete (only for PREEMPT_RCU). */
  155. unsigned long qsmaskinit;
  156. /* Per-GP initial value for qsmask & expmask. */
  157. /* Initialized from ->qsmaskinitnext at the */
  158. /* beginning of each grace period. */
  159. unsigned long qsmaskinitnext;
  160. /* Online CPUs for next grace period. */
  161. unsigned long grpmask; /* Mask to apply to parent qsmask. */
  162. /* Only one bit will be set in this mask. */
  163. int grplo; /* lowest-numbered CPU or group here. */
  164. int grphi; /* highest-numbered CPU or group here. */
  165. u8 grpnum; /* CPU/group number for next level up. */
  166. u8 level; /* root is at level 0. */
  167. bool wait_blkd_tasks;/* Necessary to wait for blocked tasks to */
  168. /* exit RCU read-side critical sections */
  169. /* before propagating offline up the */
  170. /* rcu_node tree? */
  171. struct rcu_node *parent;
  172. struct list_head blkd_tasks;
  173. /* Tasks blocked in RCU read-side critical */
  174. /* section. Tasks are placed at the head */
  175. /* of this list and age towards the tail. */
  176. struct list_head *gp_tasks;
  177. /* Pointer to the first task blocking the */
  178. /* current grace period, or NULL if there */
  179. /* is no such task. */
  180. struct list_head *exp_tasks;
  181. /* Pointer to the first task blocking the */
  182. /* current expedited grace period, or NULL */
  183. /* if there is no such task. If there */
  184. /* is no current expedited grace period, */
  185. /* then there can cannot be any such task. */
  186. struct list_head *boost_tasks;
  187. /* Pointer to first task that needs to be */
  188. /* priority boosted, or NULL if no priority */
  189. /* boosting is needed for this rcu_node */
  190. /* structure. If there are no tasks */
  191. /* queued on this rcu_node structure that */
  192. /* are blocking the current grace period, */
  193. /* there can be no such task. */
  194. struct rt_mutex boost_mtx;
  195. /* Used only for the priority-boosting */
  196. /* side effect, not as a lock. */
  197. unsigned long boost_time;
  198. /* When to start boosting (jiffies). */
  199. struct task_struct *boost_kthread_task;
  200. /* kthread that takes care of priority */
  201. /* boosting for this rcu_node structure. */
  202. unsigned int boost_kthread_status;
  203. /* State of boost_kthread_task for tracing. */
  204. unsigned long n_tasks_boosted;
  205. /* Total number of tasks boosted. */
  206. unsigned long n_exp_boosts;
  207. /* Number of tasks boosted for expedited GP. */
  208. unsigned long n_normal_boosts;
  209. /* Number of tasks boosted for normal GP. */
  210. unsigned long n_balk_blkd_tasks;
  211. /* Refused to boost: no blocked tasks. */
  212. unsigned long n_balk_exp_gp_tasks;
  213. /* Refused to boost: nothing blocking GP. */
  214. unsigned long n_balk_boost_tasks;
  215. /* Refused to boost: already boosting. */
  216. unsigned long n_balk_notblocked;
  217. /* Refused to boost: RCU RS CS still running. */
  218. unsigned long n_balk_notyet;
  219. /* Refused to boost: not yet time. */
  220. unsigned long n_balk_nos;
  221. /* Refused to boost: not sure why, though. */
  222. /* This can happen due to race conditions. */
  223. #ifdef CONFIG_RCU_NOCB_CPU
  224. wait_queue_head_t nocb_gp_wq[2];
  225. /* Place for rcu_nocb_kthread() to wait GP. */
  226. #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
  227. int need_future_gp[2];
  228. /* Counts of upcoming no-CB GP requests. */
  229. raw_spinlock_t fqslock ____cacheline_internodealigned_in_smp;
  230. } ____cacheline_internodealigned_in_smp;
  231. /*
  232. * Do a full breadth-first scan of the rcu_node structures for the
  233. * specified rcu_state structure.
  234. */
  235. #define rcu_for_each_node_breadth_first(rsp, rnp) \
  236. for ((rnp) = &(rsp)->node[0]; \
  237. (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
  238. /*
  239. * Do a breadth-first scan of the non-leaf rcu_node structures for the
  240. * specified rcu_state structure. Note that if there is a singleton
  241. * rcu_node tree with but one rcu_node structure, this loop is a no-op.
  242. */
  243. #define rcu_for_each_nonleaf_node_breadth_first(rsp, rnp) \
  244. for ((rnp) = &(rsp)->node[0]; \
  245. (rnp) < (rsp)->level[rcu_num_lvls - 1]; (rnp)++)
  246. /*
  247. * Scan the leaves of the rcu_node hierarchy for the specified rcu_state
  248. * structure. Note that if there is a singleton rcu_node tree with but
  249. * one rcu_node structure, this loop -will- visit the rcu_node structure.
  250. * It is still a leaf node, even if it is also the root node.
  251. */
  252. #define rcu_for_each_leaf_node(rsp, rnp) \
  253. for ((rnp) = (rsp)->level[rcu_num_lvls - 1]; \
  254. (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
  255. /* Index values for nxttail array in struct rcu_data. */
  256. #define RCU_DONE_TAIL 0 /* Also RCU_WAIT head. */
  257. #define RCU_WAIT_TAIL 1 /* Also RCU_NEXT_READY head. */
  258. #define RCU_NEXT_READY_TAIL 2 /* Also RCU_NEXT head. */
  259. #define RCU_NEXT_TAIL 3
  260. #define RCU_NEXT_SIZE 4
  261. /* Per-CPU data for read-copy update. */
  262. struct rcu_data {
  263. /* 1) quiescent-state and grace-period handling : */
  264. unsigned long completed; /* Track rsp->completed gp number */
  265. /* in order to detect GP end. */
  266. unsigned long gpnum; /* Highest gp number that this CPU */
  267. /* is aware of having started. */
  268. unsigned long rcu_qs_ctr_snap;/* Snapshot of rcu_qs_ctr to check */
  269. /* for rcu_all_qs() invocations. */
  270. bool passed_quiesce; /* User-mode/idle loop etc. */
  271. bool qs_pending; /* Core waits for quiesc state. */
  272. bool beenonline; /* CPU online at least once. */
  273. bool gpwrap; /* Possible gpnum/completed wrap. */
  274. struct rcu_node *mynode; /* This CPU's leaf of hierarchy */
  275. unsigned long grpmask; /* Mask to apply to leaf qsmask. */
  276. unsigned long ticks_this_gp; /* The number of scheduling-clock */
  277. /* ticks this CPU has handled */
  278. /* during and after the last grace */
  279. /* period it is aware of. */
  280. /* 2) batch handling */
  281. /*
  282. * If nxtlist is not NULL, it is partitioned as follows.
  283. * Any of the partitions might be empty, in which case the
  284. * pointer to that partition will be equal to the pointer for
  285. * the following partition. When the list is empty, all of
  286. * the nxttail elements point to the ->nxtlist pointer itself,
  287. * which in that case is NULL.
  288. *
  289. * [nxtlist, *nxttail[RCU_DONE_TAIL]):
  290. * Entries that batch # <= ->completed
  291. * The grace period for these entries has completed, and
  292. * the other grace-period-completed entries may be moved
  293. * here temporarily in rcu_process_callbacks().
  294. * [*nxttail[RCU_DONE_TAIL], *nxttail[RCU_WAIT_TAIL]):
  295. * Entries that batch # <= ->completed - 1: waiting for current GP
  296. * [*nxttail[RCU_WAIT_TAIL], *nxttail[RCU_NEXT_READY_TAIL]):
  297. * Entries known to have arrived before current GP ended
  298. * [*nxttail[RCU_NEXT_READY_TAIL], *nxttail[RCU_NEXT_TAIL]):
  299. * Entries that might have arrived after current GP ended
  300. * Note that the value of *nxttail[RCU_NEXT_TAIL] will
  301. * always be NULL, as this is the end of the list.
  302. */
  303. struct rcu_head *nxtlist;
  304. struct rcu_head **nxttail[RCU_NEXT_SIZE];
  305. unsigned long nxtcompleted[RCU_NEXT_SIZE];
  306. /* grace periods for sublists. */
  307. long qlen_lazy; /* # of lazy queued callbacks */
  308. long qlen; /* # of queued callbacks, incl lazy */
  309. long qlen_last_fqs_check;
  310. /* qlen at last check for QS forcing */
  311. unsigned long n_cbs_invoked; /* count of RCU cbs invoked. */
  312. unsigned long n_nocbs_invoked; /* count of no-CBs RCU cbs invoked. */
  313. unsigned long n_cbs_orphaned; /* RCU cbs orphaned by dying CPU */
  314. unsigned long n_cbs_adopted; /* RCU cbs adopted from dying CPU */
  315. unsigned long n_force_qs_snap;
  316. /* did other CPU force QS recently? */
  317. long blimit; /* Upper limit on a processed batch */
  318. /* 3) dynticks interface. */
  319. struct rcu_dynticks *dynticks; /* Shared per-CPU dynticks state. */
  320. int dynticks_snap; /* Per-GP tracking for dynticks. */
  321. /* 4) reasons this CPU needed to be kicked by force_quiescent_state */
  322. unsigned long dynticks_fqs; /* Kicked due to dynticks idle. */
  323. unsigned long offline_fqs; /* Kicked due to being offline. */
  324. unsigned long cond_resched_completed;
  325. /* Grace period that needs help */
  326. /* from cond_resched(). */
  327. /* 5) __rcu_pending() statistics. */
  328. unsigned long n_rcu_pending; /* rcu_pending() calls since boot. */
  329. unsigned long n_rp_qs_pending;
  330. unsigned long n_rp_report_qs;
  331. unsigned long n_rp_cb_ready;
  332. unsigned long n_rp_cpu_needs_gp;
  333. unsigned long n_rp_gp_completed;
  334. unsigned long n_rp_gp_started;
  335. unsigned long n_rp_nocb_defer_wakeup;
  336. unsigned long n_rp_need_nothing;
  337. /* 6) _rcu_barrier() and OOM callbacks. */
  338. struct rcu_head barrier_head;
  339. #ifdef CONFIG_RCU_FAST_NO_HZ
  340. struct rcu_head oom_head;
  341. #endif /* #ifdef CONFIG_RCU_FAST_NO_HZ */
  342. /* 7) Callback offloading. */
  343. #ifdef CONFIG_RCU_NOCB_CPU
  344. struct rcu_head *nocb_head; /* CBs waiting for kthread. */
  345. struct rcu_head **nocb_tail;
  346. atomic_long_t nocb_q_count; /* # CBs waiting for nocb */
  347. atomic_long_t nocb_q_count_lazy; /* invocation (all stages). */
  348. struct rcu_head *nocb_follower_head; /* CBs ready to invoke. */
  349. struct rcu_head **nocb_follower_tail;
  350. wait_queue_head_t nocb_wq; /* For nocb kthreads to sleep on. */
  351. struct task_struct *nocb_kthread;
  352. int nocb_defer_wakeup; /* Defer wakeup of nocb_kthread. */
  353. /* The following fields are used by the leader, hence own cacheline. */
  354. struct rcu_head *nocb_gp_head ____cacheline_internodealigned_in_smp;
  355. /* CBs waiting for GP. */
  356. struct rcu_head **nocb_gp_tail;
  357. bool nocb_leader_sleep; /* Is the nocb leader thread asleep? */
  358. struct rcu_data *nocb_next_follower;
  359. /* Next follower in wakeup chain. */
  360. /* The following fields are used by the follower, hence new cachline. */
  361. struct rcu_data *nocb_leader ____cacheline_internodealigned_in_smp;
  362. /* Leader CPU takes GP-end wakeups. */
  363. #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
  364. /* 8) RCU CPU stall data. */
  365. unsigned int softirq_snap; /* Snapshot of softirq activity. */
  366. int cpu;
  367. struct rcu_state *rsp;
  368. };
  369. /* Values for fqs_state field in struct rcu_state. */
  370. #define RCU_GP_IDLE 0 /* No grace period in progress. */
  371. #define RCU_GP_INIT 1 /* Grace period being initialized. */
  372. #define RCU_SAVE_DYNTICK 2 /* Need to scan dyntick state. */
  373. #define RCU_FORCE_QS 3 /* Need to force quiescent state. */
  374. #define RCU_SIGNAL_INIT RCU_SAVE_DYNTICK
  375. /* Values for nocb_defer_wakeup field in struct rcu_data. */
  376. #define RCU_NOGP_WAKE_NOT 0
  377. #define RCU_NOGP_WAKE 1
  378. #define RCU_NOGP_WAKE_FORCE 2
  379. #define RCU_JIFFIES_TILL_FORCE_QS (1 + (HZ > 250) + (HZ > 500))
  380. /* For jiffies_till_first_fqs and */
  381. /* and jiffies_till_next_fqs. */
  382. #define RCU_JIFFIES_FQS_DIV 256 /* Very large systems need more */
  383. /* delay between bouts of */
  384. /* quiescent-state forcing. */
  385. #define RCU_STALL_RAT_DELAY 2 /* Allow other CPUs time to take */
  386. /* at least one scheduling clock */
  387. /* irq before ratting on them. */
  388. #define rcu_wait(cond) \
  389. do { \
  390. for (;;) { \
  391. set_current_state(TASK_INTERRUPTIBLE); \
  392. if (cond) \
  393. break; \
  394. schedule(); \
  395. } \
  396. __set_current_state(TASK_RUNNING); \
  397. } while (0)
  398. /*
  399. * RCU global state, including node hierarchy. This hierarchy is
  400. * represented in "heap" form in a dense array. The root (first level)
  401. * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
  402. * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
  403. * and the third level in ->node[m+1] and following (->node[m+1] referenced
  404. * by ->level[2]). The number of levels is determined by the number of
  405. * CPUs and by CONFIG_RCU_FANOUT. Small systems will have a "hierarchy"
  406. * consisting of a single rcu_node.
  407. */
  408. struct rcu_state {
  409. struct rcu_node node[NUM_RCU_NODES]; /* Hierarchy. */
  410. struct rcu_node *level[RCU_NUM_LVLS + 1];
  411. /* Hierarchy levels (+1 to */
  412. /* shut bogus gcc warning) */
  413. u8 flavor_mask; /* bit in flavor mask. */
  414. struct rcu_data __percpu *rda; /* pointer of percu rcu_data. */
  415. void (*call)(struct rcu_head *head, /* call_rcu() flavor. */
  416. void (*func)(struct rcu_head *head));
  417. /* The following fields are guarded by the root rcu_node's lock. */
  418. u8 fqs_state ____cacheline_internodealigned_in_smp;
  419. /* Force QS state. */
  420. u8 boost; /* Subject to priority boost. */
  421. unsigned long gpnum; /* Current gp number. */
  422. unsigned long completed; /* # of last completed gp. */
  423. struct task_struct *gp_kthread; /* Task for grace periods. */
  424. wait_queue_head_t gp_wq; /* Where GP task waits. */
  425. short gp_flags; /* Commands for GP task. */
  426. short gp_state; /* GP kthread sleep state. */
  427. /* End of fields guarded by root rcu_node's lock. */
  428. raw_spinlock_t orphan_lock ____cacheline_internodealigned_in_smp;
  429. /* Protect following fields. */
  430. struct rcu_head *orphan_nxtlist; /* Orphaned callbacks that */
  431. /* need a grace period. */
  432. struct rcu_head **orphan_nxttail; /* Tail of above. */
  433. struct rcu_head *orphan_donelist; /* Orphaned callbacks that */
  434. /* are ready to invoke. */
  435. struct rcu_head **orphan_donetail; /* Tail of above. */
  436. long qlen_lazy; /* Number of lazy callbacks. */
  437. long qlen; /* Total number of callbacks. */
  438. /* End of fields guarded by orphan_lock. */
  439. struct mutex barrier_mutex; /* Guards barrier fields. */
  440. atomic_t barrier_cpu_count; /* # CPUs waiting on. */
  441. struct completion barrier_completion; /* Wake at barrier end. */
  442. unsigned long n_barrier_done; /* ++ at start and end of */
  443. /* _rcu_barrier(). */
  444. /* End of fields guarded by barrier_mutex. */
  445. struct mutex expedited_mutex; /* Serializes expediting. */
  446. unsigned long expedited_sequence; /* Take a ticket. */
  447. atomic_long_t expedited_tryfail; /* # acquisition failures. */
  448. atomic_long_t expedited_workdone1; /* # done by others #1. */
  449. atomic_long_t expedited_workdone2; /* # done by others #2. */
  450. unsigned long expedited_workdone3; /* # done by others #3. */
  451. atomic_long_t expedited_normal; /* # fallbacks to normal. */
  452. unsigned long jiffies_force_qs; /* Time at which to invoke */
  453. /* force_quiescent_state(). */
  454. unsigned long n_force_qs; /* Number of calls to */
  455. /* force_quiescent_state(). */
  456. unsigned long n_force_qs_lh; /* ~Number of calls leaving */
  457. /* due to lock unavailable. */
  458. unsigned long n_force_qs_ngp; /* Number of calls leaving */
  459. /* due to no GP active. */
  460. unsigned long gp_start; /* Time at which GP started, */
  461. /* but in jiffies. */
  462. unsigned long gp_activity; /* Time of last GP kthread */
  463. /* activity in jiffies. */
  464. unsigned long jiffies_stall; /* Time at which to check */
  465. /* for CPU stalls. */
  466. unsigned long jiffies_resched; /* Time at which to resched */
  467. /* a reluctant CPU. */
  468. unsigned long n_force_qs_gpstart; /* Snapshot of n_force_qs at */
  469. /* GP start. */
  470. unsigned long gp_max; /* Maximum GP duration in */
  471. /* jiffies. */
  472. const char *name; /* Name of structure. */
  473. char abbr; /* Abbreviated name. */
  474. struct list_head flavors; /* List of RCU flavors. */
  475. };
  476. /* Values for rcu_state structure's gp_flags field. */
  477. #define RCU_GP_FLAG_INIT 0x1 /* Need grace-period initialization. */
  478. #define RCU_GP_FLAG_FQS 0x2 /* Need grace-period quiescent-state forcing. */
  479. /* Values for rcu_state structure's gp_flags field. */
  480. #define RCU_GP_WAIT_INIT 0 /* Initial state. */
  481. #define RCU_GP_WAIT_GPS 1 /* Wait for grace-period start. */
  482. #define RCU_GP_DONE_GPS 2 /* Wait done for grace-period start. */
  483. #define RCU_GP_WAIT_FQS 3 /* Wait for force-quiescent-state time. */
  484. #define RCU_GP_DONE_FQS 4 /* Wait done for force-quiescent-state time. */
  485. #define RCU_GP_CLEANUP 5 /* Grace-period cleanup started. */
  486. #define RCU_GP_CLEANED 6 /* Grace-period cleanup complete. */
  487. extern struct list_head rcu_struct_flavors;
  488. /* Sequence through rcu_state structures for each RCU flavor. */
  489. #define for_each_rcu_flavor(rsp) \
  490. list_for_each_entry((rsp), &rcu_struct_flavors, flavors)
  491. /*
  492. * RCU implementation internal declarations:
  493. */
  494. extern struct rcu_state rcu_sched_state;
  495. extern struct rcu_state rcu_bh_state;
  496. #ifdef CONFIG_PREEMPT_RCU
  497. extern struct rcu_state rcu_preempt_state;
  498. #endif /* #ifdef CONFIG_PREEMPT_RCU */
  499. #ifdef CONFIG_RCU_BOOST
  500. DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_status);
  501. DECLARE_PER_CPU(int, rcu_cpu_kthread_cpu);
  502. DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_loops);
  503. DECLARE_PER_CPU(char, rcu_cpu_has_work);
  504. #endif /* #ifdef CONFIG_RCU_BOOST */
  505. #ifndef RCU_TREE_NONCORE
  506. /* Forward declarations for rcutree_plugin.h */
  507. static void rcu_bootup_announce(void);
  508. static void rcu_preempt_note_context_switch(void);
  509. static int rcu_preempt_blocked_readers_cgp(struct rcu_node *rnp);
  510. #ifdef CONFIG_HOTPLUG_CPU
  511. static bool rcu_preempt_has_tasks(struct rcu_node *rnp);
  512. #endif /* #ifdef CONFIG_HOTPLUG_CPU */
  513. static void rcu_print_detail_task_stall(struct rcu_state *rsp);
  514. static int rcu_print_task_stall(struct rcu_node *rnp);
  515. static void rcu_preempt_check_blocked_tasks(struct rcu_node *rnp);
  516. static void rcu_preempt_check_callbacks(void);
  517. void call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
  518. static void __init __rcu_init_preempt(void);
  519. static void rcu_initiate_boost(struct rcu_node *rnp, unsigned long flags);
  520. static void rcu_preempt_boost_start_gp(struct rcu_node *rnp);
  521. static void invoke_rcu_callbacks_kthread(void);
  522. static bool rcu_is_callbacks_kthread(void);
  523. #ifdef CONFIG_RCU_BOOST
  524. static void rcu_preempt_do_callbacks(void);
  525. static int rcu_spawn_one_boost_kthread(struct rcu_state *rsp,
  526. struct rcu_node *rnp);
  527. #endif /* #ifdef CONFIG_RCU_BOOST */
  528. static void __init rcu_spawn_boost_kthreads(void);
  529. static void rcu_prepare_kthreads(int cpu);
  530. static void rcu_cleanup_after_idle(void);
  531. static void rcu_prepare_for_idle(void);
  532. static void rcu_idle_count_callbacks_posted(void);
  533. static bool rcu_preempt_has_tasks(struct rcu_node *rnp);
  534. static void print_cpu_stall_info_begin(void);
  535. static void print_cpu_stall_info(struct rcu_state *rsp, int cpu);
  536. static void print_cpu_stall_info_end(void);
  537. static void zero_cpu_stall_ticks(struct rcu_data *rdp);
  538. static void increment_cpu_stall_ticks(void);
  539. static bool rcu_nocb_cpu_needs_barrier(struct rcu_state *rsp, int cpu);
  540. static void rcu_nocb_gp_set(struct rcu_node *rnp, int nrq);
  541. static void rcu_nocb_gp_cleanup(struct rcu_state *rsp, struct rcu_node *rnp);
  542. static void rcu_init_one_nocb(struct rcu_node *rnp);
  543. static bool __call_rcu_nocb(struct rcu_data *rdp, struct rcu_head *rhp,
  544. bool lazy, unsigned long flags);
  545. static bool rcu_nocb_adopt_orphan_cbs(struct rcu_state *rsp,
  546. struct rcu_data *rdp,
  547. unsigned long flags);
  548. static int rcu_nocb_need_deferred_wakeup(struct rcu_data *rdp);
  549. static void do_nocb_deferred_wakeup(struct rcu_data *rdp);
  550. static void rcu_boot_init_nocb_percpu_data(struct rcu_data *rdp);
  551. static void rcu_spawn_all_nocb_kthreads(int cpu);
  552. static void __init rcu_spawn_nocb_kthreads(void);
  553. #ifdef CONFIG_RCU_NOCB_CPU
  554. static void __init rcu_organize_nocb_kthreads(struct rcu_state *rsp);
  555. #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
  556. static void __maybe_unused rcu_kick_nohz_cpu(int cpu);
  557. static bool init_nocb_callback_list(struct rcu_data *rdp);
  558. static void rcu_sysidle_enter(int irq);
  559. static void rcu_sysidle_exit(int irq);
  560. static void rcu_sysidle_check_cpu(struct rcu_data *rdp, bool *isidle,
  561. unsigned long *maxj);
  562. static bool is_sysidle_rcu_state(struct rcu_state *rsp);
  563. static void rcu_sysidle_report_gp(struct rcu_state *rsp, int isidle,
  564. unsigned long maxj);
  565. static void rcu_bind_gp_kthread(void);
  566. static void rcu_sysidle_init_percpu_data(struct rcu_dynticks *rdtp);
  567. static bool rcu_nohz_full_cpu(struct rcu_state *rsp);
  568. static void rcu_dynticks_task_enter(void);
  569. static void rcu_dynticks_task_exit(void);
  570. #endif /* #ifndef RCU_TREE_NONCORE */
  571. #ifdef CONFIG_RCU_TRACE
  572. /* Read out queue lengths for tracing. */
  573. static inline void rcu_nocb_q_lengths(struct rcu_data *rdp, long *ql, long *qll)
  574. {
  575. #ifdef CONFIG_RCU_NOCB_CPU
  576. *ql = atomic_long_read(&rdp->nocb_q_count);
  577. *qll = atomic_long_read(&rdp->nocb_q_count_lazy);
  578. #else /* #ifdef CONFIG_RCU_NOCB_CPU */
  579. *ql = 0;
  580. *qll = 0;
  581. #endif /* #else #ifdef CONFIG_RCU_NOCB_CPU */
  582. }
  583. #endif /* #ifdef CONFIG_RCU_TRACE */