tracing: Add documentation for trace clock tai
authorKurt Kanzenbach <kurt@linutronix.de>
Thu, 14 Apr 2022 09:18:05 +0000 (11:18 +0200)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Wed, 27 Apr 2022 21:19:30 +0000 (17:19 -0400)
Add documentation for newly introduced trace clock "tai".
This clock corresponds to CLOCK_TAI.

Link: https://lkml.kernel.org/r/20220414091805.89667-4-kurt@linutronix.de
Signed-off-by: Kurt Kanzenbach <kurt@linutronix.de>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Documentation/trace/ftrace.rst

index 45b8c56af67a74230cea7ed1a9c7eeccf558c436..b37dc19e4d40950fb46d9016cb99f4b905271580 100644 (file)
@@ -517,6 +517,18 @@ of ftrace. Here is a list of some of the key files:
                processing should be able to handle them. See comments in the
                ktime_get_boot_fast_ns() function for more information.
 
+       tai:
+               This is the tai clock (CLOCK_TAI) and is derived from the wall-
+               clock time. However, this clock does not experience
+               discontinuities and backwards jumps caused by NTP inserting leap
+               seconds. Since the clock access is designed for use in tracing,
+               side effects are possible. The clock access may yield wrong
+               readouts in case the internal TAI offset is updated e.g., caused
+               by setting the system time or using adjtimex() with an offset.
+               These effects are rare and post processing should be able to
+               handle them. See comments in the ktime_get_tai_fast_ns()
+               function for more information.
+
        To set a clock, simply echo the clock name into this file::
 
          # echo global > trace_clock