50a1581e3129ffdf09ed72068b1e3cc0a609388a
[linux-2.6.git] / include / linux / cgroup.h
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);
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
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
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);
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 /* which pidlist file are we talking about? */
156 enum cgroup_filetype {
157         CGROUP_FILE_PROCS,
158         CGROUP_FILE_TASKS,
159 };
160
161 /*
162  * A pidlist is a list of pids that virtually represents the contents of one
163  * of the cgroup files ("procs" or "tasks"). We keep a list of such pidlists,
164  * a pair (one each for procs, tasks) for each pid namespace that's relevant
165  * to the cgroup.
166  */
167 struct cgroup_pidlist {
168         /*
169          * used to find which pidlist is wanted. doesn't change as long as
170          * this particular list stays in the list.
171          */
172         struct { enum cgroup_filetype type; struct pid_namespace *ns; } key;
173         /* array of xids */
174         pid_t *list;
175         /* how many elements the above list has */
176         int length;
177         /* how many files are using the current array */
178         int use_count;
179         /* each of these stored in a list by its cgroup */
180         struct list_head links;
181         /* pointer to the cgroup we belong to, for list removal purposes */
182         struct cgroup *owner;
183         /* protects the other fields */
184         struct rw_semaphore mutex;
185 };
186
187 struct cgroup {
188         unsigned long flags;            /* "unsigned long" so bitops work */
189
190         /*
191          * count users of this cgroup. >0 means busy, but doesn't
192          * necessarily indicate the number of tasks in the cgroup
193          */
194         atomic_t count;
195
196         /*
197          * We link our 'sibling' struct into our parent's 'children'.
198          * Our children link their 'sibling' into our 'children'.
199          */
200         struct list_head sibling;       /* my parent's children */
201         struct list_head children;      /* my children */
202
203         struct cgroup *parent;          /* my parent */
204         struct dentry __rcu *dentry;    /* cgroup fs entry, RCU protected */
205
206         /* Private pointers for each registered subsystem */
207         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
208
209         struct cgroupfs_root *root;
210         struct cgroup *top_cgroup;
211
212         /*
213          * List of cg_cgroup_links pointing at css_sets with
214          * tasks in this cgroup. Protected by css_set_lock
215          */
216         struct list_head css_sets;
217
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;
224
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;
231
232         /* For RCU-protected deletion */
233         struct rcu_head rcu_head;
234
235         /* List of events which userspace want to receive */
236         struct list_head event_list;
237         spinlock_t event_list_lock;
238 };
239
240 /*
241  * A css_set is a structure holding pointers to a set of
242  * cgroup_subsys_state objects. This saves space in the task struct
243  * object and speeds up fork()/exit(), since a single inc/dec and a
244  * list_add()/del() can bump the reference count on the entire cgroup
245  * set for a task.
246  */
247
248 struct css_set {
249
250         /* Reference count */
251         atomic_t refcount;
252
253         /*
254          * List running through all cgroup groups in the same hash
255          * slot. Protected by css_set_lock
256          */
257         struct hlist_node hlist;
258
259         /*
260          * List running through all tasks using this cgroup
261          * group. Protected by css_set_lock
262          */
263         struct list_head tasks;
264
265         /*
266          * List of cg_cgroup_link objects on link chains from
267          * cgroups referenced from this css_set. Protected by
268          * css_set_lock
269          */
270         struct list_head cg_links;
271
272         /*
273          * Set of subsystem states, one for each subsystem. This array
274          * is immutable after creation apart from the init_css_set
275          * during subsystem registration (at boot time) and modular subsystem
276          * loading/unloading.
277          */
278         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
279
280         /* For RCU-protected deletion */
281         struct rcu_head rcu_head;
282 };
283
284 /*
285  * cgroup_map_cb is an abstract callback API for reporting map-valued
286  * control files
287  */
288
289 struct cgroup_map_cb {
290         int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
291         void *state;
292 };
293
294 /*
295  * struct cftype: handler definitions for cgroup control files
296  *
297  * When reading/writing to a file:
298  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
299  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
300  */
301
302 #define MAX_CFTYPE_NAME 64
303 struct cftype {
304         /*
305          * By convention, the name should begin with the name of the
306          * subsystem, followed by a period
307          */
308         char name[MAX_CFTYPE_NAME];
309         int private;
310         /*
311          * If not 0, file mode is set to this value, otherwise it will
312          * be figured out automatically
313          */
314         mode_t mode;
315
316         /*
317          * If non-zero, defines the maximum length of string that can
318          * be passed to write_string; defaults to 64
319          */
320         size_t max_write_len;
321
322         int (*open)(struct inode *inode, struct file *file);
323         ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
324                         struct file *file,
325                         char __user *buf, size_t nbytes, loff_t *ppos);
326         /*
327          * read_u64() is a shortcut for the common case of returning a
328          * single integer. Use it in place of read()
329          */
330         u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
331         /*
332          * read_s64() is a signed version of read_u64()
333          */
334         s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
335         /*
336          * read_map() is used for defining a map of key/value
337          * pairs. It should call cb->fill(cb, key, value) for each
338          * entry. The key/value pairs (and their ordering) should not
339          * change between reboots.
340          */
341         int (*read_map)(struct cgroup *cont, struct cftype *cft,
342                         struct cgroup_map_cb *cb);
343         /*
344          * read_seq_string() is used for outputting a simple sequence
345          * using seqfile.
346          */
347         int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
348                                struct seq_file *m);
349
350         ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
351                          struct file *file,
352                          const char __user *buf, size_t nbytes, loff_t *ppos);
353
354         /*
355          * write_u64() is a shortcut for the common case of accepting
356          * a single integer (as parsed by simple_strtoull) from
357          * userspace. Use in place of write(); return 0 or error.
358          */
359         int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
360         /*
361          * write_s64() is a signed version of write_u64()
362          */
363         int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
364
365         /*
366          * write_string() is passed a nul-terminated kernelspace
367          * buffer of maximum length determined by max_write_len.
368          * Returns 0 or -ve error code.
369          */
370         int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
371                             const char *buffer);
372         /*
373          * trigger() callback can be used to get some kick from the
374          * userspace, when the actual string written is not important
375          * at all. The private field can be used to determine the
376          * kick type for multiplexing.
377          */
378         int (*trigger)(struct cgroup *cgrp, unsigned int event);
379
380         int (*release)(struct inode *inode, struct file *file);
381
382         /*
383          * register_event() callback will be used to add new userspace
384          * waiter for changes related to the cftype. Implement it if
385          * you want to provide this functionality. Use eventfd_signal()
386          * on eventfd to send notification to userspace.
387          */
388         int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
389                         struct eventfd_ctx *eventfd, const char *args);
390         /*
391          * unregister_event() callback will be called when userspace
392          * closes the eventfd or on cgroup removing.
393          * This callback must be implemented, if you want provide
394          * notification functionality.
395          */
396         void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
397                         struct eventfd_ctx *eventfd);
398 };
399
400 struct cgroup_scanner {
401         struct cgroup *cg;
402         int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
403         void (*process_task)(struct task_struct *p,
404                         struct cgroup_scanner *scan);
405         struct ptr_heap *heap;
406         void *data;
407 };
408
409 /*
410  * Add a new file to the given cgroup directory. Should only be
411  * called by subsystems from within a populate() method
412  */
413 int cgroup_add_file(struct cgroup *cgrp, struct cgroup_subsys *subsys,
414                        const struct cftype *cft);
415
416 /*
417  * Add a set of new files to the given cgroup directory. Should
418  * only be called by subsystems from within a populate() method
419  */
420 int cgroup_add_files(struct cgroup *cgrp,
421                         struct cgroup_subsys *subsys,
422                         const struct cftype cft[],
423                         int count);
424
425 int cgroup_is_removed(const struct cgroup *cgrp);
426
427 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
428
429 int cgroup_task_count(const struct cgroup *cgrp);
430
431 /* Return true if cgrp is a descendant of the task's cgroup */
432 int cgroup_is_descendant(const struct cgroup *cgrp, struct task_struct *task);
433
434 /*
435  * When the subsys has to access css and may add permanent refcnt to css,
436  * it should take care of racy conditions with rmdir(). Following set of
437  * functions, is for stop/restart rmdir if necessary.
438  * Because these will call css_get/put, "css" should be alive css.
439  *
440  *  cgroup_exclude_rmdir();
441  *  ...do some jobs which may access arbitrary empty cgroup
442  *  cgroup_release_and_wakeup_rmdir();
443  *
444  *  When someone removes a cgroup while cgroup_exclude_rmdir() holds it,
445  *  it sleeps and cgroup_release_and_wakeup_rmdir() will wake him up.
446  */
447
448 void cgroup_exclude_rmdir(struct cgroup_subsys_state *css);
449 void cgroup_release_and_wakeup_rmdir(struct cgroup_subsys_state *css);
450
451 /*
452  * Control Group subsystem type.
453  * See Documentation/cgroups/cgroups.txt for details
454  */
455
456 struct cgroup_subsys {
457         struct cgroup_subsys_state *(*create)(struct cgroup_subsys *ss,
458                                                   struct cgroup *cgrp);
459         int (*pre_destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
460         void (*destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
461         int (*can_attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
462                           struct task_struct *tsk);
463         int (*can_attach_task)(struct cgroup *cgrp, struct task_struct *tsk);
464         void (*cancel_attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
465                               struct task_struct *tsk);
466         void (*pre_attach)(struct cgroup *cgrp);
467         void (*attach_task)(struct cgroup *cgrp, struct task_struct *tsk);
468         void (*attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
469                        struct cgroup *old_cgrp, struct task_struct *tsk);
470         void (*fork)(struct cgroup_subsys *ss, struct task_struct *task);
471         void (*exit)(struct cgroup_subsys *ss, struct cgroup *cgrp,
472                         struct cgroup *old_cgrp, struct task_struct *task);
473         int (*populate)(struct cgroup_subsys *ss,
474                         struct cgroup *cgrp);
475         void (*post_clone)(struct cgroup_subsys *ss, struct cgroup *cgrp);
476         void (*bind)(struct cgroup_subsys *ss, struct cgroup *root);
477
478         int subsys_id;
479         int active;
480         int disabled;
481         int early_init;
482         /*
483          * True if this subsys uses ID. ID is not available before cgroup_init()
484          * (not available in early_init time.)
485          */
486         bool use_id;
487 #define MAX_CGROUP_TYPE_NAMELEN 32
488         const char *name;
489
490         /*
491          * Protects sibling/children links of cgroups in this
492          * hierarchy, plus protects which hierarchy (or none) the
493          * subsystem is a part of (i.e. root/sibling).  To avoid
494          * potential deadlocks, the following operations should not be
495          * undertaken while holding any hierarchy_mutex:
496          *
497          * - allocating memory
498          * - initiating hotplug events
499          */
500         struct mutex hierarchy_mutex;
501         struct lock_class_key subsys_key;
502
503         /*
504          * Link to parent, and list entry in parent's children.
505          * Protected by this->hierarchy_mutex and cgroup_lock()
506          */
507         struct cgroupfs_root *root;
508         struct list_head sibling;
509         /* used when use_id == true */
510         struct idr idr;
511         spinlock_t id_lock;
512
513         /* should be defined only by modular subsystems */
514         struct module *module;
515 };
516
517 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
518 #include <linux/cgroup_subsys.h>
519 #undef SUBSYS
520
521 static inline struct cgroup_subsys_state *cgroup_subsys_state(
522         struct cgroup *cgrp, int subsys_id)
523 {
524         return cgrp->subsys[subsys_id];
525 }
526
527 /*
528  * function to get the cgroup_subsys_state which allows for extra
529  * rcu_dereference_check() conditions, such as locks used during the
530  * cgroup_subsys::attach() methods.
531  */
532 #define task_subsys_state_check(task, subsys_id, __c)                   \
533         rcu_dereference_check(task->cgroups->subsys[subsys_id],         \
534                               lockdep_is_held(&task->alloc_lock) ||     \
535                               cgroup_lock_is_held() || (__c))
536
537 static inline struct cgroup_subsys_state *
538 task_subsys_state(struct task_struct *task, int subsys_id)
539 {
540         return task_subsys_state_check(task, subsys_id, false);
541 }
542
543 static inline struct cgroup* task_cgroup(struct task_struct *task,
544                                                int subsys_id)
545 {
546         return task_subsys_state(task, subsys_id)->cgroup;
547 }
548
549 /* A cgroup_iter should be treated as an opaque object */
550 struct cgroup_iter {
551         struct list_head *cg_link;
552         struct list_head *task;
553 };
554
555 /*
556  * To iterate across the tasks in a cgroup:
557  *
558  * 1) call cgroup_iter_start to initialize an iterator
559  *
560  * 2) call cgroup_iter_next() to retrieve member tasks until it
561  *    returns NULL or until you want to end the iteration
562  *
563  * 3) call cgroup_iter_end() to destroy the iterator.
564  *
565  * Or, call cgroup_scan_tasks() to iterate through every task in a
566  * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
567  * the test_task() callback, but not while calling the process_task()
568  * callback.
569  */
570 void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
571 struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
572                                         struct cgroup_iter *it);
573 void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
574 int cgroup_scan_tasks(struct cgroup_scanner *scan);
575 int cgroup_attach_task(struct cgroup *, struct task_struct *);
576 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
577
578 static inline int cgroup_attach_task_current_cg(struct task_struct *tsk)
579 {
580         return cgroup_attach_task_all(current, tsk);
581 }
582
583 /*
584  * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
585  * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
586  * CSS ID is assigned at cgroup allocation (create) automatically
587  * and removed when subsys calls free_css_id() function. This is because
588  * the lifetime of cgroup_subsys_state is subsys's matter.
589  *
590  * Looking up and scanning function should be called under rcu_read_lock().
591  * Taking cgroup_mutex()/hierarchy_mutex() is not necessary for following calls.
592  * But the css returned by this routine can be "not populated yet" or "being
593  * destroyed". The caller should check css and cgroup's status.
594  */
595
596 /*
597  * Typically Called at ->destroy(), or somewhere the subsys frees
598  * cgroup_subsys_state.
599  */
600 void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
601
602 /* Find a cgroup_subsys_state which has given ID */
603
604 struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
605
606 /*
607  * Get a cgroup whose id is greater than or equal to id under tree of root.
608  * Returning a cgroup_subsys_state or NULL.
609  */
610 struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
611                 struct cgroup_subsys_state *root, int *foundid);
612
613 /* Returns true if root is ancestor of cg */
614 bool css_is_ancestor(struct cgroup_subsys_state *cg,
615                      const struct cgroup_subsys_state *root);
616
617 /* Get id and depth of css */
618 unsigned short css_id(struct cgroup_subsys_state *css);
619 unsigned short css_depth(struct cgroup_subsys_state *css);
620 struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
621
622 #else /* !CONFIG_CGROUPS */
623
624 static inline int cgroup_init_early(void) { return 0; }
625 static inline int cgroup_init(void) { return 0; }
626 static inline void cgroup_fork(struct task_struct *p) {}
627 static inline void cgroup_fork_callbacks(struct task_struct *p) {}
628 static inline void cgroup_post_fork(struct task_struct *p) {}
629 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
630
631 static inline void cgroup_lock(void) {}
632 static inline void cgroup_unlock(void) {}
633 static inline int cgroupstats_build(struct cgroupstats *stats,
634                                         struct dentry *dentry)
635 {
636         return -EINVAL;
637 }
638
639 /* No cgroups - nothing to do */
640 static inline int cgroup_attach_task_all(struct task_struct *from,
641                                          struct task_struct *t)
642 {
643         return 0;
644 }
645 static inline int cgroup_attach_task_current_cg(struct task_struct *t)
646 {
647         return 0;
648 }
649
650 #endif /* !CONFIG_CGROUPS */
651
652 #endif /* _LINUX_CGROUP_H */