]>
Commit | Line | Data |
---|---|---|
dc52ddc0 MH |
1 | /* |
2 | * cgroup_freezer.c - control group freezer subsystem | |
3 | * | |
4 | * Copyright IBM Corporation, 2007 | |
5 | * | |
6 | * Author : Cedric Le Goater <clg@fr.ibm.com> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify it | |
9 | * under the terms of version 2.1 of the GNU Lesser General Public License | |
10 | * as published by the Free Software Foundation. | |
11 | * | |
12 | * This program is distributed in the hope that it would be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
15 | */ | |
16 | ||
17 | #include <linux/module.h> | |
18 | #include <linux/cgroup.h> | |
19 | #include <linux/fs.h> | |
20 | #include <linux/uaccess.h> | |
21 | #include <linux/freezer.h> | |
22 | #include <linux/seq_file.h> | |
23 | ||
24 | enum freezer_state { | |
81dcf33c MH |
25 | CGROUP_THAWED = 0, |
26 | CGROUP_FREEZING, | |
27 | CGROUP_FROZEN, | |
dc52ddc0 MH |
28 | }; |
29 | ||
30 | struct freezer { | |
31 | struct cgroup_subsys_state css; | |
32 | enum freezer_state state; | |
33 | spinlock_t lock; /* protects _writes_ to state */ | |
34 | }; | |
35 | ||
36 | static inline struct freezer *cgroup_freezer( | |
37 | struct cgroup *cgroup) | |
38 | { | |
39 | return container_of( | |
40 | cgroup_subsys_state(cgroup, freezer_subsys_id), | |
41 | struct freezer, css); | |
42 | } | |
43 | ||
44 | static inline struct freezer *task_freezer(struct task_struct *task) | |
45 | { | |
46 | return container_of(task_subsys_state(task, freezer_subsys_id), | |
47 | struct freezer, css); | |
48 | } | |
49 | ||
50 | int cgroup_frozen(struct task_struct *task) | |
51 | { | |
52 | struct freezer *freezer; | |
53 | enum freezer_state state; | |
54 | ||
55 | task_lock(task); | |
56 | freezer = task_freezer(task); | |
57 | state = freezer->state; | |
58 | task_unlock(task); | |
59 | ||
81dcf33c | 60 | return state == CGROUP_FROZEN; |
dc52ddc0 MH |
61 | } |
62 | ||
63 | /* | |
64 | * cgroups_write_string() limits the size of freezer state strings to | |
65 | * CGROUP_LOCAL_BUFFER_SIZE | |
66 | */ | |
67 | static const char *freezer_state_strs[] = { | |
81dcf33c | 68 | "THAWED", |
dc52ddc0 MH |
69 | "FREEZING", |
70 | "FROZEN", | |
71 | }; | |
72 | ||
73 | /* | |
74 | * State diagram | |
75 | * Transitions are caused by userspace writes to the freezer.state file. | |
76 | * The values in parenthesis are state labels. The rest are edge labels. | |
77 | * | |
81dcf33c MH |
78 | * (THAWED) --FROZEN--> (FREEZING) --FROZEN--> (FROZEN) |
79 | * ^ ^ | | | |
80 | * | \_______THAWED_______/ | | |
81 | * \__________________________THAWED____________/ | |
dc52ddc0 MH |
82 | */ |
83 | ||
84 | struct cgroup_subsys freezer_subsys; | |
85 | ||
86 | /* Locks taken and their ordering | |
87 | * ------------------------------ | |
88 | * css_set_lock | |
89 | * cgroup_mutex (AKA cgroup_lock) | |
90 | * task->alloc_lock (AKA task_lock) | |
91 | * freezer->lock | |
92 | * task->sighand->siglock | |
93 | * | |
94 | * cgroup code forces css_set_lock to be taken before task->alloc_lock | |
95 | * | |
96 | * freezer_create(), freezer_destroy(): | |
97 | * cgroup_mutex [ by cgroup core ] | |
98 | * | |
99 | * can_attach(): | |
100 | * cgroup_mutex | |
101 | * | |
102 | * cgroup_frozen(): | |
103 | * task->alloc_lock (to get task's cgroup) | |
104 | * | |
105 | * freezer_fork() (preserving fork() performance means can't take cgroup_mutex): | |
106 | * task->alloc_lock (to get task's cgroup) | |
107 | * freezer->lock | |
108 | * sighand->siglock (if the cgroup is freezing) | |
109 | * | |
110 | * freezer_read(): | |
111 | * cgroup_mutex | |
112 | * freezer->lock | |
113 | * read_lock css_set_lock (cgroup iterator start) | |
114 | * | |
115 | * freezer_write() (freeze): | |
116 | * cgroup_mutex | |
117 | * freezer->lock | |
118 | * read_lock css_set_lock (cgroup iterator start) | |
119 | * sighand->siglock | |
120 | * | |
121 | * freezer_write() (unfreeze): | |
122 | * cgroup_mutex | |
123 | * freezer->lock | |
124 | * read_lock css_set_lock (cgroup iterator start) | |
125 | * task->alloc_lock (to prevent races with freeze_task()) | |
126 | * sighand->siglock | |
127 | */ | |
128 | static struct cgroup_subsys_state *freezer_create(struct cgroup_subsys *ss, | |
129 | struct cgroup *cgroup) | |
130 | { | |
131 | struct freezer *freezer; | |
132 | ||
133 | freezer = kzalloc(sizeof(struct freezer), GFP_KERNEL); | |
134 | if (!freezer) | |
135 | return ERR_PTR(-ENOMEM); | |
136 | ||
137 | spin_lock_init(&freezer->lock); | |
81dcf33c | 138 | freezer->state = CGROUP_THAWED; |
dc52ddc0 MH |
139 | return &freezer->css; |
140 | } | |
141 | ||
142 | static void freezer_destroy(struct cgroup_subsys *ss, | |
143 | struct cgroup *cgroup) | |
144 | { | |
145 | kfree(cgroup_freezer(cgroup)); | |
146 | } | |
147 | ||
957a4eea MH |
148 | /* Task is frozen or will freeze immediately when next it gets woken */ |
149 | static bool is_task_frozen_enough(struct task_struct *task) | |
150 | { | |
151 | return frozen(task) || | |
152 | (task_is_stopped_or_traced(task) && freezing(task)); | |
153 | } | |
dc52ddc0 | 154 | |
957a4eea MH |
155 | /* |
156 | * The call to cgroup_lock() in the freezer.state write method prevents | |
157 | * a write to that file racing against an attach, and hence the | |
158 | * can_attach() result will remain valid until the attach completes. | |
159 | */ | |
dc52ddc0 MH |
160 | static int freezer_can_attach(struct cgroup_subsys *ss, |
161 | struct cgroup *new_cgroup, | |
162 | struct task_struct *task) | |
163 | { | |
164 | struct freezer *freezer; | |
957a4eea MH |
165 | int retval; |
166 | ||
167 | /* Anything frozen can't move or be moved to/from */ | |
168 | ||
169 | if (is_task_frozen_enough(task)) | |
170 | return -EBUSY; | |
dc52ddc0 | 171 | |
dc52ddc0 | 172 | freezer = cgroup_freezer(new_cgroup); |
81dcf33c | 173 | if (freezer->state == CGROUP_FROZEN) |
957a4eea MH |
174 | return -EBUSY; |
175 | ||
176 | retval = 0; | |
177 | task_lock(task); | |
178 | freezer = task_freezer(task); | |
81dcf33c | 179 | if (freezer->state == CGROUP_FROZEN) |
dc52ddc0 | 180 | retval = -EBUSY; |
957a4eea | 181 | task_unlock(task); |
dc52ddc0 MH |
182 | return retval; |
183 | } | |
184 | ||
185 | static void freezer_fork(struct cgroup_subsys *ss, struct task_struct *task) | |
186 | { | |
187 | struct freezer *freezer; | |
188 | ||
189 | task_lock(task); | |
190 | freezer = task_freezer(task); | |
191 | task_unlock(task); | |
192 | ||
dc52ddc0 | 193 | spin_lock_irq(&freezer->lock); |
7ccb9743 LZ |
194 | BUG_ON(freezer->state == CGROUP_FROZEN); |
195 | ||
81dcf33c MH |
196 | /* Locking avoids race with FREEZING -> THAWED transitions. */ |
197 | if (freezer->state == CGROUP_FREEZING) | |
dc52ddc0 MH |
198 | freeze_task(task, true); |
199 | spin_unlock_irq(&freezer->lock); | |
200 | } | |
201 | ||
202 | /* | |
203 | * caller must hold freezer->lock | |
204 | */ | |
1aece348 MH |
205 | static void update_freezer_state(struct cgroup *cgroup, |
206 | struct freezer *freezer) | |
dc52ddc0 MH |
207 | { |
208 | struct cgroup_iter it; | |
209 | struct task_struct *task; | |
210 | unsigned int nfrozen = 0, ntotal = 0; | |
211 | ||
212 | cgroup_iter_start(cgroup, &it); | |
213 | while ((task = cgroup_iter_next(cgroup, &it))) { | |
214 | ntotal++; | |
957a4eea | 215 | if (is_task_frozen_enough(task)) |
dc52ddc0 MH |
216 | nfrozen++; |
217 | } | |
218 | ||
219 | /* | |
220 | * Transition to FROZEN when no new tasks can be added ensures | |
221 | * that we never exist in the FROZEN state while there are unfrozen | |
222 | * tasks. | |
223 | */ | |
224 | if (nfrozen == ntotal) | |
81dcf33c | 225 | freezer->state = CGROUP_FROZEN; |
1aece348 MH |
226 | else if (nfrozen > 0) |
227 | freezer->state = CGROUP_FREEZING; | |
228 | else | |
229 | freezer->state = CGROUP_THAWED; | |
dc52ddc0 MH |
230 | cgroup_iter_end(cgroup, &it); |
231 | } | |
232 | ||
233 | static int freezer_read(struct cgroup *cgroup, struct cftype *cft, | |
234 | struct seq_file *m) | |
235 | { | |
236 | struct freezer *freezer; | |
237 | enum freezer_state state; | |
238 | ||
239 | if (!cgroup_lock_live_group(cgroup)) | |
240 | return -ENODEV; | |
241 | ||
242 | freezer = cgroup_freezer(cgroup); | |
243 | spin_lock_irq(&freezer->lock); | |
244 | state = freezer->state; | |
81dcf33c | 245 | if (state == CGROUP_FREEZING) { |
dc52ddc0 MH |
246 | /* We change from FREEZING to FROZEN lazily if the cgroup was |
247 | * only partially frozen when we exitted write. */ | |
1aece348 | 248 | update_freezer_state(cgroup, freezer); |
dc52ddc0 MH |
249 | state = freezer->state; |
250 | } | |
251 | spin_unlock_irq(&freezer->lock); | |
252 | cgroup_unlock(); | |
253 | ||
254 | seq_puts(m, freezer_state_strs[state]); | |
255 | seq_putc(m, '\n'); | |
256 | return 0; | |
257 | } | |
258 | ||
259 | static int try_to_freeze_cgroup(struct cgroup *cgroup, struct freezer *freezer) | |
260 | { | |
261 | struct cgroup_iter it; | |
262 | struct task_struct *task; | |
263 | unsigned int num_cant_freeze_now = 0; | |
264 | ||
81dcf33c | 265 | freezer->state = CGROUP_FREEZING; |
dc52ddc0 MH |
266 | cgroup_iter_start(cgroup, &it); |
267 | while ((task = cgroup_iter_next(cgroup, &it))) { | |
268 | if (!freeze_task(task, true)) | |
269 | continue; | |
957a4eea | 270 | if (is_task_frozen_enough(task)) |
dc52ddc0 MH |
271 | continue; |
272 | if (!freezing(task) && !freezer_should_skip(task)) | |
273 | num_cant_freeze_now++; | |
274 | } | |
275 | cgroup_iter_end(cgroup, &it); | |
276 | ||
277 | return num_cant_freeze_now ? -EBUSY : 0; | |
278 | } | |
279 | ||
280 | static int unfreeze_cgroup(struct cgroup *cgroup, struct freezer *freezer) | |
281 | { | |
282 | struct cgroup_iter it; | |
283 | struct task_struct *task; | |
284 | ||
285 | cgroup_iter_start(cgroup, &it); | |
286 | while ((task = cgroup_iter_next(cgroup, &it))) { | |
287 | int do_wake; | |
288 | ||
289 | task_lock(task); | |
290 | do_wake = __thaw_process(task); | |
291 | task_unlock(task); | |
292 | if (do_wake) | |
293 | wake_up_process(task); | |
294 | } | |
295 | cgroup_iter_end(cgroup, &it); | |
81dcf33c | 296 | freezer->state = CGROUP_THAWED; |
dc52ddc0 MH |
297 | |
298 | return 0; | |
299 | } | |
300 | ||
301 | static int freezer_change_state(struct cgroup *cgroup, | |
302 | enum freezer_state goal_state) | |
303 | { | |
304 | struct freezer *freezer; | |
305 | int retval = 0; | |
306 | ||
307 | freezer = cgroup_freezer(cgroup); | |
308 | spin_lock_irq(&freezer->lock); | |
1aece348 | 309 | update_freezer_state(cgroup, freezer); |
dc52ddc0 MH |
310 | if (goal_state == freezer->state) |
311 | goto out; | |
312 | switch (freezer->state) { | |
81dcf33c | 313 | case CGROUP_THAWED: |
dc52ddc0 MH |
314 | retval = try_to_freeze_cgroup(cgroup, freezer); |
315 | break; | |
81dcf33c MH |
316 | case CGROUP_FREEZING: |
317 | if (goal_state == CGROUP_FROZEN) { | |
dc52ddc0 MH |
318 | /* Userspace is retrying after |
319 | * "/bin/echo FROZEN > freezer.state" returned -EBUSY */ | |
320 | retval = try_to_freeze_cgroup(cgroup, freezer); | |
321 | break; | |
322 | } | |
81dcf33c MH |
323 | /* state == FREEZING and goal_state == THAWED, so unfreeze */ |
324 | case CGROUP_FROZEN: | |
dc52ddc0 MH |
325 | retval = unfreeze_cgroup(cgroup, freezer); |
326 | break; | |
327 | default: | |
328 | break; | |
329 | } | |
330 | out: | |
331 | spin_unlock_irq(&freezer->lock); | |
332 | ||
333 | return retval; | |
334 | } | |
335 | ||
336 | static int freezer_write(struct cgroup *cgroup, | |
337 | struct cftype *cft, | |
338 | const char *buffer) | |
339 | { | |
340 | int retval; | |
341 | enum freezer_state goal_state; | |
342 | ||
81dcf33c MH |
343 | if (strcmp(buffer, freezer_state_strs[CGROUP_THAWED]) == 0) |
344 | goal_state = CGROUP_THAWED; | |
345 | else if (strcmp(buffer, freezer_state_strs[CGROUP_FROZEN]) == 0) | |
346 | goal_state = CGROUP_FROZEN; | |
dc52ddc0 MH |
347 | else |
348 | return -EIO; | |
349 | ||
350 | if (!cgroup_lock_live_group(cgroup)) | |
351 | return -ENODEV; | |
352 | retval = freezer_change_state(cgroup, goal_state); | |
353 | cgroup_unlock(); | |
354 | return retval; | |
355 | } | |
356 | ||
357 | static struct cftype files[] = { | |
358 | { | |
359 | .name = "state", | |
360 | .read_seq_string = freezer_read, | |
361 | .write_string = freezer_write, | |
362 | }, | |
363 | }; | |
364 | ||
365 | static int freezer_populate(struct cgroup_subsys *ss, struct cgroup *cgroup) | |
366 | { | |
367 | return cgroup_add_files(cgroup, ss, files, ARRAY_SIZE(files)); | |
368 | } | |
369 | ||
370 | struct cgroup_subsys freezer_subsys = { | |
371 | .name = "freezer", | |
372 | .create = freezer_create, | |
373 | .destroy = freezer_destroy, | |
374 | .populate = freezer_populate, | |
375 | .subsys_id = freezer_subsys_id, | |
376 | .can_attach = freezer_can_attach, | |
377 | .attach = NULL, | |
378 | .fork = freezer_fork, | |
379 | .exit = NULL, | |
380 | }; |