[lttng-ust.git] / doc / examples / clock-override / README.md

<!--
SPDX-FileCopyrightText: 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

SPDX-License-Identifier: CC-BY-4.0
-->

This clock override example shows how to implement and load a clock
override plugin for LTTng-UST. This can be useful in cases where direct
hardware access is available for architecture-specific clocks, and where
it should be used rather than the Linux kernel Monotonic clock.

When using LTTng-tools keep in mind that lttng-sessiond uses lttng-ust's clock
definition and functions. Thus `LTTNG_UST_CLOCK_PLUGIN` needs to be defined
when launching lttng-sessiond.
Commit	Line	Data
53f7d0d7 MJ	1	<!--
	2	SPDX-FileCopyrightText: 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	3
	4	SPDX-License-Identifier: CC-BY-4.0
	5	-->
	6
f9364363 MD	7	This clock override example shows how to implement and load a clock
	8	override plugin for LTTng-UST. This can be useful in cases where direct
	9	hardware access is available for architecture-specific clocks, and where
	10	it should be used rather than the Linux kernel Monotonic clock.
9493af14 JR	11
9493af14 JR	12	When using LTTng-tools keep in mind that lttng-sessiond uses lttng-ust's clock
53f7d0d7 MJ	13	definition and functions. Thus `LTTNG_UST_CLOCK_PLUGIN` needs to be defined
53f7d0d7 MJ	14	when launching lttng-sessiond.