2 * sched_clock.c: support for extending counters to full 64-bit ns counter
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 #include <linux/clocksource.h>
9 #include <linux/init.h>
10 #include <linux/jiffies.h>
11 #include <linux/kernel.h>
12 #include <linux/moduleparam.h>
13 #include <linux/sched.h>
14 #include <linux/syscore_ops.h>
15 #include <linux/timer.h>
16 #include <linux/sched_clock.h>
28 static void sched_clock_poll(unsigned long wrap_ticks);
29 static DEFINE_TIMER(sched_clock_timer, sched_clock_poll, 0, 0);
30 static int irqtime = -1;
32 core_param(irqtime, irqtime, int, 0400);
34 static struct clock_data cd = {
35 .mult = NSEC_PER_SEC / HZ,
38 static u32 __read_mostly sched_clock_mask = 0xffffffff;
40 static u32 notrace jiffy_sched_clock_read(void)
42 return (u32)(jiffies - INITIAL_JIFFIES);
45 static u32 __read_mostly (*read_sched_clock)(void) = jiffy_sched_clock_read;
47 static inline u64 notrace cyc_to_ns(u64 cyc, u32 mult, u32 shift)
49 return (cyc * mult) >> shift;
52 static unsigned long long notrace sched_clock_32(void)
62 * Load the epoch_cyc and epoch_ns atomically. We do this by
63 * ensuring that we always write epoch_cyc, epoch_ns and
64 * epoch_cyc_copy in strict order, and read them in strict order.
65 * If epoch_cyc and epoch_cyc_copy are not equal, then we're in
66 * the middle of an update, and we should repeat the load.
69 epoch_cyc = cd.epoch_cyc;
71 epoch_ns = cd.epoch_ns;
73 } while (epoch_cyc != cd.epoch_cyc_copy);
75 cyc = read_sched_clock();
76 cyc = (cyc - epoch_cyc) & sched_clock_mask;
77 return epoch_ns + cyc_to_ns(cyc, cd.mult, cd.shift);
81 * Atomically update the sched_clock epoch.
83 static void notrace update_sched_clock(void)
89 cyc = read_sched_clock();
91 cyc_to_ns((cyc - cd.epoch_cyc) & sched_clock_mask,
94 * Write epoch_cyc and epoch_ns in a way that the update is
95 * detectable in cyc_to_fixed_sched_clock().
97 raw_local_irq_save(flags);
98 cd.epoch_cyc_copy = cyc;
103 raw_local_irq_restore(flags);
106 static void sched_clock_poll(unsigned long wrap_ticks)
108 mod_timer(&sched_clock_timer, round_jiffies(jiffies + wrap_ticks));
109 update_sched_clock();
112 void __init setup_sched_clock(u32 (*read)(void), int bits, unsigned long rate)
122 WARN_ON(!irqs_disabled());
123 read_sched_clock = read;
124 sched_clock_mask = (1 << bits) - 1;
127 /* calculate the mult/shift to convert counter ticks to ns. */
128 clocks_calc_mult_shift(&cd.mult, &cd.shift, rate, NSEC_PER_SEC, 0);
134 } else if (r >= 1000) {
140 /* calculate how many ns until we wrap */
141 wrap = cyc_to_ns((1ULL << bits) - 1, cd.mult, cd.shift);
142 do_div(wrap, NSEC_PER_MSEC);
145 /* calculate the ns resolution of this counter */
146 res = cyc_to_ns(1ULL, cd.mult, cd.shift);
147 pr_info("sched_clock: %u bits at %lu%cHz, resolution %lluns, wraps every %lums\n",
148 bits, r, r_unit, res, w);
151 * Start the timer to keep sched_clock() properly updated and
152 * sets the initial epoch.
154 sched_clock_timer.data = msecs_to_jiffies(w - (w / 10));
155 update_sched_clock();
158 * Ensure that sched_clock() starts off at 0ns
162 /* Enable IRQ time accounting if we have a fast enough sched_clock */
163 if (irqtime > 0 || (irqtime == -1 && rate >= 1000000))
164 enable_sched_clock_irqtime();
166 pr_debug("Registered %pF as sched_clock source\n", read);
169 unsigned long long __read_mostly (*sched_clock_func)(void) = sched_clock_32;
171 unsigned long long notrace sched_clock(void)
173 return sched_clock_func();
176 void __init sched_clock_postinit(void)
179 * If no sched_clock function has been provided at that point,
180 * make it the final one one.
182 if (read_sched_clock == jiffy_sched_clock_read)
183 setup_sched_clock(jiffy_sched_clock_read, 32, HZ);
185 sched_clock_poll(sched_clock_timer.data);
188 static int sched_clock_suspend(void)
190 sched_clock_poll(sched_clock_timer.data);
195 static void sched_clock_resume(void)
197 cd.epoch_cyc = read_sched_clock();
198 cd.epoch_cyc_copy = cd.epoch_cyc;
199 cd.suspended = false;
202 static struct syscore_ops sched_clock_ops = {
203 .suspend = sched_clock_suspend,
204 .resume = sched_clock_resume,
207 static int __init sched_clock_syscore_init(void)
209 register_syscore_ops(&sched_clock_ops);
212 device_initcall(sched_clock_syscore_init);