]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/linux/cgroup.h
iommu/exynos: Fix checkpatch warning
[karo-tx-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/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 cgroup_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);
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 cgroup_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 /* cgroup_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          * - If mount is requested with sane_behavior but without any
254          *   subsystem, the default unified hierarchy is mounted.
255          *
256          * - cpuset: tasks will be kept in empty cpusets when hotplug happens
257          *   and take masks of ancestors with non-empty cpus/mems, instead of
258          *   being moved to an ancestor.
259          *
260          * - cpuset: a task can be moved into an empty cpuset, and again it
261          *   takes masks of ancestors.
262          *
263          * - memcg: use_hierarchy is on by default and the cgroup file for
264          *   the flag is not created.
265          *
266          * - blkcg: blk-throttle becomes properly hierarchical.
267          */
268         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
269
270         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
271         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
272
273         /* mount options live below bit 16 */
274         CGRP_ROOT_OPTION_MASK   = (1 << 16) - 1,
275 };
276
277 /*
278  * A cgroup_root represents the root of a cgroup hierarchy, and may be
279  * associated with a kernfs_root to form an active hierarchy.  This is
280  * internal to cgroup core.  Don't access directly from controllers.
281  */
282 struct cgroup_root {
283         struct kernfs_root *kf_root;
284
285         /* Unique id for this hierarchy. */
286         int hierarchy_id;
287
288         /* The root cgroup.  Root is destroyed on its release. */
289         struct cgroup cgrp;
290
291         /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
292         atomic_t nr_cgrps;
293
294         /* A list running through the active hierarchies */
295         struct list_head root_list;
296
297         /* Hierarchy-specific flags */
298         unsigned long flags;
299
300         /* IDs for cgroups in this hierarchy */
301         struct idr cgroup_idr;
302
303         /* The path to use for release notifications. */
304         char release_agent_path[PATH_MAX];
305
306         /* The name for this hierarchy - may be empty */
307         char name[MAX_CGROUP_ROOT_NAMELEN];
308 };
309
310 /*
311  * A css_set is a structure holding pointers to a set of
312  * cgroup_subsys_state objects. This saves space in the task struct
313  * object and speeds up fork()/exit(), since a single inc/dec and a
314  * list_add()/del() can bump the reference count on the entire cgroup
315  * set for a task.
316  */
317
318 struct css_set {
319
320         /* Reference count */
321         atomic_t refcount;
322
323         /*
324          * List running through all cgroup groups in the same hash
325          * slot. Protected by css_set_lock
326          */
327         struct hlist_node hlist;
328
329         /*
330          * Lists running through all tasks using this cgroup group.
331          * mg_tasks lists tasks which belong to this cset but are in the
332          * process of being migrated out or in.  Protected by
333          * css_set_rwsem, but, during migration, once tasks are moved to
334          * mg_tasks, it can be read safely while holding cgroup_mutex.
335          */
336         struct list_head tasks;
337         struct list_head mg_tasks;
338
339         /*
340          * List of cgrp_cset_links pointing at cgroups referenced from this
341          * css_set.  Protected by css_set_lock.
342          */
343         struct list_head cgrp_links;
344
345         /*
346          * Set of subsystem states, one for each subsystem. This array is
347          * immutable after creation apart from the init_css_set during
348          * subsystem registration (at boot time).
349          */
350         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
351
352         /*
353          * List of csets participating in the on-going migration either as
354          * source or destination.  Protected by cgroup_mutex.
355          */
356         struct list_head mg_preload_node;
357         struct list_head mg_node;
358
359         /*
360          * If this cset is acting as the source of migration the following
361          * two fields are set.  mg_src_cgrp is the source cgroup of the
362          * on-going migration and mg_dst_cset is the destination cset the
363          * target tasks on this cset should be migrated to.  Protected by
364          * cgroup_mutex.
365          */
366         struct cgroup *mg_src_cgrp;
367         struct css_set *mg_dst_cset;
368
369         /* For RCU-protected deletion */
370         struct rcu_head rcu_head;
371 };
372
373 /*
374  * struct cftype: handler definitions for cgroup control files
375  *
376  * When reading/writing to a file:
377  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
378  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
379  */
380
381 /* cftype->flags */
382 enum {
383         CFTYPE_ONLY_ON_ROOT     = (1 << 0),     /* only create on root cgrp */
384         CFTYPE_NOT_ON_ROOT      = (1 << 1),     /* don't create on root cgrp */
385         CFTYPE_INSANE           = (1 << 2),     /* don't create if sane_behavior */
386         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
387         CFTYPE_ONLY_ON_DFL      = (1 << 4),     /* only on default hierarchy */
388 };
389
390 #define MAX_CFTYPE_NAME         64
391
392 struct cftype {
393         /*
394          * By convention, the name should begin with the name of the
395          * subsystem, followed by a period.  Zero length string indicates
396          * end of cftype array.
397          */
398         char name[MAX_CFTYPE_NAME];
399         int private;
400         /*
401          * If not 0, file mode is set to this value, otherwise it will
402          * be figured out automatically
403          */
404         umode_t mode;
405
406         /*
407          * The maximum length of string, excluding trailing nul, that can
408          * be passed to write_string.  If < PAGE_SIZE-1, PAGE_SIZE-1 is
409          * assumed.
410          */
411         size_t max_write_len;
412
413         /* CFTYPE_* flags */
414         unsigned int flags;
415
416         /*
417          * Fields used for internal bookkeeping.  Initialized automatically
418          * during registration.
419          */
420         struct cgroup_subsys *ss;       /* NULL for cgroup core files */
421         struct list_head node;          /* anchored at ss->cfts */
422         struct kernfs_ops *kf_ops;
423
424         /*
425          * read_u64() is a shortcut for the common case of returning a
426          * single integer. Use it in place of read()
427          */
428         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
429         /*
430          * read_s64() is a signed version of read_u64()
431          */
432         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
433
434         /* generic seq_file read interface */
435         int (*seq_show)(struct seq_file *sf, void *v);
436
437         /* optional ops, implement all or none */
438         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
439         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
440         void (*seq_stop)(struct seq_file *sf, void *v);
441
442         /*
443          * write_u64() is a shortcut for the common case of accepting
444          * a single integer (as parsed by simple_strtoull) from
445          * userspace. Use in place of write(); return 0 or error.
446          */
447         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
448                          u64 val);
449         /*
450          * write_s64() is a signed version of write_u64()
451          */
452         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
453                          s64 val);
454
455         /*
456          * write_string() is passed a nul-terminated kernelspace
457          * buffer of maximum length determined by max_write_len.
458          * Returns 0 or -ve error code.
459          */
460         int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
461                             char *buffer);
462         /*
463          * trigger() callback can be used to get some kick from the
464          * userspace, when the actual string written is not important
465          * at all. The private field can be used to determine the
466          * kick type for multiplexing.
467          */
468         int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
469
470 #ifdef CONFIG_DEBUG_LOCK_ALLOC
471         struct lock_class_key   lockdep_key;
472 #endif
473 };
474
475 extern struct cgroup_root cgrp_dfl_root;
476
477 static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
478 {
479         return cgrp->root == &cgrp_dfl_root;
480 }
481
482 /*
483  * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
484  * function can be called as long as @cgrp is accessible.
485  */
486 static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
487 {
488         return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
489 }
490
491 /* no synchronization, the result can only be used as a hint */
492 static inline bool cgroup_has_tasks(struct cgroup *cgrp)
493 {
494         return !list_empty(&cgrp->cset_links);
495 }
496
497 /* returns ino associated with a cgroup, 0 indicates unmounted root */
498 static inline ino_t cgroup_ino(struct cgroup *cgrp)
499 {
500         if (cgrp->kn)
501                 return cgrp->kn->ino;
502         else
503                 return 0;
504 }
505
506 static inline struct cftype *seq_cft(struct seq_file *seq)
507 {
508         struct kernfs_open_file *of = seq->private;
509
510         return of->kn->priv;
511 }
512
513 struct cgroup_subsys_state *seq_css(struct seq_file *seq);
514
515 /*
516  * Name / path handling functions.  All are thin wrappers around the kernfs
517  * counterparts and can be called under any context.
518  */
519
520 static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
521 {
522         return kernfs_name(cgrp->kn, buf, buflen);
523 }
524
525 static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
526                                               size_t buflen)
527 {
528         return kernfs_path(cgrp->kn, buf, buflen);
529 }
530
531 static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
532 {
533         pr_cont_kernfs_name(cgrp->kn);
534 }
535
536 static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
537 {
538         pr_cont_kernfs_path(cgrp->kn);
539 }
540
541 char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
542
543 int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
544 int cgroup_rm_cftypes(struct cftype *cfts);
545
546 bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
547
548 /*
549  * Control Group taskset, used to pass around set of tasks to cgroup_subsys
550  * methods.
551  */
552 struct cgroup_taskset;
553 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
554 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
555
556 /**
557  * cgroup_taskset_for_each - iterate cgroup_taskset
558  * @task: the loop cursor
559  * @tset: taskset to iterate
560  */
561 #define cgroup_taskset_for_each(task, tset)                             \
562         for ((task) = cgroup_taskset_first((tset)); (task);             \
563              (task) = cgroup_taskset_next((tset)))
564
565 /*
566  * Control Group subsystem type.
567  * See Documentation/cgroups/cgroups.txt for details
568  */
569
570 struct cgroup_subsys {
571         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
572         int (*css_online)(struct cgroup_subsys_state *css);
573         void (*css_offline)(struct cgroup_subsys_state *css);
574         void (*css_free)(struct cgroup_subsys_state *css);
575
576         int (*can_attach)(struct cgroup_subsys_state *css,
577                           struct cgroup_taskset *tset);
578         void (*cancel_attach)(struct cgroup_subsys_state *css,
579                               struct cgroup_taskset *tset);
580         void (*attach)(struct cgroup_subsys_state *css,
581                        struct cgroup_taskset *tset);
582         void (*fork)(struct task_struct *task);
583         void (*exit)(struct cgroup_subsys_state *css,
584                      struct cgroup_subsys_state *old_css,
585                      struct task_struct *task);
586         void (*bind)(struct cgroup_subsys_state *root_css);
587
588         int disabled;
589         int early_init;
590
591         /*
592          * If %false, this subsystem is properly hierarchical -
593          * configuration, resource accounting and restriction on a parent
594          * cgroup cover those of its children.  If %true, hierarchy support
595          * is broken in some ways - some subsystems ignore hierarchy
596          * completely while others are only implemented half-way.
597          *
598          * It's now disallowed to create nested cgroups if the subsystem is
599          * broken and cgroup core will emit a warning message on such
600          * cases.  Eventually, all subsystems will be made properly
601          * hierarchical and this will go away.
602          */
603         bool broken_hierarchy;
604         bool warned_broken_hierarchy;
605
606         /* the following two fields are initialized automtically during boot */
607         int id;
608 #define MAX_CGROUP_TYPE_NAMELEN 32
609         const char *name;
610
611         /* link to parent, protected by cgroup_lock() */
612         struct cgroup_root *root;
613
614         /*
615          * List of cftypes.  Each entry is the first entry of an array
616          * terminated by zero length name.
617          */
618         struct list_head cfts;
619
620         /* base cftypes, automatically registered with subsys itself */
621         struct cftype *base_cftypes;
622 };
623
624 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
625 #include <linux/cgroup_subsys.h>
626 #undef SUBSYS
627
628 /**
629  * css_parent - find the parent css
630  * @css: the target cgroup_subsys_state
631  *
632  * Return the parent css of @css.  This function is guaranteed to return
633  * non-NULL parent as long as @css isn't the root.
634  */
635 static inline
636 struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
637 {
638         return css->parent;
639 }
640
641 /**
642  * task_css_set_check - obtain a task's css_set with extra access conditions
643  * @task: the task to obtain css_set for
644  * @__c: extra condition expression to be passed to rcu_dereference_check()
645  *
646  * A task's css_set is RCU protected, initialized and exited while holding
647  * task_lock(), and can only be modified while holding both cgroup_mutex
648  * and task_lock() while the task is alive.  This macro verifies that the
649  * caller is inside proper critical section and returns @task's css_set.
650  *
651  * The caller can also specify additional allowed conditions via @__c, such
652  * as locks used during the cgroup_subsys::attach() methods.
653  */
654 #ifdef CONFIG_PROVE_RCU
655 extern struct mutex cgroup_mutex;
656 extern struct rw_semaphore css_set_rwsem;
657 #define task_css_set_check(task, __c)                                   \
658         rcu_dereference_check((task)->cgroups,                          \
659                 lockdep_is_held(&cgroup_mutex) ||                       \
660                 lockdep_is_held(&css_set_rwsem) ||                      \
661                 ((task)->flags & PF_EXITING) || (__c))
662 #else
663 #define task_css_set_check(task, __c)                                   \
664         rcu_dereference((task)->cgroups)
665 #endif
666
667 /**
668  * task_css_check - obtain css for (task, subsys) w/ extra access conds
669  * @task: the target task
670  * @subsys_id: the target subsystem ID
671  * @__c: extra condition expression to be passed to rcu_dereference_check()
672  *
673  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
674  * synchronization rules are the same as task_css_set_check().
675  */
676 #define task_css_check(task, subsys_id, __c)                            \
677         task_css_set_check((task), (__c))->subsys[(subsys_id)]
678
679 /**
680  * task_css_set - obtain a task's css_set
681  * @task: the task to obtain css_set for
682  *
683  * See task_css_set_check().
684  */
685 static inline struct css_set *task_css_set(struct task_struct *task)
686 {
687         return task_css_set_check(task, false);
688 }
689
690 /**
691  * task_css - obtain css for (task, subsys)
692  * @task: the target task
693  * @subsys_id: the target subsystem ID
694  *
695  * See task_css_check().
696  */
697 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
698                                                    int subsys_id)
699 {
700         return task_css_check(task, subsys_id, false);
701 }
702
703 static inline struct cgroup *task_cgroup(struct task_struct *task,
704                                          int subsys_id)
705 {
706         return task_css(task, subsys_id)->cgroup;
707 }
708
709 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
710                                            struct cgroup_subsys_state *parent);
711
712 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
713
714 /**
715  * css_for_each_child - iterate through children of a css
716  * @pos: the css * to use as the loop cursor
717  * @parent: css whose children to walk
718  *
719  * Walk @parent's children.  Must be called under rcu_read_lock().  A child
720  * css which hasn't finished ->css_online() or already has finished
721  * ->css_offline() may show up during traversal and it's each subsystem's
722  * responsibility to verify that each @pos is alive.
723  *
724  * If a subsystem synchronizes against the parent in its ->css_online() and
725  * before starting iterating, a css which finished ->css_online() is
726  * guaranteed to be visible in the future iterations.
727  *
728  * It is allowed to temporarily drop RCU read lock during iteration.  The
729  * caller is responsible for ensuring that @pos remains accessible until
730  * the start of the next iteration by, for example, bumping the css refcnt.
731  */
732 #define css_for_each_child(pos, parent)                                 \
733         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
734              (pos) = css_next_child((pos), (parent)))
735
736 struct cgroup_subsys_state *
737 css_next_descendant_pre(struct cgroup_subsys_state *pos,
738                         struct cgroup_subsys_state *css);
739
740 struct cgroup_subsys_state *
741 css_rightmost_descendant(struct cgroup_subsys_state *pos);
742
743 /**
744  * css_for_each_descendant_pre - pre-order walk of a css's descendants
745  * @pos: the css * to use as the loop cursor
746  * @root: css whose descendants to walk
747  *
748  * Walk @root's descendants.  @root is included in the iteration and the
749  * first node to be visited.  Must be called under rcu_read_lock().  A
750  * descendant css which hasn't finished ->css_online() or already has
751  * finished ->css_offline() may show up during traversal and it's each
752  * subsystem's responsibility to verify that each @pos is alive.
753  *
754  * If a subsystem synchronizes against the parent in its ->css_online() and
755  * before starting iterating, and synchronizes against @pos on each
756  * iteration, any descendant css which finished ->css_online() is
757  * guaranteed to be visible in the future iterations.
758  *
759  * In other words, the following guarantees that a descendant can't escape
760  * state updates of its ancestors.
761  *
762  * my_online(@css)
763  * {
764  *      Lock @css's parent and @css;
765  *      Inherit state from the parent;
766  *      Unlock both.
767  * }
768  *
769  * my_update_state(@css)
770  * {
771  *      css_for_each_descendant_pre(@pos, @css) {
772  *              Lock @pos;
773  *              if (@pos == @css)
774  *                      Update @css's state;
775  *              else
776  *                      Verify @pos is alive and inherit state from its parent;
777  *              Unlock @pos;
778  *      }
779  * }
780  *
781  * As long as the inheriting step, including checking the parent state, is
782  * enclosed inside @pos locking, double-locking the parent isn't necessary
783  * while inheriting.  The state update to the parent is guaranteed to be
784  * visible by walking order and, as long as inheriting operations to the
785  * same @pos are atomic to each other, multiple updates racing each other
786  * still result in the correct state.  It's guaranateed that at least one
787  * inheritance happens for any css after the latest update to its parent.
788  *
789  * If checking parent's state requires locking the parent, each inheriting
790  * iteration should lock and unlock both @pos->parent and @pos.
791  *
792  * Alternatively, a subsystem may choose to use a single global lock to
793  * synchronize ->css_online() and ->css_offline() against tree-walking
794  * operations.
795  *
796  * It is allowed to temporarily drop RCU read lock during iteration.  The
797  * caller is responsible for ensuring that @pos remains accessible until
798  * the start of the next iteration by, for example, bumping the css refcnt.
799  */
800 #define css_for_each_descendant_pre(pos, css)                           \
801         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
802              (pos) = css_next_descendant_pre((pos), (css)))
803
804 struct cgroup_subsys_state *
805 css_next_descendant_post(struct cgroup_subsys_state *pos,
806                          struct cgroup_subsys_state *css);
807
808 /**
809  * css_for_each_descendant_post - post-order walk of a css's descendants
810  * @pos: the css * to use as the loop cursor
811  * @css: css whose descendants to walk
812  *
813  * Similar to css_for_each_descendant_pre() but performs post-order
814  * traversal instead.  @root is included in the iteration and the last
815  * node to be visited.  Note that the walk visibility guarantee described
816  * in pre-order walk doesn't apply the same to post-order walks.
817  */
818 #define css_for_each_descendant_post(pos, css)                          \
819         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
820              (pos) = css_next_descendant_post((pos), (css)))
821
822 /* A css_task_iter should be treated as an opaque object */
823 struct css_task_iter {
824         struct cgroup_subsys_state      *origin_css;
825         struct list_head                *cset_link;
826         struct list_head                *task;
827 };
828
829 void css_task_iter_start(struct cgroup_subsys_state *css,
830                          struct css_task_iter *it);
831 struct task_struct *css_task_iter_next(struct css_task_iter *it);
832 void css_task_iter_end(struct css_task_iter *it);
833
834 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
835 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
836
837 struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
838                                                 struct cgroup_subsys *ss);
839
840 #else /* !CONFIG_CGROUPS */
841
842 static inline int cgroup_init_early(void) { return 0; }
843 static inline int cgroup_init(void) { return 0; }
844 static inline void cgroup_fork(struct task_struct *p) {}
845 static inline void cgroup_post_fork(struct task_struct *p) {}
846 static inline void cgroup_exit(struct task_struct *p) {}
847
848 static inline int cgroupstats_build(struct cgroupstats *stats,
849                                         struct dentry *dentry)
850 {
851         return -EINVAL;
852 }
853
854 /* No cgroups - nothing to do */
855 static inline int cgroup_attach_task_all(struct task_struct *from,
856                                          struct task_struct *t)
857 {
858         return 0;
859 }
860
861 #endif /* !CONFIG_CGROUPS */
862
863 #endif /* _LINUX_CGROUP_H */