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