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