cgroup.h 28.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 30
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);
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 66 67 68 69 70
	/*
	 * Subsys-unique ID.  0 is unused and root is always 1.  The
	 * matching css can be looked up using css_from_id().
	 */
	int id;

71
	unsigned int flags;
72

73 74
	/* percpu_ref killing and RCU release */
	struct rcu_head rcu_head;
75
	struct work_struct destroy_work;
76 77 78 79
};

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

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

97 98 99 100 101 102 103 104 105 106
/**
 * 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 已提交
107 108
static inline bool css_tryget(struct cgroup_subsys_state *css)
{
109
	if (css->flags & CSS_ROOT)
P
Paul Menage 已提交
110
		return true;
111
	return percpu_ref_tryget_live(&css->refcnt);
P
Paul Menage 已提交
112 113
}

114 115 116 117 118 119
/**
 * css_put - put a css reference
 * @css: target css
 *
 * Put a reference obtained via css_get() and css_tryget().
 */
120 121
static inline void css_put(struct cgroup_subsys_state *css)
{
122
	if (!(css->flags & CSS_ROOT))
123
		percpu_ref_put(&css->refcnt);
124 125
}

126 127 128
/* bits in struct cgroup flags field */
enum {
	/* Control Group is dead */
129
	CGRP_DEAD,
P
Paul Menage 已提交
130 131 132 133
	/*
	 * Control Group has previously had a child cgroup or a task,
	 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
	 */
134 135 136
	CGRP_RELEASABLE,
	/* Control Group requires release notifications to userspace */
	CGRP_NOTIFY_ON_RELEASE,
137
	/*
138 139 140
	 * 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.
141
	 */
142
	CGRP_CPUSET_CLONE_CHILDREN,
143 144
};

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

148 149 150
	/*
	 * idr allocated in-hierarchy ID.
	 *
151 152
	 * 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.
153 154
	 *
	 * Allocating/Removing ID must be protected by cgroup_mutex.
155 156
	 */
	int id;
T
Tejun Heo 已提交
157

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

161 162 163 164 165 166 167 168
	/*
	 * 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 已提交
169 170
	atomic_t refcnt;

171 172 173 174 175 176 177
	/*
	 * 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 */

P
Paul Menage 已提交
178
	struct cgroup *parent;		/* my parent */
T
Tejun Heo 已提交
179
	struct kernfs_node *kn;		/* cgroup kernfs entry */
180
	struct kernfs_node *control_kn;	/* kn for "cgroup.subtree_control" */
181
	struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
182

183 184 185 186 187 188 189 190
	/*
	 * 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;

191
	/* the bitmask of subsystems enabled on the child cgroups */
192
	unsigned int child_subsys_mask;
193

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

197
	struct cgroup_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

T
Tejun Heo 已提交
205 206 207 208 209 210 211 212 213
	/*
	 * 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];

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

221 222 223 224 225 226
	/*
	 * 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;
227

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

231
	/* For css percpu_ref killing and RCU-protected deletion */
232
	struct rcu_head rcu_head;
233
	struct work_struct destroy_work;
234 235 236

	/* used to wait for offlining of csses */
	wait_queue_head_t offline_waitq;
237 238
};

239 240
#define MAX_CGROUP_ROOT_NAMELEN 64

241
/* cgroup_root->flags */
242
enum {
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	/*
	 * 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.
	 *
259 260
	 * - Mount options "noprefix", "xattr", "clone_children",
	 *   "release_agent" and "name" are disallowed.
261 262 263 264 265 266
	 *
	 * - When mounting an existing superblock, mount options should
	 *   match.
	 *
	 * - Remount is disallowed.
	 *
267 268
	 * - rename(2) is disallowed.
	 *
269 270
	 * - "tasks" is removed.  Everything should be at process
	 *   granularity.  Use "cgroup.procs" instead.
271
	 *
272 273 274
	 * - "cgroup.procs" is not sorted.  pids will be unique unless they
	 *   got recycled inbetween reads.
	 *
275 276
	 * - "release_agent" and "notify_on_release" are removed.
	 *   Replacement notification mechanism will be implemented.
277
	 *
278
	 * - "cgroup.clone_children" is removed.
279
	 *
280 281 282 283 284 285
	 * - "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.
	 *
T
Tejun Heo 已提交
286 287 288
	 * - If mount is requested with sane_behavior but without any
	 *   subsystem, the default unified hierarchy is mounted.
	 *
289 290 291 292
	 * - 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.
	 *
293 294
	 * - cpuset: a task can be moved into an empty cpuset, and again it
	 *   takes masks of ancestors.
295
	 *
296 297
	 * - memcg: use_hierarchy is on by default and the cgroup file for
	 *   the flag is not created.
298
	 *
299
	 * - blkcg: blk-throttle becomes properly hierarchical.
300 301 302
	 */
	CGRP_ROOT_SANE_BEHAVIOR	= (1 << 0),

303 304
	CGRP_ROOT_NOPREFIX	= (1 << 1), /* mounted subsystems have no named prefix */
	CGRP_ROOT_XATTR		= (1 << 2), /* supports extended attributes */
305 306 307

