1dad81a20SPaul E. McKenney /* 2dad81a20SPaul E. McKenney * Sleepable Read-Copy Update mechanism for mutual exclusion. 3dad81a20SPaul E. McKenney * 4dad81a20SPaul E. McKenney * This program is free software; you can redistribute it and/or modify 5dad81a20SPaul E. McKenney * it under the terms of the GNU General Public License as published by 6dad81a20SPaul E. McKenney * the Free Software Foundation; either version 2 of the License, or 7dad81a20SPaul E. McKenney * (at your option) any later version. 8dad81a20SPaul E. McKenney * 9dad81a20SPaul E. McKenney * This program is distributed in the hope that it will be useful, 10dad81a20SPaul E. McKenney * but WITHOUT ANY WARRANTY; without even the implied warranty of 11dad81a20SPaul E. McKenney * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12dad81a20SPaul E. McKenney * GNU General Public License for more details. 13dad81a20SPaul E. McKenney * 14dad81a20SPaul E. McKenney * You should have received a copy of the GNU General Public License 15dad81a20SPaul E. McKenney * along with this program; if not, you can access it online at 16dad81a20SPaul E. McKenney * http://www.gnu.org/licenses/gpl-2.0.html. 17dad81a20SPaul E. McKenney * 18dad81a20SPaul E. McKenney * Copyright (C) IBM Corporation, 2006 19dad81a20SPaul E. McKenney * Copyright (C) Fujitsu, 2012 20dad81a20SPaul E. McKenney * 21dad81a20SPaul E. McKenney * Author: Paul McKenney <[email protected]> 22dad81a20SPaul E. McKenney * Lai Jiangshan <[email protected]> 23dad81a20SPaul E. McKenney * 24dad81a20SPaul E. McKenney * For detailed explanation of Read-Copy Update mechanism see - 25dad81a20SPaul E. McKenney * Documentation/RCU/ *.txt 26dad81a20SPaul E. McKenney * 27dad81a20SPaul E. McKenney */ 28dad81a20SPaul E. McKenney 29dad81a20SPaul E. McKenney #include <linux/export.h> 30dad81a20SPaul E. McKenney #include <linux/mutex.h> 31dad81a20SPaul E. McKenney #include <linux/percpu.h> 32dad81a20SPaul E. McKenney #include <linux/preempt.h> 33dad81a20SPaul E. McKenney #include <linux/rcupdate_wait.h> 34dad81a20SPaul E. McKenney #include <linux/sched.h> 35dad81a20SPaul E. McKenney #include <linux/smp.h> 36dad81a20SPaul E. McKenney #include <linux/delay.h> 3722607d66SPaul E. McKenney #include <linux/module.h> 38dad81a20SPaul E. McKenney #include <linux/srcu.h> 39dad81a20SPaul E. McKenney 40dad81a20SPaul E. McKenney #include "rcu.h" 4145753c5fSIngo Molnar #include "rcu_segcblist.h" 42dad81a20SPaul E. McKenney 430c8e0e3cSPaul E. McKenney /* Holdoff in nanoseconds for auto-expediting. */ 440c8e0e3cSPaul E. McKenney #define DEFAULT_SRCU_EXP_HOLDOFF (25 * 1000) 450c8e0e3cSPaul E. McKenney static ulong exp_holdoff = DEFAULT_SRCU_EXP_HOLDOFF; 4622607d66SPaul E. McKenney module_param(exp_holdoff, ulong, 0444); 4722607d66SPaul E. McKenney 48c350c008SPaul E. McKenney /* Overflow-check frequency. N bits roughly says every 2**N grace periods. */ 49c350c008SPaul E. McKenney static ulong counter_wrap_check = (ULONG_MAX >> 2); 50c350c008SPaul E. McKenney module_param(counter_wrap_check, ulong, 0444); 51c350c008SPaul E. McKenney 52da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work); 53da915ad5SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay); 54da915ad5SPaul E. McKenney 55da915ad5SPaul E. McKenney /* 56da915ad5SPaul E. McKenney * Initialize SRCU combining tree. Note that statically allocated 57da915ad5SPaul E. McKenney * srcu_struct structures might already have srcu_read_lock() and 58da915ad5SPaul E. McKenney * srcu_read_unlock() running against them. So if the is_static parameter 59da915ad5SPaul E. McKenney * is set, don't initialize ->srcu_lock_count[] and ->srcu_unlock_count[]. 60da915ad5SPaul E. McKenney */ 61da915ad5SPaul E. McKenney static void init_srcu_struct_nodes(struct srcu_struct *sp, bool is_static) 62dad81a20SPaul E. McKenney { 63da915ad5SPaul E. McKenney int cpu; 64da915ad5SPaul E. McKenney int i; 65da915ad5SPaul E. McKenney int level = 0; 66da915ad5SPaul E. McKenney int levelspread[RCU_NUM_LVLS]; 67da915ad5SPaul E. McKenney struct srcu_data *sdp; 68da915ad5SPaul E. McKenney struct srcu_node *snp; 69da915ad5SPaul E. McKenney struct srcu_node *snp_first; 70da915ad5SPaul E. McKenney 71da915ad5SPaul E. McKenney /* Work out the overall tree geometry. */ 72da915ad5SPaul E. McKenney sp->level[0] = &sp->node[0]; 73da915ad5SPaul E. McKenney for (i = 1; i < rcu_num_lvls; i++) 74da915ad5SPaul E. McKenney sp->level[i] = sp->level[i - 1] + num_rcu_lvl[i - 1]; 75da915ad5SPaul E. McKenney rcu_init_levelspread(levelspread, num_rcu_lvl); 76da915ad5SPaul E. McKenney 77da915ad5SPaul E. McKenney /* Each pass through this loop initializes one srcu_node structure. */ 78da915ad5SPaul E. McKenney rcu_for_each_node_breadth_first(sp, snp) { 79da915ad5SPaul E. McKenney spin_lock_init(&snp->lock); 80c7e88067SPaul E. McKenney WARN_ON_ONCE(ARRAY_SIZE(snp->srcu_have_cbs) != 81c7e88067SPaul E. McKenney ARRAY_SIZE(snp->srcu_data_have_cbs)); 82c7e88067SPaul E. McKenney for (i = 0; i < ARRAY_SIZE(snp->srcu_have_cbs); i++) { 83da915ad5SPaul E. McKenney snp->srcu_have_cbs[i] = 0; 84c7e88067SPaul E. McKenney snp->srcu_data_have_cbs[i] = 0; 85c7e88067SPaul E. McKenney } 861e9a038bSPaul E. McKenney snp->srcu_gp_seq_needed_exp = 0; 87da915ad5SPaul E. McKenney snp->grplo = -1; 88da915ad5SPaul E. McKenney snp->grphi = -1; 89da915ad5SPaul E. McKenney if (snp == &sp->node[0]) { 90da915ad5SPaul E. McKenney /* Root node, special case. */ 91da915ad5SPaul E. McKenney snp->srcu_parent = NULL; 92da915ad5SPaul E. McKenney continue; 93da915ad5SPaul E. McKenney } 94da915ad5SPaul E. McKenney 95da915ad5SPaul E. McKenney /* Non-root node. */ 96da915ad5SPaul E. McKenney if (snp == sp->level[level + 1]) 97da915ad5SPaul E. McKenney level++; 98da915ad5SPaul E. McKenney snp->srcu_parent = sp->level[level - 1] + 99da915ad5SPaul E. McKenney (snp - sp->level[level]) / 100da915ad5SPaul E. McKenney levelspread[level - 1]; 101da915ad5SPaul E. McKenney } 102da915ad5SPaul E. McKenney 103da915ad5SPaul E. McKenney /* 104da915ad5SPaul E. McKenney * Initialize the per-CPU srcu_data array, which feeds into the 105da915ad5SPaul E. McKenney * leaves of the srcu_node tree. 106da915ad5SPaul E. McKenney */ 107da915ad5SPaul E. McKenney WARN_ON_ONCE(ARRAY_SIZE(sdp->srcu_lock_count) != 108da915ad5SPaul E. McKenney ARRAY_SIZE(sdp->srcu_unlock_count)); 109da915ad5SPaul E. McKenney level = rcu_num_lvls - 1; 110da915ad5SPaul E. McKenney snp_first = sp->level[level]; 111da915ad5SPaul E. McKenney for_each_possible_cpu(cpu) { 112da915ad5SPaul E. McKenney sdp = per_cpu_ptr(sp->sda, cpu); 113da915ad5SPaul E. McKenney spin_lock_init(&sdp->lock); 114da915ad5SPaul E. McKenney rcu_segcblist_init(&sdp->srcu_cblist); 115da915ad5SPaul E. McKenney sdp->srcu_cblist_invoking = false; 116da915ad5SPaul E. McKenney sdp->srcu_gp_seq_needed = sp->srcu_gp_seq; 1171e9a038bSPaul E. McKenney sdp->srcu_gp_seq_needed_exp = sp->srcu_gp_seq; 118da915ad5SPaul E. McKenney sdp->mynode = &snp_first[cpu / levelspread[level]]; 119da915ad5SPaul E. McKenney for (snp = sdp->mynode; snp != NULL; snp = snp->srcu_parent) { 120da915ad5SPaul E. McKenney if (snp->grplo < 0) 121da915ad5SPaul E. McKenney snp->grplo = cpu; 122da915ad5SPaul E. McKenney snp->grphi = cpu; 123da915ad5SPaul E. McKenney } 124da915ad5SPaul E. McKenney sdp->cpu = cpu; 125da915ad5SPaul E. McKenney INIT_DELAYED_WORK(&sdp->work, srcu_invoke_callbacks); 126da915ad5SPaul E. McKenney sdp->sp = sp; 127c7e88067SPaul E. McKenney sdp->grpmask = 1 << (cpu - sdp->mynode->grplo); 128da915ad5SPaul E. McKenney if (is_static) 129da915ad5SPaul E. McKenney continue; 130da915ad5SPaul E. McKenney 131da915ad5SPaul E. McKenney /* Dynamically allocated, better be no srcu_read_locks()! */ 132da915ad5SPaul E. McKenney for (i = 0; i < ARRAY_SIZE(sdp->srcu_lock_count); i++) { 133da915ad5SPaul E. McKenney sdp->srcu_lock_count[i] = 0; 134da915ad5SPaul E. McKenney sdp->srcu_unlock_count[i] = 0; 135da915ad5SPaul E. McKenney } 136da915ad5SPaul E. McKenney } 137da915ad5SPaul E. McKenney } 138da915ad5SPaul E. McKenney 139da915ad5SPaul E. McKenney /* 140da915ad5SPaul E. McKenney * Initialize non-compile-time initialized fields, including the 141da915ad5SPaul E. McKenney * associated srcu_node and srcu_data structures. The is_static 142da915ad5SPaul E. McKenney * parameter is passed through to init_srcu_struct_nodes(), and 143da915ad5SPaul E. McKenney * also tells us that ->sda has already been wired up to srcu_data. 144da915ad5SPaul E. McKenney */ 145da915ad5SPaul E. McKenney static int init_srcu_struct_fields(struct srcu_struct *sp, bool is_static) 146da915ad5SPaul E. McKenney { 147da915ad5SPaul E. McKenney mutex_init(&sp->srcu_cb_mutex); 148da915ad5SPaul E. McKenney mutex_init(&sp->srcu_gp_mutex); 149da915ad5SPaul E. McKenney sp->srcu_idx = 0; 150dad81a20SPaul E. McKenney sp->srcu_gp_seq = 0; 151da915ad5SPaul E. McKenney sp->srcu_barrier_seq = 0; 152da915ad5SPaul E. McKenney mutex_init(&sp->srcu_barrier_mutex); 153da915ad5SPaul E. McKenney atomic_set(&sp->srcu_barrier_cpu_cnt, 0); 154dad81a20SPaul E. McKenney INIT_DELAYED_WORK(&sp->work, process_srcu); 155da915ad5SPaul E. McKenney if (!is_static) 156da915ad5SPaul E. McKenney sp->sda = alloc_percpu(struct srcu_data); 157da915ad5SPaul E. McKenney init_srcu_struct_nodes(sp, is_static); 1581e9a038bSPaul E. McKenney sp->srcu_gp_seq_needed_exp = 0; 15922607d66SPaul E. McKenney sp->srcu_last_gp_end = ktime_get_mono_fast_ns(); 160da915ad5SPaul E. McKenney smp_store_release(&sp->srcu_gp_seq_needed, 0); /* Init done. */ 161da915ad5SPaul E. McKenney return sp->sda ? 0 : -ENOMEM; 162dad81a20SPaul E. McKenney } 163dad81a20SPaul E. McKenney 164dad81a20SPaul E. McKenney #ifdef CONFIG_DEBUG_LOCK_ALLOC 165dad81a20SPaul E. McKenney 166dad81a20SPaul E. McKenney int __init_srcu_struct(struct srcu_struct *sp, const char *name, 167dad81a20SPaul E. McKenney struct lock_class_key *key) 168dad81a20SPaul E. McKenney { 169dad81a20SPaul E. McKenney /* Don't re-initialize a lock while it is held. */ 170dad81a20SPaul E. McKenney debug_check_no_locks_freed((void *)sp, sizeof(*sp)); 171dad81a20SPaul E. McKenney lockdep_init_map(&sp->dep_map, name, key, 0); 172da915ad5SPaul E. McKenney spin_lock_init(&sp->gp_lock); 173da915ad5SPaul E. McKenney return init_srcu_struct_fields(sp, false); 174dad81a20SPaul E. McKenney } 175dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__init_srcu_struct); 176dad81a20SPaul E. McKenney 177dad81a20SPaul E. McKenney #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */ 178dad81a20SPaul E. McKenney 179dad81a20SPaul E. McKenney /** 180dad81a20SPaul E. McKenney * init_srcu_struct - initialize a sleep-RCU structure 181dad81a20SPaul E. McKenney * @sp: structure to initialize. 182dad81a20SPaul E. McKenney * 183dad81a20SPaul E. McKenney * Must invoke this on a given srcu_struct before passing that srcu_struct 184dad81a20SPaul E. McKenney * to any other function. Each srcu_struct represents a separate domain 185dad81a20SPaul E. McKenney * of SRCU protection. 186dad81a20SPaul E. McKenney */ 187dad81a20SPaul E. McKenney int init_srcu_struct(struct srcu_struct *sp) 188dad81a20SPaul E. McKenney { 189da915ad5SPaul E. McKenney spin_lock_init(&sp->gp_lock); 190da915ad5SPaul E. McKenney return init_srcu_struct_fields(sp, false); 191dad81a20SPaul E. McKenney } 192dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(init_srcu_struct); 193dad81a20SPaul E. McKenney 194dad81a20SPaul E. McKenney #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */ 195dad81a20SPaul E. McKenney 196dad81a20SPaul E. McKenney /* 197da915ad5SPaul E. McKenney * First-use initialization of statically allocated srcu_struct 198da915ad5SPaul E. McKenney * structure. Wiring up the combining tree is more than can be 199da915ad5SPaul E. McKenney * done with compile-time initialization, so this check is added 200da915ad5SPaul E. McKenney * to each update-side SRCU primitive. Use ->gp_lock, which -is- 201da915ad5SPaul E. McKenney * compile-time initialized, to resolve races involving multiple 202da915ad5SPaul E. McKenney * CPUs trying to garner first-use privileges. 203da915ad5SPaul E. McKenney */ 204da915ad5SPaul E. McKenney static void check_init_srcu_struct(struct srcu_struct *sp) 205da915ad5SPaul E. McKenney { 206da915ad5SPaul E. McKenney unsigned long flags; 207da915ad5SPaul E. McKenney 208da915ad5SPaul E. McKenney WARN_ON_ONCE(rcu_scheduler_active == RCU_SCHEDULER_INIT); 209da915ad5SPaul E. McKenney /* The smp_load_acquire() pairs with the smp_store_release(). */ 210da915ad5SPaul E. McKenney if (!rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq_needed))) /*^^^*/ 211da915ad5SPaul E. McKenney return; /* Already initialized. */ 212da915ad5SPaul E. McKenney spin_lock_irqsave(&sp->gp_lock, flags); 213da915ad5SPaul E. McKenney if (!rcu_seq_state(sp->srcu_gp_seq_needed)) { 214da915ad5SPaul E. McKenney spin_unlock_irqrestore(&sp->gp_lock, flags); 215da915ad5SPaul E. McKenney return; 216da915ad5SPaul E. McKenney } 217da915ad5SPaul E. McKenney init_srcu_struct_fields(sp, true); 218da915ad5SPaul E. McKenney spin_unlock_irqrestore(&sp->gp_lock, flags); 219da915ad5SPaul E. McKenney } 220da915ad5SPaul E. McKenney 221da915ad5SPaul E. McKenney /* 222da915ad5SPaul E. McKenney * Returns approximate total of the readers' ->srcu_lock_count[] values 223da915ad5SPaul E. McKenney * for the rank of per-CPU counters specified by idx. 224dad81a20SPaul E. McKenney */ 225dad81a20SPaul E. McKenney static unsigned long srcu_readers_lock_idx(struct srcu_struct *sp, int idx) 226dad81a20SPaul E. McKenney { 227dad81a20SPaul E. McKenney int cpu; 228dad81a20SPaul E. McKenney unsigned long sum = 0; 229dad81a20SPaul E. McKenney 230dad81a20SPaul E. McKenney for_each_possible_cpu(cpu) { 231da915ad5SPaul E. McKenney struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu); 232dad81a20SPaul E. McKenney 233da915ad5SPaul E. McKenney sum += READ_ONCE(cpuc->srcu_lock_count[idx]); 234dad81a20SPaul E. McKenney } 235dad81a20SPaul E. McKenney return sum; 236dad81a20SPaul E. McKenney } 237dad81a20SPaul E. McKenney 238dad81a20SPaul E. McKenney /* 239da915ad5SPaul E. McKenney * Returns approximate total of the readers' ->srcu_unlock_count[] values 240da915ad5SPaul E. McKenney * for the rank of per-CPU counters specified by idx. 241dad81a20SPaul E. McKenney */ 242dad81a20SPaul E. McKenney static unsigned long srcu_readers_unlock_idx(struct srcu_struct *sp, int idx) 243dad81a20SPaul E. McKenney { 244dad81a20SPaul E. McKenney int cpu; 245dad81a20SPaul E. McKenney unsigned long sum = 0; 246dad81a20SPaul E. McKenney 247dad81a20SPaul E. McKenney for_each_possible_cpu(cpu) { 248da915ad5SPaul E. McKenney struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu); 249dad81a20SPaul E. McKenney 250da915ad5SPaul E. McKenney sum += READ_ONCE(cpuc->srcu_unlock_count[idx]); 251dad81a20SPaul E. McKenney } 252dad81a20SPaul E. McKenney return sum; 253dad81a20SPaul E. McKenney } 254dad81a20SPaul E. McKenney 255dad81a20SPaul E. McKenney /* 256dad81a20SPaul E. McKenney * Return true if the number of pre-existing readers is determined to 257dad81a20SPaul E. McKenney * be zero. 258dad81a20SPaul E. McKenney */ 259dad81a20SPaul E. McKenney static bool srcu_readers_active_idx_check(struct srcu_struct *sp, int idx) 260dad81a20SPaul E. McKenney { 261dad81a20SPaul E. McKenney unsigned long unlocks; 262dad81a20SPaul E. McKenney 263dad81a20SPaul E. McKenney unlocks = srcu_readers_unlock_idx(sp, idx); 264dad81a20SPaul E. McKenney 265dad81a20SPaul E. McKenney /* 266dad81a20SPaul E. McKenney * Make sure that a lock is always counted if the corresponding 267dad81a20SPaul E. McKenney * unlock is counted. Needs to be a smp_mb() as the read side may 268dad81a20SPaul E. McKenney * contain a read from a variable that is written to before the 269dad81a20SPaul E. McKenney * synchronize_srcu() in the write side. In this case smp_mb()s 270dad81a20SPaul E. McKenney * A and B act like the store buffering pattern. 271dad81a20SPaul E. McKenney * 272dad81a20SPaul E. McKenney * This smp_mb() also pairs with smp_mb() C to prevent accesses 273dad81a20SPaul E. McKenney * after the synchronize_srcu() from being executed before the 274dad81a20SPaul E. McKenney * grace period ends. 275dad81a20SPaul E. McKenney */ 276dad81a20SPaul E. McKenney smp_mb(); /* A */ 277dad81a20SPaul E. McKenney 278dad81a20SPaul E. McKenney /* 279dad81a20SPaul E. McKenney * If the locks are the same as the unlocks, then there must have 280dad81a20SPaul E. McKenney * been no readers on this index at some time in between. This does 281dad81a20SPaul E. McKenney * not mean that there are no more readers, as one could have read 282dad81a20SPaul E. McKenney * the current index but not have incremented the lock counter yet. 283dad81a20SPaul E. McKenney * 284881ec9d2SPaul E. McKenney * So suppose that the updater is preempted here for so long 285881ec9d2SPaul E. McKenney * that more than ULONG_MAX non-nested readers come and go in 286881ec9d2SPaul E. McKenney * the meantime. It turns out that this cannot result in overflow 287881ec9d2SPaul E. McKenney * because if a reader modifies its unlock count after we read it 288881ec9d2SPaul E. McKenney * above, then that reader's next load of ->srcu_idx is guaranteed 289881ec9d2SPaul E. McKenney * to get the new value, which will cause it to operate on the 290881ec9d2SPaul E. McKenney * other bank of counters, where it cannot contribute to the 291881ec9d2SPaul E. McKenney * overflow of these counters. This means that there is a maximum 292881ec9d2SPaul E. McKenney * of 2*NR_CPUS increments, which cannot overflow given current 293881ec9d2SPaul E. McKenney * systems, especially not on 64-bit systems. 294881ec9d2SPaul E. McKenney * 295881ec9d2SPaul E. McKenney * OK, how about nesting? This does impose a limit on nesting 296881ec9d2SPaul E. McKenney * of floor(ULONG_MAX/NR_CPUS/2), which should be sufficient, 297881ec9d2SPaul E. McKenney * especially on 64-bit systems. 298dad81a20SPaul E. McKenney */ 299dad81a20SPaul E. McKenney return srcu_readers_lock_idx(sp, idx) == unlocks; 300dad81a20SPaul E. McKenney } 301dad81a20SPaul E. McKenney 302dad81a20SPaul E. McKenney /** 303dad81a20SPaul E. McKenney * srcu_readers_active - returns true if there are readers. and false 304dad81a20SPaul E. McKenney * otherwise 305dad81a20SPaul E. McKenney * @sp: which srcu_struct to count active readers (holding srcu_read_lock). 306dad81a20SPaul E. McKenney * 307dad81a20SPaul E. McKenney * Note that this is not an atomic primitive, and can therefore suffer 308dad81a20SPaul E. McKenney * severe errors when invoked on an active srcu_struct. That said, it 309dad81a20SPaul E. McKenney * can be useful as an error check at cleanup time. 310dad81a20SPaul E. McKenney */ 311dad81a20SPaul E. McKenney static bool srcu_readers_active(struct srcu_struct *sp) 312dad81a20SPaul E. McKenney { 313dad81a20SPaul E. McKenney int cpu; 314dad81a20SPaul E. McKenney unsigned long sum = 0; 315dad81a20SPaul E. McKenney 316dad81a20SPaul E. McKenney for_each_possible_cpu(cpu) { 317da915ad5SPaul E. McKenney struct srcu_data *cpuc = per_cpu_ptr(sp->sda, cpu); 318dad81a20SPaul E. McKenney 319da915ad5SPaul E. McKenney sum += READ_ONCE(cpuc->srcu_lock_count[0]); 320da915ad5SPaul E. McKenney sum += READ_ONCE(cpuc->srcu_lock_count[1]); 321da915ad5SPaul E. McKenney sum -= READ_ONCE(cpuc->srcu_unlock_count[0]); 322da915ad5SPaul E. McKenney sum -= READ_ONCE(cpuc->srcu_unlock_count[1]); 323dad81a20SPaul E. McKenney } 324dad81a20SPaul E. McKenney return sum; 325dad81a20SPaul E. McKenney } 326dad81a20SPaul E. McKenney 327dad81a20SPaul E. McKenney #define SRCU_INTERVAL 1 328dad81a20SPaul E. McKenney 3291e9a038bSPaul E. McKenney /* 3301e9a038bSPaul E. McKenney * Return grace-period delay, zero if there are expedited grace 3311e9a038bSPaul E. McKenney * periods pending, SRCU_INTERVAL otherwise. 3321e9a038bSPaul E. McKenney */ 3331e9a038bSPaul E. McKenney static unsigned long srcu_get_delay(struct srcu_struct *sp) 3341e9a038bSPaul E. McKenney { 3351e9a038bSPaul E. McKenney if (ULONG_CMP_LT(READ_ONCE(sp->srcu_gp_seq), 3361e9a038bSPaul E. McKenney READ_ONCE(sp->srcu_gp_seq_needed_exp))) 3371e9a038bSPaul E. McKenney return 0; 3381e9a038bSPaul E. McKenney return SRCU_INTERVAL; 3391e9a038bSPaul E. McKenney } 3401e9a038bSPaul E. McKenney 341dad81a20SPaul E. McKenney /** 342dad81a20SPaul E. McKenney * cleanup_srcu_struct - deconstruct a sleep-RCU structure 343dad81a20SPaul E. McKenney * @sp: structure to clean up. 344dad81a20SPaul E. McKenney * 345dad81a20SPaul E. McKenney * Must invoke this after you are finished using a given srcu_struct that 346dad81a20SPaul E. McKenney * was initialized via init_srcu_struct(), else you leak memory. 347dad81a20SPaul E. McKenney */ 348dad81a20SPaul E. McKenney void cleanup_srcu_struct(struct srcu_struct *sp) 349dad81a20SPaul E. McKenney { 350da915ad5SPaul E. McKenney int cpu; 351da915ad5SPaul E. McKenney 3521e9a038bSPaul E. McKenney if (WARN_ON(!srcu_get_delay(sp))) 3531e9a038bSPaul E. McKenney return; /* Leakage unless caller handles error. */ 354dad81a20SPaul E. McKenney if (WARN_ON(srcu_readers_active(sp))) 355dad81a20SPaul E. McKenney return; /* Leakage unless caller handles error. */ 356dad81a20SPaul E. McKenney flush_delayed_work(&sp->work); 357da915ad5SPaul E. McKenney for_each_possible_cpu(cpu) 358da915ad5SPaul E. McKenney flush_delayed_work(&per_cpu_ptr(sp->sda, cpu)->work); 359da915ad5SPaul E. McKenney if (WARN_ON(rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) != SRCU_STATE_IDLE) || 360da915ad5SPaul E. McKenney WARN_ON(srcu_readers_active(sp))) { 361da915ad5SPaul E. McKenney pr_info("cleanup_srcu_struct: Active srcu_struct %p state: %d\n", sp, rcu_seq_state(READ_ONCE(sp->srcu_gp_seq))); 362dad81a20SPaul E. McKenney return; /* Caller forgot to stop doing call_srcu()? */ 363dad81a20SPaul E. McKenney } 364da915ad5SPaul E. McKenney free_percpu(sp->sda); 365da915ad5SPaul E. McKenney sp->sda = NULL; 366dad81a20SPaul E. McKenney } 367dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(cleanup_srcu_struct); 368dad81a20SPaul E. McKenney 369dad81a20SPaul E. McKenney /* 370dad81a20SPaul E. McKenney * Counts the new reader in the appropriate per-CPU element of the 371cdf7abc4SPaolo Bonzini * srcu_struct. 372dad81a20SPaul E. McKenney * Returns an index that must be passed to the matching srcu_read_unlock(). 373dad81a20SPaul E. McKenney */ 374dad81a20SPaul E. McKenney int __srcu_read_lock(struct srcu_struct *sp) 375dad81a20SPaul E. McKenney { 376dad81a20SPaul E. McKenney int idx; 377dad81a20SPaul E. McKenney 378da915ad5SPaul E. McKenney idx = READ_ONCE(sp->srcu_idx) & 0x1; 379cdf7abc4SPaolo Bonzini this_cpu_inc(sp->sda->srcu_lock_count[idx]); 380dad81a20SPaul E. McKenney smp_mb(); /* B */ /* Avoid leaking the critical section. */ 381dad81a20SPaul E. McKenney return idx; 382dad81a20SPaul E. McKenney } 383dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_lock); 384dad81a20SPaul E. McKenney 385dad81a20SPaul E. McKenney /* 386dad81a20SPaul E. McKenney * Removes the count for the old reader from the appropriate per-CPU 387dad81a20SPaul E. McKenney * element of the srcu_struct. Note that this may well be a different 388dad81a20SPaul E. McKenney * CPU than that which was incremented by the corresponding srcu_read_lock(). 389dad81a20SPaul E. McKenney */ 390dad81a20SPaul E. McKenney void __srcu_read_unlock(struct srcu_struct *sp, int idx) 391dad81a20SPaul E. McKenney { 392dad81a20SPaul E. McKenney smp_mb(); /* C */ /* Avoid leaking the critical section. */ 393da915ad5SPaul E. McKenney this_cpu_inc(sp->sda->srcu_unlock_count[idx]); 394dad81a20SPaul E. McKenney } 395dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(__srcu_read_unlock); 396dad81a20SPaul E. McKenney 397dad81a20SPaul E. McKenney /* 398dad81a20SPaul E. McKenney * We use an adaptive strategy for synchronize_srcu() and especially for 399dad81a20SPaul E. McKenney * synchronize_srcu_expedited(). We spin for a fixed time period 400dad81a20SPaul E. McKenney * (defined below) to allow SRCU readers to exit their read-side critical 401dad81a20SPaul E. McKenney * sections. If there are still some readers after a few microseconds, 402dad81a20SPaul E. McKenney * we repeatedly block for 1-millisecond time periods. 403dad81a20SPaul E. McKenney */ 404dad81a20SPaul E. McKenney #define SRCU_RETRY_CHECK_DELAY 5 405dad81a20SPaul E. McKenney 406dad81a20SPaul E. McKenney /* 407dad81a20SPaul E. McKenney * Start an SRCU grace period. 408dad81a20SPaul E. McKenney */ 409dad81a20SPaul E. McKenney static void srcu_gp_start(struct srcu_struct *sp) 410dad81a20SPaul E. McKenney { 411da915ad5SPaul E. McKenney struct srcu_data *sdp = this_cpu_ptr(sp->sda); 412dad81a20SPaul E. McKenney int state; 413dad81a20SPaul E. McKenney 414da915ad5SPaul E. McKenney RCU_LOCKDEP_WARN(!lockdep_is_held(&sp->gp_lock), 415da915ad5SPaul E. McKenney "Invoked srcu_gp_start() without ->gp_lock!"); 416da915ad5SPaul E. McKenney WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)); 417da915ad5SPaul E. McKenney rcu_segcblist_advance(&sdp->srcu_cblist, 418da915ad5SPaul E. McKenney rcu_seq_current(&sp->srcu_gp_seq)); 419da915ad5SPaul E. McKenney (void)rcu_segcblist_accelerate(&sdp->srcu_cblist, 420dad81a20SPaul E. McKenney rcu_seq_snap(&sp->srcu_gp_seq)); 4212da4b2a7SPaul E. McKenney smp_mb(); /* Order prior store to ->srcu_gp_seq_needed vs. GP start. */ 422dad81a20SPaul E. McKenney rcu_seq_start(&sp->srcu_gp_seq); 423dad81a20SPaul E. McKenney state = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)); 424dad81a20SPaul E. McKenney WARN_ON_ONCE(state != SRCU_STATE_SCAN1); 425dad81a20SPaul E. McKenney } 426dad81a20SPaul E. McKenney 427dad81a20SPaul E. McKenney /* 428da915ad5SPaul E. McKenney * Track online CPUs to guide callback workqueue placement. 429da915ad5SPaul E. McKenney */ 430da915ad5SPaul E. McKenney DEFINE_PER_CPU(bool, srcu_online); 431da915ad5SPaul E. McKenney 432da915ad5SPaul E. McKenney void srcu_online_cpu(unsigned int cpu) 433da915ad5SPaul E. McKenney { 434da915ad5SPaul E. McKenney WRITE_ONCE(per_cpu(srcu_online, cpu), true); 435da915ad5SPaul E. McKenney } 436da915ad5SPaul E. McKenney 437da915ad5SPaul E. McKenney void srcu_offline_cpu(unsigned int cpu) 438da915ad5SPaul E. McKenney { 439da915ad5SPaul E. McKenney WRITE_ONCE(per_cpu(srcu_online, cpu), false); 440da915ad5SPaul E. McKenney } 441da915ad5SPaul E. McKenney 442da915ad5SPaul E. McKenney /* 443da915ad5SPaul E. McKenney * Place the workqueue handler on the specified CPU if online, otherwise 444da915ad5SPaul E. McKenney * just run it whereever. This is useful for placing workqueue handlers 445da915ad5SPaul E. McKenney * that are to invoke the specified CPU's callbacks. 446da915ad5SPaul E. McKenney */ 447da915ad5SPaul E. McKenney static bool srcu_queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 448da915ad5SPaul E. McKenney struct delayed_work *dwork, 449da915ad5SPaul E. McKenney unsigned long delay) 450da915ad5SPaul E. McKenney { 451da915ad5SPaul E. McKenney bool ret; 452da915ad5SPaul E. McKenney 453da915ad5SPaul E. McKenney preempt_disable(); 454da915ad5SPaul E. McKenney if (READ_ONCE(per_cpu(srcu_online, cpu))) 455da915ad5SPaul E. McKenney ret = queue_delayed_work_on(cpu, wq, dwork, delay); 456da915ad5SPaul E. McKenney else 457da915ad5SPaul E. McKenney ret = queue_delayed_work(wq, dwork, delay); 458da915ad5SPaul E. McKenney preempt_enable(); 459da915ad5SPaul E. McKenney return ret; 460da915ad5SPaul E. McKenney } 461da915ad5SPaul E. McKenney 462da915ad5SPaul E. McKenney /* 463da915ad5SPaul E. McKenney * Schedule callback invocation for the specified srcu_data structure, 464da915ad5SPaul E. McKenney * if possible, on the corresponding CPU. 465da915ad5SPaul E. McKenney */ 466da915ad5SPaul E. McKenney static void srcu_schedule_cbs_sdp(struct srcu_data *sdp, unsigned long delay) 467da915ad5SPaul E. McKenney { 468da915ad5SPaul E. McKenney srcu_queue_delayed_work_on(sdp->cpu, system_power_efficient_wq, 469da915ad5SPaul E. McKenney &sdp->work, delay); 470da915ad5SPaul E. McKenney } 471da915ad5SPaul E. McKenney 472da915ad5SPaul E. McKenney /* 473da915ad5SPaul E. McKenney * Schedule callback invocation for all srcu_data structures associated 474c7e88067SPaul E. McKenney * with the specified srcu_node structure that have callbacks for the 475c7e88067SPaul E. McKenney * just-completed grace period, the one corresponding to idx. If possible, 476c7e88067SPaul E. McKenney * schedule this invocation on the corresponding CPUs. 477da915ad5SPaul E. McKenney */ 478c7e88067SPaul E. McKenney static void srcu_schedule_cbs_snp(struct srcu_struct *sp, struct srcu_node *snp, 4791e9a038bSPaul E. McKenney unsigned long mask, unsigned long delay) 480da915ad5SPaul E. McKenney { 481da915ad5SPaul E. McKenney int cpu; 482da915ad5SPaul E. McKenney 483c7e88067SPaul E. McKenney for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) { 484c7e88067SPaul E. McKenney if (!(mask & (1 << (cpu - snp->grplo)))) 485c7e88067SPaul E. McKenney continue; 4861e9a038bSPaul E. McKenney srcu_schedule_cbs_sdp(per_cpu_ptr(sp->sda, cpu), delay); 487da915ad5SPaul E. McKenney } 488c7e88067SPaul E. McKenney } 489da915ad5SPaul E. McKenney 490da915ad5SPaul E. McKenney /* 491da915ad5SPaul E. McKenney * Note the end of an SRCU grace period. Initiates callback invocation 492da915ad5SPaul E. McKenney * and starts a new grace period if needed. 493da915ad5SPaul E. McKenney * 494da915ad5SPaul E. McKenney * The ->srcu_cb_mutex acquisition does not protect any data, but 495da915ad5SPaul E. McKenney * instead prevents more than one grace period from starting while we 496da915ad5SPaul E. McKenney * are initiating callback invocation. This allows the ->srcu_have_cbs[] 497da915ad5SPaul E. McKenney * array to have a finite number of elements. 498da915ad5SPaul E. McKenney */ 499da915ad5SPaul E. McKenney static void srcu_gp_end(struct srcu_struct *sp) 500da915ad5SPaul E. McKenney { 5011e9a038bSPaul E. McKenney unsigned long cbdelay; 502da915ad5SPaul E. McKenney bool cbs; 503c350c008SPaul E. McKenney int cpu; 504c350c008SPaul E. McKenney unsigned long flags; 505da915ad5SPaul E. McKenney unsigned long gpseq; 506da915ad5SPaul E. McKenney int idx; 507da915ad5SPaul E. McKenney int idxnext; 508c7e88067SPaul E. McKenney unsigned long mask; 509c350c008SPaul E. McKenney struct srcu_data *sdp; 510da915ad5SPaul E. McKenney struct srcu_node *snp; 511da915ad5SPaul E. McKenney 512da915ad5SPaul E. McKenney /* Prevent more than one additional grace period. */ 513da915ad5SPaul E. McKenney mutex_lock(&sp->srcu_cb_mutex); 514da915ad5SPaul E. McKenney 515da915ad5SPaul E. McKenney /* End the current grace period. */ 516da915ad5SPaul E. McKenney spin_lock_irq(&sp->gp_lock); 517da915ad5SPaul E. McKenney idx = rcu_seq_state(sp->srcu_gp_seq); 518da915ad5SPaul E. McKenney WARN_ON_ONCE(idx != SRCU_STATE_SCAN2); 5191e9a038bSPaul E. McKenney cbdelay = srcu_get_delay(sp); 52022607d66SPaul E. McKenney sp->srcu_last_gp_end = ktime_get_mono_fast_ns(); 521da915ad5SPaul E. McKenney rcu_seq_end(&sp->srcu_gp_seq); 522da915ad5SPaul E. McKenney gpseq = rcu_seq_current(&sp->srcu_gp_seq); 5231e9a038bSPaul E. McKenney if (ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, gpseq)) 5241e9a038bSPaul E. McKenney sp->srcu_gp_seq_needed_exp = gpseq; 525da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 526da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_gp_mutex); 527da915ad5SPaul E. McKenney /* A new grace period can start at this point. But only one. */ 528da915ad5SPaul E. McKenney 529da915ad5SPaul E. McKenney /* Initiate callback invocation as needed. */ 530da915ad5SPaul E. McKenney idx = rcu_seq_ctr(gpseq) % ARRAY_SIZE(snp->srcu_have_cbs); 531da915ad5SPaul E. McKenney idxnext = (idx + 1) % ARRAY_SIZE(snp->srcu_have_cbs); 532da915ad5SPaul E. McKenney rcu_for_each_node_breadth_first(sp, snp) { 533da915ad5SPaul E. McKenney spin_lock_irq(&snp->lock); 534da915ad5SPaul E. McKenney cbs = false; 535da915ad5SPaul E. McKenney if (snp >= sp->level[rcu_num_lvls - 1]) 536da915ad5SPaul E. McKenney cbs = snp->srcu_have_cbs[idx] == gpseq; 537da915ad5SPaul E. McKenney snp->srcu_have_cbs[idx] = gpseq; 538da915ad5SPaul E. McKenney rcu_seq_set_state(&snp->srcu_have_cbs[idx], 1); 5391e9a038bSPaul E. McKenney if (ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, gpseq)) 5401e9a038bSPaul E. McKenney snp->srcu_gp_seq_needed_exp = gpseq; 541c7e88067SPaul E. McKenney mask = snp->srcu_data_have_cbs[idx]; 542c7e88067SPaul E. McKenney snp->srcu_data_have_cbs[idx] = 0; 543da915ad5SPaul E. McKenney spin_unlock_irq(&snp->lock); 544da915ad5SPaul E. McKenney if (cbs) { 545da915ad5SPaul E. McKenney smp_mb(); /* GP end before CB invocation. */ 5461e9a038bSPaul E. McKenney srcu_schedule_cbs_snp(sp, snp, mask, cbdelay); 547da915ad5SPaul E. McKenney } 548c350c008SPaul E. McKenney 549c350c008SPaul E. McKenney /* Occasionally prevent srcu_data counter wrap. */ 550c350c008SPaul E. McKenney if (!(gpseq & counter_wrap_check)) 551c350c008SPaul E. McKenney for (cpu = snp->grplo; cpu <= snp->grphi; cpu++) { 552c350c008SPaul E. McKenney sdp = per_cpu_ptr(sp->sda, cpu); 553c350c008SPaul E. McKenney spin_lock_irqsave(&sdp->lock, flags); 554c350c008SPaul E. McKenney if (ULONG_CMP_GE(gpseq, 555c350c008SPaul E. McKenney sdp->srcu_gp_seq_needed + 100)) 556c350c008SPaul E. McKenney sdp->srcu_gp_seq_needed = gpseq; 557c350c008SPaul E. McKenney spin_unlock_irqrestore(&sdp->lock, flags); 558c350c008SPaul E. McKenney } 559da915ad5SPaul E. McKenney } 560da915ad5SPaul E. McKenney 561da915ad5SPaul E. McKenney /* Callback initiation done, allow grace periods after next. */ 562da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_cb_mutex); 563da915ad5SPaul E. McKenney 564da915ad5SPaul E. McKenney /* Start a new grace period if needed. */ 565da915ad5SPaul E. McKenney spin_lock_irq(&sp->gp_lock); 566da915ad5SPaul E. McKenney gpseq = rcu_seq_current(&sp->srcu_gp_seq); 567da915ad5SPaul E. McKenney if (!rcu_seq_state(gpseq) && 568da915ad5SPaul E. McKenney ULONG_CMP_LT(gpseq, sp->srcu_gp_seq_needed)) { 569da915ad5SPaul E. McKenney srcu_gp_start(sp); 570da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 571da915ad5SPaul E. McKenney /* Throttle expedited grace periods: Should be rare! */ 5721e9a038bSPaul E. McKenney srcu_reschedule(sp, rcu_seq_ctr(gpseq) & 0x3ff 5731e9a038bSPaul E. McKenney ? 0 : SRCU_INTERVAL); 574da915ad5SPaul E. McKenney } else { 575da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 576da915ad5SPaul E. McKenney } 577da915ad5SPaul E. McKenney } 578da915ad5SPaul E. McKenney 579da915ad5SPaul E. McKenney /* 5801e9a038bSPaul E. McKenney * Funnel-locking scheme to scalably mediate many concurrent expedited 5811e9a038bSPaul E. McKenney * grace-period requests. This function is invoked for the first known 5821e9a038bSPaul E. McKenney * expedited request for a grace period that has already been requested, 5831e9a038bSPaul E. McKenney * but without expediting. To start a completely new grace period, 5841e9a038bSPaul E. McKenney * whether expedited or not, use srcu_funnel_gp_start() instead. 5851e9a038bSPaul E. McKenney */ 5861e9a038bSPaul E. McKenney static void srcu_funnel_exp_start(struct srcu_struct *sp, struct srcu_node *snp, 5871e9a038bSPaul E. McKenney unsigned long s) 5881e9a038bSPaul E. McKenney { 5891e9a038bSPaul E. McKenney unsigned long flags; 5901e9a038bSPaul E. McKenney 5911e9a038bSPaul E. McKenney for (; snp != NULL; snp = snp->srcu_parent) { 5921e9a038bSPaul E. McKenney if (rcu_seq_done(&sp->srcu_gp_seq, s) || 5931e9a038bSPaul E. McKenney ULONG_CMP_GE(READ_ONCE(snp->srcu_gp_seq_needed_exp), s)) 5941e9a038bSPaul E. McKenney return; 5951e9a038bSPaul E. McKenney spin_lock_irqsave(&snp->lock, flags); 5961e9a038bSPaul E. McKenney if (ULONG_CMP_GE(snp->srcu_gp_seq_needed_exp, s)) { 5971e9a038bSPaul E. McKenney spin_unlock_irqrestore(&snp->lock, flags); 5981e9a038bSPaul E. McKenney return; 5991e9a038bSPaul E. McKenney } 6001e9a038bSPaul E. McKenney WRITE_ONCE(snp->srcu_gp_seq_needed_exp, s); 6011e9a038bSPaul E. McKenney spin_unlock_irqrestore(&snp->lock, flags); 6021e9a038bSPaul E. McKenney } 6031e9a038bSPaul E. McKenney spin_lock_irqsave(&sp->gp_lock, flags); 6041e9a038bSPaul E. McKenney if (!ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s)) 6051e9a038bSPaul E. McKenney sp->srcu_gp_seq_needed_exp = s; 6061e9a038bSPaul E. McKenney spin_unlock_irqrestore(&sp->gp_lock, flags); 6071e9a038bSPaul E. McKenney } 6081e9a038bSPaul E. McKenney 6091e9a038bSPaul E. McKenney /* 610da915ad5SPaul E. McKenney * Funnel-locking scheme to scalably mediate many concurrent grace-period 611da915ad5SPaul E. McKenney * requests. The winner has to do the work of actually starting grace 612da915ad5SPaul E. McKenney * period s. Losers must either ensure that their desired grace-period 613da915ad5SPaul E. McKenney * number is recorded on at least their leaf srcu_node structure, or they 614da915ad5SPaul E. McKenney * must take steps to invoke their own callbacks. 615da915ad5SPaul E. McKenney */ 6161e9a038bSPaul E. McKenney static void srcu_funnel_gp_start(struct srcu_struct *sp, struct srcu_data *sdp, 6171e9a038bSPaul E. McKenney unsigned long s, bool do_norm) 618da915ad5SPaul E. McKenney { 619da915ad5SPaul E. McKenney unsigned long flags; 620da915ad5SPaul E. McKenney int idx = rcu_seq_ctr(s) % ARRAY_SIZE(sdp->mynode->srcu_have_cbs); 621da915ad5SPaul E. McKenney struct srcu_node *snp = sdp->mynode; 622da915ad5SPaul E. McKenney unsigned long snp_seq; 623da915ad5SPaul E. McKenney 624da915ad5SPaul E. McKenney /* Each pass through the loop does one level of the srcu_node tree. */ 625da915ad5SPaul E. McKenney for (; snp != NULL; snp = snp->srcu_parent) { 626da915ad5SPaul E. McKenney if (rcu_seq_done(&sp->srcu_gp_seq, s) && snp != sdp->mynode) 627da915ad5SPaul E. McKenney return; /* GP already done and CBs recorded. */ 628da915ad5SPaul E. McKenney spin_lock_irqsave(&snp->lock, flags); 629da915ad5SPaul E. McKenney if (ULONG_CMP_GE(snp->srcu_have_cbs[idx], s)) { 630da915ad5SPaul E. McKenney snp_seq = snp->srcu_have_cbs[idx]; 631c7e88067SPaul E. McKenney if (snp == sdp->mynode && snp_seq == s) 632c7e88067SPaul E. McKenney snp->srcu_data_have_cbs[idx] |= sdp->grpmask; 633da915ad5SPaul E. McKenney spin_unlock_irqrestore(&snp->lock, flags); 634da915ad5SPaul E. McKenney if (snp == sdp->mynode && snp_seq != s) { 635da915ad5SPaul E. McKenney smp_mb(); /* CBs after GP! */ 6361e9a038bSPaul E. McKenney srcu_schedule_cbs_sdp(sdp, do_norm 6371e9a038bSPaul E. McKenney ? SRCU_INTERVAL 6381e9a038bSPaul E. McKenney : 0); 6391e9a038bSPaul E. McKenney return; 640da915ad5SPaul E. McKenney } 6411e9a038bSPaul E. McKenney if (!do_norm) 6421e9a038bSPaul E. McKenney srcu_funnel_exp_start(sp, snp, s); 643da915ad5SPaul E. McKenney return; 644da915ad5SPaul E. McKenney } 645da915ad5SPaul E. McKenney snp->srcu_have_cbs[idx] = s; 646c7e88067SPaul E. McKenney if (snp == sdp->mynode) 647c7e88067SPaul E. McKenney snp->srcu_data_have_cbs[idx] |= sdp->grpmask; 6481e9a038bSPaul E. McKenney if (!do_norm && ULONG_CMP_LT(snp->srcu_gp_seq_needed_exp, s)) 6491e9a038bSPaul E. McKenney snp->srcu_gp_seq_needed_exp = s; 650da915ad5SPaul E. McKenney spin_unlock_irqrestore(&snp->lock, flags); 651da915ad5SPaul E. McKenney } 652da915ad5SPaul E. McKenney 653da915ad5SPaul E. McKenney /* Top of tree, must ensure the grace period will be started. */ 654da915ad5SPaul E. McKenney spin_lock_irqsave(&sp->gp_lock, flags); 655da915ad5SPaul E. McKenney if (ULONG_CMP_LT(sp->srcu_gp_seq_needed, s)) { 656da915ad5SPaul E. McKenney /* 657da915ad5SPaul E. McKenney * Record need for grace period s. Pair with load 658da915ad5SPaul E. McKenney * acquire setting up for initialization. 659da915ad5SPaul E. McKenney */ 660da915ad5SPaul E. McKenney smp_store_release(&sp->srcu_gp_seq_needed, s); /*^^^*/ 661da915ad5SPaul E. McKenney } 6621e9a038bSPaul E. McKenney if (!do_norm && ULONG_CMP_LT(sp->srcu_gp_seq_needed_exp, s)) 6631e9a038bSPaul E. McKenney sp->srcu_gp_seq_needed_exp = s; 664da915ad5SPaul E. McKenney 665da915ad5SPaul E. McKenney /* If grace period not already done and none in progress, start it. */ 666da915ad5SPaul E. McKenney if (!rcu_seq_done(&sp->srcu_gp_seq, s) && 667da915ad5SPaul E. McKenney rcu_seq_state(sp->srcu_gp_seq) == SRCU_STATE_IDLE) { 668da915ad5SPaul E. McKenney WARN_ON_ONCE(ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)); 669da915ad5SPaul E. McKenney srcu_gp_start(sp); 670da915ad5SPaul E. McKenney queue_delayed_work(system_power_efficient_wq, &sp->work, 6711e9a038bSPaul E. McKenney srcu_get_delay(sp)); 672da915ad5SPaul E. McKenney } 673da915ad5SPaul E. McKenney spin_unlock_irqrestore(&sp->gp_lock, flags); 674da915ad5SPaul E. McKenney } 675da915ad5SPaul E. McKenney 676da915ad5SPaul E. McKenney /* 677dad81a20SPaul E. McKenney * Wait until all readers counted by array index idx complete, but 678dad81a20SPaul E. McKenney * loop an additional time if there is an expedited grace period pending. 679da915ad5SPaul E. McKenney * The caller must ensure that ->srcu_idx is not changed while checking. 680dad81a20SPaul E. McKenney */ 681dad81a20SPaul E. McKenney static bool try_check_zero(struct srcu_struct *sp, int idx, int trycount) 682dad81a20SPaul E. McKenney { 683dad81a20SPaul E. McKenney for (;;) { 684dad81a20SPaul E. McKenney if (srcu_readers_active_idx_check(sp, idx)) 685dad81a20SPaul E. McKenney return true; 6861e9a038bSPaul E. McKenney if (--trycount + !srcu_get_delay(sp) <= 0) 687dad81a20SPaul E. McKenney return false; 688dad81a20SPaul E. McKenney udelay(SRCU_RETRY_CHECK_DELAY); 689dad81a20SPaul E. McKenney } 690dad81a20SPaul E. McKenney } 691dad81a20SPaul E. McKenney 692dad81a20SPaul E. McKenney /* 693da915ad5SPaul E. McKenney * Increment the ->srcu_idx counter so that future SRCU readers will 694da915ad5SPaul E. McKenney * use the other rank of the ->srcu_(un)lock_count[] arrays. This allows 695dad81a20SPaul E. McKenney * us to wait for pre-existing readers in a starvation-free manner. 696dad81a20SPaul E. McKenney */ 697dad81a20SPaul E. McKenney static void srcu_flip(struct srcu_struct *sp) 698dad81a20SPaul E. McKenney { 699881ec9d2SPaul E. McKenney /* 700881ec9d2SPaul E. McKenney * Ensure that if this updater saw a given reader's increment 701881ec9d2SPaul E. McKenney * from __srcu_read_lock(), that reader was using an old value 702881ec9d2SPaul E. McKenney * of ->srcu_idx. Also ensure that if a given reader sees the 703881ec9d2SPaul E. McKenney * new value of ->srcu_idx, this updater's earlier scans cannot 704881ec9d2SPaul E. McKenney * have seen that reader's increments (which is OK, because this 705881ec9d2SPaul E. McKenney * grace period need not wait on that reader). 706881ec9d2SPaul E. McKenney */ 707881ec9d2SPaul E. McKenney smp_mb(); /* E */ /* Pairs with B and C. */ 708881ec9d2SPaul E. McKenney 709da915ad5SPaul E. McKenney WRITE_ONCE(sp->srcu_idx, sp->srcu_idx + 1); 710dad81a20SPaul E. McKenney 711dad81a20SPaul E. McKenney /* 712dad81a20SPaul E. McKenney * Ensure that if the updater misses an __srcu_read_unlock() 713dad81a20SPaul E. McKenney * increment, that task's next __srcu_read_lock() will see the 714dad81a20SPaul E. McKenney * above counter update. Note that both this memory barrier 715dad81a20SPaul E. McKenney * and the one in srcu_readers_active_idx_check() provide the 716dad81a20SPaul E. McKenney * guarantee for __srcu_read_lock(). 717dad81a20SPaul E. McKenney */ 718dad81a20SPaul E. McKenney smp_mb(); /* D */ /* Pairs with C. */ 719dad81a20SPaul E. McKenney } 720dad81a20SPaul E. McKenney 721dad81a20SPaul E. McKenney /* 7222da4b2a7SPaul E. McKenney * If SRCU is likely idle, return true, otherwise return false. 7232da4b2a7SPaul E. McKenney * 7242da4b2a7SPaul E. McKenney * Note that it is OK for several current from-idle requests for a new 7252da4b2a7SPaul E. McKenney * grace period from idle to specify expediting because they will all end 7262da4b2a7SPaul E. McKenney * up requesting the same grace period anyhow. So no loss. 7272da4b2a7SPaul E. McKenney * 7282da4b2a7SPaul E. McKenney * Note also that if any CPU (including the current one) is still invoking 7292da4b2a7SPaul E. McKenney * callbacks, this function will nevertheless say "idle". This is not 7302da4b2a7SPaul E. McKenney * ideal, but the overhead of checking all CPUs' callback lists is even 7312da4b2a7SPaul E. McKenney * less ideal, especially on large systems. Furthermore, the wakeup 7322da4b2a7SPaul E. McKenney * can happen before the callback is fully removed, so we have no choice 7332da4b2a7SPaul E. McKenney * but to accept this type of error. 7342da4b2a7SPaul E. McKenney * 7352da4b2a7SPaul E. McKenney * This function is also subject to counter-wrap errors, but let's face 7362da4b2a7SPaul E. McKenney * it, if this function was preempted for enough time for the counters 7372da4b2a7SPaul E. McKenney * to wrap, it really doesn't matter whether or not we expedite the grace 7382da4b2a7SPaul E. McKenney * period. The extra overhead of a needlessly expedited grace period is 7392da4b2a7SPaul E. McKenney * negligible when amoritized over that time period, and the extra latency 7402da4b2a7SPaul E. McKenney * of a needlessly non-expedited grace period is similarly negligible. 7412da4b2a7SPaul E. McKenney */ 7422da4b2a7SPaul E. McKenney static bool srcu_might_be_idle(struct srcu_struct *sp) 7432da4b2a7SPaul E. McKenney { 74422607d66SPaul E. McKenney unsigned long curseq; 7452da4b2a7SPaul E. McKenney unsigned long flags; 7462da4b2a7SPaul E. McKenney struct srcu_data *sdp; 74722607d66SPaul E. McKenney unsigned long t; 7482da4b2a7SPaul E. McKenney 7492da4b2a7SPaul E. McKenney /* If the local srcu_data structure has callbacks, not idle. */ 7502da4b2a7SPaul E. McKenney local_irq_save(flags); 7512da4b2a7SPaul E. McKenney sdp = this_cpu_ptr(sp->sda); 7522da4b2a7SPaul E. McKenney if (rcu_segcblist_pend_cbs(&sdp->srcu_cblist)) { 7532da4b2a7SPaul E. McKenney local_irq_restore(flags); 7542da4b2a7SPaul E. McKenney return false; /* Callbacks already present, so not idle. */ 7552da4b2a7SPaul E. McKenney } 7562da4b2a7SPaul E. McKenney local_irq_restore(flags); 7572da4b2a7SPaul E. McKenney 7582da4b2a7SPaul E. McKenney /* 7592da4b2a7SPaul E. McKenney * No local callbacks, so probabalistically probe global state. 7602da4b2a7SPaul E. McKenney * Exact information would require acquiring locks, which would 7612da4b2a7SPaul E. McKenney * kill scalability, hence the probabalistic nature of the probe. 7622da4b2a7SPaul E. McKenney */ 76322607d66SPaul E. McKenney 76422607d66SPaul E. McKenney /* First, see if enough time has passed since the last GP. */ 76522607d66SPaul E. McKenney t = ktime_get_mono_fast_ns(); 76622607d66SPaul E. McKenney if (exp_holdoff == 0 || 76722607d66SPaul E. McKenney time_in_range_open(t, sp->srcu_last_gp_end, 76822607d66SPaul E. McKenney sp->srcu_last_gp_end + exp_holdoff)) 76922607d66SPaul E. McKenney return false; /* Too soon after last GP. */ 77022607d66SPaul E. McKenney 77122607d66SPaul E. McKenney /* Next, check for probable idleness. */ 7722da4b2a7SPaul E. McKenney curseq = rcu_seq_current(&sp->srcu_gp_seq); 7732da4b2a7SPaul E. McKenney smp_mb(); /* Order ->srcu_gp_seq with ->srcu_gp_seq_needed. */ 7742da4b2a7SPaul E. McKenney if (ULONG_CMP_LT(curseq, READ_ONCE(sp->srcu_gp_seq_needed))) 7752da4b2a7SPaul E. McKenney return false; /* Grace period in progress, so not idle. */ 7762da4b2a7SPaul E. McKenney smp_mb(); /* Order ->srcu_gp_seq with prior access. */ 7772da4b2a7SPaul E. McKenney if (curseq != rcu_seq_current(&sp->srcu_gp_seq)) 7782da4b2a7SPaul E. McKenney return false; /* GP # changed, so not idle. */ 7792da4b2a7SPaul E. McKenney return true; /* With reasonable probability, idle! */ 7802da4b2a7SPaul E. McKenney } 7812da4b2a7SPaul E. McKenney 7822da4b2a7SPaul E. McKenney /* 783a602538eSPaul E. McKenney * SRCU callback function to leak a callback. 784a602538eSPaul E. McKenney */ 785a602538eSPaul E. McKenney static void srcu_leak_callback(struct rcu_head *rhp) 786a602538eSPaul E. McKenney { 787a602538eSPaul E. McKenney } 788a602538eSPaul E. McKenney 789a602538eSPaul E. McKenney /* 790da915ad5SPaul E. McKenney * Enqueue an SRCU callback on the srcu_data structure associated with 791da915ad5SPaul E. McKenney * the current CPU and the specified srcu_struct structure, initiating 792da915ad5SPaul E. McKenney * grace-period processing if it is not already running. 793dad81a20SPaul E. McKenney * 794dad81a20SPaul E. McKenney * Note that all CPUs must agree that the grace period extended beyond 795dad81a20SPaul E. McKenney * all pre-existing SRCU read-side critical section. On systems with 796dad81a20SPaul E. McKenney * more than one CPU, this means that when "func()" is invoked, each CPU 797dad81a20SPaul E. McKenney * is guaranteed to have executed a full memory barrier since the end of 798dad81a20SPaul E. McKenney * its last corresponding SRCU read-side critical section whose beginning 799dad81a20SPaul E. McKenney * preceded the call to call_rcu(). It also means that each CPU executing 800dad81a20SPaul E. McKenney * an SRCU read-side critical section that continues beyond the start of 801dad81a20SPaul E. McKenney * "func()" must have executed a memory barrier after the call_rcu() 802dad81a20SPaul E. McKenney * but before the beginning of that SRCU read-side critical section. 803dad81a20SPaul E. McKenney * Note that these guarantees include CPUs that are offline, idle, or 804dad81a20SPaul E. McKenney * executing in user mode, as well as CPUs that are executing in the kernel. 805dad81a20SPaul E. McKenney * 806dad81a20SPaul E. McKenney * Furthermore, if CPU A invoked call_rcu() and CPU B invoked the 807dad81a20SPaul E. McKenney * resulting SRCU callback function "func()", then both CPU A and CPU 808dad81a20SPaul E. McKenney * B are guaranteed to execute a full memory barrier during the time 809dad81a20SPaul E. McKenney * interval between the call to call_rcu() and the invocation of "func()". 810dad81a20SPaul E. McKenney * This guarantee applies even if CPU A and CPU B are the same CPU (but 811dad81a20SPaul E. McKenney * again only if the system has more than one CPU). 812dad81a20SPaul E. McKenney * 813dad81a20SPaul E. McKenney * Of course, these guarantees apply only for invocations of call_srcu(), 814dad81a20SPaul E. McKenney * srcu_read_lock(), and srcu_read_unlock() that are all passed the same 815dad81a20SPaul E. McKenney * srcu_struct structure. 816dad81a20SPaul E. McKenney */ 8171e9a038bSPaul E. McKenney void __call_srcu(struct srcu_struct *sp, struct rcu_head *rhp, 8181e9a038bSPaul E. McKenney rcu_callback_t func, bool do_norm) 819dad81a20SPaul E. McKenney { 820dad81a20SPaul E. McKenney unsigned long flags; 8211e9a038bSPaul E. McKenney bool needexp = false; 822da915ad5SPaul E. McKenney bool needgp = false; 823da915ad5SPaul E. McKenney unsigned long s; 824da915ad5SPaul E. McKenney struct srcu_data *sdp; 825dad81a20SPaul E. McKenney 826da915ad5SPaul E. McKenney check_init_srcu_struct(sp); 827a602538eSPaul E. McKenney if (debug_rcu_head_queue(rhp)) { 828a602538eSPaul E. McKenney /* Probable double call_srcu(), so leak the callback. */ 829a602538eSPaul E. McKenney WRITE_ONCE(rhp->func, srcu_leak_callback); 830a602538eSPaul E. McKenney WARN_ONCE(1, "call_srcu(): Leaked duplicate callback\n"); 831a602538eSPaul E. McKenney return; 832a602538eSPaul E. McKenney } 833da915ad5SPaul E. McKenney rhp->func = func; 834da915ad5SPaul E. McKenney local_irq_save(flags); 835da915ad5SPaul E. McKenney sdp = this_cpu_ptr(sp->sda); 836da915ad5SPaul E. McKenney spin_lock(&sdp->lock); 837da915ad5SPaul E. McKenney rcu_segcblist_enqueue(&sdp->srcu_cblist, rhp, false); 838da915ad5SPaul E. McKenney rcu_segcblist_advance(&sdp->srcu_cblist, 839da915ad5SPaul E. McKenney rcu_seq_current(&sp->srcu_gp_seq)); 840da915ad5SPaul E. McKenney s = rcu_seq_snap(&sp->srcu_gp_seq); 841da915ad5SPaul E. McKenney (void)rcu_segcblist_accelerate(&sdp->srcu_cblist, s); 842da915ad5SPaul E. McKenney if (ULONG_CMP_LT(sdp->srcu_gp_seq_needed, s)) { 843da915ad5SPaul E. McKenney sdp->srcu_gp_seq_needed = s; 844da915ad5SPaul E. McKenney needgp = true; 845dad81a20SPaul E. McKenney } 8461e9a038bSPaul E. McKenney if (!do_norm && ULONG_CMP_LT(sdp->srcu_gp_seq_needed_exp, s)) { 8471e9a038bSPaul E. McKenney sdp->srcu_gp_seq_needed_exp = s; 8481e9a038bSPaul E. McKenney needexp = true; 8491e9a038bSPaul E. McKenney } 850da915ad5SPaul E. McKenney spin_unlock_irqrestore(&sdp->lock, flags); 851da915ad5SPaul E. McKenney if (needgp) 8521e9a038bSPaul E. McKenney srcu_funnel_gp_start(sp, sdp, s, do_norm); 8531e9a038bSPaul E. McKenney else if (needexp) 8541e9a038bSPaul E. McKenney srcu_funnel_exp_start(sp, sdp->mynode, s); 8551e9a038bSPaul E. McKenney } 8561e9a038bSPaul E. McKenney 857*5a0465e1SPaul E. McKenney /** 858*5a0465e1SPaul E. McKenney * call_srcu() - Queue a callback for invocation after an SRCU grace period 859*5a0465e1SPaul E. McKenney * @sp: srcu_struct in queue the callback 860*5a0465e1SPaul E. McKenney * @head: structure to be used for queueing the SRCU callback. 861*5a0465e1SPaul E. McKenney * @func: function to be invoked after the SRCU grace period 862*5a0465e1SPaul E. McKenney * 863*5a0465e1SPaul E. McKenney * The callback function will be invoked some time after a full SRCU 864*5a0465e1SPaul E. McKenney * grace period elapses, in other words after all pre-existing SRCU 865*5a0465e1SPaul E. McKenney * read-side critical sections have completed. However, the callback 866*5a0465e1SPaul E. McKenney * function might well execute concurrently with other SRCU read-side 867*5a0465e1SPaul E. McKenney * critical sections that started after call_srcu() was invoked. SRCU 868*5a0465e1SPaul E. McKenney * read-side critical sections are delimited by srcu_read_lock() and 869*5a0465e1SPaul E. McKenney * srcu_read_unlock(), and may be nested. 870*5a0465e1SPaul E. McKenney * 871*5a0465e1SPaul E. McKenney * The callback will be invoked from process context, but must nevertheless 872*5a0465e1SPaul E. McKenney * be fast and must not block. 873*5a0465e1SPaul E. McKenney */ 8741e9a038bSPaul E. McKenney void call_srcu(struct srcu_struct *sp, struct rcu_head *rhp, 8751e9a038bSPaul E. McKenney rcu_callback_t func) 8761e9a038bSPaul E. McKenney { 8771e9a038bSPaul E. McKenney __call_srcu(sp, rhp, func, true); 878dad81a20SPaul E. McKenney } 879dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(call_srcu); 880dad81a20SPaul E. McKenney 881dad81a20SPaul E. McKenney /* 882dad81a20SPaul E. McKenney * Helper function for synchronize_srcu() and synchronize_srcu_expedited(). 883dad81a20SPaul E. McKenney */ 8841e9a038bSPaul E. McKenney static void __synchronize_srcu(struct srcu_struct *sp, bool do_norm) 885dad81a20SPaul E. McKenney { 886dad81a20SPaul E. McKenney struct rcu_synchronize rcu; 887dad81a20SPaul E. McKenney 888dad81a20SPaul E. McKenney RCU_LOCKDEP_WARN(lock_is_held(&sp->dep_map) || 889dad81a20SPaul E. McKenney lock_is_held(&rcu_bh_lock_map) || 890dad81a20SPaul E. McKenney lock_is_held(&rcu_lock_map) || 891dad81a20SPaul E. McKenney lock_is_held(&rcu_sched_lock_map), 892dad81a20SPaul E. McKenney "Illegal synchronize_srcu() in same-type SRCU (or in RCU) read-side critical section"); 893dad81a20SPaul E. McKenney 894dad81a20SPaul E. McKenney if (rcu_scheduler_active == RCU_SCHEDULER_INACTIVE) 895dad81a20SPaul E. McKenney return; 896dad81a20SPaul E. McKenney might_sleep(); 897da915ad5SPaul E. McKenney check_init_srcu_struct(sp); 898dad81a20SPaul E. McKenney init_completion(&rcu.completion); 899da915ad5SPaul E. McKenney init_rcu_head_on_stack(&rcu.head); 9001e9a038bSPaul E. McKenney __call_srcu(sp, &rcu.head, wakeme_after_rcu, do_norm); 901dad81a20SPaul E. McKenney wait_for_completion(&rcu.completion); 902da915ad5SPaul E. McKenney destroy_rcu_head_on_stack(&rcu.head); 903dad81a20SPaul E. McKenney } 904dad81a20SPaul E. McKenney 905dad81a20SPaul E. McKenney /** 906dad81a20SPaul E. McKenney * synchronize_srcu_expedited - Brute-force SRCU grace period 907dad81a20SPaul E. McKenney * @sp: srcu_struct with which to synchronize. 908dad81a20SPaul E. McKenney * 909dad81a20SPaul E. McKenney * Wait for an SRCU grace period to elapse, but be more aggressive about 910dad81a20SPaul E. McKenney * spinning rather than blocking when waiting. 911dad81a20SPaul E. McKenney * 912dad81a20SPaul E. McKenney * Note that synchronize_srcu_expedited() has the same deadlock and 913dad81a20SPaul E. McKenney * memory-ordering properties as does synchronize_srcu(). 914dad81a20SPaul E. McKenney */ 915dad81a20SPaul E. McKenney void synchronize_srcu_expedited(struct srcu_struct *sp) 916dad81a20SPaul E. McKenney { 9171e9a038bSPaul E. McKenney __synchronize_srcu(sp, rcu_gp_is_normal()); 918dad81a20SPaul E. McKenney } 919dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu_expedited); 920dad81a20SPaul E. McKenney 921dad81a20SPaul E. McKenney /** 922dad81a20SPaul E. McKenney * synchronize_srcu - wait for prior SRCU read-side critical-section completion 923dad81a20SPaul E. McKenney * @sp: srcu_struct with which to synchronize. 924dad81a20SPaul E. McKenney * 925dad81a20SPaul E. McKenney * Wait for the count to drain to zero of both indexes. To avoid the 926dad81a20SPaul E. McKenney * possible starvation of synchronize_srcu(), it waits for the count of 927da915ad5SPaul E. McKenney * the index=((->srcu_idx & 1) ^ 1) to drain to zero at first, 928da915ad5SPaul E. McKenney * and then flip the srcu_idx and wait for the count of the other index. 929dad81a20SPaul E. McKenney * 930dad81a20SPaul E. McKenney * Can block; must be called from process context. 931dad81a20SPaul E. McKenney * 932dad81a20SPaul E. McKenney * Note that it is illegal to call synchronize_srcu() from the corresponding 933dad81a20SPaul E. McKenney * SRCU read-side critical section; doing so will result in deadlock. 934dad81a20SPaul E. McKenney * However, it is perfectly legal to call synchronize_srcu() on one 935dad81a20SPaul E. McKenney * srcu_struct from some other srcu_struct's read-side critical section, 936dad81a20SPaul E. McKenney * as long as the resulting graph of srcu_structs is acyclic. 937dad81a20SPaul E. McKenney * 938dad81a20SPaul E. McKenney * There are memory-ordering constraints implied by synchronize_srcu(). 939dad81a20SPaul E. McKenney * On systems with more than one CPU, when synchronize_srcu() returns, 940dad81a20SPaul E. McKenney * each CPU is guaranteed to have executed a full memory barrier since 941dad81a20SPaul E. McKenney * the end of its last corresponding SRCU-sched read-side critical section 942dad81a20SPaul E. McKenney * whose beginning preceded the call to synchronize_srcu(). In addition, 943dad81a20SPaul E. McKenney * each CPU having an SRCU read-side critical section that extends beyond 944dad81a20SPaul E. McKenney * the return from synchronize_srcu() is guaranteed to have executed a 945dad81a20SPaul E. McKenney * full memory barrier after the beginning of synchronize_srcu() and before 946dad81a20SPaul E. McKenney * the beginning of that SRCU read-side critical section. Note that these 947dad81a20SPaul E. McKenney * guarantees include CPUs that are offline, idle, or executing in user mode, 948dad81a20SPaul E. McKenney * as well as CPUs that are executing in the kernel. 949dad81a20SPaul E. McKenney * 950dad81a20SPaul E. McKenney * Furthermore, if CPU A invoked synchronize_srcu(), which returned 951dad81a20SPaul E. McKenney * to its caller on CPU B, then both CPU A and CPU B are guaranteed 952dad81a20SPaul E. McKenney * to have executed a full memory barrier during the execution of 953dad81a20SPaul E. McKenney * synchronize_srcu(). This guarantee applies even if CPU A and CPU B 954dad81a20SPaul E. McKenney * are the same CPU, but again only if the system has more than one CPU. 955dad81a20SPaul E. McKenney * 956dad81a20SPaul E. McKenney * Of course, these memory-ordering guarantees apply only when 957dad81a20SPaul E. McKenney * synchronize_srcu(), srcu_read_lock(), and srcu_read_unlock() are 958dad81a20SPaul E. McKenney * passed the same srcu_struct structure. 9592da4b2a7SPaul E. McKenney * 9602da4b2a7SPaul E. McKenney * If SRCU is likely idle, expedite the first request. This semantic 9612da4b2a7SPaul E. McKenney * was provided by Classic SRCU, and is relied upon by its users, so TREE 9622da4b2a7SPaul E. McKenney * SRCU must also provide it. Note that detecting idleness is heuristic 9632da4b2a7SPaul E. McKenney * and subject to both false positives and negatives. 964dad81a20SPaul E. McKenney */ 965dad81a20SPaul E. McKenney void synchronize_srcu(struct srcu_struct *sp) 966dad81a20SPaul E. McKenney { 9672da4b2a7SPaul E. McKenney if (srcu_might_be_idle(sp) || rcu_gp_is_expedited()) 968dad81a20SPaul E. McKenney synchronize_srcu_expedited(sp); 969dad81a20SPaul E. McKenney else 9701e9a038bSPaul E. McKenney __synchronize_srcu(sp, true); 971dad81a20SPaul E. McKenney } 972dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(synchronize_srcu); 973dad81a20SPaul E. McKenney 974da915ad5SPaul E. McKenney /* 975da915ad5SPaul E. McKenney * Callback function for srcu_barrier() use. 976da915ad5SPaul E. McKenney */ 977da915ad5SPaul E. McKenney static void srcu_barrier_cb(struct rcu_head *rhp) 978da915ad5SPaul E. McKenney { 979da915ad5SPaul E. McKenney struct srcu_data *sdp; 980da915ad5SPaul E. McKenney struct srcu_struct *sp; 981da915ad5SPaul E. McKenney 982da915ad5SPaul E. McKenney sdp = container_of(rhp, struct srcu_data, srcu_barrier_head); 983da915ad5SPaul E. McKenney sp = sdp->sp; 984da915ad5SPaul E. McKenney if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt)) 985da915ad5SPaul E. McKenney complete(&sp->srcu_barrier_completion); 986da915ad5SPaul E. McKenney } 987da915ad5SPaul E. McKenney 988dad81a20SPaul E. McKenney /** 989dad81a20SPaul E. McKenney * srcu_barrier - Wait until all in-flight call_srcu() callbacks complete. 990dad81a20SPaul E. McKenney * @sp: srcu_struct on which to wait for in-flight callbacks. 991dad81a20SPaul E. McKenney */ 992dad81a20SPaul E. McKenney void srcu_barrier(struct srcu_struct *sp) 993dad81a20SPaul E. McKenney { 994da915ad5SPaul E. McKenney int cpu; 995da915ad5SPaul E. McKenney struct srcu_data *sdp; 996da915ad5SPaul E. McKenney unsigned long s = rcu_seq_snap(&sp->srcu_barrier_seq); 997da915ad5SPaul E. McKenney 998da915ad5SPaul E. McKenney check_init_srcu_struct(sp); 999da915ad5SPaul E. McKenney mutex_lock(&sp->srcu_barrier_mutex); 1000da915ad5SPaul E. McKenney if (rcu_seq_done(&sp->srcu_barrier_seq, s)) { 1001da915ad5SPaul E. McKenney smp_mb(); /* Force ordering following return. */ 1002da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_barrier_mutex); 1003da915ad5SPaul E. McKenney return; /* Someone else did our work for us. */ 1004da915ad5SPaul E. McKenney } 1005da915ad5SPaul E. McKenney rcu_seq_start(&sp->srcu_barrier_seq); 1006da915ad5SPaul E. McKenney init_completion(&sp->srcu_barrier_completion); 1007da915ad5SPaul E. McKenney 1008da915ad5SPaul E. McKenney /* Initial count prevents reaching zero until all CBs are posted. */ 1009da915ad5SPaul E. McKenney atomic_set(&sp->srcu_barrier_cpu_cnt, 1); 1010da915ad5SPaul E. McKenney 1011da915ad5SPaul E. McKenney /* 1012da915ad5SPaul E. McKenney * Each pass through this loop enqueues a callback, but only 1013da915ad5SPaul E. McKenney * on CPUs already having callbacks enqueued. Note that if 1014da915ad5SPaul E. McKenney * a CPU already has callbacks enqueue, it must have already 1015da915ad5SPaul E. McKenney * registered the need for a future grace period, so all we 1016da915ad5SPaul E. McKenney * need do is enqueue a callback that will use the same 1017da915ad5SPaul E. McKenney * grace period as the last callback already in the queue. 1018da915ad5SPaul E. McKenney */ 1019da915ad5SPaul E. McKenney for_each_possible_cpu(cpu) { 1020da915ad5SPaul E. McKenney sdp = per_cpu_ptr(sp->sda, cpu); 1021da915ad5SPaul E. McKenney spin_lock_irq(&sdp->lock); 1022da915ad5SPaul E. McKenney atomic_inc(&sp->srcu_barrier_cpu_cnt); 1023da915ad5SPaul E. McKenney sdp->srcu_barrier_head.func = srcu_barrier_cb; 1024a602538eSPaul E. McKenney debug_rcu_head_queue(&sdp->srcu_barrier_head); 1025da915ad5SPaul E. McKenney if (!rcu_segcblist_entrain(&sdp->srcu_cblist, 1026a602538eSPaul E. McKenney &sdp->srcu_barrier_head, 0)) { 1027a602538eSPaul E. McKenney debug_rcu_head_unqueue(&sdp->srcu_barrier_head); 1028da915ad5SPaul E. McKenney atomic_dec(&sp->srcu_barrier_cpu_cnt); 1029a602538eSPaul E. McKenney } 1030da915ad5SPaul E. McKenney spin_unlock_irq(&sdp->lock); 1031da915ad5SPaul E. McKenney } 1032da915ad5SPaul E. McKenney 1033da915ad5SPaul E. McKenney /* Remove the initial count, at which point reaching zero can happen. */ 1034da915ad5SPaul E. McKenney if (atomic_dec_and_test(&sp->srcu_barrier_cpu_cnt)) 1035da915ad5SPaul E. McKenney complete(&sp->srcu_barrier_completion); 1036da915ad5SPaul E. McKenney wait_for_completion(&sp->srcu_barrier_completion); 1037da915ad5SPaul E. McKenney 1038da915ad5SPaul E. McKenney rcu_seq_end(&sp->srcu_barrier_seq); 1039da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_barrier_mutex); 1040dad81a20SPaul E. McKenney } 1041dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_barrier); 1042dad81a20SPaul E. McKenney 1043dad81a20SPaul E. McKenney /** 1044dad81a20SPaul E. McKenney * srcu_batches_completed - return batches completed. 1045dad81a20SPaul E. McKenney * @sp: srcu_struct on which to report batch completion. 1046dad81a20SPaul E. McKenney * 1047dad81a20SPaul E. McKenney * Report the number of batches, correlated with, but not necessarily 1048dad81a20SPaul E. McKenney * precisely the same as, the number of grace periods that have elapsed. 1049dad81a20SPaul E. McKenney */ 1050dad81a20SPaul E. McKenney unsigned long srcu_batches_completed(struct srcu_struct *sp) 1051dad81a20SPaul E. McKenney { 1052da915ad5SPaul E. McKenney return sp->srcu_idx; 1053dad81a20SPaul E. McKenney } 1054dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(srcu_batches_completed); 1055dad81a20SPaul E. McKenney 1056dad81a20SPaul E. McKenney /* 1057da915ad5SPaul E. McKenney * Core SRCU state machine. Push state bits of ->srcu_gp_seq 1058da915ad5SPaul E. McKenney * to SRCU_STATE_SCAN2, and invoke srcu_gp_end() when scan has 1059da915ad5SPaul E. McKenney * completed in that state. 1060dad81a20SPaul E. McKenney */ 1061da915ad5SPaul E. McKenney static void srcu_advance_state(struct srcu_struct *sp) 1062dad81a20SPaul E. McKenney { 1063dad81a20SPaul E. McKenney int idx; 1064dad81a20SPaul E. McKenney 1065da915ad5SPaul E. McKenney mutex_lock(&sp->srcu_gp_mutex); 1066da915ad5SPaul E. McKenney 1067dad81a20SPaul E. McKenney /* 1068dad81a20SPaul E. McKenney * Because readers might be delayed for an extended period after 1069da915ad5SPaul E. McKenney * fetching ->srcu_idx for their index, at any point in time there 1070dad81a20SPaul E. McKenney * might well be readers using both idx=0 and idx=1. We therefore 1071dad81a20SPaul E. McKenney * need to wait for readers to clear from both index values before 1072dad81a20SPaul E. McKenney * invoking a callback. 1073dad81a20SPaul E. McKenney * 1074dad81a20SPaul E. McKenney * The load-acquire ensures that we see the accesses performed 1075dad81a20SPaul E. McKenney * by the prior grace period. 1076dad81a20SPaul E. McKenney */ 1077dad81a20SPaul E. McKenney idx = rcu_seq_state(smp_load_acquire(&sp->srcu_gp_seq)); /* ^^^ */ 1078dad81a20SPaul E. McKenney if (idx == SRCU_STATE_IDLE) { 1079da915ad5SPaul E. McKenney spin_lock_irq(&sp->gp_lock); 1080da915ad5SPaul E. McKenney if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) { 1081da915ad5SPaul E. McKenney WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq)); 1082da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 1083da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_gp_mutex); 1084dad81a20SPaul E. McKenney return; 1085dad81a20SPaul E. McKenney } 1086dad81a20SPaul E. McKenney idx = rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)); 1087dad81a20SPaul E. McKenney if (idx == SRCU_STATE_IDLE) 1088dad81a20SPaul E. McKenney srcu_gp_start(sp); 1089da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 1090da915ad5SPaul E. McKenney if (idx != SRCU_STATE_IDLE) { 1091da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_gp_mutex); 1092dad81a20SPaul E. McKenney return; /* Someone else started the grace period. */ 1093dad81a20SPaul E. McKenney } 1094da915ad5SPaul E. McKenney } 1095dad81a20SPaul E. McKenney 1096dad81a20SPaul E. McKenney if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN1) { 1097da915ad5SPaul E. McKenney idx = 1 ^ (sp->srcu_idx & 1); 1098da915ad5SPaul E. McKenney if (!try_check_zero(sp, idx, 1)) { 1099da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_gp_mutex); 1100dad81a20SPaul E. McKenney return; /* readers present, retry later. */ 1101da915ad5SPaul E. McKenney } 1102dad81a20SPaul E. McKenney srcu_flip(sp); 1103dad81a20SPaul E. McKenney rcu_seq_set_state(&sp->srcu_gp_seq, SRCU_STATE_SCAN2); 1104dad81a20SPaul E. McKenney } 1105dad81a20SPaul E. McKenney 1106dad81a20SPaul E. McKenney if (rcu_seq_state(READ_ONCE(sp->srcu_gp_seq)) == SRCU_STATE_SCAN2) { 1107dad81a20SPaul E. McKenney 1108dad81a20SPaul E. McKenney /* 1109dad81a20SPaul E. McKenney * SRCU read-side critical sections are normally short, 1110dad81a20SPaul E. McKenney * so check at least twice in quick succession after a flip. 1111dad81a20SPaul E. McKenney */ 1112da915ad5SPaul E. McKenney idx = 1 ^ (sp->srcu_idx & 1); 1113da915ad5SPaul E. McKenney if (!try_check_zero(sp, idx, 2)) { 1114da915ad5SPaul E. McKenney mutex_unlock(&sp->srcu_gp_mutex); 1115da915ad5SPaul E. McKenney return; /* readers present, retry later. */ 1116da915ad5SPaul E. McKenney } 1117da915ad5SPaul E. McKenney srcu_gp_end(sp); /* Releases ->srcu_gp_mutex. */ 1118dad81a20SPaul E. McKenney } 1119dad81a20SPaul E. McKenney } 1120dad81a20SPaul E. McKenney 1121dad81a20SPaul E. McKenney /* 1122dad81a20SPaul E. McKenney * Invoke a limited number of SRCU callbacks that have passed through 1123dad81a20SPaul E. McKenney * their grace period. If there are more to do, SRCU will reschedule 1124dad81a20SPaul E. McKenney * the workqueue. Note that needed memory barriers have been executed 1125dad81a20SPaul E. McKenney * in this task's context by srcu_readers_active_idx_check(). 1126dad81a20SPaul E. McKenney */ 1127da915ad5SPaul E. McKenney static void srcu_invoke_callbacks(struct work_struct *work) 1128dad81a20SPaul E. McKenney { 1129da915ad5SPaul E. McKenney bool more; 1130dad81a20SPaul E. McKenney struct rcu_cblist ready_cbs; 1131dad81a20SPaul E. McKenney struct rcu_head *rhp; 1132da915ad5SPaul E. McKenney struct srcu_data *sdp; 1133da915ad5SPaul E. McKenney struct srcu_struct *sp; 1134dad81a20SPaul E. McKenney 1135da915ad5SPaul E. McKenney sdp = container_of(work, struct srcu_data, work.work); 1136da915ad5SPaul E. McKenney sp = sdp->sp; 1137dad81a20SPaul E. McKenney rcu_cblist_init(&ready_cbs); 1138da915ad5SPaul E. McKenney spin_lock_irq(&sdp->lock); 1139da915ad5SPaul E. McKenney smp_mb(); /* Old grace periods before callback invocation! */ 1140da915ad5SPaul E. McKenney rcu_segcblist_advance(&sdp->srcu_cblist, 1141da915ad5SPaul E. McKenney rcu_seq_current(&sp->srcu_gp_seq)); 1142da915ad5SPaul E. McKenney if (sdp->srcu_cblist_invoking || 1143da915ad5SPaul E. McKenney !rcu_segcblist_ready_cbs(&sdp->srcu_cblist)) { 1144da915ad5SPaul E. McKenney spin_unlock_irq(&sdp->lock); 1145da915ad5SPaul E. McKenney return; /* Someone else on the job or nothing to do. */ 1146da915ad5SPaul E. McKenney } 1147da915ad5SPaul E. McKenney 1148da915ad5SPaul E. McKenney /* We are on the job! Extract and invoke ready callbacks. */ 1149da915ad5SPaul E. McKenney sdp->srcu_cblist_invoking = true; 1150da915ad5SPaul E. McKenney rcu_segcblist_extract_done_cbs(&sdp->srcu_cblist, &ready_cbs); 1151da915ad5SPaul E. McKenney spin_unlock_irq(&sdp->lock); 1152dad81a20SPaul E. McKenney rhp = rcu_cblist_dequeue(&ready_cbs); 1153dad81a20SPaul E. McKenney for (; rhp != NULL; rhp = rcu_cblist_dequeue(&ready_cbs)) { 1154a602538eSPaul E. McKenney debug_rcu_head_unqueue(rhp); 1155dad81a20SPaul E. McKenney local_bh_disable(); 1156dad81a20SPaul E. McKenney rhp->func(rhp); 1157dad81a20SPaul E. McKenney local_bh_enable(); 1158dad81a20SPaul E. McKenney } 1159da915ad5SPaul E. McKenney 1160da915ad5SPaul E. McKenney /* 1161da915ad5SPaul E. McKenney * Update counts, accelerate new callbacks, and if needed, 1162da915ad5SPaul E. McKenney * schedule another round of callback invocation. 1163da915ad5SPaul E. McKenney */ 1164da915ad5SPaul E. McKenney spin_lock_irq(&sdp->lock); 1165da915ad5SPaul E. McKenney rcu_segcblist_insert_count(&sdp->srcu_cblist, &ready_cbs); 1166da915ad5SPaul E. McKenney (void)rcu_segcblist_accelerate(&sdp->srcu_cblist, 1167da915ad5SPaul E. McKenney rcu_seq_snap(&sp->srcu_gp_seq)); 1168da915ad5SPaul E. McKenney sdp->srcu_cblist_invoking = false; 1169da915ad5SPaul E. McKenney more = rcu_segcblist_ready_cbs(&sdp->srcu_cblist); 1170da915ad5SPaul E. McKenney spin_unlock_irq(&sdp->lock); 1171da915ad5SPaul E. McKenney if (more) 1172da915ad5SPaul E. McKenney srcu_schedule_cbs_sdp(sdp, 0); 1173dad81a20SPaul E. McKenney } 1174dad81a20SPaul E. McKenney 1175dad81a20SPaul E. McKenney /* 1176dad81a20SPaul E. McKenney * Finished one round of SRCU grace period. Start another if there are 1177dad81a20SPaul E. McKenney * more SRCU callbacks queued, otherwise put SRCU into not-running state. 1178dad81a20SPaul E. McKenney */ 1179dad81a20SPaul E. McKenney static void srcu_reschedule(struct srcu_struct *sp, unsigned long delay) 1180dad81a20SPaul E. McKenney { 1181da915ad5SPaul E. McKenney bool pushgp = true; 1182dad81a20SPaul E. McKenney 1183da915ad5SPaul E. McKenney spin_lock_irq(&sp->gp_lock); 1184da915ad5SPaul E. McKenney if (ULONG_CMP_GE(sp->srcu_gp_seq, sp->srcu_gp_seq_needed)) { 1185da915ad5SPaul E. McKenney if (!WARN_ON_ONCE(rcu_seq_state(sp->srcu_gp_seq))) { 1186da915ad5SPaul E. McKenney /* All requests fulfilled, time to go idle. */ 1187da915ad5SPaul E. McKenney pushgp = false; 1188dad81a20SPaul E. McKenney } 1189da915ad5SPaul E. McKenney } else if (!rcu_seq_state(sp->srcu_gp_seq)) { 1190da915ad5SPaul E. McKenney /* Outstanding request and no GP. Start one. */ 1191da915ad5SPaul E. McKenney srcu_gp_start(sp); 1192da915ad5SPaul E. McKenney } 1193da915ad5SPaul E. McKenney spin_unlock_irq(&sp->gp_lock); 1194dad81a20SPaul E. McKenney 1195da915ad5SPaul E. McKenney if (pushgp) 1196dad81a20SPaul E. McKenney queue_delayed_work(system_power_efficient_wq, &sp->work, delay); 1197dad81a20SPaul E. McKenney } 1198dad81a20SPaul E. McKenney 1199dad81a20SPaul E. McKenney /* 1200dad81a20SPaul E. McKenney * This is the work-queue function that handles SRCU grace periods. 1201dad81a20SPaul E. McKenney */ 1202dad81a20SPaul E. McKenney void process_srcu(struct work_struct *work) 1203dad81a20SPaul E. McKenney { 1204dad81a20SPaul E. McKenney struct srcu_struct *sp; 1205dad81a20SPaul E. McKenney 1206dad81a20SPaul E. McKenney sp = container_of(work, struct srcu_struct, work.work); 1207dad81a20SPaul E. McKenney 1208da915ad5SPaul E. McKenney srcu_advance_state(sp); 12091e9a038bSPaul E. McKenney srcu_reschedule(sp, srcu_get_delay(sp)); 1210dad81a20SPaul E. McKenney } 1211dad81a20SPaul E. McKenney EXPORT_SYMBOL_GPL(process_srcu); 12127f6733c3SPaul E. McKenney 12137f6733c3SPaul E. McKenney void srcutorture_get_gp_data(enum rcutorture_type test_type, 12147f6733c3SPaul E. McKenney struct srcu_struct *sp, int *flags, 12151e9a038bSPaul E. McKenney unsigned long *gpnum, unsigned long *completed) 12167f6733c3SPaul E. McKenney { 12177f6733c3SPaul E. McKenney if (test_type != SRCU_FLAVOR) 12187f6733c3SPaul E. McKenney return; 12197f6733c3SPaul E. McKenney *flags = 0; 12207f6733c3SPaul E. McKenney *completed = rcu_seq_ctr(sp->srcu_gp_seq); 12217f6733c3SPaul E. McKenney *gpnum = rcu_seq_ctr(sp->srcu_gp_seq_needed); 12227f6733c3SPaul E. McKenney } 12237f6733c3SPaul E. McKenney EXPORT_SYMBOL_GPL(srcutorture_get_gp_data); 12241f4f6da1SPaul E. McKenney 12251f4f6da1SPaul E. McKenney static int __init srcu_bootup_announce(void) 12261f4f6da1SPaul E. McKenney { 12271f4f6da1SPaul E. McKenney pr_info("Hierarchical SRCU implementation.\n"); 12280c8e0e3cSPaul E. McKenney if (exp_holdoff != DEFAULT_SRCU_EXP_HOLDOFF) 12290c8e0e3cSPaul E. McKenney pr_info("\tNon-default auto-expedite holdoff of %lu ns.\n", exp_holdoff); 12301f4f6da1SPaul E. McKenney return 0; 12311f4f6da1SPaul E. McKenney } 12321f4f6da1SPaul E. McKenney early_initcall(srcu_bootup_announce); 1233