cgroup.h 22.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
#ifndef _LINUX_CGROUP_H
#define _LINUX_CGROUP_H
/*
 *  cgroup interface
 *
 *  Copyright (C) 2003 BULL SA
 *  Copyright (C) 2004-2006 Silicon Graphics, Inc.
 *
 */

#include <linux/sched.h>
#include <linux/cpumask.h>
#include <linux/nodemask.h>
#include <linux/rcupdate.h>
15
#include <linux/rculist.h>
B
Balbir Singh 已提交
16
#include <linux/cgroupstats.h>
17
#include <linux/prio_heap.h>
18
#include <linux/rwsem.h>
K
KAMEZAWA Hiroyuki 已提交
19
#include <linux/idr.h>
20
#include <linux/workqueue.h>
A
Aristeu Rozanski 已提交
21
#include <linux/xattr.h>
22 23 24 25 26 27

#ifdef CONFIG_CGROUPS

struct cgroupfs_root;
struct cgroup_subsys;
struct inode;
28
struct cgroup;
K
KAMEZAWA Hiroyuki 已提交
29
struct css_id;
30 31 32 33

extern int cgroup_init_early(void);
extern int cgroup_init(void);
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);
B
Balbir Singh 已提交
40 41
extern int cgroupstats_build(struct cgroupstats *stats,
				struct dentry *dentry);
42
extern int cgroup_load_subsys(struct cgroup_subsys *ss);
B
Ben Blum 已提交
43
extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
44

45
extern const struct file_operations proc_cgroup_operations;
46

B
Ben Blum 已提交
47
/* Define the enumeration of all builtin cgroup subsystems */
48
#define SUBSYS(_x) _x ## _subsys_id,
49
#define IS_SUBSYS_ENABLED(option) IS_ENABLED(option)
50 51
enum cgroup_subsys_id {
#include <linux/cgroup_subsys.h>
52
	CGROUP_SUBSYS_COUNT,
53
};
54
#undef IS_SUBSYS_ENABLED
55 56
#undef SUBSYS

57 58
/* Per-subsystem/per-cgroup state maintained by the system. */
struct cgroup_subsys_state {
P
Paul Menage 已提交
59 60
	/*
	 * The cgroup that this subsystem is attached to. Useful
61
	 * for subsystems that want to know about the cgroup
P
Paul Menage 已提交
62 63
	 * hierarchy structure
	 */
64 65
	struct cgroup *cgroup;

P
Paul Menage 已提交
66 67
	/*
	 * State maintained by the cgroup system to allow subsystems
P
Paul Menage 已提交
68
	 * to be "busy". Should be accessed via css_get(),
69
	 * css_tryget() and css_put().
P
Paul Menage 已提交
70
	 */
71 72 73 74

	atomic_t refcnt;

	unsigned long flags;
K
KAMEZAWA Hiroyuki 已提交
75
	/* ID for this css, if possible */
A
Arnd Bergmann 已提交
76
	struct css_id __rcu *id;
77 78 79

	/* Used to put @cgroup->dentry on the last css_put() */
	struct work_struct dput_work;
80 81 82 83
};

/* bits in struct cgroup_subsys_state flags field */
enum {
84
	CSS_ROOT	= (1 << 0), /* this CSS is the root of the subsystem */
85
	CSS_ONLINE	= (1 << 1), /* between ->css_online() and ->css_offline() */
86 87
};

88 89 90 91 92 93
/* Caller must verify that the css is not for root cgroup */
static inline void __css_get(struct cgroup_subsys_state *css, int count)
{
	atomic_add(count, &css->refcnt);
}

94
/*
P
Paul Menage 已提交
95 96 97 98
 * Call css_get() to hold a reference on the css; it can be used
 * for a reference obtained via:
 * - an existing ref-counted reference to the css
 * - task->cgroups for a locked task
99 100 101 102 103
 */

