Test: add UST baddr statedump test
authorAntoine Busque <abusque@efficios.com>
Mon, 3 Aug 2015 20:16:37 +0000 (16:16 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 12 Nov 2015 22:08:36 +0000 (17:08 -0500)
Signed-off-by: Antoine Busque <abusque@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
.gitignore
configure.ac
tests/regression/ust/Makefile.am
tests/regression/ust/baddr-statedump/Makefile.am [new file with mode: 0644]
tests/regression/ust/baddr-statedump/README [new file with mode: 0644]
tests/regression/ust/baddr-statedump/prog.c [new file with mode: 0644]
tests/regression/ust/baddr-statedump/test_baddr-statedump [new file with mode: 0755]
tests/regression/ust/baddr-statedump/test_baddr-statedump.py [new file with mode: 0644]
tests/regression/ust/baddr-statedump/tp.c [new file with mode: 0644]
tests/regression/ust/baddr-statedump/tp.h [new file with mode: 0644]
tests/with_bindings_regression

index 409b5d10595eaafac9c9e0e9a7951a68f7da2f31..295b696772adb373fa8378a74bc532197ed9ef3e 100644 (file)
@@ -93,6 +93,8 @@ health_check
 /tests/regression/ust/fork/fork2
 /tests/regression/ust/libc-wrapper/prog
 tests/regression/ust/python-logging/test_python_logging
+/tests/regression/ust/baddr-statedump/prog
+/tests/regression/ust/baddr-statedump/prog.debug
 /tests/utils/testapp/gen-ust-nevents/gen-ust-nevents
 /tests/utils/testapp/gen-ust-tracef/gen-ust-tracef
 /tests/regression/tools/live/live_test
index 4a0673e768535d1bc53be2c555e356cd209a8035..d7bac224d162be68f4c798b5db50182d9d09bc4b 100644 (file)
@@ -805,6 +805,7 @@ AC_CONFIG_FILES([
        tests/regression/ust/exit-fast/Makefile
        tests/regression/ust/fork/Makefile
        tests/regression/ust/libc-wrapper/Makefile
+       tests/regression/ust/baddr-statedump/Makefile
        tests/regression/ust/java-jul/Makefile
        tests/regression/ust/java-log4j/Makefile
        tests/regression/ust/python-logging/Makefile
index f2afad5eafbdb24ddd02f38b66432b87469e5e28..01404f7dcad1011f87a5464c4d096eb6adf63f9d 100644 (file)
@@ -2,7 +2,7 @@ if HAVE_LIBLTTNG_UST_CTL
 SUBDIRS = nprocesses high-throughput low-throughput before-after multi-session \
                overlap buffers-pid linking daemon exit-fast fork libc-wrapper \
                periodical-metadata-flush java-jul java-log4j python-logging \
-               getcpu-override clock-override
+               getcpu-override clock-override baddr-statedump
 
 EXTRA_DIST = test_event_basic test_event_tracef test_event_perf
 
diff --git a/tests/regression/ust/baddr-statedump/Makefile.am b/tests/regression/ust/baddr-statedump/Makefile.am
new file mode 100644 (file)
index 0000000..f45c5ae
--- /dev/null
@@ -0,0 +1,26 @@
+AM_CPPFLAGS = -I$(srcdir) -g
+
+noinst_PROGRAMS = prog
+prog_SOURCES = prog.c tp.c tp.h
+prog_LDADD = -llttng-ust -ldl
+
+noinst_SCRIPTS = test_baddr-statedump test_baddr-statedump.py
+EXTRA_DIST = test_baddr-statedump test_baddr-statedump.py
+
+all-local: prog$(EXEEXT)
+       @if [ x"$(srcdir)" != x"$(builddir)" ]; then \
+               for script in $(EXTRA_DIST); do \
+                       cp -f $(srcdir)/$$script $(builddir); \
+               done; \
+       fi
+       objcopy --only-keep-debug prog prog.debug
+       strip -g prog
+       objcopy --add-gnu-debuglink prog.debug prog
+
+clean-local:
+       @if [ x"$(srcdir)" != x"$(builddir)" ]; then \
+               for script in $(EXTRA_DIST); do \
+                       rm -f $(builddir)/$$script; \
+               done; \
+       fi
+       rm -f prog.debug
diff --git a/tests/regression/ust/baddr-statedump/README b/tests/regression/ust/baddr-statedump/README
new file mode 100644 (file)
index 0000000..bfc6f3c
--- /dev/null
@@ -0,0 +1,33 @@
+UST base address statedump test
+-------------------------------
+
+This test verifies that the tracing of base address statedump works
+properly. When an application traced with LTTng UST registers to the
+session daemon, it should produce a statedump, delimited by `start`
+and `end` events. Between those events, the base addresses of the
+executable and all the shared objects it has loaded are dumped, along
+with extra debug information such as build id or debug link if it
+exists.
+
+DESCRIPTION
+-----------
+
+The test application simply sleeps for one second to ensure the
+statedump has the time to complete fully, and defines a single
+userspace tracepoint. The statedump events should be generated when
+the application registers with the sessiond. The application is
+compiled with debug information, which is then copied into a separate
+`prog.debug` file, and a debug link section is added to the original
+`prog` executable, now stripped of debug information. This ensures
+that `lttng_ust_statedump:debug_link` event will be produced. The
+events `start`, `soinfo`, `build_id`, and `end` from the same provider
+are also expected in the trace and verified by the test.
+
+DEPENDENCIES
+------------
+
+To run this test, you will need:
+
+  - lttng-tools (with python bindings)
+  - babeltrace
+  - python 3.0 or later
diff --git a/tests/regression/ust/baddr-statedump/prog.c b/tests/regression/ust/baddr-statedump/prog.c
new file mode 100644 (file)
index 0000000..25c8957
--- /dev/null
@@ -0,0 +1,10 @@
+#include <unistd.h>
+
+#define TRACEPOINT_DEFINE
+#include "tp.h"
+
+int main()
+{
+       sleep(1);
+       return 0;
+}
diff --git a/tests/regression/ust/baddr-statedump/test_baddr-statedump b/tests/regression/ust/baddr-statedump/test_baddr-statedump
new file mode 100755 (executable)
index 0000000..1f4044a
--- /dev/null
@@ -0,0 +1,27 @@
+#!/bin/sh
+#
+# Copyright (C) - 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License, version 2 only, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+CURDIR=$(dirname $0)
+TESTDIR=${CURDIR}/../../..
+
+source $TESTDIR/utils/utils.sh
+
+start_lttng_sessiond_notap
+
+python3 ${CURDIR}/test_baddr-statedump.py
+
+stop_lttng_sessiond_notap
diff --git a/tests/regression/ust/baddr-statedump/test_baddr-statedump.py b/tests/regression/ust/baddr-statedump/test_baddr-statedump.py
new file mode 100644 (file)
index 0000000..308eff4
--- /dev/null
@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) - 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+# Copyright (C) - 2015 Antoine Busque <abusque@efficios.com>
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License, version 2 only, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+import os
+import subprocess
+import re
+import shutil
+import sys
+
+test_path = os.path.dirname(os.path.abspath(__file__)) + "/"
+test_utils_path = test_path
+for i in range(4):
+    test_utils_path = os.path.dirname(test_utils_path)
+test_utils_path = test_utils_path + "/utils"
+sys.path.append(test_utils_path)
+from test_utils import *
+
+
+NR_TESTS = 7
+current_test = 1
+print("1..{0}".format(NR_TESTS))
+
+# Check if a sessiond is running... bail out if none found.
+if session_daemon_alive() == 0:
+    bail("""No sessiond running. Please make sure you are running this test
+    with the "run" shell script and verify that the lttng tools are
+    properly installed.""")
+
+session_info = create_session()
+enable_ust_tracepoint_event(session_info, "*")
+start_session(session_info)
+
+test_process = subprocess.Popen(test_path + "prog", stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+if sys.version_info >= (3, 3):
+    try:
+        test_process.wait(5)
+    except subprocess.TimeoutExpired:
+        test_process.kill()
+        bail("Failed to run ust baddr-statedump test application.", session_info)
+else:
+    test_process.wait()
+
+print_test_result(test_process.returncode == 0, current_test, "Test application exited normally")
+current_test += 1
+
+stop_session(session_info)
+
+# Check for statedump events in the resulting trace
+try:
+    babeltrace_process = subprocess.Popen(["babeltrace", session_info.trace_path], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+except FileNotFoundError:
+    bail("Could not open babeltrace. Please make sure it is installed.", session_info)
+
+start_event_found = False
+soinfo_event_found = False
+build_id_event_found = False
+debug_link_event_found = False
+end_event_found = False
+
+for event_line in babeltrace_process.stdout:
+    # Let babeltrace finish to get the return code
+    if start_event_found and soinfo_event_found and build_id_event_found and \
+       debug_link_event_found and end_event_found:
+        continue
+
+    event_line = event_line.decode('utf-8').replace("\n", "")
+    if re.search(r".*lttng_ust_statedump:start.*", event_line) is not None:
+        start_event_found = True
+    elif re.search(r".*lttng_ust_statedump:soinfo.*", event_line) is not None:
+        soinfo_event_found = True
+    elif re.search(r".*lttng_ust_statedump:build_id.*", event_line) is not None:
+        build_id_event_found = True
+    elif re.search(r".*lttng_ust_statedump:debug_link.*", event_line) is not None:
+        debug_link_event_found = True
+    elif re.search(r".*lttng_ust_statedump:end.*", event_line) is not None:
+        end_event_found = True
+
+babeltrace_process.wait()
+
+print_test_result(babeltrace_process.returncode == 0, current_test, "Resulting trace is readable")
+current_test += 1
+
+print_test_result(start_event_found, current_test, "lttng_ust_statedump:start event found in resulting trace")
+current_test += 1
+
+print_test_result(soinfo_event_found, current_test, "lttng_ust_statedump:soinfo event found in resulting trace")
+current_test += 1
+
+print_test_result(build_id_event_found, current_test, "lttng_ust_statedump:build_id event found in resulting trace")
+current_test += 1
+
+print_test_result(debug_link_event_found, current_test, "lttng_ust_statedump:debug_link event found in resulting trace")
+current_test += 1
+
+print_test_result(end_event_found, current_test, "lttng_ust_statedump:end event found in resulting trace")
+current_test += 1
+
+shutil.rmtree(session_info.tmp_directory)
diff --git a/tests/regression/ust/baddr-statedump/tp.c b/tests/regression/ust/baddr-statedump/tp.c
new file mode 100644 (file)
index 0000000..2283f6f
--- /dev/null
@@ -0,0 +1,3 @@
+#define TRACEPOINT_CREATE_PROBES
+
+#include "tp.h"
diff --git a/tests/regression/ust/baddr-statedump/tp.h b/tests/regression/ust/baddr-statedump/tp.h
new file mode 100644 (file)
index 0000000..d0abcad
--- /dev/null
@@ -0,0 +1,27 @@
+#undef TRACEPOINT_PROVIDER
+#define TRACEPOINT_PROVIDER my_provider
+
+#undef TRACEPOINT_INCLUDE
+#define TRACEPOINT_INCLUDE "./tp.h"
+
+#if !defined(_TP_H) || defined(TRACEPOINT_HEADER_MULTI_READ)
+#define _TP_H
+
+#include <lttng/tracepoint.h>
+
+TRACEPOINT_EVENT(
+               my_provider,
+               my_first_tracepoint,
+               TP_ARGS(
+               int, my_integer_arg,
+               char*, my_string_arg
+       ),
+       TP_FIELDS(
+               ctf_string(my_string_field, my_string_arg)
+               ctf_integer(int, my_integer_field, my_integer_arg)
+       )
+)
+
+#endif /* _TP_H */
+
+#include <lttng/tracepoint-event.h>
index 5cb1903825b6b8eba824c8760d2cb233bd729651..2097e5c2095e0d619958444d9c28f9760ac7414a 100644 (file)
@@ -3,3 +3,4 @@ regression/ust/daemon/test_daemon
 regression/ust/exit-fast/test_exit-fast
 regression/ust/fork/test_fork
 regression/ust/libc-wrapper/test_libc-wrapper
+regression/ust/baddr-statedump/test_baddr-statedump
This page took 0.042272 seconds and 4 git commands to generate.