cgroup.h 25.8 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
#include <linux/fs.h>
23
#include <linux/percpu-refcount.h>
24
#include <linux/seq_file.h>
25 26 27 28 29 30

#ifdef CONFIG_CGROUPS

struct cgroupfs_root;
struct cgroup_subsys;
struct inode;
31
struct cgroup;
32 33 34

extern int cgroup_init_early(void);
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, int run_callbacks);
B
Balbir Singh 已提交
38 39
extern int cgroupstats_build(struct cgroupstats *stats,
				struct dentry *dentry);
40

41
extern int proc_cgroup_show(struct seq_file *, void *);
42

T
Tejun Heo 已提交
43
/* define the enumeration of all cgroup subsystems */
44
#define SUBSYS(_x) _x ## _cgrp_id,
45 46
enum cgroup_subsys_id {
#include <linux/cgroup_subsys.h>
47
	CGROUP_SUBSYS_COUNT,
48 49 50
};
#undef SUBSYS

51 52
/* Per-subsystem/per-cgroup state maintained by the system. */
struct cgroup_subsys_state {
53
	/* the cgroup that this css is attached to */
54 55
	struct cgroup *cgroup;

56 57 58
	/* the cgroup subsystem that this css is attached to */
	struct cgroup_subsys *ss;

59 60
	/* reference count - access via css_[try]get() and css_put() */
	struct percpu_ref refcnt;
61

62 63 64
	/* the parent css */
	struct cgroup_subsys_state *parent;

65
	unsigned long flags;
66

67 68
	/* percpu_ref killing and RCU release */
	struct rcu_head rcu_head;
69
	struct work_struct destroy_work;
70 71 72 73
};

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

78 79 80 81 82
/**
 * css_get - obtain a reference on the specified css
 * @css: target css
 *
 * The caller must already have a reference.
83 84 85 86
 */
static inline void css_get(struct cgroup_subsys_state *css)
{
	/* We don't need to reference count the root state */
87
	if (!(css->flags & CSS_ROOT))
88
		percpu_ref_get(&css->refcnt);
89
}
P
Paul Menage 已提交
90

91 92 93 94 95 96 97 98 99 100
/**
 * css_tryget - try to obtain a reference on the specified css
 * @css: target css
 *
 * Obtain a reference on @css if it's alive.  The caller naturally needs to
 * ensure that @css is accessible but doesn't have to be holding a
 * reference on it - IOW, RCU protected access is good enough for this
 * function.  Returns %true if a reference count was successfully obtained;
 * %false otherwise.
 */
P
Paul Menage 已提交
101 102
static inline bool css_tryget(struct cgroup_subsys_state *css)
{
103
	if (css->flags & CSS_ROOT)
P
Paul Menage 已提交
104
		return true;
105
	return percpu_ref_tryget(&css->refcnt);
P
Paul Menage 已提交
106 107
}

108 109 110 111 112 113
/**
 * css_put - put a css reference
 * @css: target css
 *
 * Put a reference obtained via css_get() and css_tryget().
 */
114 115
static inline void css_put(struct cgroup_subsys_state *css)
{
116
	if (!(css->flags & CSS_ROOT))
117
		percpu_ref_put(&css->refcnt);
118 119
}