static inline void css_get(struct cgroup_subsys_state *css)
{
	/* We don't need to reference count the root state */
104
	if (!(css->flags & CSS_ROOT))
105
		__css_get(css, 1);
106
}
P
Paul Menage 已提交
107 108 109 110 111 112 113

/*
 * Call css_tryget() to take a reference on a css if your existing
 * (known-valid) reference isn't already ref-counted. Returns false if
 * the css has been destroyed.
 */

114
extern bool __css_tryget(struct cgroup_subsys_state *css);
P
Paul Menage 已提交
115 116
static inline bool css_tryget(struct cgroup_subsys_state *css)
{
117
	if (css->flags & CSS_ROOT)
P
Paul Menage 已提交
118
		return true;
119
	return __css_tryget(css);
P
Paul Menage 已提交
120 121
}

122 123
/*
 * css_put() should be called to release a reference taken by
P
Paul Menage 已提交
124
 * css_get() or css_tryget()
125 126
 */

127
extern void __css_put(struct cgroup_subsys_state *css);
128 129
static inline void css_put(struct cgroup_subsys_state *css)
{
130
	if (!(css->flags & CSS_ROOT))
131
		__css_put(css);
132 133
}

134 135 136 137
/* bits in struct cgroup flags field */
enum {
	/* Control Group is dead */
	CGRP_REMOVED,
P
Paul Menage 已提交
138 139 140 141
	/*
	 * Control Group has previously had a child cgroup or a task,
	 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
	 */
142 143 144
	CGRP_RELEASABLE,
	/* Control Group requires release notifications to userspace */
	CGRP_NOTIFY_ON_RELEASE,
145
	/*
146 147 148
	 * Clone the parent's configuration when creating a new child
	 * cpuset cgroup.  For historical reasons, this option can be
	 * specified at mount time and thus is implemented here.
149
	 */
150
	CGRP_CPUSET_CLONE_CHILDREN,
151 152
};

153 154 155
struct cgroup {
	unsigned long flags;		/* "unsigned long" so bitops work */

P
Paul Menage 已提交
156 157 158 159
	/*
	 * count users of this cgroup. >0 means busy, but doesn't
	 * necessarily indicate the number of tasks in the cgroup
	 */
160 161
	atomic_t count;

T
Tejun Heo 已提交
162 163
	int id;				/* ida allocated in-hierarchy ID */

164 165 166 167 168 169
	/*
	 * We link our 'sibling' struct into our parent's 'children'.
	 * Our children link their 'sibling' into our 'children'.
	 */
	struct list_head sibling;	/* my parent's children */
	struct list_head children;	/* my children */
T
Tejun Heo 已提交
170
	struct list_head files;		/* my files */
171

P
Paul Menage 已提交
172
	struct cgroup *parent;		/* my parent */
173
	struct dentry *dentry;		/* cgroup fs entry, RCU protected */
174 175 176 177 178 179

	/* Private pointers for each registered subsystem */
	struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];

	struct cgroupfs_root *root;
	struct cgroup *top_cgroup;
180 181 182 183 184 185

	/*
	 * List of cg_cgroup_links pointing at css_sets with
	 * tasks in this cgroup. Protected by css_set_lock
	 */
	struct list_head css_sets;
186

187
	struct list_head allcg_node;	/* cgroupfs_root->allcg_list */
188
	struct list_head cft_q_node;	/* used during cftype add/rm */
189

190 191 192 193 194 195
	/*
	 * Linked list running through all cgroups that can
	 * potentially be reaped by the release agent. Protected by
	 * release_list_lock
	 */
	struct list_head release_list;
196

197 198 199 200 201 202
	/*
	 * list of pidlists, up to two for each namespace (one for procs, one
	 * for tasks); created on demand.
	 */
	struct list_head pidlists;
	struct mutex pidlist_mutex;
203 204 205

	/* For RCU-protected deletion */
	struct rcu_head rcu_head;
206
	struct work_struct free_work;
207

L
Lucas De Marchi 已提交
208
	/* List of events which userspace want to receive */
209 210
	struct list_head event_list;
	spinlock_t event_list_lock;
