Blame view

include/linux/cgroup.h 24 KB
b24413180   Greg Kroah-Hartman   License cleanup: ...
1
  /* SPDX-License-Identifier: GPL-2.0 */
ddbcc7e8e   Paul Menage   Task Control Grou...
2
3
4
5
6
7
8
9
10
11
12
  #ifndef _LINUX_CGROUP_H
  #define _LINUX_CGROUP_H
  /*
   *  cgroup interface
   *
   *  Copyright (C) 2003 BULL SA
   *  Copyright (C) 2004-2006 Silicon Graphics, Inc.
   *
   */
  
  #include <linux/sched.h>
ddbcc7e8e   Paul Menage   Task Control Grou...
13
14
  #include <linux/cpumask.h>
  #include <linux/nodemask.h>
eb6fd5040   Tejun Heo   cgroup: use rculi...
15
  #include <linux/rculist.h>
846c7bb05   Balbir Singh   Add cgroupstats
16
  #include <linux/cgroupstats.h>
25a7e6848   Tejun Heo   move cgroupfs_roo...
17
  #include <linux/fs.h>
7da112792   Tejun Heo   cgroup: attach cg...
18
  #include <linux/seq_file.h>
2bd59d48e   Tejun Heo   cgroup: convert t...
19
  #include <linux/kernfs.h>
49d1dc4b8   Tejun Heo   cgroup: implement...
20
  #include <linux/jump_label.h>
a79a908fd   Aditya Kali   cgroup: introduce...
21
22
23
24
  #include <linux/types.h>
  #include <linux/ns_common.h>
  #include <linux/nsproxy.h>
  #include <linux/user_namespace.h>
387ad9674   Elena Reshetova   kernel: convert c...
25
  #include <linux/refcount.h>
ddbcc7e8e   Paul Menage   Task Control Grou...
26

b4a04ab7a   Tejun Heo   cgroup: separate ...
27
  #include <linux/cgroup-defs.h>
ddbcc7e8e   Paul Menage   Task Control Grou...
28
29
  
  #ifdef CONFIG_CGROUPS
6abc8ca19   Tejun Heo   cgroup: define co...
30
31
32
33
34
35
36
37
  /*
   * All weight knobs on the default hierarhcy should use the following min,
   * default and max values.  The default value is the logarithmic center of
   * MIN and MAX and allows 100x to be expressed in both directions.
   */
  #define CGROUP_WEIGHT_MIN		1
  #define CGROUP_WEIGHT_DFL		100
  #define CGROUP_WEIGHT_MAX		10000
bc2fb7ed0   Tejun Heo   cgroup: add @flag...
38
39
  /* walk only threadgroup leaders */
  #define CSS_TASK_ITER_PROCS		(1U << 0)
450ee0c1f   Tejun Heo   cgroup: implement...
40
41
  /* walk all threaded css_sets in the domain */
  #define CSS_TASK_ITER_THREADED		(1U << 1)
bc2fb7ed0   Tejun Heo   cgroup: add @flag...
42

c326aa2bb   Tejun Heo   cgroup: reorganiz...
43
44
45
  /* a css_task_iter should be treated as an opaque object */
  struct css_task_iter {
  	struct cgroup_subsys		*ss;
bc2fb7ed0   Tejun Heo   cgroup: add @flag...
46
  	unsigned int			flags;
c326aa2bb   Tejun Heo   cgroup: reorganiz...
47
48
49
  
  	struct list_head		*cset_pos;
  	struct list_head		*cset_head;
ddbcc7e8e   Paul Menage   Task Control Grou...
50

450ee0c1f   Tejun Heo   cgroup: implement...
51
52
  	struct list_head		*tcset_pos;
  	struct list_head		*tcset_head;
c326aa2bb   Tejun Heo   cgroup: reorganiz...
53
54
55
  	struct list_head		*task_pos;
  	struct list_head		*tasks_head;
  	struct list_head		*mg_tasks_head;
ed27b9f7a   Tejun Heo   cgroup: don't hol...
56
57
  
  	struct css_set			*cur_cset;
450ee0c1f   Tejun Heo   cgroup: implement...
58
  	struct css_set			*cur_dcset;
ed27b9f7a   Tejun Heo   cgroup: don't hol...
59
60
  	struct task_struct		*cur_task;
  	struct list_head		iters_node;	/* css_set->task_iters */
c326aa2bb   Tejun Heo   cgroup: reorganiz...
61
  };
ddbcc7e8e   Paul Menage   Task Control Grou...
62

c326aa2bb   Tejun Heo   cgroup: reorganiz...
63
64
  extern struct cgroup_root cgrp_dfl_root;
  extern struct css_set init_css_set;
a424316ca   Paul Menage   Task Control Grou...
65

c326aa2bb   Tejun Heo   cgroup: reorganiz...
66
  #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
817929ec2   Paul Menage   Task Control Grou...
67
  #include <linux/cgroup_subsys.h>
817929ec2   Paul Menage   Task Control Grou...
68
  #undef SUBSYS