120 121 122
/* bits in struct cgroup flags field */
enum {
	/* Control Group is dead */
123
	CGRP_DEAD,
P
Paul Menage 已提交
124 125 126 127
	/*
	 * Control Group has previously had a child cgroup or a task,
	 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
	 */
128 129 130
	CGRP_RELEASABLE,
	/* Control Group requires release notifications to userspace */
	CGRP_NOTIFY_ON_RELEASE,
131
	/*
132 133 134
	 * 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.
135
	 */
136
	CGRP_CPUSET_CLONE_CHILDREN,
137 138
	/* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
	CGRP_SANE_BEHAVIOR,
139 140
};

141 142 143
struct cgroup_name {
	struct rcu_head rcu_head;
	char name[];
144 145
};

146 147 148
struct cgroup {
	unsigned long flags;		/* "unsigned long" so bitops work */

149 150 151 152 153
	/*
	 * idr allocated in-hierarchy ID.
	 *
	 * The ID of the root cgroup is always 0, and a new cgroup
	 * will be assigned with a smallest available ID.
154 155
	 *
	 * Allocating/Removing ID must be protected by cgroup_mutex.
156 157
	 */
	int id;
T
Tejun Heo 已提交
158

159 160 161
	/* the number of attached css's */
	int nr_css;

162 163 164 165 166 167
	/*
	 * 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 已提交
168
	struct list_head files;		/* my files */
169

P
Paul Menage 已提交
170
	struct cgroup *parent;		/* my parent */
171
	struct dentry *dentry;		/* cgroup fs entry, RCU protected */
172

173 174 175 176 177 178 179 180
	/*
	 * Monotonically increasing unique serial number which defines a
	 * uniform order among all cgroups.  It's guaranteed that all
	 * ->children lists are in the ascending order of ->serial_nr.
	 * It's used to allow interrupting and resuming iterations.
	 */
	u64 serial_nr;

181 182 183 184 185 186 187 188 189 190 191 192 193
	/*
	 * This is a copy of dentry->d_name, and it's needed because
	 * we can't use dentry->d_name in cgroup_path().
	 *
	 * You must acquire rcu_read_lock() to access cgrp->name, and
	 * the only place that can change it is rename(), which is
	 * protected by parent dir's i_mutex.
	 *
	 * Normally you should use cgroup_name() wrapper rather than
	 * access it directly.
	 */
	struct cgroup_name __rcu *name;

194
	/* Private pointers for each registered subsystem */
195
	struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
196 197

	struct cgroupfs_root *root;
198 199

	/*
200 201
	 * List of cgrp_cset_links pointing at css_sets with tasks in this
	 * cgroup.  Protected by css_set_lock.
202
	 */
203
	struct list_head cset_links;
204 205 206 207 208 209 210

	/*
	 * 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;
211

212 213 214 215 216 217
	/*
	 * 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;
218

T
Tejun Heo 已提交
219 220 221
	/* dummy css with NULL ->ss, points back to this cgroup */
	struct cgroup_subsys_state dummy_css;

222
	/* For css percpu_ref killing and RCU-protected deletion */
223
	struct rcu_head rcu_head;
224
	struct work_struct destroy_work;
225

A
Aristeu Rozanski 已提交
226 227
	/* directory xattrs */
	struct simple_xattrs xattrs;
228 229
};

230 231 232 233
#define MAX_CGROUP_ROOT_NAMELEN 64

/* cgroupfs_root->flags */
enum {
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
	/*
	 * Unfortunately, cgroup core and various controllers are riddled
	 * with idiosyncrasies and pointless options.  The following flag,
	 * when set, will force sane behavior - some options are forced on,
	 * others are disallowed, and some controllers will change their
	 * hierarchical or other behaviors.
	 *
	 * The set of behaviors affected by this flag are still being
	 * determined and developed and the mount option for this flag is
	 * prefixed with __DEVEL__.  The prefix will be dropped once we
	 * reach the point where all behaviors are compatible with the
	 * planned unified hierarchy, which will automatically turn on this
	 * flag.
	 *
	 * The followings are the behaviors currently affected this flag.
	 *
	 * - Mount options "noprefix" and "clone_children" are disallowed.
	 *   Also, cgroupfs file cgroup.clone_children is not created.
	 *
	 * - When mounting an existing superblock, mount options should
	 *   match.
	 *
	 * - Remount is disallowed.
	 *
258 259
	 * - rename(2) is disallowed.
	 *
260 261
	 * - "tasks" is removed.  Everything should be at process
	 *   granularity.  Use "cgroup.procs" instead.
262
	 *
263 264 265
	 * - "cgroup.procs" is not sorted.  pids will be unique unless they
	 *   got recycled inbetween reads.
	 *
266 267
	 * - "release_agent" and "notify_on_release" are removed.
	 *   Replacement notification mechanism will be implemented.
268
	 *
269 270 271 272
	 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
	 *   and take masks of ancestors with non-empty cpus/mems, instead of
	 *   being moved to an ancestor.
	 *
273 274
	 * - cpuset: a task can be moved into an empty cpuset, and again it
	 *   takes masks of ancestors.
275
	 *
276 277
	 * - memcg: use_hierarchy is on by default and the cgroup file for
	 *   the flag is not created.
278
	 *
279
	 * - blkcg: blk-throttle becomes properly hierarchical.
280 281 282
	 */
	CGRP_ROOT_SANE_BEHAVIOR	= (1 << 0),

283 284
	CGRP_ROOT_NOPREFIX	= (1 << 1), /* mounted subsystems have no named prefix */
	CGRP_ROOT_XATTR		= (1 << 2), /* supports extended attributes */
285 286 287 288 289

