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