49d1dc4b8   Tejun Heo   cgroup: implement...
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
  #define SUBSYS(_x)								\
  	extern struct static_key_true _x ## _cgrp_subsys_enabled_key;		\
  	extern struct static_key_true _x ## _cgrp_subsys_on_dfl_key;
  #include <linux/cgroup_subsys.h>
  #undef SUBSYS
  
  /**
   * cgroup_subsys_enabled - fast test on whether a subsys is enabled
   * @ss: subsystem in question
   */
  #define cgroup_subsys_enabled(ss)						\
  	static_branch_likely(&ss ## _enabled_key)
  
  /**
   * cgroup_subsys_on_dfl - fast test on whether a subsys is on default hierarchy
   * @ss: subsystem in question
   */
  #define cgroup_subsys_on_dfl(ss)						\
  	static_branch_likely(&ss ## _on_dfl_key)
c326aa2bb   Tejun Heo   cgroup: reorganiz...
88
89
90
91
92
93
  bool css_has_online_children(struct cgroup_subsys_state *css);
  struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
  struct cgroup_subsys_state *cgroup_get_e_css(struct cgroup *cgroup,
  					     struct cgroup_subsys *ss);
  struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
  						       struct cgroup_subsys *ss);
16af43964   Tejun Heo   cgroup: implement...
94
  struct cgroup *cgroup_get_from_path(const char *path);
1f3fe7ebf   Martin KaFai Lau   cgroup: Add cgrou...
95
  struct cgroup *cgroup_get_from_fd(int fd);
16af43964   Tejun Heo   cgroup: implement...
96

c326aa2bb   Tejun Heo   cgroup: reorganiz...
97
98
99
100
101
102
  int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
  int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
  
  int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  int cgroup_rm_cftypes(struct cftype *cfts);
34c06254f   Tejun Heo   cgroup: fix cftyp...
103
  void cgroup_file_notify(struct cgroup_file *cfile);
c326aa2bb   Tejun Heo   cgroup: reorganiz...
104

4c737b41d   Tejun Heo   cgroup: make cgro...
105
  int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
c326aa2bb   Tejun Heo   cgroup: reorganiz...
106
107
108
109
110
  int cgroupstats_build(struct cgroupstats *stats, struct dentry *dentry);
  int proc_cgroup_show(struct seq_file *m, struct pid_namespace *ns,
  		     struct pid *pid, struct task_struct *tsk);
  
  void cgroup_fork(struct task_struct *p);
b53202e63   Oleg Nesterov   cgroup: kill cgrp...
111
112
113
  extern int cgroup_can_fork(struct task_struct *p);
  extern void cgroup_cancel_fork(struct task_struct *p);
  extern void cgroup_post_fork(struct task_struct *p);
c326aa2bb   Tejun Heo   cgroup: reorganiz...
114
  void cgroup_exit(struct task_struct *p);
2e91fa7f6   Tejun Heo   cgroup: keep zomb...
115
  void cgroup_free(struct task_struct *p);
c326aa2bb   Tejun Heo   cgroup: reorganiz...
116
117
118
  
  int cgroup_init_early(void);
  int cgroup_init(void);
5c9d535b8   Tejun Heo   cgroup: remove cs...
119
  /*
c326aa2bb   Tejun Heo   cgroup: reorganiz...
120
121
122
123
124
125
126
127
128
129
   * Iteration helpers and macros.
   */
  
  struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
  					   struct cgroup_subsys_state *parent);
  struct cgroup_subsys_state *css_next_descendant_pre(struct cgroup_subsys_state *pos,
  						    struct cgroup_subsys_state *css);
  struct cgroup_subsys_state *css_rightmost_descendant(struct cgroup_subsys_state *pos);
  struct cgroup_subsys_state *css_next_descendant_post(struct cgroup_subsys_state *pos,
  						     struct cgroup_subsys_state *css);
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
130
131
132
133
  struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset,
  					 struct cgroup_subsys_state **dst_cssp);
  struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset,
  					struct cgroup_subsys_state **dst_cssp);
c326aa2bb   Tejun Heo   cgroup: reorganiz...
134

bc2fb7ed0   Tejun Heo   cgroup: add @flag...
135
  void css_task_iter_start(struct cgroup_subsys_state *css, unsigned int flags,
c326aa2bb   Tejun Heo   cgroup: reorganiz...
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
  			 struct css_task_iter *it);
  struct task_struct *css_task_iter_next(struct css_task_iter *it);
  void css_task_iter_end(struct css_task_iter *it);
  
  /**
   * css_for_each_child - iterate through children of a css
   * @pos: the css * to use as the loop cursor
   * @parent: css whose children to walk
   *
   * Walk @parent's children.  Must be called under rcu_read_lock().
   *
   * If a subsystem synchronizes ->css_online() and the start of iteration, a
   * css which finished ->css_online() is guaranteed to be visible in the
   * future iterations and will stay visible until the last reference is put.
   * A css which hasn't finished ->css_online() or already finished
   * ->css_offline() may show up during traversal.  It's each subsystem's
   * responsibility to synchronize against on/offlining.
5c9d535b8   Tejun Heo   cgroup: remove cs...
153
   *
c326aa2bb   Tejun Heo   cgroup: reorganiz...
154
155
156
   * It is allowed to temporarily drop RCU read lock during iteration.  The
   * caller is responsible for ensuring that @pos remains accessible until
   * the start of the next iteration by, for example, bumping the css refcnt.
5c9d535b8   Tejun Heo   cgroup: remove cs...
157
   */
c326aa2bb   Tejun Heo   cgroup: reorganiz...
158
159
160
  #define css_for_each_child(pos, parent)					\
  	for ((pos) = css_next_child(NULL, (parent)); (pos);		\
  	     (pos) = css_next_child((pos), (parent)))
