tick.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Tick related global functions
  4. */
  5. #ifndef _LINUX_TICK_H
  6. #define _LINUX_TICK_H
  7. #include <linux/clockchips.h>
  8. #include <linux/irqflags.h>
  9. #include <linux/percpu.h>
  10. #include <linux/context_tracking_state.h>
  11. #include <linux/cpumask.h>
  12. #include <linux/sched.h>
  13. #ifdef CONFIG_GENERIC_CLOCKEVENTS
  14. extern void __init tick_init(void);
  15. /* Should be core only, but ARM BL switcher requires it */
  16. extern void tick_suspend_local(void);
  17. /* Should be core only, but XEN resume magic and ARM BL switcher require it */
  18. extern void tick_resume_local(void);
  19. extern void tick_handover_do_timer(void);
  20. extern void tick_cleanup_dead_cpu(int cpu);
  21. #else /* CONFIG_GENERIC_CLOCKEVENTS */
  22. static inline void tick_init(void) { }
  23. static inline void tick_suspend_local(void) { }
  24. static inline void tick_resume_local(void) { }
  25. static inline void tick_handover_do_timer(void) { }
  26. static inline void tick_cleanup_dead_cpu(int cpu) { }
  27. #endif /* !CONFIG_GENERIC_CLOCKEVENTS */
  28. #if defined(CONFIG_GENERIC_CLOCKEVENTS) && defined(CONFIG_SUSPEND)
  29. extern void tick_freeze(void);
  30. extern void tick_unfreeze(void);
  31. #else
  32. static inline void tick_freeze(void) { }
  33. static inline void tick_unfreeze(void) { }
  34. #endif
  35. #ifdef CONFIG_TICK_ONESHOT
  36. extern void tick_irq_enter(void);
  37. # ifndef arch_needs_cpu
  38. # define arch_needs_cpu() (0)
  39. # endif
  40. # else
  41. static inline void tick_irq_enter(void) { }
  42. #endif
  43. #if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT)
  44. extern void hotplug_cpu__broadcast_tick_pull(int dead_cpu);
  45. #else
  46. static inline void hotplug_cpu__broadcast_tick_pull(int dead_cpu) { }
  47. #endif
  48. enum tick_broadcast_mode {
  49. TICK_BROADCAST_OFF,
  50. TICK_BROADCAST_ON,
  51. TICK_BROADCAST_FORCE,
  52. };
  53. enum tick_broadcast_state {
  54. TICK_BROADCAST_EXIT,
  55. TICK_BROADCAST_ENTER,
  56. };
  57. #ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
  58. extern void tick_broadcast_control(enum tick_broadcast_mode mode);
  59. #else
  60. static inline void tick_broadcast_control(enum tick_broadcast_mode mode) { }
  61. #endif /* BROADCAST */
  62. #if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_HOTPLUG_CPU)
  63. extern void tick_offline_cpu(unsigned int cpu);
  64. #else
  65. static inline void tick_offline_cpu(unsigned int cpu) { }
  66. #endif
  67. #ifdef CONFIG_GENERIC_CLOCKEVENTS
  68. extern int tick_broadcast_oneshot_control(enum tick_broadcast_state state);
  69. #else
  70. static inline int tick_broadcast_oneshot_control(enum tick_broadcast_state state)
  71. {
  72. return 0;
  73. }
  74. #endif
  75. static inline void tick_broadcast_enable(void)
  76. {
  77. tick_broadcast_control(TICK_BROADCAST_ON);
  78. }
  79. static inline void tick_broadcast_disable(void)
  80. {
  81. tick_broadcast_control(TICK_BROADCAST_OFF);
  82. }
  83. static inline void tick_broadcast_force(void)
  84. {
  85. tick_broadcast_control(TICK_BROADCAST_FORCE);
  86. }
  87. static inline int tick_broadcast_enter(void)
  88. {
  89. return tick_broadcast_oneshot_control(TICK_BROADCAST_ENTER);
  90. }
  91. static inline void tick_broadcast_exit(void)
  92. {
  93. tick_broadcast_oneshot_control(TICK_BROADCAST_EXIT);
  94. }
  95. enum tick_dep_bits {
  96. TICK_DEP_BIT_POSIX_TIMER = 0,
  97. TICK_DEP_BIT_PERF_EVENTS = 1,
  98. TICK_DEP_BIT_SCHED = 2,
  99. TICK_DEP_BIT_CLOCK_UNSTABLE = 3,
  100. TICK_DEP_BIT_RCU = 4,
  101. TICK_DEP_BIT_RCU_EXP = 5
  102. };
  103. #define TICK_DEP_BIT_MAX TICK_DEP_BIT_RCU_EXP
  104. #define TICK_DEP_MASK_NONE 0
  105. #define TICK_DEP_MASK_POSIX_TIMER (1 << TICK_DEP_BIT_POSIX_TIMER)
  106. #define TICK_DEP_MASK_PERF_EVENTS (1 << TICK_DEP_BIT_PERF_EVENTS)
  107. #define TICK_DEP_MASK_SCHED (1 << TICK_DEP_BIT_SCHED)
  108. #define TICK_DEP_MASK_CLOCK_UNSTABLE (1 << TICK_DEP_BIT_CLOCK_UNSTABLE)
  109. #define TICK_DEP_MASK_RCU (1 << TICK_DEP_BIT_RCU)
  110. #define TICK_DEP_MASK_RCU_EXP (1 << TICK_DEP_BIT_RCU_EXP)
  111. #ifdef CONFIG_NO_HZ_COMMON
  112. extern bool tick_nohz_enabled;
  113. extern bool tick_nohz_tick_stopped(void);
  114. extern bool tick_nohz_tick_stopped_cpu(int cpu);
  115. extern void tick_nohz_idle_stop_tick(void);
  116. extern void tick_nohz_idle_retain_tick(void);
  117. extern void tick_nohz_idle_restart_tick(void);
  118. extern void tick_nohz_idle_enter(void);
  119. extern void tick_nohz_idle_exit(void);
  120. extern void tick_nohz_irq_exit(void);
  121. extern bool tick_nohz_idle_got_tick(void);
  122. extern ktime_t tick_nohz_get_next_hrtimer(void);
  123. extern ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next);
  124. extern unsigned long tick_nohz_get_idle_calls(void);
  125. extern unsigned long tick_nohz_get_idle_calls_cpu(int cpu);
  126. extern u64 get_cpu_idle_time_us(int cpu, u64 *last_update_time);
  127. extern u64 get_cpu_iowait_time_us(int cpu, u64 *last_update_time);
  128. static inline void tick_nohz_idle_stop_tick_protected(void)
  129. {
  130. local_irq_disable();
  131. tick_nohz_idle_stop_tick();
  132. local_irq_enable();
  133. }
  134. #else /* !CONFIG_NO_HZ_COMMON */
  135. #define tick_nohz_enabled (0)
  136. static inline int tick_nohz_tick_stopped(void) { return 0; }
  137. static inline int tick_nohz_tick_stopped_cpu(int cpu) { return 0; }
  138. static inline void tick_nohz_idle_stop_tick(void) { }
  139. static inline void tick_nohz_idle_retain_tick(void) { }
  140. static inline void tick_nohz_idle_restart_tick(void) { }
  141. static inline void tick_nohz_idle_enter(void) { }
  142. static inline void tick_nohz_idle_exit(void) { }
  143. static inline bool tick_nohz_idle_got_tick(void) { return false; }
  144. static inline ktime_t tick_nohz_get_next_hrtimer(void)
  145. {
  146. /* Next wake up is the tick period, assume it starts now */
  147. return ktime_add(ktime_get(), TICK_NSEC);
  148. }
  149. static inline ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next)
  150. {
  151. *delta_next = TICK_NSEC;
  152. return *delta_next;
  153. }
  154. static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return -1; }
  155. static inline u64 get_cpu_iowait_time_us(int cpu, u64 *unused) { return -1; }
  156. static inline void tick_nohz_idle_stop_tick_protected(void) { }
  157. #endif /* !CONFIG_NO_HZ_COMMON */
  158. #ifdef CONFIG_NO_HZ_FULL
  159. extern bool tick_nohz_full_running;
  160. extern cpumask_var_t tick_nohz_full_mask;
  161. static inline bool tick_nohz_full_enabled(void)
  162. {
  163. if (!context_tracking_enabled())
  164. return false;
  165. return tick_nohz_full_running;
  166. }
  167. static inline bool tick_nohz_full_cpu(int cpu)
  168. {
  169. if (!tick_nohz_full_enabled())
  170. return false;
  171. return cpumask_test_cpu(cpu, tick_nohz_full_mask);
  172. }
  173. static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask)
  174. {
  175. if (tick_nohz_full_enabled())
  176. cpumask_or(mask, mask, tick_nohz_full_mask);
  177. }
  178. extern void tick_nohz_dep_set(enum tick_dep_bits bit);
  179. extern void tick_nohz_dep_clear(enum tick_dep_bits bit);
  180. extern void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit);
  181. extern void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit);
  182. extern void tick_nohz_dep_set_task(struct task_struct *tsk,
  183. enum tick_dep_bits bit);
  184. extern void tick_nohz_dep_clear_task(struct task_struct *tsk,
  185. enum tick_dep_bits bit);
  186. extern void tick_nohz_dep_set_signal(struct signal_struct *signal,
  187. enum tick_dep_bits bit);
  188. extern void tick_nohz_dep_clear_signal(struct signal_struct *signal,
  189. enum tick_dep_bits bit);
  190. /*
  191. * The below are tick_nohz_[set,clear]_dep() wrappers that optimize off-cases
  192. * on top of static keys.
  193. */
  194. static inline void tick_dep_set(enum tick_dep_bits bit)
  195. {
  196. if (tick_nohz_full_enabled())
  197. tick_nohz_dep_set(bit);
  198. }
  199. static inline void tick_dep_clear(enum tick_dep_bits bit)
  200. {
  201. if (tick_nohz_full_enabled())
  202. tick_nohz_dep_clear(bit);
  203. }
  204. static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit)
  205. {
  206. if (tick_nohz_full_cpu(cpu))
  207. tick_nohz_dep_set_cpu(cpu, bit);
  208. }
  209. static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit)
  210. {
  211. if (tick_nohz_full_cpu(cpu))
  212. tick_nohz_dep_clear_cpu(cpu, bit);
  213. }
  214. static inline void tick_dep_set_task(struct task_struct *tsk,
  215. enum tick_dep_bits bit)
  216. {
  217. if (tick_nohz_full_enabled())
  218. tick_nohz_dep_set_task(tsk, bit);
  219. }
  220. static inline void tick_dep_clear_task(struct task_struct *tsk,
  221. enum tick_dep_bits bit)
  222. {
  223. if (tick_nohz_full_enabled())
  224. tick_nohz_dep_clear_task(tsk, bit);
  225. }
  226. static inline void tick_dep_set_signal(struct signal_struct *signal,
  227. enum tick_dep_bits bit)
  228. {
  229. if (tick_nohz_full_enabled())
  230. tick_nohz_dep_set_signal(signal, bit);
  231. }
  232. static inline void tick_dep_clear_signal(struct signal_struct *signal,
  233. enum tick_dep_bits bit)
  234. {
  235. if (tick_nohz_full_enabled())
  236. tick_nohz_dep_clear_signal(signal, bit);
  237. }
  238. extern void tick_nohz_full_kick_cpu(int cpu);
  239. extern void __tick_nohz_task_switch(void);
  240. extern void __init tick_nohz_full_setup(cpumask_var_t cpumask);
  241. #else
  242. static inline bool tick_nohz_full_enabled(void) { return false; }
  243. static inline bool tick_nohz_full_cpu(int cpu) { return false; }
  244. static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) { }
  245. static inline void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit) { }
  246. static inline void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { }
  247. static inline void tick_dep_set(enum tick_dep_bits bit) { }
  248. static inline void tick_dep_clear(enum tick_dep_bits bit) { }
  249. static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit) { }
  250. static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { }
  251. static inline void tick_dep_set_task(struct task_struct *tsk,
  252. enum tick_dep_bits bit) { }
  253. static inline void tick_dep_clear_task(struct task_struct *tsk,
  254. enum tick_dep_bits bit) { }
  255. static inline void tick_dep_set_signal(struct signal_struct *signal,
  256. enum tick_dep_bits bit) { }
  257. static inline void tick_dep_clear_signal(struct signal_struct *signal,
  258. enum tick_dep_bits bit) { }
  259. static inline void tick_nohz_full_kick_cpu(int cpu) { }
  260. static inline void __tick_nohz_task_switch(void) { }
  261. static inline void tick_nohz_full_setup(cpumask_var_t cpumask) { }
  262. #endif
  263. static inline void tick_nohz_task_switch(void)
  264. {
  265. if (tick_nohz_full_enabled())
  266. __tick_nohz_task_switch();
  267. }
  268. #endif