srcu.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694
  1. /*
  2. * Sleepable Read-Copy Update mechanism for mutual exclusion.
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation; either version 2 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software
  16. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17. *
  18. * Copyright (C) IBM Corporation, 2006
  19. * Copyright (C) Fujitsu, 2012
  20. *
  21. * Author: Paul McKenney <paulmck@us.ibm.com>
  22. * Lai Jiangshan <laijs@cn.fujitsu.com>
  23. *
  24. * For detailed explanation of Read-Copy Update mechanism see -
  25. * Documentation/RCU/ *.txt
  26. *
  27. */
  28. #include <linux/export.h>
  29. #include <linux/mutex.h>
  30. #include <linux/percpu.h>
  31. #include <linux/preempt.h>
  32. #include <linux/rcupdate.h>
  33. #include <linux/sched.h>
  34. #include <linux/smp.h>
  35. #include <linux/delay.h>
  36. #include <linux/srcu.h>
  37. #include <trace/events/rcu.h>
  38. #include "rcu.h"
  39. /*
  40. * Initialize an rcu_batch structure to empty.
  41. */
  42. static inline void rcu_batch_init(struct rcu_batch *b)
  43. {
  44. b->head = NULL;
  45. b->tail = &b->head;
  46. }
  47. /*
  48. * Enqueue a callback onto the tail of the specified rcu_batch structure.
  49. */
  50. static inline void rcu_batch_queue(struct rcu_batch *b, struct rcu_head *head)
  51. {
  52. *b->tail = head;
  53. b->tail = &head->next;
  54. }
  55. /*
  56. * Is the specified rcu_batch structure empty?
  57. */
  58. static inline bool rcu_batch_empty(struct rcu_batch *b)
  59. {
  60. return b->tail == &b->head;
  61. }
  62. /*
  63. * Remove the callback at the head of the specified rcu_batch structure
  64. * and return a pointer to it, or return NULL if the structure is empty.
  65. */
  66. static inline struct rcu_head *rcu_batch_dequeue(struct rcu_batch *b)
  67. {
  68. struct rcu_head *head;
  69. if (rcu_batch_empty(b))
  70. return NULL;
  71. head = b->head;
  72. b->head = head->next;
  73. if (b->tail == &head->next)
  74. rcu_batch_init(b);
  75. return head;
  76. }
  77. /*
  78. * Move all callbacks from the rcu_batch structure specified by "from" to
  79. * the structure specified by "to".
  80. */
  81. static inline void rcu_batch_move(struct rcu_batch *to, struct rcu_batch *from)
  82. {
  83. if (!rcu_batch_empty(from)) {
  84. *to->tail = from->head;
  85. to->tail = from->tail;
  86. rcu_batch_init(from);
  87. }
  88. }
  89. static int init_srcu_struct_fields(struct srcu_struct *sp)
  90. {
  91. sp->completed = 0;
  92. spin_lock_init(&sp->queue_lock);
  93. sp->running = false;
  94. rcu_batch_init(&sp->batch_queue);
  95. rcu_batch_init(&sp->batch_check0);
  96. rcu_batch_init(&sp->batch_check1);
  97. rcu_batch_init(&sp->batch_done);
  98. INIT_DELAYED_WORK(&sp->work, process_srcu);
  99. sp->per_cpu_ref = alloc_percpu(struct srcu_struct_array);
  100. return sp->per_cpu_ref ? 0 : -ENOMEM;
  101. }
  102. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  103. int __init_srcu_struct(struct srcu_struct *sp, const char *name,
  104. struct lock_class_key *key)
  105. {
  106. /* Don't re-initialize a lock while it is held. */
  107. debug_check_no_locks_freed((void *)sp, sizeof(*sp));
  108. lockdep_init_map(&sp->dep_map, name, key, 0);
  109. return init_srcu_struct_fields(sp);
  110. }
  111. EXPORT_SYMBOL_GPL(__init_srcu_struct);
  112. #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
  113. /**
  114. * init_srcu_struct - initialize a sleep-RCU structure
  115. * @sp: structure to initialize.
  116. *
  117. * Must invoke this on a given srcu_struct before passing that srcu_struct
  118. * to any other function. Each srcu_struct represents a separate domain
  119. * of SRCU protection.
  120. */
  121. int init_srcu_struct(struct srcu_struct *sp)
  122. {
  123. return init_srcu_struct_fields(sp);
  124. }
  125. EXPORT_SYMBOL_GPL(init_srcu_struct);
  126. #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
  127. /*
  128. * Returns approximate total of the readers' ->seq[] values for the
  129. * rank of per-CPU counters specified by idx.
  130. */
  131. static unsigned long srcu_readers_seq_idx(struct srcu_struct *sp, int idx)
  132. {
  133. int cpu;
  134. unsigned long sum = 0;
  135. unsigned long t;
  136. for_each_possible_cpu(cpu) {
  137. t = ACCESS_ONCE(per_cpu_ptr(sp->per_cpu_ref, cpu)->seq[idx]);
  138. sum += t;
  139. }
  140. return sum;
  141. }
  142. /*
  143. * Returns approximate number of readers active on the specified rank
  144. * of the per-CPU ->c[] counters.
  145. */
  146. static unsigned long srcu_readers_active_idx(struct srcu_struct *sp, int idx)
  147. {
  148. int cpu;
  149. unsigned long sum = 0;
  150. unsigned long t;
  151. for_each_possible_cpu(cpu) {
  152. t = ACCESS_ONCE(per_cpu_ptr(sp->per_cpu_ref, cpu)->c[idx]);
  153. sum += t;
  154. }
  155. return sum;
  156. }
  157. /*
  158. * Return true if the number of pre-existing readers is determined to
  159. * be stably zero. An example unstable zero can occur if the call
  160. * to srcu_readers_active_idx() misses an __srcu_read_lock() increment,
  161. * but due to task migration, sees the corresponding __srcu_read_unlock()
  162. * decrement. This can happen because srcu_readers_active_idx() takes
  163. * time to sum the array, and might in fact be interrupted or preempted
  164. * partway through the summation.
  165. */
  166. static bool srcu_readers_active_idx_check(struct srcu_struct *sp, int idx)
  167. {
  168. unsigned long seq;
  169. seq = srcu_readers_seq_idx(sp, idx);
  170. /*
  171. * The following smp_mb() A pairs with the smp_mb() B located in
  172. * __srcu_read_lock(). This pairing ensures that if an
  173. * __srcu_read_lock() increments its counter after the summation
  174. * in srcu_readers_active_idx(), then the corresponding SRCU read-side
  175. * critical section will see any changes made prior to the start
  176. * of the current SRCU grace period.
  177. *
  178. * Also, if the above call to srcu_readers_seq_idx() saw the
  179. * increment of ->seq[], then the call to srcu_readers_active_idx()
  180. * must see the increment of ->c[].
  181. */
  182. smp_mb(); /* A */
  183. /*
  184. * Note that srcu_readers_active_idx() can incorrectly return
  185. * zero even though there is a pre-existing reader throughout.
  186. * To see this, suppose that task A is in a very long SRCU
  187. * read-side critical section that started on CPU 0, and that
  188. * no other reader exists, so that the sum of the counters
  189. * is equal to one. Then suppose that task B starts executing
  190. * srcu_readers_active_idx(), summing up to CPU 1, and then that
  191. * task C starts reading on CPU 0, so that its increment is not
  192. * summed, but finishes reading on CPU 2, so that its decrement
  193. * -is- summed. Then when task B completes its sum, it will
  194. * incorrectly get zero, despite the fact that task A has been
  195. * in its SRCU read-side critical section the whole time.
  196. *
  197. * We therefore do a validation step should srcu_readers_active_idx()
  198. * return zero.
  199. */
  200. if (srcu_readers_active_idx(sp, idx) != 0)
  201. return false;
  202. /*
  203. * The remainder of this function is the validation step.
  204. * The following smp_mb() D pairs with the smp_mb() C in
  205. * __srcu_read_unlock(). If the __srcu_read_unlock() was seen
  206. * by srcu_readers_active_idx() above, then any destructive
  207. * operation performed after the grace period will happen after
  208. * the corresponding SRCU read-side critical section.
  209. *
  210. * Note that there can be at most NR_CPUS worth of readers using
  211. * the old index, which is not enough to overflow even a 32-bit
  212. * integer. (Yes, this does mean that systems having more than
  213. * a billion or so CPUs need to be 64-bit systems.) Therefore,
  214. * the sum of the ->seq[] counters cannot possibly overflow.
  215. * Therefore, the only way that the return values of the two
  216. * calls to srcu_readers_seq_idx() can be equal is if there were
  217. * no increments of the corresponding rank of ->seq[] counts
  218. * in the interim. But the missed-increment scenario laid out
  219. * above includes an increment of the ->seq[] counter by
  220. * the corresponding __srcu_read_lock(). Therefore, if this
  221. * scenario occurs, the return values from the two calls to
  222. * srcu_readers_seq_idx() will differ, and thus the validation
  223. * step below suffices.
  224. */
  225. smp_mb(); /* D */
  226. return srcu_readers_seq_idx(sp, idx) == seq;
  227. }
  228. /**
  229. * srcu_readers_active - returns approximate number of readers.
  230. * @sp: which srcu_struct to count active readers (holding srcu_read_lock).
  231. *
  232. * Note that this is not an atomic primitive, and can therefore suffer
  233. * severe errors when invoked on an active srcu_struct. That said, it
  234. * can be useful as an error check at cleanup time.
  235. */
  236. static int srcu_readers_active(struct srcu_struct *sp)
  237. {
  238. int cpu;
  239. unsigned long sum = 0;
  240. for_each_possible_cpu(cpu) {
  241. sum += ACCESS_ONCE(per_cpu_ptr(sp->per_cpu_ref, cpu)->c[0]);
  242. sum += ACCESS_ONCE(per_cpu_ptr(sp->per_cpu_ref, cpu)->c[1]);
  243. }
  244. return sum;
  245. }
  246. /**
  247. * cleanup_srcu_struct - deconstruct a sleep-RCU structure
  248. * @sp: structure to clean up.
  249. *
  250. * Must invoke this after you are finished using a given srcu_struct that
  251. * was initialized via init_srcu_struct(), else you leak memory.
  252. */
  253. void cleanup_srcu_struct(struct srcu_struct *sp)
  254. {
  255. if (WARN_ON(srcu_readers_active(sp)))
  256. return; /* Leakage unless caller handles error. */
  257. free_percpu(sp->per_cpu_ref);
  258. sp->per_cpu_ref = NULL;
  259. }
  260. EXPORT_SYMBOL_GPL(cleanup_srcu_struct);
  261. /*
  262. * Counts the new reader in the appropriate per-CPU element of the
  263. * srcu_struct. Must be called from process context.
  264. * Returns an index that must be passed to the matching srcu_read_unlock().
  265. */
  266. int __srcu_read_lock(struct srcu_struct *sp)
  267. {
  268. int idx;
  269. idx = ACCESS_ONCE(sp->completed) & 0x1;
  270. preempt_disable();
  271. ACCESS_ONCE(this_cpu_ptr(sp->per_cpu_ref)->c[idx]) += 1;
  272. smp_mb(); /* B */ /* Avoid leaking the critical section. */
  273. ACCESS_ONCE(this_cpu_ptr(sp->per_cpu_ref)->seq[idx]) += 1;
  274. preempt_enable();
  275. return idx;
  276. }
  277. EXPORT_SYMBOL_GPL(__srcu_read_lock);
  278. /*
  279. * Removes the count for the old reader from the appropriate per-CPU
  280. * element of the srcu_struct. Note that this may well be a different
  281. * CPU than that which was incremented by the corresponding srcu_read_lock().
  282. * Must be called from process context.
  283. */
  284. void __srcu_read_unlock(struct srcu_struct *sp, int idx)
  285. {
  286. smp_mb(); /* C */ /* Avoid leaking the critical section. */
  287. this_cpu_dec(sp->per_cpu_ref->c[idx]);
  288. }
  289. EXPORT_SYMBOL_GPL(__srcu_read_unlock);
  290. /*
  291. * We use an adaptive strategy for synchronize_srcu() and especially for
  292. * synchronize_srcu_expedited(). We spin for a fixed time period
  293. * (defined below) to allow SRCU readers to exit their read-side critical
  294. * sections. If there are still some readers after 10 microseconds,
  295. * we repeatedly block for 1-millisecond time periods. This approach
  296. * has done well in testing, so there is no need for a config parameter.
  297. */
  298. #define SRCU_RETRY_CHECK_DELAY 5
  299. #define SYNCHRONIZE_SRCU_TRYCOUNT 2
  300. #define SYNCHRONIZE_SRCU_EXP_TRYCOUNT 12
  301. /*
  302. * @@@ Wait until all pre-existing readers complete. Such readers
  303. * will have used the index specified by "idx".
  304. * the caller should ensures the ->completed is not changed while checking
  305. * and idx = (->completed & 1) ^ 1
  306. */
  307. static bool try_check_zero(struct srcu_struct *sp, int idx, int trycount)
  308. {
  309. for (;;) {
  310. if (srcu_readers_active_idx_check(sp, idx))
  311. return true;
  312. if (--trycount <= 0)
  313. return false;
  314. udelay(SRCU_RETRY_CHECK_DELAY);
  315. }
  316. }
  317. /*
  318. * Increment the ->completed counter so that future SRCU readers will
  319. * use the other rank of the ->c[] and ->seq[] arrays. This allows
  320. * us to wait for pre-existing readers in a starvation-free manner.
  321. */
  322. static void srcu_flip(struct srcu_struct *sp)
  323. {
  324. sp->completed++;
  325. }
  326. /*
  327. * Enqueue an SRCU callback on the specified srcu_struct structure,
  328. * initiating grace-period processing if it is not already running.
  329. *
  330. * Note that all CPUs must agree that the grace period extended beyond
  331. * all pre-existing SRCU read-side critical section. On systems with
  332. * more than one CPU, this means that when "func()" is invoked, each CPU
  333. * is guaranteed to have executed a full memory barrier since the end of
  334. * its last corresponding SRCU read-side critical section whose beginning
  335. * preceded the call to call_rcu(). It also means that each CPU executing
  336. * an SRCU read-side critical section that continues beyond the start of
  337. * "func()" must have executed a memory barrier after the call_rcu()
  338. * but before the beginning of that SRCU read-side critical section.
  339. * Note that these guarantees include CPUs that are offline, idle, or
  340. * executing in user mode, as well as CPUs that are executing in the kernel.
  341. *
  342. * Furthermore, if CPU A invoked call_rcu() and CPU B invoked the
  343. * resulting SRCU callback function "func()", then both CPU A and CPU
  344. * B are guaranteed to execute a full memory barrier during the time
  345. * interval between the call to call_rcu() and the invocation of "func()".
  346. * This guarantee applies even if CPU A and CPU B are the same CPU (but
  347. * again only if the system has more than one CPU).
  348. *
  349. * Of course, these guarantees apply only for invocations of call_srcu(),
  350. * srcu_read_lock(), and srcu_read_unlock() that are all passed the same
  351. * srcu_struct structure.
  352. */
  353. void call_srcu(struct srcu_struct *sp, struct rcu_head *head,
  354. void (*func)(struct rcu_head *head))
  355. {
  356. unsigned long flags;
  357. head->next = NULL;
  358. head->func = func;
  359. spin_lock_irqsave(&sp->queue_lock, flags);
  360. rcu_batch_queue(&sp->batch_queue, head);
  361. if (!sp->running) {
  362. sp->running = true;
  363. schedule_delayed_work(&sp->work, 0);
  364. }
  365. spin_unlock_irqrestore(&sp->queue_lock, flags);
  366. }
  367. EXPORT_SYMBOL_GPL(call_srcu);
  368. struct rcu_synchronize {
  369. struct rcu_head head;
  370. struct completion completion;
  371. };
  372. /*
  373. * Awaken the corresponding synchronize_srcu() instance now that a
  374. * grace period has elapsed.
  375. */
  376. static void wakeme_after_rcu(struct rcu_head *head)
  377. {
  378. struct rcu_synchronize *rcu;
  379. rcu = container_of(head, struct rcu_synchronize, head);
  380. complete(&rcu->completion);
  381. }
  382. static void srcu_advance_batches(struct srcu_struct *sp, int trycount);
  383. static void srcu_reschedule(struct srcu_struct *sp);
  384. /*
  385. * Helper function for synchronize_srcu() and synchronize_srcu_expedited().
  386. */
  387. static void __synchronize_srcu(struct srcu_struct *sp, int trycount)
  388. {
  389. struct rcu_synchronize rcu;
  390. struct rcu_head *head = &rcu.head;
  391. bool done = false;
  392. rcu_lockdep_assert(!lock_is_held(&sp->dep_map) &&
  393. !lock_is_held(&rcu_bh_lock_map) &&
  394. !lock_is_held(&rcu_lock_map) &&
  395. !lock_is_held(&rcu_sched_lock_map),
  396. "Illegal synchronize_srcu() in same-type SRCU (or RCU) read-side critical section");
  397. might_sleep();
  398. init_completion(&rcu.completion);
  399. head->next = NULL;
  400. head->func = wakeme_after_rcu;
  401. spin_lock_irq(&sp->queue_lock);
  402. if (!sp->running) {
  403. /* steal the processing owner */
  404. sp->running = true;
  405. rcu_batch_queue(&sp->batch_check0, head);
  406. spin_unlock_irq(&sp->queue_lock);
  407. srcu_advance_batches(sp, trycount);
  408. if (!rcu_batch_empty(&sp->batch_done)) {
  409. BUG_ON(sp->batch_done.head != head);
  410. rcu_batch_dequeue(&sp->batch_done);
  411. done = true;
  412. }
  413. /* give the processing owner to work_struct */
  414. srcu_reschedule(sp);
  415. } else {
  416. rcu_batch_queue(&sp->batch_queue, head);
  417. spin_unlock_irq(&sp->queue_lock);
  418. }
  419. if (!done)
  420. wait_for_completion(&rcu.completion);
  421. }
  422. /**
  423. * synchronize_srcu - wait for prior SRCU read-side critical-section completion
  424. * @sp: srcu_struct with which to synchronize.
  425. *
  426. * Wait for the count to drain to zero of both indexes. To avoid the
  427. * possible starvation of synchronize_srcu(), it waits for the count of
  428. * the index=((->completed & 1) ^ 1) to drain to zero at first,
  429. * and then flip the completed and wait for the count of the other index.
  430. *
  431. * Can block; must be called from process context.
  432. *
  433. * Note that it is illegal to call synchronize_srcu() from the corresponding
  434. * SRCU read-side critical section; doing so will result in deadlock.
  435. * However, it is perfectly legal to call synchronize_srcu() on one
  436. * srcu_struct from some other srcu_struct's read-side critical section,
  437. * as long as the resulting graph of srcu_structs is acyclic.
  438. *
  439. * There are memory-ordering constraints implied by synchronize_srcu().
  440. * On systems with more than one CPU, when synchronize_srcu() returns,
  441. * each CPU is guaranteed to have executed a full memory barrier since
  442. * the end of its last corresponding SRCU-sched read-side critical section
  443. * whose beginning preceded the call to synchronize_srcu(). In addition,
  444. * each CPU having an SRCU read-side critical section that extends beyond
  445. * the return from synchronize_srcu() is guaranteed to have executed a
  446. * full memory barrier after the beginning of synchronize_srcu() and before
  447. * the beginning of that SRCU read-side critical section. Note that these
  448. * guarantees include CPUs that are offline, idle, or executing in user mode,
  449. * as well as CPUs that are executing in the kernel.
  450. *
  451. * Furthermore, if CPU A invoked synchronize_srcu(), which returned
  452. * to its caller on CPU B, then both CPU A and CPU B are guaranteed
  453. * to have executed a full memory barrier during the execution of
  454. * synchronize_srcu(). This guarantee applies even if CPU A and CPU B
  455. * are the same CPU, but again only if the system has more than one CPU.
  456. *
  457. * Of course, these memory-ordering guarantees apply only when
  458. * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are
  459. * passed the same srcu_struct structure.
  460. */
  461. void synchronize_srcu(struct srcu_struct *sp)
  462. {
  463. __synchronize_srcu(sp, rcu_expedited
  464. ? SYNCHRONIZE_SRCU_EXP_TRYCOUNT
  465. : SYNCHRONIZE_SRCU_TRYCOUNT);
  466. }
  467. EXPORT_SYMBOL_GPL(synchronize_srcu);
  468. /**
  469. * synchronize_srcu_expedited - Brute-force SRCU grace period
  470. * @sp: srcu_struct with which to synchronize.
  471. *
  472. * Wait for an SRCU grace period to elapse, but be more aggressive about
  473. * spinning rather than blocking when waiting.
  474. *
  475. * Note that synchronize_srcu_expedited() has the same deadlock and
  476. * memory-ordering properties as does synchronize_srcu().
  477. */
  478. void synchronize_srcu_expedited(struct srcu_struct *sp)
  479. {
  480. __synchronize_srcu(sp, SYNCHRONIZE_SRCU_EXP_TRYCOUNT);
  481. }
  482. EXPORT_SYMBOL_GPL(synchronize_srcu_expedited);
  483. /**
  484. * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete.
  485. * @sp: srcu_struct on which to wait for in-flight callbacks.
  486. */
  487. void srcu_barrier(struct srcu_struct *sp)
  488. {
  489. synchronize_srcu(sp);
  490. }
  491. EXPORT_SYMBOL_GPL(srcu_barrier);
  492. /**
  493. * srcu_batches_completed - return batches completed.
  494. * @sp: srcu_struct on which to report batch completion.
  495. *
  496. * Report the number of batches, correlated with, but not necessarily
  497. * precisely the same as, the number of grace periods that have elapsed.
  498. */
  499. long srcu_batches_completed(struct srcu_struct *sp)
  500. {
  501. return sp->completed;
  502. }
  503. EXPORT_SYMBOL_GPL(srcu_batches_completed);
  504. #define SRCU_CALLBACK_BATCH 10
  505. #define SRCU_INTERVAL 1
  506. /*
  507. * Move any new SRCU callbacks to the first stage of the SRCU grace
  508. * period pipeline.
  509. */
  510. static void srcu_collect_new(struct srcu_struct *sp)
  511. {
  512. if (!rcu_batch_empty(&sp->batch_queue)) {
  513. spin_lock_irq(&sp->queue_lock);
  514. rcu_batch_move(&sp->batch_check0, &sp->batch_queue);
  515. spin_unlock_irq(&sp->queue_lock);
  516. }
  517. }
  518. /*
  519. * Core SRCU state machine. Advance callbacks from ->batch_check0 to
  520. * ->batch_check1 and then to ->batch_done as readers drain.
  521. */
  522. static void srcu_advance_batches(struct srcu_struct *sp, int trycount)
  523. {
  524. int idx = 1 ^ (sp->completed & 1);
  525. /*
  526. * Because readers might be delayed for an extended period after
  527. * fetching ->completed for their index, at any point in time there
  528. * might well be readers using both idx=0 and idx=1. We therefore
  529. * need to wait for readers to clear from both index values before
  530. * invoking a callback.
  531. */
  532. if (rcu_batch_empty(&sp->batch_check0) &&
  533. rcu_batch_empty(&sp->batch_check1))
  534. return; /* no callbacks need to be advanced */
  535. if (!try_check_zero(sp, idx, trycount))
  536. return; /* failed to advance, will try after SRCU_INTERVAL */
  537. /*
  538. * The callbacks in ->batch_check1 have already done with their
  539. * first zero check and flip back when they were enqueued on
  540. * ->batch_check0 in a previous invocation of srcu_advance_batches().
  541. * (Presumably try_check_zero() returned false during that
  542. * invocation, leaving the callbacks stranded on ->batch_check1.)
  543. * They are therefore ready to invoke, so move them to ->batch_done.
  544. */
  545. rcu_batch_move(&sp->batch_done, &sp->batch_check1);
  546. if (rcu_batch_empty(&sp->batch_check0))
  547. return; /* no callbacks need to be advanced */
  548. srcu_flip(sp);
  549. /*
  550. * The callbacks in ->batch_check0 just finished their
  551. * first check zero and flip, so move them to ->batch_check1
  552. * for future checking on the other idx.
  553. */
  554. rcu_batch_move(&sp->batch_check1, &sp->batch_check0);
  555. /*
  556. * SRCU read-side critical sections are normally short, so check
  557. * at least twice in quick succession after a flip.
  558. */
  559. trycount = trycount < 2 ? 2 : trycount;
  560. if (!try_check_zero(sp, idx^1, trycount))
  561. return; /* failed to advance, will try after SRCU_INTERVAL */
  562. /*
  563. * The callbacks in ->batch_check1 have now waited for all
  564. * pre-existing readers using both idx values. They are therefore
  565. * ready to invoke, so move them to ->batch_done.
  566. */
  567. rcu_batch_move(&sp->batch_done, &sp->batch_check1);
  568. }
  569. /*
  570. * Invoke a limited number of SRCU callbacks that have passed through
  571. * their grace period. If there are more to do, SRCU will reschedule
  572. * the workqueue.
  573. */
  574. static void srcu_invoke_callbacks(struct srcu_struct *sp)
  575. {
  576. int i;
  577. struct rcu_head *head;
  578. for (i = 0; i < SRCU_CALLBACK_BATCH; i++) {
  579. head = rcu_batch_dequeue(&sp->batch_done);
  580. if (!head)
  581. break;
  582. local_bh_disable();
  583. head->func(head);
  584. local_bh_enable();
  585. }
  586. }
  587. /*
  588. * Finished one round of SRCU grace period. Start another if there are
  589. * more SRCU callbacks queued, otherwise put SRCU into not-running state.
  590. */
  591. static void srcu_reschedule(struct srcu_struct *sp)
  592. {
  593. bool pending = true;
  594. if (rcu_batch_empty(&sp->batch_done) &&
  595. rcu_batch_empty(&sp->batch_check1) &&
  596. rcu_batch_empty(&sp->batch_check0) &&
  597. rcu_batch_empty(&sp->batch_queue)) {
  598. spin_lock_irq(&sp->queue_lock);
  599. if (rcu_batch_empty(&sp->batch_done) &&
  600. rcu_batch_empty(&sp->batch_check1) &&
  601. rcu_batch_empty(&sp->batch_check0) &&
  602. rcu_batch_empty(&sp->batch_queue)) {
  603. sp->running = false;
  604. pending = false;
  605. }
  606. spin_unlock_irq(&sp->queue_lock);
  607. }
  608. if (pending)
  609. schedule_delayed_work(&sp->work, SRCU_INTERVAL);
  610. }
  611. /*
  612. * This is the work-queue function that handles SRCU grace periods.
  613. */
  614. void process_srcu(struct work_struct *work)
  615. {
  616. struct srcu_struct *sp;
  617. sp = container_of(work, struct srcu_struct, work.work);
  618. srcu_collect_new(sp);
  619. srcu_advance_batches(sp, 1);
  620. srcu_invoke_callbacks(sp);
  621. srcu_reschedule(sp);
  622. }
  623. EXPORT_SYMBOL_GPL(process_srcu);