A
Aristeu Rozanski 已提交
211 212 213

	/* directory xattrs */
	struct simple_xattrs xattrs;
214 215
};

P
Paul Menage 已提交
216 217
/*
 * A css_set is a structure holding pointers to a set of
218 219
 * cgroup_subsys_state objects. This saves space in the task struct
 * object and speeds up fork()/exit(), since a single inc/dec and a
P
Paul Menage 已提交
220 221
 * list_add()/del() can bump the reference count on the entire cgroup
 * set for a task.
222 223 224 225 226
 */

struct css_set {

	/* Reference count */
227
	atomic_t refcount;
228

229 230 231 232 233 234
	/*
	 * List running through all cgroup groups in the same hash
	 * slot. Protected by css_set_lock
	 */
	struct hlist_node hlist;

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
	/*
	 * List running through all tasks using this cgroup
	 * group. Protected by css_set_lock
	 */
	struct list_head tasks;

	/*
	 * List of cg_cgroup_link objects on link chains from
	 * cgroups referenced from this css_set. Protected by
	 * css_set_lock
	 */
	struct list_head cg_links;

	/*
	 * Set of subsystem states, one for each subsystem. This array
	 * is immutable after creation apart from the init_css_set
B
Ben Blum 已提交
251 252
	 * during subsystem registration (at boot time) and modular subsystem
	 * loading/unloading.
253 254
	 */
	struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
255 256 257

	/* For RCU-protected deletion */
	struct rcu_head rcu_head;
258 259
};

260 261 262 263 264 265 266 267 268 269
/*
 * cgroup_map_cb is an abstract callback API for reporting map-valued
 * control files
 */

struct cgroup_map_cb {
	int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
	void *state;
};

P
Paul Menage 已提交
270 271
/*
 * struct cftype: handler definitions for cgroup control files
272 273
 *
 * When reading/writing to a file:
L
Li Zefan 已提交
274
 *	- the cgroup to use is file->f_dentry->d_parent->d_fsdata
275 276 277
 *	- the 'cftype' of the file is file->f_dentry->d_fsdata
 */

278 279
/* cftype->flags */
#define CFTYPE_ONLY_ON_ROOT	(1U << 0)	/* only create on root cg */
280
#define CFTYPE_NOT_ON_ROOT	(1U << 1)	/* don't create on root cg */
281 282 283

#define MAX_CFTYPE_NAME		64

284
struct cftype {
P
Paul Menage 已提交
285 286
	/*
	 * By convention, the name should begin with the name of the
287 288
	 * subsystem, followed by a period.  Zero length string indicates
	 * end of cftype array.
P
Paul Menage 已提交
289
	 */
290 291
	char name[MAX_CFTYPE_NAME];
	int private;
L
Li Zefan 已提交
292 293 294 295
	/*
	 * If not 0, file mode is set to this value, otherwise it will
	 * be figured out automatically
	 */
A
Al Viro 已提交
296
	umode_t mode;
297 298 299 300 301 302 303

	/*
	 * If non-zero, defines the maximum length of string that can
	 * be passed to write_string; defaults to 64
	 */
	size_t max_write_len;

304 305 306
	/* CFTYPE_* flags */
	unsigned int flags;

A
Aristeu Rozanski 已提交
307 308 309
	/* file xattrs */
	struct simple_xattrs xattrs;

310 311 312 313
	int (*open)(struct inode *inode, struct file *file);
	ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
			struct file *file,
			char __user *buf, size_t nbytes, loff_t *ppos);
314
	/*
315
	 * read_u64() is a shortcut for the common case of returning a
316 317
	 * single integer. Use it in place of read()
	 */
318
	u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
319 320 321
	/*
	 * read_s64() is a signed version of read_u64()
	 */
322
	s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
323 324 325 326 327 328
	/*
	 * read_map() is used for defining a map of key/value
	 * pairs. It should call cb->fill(cb, key, value) for each
	 * entry. The key/value pairs (and their ordering) should not
	 * change between reboots.
	 */
