include/linux/cpu.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * include/linux/cpu.h - generic cpu definition
   4  *
   5  * This is mainly for topological representation. We define the
   6  * basic 'struct cpu' here, which can be embedded in per-arch
   7  * definitions of processors.
   8  *
   9  * Basic handling of the devices is done in drivers/base/cpu.c
  10  *
  11  * CPUs are exported via sysfs in the devices/system/cpu
  12  * directory.
  13  */
  14 #ifndef _LINUX_CPU_H_
  15 #define _LINUX_CPU_H_
  16
  17 #include <linux/node.h>
  18 #include <linux/compiler.h>
  19 #include <linux/cpumask.h>
  20 #include <linux/cpuhotplug.h>
  21
  22 struct device;
  23 struct device_node;
  24 struct attribute_group;
  25
  26 struct cpu {
  27         int node_id;            /* The node which contains the CPU */
  28         int hotpluggable;       /* creates sysfs control file if hotpluggable */
  29         struct device dev;
  30 };
  31
  32 extern void boot_cpu_init(void);
  33 extern void boot_cpu_hotplug_init(void);
  34 extern void cpu_init(void);
  35 extern void trap_init(void);
  36
  37 extern int register_cpu(struct cpu *cpu, int num);
  38 extern struct device *get_cpu_device(unsigned cpu);
  39 extern bool cpu_is_hotpluggable(unsigned cpu);
  40 extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
  41 extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
  42                                               int cpu, unsigned int *thread);
  43
  44 extern int cpu_add_dev_attr(struct device_attribute *attr);
  45 extern void cpu_remove_dev_attr(struct device_attribute *attr);
  46
  47 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
  48 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
  49
  50 extern ssize_t cpu_show_meltdown(struct device *dev,
  51                                  struct device_attribute *attr, char *buf);
  52 extern ssize_t cpu_show_spectre_v1(struct device *dev,
  53                                    struct device_attribute *attr, char *buf);
  54 extern ssize_t cpu_show_spectre_v2(struct device *dev,
  55                                    struct device_attribute *attr, char *buf);
  56 extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
  57                                           struct device_attribute *attr, char *buf);
  58 extern ssize_t cpu_show_l1tf(struct device *dev,
  59                              struct device_attribute *attr, char *buf);
  60 extern ssize_t cpu_show_mds(struct device *dev,
  61                             struct device_attribute *attr, char *buf);
  62 extern ssize_t cpu_show_tsx_async_abort(struct device *dev,
  63                                         struct device_attribute *attr,
  64                                         char *buf);
  65 extern ssize_t cpu_show_itlb_multihit(struct device *dev,
  66                                       struct device_attribute *attr, char *buf);
  67 extern ssize_t cpu_show_srbds(struct device *dev, struct device_attribute *attr, char *buf);
  68 extern ssize_t cpu_show_mmio_stale_data(struct device *dev,
  69                                         struct device_attribute *attr,
  70                                         char *buf);
  71 extern ssize_t cpu_show_retbleed(struct device *dev,
  72                                  struct device_attribute *attr, char *buf);
  73 extern ssize_t cpu_show_spec_rstack_overflow(struct device *dev,
  74                                              struct device_attribute *attr, char *buf);
  75 extern ssize_t cpu_show_gds(struct device *dev,
  76                             struct device_attribute *attr, char *buf);
  77
  78 extern __printf(4, 5)
  79 struct device *cpu_device_create(struct device *parent, void *drvdata,
  80                                  const struct attribute_group **groups,
  81                                  const char *fmt, ...);
  82 #ifdef CONFIG_HOTPLUG_CPU
  83 extern void unregister_cpu(struct cpu *cpu);
  84 extern ssize_t arch_cpu_probe(const char *, size_t);
  85 extern ssize_t arch_cpu_release(const char *, size_t);
  86 #endif
  87
  88 /*
  89  * These states are not related to the core CPU hotplug mechanism. They are
  90  * used by various (sub)architectures to track internal state
  91  */
  92 #define CPU_ONLINE              0x0002 /* CPU is up */
  93 #define CPU_UP_PREPARE          0x0003 /* CPU coming up */
  94 #define CPU_DEAD                0x0007 /* CPU dead */
  95 #define CPU_DEAD_FROZEN         0x0008 /* CPU timed out on unplug */
  96 #define CPU_POST_DEAD           0x0009 /* CPU successfully unplugged */
  97 #define CPU_BROKEN              0x000B /* CPU did not die properly */
  98
  99 #ifdef CONFIG_SMP
 100 extern bool cpuhp_tasks_frozen;
 101 int add_cpu(unsigned int cpu);
 102 int cpu_device_up(struct device *dev);
 103 void notify_cpu_starting(unsigned int cpu);
 104 extern void cpu_maps_update_begin(void);
 105 extern void cpu_maps_update_done(void);
 106 int bringup_hibernate_cpu(unsigned int sleep_cpu);
 107 void bringup_nonboot_cpus(unsigned int setup_max_cpus);
 108
 109 #else   /* CONFIG_SMP */
 110 #define cpuhp_tasks_frozen      0
 111
 112 static inline void cpu_maps_update_begin(void)
 113 {
 114 }
 115
 116 static inline void cpu_maps_update_done(void)
 117 {
 118 }
 119
 120 static inline int add_cpu(unsigned int cpu) { return 0;}
 121
 122 #endif /* CONFIG_SMP */
 123 extern struct bus_type cpu_subsys;
 124
 125 extern int lockdep_is_cpus_held(void);
 126
 127 #ifdef CONFIG_HOTPLUG_CPU
 128 extern void cpus_write_lock(void);
 129 extern void cpus_write_unlock(void);
 130 extern void cpus_read_lock(void);
 131 extern void cpus_read_unlock(void);
 132 extern int  cpus_read_trylock(void);
 133 extern void lockdep_assert_cpus_held(void);
 134 extern void cpu_hotplug_disable(void);
 135 extern void cpu_hotplug_enable(void);
 136 void clear_tasks_mm_cpumask(int cpu);
 137 int remove_cpu(unsigned int cpu);
 138 int cpu_device_down(struct device *dev);
 139 extern void smp_shutdown_nonboot_cpus(unsigned int primary_cpu);
 140
 141 #else /* CONFIG_HOTPLUG_CPU */
 142
 143 static inline void cpus_write_lock(void) { }
 144 static inline void cpus_write_unlock(void) { }
 145 static inline void cpus_read_lock(void) { }
 146 static inline void cpus_read_unlock(void) { }
 147 static inline int  cpus_read_trylock(void) { return true; }
 148 static inline void lockdep_assert_cpus_held(void) { }
 149 static inline void cpu_hotplug_disable(void) { }
 150 static inline void cpu_hotplug_enable(void) { }
 151 static inline int remove_cpu(unsigned int cpu) { return -EPERM; }
 152 static inline void smp_shutdown_nonboot_cpus(unsigned int primary_cpu) { }
 153 #endif  /* !CONFIG_HOTPLUG_CPU */
 154
 155 #ifdef CONFIG_PM_SLEEP_SMP
 156 extern int freeze_secondary_cpus(int primary);
 157 extern void thaw_secondary_cpus(void);
 158
 159 static inline int suspend_disable_secondary_cpus(void)
 160 {
 161         int cpu = 0;
 162
 163         if (IS_ENABLED(CONFIG_PM_SLEEP_SMP_NONZERO_CPU))
 164                 cpu = -1;
 165
 166         return freeze_secondary_cpus(cpu);
 167 }
 168 static inline void suspend_enable_secondary_cpus(void)
 169 {
 170         return thaw_secondary_cpus();
 171 }
 172
 173 #else /* !CONFIG_PM_SLEEP_SMP */
 174 static inline void thaw_secondary_cpus(void) {}
 175 static inline int suspend_disable_secondary_cpus(void) { return 0; }
 176 static inline void suspend_enable_secondary_cpus(void) { }
 177 #endif /* !CONFIG_PM_SLEEP_SMP */
 178
 179 void cpu_startup_entry(enum cpuhp_state state);
 180
 181 void cpu_idle_poll_ctrl(bool enable);
 182
 183 /* Attach to any functions which should be considered cpuidle. */
 184 #define __cpuidle       __section(".cpuidle.text")
 185
 186 bool cpu_in_idle(unsigned long pc);
 187
 188 void arch_cpu_idle(void);
 189 void arch_cpu_idle_prepare(void);
 190 void arch_cpu_idle_enter(void);
 191 void arch_cpu_idle_exit(void);
 192 void arch_cpu_idle_dead(void);
 193
 194 #ifdef CONFIG_ARCH_HAS_CPU_FINALIZE_INIT
 195 void arch_cpu_finalize_init(void);
 196 #else
 197 static inline void arch_cpu_finalize_init(void) { }
 198 #endif
 199
 200 int cpu_report_state(int cpu);
 201 int cpu_check_up_prepare(int cpu);
 202 void cpu_set_state_online(int cpu);
 203 void play_idle_precise(u64 duration_ns, u64 latency_ns);
 204
 205 static inline void play_idle(unsigned long duration_us)
 206 {
 207         play_idle_precise(duration_us * NSEC_PER_USEC, U64_MAX);
 208 }
 209
 210 #ifdef CONFIG_HOTPLUG_CPU
 211 bool cpu_wait_death(unsigned int cpu, int seconds);
 212 bool cpu_report_death(void);
 213 void cpuhp_report_idle_dead(void);
 214 #else
 215 static inline void cpuhp_report_idle_dead(void) { }
 216 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
 217
 218 enum cpuhp_smt_control {
 219         CPU_SMT_ENABLED,
 220         CPU_SMT_DISABLED,
 221         CPU_SMT_FORCE_DISABLED,
 222         CPU_SMT_NOT_SUPPORTED,
 223         CPU_SMT_NOT_IMPLEMENTED,
 224 };
 225
 226 #if defined(CONFIG_SMP) && defined(CONFIG_HOTPLUG_SMT)
 227 extern enum cpuhp_smt_control cpu_smt_control;
 228 extern void cpu_smt_disable(bool force);
 229 extern void cpu_smt_check_topology(void);
 230 extern bool cpu_smt_possible(void);
 231 extern int cpuhp_smt_enable(void);
 232 extern int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval);
 233 #else
 234 # define cpu_smt_control                (CPU_SMT_NOT_IMPLEMENTED)
 235 static inline void cpu_smt_disable(bool force) { }
 236 static inline void cpu_smt_check_topology(void) { }
 237 static inline bool cpu_smt_possible(void) { return false; }
 238 static inline int cpuhp_smt_enable(void) { return 0; }
 239 static inline int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval) { return 0; }
 240 #endif
 241
 242 extern bool cpu_mitigations_off(void);
 243 extern bool cpu_mitigations_auto_nosmt(void);
 244
 245 #endif /* _LINUX_CPU_H_ */