cgroup.h 29.2 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/rwsem.h>
K
KAMEZAWA Hiroyuki 已提交
18
#include <linux/idr.h>
19
#include <linux/workqueue.h>
20
#include <linux/fs.h>
21
#include <linux/percpu-refcount.h>
22
#include <linux/seq_file.h>
T
Tejun Heo 已提交
23
#include <linux/kernfs.h>
24
#include <linux/wait.h>
25 26 27

#ifdef CONFIG_CGROUPS

28
struct cgroup_root;
29
struct cgroup_subsys;
30
struct cgroup;
31 32 33

extern int cgroup_init_early(void);
extern int cgroup_init(void);
34
extern void cgroup_fork(struct task_struct *p);
35
extern void cgroup_post_fork(struct task_struct *p);
36
extern void cgroup_exit(struct task_struct *p);
B
Balbir Singh 已提交
37 38
extern int cgroupstats_build(struct cgroupstats *stats,
				struct dentry *dentry);
39

Z
Zefan Li 已提交
40 41
extern int proc_cgroup_show(struct seq_file *m, struct pid_namespace *ns,
			    struct pid *pid, struct task_struct *tsk);
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

T
Tejun Heo 已提交
51 52 53 54 55 56 57
/*
 * Per-subsystem/per-cgroup state maintained by the system.  This is the
 * fundamental structural building block that controllers deal with.
 *
 * Fields marked with "PI:" are public and immutable and may be accessed
 * directly without synchronization.
 */
58
struct cgroup_subsys_state {
T
Tejun Heo 已提交
59
	/* PI: the cgroup that this css is attached to */
60 61
	struct cgroup *cgroup;

T
Tejun Heo 已提交
62
	/* PI: the cgroup subsystem that this css is attached to */
63 64
	struct cgroup_subsys *ss;

65 66
	/* reference count - access via css_[try]get() and css_put() */
	struct percpu_ref refcnt;
67

T
Tejun Heo 已提交
68
	/* PI: the parent css */
69 70
	struct cgroup_subsys_state *parent;

71 72 73 74
	/* siblings list anchored at the parent's ->children */
	struct list_head sibling;
	struct list_head children;

75
	/*
T
Tejun Heo 已提交
76
	 * PI: Subsys-unique ID.  0 is unused and root is always 1.  The
77 78 79 80
	 * matching css can be looked up using css_from_id().
	 */
	int id;

81
	unsigned int flags;
82

83 84 85 86 87 88 89 90
	/*
	 * Monotonically increasing unique serial number which defines a
	 * uniform order among all csses.  It's guaranteed that all
	 * ->children lists are in the ascending order of ->serial_nr and
	 * used to allow interrupting and resuming iterations.
	 */
	u64 serial_nr;

91 92
	/* percpu_ref killing and RCU release */
	struct rcu_head rcu_head;
93
	struct work_struct destroy_work;
94 95 96 97
};

/* bits in struct cgroup_subsys_state flags field */
enum {
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 */
101 102
};

103 104 105 106 107
/**
 * css_get - obtain a reference on the specified css
 * @css: target css
 *
 * The caller must already have a reference.
108 109 110
 */
static inline void css_get(struct cgroup_subsys_state *css)
{
111 112
	if (!(css->flags & CSS_NO_REF))
		percpu_ref_get(&css->refcnt);
113
}
P
Paul Menage 已提交
114

T
Tejun Heo 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
/**
 * css_tryget - try to obtain a reference on the specified css
 * @css: target css
 *
 * Obtain a reference on @css unless it already has reached zero and is
 * being released.  This function doesn't care whether @css is on or
 * offline.  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.
 */
static inline bool css_tryget(struct cgroup_subsys_state *css)
{
	if (!(css->flags & CSS_NO_REF))
		return percpu_ref_tryget(&css->refcnt);
	return true;
}

