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