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