	/* mount options live below bit 16 */
	CGRP_ROOT_OPTION_MASK	= (1 << 16) - 1,
308 309 310
};

/*
311
 * A cgroup_root represents the root of a cgroup hierarchy, and may be
T
Tejun Heo 已提交
312
 * associated with a kernfs_root to form an active hierarchy.  This is
313 314
 * internal to cgroup core.  Don't access directly from controllers.
 */
315
struct cgroup_root {
T
Tejun Heo 已提交
316
	struct kernfs_root *kf_root;
317

318
	/* The bitmask of subsystems attached to this hierarchy */
319
	unsigned int subsys_mask;
320

321 322 323
	/* Unique id for this hierarchy. */
	int hierarchy_id;

T
Tejun Heo 已提交
324
	/* The root cgroup.  Root is destroyed on its release. */
325
	struct cgroup cgrp;
326

327 328
	/* Number of cgroups in the hierarchy, used only for /proc/cgroups */
	atomic_t nr_cgrps;
329 330 331 332 333

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

	/* Hierarchy-specific flags */
334
	unsigned int flags;
335 336

	/* IDs for cgroups in this hierarchy */
337
	struct idr cgroup_idr;
338 339 340 341 342 343 344 345

	/* 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 已提交
346 347
/*
 * A css_set is a structure holding pointers to a set of
348 349
 * 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 已提交
350 351
 * list_add()/del() can bump the reference count on the entire cgroup
 * set for a task.
352 353 354 355 356
 */

struct css_set {

	/* Reference count */
357
	atomic_t refcount;
358

359 360 361 362 363 364
	/*
	 * List running through all cgroup groups in the same hash
	 * slot. Protected by css_set_lock
	 */
	struct hlist_node hlist;

365
	/*
T
Tejun Heo 已提交
366 367 368 369 370
	 * 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.
371 372
	 */
	struct list_head tasks;
T
Tejun Heo 已提交
373
	struct list_head mg_tasks;
374 375

	/*
376 377
	 * List of cgrp_cset_links pointing at cgroups referenced from this
	 * css_set.  Protected by css_set_lock.
378
	 */
379
	struct list_head cgrp_links;
380

T
Tejun Heo 已提交
381 382 383
	/* the default cgroup associated with this css_set */
	struct cgroup *dfl_cgrp;

384
	/*
T
Tejun Heo 已提交
385 386 387
	 * 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).
388 389
	 */
	struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
390

391 392 393 394
	/*
	 * List of csets participating in the on-going migration either as
	 * source or destination.  Protected by cgroup_mutex.
	 */
395
	struct list_head mg_preload_node;
396 397 398 399 400 401 402 403 404 405 406 407
	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 已提交
408 409 410 411 412 413 414 415 416
	/*
	 * 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];

417 418
	/* For RCU-protected deletion */
	struct rcu_head rcu_head;
419 420
};

P
Paul Menage 已提交
421 422
/*
 * struct cftype: handler definitions for cgroup control files
423 424
 *
 * When reading/writing to a file:
L
Li Zefan 已提交
425
 *	- the cgroup to use is file->f_dentry->d_parent->d_fsdata
426 427 428
 *	- the 'cftype' of the file is file->f_dentry->d_fsdata
 */

429
/* cftype->flags */
430
enum {
L
Li Zefan 已提交
431 432
	CFTYPE_ONLY_ON_ROOT	= (1 << 0),	/* only create on root cgrp */
	CFTYPE_NOT_ON_ROOT	= (1 << 1),	/* don't create on root cgrp */
433
	CFTYPE_INSANE		= (1 << 2),	/* don't create if sane_behavior */
T
Tejun Heo 已提交
434
	CFTYPE_NO_PREFIX	= (1 << 3),	/* (DON'T USE FOR NEW FILES) no subsys prefix */
T
Tejun Heo 已提交
435
	CFTYPE_ONLY_ON_DFL	= (1 << 4),	/* only on default hierarchy */
436
};
437 438 439

#define MAX_CFTYPE_NAME		64

440
struct cftype {
P
Paul Menage 已提交
441 442
	/*
	 * By convention, the name should begin with the name of the
443 444
	 * subsystem, followed by a period.  Zero length string indicates
	 * end of cftype array.
P
Paul Menage 已提交
445
	 */
446 447
	char name[MAX_CFTYPE_NAME];
	int private;
L
Li Zefan 已提交
448 449 450 451
	/*
	 * If not 0, file mode is set to this value, otherwise it will
	 * be figured out automatically
	 */
A
Al Viro 已提交
452
	umode_t mode;
453 454

