blob: 7e9fa505b7bbb31d078c37110509c14006c2416a [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>
Paul Menageddbcc7e2007-10-18 23:39:30 -070024
25#ifdef CONFIG_CGROUPS
26
Tejun Heo3dd06ff2014-03-19 10:23:54 -040027struct cgroup_root;
Paul Menageddbcc7e2007-10-18 23:39:30 -070028struct cgroup_subsys;
29struct inode;
Paul Menage84eea842008-07-25 01:47:00 -070030struct cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -070031
32extern int cgroup_init_early(void);
33extern int cgroup_init(void);
Paul Menageb4f48b62007-10-18 23:39:33 -070034extern void cgroup_fork(struct task_struct *p);
Paul Menage817929e2007-10-18 23:39:36 -070035extern void cgroup_post_fork(struct task_struct *p);
Paul Menageb4f48b62007-10-18 23:39:33 -070036extern void cgroup_exit(struct task_struct *p, int run_callbacks);
Balbir Singh846c7bb2007-10-18 23:39:44 -070037extern int cgroupstats_build(struct cgroupstats *stats,
38 struct dentry *dentry);
Paul Menageddbcc7e2007-10-18 23:39:30 -070039
Al Viro8d8b97b2013-04-19 23:11:24 -040040extern int proc_cgroup_show(struct seq_file *, void *);
Paul Menagea4243162007-10-18 23:39:35 -070041
Tejun Heo3ed80a62014-02-08 10:36:58 -050042/* define the enumeration of all cgroup subsystems */
Tejun Heo073219e2014-02-08 10:36:58 -050043#define SUBSYS(_x) _x ## _cgrp_id,
Paul Menage817929e2007-10-18 23:39:36 -070044enum cgroup_subsys_id {
45#include <linux/cgroup_subsys.h>
Daniel Wagnera6f00292012-09-12 16:12:08 +020046 CGROUP_SUBSYS_COUNT,
Paul Menage817929e2007-10-18 23:39:36 -070047};
48#undef SUBSYS
49
Paul Menageddbcc7e2007-10-18 23:39:30 -070050/* Per-subsystem/per-cgroup state maintained by the system. */
51struct cgroup_subsys_state {
Tejun Heo72c97e52013-08-08 20:11:22 -040052 /* the cgroup that this css is attached to */
Paul Menageddbcc7e2007-10-18 23:39:30 -070053 struct cgroup *cgroup;
54
Tejun Heo72c97e52013-08-08 20:11:22 -040055 /* the cgroup subsystem that this css is attached to */
56 struct cgroup_subsys *ss;
57
Tejun Heod3daf282013-06-13 19:39:16 -070058 /* reference count - access via css_[try]get() and css_put() */
59 struct percpu_ref refcnt;
Paul Menageddbcc7e2007-10-18 23:39:30 -070060
Tejun Heo0ae78e02013-08-13 11:01:54 -040061 /* the parent css */
62 struct cgroup_subsys_state *parent;
63
Paul Menageddbcc7e2007-10-18 23:39:30 -070064 unsigned long flags;
Tejun Heo48ddbe12012-04-01 12:09:56 -070065
Tejun Heo0c21ead2013-08-13 20:22:51 -040066 /* percpu_ref killing and RCU release */
67 struct rcu_head rcu_head;
Tejun Heo35ef10d2013-08-13 11:01:54 -040068 struct work_struct destroy_work;
Paul Menageddbcc7e2007-10-18 23:39:30 -070069};
70
71/* bits in struct cgroup_subsys_state flags field */
72enum {
Tejun Heo38b53ab2012-11-19 08:13:36 -080073 CSS_ROOT = (1 << 0), /* this CSS is the root of the subsystem */
Tejun Heo92fb9742012-11-19 08:13:38 -080074 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
Paul Menageddbcc7e2007-10-18 23:39:30 -070075};
76
Tejun Heo5de01072013-06-12 21:04:52 -070077/**
78 * css_get - obtain a reference on the specified css
79 * @css: target css
80 *
81 * The caller must already have a reference.
Paul Menageddbcc7e2007-10-18 23:39:30 -070082 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070083static inline void css_get(struct cgroup_subsys_state *css)
84{
85 /* We don't need to reference count the root state */
Tejun Heo38b53ab2012-11-19 08:13:36 -080086 if (!(css->flags & CSS_ROOT))
Tejun Heod3daf282013-06-13 19:39:16 -070087 percpu_ref_get(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -070088}
Paul Menagee7c5ec92009-01-07 18:08:38 -080089
Tejun Heo5de01072013-06-12 21:04:52 -070090/**
91 * css_tryget - try to obtain a reference on the specified css
92 * @css: target css
93 *
94 * Obtain a reference on @css if it's alive. The caller naturally needs to
95 * ensure that @css is accessible but doesn't have to be holding a
96 * reference on it - IOW, RCU protected access is good enough for this
97 * function. Returns %true if a reference count was successfully obtained;
98 * %false otherwise.
99 */
Paul Menagee7c5ec92009-01-07 18:08:38 -0800100static inline bool css_tryget(struct cgroup_subsys_state *css)
101{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800102 if (css->flags & CSS_ROOT)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800103 return true;
Tejun Heod3daf282013-06-13 19:39:16 -0700104 return percpu_ref_tryget(&css->refcnt);
Paul Menagee7c5ec92009-01-07 18:08:38 -0800105}
106
Tejun Heo5de01072013-06-12 21:04:52 -0700107/**
108 * css_put - put a css reference
109 * @css: target css
110 *
111 * Put a reference obtained via css_get() and css_tryget().
112 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700113static inline void css_put(struct cgroup_subsys_state *css)
114{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800115 if (!(css->flags & CSS_ROOT))
Tejun Heod3daf282013-06-13 19:39:16 -0700116 percpu_ref_put(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700117}
118
Paul Menage3116f0e2008-04-29 01:00:04 -0700119/* bits in struct cgroup flags field */
120enum {
121 /* Control Group is dead */
Tejun Heo54766d42013-06-12 21:04:53 -0700122 CGRP_DEAD,
Paul Menaged20a3902009-04-02 16:57:22 -0700123 /*
124 * Control Group has previously had a child cgroup or a task,
125 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
126 */
Paul Menage3116f0e2008-04-29 01:00:04 -0700127 CGRP_RELEASABLE,
128 /* Control Group requires release notifications to userspace */
129 CGRP_NOTIFY_ON_RELEASE,
KAMEZAWA Hiroyukiec64f512009-04-02 16:57:26 -0700130 /*
Tejun Heo2260e7f2012-11-19 08:13:38 -0800131 * Clone the parent's configuration when creating a new child
132 * cpuset cgroup. For historical reasons, this option can be
133 * specified at mount time and thus is implemented here.
Daniel Lezcano97978e62010-10-27 15:33:35 -0700134 */
Tejun Heo2260e7f2012-11-19 08:13:38 -0800135 CGRP_CPUSET_CLONE_CHILDREN,
Tejun Heo873fe092013-04-14 20:15:26 -0700136 /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
137 CGRP_SANE_BEHAVIOR,
Paul Menage3116f0e2008-04-29 01:00:04 -0700138};
139
Paul Menageddbcc7e2007-10-18 23:39:30 -0700140struct cgroup {
141 unsigned long flags; /* "unsigned long" so bitops work */
142
Li Zefanb414dc02013-07-31 09:51:06 +0800143 /*
144 * idr allocated in-hierarchy ID.
145 *
146 * The ID of the root cgroup is always 0, and a new cgroup
147 * will be assigned with a smallest available ID.
Li Zefan0ab02ca2014-02-11 16:05:46 +0800148 *
149 * Allocating/Removing ID must be protected by cgroup_mutex.
Li Zefanb414dc02013-07-31 09:51:06 +0800150 */
151 int id;
Tejun Heo0a950f62012-11-19 09:02:12 -0800152
Tejun Heof20104d2013-08-13 20:22:50 -0400153 /* the number of attached css's */
154 int nr_css;
155
Tejun Heo2bd59d42014-02-11 11:52:49 -0500156 atomic_t refcnt;
157
Paul Menageddbcc7e2007-10-18 23:39:30 -0700158 /*
159 * We link our 'sibling' struct into our parent's 'children'.
160 * Our children link their 'sibling' into our 'children'.
161 */
162 struct list_head sibling; /* my parent's children */
163 struct list_head children; /* my children */
164
Paul Menaged20a3902009-04-02 16:57:22 -0700165 struct cgroup *parent; /* my parent */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500166 struct kernfs_node *kn; /* cgroup kernfs entry */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700167
Li Zefan65dff752013-03-01 15:01:56 +0800168 /*
Tejun Heo53fa5262013-05-24 10:55:38 +0900169 * Monotonically increasing unique serial number which defines a
170 * uniform order among all cgroups. It's guaranteed that all
171 * ->children lists are in the ascending order of ->serial_nr.
172 * It's used to allow interrupting and resuming iterations.
173 */
174 u64 serial_nr;
175
Tejun Heo94419622014-03-19 10:23:54 -0400176 /* The bitmask of subsystems attached to this cgroup */
177 unsigned long subsys_mask;
178
Paul Menageddbcc7e2007-10-18 23:39:30 -0700179 /* Private pointers for each registered subsystem */
Tejun Heo73e80ed2013-08-13 11:01:55 -0400180 struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
Paul Menageddbcc7e2007-10-18 23:39:30 -0700181
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400182 struct cgroup_root *root;
Paul Menage817929e2007-10-18 23:39:36 -0700183
184 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700185 * List of cgrp_cset_links pointing at css_sets with tasks in this
186 * cgroup. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700187 */
Tejun Heo69d02062013-06-12 21:04:50 -0700188 struct list_head cset_links;
Paul Menage81a6a5c2007-10-18 23:39:38 -0700189
190 /*
191 * Linked list running through all cgroups that can
192 * potentially be reaped by the release agent. Protected by
193 * release_list_lock
194 */
195 struct list_head release_list;
Paul Menagecc31edc2008-10-18 20:28:04 -0700196
Ben Blum72a8cb32009-09-23 15:56:27 -0700197 /*
198 * list of pidlists, up to two for each namespace (one for procs, one
199 * for tasks); created on demand.
200 */
201 struct list_head pidlists;
202 struct mutex pidlist_mutex;
Paul Menagea47295e2009-01-07 18:07:44 -0800203
Tejun Heo67f4c362013-08-08 20:11:24 -0400204 /* dummy css with NULL ->ss, points back to this cgroup */
205 struct cgroup_subsys_state dummy_css;
206
Tejun Heod3daf282013-06-13 19:39:16 -0700207 /* For css percpu_ref killing and RCU-protected deletion */
Paul Menagea47295e2009-01-07 18:07:44 -0800208 struct rcu_head rcu_head;
Tejun Heoea15f8c2013-06-13 19:27:42 -0700209 struct work_struct destroy_work;
Paul Menage817929e2007-10-18 23:39:36 -0700210};
211
Tejun Heo25a7e682013-04-14 20:15:25 -0700212#define MAX_CGROUP_ROOT_NAMELEN 64
213
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400214/* cgroup_root->flags */
Tejun Heo25a7e682013-04-14 20:15:25 -0700215enum {
Tejun Heo873fe092013-04-14 20:15:26 -0700216 /*
217 * Unfortunately, cgroup core and various controllers are riddled
218 * with idiosyncrasies and pointless options. The following flag,
219 * when set, will force sane behavior - some options are forced on,
220 * others are disallowed, and some controllers will change their
221 * hierarchical or other behaviors.
222 *
223 * The set of behaviors affected by this flag are still being
224 * determined and developed and the mount option for this flag is
225 * prefixed with __DEVEL__. The prefix will be dropped once we
226 * reach the point where all behaviors are compatible with the
227 * planned unified hierarchy, which will automatically turn on this
228 * flag.
229 *
230 * The followings are the behaviors currently affected this flag.
231 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500232 * - Mount options "noprefix", "xattr", "clone_children",
233 * "release_agent" and "name" are disallowed.
Tejun Heo873fe092013-04-14 20:15:26 -0700234 *
235 * - When mounting an existing superblock, mount options should
236 * match.
237 *
238 * - Remount is disallowed.
239 *
Linus Torvalds0b0585c2013-07-02 20:04:25 -0700240 * - rename(2) is disallowed.
241 *
Tejun Heof63674f2013-06-13 19:58:38 -0700242 * - "tasks" is removed. Everything should be at process
243 * granularity. Use "cgroup.procs" instead.
244 *
Tejun Heoafb2bc12013-11-29 10:42:59 -0500245 * - "cgroup.procs" is not sorted. pids will be unique unless they
246 * got recycled inbetween reads.
247 *
Tejun Heof63674f2013-06-13 19:58:38 -0700248 * - "release_agent" and "notify_on_release" are removed.
249 * Replacement notification mechanism will be implemented.
250 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500251 * - "cgroup.clone_children" is removed.
Tejun Heo86bf4b62014-02-12 09:29:48 -0500252 *
Tejun Heoa2dd4242014-03-19 10:23:55 -0400253 * - If mount is requested with sane_behavior but without any
254 * subsystem, the default unified hierarchy is mounted.
255 *
Li Zefan5c5cc622013-06-09 17:16:29 +0800256 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
257 * and take masks of ancestors with non-empty cpus/mems, instead of
258 * being moved to an ancestor.
259 *
Li Zefan88fa5232013-06-09 17:16:46 +0800260 * - cpuset: a task can be moved into an empty cpuset, and again it
261 * takes masks of ancestors.
Tejun Heo6db8e852013-06-14 11:18:22 -0700262 *
Tejun Heof00baae2013-04-15 13:41:15 -0700263 * - memcg: use_hierarchy is on by default and the cgroup file for
264 * the flag is not created.
265 *
Tejun Heo91381252013-05-14 13:52:38 -0700266 * - blkcg: blk-throttle becomes properly hierarchical.
Tejun Heo873fe092013-04-14 20:15:26 -0700267 */
268 CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
269
Tejun Heo25a7e682013-04-14 20:15:25 -0700270 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
271 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
Tejun Heo0ce6cba2013-06-27 19:37:26 -0700272
273 /* mount options live below bit 16 */
274 CGRP_ROOT_OPTION_MASK = (1 << 16) - 1,
Tejun Heo25a7e682013-04-14 20:15:25 -0700275};
276
277/*
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400278 * A cgroup_root represents the root of a cgroup hierarchy, and may be
Tejun Heo2bd59d42014-02-11 11:52:49 -0500279 * associated with a kernfs_root to form an active hierarchy. This is
Tejun Heo25a7e682013-04-14 20:15:25 -0700280 * internal to cgroup core. Don't access directly from controllers.
281 */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400282struct cgroup_root {
Tejun Heo2bd59d42014-02-11 11:52:49 -0500283 struct kernfs_root *kf_root;
Tejun Heo25a7e682013-04-14 20:15:25 -0700284
Tejun Heo25a7e682013-04-14 20:15:25 -0700285 /* Unique id for this hierarchy. */
286 int hierarchy_id;
287
Tejun Heo776f02f2014-02-12 09:29:50 -0500288 /* The root cgroup. Root is destroyed on its release. */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400289 struct cgroup cgrp;
Tejun Heo25a7e682013-04-14 20:15:25 -0700290
Tejun Heo3c9c8252014-02-12 09:29:50 -0500291 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
292 atomic_t nr_cgrps;
Tejun Heo25a7e682013-04-14 20:15:25 -0700293
294 /* A list running through the active hierarchies */
295 struct list_head root_list;
296
Tejun Heo25a7e682013-04-14 20:15:25 -0700297 /* Hierarchy-specific flags */
298 unsigned long flags;
299
300 /* IDs for cgroups in this hierarchy */
Li Zefan4e96ee8e2013-07-31 09:50:50 +0800301 struct idr cgroup_idr;
Tejun Heo25a7e682013-04-14 20:15:25 -0700302
303 /* The path to use for release notifications. */
304 char release_agent_path[PATH_MAX];
305
306 /* The name for this hierarchy - may be empty */
307 char name[MAX_CGROUP_ROOT_NAMELEN];
308};
309
Paul Menaged20a3902009-04-02 16:57:22 -0700310/*
311 * A css_set is a structure holding pointers to a set of
Paul Menage817929e2007-10-18 23:39:36 -0700312 * cgroup_subsys_state objects. This saves space in the task struct
313 * object and speeds up fork()/exit(), since a single inc/dec and a
Paul Menaged20a3902009-04-02 16:57:22 -0700314 * list_add()/del() can bump the reference count on the entire cgroup
315 * set for a task.
Paul Menage817929e2007-10-18 23:39:36 -0700316 */
317
318struct css_set {
319
320 /* Reference count */
Lai Jiangshan146aa1b2008-10-18 20:28:03 -0700321 atomic_t refcount;
Paul Menage817929e2007-10-18 23:39:36 -0700322
323 /*
Li Zefan472b1052008-04-29 01:00:11 -0700324 * List running through all cgroup groups in the same hash
325 * slot. Protected by css_set_lock
326 */
327 struct hlist_node hlist;
328
329 /*
Tejun Heoc7561122014-02-25 10:04:01 -0500330 * Lists running through all tasks using this cgroup group.
331 * mg_tasks lists tasks which belong to this cset but are in the
332 * process of being migrated out or in. Protected by
333 * css_set_rwsem, but, during migration, once tasks are moved to
334 * mg_tasks, it can be read safely while holding cgroup_mutex.
Paul Menage817929e2007-10-18 23:39:36 -0700335 */
336 struct list_head tasks;
Tejun Heoc7561122014-02-25 10:04:01 -0500337 struct list_head mg_tasks;
Paul Menage817929e2007-10-18 23:39:36 -0700338
339 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700340 * List of cgrp_cset_links pointing at cgroups referenced from this
341 * css_set. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700342 */
Tejun Heo69d02062013-06-12 21:04:50 -0700343 struct list_head cgrp_links;
Paul Menage817929e2007-10-18 23:39:36 -0700344
345 /*
Tejun Heo3ed80a62014-02-08 10:36:58 -0500346 * Set of subsystem states, one for each subsystem. This array is
347 * immutable after creation apart from the init_css_set during
348 * subsystem registration (at boot time).
Paul Menage817929e2007-10-18 23:39:36 -0700349 */
350 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
Ben Blumc3783692009-09-23 15:56:29 -0700351
Tejun Heob3dc0942014-02-25 10:04:01 -0500352 /*
353 * List of csets participating in the on-going migration either as
354 * source or destination. Protected by cgroup_mutex.
355 */
Tejun Heo1958d2d2014-02-25 10:04:03 -0500356 struct list_head mg_preload_node;
Tejun Heob3dc0942014-02-25 10:04:01 -0500357 struct list_head mg_node;
358
359 /*
360 * If this cset is acting as the source of migration the following
361 * two fields are set. mg_src_cgrp is the source cgroup of the
362 * on-going migration and mg_dst_cset is the destination cset the
363 * target tasks on this cset should be migrated to. Protected by
364 * cgroup_mutex.
365 */
366 struct cgroup *mg_src_cgrp;
367 struct css_set *mg_dst_cset;
368
Ben Blumc3783692009-09-23 15:56:29 -0700369 /* For RCU-protected deletion */
370 struct rcu_head rcu_head;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700371};
372
Paul Menage91796562008-04-29 01:00:01 -0700373/*
Paul Menaged20a3902009-04-02 16:57:22 -0700374 * struct cftype: handler definitions for cgroup control files
Paul Menageddbcc7e2007-10-18 23:39:30 -0700375 *
376 * When reading/writing to a file:
Li Zefana043e3b2008-02-23 15:24:09 -0800377 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
Paul Menageddbcc7e2007-10-18 23:39:30 -0700378 * - the 'cftype' of the file is file->f_dentry->d_fsdata
379 */
380
Tejun Heo8e3f6542012-04-01 12:09:55 -0700381/* cftype->flags */
Tejun Heo02c402d2013-06-24 15:21:47 -0700382enum {
Li Zefan6f4b7e62013-07-31 16:18:36 +0800383 CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
384 CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
Tejun Heo02c402d2013-06-24 15:21:47 -0700385 CFTYPE_INSANE = (1 << 2), /* don't create if sane_behavior */
Tejun Heo9fa4db32013-08-26 18:40:56 -0400386 CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
Tejun Heo02c402d2013-06-24 15:21:47 -0700387};
Tejun Heo8e3f6542012-04-01 12:09:55 -0700388
389#define MAX_CFTYPE_NAME 64
390
Paul Menageddbcc7e2007-10-18 23:39:30 -0700391struct cftype {
Paul Menaged20a3902009-04-02 16:57:22 -0700392 /*
393 * By convention, the name should begin with the name of the
Tejun Heo8e3f6542012-04-01 12:09:55 -0700394 * subsystem, followed by a period. Zero length string indicates
395 * end of cftype array.
Paul Menaged20a3902009-04-02 16:57:22 -0700396 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700397 char name[MAX_CFTYPE_NAME];
398 int private;
Li Zefan099fca32009-04-02 16:57:29 -0700399 /*
400 * If not 0, file mode is set to this value, otherwise it will
401 * be figured out automatically
402 */
Al Viroa5e7ed32011-07-26 01:55:55 -0400403 umode_t mode;
Paul Menagedb3b1492008-07-25 01:46:58 -0700404
405 /*
Tejun Heo5f469902014-02-11 11:52:48 -0500406 * The maximum length of string, excluding trailing nul, that can
407 * be passed to write_string. If < PAGE_SIZE-1, PAGE_SIZE-1 is
408 * assumed.
Paul Menagedb3b1492008-07-25 01:46:58 -0700409 */
410 size_t max_write_len;
411
Tejun Heo8e3f6542012-04-01 12:09:55 -0700412 /* CFTYPE_* flags */
413 unsigned int flags;
414
Tejun Heo2bb566c2013-08-08 20:11:23 -0400415 /*
Tejun Heo0adb0702014-02-12 09:29:48 -0500416 * Fields used for internal bookkeeping. Initialized automatically
417 * during registration.
Tejun Heo2bb566c2013-08-08 20:11:23 -0400418 */
Tejun Heo0adb0702014-02-12 09:29:48 -0500419 struct cgroup_subsys *ss; /* NULL for cgroup core files */
420 struct list_head node; /* anchored at ss->cfts */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500421 struct kernfs_ops *kf_ops;
422
Paul Menageddbcc7e2007-10-18 23:39:30 -0700423 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700424 * read_u64() is a shortcut for the common case of returning a
Paul Menageddbcc7e2007-10-18 23:39:30 -0700425 * single integer. Use it in place of read()
426 */
Tejun Heo182446d2013-08-08 20:11:24 -0400427 u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
Paul Menage91796562008-04-29 01:00:01 -0700428 /*
Paul Menagee73d2c62008-04-29 01:00:06 -0700429 * read_s64() is a signed version of read_u64()
430 */
Tejun Heo182446d2013-08-08 20:11:24 -0400431 s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
Tejun Heo2da8ca82013-12-05 12:28:04 -0500432
433 /* generic seq_file read interface */
434 int (*seq_show)(struct seq_file *sf, void *v);
Paul Menage91796562008-04-29 01:00:01 -0700435
Tejun Heo6612f052013-12-05 12:28:04 -0500436 /* optional ops, implement all or none */
437 void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
438 void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
439 void (*seq_stop)(struct seq_file *sf, void *v);
440
Paul Menage355e0c42007-10-18 23:39:33 -0700441 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700442 * write_u64() is a shortcut for the common case of accepting
Paul Menage355e0c42007-10-18 23:39:33 -0700443 * a single integer (as parsed by simple_strtoull) from
444 * userspace. Use in place of write(); return 0 or error.
445 */
Tejun Heo182446d2013-08-08 20:11:24 -0400446 int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
447 u64 val);
Paul Menagee73d2c62008-04-29 01:00:06 -0700448 /*
449 * write_s64() is a signed version of write_u64()
450 */
Tejun Heo182446d2013-08-08 20:11:24 -0400451 int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
452 s64 val);
Paul Menage355e0c42007-10-18 23:39:33 -0700453
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700454 /*
Paul Menagedb3b1492008-07-25 01:46:58 -0700455 * write_string() is passed a nul-terminated kernelspace
456 * buffer of maximum length determined by max_write_len.
457 * Returns 0 or -ve error code.
458 */
Tejun Heo182446d2013-08-08 20:11:24 -0400459 int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
Tejun Heo4d3bb512014-03-19 10:23:54 -0400460 char *buffer);
Paul Menagedb3b1492008-07-25 01:46:58 -0700461 /*
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700462 * trigger() callback can be used to get some kick from the
463 * userspace, when the actual string written is not important
464 * at all. The private field can be used to determine the
465 * kick type for multiplexing.
466 */
Tejun Heo182446d2013-08-08 20:11:24 -0400467 int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
Tejun Heo2bd59d42014-02-11 11:52:49 -0500468
469#ifdef CONFIG_DEBUG_LOCK_ALLOC
470 struct lock_class_key lockdep_key;
471#endif
Paul Menageddbcc7e2007-10-18 23:39:30 -0700472};
473
Tejun Heoa2dd4242014-03-19 10:23:55 -0400474extern struct cgroup_root cgrp_dfl_root;
475
476static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
477{
478 return cgrp->root == &cgrp_dfl_root;
479}
480
Tejun Heo8e3f6542012-04-01 12:09:55 -0700481/*
Tejun Heo873fe092013-04-14 20:15:26 -0700482 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
483 * function can be called as long as @cgrp is accessible.
484 */
485static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
486{
487 return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
488}
489
Tejun Heo07bc3562014-02-13 06:58:39 -0500490/* no synchronization, the result can only be used as a hint */
491static inline bool cgroup_has_tasks(struct cgroup *cgrp)
492{
493 return !list_empty(&cgrp->cset_links);
494}
495
Tejun Heob1664922014-02-11 11:52:49 -0500496/* returns ino associated with a cgroup, 0 indicates unmounted root */
497static inline ino_t cgroup_ino(struct cgroup *cgrp)
498{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500499 if (cgrp->kn)
500 return cgrp->kn->ino;
Tejun Heob1664922014-02-11 11:52:49 -0500501 else
502 return 0;
503}
504
Tejun Heo7da11272013-12-05 12:28:04 -0500505static inline struct cftype *seq_cft(struct seq_file *seq)
506{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500507 struct kernfs_open_file *of = seq->private;
508
509 return of->kn->priv;
Tejun Heo7da11272013-12-05 12:28:04 -0500510}
511
Tejun Heo59f52962014-02-11 11:52:49 -0500512struct cgroup_subsys_state *seq_css(struct seq_file *seq);
513
Tejun Heoe61734c2014-02-12 09:29:50 -0500514/*
515 * Name / path handling functions. All are thin wrappers around the kernfs
516 * counterparts and can be called under any context.
517 */
518
519static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
520{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400521 return kernfs_name(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500522}
523
524static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
525 size_t buflen)
526{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400527 return kernfs_path(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500528}
529
530static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
531{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400532 pr_cont_kernfs_name(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500533}
534
535static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
536{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400537 pr_cont_kernfs_path(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500538}
539
540char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
541
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400542int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo2bb566c2013-08-08 20:11:23 -0400543int cgroup_rm_cftypes(struct cftype *cfts);
Tejun Heo8e3f6542012-04-01 12:09:55 -0700544
Li Zefan78574cf2013-04-08 19:00:38 -0700545bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700546
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100547/*
Tejun Heo2f7ee562011-12-12 18:12:21 -0800548 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
549 * methods.
550 */
551struct cgroup_taskset;
552struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
553struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
Tejun Heo2f7ee562011-12-12 18:12:21 -0800554
555/**
556 * cgroup_taskset_for_each - iterate cgroup_taskset
557 * @task: the loop cursor
Tejun Heo2f7ee562011-12-12 18:12:21 -0800558 * @tset: taskset to iterate
559 */
Tejun Heo924f0d92014-02-13 06:58:41 -0500560#define cgroup_taskset_for_each(task, tset) \
Tejun Heo2f7ee562011-12-12 18:12:21 -0800561 for ((task) = cgroup_taskset_first((tset)); (task); \
Tejun Heo924f0d92014-02-13 06:58:41 -0500562 (task) = cgroup_taskset_next((tset)))
Tejun Heo2f7ee562011-12-12 18:12:21 -0800563
564/*
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100565 * Control Group subsystem type.
566 * See Documentation/cgroups/cgroups.txt for details
567 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700568
569struct cgroup_subsys {
Tejun Heoeb954192013-08-08 20:11:23 -0400570 struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
571 int (*css_online)(struct cgroup_subsys_state *css);
572 void (*css_offline)(struct cgroup_subsys_state *css);
573 void (*css_free)(struct cgroup_subsys_state *css);
Tejun Heo92fb9742012-11-19 08:13:38 -0800574
Tejun Heoeb954192013-08-08 20:11:23 -0400575 int (*can_attach)(struct cgroup_subsys_state *css,
576 struct cgroup_taskset *tset);
577 void (*cancel_attach)(struct cgroup_subsys_state *css,
578 struct cgroup_taskset *tset);
579 void (*attach)(struct cgroup_subsys_state *css,
580 struct cgroup_taskset *tset);
Li Zefan761b3ef2012-01-31 13:47:36 +0800581 void (*fork)(struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400582 void (*exit)(struct cgroup_subsys_state *css,
583 struct cgroup_subsys_state *old_css,
Li Zefan761b3ef2012-01-31 13:47:36 +0800584 struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400585 void (*bind)(struct cgroup_subsys_state *root_css);
Hugh Dickinse5991372009-01-06 14:39:22 -0800586
Paul Menage8bab8dd2008-04-04 14:29:57 -0700587 int disabled;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700588 int early_init;
Tejun Heo48ddbe12012-04-01 12:09:56 -0700589
590 /*
Tejun Heo8c7f6ed2012-09-13 12:20:58 -0700591 * If %false, this subsystem is properly hierarchical -
592 * configuration, resource accounting and restriction on a parent
593 * cgroup cover those of its children. If %true, hierarchy support
594 * is broken in some ways - some subsystems ignore hierarchy
595 * completely while others are only implemented half-way.
596 *
597 * It's now disallowed to create nested cgroups if the subsystem is
598 * broken and cgroup core will emit a warning message on such
599 * cases. Eventually, all subsystems will be made properly
600 * hierarchical and this will go away.
601 */
602 bool broken_hierarchy;
603 bool warned_broken_hierarchy;
604
Tejun Heo073219e2014-02-08 10:36:58 -0500605 /* the following two fields are initialized automtically during boot */
Tejun Heoaec25022014-02-08 10:36:58 -0500606 int id;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700607#define MAX_CGROUP_TYPE_NAMELEN 32
608 const char *name;
609
Tejun Heob85d2042013-12-06 15:11:57 -0500610 /* link to parent, protected by cgroup_lock() */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400611 struct cgroup_root *root;
Ben Blume6a11052010-03-10 15:22:09 -0800612
Tejun Heo0adb0702014-02-12 09:29:48 -0500613 /*
614 * List of cftypes. Each entry is the first entry of an array
615 * terminated by zero length name.
616 */
617 struct list_head cfts;
Tejun Heo8e3f6542012-04-01 12:09:55 -0700618
Tejun Heode00ffa2014-02-11 11:52:48 -0500619 /* base cftypes, automatically registered with subsys itself */
Tejun Heo8e3f6542012-04-01 12:09:55 -0700620 struct cftype *base_cftypes;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700621};
622
Tejun Heo073219e2014-02-08 10:36:58 -0500623#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700624#include <linux/cgroup_subsys.h>
625#undef SUBSYS
626
Tejun Heo8af01f52013-08-08 20:11:22 -0400627/**
Tejun Heo63876982013-08-08 20:11:23 -0400628 * css_parent - find the parent css
629 * @css: the target cgroup_subsys_state
630 *
631 * Return the parent css of @css. This function is guaranteed to return
632 * non-NULL parent as long as @css isn't the root.
633 */
634static inline
635struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
636{
Tejun Heo0ae78e02013-08-13 11:01:54 -0400637 return css->parent;
Tejun Heo63876982013-08-08 20:11:23 -0400638}
639
640/**
Tejun Heo14611e52013-06-25 11:48:32 -0700641 * task_css_set_check - obtain a task's css_set with extra access conditions
642 * @task: the task to obtain css_set for
643 * @__c: extra condition expression to be passed to rcu_dereference_check()
644 *
645 * A task's css_set is RCU protected, initialized and exited while holding
646 * task_lock(), and can only be modified while holding both cgroup_mutex
647 * and task_lock() while the task is alive. This macro verifies that the
648 * caller is inside proper critical section and returns @task's css_set.
649 *
650 * The caller can also specify additional allowed conditions via @__c, such
651 * as locks used during the cgroup_subsys::attach() methods.
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200652 */
Tejun Heo22194492013-04-07 09:29:51 -0700653#ifdef CONFIG_PROVE_RCU
654extern struct mutex cgroup_mutex;
Tejun Heo0e1d7682014-02-25 10:04:03 -0500655extern struct rw_semaphore css_set_rwsem;
Tejun Heo14611e52013-06-25 11:48:32 -0700656#define task_css_set_check(task, __c) \
657 rcu_dereference_check((task)->cgroups, \
Tejun Heo0e1d7682014-02-25 10:04:03 -0500658 lockdep_is_held(&cgroup_mutex) || \
659 lockdep_is_held(&css_set_rwsem) || \
660 ((task)->flags & PF_EXITING) || (__c))
Tejun Heo22194492013-04-07 09:29:51 -0700661#else
Tejun Heo14611e52013-06-25 11:48:32 -0700662#define task_css_set_check(task, __c) \
663 rcu_dereference((task)->cgroups)
Tejun Heo22194492013-04-07 09:29:51 -0700664#endif
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200665
Tejun Heo14611e52013-06-25 11:48:32 -0700666/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400667 * task_css_check - obtain css for (task, subsys) w/ extra access conds
Tejun Heo14611e52013-06-25 11:48:32 -0700668 * @task: the target task
669 * @subsys_id: the target subsystem ID
670 * @__c: extra condition expression to be passed to rcu_dereference_check()
671 *
672 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
673 * synchronization rules are the same as task_css_set_check().
674 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400675#define task_css_check(task, subsys_id, __c) \
Tejun Heo14611e52013-06-25 11:48:32 -0700676 task_css_set_check((task), (__c))->subsys[(subsys_id)]
677
678/**
679 * task_css_set - obtain a task's css_set
680 * @task: the task to obtain css_set for
681 *
682 * See task_css_set_check().
683 */
684static inline struct css_set *task_css_set(struct task_struct *task)
685{
686 return task_css_set_check(task, false);
687}
688
689/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400690 * task_css - obtain css for (task, subsys)
Tejun Heo14611e52013-06-25 11:48:32 -0700691 * @task: the target task
692 * @subsys_id: the target subsystem ID
693 *
Tejun Heo8af01f52013-08-08 20:11:22 -0400694 * See task_css_check().
Tejun Heo14611e52013-06-25 11:48:32 -0700695 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400696static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
697 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700698{
Tejun Heo8af01f52013-08-08 20:11:22 -0400699 return task_css_check(task, subsys_id, false);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700700}
701
Tejun Heo8af01f52013-08-08 20:11:22 -0400702static inline struct cgroup *task_cgroup(struct task_struct *task,
703 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700704{
Tejun Heo8af01f52013-08-08 20:11:22 -0400705 return task_css(task, subsys_id)->cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700706}
707
Tejun Heo492eb212013-08-08 20:11:25 -0400708struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
709 struct cgroup_subsys_state *parent);
Tejun Heo53fa5262013-05-24 10:55:38 +0900710
Li Zefan1cb650b2013-08-19 10:05:24 +0800711struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
712
Tejun Heo574bd9f2012-11-09 09:12:29 -0800713/**
Tejun Heo492eb212013-08-08 20:11:25 -0400714 * css_for_each_child - iterate through children of a css
715 * @pos: the css * to use as the loop cursor
716 * @parent: css whose children to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800717 *
Tejun Heo492eb212013-08-08 20:11:25 -0400718 * Walk @parent's children. Must be called under rcu_read_lock(). A child
719 * css which hasn't finished ->css_online() or already has finished
Tejun Heo92fb9742012-11-19 08:13:38 -0800720 * ->css_offline() may show up during traversal and it's each subsystem's
Tejun Heo574bd9f2012-11-09 09:12:29 -0800721 * responsibility to verify that each @pos is alive.
722 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800723 * If a subsystem synchronizes against the parent in its ->css_online() and
Tejun Heo492eb212013-08-08 20:11:25 -0400724 * before starting iterating, a css which finished ->css_online() is
Tejun Heo92fb9742012-11-19 08:13:38 -0800725 * guaranteed to be visible in the future iterations.
Tejun Heo75501a62013-05-24 10:55:38 +0900726 *
727 * It is allowed to temporarily drop RCU read lock during iteration. The
728 * caller is responsible for ensuring that @pos remains accessible until
729 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800730 */
Tejun Heo492eb212013-08-08 20:11:25 -0400731#define css_for_each_child(pos, parent) \
732 for ((pos) = css_next_child(NULL, (parent)); (pos); \
733 (pos) = css_next_child((pos), (parent)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800734
Tejun Heo492eb212013-08-08 20:11:25 -0400735struct cgroup_subsys_state *
736css_next_descendant_pre(struct cgroup_subsys_state *pos,
737 struct cgroup_subsys_state *css);
738
739struct cgroup_subsys_state *
740css_rightmost_descendant(struct cgroup_subsys_state *pos);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800741
742/**
Tejun Heo492eb212013-08-08 20:11:25 -0400743 * css_for_each_descendant_pre - pre-order walk of a css's descendants
744 * @pos: the css * to use as the loop cursor
745 * @root: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800746 *
Tejun Heobd8815a2013-08-08 20:11:27 -0400747 * Walk @root's descendants. @root is included in the iteration and the
748 * first node to be visited. Must be called under rcu_read_lock(). A
Tejun Heo492eb212013-08-08 20:11:25 -0400749 * descendant css which hasn't finished ->css_online() or already has
Tejun Heo92fb9742012-11-19 08:13:38 -0800750 * finished ->css_offline() may show up during traversal and it's each
Tejun Heo574bd9f2012-11-09 09:12:29 -0800751 * subsystem's responsibility to verify that each @pos is alive.
752 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800753 * If a subsystem synchronizes against the parent in its ->css_online() and
754 * before starting iterating, and synchronizes against @pos on each
Tejun Heo492eb212013-08-08 20:11:25 -0400755 * iteration, any descendant css which finished ->css_online() is
Tejun Heo574bd9f2012-11-09 09:12:29 -0800756 * guaranteed to be visible in the future iterations.
757 *
758 * In other words, the following guarantees that a descendant can't escape
759 * state updates of its ancestors.
760 *
Tejun Heo492eb212013-08-08 20:11:25 -0400761 * my_online(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800762 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400763 * Lock @css's parent and @css;
764 * Inherit state from the parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800765 * Unlock both.
766 * }
767 *
Tejun Heo492eb212013-08-08 20:11:25 -0400768 * my_update_state(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800769 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400770 * css_for_each_descendant_pre(@pos, @css) {
Tejun Heo574bd9f2012-11-09 09:12:29 -0800771 * Lock @pos;
Tejun Heobd8815a2013-08-08 20:11:27 -0400772 * if (@pos == @css)
773 * Update @css's state;
774 * else
775 * Verify @pos is alive and inherit state from its parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800776 * Unlock @pos;
777 * }
778 * }
779 *
780 * As long as the inheriting step, including checking the parent state, is
781 * enclosed inside @pos locking, double-locking the parent isn't necessary
782 * while inheriting. The state update to the parent is guaranteed to be
783 * visible by walking order and, as long as inheriting operations to the
784 * same @pos are atomic to each other, multiple updates racing each other
785 * still result in the correct state. It's guaranateed that at least one
Tejun Heo492eb212013-08-08 20:11:25 -0400786 * inheritance happens for any css after the latest update to its parent.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800787 *
788 * If checking parent's state requires locking the parent, each inheriting
789 * iteration should lock and unlock both @pos->parent and @pos.
790 *
791 * Alternatively, a subsystem may choose to use a single global lock to
Tejun Heo92fb9742012-11-19 08:13:38 -0800792 * synchronize ->css_online() and ->css_offline() against tree-walking
Tejun Heo574bd9f2012-11-09 09:12:29 -0800793 * operations.
Tejun Heo75501a62013-05-24 10:55:38 +0900794 *
795 * It is allowed to temporarily drop RCU read lock during iteration. The
796 * caller is responsible for ensuring that @pos remains accessible until
797 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800798 */
Tejun Heo492eb212013-08-08 20:11:25 -0400799#define css_for_each_descendant_pre(pos, css) \
800 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
801 (pos) = css_next_descendant_pre((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800802
Tejun Heo492eb212013-08-08 20:11:25 -0400803struct cgroup_subsys_state *
804css_next_descendant_post(struct cgroup_subsys_state *pos,
805 struct cgroup_subsys_state *css);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800806
807/**
Tejun Heo492eb212013-08-08 20:11:25 -0400808 * css_for_each_descendant_post - post-order walk of a css's descendants
809 * @pos: the css * to use as the loop cursor
810 * @css: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800811 *
Tejun Heo492eb212013-08-08 20:11:25 -0400812 * Similar to css_for_each_descendant_pre() but performs post-order
Tejun Heobd8815a2013-08-08 20:11:27 -0400813 * traversal instead. @root is included in the iteration and the last
814 * node to be visited. Note that the walk visibility guarantee described
815 * in pre-order walk doesn't apply the same to post-order walks.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800816 */
Tejun Heo492eb212013-08-08 20:11:25 -0400817#define css_for_each_descendant_post(pos, css) \
818 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
819 (pos) = css_next_descendant_post((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800820
Tejun Heo72ec7022013-08-08 20:11:26 -0400821/* A css_task_iter should be treated as an opaque object */
822struct css_task_iter {
823 struct cgroup_subsys_state *origin_css;
Tejun Heo0942eee2013-08-08 20:11:26 -0400824 struct list_head *cset_link;
825 struct list_head *task;
Paul Menage817929e2007-10-18 23:39:36 -0700826};
827
Tejun Heo72ec7022013-08-08 20:11:26 -0400828void css_task_iter_start(struct cgroup_subsys_state *css,
829 struct css_task_iter *it);
830struct task_struct *css_task_iter_next(struct css_task_iter *it);
831void css_task_iter_end(struct css_task_iter *it);
Tejun Heoe5358372013-08-08 20:11:26 -0400832
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700833int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
Tejun Heo8cc99342013-04-07 09:29:50 -0700834int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700835
Tejun Heo5a17f542014-02-11 11:52:47 -0500836struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
837 struct cgroup_subsys *ss);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700838
Paul Menageddbcc7e2007-10-18 23:39:30 -0700839#else /* !CONFIG_CGROUPS */
840
841static inline int cgroup_init_early(void) { return 0; }
842static inline int cgroup_init(void) { return 0; }
Paul Menageb4f48b62007-10-18 23:39:33 -0700843static inline void cgroup_fork(struct task_struct *p) {}
Paul Menage817929e2007-10-18 23:39:36 -0700844static inline void cgroup_post_fork(struct task_struct *p) {}
Paul Menageb4f48b62007-10-18 23:39:33 -0700845static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700846
Balbir Singh846c7bb2007-10-18 23:39:44 -0700847static inline int cgroupstats_build(struct cgroupstats *stats,
848 struct dentry *dentry)
849{
850 return -EINVAL;
851}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700852
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200853/* No cgroups - nothing to do */
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700854static inline int cgroup_attach_task_all(struct task_struct *from,
855 struct task_struct *t)
856{
857 return 0;
858}
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200859
Paul Menageddbcc7e2007-10-18 23:39:30 -0700860#endif /* !CONFIG_CGROUPS */
861
Paul Menageddbcc7e2007-10-18 23:39:30 -0700862#endif /* _LINUX_CGROUP_H */