Changes in coccicheck

13b25489 - kbuild: change working directory to external module directory with M=

Sun, 10 Nov 2024 01:34:33 +0000

kbuild: change working directory to external module directory with M=Currently, Kbuild always operates in the output directory of the kernel,even when building external modules. This increases the risk of externalmodule Makefiles attempting to write to the kernel directory.This commit switches the working directory to the external moduledirectory, allowing the removal of the $(KBUILD_EXTMOD)/ prefix fromsome build artifacts.The command for building external modules maintains backwardcompatibility, but Makefiles that rely on working in the kerneldirectory may break. In such cases, $(objtree) and $(srctree) shouldbe used to refer to the output and source directories of the kernel.The appearance of the build log will change as follows:[Before] $ make -C /path/to/my/linux M=/path/to/my/externel/module make: Entering directory '/path/to/my/linux' CC [M] /path/to/my/externel/module/helloworld.o MODPOST /path/to/my/externel/module/Module.symvers CC [M] /path/to/my/externel/module/helloworld.mod.o CC [M] /path/to/my/externel/module/.module-common.o LD [M] /path/to/my/externel/module/helloworld.ko make: Leaving directory '/path/to/my/linux'[After] $ make -C /path/to/my/linux M=/path/to/my/externel/module make: Entering directory '/path/to/my/linux' make[1]: Entering directory '/path/to/my/externel/module' CC [M] helloworld.o MODPOST Module.symvers CC [M] helloworld.mod.o CC [M] .module-common.o LD [M] helloworld.ko make[1]: Leaving directory '/path/to/my/externel/module' make: Leaving directory '/path/to/my/linux'Printing "Entering directory" twice is cumbersome. This will beaddressed later.Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/coccicheck

2b2d50bd - scripts: coccicheck: Use /usr/bin/env

Thu, 26 Jan 2023 21:56:12 +0000

scripts: coccicheck: Use /usr/bin/envIf bash is not located under /bin, coccicheck fails to run. In the realworld, this happens for instance when NixOS is used in the host. Instead,use /usr/bin/env to locate the executable binary for bash.Signed-off-by: Jarkko Sakkinen Tested-by: Deepak R Varma Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

180da5ef - scripts: coccicheck: Avoid warning about spurious escape

Fri, 13 Jan 2023 17:29:36 +0000

scripts: coccicheck: Avoid warning about spurious escapee.g.grep: warning: stray \ before -Signed-off-by: Peter Foley Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

2d63e6a3 - scripts: coccicheck: use "grep -E" instead of "egrep"

Wed, 21 Sep 2022 09:13:41 +0000

scripts: coccicheck: use "grep -E" instead of "egrep"The latest version of grep claims that egrep is now obsolete so the buildnow contains warnings that look like: egrep: warning: egrep is obsolescent; using grep -Efix this up by moving the vdso Makefile to use "grep -E" instead.Cc: Julia Lawall Cc: Nicolas Palix Cc: cocci@inria.frSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/coccicheck

f5b3553b - scripts: coccicheck: fix troubles on non-English builds

Tue, 18 May 2021 09:05:26 +0000