	/* mount options live below bit 16 */
	CGRP_ROOT_OPTION_MASK	= (1 << 16) - 1,

	CGRP_ROOT_SUBSYS_BOUND	= (1 << 16), /* subsystems finished binding */
290 291 292 293 294 295 296 297 298 299
};

/*
 * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
 * associated with a superblock to form an active hierarchy.  This is
 * internal to cgroup core.  Don't access directly from controllers.
 */
struct cgroupfs_root {
	struct super_block *sb;

300
	/* The bitmask of subsystems attached to this hierarchy */
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	unsigned long subsys_mask;

	/* Unique id for this hierarchy. */
	int hierarchy_id;

	/* The root cgroup for this hierarchy */
	struct cgroup top_cgroup;

	/* Tracks how many cgroups are currently defined in hierarchy.*/
	int number_of_cgroups;

	/* A list running through the active hierarchies */
	struct list_head root_list;

	/* Hierarchy-specific flags */
	unsigned long flags;

	/* IDs for cgroups in this hierarchy */
319
	struct idr cgroup_idr;
320 321 322 323 324 325 326 327

	/* The path to use for release notifications. */
	char release_agent_path[PATH_MAX];

	/* The name for this hierarchy - may be empty */
	char name[MAX_CGROUP_ROOT_NAMELEN];
};

P
Paul Menage 已提交
328 329
/*
 * A css_set is a structure holding pointers to a set of
330 331
 * 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 已提交
332 333
 * list_add()/del() can bump the reference count on the entire cgroup
 * set for a task.
334 335 336 337 338
 */

struct css_set {

	/* Reference count */
339
	atomic_t refcount;
340

341 342 343 344 345 346
	/*
	 * List running through all cgroup groups in the same hash
	 * slot. Protected by css_set_lock
	 */
	struct hlist_node hlist;

347 348 349 350 351 352 353
	/*
	 * List running through all tasks using this cgroup
	 * group. Protected by css_set_lock
	 */
	struct list_head tasks;

	/*
354 355
	 * List of cgrp_cset_links pointing at cgroups referenced from this
	 * css_set.  Protected by css_set_lock.
356
	 */
357
	struct list_head cgrp_links;
358 359

	/*
T
Tejun Heo 已提交
360 361 362
	 * Set of subsystem states, one for each subsystem. This array is
	 * immutable after creation apart from the init_css_set during
	 * subsystem registration (at boot time).
363 364
	 */
	struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
365 366 367

	/* For RCU-protected deletion */
	struct rcu_head rcu_head;
368 369
};

P
Paul Menage 已提交
370 371
/*
 * struct cftype: handler definitions for cgroup control files
372 373
 *
 * When reading/writing to a file:
L
Li Zefan 已提交
374
 *	- the cgroup to use is file->f_dentry->d_parent->d_fsdata
375 376 377
 *	- the 'cftype' of the file is file->f_dentry->d_fsdata
 */

