Skip to contentSkip to conversation

lib/igt_core: Add igt_exec helpers

PATCH Superseded Abdiel Janulgue 2 participants 9 messages May 29, 2017 – May 30, 2017 Library code

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/4 lib/igt_core: Add igt_exec helpers

Support executing external processes with the goal of capturing its standard streams to the igt logging infrastructure in addition to its exit status.

v2: Fix leaks on fd teardown. Make sure redirected process printout when

Quoted 1 line

64kb still works, like full dmesg. (Petri)

---
 lib/igt_core.c | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 lib/igt_core.h |  10 ++++
 2 files changed, 164 insertions(+)
lib/igt_core.c +154 -0
index 9c3b37f..c2c8872 100644
@@ -2099,3 +2099,157 @@ FILE *__igt_fopen_data(const char* igt_srcdir, const char* igt_datadir,
 
 	return fp;
 }
+
+struct output_pipe {
+	int output_fd;
+	int save_fd;
+	int read_fd;
+	int write_fd;
+	bool redirected;
+	enum igt_log_level log_level;
+};
+
+static bool redirect_output(struct output_pipe *p, int output_fd,
+			    enum igt_log_level level)
+{
+	int fds[2];
+
+	if (pipe(fds) == -1)
+		goto err;
+
+	/* save output */
+	if ((p->save_fd = dup(output_fd)) == -1)
+		goto err;
+
+	/* Redirect output to our buffer */
+	if (dup2(fds[1], output_fd) == -1)
+		goto err;
+
+	p->output_fd = output_fd;
+	p->read_fd = fds[0];
+	p->write_fd = fds[1];
+	p->redirected = true;
+	p->log_level = level;
+
+	return true;
+err:
+	close(fds[0]);
+	close(fds[1]);
+	close(p->save_fd);
+
+	return false;
+}
+
+static void unredirect_output(struct output_pipe *p)
+{
+	if (!p->redirected)
+		return;
+
+	/* read_fd is closed separately. We still need to read its
+	 * buffered contents after un-redirecting the stream.
+	 */
+	close(p->write_fd);
+	dup2(p->save_fd, p->output_fd);
+	close(p->save_fd);
+	p->redirected = false;
+}
+
+/**
+ * igt_exec:
+ *
+ * Executes the shell command specified in @command and capture its stdout and
+ * stderr to igt_log or igt_warn respectively.
+ *
+ * Returns: The exit status of the executed process. -1 for failure.
+ */
+int igt_exec(const char *command)
+{
+#define OUT 0
+#define ERR 1
+	struct output_pipe op[2];
+	int i, status;
+	struct igt_helper_process process = {};
+	char buf[PIPE_BUF];
+
+	if (!redirect_output(&op[OUT], STDOUT_FILENO, IGT_LOG_INFO))
+		goto err;
+	if (!redirect_output(&op[ERR], STDERR_FILENO, IGT_LOG_WARN))
+		goto err;
+
+	igt_fork_helper(&process) {
+		igt_assert(execl("/bin/sh", "sh", "-c", command,
+				 (char *) NULL) != -1);
+	}
+
+	for (i = 0; i < ARRAY_SIZE(op); i++) {
+		struct output_pipe *current = &op[i];
+
+		/* Unredirect so igt_log() works */
+		unredirect_output(current);
+		memset(buf, 0, sizeof(buf));
+		while (read(current->read_fd, buf, sizeof(buf)) > 0) {
+			igt_log(IGT_LOG_DOMAIN, current->log_level,
+				"[cmd] %s", buf);
+			memset(buf, 0, sizeof(buf));
+		}
+		close(current->read_fd);
+	}
+	status = igt_wait_helper(&process);
+
+	return WEXITSTATUS(status);
+err:
+	/* Failed to redirect one or both streams. Roll back changes. */
+	for (i = 0; i < ARRAY_SIZE(op); i++) {
+		if (!op[i].redirected)
+			continue;
+		close(op[i].read_fd);
+		unredirect_output(&op[i]);
+	}
+
+	return -1;
+}
+
+/**
+ * igt_exec_quiet:
+ * Similar to igt_exec(), except redirect output to /dev/null
+ *
+ * Returns: The exit status of the executed process. -1 for failure.
+ */
+int igt_exec_quiet(const char *command)
+{
+	int stderr_fd_copy, stdout_fd_copy, status, nullfd;
+
+	/* redirect */
+	if ((nullfd = open("/dev/null", O_WRONLY)) == -1)
+		goto err;
+	if ((stdout_fd_copy = dup(STDOUT_FILENO)) == -1)
+		goto err;
+	if ((stderr_fd_copy = dup(STDERR_FILENO)) == -1)
+		goto err;
+
+	if (dup2(nullfd, STDOUT_FILENO) == -1)
+		goto err;
+	if (dup2(nullfd, STDERR_FILENO) == -1)
+		goto err;
+
+	if ((status = system(command)) == -1)
+		goto err;
+
+	/* restore */
+	if (dup2(stdout_fd_copy, STDOUT_FILENO) == -1)
+		goto err;
+	if (dup2(stderr_fd_copy, STDERR_FILENO) == -1)
+		goto err;
+
+	close(stdout_fd_copy);
+	close(stderr_fd_copy);
+	close(nullfd);
+
+	return WEXITSTATUS(status);
+err:
+	close(stderr_fd_copy);
+	close(stdout_fd_copy);
+	close(nullfd);
+
+	return -1;
+}
lib/igt_core.h +10 -0
index 4a125af..c41aa1a 100644
@@ -919,4 +919,14 @@ FILE *__igt_fopen_data(const char* igt_srcdir, const char* igt_datadir,
 #define igt_fopen_data(filename) \
 	__igt_fopen_data(IGT_SRCDIR, IGT_DATADIR, filename)
 
+int igt_exec(const char *command);
+int igt_exec_quiet(const char *command);
+#define igt_exec_cmd(status, format...) \
+	do { \
+		char *buf = 0; \
+		igt_assert(asprintf(&buf, format) != -1); \
+	        status = igt_exec(buf); \
+		free(buf); \
+	} while (0)
+
 #endif /* IGT_CORE_H */
Signature · 6 lines
2.7.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#1 lore raw

PATCH v2 2/4 igt/igt_core: Provide an option to check for the log buffer contents

---
 lib/igt_core.c | 24 ++++++++++++++++++++++++
 lib/igt_core.h |  3 +++
 2 files changed, 27 insertions(+)
lib/igt_core.c +24 -0
index c2c8872..81d2039 100644
@@ -329,6 +329,30 @@ static void _igt_log_buffer_dump(void)
 	pthread_mutex_unlock(&log_buffer_mutex);
 }
 
