2 * cgroup_freezer.c - control group freezer subsystem
4 * Copyright IBM Corporation, 2007
6 * Author : Cedric Le Goater <clg@fr.ibm.com>
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.
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.
17 #include <linux/export.h>
18 #include <linux/slab.h>
19 #include <linux/cgroup.h>
21 #include <linux/uaccess.h>
22 #include <linux/freezer.h>
23 #include <linux/seq_file.h>
32 struct cgroup_subsys_state css;
33 enum freezer_state state;
34 spinlock_t lock; /* protects _writes_ to state */
37 static inline struct freezer *cgroup_freezer(
38 struct cgroup *cgroup)
41 cgroup_subsys_state(cgroup, freezer_subsys_id),
45 static inline struct freezer *task_freezer(struct task_struct *task)
47 return container_of(task_subsys_state(task, freezer_subsys_id),
51 static inline int __cgroup_freezing_or_frozen(struct task_struct *task)
53 enum freezer_state state = task_freezer(task)->state;
54 return (state == CGROUP_FREEZING) || (state == CGROUP_FROZEN);
57 int cgroup_freezing_or_frozen(struct task_struct *task)
61 result = __cgroup_freezing_or_frozen(task);
67 * cgroups_write_string() limits the size of freezer state strings to
68 * CGROUP_LOCAL_BUFFER_SIZE
70 static const char *freezer_state_strs[] = {
78 * Transitions are caused by userspace writes to the freezer.state file.
79 * The values in parenthesis are state labels. The rest are edge labels.
81 * (THAWED) --FROZEN--> (FREEZING) --FROZEN--> (FROZEN)
83 * | \_______THAWED_______/ |
84 * \__________________________THAWED____________/
87 struct cgroup_subsys freezer_subsys;
89 /* Locks taken and their ordering
90 * ------------------------------
91 * cgroup_mutex (AKA cgroup_lock)
94 * task->alloc_lock (AKA task_lock)
95 * task->sighand->siglock
97 * cgroup code forces css_set_lock to be taken before task->alloc_lock
99 * freezer_create(), freezer_destroy():
100 * cgroup_mutex [ by cgroup core ]
102 * freezer_can_attach():
103 * cgroup_mutex (held by caller of can_attach)
105 * cgroup_freezing_or_frozen():
106 * task->alloc_lock (to get task's cgroup)
108 * freezer_fork() (preserving fork() performance means can't take cgroup_mutex):
110 * sighand->siglock (if the cgroup is freezing)
115 * write_lock css_set_lock (cgroup iterator start)
117 * read_lock css_set_lock (cgroup iterator start)
119 * freezer_write() (freeze):
122 * write_lock css_set_lock (cgroup iterator start)
124 * read_lock css_set_lock (cgroup iterator start)
125 * sighand->siglock (fake signal delivery inside freeze_task())
127 * freezer_write() (unfreeze):
130 * write_lock css_set_lock (cgroup iterator start)
132 * read_lock css_set_lock (cgroup iterator start)
133 * task->alloc_lock (inside thaw_process(), prevents race with refrigerator())
136 static struct cgroup_subsys_state *freezer_create(struct cgroup_subsys *ss,
137 struct cgroup *cgroup)
139 struct freezer *freezer;
141 freezer = kzalloc(sizeof(struct freezer), GFP_KERNEL);
143 return ERR_PTR(-ENOMEM);
145 spin_lock_init(&freezer->lock);
146 freezer->state = CGROUP_THAWED;
147 return &freezer->css;
150 static void freezer_destroy(struct cgroup_subsys *ss,
151 struct cgroup *cgroup)
153 kfree(cgroup_freezer(cgroup));
156 /* task is frozen or will freeze immediately when next it gets woken */
157 static bool is_task_frozen_enough(struct task_struct *task)
159 return frozen(task) ||
160 (task_is_stopped_or_traced(task) && freezing(task));
164 * The call to cgroup_lock() in the freezer.state write method prevents
165 * a write to that file racing against an attach, and hence the
166 * can_attach() result will remain valid until the attach completes.
168 static int freezer_can_attach(struct cgroup_subsys *ss,
169 struct cgroup *new_cgroup,
170 struct task_struct *task)
172 struct freezer *freezer;
175 * Anything frozen can't move or be moved to/from.
178 freezer = cgroup_freezer(new_cgroup);
179 if (freezer->state != CGROUP_THAWED)
185 static int freezer_can_attach_task(struct cgroup *cgrp, struct task_struct *tsk)
188 if (__cgroup_freezing_or_frozen(tsk)) {
196 static void freezer_fork(struct cgroup_subsys *ss, struct task_struct *task)
198 struct freezer *freezer;
201 * No lock is needed, since the task isn't on tasklist yet,
202 * so it can't be moved to another cgroup, which means the
203 * freezer won't be removed and will be valid during this
204 * function call. Nevertheless, apply RCU read-side critical
205 * section to suppress RCU lockdep false positives.
208 freezer = task_freezer(task);
212 * The root cgroup is non-freezable, so we can skip the
215 if (!freezer->css.cgroup->parent)
218 spin_lock_irq(&freezer->lock);
219 BUG_ON(freezer->state == CGROUP_FROZEN);
221 /* Locking avoids race with FREEZING -> THAWED transitions. */
222 if (freezer->state == CGROUP_FREEZING)
223 freeze_task(task, true);
224 spin_unlock_irq(&freezer->lock);
228 * caller must hold freezer->lock
230 static void update_if_frozen(struct cgroup *cgroup,
231 struct freezer *freezer)
233 struct cgroup_iter it;
234 struct task_struct *task;
235 unsigned int nfrozen = 0, ntotal = 0;
236 enum freezer_state old_state = freezer->state;
238 cgroup_iter_start(cgroup, &it);
239 while ((task = cgroup_iter_next(cgroup, &it))) {
241 if (is_task_frozen_enough(task))
245 if (old_state == CGROUP_THAWED) {
247 } else if (old_state == CGROUP_FREEZING) {
248 if (nfrozen == ntotal)
249 freezer->state = CGROUP_FROZEN;
250 } else { /* old_state == CGROUP_FROZEN */
251 BUG_ON(nfrozen != ntotal);
254 cgroup_iter_end(cgroup, &it);
257 static int freezer_read(struct cgroup *cgroup, struct cftype *cft,
260 struct freezer *freezer;
261 enum freezer_state state;
263 if (!cgroup_lock_live_group(cgroup))
266 freezer = cgroup_freezer(cgroup);
267 spin_lock_irq(&freezer->lock);
268 state = freezer->state;
269 if (state == CGROUP_FREEZING) {
270 /* We change from FREEZING to FROZEN lazily if the cgroup was
271 * only partially frozen when we exitted write. */
272 update_if_frozen(cgroup, freezer);
273 state = freezer->state;
275 spin_unlock_irq(&freezer->lock);
278 seq_puts(m, freezer_state_strs[state]);
283 static int try_to_freeze_cgroup(struct cgroup *cgroup, struct freezer *freezer)
285 struct cgroup_iter it;
286 struct task_struct *task;
287 unsigned int num_cant_freeze_now = 0;
289 freezer->state = CGROUP_FREEZING;
290 cgroup_iter_start(cgroup, &it);
291 while ((task = cgroup_iter_next(cgroup, &it))) {
292 if (!freeze_task(task, true))
294 if (is_task_frozen_enough(task))
296 if (!freezing(task) && !freezer_should_skip(task))
297 num_cant_freeze_now++;
299 cgroup_iter_end(cgroup, &it);
301 return num_cant_freeze_now ? -EBUSY : 0;
304 static void unfreeze_cgroup(struct cgroup *cgroup, struct freezer *freezer)
306 struct cgroup_iter it;
307 struct task_struct *task;
309 cgroup_iter_start(cgroup, &it);
310 while ((task = cgroup_iter_next(cgroup, &it))) {
313 cgroup_iter_end(cgroup, &it);
315 freezer->state = CGROUP_THAWED;
318 static int freezer_change_state(struct cgroup *cgroup,
319 enum freezer_state goal_state)
321 struct freezer *freezer;
324 freezer = cgroup_freezer(cgroup);
326 spin_lock_irq(&freezer->lock);
328 update_if_frozen(cgroup, freezer);
329 if (goal_state == freezer->state)
332 switch (goal_state) {
334 unfreeze_cgroup(cgroup, freezer);
337 retval = try_to_freeze_cgroup(cgroup, freezer);
343 spin_unlock_irq(&freezer->lock);
348 static int freezer_write(struct cgroup *cgroup,
353 enum freezer_state goal_state;
355 if (strcmp(buffer, freezer_state_strs[CGROUP_THAWED]) == 0)
356 goal_state = CGROUP_THAWED;
357 else if (strcmp(buffer, freezer_state_strs[CGROUP_FROZEN]) == 0)
358 goal_state = CGROUP_FROZEN;
362 if (!cgroup_lock_live_group(cgroup))
364 retval = freezer_change_state(cgroup, goal_state);
369 static struct cftype files[] = {
372 .read_seq_string = freezer_read,
373 .write_string = freezer_write,
377 static int freezer_populate(struct cgroup_subsys *ss, struct cgroup *cgroup)
381 return cgroup_add_files(cgroup, ss, files, ARRAY_SIZE(files));
384 struct cgroup_subsys freezer_subsys = {
386 .create = freezer_create,
387 .destroy = freezer_destroy,
388 .populate = freezer_populate,
389 .subsys_id = freezer_subsys_id,
390 .can_attach = freezer_can_attach,
391 .can_attach_task = freezer_can_attach_task,
395 .fork = freezer_fork,