cgroup: remove css_parent()
[linux-2.6-block.git] / include / linux / cgroup.h
CommitLineData
ddbcc7e8
PM
1#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>
ddbcc7e8
PM
12#include <linux/cpumask.h>
13#include <linux/nodemask.h>
14#include <linux/rcupdate.h>
eb6fd504 15#include <linux/rculist.h>
846c7bb0 16#include <linux/cgroupstats.h>
cc31edce 17#include <linux/rwsem.h>
38460b48 18#include <linux/idr.h>
48ddbe19 19#include <linux/workqueue.h>
25a7e684 20#include <linux/fs.h>
d3daf28d 21#include <linux/percpu-refcount.h>
7da11279 22#include <linux/seq_file.h>
2bd59d48 23#include <linux/kernfs.h>
f8f22e53 24#include <linux/wait.h>
ddbcc7e8
PM
25
26#ifdef CONFIG_CGROUPS
27
3dd06ffa 28struct cgroup_root;
ddbcc7e8
PM
29struct cgroup_subsys;
30struct inode;
84eea842 31struct cgroup;
ddbcc7e8
PM
32
33extern int cgroup_init_early(void);
34extern int cgroup_init(void);
b4f48b63 35extern void cgroup_fork(struct task_struct *p);
817929ec 36extern void cgroup_post_fork(struct task_struct *p);
1ec41830 37extern void cgroup_exit(struct task_struct *p);
846c7bb0
BS
38extern int cgroupstats_build(struct cgroupstats *stats,
39 struct dentry *dentry);
ddbcc7e8 40
8d8b97ba 41extern int proc_cgroup_show(struct seq_file *, void *);
a424316c 42
3ed80a62 43/* define the enumeration of all cgroup subsystems */
073219e9 44#define SUBSYS(_x) _x ## _cgrp_id,
817929ec
PM
45enum cgroup_subsys_id {
46#include <linux/cgroup_subsys.h>
a6f00298 47 CGROUP_SUBSYS_COUNT,
817929ec
PM
48};
49#undef SUBSYS
50
5c9d535b
TH
51/*
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 */
ddbcc7e8 58struct cgroup_subsys_state {
5c9d535b 59 /* PI: the cgroup that this css is attached to */
ddbcc7e8
PM
60 struct cgroup *cgroup;
61
5c9d535b 62 /* PI: the cgroup subsystem that this css is attached to */
72c97e54
TH
63 struct cgroup_subsys *ss;
64
d3daf28d
TH
65 /* reference count - access via css_[try]get() and css_put() */
66 struct percpu_ref refcnt;
ddbcc7e8 67
5c9d535b 68 /* PI: the parent css */
0ae78e0b
TH
69 struct cgroup_subsys_state *parent;
70
15a4c835 71 /*
5c9d535b 72 * PI: Subsys-unique ID. 0 is unused and root is always 1. The
15a4c835
TH
73 * matching css can be looked up using css_from_id().
74 */
75 int id;
76
69dfa00c 77 unsigned int flags;
48ddbe19 78
0c21ead1
TH
79 /* percpu_ref killing and RCU release */
80 struct rcu_head rcu_head;
35ef10da 81 struct work_struct destroy_work;
ddbcc7e8
PM
82};
83
84/* bits in struct cgroup_subsys_state flags field */
85enum {
3b514d24 86 CSS_NO_REF = (1 << 0), /* no reference counting for this css */
92fb9748 87 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
ddbcc7e8
PM
88};
89
5de0107e
TH
90/**
91 * css_get - obtain a reference on the specified css
92 * @css: target css
93 *
94 * The caller must already have a reference.
ddbcc7e8 95 */
ddbcc7e8
PM
96static inline void css_get(struct cgroup_subsys_state *css)
97{
3b514d24
TH
98 if (!(css->flags & CSS_NO_REF))
99 percpu_ref_get(&css->refcnt);
ddbcc7e8 100}
e7c5ec91 101
5de0107e 102/**
ec903c0c 103 * css_tryget_online - try to obtain a reference on the specified css if online
5de0107e
TH
104 * @css: target css
105 *
ec903c0c
TH
106 * Obtain a reference on @css if it's online. The caller naturally needs
107 * to ensure that @css is accessible but doesn't have to be holding a
5de0107e
TH
108 * reference on it - IOW, RCU protected access is good enough for this
109 * function. Returns %true if a reference count was successfully obtained;
110 * %false otherwise.
111 */
ec903c0c 112static inline bool css_tryget_online(struct cgroup_subsys_state *css)
e7c5ec91 113{
3b514d24
TH
114 if (!(css->flags & CSS_NO_REF))
115 return percpu_ref_tryget_live(&css->refcnt);
116 return true;
e7c5ec91
PM
117}
118
5de0107e
TH
119/**
120 * css_put - put a css reference
121 * @css: target css
122 *
ec903c0c 123 * Put a reference obtained via css_get() and css_tryget_online().
5de0107e 124 */
ddbcc7e8
PM
125static inline void css_put(struct cgroup_subsys_state *css)
126{
3b514d24
TH
127 if (!(css->flags & CSS_NO_REF))
128 percpu_ref_put(&css->refcnt);
ddbcc7e8
PM
129}
130
3116f0e3
PM
131/* bits in struct cgroup flags field */
132enum {
133 /* Control Group is dead */
54766d4a 134 CGRP_DEAD,
d20a390a
PM
135 /*
136 * Control Group has previously had a child cgroup or a task,
137 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
138 */
3116f0e3
PM
139 CGRP_RELEASABLE,
140 /* Control Group requires release notifications to userspace */
141 CGRP_NOTIFY_ON_RELEASE,
97978e6d 142 /*
2260e7fc
TH
143 * Clone the parent's configuration when creating a new child
144 * cpuset cgroup. For historical reasons, this option can be
145 * specified at mount time and thus is implemented here.
97978e6d 146 */
2260e7fc 147 CGRP_CPUSET_CLONE_CHILDREN,
3116f0e3
PM
148};
149
ddbcc7e8 150struct cgroup {
9d800df1
TH
151 /* self css with NULL ->ss, points back to this cgroup */
152 struct cgroup_subsys_state self;
153
ddbcc7e8
PM
154 unsigned long flags; /* "unsigned long" so bitops work */
155
b414dc09
LZ
156 /*
157 * idr allocated in-hierarchy ID.
158 *
7d699ddb
TH
159 * ID 0 is not used, the ID of the root cgroup is always 1, and a
160 * new cgroup will be assigned with a smallest available ID.
0ab02ca8
LZ
161 *
162 * Allocating/Removing ID must be protected by cgroup_mutex.
b414dc09
LZ
163 */
164 int id;
0a950f65 165
842b597e
TH
166 /*
167 * If this cgroup contains any tasks, it contributes one to
168 * populated_cnt. All children with non-zero popuplated_cnt of
169 * their own contribute one. The count is zero iff there's no task
170 * in this cgroup or its subtree.
171 */
172 int populated_cnt;
173
ddbcc7e8
PM
174 /*
175 * We link our 'sibling' struct into our parent's 'children'.
176 * Our children link their 'sibling' into our 'children'.
177 */
178 struct list_head sibling; /* my parent's children */
179 struct list_head children; /* my children */
180
d20a390a 181 struct cgroup *parent; /* my parent */
2bd59d48 182 struct kernfs_node *kn; /* cgroup kernfs entry */
842b597e 183 struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
ddbcc7e8 184
53fa5261
TH
185 /*
186 * Monotonically increasing unique serial number which defines a
187 * uniform order among all cgroups. It's guaranteed that all
188 * ->children lists are in the ascending order of ->serial_nr.
189 * It's used to allow interrupting and resuming iterations.
190 */
191 u64 serial_nr;
192
f392e51c 193 /* the bitmask of subsystems enabled on the child cgroups */
69dfa00c 194 unsigned int child_subsys_mask;
94419627 195
ddbcc7e8 196 /* Private pointers for each registered subsystem */
73e80ed8 197 struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
ddbcc7e8 198
3dd06ffa 199 struct cgroup_root *root;
817929ec
PM
200
201 /*
69d0206c
TH
202 * List of cgrp_cset_links pointing at css_sets with tasks in this
203 * cgroup. Protected by css_set_lock.
817929ec 204 */
69d0206c 205 struct list_head cset_links;
81a6a5cd 206
2d8f243a
TH
207 /*
208 * On the default hierarchy, a css_set for a cgroup with some
209 * susbsys disabled will point to css's which are associated with
210 * the closest ancestor which has the subsys enabled. The
211 * following lists all css_sets which point to this cgroup's css
212 * for the given subsystem.
213 */
214 struct list_head e_csets[CGROUP_SUBSYS_COUNT];
215
81a6a5cd
PM
216 /*
217 * Linked list running through all cgroups that can
218 * potentially be reaped by the release agent. Protected by
219 * release_list_lock
220 */
221 struct list_head release_list;
cc31edce 222
72a8cb30
BB
223 /*
224 * list of pidlists, up to two for each namespace (one for procs, one
225 * for tasks); created on demand.
226 */
227 struct list_head pidlists;
228 struct mutex pidlist_mutex;
a47295e6 229
f8f22e53
TH
230 /* used to wait for offlining of csses */
231 wait_queue_head_t offline_waitq;
817929ec
PM
232};
233
25a7e684
TH
234#define MAX_CGROUP_ROOT_NAMELEN 64
235
3dd06ffa 236/* cgroup_root->flags */
25a7e684 237enum {
873fe09e
TH
238 /*
239 * Unfortunately, cgroup core and various controllers are riddled
240 * with idiosyncrasies and pointless options. The following flag,
241 * when set, will force sane behavior - some options are forced on,
242 * others are disallowed, and some controllers will change their
243 * hierarchical or other behaviors.
244 *
245 * The set of behaviors affected by this flag are still being
246 * determined and developed and the mount option for this flag is
247 * prefixed with __DEVEL__. The prefix will be dropped once we
248 * reach the point where all behaviors are compatible with the
249 * planned unified hierarchy, which will automatically turn on this
250 * flag.
251 *
252 * The followings are the behaviors currently affected this flag.
253 *
d3ba07c3
TH
254 * - Mount options "noprefix", "xattr", "clone_children",
255 * "release_agent" and "name" are disallowed.
873fe09e
TH
256 *
257 * - When mounting an existing superblock, mount options should
258 * match.
259 *
260 * - Remount is disallowed.
261 *
0b0585c3
LT
262 * - rename(2) is disallowed.
263 *
f63674fd
TH
264 * - "tasks" is removed. Everything should be at process
265 * granularity. Use "cgroup.procs" instead.
f00baae7 266 *
afb2bc14
TH
267 * - "cgroup.procs" is not sorted. pids will be unique unless they
268 * got recycled inbetween reads.
269 *
f63674fd
TH
270 * - "release_agent" and "notify_on_release" are removed.
271 * Replacement notification mechanism will be implemented.
873fe09e 272 *
d3ba07c3 273 * - "cgroup.clone_children" is removed.
86bf4b68 274 *
842b597e
TH
275 * - "cgroup.subtree_populated" is available. Its value is 0 if
276 * the cgroup and its descendants contain no task; otherwise, 1.
277 * The file also generates kernfs notification which can be
278 * monitored through poll and [di]notify when the value of the
279 * file changes.
280 *
a2dd4247
TH
281 * - If mount is requested with sane_behavior but without any
282 * subsystem, the default unified hierarchy is mounted.
283 *
5c5cc623
LZ
284 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
285 * and take masks of ancestors with non-empty cpus/mems, instead of
286 * being moved to an ancestor.
287 *
88fa523b
LZ
288 * - cpuset: a task can be moved into an empty cpuset, and again it
289 * takes masks of ancestors.
6db8e85c 290 *
f63674fd
TH
291 * - memcg: use_hierarchy is on by default and the cgroup file for
292 * the flag is not created.
f00baae7 293 *
9138125b 294 * - blkcg: blk-throttle becomes properly hierarchical.
873fe09e
TH
295 */
296 CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
297
25a7e684
TH
298 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
299 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
0ce6cba3
TH
300
301 /* mount options live below bit 16 */
302 CGRP_ROOT_OPTION_MASK = (1 << 16) - 1,
25a7e684
TH
303};
304
305/*
3dd06ffa 306 * A cgroup_root represents the root of a cgroup hierarchy, and may be
2bd59d48 307 * associated with a kernfs_root to form an active hierarchy. This is
25a7e684
TH
308 * internal to cgroup core. Don't access directly from controllers.
309 */
3dd06ffa 310struct cgroup_root {
2bd59d48 311 struct kernfs_root *kf_root;
25a7e684 312
f392e51c 313 /* The bitmask of subsystems attached to this hierarchy */
69dfa00c 314 unsigned int subsys_mask;
f392e51c 315
25a7e684
TH
316 /* Unique id for this hierarchy. */
317 int hierarchy_id;
318
776f02fa 319 /* The root cgroup. Root is destroyed on its release. */
3dd06ffa 320 struct cgroup cgrp;
25a7e684 321
3c9c825b
TH
322 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
323 atomic_t nr_cgrps;
25a7e684
TH
324
325 /* A list running through the active hierarchies */
326 struct list_head root_list;
327
25a7e684 328 /* Hierarchy-specific flags */
69dfa00c 329 unsigned int flags;
25a7e684
TH
330
331 /* IDs for cgroups in this hierarchy */
4e96ee8e 332 struct idr cgroup_idr;
25a7e684
TH
333
334 /* The path to use for release notifications. */
335 char release_agent_path[PATH_MAX];
336
337 /* The name for this hierarchy - may be empty */
338 char name[MAX_CGROUP_ROOT_NAMELEN];
339};
340
d20a390a
PM
341/*
342 * A css_set is a structure holding pointers to a set of
817929ec
PM
343 * cgroup_subsys_state objects. This saves space in the task struct
344 * object and speeds up fork()/exit(), since a single inc/dec and a
d20a390a
PM
345 * list_add()/del() can bump the reference count on the entire cgroup
346 * set for a task.
817929ec
PM
347 */
348
349struct css_set {
350
351 /* Reference count */
146aa1bd 352 atomic_t refcount;
817929ec 353
472b1053
LZ
354 /*
355 * List running through all cgroup groups in the same hash
356 * slot. Protected by css_set_lock
357 */
358 struct hlist_node hlist;
359
817929ec 360 /*
c7561128
TH
361 * Lists running through all tasks using this cgroup group.
362 * mg_tasks lists tasks which belong to this cset but are in the
363 * process of being migrated out or in. Protected by
364 * css_set_rwsem, but, during migration, once tasks are moved to
365 * mg_tasks, it can be read safely while holding cgroup_mutex.
817929ec
PM
366 */
367 struct list_head tasks;
c7561128 368 struct list_head mg_tasks;
817929ec
PM
369
370 /*
69d0206c
TH
371 * List of cgrp_cset_links pointing at cgroups referenced from this
372 * css_set. Protected by css_set_lock.
817929ec 373 */
69d0206c 374 struct list_head cgrp_links;
817929ec 375
6803c006
TH
376 /* the default cgroup associated with this css_set */
377 struct cgroup *dfl_cgrp;
378
817929ec 379 /*
3ed80a62
TH
380 * Set of subsystem states, one for each subsystem. This array is
381 * immutable after creation apart from the init_css_set during
382 * subsystem registration (at boot time).
817929ec
PM
383 */
384 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
c378369d 385
b3dc094e
TH
386 /*
387 * List of csets participating in the on-going migration either as
388 * source or destination. Protected by cgroup_mutex.
389 */
1958d2d5 390 struct list_head mg_preload_node;
b3dc094e
TH
391 struct list_head mg_node;
392
393 /*
394 * If this cset is acting as the source of migration the following
395 * two fields are set. mg_src_cgrp is the source cgroup of the
396 * on-going migration and mg_dst_cset is the destination cset the
397 * target tasks on this cset should be migrated to. Protected by
398 * cgroup_mutex.
399 */
400 struct cgroup *mg_src_cgrp;
401 struct css_set *mg_dst_cset;
402
2d8f243a
TH
403 /*
404 * On the default hierarhcy, ->subsys[ssid] may point to a css
405 * attached to an ancestor instead of the cgroup this css_set is
406 * associated with. The following node is anchored at
407 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
408 * iterate through all css's attached to a given cgroup.
409 */
410 struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
411
c378369d
BB
412 /* For RCU-protected deletion */
413 struct rcu_head rcu_head;
ddbcc7e8
PM
414};
415
d20a390a
PM
416/*
417 * struct cftype: handler definitions for cgroup control files
ddbcc7e8
PM
418 *
419 * When reading/writing to a file:
a043e3b2 420 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
ddbcc7e8
PM
421 * - the 'cftype' of the file is file->f_dentry->d_fsdata
422 */
423
8e3f6541 424/* cftype->flags */
02c402d9 425enum {
6f4b7e63
LZ
426 CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
427 CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
02c402d9 428 CFTYPE_INSANE = (1 << 2), /* don't create if sane_behavior */
9fa4db33 429 CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
8cbbf2c9 430 CFTYPE_ONLY_ON_DFL = (1 << 4), /* only on default hierarchy */
02c402d9 431};
8e3f6541
TH
432
433#define MAX_CFTYPE_NAME 64
434
ddbcc7e8 435struct cftype {
d20a390a
PM
436 /*
437 * By convention, the name should begin with the name of the
8e3f6541
TH
438 * subsystem, followed by a period. Zero length string indicates
439 * end of cftype array.
d20a390a 440 */
ddbcc7e8
PM
441 char name[MAX_CFTYPE_NAME];
442 int private;
099fca32
LZ
443 /*
444 * If not 0, file mode is set to this value, otherwise it will
445 * be figured out automatically
446 */
a5e7ed32 447 umode_t mode;
db3b1497
PM
448
449 /*
5f469907 450 * The maximum length of string, excluding trailing nul, that can
451af504 451 * be passed to write. If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
db3b1497
PM
452 */
453 size_t max_write_len;
454
8e3f6541
TH
455 /* CFTYPE_* flags */
456 unsigned int flags;
457
2bb566cb 458 /*
0adb0704
TH
459 * Fields used for internal bookkeeping. Initialized automatically
460 * during registration.
2bb566cb 461 */
0adb0704
TH
462 struct cgroup_subsys *ss; /* NULL for cgroup core files */
463 struct list_head node; /* anchored at ss->cfts */
2bd59d48
TH
464 struct kernfs_ops *kf_ops;
465
ddbcc7e8 466 /*
f4c753b7 467 * read_u64() is a shortcut for the common case of returning a
ddbcc7e8
PM
468 * single integer. Use it in place of read()
469 */
182446d0 470 u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
e73d2c61
PM
471 /*
472 * read_s64() is a signed version of read_u64()
473 */
182446d0 474 s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
2da8ca82
TH
475
476 /* generic seq_file read interface */
477 int (*seq_show)(struct seq_file *sf, void *v);
91796569 478
6612f05b
TH
479 /* optional ops, implement all or none */
480 void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
481 void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
482 void (*seq_stop)(struct seq_file *sf, void *v);
483
355e0c48 484 /*
f4c753b7 485 * write_u64() is a shortcut for the common case of accepting
355e0c48
PM
486 * a single integer (as parsed by simple_strtoull) from
487 * userspace. Use in place of write(); return 0 or error.
488 */
182446d0
TH
489 int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
490 u64 val);
e73d2c61
PM
491 /*
492 * write_s64() is a signed version of write_u64()
493 */
182446d0
TH
494 int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
495 s64 val);
355e0c48 496
b4168640
TH
497 /*
498 * write() is the generic write callback which maps directly to
499 * kernfs write operation and overrides all other operations.
500 * Maximum write size is determined by ->max_write_len. Use
501 * of_css/cft() to access the associated css and cft.
502 */
503 ssize_t (*write)(struct kernfs_open_file *of,
504 char *buf, size_t nbytes, loff_t off);
505
2bd59d48
TH
506#ifdef CONFIG_DEBUG_LOCK_ALLOC
507 struct lock_class_key lockdep_key;
508#endif
ddbcc7e8
PM
509};
510
a2dd4247 511extern struct cgroup_root cgrp_dfl_root;
5024ae29 512extern struct css_set init_css_set;
a2dd4247
TH
513
514static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
515{
516 return cgrp->root == &cgrp_dfl_root;
517}
518
873fe09e
TH
519/*
520 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
521 * function can be called as long as @cgrp is accessible.
522 */
523static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
524{
525 return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
526}
527
07bc356e
TH
528/* no synchronization, the result can only be used as a hint */
529static inline bool cgroup_has_tasks(struct cgroup *cgrp)
530{
531 return !list_empty(&cgrp->cset_links);
532}
533
b1664924
TH
534/* returns ino associated with a cgroup, 0 indicates unmounted root */
535static inline ino_t cgroup_ino(struct cgroup *cgrp)
536{
2bd59d48
TH
537 if (cgrp->kn)
538 return cgrp->kn->ino;
b1664924
TH
539 else
540 return 0;
541}
542
b4168640
TH
543/* cft/css accessors for cftype->write() operation */
544static inline struct cftype *of_cft(struct kernfs_open_file *of)
7da11279 545{
2bd59d48 546 return of->kn->priv;
7da11279
TH
547}
548
b4168640
TH
549struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
550
551/* cft/css accessors for cftype->seq_*() operations */
552static inline struct cftype *seq_cft(struct seq_file *seq)
553{
554 return of_cft(seq->private);
555}
556
557static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
558{
559 return of_css(seq->private);
560}
59f5296b 561
e61734c5
TH
562/*
563 * Name / path handling functions. All are thin wrappers around the kernfs
564 * counterparts and can be called under any context.
565 */
566
567static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
568{
fdce6bf8 569 return kernfs_name(cgrp->kn, buf, buflen);
e61734c5
TH
570}
571
572static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
573 size_t buflen)
574{
fdce6bf8 575 return kernfs_path(cgrp->kn, buf, buflen);
e61734c5
TH
576}
577
578static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
579{
fdce6bf8 580 pr_cont_kernfs_name(cgrp->kn);
e61734c5
TH
581}
582
583static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
584{
fdce6bf8 585 pr_cont_kernfs_path(cgrp->kn);
e61734c5
TH
586}
587
588char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
589
03b1cde6 590int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
2bb566cb 591int cgroup_rm_cftypes(struct cftype *cfts);
8e3f6541 592
78574cf9 593bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
ddbcc7e8 594
2f7ee569
TH
595/*
596 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
597 * methods.
598 */
599struct cgroup_taskset;
600struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
601struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
2f7ee569
TH
602
603/**
604 * cgroup_taskset_for_each - iterate cgroup_taskset
605 * @task: the loop cursor
2f7ee569
TH
606 * @tset: taskset to iterate
607 */
924f0d9a 608#define cgroup_taskset_for_each(task, tset) \
2f7ee569 609 for ((task) = cgroup_taskset_first((tset)); (task); \
924f0d9a 610 (task) = cgroup_taskset_next((tset)))
2f7ee569 611
21acb9ca
TLSC
612/*
613 * Control Group subsystem type.
614 * See Documentation/cgroups/cgroups.txt for details
615 */
ddbcc7e8
PM
616
617struct cgroup_subsys {
eb95419b
TH
618 struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
619 int (*css_online)(struct cgroup_subsys_state *css);
620 void (*css_offline)(struct cgroup_subsys_state *css);
621 void (*css_free)(struct cgroup_subsys_state *css);
622
623 int (*can_attach)(struct cgroup_subsys_state *css,
624 struct cgroup_taskset *tset);
625 void (*cancel_attach)(struct cgroup_subsys_state *css,
626 struct cgroup_taskset *tset);
627 void (*attach)(struct cgroup_subsys_state *css,
628 struct cgroup_taskset *tset);
761b3ef5 629 void (*fork)(struct task_struct *task);
eb95419b
TH
630 void (*exit)(struct cgroup_subsys_state *css,
631 struct cgroup_subsys_state *old_css,
761b3ef5 632 struct task_struct *task);
eb95419b 633 void (*bind)(struct cgroup_subsys_state *root_css);
e5991371 634
8bab8dde 635 int disabled;
ddbcc7e8 636 int early_init;
48ddbe19 637
8c7f6edb
TH
638 /*
639 * If %false, this subsystem is properly hierarchical -
640 * configuration, resource accounting and restriction on a parent
641 * cgroup cover those of its children. If %true, hierarchy support
642 * is broken in some ways - some subsystems ignore hierarchy
643 * completely while others are only implemented half-way.
644 *
645 * It's now disallowed to create nested cgroups if the subsystem is
646 * broken and cgroup core will emit a warning message on such
647 * cases. Eventually, all subsystems will be made properly
648 * hierarchical and this will go away.
649 */
650 bool broken_hierarchy;
651 bool warned_broken_hierarchy;
652
073219e9 653 /* the following two fields are initialized automtically during boot */
aec25020 654 int id;
ddbcc7e8
PM
655#define MAX_CGROUP_TYPE_NAMELEN 32
656 const char *name;
657
b85d2040 658 /* link to parent, protected by cgroup_lock() */
3dd06ffa 659 struct cgroup_root *root;
e6a1105b 660
15a4c835
TH
661 /* idr for css->id */
662 struct idr css_idr;
663
0adb0704
TH
664 /*
665 * List of cftypes. Each entry is the first entry of an array
666 * terminated by zero length name.
667 */
668 struct list_head cfts;
8e3f6541 669
de00ffa5 670 /* base cftypes, automatically registered with subsys itself */
8e3f6541 671 struct cftype *base_cftypes;
ddbcc7e8
PM
672};
673
073219e9 674#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
ddbcc7e8
PM
675#include <linux/cgroup_subsys.h>
676#undef SUBSYS
677
14611e51
TH
678/**
679 * task_css_set_check - obtain a task's css_set with extra access conditions
680 * @task: the task to obtain css_set for
681 * @__c: extra condition expression to be passed to rcu_dereference_check()
682 *
683 * A task's css_set is RCU protected, initialized and exited while holding
684 * task_lock(), and can only be modified while holding both cgroup_mutex
685 * and task_lock() while the task is alive. This macro verifies that the
686 * caller is inside proper critical section and returns @task's css_set.
687 *
688 * The caller can also specify additional allowed conditions via @__c, such
689 * as locks used during the cgroup_subsys::attach() methods.
dc61b1d6 690 */
2219449a
TH
691#ifdef CONFIG_PROVE_RCU
692extern struct mutex cgroup_mutex;
0e1d768f 693extern struct rw_semaphore css_set_rwsem;
14611e51
TH
694#define task_css_set_check(task, __c) \
695 rcu_dereference_check((task)->cgroups, \
0e1d768f
TH
696 lockdep_is_held(&cgroup_mutex) || \
697 lockdep_is_held(&css_set_rwsem) || \
698 ((task)->flags & PF_EXITING) || (__c))
2219449a 699#else
14611e51
TH
700#define task_css_set_check(task, __c) \
701 rcu_dereference((task)->cgroups)
2219449a 702#endif
dc61b1d6 703
14611e51 704/**
8af01f56 705 * task_css_check - obtain css for (task, subsys) w/ extra access conds
14611e51
TH
706 * @task: the target task
707 * @subsys_id: the target subsystem ID
708 * @__c: extra condition expression to be passed to rcu_dereference_check()
709 *
710 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
711 * synchronization rules are the same as task_css_set_check().
712 */
8af01f56 713#define task_css_check(task, subsys_id, __c) \
14611e51
TH
714 task_css_set_check((task), (__c))->subsys[(subsys_id)]
715
716/**
717 * task_css_set - obtain a task's css_set
718 * @task: the task to obtain css_set for
719 *
720 * See task_css_set_check().
721 */
722static inline struct css_set *task_css_set(struct task_struct *task)
723{
724 return task_css_set_check(task, false);
725}
726
727/**
8af01f56 728 * task_css - obtain css for (task, subsys)
14611e51
TH
729 * @task: the target task
730 * @subsys_id: the target subsystem ID
731 *
8af01f56 732 * See task_css_check().
14611e51 733 */
8af01f56
TH
734static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
735 int subsys_id)
ddbcc7e8 736{
8af01f56 737 return task_css_check(task, subsys_id, false);
ddbcc7e8
PM
738}
739
5024ae29
TH
740/**
741 * task_css_is_root - test whether a task belongs to the root css
742 * @task: the target task
743 * @subsys_id: the target subsystem ID
744 *
745 * Test whether @task belongs to the root css on the specified subsystem.
746 * May be invoked in any context.
747 */
748static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
749{
750 return task_css_check(task, subsys_id, true) ==
751 init_css_set.subsys[subsys_id];
752}
753
8af01f56
TH
754static inline struct cgroup *task_cgroup(struct task_struct *task,
755 int subsys_id)
ddbcc7e8 756{
8af01f56 757 return task_css(task, subsys_id)->cgroup;
ddbcc7e8
PM
758}
759
492eb21b
TH
760struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
761 struct cgroup_subsys_state *parent);
53fa5261 762
1cb650b9
LZ
763struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
764
574bd9f7 765/**
492eb21b
TH
766 * css_for_each_child - iterate through children of a css
767 * @pos: the css * to use as the loop cursor
768 * @parent: css whose children to walk
574bd9f7 769 *
492eb21b
TH
770 * Walk @parent's children. Must be called under rcu_read_lock(). A child
771 * css which hasn't finished ->css_online() or already has finished
92fb9748 772 * ->css_offline() may show up during traversal and it's each subsystem's
574bd9f7
TH
773 * responsibility to verify that each @pos is alive.
774 *
92fb9748 775 * If a subsystem synchronizes against the parent in its ->css_online() and
492eb21b 776 * before starting iterating, a css which finished ->css_online() is
92fb9748 777 * guaranteed to be visible in the future iterations.
75501a6d
TH
778 *
779 * It is allowed to temporarily drop RCU read lock during iteration. The
780 * caller is responsible for ensuring that @pos remains accessible until
781 * the start of the next iteration by, for example, bumping the css refcnt.
574bd9f7 782 */
492eb21b
TH
783#define css_for_each_child(pos, parent) \
784 for ((pos) = css_next_child(NULL, (parent)); (pos); \
785 (pos) = css_next_child((pos), (parent)))
574bd9f7 786
492eb21b
TH
787struct cgroup_subsys_state *
788css_next_descendant_pre(struct cgroup_subsys_state *pos,
789 struct cgroup_subsys_state *css);
790
791struct cgroup_subsys_state *
792css_rightmost_descendant(struct cgroup_subsys_state *pos);
574bd9f7
TH
793
794/**
492eb21b
TH
795 * css_for_each_descendant_pre - pre-order walk of a css's descendants
796 * @pos: the css * to use as the loop cursor
797 * @root: css whose descendants to walk
574bd9f7 798 *
bd8815a6
TH
799 * Walk @root's descendants. @root is included in the iteration and the
800 * first node to be visited. Must be called under rcu_read_lock(). A
492eb21b 801 * descendant css which hasn't finished ->css_online() or already has
92fb9748 802 * finished ->css_offline() may show up during traversal and it's each
574bd9f7
TH
803 * subsystem's responsibility to verify that each @pos is alive.
804 *
92fb9748
TH
805 * If a subsystem synchronizes against the parent in its ->css_online() and
806 * before starting iterating, and synchronizes against @pos on each
492eb21b 807 * iteration, any descendant css which finished ->css_online() is
574bd9f7
TH
808 * guaranteed to be visible in the future iterations.
809 *
810 * In other words, the following guarantees that a descendant can't escape
811 * state updates of its ancestors.
812 *
492eb21b 813 * my_online(@css)
574bd9f7 814 * {
492eb21b
TH
815 * Lock @css's parent and @css;
816 * Inherit state from the parent;
574bd9f7
TH
817 * Unlock both.
818 * }
819 *
492eb21b 820 * my_update_state(@css)
574bd9f7 821 * {
492eb21b 822 * css_for_each_descendant_pre(@pos, @css) {
574bd9f7 823 * Lock @pos;
bd8815a6
TH
824 * if (@pos == @css)
825 * Update @css's state;
826 * else
827 * Verify @pos is alive and inherit state from its parent;
574bd9f7
TH
828 * Unlock @pos;
829 * }
830 * }
831 *
832 * As long as the inheriting step, including checking the parent state, is
833 * enclosed inside @pos locking, double-locking the parent isn't necessary
834 * while inheriting. The state update to the parent is guaranteed to be
835 * visible by walking order and, as long as inheriting operations to the
836 * same @pos are atomic to each other, multiple updates racing each other
837 * still result in the correct state. It's guaranateed that at least one
492eb21b 838 * inheritance happens for any css after the latest update to its parent.
574bd9f7
TH
839 *
840 * If checking parent's state requires locking the parent, each inheriting
841 * iteration should lock and unlock both @pos->parent and @pos.
842 *
843 * Alternatively, a subsystem may choose to use a single global lock to
92fb9748 844 * synchronize ->css_online() and ->css_offline() against tree-walking
574bd9f7 845 * operations.
75501a6d
TH
846 *
847 * It is allowed to temporarily drop RCU read lock during iteration. The
848 * caller is responsible for ensuring that @pos remains accessible until
849 * the start of the next iteration by, for example, bumping the css refcnt.
574bd9f7 850 */
492eb21b
TH
851#define css_for_each_descendant_pre(pos, css) \
852 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
853 (pos) = css_next_descendant_pre((pos), (css)))
574bd9f7 854
492eb21b
TH
855struct cgroup_subsys_state *
856css_next_descendant_post(struct cgroup_subsys_state *pos,
857 struct cgroup_subsys_state *css);
574bd9f7
TH
858
859/**
492eb21b
TH
860 * css_for_each_descendant_post - post-order walk of a css's descendants
861 * @pos: the css * to use as the loop cursor
862 * @css: css whose descendants to walk
574bd9f7 863 *
492eb21b 864 * Similar to css_for_each_descendant_pre() but performs post-order
bd8815a6
TH
865 * traversal instead. @root is included in the iteration and the last
866 * node to be visited. Note that the walk visibility guarantee described
867 * in pre-order walk doesn't apply the same to post-order walks.
574bd9f7 868 */
492eb21b
TH
869#define css_for_each_descendant_post(pos, css) \
870 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
871 (pos) = css_next_descendant_post((pos), (css)))
574bd9f7 872
72ec7029
TH
873/* A css_task_iter should be treated as an opaque object */
874struct css_task_iter {
3ebb2b6e
TH
875 struct cgroup_subsys *ss;
876
0f0a2b4f
TH
877 struct list_head *cset_pos;
878 struct list_head *cset_head;
879
880 struct list_head *task_pos;
881 struct list_head *tasks_head;
882 struct list_head *mg_tasks_head;
817929ec
PM
883};
884
72ec7029
TH
885void css_task_iter_start(struct cgroup_subsys_state *css,
886 struct css_task_iter *it);
887struct task_struct *css_task_iter_next(struct css_task_iter *it);
888void css_task_iter_end(struct css_task_iter *it);
e535837b 889
31583bb0 890int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
8cc99345 891int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
31583bb0 892
ec903c0c
TH
893struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
894 struct cgroup_subsys *ss);
38460b48 895
ddbcc7e8
PM
896#else /* !CONFIG_CGROUPS */
897
898static inline int cgroup_init_early(void) { return 0; }
899static inline int cgroup_init(void) { return 0; }
b4f48b63 900static inline void cgroup_fork(struct task_struct *p) {}
817929ec 901static inline void cgroup_post_fork(struct task_struct *p) {}
1ec41830 902static inline void cgroup_exit(struct task_struct *p) {}
ddbcc7e8 903
846c7bb0
BS
904static inline int cgroupstats_build(struct cgroupstats *stats,
905 struct dentry *dentry)
906{
907 return -EINVAL;
908}
ddbcc7e8 909
d7926ee3 910/* No cgroups - nothing to do */
31583bb0
MT
911static inline int cgroup_attach_task_all(struct task_struct *from,
912 struct task_struct *t)
913{
914 return 0;
915}
d7926ee3 916
ddbcc7e8
PM
917#endif /* !CONFIG_CGROUPS */
918
919#endif /* _LINUX_CGROUP_H */