Changes in checkkconfigsymbols.py

87c7ee67 - scripts: handle BrokenPipeError for python scripts

Thu, 12 Jan 2023 02:30:06 +0000

scripts: handle BrokenPipeError for python scriptsIn the follow-up of commit fb3041d61f68 ("kbuild: fix SIGPIPE errormessage for AR=gcc-ar and AR=llvm-ar"), Kees Cook pointed out thattools should _not_ catch their own SIGPIPEs [1] [2].Based on his feedback, LLVM was fixed [3].However, Python's default behavior is to show noisy bracktrace whenSIGPIPE is sent. So, scripts written in Python are basically in thesame situation as the buggy llvm tools.Example: $ make -s allnoconfig $ make -s allmodconfig $ scripts/diffconfig .config.old .config | head -n1 -ALIX n Traceback (most recent call last): File "/home/masahiro/linux/scripts/diffconfig", line 132, in main() File "/home/masahiro/linux/scripts/diffconfig", line 130, in main print_config("+", config, None, b[config]) File "/home/masahiro/linux/scripts/diffconfig", line 64, in print_config print("+%s %s" % (config, new_value)) BrokenPipeError: [Errno 32] Broken pipePython documentation [4] notes how to make scripts die immediately andsilently: """ Piping output of your program to tools like head(1) will cause a SIGPIPE signal to be sent to your process when the receiver of its standard output closes early. This results in an exception like BrokenPipeError: [Errno 32] Broken pipe. To handle this case, wrap your entry point to catch this exception as follows: import os import sys def main(): try: # simulate large output (your code replaces this loop) for x in range(10000): print("y") # flush output here to force SIGPIPE to be triggered # while inside this try block. sys.stdout.flush() except BrokenPipeError: # Python flushes standard streams on exit; redirect remaining output # to devnull to avoid another BrokenPipeError at shutdown devnull = os.open(os.devnull, os.O_WRONLY) os.dup2(devnull, sys.stdout.fileno()) sys.exit(1) # Python exits with error code 1 on EPIPE if __name__ == '__main__': main() Do not set SIGPIPE’s disposition to SIG_DFL in order to avoid BrokenPipeError. Doing that would cause your program to exit unexpectedly whenever any socket connection is interrupted while your program is still writing to it. """Currently, tools/perf/scripts/python/intel-pt-events.py seems to be theonly script that fixes the issue that way.tools/perf/scripts/python/compaction-times.py uses another approachsignal.signal(signal.SIGPIPE, signal.SIG_DFL) but the Pythondocumentation clearly says "Don't do it".I cannot fix all Python scripts since there are so many.I fixed some in the scripts/ directory.[1]: https://lore.kernel.org/all/202211161056.1B9611A@keescook/[2]: https://github.com/llvm/llvm-project/issues/59037[3]: https://github.com/llvm/llvm-project/commit/4787efa38066adb51e2c049499d25b3610c0877b[4]: https://docs.python.org/3/library/signal.html#note-on-sigpipeSigned-off-by: Masahiro Yamada Reviewed-by: Nick Desaulniers Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/checkkconfigsymbols.py

aa0f5ea1 - checkkconfigsymbols.py: Remove skipping of help lines in parse_kconfig_file

Wed, 01 Sep 2021 16:49:52 +0000

checkkconfigsymbols.py: Remove skipping of help lines in parse_kconfig_fileWhen parsing Kconfig files to find symbol definitions and references,lines after a 'help' line are skipped until a new config definitionstarts.However, Kconfig statements can actually be after a help section, aslong as these have shallower indentation. These are skipped by theparser.This means that symbols referenced in this kind of statements areignored by this function and thus are not considered undefinedreferences in case the symbol is not defined.Remove the 'skip' logic entirely, as it is not needed if we just use theSTMT regex to find the end of help lines.However, this means that keywords that appear as part of the helpmessage (i.e. with the same indentation as the help lines) it will beconsidered as a reference/definition. This can happen now as well, butonly with REGEX_KCONFIG_DEF lines. Also, the keyword must have a SYMBOLafter it, which probably means that someone referenced a config in thehelp so it seems like a bonus :)The real solution is to keep track of the indentation when a the firsthelp line in encountered and then handle DEF and STMT lines only if theindentation is shallower.Signed-off-by: Ariel Marcovitch Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/checkkconfigsymbols.py

