diff options
| -rw-r--r-- | .travis.yml | 2 | ||||
| -rw-r--r-- | Makefile.pre.in | 5 | ||||
| -rwxr-xr-x | Tools/scripts/smelly.py | 78 |
3 files changed, 82 insertions, 3 deletions
diff --git a/.travis.yml b/.travis.yml index 185846029c2..c207bd72da2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -91,6 +91,8 @@ script: - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then ./python Tools/scripts/patchcheck.py --travis $TRAVIS_PULL_REQUEST; fi # `-r -w` implicitly provided through `make buildbottest`. - make buildbottest TESTOPTS="-j4 -uall,-cpu" + # Check that all symbols exported by libpython start with "Py" or "_Py" + - make smelly notifications: email: false diff --git a/Makefile.pre.in b/Makefile.pre.in index e8df8f7355e..6dacb872e0c 100644 --- a/Makefile.pre.in +++ b/Makefile.pre.in @@ -1659,10 +1659,9 @@ distclean: clobber -o -name '*.bak' ')' \ -exec rm -f {} ';' -# Check for smelly exported symbols (not starting with Py/_Py) +# Check that all symbols exported by libpython start with "Py" or "_Py" smelly: @DEF_MAKE_RULE@ - nm -p $(LIBRARY) | \ - sed -n "/ [TDB] /s/.* //p" | grep -v "^_*Py" | sort -u; \ + $(RUNSHARED) ./$(BUILDPYTHON) Tools/scripts/smelly.py # Find files with funny names funny: diff --git a/Tools/scripts/smelly.py b/Tools/scripts/smelly.py new file mode 100755 index 00000000000..212eedb30bc --- /dev/null +++ b/Tools/scripts/smelly.py @@ -0,0 +1,78 @@ +#!/usr/bin/env python +# Script checking that all symbols exported by libpython start with Py or _Py + +import subprocess +import sys +import sysconfig + + +def get_exported_symbols(): + LIBRARY = sysconfig.get_config_var('LIBRARY') + if not LIBRARY: + raise Exception("failed to get LIBRARY") + + args = ('nm', '-p', LIBRARY) + print("+ %s" % ' '.join(args)) + proc = subprocess.run(args, stdout=subprocess.PIPE, universal_newlines=True) + if proc.returncode: + sys.stdout.write(proc.stdout) + sys.exit(proc.returncode) + + stdout = proc.stdout.rstrip() + if not stdout: + raise Exception("command output is empty") + return stdout + + +def get_smelly_symbols(stdout): + symbols = [] + ignored_symtypes = set() + for line in stdout.splitlines(): + # Split line '0000000000001b80 D PyTextIOWrapper_Type' + if not line: + continue + + parts = line.split(maxsplit=2) + if len(parts) < 3: + continue + + symtype = parts[1].strip() + # Ignore private symbols. + # + # If lowercase, the symbol is usually local; if uppercase, the symbol + # is global (external). There are however a few lowercase symbols that + # are shown for special global symbols ("u", "v" and "w"). + if symtype.islower() and symtype not in "uvw": + ignored_symtypes.add(symtype) + continue + + symbol = parts[-1] + if symbol.startswith(('Py', '_Py')): + continue + symbol = '%s (type: %s)' % (symbol, symtype) + symbols.append(symbol) + + if ignored_symtypes: + print("Ignored symbol types: %s" % ', '.join(sorted(ignored_symtypes))) + print() + return symbols + + +def main(): + nm_output = get_exported_symbols() + symbols = get_smelly_symbols(nm_output) + + if not symbols: + print("OK: no smelly symbol found") + sys.exit(0) + + symbols.sort() + for symbol in symbols: + print("Smelly symbol: %s" % symbol) + print() + print("ERROR: Found %s smelly symbols!" % len(symbols)) + sys.exit(1) + + +if __name__ == "__main__": + main() |