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 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 124 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 125 #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
 126 #ifdef CONFIG_HOTPLUG_CPU
 127 extern int register_cpu_notifier(struct notifier_block *nb);
 128 extern void unregister_cpu_notifier(struct notifier_block *nb);
 129 #else
 130
 131 #ifndef MODULE
 132 extern int register_cpu_notifier(struct notifier_block *nb);
 133 #else
 134 static inline int register_cpu_notifier(struct notifier_block *nb)
 135 {
 136         return 0;
 137 }
 138 #endif
 139
 140 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 141 {
 142 }
 143 #endif
 144
 145 int cpu_up(unsigned int cpu);
 146 void notify_cpu_starting(unsigned int cpu);
 147 extern void cpu_maps_update_begin(void);
 148 extern void cpu_maps_update_done(void);
 149
 150 #else   /* CONFIG_SMP */
 151
 152 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
 153
 154 static inline int register_cpu_notifier(struct notifier_block *nb)
 155 {
 156         return 0;
 157 }
 158
 159 static inline void unregister_cpu_notifier(struct notifier_block *nb)
 160 {
 161 }
 162
 163 static inline void cpu_maps_update_begin(void)
 164 {
 165 }
 166
 167 static inline void cpu_maps_update_done(void)
 168 {
 169 }
 170
 171 #endif /* CONFIG_SMP */
 172 extern struct bus_type cpu_subsys;
 173
 174 #ifdef CONFIG_HOTPLUG_CPU
 175 /* Stop CPUs going up and down. */
 176
 177 extern void get_online_cpus(void);
 178 extern void put_online_cpus(void);
 179 extern void cpu_hotplug_disable(void);
 180 extern void cpu_hotplug_enable(void);
 181 #define hotcpu_notifier(fn, pri)        cpu_notifier(fn, pri)
 182 #define register_hotcpu_notifier(nb)    register_cpu_notifier(nb)
 183 #define unregister_hotcpu_notifier(nb)  unregister_cpu_notifier(nb)
 184 void clear_tasks_mm_cpumask(int cpu);
 185 int cpu_down(unsigned int cpu);
 186
 187 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
 188 extern void cpu_hotplug_driver_lock(void);
 189 extern void cpu_hotplug_driver_unlock(void);
 190 #else
 191 static inline void cpu_hotplug_driver_lock(void)
 192 {
 193 }
 194
 195 static inline void cpu_hotplug_driver_unlock(void)
 196 {
 197 }
 198 #endif
 199
 200 #else           /* CONFIG_HOTPLUG_CPU */
 201
 202 #define get_online_cpus()       do { } while (0)
 203 #define put_online_cpus()       do { } while (0)
 204 #define cpu_hotplug_disable()   do { } while (0)
 205 #define cpu_hotplug_enable()    do { } while (0)
 206 #define hotcpu_notifier(fn, pri)        do { (void)(fn); } while (0)
 207 /* These aren't inline functions due to a GCC bug. */
 208 #define register_hotcpu_notifier(nb)    ({ (void)(nb); 0; })
 209 #define unregister_hotcpu_notifier(nb)  ({ (void)(nb); })
 210 #endif          /* CONFIG_HOTPLUG_CPU */
 211
 212 #ifdef CONFIG_PM_SLEEP_SMP
 213 extern int disable_nonboot_cpus(void);
 214 extern void enable_nonboot_cpus(void);
 215 #else /* !CONFIG_PM_SLEEP_SMP */
 216 static inline int disable_nonboot_cpus(void) { return 0; }
 217 static inline void enable_nonboot_cpus(void) {}
 218 #endif /* !CONFIG_PM_SLEEP_SMP */
 219
 220 enum cpuhp_state {
 221         CPUHP_OFFLINE,
 222         CPUHP_ONLINE,
 223 };
 224
 225 void cpu_startup_entry(enum cpuhp_state state);
 226 void cpu_idle(void);
 227
 228 void cpu_idle_poll_ctrl(bool enable);
 229
 230 void arch_cpu_idle(void);
 231 void arch_cpu_idle_prepare(void);
 232 void arch_cpu_idle_enter(void);
 233 void arch_cpu_idle_exit(void);
 234 void arch_cpu_idle_dead(void);
 235
 236 #define IDLE_START 1
 237 #define IDLE_END 2
 238
 239 void idle_notifier_register(struct notifier_block *n);
 240 void idle_notifier_unregister(struct notifier_block *n);
 241 void idle_notifier_call_chain(unsigned long val);
 242
 243 #endif /* _LINUX_CPU_H_ */