cgroup.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  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. #ifdef CONFIG_CGROUPS
  23. struct cgroupfs_root;
  24. struct cgroup_subsys;
  25. struct inode;
  26. struct cgroup;
  27. struct css_id;
  28. extern int cgroup_init_early(void);
  29. extern int cgroup_init(void);
  30. extern void cgroup_fork(struct task_struct *p);
  31. extern void cgroup_post_fork(struct task_struct *p);
  32. extern void cgroup_exit(struct task_struct *p, int run_callbacks);
  33. extern int cgroupstats_build(struct cgroupstats *stats,
  34. struct dentry *dentry);
  35. extern int cgroup_load_subsys(struct cgroup_subsys *ss);
  36. extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
  37. extern const struct file_operations proc_cgroup_operations;
  38. /*
  39. * Define the enumeration of all cgroup subsystems.
  40. *
  41. * We define ids for builtin subsystems and then modular ones.
  42. */
  43. #define SUBSYS(_x) _x ## _subsys_id,
  44. enum cgroup_subsys_id {
  45. #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
  46. #include <linux/cgroup_subsys.h>
  47. #undef IS_SUBSYS_ENABLED
  48. CGROUP_BUILTIN_SUBSYS_COUNT,
  49. __CGROUP_SUBSYS_TEMP_PLACEHOLDER = CGROUP_BUILTIN_SUBSYS_COUNT - 1,
  50. #define IS_SUBSYS_ENABLED(option) IS_MODULE(option)
  51. #include <linux/cgroup_subsys.h>
  52. #undef IS_SUBSYS_ENABLED
  53. CGROUP_SUBSYS_COUNT,
  54. };
  55. #undef SUBSYS
  56. /* Per-subsystem/per-cgroup state maintained by the system. */
  57. struct cgroup_subsys_state {
  58. /*
  59. * The cgroup that this subsystem is attached to. Useful
  60. * for subsystems that want to know about the cgroup
  61. * hierarchy structure
  62. */
  63. struct cgroup *cgroup;
  64. /*
  65. * State maintained by the cgroup system to allow subsystems
  66. * to be "busy". Should be accessed via css_get(),
  67. * css_tryget() and css_put().
  68. */
  69. atomic_t refcnt;
  70. unsigned long flags;
  71. /* ID for this css, if possible */
  72. struct css_id __rcu *id;
  73. /* Used to put @cgroup->dentry on the last css_put() */
  74. struct work_struct dput_work;
  75. };
  76. /* bits in struct cgroup_subsys_state flags field */
  77. enum {
  78. CSS_ROOT = (1 << 0), /* this CSS is the root of the subsystem */
  79. CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
  80. };
  81. /* Caller must verify that the css is not for root cgroup */
  82. static inline void __css_get(struct cgroup_subsys_state *css, int count)
  83. {
  84. atomic_add(count, &css->refcnt);
  85. }
  86. /*
  87. * Call css_get() to hold a reference on the css; it can be used
  88. * for a reference obtained via:
  89. * - an existing ref-counted reference to the css
  90. * - task->cgroups for a locked task
  91. */
  92. static inline void css_get(struct cgroup_subsys_state *css)
  93. {
  94. /* We don't need to reference count the root state */
  95. if (!(css->flags & CSS_ROOT))
  96. __css_get(css, 1);
  97. }
  98. /*
  99. * Call css_tryget() to take a reference on a css if your existing
  100. * (known-valid) reference isn't already ref-counted. Returns false if
  101. * the css has been destroyed.
  102. */
  103. extern bool __css_tryget(struct cgroup_subsys_state *css);
  104. static inline bool css_tryget(struct cgroup_subsys_state *css)
  105. {
  106. if (css->flags & CSS_ROOT)
  107. return true;
  108. return __css_tryget(css);
  109. }
  110. /*
  111. * css_put() should be called to release a reference taken by
  112. * css_get() or css_tryget()
  113. */
  114. extern void __css_put(struct cgroup_subsys_state *css);
  115. static inline void css_put(struct cgroup_subsys_state *css)
  116. {
  117. if (!(css->flags & CSS_ROOT))
  118. __css_put(css);
  119. }
  120. /* bits in struct cgroup flags field */
  121. enum {
  122. /* Control Group is dead */
  123. CGRP_REMOVED,
  124. /*
  125. * Control Group has previously had a child cgroup or a task,
  126. * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
  127. */
  128. CGRP_RELEASABLE,
  129. /* Control Group requires release notifications to userspace */
  130. CGRP_NOTIFY_ON_RELEASE,
  131. /*
  132. * Clone the parent's configuration when creating a new child
  133. * cpuset cgroup. For historical reasons, this option can be
  134. * specified at mount time and thus is implemented here.
  135. */
  136. CGRP_CPUSET_CLONE_CHILDREN,
  137. /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
  138. CGRP_SANE_BEHAVIOR,
  139. };
  140. struct cgroup_name {
  141. struct rcu_head rcu_head;
  142. char name[];
  143. };
  144. struct cgroup {
  145. unsigned long flags; /* "unsigned long" so bitops work */
  146. /*
  147. * count users of this cgroup. >0 means busy, but doesn't
  148. * necessarily indicate the number of tasks in the cgroup
  149. */
  150. atomic_t count;
  151. int id; /* ida allocated in-hierarchy ID */
  152. /*
  153. * We link our 'sibling' struct into our parent's 'children'.
  154. * Our children link their 'sibling' into our 'children'.
  155. */
  156. struct list_head sibling; /* my parent's children */
  157. struct list_head children; /* my children */
  158. struct list_head files; /* my files */
  159. struct cgroup *parent; /* my parent */
  160. struct dentry *dentry; /* cgroup fs entry, RCU protected */
  161. /*
  162. * This is a copy of dentry->d_name, and it's needed because
  163. * we can't use dentry->d_name in cgroup_path().
  164. *
  165. * You must acquire rcu_read_lock() to access cgrp->name, and
  166. * the only place that can change it is rename(), which is
  167. * protected by parent dir's i_mutex.
  168. *
  169. * Normally you should use cgroup_name() wrapper rather than
  170. * access it directly.
  171. */
  172. struct cgroup_name __rcu *name;
  173. /* Private pointers for each registered subsystem */
  174. struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
  175. struct cgroupfs_root *root;
  176. /*
  177. * List of cg_cgroup_links pointing at css_sets with
  178. * tasks in this cgroup. Protected by css_set_lock
  179. */
  180. struct list_head css_sets;
  181. struct list_head allcg_node; /* cgroupfs_root->allcg_list */
  182. struct list_head cft_q_node; /* used during cftype add/rm */
  183. /*
  184. * Linked list running through all cgroups that can
  185. * potentially be reaped by the release agent. Protected by
  186. * release_list_lock
  187. */
  188. struct list_head release_list;
  189. /*
  190. * list of pidlists, up to two for each namespace (one for procs, one
  191. * for tasks); created on demand.
  192. */
  193. struct list_head pidlists;
  194. struct mutex pidlist_mutex;
  195. /* For RCU-protected deletion */
  196. struct rcu_head rcu_head;
  197. struct work_struct free_work;
  198. /* List of events which userspace want to receive */
  199. struct list_head event_list;
  200. spinlock_t event_list_lock;
  201. /* directory xattrs */
  202. struct simple_xattrs xattrs;
  203. };
  204. #define MAX_CGROUP_ROOT_NAMELEN 64
  205. /* cgroupfs_root->flags */
  206. enum {
  207. /*
  208. * Unfortunately, cgroup core and various controllers are riddled
  209. * with idiosyncrasies and pointless options. The following flag,
  210. * when set, will force sane behavior - some options are forced on,
  211. * others are disallowed, and some controllers will change their
  212. * hierarchical or other behaviors.
  213. *
  214. * The set of behaviors affected by this flag are still being
  215. * determined and developed and the mount option for this flag is
  216. * prefixed with __DEVEL__. The prefix will be dropped once we
  217. * reach the point where all behaviors are compatible with the
  218. * planned unified hierarchy, which will automatically turn on this
  219. * flag.
  220. *
  221. * The followings are the behaviors currently affected this flag.
  222. *
  223. * - Mount options "noprefix" and "clone_children" are disallowed.
  224. * Also, cgroupfs file cgroup.clone_children is not created.
  225. *
  226. * - When mounting an existing superblock, mount options should
  227. * match.
  228. *
  229. * - Remount is disallowed.
  230. *
  231. * The followings are planned changes.
  232. *
  233. * - release_agent will be disallowed once replacement notification
  234. * mechanism is implemented.
  235. */
  236. CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
  237. CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
  238. CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
  239. };
  240. /*
  241. * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
  242. * associated with a superblock to form an active hierarchy. This is
  243. * internal to cgroup core. Don't access directly from controllers.
  244. */
  245. struct cgroupfs_root {
  246. struct super_block *sb;
  247. /*
  248. * The bitmask of subsystems intended to be attached to this
  249. * hierarchy
  250. */
  251. unsigned long subsys_mask;
  252. /* Unique id for this hierarchy. */
  253. int hierarchy_id;
  254. /* The bitmask of subsystems currently attached to this hierarchy */
  255. unsigned long actual_subsys_mask;
  256. /* A list running through the attached subsystems */
  257. struct list_head subsys_list;
  258. /* The root cgroup for this hierarchy */
  259. struct cgroup top_cgroup;
  260. /* Tracks how many cgroups are currently defined in hierarchy.*/
  261. int number_of_cgroups;
  262. /* A list running through the active hierarchies */
  263. struct list_head root_list;
  264. /* All cgroups on this root, cgroup_mutex protected */
  265. struct list_head allcg_list;
  266. /* Hierarchy-specific flags */
  267. unsigned long flags;
  268. /* IDs for cgroups in this hierarchy */
  269. struct ida cgroup_ida;
  270. /* The path to use for release notifications. */
  271. char release_agent_path[PATH_MAX];
  272. /* The name for this hierarchy - may be empty */
  273. char name[MAX_CGROUP_ROOT_NAMELEN];
  274. };
  275. /*
  276. * A css_set is a structure holding pointers to a set of
  277. * cgroup_subsys_state objects. This saves space in the task struct
  278. * object and speeds up fork()/exit(), since a single inc/dec and a
  279. * list_add()/del() can bump the reference count on the entire cgroup
  280. * set for a task.
  281. */
  282. struct css_set {
  283. /* Reference count */
  284. atomic_t refcount;
  285. /*
  286. * List running through all cgroup groups in the same hash
  287. * slot. Protected by css_set_lock
  288. */
  289. struct hlist_node hlist;
  290. /*
  291. * List running through all tasks using this cgroup
  292. * group. Protected by css_set_lock
  293. */
  294. struct list_head tasks;
  295. /*
  296. * List of cg_cgroup_link objects on link chains from
  297. * cgroups referenced from this css_set. Protected by
  298. * css_set_lock
  299. */
  300. struct list_head cg_links;
  301. /*
  302. * Set of subsystem states, one for each subsystem. This array
  303. * is immutable after creation apart from the init_css_set
  304. * during subsystem registration (at boot time) and modular subsystem
  305. * loading/unloading.
  306. */
  307. struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
  308. /* For RCU-protected deletion */
  309. struct rcu_head rcu_head;
  310. };
  311. /*
  312. * cgroup_map_cb is an abstract callback API for reporting map-valued
  313. * control files
  314. */
  315. struct cgroup_map_cb {
  316. int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
  317. void *state;
  318. };
  319. /*
  320. * struct cftype: handler definitions for cgroup control files
  321. *
  322. * When reading/writing to a file:
  323. * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
  324. * - the 'cftype' of the file is file->f_dentry->d_fsdata
  325. */
  326. /* cftype->flags */
  327. #define CFTYPE_ONLY_ON_ROOT (1U << 0) /* only create on root cg */
  328. #define CFTYPE_NOT_ON_ROOT (1U << 1) /* don't create on root cg */
  329. #define CFTYPE_INSANE (1U << 2) /* don't create if sane_behavior */
  330. #define MAX_CFTYPE_NAME 64
  331. struct cftype {
  332. /*
  333. * By convention, the name should begin with the name of the
  334. * subsystem, followed by a period. Zero length string indicates
  335. * end of cftype array.
  336. */
  337. char name[MAX_CFTYPE_NAME];
  338. int private;
  339. /*
  340. * If not 0, file mode is set to this value, otherwise it will
  341. * be figured out automatically
  342. */
  343. umode_t mode;
  344. /*
  345. * If non-zero, defines the maximum length of string that can
  346. * be passed to write_string; defaults to 64
  347. */
  348. size_t max_write_len;
  349. /* CFTYPE_* flags */
  350. unsigned int flags;
  351. /* file xattrs */
  352. struct simple_xattrs xattrs;
  353. int (*open)(struct inode *inode, struct file *file);
  354. ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
  355. struct file *file,
  356. char __user *buf, size_t nbytes, loff_t *ppos);
  357. /*
  358. * read_u64() is a shortcut for the common case of returning a
  359. * single integer. Use it in place of read()
  360. */
  361. u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
  362. /*
  363. * read_s64() is a signed version of read_u64()
  364. */
  365. s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
  366. /*
  367. * read_map() is used for defining a map of key/value
  368. * pairs. It should call cb->fill(cb, key, value) for each
  369. * entry. The key/value pairs (and their ordering) should not
  370. * change between reboots.
  371. */
  372. int (*read_map)(struct cgroup *cont, struct cftype *cft,
  373. struct cgroup_map_cb *cb);
  374. /*
  375. * read_seq_string() is used for outputting a simple sequence
  376. * using seqfile.
  377. */
  378. int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
  379. struct seq_file *m);
  380. ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
  381. struct file *file,
  382. const char __user *buf, size_t nbytes, loff_t *ppos);
  383. /*
  384. * write_u64() is a shortcut for the common case of accepting
  385. * a single integer (as parsed by simple_strtoull) from
  386. * userspace. Use in place of write(); return 0 or error.
  387. */
  388. int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
  389. /*
  390. * write_s64() is a signed version of write_u64()
  391. */
  392. int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
  393. /*
  394. * write_string() is passed a nul-terminated kernelspace
  395. * buffer of maximum length determined by max_write_len.
  396. * Returns 0 or -ve error code.
  397. */
  398. int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
  399. const char *buffer);
  400. /*
  401. * trigger() callback can be used to get some kick from the
  402. * userspace, when the actual string written is not important
  403. * at all. The private field can be used to determine the
  404. * kick type for multiplexing.
  405. */
  406. int (*trigger)(struct cgroup *cgrp, unsigned int event);
  407. int (*release)(struct inode *inode, struct file *file);
  408. /*
  409. * register_event() callback will be used to add new userspace
  410. * waiter for changes related to the cftype. Implement it if
  411. * you want to provide this functionality. Use eventfd_signal()
  412. * on eventfd to send notification to userspace.
  413. */
  414. int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
  415. struct eventfd_ctx *eventfd, const char *args);
  416. /*
  417. * unregister_event() callback will be called when userspace
  418. * closes the eventfd or on cgroup removing.
  419. * This callback must be implemented, if you want provide
  420. * notification functionality.
  421. */
  422. void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
  423. struct eventfd_ctx *eventfd);
  424. };
  425. /*
  426. * cftype_sets describe cftypes belonging to a subsystem and are chained at
  427. * cgroup_subsys->cftsets. Each cftset points to an array of cftypes
  428. * terminated by zero length name.
  429. */
  430. struct cftype_set {
  431. struct list_head node; /* chained at subsys->cftsets */
  432. struct cftype *cfts;
  433. };
  434. struct cgroup_scanner {
  435. struct cgroup *cg;
  436. int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
  437. void (*process_task)(struct task_struct *p,
  438. struct cgroup_scanner *scan);
  439. struct ptr_heap *heap;
  440. void *data;
  441. };
  442. /*
  443. * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
  444. * function can be called as long as @cgrp is accessible.
  445. */
  446. static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
  447. {
  448. return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
  449. }
  450. /* Caller should hold rcu_read_lock() */
  451. static inline const char *cgroup_name(const struct cgroup *cgrp)
  452. {
  453. return rcu_dereference(cgrp->name)->name;
  454. }
  455. int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  456. int cgroup_rm_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  457. int cgroup_is_removed(const struct cgroup *cgrp);
  458. bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
  459. int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
  460. int cgroup_task_count(const struct cgroup *cgrp);
  461. /*
  462. * Control Group taskset, used to pass around set of tasks to cgroup_subsys
  463. * methods.
  464. */
  465. struct cgroup_taskset;
  466. struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
  467. struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
  468. struct cgroup *cgroup_taskset_cur_cgroup(struct cgroup_taskset *tset);
  469. int cgroup_taskset_size(struct cgroup_taskset *tset);
  470. /**
  471. * cgroup_taskset_for_each - iterate cgroup_taskset
  472. * @task: the loop cursor
  473. * @skip_cgrp: skip if task's cgroup matches this, %NULL to iterate through all
  474. * @tset: taskset to iterate
  475. */
  476. #define cgroup_taskset_for_each(task, skip_cgrp, tset) \
  477. for ((task) = cgroup_taskset_first((tset)); (task); \
  478. (task) = cgroup_taskset_next((tset))) \
  479. if (!(skip_cgrp) || \
  480. cgroup_taskset_cur_cgroup((tset)) != (skip_cgrp))
  481. /*
  482. * Control Group subsystem type.
  483. * See Documentation/cgroups/cgroups.txt for details
  484. */
  485. struct cgroup_subsys {
  486. struct cgroup_subsys_state *(*css_alloc)(struct cgroup *cgrp);
  487. int (*css_online)(struct cgroup *cgrp);
  488. void (*css_offline)(struct cgroup *cgrp);
  489. void (*css_free)(struct cgroup *cgrp);
  490. int (*can_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
  491. void (*cancel_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
  492. void (*attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
  493. void (*fork)(struct task_struct *task);
  494. void (*exit)(struct cgroup *cgrp, struct cgroup *old_cgrp,
  495. struct task_struct *task);
  496. void (*bind)(struct cgroup *root);
  497. int subsys_id;
  498. int active;
  499. int disabled;
  500. int early_init;
  501. /*
  502. * True if this subsys uses ID. ID is not available before cgroup_init()
  503. * (not available in early_init time.)
  504. */
  505. bool use_id;
  506. /*
  507. * If %false, this subsystem is properly hierarchical -
  508. * configuration, resource accounting and restriction on a parent
  509. * cgroup cover those of its children. If %true, hierarchy support
  510. * is broken in some ways - some subsystems ignore hierarchy
  511. * completely while others are only implemented half-way.
  512. *
  513. * It's now disallowed to create nested cgroups if the subsystem is
  514. * broken and cgroup core will emit a warning message on such
  515. * cases. Eventually, all subsystems will be made properly
  516. * hierarchical and this will go away.
  517. */
  518. bool broken_hierarchy;
  519. bool warned_broken_hierarchy;
  520. #define MAX_CGROUP_TYPE_NAMELEN 32
  521. const char *name;
  522. /*
  523. * Link to parent, and list entry in parent's children.
  524. * Protected by cgroup_lock()
  525. */
  526. struct cgroupfs_root *root;
  527. struct list_head sibling;
  528. /* used when use_id == true */
  529. struct idr idr;
  530. spinlock_t id_lock;
  531. /* list of cftype_sets */
  532. struct list_head cftsets;
  533. /* base cftypes, automatically [de]registered with subsys itself */
  534. struct cftype *base_cftypes;
  535. struct cftype_set base_cftset;
  536. /* should be defined only by modular subsystems */
  537. struct module *module;
  538. };
  539. #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
  540. #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
  541. #include <linux/cgroup_subsys.h>
  542. #undef IS_SUBSYS_ENABLED
  543. #undef SUBSYS
  544. static inline struct cgroup_subsys_state *cgroup_subsys_state(
  545. struct cgroup *cgrp, int subsys_id)
  546. {
  547. return cgrp->subsys[subsys_id];
  548. }
  549. /*
  550. * function to get the cgroup_subsys_state which allows for extra
  551. * rcu_dereference_check() conditions, such as locks used during the
  552. * cgroup_subsys::attach() methods.
  553. */
  554. #ifdef CONFIG_PROVE_RCU
  555. extern struct mutex cgroup_mutex;
  556. #define task_subsys_state_check(task, subsys_id, __c) \
  557. rcu_dereference_check((task)->cgroups->subsys[(subsys_id)], \
  558. lockdep_is_held(&(task)->alloc_lock) || \
  559. lockdep_is_held(&cgroup_mutex) || (__c))
  560. #else
  561. #define task_subsys_state_check(task, subsys_id, __c) \
  562. rcu_dereference((task)->cgroups->subsys[(subsys_id)])
  563. #endif
  564. static inline struct cgroup_subsys_state *
  565. task_subsys_state(struct task_struct *task, int subsys_id)
  566. {
  567. return task_subsys_state_check(task, subsys_id, false);
  568. }
  569. static inline struct cgroup* task_cgroup(struct task_struct *task,
  570. int subsys_id)
  571. {
  572. return task_subsys_state(task, subsys_id)->cgroup;
  573. }
  574. /**
  575. * cgroup_for_each_child - iterate through children of a cgroup
  576. * @pos: the cgroup * to use as the loop cursor
  577. * @cgroup: cgroup whose children to walk
  578. *
  579. * Walk @cgroup's children. Must be called under rcu_read_lock(). A child
  580. * cgroup which hasn't finished ->css_online() or already has finished
  581. * ->css_offline() may show up during traversal and it's each subsystem's
  582. * responsibility to verify that each @pos is alive.
  583. *
  584. * If a subsystem synchronizes against the parent in its ->css_online() and
  585. * before starting iterating, a cgroup which finished ->css_online() is
  586. * guaranteed to be visible in the future iterations.
  587. */
  588. #define cgroup_for_each_child(pos, cgroup) \
  589. list_for_each_entry_rcu(pos, &(cgroup)->children, sibling)
  590. struct cgroup *cgroup_next_descendant_pre(struct cgroup *pos,
  591. struct cgroup *cgroup);
  592. struct cgroup *cgroup_rightmost_descendant(struct cgroup *pos);
  593. /**
  594. * cgroup_for_each_descendant_pre - pre-order walk of a cgroup's descendants
  595. * @pos: the cgroup * to use as the loop cursor
  596. * @cgroup: cgroup whose descendants to walk
  597. *
  598. * Walk @cgroup's descendants. Must be called under rcu_read_lock(). A
  599. * descendant cgroup which hasn't finished ->css_online() or already has
  600. * finished ->css_offline() may show up during traversal and it's each
  601. * subsystem's responsibility to verify that each @pos is alive.
  602. *
  603. * If a subsystem synchronizes against the parent in its ->css_online() and
  604. * before starting iterating, and synchronizes against @pos on each
  605. * iteration, any descendant cgroup which finished ->css_offline() is
  606. * guaranteed to be visible in the future iterations.
  607. *
  608. * In other words, the following guarantees that a descendant can't escape
  609. * state updates of its ancestors.
  610. *
  611. * my_online(@cgrp)
  612. * {
  613. * Lock @cgrp->parent and @cgrp;
  614. * Inherit state from @cgrp->parent;
  615. * Unlock both.
  616. * }
  617. *
  618. * my_update_state(@cgrp)
  619. * {
  620. * Lock @cgrp;
  621. * Update @cgrp's state;
  622. * Unlock @cgrp;
  623. *
  624. * cgroup_for_each_descendant_pre(@pos, @cgrp) {
  625. * Lock @pos;
  626. * Verify @pos is alive and inherit state from @pos->parent;
  627. * Unlock @pos;
  628. * }
  629. * }
  630. *
  631. * As long as the inheriting step, including checking the parent state, is
  632. * enclosed inside @pos locking, double-locking the parent isn't necessary
  633. * while inheriting. The state update to the parent is guaranteed to be
  634. * visible by walking order and, as long as inheriting operations to the
  635. * same @pos are atomic to each other, multiple updates racing each other
  636. * still result in the correct state. It's guaranateed that at least one
  637. * inheritance happens for any cgroup after the latest update to its
  638. * parent.
  639. *
  640. * If checking parent's state requires locking the parent, each inheriting
  641. * iteration should lock and unlock both @pos->parent and @pos.
  642. *
  643. * Alternatively, a subsystem may choose to use a single global lock to
  644. * synchronize ->css_online() and ->css_offline() against tree-walking
  645. * operations.
  646. */
  647. #define cgroup_for_each_descendant_pre(pos, cgroup) \
  648. for (pos = cgroup_next_descendant_pre(NULL, (cgroup)); (pos); \
  649. pos = cgroup_next_descendant_pre((pos), (cgroup)))
  650. struct cgroup *cgroup_next_descendant_post(struct cgroup *pos,
  651. struct cgroup *cgroup);
  652. /**
  653. * cgroup_for_each_descendant_post - post-order walk of a cgroup's descendants
  654. * @pos: the cgroup * to use as the loop cursor
  655. * @cgroup: cgroup whose descendants to walk
  656. *
  657. * Similar to cgroup_for_each_descendant_pre() but performs post-order
  658. * traversal instead. Note that the walk visibility guarantee described in
  659. * pre-order walk doesn't apply the same to post-order walks.
  660. */
  661. #define cgroup_for_each_descendant_post(pos, cgroup) \
  662. for (pos = cgroup_next_descendant_post(NULL, (cgroup)); (pos); \
  663. pos = cgroup_next_descendant_post((pos), (cgroup)))
  664. /* A cgroup_iter should be treated as an opaque object */
  665. struct cgroup_iter {
  666. struct list_head *cg_link;
  667. struct list_head *task;
  668. };
  669. /*
  670. * To iterate across the tasks in a cgroup:
  671. *
  672. * 1) call cgroup_iter_start to initialize an iterator
  673. *
  674. * 2) call cgroup_iter_next() to retrieve member tasks until it
  675. * returns NULL or until you want to end the iteration
  676. *
  677. * 3) call cgroup_iter_end() to destroy the iterator.
  678. *
  679. * Or, call cgroup_scan_tasks() to iterate through every task in a
  680. * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
  681. * the test_task() callback, but not while calling the process_task()
  682. * callback.
  683. */
  684. void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
  685. struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
  686. struct cgroup_iter *it);
  687. void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
  688. int cgroup_scan_tasks(struct cgroup_scanner *scan);
  689. int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
  690. int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
  691. /*
  692. * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
  693. * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
  694. * CSS ID is assigned at cgroup allocation (create) automatically
  695. * and removed when subsys calls free_css_id() function. This is because
  696. * the lifetime of cgroup_subsys_state is subsys's matter.
  697. *
  698. * Looking up and scanning function should be called under rcu_read_lock().
  699. * Taking cgroup_mutex is not necessary for following calls.
  700. * But the css returned by this routine can be "not populated yet" or "being
  701. * destroyed". The caller should check css and cgroup's status.
  702. */
  703. /*
  704. * Typically Called at ->destroy(), or somewhere the subsys frees
  705. * cgroup_subsys_state.
  706. */
  707. void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
  708. /* Find a cgroup_subsys_state which has given ID */
  709. struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
  710. /*
  711. * Get a cgroup whose id is greater than or equal to id under tree of root.
  712. * Returning a cgroup_subsys_state or NULL.
  713. */
  714. struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
  715. struct cgroup_subsys_state *root, int *foundid);
  716. /* Returns true if root is ancestor of cg */
  717. bool css_is_ancestor(struct cgroup_subsys_state *cg,
  718. const struct cgroup_subsys_state *root);
  719. /* Get id and depth of css */
  720. unsigned short css_id(struct cgroup_subsys_state *css);
  721. unsigned short css_depth(struct cgroup_subsys_state *css);
  722. struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
  723. #else /* !CONFIG_CGROUPS */
  724. static inline int cgroup_init_early(void) { return 0; }
  725. static inline int cgroup_init(void) { return 0; }
  726. static inline void cgroup_fork(struct task_struct *p) {}
  727. static inline void cgroup_post_fork(struct task_struct *p) {}
  728. static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
  729. static inline void cgroup_lock(void) {}
  730. static inline void cgroup_unlock(void) {}
  731. static inline int cgroupstats_build(struct cgroupstats *stats,
  732. struct dentry *dentry)
  733. {
  734. return -EINVAL;
  735. }
  736. /* No cgroups - nothing to do */
  737. static inline int cgroup_attach_task_all(struct task_struct *from,
  738. struct task_struct *t)
  739. {
  740. return 0;
  741. }
  742. #endif /* !CONFIG_CGROUPS */
  743. #endif /* _LINUX_CGROUP_H */