blob: 8d52c8e5b510a9ccab4eafbcf8ed3721734e2a8d [file] [log] [blame]
Paul Menageddbcc7e2007-10-18 23:39:30 -07001#ifndef _LINUX_CGROUP_H
2#define _LINUX_CGROUP_H
3/*
4 * cgroup interface
5 *
6 * Copyright (C) 2003 BULL SA
7 * Copyright (C) 2004-2006 Silicon Graphics, Inc.
8 *
9 */
10
11#include <linux/sched.h>
Paul Menageddbcc7e2007-10-18 23:39:30 -070012#include <linux/cpumask.h>
13#include <linux/nodemask.h>
14#include <linux/rcupdate.h>
Tejun Heoeb6fd502012-11-09 09:12:29 -080015#include <linux/rculist.h>
Balbir Singh846c7bb2007-10-18 23:39:44 -070016#include <linux/cgroupstats.h>
Paul Menagecc31edc2008-10-18 20:28:04 -070017#include <linux/rwsem.h>
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -070018#include <linux/idr.h>
Tejun Heo48ddbe12012-04-01 12:09:56 -070019#include <linux/workqueue.h>
Tejun Heo25a7e682013-04-14 20:15:25 -070020#include <linux/fs.h>
Tejun Heod3daf282013-06-13 19:39:16 -070021#include <linux/percpu-refcount.h>
Tejun Heo7da11272013-12-05 12:28:04 -050022#include <linux/seq_file.h>
Tejun Heo2bd59d42014-02-11 11:52:49 -050023#include <linux/kernfs.h>
Tejun Heof8f22e52014-04-23 11:13:16 -040024#include <linux/wait.h>
Paul Menageddbcc7e2007-10-18 23:39:30 -070025
26#ifdef CONFIG_CGROUPS
27
Tejun Heo3dd06ff2014-03-19 10:23:54 -040028struct cgroup_root;
Paul Menageddbcc7e2007-10-18 23:39:30 -070029struct cgroup_subsys;
30struct inode;
Paul Menage84eea842008-07-25 01:47:00 -070031struct cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -070032
33extern int cgroup_init_early(void);
34extern int cgroup_init(void);
Paul Menageb4f48b62007-10-18 23:39:33 -070035extern void cgroup_fork(struct task_struct *p);
Paul Menage817929e2007-10-18 23:39:36 -070036extern void cgroup_post_fork(struct task_struct *p);
Li Zefan1ec41832014-03-28 15:22:19 +080037extern void cgroup_exit(struct task_struct *p);
Balbir Singh846c7bb2007-10-18 23:39:44 -070038extern int cgroupstats_build(struct cgroupstats *stats,
39 struct dentry *dentry);
Paul Menageddbcc7e2007-10-18 23:39:30 -070040
Al Viro8d8b97b2013-04-19 23:11:24 -040041extern int proc_cgroup_show(struct seq_file *, void *);
Paul Menagea4243162007-10-18 23:39:35 -070042
Tejun Heo3ed80a62014-02-08 10:36:58 -050043/* define the enumeration of all cgroup subsystems */
Tejun Heo073219e2014-02-08 10:36:58 -050044#define SUBSYS(_x) _x ## _cgrp_id,
Paul Menage817929e2007-10-18 23:39:36 -070045enum cgroup_subsys_id {
46#include <linux/cgroup_subsys.h>
Daniel Wagnera6f00292012-09-12 16:12:08 +020047 CGROUP_SUBSYS_COUNT,
Paul Menage817929e2007-10-18 23:39:36 -070048};
49#undef SUBSYS
50
Tejun Heo5c9d5352014-05-16 13:22:48 -040051/*
52 * Per-subsystem/per-cgroup state maintained by the system. This is the
53 * fundamental structural building block that controllers deal with.
54 *
55 * Fields marked with "PI:" are public and immutable and may be accessed
56 * directly without synchronization.
57 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070058struct cgroup_subsys_state {
Tejun Heo5c9d5352014-05-16 13:22:48 -040059 /* PI: the cgroup that this css is attached to */
Paul Menageddbcc7e2007-10-18 23:39:30 -070060 struct cgroup *cgroup;
61
Tejun Heo5c9d5352014-05-16 13:22:48 -040062 /* PI: the cgroup subsystem that this css is attached to */
Tejun Heo72c97e52013-08-08 20:11:22 -040063 struct cgroup_subsys *ss;
64
Tejun Heod3daf282013-06-13 19:39:16 -070065 /* reference count - access via css_[try]get() and css_put() */
66 struct percpu_ref refcnt;
Paul Menageddbcc7e2007-10-18 23:39:30 -070067
Tejun Heo5c9d5352014-05-16 13:22:48 -040068 /* PI: the parent css */
Tejun Heo0ae78e02013-08-13 11:01:54 -040069 struct cgroup_subsys_state *parent;
70
Tejun Heod5c419b2014-05-16 13:22:48 -040071 /* siblings list anchored at the parent's ->children */
72 struct list_head sibling;
73 struct list_head children;
74
Tejun Heo15a4c832014-05-04 15:09:14 -040075 /*
Tejun Heo5c9d5352014-05-16 13:22:48 -040076 * PI: Subsys-unique ID. 0 is unused and root is always 1. The
Tejun Heo15a4c832014-05-04 15:09:14 -040077 * matching css can be looked up using css_from_id().
78 */
79 int id;
80
Tejun Heo69dfa002014-05-04 15:09:13 -040081 unsigned int flags;
Tejun Heo48ddbe12012-04-01 12:09:56 -070082
Tejun Heo0cb51d72014-05-16 13:22:49 -040083 /*
84 * Monotonically increasing unique serial number which defines a
85 * uniform order among all csses. It's guaranteed that all
86 * ->children lists are in the ascending order of ->serial_nr and
87 * used to allow interrupting and resuming iterations.
88 */
89 u64 serial_nr;
90
Tejun Heo0c21ead2013-08-13 20:22:51 -040091 /* percpu_ref killing and RCU release */
92 struct rcu_head rcu_head;
Tejun Heo35ef10d2013-08-13 11:01:54 -040093 struct work_struct destroy_work;
Paul Menageddbcc7e2007-10-18 23:39:30 -070094};
95
96/* bits in struct cgroup_subsys_state flags field */
97enum {
Tejun Heo3b514d22014-05-16 13:22:47 -040098 CSS_NO_REF = (1 << 0), /* no reference counting for this css */
Tejun Heo92fb9742012-11-19 08:13:38 -080099 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
Tejun Heode3f0342014-05-16 13:22:49 -0400100 CSS_RELEASED = (1 << 2), /* refcnt reached zero, released */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700101};
102
Tejun Heo5de01072013-06-12 21:04:52 -0700103/**
104 * css_get - obtain a reference on the specified css
105 * @css: target css
106 *
107 * The caller must already have a reference.
Paul Menageddbcc7e2007-10-18 23:39:30 -0700108 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700109static inline void css_get(struct cgroup_subsys_state *css)
110{
Tejun Heo3b514d22014-05-16 13:22:47 -0400111 if (!(css->flags & CSS_NO_REF))
112 percpu_ref_get(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700113}
Paul Menagee7c5ec92009-01-07 18:08:38 -0800114
Tejun Heo5de01072013-06-12 21:04:52 -0700115/**
Tejun Heo6f4524d2014-05-16 13:22:52 -0400116 * css_tryget - try to obtain a reference on the specified css
117 * @css: target css
118 *
119 * Obtain a reference on @css unless it already has reached zero and is
120 * being released. This function doesn't care whether @css is on or
121 * offline. The caller naturally needs to ensure that @css is accessible
122 * but doesn't have to be holding a reference on it - IOW, RCU protected
123 * access is good enough for this function. Returns %true if a reference
124 * count was successfully obtained; %false otherwise.
125 */
126static inline bool css_tryget(struct cgroup_subsys_state *css)
127{
128 if (!(css->flags & CSS_NO_REF))
129 return percpu_ref_tryget(&css->refcnt);
130 return true;
131}
132
133/**
Tejun Heoec903c02014-05-13 12:11:01 -0400134 * css_tryget_online - try to obtain a reference on the specified css if online
Tejun Heo5de01072013-06-12 21:04:52 -0700135 * @css: target css
136 *
Tejun Heoec903c02014-05-13 12:11:01 -0400137 * Obtain a reference on @css if it's online. The caller naturally needs
138 * to ensure that @css is accessible but doesn't have to be holding a
Tejun Heo5de01072013-06-12 21:04:52 -0700139 * reference on it - IOW, RCU protected access is good enough for this
140 * function. Returns %true if a reference count was successfully obtained;
141 * %false otherwise.
142 */
Tejun Heoec903c02014-05-13 12:11:01 -0400143static inline bool css_tryget_online(struct cgroup_subsys_state *css)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800144{
Tejun Heo3b514d22014-05-16 13:22:47 -0400145 if (!(css->flags & CSS_NO_REF))
146 return percpu_ref_tryget_live(&css->refcnt);
147 return true;
Paul Menagee7c5ec92009-01-07 18:08:38 -0800148}
149
Tejun Heo5de01072013-06-12 21:04:52 -0700150/**
151 * css_put - put a css reference
152 * @css: target css
153 *
Tejun Heoec903c02014-05-13 12:11:01 -0400154 * Put a reference obtained via css_get() and css_tryget_online().
Tejun Heo5de01072013-06-12 21:04:52 -0700155 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700156static inline void css_put(struct cgroup_subsys_state *css)
157{
Tejun Heo3b514d22014-05-16 13:22:47 -0400158 if (!(css->flags & CSS_NO_REF))
159 percpu_ref_put(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700160}
161
Paul Menage3116f0e2008-04-29 01:00:04 -0700162/* bits in struct cgroup flags field */
163enum {
Paul Menaged20a3902009-04-02 16:57:22 -0700164 /*
165 * Control Group has previously had a child cgroup or a task,
166 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
167 */
Paul Menage3116f0e2008-04-29 01:00:04 -0700168 CGRP_RELEASABLE,
169 /* Control Group requires release notifications to userspace */
170 CGRP_NOTIFY_ON_RELEASE,
KAMEZAWA Hiroyukiec64f512009-04-02 16:57:26 -0700171 /*
Tejun Heo2260e7f2012-11-19 08:13:38 -0800172 * Clone the parent's configuration when creating a new child
173 * cpuset cgroup. For historical reasons, this option can be
174 * specified at mount time and thus is implemented here.
Daniel Lezcano97978e62010-10-27 15:33:35 -0700175 */
Tejun Heo2260e7f2012-11-19 08:13:38 -0800176 CGRP_CPUSET_CLONE_CHILDREN,
Paul Menage3116f0e2008-04-29 01:00:04 -0700177};
178
Paul Menageddbcc7e2007-10-18 23:39:30 -0700179struct cgroup {
Tejun Heo9d800df2014-05-14 09:15:00 -0400180 /* self css with NULL ->ss, points back to this cgroup */
181 struct cgroup_subsys_state self;
182
Paul Menageddbcc7e2007-10-18 23:39:30 -0700183 unsigned long flags; /* "unsigned long" so bitops work */
184
Li Zefanb414dc02013-07-31 09:51:06 +0800185 /*
186 * idr allocated in-hierarchy ID.
187 *
Tejun Heo7d699dd2014-05-04 15:09:13 -0400188 * ID 0 is not used, the ID of the root cgroup is always 1, and a
189 * new cgroup will be assigned with a smallest available ID.
Li Zefan0ab02ca2014-02-11 16:05:46 +0800190 *
191 * Allocating/Removing ID must be protected by cgroup_mutex.
Li Zefanb414dc02013-07-31 09:51:06 +0800192 */
193 int id;
Tejun Heo0a950f62012-11-19 09:02:12 -0800194
Tejun Heo842b5972014-04-25 18:28:02 -0400195 /*
196 * If this cgroup contains any tasks, it contributes one to
197 * populated_cnt. All children with non-zero popuplated_cnt of
198 * their own contribute one. The count is zero iff there's no task
199 * in this cgroup or its subtree.
200 */
201 int populated_cnt;
202
Tejun Heo2bd59d42014-02-11 11:52:49 -0500203 struct kernfs_node *kn; /* cgroup kernfs entry */
Tejun Heo842b5972014-04-25 18:28:02 -0400204 struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700205
Tejun Heo667c2492014-07-08 18:02:56 -0400206 /*
207 * The bitmask of subsystems enabled on the child cgroups.
208 * ->subtree_control is the one configured through
209 * "cgroup.subtree_control" while ->child_subsys_mask is the
210 * effective one which may have more subsystems enabled.
211 */
212 unsigned int subtree_control;
Tejun Heo69dfa002014-05-04 15:09:13 -0400213 unsigned int child_subsys_mask;
Tejun Heo94419622014-03-19 10:23:54 -0400214
Paul Menageddbcc7e2007-10-18 23:39:30 -0700215 /* Private pointers for each registered subsystem */
Tejun Heo73e80ed2013-08-13 11:01:55 -0400216 struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
Paul Menageddbcc7e2007-10-18 23:39:30 -0700217
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400218 struct cgroup_root *root;
Paul Menage817929e2007-10-18 23:39:36 -0700219
220 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700221 * List of cgrp_cset_links pointing at css_sets with tasks in this
222 * cgroup. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700223 */
Tejun Heo69d02062013-06-12 21:04:50 -0700224 struct list_head cset_links;
Paul Menage81a6a5c2007-10-18 23:39:38 -0700225
226 /*
Tejun Heo2d8f2432014-04-23 11:13:15 -0400227 * On the default hierarchy, a css_set for a cgroup with some
228 * susbsys disabled will point to css's which are associated with
229 * the closest ancestor which has the subsys enabled. The
230 * following lists all css_sets which point to this cgroup's css
231 * for the given subsystem.
232 */
233 struct list_head e_csets[CGROUP_SUBSYS_COUNT];
234
235 /*
Paul Menage81a6a5c2007-10-18 23:39:38 -0700236 * Linked list running through all cgroups that can
237 * potentially be reaped by the release agent. Protected by
238 * release_list_lock
239 */
240 struct list_head release_list;
Paul Menagecc31edc2008-10-18 20:28:04 -0700241
Ben Blum72a8cb32009-09-23 15:56:27 -0700242 /*
243 * list of pidlists, up to two for each namespace (one for procs, one
244 * for tasks); created on demand.
245 */
246 struct list_head pidlists;
247 struct mutex pidlist_mutex;
Paul Menagea47295e2009-01-07 18:07:44 -0800248
Tejun Heof8f22e52014-04-23 11:13:16 -0400249 /* used to wait for offlining of csses */
250 wait_queue_head_t offline_waitq;
Paul Menage817929e2007-10-18 23:39:36 -0700251};
252
Tejun Heo25a7e682013-04-14 20:15:25 -0700253#define MAX_CGROUP_ROOT_NAMELEN 64
254
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400255/* cgroup_root->flags */
Tejun Heo25a7e682013-04-14 20:15:25 -0700256enum {
Tejun Heo873fe092013-04-14 20:15:26 -0700257 /*
258 * Unfortunately, cgroup core and various controllers are riddled
259 * with idiosyncrasies and pointless options. The following flag,
260 * when set, will force sane behavior - some options are forced on,
261 * others are disallowed, and some controllers will change their
262 * hierarchical or other behaviors.
263 *
264 * The set of behaviors affected by this flag are still being
265 * determined and developed and the mount option for this flag is
266 * prefixed with __DEVEL__. The prefix will be dropped once we
267 * reach the point where all behaviors are compatible with the
268 * planned unified hierarchy, which will automatically turn on this
269 * flag.
270 *
271 * The followings are the behaviors currently affected this flag.
272 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500273 * - Mount options "noprefix", "xattr", "clone_children",
274 * "release_agent" and "name" are disallowed.
Tejun Heo873fe092013-04-14 20:15:26 -0700275 *
276 * - When mounting an existing superblock, mount options should
277 * match.
278 *
279 * - Remount is disallowed.
280 *
Linus Torvalds0b0585c2013-07-02 20:04:25 -0700281 * - rename(2) is disallowed.
282 *
Tejun Heof63674f2013-06-13 19:58:38 -0700283 * - "tasks" is removed. Everything should be at process
284 * granularity. Use "cgroup.procs" instead.
285 *
Tejun Heoafb2bc12013-11-29 10:42:59 -0500286 * - "cgroup.procs" is not sorted. pids will be unique unless they
287 * got recycled inbetween reads.
288 *
Tejun Heof63674f2013-06-13 19:58:38 -0700289 * - "release_agent" and "notify_on_release" are removed.
290 * Replacement notification mechanism will be implemented.
291 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500292 * - "cgroup.clone_children" is removed.
Tejun Heo86bf4b62014-02-12 09:29:48 -0500293 *
Tejun Heo842b5972014-04-25 18:28:02 -0400294 * - "cgroup.subtree_populated" is available. Its value is 0 if
295 * the cgroup and its descendants contain no task; otherwise, 1.
296 * The file also generates kernfs notification which can be
297 * monitored through poll and [di]notify when the value of the
298 * file changes.
299 *
Tejun Heoa2dd4242014-03-19 10:23:55 -0400300 * - If mount is requested with sane_behavior but without any
301 * subsystem, the default unified hierarchy is mounted.
302 *
Li Zefan5c5cc622013-06-09 17:16:29 +0800303 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
304 * and take masks of ancestors with non-empty cpus/mems, instead of
305 * being moved to an ancestor.
306 *
Li Zefan88fa5232013-06-09 17:16:46 +0800307 * - cpuset: a task can be moved into an empty cpuset, and again it
308 * takes masks of ancestors.
Tejun Heo6db8e852013-06-14 11:18:22 -0700309 *
Tejun Heof00baae2013-04-15 13:41:15 -0700310 * - memcg: use_hierarchy is on by default and the cgroup file for
311 * the flag is not created.
312 *
Tejun Heo91381252013-05-14 13:52:38 -0700313 * - blkcg: blk-throttle becomes properly hierarchical.
Tejun Heo5533e012014-05-14 19:33:07 -0400314 *
315 * - debug: disallowed on the default hierarchy.
Tejun Heo873fe092013-04-14 20:15:26 -0700316 */
317 CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
318
Tejun Heo25a7e682013-04-14 20:15:25 -0700319 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
320 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
Tejun Heo0ce6cba2013-06-27 19:37:26 -0700321
322 /* mount options live below bit 16 */
323 CGRP_ROOT_OPTION_MASK = (1 << 16) - 1,
Tejun Heo25a7e682013-04-14 20:15:25 -0700324};
325
326/*
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400327 * A cgroup_root represents the root of a cgroup hierarchy, and may be
Tejun Heo2bd59d42014-02-11 11:52:49 -0500328 * associated with a kernfs_root to form an active hierarchy. This is
Tejun Heo25a7e682013-04-14 20:15:25 -0700329 * internal to cgroup core. Don't access directly from controllers.
330 */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400331struct cgroup_root {
Tejun Heo2bd59d42014-02-11 11:52:49 -0500332 struct kernfs_root *kf_root;
Tejun Heo25a7e682013-04-14 20:15:25 -0700333
Tejun Heof392e512014-04-23 11:13:14 -0400334 /* The bitmask of subsystems attached to this hierarchy */
Tejun Heo69dfa002014-05-04 15:09:13 -0400335 unsigned int subsys_mask;
Tejun Heof392e512014-04-23 11:13:14 -0400336
Tejun Heo25a7e682013-04-14 20:15:25 -0700337 /* Unique id for this hierarchy. */
338 int hierarchy_id;
339
Tejun Heo776f02f2014-02-12 09:29:50 -0500340 /* The root cgroup. Root is destroyed on its release. */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400341 struct cgroup cgrp;
Tejun Heo25a7e682013-04-14 20:15:25 -0700342
Tejun Heo3c9c8252014-02-12 09:29:50 -0500343 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
344 atomic_t nr_cgrps;
Tejun Heo25a7e682013-04-14 20:15:25 -0700345
346 /* A list running through the active hierarchies */
347 struct list_head root_list;
348
Tejun Heo25a7e682013-04-14 20:15:25 -0700349 /* Hierarchy-specific flags */
Tejun Heo69dfa002014-05-04 15:09:13 -0400350 unsigned int flags;
Tejun Heo25a7e682013-04-14 20:15:25 -0700351
352 /* IDs for cgroups in this hierarchy */
Li Zefan4e96ee8e2013-07-31 09:50:50 +0800353 struct idr cgroup_idr;
Tejun Heo25a7e682013-04-14 20:15:25 -0700354
355 /* The path to use for release notifications. */
356 char release_agent_path[PATH_MAX];
357
358 /* The name for this hierarchy - may be empty */
359 char name[MAX_CGROUP_ROOT_NAMELEN];
360};
361
Paul Menaged20a3902009-04-02 16:57:22 -0700362/*
363 * A css_set is a structure holding pointers to a set of
Paul Menage817929e2007-10-18 23:39:36 -0700364 * cgroup_subsys_state objects. This saves space in the task struct
365 * object and speeds up fork()/exit(), since a single inc/dec and a
Paul Menaged20a3902009-04-02 16:57:22 -0700366 * list_add()/del() can bump the reference count on the entire cgroup
367 * set for a task.
Paul Menage817929e2007-10-18 23:39:36 -0700368 */
369
370struct css_set {
371
372 /* Reference count */
Lai Jiangshan146aa1b2008-10-18 20:28:03 -0700373 atomic_t refcount;
Paul Menage817929e2007-10-18 23:39:36 -0700374
375 /*
Li Zefan472b1052008-04-29 01:00:11 -0700376 * List running through all cgroup groups in the same hash
377 * slot. Protected by css_set_lock
378 */
379 struct hlist_node hlist;
380
381 /*
Tejun Heoc7561122014-02-25 10:04:01 -0500382 * Lists running through all tasks using this cgroup group.
383 * mg_tasks lists tasks which belong to this cset but are in the
384 * process of being migrated out or in. Protected by
385 * css_set_rwsem, but, during migration, once tasks are moved to
386 * mg_tasks, it can be read safely while holding cgroup_mutex.
Paul Menage817929e2007-10-18 23:39:36 -0700387 */
388 struct list_head tasks;
Tejun Heoc7561122014-02-25 10:04:01 -0500389 struct list_head mg_tasks;
Paul Menage817929e2007-10-18 23:39:36 -0700390
391 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700392 * List of cgrp_cset_links pointing at cgroups referenced from this
393 * css_set. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700394 */
Tejun Heo69d02062013-06-12 21:04:50 -0700395 struct list_head cgrp_links;
Paul Menage817929e2007-10-18 23:39:36 -0700396
Tejun Heo6803c002014-04-23 11:13:16 -0400397 /* the default cgroup associated with this css_set */
398 struct cgroup *dfl_cgrp;
399
Paul Menage817929e2007-10-18 23:39:36 -0700400 /*
Tejun Heo3ed80a62014-02-08 10:36:58 -0500401 * Set of subsystem states, one for each subsystem. This array is
402 * immutable after creation apart from the init_css_set during
403 * subsystem registration (at boot time).
Paul Menage817929e2007-10-18 23:39:36 -0700404 */
405 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
Ben Blumc3783692009-09-23 15:56:29 -0700406
Tejun Heob3dc0942014-02-25 10:04:01 -0500407 /*
408 * List of csets participating in the on-going migration either as
409 * source or destination. Protected by cgroup_mutex.
410 */
Tejun Heo1958d2d2014-02-25 10:04:03 -0500411 struct list_head mg_preload_node;
Tejun Heob3dc0942014-02-25 10:04:01 -0500412 struct list_head mg_node;
413
414 /*
415 * If this cset is acting as the source of migration the following
416 * two fields are set. mg_src_cgrp is the source cgroup of the
417 * on-going migration and mg_dst_cset is the destination cset the
418 * target tasks on this cset should be migrated to. Protected by
419 * cgroup_mutex.
420 */
421 struct cgroup *mg_src_cgrp;
422 struct css_set *mg_dst_cset;
423
Tejun Heo2d8f2432014-04-23 11:13:15 -0400424 /*
425 * On the default hierarhcy, ->subsys[ssid] may point to a css
426 * attached to an ancestor instead of the cgroup this css_set is
427 * associated with. The following node is anchored at
428 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
429 * iterate through all css's attached to a given cgroup.
430 */
431 struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
432
Ben Blumc3783692009-09-23 15:56:29 -0700433 /* For RCU-protected deletion */
434 struct rcu_head rcu_head;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700435};
436
Paul Menage91796562008-04-29 01:00:01 -0700437/*
Paul Menaged20a3902009-04-02 16:57:22 -0700438 * struct cftype: handler definitions for cgroup control files
Paul Menageddbcc7e2007-10-18 23:39:30 -0700439 *
440 * When reading/writing to a file:
Li Zefana043e3b2008-02-23 15:24:09 -0800441 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
Paul Menageddbcc7e2007-10-18 23:39:30 -0700442 * - the 'cftype' of the file is file->f_dentry->d_fsdata
443 */
444
Tejun Heo8e3f6542012-04-01 12:09:55 -0700445/* cftype->flags */
Tejun Heo02c402d2013-06-24 15:21:47 -0700446enum {
Li Zefan6f4b7e62013-07-31 16:18:36 +0800447 CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
448 CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
Tejun Heo02c402d2013-06-24 15:21:47 -0700449 CFTYPE_INSANE = (1 << 2), /* don't create if sane_behavior */
Tejun Heo9fa4db32013-08-26 18:40:56 -0400450 CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
Tejun Heo8cbbf2c2014-03-19 10:23:55 -0400451 CFTYPE_ONLY_ON_DFL = (1 << 4), /* only on default hierarchy */
Tejun Heo02c402d2013-06-24 15:21:47 -0700452};
Tejun Heo8e3f6542012-04-01 12:09:55 -0700453
454#define MAX_CFTYPE_NAME 64
455
Paul Menageddbcc7e2007-10-18 23:39:30 -0700456struct cftype {
Paul Menaged20a3902009-04-02 16:57:22 -0700457 /*
458 * By convention, the name should begin with the name of the
Tejun Heo8e3f6542012-04-01 12:09:55 -0700459 * subsystem, followed by a period. Zero length string indicates
460 * end of cftype array.
Paul Menaged20a3902009-04-02 16:57:22 -0700461 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700462 char name[MAX_CFTYPE_NAME];
463 int private;
Li Zefan099fca32009-04-02 16:57:29 -0700464 /*
465 * If not 0, file mode is set to this value, otherwise it will
466 * be figured out automatically
467 */
Al Viroa5e7ed32011-07-26 01:55:55 -0400468 umode_t mode;
Paul Menagedb3b1492008-07-25 01:46:58 -0700469
470 /*
Tejun Heo5f469902014-02-11 11:52:48 -0500471 * The maximum length of string, excluding trailing nul, that can
Tejun Heo451af502014-05-13 12:16:21 -0400472 * be passed to write. If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
Paul Menagedb3b1492008-07-25 01:46:58 -0700473 */
474 size_t max_write_len;
475
Tejun Heo8e3f6542012-04-01 12:09:55 -0700476 /* CFTYPE_* flags */
477 unsigned int flags;
478
Tejun Heo2bb566c2013-08-08 20:11:23 -0400479 /*
Tejun Heo0adb0702014-02-12 09:29:48 -0500480 * Fields used for internal bookkeeping. Initialized automatically
481 * during registration.
Tejun Heo2bb566c2013-08-08 20:11:23 -0400482 */
Tejun Heo0adb0702014-02-12 09:29:48 -0500483 struct cgroup_subsys *ss; /* NULL for cgroup core files */
484 struct list_head node; /* anchored at ss->cfts */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500485 struct kernfs_ops *kf_ops;
486
Paul Menageddbcc7e2007-10-18 23:39:30 -0700487 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700488 * read_u64() is a shortcut for the common case of returning a
Paul Menageddbcc7e2007-10-18 23:39:30 -0700489 * single integer. Use it in place of read()
490 */
Tejun Heo182446d2013-08-08 20:11:24 -0400491 u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
Paul Menage91796562008-04-29 01:00:01 -0700492 /*
Paul Menagee73d2c62008-04-29 01:00:06 -0700493 * read_s64() is a signed version of read_u64()
494 */
Tejun Heo182446d2013-08-08 20:11:24 -0400495 s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
Tejun Heo2da8ca82013-12-05 12:28:04 -0500496
497 /* generic seq_file read interface */
498 int (*seq_show)(struct seq_file *sf, void *v);
Paul Menage91796562008-04-29 01:00:01 -0700499
Tejun Heo6612f052013-12-05 12:28:04 -0500500 /* optional ops, implement all or none */
501 void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
502 void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
503 void (*seq_stop)(struct seq_file *sf, void *v);
504
Paul Menage355e0c42007-10-18 23:39:33 -0700505 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700506 * write_u64() is a shortcut for the common case of accepting
Paul Menage355e0c42007-10-18 23:39:33 -0700507 * a single integer (as parsed by simple_strtoull) from
508 * userspace. Use in place of write(); return 0 or error.
509 */
Tejun Heo182446d2013-08-08 20:11:24 -0400510 int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
511 u64 val);
Paul Menagee73d2c62008-04-29 01:00:06 -0700512 /*
513 * write_s64() is a signed version of write_u64()
514 */
Tejun Heo182446d2013-08-08 20:11:24 -0400515 int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
516 s64 val);
Paul Menage355e0c42007-10-18 23:39:33 -0700517
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700518 /*
Tejun Heob4168642014-05-13 12:16:21 -0400519 * write() is the generic write callback which maps directly to
520 * kernfs write operation and overrides all other operations.
521 * Maximum write size is determined by ->max_write_len. Use
522 * of_css/cft() to access the associated css and cft.
523 */
524 ssize_t (*write)(struct kernfs_open_file *of,
525 char *buf, size_t nbytes, loff_t off);
526
Tejun Heo2bd59d42014-02-11 11:52:49 -0500527#ifdef CONFIG_DEBUG_LOCK_ALLOC
528 struct lock_class_key lockdep_key;
529#endif
Paul Menageddbcc7e2007-10-18 23:39:30 -0700530};
531
Tejun Heoa2dd4242014-03-19 10:23:55 -0400532extern struct cgroup_root cgrp_dfl_root;
Tejun Heo5024ae22014-05-07 21:31:17 -0400533extern struct css_set init_css_set;
Tejun Heoa2dd4242014-03-19 10:23:55 -0400534
535static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
536{
537 return cgrp->root == &cgrp_dfl_root;
538}
539
Tejun Heo8e3f6542012-04-01 12:09:55 -0700540/*
Tejun Heo873fe092013-04-14 20:15:26 -0700541 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
542 * function can be called as long as @cgrp is accessible.
543 */
544static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
545{
546 return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
547}
548
Tejun Heo07bc3562014-02-13 06:58:39 -0500549/* no synchronization, the result can only be used as a hint */
550static inline bool cgroup_has_tasks(struct cgroup *cgrp)
551{
552 return !list_empty(&cgrp->cset_links);
553}
554
Tejun Heob1664922014-02-11 11:52:49 -0500555/* returns ino associated with a cgroup, 0 indicates unmounted root */
556static inline ino_t cgroup_ino(struct cgroup *cgrp)
557{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500558 if (cgrp->kn)
559 return cgrp->kn->ino;
Tejun Heob1664922014-02-11 11:52:49 -0500560 else
561 return 0;
562}
563
Tejun Heob4168642014-05-13 12:16:21 -0400564/* cft/css accessors for cftype->write() operation */
565static inline struct cftype *of_cft(struct kernfs_open_file *of)
Tejun Heo7da11272013-12-05 12:28:04 -0500566{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500567 return of->kn->priv;
Tejun Heo7da11272013-12-05 12:28:04 -0500568}
569
Tejun Heob4168642014-05-13 12:16:21 -0400570struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
571
572/* cft/css accessors for cftype->seq_*() operations */
573static inline struct cftype *seq_cft(struct seq_file *seq)
574{
575 return of_cft(seq->private);
576}
577
578static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
579{
580 return of_css(seq->private);
581}
Tejun Heo59f52962014-02-11 11:52:49 -0500582
Tejun Heoe61734c2014-02-12 09:29:50 -0500583/*
584 * Name / path handling functions. All are thin wrappers around the kernfs
585 * counterparts and can be called under any context.
586 */
587
588static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
589{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400590 return kernfs_name(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500591}
592
593static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
594 size_t buflen)
595{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400596 return kernfs_path(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500597}
598
599static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
600{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400601 pr_cont_kernfs_name(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500602}
603
604static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
605{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400606 pr_cont_kernfs_path(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500607}
608
609char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
610
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400611int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo2bb566c2013-08-08 20:11:23 -0400612int cgroup_rm_cftypes(struct cftype *cfts);
Tejun Heo8e3f6542012-04-01 12:09:55 -0700613
Li Zefan78574cf2013-04-08 19:00:38 -0700614bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700615
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100616/*
Tejun Heo2f7ee562011-12-12 18:12:21 -0800617 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
618 * methods.
619 */
620struct cgroup_taskset;
621struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
622struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
Tejun Heo2f7ee562011-12-12 18:12:21 -0800623
624/**
625 * cgroup_taskset_for_each - iterate cgroup_taskset
626 * @task: the loop cursor
Tejun Heo2f7ee562011-12-12 18:12:21 -0800627 * @tset: taskset to iterate
628 */
Tejun Heo924f0d9a2014-02-13 06:58:41 -0500629#define cgroup_taskset_for_each(task, tset) \
Tejun Heo2f7ee562011-12-12 18:12:21 -0800630 for ((task) = cgroup_taskset_first((tset)); (task); \
Tejun Heo924f0d9a2014-02-13 06:58:41 -0500631 (task) = cgroup_taskset_next((tset)))
Tejun Heo2f7ee562011-12-12 18:12:21 -0800632
633/*
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100634 * Control Group subsystem type.
635 * See Documentation/cgroups/cgroups.txt for details
636 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700637
638struct cgroup_subsys {
Tejun Heoeb954192013-08-08 20:11:23 -0400639 struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
640 int (*css_online)(struct cgroup_subsys_state *css);
641 void (*css_offline)(struct cgroup_subsys_state *css);
642 void (*css_free)(struct cgroup_subsys_state *css);
Tejun Heo92fb9742012-11-19 08:13:38 -0800643
Tejun Heoeb954192013-08-08 20:11:23 -0400644 int (*can_attach)(struct cgroup_subsys_state *css,
645 struct cgroup_taskset *tset);
646 void (*cancel_attach)(struct cgroup_subsys_state *css,
647 struct cgroup_taskset *tset);
648 void (*attach)(struct cgroup_subsys_state *css,
649 struct cgroup_taskset *tset);
Li Zefan761b3ef52012-01-31 13:47:36 +0800650 void (*fork)(struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400651 void (*exit)(struct cgroup_subsys_state *css,
652 struct cgroup_subsys_state *old_css,
Li Zefan761b3ef52012-01-31 13:47:36 +0800653 struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400654 void (*bind)(struct cgroup_subsys_state *root_css);
Hugh Dickinse5991372009-01-06 14:39:22 -0800655
Paul Menage8bab8dd2008-04-04 14:29:57 -0700656 int disabled;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700657 int early_init;
Tejun Heo48ddbe12012-04-01 12:09:56 -0700658
659 /*
Tejun Heo8c7f6ed2012-09-13 12:20:58 -0700660 * If %false, this subsystem is properly hierarchical -
661 * configuration, resource accounting and restriction on a parent
662 * cgroup cover those of its children. If %true, hierarchy support
663 * is broken in some ways - some subsystems ignore hierarchy
664 * completely while others are only implemented half-way.
665 *
666 * It's now disallowed to create nested cgroups if the subsystem is
667 * broken and cgroup core will emit a warning message on such
668 * cases. Eventually, all subsystems will be made properly
669 * hierarchical and this will go away.
670 */
671 bool broken_hierarchy;
672 bool warned_broken_hierarchy;
673
Tejun Heo073219e2014-02-08 10:36:58 -0500674 /* the following two fields are initialized automtically during boot */
Tejun Heoaec25022014-02-08 10:36:58 -0500675 int id;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700676#define MAX_CGROUP_TYPE_NAMELEN 32
677 const char *name;
678
Tejun Heob85d2042013-12-06 15:11:57 -0500679 /* link to parent, protected by cgroup_lock() */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400680 struct cgroup_root *root;
Ben Blume6a11052010-03-10 15:22:09 -0800681
Tejun Heo15a4c832014-05-04 15:09:14 -0400682 /* idr for css->id */
683 struct idr css_idr;
684
Tejun Heo0adb0702014-02-12 09:29:48 -0500685 /*
686 * List of cftypes. Each entry is the first entry of an array
687 * terminated by zero length name.
688 */
689 struct list_head cfts;
Tejun Heo8e3f6542012-04-01 12:09:55 -0700690
Tejun Heode00ffa2014-02-11 11:52:48 -0500691 /* base cftypes, automatically registered with subsys itself */
Tejun Heo8e3f6542012-04-01 12:09:55 -0700692 struct cftype *base_cftypes;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700693};
694
Tejun Heo073219e2014-02-08 10:36:58 -0500695#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700696#include <linux/cgroup_subsys.h>
697#undef SUBSYS
698
Tejun Heo8af01f52013-08-08 20:11:22 -0400699/**
Tejun Heo14611e52013-06-25 11:48:32 -0700700 * task_css_set_check - obtain a task's css_set with extra access conditions
701 * @task: the task to obtain css_set for
702 * @__c: extra condition expression to be passed to rcu_dereference_check()
703 *
704 * A task's css_set is RCU protected, initialized and exited while holding
705 * task_lock(), and can only be modified while holding both cgroup_mutex
706 * and task_lock() while the task is alive. This macro verifies that the
707 * caller is inside proper critical section and returns @task's css_set.
708 *
709 * The caller can also specify additional allowed conditions via @__c, such
710 * as locks used during the cgroup_subsys::attach() methods.
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200711 */
Tejun Heo22194492013-04-07 09:29:51 -0700712#ifdef CONFIG_PROVE_RCU
713extern struct mutex cgroup_mutex;
Tejun Heo0e1d7682014-02-25 10:04:03 -0500714extern struct rw_semaphore css_set_rwsem;
Tejun Heo14611e52013-06-25 11:48:32 -0700715#define task_css_set_check(task, __c) \
716 rcu_dereference_check((task)->cgroups, \
Tejun Heo0e1d7682014-02-25 10:04:03 -0500717 lockdep_is_held(&cgroup_mutex) || \
718 lockdep_is_held(&css_set_rwsem) || \
719 ((task)->flags & PF_EXITING) || (__c))
Tejun Heo22194492013-04-07 09:29:51 -0700720#else
Tejun Heo14611e52013-06-25 11:48:32 -0700721#define task_css_set_check(task, __c) \
722 rcu_dereference((task)->cgroups)
Tejun Heo22194492013-04-07 09:29:51 -0700723#endif
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200724
Tejun Heo14611e52013-06-25 11:48:32 -0700725/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400726 * task_css_check - obtain css for (task, subsys) w/ extra access conds
Tejun Heo14611e52013-06-25 11:48:32 -0700727 * @task: the target task
728 * @subsys_id: the target subsystem ID
729 * @__c: extra condition expression to be passed to rcu_dereference_check()
730 *
731 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
732 * synchronization rules are the same as task_css_set_check().
733 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400734#define task_css_check(task, subsys_id, __c) \
Tejun Heo14611e52013-06-25 11:48:32 -0700735 task_css_set_check((task), (__c))->subsys[(subsys_id)]
736
737/**
738 * task_css_set - obtain a task's css_set
739 * @task: the task to obtain css_set for
740 *
741 * See task_css_set_check().
742 */
743static inline struct css_set *task_css_set(struct task_struct *task)
744{
745 return task_css_set_check(task, false);
746}
747
748/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400749 * task_css - obtain css for (task, subsys)
Tejun Heo14611e52013-06-25 11:48:32 -0700750 * @task: the target task
751 * @subsys_id: the target subsystem ID
752 *
Tejun Heo8af01f52013-08-08 20:11:22 -0400753 * See task_css_check().
Tejun Heo14611e52013-06-25 11:48:32 -0700754 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400755static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
756 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700757{
Tejun Heo8af01f52013-08-08 20:11:22 -0400758 return task_css_check(task, subsys_id, false);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700759}
760
Tejun Heo5024ae22014-05-07 21:31:17 -0400761/**
762 * task_css_is_root - test whether a task belongs to the root css
763 * @task: the target task
764 * @subsys_id: the target subsystem ID
765 *
766 * Test whether @task belongs to the root css on the specified subsystem.
767 * May be invoked in any context.
768 */
769static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
770{
771 return task_css_check(task, subsys_id, true) ==
772 init_css_set.subsys[subsys_id];
773}
774
Tejun Heo8af01f52013-08-08 20:11:22 -0400775static inline struct cgroup *task_cgroup(struct task_struct *task,
776 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700777{
Tejun Heo8af01f52013-08-08 20:11:22 -0400778 return task_css(task, subsys_id)->cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700779}
780
Tejun Heo492eb212013-08-08 20:11:25 -0400781struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
782 struct cgroup_subsys_state *parent);
Tejun Heo53fa5262013-05-24 10:55:38 +0900783
Li Zefan1cb650b2013-08-19 10:05:24 +0800784struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
785
Tejun Heo574bd9f2012-11-09 09:12:29 -0800786/**
Tejun Heo492eb212013-08-08 20:11:25 -0400787 * css_for_each_child - iterate through children of a css
788 * @pos: the css * to use as the loop cursor
789 * @parent: css whose children to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800790 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400791 * Walk @parent's children. Must be called under rcu_read_lock().
Tejun Heo574bd9f2012-11-09 09:12:29 -0800792 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400793 * If a subsystem synchronizes ->css_online() and the start of iteration, a
794 * css which finished ->css_online() is guaranteed to be visible in the
795 * future iterations and will stay visible until the last reference is put.
796 * A css which hasn't finished ->css_online() or already finished
797 * ->css_offline() may show up during traversal. It's each subsystem's
798 * responsibility to synchronize against on/offlining.
Tejun Heo75501a62013-05-24 10:55:38 +0900799 *
800 * It is allowed to temporarily drop RCU read lock during iteration. The
801 * caller is responsible for ensuring that @pos remains accessible until
802 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800803 */
Tejun Heo492eb212013-08-08 20:11:25 -0400804#define css_for_each_child(pos, parent) \
805 for ((pos) = css_next_child(NULL, (parent)); (pos); \
806 (pos) = css_next_child((pos), (parent)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800807
Tejun Heo492eb212013-08-08 20:11:25 -0400808struct cgroup_subsys_state *
809css_next_descendant_pre(struct cgroup_subsys_state *pos,
810 struct cgroup_subsys_state *css);
811
812struct cgroup_subsys_state *
813css_rightmost_descendant(struct cgroup_subsys_state *pos);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800814
815/**
Tejun Heo492eb212013-08-08 20:11:25 -0400816 * css_for_each_descendant_pre - pre-order walk of a css's descendants
817 * @pos: the css * to use as the loop cursor
818 * @root: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800819 *
Tejun Heobd8815a2013-08-08 20:11:27 -0400820 * Walk @root's descendants. @root is included in the iteration and the
Tejun Heoc2931b72014-05-16 13:22:51 -0400821 * first node to be visited. Must be called under rcu_read_lock().
Tejun Heo574bd9f2012-11-09 09:12:29 -0800822 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400823 * If a subsystem synchronizes ->css_online() and the start of iteration, a
824 * css which finished ->css_online() is guaranteed to be visible in the
825 * future iterations and will stay visible until the last reference is put.
826 * A css which hasn't finished ->css_online() or already finished
827 * ->css_offline() may show up during traversal. It's each subsystem's
828 * responsibility to synchronize against on/offlining.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800829 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400830 * For example, the following guarantees that a descendant can't escape
Tejun Heo574bd9f2012-11-09 09:12:29 -0800831 * state updates of its ancestors.
832 *
Tejun Heo492eb212013-08-08 20:11:25 -0400833 * my_online(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800834 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400835 * Lock @css's parent and @css;
836 * Inherit state from the parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800837 * Unlock both.
838 * }
839 *
Tejun Heo492eb212013-08-08 20:11:25 -0400840 * my_update_state(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800841 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400842 * css_for_each_descendant_pre(@pos, @css) {
Tejun Heo574bd9f2012-11-09 09:12:29 -0800843 * Lock @pos;
Tejun Heobd8815a2013-08-08 20:11:27 -0400844 * if (@pos == @css)
845 * Update @css's state;
846 * else
847 * Verify @pos is alive and inherit state from its parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800848 * Unlock @pos;
849 * }
850 * }
851 *
852 * As long as the inheriting step, including checking the parent state, is
853 * enclosed inside @pos locking, double-locking the parent isn't necessary
854 * while inheriting. The state update to the parent is guaranteed to be
855 * visible by walking order and, as long as inheriting operations to the
856 * same @pos are atomic to each other, multiple updates racing each other
857 * still result in the correct state. It's guaranateed that at least one
Tejun Heo492eb212013-08-08 20:11:25 -0400858 * inheritance happens for any css after the latest update to its parent.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800859 *
860 * If checking parent's state requires locking the parent, each inheriting
861 * iteration should lock and unlock both @pos->parent and @pos.
862 *
863 * Alternatively, a subsystem may choose to use a single global lock to
Tejun Heo92fb9742012-11-19 08:13:38 -0800864 * synchronize ->css_online() and ->css_offline() against tree-walking
Tejun Heo574bd9f2012-11-09 09:12:29 -0800865 * operations.
Tejun Heo75501a62013-05-24 10:55:38 +0900866 *
867 * It is allowed to temporarily drop RCU read lock during iteration. The
868 * caller is responsible for ensuring that @pos remains accessible until
869 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800870 */
Tejun Heo492eb212013-08-08 20:11:25 -0400871#define css_for_each_descendant_pre(pos, css) \
872 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
873 (pos) = css_next_descendant_pre((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800874
Tejun Heo492eb212013-08-08 20:11:25 -0400875struct cgroup_subsys_state *
876css_next_descendant_post(struct cgroup_subsys_state *pos,
877 struct cgroup_subsys_state *css);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800878
879/**
Tejun Heo492eb212013-08-08 20:11:25 -0400880 * css_for_each_descendant_post - post-order walk of a css's descendants
881 * @pos: the css * to use as the loop cursor
882 * @css: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800883 *
Tejun Heo492eb212013-08-08 20:11:25 -0400884 * Similar to css_for_each_descendant_pre() but performs post-order
Tejun Heobd8815a2013-08-08 20:11:27 -0400885 * traversal instead. @root is included in the iteration and the last
Tejun Heoc2931b72014-05-16 13:22:51 -0400886 * node to be visited.
887 *
888 * If a subsystem synchronizes ->css_online() and the start of iteration, a
889 * css which finished ->css_online() is guaranteed to be visible in the
890 * future iterations and will stay visible until the last reference is put.
891 * A css which hasn't finished ->css_online() or already finished
892 * ->css_offline() may show up during traversal. It's each subsystem's
893 * responsibility to synchronize against on/offlining.
894 *
895 * Note that the walk visibility guarantee example described in pre-order
896 * walk doesn't apply the same to post-order walks.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800897 */
Tejun Heo492eb212013-08-08 20:11:25 -0400898#define css_for_each_descendant_post(pos, css) \
899 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
900 (pos) = css_next_descendant_post((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800901
Tejun Heof3d46502014-05-16 13:22:52 -0400902bool css_has_online_children(struct cgroup_subsys_state *css);
903
Tejun Heo72ec7022013-08-08 20:11:26 -0400904/* A css_task_iter should be treated as an opaque object */
905struct css_task_iter {
Tejun Heo3ebb2b62014-04-23 11:13:15 -0400906 struct cgroup_subsys *ss;
907
Tejun Heo0f0a2b42014-04-23 11:13:15 -0400908 struct list_head *cset_pos;
909 struct list_head *cset_head;
910
911 struct list_head *task_pos;
912 struct list_head *tasks_head;
913 struct list_head *mg_tasks_head;
Paul Menage817929e2007-10-18 23:39:36 -0700914};
915
Tejun Heo72ec7022013-08-08 20:11:26 -0400916void css_task_iter_start(struct cgroup_subsys_state *css,
917 struct css_task_iter *it);
918struct task_struct *css_task_iter_next(struct css_task_iter *it);
919void css_task_iter_end(struct css_task_iter *it);
Tejun Heoe5358372013-08-08 20:11:26 -0400920
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700921int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
Tejun Heo8cc99342013-04-07 09:29:50 -0700922int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700923
Tejun Heoec903c02014-05-13 12:11:01 -0400924struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
925 struct cgroup_subsys *ss);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700926
Paul Menageddbcc7e2007-10-18 23:39:30 -0700927#else /* !CONFIG_CGROUPS */
928
929static inline int cgroup_init_early(void) { return 0; }
930static inline int cgroup_init(void) { return 0; }
Paul Menageb4f48b62007-10-18 23:39:33 -0700931static inline void cgroup_fork(struct task_struct *p) {}
Paul Menage817929e2007-10-18 23:39:36 -0700932static inline void cgroup_post_fork(struct task_struct *p) {}
Li Zefan1ec41832014-03-28 15:22:19 +0800933static inline void cgroup_exit(struct task_struct *p) {}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700934
Balbir Singh846c7bb2007-10-18 23:39:44 -0700935static inline int cgroupstats_build(struct cgroupstats *stats,
936 struct dentry *dentry)
937{
938 return -EINVAL;
939}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700940
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200941/* No cgroups - nothing to do */
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700942static inline int cgroup_attach_task_all(struct task_struct *from,
943 struct task_struct *t)
944{
945 return 0;
946}
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200947
Paul Menageddbcc7e2007-10-18 23:39:30 -0700948#endif /* !CONFIG_CGROUPS */
949
Paul Menageddbcc7e2007-10-18 23:39:30 -0700950#endif /* _LINUX_CGROUP_H */