378
/* cftype->flags */
379
enum {
L
Li Zefan 已提交
380 381
	CFTYPE_ONLY_ON_ROOT	= (1 << 0),	/* only create on root cgrp */
	CFTYPE_NOT_ON_ROOT	= (1 << 1),	/* don't create on root cgrp */
382
	CFTYPE_INSANE		= (1 << 2),	/* don't create if sane_behavior */
T
Tejun Heo 已提交
383
	CFTYPE_NO_PREFIX	= (1 << 3),	/* (DON'T USE FOR NEW FILES) no subsys prefix */
384
};
385 386 387

#define MAX_CFTYPE_NAME		64

388
struct cftype {
P
Paul Menage 已提交
389 390
	/*
	 * By convention, the name should begin with the name of the
391 392
	 * subsystem, followed by a period.  Zero length string indicates
	 * end of cftype array.
P
Paul Menage 已提交
393
	 */
394 395
	char name[MAX_CFTYPE_NAME];
	int private;
L
Li Zefan 已提交
396 397 398 399
	/*
	 * If not 0, file mode is set to this value, otherwise it will
	 * be figured out automatically
	 */
A
Al Viro 已提交
400
	umode_t mode;
401 402

	/*
403 404 405
	 * The maximum length of string, excluding trailing nul, that can
	 * be passed to write_string.  If < PAGE_SIZE-1, PAGE_SIZE-1 is
	 * assumed.
406 407 408
	 */
	size_t max_write_len;

409 410 411
	/* CFTYPE_* flags */
	unsigned int flags;

412 413 414 415 416 417
	/*
	 * The subsys this file belongs to.  Initialized automatically
	 * during registration.  NULL for cgroup core files.
	 */
	struct cgroup_subsys *ss;

418
	/*
419
	 * read_u64() is a shortcut for the common case of returning a
420 421
	 * single integer. Use it in place of read()
	 */
422
	u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
423 424 425
	/*
	 * read_s64() is a signed version of read_u64()
	 */
426
	s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
427 428 429

	/* generic seq_file read interface */
	int (*seq_show)(struct seq_file *sf, void *v);
430

431 432 433 434 435
	/* optional ops, implement all or none */
	void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
	void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
	void (*seq_stop)(struct seq_file *sf, void *v);

436
	/*
437
	 * write_u64() is a shortcut for the common case of accepting
438 439 440
	 * a single integer (as parsed by simple_strtoull) from
	 * userspace. Use in place of write(); return 0 or error.
	 */
441 442
	int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
			 u64 val);
443 444 445
	/*
	 * write_s64() is a signed version of write_u64()
	 */
446 447
	int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
			 s64 val);
448

449 450 451 452 453
	/*
	 * write_string() is passed a nul-terminated kernelspace
	 * buffer of maximum length determined by max_write_len.
	 * Returns 0 or -ve error code.
	 */
454
	int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
455
			    const char *buffer);
456 457 458 459 460 461
	/*
	 * 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.
	 */
462
	int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
463 464
};

465 466 467 468 469 470 471
/*
 * 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 已提交
472
	struct cftype			*cfts;
473 474
};

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/*
 * cgroupfs file entry, pointed to from leaf dentry->d_fsdata.  Don't
 * access directly.
 */
struct cfent {
	struct list_head		node;
	struct dentry			*dentry;
	struct cftype			*type;
	struct cgroup_subsys_state	*css;

	/* file xattrs */
	struct simple_xattrs		xattrs;
};

/* seq_file->private points to the following, only ->priv is public */
struct cgroup_open_file {
	struct cfent			*cfe;
	void				*priv;
};

495 496 497 498 499 500 501 502 503
/*
 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
 * function can be called as long as @cgrp is accessible.
 */
static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
{
	return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
}

504 505 506 507 508 509
/* Caller should hold rcu_read_lock() */
static inline const char *cgroup_name(const struct cgroup *cgrp)
{
	return rcu_dereference(cgrp->name)->name;
}

510 511 512 513 514 515 516 517 518 519 520 521
static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
{
	struct cgroup_open_file *of = seq->private;
	return of->cfe->css;
}

static inline struct cftype *seq_cft(struct seq_file *seq)
{
	struct cgroup_open_file *of = seq->private;
	return of->cfe->type;
}

