1 #ifndef _LINUX_CGROUP_H
2 #define _LINUX_CGROUP_H
6 * Copyright (C) 2003 BULL SA
7 * Copyright (C) 2004-2006 Silicon Graphics, Inc.
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>
21 #include <linux/percpu-refcount.h>
22 #include <linux/seq_file.h>
23 #include <linux/kernfs.h>
24 #include <linux/wait.h>
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
);
41 extern int proc_cgroup_show(struct seq_file
*, void *);
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>
52 * Per-subsystem/per-cgroup state maintained by the system. This is the
53 * fundamental structural building block that controllers deal with.
55 * Fields marked with "PI:" are public and immutable and may be accessed
56 * directly without synchronization.
58 struct cgroup_subsys_state
{
59 /* PI: the cgroup that this css is attached to */
60 struct cgroup
*cgroup
;
62 /* PI: the cgroup subsystem that this css is attached to */
63 struct cgroup_subsys
*ss
;
65 /* reference count - access via css_[try]get() and css_put() */
66 struct percpu_ref refcnt
;
68 /* PI: the parent css */
69 struct cgroup_subsys_state
*parent
;
71 /* siblings list anchored at the parent's ->children */
72 struct list_head sibling
;
73 struct list_head children
;
76 * PI: Subsys-unique ID. 0 is unused and root is always 1. The
77 * matching css can be looked up using css_from_id().
84 * Monotonically increasing unique serial number which defines a
85 * uniform order among all csses. It's guaranteed that all
86 * ->children lists are in the ascending order of ->serial_nr and
87 * used to allow interrupting and resuming iterations.
91 /* percpu_ref killing and RCU release */
92 struct rcu_head rcu_head
;
93 struct work_struct destroy_work
;
96 /* bits in struct cgroup_subsys_state flags field */
98 CSS_NO_REF
= (1 << 0), /* no reference counting for this css */
99 CSS_ONLINE
= (1 << 1), /* between ->css_online() and ->css_offline() */
100 CSS_RELEASED
= (1 << 2), /* refcnt reached zero, released */
104 * css_get - obtain a reference on the specified css
107 * The caller must already have a reference.
109 static inline void css_get(struct cgroup_subsys_state
*css
)
111 if (!(css
->flags
& CSS_NO_REF
))
112 percpu_ref_get(&css
->refcnt
);
116 * css_tryget - try to obtain a reference on the specified css
119 * Obtain a reference on @css unless it already has reached zero and is
120 * being released. This function doesn't care whether @css is on or
121 * offline. The caller naturally needs to ensure that @css is accessible
122 * but doesn't have to be holding a reference on it - IOW, RCU protected
123 * access is good enough for this function. Returns %true if a reference
124 * count was successfully obtained; %false otherwise.
126 static inline bool css_tryget(struct cgroup_subsys_state
*css
)
128 if (!(css
->flags
& CSS_NO_REF
))
129 return percpu_ref_tryget(&css
->refcnt
);
134 * css_tryget_online - try to obtain a reference on the specified css if online
137 * Obtain a reference on @css if it's online. The caller naturally needs
138 * to ensure that @css is accessible but doesn't have to be holding a
139 * reference on it - IOW, RCU protected access is good enough for this
140 * function. Returns %true if a reference count was successfully obtained;
143 static inline bool css_tryget_online(struct cgroup_subsys_state
*css
)
145 if (!(css
->flags
& CSS_NO_REF
))
146 return percpu_ref_tryget_live(&css
->refcnt
);
151 * css_put - put a css reference
154 * Put a reference obtained via css_get() and css_tryget_online().
156 static inline void css_put(struct cgroup_subsys_state
*css
)
158 if (!(css
->flags
& CSS_NO_REF
))
159 percpu_ref_put(&css
->refcnt
);
162 /* bits in struct cgroup flags field */
165 * Control Group has previously had a child cgroup or a task,
166 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
169 /* Control Group requires release notifications to userspace */
170 CGRP_NOTIFY_ON_RELEASE
,
172 * Clone the parent's configuration when creating a new child
173 * cpuset cgroup. For historical reasons, this option can be
174 * specified at mount time and thus is implemented here.
176 CGRP_CPUSET_CLONE_CHILDREN
,
180 /* self css with NULL ->ss, points back to this cgroup */
181 struct cgroup_subsys_state self
;
183 unsigned long flags
; /* "unsigned long" so bitops work */
186 * idr allocated in-hierarchy ID.
188 * ID 0 is not used, the ID of the root cgroup is always 1, and a
189 * new cgroup will be assigned with a smallest available ID.
191 * Allocating/Removing ID must be protected by cgroup_mutex.
196 * If this cgroup contains any tasks, it contributes one to
197 * populated_cnt. All children with non-zero popuplated_cnt of
198 * their own contribute one. The count is zero iff there's no task
199 * in this cgroup or its subtree.
203 struct kernfs_node
*kn
; /* cgroup kernfs entry */
204 struct kernfs_node
*populated_kn
; /* kn for "cgroup.subtree_populated" */
207 * The bitmask of subsystems enabled on the child cgroups.
208 * ->subtree_control is the one configured through
209 * "cgroup.subtree_control" while ->child_subsys_mask is the
210 * effective one which may have more subsystems enabled.
211 * Controller knobs are made available iff it's enabled in
214 unsigned int subtree_control
;
215 unsigned int child_subsys_mask
;
217 /* Private pointers for each registered subsystem */
218 struct cgroup_subsys_state __rcu
*subsys
[CGROUP_SUBSYS_COUNT
];
220 struct cgroup_root
*root
;
223 * List of cgrp_cset_links pointing at css_sets with tasks in this
224 * cgroup. Protected by css_set_lock.
226 struct list_head cset_links
;
229 * On the default hierarchy, a css_set for a cgroup with some
230 * susbsys disabled will point to css's which are associated with
231 * the closest ancestor which has the subsys enabled. The
232 * following lists all css_sets which point to this cgroup's css
233 * for the given subsystem.
235 struct list_head e_csets
[CGROUP_SUBSYS_COUNT
];
238 * Linked list running through all cgroups that can
239 * potentially be reaped by the release agent. Protected by
242 struct list_head release_list
;
245 * list of pidlists, up to two for each namespace (one for procs, one
246 * for tasks); created on demand.
248 struct list_head pidlists
;
249 struct mutex pidlist_mutex
;
251 /* used to wait for offlining of csses */
252 wait_queue_head_t offline_waitq
;
255 #define MAX_CGROUP_ROOT_NAMELEN 64
257 /* cgroup_root->flags */
260 * Unfortunately, cgroup core and various controllers are riddled
261 * with idiosyncrasies and pointless options. The following flag,
262 * when set, will force sane behavior - some options are forced on,
263 * others are disallowed, and some controllers will change their
264 * hierarchical or other behaviors.
266 * The set of behaviors affected by this flag are still being
267 * determined and developed and the mount option for this flag is
268 * prefixed with __DEVEL__. The prefix will be dropped once we
269 * reach the point where all behaviors are compatible with the
270 * planned unified hierarchy, which will automatically turn on this
273 * The followings are the behaviors currently affected this flag.
275 * - Mount options "noprefix", "xattr", "clone_children",
276 * "release_agent" and "name" are disallowed.
278 * - When mounting an existing superblock, mount options should
281 * - Remount is disallowed.
283 * - rename(2) is disallowed.
285 * - "tasks" is removed. Everything should be at process
286 * granularity. Use "cgroup.procs" instead.
288 * - "cgroup.procs" is not sorted. pids will be unique unless they
289 * got recycled inbetween reads.
291 * - "release_agent" and "notify_on_release" are removed.
292 * Replacement notification mechanism will be implemented.
294 * - "cgroup.clone_children" is removed.
296 * - "cgroup.subtree_populated" is available. Its value is 0 if
297 * the cgroup and its descendants contain no task; otherwise, 1.
298 * The file also generates kernfs notification which can be
299 * monitored through poll and [di]notify when the value of the
302 * - If mount is requested with sane_behavior but without any
303 * subsystem, the default unified hierarchy is mounted.
305 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
306 * and take masks of ancestors with non-empty cpus/mems, instead of
307 * being moved to an ancestor.
309 * - cpuset: a task can be moved into an empty cpuset, and again it
310 * takes masks of ancestors.
312 * - memcg: use_hierarchy is on by default and the cgroup file for
313 * the flag is not created.
315 * - blkcg: blk-throttle becomes properly hierarchical.
317 * - debug: disallowed on the default hierarchy.
319 CGRP_ROOT_SANE_BEHAVIOR
= (1 << 0),
321 CGRP_ROOT_NOPREFIX
= (1 << 1), /* mounted subsystems have no named prefix */
322 CGRP_ROOT_XATTR
= (1 << 2), /* supports extended attributes */
326 * A cgroup_root represents the root of a cgroup hierarchy, and may be
327 * associated with a kernfs_root to form an active hierarchy. This is
328 * internal to cgroup core. Don't access directly from controllers.
331 struct kernfs_root
*kf_root
;
333 /* The bitmask of subsystems attached to this hierarchy */
334 unsigned int subsys_mask
;
336 /* Unique id for this hierarchy. */
339 /* The root cgroup. Root is destroyed on its release. */
342 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
345 /* A list running through the active hierarchies */
346 struct list_head root_list
;
348 /* Hierarchy-specific flags */
351 /* IDs for cgroups in this hierarchy */
352 struct idr cgroup_idr
;
354 /* The path to use for release notifications. */
355 char release_agent_path
[PATH_MAX
];
357 /* The name for this hierarchy - may be empty */
358 char name
[MAX_CGROUP_ROOT_NAMELEN
];
362 * A css_set is a structure holding pointers to a set of
363 * cgroup_subsys_state objects. This saves space in the task struct
364 * object and speeds up fork()/exit(), since a single inc/dec and a
365 * list_add()/del() can bump the reference count on the entire cgroup
371 /* Reference count */
375 * List running through all cgroup groups in the same hash
376 * slot. Protected by css_set_lock
378 struct hlist_node hlist
;
381 * Lists running through all tasks using this cgroup group.
382 * mg_tasks lists tasks which belong to this cset but are in the
383 * process of being migrated out or in. Protected by
384 * css_set_rwsem, but, during migration, once tasks are moved to
385 * mg_tasks, it can be read safely while holding cgroup_mutex.
387 struct list_head tasks
;
388 struct list_head mg_tasks
;
391 * List of cgrp_cset_links pointing at cgroups referenced from this
392 * css_set. Protected by css_set_lock.
394 struct list_head cgrp_links
;
396 /* the default cgroup associated with this css_set */
397 struct cgroup
*dfl_cgrp
;
400 * Set of subsystem states, one for each subsystem. This array is
401 * immutable after creation apart from the init_css_set during
402 * subsystem registration (at boot time).
404 struct cgroup_subsys_state
*subsys
[CGROUP_SUBSYS_COUNT
];
407 * List of csets participating in the on-going migration either as
408 * source or destination. Protected by cgroup_mutex.
410 struct list_head mg_preload_node
;
411 struct list_head mg_node
;
414 * If this cset is acting as the source of migration the following
415 * two fields are set. mg_src_cgrp is the source cgroup of the
416 * on-going migration and mg_dst_cset is the destination cset the
417 * target tasks on this cset should be migrated to. Protected by
420 struct cgroup
*mg_src_cgrp
;
421 struct css_set
*mg_dst_cset
;
424 * On the default hierarhcy, ->subsys[ssid] may point to a css
425 * attached to an ancestor instead of the cgroup this css_set is
426 * associated with. The following node is anchored at
427 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
428 * iterate through all css's attached to a given cgroup.
430 struct list_head e_cset_node
[CGROUP_SUBSYS_COUNT
];
432 /* For RCU-protected deletion */
433 struct rcu_head rcu_head
;
437 * struct cftype: handler definitions for cgroup control files
439 * When reading/writing to a file:
440 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
441 * - the 'cftype' of the file is file->f_dentry->d_fsdata
446 CFTYPE_ONLY_ON_ROOT
= (1 << 0), /* only create on root cgrp */
447 CFTYPE_NOT_ON_ROOT
= (1 << 1), /* don't create on root cgrp */
448 CFTYPE_INSANE
= (1 << 2), /* don't create if sane_behavior */
449 CFTYPE_NO_PREFIX
= (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
450 CFTYPE_ONLY_ON_DFL
= (1 << 4), /* only on default hierarchy */
453 #define MAX_CFTYPE_NAME 64
457 * By convention, the name should begin with the name of the
458 * subsystem, followed by a period. Zero length string indicates
459 * end of cftype array.
461 char name
[MAX_CFTYPE_NAME
];
464 * If not 0, file mode is set to this value, otherwise it will
465 * be figured out automatically
470 * The maximum length of string, excluding trailing nul, that can
471 * be passed to write. If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
473 size_t max_write_len
;
479 * Fields used for internal bookkeeping. Initialized automatically
480 * during registration.
482 struct cgroup_subsys
*ss
; /* NULL for cgroup core files */
483 struct list_head node
; /* anchored at ss->cfts */
484 struct kernfs_ops
*kf_ops
;
487 * read_u64() is a shortcut for the common case of returning a
488 * single integer. Use it in place of read()
490 u64 (*read_u64
)(struct cgroup_subsys_state
*css
, struct cftype
*cft
);
492 * read_s64() is a signed version of read_u64()
494 s64 (*read_s64
)(struct cgroup_subsys_state
*css
, struct cftype
*cft
);
496 /* generic seq_file read interface */
497 int (*seq_show
)(struct seq_file
*sf
, void *v
);
499 /* optional ops, implement all or none */
500 void *(*seq_start
)(struct seq_file
*sf
, loff_t
*ppos
);
501 void *(*seq_next
)(struct seq_file
*sf
, void *v
, loff_t
*ppos
);
502 void (*seq_stop
)(struct seq_file
*sf
, void *v
);
505 * write_u64() is a shortcut for the common case of accepting
506 * a single integer (as parsed by simple_strtoull) from
507 * userspace. Use in place of write(); return 0 or error.
509 int (*write_u64
)(struct cgroup_subsys_state
*css
, struct cftype
*cft
,
512 * write_s64() is a signed version of write_u64()
514 int (*write_s64
)(struct cgroup_subsys_state
*css
, struct cftype
*cft
,
518 * write() is the generic write callback which maps directly to
519 * kernfs write operation and overrides all other operations.
520 * Maximum write size is determined by ->max_write_len. Use
521 * of_css/cft() to access the associated css and cft.
523 ssize_t (*write
)(struct kernfs_open_file
*of
,
524 char *buf
, size_t nbytes
, loff_t off
);
526 #ifdef CONFIG_DEBUG_LOCK_ALLOC
527 struct lock_class_key lockdep_key
;
531 extern struct cgroup_root cgrp_dfl_root
;
532 extern struct css_set init_css_set
;
534 static inline bool cgroup_on_dfl(const struct cgroup
*cgrp
)
536 return cgrp
->root
== &cgrp_dfl_root
;
540 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
541 * function can be called as long as @cgrp is accessible.
543 static inline bool cgroup_sane_behavior(const struct cgroup
*cgrp
)
545 return cgrp
->root
->flags
& CGRP_ROOT_SANE_BEHAVIOR
;
548 /* no synchronization, the result can only be used as a hint */
549 static inline bool cgroup_has_tasks(struct cgroup
*cgrp
)
551 return !list_empty(&cgrp
->cset_links
);
554 /* returns ino associated with a cgroup, 0 indicates unmounted root */
555 static inline ino_t
cgroup_ino(struct cgroup
*cgrp
)
558 return cgrp
->kn
->ino
;
563 /* cft/css accessors for cftype->write() operation */
564 static inline struct cftype
*of_cft(struct kernfs_open_file
*of
)
569 struct cgroup_subsys_state
*of_css(struct kernfs_open_file
*of
);
571 /* cft/css accessors for cftype->seq_*() operations */
572 static inline struct cftype
*seq_cft(struct seq_file
*seq
)
574 return of_cft(seq
->private);
577 static inline struct cgroup_subsys_state
*seq_css(struct seq_file
*seq
)
579 return of_css(seq
->private);
583 * Name / path handling functions. All are thin wrappers around the kernfs
584 * counterparts and can be called under any context.
587 static inline int cgroup_name(struct cgroup
*cgrp
, char *buf
, size_t buflen
)
589 return kernfs_name(cgrp
->kn
, buf
, buflen
);
592 static inline char * __must_check
cgroup_path(struct cgroup
*cgrp
, char *buf
,
595 return kernfs_path(cgrp
->kn
, buf
, buflen
);
598 static inline void pr_cont_cgroup_name(struct cgroup
*cgrp
)
600 pr_cont_kernfs_name(cgrp
->kn
);
603 static inline void pr_cont_cgroup_path(struct cgroup
*cgrp
)
605 pr_cont_kernfs_path(cgrp
->kn
);
608 char *task_cgroup_path(struct task_struct
*task
, char *buf
, size_t buflen
);
610 int cgroup_add_cftypes(struct cgroup_subsys
*ss
, struct cftype
*cfts
);
611 int cgroup_rm_cftypes(struct cftype
*cfts
);
613 bool cgroup_is_descendant(struct cgroup
*cgrp
, struct cgroup
*ancestor
);
616 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
619 struct cgroup_taskset
;
620 struct task_struct
*cgroup_taskset_first(struct cgroup_taskset
*tset
);
621 struct task_struct
*cgroup_taskset_next(struct cgroup_taskset
*tset
);
624 * cgroup_taskset_for_each - iterate cgroup_taskset
625 * @task: the loop cursor
626 * @tset: taskset to iterate
628 #define cgroup_taskset_for_each(task, tset) \
629 for ((task) = cgroup_taskset_first((tset)); (task); \
630 (task) = cgroup_taskset_next((tset)))
633 * Control Group subsystem type.
634 * See Documentation/cgroups/cgroups.txt for details
637 struct cgroup_subsys
{
638 struct cgroup_subsys_state
*(*css_alloc
)(struct cgroup_subsys_state
*parent_css
);
639 int (*css_online
)(struct cgroup_subsys_state
*css
);
640 void (*css_offline
)(struct cgroup_subsys_state
*css
);
641 void (*css_free
)(struct cgroup_subsys_state
*css
);
642 void (*css_reset
)(struct cgroup_subsys_state
*css
);
644 int (*can_attach
)(struct cgroup_subsys_state
*css
,
645 struct cgroup_taskset
*tset
);
646 void (*cancel_attach
)(struct cgroup_subsys_state
*css
,
647 struct cgroup_taskset
*tset
);
648 void (*attach
)(struct cgroup_subsys_state
*css
,
649 struct cgroup_taskset
*tset
);
650 void (*fork
)(struct task_struct
*task
);
651 void (*exit
)(struct cgroup_subsys_state
*css
,
652 struct cgroup_subsys_state
*old_css
,
653 struct task_struct
*task
);
654 void (*bind
)(struct cgroup_subsys_state
*root_css
);
660 * If %false, this subsystem is properly hierarchical -
661 * configuration, resource accounting and restriction on a parent
662 * cgroup cover those of its children. If %true, hierarchy support
663 * is broken in some ways - some subsystems ignore hierarchy
664 * completely while others are only implemented half-way.
666 * It's now disallowed to create nested cgroups if the subsystem is
667 * broken and cgroup core will emit a warning message on such
668 * cases. Eventually, all subsystems will be made properly
669 * hierarchical and this will go away.
671 bool broken_hierarchy
;
672 bool warned_broken_hierarchy
;
674 /* the following two fields are initialized automtically during boot */
676 #define MAX_CGROUP_TYPE_NAMELEN 32
679 /* link to parent, protected by cgroup_lock() */
680 struct cgroup_root
*root
;
682 /* idr for css->id */
686 * List of cftypes. Each entry is the first entry of an array
687 * terminated by zero length name.
689 struct list_head cfts
;
691 /* base cftypes, automatically registered with subsys itself */
692 struct cftype
*base_cftypes
;
695 * A subsystem may depend on other subsystems. When such subsystem
696 * is enabled on a cgroup, the depended-upon subsystems are enabled
697 * together if available. Subsystems enabled due to dependency are
698 * not visible to userland until explicitly enabled. The following
699 * specifies the mask of subsystems that this one depends on.
701 unsigned int depends_on
;
704 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
705 #include <linux/cgroup_subsys.h>
709 * task_css_set_check - obtain a task's css_set with extra access conditions
710 * @task: the task to obtain css_set for
711 * @__c: extra condition expression to be passed to rcu_dereference_check()
713 * A task's css_set is RCU protected, initialized and exited while holding
714 * task_lock(), and can only be modified while holding both cgroup_mutex
715 * and task_lock() while the task is alive. This macro verifies that the
716 * caller is inside proper critical section and returns @task's css_set.
718 * The caller can also specify additional allowed conditions via @__c, such
719 * as locks used during the cgroup_subsys::attach() methods.
721 #ifdef CONFIG_PROVE_RCU
722 extern struct mutex cgroup_mutex
;
723 extern struct rw_semaphore css_set_rwsem
;
724 #define task_css_set_check(task, __c) \
725 rcu_dereference_check((task)->cgroups, \
726 lockdep_is_held(&cgroup_mutex) || \
727 lockdep_is_held(&css_set_rwsem) || \
728 ((task)->flags & PF_EXITING) || (__c))
730 #define task_css_set_check(task, __c) \
731 rcu_dereference((task)->cgroups)
735 * task_css_check - obtain css for (task, subsys) w/ extra access conds
736 * @task: the target task
737 * @subsys_id: the target subsystem ID
738 * @__c: extra condition expression to be passed to rcu_dereference_check()
740 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
741 * synchronization rules are the same as task_css_set_check().
743 #define task_css_check(task, subsys_id, __c) \
744 task_css_set_check((task), (__c))->subsys[(subsys_id)]
747 * task_css_set - obtain a task's css_set
748 * @task: the task to obtain css_set for
750 * See task_css_set_check().
752 static inline struct css_set
*task_css_set(struct task_struct
*task
)
754 return task_css_set_check(task
, false);
758 * task_css - obtain css for (task, subsys)
759 * @task: the target task
760 * @subsys_id: the target subsystem ID
762 * See task_css_check().
764 static inline struct cgroup_subsys_state
*task_css(struct task_struct
*task
,
767 return task_css_check(task
, subsys_id
, false);
771 * task_css_is_root - test whether a task belongs to the root css
772 * @task: the target task
773 * @subsys_id: the target subsystem ID
775 * Test whether @task belongs to the root css on the specified subsystem.
776 * May be invoked in any context.
778 static inline bool task_css_is_root(struct task_struct
*task
, int subsys_id
)
780 return task_css_check(task
, subsys_id
, true) ==
781 init_css_set
.subsys
[subsys_id
];
784 static inline struct cgroup
*task_cgroup(struct task_struct
*task
,
787 return task_css(task
, subsys_id
)->cgroup
;
790 struct cgroup_subsys_state
*css_next_child(struct cgroup_subsys_state
*pos
,
791 struct cgroup_subsys_state
*parent
);
793 struct cgroup_subsys_state
*css_from_id(int id
, struct cgroup_subsys
*ss
);
796 * css_for_each_child - iterate through children of a css
797 * @pos: the css * to use as the loop cursor
798 * @parent: css whose children to walk
800 * Walk @parent's children. Must be called under rcu_read_lock().
802 * If a subsystem synchronizes ->css_online() and the start of iteration, a
803 * css which finished ->css_online() is guaranteed to be visible in the
804 * future iterations and will stay visible until the last reference is put.
805 * A css which hasn't finished ->css_online() or already finished
806 * ->css_offline() may show up during traversal. It's each subsystem's
807 * responsibility to synchronize against on/offlining.
809 * It is allowed to temporarily drop RCU read lock during iteration. The
810 * caller is responsible for ensuring that @pos remains accessible until
811 * the start of the next iteration by, for example, bumping the css refcnt.
813 #define css_for_each_child(pos, parent) \
814 for ((pos) = css_next_child(NULL, (parent)); (pos); \
815 (pos) = css_next_child((pos), (parent)))
817 struct cgroup_subsys_state
*
818 css_next_descendant_pre(struct cgroup_subsys_state
*pos
,
819 struct cgroup_subsys_state
*css
);
821 struct cgroup_subsys_state
*
822 css_rightmost_descendant(struct cgroup_subsys_state
*pos
);
825 * css_for_each_descendant_pre - pre-order walk of a css's descendants
826 * @pos: the css * to use as the loop cursor
827 * @root: css whose descendants to walk
829 * Walk @root's descendants. @root is included in the iteration and the
830 * first node to be visited. Must be called under rcu_read_lock().
832 * If a subsystem synchronizes ->css_online() and the start of iteration, a
833 * css which finished ->css_online() is guaranteed to be visible in the
834 * future iterations and will stay visible until the last reference is put.
835 * A css which hasn't finished ->css_online() or already finished
836 * ->css_offline() may show up during traversal. It's each subsystem's
837 * responsibility to synchronize against on/offlining.
839 * For example, the following guarantees that a descendant can't escape
840 * state updates of its ancestors.
844 * Lock @css's parent and @css;
845 * Inherit state from the parent;
849 * my_update_state(@css)
851 * css_for_each_descendant_pre(@pos, @css) {
854 * Update @css's state;
856 * Verify @pos is alive and inherit state from its parent;
861 * As long as the inheriting step, including checking the parent state, is
862 * enclosed inside @pos locking, double-locking the parent isn't necessary
863 * while inheriting. The state update to the parent is guaranteed to be
864 * visible by walking order and, as long as inheriting operations to the
865 * same @pos are atomic to each other, multiple updates racing each other
866 * still result in the correct state. It's guaranateed that at least one
867 * inheritance happens for any css after the latest update to its parent.
869 * If checking parent's state requires locking the parent, each inheriting
870 * iteration should lock and unlock both @pos->parent and @pos.
872 * Alternatively, a subsystem may choose to use a single global lock to
873 * synchronize ->css_online() and ->css_offline() against tree-walking
876 * It is allowed to temporarily drop RCU read lock during iteration. The
877 * caller is responsible for ensuring that @pos remains accessible until
878 * the start of the next iteration by, for example, bumping the css refcnt.
880 #define css_for_each_descendant_pre(pos, css) \
881 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
882 (pos) = css_next_descendant_pre((pos), (css)))
884 struct cgroup_subsys_state
*
885 css_next_descendant_post(struct cgroup_subsys_state
*pos
,
886 struct cgroup_subsys_state
*css
);
889 * css_for_each_descendant_post - post-order walk of a css's descendants
890 * @pos: the css * to use as the loop cursor
891 * @css: css whose descendants to walk
893 * Similar to css_for_each_descendant_pre() but performs post-order
894 * traversal instead. @root is included in the iteration and the last
895 * node to be visited.
897 * If a subsystem synchronizes ->css_online() and the start of iteration, a
898 * css which finished ->css_online() is guaranteed to be visible in the
899 * future iterations and will stay visible until the last reference is put.
900 * A css which hasn't finished ->css_online() or already finished
901 * ->css_offline() may show up during traversal. It's each subsystem's
902 * responsibility to synchronize against on/offlining.
904 * Note that the walk visibility guarantee example described in pre-order
905 * walk doesn't apply the same to post-order walks.
907 #define css_for_each_descendant_post(pos, css) \
908 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
909 (pos) = css_next_descendant_post((pos), (css)))
911 bool css_has_online_children(struct cgroup_subsys_state
*css
);
913 /* A css_task_iter should be treated as an opaque object */
914 struct css_task_iter
{
915 struct cgroup_subsys
*ss
;
917 struct list_head
*cset_pos
;
918 struct list_head
*cset_head
;
920 struct list_head
*task_pos
;
921 struct list_head
*tasks_head
;
922 struct list_head
*mg_tasks_head
;
925 void css_task_iter_start(struct cgroup_subsys_state
*css
,
926 struct css_task_iter
*it
);
927 struct task_struct
*css_task_iter_next(struct css_task_iter
*it
);
928 void css_task_iter_end(struct css_task_iter
*it
);
930 int cgroup_attach_task_all(struct task_struct
*from
, struct task_struct
*);
931 int cgroup_transfer_tasks(struct cgroup
*to
, struct cgroup
*from
);
933 struct cgroup_subsys_state
*css_tryget_online_from_dir(struct dentry
*dentry
,
934 struct cgroup_subsys
*ss
);
936 #else /* !CONFIG_CGROUPS */
938 static inline int cgroup_init_early(void) { return 0; }
939 static inline int cgroup_init(void) { return 0; }
940 static inline void cgroup_fork(struct task_struct
*p
) {}
941 static inline void cgroup_post_fork(struct task_struct
*p
) {}
942 static inline void cgroup_exit(struct task_struct
*p
) {}
944 static inline int cgroupstats_build(struct cgroupstats
*stats
,
945 struct dentry
*dentry
)
950 /* No cgroups - nothing to do */
951 static inline int cgroup_attach_task_all(struct task_struct
*from
,
952 struct task_struct
*t
)
957 #endif /* !CONFIG_CGROUPS */
959 #endif /* _LINUX_CGROUP_H */