include/linux/cpuset.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_CPUSET_H
   3 #define _LINUX_CPUSET_H
   4 /*
   5  *  cpuset 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/sched/topology.h>
  14 #include <linux/sched/task.h>
  15 #include <linux/cpumask.h>
  16 #include <linux/nodemask.h>
  17 #include <linux/mm.h>
  18 #include <linux/jump_label.h>
  19
  20 #ifdef CONFIG_CPUSETS
  21
  22 /*
  23  * Static branch rewrites can happen in an arbitrary order for a given
  24  * key. In code paths where we need to loop with read_mems_allowed_begin() and
  25  * read_mems_allowed_retry() to get a consistent view of mems_allowed, we need
  26  * to ensure that begin() always gets rewritten before retry() in the
  27  * disabled -> enabled transition. If not, then if local irqs are disabled
  28  * around the loop, we can deadlock since retry() would always be
  29  * comparing the latest value of the mems_allowed seqcount against 0 as
  30  * begin() still would see cpusets_enabled() as false. The enabled -> disabled
  31  * transition should happen in reverse order for the same reasons (want to stop
  32  * looking at real value of mems_allowed.sequence in retry() first).
  33  */
  34 extern struct static_key_false cpusets_pre_enable_key;
  35 extern struct static_key_false cpusets_enabled_key;
  36 static inline bool cpusets_enabled(void)
  37 {
  38         return static_branch_unlikely(&cpusets_enabled_key);
  39 }
  40
  41 static inline void cpuset_inc(void)
  42 {
  43         static_branch_inc(&cpusets_pre_enable_key);
  44         static_branch_inc(&cpusets_enabled_key);
  45 }
  46
  47 static inline void cpuset_dec(void)
  48 {
  49         static_branch_dec(&cpusets_enabled_key);
  50         static_branch_dec(&cpusets_pre_enable_key);
  51 }
  52
  53 extern int cpuset_init(void);
  54 extern void cpuset_init_smp(void);
  55 extern void cpuset_update_active_cpus(void);
  56 extern void cpuset_cpus_allowed(struct task_struct *p, struct cpumask *mask);
  57 extern void cpuset_cpus_allowed_fallback(struct task_struct *p);
  58 extern nodemask_t cpuset_mems_allowed(struct task_struct *p);
  59 #define cpuset_current_mems_allowed (current->mems_allowed)
  60 void cpuset_init_current_mems_allowed(void);
  61 int cpuset_nodemask_valid_mems_allowed(nodemask_t *nodemask);
  62
  63 extern bool __cpuset_node_allowed(int node, gfp_t gfp_mask);
  64
  65 static inline bool cpuset_node_allowed(int node, gfp_t gfp_mask)
  66 {
  67         if (cpusets_enabled())
  68                 return __cpuset_node_allowed(node, gfp_mask);
  69         return true;
  70 }
  71
  72 static inline bool __cpuset_zone_allowed(struct zone *z, gfp_t gfp_mask)
  73 {
  74         return __cpuset_node_allowed(zone_to_nid(z), gfp_mask);
  75 }
  76
  77 static inline bool cpuset_zone_allowed(struct zone *z, gfp_t gfp_mask)
  78 {
  79         if (cpusets_enabled())
  80                 return __cpuset_zone_allowed(z, gfp_mask);
  81         return true;
  82 }
  83
  84 extern int cpuset_mems_allowed_intersects(const struct task_struct *tsk1,
  85                                           const struct task_struct *tsk2);
  86
  87 #define cpuset_memory_pressure_bump()                           \
  88         do {                                                    \
  89                 if (cpuset_memory_pressure_enabled)             \
  90                         __cpuset_memory_pressure_bump();        \
  91         } while (0)
  92 extern int cpuset_memory_pressure_enabled;
  93 extern void __cpuset_memory_pressure_bump(void);
  94
  95 extern void cpuset_task_status_allowed(struct seq_file *m,
  96                                         struct task_struct *task);
  97 extern int proc_cpuset_show(struct seq_file *m, struct pid_namespace *ns,
  98                             struct pid *pid, struct task_struct *tsk);
  99
 100 extern int cpuset_mem_spread_node(void);
 101 extern int cpuset_slab_spread_node(void);
 102
 103 static inline int cpuset_do_page_mem_spread(void)
 104 {
 105         return task_spread_page(current);
 106 }
 107
 108 static inline int cpuset_do_slab_mem_spread(void)
 109 {
 110         return task_spread_slab(current);
 111 }
 112
 113 extern int current_cpuset_is_being_rebound(void);
 114
 115 extern void rebuild_sched_domains(void);
 116
 117 extern void cpuset_print_current_mems_allowed(void);
 118
 119 /*
 120  * read_mems_allowed_begin is required when making decisions involving
 121  * mems_allowed such as during page allocation. mems_allowed can be updated in
 122  * parallel and depending on the new value an operation can fail potentially
 123  * causing process failure. A retry loop with read_mems_allowed_begin and
 124  * read_mems_allowed_retry prevents these artificial failures.
 125  */
 126 static inline unsigned int read_mems_allowed_begin(void)
 127 {
 128         if (!static_branch_unlikely(&cpusets_pre_enable_key))
 129                 return 0;
 130
 131         return read_seqcount_begin(&current->mems_allowed_seq);
 132 }
 133
 134 /*
 135  * If this returns true, the operation that took place after
 136  * read_mems_allowed_begin may have failed artificially due to a concurrent
 137  * update of mems_allowed. It is up to the caller to retry the operation if
 138  * appropriate.
 139  */
 140 static inline bool read_mems_allowed_retry(unsigned int seq)
 141 {
 142         if (!static_branch_unlikely(&cpusets_enabled_key))
 143                 return false;
 144
 145         return read_seqcount_retry(&current->mems_allowed_seq, seq);
 146 }
 147
 148 static inline void set_mems_allowed(nodemask_t nodemask)
 149 {
 150         unsigned long flags;
 151
 152         task_lock(current);
 153         local_irq_save(flags);
 154         write_seqcount_begin(&current->mems_allowed_seq);
 155         current->mems_allowed = nodemask;
 156         write_seqcount_end(&current->mems_allowed_seq);
 157         local_irq_restore(flags);
 158         task_unlock(current);
 159 }
 160
 161 #else /* !CONFIG_CPUSETS */
 162
 163 static inline bool cpusets_enabled(void) { return false; }
 164
 165 static inline int cpuset_init(void) { return 0; }
 166 static inline void cpuset_init_smp(void) {}
 167
 168 static inline void cpuset_update_active_cpus(void)
 169 {
 170         partition_sched_domains(1, NULL, NULL);
 171 }
 172
 173 static inline void cpuset_cpus_allowed(struct task_struct *p,
 174                                        struct cpumask *mask)
 175 {
 176         cpumask_copy(mask, cpu_possible_mask);
 177 }
 178
 179 static inline void cpuset_cpus_allowed_fallback(struct task_struct *p)
 180 {
 181 }
 182
 183 static inline nodemask_t cpuset_mems_allowed(struct task_struct *p)
 184 {
 185         return node_possible_map;
 186 }
 187
 188 #define cpuset_current_mems_allowed (node_states[N_MEMORY])
 189 static inline void cpuset_init_current_mems_allowed(void) {}
 190
 191 static inline int cpuset_nodemask_valid_mems_allowed(nodemask_t *nodemask)
 192 {
 193         return 1;
 194 }
 195
 196 static inline bool cpuset_node_allowed(int node, gfp_t gfp_mask)
 197 {
 198         return true;
 199 }
 200
 201 static inline bool __cpuset_zone_allowed(struct zone *z, gfp_t gfp_mask)
 202 {
 203         return true;
 204 }
 205
 206 static inline bool cpuset_zone_allowed(struct zone *z, gfp_t gfp_mask)
 207 {
 208         return true;
 209 }
 210
 211 static inline int cpuset_mems_allowed_intersects(const struct task_struct *tsk1,
 212                                                  const struct task_struct *tsk2)
 213 {
 214         return 1;
 215 }
 216
 217 static inline void cpuset_memory_pressure_bump(void) {}
 218
 219 static inline void cpuset_task_status_allowed(struct seq_file *m,
 220                                                 struct task_struct *task)
 221 {
 222 }
 223
 224 static inline int cpuset_mem_spread_node(void)
 225 {
 226         return 0;
 227 }
 228
 229 static inline int cpuset_slab_spread_node(void)
 230 {
 231         return 0;
 232 }
 233
 234 static inline int cpuset_do_page_mem_spread(void)
 235 {
 236         return 0;
 237 }
 238
 239 static inline int cpuset_do_slab_mem_spread(void)
 240 {
 241         return 0;
 242 }
 243
 244 static inline int current_cpuset_is_being_rebound(void)
 245 {
 246         return 0;
 247 }
 248
 249 static inline void rebuild_sched_domains(void)
 250 {
 251         partition_sched_domains(1, NULL, NULL);
 252 }
 253
 254 static inline void cpuset_print_current_mems_allowed(void)
 255 {
 256 }
 257
 258 static inline void set_mems_allowed(nodemask_t nodemask)
 259 {
 260 }
 261
 262 static inline unsigned int read_mems_allowed_begin(void)
 263 {
 264         return 0;
 265 }
 266
 267 static inline bool read_mems_allowed_retry(unsigned int seq)
 268 {
 269         return false;
 270 }
 271
 272 #endif /* !CONFIG_CPUSETS */
 273
 274 #endif /* _LINUX_CPUSET_H */