igt_core.c 35 KB
Newer Older
Daniel Vetter's avatar
Daniel Vetter committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*
 * Copyright © 2007, 2011, 2013, 2014 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.
 *
 * Authors:
 *    Eric Anholt <eric@anholt.net>
 *    Daniel Vetter <daniel.vetter@ffwll.ch>
 *
 */

#ifndef ANDROID
#define _GNU_SOURCE
#else
#include <libgen.h>
#endif
#include <stdio.h>
35
#include <assert.h>
Daniel Vetter's avatar
Daniel Vetter committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <string.h>
#include <sys/mman.h>
#include <signal.h>
#include <pciaccess.h>
#include <getopt.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/wait.h>
#include <sys/types.h>
#include <sys/syscall.h>
#include <sys/utsname.h>
#include <termios.h>
51
#include <errno.h>
Daniel Vetter's avatar
Daniel Vetter committed
52 53 54

#include "drmtest.h"
#include "intel_chipset.h"
55
#include "intel_io.h"
Daniel Vetter's avatar
Daniel Vetter committed
56
#include "igt_debugfs.h"
57
#include "version.h"
Daniel Vetter's avatar
Daniel Vetter committed
58 59 60
#include "config.h"

#include "igt_core.h"
61
#include "igt_aux.h"
Daniel Vetter's avatar
Daniel Vetter committed
62 63 64 65 66

/**
 * SECTION:igt_core
 * @short_description: Core i-g-t testing support
 * @title: i-g-t core
67
 * @include: igt_core.h
68
 *
Daniel Vetter's avatar
Daniel Vetter committed
69 70 71 72 73 74 75 76 77
 * This libary implements the core of the i-g-t test support infrastructure.
 * Main features are the subtest enumeration, cmdline option parsing helpers for
 * subtest handling and various helpers to structure testcases with subtests and
 * handle subtest test results.
 *
 * Auxiliary code provides exit handlers, support for forked processes with test
 * result propagation. Other generally useful functionality includes optional
 * structure logging infrastructure and some support code for running reduced
 * test set on in simulated hardware environments.
78 79 80 81 82 83 84 85 86 87 88
 *
 * When writing tests with subtests it is extremely important that nothing
 * interferes with the subtest enumeration. In i-g-t subtests are enumerated at
 * runtime, which allows powerful testcase enumeration. But it makes subtest
 * enumeration a bit more tricky since the test code needs to be careful to
 * never run any code which might fail (like trying to do privileged operations
 * or opening device driver nodes).
 *
 * To allow this i-g-t provides #igt_fixture code blocks for setup code outside
 * of subtests and automatically skips the subtest code blocks themselves. For
 * special cases igt_only_list_subtests() is also provided.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
 *
 * # Magic Control Blocks
 *
 * i-g-t makes heavy use of C macros which serve as magic control blocks. They
 * work fairly well and transparently but since C doesn't have full-blown
 * closures there are caveats:
 *
 * - Asynchronous blocks which are used to spawn children internally use fork().
 *   Which means that nonsensical control flow like jumping out of the control
 *   block is possible, but it will badly confuse the i-g-t library code. And of
 *   course all caveats of a real fork() call apply, namely that file
 *   descriptors are copied, but still point at the original file. This will
 *   terminally upset the libdrm buffer manager if both parent and child keep on
 *   using the same open instance of the drm device. Usually everything related
 *   to interacting with the kernel driver must be reinitialized to avoid such
 *   issues.
 *
 * - Code blocks with magic control flow are implemented with setjmp() and
 *   longjmp(). This applies to #igt_fixture and #igt_subtest blocks and all the
 *   three variants to finish test: igt_success(), igt_skip() and igt_fail().
 *   Mostly this is of no concern, except when such a control block changes
 *   stack variables defined in the same function as the control block resides.
 *   Any store/load behaviour after a longjmp() is ill-defined for these
 *   variables. Avoid such code.
 *
 *   Quoting the man page for longjmp():
 *
 *   "The values of automatic variables are unspecified after a call to
 *   longjmp() if they meet all the following criteria:"
 *    - "they are local to the function that made the corresponding setjmp() call;
 *    - "their values are changed between the calls to setjmp() and longjmp(); and
 *    - "they are not declared as volatile."
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
 *
 * # Best Practices for Test Helper Libraries Design
 *
 * Kernel tests itself tend to have fairly complex logic already. It is
 * therefore paramount that helper code, both in libraries and test-private
 * functions, add as little boilerplate code to the main test logic as possible.
 * But then dense code is hard to understand without constantly consulting
 * the documentation and implementation of all the helper functions if it
 * doesn't follow some clear patterns. Hence follow these established best
 * practices:
 *
 * - Make extensive use of the implicit control flow afforded by igt_skip(),
 *   igt_fail and igt_success(). When dealing with optional kernel features
 *   combine igt_skip() with igt_fail() to skip when the kernel support isn't
 *   available but fail when anything else goes awry. void should be the most
 *   common return type in all your functions, except object constructors of
 *   course.
 *
 * - The main test logic should have no explicit control flow for failure
 *   conditions, but instead such assumptions should be written in a declarative
 *   style.  Use one of the many macros which encapsulate i-g-t's implicit
 *   control flow.  Pick the most suitable one to have as much debug output as
 *   possible without polluting the code unecessarily. For example
 *   igt_assert_cmpint() for comparing integers or do_ioctl() for running ioctls
 *   and checking their results.  Feel free to add new ones to the libary or
 *   wrap up a set of checks into a private function to further condense your
 *   test logic.
 *
 * - When adding a new feature test function which uses igt_skip() internally,
 *   use the &lt;prefix&gt;_require_&lt;feature_name&gt; naming scheme. When you
 *   instead add a feature test function which returns a boolean, because your
 *   main test logic must take different actions depending upon the feature's
 *   availability, then instead use the &lt;prefix&gt;_has_&lt;feature_name&gt;.
 *
 * - As already mentioned eschew explicit error handling logic as much as
 *   possible. If your test absolutely has to handle the error of some function
 *   the customary naming pattern is to prefix those variants with __. Try to
 *   restrict explicit error handling to leaf functions. For the main test flow
 *   simply pass the expected error condition down into your helper code, which
 *   results in tidy and declarative test logic.
 *
 * - Make your library functions as simple to use as possible. Automatically
 *   register cleanup handlers through igt_install_exit_handler(). Reduce the
 *   amount of setup boilerplate needed by using implicit singletons and lazy
 *   structure initialization and similar design patterns.
 *
 * - Don't shy away from refactoring common code, even when there are just 2-3
 *   users and even if it's not a net reduction in code. As long as it helps to
 *   remove boilerplate and makes the code more declarative the resulting
 *   clearer test flow is worth it. All i-g-t library code has been organically
 *   extracted from testcases in this fashion.
 *
 * - For general coding style issues please follow the kernel's rules laid out
 *   in
 *   [CodingStyle](https://www.kernel.org/doc/Documentation/CodingStyle).
176 177 178 179 180
 *
 * # Interface with Testrunners
 *
 * i-g-t testcase are all executables which should be run as root on an
 * otherwise completely idle system. The test status is reflected in the
181 182 183 184
 * exitcode. #IGT_EXIT_SUCCESS means "success", #IGT_EXIT_SKIP "skip",
 * #IGT_EXIT_TIMEOUT that some operation "timed out".  All other exit codes
 * encode a failed test result, including any abnormal termination of the test
 * (e.g. by SIGKILL).
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
 *
 * On top of that tests may report unexpected results and minor issues to
 * stderr. If stderr is non-empty the test result should be treated as "warn".
 *
 * The test lists are generated at build time. Simple testcases are listed in
 * tests/single-tests.txt and tests with subtests are listed in
 * tests/multi-tests.txt. When running tests with subtest from a test runner it
 * is recommend to run each subtest individually, since otherwise the return
 * code will only reflect the overall result.
 *
 * To do that obtain the lists of subtests with "--list-subtests", which can be
 * run as non-root and doesn't require the i915 driver to be loaded (or any
 * intel gpu to be present). Then individual subtests can be run with
 * "--run-subtest". Usage help for tests with subtests can be obtained with the
 * "--help" commandline option.
Daniel Vetter's avatar
Daniel Vetter committed
200 201 202 203 204 205 206
 */