133
/**
134
 * css_tryget_online - try to obtain a reference on the specified css if online
135 136
 * @css: target css
 *
137 138
 * Obtain a reference on @css if it's online.  The caller naturally needs
 * to ensure that @css is accessible but doesn't have to be holding a
139 140 141 142
 * reference on it - IOW, RCU protected access is good enough for this
 * function.  Returns %true if a reference count was successfully obtained;
 * %false otherwise.
 */
143
static inline bool css_tryget_online(struct cgroup_subsys_state *css)
P
Paul Menage 已提交
144
{
145 146 147
	if (!(css->flags & CSS_NO_REF))
		return percpu_ref_tryget_live(&css->refcnt);
	return true;
P
Paul Menage 已提交
148 149
}

150 151 152 153
/**
 * css_put - put a css reference
 * @css: target css
 *
154
 * Put a reference obtained via css_get() and css_tryget_online().
155
 */
156 157
static inline void css_put(struct cgroup_subsys_state *css)
{
158 159
	if (!(css->flags & CSS_NO_REF))
		percpu_ref_put(&css->refcnt);
160 161
}

162 163
/* bits in struct cgroup flags field */
enum {
P
Paul Menage 已提交
164 165 166 167
	/*
	 * Control Group has previously had a child cgroup or a task,
	 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
	 */
168 169 170
	CGRP_RELEASABLE,
	/* Control Group requires release notifications to userspace */
	CGRP_NOTIFY_ON_RELEASE,
171
	/*
172 173 174
	 * 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.
175
	 */
176
	CGRP_CPUSET_CLONE_CHILDREN,
177 178
};

179
struct cgroup {
180 181 182
	/* self css with NULL ->ss, points back to this cgroup */
	struct cgroup_subsys_state self;

183 184
	unsigned long flags;		/* "unsigned long" so bitops work */

185 186 187
	/*
	 * idr allocated in-hierarchy ID.
	 *
188 189
	 * ID 0 is not used, the ID of the root cgroup is always 1, and a
	 * new cgroup will be assigned with a smallest available ID.
190 191
	 *
	 * Allocating/Removing ID must be protected by cgroup_mutex.
192 193
	 */
	int id;
T
Tejun Heo 已提交
194

195 196 197 198 199 200 201 202
	/*
	 * If this cgroup contains any tasks, it contributes one to
	 * populated_cnt.  All children with non-zero popuplated_cnt of
	 * their own contribute one.  The count is zero iff there's no task
	 * in this cgroup or its subtree.
	 */
	int populated_cnt;

T
Tejun Heo 已提交
203
	struct kernfs_node *kn;		/* cgroup kernfs entry */
204
	struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
205

206 207 208 209 210
	/*
	 * The bitmask of subsystems enabled on the child cgroups.
	 * ->subtree_control is the one configured through
	 * "cgroup.subtree_control" while ->child_subsys_mask is the
	 * effective one which may have more subsystems enabled.
211 212
	 * Controller knobs are made available iff it's enabled in
	 * ->subtree_control.
213 214
	 */
	unsigned int subtree_control;
215
	unsigned int child_subsys_mask;
216

217
	/* Private pointers for each registered subsystem */
218
	struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
219

220
	struct cgroup_root *root;
221 222

	/*
223 224
	 * List of cgrp_cset_links pointing at css_sets with tasks in this
	 * cgroup.  Protected by css_set_lock.
225
	 */
226
	struct list_head cset_links;
227

T
Tejun Heo 已提交
228 229 230 231 232 233 234 235 236
	/*
	 * On the default hierarchy, a css_set for a cgroup with some
	 * susbsys disabled will point to css's which are associated with
	 * the closest ancestor which has the subsys enabled.  The
	 * following lists all css_sets which point to this cgroup's css
	 * for the given subsystem.
	 */
	struct list_head e_csets[CGROUP_SUBSYS_COUNT];

237 238 239 240 241 242
	/*
	 * 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;
243

244 245
	/* used to wait for offlining of csses */
	wait_queue_head_t offline_waitq;
246 247 248

	/* used to schedule release agent */
	struct work_struct release_agent_work;
249 250
};