+/**
+ * igt_log_buffer_inspect:
+ *
+ * Provides a way to replay the internal igt log buffer for inspection.
+ * @check: A user-specified handler that gets invoked for each line of
+           the log buffer. The handler should return true to stop
+           inspecting the rest of the buffer.
+ * @data: passed as a user argument to the inspection function.
+ */
+void igt_log_buffer_inspect(igt_buffer_log_handler_t check, void *data)
+{
+	uint8_t i;
+	pthread_mutex_lock(&log_buffer_mutex);
+
+	i = log_buffer.start;
+	do {
+		if (check(log_buffer.entries[i], data))
+			break;
+		i++;
+	} while (i != log_buffer.start && i != log_buffer.end);
+
+	pthread_mutex_unlock(&log_buffer_mutex);
+}
+
 __attribute__((format(printf, 1, 2)))
 static void kmsg(const char *format, ...)
 #define KERN_EMER	"<0>"
lib/igt_core.h +3 -0
index c41aa1a..93f61d8 100644
@@ -818,6 +818,9 @@ void igt_vlog(const char *domain, enum igt_log_level level, const char *format,
  */
 #define igt_critical(f...) igt_log(IGT_LOG_DOMAIN, IGT_LOG_CRITICAL, f)
 
+typedef bool (*igt_buffer_log_handler_t)(const char *line, void *data);
+void igt_log_buffer_inspect(igt_buffer_log_handler_t check, void *data);
+
 extern enum igt_log_level igt_log_level;
 
 /**
Signature · 6 lines
2.7.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#2 lore raw

PATCH v2 3/4 Convert shell script tests to C version

In reply to Abdiel Janulgue

v2: Use internal igt_debugfs functions instead of cat and document
debugfs tests.
Convert sysfs_l3_parity properly.
Rename redundant names in tests.

Converted:
- check_drm_clients (ensures no other clients are running. functionality provided by drm_open_driver_master).
- debugfs_emon_crash
- debugfs_wedged
- drv_debugfs_reader
- sysfs_l3_parity
- test_rte_check (same as check_drm_clients)
- tools_test
- ZZ_check_dmesg

---
 tests/Makefile.sources   |   9 +---
 tests/ZZ_check_dmesg     |  11 -----
 tests/check_drm_clients  |   6 ---
 tests/debugfs.c          |  97 ++++++++++++++++++++++++++++++++++++
 tests/debugfs_emon_crash |  16 ------
 tests/debugfs_wedged     |  10 ----
 tests/drv_debugfs_reader |   9 ----
 tests/sysfs_l3_parity    |  22 ---------
 tests/test_rte_check     |   6 ---
 tests/tools.c            | 125 +++++++++++++++++++++++++++++++++++++++++++++++
 tests/tools_test         |  16 ------
 11 files changed, 224 insertions(+), 103 deletions(-)
 delete mode 100755 tests/ZZ_check_dmesg
 delete mode 100755 tests/check_drm_clients
 create mode 100644 tests/debugfs.c
 delete mode 100755 tests/debugfs_emon_crash
 delete mode 100755 tests/debugfs_wedged
 delete mode 100755 tests/drv_debugfs_reader
 delete mode 100755 tests/sysfs_l3_parity
 delete mode 100755 tests/test_rte_check
 create mode 100644 tests/tools.c
 delete mode 100755 tests/tools_test
tests/Makefile.sources +2 -7
index 9553e4d..c4a78a9 100644
@@ -243,6 +243,8 @@ TESTS_progs = \
 	drv_module_reload \
 	kms_sysfs_edid_timing \
 	perf \
+	debugfs \
+	tools \
 	$(NULL)
 
 # IMPORTANT: The ZZ_ tests need to be run last!
@@ -251,11 +253,6 @@ TESTS_scripts_M = \
 	$(NULL)
 
 TESTS_scripts = \
-	debugfs_emon_crash \
-	drv_debugfs_reader \
-	sysfs_l3_parity \
-	test_rte_check \
-	tools_test \
 	$(NULL)
 
 # This target contains testcases which support automagic subtest enumeration
@@ -317,9 +314,7 @@ HANG = \
 	$(NULL)
 
 scripts = \
-	check_drm_clients \
 	ddx_intel_after_fbdev \
-	debugfs_wedged \
 	drm_lib.sh \
 	drm_getopt.sh \
 	$(NULL)
tests/ZZ_check_dmesg deleted +0 -11
deleted file mode 100755
index e28ba35..0000000
@@ -1,11 +0,0 @@
-#!/bin/sh
-
-if dmesg | grep '\*ERROR\*'  > /dev/null ; then
-	echo "DRM_ERROR dirt in dmesg"
-	exit 1
-fi
-
-if dmesg | grep -- '------\[ cut here \]----' > /dev/null  ; then
-	echo "found a backtrace in dmesg"
-	exit 1
-fi
tests/check_drm_clients deleted +0 -6
deleted file mode 100755
index 2a891b8..0000000
@@ -1,6 +0,0 @@
-#!/bin/bash
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-exit $IGT_EXIT_SUCCESS
tests/debugfs.c new file +97 -0

97 lines not on this page · raw message

tests/debugfs_emon_crash deleted +0 -16
deleted file mode 100755
index 1dbfcb2..0000000
@@ -1,16 +0,0 @@
-#!/bin/bash
-#
-# This check if we can crash the kernel with segmentation-fault
-# by reading /sys/kernel/debug/dri/0/i915_emon_status too quickly
-#
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-for z in $(seq 1 1000); do
-	cat $i915_dfs_path/i915_emon_status > /dev/null 2&>1
-done
-
-# If we got here, we haven't crashed
-
-exit $IGT_EXIT_SUCCESS
tests/debugfs_wedged deleted +0 -10
deleted file mode 100755
index f15ac46..0000000
@@ -1,10 +0,0 @@
-#!/bin/bash
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-# Testcase: wedge the hw to check the error_state reading
-# 
-# Unfortunately wedged is permanent, so this test is not run by default
-echo 1 > ${i915_dfs_path}/i915_wedged
-cat $i915_dfs_path/i915_error_state > /dev/null 2>&1
tests/drv_debugfs_reader deleted +0 -9
deleted file mode 100755
index 6ea4e64..0000000
@@ -1,9 +0,0 @@
-#!/bin/bash
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-# read everything we can
-cat $i915_dfs_path/* > /dev/null 2>&1
-
-exit $IGT_EXIT_SUCCESS
tests/sysfs_l3_parity deleted +0 -22
deleted file mode 100755
index d5f3284..0000000
@@ -1,22 +0,0 @@
-#!/bin/bash
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-$SOURCE_DIR/../tools/intel_l3_parity -r 0 -b 0 -s 0 -e || exit $?
-
-#Check that we can remap a row
-$SOURCE_DIR/../tools/intel_l3_parity -r 0 -b 0 -s 0 -d
-disabled=`$SOURCE_DIR/../tools/intel_l3_parity -l | grep -c 'Row 0, Bank 0, Subbank 0 is disabled'`
-if [ "$disabled" != "1" ] ; then
-	echo "Fail"
-	exit $IGT_EXIT_FAILURE
-fi
-
-$SOURCE_DIR/../tools/intel_l3_parity -r 0 -b 0 -s 0 -e
-
-#Check that we can clear remaps
-if [ `$SOURCE_DIR/../tools/intel_l3_parity -l | wc -l` != 1 ] ; then
-	echo "Fail 2"
-	exit $IGT_EXIT_FAILURE
-fi
tests/test_rte_check deleted +0 -6
deleted file mode 100755
index 2a891b8..0000000
@@ -1,6 +0,0 @@
-#!/bin/bash
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-exit $IGT_EXIT_SUCCESS
tests/tools.c new file +125 -0

125 lines not on this page · raw message

tests/tools_test deleted +0 -16
deleted file mode 100755
index a27fb87..0000000
@@ -1,16 +0,0 @@
-#!/bin/bash
-# Test some of the most critical tools we have accidentally broken before.
-# TODO: Possibly make tests parse output
-
-SOURCE_DIR="$( dirname "${BASH_SOURCE[0]}" )"
-. $SOURCE_DIR/drm_lib.sh
-
-# ARB_MODE has existed for many gens
-PATH=$SOURCE_DIR/../tools:$PATH
-do_or_die "intel_reg read 0x4030"
-do_or_die "intel_reg dump"
-
-# TODO: Add more tests
-
-exit $IGT_EXIT_SUCCESS
-
Signature · 6 lines
2.7.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#3 lore raw

Re: [i-g-t PATCH v2 3/4] Convert shell script tests to C version

Quoted 39 lines · Abdiel Janulgue
tests/debugfs.c new file +33 -0
new file mode 100644
index 0000000..fb33f9f
@@ -0,0 +1,97 @@
+/*
+ * Copyright © 2017 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "igt.h"
+#include "igt_sysfs.h"
+#include <fcntl.h>
+#include <sys/types.h>
+#include <dirent.h>
+
+igt_main
+{

tests/debugfs.c line 43

Quoted 10 lines
tests/debugfs.c new file +10 -0
+	int fd = -1, debugfs;
+	igt_skip_on_simulation();
+
+	igt_fixture {
+		fd = drm_open_driver_master(DRIVER_INTEL);
+		igt_require_gem(fd);
+		debugfs = igt_debugfs_dir(fd);
+	}
+
+	igt_subtest_group {

What's the group for? It's very lonely.

tests/debugfs.c line 55

Quoted 12 lines
tests/debugfs.c new file +12 -0
+		igt_subtest("emon_crash") {
+			int i;
+			/*
+			 * This check if we can crash the kernel with
+			 * segmentation-fault by reading
+			 * /sys/kernel/debug/dri/0/i915_emon_status too quickly
+			 */
+			for (i = 0; i < 1; i++) {
+				char *buf = igt_sysfs_get(debugfs,
+							  "i915_emon_status");
+				free(buf);
+			}

This is covered by the later test to read it once. And if frequent rereads is a trigger, apply it to all.

Quoted 14 lines
tests/debugfs.c new file +14 -0
+
+			/* If we got here, we haven't crashed */
+			igt_success();
+		}
+
+		igt_subtest("wedged") {
+			char *error;
+			int dev;
+
+			/* wedge the hw to check the error_state reading */
+			igt_sysfs_write(debugfs, "i915_error_state", "", 1);
+
+			dev = igt_debugfs_open(fd, "i915_wedged", O_WRONLY);
+			igt_ignore_warn(write(dev, "1\n", 2));

tests/debugfs.c line 79

Quoted 10 lines
tests/debugfs.c new file +10 -0
+			close(dev);
+			/*
+			 * Reading i915_error_state file explodes on a
+			 * broken kernel
+			 */
+			error = igt_sysfs_get(debugfs, "i915_error_state");
+			igt_assert(error);
+			free(error);
+			/* If we got here, we haven't crashed */
+			igt_success();

This is drv_hangman/basic.

tests/debugfs.c line 91

Quoted 12 lines
tests/debugfs.c new file +12 -0
+		}
+
+		igt_subtest("drv_reader") {
+			struct dirent *dirent;
+			DIR *dir;
+
+			igt_assert((dir = fdopendir(debugfs)) != NULL);
+			while ((dirent = readdir(dir))) {
+				char *buf = igt_sysfs_get(debugfs, dirent->d_name);
+				free(buf);
+			}
+		}