static unsigned int exit_handler_count;

/* subtests helpers */
static bool list_subtests = false;
static char *run_single_subtest = NULL;
207
static bool run_single_subtest_found = false;
Daniel Vetter's avatar
Daniel Vetter committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
static const char *in_subtest = NULL;
static bool in_fixture = false;
static bool test_with_subtests = false;
static enum {
	CONT = 0, SKIP, FAIL
} skip_subtests_henceforth = CONT;

/* fork support state */
pid_t *test_children;
int num_test_children;
int test_children_sz;
bool test_child;

bool __igt_fixture(void)
{
	assert(!in_fixture);

	if (igt_only_list_subtests())
		return false;

	if (skip_subtests_henceforth)
		return false;

	in_fixture = true;
	return true;
}

void __igt_fixture_complete(void)
{
	assert(in_fixture);

	in_fixture = false;
}

void __igt_fixture_end(void)
{
	assert(in_fixture);

	in_fixture = false;
	longjmp(igt_subtest_jmpbuf, 1);
}

bool igt_exit_called;
static void check_igt_exit(int sig)
{
	/* When not killed by a signal check that igt_exit() has been properly
	 * called. */
	assert(sig != 0 || igt_exit_called);
}

static void print_version(void)
{
	struct utsname uts;

	if (list_subtests)
		return;

	uname(&uts);

	fprintf(stdout, "IGT-Version: %s-%s (%s) (%s: %s %s)\n", PACKAGE_VERSION,
		IGT_GIT_SHA1, TARGET_CPU_PLATFORM,
		uts.sysname, uts.release, uts.machine);
}

static void print_usage(const char *command_str, const char *help_str,
			bool output_on_stderr)
{
	FILE *f = output_on_stderr ? stderr : stdout;

	fprintf(f, "Usage: %s [OPTIONS]\n"
		   "  --list-subtests\n"
279 280 281
		   "  --run-subtest <pattern>\n"
		   "  --debug\n"
		   "  --help\n", command_str);
Daniel Vetter's avatar
Daniel Vetter committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295
	if (help_str)
		fprintf(f, "%s\n", help_str);
}

static void oom_adjust_for_doom(void)
{
	int fd;
	const char always_kill[] = "1000";

	fd = open("/proc/self/oom_score_adj", O_WRONLY);
	igt_assert(fd != -1);
	igt_assert(write(fd, always_kill, sizeof(always_kill)) == sizeof(always_kill));
}

296 297 298 299 300
static int common_init(int argc, char **argv,
		       const char *extra_short_opts,
		       struct option *extra_long_opts,
		       const char *help_str,
		       igt_opt_handler_t extra_opt_handler)
