glibc/nptl/test-mutexattr-printers.py

102 lines
3.5 KiB
Python
Raw Normal View History

Add pretty printers for the NPTL lock types This patch adds pretty printers for the following NPTL types: - pthread_mutex_t - pthread_mutexattr_t - pthread_cond_t - pthread_condattr_t - pthread_rwlock_t - pthread_rwlockattr_t To load the pretty printers into your gdb session, do the following: python import sys sys.path.insert(0, '/path/to/glibc/build/nptl/pretty-printers') end source /path/to/glibc/source/pretty-printers/nptl-printers.py You can check which printers are registered and enabled by issuing the 'info pretty-printer' gdb command. Printers should trigger automatically when trying to print a variable of one of the types mentioned above. The printers are architecture-independent, and were tested on an AMD64 running Ubuntu 14.04 and an x86 VM running Fedora 24. In order to work, the printers need to know the values of various flags that are scattered throughout pthread.h and pthreadP.h as enums and #defines. Since replicating these constants in the printers file itself would create a maintenance burden, I wrote a script called gen-py-const.awk that Makerules uses to extract the constants. This script is pretty much the same as gen-as-const.awk, except it doesn't cast the constant values to 'long' and is thorougly documented. The constants need only to be enumerated in a .pysym file, which is then referenced by a Make variable called gen-py-const-headers. As for the install directory, I discussed this with Mike Frysinger and Siddhesh Poyarekar, and we agreed that it can be handled in a separate patch, and shouldn't block merging of this one. In addition, I've written a series of test cases for the pretty printers. Each lock type (mutex, condvar and rwlock) has two test programs, one for itself and other for its related 'attributes' object. Each test program in turn has a PExpect-based Python script that drives gdb and compares its output to the expected printer's. The tests run on the glibc host, which is assumed to have both gdb and PExpect; if either is absent the tests will fail with code 77 (UNSUPPORTED). For cross-testing you should use cross-test-ssh.sh as test-wrapper. I've tested the printers on both native builds and a cross build using a Beaglebone Black running Debian, with the build system's filesystem shared with the board through NFS. Finally, I've written a README that explains all this and more. * INSTALL: Regenerated. * Makeconfig: Add comments and whitespace to make the control flow clearer. (+link-printers-tests, +link-pie-printers-tests, CFLAGS-printers-tests, installed-rtld-LDFLAGS, built-rtld-LDFLAGS, link-libc-rpath, link-libc-tests-after-rpath-link, link-libc-printers-tests): New. (rtld-LDFLAGS, rtld-tests-LDFLAGS, link-libc-tests-rpath-link, link-libc-tests): Use the new variables as required. * Makerules ($(py-const)): New rule. generated: Add $(py-const). * README.pretty-printers: New file. * Rules (tests-printers-programs, tests-printers-out, py-env): New. (others): Depend on $(py-const). (tests): Depend on $(tests-printers-programs) or $(tests-printers-out), as required. Pass $(tests-printers) to merge-test-results.sh. * manual/install.texi: Add requirements for testing the pretty printers. * nptl/Makefile (gen-py-const-headers, pretty-printers, tests-printers, CFLAGS-test-mutexattr-printers.c CFLAGS-test-mutex-printers.c, CFLAGS-test-condattr-printers.c, CFLAGS-test-cond-printers.c, CFLAGS-test-rwlockattr-printers.c CFLAGS-test-rwlock-printers.c, tests-printers-libs): Define. * nptl/nptl-printers.py: New file. * nptl/nptl_lock_constants.pysym: Likewise. * nptl/test-cond-printers.c: Likewise. * nptl/test-cond-printers.py: Likewise. * nptl/test-condattr-printers.c: Likewise. * nptl/test-condattr-printers.py: Likewise. * nptl/test-mutex-printers.c: Likewise. * nptl/test-mutex-printers.py: Likewise. * nptl/test-mutexattr-printers.c: Likewise. * nptl/test-mutexattr-printers.py: Likewise. * nptl/test-rwlock-printers.c: Likewise. * nptl/test-rwlock-printers.py: Likewise. * nptl/test-rwlockattr-printers.c: Likewise. * nptl/test-rwlockattr-printers.py: Likewise. * scripts/gen-py-const.awk: Likewise. * scripts/test_printers_common.py: Likewise. * scripts/test_printers_exceptions.py: Likewise.
2016-12-08 21:29:02 +08:00
# Common tests for the MutexPrinter and MutexAttributesPrinter classes.
#
# Copyright (C) 2016 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
# <http://www.gnu.org/licenses/>.
import sys
from test_printers_common import *
test_source = sys.argv[1]
test_bin = sys.argv[2]
printer_files = sys.argv[3:]
printer_names = ['global glibc-pthread-locks']
PRIOCEILING = 42
try:
init_test(test_bin, printer_files, printer_names)
go_to_main()
check_debug_symbol('struct pthread_mutexattr')
mutex_var = 'mutex'
mutex_to_string = 'pthread_mutex_t'
attr_var = 'attr'
attr_to_string = 'pthread_mutexattr_t'
break_at(test_source, 'Set type')
continue_cmd() # Go to test_settype
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Type': 'Error check'})
test_printer(mutex_var, mutex_to_string, {'Type': 'Error check'})
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Type': 'Recursive'})
test_printer(mutex_var, mutex_to_string, {'Type': 'Recursive'})
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Type': 'Normal'})
test_printer(mutex_var, mutex_to_string, {'Type': 'Normal'})
break_at(test_source, 'Set robust')
continue_cmd() # Go to test_setrobust
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Robust': 'Yes'})
test_printer(mutex_var, mutex_to_string, {'Robust': 'Yes'})
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Robust': 'No'})
test_printer(mutex_var, mutex_to_string, {'Robust': 'No'})
break_at(test_source, 'Set shared')
continue_cmd() # Go to test_setpshared
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Shared': 'Yes'})
test_printer(mutex_var, mutex_to_string, {'Shared': 'Yes'})
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Shared': 'No'})
test_printer(mutex_var, mutex_to_string, {'Shared': 'No'})
break_at(test_source, 'Set protocol')
continue_cmd() # Go to test_setprotocol
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Protocol': 'Priority inherit'})
test_printer(mutex_var, mutex_to_string, {'Protocol': 'Priority inherit'})
next_cmd(2)
test_printer(attr_var, attr_to_string, {'Protocol': 'Priority protect'})
test_printer(mutex_var, mutex_to_string, {'Protocol': 'Priority protect'})
next_cmd(2)
test_printer(mutex_var, mutex_to_string, {'Priority ceiling':
str(PRIOCEILING)})
next_cmd()
test_printer(attr_var, attr_to_string, {'Protocol': 'None'})
test_printer(mutex_var, mutex_to_string, {'Protocol': 'None'})
continue_cmd() # Exit
except (NoLineError, pexpect.TIMEOUT) as exception:
print('Error: {0}'.format(exception))
result = FAIL
except DebugError as exception:
print(exception)
result = UNSUPPORTED
else:
print('Test succeeded.')
result = PASS
exit(result)