	/*
455 456 457
	 * The maximum length of string, excluding trailing nul, that can
	 * be passed to write_string.  If < PAGE_SIZE-1, PAGE_SIZE-1 is
	 * assumed.
458 459 460
	 */
	size_t max_write_len;

461 462 463
	/* CFTYPE_* flags */
	unsigned int flags;

464
	/*
T
Tejun Heo 已提交
465 466
	 * Fields used for internal bookkeeping.  Initialized automatically
	 * during registration.
467
	 */
T
Tejun Heo 已提交
468 469
	struct cgroup_subsys *ss;	/* NULL for cgroup core files */
	struct list_head node;		/* anchored at ss->cfts */
T
Tejun Heo 已提交
470 471
	struct kernfs_ops *kf_ops;

472
	/*
473
	 * read_u64() is a shortcut for the common case of returning a
474 475
	 * single integer. Use it in place of read()
	 */
476
	u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
477 478 479
	/*
	 * read_s64() is a signed version of read_u64()
	 */
480
	s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
481 482 483

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

485 486 487 488 489
	/* 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);

490
	/*
491
	 * write_u64() is a shortcut for the common case of accepting
492 493 494
	 * a single integer (as parsed by simple_strtoull) from
	 * userspace. Use in place of write(); return 0 or error.
	 */
495 496
	int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
			 u64 val);
497 498 499
	/*
	 * write_s64() is a signed version of write_u64()
	 */
500 501
	int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
			 s64 val);
502

503 504 505 506 507
	/*
	 * write_string() is passed a nul-terminated kernelspace
	 * buffer of maximum length determined by max_write_len.
	 * Returns 0 or -ve error code.
	 */
508
	int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
509
			    char *buffer);
510 511 512 513 514 515
	/*
	 * 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.
	 */
516
	int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
T
Tejun Heo 已提交
517 518 519 520

#ifdef CONFIG_DEBUG_LOCK_ALLOC
	struct lock_class_key	lockdep_key;
#endif
521 522
};

T
Tejun Heo 已提交
523
extern struct cgroup_root cgrp_dfl_root;
T
Tejun Heo 已提交
524
extern struct css_set init_css_set;
T
Tejun Heo 已提交
525 526 527 528 529 530

static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
{
	return cgrp->root == &cgrp_dfl_root;
}

531 532 533 534 535 536 537 538 539
/*
 * 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;
}

540 541 542 543 544 545
/* 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 已提交
546 547 548
/* returns ino associated with a cgroup, 0 indicates unmounted root */
static inline ino_t cgroup_ino(struct cgroup *cgrp)
{
T
Tejun Heo 已提交
549 550
	if (cgrp->kn)
		return cgrp->kn->ino;
T
Tejun Heo 已提交
551 552 553 554
	else
		return 0;
}

555 556
static inline struct cftype *seq_cft(struct seq_file *seq)
{
T
Tejun Heo 已提交
557 558 559
	struct kernfs_open_file *of = seq->private;

	return of->kn->priv;
560 561
}

562 563
struct cgroup_subsys_state *seq_css(struct seq_file *seq);