Daniel Vetter's avatar
Daniel Vetter committed
301 302 303 304 305
{
	int c, option_index = 0;
	static struct option long_options[] = {
		{"list-subtests", 0, 0, 'l'},
		{"run-subtest", 1, 0, 'r'},
306
		{"debug", 0, 0, 'd'},
Daniel Vetter's avatar
Daniel Vetter committed
307 308 309 310 311 312 313 314
		{"help", 0, 0, 'h'},
	};
	const char *command_str;
	char *short_opts;
	struct option *combined_opts;
	int extra_opt_count;
	int all_opt_count;
	int ret = 0;
315
	char *env = getenv("IGT_LOG_LEVEL");
Daniel Vetter's avatar
Daniel Vetter committed
316

317 318 319 320 321 322 323 324 325 326
	if (env) {
		if (strcmp(env, "debug") == 0)
			igt_log_level = IGT_LOG_DEBUG;
		else if (strcmp(env, "info") == 0)
			igt_log_level = IGT_LOG_INFO;
		else if (strcmp(env, "warn") == 0)
			igt_log_level = IGT_LOG_WARN;
		else if (strcmp(env, "none") == 0)
			igt_log_level = IGT_LOG_NONE;
	}
Daniel Vetter's avatar
Daniel Vetter committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

	command_str = argv[0];
	if (strrchr(command_str, '/'))
		command_str = strrchr(command_str, '/') + 1;

	/* First calculate space for all passed-in extra long options */
	all_opt_count = 0;
	while (extra_long_opts && extra_long_opts[all_opt_count].name)
		all_opt_count++;
	extra_opt_count = all_opt_count;

	all_opt_count += ARRAY_SIZE(long_options);

	combined_opts = malloc(all_opt_count * sizeof(*combined_opts));
	memcpy(combined_opts, extra_long_opts,
	       extra_opt_count * sizeof(*combined_opts));

	/* Copy the subtest long options (and the final NULL entry) */
	memcpy(&combined_opts[extra_opt_count], long_options,
		ARRAY_SIZE(long_options) * sizeof(*combined_opts));

	ret = asprintf(&short_opts, "%sh",
		       extra_short_opts ? extra_short_opts : "");
	assert(ret >= 0);

	while ((c = getopt_long(argc, argv, short_opts, combined_opts,
			       &option_index)) != -1) {
		switch(c) {
355 356 357
		case 'd':
			igt_log_level = IGT_LOG_DEBUG;
			break;
Daniel Vetter's avatar
Daniel Vetter committed
358 359 360 361 362 363 364 365 366 367 368 369 370
		case 'l':
			if (!run_single_subtest)
				list_subtests = true;
			break;
		case 'r':
			if (!list_subtests)
				run_single_subtest = strdup(optarg);
			break;
		case 'h':
			print_usage(command_str, help_str, false);
			ret = -1;
			goto out;
		case '?':
371 372 373
			print_usage(command_str, help_str, true);
			ret = -2;
			goto out;
Daniel Vetter's avatar
Daniel Vetter committed
374 375 376 377 378 379 380 381 382 383 384 385
		default:
			ret = extra_opt_handler(c, option_index);
			if (ret)
				goto out;
		}
	}

	oom_adjust_for_doom();

out:
	free(short_opts);
	free(combined_opts);
386 387 388 389 390 391

	/* exit immediately if this test has no subtests and a subtest or the
	 * list of subtests has been requested */
	if (!test_with_subtests) {
		if (run_single_subtest) {
			igt_warn("Unknown subtest: %s\n", run_single_subtest);
392
			exit(IGT_EXIT_INVALID);
393 394
		}
		if (list_subtests)
395
			exit(IGT_EXIT_INVALID);
396 397 398 399
	}

	if (ret < 0)
		/* exit with no error for -h/--help */
400
		exit(ret == -1 ? 0 : IGT_EXIT_INVALID);
401

Daniel Vetter's avatar
Daniel Vetter committed
402 403 404 405 406 407
	print_version();

	return ret;
}


408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
/**
 * igt_subtest_init_parse_opts:
 * @argc: argc from the test's main()
 * @argv: argv from the test's main()
 * @extra_short_opts: getopt_long() compliant list with additional short options
 * @extra_long_opts: getopt_long() compliant list with additional long options
 * @help_str: help string for the additional options
 * @extra_opt_handler: handler for the additional options
 *
 * This function handles the subtest related cmdline options and allows an
 * arbitrary set of additional options. This is useful for tests which have
 * additional knobs to tune when run manually like the number of rounds execute
 * or the size of the allocated buffer objects.
 *
 * Tests without special needs should just use igt_subtest_init() or use
 * #igt_main directly instead of their own main() function.
 *
 * Returns: Forwards any option parsing errors from getopt_long.
 */
int igt_subtest_init_parse_opts(int argc, char **argv,
				const char *extra_short_opts,
				struct option *extra_long_opts,
				const char *help_str,
				igt_opt_handler_t extra_opt_handler)
Daniel Vetter's avatar
Daniel Vetter committed
432
{
433
	int ret;
Daniel Vetter's avatar
Daniel Vetter committed
434

435 436 437 438
	test_with_subtests = true;
	ret = common_init(argc, argv, extra_short_opts, extra_long_opts,
			  help_str, extra_opt_handler);
	igt_install_exit_handler(check_igt_exit);
Daniel Vetter's avatar
Daniel Vetter committed
439

440
	return ret;
Daniel Vetter's avatar
Daniel Vetter committed
441 442
}

443 444
enum igt_log_level igt_log_level = IGT_LOG_INFO;

445 446 447 448 449 450 451 452 453 454 455 456 457
/**
 * igt_subtest_init:
 * @argc: argc from the test's main()
 * @argv: argv from the test's main()
 *
 * This initializes the for tests with subtests without the need for additional
 * cmdline options. It is just a simplified version of
 * igt_subtest_init_parse_opts().
 *
 * If there's not a reason to the contrary it's less error prone to just use an
 * #igt_main block instead of stitching the tests's main() function together
 * manually.
 */
