include/linux/cgroup.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_CGROUP_H
   3 #define _LINUX_CGROUP_H
   4 /*
   5  *  cgroup interface
   6  *
   7  *  Copyright (C) 2003 BULL SA
   8  *  Copyright (C) 2004-2006 Silicon Graphics, Inc.
   9  *
  10  */
  11
  12 #include <linux/sched.h>
  13 #include <linux/cpumask.h>
  14 #include <linux/nodemask.h>
  15 #include <linux/rculist.h>
  16 #include <linux/cgroupstats.h>
  17 #include <linux/fs.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/kernfs.h>
  20 #include <linux/jump_label.h>
  21 #include <linux/types.h>
  22 #include <linux/ns_common.h>
  23 #include <linux/nsproxy.h>
  24 #include <linux/user_namespace.h>
  25 #include <linux/refcount.h>
  26 #include <linux/kernel_stat.h>
  27
  28 #include <linux/cgroup-defs.h>
  29
  30 struct kernel_clone_args;
  31
  32 #ifdef CONFIG_CGROUPS
  33
  34 /*
  35  * All weight knobs on the default hierarchy should use the following min,
  36  * default and max values.  The default value is the logarithmic center of
  37  * MIN and MAX and allows 100x to be expressed in both directions.
  38  */
  39 #define CGROUP_WEIGHT_MIN               1
  40 #define CGROUP_WEIGHT_DFL               100
  41 #define CGROUP_WEIGHT_MAX               10000
  42
  43 /* walk only threadgroup leaders */
  44 #define CSS_TASK_ITER_PROCS             (1U << 0)
  45 /* walk all threaded css_sets in the domain */
  46 #define CSS_TASK_ITER_THREADED          (1U << 1)
  47
  48 /* internal flags */
  49 #define CSS_TASK_ITER_SKIPPED           (1U << 16)
  50
  51 /* a css_task_iter should be treated as an opaque object */
  52 struct css_task_iter {
  53         struct cgroup_subsys            *ss;
  54         unsigned int                    flags;
  55
  56         struct list_head                *cset_pos;
  57         struct list_head                *cset_head;
  58
  59         struct list_head                *tcset_pos;
  60         struct list_head                *tcset_head;
  61
  62         struct list_head                *task_pos;
  63
  64         struct list_head                *cur_tasks_head;
  65         struct css_set                  *cur_cset;
  66         struct css_set                  *cur_dcset;
  67         struct task_struct              *cur_task;
  68         struct list_head                iters_node;     /* css_set->task_iters */
  69 };
  70
  71 extern struct cgroup_root cgrp_dfl_root;
  72 extern struct css_set init_css_set;
  73
  74 #define SUBSYS(_x) extern struct cgroup_subsys _x ## _cgrp_subsys;
  75 #include <linux/cgroup_subsys.h>
  76 #undef SUBSYS
  77
  78 #define SUBSYS(_x)                                                              \
  79         extern struct static_key_true _x ## _cgrp_subsys_enabled_key;           \
  80         extern struct static_key_true _x ## _cgrp_subsys_on_dfl_key;
  81 #include <linux/cgroup_subsys.h>
  82 #undef SUBSYS
  83
  84 /**
  85  * cgroup_subsys_enabled - fast test on whether a subsys is enabled
  86  * @ss: subsystem in question
  87  */
  88 #define cgroup_subsys_enabled(ss)                                               \
  89         static_branch_likely(&ss ## _enabled_key)
  90
  91 /**
  92  * cgroup_subsys_on_dfl - fast test on whether a subsys is on default hierarchy
  93  * @ss: subsystem in question
  94  */
  95 #define cgroup_subsys_on_dfl(ss)                                                \
  96         static_branch_likely(&ss ## _on_dfl_key)
  97
  98 bool css_has_online_children(struct cgroup_subsys_state *css);
  99 struct cgroup_subsys_state *css_from_id(int id, struct cgroup_subsys *ss);
 100 struct cgroup_subsys_state *cgroup_e_css(struct cgroup *cgroup,
 101                                          struct cgroup_subsys *ss);
 102 struct cgroup_subsys_state *cgroup_get_e_css(struct cgroup *cgroup,
 103                                              struct cgroup_subsys *ss);
 104 struct cgroup_subsys_state *css_tryget_online_from_dir(struct dentry *dentry,
 105                                                        struct cgroup_subsys *ss);
 106
 107 struct cgroup *cgroup_get_from_path(const char *path);
 108 struct cgroup *cgroup_get_from_fd(int fd);
 109
 110 int cgroup_attach_task_all(struct task_struct *from, struct task_struct *);
 111 int cgroup_transfer_tasks(struct cgroup *to, struct cgroup *from);
 112
 113 int cgroup_add_dfl_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
 114 int cgroup_add_legacy_cftypes(struct cgroup_subsys *ss, struct cftype *cfts);
 115 int cgroup_rm_cftypes(struct cftype *cfts);
 116 void cgroup_file_notify(struct cgroup_file *cfile);
 117 void cgroup_file_show(struct cgroup_file *cfile, bool show);
 118
 119 int task_cgroup_path(struct task_struct *task, char *buf, size_t buflen);
 120 int cgroupstats_build(struct cgroupstats *stats, struct dentry *dentry);
 121 int proc_cgroup_show(struct seq_file *m, struct pid_namespace *ns,
 122                      struct pid *pid, struct task_struct *tsk);
 123
 124 void cgroup_fork(struct task_struct *p);
 125 extern int cgroup_can_fork(struct task_struct *p,
 126                            struct kernel_clone_args *kargs);
 127 extern void cgroup_cancel_fork(struct task_struct *p,
 128                                struct kernel_clone_args *kargs);
 129 extern void cgroup_post_fork(struct task_struct *p,
 130                              struct kernel_clone_args *kargs);
 131 void cgroup_exit(struct task_struct *p);
 132 void cgroup_release(struct task_struct *p);
 133 void cgroup_free(struct task_struct *p);
 134
 135 int cgroup_init_early(void);
 136 int cgroup_init(void);
 137
 138 int cgroup_parse_float(const char *input, unsigned dec_shift, s64 *v);
 139
 140 /*
 141  * Iteration helpers and macros.
 142  */
 143
 144 struct cgroup_subsys_state *css_next_child(struct cgroup_subsys_state *pos,
 145                                            struct cgroup_subsys_state *parent);
 146 struct cgroup_subsys_state *css_next_descendant_pre(struct cgroup_subsys_state *pos,
 147                                                     struct cgroup_subsys_state *css);
 148 struct cgroup_subsys_state *css_rightmost_descendant(struct cgroup_subsys_state *pos);
 149 struct cgroup_subsys_state *css_next_descendant_post(struct cgroup_subsys_state *pos,
 150                                                      struct cgroup_subsys_state *css);
 151
 152 struct task_struct *cgroup_taskset_first(struct cgroup_taskset *tset,
 153                                          struct cgroup_subsys_state **dst_cssp);
 154 struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset,
 155                                         struct cgroup_subsys_state **dst_cssp);
 156
 157 void css_task_iter_start(struct cgroup_subsys_state *css, unsigned int flags,
 158                          struct css_task_iter *it);
 159 struct task_struct *css_task_iter_next(struct css_task_iter *it);
 160 void css_task_iter_end(struct css_task_iter *it);
 161
 162 /**
 163  * css_for_each_child - iterate through children of a css
 164  * @pos: the css * to use as the loop cursor
 165  * @parent: css whose children to walk
 166  *
 167  * Walk @parent's children.  Must be called under rcu_read_lock().
 168  *
 169  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 170  * css which finished ->css_online() is guaranteed to be visible in the
 171  * future iterations and will stay visible until the last reference is put.
 172  * A css which hasn't finished ->css_online() or already finished
 173  * ->css_offline() may show up during traversal.  It's each subsystem's
 174  * responsibility to synchronize against on/offlining.
 175  *
 176  * It is allowed to temporarily drop RCU read lock during iteration.  The
 177  * caller is responsible for ensuring that @pos remains accessible until
 178  * the start of the next iteration by, for example, bumping the css refcnt.
 179  */
 180 #define css_for_each_child(pos, parent)                                 \
 181         for ((pos) = css_next_child(NULL, (parent)); (pos);             \
 182              (pos) = css_next_child((pos), (parent)))
 183
 184 /**
 185  * css_for_each_descendant_pre - pre-order walk of a css's descendants
 186  * @pos: the css * to use as the loop cursor
 187  * @root: css whose descendants to walk
 188  *
 189  * Walk @root's descendants.  @root is included in the iteration and the
 190  * first node to be visited.  Must be called under rcu_read_lock().
 191  *
 192  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 193  * css which finished ->css_online() is guaranteed to be visible in the
 194  * future iterations and will stay visible until the last reference is put.
 195  * A css which hasn't finished ->css_online() or already finished
 196  * ->css_offline() may show up during traversal.  It's each subsystem's
 197  * responsibility to synchronize against on/offlining.
 198  *
 199  * For example, the following guarantees that a descendant can't escape
 200  * state updates of its ancestors.
 201  *
 202  * my_online(@css)
 203  * {
 204  *      Lock @css's parent and @css;
 205  *      Inherit state from the parent;
 206  *      Unlock both.
 207  * }
 208  *
 209  * my_update_state(@css)
 210  * {
 211  *      css_for_each_descendant_pre(@pos, @css) {
 212  *              Lock @pos;
 213  *              if (@pos == @css)
 214  *                      Update @css's state;
 215  *              else
 216  *                      Verify @pos is alive and inherit state from its parent;
 217  *              Unlock @pos;
 218  *      }
 219  * }
 220  *
 221  * As long as the inheriting step, including checking the parent state, is
 222  * enclosed inside @pos locking, double-locking the parent isn't necessary
 223  * while inheriting.  The state update to the parent is guaranteed to be
 224  * visible by walking order and, as long as inheriting operations to the
 225  * same @pos are atomic to each other, multiple updates racing each other
 226  * still result in the correct state.  It's guaranateed that at least one
 227  * inheritance happens for any css after the latest update to its parent.
 228  *
 229  * If checking parent's state requires locking the parent, each inheriting
 230  * iteration should lock and unlock both @pos->parent and @pos.
 231  *
 232  * Alternatively, a subsystem may choose to use a single global lock to
 233  * synchronize ->css_online() and ->css_offline() against tree-walking
 234  * operations.
 235  *
 236  * It is allowed to temporarily drop RCU read lock during iteration.  The
 237  * caller is responsible for ensuring that @pos remains accessible until
 238  * the start of the next iteration by, for example, bumping the css refcnt.
 239  */
 240 #define css_for_each_descendant_pre(pos, css)                           \
 241         for ((pos) = css_next_descendant_pre(NULL, (css)); (pos);       \
 242              (pos) = css_next_descendant_pre((pos), (css)))
 243
 244 /**
 245  * css_for_each_descendant_post - post-order walk of a css's descendants
 246  * @pos: the css * to use as the loop cursor
 247  * @css: css whose descendants to walk
 248  *
 249  * Similar to css_for_each_descendant_pre() but performs post-order
 250  * traversal instead.  @root is included in the iteration and the last
 251  * node to be visited.
 252  *
 253  * If a subsystem synchronizes ->css_online() and the start of iteration, a
 254  * css which finished ->css_online() is guaranteed to be visible in the
 255  * future iterations and will stay visible until the last reference is put.
 256  * A css which hasn't finished ->css_online() or already finished
 257  * ->css_offline() may show up during traversal.  It's each subsystem's
 258  * responsibility to synchronize against on/offlining.
 259  *
 260  * Note that the walk visibility guarantee example described in pre-order
 261  * walk doesn't apply the same to post-order walks.
 262  */
 263 #define css_for_each_descendant_post(pos, css)                          \
 264         for ((pos) = css_next_descendant_post(NULL, (css)); (pos);      \
 265              (pos) = css_next_descendant_post((pos), (css)))
 266
 267 /**
 268  * cgroup_taskset_for_each - iterate cgroup_taskset
 269  * @task: the loop cursor
 270  * @dst_css: the destination css
 271  * @tset: taskset to iterate
 272  *
 273  * @tset may contain multiple tasks and they may belong to multiple
 274  * processes.
 275  *
 276  * On the v2 hierarchy, there may be tasks from multiple processes and they
 277  * may not share the source or destination csses.
 278  *
 279  * On traditional hierarchies, when there are multiple tasks in @tset, if a
 280  * task of a process is in @tset, all tasks of the process are in @tset.
 281  * Also, all are guaranteed to share the same source and destination csses.
 282  *
 283  * Iteration is not in any specific order.
 284  */
 285 #define cgroup_taskset_for_each(task, dst_css, tset)                    \
 286         for ((task) = cgroup_taskset_first((tset), &(dst_css));         \
 287              (task);                                                    \
 288              (task) = cgroup_taskset_next((tset), &(dst_css)))
 289
 290 /**
 291  * cgroup_taskset_for_each_leader - iterate group leaders in a cgroup_taskset
 292  * @leader: the loop cursor
 293  * @dst_css: the destination css
 294  * @tset: taskset to iterate
 295  *
 296  * Iterate threadgroup leaders of @tset.  For single-task migrations, @tset
 297  * may not contain any.
 298  */
 299 #define cgroup_taskset_for_each_leader(leader, dst_css, tset)           \
 300         for ((leader) = cgroup_taskset_first((tset), &(dst_css));       \
 301              (leader);                                                  \
 302              (leader) = cgroup_taskset_next((tset), &(dst_css)))        \
 303                 if ((leader) != (leader)->group_leader)                 \
 304                         ;                                               \
 305                 else
 306
 307 /*
 308  * Inline functions.
 309  */
 310
 311 static inline u64 cgroup_id(const struct cgroup *cgrp)
 312 {
 313         return cgrp->kn->id;
 314 }
 315
 316 /**
 317  * css_get - obtain a reference on the specified css
 318  * @css: target css
 319  *
 320  * The caller must already have a reference.
 321  */
 322 static inline void css_get(struct cgroup_subsys_state *css)
 323 {
 324         if (!(css->flags & CSS_NO_REF))
 325                 percpu_ref_get(&css->refcnt);
 326 }
 327
 328 /**
 329  * css_get_many - obtain references on the specified css
 330  * @css: target css
 331  * @n: number of references to get
 332  *
 333  * The caller must already have a reference.
 334  */
 335 static inline void css_get_many(struct cgroup_subsys_state *css, unsigned int n)
 336 {
 337         if (!(css->flags & CSS_NO_REF))
 338                 percpu_ref_get_many(&css->refcnt, n);
 339 }
 340
 341 /**
 342  * css_tryget - try to obtain a reference on the specified css
 343  * @css: target css
 344  *
 345  * Obtain a reference on @css unless it already has reached zero and is
 346  * being released.  This function doesn't care whether @css is on or
 347  * offline.  The caller naturally needs to ensure that @css is accessible
 348  * but doesn't have to be holding a reference on it - IOW, RCU protected
 349  * access is good enough for this function.  Returns %true if a reference
 350  * count was successfully obtained; %false otherwise.
 351  */
 352 static inline bool css_tryget(struct cgroup_subsys_state *css)
 353 {
 354         if (!(css->flags & CSS_NO_REF))
 355                 return percpu_ref_tryget(&css->refcnt);
 356         return true;
 357 }
 358
 359 /**
 360  * css_tryget_online - try to obtain a reference on the specified css if online
 361  * @css: target css
 362  *
 363  * Obtain a reference on @css if it's online.  The caller naturally needs
 364  * to ensure that @css is accessible but doesn't have to be holding a
 365  * reference on it - IOW, RCU protected access is good enough for this
 366  * function.  Returns %true if a reference count was successfully obtained;
 367  * %false otherwise.
 368  */
 369 static inline bool css_tryget_online(struct cgroup_subsys_state *css)
 370 {
 371         if (!(css->flags & CSS_NO_REF))
 372                 return percpu_ref_tryget_live(&css->refcnt);
 373         return true;
 374 }
 375
 376 /**
 377  * css_is_dying - test whether the specified css is dying
 378  * @css: target css
 379  *
 380  * Test whether @css is in the process of offlining or already offline.  In
 381  * most cases, ->css_online() and ->css_offline() callbacks should be
 382  * enough; however, the actual offline operations are RCU delayed and this
 383  * test returns %true also when @css is scheduled to be offlined.
 384  *
 385  * This is useful, for example, when the use case requires synchronous
 386  * behavior with respect to cgroup removal.  cgroup removal schedules css
 387  * offlining but the css can seem alive while the operation is being
 388  * delayed.  If the delay affects user visible semantics, this test can be
 389  * used to resolve the situation.
 390  */
 391 static inline bool css_is_dying(struct cgroup_subsys_state *css)
 392 {
 393         return !(css->flags & CSS_NO_REF) && percpu_ref_is_dying(&css->refcnt);
 394 }
 395
 396 /**
 397  * css_put - put a css reference
 398  * @css: target css
 399  *
 400  * Put a reference obtained via css_get() and css_tryget_online().
 401  */
 402 static inline void css_put(struct cgroup_subsys_state *css)
 403 {
 404         if (!(css->flags & CSS_NO_REF))
 405                 percpu_ref_put(&css->refcnt);
 406 }
 407
 408 /**
 409  * css_put_many - put css references
 410  * @css: target css
 411  * @n: number of references to put
 412  *
 413  * Put references obtained via css_get() and css_tryget_online().
 414  */
 415 static inline void css_put_many(struct cgroup_subsys_state *css, unsigned int n)
 416 {
 417         if (!(css->flags & CSS_NO_REF))
 418                 percpu_ref_put_many(&css->refcnt, n);
 419 }
 420
 421 static inline void cgroup_get(struct cgroup *cgrp)
 422 {
 423         css_get(&cgrp->self);
 424 }
 425
 426 static inline bool cgroup_tryget(struct cgroup *cgrp)
 427 {
 428         return css_tryget(&cgrp->self);
 429 }
 430
 431 static inline void cgroup_put(struct cgroup *cgrp)
 432 {
 433         css_put(&cgrp->self);
 434 }
 435
 436 /**
 437  * task_css_set_check - obtain a task's css_set with extra access conditions
 438  * @task: the task to obtain css_set for
 439  * @__c: extra condition expression to be passed to rcu_dereference_check()
 440  *
 441  * A task's css_set is RCU protected, initialized and exited while holding
 442  * task_lock(), and can only be modified while holding both cgroup_mutex
 443  * and task_lock() while the task is alive.  This macro verifies that the
 444  * caller is inside proper critical section and returns @task's css_set.
 445  *
 446  * The caller can also specify additional allowed conditions via @__c, such
 447  * as locks used during the cgroup_subsys::attach() methods.
 448  */
 449 #ifdef CONFIG_PROVE_RCU
 450 extern struct mutex cgroup_mutex;
 451 extern spinlock_t css_set_lock;
 452 #define task_css_set_check(task, __c)                                   \
 453         rcu_dereference_check((task)->cgroups,                          \
 454                 rcu_read_lock_sched_held() ||                           \
 455                 lockdep_is_held(&cgroup_mutex) ||                       \
 456                 lockdep_is_held(&css_set_lock) ||                       \
 457                 ((task)->flags & PF_EXITING) || (__c))
 458 #else
 459 #define task_css_set_check(task, __c)                                   \
 460         rcu_dereference((task)->cgroups)
 461 #endif
 462
 463 /**
 464  * task_css_check - obtain css for (task, subsys) w/ extra access conds
 465  * @task: the target task
 466  * @subsys_id: the target subsystem ID
 467  * @__c: extra condition expression to be passed to rcu_dereference_check()
 468  *
 469  * Return the cgroup_subsys_state for the (@task, @subsys_id) pair.  The
 470  * synchronization rules are the same as task_css_set_check().
 471  */
 472 #define task_css_check(task, subsys_id, __c)                            \
 473         task_css_set_check((task), (__c))->subsys[(subsys_id)]
 474
 475 /**
 476  * task_css_set - obtain a task's css_set
 477  * @task: the task to obtain css_set for
 478  *
 479  * See task_css_set_check().
 480  */
 481 static inline struct css_set *task_css_set(struct task_struct *task)
 482 {
 483         return task_css_set_check(task, false);
 484 }
 485
 486 /**
 487  * task_css - obtain css for (task, subsys)
 488  * @task: the target task
 489  * @subsys_id: the target subsystem ID
 490  *
 491  * See task_css_check().
 492  */
 493 static inline struct cgroup_subsys_state *task_css(struct task_struct *task,
 494                                                    int subsys_id)
 495 {
 496         return task_css_check(task, subsys_id, false);
 497 }
 498
 499 /**
 500  * task_get_css - find and get the css for (task, subsys)
 501  * @task: the target task
 502  * @subsys_id: the target subsystem ID
 503  *
 504  * Find the css for the (@task, @subsys_id) combination, increment a
 505  * reference on and return it.  This function is guaranteed to return a
 506  * valid css.  The returned css may already have been offlined.
 507  */
 508 static inline struct cgroup_subsys_state *
 509 task_get_css(struct task_struct *task, int subsys_id)
 510 {
 511         struct cgroup_subsys_state *css;
 512
 513         rcu_read_lock();
 514         while (true) {
 515                 css = task_css(task, subsys_id);
 516                 /*
 517                  * Can't use css_tryget_online() here.  A task which has
 518                  * PF_EXITING set may stay associated with an offline css.
 519                  * If such task calls this function, css_tryget_online()
 520                  * will keep failing.
 521                  */
 522                 if (likely(css_tryget(css)))
 523                         break;
 524                 cpu_relax();
 525         }
 526         rcu_read_unlock();
 527         return css;
 528 }
 529
 530 /**
 531  * task_css_is_root - test whether a task belongs to the root css
 532  * @task: the target task
 533  * @subsys_id: the target subsystem ID
 534  *
 535  * Test whether @task belongs to the root css on the specified subsystem.
 536  * May be invoked in any context.
 537  */
 538 static inline bool task_css_is_root(struct task_struct *task, int subsys_id)
 539 {
 540         return task_css_check(task, subsys_id, true) ==
 541                 init_css_set.subsys[subsys_id];
 542 }
 543
 544 static inline struct cgroup *task_cgroup(struct task_struct *task,
 545                                          int subsys_id)
 546 {
 547         return task_css(task, subsys_id)->cgroup;
 548 }
 549
 550 static inline struct cgroup *task_dfl_cgroup(struct task_struct *task)
 551 {
 552         return task_css_set(task)->dfl_cgrp;
 553 }
 554
 555 static inline struct cgroup *cgroup_parent(struct cgroup *cgrp)
 556 {
 557         struct cgroup_subsys_state *parent_css = cgrp->self.parent;
 558
 559         if (parent_css)
 560                 return container_of(parent_css, struct cgroup, self);
 561         return NULL;
 562 }
 563
 564 /**
 565  * cgroup_is_descendant - test ancestry
 566  * @cgrp: the cgroup to be tested
 567  * @ancestor: possible ancestor of @cgrp
 568  *
 569  * Test whether @cgrp is a descendant of @ancestor.  It also returns %true
 570  * if @cgrp == @ancestor.  This function is safe to call as long as @cgrp
 571  * and @ancestor are accessible.
 572  */
 573 static inline bool cgroup_is_descendant(struct cgroup *cgrp,
 574                                         struct cgroup *ancestor)
 575 {
 576         if (cgrp->root != ancestor->root || cgrp->level < ancestor->level)
 577                 return false;
 578         return cgrp->ancestor_ids[ancestor->level] == cgroup_id(ancestor);
 579 }
 580
 581 /**
 582  * cgroup_ancestor - find ancestor of cgroup
 583  * @cgrp: cgroup to find ancestor of
 584  * @ancestor_level: level of ancestor to find starting from root
 585  *
 586  * Find ancestor of cgroup at specified level starting from root if it exists
 587  * and return pointer to it. Return NULL if @cgrp doesn't have ancestor at
 588  * @ancestor_level.
 589  *
 590  * This function is safe to call as long as @cgrp is accessible.
 591  */
 592 static inline struct cgroup *cgroup_ancestor(struct cgroup *cgrp,
 593                                              int ancestor_level)
 594 {
 595         if (cgrp->level < ancestor_level)
 596                 return NULL;
 597         while (cgrp && cgrp->level > ancestor_level)
 598                 cgrp = cgroup_parent(cgrp);
 599         return cgrp;
 600 }
 601
 602 /**
 603  * task_under_cgroup_hierarchy - test task's membership of cgroup ancestry
 604  * @task: the task to be tested
 605  * @ancestor: possible ancestor of @task's cgroup
 606  *
 607  * Tests whether @task's default cgroup hierarchy is a descendant of @ancestor.
 608  * It follows all the same rules as cgroup_is_descendant, and only applies
 609  * to the default hierarchy.
 610  */
 611 static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
 612                                                struct cgroup *ancestor)
 613 {
 614         struct css_set *cset = task_css_set(task);
 615
 616         return cgroup_is_descendant(cset->dfl_cgrp, ancestor);
 617 }
 618
 619 /* no synchronization, the result can only be used as a hint */
 620 static inline bool cgroup_is_populated(struct cgroup *cgrp)
 621 {
 622         return cgrp->nr_populated_csets + cgrp->nr_populated_domain_children +
 623                 cgrp->nr_populated_threaded_children;
 624 }
 625
 626 /* returns ino associated with a cgroup */
 627 static inline ino_t cgroup_ino(struct cgroup *cgrp)
 628 {
 629         return kernfs_ino(cgrp->kn);
 630 }
 631
 632 /* cft/css accessors for cftype->write() operation */
 633 static inline struct cftype *of_cft(struct kernfs_open_file *of)
 634 {
 635         return of->kn->priv;
 636 }
 637
 638 struct cgroup_subsys_state *of_css(struct kernfs_open_file *of);
 639
 640 /* cft/css accessors for cftype->seq_*() operations */
 641 static inline struct cftype *seq_cft(struct seq_file *seq)
 642 {
 643         return of_cft(seq->private);
 644 }
 645
 646 static inline struct cgroup_subsys_state *seq_css(struct seq_file *seq)
 647 {
 648         return of_css(seq->private);
 649 }
 650
 651 /*
 652  * Name / path handling functions.  All are thin wrappers around the kernfs
 653  * counterparts and can be called under any context.
 654  */
 655
 656 static inline int cgroup_name(struct cgroup *cgrp, char *buf, size_t buflen)
 657 {
 658         return kernfs_name(cgrp->kn, buf, buflen);
 659 }
 660
 661 static inline int cgroup_path(struct cgroup *cgrp, char *buf, size_t buflen)
 662 {
 663         return kernfs_path(cgrp->kn, buf, buflen);
 664 }
 665
 666 static inline void pr_cont_cgroup_name(struct cgroup *cgrp)
 667 {
 668         pr_cont_kernfs_name(cgrp->kn);
 669 }
 670
 671 static inline void pr_cont_cgroup_path(struct cgroup *cgrp)
 672 {
 673         pr_cont_kernfs_path(cgrp->kn);
 674 }
 675
 676 bool cgroup_psi_enabled(void);
 677
 678 static inline void cgroup_init_kthreadd(void)
 679 {
 680         /*
 681          * kthreadd is inherited by all kthreads, keep it in the root so
 682          * that the new kthreads are guaranteed to stay in the root until
 683          * initialization is finished.
 684          */
 685         current->no_cgroup_migration = 1;
 686 }
 687
 688 static inline void cgroup_kthread_ready(void)
 689 {
 690         /*
 691          * This kthread finished initialization.  The creator should have
 692          * set PF_NO_SETAFFINITY if this kthread should stay in the root.
 693          */
 694         current->no_cgroup_migration = 0;
 695 }
 696
 697 void cgroup_path_from_kernfs_id(u64 id, char *buf, size_t buflen);
 698 struct cgroup *cgroup_get_from_id(u64 id);
 699 #else /* !CONFIG_CGROUPS */
 700
 701 struct cgroup_subsys_state;
 702 struct cgroup;
 703
 704 static inline u64 cgroup_id(const struct cgroup *cgrp) { return 1; }
 705 static inline void css_get(struct cgroup_subsys_state *css) {}
 706 static inline void css_put(struct cgroup_subsys_state *css) {}
 707 static inline int cgroup_attach_task_all(struct task_struct *from,
 708                                          struct task_struct *t) { return 0; }
 709 static inline int cgroupstats_build(struct cgroupstats *stats,
 710                                     struct dentry *dentry) { return -EINVAL; }
 711
 712 static inline void cgroup_fork(struct task_struct *p) {}
 713 static inline int cgroup_can_fork(struct task_struct *p,
 714                                   struct kernel_clone_args *kargs) { return 0; }
 715 static inline void cgroup_cancel_fork(struct task_struct *p,
 716                                       struct kernel_clone_args *kargs) {}
 717 static inline void cgroup_post_fork(struct task_struct *p,
 718                                     struct kernel_clone_args *kargs) {}
 719 static inline void cgroup_exit(struct task_struct *p) {}
 720 static inline void cgroup_release(struct task_struct *p) {}
 721 static inline void cgroup_free(struct task_struct *p) {}
 722
 723 static inline int cgroup_init_early(void) { return 0; }
 724 static inline int cgroup_init(void) { return 0; }
 725 static inline void cgroup_init_kthreadd(void) {}
 726 static inline void cgroup_kthread_ready(void) {}
 727
 728 static inline struct cgroup *cgroup_parent(struct cgroup *cgrp)
 729 {
 730         return NULL;
 731 }
 732
 733 static inline bool cgroup_psi_enabled(void)
 734 {
 735         return false;
 736 }
 737
 738 static inline bool task_under_cgroup_hierarchy(struct task_struct *task,
 739                                                struct cgroup *ancestor)
 740 {
 741         return true;
 742 }
 743
 744 static inline void cgroup_path_from_kernfs_id(u64 id, char *buf, size_t buflen)
 745 {}
 746
 747 static inline struct cgroup *cgroup_get_from_id(u64 id)
 748 {
 749         return NULL;
 750 }
 751 #endif /* !CONFIG_CGROUPS */
 752
 753 #ifdef CONFIG_CGROUPS
 754 /*
 755  * cgroup scalable recursive statistics.
 756  */
 757 void cgroup_rstat_updated(struct cgroup *cgrp, int cpu);
 758 void cgroup_rstat_flush(struct cgroup *cgrp);
 759 void cgroup_rstat_flush_irqsafe(struct cgroup *cgrp);
 760 void cgroup_rstat_flush_hold(struct cgroup *cgrp);
 761 void cgroup_rstat_flush_release(void);
 762
 763 /*
 764  * Basic resource stats.
 765  */
 766 #ifdef CONFIG_CGROUP_CPUACCT
 767 void cpuacct_charge(struct task_struct *tsk, u64 cputime);
 768 void cpuacct_account_field(struct task_struct *tsk, int index, u64 val);
 769 #else
 770 static inline void cpuacct_charge(struct task_struct *tsk, u64 cputime) {}
 771 static inline void cpuacct_account_field(struct task_struct *tsk, int index,
 772                                          u64 val) {}
 773 #endif
 774
 775 void __cgroup_account_cputime(struct cgroup *cgrp, u64 delta_exec);
 776 void __cgroup_account_cputime_field(struct cgroup *cgrp,
 777                                     enum cpu_usage_stat index, u64 delta_exec);
 778
 779 static inline void cgroup_account_cputime(struct task_struct *task,
 780                                           u64 delta_exec)
 781 {
 782         struct cgroup *cgrp;
 783
 784         cpuacct_charge(task, delta_exec);
 785
 786         cgrp = task_dfl_cgroup(task);
 787         if (cgroup_parent(cgrp))
 788                 __cgroup_account_cputime(cgrp, delta_exec);
 789 }
 790
 791 static inline void cgroup_account_cputime_field(struct task_struct *task,
 792                                                 enum cpu_usage_stat index,
 793                                                 u64 delta_exec)
 794 {
 795         struct cgroup *cgrp;
 796
 797         cpuacct_account_field(task, index, delta_exec);
 798
 799         cgrp = task_dfl_cgroup(task);
 800         if (cgroup_parent(cgrp))
 801                 __cgroup_account_cputime_field(cgrp, index, delta_exec);
 802 }
 803
 804 #else   /* CONFIG_CGROUPS */
 805
 806 static inline void cgroup_account_cputime(struct task_struct *task,
 807                                           u64 delta_exec) {}
 808 static inline void cgroup_account_cputime_field(struct task_struct *task,
 809                                                 enum cpu_usage_stat index,
 810                                                 u64 delta_exec) {}
 811
 812 #endif  /* CONFIG_CGROUPS */
 813
 814 /*
 815  * sock->sk_cgrp_data handling.  For more info, see sock_cgroup_data
 816  * definition in cgroup-defs.h.
 817  */
 818 #ifdef CONFIG_SOCK_CGROUP_DATA
 819
 820 void cgroup_sk_alloc(struct sock_cgroup_data *skcd);
 821 void cgroup_sk_clone(struct sock_cgroup_data *skcd);
 822 void cgroup_sk_free(struct sock_cgroup_data *skcd);
 823
 824 static inline struct cgroup *sock_cgroup_ptr(struct sock_cgroup_data *skcd)
 825 {
 826         return skcd->cgroup;
 827 }
 828
 829 #else   /* CONFIG_CGROUP_DATA */
 830
 831 static inline void cgroup_sk_alloc(struct sock_cgroup_data *skcd) {}
 832 static inline void cgroup_sk_clone(struct sock_cgroup_data *skcd) {}
 833 static inline void cgroup_sk_free(struct sock_cgroup_data *skcd) {}
 834
 835 #endif  /* CONFIG_CGROUP_DATA */
 836
 837 struct cgroup_namespace {
 838         struct ns_common        ns;
 839         struct user_namespace   *user_ns;
 840         struct ucounts          *ucounts;
 841         struct css_set          *root_cset;
 842 };
 843
 844 extern struct cgroup_namespace init_cgroup_ns;
 845
 846 #ifdef CONFIG_CGROUPS
 847
 848 void free_cgroup_ns(struct cgroup_namespace *ns);
 849
 850 struct cgroup_namespace *copy_cgroup_ns(unsigned long flags,
 851                                         struct user_namespace *user_ns,
 852                                         struct cgroup_namespace *old_ns);
 853
 854 int cgroup_path_ns(struct cgroup *cgrp, char *buf, size_t buflen,
 855                    struct cgroup_namespace *ns);
 856
 857 #else /* !CONFIG_CGROUPS */
 858
 859 static inline void free_cgroup_ns(struct cgroup_namespace *ns) { }
 860 static inline struct cgroup_namespace *
 861 copy_cgroup_ns(unsigned long flags, struct user_namespace *user_ns,
 862                struct cgroup_namespace *old_ns)
 863 {
 864         return old_ns;
 865 }
 866
 867 #endif /* !CONFIG_CGROUPS */
 868
 869 static inline void get_cgroup_ns(struct cgroup_namespace *ns)
 870 {
 871         if (ns)
 872                 refcount_inc(&ns->ns.count);
 873 }
 874
 875 static inline void put_cgroup_ns(struct cgroup_namespace *ns)
 876 {
 877         if (ns && refcount_dec_and_test(&ns->ns.count))
 878                 free_cgroup_ns(ns);
 879 }
 880
 881 #ifdef CONFIG_CGROUPS
 882
 883 void cgroup_enter_frozen(void);
 884 void cgroup_leave_frozen(bool always_leave);
 885 void cgroup_update_frozen(struct cgroup *cgrp);
 886 void cgroup_freeze(struct cgroup *cgrp, bool freeze);
 887 void cgroup_freezer_migrate_task(struct task_struct *task, struct cgroup *src,
 888                                  struct cgroup *dst);
 889
 890 static inline bool cgroup_task_frozen(struct task_struct *task)
 891 {
 892         return task->frozen;
 893 }
 894
 895 #else /* !CONFIG_CGROUPS */
 896
 897 static inline void cgroup_enter_frozen(void) { }
 898 static inline void cgroup_leave_frozen(bool always_leave) { }
 899 static inline bool cgroup_task_frozen(struct task_struct *task)
 900 {
 901         return false;
 902 }
 903
 904 #endif /* !CONFIG_CGROUPS */
 905
 906 #ifdef CONFIG_CGROUP_BPF
 907 static inline void cgroup_bpf_get(struct cgroup *cgrp)
 908 {
 909         percpu_ref_get(&cgrp->bpf.refcnt);
 910 }
 911
 912 static inline void cgroup_bpf_put(struct cgroup *cgrp)
 913 {
 914         percpu_ref_put(&cgrp->bpf.refcnt);
 915 }
 916
 917 #else /* CONFIG_CGROUP_BPF */
 918
 919 static inline void cgroup_bpf_get(struct cgroup *cgrp) {}
 920 static inline void cgroup_bpf_put(struct cgroup *cgrp) {}
 921
 922 #endif /* CONFIG_CGROUP_BPF */
 923
 924 #endif /* _LINUX_CGROUP_H */