cgroup: deal with dummp_top in cgroup_name() and cgroup_path()
[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         /* Private pointers for each registered subsystem */
177         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
178
179         struct cgroupfs_root *root;
180
181         /*
182          * List of cgrp_cset_links pointing at css_sets with tasks in this
183          * cgroup.  Protected by css_set_lock.
184          */
185         struct list_head cset_links;
186
187         /*
188          * Linked list running through all cgroups that can
189          * potentially be reaped by the release agent. Protected by
190          * release_list_lock
191          */
192         struct list_head release_list;
193
194         /*
195          * list of pidlists, up to two for each namespace (one for procs, one
196          * for tasks); created on demand.
197          */
198         struct list_head pidlists;
199         struct mutex pidlist_mutex;
200
201         /* dummy css with NULL ->ss, points back to this cgroup */
202         struct cgroup_subsys_state dummy_css;
203
204         /* For css percpu_ref killing and RCU-protected deletion */
205         struct rcu_head rcu_head;
206         struct work_struct destroy_work;
207 };
208
209 #define MAX_CGROUP_ROOT_NAMELEN 64
210
211 /* cgroupfs_root->flags */
212 enum {
213         /*
214          * Unfortunately, cgroup core and various controllers are riddled
215          * with idiosyncrasies and pointless options.  The following flag,
216          * when set, will force sane behavior - some options are forced on,
217          * others are disallowed, and some controllers will change their
218          * hierarchical or other behaviors.
219          *
220          * The set of behaviors affected by this flag are still being
221          * determined and developed and the mount option for this flag is
222          * prefixed with __DEVEL__.  The prefix will be dropped once we
223          * reach the point where all behaviors are compatible with the
224          * planned unified hierarchy, which will automatically turn on this
225          * flag.
226          *
227          * The followings are the behaviors currently affected this flag.
228          *
229          * - Mount options "noprefix", "xattr", "clone_children",
230          *   "release_agent" and "name" are disallowed.
231          *
232          * - When mounting an existing superblock, mount options should
233          *   match.
234          *
235          * - Remount is disallowed.
236          *
237          * - rename(2) is disallowed.
238          *
239          * - "tasks" is removed.  Everything should be at process
240          *   granularity.  Use "cgroup.procs" instead.
241          *
242          * - "cgroup.procs" is not sorted.  pids will be unique unless they
243          *   got recycled inbetween reads.
244          *
245          * - "release_agent" and "notify_on_release" are removed.
246          *   Replacement notification mechanism will be implemented.
247          *
248          * - "cgroup.clone_children" is removed.
249          *
250          * - cpuset: tasks will be kept in empty cpusets when hotplug happens
251          *   and take masks of ancestors with non-empty cpus/mems, instead of
252          *   being moved to an ancestor.
253          *
254          * - cpuset: a task can be moved into an empty cpuset, and again it
255          *   takes masks of ancestors.
256          *
257          * - memcg: use_hierarchy is on by default and the cgroup file for
258          *   the flag is not created.
259          *
260          * - blkcg: blk-throttle becomes properly hierarchical.
261          */
262         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
263
264         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
265         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
266
267         /* mount options live below bit 16 */
268         CGRP_ROOT_OPTION_MASK   = (1 << 16) - 1,
269 };
270
271 /*
272  * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
273  * associated with a kernfs_root to form an active hierarchy.  This is
274  * internal to cgroup core.  Don't access directly from controllers.
275  */
276 struct cgroupfs_root {
277         struct kernfs_root *kf_root;
278
279         /* The bitmask of subsystems attached to this hierarchy */
280         unsigned long subsys_mask;
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          * List running through all tasks using this cgroup
328          * group. Protected by css_set_lock
329          */
330         struct list_head tasks;
331
332         /*
333          * List of cgrp_cset_links pointing at cgroups referenced from this
334          * css_set.  Protected by css_set_lock.
335          */
336         struct list_head cgrp_links;
337
338         /*
339          * Set of subsystem states, one for each subsystem. This array is
340          * immutable after creation apart from the init_css_set during
341          * subsystem registration (at boot time).
342          */
343         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
344
345         /* For RCU-protected deletion */
346         struct rcu_head rcu_head;
347 };
348
349 /*
350  * struct cftype: handler definitions for cgroup control files
351  *
352  * When reading/writing to a file:
353  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
354  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
355  */
356
357 /* cftype->flags */
358 enum {
359         CFTYPE_ONLY_ON_ROOT     = (1 << 0),     /* only create on root cgrp */
360         CFTYPE_NOT_ON_ROOT      = (1 << 1),     /* don't create on root cgrp */
361         CFTYPE_INSANE           = (1 << 2),     /* don't create if sane_behavior */
362         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
363 };
364
365 #define MAX_CFTYPE_NAME         64
366
367 struct cftype {
368         /*
369          * By convention, the name should begin with the name of the
370          * subsystem, followed by a period.  Zero length string indicates
371          * end of cftype array.
372          */
373         char name[MAX_CFTYPE_NAME];
374         int private;
375         /*
376          * If not 0, file mode is set to this value, otherwise it will
377          * be figured out automatically
378          */
379         umode_t mode;
380
381         /*
382          * The maximum length of string, excluding trailing nul, that can
383          * be passed to write_string.  If < PAGE_SIZE-1, PAGE_SIZE-1 is
384          * assumed.
385          */
386         size_t max_write_len;
387
388         /* CFTYPE_* flags */
389         unsigned int flags;
390
391         /*
392          * Fields used for internal bookkeeping.  Initialized automatically
393          * during registration.
394          */
395         struct cgroup_subsys *ss;       /* NULL for cgroup core files */
396         struct list_head node;          /* anchored at ss->cfts */
397         struct kernfs_ops *kf_ops;
398
399         /*
400          * read_u64() is a shortcut for the common case of returning a
401          * single integer. Use it in place of read()
402          */
403         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
404         /*
405          * read_s64() is a signed version of read_u64()
406          */
407         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
408
409         /* generic seq_file read interface */
410         int (*seq_show)(struct seq_file *sf, void *v);
411
412         /* optional ops, implement all or none */
413         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
414         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
415         void (*seq_stop)(struct seq_file *sf, void *v);
416
417         /*
418          * write_u64() is a shortcut for the common case of accepting
419          * a single integer (as parsed by simple_strtoull) from
420          * userspace. Use in place of write(); return 0 or error.
421          */
422         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
423                          u64 val);
424         /*
425          * write_s64() is a signed version of write_u64()
426          */
427         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
428                          s64 val);
429
430         /*
431          * write_string() is passed a nul-terminated kernelspace
432          * buffer of maximum length determined by max_write_len.
433          * Returns 0 or -ve error code.
434          */
435         int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
436                             const char *buffer);
437         /*
438          * trigger() callback can be used to get some kick from the
439          * userspace, when the actual string written is not important
440          * at all. The private field can be used to determine the
441          * kick type for multiplexing.
442          */
443         int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
444
445 #ifdef CONFIG_DEBUG_LOCK_ALLOC
446         struct lock_class_key   lockdep_key;
447 #endif
448 };
449
450 /*
451  * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
452  * function can be called as long as @cgrp is accessible.
453  */
454 static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
455 {
456         return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
457 }
458
459 /* no synchronization, the result can only be used as a hint */
460 static inline bool cgroup_has_tasks(struct cgroup *cgrp)
461 {
462         return !list_empty(&cgrp->cset_links);
463 }
464
465 /* returns ino associated with a cgroup, 0 indicates unmounted root */
466 static inline ino_t cgroup_ino(struct cgroup *cgrp)
467 {
468         if (cgrp->kn)
469                 return cgrp->kn->ino;
470         else
471                 return 0;
472 }
473
474 static inline struct cftype *seq_cft(struct seq_file *seq)
475 {
476         struct kernfs_open_file *of = seq->private;
477
478         return of->kn->priv;
479 }
480
481 struct cgroup_subsys_state *seq_css(struct seq_file *seq);
482
483 /*
484  * Name / path handling functions.  All are thin wrappers around the kernfs
485  * counterparts and can be called under any context.
486  */
487
488 static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
489 {
490         /* dummy_top doesn't have a kn associated */
491         if (cgrp->kn)
492                 return kernfs_name(cgrp->kn, buf, buflen);
493         else
494                 return strlcpy(buf, "/", buflen);
495 }
496
497 static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
498                                               size_t buflen)
499 {
500         /* dummy_top doesn't have a kn associated */
501         if (cgrp->kn)
502                 return kernfs_path(cgrp->kn, buf, buflen);
503         strlcpy(buf, "/", buflen);
504         return (buflen <= 2) ? NULL : buf;
505 }
506
507 static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
508 {
509         /* dummy_top doesn't have a kn associated */
510         if (cgrp->kn)
511                 pr_cont_kernfs_name(cgrp->kn);
512         else
513                 pr_cont("/");
514 }
515
516 static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
517 {
518         /* dummy_top doesn't have a kn associated */
519         if (cgrp->kn)
520                 pr_cont_kernfs_path(cgrp->kn);
521         else
522                 pr_cont("/");
523 }
524
525 char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
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 /*
533  * Control Group taskset, used to pass around set of tasks to cgroup_subsys
534  * methods.
535  */
536 struct cgroup_taskset;
537 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
538 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
539
540 /**
541  * cgroup_taskset_for_each - iterate cgroup_taskset
542  * @task: the loop cursor
543  * @tset: taskset to iterate
544  */
545 #define cgroup_taskset_for_each(task, tset)                             \
546         for ((task) = cgroup_taskset_first((tset)); (task);             \
547              (task) = cgroup_taskset_next((tset)))
548
549 /*
550  * Control Group subsystem type.
551  * See Documentation/cgroups/cgroups.txt for details
552  */
553
554 struct cgroup_subsys {
555         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
556         int (*css_online)(struct cgroup_subsys_state *css);
557         void (*css_offline)(struct cgroup_subsys_state *css);
558         void (*css_free)(struct cgroup_subsys_state *css);
559
560         int (*can_attach)(struct cgroup_subsys_state *css,
561                           struct cgroup_taskset *tset);
562         void (*cancel_attach)(struct cgroup_subsys_state *css,
563                               struct cgroup_taskset *tset);
564         void (*attach)(struct cgroup_subsys_state *css,
565                        struct cgroup_taskset *tset);
566         void (*fork)(struct task_struct *task);
567         void (*exit)(struct cgroup_subsys_state *css,
568                      struct cgroup_subsys_state *old_css,
569                      struct task_struct *task);
570         void (*bind)(struct cgroup_subsys_state *root_css);
571
572         int disabled;
573         int early_init;
574
575         /*
576          * If %false, this subsystem is properly hierarchical -
577          * configuration, resource accounting and restriction on a parent
578          * cgroup cover those of its children.  If %true, hierarchy support
579          * is broken in some ways - some subsystems ignore hierarchy
580          * completely while others are only implemented half-way.
581          *
582          * It's now disallowed to create nested cgroups if the subsystem is
583          * broken and cgroup core will emit a warning message on such
584          * cases.  Eventually, all subsystems will be made properly
585          * hierarchical and this will go away.
586          */
587         bool broken_hierarchy;
588         bool warned_broken_hierarchy;
589
590         /* the following two fields are initialized automtically during boot */
591         int id;
592 #define MAX_CGROUP_TYPE_NAMELEN 32
593         const char *name;
594
595         /* link to parent, protected by cgroup_lock() */
596         struct cgroupfs_root *root;
597
598         /*
599          * List of cftypes.  Each entry is the first entry of an array
600          * terminated by zero length name.
601          */
602         struct list_head cfts;
603
604         /* base cftypes, automatically registered with subsys itself */
605         struct cftype *base_cftypes;
606 };
607
608 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
609 #include <linux/cgroup_subsys.h>
610 #undef SUBSYS
611
612 /**
613  * css_parent - find the parent css
614  * @css: the target cgroup_subsys_state
615  *
616  * Return the parent css of @css.  This function is guaranteed to return
617  * non-NULL parent as long as @css isn't the root.
618  */
619 static inline
620 struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
621 {
622         return css->parent;
623 }
624
625 /**
626  * task_css_set_check - obtain a task's css_set with extra access conditions
627  * @task: the task to obtain css_set for
628  * @__c: extra condition expression to be passed to rcu_dereference_check()
629  *
630  * A task's css_set is RCU protected, initialized and exited while holding
631  * task_lock(), and can only be modified while holding both cgroup_mutex
632  * and task_lock() while the task is alive.  This macro verifies that the
633  * caller is inside proper critical section and returns @task's css_set.
634  *
635  * The caller can also specify additional allowed conditions via @__c, such
636  * as locks used during the cgroup_subsys::attach() methods.
637  */
638 #ifdef CONFIG_PROVE_RCU
639 extern struct mutex cgroup_mutex;
640 #define task_css_set_check(task, __c)                                   \
641         rcu_dereference_check((task)->cgroups,                          \
642                 lockdep_is_held(&(task)->alloc_lock) ||                 \
643                 lockdep_is_held(&cgroup_mutex) || (__c))
644 #else
645 #define task_css_set_check(task, __c)                                   \
646         rcu_dereference((task)->cgroups)
647 #endif
648
649 /**
650  * task_css_check - obtain css for (task, subsys) w/ extra access conds
651  * @task: the target task
652  * @subsys_id: the target subsystem ID
653  * @__c: extra condition expression to be passed to rcu_dereference_check()
654  *
655  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
656  * synchronization rules are the same as task_css_set_check().
657  */
658 #define task_css_check(task, subsys_id, __c)                            \
659         task_css_set_check((task), (__c))->subsys[(subsys_id)]
660
661 /**
662  * task_css_set - obtain a task's css_set
663  * @task: the task to obtain css_set for
664  *
665  * See task_css_set_check().
666  */
667 static inline struct css_set *task_css_set(struct task_struct *task)
668 {
669         return task_css_set_check(task, false);
670 }
671
672 /**
673  * task_css - obtain css for (task, subsys)
674  * @task: the target task
675  * @subsys_id: the target subsystem ID
676  *
677  * See task_css_check().
678  */
679 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
680                                                    int subsys_id)
681 {
682         return task_css_check(task, subsys_id, false);
683 }
684
685 static inline struct cgroup *task_cgroup(struct task_struct *task,
686                                          int subsys_id)
687 {
688         return task_css(task, subsys_id)->cgroup;
689 }
690
691 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
692                                            struct cgroup_subsys_state *parent);
693
694 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
695
696 /**
697  * css_for_each_child - iterate through children of a css
698  * @pos: the css * to use as the loop cursor
699  * @parent: css whose children to walk
700  *
701  * Walk @parent's children.  Must be called under rcu_read_lock().  A child
702  * css which hasn't finished ->css_online() or already has finished
703  * ->css_offline() may show up during traversal and it's each subsystem's
704  * responsibility to verify that each @pos is alive.
705  *
706  * If a subsystem synchronizes against the parent in its ->css_online() and
707  * before starting iterating, a css which finished ->css_online() is
708  * guaranteed to be visible in the future iterations.
709  *
710  * It is allowed to temporarily drop RCU read lock during iteration.  The
711  * caller is responsible for ensuring that @pos remains accessible until
712  * the start of the next iteration by, for example, bumping the css refcnt.
713  */
714 #define css_for_each_child(pos, parent)                                 \
715         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
716              (pos) = css_next_child((pos), (parent)))
717
718 struct cgroup_subsys_state *
719 css_next_descendant_pre(struct cgroup_subsys_state *pos,
720                         struct cgroup_subsys_state *css);
721
722 struct cgroup_subsys_state *
723 css_rightmost_descendant(struct cgroup_subsys_state *pos);
724
725 /**
726  * css_for_each_descendant_pre - pre-order walk of a css's descendants
727  * @pos: the css * to use as the loop cursor
728  * @root: css whose descendants to walk
729  *
730  * Walk @root's descendants.  @root is included in the iteration and the
731  * first node to be visited.  Must be called under rcu_read_lock().  A
732  * descendant css which hasn't finished ->css_online() or already has
733  * finished ->css_offline() may show up during traversal and it's each
734  * subsystem's responsibility to verify that each @pos is alive.
735  *
736  * If a subsystem synchronizes against the parent in its ->css_online() and
737  * before starting iterating, and synchronizes against @pos on each
738  * iteration, any descendant css which finished ->css_online() is
739  * guaranteed to be visible in the future iterations.
740  *
741  * In other words, the following guarantees that a descendant can't escape
742  * state updates of its ancestors.
743  *
744  * my_online(@css)
745  * {
746  *      Lock @css's parent and @css;
747  *      Inherit state from the parent;
748  *      Unlock both.
749  * }
750  *
751  * my_update_state(@css)
752  * {
753  *      css_for_each_descendant_pre(@pos, @css) {
754  *              Lock @pos;
755  *              if (@pos == @css)
756  *                      Update @css's state;
757  *              else
758  *                      Verify @pos is alive and inherit state from its parent;
759  *              Unlock @pos;
760  *      }
761  * }
762  *
763  * As long as the inheriting step, including checking the parent state, is
764  * enclosed inside @pos locking, double-locking the parent isn't necessary
765  * while inheriting.  The state update to the parent is guaranteed to be
766  * visible by walking order and, as long as inheriting operations to the
767  * same @pos are atomic to each other, multiple updates racing each other
768  * still result in the correct state.  It's guaranateed that at least one
769  * inheritance happens for any css after the latest update to its parent.
770  *
771  * If checking parent's state requires locking the parent, each inheriting
772  * iteration should lock and unlock both @pos->parent and @pos.
773  *
774  * Alternatively, a subsystem may choose to use a single global lock to
775  * synchronize ->css_online() and ->css_offline() against tree-walking
776  * operations.
777  *
778  * It is allowed to temporarily drop RCU read lock during iteration.  The
779  * caller is responsible for ensuring that @pos remains accessible until
780  * the start of the next iteration by, for example, bumping the css refcnt.
781  */
782 #define css_for_each_descendant_pre(pos, css)                           \
783         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
784              (pos) = css_next_descendant_pre((pos), (css)))
785
786 struct cgroup_subsys_state *
787 css_next_descendant_post(struct cgroup_subsys_state *pos,
788                          struct cgroup_subsys_state *css);
789
790 /**
791  * css_for_each_descendant_post - post-order walk of a css's descendants
792  * @pos: the css * to use as the loop cursor
793  * @css: css whose descendants to walk
794  *
795  * Similar to css_for_each_descendant_pre() but performs post-order
796  * traversal instead.  @root is included in the iteration and the last
797  * node to be visited.  Note that the walk visibility guarantee described
798  * in pre-order walk doesn't apply the same to post-order walks.
799  */
800 #define css_for_each_descendant_post(pos, css)                          \
801         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
802              (pos) = css_next_descendant_post((pos), (css)))
803
804 /* A css_task_iter should be treated as an opaque object */
805 struct css_task_iter {
806         struct cgroup_subsys_state      *origin_css;
807         struct list_head                *cset_link;
808         struct list_head                *task;
809 };
810
811 void css_task_iter_start(struct cgroup_subsys_state *css,
812                          struct css_task_iter *it);
813 struct task_struct *css_task_iter_next(struct css_task_iter *it);
814 void css_task_iter_end(struct css_task_iter *it);
815
816 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
817 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
818
819 struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
820                                                 struct cgroup_subsys *ss);
821
822 #else /* !CONFIG_CGROUPS */
823
824 static inline int cgroup_init_early(void) { return 0; }
825 static inline int cgroup_init(void) { return 0; }
826 static inline void cgroup_fork(struct task_struct *p) {}
827 static inline void cgroup_post_fork(struct task_struct *p) {}
828 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
829
830 static inline int cgroupstats_build(struct cgroupstats *stats,
831                                         struct dentry *dentry)
832 {
833         return -EINVAL;
834 }
835
836 /* No cgroups - nothing to do */
837 static inline int cgroup_attach_task_all(struct task_struct *from,
838                                          struct task_struct *t)
839 {
840         return 0;
841 }
842
843 #endif /* !CONFIG_CGROUPS */
844
845 #endif /* _LINUX_CGROUP_H */