blob: b5223c570eba54e4dafb4e31b1e7d89c0a65b9f8 [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>
Paul Menagecc31edc2008-10-18 20:28:04 -070017#include <linux/rwsem.h>
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -070018#include <linux/idr.h>
Tejun Heo48ddbe12012-04-01 12:09:56 -070019#include <linux/workqueue.h>
Tejun Heo25a7e682013-04-14 20:15:25 -070020#include <linux/fs.h>
Tejun Heod3daf282013-06-13 19:39:16 -070021#include <linux/percpu-refcount.h>
Tejun Heo7da11272013-12-05 12:28:04 -050022#include <linux/seq_file.h>
Tejun Heo2bd59d42014-02-11 11:52:49 -050023#include <linux/kernfs.h>
Tejun Heof8f22e52014-04-23 11:13:16 -040024#include <linux/wait.h>
Paul Menageddbcc7e2007-10-18 23:39:30 -070025
26#ifdef CONFIG_CGROUPS
27
Tejun Heo3dd06ff2014-03-19 10:23:54 -040028struct cgroup_root;
Paul Menageddbcc7e2007-10-18 23:39:30 -070029struct cgroup_subsys;
30struct inode;
Paul Menage84eea842008-07-25 01:47:00 -070031struct cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -070032
33extern int cgroup_init_early(void);
34extern int cgroup_init(void);
Paul Menageb4f48b62007-10-18 23:39:33 -070035extern void cgroup_fork(struct task_struct *p);
Paul Menage817929e2007-10-18 23:39:36 -070036extern void cgroup_post_fork(struct task_struct *p);
Li Zefan1ec41832014-03-28 15:22:19 +080037extern void cgroup_exit(struct task_struct *p);
Balbir Singh846c7bb2007-10-18 23:39:44 -070038extern int cgroupstats_build(struct cgroupstats *stats,
39 struct dentry *dentry);
Paul Menageddbcc7e2007-10-18 23:39:30 -070040
Al Viro8d8b97b2013-04-19 23:11:24 -040041extern int proc_cgroup_show(struct seq_file *, void *);
Paul Menagea4243162007-10-18 23:39:35 -070042
Tejun Heo3ed80a62014-02-08 10:36:58 -050043/* define the enumeration of all cgroup subsystems */
Tejun Heo073219e2014-02-08 10:36:58 -050044#define SUBSYS(_x) _x ## _cgrp_id,
Paul Menage817929e2007-10-18 23:39:36 -070045enum cgroup_subsys_id {
46#include <linux/cgroup_subsys.h>
Daniel Wagnera6f00292012-09-12 16:12:08 +020047 CGROUP_SUBSYS_COUNT,
Paul Menage817929e2007-10-18 23:39:36 -070048};
49#undef SUBSYS
50
Tejun Heo5c9d5352014-05-16 13:22:48 -040051/*
52 * Per-subsystem/per-cgroup state maintained by the system. This is the
53 * fundamental structural building block that controllers deal with.
54 *
55 * Fields marked with "PI:" are public and immutable and may be accessed
56 * directly without synchronization.
57 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070058struct cgroup_subsys_state {
Tejun Heo5c9d5352014-05-16 13:22:48 -040059 /* PI: the cgroup that this css is attached to */
Paul Menageddbcc7e2007-10-18 23:39:30 -070060 struct cgroup *cgroup;
61
Tejun Heo5c9d5352014-05-16 13:22:48 -040062 /* PI: the cgroup subsystem that this css is attached to */
Tejun Heo72c97e52013-08-08 20:11:22 -040063 struct cgroup_subsys *ss;
64
Tejun Heod3daf282013-06-13 19:39:16 -070065 /* reference count - access via css_[try]get() and css_put() */
66 struct percpu_ref refcnt;
Paul Menageddbcc7e2007-10-18 23:39:30 -070067
Tejun Heo5c9d5352014-05-16 13:22:48 -040068 /* PI: the parent css */
Tejun Heo0ae78e02013-08-13 11:01:54 -040069 struct cgroup_subsys_state *parent;
70
Tejun Heod5c419b2014-05-16 13:22:48 -040071 /* siblings list anchored at the parent's ->children */
72 struct list_head sibling;
73 struct list_head children;
74
Tejun Heo15a4c832014-05-04 15:09:14 -040075 /*
Tejun Heo5c9d5352014-05-16 13:22:48 -040076 * PI: Subsys-unique ID. 0 is unused and root is always 1. The
Tejun Heo15a4c832014-05-04 15:09:14 -040077 * matching css can be looked up using css_from_id().
78 */
79 int id;
80
Tejun Heo69dfa002014-05-04 15:09:13 -040081 unsigned int flags;
Tejun Heo48ddbe12012-04-01 12:09:56 -070082
Tejun Heo0cb51d72014-05-16 13:22:49 -040083 /*
84 * Monotonically increasing unique serial number which defines a
85 * uniform order among all csses. It's guaranteed that all
86 * ->children lists are in the ascending order of ->serial_nr and
87 * used to allow interrupting and resuming iterations.
88 */
89 u64 serial_nr;
90
Tejun Heo0c21ead2013-08-13 20:22:51 -040091 /* percpu_ref killing and RCU release */
92 struct rcu_head rcu_head;
Tejun Heo35ef10d2013-08-13 11:01:54 -040093 struct work_struct destroy_work;
Paul Menageddbcc7e2007-10-18 23:39:30 -070094};
95
96/* bits in struct cgroup_subsys_state flags field */
97enum {
Tejun Heo3b514d22014-05-16 13:22:47 -040098 CSS_NO_REF = (1 << 0), /* no reference counting for this css */
Tejun Heo92fb9742012-11-19 08:13:38 -080099 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
Tejun Heode3f0342014-05-16 13:22:49 -0400100 CSS_RELEASED = (1 << 2), /* refcnt reached zero, released */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700101};
102
Tejun Heo5de01072013-06-12 21:04:52 -0700103/**
104 * css_get - obtain a reference on the specified css
105 * @css: target css
106 *
107 * The caller must already have a reference.
Paul Menageddbcc7e2007-10-18 23:39:30 -0700108 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700109static inline void css_get(struct cgroup_subsys_state *css)
110{
Tejun Heo3b514d22014-05-16 13:22:47 -0400111 if (!(css->flags & CSS_NO_REF))
112 percpu_ref_get(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700113}
Paul Menagee7c5ec92009-01-07 18:08:38 -0800114
Tejun Heo5de01072013-06-12 21:04:52 -0700115/**
Tejun Heo6f4524d2014-05-16 13:22:52 -0400116 * css_tryget - try to obtain a reference on the specified css
117 * @css: target css
118 *
119 * Obtain a reference on @css unless it already has reached zero and is
120 * being released. This function doesn't care whether @css is on or
121 * offline. The caller naturally needs to ensure that @css is accessible
122 * but doesn't have to be holding a reference on it - IOW, RCU protected
123 * access is good enough for this function. Returns %true if a reference
124 * count was successfully obtained; %false otherwise.
125 */
126static inline bool css_tryget(struct cgroup_subsys_state *css)
127{
128 if (!(css->flags & CSS_NO_REF))
129 return percpu_ref_tryget(&css->refcnt);
130 return true;
131}
132
133/**
Tejun Heoec903c02014-05-13 12:11:01 -0400134 * css_tryget_online - try to obtain a reference on the specified css if online
Tejun Heo5de01072013-06-12 21:04:52 -0700135 * @css: target css
136 *
Tejun Heoec903c02014-05-13 12:11:01 -0400137 * Obtain a reference on @css if it's online. The caller naturally needs
138 * to ensure that @css is accessible but doesn't have to be holding a
Tejun Heo5de01072013-06-12 21:04:52 -0700139 * reference on it - IOW, RCU protected access is good enough for this
140 * function. Returns %true if a reference count was successfully obtained;
141 * %false otherwise.
142 */
Tejun Heoec903c02014-05-13 12:11:01 -0400143static inline bool css_tryget_online(struct cgroup_subsys_state *css)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800144{
Tejun Heo3b514d22014-05-16 13:22:47 -0400145 if (!(css->flags & CSS_NO_REF))
146 return percpu_ref_tryget_live(&css->refcnt);
147 return true;
Paul Menagee7c5ec92009-01-07 18:08:38 -0800148}
149
Tejun Heo5de01072013-06-12 21:04:52 -0700150/**
151 * css_put - put a css reference
152 * @css: target css
153 *
Tejun Heoec903c02014-05-13 12:11:01 -0400154 * Put a reference obtained via css_get() and css_tryget_online().
Tejun Heo5de01072013-06-12 21:04:52 -0700155 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700156static inline void css_put(struct cgroup_subsys_state *css)
157{
Tejun Heo3b514d22014-05-16 13:22:47 -0400158 if (!(css->flags & CSS_NO_REF))
159 percpu_ref_put(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700160}
161
Paul Menage3116f0e2008-04-29 01:00:04 -0700162/* bits in struct cgroup flags field */
163enum {
Paul Menaged20a3902009-04-02 16:57:22 -0700164 /*
165 * Control Group has previously had a child cgroup or a task,
166 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
167 */
Paul Menage3116f0e2008-04-29 01:00:04 -0700168 CGRP_RELEASABLE,
169 /* Control Group requires release notifications to userspace */
170 CGRP_NOTIFY_ON_RELEASE,
KAMEZAWA Hiroyukiec64f512009-04-02 16:57:26 -0700171 /*
Tejun Heo2260e7f2012-11-19 08:13:38 -0800172 * Clone the parent's configuration when creating a new child
173 * cpuset cgroup. For historical reasons, this option can be
174 * specified at mount time and thus is implemented here.
Daniel Lezcano97978e62010-10-27 15:33:35 -0700175 */
Tejun Heo2260e7f2012-11-19 08:13:38 -0800176 CGRP_CPUSET_CLONE_CHILDREN,
Paul Menage3116f0e2008-04-29 01:00:04 -0700177};
178
Paul Menageddbcc7e2007-10-18 23:39:30 -0700179struct cgroup {
Tejun Heo9d800df2014-05-14 09:15:00 -0400180 /* self css with NULL ->ss, points back to this cgroup */
181 struct cgroup_subsys_state self;
182
Paul Menageddbcc7e2007-10-18 23:39:30 -0700183 unsigned long flags; /* "unsigned long" so bitops work */
184
Li Zefanb414dc02013-07-31 09:51:06 +0800185 /*
186 * idr allocated in-hierarchy ID.
187 *
Tejun Heo7d699dd2014-05-04 15:09:13 -0400188 * ID 0 is not used, the ID of the root cgroup is always 1, and a
189 * new cgroup will be assigned with a smallest available ID.
Li Zefan0ab02ca2014-02-11 16:05:46 +0800190 *
191 * Allocating/Removing ID must be protected by cgroup_mutex.
Li Zefanb414dc02013-07-31 09:51:06 +0800192 */
193 int id;
Tejun Heo0a950f62012-11-19 09:02:12 -0800194
Tejun Heo842b5972014-04-25 18:28:02 -0400195 /*
196 * If this cgroup contains any tasks, it contributes one to
197 * populated_cnt. All children with non-zero popuplated_cnt of
198 * their own contribute one. The count is zero iff there's no task
199 * in this cgroup or its subtree.
200 */
201 int populated_cnt;
202
Tejun Heo2bd59d42014-02-11 11:52:49 -0500203 struct kernfs_node *kn; /* cgroup kernfs entry */
Tejun Heo842b5972014-04-25 18:28:02 -0400204 struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700205
Tejun Heo667c2492014-07-08 18:02:56 -0400206 /*
207 * The bitmask of subsystems enabled on the child cgroups.
208 * ->subtree_control is the one configured through
209 * "cgroup.subtree_control" while ->child_subsys_mask is the
210 * effective one which may have more subsystems enabled.
Tejun Heof63070d2014-07-08 18:02:57 -0400211 * Controller knobs are made available iff it's enabled in
212 * ->subtree_control.
Tejun Heo667c2492014-07-08 18:02:56 -0400213 */
214 unsigned int subtree_control;
Tejun Heo69dfa002014-05-04 15:09:13 -0400215 unsigned int child_subsys_mask;
Tejun Heo94419622014-03-19 10:23:54 -0400216
Paul Menageddbcc7e2007-10-18 23:39:30 -0700217 /* Private pointers for each registered subsystem */
Tejun Heo73e80ed2013-08-13 11:01:55 -0400218 struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
Paul Menageddbcc7e2007-10-18 23:39:30 -0700219
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400220 struct cgroup_root *root;
Paul Menage817929e2007-10-18 23:39:36 -0700221
222 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700223 * List of cgrp_cset_links pointing at css_sets with tasks in this
224 * cgroup. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700225 */
Tejun Heo69d02062013-06-12 21:04:50 -0700226 struct list_head cset_links;
Paul Menage81a6a5c2007-10-18 23:39:38 -0700227
228 /*
Tejun Heo2d8f2432014-04-23 11:13:15 -0400229 * On the default hierarchy, a css_set for a cgroup with some
230 * susbsys disabled will point to css's which are associated with
231 * the closest ancestor which has the subsys enabled. The
232 * following lists all css_sets which point to this cgroup's css
233 * for the given subsystem.
234 */
235 struct list_head e_csets[CGROUP_SUBSYS_COUNT];
236
237 /*
Paul Menage81a6a5c2007-10-18 23:39:38 -0700238 * Linked list running through all cgroups that can
239 * potentially be reaped by the release agent. Protected by
240 * release_list_lock
241 */
242 struct list_head release_list;
Paul Menagecc31edc2008-10-18 20:28:04 -0700243
Ben Blum72a8cb32009-09-23 15:56:27 -0700244 /*
245 * list of pidlists, up to two for each namespace (one for procs, one
246 * for tasks); created on demand.
247 */
248 struct list_head pidlists;
249 struct mutex pidlist_mutex;
Paul Menagea47295e2009-01-07 18:07:44 -0800250
Tejun Heof8f22e52014-04-23 11:13:16 -0400251 /* used to wait for offlining of csses */
252 wait_queue_head_t offline_waitq;
Paul Menage817929e2007-10-18 23:39:36 -0700253};
254
Tejun Heo25a7e682013-04-14 20:15:25 -0700255#define MAX_CGROUP_ROOT_NAMELEN 64
256
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400257/* cgroup_root->flags */
Tejun Heo25a7e682013-04-14 20:15:25 -0700258enum {
Tejun Heoaa6ec292014-07-09 10:08:08 -0400259 CGRP_ROOT_SANE_BEHAVIOR = (1 << 0), /* __DEVEL__sane_behavior specified */
Tejun Heo25a7e682013-04-14 20:15:25 -0700260 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
261 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
262};
263
264/*
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400265 * A cgroup_root represents the root of a cgroup hierarchy, and may be
Tejun Heo2bd59d42014-02-11 11:52:49 -0500266 * associated with a kernfs_root to form an active hierarchy. This is
Tejun Heo25a7e682013-04-14 20:15:25 -0700267 * internal to cgroup core. Don't access directly from controllers.
268 */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400269struct cgroup_root {
Tejun Heo2bd59d42014-02-11 11:52:49 -0500270 struct kernfs_root *kf_root;
Tejun Heo25a7e682013-04-14 20:15:25 -0700271
Tejun Heof392e512014-04-23 11:13:14 -0400272 /* The bitmask of subsystems attached to this hierarchy */
Tejun Heo69dfa002014-05-04 15:09:13 -0400273 unsigned int subsys_mask;
Tejun Heof392e512014-04-23 11:13:14 -0400274
Tejun Heo25a7e682013-04-14 20:15:25 -0700275 /* Unique id for this hierarchy. */
276 int hierarchy_id;
277
Tejun Heo776f02f2014-02-12 09:29:50 -0500278 /* The root cgroup. Root is destroyed on its release. */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400279 struct cgroup cgrp;
Tejun Heo25a7e682013-04-14 20:15:25 -0700280
Tejun Heo3c9c8252014-02-12 09:29:50 -0500281 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
282 atomic_t nr_cgrps;
Tejun Heo25a7e682013-04-14 20:15:25 -0700283
284 /* A list running through the active hierarchies */
285 struct list_head root_list;
286
Tejun Heo25a7e682013-04-14 20:15:25 -0700287 /* Hierarchy-specific flags */
Tejun Heo69dfa002014-05-04 15:09:13 -0400288 unsigned int flags;
Tejun Heo25a7e682013-04-14 20:15:25 -0700289
290 /* IDs for cgroups in this hierarchy */
Li Zefan4e96ee8e2013-07-31 09:50:50 +0800291 struct idr cgroup_idr;
Tejun Heo25a7e682013-04-14 20:15:25 -0700292
293 /* The path to use for release notifications. */
294 char release_agent_path[PATH_MAX];
295
296 /* The name for this hierarchy - may be empty */
297 char name[MAX_CGROUP_ROOT_NAMELEN];
298};
299
Paul Menaged20a3902009-04-02 16:57:22 -0700300/*
301 * A css_set is a structure holding pointers to a set of
Paul Menage817929e2007-10-18 23:39:36 -0700302 * cgroup_subsys_state objects. This saves space in the task struct
303 * object and speeds up fork()/exit(), since a single inc/dec and a
Paul Menaged20a3902009-04-02 16:57:22 -0700304 * list_add()/del() can bump the reference count on the entire cgroup
305 * set for a task.
Paul Menage817929e2007-10-18 23:39:36 -0700306 */
307
308struct css_set {
309
310 /* Reference count */
Lai Jiangshan146aa1b2008-10-18 20:28:03 -0700311 atomic_t refcount;
Paul Menage817929e2007-10-18 23:39:36 -0700312
313 /*
Li Zefan472b1052008-04-29 01:00:11 -0700314 * List running through all cgroup groups in the same hash
315 * slot. Protected by css_set_lock
316 */
317 struct hlist_node hlist;
318
319 /*
Tejun Heoc7561122014-02-25 10:04:01 -0500320 * Lists running through all tasks using this cgroup group.
321 * mg_tasks lists tasks which belong to this cset but are in the
322 * process of being migrated out or in. Protected by
323 * css_set_rwsem, but, during migration, once tasks are moved to
324 * mg_tasks, it can be read safely while holding cgroup_mutex.
Paul Menage817929e2007-10-18 23:39:36 -0700325 */
326 struct list_head tasks;
Tejun Heoc7561122014-02-25 10:04:01 -0500327 struct list_head mg_tasks;
Paul Menage817929e2007-10-18 23:39:36 -0700328
329 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700330 * List of cgrp_cset_links pointing at cgroups referenced from this
331 * css_set. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700332 */
Tejun Heo69d02062013-06-12 21:04:50 -0700333 struct list_head cgrp_links;
Paul Menage817929e2007-10-18 23:39:36 -0700334
Tejun Heo6803c002014-04-23 11:13:16 -0400335 /* the default cgroup associated with this css_set */
336 struct cgroup *dfl_cgrp;
337
Paul Menage817929e2007-10-18 23:39:36 -0700338 /*
Tejun Heo3ed80a62014-02-08 10:36:58 -0500339 * Set of subsystem states, one for each subsystem. This array is
340 * immutable after creation apart from the init_css_set during
341 * subsystem registration (at boot time).
Paul Menage817929e2007-10-18 23:39:36 -0700342 */
343 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
Ben Blumc3783692009-09-23 15:56:29 -0700344
Tejun Heob3dc0942014-02-25 10:04:01 -0500345 /*
346 * List of csets participating in the on-going migration either as
347 * source or destination. Protected by cgroup_mutex.
348 */
Tejun Heo1958d2d2014-02-25 10:04:03 -0500349 struct list_head mg_preload_node;
Tejun Heob3dc0942014-02-25 10:04:01 -0500350 struct list_head mg_node;
351
352 /*
353 * If this cset is acting as the source of migration the following
354 * two fields are set. mg_src_cgrp is the source cgroup of the
355 * on-going migration and mg_dst_cset is the destination cset the
356 * target tasks on this cset should be migrated to. Protected by
357 * cgroup_mutex.
358 */
359 struct cgroup *mg_src_cgrp;
360 struct css_set *mg_dst_cset;
361
Tejun Heo2d8f2432014-04-23 11:13:15 -0400362 /*
363 * On the default hierarhcy, ->subsys[ssid] may point to a css
364 * attached to an ancestor instead of the cgroup this css_set is
365 * associated with. The following node is anchored at
366 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
367 * iterate through all css's attached to a given cgroup.
368 */
369 struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
370
Ben Blumc3783692009-09-23 15:56:29 -0700371 /* For RCU-protected deletion */
372 struct rcu_head rcu_head;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700373};
374
Paul Menage91796562008-04-29 01:00:01 -0700375/*
Paul Menaged20a3902009-04-02 16:57:22 -0700376 * struct cftype: handler definitions for cgroup control files
Paul Menageddbcc7e2007-10-18 23:39:30 -0700377 *
378 * When reading/writing to a file:
Li Zefana043e3b2008-02-23 15:24:09 -0800379 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
Paul Menageddbcc7e2007-10-18 23:39:30 -0700380 * - the 'cftype' of the file is file->f_dentry->d_fsdata
381 */
382
Tejun Heo8e3f6542012-04-01 12:09:55 -0700383/* cftype->flags */
Tejun Heo02c402d2013-06-24 15:21:47 -0700384enum {
Li Zefan6f4b7e62013-07-31 16:18:36 +0800385 CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
386 CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
Tejun Heo9fa4db32013-08-26 18:40:56 -0400387 CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
Tejun Heo05ebb6e2014-07-15 11:05:10 -0400388
389 /* internal flags, do not use outside cgroup core proper */
390 __CFTYPE_ONLY_ON_DFL = (1 << 16), /* only on default hierarchy */
391 __CFTYPE_NOT_ON_DFL = (1 << 17), /* not on default hierarchy */
Tejun Heo02c402d2013-06-24 15:21:47 -0700392};
Tejun Heo8e3f6542012-04-01 12:09:55 -0700393
394#define MAX_CFTYPE_NAME 64
395
Paul Menageddbcc7e2007-10-18 23:39:30 -0700396struct cftype {
Paul Menaged20a3902009-04-02 16:57:22 -0700397 /*
398 * By convention, the name should begin with the name of the
Tejun Heo8e3f6542012-04-01 12:09:55 -0700399 * subsystem, followed by a period. Zero length string indicates
400 * end of cftype array.
Paul Menaged20a3902009-04-02 16:57:22 -0700401 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700402 char name[MAX_CFTYPE_NAME];
403 int private;
Li Zefan099fca32009-04-02 16:57:29 -0700404 /*
405 * If not 0, file mode is set to this value, otherwise it will
406 * be figured out automatically
407 */
Al Viroa5e7ed32011-07-26 01:55:55 -0400408 umode_t mode;
Paul Menagedb3b1492008-07-25 01:46:58 -0700409
410 /*
Tejun Heo5f469902014-02-11 11:52:48 -0500411 * The maximum length of string, excluding trailing nul, that can
Tejun Heo451af502014-05-13 12:16:21 -0400412 * be passed to write. If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
Paul Menagedb3b1492008-07-25 01:46:58 -0700413 */
414 size_t max_write_len;
415
Tejun Heo8e3f6542012-04-01 12:09:55 -0700416 /* CFTYPE_* flags */
417 unsigned int flags;
418
Tejun Heo2bb566c2013-08-08 20:11:23 -0400419 /*
Tejun Heo0adb0702014-02-12 09:29:48 -0500420 * Fields used for internal bookkeeping. Initialized automatically
421 * during registration.
Tejun Heo2bb566c2013-08-08 20:11:23 -0400422 */
Tejun Heo0adb0702014-02-12 09:29:48 -0500423 struct cgroup_subsys *ss; /* NULL for cgroup core files */
424 struct list_head node; /* anchored at ss->cfts */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500425 struct kernfs_ops *kf_ops;
426
Paul Menageddbcc7e2007-10-18 23:39:30 -0700427 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700428 * read_u64() is a shortcut for the common case of returning a
Paul Menageddbcc7e2007-10-18 23:39:30 -0700429 * single integer. Use it in place of read()
430 */
Tejun Heo182446d2013-08-08 20:11:24 -0400431 u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
Paul Menage91796562008-04-29 01:00:01 -0700432 /*
Paul Menagee73d2c62008-04-29 01:00:06 -0700433 * read_s64() is a signed version of read_u64()
434 */
Tejun Heo182446d2013-08-08 20:11:24 -0400435 s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
Tejun Heo2da8ca82013-12-05 12:28:04 -0500436
437 /* generic seq_file read interface */
438 int (*seq_show)(struct seq_file *sf, void *v);
Paul Menage91796562008-04-29 01:00:01 -0700439
Tejun Heo6612f052013-12-05 12:28:04 -0500440 /* optional ops, implement all or none */
441 void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
442 void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
443 void (*seq_stop)(struct seq_file *sf, void *v);
444
Paul Menage355e0c42007-10-18 23:39:33 -0700445 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700446 * write_u64() is a shortcut for the common case of accepting
Paul Menage355e0c42007-10-18 23:39:33 -0700447 * a single integer (as parsed by simple_strtoull) from
448 * userspace. Use in place of write(); return 0 or error.
449 */
Tejun Heo182446d2013-08-08 20:11:24 -0400450 int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
451 u64 val);
Paul Menagee73d2c62008-04-29 01:00:06 -0700452 /*
453 * write_s64() is a signed version of write_u64()
454 */
Tejun Heo182446d2013-08-08 20:11:24 -0400455 int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
456 s64 val);
Paul Menage355e0c42007-10-18 23:39:33 -0700457
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700458 /*
Tejun Heob4168642014-05-13 12:16:21 -0400459 * write() is the generic write callback which maps directly to
460 * kernfs write operation and overrides all other operations.
461 * Maximum write size is determined by ->max_write_len. Use
462 * of_css/cft() to access the associated css and cft.
463 */
464 ssize_t (*write)(struct kernfs_open_file *of,
465 char *buf, size_t nbytes, loff_t off);
466
Tejun Heo2bd59d42014-02-11 11:52:49 -0500467#ifdef CONFIG_DEBUG_LOCK_ALLOC
468 struct lock_class_key lockdep_key;
469#endif
Paul Menageddbcc7e2007-10-18 23:39:30 -0700470};
471
Tejun Heoa2dd4242014-03-19 10:23:55 -0400472extern struct cgroup_root cgrp_dfl_root;
Tejun Heo5024ae22014-05-07 21:31:17 -0400473extern struct css_set init_css_set;
Tejun Heoa2dd4242014-03-19 10:23:55 -0400474
Tejun Heoaa6ec292014-07-09 10:08:08 -0400475/**
476 * cgroup_on_dfl - test whether a cgroup is on the default hierarchy
477 * @cgrp: the cgroup of interest
478 *
479 * The default hierarchy is the v2 interface of cgroup and this function
480 * can be used to test whether a cgroup is on the default hierarchy for
481 * cases where a subsystem should behave differnetly depending on the
482 * interface version.
483 *
484 * The set of behaviors which change on the default hierarchy are still
485 * being determined and the mount option is prefixed with __DEVEL__.
486 *
487 * List of changed behaviors:
488 *
489 * - Mount options "noprefix", "xattr", "clone_children", "release_agent"
490 * and "name" are disallowed.
491 *
492 * - When mounting an existing superblock, mount options should match.
493 *
494 * - Remount is disallowed.
495 *
496 * - rename(2) is disallowed.
497 *
498 * - "tasks" is removed. Everything should be at process granularity. Use
499 * "cgroup.procs" instead.
500 *
501 * - "cgroup.procs" is not sorted. pids will be unique unless they got
502 * recycled inbetween reads.
503 *
504 * - "release_agent" and "notify_on_release" are removed. Replacement
505 * notification mechanism will be implemented.
506 *
507 * - "cgroup.clone_children" is removed.
508 *
509 * - "cgroup.subtree_populated" is available. Its value is 0 if the cgroup
510 * and its descendants contain no task; otherwise, 1. The file also
511 * generates kernfs notification which can be monitored through poll and
512 * [di]notify when the value of the file changes.
513 *
514 * - cpuset: tasks will be kept in empty cpusets when hotplug happens and
515 * take masks of ancestors with non-empty cpus/mems, instead of being
516 * moved to an ancestor.
517 *
518 * - cpuset: a task can be moved into an empty cpuset, and again it takes
519 * masks of ancestors.
520 *
521 * - memcg: use_hierarchy is on by default and the cgroup file for the flag
522 * is not created.
523 *
524 * - blkcg: blk-throttle becomes properly hierarchical.
525 *
526 * - debug: disallowed on the default hierarchy.
527 */
Tejun Heoa2dd4242014-03-19 10:23:55 -0400528static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
529{
530 return cgrp->root == &cgrp_dfl_root;
531}
532
Tejun Heo07bc3562014-02-13 06:58:39 -0500533/* no synchronization, the result can only be used as a hint */
534static inline bool cgroup_has_tasks(struct cgroup *cgrp)
535{
536 return !list_empty(&cgrp->cset_links);
537}
538
Tejun Heob1664922014-02-11 11:52:49 -0500539/* returns ino associated with a cgroup, 0 indicates unmounted root */
540static inline ino_t cgroup_ino(struct cgroup *cgrp)
541{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500542 if (cgrp->kn)
543 return cgrp->kn->ino;
Tejun Heob1664922014-02-11 11:52:49 -0500544 else
545 return 0;
546}
547
Tejun Heob4168642014-05-13 12:16:21 -0400548/* cft/css accessors for cftype->write() operation */
549static inline struct cftype *of_cft(struct kernfs_open_file *of)
Tejun Heo7da11272013-12-05 12:28:04 -0500550{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500551 return of->kn->priv;
Tejun Heo7da11272013-12-05 12:28:04 -0500552}
553
Tejun Heob4168642014-05-13 12:16:21 -0400554struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
555
556/* cft/css accessors for cftype->seq_*() operations */
557static inline struct cftype *seq_cft(struct seq_file *seq)
558{
559 return of_cft(seq->private);
560}
561
562static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
563{
564 return of_css(seq->private);
565}
Tejun Heo59f52962014-02-11 11:52:49 -0500566
Tejun Heoe61734c2014-02-12 09:29:50 -0500567/*
568 * Name / path handling functions. All are thin wrappers around the kernfs
569 * counterparts and can be called under any context.
570 */
571
572static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
573{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400574 return kernfs_name(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500575}
576
577static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
578 size_t buflen)
579{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400580 return kernfs_path(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500581}
582
583static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
584{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400585 pr_cont_kernfs_name(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500586}
587
588static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
589{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400590 pr_cont_kernfs_path(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500591}
592
593char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
594
Tejun Heoa8ddc822014-07-15 11:05:10 -0400595int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo2cf669a2014-07-15 11:05:09 -0400596int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo2bb566c2013-08-08 20:11:23 -0400597int cgroup_rm_cftypes(struct cftype *cfts);
Tejun Heo8e3f6542012-04-01 12:09:55 -0700598
Li Zefan78574cf2013-04-08 19:00:38 -0700599bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700600
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100601/*
Tejun Heo2f7ee562011-12-12 18:12:21 -0800602 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
603 * methods.
604 */
605struct cgroup_taskset;
606struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
607struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
Tejun Heo2f7ee562011-12-12 18:12:21 -0800608
609/**
610 * cgroup_taskset_for_each - iterate cgroup_taskset
611 * @task: the loop cursor
Tejun Heo2f7ee562011-12-12 18:12:21 -0800612 * @tset: taskset to iterate
613 */
Tejun Heo924f0d92014-02-13 06:58:41 -0500614#define cgroup_taskset_for_each(task, tset) \
Tejun Heo2f7ee562011-12-12 18:12:21 -0800615 for ((task) = cgroup_taskset_first((tset)); (task); \
Tejun Heo924f0d92014-02-13 06:58:41 -0500616 (task) = cgroup_taskset_next((tset)))
Tejun Heo2f7ee562011-12-12 18:12:21 -0800617
618/*
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100619 * Control Group subsystem type.
620 * See Documentation/cgroups/cgroups.txt for details
621 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700622
623struct cgroup_subsys {
Tejun Heoeb954192013-08-08 20:11:23 -0400624 struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
625 int (*css_online)(struct cgroup_subsys_state *css);
626 void (*css_offline)(struct cgroup_subsys_state *css);
627 void (*css_free)(struct cgroup_subsys_state *css);
Tejun Heob4536f0ca2014-07-08 18:02:57 -0400628 void (*css_reset)(struct cgroup_subsys_state *css);
Tejun Heo92fb9742012-11-19 08:13:38 -0800629
Tejun Heoeb954192013-08-08 20:11:23 -0400630 int (*can_attach)(struct cgroup_subsys_state *css,
631 struct cgroup_taskset *tset);
632 void (*cancel_attach)(struct cgroup_subsys_state *css,
633 struct cgroup_taskset *tset);
634 void (*attach)(struct cgroup_subsys_state *css,
635 struct cgroup_taskset *tset);
Li Zefan761b3ef2012-01-31 13:47:36 +0800636 void (*fork)(struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400637 void (*exit)(struct cgroup_subsys_state *css,
638 struct cgroup_subsys_state *old_css,
Li Zefan761b3ef2012-01-31 13:47:36 +0800639 struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400640 void (*bind)(struct cgroup_subsys_state *root_css);
Hugh Dickinse5991372009-01-06 14:39:22 -0800641
Paul Menage8bab8dd2008-04-04 14:29:57 -0700642 int disabled;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700643 int early_init;
Tejun Heo48ddbe12012-04-01 12:09:56 -0700644
645 /*
Tejun Heo8c7f6ed2012-09-13 12:20:58 -0700646 * If %false, this subsystem is properly hierarchical -
647 * configuration, resource accounting and restriction on a parent
648 * cgroup cover those of its children. If %true, hierarchy support
649 * is broken in some ways - some subsystems ignore hierarchy
650 * completely while others are only implemented half-way.
651 *
652 * It's now disallowed to create nested cgroups if the subsystem is
653 * broken and cgroup core will emit a warning message on such
654 * cases. Eventually, all subsystems will be made properly
655 * hierarchical and this will go away.
656 */
657 bool broken_hierarchy;
658 bool warned_broken_hierarchy;
659
Tejun Heo073219e2014-02-08 10:36:58 -0500660 /* the following two fields are initialized automtically during boot */
Tejun Heoaec25022014-02-08 10:36:58 -0500661 int id;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700662#define MAX_CGROUP_TYPE_NAMELEN 32
663 const char *name;
664
Tejun Heob85d2042013-12-06 15:11:57 -0500665 /* link to parent, protected by cgroup_lock() */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400666 struct cgroup_root *root;
Ben Blume6a11052010-03-10 15:22:09 -0800667
Tejun Heo15a4c832014-05-04 15:09:14 -0400668 /* idr for css->id */
669 struct idr css_idr;
670
Tejun Heo0adb0702014-02-12 09:29:48 -0500671 /*
672 * List of cftypes. Each entry is the first entry of an array
673 * terminated by zero length name.
674 */
675 struct list_head cfts;
Tejun Heo8e3f6542012-04-01 12:09:55 -0700676
Tejun Heoa8ddc822014-07-15 11:05:10 -0400677 /*
678 * Base cftypes which are automatically registered. The two can
679 * point to the same array.
680 */
681 struct cftype *dfl_cftypes; /* for the default hierarchy */
682 struct cftype *legacy_cftypes; /* for the legacy hierarchies */
Tejun Heoaf0ba672014-07-08 18:02:57 -0400683
684 /*
685 * A subsystem may depend on other subsystems. When such subsystem
686 * is enabled on a cgroup, the depended-upon subsystems are enabled
687 * together if available. Subsystems enabled due to dependency are
688 * not visible to userland until explicitly enabled. The following
689 * specifies the mask of subsystems that this one depends on.
690 */
691 unsigned int depends_on;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700692};
693
Tejun Heo073219e2014-02-08 10:36:58 -0500694#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700695#include <linux/cgroup_subsys.h>
696#undef SUBSYS
697
Tejun Heo8af01f52013-08-08 20:11:22 -0400698/**
Tejun Heo14611e52013-06-25 11:48:32 -0700699 * task_css_set_check - obtain a task's css_set with extra access conditions
700 * @task: the task to obtain css_set for
701 * @__c: extra condition expression to be passed to rcu_dereference_check()
702 *
703 * A task's css_set is RCU protected, initialized and exited while holding
704 * task_lock(), and can only be modified while holding both cgroup_mutex
705 * and task_lock() while the task is alive. This macro verifies that the
706 * caller is inside proper critical section and returns @task's css_set.
707 *
708 * The caller can also specify additional allowed conditions via @__c, such
709 * as locks used during the cgroup_subsys::attach() methods.
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200710 */
Tejun Heo22194492013-04-07 09:29:51 -0700711#ifdef CONFIG_PROVE_RCU
712extern struct mutex cgroup_mutex;
Tejun Heo0e1d7682014-02-25 10:04:03 -0500713extern struct rw_semaphore css_set_rwsem;
Tejun Heo14611e52013-06-25 11:48:32 -0700714#define task_css_set_check(task, __c) \
715 rcu_dereference_check((task)->cgroups, \
Tejun Heo0e1d7682014-02-25 10:04:03 -0500716 lockdep_is_held(&cgroup_mutex) || \
717 lockdep_is_held(&css_set_rwsem) || \
718 ((task)->flags & PF_EXITING) || (__c))
Tejun Heo22194492013-04-07 09:29:51 -0700719#else
Tejun Heo14611e52013-06-25 11:48:32 -0700720#define task_css_set_check(task, __c) \
721 rcu_dereference((task)->cgroups)
Tejun Heo22194492013-04-07 09:29:51 -0700722#endif
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200723
Tejun Heo14611e52013-06-25 11:48:32 -0700724/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400725 * task_css_check - obtain css for (task, subsys) w/ extra access conds
Tejun Heo14611e52013-06-25 11:48:32 -0700726 * @task: the target task
727 * @subsys_id: the target subsystem ID
728 * @__c: extra condition expression to be passed to rcu_dereference_check()
729 *
730 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
731 * synchronization rules are the same as task_css_set_check().
732 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400733#define task_css_check(task, subsys_id, __c) \
Tejun Heo14611e52013-06-25 11:48:32 -0700734 task_css_set_check((task), (__c))->subsys[(subsys_id)]
735
736/**
737 * task_css_set - obtain a task's css_set
738 * @task: the task to obtain css_set for
739 *
740 * See task_css_set_check().
741 */
742static inline struct css_set *task_css_set(struct task_struct *task)
743{
744 return task_css_set_check(task, false);
745}
746
747/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400748 * task_css - obtain css for (task, subsys)
Tejun Heo14611e52013-06-25 11:48:32 -0700749 * @task: the target task
750 * @subsys_id: the target subsystem ID
751 *
Tejun Heo8af01f52013-08-08 20:11:22 -0400752 * See task_css_check().
Tejun Heo14611e52013-06-25 11:48:32 -0700753 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400754static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
755 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700756{
Tejun Heo8af01f52013-08-08 20:11:22 -0400757 return task_css_check(task, subsys_id, false);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700758}
759
Tejun Heo5024ae22014-05-07 21:31:17 -0400760/**
761 * task_css_is_root - test whether a task belongs to the root css
762 * @task: the target task
763 * @subsys_id: the target subsystem ID
764 *
765 * Test whether @task belongs to the root css on the specified subsystem.
766 * May be invoked in any context.
767 */
768static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
769{
770 return task_css_check(task, subsys_id, true) ==
771 init_css_set.subsys[subsys_id];
772}
773
Tejun Heo8af01f52013-08-08 20:11:22 -0400774static inline struct cgroup *task_cgroup(struct task_struct *task,
775 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700776{
Tejun Heo8af01f52013-08-08 20:11:22 -0400777 return task_css(task, subsys_id)->cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700778}
779
Tejun Heo492eb212013-08-08 20:11:25 -0400780struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
781 struct cgroup_subsys_state *parent);
Tejun Heo53fa5262013-05-24 10:55:38 +0900782
Li Zefan1cb650b2013-08-19 10:05:24 +0800783struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
784
Tejun Heo574bd9f2012-11-09 09:12:29 -0800785/**
Tejun Heo492eb212013-08-08 20:11:25 -0400786 * css_for_each_child - iterate through children of a css
787 * @pos: the css * to use as the loop cursor
788 * @parent: css whose children to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800789 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400790 * Walk @parent's children. Must be called under rcu_read_lock().
Tejun Heo574bd9f2012-11-09 09:12:29 -0800791 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400792 * If a subsystem synchronizes ->css_online() and the start of iteration, a
793 * css which finished ->css_online() is guaranteed to be visible in the
794 * future iterations and will stay visible until the last reference is put.
795 * A css which hasn't finished ->css_online() or already finished
796 * ->css_offline() may show up during traversal. It's each subsystem's
797 * responsibility to synchronize against on/offlining.
Tejun Heo75501a62013-05-24 10:55:38 +0900798 *
799 * It is allowed to temporarily drop RCU read lock during iteration. The
800 * caller is responsible for ensuring that @pos remains accessible until
801 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800802 */
Tejun Heo492eb212013-08-08 20:11:25 -0400803#define css_for_each_child(pos, parent) \
804 for ((pos) = css_next_child(NULL, (parent)); (pos); \
805 (pos) = css_next_child((pos), (parent)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800806
Tejun Heo492eb212013-08-08 20:11:25 -0400807struct cgroup_subsys_state *
808css_next_descendant_pre(struct cgroup_subsys_state *pos,
809 struct cgroup_subsys_state *css);
810
811struct cgroup_subsys_state *
812css_rightmost_descendant(struct cgroup_subsys_state *pos);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800813
814/**
Tejun Heo492eb212013-08-08 20:11:25 -0400815 * css_for_each_descendant_pre - pre-order walk of a css's descendants
816 * @pos: the css * to use as the loop cursor
817 * @root: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800818 *
Tejun Heobd8815a2013-08-08 20:11:27 -0400819 * Walk @root's descendants. @root is included in the iteration and the
Tejun Heoc2931b72014-05-16 13:22:51 -0400820 * first node to be visited. Must be called under rcu_read_lock().
Tejun Heo574bd9f2012-11-09 09:12:29 -0800821 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400822 * If a subsystem synchronizes ->css_online() and the start of iteration, a
823 * css which finished ->css_online() is guaranteed to be visible in the
824 * future iterations and will stay visible until the last reference is put.
825 * A css which hasn't finished ->css_online() or already finished
826 * ->css_offline() may show up during traversal. It's each subsystem's
827 * responsibility to synchronize against on/offlining.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800828 *
Tejun Heoc2931b72014-05-16 13:22:51 -0400829 * For example, the following guarantees that a descendant can't escape
Tejun Heo574bd9f2012-11-09 09:12:29 -0800830 * state updates of its ancestors.
831 *
Tejun Heo492eb212013-08-08 20:11:25 -0400832 * my_online(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800833 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400834 * Lock @css's parent and @css;
835 * Inherit state from the parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800836 * Unlock both.
837 * }
838 *
Tejun Heo492eb212013-08-08 20:11:25 -0400839 * my_update_state(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800840 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400841 * css_for_each_descendant_pre(@pos, @css) {
Tejun Heo574bd9f2012-11-09 09:12:29 -0800842 * Lock @pos;
Tejun Heobd8815a2013-08-08 20:11:27 -0400843 * if (@pos == @css)
844 * Update @css's state;
845 * else
846 * Verify @pos is alive and inherit state from its parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800847 * Unlock @pos;
848 * }
849 * }
850 *
851 * As long as the inheriting step, including checking the parent state, is
852 * enclosed inside @pos locking, double-locking the parent isn't necessary
853 * while inheriting. The state update to the parent is guaranteed to be
854 * visible by walking order and, as long as inheriting operations to the
855 * same @pos are atomic to each other, multiple updates racing each other
856 * still result in the correct state. It's guaranateed that at least one
Tejun Heo492eb212013-08-08 20:11:25 -0400857 * inheritance happens for any css after the latest update to its parent.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800858 *
859 * If checking parent's state requires locking the parent, each inheriting
860 * iteration should lock and unlock both @pos->parent and @pos.
861 *
862 * Alternatively, a subsystem may choose to use a single global lock to
Tejun Heo92fb9742012-11-19 08:13:38 -0800863 * synchronize ->css_online() and ->css_offline() against tree-walking
Tejun Heo574bd9f2012-11-09 09:12:29 -0800864 * operations.
Tejun Heo75501a62013-05-24 10:55:38 +0900865 *
866 * It is allowed to temporarily drop RCU read lock during iteration. The
867 * caller is responsible for ensuring that @pos remains accessible until
868 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800869 */
Tejun Heo492eb212013-08-08 20:11:25 -0400870#define css_for_each_descendant_pre(pos, css) \
871 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
872 (pos) = css_next_descendant_pre((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800873
Tejun Heo492eb212013-08-08 20:11:25 -0400874struct cgroup_subsys_state *
875css_next_descendant_post(struct cgroup_subsys_state *pos,
876 struct cgroup_subsys_state *css);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800877
878/**
Tejun Heo492eb212013-08-08 20:11:25 -0400879 * css_for_each_descendant_post - post-order walk of a css's descendants
880 * @pos: the css * to use as the loop cursor
881 * @css: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800882 *
Tejun Heo492eb212013-08-08 20:11:25 -0400883 * Similar to css_for_each_descendant_pre() but performs post-order
Tejun Heobd8815a2013-08-08 20:11:27 -0400884 * traversal instead. @root is included in the iteration and the last
Tejun Heoc2931b72014-05-16 13:22:51 -0400885 * node to be visited.
886 *
887 * If a subsystem synchronizes ->css_online() and the start of iteration, a
888 * css which finished ->css_online() is guaranteed to be visible in the
889 * future iterations and will stay visible until the last reference is put.
890 * A css which hasn't finished ->css_online() or already finished
891 * ->css_offline() may show up during traversal. It's each subsystem's
892 * responsibility to synchronize against on/offlining.
893 *
894 * Note that the walk visibility guarantee example described in pre-order
895 * walk doesn't apply the same to post-order walks.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800896 */
Tejun Heo492eb212013-08-08 20:11:25 -0400897#define css_for_each_descendant_post(pos, css) \
898 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
899 (pos) = css_next_descendant_post((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800900
Tejun Heof3d46502014-05-16 13:22:52 -0400901bool css_has_online_children(struct cgroup_subsys_state *css);
902
Tejun Heo72ec7022013-08-08 20:11:26 -0400903/* A css_task_iter should be treated as an opaque object */
904struct css_task_iter {
Tejun Heo3ebb2b62014-04-23 11:13:15 -0400905 struct cgroup_subsys *ss;
906
Tejun Heo0f0a2b42014-04-23 11:13:15 -0400907 struct list_head *cset_pos;
908 struct list_head *cset_head;
909
910 struct list_head *task_pos;
911 struct list_head *tasks_head;
912 struct list_head *mg_tasks_head;
Paul Menage817929e2007-10-18 23:39:36 -0700913};
914
Tejun Heo72ec7022013-08-08 20:11:26 -0400915void css_task_iter_start(struct cgroup_subsys_state *css,
916 struct css_task_iter *it);
917struct task_struct *css_task_iter_next(struct css_task_iter *it);
918void css_task_iter_end(struct css_task_iter *it);
Tejun Heoe5358372013-08-08 20:11:26 -0400919
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700920int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
Tejun Heo8cc99342013-04-07 09:29:50 -0700921int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700922
Tejun Heoec903c02014-05-13 12:11:01 -0400923struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
924 struct cgroup_subsys *ss);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700925
Paul Menageddbcc7e2007-10-18 23:39:30 -0700926#else /* !CONFIG_CGROUPS */
927
928static inline int cgroup_init_early(void) { return 0; }
929static inline int cgroup_init(void) { return 0; }
Paul Menageb4f48b62007-10-18 23:39:33 -0700930static inline void cgroup_fork(struct task_struct *p) {}
Paul Menage817929e2007-10-18 23:39:36 -0700931static inline void cgroup_post_fork(struct task_struct *p) {}
Li Zefan1ec41832014-03-28 15:22:19 +0800932static inline void cgroup_exit(struct task_struct *p) {}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700933
Balbir Singh846c7bb2007-10-18 23:39:44 -0700934static inline int cgroupstats_build(struct cgroupstats *stats,
935 struct dentry *dentry)
936{
937 return -EINVAL;
938}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700939
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200940/* No cgroups - nothing to do */
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700941static inline int cgroup_attach_task_all(struct task_struct *from,
942 struct task_struct *t)
943{
944 return 0;
945}
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200946
Paul Menageddbcc7e2007-10-18 23:39:30 -0700947#endif /* !CONFIG_CGROUPS */
948
Paul Menageddbcc7e2007-10-18 23:39:30 -0700949#endif /* _LINUX_CGROUP_H */