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