251 252
#define MAX_CGROUP_ROOT_NAMELEN 64

253
/* cgroup_root->flags */
254
enum {
255
	CGRP_ROOT_SANE_BEHAVIOR	= (1 << 0), /* __DEVEL__sane_behavior specified */
256 257 258 259 260
	CGRP_ROOT_NOPREFIX	= (1 << 1), /* mounted subsystems have no named prefix */
	CGRP_ROOT_XATTR		= (1 << 2), /* supports extended attributes */
};

/*
261
 * A cgroup_root represents the root of a cgroup hierarchy, and may be
T
Tejun Heo 已提交
262
 * associated with a kernfs_root to form an active hierarchy.  This is
263 264
 * internal to cgroup core.  Don't access directly from controllers.
 */
265
struct cgroup_root {
T
Tejun Heo 已提交
266
	struct kernfs_root *kf_root;
267

268
	/* The bitmask of subsystems attached to this hierarchy */
269
	unsigned int subsys_mask;
270

271 272 273
	/* Unique id for this hierarchy. */
	int hierarchy_id;

T
Tejun Heo 已提交
274
	/* The root cgroup.  Root is destroyed on its release. */
275
	struct cgroup cgrp;
276

277 278
	/* Number of cgroups in the hierarchy, used only for /proc/cgroups */
	atomic_t nr_cgrps;
279 280 281 282 283

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

	/* Hierarchy-specific flags */
284
	unsigned int flags;
285 286

	/* IDs for cgroups in this hierarchy */
287
	struct idr cgroup_idr;
288 289 290 291 292 293 294 295

	/* 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 已提交
296 297
/*
 * A css_set is a structure holding pointers to a set of
298 299
 * 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 已提交
300 301
 * list_add()/del() can bump the reference count on the entire cgroup
 * set for a task.
302 303 304 305 306
 */

struct css_set {

	/* Reference count */
307
	atomic_t refcount;
308

309 310 311 312 313 314
	/*
	 * List running through all cgroup groups in the same hash
	 * slot. Protected by css_set_lock
	 */
	struct hlist_node hlist;

315
	/*
T
Tejun Heo 已提交
316 317 318 319 320
	 * Lists running through all tasks using this cgroup group.
	 * mg_tasks lists tasks which belong to this cset but are in the
	 * process of being migrated out or in.  Protected by
	 * css_set_rwsem, but, during migration, once tasks are moved to
	 * mg_tasks, it can be read safely while holding cgroup_mutex.
321 322
	 */
	struct list_head tasks;
T
Tejun Heo 已提交
323
	struct list_head mg_tasks;
324 325

	/*
326 327
	 * List of cgrp_cset_links pointing at cgroups referenced from this
	 * css_set.  Protected by css_set_lock.
328
	 */
329
	struct list_head cgrp_links;
330

T
Tejun Heo 已提交
331 332 333
	/* the default cgroup associated with this css_set */
	struct cgroup *dfl_cgrp;

334
	/*
T
Tejun Heo 已提交
335 336 337
	 * 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).
338 339
	 */
	struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
340

341 342 343 344
	/*
	 * List of csets participating in the on-going migration either as
	 * source or destination.  Protected by cgroup_mutex.
	 */
345
	struct list_head mg_preload_node;
346 347 348 349 350 351 352 353 354 355 356 357
	struct list_head mg_node;

	/*
	 * If this cset is acting as the source of migration the following
	 * two fields are set.  mg_src_cgrp is the source cgroup of the
	 * on-going migration and mg_dst_cset is the destination cset the
	 * target tasks on this cset should be migrated to.  Protected by
	 * cgroup_mutex.
	 */
	struct cgroup *mg_src_cgrp;
	struct css_set *mg_dst_cset;

T
Tejun Heo 已提交
358 359 360 361 362 363 364 365 366
	/*
	 * On the default hierarhcy, ->subsys[ssid] may point to a css
	 * attached to an ancestor instead of the cgroup this css_set is
	 * associated with.  The following node is anchored at
	 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
	 * iterate through all css's attached to a given cgroup.
	 */
	struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];

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

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

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