Daniel Vetter's avatar
Daniel Vetter committed
458 459
void igt_subtest_init(int argc, char **argv)
{
460
	igt_subtest_init_parse_opts(argc, argv, NULL, NULL, NULL, NULL);
Daniel Vetter's avatar
Daniel Vetter committed
461 462
}

463 464
/**
 * igt_simple_init:
465 466
 * @argc: argc from the test's main()
 * @argv: argv from the test's main()
467 468 469 470 471 472 473
 *
 * This initializes a simple test without any support for subtests.
 *
 * If there's not a reason to the contrary it's less error prone to just use an
 * #igt_simple_main block instead of stitching the tests's main() function together
 * manually.
 */
474
void igt_simple_init(int argc, char **argv)
Daniel Vetter's avatar
Daniel Vetter committed
475
{
476
	common_init(argc, argv, NULL, NULL, NULL, NULL);
Daniel Vetter's avatar
Daniel Vetter committed
477 478
}

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/**
 * igt_simple_init_parse_opts:
 * @argc: argc from the test's main()
 * @argv: argv from the test's main()
 * @extra_short_opts: getopt_long() compliant list with additional short options
 * @extra_long_opts: getopt_long() compliant list with additional long options
 * @help_str: help string for the additional options
 * @extra_opt_handler: handler for the additional options
 *
 * This initializes a simple test without any support for subtests and allows
 * an arbitrary set of additional options.
 */
void igt_simple_init_parse_opts(int argc, char **argv,
				const char *extra_short_opts,
				struct option *extra_long_opts,
				const char *help_str,
				igt_opt_handler_t extra_opt_handler)
{
	common_init(argc, argv, extra_short_opts, extra_long_opts, help_str,
		    extra_opt_handler);
}

Daniel Vetter's avatar
Daniel Vetter committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
/*
 * Note: Testcases which use these helpers MUST NOT output anything to stdout
 * outside of places protected by igt_run_subtest checks - the piglit
 * runner adds every line to the subtest list.
 */
bool __igt_run_subtest(const char *subtest_name)
{
	assert(!in_subtest);
	assert(!in_fixture);

	if (list_subtests) {
		printf("%s\n", subtest_name);
		return false;
	}

516 517 518 519 520 521 522 523
	if (run_single_subtest) {
		if (strcmp(subtest_name, run_single_subtest) != 0)
			return false;
		else
			run_single_subtest_found = true;
	}


Daniel Vetter's avatar
Daniel Vetter committed
524 525 526 527 528 529 530 531 532 533 534

	if (skip_subtests_henceforth) {
		printf("Subtest %s: %s\n", subtest_name,
		       skip_subtests_henceforth == SKIP ?
		       "SKIP" : "FAIL");
		return false;
	}

	return (in_subtest = subtest_name);
}

535 536 537 538 539 540
/**
 * igt_subtest_name:
 *
 * Returns: The name of the currently executed subtest or NULL if called from
 * outside a subtest block.
 */
Daniel Vetter's avatar
Daniel Vetter committed
541 542 543 544 545
const char *igt_subtest_name(void)
{
	return in_subtest;
}

546 547 548 549 550 551
/**
 * igt_only_list_subtests:
 *
 * Returns: Returns true if only subtest should be listed and any setup code
 * must be skipped, false otherwise.
 */
Daniel Vetter's avatar
Daniel Vetter committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
bool igt_only_list_subtests(void)
{
	return list_subtests;
}

static bool skipped_one = false;
static bool succeeded_one = false;
static bool failed_one = false;
static int igt_exitcode;

static void exit_subtest(const char *) __attribute__((noreturn));
static void exit_subtest(const char *result)
{
	printf("Subtest %s: %s\n", in_subtest, result);
	in_subtest = NULL;
	longjmp(igt_subtest_jmpbuf, 1);
}

570 571 572 573 574 575 576 577 578 579 580 581 582 583
/**
 * igt_skip:
 * @f: format string
 * @...: optional arguments used in the format string
 *
 * Subtest aware test skipping. The format string is printed to stderr as the
 * reason why the test skipped.
 *
 * For tests with subtests this will either bail out of the current subtest or
 * mark all subsequent subtests as SKIP (presuming some global setup code
 * failed).
 *
 * For normal tests without subtest it will directly exit.
 */
Daniel Vetter's avatar
Daniel Vetter committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
void igt_skip(const char *f, ...)
{
	va_list args;
	skipped_one = true;

	assert(!test_child);

	if (!igt_only_list_subtests()) {
		va_start(args, f);
		vprintf(f, args);
		va_end(args);
	}

	if (in_subtest) {
		exit_subtest("SKIP");
	} else if (test_with_subtests) {
		skip_subtests_henceforth = SKIP;
		assert(in_fixture);
		__igt_fixture_end();
	} else {
604
		exit(IGT_EXIT_SKIP);
Daniel Vetter's avatar
Daniel Vetter committed
605 606 607 608 609 610 611 612 613
	}
}

void __igt_skip_check(const char *file, const int line,
		      const char *func, const char *check,
		      const char *f, ...)
{
	va_list args;
	int err = errno;
614 615 616 617
	char *err_str = NULL;

	if (err)
		asprintf(&err_str, "Last errno: %i, %s\n", err, strerror(err));
Daniel Vetter's avatar
Daniel Vetter committed
618 619 620 621 622 623 624 625 626 627 628 629 630

	if (f) {
		static char *buf;

		/* igt_skip never returns, so try to not leak too badly. */
		if (buf)
			free(buf);

		va_start(args, f);
		vasprintf(&buf, f, args);
		va_end(args);

		igt_skip("Test requirement not met in function %s, file %s:%i:\n"
631
			 "Test requirement: (%s)\n%s"
632 633
			 "%s",
			 func, file, line, check, buf, err_str ?: "");
Daniel Vetter's avatar
Daniel Vetter committed
634 635
	} else {
		igt_skip("Test requirement not met in function %s, file %s:%i:\n"
636
			 "Test requirement: (%s)\n"
637 638
			 "%s",
			 func, file, line, check, err_str ?: "");
Daniel Vetter's avatar
Daniel Vetter committed
639 640 641
	}
}