T
Tejun Heo 已提交
564 565 566 567 568 569 570
/*
 * 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)
{
571
	return kernfs_name(cgrp->kn, buf, buflen);
T
Tejun Heo 已提交
572 573 574 575 576
}

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

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

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

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

A
Aristeu Rozanski 已提交
592
int cgroup_add_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 624 625 626 627 628 629 630
	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);
631
	void (*fork)(struct task_struct *task);
632 633
	void (*exit)(struct cgroup_subsys_state *css,
		     struct cgroup_subsys_state *old_css,
634
		     struct task_struct *task);
635
	void (*bind)(struct cgroup_subsys_state *root_css);
636

637
	int disabled;
638
	int early_init;
639

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

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

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

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

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

672
	/* base cftypes, automatically registered with subsys itself */
673
	struct cftype *base_cftypes;
674 675
};

676
#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
677 678 679
#include <linux/cgroup_subsys.h>
#undef SUBSYS

T
Tejun Heo 已提交
680 681 682 683 684 685 686 687 688 689
/**
 * 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)
{
690
	return css->parent;
T
Tejun Heo 已提交
691 692
}

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

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

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

T
Tejun Heo 已提交
755 756 757 758 759 760 761 762 763 764 765 766 767 768
/**
 * 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];
}

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

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

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

780
/**
781 782 783
 * 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
784
 *
785 786
 * Walk @parent's children.  Must be called under rcu_read_lock().  A child
 * css which hasn't finished ->css_online() or already has finished
787
 * ->css_offline() may show up during traversal and it's each subsystem's
788 789
 * responsibility to verify that each @pos is alive.
 *
790
 * If a subsystem synchronizes against the parent in its ->css_online() and
791
 * before starting iterating, a css which finished ->css_online() is
792
 * guaranteed to be visible in the future iterations.
793 794 795 796
 *
 * 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.
797
 */
798 799 800
#define css_for_each_child(pos, parent)					\
	for ((pos) = css_next_child(NULL, (parent)); (pos);		\
	     (pos) = css_next_child((pos), (parent)))
801

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

/**
810 811 812
 * 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
813
 *
814 815
 * 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
816
 * descendant css which hasn't finished ->css_online() or already has
817
 * finished ->css_offline() may show up during traversal and it's each
818 819
 * subsystem's responsibility to verify that each @pos is alive.
 *
820 821
 * If a subsystem synchronizes against the parent in its ->css_online() and
 * before starting iterating, and synchronizes against @pos on each
822
 * iteration, any descendant css which finished ->css_online() is
823 824 825 826 827
 * 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.
 *
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 881 882
 * 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.
883
 */
884 885 886
#define css_for_each_descendant_post(pos, css)				\
	for ((pos) = css_next_descendant_post(NULL, (css)); (pos);	\
	     (pos) = css_next_descendant_post((pos), (css)))
887

888 889
/* A css_task_iter should be treated as an opaque object */
struct css_task_iter {
890 891
	struct cgroup_subsys		*ss;

T
Tejun Heo 已提交
892 893 894 895 896 897
	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;
898 899
};

900 901 902 903
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 已提交
904

M
Michael S. Tsirkin 已提交
905
int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
906
int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
M
Michael S. Tsirkin 已提交
907

908 909
struct cgroup_subsys_state *css_tryget_from_dir(struct dentry *dentry,
						struct cgroup_subsys *ss);
K
KAMEZAWA Hiroyuki 已提交
910

911 912 913 914
#else /* !CONFIG_CGROUPS */

static inline int cgroup_init_early(void) { return 0; }
static inline int cgroup_init(void) { return 0; }
915
static inline void cgroup_fork(struct task_struct *p) {}
916
static inline void cgroup_post_fork(struct task_struct *p) {}
917
static inline void cgroup_exit(struct task_struct *p) {}
918

B
Balbir Singh 已提交
919 920 921 922 923
static inline int cgroupstats_build(struct cgroupstats *stats,
					struct dentry *dentry)
{
	return -EINVAL;
}
924

925
/* No cgroups - nothing to do */
M
Michael S. Tsirkin 已提交
926 927 928 929 930
static inline int cgroup_attach_task_all(struct task_struct *from,
					 struct task_struct *t)
{
	return 0;
}
931

932 933 934
#endif /* !CONFIG_CGROUPS */

#endif /* _LINUX_CGROUP_H */