include/linux/cpu.h

   1 /*
   2  * include/linux/cpu.h - generic cpu definition
   3  *
   4  * This is mainly for topological representation. We define the
   5  * basic 'struct cpu' here, which can be embedded in per-arch
   6  * definitions of processors.
   7  *
   8  * Basic handling of the devices is done in drivers/base/cpu.c
   9  *
  10  * CPUs are exported via sysfs in the devices/system/cpu
  11  * directory.
  12  */
  13 #ifndef _LINUX_CPU_H_
  14 #define _LINUX_CPU_H_
  15
  16 #include <linux/node.h>
  17 #include <linux/compiler.h>
  18 #include <linux/cpumask.h>
  19 #include <linux/cpuhotplug.h>
  20
  21 struct device;
  22 struct device_node;
  23 struct attribute_group;
  24
  25 struct cpu {
  26         int node_id;            /* The node which contains the CPU */
  27         int hotpluggable;       /* creates sysfs control file if hotpluggable */
  28         struct device dev;
  29 };
  30
  31 extern void boot_cpu_init(void);
  32 extern void boot_cpu_hotplug_init(void);
  33
  34 extern int register_cpu(struct cpu *cpu, int num);
  35 extern struct device *get_cpu_device(unsigned cpu);
  36 extern bool cpu_is_hotpluggable(unsigned cpu);
  37 extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
  38 extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
  39                                               int cpu, unsigned int *thread);
  40
  41 extern int cpu_add_dev_attr(struct device_attribute *attr);
  42 extern void cpu_remove_dev_attr(struct device_attribute *attr);
  43
  44 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
  45 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
  46
  47 extern ssize_t cpu_show_meltdown(struct device *dev,
  48                                  struct device_attribute *attr, char *buf);
  49 extern ssize_t cpu_show_spectre_v1(struct device *dev,
  50                                    struct device_attribute *attr, char *buf);
  51 extern ssize_t cpu_show_spectre_v2(struct device *dev,
  52                                    struct device_attribute *attr, char *buf);
  53 extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
  54                                           struct device_attribute *attr, char *buf);
  55 extern ssize_t cpu_show_l1tf(struct device *dev,
  56                              struct device_attribute *attr, char *buf);
  57
  58 extern __printf(4, 5)
  59 struct device *cpu_device_create(struct device *parent, void *drvdata,
  60                                  const struct attribute_group **groups,
  61                                  const char *fmt, ...);
  62 #ifdef CONFIG_HOTPLUG_CPU
  63 extern void unregister_cpu(struct cpu *cpu);
  64 extern ssize_t arch_cpu_probe(const char *, size_t);
  65 extern ssize_t arch_cpu_release(const char *, size_t);
  66 #endif
  67 struct notifier_block;
  68
  69 #define CPU_ONLINE              0x0002 /* CPU (unsigned)v is up */
  70 #define CPU_UP_PREPARE          0x0003 /* CPU (unsigned)v coming up */
  71 #define CPU_UP_CANCELED         0x0004 /* CPU (unsigned)v NOT coming up */
  72 #define CPU_DOWN_PREPARE        0x0005 /* CPU (unsigned)v going down */
  73 #define CPU_DOWN_FAILED         0x0006 /* CPU (unsigned)v NOT going down */
  74 #define CPU_DEAD                0x0007 /* CPU (unsigned)v dead */
  75 #define CPU_POST_DEAD           0x0009 /* CPU (unsigned)v dead, cpu_hotplug
  76                                         * lock is dropped */
  77 #define CPU_BROKEN              0x000B /* CPU (unsigned)v did not die properly,
  78                                         * perhaps due to preemption. */
  79
  80 /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
  81  * operation in progress
  82  */
  83 #define CPU_TASKS_FROZEN        0x0010
  84
  85 #define CPU_ONLINE_FROZEN       (CPU_ONLINE | CPU_TASKS_FROZEN)
  86 #define CPU_UP_PREPARE_FROZEN   (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
  87 #define CPU_UP_CANCELED_FROZEN  (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
  88 #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
  89 #define CPU_DOWN_FAILED_FROZEN  (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
  90 #define CPU_DEAD_FROZEN         (CPU_DEAD | CPU_TASKS_FROZEN)
  91
  92 #ifdef CONFIG_SMP
  93 extern bool cpuhp_tasks_frozen;
  94 /* Need to know about CPUs going up/down? */
  95 #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
  96 #define cpu_notifier(fn, pri) {                                 \
  97         static struct notifier_block fn##_nb =                  \
  98                 { .notifier_call = fn, .priority = pri };       \
  99         register_cpu_notifier(&fn##_nb);                        \
 100 }
 101
 102 #define __cpu_notifier(fn, pri) {                               \
 103         static struct notifier_block fn##_nb =                  \
 104                 { .notifier_call = fn, .priority = pri };       \
 105         __register_cpu_notifier(&fn##_nb);                      \
 106 }
 107
 108 extern int register_cpu_notifier(struct notifier_block *nb);
 109 extern int __register_cpu_notifier(struct notifier_block *nb);
 110 extern void unregister_cpu_notifier(struct notifier_block *nb);
 111 extern void __unregister_cpu_notifier(struct notifier_block *nb);
 112
 113 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 114 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 115 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 116
 117 static inline int register_cpu_notifier(struct notifier_block *nb)
 118 {
 119         return 0;
 120 }
 121
 122 static inline int __register_cpu_notifier(struct notifier_block *nb)
 123 {
 124         return 0;
 125 }
 126
 127 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 128 {
 129 }
 130
 131 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 132 {
 133 }
 134 #endif
 135
 136 int cpu_up(unsigned int cpu);
 137 void notify_cpu_starting(unsigned int cpu);
 138 extern void cpu_maps_update_begin(void);
 139 extern void cpu_maps_update_done(void);
 140
 141 #define cpu_notifier_register_begin     cpu_maps_update_begin
 142 #define cpu_notifier_register_done      cpu_maps_update_done
 143
 144 #else   /* CONFIG_SMP */
 145 #define cpuhp_tasks_frozen      0
 146
 147 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 148 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 149
 150 static inline int register_cpu_notifier(struct notifier_block *nb)
 151 {
 152         return 0;
 153 }
 154
 155 static inline int __register_cpu_notifier(struct notifier_block *nb)
 156 {
 157         return 0;
 158 }
 159
 160 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 161 {
 162 }
 163
 164 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 165 {
 166 }
 167
 168 static inline void cpu_maps_update_begin(void)
 169 {
 170 }
 171
 172 static inline void cpu_maps_update_done(void)
 173 {
 174 }
 175
 176 static inline void cpu_notifier_register_begin(void)
 177 {
 178 }
 179
 180 static inline void cpu_notifier_register_done(void)
 181 {
 182 }
 183
 184 #endif /* CONFIG_SMP */
 185 extern struct bus_type cpu_subsys;
 186
 187 #ifdef CONFIG_HOTPLUG_CPU
 188 /* Stop CPUs going up and down. */
 189
 190 extern void cpu_hotplug_begin(void);
 191 extern void cpu_hotplug_done(void);
 192 extern void get_online_cpus(void);
 193 extern void put_online_cpus(void);
 194 extern void cpu_hotplug_disable(void);
 195 extern void cpu_hotplug_enable(void);
 196 #define hotcpu_notifier(fn, pri)        cpu_notifier(fn, pri)
 197 #define __hotcpu_notifier(fn, pri)      __cpu_notifier(fn, pri)
 198 #define register_hotcpu_notifier(nb)    register_cpu_notifier(nb)
 199 #define __register_hotcpu_notifier(nb)  __register_cpu_notifier(nb)
 200 #define unregister_hotcpu_notifier(nb)  unregister_cpu_notifier(nb)
 201 #define __unregister_hotcpu_notifier(nb)        __unregister_cpu_notifier(nb)
 202 void clear_tasks_mm_cpumask(int cpu);
 203 int cpu_down(unsigned int cpu);
 204
 205 #else           /* CONFIG_HOTPLUG_CPU */
 206
 207 static inline void cpu_hotplug_begin(void) {}
 208 static inline void cpu_hotplug_done(void) {}
 209 #define get_online_cpus()       do { } while (0)
 210 #define put_online_cpus()       do { } while (0)
 211 #define cpu_hotplug_disable()   do { } while (0)
 212 #define cpu_hotplug_enable()    do { } while (0)
 213 #define hotcpu_notifier(fn, pri)        do { (void)(fn); } while (0)
 214 #define __hotcpu_notifier(fn, pri)      do { (void)(fn); } while (0)
 215 /* These aren't inline functions due to a GCC bug. */
 216 #define register_hotcpu_notifier(nb)    ({ (void)(nb); 0; })
 217 #define __register_hotcpu_notifier(nb)  ({ (void)(nb); 0; })
 218 #define unregister_hotcpu_notifier(nb)  ({ (void)(nb); })
 219 #define __unregister_hotcpu_notifier(nb)        ({ (void)(nb); })
 220 #endif          /* CONFIG_HOTPLUG_CPU */
 221
 222 #ifdef CONFIG_PM_SLEEP_SMP
 223 extern int freeze_secondary_cpus(int primary);
 224 static inline int disable_nonboot_cpus(void)
 225 {
 226         return freeze_secondary_cpus(0);
 227 }
 228 extern void enable_nonboot_cpus(void);
 229 #else /* !CONFIG_PM_SLEEP_SMP */
 230 static inline int disable_nonboot_cpus(void) { return 0; }
 231 static inline void enable_nonboot_cpus(void) {}
 232 #endif /* !CONFIG_PM_SLEEP_SMP */
 233
 234 void cpu_startup_entry(enum cpuhp_state state);
 235
 236 void cpu_idle_poll_ctrl(bool enable);
 237
 238 /* Attach to any functions which should be considered cpuidle. */
 239 #define __cpuidle       __attribute__((__section__(".cpuidle.text")))
 240
 241 bool cpu_in_idle(unsigned long pc);
 242
 243 void arch_cpu_idle(void);
 244 void arch_cpu_idle_prepare(void);
 245 void arch_cpu_idle_enter(void);
 246 void arch_cpu_idle_exit(void);
 247 void arch_cpu_idle_dead(void);
 248
 249 int cpu_report_state(int cpu);
 250 int cpu_check_up_prepare(int cpu);
 251 void cpu_set_state_online(int cpu);
 252 #ifdef CONFIG_HOTPLUG_CPU
 253 bool cpu_wait_death(unsigned int cpu, int seconds);
 254 bool cpu_report_death(void);
 255 void cpuhp_report_idle_dead(void);
 256 #else
 257 static inline void cpuhp_report_idle_dead(void) { }
 258 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
 259
 260 enum cpuhp_smt_control {
 261         CPU_SMT_ENABLED,
 262         CPU_SMT_DISABLED,
 263         CPU_SMT_FORCE_DISABLED,
 264         CPU_SMT_NOT_SUPPORTED,
 265 };
 266
 267 #if defined(CONFIG_SMP) && defined(CONFIG_HOTPLUG_SMT)
 268 extern enum cpuhp_smt_control cpu_smt_control;
 269 extern void cpu_smt_disable(bool force);
 270 extern void cpu_smt_check_topology_early(void);
 271 extern void cpu_smt_check_topology(void);
 272 #else
 273 # define cpu_smt_control                (CPU_SMT_ENABLED)
 274 static inline void cpu_smt_disable(bool force) { }
 275 static inline void cpu_smt_check_topology_early(void) { }
 276 static inline void cpu_smt_check_topology(void) { }
 277 #endif
 278
 279 #endif /* _LINUX_CPU_H_ */