329 330
	int (*read_map)(struct cgroup *cont, struct cftype *cft,
			struct cgroup_map_cb *cb);
331 332 333 334
	/*
	 * read_seq_string() is used for outputting a simple sequence
	 * using seqfile.
	 */
335 336
	int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
			       struct seq_file *m);
337

338 339 340
	ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
			 struct file *file,
			 const char __user *buf, size_t nbytes, loff_t *ppos);
341 342

	/*
343
	 * write_u64() is a shortcut for the common case of accepting
344 345 346
	 * a single integer (as parsed by simple_strtoull) from
	 * userspace. Use in place of write(); return 0 or error.
	 */
347
	int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
348 349 350
	/*
	 * write_s64() is a signed version of write_u64()
	 */
351
	int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
352

353 354 355 356 357 358 359
	/*
	 * write_string() is passed a nul-terminated kernelspace
	 * buffer of maximum length determined by max_write_len.
	 * Returns 0 or -ve error code.
	 */
	int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
			    const char *buffer);
360 361 362 363 364 365 366 367
	/*
	 * trigger() callback can be used to get some kick from the
	 * userspace, when the actual string written is not important
	 * at all. The private field can be used to determine the
	 * kick type for multiplexing.
	 */
	int (*trigger)(struct cgroup *cgrp, unsigned int event);

368
	int (*release)(struct inode *inode, struct file *file);
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

	/*
	 * register_event() callback will be used to add new userspace
	 * waiter for changes related to the cftype. Implement it if
	 * you want to provide this functionality. Use eventfd_signal()
	 * on eventfd to send notification to userspace.
	 */
	int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
			struct eventfd_ctx *eventfd, const char *args);
	/*
	 * unregister_event() callback will be called when userspace
	 * closes the eventfd or on cgroup removing.
	 * This callback must be implemented, if you want provide
	 * notification functionality.
	 */
384
	void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
385
			struct eventfd_ctx *eventfd);
386 387
};

388 389 390 391 392 393 394
/*
 * cftype_sets describe cftypes belonging to a subsystem and are chained at
 * cgroup_subsys->cftsets.  Each cftset points to an array of cftypes
 * terminated by zero length name.
 */
struct cftype_set {
	struct list_head		node;	/* chained at subsys->cftsets */
A
Aristeu Rozanski 已提交
395
	struct cftype			*cfts;
396 397
};

398 399 400 401 402 403
struct cgroup_scanner {
	struct cgroup *cg;
	int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
	void (*process_task)(struct task_struct *p,
			struct cgroup_scanner *scan);
	struct ptr_heap *heap;
404
	void *data;
405 406
};

A
Aristeu Rozanski 已提交
407 408
int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
int cgroup_rm_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
409

L
Li Zefan 已提交
410
int cgroup_is_removed(const struct cgroup *cgrp);
411

L
Li Zefan 已提交
412
int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
413

L
Li Zefan 已提交
414
int cgroup_task_count(const struct cgroup *cgrp);
415

416 417
/* Return true if cgrp is a descendant of the task's cgroup */
int cgroup_is_descendant(const struct cgroup *cgrp, struct task_struct *task);
418

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
/*
 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
 * methods.
 */
struct cgroup_taskset;
struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
struct cgroup *cgroup_taskset_cur_cgroup(struct cgroup_taskset *tset);
int cgroup_taskset_size(struct cgroup_taskset *tset);

/**
 * cgroup_taskset_for_each - iterate cgroup_taskset
 * @task: the loop cursor
 * @skip_cgrp: skip if task's cgroup matches this, %NULL to iterate through all
 * @tset: taskset to iterate
 */
#define cgroup_taskset_for_each(task, skip_cgrp, tset)			\
	for ((task) = cgroup_taskset_first((tset)); (task);		\
	     (task) = cgroup_taskset_next((tset)))			\
		if (!(skip_cgrp) ||					\
		    cgroup_taskset_cur_cgroup((tset)) != (skip_cgrp))

