blob: 164851e388e7280a5d4c3d9072cdc486392a8763 [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
Paul Menageddbcc7e2007-10-18 23:39:30 -070051/* Per-subsystem/per-cgroup state maintained by the system. */
52struct cgroup_subsys_state {
Tejun Heo72c97e52013-08-08 20:11:22 -040053 /* the cgroup that this css is attached to */
Paul Menageddbcc7e2007-10-18 23:39:30 -070054 struct cgroup *cgroup;
55
Tejun Heo72c97e52013-08-08 20:11:22 -040056 /* the cgroup subsystem that this css is attached to */
57 struct cgroup_subsys *ss;
58
Tejun Heod3daf282013-06-13 19:39:16 -070059 /* reference count - access via css_[try]get() and css_put() */
60 struct percpu_ref refcnt;
Paul Menageddbcc7e2007-10-18 23:39:30 -070061
Tejun Heo0ae78e02013-08-13 11:01:54 -040062 /* the parent css */
63 struct cgroup_subsys_state *parent;
64
Tejun Heo15a4c832014-05-04 15:09:14 -040065 /*
66 * Subsys-unique ID. 0 is unused and root is always 1. The
67 * matching css can be looked up using css_from_id().
68 */
69 int id;
70
Tejun Heo69dfa002014-05-04 15:09:13 -040071 unsigned int flags;
Tejun Heo48ddbe12012-04-01 12:09:56 -070072
Tejun Heo0c21ead2013-08-13 20:22:51 -040073 /* percpu_ref killing and RCU release */
74 struct rcu_head rcu_head;
Tejun Heo35ef10d2013-08-13 11:01:54 -040075 struct work_struct destroy_work;
Paul Menageddbcc7e2007-10-18 23:39:30 -070076};
77
78/* bits in struct cgroup_subsys_state flags field */
79enum {
Tejun Heo38b53ab2012-11-19 08:13:36 -080080 CSS_ROOT = (1 << 0), /* this CSS is the root of the subsystem */
Tejun Heo92fb9742012-11-19 08:13:38 -080081 CSS_ONLINE = (1 << 1), /* between ->css_online() and ->css_offline() */
Paul Menageddbcc7e2007-10-18 23:39:30 -070082};
83
Tejun Heo5de01072013-06-12 21:04:52 -070084/**
85 * css_get - obtain a reference on the specified css
86 * @css: target css
87 *
88 * The caller must already have a reference.
Paul Menageddbcc7e2007-10-18 23:39:30 -070089 */
Paul Menageddbcc7e2007-10-18 23:39:30 -070090static inline void css_get(struct cgroup_subsys_state *css)
91{
92 /* We don't need to reference count the root state */
Tejun Heo38b53ab2012-11-19 08:13:36 -080093 if (!(css->flags & CSS_ROOT))
Tejun Heod3daf282013-06-13 19:39:16 -070094 percpu_ref_get(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -070095}
Paul Menagee7c5ec92009-01-07 18:08:38 -080096
Tejun Heo5de01072013-06-12 21:04:52 -070097/**
Tejun Heoec903c02014-05-13 12:11:01 -040098 * css_tryget_online - try to obtain a reference on the specified css if online
Tejun Heo5de01072013-06-12 21:04:52 -070099 * @css: target css
100 *
Tejun Heoec903c02014-05-13 12:11:01 -0400101 * Obtain a reference on @css if it's online. The caller naturally needs
102 * to ensure that @css is accessible but doesn't have to be holding a
Tejun Heo5de01072013-06-12 21:04:52 -0700103 * reference on it - IOW, RCU protected access is good enough for this
104 * function. Returns %true if a reference count was successfully obtained;
105 * %false otherwise.
106 */
Tejun Heoec903c02014-05-13 12:11:01 -0400107static inline bool css_tryget_online(struct cgroup_subsys_state *css)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800108{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800109 if (css->flags & CSS_ROOT)
Paul Menagee7c5ec92009-01-07 18:08:38 -0800110 return true;
Tejun Heo2070d502014-05-09 15:11:53 -0400111 return percpu_ref_tryget_live(&css->refcnt);
Paul Menagee7c5ec92009-01-07 18:08:38 -0800112}
113
Tejun Heo5de01072013-06-12 21:04:52 -0700114/**
115 * css_put - put a css reference
116 * @css: target css
117 *
Tejun Heoec903c02014-05-13 12:11:01 -0400118 * Put a reference obtained via css_get() and css_tryget_online().
Tejun Heo5de01072013-06-12 21:04:52 -0700119 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700120static inline void css_put(struct cgroup_subsys_state *css)
121{
Tejun Heo38b53ab2012-11-19 08:13:36 -0800122 if (!(css->flags & CSS_ROOT))
Tejun Heod3daf282013-06-13 19:39:16 -0700123 percpu_ref_put(&css->refcnt);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700124}
125
Paul Menage3116f0e2008-04-29 01:00:04 -0700126/* bits in struct cgroup flags field */
127enum {
128 /* Control Group is dead */
Tejun Heo54766d42013-06-12 21:04:53 -0700129 CGRP_DEAD,
Paul Menaged20a3902009-04-02 16:57:22 -0700130 /*
131 * Control Group has previously had a child cgroup or a task,
132 * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
133 */
Paul Menage3116f0e2008-04-29 01:00:04 -0700134 CGRP_RELEASABLE,
135 /* Control Group requires release notifications to userspace */
136 CGRP_NOTIFY_ON_RELEASE,
KAMEZAWA Hiroyukiec64f512009-04-02 16:57:26 -0700137 /*
Tejun Heo2260e7f2012-11-19 08:13:38 -0800138 * Clone the parent's configuration when creating a new child
139 * cpuset cgroup. For historical reasons, this option can be
140 * specified at mount time and thus is implemented here.
Daniel Lezcano97978e62010-10-27 15:33:35 -0700141 */
Tejun Heo2260e7f2012-11-19 08:13:38 -0800142 CGRP_CPUSET_CLONE_CHILDREN,
Paul Menage3116f0e2008-04-29 01:00:04 -0700143};
144
Paul Menageddbcc7e2007-10-18 23:39:30 -0700145struct cgroup {
Tejun Heo9d800df2014-05-14 09:15:00 -0400146 /* self css with NULL ->ss, points back to this cgroup */
147 struct cgroup_subsys_state self;
148
Paul Menageddbcc7e2007-10-18 23:39:30 -0700149 unsigned long flags; /* "unsigned long" so bitops work */
150
Li Zefanb414dc02013-07-31 09:51:06 +0800151 /*
152 * idr allocated in-hierarchy ID.
153 *
Tejun Heo7d699dd2014-05-04 15:09:13 -0400154 * ID 0 is not used, the ID of the root cgroup is always 1, and a
155 * new cgroup will be assigned with a smallest available ID.
Li Zefan0ab02ca2014-02-11 16:05:46 +0800156 *
157 * Allocating/Removing ID must be protected by cgroup_mutex.
Li Zefanb414dc02013-07-31 09:51:06 +0800158 */
159 int id;
Tejun Heo0a950f62012-11-19 09:02:12 -0800160
Tejun Heof20104d2013-08-13 20:22:50 -0400161 /* the number of attached css's */
162 int nr_css;
163
Tejun Heo842b5972014-04-25 18:28:02 -0400164 /*
165 * If this cgroup contains any tasks, it contributes one to
166 * populated_cnt. All children with non-zero popuplated_cnt of
167 * their own contribute one. The count is zero iff there's no task
168 * in this cgroup or its subtree.
169 */
170 int populated_cnt;
171
Tejun Heo2bd59d42014-02-11 11:52:49 -0500172 atomic_t refcnt;
173
Paul Menageddbcc7e2007-10-18 23:39:30 -0700174 /*
175 * We link our 'sibling' struct into our parent's 'children'.
176 * Our children link their 'sibling' into our 'children'.
177 */
178 struct list_head sibling; /* my parent's children */
179 struct list_head children; /* my children */
180
Paul Menaged20a3902009-04-02 16:57:22 -0700181 struct cgroup *parent; /* my parent */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500182 struct kernfs_node *kn; /* cgroup kernfs entry */
Tejun Heo842b5972014-04-25 18:28:02 -0400183 struct kernfs_node *populated_kn; /* kn for "cgroup.subtree_populated" */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700184
Li Zefan65dff752013-03-01 15:01:56 +0800185 /*
Tejun Heo53fa5262013-05-24 10:55:38 +0900186 * Monotonically increasing unique serial number which defines a
187 * uniform order among all cgroups. It's guaranteed that all
188 * ->children lists are in the ascending order of ->serial_nr.
189 * It's used to allow interrupting and resuming iterations.
190 */
191 u64 serial_nr;
192
Tejun Heof392e512014-04-23 11:13:14 -0400193 /* the bitmask of subsystems enabled on the child cgroups */
Tejun Heo69dfa002014-05-04 15:09:13 -0400194 unsigned int child_subsys_mask;
Tejun Heo94419622014-03-19 10:23:54 -0400195
Paul Menageddbcc7e2007-10-18 23:39:30 -0700196 /* Private pointers for each registered subsystem */
Tejun Heo73e80ed2013-08-13 11:01:55 -0400197 struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
Paul Menageddbcc7e2007-10-18 23:39:30 -0700198
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400199 struct cgroup_root *root;
Paul Menage817929e2007-10-18 23:39:36 -0700200
201 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700202 * List of cgrp_cset_links pointing at css_sets with tasks in this
203 * cgroup. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700204 */
Tejun Heo69d02062013-06-12 21:04:50 -0700205 struct list_head cset_links;
Paul Menage81a6a5c2007-10-18 23:39:38 -0700206
207 /*
Tejun Heo2d8f2432014-04-23 11:13:15 -0400208 * On the default hierarchy, a css_set for a cgroup with some
209 * susbsys disabled will point to css's which are associated with
210 * the closest ancestor which has the subsys enabled. The
211 * following lists all css_sets which point to this cgroup's css
212 * for the given subsystem.
213 */
214 struct list_head e_csets[CGROUP_SUBSYS_COUNT];
215
216 /*
Paul Menage81a6a5c2007-10-18 23:39:38 -0700217 * 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
Tejun Heod3daf282013-06-13 19:39:16 -0700230 /* For css percpu_ref killing and RCU-protected deletion */
Paul Menagea47295e2009-01-07 18:07:44 -0800231 struct rcu_head rcu_head;
Tejun Heoea15f8c2013-06-13 19:27:42 -0700232 struct work_struct destroy_work;
Tejun Heof8f22e52014-04-23 11:13:16 -0400233
234 /* used to wait for offlining of csses */
235 wait_queue_head_t offline_waitq;
Paul Menage817929e2007-10-18 23:39:36 -0700236};
237
Tejun Heo25a7e682013-04-14 20:15:25 -0700238#define MAX_CGROUP_ROOT_NAMELEN 64
239
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400240/* cgroup_root->flags */
Tejun Heo25a7e682013-04-14 20:15:25 -0700241enum {
Tejun Heo873fe092013-04-14 20:15:26 -0700242 /*
243 * Unfortunately, cgroup core and various controllers are riddled
244 * with idiosyncrasies and pointless options. The following flag,
245 * when set, will force sane behavior - some options are forced on,
246 * others are disallowed, and some controllers will change their
247 * hierarchical or other behaviors.
248 *
249 * The set of behaviors affected by this flag are still being
250 * determined and developed and the mount option for this flag is
251 * prefixed with __DEVEL__. The prefix will be dropped once we
252 * reach the point where all behaviors are compatible with the
253 * planned unified hierarchy, which will automatically turn on this
254 * flag.
255 *
256 * The followings are the behaviors currently affected this flag.
257 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500258 * - Mount options "noprefix", "xattr", "clone_children",
259 * "release_agent" and "name" are disallowed.
Tejun Heo873fe092013-04-14 20:15:26 -0700260 *
261 * - When mounting an existing superblock, mount options should
262 * match.
263 *
264 * - Remount is disallowed.
265 *
Linus Torvalds0b0585c2013-07-02 20:04:25 -0700266 * - rename(2) is disallowed.
267 *
Tejun Heof63674f2013-06-13 19:58:38 -0700268 * - "tasks" is removed. Everything should be at process
269 * granularity. Use "cgroup.procs" instead.
270 *
Tejun Heoafb2bc12013-11-29 10:42:59 -0500271 * - "cgroup.procs" is not sorted. pids will be unique unless they
272 * got recycled inbetween reads.
273 *
Tejun Heof63674f2013-06-13 19:58:38 -0700274 * - "release_agent" and "notify_on_release" are removed.
275 * Replacement notification mechanism will be implemented.
276 *
Tejun Heod3ba07c2014-02-13 06:58:38 -0500277 * - "cgroup.clone_children" is removed.
Tejun Heo86bf4b62014-02-12 09:29:48 -0500278 *
Tejun Heo842b5972014-04-25 18:28:02 -0400279 * - "cgroup.subtree_populated" is available. Its value is 0 if
280 * the cgroup and its descendants contain no task; otherwise, 1.
281 * The file also generates kernfs notification which can be
282 * monitored through poll and [di]notify when the value of the
283 * file changes.
284 *
Tejun Heoa2dd4242014-03-19 10:23:55 -0400285 * - If mount is requested with sane_behavior but without any
286 * subsystem, the default unified hierarchy is mounted.
287 *
Li Zefan5c5cc622013-06-09 17:16:29 +0800288 * - cpuset: tasks will be kept in empty cpusets when hotplug happens
289 * and take masks of ancestors with non-empty cpus/mems, instead of
290 * being moved to an ancestor.
291 *
Li Zefan88fa5232013-06-09 17:16:46 +0800292 * - cpuset: a task can be moved into an empty cpuset, and again it
293 * takes masks of ancestors.
Tejun Heo6db8e852013-06-14 11:18:22 -0700294 *
Tejun Heof00baae2013-04-15 13:41:15 -0700295 * - memcg: use_hierarchy is on by default and the cgroup file for
296 * the flag is not created.
297 *
Tejun Heo91381252013-05-14 13:52:38 -0700298 * - blkcg: blk-throttle becomes properly hierarchical.
Tejun Heo873fe092013-04-14 20:15:26 -0700299 */
300 CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
301
Tejun Heo25a7e682013-04-14 20:15:25 -0700302 CGRP_ROOT_NOPREFIX = (1 << 1), /* mounted subsystems have no named prefix */
303 CGRP_ROOT_XATTR = (1 << 2), /* supports extended attributes */
Tejun Heo0ce6cba2013-06-27 19:37:26 -0700304
305 /* mount options live below bit 16 */
306 CGRP_ROOT_OPTION_MASK = (1 << 16) - 1,
Tejun Heo25a7e682013-04-14 20:15:25 -0700307};
308
309/*
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400310 * A cgroup_root represents the root of a cgroup hierarchy, and may be
Tejun Heo2bd59d42014-02-11 11:52:49 -0500311 * associated with a kernfs_root to form an active hierarchy. This is
Tejun Heo25a7e682013-04-14 20:15:25 -0700312 * internal to cgroup core. Don't access directly from controllers.
313 */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400314struct cgroup_root {
Tejun Heo2bd59d42014-02-11 11:52:49 -0500315 struct kernfs_root *kf_root;
Tejun Heo25a7e682013-04-14 20:15:25 -0700316
Tejun Heof392e512014-04-23 11:13:14 -0400317 /* The bitmask of subsystems attached to this hierarchy */
Tejun Heo69dfa002014-05-04 15:09:13 -0400318 unsigned int subsys_mask;
Tejun Heof392e512014-04-23 11:13:14 -0400319
Tejun Heo25a7e682013-04-14 20:15:25 -0700320 /* Unique id for this hierarchy. */
321 int hierarchy_id;
322
Tejun Heo776f02f2014-02-12 09:29:50 -0500323 /* The root cgroup. Root is destroyed on its release. */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400324 struct cgroup cgrp;
Tejun Heo25a7e682013-04-14 20:15:25 -0700325
Tejun Heo3c9c8252014-02-12 09:29:50 -0500326 /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
327 atomic_t nr_cgrps;
Tejun Heo25a7e682013-04-14 20:15:25 -0700328
329 /* A list running through the active hierarchies */
330 struct list_head root_list;
331
Tejun Heo25a7e682013-04-14 20:15:25 -0700332 /* Hierarchy-specific flags */
Tejun Heo69dfa002014-05-04 15:09:13 -0400333 unsigned int flags;
Tejun Heo25a7e682013-04-14 20:15:25 -0700334
335 /* IDs for cgroups in this hierarchy */
Li Zefan4e96ee8e2013-07-31 09:50:50 +0800336 struct idr cgroup_idr;
Tejun Heo25a7e682013-04-14 20:15:25 -0700337
338 /* The path to use for release notifications. */
339 char release_agent_path[PATH_MAX];
340
341 /* The name for this hierarchy - may be empty */
342 char name[MAX_CGROUP_ROOT_NAMELEN];
343};
344
Paul Menaged20a3902009-04-02 16:57:22 -0700345/*
346 * A css_set is a structure holding pointers to a set of
Paul Menage817929e2007-10-18 23:39:36 -0700347 * cgroup_subsys_state objects. This saves space in the task struct
348 * object and speeds up fork()/exit(), since a single inc/dec and a
Paul Menaged20a3902009-04-02 16:57:22 -0700349 * list_add()/del() can bump the reference count on the entire cgroup
350 * set for a task.
Paul Menage817929e2007-10-18 23:39:36 -0700351 */
352
353struct css_set {
354
355 /* Reference count */
Lai Jiangshan146aa1b2008-10-18 20:28:03 -0700356 atomic_t refcount;
Paul Menage817929e2007-10-18 23:39:36 -0700357
358 /*
Li Zefan472b1052008-04-29 01:00:11 -0700359 * List running through all cgroup groups in the same hash
360 * slot. Protected by css_set_lock
361 */
362 struct hlist_node hlist;
363
364 /*
Tejun Heoc7561122014-02-25 10:04:01 -0500365 * Lists running through all tasks using this cgroup group.
366 * mg_tasks lists tasks which belong to this cset but are in the
367 * process of being migrated out or in. Protected by
368 * css_set_rwsem, but, during migration, once tasks are moved to
369 * mg_tasks, it can be read safely while holding cgroup_mutex.
Paul Menage817929e2007-10-18 23:39:36 -0700370 */
371 struct list_head tasks;
Tejun Heoc7561122014-02-25 10:04:01 -0500372 struct list_head mg_tasks;
Paul Menage817929e2007-10-18 23:39:36 -0700373
374 /*
Tejun Heo69d02062013-06-12 21:04:50 -0700375 * List of cgrp_cset_links pointing at cgroups referenced from this
376 * css_set. Protected by css_set_lock.
Paul Menage817929e2007-10-18 23:39:36 -0700377 */
Tejun Heo69d02062013-06-12 21:04:50 -0700378 struct list_head cgrp_links;
Paul Menage817929e2007-10-18 23:39:36 -0700379
Tejun Heo6803c002014-04-23 11:13:16 -0400380 /* the default cgroup associated with this css_set */
381 struct cgroup *dfl_cgrp;
382
Paul Menage817929e2007-10-18 23:39:36 -0700383 /*
Tejun Heo3ed80a62014-02-08 10:36:58 -0500384 * Set of subsystem states, one for each subsystem. This array is
385 * immutable after creation apart from the init_css_set during
386 * subsystem registration (at boot time).
Paul Menage817929e2007-10-18 23:39:36 -0700387 */
388 struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
Ben Blumc3783692009-09-23 15:56:29 -0700389
Tejun Heob3dc0942014-02-25 10:04:01 -0500390 /*
391 * List of csets participating in the on-going migration either as
392 * source or destination. Protected by cgroup_mutex.
393 */
Tejun Heo1958d2d2014-02-25 10:04:03 -0500394 struct list_head mg_preload_node;
Tejun Heob3dc0942014-02-25 10:04:01 -0500395 struct list_head mg_node;
396
397 /*
398 * If this cset is acting as the source of migration the following
399 * two fields are set. mg_src_cgrp is the source cgroup of the
400 * on-going migration and mg_dst_cset is the destination cset the
401 * target tasks on this cset should be migrated to. Protected by
402 * cgroup_mutex.
403 */
404 struct cgroup *mg_src_cgrp;
405 struct css_set *mg_dst_cset;
406
Tejun Heo2d8f2432014-04-23 11:13:15 -0400407 /*
408 * On the default hierarhcy, ->subsys[ssid] may point to a css
409 * attached to an ancestor instead of the cgroup this css_set is
410 * associated with. The following node is anchored at
411 * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
412 * iterate through all css's attached to a given cgroup.
413 */
414 struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
415
Ben Blumc3783692009-09-23 15:56:29 -0700416 /* For RCU-protected deletion */
417 struct rcu_head rcu_head;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700418};
419
Paul Menage91796562008-04-29 01:00:01 -0700420/*
Paul Menaged20a3902009-04-02 16:57:22 -0700421 * struct cftype: handler definitions for cgroup control files
Paul Menageddbcc7e2007-10-18 23:39:30 -0700422 *
423 * When reading/writing to a file:
Li Zefana043e3b2008-02-23 15:24:09 -0800424 * - the cgroup to use is file->f_dentry->d_parent->d_fsdata
Paul Menageddbcc7e2007-10-18 23:39:30 -0700425 * - the 'cftype' of the file is file->f_dentry->d_fsdata
426 */
427
Tejun Heo8e3f6542012-04-01 12:09:55 -0700428/* cftype->flags */
Tejun Heo02c402d2013-06-24 15:21:47 -0700429enum {
Li Zefan6f4b7e62013-07-31 16:18:36 +0800430 CFTYPE_ONLY_ON_ROOT = (1 << 0), /* only create on root cgrp */
431 CFTYPE_NOT_ON_ROOT = (1 << 1), /* don't create on root cgrp */
Tejun Heo02c402d2013-06-24 15:21:47 -0700432 CFTYPE_INSANE = (1 << 2), /* don't create if sane_behavior */
Tejun Heo9fa4db32013-08-26 18:40:56 -0400433 CFTYPE_NO_PREFIX = (1 << 3), /* (DON'T USE FOR NEW FILES) no subsys prefix */
Tejun Heo8cbbf2c2014-03-19 10:23:55 -0400434 CFTYPE_ONLY_ON_DFL = (1 << 4), /* only on default hierarchy */
Tejun Heo02c402d2013-06-24 15:21:47 -0700435};
Tejun Heo8e3f6542012-04-01 12:09:55 -0700436
437#define MAX_CFTYPE_NAME 64
438
Paul Menageddbcc7e2007-10-18 23:39:30 -0700439struct cftype {
Paul Menaged20a3902009-04-02 16:57:22 -0700440 /*
441 * By convention, the name should begin with the name of the
Tejun Heo8e3f6542012-04-01 12:09:55 -0700442 * subsystem, followed by a period. Zero length string indicates
443 * end of cftype array.
Paul Menaged20a3902009-04-02 16:57:22 -0700444 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700445 char name[MAX_CFTYPE_NAME];
446 int private;
Li Zefan099fca32009-04-02 16:57:29 -0700447 /*
448 * If not 0, file mode is set to this value, otherwise it will
449 * be figured out automatically
450 */
Al Viroa5e7ed32011-07-26 01:55:55 -0400451 umode_t mode;
Paul Menagedb3b1492008-07-25 01:46:58 -0700452
453 /*
Tejun Heo5f469902014-02-11 11:52:48 -0500454 * The maximum length of string, excluding trailing nul, that can
Tejun Heo451af502014-05-13 12:16:21 -0400455 * be passed to write. If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
Paul Menagedb3b1492008-07-25 01:46:58 -0700456 */
457 size_t max_write_len;
458
Tejun Heo8e3f6542012-04-01 12:09:55 -0700459 /* CFTYPE_* flags */
460 unsigned int flags;
461
Tejun Heo2bb566c2013-08-08 20:11:23 -0400462 /*
Tejun Heo0adb0702014-02-12 09:29:48 -0500463 * Fields used for internal bookkeeping. Initialized automatically
464 * during registration.
Tejun Heo2bb566c2013-08-08 20:11:23 -0400465 */
Tejun Heo0adb0702014-02-12 09:29:48 -0500466 struct cgroup_subsys *ss; /* NULL for cgroup core files */
467 struct list_head node; /* anchored at ss->cfts */
Tejun Heo2bd59d42014-02-11 11:52:49 -0500468 struct kernfs_ops *kf_ops;
469
Paul Menageddbcc7e2007-10-18 23:39:30 -0700470 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700471 * read_u64() is a shortcut for the common case of returning a
Paul Menageddbcc7e2007-10-18 23:39:30 -0700472 * single integer. Use it in place of read()
473 */
Tejun Heo182446d2013-08-08 20:11:24 -0400474 u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
Paul Menage91796562008-04-29 01:00:01 -0700475 /*
Paul Menagee73d2c62008-04-29 01:00:06 -0700476 * read_s64() is a signed version of read_u64()
477 */
Tejun Heo182446d2013-08-08 20:11:24 -0400478 s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
Tejun Heo2da8ca82013-12-05 12:28:04 -0500479
480 /* generic seq_file read interface */
481 int (*seq_show)(struct seq_file *sf, void *v);
Paul Menage91796562008-04-29 01:00:01 -0700482
Tejun Heo6612f052013-12-05 12:28:04 -0500483 /* optional ops, implement all or none */
484 void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
485 void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
486 void (*seq_stop)(struct seq_file *sf, void *v);
487
Paul Menage355e0c42007-10-18 23:39:33 -0700488 /*
Paul Menagef4c753b2008-04-29 00:59:56 -0700489 * write_u64() is a shortcut for the common case of accepting
Paul Menage355e0c42007-10-18 23:39:33 -0700490 * a single integer (as parsed by simple_strtoull) from
491 * userspace. Use in place of write(); return 0 or error.
492 */
Tejun Heo182446d2013-08-08 20:11:24 -0400493 int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
494 u64 val);
Paul Menagee73d2c62008-04-29 01:00:06 -0700495 /*
496 * write_s64() is a signed version of write_u64()
497 */
Tejun Heo182446d2013-08-08 20:11:24 -0400498 int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
499 s64 val);
Paul Menage355e0c42007-10-18 23:39:33 -0700500
Pavel Emelyanovd447ea22008-04-29 01:00:08 -0700501 /*
Tejun Heob4168642014-05-13 12:16:21 -0400502 * write() is the generic write callback which maps directly to
503 * kernfs write operation and overrides all other operations.
504 * Maximum write size is determined by ->max_write_len. Use
505 * of_css/cft() to access the associated css and cft.
506 */
507 ssize_t (*write)(struct kernfs_open_file *of,
508 char *buf, size_t nbytes, loff_t off);
509
Tejun Heo2bd59d42014-02-11 11:52:49 -0500510#ifdef CONFIG_DEBUG_LOCK_ALLOC
511 struct lock_class_key lockdep_key;
512#endif
Paul Menageddbcc7e2007-10-18 23:39:30 -0700513};
514
Tejun Heoa2dd4242014-03-19 10:23:55 -0400515extern struct cgroup_root cgrp_dfl_root;
Tejun Heo5024ae22014-05-07 21:31:17 -0400516extern struct css_set init_css_set;
Tejun Heoa2dd4242014-03-19 10:23:55 -0400517
518static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
519{
520 return cgrp->root == &cgrp_dfl_root;
521}
522
Tejun Heo8e3f6542012-04-01 12:09:55 -0700523/*
Tejun Heo873fe092013-04-14 20:15:26 -0700524 * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details. This
525 * function can be called as long as @cgrp is accessible.
526 */
527static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
528{
529 return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
530}
531
Tejun Heo07bc3562014-02-13 06:58:39 -0500532/* no synchronization, the result can only be used as a hint */
533static inline bool cgroup_has_tasks(struct cgroup *cgrp)
534{
535 return !list_empty(&cgrp->cset_links);
536}
537
Tejun Heob1664922014-02-11 11:52:49 -0500538/* returns ino associated with a cgroup, 0 indicates unmounted root */
539static inline ino_t cgroup_ino(struct cgroup *cgrp)
540{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500541 if (cgrp->kn)
542 return cgrp->kn->ino;
Tejun Heob1664922014-02-11 11:52:49 -0500543 else
544 return 0;
545}
546
Tejun Heob4168642014-05-13 12:16:21 -0400547/* cft/css accessors for cftype->write() operation */
548static inline struct cftype *of_cft(struct kernfs_open_file *of)
Tejun Heo7da11272013-12-05 12:28:04 -0500549{
Tejun Heo2bd59d42014-02-11 11:52:49 -0500550 return of->kn->priv;
Tejun Heo7da11272013-12-05 12:28:04 -0500551}
552
Tejun Heob4168642014-05-13 12:16:21 -0400553struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
554
555/* cft/css accessors for cftype->seq_*() operations */
556static inline struct cftype *seq_cft(struct seq_file *seq)
557{
558 return of_cft(seq->private);
559}
560
561static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
562{
563 return of_css(seq->private);
564}
Tejun Heo59f52962014-02-11 11:52:49 -0500565
Tejun Heoe61734c2014-02-12 09:29:50 -0500566/*
567 * Name / path handling functions. All are thin wrappers around the kernfs
568 * counterparts and can be called under any context.
569 */
570
571static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
572{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400573 return kernfs_name(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500574}
575
576static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
577 size_t buflen)
578{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400579 return kernfs_path(cgrp->kn, buf, buflen);
Tejun Heoe61734c2014-02-12 09:29:50 -0500580}
581
582static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
583{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400584 pr_cont_kernfs_name(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500585}
586
587static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
588{
Tejun Heofdce6bf2014-03-19 10:23:54 -0400589 pr_cont_kernfs_path(cgrp->kn);
Tejun Heoe61734c2014-02-12 09:29:50 -0500590}
591
592char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
593
Aristeu Rozanski03b1cde2012-08-23 16:53:30 -0400594int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
Tejun Heo2bb566c2013-08-08 20:11:23 -0400595int cgroup_rm_cftypes(struct cftype *cfts);
Tejun Heo8e3f6542012-04-01 12:09:55 -0700596
Li Zefan78574cf2013-04-08 19:00:38 -0700597bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700598
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100599/*
Tejun Heo2f7ee562011-12-12 18:12:21 -0800600 * Control Group taskset, used to pass around set of tasks to cgroup_subsys
601 * methods.
602 */
603struct cgroup_taskset;
604struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
605struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
Tejun Heo2f7ee562011-12-12 18:12:21 -0800606
607/**
608 * cgroup_taskset_for_each - iterate cgroup_taskset
609 * @task: the loop cursor
Tejun Heo2f7ee562011-12-12 18:12:21 -0800610 * @tset: taskset to iterate
611 */
Tejun Heo924f0d9a2014-02-13 06:58:41 -0500612#define cgroup_taskset_for_each(task, tset) \
Tejun Heo2f7ee562011-12-12 18:12:21 -0800613 for ((task) = cgroup_taskset_first((tset)); (task); \
Tejun Heo924f0d9a2014-02-13 06:58:41 -0500614 (task) = cgroup_taskset_next((tset)))
Tejun Heo2f7ee562011-12-12 18:12:21 -0800615
616/*
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100617 * Control Group subsystem type.
618 * See Documentation/cgroups/cgroups.txt for details
619 */
Paul Menageddbcc7e2007-10-18 23:39:30 -0700620
621struct cgroup_subsys {
Tejun Heoeb954192013-08-08 20:11:23 -0400622 struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
623 int (*css_online)(struct cgroup_subsys_state *css);
624 void (*css_offline)(struct cgroup_subsys_state *css);
625 void (*css_free)(struct cgroup_subsys_state *css);
Tejun Heo92fb9742012-11-19 08:13:38 -0800626
Tejun Heoeb954192013-08-08 20:11:23 -0400627 int (*can_attach)(struct cgroup_subsys_state *css,
628 struct cgroup_taskset *tset);
629 void (*cancel_attach)(struct cgroup_subsys_state *css,
630 struct cgroup_taskset *tset);
631 void (*attach)(struct cgroup_subsys_state *css,
632 struct cgroup_taskset *tset);
Li Zefan761b3ef52012-01-31 13:47:36 +0800633 void (*fork)(struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400634 void (*exit)(struct cgroup_subsys_state *css,
635 struct cgroup_subsys_state *old_css,
Li Zefan761b3ef52012-01-31 13:47:36 +0800636 struct task_struct *task);
Tejun Heoeb954192013-08-08 20:11:23 -0400637 void (*bind)(struct cgroup_subsys_state *root_css);
Hugh Dickinse5991372009-01-06 14:39:22 -0800638
Paul Menage8bab8dd2008-04-04 14:29:57 -0700639 int disabled;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700640 int early_init;
Tejun Heo48ddbe12012-04-01 12:09:56 -0700641
642 /*
Tejun Heo8c7f6ed2012-09-13 12:20:58 -0700643 * If %false, this subsystem is properly hierarchical -
644 * configuration, resource accounting and restriction on a parent
645 * cgroup cover those of its children. If %true, hierarchy support
646 * is broken in some ways - some subsystems ignore hierarchy
647 * completely while others are only implemented half-way.
648 *
649 * It's now disallowed to create nested cgroups if the subsystem is
650 * broken and cgroup core will emit a warning message on such
651 * cases. Eventually, all subsystems will be made properly
652 * hierarchical and this will go away.
653 */
654 bool broken_hierarchy;
655 bool warned_broken_hierarchy;
656
Tejun Heo073219e2014-02-08 10:36:58 -0500657 /* the following two fields are initialized automtically during boot */
Tejun Heoaec25022014-02-08 10:36:58 -0500658 int id;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700659#define MAX_CGROUP_TYPE_NAMELEN 32
660 const char *name;
661
Tejun Heob85d2042013-12-06 15:11:57 -0500662 /* link to parent, protected by cgroup_lock() */
Tejun Heo3dd06ff2014-03-19 10:23:54 -0400663 struct cgroup_root *root;
Ben Blume6a11052010-03-10 15:22:09 -0800664
Tejun Heo15a4c832014-05-04 15:09:14 -0400665 /* idr for css->id */
666 struct idr css_idr;
667
Tejun Heo0adb0702014-02-12 09:29:48 -0500668 /*
669 * List of cftypes. Each entry is the first entry of an array
670 * terminated by zero length name.
671 */
672 struct list_head cfts;
Tejun Heo8e3f6542012-04-01 12:09:55 -0700673
Tejun Heode00ffa2014-02-11 11:52:48 -0500674 /* base cftypes, automatically registered with subsys itself */
Tejun Heo8e3f6542012-04-01 12:09:55 -0700675 struct cftype *base_cftypes;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700676};
677
Tejun Heo073219e2014-02-08 10:36:58 -0500678#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700679#include <linux/cgroup_subsys.h>
680#undef SUBSYS
681
Tejun Heo8af01f52013-08-08 20:11:22 -0400682/**
Tejun Heo63876982013-08-08 20:11:23 -0400683 * css_parent - find the parent css
684 * @css: the target cgroup_subsys_state
685 *
686 * Return the parent css of @css. This function is guaranteed to return
687 * non-NULL parent as long as @css isn't the root.
688 */
689static inline
690struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
691{
Tejun Heo0ae78e02013-08-13 11:01:54 -0400692 return css->parent;
Tejun Heo63876982013-08-08 20:11:23 -0400693}
694
695/**
Tejun Heo14611e52013-06-25 11:48:32 -0700696 * task_css_set_check - obtain a task's css_set with extra access conditions
697 * @task: the task to obtain css_set for
698 * @__c: extra condition expression to be passed to rcu_dereference_check()
699 *
700 * A task's css_set is RCU protected, initialized and exited while holding
701 * task_lock(), and can only be modified while holding both cgroup_mutex
702 * and task_lock() while the task is alive. This macro verifies that the
703 * caller is inside proper critical section and returns @task's css_set.
704 *
705 * The caller can also specify additional allowed conditions via @__c, such
706 * as locks used during the cgroup_subsys::attach() methods.
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200707 */
Tejun Heo22194492013-04-07 09:29:51 -0700708#ifdef CONFIG_PROVE_RCU
709extern struct mutex cgroup_mutex;
Tejun Heo0e1d7682014-02-25 10:04:03 -0500710extern struct rw_semaphore css_set_rwsem;
Tejun Heo14611e52013-06-25 11:48:32 -0700711#define task_css_set_check(task, __c) \
712 rcu_dereference_check((task)->cgroups, \
Tejun Heo0e1d7682014-02-25 10:04:03 -0500713 lockdep_is_held(&cgroup_mutex) || \
714 lockdep_is_held(&css_set_rwsem) || \
715 ((task)->flags & PF_EXITING) || (__c))
Tejun Heo22194492013-04-07 09:29:51 -0700716#else
Tejun Heo14611e52013-06-25 11:48:32 -0700717#define task_css_set_check(task, __c) \
718 rcu_dereference((task)->cgroups)
Tejun Heo22194492013-04-07 09:29:51 -0700719#endif
Peter Zijlstradc61b1d2010-06-08 11:40:42 +0200720
Tejun Heo14611e52013-06-25 11:48:32 -0700721/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400722 * task_css_check - obtain css for (task, subsys) w/ extra access conds
Tejun Heo14611e52013-06-25 11:48:32 -0700723 * @task: the target task
724 * @subsys_id: the target subsystem ID
725 * @__c: extra condition expression to be passed to rcu_dereference_check()
726 *
727 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
728 * synchronization rules are the same as task_css_set_check().
729 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400730#define task_css_check(task, subsys_id, __c) \
Tejun Heo14611e52013-06-25 11:48:32 -0700731 task_css_set_check((task), (__c))->subsys[(subsys_id)]
732
733/**
734 * task_css_set - obtain a task's css_set
735 * @task: the task to obtain css_set for
736 *
737 * See task_css_set_check().
738 */
739static inline struct css_set *task_css_set(struct task_struct *task)
740{
741 return task_css_set_check(task, false);
742}
743
744/**
Tejun Heo8af01f52013-08-08 20:11:22 -0400745 * task_css - obtain css for (task, subsys)
Tejun Heo14611e52013-06-25 11:48:32 -0700746 * @task: the target task
747 * @subsys_id: the target subsystem ID
748 *
Tejun Heo8af01f52013-08-08 20:11:22 -0400749 * See task_css_check().
Tejun Heo14611e52013-06-25 11:48:32 -0700750 */
Tejun Heo8af01f52013-08-08 20:11:22 -0400751static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
752 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700753{
Tejun Heo8af01f52013-08-08 20:11:22 -0400754 return task_css_check(task, subsys_id, false);
Paul Menageddbcc7e2007-10-18 23:39:30 -0700755}
756
Tejun Heo5024ae22014-05-07 21:31:17 -0400757/**
758 * task_css_is_root - test whether a task belongs to the root css
759 * @task: the target task
760 * @subsys_id: the target subsystem ID
761 *
762 * Test whether @task belongs to the root css on the specified subsystem.
763 * May be invoked in any context.
764 */
765static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
766{
767 return task_css_check(task, subsys_id, true) ==
768 init_css_set.subsys[subsys_id];
769}
770
Tejun Heo8af01f52013-08-08 20:11:22 -0400771static inline struct cgroup *task_cgroup(struct task_struct *task,
772 int subsys_id)
Paul Menageddbcc7e2007-10-18 23:39:30 -0700773{
Tejun Heo8af01f52013-08-08 20:11:22 -0400774 return task_css(task, subsys_id)->cgroup;
Paul Menageddbcc7e2007-10-18 23:39:30 -0700775}
776
Tejun Heo492eb212013-08-08 20:11:25 -0400777struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
778 struct cgroup_subsys_state *parent);
Tejun Heo53fa5262013-05-24 10:55:38 +0900779
Li Zefan1cb650b2013-08-19 10:05:24 +0800780struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
781
Tejun Heo574bd9f2012-11-09 09:12:29 -0800782/**
Tejun Heo492eb212013-08-08 20:11:25 -0400783 * css_for_each_child - iterate through children of a css
784 * @pos: the css * to use as the loop cursor
785 * @parent: css whose children to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800786 *
Tejun Heo492eb212013-08-08 20:11:25 -0400787 * Walk @parent's children. Must be called under rcu_read_lock(). A child
788 * css which hasn't finished ->css_online() or already has finished
Tejun Heo92fb9742012-11-19 08:13:38 -0800789 * ->css_offline() may show up during traversal and it's each subsystem's
Tejun Heo574bd9f2012-11-09 09:12:29 -0800790 * responsibility to verify that each @pos is alive.
791 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800792 * If a subsystem synchronizes against the parent in its ->css_online() and
Tejun Heo492eb212013-08-08 20:11:25 -0400793 * before starting iterating, a css which finished ->css_online() is
Tejun Heo92fb9742012-11-19 08:13:38 -0800794 * guaranteed to be visible in the future iterations.
Tejun Heo75501a62013-05-24 10:55:38 +0900795 *
796 * It is allowed to temporarily drop RCU read lock during iteration. The
797 * caller is responsible for ensuring that @pos remains accessible until
798 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800799 */
Tejun Heo492eb212013-08-08 20:11:25 -0400800#define css_for_each_child(pos, parent) \
801 for ((pos) = css_next_child(NULL, (parent)); (pos); \
802 (pos) = css_next_child((pos), (parent)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800803
Tejun Heo492eb212013-08-08 20:11:25 -0400804struct cgroup_subsys_state *
805css_next_descendant_pre(struct cgroup_subsys_state *pos,
806 struct cgroup_subsys_state *css);
807
808struct cgroup_subsys_state *
809css_rightmost_descendant(struct cgroup_subsys_state *pos);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800810
811/**
Tejun Heo492eb212013-08-08 20:11:25 -0400812 * css_for_each_descendant_pre - pre-order walk of a css's descendants
813 * @pos: the css * to use as the loop cursor
814 * @root: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800815 *
Tejun Heobd8815a2013-08-08 20:11:27 -0400816 * Walk @root's descendants. @root is included in the iteration and the
817 * first node to be visited. Must be called under rcu_read_lock(). A
Tejun Heo492eb212013-08-08 20:11:25 -0400818 * descendant css which hasn't finished ->css_online() or already has
Tejun Heo92fb9742012-11-19 08:13:38 -0800819 * finished ->css_offline() may show up during traversal and it's each
Tejun Heo574bd9f2012-11-09 09:12:29 -0800820 * subsystem's responsibility to verify that each @pos is alive.
821 *
Tejun Heo92fb9742012-11-19 08:13:38 -0800822 * If a subsystem synchronizes against the parent in its ->css_online() and
823 * before starting iterating, and synchronizes against @pos on each
Tejun Heo492eb212013-08-08 20:11:25 -0400824 * iteration, any descendant css which finished ->css_online() is
Tejun Heo574bd9f2012-11-09 09:12:29 -0800825 * guaranteed to be visible in the future iterations.
826 *
827 * In other words, the following guarantees that a descendant can't escape
828 * state updates of its ancestors.
829 *
Tejun Heo492eb212013-08-08 20:11:25 -0400830 * my_online(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800831 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400832 * Lock @css's parent and @css;
833 * Inherit state from the parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800834 * Unlock both.
835 * }
836 *
Tejun Heo492eb212013-08-08 20:11:25 -0400837 * my_update_state(@css)
Tejun Heo574bd9f2012-11-09 09:12:29 -0800838 * {
Tejun Heo492eb212013-08-08 20:11:25 -0400839 * css_for_each_descendant_pre(@pos, @css) {
Tejun Heo574bd9f2012-11-09 09:12:29 -0800840 * Lock @pos;
Tejun Heobd8815a2013-08-08 20:11:27 -0400841 * if (@pos == @css)
842 * Update @css's state;
843 * else
844 * Verify @pos is alive and inherit state from its parent;
Tejun Heo574bd9f2012-11-09 09:12:29 -0800845 * Unlock @pos;
846 * }
847 * }
848 *
849 * As long as the inheriting step, including checking the parent state, is
850 * enclosed inside @pos locking, double-locking the parent isn't necessary
851 * while inheriting. The state update to the parent is guaranteed to be
852 * visible by walking order and, as long as inheriting operations to the
853 * same @pos are atomic to each other, multiple updates racing each other
854 * still result in the correct state. It's guaranateed that at least one
Tejun Heo492eb212013-08-08 20:11:25 -0400855 * inheritance happens for any css after the latest update to its parent.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800856 *
857 * If checking parent's state requires locking the parent, each inheriting
858 * iteration should lock and unlock both @pos->parent and @pos.
859 *
860 * Alternatively, a subsystem may choose to use a single global lock to
Tejun Heo92fb9742012-11-19 08:13:38 -0800861 * synchronize ->css_online() and ->css_offline() against tree-walking
Tejun Heo574bd9f2012-11-09 09:12:29 -0800862 * operations.
Tejun Heo75501a62013-05-24 10:55:38 +0900863 *
864 * It is allowed to temporarily drop RCU read lock during iteration. The
865 * caller is responsible for ensuring that @pos remains accessible until
866 * the start of the next iteration by, for example, bumping the css refcnt.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800867 */
Tejun Heo492eb212013-08-08 20:11:25 -0400868#define css_for_each_descendant_pre(pos, css) \
869 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
870 (pos) = css_next_descendant_pre((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800871
Tejun Heo492eb212013-08-08 20:11:25 -0400872struct cgroup_subsys_state *
873css_next_descendant_post(struct cgroup_subsys_state *pos,
874 struct cgroup_subsys_state *css);
Tejun Heo574bd9f2012-11-09 09:12:29 -0800875
876/**
Tejun Heo492eb212013-08-08 20:11:25 -0400877 * css_for_each_descendant_post - post-order walk of a css's descendants
878 * @pos: the css * to use as the loop cursor
879 * @css: css whose descendants to walk
Tejun Heo574bd9f2012-11-09 09:12:29 -0800880 *
Tejun Heo492eb212013-08-08 20:11:25 -0400881 * Similar to css_for_each_descendant_pre() but performs post-order
Tejun Heobd8815a2013-08-08 20:11:27 -0400882 * traversal instead. @root is included in the iteration and the last
883 * node to be visited. Note that the walk visibility guarantee described
884 * in pre-order walk doesn't apply the same to post-order walks.
Tejun Heo574bd9f2012-11-09 09:12:29 -0800885 */
Tejun Heo492eb212013-08-08 20:11:25 -0400886#define css_for_each_descendant_post(pos, css) \
887 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
888 (pos) = css_next_descendant_post((pos), (css)))
Tejun Heo574bd9f2012-11-09 09:12:29 -0800889
Tejun Heo72ec7022013-08-08 20:11:26 -0400890/* A css_task_iter should be treated as an opaque object */
891struct css_task_iter {
Tejun Heo3ebb2b62014-04-23 11:13:15 -0400892 struct cgroup_subsys *ss;
893
Tejun Heo0f0a2b42014-04-23 11:13:15 -0400894 struct list_head *cset_pos;
895 struct list_head *cset_head;
896
897 struct list_head *task_pos;
898 struct list_head *tasks_head;
899 struct list_head *mg_tasks_head;
Paul Menage817929e2007-10-18 23:39:36 -0700900};
901
Tejun Heo72ec7022013-08-08 20:11:26 -0400902void css_task_iter_start(struct cgroup_subsys_state *css,
903 struct css_task_iter *it);
904struct task_struct *css_task_iter_next(struct css_task_iter *it);
905void css_task_iter_end(struct css_task_iter *it);
Tejun Heoe5358372013-08-08 20:11:26 -0400906
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700907int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
Tejun Heo8cc99342013-04-07 09:29:50 -0700908int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700909
Tejun Heoec903c02014-05-13 12:11:01 -0400910struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
911 struct cgroup_subsys *ss);
KAMEZAWA Hiroyuki38460b42009-04-02 16:57:25 -0700912
Paul Menageddbcc7e2007-10-18 23:39:30 -0700913#else /* !CONFIG_CGROUPS */
914
915static inline int cgroup_init_early(void) { return 0; }
916static inline int cgroup_init(void) { return 0; }
Paul Menageb4f48b62007-10-18 23:39:33 -0700917static inline void cgroup_fork(struct task_struct *p) {}
Paul Menage817929e2007-10-18 23:39:36 -0700918static inline void cgroup_post_fork(struct task_struct *p) {}
Li Zefan1ec41832014-03-28 15:22:19 +0800919static inline void cgroup_exit(struct task_struct *p) {}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700920
Balbir Singh846c7bb2007-10-18 23:39:44 -0700921static inline int cgroupstats_build(struct cgroupstats *stats,
922 struct dentry *dentry)
923{
924 return -EINVAL;
925}
Paul Menageddbcc7e2007-10-18 23:39:30 -0700926
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200927/* No cgroups - nothing to do */
Michael S. Tsirkin31583bb2010-09-09 16:37:37 -0700928static inline int cgroup_attach_task_all(struct task_struct *from,
929 struct task_struct *t)
930{
931 return 0;
932}
Sridhar Samudralad7926ee2010-05-30 22:24:39 +0200933
Paul Menageddbcc7e2007-10-18 23:39:30 -0700934#endif /* !CONFIG_CGROUPS */
935
Paul Menageddbcc7e2007-10-18 23:39:30 -0700936#endif /* _LINUX_CGROUP_H */