Loading...
1/*
2 * Copyright (C) 2010 Red Hat, Inc., Peter Zijlstra
3 *
4 * Provides a framework for enqueueing and running callbacks from hardirq
5 * context. The enqueueing is NMI-safe.
6 */
7
8#include <linux/bug.h>
9#include <linux/kernel.h>
10#include <linux/export.h>
11#include <linux/irq_work.h>
12#include <linux/percpu.h>
13#include <linux/hardirq.h>
14#include <linux/irqflags.h>
15#include <linux/sched.h>
16#include <linux/tick.h>
17#include <linux/cpu.h>
18#include <linux/notifier.h>
19#include <linux/smp.h>
20#include <asm/processor.h>
21
22
23static DEFINE_PER_CPU(struct llist_head, raised_list);
24static DEFINE_PER_CPU(struct llist_head, lazy_list);
25
26/*
27 * Claim the entry so that no one else will poke at it.
28 */
29static bool irq_work_claim(struct irq_work *work)
30{
31 unsigned long flags, oflags, nflags;
32
33 /*
34 * Start with our best wish as a premise but only trust any
35 * flag value after cmpxchg() result.
36 */
37 flags = work->flags & ~IRQ_WORK_PENDING;
38 for (;;) {
39 nflags = flags | IRQ_WORK_FLAGS;
40 oflags = cmpxchg(&work->flags, flags, nflags);
41 if (oflags == flags)
42 break;
43 if (oflags & IRQ_WORK_PENDING)
44 return false;
45 flags = oflags;
46 cpu_relax();
47 }
48
49 return true;
50}
51
52void __weak arch_irq_work_raise(void)
53{
54 /*
55 * Lame architectures will get the timer tick callback
56 */
57}
58
59#ifdef CONFIG_SMP
60/*
61 * Enqueue the irq_work @work on @cpu unless it's already pending
62 * somewhere.
63 *
64 * Can be re-enqueued while the callback is still in progress.
65 */
66bool irq_work_queue_on(struct irq_work *work, int cpu)
67{
68 /* All work should have been flushed before going offline */
69 WARN_ON_ONCE(cpu_is_offline(cpu));
70
71 /* Arch remote IPI send/receive backend aren't NMI safe */
72 WARN_ON_ONCE(in_nmi());
73
74 /* Only queue if not already pending */
75 if (!irq_work_claim(work))
76 return false;
77
78 if (llist_add(&work->llnode, &per_cpu(raised_list, cpu)))
79 arch_send_call_function_single_ipi(cpu);
80
81 return true;
82}
83EXPORT_SYMBOL_GPL(irq_work_queue_on);
84#endif
85
86/* Enqueue the irq work @work on the current CPU */
87bool irq_work_queue(struct irq_work *work)
88{
89 /* Only queue if not already pending */
90 if (!irq_work_claim(work))
91 return false;
92
93 /* Queue the entry and raise the IPI if needed. */
94 preempt_disable();
95
96 /* If the work is "lazy", handle it from next tick if any */
97 if (work->flags & IRQ_WORK_LAZY) {
98 if (llist_add(&work->llnode, this_cpu_ptr(&lazy_list)) &&
99 tick_nohz_tick_stopped())
100 arch_irq_work_raise();
101 } else {
102 if (llist_add(&work->llnode, this_cpu_ptr(&raised_list)))
103 arch_irq_work_raise();
104 }
105
106 preempt_enable();
107
108 return true;
109}
110EXPORT_SYMBOL_GPL(irq_work_queue);
111
112bool irq_work_needs_cpu(void)
113{
114 struct llist_head *raised, *lazy;
115
116 raised = this_cpu_ptr(&raised_list);
117 lazy = this_cpu_ptr(&lazy_list);
118
119 if (llist_empty(raised) || arch_irq_work_has_interrupt())
120 if (llist_empty(lazy))
121 return false;
122
123 /* All work should have been flushed before going offline */
124 WARN_ON_ONCE(cpu_is_offline(smp_processor_id()));
125
126 return true;
127}
128
129static void irq_work_run_list(struct llist_head *list)
130{
131 unsigned long flags;
132 struct irq_work *work;
133 struct llist_node *llnode;
134
135 BUG_ON(!irqs_disabled());
136
137 if (llist_empty(list))
138 return;
139
140 llnode = llist_del_all(list);
141 while (llnode != NULL) {
142 work = llist_entry(llnode, struct irq_work, llnode);
143
144 llnode = llist_next(llnode);
145
146 /*
147 * Clear the PENDING bit, after this point the @work
148 * can be re-used.
149 * Make it immediately visible so that other CPUs trying
150 * to claim that work don't rely on us to handle their data
151 * while we are in the middle of the func.
152 */
153 flags = work->flags & ~IRQ_WORK_PENDING;
154 xchg(&work->flags, flags);
155
156 work->func(work);
157 /*
158 * Clear the BUSY bit and return to the free state if
159 * no-one else claimed it meanwhile.
160 */
161 (void)cmpxchg(&work->flags, flags, flags & ~IRQ_WORK_BUSY);
162 }
163}
164
165/*
166 * hotplug calls this through:
167 * hotplug_cfd() -> flush_smp_call_function_queue()
168 */
169void irq_work_run(void)
170{
171 irq_work_run_list(this_cpu_ptr(&raised_list));
172 irq_work_run_list(this_cpu_ptr(&lazy_list));
173}
174EXPORT_SYMBOL_GPL(irq_work_run);
175
176void irq_work_tick(void)
177{
178 struct llist_head *raised = this_cpu_ptr(&raised_list);
179
180 if (!llist_empty(raised) && !arch_irq_work_has_interrupt())
181 irq_work_run_list(raised);
182 irq_work_run_list(this_cpu_ptr(&lazy_list));
183}
184
185/*
186 * Synchronize against the irq_work @entry, ensures the entry is not
187 * currently in use.
188 */
189void irq_work_sync(struct irq_work *work)
190{
191 WARN_ON_ONCE(irqs_disabled());
192
193 while (work->flags & IRQ_WORK_BUSY)
194 cpu_relax();
195}
196EXPORT_SYMBOL_GPL(irq_work_sync);
1/*
2 * Copyright (C) 2010 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
3 *
4 * Provides a framework for enqueueing and running callbacks from hardirq
5 * context. The enqueueing is NMI-safe.
6 */
7
8#include <linux/kernel.h>
9#include <linux/module.h>
10#include <linux/irq_work.h>
11#include <linux/hardirq.h>
12
13/*
14 * An entry can be in one of four states:
15 *
16 * free NULL, 0 -> {claimed} : free to be used
17 * claimed NULL, 3 -> {pending} : claimed to be enqueued
18 * pending next, 3 -> {busy} : queued, pending callback
19 * busy NULL, 2 -> {free, claimed} : callback in progress, can be claimed
20 *
21 * We use the lower two bits of the next pointer to keep PENDING and BUSY
22 * flags.
23 */
24
25#define IRQ_WORK_PENDING 1UL
26#define IRQ_WORK_BUSY 2UL
27#define IRQ_WORK_FLAGS 3UL
28
29static inline bool irq_work_is_set(struct irq_work *entry, int flags)
30{
31 return (unsigned long)entry->next & flags;
32}
33
34static inline struct irq_work *irq_work_next(struct irq_work *entry)
35{
36 unsigned long next = (unsigned long)entry->next;
37 next &= ~IRQ_WORK_FLAGS;
38 return (struct irq_work *)next;
39}
40
41static inline struct irq_work *next_flags(struct irq_work *entry, int flags)
42{
43 unsigned long next = (unsigned long)entry;
44 next |= flags;
45 return (struct irq_work *)next;
46}
47
48static DEFINE_PER_CPU(struct irq_work *, irq_work_list);
49
50/*
51 * Claim the entry so that no one else will poke at it.
52 */
53static bool irq_work_claim(struct irq_work *entry)
54{
55 struct irq_work *next, *nflags;
56
57 do {
58 next = entry->next;
59 if ((unsigned long)next & IRQ_WORK_PENDING)
60 return false;
61 nflags = next_flags(next, IRQ_WORK_FLAGS);
62 } while (cmpxchg(&entry->next, next, nflags) != next);
63
64 return true;
65}
66
67
68void __weak arch_irq_work_raise(void)
69{
70 /*
71 * Lame architectures will get the timer tick callback
72 */
73}
74
75/*
76 * Queue the entry and raise the IPI if needed.
77 */
78static void __irq_work_queue(struct irq_work *entry)
79{
80 struct irq_work *next;
81
82 preempt_disable();
83
84 do {
85 next = __this_cpu_read(irq_work_list);
86 /* Can assign non-atomic because we keep the flags set. */
87 entry->next = next_flags(next, IRQ_WORK_FLAGS);
88 } while (this_cpu_cmpxchg(irq_work_list, next, entry) != next);
89
90 /* The list was empty, raise self-interrupt to start processing. */
91 if (!irq_work_next(entry))
92 arch_irq_work_raise();
93
94 preempt_enable();
95}
96
97/*
98 * Enqueue the irq_work @entry, returns true on success, failure when the
99 * @entry was already enqueued by someone else.
100 *
101 * Can be re-enqueued while the callback is still in progress.
102 */
103bool irq_work_queue(struct irq_work *entry)
104{
105 if (!irq_work_claim(entry)) {
106 /*
107 * Already enqueued, can't do!
108 */
109 return false;
110 }
111
112 __irq_work_queue(entry);
113 return true;
114}
115EXPORT_SYMBOL_GPL(irq_work_queue);
116
117/*
118 * Run the irq_work entries on this cpu. Requires to be ran from hardirq
119 * context with local IRQs disabled.
120 */
121void irq_work_run(void)
122{
123 struct irq_work *list;
124
125 if (this_cpu_read(irq_work_list) == NULL)
126 return;
127
128 BUG_ON(!in_irq());
129 BUG_ON(!irqs_disabled());
130
131 list = this_cpu_xchg(irq_work_list, NULL);
132
133 while (list != NULL) {
134 struct irq_work *entry = list;
135
136 list = irq_work_next(list);
137
138 /*
139 * Clear the PENDING bit, after this point the @entry
140 * can be re-used.
141 */
142 entry->next = next_flags(NULL, IRQ_WORK_BUSY);
143 entry->func(entry);
144 /*
145 * Clear the BUSY bit and return to the free state if
146 * no-one else claimed it meanwhile.
147 */
148 (void)cmpxchg(&entry->next,
149 next_flags(NULL, IRQ_WORK_BUSY),
150 NULL);
151 }
152}
153EXPORT_SYMBOL_GPL(irq_work_run);
154
155/*
156 * Synchronize against the irq_work @entry, ensures the entry is not
157 * currently in use.
158 */
159void irq_work_sync(struct irq_work *entry)
160{
161 WARN_ON_ONCE(irqs_disabled());
162
163 while (irq_work_is_set(entry, IRQ_WORK_BUSY))
164 cpu_relax();
165}
166EXPORT_SYMBOL_GPL(irq_work_sync);