A
Aristeu Rozanski 已提交
522
int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
523
int cgroup_rm_cftypes(struct cftype *cfts);
524

525
bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
526

L
Li Zefan 已提交
527
int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
528
int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
529

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

532 533 534 535 536 537 538
/*
 * 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);
539 540
struct cgroup_subsys_state *cgroup_taskset_cur_css(struct cgroup_taskset *tset,
						   int subsys_id);
541 542 543 544 545
int cgroup_taskset_size(struct cgroup_taskset *tset);

/**
 * cgroup_taskset_for_each - iterate cgroup_taskset
 * @task: the loop cursor
546
 * @skip_css: skip if task's css matches this, %NULL to iterate through all
547 548
 * @tset: taskset to iterate
 */
549
#define cgroup_taskset_for_each(task, skip_css, tset)			\
550 551
	for ((task) = cgroup_taskset_first((tset)); (task);		\
	     (task) = cgroup_taskset_next((tset)))			\
552 553
		if (!(skip_css) ||					\
		    cgroup_taskset_cur_css((tset),			\
554
			(skip_css)->ss->id) != (skip_css))
555

556 557 558 559
/*
 * Control Group subsystem type.
 * See Documentation/cgroups/cgroups.txt for details
 */
560 561

struct cgroup_subsys {
562 563 564 565 566 567 568 569 570 571 572
	struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
	int (*css_online)(struct cgroup_subsys_state *css);
	void (*css_offline)(struct cgroup_subsys_state *css);
	void (*css_free)(struct cgroup_subsys_state *css);

	int (*can_attach)(struct cgroup_subsys_state *css,
			  struct cgroup_taskset *tset);
	void (*cancel_attach)(struct cgroup_subsys_state *css,
			      struct cgroup_taskset *tset);
	void (*attach)(struct cgroup_subsys_state *css,
		       struct cgroup_taskset *tset);
573
	void (*fork)(struct task_struct *task);
574 575
	void (*exit)(struct cgroup_subsys_state *css,
		     struct cgroup_subsys_state *old_css,
576
		     struct task_struct *task);
577
	void (*bind)(struct cgroup_subsys_state *root_css);
578

579
	int disabled;
580
	int early_init;
581

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
	/*
	 * 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;

597
	/* the following two fields are initialized automtically during boot */
598
	int id;
599 600 601
#define MAX_CGROUP_TYPE_NAMELEN 32
	const char *name;

T
Tejun Heo 已提交
602
	/* link to parent, protected by cgroup_lock() */
603
	struct cgroupfs_root *root;
604

605 606 607
	/* list of cftype_sets */
	struct list_head cftsets;

608
	/* base cftypes, automatically registered with subsys itself */
609
	struct cftype *base_cftypes;
610 611
};

612
#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
613 614 615
#include <linux/cgroup_subsys.h>
#undef SUBSYS

T
Tejun Heo 已提交
616 617 618 619 620 621 622 623 624 625
/**
 * css_parent - find the parent css
 * @css: the target cgroup_subsys_state
 *
 * Return the parent css of @css.  This function is guaranteed to return
 * non-NULL parent as long as @css isn't the root.
 */
static inline
struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
{
626
	return css->parent;
T
Tejun Heo 已提交
627 628
}

629 630 631 632 633 634 635 636 637 638 639 640
/**
 * task_css_set_check - obtain a task's css_set with extra access conditions
 * @task: the task to obtain css_set for
 * @__c: extra condition expression to be passed to rcu_dereference_check()
 *
 * A task's css_set is RCU protected, initialized and exited while holding
 * task_lock(), and can only be modified while holding both cgroup_mutex
 * and task_lock() while the task is alive.  This macro verifies that the
 * caller is inside proper critical section and returns @task's css_set.
 *
 * The caller can also specify additional allowed conditions via @__c, such
 * as locks used during the cgroup_subsys::attach() methods.
641
 */
