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