stop_machine.h 4.73 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds's avatar
Linus Torvalds committed
2 3
#ifndef _LINUX_STOP_MACHINE
#define _LINUX_STOP_MACHINE
4

Linus Torvalds's avatar
Linus Torvalds committed
5
#include <linux/cpu.h>
6
#include <linux/cpumask.h>
7
#include <linux/smp.h>
8
#include <linux/list.h>
Linus Torvalds's avatar
Linus Torvalds committed
9

10 11 12 13 14 15 16 17 18 19 20 21
/*
 * stop_cpu[s]() is simplistic per-cpu maximum priority cpu
 * monopolization mechanism.  The caller can specify a non-sleeping
 * function to be executed on a single or multiple cpus preempting all
 * other processes and monopolizing those cpus until it finishes.
 *
 * Resources for this mechanism are preallocated when a cpu is brought
 * up and requests are guaranteed to be served as long as the target
 * cpus are online.
 */
typedef int (*cpu_stop_fn_t)(void *arg);

22 23
#ifdef CONFIG_SMP

24 25 26 27 28 29 30 31
struct cpu_stop_work {
	struct list_head	list;		/* cpu_stopper->works */
	cpu_stop_fn_t		fn;
	void			*arg;
	struct cpu_stop_done	*done;
};

int stop_one_cpu(unsigned int cpu, cpu_stop_fn_t fn, void *arg);
32
int stop_two_cpus(unsigned int cpu1, unsigned int cpu2, cpu_stop_fn_t fn, void *arg);
33
bool stop_one_cpu_nowait(unsigned int cpu, cpu_stop_fn_t fn, void *arg,
34 35 36
			 struct cpu_stop_work *work_buf);
int stop_cpus(const struct cpumask *cpumask, cpu_stop_fn_t fn, void *arg);
int try_stop_cpus(const struct cpumask *cpumask, cpu_stop_fn_t fn, void *arg);
37
void stop_machine_park(int cpu);
38
void stop_machine_unpark(int cpu);
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
#else	/* CONFIG_SMP */

#include <linux/workqueue.h>

struct cpu_stop_work {
	struct work_struct	work;
	cpu_stop_fn_t		fn;
	void			*arg;
};

static inline int stop_one_cpu(unsigned int cpu, cpu_stop_fn_t fn, void *arg)
{
	int ret = -ENOENT;
	preempt_disable();
	if (cpu == smp_processor_id())
		ret = fn(arg);
	preempt_enable();
	return ret;
}

static void stop_one_cpu_nowait_workfn(struct work_struct *work)
{
	struct cpu_stop_work *stwork =
		container_of(work, struct cpu_stop_work, work);
	preempt_disable();
	stwork->fn(stwork->arg);
	preempt_enable();
}

69
static inline bool stop_one_cpu_nowait(unsigned int cpu,
70 71 72 73 74 75 76 77
				       cpu_stop_fn_t fn, void *arg,
				       struct cpu_stop_work *work_buf)
{
	if (cpu == smp_processor_id()) {
		INIT_WORK(&work_buf->work, stop_one_cpu_nowait_workfn);
		work_buf->fn = fn;
		work_buf->arg = arg;
		schedule_work(&work_buf->work);
78
		return true;
79
	}
80 81

	return false;
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
}

static inline int stop_cpus(const struct cpumask *cpumask,
			    cpu_stop_fn_t fn, void *arg)
{
	if (cpumask_test_cpu(raw_smp_processor_id(), cpumask))
		return stop_one_cpu(raw_smp_processor_id(), fn, arg);
	return -ENOENT;
}

static inline int try_stop_cpus(const struct cpumask *cpumask,
				cpu_stop_fn_t fn, void *arg)
{
	return stop_cpus(cpumask, fn, arg);
}

#endif	/* CONFIG_SMP */

100 101 102 103
/*
 * stop_machine "Bogolock": stop the entire machine, disable
 * interrupts.  This is a very heavy lock, which is equivalent to
 * grabbing every spinlock (and more).  So the "read" side to such a
104
 * lock is anything which disables preemption.
105
 */
106
#if defined(CONFIG_SMP) || defined(CONFIG_HOTPLUG_CPU)
107

Linus Torvalds's avatar
Linus Torvalds committed
108
/**
109
 * stop_machine: freeze the machine on all CPUs and run this function
Linus Torvalds's avatar
Linus Torvalds committed
110 111
 * @fn: the function to run
 * @data: the data ptr for the @fn()
112
 * @cpus: the cpus to run the @fn() on (NULL = any online cpu)
Linus Torvalds's avatar
Linus Torvalds committed
113
 *
Rusty Russell's avatar
Rusty Russell committed
114
 * Description: This causes a thread to be scheduled on every cpu,
Lucas De Marchi's avatar
Lucas De Marchi committed
115
 * each of which disables interrupts.  The result is that no one is
Rusty Russell's avatar
Rusty Russell committed
116 117
 * holding a spinlock or inside any other preempt-disabled region when
 * @fn() runs.
Linus Torvalds's avatar
Linus Torvalds committed
118 119
 *
 * This can be thought of as a very heavy write lock, equivalent to
120 121 122 123
 * grabbing every spinlock in the kernel.
 *
 * Protects against CPU hotplug.
 */
124
int stop_machine(cpu_stop_fn_t fn, void *data, const struct cpumask *cpus);
Linus Torvalds's avatar
Linus Torvalds committed
125

126 127 128 129 130 131 132 133 134 135 136
/**
 * stop_machine_cpuslocked: freeze the machine on all CPUs and run this function
 * @fn: the function to run
 * @data: the data ptr for the @fn()
 * @cpus: the cpus to run the @fn() on (NULL = any online cpu)
 *
 * Same as above. Must be called from with in a cpus_read_lock() protected
 * region. Avoids nested calls to cpus_read_lock().
 */
int stop_machine_cpuslocked(cpu_stop_fn_t fn, void *data, const struct cpumask *cpus);

137
int stop_machine_from_inactive_cpu(cpu_stop_fn_t fn, void *data,
138
				   const struct cpumask *cpus);
139
#else	/* CONFIG_SMP || CONFIG_HOTPLUG_CPU */
Linus Torvalds's avatar
Linus Torvalds committed
140

141 142
#include <linux/interrupt.h>

143 144
static inline int stop_machine_cpuslocked(cpu_stop_fn_t fn, void *data,
					  const struct cpumask *cpus)
Linus Torvalds's avatar
Linus Torvalds committed
145
{
146
	unsigned long flags;
Linus Torvalds's avatar
Linus Torvalds committed
147
	int ret;
148
	local_irq_save(flags);
149
	hard_irq_disable();
Linus Torvalds's avatar
Linus Torvalds committed
150
	ret = fn(data);
151
	hard_irq_enable();
152
	local_irq_restore(flags);
Linus Torvalds's avatar
Linus Torvalds committed
153 154
	return ret;
}
155

156 157 158 159 160 161
static inline int stop_machine(cpu_stop_fn_t fn, void *data,
			       const struct cpumask *cpus)
{
	return stop_machine_cpuslocked(fn, data, cpus);
}

162
static inline int stop_machine_from_inactive_cpu(cpu_stop_fn_t fn, void *data,
163 164
						 const struct cpumask *cpus)
{
165
	return stop_machine(fn, data, cpus);
166 167
}

168
#endif	/* CONFIG_SMP || CONFIG_HOTPLUG_CPU */
169
#endif	/* _LINUX_STOP_MACHINE */