642 643 644 645 646 647 648 649
/**
 * igt_success:
 *
 * Complete a (subtest) as successfull
 *
 * This bails out of a subtests and marks it as successful. For global tests it
 * it won't bail out of anything.
 */
Daniel Vetter's avatar
Daniel Vetter committed
650 651 652 653 654 655 656
void igt_success(void)
{
	succeeded_one = true;
	if (in_subtest)
		exit_subtest("SUCCESS");
}

657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
/**
 * igt_fail:
 * @exitcode: exitcode
 *
 * Fail a testcase. The exitcode is used as the exit code of the test process.
 * It may not be 0 (which indicates success) or 77 (which indicates a skipped
 * test).
 *
 * For tests with subtests this will either bail out of the current subtest or
 * mark all subsequent subtests as FAIL (presuming some global setup code
 * failed).
 *
 * For normal tests without subtest it will directly exit with the given
 * exitcode.
 */
Daniel Vetter's avatar
Daniel Vetter committed
672 673
void igt_fail(int exitcode)
{
674
	assert(exitcode != IGT_EXIT_SUCCESS && exitcode != IGT_EXIT_SKIP);
Daniel Vetter's avatar
Daniel Vetter committed
675 676 677 678 679 680 681 682 683 684

	if (!failed_one)
		igt_exitcode = exitcode;

	failed_one = true;

	/* Silent exit, parent will do the yelling. */
	if (test_child)
		exit(exitcode);

Thomas Wood's avatar
Thomas Wood committed
685
	if (in_subtest) {
686
		if (exitcode == IGT_EXIT_TIMEOUT)
Thomas Wood's avatar
Thomas Wood committed
687 688 689 690
			exit_subtest("TIMEOUT");
		else
			exit_subtest("FAIL");
	} else {
Daniel Vetter's avatar
Daniel Vetter committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
		assert(!test_with_subtests || in_fixture);

		if (in_fixture) {
			skip_subtests_henceforth = FAIL;
			__igt_fixture_end();
		}

		exit(exitcode);
	}
}

static bool run_under_gdb(void)
{
	char buf[1024];

	sprintf(buf, "/proc/%d/exe", getppid());
	return (readlink (buf, buf, sizeof (buf)) != -1 &&
		strncmp(basename(buf), "gdb", 3) == 0);
}

