3c1613a7648cc7b7c2d2f466f434d216515be943
[muen/linux.git] / kernel / cgroup / cgroup-internal.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __CGROUP_INTERNAL_H
3 #define __CGROUP_INTERNAL_H
4
5 #include <linux/cgroup.h>
6 #include <linux/kernfs.h>
7 #include <linux/workqueue.h>
8 #include <linux/list.h>
9 #include <linux/refcount.h>
10 #include <linux/fs_context.h>
11
12 #define TRACE_CGROUP_PATH_LEN 1024
13 extern spinlock_t trace_cgroup_path_lock;
14 extern char trace_cgroup_path[TRACE_CGROUP_PATH_LEN];
15 extern bool cgroup_debug;
16 extern void __init enable_debug_cgroup(void);
17
18 /*
19  * cgroup_path() takes a spin lock. It is good practice not to take
20  * spin locks within trace point handlers, as they are mostly hidden
21  * from normal view. As cgroup_path() can take the kernfs_rename_lock
22  * spin lock, it is best to not call that function from the trace event
23  * handler.
24  *
25  * Note: trace_cgroup_##type##_enabled() is a static branch that will only
26  *       be set when the trace event is enabled.
27  */
28 #define TRACE_CGROUP_PATH(type, cgrp, ...)                              \
29         do {                                                            \
30                 if (trace_cgroup_##type##_enabled()) {                  \
31                         spin_lock(&trace_cgroup_path_lock);             \
32                         cgroup_path(cgrp, trace_cgroup_path,            \
33                                     TRACE_CGROUP_PATH_LEN);             \
34                         trace_cgroup_##type(cgrp, trace_cgroup_path,    \
35                                             ##__VA_ARGS__);             \
36                         spin_unlock(&trace_cgroup_path_lock);           \
37                 }                                                       \
38         } while (0)
39
40 /*
41  * The cgroup filesystem superblock creation/mount context.
42  */
43 struct cgroup_fs_context {
44         struct cgroup_root      *root;
45         unsigned int    flags;                  /* CGRP_ROOT_* flags */
46
47         /* cgroup1 bits */
48         bool            cpuset_clone_children;
49         bool            none;                   /* User explicitly requested empty subsystem */
50         bool            all_ss;                 /* Seen 'all' option */
51         u16             subsys_mask;            /* Selected subsystems */
52         char            *name;                  /* Hierarchy name */
53         char            *release_agent;         /* Path for release notifications */
54 };
55
56 static inline struct cgroup_fs_context *cgroup_fc2context(struct fs_context *fc)
57 {
58         return fc->fs_private;
59 }
60
61 /*
62  * A cgroup can be associated with multiple css_sets as different tasks may
63  * belong to different cgroups on different hierarchies.  In the other
64  * direction, a css_set is naturally associated with multiple cgroups.
65  * This M:N relationship is represented by the following link structure
66  * which exists for each association and allows traversing the associations
67  * from both sides.
68  */
69 struct cgrp_cset_link {
70         /* the cgroup and css_set this link associates */
71         struct cgroup           *cgrp;
72         struct css_set          *cset;
73
74         /* list of cgrp_cset_links anchored at cgrp->cset_links */
75         struct list_head        cset_link;
76
77         /* list of cgrp_cset_links anchored at css_set->cgrp_links */
78         struct list_head        cgrp_link;
79 };
80
81 /* used to track tasks and csets during migration */
82 struct cgroup_taskset {
83         /* the src and dst cset list running through cset->mg_node */
84         struct list_head        src_csets;
85         struct list_head        dst_csets;
86
87         /* the number of tasks in the set */
88         int                     nr_tasks;
89
90         /* the subsys currently being processed */
91         int                     ssid;
92
93         /*
94          * Fields for cgroup_taskset_*() iteration.
95          *
96          * Before migration is committed, the target migration tasks are on
97          * ->mg_tasks of the csets on ->src_csets.  After, on ->mg_tasks of
98          * the csets on ->dst_csets.  ->csets point to either ->src_csets
99          * or ->dst_csets depending on whether migration is committed.
100          *
101          * ->cur_csets and ->cur_task point to the current task position
102          * during iteration.
103          */
104         struct list_head        *csets;
105         struct css_set          *cur_cset;
106         struct task_struct      *cur_task;
107 };
108
109 /* migration context also tracks preloading */
110 struct cgroup_mgctx {
111         /*
112          * Preloaded source and destination csets.  Used to guarantee
113          * atomic success or failure on actual migration.
114          */
115         struct list_head        preloaded_src_csets;
116         struct list_head        preloaded_dst_csets;
117
118         /* tasks and csets to migrate */
119         struct cgroup_taskset   tset;
120
121         /* subsystems affected by migration */
122         u16                     ss_mask;
123 };
124
125 #define CGROUP_TASKSET_INIT(tset)                                               \
126 {                                                                               \
127         .src_csets              = LIST_HEAD_INIT(tset.src_csets),               \
128         .dst_csets              = LIST_HEAD_INIT(tset.dst_csets),               \
129         .csets                  = &tset.src_csets,                              \
130 }
131
132 #define CGROUP_MGCTX_INIT(name)                                                 \
133 {                                                                               \
134         LIST_HEAD_INIT(name.preloaded_src_csets),                               \
135         LIST_HEAD_INIT(name.preloaded_dst_csets),                               \
136         CGROUP_TASKSET_INIT(name.tset),                                         \
137 }
138
139 #define DEFINE_CGROUP_MGCTX(name)                                               \
140         struct cgroup_mgctx name = CGROUP_MGCTX_INIT(name)
141
142 extern struct mutex cgroup_mutex;
143 extern spinlock_t css_set_lock;
144 extern struct cgroup_subsys *cgroup_subsys[];
145 extern struct list_head cgroup_roots;
146 extern struct file_system_type cgroup_fs_type;
147
148 /* iterate across the hierarchies */
149 #define for_each_root(root)                                             \
150         list_for_each_entry((root), &cgroup_roots, root_list)
151
152 /**
153  * for_each_subsys - iterate all enabled cgroup subsystems
154  * @ss: the iteration cursor
155  * @ssid: the index of @ss, CGROUP_SUBSYS_COUNT after reaching the end
156  */
157 #define for_each_subsys(ss, ssid)                                       \
158         for ((ssid) = 0; (ssid) < CGROUP_SUBSYS_COUNT &&                \
159              (((ss) = cgroup_subsys[ssid]) || true); (ssid)++)
160
161 static inline bool cgroup_is_dead(const struct cgroup *cgrp)
162 {
163         return !(cgrp->self.flags & CSS_ONLINE);
164 }
165
166 static inline bool notify_on_release(const struct cgroup *cgrp)
167 {
168         return test_bit(CGRP_NOTIFY_ON_RELEASE, &cgrp->flags);
169 }
170
171 void put_css_set_locked(struct css_set *cset);
172
173 static inline void put_css_set(struct css_set *cset)
174 {
175         unsigned long flags;
176
177         /*
178          * Ensure that the refcount doesn't hit zero while any readers
179          * can see it. Similar to atomic_dec_and_lock(), but for an
180          * rwlock
181          */
182         if (refcount_dec_not_one(&cset->refcount))
183                 return;
184
185         spin_lock_irqsave(&css_set_lock, flags);
186         put_css_set_locked(cset);
187         spin_unlock_irqrestore(&css_set_lock, flags);
188 }
189
190 /*
191  * refcounted get/put for css_set objects
192  */
193 static inline void get_css_set(struct css_set *cset)
194 {
195         refcount_inc(&cset->refcount);
196 }
197
198 bool cgroup_ssid_enabled(int ssid);
199 bool cgroup_on_dfl(const struct cgroup *cgrp);
200 bool cgroup_is_thread_root(struct cgroup *cgrp);
201 bool cgroup_is_threaded(struct cgroup *cgrp);
202
203 struct cgroup_root *cgroup_root_from_kf(struct kernfs_root *kf_root);
204 struct cgroup *task_cgroup_from_root(struct task_struct *task,
205                                      struct cgroup_root *root);
206 struct cgroup *cgroup_kn_lock_live(struct kernfs_node *kn, bool drain_offline);
207 void cgroup_kn_unlock(struct kernfs_node *kn);
208 int cgroup_path_ns_locked(struct cgroup *cgrp, char *buf, size_t buflen,
209                           struct cgroup_namespace *ns);
210
211 void cgroup_free_root(struct cgroup_root *root);
212 void init_cgroup_root(struct cgroup_fs_context *ctx);
213 int cgroup_setup_root(struct cgroup_root *root, u16 ss_mask);
214 int rebind_subsystems(struct cgroup_root *dst_root, u16 ss_mask);
215 struct dentry *cgroup_do_mount(struct file_system_type *fs_type, int flags,
216                                struct cgroup_root *root, unsigned long magic,
217                                struct cgroup_namespace *ns);
218
219 int cgroup_migrate_vet_dst(struct cgroup *dst_cgrp);
220 void cgroup_migrate_finish(struct cgroup_mgctx *mgctx);
221 void cgroup_migrate_add_src(struct css_set *src_cset, struct cgroup *dst_cgrp,
222                             struct cgroup_mgctx *mgctx);
223 int cgroup_migrate_prepare_dst(struct cgroup_mgctx *mgctx);
224 int cgroup_migrate(struct task_struct *leader, bool threadgroup,
225                    struct cgroup_mgctx *mgctx);
226
227 int cgroup_attach_task(struct cgroup *dst_cgrp, struct task_struct *leader,
228                        bool threadgroup);
229 struct task_struct *cgroup_procs_write_start(char *buf, bool threadgroup)
230         __acquires(&cgroup_threadgroup_rwsem);
231 void cgroup_procs_write_finish(struct task_struct *task)
232         __releases(&cgroup_threadgroup_rwsem);
233
234 void cgroup_lock_and_drain_offline(struct cgroup *cgrp);
235
236 int cgroup_mkdir(struct kernfs_node *parent_kn, const char *name, umode_t mode);
237 int cgroup_rmdir(struct kernfs_node *kn);
238 int cgroup_show_path(struct seq_file *sf, struct kernfs_node *kf_node,
239                      struct kernfs_root *kf_root);
240
241 int cgroup_task_count(const struct cgroup *cgrp);
242
243 /*
244  * rstat.c
245  */
246 int cgroup_rstat_init(struct cgroup *cgrp);
247 void cgroup_rstat_exit(struct cgroup *cgrp);
248 void cgroup_rstat_boot(void);
249 void cgroup_base_stat_cputime_show(struct seq_file *seq);
250
251 /*
252  * namespace.c
253  */
254 extern const struct proc_ns_operations cgroupns_operations;
255
256 /*
257  * cgroup-v1.c
258  */
259 extern struct cftype cgroup1_base_files[];
260 extern struct kernfs_syscall_ops cgroup1_kf_syscall_ops;
261 extern const struct fs_parameter_description cgroup1_fs_parameters;
262
263 int proc_cgroupstats_show(struct seq_file *m, void *v);
264 bool cgroup1_ssid_disabled(int ssid);
265 void cgroup1_pidlist_destroy_all(struct cgroup *cgrp);
266 void cgroup1_release_agent(struct work_struct *work);
267 void cgroup1_check_for_release(struct cgroup *cgrp);
268 int cgroup1_parse_param(struct fs_context *fc, struct fs_parameter *param);
269 int cgroup1_get_tree(struct fs_context *fc);
270 int cgroup1_reconfigure(struct fs_context *ctx);
271
272 #endif /* __CGROUP_INTERNAL_H */