include/linux/cgroup.h

   1 #ifndef _LINUX_CGROUP_H
   2 #define _LINUX_CGROUP_H
   3 /*
   4  *  cgroup interface
   5  *
   6  *  Copyright (C) 2003 BULL SA
   7  *  Copyright (C) 2004-2006 Silicon Graphics, Inc.
   8  *
   9  */
  10
  11 #include <linux/sched.h>
  12 #include <linux/cpumask.h>
  13 #include <linux/nodemask.h>
  14 #include <linux/rcupdate.h>
  15 #include <linux/rculist.h>
  16 #include <linux/cgroupstats.h>
  17 #include <linux/prio_heap.h>
  18 #include <linux/rwsem.h>
  19 #include <linux/idr.h>
  20 #include <linux/workqueue.h>
  21 #include <linux/xattr.h>
  22 #include <linux/fs.h>
  23 #include <linux/percpu-refcount.h>
  24
  25 #ifdef CONFIG_CGROUPS
  26
  27 struct cgroupfs_root;
  28 struct cgroup_subsys;
  29 struct inode;
  30 struct cgroup;
  31 struct css_id;
  32
  33 extern int cgroup_init_early(void);
  34 extern int cgroup_init(void);
  35 extern void cgroup_fork(struct task_struct *p);
  36 extern void cgroup_post_fork(struct task_struct *p);
  37 extern void cgroup_exit(struct task_struct *p, int run_callbacks);
  38 extern int cgroupstats_build(struct cgroupstats *stats,
  39                                 struct dentry *dentry);
  40 extern int cgroup_load_subsys(struct cgroup_subsys *ss);
  41 extern void cgroup_unload_subsys(struct cgroup_subsys *ss);
  42
  43 extern int proc_cgroup_show(struct seq_file *, void *);
  44
  45 /*
  46  * Define the enumeration of all cgroup subsystems.
  47  *
  48  * We define ids for builtin subsystems and then modular ones.
  49  */
  50 #define SUBSYS(_x) _x ## _subsys_id,
  51 enum cgroup_subsys_id {
  52 #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
  53 #include <linux/cgroup_subsys.h>
  54 #undef IS_SUBSYS_ENABLED
  55         CGROUP_BUILTIN_SUBSYS_COUNT,
  56
  57         __CGROUP_SUBSYS_TEMP_PLACEHOLDER = CGROUP_BUILTIN_SUBSYS_COUNT - 1,
  58
  59 #define IS_SUBSYS_ENABLED(option) IS_MODULE(option)
  60 #include <linux/cgroup_subsys.h>
  61 #undef IS_SUBSYS_ENABLED
  62         CGROUP_SUBSYS_COUNT,
  63 };
  64 #undef SUBSYS
  65
  66 /* Per-subsystem/per-cgroup state maintained by the system. */
  67 struct cgroup_subsys_state {
  68         /* the cgroup that this css is attached to */
  69         struct cgroup *cgroup;
  70
  71         /* the cgroup subsystem that this css is attached to */
  72         struct cgroup_subsys *ss;
  73
  74         /* reference count - access via css_[try]get() and css_put() */
  75         struct percpu_ref refcnt;
  76
  77         /* the parent css */
  78         struct cgroup_subsys_state *parent;
  79
  80         unsigned long flags;
  81         /* ID for this css, if possible */
  82         struct css_id __rcu *id;
  83
  84         /* percpu_ref killing and RCU release */
  85         struct rcu_head rcu_head;
  86         struct work_struct destroy_work;
  87 };
  88
  89 /* bits in struct cgroup_subsys_state flags field */
  90 enum {
  91         CSS_ROOT        = (1 << 0), /* this CSS is the root of the subsystem */
  92         CSS_ONLINE      = (1 << 1), /* between ->css_online() and ->css_offline() */
  93 };
  94
  95 /**
  96  * css_get - obtain a reference on the specified css
  97  * @css: target css
  98  *
  99  * The caller must already have a reference.
 100  */
 101 static inline void css_get(struct cgroup_subsys_state *css)
 102 {
 103         /* We don't need to reference count the root state */
 104         if (!(css->flags & CSS_ROOT))
 105                 percpu_ref_get(&css->refcnt);
 106 }
 107
 108 /**
 109  * css_tryget - try to obtain a reference on the specified css
 110  * @css: target css
 111  *
 112  * Obtain a reference on @css if it's alive.  The caller naturally needs to
 113  * ensure that @css is accessible but doesn't have to be holding a
 114  * reference on it - IOW, RCU protected access is good enough for this
 115  * function.  Returns %true if a reference count was successfully obtained;
 116  * %false otherwise.
 117  */
 118 static inline bool css_tryget(struct cgroup_subsys_state *css)
 119 {
 120         if (css->flags & CSS_ROOT)
 121                 return true;
 122         return percpu_ref_tryget(&css->refcnt);
 123 }
 124
 125 /**
 126  * css_put - put a css reference
 127  * @css: target css
 128  *
 129  * Put a reference obtained via css_get() and css_tryget().
 130  */
 131 static inline void css_put(struct cgroup_subsys_state *css)
 132 {
 133         if (!(css->flags & CSS_ROOT))
 134                 percpu_ref_put(&css->refcnt);
 135 }
 136
 137 /* bits in struct cgroup flags field */
 138 enum {
 139         /* Control Group is dead */
 140         CGRP_DEAD,
 141         /*
 142          * Control Group has previously had a child cgroup or a task,
 143          * but no longer (only if CGRP_NOTIFY_ON_RELEASE is set)
 144          */
 145         CGRP_RELEASABLE,
 146         /* Control Group requires release notifications to userspace */
 147         CGRP_NOTIFY_ON_RELEASE,
 148         /*
 149          * Clone the parent's configuration when creating a new child
 150          * cpuset cgroup.  For historical reasons, this option can be
 151          * specified at mount time and thus is implemented here.
 152          */
 153         CGRP_CPUSET_CLONE_CHILDREN,
 154         /* see the comment above CGRP_ROOT_SANE_BEHAVIOR for details */
 155         CGRP_SANE_BEHAVIOR,
 156 };
 157
 158 struct cgroup_name {
 159         struct rcu_head rcu_head;
 160         char name[];
 161 };
 162
 163 struct cgroup {
 164         unsigned long flags;            /* "unsigned long" so bitops work */
 165
 166         /*
 167          * idr allocated in-hierarchy ID.
 168          *
 169          * The ID of the root cgroup is always 0, and a new cgroup
 170          * will be assigned with a smallest available ID.
 171          */
 172         int id;
 173
 174         /* the number of attached css's */
 175         int nr_css;
 176
 177         /*
 178          * We link our 'sibling' struct into our parent's 'children'.
 179          * Our children link their 'sibling' into our 'children'.
 180          */
 181         struct list_head sibling;       /* my parent's children */
 182         struct list_head children;      /* my children */
 183         struct list_head files;         /* my files */
 184
 185         struct cgroup *parent;          /* my parent */
 186         struct dentry *dentry;          /* cgroup fs entry, RCU protected */
 187
 188         /*
 189          * Monotonically increasing unique serial number which defines a
 190          * uniform order among all cgroups.  It's guaranteed that all
 191          * ->children lists are in the ascending order of ->serial_nr.
 192          * It's used to allow interrupting and resuming iterations.
 193          */
 194         u64 serial_nr;
 195
 196         /*
 197          * This is a copy of dentry->d_name, and it's needed because
 198          * we can't use dentry->d_name in cgroup_path().
 199          *
 200          * You must acquire rcu_read_lock() to access cgrp->name, and
 201          * the only place that can change it is rename(), which is
 202          * protected by parent dir's i_mutex.
 203          *
 204          * Normally you should use cgroup_name() wrapper rather than
 205          * access it directly.
 206          */
 207         struct cgroup_name __rcu *name;
 208
 209         /* Private pointers for each registered subsystem */
 210         struct cgroup_subsys_state __rcu *subsys[CGROUP_SUBSYS_COUNT];
 211
 212         struct cgroupfs_root *root;
 213
 214         /*
 215          * List of cgrp_cset_links pointing at css_sets with tasks in this
 216          * cgroup.  Protected by css_set_lock.
 217          */
 218         struct list_head cset_links;
 219
 220         /*
 221          * Linked list running through all cgroups that can
 222          * potentially be reaped by the release agent. Protected by
 223          * release_list_lock
 224          */
 225         struct list_head release_list;
 226
 227         /*
 228          * list of pidlists, up to two for each namespace (one for procs, one
 229          * for tasks); created on demand.
 230          */
 231         struct list_head pidlists;
 232         struct mutex pidlist_mutex;
 233
 234         /* dummy css with NULL ->ss, points back to this cgroup */
 235         struct cgroup_subsys_state dummy_css;
 236
 237         /* For css percpu_ref killing and RCU-protected deletion */
 238         struct rcu_head rcu_head;
 239         struct work_struct destroy_work;
 240
 241         /* directory xattrs */
 242         struct simple_xattrs xattrs;
 243 };
 244
 245 #define MAX_CGROUP_ROOT_NAMELEN 64
 246
 247 /* cgroupfs_root->flags */
 248 enum {
 249         /*
 250          * Unfortunately, cgroup core and various controllers are riddled
 251          * with idiosyncrasies and pointless options.  The following flag,
 252          * when set, will force sane behavior - some options are forced on,
 253          * others are disallowed, and some controllers will change their
 254          * hierarchical or other behaviors.
 255          *
 256          * The set of behaviors affected by this flag are still being
 257          * determined and developed and the mount option for this flag is
 258          * prefixed with __DEVEL__.  The prefix will be dropped once we
 259          * reach the point where all behaviors are compatible with the
 260          * planned unified hierarchy, which will automatically turn on this
 261          * flag.
 262          *
 263          * The followings are the behaviors currently affected this flag.
 264          *
 265          * - Mount options "noprefix" and "clone_children" are disallowed.
 266          *   Also, cgroupfs file cgroup.clone_children is not created.
 267          *
 268          * - When mounting an existing superblock, mount options should
 269          *   match.
 270          *
 271          * - Remount is disallowed.
 272          *
 273          * - rename(2) is disallowed.
 274          *
 275          * - "tasks" is removed.  Everything should be at process
 276          *   granularity.  Use "cgroup.procs" instead.
 277          *
 278          * - "release_agent" and "notify_on_release" are removed.
 279          *   Replacement notification mechanism will be implemented.
 280          *
 281          * - cpuset: tasks will be kept in empty cpusets when hotplug happens
 282          *   and take masks of ancestors with non-empty cpus/mems, instead of
 283          *   being moved to an ancestor.
 284          *
 285          * - cpuset: a task can be moved into an empty cpuset, and again it
 286          *   takes masks of ancestors.
 287          *
 288          * - memcg: use_hierarchy is on by default and the cgroup file for
 289          *   the flag is not created.
 290          *
 291          * - blkcg: blk-throttle becomes properly hierarchical.
 292          */
 293         CGRP_ROOT_SANE_BEHAVIOR = (1 << 0),
 294
 295         CGRP_ROOT_NOPREFIX      = (1 << 1), /* mounted subsystems have no named prefix */
 296         CGRP_ROOT_XATTR         = (1 << 2), /* supports extended attributes */
 297
 298         /* mount options live below bit 16 */
 299         CGRP_ROOT_OPTION_MASK   = (1 << 16) - 1,
 300
 301         CGRP_ROOT_SUBSYS_BOUND  = (1 << 16), /* subsystems finished binding */
 302 };
 303
 304 /*
 305  * A cgroupfs_root represents the root of a cgroup hierarchy, and may be
 306  * associated with a superblock to form an active hierarchy.  This is
 307  * internal to cgroup core.  Don't access directly from controllers.
 308  */
 309 struct cgroupfs_root {
 310         struct super_block *sb;
 311
 312         /* The bitmask of subsystems attached to this hierarchy */
 313         unsigned long subsys_mask;
 314
 315         /* Unique id for this hierarchy. */
 316         int hierarchy_id;
 317
 318         /* A list running through the attached subsystems */
 319         struct list_head subsys_list;
 320
 321         /* The root cgroup for this hierarchy */
 322         struct cgroup top_cgroup;
 323
 324         /* Tracks how many cgroups are currently defined in hierarchy.*/
 325         int number_of_cgroups;
 326
 327         /* A list running through the active hierarchies */
 328         struct list_head root_list;
 329
 330         /* Hierarchy-specific flags */
 331         unsigned long flags;
 332
 333         /* IDs for cgroups in this hierarchy */
 334         struct idr cgroup_idr;
 335
 336         /* The path to use for release notifications. */
 337         char release_agent_path[PATH_MAX];
 338
 339         /* The name for this hierarchy - may be empty */
 340         char name[MAX_CGROUP_ROOT_NAMELEN];
 341 };
 342
 343 /*
 344  * A css_set is a structure holding pointers to a set of
 345  * cgroup_subsys_state objects. This saves space in the task struct
 346  * object and speeds up fork()/exit(), since a single inc/dec and a
 347  * list_add()/del() can bump the reference count on the entire cgroup
 348  * set for a task.
 349  */
 350
 351 struct css_set {
 352
 353         /* Reference count */
 354         atomic_t refcount;
 355
 356         /*
 357          * List running through all cgroup groups in the same hash
 358          * slot. Protected by css_set_lock
 359          */
 360         struct hlist_node hlist;
 361
 362         /*
 363          * List running through all tasks using this cgroup
 364          * group. Protected by css_set_lock
 365          */
 366         struct list_head tasks;
 367
 368         /*
 369          * List of cgrp_cset_links pointing at cgroups referenced from this
 370          * css_set.  Protected by css_set_lock.
 371          */
 372         struct list_head cgrp_links;
 373
 374         /*
 375          * Set of subsystem states, one for each subsystem. This array
 376          * is immutable after creation apart from the init_css_set
 377          * during subsystem registration (at boot time) and modular subsystem
 378          * loading/unloading.
 379          */
 380         struct cgroup_subsys_state *subsys[CGROUP_SUBSYS_COUNT];
 381
 382         /* For RCU-protected deletion */
 383         struct rcu_head rcu_head;
 384 };
 385
 386 /*
 387  * cgroup_map_cb is an abstract callback API for reporting map-valued
 388  * control files
 389  */
 390
 391 struct cgroup_map_cb {
 392         int (*fill)(struct cgroup_map_cb *cb, const char *key, u64 value);
 393         void *state;
 394 };
 395
 396 /*
 397  * struct cftype: handler definitions for cgroup control files
 398  *
 399  * When reading/writing to a file:
 400  *      - the cgroup to use is file->f_dentry->d_parent->d_fsdata
 401  *      - the 'cftype' of the file is file->f_dentry->d_fsdata
 402  */
 403
 404 /* cftype->flags */
 405 enum {
 406         CFTYPE_ONLY_ON_ROOT     = (1 << 0),     /* only create on root cgrp */
 407         CFTYPE_NOT_ON_ROOT      = (1 << 1),     /* don't create on root cgrp */
 408         CFTYPE_INSANE           = (1 << 2),     /* don't create if sane_behavior */
 409         CFTYPE_NO_PREFIX        = (1 << 3),     /* (DON'T USE FOR NEW FILES) no subsys prefix */
 410 };
 411
 412 #define MAX_CFTYPE_NAME         64
 413
 414 struct cftype {
 415         /*
 416          * By convention, the name should begin with the name of the
 417          * subsystem, followed by a period.  Zero length string indicates
 418          * end of cftype array.
 419          */
 420         char name[MAX_CFTYPE_NAME];
 421         int private;
 422         /*
 423          * If not 0, file mode is set to this value, otherwise it will
 424          * be figured out automatically
 425          */
 426         umode_t mode;
 427
 428         /*
 429          * If non-zero, defines the maximum length of string that can
 430          * be passed to write_string; defaults to 64
 431          */
 432         size_t max_write_len;
 433
 434         /* CFTYPE_* flags */
 435         unsigned int flags;
 436
 437         /*
 438          * The subsys this file belongs to.  Initialized automatically
 439          * during registration.  NULL for cgroup core files.
 440          */
 441         struct cgroup_subsys *ss;
 442
 443         int (*open)(struct inode *inode, struct file *file);
 444         ssize_t (*read)(struct cgroup_subsys_state *css, struct cftype *cft,
 445                         struct file *file,
 446                         char __user *buf, size_t nbytes, loff_t *ppos);
 447         /*
 448          * read_u64() is a shortcut for the common case of returning a
 449          * single integer. Use it in place of read()
 450          */
 451         u64 (*read_u64)(struct cgroup_subsys_state *css, struct cftype *cft);
 452         /*
 453          * read_s64() is a signed version of read_u64()
 454          */
 455         s64 (*read_s64)(struct cgroup_subsys_state *css, struct cftype *cft);
 456         /*
 457          * read_map() is used for defining a map of key/value
 458          * pairs. It should call cb->fill(cb, key, value) for each
 459          * entry. The key/value pairs (and their ordering) should not
 460          * change between reboots.
 461          */
 462         int (*read_map)(struct cgroup_subsys_state *css, struct cftype *cft,
 463                         struct cgroup_map_cb *cb);
 464         /*
 465          * read_seq_string() is used for outputting a simple sequence
 466          * using seqfile.
 467          */
 468         int (*read_seq_string)(struct cgroup_subsys_state *css,
 469                                struct cftype *cft, struct seq_file *m);
 470
 471         ssize_t (*write)(struct cgroup_subsys_state *css, struct cftype *cft,
 472                          struct file *file,
 473                          const char __user *buf, size_t nbytes, loff_t *ppos);
 474
 475         /*
 476          * write_u64() is a shortcut for the common case of accepting
 477          * a single integer (as parsed by simple_strtoull) from
 478          * userspace. Use in place of write(); return 0 or error.
 479          */
 480         int (*write_u64)(struct cgroup_subsys_state *css, struct cftype *cft,
 481                          u64 val);
 482         /*
 483          * write_s64() is a signed version of write_u64()
 484          */
 485         int (*write_s64)(struct cgroup_subsys_state *css, struct cftype *cft,
 486                          s64 val);
 487
 488         /*
 489          * write_string() is passed a nul-terminated kernelspace
 490          * buffer of maximum length determined by max_write_len.
 491          * Returns 0 or -ve error code.
 492          */
 493         int (*write_string)(struct cgroup_subsys_state *css, struct cftype *cft,
 494                             const char *buffer);
 495         /*
 496          * trigger() callback can be used to get some kick from the
 497          * userspace, when the actual string written is not important
 498          * at all. The private field can be used to determine the
 499          * kick type for multiplexing.
 500          */
 501         int (*trigger)(struct cgroup_subsys_state *css, unsigned int event);
 502 };
 503
 504 /*
 505  * cftype_sets describe cftypes belonging to a subsystem and are chained at
 506  * cgroup_subsys->cftsets.  Each cftset points to an array of cftypes
 507  * terminated by zero length name.
 508  */
 509 struct cftype_set {
 510         struct list_head                node;   /* chained at subsys->cftsets */
 511         struct cftype                   *cfts;
 512 };
 513
 514 /*
 515  * See the comment above CGRP_ROOT_SANE_BEHAVIOR for details.  This
 516  * function can be called as long as @cgrp is accessible.
 517  */
 518 static inline bool cgroup_sane_behavior(const struct cgroup *cgrp)
 519 {
 520         return cgrp->root->flags & CGRP_ROOT_SANE_BEHAVIOR;
 521 }
 522
 523 /* Caller should hold rcu_read_lock() */
 524 static inline const char *cgroup_name(const struct cgroup *cgrp)
 525 {
 526         return rcu_dereference(cgrp->name)->name;
 527 }
 528
 529 int cgroup_add_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
 530 int cgroup_rm_cftypes(struct cftype *cfts);
 531
 532 bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
 533
 534 int cgroup_path(const struct cgroup *cgrp, char *buf, int buflen);
 535 int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
 536
 537 int cgroup_task_count(const struct cgroup *cgrp);
 538
 539 /*
 540  * Control Group taskset, used to pass around set of tasks to cgroup_subsys
 541  * methods.
 542  */
 543 struct cgroup_taskset;
 544 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
 545 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
 546 struct cgroup_subsys_state *cgroup_taskset_cur_css(struct cgroup_taskset *tset,
 547                                                    int subsys_id);
 548 int cgroup_taskset_size(struct cgroup_taskset *tset);
 549
 550 /**
 551  * cgroup_taskset_for_each - iterate cgroup_taskset
 552  * @task: the loop cursor
 553  * @skip_css: skip if task's css matches this, %NULL to iterate through all
 554  * @tset: taskset to iterate
 555  */
 556 #define cgroup_taskset_for_each(task, skip_css, tset)                   \
 557         for ((task) = cgroup_taskset_first((tset)); (task);             \
 558              (task) = cgroup_taskset_next((tset)))                      \
 559                 if (!(skip_css) ||                                      \
 560                     cgroup_taskset_cur_css((tset),                      \
 561                         (skip_css)->ss->subsys_id) != (skip_css))
 562
 563 /*
 564  * Control Group subsystem type.
 565  * See Documentation/cgroups/cgroups.txt for details
 566  */
 567
 568 struct cgroup_subsys {
 569         struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
 570         int (*css_online)(struct cgroup_subsys_state *css);
 571         void (*css_offline)(struct cgroup_subsys_state *css);
 572         void (*css_free)(struct cgroup_subsys_state *css);
 573
 574         int (*can_attach)(struct cgroup_subsys_state *css,
 575                           struct cgroup_taskset *tset);
 576         void (*cancel_attach)(struct cgroup_subsys_state *css,
 577                               struct cgroup_taskset *tset);
 578         void (*attach)(struct cgroup_subsys_state *css,
 579                        struct cgroup_taskset *tset);
 580         void (*fork)(struct task_struct *task);
 581         void (*exit)(struct cgroup_subsys_state *css,
 582                      struct cgroup_subsys_state *old_css,
 583                      struct task_struct *task);
 584         void (*bind)(struct cgroup_subsys_state *root_css);
 585
 586         int subsys_id;
 587         int disabled;
 588         int early_init;
 589
 590         /*
 591          * If %false, this subsystem is properly hierarchical -
 592          * configuration, resource accounting and restriction on a parent
 593          * cgroup cover those of its children.  If %true, hierarchy support
 594          * is broken in some ways - some subsystems ignore hierarchy
 595          * completely while others are only implemented half-way.
 596          *
 597          * It's now disallowed to create nested cgroups if the subsystem is
 598          * broken and cgroup core will emit a warning message on such
 599          * cases.  Eventually, all subsystems will be made properly
 600          * hierarchical and this will go away.
 601          */
 602         bool broken_hierarchy;
 603         bool warned_broken_hierarchy;
 604
 605 #define MAX_CGROUP_TYPE_NAMELEN 32
 606         const char *name;
 607
 608         /*
 609          * Link to parent, and list entry in parent's children.
 610          * Protected by cgroup_lock()
 611          */
 612         struct cgroupfs_root *root;
 613         struct list_head sibling;
 614
 615         /* list of cftype_sets */
 616         struct list_head cftsets;
 617
 618         /* base cftypes, automatically [de]registered with subsys itself */
 619         struct cftype *base_cftypes;
 620         struct cftype_set base_cftset;
 621
 622         /* should be defined only by modular subsystems */
 623         struct module *module;
 624 };
 625
 626 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _subsys;
 627 #define IS_SUBSYS_ENABLED(option) IS_BUILTIN(option)
 628 #include <linux/cgroup_subsys.h>
 629 #undef IS_SUBSYS_ENABLED
 630 #undef SUBSYS
 631
 632 /**
 633  * css_parent - find the parent css
 634  * @css: the target cgroup_subsys_state
 635  *
 636  * Return the parent css of @css.  This function is guaranteed to return
 637  * non-NULL parent as long as @css isn't the root.
 638  */
 639 static inline
 640 struct cgroup_subsys_state *css_parent(struct cgroup_subsys_state *css)
 641 {
 642         return css->parent;
 643 }
 644
 645 /**
 646  * task_css_set_check - obtain a task's css_set with extra access conditions
 647  * @task: the task to obtain css_set for
 648  * @__c: extra condition expression to be passed to rcu_dereference_check()
 649  *
 650  * A task's css_set is RCU protected, initialized and exited while holding
 651  * task_lock(), and can only be modified while holding both cgroup_mutex
 652  * and task_lock() while the task is alive.  This macro verifies that the
 653  * caller is inside proper critical section and returns @task's css_set.
 654  *
 655  * The caller can also specify additional allowed conditions via @__c, such
 656  * as locks used during the cgroup_subsys::attach() methods.
 657  */
 658 #ifdef CONFIG_PROVE_RCU
 659 extern struct mutex cgroup_mutex;
 660 #define task_css_set_check(task, __c)                                   \
 661         rcu_dereference_check((task)->cgroups,                          \
 662                 lockdep_is_held(&(task)->alloc_lock) ||                 \
 663                 lockdep_is_held(&cgroup_mutex) || (__c))
 664 #else
 665 #define task_css_set_check(task, __c)                                   \
 666         rcu_dereference((task)->cgroups)
 667 #endif
 668
 669 /**
 670  * task_css_check - obtain css for (task, subsys) w/ extra access conds
 671  * @task: the target task
 672  * @subsys_id: the target subsystem ID
 673  * @__c: extra condition expression to be passed to rcu_dereference_check()
 674  *
 675  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
 676  * synchronization rules are the same as task_css_set_check().
 677  */
 678 #define task_css_check(task, subsys_id, __c)                            \
 679         task_css_set_check((task), (__c))->subsys[(subsys_id)]
 680
 681 /**
 682  * task_css_set - obtain a task's css_set
 683  * @task: the task to obtain css_set for
 684  *
 685  * See task_css_set_check().
 686  */
 687 static inline struct css_set *task_css_set(struct task_struct *task)
 688 {
 689         return task_css_set_check(task, false);
 690 }
 691
 692 /**
 693  * task_css - obtain css for (task, subsys)
 694  * @task: the target task
 695  * @subsys_id: the target subsystem ID
 696  *
 697  * See task_css_check().
 698  */
 699 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
 700                                                    int subsys_id)
 701 {
 702         return task_css_check(task, subsys_id, false);
 703 }
 704
 705 static inline struct cgroup *task_cgroup(struct task_struct *task,
 706                                          int subsys_id)
 707 {
 708         return task_css(task, subsys_id)->cgroup;
 709 }
 710
 711 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
 712                                            struct cgroup_subsys_state *parent);
 713
 714 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
 715
 716 /**
 717  * css_for_each_child - iterate through children of a css
 718  * @pos: the css * to use as the loop cursor
 719  * @parent: css whose children to walk
 720  *
 721  * Walk @parent's children.  Must be called under rcu_read_lock().  A child
 722  * css which hasn't finished ->css_online() or already has finished
 723  * ->css_offline() may show up during traversal and it's each subsystem's
 724  * responsibility to verify that each @pos is alive.
 725  *
 726  * If a subsystem synchronizes against the parent in its ->css_online() and
 727  * before starting iterating, a css which finished ->css_online() is
 728  * guaranteed to be visible in the future iterations.
 729  *
 730  * It is allowed to temporarily drop RCU read lock during iteration.  The
 731  * caller is responsible for ensuring that @pos remains accessible until
 732  * the start of the next iteration by, for example, bumping the css refcnt.
 733  */
 734 #define css_for_each_child(pos, parent)                                 \
 735         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
 736              (pos) = css_next_child((pos), (parent)))
 737
 738 struct cgroup_subsys_state *
 739 css_next_descendant_pre(struct cgroup_subsys_state *pos,
 740                         struct cgroup_subsys_state *css);
 741
 742 struct cgroup_subsys_state *
 743 css_rightmost_descendant(struct cgroup_subsys_state *pos);
 744
 745 /**
 746  * css_for_each_descendant_pre - pre-order walk of a css's descendants
 747  * @pos: the css * to use as the loop cursor
 748  * @root: css whose descendants to walk
 749  *
 750  * Walk @root's descendants.  @root is included in the iteration and the
 751  * first node to be visited.  Must be called under rcu_read_lock().  A
 752  * descendant css which hasn't finished ->css_online() or already has
 753  * finished ->css_offline() may show up during traversal and it's each
 754  * subsystem's responsibility to verify that each @pos is alive.
 755  *
 756  * If a subsystem synchronizes against the parent in its ->css_online() and
 757  * before starting iterating, and synchronizes against @pos on each
 758  * iteration, any descendant css which finished ->css_online() is
 759  * guaranteed to be visible in the future iterations.
 760  *
 761  * In other words, the following guarantees that a descendant can't escape
 762  * state updates of its ancestors.
 763  *
 764  * my_online(@css)
 765  * {
 766  *      Lock @css's parent and @css;
 767  *      Inherit state from the parent;
 768  *      Unlock both.
 769  * }
 770  *
 771  * my_update_state(@css)
 772  * {
 773  *      css_for_each_descendant_pre(@pos, @css) {
 774  *              Lock @pos;
 775  *              if (@pos == @css)
 776  *                      Update @css's state;
 777  *              else
 778  *                      Verify @pos is alive and inherit state from its parent;
 779  *              Unlock @pos;
 780  *      }
 781  * }
 782  *
 783  * As long as the inheriting step, including checking the parent state, is
 784  * enclosed inside @pos locking, double-locking the parent isn't necessary
 785  * while inheriting.  The state update to the parent is guaranteed to be
 786  * visible by walking order and, as long as inheriting operations to the
 787  * same @pos are atomic to each other, multiple updates racing each other
 788  * still result in the correct state.  It's guaranateed that at least one
 789  * inheritance happens for any css after the latest update to its parent.
 790  *
 791  * If checking parent's state requires locking the parent, each inheriting
 792  * iteration should lock and unlock both @pos->parent and @pos.
 793  *
 794  * Alternatively, a subsystem may choose to use a single global lock to
 795  * synchronize ->css_online() and ->css_offline() against tree-walking
 796  * operations.
 797  *
 798  * It is allowed to temporarily drop RCU read lock during iteration.  The
 799  * caller is responsible for ensuring that @pos remains accessible until
 800  * the start of the next iteration by, for example, bumping the css refcnt.
 801  */
 802 #define css_for_each_descendant_pre(pos, css)                           \
 803         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
 804              (pos) = css_next_descendant_pre((pos), (css)))
 805
 806 struct cgroup_subsys_state *
 807 css_next_descendant_post(struct cgroup_subsys_state *pos,
 808                          struct cgroup_subsys_state *css);
 809
 810 /**
 811  * css_for_each_descendant_post - post-order walk of a css's descendants
 812  * @pos: the css * to use as the loop cursor
 813  * @css: css whose descendants to walk
 814  *
 815  * Similar to css_for_each_descendant_pre() but performs post-order
 816  * traversal instead.  @root is included in the iteration and the last
 817  * node to be visited.  Note that the walk visibility guarantee described
 818  * in pre-order walk doesn't apply the same to post-order walks.
 819  */
 820 #define css_for_each_descendant_post(pos, css)                          \
 821         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
 822              (pos) = css_next_descendant_post((pos), (css)))
 823
 824 /* A css_task_iter should be treated as an opaque object */
 825 struct css_task_iter {
 826         struct cgroup_subsys_state      *origin_css;
 827         struct list_head                *cset_link;
 828         struct list_head                *task;
 829 };
 830
 831 void css_task_iter_start(struct cgroup_subsys_state *css,
 832                          struct css_task_iter *it);
 833 struct task_struct *css_task_iter_next(struct css_task_iter *it);
 834 void css_task_iter_end(struct css_task_iter *it);
 835
 836 int css_scan_tasks(struct cgroup_subsys_state *css,
 837                    bool (*test)(struct task_struct *, void *),
 838                    void (*process)(struct task_struct *, void *),
 839                    void *data, struct ptr_heap *heap);
 840
 841 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
 842 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
 843
 844 struct cgroup_subsys_state *css_from_dir(struct dentry *dentry,
 845                                          struct cgroup_subsys *ss);
 846
 847 #else /* !CONFIG_CGROUPS */
 848
 849 static inline int cgroup_init_early(void) { return 0; }
 850 static inline int cgroup_init(void) { return 0; }
 851 static inline void cgroup_fork(struct task_struct *p) {}
 852 static inline void cgroup_post_fork(struct task_struct *p) {}
 853 static inline void cgroup_exit(struct task_struct *p, int callbacks) {}
 854
 855 static inline int cgroupstats_build(struct cgroupstats *stats,
 856                                         struct dentry *dentry)
 857 {
 858         return -EINVAL;
 859 }
 860
 861 /* No cgroups - nothing to do */
 862 static inline int cgroup_attach_task_all(struct task_struct *from,
 863                                          struct task_struct *t)
 864 {
 865         return 0;
 866 }
 867
 868 #endif /* !CONFIG_CGROUPS */
 869
 870 #endif /* _LINUX_CGROUP_H */