ddbcc7e8e   Paul Menage   Task Control Grou...
161

c326aa2bb   Tejun Heo   cgroup: reorganiz...
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
  /**
   * css_for_each_descendant_pre - pre-order walk of a css's descendants
   * @pos: the css * to use as the loop cursor
   * @root: css whose descendants to walk
   *
   * Walk @root's descendants.  @root is included in the iteration and the
   * first node to be visited.  Must be called under rcu_read_lock().
   *
   * If a subsystem synchronizes ->css_online() and the start of iteration, a
   * css which finished ->css_online() is guaranteed to be visible in the
   * future iterations and will stay visible until the last reference is put.
   * A css which hasn't finished ->css_online() or already finished
   * ->css_offline() may show up during traversal.  It's each subsystem's
   * responsibility to synchronize against on/offlining.
   *
   * For example, the following guarantees that a descendant can't escape
   * state updates of its ancestors.
   *
   * my_online(@css)
   * {
   *	Lock @css's parent and @css;
   *	Inherit state from the parent;
   *	Unlock both.
   * }
   *
   * my_update_state(@css)
   * {
   *	css_for_each_descendant_pre(@pos, @css) {
   *		Lock @pos;
   *		if (@pos == @css)
   *			Update @css's state;
   *		else
   *			Verify @pos is alive and inherit state from its parent;
   *		Unlock @pos;
   *	}
   * }
   *
   * As long as the inheriting step, including checking the parent state, is
   * enclosed inside @pos locking, double-locking the parent isn't necessary
   * while inheriting.  The state update to the parent is guaranteed to be
   * visible by walking order and, as long as inheriting operations to the
   * same @pos are atomic to each other, multiple updates racing each other
   * still result in the correct state.  It's guaranateed that at least one
   * inheritance happens for any css after the latest update to its parent.
   *
   * If checking parent's state requires locking the parent, each inheriting
   * iteration should lock and unlock both @pos->parent and @pos.
   *
   * Alternatively, a subsystem may choose to use a single global lock to
   * synchronize ->css_online() and ->css_offline() against tree-walking
   * operations.
   *
   * It is allowed to temporarily drop RCU read lock during iteration.  The
   * caller is responsible for ensuring that @pos remains accessible until
   * the start of the next iteration by, for example, bumping the css refcnt.
   */
  #define css_for_each_descendant_pre(pos, css)				\
  	for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);	\
  	     (pos) = css_next_descendant_pre((pos), (css)))
  
  /**
   * css_for_each_descendant_post - post-order walk of a css's descendants
   * @pos: the css * to use as the loop cursor
   * @css: css whose descendants to walk
   *
   * Similar to css_for_each_descendant_pre() but performs post-order
   * traversal instead.  @root is included in the iteration and the last
   * node to be visited.
   *
   * If a subsystem synchronizes ->css_online() and the start of iteration, a
   * css which finished ->css_online() is guaranteed to be visible in the
   * future iterations and will stay visible until the last reference is put.
   * A css which hasn't finished ->css_online() or already finished
   * ->css_offline() may show up during traversal.  It's each subsystem's
   * responsibility to synchronize against on/offlining.
   *
   * Note that the walk visibility guarantee example described in pre-order
   * walk doesn't apply the same to post-order walks.
   */
  #define css_for_each_descendant_post(pos, css)				\
  	for ((pos) = css_next_descendant_post(NULL, (css)); (pos);	\
  	     (pos) = css_next_descendant_post((pos), (css)))
  
  /**
   * cgroup_taskset_for_each - iterate cgroup_taskset
   * @task: the loop cursor
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
248
   * @dst_css: the destination css
c326aa2bb   Tejun Heo   cgroup: reorganiz...
249
   * @tset: taskset to iterate
4530eddb5   Tejun Heo   cgroup, memcg, cp...
250
251
   *
   * @tset may contain multiple tasks and they may belong to multiple
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
252
253
254
255
256
257
258
259
   * processes.
   *
   * On the v2 hierarchy, there may be tasks from multiple processes and they
   * may not share the source or destination csses.
   *
   * On traditional hierarchies, when there are multiple tasks in @tset, if a
   * task of a process is in @tset, all tasks of the process are in @tset.
   * Also, all are guaranteed to share the same source and destination csses.
4530eddb5   Tejun Heo   cgroup, memcg, cp...
260
261
   *
   * Iteration is not in any specific order.
c326aa2bb   Tejun Heo   cgroup: reorganiz...
262
   */
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
263
264
265
266
  #define cgroup_taskset_for_each(task, dst_css, tset)			\
  	for ((task) = cgroup_taskset_first((tset), &(dst_css));		\
  	     (task);							\
  	     (task) = cgroup_taskset_next((tset), &(dst_css)))
ddbcc7e8e   Paul Menage   Task Control Grou...
267

4530eddb5   Tejun Heo   cgroup, memcg, cp...
268
269
270
  /**
   * cgroup_taskset_for_each_leader - iterate group leaders in a cgroup_taskset
   * @leader: the loop cursor
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
271
   * @dst_css: the destination css
7b4632f04   Geliang Tang   cgroup: fix a com...
272
   * @tset: taskset to iterate
4530eddb5   Tejun Heo   cgroup, memcg, cp...
273
274
275
276
   *
   * Iterate threadgroup leaders of @tset.  For single-task migrations, @tset
   * may not contain any.
   */