T
Tejun Heo 已提交
642 643
#ifdef CONFIG_PROVE_RCU
extern struct mutex cgroup_mutex;
644 645 646 647
#define task_css_set_check(task, __c)					\
	rcu_dereference_check((task)->cgroups,				\
		lockdep_is_held(&(task)->alloc_lock) ||			\
		lockdep_is_held(&cgroup_mutex) || (__c))
T
Tejun Heo 已提交
648
#else
649 650
#define task_css_set_check(task, __c)					\
	rcu_dereference((task)->cgroups)
T
Tejun Heo 已提交
651
#endif
652

653
/**
654
 * task_css_check - obtain css for (task, subsys) w/ extra access conds
655 656 657 658 659 660 661
 * @task: the target task
 * @subsys_id: the target subsystem ID
 * @__c: extra condition expression to be passed to rcu_dereference_check()
 *
 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
 * synchronization rules are the same as task_css_set_check().
 */
662
#define task_css_check(task, subsys_id, __c)				\
663 664 665 666 667 668 669 670 671 672 673 674 675 676
	task_css_set_check((task), (__c))->subsys[(subsys_id)]

/**
 * task_css_set - obtain a task's css_set
 * @task: the task to obtain css_set for
 *
 * See task_css_set_check().
 */
static inline struct css_set *task_css_set(struct task_struct *task)
{
	return task_css_set_check(task, false);
}

/**
677
 * task_css - obtain css for (task, subsys)
678 679 680
 * @task: the target task
 * @subsys_id: the target subsystem ID
 *
681
 * See task_css_check().
682
 */
683 684
static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
						   int subsys_id)
685
{
686
	return task_css_check(task, subsys_id, false);
687 688
}

689 690
static inline struct cgroup *task_cgroup(struct task_struct *task,
					 int subsys_id)
691
{
692
	return task_css(task, subsys_id)->cgroup;
693 694
}

695 696
struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
					   struct cgroup_subsys_state *parent);
697

698 699
struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);

700
/**
701 702 703
 * css_for_each_child - iterate through children of a css
 * @pos: the css * to use as the loop cursor
 * @parent: css whose children to walk
704
 *
705 706
 * Walk @parent's children.  Must be called under rcu_read_lock().  A child
 * css which hasn't finished ->css_online() or already has finished
707
 * ->css_offline() may show up during traversal and it's each subsystem's
708 709
 * responsibility to verify that each @pos is alive.
 *
710
 * If a subsystem synchronizes against the parent in its ->css_online() and
711
 * before starting iterating, a css which finished ->css_online() is
712
 * guaranteed to be visible in the future iterations.
713 714 715 716
 *
 * It is allowed to temporarily drop RCU read lock during iteration.  The
 * caller is responsible for ensuring that @pos remains accessible until
 * the start of the next iteration by, for example, bumping the css refcnt.
717
 */
718 719 720
#define css_for_each_child(pos, parent)					\
	for ((pos) = css_next_child(NULL, (parent)); (pos);		\
	     (pos) = css_next_child((pos), (parent)))
721

722 723 724 725 726 727
struct cgroup_subsys_state *
css_next_descendant_pre(struct cgroup_subsys_state *pos,
			struct cgroup_subsys_state *css);

struct cgroup_subsys_state *
css_rightmost_descendant(struct cgroup_subsys_state *pos);
728 729

