cgroup: move ->subsys_mask from cgroupfs_root to cgroup
[firefly-linux-kernel-4.4.55.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/rwsem.h>
18 #include <linux/idr.h>
19 #include <linux/workqueue.h>
20 #include <linux/fs.h>
21 #include <linux/percpu-refcount.h>
22 #include <linux/seq_file.h>
23 #include <linux/kernfs.h>
24
25 #ifdef CONFIG_CGROUPS
26
27 struct cgroupfs_root;
28 struct cgroup_subsys;
29 struct inode;
30 struct cgroup;
31
32 extern int cgroup_init_early(void);
33 extern int cgroup_init(void);
34 extern void cgroup_fork(struct task_struct *p);
35 extern void cgroup_post_fork(struct task_struct *p);
36 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
37 extern int cgroupstats_build(struct cgroupstats *stats,
38                                 struct dentry *dentry);
39
40 extern int proc_cgroup_show(struct seq_file *, void *);
41
42 /* define the enumeration of all cgroup subsystems */
43 #define SUBSYS(_x) _x ## _cgrp_id,
44 enum cgroup_subsys_id {
45 #include <linux/cgroup_subsys.h>
46         CGROUP_SUBSYS_COUNT,
47 };
48 #undef SUBSYS
49
50 /* Per-subsystem/per-cgroup state maintained by the system. */
51 struct cgroup_subsys_state {
52         /* the cgroup that this css is attached to */
53         struct cgroup *cgroup;
54
55         /* the cgroup subsystem that this css is attached to */
56         struct cgroup_subsys *ss;
57
58         /* reference count - access via css_[try]get() and css_put() */
59         struct percpu_ref refcnt;
60
61         /* the parent css */
62         struct cgroup_subsys_state *parent;
63
64         unsigned long flags;
65
66         /* percpu_ref killing and RCU release */
67         struct rcu_head rcu_head;
68         struct work_struct destroy_work;
69 };
70
71 /* bits in struct cgroup_subsys_state flags field */
72 enum {
73         CSS_ROOT        = (1 << 0), /* this CSS is the root of the subsystem */
74         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
75 };
76
77 /**
78  * css_get - obtain a reference on the specified css
79  * @css: target css
80  *
81  * The caller must already have a reference.
82  */
83 static inline void css_get(struct cgroup_subsys_state *css)
84 {
85         /* We don't need to reference count the root state */
86         if (!(css->flags & CSS_ROOT))
87                 percpu_ref_get(&css->refcnt);
88 }
89
90 /**
91  * css_tryget - try to obtain a reference on the specified css
92  * @css: target css
93  *
94  * Obtain a reference on @css if it's alive.  The caller naturally needs to
95  * ensure that @css is accessible but doesn't have to be holding a
96  * reference on it - IOW, RCU protected access is good enough for this
97  * function.  Returns %true if a reference count was successfully obtained;
98  * %false otherwise.
99  */
100 static inline bool css_tryget(struct cgroup_subsys_state *css)
101 {
102         if (css->flags & CSS_ROOT)
103                 return true;
104         return percpu_ref_tryget(&css->refcnt);
105 }
106
107 /**
108  * css_put - put a css reference
109  * @css: target css
110  *
111  * Put a reference obtained via css_get() and css_tryget().
112  */
113 static inline void css_put(struct cgroup_subsys_state *css)
114 {
115         if (!(css->flags & CSS_ROOT))
116                 percpu_ref_put(&css->refcnt);
117 }
118
119 /* bits in struct cgroup flags field */
120 enum {
121         /* Control Group is dead */
122         CGRP_DEAD,
123         /*
124          * Control Group has previously had a child cgroup or a task,
125          * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
126          */
127         CGRP_RELEASABLE,
128         /* Control Group requires release notifications to userspace */
129         CGRP_NOTIFY_ON_RELEASE,
130         /*
131          * Clone the parent's configuration when creating a new child
132          * cpuset cgroup.  For historical reasons, this option can be
133          * specified at mount time and thus is implemented here.
134          */
135         CGRP_CPUSET_CLONE_CHILDREN,
136         /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
137         CGRP_SANE_BEHAVIOR,
138 };
139
140 struct cgroup {
141         unsigned long flags;            /* "unsigned long" so bitops work */
142
143         /*
144          * idr allocated in-hierarchy ID.
145          *
146          * The ID of the root cgroup is always 0, and a new cgroup
147          * will be assigned with a smallest available ID.
148          *
149          * Allocating/Removing ID must be protected by cgroup_mutex.
150          */
151         int id;
152
153         /* the number of attached css's */
154         int nr_css;
155
156         atomic_t refcnt;
157
158         /*
159          * We link our 'sibling' struct into our parent's 'children'.
160          * Our children link their 'sibling' into our 'children'.
161          */
162         struct list_head sibling;       /* my parent's children */
163         struct list_head children;      /* my children */
164
165         struct cgroup *parent;          /* my parent */
166         struct kernfs_node *kn;         /* cgroup kernfs entry */
167
168         /*
169          * Monotonically increasing unique serial number which defines a
170          * uniform order among all cgroups.  It's guaranteed that all
171          * ->children lists are in the ascending order of ->serial_nr.
172          * It's used to allow interrupting and resuming iterations.
173          */
174         u64 serial_nr;
175
176         /* The bitmask of subsystems attached to this cgroup */
177         unsigned long subsys_mask;
178
179         /* Private pointers for each registered subsystem */
180         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
181
182         struct cgroupfs_root *root;
183
184         /*
185          * List of cgrp_cset_links pointing at css_sets with tasks in this
186          * cgroup.  Protected by css_set_lock.
187          */
188         struct list_head cset_links;
189
190         /*
191          * Linked list running through all cgroups that can
192          * potentially be reaped by the release agent. Protected by
193          * release_list_lock
194          */
195         struct list_head release_list;
196
197         /*
198          * list of pidlists, up to two for each namespace (one for procs, one
199          * for tasks); created on demand.
200          */
201         struct list_head pidlists;
202         struct mutex pidlist_mutex;
203
204         /* dummy css with NULL ->ss, points back to this cgroup */
205         struct cgroup_subsys_state dummy_css;
206
207         /* For css percpu_ref killing and RCU-protected deletion */
208         struct rcu_head rcu_head;
209         struct work_struct destroy_work;
210 };
211
212 #define MAX_CGROUP_ROOT_NAMELEN 64
213
214 /* cgroupfs_root->flags */
215 enum {
216         /*
217          * Unfortunately, cgroup core and various controllers are riddled
218          * with idiosyncrasies and pointless options.  The following flag,
219          * when set, will force sane behavior - some options are forced on,
220          * others are disallowed, and some controllers will change their
221          * hierarchical or other behaviors.
222          *
223          * The set of behaviors affected by this flag are still being
224          * determined and developed and the mount option for this flag is
225          * prefixed with __DEVEL__.  The prefix will be dropped once we
226          * reach the point where all behaviors are compatible with the
227          * planned unified hierarchy, which will automatically turn on this
228          * flag.
229          *
230          * The followings are the behaviors currently affected this flag.
231          *
232          * - Mount options "noprefix", "xattr", "clone_children",
233          *   "release_agent" and "name" are disallowed.
234          *
235          * - When mounting an existing superblock, mount options should
236          *   match.
237          *
238          * - Remount is disallowed.
239          *
240          * - rename(2) is disallowed.
241          *
242          * - "tasks" is removed.  Everything should be at process
243          *   granularity.  Use "cgroup.procs" instead.
244          *
245          * - "cgroup.procs" is not sorted.  pids will be unique unless they
246          *   got recycled inbetween reads.
247          *
248          * - "release_agent" and "notify_on_release" are removed.
249          *   Replacement notification mechanism will be implemented.
250          *
251          * - "cgroup.clone_children" is removed.
252          *
253          * - cpuset: tasks will be kept in empty cpusets when hotplug happens
254          *   and take masks of ancestors with non-empty cpus/mems, instead of
255          *   being moved to an ancestor.
256          *
257          * - cpuset: a task can be moved into an empty cpuset, and again it
258          *   takes masks of ancestors.
259          *
260          * - memcg: use_hierarchy is on by default and the cgroup file for
261          *   the flag is not created.
262          *
263          * - blkcg: blk-throttle becomes properly hierarchical.
264          */
265         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
266
267         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
268         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
269
270         /* mount options live below bit 16 */
271         CGRP_ROOT_OPTION_MASK   = (1 << 16) - 1,
272 };
273
274 /*
275  * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
276  * associated with a kernfs_root to form an active hierarchy.  This is
277  * internal to cgroup core.  Don't access directly from controllers.
278  */
279 struct cgroupfs_root {
280         struct kernfs_root *kf_root;
281
282         /* Unique id for this hierarchy. */
283         int hierarchy_id;
284
285         /* The root cgroup.  Root is destroyed on its release. */
286         struct cgroup top_cgroup;
287
288         /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
289         atomic_t nr_cgrps;
290
291         /* A list running through the active hierarchies */
292         struct list_head root_list;
293
294         /* Hierarchy-specific flags */
295         unsigned long flags;
296
297         /* IDs for cgroups in this hierarchy */
298         struct idr cgroup_idr;
299
300         /* The path to use for release notifications. */
301         char release_agent_path[PATH_MAX];
302
303         /* The name for this hierarchy - may be empty */
304         char name[MAX_CGROUP_ROOT_NAMELEN];
305 };
306
307 /*
308  * A css_set is a structure holding pointers to a set of
309  * cgroup_subsys_state objects. This saves space in the task struct
310  * object and speeds up fork()/exit(), since a single inc/dec and a
311  * list_add()/del() can bump the reference count on the entire cgroup
312  * set for a task.
313  */
314
315 struct css_set {
316
317         /* Reference count */
318         atomic_t refcount;
319
320         /*
321          * List running through all cgroup groups in the same hash
322          * slot. Protected by css_set_lock
323          */
324         struct hlist_node hlist;
325
326         /*
327          * Lists running through all tasks using this cgroup group.
328          * mg_tasks lists tasks which belong to this cset but are in the
329          * process of being migrated out or in.  Protected by
330          * css_set_rwsem, but, during migration, once tasks are moved to
331          * mg_tasks, it can be read safely while holding cgroup_mutex.
332          */
333         struct list_head tasks;
334         struct list_head mg_tasks;
335
336         /*
337          * List of cgrp_cset_links pointing at cgroups referenced from this
338          * css_set.  Protected by css_set_lock.
339          */
340         struct list_head cgrp_links;
341
342         /*
343          * Set of subsystem states, one for each subsystem. This array is
344          * immutable after creation apart from the init_css_set during
345          * subsystem registration (at boot time).
346          */
347         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
348
349         /*
350          * List of csets participating in the on-going migration either as
351          * source or destination.  Protected by cgroup_mutex.
352          */
353         struct list_head mg_preload_node;
354         struct list_head mg_node;
355
356         /*
357          * If this cset is acting as the source of migration the following
358          * two fields are set.  mg_src_cgrp is the source cgroup of the
359          * on-going migration and mg_dst_cset is the destination cset the
360          * target tasks on this cset should be migrated to.  Protected by
361          * cgroup_mutex.
362          */
363         struct cgroup *mg_src_cgrp;
364         struct css_set *mg_dst_cset;
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          * Fields used for internal bookkeeping.  Initialized automatically
414          * during registration.
415          */
416         struct cgroup_subsys *ss;       /* NULL for cgroup core files */
417         struct list_head node;          /* anchored at ss->cfts */
418         struct kernfs_ops *kf_ops;
419
420         /*
421          * read_u64() is a shortcut for the common case of returning a
422          * single integer. Use it in place of read()
423          */
424         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
425         /*
426          * read_s64() is a signed version of read_u64()
427          */
428         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
429
430         /* generic seq_file read interface */
431         int (*seq_show)(struct seq_file *sf, void *v);
432
433         /* optional ops, implement all or none */
434         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
435         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
436         void (*seq_stop)(struct seq_file *sf, void *v);
437
438         /*
439          * write_u64() is a shortcut for the common case of accepting
440          * a single integer (as parsed by simple_strtoull) from
441          * userspace. Use in place of write(); return 0 or error.
442          */
443         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
444                          u64 val);
445         /*
446          * write_s64() is a signed version of write_u64()
447          */
448         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
449                          s64 val);
450
451         /*
452          * write_string() is passed a nul-terminated kernelspace
453          * buffer of maximum length determined by max_write_len.
454          * Returns 0 or -ve error code.
455          */
456         int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
457                             const char *buffer);
458         /*
459          * trigger() callback can be used to get some kick from the
460          * userspace, when the actual string written is not important
461          * at all. The private field can be used to determine the
462          * kick type for multiplexing.
463          */
464         int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
465
466 #ifdef CONFIG_DEBUG_LOCK_ALLOC
467         struct lock_class_key   lockdep_key;
468 #endif
469 };
470
471 /*
472  * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
473  * function can be called as long as @cgrp is accessible.
474  */
475 static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
476 {
477         return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
478 }
479
480 /* no synchronization, the result can only be used as a hint */
481 static inline bool cgroup_has_tasks(struct cgroup *cgrp)
482 {
483         return !list_empty(&cgrp->cset_links);
484 }
485
486 /* returns ino associated with a cgroup, 0 indicates unmounted root */
487 static inline ino_t cgroup_ino(struct cgroup *cgrp)
488 {
489         if (cgrp->kn)
490                 return cgrp->kn->ino;
491         else
492                 return 0;
493 }
494
495 static inline struct cftype *seq_cft(struct seq_file *seq)
496 {
497         struct kernfs_open_file *of = seq->private;
498
499         return of->kn->priv;
500 }
501
502 struct cgroup_subsys_state *seq_css(struct seq_file *seq);
503
504 /*
505  * Name / path handling functions.  All are thin wrappers around the kernfs
506  * counterparts and can be called under any context.
507  */
508
509 static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
510 {
511         return kernfs_name(cgrp->kn, buf, buflen);
512 }
513
514 static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
515                                               size_t buflen)
516 {
517         return kernfs_path(cgrp->kn, buf, buflen);
518 }
519
520 static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
521 {
522         pr_cont_kernfs_name(cgrp->kn);
523 }
524
525 static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
526 {
527         pr_cont_kernfs_path(cgrp->kn);
528 }
529
530 char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
531
532 int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
533 int cgroup_rm_cftypes(struct cftype *cfts);
534
535 bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
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
545 /**
546  * cgroup_taskset_for_each - iterate cgroup_taskset
547  * @task: the loop cursor
548  * @tset: taskset to iterate
549  */
550 #define cgroup_taskset_for_each(task, tset)                             \
551         for ((task) = cgroup_taskset_first((tset)); (task);             \
552              (task) = cgroup_taskset_next((tset)))
553
554 /*
555  * Control Group subsystem type.
556  * See Documentation/cgroups/cgroups.txt for details
557  */
558
559 struct cgroup_subsys {
560         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
561         int (*css_online)(struct cgroup_subsys_state *css);
562         void (*css_offline)(struct cgroup_subsys_state *css);
563         void (*css_free)(struct cgroup_subsys_state *css);
564
565         int (*can_attach)(struct cgroup_subsys_state *css,
566                           struct cgroup_taskset *tset);
567         void (*cancel_attach)(struct cgroup_subsys_state *css,
568                               struct cgroup_taskset *tset);
569         void (*attach)(struct cgroup_subsys_state *css,
570                        struct cgroup_taskset *tset);
571         void (*fork)(struct task_struct *task);
572         void (*exit)(struct cgroup_subsys_state *css,
573                      struct cgroup_subsys_state *old_css,
574                      struct task_struct *task);
575         void (*bind)(struct cgroup_subsys_state *root_css);
576
577         int disabled;
578         int early_init;
579
580         /*
581          * If %false, this subsystem is properly hierarchical -
582          * configuration, resource accounting and restriction on a parent
583          * cgroup cover those of its children.  If %true, hierarchy support
584          * is broken in some ways - some subsystems ignore hierarchy
585          * completely while others are only implemented half-way.
586          *
587          * It's now disallowed to create nested cgroups if the subsystem is
588          * broken and cgroup core will emit a warning message on such
589          * cases.  Eventually, all subsystems will be made properly
590          * hierarchical and this will go away.
591          */
592         bool broken_hierarchy;
593         bool warned_broken_hierarchy;
594
595         /* the following two fields are initialized automtically during boot */
596         int id;
597 #define MAX_CGROUP_TYPE_NAMELEN 32
598         const char *name;
599
600         /* link to parent, protected by cgroup_lock() */
601         struct cgroupfs_root *root;
602
603         /*
604          * List of cftypes.  Each entry is the first entry of an array
605          * terminated by zero length name.
606          */
607         struct list_head cfts;
608
609         /* base cftypes, automatically registered with subsys itself */
610         struct cftype *base_cftypes;
611 };
612
613 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
614 #include <linux/cgroup_subsys.h>
615 #undef SUBSYS
616
617 /**
618  * css_parent - find the parent css
619  * @css: the target cgroup_subsys_state
620  *
621  * Return the parent css of @css.  This function is guaranteed to return
622  * non-NULL parent as long as @css isn't the root.
623  */
624 static inline
625 struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
626 {
627         return css->parent;
628 }
629
630 /**
631  * task_css_set_check - obtain a task's css_set with extra access conditions
632  * @task: the task to obtain css_set for
633  * @__c: extra condition expression to be passed to rcu_dereference_check()
634  *
635  * A task's css_set is RCU protected, initialized and exited while holding
636  * task_lock(), and can only be modified while holding both cgroup_mutex
637  * and task_lock() while the task is alive.  This macro verifies that the
638  * caller is inside proper critical section and returns @task's css_set.
639  *
640  * The caller can also specify additional allowed conditions via @__c, such
641  * as locks used during the cgroup_subsys::attach() methods.
642  */
643 #ifdef CONFIG_PROVE_RCU
644 extern struct mutex cgroup_mutex;
645 extern struct rw_semaphore css_set_rwsem;
646 #define task_css_set_check(task, __c)                                   \
647         rcu_dereference_check((task)->cgroups,                          \
648                 lockdep_is_held(&cgroup_mutex) ||                       \
649                 lockdep_is_held(&css_set_rwsem) ||                      \
650                 ((task)->flags & PF_EXITING) || (__c))
651 #else
652 #define task_css_set_check(task, __c)                                   \
653         rcu_dereference((task)->cgroups)
654 #endif
655
656 /**
657  * task_css_check - obtain css for (task, subsys) w/ extra access conds
658  * @task: the target task
659  * @subsys_id: the target subsystem ID
660  * @__c: extra condition expression to be passed to rcu_dereference_check()
661  *
662  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
663  * synchronization rules are the same as task_css_set_check().
664  */
665 #define task_css_check(task, subsys_id, __c)                            \
666         task_css_set_check((task), (__c))->subsys[(subsys_id)]
667
668 /**
669  * task_css_set - obtain a task's css_set
670  * @task: the task to obtain css_set for
671  *
672  * See task_css_set_check().
673  */
674 static inline struct css_set *task_css_set(struct task_struct *task)
675 {
676         return task_css_set_check(task, false);
677 }
678
679 /**
680  * task_css - obtain css for (task, subsys)
681  * @task: the target task
682  * @subsys_id: the target subsystem ID
683  *
684  * See task_css_check().
685  */
686 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
687                                                    int subsys_id)
688 {
689         return task_css_check(task, subsys_id, false);
690 }
691
692 static inline struct cgroup *task_cgroup(struct task_struct *task,
693                                          int subsys_id)
694 {
695         return task_css(task, subsys_id)->cgroup;
696 }
697
698 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
699                                            struct cgroup_subsys_state *parent);
700
701 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
702
703 /**
704  * css_for_each_child - iterate through children of a css
705  * @pos: the css * to use as the loop cursor
706  * @parent: css whose children to walk
707  *
708  * Walk @parent's children.  Must be called under rcu_read_lock().  A child
709  * css which hasn't finished ->css_online() or already has finished
710  * ->css_offline() may show up during traversal and it's each subsystem's
711  * responsibility to verify that each @pos is alive.
712  *
713  * If a subsystem synchronizes against the parent in its ->css_online() and
714  * before starting iterating, a css which finished ->css_online() is
715  * guaranteed to be visible in the future iterations.
716  *
717  * It is allowed to temporarily drop RCU read lock during iteration.  The
718  * caller is responsible for ensuring that @pos remains accessible until
719  * the start of the next iteration by, for example, bumping the css refcnt.
720  */
721 #define css_for_each_child(pos, parent)                                 \
722         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
723              (pos) = css_next_child((pos), (parent)))
724
725 struct cgroup_subsys_state *
726 css_next_descendant_pre(struct cgroup_subsys_state *pos,
727                         struct cgroup_subsys_state *css);
728
729 struct cgroup_subsys_state *
730 css_rightmost_descendant(struct cgroup_subsys_state *pos);
731
732 /**
733  * css_for_each_descendant_pre - pre-order walk of a css's descendants
734  * @pos: the css * to use as the loop cursor
735  * @root: css whose descendants to walk
736  *
737  * Walk @root's descendants.  @root is included in the iteration and the
738  * first node to be visited.  Must be called under rcu_read_lock().  A
739  * descendant css which hasn't finished ->css_online() or already has
740  * finished ->css_offline() may show up during traversal and it's each
741  * subsystem's responsibility to verify that each @pos is alive.
742  *
743  * If a subsystem synchronizes against the parent in its ->css_online() and
744  * before starting iterating, and synchronizes against @pos on each
745  * iteration, any descendant css which finished ->css_online() is
746  * guaranteed to be visible in the future iterations.
747  *
748  * In other words, the following guarantees that a descendant can't escape
749  * state updates of its ancestors.
750  *
751  * my_online(@css)
752  * {
753  *      Lock @css's parent and @css;
754  *      Inherit state from the parent;
755  *      Unlock both.
756  * }
757  *
758  * my_update_state(@css)
759  * {
760  *      css_for_each_descendant_pre(@pos, @css) {
761  *              Lock @pos;
762  *              if (@pos == @css)
763  *                      Update @css's state;
764  *              else
765  *                      Verify @pos is alive and inherit state from its parent;
766  *              Unlock @pos;
767  *      }
768  * }
769  *
770  * As long as the inheriting step, including checking the parent state, is
771  * enclosed inside @pos locking, double-locking the parent isn't necessary
772  * while inheriting.  The state update to the parent is guaranteed to be
773  * visible by walking order and, as long as inheriting operations to the
774  * same @pos are atomic to each other, multiple updates racing each other
775  * still result in the correct state.  It's guaranateed that at least one
776  * inheritance happens for any css after the latest update to its parent.
777  *
778  * If checking parent's state requires locking the parent, each inheriting
779  * iteration should lock and unlock both @pos->parent and @pos.
780  *
781  * Alternatively, a subsystem may choose to use a single global lock to
782  * synchronize ->css_online() and ->css_offline() against tree-walking
783  * operations.
784  *
785  * It is allowed to temporarily drop RCU read lock during iteration.  The
786  * caller is responsible for ensuring that @pos remains accessible until
787  * the start of the next iteration by, for example, bumping the css refcnt.
788  */
789 #define css_for_each_descendant_pre(pos, css)                           \
790         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
791              (pos) = css_next_descendant_pre((pos), (css)))
792
793 struct cgroup_subsys_state *
794 css_next_descendant_post(struct cgroup_subsys_state *pos,
795                          struct cgroup_subsys_state *css);
796
797 /**
798  * css_for_each_descendant_post - post-order walk of a css's descendants
799  * @pos: the css * to use as the loop cursor
800  * @css: css whose descendants to walk
801  *
802  * Similar to css_for_each_descendant_pre() but performs post-order
803  * traversal instead.  @root is included in the iteration and the last
804  * node to be visited.  Note that the walk visibility guarantee described
805  * in pre-order walk doesn't apply the same to post-order walks.
806  */
807 #define css_for_each_descendant_post(pos, css)                          \
808         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
809              (pos) = css_next_descendant_post((pos), (css)))
810
811 /* A css_task_iter should be treated as an opaque object */
812 struct css_task_iter {
813         struct cgroup_subsys_state      *origin_css;
814         struct list_head                *cset_link;
815         struct list_head                *task;
816 };
817
818 void css_task_iter_start(struct cgroup_subsys_state *css,
819                          struct css_task_iter *it);
820 struct task_struct *css_task_iter_next(struct css_task_iter *it);
821 void css_task_iter_end(struct css_task_iter *it);
822
823 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
824 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
825
826 struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
827                                                 struct cgroup_subsys *ss);
828
829 #else /* !CONFIG_CGROUPS */
830
831 static inline int cgroup_init_early(void) { return 0; }
832 static inline int cgroup_init(void) { return 0; }
833 static inline void cgroup_fork(struct task_struct *p) {}
834 static inline void cgroup_post_fork(struct task_struct *p) {}
835 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
836
837 static inline int cgroupstats_build(struct cgroupstats *stats,
838                                         struct dentry *dentry)
839 {
840         return -EINVAL;
841 }
842
843 /* No cgroups - nothing to do */
844 static inline int cgroup_attach_task_all(struct task_struct *from,
845                                          struct task_struct *t)
846 {
847         return 0;
848 }
849
850 #endif /* !CONFIG_CGROUPS */
851
852 #endif /* _LINUX_CGROUP_H */