1f7dd3e5a   Tejun Heo   cgroup: fix handl...
277
278
279
280
  #define cgroup_taskset_for_each_leader(leader, dst_css, tset)		\
  	for ((leader) = cgroup_taskset_first((tset), &(dst_css));	\
  	     (leader);							\
  	     (leader) = cgroup_taskset_next((tset), &(dst_css)))	\
4530eddb5   Tejun Heo   cgroup, memcg, cp...
281
282
283
  		if ((leader) != (leader)->group_leader)			\
  			;						\
  		else
c326aa2bb   Tejun Heo   cgroup: reorganiz...
284
285
286
  /*
   * Inline functions.
   */
ddbcc7e8e   Paul Menage   Task Control Grou...
287

5de0107e6   Tejun Heo   cgroup: clean up ...
288
289
290
291
292
  /**
   * css_get - obtain a reference on the specified css
   * @css: target css
   *
   * The caller must already have a reference.
ddbcc7e8e   Paul Menage   Task Control Grou...
293
   */
ddbcc7e8e   Paul Menage   Task Control Grou...
294
295
  static inline void css_get(struct cgroup_subsys_state *css)
  {
3b514d24e   Tejun Heo   cgroup: skip refc...
296
297
  	if (!(css->flags & CSS_NO_REF))
  		percpu_ref_get(&css->refcnt);
ddbcc7e8e   Paul Menage   Task Control Grou...
298
  }
e7c5ec919   Paul Menage   cgroups: add css_...
299

5de0107e6   Tejun Heo   cgroup: clean up ...
300
  /**
e8ea14cc6   Johannes Weiner   mm: memcontrol: t...
301
302
303
304
305
306
307
308
309
310
311
312
313
   * css_get_many - obtain references on the specified css
   * @css: target css
   * @n: number of references to get
   *
   * The caller must already have a reference.
   */
  static inline void css_get_many(struct cgroup_subsys_state *css, unsigned int n)
  {
  	if (!(css->flags & CSS_NO_REF))
  		percpu_ref_get_many(&css->refcnt, n);
  }
  
  /**
6f4524d35   Tejun Heo   cgroup: implement...
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
   * css_tryget - try to obtain a reference on the specified css
   * @css: target css
   *
   * Obtain a reference on @css unless it already has reached zero and is
   * being released.  This function doesn't care whether @css is on or
   * offline.  The caller naturally needs to ensure that @css is accessible
   * but doesn't have to be holding a reference on it - IOW, RCU protected
   * access is good enough for this function.  Returns %true if a reference
   * count was successfully obtained; %false otherwise.
   */
  static inline bool css_tryget(struct cgroup_subsys_state *css)
  {
  	if (!(css->flags & CSS_NO_REF))
  		return percpu_ref_tryget(&css->refcnt);
  	return true;
  }
  
  /**
ec903c0c8   Tejun Heo   cgroup: rename cs...
332
   * css_tryget_online - try to obtain a reference on the specified css if online
5de0107e6   Tejun Heo   cgroup: clean up ...
333
334
   * @css: target css
   *
ec903c0c8   Tejun Heo   cgroup: rename cs...
335
336
   * Obtain a reference on @css if it's online.  The caller naturally needs
   * to ensure that @css is accessible but doesn't have to be holding a
5de0107e6   Tejun Heo   cgroup: clean up ...
337
338
339
340
   * reference on it - IOW, RCU protected access is good enough for this
   * function.  Returns %true if a reference count was successfully obtained;
   * %false otherwise.
   */
ec903c0c8   Tejun Heo   cgroup: rename cs...
341
  static inline bool css_tryget_online(struct cgroup_subsys_state *css)
e7c5ec919   Paul Menage   cgroups: add css_...
342
  {
3b514d24e   Tejun Heo   cgroup: skip refc...
343
344
345
  	if (!(css->flags & CSS_NO_REF))
  		return percpu_ref_tryget_live(&css->refcnt);
  	return true;
e7c5ec919   Paul Menage   cgroups: add css_...
346
  }
2f7ee5691   Tejun Heo   cgroup: introduce...
347
348
  
  /**
41c25707d   Tejun Heo   cpuset: consider ...
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
   * css_is_dying - test whether the specified css is dying
   * @css: target css
   *
   * Test whether @css is in the process of offlining or already offline.  In
   * most cases, ->css_online() and ->css_offline() callbacks should be
   * enough; however, the actual offline operations are RCU delayed and this
   * test returns %true also when @css is scheduled to be offlined.
   *
   * This is useful, for example, when the use case requires synchronous
   * behavior with respect to cgroup removal.  cgroup removal schedules css
   * offlining but the css can seem alive while the operation is being
   * delayed.  If the delay affects user visible semantics, this test can be
   * used to resolve the situation.
   */
  static inline bool css_is_dying(struct cgroup_subsys_state *css)
  {
  	return !(css->flags & CSS_NO_REF) && percpu_ref_is_dying(&css->refcnt);
  }
  
  /**
5de0107e6   Tejun Heo   cgroup: clean up ...
369
370
371
   * css_put - put a css reference
   * @css: target css
   *
ec903c0c8   Tejun Heo   cgroup: rename cs...
372
   * Put a reference obtained via css_get() and css_tryget_online().
2f7ee5691   Tejun Heo   cgroup: introduce...
373
   */
ddbcc7e8e   Paul Menage   Task Control Grou...
374
375
  static inline void css_put(struct cgroup_subsys_state *css)
  {
3b514d24e   Tejun Heo   cgroup: skip refc...
376
377
  	if (!(css->flags & CSS_NO_REF))
  		percpu_ref_put(&css->refcnt);
ddbcc7e8e   Paul Menage   Task Control Grou...
378
  }
2f7ee5691   Tejun Heo   cgroup: introduce...
379

e8ea14cc6   Johannes Weiner   mm: memcontrol: t...
380
381
382
383
384
385
  /**
   * css_put_many - put css references
   * @css: target css
   * @n: number of references to put
   *
   * Put references obtained via css_get() and css_tryget_online().
21acb9caa   Thadeu Lima de Souza Cascardo   trivial: fix wher...
386
   */
e8ea14cc6   Johannes Weiner   mm: memcontrol: t...
387
388
389
390
391
  static inline void css_put_many(struct cgroup_subsys_state *css, unsigned int n)
  {
  	if (!(css->flags & CSS_NO_REF))
  		percpu_ref_put_many(&css->refcnt, n);
  }
ddbcc7e8e   Paul Menage   Task Control Grou...
392

3e48930cc   Tejun Heo   cgroup: misc changes
393
394
395
396
397
398
399
400
401
  static inline void cgroup_get(struct cgroup *cgrp)
  {
  	css_get(&cgrp->self);
  }
  
  static inline bool cgroup_tryget(struct cgroup *cgrp)
  {
  	return css_tryget(&cgrp->self);
  }
16af43964   Tejun Heo   cgroup: implement...
402
403
404
405
  static inline void cgroup_put(struct cgroup *cgrp)
  {
  	css_put(&cgrp->self);
  }
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
406
  /**
14611e51a   Tejun Heo   cgroup: fix RCU a...
407
408
409
410
411
412
413
414
415
416
417
   * task_css_set_check - obtain a task's css_set with extra access conditions
   * @task: the task to obtain css_set for
   * @__c: extra condition expression to be passed to rcu_dereference_check()
   *
   * A task's css_set is RCU protected, initialized and exited while holding
   * task_lock(), and can only be modified while holding both cgroup_mutex
   * and task_lock() while the task is alive.  This macro verifies that the
   * caller is inside proper critical section and returns @task's css_set.
   *
   * The caller can also specify additional allowed conditions via @__c, such
   * as locks used during the cgroup_subsys::attach() methods.
dc61b1d65   Peter Zijlstra   sched: Fix PROVE_...
418
   */
2219449a6   Tejun Heo   cgroup: remove cg...
419
420
  #ifdef CONFIG_PROVE_RCU
  extern struct mutex cgroup_mutex;
f0d9a5f17   Tejun Heo   cgroup: make css_...
421
  extern spinlock_t css_set_lock;
14611e51a   Tejun Heo   cgroup: fix RCU a...
422
423
  #define task_css_set_check(task, __c)					\
  	rcu_dereference_check((task)->cgroups,				\
0e1d768f1   Tejun Heo   cgroup: drop task...
424
  		lockdep_is_held(&cgroup_mutex) ||			\
f0d9a5f17   Tejun Heo   cgroup: make css_...
425
  		lockdep_is_held(&css_set_lock) ||			\
0e1d768f1   Tejun Heo   cgroup: drop task...
426
  		((task)->flags & PF_EXITING) || (__c))
2219449a6   Tejun Heo   cgroup: remove cg...
427
  #else
14611e51a   Tejun Heo   cgroup: fix RCU a...
428
429
  #define task_css_set_check(task, __c)					\
  	rcu_dereference((task)->cgroups)
2219449a6   Tejun Heo   cgroup: remove cg...
430
  #endif
dc61b1d65   Peter Zijlstra   sched: Fix PROVE_...
431

14611e51a   Tejun Heo   cgroup: fix RCU a...
432
  /**
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
433
   * task_css_check - obtain css for (task, subsys) w/ extra access conds
14611e51a   Tejun Heo   cgroup: fix RCU a...
434
435
436
437
438
439
440
   * @task: the target task
   * @subsys_id: the target subsystem ID
   * @__c: extra condition expression to be passed to rcu_dereference_check()
   *
   * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
   * synchronization rules are the same as task_css_set_check().
   */
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
441
  #define task_css_check(task, subsys_id, __c)				\
14611e51a   Tejun Heo   cgroup: fix RCU a...
442
443
444
445
446
447
448
449
450
451
452
453
454
455
  	task_css_set_check((task), (__c))->subsys[(subsys_id)]
  
  /**
   * task_css_set - obtain a task's css_set
   * @task: the task to obtain css_set for
   *
   * See task_css_set_check().
   */
  static inline struct css_set *task_css_set(struct task_struct *task)
  {
  	return task_css_set_check(task, false);
  }
  
  /**
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
456
   * task_css - obtain css for (task, subsys)
14611e51a   Tejun Heo   cgroup: fix RCU a...
457
458
459
   * @task: the target task
   * @subsys_id: the target subsystem ID
   *
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
460
   * See task_css_check().
14611e51a   Tejun Heo   cgroup: fix RCU a...
461
   */
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
462
463
  static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
  						   int subsys_id)
ddbcc7e8e   Paul Menage   Task Control Grou...
464
  {
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
465
  	return task_css_check(task, subsys_id, false);
ddbcc7e8e   Paul Menage   Task Control Grou...
466
  }