	/* internal flags, do not use outside cgroup core proper */
	__CFTYPE_ONLY_ON_DFL	= (1 << 16),	/* only on default hierarchy */
	__CFTYPE_NOT_ON_DFL	= (1 << 17),	/* not on default hierarchy */
388
};
389 390 391

#define MAX_CFTYPE_NAME		64

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

	/*
407
	 * The maximum length of string, excluding trailing nul, that can
408
	 * be passed to write.  If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
409 410 411
	 */
	size_t max_write_len;

412 413 414
	/* CFTYPE_* flags */
	unsigned int flags;

415
	/*
T
Tejun Heo 已提交
416 417
	 * Fields used for internal bookkeeping.  Initialized automatically
	 * during registration.
418
	 */
T
Tejun Heo 已提交
419 420
	struct cgroup_subsys *ss;	/* NULL for cgroup core files */
	struct list_head node;		/* anchored at ss->cfts */
T
Tejun Heo 已提交
421 422
	struct kernfs_ops *kf_ops;

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

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

436 437 438 439 440
	/* 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);

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

T
Tejun Heo 已提交
454 455 456 457 458 459 460 461 462
	/*
	 * write() is the generic write callback which maps directly to
	 * kernfs write operation and overrides all other operations.
	 * Maximum write size is determined by ->max_write_len.  Use
	 * of_css/cft() to access the associated css and cft.
	 */
	ssize_t (*write)(struct kernfs_open_file *of,
			 char *buf, size_t nbytes, loff_t off);

T
Tejun Heo 已提交
463 464 465
#ifdef CONFIG_DEBUG_LOCK_ALLOC
	struct lock_class_key	lockdep_key;
#endif
466 467
};

T
Tejun Heo 已提交
468
extern struct cgroup_root cgrp_dfl_root;
T
Tejun Heo 已提交
469
extern struct css_set init_css_set;
T
Tejun Heo 已提交
470

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
/**
 * cgroup_on_dfl - test whether a cgroup is on the default hierarchy
 * @cgrp: the cgroup of interest
 *
 * The default hierarchy is the v2 interface of cgroup and this function
 * can be used to test whether a cgroup is on the default hierarchy for
 * cases where a subsystem should behave differnetly depending on the
 * interface version.
 *
 * The set of behaviors which change on the default hierarchy are still
 * being determined and the mount option is prefixed with __DEVEL__.
 *
 * List of changed behaviors:
 *
 * - Mount options "noprefix", "xattr", "clone_children", "release_agent"
 *   and "name" are disallowed.
 *
 * - When mounting an existing superblock, mount options should match.
 *
 * - Remount is disallowed.
 *
 * - rename(2) is disallowed.
 *
 * - "tasks" is removed.  Everything should be at process granularity.  Use
 *   "cgroup.procs" instead.
 *
 * - "cgroup.procs" is not sorted.  pids will be unique unless they got
 *   recycled inbetween reads.
 *
 * - "release_agent" and "notify_on_release" are removed.  Replacement
 *   notification mechanism will be implemented.
 *
 * - "cgroup.clone_children" is removed.
 *
 * - "cgroup.subtree_populated" is available.  Its value is 0 if the cgroup
 *   and its descendants contain no task; otherwise, 1.  The file also
 *   generates kernfs notification which can be monitored through poll and
 *   [di]notify when the value of the file changes.
 *
 * - 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.
 *
 * - cpuset: a task can be moved into an empty cpuset, and again it takes
 *   masks of ancestors.
 *
 * - memcg: use_hierarchy is on by default and the cgroup file for the flag
 *   is not created.
 *
 * - blkcg: blk-throttle becomes properly hierarchical.
 *
 * - debug: disallowed on the default hierarchy.
 */
T
Tejun Heo 已提交
524 525 526 527 528
static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
{
	return cgrp->root == &cgrp_dfl_root;
}

