cgroup.h 25 KB

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