scripts: coccicheck: fix troubles on non-English buildsWhen LANG is not set to English, the logic which checks thenumber of CPUs fail, as the messages can be localized, andthe logic at: THREADS_PER_CORE=$(lscpu | grep "Thread(s) per core: " | tr -cd "[:digit:]")will not get the number of threads per core.This causes the script to not run properly, as it will producea warning: $ make coccicheck COCCI=$PWD/scripts/coccinelle/misc/add_namespace.cocci MODE=report drivers/media/ ./scripts/coccicheck: linha 93: [: número excessivo de argumentosFix it by forcing LANG=C when calling lscpu.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

d8f6e5c6 - scripts: coccicheck: Correct usage of make coccicheck

Tue, 24 Nov 2020 20:32:12 +0000

scripts: coccicheck: Correct usage of make coccicheckThe command "make coccicheck C=1 CHECK=scripts/coccicheck" results in theerror: ./scripts/coccicheck: line 65: -1: shift count out of rangeThis happens because every time the C variable is specified,the shell arguments need to be "shifted" in order to take onlythe last argument, which is the C file to test. These shell argumentsmostly comprise flags that have been set in the Makefile. However,when coccicheck is specified in the make command as a rule, thenumber of shell arguments is zero, thus passing the invalid value -1to the shift command, resulting in an error.Modify coccicheck to print correct usage of make coccicheck so as toavoid the error.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

33114c43 - kbuild: do not use scripts/ld-version.sh for checking spatch version

Sat, 12 Dec 2020 16:54:29 +0000

kbuild: do not use scripts/ld-version.sh for checking spatch versionscripts/ld-version.sh was, as its file name implies, originally intendedfor the GNU ld version, but is (ab)used for the spatch version too.Use 'sort -CV' for the version comparison, then coccicheck does not needto use scripts/ld-version.sh. Fix nsdeps as well.Signed-off-by: Masahiro Yamada Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

c5864560 - scripts: coccicheck: Change default condition for parallelism

Sun, 11 Oct 2020 10:29:42 +0000

scripts: coccicheck: Change default condition for parallelismCurrently, Coccinelle uses at most one thread per core by default inmachines with more than 2 hyperthreads. However, for systems with only 4hyperthreads, this does not improve performance.Modify coccicheck to use all available threads in machines withupto 4 hyperthreads.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

2f324dd8 - scripts: coccicheck: Add quotes to improve portability

Sun, 11 Oct 2020 10:28:43 +0000

scripts: coccicheck: Add quotes to improve portabilityWhile fetching the number of threads per core with lscpu,the [:digit:] set is used for translation of digits from 0-9.However, using [:digit:] instead of "[:digit:]" does not seemto work uniformly for some shell types and configurations(such as zsh).Therefore, modify coccicheck to use double quotes around the[:digit:] set for uniformity and better portability.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

e16a7c47 - scripts: coccicheck: Change default value for parallelism

Thu, 24 Sep 2020 11:26:08 +0000

scripts: coccicheck: Change default value for parallelismBy default, coccicheck utilizes all available threads to implementparallelisation. However, when all available threads are used,a decrease in performance is noted. The elapsed time is minimumwhen at most one thread per core is used.For example, on benchmarking the semantic patch kfree.cocci forusb/serial using hyperfine, the outputs obtained for J=5 and J=2are 1.32 and 1.90 times faster than those for J=10 and J=9respectively for two separate runs. For the larger drivers/stagingdirectory, minimium elapsed time is obtained for J=3 which is 1.86times faster than that for J=12. The optimal J value does notexceed 6 in any of the test runs. The benchmarks are run on a machinewith 6 cores, with 2 threads per core, i.e, 12 hyperthreads in all.To improve performance, modify coccicheck to use at most onlyone thread per core by default.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

a19d1358 - scripts: coccicheck: Improve error feedback when coccicheck fails

Sun, 13 Sep 2020 12:05:48 +0000

scripts: coccicheck: Improve error feedback when coccicheck failsCurrently, coccicheck fails with only the message "coccicheck failed"and the error code for the failure. To obtain the error logs,one needs to specify a debug file using the DEBUG_FILE option.Modify coccicheck to display error logs when it crashes unlessDEBUG_FILE is set, in which case, the error logs are stored inthe specified debug file.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

4b2bd20c - scripts: coccicheck: Add chain mode to list of modes

Wed, 05 Aug 2020 08:57:40 +0000

scripts: coccicheck: Add chain mode to list of modesThis patch adds chain mode to the list of available modes in coccicheck.Signed-off-by: Sumera Priyadarsini Signed-off-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

512ddf7d - coccicheck: return proper error code on fail

Fri, 10 Aug 2018 20:25:55 +0000

coccicheck: return proper error code on failIf coccicheck fails, it should return an error code distinct from zeroto signal about an internal problem. Current code instead of exiting withthe tool's error code returns the error code of 'echo "coccicheck failed"'which is almost always equals to zero, thus failing the original intentionof alerting about a problem. This patch fixes the code.Found by Linux Driver Verification project (linuxtesting.org).Signed-off-by: Denis Efremov Acked-by: Julia Lawall Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/coccicheck

1640eea3 - Coccinelle: coccicheck: fix typo

Thu, 01 Feb 2018 09:20:55 +0000

Coccinelle: coccicheck: fix typoCorrect spelling of "coccinelle".Signed-off-by: Julia Lawall Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/coccicheck

d7059ca0 - coccinelle: fix parallel build with CHECK=scripts/coccicheck

Tue, 14 Nov 2017 11:38:07 +0000

coccinelle: fix parallel build with CHECK=scripts/coccicheckThe command "make -j8 C=1 CHECK=scripts/coccicheck" produceslots of "coccicheck failed" error messages.Julia Lawall explained the Coccinelle behavior as follows:"The problem on the Coccinelle side is that it uses a subdirectorywith the name of the semantic patch to store standard output andstandard error for the different threads. I didn't want to use aname with the pid, so that one could easily find this informationwhile Coccinelle is running. Normally the subdirectory is cleanedup when Coccinelle completes, so there is only one of them at a time.Maybe it is best to just add the pid. There is the risk that thesesubdirectories will accumulate if Coccinelle crashes in a way suchthat they don't get cleaned up, but Coccinelle could print a warningif it detects this case, rather than failing."When scripts/coccicheck is used as CHECK tool and -j option is givento Make, the whole of build process runs in parallel. So, multipleprocesses try to get access to the same subdirectory.I notice spatch creates the subdirectory only when it runs in parallel(i.e. --jobs is given and is greater than 1).Setting NPROC=1 is a reasonable solution; spatch does not create thesubdirectory. Besides, ONLINE=1 mode takes a single file input foreach spatch invocation, so there is no reason to parallelize it inthe first place.Signed-off-by: Masahiro Yamada Acked-by: Julia Lawall List of files: /linux-6.15/scripts/coccicheck

cd1af7cf - coccinelle: fix verbose message about .cocci file being run

Thu, 26 Oct 2017 04:55:51 +0000

coccinelle: fix verbose message about .cocci file being runIf you run coccicheck with V=1 and COCCI=, you will see a strangepath to the semantic patch file. For example, run the following:$ make V=1 COCCI=scripts/coccinelle/free/kfree.cocci coccicheck [ snip ] The semantic patch that makes this report is available in scriptcoccinelle/free/kfree.cocci.Notice "s/" was dropped from "scripts/coccinelle/free/kfree.cocci".When running coccicheck without O=, $srctree is expanded to ".", whichrepresents one arbitrary character in the regular expression. Usingsed is not a good choice here. Strip $srctree/ simply without sed.Signed-off-by: Masahiro Yamada Acked-by: Nicolas Palix List of files: /linux-6.15/scripts/coccicheck

e0be348e - coccinelle: grep Options and Requires fields more precisely

Thu, 26 Oct 2017 04:50:38 +0000

coccinelle: grep Options and Requires fields more preciselyCurrently, the required version for badzero.cocci is picked up fromits "Comments:" line since it contains the word "Requires".Surprisingly, ld-version.sh can extract the version number from thestring "Requires Coccinelle version 1.0.0-rc20 or later", but thisexpectation is fragile. Fix the .cocci file. I removed "-rc20"because ld-version.sh cannot handle it.Make the coccicheck script to see exact patterns for "Options:" and"Requires:" in order to avoid accidental matching to what just happensto appear in comment lines.Signed-off-by: Masahiro Yamada Acked-by: Julia Lawall Acked-by: Nicolas Palix List of files: /linux-6.15/scripts/coccicheck

9ed07ada - Coccinelle: make DEBUG_FILE option more useful

Sun, 15 Oct 2017 09:55:53 +0000

Coccinelle: make DEBUG_FILE option more usefulMake coccicheck checked for the existence of DEBUG_FILE on each semanticpatch, and bailed if it already existed. This meant that DEBUG_FILE wasuseless for checking more than one semantic patch at a time. Now the checkis moved to the start of make coccicheck, and the 2> is changed to a 2>> toappend to the file on each semantic patch. Furthermore, the spatch commandthat is run for each semantic patch is also added to the DEBUG_FILE, tomake clear what each stdout trace corresponds to.Signed-off-by: Julia Lawall Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/coccicheck

b2441318 - License cleanup: add SPDX GPL-2.0 license identifier to files with no license

Wed, 01 Nov 2017 14:07:57 +0000

License cleanup: add SPDX GPL-2.0 license identifier to files with no licenseMany source files in the tree are missing licensing information, whichmakes it harder for compliance tools to determine the correct license.By default all files without license information are under the defaultlicense of the kernel, which is GPL version 2.Update the files which contain no license information with the 'GPL-2.0'SPDX license identifier. The SPDX identifier is a legally bindingshorthand, which can be used instead of the full boiler plate text.This patch is based on work done by Thomas Gleixner and Kate Stewart andPhilippe Ombredanne.How this work was done:Patches were generated and checked against linux-4.14-rc6 for a subset ofthe use cases: - file had no licensing information it it. - file was a */uapi/* one with no licensing information in it, - file was a */uapi/* one with existing licensing information,Further patches will be generated in subsequent months to fix up caseswhere non-standard license headers were used, and references to licensehad to be inferred by heuristics based on keywords.The analysis to determine which SPDX License Identifier to be applied toa file was done in a spreadsheet of side by side results from of theoutput of two independent scanners (ScanCode & Windriver) producing SPDXtag:value files created by Philippe Ombredanne. Philippe prepared thebase worksheet, and did an initial spot review of a few 1000 files.The 4.13 kernel was the starting point of the analysis with 60,537 filesassessed. Kate Stewart did a file by file comparison of the scannerresults in the spreadsheet to determine which SPDX license identifier(s)to be applied to the file. She confirmed any determination that was notimmediately clear with lawyers working with the Linux Foundation.Criteria used to select files for SPDX license identifier tagging was: - Files considered eligible had to be source code files. - Make and config files were included as candidates if they contained >5 lines of source - File already had some variant of a license header in it (even if <5 lines).All documentation files were explicitly excluded.The following heuristics were used to determine which SPDX licenseidentifiers to apply. - when both scanners couldn't find any license traces, file was considered to have no license information in it, and the top level COPYING file license applied. For non */uapi/* files that summary was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 11139 and resulted in the first patch in this series. If that file was a */uapi/* path one, it was "GPL-2.0 WITH Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 WITH Linux-syscall-note 930 and resulted in the second patch in this series. - if a file had some form of licensing information in it, and was one of the */uapi/* ones, it was denoted with the Linux-syscall-note if any GPL family license was found in the file or had no licensing in it (per prior point). Results summary: SPDX license identifier # files ---------------------------------------------------|------ GPL-2.0 WITH Linux-syscall-note 270 GPL-2.0+ WITH Linux-syscall-note 169 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17 LGPL-2.1+ WITH Linux-syscall-note 15 GPL-1.0+ WITH Linux-syscall-note 14 ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5 LGPL-2.0+ WITH Linux-syscall-note 4 LGPL-2.1 WITH Linux-syscall-note 3 ((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3 ((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1 and that resulted in the third patch in this series. - when the two scanners agreed on the detected license(s), that became the concluded license(s). - when there was disagreement between the two scanners (one detected a license but the other didn't, or they both detected different licenses) a manual inspection of the file occurred. - In most cases a manual inspection of the information in the file resulted in a clear resolution of the license that should apply (and which scanner probably needed to revisit its heuristics). - When it was not immediately clear, the license identifier was confirmed with lawyers working with the Linux Foundation. - If there was any question as to the appropriate license identifier, the file was flagged for further research and to be revisited later in time.In total, over 70 hours of logged manual review was done on thespreadsheet to determine the SPDX license identifiers to apply to thesource files by Kate, Philippe, Thomas and, in some cases, confirmationby lawyers working with the Linux Foundation.Kate also obtained a third independent scan of the 4.13 code base fromFOSSology, and compared selected files where the other two scannersdisagreed against that SPDX file, to see if there was new insights. TheWindriver scanner is based on an older version of FOSSology in part, sothey are related.Thomas did random spot checks in about 500 files from the spreadsheetsfor the uapi headers and agreed with SPDX license identifier in thefiles he inspected. For the non-uapi files Thomas did random spot checksin about 15000 files.In initial set of patches against 4.14-rc6, 3 files were found to havecopy/paste license identifier errors, and have been fixed to reflect thecorrect identifier.Additionally Philippe spent 10 hours this week doing a detailed manualinspection and review of the 12,461 patched files from the initial patchversion early this week with: - a full scancode scan run, collecting the matched texts, detected license ids and scores - reviewing anything where there was a license detected (about 500+ files) to ensure that the applied SPDX license was correct - reviewing anything where there was no detection but the patch license was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied SPDX license was correctThis produced a worksheet with 20 files needing minor correction. Thisworksheet was then exported into 3 different .csv files for thedifferent types of files to be modified.These .csv files were then reviewed by Greg. Thomas wrote a script toparse the csv files and add the proper SPDX tag to the file, in theformat that the file expected. This script was further refined by Gregbased on the output to detect more types of files automatically and todistinguish between header and source .c files (which need differentcomment types.) Finally Greg ran the script using the .csv files togenerate the patches.Reviewed-by: Kate Stewart Reviewed-by: Philippe Ombredanne Reviewed-by: Thomas Gleixner Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/coccicheck

1e01892e - scripts/coccicheck: Update reference for the corresponding documentation

Fri, 07 Oct 2016 14:06:15 +0000

scripts/coccicheck: Update reference for the corresponding documentationUse the current name (in a comment at the beginning of this script) forthe file which was converted to the documentation format "reStructuredText"in August 2016.Fixes: 4b9033a33494 ("docs: sphinxify coccinelle.txt and add it to dev-tools")Signed-off-by: Markus Elfring Acked-by: Julia Lawall Signed-off-by: Michal Marek List of files: /linux-6.15/scripts/coccicheck