GNU Linux-libre 4.9.333-gnu1
[releases.git] / include / linux / cgroup-defs.h
1 /*
2  * linux/cgroup-defs.h - basic definitions for cgroup
3  *
4  * This file provides basic type and interface.  Include this file directly
5  * only if necessary to avoid cyclic dependencies.
6  */
7 #ifndef _LINUX_CGROUP_DEFS_H
8 #define _LINUX_CGROUP_DEFS_H
9
10 #include <linux/limits.h>
11 #include <linux/list.h>
12 #include <linux/idr.h>
13 #include <linux/wait.h>
14 #include <linux/mutex.h>
15 #include <linux/rcupdate.h>
16 #include <linux/percpu-refcount.h>
17 #include <linux/percpu-rwsem.h>
18 #include <linux/workqueue.h>
19
20 #ifdef CONFIG_CGROUPS
21
22 struct cgroup;
23 struct cgroup_root;
24 struct cgroup_subsys;
25 struct cgroup_taskset;
26 struct kernfs_node;
27 struct kernfs_ops;
28 struct kernfs_open_file;
29 struct seq_file;
30
31 #define MAX_CGROUP_TYPE_NAMELEN 32
32 #define MAX_CGROUP_ROOT_NAMELEN 64
33 #define MAX_CFTYPE_NAME         64
34
35 /* define the enumeration of all cgroup subsystems */
36 #define SUBSYS(_x) _x ## _cgrp_id,
37 enum cgroup_subsys_id {
38 #include <linux/cgroup_subsys.h>
39         CGROUP_SUBSYS_COUNT,
40 };
41 #undef SUBSYS
42
43 /* bits in struct cgroup_subsys_state flags field */
44 enum {
45         CSS_NO_REF      = (1 << 0), /* no reference counting for this css */
46         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
47         CSS_RELEASED    = (1 << 2), /* refcnt reached zero, released */
48         CSS_VISIBLE     = (1 << 3), /* css is visible to userland */
49         CSS_DYING       = (1 << 4), /* css is dying */
50 };
51
52 /* bits in struct cgroup flags field */
53 enum {
54         /* Control Group requires release notifications to userspace */
55         CGRP_NOTIFY_ON_RELEASE,
56         /*
57          * Clone the parent's configuration when creating a new child
58          * cpuset cgroup.  For historical reasons, this option can be
59          * specified at mount time and thus is implemented here.
60          */
61         CGRP_CPUSET_CLONE_CHILDREN,
62 };
63
64 /* cgroup_root->flags */
65 enum {
66         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
67         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
68 };
69
70 /* cftype->flags */
71 enum {
72         CFTYPE_ONLY_ON_ROOT     = (1 << 0),     /* only create on root cgrp */
73         CFTYPE_NOT_ON_ROOT      = (1 << 1),     /* don't create on root cgrp */
74         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
75         CFTYPE_WORLD_WRITABLE   = (1 << 4),     /* (DON'T USE FOR NEW FILES) S_IWUGO */
76
77         /* internal flags, do not use outside cgroup core proper */
78         __CFTYPE_ONLY_ON_DFL    = (1 << 16),    /* only on default hierarchy */
79         __CFTYPE_NOT_ON_DFL     = (1 << 17),    /* not on default hierarchy */
80 };
81
82 /*
83  * cgroup_file is the handle for a file instance created in a cgroup which
84  * is used, for example, to generate file changed notifications.  This can
85  * be obtained by setting cftype->file_offset.
86  */
87 struct cgroup_file {
88         /* do not access any fields from outside cgroup core */
89         struct kernfs_node *kn;
90 };
91
92 /*
93  * Per-subsystem/per-cgroup state maintained by the system.  This is the
94  * fundamental structural building block that controllers deal with.
95  *
96  * Fields marked with "PI:" are public and immutable and may be accessed
97  * directly without synchronization.
98  */
99 struct cgroup_subsys_state {
100         /* PI: the cgroup that this css is attached to */
101         struct cgroup *cgroup;
102
103         /* PI: the cgroup subsystem that this css is attached to */
104         struct cgroup_subsys *ss;
105
106         /* reference count - access via css_[try]get() and css_put() */
107         struct percpu_ref refcnt;
108
109         /* PI: the parent css */
110         struct cgroup_subsys_state *parent;
111
112         /* siblings list anchored at the parent's ->children */
113         struct list_head sibling;
114         struct list_head children;
115
116         /*
117          * PI: Subsys-unique ID.  0 is unused and root is always 1.  The
118          * matching css can be looked up using css_from_id().
119          */
120         int id;
121
122         unsigned int flags;
123
124         /*
125          * Monotonically increasing unique serial number which defines a
126          * uniform order among all csses.  It's guaranteed that all
127          * ->children lists are in the ascending order of ->serial_nr and
128          * used to allow interrupting and resuming iterations.
129          */
130         u64 serial_nr;
131
132         /*
133          * Incremented by online self and children.  Used to guarantee that
134          * parents are not offlined before their children.
135          */
136         atomic_t online_cnt;
137
138         /* percpu_ref killing and RCU release */
139         struct rcu_head rcu_head;
140         struct work_struct destroy_work;
141 };
142
143 /*
144  * A css_set is a structure holding pointers to a set of
145  * cgroup_subsys_state objects. This saves space in the task struct
146  * object and speeds up fork()/exit(), since a single inc/dec and a
147  * list_add()/del() can bump the reference count on the entire cgroup
148  * set for a task.
149  */
150 struct css_set {
151         /* Reference count */
152         atomic_t refcount;
153
154         /*
155          * List running through all cgroup groups in the same hash
156          * slot. Protected by css_set_lock
157          */
158         struct hlist_node hlist;
159
160         /*
161          * Lists running through all tasks using this cgroup group.
162          * mg_tasks lists tasks which belong to this cset but are in the
163          * process of being migrated out or in.  Protected by
164          * css_set_rwsem, but, during migration, once tasks are moved to
165          * mg_tasks, it can be read safely while holding cgroup_mutex.
166          */
167         struct list_head tasks;
168         struct list_head mg_tasks;
169
170         /*
171          * List of cgrp_cset_links pointing at cgroups referenced from this
172          * css_set.  Protected by css_set_lock.
173          */
174         struct list_head cgrp_links;
175
176         /* the default cgroup associated with this css_set */
177         struct cgroup *dfl_cgrp;
178
179         /*
180          * Set of subsystem states, one for each subsystem. This array is
181          * immutable after creation apart from the init_css_set during
182          * subsystem registration (at boot time).
183          */
184         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
185
186         /*
187          * List of csets participating in the on-going migration either as
188          * source or destination.  Protected by cgroup_mutex.
189          */
190         struct list_head mg_preload_node;
191         struct list_head mg_node;
192
193         /*
194          * If this cset is acting as the source of migration the following
195          * two fields are set.  mg_src_cgrp and mg_dst_cgrp are
196          * respectively the source and destination cgroups of the on-going
197          * migration.  mg_dst_cset is the destination cset the target tasks
198          * on this cset should be migrated to.  Protected by cgroup_mutex.
199          */
200         struct cgroup *mg_src_cgrp;
201         struct cgroup *mg_dst_cgrp;
202         struct css_set *mg_dst_cset;
203
204         /*
205          * On the default hierarhcy, ->subsys[ssid] may point to a css
206          * attached to an ancestor instead of the cgroup this css_set is
207          * associated with.  The following node is anchored at
208          * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
209          * iterate through all css's attached to a given cgroup.
210          */
211         struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
212
213         /* all css_task_iters currently walking this cset */
214         struct list_head task_iters;
215
216         /* dead and being drained, ignore for migration */
217         bool dead;
218
219         /* For RCU-protected deletion */
220         struct rcu_head rcu_head;
221 };
222
223 struct cgroup {
224         /* self css with NULL ->ss, points back to this cgroup */
225         struct cgroup_subsys_state self;
226
227         unsigned long flags;            /* "unsigned long" so bitops work */
228
229         /*
230          * idr allocated in-hierarchy ID.
231          *
232          * ID 0 is not used, the ID of the root cgroup is always 1, and a
233          * new cgroup will be assigned with a smallest available ID.
234          *
235          * Allocating/Removing ID must be protected by cgroup_mutex.
236          */
237         int id;
238
239         /*
240          * The depth this cgroup is at.  The root is at depth zero and each
241          * step down the hierarchy increments the level.  This along with
242          * ancestor_ids[] can determine whether a given cgroup is a
243          * descendant of another without traversing the hierarchy.
244          */
245         int level;
246
247         /*
248          * Each non-empty css_set associated with this cgroup contributes
249          * one to populated_cnt.  All children with non-zero popuplated_cnt
250          * of their own contribute one.  The count is zero iff there's no
251          * task in this cgroup or its subtree.
252          */
253         int populated_cnt;
254
255         struct kernfs_node *kn;         /* cgroup kernfs entry */
256         struct cgroup_file procs_file;  /* handle for "cgroup.procs" */
257         struct cgroup_file events_file; /* handle for "cgroup.events" */
258
259         /*
260          * The bitmask of subsystems enabled on the child cgroups.
261          * ->subtree_control is the one configured through
262          * "cgroup.subtree_control" while ->child_ss_mask is the effective
263          * one which may have more subsystems enabled.  Controller knobs
264          * are made available iff it's enabled in ->subtree_control.
265          */
266         u16 subtree_control;
267         u16 subtree_ss_mask;
268         u16 old_subtree_control;
269         u16 old_subtree_ss_mask;
270
271         /* Private pointers for each registered subsystem */
272         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
273
274         struct cgroup_root *root;
275
276         /*
277          * List of cgrp_cset_links pointing at css_sets with tasks in this
278          * cgroup.  Protected by css_set_lock.
279          */
280         struct list_head cset_links;
281
282         /*
283          * On the default hierarchy, a css_set for a cgroup with some
284          * susbsys disabled will point to css's which are associated with
285          * the closest ancestor which has the subsys enabled.  The
286          * following lists all css_sets which point to this cgroup's css
287          * for the given subsystem.
288          */
289         struct list_head e_csets[CGROUP_SUBSYS_COUNT];
290
291         /*
292          * list of pidlists, up to two for each namespace (one for procs, one
293          * for tasks); created on demand.
294          */
295         struct list_head pidlists;
296         struct mutex pidlist_mutex;
297
298         /* used to wait for offlining of csses */
299         wait_queue_head_t offline_waitq;
300
301         /* used to schedule release agent */
302         struct work_struct release_agent_work;
303
304         /* ids of the ancestors at each level including self */
305         int ancestor_ids[];
306 };
307
308 /*
309  * A cgroup_root represents the root of a cgroup hierarchy, and may be
310  * associated with a kernfs_root to form an active hierarchy.  This is
311  * internal to cgroup core.  Don't access directly from controllers.
312  */
313 struct cgroup_root {
314         struct kernfs_root *kf_root;
315
316         /* The bitmask of subsystems attached to this hierarchy */
317         unsigned int subsys_mask;
318
319         /* Unique id for this hierarchy. */
320         int hierarchy_id;
321
322         /* The root cgroup.  Root is destroyed on its release. */
323         struct cgroup cgrp;
324
325         /* for cgrp->ancestor_ids[0] */
326         int cgrp_ancestor_id_storage;
327
328         /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
329         atomic_t nr_cgrps;
330
331         /* A list running through the active hierarchies */
332         struct list_head root_list;
333
334         /* Hierarchy-specific flags */
335         unsigned int flags;
336
337         /* IDs for cgroups in this hierarchy */
338         struct idr cgroup_idr;
339
340         /* The path to use for release notifications. */
341         char release_agent_path[PATH_MAX];
342
343         /* The name for this hierarchy - may be empty */
344         char name[MAX_CGROUP_ROOT_NAMELEN];
345 };
346
347 /*
348  * struct cftype: handler definitions for cgroup control files
349  *
350  * When reading/writing to a file:
351  *      - the cgroup to use is file->f_path.dentry->d_parent->d_fsdata
352  *      - the 'cftype' of the file is file->f_path.dentry->d_fsdata
353  */
354 struct cftype {
355         /*
356          * By convention, the name should begin with the name of the
357          * subsystem, followed by a period.  Zero length string indicates
358          * end of cftype array.
359          */
360         char name[MAX_CFTYPE_NAME];
361         unsigned long private;
362
363         /*
364          * The maximum length of string, excluding trailing nul, that can
365          * be passed to write.  If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
366          */
367         size_t max_write_len;
368
369         /* CFTYPE_* flags */
370         unsigned int flags;
371
372         /*
373          * If non-zero, should contain the offset from the start of css to
374          * a struct cgroup_file field.  cgroup will record the handle of
375          * the created file into it.  The recorded handle can be used as
376          * long as the containing css remains accessible.
377          */
378         unsigned int file_offset;
379
380         /*
381          * Fields used for internal bookkeeping.  Initialized automatically
382          * during registration.
383          */
384         struct cgroup_subsys *ss;       /* NULL for cgroup core files */
385         struct list_head node;          /* anchored at ss->cfts */
386         struct kernfs_ops *kf_ops;
387
388         /*
389          * read_u64() is a shortcut for the common case of returning a
390          * single integer. Use it in place of read()
391          */
392         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
393         /*
394          * read_s64() is a signed version of read_u64()
395          */
396         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
397
398         /* generic seq_file read interface */
399         int (*seq_show)(struct seq_file *sf, void *v);
400
401         /* optional ops, implement all or none */
402         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
403         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
404         void (*seq_stop)(struct seq_file *sf, void *v);
405
406         /*
407          * write_u64() is a shortcut for the common case of accepting
408          * a single integer (as parsed by simple_strtoull) from
409          * userspace. Use in place of write(); return 0 or error.
410          */
411         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
412                          u64 val);
413         /*
414          * write_s64() is a signed version of write_u64()
415          */
416         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
417                          s64 val);
418
419         /*
420          * write() is the generic write callback which maps directly to
421          * kernfs write operation and overrides all other operations.
422          * Maximum write size is determined by ->max_write_len.  Use
423          * of_css/cft() to access the associated css and cft.
424          */
425         ssize_t (*write)(struct kernfs_open_file *of,
426                          char *buf, size_t nbytes, loff_t off);
427
428 #ifdef CONFIG_DEBUG_LOCK_ALLOC
429         struct lock_class_key   lockdep_key;
430 #endif
431 };
432
433 /*
434  * Control Group subsystem type.
435  * See Documentation/cgroups/cgroups.txt for details
436  */
437 struct cgroup_subsys {
438         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
439         int (*css_online)(struct cgroup_subsys_state *css);
440         void (*css_offline)(struct cgroup_subsys_state *css);
441         void (*css_released)(struct cgroup_subsys_state *css);
442         void (*css_free)(struct cgroup_subsys_state *css);
443         void (*css_reset)(struct cgroup_subsys_state *css);
444
445         int (*can_attach)(struct cgroup_taskset *tset);
446         void (*cancel_attach)(struct cgroup_taskset *tset);
447         void (*attach)(struct cgroup_taskset *tset);
448         void (*post_attach)(void);
449         int (*can_fork)(struct task_struct *task);
450         void (*cancel_fork)(struct task_struct *task);
451         void (*fork)(struct task_struct *task);
452         void (*exit)(struct task_struct *task);
453         void (*free)(struct task_struct *task);
454         void (*bind)(struct cgroup_subsys_state *root_css);
455
456         bool early_init:1;
457
458         /*
459          * If %true, the controller, on the default hierarchy, doesn't show
460          * up in "cgroup.controllers" or "cgroup.subtree_control", is
461          * implicitly enabled on all cgroups on the default hierarchy, and
462          * bypasses the "no internal process" constraint.  This is for
463          * utility type controllers which is transparent to userland.
464          *
465          * An implicit controller can be stolen from the default hierarchy
466          * anytime and thus must be okay with offline csses from previous
467          * hierarchies coexisting with csses for the current one.
468          */
469         bool implicit_on_dfl:1;
470
471         /*
472          * If %false, this subsystem is properly hierarchical -
473          * configuration, resource accounting and restriction on a parent
474          * cgroup cover those of its children.  If %true, hierarchy support
475          * is broken in some ways - some subsystems ignore hierarchy
476          * completely while others are only implemented half-way.
477          *
478          * It's now disallowed to create nested cgroups if the subsystem is
479          * broken and cgroup core will emit a warning message on such
480          * cases.  Eventually, all subsystems will be made properly
481          * hierarchical and this will go away.
482          */
483         bool broken_hierarchy:1;
484         bool warned_broken_hierarchy:1;
485
486         /* the following two fields are initialized automtically during boot */
487         int id;
488         const char *name;
489
490         /* optional, initialized automatically during boot if not set */
491         const char *legacy_name;
492
493         /* link to parent, protected by cgroup_lock() */
494         struct cgroup_root *root;
495
496         /* idr for css->id */
497         struct idr css_idr;
498
499         /*
500          * List of cftypes.  Each entry is the first entry of an array
501          * terminated by zero length name.
502          */
503         struct list_head cfts;
504
505         /*
506          * Base cftypes which are automatically registered.  The two can
507          * point to the same array.
508          */
509         struct cftype *dfl_cftypes;     /* for the default hierarchy */
510         struct cftype *legacy_cftypes;  /* for the legacy hierarchies */
511
512         /*
513          * A subsystem may depend on other subsystems.  When such subsystem
514          * is enabled on a cgroup, the depended-upon subsystems are enabled
515          * together if available.  Subsystems enabled due to dependency are
516          * not visible to userland until explicitly enabled.  The following
517          * specifies the mask of subsystems that this one depends on.
518          */
519         unsigned int depends_on;
520 };
521
522 extern struct percpu_rw_semaphore cgroup_threadgroup_rwsem;
523
524 /**
525  * cgroup_threadgroup_change_begin - threadgroup exclusion for cgroups
526  * @tsk: target task
527  *
528  * Called from threadgroup_change_begin() and allows cgroup operations to
529  * synchronize against threadgroup changes using a percpu_rw_semaphore.
530  */
531 static inline void cgroup_threadgroup_change_begin(struct task_struct *tsk)
532 {
533         percpu_down_read(&cgroup_threadgroup_rwsem);
534 }
535
536 /**
537  * cgroup_threadgroup_change_end - threadgroup exclusion for cgroups
538  * @tsk: target task
539  *
540  * Called from threadgroup_change_end().  Counterpart of
541  * cgroup_threadcgroup_change_begin().
542  */
543 static inline void cgroup_threadgroup_change_end(struct task_struct *tsk)
544 {
545         percpu_up_read(&cgroup_threadgroup_rwsem);
546 }
547
548 #else   /* CONFIG_CGROUPS */
549
550 #define CGROUP_SUBSYS_COUNT 0
551
552 static inline void cgroup_threadgroup_change_begin(struct task_struct *tsk) {}
553 static inline void cgroup_threadgroup_change_end(struct task_struct *tsk) {}
554
555 #endif  /* CONFIG_CGROUPS */
556
557 #ifdef CONFIG_SOCK_CGROUP_DATA
558
559 /*
560  * sock_cgroup_data is embedded at sock->sk_cgrp_data and contains
561  * per-socket cgroup information except for memcg association.
562  *
563  * On legacy hierarchies, net_prio and net_cls controllers directly set
564  * attributes on each sock which can then be tested by the network layer.
565  * On the default hierarchy, each sock is associated with the cgroup it was
566  * created in and the networking layer can match the cgroup directly.
567  *
568  * To avoid carrying all three cgroup related fields separately in sock,
569  * sock_cgroup_data overloads (prioidx, classid) and the cgroup pointer.
570  * On boot, sock_cgroup_data records the cgroup that the sock was created
571  * in so that cgroup2 matches can be made; however, once either net_prio or
572  * net_cls starts being used, the area is overriden to carry prioidx and/or
573  * classid.  The two modes are distinguished by whether the lowest bit is
574  * set.  Clear bit indicates cgroup pointer while set bit prioidx and
575  * classid.
576  *
577  * While userland may start using net_prio or net_cls at any time, once
578  * either is used, cgroup2 matching no longer works.  There is no reason to
579  * mix the two and this is in line with how legacy and v2 compatibility is
580  * handled.  On mode switch, cgroup references which are already being
581  * pointed to by socks may be leaked.  While this can be remedied by adding
582  * synchronization around sock_cgroup_data, given that the number of leaked
583  * cgroups is bound and highly unlikely to be high, this seems to be the
584  * better trade-off.
585  */
586 struct sock_cgroup_data {
587         union {
588 #ifdef __LITTLE_ENDIAN
589                 struct {
590                         u8      is_data : 1;
591                         u8      no_refcnt : 1;
592                         u8      unused : 6;
593                         u8      padding;
594                         u16     prioidx;
595                         u32     classid;
596                 } __packed;
597 #else
598                 struct {
599                         u32     classid;
600                         u16     prioidx;
601                         u8      padding;
602                         u8      unused : 6;
603                         u8      no_refcnt : 1;
604                         u8      is_data : 1;
605                 } __packed;
606 #endif
607                 u64             val;
608         };
609 };
610
611 /*
612  * There's a theoretical window where the following accessors race with
613  * updaters and return part of the previous pointer as the prioidx or
614  * classid.  Such races are short-lived and the result isn't critical.
615  */
616 static inline u16 sock_cgroup_prioidx(const struct sock_cgroup_data *skcd)
617 {
618         /* fallback to 1 which is always the ID of the root cgroup */
619         return (skcd->is_data & 1) ? skcd->prioidx : 1;
620 }
621
622 static inline u32 sock_cgroup_classid(const struct sock_cgroup_data *skcd)
623 {
624         /* fallback to 0 which is the unconfigured default classid */
625         return (skcd->is_data & 1) ? skcd->classid : 0;
626 }
627
628 /*
629  * If invoked concurrently, the updaters may clobber each other.  The
630  * caller is responsible for synchronization.
631  */
632 static inline void sock_cgroup_set_prioidx(struct sock_cgroup_data *skcd,
633                                            u16 prioidx)
634 {
635         struct sock_cgroup_data skcd_buf = {{ .val = READ_ONCE(skcd->val) }};
636
637         if (sock_cgroup_prioidx(&skcd_buf) == prioidx)
638                 return;
639
640         if (!(skcd_buf.is_data & 1)) {
641                 skcd_buf.val = 0;
642                 skcd_buf.is_data = 1;
643         }
644
645         skcd_buf.prioidx = prioidx;
646         WRITE_ONCE(skcd->val, skcd_buf.val);    /* see sock_cgroup_ptr() */
647 }
648
649 static inline void sock_cgroup_set_classid(struct sock_cgroup_data *skcd,
650                                            u32 classid)
651 {
652         struct sock_cgroup_data skcd_buf = {{ .val = READ_ONCE(skcd->val) }};
653
654         if (sock_cgroup_classid(&skcd_buf) == classid)
655                 return;
656
657         if (!(skcd_buf.is_data & 1)) {
658                 skcd_buf.val = 0;
659                 skcd_buf.is_data = 1;
660         }
661
662         skcd_buf.classid = classid;
663         WRITE_ONCE(skcd->val, skcd_buf.val);    /* see sock_cgroup_ptr() */
664 }
665
666 #else   /* CONFIG_SOCK_CGROUP_DATA */
667
668 struct sock_cgroup_data {
669 };
670
671 #endif  /* CONFIG_SOCK_CGROUP_DATA */
672
673 #endif  /* _LINUX_CGROUP_DEFS_H */