LIBTAP=$(top_builddir)/tests/utils/tap/libtap.la
LIB_LTTNG_CTL = $(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la
-noinst_PROGRAMS = base_client notification rotation
+noinst_PROGRAMS = base_client notification rotation default_pipe_size_getter
if NO_SHARED
-CLEANFILES = libpause_consumer.so libpause_consumer.so.debug
+CLEANFILES = libpause_consumer.so libpause_consumer.so.debug libpause_sessiond.so libpause_sessiond.so.debug
EXTRA_DIST = \
base_client.c \
consumer_testpoints.c \
+ sessiond_testpoints.c \
notification.c \
test_notification_kernel_buffer_usage \
test_notification_kernel_capture \
test_notification_kernel_syscall \
test_notification_kernel_userspace_probe \
test_notification_multi_app \
+ test_notification_notifier_discarded_count \
test_notification_ust_buffer_usage \
test_notification_ust_capture \
test_notification_ust_error \
$(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la \
$(DL_LIBS)
libpause_consumer_la_LDFLAGS = $(FORCE_SHARED_LIB_OPTIONS)
-noinst_LTLIBRARIES = libpause_consumer.la
+
+libpause_sessiond_la_SOURCES = sessiond_testpoints.c
+libpause_sessiond_la_LIBADD = \
+ $(top_builddir)/src/common/libcommon.la \
+ $(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la \
+ $(DL_LIBS)
+libpause_sessiond_la_LDFLAGS = $(FORCE_SHARED_LIB_OPTIONS)
+noinst_LTLIBRARIES = libpause_sessiond.la libpause_consumer.la
base_client_SOURCES = base_client.c
base_client_LDADD = $(LIB_LTTNG_CTL)
rotation_SOURCES = rotation.c
rotation_LDADD = $(LIB_LTTNG_CTL) $(LIBTAP) -lm
+default_pipe_size_getter_SOURCES = default_pipe_size_getter.c
+default_pipe_size_getter_LDADD = $(top_builddir)/src/common/libcommon.la
+
noinst_SCRIPTS = \
test_notification_kernel_buffer_usage \
test_notification_kernel_error \
test_notification_kernel_syscall \
test_notification_kernel_userspace_probe \
test_notification_multi_app \
+ test_notification_notifier_discarded_count \
test_notification_ust_buffer_usage \
test_notification_ust_error \
test_notification_ust_event_rule_condition_exclusion \
test_notification_kernel_syscall \
test_notification_kernel_userspace_probe \
test_notification_multi_app \
+ test_notification_notifier_discarded_count \
test_notification_ust_buffer_usage \
test_notification_ust_capture \
test_notification_ust_error \
--- /dev/null
+/*
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ */
+
+#include <common/compat/getenv.h>
+#include <common/consumer/consumer.h>
+#include <common/pipe.h>
+#include <common/error.h>
+#include <unistd.h>
+#include <stdbool.h>
+#include <lttng/constant.h>
+#include <fcntl.h>
+#include <dlfcn.h>
+#include <assert.h>
+#include <stdio.h>
+
+static char *pause_pipe_path;
+static struct lttng_pipe *pause_pipe;
+static int *notifier_notif_consumption_state;;
+
+int lttng_opt_verbose;
+int lttng_opt_mi;
+int lttng_opt_quiet;
+
+static
+void __attribute__((destructor)) pause_pipe_fini(void)
+{
+ int ret;
+
+ if (pause_pipe_path) {
+ ret = unlink(pause_pipe_path);
+ if (ret) {
+ PERROR("Failed to unlink pause pipe: path = %s",
+ pause_pipe_path);
+ }
+ }
+
+ free(pause_pipe_path);
+ lttng_pipe_destroy(pause_pipe);
+}
+
+int __testpoint_sessiond_thread_notification(void);
+int __testpoint_sessiond_thread_notification(void)
+{
+ int ret = 0;
+ const char *pause_pipe_path_prefix;
+
+ pause_pipe_path_prefix = lttng_secure_getenv(
+ "NOTIFIER_PAUSE_PIPE_PATH");
+ if (!pause_pipe_path_prefix) {
+ ret = -1;
+ goto end;
+ }
+
+ notifier_notif_consumption_state = dlsym(NULL, "notifier_consumption_paused");
+ assert(notifier_notif_consumption_state);
+
+ ret = asprintf(&pause_pipe_path, "%s", pause_pipe_path_prefix);
+ if (ret < 1) {
+ ERR("Failed to allocate pause pipe path");
+ goto end;
+ }
+
+ DBG("Creating pause pipe at %s", pause_pipe_path);
+ pause_pipe = lttng_pipe_named_open(pause_pipe_path,
+ S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP, O_NONBLOCK);
+ if (!pause_pipe) {
+ ERR("Failed to create pause pipe at %s", pause_pipe_path);
+ ret = -1;
+ goto end;
+ }
+
+ /* Only the read end of the pipe is useful to us. */
+ ret = lttng_pipe_write_close(pause_pipe);
+end:
+ return ret;
+}
+
+int __testpoint_sessiond_handle_notifier_event_pipe(void);
+int __testpoint_sessiond_handle_notifier_event_pipe(void)
+{
+ int ret = 0;
+ uint8_t value;
+ bool value_read = false;
+
+ if (!pause_pipe) {
+ ret = -1;
+ goto end;
+ }
+
+ /* Purge pipe and only consider the freshest value. */
+ do {
+ ret = lttng_pipe_read(pause_pipe, &value, sizeof(value));
+ if (ret == sizeof(value)) {
+ value_read = true;
+ }
+ } while (ret == sizeof(value));
+
+ ret = (errno == EAGAIN) ? 0 : -errno;
+
+ if (value_read) {
+ *notifier_notif_consumption_state = !!value;
+ DBG("Message received on pause pipe: %s data consumption",
+ *notifier_notif_consumption_state ? "paused" : "resumed");
+ }
+end:
+ return ret;
+}
--- /dev/null
+#!/bin/bash
+#
+# Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
+#
+# SPDX-License-Identifier: LGPL-2.1-only
+
+CURDIR=$(dirname "$0")/
+TESTDIR=$CURDIR/../../../
+
+TMPDIR=$(mktemp -d)
+
+TESTAPP_PATH="$TESTDIR/utils/testapp"
+TESTAPP_NAME="gen-ust-events"
+TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
+
+TESTPOINT_BASE_PATH=$(readlink -f "$TMPDIR/lttng.t_p_n")
+TESTPOINT_PIPE_PATH=$(mktemp -u "${TESTPOINT_BASE_PATH}.XXXXXX")
+TESTPOINT=$(readlink -f "${CURDIR}/.libs/libpause_sessiond.so")
+
+SH_TAP=1
+
+# shellcheck source=../../../utils/utils.sh
+source "$TESTDIR/utils/utils.sh"
+# shellcheck source=./util_event_generator.sh
+source "$CURDIR/util_event_generator.sh"
+
+FULL_LTTNG_BIN="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
+FULL_LTTNG_SESSIOND_BIN="${TESTDIR}/../src/bin/lttng-sessiond/lttng-sessiond"
+
+UST_NUM_TESTS=16
+KERNEL_NUM_TESTS=15
+NUM_TESTS=$(($UST_NUM_TESTS + $KERNEL_NUM_TESTS))
+
+plan_tests $NUM_TESTS
+
+function test_kernel_notifier_discarded_count
+{
+ local sessiond_pipe=()
+ local trigger_name="my_trigger"
+ local list_triggers_stdout=$(mktemp -t list_triggers_stdout.XXXXXX)
+
+ # Used on sessiond launch.
+ LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
+ NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
+ LD_PRELOAD=${TESTPOINT}"
+
+ diag "Kernel event notifer error counter"
+
+ start_lttng_sessiond_notap
+
+ # This is needed since the testpoint creates a pipe with the sessiond
+ # type suffixed.
+ for f in "$TESTPOINT_BASE_PATH"*; do
+ sessiond_pipe+=("$f")
+ done
+
+ lttng_add_trigger_ok "$trigger_name" \
+ --condition on-event --kernel lttng_test_filter_event \
+ --action notify
+
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+
+ # Confirm that the discarded notification line is present.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ ok $? "No discarded tracer notification"
+
+ # Stop consumption of notifier tracer notifications.
+ echo -n 1 > $sessiond_pipe
+
+ # The notifier ring buffer configuration is currently made of 16 4096
+ # bytes subbuffers. Each kernel notification is at least 42 bytes long.
+ # To fill it, we need to generate (16 * 4096)/42 = 1561 notifications.
+ # That number is a bit larger than what we need since some of the space
+ # is lost in subbuffer boundaries.
+ echo -n "200000" > /proc/lttng-test-filter-event
+
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+
+ # Confirm that the discarded notification line is present. To avoid
+ # false positives.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded"
+ ok $? "Tracer notification discarded line printed"
+
+ # Confirm that the number of tracer notifications discarded is not zero.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ isnt $? 0 "Discarded tracer notification number non-zero as expected"
+
+ lttng_remove_trigger_ok "$trigger_name"
+
+ # Confirm that no notifier is enabled.
+ list_triggers_line_count=$("$FULL_LTTNG_BIN" list-triggers | wc -l)
+ is "$list_triggers_line_count" "0" "No \`on-event\` kernel notifier enabled as expected"
+
+ # Enable another notifier and list it to confirm the counter was cleared.
+ lttng_add_trigger_ok "$trigger_name" \
+ --condition on-event --kernel lttng_test_filter_event \
+ --action notify
+
+ # Confirm that the discarded notification line is present.
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ ok $? "No discarded tracer notification"
+
+ lttng_remove_trigger_ok "$trigger_name"
+
+ stop_lttng_sessiond_notap
+
+ unset LTTNG_SESSIOND_ENV_VARS
+
+ rm -f "$list_triggers_stdout"
+}
+
+function test_kernel_notifier_discarded_count_max_bucket
+{
+ start_lttng_sessiond "" "--event-notifier-error-number-of-bucket=3"
+
+ diag "Kernel event notifer error counter bucket limit"
+ for i in $(seq 3); do
+ lttng_add_trigger_ok "$i" \
+ --condition on-event --kernel my_event_that_doesnt_need_to_really_exist_$i \
+ --action notify
+ done
+
+ for i in $(seq 4 5); do
+ lttng_add_trigger_fail "$i" \
+ --condition on-event --kernel my_event_that_doesnt_need_to_really_exist_$i \
+ --action notify
+ done
+
+ stop_lttng_sessiond_notap
+}
+
+function test_ust_notifier_discarded_count
+{
+ local sessiond_pipe=()
+ local trigger_name="my_trigger"
+ local list_triggers_stdout=$(mktemp -t list_triggers_stdout.XXXXXX)
+ local NR_USEC_WAIT=0
+ local PIPE_SIZE
+ local NR_ITER
+
+ diag "UST event notifer error counter"
+
+ PIPE_SIZE=$("$CURDIR"/default_pipe_size_getter)
+ if [ $? -ne 0 ]; then
+ BAIL_OUT "Failed to get system default pipe size"
+ else
+ diag "Default system pipe size: $PIPE_SIZE bytes"
+ fi
+
+ # Find the number of events needed to overflow the event notification
+ # pipe buffer. Each LTTng-UST notification is at least 42 bytes long.
+ # Double that number to ensure enough events are created to overflow
+ # the buffer.
+ NR_ITER=$(( (PIPE_SIZE / 42) * 2 ))
+ diag "Test application will emit $NR_ITER events"
+
+ # Used on sessiond launch.
+ LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
+ NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
+ LD_PRELOAD=${TESTPOINT}"
+
+ start_lttng_sessiond_notap
+
+ # This is needed since the testpoint create a pipe with the sessiond
+ # type suffixed.
+ for f in "$TESTPOINT_BASE_PATH"*; do
+ sessiond_pipe+=("$f")
+ done
+
+ lttng_add_trigger_ok "$trigger_name" \
+ --condition on-event --userspace tp:tptest \
+ --action notify
+
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+
+ # Confirm that the discarded notification line is present.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ ok $? "No discarded tracer notification"
+
+ # Stop consumption of notifier tracer notifications.
+ echo -n 1 > $sessiond_pipe
+
+ $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT
+ ok $? "Generating $NR_ITER tracer notifications"
+
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+
+ # Confirm that the discarded notification line is present. To avoid
+ # false positive.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded"
+ ok $? "Tracer notification discarded line printed"
+
+ # Confirm that the number of tracer notifications discarded is not zero.
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ isnt $? 0 "Discarded tracer notification number non-zero as expected"
+
+ # Remove the notifier.
+ lttng_remove_trigger_ok "$trigger_name"
+
+ # Confirm that no notifier is enabled.
+ list_triggers_line_count=$("$FULL_LTTNG_BIN" list-triggers | wc -l)
+ is "$list_triggers_line_count" "0" "No \`on-event\` userspace notifier enabled as expected"
+
+ # Enable another notifier and list it to confirm the counter was cleared.
+ lttng_add_trigger_ok "$trigger_name" \
+ --condition on-event --userspace tp:tptest \
+ --action notify
+
+ # Confirm that the discarded notification line is present.
+ "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
+ cat "$list_triggers_stdout" | grep --quiet "tracer notifications discarded: 0"
+ ok $? "No discarded tracer notification"
+
+ lttng_remove_trigger_ok "$trigger_name"
+
+ stop_lttng_sessiond_notap
+
+ unset LTTNG_SESSIOND_ENV_VARS
+
+ rm -f "$list_triggers_stdout"
+}
+function test_ust_notifier_discarded_count_max_bucket
+{
+ start_lttng_sessiond "" "--event-notifier-error-number-of-bucket=3"
+
+ diag "UST event notifer error counter bucket limit"
+ for i in $(seq 3); do
+ lttng_add_trigger_ok "$i" \
+ --condition on-event --userspace my_event_that_doesnt_need_to_really_exist_$i \
+ --action notify
+ done
+
+ for i in $(seq 4 5); do
+ lttng_add_trigger_fail "$i" \
+ --condition on-event --userspace my_event_that_doesnt_need_to_really_exist_$i \
+ --action notify
+ done
+
+ stop_lttng_sessiond_notap
+}
+
+test_ust_notifier_discarded_count
+test_ust_notifier_discarded_count_max_bucket
+
+if [ "$(id -u)" == "0" ]; then
+
+ validate_lttng_modules_present
+
+ modprobe lttng-test
+
+ test_kernel_notifier_discarded_count
+
+ test_kernel_notifier_discarded_count_max_bucket
+
+ modprobe --remove lttng-test
+
+ rm -rf "${sessiond_pipe[@]}" 2> /dev/null
+else
+ # Kernel tests are skipped.
+ skip 0 "Root access is needed. Skipping all kernel notification tests." $KERNEL_NUM_TESTS
+fi
+
+rm -rf "$TMPDIR"
projects / lttng-tools.git / commitdiff