529 530 531 532 533 534
/* no synchronization, the result can only be used as a hint */
static inline bool cgroup_has_tasks(struct cgroup *cgrp)
{
	return !list_empty(&cgrp->cset_links);
}

T
Tejun Heo 已提交
535 536 537
/* returns ino associated with a cgroup, 0 indicates unmounted root */
static inline ino_t cgroup_ino(struct cgroup *cgrp)
{
T
Tejun Heo 已提交
538 539
	if (cgrp->kn)
		return cgrp->kn->ino;
T
Tejun Heo 已提交
540 541 542 543
	else
		return 0;
}

T
Tejun Heo 已提交
544 545
/* cft/css accessors for cftype->write() operation */
static inline struct cftype *of_cft(struct kernfs_open_file *of)
546
{
T
Tejun Heo 已提交
547
	return of->kn->priv;
548 549
}

T
Tejun Heo 已提交
550 551 552 553 554 555 556 557 558 559 560 561
struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);

/* cft/css accessors for cftype->seq_*() operations */
static inline struct cftype *seq_cft(struct seq_file *seq)
{
	return of_cft(seq->private);
}

static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
{
	return of_css(seq->private);
}
562

T
Tejun Heo 已提交
563 564 565 566 567 568 569
/*
 * Name / path handling functions.  All are thin wrappers around the kernfs
 * counterparts and can be called under any context.
 */

static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
{
570
	return kernfs_name(cgrp->kn, buf, buflen);
T
Tejun Heo 已提交
571 572 573 574 575
}

static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
					      size_t buflen)
{
576
	return kernfs_path(cgrp->kn, buf, buflen);
T
Tejun Heo 已提交
577 578 579 580
}

static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
{
581
	pr_cont_kernfs_name(cgrp->kn);
T
Tejun Heo 已提交
582 583 584 585
}

static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
{
586
	pr_cont_kernfs_path(cgrp->kn);
T
Tejun Heo 已提交
587 588 589 590
}

char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);

591
int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
592
int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
593
int cgroup_rm_cftypes(struct cftype *cfts);
594

595
bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
596

597 598 599 600 601 602 603 604 605 606 607 608 609
/*
 * 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);

/**
 * cgroup_taskset_for_each - iterate cgroup_taskset
 * @task: the loop cursor
 * @tset: taskset to iterate
 */
610
#define cgroup_taskset_for_each(task, tset)				\
611
	for ((task) = cgroup_taskset_first((tset)); (task);		\
612
	     (task) = cgroup_taskset_next((tset)))
613

614 615 616 617
/*
 * Control Group subsystem type.
 * See Documentation/cgroups/cgroups.txt for details
 */
618 619

struct cgroup_subsys {
620 621 622 623
	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);
624
	void (*css_reset)(struct cgroup_subsys_state *css);
625 626 627 628 629 630 631

	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);
632
	void (*fork)(struct task_struct *task);
633 634
	void (*exit)(struct cgroup_subsys_state *css,
		     struct cgroup_subsys_state *old_css,
635
		     struct task_struct *task);
636
	void (*bind)(struct cgroup_subsys_state *root_css);
637

638
	int disabled;
639
	int early_init;
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
	/*
	 * 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;

656
	/* the following two fields are initialized automtically during boot */
657
	int id;
658 659 660
#define MAX_CGROUP_TYPE_NAMELEN 32
	const char *name;

T
Tejun Heo 已提交
661
	/* link to parent, protected by cgroup_lock() */
662
	struct cgroup_root *root;
663

664 665 666
	/* idr for css->id */
	struct idr css_idr;

T
Tejun Heo 已提交
667 668 669 670 671
	/*
	 * List of cftypes.  Each entry is the first entry of an array
	 * terminated by zero length name.
	 */
	struct list_head cfts;
672

673 674 675 676 677 678
	/*
	 * Base cftypes which are automatically registered.  The two can
	 * point to the same array.
	 */
	struct cftype *dfl_cftypes;	/* for the default hierarchy */
	struct cftype *legacy_cftypes;	/* for the legacy hierarchies */
