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  * and system devices are handled in drivers/base/sys.c.
  10  *
  11  * CPUs are exported via sysfs in the class/cpu/devices/
  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
  21 struct device;
  22
  23 struct cpu {
  24         int node_id;            /* The node which contains the CPU */
  25         int hotpluggable;       /* creates sysfs control file if hotpluggable */
  26         struct device dev;
  27 };
  28
  29 extern int register_cpu(struct cpu *cpu, int num);
  30 extern struct device *get_cpu_device(unsigned cpu);
  31 extern bool cpu_is_hotpluggable(unsigned cpu);
  32 extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
  33
  34 extern int cpu_add_dev_attr(struct device_attribute *attr);
  35 extern void cpu_remove_dev_attr(struct device_attribute *attr);
  36
  37 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
  38 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
  39
  40 #ifdef CONFIG_HOTPLUG_CPU
  41 extern void unregister_cpu(struct cpu *cpu);
  42 extern ssize_t arch_cpu_probe(const char *, size_t);
  43 extern ssize_t arch_cpu_release(const char *, size_t);
  44 #endif
  45 struct notifier_block;
  46
  47 #ifdef CONFIG_ARCH_HAS_CPU_AUTOPROBE
  48 extern int arch_cpu_uevent(struct device *dev, struct kobj_uevent_env *env);
  49 extern ssize_t arch_print_cpu_modalias(struct device *dev,
  50                                        struct device_attribute *attr,
  51                                        char *bufptr);
  52 #endif
  53
  54 /*
  55  * CPU notifier priorities.
  56  */
  57 enum {
  58         /*
  59          * SCHED_ACTIVE marks a cpu which is coming up active during
  60          * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
  61          * notifier.  CPUSET_ACTIVE adjusts cpuset according to
  62          * cpu_active mask right after SCHED_ACTIVE.  During
  63          * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
  64          * ordered in the similar way.
  65          *
  66          * This ordering guarantees consistent cpu_active mask and
  67          * migration behavior to all cpu notifiers.
  68          */
  69         CPU_PRI_SCHED_ACTIVE    = INT_MAX,
  70         CPU_PRI_CPUSET_ACTIVE   = INT_MAX - 1,
  71         CPU_PRI_SCHED_INACTIVE  = INT_MIN + 1,
  72         CPU_PRI_CPUSET_INACTIVE = INT_MIN,
  73
  74         /* migration should happen before other stuff but after perf */
  75         CPU_PRI_PERF            = 20,
  76         CPU_PRI_MIGRATION       = 10,
  77         /* bring up workqueues before normal notifiers and down after */
  78         CPU_PRI_WORKQUEUE_UP    = 5,
  79         CPU_PRI_WORKQUEUE_DOWN  = -5,
  80 };
  81
  82 #define CPU_ONLINE              0x0002 /* CPU (unsigned)v is up */
  83 #define CPU_UP_PREPARE          0x0003 /* CPU (unsigned)v coming up */
  84 #define CPU_UP_CANCELED         0x0004 /* CPU (unsigned)v NOT coming up */
  85 #define CPU_DOWN_PREPARE        0x0005 /* CPU (unsigned)v going down */
  86 #define CPU_DOWN_FAILED         0x0006 /* CPU (unsigned)v NOT going down */
  87 #define CPU_DEAD                0x0007 /* CPU (unsigned)v dead */
  88 #define CPU_DYING               0x0008 /* CPU (unsigned)v not running any task,
  89                                         * not handling interrupts, soon dead.
  90                                         * Called on the dying cpu, interrupts
  91                                         * are already disabled. Must not
  92                                         * sleep, must not fail */
  93 #define CPU_POST_DEAD           0x0009 /* CPU (unsigned)v dead, cpu_hotplug
  94                                         * lock is dropped */
  95 #define CPU_STARTING            0x000A /* CPU (unsigned)v soon running.
  96                                         * Called on the new cpu, just before
  97                                         * enabling interrupts. Must not sleep,
  98                                         * must not fail */
  99
 100 /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
 101  * operation in progress
 102  */
 103 #define CPU_TASKS_FROZEN        0x0010
 104
 105 #define CPU_ONLINE_FROZEN       (CPU_ONLINE | CPU_TASKS_FROZEN)
 106 #define CPU_UP_PREPARE_FROZEN   (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
 107 #define CPU_UP_CANCELED_FROZEN  (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
 108 #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
 109 #define CPU_DOWN_FAILED_FROZEN  (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
 110 #define CPU_DEAD_FROZEN         (CPU_DEAD | CPU_TASKS_FROZEN)
 111 #define CPU_DYING_FROZEN        (CPU_DYING | CPU_TASKS_FROZEN)
 112 #define CPU_STARTING_FROZEN     (CPU_STARTING | CPU_TASKS_FROZEN)
 113
 114
 115 #ifdef CONFIG_SMP
 116 /* Need to know about CPUs going up/down? */
 117 #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
 118 #define cpu_notifier(fn, pri) {                                 \
 119         static struct notifier_block fn##_nb __cpuinitdata =    \
 120                 { .notifier_call = fn, .priority = pri };       \
 121         register_cpu_notifier(&fn##_nb);                        \
 122 }
 123
 124 #define __cpu_notifier(fn, pri) {                               \
 125         static struct notifier_block fn##_nb =                  \
 126                 { .notifier_call = fn, .priority = pri };       \
 127         __register_cpu_notifier(&fn##_nb);                      \
 128 }
 129 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 130 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 131 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 132 #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 133
 134 #ifdef CONFIG_HOTPLUG_CPU
 135 extern int register_cpu_notifier(struct notifier_block *nb);
 136 extern int __register_cpu_notifier(struct notifier_block *nb);
 137 extern void unregister_cpu_notifier(struct notifier_block *nb);
 138 extern void __unregister_cpu_notifier(struct notifier_block *nb);
 139 #else
 140
 141 #ifndef MODULE
 142 extern int register_cpu_notifier(struct notifier_block *nb);
 143 extern int __register_cpu_notifier(struct notifier_block *nb);
 144 #else
 145 static inline int register_cpu_notifier(struct notifier_block *nb)
 146 {
 147         return 0;
 148 }
 149
 150 static inline int __register_cpu_notifier(struct notifier_block *nb)
 151 {
 152         return 0;
 153 }
 154 #endif
 155
 156 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 157 {
 158 }
 159
 160 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 161 {
 162 }
 163 #endif
 164
 165 int cpu_up(unsigned int cpu);
 166 void notify_cpu_starting(unsigned int cpu);
 167 extern void cpu_maps_update_begin(void);
 168 extern void cpu_maps_update_done(void);
 169
 170 #define cpu_notifier_register_begin     cpu_maps_update_begin
 171 #define cpu_notifier_register_done      cpu_maps_update_done
 172
 173 #else   /* CONFIG_SMP */
 174
 175 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 176 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
 177
 178 static inline int register_cpu_notifier(struct notifier_block *nb)
 179 {
 180         return 0;
 181 }
 182
 183 static inline int __register_cpu_notifier(struct notifier_block *nb)
 184 {
 185         return 0;
 186 }
 187
 188 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 189 {
 190 }
 191
 192 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
 193 {
 194 }
 195
 196 static inline void cpu_maps_update_begin(void)
 197 {
 198 }
 199
 200 static inline void cpu_maps_update_done(void)
 201 {
 202 }
 203
 204 static inline void cpu_notifier_register_begin(void)
 205 {
 206 }
 207
 208 static inline void cpu_notifier_register_done(void)
 209 {
 210 }
 211
 212 #endif /* CONFIG_SMP */
 213 extern struct bus_type cpu_subsys;
 214
 215 #ifdef CONFIG_HOTPLUG_CPU
 216 /* Stop CPUs going up and down. */
 217
 218 extern void get_online_cpus(void);
 219 extern void put_online_cpus(void);
 220 extern void cpu_hotplug_disable(void);
 221 extern void cpu_hotplug_enable(void);
 222 #define hotcpu_notifier(fn, pri)        cpu_notifier(fn, pri)
 223 #define __hotcpu_notifier(fn, pri)      __cpu_notifier(fn, pri)
 224 #define register_hotcpu_notifier(nb)    register_cpu_notifier(nb)
 225 #define __register_hotcpu_notifier(nb)  __register_cpu_notifier(nb)
 226 #define unregister_hotcpu_notifier(nb)  unregister_cpu_notifier(nb)
 227 #define __unregister_hotcpu_notifier(nb)        __unregister_cpu_notifier(nb)
 228 void clear_tasks_mm_cpumask(int cpu);
 229 int cpu_down(unsigned int cpu);
 230
 231 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
 232 extern void cpu_hotplug_driver_lock(void);
 233 extern void cpu_hotplug_driver_unlock(void);
 234 #else
 235 static inline void cpu_hotplug_driver_lock(void)
 236 {
 237 }
 238
 239 static inline void cpu_hotplug_driver_unlock(void)
 240 {
 241 }
 242 #endif
 243
 244 #else           /* CONFIG_HOTPLUG_CPU */
 245
 246 #define get_online_cpus()       do { } while (0)
 247 #define put_online_cpus()       do { } while (0)
 248 #define cpu_hotplug_disable()   do { } while (0)
 249 #define cpu_hotplug_enable()    do { } while (0)
 250 #define hotcpu_notifier(fn, pri)        do { (void)(fn); } while (0)
 251 #define __hotcpu_notifier(fn, pri)      do { (void)(fn); } while (0)
 252 /* These aren't inline functions due to a GCC bug. */
 253 #define register_hotcpu_notifier(nb)    ({ (void)(nb); 0; })
 254 #define __register_hotcpu_notifier(nb)  ({ (void)(nb); 0; })
 255 #define unregister_hotcpu_notifier(nb)  ({ (void)(nb); })
 256 #define __unregister_hotcpu_notifier(nb)        ({ (void)(nb); })
 257 #endif          /* CONFIG_HOTPLUG_CPU */
 258
 259 #ifdef CONFIG_PM_SLEEP_SMP
 260 extern int disable_nonboot_cpus(void);
 261 extern void enable_nonboot_cpus(void);
 262 #else /* !CONFIG_PM_SLEEP_SMP */
 263 static inline int disable_nonboot_cpus(void) { return 0; }
 264 static inline void enable_nonboot_cpus(void) {}
 265 #endif /* !CONFIG_PM_SLEEP_SMP */
 266
 267 enum cpuhp_state {
 268         CPUHP_OFFLINE,
 269         CPUHP_ONLINE,
 270 };
 271
 272 void cpu_startup_entry(enum cpuhp_state state);
 273 void cpu_idle(void);
 274
 275 void cpu_idle_poll_ctrl(bool enable);
 276
 277 void arch_cpu_idle(void);
 278 void arch_cpu_idle_prepare(void);
 279 void arch_cpu_idle_enter(void);
 280 void arch_cpu_idle_exit(void);
 281 void arch_cpu_idle_dead(void);
 282
 283 #endif /* _LINUX_CPU_H_ */