Needs to descend through the debugfs directory.
-Chris

Signature · 5 lines
Chris Wilson, Intel Open Source Technology Centre
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#4 lore raw

PATCH v2 4/4 Convert ddx_intel_after_fbdev to C.

In reply to Abdiel Janulgue

v2: Use igt_exec_cmd macro.

---
 tests/Makefile.sources        |   1 +
 tests/ddx_intel_after_fbdev   |  73 ---------------------------
 tests/ddx_intel_after_fbdev.c | 113 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 114 insertions(+), 73 deletions(-)
 delete mode 100755 tests/ddx_intel_after_fbdev
 create mode 100644 tests/ddx_intel_after_fbdev.c
tests/Makefile.sources +1 -0
index c4a78a9..8068257 100644
@@ -245,6 +245,7 @@ TESTS_progs = \
 	perf \
 	debugfs \
 	tools \
+	ddx_intel_after_fbdev \
 	$(NULL)
 
 # IMPORTANT: The ZZ_ tests need to be run last!
tests/ddx_intel_after_fbdev deleted +0 -73

73 lines not on this page · raw message

tests/ddx_intel_after_fbdev.c new file +113 -0

113 lines not on this page · raw message

Signature · 6 lines
2.7.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#5 lore raw

Re: [i-g-t PATCH v2 4/4] Convert ddx_intel_after_fbdev to C.