5024ae29c   Tejun Heo   cgroup: introduce...
467
  /**
ec438699a   Tejun Heo   cgroup, block: im...
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
   * task_get_css - find and get the css for (task, subsys)
   * @task: the target task
   * @subsys_id: the target subsystem ID
   *
   * Find the css for the (@task, @subsys_id) combination, increment a
   * reference on and return it.  This function is guaranteed to return a
   * valid css.
   */
  static inline struct cgroup_subsys_state *
  task_get_css(struct task_struct *task, int subsys_id)
  {
  	struct cgroup_subsys_state *css;
  
  	rcu_read_lock();
  	while (true) {
  		css = task_css(task, subsys_id);
  		if (likely(css_tryget_online(css)))
  			break;
  		cpu_relax();
  	}
  	rcu_read_unlock();
  	return css;
  }
  
  /**
5024ae29c   Tejun Heo   cgroup: introduce...
493
494
495
496
497
498
499
500
501
502
503
504
   * task_css_is_root - test whether a task belongs to the root css
   * @task: the target task
   * @subsys_id: the target subsystem ID
   *
   * Test whether @task belongs to the root css on the specified subsystem.
   * May be invoked in any context.
   */
  static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
  {
  	return task_css_check(task, subsys_id, true) ==
  		init_css_set.subsys[subsys_id];
  }
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
505
506
  static inline struct cgroup *task_cgroup(struct task_struct *task,
  					 int subsys_id)
ddbcc7e8e   Paul Menage   Task Control Grou...
507
  {
8af01f56a   Tejun Heo   cgroup: s/cgroup_...
508
  	return task_css(task, subsys_id)->cgroup;
ddbcc7e8e   Paul Menage   Task Control Grou...
509
  }
3e48930cc   Tejun Heo   cgroup: misc changes
510
511
512
513
514
515
516
517
518
519
520
521
522
  static inline struct cgroup *task_dfl_cgroup(struct task_struct *task)
  {
  	return task_css_set(task)->dfl_cgrp;
  }
  
  static inline struct cgroup *cgroup_parent(struct cgroup *cgrp)
  {
  	struct cgroup_subsys_state *parent_css = cgrp->self.parent;
  
  	if (parent_css)
  		return container_of(parent_css, struct cgroup, self);
  	return NULL;
  }
b11cfb580   Tejun Heo   cgroup: record an...
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
  /**
   * cgroup_is_descendant - test ancestry
   * @cgrp: the cgroup to be tested
   * @ancestor: possible ancestor of @cgrp
   *
   * Test whether @cgrp is a descendant of @ancestor.  It also returns %true
   * if @cgrp == @ancestor.  This function is safe to call as long as @cgrp
   * and @ancestor are accessible.
   */
  static inline bool cgroup_is_descendant(struct cgroup *cgrp,
  					struct cgroup *ancestor)
  {
  	if (cgrp->root != ancestor->root || cgrp->level < ancestor->level)
  		return false;
  	return cgrp->ancestor_ids[ancestor->level] == ancestor->id;
  }
aed704b7a   Sargun Dhillon   cgroup: Add task_...
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
  /**
   * task_under_cgroup_hierarchy - test task's membership of cgroup ancestry
   * @task: the task to be tested
   * @ancestor: possible ancestor of @task's cgroup
   *
   * Tests whether @task's default cgroup hierarchy is a descendant of @ancestor.
   * It follows all the same rules as cgroup_is_descendant, and only applies
   * to the default hierarchy.
   */
  static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
  					       struct cgroup *ancestor)
  {
  	struct css_set *cset = task_css_set(task);
  
  	return cgroup_is_descendant(cset->dfl_cgrp, ancestor);
  }
07bc356ed   Tejun Heo   cgroup: implement...
555
  /* no synchronization, the result can only be used as a hint */
27bd4dbb8   Tejun Heo   cgroup: replace c...
556
  static inline bool cgroup_is_populated(struct cgroup *cgrp)
07bc356ed   Tejun Heo   cgroup: implement...
557
  {
454000ada   Tejun Heo   cgroup: introduce...
558
559
  	return cgrp->nr_populated_csets + cgrp->nr_populated_domain_children +
  		cgrp->nr_populated_threaded_children;
07bc356ed   Tejun Heo   cgroup: implement...
560
  }
f3d465001   Tejun Heo   cgroup: convert c...
561

f29374b14   Zefan Li   cgroup: remove re...
562
  /* returns ino associated with a cgroup */
b16649240   Tejun Heo   cgroup: introduce...
563
564
  static inline ino_t cgroup_ino(struct cgroup *cgrp)
  {
c53cd490b   Shaohua Li   kernfs: introduce...
565
  	return cgrp->kn->id.ino;
b16649240   Tejun Heo   cgroup: introduce...
566
  }
3ebb2b6ef   Tejun Heo   cgroup: teach css...
567

b41686401   Tejun Heo   cgroup: implement...
568
569
  /* cft/css accessors for cftype->write() operation */
  static inline struct cftype *of_cft(struct kernfs_open_file *of)
7da112792   Tejun Heo   cgroup: attach cg...
570
  {
2bd59d48e   Tejun Heo   cgroup: convert t...
571
  	return of->kn->priv;
7da112792   Tejun Heo   cgroup: attach cg...
572
  }
0f0a2b4fa   Tejun Heo   cgroup: reorganiz...
573

