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_state_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 __printf(4, 5)
  48 struct device *cpu_device_create(struct device *parent, void *drvdata,
  49                                  const struct attribute_group **groups,
  50                                  const char *fmt, ...);
  51 #ifdef CONFIG_HOTPLUG_CPU
  52 extern void unregister_cpu(struct cpu *cpu);
  53 extern ssize_t arch_cpu_probe(const char *, size_t);
  54 extern ssize_t arch_cpu_release(const char *, size_t);
  55 #endif
  56 struct notifier_block;
  57
  58 /*
  59  * CPU notifier priorities.
  60  */
  61 enum {
  62         /* bring up workqueues before normal notifiers and down after */
  63         CPU_PRI_WORKQUEUE_UP    = 5,
  64         CPU_PRI_WORKQUEUE_DOWN  = -5,
  65 };
  66
  67 #define CPU_ONLINE              0x0002 /* CPU (unsigned)v is up */
  68 #define CPU_UP_PREPARE          0x0003 /* CPU (unsigned)v coming up */
  69 #define CPU_UP_CANCELED         0x0004 /* CPU (unsigned)v NOT coming up */
  70 #define CPU_DOWN_PREPARE        0x0005 /* CPU (unsigned)v going down */
  71 #define CPU_DOWN_FAILED         0x0006 /* CPU (unsigned)v NOT going down */
  72 #define CPU_DEAD                0x0007 /* CPU (unsigned)v dead */
  73 #define CPU_DYING               0x0008 /* CPU (unsigned)v not running any task,
  74                                         * not handling interrupts, soon dead.
  75                                         * Called on the dying cpu, interrupts
  76                                         * are already disabled. Must not
  77                                         * sleep, must not fail */
  78 #define CPU_POST_DEAD           0x0009 /* CPU (unsigned)v dead, cpu_hotplug
  79                                         * lock is dropped */
  80 #define CPU_STARTING            0x000A /* CPU (unsigned)v soon running.
  81                                         * Called on the new cpu, just before
  82                                         * enabling interrupts. Must not sleep,
  83                                         * must not fail */
  84 #define CPU_BROKEN              0x000B /* CPU (unsigned)v did not die properly,
  85                                         * perhaps due to preemption. */
  86
  87 /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
  88  * operation in progress
  89  */
  90 #define CPU_TASKS_FROZEN        0x0010
  91
  92 #define CPU_ONLINE_FROZEN       (CPU_ONLINE | CPU_TASKS_FROZEN)
  93 #define CPU_UP_PREPARE_FROZEN   (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
  94 #define CPU_UP_CANCELED_FROZEN  (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
  95 #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
  96 #define CPU_DOWN_FAILED_FROZEN  (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
  97 #define CPU_DEAD_FROZEN         (CPU_DEAD | CPU_TASKS_FROZEN)
  98 #define CPU_DYING_FROZEN        (CPU_DYING | CPU_TASKS_FROZEN)
  99 #define CPU_STARTING_FROZEN     (CPU_STARTING | CPU_TASKS_FROZEN)
 100
 101
 102 #ifdef CONFIG_SMP
 103 extern bool cpuhp_tasks_frozen;
 104 /* Need to know about CPUs going up/down? */
 105 #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
 106 #define cpu_notifier(fn, pri) {                                 \
 107         static struct notifier_block fn##_nb =                  \
 108                 { .notifier_call = fn, .priority = pri };       \
 109         register_cpu_notifier(&fn##_nb);                        \
 110 }
 111
 112 #define __cpu_notifier(fn, pri) {                               \
 113         static struct notifier_block fn##_nb =                  \
 114                 { .notifier_call = fn, .priority = pri };       \
 115         __register_cpu_notifier(&fn##_nb);                      \
 116 }
 117 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 118 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 119 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 120 #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 121
 122 #ifdef CONFIG_HOTPLUG_CPU
 123 extern int register_cpu_notifier(struct notifier_block *nb);
 124 extern int __register_cpu_notifier(struct notifier_block *nb);
 125 extern void unregister_cpu_notifier(struct notifier_block *nb);
 126 extern void __unregister_cpu_notifier(struct notifier_block *nb);
 127 #else
 128
 129 #ifndef MODULE
 130 extern int register_cpu_notifier(struct notifier_block *nb);
 131 extern int __register_cpu_notifier(struct notifier_block *nb);
 132 #else
 133 static inline int register_cpu_notifier(struct notifier_block *nb)
 134 {
 135         return 0;
 136 }
 137
 138 static inline int __register_cpu_notifier(struct notifier_block *nb)
 139 {
 140         return 0;
 141 }
 142 #endif
 143
 144 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 145 {
 146 }
 147
 148 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 149 {
 150 }
 151 #endif
 152
 153 int cpu_up(unsigned int cpu);
 154 void notify_cpu_starting(unsigned int cpu);
 155 extern void cpu_maps_update_begin(void);
 156 extern void cpu_maps_update_done(void);
 157
 158 #define cpu_notifier_register_begin     cpu_maps_update_begin
 159 #define cpu_notifier_register_done      cpu_maps_update_done
 160
 161 #else   /* CONFIG_SMP */
 162 #define cpuhp_tasks_frozen      0
 163
 164 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 165 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 166
 167 static inline int register_cpu_notifier(struct notifier_block *nb)
 168 {
 169         return 0;
 170 }
 171
 172 static inline int __register_cpu_notifier(struct notifier_block *nb)
 173 {
 174         return 0;
 175 }
 176
 177 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 178 {
 179 }
 180
 181 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 182 {
 183 }
 184
 185 static inline void cpu_maps_update_begin(void)
 186 {
 187 }
 188
 189 static inline void cpu_maps_update_done(void)
 190 {
 191 }
 192
 193 static inline void cpu_notifier_register_begin(void)
 194 {
 195 }
 196
 197 static inline void cpu_notifier_register_done(void)
 198 {
 199 }
 200
 201 #endif /* CONFIG_SMP */
 202 extern struct bus_type cpu_subsys;
 203
 204 #ifdef CONFIG_HOTPLUG_CPU
 205 /* Stop CPUs going up and down. */
 206
 207 extern void cpu_hotplug_begin(void);
 208 extern void cpu_hotplug_done(void);
 209 extern void get_online_cpus(void);
 210 extern void put_online_cpus(void);
 211 extern void cpu_hotplug_disable(void);
 212 extern void cpu_hotplug_enable(void);
 213 #define hotcpu_notifier(fn, pri)        cpu_notifier(fn, pri)
 214 #define __hotcpu_notifier(fn, pri)      __cpu_notifier(fn, pri)
 215 #define register_hotcpu_notifier(nb)    register_cpu_notifier(nb)
 216 #define __register_hotcpu_notifier(nb)  __register_cpu_notifier(nb)
 217 #define unregister_hotcpu_notifier(nb)  unregister_cpu_notifier(nb)
 218 #define __unregister_hotcpu_notifier(nb)        __unregister_cpu_notifier(nb)
 219 void clear_tasks_mm_cpumask(int cpu);
 220 int cpu_down(unsigned int cpu);
 221
 222 #else           /* CONFIG_HOTPLUG_CPU */
 223
 224 static inline void cpu_hotplug_begin(void) {}
 225 static inline void cpu_hotplug_done(void) {}
 226 #define get_online_cpus()       do { } while (0)
 227 #define put_online_cpus()       do { } while (0)
 228 #define cpu_hotplug_disable()   do { } while (0)
 229 #define cpu_hotplug_enable()    do { } while (0)
 230 #define hotcpu_notifier(fn, pri)        do { (void)(fn); } while (0)
 231 #define __hotcpu_notifier(fn, pri)      do { (void)(fn); } while (0)
 232 /* These aren't inline functions due to a GCC bug. */
 233 #define register_hotcpu_notifier(nb)    ({ (void)(nb); 0; })
 234 #define __register_hotcpu_notifier(nb)  ({ (void)(nb); 0; })
 235 #define unregister_hotcpu_notifier(nb)  ({ (void)(nb); })
 236 #define __unregister_hotcpu_notifier(nb)        ({ (void)(nb); })
 237 #endif          /* CONFIG_HOTPLUG_CPU */
 238
 239 #ifdef CONFIG_PM_SLEEP_SMP
 240 extern int disable_nonboot_cpus(void);
 241 extern void enable_nonboot_cpus(void);
 242 #else /* !CONFIG_PM_SLEEP_SMP */
 243 static inline int disable_nonboot_cpus(void) { return 0; }
 244 static inline void enable_nonboot_cpus(void) {}
 245 #endif /* !CONFIG_PM_SLEEP_SMP */
 246
 247 void cpu_startup_entry(enum cpuhp_state state);
 248
 249 void cpu_idle_poll_ctrl(bool enable);
 250
 251 void arch_cpu_idle(void);
 252 void arch_cpu_idle_prepare(void);
 253 void arch_cpu_idle_enter(void);
 254 void arch_cpu_idle_exit(void);
 255 void arch_cpu_idle_dead(void);
 256
 257 int cpu_report_state(int cpu);
 258 int cpu_check_up_prepare(int cpu);
 259 void cpu_set_state_online(int cpu);
 260 #ifdef CONFIG_HOTPLUG_CPU
 261 bool cpu_wait_death(unsigned int cpu, int seconds);
 262 bool cpu_report_death(void);
 263 void cpuhp_report_idle_dead(void);
 264 #else
 265 static inline void cpuhp_report_idle_dead(void) { }
 266 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
 267
 268 #endif /* _LINUX_CPU_H_ */