blob: b21881e1ea088a4e2393aa84799d5e2c6abe50ad [file] [log] [blame]
Paul Menageddbcc7e2007-10-18 23:39:30 -07001#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>
Paul Menageddbcc7e2007-10-18 23:39:30 -070012#include <linux/cpumask.h>
13#include <linux/nodemask.h>
14#include <linux/rcupdate.h>
Tejun Heoeb6fd502012-11-09 09:12:29 -080015#include <linux/rculist.h>
Balbir Singh846c7bb2007-10-18 23:39:44 -070016#include <linux/cgroupstats.h>
Cliff Wickman31a7df02008-02-07 00:14:42 -080017#include <linux/prio_heap.h>
Paul Menagecc31edc2008-10-18 20:28:04 -070018#include <linux/rwsem.h>
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -070019#include <linux/idr.h>
Tejun Heo48ddbe12012-04-01 12:09:56 -070020#include <linux/workqueue.h>
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -040021#include <linux/xattr.h>
Tejun Heo25a7e682013-04-14 20:15:25 -070022#include <linux/fs.h>
Paul Menageddbcc7e2007-10-18 23:39:30 -070023
24#ifdef CONFIG_CGROUPS
25
26struct cgroupfs_root;
27struct cgroup_subsys;
28struct inode;
Paul Menage84eea842008-07-25 01:47:00 -070029struct cgroup;
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -070030struct css_id;
Paul Menageddbcc7e2007-10-18 23:39:30 -070031
32extern int cgroup_init_early(void);
33extern int cgroup_init(void);
Paul Menageb4f48b62007-10-18 23:39:33 -070034extern void cgroup_fork(struct task_struct *p);
Paul Menage817929e2007-10-18 23:39:36 -070035extern void cgroup_post_fork(struct task_struct *p);
Paul Menageb4f48b62007-10-18 23:39:33 -070036extern void cgroup_exit(struct task_struct *p, int run_callbacks);
Balbir Singh846c7bb2007-10-18 23:39:44 -070037extern int cgroupstats_build(struct cgroupstats *stats,
38 struct dentry *dentry);
Ben Blume6a11052010-03-10 15:22:09 -080039extern int cgroup_load_subsys(struct cgroup_subsys *ss);
Ben Blumcf5d5942010-03-10 15:22:09 -080040extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
Paul Menageddbcc7e2007-10-18 23:39:30 -070041
Alexey Dobriyan828c0952009-10-01 15:43:56 -070042extern const struct file_operations proc_cgroup_operations;
Paul Menagea4243162007-10-18 23:39:35 -070043
Li Zefan7d8e0bf2013-03-05 10:57:03 +080044/*
45 * Define the enumeration of all cgroup subsystems.
46 *
47 * We define ids for builtin subsystems and then modular ones.
48 */
Paul Menage817929e2007-10-18 23:39:36 -070049#define SUBSYS(_x) _x ## _subsys_id,
50enum cgroup_subsys_id {
Li Zefan7d8e0bf2013-03-05 10:57:03 +080051#define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
Paul Menage817929e2007-10-18 23:39:36 -070052#include <linux/cgroup_subsys.h>
Li Zefan7d8e0bf2013-03-05 10:57:03 +080053#undef IS_SUBSYS_ENABLED
54 CGROUP_BUILTIN_SUBSYS_COUNT,
55
56 __CGROUP_SUBSYS_TEMP_PLACEHOLDER = CGROUP_BUILTIN_SUBSYS_COUNT - 1,
57
58#define IS_SUBSYS_ENABLED(option) IS_MODULE(option)
59#include <linux/cgroup_subsys.h>
60#undef IS_SUBSYS_ENABLED
Daniel Wagnera6f00292012-09-12 16:12:08 +020061 CGROUP_SUBSYS_COUNT,
Paul Menage817929e2007-10-18 23:39:36 -070062};
63#undef SUBSYS
64
Paul Menageddbcc7e2007-10-18 23:39:30 -070065/* Per-subsystem/per-cgroup state maintained by the system. */
66struct cgroup_subsys_state {
Paul Menaged20a3902009-04-02 16:57:22 -070067 /*
68 * The cgroup that this subsystem is attached to. Useful
Paul Menageddbcc7e2007-10-18 23:39:30 -070069 * for subsystems that want to know about the cgroup
Paul Menaged20a3902009-04-02 16:57:22 -070070 * hierarchy structure
71 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070072 struct cgroup *cgroup;
73
Paul Menaged20a3902009-04-02 16:57:22 -070074 /*
75 * State maintained by the cgroup system to allow subsystems
Paul Menagee7c5ec92009-01-07 18:08:38 -080076 * to be "busy". Should be accessed via css_get(),
Tao Mad0b2fdd2012-11-20 22:06:18 +080077 * css_tryget() and css_put().
Paul Menaged20a3902009-04-02 16:57:22 -070078 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070079
80 atomic_t refcnt;
81
82 unsigned long flags;
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -070083 /* ID for this css, if possible */
Arnd Bergmann2c392b82010-02-24 19:41:39 +010084 struct css_id __rcu *id;
Tejun Heo48ddbe12012-04-01 12:09:56 -070085
86 /* Used to put @cgroup->dentry on the last css_put() */
87 struct work_struct dput_work;
Paul Menageddbcc7e2007-10-18 23:39:30 -070088};
89
90/* bits in struct cgroup_subsys_state flags field */
91enum {
Tejun Heo38b53ab2012-11-19 08:13:36 -080092 CSS_ROOT = (1 << 0), /* this CSS is the root of the subsystem */
Tejun Heo92fb9742012-11-19 08:13:38 -080093 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
Paul Menageddbcc7e2007-10-18 23:39:30 -070094};
95
Daisuke Nishimurad7b9fff2010-03-10 15:22:05 -080096/* Caller must verify that the css is not for root cgroup */
97static inline void __css_get(struct cgroup_subsys_state *css, int count)
98{
99 atomic_add(count, &css->refcnt);
100}
101
Paul Menageddbcc7e2007-10-18 23:39:30 -0700102/*
Paul Menagee7c5ec92009-01-07 18:08:38 -0800103 * Call css_get() to hold a reference on the css; it can be used
104 * for a reference obtained via:
105 * - an existing ref-counted reference to the css
106 * - task->cgroups for a locked task
Paul Menageddbcc7e2007-10-18 23:39:30 -0700107 */
108
109static inline void css_get(struct cgroup_subsys_state *css)
110{
111 /* We don't need to reference count the root state */
Tejun Heo38b53ab2012-11-19 08:13:36 -0800112 if (!(css->flags & CSS_ROOT))
Daisuke Nishimurad7b9fff2010-03-10 15:22:05 -0800113 __css_get(css, 1);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700114}
Paul Menagee7c5ec92009-01-07 18:08:38 -0800115
Paul Menagee7c5ec92009-01-07 18:08:38 -0800116/*
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
Tejun Heo28b4c272012-04-01 12:09:56 -0700122extern bool __css_tryget(struct cgroup_subsys_state *css);
Paul Menagee7c5ec92009-01-07 18:08:38 -0800123static inline bool css_tryget(struct cgroup_subsys_state *css)
124{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800125 if (css->flags & CSS_ROOT)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800126 return true;
Tejun Heo28b4c272012-04-01 12:09:56 -0700127 return __css_tryget(css);
Paul Menagee7c5ec92009-01-07 18:08:38 -0800128}
129
Paul Menageddbcc7e2007-10-18 23:39:30 -0700130/*
131 * css_put() should be called to release a reference taken by
Paul Menagee7c5ec92009-01-07 18:08:38 -0800132 * css_get() or css_tryget()
Paul Menageddbcc7e2007-10-18 23:39:30 -0700133 */
134
Tejun Heo28b4c272012-04-01 12:09:56 -0700135extern void __css_put(struct cgroup_subsys_state *css);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700136static inline void css_put(struct cgroup_subsys_state *css)
137{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800138 if (!(css->flags & CSS_ROOT))
Tejun Heo28b4c272012-04-01 12:09:56 -0700139 __css_put(css);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700140}
141
Paul Menage3116f0e2008-04-29 01:00:04 -0700142/* bits in struct cgroup flags field */
143enum {
144 /* Control Group is dead */
145 CGRP_REMOVED,
Paul Menaged20a3902009-04-02 16:57:22 -0700146 /*
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 */
Paul Menage3116f0e2008-04-29 01:00:04 -0700150 CGRP_RELEASABLE,
151 /* Control Group requires release notifications to userspace */
152 CGRP_NOTIFY_ON_RELEASE,
KAMEZAWA Hiroyukiec64f512009-04-02 16:57:26 -0700153 /*
Tejun Heo2260e7f2012-11-19 08:13:38 -0800154 * Clone the parent's configuration when creating a new child
155 * cpuset cgroup. For historical reasons, this option can be
156 * specified at mount time and thus is implemented here.
Daniel Lezcano97978e62010-10-27 15:33:35 -0700157 */
Tejun Heo2260e7f2012-11-19 08:13:38 -0800158 CGRP_CPUSET_CLONE_CHILDREN,
Paul Menage3116f0e2008-04-29 01:00:04 -0700159};
160
Li Zefan65dff752013-03-01 15:01:56 +0800161struct cgroup_name {
162 struct rcu_head rcu_head;
163 char name[];
164};
165
Paul Menageddbcc7e2007-10-18 23:39:30 -0700166struct cgroup {
167 unsigned long flags; /* "unsigned long" so bitops work */
168
Paul Menaged20a3902009-04-02 16:57:22 -0700169 /*
170 * count users of this cgroup. >0 means busy, but doesn't
171 * necessarily indicate the number of tasks in the cgroup
172 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700173 atomic_t count;
174
Tejun Heo0a950f62012-11-19 09:02:12 -0800175 int id; /* ida allocated in-hierarchy ID */
176
Paul Menageddbcc7e2007-10-18 23:39:30 -0700177 /*
178 * We link our 'sibling' struct into our parent's 'children'.
179 * Our children link their 'sibling' into our 'children'.
180 */
181 struct list_head sibling; /* my parent's children */
182 struct list_head children; /* my children */
Tejun Heo05ef1d72012-04-01 12:09:56 -0700183 struct list_head files; /* my files */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700184
Paul Menaged20a3902009-04-02 16:57:22 -0700185 struct cgroup *parent; /* my parent */
Tejun Heofebfcef2012-11-19 08:13:36 -0800186 struct dentry *dentry; /* cgroup fs entry, RCU protected */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700187
Li Zefan65dff752013-03-01 15:01:56 +0800188 /*
189 * This is a copy of dentry->d_name, and it's needed because
190 * we can't use dentry->d_name in cgroup_path().
191 *
192 * You must acquire rcu_read_lock() to access cgrp->name, and
193 * the only place that can change it is rename(), which is
194 * protected by parent dir's i_mutex.
195 *
196 * Normally you should use cgroup_name() wrapper rather than
197 * access it directly.
198 */
199 struct cgroup_name __rcu *name;
200
Paul Menageddbcc7e2007-10-18 23:39:30 -0700201 /* Private pointers for each registered subsystem */
202 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
203
204 struct cgroupfs_root *root;
205 struct cgroup *top_cgroup;
Paul Menage817929e2007-10-18 23:39:36 -0700206
207 /*
208 * List of cg_cgroup_links pointing at css_sets with
209 * tasks in this cgroup. Protected by css_set_lock
210 */
211 struct list_head css_sets;
Paul Menage81a6a5c2007-10-18 23:39:38 -0700212
Tejun Heob0ca5a82012-04-01 12:09:54 -0700213 struct list_head allcg_node; /* cgroupfs_root->allcg_list */
Tejun Heo8e3f6542012-04-01 12:09:55 -0700214 struct list_head cft_q_node; /* used during cftype add/rm */
Tejun Heob0ca5a82012-04-01 12:09:54 -0700215
Paul Menage81a6a5c2007-10-18 23:39:38 -0700216 /*
217 * Linked list running through all cgroups that can
218 * potentially be reaped by the release agent. Protected by
219 * release_list_lock
220 */
221 struct list_head release_list;
Paul Menagecc31edc2008-10-18 20:28:04 -0700222
Ben Blum72a8cb32009-09-23 15:56:27 -0700223 /*
224 * list of pidlists, up to two for each namespace (one for procs, one
225 * for tasks); created on demand.
226 */
227 struct list_head pidlists;
228 struct mutex pidlist_mutex;
Paul Menagea47295e2009-01-07 18:07:44 -0800229
230 /* For RCU-protected deletion */
231 struct rcu_head rcu_head;
Li Zefanbe445622013-01-24 14:31:42 +0800232 struct work_struct free_work;
Kirill A. Shutemov0dea1162010-03-10 15:22:20 -0800233
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300234 /* List of events which userspace want to receive */
Kirill A. Shutemov0dea1162010-03-10 15:22:20 -0800235 struct list_head event_list;
236 spinlock_t event_list_lock;
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400237
238 /* directory xattrs */
239 struct simple_xattrs xattrs;
Paul Menage817929e2007-10-18 23:39:36 -0700240};
241
Tejun Heo25a7e682013-04-14 20:15:25 -0700242#define MAX_CGROUP_ROOT_NAMELEN 64
243
244/* cgroupfs_root->flags */
245enum {
246 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
247 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
248};
249
250/*
251 * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
252 * associated with a superblock to form an active hierarchy. This is
253 * internal to cgroup core. Don't access directly from controllers.
254 */
255struct cgroupfs_root {
256 struct super_block *sb;
257
258 /*
259 * The bitmask of subsystems intended to be attached to this
260 * hierarchy
261 */
262 unsigned long subsys_mask;
263
264 /* Unique id for this hierarchy. */
265 int hierarchy_id;
266
267 /* The bitmask of subsystems currently attached to this hierarchy */
268 unsigned long actual_subsys_mask;
269
270 /* A list running through the attached subsystems */
271 struct list_head subsys_list;
272
273 /* The root cgroup for this hierarchy */
274 struct cgroup top_cgroup;
275
276 /* Tracks how many cgroups are currently defined in hierarchy.*/
277 int number_of_cgroups;
278
279 /* A list running through the active hierarchies */
280 struct list_head root_list;
281
282 /* All cgroups on this root, cgroup_mutex protected */
283 struct list_head allcg_list;
284
285 /* Hierarchy-specific flags */
286 unsigned long flags;
287
288 /* IDs for cgroups in this hierarchy */
289 struct ida cgroup_ida;
290
291 /* The path to use for release notifications. */
292 char release_agent_path[PATH_MAX];
293
294 /* The name for this hierarchy - may be empty */
295 char name[MAX_CGROUP_ROOT_NAMELEN];
296};
297
Paul Menaged20a3902009-04-02 16:57:22 -0700298/*
299 * A css_set is a structure holding pointers to a set of
Paul Menage817929e2007-10-18 23:39:36 -0700300 * cgroup_subsys_state objects. This saves space in the task struct
301 * object and speeds up fork()/exit(), since a single inc/dec and a
Paul Menaged20a3902009-04-02 16:57:22 -0700302 * list_add()/del() can bump the reference count on the entire cgroup
303 * set for a task.
Paul Menage817929e2007-10-18 23:39:36 -0700304 */
305
306struct css_set {
307
308 /* Reference count */
Lai Jiangshan146aa1b2008-10-18 20:28:03 -0700309 atomic_t refcount;
Paul Menage817929e2007-10-18 23:39:36 -0700310
311 /*
Li Zefan472b1052008-04-29 01:00:11 -0700312 * List running through all cgroup groups in the same hash
313 * slot. Protected by css_set_lock
314 */
315 struct hlist_node hlist;
316
317 /*
Paul Menage817929e2007-10-18 23:39:36 -0700318 * List running through all tasks using this cgroup
319 * group. Protected by css_set_lock
320 */
321 struct list_head tasks;
322
323 /*
324 * List of cg_cgroup_link objects on link chains from
325 * cgroups referenced from this css_set. Protected by
326 * css_set_lock
327 */
328 struct list_head cg_links;
329
330 /*
331 * Set of subsystem states, one for each subsystem. This array
332 * is immutable after creation apart from the init_css_set
Ben Blumcf5d5942010-03-10 15:22:09 -0800333 * during subsystem registration (at boot time) and modular subsystem
334 * loading/unloading.
Paul Menage817929e2007-10-18 23:39:36 -0700335 */
336 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
Ben Blumc3783692009-09-23 15:56:29 -0700337
338 /* For RCU-protected deletion */
339 struct rcu_head rcu_head;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700340};
341
Paul Menage91796562008-04-29 01:00:01 -0700342/*
343 * cgroup_map_cb is an abstract callback API for reporting map-valued
344 * control files
345 */
346
347struct cgroup_map_cb {
348 int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
349 void *state;
350};
351
Paul Menaged20a3902009-04-02 16:57:22 -0700352/*
353 * struct cftype: handler definitions for cgroup control files
Paul Menageddbcc7e2007-10-18 23:39:30 -0700354 *
355 * When reading/writing to a file:
Li Zefana043e3b2008-02-23 15:24:09 -0800356 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
Paul Menageddbcc7e2007-10-18 23:39:30 -0700357 * - the 'cftype' of the file is file->f_dentry->d_fsdata
358 */
359
Tejun Heo8e3f6542012-04-01 12:09:55 -0700360/* cftype->flags */
361#define CFTYPE_ONLY_ON_ROOT (1U << 0) /* only create on root cg */
Tao Mad0b2fdd2012-11-20 22:06:18 +0800362#define CFTYPE_NOT_ON_ROOT (1U << 1) /* don't create on root cg */
Tejun Heo8e3f6542012-04-01 12:09:55 -0700363
364#define MAX_CFTYPE_NAME 64
365
Paul Menageddbcc7e2007-10-18 23:39:30 -0700366struct cftype {
Paul Menaged20a3902009-04-02 16:57:22 -0700367 /*
368 * By convention, the name should begin with the name of the
Tejun Heo8e3f6542012-04-01 12:09:55 -0700369 * subsystem, followed by a period. Zero length string indicates
370 * end of cftype array.
Paul Menaged20a3902009-04-02 16:57:22 -0700371 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700372 char name[MAX_CFTYPE_NAME];
373 int private;
Li Zefan099fca32009-04-02 16:57:29 -0700374 /*
375 * If not 0, file mode is set to this value, otherwise it will
376 * be figured out automatically
377 */
Al Viroa5e7ed32011-07-26 01:55:55 -0400378 umode_t mode;
Paul Menagedb3b1492008-07-25 01:46:58 -0700379
380 /*
381 * If non-zero, defines the maximum length of string that can
382 * be passed to write_string; defaults to 64
383 */
384 size_t max_write_len;
385
Tejun Heo8e3f6542012-04-01 12:09:55 -0700386 /* CFTYPE_* flags */
387 unsigned int flags;
388
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400389 /* file xattrs */
390 struct simple_xattrs xattrs;
391
Paul Menagece16b492008-07-25 01:46:57 -0700392 int (*open)(struct inode *inode, struct file *file);
393 ssize_t (*read)(struct cgroup *cgrp, struct cftype *cft,
394 struct file *file,
395 char __user *buf, size_t nbytes, loff_t *ppos);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700396 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700397 * read_u64() is a shortcut for the common case of returning a
Paul Menageddbcc7e2007-10-18 23:39:30 -0700398 * single integer. Use it in place of read()
399 */
Paul Menagece16b492008-07-25 01:46:57 -0700400 u64 (*read_u64)(struct cgroup *cgrp, struct cftype *cft);
Paul Menage91796562008-04-29 01:00:01 -0700401 /*
Paul Menagee73d2c62008-04-29 01:00:06 -0700402 * read_s64() is a signed version of read_u64()
403 */
Paul Menagece16b492008-07-25 01:46:57 -0700404 s64 (*read_s64)(struct cgroup *cgrp, struct cftype *cft);
Paul Menagee73d2c62008-04-29 01:00:06 -0700405 /*
Paul Menage91796562008-04-29 01:00:01 -0700406 * read_map() is used for defining a map of key/value
407 * pairs. It should call cb->fill(cb, key, value) for each
408 * entry. The key/value pairs (and their ordering) should not
409 * change between reboots.
410 */
Paul Menagece16b492008-07-25 01:46:57 -0700411 int (*read_map)(struct cgroup *cont, struct cftype *cft,
412 struct cgroup_map_cb *cb);
Serge E. Hallyn29486df2008-04-29 01:00:14 -0700413 /*
414 * read_seq_string() is used for outputting a simple sequence
415 * using seqfile.
416 */
Paul Menagece16b492008-07-25 01:46:57 -0700417 int (*read_seq_string)(struct cgroup *cont, struct cftype *cft,
418 struct seq_file *m);
Paul Menage91796562008-04-29 01:00:01 -0700419
Paul Menagece16b492008-07-25 01:46:57 -0700420 ssize_t (*write)(struct cgroup *cgrp, struct cftype *cft,
421 struct file *file,
422 const char __user *buf, size_t nbytes, loff_t *ppos);
Paul Menage355e0c42007-10-18 23:39:33 -0700423
424 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700425 * write_u64() is a shortcut for the common case of accepting
Paul Menage355e0c42007-10-18 23:39:33 -0700426 * a single integer (as parsed by simple_strtoull) from
427 * userspace. Use in place of write(); return 0 or error.
428 */
Paul Menagece16b492008-07-25 01:46:57 -0700429 int (*write_u64)(struct cgroup *cgrp, struct cftype *cft, u64 val);
Paul Menagee73d2c62008-04-29 01:00:06 -0700430 /*
431 * write_s64() is a signed version of write_u64()
432 */
Paul Menagece16b492008-07-25 01:46:57 -0700433 int (*write_s64)(struct cgroup *cgrp, struct cftype *cft, s64 val);
Paul Menage355e0c42007-10-18 23:39:33 -0700434
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700435 /*
Paul Menagedb3b1492008-07-25 01:46:58 -0700436 * write_string() is passed a nul-terminated kernelspace
437 * buffer of maximum length determined by max_write_len.
438 * Returns 0 or -ve error code.
439 */
440 int (*write_string)(struct cgroup *cgrp, struct cftype *cft,
441 const char *buffer);
442 /*
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700443 * trigger() callback can be used to get some kick from the
444 * userspace, when the actual string written is not important
445 * at all. The private field can be used to determine the
446 * kick type for multiplexing.
447 */
448 int (*trigger)(struct cgroup *cgrp, unsigned int event);
449
Paul Menagece16b492008-07-25 01:46:57 -0700450 int (*release)(struct inode *inode, struct file *file);
Kirill A. Shutemov0dea1162010-03-10 15:22:20 -0800451
452 /*
453 * register_event() callback will be used to add new userspace
454 * waiter for changes related to the cftype. Implement it if
455 * you want to provide this functionality. Use eventfd_signal()
456 * on eventfd to send notification to userspace.
457 */
458 int (*register_event)(struct cgroup *cgrp, struct cftype *cft,
459 struct eventfd_ctx *eventfd, const char *args);
460 /*
461 * unregister_event() callback will be called when userspace
462 * closes the eventfd or on cgroup removing.
463 * This callback must be implemented, if you want provide
464 * notification functionality.
Kirill A. Shutemov0dea1162010-03-10 15:22:20 -0800465 */
Kirill A. Shutemov907860e2010-05-26 14:42:46 -0700466 void (*unregister_event)(struct cgroup *cgrp, struct cftype *cft,
Kirill A. Shutemov0dea1162010-03-10 15:22:20 -0800467 struct eventfd_ctx *eventfd);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700468};
469
Tejun Heo8e3f6542012-04-01 12:09:55 -0700470/*
471 * cftype_sets describe cftypes belonging to a subsystem and are chained at
472 * cgroup_subsys->cftsets. Each cftset points to an array of cftypes
473 * terminated by zero length name.
474 */
475struct cftype_set {
476 struct list_head node; /* chained at subsys->cftsets */
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400477 struct cftype *cfts;
Tejun Heo8e3f6542012-04-01 12:09:55 -0700478};
479
Cliff Wickman31a7df02008-02-07 00:14:42 -0800480struct cgroup_scanner {
481 struct cgroup *cg;
482 int (*test_task)(struct task_struct *p, struct cgroup_scanner *scan);
483 void (*process_task)(struct task_struct *p,
484 struct cgroup_scanner *scan);
485 struct ptr_heap *heap;
Li Zefanbd1a8ab2009-04-02 16:57:50 -0700486 void *data;
Cliff Wickman31a7df02008-02-07 00:14:42 -0800487};
488
Li Zefan65dff752013-03-01 15:01:56 +0800489/* Caller should hold rcu_read_lock() */
490static inline const char *cgroup_name(const struct cgroup *cgrp)
491{
492 return rcu_dereference(cgrp->name)->name;
493}
494
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400495int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
496int cgroup_rm_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo8e3f6542012-04-01 12:09:55 -0700497
Li Zefanffd2d882008-02-23 15:24:09 -0800498int cgroup_is_removed(const struct cgroup *cgrp);
Li Zefan78574cf2013-04-08 19:00:38 -0700499bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700500
Li Zefanffd2d882008-02-23 15:24:09 -0800501int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700502
Li Zefanffd2d882008-02-23 15:24:09 -0800503int cgroup_task_count(const struct cgroup *cgrp);
Paul Menagebbcb81d2007-10-18 23:39:32 -0700504
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100505/*
Tejun Heo2f7ee562011-12-12 18:12:21 -0800506 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
507 * methods.
508 */
509struct cgroup_taskset;
510struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
511struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
512struct cgroup *cgroup_taskset_cur_cgroup(struct cgroup_taskset *tset);
513int cgroup_taskset_size(struct cgroup_taskset *tset);
514
515/**
516 * cgroup_taskset_for_each - iterate cgroup_taskset
517 * @task: the loop cursor
518 * @skip_cgrp: skip if task's cgroup matches this, %NULL to iterate through all
519 * @tset: taskset to iterate
520 */
521#define cgroup_taskset_for_each(task, skip_cgrp, tset) \
522 for ((task) = cgroup_taskset_first((tset)); (task); \
523 (task) = cgroup_taskset_next((tset))) \
524 if (!(skip_cgrp) || \
525 cgroup_taskset_cur_cgroup((tset)) != (skip_cgrp))
526
527/*
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100528 * Control Group subsystem type.
529 * See Documentation/cgroups/cgroups.txt for details
530 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700531
532struct cgroup_subsys {
Tejun Heo92fb9742012-11-19 08:13:38 -0800533 struct cgroup_subsys_state *(*css_alloc)(struct cgroup *cgrp);
534 int (*css_online)(struct cgroup *cgrp);
535 void (*css_offline)(struct cgroup *cgrp);
536 void (*css_free)(struct cgroup *cgrp);
537
Li Zefan761b3ef2012-01-31 13:47:36 +0800538 int (*can_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
539 void (*cancel_attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
540 void (*attach)(struct cgroup *cgrp, struct cgroup_taskset *tset);
541 void (*fork)(struct task_struct *task);
542 void (*exit)(struct cgroup *cgrp, struct cgroup *old_cgrp,
543 struct task_struct *task);
Tejun Heo26d5bbe2013-04-12 10:29:04 -0700544 void (*bind)(struct cgroup *root);
545
Paul Menageddbcc7e2007-10-18 23:39:30 -0700546 int subsys_id;
547 int active;
Paul Menage8bab8dd2008-04-04 14:29:57 -0700548 int disabled;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700549 int early_init;
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700550 /*
551 * True if this subsys uses ID. ID is not available before cgroup_init()
552 * (not available in early_init time.)
553 */
554 bool use_id;
Tejun Heo48ddbe12012-04-01 12:09:56 -0700555
556 /*
Tejun Heo8c7f6ed2012-09-13 12:20:58 -0700557 * If %false, this subsystem is properly hierarchical -
558 * configuration, resource accounting and restriction on a parent
559 * cgroup cover those of its children. If %true, hierarchy support
560 * is broken in some ways - some subsystems ignore hierarchy
561 * completely while others are only implemented half-way.
562 *
563 * It's now disallowed to create nested cgroups if the subsystem is
564 * broken and cgroup core will emit a warning message on such
565 * cases. Eventually, all subsystems will be made properly
566 * hierarchical and this will go away.
567 */
568 bool broken_hierarchy;
569 bool warned_broken_hierarchy;
570
Paul Menageddbcc7e2007-10-18 23:39:30 -0700571#define MAX_CGROUP_TYPE_NAMELEN 32
572 const char *name;
573
Paul Menage999cd8a2009-01-07 18:08:36 -0800574 /*
Paul Menage999cd8a2009-01-07 18:08:36 -0800575 * Link to parent, and list entry in parent's children.
Li Zefan6be96a52012-06-06 19:12:30 -0700576 * Protected by cgroup_lock()
Paul Menage999cd8a2009-01-07 18:08:36 -0800577 */
578 struct cgroupfs_root *root;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700579 struct list_head sibling;
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700580 /* used when use_id == true */
581 struct idr idr;
Hugh Dickins42aee6c2012-03-21 16:34:21 -0700582 spinlock_t id_lock;
Ben Blume6a11052010-03-10 15:22:09 -0800583
Tejun Heo8e3f6542012-04-01 12:09:55 -0700584 /* list of cftype_sets */
585 struct list_head cftsets;
586
587 /* base cftypes, automatically [de]registered with subsys itself */
588 struct cftype *base_cftypes;
589 struct cftype_set base_cftset;
590
Ben Blume6a11052010-03-10 15:22:09 -0800591 /* should be defined only by modular subsystems */
592 struct module *module;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700593};
594
595#define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
Daniel Wagner5fc0b022012-09-12 16:12:05 +0200596#define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700597#include <linux/cgroup_subsys.h>
Daniel Wagner5fc0b022012-09-12 16:12:05 +0200598#undef IS_SUBSYS_ENABLED
Paul Menageddbcc7e2007-10-18 23:39:30 -0700599#undef SUBSYS
600
601static inline struct cgroup_subsys_state *cgroup_subsys_state(
Li Zefanffd2d882008-02-23 15:24:09 -0800602 struct cgroup *cgrp, int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700603{
Li Zefanffd2d882008-02-23 15:24:09 -0800604 return cgrp->subsys[subsys_id];
Paul Menageddbcc7e2007-10-18 23:39:30 -0700605}
606
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200607/*
608 * function to get the cgroup_subsys_state which allows for extra
609 * rcu_dereference_check() conditions, such as locks used during the
610 * cgroup_subsys::attach() methods.
611 */
Tejun Heo22194492013-04-07 09:29:51 -0700612#ifdef CONFIG_PROVE_RCU
613extern struct mutex cgroup_mutex;
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200614#define task_subsys_state_check(task, subsys_id, __c) \
Tejun Heo22194492013-04-07 09:29:51 -0700615 rcu_dereference_check((task)->cgroups->subsys[(subsys_id)], \
616 lockdep_is_held(&(task)->alloc_lock) || \
617 lockdep_is_held(&cgroup_mutex) || (__c))
618#else
619#define task_subsys_state_check(task, subsys_id, __c) \
620 rcu_dereference((task)->cgroups->subsys[(subsys_id)])
621#endif
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200622
623static inline struct cgroup_subsys_state *
624task_subsys_state(struct task_struct *task, int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700625{
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200626 return task_subsys_state_check(task, subsys_id, false);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700627}
628
629static inline struct cgroup* task_cgroup(struct task_struct *task,
630 int subsys_id)
631{
632 return task_subsys_state(task, subsys_id)->cgroup;
633}
634
Tejun Heo574bd9f2012-11-09 09:12:29 -0800635/**
636 * cgroup_for_each_child - iterate through children of a cgroup
637 * @pos: the cgroup * to use as the loop cursor
638 * @cgroup: cgroup whose children to walk
639 *
640 * Walk @cgroup's children. Must be called under rcu_read_lock(). A child
Tejun Heo92fb9742012-11-19 08:13:38 -0800641 * cgroup which hasn't finished ->css_online() or already has finished
642 * ->css_offline() may show up during traversal and it's each subsystem's
Tejun Heo574bd9f2012-11-09 09:12:29 -0800643 * responsibility to verify that each @pos is alive.
644 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800645 * If a subsystem synchronizes against the parent in its ->css_online() and
646 * before starting iterating, a cgroup which finished ->css_online() is
647 * guaranteed to be visible in the future iterations.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800648 */
649#define cgroup_for_each_child(pos, cgroup) \
650 list_for_each_entry_rcu(pos, &(cgroup)->children, sibling)
651
652struct cgroup *cgroup_next_descendant_pre(struct cgroup *pos,
653 struct cgroup *cgroup);
Tejun Heo12a9d2f2013-01-07 08:49:33 -0800654struct cgroup *cgroup_rightmost_descendant(struct cgroup *pos);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800655
656/**
657 * cgroup_for_each_descendant_pre - pre-order walk of a cgroup's descendants
658 * @pos: the cgroup * to use as the loop cursor
659 * @cgroup: cgroup whose descendants to walk
660 *
661 * Walk @cgroup's descendants. Must be called under rcu_read_lock(). A
Tejun Heo92fb9742012-11-19 08:13:38 -0800662 * descendant cgroup which hasn't finished ->css_online() or already has
663 * finished ->css_offline() may show up during traversal and it's each
Tejun Heo574bd9f2012-11-09 09:12:29 -0800664 * subsystem's responsibility to verify that each @pos is alive.
665 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800666 * If a subsystem synchronizes against the parent in its ->css_online() and
667 * before starting iterating, and synchronizes against @pos on each
668 * iteration, any descendant cgroup which finished ->css_offline() is
Tejun Heo574bd9f2012-11-09 09:12:29 -0800669 * guaranteed to be visible in the future iterations.
670 *
671 * In other words, the following guarantees that a descendant can't escape
672 * state updates of its ancestors.
673 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800674 * my_online(@cgrp)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800675 * {
676 * Lock @cgrp->parent and @cgrp;
677 * Inherit state from @cgrp->parent;
678 * Unlock both.
679 * }
680 *
681 * my_update_state(@cgrp)
682 * {
683 * Lock @cgrp;
684 * Update @cgrp's state;
685 * Unlock @cgrp;
686 *
687 * cgroup_for_each_descendant_pre(@pos, @cgrp) {
688 * Lock @pos;
689 * Verify @pos is alive and inherit state from @pos->parent;
690 * Unlock @pos;
691 * }
692 * }
693 *
694 * As long as the inheriting step, including checking the parent state, is
695 * enclosed inside @pos locking, double-locking the parent isn't necessary
696 * while inheriting. The state update to the parent is guaranteed to be
697 * visible by walking order and, as long as inheriting operations to the
698 * same @pos are atomic to each other, multiple updates racing each other
699 * still result in the correct state. It's guaranateed that at least one
700 * inheritance happens for any cgroup after the latest update to its
701 * parent.
702 *
703 * If checking parent's state requires locking the parent, each inheriting
704 * iteration should lock and unlock both @pos->parent and @pos.
705 *
706 * Alternatively, a subsystem may choose to use a single global lock to
Tejun Heo92fb9742012-11-19 08:13:38 -0800707 * synchronize ->css_online() and ->css_offline() against tree-walking
Tejun Heo574bd9f2012-11-09 09:12:29 -0800708 * operations.
709 */
710#define cgroup_for_each_descendant_pre(pos, cgroup) \
711 for (pos = cgroup_next_descendant_pre(NULL, (cgroup)); (pos); \
712 pos = cgroup_next_descendant_pre((pos), (cgroup)))
713
714struct cgroup *cgroup_next_descendant_post(struct cgroup *pos,
715 struct cgroup *cgroup);
716
717/**
718 * cgroup_for_each_descendant_post - post-order walk of a cgroup's descendants
719 * @pos: the cgroup * to use as the loop cursor
720 * @cgroup: cgroup whose descendants to walk
721 *
722 * Similar to cgroup_for_each_descendant_pre() but performs post-order
723 * traversal instead. Note that the walk visibility guarantee described in
724 * pre-order walk doesn't apply the same to post-order walks.
725 */
726#define cgroup_for_each_descendant_post(pos, cgroup) \
727 for (pos = cgroup_next_descendant_post(NULL, (cgroup)); (pos); \
728 pos = cgroup_next_descendant_post((pos), (cgroup)))
729
Paul Menage817929e2007-10-18 23:39:36 -0700730/* A cgroup_iter should be treated as an opaque object */
731struct cgroup_iter {
732 struct list_head *cg_link;
733 struct list_head *task;
734};
735
Paul Menaged20a3902009-04-02 16:57:22 -0700736/*
737 * To iterate across the tasks in a cgroup:
Paul Menage817929e2007-10-18 23:39:36 -0700738 *
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400739 * 1) call cgroup_iter_start to initialize an iterator
Paul Menage817929e2007-10-18 23:39:36 -0700740 *
741 * 2) call cgroup_iter_next() to retrieve member tasks until it
742 * returns NULL or until you want to end the iteration
743 *
744 * 3) call cgroup_iter_end() to destroy the iterator.
Cliff Wickman31a7df02008-02-07 00:14:42 -0800745 *
Paul Menaged20a3902009-04-02 16:57:22 -0700746 * Or, call cgroup_scan_tasks() to iterate through every task in a
747 * cgroup - cgroup_scan_tasks() holds the css_set_lock when calling
748 * the test_task() callback, but not while calling the process_task()
749 * callback.
Paul Menage817929e2007-10-18 23:39:36 -0700750 */
Li Zefanffd2d882008-02-23 15:24:09 -0800751void cgroup_iter_start(struct cgroup *cgrp, struct cgroup_iter *it);
752struct task_struct *cgroup_iter_next(struct cgroup *cgrp,
Paul Menage817929e2007-10-18 23:39:36 -0700753 struct cgroup_iter *it);
Li Zefanffd2d882008-02-23 15:24:09 -0800754void cgroup_iter_end(struct cgroup *cgrp, struct cgroup_iter *it);
Cliff Wickman31a7df02008-02-07 00:14:42 -0800755int cgroup_scan_tasks(struct cgroup_scanner *scan);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700756int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
Tejun Heo8cc99342013-04-07 09:29:50 -0700757int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700758
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700759/*
760 * CSS ID is ID for cgroup_subsys_state structs under subsys. This only works
761 * if cgroup_subsys.use_id == true. It can be used for looking up and scanning.
762 * CSS ID is assigned at cgroup allocation (create) automatically
763 * and removed when subsys calls free_css_id() function. This is because
764 * the lifetime of cgroup_subsys_state is subsys's matter.
765 *
766 * Looking up and scanning function should be called under rcu_read_lock().
Li Zefan6be96a52012-06-06 19:12:30 -0700767 * Taking cgroup_mutex is not necessary for following calls.
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700768 * But the css returned by this routine can be "not populated yet" or "being
769 * destroyed". The caller should check css and cgroup's status.
770 */
771
772/*
773 * Typically Called at ->destroy(), or somewhere the subsys frees
774 * cgroup_subsys_state.
775 */
776void free_css_id(struct cgroup_subsys *ss, struct cgroup_subsys_state *css);
777
778/* Find a cgroup_subsys_state which has given ID */
779
780struct cgroup_subsys_state *css_lookup(struct cgroup_subsys *ss, int id);
781
782/*
783 * Get a cgroup whose id is greater than or equal to id under tree of root.
784 * Returning a cgroup_subsys_state or NULL.
785 */
786struct cgroup_subsys_state *css_get_next(struct cgroup_subsys *ss, int id,
787 struct cgroup_subsys_state *root, int *foundid);
788
789/* Returns true if root is ancestor of cg */
790bool css_is_ancestor(struct cgroup_subsys_state *cg,
KAMEZAWA Hiroyuki0b7f5692009-04-02 16:57:38 -0700791 const struct cgroup_subsys_state *root);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700792
793/* Get id and depth of css */
794unsigned short css_id(struct cgroup_subsys_state *css);
795unsigned short css_depth(struct cgroup_subsys_state *css);
Stephane Eraniane5d13672011-02-14 11:20:01 +0200796struct cgroup_subsys_state *cgroup_css_from_dir(struct file *f, int id);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700797
Paul Menageddbcc7e2007-10-18 23:39:30 -0700798#else /* !CONFIG_CGROUPS */
799
800static inline int cgroup_init_early(void) { return 0; }
801static inline int cgroup_init(void) { return 0; }
Paul Menageb4f48b62007-10-18 23:39:33 -0700802static inline void cgroup_fork(struct task_struct *p) {}
Paul Menage817929e2007-10-18 23:39:36 -0700803static inline void cgroup_post_fork(struct task_struct *p) {}
Paul Menageb4f48b62007-10-18 23:39:33 -0700804static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700805
806static inline void cgroup_lock(void) {}
807static inline void cgroup_unlock(void) {}
Balbir Singh846c7bb2007-10-18 23:39:44 -0700808static inline int cgroupstats_build(struct cgroupstats *stats,
809 struct dentry *dentry)
810{
811 return -EINVAL;
812}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700813
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200814/* No cgroups - nothing to do */
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700815static inline int cgroup_attach_task_all(struct task_struct *from,
816 struct task_struct *t)
817{
818 return 0;
819}
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200820
Paul Menageddbcc7e2007-10-18 23:39:30 -0700821#endif /* !CONFIG_CGROUPS */
822
Paul Menageddbcc7e2007-10-18 23:39:30 -0700823#endif /* _LINUX_CGROUP_H */