441 442 443 444
/*
 * Control Group subsystem type.
 * See Documentation/cgroups/cgroups.txt for details
 */
445 446

struct cgroup_subsys {
447 448 449 450 451
	struct cgroup_subsys_state *(*css_alloc)(struct cgroup *cgrp);
	int (*css_online)(struct cgroup *cgrp);
	void (*css_offline)(struct cgroup *cgrp);
	void (*css_free)(struct cgroup *cgrp);

452 453 454 455 456 457 458
	int (*can_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
	void (*cancel_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
	void (*attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
	void (*fork)(struct task_struct *task);
	void (*exit)(struct cgroup *cgrp, struct cgroup *old_cgrp,
		     struct task_struct *task);
	void (*bind)(struct cgroup *root);
459

460 461
	int subsys_id;
	int active;
462
	int disabled;
463
	int early_init;
K
KAMEZAWA Hiroyuki 已提交
464 465 466 467 468
	/*
	 * True if this subsys uses ID. ID is not available before cgroup_init()
	 * (not available in early_init time.)
	 */
	bool use_id;
469

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
	/*
	 * If %false, this subsystem is properly hierarchical -
	 * configuration, resource accounting and restriction on a parent
	 * cgroup cover those of its children.  If %true, hierarchy support
	 * is broken in some ways - some subsystems ignore hierarchy
	 * completely while others are only implemented half-way.
	 *
	 * It's now disallowed to create nested cgroups if the subsystem is
	 * broken and cgroup core will emit a warning message on such
	 * cases.  Eventually, all subsystems will be made properly
	 * hierarchical and this will go away.
	 */
	bool broken_hierarchy;
	bool warned_broken_hierarchy;

485 486 487
#define MAX_CGROUP_TYPE_NAMELEN 32
	const char *name;

488 489
	/*
	 * Link to parent, and list entry in parent's children.
L
Li Zefan 已提交
490
	 * Protected by cgroup_lock()
491 492
	 */
	struct cgroupfs_root *root;
493
	struct list_head sibling;
K
KAMEZAWA Hiroyuki 已提交
494 495
	/* used when use_id == true */
	struct idr idr;
496
	spinlock_t id_lock;
497

498 499 500 501 502 503 504
	/* list of cftype_sets */
	struct list_head cftsets;

	/* base cftypes, automatically [de]registered with subsys itself */
	struct cftype *base_cftypes;
	struct cftype_set base_cftset;

505 506
	/* should be defined only by modular subsystems */
	struct module *module;
507 508 509
};

#define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
510
#define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
511
#include <linux/cgroup_subsys.h>
512
#undef IS_SUBSYS_ENABLED
513 514 515
#undef SUBSYS

static inline struct cgroup_subsys_state *cgroup_subsys_state(
L
Li Zefan 已提交
516
	struct cgroup *cgrp, int subsys_id)
517
{
L
Li Zefan 已提交
518
	return cgrp->subsys[subsys_id];
519 520
}

521 522 523 524 525 526 527 528 529 530 531 532
/*
 * function to get the cgroup_subsys_state which allows for extra
 * rcu_dereference_check() conditions, such as locks used during the
 * cgroup_subsys::attach() methods.
 */
#define task_subsys_state_check(task, subsys_id, __c)			\
	rcu_dereference_check(task->cgroups->subsys[subsys_id],		\
			      lockdep_is_held(&task->alloc_lock) ||	\
			      cgroup_lock_is_held() || (__c))

static inline struct cgroup_subsys_state *
task_subsys_state(struct task_struct *task, int subsys_id)
533
{
534
	return task_subsys_state_check(task, subsys_id, false);
535 536 537 538 539 540 541 542
}

static inline struct cgroup* task_cgroup(struct task_struct *task,
					       int subsys_id)
{
	return task_subsys_state(task, subsys_id)->cgroup;
}

543 544 545 546 547 548
/**
 * cgroup_for_each_child - iterate through children of a cgroup
 * @pos: the cgroup * to use as the loop cursor
 * @cgroup: cgroup whose children to walk
 *
 * Walk @cgroup's children.  Must be called under rcu_read_lock().  A child
549 550
 * cgroup which hasn't finished ->css_online() or already has finished
 * ->css_offline() may show up during traversal and it's each subsystem's
551 552
 * responsibility to verify that each @pos is alive.
 *
553 554 555
 * If a subsystem synchronizes against the parent in its ->css_online() and
 * before starting iterating, a cgroup which finished ->css_online() is
 * guaranteed to be visible in the future iterations.
556 557 558 559 560 561
 */
#define cgroup_for_each_child(pos, cgroup)				\
	list_for_each_entry_rcu(pos, &(cgroup)->children, sibling)

struct cgroup *cgroup_next_descendant_pre(struct cgroup *pos,
					  struct cgroup *cgroup);
562
struct cgroup *cgroup_rightmost_descendant(struct cgroup *pos);
563 564 565 566 567 568 569

/**
 * cgroup_for_each_descendant_pre - pre-order walk of a cgroup's descendants
 * @pos: the cgroup * to use as the loop cursor
 * @cgroup: cgroup whose descendants to walk
 *
 * Walk @cgroup's descendants.  Must be called under rcu_read_lock().  A
570 571
 * descendant cgroup which hasn't finished ->css_online() or already has
 * finished ->css_offline() may show up during traversal and it's each
572 573
 * subsystem's responsibility to verify that each @pos is alive.
 *
574 575 576
 * If a subsystem synchronizes against the parent in its ->css_online() and
 * before starting iterating, and synchronizes against @pos on each
 * iteration, any descendant cgroup which finished ->css_offline() is
577 578 579 580 581
 * guaranteed to be visible in the future iterations.
 *
 * In other words, the following guarantees that a descendant can't escape
 * state updates of its ancestors.
 *
582
 * my_online(@cgrp)
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
 * {
 *	Lock @cgrp->parent and @cgrp;
 *	Inherit state from @cgrp->parent;
 *	Unlock both.
 * }
 *
 * my_update_state(@cgrp)
 * {
 *	Lock @cgrp;
 *	Update @cgrp's state;
 *	Unlock @cgrp;
 *
 *	cgroup_for_each_descendant_pre(@pos, @cgrp) {
 *		Lock @pos;
 *		Verify @pos is alive and inherit state from @pos->parent;
 *		Unlock @pos;
 *	}
 * }
 *
 * As long as the inheriting step, including checking the parent state, is
 * enclosed inside @pos locking, double-locking the parent isn't necessary
 * while inheriting.  The state update to the parent is guaranteed to be
 * visible by walking order and, as long as inheriting operations to the
 * same @pos are atomic to each other, multiple updates racing each other
 * still result in the correct state.  It's guaranateed that at least one
 * inheritance happens for any cgroup after the latest update to its
 * parent.
 *
 * If checking parent's state requires locking the parent, each inheriting
 * iteration should lock and unlock both @pos->parent and @pos.
 *
 * Alternatively, a subsystem may choose to use a single global lock to
615
 * synchronize ->css_online() and ->css_offline() against tree-walking
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
 * operations.
 */
#define cgroup_for_each_descendant_pre(pos, cgroup)			\
	for (pos = cgroup_next_descendant_pre(NULL, (cgroup)); (pos);	\
	     pos = cgroup_next_descendant_pre((pos), (cgroup)))

struct cgroup *cgroup_next_descendant_post(struct cgroup *pos,
					   struct cgroup *cgroup);

/**
 * cgroup_for_each_descendant_post - post-order walk of a cgroup's descendants
 * @pos: the cgroup * to use as the loop cursor
 * @cgroup: cgroup whose descendants to walk
 *
 * Similar to cgroup_for_each_descendant_pre() but performs post-order
 * traversal instead.  Note that the walk visibility guarantee described in
 * pre-order walk doesn't apply the same to post-order walks.
 */
#define cgroup_for_each_descendant_post(pos, cgroup)			\
	for (pos = cgroup_next_descendant_post(NULL, (cgroup)); (pos);	\
	     pos = cgroup_next_descendant_post((pos), (cgroup)))

638 639 640 641 642 643
/* A cgroup_iter should be treated as an opaque object */
struct cgroup_iter {
	struct list_head *cg_link;
	struct list_head *task;
};

P
Paul Menage 已提交
644 645
/*
 * To iterate across the tasks in a cgroup:
646
 *
647
 * 1) call cgroup_iter_start to initialize an iterator
648 649 650 651 652
 *
 * 2) call cgroup_iter_next() to retrieve member tasks until it
 *    returns NULL or until you want to end the iteration
 *
 * 3) call cgroup_iter_end() to destroy the iterator.
653
 *
P
Paul Menage 已提交
654 655 656 657
 * Or, call cgroup_scan_tasks() to iterate through every task in a
 * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
 * the test_task() callback, but not while calling the process_task()
 * callback.
658
 */
L
Li Zefan 已提交
659 660
void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
661
					struct cgroup_iter *it);
L
Li Zefan 已提交
662
void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
663
int cgroup_scan_tasks(struct cgroup_scanner *scan);
664
int cgroup_attach_task(struct cgroup *, struct task_struct *);
M
Michael S. Tsirkin 已提交
665 666
int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);

K
KAMEZAWA Hiroyuki 已提交
667 668 669 670 671 672 673 674
/*
 * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
 * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
 * CSS ID is assigned at cgroup allocation (create) automatically
 * and removed when subsys calls free_css_id() function. This is because
 * the lifetime of cgroup_subsys_state is subsys's matter.
 *
 * Looking up and scanning function should be called under rcu_read_lock().
L
Li Zefan 已提交
675
 * Taking cgroup_mutex is not necessary for following calls.
K
KAMEZAWA Hiroyuki 已提交
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
 * But the css returned by this routine can be "not populated yet" or "being
 * destroyed". The caller should check css and cgroup's status.
 */

/*
 * Typically Called at ->destroy(), or somewhere the subsys frees
 * cgroup_subsys_state.
 */
void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);

