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