b41686401   Tejun Heo   cgroup: implement...
574
  struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
817929ec2   Paul Menage   Task Control Grou...
575

b41686401   Tejun Heo   cgroup: implement...
576
577
578
579
580
  /* cft/css accessors for cftype->seq_*() operations */
  static inline struct cftype *seq_cft(struct seq_file *seq)
  {
  	return of_cft(seq->private);
  }
e535837b1   Tejun Heo   cgroup: remove st...
581

b41686401   Tejun Heo   cgroup: implement...
582
583
584
585
  static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
  {
  	return of_css(seq->private);
  }
31583bb0c   Michael S. Tsirkin   cgroups: fix API ...
586

e61734c55   Tejun Heo   cgroup: remove cg...
587
588
589
590
  /*
   * Name / path handling functions.  All are thin wrappers around the kernfs
   * counterparts and can be called under any context.
   */
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
591

e61734c55   Tejun Heo   cgroup: remove cg...
592
593
  static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
  {
fdce6bf8c   Tejun Heo   cgroup: remove NU...
594
  	return kernfs_name(cgrp->kn, buf, buflen);
e61734c55   Tejun Heo   cgroup: remove cg...
595
  }
ddbcc7e8e   Paul Menage   Task Control Grou...
596

4c737b41d   Tejun Heo   cgroup: make cgro...
597
  static inline int cgroup_path(struct cgroup *cgrp, char *buf, size_t buflen)
e61734c55   Tejun Heo   cgroup: remove cg...
598
  {
fdce6bf8c   Tejun Heo   cgroup: remove NU...
599
  	return kernfs_path(cgrp->kn, buf, buflen);
e61734c55   Tejun Heo   cgroup: remove cg...
600
  }
f3ba53802   Tejun Heo   cgroup: add dummy...
601

e61734c55   Tejun Heo   cgroup: remove cg...
602
603
  static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
  {
fdce6bf8c   Tejun Heo   cgroup: remove NU...
604
  	pr_cont_kernfs_name(cgrp->kn);
e61734c55   Tejun Heo   cgroup: remove cg...
605
  }
ddbcc7e8e   Paul Menage   Task Control Grou...
606

e61734c55   Tejun Heo   cgroup: remove cg...
607
  static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
846c7bb05   Balbir Singh   Add cgroupstats
608
  {
fdce6bf8c   Tejun Heo   cgroup: remove NU...
609
  	pr_cont_kernfs_path(cgrp->kn);
846c7bb05   Balbir Singh   Add cgroupstats
610
  }
ddbcc7e8e   Paul Menage   Task Control Grou...
611

77f88796c   Tejun Heo   cgroup, kthread: ...
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
  static inline void cgroup_init_kthreadd(void)
  {
  	/*
  	 * kthreadd is inherited by all kthreads, keep it in the root so
  	 * that the new kthreads are guaranteed to stay in the root until
  	 * initialization is finished.
  	 */
  	current->no_cgroup_migration = 1;
  }
  
  static inline void cgroup_kthread_ready(void)
  {
  	/*
  	 * This kthread finished initialization.  The creator should have
  	 * set PF_NO_SETAFFINITY if this kthread should stay in the root.
  	 */
  	current->no_cgroup_migration = 0;
  }
121508df4   Shaohua Li   cgroup: export fh...
630
631
632
633
  static inline union kernfs_node_id *cgroup_get_kernfs_id(struct cgroup *cgrp)
  {
  	return &cgrp->kn->id;
  }
69fd5c391   Shaohua Li   blktrace: add an ...
634
635
636
  
  void cgroup_path_from_kernfs_id(const union kernfs_node_id *id,
  					char *buf, size_t buflen);
ddbcc7e8e   Paul Menage   Task Control Grou...
637
  #else /* !CONFIG_CGROUPS */
f3ba53802   Tejun Heo   cgroup: add dummy...
638
  struct cgroup_subsys_state;
aed704b7a   Sargun Dhillon   cgroup: Add task_...
639
  struct cgroup;
f3ba53802   Tejun Heo   cgroup: add dummy...
640

c326aa2bb   Tejun Heo   cgroup: reorganiz...
641
  static inline void css_put(struct cgroup_subsys_state *css) {}
31583bb0c   Michael S. Tsirkin   cgroups: fix API ...
642
  static inline int cgroup_attach_task_all(struct task_struct *from,
c326aa2bb   Tejun Heo   cgroup: reorganiz...
643
644
645
  					 struct task_struct *t) { return 0; }
  static inline int cgroupstats_build(struct cgroupstats *stats,
  				    struct dentry *dentry) { return -EINVAL; }
b4f48b636   Paul Menage   Task Control Grou...
646
  static inline void cgroup_fork(struct task_struct *p) {}
b53202e63   Oleg Nesterov   cgroup: kill cgrp...
647
648
649
  static inline int cgroup_can_fork(struct task_struct *p) { return 0; }
  static inline void cgroup_cancel_fork(struct task_struct *p) {}
  static inline void cgroup_post_fork(struct task_struct *p) {}
1ec41830e   Li Zefan   cgroup: remove us...
650
  static inline void cgroup_exit(struct task_struct *p) {}
2e91fa7f6   Tejun Heo   cgroup: keep zomb...
651
  static inline void cgroup_free(struct task_struct *p) {}
ddbcc7e8e   Paul Menage   Task Control Grou...
652

