cgroup: misc preps for kernfs conversion
[cascardo/linux.git] / include / linux / cgroup.h
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>
12 #include <linux/cpumask.h>
13 #include <linux/nodemask.h>
14 #include <linux/rcupdate.h>
15 #include <linux/rculist.h>
16 #include <linux/cgroupstats.h>
17 #include <linux/prio_heap.h>
18 #include <linux/rwsem.h>
19 #include <linux/idr.h>
20 #include <linux/workqueue.h>
21 #include <linux/xattr.h>
22 #include <linux/fs.h>
23 #include <linux/percpu-refcount.h>
24 #include <linux/seq_file.h>
25
26 #ifdef CONFIG_CGROUPS
27
28 struct cgroupfs_root;
29 struct cgroup_subsys;
30 struct inode;
31 struct cgroup;
32
33 extern int cgroup_init_early(void);
34 extern int cgroup_init(void);
35 extern void cgroup_fork(struct task_struct *p);
36 extern void cgroup_post_fork(struct task_struct *p);
37 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
38 extern int cgroupstats_build(struct cgroupstats *stats,
39                                 struct dentry *dentry);
40
41 extern int proc_cgroup_show(struct seq_file *, void *);
42
43 /* define the enumeration of all cgroup subsystems */
44 #define SUBSYS(_x) _x ## _cgrp_id,
45 enum cgroup_subsys_id {
46 #include <linux/cgroup_subsys.h>
47         CGROUP_SUBSYS_COUNT,
48 };
49 #undef SUBSYS
50
51 /* Per-subsystem/per-cgroup state maintained by the system. */
52 struct cgroup_subsys_state {
53         /* the cgroup that this css is attached to */
54         struct cgroup *cgroup;
55
56         /* the cgroup subsystem that this css is attached to */
57         struct cgroup_subsys *ss;
58
59         /* reference count - access via css_[try]get() and css_put() */
60         struct percpu_ref refcnt;
61
62         /* the parent css */
63         struct cgroup_subsys_state *parent;
64
65         unsigned long flags;
66
67         /* percpu_ref killing and RCU release */
68         struct rcu_head rcu_head;
69         struct work_struct destroy_work;
70 };
71
72 /* bits in struct cgroup_subsys_state flags field */
73 enum {
74         CSS_ROOT        = (1 << 0), /* this CSS is the root of the subsystem */
75         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
76 };
77
78 /**
79  * css_get - obtain a reference on the specified css
80  * @css: target css
81  *
82  * The caller must already have a reference.
83  */
84 static inline void css_get(struct cgroup_subsys_state *css)
85 {
86         /* We don't need to reference count the root state */
87         if (!(css->flags & CSS_ROOT))
88                 percpu_ref_get(&css->refcnt);
89 }
90
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  */
101 static inline bool css_tryget(struct cgroup_subsys_state *css)
102 {
103         if (css->flags & CSS_ROOT)
104                 return true;
105         return percpu_ref_tryget(&css->refcnt);
106 }
107
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  */
114 static inline void css_put(struct cgroup_subsys_state *css)
115 {
116         if (!(css->flags & CSS_ROOT))
117                 percpu_ref_put(&css->refcnt);
118 }
119
120 /* bits in struct cgroup flags field */
121 enum {
122         /* Control Group is dead */
123         CGRP_DEAD,
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          */
128         CGRP_RELEASABLE,
129         /* Control Group requires release notifications to userspace */
130         CGRP_NOTIFY_ON_RELEASE,
131         /*
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.
135          */
136         CGRP_CPUSET_CLONE_CHILDREN,
137         /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
138         CGRP_SANE_BEHAVIOR,
139 };
140
141 struct cgroup_name {
142         struct rcu_head rcu_head;
143         char name[];
144 };
145
146 struct cgroup {
147         unsigned long flags;            /* "unsigned long" so bitops work */
148
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.
154          *
155          * Allocating/Removing ID must be protected by cgroup_mutex.
156          */
157         int id;
158
159         /* the number of attached css's */
160         int nr_css;
161
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 */
168         struct list_head files;         /* my files */
169
170         struct cgroup *parent;          /* my parent */
171         struct dentry *dentry;          /* cgroup fs entry, RCU protected */
172
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
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
194         /* Private pointers for each registered subsystem */
195         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
196
197         struct cgroupfs_root *root;
198
199         /*
200          * List of cgrp_cset_links pointing at css_sets with tasks in this
201          * cgroup.  Protected by css_set_lock.
202          */
203         struct list_head cset_links;
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;
211
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;
218
219         /* dummy css with NULL ->ss, points back to this cgroup */
220         struct cgroup_subsys_state dummy_css;
221
222         /* For css percpu_ref killing and RCU-protected deletion */
223         struct rcu_head rcu_head;
224         struct work_struct destroy_work;
225
226         /* directory xattrs */
227         struct simple_xattrs xattrs;
228 };
229
230 #define MAX_CGROUP_ROOT_NAMELEN 64
231
232 /* cgroupfs_root->flags */
233 enum {
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          *
258          * - rename(2) is disallowed.
259          *
260          * - "tasks" is removed.  Everything should be at process
261          *   granularity.  Use "cgroup.procs" instead.
262          *
263          * - "cgroup.procs" is not sorted.  pids will be unique unless they
264          *   got recycled inbetween reads.
265          *
266          * - "release_agent" and "notify_on_release" are removed.
267          *   Replacement notification mechanism will be implemented.
268          *
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          *
273          * - cpuset: a task can be moved into an empty cpuset, and again it
274          *   takes masks of ancestors.
275          *
276          * - memcg: use_hierarchy is on by default and the cgroup file for
277          *   the flag is not created.
278          *
279          * - blkcg: blk-throttle becomes properly hierarchical.
280          */
281         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
282
283         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
284         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
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 */
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  */
297 struct cgroupfs_root {
298         struct super_block *sb;
299
300         /* The bitmask of subsystems attached to this hierarchy */
301         unsigned long subsys_mask;
302
303         /* Unique id for this hierarchy. */
304         int hierarchy_id;
305
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
315         /* Hierarchy-specific flags */
316         unsigned long flags;
317
318         /* IDs for cgroups in this hierarchy */
319         struct idr cgroup_idr;
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
328 /*
329  * A css_set is a structure holding pointers to a set of
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
332  * list_add()/del() can bump the reference count on the entire cgroup
333  * set for a task.
334  */
335
336 struct css_set {
337
338         /* Reference count */
339         atomic_t refcount;
340
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
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         /*
354          * List of cgrp_cset_links pointing at cgroups referenced from this
355          * css_set.  Protected by css_set_lock.
356          */
357         struct list_head cgrp_links;
358
359         /*
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).
363          */
364         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
365
366         /* For RCU-protected deletion */
367         struct rcu_head rcu_head;
368 };
369
370 /*
371  * struct cftype: handler definitions for cgroup control files
372  *
373  * When reading/writing to a file:
374  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
375  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
376  */
377
378 /* cftype->flags */
379 enum {
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 */
382         CFTYPE_INSANE           = (1 << 2),     /* don't create if sane_behavior */
383         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
384 };
385
386 #define MAX_CFTYPE_NAME         64
387
388 struct cftype {
389         /*
390          * By convention, the name should begin with the name of the
391          * subsystem, followed by a period.  Zero length string indicates
392          * end of cftype array.
393          */
394         char name[MAX_CFTYPE_NAME];
395         int private;
396         /*
397          * If not 0, file mode is set to this value, otherwise it will
398          * be figured out automatically
399          */
400         umode_t mode;
401
402         /*
403          * The maximum length of string, excluding trailing nul, that can
404          * be passed to write_string.  If < PAGE_SIZE-1, PAGE_SIZE-1 is
405          * assumed.
406          */
407         size_t max_write_len;
408
409         /* CFTYPE_* flags */
410         unsigned int flags;
411
412         /*
413          * The subsys this file belongs to.  Initialized automatically
414          * during registration.  NULL for cgroup core files.
415          */
416         struct cgroup_subsys *ss;
417
418         /*
419          * read_u64() is a shortcut for the common case of returning a
420          * single integer. Use it in place of read()
421          */
422         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
423         /*
424          * read_s64() is a signed version of read_u64()
425          */
426         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
427
428         /* generic seq_file read interface */
429         int (*seq_show)(struct seq_file *sf, void *v);
430
431         /* optional ops, implement all or none */
432         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
433         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
434         void (*seq_stop)(struct seq_file *sf, void *v);
435
436         /*
437          * write_u64() is a shortcut for the common case of accepting
438          * a single integer (as parsed by simple_strtoull) from
439          * userspace. Use in place of write(); return 0 or error.
440          */
441         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
442                          u64 val);
443         /*
444          * write_s64() is a signed version of write_u64()
445          */
446         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
447                          s64 val);
448
449         /*
450          * write_string() is passed a nul-terminated kernelspace
451          * buffer of maximum length determined by max_write_len.
452          * Returns 0 or -ve error code.
453          */
454         int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
455                             const char *buffer);
456         /*
457          * trigger() callback can be used to get some kick from the
458          * userspace, when the actual string written is not important
459          * at all. The private field can be used to determine the
460          * kick type for multiplexing.
461          */
462         int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
463 };
464
465 /*
466  * cftype_sets describe cftypes belonging to a subsystem and are chained at
467  * cgroup_subsys->cftsets.  Each cftset points to an array of cftypes
468  * terminated by zero length name.
469  */
470 struct cftype_set {
471         struct list_head                node;   /* chained at subsys->cftsets */
472         struct cftype                   *cfts;
473 };
474
475 /*
476  * cgroupfs file entry, pointed to from leaf dentry->d_fsdata.  Don't
477  * access directly.
478  */
479 struct cfent {
480         struct list_head                node;
481         struct dentry                   *dentry;
482         struct cftype                   *type;
483         struct cgroup_subsys_state      *css;
484
485         /* file xattrs */
486         struct simple_xattrs            xattrs;
487 };
488
489 /* seq_file->private points to the following, only ->priv is public */
490 struct cgroup_open_file {
491         struct cfent                    *cfe;
492         void                            *priv;
493 };
494
495 /*
496  * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
497  * function can be called as long as @cgrp is accessible.
498  */
499 static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
500 {
501         return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
502 }
503
504 /* Caller should hold rcu_read_lock() */
505 static inline const char *cgroup_name(const struct cgroup *cgrp)
506 {
507         return rcu_dereference(cgrp->name)->name;
508 }
509
510 /* returns ino associated with a cgroup, 0 indicates unmounted root */
511 static inline ino_t cgroup_ino(struct cgroup *cgrp)
512 {
513         if (cgrp->dentry)
514                 return cgrp->dentry->d_inode->i_ino;
515         else
516                 return 0;
517 }
518
519 static inline struct cftype *seq_cft(struct seq_file *seq)
520 {
521         struct cgroup_open_file *of = seq->private;
522         return of->cfe->type;
523 }
524
525 struct cgroup_subsys_state *seq_css(struct seq_file *seq);
526
527 int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
528 int cgroup_rm_cftypes(struct cftype *cfts);
529
530 bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
531
532 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
533 int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
534
535 int cgroup_task_count(const struct cgroup *cgrp);
536
537 /*
538  * Control Group taskset, used to pass around set of tasks to cgroup_subsys
539  * methods.
540  */
541 struct cgroup_taskset;
542 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
543 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
544 struct cgroup_subsys_state *cgroup_taskset_cur_css(struct cgroup_taskset *tset,
545                                                    int subsys_id);
546 int cgroup_taskset_size(struct cgroup_taskset *tset);
547
548 /**
549  * cgroup_taskset_for_each - iterate cgroup_taskset
550  * @task: the loop cursor
551  * @skip_css: skip if task's css matches this, %NULL to iterate through all
552  * @tset: taskset to iterate
553  */
554 #define cgroup_taskset_for_each(task, skip_css, tset)                   \
555         for ((task) = cgroup_taskset_first((tset)); (task);             \
556              (task) = cgroup_taskset_next((tset)))                      \
557                 if (!(skip_css) ||                                      \
558                     cgroup_taskset_cur_css((tset),                      \
559                         (skip_css)->ss->id) != (skip_css))
560
561 /*
562  * Control Group subsystem type.
563  * See Documentation/cgroups/cgroups.txt for details
564  */
565
566 struct cgroup_subsys {
567         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
568         int (*css_online)(struct cgroup_subsys_state *css);
569         void (*css_offline)(struct cgroup_subsys_state *css);
570         void (*css_free)(struct cgroup_subsys_state *css);
571
572         int (*can_attach)(struct cgroup_subsys_state *css,
573                           struct cgroup_taskset *tset);
574         void (*cancel_attach)(struct cgroup_subsys_state *css,
575                               struct cgroup_taskset *tset);
576         void (*attach)(struct cgroup_subsys_state *css,
577                        struct cgroup_taskset *tset);
578         void (*fork)(struct task_struct *task);
579         void (*exit)(struct cgroup_subsys_state *css,
580                      struct cgroup_subsys_state *old_css,
581                      struct task_struct *task);
582         void (*bind)(struct cgroup_subsys_state *root_css);
583
584         int disabled;
585         int early_init;
586
587         /*
588          * If %false, this subsystem is properly hierarchical -
589          * configuration, resource accounting and restriction on a parent
590          * cgroup cover those of its children.  If %true, hierarchy support
591          * is broken in some ways - some subsystems ignore hierarchy
592          * completely while others are only implemented half-way.
593          *
594          * It's now disallowed to create nested cgroups if the subsystem is
595          * broken and cgroup core will emit a warning message on such
596          * cases.  Eventually, all subsystems will be made properly
597          * hierarchical and this will go away.
598          */
599         bool broken_hierarchy;
600         bool warned_broken_hierarchy;
601
602         /* the following two fields are initialized automtically during boot */
603         int id;
604 #define MAX_CGROUP_TYPE_NAMELEN 32
605         const char *name;
606
607         /* link to parent, protected by cgroup_lock() */
608         struct cgroupfs_root *root;
609
610         /* list of cftype_sets */
611         struct list_head cftsets;
612
613         /* base cftypes, automatically registered with subsys itself */
614         struct cftype *base_cftypes;
615 };
616
617 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
618 #include <linux/cgroup_subsys.h>
619 #undef SUBSYS
620
621 /**
622  * css_parent - find the parent css
623  * @css: the target cgroup_subsys_state
624  *
625  * Return the parent css of @css.  This function is guaranteed to return
626  * non-NULL parent as long as @css isn't the root.
627  */
628 static inline
629 struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
630 {
631         return css->parent;
632 }
633
634 /**
635  * task_css_set_check - obtain a task's css_set with extra access conditions
636  * @task: the task to obtain css_set for
637  * @__c: extra condition expression to be passed to rcu_dereference_check()
638  *
639  * A task's css_set is RCU protected, initialized and exited while holding
640  * task_lock(), and can only be modified while holding both cgroup_mutex
641  * and task_lock() while the task is alive.  This macro verifies that the
642  * caller is inside proper critical section and returns @task's css_set.
643  *
644  * The caller can also specify additional allowed conditions via @__c, such
645  * as locks used during the cgroup_subsys::attach() methods.
646  */
647 #ifdef CONFIG_PROVE_RCU
648 extern struct mutex cgroup_mutex;
649 #define task_css_set_check(task, __c)                                   \
650         rcu_dereference_check((task)->cgroups,                          \
651                 lockdep_is_held(&(task)->alloc_lock) ||                 \
652                 lockdep_is_held(&cgroup_mutex) || (__c))
653 #else
654 #define task_css_set_check(task, __c)                                   \
655         rcu_dereference((task)->cgroups)
656 #endif
657
658 /**
659  * task_css_check - obtain css for (task, subsys) w/ extra access conds
660  * @task: the target task
661  * @subsys_id: the target subsystem ID
662  * @__c: extra condition expression to be passed to rcu_dereference_check()
663  *
664  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
665  * synchronization rules are the same as task_css_set_check().
666  */
667 #define task_css_check(task, subsys_id, __c)                            \
668         task_css_set_check((task), (__c))->subsys[(subsys_id)]
669
670 /**
671  * task_css_set - obtain a task's css_set
672  * @task: the task to obtain css_set for
673  *
674  * See task_css_set_check().
675  */
676 static inline struct css_set *task_css_set(struct task_struct *task)
677 {
678         return task_css_set_check(task, false);
679 }
680
681 /**
682  * task_css - obtain css for (task, subsys)
683  * @task: the target task
684  * @subsys_id: the target subsystem ID
685  *
686  * See task_css_check().
687  */
688 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
689                                                    int subsys_id)
690 {
691         return task_css_check(task, subsys_id, false);
692 }
693
694 static inline struct cgroup *task_cgroup(struct task_struct *task,
695                                          int subsys_id)
696 {
697         return task_css(task, subsys_id)->cgroup;
698 }
699
700 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
701                                            struct cgroup_subsys_state *parent);
702
703 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
704
705 /**
706  * css_for_each_child - iterate through children of a css
707  * @pos: the css * to use as the loop cursor
708  * @parent: css whose children to walk
709  *
710  * Walk @parent's children.  Must be called under rcu_read_lock().  A child
711  * css which hasn't finished ->css_online() or already has finished
712  * ->css_offline() may show up during traversal and it's each subsystem's
713  * responsibility to verify that each @pos is alive.
714  *
715  * If a subsystem synchronizes against the parent in its ->css_online() and
716  * before starting iterating, a css which finished ->css_online() is
717  * guaranteed to be visible in the future iterations.
718  *
719  * It is allowed to temporarily drop RCU read lock during iteration.  The
720  * caller is responsible for ensuring that @pos remains accessible until
721  * the start of the next iteration by, for example, bumping the css refcnt.
722  */
723 #define css_for_each_child(pos, parent)                                 \
724         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
725              (pos) = css_next_child((pos), (parent)))
726
727 struct cgroup_subsys_state *
728 css_next_descendant_pre(struct cgroup_subsys_state *pos,
729                         struct cgroup_subsys_state *css);
730
731 struct cgroup_subsys_state *
732 css_rightmost_descendant(struct cgroup_subsys_state *pos);
733
734 /**
735  * css_for_each_descendant_pre - pre-order walk of a css's descendants
736  * @pos: the css * to use as the loop cursor
737  * @root: css whose descendants to walk
738  *
739  * Walk @root's descendants.  @root is included in the iteration and the
740  * first node to be visited.  Must be called under rcu_read_lock().  A
741  * descendant css which hasn't finished ->css_online() or already has
742  * finished ->css_offline() may show up during traversal and it's each
743  * subsystem's responsibility to verify that each @pos is alive.
744  *
745  * If a subsystem synchronizes against the parent in its ->css_online() and
746  * before starting iterating, and synchronizes against @pos on each
747  * iteration, any descendant css which finished ->css_online() is
748  * guaranteed to be visible in the future iterations.
749  *
750  * In other words, the following guarantees that a descendant can't escape
751  * state updates of its ancestors.
752  *
753  * my_online(@css)
754  * {
755  *      Lock @css's parent and @css;
756  *      Inherit state from the parent;
757  *      Unlock both.
758  * }
759  *
760  * my_update_state(@css)
761  * {
762  *      css_for_each_descendant_pre(@pos, @css) {
763  *              Lock @pos;
764  *              if (@pos == @css)
765  *                      Update @css's state;
766  *              else
767  *                      Verify @pos is alive and inherit state from its parent;
768  *              Unlock @pos;
769  *      }
770  * }
771  *
772  * As long as the inheriting step, including checking the parent state, is
773  * enclosed inside @pos locking, double-locking the parent isn't necessary
774  * while inheriting.  The state update to the parent is guaranteed to be
775  * visible by walking order and, as long as inheriting operations to the
776  * same @pos are atomic to each other, multiple updates racing each other
777  * still result in the correct state.  It's guaranateed that at least one
778  * inheritance happens for any css after the latest update to its parent.
779  *
780  * If checking parent's state requires locking the parent, each inheriting
781  * iteration should lock and unlock both @pos->parent and @pos.
782  *
783  * Alternatively, a subsystem may choose to use a single global lock to
784  * synchronize ->css_online() and ->css_offline() against tree-walking
785  * operations.
786  *
787  * It is allowed to temporarily drop RCU read lock during iteration.  The
788  * caller is responsible for ensuring that @pos remains accessible until
789  * the start of the next iteration by, for example, bumping the css refcnt.
790  */
791 #define css_for_each_descendant_pre(pos, css)                           \
792         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
793              (pos) = css_next_descendant_pre((pos), (css)))
794
795 struct cgroup_subsys_state *
796 css_next_descendant_post(struct cgroup_subsys_state *pos,
797                          struct cgroup_subsys_state *css);
798
799 /**
800  * css_for_each_descendant_post - post-order walk of a css's descendants
801  * @pos: the css * to use as the loop cursor
802  * @css: css whose descendants to walk
803  *
804  * Similar to css_for_each_descendant_pre() but performs post-order
805  * traversal instead.  @root is included in the iteration and the last
806  * node to be visited.  Note that the walk visibility guarantee described
807  * in pre-order walk doesn't apply the same to post-order walks.
808  */
809 #define css_for_each_descendant_post(pos, css)                          \
810         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
811              (pos) = css_next_descendant_post((pos), (css)))
812
813 /* A css_task_iter should be treated as an opaque object */
814 struct css_task_iter {
815         struct cgroup_subsys_state      *origin_css;
816         struct list_head                *cset_link;
817         struct list_head                *task;
818 };
819
820 void css_task_iter_start(struct cgroup_subsys_state *css,
821                          struct css_task_iter *it);
822 struct task_struct *css_task_iter_next(struct css_task_iter *it);
823 void css_task_iter_end(struct css_task_iter *it);
824
825 int css_scan_tasks(struct cgroup_subsys_state *css,
826                    bool (*test)(struct task_struct *, void *),
827                    void (*process)(struct task_struct *, void *),
828                    void *data, struct ptr_heap *heap);
829
830 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
831 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
832
833 struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
834                                                 struct cgroup_subsys *ss);
835
836 #else /* !CONFIG_CGROUPS */
837
838 static inline int cgroup_init_early(void) { return 0; }
839 static inline int cgroup_init(void) { return 0; }
840 static inline void cgroup_fork(struct task_struct *p) {}
841 static inline void cgroup_post_fork(struct task_struct *p) {}
842 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
843
844 static inline int cgroupstats_build(struct cgroupstats *stats,
845                                         struct dentry *dentry)
846 {
847         return -EINVAL;
848 }
849
850 /* No cgroups - nothing to do */
851 static inline int cgroup_attach_task_all(struct task_struct *from,
852                                          struct task_struct *t)
853 {
854         return 0;
855 }
856
857 #endif /* !CONFIG_CGROUPS */
858
859 #endif /* _LINUX_CGROUP_H */