void __igt_fail_assert(int exitcode, const char *file,
		       const int line, const char *func, const char *assertion,
		       const char *f, ...)
{
	va_list args;
	int err = errno;
717 718 719 720
	char *err_str = NULL;

	if (err)
		asprintf(&err_str, "Last errno: %i, %s\n", err, strerror(err));
Daniel Vetter's avatar
Daniel Vetter committed
721 722

	printf("Test assertion failure function %s, file %s:%i:\n"
723 724 725 726 727
	       "Failed assertion: %s\n"
	       "%s",
	       func, file, line, assertion, err_str ?: "");

	free(err_str);
Daniel Vetter's avatar
Daniel Vetter committed
728 729 730 731 732 733 734 735 736 737 738 739

	if (f) {
		va_start(args, f);
		vprintf(f, args);
		va_end(args);
	}

	if (run_under_gdb())
		abort();
	igt_fail(exitcode);
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
/**
 * igt_exit:
 *
 * exit() for both types (simple and with subtests) of i-g-t tests.
 *
 * This will exit the test with the right exit code when subtests have been
 * skipped. For normal tests it exits with a successful exit code, presuming
 * everything has worked out. For subtests it also checks that at least one
 * subtest has been run (save when only listing subtests.
 *
 * It is an error to normally exit a test with subtests without calling
 * igt_exit() - without it the result reporting will be wrong. To avoid such
 * issues it is highly recommended to use #igt_main instead of a hand-rolled
 * main() function.
 */
Daniel Vetter's avatar
Daniel Vetter committed
755 756 757 758
void igt_exit(void)
{
	igt_exit_called = true;

759 760
	if (run_single_subtest && !run_single_subtest_found) {
		igt_warn("Unknown subtest: %s\n", run_single_subtest);
761
		exit(IGT_EXIT_INVALID);
762 763 764
	}


Daniel Vetter's avatar
Daniel Vetter committed
765
	if (igt_only_list_subtests())
766
		exit(IGT_EXIT_SUCCESS);
Daniel Vetter's avatar
Daniel Vetter committed
767 768

	if (!test_with_subtests)
769
		exit(IGT_EXIT_SUCCESS);
Daniel Vetter's avatar
Daniel Vetter committed
770 771 772 773 774 775 776

	/* Calling this without calling one of the above is a failure */
	assert(skipped_one || succeeded_one || failed_one);

	if (failed_one)
		exit(igt_exitcode);
	else if (succeeded_one)
777
		exit(IGT_EXIT_SUCCESS);
Daniel Vetter's avatar
Daniel Vetter committed
778
	else
779
		exit(IGT_EXIT_SKIP);
Daniel Vetter's avatar
Daniel Vetter committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
}

/* fork support code */
static int helper_process_count;
static pid_t helper_process_pids[] =
{ -1, -1, -1, -1};

static void reset_helper_process_list(void)
{
	for (int i = 0; i < ARRAY_SIZE(helper_process_pids); i++)
		helper_process_pids[i] = -1;
	helper_process_count = 0;
}

static void fork_helper_exit_handler(int sig)
{
796 797 798
	int status;

	/* Inside a signal handler, play safe */
Daniel Vetter's avatar
Daniel Vetter committed
799 800 801
	for (int i = 0; i < ARRAY_SIZE(helper_process_pids); i++) {
		pid_t pid = helper_process_pids[i];
		if (pid != -1) {
802 803
			kill(pid, SIGTERM);
			waitpid(pid, &status, WNOHANG);
Daniel Vetter's avatar
Daniel Vetter committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
			helper_process_count--;
		}
	}

	assert(helper_process_count == 0);
}

bool __igt_fork_helper(struct igt_helper_process *proc)
{
	pid_t pid;
	int id;

	assert(!proc->running);
	assert(helper_process_count < ARRAY_SIZE(helper_process_pids));

	for (id = 0; helper_process_pids[id] != -1; id++)
		;

	igt_install_exit_handler(fork_helper_exit_handler);

	switch (pid = fork()) {
	case -1:
		igt_assert(0);
	case 0:
		exit_handler_count = 0;
		reset_helper_process_list();
		oom_adjust_for_doom();

		return true;
	default:
		proc->running = true;
		proc->pid = pid;
		proc->id = id;
		helper_process_pids[id] = pid;
		helper_process_count++;

		return false;
	}

}

845
/**
846
 * igt_wait_helper:
847 848
 * @proc: #igt_helper_process structure
 *
849 850
 * Joins a helper process. It is an error to call this on a helper process which
 * hasn't been spawned yet.
851
 */
852
int igt_wait_helper(struct igt_helper_process *proc)
Daniel Vetter's avatar
Daniel Vetter committed
853
{
854
	int status = -1;
Daniel Vetter's avatar
Daniel Vetter committed
855 856 857

	assert(proc->running);

858
	waitpid(proc->pid, &status, WNOHANG);
Daniel Vetter's avatar
Daniel Vetter committed
859 860 861 862 863

	proc->running = false;

	helper_process_pids[proc->id] = -1;
	helper_process_count--;
864 865

	return status;
Daniel Vetter's avatar
Daniel Vetter committed
866 867
}

868
/**
869
 * igt_stop_helper:
870 871
 * @proc: #igt_helper_process structure
 *
872 873
 * Terminates a helper process. It is an error to call this on a helper process
 * which hasn't been spawned yet.
874
 */
875
void igt_stop_helper(struct igt_helper_process *proc)
Daniel Vetter's avatar
Daniel Vetter committed
876 877 878
{
	int status;

879 880
	/* failure here means the pid is already dead and so waiting is safe */
	kill(proc->pid, proc->use_SIGKILL ? SIGKILL : SIGTERM);
Daniel Vetter's avatar
Daniel Vetter committed
881

882 883 884
	status = igt_wait_helper(proc);
	assert(WIFSIGNALED(status) &&
	       WTERMSIG(status) == (proc->use_SIGKILL ? SIGKILL : SIGTERM));
Daniel Vetter's avatar
Daniel Vetter committed
885 886 887 888
}

static void children_exit_handler(int sig)
{
889
	int status;
Daniel Vetter's avatar
Daniel Vetter committed
890

891 892 893
	/* The exit handler can be called from a fatal signal, so play safe */
	while (num_test_children-- && wait(&status))
		;
Daniel Vetter's avatar
Daniel Vetter committed
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
}

bool __igt_fork(void)
{
	assert(!test_with_subtests || in_subtest);
	assert(!test_child);

	igt_install_exit_handler(children_exit_handler);

	if (num_test_children >= test_children_sz) {
		if (!test_children_sz)
			test_children_sz = 4;
		else
			test_children_sz *= 2;

		test_children = realloc(test_children,
					sizeof(pid_t)*test_children_sz);
		igt_assert(test_children);
	}

	switch (test_children[num_test_children++] = fork()) {
	case -1:
		igt_assert(0);
	case 0:
		test_child = true;
		exit_handler_count = 0;
		reset_helper_process_list();
		oom_adjust_for_doom();

		return true;
	default:
		return false;
	}

}

/**
 * igt_waitchildren:
 *
933
 * Wait for all children forked with igt_fork.
Daniel Vetter's avatar
Daniel Vetter committed
934 935
 *
 * The magic here is that exit codes from children will be correctly propagated
936 937 938 939 940 941
 * to the main thread, including the relevant exitcode if a child thread failed.
 * Of course if multiple children failed with differen exitcodes the resulting
 * exitcode will be non-deterministic.
 *
 * Note that igt_skip() will not be forwarded, feature tests need to be done
 * before spawning threads with igt_fork().
Daniel Vetter's avatar
Daniel Vetter committed
942 943 944
 */
void igt_waitchildren(void)
{
945 946 947
	int err = 0;
	int count;

Daniel Vetter's avatar
Daniel Vetter committed
948 949
	assert(!test_child);

950 951
	count = 0;
	while (count < num_test_children) {
Daniel Vetter's avatar
Daniel Vetter committed
952
		int status = -1;
953 954
		pid_t pid;
		int c;
Daniel Vetter's avatar
Daniel Vetter committed
955

956 957 958 959 960 961 962 963 964 965 966
		pid = wait(&status);
		if (pid == -1)
			continue;

		for (c = 0; c < num_test_children; c++)
			if (pid == test_children[c])
				break;
		if (c == num_test_children)
			continue;

		if (err == 0 && status != 0) {
Daniel Vetter's avatar
Daniel Vetter committed
967 968
			if (WIFEXITED(status)) {
				printf("child %i failed with exit status %i\n",
969 970
				       c, WEXITSTATUS(status));
				err = WEXITSTATUS(status);
Daniel Vetter's avatar
Daniel Vetter committed
971 972
			} else if (WIFSIGNALED(status)) {
				printf("child %i died with signal %i, %s\n",
973
				       c, WTERMSIG(status),
Daniel Vetter's avatar
Daniel Vetter committed
974
				       strsignal(WTERMSIG(status)));
975
				err = 128 + WTERMSIG(status);
Daniel Vetter's avatar
Daniel Vetter committed
976
			} else {
977 978
				printf("Unhandled failure [%d] in child %i\n", status, c);
				err = 256;
Daniel Vetter's avatar
Daniel Vetter committed
979
			}
980 981 982

			for (c = 0; c < num_test_children; c++)
				kill(test_children[c], SIGKILL);
Daniel Vetter's avatar
Daniel Vetter committed
983
		}
984 985

		count++;
Daniel Vetter's avatar
Daniel Vetter committed
986 987 988
	}

	num_test_children = 0;
989 990
	if (err)
		igt_fail(err);
Daniel Vetter's avatar
Daniel Vetter committed
991 992 993 994
}

/* exit handler code */
#define MAX_SIGNALS		32
995
#define MAX_EXIT_HANDLERS	10
Daniel Vetter's avatar
Daniel Vetter committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

static struct {
	sighandler_t handler;
	bool installed;
} orig_sig[MAX_SIGNALS];

static igt_exit_handler_t exit_handler_fn[MAX_EXIT_HANDLERS];
static bool exit_handler_disabled;
static sigset_t saved_sig_mask;
static const int handled_signals[] =
	{ SIGINT, SIGHUP, SIGTERM, SIGQUIT, SIGPIPE, SIGABRT, SIGSEGV, SIGBUS };

static int install_sig_handler(int sig_num, sighandler_t handler)
{
	orig_sig[sig_num].handler = signal(sig_num, handler);

	if (orig_sig[sig_num].handler == SIG_ERR)
		return -1;

	orig_sig[sig_num].installed = true;

	return 0;
}

static void restore_sig_handler(int sig_num)
{
	/* Just restore the default so that we properly fall over. */
	signal(sig_num, SIG_DFL);
}

static void restore_all_sig_handler(void)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(orig_sig); i++)
		restore_sig_handler(i);
}

