]>
Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
8174f150 MH |
2 | /* |
3 | * kernel/freezer.c - Function to freeze a process | |
4 | * | |
5 | * Originally from kernel/power/process.c | |
6 | */ | |
7 | ||
8 | #include <linux/interrupt.h> | |
9 | #include <linux/suspend.h> | |
9984de1a | 10 | #include <linux/export.h> |
8174f150 MH |
11 | #include <linux/syscalls.h> |
12 | #include <linux/freezer.h> | |
8a32c441 | 13 | #include <linux/kthread.h> |
8174f150 | 14 | |
a3201227 | 15 | /* total number of freezing conditions in effect */ |
f5d39b02 PZ |
16 | DEFINE_STATIC_KEY_FALSE(freezer_active); |
17 | EXPORT_SYMBOL(freezer_active); | |
a3201227 | 18 | |
f5d39b02 PZ |
19 | /* |
20 | * indicate whether PM freezing is in effect, protected by | |
55f2503c PL |
21 | * system_transition_mutex |
22 | */ | |
a3201227 TH |
23 | bool pm_freezing; |
24 | bool pm_nosig_freezing; | |
25 | ||
0c9af092 TH |
26 | /* protects freezing and frozen transitions */ |
27 | static DEFINE_SPINLOCK(freezer_lock); | |
8174f150 | 28 | |
a3201227 TH |
29 | /** |
30 | * freezing_slow_path - slow path for testing whether a task needs to be frozen | |
31 | * @p: task to be tested | |
32 | * | |
f5d39b02 | 33 | * This function is called by freezing() if freezer_active isn't zero |
a3201227 TH |
34 | * and tests whether @p needs to enter and stay in frozen state. Can be |
35 | * called under any context. The freezers are responsible for ensuring the | |
36 | * target tasks see the updated state. | |
37 | */ | |
38 | bool freezing_slow_path(struct task_struct *p) | |
39 | { | |
2b44c4db | 40 | if (p->flags & (PF_NOFREEZE | PF_SUSPEND_TASK)) |
a3201227 TH |
41 | return false; |
42 | ||
a34c80a7 | 43 | if (test_tsk_thread_flag(p, TIF_MEMDIE)) |
51fae6da CW |
44 | return false; |
45 | ||
a3201227 TH |
46 | if (pm_nosig_freezing || cgroup_freezing(p)) |
47 | return true; | |
48 | ||
34b087e4 | 49 | if (pm_freezing && !(p->flags & PF_KTHREAD)) |
a3201227 TH |
50 | return true; |
51 | ||
52 | return false; | |
53 | } | |
54 | EXPORT_SYMBOL(freezing_slow_path); | |
55 | ||
f5d39b02 PZ |
56 | bool frozen(struct task_struct *p) |
57 | { | |
58 | return READ_ONCE(p->__state) & TASK_FROZEN; | |
59 | } | |
60 | ||
8174f150 | 61 | /* Refrigerator is place where frozen processes are stored :-). */ |
8a32c441 | 62 | bool __refrigerator(bool check_kthr_stop) |
8174f150 | 63 | { |
f5d39b02 | 64 | unsigned int state = get_current_state(); |
a0acae0e | 65 | bool was_frozen = false; |
8174f150 | 66 | |
8174f150 MH |
67 | pr_debug("%s entered refrigerator\n", current->comm); |
68 | ||
f5d39b02 PZ |
69 | WARN_ON_ONCE(state && !(state & TASK_NORMAL)); |
70 | ||
8174f150 | 71 | for (;;) { |
f5d39b02 PZ |
72 | bool freeze; |
73 | ||
74 | set_current_state(TASK_FROZEN); | |
5ece3eae TH |
75 | |
76 | spin_lock_irq(&freezer_lock); | |
f5d39b02 | 77 | freeze = freezing(current) && !(check_kthr_stop && kthread_should_stop()); |
5ece3eae TH |
78 | spin_unlock_irq(&freezer_lock); |
79 | ||
f5d39b02 | 80 | if (!freeze) |
8174f150 | 81 | break; |
f5d39b02 | 82 | |
a0acae0e | 83 | was_frozen = true; |
8174f150 MH |
84 | schedule(); |
85 | } | |
f5d39b02 | 86 | __set_current_state(TASK_RUNNING); |
6301cb95 | 87 | |
8174f150 | 88 | pr_debug("%s left refrigerator\n", current->comm); |
50fb4f7f | 89 | |
a0acae0e | 90 | return was_frozen; |
8174f150 | 91 | } |
a0acae0e | 92 | EXPORT_SYMBOL(__refrigerator); |
8174f150 MH |
93 | |
94 | static void fake_signal_wake_up(struct task_struct *p) | |
95 | { | |
96 | unsigned long flags; | |
97 | ||
37ad8aca TH |
98 | if (lock_task_sighand(p, &flags)) { |
99 | signal_wake_up(p, 0); | |
100 | unlock_task_sighand(p, &flags); | |
101 | } | |
8174f150 MH |
102 | } |
103 | ||
f5d39b02 PZ |
104 | static int __set_task_frozen(struct task_struct *p, void *arg) |
105 | { | |
106 | unsigned int state = READ_ONCE(p->__state); | |
107 | ||
108 | if (p->on_rq) | |
109 | return 0; | |
110 | ||
111 | if (p != current && task_curr(p)) | |
112 | return 0; | |
113 | ||
114 | if (!(state & (TASK_FREEZABLE | __TASK_STOPPED | __TASK_TRACED))) | |
115 | return 0; | |
116 | ||
117 | /* | |
118 | * Only TASK_NORMAL can be augmented with TASK_FREEZABLE, since they | |
119 | * can suffer spurious wakeups. | |
120 | */ | |
121 | if (state & TASK_FREEZABLE) | |
122 | WARN_ON_ONCE(!(state & TASK_NORMAL)); | |
123 | ||
124 | #ifdef CONFIG_LOCKDEP | |
125 | /* | |
126 | * It's dangerous to freeze with locks held; there be dragons there. | |
127 | */ | |
128 | if (!(state & __TASK_FREEZABLE_UNSAFE)) | |
129 | WARN_ON_ONCE(debug_locks && p->lockdep_depth); | |
130 | #endif | |
131 | ||
132 | WRITE_ONCE(p->__state, TASK_FROZEN); | |
133 | return TASK_FROZEN; | |
134 | } | |
135 | ||
136 | static bool __freeze_task(struct task_struct *p) | |
137 | { | |
138 | /* TASK_FREEZABLE|TASK_STOPPED|TASK_TRACED -> TASK_FROZEN */ | |
139 | return task_call_func(p, __set_task_frozen, NULL); | |
140 | } | |
141 | ||
8174f150 | 142 | /** |
839e3407 TH |
143 | * freeze_task - send a freeze request to given task |
144 | * @p: task to send the request to | |
8174f150 | 145 | * |
37f08be1 MPS |
146 | * If @p is freezing, the freeze request is sent either by sending a fake |
147 | * signal (if it's not a kernel thread) or waking it up (if it's a kernel | |
148 | * thread). | |
839e3407 TH |
149 | * |
150 | * RETURNS: | |
151 | * %false, if @p is not freezing or already frozen; %true, otherwise | |
8174f150 | 152 | */ |
839e3407 | 153 | bool freeze_task(struct task_struct *p) |
8174f150 | 154 | { |
0c9af092 | 155 | unsigned long flags; |
0c9af092 TH |
156 | |
157 | spin_lock_irqsave(&freezer_lock, flags); | |
f5d39b02 | 158 | if (!freezing(p) || frozen(p) || __freeze_task(p)) { |
a3201227 TH |
159 | spin_unlock_irqrestore(&freezer_lock, flags); |
160 | return false; | |
161 | } | |
8174f150 | 162 | |
d3dc04cd | 163 | if (!(p->flags & PF_KTHREAD)) |
8cfe400c | 164 | fake_signal_wake_up(p); |
5d8f72b5 | 165 | else |
f5d39b02 | 166 | wake_up_state(p, TASK_NORMAL); |
a3201227 | 167 | |
0c9af092 | 168 | spin_unlock_irqrestore(&freezer_lock, flags); |
a3201227 | 169 | return true; |
8174f150 MH |
170 | } |
171 | ||
f5d39b02 PZ |
172 | /* |
173 | * The special task states (TASK_STOPPED, TASK_TRACED) keep their canonical | |
174 | * state in p->jobctl. If either of them got a wakeup that was missed because | |
175 | * TASK_FROZEN, then their canonical state reflects that and the below will | |
176 | * refuse to restore the special state and instead issue the wakeup. | |
177 | */ | |
178 | static int __set_task_special(struct task_struct *p, void *arg) | |
179 | { | |
180 | unsigned int state = 0; | |
181 | ||
182 | if (p->jobctl & JOBCTL_TRACED) | |
183 | state = TASK_TRACED; | |
184 | ||
185 | else if (p->jobctl & JOBCTL_STOPPED) | |
186 | state = TASK_STOPPED; | |
187 | ||
188 | if (state) | |
189 | WRITE_ONCE(p->__state, state); | |
190 | ||
191 | return state; | |
192 | } | |
193 | ||
a5be2d0d | 194 | void __thaw_task(struct task_struct *p) |
dc52ddc0 | 195 | { |
f5d39b02 | 196 | unsigned long flags, flags2; |
a5be2d0d | 197 | |
0c9af092 | 198 | spin_lock_irqsave(&freezer_lock, flags); |
f5d39b02 PZ |
199 | if (WARN_ON_ONCE(freezing(p))) |
200 | goto unlock; | |
201 | ||
202 | if (lock_task_sighand(p, &flags2)) { | |
203 | /* TASK_FROZEN -> TASK_{STOPPED,TRACED} */ | |
204 | bool ret = task_call_func(p, __set_task_special, NULL); | |
205 | unlock_task_sighand(p, &flags2); | |
206 | if (ret) | |
207 | goto unlock; | |
208 | } | |
209 | ||
210 | wake_up_state(p, TASK_FROZEN); | |
211 | unlock: | |
0c9af092 | 212 | spin_unlock_irqrestore(&freezer_lock, flags); |
dc52ddc0 | 213 | } |
96ee6d85 TH |
214 | |
215 | /** | |
34b087e4 | 216 | * set_freezable - make %current freezable |
96ee6d85 TH |
217 | * |
218 | * Mark %current freezable and enter refrigerator if necessary. | |
219 | */ | |
34b087e4 | 220 | bool set_freezable(void) |
96ee6d85 TH |
221 | { |
222 | might_sleep(); | |
223 | ||
224 | /* | |
225 | * Modify flags while holding freezer_lock. This ensures the | |
226 | * freezer notices that we aren't frozen yet or the freezing | |
227 | * condition is visible to try_to_freeze() below. | |
228 | */ | |
229 | spin_lock_irq(&freezer_lock); | |
230 | current->flags &= ~PF_NOFREEZE; | |
96ee6d85 TH |
231 | spin_unlock_irq(&freezer_lock); |
232 | ||
233 | return try_to_freeze(); | |
234 | } | |
34b087e4 | 235 | EXPORT_SYMBOL(set_freezable); |