2 * Generic helpers for smp ipi calls
4 * (C) Jens Axboe <jens.axboe@oracle.com> 2008
6 #include <linux/rcupdate.h>
7 #include <linux/rculist.h>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/percpu.h>
11 #include <linux/init.h>
12 #include <linux/smp.h>
13 #include <linux/cpu.h>
15 static DEFINE_PER_CPU(struct call_single_queue
, call_single_queue
);
18 struct list_head queue
;
20 } call_function __cacheline_aligned_in_smp
=
22 .queue
= LIST_HEAD_INIT(call_function
.queue
),
23 .lock
= __RAW_SPIN_LOCK_UNLOCKED(call_function
.lock
),
30 struct call_function_data
{
31 struct call_single_data csd
;
33 cpumask_var_t cpumask
;
36 struct call_single_queue
{
37 struct list_head list
;
41 static DEFINE_PER_CPU(struct call_function_data
, cfd_data
);
44 hotplug_cfd(struct notifier_block
*nfb
, unsigned long action
, void *hcpu
)
46 long cpu
= (long)hcpu
;
47 struct call_function_data
*cfd
= &per_cpu(cfd_data
, cpu
);
51 case CPU_UP_PREPARE_FROZEN
:
52 if (!zalloc_cpumask_var_node(&cfd
->cpumask
, GFP_KERNEL
,
57 #ifdef CONFIG_HOTPLUG_CPU
59 case CPU_UP_CANCELED_FROZEN
:
63 free_cpumask_var(cfd
->cpumask
);
71 static struct notifier_block __cpuinitdata hotplug_cfd_notifier
= {
72 .notifier_call
= hotplug_cfd
,
75 static int __cpuinit
init_call_single_data(void)
77 void *cpu
= (void *)(long)smp_processor_id();
80 for_each_possible_cpu(i
) {
81 struct call_single_queue
*q
= &per_cpu(call_single_queue
, i
);
83 raw_spin_lock_init(&q
->lock
);
84 INIT_LIST_HEAD(&q
->list
);
87 hotplug_cfd(&hotplug_cfd_notifier
, CPU_UP_PREPARE
, cpu
);
88 register_cpu_notifier(&hotplug_cfd_notifier
);
92 early_initcall(init_call_single_data
);
95 * csd_lock/csd_unlock used to serialize access to per-cpu csd resources
97 * For non-synchronous ipi calls the csd can still be in use by the
98 * previous function call. For multi-cpu calls its even more interesting
99 * as we'll have to ensure no other cpu is observing our csd.
101 static void csd_lock_wait(struct call_single_data
*data
)
103 while (data
->flags
& CSD_FLAG_LOCK
)
107 static void csd_lock(struct call_single_data
*data
)
110 data
->flags
= CSD_FLAG_LOCK
;
113 * prevent CPU from reordering the above assignment
114 * to ->flags with any subsequent assignments to other
115 * fields of the specified call_single_data structure:
120 static void csd_unlock(struct call_single_data
*data
)
122 WARN_ON(!(data
->flags
& CSD_FLAG_LOCK
));
125 * ensure we're all done before releasing data:
129 data
->flags
&= ~CSD_FLAG_LOCK
;
133 * Insert a previously allocated call_single_data element
134 * for execution on the given CPU. data must already have
135 * ->func, ->info, and ->flags set.
138 void generic_exec_single(int cpu
, struct call_single_data
*data
, int wait
)
140 struct call_single_queue
*dst
= &per_cpu(call_single_queue
, cpu
);
144 raw_spin_lock_irqsave(&dst
->lock
, flags
);
145 ipi
= list_empty(&dst
->list
);
146 list_add_tail(&data
->list
, &dst
->list
);
147 raw_spin_unlock_irqrestore(&dst
->lock
, flags
);
150 * The list addition should be visible before sending the IPI
151 * handler locks the list to pull the entry off it because of
152 * normal cache coherency rules implied by spinlocks.
154 * If IPIs can go out of order to the cache coherency protocol
155 * in an architecture, sufficient synchronisation should be added
156 * to arch code to make it appear to obey cache coherency WRT
157 * locking and barrier primitives. Generic code isn't really
158 * equipped to do the right thing...
161 arch_send_call_function_single_ipi(cpu
);
168 * Invoked by arch to handle an IPI for call function. Must be called with
169 * interrupts disabled.
171 void generic_smp_call_function_interrupt(void)
173 struct call_function_data
*data
;
174 int cpu
= smp_processor_id();
177 * Shouldn't receive this interrupt on a cpu that is not yet online.
179 WARN_ON_ONCE(!cpu_online(cpu
));
182 * Ensure entry is visible on call_function_queue after we have
183 * entered the IPI. See comment in smp_call_function_many.
184 * If we don't have this, then we may miss an entry on the list
185 * and never get another IPI to process it.
190 * It's ok to use list_for_each_rcu() here even though we may
191 * delete 'pos', since list_del_rcu() doesn't clear ->next
193 list_for_each_entry_rcu(data
, &call_function
.queue
, csd
.list
) {
197 * Since we walk the list without any locks, we might
198 * see an entry that was completed, removed from the
199 * list and is in the process of being reused.
201 * We must check that the cpu is in the cpumask before
202 * checking the refs, and both must be set before
203 * executing the callback on this cpu.
206 if (!cpumask_test_cpu(cpu
, data
->cpumask
))
211 if (atomic_read(&data
->refs
) == 0)
214 if (!cpumask_test_and_clear_cpu(cpu
, data
->cpumask
))
217 data
->csd
.func(data
->csd
.info
);
219 refs
= atomic_dec_return(&data
->refs
);
222 WARN_ON(!cpumask_empty(data
->cpumask
));
224 raw_spin_lock(&call_function
.lock
);
225 list_del_rcu(&data
->csd
.list
);
226 raw_spin_unlock(&call_function
.lock
);
232 csd_unlock(&data
->csd
);
238 * Invoked by arch to handle an IPI for call function single. Must be
239 * called from the arch with interrupts disabled.
241 void generic_smp_call_function_single_interrupt(void)
243 struct call_single_queue
*q
= &__get_cpu_var(call_single_queue
);
244 unsigned int data_flags
;
248 * Shouldn't receive this interrupt on a cpu that is not yet online.
250 WARN_ON_ONCE(!cpu_online(smp_processor_id()));
252 raw_spin_lock(&q
->lock
);
253 list_replace_init(&q
->list
, &list
);
254 raw_spin_unlock(&q
->lock
);
256 while (!list_empty(&list
)) {
257 struct call_single_data
*data
;
259 data
= list_entry(list
.next
, struct call_single_data
, list
);
260 list_del(&data
->list
);
263 * 'data' can be invalid after this call if flags == 0
264 * (when called through generic_exec_single()),
265 * so save them away before making the call:
267 data_flags
= data
->flags
;
269 data
->func(data
->info
);
272 * Unlocked CSDs are valid through generic_exec_single():
274 if (data_flags
& CSD_FLAG_LOCK
)
279 static DEFINE_PER_CPU(struct call_single_data
, csd_data
);
282 * smp_call_function_single - Run a function on a specific CPU
283 * @func: The function to run. This must be fast and non-blocking.
284 * @info: An arbitrary pointer to pass to the function.
285 * @wait: If true, wait until function has completed on other CPUs.
287 * Returns 0 on success, else a negative status code.
289 int smp_call_function_single(int cpu
, void (*func
) (void *info
), void *info
,
292 struct call_single_data d
= {
300 * prevent preemption and reschedule on another processor,
301 * as well as CPU removal
303 this_cpu
= get_cpu();
306 * Can deadlock when called with interrupts disabled.
307 * We allow cpu's that are not yet online though, as no one else can
308 * send smp call function interrupt to this cpu and as such deadlocks
311 WARN_ON_ONCE(cpu_online(this_cpu
) && irqs_disabled()
312 && !oops_in_progress
);
314 if (cpu
== this_cpu
) {
315 local_irq_save(flags
);
317 local_irq_restore(flags
);
319 if ((unsigned)cpu
< nr_cpu_ids
&& cpu_online(cpu
)) {
320 struct call_single_data
*data
= &d
;
323 data
= &__get_cpu_var(csd_data
);
329 generic_exec_single(cpu
, data
, wait
);
331 err
= -ENXIO
; /* CPU not online */
339 EXPORT_SYMBOL(smp_call_function_single
);
342 * smp_call_function_any - Run a function on any of the given cpus
343 * @mask: The mask of cpus it can run on.
344 * @func: The function to run. This must be fast and non-blocking.
345 * @info: An arbitrary pointer to pass to the function.
346 * @wait: If true, wait until function has completed.
348 * Returns 0 on success, else a negative status code (if no cpus were online).
349 * Note that @wait will be implicitly turned on in case of allocation failures,
350 * since we fall back to on-stack allocation.
352 * Selection preference:
353 * 1) current cpu if in @mask
354 * 2) any cpu of current node if in @mask
355 * 3) any other online cpu in @mask
357 int smp_call_function_any(const struct cpumask
*mask
,
358 void (*func
)(void *info
), void *info
, int wait
)
361 const struct cpumask
*nodemask
;
364 /* Try for same CPU (cheapest) */
366 if (cpumask_test_cpu(cpu
, mask
))
369 /* Try for same node. */
370 nodemask
= cpumask_of_node(cpu_to_node(cpu
));
371 for (cpu
= cpumask_first_and(nodemask
, mask
); cpu
< nr_cpu_ids
;
372 cpu
= cpumask_next_and(cpu
, nodemask
, mask
)) {
377 /* Any online will do: smp_call_function_single handles nr_cpu_ids. */
378 cpu
= cpumask_any_and(mask
, cpu_online_mask
);
380 ret
= smp_call_function_single(cpu
, func
, info
, wait
);
384 EXPORT_SYMBOL_GPL(smp_call_function_any
);
387 * __smp_call_function_single(): Run a function on another CPU
388 * @cpu: The CPU to run on.
389 * @data: Pre-allocated and setup data structure
391 * Like smp_call_function_single(), but allow caller to pass in a
392 * pre-allocated data structure. Useful for embedding @data inside
393 * other structures, for instance.
395 void __smp_call_function_single(int cpu
, struct call_single_data
*data
,
401 * Can deadlock when called with interrupts disabled.
402 * We allow cpu's that are not yet online though, as no one else can
403 * send smp call function interrupt to this cpu and as such deadlocks
406 WARN_ON_ONCE(cpu_online(smp_processor_id()) && wait
&& irqs_disabled()
407 && !oops_in_progress
);
409 generic_exec_single(cpu
, data
, wait
);
413 * smp_call_function_many(): Run a function on a set of other CPUs.
414 * @mask: The set of cpus to run on (only runs on online subset).
415 * @func: The function to run. This must be fast and non-blocking.
416 * @info: An arbitrary pointer to pass to the function.
417 * @wait: If true, wait (atomically) until function has completed
420 * If @wait is true, then returns once @func has returned.
422 * You must not call this function with disabled interrupts or from a
423 * hardware interrupt handler or from a bottom half handler. Preemption
424 * must be disabled when calling this function.
426 void smp_call_function_many(const struct cpumask
*mask
,
427 void (*func
)(void *), void *info
, bool wait
)
429 struct call_function_data
*data
;
431 int refs
, cpu
, next_cpu
, this_cpu
= smp_processor_id();
434 * Can deadlock when called with interrupts disabled.
435 * We allow cpu's that are not yet online though, as no one else can
436 * send smp call function interrupt to this cpu and as such deadlocks
439 WARN_ON_ONCE(cpu_online(this_cpu
) && irqs_disabled()
440 && !oops_in_progress
);
442 /* Try to fastpath. So, what's a CPU they want? Ignoring this one. */
443 cpu
= cpumask_first_and(mask
, cpu_online_mask
);
445 cpu
= cpumask_next_and(cpu
, mask
, cpu_online_mask
);
447 /* No online cpus? We're done. */
448 if (cpu
>= nr_cpu_ids
)
451 /* Do we have another CPU which isn't us? */
452 next_cpu
= cpumask_next_and(cpu
, mask
, cpu_online_mask
);
453 if (next_cpu
== this_cpu
)
454 next_cpu
= cpumask_next_and(next_cpu
, mask
, cpu_online_mask
);
456 /* Fastpath: do that cpu by itself. */
457 if (next_cpu
>= nr_cpu_ids
) {
458 smp_call_function_single(cpu
, func
, info
, wait
);
462 data
= &__get_cpu_var(cfd_data
);
463 csd_lock(&data
->csd
);
465 /* This BUG_ON verifies our reuse assertions and can be removed */
466 BUG_ON(atomic_read(&data
->refs
) || !cpumask_empty(data
->cpumask
));
469 * The global call function queue list add and delete are protected
470 * by a lock, but the list is traversed without any lock, relying
471 * on the rcu list add and delete to allow safe concurrent traversal.
472 * We reuse the call function data without waiting for any grace
473 * period after some other cpu removes it from the global queue.
474 * This means a cpu might find our data block as it is being
477 * We hold off the interrupt handler on the other cpu by
478 * ordering our writes to the cpu mask vs our setting of the
479 * refs counter. We assert only the cpu owning the data block
480 * will set a bit in cpumask, and each bit will only be cleared
481 * by the subject cpu. Each cpu must first find its bit is
482 * set and then check that refs is set indicating the element is
483 * ready to be processed, otherwise it must skip the entry.
485 * On the previous iteration refs was set to 0 by another cpu.
486 * To avoid the use of transitivity, set the counter to 0 here
487 * so the wmb will pair with the rmb in the interrupt handler.
489 atomic_set(&data
->refs
, 0); /* convert 3rd to 1st party write */
491 data
->csd
.func
= func
;
492 data
->csd
.info
= info
;
494 /* Ensure 0 refs is visible before mask. Also orders func and info */
497 /* We rely on the "and" being processed before the store */
498 cpumask_and(data
->cpumask
, mask
, cpu_online_mask
);
499 cpumask_clear_cpu(this_cpu
, data
->cpumask
);
500 refs
= cpumask_weight(data
->cpumask
);
502 /* Some callers race with other cpus changing the passed mask */
503 if (unlikely(!refs
)) {
504 csd_unlock(&data
->csd
);
508 raw_spin_lock_irqsave(&call_function
.lock
, flags
);
510 * Place entry at the _HEAD_ of the list, so that any cpu still
511 * observing the entry in generic_smp_call_function_interrupt()
512 * will not miss any other list entries:
514 list_add_rcu(&data
->csd
.list
, &call_function
.queue
);
516 * We rely on the wmb() in list_add_rcu to complete our writes
517 * to the cpumask before this write to refs, which indicates
518 * data is on the list and is ready to be processed.
520 atomic_set(&data
->refs
, refs
);
521 raw_spin_unlock_irqrestore(&call_function
.lock
, flags
);
524 * Make the list addition visible before sending the ipi.
525 * (IPIs must obey or appear to obey normal Linux cache
526 * coherency rules -- see comment in generic_exec_single).
530 /* Send a message to all CPUs in the map */
531 arch_send_call_function_ipi_mask(data
->cpumask
);
533 /* Optionally wait for the CPUs to complete */
535 csd_lock_wait(&data
->csd
);
537 EXPORT_SYMBOL(smp_call_function_many
);
540 * smp_call_function(): Run a function on all other CPUs.
541 * @func: The function to run. This must be fast and non-blocking.
542 * @info: An arbitrary pointer to pass to the function.
543 * @wait: If true, wait (atomically) until function has completed
548 * If @wait is true, then returns once @func has returned; otherwise
549 * it returns just before the target cpu calls @func.
551 * You must not call this function with disabled interrupts or from a
552 * hardware interrupt handler or from a bottom half handler.
554 int smp_call_function(void (*func
)(void *), void *info
, int wait
)
557 smp_call_function_many(cpu_online_mask
, func
, info
, wait
);
562 EXPORT_SYMBOL(smp_call_function
);
564 void ipi_call_lock(void)
566 raw_spin_lock(&call_function
.lock
);
569 void ipi_call_unlock(void)
571 raw_spin_unlock(&call_function
.lock
);
574 void ipi_call_lock_irq(void)
576 raw_spin_lock_irq(&call_function
.lock
);
579 void ipi_call_unlock_irq(void)
581 raw_spin_unlock_irq(&call_function
.lock
);