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