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