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>
12 #include <linux/cpumask.h>
13 #include <linux/nodemask.h>
14 #include <linux/rcupdate.h>
15 #include <linux/cgroupstats.h>
16 #include <linux/prio_heap.h>
17 #include <linux/rwsem.h>
18 #include <linux/idr.h>
19
20 #ifdef CONFIG_CGROUPS
21
22 struct cgroupfs_root;
23 struct cgroup_subsys;
24 struct inode;
25 struct cgroup;
26 struct css_id;
27
28 extern int cgroup_init_early(void);
29 extern int cgroup_init(void);
30 extern void cgroup_lock(void);
31 extern int cgroup_lock_is_held(void);
32 extern bool cgroup_lock_live_group(struct cgroup *cgrp);
33 extern void cgroup_unlock(void);
34 extern void cgroup_fork(struct task_struct *p);
35 extern void cgroup_fork_callbacks(struct task_struct *p);
36 extern void cgroup_post_fork(struct task_struct *p);
37 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
38 extern int cgroupstats_build(struct cgroupstats *stats,
39 struct dentry *dentry);
40 extern int cgroup_load_subsys(struct cgroup_subsys *ss);
41 extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
42
43 extern const struct file_operations proc_cgroup_operations;
44
45 /* Define the enumeration of all builtin cgroup subsystems */
46 #define SUBSYS(_x) _x ## _subsys_id,
47 enum cgroup_subsys_id {
48 #include <linux/cgroup_subsys.h>
49 CGROUP_BUILTIN_SUBSYS_COUNT
50 };
51 #undef SUBSYS
52 /*
53 * This define indicates the maximum number of subsystems that can be loaded
54 * at once. We limit to this many since cgroupfs_root has subsys_bits to keep
55 * track of all of them.
56 */
57 #define CGROUP_SUBSYS_COUNT (BITS_PER_BYTE*sizeof(unsigned long))
58
59 /* Per-subsystem/per-cgroup state maintained by the system. */
60 struct cgroup_subsys_state {
61 /*
62 * The cgroup that this subsystem is attached to. Useful
63 * for subsystems that want to know about the cgroup
64 * hierarchy structure
65 */
66 struct cgroup *cgroup;
67
68 /*
69 * State maintained by the cgroup system to allow subsystems
70 * to be "busy". Should be accessed via css_get(),
71 * css_tryget() and and css_put().
72 */
73
74 atomic_t refcnt;
75
76 unsigned long flags;
77 /* ID for this css, if possible */
78 struct css_id __rcu *id;
79 };
80
81 /* bits in struct cgroup_subsys_state flags field */
82 enum {
83 CSS_ROOT, /* This CSS is the root of the subsystem */
84 CSS_REMOVED, /* This CSS is dead */
85 };
86
87 /*
88 * Call css_get() to hold a reference on the css; it can be used
89 * for a reference obtained via:
90 * - an existing ref-counted reference to the css
91 * - task->cgroups for a locked task
92 */
93
94 extern void __css_get(struct cgroup_subsys_state *css, int count);
css_get(struct cgroup_subsys_state * css)95 static inline void css_get(struct cgroup_subsys_state *css)
96 {
97 /* We don't need to reference count the root state */
98 if (!test_bit(CSS_ROOT, &css->flags))
99 __css_get(css, 1);
100 }
101
css_is_removed(struct cgroup_subsys_state * css)102 static inline bool css_is_removed(struct cgroup_subsys_state *css)
103 {
104 return test_bit(CSS_REMOVED, &css->flags);
105 }
106
107 /*
108 * Call css_tryget() to take a reference on a css if your existing
109 * (known-valid) reference isn't already ref-counted. Returns false if
110 * the css has been destroyed.
111 */
112
css_tryget(struct cgroup_subsys_state * css)113 static inline bool css_tryget(struct cgroup_subsys_state *css)
114 {
115 if (test_bit(CSS_ROOT, &css->flags))
116 return true;
117 while (!atomic_inc_not_zero(&css->refcnt)) {
118 if (test_bit(CSS_REMOVED, &css->flags))
119 return false;
120 cpu_relax();
121 }
122 return true;
123 }
124
125 /*
126 * css_put() should be called to release a reference taken by
127 * css_get() or css_tryget()
128 */
129
130 extern void __css_put(struct cgroup_subsys_state *css, int count);
css_put(struct cgroup_subsys_state * css)131 static inline void css_put(struct cgroup_subsys_state *css)
132 {
133 if (!test_bit(CSS_ROOT, &css->flags))
134 __css_put(css, 1);
135 }
136
137 /* bits in struct cgroup flags field */
138 enum {
139 /* Control Group is dead */
140 CGRP_REMOVED,
141 /* Control Group has ever had a child cgroup or a task */
142 CGRP_RELEASABLE,
143 /* Control Group requires release notifications to userspace */
144 CGRP_NOTIFY_ON_RELEASE,
145 /*
146 * A thread in rmdir() is wating for this cgroup.
147 */
148 CGRP_WAIT_ON_RMDIR,
149 /*
150 * Clone cgroup values when creating a new child cgroup
151 */
152 CGRP_CLONE_CHILDREN,
153 };
154
155 struct cgroup {
156 unsigned long flags; /* "unsigned long" so bitops work */
157
158 /*
159 * count users of this cgroup. >0 means busy, but doesn't
160 * necessarily indicate the number of tasks in the cgroup
161 */
162 atomic_t count;
163
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 */
170
171 struct cgroup *parent; /* my parent */
172 struct dentry __rcu *dentry; /* cgroup fs entry, RCU protected */
173
174 /* Private pointers for each registered subsystem */
175 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
176
177 struct cgroupfs_root *root;
178 struct cgroup *top_cgroup;
179
180 /*
181 * List of cg_cgroup_links pointing at css_sets with
182 * tasks in this cgroup. Protected by css_set_lock
183 */
184 struct list_head css_sets;
185
186 /*
187 * Linked list running through all cgroups that can
188 * potentially be reaped by the release agent. Protected by
189 * release_list_lock
190 */
191 struct list_head release_list;
192
193 /*
194 * list of pidlists, up to two for each namespace (one for procs, one
195 * for tasks); created on demand.
196 */
197 struct list_head pidlists;
198 struct mutex pidlist_mutex;
199
200 /* For RCU-protected deletion */
201 struct rcu_head rcu_head;
202
203 /* List of events which userspace want to receive */
204 struct list_head event_list;
205 spinlock_t event_list_lock;
206 };
207
208 /*
209 * A css_set is a structure holding pointers to a set of
210 * cgroup_subsys_state objects. This saves space in the task struct
211 * object and speeds up fork()/exit(), since a single inc/dec and a
212 * list_add()/del() can bump the reference count on the entire cgroup
213 * set for a task.
214 */
215
216 struct css_set {
217
218 /* Reference count */
219 atomic_t refcount;
220
221 /*
222 * List running through all cgroup groups in the same hash
223 * slot. Protected by css_set_lock
224 */
225 struct hlist_node hlist;
226
227 /*
228 * List running through all tasks using this cgroup
229 * group. Protected by css_set_lock
230 */
231 struct list_head tasks;
232
233 /*
234 * List of cg_cgroup_link objects on link chains from
235 * cgroups referenced from this css_set. Protected by
236 * css_set_lock
237 */
238 struct list_head cg_links;
239
240 /*
241 * Set of subsystem states, one for each subsystem. This array
242 * is immutable after creation apart from the init_css_set
243 * during subsystem registration (at boot time) and modular subsystem
244 * loading/unloading.
245 */
246 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
247
248 /* For RCU-protected deletion */
249 struct rcu_head rcu_head;
250 struct work_struct work;
251 };
252
253 /*
254 * cgroup_map_cb is an abstract callback API for reporting map-valued
255 * control files
256 */
257
258 struct cgroup_map_cb {
259 int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
260 void *state;
261 };
262
263 /*
264 * struct cftype: handler definitions for cgroup control files
265 *
266 * When reading/writing to a file:
267 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
268 * - the 'cftype' of the file is file->f_dentry->d_fsdata
269 */
270
271 #define MAX_CFTYPE_NAME 64
272 struct cftype {
273 /*
274 * By convention, the name should begin with the name of the
275 * subsystem, followed by a period
276 */
277 char name[MAX_CFTYPE_NAME];
278 int private;
279 /*
280 * If not 0, file mode is set to this value, otherwise it will
281 * be figured out automatically
282 */
283 umode_t mode;
284
285 /*
286 * If non-zero, defines the maximum length of string that can
287 * be passed to write_string; defaults to 64
288 */
289 size_t max_write_len;
290
291 int (*open)(struct inode *inode, struct file *file);
292 ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
293 struct file *file,
294 char __user *buf, size_t nbytes, loff_t *ppos);
295 /*
296 * read_u64() is a shortcut for the common case of returning a
297 * single integer. Use it in place of read()
298 */
299 u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
300 /*
301 * read_s64() is a signed version of read_u64()
302 */
303 s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
304 /*
305 * read_map() is used for defining a map of key/value
306 * pairs. It should call cb->fill(cb, key, value) for each
307 * entry. The key/value pairs (and their ordering) should not
308 * change between reboots.
309 */
310 int (*read_map)(struct cgroup *cont, struct cftype *cft,
311 struct cgroup_map_cb *cb);
312 /*
313 * read_seq_string() is used for outputting a simple sequence
314 * using seqfile.
315 */
316 int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
317 struct seq_file *m);
318
319 ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
320 struct file *file,
321 const char __user *buf, size_t nbytes, loff_t *ppos);
322
323 /*
324 * write_u64() is a shortcut for the common case of accepting
325 * a single integer (as parsed by simple_strtoull) from
326 * userspace. Use in place of write(); return 0 or error.
327 */
328 int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
329 /*
330 * write_s64() is a signed version of write_u64()
331 */
332 int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
333
334 /*
335 * write_string() is passed a nul-terminated kernelspace
336 * buffer of maximum length determined by max_write_len.
337 * Returns 0 or -ve error code.
338 */
339 int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
340 const char *buffer);
341 /*
342 * trigger() callback can be used to get some kick from the
343 * userspace, when the actual string written is not important
344 * at all. The private field can be used to determine the
345 * kick type for multiplexing.
346 */
347 int (*trigger)(struct cgroup *cgrp, unsigned int event);
348
349 int (*release)(struct inode *inode, struct file *file);
350
351 /*
352 * register_event() callback will be used to add new userspace
353 * waiter for changes related to the cftype. Implement it if
354 * you want to provide this functionality. Use eventfd_signal()
355 * on eventfd to send notification to userspace.
356 */
357 int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
358 struct eventfd_ctx *eventfd, const char *args);
359 /*
360 * unregister_event() callback will be called when userspace
361 * closes the eventfd or on cgroup removing.
362 * This callback must be implemented, if you want provide
363 * notification functionality.
364 */
365 void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
366 struct eventfd_ctx *eventfd);
367 };
368
369 struct cgroup_scanner {
370 struct cgroup *cg;
371 int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
372 void (*process_task)(struct task_struct *p,
373 struct cgroup_scanner *scan);
374 struct ptr_heap *heap;
375 void *data;
376 };
377
378 /*
379 * Add a new file to the given cgroup directory. Should only be
380 * called by subsystems from within a populate() method
381 */
382 int cgroup_add_file(struct cgroup *cgrp, struct cgroup_subsys *subsys,
383 const struct cftype *cft);
384
385 /*
386 * Add a set of new files to the given cgroup directory. Should
387 * only be called by subsystems from within a populate() method
388 */
389 int cgroup_add_files(struct cgroup *cgrp,
390 struct cgroup_subsys *subsys,
391 const struct cftype cft[],
392 int count);
393
394 int cgroup_is_removed(const struct cgroup *cgrp);
395
396 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
397
398 int cgroup_task_count(const struct cgroup *cgrp);
399
400 /* Return true if cgrp is a descendant of the task's cgroup */
401 int cgroup_is_descendant(const struct cgroup *cgrp, struct task_struct *task);
402
403 /*
404 * When the subsys has to access css and may add permanent refcnt to css,
405 * it should take care of racy conditions with rmdir(). Following set of
406 * functions, is for stop/restart rmdir if necessary.
407 * Because these will call css_get/put, "css" should be alive css.
408 *
409 * cgroup_exclude_rmdir();
410 * ...do some jobs which may access arbitrary empty cgroup
411 * cgroup_release_and_wakeup_rmdir();
412 *
413 * When someone removes a cgroup while cgroup_exclude_rmdir() holds it,
414 * it sleeps and cgroup_release_and_wakeup_rmdir() will wake him up.
415 */
416
417 void cgroup_exclude_rmdir(struct cgroup_subsys_state *css);
418 void cgroup_release_and_wakeup_rmdir(struct cgroup_subsys_state *css);
419
420 /*
421 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
422 * methods.
423 */
424 struct cgroup_taskset;
425 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
426 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
427 struct cgroup *cgroup_taskset_cur_cgroup(struct cgroup_taskset *tset);
428 int cgroup_taskset_size(struct cgroup_taskset *tset);
429
430 /**
431 * cgroup_taskset_for_each - iterate cgroup_taskset
432 * @task: the loop cursor
433 * @skip_cgrp: skip if task's cgroup matches this, %NULL to iterate through all
434 * @tset: taskset to iterate
435 */
436 #define cgroup_taskset_for_each(task, skip_cgrp, tset) \
437 for ((task) = cgroup_taskset_first((tset)); (task); \
438 (task) = cgroup_taskset_next((tset))) \
439 if (!(skip_cgrp) || \
440 cgroup_taskset_cur_cgroup((tset)) != (skip_cgrp))
441
442 /*
443 * Control Group subsystem type.
444 * See Documentation/cgroups/cgroups.txt for details
445 */
446
447 struct cgroup_subsys {
448 struct cgroup_subsys_state *(*create)(struct cgroup *cgrp);
449 int (*pre_destroy)(struct cgroup *cgrp);
450 void (*destroy)(struct cgroup *cgrp);
451 int (*allow_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
452 int (*can_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
453 void (*cancel_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
454 void (*attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
455 void (*fork)(struct task_struct *task);
456 void (*exit)(struct cgroup *cgrp, struct cgroup *old_cgrp,
457 struct task_struct *task);
458 int (*populate)(struct cgroup_subsys *ss, struct cgroup *cgrp);
459 void (*post_clone)(struct cgroup *cgrp);
460 void (*bind)(struct cgroup *root);
461
462 int subsys_id;
463 int active;
464 int disabled;
465 int early_init;
466 /*
467 * True if this subsys uses ID. ID is not available before cgroup_init()
468 * (not available in early_init time.)
469 */
470 bool use_id;
471 #define MAX_CGROUP_TYPE_NAMELEN 32
472 const char *name;
473
474 /*
475 * Protects sibling/children links of cgroups in this
476 * hierarchy, plus protects which hierarchy (or none) the
477 * subsystem is a part of (i.e. root/sibling). To avoid
478 * potential deadlocks, the following operations should not be
479 * undertaken while holding any hierarchy_mutex:
480 *
481 * - allocating memory
482 * - initiating hotplug events
483 */
484 struct mutex hierarchy_mutex;
485 struct lock_class_key subsys_key;
486
487 /*
488 * Link to parent, and list entry in parent's children.
489 * Protected by this->hierarchy_mutex and cgroup_lock()
490 */
491 struct cgroupfs_root *root;
492 struct list_head sibling;
493 /* used when use_id == true */
494 struct idr idr;
495 spinlock_t id_lock;
496
497 /* should be defined only by modular subsystems */
498 struct module *module;
499 };
500
501 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
502 #include <linux/cgroup_subsys.h>
503 #undef SUBSYS
504
cgroup_subsys_state(struct cgroup * cgrp,int subsys_id)505 static inline struct cgroup_subsys_state *cgroup_subsys_state(
506 struct cgroup *cgrp, int subsys_id)
507 {
508 return cgrp->subsys[subsys_id];
509 }
510
511 /*
512 * function to get the cgroup_subsys_state which allows for extra
513 * rcu_dereference_check() conditions, such as locks used during the
514 * cgroup_subsys::attach() methods.
515 */
516 #define task_subsys_state_check(task, subsys_id, __c) \
517 rcu_dereference_check(task->cgroups->subsys[subsys_id], \
518 lockdep_is_held(&task->alloc_lock) || \
519 cgroup_lock_is_held() || (__c))
520
521 static inline struct cgroup_subsys_state *
task_subsys_state(struct task_struct * task,int subsys_id)522 task_subsys_state(struct task_struct *task, int subsys_id)
523 {
524 return task_subsys_state_check(task, subsys_id, false);
525 }
526
task_cgroup(struct task_struct * task,int subsys_id)527 static inline struct cgroup* task_cgroup(struct task_struct *task,
528 int subsys_id)
529 {
530 return task_subsys_state(task, subsys_id)->cgroup;
531 }
532
533 /* A cgroup_iter should be treated as an opaque object */
534 struct cgroup_iter {
535 struct list_head *cg_link;
536 struct list_head *task;
537 };
538
539 /*
540 * To iterate across the tasks in a cgroup:
541 *
542 * 1) call cgroup_iter_start to initialize an iterator
543 *
544 * 2) call cgroup_iter_next() to retrieve member tasks until it
545 * returns NULL or until you want to end the iteration
546 *
547 * 3) call cgroup_iter_end() to destroy the iterator.
548 *
549 * Or, call cgroup_scan_tasks() to iterate through every task in a
550 * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
551 * the test_task() callback, but not while calling the process_task()
552 * callback.
553 */
554 void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
555 struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
556 struct cgroup_iter *it);
557 void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
558 int cgroup_scan_tasks(struct cgroup_scanner *scan);
559 int cgroup_attach_task(struct cgroup *, struct task_struct *);
560 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
561
562 /*
563 * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
564 * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
565 * CSS ID is assigned at cgroup allocation (create) automatically
566 * and removed when subsys calls free_css_id() function. This is because
567 * the lifetime of cgroup_subsys_state is subsys's matter.
568 *
569 * Looking up and scanning function should be called under rcu_read_lock().
570 * Taking cgroup_mutex()/hierarchy_mutex() is not necessary for following calls.
571 * But the css returned by this routine can be "not populated yet" or "being
572 * destroyed". The caller should check css and cgroup's status.
573 */
574
575 /*
576 * Typically Called at ->destroy(), or somewhere the subsys frees
577 * cgroup_subsys_state.
578 */
579 void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
580
581 /* Find a cgroup_subsys_state which has given ID */
582
583 struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
584
585 /*
586 * Get a cgroup whose id is greater than or equal to id under tree of root.
587 * Returning a cgroup_subsys_state or NULL.
588 */
589 struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
590 struct cgroup_subsys_state *root, int *foundid);
591
592 /* Returns true if root is ancestor of cg */
593 bool css_is_ancestor(struct cgroup_subsys_state *cg,
594 const struct cgroup_subsys_state *root);
595
596 /* Get id and depth of css */
597 unsigned short css_id(struct cgroup_subsys_state *css);
598 unsigned short css_depth(struct cgroup_subsys_state *css);
599 struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
600
601 #else /* !CONFIG_CGROUPS */
602
cgroup_init_early(void)603 static inline int cgroup_init_early(void) { return 0; }
cgroup_init(void)604 static inline int cgroup_init(void) { return 0; }
cgroup_fork(struct task_struct * p)605 static inline void cgroup_fork(struct task_struct *p) {}
cgroup_fork_callbacks(struct task_struct * p)606 static inline void cgroup_fork_callbacks(struct task_struct *p) {}
cgroup_post_fork(struct task_struct * p)607 static inline void cgroup_post_fork(struct task_struct *p) {}
cgroup_exit(struct task_struct * p,int callbacks)608 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
609
cgroup_lock(void)610 static inline void cgroup_lock(void) {}
cgroup_unlock(void)611 static inline void cgroup_unlock(void) {}
cgroupstats_build(struct cgroupstats * stats,struct dentry * dentry)612 static inline int cgroupstats_build(struct cgroupstats *stats,
613 struct dentry *dentry)
614 {
615 return -EINVAL;
616 }
617
618 /* No cgroups - nothing to do */
cgroup_attach_task_all(struct task_struct * from,struct task_struct * t)619 static inline int cgroup_attach_task_all(struct task_struct *from,
620 struct task_struct *t)
621 {
622 return 0;
623 }
624
625 #endif /* !CONFIG_CGROUPS */
626
627 #endif /* _LINUX_CGROUP_H */
628