d62d5aed - checkkconfigsymbols.py: Forbid passing 'HEAD' to --commit

Wed, 01 Sep 2021 14:52:12 +0000

checkkconfigsymbols.py: Forbid passing 'HEAD' to --commitAs opposed to the --diff option, --commit can get ref names instead ofcommit hashes.When using the --commit option, the script resets the working directoryto the commit before the given ref, by adding '~' to the end of the ref.However, the 'HEAD' ref is relative, and so when the working directoryis reset to 'HEAD~', 'HEAD' points to what was 'HEAD~'. Then when thescript resets to 'HEAD' it actually stays in the same commit. In thiscase, the script won't report any cases because there is no diff betweenthe cases of the two refs.Prevent the user from using HEAD refs.A better solution might be to resolve the refs before doing thereset, but for now just disallow such refs.Signed-off-by: Ariel Marcovitch Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/checkkconfigsymbols.py

1439ebd2 - checkkconfigsymbols.py: Fix the '--ignore' option

Sun, 22 Aug 2021 19:22:01 +0000

checkkconfigsymbols.py: Fix the '--ignore' optionIt seems like the implementation of the --ignore option is broken.In check_symbols_helper, when going through the list of files, a file isadded to the list of source files to check if it matches the ignorepattern. Instead, as stated in the comment below this condition, thefile should be added if it doesn't match the pattern.This means that when providing an ignore pattern, the only files thatwill be checked will be the ones we want the ignore, in addition to theKconfig files that don't match the pattern (the check inparse_kconfig_files is done right)Signed-off-by: Ariel Marcovitch Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/checkkconfigsymbols.py

f70f74d1 - kconfig: remove '---help---' support

Wed, 17 Jun 2020 03:02:19 +0000

kconfig: remove '---help---' supportThe conversion is done. No more user of '---help---'.Cc: Ulf Magnusson Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/checkkconfigsymbols.py

4f19048f - treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 166

Mon, 27 May 2019 06:55:14 +0000

treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 166Based on 1 normalized pattern(s): licensed under the terms of the gnu gpl license version 2extracted by the scancode license scanner the SPDX license identifier GPL-2.0-onlyhas been chosen to replace the boilerplate/reference in 62 file(s).Signed-off-by: Thomas Gleixner Reviewed-by: Allison Randal Reviewed-by: Kate Stewart Reviewed-by: Richard Fontana Cc: linux-spdx@vger.kernel.orgLink: https://lkml.kernel.org/r/20190527070033.929121379@linutronix.deSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

3b28f4f2 - checkkconfigsymbols.py: support Kconfig's 'imply' statement

Thu, 02 Feb 2017 17:00:44 +0000

checkkconfigsymbols.py: support Kconfig's 'imply' statementSupport the new imply statement in Kconfig. The imply statement hasbeen added by commit 237e3ad0f195 ("Kconfig: Introduce the "imply"keyword") and is a weak version of a select, but the target symbol canstill be turned off.Signed-off-by: Andreas Ziegler Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

8e8e3331 - checkkconfigsymbols.py: don't sort similar symbols

Wed, 18 Jan 2017 12:08:19 +0000

checkkconfigsymbols.py: don't sort similar symbolsDon't sort the list of string-similar Kconfig symbols alphabetically topreserve the correct order of string similarity.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

0d18c192 - checkkconfigsymbols.py: support git's "^" syntax

Thu, 27 Oct 2016 12:34:57 +0000

checkkconfigsymbols.py: support git's "^" syntaxSupport git's "^" syntax for diffing two commits, for instance via"--diff HEAD^^^..HEAD".Signed-off-by: Michael Ellermann Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

2f9cc12b - checkkconfigsymbols: use arglist instead of cmd string

Sun, 28 Aug 2016 06:51:32 +0000

checkkconfigsymbols: use arglist instead of cmd stringSplitting a command string could lead to unintended arguments. Use anargument list in the execute() function instead.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