static void call_exit_handlers(int sig)
{
	int i;

	if (!exit_handler_count) {
		return;
	}

	for (i = exit_handler_count - 1; i >= 0; i--)
		exit_handler_fn[i](sig);

	/* ensure we don't get called twice */
	exit_handler_count = 0;
}

static void igt_atexit_handler(void)
{
	restore_all_sig_handler();

	if (!exit_handler_disabled)
		call_exit_handlers(0);
}

static void fatal_sig_handler(int sig)
{
	pid_t pid, tid;

	restore_all_sig_handler();

	/*
	 * exit_handler_disabled is always false here, since when we set it
	 * we also block signals.
	 */
	call_exit_handlers(sig);

	/* Workaround cached PID and TID races on glibc and Bionic libc. */
	pid = syscall(SYS_getpid);
	tid = syscall(SYS_gettid);

	syscall(SYS_tgkill, pid, tid, sig);
}

1076 1077 1078 1079
/**
 * igt_install_exit_handler:
 * @fn: exit handler function
 *
Daniel Vetter's avatar
Daniel Vetter committed
1080
 * Set a handler that will be called either when the process calls exit() or
1081 1082 1083 1084 1085
 * <!-- -->returns from the main function, or one of the signals in
 * 'handled_signals' is raised. MAX_EXIT_HANDLERS handlers can be installed,
 * each of which will be called only once, even if a subsequent signal is
 * raised. If the exit handlers are called due to a signal, the signal will be
 * re-raised with the original signal disposition after all handlers returned.
Daniel Vetter's avatar
Daniel Vetter committed
1086 1087
 *
 * The handler will be passed the signal number if called due to a signal, or
1088 1089
 * 0 otherwise. Exit handlers can also be used from test children spawned with
 * igt_fork(), but not from within helper processes spawned with
1090
 * igt_fork_helper(). The list of exit handlers is reset when forking to
1091
 * avoid issues with children cleanup up the parent's state too early.
Daniel Vetter's avatar
Daniel Vetter committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
 */
void igt_install_exit_handler(igt_exit_handler_t fn)
{
	int i;

	for (i = 0; i < exit_handler_count; i++)
		if (exit_handler_fn[i] == fn)
			return;

	igt_assert(exit_handler_count < MAX_EXIT_HANDLERS);

	exit_handler_fn[exit_handler_count] = fn;
	exit_handler_count++;

	if (exit_handler_count > 1)
		return;

	for (i = 0; i < ARRAY_SIZE(handled_signals); i++) {
		if (install_sig_handler(handled_signals[i],
					fatal_sig_handler))
			goto err;
	}

	if (atexit(igt_atexit_handler))
		goto err;

	return;
err:
	restore_all_sig_handler();
	exit_handler_count--;

	igt_assert_f(0, "failed to install the signal handler\n");
}

1126 1127 1128 1129 1130 1131
/**
 * igt_disable_exit_handler:
 *
 * Temporarily disable all exit handlers. Useful for library code doing tricky
 * things.
 */
Daniel Vetter's avatar
Daniel Vetter committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
void igt_disable_exit_handler(void)
{
	sigset_t set;
	int i;

	if (exit_handler_disabled)
		return;

	sigemptyset(&set);
	for (i = 0; i < ARRAY_SIZE(handled_signals); i++)
		sigaddset(&set, handled_signals[i]);

	if (sigprocmask(SIG_BLOCK, &set, &saved_sig_mask)) {
		perror("sigprocmask");
		return;
	}

	exit_handler_disabled = true;
}

