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/rculist.h>
  15 #include <linux/cgroupstats.h>
  16 #include <linux/rwsem.h>
  17 #include <linux/fs.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/kernfs.h>
  20
  21 #include <linux/cgroup-defs.h>
  22
  23 #ifdef CONFIG_CGROUPS
  24
  25 /*
  26  * All weight knobs on the default hierarhcy should use the following min,
  27  * default and max values.  The default value is the logarithmic center of
  28  * MIN and MAX and allows 100x to be expressed in both directions.
  29  */
  30 #define CGROUP_WEIGHT_MIN               1
  31 #define CGROUP_WEIGHT_DFL               100
  32 #define CGROUP_WEIGHT_MAX               10000
  33
  34 /* a css_task_iter should be treated as an opaque object */
  35 struct css_task_iter {
  36         struct cgroup_subsys            *ss;
  37
  38         struct list_head                *cset_pos;
  39         struct list_head                *cset_head;
  40
  41         struct list_head                *task_pos;
  42         struct list_head                *tasks_head;
  43         struct list_head                *mg_tasks_head;
  44 };
  45
  46 extern struct cgroup_root cgrp_dfl_root;
  47 extern struct css_set init_css_set;
  48
  49 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
  50 #include <linux/cgroup_subsys.h>
  51 #undef SUBSYS
  52
  53 bool css_has_online_children(struct cgroup_subsys_state *css);
  54 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
  55 struct cgroup_subsys_state *cgroup_get_e_css(struct cgroup *cgroup,
  56                                              struct cgroup_subsys *ss);
  57 struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
  58                                                        struct cgroup_subsys *ss);
  59
  60 bool cgroup_is_descendant(struct cgroup *cgrp, struct cgroup *ancestor);
  61 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
  62 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
  63
  64 int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  65 int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
  66 int cgroup_rm_cftypes(struct cftype *cfts);
  67
  68 char *task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
  69 int cgroupstats_build(struct cgroupstats *stats, struct dentry *dentry);
  70 int proc_cgroup_show(struct seq_file *m, struct pid_namespace *ns,
  71                      struct pid *pid, struct task_struct *tsk);
  72
  73 void cgroup_fork(struct task_struct *p);
  74 void cgroup_post_fork(struct task_struct *p);
  75 void cgroup_exit(struct task_struct *p);
  76
  77 int cgroup_init_early(void);
  78 int cgroup_init(void);
  79
  80 /*
  81  * Iteration helpers and macros.
  82  */
  83
  84 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
  85                                            struct cgroup_subsys_state *parent);
  86 struct cgroup_subsys_state *css_next_descendant_pre(struct cgroup_subsys_state *pos,
  87                                                     struct cgroup_subsys_state *css);
  88 struct cgroup_subsys_state *css_rightmost_descendant(struct cgroup_subsys_state *pos);
  89 struct cgroup_subsys_state *css_next_descendant_post(struct cgroup_subsys_state *pos,
  90                                                      struct cgroup_subsys_state *css);
  91
  92 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset);
  93 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset);
  94
  95 void css_task_iter_start(struct cgroup_subsys_state *css,
  96                          struct css_task_iter *it);
  97 struct task_struct *css_task_iter_next(struct css_task_iter *it);
  98 void css_task_iter_end(struct css_task_iter *it);
  99
 100 /**
 101  * css_for_each_child - iterate through children of a css
 102  * @pos: the css * to use as the loop cursor
 103  * @parent: css whose children to walk
 104  *
 105  * Walk @parent's children.  Must be called under rcu_read_lock().
 106  *
 107  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 108  * css which finished ->css_online() is guaranteed to be visible in the
 109  * future iterations and will stay visible until the last reference is put.
 110  * A css which hasn't finished ->css_online() or already finished
 111  * ->css_offline() may show up during traversal.  It's each subsystem's
 112  * responsibility to synchronize against on/offlining.
 113  *
 114  * It is allowed to temporarily drop RCU read lock during iteration.  The
 115  * caller is responsible for ensuring that @pos remains accessible until
 116  * the start of the next iteration by, for example, bumping the css refcnt.
 117  */
 118 #define css_for_each_child(pos, parent)                                 \
 119         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
 120              (pos) = css_next_child((pos), (parent)))
 121
 122 /**
 123  * css_for_each_descendant_pre - pre-order walk of a css's descendants
 124  * @pos: the css * to use as the loop cursor
 125  * @root: css whose descendants to walk
 126  *
 127  * Walk @root's descendants.  @root is included in the iteration and the
 128  * first node to be visited.  Must be called under rcu_read_lock().
 129  *
 130  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 131  * css which finished ->css_online() is guaranteed to be visible in the
 132  * future iterations and will stay visible until the last reference is put.
 133  * A css which hasn't finished ->css_online() or already finished
 134  * ->css_offline() may show up during traversal.  It's each subsystem's
 135  * responsibility to synchronize against on/offlining.
 136  *
 137  * For example, the following guarantees that a descendant can't escape
 138  * state updates of its ancestors.
 139  *
 140  * my_online(@css)
 141  * {
 142  *      Lock @css's parent and @css;
 143  *      Inherit state from the parent;
 144  *      Unlock both.
 145  * }
 146  *
 147  * my_update_state(@css)
 148  * {
 149  *      css_for_each_descendant_pre(@pos, @css) {
 150  *              Lock @pos;
 151  *              if (@pos == @css)
 152  *                      Update @css's state;
 153  *              else
 154  *                      Verify @pos is alive and inherit state from its parent;
 155  *              Unlock @pos;
 156  *      }
 157  * }
 158  *
 159  * As long as the inheriting step, including checking the parent state, is
 160  * enclosed inside @pos locking, double-locking the parent isn't necessary
 161  * while inheriting.  The state update to the parent is guaranteed to be
 162  * visible by walking order and, as long as inheriting operations to the
 163  * same @pos are atomic to each other, multiple updates racing each other
 164  * still result in the correct state.  It's guaranateed that at least one
 165  * inheritance happens for any css after the latest update to its parent.
 166  *
 167  * If checking parent's state requires locking the parent, each inheriting
 168  * iteration should lock and unlock both @pos->parent and @pos.
 169  *
 170  * Alternatively, a subsystem may choose to use a single global lock to
 171  * synchronize ->css_online() and ->css_offline() against tree-walking
 172  * operations.
 173  *
 174  * It is allowed to temporarily drop RCU read lock during iteration.  The
 175  * caller is responsible for ensuring that @pos remains accessible until
 176  * the start of the next iteration by, for example, bumping the css refcnt.
 177  */
 178 #define css_for_each_descendant_pre(pos, css)                           \
 179         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
 180              (pos) = css_next_descendant_pre((pos), (css)))
 181
 182 /**
 183  * css_for_each_descendant_post - post-order walk of a css's descendants
 184  * @pos: the css * to use as the loop cursor
 185  * @css: css whose descendants to walk
 186  *
 187  * Similar to css_for_each_descendant_pre() but performs post-order
 188  * traversal instead.  @root is included in the iteration and the last
 189  * node to be visited.
 190  *
 191  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 192  * css which finished ->css_online() is guaranteed to be visible in the
 193  * future iterations and will stay visible until the last reference is put.
 194  * A css which hasn't finished ->css_online() or already finished
 195  * ->css_offline() may show up during traversal.  It's each subsystem's
 196  * responsibility to synchronize against on/offlining.
 197  *
 198  * Note that the walk visibility guarantee example described in pre-order
 199  * walk doesn't apply the same to post-order walks.
 200  */
 201 #define css_for_each_descendant_post(pos, css)                          \
 202         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
 203              (pos) = css_next_descendant_post((pos), (css)))
 204
 205 /**
 206  * cgroup_taskset_for_each - iterate cgroup_taskset
 207  * @task: the loop cursor
 208  * @tset: taskset to iterate
 209  */
 210 #define cgroup_taskset_for_each(task, tset)                             \
 211         for ((task) = cgroup_taskset_first((tset)); (task);             \
 212              (task) = cgroup_taskset_next((tset)))
 213
 214 /*
 215  * Inline functions.
 216  */
 217
 218 /**
 219  * css_get - obtain a reference on the specified css
 220  * @css: target css
 221  *
 222  * The caller must already have a reference.
 223  */
 224 static inline void css_get(struct cgroup_subsys_state *css)
 225 {
 226         if (!(css->flags & CSS_NO_REF))
 227                 percpu_ref_get(&css->refcnt);
 228 }
 229
 230 /**
 231  * css_get_many - obtain references on the specified css
 232  * @css: target css
 233  * @n: number of references to get
 234  *
 235  * The caller must already have a reference.
 236  */
 237 static inline void css_get_many(struct cgroup_subsys_state *css, unsigned int n)
 238 {
 239         if (!(css->flags & CSS_NO_REF))
 240                 percpu_ref_get_many(&css->refcnt, n);
 241 }
 242
 243 /**
 244  * css_tryget - try to obtain a reference on the specified css
 245  * @css: target css
 246  *
 247  * Obtain a reference on @css unless it already has reached zero and is
 248  * being released.  This function doesn't care whether @css is on or
 249  * offline.  The caller naturally needs to ensure that @css is accessible
 250  * but doesn't have to be holding a reference on it - IOW, RCU protected
 251  * access is good enough for this function.  Returns %true if a reference
 252  * count was successfully obtained; %false otherwise.
 253  */
 254 static inline bool css_tryget(struct cgroup_subsys_state *css)
 255 {
 256         if (!(css->flags & CSS_NO_REF))
 257                 return percpu_ref_tryget(&css->refcnt);
 258         return true;
 259 }
 260
 261 /**
 262  * css_tryget_online - try to obtain a reference on the specified css if online
 263  * @css: target css
 264  *
 265  * Obtain a reference on @css if it's online.  The caller naturally needs
 266  * to ensure that @css is accessible but doesn't have to be holding a
 267  * reference on it - IOW, RCU protected access is good enough for this
 268  * function.  Returns %true if a reference count was successfully obtained;
 269  * %false otherwise.
 270  */
 271 static inline bool css_tryget_online(struct cgroup_subsys_state *css)
 272 {
 273         if (!(css->flags & CSS_NO_REF))
 274                 return percpu_ref_tryget_live(&css->refcnt);
 275         return true;
 276 }
 277
 278 /**
 279  * css_put - put a css reference
 280  * @css: target css
 281  *
 282  * Put a reference obtained via css_get() and css_tryget_online().
 283  */
 284 static inline void css_put(struct cgroup_subsys_state *css)
 285 {
 286         if (!(css->flags & CSS_NO_REF))
 287                 percpu_ref_put(&css->refcnt);
 288 }
 289
 290 /**
 291  * css_put_many - put css references
 292  * @css: target css
 293  * @n: number of references to put
 294  *
 295  * Put references obtained via css_get() and css_tryget_online().
 296  */
 297 static inline void css_put_many(struct cgroup_subsys_state *css, unsigned int n)
 298 {
 299         if (!(css->flags & CSS_NO_REF))
 300                 percpu_ref_put_many(&css->refcnt, n);
 301 }
 302
 303 /**
 304  * task_css_set_check - obtain a task's css_set with extra access conditions
 305  * @task: the task to obtain css_set for
 306  * @__c: extra condition expression to be passed to rcu_dereference_check()
 307  *
 308  * A task's css_set is RCU protected, initialized and exited while holding
 309  * task_lock(), and can only be modified while holding both cgroup_mutex
 310  * and task_lock() while the task is alive.  This macro verifies that the
 311  * caller is inside proper critical section and returns @task's css_set.
 312  *
 313  * The caller can also specify additional allowed conditions via @__c, such
 314  * as locks used during the cgroup_subsys::attach() methods.
 315  */
 316 #ifdef CONFIG_PROVE_RCU
 317 extern struct mutex cgroup_mutex;
 318 extern struct rw_semaphore css_set_rwsem;
 319 #define task_css_set_check(task, __c)                                   \
 320         rcu_dereference_check((task)->cgroups,                          \
 321                 lockdep_is_held(&cgroup_mutex) ||                       \
 322                 lockdep_is_held(&css_set_rwsem) ||                      \
 323                 ((task)->flags & PF_EXITING) || (__c))
 324 #else
 325 #define task_css_set_check(task, __c)                                   \
 326         rcu_dereference((task)->cgroups)
 327 #endif
 328
 329 /**
 330  * task_css_check - obtain css for (task, subsys) w/ extra access conds
 331  * @task: the target task
 332  * @subsys_id: the target subsystem ID
 333  * @__c: extra condition expression to be passed to rcu_dereference_check()
 334  *
 335  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
 336  * synchronization rules are the same as task_css_set_check().
 337  */
 338 #define task_css_check(task, subsys_id, __c)                            \
 339         task_css_set_check((task), (__c))->subsys[(subsys_id)]
 340
 341 /**
 342  * task_css_set - obtain a task's css_set
 343  * @task: the task to obtain css_set for
 344  *
 345  * See task_css_set_check().
 346  */
 347 static inline struct css_set *task_css_set(struct task_struct *task)
 348 {
 349         return task_css_set_check(task, false);
 350 }
 351
 352 /**
 353  * task_css - obtain css for (task, subsys)
 354  * @task: the target task
 355  * @subsys_id: the target subsystem ID
 356  *
 357  * See task_css_check().
 358  */
 359 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
 360                                                    int subsys_id)
 361 {
 362         return task_css_check(task, subsys_id, false);
 363 }
 364
 365 /**
 366  * task_get_css - find and get the css for (task, subsys)
 367  * @task: the target task
 368  * @subsys_id: the target subsystem ID
 369  *
 370  * Find the css for the (@task, @subsys_id) combination, increment a
 371  * reference on and return it.  This function is guaranteed to return a
 372  * valid css.
 373  */
 374 static inline struct cgroup_subsys_state *
 375 task_get_css(struct task_struct *task, int subsys_id)
 376 {
 377         struct cgroup_subsys_state *css;
 378
 379         rcu_read_lock();
 380         while (true) {
 381                 css = task_css(task, subsys_id);
 382                 if (likely(css_tryget_online(css)))
 383                         break;
 384                 cpu_relax();
 385         }
 386         rcu_read_unlock();
 387         return css;
 388 }
 389
 390 /**
 391  * task_css_is_root - test whether a task belongs to the root css
 392  * @task: the target task
 393  * @subsys_id: the target subsystem ID
 394  *
 395  * Test whether @task belongs to the root css on the specified subsystem.
 396  * May be invoked in any context.
 397  */
 398 static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
 399 {
 400         return task_css_check(task, subsys_id, true) ==
 401                 init_css_set.subsys[subsys_id];
 402 }
 403
 404 static inline struct cgroup *task_cgroup(struct task_struct *task,
 405                                          int subsys_id)
 406 {
 407         return task_css(task, subsys_id)->cgroup;
 408 }
 409
 410 /**
 411  * cgroup_on_dfl - test whether a cgroup is on the default hierarchy
 412  * @cgrp: the cgroup of interest
 413  *
 414  * The default hierarchy is the v2 interface of cgroup and this function
 415  * can be used to test whether a cgroup is on the default hierarchy for
 416  * cases where a subsystem should behave differnetly depending on the
 417  * interface version.
 418  *
 419  * The set of behaviors which change on the default hierarchy are still
 420  * being determined and the mount option is prefixed with __DEVEL__.
 421  *
 422  * List of changed behaviors:
 423  *
 424  * - Mount options "noprefix", "xattr", "clone_children", "release_agent"
 425  *   and "name" are disallowed.
 426  *
 427  * - When mounting an existing superblock, mount options should match.
 428  *
 429  * - Remount is disallowed.
 430  *
 431  * - rename(2) is disallowed.
 432  *
 433  * - "tasks" is removed.  Everything should be at process granularity.  Use
 434  *   "cgroup.procs" instead.
 435  *
 436  * - "cgroup.procs" is not sorted.  pids will be unique unless they got
 437  *   recycled inbetween reads.
 438  *
 439  * - "release_agent" and "notify_on_release" are removed.  Replacement
 440  *   notification mechanism will be implemented.
 441  *
 442  * - "cgroup.clone_children" is removed.
 443  *
 444  * - "cgroup.subtree_populated" is available.  Its value is 0 if the cgroup
 445  *   and its descendants contain no task; otherwise, 1.  The file also
 446  *   generates kernfs notification which can be monitored through poll and
 447  *   [di]notify when the value of the file changes.
 448  *
 449  * - cpuset: tasks will be kept in empty cpusets when hotplug happens and
 450  *   take masks of ancestors with non-empty cpus/mems, instead of being
 451  *   moved to an ancestor.
 452  *
 453  * - cpuset: a task can be moved into an empty cpuset, and again it takes
 454  *   masks of ancestors.
 455  *
 456  * - memcg: use_hierarchy is on by default and the cgroup file for the flag
 457  *   is not created.
 458  *
 459  * - blkcg: blk-throttle becomes properly hierarchical.
 460  *
 461  * - debug: disallowed on the default hierarchy.
 462  */
 463 static inline bool cgroup_on_dfl(const struct cgroup *cgrp)
 464 {
 465         return cgrp->root == &cgrp_dfl_root;
 466 }
 467
 468 /* no synchronization, the result can only be used as a hint */
 469 static inline bool cgroup_has_tasks(struct cgroup *cgrp)
 470 {
 471         return !list_empty(&cgrp->cset_links);
 472 }
 473
 474 /* returns ino associated with a cgroup */
 475 static inline ino_t cgroup_ino(struct cgroup *cgrp)
 476 {
 477         return cgrp->kn->ino;
 478 }
 479
 480 /* cft/css accessors for cftype->write() operation */
 481 static inline struct cftype *of_cft(struct kernfs_open_file *of)
 482 {
 483         return of->kn->priv;
 484 }
 485
 486 struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
 487
 488 /* cft/css accessors for cftype->seq_*() operations */
 489 static inline struct cftype *seq_cft(struct seq_file *seq)
 490 {
 491         return of_cft(seq->private);
 492 }
 493
 494 static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
 495 {
 496         return of_css(seq->private);
 497 }
 498
 499 /*
 500  * Name / path handling functions.  All are thin wrappers around the kernfs
 501  * counterparts and can be called under any context.
 502  */
 503
 504 static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
 505 {
 506         return kernfs_name(cgrp->kn, buf, buflen);
 507 }
 508
 509 static inline char * __must_check cgroup_path(struct cgroup *cgrp, char *buf,
 510                                               size_t buflen)
 511 {
 512         return kernfs_path(cgrp->kn, buf, buflen);
 513 }
 514
 515 static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
 516 {
 517         pr_cont_kernfs_name(cgrp->kn);
 518 }
 519
 520 static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
 521 {
 522         pr_cont_kernfs_path(cgrp->kn);
 523 }
 524
 525 #else /* !CONFIG_CGROUPS */
 526
 527 struct cgroup_subsys_state;
 528
 529 static inline void css_put(struct cgroup_subsys_state *css) {}
 530 static inline int cgroup_attach_task_all(struct task_struct *from,
 531                                          struct task_struct *t) { return 0; }
 532 static inline int cgroupstats_build(struct cgroupstats *stats,
 533                                     struct dentry *dentry) { return -EINVAL; }
 534
 535 static inline void cgroup_fork(struct task_struct *p) {}
 536 static inline void cgroup_post_fork(struct task_struct *p) {}
 537 static inline void cgroup_exit(struct task_struct *p) {}
 538
 539 static inline int cgroup_init_early(void) { return 0; }
 540 static inline int cgroup_init(void) { return 0; }
 541
 542 #endif /* !CONFIG_CGROUPS */
 543
 544 #endif /* _LINUX_CGROUP_H */