glibc/support/test-driver.h
Chung-Lin Tang e6fd79f379 elf: Testing infrastructure for ld.so DSO sorting (BZ #17645)
This is the first of a 2-part patch set that fixes slow DSO sorting behavior in
the dynamic loader, as reported in BZ #17645. In order to facilitate such a
large modification to the dynamic loader, this first patch implements a testing
framework for validating shared object sorting behavior, to enable comparison
between old/new sorting algorithms, and any later enhancements.

This testing infrastructure consists of a Python script
scripts/dso-ordering-test.py' which takes in a description language, consisting
of strings that describe a set of link dependency relations between DSOs, and
generates testcase programs and Makefile fragments to automatically test the
described situation, for example:

  a->b->c->d          # four objects linked one after another

  a->[bc]->d;b->c     # a depends on b and c, which both depend on d,
                      # b depends on c (b,c linked to object a in fixed order)

  a->b->c;{+a;%a;-a}  # a, b, c serially dependent, main program uses
                      # dlopen/dlsym/dlclose on object a

  a->b->c;{}!->[abc]  # a, b, c serially dependent; multiple tests generated
                      # to test all permutations of a, b, c ordering linked
                      # to main program

 (Above is just a short description of what the script can do, more
  documentation is in the script comments.)

Two files containing several new tests, elf/dso-sort-tests-[12].def are added,
including test scenarios for BZ #15311 and Redhat issue #1162810 [1].

Due to the nature of dynamic loader tests, where the sorting behavior and test
output occurs before/after main(), generating testcases to use
support/test-driver.c does not suffice to control meaningful timeout for ld.so.
Therefore a new utility program 'support/test-run-command', based on
test-driver.c/support_test_main.c has been added. This does the same testcase
control, but for a program specified through a command-line rather than at the
source code level. This utility is used to run the dynamic loader testcases
generated by dso-ordering-test.py.

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1162810

Signed-off-by: Chung-Lin Tang  <cltang@codesourcery.com>
Reviewed-by: Adhemerval Zanella  <adhemerval.zanella@linaro.org>
2021-10-21 11:23:53 -03:00

86 lines
3.0 KiB
C

/* Interfaces for the test driver.
Copyright (C) 2016-2021 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<https://www.gnu.org/licenses/>. */
#ifndef SUPPORT_TEST_DRIVER_H
#define SUPPORT_TEST_DRIVER_H
#include <sys/cdefs.h>
__BEGIN_DECLS
struct test_config
{
void (*prepare_function) (int argc, char **argv);
int (*test_function) (void);
int (*test_function_argv) (int argc, char **argv);
void (*cleanup_function) (void);
void (*cmdline_function) (int);
const void *options; /* Custom options if not NULL. */
int timeout; /* Test timeout in seconds. */
int expected_status; /* Expected exit status. */
int expected_signal; /* If non-zero, expect termination by signal. */
char no_mallopt; /* Boolean flag to disable mallopt. */
char no_setvbuf; /* Boolean flag to disable setvbuf. */
char run_command_mode; /* Boolean flag to indicate run-command-mode. */
const char *optstring; /* Short command line options. */
};
enum
{
/* Test exit status which indicates that the feature is
unsupported. */
EXIT_UNSUPPORTED = 77,
/* Default timeout is twenty seconds. Tests should normally
complete faster than this, but if they don't, that's abnormal
(a bug) anyways. */
DEFAULT_TIMEOUT = 20,
/* Used for command line argument parsing. */
OPT_DIRECT = 1000,
OPT_TESTDIR,
};
/* Options provided by the test driver. */
#define TEST_DEFAULT_OPTIONS \
{ "verbose", no_argument, NULL, 'v' }, \
{ "direct", no_argument, NULL, OPT_DIRECT }, \
{ "test-dir", required_argument, NULL, OPT_TESTDIR }, \
/* The directory the test should use for temporary files. */
extern const char *test_dir;
/* The number of --verbose arguments specified during program
invocation. This variable can be used to control the verbosity of
tests. */
extern unsigned int test_verbose;
/* Output that is only emitted if at least one --verbose argument was
specified. */
#define verbose_printf(...) \
do { \
if (test_verbose > 0) \
printf (__VA_ARGS__); \
} while (0);
int support_test_main (int argc, char **argv, const struct test_config *);
__END_DECLS
#endif /* SUPPORT_TEST_DRIVER_H */