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