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/module.h>
18 #include <linux/cgroup.h>
20 #include <linux/uaccess.h>
21 #include <linux/freezer.h>
22 #include <linux/seq_file.h>
31 struct cgroup_subsys_state css;
32 enum freezer_state state;
33 spinlock_t lock; /* protects _writes_ to state */
36 static inline struct freezer *cgroup_freezer(
37 struct cgroup *cgroup)
40 cgroup_subsys_state(cgroup, freezer_subsys_id),
44 static inline struct freezer *task_freezer(struct task_struct *task)
46 return container_of(task_subsys_state(task, freezer_subsys_id),
50 int cgroup_frozen(struct task_struct *task)
52 struct freezer *freezer;
53 enum freezer_state state;
56 freezer = task_freezer(task);
57 state = freezer->state;
60 return state == CGROUP_FROZEN;
64 * cgroups_write_string() limits the size of freezer state strings to
65 * CGROUP_LOCAL_BUFFER_SIZE
67 static const char *freezer_state_strs[] = {
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.
78 * (THAWED) --FROZEN--> (FREEZING) --FROZEN--> (FROZEN)
80 * | \_______THAWED_______/ |
81 * \__________________________THAWED____________/
84 struct cgroup_subsys freezer_subsys;
86 /* Locks taken and their ordering
87 * ------------------------------
89 * cgroup_mutex (AKA cgroup_lock)
90 * task->alloc_lock (AKA task_lock)
92 * task->sighand->siglock
94 * cgroup code forces css_set_lock to be taken before task->alloc_lock
96 * freezer_create(), freezer_destroy():
97 * cgroup_mutex [ by cgroup core ]
103 * task->alloc_lock (to get task's cgroup)
105 * freezer_fork() (preserving fork() performance means can't take cgroup_mutex):
106 * task->alloc_lock (to get task's cgroup)
108 * sighand->siglock (if the cgroup is freezing)
113 * read_lock css_set_lock (cgroup iterator start)
115 * freezer_write() (freeze):
118 * read_lock css_set_lock (cgroup iterator start)
121 * freezer_write() (unfreeze):
124 * read_lock css_set_lock (cgroup iterator start)
125 * task->alloc_lock (to prevent races with freeze_task())
128 static struct cgroup_subsys_state *freezer_create(struct cgroup_subsys *ss,
129 struct cgroup *cgroup)
131 struct freezer *freezer;
133 freezer = kzalloc(sizeof(struct freezer), GFP_KERNEL);
135 return ERR_PTR(-ENOMEM);
137 spin_lock_init(&freezer->lock);
138 freezer->state = CGROUP_THAWED;
139 return &freezer->css;
142 static void freezer_destroy(struct cgroup_subsys *ss,
143 struct cgroup *cgroup)
145 kfree(cgroup_freezer(cgroup));
148 /* Task is frozen or will freeze immediately when next it gets woken */
149 static bool is_task_frozen_enough(struct task_struct *task)
151 return frozen(task) ||
152 (task_is_stopped_or_traced(task) && freezing(task));
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.
160 static int freezer_can_attach(struct cgroup_subsys *ss,
161 struct cgroup *new_cgroup,
162 struct task_struct *task)
164 struct freezer *freezer;
167 /* Anything frozen can't move or be moved to/from */
169 if (is_task_frozen_enough(task))
172 freezer = cgroup_freezer(new_cgroup);
173 if (freezer->state == CGROUP_FROZEN)
178 freezer = task_freezer(task);
179 if (freezer->state == CGROUP_FROZEN)
185 static void freezer_fork(struct cgroup_subsys *ss, struct task_struct *task)
187 struct freezer *freezer;
190 freezer = task_freezer(task);
193 spin_lock_irq(&freezer->lock);
194 BUG_ON(freezer->state == CGROUP_FROZEN);
196 /* Locking avoids race with FREEZING -> THAWED transitions. */
197 if (freezer->state == CGROUP_FREEZING)
198 freeze_task(task, true);
199 spin_unlock_irq(&freezer->lock);
203 * caller must hold freezer->lock
205 static void update_freezer_state(struct cgroup *cgroup,
206 struct freezer *freezer)
208 struct cgroup_iter it;
209 struct task_struct *task;
210 unsigned int nfrozen = 0, ntotal = 0;
212 cgroup_iter_start(cgroup, &it);
213 while ((task = cgroup_iter_next(cgroup, &it))) {
215 if (is_task_frozen_enough(task))
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
224 if (nfrozen == ntotal)
225 freezer->state = CGROUP_FROZEN;
226 else if (nfrozen > 0)
227 freezer->state = CGROUP_FREEZING;
229 freezer->state = CGROUP_THAWED;
230 cgroup_iter_end(cgroup, &it);
233 static int freezer_read(struct cgroup *cgroup, struct cftype *cft,
236 struct freezer *freezer;
237 enum freezer_state state;
239 if (!cgroup_lock_live_group(cgroup))
242 freezer = cgroup_freezer(cgroup);
243 spin_lock_irq(&freezer->lock);
244 state = freezer->state;
245 if (state == CGROUP_FREEZING) {
246 /* We change from FREEZING to FROZEN lazily if the cgroup was
247 * only partially frozen when we exitted write. */
248 update_freezer_state(cgroup, freezer);
249 state = freezer->state;
251 spin_unlock_irq(&freezer->lock);
254 seq_puts(m, freezer_state_strs[state]);
259 static int try_to_freeze_cgroup(struct cgroup *cgroup, struct freezer *freezer)
261 struct cgroup_iter it;
262 struct task_struct *task;
263 unsigned int num_cant_freeze_now = 0;
265 freezer->state = CGROUP_FREEZING;
266 cgroup_iter_start(cgroup, &it);
267 while ((task = cgroup_iter_next(cgroup, &it))) {
268 if (!freeze_task(task, true))
270 if (is_task_frozen_enough(task))
272 if (!freezing(task) && !freezer_should_skip(task))
273 num_cant_freeze_now++;
275 cgroup_iter_end(cgroup, &it);
277 return num_cant_freeze_now ? -EBUSY : 0;
280 static int unfreeze_cgroup(struct cgroup *cgroup, struct freezer *freezer)
282 struct cgroup_iter it;
283 struct task_struct *task;
285 cgroup_iter_start(cgroup, &it);
286 while ((task = cgroup_iter_next(cgroup, &it))) {
290 do_wake = __thaw_process(task);
293 wake_up_process(task);
295 cgroup_iter_end(cgroup, &it);
296 freezer->state = CGROUP_THAWED;
301 static int freezer_change_state(struct cgroup *cgroup,
302 enum freezer_state goal_state)
304 struct freezer *freezer;
307 freezer = cgroup_freezer(cgroup);
308 spin_lock_irq(&freezer->lock);
309 update_freezer_state(cgroup, freezer);
310 if (goal_state == freezer->state)
312 switch (freezer->state) {
314 retval = try_to_freeze_cgroup(cgroup, freezer);
316 case CGROUP_FREEZING:
317 if (goal_state == CGROUP_FROZEN) {
318 /* Userspace is retrying after
319 * "/bin/echo FROZEN > freezer.state" returned -EBUSY */
320 retval = try_to_freeze_cgroup(cgroup, freezer);
323 /* state == FREEZING and goal_state == THAWED, so unfreeze */
325 retval = unfreeze_cgroup(cgroup, freezer);
331 spin_unlock_irq(&freezer->lock);
336 static int freezer_write(struct cgroup *cgroup,
341 enum freezer_state goal_state;
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;
350 if (!cgroup_lock_live_group(cgroup))
352 retval = freezer_change_state(cgroup, goal_state);
357 static struct cftype files[] = {
360 .read_seq_string = freezer_read,
361 .write_string = freezer_write,
365 static int freezer_populate(struct cgroup_subsys *ss, struct cgroup *cgroup)
367 return cgroup_add_files(cgroup, ss, files, ARRAY_SIZE(files));
370 struct cgroup_subsys freezer_subsys = {
372 .create = freezer_create,
373 .destroy = freezer_destroy,
374 .populate = freezer_populate,
375 .subsys_id = freezer_subsys_id,
376 .can_attach = freezer_can_attach,
378 .fork = freezer_fork,