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