679 680 681 682 683 684 685 686 687

	/*
	 * A subsystem may depend on other subsystems.  When such subsystem
	 * is enabled on a cgroup, the depended-upon subsystems are enabled
	 * together if available.  Subsystems enabled due to dependency are
	 * not visible to userland until explicitly enabled.  The following
	 * specifies the mask of subsystems that this one depends on.
	 */
	unsigned int depends_on;
688 689
};

690
#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
691 692 693
#include <linux/cgroup_subsys.h>
#undef SUBSYS

694 695 696 697 698 699 700 701 702 703 704 705
/**
 * 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.
706
 */
T
Tejun Heo 已提交
707 708
#ifdef CONFIG_PROVE_RCU
extern struct mutex cgroup_mutex;
709
extern struct rw_semaphore css_set_rwsem;
710 711
#define task_css_set_check(task, __c)					\
	rcu_dereference_check((task)->cgroups,				\
712 713 714
		lockdep_is_held(&cgroup_mutex) ||			\
		lockdep_is_held(&css_set_rwsem) ||			\
		((task)->flags & PF_EXITING) || (__c))
T
Tejun Heo 已提交
715
#else
716 717
#define task_css_set_check(task, __c)					\
	rcu_dereference((task)->cgroups)
T
Tejun Heo 已提交
718
#endif
719

720
/**
721
 * task_css_check - obtain css for (task, subsys) w/ extra access conds
722 723 724 725 726 727 728
 * @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().
 */
729
#define task_css_check(task, subsys_id, __c)				\
730 731 732 733 734 735 736 737 738 739 740 741 742 743
	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);
}

/**
744
 * task_css - obtain css for (task, subsys)
745 746 747
 * @task: the target task
 * @subsys_id: the target subsystem ID
 *
748
 * See task_css_check().
749
 */
750 751
static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
						   int subsys_id)
752
{
753
	return task_css_check(task, subsys_id, false);
754 755
}

T
Tejun Heo 已提交
756 757 758 759 760 761 762 763 764 765 766 767 768 769
/**
 * task_css_is_root - test whether a task belongs to the root css
 * @task: the target task
 * @subsys_id: the target subsystem ID
 *
 * Test whether @task belongs to the root css on the specified subsystem.
 * May be invoked in any context.
 */
static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
{
	return task_css_check(task, subsys_id, true) ==
		init_css_set.subsys[subsys_id];
}

770 771
static inline struct cgroup *task_cgroup(struct task_struct *task,
					 int subsys_id)
772
{
773
	return task_css(task, subsys_id)->cgroup;
774 775
}

776 777
struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
					   struct cgroup_subsys_state *parent);
778

779 780
struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);

781
/**
782 783 784
 * 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
785
 *
786
 * Walk @parent's children.  Must be called under rcu_read_lock().
787
 *
788 789 790 791 792 793
 * If a subsystem synchronizes ->css_online() and the start of iteration, a
 * css which finished ->css_online() is guaranteed to be visible in the
 * future iterations and will stay visible until the last reference is put.
 * A css which hasn't finished ->css_online() or already finished
 * ->css_offline() may show up during traversal.  It's each subsystem's
 * responsibility to synchronize against on/offlining.
794 795 796 797
 *
 * 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.
798
 */
799 800 801
#define css_for_each_child(pos, parent)					\
	for ((pos) = css_next_child(NULL, (parent)); (pos);		\
	     (pos) = css_next_child((pos), (parent)))
802

803 804 805 806 807 808
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);
809 810

