cgroup.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. #ifndef _LINUX_CGROUP_H
  2. #define _LINUX_CGROUP_H
  3. /*
  4. * cgroup interface
  5. *
  6. * Copyright (C) 2003 BULL SA
  7. * Copyright (C) 2004-2006 Silicon Graphics, Inc.
  8. *
  9. */
  10. #include <linux/sched.h>
  11. #include <linux/cpumask.h>
  12. #include <linux/nodemask.h>
  13. #include <linux/rcupdate.h>
  14. #include <linux/rculist.h>
  15. #include <linux/cgroupstats.h>
  16. #include <linux/prio_heap.h>
  17. #include <linux/rwsem.h>
  18. #include <linux/idr.h>
  19. #include <linux/workqueue.h>
  20. #include <linux/xattr.h>
  21. #include <linux/fs.h>
  22. #include <linux/percpu-refcount.h>
  23. #include <linux/seq_file.h>
  24. #ifdef CONFIG_CGROUPS
  25. struct cgroupfs_root;
  26. struct cgroup_subsys;
  27. struct inode;
  28. struct cgroup;
  29. extern int cgroup_init_early(void);
  30. extern int cgroup_init(void);
  31. extern void cgroup_fork(struct task_struct *p);
  32. extern void cgroup_post_fork(struct task_struct *p);
  33. extern void cgroup_exit(struct task_struct *p, int run_callbacks);
  34. extern int cgroupstats_build(struct cgroupstats *stats,
  35. struct dentry *dentry);
  36. extern int proc_cgroup_show(struct seq_file *, void *);
  37. /* define the enumeration of all cgroup subsystems */
  38. #define SUBSYS(_x) _x ## _cgrp_id,
  39. enum cgroup_subsys_id {
  40. #include <linux/cgroup_subsys.h>
  41. CGROUP_SUBSYS_COUNT,
  42. };
  43. #undef SUBSYS
  44. /* Per-subsystem/per-cgroup state maintained by the system. */
  45. struct cgroup_subsys_state {
  46. /* the cgroup that this css is attached to */
  47. struct cgroup *cgroup;
  48. /* the cgroup subsystem that this css is attached to */
  49. struct cgroup_subsys *ss;
  50. /* reference count - access via css_[try]get() and css_put() */
  51. struct percpu_ref refcnt;
  52. /* the parent css */
  53. struct cgroup_subsys_state *parent;
  54. unsigned long flags;
  55. /* percpu_ref killing and RCU release */
  56. struct rcu_head rcu_head;
  57. struct work_struct destroy_work;
  58. };
  59. /* bits in struct cgroup_subsys_state flags field */
  60. enum {
  61. CSS_ROOT = (1 << 0), /* this CSS is the root of the subsystem */
  62. CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
  63. };
  64. /**
  65. * css_get - obtain a reference on the specified css
  66. * @css: target css
  67. *
  68. * The caller must already have a reference.
  69. */
  70. static inline void css_get(struct cgroup_subsys_state *css)
  71. {
  72. /* We don't need to reference count the root state */
  73. if (!(css->flags & CSS_ROOT))
  74. percpu_ref_get(&css->refcnt);
  75. }
  76. /**
  77. * css_tryget - try to obtain a reference on the specified css
  78. * @css: target css
  79. *
  80. * Obtain a reference on @css if it's alive. The caller naturally needs to
  81. * ensure that @css is accessible but doesn't have to be holding a
  82. * reference on it - IOW, RCU protected access is good enough for this
  83. * function. Returns %true if a reference count was successfully obtained;
  84. * %false otherwise.
  85. */
  86. static inline bool css_tryget(struct cgroup_subsys_state *css)
  87. {
  88. if (css->flags & CSS_ROOT)
  89. return true;
  90. return percpu_ref_tryget(&css->refcnt);
  91. }
  92. /**
  93. * css_put - put a css reference
  94. * @css: target css
  95. *
  96. * Put a reference obtained via css_get() and css_tryget().
  97. */
  98. static inline void css_put(struct cgroup_subsys_state *css)
  99. {
  100. if (!(css->flags & CSS_ROOT))
  101. percpu_ref_put(&css->refcnt);
  102. }
  103. /* bits in struct cgroup flags field */
  104. enum {
  105. /* Control Group is dead */
  106. CGRP_DEAD,
  107. /*
  108. * Control Group has previously had a child cgroup or a task,
  109. * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
  110. */
  111. CGRP_RELEASABLE,
  112. /* Control Group requires release notifications to userspace */
  113. CGRP_NOTIFY_ON_RELEASE,
  114. /*
  115. * Clone the parent's configuration when creating a new child
  116. * cpuset cgroup. For historical reasons, this option can be
  117. * specified at mount time and thus is implemented here.
  118. */
  119. CGRP_CPUSET_CLONE_CHILDREN,
  120. /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
  121. CGRP_SANE_BEHAVIOR,
  122. };
  123. struct cgroup_name {
  124. struct rcu_head rcu_head;
  125. char name[];
  126. };
  127. struct cgroup {
  128. unsigned long flags; /* "unsigned long" so bitops work */
  129. /*
  130. * idr allocated in-hierarchy ID.
  131. *
  132. * The ID of the root cgroup is always 0, and a new cgroup
  133. * will be assigned with a smallest available ID.
  134. *
  135. * Allocating/Removing ID must be protected by cgroup_mutex.
  136. */
  137. int id;
  138. /* the number of attached css's */
  139. int nr_css;
  140. /*
  141. * We link our 'sibling' struct into our parent's 'children'.
  142. * Our children link their 'sibling' into our 'children'.
  143. */
  144. struct list_head sibling; /* my parent's children */
  145. struct list_head children; /* my children */
  146. struct list_head files; /* my files */
  147. struct cgroup *parent; /* my parent */
  148. struct dentry *dentry; /* cgroup fs entry, RCU protected */
  149. /*
  150. * Monotonically increasing unique serial number which defines a
  151. * uniform order among all cgroups. It's guaranteed that all
  152. * ->children lists are in the ascending order of ->serial_nr.
  153. * It's used to allow interrupting and resuming iterations.
  154. */
  155. u64 serial_nr;
  156. /*
  157. * This is a copy of dentry->d_name, and it's needed because
  158. * we can't use dentry->d_name in cgroup_path().
  159. *
  160. * You must acquire rcu_read_lock() to access cgrp->name, and
  161. * the only place that can change it is rename(), which is
  162. * protected by parent dir's i_mutex.
  163. *
  164. * Normally you should use cgroup_name() wrapper rather than
  165. * access it directly.
  166. */
  167. struct cgroup_name __rcu *name;
  168. /* Private pointers for each registered subsystem */
  169. struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
  170. struct cgroupfs_root *root;
  171. /*
  172. * List of cgrp_cset_links pointing at css_sets with tasks in this
  173. * cgroup. Protected by css_set_lock.
  174. */
  175. struct list_head cset_links;
  176. /*
  177. * Linked list running through all cgroups that can
  178. * potentially be reaped by the release agent. Protected by
  179. * release_list_lock
  180. */
  181. struct list_head release_list;
  182. /*
  183. * list of pidlists, up to two for each namespace (one for procs, one
  184. * for tasks); created on demand.
  185. */
  186. struct list_head pidlists;
  187. struct mutex pidlist_mutex;
  188. /* dummy css with NULL ->ss, points back to this cgroup */
  189. struct cgroup_subsys_state dummy_css;
  190. /* For css percpu_ref killing and RCU-protected deletion */
  191. struct rcu_head rcu_head;
  192. struct work_struct destroy_work;
  193. /* directory xattrs */
  194. struct simple_xattrs xattrs;
  195. };
  196. #define MAX_CGROUP_ROOT_NAMELEN 64
  197. /* cgroupfs_root->flags */
  198. enum {
  199. /*
  200. * Unfortunately, cgroup core and various controllers are riddled
  201. * with idiosyncrasies and pointless options. The following flag,
  202. * when set, will force sane behavior - some options are forced on,
  203. * others are disallowed, and some controllers will change their
  204. * hierarchical or other behaviors.
  205. *
  206. * The set of behaviors affected by this flag are still being
  207. * determined and developed and the mount option for this flag is
  208. * prefixed with __DEVEL__. The prefix will be dropped once we
  209. * reach the point where all behaviors are compatible with the
  210. * planned unified hierarchy, which will automatically turn on this
  211. * flag.
  212. *
  213. * The followings are the behaviors currently affected this flag.
  214. *
  215. * - Mount options "noprefix" and "clone_children" are disallowed.
  216. * Also, cgroupfs file cgroup.clone_children is not created.
  217. *
  218. * - When mounting an existing superblock, mount options should
  219. * match.
  220. *
  221. * - Remount is disallowed.
  222. *
  223. * - rename(2) is disallowed.
  224. *
  225. * - "tasks" is removed. Everything should be at process
  226. * granularity. Use "cgroup.procs" instead.
  227. *
  228. * - "cgroup.procs" is not sorted. pids will be unique unless they
  229. * got recycled inbetween reads.
  230. *
  231. * - "release_agent" and "notify_on_release" are removed.
  232. * Replacement notification mechanism will be implemented.
  233. *
  234. * - cpuset: tasks will be kept in empty cpusets when hotplug happens
  235. * and take masks of ancestors with non-empty cpus/mems, instead of
  236. * being moved to an ancestor.
  237. *
  238. * - cpuset: a task can be moved into an empty cpuset, and again it
  239. * takes masks of ancestors.
  240. *
  241. * - memcg: use_hierarchy is on by default and the cgroup file for
  242. * the flag is not created.
  243. *
  244. * - blkcg: blk-throttle becomes properly hierarchical.
  245. */
  246. CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
  247. CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
  248. CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
  249. /* mount options live below bit 16 */
  250. CGRP_ROOT_OPTION_MASK = (1 << 16) - 1,
  251. CGRP_ROOT_SUBSYS_BOUND = (1 << 16), /* subsystems finished binding */
  252. };
  253. /*
  254. * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
  255. * associated with a superblock to form an active hierarchy. This is
  256. * internal to cgroup core. Don't access directly from controllers.
  257. */
  258. struct cgroupfs_root {
  259. struct super_block *sb;
  260. /* The bitmask of subsystems attached to this hierarchy */
  261. unsigned long subsys_mask;
  262. /* Unique id for this hierarchy. */
  263. int hierarchy_id;
  264. /* The root cgroup for this hierarchy */
  265. struct cgroup top_cgroup;
  266. /* Tracks how many cgroups are currently defined in hierarchy.*/
  267. int number_of_cgroups;
  268. /* A list running through the active hierarchies */
  269. struct list_head root_list;
  270. /* Hierarchy-specific flags */
  271. unsigned long flags;
  272. /* IDs for cgroups in this hierarchy */
  273. struct idr cgroup_idr;
  274. /* The path to use for release notifications. */
  275. char release_agent_path[PATH_MAX];
  276. /* The name for this hierarchy - may be empty */
  277. char name[MAX_CGROUP_ROOT_NAMELEN];
  278. };
  279. /*
  280. * A css_set is a structure holding pointers to a set of
  281. * cgroup_subsys_state objects. This saves space in the task struct
  282. * object and speeds up fork()/exit(), since a single inc/dec and a
  283. * list_add()/del() can bump the reference count on the entire cgroup
  284. * set for a task.
  285. */
  286. struct css_set {
  287. /* Reference count */
  288. atomic_t refcount;
  289. /*
  290. * List running through all cgroup groups in the same hash
  291. * slot. Protected by css_set_lock
  292. */
  293. struct hlist_node hlist;
  294. /*
  295. * List running through all tasks using this cgroup
  296. * group. Protected by css_set_lock
  297. */
  298. struct list_head tasks;
  299. /*
  300. * List of cgrp_cset_links pointing at cgroups referenced from this
  301. * css_set. Protected by css_set_lock.
  302. */
  303. struct list_head cgrp_links;
  304. /*
  305. * Set of subsystem states, one for each subsystem. This array is
  306. * immutable after creation apart from the init_css_set during
  307. * subsystem registration (at boot time).
  308. */
  309. struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
  310. /* For RCU-protected deletion */
  311. struct rcu_head rcu_head;
  312. };
  313. /*
  314. * struct cftype: handler definitions for cgroup control files
  315. *
  316. * When reading/writing to a file:
  317. * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
  318. * - the 'cftype' of the file is file->f_dentry->d_fsdata
  319. */
  320. /* cftype->flags */
  321. enum {
  322. CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
  323. CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
  324. CFTYPE_INSANE = (1 << 2), /* don't create if sane_behavior */
  325. CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
  326. };
  327. #define MAX_CFTYPE_NAME 64
  328. struct cftype {
  329. /*
  330. * By convention, the name should begin with the name of the
  331. * subsystem, followed by a period. Zero length string indicates
  332. * end of cftype array.
  333. */
  334. char name[MAX_CFTYPE_NAME];
  335. int private;
  336. /*
  337. * If not 0, file mode is set to this value, otherwise it will
  338. * be figured out automatically
  339. */
  340. umode_t mode;
  341. /*
  342. * If non-zero, defines the maximum length of string that can
  343. * be passed to write_string; defaults to 64
  344. */
  345. size_t max_write_len;
  346. /* CFTYPE_* flags */
  347. unsigned int flags;
  348. /*
  349. * The subsys this file belongs to. Initialized automatically
  350. * during registration. NULL for cgroup core files.
  351. */
  352. struct cgroup_subsys *ss;
  353. /*
  354. * read_u64() is a shortcut for the common case of returning a
  355. * single integer. Use it in place of read()
  356. */
  357. u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
  358. /*
  359. * read_s64() is a signed version of read_u64()
  360. */
  361. s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
  362. /* generic seq_file read interface */
  363. int (*seq_show)(struct seq_file *sf, void *v);
  364. /* optional ops, implement all or none */
  365. void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
  366. void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
  367. void (*seq_stop)(struct seq_file *sf, void *v);
  368. /*
  369. * write_u64() is a shortcut for the common case of accepting
  370. * a single integer (as parsed by simple_strtoull) from
  371. * userspace. Use in place of write(); return 0 or error.
  372. */
  373. int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
  374. u64 val);
  375. /*
  376. * write_s64() is a signed version of write_u64()
  377. */
  378. int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
  379. s64 val);
  380. /*
  381. * write_string() is passed a nul-terminated kernelspace
  382. * buffer of maximum length determined by max_write_len.
  383. * Returns 0 or -ve error code.
  384. */
  385. int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
  386. const char *buffer);
  387. /*
  388. * trigger() callback can be used to get some kick from the
  389. * userspace, when the actual string written is not important
  390. * at all. The private field can be used to determine the
  391. * kick type for multiplexing.
  392. */
  393. int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
  394. };
  395. /*
  396. * cftype_sets describe cftypes belonging to a subsystem and are chained at
  397. * cgroup_subsys->cftsets. Each cftset points to an array of cftypes
  398. * terminated by zero length name.
  399. */
  400. struct cftype_set {
  401. struct list_head node; /* chained at subsys->cftsets */
  402. struct cftype *cfts;
  403. };
  404. /*
  405. * cgroupfs file entry, pointed to from leaf dentry->d_fsdata. Don't
  406. * access directly.
  407. */
  408. struct cfent {
  409. struct list_head node;
  410. struct dentry *dentry;
  411. struct cftype *type;
  412. struct cgroup_subsys_state *css;
  413. /* file xattrs */
  414. struct simple_xattrs xattrs;
  415. };
  416. /* seq_file->private points to the following, only ->priv is public */
  417. struct cgroup_open_file {
  418. struct cfent *cfe;
  419. void *priv;
  420. };
  421. /*
  422. * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
  423. * function can be called as long as @cgrp is accessible.
  424. */
  425. static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
  426. {
  427. return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
  428. }
  429. /* Caller should hold rcu_read_lock() */
  430. static inline const char *cgroup_name(const struct cgroup *cgrp)
  431. {
  432. return rcu_dereference(cgrp->name)->name;
  433. }
  434. static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
  435. {
  436. struct cgroup_open_file *of = seq->private;
  437. return of->cfe->css;
  438. }
  439. static inline struct cftype *seq_cft(struct seq_file *seq)
  440. {
  441. struct cgroup_open_file *of = seq->private;
  442. return of->cfe->type;
  443. }
  444. int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  445. int cgroup_rm_cftypes(struct cftype *cfts);
  446. bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
  447. int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
  448. int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
  449. int cgroup_task_count(const struct cgroup *cgrp);
  450. /*
  451. * Control Group taskset, used to pass around set of tasks to cgroup_subsys
  452. * methods.
  453. */
  454. struct cgroup_taskset;
  455. struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
  456. struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
  457. struct cgroup_subsys_state *cgroup_taskset_cur_css(struct cgroup_taskset *tset,
  458. int subsys_id);
  459. int cgroup_taskset_size(struct cgroup_taskset *tset);
  460. /**
  461. * cgroup_taskset_for_each - iterate cgroup_taskset
  462. * @task: the loop cursor
  463. * @skip_css: skip if task's css matches this, %NULL to iterate through all
  464. * @tset: taskset to iterate
  465. */
  466. #define cgroup_taskset_for_each(task, skip_css, tset) \
  467. for ((task) = cgroup_taskset_first((tset)); (task); \
  468. (task) = cgroup_taskset_next((tset))) \
  469. if (!(skip_css) || \
  470. cgroup_taskset_cur_css((tset), \
  471. (skip_css)->ss->id) != (skip_css))
  472. /*
  473. * Control Group subsystem type.
  474. * See Documentation/cgroups/cgroups.txt for details
  475. */
  476. struct cgroup_subsys {
  477. struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
  478. int (*css_online)(struct cgroup_subsys_state *css);
  479. void (*css_offline)(struct cgroup_subsys_state *css);
  480. void (*css_free)(struct cgroup_subsys_state *css);
  481. int (*can_attach)(struct cgroup_subsys_state *css,
  482. struct cgroup_taskset *tset);
  483. void (*cancel_attach)(struct cgroup_subsys_state *css,
  484. struct cgroup_taskset *tset);
  485. void (*attach)(struct cgroup_subsys_state *css,
  486. struct cgroup_taskset *tset);
  487. void (*fork)(struct task_struct *task);
  488. void (*exit)(struct cgroup_subsys_state *css,
  489. struct cgroup_subsys_state *old_css,
  490. struct task_struct *task);
  491. void (*bind)(struct cgroup_subsys_state *root_css);
  492. int disabled;
  493. int early_init;
  494. /*
  495. * If %false, this subsystem is properly hierarchical -
  496. * configuration, resource accounting and restriction on a parent
  497. * cgroup cover those of its children. If %true, hierarchy support
  498. * is broken in some ways - some subsystems ignore hierarchy
  499. * completely while others are only implemented half-way.
  500. *
  501. * It's now disallowed to create nested cgroups if the subsystem is
  502. * broken and cgroup core will emit a warning message on such
  503. * cases. Eventually, all subsystems will be made properly
  504. * hierarchical and this will go away.
  505. */
  506. bool broken_hierarchy;
  507. bool warned_broken_hierarchy;
  508. /* the following two fields are initialized automtically during boot */
  509. int id;
  510. #define MAX_CGROUP_TYPE_NAMELEN 32
  511. const char *name;
  512. /* link to parent, protected by cgroup_lock() */
  513. struct cgroupfs_root *root;
  514. /* list of cftype_sets */
  515. struct list_head cftsets;
  516. /* base cftypes, automatically [de]registered with subsys itself */
  517. struct cftype *base_cftypes;
  518. struct cftype_set base_cftset;
  519. };
  520. #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
  521. #include <linux/cgroup_subsys.h>
  522. #undef SUBSYS
  523. /**
  524. * css_parent - find the parent css
  525. * @css: the target cgroup_subsys_state
  526. *
  527. * Return the parent css of @css. This function is guaranteed to return
  528. * non-NULL parent as long as @css isn't the root.
  529. */
  530. static inline
  531. struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
  532. {
  533. return css->parent;
  534. }
  535. /**
  536. * task_css_set_check - obtain a task's css_set with extra access conditions
  537. * @task: the task to obtain css_set for
  538. * @__c: extra condition expression to be passed to rcu_dereference_check()
  539. *
  540. * A task's css_set is RCU protected, initialized and exited while holding
  541. * task_lock(), and can only be modified while holding both cgroup_mutex
  542. * and task_lock() while the task is alive. This macro verifies that the
  543. * caller is inside proper critical section and returns @task's css_set.
  544. *
  545. * The caller can also specify additional allowed conditions via @__c, such
  546. * as locks used during the cgroup_subsys::attach() methods.
  547. */
  548. #ifdef CONFIG_PROVE_RCU
  549. extern struct mutex cgroup_mutex;
  550. #define task_css_set_check(task, __c) \
  551. rcu_dereference_check((task)->cgroups, \
  552. lockdep_is_held(&(task)->alloc_lock) || \
  553. lockdep_is_held(&cgroup_mutex) || (__c))
  554. #else
  555. #define task_css_set_check(task, __c) \
  556. rcu_dereference((task)->cgroups)
  557. #endif
  558. /**
  559. * task_css_check - obtain css for (task, subsys) w/ extra access conds
  560. * @task: the target task
  561. * @subsys_id: the target subsystem ID
  562. * @__c: extra condition expression to be passed to rcu_dereference_check()
  563. *
  564. * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
  565. * synchronization rules are the same as task_css_set_check().
  566. */
  567. #define task_css_check(task, subsys_id, __c) \
  568. task_css_set_check((task), (__c))->subsys[(subsys_id)]
  569. /**
  570. * task_css_set - obtain a task's css_set
  571. * @task: the task to obtain css_set for
  572. *
  573. * See task_css_set_check().
  574. */
  575. static inline struct css_set *task_css_set(struct task_struct *task)
  576. {
  577. return task_css_set_check(task, false);
  578. }
  579. /**
  580. * task_css - obtain css for (task, subsys)
  581. * @task: the target task
  582. * @subsys_id: the target subsystem ID
  583. *
  584. * See task_css_check().
  585. */
  586. static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
  587. int subsys_id)
  588. {
  589. return task_css_check(task, subsys_id, false);
  590. }
  591. static inline struct cgroup *task_cgroup(struct task_struct *task,
  592. int subsys_id)
  593. {
  594. return task_css(task, subsys_id)->cgroup;
  595. }
  596. struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
  597. struct cgroup_subsys_state *parent);
  598. struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
  599. /**
  600. * css_for_each_child - iterate through children of a css
  601. * @pos: the css * to use as the loop cursor
  602. * @parent: css whose children to walk
  603. *
  604. * Walk @parent's children. Must be called under rcu_read_lock(). A child
  605. * css which hasn't finished ->css_online() or already has finished
  606. * ->css_offline() may show up during traversal and it's each subsystem's
  607. * responsibility to verify that each @pos is alive.
  608. *
  609. * If a subsystem synchronizes against the parent in its ->css_online() and
  610. * before starting iterating, a css which finished ->css_online() is
  611. * guaranteed to be visible in the future iterations.
  612. *
  613. * It is allowed to temporarily drop RCU read lock during iteration. The
  614. * caller is responsible for ensuring that @pos remains accessible until
  615. * the start of the next iteration by, for example, bumping the css refcnt.
  616. */
  617. #define css_for_each_child(pos, parent) \
  618. for ((pos) = css_next_child(NULL, (parent)); (pos); \
  619. (pos) = css_next_child((pos), (parent)))
  620. struct cgroup_subsys_state *
  621. css_next_descendant_pre(struct cgroup_subsys_state *pos,
  622. struct cgroup_subsys_state *css);
  623. struct cgroup_subsys_state *
  624. css_rightmost_descendant(struct cgroup_subsys_state *pos);
  625. /**
  626. * css_for_each_descendant_pre - pre-order walk of a css's descendants
  627. * @pos: the css * to use as the loop cursor
  628. * @root: css whose descendants to walk
  629. *
  630. * Walk @root's descendants. @root is included in the iteration and the
  631. * first node to be visited. Must be called under rcu_read_lock(). A
  632. * descendant css which hasn't finished ->css_online() or already has
  633. * finished ->css_offline() may show up during traversal and it's each
  634. * subsystem's responsibility to verify that each @pos is alive.
  635. *
  636. * If a subsystem synchronizes against the parent in its ->css_online() and
  637. * before starting iterating, and synchronizes against @pos on each
  638. * iteration, any descendant css which finished ->css_online() is
  639. * guaranteed to be visible in the future iterations.
  640. *
  641. * In other words, the following guarantees that a descendant can't escape
  642. * state updates of its ancestors.
  643. *
  644. * my_online(@css)
  645. * {
  646. * Lock @css's parent and @css;
  647. * Inherit state from the parent;
  648. * Unlock both.
  649. * }
  650. *
  651. * my_update_state(@css)
  652. * {
  653. * css_for_each_descendant_pre(@pos, @css) {
  654. * Lock @pos;
  655. * if (@pos == @css)
  656. * Update @css's state;
  657. * else
  658. * Verify @pos is alive and inherit state from its parent;
  659. * Unlock @pos;
  660. * }
  661. * }
  662. *
  663. * As long as the inheriting step, including checking the parent state, is
  664. * enclosed inside @pos locking, double-locking the parent isn't necessary
  665. * while inheriting. The state update to the parent is guaranteed to be
  666. * visible by walking order and, as long as inheriting operations to the
  667. * same @pos are atomic to each other, multiple updates racing each other
  668. * still result in the correct state. It's guaranateed that at least one
  669. * inheritance happens for any css after the latest update to its parent.
  670. *
  671. * If checking parent's state requires locking the parent, each inheriting
  672. * iteration should lock and unlock both @pos->parent and @pos.
  673. *
  674. * Alternatively, a subsystem may choose to use a single global lock to
  675. * synchronize ->css_online() and ->css_offline() against tree-walking
  676. * operations.
  677. *
  678. * It is allowed to temporarily drop RCU read lock during iteration. The
  679. * caller is responsible for ensuring that @pos remains accessible until
  680. * the start of the next iteration by, for example, bumping the css refcnt.
  681. */
  682. #define css_for_each_descendant_pre(pos, css) \
  683. for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
  684. (pos) = css_next_descendant_pre((pos), (css)))
  685. struct cgroup_subsys_state *
  686. css_next_descendant_post(struct cgroup_subsys_state *pos,
  687. struct cgroup_subsys_state *css);
  688. /**
  689. * css_for_each_descendant_post - post-order walk of a css's descendants
  690. * @pos: the css * to use as the loop cursor
  691. * @css: css whose descendants to walk
  692. *
  693. * Similar to css_for_each_descendant_pre() but performs post-order
  694. * traversal instead. @root is included in the iteration and the last
  695. * node to be visited. Note that the walk visibility guarantee described
  696. * in pre-order walk doesn't apply the same to post-order walks.
  697. */
  698. #define css_for_each_descendant_post(pos, css) \
  699. for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
  700. (pos) = css_next_descendant_post((pos), (css)))
  701. /* A css_task_iter should be treated as an opaque object */
  702. struct css_task_iter {
  703. struct cgroup_subsys_state *origin_css;
  704. struct list_head *cset_link;
  705. struct list_head *task;
  706. };
  707. void css_task_iter_start(struct cgroup_subsys_state *css,
  708. struct css_task_iter *it);
  709. struct task_struct *css_task_iter_next(struct css_task_iter *it);
  710. void css_task_iter_end(struct css_task_iter *it);
  711. int css_scan_tasks(struct cgroup_subsys_state *css,
  712. bool (*test)(struct task_struct *, void *),
  713. void (*process)(struct task_struct *, void *),
  714. void *data, struct ptr_heap *heap);
  715. int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
  716. int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
  717. struct cgroup_subsys_state *css_from_dir(struct dentry *dentry,
  718. struct cgroup_subsys *ss);
  719. #else /* !CONFIG_CGROUPS */
  720. static inline int cgroup_init_early(void) { return 0; }
  721. static inline int cgroup_init(void) { return 0; }
  722. static inline void cgroup_fork(struct task_struct *p) {}
  723. static inline void cgroup_post_fork(struct task_struct *p) {}
  724. static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
  725. static inline int cgroupstats_build(struct cgroupstats *stats,
  726. struct dentry *dentry)
  727. {
  728. return -EINVAL;
  729. }
  730. /* No cgroups - nothing to do */
  731. static inline int cgroup_attach_task_all(struct task_struct *from,
  732. struct task_struct *t)
  733. {
  734. return 0;
  735. }
  736. #endif /* !CONFIG_CGROUPS */
  737. #endif /* _LINUX_CGROUP_H */