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