c326aa2bb   Tejun Heo   cgroup: reorganiz...
653
654
  static inline int cgroup_init_early(void) { return 0; }
  static inline int cgroup_init(void) { return 0; }
77f88796c   Tejun Heo   cgroup, kthread: ...
655
656
  static inline void cgroup_init_kthreadd(void) {}
  static inline void cgroup_kthread_ready(void) {}
121508df4   Shaohua Li   cgroup: export fh...
657
658
659
660
  static inline union kernfs_node_id *cgroup_get_kernfs_id(struct cgroup *cgrp)
  {
  	return NULL;
  }
d7926ee38   Sridhar Samudrala   cgroups: Add an A...
661

aed704b7a   Sargun Dhillon   cgroup: Add task_...
662
663
664
665
666
  static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
  					       struct cgroup *ancestor)
  {
  	return true;
  }
69fd5c391   Shaohua Li   blktrace: add an ...
667
668
669
  
  static inline void cgroup_path_from_kernfs_id(const union kernfs_node_id *id,
  	char *buf, size_t buflen) {}
ddbcc7e8e   Paul Menage   Task Control Grou...
670
  #endif /* !CONFIG_CGROUPS */
bd1060a1d   Tejun Heo   sock, cgroup: add...
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
  /*
   * sock->sk_cgrp_data handling.  For more info, see sock_cgroup_data
   * definition in cgroup-defs.h.
   */
  #ifdef CONFIG_SOCK_CGROUP_DATA
  
  #if defined(CONFIG_CGROUP_NET_PRIO) || defined(CONFIG_CGROUP_NET_CLASSID)
  extern spinlock_t cgroup_sk_update_lock;
  #endif
  
  void cgroup_sk_alloc_disable(void);
  void cgroup_sk_alloc(struct sock_cgroup_data *skcd);
  void cgroup_sk_free(struct sock_cgroup_data *skcd);
  
  static inline struct cgroup *sock_cgroup_ptr(struct sock_cgroup_data *skcd)
  {
  #if defined(CONFIG_CGROUP_NET_PRIO) || defined(CONFIG_CGROUP_NET_CLASSID)
  	unsigned long v;
  
  	/*
  	 * @skcd->val is 64bit but the following is safe on 32bit too as we
  	 * just need the lower ulong to be written and read atomically.
  	 */
  	v = READ_ONCE(skcd->val);
  
  	if (v & 1)
  		return &cgrp_dfl_root.cgrp;
  
  	return (struct cgroup *)(unsigned long)v ?: &cgrp_dfl_root.cgrp;
  #else
  	return (struct cgroup *)(unsigned long)skcd->val;
  #endif
  }
  
  #else	/* CONFIG_CGROUP_DATA */
  
  static inline void cgroup_sk_alloc(struct sock_cgroup_data *skcd) {}
  static inline void cgroup_sk_free(struct sock_cgroup_data *skcd) {}
  
  #endif	/* CONFIG_CGROUP_DATA */
a79a908fd   Aditya Kali   cgroup: introduce...
711
  struct cgroup_namespace {
387ad9674   Elena Reshetova   kernel: convert c...
712
  	refcount_t		count;
a79a908fd   Aditya Kali   cgroup: introduce...
713
714
  	struct ns_common	ns;
  	struct user_namespace	*user_ns;
d08311dd6   Eric W. Biederman   cgroupns: Add a l...
715
  	struct ucounts		*ucounts;
a79a908fd   Aditya Kali   cgroup: introduce...
716
717
718
719
720
721
722
723
724
725
726
727
  	struct css_set          *root_cset;
  };
  
  extern struct cgroup_namespace init_cgroup_ns;
  
  #ifdef CONFIG_CGROUPS
  
  void free_cgroup_ns(struct cgroup_namespace *ns);
  
  struct cgroup_namespace *copy_cgroup_ns(unsigned long flags,
  					struct user_namespace *user_ns,
  					struct cgroup_namespace *old_ns);
4c737b41d   Tejun Heo   cgroup: make cgro...
728
729
  int cgroup_path_ns(struct cgroup *cgrp, char *buf, size_t buflen,
  		   struct cgroup_namespace *ns);
a79a908fd   Aditya Kali   cgroup: introduce...
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
  
  #else /* !CONFIG_CGROUPS */
  
  static inline void free_cgroup_ns(struct cgroup_namespace *ns) { }
  static inline struct cgroup_namespace *
  copy_cgroup_ns(unsigned long flags, struct user_namespace *user_ns,
  	       struct cgroup_namespace *old_ns)
  {
  	return old_ns;
  }
  
  #endif /* !CONFIG_CGROUPS */
  
  static inline void get_cgroup_ns(struct cgroup_namespace *ns)
  {
  	if (ns)
387ad9674   Elena Reshetova   kernel: convert c...
746
  		refcount_inc(&ns->count);
a79a908fd   Aditya Kali   cgroup: introduce...
747
748
749
750
  }
  
  static inline void put_cgroup_ns(struct cgroup_namespace *ns)
  {
387ad9674   Elena Reshetova   kernel: convert c...
751
  	if (ns && refcount_dec_and_test(&ns->count))
a79a908fd   Aditya Kali   cgroup: introduce...
752
753
  		free_cgroup_ns(ns);
  }
ddbcc7e8e   Paul Menage   Task Control Grou...
754
  #endif /* _LINUX_CGROUP_H */