1152 1153 1154 1155 1156 1157
/**
 * igt_enable_exit_handler:
 *
 * Re-enable all exit handlers temporarily disabled with
 * igt_disable_exit_handler().
 */
Daniel Vetter's avatar
Daniel Vetter committed
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
void igt_enable_exit_handler(void)
{
	if (!exit_handler_disabled)
		return;

	if (sigprocmask(SIG_SETMASK, &saved_sig_mask, NULL)) {
		perror("sigprocmask");
		return;
	}

	exit_handler_disabled = false;
}

/* simulation enviroment support */
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181

/**
 * igt_run_in_simulation:
 *
 * This function can be used to select a reduced test set when running in
 * simulation enviroments. This i-g-t mode is selected by setting the
 * INTEL_SIMULATION enviroment variable to 1.
 *
 * Returns: True when run in simulation mode, false otherwise.
 */
Daniel Vetter's avatar
Daniel Vetter committed
1182 1183 1184 1185 1186
bool igt_run_in_simulation(void)
{
	static int simulation = -1;

	if (simulation == -1)
1187
		simulation = igt_check_boolean_env_var("INTEL_SIMULATION", false);
Daniel Vetter's avatar
Daniel Vetter committed
1188 1189 1190 1191 1192 1193 1194

	return simulation;
}

/**
 * igt_skip_on_simulation:
 *
1195 1196
 * Skip tests when INTEL_SIMULATION environment variable is set. It uses
 * igt_skip() internally and hence is fully subtest aware.
1197 1198 1199 1200 1201 1202
 *
 * Note that in contrast to all other functions which use igt_skip() internally
 * it is allowed to use this outside of an #igt_fixture block in a test with
 * subtests. This is because in contrast to most other test requirements,
 * checking for simulation mode doesn't depend upon the present hardware and it
 * so makes a lot of sense to have this check in the outermost #igt_main block.
Daniel Vetter's avatar
Daniel Vetter committed
1203 1204 1205 1206 1207 1208
 */
void igt_skip_on_simulation(void)
{
	if (igt_only_list_subtests())
		return;

1209
	if (!in_fixture && !in_subtest) {
1210 1211 1212 1213
		igt_fixture
			igt_require(!igt_run_in_simulation());
	} else
		igt_require(!igt_run_in_simulation());
Daniel Vetter's avatar
Daniel Vetter committed
1214 1215 1216
}

/* structured logging */
1217 1218 1219 1220 1221 1222 1223

/**
 * igt_log:
 * @level: #igt_log_level
 * @format: format string
 * @...: optional arguments used in the format string
 *
1224
 * This is the generic structured logging helper function. i-g-t testcase should
1225 1226 1227 1228 1229 1230 1231 1232 1233
 * output all normal message to stdout. Warning level message should be printed
 * to stderr and the test runner should treat this as an intermediate result
 * between SUCESS and FAILURE.
 *
 * The log level can be set through the IGT_LOG_LEVEL enviroment variable with
 * values "debug", "info", "warn" and "none". By default verbose debug message
 * are disabled. "none" completely disables all output and is not recommended
 * since crucial issues only reported at the IGT_LOG_WARN level are ignored.
 */
Daniel Vetter's avatar
Daniel Vetter committed
1234 1235 1236 1237 1238 1239
void igt_log(enum igt_log_level level, const char *format, ...)
{
	va_list args;

	assert(format);

1240 1241 1242
	if (list_subtests)
		return;

Daniel Vetter's avatar
Daniel Vetter committed
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
	if (igt_log_level > level)
		return;

	va_start(args, format);
	if (level == IGT_LOG_WARN) {
		fflush(stdout);
		vfprintf(stderr, format, args);
	} else
		vprintf(format, args);
	va_end(args);
}
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271

/**
 * igt_vlog:
 * @level: #igt_log_level
 * @format: format string
 * @args: variable arguments lists
 *
 * This is the generic logging helper function using an explicit varargs
 * structure and hence useful to implement domain-specific logging
 * functions.
 *
 * If there is no need to wrap up a vararg list in the caller it is simpler to
 * just use igt_log().
 */
void igt_vlog(enum igt_log_level level, const char *format, va_list args)
{
	assert(format);

1272 1273 1274
	if (list_subtests)
		return;

1275 1276 1277 1278 1279 1280 1281 1282 1283
	if (igt_log_level > level)
		return;

	if (level == IGT_LOG_WARN) {
		fflush(stdout);
		vfprintf(stderr, format, args);
	} else
		vprintf(format, args);
}
Thomas Wood's avatar
Thomas Wood committed
1284 1285 1286 1287 1288 1289

static void igt_alarm_handler(int signal)
{
	/* subsequent tests are skipped */
	skip_subtests_henceforth = SKIP;

1290 1291
	/* exit with timeout status */
	igt_fail(IGT_EXIT_TIMEOUT);
Thomas Wood's avatar
Thomas Wood committed
1292 1293 1294 1295 1296 1297 1298
}

/**
 * igt_set_timeout:
 * @seconds: number of seconds before timeout
 *
 * Stop the current test and skip any subsequent tests after the specified
1299 1300 1301
 * number of seconds have elapsed. The test will exit with #IGT_EXIT_TIMEOUT
 * status. Any previous timer is cancelled and no timeout is scheduled if
 * @seconds is zero.
Thomas Wood's avatar
Thomas Wood committed
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
 *
 */
void igt_set_timeout(unsigned int seconds)
{
	struct sigaction sa;

	sa.sa_handler = igt_alarm_handler;
	sigemptyset(&sa.sa_mask);
	sa.sa_flags = 0;

	if (seconds == 0)
		sigaction(SIGALRM, NULL, NULL);
	else
		sigaction(SIGALRM, &sa, NULL);

	alarm(seconds);
}