/**
730 731 732
 * css_for_each_descendant_pre - pre-order walk of a css's descendants
 * @pos: the css * to use as the loop cursor
 * @root: css whose descendants to walk
733
 *
734 735
 * Walk @root's descendants.  @root is included in the iteration and the
 * first node to be visited.  Must be called under rcu_read_lock().  A
736
 * descendant css which hasn't finished ->css_online() or already has
737
 * finished ->css_offline() may show up during traversal and it's each
738 739
 * subsystem's responsibility to verify that each @pos is alive.
 *
740 741
 * If a subsystem synchronizes against the parent in its ->css_online() and
 * before starting iterating, and synchronizes against @pos on each
742
 * iteration, any descendant css which finished ->css_online() is
743 744 745 746 747
 * 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.
 *
748
 * my_online(@css)
749
 * {
750 751
 *	Lock @css's parent and @css;
 *	Inherit state from the parent;
752 753 754
 *	Unlock both.
 * }
 *
755
 * my_update_state(@css)
756
 * {
757
 *	css_for_each_descendant_pre(@pos, @css) {
758
 *		Lock @pos;
759 760 761 762
 *		if (@pos == @css)
 *			Update @css's state;
 *		else
 *			Verify @pos is alive and inherit state from its parent;
763 764 765 766 767 768 769 770 771 772
 *		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
773
 * inheritance happens for any css after the latest update to its parent.
774 775 776 777 778
 *
 * 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
779
 * synchronize ->css_online() and ->css_offline() against tree-walking
780
 * operations.
781 782 783 784
 *
 * It is allowed to temporarily drop RCU read lock during iteration.  The
 * caller is responsible for ensuring that @pos remains accessible until
 * the start of the next iteration by, for example, bumping the css refcnt.
785
 */
786 787 788
#define css_for_each_descendant_pre(pos, css)				\
	for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);	\
	     (pos) = css_next_descendant_pre((pos), (css)))
789

790 791 792
struct cgroup_subsys_state *
css_next_descendant_post(struct cgroup_subsys_state *pos,
			 struct cgroup_subsys_state *css);
793 794

/**
795 796 797
 * css_for_each_descendant_post - post-order walk of a css's descendants
 * @pos: the css * to use as the loop cursor
 * @css: css whose descendants to walk
798
 *
799
 * Similar to css_for_each_descendant_pre() but performs post-order
800 801 802
 * traversal instead.  @root is included in the iteration and the last
 * node to be visited.  Note that the walk visibility guarantee described
 * in pre-order walk doesn't apply the same to post-order walks.
803
 */
804 805 806
#define css_for_each_descendant_post(pos, css)				\
	for ((pos) = css_next_descendant_post(NULL, (css)); (pos);	\
	     (pos) = css_next_descendant_post((pos), (css)))
807

808 809 810
/* A css_task_iter should be treated as an opaque object */
struct css_task_iter {
	struct cgroup_subsys_state	*origin_css;
811 812
	struct list_head		*cset_link;
	struct list_head		*task;
813 814
};

815 816 817 818
void css_task_iter_start(struct cgroup_subsys_state *css,
			 struct css_task_iter *it);
struct task_struct *css_task_iter_next(struct css_task_iter *it);
void css_task_iter_end(struct css_task_iter *it);
T
Tejun Heo 已提交
819

820 821 822 823
int css_scan_tasks(struct cgroup_subsys_state *css,
		   bool (*test)(struct task_struct *, void *),
		   void (*process)(struct task_struct *, void *),
		   void *data, struct ptr_heap *heap);
T
Tejun Heo 已提交
824

M
Michael S. Tsirkin 已提交
825
int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
826
int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
M
Michael S. Tsirkin 已提交
827

828 829
struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
						struct cgroup_subsys *ss);
K
KAMEZAWA Hiroyuki 已提交
830

831 832 833 834
#else /* !CONFIG_CGROUPS */

static inline int cgroup_init_early(void) { return 0; }
static inline int cgroup_init(void) { return 0; }
835
static inline void cgroup_fork(struct task_struct *p) {}
836
static inline void cgroup_post_fork(struct task_struct *p) {}
837
static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
838

B
Balbir Singh 已提交
839 840 841 842 843
static inline int cgroupstats_build(struct cgroupstats *stats,
					struct dentry *dentry)
{
	return -EINVAL;
}
844

845
/* No cgroups - nothing to do */
M
Michael S. Tsirkin 已提交
846 847 848 849 850
static inline int cgroup_attach_task_all(struct task_struct *from,
					 struct task_struct *t)
{
	return 0;
}
851

852 853 854
#endif /* !CONFIG_CGROUPS */

#endif /* _LINUX_CGROUP_H */