/* Find a cgroup_subsys_state which has given ID */

struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);

/*
 * Get a cgroup whose id is greater than or equal to id under tree of root.
 * Returning a cgroup_subsys_state or NULL.
 */
struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
		struct cgroup_subsys_state *root, int *foundid);

/* Returns true if root is ancestor of cg */
bool css_is_ancestor(struct cgroup_subsys_state *cg,
699
		     const struct cgroup_subsys_state *root);
K
KAMEZAWA Hiroyuki 已提交
700 701 702 703

/* Get id and depth of css */
unsigned short css_id(struct cgroup_subsys_state *css);
unsigned short css_depth(struct cgroup_subsys_state *css);
S
Stephane Eranian 已提交
704
struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
K
KAMEZAWA Hiroyuki 已提交
705

706 707 708 709
#else /* !CONFIG_CGROUPS */

static inline int cgroup_init_early(void) { return 0; }
static inline int cgroup_init(void) { return 0; }
710
static inline void cgroup_fork(struct task_struct *p) {}
711
static inline void cgroup_post_fork(struct task_struct *p) {}
712
static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
713 714 715

static inline void cgroup_lock(void) {}
static inline void cgroup_unlock(void) {}
B
Balbir Singh 已提交
716 717 718 719 720
static inline int cgroupstats_build(struct cgroupstats *stats,
					struct dentry *dentry)
{
	return -EINVAL;
}
721

722
/* No cgroups - nothing to do */
M
Michael S. Tsirkin 已提交
723 724 725 726 727
static inline int cgroup_attach_task_all(struct task_struct *from,
					 struct task_struct *t)
{
	return 0;
}
728

729 730 731
#endif /* !CONFIG_CGROUPS */

#endif /* _LINUX_CGROUP_H */