CGroup API files: make CGROUP_DEBUG default to off
[deliverable/linux.git] / include / linux / cgroup.h
CommitLineData
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>
12#include <linux/kref.h>
13#include <linux/cpumask.h>
14#include <linux/nodemask.h>
15#include <linux/rcupdate.h>
846c7bb0 16#include <linux/cgroupstats.h>
31a7df01 17#include <linux/prio_heap.h>
ddbcc7e8
PM
18
19#ifdef CONFIG_CGROUPS
20
21struct cgroupfs_root;
22struct cgroup_subsys;
23struct inode;
24
25extern int cgroup_init_early(void);
26extern int cgroup_init(void);
27extern void cgroup_init_smp(void);
28extern void cgroup_lock(void);
29extern void cgroup_unlock(void);
b4f48b63
PM
30extern void cgroup_fork(struct task_struct *p);
31extern void cgroup_fork_callbacks(struct task_struct *p);
817929ec 32extern void cgroup_post_fork(struct task_struct *p);
b4f48b63 33extern void cgroup_exit(struct task_struct *p, int run_callbacks);
846c7bb0
BS
34extern int cgroupstats_build(struct cgroupstats *stats,
35 struct dentry *dentry);
ddbcc7e8 36
a424316c
PM
37extern struct file_operations proc_cgroup_operations;
38
817929ec
PM
39/* Define the enumeration of all cgroup subsystems */
40#define SUBSYS(_x) _x ## _subsys_id,
41enum cgroup_subsys_id {
42#include <linux/cgroup_subsys.h>
43 CGROUP_SUBSYS_COUNT
44};
45#undef SUBSYS
46
ddbcc7e8
PM
47/* Per-subsystem/per-cgroup state maintained by the system. */
48struct cgroup_subsys_state {
49 /* The cgroup that this subsystem is attached to. Useful
50 * for subsystems that want to know about the cgroup
51 * hierarchy structure */
52 struct cgroup *cgroup;
53
54 /* State maintained by the cgroup system to allow
55 * subsystems to be "busy". Should be accessed via css_get()
56 * and css_put() */
57
58 atomic_t refcnt;
59
60 unsigned long flags;
61};
62
63/* bits in struct cgroup_subsys_state flags field */
64enum {
65 CSS_ROOT, /* This CSS is the root of the subsystem */
66};
67
68/*
69 * Call css_get() to hold a reference on the cgroup;
70 *
71 */
72
73static inline void css_get(struct cgroup_subsys_state *css)
74{
75 /* We don't need to reference count the root state */
76 if (!test_bit(CSS_ROOT, &css->flags))
77 atomic_inc(&css->refcnt);
78}
79/*
80 * css_put() should be called to release a reference taken by
81 * css_get()
82 */
83
81a6a5cd 84extern void __css_put(struct cgroup_subsys_state *css);
ddbcc7e8
PM
85static inline void css_put(struct cgroup_subsys_state *css)
86{
87 if (!test_bit(CSS_ROOT, &css->flags))
81a6a5cd 88 __css_put(css);
ddbcc7e8
PM
89}
90
3116f0e3
PM
91/* bits in struct cgroup flags field */
92enum {
93 /* Control Group is dead */
94 CGRP_REMOVED,
95 /* Control Group has previously had a child cgroup or a task,
96 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set) */
97 CGRP_RELEASABLE,
98 /* Control Group requires release notifications to userspace */
99 CGRP_NOTIFY_ON_RELEASE,
100};
101
ddbcc7e8
PM
102struct cgroup {
103 unsigned long flags; /* "unsigned long" so bitops work */
104
105 /* count users of this cgroup. >0 means busy, but doesn't
106 * necessarily indicate the number of tasks in the
107 * cgroup */
108 atomic_t count;
109
110 /*
111 * We link our 'sibling' struct into our parent's 'children'.
112 * Our children link their 'sibling' into our 'children'.
113 */
114 struct list_head sibling; /* my parent's children */
115 struct list_head children; /* my children */
116
117 struct cgroup *parent; /* my parent */
118 struct dentry *dentry; /* cgroup fs entry */
119
120 /* Private pointers for each registered subsystem */
121 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
122
123 struct cgroupfs_root *root;
124 struct cgroup *top_cgroup;
817929ec
PM
125
126 /*
127 * List of cg_cgroup_links pointing at css_sets with
128 * tasks in this cgroup. Protected by css_set_lock
129 */
130 struct list_head css_sets;
81a6a5cd
PM
131
132 /*
133 * Linked list running through all cgroups that can
134 * potentially be reaped by the release agent. Protected by
135 * release_list_lock
136 */
137 struct list_head release_list;
817929ec
PM
138};
139
140/* A css_set is a structure holding pointers to a set of
141 * cgroup_subsys_state objects. This saves space in the task struct
142 * object and speeds up fork()/exit(), since a single inc/dec and a
143 * list_add()/del() can bump the reference count on the entire
144 * cgroup set for a task.
145 */
146
147struct css_set {
148
149 /* Reference count */
150 struct kref ref;
151
152 /*
153 * List running through all cgroup groups. Protected by
154 * css_set_lock
155 */
156 struct list_head list;
157
158 /*
159 * List running through all tasks using this cgroup
160 * group. Protected by css_set_lock
161 */
162 struct list_head tasks;
163
164 /*
165 * List of cg_cgroup_link objects on link chains from
166 * cgroups referenced from this css_set. Protected by
167 * css_set_lock
168 */
169 struct list_head cg_links;
170
171 /*
172 * Set of subsystem states, one for each subsystem. This array
173 * is immutable after creation apart from the init_css_set
174 * during subsystem registration (at boot time).
175 */
176 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
177
ddbcc7e8
PM
178};
179
91796569
PM
180/*
181 * cgroup_map_cb is an abstract callback API for reporting map-valued
182 * control files
183 */
184
185struct cgroup_map_cb {
186 int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
187 void *state;
188};
189
ddbcc7e8
PM
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:
a043e3b2 199 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
ddbcc7e8
PM
200 * - the 'cftype' of the file is file->f_dentry->d_fsdata
201 */
202
203#define MAX_CFTYPE_NAME 64
204struct 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 int (*open) (struct inode *inode, struct file *file);
ffd2d883 210 ssize_t (*read) (struct cgroup *cgrp, struct cftype *cft,
ddbcc7e8
PM
211 struct file *file,
212 char __user *buf, size_t nbytes, loff_t *ppos);
213 /*
f4c753b7 214 * read_u64() is a shortcut for the common case of returning a
ddbcc7e8
PM
215 * single integer. Use it in place of read()
216 */
f4c753b7 217 u64 (*read_u64) (struct cgroup *cgrp, struct cftype *cft);
91796569
PM
218 /*
219 * read_map() is used for defining a map of key/value
220 * pairs. It should call cb->fill(cb, key, value) for each
221 * entry. The key/value pairs (and their ordering) should not
222 * change between reboots.
223 */
224 int (*read_map) (struct cgroup *cont, struct cftype *cft,
225 struct cgroup_map_cb *cb);
226
ffd2d883 227 ssize_t (*write) (struct cgroup *cgrp, struct cftype *cft,
ddbcc7e8
PM
228 struct file *file,
229 const char __user *buf, size_t nbytes, loff_t *ppos);
355e0c48
PM
230
231 /*
f4c753b7 232 * write_u64() is a shortcut for the common case of accepting
355e0c48
PM
233 * a single integer (as parsed by simple_strtoull) from
234 * userspace. Use in place of write(); return 0 or error.
235 */
f4c753b7 236 int (*write_u64) (struct cgroup *cgrp, struct cftype *cft, u64 val);
355e0c48 237
ddbcc7e8
PM
238 int (*release) (struct inode *inode, struct file *file);
239};
240
31a7df01
CW
241struct cgroup_scanner {
242 struct cgroup *cg;
243 int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
244 void (*process_task)(struct task_struct *p,
245 struct cgroup_scanner *scan);
246 struct ptr_heap *heap;
247};
248
ddbcc7e8
PM
249/* Add a new file to the given cgroup directory. Should only be
250 * called by subsystems from within a populate() method */
ffd2d883 251int cgroup_add_file(struct cgroup *cgrp, struct cgroup_subsys *subsys,
ddbcc7e8
PM
252 const struct cftype *cft);
253
254/* Add a set of new files to the given cgroup directory. Should
255 * only be called by subsystems from within a populate() method */
ffd2d883 256int cgroup_add_files(struct cgroup *cgrp,
ddbcc7e8
PM
257 struct cgroup_subsys *subsys,
258 const struct cftype cft[],
259 int count);
260
ffd2d883 261int cgroup_is_removed(const struct cgroup *cgrp);
ddbcc7e8 262
ffd2d883 263int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
ddbcc7e8 264
ffd2d883 265int cgroup_task_count(const struct cgroup *cgrp);
bbcb81d0 266
ddbcc7e8 267/* Return true if the cgroup is a descendant of the current cgroup */
ffd2d883 268int cgroup_is_descendant(const struct cgroup *cgrp);
ddbcc7e8
PM
269
270/* Control Group subsystem type. See Documentation/cgroups.txt for details */
271
272struct cgroup_subsys {
273 struct cgroup_subsys_state *(*create)(struct cgroup_subsys *ss,
ffd2d883
LZ
274 struct cgroup *cgrp);
275 void (*pre_destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
276 void (*destroy)(struct cgroup_subsys *ss, struct cgroup *cgrp);
ddbcc7e8 277 int (*can_attach)(struct cgroup_subsys *ss,
ffd2d883
LZ
278 struct cgroup *cgrp, struct task_struct *tsk);
279 void (*attach)(struct cgroup_subsys *ss, struct cgroup *cgrp,
280 struct cgroup *old_cgrp, struct task_struct *tsk);
ddbcc7e8
PM
281 void (*fork)(struct cgroup_subsys *ss, struct task_struct *task);
282 void (*exit)(struct cgroup_subsys *ss, struct task_struct *task);
283 int (*populate)(struct cgroup_subsys *ss,
ffd2d883
LZ
284 struct cgroup *cgrp);
285 void (*post_clone)(struct cgroup_subsys *ss, struct cgroup *cgrp);
ddbcc7e8
PM
286 void (*bind)(struct cgroup_subsys *ss, struct cgroup *root);
287 int subsys_id;
288 int active;
8bab8dde 289 int disabled;
ddbcc7e8
PM
290 int early_init;
291#define MAX_CGROUP_TYPE_NAMELEN 32
292 const char *name;
293
294 /* Protected by RCU */
295 struct cgroupfs_root *root;
296
297 struct list_head sibling;
298
299 void *private;
300};
301
302#define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
303#include <linux/cgroup_subsys.h>
304#undef SUBSYS
305
306static inline struct cgroup_subsys_state *cgroup_subsys_state(
ffd2d883 307 struct cgroup *cgrp, int subsys_id)
ddbcc7e8 308{
ffd2d883 309 return cgrp->subsys[subsys_id];
ddbcc7e8
PM
310}
311
312static inline struct cgroup_subsys_state *task_subsys_state(
313 struct task_struct *task, int subsys_id)
314{
817929ec 315 return rcu_dereference(task->cgroups->subsys[subsys_id]);
ddbcc7e8
PM
316}
317
318static inline struct cgroup* task_cgroup(struct task_struct *task,
319 int subsys_id)
320{
321 return task_subsys_state(task, subsys_id)->cgroup;
322}
323
697f4161
PM
324int cgroup_clone(struct task_struct *tsk, struct cgroup_subsys *ss);
325
817929ec
PM
326/* A cgroup_iter should be treated as an opaque object */
327struct cgroup_iter {
328 struct list_head *cg_link;
329 struct list_head *task;
330};
331
332/* To iterate across the tasks in a cgroup:
333 *
334 * 1) call cgroup_iter_start to intialize an iterator
335 *
336 * 2) call cgroup_iter_next() to retrieve member tasks until it
337 * returns NULL or until you want to end the iteration
338 *
339 * 3) call cgroup_iter_end() to destroy the iterator.
31a7df01
CW
340 *
341 * Or, call cgroup_scan_tasks() to iterate through every task in a cpuset.
342 * - cgroup_scan_tasks() holds the css_set_lock when calling the test_task()
343 * callback, but not while calling the process_task() callback.
817929ec 344 */
ffd2d883
LZ
345void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
346struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
817929ec 347 struct cgroup_iter *it);
ffd2d883 348void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
31a7df01 349int cgroup_scan_tasks(struct cgroup_scanner *scan);
956db3ca 350int cgroup_attach_task(struct cgroup *, struct task_struct *);
817929ec 351
ddbcc7e8
PM
352#else /* !CONFIG_CGROUPS */
353
354static inline int cgroup_init_early(void) { return 0; }
355static inline int cgroup_init(void) { return 0; }
356static inline void cgroup_init_smp(void) {}
b4f48b63
PM
357static inline void cgroup_fork(struct task_struct *p) {}
358static inline void cgroup_fork_callbacks(struct task_struct *p) {}
817929ec 359static inline void cgroup_post_fork(struct task_struct *p) {}
b4f48b63 360static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
ddbcc7e8
PM
361
362static inline void cgroup_lock(void) {}
363static inline void cgroup_unlock(void) {}
846c7bb0
BS
364static inline int cgroupstats_build(struct cgroupstats *stats,
365 struct dentry *dentry)
366{
367 return -EINVAL;
368}
ddbcc7e8
PM
369
370#endif /* !CONFIG_CGROUPS */
371
372#endif /* _LINUX_CGROUP_H */
This page took 0.111988 seconds and 5 git commands to generate.