Quoted 1 line · Abdiel Janulgue

v2: Use igt_exec_cmd macro.

What benefit does this give us? You are not writing it in C using the system libraries, you are just badly rewriting the shell script as snippets pass to shell from C.
-Chris

Signature · 5 lines
Chris Wilson, Intel Open Source Technology Centre
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#6 lore raw
In reply to Abdiel Janulgue
Quoted 3 lines · Abdiel Janulgue

Support executing external processes with the goal of capturing its standard streams to the igt logging infrastructure in addition to its exit status.

This is not an exec wrapper. This is a system() replacement. That it invokes shell to evaluate the cmd should be front and centre. -Chris

Signature · 5 lines
Chris Wilson, Intel Open Source Technology Centre
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#7 lore raw
Quoted 9 lines · Chris Wilson
Quoted 3 lines · Abdiel Janulgue

Support executing external processes with the goal of capturing its standard streams to the igt logging infrastructure in addition to its exit status.

This is not an exec wrapper. This is a system() replacement. That it invokes shell to evaluate the cmd should be front and centre. -Chris

The problem with system() is that it waits until the process is completed. If the process' output is more than PIPE_BUF, it'll block. Do you have any suggestions?
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

#8 lore raw
Quoted 8 lines · Abdiel Janulgue
Quoted 5 lines · Chris Wilson
Quoted 3 lines · Abdiel Janulgue

Support executing external processes with the goal of capturing its standard streams to the igt logging infrastructure in addition to its exit status.

Quoted 7 lines
Quoted 3 lines

This is not an exec wrapper. This is a system() replacement. That it invokes shell to evaluate the cmd should be front and centre.

The problem with system() is that it waits until the process is completed. If the process' output is more than PIPE_BUF, it'll block. Do you have any suggestions?

I'm just saying the name is misleading. igt_system() and explain the improvements (concurrency and accessible piped output). -Chris

Signature · 5 lines
Chris Wilson, Intel Open Source Technology Centre
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx