cgroup: avoid accessing modular cgroup subsys structure without locking
[firefly-linux-kernel-4.4.55.git] / include / linux / cgroup.h
1 #ifndef _LINUX_CGROUP_H
2 #define _LINUX_CGROUP_H
3 /*
4  *  cgroup interface
5  *
6  *  Copyright (C) 2003 BULL SA
7  *  Copyright (C) 2004-2006 Silicon Graphics, Inc.
8  *
9  */
10
11 #include <linux/sched.h>
12 #include <linux/cpumask.h>
13 #include <linux/nodemask.h>
14 #include <linux/rcupdate.h>
15 #include <linux/rculist.h>
16 #include <linux/cgroupstats.h>
17 #include <linux/prio_heap.h>
18 #include <linux/rwsem.h>
19 #include <linux/idr.h>
20 #include <linux/workqueue.h>
21 #include <linux/xattr.h>
22
23 #ifdef CONFIG_CGROUPS
24
25 struct cgroupfs_root;
26 struct cgroup_subsys;
27 struct inode;
28 struct cgroup;
29 struct css_id;
30
31 extern int cgroup_init_early(void);
32 extern int cgroup_init(void);
33 extern void cgroup_lock(void);
34 extern int cgroup_lock_is_held(void);
35 extern bool cgroup_lock_live_group(struct cgroup *cgrp);
36 extern void cgroup_unlock(void);
37 extern void cgroup_fork(struct task_struct *p);
38 extern void cgroup_post_fork(struct task_struct *p);
39 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
40 extern int cgroupstats_build(struct cgroupstats *stats,
41                                 struct dentry *dentry);
42 extern int cgroup_load_subsys(struct cgroup_subsys *ss);
43 extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
44
45 extern const struct file_operations proc_cgroup_operations;
46
47 /*
48  * Define the enumeration of all cgroup subsystems.
49  *
50  * We define ids for builtin subsystems and then modular ones.
51  */
52 #define SUBSYS(_x) _x ## _subsys_id,
53 enum cgroup_subsys_id {
54 #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
55 #include <linux/cgroup_subsys.h>
56 #undef IS_SUBSYS_ENABLED
57         CGROUP_BUILTIN_SUBSYS_COUNT,
58
59         __CGROUP_SUBSYS_TEMP_PLACEHOLDER = CGROUP_BUILTIN_SUBSYS_COUNT - 1,
60
61 #define IS_SUBSYS_ENABLED(option) IS_MODULE(option)
62 #include <linux/cgroup_subsys.h>
63 #undef IS_SUBSYS_ENABLED
64         CGROUP_SUBSYS_COUNT,
65 };
66 #undef SUBSYS
67
68 /* Per-subsystem/per-cgroup state maintained by the system. */
69 struct cgroup_subsys_state {
70         /*
71          * The cgroup that this subsystem is attached to. Useful
72          * for subsystems that want to know about the cgroup
73          * hierarchy structure
74          */
75         struct cgroup *cgroup;
76
77         /*
78          * State maintained by the cgroup system to allow subsystems
79          * to be "busy". Should be accessed via css_get(),
80          * css_tryget() and css_put().
81          */
82
83         atomic_t refcnt;
84
85         unsigned long flags;
86         /* ID for this css, if possible */
87         struct css_id __rcu *id;
88
89         /* Used to put @cgroup->dentry on the last css_put() */
90         struct work_struct dput_work;
91 };
92
93 /* bits in struct cgroup_subsys_state flags field */
94 enum {
95         CSS_ROOT        = (1 << 0), /* this CSS is the root of the subsystem */
96         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
97 };
98
99 /* Caller must verify that the css is not for root cgroup */
100 static inline void __css_get(struct cgroup_subsys_state *css, int count)
101 {
102         atomic_add(count, &css->refcnt);
103 }
104
105 /*
106  * Call css_get() to hold a reference on the css; it can be used
107  * for a reference obtained via:
108  * - an existing ref-counted reference to the css
109  * - task->cgroups for a locked task
110  */
111
112 static inline void css_get(struct cgroup_subsys_state *css)
113 {
114         /* We don't need to reference count the root state */
115         if (!(css->flags & CSS_ROOT))
116                 __css_get(css, 1);
117 }
118
119 /*
120  * Call css_tryget() to take a reference on a css if your existing
121  * (known-valid) reference isn't already ref-counted. Returns false if
122  * the css has been destroyed.
123  */
124
125 extern bool __css_tryget(struct cgroup_subsys_state *css);
126 static inline bool css_tryget(struct cgroup_subsys_state *css)
127 {
128         if (css->flags & CSS_ROOT)
129                 return true;
130         return __css_tryget(css);
131 }
132
133 /*
134  * css_put() should be called to release a reference taken by
135  * css_get() or css_tryget()
136  */
137
138 extern void __css_put(struct cgroup_subsys_state *css);
139 static inline void css_put(struct cgroup_subsys_state *css)
140 {
141         if (!(css->flags & CSS_ROOT))
142                 __css_put(css);
143 }
144
145 /* bits in struct cgroup flags field */
146 enum {
147         /* Control Group is dead */
148         CGRP_REMOVED,
149         /*
150          * Control Group has previously had a child cgroup or a task,
151          * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
152          */
153         CGRP_RELEASABLE,
154         /* Control Group requires release notifications to userspace */
155         CGRP_NOTIFY_ON_RELEASE,
156         /*
157          * Clone the parent's configuration when creating a new child
158          * cpuset cgroup.  For historical reasons, this option can be
159          * specified at mount time and thus is implemented here.
160          */
161         CGRP_CPUSET_CLONE_CHILDREN,
162 };
163
164 struct cgroup_name {
165         struct rcu_head rcu_head;
166         char name[];
167 };
168
169 struct cgroup {
170         unsigned long flags;            /* "unsigned long" so bitops work */
171
172         /*
173          * count users of this cgroup. >0 means busy, but doesn't
174          * necessarily indicate the number of tasks in the cgroup
175          */
176         atomic_t count;
177
178         int id;                         /* ida allocated in-hierarchy ID */
179
180         /*
181          * We link our 'sibling' struct into our parent's 'children'.
182          * Our children link their 'sibling' into our 'children'.
183          */
184         struct list_head sibling;       /* my parent's children */
185         struct list_head children;      /* my children */
186         struct list_head files;         /* my files */
187
188         struct cgroup *parent;          /* my parent */
189         struct dentry *dentry;          /* cgroup fs entry, RCU protected */
190
191         /*
192          * This is a copy of dentry->d_name, and it's needed because
193          * we can't use dentry->d_name in cgroup_path().
194          *
195          * You must acquire rcu_read_lock() to access cgrp->name, and
196          * the only place that can change it is rename(), which is
197          * protected by parent dir's i_mutex.
198          *
199          * Normally you should use cgroup_name() wrapper rather than
200          * access it directly.
201          */
202         struct cgroup_name __rcu *name;
203
204         /* Private pointers for each registered subsystem */
205         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
206
207         struct cgroupfs_root *root;
208         struct cgroup *top_cgroup;
209
210         /*
211          * List of cg_cgroup_links pointing at css_sets with
212          * tasks in this cgroup. Protected by css_set_lock
213          */
214         struct list_head css_sets;
215
216         struct list_head allcg_node;    /* cgroupfs_root->allcg_list */
217         struct list_head cft_q_node;    /* used during cftype add/rm */
218
219         /*
220          * Linked list running through all cgroups that can
221          * potentially be reaped by the release agent. Protected by
222          * release_list_lock
223          */
224         struct list_head release_list;
225
226         /*
227          * list of pidlists, up to two for each namespace (one for procs, one
228          * for tasks); created on demand.
229          */
230         struct list_head pidlists;
231         struct mutex pidlist_mutex;
232
233         /* For RCU-protected deletion */
234         struct rcu_head rcu_head;
235         struct work_struct free_work;
236
237         /* List of events which userspace want to receive */
238         struct list_head event_list;
239         spinlock_t event_list_lock;
240
241         /* directory xattrs */
242         struct simple_xattrs xattrs;
243 };
244
245 /*
246  * A css_set is a structure holding pointers to a set of
247  * cgroup_subsys_state objects. This saves space in the task struct
248  * object and speeds up fork()/exit(), since a single inc/dec and a
249  * list_add()/del() can bump the reference count on the entire cgroup
250  * set for a task.
251  */
252
253 struct css_set {
254
255         /* Reference count */
256         atomic_t refcount;
257
258         /*
259          * List running through all cgroup groups in the same hash
260          * slot. Protected by css_set_lock
261          */
262         struct hlist_node hlist;
263
264         /*
265          * List running through all tasks using this cgroup
266          * group. Protected by css_set_lock
267          */
268         struct list_head tasks;
269
270         /*
271          * List of cg_cgroup_link objects on link chains from
272          * cgroups referenced from this css_set. Protected by
273          * css_set_lock
274          */
275         struct list_head cg_links;
276
277         /*
278          * Set of subsystem states, one for each subsystem. This array
279          * is immutable after creation apart from the init_css_set
280          * during subsystem registration (at boot time) and modular subsystem
281          * loading/unloading.
282          */
283         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
284
285         /* For RCU-protected deletion */
286         struct rcu_head rcu_head;
287 };
288
289 /*
290  * cgroup_map_cb is an abstract callback API for reporting map-valued
291  * control files
292  */
293
294 struct cgroup_map_cb {
295         int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
296         void *state;
297 };
298
299 /*
300  * struct cftype: handler definitions for cgroup control files
301  *
302  * When reading/writing to a file:
303  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
304  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
305  */
306
307 /* cftype->flags */
308 #define CFTYPE_ONLY_ON_ROOT     (1U << 0)       /* only create on root cg */
309 #define CFTYPE_NOT_ON_ROOT      (1U << 1)       /* don't create on root cg */
310
311 #define MAX_CFTYPE_NAME         64
312
313 struct cftype {
314         /*
315          * By convention, the name should begin with the name of the
316          * subsystem, followed by a period.  Zero length string indicates
317          * end of cftype array.
318          */
319         char name[MAX_CFTYPE_NAME];
320         int private;
321         /*
322          * If not 0, file mode is set to this value, otherwise it will
323          * be figured out automatically
324          */
325         umode_t mode;
326
327         /*
328          * If non-zero, defines the maximum length of string that can
329          * be passed to write_string; defaults to 64
330          */
331         size_t max_write_len;
332
333         /* CFTYPE_* flags */
334         unsigned int flags;
335
336         /* file xattrs */
337         struct simple_xattrs xattrs;
338
339         int (*open)(struct inode *inode, struct file *file);
340         ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
341                         struct file *file,
342                         char __user *buf, size_t nbytes, loff_t *ppos);
343         /*
344          * read_u64() is a shortcut for the common case of returning a
345          * single integer. Use it in place of read()
346          */
347         u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
348         /*
349          * read_s64() is a signed version of read_u64()
350          */
351         s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
352         /*
353          * read_map() is used for defining a map of key/value
354          * pairs. It should call cb->fill(cb, key, value) for each
355          * entry. The key/value pairs (and their ordering) should not
356          * change between reboots.
357          */
358         int (*read_map)(struct cgroup *cont, struct cftype *cft,
359                         struct cgroup_map_cb *cb);
360         /*
361          * read_seq_string() is used for outputting a simple sequence
362          * using seqfile.
363          */
364         int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
365                                struct seq_file *m);
366
367         ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
368                          struct file *file,
369                          const char __user *buf, size_t nbytes, loff_t *ppos);
370
371         /*
372          * write_u64() is a shortcut for the common case of accepting
373          * a single integer (as parsed by simple_strtoull) from
374          * userspace. Use in place of write(); return 0 or error.
375          */
376         int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
377         /*
378          * write_s64() is a signed version of write_u64()
379          */
380         int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
381
382         /*
383          * write_string() is passed a nul-terminated kernelspace
384          * buffer of maximum length determined by max_write_len.
385          * Returns 0 or -ve error code.
386          */
387         int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
388                             const char *buffer);
389         /*
390          * trigger() callback can be used to get some kick from the
391          * userspace, when the actual string written is not important
392          * at all. The private field can be used to determine the
393          * kick type for multiplexing.
394          */
395         int (*trigger)(struct cgroup *cgrp, unsigned int event);
396
397         int (*release)(struct inode *inode, struct file *file);
398
399         /*
400          * register_event() callback will be used to add new userspace
401          * waiter for changes related to the cftype. Implement it if
402          * you want to provide this functionality. Use eventfd_signal()
403          * on eventfd to send notification to userspace.
404          */
405         int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
406                         struct eventfd_ctx *eventfd, const char *args);
407         /*
408          * unregister_event() callback will be called when userspace
409          * closes the eventfd or on cgroup removing.
410          * This callback must be implemented, if you want provide
411          * notification functionality.
412          */
413         void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
414                         struct eventfd_ctx *eventfd);
415 };
416
417 /*
418  * cftype_sets describe cftypes belonging to a subsystem and are chained at
419  * cgroup_subsys->cftsets.  Each cftset points to an array of cftypes
420  * terminated by zero length name.
421  */
422 struct cftype_set {
423         struct list_head                node;   /* chained at subsys->cftsets */
424         struct cftype                   *cfts;
425 };
426
427 struct cgroup_scanner {
428         struct cgroup *cg;
429         int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
430         void (*process_task)(struct task_struct *p,
431                         struct cgroup_scanner *scan);
432         struct ptr_heap *heap;
433         void *data;
434 };
435
436 /* Caller should hold rcu_read_lock() */
437 static inline const char *cgroup_name(const struct cgroup *cgrp)
438 {
439         return rcu_dereference(cgrp->name)->name;
440 }
441
442 int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
443 int cgroup_rm_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
444
445 int cgroup_is_removed(const struct cgroup *cgrp);
446
447 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
448
449 int cgroup_task_count(const struct cgroup *cgrp);
450
451 /* Return true if cgrp is a descendant of the task's cgroup */
452 int cgroup_is_descendant(const struct cgroup *cgrp, struct task_struct *task);
453
454 /*
455  * Control Group taskset, used to pass around set of tasks to cgroup_subsys
456  * methods.
457  */
458 struct cgroup_taskset;
459 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
460 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
461 struct cgroup *cgroup_taskset_cur_cgroup(struct cgroup_taskset *tset);
462 int cgroup_taskset_size(struct cgroup_taskset *tset);
463
464 /**
465  * cgroup_taskset_for_each - iterate cgroup_taskset
466  * @task: the loop cursor
467  * @skip_cgrp: skip if task's cgroup matches this, %NULL to iterate through all
468  * @tset: taskset to iterate
469  */
470 #define cgroup_taskset_for_each(task, skip_cgrp, tset)                  \
471         for ((task) = cgroup_taskset_first((tset)); (task);             \
472              (task) = cgroup_taskset_next((tset)))                      \
473                 if (!(skip_cgrp) ||                                     \
474                     cgroup_taskset_cur_cgroup((tset)) != (skip_cgrp))
475
476 /*
477  * Control Group subsystem type.
478  * See Documentation/cgroups/cgroups.txt for details
479  */
480
481 struct cgroup_subsys {
482         struct cgroup_subsys_state *(*css_alloc)(struct cgroup *cgrp);
483         int (*css_online)(struct cgroup *cgrp);
484         void (*css_offline)(struct cgroup *cgrp);
485         void (*css_free)(struct cgroup *cgrp);
486
487         int (*can_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
488         void (*cancel_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
489         void (*attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
490         void (*fork)(struct task_struct *task);
491         void (*exit)(struct cgroup *cgrp, struct cgroup *old_cgrp,
492                      struct task_struct *task);
493         void (*bind)(struct cgroup *root);
494
495         int subsys_id;
496         int active;
497         int disabled;
498         int early_init;
499         /*
500          * True if this subsys uses ID. ID is not available before cgroup_init()
501          * (not available in early_init time.)
502          */
503         bool use_id;
504
505         /*
506          * If %false, this subsystem is properly hierarchical -
507          * configuration, resource accounting and restriction on a parent
508          * cgroup cover those of its children.  If %true, hierarchy support
509          * is broken in some ways - some subsystems ignore hierarchy
510          * completely while others are only implemented half-way.
511          *
512          * It's now disallowed to create nested cgroups if the subsystem is
513          * broken and cgroup core will emit a warning message on such
514          * cases.  Eventually, all subsystems will be made properly
515          * hierarchical and this will go away.
516          */
517         bool broken_hierarchy;
518         bool warned_broken_hierarchy;
519
520 #define MAX_CGROUP_TYPE_NAMELEN 32
521         const char *name;
522
523         /*
524          * Link to parent, and list entry in parent's children.
525          * Protected by cgroup_lock()
526          */
527         struct cgroupfs_root *root;
528         struct list_head sibling;
529         /* used when use_id == true */
530         struct idr idr;
531         spinlock_t id_lock;
532
533         /* list of cftype_sets */
534         struct list_head cftsets;
535
536         /* base cftypes, automatically [de]registered with subsys itself */
537         struct cftype *base_cftypes;
538         struct cftype_set base_cftset;
539
540         /* should be defined only by modular subsystems */
541         struct module *module;
542 };
543
544 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
545 #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
546 #include <linux/cgroup_subsys.h>
547 #undef IS_SUBSYS_ENABLED
548 #undef SUBSYS
549
550 static inline struct cgroup_subsys_state *cgroup_subsys_state(
551         struct cgroup *cgrp, int subsys_id)
552 {
553         return cgrp->subsys[subsys_id];
554 }
555
556 /*
557  * function to get the cgroup_subsys_state which allows for extra
558  * rcu_dereference_check() conditions, such as locks used during the
559  * cgroup_subsys::attach() methods.
560  */
561 #define task_subsys_state_check(task, subsys_id, __c)                   \
562         rcu_dereference_check(task->cgroups->subsys[subsys_id],         \
563                               lockdep_is_held(&task->alloc_lock) ||     \
564                               cgroup_lock_is_held() || (__c))
565
566 static inline struct cgroup_subsys_state *
567 task_subsys_state(struct task_struct *task, int subsys_id)
568 {
569         return task_subsys_state_check(task, subsys_id, false);
570 }
571
572 static inline struct cgroup* task_cgroup(struct task_struct *task,
573                                                int subsys_id)
574 {
575         return task_subsys_state(task, subsys_id)->cgroup;
576 }
577
578 /**
579  * cgroup_for_each_child - iterate through children of a cgroup
580  * @pos: the cgroup * to use as the loop cursor
581  * @cgroup: cgroup whose children to walk
582  *
583  * Walk @cgroup's children.  Must be called under rcu_read_lock().  A child
584  * cgroup which hasn't finished ->css_online() or already has finished
585  * ->css_offline() may show up during traversal and it's each subsystem's
586  * responsibility to verify that each @pos is alive.
587  *
588  * If a subsystem synchronizes against the parent in its ->css_online() and
589  * before starting iterating, a cgroup which finished ->css_online() is
590  * guaranteed to be visible in the future iterations.
591  */
592 #define cgroup_for_each_child(pos, cgroup)                              \
593         list_for_each_entry_rcu(pos, &(cgroup)->children, sibling)
594
595 struct cgroup *cgroup_next_descendant_pre(struct cgroup *pos,
596                                           struct cgroup *cgroup);
597 struct cgroup *cgroup_rightmost_descendant(struct cgroup *pos);
598
599 /**
600  * cgroup_for_each_descendant_pre - pre-order walk of a cgroup's descendants
601  * @pos: the cgroup * to use as the loop cursor
602  * @cgroup: cgroup whose descendants to walk
603  *
604  * Walk @cgroup's descendants.  Must be called under rcu_read_lock().  A
605  * descendant cgroup which hasn't finished ->css_online() or already has
606  * finished ->css_offline() may show up during traversal and it's each
607  * subsystem's responsibility to verify that each @pos is alive.
608  *
609  * If a subsystem synchronizes against the parent in its ->css_online() and
610  * before starting iterating, and synchronizes against @pos on each
611  * iteration, any descendant cgroup which finished ->css_offline() is
612  * guaranteed to be visible in the future iterations.
613  *
614  * In other words, the following guarantees that a descendant can't escape
615  * state updates of its ancestors.
616  *
617  * my_online(@cgrp)
618  * {
619  *      Lock @cgrp->parent and @cgrp;
620  *      Inherit state from @cgrp->parent;
621  *      Unlock both.
622  * }
623  *
624  * my_update_state(@cgrp)
625  * {
626  *      Lock @cgrp;
627  *      Update @cgrp's state;
628  *      Unlock @cgrp;
629  *
630  *      cgroup_for_each_descendant_pre(@pos, @cgrp) {
631  *              Lock @pos;
632  *              Verify @pos is alive and inherit state from @pos->parent;
633  *              Unlock @pos;
634  *      }
635  * }
636  *
637  * As long as the inheriting step, including checking the parent state, is
638  * enclosed inside @pos locking, double-locking the parent isn't necessary
639  * while inheriting.  The state update to the parent is guaranteed to be
640  * visible by walking order and, as long as inheriting operations to the
641  * same @pos are atomic to each other, multiple updates racing each other
642  * still result in the correct state.  It's guaranateed that at least one
643  * inheritance happens for any cgroup after the latest update to its
644  * parent.
645  *
646  * If checking parent's state requires locking the parent, each inheriting
647  * iteration should lock and unlock both @pos->parent and @pos.
648  *
649  * Alternatively, a subsystem may choose to use a single global lock to
650  * synchronize ->css_online() and ->css_offline() against tree-walking
651  * operations.
652  */
653 #define cgroup_for_each_descendant_pre(pos, cgroup)                     \
654         for (pos = cgroup_next_descendant_pre(NULL, (cgroup)); (pos);   \
655              pos = cgroup_next_descendant_pre((pos), (cgroup)))
656
657 struct cgroup *cgroup_next_descendant_post(struct cgroup *pos,
658                                            struct cgroup *cgroup);
659
660 /**
661  * cgroup_for_each_descendant_post - post-order walk of a cgroup's descendants
662  * @pos: the cgroup * to use as the loop cursor
663  * @cgroup: cgroup whose descendants to walk
664  *
665  * Similar to cgroup_for_each_descendant_pre() but performs post-order
666  * traversal instead.  Note that the walk visibility guarantee described in
667  * pre-order walk doesn't apply the same to post-order walks.
668  */
669 #define cgroup_for_each_descendant_post(pos, cgroup)                    \
670         for (pos = cgroup_next_descendant_post(NULL, (cgroup)); (pos);  \
671              pos = cgroup_next_descendant_post((pos), (cgroup)))
672
673 /* A cgroup_iter should be treated as an opaque object */
674 struct cgroup_iter {
675         struct list_head *cg_link;
676         struct list_head *task;
677 };
678
679 /*
680  * To iterate across the tasks in a cgroup:
681  *
682  * 1) call cgroup_iter_start to initialize an iterator
683  *
684  * 2) call cgroup_iter_next() to retrieve member tasks until it
685  *    returns NULL or until you want to end the iteration
686  *
687  * 3) call cgroup_iter_end() to destroy the iterator.
688  *
689  * Or, call cgroup_scan_tasks() to iterate through every task in a
690  * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
691  * the test_task() callback, but not while calling the process_task()
692  * callback.
693  */
694 void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
695 struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
696                                         struct cgroup_iter *it);
697 void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
698 int cgroup_scan_tasks(struct cgroup_scanner *scan);
699 int cgroup_attach_task(struct cgroup *, struct task_struct *);
700 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
701
702 /*
703  * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
704  * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
705  * CSS ID is assigned at cgroup allocation (create) automatically
706  * and removed when subsys calls free_css_id() function. This is because
707  * the lifetime of cgroup_subsys_state is subsys's matter.
708  *
709  * Looking up and scanning function should be called under rcu_read_lock().
710  * Taking cgroup_mutex is not necessary for following calls.
711  * But the css returned by this routine can be "not populated yet" or "being
712  * destroyed". The caller should check css and cgroup's status.
713  */
714
715 /*
716  * Typically Called at ->destroy(), or somewhere the subsys frees
717  * cgroup_subsys_state.
718  */
719 void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
720
721 /* Find a cgroup_subsys_state which has given ID */
722
723 struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
724
725 /*
726  * Get a cgroup whose id is greater than or equal to id under tree of root.
727  * Returning a cgroup_subsys_state or NULL.
728  */
729 struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
730                 struct cgroup_subsys_state *root, int *foundid);
731
732 /* Returns true if root is ancestor of cg */
733 bool css_is_ancestor(struct cgroup_subsys_state *cg,
734                      const struct cgroup_subsys_state *root);
735
736 /* Get id and depth of css */
737 unsigned short css_id(struct cgroup_subsys_state *css);
738 unsigned short css_depth(struct cgroup_subsys_state *css);
739 struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
740
741 #else /* !CONFIG_CGROUPS */
742
743 static inline int cgroup_init_early(void) { return 0; }
744 static inline int cgroup_init(void) { return 0; }
745 static inline void cgroup_fork(struct task_struct *p) {}
746 static inline void cgroup_post_fork(struct task_struct *p) {}
747 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
748
749 static inline void cgroup_lock(void) {}
750 static inline void cgroup_unlock(void) {}
751 static inline int cgroupstats_build(struct cgroupstats *stats,
752                                         struct dentry *dentry)
753 {
754         return -EINVAL;
755 }
756
757 /* No cgroups - nothing to do */
758 static inline int cgroup_attach_task_all(struct task_struct *from,
759                                          struct task_struct *t)
760 {
761         return 0;
762 }
763
764 #endif /* !CONFIG_CGROUPS */
765
766 #endif /* _LINUX_CGROUP_H */