7166023e07d26036f3164eca0b2c52cae7fdc5b8
[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
18 #ifdef CONFIG_CGROUPS
19
20 struct cgroupfs_root;
21 struct cgroup_subsys;
22 struct inode;
23 struct cgroup;
24
25 extern int cgroup_init_early(void);
26 extern int cgroup_init(void);
27 extern void cgroup_init_smp(void);
28 extern void cgroup_lock(void);
29 extern bool cgroup_lock_live_group(struct cgroup *cgrp);
30 extern void cgroup_unlock(void);
31 extern void cgroup_fork(struct task_struct *p);
32 extern void cgroup_fork_callbacks(struct task_struct *p);
33 extern void cgroup_post_fork(struct task_struct *p);
34 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
35 extern int cgroupstats_build(struct cgroupstats *stats,
36                                 struct dentry *dentry);
37
38 extern struct file_operations proc_cgroup_operations;
39
40 /* Define the enumeration of all cgroup subsystems */
41 #define SUBSYS(_x) _x ## _subsys_id,
42 enum cgroup_subsys_id {
43 #include <linux/cgroup_subsys.h>
44         CGROUP_SUBSYS_COUNT
45 };
46 #undef SUBSYS
47
48 /* Per-subsystem/per-cgroup state maintained by the system. */
49 struct cgroup_subsys_state {
50         /* The cgroup that this subsystem is attached to. Useful
51          * for subsystems that want to know about the cgroup
52          * hierarchy structure */
53         struct cgroup *cgroup;
54
55         /* State maintained by the cgroup system to allow
56          * subsystems to be "busy". Should be accessed via css_get()
57          * and css_put() */
58
59         atomic_t refcnt;
60
61         unsigned long flags;
62 };
63
64 /* bits in struct cgroup_subsys_state flags field */
65 enum {
66         CSS_ROOT, /* This CSS is the root of the subsystem */
67 };
68
69 /*
70  * Call css_get() to hold a reference on the cgroup;
71  *
72  */
73
74 static inline void css_get(struct cgroup_subsys_state *css)
75 {
76         /* We don't need to reference count the root state */
77         if (!test_bit(CSS_ROOT, &css->flags))
78                 atomic_inc(&css->refcnt);
79 }
80 /*
81  * css_put() should be called to release a reference taken by
82  * css_get()
83  */
84
85 extern void __css_put(struct cgroup_subsys_state *css);
86 static inline void css_put(struct cgroup_subsys_state *css)
87 {
88         if (!test_bit(CSS_ROOT, &css->flags))
89                 __css_put(css);
90 }
91
92 /* bits in struct cgroup flags field */
93 enum {
94         /* Control Group is dead */
95         CGRP_REMOVED,
96         /* Control Group has previously had a child cgroup or a task,
97          * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set) */
98         CGRP_RELEASABLE,
99         /* Control Group requires release notifications to userspace */
100         CGRP_NOTIFY_ON_RELEASE,
101 };
102
103 struct cgroup {
104         unsigned long flags;            /* "unsigned long" so bitops work */
105
106         /* count users of this cgroup. >0 means busy, but doesn't
107          * necessarily indicate the number of tasks in the
108          * cgroup */
109         atomic_t count;
110
111         /*
112          * We link our 'sibling' struct into our parent's 'children'.
113          * Our children link their 'sibling' into our 'children'.
114          */
115         struct list_head sibling;       /* my parent's children */
116         struct list_head children;      /* my children */
117
118         struct cgroup *parent;  /* my parent */
119         struct dentry *dentry;          /* cgroup fs entry */
120
121         /* Private pointers for each registered subsystem */
122         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
123
124         struct cgroupfs_root *root;
125         struct cgroup *top_cgroup;
126
127         /*
128          * List of cg_cgroup_links pointing at css_sets with
129          * tasks in this cgroup. Protected by css_set_lock
130          */
131         struct list_head css_sets;
132
133         /*
134          * Linked list running through all cgroups that can
135          * potentially be reaped by the release agent. Protected by
136          * release_list_lock
137          */
138         struct list_head release_list;
139 };
140
141 /* A css_set is a structure holding pointers to a set of
142  * cgroup_subsys_state objects. This saves space in the task struct
143  * object and speeds up fork()/exit(), since a single inc/dec and a
144  * list_add()/del() can bump the reference count on the entire
145  * cgroup set for a task.
146  */
147
148 struct css_set {
149
150         /* Reference count */
151         atomic_t refcount;
152
153         /*
154          * List running through all cgroup groups in the same hash
155          * slot. Protected by css_set_lock
156          */
157         struct hlist_node hlist;
158
159         /*
160          * List running through all tasks using this cgroup
161          * group. Protected by css_set_lock
162          */
163         struct list_head tasks;
164
165         /*
166          * List of cg_cgroup_link objects on link chains from
167          * cgroups referenced from this css_set. Protected by
168          * css_set_lock
169          */
170         struct list_head cg_links;
171
172         /*
173          * Set of subsystem states, one for each subsystem. This array
174          * is immutable after creation apart from the init_css_set
175          * during subsystem registration (at boot time).
176          */
177         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
178 };
179
180 /*
181  * cgroup_map_cb is an abstract callback API for reporting map-valued
182  * control files
183  */
184
185 struct cgroup_map_cb {
186         int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
187         void *state;
188 };
189
190 /* struct cftype:
191  *
192  * The files in the cgroup filesystem mostly have a very simple read/write
193  * handling, some common function will take care of it. Nevertheless some cases
194  * (read tasks) are special and therefore I define this structure for every
195  * kind of file.
196  *
197  *
198  * When reading/writing to a file:
199  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
200  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
201  */
202
203 #define MAX_CFTYPE_NAME 64
204 struct cftype {
205         /* By convention, the name should begin with the name of the
206          * subsystem, followed by a period */
207         char name[MAX_CFTYPE_NAME];
208         int private;
209
210         /*
211          * If non-zero, defines the maximum length of string that can
212          * be passed to write_string; defaults to 64
213          */
214         size_t max_write_len;
215
216         int (*open)(struct inode *inode, struct file *file);
217         ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
218                         struct file *file,
219                         char __user *buf, size_t nbytes, loff_t *ppos);
220         /*
221          * read_u64() is a shortcut for the common case of returning a
222          * single integer. Use it in place of read()
223          */
224         u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
225         /*
226          * read_s64() is a signed version of read_u64()
227          */
228         s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
229         /*
230          * read_map() is used for defining a map of key/value
231          * pairs. It should call cb->fill(cb, key, value) for each
232          * entry. The key/value pairs (and their ordering) should not
233          * change between reboots.
234          */
235         int (*read_map)(struct cgroup *cont, struct cftype *cft,
236                         struct cgroup_map_cb *cb);
237         /*
238          * read_seq_string() is used for outputting a simple sequence
239          * using seqfile.
240          */
241         int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
242                                struct seq_file *m);
243
244         ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
245                          struct file *file,
246                          const char __user *buf, size_t nbytes, loff_t *ppos);
247
248         /*
249          * write_u64() is a shortcut for the common case of accepting
250          * a single integer (as parsed by simple_strtoull) from
251          * userspace. Use in place of write(); return 0 or error.
252          */
253         int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
254         /*
255          * write_s64() is a signed version of write_u64()
256          */
257         int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
258
259         /*
260          * write_string() is passed a nul-terminated kernelspace
261          * buffer of maximum length determined by max_write_len.
262          * Returns 0 or -ve error code.
263          */
264         int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
265                             const char *buffer);
266         /*
267          * trigger() callback can be used to get some kick from the
268          * userspace, when the actual string written is not important
269          * at all. The private field can be used to determine the
270          * kick type for multiplexing.
271          */
272         int (*trigger)(struct cgroup *cgrp, unsigned int event);
273
274         int (*release)(struct inode *inode, struct file *file);
275 };
276
277 struct cgroup_scanner {
278         struct cgroup *cg;
279         int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
280         void (*process_task)(struct task_struct *p,
281                         struct cgroup_scanner *scan);
282         struct ptr_heap *heap;
283 };
284
285 /* Add a new file to the given cgroup directory. Should only be
286  * called by subsystems from within a populate() method */
287 int cgroup_add_file(struct cgroup *cgrp, struct cgroup_subsys *subsys,
288                        const struct cftype *cft);
289
290 /* Add a set of new files to the given cgroup directory. Should
291  * only be called by subsystems from within a populate() method */
292 int cgroup_add_files(struct cgroup *cgrp,
293                         struct cgroup_subsys *subsys,
294                         const struct cftype cft[],
295                         int count);
296
297 int cgroup_is_removed(const struct cgroup *cgrp);
298
299 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
300
301 int cgroup_task_count(const struct cgroup *cgrp);
302
303 /* Return true if the cgroup is a descendant of the current cgroup */
304 int cgroup_is_descendant(const struct cgroup *cgrp);
305
306 /* Control Group subsystem type. See Documentation/cgroups.txt for details */
307
308 struct cgroup_subsys {
309         struct cgroup_subsys_state *(*create)(struct cgroup_subsys *ss,
310                                                   struct cgroup *cgrp);
311         void (*pre_destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
312         void (*destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
313         int (*can_attach)(struct cgroup_subsys *ss,
314                           struct cgroup *cgrp, struct task_struct *tsk);
315         void (*attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
316                         struct cgroup *old_cgrp, struct task_struct *tsk);
317         void (*fork)(struct cgroup_subsys *ss, struct task_struct *task);
318         void (*exit)(struct cgroup_subsys *ss, struct task_struct *task);
319         int (*populate)(struct cgroup_subsys *ss,
320                         struct cgroup *cgrp);
321         void (*post_clone)(struct cgroup_subsys *ss, struct cgroup *cgrp);
322         void (*bind)(struct cgroup_subsys *ss, struct cgroup *root);
323         /*
324          * This routine is called with the task_lock of mm->owner held
325          */
326         void (*mm_owner_changed)(struct cgroup_subsys *ss,
327                                         struct cgroup *old,
328                                         struct cgroup *new,
329                                         struct task_struct *p);
330         int subsys_id;
331         int active;
332         int disabled;
333         int early_init;
334 #define MAX_CGROUP_TYPE_NAMELEN 32
335         const char *name;
336
337         /* Protected by RCU */
338         struct cgroupfs_root *root;
339
340         struct list_head sibling;
341
342         void *private;
343 };
344
345 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
346 #include <linux/cgroup_subsys.h>
347 #undef SUBSYS
348
349 static inline struct cgroup_subsys_state *cgroup_subsys_state(
350         struct cgroup *cgrp, int subsys_id)
351 {
352         return cgrp->subsys[subsys_id];
353 }
354
355 static inline struct cgroup_subsys_state *task_subsys_state(
356         struct task_struct *task, int subsys_id)
357 {
358         return rcu_dereference(task->cgroups->subsys[subsys_id]);
359 }
360
361 static inline struct cgroup* task_cgroup(struct task_struct *task,
362                                                int subsys_id)
363 {
364         return task_subsys_state(task, subsys_id)->cgroup;
365 }
366
367 int cgroup_clone(struct task_struct *tsk, struct cgroup_subsys *ss,
368                                                         char *nodename);
369
370 /* A cgroup_iter should be treated as an opaque object */
371 struct cgroup_iter {
372         struct list_head *cg_link;
373         struct list_head *task;
374 };
375
376 /* To iterate across the tasks in a cgroup:
377  *
378  * 1) call cgroup_iter_start to intialize an iterator
379  *
380  * 2) call cgroup_iter_next() to retrieve member tasks until it
381  *    returns NULL or until you want to end the iteration
382  *
383  * 3) call cgroup_iter_end() to destroy the iterator.
384  *
385  * Or, call cgroup_scan_tasks() to iterate through every task in a cpuset.
386  *    - cgroup_scan_tasks() holds the css_set_lock when calling the test_task()
387  *      callback, but not while calling the process_task() callback.
388  */
389 void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
390 struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
391                                         struct cgroup_iter *it);
392 void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
393 int cgroup_scan_tasks(struct cgroup_scanner *scan);
394 int cgroup_attach_task(struct cgroup *, struct task_struct *);
395
396 #else /* !CONFIG_CGROUPS */
397
398 static inline int cgroup_init_early(void) { return 0; }
399 static inline int cgroup_init(void) { return 0; }
400 static inline void cgroup_init_smp(void) {}
401 static inline void cgroup_fork(struct task_struct *p) {}
402 static inline void cgroup_fork_callbacks(struct task_struct *p) {}
403 static inline void cgroup_post_fork(struct task_struct *p) {}
404 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
405
406 static inline void cgroup_lock(void) {}
407 static inline void cgroup_unlock(void) {}
408 static inline int cgroupstats_build(struct cgroupstats *stats,
409                                         struct dentry *dentry)
410 {
411         return -EINVAL;
412 }
413
414 #endif /* !CONFIG_CGROUPS */
415
416 #ifdef CONFIG_MM_OWNER
417 extern void
418 cgroup_mm_owner_callbacks(struct task_struct *old, struct task_struct *new);
419 #else /* !CONFIG_MM_OWNER */
420 static inline void
421 cgroup_mm_owner_callbacks(struct task_struct *old, struct task_struct *new)
422 {
423 }
424 #endif /* CONFIG_MM_OWNER */
425 #endif /* _LINUX_CGROUP_H */