cgroup: start switching to fs_context
[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         char *data;
45 };
46
47 static inline struct cgroup_fs_context *cgroup_fc2context(struct fs_context *fc)
48 {
49         return fc->fs_private;
50 }
51
52 /*
53  * A cgroup can be associated with multiple css_sets as different tasks may
54  * belong to different cgroups on different hierarchies.  In the other
55  * direction, a css_set is naturally associated with multiple cgroups.
56  * This M:N relationship is represented by the following link structure
57  * which exists for each association and allows traversing the associations
58  * from both sides.
59  */
60 struct cgrp_cset_link {
61         /* the cgroup and css_set this link associates */
62         struct cgroup           *cgrp;
63         struct css_set          *cset;
64
65         /* list of cgrp_cset_links anchored at cgrp->cset_links */
66         struct list_head        cset_link;
67
68         /* list of cgrp_cset_links anchored at css_set->cgrp_links */
69         struct list_head        cgrp_link;
70 };
71
72 /* used to track tasks and csets during migration */
73 struct cgroup_taskset {
74         /* the src and dst cset list running through cset->mg_node */
75         struct list_head        src_csets;
76         struct list_head        dst_csets;
77
78         /* the number of tasks in the set */
79         int                     nr_tasks;
80
81         /* the subsys currently being processed */
82         int                     ssid;
83
84         /*
85          * Fields for cgroup_taskset_*() iteration.
86          *
87          * Before migration is committed, the target migration tasks are on
88          * ->mg_tasks of the csets on ->src_csets.  After, on ->mg_tasks of
89          * the csets on ->dst_csets.  ->csets point to either ->src_csets
90          * or ->dst_csets depending on whether migration is committed.
91          *
92          * ->cur_csets and ->cur_task point to the current task position
93          * during iteration.
94          */
95         struct list_head        *csets;
96         struct css_set          *cur_cset;
97         struct task_struct      *cur_task;
98 };
99
100 /* migration context also tracks preloading */
101 struct cgroup_mgctx {
102         /*
103          * Preloaded source and destination csets.  Used to guarantee
104          * atomic success or failure on actual migration.
105          */
106         struct list_head        preloaded_src_csets;
107         struct list_head        preloaded_dst_csets;
108
109         /* tasks and csets to migrate */
110         struct cgroup_taskset   tset;
111
112         /* subsystems affected by migration */
113         u16                     ss_mask;
114 };
115
116 #define CGROUP_TASKSET_INIT(tset)                                               \
117 {                                                                               \
118         .src_csets              = LIST_HEAD_INIT(tset.src_csets),               \
119         .dst_csets              = LIST_HEAD_INIT(tset.dst_csets),               \
120         .csets                  = &tset.src_csets,                              \
121 }
122
123 #define CGROUP_MGCTX_INIT(name)                                                 \
124 {                                                                               \
125         LIST_HEAD_INIT(name.preloaded_src_csets),                               \
126         LIST_HEAD_INIT(name.preloaded_dst_csets),                               \
127         CGROUP_TASKSET_INIT(name.tset),                                         \
128 }
129
130 #define DEFINE_CGROUP_MGCTX(name)                                               \
131         struct cgroup_mgctx name = CGROUP_MGCTX_INIT(name)
132
133 struct cgroup_sb_opts {
134         u16 subsys_mask;
135         unsigned int flags;
136         char *release_agent;
137         bool cpuset_clone_children;
138         char *name;
139         /* User explicitly requested empty subsystem */
140         bool none;
141 };
142
143 extern struct mutex cgroup_mutex;
144 extern spinlock_t css_set_lock;
145 extern struct cgroup_subsys *cgroup_subsys[];
146 extern struct list_head cgroup_roots;
147 extern struct file_system_type cgroup_fs_type;
148
149 /* iterate across the hierarchies */
150 #define for_each_root(root)                                             \
151         list_for_each_entry((root), &cgroup_roots, root_list)
152
153 /**
154  * for_each_subsys - iterate all enabled cgroup subsystems
155  * @ss: the iteration cursor
156  * @ssid: the index of @ss, CGROUP_SUBSYS_COUNT after reaching the end
157  */
158 #define for_each_subsys(ss, ssid)                                       \
159         for ((ssid) = 0; (ssid) < CGROUP_SUBSYS_COUNT &&                \
160              (((ss) = cgroup_subsys[ssid]) || true); (ssid)++)
161
162 static inline bool cgroup_is_dead(const struct cgroup *cgrp)
163 {
164         return !(cgrp->self.flags & CSS_ONLINE);
165 }
166
167 static inline bool notify_on_release(const struct cgroup *cgrp)
168 {
169         return test_bit(CGRP_NOTIFY_ON_RELEASE, &cgrp->flags);
170 }
171
172 void put_css_set_locked(struct css_set *cset);
173
174 static inline void put_css_set(struct css_set *cset)
175 {
176         unsigned long flags;
177
178         /*
179          * Ensure that the refcount doesn't hit zero while any readers
180          * can see it. Similar to atomic_dec_and_lock(), but for an
181          * rwlock
182          */
183         if (refcount_dec_not_one(&cset->refcount))
184                 return;
185
186         spin_lock_irqsave(&css_set_lock, flags);
187         put_css_set_locked(cset);
188         spin_unlock_irqrestore(&css_set_lock, flags);
189 }
190
191 /*
192  * refcounted get/put for css_set objects
193  */
194 static inline void get_css_set(struct css_set *cset)
195 {
196         refcount_inc(&cset->refcount);
197 }
198
199 bool cgroup_ssid_enabled(int ssid);
200 bool cgroup_on_dfl(const struct cgroup *cgrp);
201 bool cgroup_is_thread_root(struct cgroup *cgrp);
202 bool cgroup_is_threaded(struct cgroup *cgrp);
203
204 struct cgroup_root *cgroup_root_from_kf(struct kernfs_root *kf_root);
205 struct cgroup *task_cgroup_from_root(struct task_struct *task,
206                                      struct cgroup_root *root);
207 struct cgroup *cgroup_kn_lock_live(struct kernfs_node *kn, bool drain_offline);
208 void cgroup_kn_unlock(struct kernfs_node *kn);
209 int cgroup_path_ns_locked(struct cgroup *cgrp, char *buf, size_t buflen,
210                           struct cgroup_namespace *ns);
211
212 void cgroup_free_root(struct cgroup_root *root);
213 void init_cgroup_root(struct cgroup_root *root, struct cgroup_sb_opts *opts);
214 int cgroup_setup_root(struct cgroup_root *root, u16 ss_mask);
215 int rebind_subsystems(struct cgroup_root *dst_root, u16 ss_mask);
216 struct dentry *cgroup_do_mount(struct file_system_type *fs_type, int flags,
217                                struct cgroup_root *root, unsigned long magic,
218                                struct cgroup_namespace *ns);
219
220 int cgroup_migrate_vet_dst(struct cgroup *dst_cgrp);
221 void cgroup_migrate_finish(struct cgroup_mgctx *mgctx);
222 void cgroup_migrate_add_src(struct css_set *src_cset, struct cgroup *dst_cgrp,
223                             struct cgroup_mgctx *mgctx);
224 int cgroup_migrate_prepare_dst(struct cgroup_mgctx *mgctx);
225 int cgroup_migrate(struct task_struct *leader, bool threadgroup,
226                    struct cgroup_mgctx *mgctx);
227
228 int cgroup_attach_task(struct cgroup *dst_cgrp, struct task_struct *leader,
229                        bool threadgroup);
230 struct task_struct *cgroup_procs_write_start(char *buf, bool threadgroup)
231         __acquires(&cgroup_threadgroup_rwsem);
232 void cgroup_procs_write_finish(struct task_struct *task)
233         __releases(&cgroup_threadgroup_rwsem);
234
235 void cgroup_lock_and_drain_offline(struct cgroup *cgrp);
236
237 int cgroup_mkdir(struct kernfs_node *parent_kn, const char *name, umode_t mode);
238 int cgroup_rmdir(struct kernfs_node *kn);
239 int cgroup_show_path(struct seq_file *sf, struct kernfs_node *kf_node,
240                      struct kernfs_root *kf_root);
241
242 int cgroup_task_count(const struct cgroup *cgrp);
243
244 /*
245  * rstat.c
246  */
247 int cgroup_rstat_init(struct cgroup *cgrp);
248 void cgroup_rstat_exit(struct cgroup *cgrp);
249 void cgroup_rstat_boot(void);
250 void cgroup_base_stat_cputime_show(struct seq_file *seq);
251
252 /*
253  * namespace.c
254  */
255 extern const struct proc_ns_operations cgroupns_operations;
256
257 /*
258  * cgroup-v1.c
259  */
260 extern struct cftype cgroup1_base_files[];
261 extern struct kernfs_syscall_ops cgroup1_kf_syscall_ops;
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 struct dentry *cgroup1_mount(struct file_system_type *fs_type, int flags,
269                              void *data, unsigned long magic,
270                              struct cgroup_namespace *ns);
271 int cgroup1_reconfigure(struct fs_context *ctx);
272
273 #endif /* __CGROUP_INTERNAL_H */