kernel/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 #include <linux/work-simple.h>
  20
  21 #ifdef CONFIG_CGROUPS
  22
  23 struct cgroup;
  24 struct cgroup_root;
  25 struct cgroup_subsys;
  26 struct cgroup_taskset;
  27 struct kernfs_node;
  28 struct kernfs_ops;
  29 struct kernfs_open_file;
  30 struct seq_file;
  31
  32 #define MAX_CGROUP_TYPE_NAMELEN 32
  33 #define MAX_CGROUP_ROOT_NAMELEN 64
  34 #define MAX_CFTYPE_NAME         64
  35
  36 /* define the enumeration of all cgroup subsystems */
  37 #define SUBSYS(_x) _x ## _cgrp_id,
  38 #define SUBSYS_TAG(_t) CGROUP_ ## _t, \
  39         __unused_tag_ ## _t = CGROUP_ ## _t - 1,
  40 enum cgroup_subsys_id {
  41 #include <linux/cgroup_subsys.h>
  42         CGROUP_SUBSYS_COUNT,
  43 };
  44 #undef SUBSYS_TAG
  45 #undef SUBSYS
  46
  47 #define CGROUP_CANFORK_COUNT (CGROUP_CANFORK_END - CGROUP_CANFORK_START)
  48
  49 /* bits in struct cgroup_subsys_state flags field */
  50 enum {
  51         CSS_NO_REF      = (1 << 0), /* no reference counting for this css */
  52         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
  53         CSS_RELEASED    = (1 << 2), /* refcnt reached zero, released */
  54 };
  55
  56 /* bits in struct cgroup flags field */
  57 enum {
  58         /* Control Group requires release notifications to userspace */
  59         CGRP_NOTIFY_ON_RELEASE,
  60         /*
  61          * Clone the parent's configuration when creating a new child
  62          * cpuset cgroup.  For historical reasons, this option can be
  63          * specified at mount time and thus is implemented here.
  64          */
  65         CGRP_CPUSET_CLONE_CHILDREN,
  66 };
  67
  68 /* cgroup_root->flags */
  69 enum {
  70         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0), /* __DEVEL__sane_behavior specified */
  71         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
  72         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
  73 };
  74
  75 /* cftype->flags */
  76 enum {
  77         CFTYPE_ONLY_ON_ROOT     = (1 << 0),     /* only create on root cgrp */
  78         CFTYPE_NOT_ON_ROOT      = (1 << 1),     /* don't create on root cgrp */
  79         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
  80         CFTYPE_WORLD_WRITABLE   = (1 << 4),     /* (DON'T USE FOR NEW FILES) S_IWUGO */
  81
  82         /* internal flags, do not use outside cgroup core proper */
  83         __CFTYPE_ONLY_ON_DFL    = (1 << 16),    /* only on default hierarchy */
  84         __CFTYPE_NOT_ON_DFL     = (1 << 17),    /* not on default hierarchy */
  85 };
  86
  87 /*
  88  * cgroup_file is the handle for a file instance created in a cgroup which
  89  * is used, for example, to generate file changed notifications.  This can
  90  * be obtained by setting cftype->file_offset.
  91  */
  92 struct cgroup_file {
  93         /* do not access any fields from outside cgroup core */
  94         struct kernfs_node *kn;
  95 };
  96
  97 /*
  98  * Per-subsystem/per-cgroup state maintained by the system.  This is the
  99  * fundamental structural building block that controllers deal with.
 100  *
 101  * Fields marked with "PI:" are public and immutable and may be accessed
 102  * directly without synchronization.
 103  */
 104 struct cgroup_subsys_state {
 105         /* PI: the cgroup that this css is attached to */
 106         struct cgroup *cgroup;
 107
 108         /* PI: the cgroup subsystem that this css is attached to */
 109         struct cgroup_subsys *ss;
 110
 111         /* reference count - access via css_[try]get() and css_put() */
 112         struct percpu_ref refcnt;
 113
 114         /* PI: the parent css */
 115         struct cgroup_subsys_state *parent;
 116
 117         /* siblings list anchored at the parent's ->children */
 118         struct list_head sibling;
 119         struct list_head children;
 120
 121         /*
 122          * PI: Subsys-unique ID.  0 is unused and root is always 1.  The
 123          * matching css can be looked up using css_from_id().
 124          */
 125         int id;
 126
 127         unsigned int flags;
 128
 129         /*
 130          * Monotonically increasing unique serial number which defines a
 131          * uniform order among all csses.  It's guaranteed that all
 132          * ->children lists are in the ascending order of ->serial_nr and
 133          * used to allow interrupting and resuming iterations.
 134          */
 135         u64 serial_nr;
 136
 137         /*
 138          * Incremented by online self and children.  Used to guarantee that
 139          * parents are not offlined before their children.
 140          */
 141         atomic_t online_cnt;
 142
 143         /* percpu_ref killing and RCU release */
 144         struct rcu_head rcu_head;
 145         struct work_struct destroy_work;
 146         struct swork_event destroy_swork;
 147 };
 148
 149 /*
 150  * A css_set is a structure holding pointers to a set of
 151  * cgroup_subsys_state objects. This saves space in the task struct
 152  * object and speeds up fork()/exit(), since a single inc/dec and a
 153  * list_add()/del() can bump the reference count on the entire cgroup
 154  * set for a task.
 155  */
 156 struct css_set {
 157         /* Reference count */
 158         atomic_t refcount;
 159
 160         /*
 161          * List running through all cgroup groups in the same hash
 162          * slot. Protected by css_set_lock
 163          */
 164         struct hlist_node hlist;
 165
 166         /*
 167          * Lists running through all tasks using this cgroup group.
 168          * mg_tasks lists tasks which belong to this cset but are in the
 169          * process of being migrated out or in.  Protected by
 170          * css_set_rwsem, but, during migration, once tasks are moved to
 171          * mg_tasks, it can be read safely while holding cgroup_mutex.
 172          */
 173         struct list_head tasks;
 174         struct list_head mg_tasks;
 175
 176         /*
 177          * List of cgrp_cset_links pointing at cgroups referenced from this
 178          * css_set.  Protected by css_set_lock.
 179          */
 180         struct list_head cgrp_links;
 181
 182         /* the default cgroup associated with this css_set */
 183         struct cgroup *dfl_cgrp;
 184
 185         /*
 186          * Set of subsystem states, one for each subsystem. This array is
 187          * immutable after creation apart from the init_css_set during
 188          * subsystem registration (at boot time).
 189          */
 190         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
 191
 192         /*
 193          * List of csets participating in the on-going migration either as
 194          * source or destination.  Protected by cgroup_mutex.
 195          */
 196         struct list_head mg_preload_node;
 197         struct list_head mg_node;
 198
 199         /*
 200          * If this cset is acting as the source of migration the following
 201          * two fields are set.  mg_src_cgrp is the source cgroup of the
 202          * on-going migration and mg_dst_cset is the destination cset the
 203          * target tasks on this cset should be migrated to.  Protected by
 204          * cgroup_mutex.
 205          */
 206         struct cgroup *mg_src_cgrp;
 207         struct css_set *mg_dst_cset;
 208
 209         /*
 210          * On the default hierarhcy, ->subsys[ssid] may point to a css
 211          * attached to an ancestor instead of the cgroup this css_set is
 212          * associated with.  The following node is anchored at
 213          * ->subsys[ssid]->cgroup->e_csets[ssid] and provides a way to
 214          * iterate through all css's attached to a given cgroup.
 215          */
 216         struct list_head e_cset_node[CGROUP_SUBSYS_COUNT];
 217
 218         /* all css_task_iters currently walking this cset */
 219         struct list_head task_iters;
 220
 221         /* For RCU-protected deletion */
 222         struct rcu_head rcu_head;
 223 };
 224
 225 struct cgroup {
 226         /* self css with NULL ->ss, points back to this cgroup */
 227         struct cgroup_subsys_state self;
 228
 229         unsigned long flags;            /* "unsigned long" so bitops work */
 230
 231         /*
 232          * idr allocated in-hierarchy ID.
 233          *
 234          * ID 0 is not used, the ID of the root cgroup is always 1, and a
 235          * new cgroup will be assigned with a smallest available ID.
 236          *
 237          * Allocating/Removing ID must be protected by cgroup_mutex.
 238          */
 239         int id;
 240
 241         /*
 242          * Each non-empty css_set associated with this cgroup contributes
 243          * one to populated_cnt.  All children with non-zero popuplated_cnt
 244          * of their own contribute one.  The count is zero iff there's no
 245          * task in this cgroup or its subtree.
 246          */
 247         int populated_cnt;
 248
 249         struct kernfs_node *kn;         /* cgroup kernfs entry */
 250         struct cgroup_file procs_file;  /* handle for "cgroup.procs" */
 251         struct cgroup_file events_file; /* handle for "cgroup.events" */
 252
 253         /*
 254          * The bitmask of subsystems enabled on the child cgroups.
 255          * ->subtree_control is the one configured through
 256          * "cgroup.subtree_control" while ->child_subsys_mask is the
 257          * effective one which may have more subsystems enabled.
 258          * Controller knobs are made available iff it's enabled in
 259          * ->subtree_control.
 260          */
 261         unsigned int subtree_control;
 262         unsigned int child_subsys_mask;
 263
 264         /* Private pointers for each registered subsystem */
 265         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
 266
 267         struct cgroup_root *root;
 268
 269         /*
 270          * List of cgrp_cset_links pointing at css_sets with tasks in this
 271          * cgroup.  Protected by css_set_lock.
 272          */
 273         struct list_head cset_links;
 274
 275         /*
 276          * On the default hierarchy, a css_set for a cgroup with some
 277          * susbsys disabled will point to css's which are associated with
 278          * the closest ancestor which has the subsys enabled.  The
 279          * following lists all css_sets which point to this cgroup's css
 280          * for the given subsystem.
 281          */
 282         struct list_head e_csets[CGROUP_SUBSYS_COUNT];
 283
 284         /*
 285          * list of pidlists, up to two for each namespace (one for procs, one
 286          * for tasks); created on demand.
 287          */
 288         struct list_head pidlists;
 289         struct mutex pidlist_mutex;
 290
 291         /* used to wait for offlining of csses */
 292         wait_queue_head_t offline_waitq;
 293
 294         /* used to schedule release agent */
 295         struct work_struct release_agent_work;
 296 };
 297
 298 /*
 299  * A cgroup_root represents the root of a cgroup hierarchy, and may be
 300  * associated with a kernfs_root to form an active hierarchy.  This is
 301  * internal to cgroup core.  Don't access directly from controllers.
 302  */
 303 struct cgroup_root {
 304         struct kernfs_root *kf_root;
 305
 306         /* The bitmask of subsystems attached to this hierarchy */
 307         unsigned int subsys_mask;
 308
 309         /* Unique id for this hierarchy. */
 310         int hierarchy_id;
 311
 312         /* The root cgroup.  Root is destroyed on its release. */
 313         struct cgroup cgrp;
 314
 315         /* Number of cgroups in the hierarchy, used only for /proc/cgroups */
 316         atomic_t nr_cgrps;
 317
 318         /* A list running through the active hierarchies */
 319         struct list_head root_list;
 320
 321         /* Hierarchy-specific flags */
 322         unsigned int flags;
 323
 324         /* IDs for cgroups in this hierarchy */
 325         struct idr cgroup_idr;
 326
 327         /* The path to use for release notifications. */
 328         char release_agent_path[PATH_MAX];
 329
 330         /* The name for this hierarchy - may be empty */
 331         char name[MAX_CGROUP_ROOT_NAMELEN];
 332 };
 333
 334 /*
 335  * struct cftype: handler definitions for cgroup control files
 336  *
 337  * When reading/writing to a file:
 338  *      - the cgroup to use is file->f_path.dentry->d_parent->d_fsdata
 339  *      - the 'cftype' of the file is file->f_path.dentry->d_fsdata
 340  */
 341 struct cftype {
 342         /*
 343          * By convention, the name should begin with the name of the
 344          * subsystem, followed by a period.  Zero length string indicates
 345          * end of cftype array.
 346          */
 347         char name[MAX_CFTYPE_NAME];
 348         unsigned long private;
 349
 350         /*
 351          * The maximum length of string, excluding trailing nul, that can
 352          * be passed to write.  If < PAGE_SIZE-1, PAGE_SIZE-1 is assumed.
 353          */
 354         size_t max_write_len;
 355
 356         /* CFTYPE_* flags */
 357         unsigned int flags;
 358
 359         /*
 360          * If non-zero, should contain the offset from the start of css to
 361          * a struct cgroup_file field.  cgroup will record the handle of
 362          * the created file into it.  The recorded handle can be used as
 363          * long as the containing css remains accessible.
 364          */
 365         unsigned int file_offset;
 366
 367         /*
 368          * Fields used for internal bookkeeping.  Initialized automatically
 369          * during registration.
 370          */
 371         struct cgroup_subsys *ss;       /* NULL for cgroup core files */
 372         struct list_head node;          /* anchored at ss->cfts */
 373         struct kernfs_ops *kf_ops;
 374
 375         /*
 376          * read_u64() is a shortcut for the common case of returning a
 377          * single integer. Use it in place of read()
 378          */
 379         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
 380         /*
 381          * read_s64() is a signed version of read_u64()
 382          */
 383         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
 384
 385         /* generic seq_file read interface */
 386         int (*seq_show)(struct seq_file *sf, void *v);
 387
 388         /* optional ops, implement all or none */
 389         void *(*seq_start)(struct seq_file *sf, loff_t *ppos);
 390         void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos);
 391         void (*seq_stop)(struct seq_file *sf, void *v);
 392
 393         /*
 394          * write_u64() is a shortcut for the common case of accepting
 395          * a single integer (as parsed by simple_strtoull) from
 396          * userspace. Use in place of write(); return 0 or error.
 397          */
 398         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
 399                          u64 val);
 400         /*
 401          * write_s64() is a signed version of write_u64()
 402          */
 403         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
 404                          s64 val);
 405
 406         /*
 407          * write() is the generic write callback which maps directly to
 408          * kernfs write operation and overrides all other operations.
 409          * Maximum write size is determined by ->max_write_len.  Use
 410          * of_css/cft() to access the associated css and cft.
 411          */
 412         ssize_t (*write)(struct kernfs_open_file *of,
 413                          char *buf, size_t nbytes, loff_t off);
 414
 415 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 416         struct lock_class_key   lockdep_key;
 417 #endif
 418 };
 419
 420 /*
 421  * Control Group subsystem type.
 422  * See Documentation/cgroups/cgroups.txt for details
 423  */
 424 struct cgroup_subsys {
 425         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
 426         int (*css_online)(struct cgroup_subsys_state *css);
 427         void (*css_offline)(struct cgroup_subsys_state *css);
 428         void (*css_released)(struct cgroup_subsys_state *css);
 429         void (*css_free)(struct cgroup_subsys_state *css);
 430         void (*css_reset)(struct cgroup_subsys_state *css);
 431         void (*css_e_css_changed)(struct cgroup_subsys_state *css);
 432
 433         int (*can_attach)(struct cgroup_taskset *tset);
 434         void (*cancel_attach)(struct cgroup_taskset *tset);
 435         void (*attach)(struct cgroup_taskset *tset);
 436         int (*can_fork)(struct task_struct *task, void **priv_p);
 437         void (*cancel_fork)(struct task_struct *task, void *priv);
 438         void (*fork)(struct task_struct *task, void *priv);
 439         void (*exit)(struct task_struct *task);
 440         void (*free)(struct task_struct *task);
 441         void (*bind)(struct cgroup_subsys_state *root_css);
 442
 443         int early_init;
 444
 445         /*
 446          * If %false, this subsystem is properly hierarchical -
 447          * configuration, resource accounting and restriction on a parent
 448          * cgroup cover those of its children.  If %true, hierarchy support
 449          * is broken in some ways - some subsystems ignore hierarchy
 450          * completely while others are only implemented half-way.
 451          *
 452          * It's now disallowed to create nested cgroups if the subsystem is
 453          * broken and cgroup core will emit a warning message on such
 454          * cases.  Eventually, all subsystems will be made properly
 455          * hierarchical and this will go away.
 456          */
 457         bool broken_hierarchy;
 458         bool warned_broken_hierarchy;
 459
 460         /* the following two fields are initialized automtically during boot */
 461         int id;
 462         const char *name;
 463
 464         /* optional, initialized automatically during boot if not set */
 465         const char *legacy_name;
 466
 467         /* link to parent, protected by cgroup_lock() */
 468         struct cgroup_root *root;
 469
 470         /* idr for css->id */
 471         struct idr css_idr;
 472
 473         /*
 474          * List of cftypes.  Each entry is the first entry of an array
 475          * terminated by zero length name.
 476          */
 477         struct list_head cfts;
 478
 479         /*
 480          * Base cftypes which are automatically registered.  The two can
 481          * point to the same array.
 482          */
 483         struct cftype *dfl_cftypes;     /* for the default hierarchy */
 484         struct cftype *legacy_cftypes;  /* for the legacy hierarchies */
 485
 486         /*
 487          * A subsystem may depend on other subsystems.  When such subsystem
 488          * is enabled on a cgroup, the depended-upon subsystems are enabled
 489          * together if available.  Subsystems enabled due to dependency are
 490          * not visible to userland until explicitly enabled.  The following
 491          * specifies the mask of subsystems that this one depends on.
 492          */
 493         unsigned int depends_on;
 494 };
 495
 496 extern struct percpu_rw_semaphore cgroup_threadgroup_rwsem;
 497
 498 /**
 499  * cgroup_threadgroup_change_begin - threadgroup exclusion for cgroups
 500  * @tsk: target task
 501  *
 502  * Called from threadgroup_change_begin() and allows cgroup operations to
 503  * synchronize against threadgroup changes using a percpu_rw_semaphore.
 504  */
 505 static inline void cgroup_threadgroup_change_begin(struct task_struct *tsk)
 506 {
 507         percpu_down_read(&cgroup_threadgroup_rwsem);
 508 }
 509
 510 /**
 511  * cgroup_threadgroup_change_end - threadgroup exclusion for cgroups
 512  * @tsk: target task
 513  *
 514  * Called from threadgroup_change_end().  Counterpart of
 515  * cgroup_threadcgroup_change_begin().
 516  */
 517 static inline void cgroup_threadgroup_change_end(struct task_struct *tsk)
 518 {
 519         percpu_up_read(&cgroup_threadgroup_rwsem);
 520 }
 521
 522 #else   /* CONFIG_CGROUPS */
 523
 524 #define CGROUP_CANFORK_COUNT 0
 525 #define CGROUP_SUBSYS_COUNT 0
 526
 527 static inline void cgroup_threadgroup_change_begin(struct task_struct *tsk) {}
 528 static inline void cgroup_threadgroup_change_end(struct task_struct *tsk) {}
 529
 530 #endif  /* CONFIG_CGROUPS */
 531
 532 #endif  /* _LINUX_CGROUP_DEFS_H */