/**
811 812 813
 * 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
814
 *
815
 * Walk @root's descendants.  @root is included in the iteration and the
816
 * first node to be visited.  Must be called under rcu_read_lock().
817
 *
818 819 820 821 822 823
 * If a subsystem synchronizes ->css_online() and the start of iteration, a
 * css which finished ->css_online() is guaranteed to be visible in the
 * future iterations and will stay visible until the last reference is put.
 * A css which hasn't finished ->css_online() or already finished
 * ->css_offline() may show up during traversal.  It's each subsystem's
 * responsibility to synchronize against on/offlining.
824
 *
825
 * For example, the following guarantees that a descendant can't escape
826 827
 * state updates of its ancestors.
 *
828
 * my_online(@css)
829
 * {
830 831
 *	Lock @css's parent and @css;
 *	Inherit state from the parent;
832 833 834
 *	Unlock both.
 * }
 *
835
 * my_update_state(@css)
836
 * {
837
 *	css_for_each_descendant_pre(@pos, @css) {
838
 *		Lock @pos;
839 840 841 842
 *		if (@pos == @css)
 *			Update @css's state;
 *		else
 *			Verify @pos is alive and inherit state from its parent;
843 844 845 846 847 848 849 850 851 852
 *		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
853
 * inheritance happens for any css after the latest update to its parent.
854 855 856 857 858
 *
 * 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
859
 * synchronize ->css_online() and ->css_offline() against tree-walking
860
 * operations.
861 862 863 864
 *
 * 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.
865
 */
866 867 868
#define css_for_each_descendant_pre(pos, css)				\
	for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);	\
	     (pos) = css_next_descendant_pre((pos), (css)))
869

870 871 872
struct cgroup_subsys_state *
css_next_descendant_post(struct cgroup_subsys_state *pos,
			 struct cgroup_subsys_state *css);
873 874

/**
875 876 877
 * 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
878
 *
879
 * Similar to css_for_each_descendant_pre() but performs post-order
880
 * traversal instead.  @root is included in the iteration and the last
881 882 883 884 885 886 887 888 889 890 891
 * node to be visited.
 *
 * If a subsystem synchronizes ->css_online() and the start of iteration, a
 * css which finished ->css_online() is guaranteed to be visible in the
 * future iterations and will stay visible until the last reference is put.
 * A css which hasn't finished ->css_online() or already finished
 * ->css_offline() may show up during traversal.  It's each subsystem's
 * responsibility to synchronize against on/offlining.
 *
 * Note that the walk visibility guarantee example described in pre-order
 * walk doesn't apply the same to post-order walks.
892
 */
893 894 895
#define css_for_each_descendant_post(pos, css)				\
	for ((pos) = css_next_descendant_post(NULL, (css)); (pos);	\
	     (pos) = css_next_descendant_post((pos), (css)))
896

897 898
bool css_has_online_children(struct cgroup_subsys_state *css);

899 900
/* A css_task_iter should be treated as an opaque object */
struct css_task_iter {
901 902
	struct cgroup_subsys		*ss;

T
Tejun Heo 已提交
903 904 905 906 907 908
	struct list_head		*cset_pos;
	struct list_head		*cset_head;

	struct list_head		*task_pos;
	struct list_head		*tasks_head;
	struct list_head		*mg_tasks_head;
909 910
};

911 912 913 914
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 已提交
915

M
Michael S. Tsirkin 已提交
916
int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
917
int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
M
Michael S. Tsirkin 已提交
918

919 920
struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
						       struct cgroup_subsys *ss);
K
KAMEZAWA Hiroyuki 已提交
921

922 923 924 925
#else /* !CONFIG_CGROUPS */

static inline int cgroup_init_early(void) { return 0; }
static inline int cgroup_init(void) { return 0; }
926
static inline void cgroup_fork(struct task_struct *p) {}
927
static inline void cgroup_post_fork(struct task_struct *p) {}
928
static inline void cgroup_exit(struct task_struct *p) {}
929

B
Balbir Singh 已提交
930 931 932 933 934
static inline int cgroupstats_build(struct cgroupstats *stats,
					struct dentry *dentry)
{
	return -EINVAL;
}
935

936
/* No cgroups - nothing to do */
M
Michael S. Tsirkin 已提交
937 938 939 940 941
static inline int cgroup_attach_task_all(struct task_struct *from,
					 struct task_struct *t)
{
	return 0;
}
942

943 944 945
#endif /* !CONFIG_CGROUPS */

#endif /* _LINUX_CGROUP_H */