Sparse based checker and rule proposal
Subsystems (2)
v2 cover Sparse based checker and rule proposal
Hello,
So it turns out that it is quite easy to implement the TST_RET/ERR check in Sparse. It compiles the code into an IR which is just the right abstraction for the test. It is also possible to inspect the AST with Sparse. It appears more difficult to inspect the AST before macros are expanded.
Sparse is not packaged as a shared library, but has few/no dependencies and is easy to compile. It seems like it was meant to be vendored. Including it as a git module seems reasonable to me. Please see tools/sparse/README.md.
There are still a lot of errors/noise when running 'make check' on the entire tree. These are mainly caused by old function definitions and such. They need to be fixed before the tool can be used properly.
Also I have tried to document the rule and created a list of rules. So this can also be taken as a formal proposal for the rule itself.
Thanks,
V2:
* Automatically download and build sparse.
* Only build sparse if "make check" is run. It is filtered from "make all".
* Move libtsc.h out of the realtime tests dir. Note that checking of metldown.c now fails because it uses a GCC builtin sparse does not recognize.
As mentioned above, there are various errors during checking that need fixing. For the most part these are legit errors (usually old style function definitions or redefining of symbols). With stuff like metldown I am tempted to filter it, but OTOH it looks relatively straight forward to add a builtin to Sparse upstream. I just need time to do it. First though I would like to get "make check" working on the library, so we can put that in CI.
Richard Palethorpe (8):
Add Sparse based checker and TST_RET/ERR check Add 'make check' to the build system
doc: Add rules and recommendations list
doc: Remind authors and maintainers to run make check
doc: Document TEST macro and state TST_RET/ERR rule LTP-002 Reference LTP-002 rule in Cocci scripts
API: Move libtsc.h from realtime tests include to tst_tsc.h API/tst_tsc: Add guards and remove some boilerplate
.gitmodules | 3 + Makefile | 8 + doc/c-test-api.txt | 47 ++++++ doc/library-api-writing-guidelines.txt | 14 ++ doc/maintainer-patch-review-checklist.txt | 2 +- doc/rules.tsv | 3 + doc/test-writing-guidelines.txt | 6 + include/mk/env_post.mk | 8 + include/mk/generic_leaf_target.inc | 5 +- include/mk/generic_trunk_target.inc | 7 +- include/mk/lib.mk | 3 + include/mk/module.mk | 2 + include/mk/rules.mk | 9 ++ include/mk/sparse.mk | 9 ++ include/mk/testcases.mk | 1 + .../include/libtsc.h => include/tst_tsc.h | 35 +---- .../coccinelle/libltp-test-macro-vars.cocci | 6 +- scripts/coccinelle/libltp-test-macro.cocci | 4 +- testcases/cve/Makefile | 2 - testcases/cve/meltdown.c | 2 +- testcases/open_posix_testsuite/Makefile | 4 + .../func/async_handler/async_handler_tsc.c | 3 +- .../func/measurement/preempt_timing.c | 3 +- .../realtime/func/measurement/rdtsc-latency.c | 3 +- tools/Makefile | 2 + tools/sparse/.gitignore | 1 + tools/sparse/Makefile | 27 ++++ tools/sparse/README.md | 38 +++++ tools/sparse/main.c | 148 ++++++++++++++++++ tools/sparse/sparse-src | 1 + 30 files changed, 362 insertions(+), 44 deletions(-) create mode 100644 doc/rules.tsv create mode 100644 include/mk/sparse.mk rename testcases/realtime/include/libtsc.h => include/tst_tsc.h (53%) create mode 100644 tools/sparse/.gitignore create mode 100644 tools/sparse/Makefile create mode 100644 tools/sparse/README.md create mode 100644 tools/sparse/main.c create mode 160000 tools/sparse/sparse-src
Signature · 1 line
2.31.1
PATCH v2 1/8 Add Sparse based checker and TST_RET/ERR check
Vendors in Sparse as a git module. Then uses it to check for stores to TST_RET/ERR within the library.
--- .gitmodules | 3 + tools/Makefile | 2 + tools/sparse/.gitignore | 1 + tools/sparse/Makefile | 27 ++++++++ tools/sparse/README.md | 38 +++++++++++ tools/sparse/main.c | 148 ++++++++++++++++++++++++++++++++++++++++ tools/sparse/sparse-src | 1 + 7 files changed, 220 insertions(+) create mode 100644 tools/sparse/.gitignore create mode 100644 tools/sparse/Makefile create mode 100644 tools/sparse/README.md create mode 100644 tools/sparse/main.c create mode 160000 tools/sparse/sparse-src
.gitmodules +3 -0
@@ -1,3 +1,6 @@ [submodule "testcases/kernel/mce-test"] path = testcases/kernel/mce-test url = git://git.kernel.org/pub/scm/linux/kernel/git/gong.chen/mce-test.git +[submodule "tools/sparse/sparse-src"] + path = tools/sparse/sparse-src + url = git://git.kernel.org/pub/scm/devel/sparse/sparse.git
tools/Makefile +2 -0
@@ -28,4 +28,6 @@ INSTALL_TARGETS := *.awk *.pl *.sh html_report_header.txt INSTALL_DIR := bin +FILTER_OUT_DIRS += sparse + include $(top_srcdir)/include/mk/generic_trunk_target.mk
tools/sparse/.gitignore new file +1 -0
@@ -0,0 +1 @@ +main
tools/sparse/Makefile new file +27 -0
@@ -0,0 +1,27 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (c) 2021 SUSE LLC <[email protected]> + +top_srcdir ?= ../.. + +include $(top_srcdir)/include/mk/env_pre.mk +include $(top_srcdir)/include/mk/functions.mk + +SPARSE_SRC ?= sparse-src + +$(SPARSE_SRC)/Makefile: +ifeq ($(SPARSE_SRC),sparse-src) + git submodule update --init +else + $(error "Can't find $(SPARSE_SRC)/Makefile") +endif + +$(SPARSE_SRC)/libsparse.a: $(SPARSE_SRC)/Makefile + $(MAKE) -C $(SPARSE_SRC) libsparse.a + +HOST_MAKE_TARGETS := main +MAKE_DEPS += $(SPARSE_SRC)/libsparse.a +HOST_CFLAGS += -I$(SPARSE_SRC) +HOST_LDLIBS += $(SPARSE_SRC)/libsparse.a + + +include $(top_srcdir)/include/mk/generic_leaf_target.mk
tools/sparse/README.md new file +38 -0
@@ -0,0 +1,38 @@ +# Sparse based linting + +This tool checks LTP test and library code for common problems. + +## Usage + +It is integrated with the LTP build system. Just run `make check` or +`make check-a_test01`, where `a_test01` is an arbitrary test +executable or object file. + +## Building + +The bad news is you must get and build Sparse[^1]. The good news is +that this only takes a minute and the build system does it for +you. Just try running `make check` as described above. + +However if you want to reuse an existing Sparse checkout. Then you can +do the following. Where `$SRC_PATH` is the path to the Sparse +directory. + +```sh +$ cd tools/sparse +$ make SPARSE_SRC=$SRC_PATH +``` +You can also manually fetch it via the git submodule + +```sh +$ cd tools/sparse +$ git submodule update --init +``` + +### Clang + +Note that while it is possible to build Sparse with Clang. This may +cause some issues. Namely `GCC_BASE` is set to the Clang resource +directory. This contains some headers Sparse can not parse. + +[1]: Many distributions have a Sparse package. This only contains some executables. There is no shared library
tools/sparse/main.c new file +148 -0
148 lines not on this page · raw message
tools/sparse/sparse-src new file +1 -0
@@ -0,0 +1 @@ +Subproject commit 8af2432923486c753ab52cae70b94ee684121080
Signature · 1 line
2.31.1
PATCH v2 1/8 Add Sparse based checker and TST_RET/ERR check
Hi Richie,
Quoted 2 lines
Vendors in Sparse as a git module. Then uses it to check for stores to TST_RET/ERR within the library.
I think submodules are a bit problematic, thus I'd prefer avoiding them. But whole thing is integrated nicely, thus:
...
Quoted 1 line
tools/sparse/README.md +0
-0
...
tools/sparse/README.md line 38
Quoted 7 lines
tools/sparse/README.md +7
-0+# Sparse based linting + +Note that while it is possible to build Sparse with Clang. This may +cause some issues. Namely `GCC_BASE` is set to the Clang resource +directory. This contains some headers Sparse can not parse. + +[1]: Many distributions have a Sparse package. This only contains some executables. There is no shared library
nit: missing dot here.
Quoted 7 lines
tools/sparse/main.c new file +1
-0@@ -0,0 +1,148 @@ +// SPDX-License-Identifier: GPL-2.0-or-later
tools/sparse/main.c line 11
Quoted 10 lines
tools/sparse/main.c new file +10
-0+/* +* Copyright (C) 2021 SUSE LLC <[email protected]> +* +* Sparse allows us to perform checks on the AST (struct symbol) or on +* a linearized representation. In the latter case we are given a set +* of entry points (functions) containing basic blocks of +* instructions. +* +* The basic blocks contain byte code in SSA form. This is similar to +* the the intermediate representation most compilers use during
nit: repeated the
tools/sparse/main.c line 13
Quoted 2 lines
tools/sparse/main.c new file +2
-0+* optimisation. +*/
The rest LGTM.
Kind regards,
Petr
PATCH v2 1/8 Add Sparse based checker and TST_RET/ERR check
In reply to Richard PalethorpeHi,
Quoted 11 lines · Richard Palethorpe via ltp
Vendors in Sparse as a git module. Then uses it to check for stores to TST_RET/ERR within the library.
Signed-off-by Richard Palethorpe <[email protected]>--- .gitmodules | 3 + tools/Makefile | 2 + tools/sparse/.gitignore | 1 + tools/sparse/Makefile | 27 ++++++++ tools/sparse/README.md | 38 +++++++++++ tools/sparse/main.c | 148 ++++++++++++++++++++++++++++++++++++++++
I think the name could be a bit better... sparse_main or ltp_checker or something, because a binary just called main could be confusing.
Otherwise good basis for additional checks and fixing the warnings emitted by sparse will allow use to raise the overall warning level. Hopefully at some point at least "-Wall -Werror" is possible.
Joerg
PATCH v2 1/8 Add Sparse based checker and TST_RET/ERR check
Hello Joerg,
Quoted 15 lines · Joerg Vehlow
Hi,
Quoted 11 lines · Richard Palethorpe via ltp
Vendors in Sparse as a git module. Then uses it to check for stores to TST_RET/ERR within the library.
Signed-off-by Richard Palethorpe <[email protected]>--- .gitmodules | 3 + tools/Makefile | 2 + tools/sparse/.gitignore | 1 + tools/sparse/Makefile | 27 ++++++++ tools/sparse/README.md | 38 +++++++++++ tools/sparse/main.c | 148 ++++++++++++++++++++++++++++++++++++++++
Quoted 2 lines
I think the name could be a bit better...
sparse_mainorltp_checkeror something, because a binary just called main could be confusing.
Sure or maybe sparse-ltp?
That would fit with upstream IMO.
Quoted 6 lines
Otherwise good basis for additional checks and fixing the warnings emitted by sparse will allow use to raise the overall warning level. Hopefully at some point at least "-Wall -Werror" is possible.
Joerg
Yes, I would really like to see -Wall enabled by default. Also Sparse can maybe help highlight wierd crap only GCC and Clang accept.
Signature · 2 lines
Thank you, Richard.
PATCH v2 1/8 Add Sparse based checker and TST_RET/ERR check
In reply to Richard PalethorpeHi!
Looks good now, if I'm reading it correctly the 'make check' will get fetch the submodule sources and build everything.
With the main.c file name changed to something reasonable:
Signature · 2 lines
Cyril Hrubis [email protected]
PATCH v2 2/8 Add 'make check' to the build system
In reply to Richard PalethorpeAllows one to run 'make check' or 'make check-$TARGET'. Which will execute the CHECK tool with that target's CC arguments and CHECK_FLAGS. By default the check tool is tools/sparse/main.
--- Makefile | 8 ++++++++ include/mk/env_post.mk | 8 ++++++++ include/mk/generic_leaf_target.inc | 5 ++++- include/mk/generic_trunk_target.inc | 7 ++++++- include/mk/lib.mk | 3 +++ include/mk/module.mk | 2 ++ include/mk/rules.mk | 9 +++++++++ include/mk/sparse.mk | 9 +++++++++ include/mk/testcases.mk | 1 + testcases/open_posix_testsuite/Makefile | 4 ++++ 10 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 include/mk/sparse.mk
Makefile +8 -0
@@ -79,6 +79,7 @@ BOOTSTRAP_TARGETS := $(sort $(COMMON_TARGETS) $(CLEAN_TARGETS) $(INSTALL_TARGETS CLEAN_TARGETS := $(addsuffix -clean,$(CLEAN_TARGETS)) INSTALL_TARGETS := $(addsuffix -install,$(INSTALL_TARGETS)) MAKE_TARGETS := $(addsuffix -all,$(filter-out lib,$(COMMON_TARGETS))) +CHECK_TARGETS := $(addsuffix -check,testcases lib) # There's no reason why we should run `all' twice. Otherwise we're just wasting # 3+ mins of useful CPU cycles on a modern machine, and even more time on an
@@ -108,6 +109,10 @@ $(MAKE_TARGETS) include-all lib-all libs-all: $(MAKE) -C "$(subst -all,,$@)" \ -f "$(abs_top_srcdir)/$(subst -all,,$@)/Makefile" all +$(CHECK_TARGETS): tools-all + $(MAKE) -C "$(subst -check,,$@)" \ + -f "$(abs_top_srcdir)/$(subst -check,,$@)/Makefile" check + # Let's not conflict with ac-clean, maintainer-clean, etc, so. $(filter-out include-clean,$(CLEAN_TARGETS)):: -$(MAKE) -C "$(subst -clean,,$@)" \
@@ -189,6 +194,9 @@ INSTALL_TARGETS += $(addprefix $(DESTDIR)/$(bindir)/,$(BINDIR_INSTALL_SCRIPTS)) $(INSTALL_TARGETS): $(INSTALL_DIR) $(DESTDIR)/$(bindir) +.PHONY: check +check: $(CHECK_TARGETS) + ## Install install: $(INSTALL_TARGETS)
include/mk/env_post.mk +8 -0
@@ -89,6 +89,14 @@ $(error You must define $$(prefix) before executing install) endif # END $(filter-out install,$(MAKECMDGOALS)),$(MAKECMDGOALS) endif +CHECK_TARGETS ?= $(addprefix check-,$(notdir $(patsubst %.c,%,$(sort $(wildcard $(abs_srcdir)/*.c))))) +CHECK_TARGETS := $(filter-out $(addprefix check-, $(FILTER_OUT_MAKE_TARGETS)), $(CHECK_TARGETS)) +CHECK ?= $(abs_top_srcdir)/tools/sparse/main + +ifeq ($(CHECK),$(abs_top_srcdir)/tools/sparse/main) +CHECK_DEPS += $(CHECK) +endif + include $(top_srcdir)/include/mk/rules.mk endif
include/mk/generic_leaf_target.inc +4 -1
@@ -92,7 +92,7 @@ # INSTALL_DIR := $(libdir) # -.PHONY: all clean install +.PHONY: all clean install check ifneq ($(strip $(MAKE_TARGETS)),) $(MAKE_TARGETS) += $(HOST_MAKE_TARGETS)
@@ -109,4 +109,7 @@ $(INSTALL_FILES): | $(INSTALL_DEPS) install: $(INSTALL_FILES) +$(CHECK_TARGETS): | $(CHECK_DEPS) +check: $(CHECK_TARGETS) + # vim: syntax=make
include/mk/generic_trunk_target.inc +6 -1
@@ -48,7 +48,7 @@ include $(top_srcdir)/include/mk/functions.mk -RECURSIVE_TARGETS ?= all install +RECURSIVE_TARGETS ?= all install check $(eval $(get_make_dirs))
@@ -68,6 +68,9 @@ $(INSTALL_FILES): | $(INSTALL_DEPS) trunk-install: $(INSTALL_FILES) +$(CHECK_TARGETS): | $(CHECK_DEPS) +trunk-check: $(CHECK_TARGETS) + # Avoid creating duplicate .PHONY references to all, clean, and install. IIRC, # I've seen some indeterministic behavior when one does this in the past with # GNU Make...
@@ -108,4 +111,6 @@ else endif endif +check: trunk-check + # vim: syntax=make
include/mk/lib.mk +3 -0
@@ -26,6 +26,7 @@ # Makefile to include for libraries. include $(top_srcdir)/include/mk/env_pre.mk +include $(top_srcdir)/include/mk/sparse.mk INSTALL_DIR := $(libdir)
@@ -57,6 +58,8 @@ LIBSRCS := $(filter-out $(FILTER_OUT_LIBSRCS),$(LIBSRCS)) LIBOBJS := $(LIBSRCS:.c=.o) +CHECK_TARGETS := $(addprefix check-,$(notdir $(LIBSRCS:.c=))) + $(LIB): $(notdir $(LIBOBJS)) @if [ -z "$(strip $^)" ] ; then \ echo "Cowardly refusing to create empty archive"; \
include/mk/module.mk +2 -0
@@ -47,6 +47,8 @@ endif CLEAN_TARGETS += .dep_modules *.mod built-in.a +CHECK_TARGETS := $(filter-out %.ko, $(CHECK_TARGETS)) + MODULE_SOURCES := $(patsubst %.ko,%.c,$(filter %.ko, $(MAKE_TARGETS))) # Ignoring the exit status of commands is done to be forward compatible with
include/mk/rules.mk +9 -0
@@ -37,3 +37,12 @@ else @$(CC) $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) $^ $(LTPLDLIBS) $(LDLIBS) -o $@ @echo CC $(target_rel_dir)$@ endif + +.PHONY: $(CHECK_TARGETS) +$(CHECK_TARGETS): check-%: %.c +ifdef VERBOSE + $(CHECK) $(CHECK_FLAGS) $(CPPFLAGS) $(CFLAGS) $< +else + @$(CHECK) $(CHECK_FLAGS) $(CPPFLAGS) $(CFLAGS) $< + @echo CHECK $(target_rel_dir)$< +endif
include/mk/sparse.mk new file +9 -0
@@ -0,0 +1,9 @@ +# Rules to make sparse tool(s) for inclusion in lib and testcases Makefiles + +SPARSE_DIR:= $(abs_top_builddir)/tools/sparse + +$(SPARSE_DIR)/main: $(SPARSE_DIR) + $(MAKE) -C "$^" all + +$(SPARSE_DIR): %: + mkdir -p "$@"
include/mk/testcases.mk +1 -0
@@ -22,6 +22,7 @@ include $(top_srcdir)/include/mk/env_pre.mk include $(top_srcdir)/include/mk/functions.mk +include $(top_srcdir)/include/mk/sparse.mk APICMDS_DIR := $(abs_top_builddir)/tools/apicmds
testcases/open_posix_testsuite/Makefile +4 -0
@@ -104,3 +104,7 @@ $(CRITICAL_MAKEFILE): \ $(top_srcdir)/LDFLAGS \ $(top_srcdir)/LDLIBS @$(MAKE) generate-makefiles + +.PHONY: check +check: + @echo "Checker not yet supported by Open POSIX testsuite"
Signature · 1 line
2.31.1
PATCH v2 2/8 Add 'make check' to the build system
Hi Richie,
Quoted 3 lines
Allows one to run 'make check' or 'make check-$TARGET'. Which will execute the CHECK tool with that target's CC arguments and
CHECK_FLAGS. By default the check tool istools/sparse/main.
LGTM.
Quoted 1 line
Only build sparse if "make check" is run. It is filtered from "make all".
+1
Kind regards,
Petr
PATCH v2 3/8 doc: Add rules and recommendations list
In reply to Richard PalethorpeCreate a list of rules which are feasible to check automatically. The file is a table of tab separated values. It's intended to be machine readable.
For now there is just an ID column, with IDs that look similar to CWE IDs or CVEs. For now these can just be used with 'git grep'. Also there is a description column.
Clearly this is not an exhaustive list. It just contains a library rule already stated in the guide and the issue Sparse checks for.
--- doc/rules.tsv | 3 +++ doc/test-writing-guidelines.txt | 5 +++++ 2 files changed, 8 insertions(+) create mode 100644 doc/rules.tsv
doc/rules.tsv new file +3 -0
@@ -0,0 +1,3 @@ +ID DESCRIPTION +LTP-001 Library source files have tst_ prefix +LTP-002 TST_RET and TST_ERR are never modified by test library functions
doc/test-writing-guidelines.txt +5 -0
@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines]. +Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it +will display these IDs as a reference. + 1. Guide to clean and understandable code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.31.1
PATCH v2 3/8 doc: Add rules and recommendations list
Hi Richie,
obviously correct.
doc/test-writing-guidelines.txt NOTE: See also · line 15
Quoted 8 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +3
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines]. +Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it
nit: I'd make 'doc/rules.tsv' as link (for lazy people like me):
https://github.com/linux-test-project/ltp/tree/master/doc/rules.tsv[doc/rules.tsv]
Kind regards,
Petr
PATCH v2 3/8 doc: Add rules and recommendations list
Hello Petr,
Quoted 10 lines · Petr Vorel
Hi Richie,
obviously correct.
Reviewed-by Petr Vorel <[email protected]>Quoted 4 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +0
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].
Quoted 5 lines
doc/test-writing-guidelines.txt NOTE: See also · line 15
Quoted 3 lines
doc/test-writing-guidelines.txt +3
-0+Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' itnit: I'd make 'doc/rules.tsv' as link (for lazy people like me):
https://github.com/linux-test-project/ltp/tree/master/doc/rules.tsv[doc/rules.tsv]
+1
Although I was wondering if it could be formatted and displayed inline somehow?
Quoted 3 lines
Kind regards,
Petr
Signature · 2 lines
Thank you, Richard.
PATCH v2 3/8 doc: Add rules and recommendations list
Hi Richie,
Quoted 20 lines
Hello Petr,
Quoted 10 lines · Petr Vorel
Hi Richie,
obviously correct.
Reviewed-by Petr Vorel <[email protected]>Quoted 4 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +0
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].Quoted 5 lines
doc/test-writing-guidelines.txt NOTE: See also · line 15
Quoted 3 lines
doc/test-writing-guidelines.txt +3
-0+Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' itnit: I'd make 'doc/rules.tsv' as link (for lazy people like me):
https://github.com/linux-test-project/ltp/tree/master/doc/rules.tsv[doc/rules.tsv]
Quoted 3 lines
+1
Although I was wondering if it could be formatted and displayed inline somehow?
I'm not aware of it :(.
Kind regards,
Petr
Quoted 2 lines
Quoted 2 lines
Kind regards,
Petr
PATCH v2 3/8 doc: Add rules and recommendations list
In reply to Richard PalethorpeHi Richie,
doc/test-writing-guidelines.txt NOTE: See also · line 17
Quoted 10 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +5
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines]. +Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it +will display these IDs as a reference. +
Actually text is on the top. I suppose, you probably planned to put this into "2.1 C coding style".
Kind regards,
Petr
Quoted 2 lines
doc/test-writing-guidelines.txt +0
-01. Guide to clean and understandable code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PATCH v2 3/8 doc: Add rules and recommendations list
Hello Petr,
Quoted 7 lines · Petr Vorel
Hi Richie,
Quoted 4 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +0
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].
Quoted 7 lines
doc/test-writing-guidelines.txt NOTE: See also · line 17
Quoted 5 lines
doc/test-writing-guidelines.txt +5
-0+Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it +will display these IDs as a reference. +Actually text is on the top. I suppose, you probably planned to put this into "2.1 C coding style".
I'm not sure where to put it. The coding style is mostly about syntax and formatting. The rules file can state anything machine checkable, so that can include shell, directory structure, what functions are used etc.
Quoted 6 lines
Kind regards,
PetrQuoted 2 lines
doc/test-writing-guidelines.txt +0
-01. Guide to clean and understandable code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 2 lines
Thank you, Richard.
PATCH v2 3/8 doc: Add rules and recommendations list
Hi Richie,
Quoted 19 lines
Hello Petr,
Quoted 7 lines · Petr Vorel
Hi Richie,
Quoted 4 lines
+++
b/doc/test-writing-guidelines.txtdoc/test-writing-guidelines.txt +0
-0@@ -10,6 +10,11 @@ NOTE: See also https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API], https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].Quoted 7 lines
doc/test-writing-guidelines.txt NOTE: See also · line 17
Quoted 5 lines
doc/test-writing-guidelines.txt +5
-0+Rules and recommendations which are "machine checkable" should be +tagged with an ID like +LTP-XXX+. There will be a corresponding entry +in 'doc/rules.tsv'. When you run 'make check' or 'make check-test' it +will display these IDs as a reference. +Actually text is on the top. I suppose, you probably planned to put this into "2.1 C coding style".
Quoted 4 lines
I'm not sure where to put it. The coding style is mostly about syntax and formatting. The rules file can state anything machine checkable, so that can include shell, directory structure, what functions are used etc.
Not sure myself myself. But my note was that you put it below NOTE, above "1. Guide to clean and understandable code" which looks strange to me.
But not a big deal with it, just a nit.
Kind regards,
Petr
Quoted 5 lines
Quoted 5 lines
Kind regards,
PetrQuoted 2 lines
doc/test-writing-guidelines.txt +0
-01. Guide to clean and understandable code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PATCH v2 4/8 doc: Remind authors and maintainers to run make check
In reply to Richard Palethorpe--- doc/maintainer-patch-review-checklist.txt | 2 +- doc/test-writing-guidelines.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-)
doc/maintainer-patch-review-checklist.txt +1 -1
@@ -39,7 +39,7 @@ New test should * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API] * Test binaries are added into corresponding '.gitignore' files * Check coding style with - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check` (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style]) * Docparse documentation * If a test is a regression test it should include tags
doc/test-writing-guidelines.txt +1 -0
@@ -308,6 +308,7 @@ NOTE: See also 3. The runtest entires are in place 4. Test binaries are added into corresponding '.gitignore' files 5. Patches apply over the latest git +6. 'make check' does not emit any warnings 6.1 About .gitignore files ~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.31.1
PATCH v2 4/8 doc: Remind authors and maintainers to run make check
Hi Richie,
Quoted 11 lines
Signed-off-by Richard Palethorpe <[email protected]>--- doc/maintainer-patch-review-checklist.txt | 2 +- doc/test-writing-guidelines.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-)doc/maintainer-patch-review-checklist.txt +0
-0
doc/maintainer-patch-review-checklist.txt New test should · line 43
Quoted 6 lines
doc/maintainer-patch-review-checklist.txt +1
-1@@ -39,7 +39,7 @@ New test should * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API] * Test binaries are added into corresponding '.gitignore' files * Check coding style with - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check` (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
+1
"131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link should be #21-c-coding-style.
Kind regards,
Petr
doc/test-writing-guidelines.txt NOTE: See also · line 311
Quoted 11 lines
doc/maintainer-patch-review-checklist.txt +0
-0* Docparse documentation * If a test is a regression test it should include tagsdoc/test-writing-guidelines.txt +1
-0@@ -308,6 +308,7 @@ NOTE: See also 3. The runtest entires are in place 4. Test binaries are added into corresponding '.gitignore' files 5. Patches apply over the latest git +6. 'make check' does not emit any warnings
+1
Kind regards,
Petr
PATCH v2 4/8 doc: Remind authors and maintainers to run make check
Hello Petr,
Quoted 21 lines · Petr Vorel
Hi Richie,
Quoted 11 lines
Signed-off-by Richard Palethorpe <[email protected]>--- doc/maintainer-patch-review-checklist.txt | 2 +- doc/test-writing-guidelines.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-)doc/maintainer-patch-review-checklist.txt +0
-0doc/maintainer-patch-review-checklist.txt New test should · line 43
Quoted 6 lines
doc/maintainer-patch-review-checklist.txt +1
-1@@ -39,7 +39,7 @@ New test should * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API] * Test binaries are added into corresponding '.gitignore' files * Check coding style with - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check` (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])+1
Quoted 2 lines
"131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link should be #21-c-coding-style.
You may want to do a quick-fix commit for that, because it is not part of my patch. Although I can add it ofcourse.
Quoted 19 lines
Kind regards,
Petrdoc/test-writing-guidelines.txt NOTE: See also · line 311
Quoted 11 lines
doc/maintainer-patch-review-checklist.txt +0
-0* Docparse documentation * If a test is a regression test it should include tagsdoc/test-writing-guidelines.txt +1
-0@@ -308,6 +308,7 @@ NOTE: See also 3. The runtest entires are in place 4. Test binaries are added into corresponding '.gitignore' files 5. Patches apply over the latest git +6. 'make check' does not emit any warnings+1
Kind regards,
Petr
Signature · 2 lines
Thank you, Richard.
PATCH v2 4/8 doc: Remind authors and maintainers to run make check
Quoted 25 lines
Hello Petr,
Quoted 20 lines · Petr Vorel
Hi Richie,
Quoted 11 lines
Signed-off-by Richard Palethorpe <[email protected]>--- doc/maintainer-patch-review-checklist.txt | 2 +- doc/test-writing-guidelines.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-)doc/maintainer-patch-review-checklist.txt +0
-0doc/maintainer-patch-review-checklist.txt New test should · line 43
Quoted 6 lines
doc/maintainer-patch-review-checklist.txt +1
-1@@ -39,7 +39,7 @@ New test should * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API] * Test binaries are added into corresponding '.gitignore' files * Check coding style with - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check` (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])+1
Quoted 5 lines
Quoted 2 lines
"131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link should be #21-c-coding-style.
You may want to do a quick-fix commit for that, because it is not part of my patch. Although I can add it ofcourse.
I'm sorry, I overlooked that it does not have ^+. Thanks for info!
Kind regards,
Petr
PATCH v2 5/8 doc: Document TEST macro and state TST_RET/ERR rule LTP-002
In reply to Richard PalethorpeThere are cases where these variables can be safely used by the library. However it is a difficult problem to identify these cases automatically.
Identifying any library code which uses them is relatively easy. In fact it is easier to automate it than by code review. Because it is such a boring thing to repeatedly look for and comment on.
If a test library function needs these variables it can recreate its own private copies.
--- doc/c-test-api.txt | 47 ++++++++++++++++++++++++++ doc/library-api-writing-guidelines.txt | 14 ++++++++ 2 files changed, 61 insertions(+)
doc/c-test-api.txt +47 -0
@@ -767,6 +767,53 @@ LTP_ALIGN(x, a) Aligns the x to be next multiple of a. The a must be power of 2. +[source,c] +------------------------------------------------------------------------------- +TEST(socket(AF_INET, SOCK_RAW, 1)); +if (TST_RET > -1) { + tst_res(TFAIL, "Created raw socket"); + SAFE_CLOSE(TST_RET); +} else if (TST_ERR != EPERM) { + tst_res(TFAIL | TTERRNO, + "Failed to create socket for wrong reason"); +} else { + tst_res(TPASS | TTERRNO, "Didn't create raw socket"); +} +------------------------------------------------------------------------------- + +The +TEST+ macro sets +TST_RET+ to its argument's return value and ++TST_ERR+ to +errno+. The +TTERNO+ flag can be used to print the error +number's symbolic value. + +No LTP library function or macro, except those in 'tst_test_macros.h', +will write to these variables (rule 'LTP-002'). So their values will +not be changed unexpectedly. + +[source,c] +------------------------------------------------------------------------------- +TST_EXP_POSITIVE(wait(&status)); + +if (!TST_PASS) + return; +------------------------------------------------------------------------------- + +If the return value of 'wait' is positive. This macro will print a +pass result and set +TST_PASS+ appropriately. If the return value is +zero or negative, then it will print fail. + +This and similar macros take optional variadic arguments. These begin +with a format string and then appropriate values to be formatted. + +[source,c] +------------------------------------------------------------------------------- +TST_EXP_PASS(chown("a/file", uid, gid), "chown(%s,%d,%d)", + "a/file", uid, gid); +------------------------------------------------------------------------------- + +Expects +chown+ to return 0 and emits a pass or a fail. The arguments +to +chown+ will be printed in either case. There are many similar +macros, please see 'tst_test_macros.h'. + 1.13 Filesystem type detection and skiplist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/library-api-writing-guidelines.txt +14 -0
@@ -21,10 +21,24 @@ Don't forget to update docs when you change the API. 2. C API -------- +2.1 LTP-001: Sources have tst_ prefix +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + API source code is in headers `include/*.h`, `include/lapi/*.h` (backward compatibility for old kernel and libc) and C sources in `lib/*.c`. Files have 'tst_' prefix. +2.2 LTP-002: TST_RET and TST_ERR are not modified +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The test author is guaranteed that the test API will not modify these +variables. This prevents silent errors where the return value and +errno are overwritten before the test has chance to check them. + +The macros which are clearly intended to update these variables. That +is +TEST+ and those in 'tst_test_macros.h'. Are of course allowed to +update these variables. + 3. Shell API ------------
Signature · 1 line
2.31.1
PATCH v2 5/8 doc: Document TEST macro and state TST_RET/ERR rule LTP-002
Hi Richie,
generally LGTM, with comments below.
Quoted 32 lines
There are cases where these variables can be safely used by the library. However it is a difficult problem to identify these cases automatically.
Identifying any library code which uses them is relatively easy. In fact it is easier to automate it than by code review. Because it is such a boring thing to repeatedly look for and comment on.
If a test library function needs these variables it can recreate its own private copies.
Signed-off-by Richard Palethorpe <[email protected]>--- doc/c-test-api.txt | 47 ++++++++++++++++++++++++++ doc/library-api-writing-guidelines.txt | 14 ++++++++ 2 files changed, 61 insertions(+)doc/c-test-api.txt +7
-0@@ -767,6 +767,53 @@ LTP_ALIGN(x, a) Aligns the x to be next multiple of a. The a must be power of 2. +[source,c] +------------------------------------------------------------------------------- +TEST(socket(AF_INET, SOCK_RAW, 1)); +if (TST_RET > -1) { + tst_res(TFAIL, "Created raw socket"); + SAFE_CLOSE(TST_RET); +} else if (TST_ERR != EPERM) {
doc/c-test-api.txt LTP_ALIGN(x, a) · line 786
Quoted 10 lines
doc/c-test-api.txt +10
-0+ tst_res(TFAIL | TTERRNO, + "Failed to create socket for wrong reason"); +} else { + tst_res(TPASS | TTERRNO, "Didn't create raw socket"); +} +------------------------------------------------------------------------------- + +The +TEST+ macro sets +TST_RET+ to its argument's return value and ++TST_ERR+ to +errno+. The +TTERNO+ flag can be used to print the error +number's symbolic value.
Nice examples, but we already talk about TEST() in "1.2 Basic test interface". Should we put it there? If not, I'd add links to both places to the other (separate effort).
Also I suppose whole thing could be simplified with TST_EXP_FAIL2().
doc/c-test-api.txt LTP_ALIGN(x, a) · line 797
Quoted 11 lines
doc/c-test-api.txt +11
-0+ +No LTP library function or macro, except those in 'tst_test_macros.h', +will write to these variables (rule 'LTP-002'). So their values will +not be changed unexpectedly. + +[source,c] +------------------------------------------------------------------------------- +TST_EXP_POSITIVE(wait(&status)); + +if (!TST_PASS) + return;
IMHO This is really for "1.2 Basic test interface".
Quoted 8 lines
doc/c-test-api.txt +8
-0+------------------------------------------------------------------------------- + +If the return value of 'wait' is positive. This macro will print a +pass result and set +TST_PASS+ appropriately. If the return value is +zero or negative, then it will print fail. + +This and similar macros take optional variadic arguments. These begin +with a format string and then appropriate values to be formatted.
doc/c-test-api.txt LTP_ALIGN(x, a) · line 815
Quoted 10 lines
doc/c-test-api.txt +10
-0+ +[source,c] +------------------------------------------------------------------------------- +TST_EXP_PASS(chown("a/file", uid, gid), "chown(%s,%d,%d)", + "a/file", uid, gid); +------------------------------------------------------------------------------- + +Expects +chown+ to return 0 and emits a pass or a fail. The arguments +to +chown+ will be printed in either case. There are many similar +macros, please see 'tst_test_macros.h'.
And this as well.
...
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 25
Quoted 10 lines
doc/library-api-writing-guidelines.txt +2
-0@@ -21,10 +21,24 @@ Don't forget to update docs when you change the API. 2. C API -------- +2.1 LTP-001: Sources have tst_ prefix +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1
Quoted 4 lines
doc/library-api-writing-guidelines.txt +1
-0+ API source code is in headers `include/*.h`, `include/lapi/*.h` (backward compatibility for old kernel and libc) and C sources in `lib/*.c`. Files have 'tst_' prefix.
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 39
Quoted 10 lines
doc/library-api-writing-guidelines.txt +9
-0+2.2 LTP-002: TST_RET and TST_ERR are not modified +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The test author is guaranteed that the test API will not modify these +variables. This prevents silent errors where the return value and +errno are overwritten before the test has chance to check them. + +The macros which are clearly intended to update these variables. That +is +TEST+ and those in 'tst_test_macros.h'. Are of course allowed to
nit: Maybe +TEST()+ (it's a "function", unlike "variables" TST_RET TST_ERR)?
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 40
Quoted 1 line
doc/library-api-writing-guidelines.txt +1
-0+update these variables.
Kind regards,
Petr
PATCH v2 5/8 doc: Document TEST macro and state TST_RET/ERR rule LTP-002
Hello Petr,
Quoted 44 lines · Petr Vorel
Hi Richie,
generally LGTM, with comments below.
Reviewed-by Petr Vorel <[email protected]>Quoted 38 lines
There are cases where these variables can be safely used by the library. However it is a difficult problem to identify these cases automatically.
Identifying any library code which uses them is relatively easy. In fact it is easier to automate it than by code review. Because it is such a boring thing to repeatedly look for and comment on.
If a test library function needs these variables it can recreate its own private copies.
Signed-off-by Richard Palethorpe <[email protected]>--- doc/c-test-api.txt | 47 ++++++++++++++++++++++++++ doc/library-api-writing-guidelines.txt | 14 ++++++++ 2 files changed, 61 insertions(+)doc/c-test-api.txt +13
-0@@ -767,6 +767,53 @@ LTP_ALIGN(x, a) Aligns the x to be next multiple of a. The a must be power of 2. +[source,c] +------------------------------------------------------------------------------- +TEST(socket(AF_INET, SOCK_RAW, 1)); +if (TST_RET > -1) { + tst_res(TFAIL, "Created raw socket"); + SAFE_CLOSE(TST_RET); +} else if (TST_ERR != EPERM) { + tst_res(TFAIL | TTERRNO, + "Failed to create socket for wrong reason"); +} else { + tst_res(TPASS | TTERRNO, "Didn't create raw socket"); +} +-------------------------------------------------------------------------------
Quoted 8 lines
doc/c-test-api.txt LTP_ALIGN(x, a) · line 786
Quoted 4 lines
doc/c-test-api.txt +4
-0+ +The +TEST+ macro sets +TST_RET+ to its argument's return value and ++TST_ERR+ to +errno+. The +TTERNO+ flag can be used to print the error +number's symbolic value.Nice examples, but we already talk about
TEST()in "1.2 Basic test interface". Should we put it there? If not, I'd add links to both places to the other (separate effort).
Also I suppose whole thing could be simplified withTST_EXP_FAIL2().
Yes, I suppose that I missed that originally. So it needs unifying and some wording changes.
Quoted 53 lines
doc/c-test-api.txt LTP_ALIGN(x, a) · line 797
Quoted 12 lines
doc/c-test-api.txt +11
-0+ +No LTP library function or macro, except those in 'tst_test_macros.h', +will write to these variables (rule 'LTP-002'). So their values will +not be changed unexpectedly. + +[source,c] +------------------------------------------------------------------------------- +TST_EXP_POSITIVE(wait(&status)); + +if (!TST_PASS) + return;IMHO This is really for "1.2 Basic test interface".
Quoted 8 lines
doc/c-test-api.txt +8
-0+------------------------------------------------------------------------------- + +If the return value of 'wait' is positive. This macro will print a +pass result and set +TST_PASS+ appropriately. If the return value is +zero or negative, then it will print fail. + +This and similar macros take optional variadic arguments. These begin +with a format string and then appropriate values to be formatted.doc/c-test-api.txt LTP_ALIGN(x, a) · line 815
Quoted 10 lines
doc/c-test-api.txt +10
-0+ +[source,c] +------------------------------------------------------------------------------- +TST_EXP_PASS(chown("a/file", uid, gid), "chown(%s,%d,%d)", + "a/file", uid, gid); +------------------------------------------------------------------------------- + +Expects +chown+ to return 0 and emits a pass or a fail. The arguments +to +chown+ will be printed in either case. There are many similar +macros, please see 'tst_test_macros.h'.And this as well.
...
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 25
Quoted 10 lines
doc/library-api-writing-guidelines.txt +2
-0@@ -21,10 +21,24 @@ Don't forget to update docs when you change the API. 2. C API -------- +2.1 LTP-001: Sources have tst_ prefix +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+1
Quoted 4 lines
doc/library-api-writing-guidelines.txt +1
-0+ API source code is in headers `include/*.h`, `include/lapi/*.h` (backward compatibility for old kernel and libc) and C sources in `lib/*.c`. Files have 'tst_' prefix.
Quoted 11 lines
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 39
Quoted 9 lines
doc/library-api-writing-guidelines.txt +9
-0+2.2 LTP-002: TST_RET and TST_ERR are not modified +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The test author is guaranteed that the test API will not modify these +variables. This prevents silent errors where the return value and +errno are overwritten before the test has chance to check them. + +The macros which are clearly intended to update these variables. That +is +TEST+ and those in 'tst_test_macros.h'. Are of course allowed tonit: Maybe +TEST()+ (it's a "function", unlike "variables"
TST_RETTST_ERR)?
+1
Quoted 5 lines
doc/library-api-writing-guidelines.txt Don't forget to update docs when you change the API. · line 40
Quoted 2 lines
doc/library-api-writing-guidelines.txt +1
-0+update these variables.Kind regards,
Petr
Signature · 2 lines
Thank you, Richard.
PATCH v2 6/8 Reference LTP-002 rule in Cocci scripts
In reply to Richard PalethorpeAvoid duplication of rule description
--- scripts/coccinelle/libltp-test-macro-vars.cocci | 6 +----- scripts/coccinelle/libltp-test-macro.cocci | 4 +--- 2 files changed, 2 insertions(+), 8 deletions(-)
scripts/coccinelle/libltp-test-macro-vars.cocci +1 -5
@@ -1,11 +1,7 @@ // SPDX-License-Identifier: GPL-2.0-or-later // Copyright (c) 2021 SUSE LLC <[email protected]> -// The TEST macro should not be used in the library because it sets -// TST_RET and TST_ERR which are global variables. The test author -// only expects these to be changed if *they* call TEST directly. - -// Find all positions where TEST's variables are used +// Find violations of LTP-002 @ find_use exists @ expression E; @@
scripts/coccinelle/libltp-test-macro.cocci +1 -3
@@ -1,9 +1,7 @@ // SPDX-License-Identifier: GPL-2.0-or-later // Copyright (c) 2021 SUSE LLC <[email protected]> -// The TEST macro should not be used in the library because it sets -// TST_RET and TST_ERR which are global variables. The test author -// only expects these to be changed if *they* call TEST directly. +// Find and fix violations of rule LTP-002 // Set with -D fix virtual fix
Signature · 1 line
2.31.1
PATCH v2 6/8 Reference LTP-002 rule in Cocci scripts
Hi Riichie,
Quoted 1 line
Avoid duplication of rule description
obviously correct.
Kind regards,
Petr
PATCH v2 7/8 API: Move libtsc.h from realtime tests include to tst_tsc.h
In reply to Richard PalethorpeAllow the meltdown test to use this file without modifying the CFLAGS. This avoids having to add the include also to the CHECK_FLAGS.
--- testcases/realtime/include/libtsc.h => include/tst_tsc.h | 0 testcases/cve/Makefile | 2 -- testcases/cve/meltdown.c | 2 +- testcases/realtime/func/async_handler/async_handler_tsc.c | 3 ++- testcases/realtime/func/measurement/preempt_timing.c | 3 ++- testcases/realtime/func/measurement/rdtsc-latency.c | 3 ++- 6 files changed, 7 insertions(+), 6 deletions(-) rename testcases/realtime/include/libtsc.h => include/tst_tsc.h (100%)
include/tst_tsc.h renamed from testcases/realtime/include/libtsc.h +0 -0
testcases/cve/Makefile +0 -2
@@ -18,8 +18,6 @@ ifneq ($(ANDROID),1) cve-2014-0196: LDLIBS += -lutil endif -meltdown: CFLAGS += -I$(abs_srcdir)/../realtime/include - ifneq (,$(filter $(HOST_CPU),x86 x86_64)) meltdown: CFLAGS += -msse2 endif
testcases/cve/meltdown.c +1 -1
@@ -19,7 +19,7 @@#include <emmintrin.h> -#include "libtsc.h" +#include "tst_tsc.h" #define TARGET_OFFSET 9#define TARGET_SIZE (1 << TARGET_OFFSET)
testcases/realtime/func/async_handler/async_handler_tsc.c +2 -1
@@ -46,7 +46,8 @@#include <pthread.h> #include <librttest.h> #include <libstats.h> -#include <libtsc.h> + +#include "tst_tsc.h" #define HANDLER_PRIO 98#define SIGNAL_PRIO 99
testcases/realtime/func/measurement/preempt_timing.c +2 -1
@@ -52,7 +52,8 @@#include <sys/mman.h> #include <stdint.h> #include <librttest.h> -#include <libtsc.h> + +#include "tst_tsc.h" #define ITERATIONS 1000000ULL#define INTERVALS 10
testcases/realtime/func/measurement/rdtsc-latency.c +2 -1
@@ -44,7 +44,8 @@#include <errno.h> #include <stdint.h> #include <librttest.h> -#include <libtsc.h> + +#include "tst_tsc.h" #define ITERATIONS 1000000
Signature · 1 line
2.31.1
PATCH v2 7/8 API: Move libtsc.h from realtime tests include to tst_tsc.h
Hi Richie,
Quoted 2 lines
Allow the meltdown test to use this file without modifying the CFLAGS. This avoids having to add the include also to the
CHECK_FLAGS.
+1
Kind regards,
Petr
PATCH v2 8/8 API/tst_tsc: Add guards and remove some boilerplate
In reply to Richard Palethorpe--- include/tst_tsc.h | 35 ++++++++--------------------------- 1 file changed, 8 insertions(+), 27 deletions(-)
include/tst_tsc.h +8 -27
@@ -1,28 +1,6 @@ -/****************************************************************************** -* -* Copyright ? International Business Machines Corp., 2006-2008 -* -* This program is free software; you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation; either version 2 of the License, or -* (at your option) any later version. -* -* This program 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 General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program; if not, write to the Free Software -* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -* -* NAME -* libtsc.h -* -* DESCRIPTION -* -* USAGE: -* To be included in some testcases. +// SPDX-License-Identifier: GPL-2.0-or-later +/* +* Copyright ? International Business Machines Corp., 2006-2008 * * AUTHOR * Darren Hart <[email protected]>
@@ -30,8 +8,10 @@* * HISTORY * It directly comes from the librttest.h (see its HISTORY). -* -*****************************************************************************/ +*/ + +#ifndef TST_TSC_H +#define TST_TSC_H #undef TSC_UNSUPPORTED
@@ -70,3 +50,4 @@#define TSC_UNSUPPORTED #endif +#endif
Signature · 1 line
2.31.1
PATCH v2 8/8 API/tst_tsc: Add guards and remove some boilerplate
v2 cover Sparse based checker and rule proposal
In reply to Richard PalethorpeHi Richie,
thanks for this work! I'm looking forward enabling it in CI after we merge it.
Kind regards,
Petr
v2 cover Sparse based checker and rule proposal
Hello Petr,
Quoted 4 lines · Petr Vorel
Hi Richie,
thanks for this work! I'm looking forward enabling it in CI after we merge it.
Thanks. Perhaps only in the lib directory for now though. Also it will only really be checking the checker itself doesn't crash or fail to build. There are some errors which need fixing in the library before we can enforce the checks in CI.
Quoted 3 lines
Kind regards,
Petr
Signature · 2 lines
Thank you, Richard.