#!/bin/bash
#
# Copyright (C) 2013 Christian Babeux <christian.babeux@efficios.com>
# Copyright (C) 2014, 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
#
# SPDX-License-Identifier: GPL-2.0-only
#

TEST_DESC="Kernel tracer - Clock override plugin"

CURDIR=$(dirname "$0")/
TESTDIR=$CURDIR/../..
SESSION_NAME="clock_override"

NUM_TESTS=30
EVENT_NAME="lttng_test_filter_event"

TESTCMD="echo -n 10 > /proc/lttng-test-filter-event"

source $TESTDIR/utils/utils.sh

if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then
	NUM_TESTS=30
elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then
	NUM_TESTS=28
fi

function signal_cleanup()
{
	diag "*** Exiting ***"
	stop_lttng_sessiond
	modprobe --remove lttng-test lttng-clock-plugin-test lttng-clock
	full_cleanup
}

function extract_clock_metadata_ctf1()
{
	local metadata_clock_start_token="clock {"
	local metadata_clock_end_token="};"

	local metadata_file=$1
	local clock_metadata_file_destination=$2

	sed -n "/$metadata_clock_start_token/,/$metadata_clock_end_token/p" "$metadata_file" > "$clock_metadata_file_destination"
	ok $? "Clock metadata extraction"
}

function extract_clock_metadata_token_ctf1()
{
	local clock_metadata_file=$1
	local token=$2
	# Look for token and get value between ""
	grep "$token" "$clock_metadata_file" | awk -F"= |;" '{print $2}' | tr -d '"'
}

function validate_tokens_ctf1
{

	local metadata_token_list=(
		"name"
		"uuid"
		"description"
		"freq"
	)

	local ust_clock_token_value=(
		"lttng_test_clock_override"
		"83c63deb-7aa4-48fb-abda-946f400d76e6"
		"Freeze time with 1KHz for regression test"
		"1000"
	)

	local metadata_directory_path=$1
	local ctf_metadata_file
	local clock_metadata_file

	test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]}
	ok $? "Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal"


	clock_metadata_file=$(mktemp --tmpdir -p "$TRACE_PATH" clock-metadata.XXXXXX)
	ctf_metadata_file=$(mktemp --tmpdir -p "$TRACE_PATH" ctf-metadata.XXXXXX)

	$BABELTRACE_BIN -o ctf-metadata -w "$ctf_metadata_file" "$metadata_directory_path"
	ok $? "Metadata extraction from babeltrace"

	extract_clock_metadata_ctf1 "$ctf_metadata_file" "$clock_metadata_file"

	local counter=0
	while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do
		result=$(extract_clock_metadata_token_ctf1 "$clock_metadata_file" \
			"${metadata_token_list[$counter]}")
		test "$result" == "${ust_clock_token_value[$counter]}"
		ok $? "Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result"
		(( counter++ ))
	done

	rm -rf "$ctf_metadata_file"
	rm -rf "$clock_metadata_file"
}

function validate_tokens_ctf2
{
	local metadata_token_list=(
		"name"
		"uuid"
		"description"
		"frequency"
	)

	local ust_clock_token_value=(
		"lttng_test_clock_override"
		"[131,198,61,235,122,164,72,251,171,218,148,111,64,13,118,230]"
		"Freeze time with 1KHz for regression test"
		"1000"
	)

	test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]}
	ok $? "Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal"

	local metadata_path=$1

	local counter=0
	while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do
		result=$(jq  -c -r "select(.type == \"clock-class\").${metadata_token_list[$counter]}" "$metadata_path")
		test "$result" == "${ust_clock_token_value[$counter]}"
		ok $? "Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result"
		(( counter++ ))
	done

}

function test_clock_override_metadata()
{
	local trace_metadata_file_path
	local trace_metadata_dir

	diag "Clock override plugin metadata test"

	modprobe lttng-clock-plugin-test
	start_lttng_sessiond
	modprobe lttng-test

	create_lttng_session_ok $SESSION_NAME "$TRACE_PATH"
	enable_kernel_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
	start_lttng_tracing_ok $SESSION_NAME
	eval "${TESTCMD}"
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	stop_lttng_sessiond
	modprobe --remove lttng-test lttng-clock-plugin-test lttng-clock

	trace_metadata_file_path="$(find "$TRACE_PATH" -name metadata -type f)"
	trace_metadata_dir="$(dirname "$trace_metadata_file_path")"

	if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then
		validate_tokens_ctf1 "$trace_metadata_dir"
	elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then
		validate_tokens_ctf2 "$trace_metadata_file_path"
	fi
}

function test_clock_override_timestamp()
{
	diag "Clock override test"

	# Test without the plugin
	diag "Plugin disabled"

	start_lttng_sessiond
	modprobe lttng-test

	create_lttng_session_ok $SESSION_NAME "$TRACE_PATH"
	enable_kernel_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
	start_lttng_tracing_ok $SESSION_NAME
	eval "${TESTCMD}"
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Use Babeltrace with "-n all" to give a comma separated list for
	# easy extraction of timestamps.
	unique_timestamps_count=$($BABELTRACE_BIN -n all "$TRACE_PATH" | \
		cut -d, -f1 | uniq | wc -l)
	test "$unique_timestamps_count" -gt 1
	ok $? "Unique event timestamps without clock override: $unique_timestamps_count expect >1"
	modprobe --remove lttng-test
	stop_lttng_sessiond

	# Test with clock override plugin.
	diag "Plugin enabled"

	modprobe lttng-clock-plugin-test
	start_lttng_sessiond
	modprobe lttng-test

	start_lttng_sessiond
	create_lttng_session_ok $SESSION_NAME "$TRACE_PATH"
	enable_kernel_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
	start_lttng_tracing_ok $SESSION_NAME
	eval "${TESTCMD}"
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	stop_lttng_sessiond
	modprobe --remove lttng-test lttng-clock-plugin-test lttng-clock

	# Use Babeltrace with "-n all" to give a comma separated list for
	# easy extraction of timestamps.
	unique_timestamps_count=$($BABELTRACE_BIN -n all "$TRACE_PATH" | \
		cut -d, -f1 | uniq | wc -l)
	test "$unique_timestamps_count" -eq 1
	ok $? "Unique event timestamps with clock override: $unique_timestamps_count expect 1"
}

# MUST set TESTDIR before calling those functions
plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

bail_out_if_no_babeltrace

TESTS=(
	"test_clock_override_metadata"
	"test_clock_override_timestamp"
)

TEST_COUNT=${#TESTS[@]}
i=0

if [ "$(id -u)" == "0" ]; then
	isroot=1
else
	isroot=0
fi

skip $isroot "Root access is needed. Skipping all tests." $NUM_TESTS ||
{
	validate_lttng_modules_present
	trap signal_cleanup SIGTERM SIGINT

	while [ "$i" -lt "$TEST_COUNT" ]; do

		TRACE_PATH=$(mktemp --tmpdir -d tmp.test_clock_override_trace_path.XXXXXX)

		# Execute test
		${TESTS[$i]}

		rm -rf $TRACE_PATH

		let "i++"
	done
}