ef3f5543 - checkkconfigsymblos: consistent symbol terminology

Sun, 28 Aug 2016 06:51:31 +0000

checkkconfigsymblos: consistent symbol terminology'symbol' and 'feature' are used synonymously to refer to Kconfig symbols(configs, menus, etc.). Use the term 'symbol' to have a consistentterminology and to make the code more comprehensible.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

36c79c7f - checkkconfigsymbols.py: fix pylint and pep8 warnings

Sun, 28 Aug 2016 06:51:30 +0000

checkkconfigsymbols.py: fix pylint and pep8 warningsFix pylint and pep8 warnings to have a consistent syntax and style.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

14390e31 - checkkconfigsymbols: use ArgumentParser

Sun, 28 Aug 2016 06:51:29 +0000

checkkconfigsymbols: use ArgumentParserReplace the deprecated OptionParser with ArgumentParser, as recommendedby pylint.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

7c5227af - checkkconfigsymbols.py: port to Python 3

Sun, 28 Aug 2016 06:51:28 +0000

checkkconfigsymbols.py: port to Python 3Python 2 is slowly dying, so port the script to Python 3.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

f175ba17 - checkkconfigsymbols.py: avoid shell injection

Sat, 27 Aug 2016 08:59:07 +0000

checkkconfigsymbols.py: avoid shell injectionUse subprocess and set shell to False to avoid potential shellinjections.Reported-by: Bernd Dietzel Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

4c73c088 - checkkconfigsymbols.py: add --no-color option, don't print color to non-TTY

Tue, 05 Jul 2016 07:47:37 +0000

checkkconfigsymbols.py: add --no-color option, don't print color to non-TTYOnly print the ANSI colour escape codes if stdout is a TTY. Useful ifredirecting output to a file or piping to another script.Also add a new option, --no-color, if the user wants to disable colouroutput for whatever reason.Signed-off-by: Andrew Donnellan Acked-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

38cbfe4f - checkkconfigsymbols.py: Fix typo in help message

Thu, 31 Mar 2016 07:24:29 +0000

checkkconfigsymbols.py: Fix typo in help messageFix a typo in the help message for the -d parameter by removing one 'm'.Signed-off-by: Andreas Ziegler Acked-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

1b2c8414 - checkkconfigsymbols.py: find similar symbols

Thu, 26 Nov 2015 13:17:15 +0000

checkkconfigsymbols.py: find similar symbolsAdd support to find string-similar symbols. When option --sim SYM isspecified, checkkconfigsymbols.py will print at most 10 symbols definedin Kconfig that are string similar to SYM in the following format: Similar symbols: $COMMA_SEPARATED_LIST_OF_SYMBOLSNote, if no similar symbols are found it is indicated as follows: Similar symbols: no similar symbols foundSince the implemented functionality is also useful when searching theentire source or when diffing two commits, a list of similar symbols isprinted unconditionally with the other data. In order to make theoutput more readable, the format now looks as follows: $UNDEFINED_SYMBOL Referencing files: $COMMA_SEPARATED_LIST_OF_FILES Similar symbols: $COMMA_SEPARATED_LIST_OF_SYMBOLS [Optional with '--find'] Commits changing symbol: - $COMMIT_1_HASH ("$COMMIT_1_MESSAGE") - $COMMIT_2_HASH ("$COMMIT_2_MESSAGE") or - no commit foundSigned-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

e2042a8a - checkkconfigsymbols.py: multiprocessing of files

Thu, 15 Oct 2015 08:37:47 +0000

checkkconfigsymbols.py: multiprocessing of filesDistribute the parsing of source and Kconfig files on all availablecores to speed up processing.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py

0bd38ae3 - scripts/checkkconfigsymbols.py: support default statements

Mon, 27 Jul 2015 10:33:05 +0000

scripts/checkkconfigsymbols.py: support default statementsUntil now, checkkonfigsymbols.py did not check default statements forreferences on missing Kconfig symbols (i.e., undefined Kconfig options).Hence, add support to parse and check the Kconfig default statement.Signed-off-by: Valentin Rothberg Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/checkkconfigsymbols.py