Merge tag 'kbuild-v5.3-2' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy...
[linux-2.6-block.git] / include / linux / cgroup.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
ddbcc7e8
PM
2#ifndef _LINUX_CGROUP_H
3#define _LINUX_CGROUP_H
4/*
5 * cgroup interface
6 *
7 * Copyright (C) 2003 BULL SA
8 * Copyright (C) 2004-2006 Silicon Graphics, Inc.
9 *
10 */
11
12#include <linux/sched.h>
ddbcc7e8
PM
13#include <linux/cpumask.h>
14#include <linux/nodemask.h>
eb6fd504 15#include <linux/rculist.h>
846c7bb0 16#include <linux/cgroupstats.h>
25a7e684 17#include <linux/fs.h>
7da11279 18#include <linux/seq_file.h>
2bd59d48 19#include <linux/kernfs.h>
49d1dc4b 20#include <linux/jump_label.h>
a79a908f
AK
21#include <linux/types.h>
22#include <linux/ns_common.h>
23#include <linux/nsproxy.h>
24#include <linux/user_namespace.h>
387ad967 25#include <linux/refcount.h>
d2cc5ed6 26#include <linux/kernel_stat.h>
ddbcc7e8 27
b4a04ab7 28#include <linux/cgroup-defs.h>
ddbcc7e8
PM
29
30#ifdef CONFIG_CGROUPS
31
6abc8ca1
TH
32/*
33 * All weight knobs on the default hierarhcy should use the following min,
34 * default and max values. The default value is the logarithmic center of
35 * MIN and MAX and allows 100x to be expressed in both directions.
36 */
37#define CGROUP_WEIGHT_MIN 1
38#define CGROUP_WEIGHT_DFL 100
39#define CGROUP_WEIGHT_MAX 10000
40
bc2fb7ed
TH
41/* walk only threadgroup leaders */
42#define CSS_TASK_ITER_PROCS (1U << 0)
450ee0c1
TH
43/* walk all threaded css_sets in the domain */
44#define CSS_TASK_ITER_THREADED (1U << 1)
bc2fb7ed 45
b636fd38
TH
46/* internal flags */
47#define CSS_TASK_ITER_SKIPPED (1U << 16)
48
c326aa2b
TH
49/* a css_task_iter should be treated as an opaque object */
50struct css_task_iter {
51 struct cgroup_subsys *ss;
bc2fb7ed 52 unsigned int flags;
c326aa2b
TH
53
54 struct list_head *cset_pos;
55 struct list_head *cset_head;
ddbcc7e8 56
450ee0c1
TH
57 struct list_head *tcset_pos;
58 struct list_head *tcset_head;
59
c326aa2b
TH
60 struct list_head *task_pos;
61 struct list_head *tasks_head;
62 struct list_head *mg_tasks_head;
c03cd773 63 struct list_head *dying_tasks_head;
ed27b9f7
TH
64
65 struct css_set *cur_cset;
450ee0c1 66 struct css_set *cur_dcset;
ed27b9f7
TH
67 struct task_struct *cur_task;
68 struct list_head iters_node; /* css_set->task_iters */
c326aa2b 69};
ddbcc7e8 70
c326aa2b
TH
71extern struct cgroup_root cgrp_dfl_root;
72extern struct css_set init_css_set;
a424316c 73
c326aa2b 74#define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
817929ec 75#include <linux/cgroup_subsys.h>
817929ec
PM
76#undef SUBSYS
77
49d1dc4b
TH
78#define SUBSYS(_x) \
79 extern struct static_key_true _x ## _cgrp_subsys_enabled_key; \
80 extern struct static_key_true _x ## _cgrp_subsys_on_dfl_key;
81#include <linux/cgroup_subsys.h>
82#undef SUBSYS
83
84/**
85 * cgroup_subsys_enabled - fast test on whether a subsys is enabled
86 * @ss: subsystem in question
87 */
88#define cgroup_subsys_enabled(ss) \
89 static_branch_likely(&ss ## _enabled_key)
90
91/**
92 * cgroup_subsys_on_dfl - fast test on whether a subsys is on default hierarchy
93 * @ss: subsystem in question
94 */
95#define cgroup_subsys_on_dfl(ss) \
96 static_branch_likely(&ss ## _on_dfl_key)
97
c326aa2b
TH
98bool css_has_online_children(struct cgroup_subsys_state *css);
99struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
fc5a828b
DZ
100struct cgroup_subsys_state *cgroup_e_css(struct cgroup *cgroup,
101 struct cgroup_subsys *ss);
c326aa2b
TH
102struct cgroup_subsys_state *cgroup_get_e_css(struct cgroup *cgroup,
103 struct cgroup_subsys *ss);
104struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
105 struct cgroup_subsys *ss);
106
16af4396 107struct cgroup *cgroup_get_from_path(const char *path);
1f3fe7eb 108struct cgroup *cgroup_get_from_fd(int fd);
16af4396 109
c326aa2b
TH
110int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
111int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
112
113int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
114int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
115int cgroup_rm_cftypes(struct cftype *cfts);
34c06254 116void cgroup_file_notify(struct cgroup_file *cfile);
c326aa2b 117
4c737b41 118int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
c326aa2b
TH
119int cgroupstats_build(struct cgroupstats *stats, struct dentry *dentry);
120int proc_cgroup_show(struct seq_file *m, struct pid_namespace *ns,
121 struct pid *pid, struct task_struct *tsk);
122
123void cgroup_fork(struct task_struct *p);
b53202e6
ON
124extern int cgroup_can_fork(struct task_struct *p);
125extern void cgroup_cancel_fork(struct task_struct *p);
126extern void cgroup_post_fork(struct task_struct *p);
c326aa2b 127void cgroup_exit(struct task_struct *p);
51bee5ab 128void cgroup_release(struct task_struct *p);
2e91fa7f 129void cgroup_free(struct task_struct *p);
c326aa2b
TH
130
131int cgroup_init_early(void);
132int cgroup_init(void);
133
a5e112e6
TH
134int cgroup_parse_float(const char *input, unsigned dec_shift, s64 *v);
135
5c9d535b 136/*
c326aa2b
TH
137 * Iteration helpers and macros.
138 */
139
140struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
141 struct cgroup_subsys_state *parent);
142struct cgroup_subsys_state *css_next_descendant_pre(struct cgroup_subsys_state *pos,
143 struct cgroup_subsys_state *css);
144struct cgroup_subsys_state *css_rightmost_descendant(struct cgroup_subsys_state *pos);
145struct cgroup_subsys_state *css_next_descendant_post(struct cgroup_subsys_state *pos,
146 struct cgroup_subsys_state *css);
147
1f7dd3e5
TH
148struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset,
149 struct cgroup_subsys_state **dst_cssp);
150struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset,
151 struct cgroup_subsys_state **dst_cssp);
c326aa2b 152
bc2fb7ed 153void css_task_iter_start(struct cgroup_subsys_state *css, unsigned int flags,
c326aa2b
TH
154 struct css_task_iter *it);
155struct task_struct *css_task_iter_next(struct css_task_iter *it);
156void css_task_iter_end(struct css_task_iter *it);
157
158/**
159 * css_for_each_child - iterate through children of a css
160 * @pos: the css * to use as the loop cursor
161 * @parent: css whose children to walk
162 *
163 * Walk @parent's children. Must be called under rcu_read_lock().
164 *
165 * If a subsystem synchronizes ->css_online() and the start of iteration, a
166 * css which finished ->css_online() is guaranteed to be visible in the
167 * future iterations and will stay visible until the last reference is put.
168 * A css which hasn't finished ->css_online() or already finished
169 * ->css_offline() may show up during traversal. It's each subsystem's
170 * responsibility to synchronize against on/offlining.
5c9d535b 171 *
c326aa2b
TH
172 * It is allowed to temporarily drop RCU read lock during iteration. The
173 * caller is responsible for ensuring that @pos remains accessible until
174 * the start of the next iteration by, for example, bumping the css refcnt.
5c9d535b 175 */
c326aa2b
TH
176#define css_for_each_child(pos, parent) \
177 for ((pos) = css_next_child(NULL, (parent)); (pos); \
178 (pos) = css_next_child((pos), (parent)))
ddbcc7e8 179
c326aa2b
TH
180/**
181 * css_for_each_descendant_pre - pre-order walk of a css's descendants
182 * @pos: the css * to use as the loop cursor
183 * @root: css whose descendants to walk
184 *
185 * Walk @root's descendants. @root is included in the iteration and the
186 * first node to be visited. Must be called under rcu_read_lock().
187 *
188 * If a subsystem synchronizes ->css_online() and the start of iteration, a
189 * css which finished ->css_online() is guaranteed to be visible in the
190 * future iterations and will stay visible until the last reference is put.
191 * A css which hasn't finished ->css_online() or already finished
192 * ->css_offline() may show up during traversal. It's each subsystem's
193 * responsibility to synchronize against on/offlining.
194 *
195 * For example, the following guarantees that a descendant can't escape
196 * state updates of its ancestors.
197 *
198 * my_online(@css)
199 * {
200 * Lock @css's parent and @css;
201 * Inherit state from the parent;
202 * Unlock both.
203 * }
204 *
205 * my_update_state(@css)
206 * {
207 * css_for_each_descendant_pre(@pos, @css) {
208 * Lock @pos;
209 * if (@pos == @css)
210 * Update @css's state;
211 * else
212 * Verify @pos is alive and inherit state from its parent;
213 * Unlock @pos;
214 * }
215 * }
216 *
217 * As long as the inheriting step, including checking the parent state, is
218 * enclosed inside @pos locking, double-locking the parent isn't necessary
219 * while inheriting. The state update to the parent is guaranteed to be
220 * visible by walking order and, as long as inheriting operations to the
221 * same @pos are atomic to each other, multiple updates racing each other
222 * still result in the correct state. It's guaranateed that at least one
223 * inheritance happens for any css after the latest update to its parent.
224 *
225 * If checking parent's state requires locking the parent, each inheriting
226 * iteration should lock and unlock both @pos->parent and @pos.
227 *
228 * Alternatively, a subsystem may choose to use a single global lock to
229 * synchronize ->css_online() and ->css_offline() against tree-walking
230 * operations.
231 *
232 * It is allowed to temporarily drop RCU read lock during iteration. The
233 * caller is responsible for ensuring that @pos remains accessible until
234 * the start of the next iteration by, for example, bumping the css refcnt.
235 */
236#define css_for_each_descendant_pre(pos, css) \
237 for ((pos) = css_next_descendant_pre(NULL, (css)); (pos); \
238 (pos) = css_next_descendant_pre((pos), (css)))
239
240/**
241 * css_for_each_descendant_post - post-order walk of a css's descendants
242 * @pos: the css * to use as the loop cursor
243 * @css: css whose descendants to walk
244 *
245 * Similar to css_for_each_descendant_pre() but performs post-order
246 * traversal instead. @root is included in the iteration and the last
247 * node to be visited.
248 *
249 * If a subsystem synchronizes ->css_online() and the start of iteration, a
250 * css which finished ->css_online() is guaranteed to be visible in the
251 * future iterations and will stay visible until the last reference is put.
252 * A css which hasn't finished ->css_online() or already finished
253 * ->css_offline() may show up during traversal. It's each subsystem's
254 * responsibility to synchronize against on/offlining.
255 *
256 * Note that the walk visibility guarantee example described in pre-order
257 * walk doesn't apply the same to post-order walks.
258 */
259#define css_for_each_descendant_post(pos, css) \
260 for ((pos) = css_next_descendant_post(NULL, (css)); (pos); \
261 (pos) = css_next_descendant_post((pos), (css)))
262
263/**
264 * cgroup_taskset_for_each - iterate cgroup_taskset
265 * @task: the loop cursor
1f7dd3e5 266 * @dst_css: the destination css
c326aa2b 267 * @tset: taskset to iterate
4530eddb
TH
268 *
269 * @tset may contain multiple tasks and they may belong to multiple
1f7dd3e5
TH
270 * processes.
271 *
272 * On the v2 hierarchy, there may be tasks from multiple processes and they
273 * may not share the source or destination csses.
274 *
275 * On traditional hierarchies, when there are multiple tasks in @tset, if a
276 * task of a process is in @tset, all tasks of the process are in @tset.
277 * Also, all are guaranteed to share the same source and destination csses.
4530eddb
TH
278 *
279 * Iteration is not in any specific order.
c326aa2b 280 */
1f7dd3e5
TH
281#define cgroup_taskset_for_each(task, dst_css, tset) \
282 for ((task) = cgroup_taskset_first((tset), &(dst_css)); \
283 (task); \
284 (task) = cgroup_taskset_next((tset), &(dst_css)))
ddbcc7e8 285
4530eddb
TH
286/**
287 * cgroup_taskset_for_each_leader - iterate group leaders in a cgroup_taskset
288 * @leader: the loop cursor
1f7dd3e5 289 * @dst_css: the destination css
7b4632f0 290 * @tset: taskset to iterate
4530eddb
TH
291 *
292 * Iterate threadgroup leaders of @tset. For single-task migrations, @tset
293 * may not contain any.
294 */
1f7dd3e5
TH
295#define cgroup_taskset_for_each_leader(leader, dst_css, tset) \
296 for ((leader) = cgroup_taskset_first((tset), &(dst_css)); \
297 (leader); \
298 (leader) = cgroup_taskset_next((tset), &(dst_css))) \
4530eddb
TH
299 if ((leader) != (leader)->group_leader) \
300 ; \
301 else
302
c326aa2b
TH
303/*
304 * Inline functions.
305 */
ddbcc7e8 306
5de0107e
TH
307/**
308 * css_get - obtain a reference on the specified css
309 * @css: target css
310 *
311 * The caller must already have a reference.
ddbcc7e8 312 */
ddbcc7e8
PM
313static inline void css_get(struct cgroup_subsys_state *css)
314{
3b514d24
TH
315 if (!(css->flags & CSS_NO_REF))
316 percpu_ref_get(&css->refcnt);
ddbcc7e8 317}
e7c5ec91 318
e8ea14cc
JW
319/**
320 * css_get_many - obtain references on the specified css
321 * @css: target css
322 * @n: number of references to get
323 *
324 * The caller must already have a reference.
325 */
326static inline void css_get_many(struct cgroup_subsys_state *css, unsigned int n)
327{
328 if (!(css->flags & CSS_NO_REF))
329 percpu_ref_get_many(&css->refcnt, n);
330}
331
6f4524d3
TH
332/**
333 * css_tryget - try to obtain a reference on the specified css
334 * @css: target css
335 *
336 * Obtain a reference on @css unless it already has reached zero and is
337 * being released. This function doesn't care whether @css is on or
338 * offline. The caller naturally needs to ensure that @css is accessible
339 * but doesn't have to be holding a reference on it - IOW, RCU protected
340 * access is good enough for this function. Returns %true if a reference
341 * count was successfully obtained; %false otherwise.
342 */
343static inline bool css_tryget(struct cgroup_subsys_state *css)
344{
345 if (!(css->flags & CSS_NO_REF))
346 return percpu_ref_tryget(&css->refcnt);
347 return true;
348}
349
5de0107e 350/**
ec903c0c 351 * css_tryget_online - try to obtain a reference on the specified css if online
5de0107e
TH
352 * @css: target css
353 *
ec903c0c
TH
354 * Obtain a reference on @css if it's online. The caller naturally needs
355 * to ensure that @css is accessible but doesn't have to be holding a
5de0107e
TH
356 * reference on it - IOW, RCU protected access is good enough for this
357 * function. Returns %true if a reference count was successfully obtained;
358 * %false otherwise.
359 */
ec903c0c 360static inline bool css_tryget_online(struct cgroup_subsys_state *css)
e7c5ec91 361{
3b514d24
TH
362 if (!(css->flags & CSS_NO_REF))
363 return percpu_ref_tryget_live(&css->refcnt);
364 return true;
e7c5ec91 365}
2f7ee569 366
41c25707
TH
367/**
368 * css_is_dying - test whether the specified css is dying
369 * @css: target css
370 *
371 * Test whether @css is in the process of offlining or already offline. In
372 * most cases, ->css_online() and ->css_offline() callbacks should be
373 * enough; however, the actual offline operations are RCU delayed and this
374 * test returns %true also when @css is scheduled to be offlined.
375 *
376 * This is useful, for example, when the use case requires synchronous
377 * behavior with respect to cgroup removal. cgroup removal schedules css
378 * offlining but the css can seem alive while the operation is being
379 * delayed. If the delay affects user visible semantics, this test can be
380 * used to resolve the situation.
381 */
382static inline bool css_is_dying(struct cgroup_subsys_state *css)
383{
384 return !(css->flags & CSS_NO_REF) && percpu_ref_is_dying(&css->refcnt);
385}
386
2f7ee569 387/**
5de0107e
TH
388 * css_put - put a css reference
389 * @css: target css
390 *
ec903c0c 391 * Put a reference obtained via css_get() and css_tryget_online().
2f7ee569 392 */
ddbcc7e8
PM
393static inline void css_put(struct cgroup_subsys_state *css)
394{
3b514d24
TH
395 if (!(css->flags & CSS_NO_REF))
396 percpu_ref_put(&css->refcnt);
ddbcc7e8 397}
2f7ee569 398
e8ea14cc
JW
399/**
400 * css_put_many - put css references
401 * @css: target css
402 * @n: number of references to put
403 *
404 * Put references obtained via css_get() and css_tryget_online().
21acb9ca 405 */
e8ea14cc
JW
406static inline void css_put_many(struct cgroup_subsys_state *css, unsigned int n)
407{
408 if (!(css->flags & CSS_NO_REF))
409 percpu_ref_put_many(&css->refcnt, n);
410}
ddbcc7e8 411
3e48930c
TH
412static inline void cgroup_get(struct cgroup *cgrp)
413{
414 css_get(&cgrp->self);
415}
416
417static inline bool cgroup_tryget(struct cgroup *cgrp)
418{
419 return css_tryget(&cgrp->self);
420}
421
16af4396
TH
422static inline void cgroup_put(struct cgroup *cgrp)
423{
424 css_put(&cgrp->self);
425}
426
14611e51
TH
427/**
428 * task_css_set_check - obtain a task's css_set with extra access conditions
429 * @task: the task to obtain css_set for
430 * @__c: extra condition expression to be passed to rcu_dereference_check()
431 *
432 * A task's css_set is RCU protected, initialized and exited while holding
433 * task_lock(), and can only be modified while holding both cgroup_mutex
434 * and task_lock() while the task is alive. This macro verifies that the
435 * caller is inside proper critical section and returns @task's css_set.
436 *
437 * The caller can also specify additional allowed conditions via @__c, such
438 * as locks used during the cgroup_subsys::attach() methods.
dc61b1d6 439 */
2219449a
TH
440#ifdef CONFIG_PROVE_RCU
441extern struct mutex cgroup_mutex;
f0d9a5f1 442extern spinlock_t css_set_lock;
14611e51
TH
443#define task_css_set_check(task, __c) \
444 rcu_dereference_check((task)->cgroups, \
0e1d768f 445 lockdep_is_held(&cgroup_mutex) || \
f0d9a5f1 446 lockdep_is_held(&css_set_lock) || \
0e1d768f 447 ((task)->flags & PF_EXITING) || (__c))
2219449a 448#else
14611e51
TH
449#define task_css_set_check(task, __c) \
450 rcu_dereference((task)->cgroups)
2219449a 451#endif
dc61b1d6 452
14611e51 453/**
8af01f56 454 * task_css_check - obtain css for (task, subsys) w/ extra access conds
14611e51
TH
455 * @task: the target task
456 * @subsys_id: the target subsystem ID
457 * @__c: extra condition expression to be passed to rcu_dereference_check()
458 *
459 * Return the cgroup_subsys_state for the (@task, @subsys_id) pair. The
460 * synchronization rules are the same as task_css_set_check().
461 */
8af01f56 462#define task_css_check(task, subsys_id, __c) \
14611e51
TH
463 task_css_set_check((task), (__c))->subsys[(subsys_id)]
464
465/**
466 * task_css_set - obtain a task's css_set
467 * @task: the task to obtain css_set for
468 *
469 * See task_css_set_check().
470 */
471static inline struct css_set *task_css_set(struct task_struct *task)
472{
473 return task_css_set_check(task, false);
474}
475
476/**
8af01f56 477 * task_css - obtain css for (task, subsys)
14611e51
TH
478 * @task: the target task
479 * @subsys_id: the target subsystem ID
480 *
8af01f56 481 * See task_css_check().
14611e51 482 */
8af01f56
TH
483static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
484 int subsys_id)
ddbcc7e8 485{
8af01f56 486 return task_css_check(task, subsys_id, false);
ddbcc7e8
PM
487}
488
ec438699
TH
489/**
490 * task_get_css - find and get the css for (task, subsys)
491 * @task: the target task
492 * @subsys_id: the target subsystem ID
493 *
494 * Find the css for the (@task, @subsys_id) combination, increment a
495 * reference on and return it. This function is guaranteed to return a
18fa84a2 496 * valid css. The returned css may already have been offlined.
ec438699
TH
497 */
498static inline struct cgroup_subsys_state *
499task_get_css(struct task_struct *task, int subsys_id)
500{
501 struct cgroup_subsys_state *css;
502
503 rcu_read_lock();
504 while (true) {
505 css = task_css(task, subsys_id);
18fa84a2
TH
506 /*
507 * Can't use css_tryget_online() here. A task which has
508 * PF_EXITING set may stay associated with an offline css.
509 * If such task calls this function, css_tryget_online()
510 * will keep failing.
511 */
512 if (likely(css_tryget(css)))
ec438699
TH
513 break;
514 cpu_relax();
515 }
516 rcu_read_unlock();
517 return css;
518}
519
5024ae29
TH
520/**
521 * task_css_is_root - test whether a task belongs to the root css
522 * @task: the target task
523 * @subsys_id: the target subsystem ID
524 *
525 * Test whether @task belongs to the root css on the specified subsystem.
526 * May be invoked in any context.
527 */
528static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
529{
530 return task_css_check(task, subsys_id, true) ==
531 init_css_set.subsys[subsys_id];
532}
533
8af01f56
TH
534static inline struct cgroup *task_cgroup(struct task_struct *task,
535 int subsys_id)
ddbcc7e8 536{
8af01f56 537 return task_css(task, subsys_id)->cgroup;
ddbcc7e8
PM
538}
539
3e48930c
TH
540static inline struct cgroup *task_dfl_cgroup(struct task_struct *task)
541{
542 return task_css_set(task)->dfl_cgrp;
543}
544
545static inline struct cgroup *cgroup_parent(struct cgroup *cgrp)
546{
547 struct cgroup_subsys_state *parent_css = cgrp->self.parent;
548
549 if (parent_css)
550 return container_of(parent_css, struct cgroup, self);
551 return NULL;
552}
553
b11cfb58
TH
554/**
555 * cgroup_is_descendant - test ancestry
556 * @cgrp: the cgroup to be tested
557 * @ancestor: possible ancestor of @cgrp
558 *
559 * Test whether @cgrp is a descendant of @ancestor. It also returns %true
560 * if @cgrp == @ancestor. This function is safe to call as long as @cgrp
561 * and @ancestor are accessible.
562 */
563static inline bool cgroup_is_descendant(struct cgroup *cgrp,
564 struct cgroup *ancestor)
565{
566 if (cgrp->root != ancestor->root || cgrp->level < ancestor->level)
567 return false;
568 return cgrp->ancestor_ids[ancestor->level] == ancestor->id;
569}
570
77236281
AI
571/**
572 * cgroup_ancestor - find ancestor of cgroup
573 * @cgrp: cgroup to find ancestor of
574 * @ancestor_level: level of ancestor to find starting from root
575 *
576 * Find ancestor of cgroup at specified level starting from root if it exists
577 * and return pointer to it. Return NULL if @cgrp doesn't have ancestor at
578 * @ancestor_level.
579 *
580 * This function is safe to call as long as @cgrp is accessible.
581 */
582static inline struct cgroup *cgroup_ancestor(struct cgroup *cgrp,
583 int ancestor_level)
584{
77236281
AI
585 if (cgrp->level < ancestor_level)
586 return NULL;
808c43b7
AI
587 while (cgrp && cgrp->level > ancestor_level)
588 cgrp = cgroup_parent(cgrp);
589 return cgrp;
77236281
AI
590}
591
aed704b7
SD
592/**
593 * task_under_cgroup_hierarchy - test task's membership of cgroup ancestry
594 * @task: the task to be tested
595 * @ancestor: possible ancestor of @task's cgroup
596 *
597 * Tests whether @task's default cgroup hierarchy is a descendant of @ancestor.
598 * It follows all the same rules as cgroup_is_descendant, and only applies
599 * to the default hierarchy.
600 */
601static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
602 struct cgroup *ancestor)
603{
604 struct css_set *cset = task_css_set(task);
605
606 return cgroup_is_descendant(cset->dfl_cgrp, ancestor);
607}
608
07bc356e 609/* no synchronization, the result can only be used as a hint */
27bd4dbb 610static inline bool cgroup_is_populated(struct cgroup *cgrp)
07bc356e 611{
454000ad
TH
612 return cgrp->nr_populated_csets + cgrp->nr_populated_domain_children +
613 cgrp->nr_populated_threaded_children;
07bc356e 614}
f3d46500 615
f29374b1 616/* returns ino associated with a cgroup */
b1664924
TH
617static inline ino_t cgroup_ino(struct cgroup *cgrp)
618{
c53cd490 619 return cgrp->kn->id.ino;
b1664924 620}
3ebb2b6e 621
b4168640
TH
622/* cft/css accessors for cftype->write() operation */
623static inline struct cftype *of_cft(struct kernfs_open_file *of)
7da11279 624{
2bd59d48 625 return of->kn->priv;
7da11279 626}
0f0a2b4f 627
b4168640 628struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
817929ec 629
b4168640
TH
630/* cft/css accessors for cftype->seq_*() operations */
631static inline struct cftype *seq_cft(struct seq_file *seq)
632{
633 return of_cft(seq->private);
634}
e535837b 635
b4168640
TH
636static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
637{
638 return of_css(seq->private);
639}
31583bb0 640
e61734c5
TH
641/*
642 * Name / path handling functions. All are thin wrappers around the kernfs
643 * counterparts and can be called under any context.
644 */
38460b48 645
e61734c5
TH
646static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
647{
fdce6bf8 648 return kernfs_name(cgrp->kn, buf, buflen);
e61734c5 649}
ddbcc7e8 650
4c737b41 651static inline int cgroup_path(struct cgroup *cgrp, char *buf, size_t buflen)
e61734c5 652{
fdce6bf8 653 return kernfs_path(cgrp->kn, buf, buflen);
e61734c5 654}
f3ba5380 655
e61734c5
TH
656static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
657{
fdce6bf8 658 pr_cont_kernfs_name(cgrp->kn);
e61734c5 659}
ddbcc7e8 660
e61734c5 661static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
846c7bb0 662{
fdce6bf8 663 pr_cont_kernfs_path(cgrp->kn);
846c7bb0 664}
ddbcc7e8 665
2ce7135a
JW
666static inline struct psi_group *cgroup_psi(struct cgroup *cgrp)
667{
668 return &cgrp->psi;
669}
670
77f88796
TH
671static inline void cgroup_init_kthreadd(void)
672{
673 /*
674 * kthreadd is inherited by all kthreads, keep it in the root so
675 * that the new kthreads are guaranteed to stay in the root until
676 * initialization is finished.
677 */
678 current->no_cgroup_migration = 1;
679}
680
681static inline void cgroup_kthread_ready(void)
682{
683 /*
684 * This kthread finished initialization. The creator should have
685 * set PF_NO_SETAFFINITY if this kthread should stay in the root.
686 */
687 current->no_cgroup_migration = 0;
688}
689
121508df
SL
690static inline union kernfs_node_id *cgroup_get_kernfs_id(struct cgroup *cgrp)
691{
692 return &cgrp->kn->id;
693}
69fd5c39
SL
694
695void cgroup_path_from_kernfs_id(const union kernfs_node_id *id,
696 char *buf, size_t buflen);
ddbcc7e8
PM
697#else /* !CONFIG_CGROUPS */
698
f3ba5380 699struct cgroup_subsys_state;
aed704b7 700struct cgroup;
f3ba5380 701
9b0eb69b 702static inline void css_get(struct cgroup_subsys_state *css) {}
c326aa2b 703static inline void css_put(struct cgroup_subsys_state *css) {}
31583bb0 704static inline int cgroup_attach_task_all(struct task_struct *from,
c326aa2b
TH
705 struct task_struct *t) { return 0; }
706static inline int cgroupstats_build(struct cgroupstats *stats,
707 struct dentry *dentry) { return -EINVAL; }
708
b4f48b63 709static inline void cgroup_fork(struct task_struct *p) {}
b53202e6
ON
710static inline int cgroup_can_fork(struct task_struct *p) { return 0; }
711static inline void cgroup_cancel_fork(struct task_struct *p) {}
712static inline void cgroup_post_fork(struct task_struct *p) {}
1ec41830 713static inline void cgroup_exit(struct task_struct *p) {}
51bee5ab 714static inline void cgroup_release(struct task_struct *p) {}
2e91fa7f 715static inline void cgroup_free(struct task_struct *p) {}
ddbcc7e8 716
c326aa2b
TH
717static inline int cgroup_init_early(void) { return 0; }
718static inline int cgroup_init(void) { return 0; }
77f88796
TH
719static inline void cgroup_init_kthreadd(void) {}
720static inline void cgroup_kthread_ready(void) {}
121508df
SL
721static inline union kernfs_node_id *cgroup_get_kernfs_id(struct cgroup *cgrp)
722{
723 return NULL;
724}
d7926ee3 725
2ce7135a
JW
726static inline struct cgroup *cgroup_parent(struct cgroup *cgrp)
727{
728 return NULL;
729}
730
731static inline struct psi_group *cgroup_psi(struct cgroup *cgrp)
732{
733 return NULL;
734}
735
aed704b7
SD
736static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
737 struct cgroup *ancestor)
738{
739 return true;
740}
69fd5c39
SL
741
742static inline void cgroup_path_from_kernfs_id(const union kernfs_node_id *id,
743 char *buf, size_t buflen) {}
ddbcc7e8
PM
744#endif /* !CONFIG_CGROUPS */
745
6162cef0 746#ifdef CONFIG_CGROUPS
d2cc5ed6 747/*
6162cef0 748 * cgroup scalable recursive statistics.
d2cc5ed6 749 */
6162cef0
TH
750void cgroup_rstat_updated(struct cgroup *cgrp, int cpu);
751void cgroup_rstat_flush(struct cgroup *cgrp);
0fa294fb 752void cgroup_rstat_flush_irqsafe(struct cgroup *cgrp);
6162cef0
TH
753void cgroup_rstat_flush_hold(struct cgroup *cgrp);
754void cgroup_rstat_flush_release(void);
d2cc5ed6 755
6162cef0
TH
756/*
757 * Basic resource stats.
758 */
d2cc5ed6
TH
759#ifdef CONFIG_CGROUP_CPUACCT
760void cpuacct_charge(struct task_struct *tsk, u64 cputime);
761void cpuacct_account_field(struct task_struct *tsk, int index, u64 val);
762#else
763static inline void cpuacct_charge(struct task_struct *tsk, u64 cputime) {}
764static inline void cpuacct_account_field(struct task_struct *tsk, int index,
765 u64 val) {}
766#endif
767
041cd640
TH
768void __cgroup_account_cputime(struct cgroup *cgrp, u64 delta_exec);
769void __cgroup_account_cputime_field(struct cgroup *cgrp,
770 enum cpu_usage_stat index, u64 delta_exec);
771
d2cc5ed6
TH
772static inline void cgroup_account_cputime(struct task_struct *task,
773 u64 delta_exec)
774{
041cd640
TH
775 struct cgroup *cgrp;
776
d2cc5ed6 777 cpuacct_charge(task, delta_exec);
041cd640
TH
778
779 rcu_read_lock();
780 cgrp = task_dfl_cgroup(task);
781 if (cgroup_parent(cgrp))
782 __cgroup_account_cputime(cgrp, delta_exec);
783 rcu_read_unlock();
d2cc5ed6
TH
784}
785
786static inline void cgroup_account_cputime_field(struct task_struct *task,
787 enum cpu_usage_stat index,
788 u64 delta_exec)
789{
041cd640
TH
790 struct cgroup *cgrp;
791
d2cc5ed6 792 cpuacct_account_field(task, index, delta_exec);
041cd640
TH
793
794 rcu_read_lock();
795 cgrp = task_dfl_cgroup(task);
796 if (cgroup_parent(cgrp))
797 __cgroup_account_cputime_field(cgrp, index, delta_exec);
798 rcu_read_unlock();
d2cc5ed6
TH
799}
800
801#else /* CONFIG_CGROUPS */
802
803static inline void cgroup_account_cputime(struct task_struct *task,
804 u64 delta_exec) {}
805static inline void cgroup_account_cputime_field(struct task_struct *task,
806 enum cpu_usage_stat index,
807 u64 delta_exec) {}
808
809#endif /* CONFIG_CGROUPS */
810
bd1060a1
TH
811/*
812 * sock->sk_cgrp_data handling. For more info, see sock_cgroup_data
813 * definition in cgroup-defs.h.
814 */
815#ifdef CONFIG_SOCK_CGROUP_DATA
816
817#if defined(CONFIG_CGROUP_NET_PRIO) || defined(CONFIG_CGROUP_NET_CLASSID)
818extern spinlock_t cgroup_sk_update_lock;
819#endif
820
821void cgroup_sk_alloc_disable(void);
822void cgroup_sk_alloc(struct sock_cgroup_data *skcd);
823void cgroup_sk_free(struct sock_cgroup_data *skcd);
824
825static inline struct cgroup *sock_cgroup_ptr(struct sock_cgroup_data *skcd)
826{
827#if defined(CONFIG_CGROUP_NET_PRIO) || defined(CONFIG_CGROUP_NET_CLASSID)
828 unsigned long v;
829
830 /*
831 * @skcd->val is 64bit but the following is safe on 32bit too as we
832 * just need the lower ulong to be written and read atomically.
833 */
834 v = READ_ONCE(skcd->val);
835
836 if (v & 1)
837 return &cgrp_dfl_root.cgrp;
838
839 return (struct cgroup *)(unsigned long)v ?: &cgrp_dfl_root.cgrp;
840#else
841 return (struct cgroup *)(unsigned long)skcd->val;
842#endif
843}
844
845#else /* CONFIG_CGROUP_DATA */
846
847static inline void cgroup_sk_alloc(struct sock_cgroup_data *skcd) {}
848static inline void cgroup_sk_free(struct sock_cgroup_data *skcd) {}
849
850#endif /* CONFIG_CGROUP_DATA */
851
a79a908f 852struct cgroup_namespace {
387ad967 853 refcount_t count;
a79a908f
AK
854 struct ns_common ns;
855 struct user_namespace *user_ns;
d08311dd 856 struct ucounts *ucounts;
a79a908f
AK
857 struct css_set *root_cset;
858};
859
860extern struct cgroup_namespace init_cgroup_ns;
861
862#ifdef CONFIG_CGROUPS
863
864void free_cgroup_ns(struct cgroup_namespace *ns);
865
866struct cgroup_namespace *copy_cgroup_ns(unsigned long flags,
867 struct user_namespace *user_ns,
868 struct cgroup_namespace *old_ns);
869
4c737b41
TH
870int cgroup_path_ns(struct cgroup *cgrp, char *buf, size_t buflen,
871 struct cgroup_namespace *ns);
a79a908f
AK
872
873#else /* !CONFIG_CGROUPS */
874
875static inline void free_cgroup_ns(struct cgroup_namespace *ns) { }
876static inline struct cgroup_namespace *
877copy_cgroup_ns(unsigned long flags, struct user_namespace *user_ns,
878 struct cgroup_namespace *old_ns)
879{
880 return old_ns;
881}
882
883#endif /* !CONFIG_CGROUPS */
884
885static inline void get_cgroup_ns(struct cgroup_namespace *ns)
886{
887 if (ns)
387ad967 888 refcount_inc(&ns->count);
a79a908f
AK
889}
890
891static inline void put_cgroup_ns(struct cgroup_namespace *ns)
892{
387ad967 893 if (ns && refcount_dec_and_test(&ns->count))
a79a908f
AK
894 free_cgroup_ns(ns);
895}
896
76f969e8
RG
897#ifdef CONFIG_CGROUPS
898
899void cgroup_enter_frozen(void);
900void cgroup_leave_frozen(bool always_leave);
901void cgroup_update_frozen(struct cgroup *cgrp);
902void cgroup_freeze(struct cgroup *cgrp, bool freeze);
903void cgroup_freezer_migrate_task(struct task_struct *task, struct cgroup *src,
904 struct cgroup *dst);
96b9c592 905
76f969e8
RG
906static inline bool cgroup_task_freeze(struct task_struct *task)
907{
908 bool ret;
909
910 if (task->flags & PF_KTHREAD)
911 return false;
912
913 rcu_read_lock();
914 ret = test_bit(CGRP_FREEZE, &task_dfl_cgroup(task)->flags);
915 rcu_read_unlock();
916
917 return ret;
918}
919
920static inline bool cgroup_task_frozen(struct task_struct *task)
921{
922 return task->frozen;
923}
924
925#else /* !CONFIG_CGROUPS */
926
927static inline void cgroup_enter_frozen(void) { }
928static inline void cgroup_leave_frozen(bool always_leave) { }
929static inline bool cgroup_task_freeze(struct task_struct *task)
930{
931 return false;
932}
933static inline bool cgroup_task_frozen(struct task_struct *task)
934{
935 return false;
936}
937
938#endif /* !CONFIG_CGROUPS */
939
4bfc0bb2
RG
940#ifdef CONFIG_CGROUP_BPF
941static inline void cgroup_bpf_get(struct cgroup *cgrp)
942{
943 percpu_ref_get(&cgrp->bpf.refcnt);
944}
945
946static inline void cgroup_bpf_put(struct cgroup *cgrp)
947{
948 percpu_ref_put(&cgrp->bpf.refcnt);
949}
950
951#else /* CONFIG_CGROUP_BPF */
952
953static inline void cgroup_bpf_get(struct cgroup *cgrp) {}
954static inline void cgroup_bpf_put(struct cgroup *cgrp) {}
955
956#endif /* CONFIG_CGROUP_BPF */
957
ddbcc7e8 958#endif /* _LINUX_CGROUP_H */