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