Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

trace: Update documentation for mono, mono_raw and boot clock

Documentation was missing for mono and mono_raw, add them and also for
the boot clock introduced in this series.

Signed-off-by: Joel Fernandes <joelaf@google.com>
Signed-off-by: John Stultz <john.stultz@linaro.org>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Acked-by: Steven Rostedt <rostedt@goodmis.org>
Cc: Prarit Bhargava <prarit@redhat.com>
Cc: Richard Cochran <richardcochran@gmail.com>
Link: http://lkml.kernel.org/r/1480372524-15181-8-git-send-email-john.stultz@linaro.org
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>

authored by

Joel Fernandes and committed by
Thomas Gleixner
2924ecd4 80ec3552

+20
+20
Documentation/trace/ftrace.txt
··· 362 362 to correlate events across hypervisor/guest if 363 363 tb_offset is known. 364 364 365 + mono: This uses the fast monotonic clock (CLOCK_MONOTONIC) 366 + which is monotonic and is subject to NTP rate adjustments. 367 + 368 + mono_raw: 369 + This is the raw monotonic clock (CLOCK_MONOTONIC_RAW) 370 + which is montonic but is not subject to any rate adjustments 371 + and ticks at the same rate as the hardware clocksource. 372 + 373 + boot: This is the boot clock (CLOCK_BOOTTIME) and is based on the 374 + fast monotonic clock, but also accounts for time spent in 375 + suspend. Since the clock access is designed for use in 376 + tracing in the suspend path, some side effects are possible 377 + if clock is accessed after the suspend time is accounted before 378 + the fast mono clock is updated. In this case, the clock update 379 + appears to happen slightly sooner than it normally would have. 380 + Also on 32-bit systems, it's possible that the 64-bit boot offset 381 + sees a partial update. These effects are rare and post 382 + processing should be able to handle them. See comments in the 383 + ktime_get_boot_fast_ns() function for more information. 384 + 365 385 To set a clock, simply echo the clock name into this file. 366 386 367 387 echo global > trace_clock