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