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