cgroup: CSS ID support
[linux-2.6] / 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 bool cgroup_lock_live_group(struct cgroup *cgrp);
32 extern void cgroup_unlock(void);
33 extern void cgroup_fork(struct task_struct *p);
34 extern void cgroup_fork_callbacks(struct task_struct *p);
35 extern void cgroup_post_fork(struct task_struct *p);
36 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
37 extern int cgroupstats_build(struct cgroupstats *stats,
38                                 struct dentry *dentry);
39
40 extern struct file_operations proc_cgroup_operations;
41
42 /* Define the enumeration of all cgroup subsystems */
43 #define SUBSYS(_x) _x ## _subsys_id,
44 enum cgroup_subsys_id {
45 #include <linux/cgroup_subsys.h>
46         CGROUP_SUBSYS_COUNT
47 };
48 #undef SUBSYS
49
50 /* Per-subsystem/per-cgroup state maintained by the system. */
51 struct cgroup_subsys_state {
52         /*
53          * The cgroup that this subsystem is attached to. Useful
54          * for subsystems that want to know about the cgroup
55          * hierarchy structure
56          */
57         struct cgroup *cgroup;
58
59         /*
60          * State maintained by the cgroup system to allow subsystems
61          * to be "busy". Should be accessed via css_get(),
62          * css_tryget() and and css_put().
63          */
64
65         atomic_t refcnt;
66
67         unsigned long flags;
68         /* ID for this css, if possible */
69         struct css_id *id;
70 };
71
72 /* bits in struct cgroup_subsys_state flags field */
73 enum {
74         CSS_ROOT, /* This CSS is the root of the subsystem */
75         CSS_REMOVED, /* This CSS is dead */
76 };
77
78 /*
79  * Call css_get() to hold a reference on the css; it can be used
80  * for a reference obtained via:
81  * - an existing ref-counted reference to the css
82  * - task->cgroups for a locked task
83  */
84
85 static inline void css_get(struct cgroup_subsys_state *css)
86 {
87         /* We don't need to reference count the root state */
88         if (!test_bit(CSS_ROOT, &css->flags))
89                 atomic_inc(&css->refcnt);
90 }
91
92 static inline bool css_is_removed(struct cgroup_subsys_state *css)
93 {
94         return test_bit(CSS_REMOVED, &css->flags);
95 }
96
97 /*
98  * Call css_tryget() to take a reference on a css if your existing
99  * (known-valid) reference isn't already ref-counted. Returns false if
100  * the css has been destroyed.
101  */
102
103 static inline bool css_tryget(struct cgroup_subsys_state *css)
104 {
105         if (test_bit(CSS_ROOT, &css->flags))
106                 return true;
107         while (!atomic_inc_not_zero(&css->refcnt)) {
108                 if (test_bit(CSS_REMOVED, &css->flags))
109                         return false;
110                 cpu_relax();
111         }
112         return true;
113 }
114
115 /*
116  * css_put() should be called to release a reference taken by
117  * css_get() or css_tryget()
118  */
119
120 extern void __css_put(struct cgroup_subsys_state *css);
121 static inline void css_put(struct cgroup_subsys_state *css)
122 {
123         if (!test_bit(CSS_ROOT, &css->flags))
124                 __css_put(css);
125 }
126
127 /* bits in struct cgroup flags field */
128 enum {
129         /* Control Group is dead */
130         CGRP_REMOVED,
131         /*
132          * Control Group has previously had a child cgroup or a task,
133          * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
134          */
135         CGRP_RELEASABLE,
136         /* Control Group requires release notifications to userspace */
137         CGRP_NOTIFY_ON_RELEASE,
138 };
139
140 struct cgroup {
141         unsigned long flags;            /* "unsigned long" so bitops work */
142
143         /*
144          * count users of this cgroup. >0 means busy, but doesn't
145          * necessarily indicate the number of tasks in the cgroup
146          */
147         atomic_t count;
148
149         /*
150          * We link our 'sibling' struct into our parent's 'children'.
151          * Our children link their 'sibling' into our 'children'.
152          */
153         struct list_head sibling;       /* my parent's children */
154         struct list_head children;      /* my children */
155
156         struct cgroup *parent;          /* my parent */
157         struct dentry *dentry;          /* cgroup fs entry, RCU protected */
158
159         /* Private pointers for each registered subsystem */
160         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
161
162         struct cgroupfs_root *root;
163         struct cgroup *top_cgroup;
164
165         /*
166          * List of cg_cgroup_links pointing at css_sets with
167          * tasks in this cgroup. Protected by css_set_lock
168          */
169         struct list_head css_sets;
170
171         /*
172          * Linked list running through all cgroups that can
173          * potentially be reaped by the release agent. Protected by
174          * release_list_lock
175          */
176         struct list_head release_list;
177
178         /* pids_mutex protects the fields below */
179         struct rw_semaphore pids_mutex;
180         /* Array of process ids in the cgroup */
181         pid_t *tasks_pids;
182         /* How many files are using the current tasks_pids array */
183         int pids_use_count;
184         /* Length of the current tasks_pids array */
185         int pids_length;
186
187         /* For RCU-protected deletion */
188         struct rcu_head rcu_head;
189 };
190
191 /*
192  * A css_set is a structure holding pointers to a set of
193  * cgroup_subsys_state objects. This saves space in the task struct
194  * object and speeds up fork()/exit(), since a single inc/dec and a
195  * list_add()/del() can bump the reference count on the entire cgroup
196  * set for a task.
197  */
198
199 struct css_set {
200
201         /* Reference count */
202         atomic_t refcount;
203
204         /*
205          * List running through all cgroup groups in the same hash
206          * slot. Protected by css_set_lock
207          */
208         struct hlist_node hlist;
209
210         /*
211          * List running through all tasks using this cgroup
212          * group. Protected by css_set_lock
213          */
214         struct list_head tasks;
215
216         /*
217          * List of cg_cgroup_link objects on link chains from
218          * cgroups referenced from this css_set. Protected by
219          * css_set_lock
220          */
221         struct list_head cg_links;
222
223         /*
224          * Set of subsystem states, one for each subsystem. This array
225          * is immutable after creation apart from the init_css_set
226          * during subsystem registration (at boot time).
227          */
228         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
229 };
230
231 /*
232  * cgroup_map_cb is an abstract callback API for reporting map-valued
233  * control files
234  */
235
236 struct cgroup_map_cb {
237         int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
238         void *state;
239 };
240
241 /*
242  * struct cftype: handler definitions for cgroup control files
243  *
244  * When reading/writing to a file:
245  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
246  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
247  */
248
249 #define MAX_CFTYPE_NAME 64
250 struct cftype {
251         /*
252          * By convention, the name should begin with the name of the
253          * subsystem, followed by a period
254          */
255         char name[MAX_CFTYPE_NAME];
256         int private;
257
258         /*
259          * If non-zero, defines the maximum length of string that can
260          * be passed to write_string; defaults to 64
261          */
262         size_t max_write_len;
263
264         int (*open)(struct inode *inode, struct file *file);
265         ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
266                         struct file *file,
267                         char __user *buf, size_t nbytes, loff_t *ppos);
268         /*
269          * read_u64() is a shortcut for the common case of returning a
270          * single integer. Use it in place of read()
271          */
272         u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
273         /*
274          * read_s64() is a signed version of read_u64()
275          */
276         s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
277         /*
278          * read_map() is used for defining a map of key/value
279          * pairs. It should call cb->fill(cb, key, value) for each
280          * entry. The key/value pairs (and their ordering) should not
281          * change between reboots.
282          */
283         int (*read_map)(struct cgroup *cont, struct cftype *cft,
284                         struct cgroup_map_cb *cb);
285         /*
286          * read_seq_string() is used for outputting a simple sequence
287          * using seqfile.
288          */
289         int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
290                                struct seq_file *m);
291
292         ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
293                          struct file *file,
294                          const char __user *buf, size_t nbytes, loff_t *ppos);
295
296         /*
297          * write_u64() is a shortcut for the common case of accepting
298          * a single integer (as parsed by simple_strtoull) from
299          * userspace. Use in place of write(); return 0 or error.
300          */
301         int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
302         /*
303          * write_s64() is a signed version of write_u64()
304          */
305         int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
306
307         /*
308          * write_string() is passed a nul-terminated kernelspace
309          * buffer of maximum length determined by max_write_len.
310          * Returns 0 or -ve error code.
311          */
312         int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
313                             const char *buffer);
314         /*
315          * trigger() callback can be used to get some kick from the
316          * userspace, when the actual string written is not important
317          * at all. The private field can be used to determine the
318          * kick type for multiplexing.
319          */
320         int (*trigger)(struct cgroup *cgrp, unsigned int event);
321
322         int (*release)(struct inode *inode, struct file *file);
323 };
324
325 struct cgroup_scanner {
326         struct cgroup *cg;
327         int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
328         void (*process_task)(struct task_struct *p,
329                         struct cgroup_scanner *scan);
330         struct ptr_heap *heap;
331 };
332
333 /*
334  * Add a new file to the given cgroup directory. Should only be
335  * called by subsystems from within a populate() method
336  */
337 int cgroup_add_file(struct cgroup *cgrp, struct cgroup_subsys *subsys,
338                        const struct cftype *cft);
339
340 /*
341  * Add a set of new files to the given cgroup directory. Should
342  * only be called by subsystems from within a populate() method
343  */
344 int cgroup_add_files(struct cgroup *cgrp,
345                         struct cgroup_subsys *subsys,
346                         const struct cftype cft[],
347                         int count);
348
349 int cgroup_is_removed(const struct cgroup *cgrp);
350
351 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
352
353 int cgroup_task_count(const struct cgroup *cgrp);
354
355 /* Return true if cgrp is a descendant of the task's cgroup */
356 int cgroup_is_descendant(const struct cgroup *cgrp, struct task_struct *task);
357
358 /* Control Group subsystem type. See Documentation/cgroups.txt for details */
359
360 struct cgroup_subsys {
361         struct cgroup_subsys_state *(*create)(struct cgroup_subsys *ss,
362                                                   struct cgroup *cgrp);
363         void (*pre_destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
364         void (*destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
365         int (*can_attach)(struct cgroup_subsys *ss,
366                           struct cgroup *cgrp, struct task_struct *tsk);
367         void (*attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
368                         struct cgroup *old_cgrp, struct task_struct *tsk);
369         void (*fork)(struct cgroup_subsys *ss, struct task_struct *task);
370         void (*exit)(struct cgroup_subsys *ss, struct task_struct *task);
371         int (*populate)(struct cgroup_subsys *ss,
372                         struct cgroup *cgrp);
373         void (*post_clone)(struct cgroup_subsys *ss, struct cgroup *cgrp);
374         void (*bind)(struct cgroup_subsys *ss, struct cgroup *root);
375
376         int subsys_id;
377         int active;
378         int disabled;
379         int early_init;
380         /*
381          * True if this subsys uses ID. ID is not available before cgroup_init()
382          * (not available in early_init time.)
383          */
384         bool use_id;
385 #define MAX_CGROUP_TYPE_NAMELEN 32
386         const char *name;
387
388         /*
389          * Protects sibling/children links of cgroups in this
390          * hierarchy, plus protects which hierarchy (or none) the
391          * subsystem is a part of (i.e. root/sibling).  To avoid
392          * potential deadlocks, the following operations should not be
393          * undertaken while holding any hierarchy_mutex:
394          *
395          * - allocating memory
396          * - initiating hotplug events
397          */
398         struct mutex hierarchy_mutex;
399         struct lock_class_key subsys_key;
400
401         /*
402          * Link to parent, and list entry in parent's children.
403          * Protected by this->hierarchy_mutex and cgroup_lock()
404          */
405         struct cgroupfs_root *root;
406         struct list_head sibling;
407         /* used when use_id == true */
408         struct idr idr;
409         spinlock_t id_lock;
410 };
411
412 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
413 #include <linux/cgroup_subsys.h>
414 #undef SUBSYS
415
416 static inline struct cgroup_subsys_state *cgroup_subsys_state(
417         struct cgroup *cgrp, int subsys_id)
418 {
419         return cgrp->subsys[subsys_id];
420 }
421
422 static inline struct cgroup_subsys_state *task_subsys_state(
423         struct task_struct *task, int subsys_id)
424 {
425         return rcu_dereference(task->cgroups->subsys[subsys_id]);
426 }
427
428 static inline struct cgroup* task_cgroup(struct task_struct *task,
429                                                int subsys_id)
430 {
431         return task_subsys_state(task, subsys_id)->cgroup;
432 }
433
434 int cgroup_clone(struct task_struct *tsk, struct cgroup_subsys *ss,
435                                                         char *nodename);
436
437 /* A cgroup_iter should be treated as an opaque object */
438 struct cgroup_iter {
439         struct list_head *cg_link;
440         struct list_head *task;
441 };
442
443 /*
444  * To iterate across the tasks in a cgroup:
445  *
446  * 1) call cgroup_iter_start to intialize an iterator
447  *
448  * 2) call cgroup_iter_next() to retrieve member tasks until it
449  *    returns NULL or until you want to end the iteration
450  *
451  * 3) call cgroup_iter_end() to destroy the iterator.
452  *
453  * Or, call cgroup_scan_tasks() to iterate through every task in a
454  * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
455  * the test_task() callback, but not while calling the process_task()
456  * callback.
457  */
458 void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
459 struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
460                                         struct cgroup_iter *it);
461 void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
462 int cgroup_scan_tasks(struct cgroup_scanner *scan);
463 int cgroup_attach_task(struct cgroup *, struct task_struct *);
464
465 /*
466  * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
467  * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
468  * CSS ID is assigned at cgroup allocation (create) automatically
469  * and removed when subsys calls free_css_id() function. This is because
470  * the lifetime of cgroup_subsys_state is subsys's matter.
471  *
472  * Looking up and scanning function should be called under rcu_read_lock().
473  * Taking cgroup_mutex()/hierarchy_mutex() is not necessary for following calls.
474  * But the css returned by this routine can be "not populated yet" or "being
475  * destroyed". The caller should check css and cgroup's status.
476  */
477
478 /*
479  * Typically Called at ->destroy(), or somewhere the subsys frees
480  * cgroup_subsys_state.
481  */
482 void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
483
484 /* Find a cgroup_subsys_state which has given ID */
485
486 struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
487
488 /*
489  * Get a cgroup whose id is greater than or equal to id under tree of root.
490  * Returning a cgroup_subsys_state or NULL.
491  */
492 struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
493                 struct cgroup_subsys_state *root, int *foundid);
494
495 /* Returns true if root is ancestor of cg */
496 bool css_is_ancestor(struct cgroup_subsys_state *cg,
497                      struct cgroup_subsys_state *root);
498
499 /* Get id and depth of css */
500 unsigned short css_id(struct cgroup_subsys_state *css);
501 unsigned short css_depth(struct cgroup_subsys_state *css);
502
503 #else /* !CONFIG_CGROUPS */
504
505 static inline int cgroup_init_early(void) { return 0; }
506 static inline int cgroup_init(void) { return 0; }
507 static inline void cgroup_fork(struct task_struct *p) {}
508 static inline void cgroup_fork_callbacks(struct task_struct *p) {}
509 static inline void cgroup_post_fork(struct task_struct *p) {}
510 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
511
512 static inline void cgroup_lock(void) {}
513 static inline void cgroup_unlock(void) {}
514 static inline int cgroupstats_build(struct cgroupstats *stats,
515                                         struct dentry *dentry)
516 {
517         return -EINVAL;
518 }
519
520 #endif /* !CONFIG_CGROUPS */
521
522 #endif /* _LINUX_CGROUP_H */