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