timekeeping.c 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335
  1. /*
  2. * linux/kernel/time/timekeeping.c
  3. *
  4. * Kernel timekeeping code and accessor functions
  5. *
  6. * This code was moved from linux/kernel/timer.c.
  7. * Please see that file for copyright and history logs.
  8. *
  9. */
  10. #include <linux/timekeeper_internal.h>
  11. #include <linux/module.h>
  12. #include <linux/interrupt.h>
  13. #include <linux/percpu.h>
  14. #include <linux/init.h>
  15. #include <linux/mm.h>
  16. #include <linux/nmi.h>
  17. #include <linux/sched.h>
  18. #include <linux/sched/loadavg.h>
  19. #include <linux/syscore_ops.h>
  20. #include <linux/clocksource.h>
  21. #include <linux/jiffies.h>
  22. #include <linux/time.h>
  23. #include <linux/tick.h>
  24. #include <linux/stop_machine.h>
  25. #include <linux/pvclock_gtod.h>
  26. #include <linux/compiler.h>
  27. #include "tick-internal.h"
  28. #include "ntp_internal.h"
  29. #include "timekeeping_internal.h"
  30. #define TK_CLEAR_NTP (1 << 0)
  31. #define TK_MIRROR (1 << 1)
  32. #define TK_CLOCK_WAS_SET (1 << 2)
  33. /*
  34. * The most important data for readout fits into a single 64 byte
  35. * cache line.
  36. */
  37. static struct {
  38. seqcount_t seq;
  39. struct timekeeper timekeeper;
  40. } tk_core ____cacheline_aligned = {
  41. .seq = SEQCNT_ZERO(tk_core.seq),
  42. };
  43. static DEFINE_RAW_SPINLOCK(timekeeper_lock);
  44. static struct timekeeper shadow_timekeeper;
  45. /**
  46. * struct tk_fast - NMI safe timekeeper
  47. * @seq: Sequence counter for protecting updates. The lowest bit
  48. * is the index for the tk_read_base array
  49. * @base: tk_read_base array. Access is indexed by the lowest bit of
  50. * @seq.
  51. *
  52. * See @update_fast_timekeeper() below.
  53. */
  54. struct tk_fast {
  55. seqcount_t seq;
  56. struct tk_read_base base[2];
  57. };
  58. static struct tk_fast tk_fast_mono ____cacheline_aligned;
  59. static struct tk_fast tk_fast_raw ____cacheline_aligned;
  60. /* flag for if timekeeping is suspended */
  61. int __read_mostly timekeeping_suspended;
  62. static inline void tk_normalize_xtime(struct timekeeper *tk)
  63. {
  64. while (tk->tkr_mono.xtime_nsec >= ((u64)NSEC_PER_SEC << tk->tkr_mono.shift)) {
  65. tk->tkr_mono.xtime_nsec -= (u64)NSEC_PER_SEC << tk->tkr_mono.shift;
  66. tk->xtime_sec++;
  67. }
  68. while (tk->tkr_raw.xtime_nsec >= ((u64)NSEC_PER_SEC << tk->tkr_raw.shift)) {
  69. tk->tkr_raw.xtime_nsec -= (u64)NSEC_PER_SEC << tk->tkr_raw.shift;
  70. tk->raw_sec++;
  71. }
  72. }
  73. static inline struct timespec64 tk_xtime(struct timekeeper *tk)
  74. {
  75. struct timespec64 ts;
  76. ts.tv_sec = tk->xtime_sec;
  77. ts.tv_nsec = (long)(tk->tkr_mono.xtime_nsec >> tk->tkr_mono.shift);
  78. return ts;
  79. }
  80. static void tk_set_xtime(struct timekeeper *tk, const struct timespec64 *ts)
  81. {
  82. tk->xtime_sec = ts->tv_sec;
  83. tk->tkr_mono.xtime_nsec = (u64)ts->tv_nsec << tk->tkr_mono.shift;
  84. }
  85. static void tk_xtime_add(struct timekeeper *tk, const struct timespec64 *ts)
  86. {
  87. tk->xtime_sec += ts->tv_sec;
  88. tk->tkr_mono.xtime_nsec += (u64)ts->tv_nsec << tk->tkr_mono.shift;
  89. tk_normalize_xtime(tk);
  90. }
  91. static void tk_set_wall_to_mono(struct timekeeper *tk, struct timespec64 wtm)
  92. {
  93. struct timespec64 tmp;
  94. /*
  95. * Verify consistency of: offset_real = -wall_to_monotonic
  96. * before modifying anything
  97. */
  98. set_normalized_timespec64(&tmp, -tk->wall_to_monotonic.tv_sec,
  99. -tk->wall_to_monotonic.tv_nsec);
  100. WARN_ON_ONCE(tk->offs_real != timespec64_to_ktime(tmp));
  101. tk->wall_to_monotonic = wtm;
  102. set_normalized_timespec64(&tmp, -wtm.tv_sec, -wtm.tv_nsec);
  103. tk->offs_real = timespec64_to_ktime(tmp);
  104. tk->offs_tai = ktime_add(tk->offs_real, ktime_set(tk->tai_offset, 0));
  105. }
  106. static inline void tk_update_sleep_time(struct timekeeper *tk, ktime_t delta)
  107. {
  108. tk->offs_boot = ktime_add(tk->offs_boot, delta);
  109. }
  110. /*
  111. * tk_clock_read - atomic clocksource read() helper
  112. *
  113. * This helper is necessary to use in the read paths because, while the
  114. * seqlock ensures we don't return a bad value while structures are updated,
  115. * it doesn't protect from potential crashes. There is the possibility that
  116. * the tkr's clocksource may change between the read reference, and the
  117. * clock reference passed to the read function. This can cause crashes if
  118. * the wrong clocksource is passed to the wrong read function.
  119. * This isn't necessary to use when holding the timekeeper_lock or doing
  120. * a read of the fast-timekeeper tkrs (which is protected by its own locking
  121. * and update logic).
  122. */
  123. static inline u64 tk_clock_read(struct tk_read_base *tkr)
  124. {
  125. struct clocksource *clock = READ_ONCE(tkr->clock);
  126. return clock->read(clock);
  127. }
  128. #ifdef CONFIG_DEBUG_TIMEKEEPING
  129. #define WARNING_FREQ (HZ*300) /* 5 minute rate-limiting */
  130. static void timekeeping_check_update(struct timekeeper *tk, u64 offset)
  131. {
  132. u64 max_cycles = tk->tkr_mono.clock->max_cycles;
  133. const char *name = tk->tkr_mono.clock->name;
  134. if (offset > max_cycles) {
  135. printk_deferred("WARNING: timekeeping: Cycle offset (%lld) is larger than allowed by the '%s' clock's max_cycles value (%lld): time overflow danger\n",
  136. offset, name, max_cycles);
  137. printk_deferred(" timekeeping: Your kernel is sick, but tries to cope by capping time updates\n");
  138. } else {
  139. if (offset > (max_cycles >> 1)) {
  140. printk_deferred("INFO: timekeeping: Cycle offset (%lld) is larger than the '%s' clock's 50%% safety margin (%lld)\n",
  141. offset, name, max_cycles >> 1);
  142. printk_deferred(" timekeeping: Your kernel is still fine, but is feeling a bit nervous\n");
  143. }
  144. }
  145. if (tk->underflow_seen) {
  146. if (jiffies - tk->last_warning > WARNING_FREQ) {
  147. printk_deferred("WARNING: Underflow in clocksource '%s' observed, time update ignored.\n", name);
  148. printk_deferred(" Please report this, consider using a different clocksource, if possible.\n");
  149. printk_deferred(" Your kernel is probably still fine.\n");
  150. tk->last_warning = jiffies;
  151. }
  152. tk->underflow_seen = 0;
  153. }
  154. if (tk->overflow_seen) {
  155. if (jiffies - tk->last_warning > WARNING_FREQ) {
  156. printk_deferred("WARNING: Overflow in clocksource '%s' observed, time update capped.\n", name);
  157. printk_deferred(" Please report this, consider using a different clocksource, if possible.\n");
  158. printk_deferred(" Your kernel is probably still fine.\n");
  159. tk->last_warning = jiffies;
  160. }
  161. tk->overflow_seen = 0;
  162. }
  163. }
  164. static inline u64 timekeeping_get_delta(struct tk_read_base *tkr)
  165. {
  166. struct timekeeper *tk = &tk_core.timekeeper;
  167. u64 now, last, mask, max, delta;
  168. unsigned int seq;
  169. /*
  170. * Since we're called holding a seqlock, the data may shift
  171. * under us while we're doing the calculation. This can cause
  172. * false positives, since we'd note a problem but throw the
  173. * results away. So nest another seqlock here to atomically
  174. * grab the points we are checking with.
  175. */
  176. do {
  177. seq = read_seqcount_begin(&tk_core.seq);
  178. now = tk_clock_read(tkr);
  179. last = tkr->cycle_last;
  180. mask = tkr->mask;
  181. max = tkr->clock->max_cycles;
  182. } while (read_seqcount_retry(&tk_core.seq, seq));
  183. delta = clocksource_delta(now, last, mask);
  184. /*
  185. * Try to catch underflows by checking if we are seeing small
  186. * mask-relative negative values.
  187. */
  188. if (unlikely((~delta & mask) < (mask >> 3))) {
  189. tk->underflow_seen = 1;
  190. delta = 0;
  191. }
  192. /* Cap delta value to the max_cycles values to avoid mult overflows */
  193. if (unlikely(delta > max)) {
  194. tk->overflow_seen = 1;
  195. delta = tkr->clock->max_cycles;
  196. }
  197. return delta;
  198. }
  199. #else
  200. static inline void timekeeping_check_update(struct timekeeper *tk, u64 offset)
  201. {
  202. }
  203. static inline u64 timekeeping_get_delta(struct tk_read_base *tkr)
  204. {
  205. u64 cycle_now, delta;
  206. /* read clocksource */
  207. cycle_now = tk_clock_read(tkr);
  208. /* calculate the delta since the last update_wall_time */
  209. delta = clocksource_delta(cycle_now, tkr->cycle_last, tkr->mask);
  210. return delta;
  211. }
  212. #endif
  213. /**
  214. * tk_setup_internals - Set up internals to use clocksource clock.
  215. *
  216. * @tk: The target timekeeper to setup.
  217. * @clock: Pointer to clocksource.
  218. *
  219. * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
  220. * pair and interval request.
  221. *
  222. * Unless you're the timekeeping code, you should not be using this!
  223. */
  224. static void tk_setup_internals(struct timekeeper *tk, struct clocksource *clock)
  225. {
  226. u64 interval;
  227. u64 tmp, ntpinterval;
  228. struct clocksource *old_clock;
  229. ++tk->cs_was_changed_seq;
  230. old_clock = tk->tkr_mono.clock;
  231. tk->tkr_mono.clock = clock;
  232. tk->tkr_mono.mask = clock->mask;
  233. tk->tkr_mono.cycle_last = tk_clock_read(&tk->tkr_mono);
  234. tk->tkr_raw.clock = clock;
  235. tk->tkr_raw.mask = clock->mask;
  236. tk->tkr_raw.cycle_last = tk->tkr_mono.cycle_last;
  237. /* Do the ns -> cycle conversion first, using original mult */
  238. tmp = NTP_INTERVAL_LENGTH;
  239. tmp <<= clock->shift;
  240. ntpinterval = tmp;
  241. tmp += clock->mult/2;
  242. do_div(tmp, clock->mult);
  243. if (tmp == 0)
  244. tmp = 1;
  245. interval = (u64) tmp;
  246. tk->cycle_interval = interval;
  247. /* Go back from cycles -> shifted ns */
  248. tk->xtime_interval = interval * clock->mult;
  249. tk->xtime_remainder = ntpinterval - tk->xtime_interval;
  250. tk->raw_interval = interval * clock->mult;
  251. /* if changing clocks, convert xtime_nsec shift units */
  252. if (old_clock) {
  253. int shift_change = clock->shift - old_clock->shift;
  254. if (shift_change < 0) {
  255. tk->tkr_mono.xtime_nsec >>= -shift_change;
  256. tk->tkr_raw.xtime_nsec >>= -shift_change;
  257. } else {
  258. tk->tkr_mono.xtime_nsec <<= shift_change;
  259. tk->tkr_raw.xtime_nsec <<= shift_change;
  260. }
  261. }
  262. tk->tkr_mono.shift = clock->shift;
  263. tk->tkr_raw.shift = clock->shift;
  264. tk->ntp_error = 0;
  265. tk->ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
  266. tk->ntp_tick = ntpinterval << tk->ntp_error_shift;
  267. /*
  268. * The timekeeper keeps its own mult values for the currently
  269. * active clocksource. These value will be adjusted via NTP
  270. * to counteract clock drifting.
  271. */
  272. tk->tkr_mono.mult = clock->mult;
  273. tk->tkr_raw.mult = clock->mult;
  274. tk->ntp_err_mult = 0;
  275. }
  276. /* Timekeeper helper functions. */
  277. #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
  278. static u32 default_arch_gettimeoffset(void) { return 0; }
  279. u32 (*arch_gettimeoffset)(void) = default_arch_gettimeoffset;
  280. #else
  281. static inline u32 arch_gettimeoffset(void) { return 0; }
  282. #endif
  283. static inline u64 timekeeping_delta_to_ns(struct tk_read_base *tkr, u64 delta)
  284. {
  285. u64 nsec;
  286. nsec = delta * tkr->mult + tkr->xtime_nsec;
  287. nsec >>= tkr->shift;
  288. /* If arch requires, add in get_arch_timeoffset() */
  289. return nsec + arch_gettimeoffset();
  290. }
  291. static inline u64 timekeeping_get_ns(struct tk_read_base *tkr)
  292. {
  293. u64 delta;
  294. delta = timekeeping_get_delta(tkr);
  295. return timekeeping_delta_to_ns(tkr, delta);
  296. }
  297. static inline u64 timekeeping_cycles_to_ns(struct tk_read_base *tkr, u64 cycles)
  298. {
  299. u64 delta;
  300. /* calculate the delta since the last update_wall_time */
  301. delta = clocksource_delta(cycles, tkr->cycle_last, tkr->mask);
  302. return timekeeping_delta_to_ns(tkr, delta);
  303. }
  304. /**
  305. * update_fast_timekeeper - Update the fast and NMI safe monotonic timekeeper.
  306. * @tkr: Timekeeping readout base from which we take the update
  307. *
  308. * We want to use this from any context including NMI and tracing /
  309. * instrumenting the timekeeping code itself.
  310. *
  311. * Employ the latch technique; see @raw_write_seqcount_latch.
  312. *
  313. * So if a NMI hits the update of base[0] then it will use base[1]
  314. * which is still consistent. In the worst case this can result is a
  315. * slightly wrong timestamp (a few nanoseconds). See
  316. * @ktime_get_mono_fast_ns.
  317. */
  318. static void update_fast_timekeeper(struct tk_read_base *tkr, struct tk_fast *tkf)
  319. {
  320. struct tk_read_base *base = tkf->base;
  321. /* Force readers off to base[1] */
  322. raw_write_seqcount_latch(&tkf->seq);
  323. /* Update base[0] */
  324. memcpy(base, tkr, sizeof(*base));
  325. /* Force readers back to base[0] */
  326. raw_write_seqcount_latch(&tkf->seq);
  327. /* Update base[1] */
  328. memcpy(base + 1, base, sizeof(*base));
  329. }
  330. /**
  331. * ktime_get_mono_fast_ns - Fast NMI safe access to clock monotonic
  332. *
  333. * This timestamp is not guaranteed to be monotonic across an update.
  334. * The timestamp is calculated by:
  335. *
  336. * now = base_mono + clock_delta * slope
  337. *
  338. * So if the update lowers the slope, readers who are forced to the
  339. * not yet updated second array are still using the old steeper slope.
  340. *
  341. * tmono
  342. * ^
  343. * | o n
  344. * | o n
  345. * | u
  346. * | o
  347. * |o
  348. * |12345678---> reader order
  349. *
  350. * o = old slope
  351. * u = update
  352. * n = new slope
  353. *
  354. * So reader 6 will observe time going backwards versus reader 5.
  355. *
  356. * While other CPUs are likely to be able observe that, the only way
  357. * for a CPU local observation is when an NMI hits in the middle of
  358. * the update. Timestamps taken from that NMI context might be ahead
  359. * of the following timestamps. Callers need to be aware of that and
  360. * deal with it.
  361. */
  362. static __always_inline u64 __ktime_get_fast_ns(struct tk_fast *tkf)
  363. {
  364. struct tk_read_base *tkr;
  365. unsigned int seq;
  366. u64 now;
  367. do {
  368. seq = raw_read_seqcount_latch(&tkf->seq);
  369. tkr = tkf->base + (seq & 0x01);
  370. now = ktime_to_ns(tkr->base);
  371. now += timekeeping_delta_to_ns(tkr,
  372. clocksource_delta(
  373. tk_clock_read(tkr),
  374. tkr->cycle_last,
  375. tkr->mask));
  376. } while (read_seqcount_retry(&tkf->seq, seq));
  377. return now;
  378. }
  379. u64 ktime_get_mono_fast_ns(void)
  380. {
  381. return __ktime_get_fast_ns(&tk_fast_mono);
  382. }
  383. EXPORT_SYMBOL_GPL(ktime_get_mono_fast_ns);
  384. u64 ktime_get_raw_fast_ns(void)
  385. {
  386. return __ktime_get_fast_ns(&tk_fast_raw);
  387. }
  388. EXPORT_SYMBOL_GPL(ktime_get_raw_fast_ns);
  389. /**
  390. * ktime_get_boot_fast_ns - NMI safe and fast access to boot clock.
  391. *
  392. * To keep it NMI safe since we're accessing from tracing, we're not using a
  393. * separate timekeeper with updates to monotonic clock and boot offset
  394. * protected with seqlocks. This has the following minor side effects:
  395. *
  396. * (1) Its possible that a timestamp be taken after the boot offset is updated
  397. * but before the timekeeper is updated. If this happens, the new boot offset
  398. * is added to the old timekeeping making the clock appear to update slightly
  399. * earlier:
  400. * CPU 0 CPU 1
  401. * timekeeping_inject_sleeptime64()
  402. * __timekeeping_inject_sleeptime(tk, delta);
  403. * timestamp();
  404. * timekeeping_update(tk, TK_CLEAR_NTP...);
  405. *
  406. * (2) On 32-bit systems, the 64-bit boot offset (tk->offs_boot) may be
  407. * partially updated. Since the tk->offs_boot update is a rare event, this
  408. * should be a rare occurrence which postprocessing should be able to handle.
  409. */
  410. u64 notrace ktime_get_boot_fast_ns(void)
  411. {
  412. struct timekeeper *tk = &tk_core.timekeeper;
  413. return (ktime_get_mono_fast_ns() + ktime_to_ns(tk->offs_boot));
  414. }
  415. EXPORT_SYMBOL_GPL(ktime_get_boot_fast_ns);
  416. /* Suspend-time cycles value for halted fast timekeeper. */
  417. static u64 cycles_at_suspend;
  418. static u64 dummy_clock_read(struct clocksource *cs)
  419. {
  420. return cycles_at_suspend;
  421. }
  422. static struct clocksource dummy_clock = {
  423. .read = dummy_clock_read,
  424. };
  425. /**
  426. * halt_fast_timekeeper - Prevent fast timekeeper from accessing clocksource.
  427. * @tk: Timekeeper to snapshot.
  428. *
  429. * It generally is unsafe to access the clocksource after timekeeping has been
  430. * suspended, so take a snapshot of the readout base of @tk and use it as the
  431. * fast timekeeper's readout base while suspended. It will return the same
  432. * number of cycles every time until timekeeping is resumed at which time the
  433. * proper readout base for the fast timekeeper will be restored automatically.
  434. */
  435. static void halt_fast_timekeeper(struct timekeeper *tk)
  436. {
  437. static struct tk_read_base tkr_dummy;
  438. struct tk_read_base *tkr = &tk->tkr_mono;
  439. memcpy(&tkr_dummy, tkr, sizeof(tkr_dummy));
  440. cycles_at_suspend = tk_clock_read(tkr);
  441. tkr_dummy.clock = &dummy_clock;
  442. update_fast_timekeeper(&tkr_dummy, &tk_fast_mono);
  443. tkr = &tk->tkr_raw;
  444. memcpy(&tkr_dummy, tkr, sizeof(tkr_dummy));
  445. tkr_dummy.clock = &dummy_clock;
  446. update_fast_timekeeper(&tkr_dummy, &tk_fast_raw);
  447. }
  448. #ifdef CONFIG_GENERIC_TIME_VSYSCALL_OLD
  449. #warning Please contact your maintainers, as GENERIC_TIME_VSYSCALL_OLD compatibity will disappear soon.
  450. static inline void update_vsyscall(struct timekeeper *tk)
  451. {
  452. struct timespec xt, wm;
  453. xt = timespec64_to_timespec(tk_xtime(tk));
  454. wm = timespec64_to_timespec(tk->wall_to_monotonic);
  455. update_vsyscall_old(&xt, &wm, tk->tkr_mono.clock, tk->tkr_mono.mult,
  456. tk->tkr_mono.cycle_last);
  457. }
  458. static inline void old_vsyscall_fixup(struct timekeeper *tk)
  459. {
  460. s64 remainder;
  461. /*
  462. * Store only full nanoseconds into xtime_nsec after rounding
  463. * it up and add the remainder to the error difference.
  464. * XXX - This is necessary to avoid small 1ns inconsistnecies caused
  465. * by truncating the remainder in vsyscalls. However, it causes
  466. * additional work to be done in timekeeping_adjust(). Once
  467. * the vsyscall implementations are converted to use xtime_nsec
  468. * (shifted nanoseconds), and CONFIG_GENERIC_TIME_VSYSCALL_OLD
  469. * users are removed, this can be killed.
  470. */
  471. remainder = tk->tkr_mono.xtime_nsec & ((1ULL << tk->tkr_mono.shift) - 1);
  472. if (remainder != 0) {
  473. tk->tkr_mono.xtime_nsec -= remainder;
  474. tk->tkr_mono.xtime_nsec += 1ULL << tk->tkr_mono.shift;
  475. tk->ntp_error += remainder << tk->ntp_error_shift;
  476. tk->ntp_error -= (1ULL << tk->tkr_mono.shift) << tk->ntp_error_shift;
  477. }
  478. }
  479. #else
  480. #define old_vsyscall_fixup(tk)
  481. #endif
  482. static RAW_NOTIFIER_HEAD(pvclock_gtod_chain);
  483. static void update_pvclock_gtod(struct timekeeper *tk, bool was_set)
  484. {
  485. raw_notifier_call_chain(&pvclock_gtod_chain, was_set, tk);
  486. }
  487. /**
  488. * pvclock_gtod_register_notifier - register a pvclock timedata update listener
  489. */
  490. int pvclock_gtod_register_notifier(struct notifier_block *nb)
  491. {
  492. struct timekeeper *tk = &tk_core.timekeeper;
  493. unsigned long flags;
  494. int ret;
  495. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  496. ret = raw_notifier_chain_register(&pvclock_gtod_chain, nb);
  497. update_pvclock_gtod(tk, true);
  498. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  499. return ret;
  500. }
  501. EXPORT_SYMBOL_GPL(pvclock_gtod_register_notifier);
  502. /**
  503. * pvclock_gtod_unregister_notifier - unregister a pvclock
  504. * timedata update listener
  505. */
  506. int pvclock_gtod_unregister_notifier(struct notifier_block *nb)
  507. {
  508. unsigned long flags;
  509. int ret;
  510. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  511. ret = raw_notifier_chain_unregister(&pvclock_gtod_chain, nb);
  512. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  513. return ret;
  514. }
  515. EXPORT_SYMBOL_GPL(pvclock_gtod_unregister_notifier);
  516. /*
  517. * tk_update_leap_state - helper to update the next_leap_ktime
  518. */
  519. static inline void tk_update_leap_state(struct timekeeper *tk)
  520. {
  521. tk->next_leap_ktime = ntp_get_next_leap();
  522. if (tk->next_leap_ktime != KTIME_MAX)
  523. /* Convert to monotonic time */
  524. tk->next_leap_ktime = ktime_sub(tk->next_leap_ktime, tk->offs_real);
  525. }
  526. /*
  527. * Update the ktime_t based scalar nsec members of the timekeeper
  528. */
  529. static inline void tk_update_ktime_data(struct timekeeper *tk)
  530. {
  531. u64 seconds;
  532. u32 nsec;
  533. /*
  534. * The xtime based monotonic readout is:
  535. * nsec = (xtime_sec + wtm_sec) * 1e9 + wtm_nsec + now();
  536. * The ktime based monotonic readout is:
  537. * nsec = base_mono + now();
  538. * ==> base_mono = (xtime_sec + wtm_sec) * 1e9 + wtm_nsec
  539. */
  540. seconds = (u64)(tk->xtime_sec + tk->wall_to_monotonic.tv_sec);
  541. nsec = (u32) tk->wall_to_monotonic.tv_nsec;
  542. tk->tkr_mono.base = ns_to_ktime(seconds * NSEC_PER_SEC + nsec);
  543. /*
  544. * The sum of the nanoseconds portions of xtime and
  545. * wall_to_monotonic can be greater/equal one second. Take
  546. * this into account before updating tk->ktime_sec.
  547. */
  548. nsec += (u32)(tk->tkr_mono.xtime_nsec >> tk->tkr_mono.shift);
  549. if (nsec >= NSEC_PER_SEC)
  550. seconds++;
  551. tk->ktime_sec = seconds;
  552. /* Update the monotonic raw base */
  553. tk->tkr_raw.base = ns_to_ktime(tk->raw_sec * NSEC_PER_SEC);
  554. }
  555. /* must hold timekeeper_lock */
  556. static void timekeeping_update(struct timekeeper *tk, unsigned int action)
  557. {
  558. if (action & TK_CLEAR_NTP) {
  559. tk->ntp_error = 0;
  560. ntp_clear();
  561. }
  562. tk_update_leap_state(tk);
  563. tk_update_ktime_data(tk);
  564. update_vsyscall(tk);
  565. update_pvclock_gtod(tk, action & TK_CLOCK_WAS_SET);
  566. update_fast_timekeeper(&tk->tkr_mono, &tk_fast_mono);
  567. update_fast_timekeeper(&tk->tkr_raw, &tk_fast_raw);
  568. if (action & TK_CLOCK_WAS_SET)
  569. tk->clock_was_set_seq++;
  570. /*
  571. * The mirroring of the data to the shadow-timekeeper needs
  572. * to happen last here to ensure we don't over-write the
  573. * timekeeper structure on the next update with stale data
  574. */
  575. if (action & TK_MIRROR)
  576. memcpy(&shadow_timekeeper, &tk_core.timekeeper,
  577. sizeof(tk_core.timekeeper));
  578. }
  579. /**
  580. * timekeeping_forward_now - update clock to the current time
  581. *
  582. * Forward the current clock to update its state since the last call to
  583. * update_wall_time(). This is useful before significant clock changes,
  584. * as it avoids having to deal with this time offset explicitly.
  585. */
  586. static void timekeeping_forward_now(struct timekeeper *tk)
  587. {
  588. u64 cycle_now, delta;
  589. cycle_now = tk_clock_read(&tk->tkr_mono);
  590. delta = clocksource_delta(cycle_now, tk->tkr_mono.cycle_last, tk->tkr_mono.mask);
  591. tk->tkr_mono.cycle_last = cycle_now;
  592. tk->tkr_raw.cycle_last = cycle_now;
  593. tk->tkr_mono.xtime_nsec += delta * tk->tkr_mono.mult;
  594. /* If arch requires, add in get_arch_timeoffset() */
  595. tk->tkr_mono.xtime_nsec += (u64)arch_gettimeoffset() << tk->tkr_mono.shift;
  596. tk->tkr_raw.xtime_nsec += delta * tk->tkr_raw.mult;
  597. /* If arch requires, add in get_arch_timeoffset() */
  598. tk->tkr_raw.xtime_nsec += (u64)arch_gettimeoffset() << tk->tkr_raw.shift;
  599. tk_normalize_xtime(tk);
  600. }
  601. /**
  602. * __getnstimeofday64 - Returns the time of day in a timespec64.
  603. * @ts: pointer to the timespec to be set
  604. *
  605. * Updates the time of day in the timespec.
  606. * Returns 0 on success, or -ve when suspended (timespec will be undefined).
  607. */
  608. int __getnstimeofday64(struct timespec64 *ts)
  609. {
  610. struct timekeeper *tk = &tk_core.timekeeper;
  611. unsigned long seq;
  612. u64 nsecs;
  613. do {
  614. seq = read_seqcount_begin(&tk_core.seq);
  615. ts->tv_sec = tk->xtime_sec;
  616. nsecs = timekeeping_get_ns(&tk->tkr_mono);
  617. } while (read_seqcount_retry(&tk_core.seq, seq));
  618. ts->tv_nsec = 0;
  619. timespec64_add_ns(ts, nsecs);
  620. /*
  621. * Do not bail out early, in case there were callers still using
  622. * the value, even in the face of the WARN_ON.
  623. */
  624. if (unlikely(timekeeping_suspended))
  625. return -EAGAIN;
  626. return 0;
  627. }
  628. EXPORT_SYMBOL(__getnstimeofday64);
  629. /**
  630. * getnstimeofday64 - Returns the time of day in a timespec64.
  631. * @ts: pointer to the timespec64 to be set
  632. *
  633. * Returns the time of day in a timespec64 (WARN if suspended).
  634. */
  635. void getnstimeofday64(struct timespec64 *ts)
  636. {
  637. WARN_ON(__getnstimeofday64(ts));
  638. }
  639. EXPORT_SYMBOL(getnstimeofday64);
  640. ktime_t ktime_get(void)
  641. {
  642. struct timekeeper *tk = &tk_core.timekeeper;
  643. unsigned int seq;
  644. ktime_t base;
  645. u64 nsecs;
  646. WARN_ON(timekeeping_suspended);
  647. do {
  648. seq = read_seqcount_begin(&tk_core.seq);
  649. base = tk->tkr_mono.base;
  650. nsecs = timekeeping_get_ns(&tk->tkr_mono);
  651. } while (read_seqcount_retry(&tk_core.seq, seq));
  652. return ktime_add_ns(base, nsecs);
  653. }
  654. EXPORT_SYMBOL_GPL(ktime_get);
  655. u32 ktime_get_resolution_ns(void)
  656. {
  657. struct timekeeper *tk = &tk_core.timekeeper;
  658. unsigned int seq;
  659. u32 nsecs;
  660. WARN_ON(timekeeping_suspended);
  661. do {
  662. seq = read_seqcount_begin(&tk_core.seq);
  663. nsecs = tk->tkr_mono.mult >> tk->tkr_mono.shift;
  664. } while (read_seqcount_retry(&tk_core.seq, seq));
  665. return nsecs;
  666. }
  667. EXPORT_SYMBOL_GPL(ktime_get_resolution_ns);
  668. static ktime_t *offsets[TK_OFFS_MAX] = {
  669. [TK_OFFS_REAL] = &tk_core.timekeeper.offs_real,
  670. [TK_OFFS_BOOT] = &tk_core.timekeeper.offs_boot,
  671. [TK_OFFS_TAI] = &tk_core.timekeeper.offs_tai,
  672. };
  673. ktime_t ktime_get_with_offset(enum tk_offsets offs)
  674. {
  675. struct timekeeper *tk = &tk_core.timekeeper;
  676. unsigned int seq;
  677. ktime_t base, *offset = offsets[offs];
  678. u64 nsecs;
  679. WARN_ON(timekeeping_suspended);
  680. do {
  681. seq = read_seqcount_begin(&tk_core.seq);
  682. base = ktime_add(tk->tkr_mono.base, *offset);
  683. nsecs = timekeeping_get_ns(&tk->tkr_mono);
  684. } while (read_seqcount_retry(&tk_core.seq, seq));
  685. return ktime_add_ns(base, nsecs);
  686. }
  687. EXPORT_SYMBOL_GPL(ktime_get_with_offset);
  688. /**
  689. * ktime_mono_to_any() - convert mononotic time to any other time
  690. * @tmono: time to convert.
  691. * @offs: which offset to use
  692. */
  693. ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs)
  694. {
  695. ktime_t *offset = offsets[offs];
  696. unsigned long seq;
  697. ktime_t tconv;
  698. do {
  699. seq = read_seqcount_begin(&tk_core.seq);
  700. tconv = ktime_add(tmono, *offset);
  701. } while (read_seqcount_retry(&tk_core.seq, seq));
  702. return tconv;
  703. }
  704. EXPORT_SYMBOL_GPL(ktime_mono_to_any);
  705. /**
  706. * ktime_get_raw - Returns the raw monotonic time in ktime_t format
  707. */
  708. ktime_t ktime_get_raw(void)
  709. {
  710. struct timekeeper *tk = &tk_core.timekeeper;
  711. unsigned int seq;
  712. ktime_t base;
  713. u64 nsecs;
  714. do {
  715. seq = read_seqcount_begin(&tk_core.seq);
  716. base = tk->tkr_raw.base;
  717. nsecs = timekeeping_get_ns(&tk->tkr_raw);
  718. } while (read_seqcount_retry(&tk_core.seq, seq));
  719. return ktime_add_ns(base, nsecs);
  720. }
  721. EXPORT_SYMBOL_GPL(ktime_get_raw);
  722. /**
  723. * ktime_get_ts64 - get the monotonic clock in timespec64 format
  724. * @ts: pointer to timespec variable
  725. *
  726. * The function calculates the monotonic clock from the realtime
  727. * clock and the wall_to_monotonic offset and stores the result
  728. * in normalized timespec64 format in the variable pointed to by @ts.
  729. */
  730. void ktime_get_ts64(struct timespec64 *ts)
  731. {
  732. struct timekeeper *tk = &tk_core.timekeeper;
  733. struct timespec64 tomono;
  734. unsigned int seq;
  735. u64 nsec;
  736. WARN_ON(timekeeping_suspended);
  737. do {
  738. seq = read_seqcount_begin(&tk_core.seq);
  739. ts->tv_sec = tk->xtime_sec;
  740. nsec = timekeeping_get_ns(&tk->tkr_mono);
  741. tomono = tk->wall_to_monotonic;
  742. } while (read_seqcount_retry(&tk_core.seq, seq));
  743. ts->tv_sec += tomono.tv_sec;
  744. ts->tv_nsec = 0;
  745. timespec64_add_ns(ts, nsec + tomono.tv_nsec);
  746. }
  747. EXPORT_SYMBOL_GPL(ktime_get_ts64);
  748. /**
  749. * ktime_get_seconds - Get the seconds portion of CLOCK_MONOTONIC
  750. *
  751. * Returns the seconds portion of CLOCK_MONOTONIC with a single non
  752. * serialized read. tk->ktime_sec is of type 'unsigned long' so this
  753. * works on both 32 and 64 bit systems. On 32 bit systems the readout
  754. * covers ~136 years of uptime which should be enough to prevent
  755. * premature wrap arounds.
  756. */
  757. time64_t ktime_get_seconds(void)
  758. {
  759. struct timekeeper *tk = &tk_core.timekeeper;
  760. WARN_ON(timekeeping_suspended);
  761. return tk->ktime_sec;
  762. }
  763. EXPORT_SYMBOL_GPL(ktime_get_seconds);
  764. /**
  765. * ktime_get_real_seconds - Get the seconds portion of CLOCK_REALTIME
  766. *
  767. * Returns the wall clock seconds since 1970. This replaces the
  768. * get_seconds() interface which is not y2038 safe on 32bit systems.
  769. *
  770. * For 64bit systems the fast access to tk->xtime_sec is preserved. On
  771. * 32bit systems the access must be protected with the sequence
  772. * counter to provide "atomic" access to the 64bit tk->xtime_sec
  773. * value.
  774. */
  775. time64_t ktime_get_real_seconds(void)
  776. {
  777. struct timekeeper *tk = &tk_core.timekeeper;
  778. time64_t seconds;
  779. unsigned int seq;
  780. if (IS_ENABLED(CONFIG_64BIT))
  781. return tk->xtime_sec;
  782. do {
  783. seq = read_seqcount_begin(&tk_core.seq);
  784. seconds = tk->xtime_sec;
  785. } while (read_seqcount_retry(&tk_core.seq, seq));
  786. return seconds;
  787. }
  788. EXPORT_SYMBOL_GPL(ktime_get_real_seconds);
  789. /**
  790. * __ktime_get_real_seconds - The same as ktime_get_real_seconds
  791. * but without the sequence counter protect. This internal function
  792. * is called just when timekeeping lock is already held.
  793. */
  794. time64_t __ktime_get_real_seconds(void)
  795. {
  796. struct timekeeper *tk = &tk_core.timekeeper;
  797. return tk->xtime_sec;
  798. }
  799. /**
  800. * ktime_get_snapshot - snapshots the realtime/monotonic raw clocks with counter
  801. * @systime_snapshot: pointer to struct receiving the system time snapshot
  802. */
  803. void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot)
  804. {
  805. struct timekeeper *tk = &tk_core.timekeeper;
  806. unsigned long seq;
  807. ktime_t base_raw;
  808. ktime_t base_real;
  809. u64 nsec_raw;
  810. u64 nsec_real;
  811. u64 now;
  812. WARN_ON_ONCE(timekeeping_suspended);
  813. do {
  814. seq = read_seqcount_begin(&tk_core.seq);
  815. now = tk_clock_read(&tk->tkr_mono);
  816. systime_snapshot->cs_was_changed_seq = tk->cs_was_changed_seq;
  817. systime_snapshot->clock_was_set_seq = tk->clock_was_set_seq;
  818. base_real = ktime_add(tk->tkr_mono.base,
  819. tk_core.timekeeper.offs_real);
  820. base_raw = tk->tkr_raw.base;
  821. nsec_real = timekeeping_cycles_to_ns(&tk->tkr_mono, now);
  822. nsec_raw = timekeeping_cycles_to_ns(&tk->tkr_raw, now);
  823. } while (read_seqcount_retry(&tk_core.seq, seq));
  824. systime_snapshot->cycles = now;
  825. systime_snapshot->real = ktime_add_ns(base_real, nsec_real);
  826. systime_snapshot->raw = ktime_add_ns(base_raw, nsec_raw);
  827. }
  828. EXPORT_SYMBOL_GPL(ktime_get_snapshot);
  829. /* Scale base by mult/div checking for overflow */
  830. static int scale64_check_overflow(u64 mult, u64 div, u64 *base)
  831. {
  832. u64 tmp, rem;
  833. tmp = div64_u64_rem(*base, div, &rem);
  834. if (((int)sizeof(u64)*8 - fls64(mult) < fls64(tmp)) ||
  835. ((int)sizeof(u64)*8 - fls64(mult) < fls64(rem)))
  836. return -EOVERFLOW;
  837. tmp *= mult;
  838. rem = div64_u64(rem * mult, div);
  839. *base = tmp + rem;
  840. return 0;
  841. }
  842. /**
  843. * adjust_historical_crosststamp - adjust crosstimestamp previous to current interval
  844. * @history: Snapshot representing start of history
  845. * @partial_history_cycles: Cycle offset into history (fractional part)
  846. * @total_history_cycles: Total history length in cycles
  847. * @discontinuity: True indicates clock was set on history period
  848. * @ts: Cross timestamp that should be adjusted using
  849. * partial/total ratio
  850. *
  851. * Helper function used by get_device_system_crosststamp() to correct the
  852. * crosstimestamp corresponding to the start of the current interval to the
  853. * system counter value (timestamp point) provided by the driver. The
  854. * total_history_* quantities are the total history starting at the provided
  855. * reference point and ending at the start of the current interval. The cycle
  856. * count between the driver timestamp point and the start of the current
  857. * interval is partial_history_cycles.
  858. */
  859. static int adjust_historical_crosststamp(struct system_time_snapshot *history,
  860. u64 partial_history_cycles,
  861. u64 total_history_cycles,
  862. bool discontinuity,
  863. struct system_device_crosststamp *ts)
  864. {
  865. struct timekeeper *tk = &tk_core.timekeeper;
  866. u64 corr_raw, corr_real;
  867. bool interp_forward;
  868. int ret;
  869. if (total_history_cycles == 0 || partial_history_cycles == 0)
  870. return 0;
  871. /* Interpolate shortest distance from beginning or end of history */
  872. interp_forward = partial_history_cycles > total_history_cycles / 2;
  873. partial_history_cycles = interp_forward ?
  874. total_history_cycles - partial_history_cycles :
  875. partial_history_cycles;
  876. /*
  877. * Scale the monotonic raw time delta by:
  878. * partial_history_cycles / total_history_cycles
  879. */
  880. corr_raw = (u64)ktime_to_ns(
  881. ktime_sub(ts->sys_monoraw, history->raw));
  882. ret = scale64_check_overflow(partial_history_cycles,
  883. total_history_cycles, &corr_raw);
  884. if (ret)
  885. return ret;
  886. /*
  887. * If there is a discontinuity in the history, scale monotonic raw
  888. * correction by:
  889. * mult(real)/mult(raw) yielding the realtime correction
  890. * Otherwise, calculate the realtime correction similar to monotonic
  891. * raw calculation
  892. */
  893. if (discontinuity) {
  894. corr_real = mul_u64_u32_div
  895. (corr_raw, tk->tkr_mono.mult, tk->tkr_raw.mult);
  896. } else {
  897. corr_real = (u64)ktime_to_ns(
  898. ktime_sub(ts->sys_realtime, history->real));
  899. ret = scale64_check_overflow(partial_history_cycles,
  900. total_history_cycles, &corr_real);
  901. if (ret)
  902. return ret;
  903. }
  904. /* Fixup monotonic raw and real time time values */
  905. if (interp_forward) {
  906. ts->sys_monoraw = ktime_add_ns(history->raw, corr_raw);
  907. ts->sys_realtime = ktime_add_ns(history->real, corr_real);
  908. } else {
  909. ts->sys_monoraw = ktime_sub_ns(ts->sys_monoraw, corr_raw);
  910. ts->sys_realtime = ktime_sub_ns(ts->sys_realtime, corr_real);
  911. }
  912. return 0;
  913. }
  914. /*
  915. * cycle_between - true if test occurs chronologically between before and after
  916. */
  917. static bool cycle_between(u64 before, u64 test, u64 after)
  918. {
  919. if (test > before && test < after)
  920. return true;
  921. if (test < before && before > after)
  922. return true;
  923. return false;
  924. }
  925. /**
  926. * get_device_system_crosststamp - Synchronously capture system/device timestamp
  927. * @get_time_fn: Callback to get simultaneous device time and
  928. * system counter from the device driver
  929. * @ctx: Context passed to get_time_fn()
  930. * @history_begin: Historical reference point used to interpolate system
  931. * time when counter provided by the driver is before the current interval
  932. * @xtstamp: Receives simultaneously captured system and device time
  933. *
  934. * Reads a timestamp from a device and correlates it to system time
  935. */
  936. int get_device_system_crosststamp(int (*get_time_fn)
  937. (ktime_t *device_time,
  938. struct system_counterval_t *sys_counterval,
  939. void *ctx),
  940. void *ctx,
  941. struct system_time_snapshot *history_begin,
  942. struct system_device_crosststamp *xtstamp)
  943. {
  944. struct system_counterval_t system_counterval;
  945. struct timekeeper *tk = &tk_core.timekeeper;
  946. u64 cycles, now, interval_start;
  947. unsigned int clock_was_set_seq = 0;
  948. ktime_t base_real, base_raw;
  949. u64 nsec_real, nsec_raw;
  950. u8 cs_was_changed_seq;
  951. unsigned long seq;
  952. bool do_interp;
  953. int ret;
  954. do {
  955. seq = read_seqcount_begin(&tk_core.seq);
  956. /*
  957. * Try to synchronously capture device time and a system
  958. * counter value calling back into the device driver
  959. */
  960. ret = get_time_fn(&xtstamp->device, &system_counterval, ctx);
  961. if (ret)
  962. return ret;
  963. /*
  964. * Verify that the clocksource associated with the captured
  965. * system counter value is the same as the currently installed
  966. * timekeeper clocksource
  967. */
  968. if (tk->tkr_mono.clock != system_counterval.cs)
  969. return -ENODEV;
  970. cycles = system_counterval.cycles;
  971. /*
  972. * Check whether the system counter value provided by the
  973. * device driver is on the current timekeeping interval.
  974. */
  975. now = tk_clock_read(&tk->tkr_mono);
  976. interval_start = tk->tkr_mono.cycle_last;
  977. if (!cycle_between(interval_start, cycles, now)) {
  978. clock_was_set_seq = tk->clock_was_set_seq;
  979. cs_was_changed_seq = tk->cs_was_changed_seq;
  980. cycles = interval_start;
  981. do_interp = true;
  982. } else {
  983. do_interp = false;
  984. }
  985. base_real = ktime_add(tk->tkr_mono.base,
  986. tk_core.timekeeper.offs_real);
  987. base_raw = tk->tkr_raw.base;
  988. nsec_real = timekeeping_cycles_to_ns(&tk->tkr_mono,
  989. system_counterval.cycles);
  990. nsec_raw = timekeeping_cycles_to_ns(&tk->tkr_raw,
  991. system_counterval.cycles);
  992. } while (read_seqcount_retry(&tk_core.seq, seq));
  993. xtstamp->sys_realtime = ktime_add_ns(base_real, nsec_real);
  994. xtstamp->sys_monoraw = ktime_add_ns(base_raw, nsec_raw);
  995. /*
  996. * Interpolate if necessary, adjusting back from the start of the
  997. * current interval
  998. */
  999. if (do_interp) {
  1000. u64 partial_history_cycles, total_history_cycles;
  1001. bool discontinuity;
  1002. /*
  1003. * Check that the counter value occurs after the provided
  1004. * history reference and that the history doesn't cross a
  1005. * clocksource change
  1006. */
  1007. if (!history_begin ||
  1008. !cycle_between(history_begin->cycles,
  1009. system_counterval.cycles, cycles) ||
  1010. history_begin->cs_was_changed_seq != cs_was_changed_seq)
  1011. return -EINVAL;
  1012. partial_history_cycles = cycles - system_counterval.cycles;
  1013. total_history_cycles = cycles - history_begin->cycles;
  1014. discontinuity =
  1015. history_begin->clock_was_set_seq != clock_was_set_seq;
  1016. ret = adjust_historical_crosststamp(history_begin,
  1017. partial_history_cycles,
  1018. total_history_cycles,
  1019. discontinuity, xtstamp);
  1020. if (ret)
  1021. return ret;
  1022. }
  1023. return 0;
  1024. }
  1025. EXPORT_SYMBOL_GPL(get_device_system_crosststamp);
  1026. /**
  1027. * do_gettimeofday - Returns the time of day in a timeval
  1028. * @tv: pointer to the timeval to be set
  1029. *
  1030. * NOTE: Users should be converted to using getnstimeofday()
  1031. */
  1032. void do_gettimeofday(struct timeval *tv)
  1033. {
  1034. struct timespec64 now;
  1035. getnstimeofday64(&now);
  1036. tv->tv_sec = now.tv_sec;
  1037. tv->tv_usec = now.tv_nsec/1000;
  1038. }
  1039. EXPORT_SYMBOL(do_gettimeofday);
  1040. /**
  1041. * do_settimeofday64 - Sets the time of day.
  1042. * @ts: pointer to the timespec64 variable containing the new time
  1043. *
  1044. * Sets the time of day to the new time and update NTP and notify hrtimers
  1045. */
  1046. int do_settimeofday64(const struct timespec64 *ts)
  1047. {
  1048. struct timekeeper *tk = &tk_core.timekeeper;
  1049. struct timespec64 ts_delta, xt;
  1050. unsigned long flags;
  1051. int ret = 0;
  1052. if (!timespec64_valid_strict(ts))
  1053. return -EINVAL;
  1054. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1055. write_seqcount_begin(&tk_core.seq);
  1056. timekeeping_forward_now(tk);
  1057. xt = tk_xtime(tk);
  1058. ts_delta.tv_sec = ts->tv_sec - xt.tv_sec;
  1059. ts_delta.tv_nsec = ts->tv_nsec - xt.tv_nsec;
  1060. if (timespec64_compare(&tk->wall_to_monotonic, &ts_delta) > 0) {
  1061. ret = -EINVAL;
  1062. goto out;
  1063. }
  1064. tk_set_wall_to_mono(tk, timespec64_sub(tk->wall_to_monotonic, ts_delta));
  1065. tk_set_xtime(tk, ts);
  1066. out:
  1067. timekeeping_update(tk, TK_CLEAR_NTP | TK_MIRROR | TK_CLOCK_WAS_SET);
  1068. write_seqcount_end(&tk_core.seq);
  1069. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1070. /* signal hrtimers about time change */
  1071. clock_was_set();
  1072. return ret;
  1073. }
  1074. EXPORT_SYMBOL(do_settimeofday64);
  1075. /**
  1076. * timekeeping_inject_offset - Adds or subtracts from the current time.
  1077. * @tv: pointer to the timespec variable containing the offset
  1078. *
  1079. * Adds or subtracts an offset value from the current time.
  1080. */
  1081. int timekeeping_inject_offset(struct timespec *ts)
  1082. {
  1083. struct timekeeper *tk = &tk_core.timekeeper;
  1084. unsigned long flags;
  1085. struct timespec64 ts64, tmp;
  1086. int ret = 0;
  1087. if (!timespec_inject_offset_valid(ts))
  1088. return -EINVAL;
  1089. ts64 = timespec_to_timespec64(*ts);
  1090. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1091. write_seqcount_begin(&tk_core.seq);
  1092. timekeeping_forward_now(tk);
  1093. /* Make sure the proposed value is valid */
  1094. tmp = timespec64_add(tk_xtime(tk), ts64);
  1095. if (timespec64_compare(&tk->wall_to_monotonic, &ts64) > 0 ||
  1096. !timespec64_valid_strict(&tmp)) {
  1097. ret = -EINVAL;
  1098. goto error;
  1099. }
  1100. tk_xtime_add(tk, &ts64);
  1101. tk_set_wall_to_mono(tk, timespec64_sub(tk->wall_to_monotonic, ts64));
  1102. error: /* even if we error out, we forwarded the time, so call update */
  1103. timekeeping_update(tk, TK_CLEAR_NTP | TK_MIRROR | TK_CLOCK_WAS_SET);
  1104. write_seqcount_end(&tk_core.seq);
  1105. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1106. /* signal hrtimers about time change */
  1107. clock_was_set();
  1108. return ret;
  1109. }
  1110. EXPORT_SYMBOL(timekeeping_inject_offset);
  1111. /**
  1112. * __timekeeping_set_tai_offset - Sets the TAI offset from UTC and monotonic
  1113. *
  1114. */
  1115. static void __timekeeping_set_tai_offset(struct timekeeper *tk, s32 tai_offset)
  1116. {
  1117. tk->tai_offset = tai_offset;
  1118. tk->offs_tai = ktime_add(tk->offs_real, ktime_set(tai_offset, 0));
  1119. }
  1120. /**
  1121. * change_clocksource - Swaps clocksources if a new one is available
  1122. *
  1123. * Accumulates current time interval and initializes new clocksource
  1124. */
  1125. static int change_clocksource(void *data)
  1126. {
  1127. struct timekeeper *tk = &tk_core.timekeeper;
  1128. struct clocksource *new, *old;
  1129. unsigned long flags;
  1130. new = (struct clocksource *) data;
  1131. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1132. write_seqcount_begin(&tk_core.seq);
  1133. timekeeping_forward_now(tk);
  1134. /*
  1135. * If the cs is in module, get a module reference. Succeeds
  1136. * for built-in code (owner == NULL) as well.
  1137. */
  1138. if (try_module_get(new->owner)) {
  1139. if (!new->enable || new->enable(new) == 0) {
  1140. old = tk->tkr_mono.clock;
  1141. tk_setup_internals(tk, new);
  1142. if (old->disable)
  1143. old->disable(old);
  1144. module_put(old->owner);
  1145. } else {
  1146. module_put(new->owner);
  1147. }
  1148. }
  1149. timekeeping_update(tk, TK_CLEAR_NTP | TK_MIRROR | TK_CLOCK_WAS_SET);
  1150. write_seqcount_end(&tk_core.seq);
  1151. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1152. return 0;
  1153. }
  1154. /**
  1155. * timekeeping_notify - Install a new clock source
  1156. * @clock: pointer to the clock source
  1157. *
  1158. * This function is called from clocksource.c after a new, better clock
  1159. * source has been registered. The caller holds the clocksource_mutex.
  1160. */
  1161. int timekeeping_notify(struct clocksource *clock)
  1162. {
  1163. struct timekeeper *tk = &tk_core.timekeeper;
  1164. if (tk->tkr_mono.clock == clock)
  1165. return 0;
  1166. stop_machine(change_clocksource, clock, NULL);
  1167. tick_clock_notify();
  1168. return tk->tkr_mono.clock == clock ? 0 : -1;
  1169. }
  1170. /**
  1171. * getrawmonotonic64 - Returns the raw monotonic time in a timespec
  1172. * @ts: pointer to the timespec64 to be set
  1173. *
  1174. * Returns the raw monotonic time (completely un-modified by ntp)
  1175. */
  1176. void getrawmonotonic64(struct timespec64 *ts)
  1177. {
  1178. struct timekeeper *tk = &tk_core.timekeeper;
  1179. unsigned long seq;
  1180. u64 nsecs;
  1181. do {
  1182. seq = read_seqcount_begin(&tk_core.seq);
  1183. ts->tv_sec = tk->raw_sec;
  1184. nsecs = timekeeping_get_ns(&tk->tkr_raw);
  1185. } while (read_seqcount_retry(&tk_core.seq, seq));
  1186. ts->tv_nsec = 0;
  1187. timespec64_add_ns(ts, nsecs);
  1188. }
  1189. EXPORT_SYMBOL(getrawmonotonic64);
  1190. /**
  1191. * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
  1192. */
  1193. int timekeeping_valid_for_hres(void)
  1194. {
  1195. struct timekeeper *tk = &tk_core.timekeeper;
  1196. unsigned long seq;
  1197. int ret;
  1198. do {
  1199. seq = read_seqcount_begin(&tk_core.seq);
  1200. ret = tk->tkr_mono.clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
  1201. } while (read_seqcount_retry(&tk_core.seq, seq));
  1202. return ret;
  1203. }
  1204. /**
  1205. * timekeeping_max_deferment - Returns max time the clocksource can be deferred
  1206. */
  1207. u64 timekeeping_max_deferment(void)
  1208. {
  1209. struct timekeeper *tk = &tk_core.timekeeper;
  1210. unsigned long seq;
  1211. u64 ret;
  1212. do {
  1213. seq = read_seqcount_begin(&tk_core.seq);
  1214. ret = tk->tkr_mono.clock->max_idle_ns;
  1215. } while (read_seqcount_retry(&tk_core.seq, seq));
  1216. return ret;
  1217. }
  1218. /**
  1219. * read_persistent_clock - Return time from the persistent clock.
  1220. *
  1221. * Weak dummy function for arches that do not yet support it.
  1222. * Reads the time from the battery backed persistent clock.
  1223. * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
  1224. *
  1225. * XXX - Do be sure to remove it once all arches implement it.
  1226. */
  1227. void __weak read_persistent_clock(struct timespec *ts)
  1228. {
  1229. ts->tv_sec = 0;
  1230. ts->tv_nsec = 0;
  1231. }
  1232. void __weak read_persistent_clock64(struct timespec64 *ts64)
  1233. {
  1234. struct timespec ts;
  1235. read_persistent_clock(&ts);
  1236. *ts64 = timespec_to_timespec64(ts);
  1237. }
  1238. /**
  1239. * read_boot_clock64 - Return time of the system start.
  1240. *
  1241. * Weak dummy function for arches that do not yet support it.
  1242. * Function to read the exact time the system has been started.
  1243. * Returns a timespec64 with tv_sec=0 and tv_nsec=0 if unsupported.
  1244. *
  1245. * XXX - Do be sure to remove it once all arches implement it.
  1246. */
  1247. void __weak read_boot_clock64(struct timespec64 *ts)
  1248. {
  1249. ts->tv_sec = 0;
  1250. ts->tv_nsec = 0;
  1251. }
  1252. /* Flag for if timekeeping_resume() has injected sleeptime */
  1253. static bool sleeptime_injected;
  1254. /* Flag for if there is a persistent clock on this platform */
  1255. static bool persistent_clock_exists;
  1256. /*
  1257. * timekeeping_init - Initializes the clocksource and common timekeeping values
  1258. */
  1259. void __init timekeeping_init(void)
  1260. {
  1261. struct timekeeper *tk = &tk_core.timekeeper;
  1262. struct clocksource *clock;
  1263. unsigned long flags;
  1264. struct timespec64 now, boot, tmp;
  1265. read_persistent_clock64(&now);
  1266. if (!timespec64_valid_strict(&now)) {
  1267. pr_warn("WARNING: Persistent clock returned invalid value!\n"
  1268. " Check your CMOS/BIOS settings.\n");
  1269. now.tv_sec = 0;
  1270. now.tv_nsec = 0;
  1271. } else if (now.tv_sec || now.tv_nsec)
  1272. persistent_clock_exists = true;
  1273. read_boot_clock64(&boot);
  1274. if (!timespec64_valid_strict(&boot)) {
  1275. pr_warn("WARNING: Boot clock returned invalid value!\n"
  1276. " Check your CMOS/BIOS settings.\n");
  1277. boot.tv_sec = 0;
  1278. boot.tv_nsec = 0;
  1279. }
  1280. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1281. write_seqcount_begin(&tk_core.seq);
  1282. ntp_init();
  1283. clock = clocksource_default_clock();
  1284. if (clock->enable)
  1285. clock->enable(clock);
  1286. tk_setup_internals(tk, clock);
  1287. tk_set_xtime(tk, &now);
  1288. tk->raw_sec = 0;
  1289. if (boot.tv_sec == 0 && boot.tv_nsec == 0)
  1290. boot = tk_xtime(tk);
  1291. set_normalized_timespec64(&tmp, -boot.tv_sec, -boot.tv_nsec);
  1292. tk_set_wall_to_mono(tk, tmp);
  1293. timekeeping_update(tk, TK_MIRROR | TK_CLOCK_WAS_SET);
  1294. write_seqcount_end(&tk_core.seq);
  1295. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1296. }
  1297. /* time in seconds when suspend began for persistent clock */
  1298. static struct timespec64 timekeeping_suspend_time;
  1299. /**
  1300. * __timekeeping_inject_sleeptime - Internal function to add sleep interval
  1301. * @delta: pointer to a timespec delta value
  1302. *
  1303. * Takes a timespec offset measuring a suspend interval and properly
  1304. * adds the sleep offset to the timekeeping variables.
  1305. */
  1306. static void __timekeeping_inject_sleeptime(struct timekeeper *tk,
  1307. struct timespec64 *delta)
  1308. {
  1309. if (!timespec64_valid_strict(delta)) {
  1310. printk_deferred(KERN_WARNING
  1311. "__timekeeping_inject_sleeptime: Invalid "
  1312. "sleep delta value!\n");
  1313. return;
  1314. }
  1315. tk_xtime_add(tk, delta);
  1316. tk_set_wall_to_mono(tk, timespec64_sub(tk->wall_to_monotonic, *delta));
  1317. tk_update_sleep_time(tk, timespec64_to_ktime(*delta));
  1318. tk_debug_account_sleep_time(delta);
  1319. }
  1320. #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
  1321. /**
  1322. * We have three kinds of time sources to use for sleep time
  1323. * injection, the preference order is:
  1324. * 1) non-stop clocksource
  1325. * 2) persistent clock (ie: RTC accessible when irqs are off)
  1326. * 3) RTC
  1327. *
  1328. * 1) and 2) are used by timekeeping, 3) by RTC subsystem.
  1329. * If system has neither 1) nor 2), 3) will be used finally.
  1330. *
  1331. *
  1332. * If timekeeping has injected sleeptime via either 1) or 2),
  1333. * 3) becomes needless, so in this case we don't need to call
  1334. * rtc_resume(), and this is what timekeeping_rtc_skipresume()
  1335. * means.
  1336. */
  1337. bool timekeeping_rtc_skipresume(void)
  1338. {
  1339. return sleeptime_injected;
  1340. }
  1341. /**
  1342. * 1) can be determined whether to use or not only when doing
  1343. * timekeeping_resume() which is invoked after rtc_suspend(),
  1344. * so we can't skip rtc_suspend() surely if system has 1).
  1345. *
  1346. * But if system has 2), 2) will definitely be used, so in this
  1347. * case we don't need to call rtc_suspend(), and this is what
  1348. * timekeeping_rtc_skipsuspend() means.
  1349. */
  1350. bool timekeeping_rtc_skipsuspend(void)
  1351. {
  1352. return persistent_clock_exists;
  1353. }
  1354. /**
  1355. * timekeeping_inject_sleeptime64 - Adds suspend interval to timeekeeping values
  1356. * @delta: pointer to a timespec64 delta value
  1357. *
  1358. * This hook is for architectures that cannot support read_persistent_clock64
  1359. * because their RTC/persistent clock is only accessible when irqs are enabled.
  1360. * and also don't have an effective nonstop clocksource.
  1361. *
  1362. * This function should only be called by rtc_resume(), and allows
  1363. * a suspend offset to be injected into the timekeeping values.
  1364. */
  1365. void timekeeping_inject_sleeptime64(struct timespec64 *delta)
  1366. {
  1367. struct timekeeper *tk = &tk_core.timekeeper;
  1368. unsigned long flags;
  1369. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1370. write_seqcount_begin(&tk_core.seq);
  1371. timekeeping_forward_now(tk);
  1372. __timekeeping_inject_sleeptime(tk, delta);
  1373. timekeeping_update(tk, TK_CLEAR_NTP | TK_MIRROR | TK_CLOCK_WAS_SET);
  1374. write_seqcount_end(&tk_core.seq);
  1375. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1376. /* signal hrtimers about time change */
  1377. clock_was_set();
  1378. }
  1379. #endif
  1380. /**
  1381. * timekeeping_resume - Resumes the generic timekeeping subsystem.
  1382. */
  1383. void timekeeping_resume(void)
  1384. {
  1385. struct timekeeper *tk = &tk_core.timekeeper;
  1386. struct clocksource *clock = tk->tkr_mono.clock;
  1387. unsigned long flags;
  1388. struct timespec64 ts_new, ts_delta;
  1389. u64 cycle_now;
  1390. sleeptime_injected = false;
  1391. read_persistent_clock64(&ts_new);
  1392. clockevents_resume();
  1393. clocksource_resume();
  1394. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1395. write_seqcount_begin(&tk_core.seq);
  1396. /*
  1397. * After system resumes, we need to calculate the suspended time and
  1398. * compensate it for the OS time. There are 3 sources that could be
  1399. * used: Nonstop clocksource during suspend, persistent clock and rtc
  1400. * device.
  1401. *
  1402. * One specific platform may have 1 or 2 or all of them, and the
  1403. * preference will be:
  1404. * suspend-nonstop clocksource -> persistent clock -> rtc
  1405. * The less preferred source will only be tried if there is no better
  1406. * usable source. The rtc part is handled separately in rtc core code.
  1407. */
  1408. cycle_now = tk_clock_read(&tk->tkr_mono);
  1409. if ((clock->flags & CLOCK_SOURCE_SUSPEND_NONSTOP) &&
  1410. cycle_now > tk->tkr_mono.cycle_last) {
  1411. u64 nsec, cyc_delta;
  1412. cyc_delta = clocksource_delta(cycle_now, tk->tkr_mono.cycle_last,
  1413. tk->tkr_mono.mask);
  1414. nsec = mul_u64_u32_shr(cyc_delta, clock->mult, clock->shift);
  1415. ts_delta = ns_to_timespec64(nsec);
  1416. sleeptime_injected = true;
  1417. } else if (timespec64_compare(&ts_new, &timekeeping_suspend_time) > 0) {
  1418. ts_delta = timespec64_sub(ts_new, timekeeping_suspend_time);
  1419. sleeptime_injected = true;
  1420. }
  1421. if (sleeptime_injected)
  1422. __timekeeping_inject_sleeptime(tk, &ts_delta);
  1423. /* Re-base the last cycle value */
  1424. tk->tkr_mono.cycle_last = cycle_now;
  1425. tk->tkr_raw.cycle_last = cycle_now;
  1426. tk->ntp_error = 0;
  1427. timekeeping_suspended = 0;
  1428. timekeeping_update(tk, TK_MIRROR | TK_CLOCK_WAS_SET);
  1429. write_seqcount_end(&tk_core.seq);
  1430. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1431. touch_softlockup_watchdog();
  1432. tick_resume();
  1433. hrtimers_resume();
  1434. }
  1435. int timekeeping_suspend(void)
  1436. {
  1437. struct timekeeper *tk = &tk_core.timekeeper;
  1438. unsigned long flags;
  1439. struct timespec64 delta, delta_delta;
  1440. static struct timespec64 old_delta;
  1441. read_persistent_clock64(&timekeeping_suspend_time);
  1442. /*
  1443. * On some systems the persistent_clock can not be detected at
  1444. * timekeeping_init by its return value, so if we see a valid
  1445. * value returned, update the persistent_clock_exists flag.
  1446. */
  1447. if (timekeeping_suspend_time.tv_sec || timekeeping_suspend_time.tv_nsec)
  1448. persistent_clock_exists = true;
  1449. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1450. write_seqcount_begin(&tk_core.seq);
  1451. timekeeping_forward_now(tk);
  1452. timekeeping_suspended = 1;
  1453. if (persistent_clock_exists) {
  1454. /*
  1455. * To avoid drift caused by repeated suspend/resumes,
  1456. * which each can add ~1 second drift error,
  1457. * try to compensate so the difference in system time
  1458. * and persistent_clock time stays close to constant.
  1459. */
  1460. delta = timespec64_sub(tk_xtime(tk), timekeeping_suspend_time);
  1461. delta_delta = timespec64_sub(delta, old_delta);
  1462. if (abs(delta_delta.tv_sec) >= 2) {
  1463. /*
  1464. * if delta_delta is too large, assume time correction
  1465. * has occurred and set old_delta to the current delta.
  1466. */
  1467. old_delta = delta;
  1468. } else {
  1469. /* Otherwise try to adjust old_system to compensate */
  1470. timekeeping_suspend_time =
  1471. timespec64_add(timekeeping_suspend_time, delta_delta);
  1472. }
  1473. }
  1474. timekeeping_update(tk, TK_MIRROR);
  1475. halt_fast_timekeeper(tk);
  1476. write_seqcount_end(&tk_core.seq);
  1477. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1478. tick_suspend();
  1479. clocksource_suspend();
  1480. clockevents_suspend();
  1481. return 0;
  1482. }
  1483. /* sysfs resume/suspend bits for timekeeping */
  1484. static struct syscore_ops timekeeping_syscore_ops = {
  1485. .resume = timekeeping_resume,
  1486. .suspend = timekeeping_suspend,
  1487. };
  1488. static int __init timekeeping_init_ops(void)
  1489. {
  1490. register_syscore_ops(&timekeeping_syscore_ops);
  1491. return 0;
  1492. }
  1493. device_initcall(timekeeping_init_ops);
  1494. /*
  1495. * Apply a multiplier adjustment to the timekeeper
  1496. */
  1497. static __always_inline void timekeeping_apply_adjustment(struct timekeeper *tk,
  1498. s64 offset,
  1499. bool negative,
  1500. int adj_scale)
  1501. {
  1502. s64 interval = tk->cycle_interval;
  1503. s32 mult_adj = 1;
  1504. if (negative) {
  1505. mult_adj = -mult_adj;
  1506. interval = -interval;
  1507. offset = -offset;
  1508. }
  1509. mult_adj <<= adj_scale;
  1510. interval <<= adj_scale;
  1511. offset <<= adj_scale;
  1512. /*
  1513. * So the following can be confusing.
  1514. *
  1515. * To keep things simple, lets assume mult_adj == 1 for now.
  1516. *
  1517. * When mult_adj != 1, remember that the interval and offset values
  1518. * have been appropriately scaled so the math is the same.
  1519. *
  1520. * The basic idea here is that we're increasing the multiplier
  1521. * by one, this causes the xtime_interval to be incremented by
  1522. * one cycle_interval. This is because:
  1523. * xtime_interval = cycle_interval * mult
  1524. * So if mult is being incremented by one:
  1525. * xtime_interval = cycle_interval * (mult + 1)
  1526. * Its the same as:
  1527. * xtime_interval = (cycle_interval * mult) + cycle_interval
  1528. * Which can be shortened to:
  1529. * xtime_interval += cycle_interval
  1530. *
  1531. * So offset stores the non-accumulated cycles. Thus the current
  1532. * time (in shifted nanoseconds) is:
  1533. * now = (offset * adj) + xtime_nsec
  1534. * Now, even though we're adjusting the clock frequency, we have
  1535. * to keep time consistent. In other words, we can't jump back
  1536. * in time, and we also want to avoid jumping forward in time.
  1537. *
  1538. * So given the same offset value, we need the time to be the same
  1539. * both before and after the freq adjustment.
  1540. * now = (offset * adj_1) + xtime_nsec_1
  1541. * now = (offset * adj_2) + xtime_nsec_2
  1542. * So:
  1543. * (offset * adj_1) + xtime_nsec_1 =
  1544. * (offset * adj_2) + xtime_nsec_2
  1545. * And we know:
  1546. * adj_2 = adj_1 + 1
  1547. * So:
  1548. * (offset * adj_1) + xtime_nsec_1 =
  1549. * (offset * (adj_1+1)) + xtime_nsec_2
  1550. * (offset * adj_1) + xtime_nsec_1 =
  1551. * (offset * adj_1) + offset + xtime_nsec_2
  1552. * Canceling the sides:
  1553. * xtime_nsec_1 = offset + xtime_nsec_2
  1554. * Which gives us:
  1555. * xtime_nsec_2 = xtime_nsec_1 - offset
  1556. * Which simplfies to:
  1557. * xtime_nsec -= offset
  1558. *
  1559. * XXX - TODO: Doc ntp_error calculation.
  1560. */
  1561. if ((mult_adj > 0) && (tk->tkr_mono.mult + mult_adj < mult_adj)) {
  1562. /* NTP adjustment caused clocksource mult overflow */
  1563. WARN_ON_ONCE(1);
  1564. return;
  1565. }
  1566. tk->tkr_mono.mult += mult_adj;
  1567. tk->xtime_interval += interval;
  1568. tk->tkr_mono.xtime_nsec -= offset;
  1569. tk->ntp_error -= (interval - offset) << tk->ntp_error_shift;
  1570. }
  1571. /*
  1572. * Calculate the multiplier adjustment needed to match the frequency
  1573. * specified by NTP
  1574. */
  1575. static __always_inline void timekeeping_freqadjust(struct timekeeper *tk,
  1576. s64 offset)
  1577. {
  1578. s64 interval = tk->cycle_interval;
  1579. s64 xinterval = tk->xtime_interval;
  1580. u32 base = tk->tkr_mono.clock->mult;
  1581. u32 max = tk->tkr_mono.clock->maxadj;
  1582. u32 cur_adj = tk->tkr_mono.mult;
  1583. s64 tick_error;
  1584. bool negative;
  1585. u32 adj_scale;
  1586. /* Remove any current error adj from freq calculation */
  1587. if (tk->ntp_err_mult)
  1588. xinterval -= tk->cycle_interval;
  1589. tk->ntp_tick = ntp_tick_length();
  1590. /* Calculate current error per tick */
  1591. tick_error = ntp_tick_length() >> tk->ntp_error_shift;
  1592. tick_error -= (xinterval + tk->xtime_remainder);
  1593. /* Don't worry about correcting it if its small */
  1594. if (likely((tick_error >= 0) && (tick_error <= interval)))
  1595. return;
  1596. /* preserve the direction of correction */
  1597. negative = (tick_error < 0);
  1598. /* If any adjustment would pass the max, just return */
  1599. if (negative && (cur_adj - 1) <= (base - max))
  1600. return;
  1601. if (!negative && (cur_adj + 1) >= (base + max))
  1602. return;
  1603. /*
  1604. * Sort out the magnitude of the correction, but
  1605. * avoid making so large a correction that we go
  1606. * over the max adjustment.
  1607. */
  1608. adj_scale = 0;
  1609. tick_error = abs(tick_error);
  1610. while (tick_error > interval) {
  1611. u32 adj = 1 << (adj_scale + 1);
  1612. /* Check if adjustment gets us within 1 unit from the max */
  1613. if (negative && (cur_adj - adj) <= (base - max))
  1614. break;
  1615. if (!negative && (cur_adj + adj) >= (base + max))
  1616. break;
  1617. adj_scale++;
  1618. tick_error >>= 1;
  1619. }
  1620. /* scale the corrections */
  1621. timekeeping_apply_adjustment(tk, offset, negative, adj_scale);
  1622. }
  1623. /*
  1624. * Adjust the timekeeper's multiplier to the correct frequency
  1625. * and also to reduce the accumulated error value.
  1626. */
  1627. static void timekeeping_adjust(struct timekeeper *tk, s64 offset)
  1628. {
  1629. /* Correct for the current frequency error */
  1630. timekeeping_freqadjust(tk, offset);
  1631. /* Next make a small adjustment to fix any cumulative error */
  1632. if (!tk->ntp_err_mult && (tk->ntp_error > 0)) {
  1633. tk->ntp_err_mult = 1;
  1634. timekeeping_apply_adjustment(tk, offset, 0, 0);
  1635. } else if (tk->ntp_err_mult && (tk->ntp_error <= 0)) {
  1636. /* Undo any existing error adjustment */
  1637. timekeeping_apply_adjustment(tk, offset, 1, 0);
  1638. tk->ntp_err_mult = 0;
  1639. }
  1640. if (unlikely(tk->tkr_mono.clock->maxadj &&
  1641. (abs(tk->tkr_mono.mult - tk->tkr_mono.clock->mult)
  1642. > tk->tkr_mono.clock->maxadj))) {
  1643. printk_once(KERN_WARNING
  1644. "Adjusting %s more than 11%% (%ld vs %ld)\n",
  1645. tk->tkr_mono.clock->name, (long)tk->tkr_mono.mult,
  1646. (long)tk->tkr_mono.clock->mult + tk->tkr_mono.clock->maxadj);
  1647. }
  1648. /*
  1649. * It may be possible that when we entered this function, xtime_nsec
  1650. * was very small. Further, if we're slightly speeding the clocksource
  1651. * in the code above, its possible the required corrective factor to
  1652. * xtime_nsec could cause it to underflow.
  1653. *
  1654. * Now, since we already accumulated the second, cannot simply roll
  1655. * the accumulated second back, since the NTP subsystem has been
  1656. * notified via second_overflow. So instead we push xtime_nsec forward
  1657. * by the amount we underflowed, and add that amount into the error.
  1658. *
  1659. * We'll correct this error next time through this function, when
  1660. * xtime_nsec is not as small.
  1661. */
  1662. if (unlikely((s64)tk->tkr_mono.xtime_nsec < 0)) {
  1663. s64 neg = -(s64)tk->tkr_mono.xtime_nsec;
  1664. tk->tkr_mono.xtime_nsec = 0;
  1665. tk->ntp_error += neg << tk->ntp_error_shift;
  1666. }
  1667. }
  1668. /**
  1669. * accumulate_nsecs_to_secs - Accumulates nsecs into secs
  1670. *
  1671. * Helper function that accumulates the nsecs greater than a second
  1672. * from the xtime_nsec field to the xtime_secs field.
  1673. * It also calls into the NTP code to handle leapsecond processing.
  1674. *
  1675. */
  1676. static inline unsigned int accumulate_nsecs_to_secs(struct timekeeper *tk)
  1677. {
  1678. u64 nsecps = (u64)NSEC_PER_SEC << tk->tkr_mono.shift;
  1679. unsigned int clock_set = 0;
  1680. while (tk->tkr_mono.xtime_nsec >= nsecps) {
  1681. int leap;
  1682. tk->tkr_mono.xtime_nsec -= nsecps;
  1683. tk->xtime_sec++;
  1684. /* Figure out if its a leap sec and apply if needed */
  1685. leap = second_overflow(tk->xtime_sec);
  1686. if (unlikely(leap)) {
  1687. struct timespec64 ts;
  1688. tk->xtime_sec += leap;
  1689. ts.tv_sec = leap;
  1690. ts.tv_nsec = 0;
  1691. tk_set_wall_to_mono(tk,
  1692. timespec64_sub(tk->wall_to_monotonic, ts));
  1693. __timekeeping_set_tai_offset(tk, tk->tai_offset - leap);
  1694. clock_set = TK_CLOCK_WAS_SET;
  1695. }
  1696. }
  1697. return clock_set;
  1698. }
  1699. /**
  1700. * logarithmic_accumulation - shifted accumulation of cycles
  1701. *
  1702. * This functions accumulates a shifted interval of cycles into
  1703. * into a shifted interval nanoseconds. Allows for O(log) accumulation
  1704. * loop.
  1705. *
  1706. * Returns the unconsumed cycles.
  1707. */
  1708. static u64 logarithmic_accumulation(struct timekeeper *tk, u64 offset,
  1709. u32 shift, unsigned int *clock_set)
  1710. {
  1711. u64 interval = tk->cycle_interval << shift;
  1712. u64 snsec_per_sec;
  1713. /* If the offset is smaller than a shifted interval, do nothing */
  1714. if (offset < interval)
  1715. return offset;
  1716. /* Accumulate one shifted interval */
  1717. offset -= interval;
  1718. tk->tkr_mono.cycle_last += interval;
  1719. tk->tkr_raw.cycle_last += interval;
  1720. tk->tkr_mono.xtime_nsec += tk->xtime_interval << shift;
  1721. *clock_set |= accumulate_nsecs_to_secs(tk);
  1722. /* Accumulate raw time */
  1723. tk->tkr_raw.xtime_nsec += tk->raw_interval << shift;
  1724. snsec_per_sec = (u64)NSEC_PER_SEC << tk->tkr_raw.shift;
  1725. while (tk->tkr_raw.xtime_nsec >= snsec_per_sec) {
  1726. tk->tkr_raw.xtime_nsec -= snsec_per_sec;
  1727. tk->raw_sec++;
  1728. }
  1729. /* Accumulate error between NTP and clock interval */
  1730. tk->ntp_error += tk->ntp_tick << shift;
  1731. tk->ntp_error -= (tk->xtime_interval + tk->xtime_remainder) <<
  1732. (tk->ntp_error_shift + shift);
  1733. return offset;
  1734. }
  1735. /**
  1736. * update_wall_time - Uses the current clocksource to increment the wall time
  1737. *
  1738. */
  1739. void update_wall_time(void)
  1740. {
  1741. struct timekeeper *real_tk = &tk_core.timekeeper;
  1742. struct timekeeper *tk = &shadow_timekeeper;
  1743. u64 offset;
  1744. int shift = 0, maxshift;
  1745. unsigned int clock_set = 0;
  1746. unsigned long flags;
  1747. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1748. /* Make sure we're fully resumed: */
  1749. if (unlikely(timekeeping_suspended))
  1750. goto out;
  1751. #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
  1752. offset = real_tk->cycle_interval;
  1753. #else
  1754. offset = clocksource_delta(tk_clock_read(&tk->tkr_mono),
  1755. tk->tkr_mono.cycle_last, tk->tkr_mono.mask);
  1756. #endif
  1757. /* Check if there's really nothing to do */
  1758. if (offset < real_tk->cycle_interval)
  1759. goto out;
  1760. /* Do some additional sanity checking */
  1761. timekeeping_check_update(tk, offset);
  1762. /*
  1763. * With NO_HZ we may have to accumulate many cycle_intervals
  1764. * (think "ticks") worth of time at once. To do this efficiently,
  1765. * we calculate the largest doubling multiple of cycle_intervals
  1766. * that is smaller than the offset. We then accumulate that
  1767. * chunk in one go, and then try to consume the next smaller
  1768. * doubled multiple.
  1769. */
  1770. shift = ilog2(offset) - ilog2(tk->cycle_interval);
  1771. shift = max(0, shift);
  1772. /* Bound shift to one less than what overflows tick_length */
  1773. maxshift = (64 - (ilog2(ntp_tick_length())+1)) - 1;
  1774. shift = min(shift, maxshift);
  1775. while (offset >= tk->cycle_interval) {
  1776. offset = logarithmic_accumulation(tk, offset, shift,
  1777. &clock_set);
  1778. if (offset < tk->cycle_interval<<shift)
  1779. shift--;
  1780. }
  1781. /* correct the clock when NTP error is too big */
  1782. timekeeping_adjust(tk, offset);
  1783. /*
  1784. * XXX This can be killed once everyone converts
  1785. * to the new update_vsyscall.
  1786. */
  1787. old_vsyscall_fixup(tk);
  1788. /*
  1789. * Finally, make sure that after the rounding
  1790. * xtime_nsec isn't larger than NSEC_PER_SEC
  1791. */
  1792. clock_set |= accumulate_nsecs_to_secs(tk);
  1793. write_seqcount_begin(&tk_core.seq);
  1794. /*
  1795. * Update the real timekeeper.
  1796. *
  1797. * We could avoid this memcpy by switching pointers, but that
  1798. * requires changes to all other timekeeper usage sites as
  1799. * well, i.e. move the timekeeper pointer getter into the
  1800. * spinlocked/seqcount protected sections. And we trade this
  1801. * memcpy under the tk_core.seq against one before we start
  1802. * updating.
  1803. */
  1804. timekeeping_update(tk, clock_set);
  1805. memcpy(real_tk, tk, sizeof(*tk));
  1806. /* The memcpy must come last. Do not put anything here! */
  1807. write_seqcount_end(&tk_core.seq);
  1808. out:
  1809. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1810. if (clock_set)
  1811. /* Have to call _delayed version, since in irq context*/
  1812. clock_was_set_delayed();
  1813. }
  1814. /**
  1815. * getboottime64 - Return the real time of system boot.
  1816. * @ts: pointer to the timespec64 to be set
  1817. *
  1818. * Returns the wall-time of boot in a timespec64.
  1819. *
  1820. * This is based on the wall_to_monotonic offset and the total suspend
  1821. * time. Calls to settimeofday will affect the value returned (which
  1822. * basically means that however wrong your real time clock is at boot time,
  1823. * you get the right time here).
  1824. */
  1825. void getboottime64(struct timespec64 *ts)
  1826. {
  1827. struct timekeeper *tk = &tk_core.timekeeper;
  1828. ktime_t t = ktime_sub(tk->offs_real, tk->offs_boot);
  1829. *ts = ktime_to_timespec64(t);
  1830. }
  1831. EXPORT_SYMBOL_GPL(getboottime64);
  1832. unsigned long get_seconds(void)
  1833. {
  1834. struct timekeeper *tk = &tk_core.timekeeper;
  1835. return tk->xtime_sec;
  1836. }
  1837. EXPORT_SYMBOL(get_seconds);
  1838. struct timespec __current_kernel_time(void)
  1839. {
  1840. struct timekeeper *tk = &tk_core.timekeeper;
  1841. return timespec64_to_timespec(tk_xtime(tk));
  1842. }
  1843. struct timespec64 current_kernel_time64(void)
  1844. {
  1845. struct timekeeper *tk = &tk_core.timekeeper;
  1846. struct timespec64 now;
  1847. unsigned long seq;
  1848. do {
  1849. seq = read_seqcount_begin(&tk_core.seq);
  1850. now = tk_xtime(tk);
  1851. } while (read_seqcount_retry(&tk_core.seq, seq));
  1852. return now;
  1853. }
  1854. EXPORT_SYMBOL(current_kernel_time64);
  1855. struct timespec64 get_monotonic_coarse64(void)
  1856. {
  1857. struct timekeeper *tk = &tk_core.timekeeper;
  1858. struct timespec64 now, mono;
  1859. unsigned long seq;
  1860. do {
  1861. seq = read_seqcount_begin(&tk_core.seq);
  1862. now = tk_xtime(tk);
  1863. mono = tk->wall_to_monotonic;
  1864. } while (read_seqcount_retry(&tk_core.seq, seq));
  1865. set_normalized_timespec64(&now, now.tv_sec + mono.tv_sec,
  1866. now.tv_nsec + mono.tv_nsec);
  1867. return now;
  1868. }
  1869. EXPORT_SYMBOL(get_monotonic_coarse64);
  1870. /*
  1871. * Must hold jiffies_lock
  1872. */
  1873. void do_timer(unsigned long ticks)
  1874. {
  1875. jiffies_64 += ticks;
  1876. calc_global_load(ticks);
  1877. }
  1878. /**
  1879. * ktime_get_update_offsets_now - hrtimer helper
  1880. * @cwsseq: pointer to check and store the clock was set sequence number
  1881. * @offs_real: pointer to storage for monotonic -> realtime offset
  1882. * @offs_boot: pointer to storage for monotonic -> boottime offset
  1883. * @offs_tai: pointer to storage for monotonic -> clock tai offset
  1884. *
  1885. * Returns current monotonic time and updates the offsets if the
  1886. * sequence number in @cwsseq and timekeeper.clock_was_set_seq are
  1887. * different.
  1888. *
  1889. * Called from hrtimer_interrupt() or retrigger_next_event()
  1890. */
  1891. ktime_t ktime_get_update_offsets_now(unsigned int *cwsseq, ktime_t *offs_real,
  1892. ktime_t *offs_boot, ktime_t *offs_tai)
  1893. {
  1894. struct timekeeper *tk = &tk_core.timekeeper;
  1895. unsigned int seq;
  1896. ktime_t base;
  1897. u64 nsecs;
  1898. do {
  1899. seq = read_seqcount_begin(&tk_core.seq);
  1900. base = tk->tkr_mono.base;
  1901. nsecs = timekeeping_get_ns(&tk->tkr_mono);
  1902. base = ktime_add_ns(base, nsecs);
  1903. if (*cwsseq != tk->clock_was_set_seq) {
  1904. *cwsseq = tk->clock_was_set_seq;
  1905. *offs_real = tk->offs_real;
  1906. *offs_boot = tk->offs_boot;
  1907. *offs_tai = tk->offs_tai;
  1908. }
  1909. /* Handle leapsecond insertion adjustments */
  1910. if (unlikely(base >= tk->next_leap_ktime))
  1911. *offs_real = ktime_sub(tk->offs_real, ktime_set(1, 0));
  1912. } while (read_seqcount_retry(&tk_core.seq, seq));
  1913. return base;
  1914. }
  1915. /**
  1916. * do_adjtimex() - Accessor function to NTP __do_adjtimex function
  1917. */
  1918. int do_adjtimex(struct timex *txc)
  1919. {
  1920. struct timekeeper *tk = &tk_core.timekeeper;
  1921. unsigned long flags;
  1922. struct timespec64 ts;
  1923. s32 orig_tai, tai;
  1924. int ret;
  1925. /* Validate the data before disabling interrupts */
  1926. ret = ntp_validate_timex(txc);
  1927. if (ret)
  1928. return ret;
  1929. if (txc->modes & ADJ_SETOFFSET) {
  1930. struct timespec delta;
  1931. delta.tv_sec = txc->time.tv_sec;
  1932. delta.tv_nsec = txc->time.tv_usec;
  1933. if (!(txc->modes & ADJ_NANO))
  1934. delta.tv_nsec *= 1000;
  1935. ret = timekeeping_inject_offset(&delta);
  1936. if (ret)
  1937. return ret;
  1938. }
  1939. getnstimeofday64(&ts);
  1940. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1941. write_seqcount_begin(&tk_core.seq);
  1942. orig_tai = tai = tk->tai_offset;
  1943. ret = __do_adjtimex(txc, &ts, &tai);
  1944. if (tai != orig_tai) {
  1945. __timekeeping_set_tai_offset(tk, tai);
  1946. timekeeping_update(tk, TK_MIRROR | TK_CLOCK_WAS_SET);
  1947. }
  1948. tk_update_leap_state(tk);
  1949. write_seqcount_end(&tk_core.seq);
  1950. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1951. if (tai != orig_tai)
  1952. clock_was_set();
  1953. ntp_notify_cmos_timer();
  1954. return ret;
  1955. }
  1956. #ifdef CONFIG_NTP_PPS
  1957. /**
  1958. * hardpps() - Accessor function to NTP __hardpps function
  1959. */
  1960. void hardpps(const struct timespec64 *phase_ts, const struct timespec64 *raw_ts)
  1961. {
  1962. unsigned long flags;
  1963. raw_spin_lock_irqsave(&timekeeper_lock, flags);
  1964. write_seqcount_begin(&tk_core.seq);
  1965. __hardpps(phase_ts, raw_ts);
  1966. write_seqcount_end(&tk_core.seq);
  1967. raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
  1968. }
  1969. EXPORT_SYMBOL(hardpps);
  1970. #endif /* CONFIG_NTP_PPS */
  1971. /**
  1972. * xtime_update() - advances the timekeeping infrastructure
  1973. * @ticks: number of ticks, that have elapsed since the last call.
  1974. *
  1975. * Must be called with interrupts disabled.
  1976. */
  1977. void xtime_update(unsigned long ticks)
  1978. {
  1979. write_seqlock(&jiffies_lock);
  1980. do_timer(ticks);
  1981. write_sequnlock(&jiffies_lock);
  1982. update_wall_time();
  1983. }