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