Add selftests to tools and KUnit tests
Subsystems (3)
Gabriele Monaco
maintainerv5 cover Add selftests to tools and KUnit tests
This series adds support to the make check target in the rv userspace tool and the rvgen script, this allows to quickly validate its functionality. The selftest framework is inspired by the one used in RTLA.
A few bugs in both tools were also discovered and are fixed as part of this series.
Additionally it adds unit tests for models. This is achieved by running the handlers functions directly within KUnit, emulating all modules paths as if real kernel events fired.
Unit tests emulate a series of events that are expected to trigger violations and checks that a reaction occurred, stub structs and functions are used so the kernel is not affected by the test.
Finally it adds a few kselftests for new monitors and improves existing ones.
Difference since V4 [1]:
* Drop static stub from current to avoid issues with unrelated KUnit tests
* Increase delay in nomiss KUnit test to avoid false positives
* Move wait for flush to avoid wwnr/printk selftest to hang
* Split some long lines
Difference since V3 [2]:
* Retry multiple times when getting the pid to avoid races in selftests
* Use pathlib instead of os.path in rvgen
* Rename files to backup instead of writing to backup in rvgen kunit
* Use deadline_thresh in nomiss KUnit test
* Special init/destroy for per-task monitors to avoid touching real tasks and starting tracepoints in KUnit test
* Use actual reactor instead of KUnit stub to support timer reactions
* Wait for dmesg to flush all messages after reactions in wwnr selftest
* Restore original stall threshold after selftest
Difference since V2 [3]:
* Use general rv_this also in LTL monitors
* Refactor KUnit tests to allow build as module
* Add deadline and stall kselftests
* Fix errexit assumption on kselftests
* Adapt rvgen selftests after rebase
Differences since RFC [4]:
* Fix issue with LTL generator printing literals as uppercase
* Add missing state label in selftest dot spec
* Fail selftest if pid was required but not found (harness error)
* Remove useless static keywords in KUnit tests
* Assert after kunit_kzalloc()
* Use RV_KUNIT_EXPECT_REACTION_HERE to avoid false positives
* Prevent running RV monitors and events together with KUnit
* Rearrange KUnit testing headers
* Expect no reaction at the end of KUnit test cases
* Fix broken nomiss test and allocation
[1] - https://lore.kernel.org/lkml/[email protected]
[2] - https://lore.kernel.org/lkml/[email protected]
[3] - https://lore.kernel.org/lkml/[email protected]
[4] - https://lore.kernel.org/lkml/[email protected]
To: [email protected]
To: [email protected]
Cc: Steven Rostedt <[email protected]>
Cc: Nam Cao <[email protected]>
Cc: Thomas Weissschuh <[email protected]>
Cc: Tomas Glozar <[email protected]>
Cc: John Kacur <[email protected]>
Cc: Wen Yang <[email protected]>
Gabriele Monaco (17):
rv: Use generic rv_this for the rv_monitor variable in LTL tools/rv: Fix exit status when monitor execution fails verification/rvgen: Improve rv_dir discovery in RVGenerator verification/rvgen: Use pathlib instead of os.path verification/rvgen: Improve consistency in template files tools/rv: Add selftests
verification/rvgen: Add golden and spec folders for tests verification/rvgen: Add selftests
verification/rvgen: Add the rvgen kunit subcommand verification/rvgen: Add selftests for rvgen kunit
rv: Export task monitor slot and react symbols
rv: Add KUnit tests for some DA/HA monitors
rv: Add KUnit mock for current
rv: Add KUnit tests for some LTL monitors selftests/verification: Fix wrong errexit assumption selftests/verification: Rearrange the wwnr_printk test selftests/verification: Add selftests for deadline and stall monitors
include/rv/da_monitor.h | 23 ++ include/rv/ha_monitor.h | 21 ++ include/rv/kunit.h | 73 +++++ include/rv/ltl_monitor.h | 14 +- kernel/trace/rv/Kconfig | 14 + kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/nomiss/nomiss.c | 18 ++ .../trace/rv/monitors/nomiss/nomiss_kunit.c | 38 +++ .../trace/rv/monitors/nomiss/nomiss_kunit.h | 35 +++ kernel/trace/rv/monitors/opid/opid.c | 12 + kernel/trace/rv/monitors/opid/opid_kunit.c | 33 +++ kernel/trace/rv/monitors/opid/opid_kunit.h | 23 ++ .../trace/rv/monitors/pagefault/pagefault.c | 20 +- .../rv/monitors/pagefault/pagefault_kunit.c | 34 +++ .../rv/monitors/pagefault/pagefault_kunit.h | 24 ++ kernel/trace/rv/monitors/sco/sco.c | 13 + kernel/trace/rv/monitors/sco/sco_kunit.c | 29 ++ kernel/trace/rv/monitors/sco/sco_kunit.h | 24 ++ kernel/trace/rv/monitors/sleep/sleep.c | 49 +++- kernel/trace/rv/monitors/sleep/sleep_kunit.c | 58 ++++ kernel/trace/rv/monitors/sleep/sleep_kunit.h | 30 ++ kernel/trace/rv/monitors/sssw/sssw.c | 14 + kernel/trace/rv/monitors/sssw/sssw_kunit.c | 33 +++ kernel/trace/rv/monitors/sssw/sssw_kunit.h | 30 ++ kernel/trace/rv/monitors/sts/sts.c | 19 ++ kernel/trace/rv/monitors/sts/sts_kunit.c | 39 +++ kernel/trace/rv/monitors/sts/sts_kunit.h | 33 +++ kernel/trace/rv/rv.c | 68 +++++ kernel/trace/rv/rv_monitors_test.c | 179 ++++++++++++ kernel/trace/rv/rv_reactors.c | 1 + .../verification/test.d/rv_deadline.tc | 23 ++ .../test.d/rv_monitor_enable_disable.tc | 10 +- .../verification/test.d/rv_monitor_reactor.tc | 4 +- .../selftests/verification/test.d/rv_stall.tc | 33 +++ .../verification/test.d/rv_wwnr_printk.tc | 32 ++- tools/verification/rv/Makefile | 5 +- tools/verification/rv/src/rv.c | 24 +- tools/verification/rv/tests/rv_list.t | 48 ++++ tools/verification/rv/tests/rv_mon.t | 95 +++++++ tools/verification/rvgen/Makefile | 5 + tools/verification/rvgen/__main__.py | 15 +- tools/verification/rvgen/rvgen/generator.py | 51 ++-- tools/verification/rvgen/rvgen/kunit.py | 194 +++++++++++++ tools/verification/rvgen/rvgen/ltl2k.py | 2 +- .../rvgen/rvgen/templates/container/main.c | 2 +- .../rvgen/rvgen/templates/dot2k/main.c | 2 +- .../rvgen/rvgen/templates/kunit.c | 33 +++ .../rvgen/rvgen/templates/ltl2k/main.c | 8 +- .../rvgen/tests/golden/da_global/Kconfig | 9 + .../rvgen/tests/golden/da_global/da_global.c | 95 +++++++ .../rvgen/tests/golden/da_global/da_global.h | 47 ++++ .../tests/golden/da_global/da_global_trace.h | 15 + .../tests/golden/da_perobj_parent/Kconfig | 11 + .../da_perobj_parent/da_perobj_parent.c | 110 ++++++++ .../da_perobj_parent/da_perobj_parent.h | 64 +++++ .../da_perobj_parent/da_perobj_parent_trace.h | 15 + .../tests/golden/da_pertask_desc/Kconfig | 9 + .../golden/da_pertask_desc/da_pertask_desc.c | 105 +++++++ .../golden/da_pertask_desc/da_pertask_desc.h | 64 +++++ .../da_pertask_desc/da_pertask_desc_trace.h | 15 + .../rvgen/tests/golden/ha_percpu/Kconfig | 9 + .../rvgen/tests/golden/ha_percpu/ha_percpu.c | 244 ++++++++++++++++ .../rvgen/tests/golden/ha_percpu/ha_percpu.h | 72 +++++ .../tests/golden/ha_percpu/ha_percpu_trace.h | 19 ++ .../rvgen/tests/golden/ltl_pertask/Kconfig | 9 + .../tests/golden/ltl_pertask/ltl_pertask.c | 107 +++++++ .../tests/golden/ltl_pertask/ltl_pertask.h | 108 ++++++++ .../golden/ltl_pertask/ltl_pertask_trace.h | 14 + .../rvgen/tests/golden/test_bak_kunit/Kconfig | 9 + .../golden/test_bak_kunit/test_bak_kunit.c | 107 +++++++ .../golden/test_bak_kunit/test_bak_kunit.h | 108 ++++++++ .../test_bak_kunit/test_bak_kunit_kunit.c | 33 +++ .../test_bak_kunit/test_bak_kunit_kunit.c.bak | 1 + .../test_bak_kunit/test_bak_kunit_kunit.h | 22 ++ .../test_bak_kunit/test_bak_kunit_trace.h | 14 + .../rvgen/tests/golden/test_container/Kconfig | 5 + .../golden/test_container/test_container.c | 35 +++ .../golden/test_container/test_container.h | 3 + .../rvgen/tests/golden/test_da/Kconfig | 9 + .../rvgen/tests/golden/test_da/test_da.c | 95 +++++++ .../rvgen/tests/golden/test_da/test_da.h | 47 ++++ .../tests/golden/test_da/test_da_trace.h | 15 + .../rvgen/tests/golden/test_da_kunit/Kconfig | 9 + .../golden/test_da_kunit/test_da_kunit.c | 107 +++++++ .../golden/test_da_kunit/test_da_kunit.h | 47 ++++ .../test_da_kunit/test_da_kunit_kunit.c | 33 +++ .../test_da_kunit/test_da_kunit_kunit.h | 23 ++ .../test_da_kunit/test_da_kunit_trace.h | 15 + .../rvgen/tests/golden/test_ha/Kconfig | 9 + .../rvgen/tests/golden/test_ha/test_ha.c | 247 +++++++++++++++++ .../rvgen/tests/golden/test_ha/test_ha.h | 72 +++++ .../tests/golden/test_ha/test_ha_trace.h | 19 ++ .../rvgen/tests/golden/test_ha_kunit/Kconfig | 9 + .../golden/test_ha_kunit/test_ha_kunit.c | 260 ++++++++++++++++++ .../golden/test_ha_kunit/test_ha_kunit.h | 88 ++++++ .../test_ha_kunit/test_ha_kunit_kunit.c | 33 +++ .../test_ha_kunit/test_ha_kunit_kunit.h | 24 ++ .../test_ha_kunit/test_ha_kunit_trace.h | 19 ++ .../rvgen/tests/golden/test_ltl/Kconfig | 11 + .../rvgen/tests/golden/test_ltl/test_ltl.c | 108 ++++++++ .../rvgen/tests/golden/test_ltl/test_ltl.h | 108 ++++++++ .../tests/golden/test_ltl/test_ltl_trace.h | 14 + .../rvgen/tests/golden/test_ltl_kunit/Kconfig | 9 + .../golden/test_ltl_kunit/test_ltl_kunit.c | 107 +++++++ .../golden/test_ltl_kunit/test_ltl_kunit.h | 108 ++++++++ .../test_ltl_kunit/test_ltl_kunit_kunit.c | 33 +++ .../test_ltl_kunit/test_ltl_kunit_kunit.h | 22 ++ .../test_ltl_kunit/test_ltl_kunit_trace.h | 14 + .../rvgen/tests/rvgen_container.t | 20 ++ tools/verification/rvgen/tests/rvgen_kunit.t | 41 +++ .../verification/rvgen/tests/rvgen_monitor.t | 87 ++++++ .../rvgen/tests/specs/test_da.dot | 16 ++ .../rvgen/tests/specs/test_da2.dot | 19 ++ .../rvgen/tests/specs/test_ha.dot | 27 ++ .../rvgen/tests/specs/test_invalid.dot | 8 + .../rvgen/tests/specs/test_invalid.ltl | 1 + .../rvgen/tests/specs/test_invalid_ha.dot | 16 ++ .../rvgen/tests/specs/test_ltl.ltl | 1 + tools/verification/tests/engine.sh | 175 ++++++++++++ 119 files changed, 5110 insertions(+), 81 deletions(-) create mode 100644 include/rv/kunit.h create mode 100644 kernel/trace/rv/monitors/nomiss/nomiss_kunit.c create mode 100644 kernel/trace/rv/monitors/nomiss/nomiss_kunit.h create mode 100644 kernel/trace/rv/monitors/opid/opid_kunit.c create mode 100644 kernel/trace/rv/monitors/opid/opid_kunit.h create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_kunit.c create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_kunit.h create mode 100644 kernel/trace/rv/monitors/sco/sco_kunit.c create mode 100644 kernel/trace/rv/monitors/sco/sco_kunit.h create mode 100644 kernel/trace/rv/monitors/sleep/sleep_kunit.c create mode 100644 kernel/trace/rv/monitors/sleep/sleep_kunit.h create mode 100644 kernel/trace/rv/monitors/sssw/sssw_kunit.c create mode 100644 kernel/trace/rv/monitors/sssw/sssw_kunit.h create mode 100644 kernel/trace/rv/monitors/sts/sts_kunit.c create mode 100644 kernel/trace/rv/monitors/sts/sts_kunit.h create mode 100644 kernel/trace/rv/rv_monitors_test.c create mode 100644 tools/testing/selftests/verification/test.d/rv_deadline.tc create mode 100644 tools/testing/selftests/verification/test.d/rv_stall.tc create mode 100644 tools/verification/rv/tests/rv_list.t create mode 100644 tools/verification/rv/tests/rv_mon.t create mode 100644 tools/verification/rvgen/rvgen/kunit.py create mode 100644 tools/verification/rvgen/rvgen/templates/kunit.c create mode 100644 tools/verification/rvgen/tests/golden/da_global/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global.c create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global.h create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global_trace.h create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.c create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.h create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent_trace.h create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.c create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.h create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc_trace.h create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.c create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.h create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu_trace.h create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.c create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.h create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c.bak create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_container/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_container/test_container.c create mode 100644 tools/verification/rvgen/tests/golden/test_container/test_container.h create mode 100644 tools/verification/rvgen/tests/golden/test_da/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da.c create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da.h create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/rvgen_container.t create mode 100644 tools/verification/rvgen/tests/rvgen_kunit.t create mode 100644 tools/verification/rvgen/tests/rvgen_monitor.t create mode 100644 tools/verification/rvgen/tests/specs/test_da.dot create mode 100644 tools/verification/rvgen/tests/specs/test_da2.dot create mode 100644 tools/verification/rvgen/tests/specs/test_ha.dot create mode 100644 tools/verification/rvgen/tests/specs/test_invalid.dot create mode 100644 tools/verification/rvgen/tests/specs/test_invalid.ltl create mode 100644 tools/verification/rvgen/tests/specs/test_invalid_ha.dot create mode 100644 tools/verification/rvgen/tests/specs/test_ltl.ltl create mode 100644 tools/verification/tests/engine.sh
base-commit: 1590cf0329716306e948a8fc29f1d3ee87d3989f
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 1/17 Use generic rv_this for the rv_monitor variable in LTL
Align the rv_monitor variable name in LTL to the generic rv_this as it is already done for DA/HA monitors. This improves consistency and eases assumptions across model classes.
--- include/rv/ltl_monitor.h | 5 ++--- kernel/trace/rv/monitors/pagefault/pagefault.c | 6 +++--- kernel/trace/rv/monitors/sleep/sleep.c | 6 +++--- tools/verification/rvgen/rvgen/templates/ltl2k/main.c | 6 +++--- 4 files changed, 11 insertions(+), 12 deletions(-)
include/rv/ltl_monitor.h +2 -3
@@ -16,8 +16,7 @@#error "Please include $(MODEL_NAME).h generated by rvgen"#endif -#define RV_MONITOR_NAME CONCATENATE(rv_, MONITOR_NAME) -static struct rv_monitor RV_MONITOR_NAME ; +static struct rv_monitor rv_this;static int ltl_monitor_slot =RV_PER_TASK_MONITOR_INIT ;
@@ -85,7 +84,7 @@ static void ltl_monitor_destroy(void)static void ltl_illegal_state (struct task_struct *task,struct ltl_monitor *mon) {CONCATENATE (trace_error_,MONITOR_NAME )(task); - rv_react(&RV_MONITOR_NAME, "rv: "__stringify(MONITOR_NAME)": %s[%d]: violation detected\n", + rv_react(&rv_this, "rv: "__stringify(MONITOR_NAME)": %s[%d]: violation detected\n", task->comm, task->pid); }
kernel/trace/rv/monitors/pagefault/pagefault.c +3 -3
@@ -63,7 +63,7 @@ static void disable_pagefault(void)ltl_monitor_destroy (); } -static struct rv_monitor rv_pagefault = { +static struct rv_monitor rv_this = { .name ="pagefault" , .description ="Monitor that RT tasks do not raise page faults" , .enable = enable_pagefault,
@@ -72,12 +72,12 @@ static struct rv_monitor rv_pagefault = {static int __init register_pagefault (void ) { -return rv_register_monitor (&rv_pagefault, &rv_rtapp); +return rv_register_monitor (&rv_this, &rv_rtapp); } static void __exit unregister_pagefault(void) { -rv_unregister_monitor (&rv_pagefault); +rv_unregister_monitor (&rv_this); }module_init (register_pagefault);
kernel/trace/rv/monitors/sleep/sleep.c +3 -3
@@ -224,7 +224,7 @@ static void disable_sleep(void)ltl_monitor_destroy (); } -static struct rv_monitor rv_sleep = { +static struct rv_monitor rv_this = { .name ="sleep" , .description ="Monitor that RT tasks do not undesirably sleep" , .enable = enable_sleep,
@@ -233,12 +233,12 @@ static struct rv_monitor rv_sleep = {static int __init register_sleep (void ) { -return rv_register_monitor (&rv_sleep, &rv_rtapp); +return rv_register_monitor (&rv_this, &rv_rtapp); } static void __exit unregister_sleep(void) { -rv_unregister_monitor (&rv_sleep); +rv_unregister_monitor (&rv_this); }module_init (register_sleep);
tools/verification/rvgen/rvgen/templates/ltl2k/main.c +3 -3
@@ -77,7 +77,7 @@ static void disable_%%MODEL_NAME%%(void)/* * This is the monitor register section. */ -static struct rv_monitor rv_%%MODEL_NAME%% = { +static struct rv_monitor rv_this = { .name ="%%MODEL_NAME%%" , .description ="%%DESCRIPTION%%" , .enable = enable_%%MODEL_NAME%%,
@@ -86,12 +86,12 @@ static struct rv_monitor rv_%%MODEL_NAME%% = { static int __init register_%%MODEL_NAME%%(void) { - return rv_register_monitor(&rv_%%MODEL_NAME%%, %%PARENT%%); + return rv_register_monitor(&rv_this, %%PARENT%%); } static void __exit unregister_%%MODEL_NAME%%(void) { - rv_unregister_monitor(&rv_%%MODEL_NAME%%); + rv_unregister_monitor(&rv_this); } module_init(register_%%MODEL_NAME%%);
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 2/17 tools/rv: Fix exit status when monitor execution fails
In reply to Gabriele MonacoWhen running "rv mon" on a monitor that is already enabled, the tool fails to start but incorrectly exits with a success status (0).
Fix the exit condition to ensure it returns a failure code on any execution error. Also use the standard EXIT_SUCCESS/EXIT_FAILURE macros throughout the file.
--- tools/verification/rv/src/rv.c | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-)
tools/verification/rv/src/rv.c +12 -12
@@ -50,23 +50,23 @@ static void rv_list(int argc, char **argv)" [container]: list only monitors in this container" , NULL, }; -int i, print_help =0 , retval =0 ; +int i, print_help =0 , retval =EXIT_SUCCESS ;char *container =NULL ;if (argc ==2 ) {if (!strcmp (argv[1 ],"-h" ) || !strcmp (argv[1 ],"--help" )) { print_help =1 ; - retval =0 ; + retval =EXIT_SUCCESS ; }else if (argv[1 ][0 ] =='-' ) {/* assume invalid option */ print_help =1 ; - retval =1 ; + retval =EXIT_FAILURE ; }else container = argv[1 ]; }else if (argc >2 ) {/* more than 2 is always usage */ print_help =1 ; - retval =1 ; + retval =EXIT_FAILURE ; }if (print_help) {fprintf (stderr,"rv version %s\n" ,VERSION );
@@ -77,7 +77,7 @@ static void rv_list(int argc, char **argv)ikm_list_monitors (container); -exit (0 ); +exit (EXIT_SUCCESS ); }/*
@@ -108,14 +108,14 @@ static void rv_mon(int argc, char **argv)for (i =0 ; usage[i]; i++)fprintf (stderr,"%s\n" , usage[i]); -exit (1 ); +exit (EXIT_FAILURE ); }else if (!strcmp (argv[1 ],"-h" ) || !strcmp (argv[1 ],"--help" )) {fprintf (stderr,"rv version %s\n" ,VERSION );for (i =0 ; usage[i]; i++)fprintf (stderr,"%s\n" , usage[i]); -exit (0 ); +exit (EXIT_SUCCESS ); } monitor_name = argv[1 ];
@@ -127,7 +127,7 @@ static void rv_mon(int argc, char **argv)if (!run)err_msg ("rv: monitor %s does not exist\n" , monitor_name); -exit (!run); +exit (run >0 ?EXIT_SUCCESS :EXIT_FAILURE ); }static void usage (int exit_val,const char *fmt, ...)
@@ -174,13 +174,13 @@ static void usage(int exit_val, const char *fmt, ...)int main (int argc,char **argv) {if (geteuid ()) -usage (1 ,"%s needs root permission" , argv[0 ]); +usage (EXIT_FAILURE ,"%s needs root permission" , argv[0 ]);if (argc <=1 ) -usage (1 ,"%s requires a command" , argv[0 ]); +usage (EXIT_FAILURE ,"%s requires a command" , argv[0 ]);if (!strcmp (argv[1 ],"-h" ) || !strcmp (argv[1 ],"--help" )) -usage (0 ,"help" ); +usage (EXIT_SUCCESS ,"help" );if (!strcmp (argv[1 ],"list" ))rv_list (--argc, &argv[1 ]);
@@ -197,5 +197,5 @@ int main(int argc, char **argv) }/* invalid sub-command */ -usage (1 ,"%s does not know the %s command, old version?" , argv[0 ], argv[1 ]); +usage (EXIT_FAILURE ,"%s does not know the %s command, old version?" , argv[0 ], argv[1 ]); }
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 3/17 verification/rvgen: Improve rv_dir discovery in RVGenerator
In reply to Gabriele MonacoThe RVGenerator class can find the RV directory (kernel/trace/rv) in the kernel tree to do some auto patching. This works by assuming PWD is either the kernel tree or tools/verification, which isn't always the case (e.g. when running from selftests).
Make discovery more robust by relying on the absolute path of the current script and traversing backwards the right number of times. This should work from any location if rvgen is in the kernel tree.
---
Notes:
V4:
* Use pathlib's parents array to climb up directories
tools/verification/rvgen/rvgen/generator.py | 29 ++++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-)
tools/verification/rvgen/rvgen/generator.py +16 -13
@@ -7,6 +7,7 @@ import platform import os +from pathlib import Path class RVGenerator:
@@ -25,27 +26,29 @@ class RVGenerator: self.__fill_rv_kernel_dir() def __fill_rv_kernel_dir(self): - - # first try if we are running in the kernel tree root - if os.path.exists(self.rv_dir): - return - - # offset if we are running inside the kernel tree from verification/dot2 - kernel_path = os.path.join("../..", self.rv_dir) - - if os.path.exists(kernel_path): - self.rv_dir = kernel_path + # find the kernel tree root relative to this file's location + resolved_path = Path(__file__).resolve() + if len(resolved_path.parents) > 4: + kernel_root = resolved_path.parents[4] + kernel_path = kernel_root / self.rv_dir + + if kernel_path.exists(): + self.rv_dir = str(kernel_path) + return + + # best effort if rvgen is installed and we are at the root of a kernel tree + if Path(self.rv_dir).exists(): return if platform.system() != "Linux": raise OSError("I can only run on Linux.") - kernel_path = os.path.join(f"/lib/modules/{platform.release()}/build", self.rv_dir) + kernel_path = Path(f"/lib/modules/{platform.release()}/build") / self.rv_dir # if the current kernel is from a distro this may not be a full kernel tree # verify that one of the files we are going to modify is available - if os.path.exists(os.path.join(kernel_path, "rv_trace.h")): - self.rv_dir = kernel_path + if (kernel_path / "rv_trace.h").exists(): + self.rv_dir = str(kernel_path) return raise FileNotFoundError("Could not find the rv directory, do you have the kernel source installed?")
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 4/17 verification/rvgen: Use pathlib instead of os.path
In reply to Gabriele MonacoMigrate to the newer patlib library, bundled with python since 3.4 to increase readability over using os.path.
--- tools/verification/rvgen/rvgen/generator.py | 22 +++++++++------------ 1 file changed, 9 insertions(+), 13 deletions(-)
tools/verification/rvgen/rvgen/generator.py +9 -13
@@ -6,7 +6,6 @@ # Abstract class for generating kernel runtime verification monitors from specification file import platform -import os from pathlib import Path
@@ -17,7 +16,7 @@ class RVGenerator: self.name = extra_params.get("model_name") self.parent = extra_params.get("parent") self.abs_template_dir = \ - os.path.join(os.path.dirname(__file__), "templates", self.template_dir) + Path(__file__).resolve().parent / "templates" / self.template_dir self.main_c = self._read_template_file("main.c") self.kconfig = self._read_template_file("Kconfig") self.description = extra_params.get("description", self.name) or "auto-generated"
@@ -60,12 +59,12 @@ class RVGenerator: def _read_template_file(self, file): try: - path = os.path.join(self.abs_template_dir, file) + path = self.abs_template_dir / file return self._read_file(path) except OSError: # Specific template file not found. Try the generic template file in the template/ # directory, which is one level up - path = os.path.join(self.abs_template_dir, "..", file) + path = self.abs_template_dir.parent / file return self._read_file(path) def fill_parent(self):
@@ -136,7 +135,7 @@ class RVGenerator: def _patch_file(self, file, marker, line): assert self.auto_patch - file_to_patch = os.path.join(self.rv_dir, file) + file_to_patch = Path(self.rv_dir) / file content = self._read_file(file_to_patch) content = content.replace(marker, line + "\n" + marker) self.__write_file(file_to_patch, content)
@@ -190,22 +189,19 @@ obj-$(CONFIG_RV_MON_{name_up}) += monitors/{name}/{name}.o return f" - Move {self.name}/ to the kernel's monitor directory ({self.rv_dir}/monitors)" def __create_directory(self): - path = self.name + path = Path(self.name) if self.auto_patch: - path = os.path.join(self.rv_dir, "monitors", path) - try: - os.mkdir(path) - except FileExistsError: - return + path = Path(self.rv_dir) / "monitors" / path + path.mkdir(exist_ok=True) def __write_file(self, file_name, content): with open(file_name, 'w') as file: file.write(content) def _create_file(self, file_name, content): - path = f"{self.name}/{file_name}" + path = Path(self.name) / file_name if self.auto_patch: - path = os.path.join(self.rv_dir, "monitors", path) + path = Path(self.rv_dir) / "monitors" / self.name / file_name self.__write_file(path, content) def print_files(self):
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 5/17 verification/rvgen: Improve consistency in template files
In reply to Gabriele MonacoTemplate files for rvgen had minor inconsistencies in their placeholders for default author and default tracepoint examples. The user needs to modify those anyway but keeping consistency may help in bulk editing or checking.
Change default author from "dot2k: auto-generated" (for DA/containers) or /* TODO */ (for LTL) to the general "rvgen: auto-generated".
Align the sample tracepoint handler name in LTL template to handle_example_event, consistently with the rest of the file.
--- tools/verification/rvgen/rvgen/ltl2k.py | 2 +- tools/verification/rvgen/rvgen/templates/container/main.c | 2 +- tools/verification/rvgen/rvgen/templates/dot2k/main.c | 2 +- tools/verification/rvgen/rvgen/templates/ltl2k/main.c | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)
tools/verification/rvgen/rvgen/ltl2k.py +1 -1
@@ -222,7 +222,7 @@ class ltl2k(generator.Monitor): return f"\trv_attach_trace_probe(\"{self.name}\", /* XXX: tracepoint */, handle_example_event);" def fill_tracepoint_detach_helper(self): - return f"\trv_detach_trace_probe(\"{self.name}\", /* XXX: tracepoint */, handle_sample_event);" + return f"\trv_detach_trace_probe(\"{self.name}\", /* XXX: tracepoint */, handle_example_event);" def fill_atoms_init(self): buff = []
tools/verification/rvgen/rvgen/templates/container/main.c +1 -1
@@ -31,5 +31,5 @@ module_init(register_%%MODEL_NAME%%); module_exit(unregister_%%MODEL_NAME%%);MODULE_LICENSE ("GPL" ); -MODULE_AUTHOR ("dot2k: auto-generated" ); +MODULE_AUTHOR ("rvgen: auto-generated" );MODULE_DESCRIPTION ("%%MODEL_NAME%%: %%DESCRIPTION%%" );
tools/verification/rvgen/rvgen/templates/dot2k/main.c +1 -1
@@ -79,5 +79,5 @@ module_init(register_%%MODEL_NAME%%); module_exit(unregister_%%MODEL_NAME%%);MODULE_LICENSE ("GPL" ); -MODULE_AUTHOR ("dot2k: auto-generated" ); +MODULE_AUTHOR ("rvgen: auto-generated" );MODULE_DESCRIPTION ("%%MODEL_NAME%%: %%DESCRIPTION%%" );
tools/verification/rvgen/rvgen/templates/ltl2k/main.c +1 -1
@@ -98,5 +98,5 @@ module_init(register_%%MODEL_NAME%%); module_exit(unregister_%%MODEL_NAME%%);MODULE_LICENSE ("GPL" ); -MODULE_AUTHOR (/* TODO */ ); +MODULE_AUTHOR ("rvgen: auto-generated" );MODULE_DESCRIPTION ("%%MODEL_NAME%%: %%DESCRIPTION%%" );
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 6/17 tools/rv: Add selftests
In reply to Gabriele MonacoThe rv tool needs automated testing to catch regressions and verify correct functionality across different usage scenarios.
Add selftests that validate monitor listing (including containers and nested monitors), monitor execution with different configurations (reactors, verbose output, tracing), and trace output format for both per-task and per-cpu monitors. Error handling paths are also tested. Tests use a shared engine for common patterns.
---
Notes:
V4:
* Retry multiple times when getting the pid to avoid races
tools/verification/rv/Makefile | 5 +- tools/verification/rv/tests/rv_list.t | 48 +++++++++ tools/verification/rv/tests/rv_mon.t | 95 +++++++++++++++++ tools/verification/tests/engine.sh | 141 ++++++++++++++++++++++++++ 4 files changed, 288 insertions(+), 1 deletion(-) create mode 100644 tools/verification/rv/tests/rv_list.t create mode 100644 tools/verification/rv/tests/rv_mon.t create mode 100644 tools/verification/tests/engine.sh
tools/verification/rv/Makefile +4 -1
@@ -78,4 +78,7 @@ clean: doc_clean fixdep-clean $(Q)rm -f rv rv-static fixdep FEATURE-DUMP rv-* $(Q)rm -rf feature -.PHONY: FORCE clean +check: $(RV) + RV=$(RV) prove -o --directives -f tests/ + +.PHONY: FORCE clean check
tools/verification/rv/tests/rv_list.t new file +48 -0
48 lines not on this page · raw message
tools/verification/rv/tests/rv_mon.t new file +95 -0
95 lines not on this page · raw message
tools/verification/tests/engine.sh new file +141 -0
141 lines not on this page · raw message
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 7/17 verification/rvgen: Add golden and spec folders for tests
In reply to Gabriele MonacoCreate reference models specifications and generated files in the golded folder. Those can be used as reference to validate rvgen still generates files as expected in automated tests.
--- .../rvgen/tests/golden/da_global/Kconfig | 9 + .../rvgen/tests/golden/da_global/da_global.c | 95 +++++++ .../rvgen/tests/golden/da_global/da_global.h | 47 ++++ .../tests/golden/da_global/da_global_trace.h | 15 ++ .../tests/golden/da_perobj_parent/Kconfig | 11 + .../da_perobj_parent/da_perobj_parent.c | 110 ++++++++ .../da_perobj_parent/da_perobj_parent.h | 64 +++++ .../da_perobj_parent/da_perobj_parent_trace.h | 15 ++ .../tests/golden/da_pertask_desc/Kconfig | 9 + .../golden/da_pertask_desc/da_pertask_desc.c | 105 ++++++++ .../golden/da_pertask_desc/da_pertask_desc.h | 64 +++++ .../da_pertask_desc/da_pertask_desc_trace.h | 15 ++ .../rvgen/tests/golden/ha_percpu/Kconfig | 9 + .../rvgen/tests/golden/ha_percpu/ha_percpu.c | 244 +++++++++++++++++ .../rvgen/tests/golden/ha_percpu/ha_percpu.h | 72 +++++ .../tests/golden/ha_percpu/ha_percpu_trace.h | 19 ++ .../rvgen/tests/golden/ltl_pertask/Kconfig | 9 + .../tests/golden/ltl_pertask/ltl_pertask.c | 107 ++++++++ .../tests/golden/ltl_pertask/ltl_pertask.h | 108 ++++++++ .../golden/ltl_pertask/ltl_pertask_trace.h | 14 + .../rvgen/tests/golden/test_container/Kconfig | 5 + .../golden/test_container/test_container.c | 35 +++ .../golden/test_container/test_container.h | 3 + .../rvgen/tests/golden/test_da/Kconfig | 9 + .../rvgen/tests/golden/test_da/test_da.c | 95 +++++++ .../rvgen/tests/golden/test_da/test_da.h | 47 ++++ .../tests/golden/test_da/test_da_trace.h | 15 ++ .../rvgen/tests/golden/test_ha/Kconfig | 9 + .../rvgen/tests/golden/test_ha/test_ha.c | 247 ++++++++++++++++++ .../rvgen/tests/golden/test_ha/test_ha.h | 72 +++++ .../tests/golden/test_ha/test_ha_trace.h | 19 ++ .../rvgen/tests/golden/test_ltl/Kconfig | 11 + .../rvgen/tests/golden/test_ltl/test_ltl.c | 108 ++++++++ .../rvgen/tests/golden/test_ltl/test_ltl.h | 108 ++++++++ .../tests/golden/test_ltl/test_ltl_trace.h | 14 + .../rvgen/tests/specs/test_da.dot | 16 ++ .../rvgen/tests/specs/test_da2.dot | 19 ++ .../rvgen/tests/specs/test_ha.dot | 27 ++ .../rvgen/tests/specs/test_invalid.dot | 8 + .../rvgen/tests/specs/test_invalid.ltl | 1 + .../rvgen/tests/specs/test_invalid_ha.dot | 16 ++ .../rvgen/tests/specs/test_ltl.ltl | 1 + 42 files changed, 2026 insertions(+) create mode 100644 tools/verification/rvgen/tests/golden/da_global/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global.c create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global.h create mode 100644 tools/verification/rvgen/tests/golden/da_global/da_global_trace.h create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.c create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.h create mode 100644 tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent_trace.h create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.c create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.h create mode 100644 tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc_trace.h create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.c create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.h create mode 100644 tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu_trace.h create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.c create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.h create mode 100644 tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_container/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_container/test_container.c create mode 100644 tools/verification/rvgen/tests/golden/test_container/test_container.h create mode 100644 tools/verification/rvgen/tests/golden/test_da/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da.c create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da.h create mode 100644 tools/verification/rvgen/tests/golden/test_da/test_da_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha/test_ha_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl/test_ltl_trace.h create mode 100644 tools/verification/rvgen/tests/specs/test_da.dot create mode 100644 tools/verification/rvgen/tests/specs/test_da2.dot create mode 100644 tools/verification/rvgen/tests/specs/test_ha.dot create mode 100644 tools/verification/rvgen/tests/specs/test_invalid.dot create mode 100644 tools/verification/rvgen/tests/specs/test_invalid.ltl create mode 100644 tools/verification/rvgen/tests/specs/test_invalid_ha.dot create mode 100644 tools/verification/rvgen/tests/specs/test_ltl.ltl
tools/verification/rvgen/tests/golden/da_global/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_DA_GLOBAL + depends on RV + # XXX: add dependencies if there + select DA_MON_EVENTS_IMPLICIT + bool "da_global monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/da_global/da_global.c new file +95 -0
95 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_global/da_global.h new file +47 -0
47 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_global/da_global_trace.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_DA_GLOBAL +DEFINE_EVENT (event_da_monitor, event_da_global, + TP_PROTO(char *state, char *event, char *next_state, bool final_state), +TP_ARGS (state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor, error_da_global, +TP_PROTO (char *state, char *event), +TP_ARGS (state, event)); +#endif /* CONFIG_RV_MON_DA_GLOBAL */
tools/verification/rvgen/tests/golden/da_perobj_parent/Kconfig new file +11 -0
@@ -0,0 +1,11 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_DA_PEROBJ_PARENT + depends on RV + # XXX: add dependencies if there + depends on RV_MON_PARENT_MON + default y + select DA_MON_EVENTS_ID + bool "da_perobj_parent monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.c new file +110 -0
110 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent.h new file +64 -0
64 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_perobj_parent/da_perobj_parent_trace.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_DA_PEROBJ_PARENT +DEFINE_EVENT (event_da_monitor_id, event_da_perobj_parent, + TP_PROTO(int id, char *state, char *event, char *next_state, bool final_state), +TP_ARGS (id, state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor_id, error_da_perobj_parent, + TP_PROTO(int id, char *state, char *event), +TP_ARGS (id, state, event)); +#endif /* CONFIG_RV_MON_DA_PEROBJ_PARENT */
tools/verification/rvgen/tests/golden/da_pertask_desc/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_DA_PERTASK_DESC + depends on RV + # XXX: add dependencies if there + select DA_MON_EVENTS_ID + bool "da_pertask_desc monitor" + help + Custom description for testing
tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.c new file +105 -0
105 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc.h new file +64 -0
64 lines not on this page · raw message
tools/verification/rvgen/tests/golden/da_pertask_desc/da_pertask_desc_trace.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_DA_PERTASK_DESC +DEFINE_EVENT (event_da_monitor_id, event_da_pertask_desc, + TP_PROTO(int id, char *state, char *event, char *next_state, bool final_state), +TP_ARGS (id, state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor_id, error_da_pertask_desc, + TP_PROTO(int id, char *state, char *event), +TP_ARGS (id, state, event)); +#endif /* CONFIG_RV_MON_DA_PERTASK_DESC */
tools/verification/rvgen/tests/golden/ha_percpu/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_HA_PERCPU + depends on RV + # XXX: add dependencies if there + select HA_MON_EVENTS_IMPLICIT + bool "ha_percpu monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.c new file +244 -0
244 lines not on this page · raw message
tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu.h new file +72 -0
72 lines not on this page · raw message
tools/verification/rvgen/tests/golden/ha_percpu/ha_percpu_trace.h new file +19 -0
@@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_HA_PERCPU +DEFINE_EVENT (event_da_monitor, event_ha_percpu, + TP_PROTO(char *state, char *event, char *next_state, bool final_state), +TP_ARGS (state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor, error_ha_percpu, +TP_PROTO (char *state, char *event), +TP_ARGS (state, event)); + +DEFINE_EVENT (error_env_da_monitor, error_env_ha_percpu, +TP_PROTO (char *state, char *event, char *env), +TP_ARGS (state, event, env)); +#endif /* CONFIG_RV_MON_HA_PERCPU */
tools/verification/rvgen/tests/golden/ltl_pertask/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_LTL_PERTASK + depends on RV + # XXX: add dependencies if there + select LTL_MON_EVENTS_ID + bool "ltl_pertask monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.c new file +107 -0
107 lines not on this page · raw message
tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask.h new file +108 -0
108 lines not on this page · raw message
tools/verification/rvgen/tests/golden/ltl_pertask/ltl_pertask_trace.h new file +14 -0
@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_LTL_PERTASK +DEFINE_EVENT (event_ltl_monitor_id, event_ltl_pertask, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_ltl_pertask, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_LTL_PERTASK */
tools/verification/rvgen/tests/golden/test_container/Kconfig new file +5 -0
@@ -0,0 +1,5 @@ +config RV_MON_TEST_CONTAINER + depends on RV + bool "test_container monitor" + help + Test container for grouping monitors
tools/verification/rvgen/tests/golden/test_container/test_container.c new file +35 -0
@@ -0,0 +1,35 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/init.h> +#include <linux/rv.h> + +#define MODULE_NAME "test_container" + +#include "test_container.h" + +struct rv_monitor rv_test_container = { + .name ="test_container" , + .description ="Test container for grouping monitors" , + .enable =NULL , + .disable =NULL , + .reset =NULL , + .enabled =0 , +}; + +static int __init register_test_container (void ) +{ +return rv_register_monitor (&rv_test_container,NULL ); +} + +static void __exit unregister_test_container(void) +{ +rv_unregister_monitor (&rv_test_container); +} + +module_init (register_test_container); +module_exit (unregister_test_container); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("rvgen: auto-generated" ); +MODULE_DESCRIPTION ("test_container: Test container for grouping monitors" );
tools/verification/rvgen/tests/golden/test_container/test_container.h new file +3 -0
@@ -0,0 +1,3 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +extern struct rv_monitor rv_test_container;
tools/verification/rvgen/tests/golden/test_da/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_DA + depends on RV + # XXX: add dependencies if there + select DA_MON_EVENTS_IMPLICIT + bool "test_da monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_da/test_da.c new file +95 -0
95 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_da/test_da.h new file +47 -0
47 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_da/test_da_trace.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_DA +DEFINE_EVENT (event_da_monitor, event_test_da, + TP_PROTO(char *state, char *event, char *next_state, bool final_state), +TP_ARGS (state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor, error_test_da, +TP_PROTO (char *state, char *event), +TP_ARGS (state, event)); +#endif /* CONFIG_RV_MON_TEST_DA */
tools/verification/rvgen/tests/golden/test_ha/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_HA + depends on RV + # XXX: add dependencies if there + select HA_MON_EVENTS_ID + bool "test_ha monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_ha/test_ha.c new file +247 -0
247 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ha/test_ha.h new file +72 -0
72 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ha/test_ha_trace.h new file +19 -0
@@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_HA +DEFINE_EVENT (event_da_monitor_id, event_test_ha, + TP_PROTO(int id, char *state, char *event, char *next_state, bool final_state), +TP_ARGS (id, state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor_id, error_test_ha, + TP_PROTO(int id, char *state, char *event), +TP_ARGS (id, state, event)); + +DEFINE_EVENT (error_env_da_monitor_id, error_env_test_ha, + TP_PROTO(int id, char *state, char *event, char *env), +TP_ARGS (id, state, event, env)); +#endif /* CONFIG_RV_MON_TEST_HA */
tools/verification/rvgen/tests/golden/test_ltl/Kconfig new file +11 -0
@@ -0,0 +1,11 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_LTL + depends on RV + # XXX: add dependencies if there + depends on RV_MON_LTL_PARENT + default y + select LTL_MON_EVENTS_ID + bool "test_ltl monitor" + help + Simple description
tools/verification/rvgen/tests/golden/test_ltl/test_ltl.c new file +108 -0
108 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ltl/test_ltl.h new file +108 -0
108 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ltl/test_ltl_trace.h new file +14 -0
@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_LTL +DEFINE_EVENT (event_ltl_monitor_id, event_test_ltl, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_test_ltl, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_TEST_LTL */
tools/verification/rvgen/tests/specs/test_da.dot new file +16 -0
@@ -0,0 +1,16 @@ +digraph state_automaton { + {node [shape = circle] "state_b"}; + {node [shape = plaintext, style=invis, label=""] "__init_state_a"}; + {node [shape = doublecircle] "state_a"}; + {node [shape = circle] "state_a"}; + "__init_state_a" -> "state_a"; + "state_a" [label = "state_a"]; + "state_a" -> "state_a" [ label = "event_2" ]; + "state_a" -> "state_b" [ label = "event_1" ]; + "state_b" [label = "state_b"]; + "state_b" -> "state_a" [ label = "event_2" ]; + { rank = min ; + "__init_state_a"; + "state_a"; + } +}
tools/verification/rvgen/tests/specs/test_da2.dot new file +19 -0
@@ -0,0 +1,19 @@ +digraph state_automaton { + {node [shape = circle] "state_b"}; + {node [shape = circle] "state_c"}; + {node [shape = plaintext, style=invis, label=""] "__init_state_a"}; + {node [shape = doublecircle] "state_a"}; + {node [shape = circle] "state_a"}; + "__init_state_a" -> "state_a"; + "state_a" [label = "state_a"]; + "state_a" -> "state_b" [ label = "event_1" ]; + "state_a" -> "state_c" [ label = "event_2" ]; + "state_b" [label = "state_b"]; + "state_b" -> "state_a" [ label = "event_2" ]; + "state_b" -> "state_c" [ label = "event_3" ]; + "state_c" [label = "state_c"]; + { rank = min ; + "__init_state_a"; + "state_a"; + } +}
tools/verification/rvgen/tests/specs/test_ha.dot new file +27 -0
@@ -0,0 +1,27 @@ +digraph state_automaton { + center = true; + size = "7,11"; + {node [shape = circle] "S1"}; + {node [shape = plaintext, style=invis, label=""] "__init_S0"}; + {node [shape = doublecircle] "S0"}; + {node [shape = circle] "S0"}; + {node [shape = circle] "S2"}; + {node [shape = circle] "S3"}; + "__init_S0" -> "S0"; + "S0" [label = "S0\nclk < bar_ns()", color = green3]; + "S1" [label = "S1"]; + "S2" [label = "S2\nclk < BAR_NS()"]; + "S3" [label = "S3"]; + "S1" -> "S0" [ label = "event0;reset(clk)" ]; + "S0" -> "S1" [ label = "event1;reset(clk)" ]; + "S0" -> "S0" [ label = "event0;reset(clk)" ]; + "S1" -> "S2" [ label = "event2;env1 == 0;reset(clk)" ]; + "S2" -> "S3" [ label = "event2" ]; + "S2" -> "S2" [ label = "event1;clk < foo_ns" ]; + "S3" -> "S0" [ label = "event0;clk < FOO_NS && env2 == 0" ]; + "S3" -> "S1" [ label = "event1;clk < 5us && env1 == 1;reset(clk)" ]; + { rank = min ; + "__init_S0"; + "S0"; + } +}
tools/verification/rvgen/tests/specs/test_invalid.dot new file +8 -0
@@ -0,0 +1,8 @@ +digraph invalid { + {node [shape = circle] "init"}; + {node [shape = circle] "state1"}; + "init" [label = "init"]; + "init" -> "state1" [ label = "event_a" ]; + "state1" [label = "state1"]; + "state1" -> "init" [ label = "event_b" ]; +}
tools/verification/rvgen/tests/specs/test_invalid.ltl new file +1 -0
@@ -0,0 +1 @@ +RULE = A invalid B
tools/verification/rvgen/tests/specs/test_invalid_ha.dot new file +16 -0
@@ -0,0 +1,16 @@ +digraph state_automaton { + {node [shape = circle] "state_b"}; + {node [shape = plaintext, style=invis, label=""] "__init_state_a"}; + {node [shape = doublecircle] "state_a"}; + {node [shape = circle] "state_a"}; + "__init_state_a" -> "state_a"; + "state_a" [label = "state_a;clk < 1"]; + "state_a" -> "state_a" [ label = "event_2;reset(clk)" ]; + "state_a" -> "state_b" [ label = "event_1;wrong_constraint" ]; + "state_b" [label = "state_b"]; + "state_b" -> "state_a" [ label = "event_2" ]; + { rank = min ; + "__init_state_a"; + "state_a"; + } +}
tools/verification/rvgen/tests/specs/test_ltl.ltl new file +1 -0
@@ -0,0 +1 @@ +RULE = always (EVENT_A imply eventually EVENT_B)
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 8/17 verification/rvgen: Add selftests
In reply to Gabriele MonacoThe rvgen code generator needs validation to ensure it produces correct monitor implementations from input specifications.
Add selftests with golden reference outputs covering all monitor classes (DA, HA, LTL) and types (global, per_cpu, per_task, per_obj), including optional features like descriptions and parent monitors. Container generation and error handling (missing files, invalid specifications, missing arguments) are also validated against expected output.
--- tools/verification/rvgen/Makefile | 4 + .../rvgen/tests/rvgen_container.t | 20 +++++ .../verification/rvgen/tests/rvgen_monitor.t | 87 +++++++++++++++++++ tools/verification/tests/engine.sh | 34 ++++++++ 4 files changed, 145 insertions(+) create mode 100644 tools/verification/rvgen/tests/rvgen_container.t create mode 100644 tools/verification/rvgen/tests/rvgen_monitor.t
tools/verification/rvgen/Makefile +4 -0
@@ -13,6 +13,10 @@ all: .PHONY: clean clean: +.PHONY: check +check: + prove -o --directives -f tests/ + .PHONY: install install: $(INSTALL) rvgen/automata.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/automata.py
tools/verification/rvgen/tests/rvgen_container.t new file +20 -0
@@ -0,0 +1,20 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0 +source ../tests/engine.sh +test_begin + +set_timeout 30s + +# Help tests +check "verify container subcommand help" \ + "$RVGEN container -h" 0 "model_name" "class" + +check_and_compare_folder "container with description" \ + "$RVGEN container -n test_container -D 'Test container for grouping monitors'" \ + "test_container" "Writing the monitor into the directory test_container" + +# Error handling tests +check "missing required model_name" \ + "$RVGEN container" 2 "the following arguments are required: -n/--model_name" + +test_end
tools/verification/rvgen/tests/rvgen_monitor.t new file +87 -0
87 lines not on this page · raw message
tools/verification/tests/engine.sh +34 -0
@@ -5,6 +5,8 @@ test_begin() { # included correctly. ctr=0 [ -z "$RV" ] && RV="../rv/rv" + [ -z "$RVGEN" ] && RVGEN="python3 ../rvgen" + [ -z "$GOLDEN_DIR" ] && GOLDEN_DIR="tests/golden" [ -n "$TEST_COUNT" ] && echo "1..$TEST_COUNT" }
@@ -118,6 +120,38 @@ check_if_exists() { fi } +check_and_compare_folder() { + # Run command, compare generated folder to golden, and cleanup + local desc=$1 + local command=$2 + local generated_dir=$3 + local expected_output=$4 + local unexpected_output=$5 + local golden_dir="$GOLDEN_DIR/$generated_dir" + + ctr=$((ctr + 1)) + if [ -n "$TEST_COUNT" ]; then + rm -rf "$generated_dir" + _check "$desc" "$command" 0 "$expected_output" "$unexpected_output" + + if [ "$fail" -eq 0 ] && [ ! -d "$generated_dir" ]; then + failure "# Generated directory not found: $generated_dir" + fi + + if [ "$fail" -ne 0 ]; then + : + elif ! diff -r "$generated_dir" "$golden_dir" &> /dev/null; then + failure "# Directories differ:" + failbuf+=$(diff -r "$generated_dir" "$golden_dir" 2>&1 | sed 's/^/# /') + failbuf+=$'\n' + fi + + report "$1" + + rm -rf "$generated_dir" + fi +} + set_timeout() { TIMEOUT="timeout -v -k 30s $1" }
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 9/17 verification/rvgen: Add the rvgen kunit subcommand
In reply to Gabriele MonacoAdd the rvgen kunit subcommand to patch an already generated monitor for kunit support. It parses the handlers and create the necessary structs and initialisations.
The only remaining manual steps are importing the test in the runner and writing the test itself.
---
Notes:
V4:
* Use pathlib instead of os.path
* Rename files to backup instead of writing to backup
tools/verification/rvgen/Makefile | 1 + tools/verification/rvgen/__main__.py | 15 +- tools/verification/rvgen/rvgen/generator.py | 4 +- tools/verification/rvgen/rvgen/kunit.py | 194 ++++++++++++++++++ .../rvgen/rvgen/templates/kunit.c | 33 +++ 5 files changed, 244 insertions(+), 3 deletions(-) create mode 100644 tools/verification/rvgen/rvgen/kunit.py create mode 100644 tools/verification/rvgen/rvgen/templates/kunit.c
tools/verification/rvgen/Makefile +1 -0
@@ -23,6 +23,7 @@ install: $(INSTALL) rvgen/dot2c.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2c.py $(INSTALL) dot2c -D -m 755 $(DESTDIR)$(bindir)/ $(INSTALL) rvgen/dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2k.py + $(INSTALL) rvgen/kunit.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/kunit.py $(INSTALL) rvgen/container.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/container.py $(INSTALL) rvgen/generator.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/generator.py $(INSTALL) rvgen/ltl2ba.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/ltl2ba.py
tools/verification/rvgen/__main__.py +14 -1
@@ -13,6 +13,7 @@ if __name__ == '__main__': from rvgen.generator import Monitor from rvgen.container import Container from rvgen.ltl2k import ltl2k + from rvgen.kunit import KUnit, KUnitError from rvgen.automata import AutomataError import argparse import sys
@@ -41,6 +42,11 @@ if __name__ == '__main__': container_parser = subparsers.add_parser("container", parents=[parent_parser]) container_parser.add_argument('-n', "--model_name", dest="model_name", required=True) + kunit_parser = subparsers.add_parser("kunit", parents=[parent_parser]) + kunit_parser.add_argument('-n', "--model_name", dest="model_name", required=True) + kunit_parser.add_argument('-l', "--local", dest="local", action="store_true", required=False, + help="Force looking for the monitor in the current directory only") + params = parser.parse_args() try:
@@ -55,11 +61,18 @@ if __name__ == '__main__': else: print("Unknown monitor class:", params.monitor_class) sys.exit(1) - else: + elif params.subcmd == "container": monitor = Container(vars(params)) + elif params.subcmd == "kunit": + monitor = KUnit(vars(params)) + monitor.print_files() + sys.exit(0) except AutomataError as e: print(f"There was an error processing {params.spec}: {e}", file=sys.stderr) sys.exit(1) + except KUnitError as e: + print(f"There was an error generating KUnit files: {e}", file=sys.stderr) + sys.exit(1) print(f"Writing the monitor into the directory {monitor.name}") monitor.print_files()
tools/verification/rvgen/rvgen/generator.py +2 -2
@@ -22,9 +22,9 @@ class RVGenerator: self.description = extra_params.get("description", self.name) or "auto-generated" self.auto_patch = extra_params.get("auto_patch") if self.auto_patch: - self.__fill_rv_kernel_dir() + self._fill_rv_kernel_dir() - def __fill_rv_kernel_dir(self): + def _fill_rv_kernel_dir(self): # find the kernel tree root relative to this file's location resolved_path = Path(__file__).resolve() if len(resolved_path.parents) > 4:
tools/verification/rvgen/rvgen/kunit.py new file +194 -0
194 lines not on this page · raw message
tools/verification/rvgen/rvgen/templates/kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "%%MODEL_NAME%%_kunit.h" + +#if IS_REACHABLE(CONFIG_RV_MON_%%MODEL_NAME_UP%%) + +static void rv_test_%%MODEL_NAME%%(struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + + prepare_test(test, &%%STRUCT_NAME%%.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* %%STRUCT_NAME%%.handle_event(args); +*/ +} + +#else +#define rv_test_%%MODEL_NAME%% rv_test_stub +#endif
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 10/17 verification/rvgen: Add selftests for rvgen kunit
In reply to Gabriele MonacoThe rvgen kunit command patches monitor files and adds necessary definitions for kunit tests.
Add a test case validating its behaviour on dummy generated files and comparing it against reference files, like it's done for rvgen monitor.
--- .../rvgen/tests/golden/test_bak_kunit/Kconfig | 9 + .../golden/test_bak_kunit/test_bak_kunit.c | 107 +++++++ .../golden/test_bak_kunit/test_bak_kunit.h | 108 ++++++++ .../test_bak_kunit/test_bak_kunit_kunit.c | 33 +++ .../test_bak_kunit/test_bak_kunit_kunit.c.bak | 1 + .../test_bak_kunit/test_bak_kunit_kunit.h | 22 ++ .../test_bak_kunit/test_bak_kunit_trace.h | 14 + .../rvgen/tests/golden/test_da_kunit/Kconfig | 9 + .../golden/test_da_kunit/test_da_kunit.c | 107 +++++++ .../golden/test_da_kunit/test_da_kunit.h | 47 ++++ .../test_da_kunit/test_da_kunit_kunit.c | 33 +++ .../test_da_kunit/test_da_kunit_kunit.h | 23 ++ .../test_da_kunit/test_da_kunit_trace.h | 15 + .../rvgen/tests/golden/test_ha_kunit/Kconfig | 9 + .../golden/test_ha_kunit/test_ha_kunit.c | 260 ++++++++++++++++++ .../golden/test_ha_kunit/test_ha_kunit.h | 88 ++++++ .../test_ha_kunit/test_ha_kunit_kunit.c | 33 +++ .../test_ha_kunit/test_ha_kunit_kunit.h | 24 ++ .../test_ha_kunit/test_ha_kunit_trace.h | 19 ++ .../rvgen/tests/golden/test_ltl_kunit/Kconfig | 9 + .../golden/test_ltl_kunit/test_ltl_kunit.c | 107 +++++++ .../golden/test_ltl_kunit/test_ltl_kunit.h | 108 ++++++++ .../test_ltl_kunit/test_ltl_kunit_kunit.c | 33 +++ .../test_ltl_kunit/test_ltl_kunit_kunit.h | 22 ++ .../test_ltl_kunit/test_ltl_kunit_trace.h | 14 + tools/verification/rvgen/tests/rvgen_kunit.t | 41 +++ 26 files changed, 1295 insertions(+) create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c.bak create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/rvgen_kunit.t
tools/verification/rvgen/tests/golden/test_bak_kunit/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_BAK_KUNIT + depends on RV + # XXX: add dependencies if there + select LTL_MON_EVENTS_ID + bool "test_bak_kunit monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.c new file +107 -0
107 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.h new file +108 -0
108 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_bak_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_BAK_KUNIT ) + +static void rv_test_test_bak_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_bak_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_bak_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_bak_kunit rv_test_stub +#endif
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c.bak new file +1 -0
@@ -0,0 +1 @@ +DUMMY
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.h new file +22 -0
@@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_BAK_KUNIT_KUNIT_H +#define __TEST_BAK_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_bak_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_example_event)(void *data, /* XXX: fill header */); +} rv_test_bak_kunit_ops; +#endif + +#endif /* __TEST_BAK_KUNIT_KUNIT_H */
tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_trace.h new file +14 -0
@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_BAK_KUNIT +DEFINE_EVENT (event_ltl_monitor_id, event_test_bak_kunit, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_test_bak_kunit, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_TEST_BAK_KUNIT */
tools/verification/rvgen/tests/golden/test_da_kunit/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_DA_KUNIT + depends on RV + # XXX: add dependencies if there + select DA_MON_EVENTS_IMPLICIT + bool "test_da_kunit monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.c new file +107 -0
107 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.h new file +47 -0
47 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_da_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_DA_KUNIT ) + +static void rv_test_test_da_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_da_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_da_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_da_kunit rv_test_stub +#endif
tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.h new file +23 -0
@@ -0,0 +1,23 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_DA_KUNIT_KUNIT_H +#define __TEST_DA_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_da_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_event_1)(void *data, /* XXX: fill header */); + void (*handle_event_2)(void *data, /* XXX: fill header */); +} rv_test_da_kunit_ops; +#endif + +#endif /* __TEST_DA_KUNIT_KUNIT_H */
tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_trace.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_DA_KUNIT +DEFINE_EVENT (event_da_monitor, event_test_da_kunit, + TP_PROTO(char *state, char *event, char *next_state, bool final_state), +TP_ARGS (state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor, error_test_da_kunit, +TP_PROTO (char *state, char *event), +TP_ARGS (state, event)); +#endif /* CONFIG_RV_MON_TEST_DA_KUNIT */
tools/verification/rvgen/tests/golden/test_ha_kunit/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_HA_KUNIT + depends on RV + # XXX: add dependencies if there + select HA_MON_EVENTS_ID + bool "test_ha_kunit monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.c new file +260 -0
260 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.h new file +88 -0
88 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_ha_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_HA_KUNIT ) + +static void rv_test_test_ha_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_ha_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_ha_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_ha_kunit rv_test_stub +#endif
tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_HA_KUNIT_KUNIT_H +#define __TEST_HA_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_ha_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_event0)(void *data, /* XXX: fill header */); + void (*handle_event1)(void *data, /* XXX: fill header */); + void (*handle_event2)(void *data, /* XXX: fill header */); +} rv_test_ha_kunit_ops; +#endif + +#endif /* __TEST_HA_KUNIT_KUNIT_H */
tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_trace.h new file +19 -0
@@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_HA_KUNIT +DEFINE_EVENT (event_da_monitor_id, event_test_ha_kunit, + TP_PROTO(int id, char *state, char *event, char *next_state, bool final_state), +TP_ARGS (id, state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor_id, error_test_ha_kunit, + TP_PROTO(int id, char *state, char *event), +TP_ARGS (id, state, event)); + +DEFINE_EVENT (error_env_da_monitor_id, error_env_test_ha_kunit, + TP_PROTO(int id, char *state, char *event, char *env), +TP_ARGS (id, state, event, env)); +#endif /* CONFIG_RV_MON_TEST_HA_KUNIT */
tools/verification/rvgen/tests/golden/test_ltl_kunit/Kconfig new file +9 -0
@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_LTL_KUNIT + depends on RV + # XXX: add dependencies if there + select LTL_MON_EVENTS_ID + bool "test_ltl_kunit monitor" + help + auto-generated
tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.c new file +107 -0
107 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.h new file +108 -0
108 lines not on this page · raw message
tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_ltl_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_LTL_KUNIT ) + +static void rv_test_test_ltl_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_ltl_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_ltl_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_ltl_kunit rv_test_stub +#endif
tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.h new file +22 -0
@@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_LTL_KUNIT_KUNIT_H +#define __TEST_LTL_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_ltl_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_example_event)(void *data, /* XXX: fill header */); +} rv_test_ltl_kunit_ops; +#endif + +#endif /* __TEST_LTL_KUNIT_KUNIT_H */
tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_trace.h new file +14 -0
@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_LTL_KUNIT +DEFINE_EVENT (event_ltl_monitor_id, event_test_ltl_kunit, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_test_ltl_kunit, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_TEST_LTL_KUNIT */
tools/verification/rvgen/tests/rvgen_kunit.t new file +41 -0
41 lines not on this page · raw message
Signature · 1 line
2.55.0
Re: [PATCH v5 10/17] verification/rvgen: Add selftests for rvgen kunit
Hi Gabriele,
Quoted 8 lines · Gabriele Monaco
The rvgen kunit command patches monitor files and adds necessary definitions for kunit tests.
Add a test case validating its behaviour on dummy generated files and comparing it against reference files, like it's done for rvgen monitor.
Reviewed-by Nam Cao <[email protected]>Signed-off-by Gabriele Monaco <[email protected]>
Thanks for your patch, which is now commit 7b6246294eb0 upstream.
Quoted 6 lines
--- .../rvgen/tests/golden/test_bak_kunit/Kconfig | 9 + .../golden/test_bak_kunit/test_bak_kunit.c | 107 +++++++ .../golden/test_bak_kunit/test_bak_kunit.h | 108 ++++++++ .../test_bak_kunit/test_bak_kunit_kunit.c | 33 +++ .../test_bak_kunit/test_bak_kunit_kunit.c.bak | 1 +
I noticed a issue regarding the .bak file introduced in this patch.
When running make distclean on the kernel tree, this file gets automatically deleted. As a result, git tracks this as a deleted file and leaves a dirty working tree, which is a bit annoying during development. Would it be possible to use a different extension for this golden file, such as .backup or something, to prevent it from being swept up by the generic clean rules?
Regards,
Kuan-Wei
Quoted 1,504 lines
.../test_bak_kunit/test_bak_kunit_kunit.h | 22 ++ .../test_bak_kunit/test_bak_kunit_trace.h | 14 + .../rvgen/tests/golden/test_da_kunit/Kconfig | 9 + .../golden/test_da_kunit/test_da_kunit.c | 107 +++++++ .../golden/test_da_kunit/test_da_kunit.h | 47 ++++ .../test_da_kunit/test_da_kunit_kunit.c | 33 +++ .../test_da_kunit/test_da_kunit_kunit.h | 23 ++ .../test_da_kunit/test_da_kunit_trace.h | 15 + .../rvgen/tests/golden/test_ha_kunit/Kconfig | 9 + .../golden/test_ha_kunit/test_ha_kunit.c | 260 ++++++++++++++++++ .../golden/test_ha_kunit/test_ha_kunit.h | 88 ++++++ .../test_ha_kunit/test_ha_kunit_kunit.c | 33 +++ .../test_ha_kunit/test_ha_kunit_kunit.h | 24 ++ .../test_ha_kunit/test_ha_kunit_trace.h | 19 ++ .../rvgen/tests/golden/test_ltl_kunit/Kconfig | 9 + .../golden/test_ltl_kunit/test_ltl_kunit.c | 107 +++++++ .../golden/test_ltl_kunit/test_ltl_kunit.h | 108 ++++++++ .../test_ltl_kunit/test_ltl_kunit_kunit.c | 33 +++ .../test_ltl_kunit/test_ltl_kunit_kunit.h | 22 ++ .../test_ltl_kunit/test_ltl_kunit_trace.h | 14 + tools/verification/rvgen/tests/rvgen_kunit.t | 41 +++ 26 files changed, 1295 insertions(+) create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c.bak create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/Kconfig create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.c create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.h create mode 100644 tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_trace.h create mode 100644 tools/verification/rvgen/tests/rvgen_kunit.ttools/verification/rvgen/tests/golden/test_bak_kunit/Kconfig new file +9
-0@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_BAK_KUNIT + depends on RV + # XXX: add dependencies if there + select LTL_MON_EVENTS_ID + bool "test_bak_kunit monitor" + help + auto-generatedtools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.c new file +107
-0@@ -0,0 +1,107 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/ftrace.h> +#include <linux/tracepoint.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/init.h> +#include <linux/rv.h> +#include <rv/instrumentation.h> + +#define MODULE_NAME "test_bak_kunit" + +/* +* XXX: include required tracepoint headers, e.g., +* #include <trace/events/sched.h> +*/ +#include <rv_trace.h> + + +/* +* This is the self-generated part of the monitor. Generally, there is no need +* to touch this section. +*/ +#include "test_bak_kunit.h" +#include <rv/ltl_monitor.h> + +static void ltl_atoms_fetch (struct task_struct *task,struct ltl_monitor *mon) +{ +/* +* This is called everytime the Buchi automaton is triggered. +* +* This function could be used to fetch the atomic propositions which +* are expensive to trace. It is possible only if the atomic proposition +* does not need to be updated at precise time. +* +* It is recommended to use tracepoints and ltl_atom_update() instead. +*/ +} + +static void ltl_atoms_init (struct task_struct *task,struct ltl_monitor *mon,bool task_creation) +{ +/* +* This should initialize as many atomic propositions as possible. +* +* @task_creation indicates whether the task is being created. This is +* false if the task is already running before the monitor is enabled. +*/ +ltl_atom_set (mon,LTL_EVENT_A , true/false); +ltl_atom_set (mon,LTL_EVENT_B , true/false); +} + +/* +* This is the instrumentation part of the monitor. +* +* This is the section where manual work is required. Here the kernel events +* are translated into model's event. +*/ +static void handle_example_event(void *data, /* XXX: fill header */) +{ +ltl_atom_update (task,LTL_EVENT_A , true/false); +} + +static int enable_test_bak_kunit (void ) +{ +int retval; + + retval =ltl_monitor_init (); +if (retval) +return retval; + + rv_attach_trace_probe("test_bak_kunit", /* XXX: tracepoint */, handle_example_event); + +return 0 ; +} + +static void disable_test_bak_kunit (void ) +{ + rv_detach_trace_probe("test_bak_kunit", /* XXX: tracepoint */, handle_example_event); + +ltl_monitor_destroy (); +} + +/* +* This is the monitor register section. +*/ +static struct rv_monitor rv_this = { + .name ="test_bak_kunit" , + .description ="auto-generated" , + .enable = enable_test_bak_kunit, + .disable = disable_test_bak_kunit, +}; + +static int __init register_test_bak_kunit (void ) +{ +return rv_register_monitor (&rv_this,NULL ); +} + +static void __exit unregister_test_bak_kunit(void) +{ +rv_unregister_monitor (&rv_this); +} + +module_init (register_test_bak_kunit); +module_exit (unregister_test_bak_kunit); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("rvgen: auto-generated" ); +MODULE_DESCRIPTION ("test_bak_kunit: auto-generated" );tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit.h new file +108
-0@@ -0,0 +1,108 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* C implementation of Buchi automaton, automatically generated by +* tools/verification/rvgen from the linear temporal logic specification. +* For further information, see kernel documentation: +* Documentation/trace/rv/linear_temporal_logic.rst +*/ + +#include <linux/rv.h> + +#define MONITOR_NAME test_bak_kunit + +enum ltl_atom { +LTL_EVENT_A , +LTL_EVENT_B , +LTL_NUM_ATOM +}; +static_assert (LTL_NUM_ATOM <=RV_MAX_LTL_ATOM ); + +static const char *ltl_atom_str (enum ltl_atom atom) +{ +static const char *const names[] = { +"ev_a" , +"ev_b" , + }; + +return names[atom]; +} + +enum ltl_buchi_state { +S0 , +S1 , +S2 , +S3 , +S4 , +RV_NUM_BA_STATES +}; +static_assert (RV_NUM_BA_STATES <=RV_MAX_BA_STATES ); + +static void ltl_start (struct task_struct *task,struct ltl_monitor *mon) +{ +bool event_b =test_bit (LTL_EVENT_B , mon->atoms); +bool event_a =test_bit (LTL_EVENT_A , mon->atoms); +bool val1 = !event_a; + +if (val1) +__set_bit (S0 , mon->states); +if (true) +__set_bit (S1 , mon->states); +if (event_b) +__set_bit (S4 , mon->states); +} + +static void +ltl_possible_next_states (struct ltl_monitor *mon,unsigned int state,unsigned long *next) +{ +bool event_b =test_bit (LTL_EVENT_B , mon->atoms); +bool event_a =test_bit (LTL_EVENT_A , mon->atoms); +bool val1 = !event_a; + +switch (state) { +case S0 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S1 : +if (true) +__set_bit (S1 , next); +if (true && val1) +__set_bit (S2 , next); +if (event_b && val1) +__set_bit (S3 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S2 : +if (true) +__set_bit (S1 , next); +if (true && val1) +__set_bit (S2 , next); +if (event_b && val1) +__set_bit (S3 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S3 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S4 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; + } +}tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c new file +33
-0@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_bak_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_BAK_KUNIT ) + +static void rv_test_test_bak_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_bak_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_bak_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_bak_kunit rv_test_stub +#endif tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.c.bak new file +1
-0@@ -0,0 +1 @@ +DUMMYtools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_kunit.h new file +22
-0@@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_BAK_KUNIT_KUNIT_H +#define __TEST_BAK_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_bak_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_example_event)(void *data, /* XXX: fill header */); +} rv_test_bak_kunit_ops; +#endif + +#endif /* __TEST_BAK_KUNIT_KUNIT_H */ tools/verification/rvgen/tests/golden/test_bak_kunit/test_bak_kunit_trace.h new file +14
-0@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_BAK_KUNIT +DEFINE_EVENT (event_ltl_monitor_id, event_test_bak_kunit, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_test_bak_kunit, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_TEST_BAK_KUNIT */ tools/verification/rvgen/tests/golden/test_da_kunit/Kconfig new file +9
-0@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_DA_KUNIT + depends on RV + # XXX: add dependencies if there + select DA_MON_EVENTS_IMPLICIT + bool "test_da_kunit monitor" + help + auto-generatedtools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.c new file +107
-0@@ -0,0 +1,107 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/ftrace.h> +#include <linux/tracepoint.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/init.h> +#include <linux/rv.h> +#include <rv/instrumentation.h> + +#define MODULE_NAME "test_da_kunit" + +/* +* XXX: include required tracepoint headers, e.g., +* #include <trace/events/sched.h> +*/ +#include <rv_trace.h> + +/* +* This is the self-generated part of the monitor. Generally, there is no need +* to touch this section. +*/ +#define RV_MON_TYPE RV_MON_PER_CPU +#include "test_da_kunit.h" +#include <rv/da_monitor.h> + +/* +* This is the instrumentation part of the monitor. +* +* This is the section where manual work is required. Here the kernel events +* are translated into model's event. +* +*/ +static void handle_event_1(void *data, /* XXX: fill header */) +{ +da_handle_event (event_1_test_da_kunit); +} + +static void handle_event_2(void *data, /* XXX: fill header */) +{ +/* XXX: validate that this event always leads to the initial state */ +da_handle_start_event (event_2_test_da_kunit); +} + +static int enable_test_da_kunit (void ) +{ +int retval; + + retval =da_monitor_init (); +if (retval) +return retval; + + rv_attach_trace_probe("test_da_kunit", /* XXX: tracepoint */, handle_event_1); + rv_attach_trace_probe("test_da_kunit", /* XXX: tracepoint */, handle_event_2); + +return 0 ; +} + +static void disable_test_da_kunit (void ) +{ + rv_this.enabled =0 ; + + rv_detach_trace_probe("test_da_kunit", /* XXX: tracepoint */, handle_event_1); + rv_detach_trace_probe("test_da_kunit", /* XXX: tracepoint */, handle_event_2); + +da_monitor_destroy (); +} + +/* +* This is the monitor register section. +*/ +static struct rv_monitor rv_this = { + .name ="test_da_kunit" , + .description ="auto-generated" , + .enable = enable_test_da_kunit, + .disable = disable_test_da_kunit, + .reset = da_monitor_reset_all, + .enabled =0 , +}; + +static int __init register_test_da_kunit (void ) +{ +return rv_register_monitor (&rv_this,NULL ); +} + +static void __exit unregister_test_da_kunit(void) +{ +rv_unregister_monitor (&rv_this); +} + +module_init (register_test_da_kunit); +module_exit (unregister_test_da_kunit); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("rvgen: auto-generated" ); +MODULE_DESCRIPTION ("test_da_kunit: auto-generated" ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "test_da_kunit_kunit.h" + +const struct rv_test_da_kunit_ops rv_test_da_kunit_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_event_1 = handle_event_1, + .handle_event_2 = handle_event_2, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_test_da_kunit_ops); +#endif tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit.h new file +47
-0@@ -0,0 +1,47 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Automatically generated C representation of test_da_kunit automaton +* For further information about this format, see kernel documentation: +* Documentation/trace/rv/deterministic_automata.rst +*/ + +#define MONITOR_NAME test_da_kunit + +enum states_test_da_kunit { + state_a_test_da_kunit, + state_b_test_da_kunit, + state_max_test_da_kunit, +}; + +#define INVALID_STATE state_max_test_da_kunit + +enum events_test_da_kunit { + event_1_test_da_kunit, + event_2_test_da_kunit, + event_max_test_da_kunit, +}; + +struct automaton_test_da_kunit { +char *state_names[state_max_test_da_kunit]; +char *event_names[event_max_test_da_kunit]; +unsigned char function[state_max_test_da_kunit][event_max_test_da_kunit]; +unsigned char initial_state; +bool final_states[state_max_test_da_kunit]; +}; + +static const struct automaton_test_da_kunit automaton_test_da_kunit = { + .state_names = { +"state_a" , +"state_b" , + }, + .event_names = { +"event_1" , +"event_2" , + }, + .function = { + { state_b_test_da_kunit, state_a_test_da_kunit }, + {INVALID_STATE , state_a_test_da_kunit }, + }, + .initial_state = state_a_test_da_kunit, + .final_states = {1 ,0 }, +};tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.c new file +33
-0@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_da_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_DA_KUNIT ) + +static void rv_test_test_da_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_da_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_da_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_da_kunit rv_test_stub +#endif tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_kunit.h new file +23
-0@@ -0,0 +1,23 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_DA_KUNIT_KUNIT_H +#define __TEST_DA_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_da_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_event_1)(void *data, /* XXX: fill header */); + void (*handle_event_2)(void *data, /* XXX: fill header */); +} rv_test_da_kunit_ops; +#endif + +#endif /* __TEST_DA_KUNIT_KUNIT_H */ tools/verification/rvgen/tests/golden/test_da_kunit/test_da_kunit_trace.h new file +15
-0@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_DA_KUNIT +DEFINE_EVENT (event_da_monitor, event_test_da_kunit, + TP_PROTO(char *state, char *event, char *next_state, bool final_state), +TP_ARGS (state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor, error_test_da_kunit, +TP_PROTO (char *state, char *event), +TP_ARGS (state, event)); +#endif /* CONFIG_RV_MON_TEST_DA_KUNIT */ tools/verification/rvgen/tests/golden/test_ha_kunit/Kconfig new file +9
-0@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_HA_KUNIT + depends on RV + # XXX: add dependencies if there + select HA_MON_EVENTS_ID + bool "test_ha_kunit monitor" + help + auto-generatedtools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.c new file +260
-0@@ -0,0 +1,260 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/ftrace.h> +#include <linux/tracepoint.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/init.h> +#include <linux/rv.h> +#include <rv/instrumentation.h> + +#define MODULE_NAME "test_ha_kunit" + +/* +* XXX: include required tracepoint headers, e.g., +* #include <trace/events/sched.h> +*/ +#include <rv_trace.h> + +/* +* This is the self-generated part of the monitor. Generally, there is no need +* to touch this section. +*/ +#define RV_MON_TYPE RV_MON_PER_TASK +/* XXX: If the monitor has several instances, consider HA_TIMER_WHEEL */ +#define HA_TIMER_TYPE HA_TIMER_HRTIMER +#include "test_ha_kunit.h" +#include <rv/ha_monitor.h> + +/* +* This is the instrumentation part of the monitor. +* +* This is the section where manual work is required. Here the kernel events +* are translated into model's event. +* +*/ +#define BAR_NS (ha_mon)/* XXX: what is BAR_NS(ha_mon)? */ + +#define FOO_NS /* XXX: what is FOO_NS? */ + +static inline u64 bar_ns (struct ha_monitor *ha_mon) +{ +return /* XXX: what is bar_ns(ha_mon)? */ ; +} + +static u64 foo_ns = /* XXX: default value */; +module_param (foo_ns, ullong,0644 ); + +/* +* These functions define how to read and reset the environment variable. +* +* Common environment variables like ns-based and jiffy-based clocks have +* pre-define getters and resetters you can use. The parser can infer the type +* of the environment variable if you supply a measure unit in the constraint. +* If you define your own functions, make sure to add appropriate memory +* barriers if required. +* Some environment variables don't require a storage as they read a system +* state (e.g. preemption count). Those variables are never reset, so we don't +* define a reset function on monitors only relying on this type of variables. +*/ +static u64 ha_get_env (struct ha_monitor *ha_mon,enum envs_test_ha_kunit env,u64 time_ns) +{ +if (env == clk_test_ha_kunit) +return ha_get_clk_ns (ha_mon, env, time_ns); +else if (env == env1_test_ha_kunit) +return /* XXX: how do I read env1? */ + else if (env == env2_test_ha_kunit) +return /* XXX: how do I read env2? */ + return ENV_INVALID_VALUE; +} + +static void ha_reset_env (struct ha_monitor *ha_mon,enum envs_test_ha_kunit env,u64 time_ns) +{ +if (env == clk_test_ha_kunit) +ha_reset_clk_ns (ha_mon, env, time_ns); +} + +/* +* These functions are used to validate state transitions. +* +* They are generated by parsing the model, there is usually no need to change them. +* If the monitor requires a timer, there are functions responsible to arm it when +* the next state has a constraint, cancel it in any other case and to check +* that it didn't expire before the callback run. Transitions to the same state +* without a reset never affect timers. +* Due to the different representations between invariants and guards, there is +* a function to convert it in case invariants or guards are reachable from +* another invariant without reset. Those are not present if not required in +* the model. This is all automatic but is worth checking because it may show +* errors in the model (e.g. missing resets). +*/ +static inline bool ha_verify_invariants (struct ha_monitor *ha_mon, +enum states curr_state,enum events event, +enum states next_state,u64 time_ns) +{ +if (curr_state == S0_test_ha_kunit) +return ha_check_invariant_ns (ha_mon, clk_test_ha_kunit, time_ns); +else if (curr_state == S2_test_ha_kunit) +return ha_check_invariant_ns (ha_mon, clk_test_ha_kunit, time_ns); +return true; +} + +static inline void ha_convert_inv_guard (struct ha_monitor *ha_mon, +enum states curr_state,enum events event, +enum states next_state,u64 time_ns) +{ +if (curr_state == next_state) +return ; +if (curr_state == S2_test_ha_kunit) +ha_inv_to_guard (ha_mon, clk_test_ha_kunit,BAR_NS (ha_mon), time_ns); +} + +static inline bool ha_verify_guards (struct ha_monitor *ha_mon, +enum states curr_state,enum events event, +enum states next_state,u64 time_ns) +{ +bool res = true; + +if (curr_state == S0_test_ha_kunit && event == event0_test_ha_kunit) +ha_reset_env (ha_mon, clk_test_ha_kunit, time_ns); +else if (curr_state == S0_test_ha_kunit && event == event1_test_ha_kunit) +ha_reset_env (ha_mon, clk_test_ha_kunit, time_ns); +else if (curr_state == S1_test_ha_kunit && event == event0_test_ha_kunit) +ha_reset_env (ha_mon, clk_test_ha_kunit, time_ns); +else if (curr_state == S1_test_ha_kunit && event == event2_test_ha_kunit) { + res =ha_get_env (ha_mon, env1_test_ha_kunit, time_ns) ==0ull ; +ha_reset_env (ha_mon, clk_test_ha_kunit, time_ns); + }else if (curr_state == S2_test_ha_kunit && event == event1_test_ha_kunit) + res =ha_monitor_env_invalid (ha_mon, clk_test_ha_kunit) || +ha_get_env (ha_mon, clk_test_ha_kunit, time_ns) < foo_ns; +else if (curr_state == S3_test_ha_kunit && event == event0_test_ha_kunit) + res =ha_monitor_env_invalid (ha_mon, clk_test_ha_kunit) || + (ha_get_env (ha_mon, clk_test_ha_kunit, time_ns) <FOO_NS && +ha_get_env (ha_mon, env2_test_ha_kunit, time_ns) ==0ull ); +else if (curr_state == S3_test_ha_kunit && event == event1_test_ha_kunit) { + res =ha_monitor_env_invalid (ha_mon, clk_test_ha_kunit) || + (ha_get_env (ha_mon, clk_test_ha_kunit, time_ns) <5000ull && +ha_get_env (ha_mon, env1_test_ha_kunit, time_ns) ==1ull ); +ha_reset_env (ha_mon, clk_test_ha_kunit, time_ns); + } +return res; +} + +static inline void ha_setup_invariants (struct ha_monitor *ha_mon, +enum states curr_state,enum events event, +enum states next_state,u64 time_ns) +{ +if (next_state == curr_state && event != event0_test_ha_kunit) +return ; +if (next_state == S0_test_ha_kunit) +ha_start_timer_ns (ha_mon, clk_test_ha_kunit,bar_ns (ha_mon), time_ns); +else if (next_state == S2_test_ha_kunit) +ha_start_timer_ns (ha_mon, clk_test_ha_kunit,BAR_NS (ha_mon), time_ns); +else if (curr_state == S0_test_ha_kunit) +ha_cancel_timer (ha_mon); +else if (curr_state == S2_test_ha_kunit) +ha_cancel_timer (ha_mon); +} + +static bool ha_verify_constraint (struct ha_monitor *ha_mon, +enum states curr_state,enum events event, +enum states next_state,u64 time_ns) +{ +if (!ha_verify_invariants (ha_mon, curr_state, event, next_state, time_ns)) +return false; + +ha_convert_inv_guard (ha_mon, curr_state, event, next_state, time_ns); + +if (!ha_verify_guards (ha_mon, curr_state, event, next_state, time_ns)) +return false; + +ha_setup_invariants (ha_mon, curr_state, event, next_state, time_ns); + +return true; +} + +static void handle_event0(void *data, /* XXX: fill header */) +{ +/* XXX: validate that this event always leads to the initial state */ + struct task_struct *p = /* XXX: how do I get p? */; +da_handle_start_event (p, event0_test_ha_kunit); +} + +static void handle_event1(void *data, /* XXX: fill header */) +{ + struct task_struct *p = /* XXX: how do I get p? */; +da_handle_event (p, event1_test_ha_kunit); +} + +static void handle_event2(void *data, /* XXX: fill header */) +{ + struct task_struct *p = /* XXX: how do I get p? */; +da_handle_event (p, event2_test_ha_kunit); +} + +static int enable_test_ha_kunit (void ) +{ +int retval; + + retval =ha_monitor_init (); +if (retval) +return retval; + + rv_attach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event0); + rv_attach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event1); + rv_attach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event2); + +return 0 ; +} + +static void disable_test_ha_kunit (void ) +{ + rv_this.enabled =0 ; + + rv_detach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event0); + rv_detach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event1); + rv_detach_trace_probe("test_ha_kunit", /* XXX: tracepoint */, handle_event2); + +ha_monitor_destroy (); +} + +/* +* This is the monitor register section. +*/ +static struct rv_monitor rv_this = { + .name ="test_ha_kunit" , + .description ="auto-generated" , + .enable = enable_test_ha_kunit, + .disable = disable_test_ha_kunit, + .reset = da_monitor_reset_all, + .enabled =0 , +}; + +static int __init register_test_ha_kunit (void ) +{ +return rv_register_monitor (&rv_this,NULL ); +} + +static void __exit unregister_test_ha_kunit(void) +{ +rv_unregister_monitor (&rv_this); +} + +module_init (register_test_ha_kunit); +module_exit (unregister_test_ha_kunit); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("rvgen: auto-generated" ); +MODULE_DESCRIPTION ("test_ha_kunit: auto-generated" ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "test_ha_kunit_kunit.h" + +const struct rv_test_ha_kunit_ops rv_test_ha_kunit_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_event0 = handle_event0, + .handle_event1 = handle_event1, + .handle_event2 = handle_event2, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_test_ha_kunit_ops); +#endif tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit.h new file +88
-0@@ -0,0 +1,88 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Automatically generated C representation of test_ha_kunit automaton +* For further information about this format, see kernel documentation: +* Documentation/trace/rv/deterministic_automata.rst +*/ + +#define MONITOR_NAME test_ha_kunit + +enum states_test_ha_kunit { + S0_test_ha_kunit, + S1_test_ha_kunit, + S2_test_ha_kunit, + S3_test_ha_kunit, + state_max_test_ha_kunit, +}; + +#define INVALID_STATE state_max_test_ha_kunit + +enum events_test_ha_kunit { + event0_test_ha_kunit, + event1_test_ha_kunit, + event2_test_ha_kunit, + event_max_test_ha_kunit, +}; + +enum envs_test_ha_kunit { + clk_test_ha_kunit, + env1_test_ha_kunit, + env2_test_ha_kunit, + env_max_test_ha_kunit, + env_max_stored_test_ha_kunit = env1_test_ha_kunit, +}; + +_Static_assert (env_max_stored_test_ha_kunit <=MAX_HA_ENV_LEN ,"Not enough slots" ); +#define HA_CLK_NS + +struct automaton_test_ha_kunit { +char *state_names[state_max_test_ha_kunit]; +char *event_names[event_max_test_ha_kunit]; +char *env_names[env_max_test_ha_kunit]; +unsigned char function[state_max_test_ha_kunit][event_max_test_ha_kunit]; +unsigned char initial_state; +bool final_states[state_max_test_ha_kunit]; +}; + +static const struct automaton_test_ha_kunit automaton_test_ha_kunit = { + .state_names = { +"S0" , +"S1" , +"S2" , +"S3" , + }, + .event_names = { +"event0" , +"event1" , +"event2" , + }, + .env_names = { +"clk" , +"env1" , +"env2" , + }, + .function = { + { + S0_test_ha_kunit, + S1_test_ha_kunit, +INVALID_STATE , + }, + { + S0_test_ha_kunit, +INVALID_STATE , + S2_test_ha_kunit, + }, + { +INVALID_STATE , + S2_test_ha_kunit, + S3_test_ha_kunit, + }, + { + S0_test_ha_kunit, + S1_test_ha_kunit, +INVALID_STATE , + }, + }, + .initial_state = S0_test_ha_kunit, + .final_states = {1 ,0 ,0 ,0 }, +};tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.c new file +33
-0@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_ha_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_HA_KUNIT ) + +static void rv_test_test_ha_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_ha_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_ha_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_ha_kunit rv_test_stub +#endif tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_kunit.h new file +24
-0@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_HA_KUNIT_KUNIT_H +#define __TEST_HA_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_ha_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_event0)(void *data, /* XXX: fill header */); + void (*handle_event1)(void *data, /* XXX: fill header */); + void (*handle_event2)(void *data, /* XXX: fill header */); +} rv_test_ha_kunit_ops; +#endif + +#endif /* __TEST_HA_KUNIT_KUNIT_H */ tools/verification/rvgen/tests/golden/test_ha_kunit/test_ha_kunit_trace.h new file +19
-0@@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_HA_KUNIT +DEFINE_EVENT (event_da_monitor_id, event_test_ha_kunit, + TP_PROTO(int id, char *state, char *event, char *next_state, bool final_state), +TP_ARGS (id, state, event, next_state, final_state)); + +DEFINE_EVENT (error_da_monitor_id, error_test_ha_kunit, + TP_PROTO(int id, char *state, char *event), +TP_ARGS (id, state, event)); + +DEFINE_EVENT (error_env_da_monitor_id, error_env_test_ha_kunit, + TP_PROTO(int id, char *state, char *event, char *env), +TP_ARGS (id, state, event, env)); +#endif /* CONFIG_RV_MON_TEST_HA_KUNIT */ tools/verification/rvgen/tests/golden/test_ltl_kunit/Kconfig new file +9
-0@@ -0,0 +1,9 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_TEST_LTL_KUNIT + depends on RV + # XXX: add dependencies if there + select LTL_MON_EVENTS_ID + bool "test_ltl_kunit monitor" + help + auto-generatedtools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.c new file +107
-0@@ -0,0 +1,107 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/ftrace.h> +#include <linux/tracepoint.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/init.h> +#include <linux/rv.h> +#include <rv/instrumentation.h> + +#define MODULE_NAME "test_ltl_kunit" + +/* +* XXX: include required tracepoint headers, e.g., +* #include <trace/events/sched.h> +*/ +#include <rv_trace.h> + + +/* +* This is the self-generated part of the monitor. Generally, there is no need +* to touch this section. +*/ +#include "test_ltl_kunit.h" +#include <rv/ltl_monitor.h> + +static void ltl_atoms_fetch (struct task_struct *task,struct ltl_monitor *mon) +{ +/* +* This is called everytime the Buchi automaton is triggered. +* +* This function could be used to fetch the atomic propositions which +* are expensive to trace. It is possible only if the atomic proposition +* does not need to be updated at precise time. +* +* It is recommended to use tracepoints and ltl_atom_update() instead. +*/ +} + +static void ltl_atoms_init (struct task_struct *task,struct ltl_monitor *mon,bool task_creation) +{ +/* +* This should initialize as many atomic propositions as possible. +* +* @task_creation indicates whether the task is being created. This is +* false if the task is already running before the monitor is enabled. +*/ +ltl_atom_set (mon,LTL_EVENT_A , true/false); +ltl_atom_set (mon,LTL_EVENT_B , true/false); +} + +/* +* This is the instrumentation part of the monitor. +* +* This is the section where manual work is required. Here the kernel events +* are translated into model's event. +*/ +static void handle_example_event(void *data, /* XXX: fill header */) +{ +ltl_atom_update (task,LTL_EVENT_A , true/false); +} + +static int enable_test_ltl_kunit (void ) +{ +int retval; + + retval =ltl_monitor_init (); +if (retval) +return retval; + + rv_attach_trace_probe("test_ltl_kunit", /* XXX: tracepoint */, handle_example_event); + +return 0 ; +} + +static void disable_test_ltl_kunit (void ) +{ + rv_detach_trace_probe("test_ltl_kunit", /* XXX: tracepoint */, handle_example_event); + +ltl_monitor_destroy (); +} + +/* +* This is the monitor register section. +*/ +static struct rv_monitor rv_this = { + .name ="test_ltl_kunit" , + .description ="auto-generated" , + .enable = enable_test_ltl_kunit, + .disable = disable_test_ltl_kunit, +}; + +static int __init register_test_ltl_kunit (void ) +{ +return rv_register_monitor (&rv_this,NULL ); +} + +static void __exit unregister_test_ltl_kunit(void) +{ +rv_unregister_monitor (&rv_this); +} + +module_init (register_test_ltl_kunit); +module_exit (unregister_test_ltl_kunit); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("rvgen: auto-generated" ); +MODULE_DESCRIPTION ("test_ltl_kunit: auto-generated" );tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit.h new file +108
-0@@ -0,0 +1,108 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* C implementation of Buchi automaton, automatically generated by +* tools/verification/rvgen from the linear temporal logic specification. +* For further information, see kernel documentation: +* Documentation/trace/rv/linear_temporal_logic.rst +*/ + +#include <linux/rv.h> + +#define MONITOR_NAME test_ltl_kunit + +enum ltl_atom { +LTL_EVENT_A , +LTL_EVENT_B , +LTL_NUM_ATOM +}; +static_assert (LTL_NUM_ATOM <=RV_MAX_LTL_ATOM ); + +static const char *ltl_atom_str (enum ltl_atom atom) +{ +static const char *const names[] = { +"ev_a" , +"ev_b" , + }; + +return names[atom]; +} + +enum ltl_buchi_state { +S0 , +S1 , +S2 , +S3 , +S4 , +RV_NUM_BA_STATES +}; +static_assert (RV_NUM_BA_STATES <=RV_MAX_BA_STATES ); + +static void ltl_start (struct task_struct *task,struct ltl_monitor *mon) +{ +bool event_b =test_bit (LTL_EVENT_B , mon->atoms); +bool event_a =test_bit (LTL_EVENT_A , mon->atoms); +bool val1 = !event_a; + +if (val1) +__set_bit (S0 , mon->states); +if (true) +__set_bit (S1 , mon->states); +if (event_b) +__set_bit (S4 , mon->states); +} + +static void +ltl_possible_next_states (struct ltl_monitor *mon,unsigned int state,unsigned long *next) +{ +bool event_b =test_bit (LTL_EVENT_B , mon->atoms); +bool event_a =test_bit (LTL_EVENT_A , mon->atoms); +bool val1 = !event_a; + +switch (state) { +case S0 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S1 : +if (true) +__set_bit (S1 , next); +if (true && val1) +__set_bit (S2 , next); +if (event_b && val1) +__set_bit (S3 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S2 : +if (true) +__set_bit (S1 , next); +if (true && val1) +__set_bit (S2 , next); +if (event_b && val1) +__set_bit (S3 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S3 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; +case S4 : +if (val1) +__set_bit (S0 , next); +if (true) +__set_bit (S1 , next); +if (event_b) +__set_bit (S4 , next); +break ; + } +}tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.c new file +33
-0@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +/* +* XXX: include required headers, e.g., +* #include <linux/sched.h> +*/ +#include "test_ltl_kunit_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_TEST_LTL_KUNIT ) + +static void rv_test_test_ltl_kunit (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; +/* +* If you need to create task_structs with rv_kunit_alloc_mock_task() +* do it BEFORE preparing the test. +*/ + +prepare_test (test, &rv_test_ltl_kunit_ops.mon); + +/* +* XXX: write the test here +* e.g. +* RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) +* rv_test_ltl_kunit_ops.handle_event(args); +*/ +} + +#else +#define rv_test_test_ltl_kunit rv_test_stub +#endif tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_kunit.h new file +22
-0@@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __TEST_LTL_KUNIT_KUNIT_H +#define __TEST_LTL_KUNIT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_test_ltl_kunit_ops { +struct rv_kunit_mon mon; + void (*handle_example_event)(void *data, /* XXX: fill header */); +} rv_test_ltl_kunit_ops; +#endif + +#endif /* __TEST_LTL_KUNIT_KUNIT_H */ tools/verification/rvgen/tests/golden/test_ltl_kunit/test_ltl_kunit_trace.h new file +14
-0@@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +/* +* Snippet to be included in rv_trace.h +*/ + +#ifdef CONFIG_RV_MON_TEST_LTL_KUNIT +DEFINE_EVENT (event_ltl_monitor_id, event_test_ltl_kunit, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT (error_ltl_monitor_id, error_test_ltl_kunit, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_TEST_LTL_KUNIT */ tools/verification/rvgen/tests/rvgen_kunit.t new file +41
-0@@ -0,0 +1,41 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0 +source ../tests/engine.sh +test_begin + +set_timeout 30s + +# Help tests +check "verify kunit subcommand help" \ + "$RVGEN kunit -h" 0 "model_name" "spec" + +check_and_compare_folder "KUnit generation with local lookup and test_da_kunit" \ + "$RVGEN monitor -c da -s tests/specs/test_da.dot -t per_cpu -n test_da_kunit && $RVGEN kunit -a -l -n test_da_kunit" \ + "test_da_kunit" "Now complete the test and add it to rv_monitors_test.c" "RV_MON_OPS_INIT" + +check_and_compare_folder "KUnit generation with local lookup and test_ha_kunit" \ + "$RVGEN monitor -c ha -s tests/specs/test_ha.dot -t per_task -n test_ha_kunit && $RVGEN kunit -a -l -n test_ha_kunit" \ + "test_ha_kunit" "Successfully created KUnit" "Append the following to" + +check_and_compare_folder "KUnit generation with local lookup and test_ltl_kunit" \ + "$RVGEN monitor -c ltl -s tests/specs/test_ltl.ltl -t per_task -n test_ltl_kunit && $RVGEN kunit -l -n test_ltl_kunit" \ + "test_ltl_kunit" "RV_MON_OPS_INIT" + +check_and_compare_folder "KUnit generation with backup file" \ + "$RVGEN monitor -c ltl -s tests/specs/test_ltl.ltl -t per_task -n test_bak_kunit && echo DUMMY > test_bak_kunit/test_bak_kunit_kunit.c && $RVGEN kunit -l -n test_bak_kunit" \ + "test_bak_kunit" "KUnit file(s) already exist.*backing up existing files" + +# Error handling tests +check "missing required model_name" \ + "$RVGEN kunit" 2 "the following arguments are required: -n/--model_name" + +check "non-existent model_name with auto_patch" \ + "$RVGEN kunit -a -n nonexistent" 1 \ + "Could not find monitor C file" "Traceback (most recent call last)" + +check "monitor without handlers" \ + "mkdir -p nohandler ; echo DUMMY > nohandler/nohandler.c ; $RVGEN kunit -l -n nohandler" 1 \ + "No handlers found" "Traceback (most recent call last)" +rm -rf nohandler + +test_endSignature · 1 line
2.55.0
Gabriele Monaco
maintainerRe: [PATCH v5 10/17] verification/rvgen: Add selftests for rvgen kunit
Quoted 8 lines · Kuan-Wei Chiu
I noticed a issue regarding the .bak file introduced in this patch.
When running make distclean on the kernel tree, this file gets automatically deleted. As a result, git tracks this as a deleted file and leaves a dirty working tree, which is a bit annoying during development. Would it be possible to use a different extension for this golden file, such as .backup or something, to prevent it from being swept up by the generic clean rules?
Hi Kuan-Wei,
thanks for reporting, that looks quite annoying indeed, let me send a fix.
Gabriele
Gabriele Monaco
maintainerPATCH v5 11/17 Export task monitor slot and react symbols
In reply to Gabriele MonacoExport rv_get_task_monitor_slot, rv_put_task_monitor_slot, and rv_react to GPL modules so they can be accessed by KUnit and future monitors built as kernel modules.
--- kernel/trace/rv/rv.c | 2 ++ kernel/trace/rv/rv_reactors.c | 1 + 2 files changed, 3 insertions(+)
kernel/trace/rv/rv.c +2 -0
@@ -189,6 +189,7 @@ int rv_get_task_monitor_slot(void)return -EINVAL ; } +EXPORT_SYMBOL_GPL (rv_get_task_monitor_slot);void rv_put_task_monitor_slot (int slot) {
@@ -205,6 +206,7 @@ void rv_put_task_monitor_slot(int slot) task_monitor_count--; task_monitor_slots[slot] = false; } +EXPORT_SYMBOL_GPL (rv_put_task_monitor_slot);/* * Monitors with a parent are nested,
kernel/trace/rv/rv_reactors.c +1 -0
@@ -479,3 +479,4 @@ void rv_react(struct rv_monitor *monitor, const char *msg, ...)va_end (args); } +EXPORT_SYMBOL_GPL (rv_react);
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 12/17 Add KUnit tests for some DA/HA monitors
In reply to Gabriele MonacoValidate the functionality of DA monitors by injecting events in a controlled environment (KUnit) and expecting reactions.
Events handlers are exported directly from the monitor source files without using system events and with dummy arguments (e.g. no real tasks). If the provided sequence of events incurs a violation, the test expects the stub version of rv_react() to be called.
This testing method can validate the entire monitor implementation since it sits between the monitor and the system (in place of the tracepoints). All sorts of system and timing events can be emulated without affecting the running kernel.
Handlers and monitor functions are exported as part of a struct to simplify the process of running KUnit tests from kernel modules.
---
Notes:
V4:
* Use deadline_thresh in nomiss KUnit test
* Special init/destroy for per-task monitors to avoid touching real tasks and starting tracepoints
* Add dummy test to check reactions work as expected
* Use actual reactor instead of stub to support timer reactions
include/rv/da_monitor.h | 22 +++ include/rv/ha_monitor.h | 21 +++ include/rv/kunit.h | 61 ++++++ kernel/trace/rv/Kconfig | 11 ++ kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/nomiss/nomiss.c | 18 ++ .../trace/rv/monitors/nomiss/nomiss_kunit.c | 38 ++++ .../trace/rv/monitors/nomiss/nomiss_kunit.h | 35 ++++ kernel/trace/rv/monitors/opid/opid.c | 12 ++ kernel/trace/rv/monitors/opid/opid_kunit.c | 33 ++++ kernel/trace/rv/monitors/opid/opid_kunit.h | 23 +++ kernel/trace/rv/monitors/sco/sco.c | 13 ++ kernel/trace/rv/monitors/sco/sco_kunit.c | 29 +++ kernel/trace/rv/monitors/sco/sco_kunit.h | 24 +++ kernel/trace/rv/monitors/sssw/sssw.c | 14 ++ kernel/trace/rv/monitors/sssw/sssw_kunit.c | 33 ++++ kernel/trace/rv/monitors/sssw/sssw_kunit.h | 30 +++ kernel/trace/rv/monitors/sts/sts.c | 19 ++ kernel/trace/rv/monitors/sts/sts_kunit.c | 39 ++++ kernel/trace/rv/monitors/sts/sts_kunit.h | 33 ++++ kernel/trace/rv/rv.c | 40 ++++ kernel/trace/rv/rv_monitors_test.c | 174 ++++++++++++++++++ 22 files changed, 723 insertions(+) create mode 100644 include/rv/kunit.h create mode 100644 kernel/trace/rv/monitors/nomiss/nomiss_kunit.c create mode 100644 kernel/trace/rv/monitors/nomiss/nomiss_kunit.h create mode 100644 kernel/trace/rv/monitors/opid/opid_kunit.c create mode 100644 kernel/trace/rv/monitors/opid/opid_kunit.h create mode 100644 kernel/trace/rv/monitors/sco/sco_kunit.c create mode 100644 kernel/trace/rv/monitors/sco/sco_kunit.h create mode 100644 kernel/trace/rv/monitors/sssw/sssw_kunit.c create mode 100644 kernel/trace/rv/monitors/sssw/sssw_kunit.h create mode 100644 kernel/trace/rv/monitors/sts/sts_kunit.c create mode 100644 kernel/trace/rv/monitors/sts/sts_kunit.h create mode 100644 kernel/trace/rv/rv_monitors_test.c
include/rv/da_monitor.h +22 -0
@@ -311,6 +311,11 @@ static inline struct da_monitor *da_get_monitor(struct task_struct *tsk)return &tsk->rv[task_mon_slot].da_mon; } +static inline void da_reset (struct task_struct *tsk) +{ +da_monitor_reset (da_get_monitor (tsk)); +} +/* * da_get_target - return the task associated to the monitor */
@@ -908,4 +913,21 @@ static inline void da_reset(da_id_type id, monitor_target target) }#endif /* RV_MON_TYPE */ +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#if RV_MON_TYPE ==RV_MON_PER_TASK +#define RV_MON_OPS_INIT () { \ + .rv_this = &rv_this, \ + .is_per_task = true, \ + .task_slot = &task_mon_slot, \ + .task_reset = da_reset, \ +} +#else +#define RV_MON_OPS_INIT () { \ + .rv_this = &rv_this, \ + .monitor_init = da_monitor_init, \ + .monitor_destroy = da_monitor_destroy, \ +} +#endif /* RV_MON_TYPE */ +#endif /* CONFIG_RV_MONITORS_KUNIT_TEST */ +#endif
include/rv/ha_monitor.h +21 -0
@@ -558,4 +558,25 @@ static inline bool ha_cancel_timer(struct ha_monitor *ha_mon)static inline void ha_cancel_timer_sync (struct ha_monitor *ha_mon) { }#endif +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#ifdef RV_MON_OPS_INIT +#undef RV_MON_OPS_INIT +#endif + +#if RV_MON_TYPE ==RV_MON_PER_TASK +#define RV_MON_OPS_INIT () { \ + .rv_this = &rv_this, \ + .is_per_task = true, \ + .task_slot = &task_mon_slot, \ + .task_reset = da_reset, \ +} +#else +#define RV_MON_OPS_INIT () { \ + .rv_this = &rv_this, \ + .monitor_init = ha_monitor_init, \ + .monitor_destroy = ha_monitor_destroy, \ +} +#endif /* RV_MON_TYPE */ +#endif /* CONFIG_RV_MONITORS_KUNIT_TEST */ +#endif
include/rv/kunit.h new file +61 -0
61 lines not on this page · raw message
kernel/trace/rv/Kconfig +11 -0
@@ -111,3 +111,14 @@ config RV_REACT_PANIC help Enables the panic reactor. The panic reactor emits a printk() message if an exception is found and panic()s the system. + +config RV_MONITORS_KUNIT_TEST + tristate "KUnit tests for RV monitors" if !KUNIT_ALL_TESTS + depends on KUNIT && RV && RV_REACTORS + default KUNIT_ALL_TESTS + help + Enable KUnit tests for the RV (Runtime Verification) monitors. + These tests verify that monitors correctly detect violations by + triggering fake events and validating the expected reactions. + + If unsure, say N.
kernel/trace/rv/Makefile +1 -0
@@ -24,3 +24,4 @@ obj-$(CONFIG_RV_MON_NOMISS) += monitors/nomiss/nomiss.o obj-$(CONFIG_RV_REACTORS) += rv_reactors.o obj-$(CONFIG_RV_REACT_PRINTK) += reactor_printk.o obj-$(CONFIG_RV_REACT_PANIC) += reactor_panic.o +obj-$(CONFIG_RV_MONITORS_KUNIT_TEST) += rv_monitors_test.o
kernel/trace/rv/monitors/nomiss/nomiss.c +18 -0
@@ -291,3 +291,21 @@ module_exit(unregister_nomiss);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Gabriele Monaco <[email protected]>" );MODULE_DESCRIPTION ("nomiss: dl entities run to completion before their deadline." ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "nomiss_kunit.h" + +const struct rv_nomiss_ops rv_nomiss_ops = { + .mon =RV_MON_OPS_INIT (), + .deadline_thresh = &deadline_thresh, + .handle_dl_replenish = handle_dl_replenish, + .handle_dl_throttle = handle_dl_throttle, + .handle_dl_server_stop = handle_dl_server_stop, + .handle_sched_switch = handle_sched_switch, + .handle_sched_wakeup = handle_sched_wakeup, + .handle_sys_enter = handle_sys_enter, + .handle_newtask = handle_newtask, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_nomiss_ops); +#endif
kernel/trace/rv/monitors/nomiss/nomiss_kunit.c new file +38 -0
@@ -0,0 +1,38 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <trace/events/sched.h> +#include "nomiss_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_NOMISS ) + +static void rv_test_nomiss (struct kunit *test) +{ +struct task_struct *target =rv_kunit_alloc_mock_task (test); +struct task_struct *other =rv_kunit_alloc_mock_task (test); +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_nomiss_ops.mon); + + target->pid =99 ; + target->policy =SCHED_DEADLINE ; + target->dl.runtime =10000 ; + target->dl.dl_deadline =20000 ; + + rv_nomiss_ops.handle_newtask (NULL , target,0 ); + +/* Task gets preempted and can't terminate before deadline */ + rv_nomiss_ops.handle_sched_switch (NULL ,0 , other, target,TASK_RUNNING ); + rv_nomiss_ops.handle_dl_replenish (NULL , &target->dl,0 ,DL_TASK ); +udelay (10 ); + rv_nomiss_ops.handle_sched_switch (NULL ,0 , target, other,TASK_RUNNING ); + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) { +udelay (15 + *rv_nomiss_ops.deadline_thresh /1000 ); + rv_nomiss_ops.handle_sched_switch (NULL ,0 , other, target,TASK_RUNNING ); + } +} + +#else +#define rv_test_nomiss rv_test_stub +#endif
kernel/trace/rv/monitors/nomiss/nomiss_kunit.h new file +35 -0
@@ -0,0 +1,35 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __NOMISS_KUNIT_H +#define __NOMISS_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_nomiss_ops { +struct rv_kunit_mon mon; +const u64 *deadline_thresh; +void (*handle_dl_replenish)(void *data,struct sched_dl_entity *dl_se, +int cpu,u8 type); +void (*handle_dl_throttle)(void *data,struct sched_dl_entity *dl_se, +int cpu,u8 type); +void (*handle_dl_server_stop)(void *data,struct sched_dl_entity *dl_se, +int cpu,u8 type); +void (*handle_sched_switch)(void *data,bool preempt, +struct task_struct *prev, +struct task_struct *next, +unsigned int prev_state); +void (*handle_sched_wakeup)(void *data,struct task_struct *tsk); +void (*handle_sys_enter)(void *data,struct pt_regs *regs,long id); +void (*handle_newtask)(void *data,struct task_struct *task,u64 flags); +} rv_nomiss_ops; +#endif + +#endif /* __NOMISS_KUNIT_H */
kernel/trace/rv/monitors/opid/opid.c +12 -0
@@ -115,3 +115,15 @@ module_exit(unregister_opid);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Gabriele Monaco <[email protected]>" );MODULE_DESCRIPTION ("opid: operations with preemption and irq disabled." ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "opid_kunit.h" + +const struct rv_opid_ops rv_opid_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_sched_need_resched = handle_sched_need_resched, + .handle_sched_waking = handle_sched_waking, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_opid_ops); +#endif
kernel/trace/rv/monitors/opid/opid_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <trace/events/sched.h> +#include "opid_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_OPID ) + +static void rv_test_opid (struct kunit *test) +{ +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_opid_ops.mon); + +/* Ensure we keep the same per-cpu monitor */ +guard (migrate)(); +KUNIT_EXPECT_TRUE (test,preemptible ()); + +/* Wakeup with preemption and interrupts enabled */ + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) + rv_opid_ops.handle_sched_waking (NULL ,NULL ); + +/* Need resched with interrupts enabled */ + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) { + scoped_guard(preempt) + rv_opid_ops.handle_sched_need_resched(NULL, NULL, 0, TIF_NEED_RESCHED); + } +} + +#else +#define rv_test_opid rv_test_stub +#endif
kernel/trace/rv/monitors/opid/opid_kunit.h new file +23 -0
@@ -0,0 +1,23 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __OPID_KUNIT_H +#define __OPID_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_opid_ops { +struct rv_kunit_mon mon; +void (*handle_sched_need_resched)(void *data,struct task_struct *tsk,int cpu,int tif); +void (*handle_sched_waking)(void *data,struct task_struct *p); +} rv_opid_ops; +#endif + +#endif /* __OPID_KUNIT_H */
kernel/trace/rv/monitors/sco/sco.c +13 -0
@@ -83,3 +83,16 @@ module_exit(unregister_sco);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Gabriele Monaco <[email protected]>" );MODULE_DESCRIPTION ("sco: scheduling context operations." ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "sco_kunit.h" + +const struct rv_sco_ops rv_sco_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_sched_set_state = handle_sched_set_state, + .handle_schedule_entry = handle_schedule_entry, + .handle_schedule_exit = handle_schedule_exit, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_sco_ops); +#endif
kernel/trace/rv/monitors/sco/sco_kunit.c new file +29 -0
@@ -0,0 +1,29 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <trace/events/sched.h> +#include "sco_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_SCO ) + +static void rv_test_sco (struct kunit *test) +{ +struct task_struct *target =rv_kunit_alloc_mock_task (test); +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_sco_ops.mon); + +/* Ensure we keep the same per-cpu monitor */ +guard (migrate)(); + +/* Set state while scheduling */ + rv_sco_ops.handle_sched_set_state (NULL , target,TASK_INTERRUPTIBLE ); + rv_sco_ops.handle_schedule_entry (NULL , false); +RV_KUNIT_EXPECT_REACTION_HERE (test, ctx) + rv_sco_ops.handle_sched_set_state(NULL, target, TASK_INTERRUPTIBLE); +} + +#else +#define rv_test_sco rv_test_stub +#endif
kernel/trace/rv/monitors/sco/sco_kunit.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __SCO_KUNIT_H +#define __SCO_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_sco_ops { +struct rv_kunit_mon mon; +void (*handle_sched_set_state)(void *data,struct task_struct *tsk,int state); +void (*handle_schedule_entry)(void *data,bool preempt); +void (*handle_schedule_exit)(void *data,bool is_switch); +} rv_sco_ops; +#endif + +#endif /* __SCO_KUNIT_H */
kernel/trace/rv/monitors/sssw/sssw.c +14 -0
@@ -112,3 +112,17 @@ module_exit(unregister_sssw);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Gabriele Monaco <[email protected]>" );MODULE_DESCRIPTION ("sssw: set state sleep and wakeup." ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "sssw_kunit.h" + +const struct rv_sssw_ops rv_sssw_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_sched_set_state = handle_sched_set_state, + .handle_sched_switch = handle_sched_switch, + .handle_sched_wakeup = handle_sched_wakeup, + .handle_signal_deliver = handle_signal_deliver, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_sssw_ops); +#endif
kernel/trace/rv/monitors/sssw/sssw_kunit.c new file +33 -0
@@ -0,0 +1,33 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <trace/events/sched.h> +#include "sssw_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_SSSW ) + +static void rv_test_sssw (struct kunit *test) +{ +struct task_struct *target =rv_kunit_alloc_mock_task (test); +struct task_struct *other =rv_kunit_alloc_mock_task (test); +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_sssw_ops.mon); + +/* Suspend without setting to sleepable */ + rv_sssw_ops.handle_sched_set_state (NULL , target,TASK_RUNNING ); + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) + rv_sssw_ops.handle_sched_switch (NULL ,0 , target, other,TASK_INTERRUPTIBLE ); + +/* Switch in after suspension without wakeup */ + rv_sssw_ops.handle_sched_wakeup (NULL , target); + rv_sssw_ops.handle_sched_set_state (NULL , target,TASK_INTERRUPTIBLE ); + rv_sssw_ops.handle_sched_switch (NULL ,0 , target, other,TASK_INTERRUPTIBLE ); + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) + rv_sssw_ops.handle_sched_switch (NULL ,0 , other, target,TASK_RUNNING ); +} + +#else +#define rv_test_sssw rv_test_stub +#endif
kernel/trace/rv/monitors/sssw/sssw_kunit.h new file +30 -0
@@ -0,0 +1,30 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __SSSW_KUNIT_H +#define __SSSW_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_sssw_ops { +struct rv_kunit_mon mon; +void (*handle_sched_set_state)(void *data,struct task_struct *tsk,int state); +void (*handle_sched_switch)(void *data,bool preempt, +struct task_struct *prev, +struct task_struct *next, +unsigned int prev_state); +void (*handle_sched_wakeup)(void *data,struct task_struct *p); +void (*handle_signal_deliver)(void *data,int sig, +struct kernel_siginfo *info, +struct k_sigaction *ka); +} rv_sssw_ops; +#endif + +#endif /* __SSSW_KUNIT_H */
kernel/trace/rv/monitors/sts/sts.c +19 -0
@@ -152,3 +152,22 @@ module_exit(unregister_sts);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Gabriele Monaco <[email protected]>" );MODULE_DESCRIPTION ("sts: schedule implies task switch." ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "sts_kunit.h" + +const struct rv_sts_ops rv_sts_ops = { + .mon =RV_MON_OPS_INIT (), +#ifdef CONFIG_X86_LOCAL_APIC + .handle_vector_irq_entry = handle_vector_irq_entry, +#endif + .handle_irq_disable = handle_irq_disable, + .handle_irq_enable = handle_irq_enable, + .handle_irq_entry = handle_irq_entry, + .handle_sched_switch = handle_sched_switch, + .handle_schedule_entry = handle_schedule_entry, + .handle_schedule_exit = handle_schedule_exit, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_sts_ops); +#endif
kernel/trace/rv/monitors/sts/sts_kunit.c new file +39 -0
@@ -0,0 +1,39 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <trace/events/sched.h> +#include "sts_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_STS ) + +static void rv_test_sts (struct kunit *test) +{ +struct task_struct *target =rv_kunit_alloc_mock_task (test); +struct task_struct *other =rv_kunit_alloc_mock_task (test); +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_sts_ops.mon); +/* Per-CPU monitor, make sure we don't change CPU mid-test */ +guard (migrate)(); + +/* Switch without disabling interrupts */ + rv_sts_ops.handle_schedule_exit (NULL , false); + rv_sts_ops.handle_schedule_entry (NULL , false); +RV_KUNIT_EXPECT_REACTION_HERE (test, ctx) + rv_sts_ops.handle_sched_switch(NULL, 0, target, other, TASK_RUNNING); + + rv_sts_ops.handle_schedule_exit (NULL , false); + +/* Schedule from interrupt context */ + rv_sts_ops.handle_schedule_entry (NULL , false); + rv_sts_ops.handle_irq_disable (NULL ,0 ,0 ); + rv_sts_ops.handle_irq_entry (NULL ,0 ,NULL ); +RV_KUNIT_EXPECT_REACTION_HERE (test, ctx) + rv_sts_ops.handle_sched_switch(NULL, 0, target, other, TASK_RUNNING); + rv_sts_ops.handle_irq_enable (NULL ,0 ,0 ); +} + +#else +#define rv_test_sts rv_test_stub +#endif
kernel/trace/rv/monitors/sts/sts_kunit.h new file +33 -0
@@ -0,0 +1,33 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __STS_KUNIT_H +#define __STS_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_sts_ops { +struct rv_kunit_mon mon; +#ifdef CONFIG_X86_LOCAL_APIC +void (*handle_vector_irq_entry)(void *data,int vector); +#endif +void (*handle_irq_disable)(void *data,unsigned long ip,unsigned long parent_ip); +void (*handle_irq_enable)(void *data,unsigned long ip,unsigned long parent_ip); +void (*handle_irq_entry)(void *data,int irq,struct irqaction *action); +void (*handle_sched_switch)(void *data,bool preempt, +struct task_struct *prev, +struct task_struct *next, +unsigned int prev_state); +void (*handle_schedule_entry)(void *data,bool preempt); +void (*handle_schedule_exit)(void *data,bool is_switch); +} rv_sts_ops; +#endif + +#endif /* __STS_KUNIT_H */
kernel/trace/rv/rv.c +40 -0
@@ -854,3 +854,43 @@ int __init rv_init_interface(void)return 0 ; } + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <rv/kunit.h> +#include <kunit/visibility.h> + +/* +* rv_set_testing - ensure mutual exclusion between KUnit tests and real monitors +* +* KUnit tests for RV monitors rely on stubs that are incompatible with +* the execution of real monitors. Ensure mutual exclusion by acquiring +* the rv_interface_lock for the duration of the suite. +* +* Returns 0 on success, -EBUSY if any real monitor is already enabled. +*/ +int rv_set_testing (struct kunit_suite *suite) +{ +struct rv_monitor *mon; + +mutex_lock (&rv_interface_lock); + +list_for_each_entry (mon, &rv_monitors_list, list) { +if (mon->enabled) { +mutex_unlock (&rv_interface_lock); +return -EBUSY ; + } + } + +return 0 ; +} +EXPORT_SYMBOL_IF_KUNIT (rv_set_testing); + +/* +* rv_clear_testing - allow real monitors to run again after KUnit tests +*/ +void rv_clear_testing (struct kunit_suite *suite) +{ +mutex_unlock (&rv_interface_lock); +} +EXPORT_SYMBOL_IF_KUNIT (rv_clear_testing); +#endif
kernel/trace/rv/rv_monitors_test.c new file +174 -0
174 lines not on this page · raw message
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 13/17 Add KUnit mock for current
In reply to Gabriele MonacoSome monitors do not only rely on tracepoint arguments but also on the currently executing task.
This makes it more challenging to mock events in KUnit.
Define wrapper functions around current, the functionality is mocked only during KUnit, an additional function call is avoided using a static branch unless any (even unrelated) KUnit test is running.
Rely on a global mock_current variable that is set only by the RV KUnit tests and cleared on teardown. Unrelated KUnit tests that happen to trigger RV handlers would see it null and use current.
---
Notes:
V5:
* Drop static stub from current to avoid issues with unrelated KUnit tests
include/rv/da_monitor.h | 1 + include/rv/kunit.h | 14 +++++++++- include/rv/ltl_monitor.h | 1 + kernel/trace/rv/Kconfig | 3 +++ .../trace/rv/monitors/pagefault/pagefault.c | 2 +- kernel/trace/rv/monitors/sleep/sleep.c | 24 ++++++++--------- kernel/trace/rv/rv.c | 26 +++++++++++++++++++ kernel/trace/rv/rv_monitors_test.c | 1 + 8 files changed, 58 insertions(+), 14 deletions(-)
include/rv/da_monitor.h +1 -0
@@ -16,6 +16,7 @@#include <rv/automata.h> #include <linux/rv.h> +#include <rv/kunit.h> #include <linux/stringify.h> #include <linux/bug.h> #include <linux/sched.h>
include/rv/kunit.h +13 -1
@@ -2,7 +2,10 @@/* * Copyright (C) 2026-2029 Red Hat, Inc. Gabriele Monaco <[email protected]> * -* Declaration of utilities to run KUnit tests. +* Declaration of wrappers to allow mocking core functionality, like current, +* and other testing utilities. +* Necessary only when mocking may be needed. If the RV KUnit test is +* enabled, the wrappers incur an additional function call overhead. */ #ifndef _RV_KUNIT_H
@@ -57,5 +60,14 @@ void prepare_test(struct kunit *test, const struct rv_kunit_mon *mon);void teardown_test (void *arg);struct task_struct *rv_kunit_alloc_mock_task (struct kunit *test); +void rv_mock_current (struct task_struct *tsk); +struct task_struct *rv_get_mock_current (void ); + +#define rv_get_current () (unlikely(kunit_get_current_test()) ? rv_get_mock_current() : current) + +#else /* !CONFIG_RV_MONITORS_KUNIT_TEST */ + +#define rv_get_current () current +#endif /* CONFIG_RV_MONITORS_KUNIT_TEST */ #endif /* _RV_KUNIT_H */
include/rv/ltl_monitor.h +1 -0
@@ -9,6 +9,7 @@#include <linux/stringify.h> #include <linux/seq_buf.h> #include <rv/instrumentation.h> +#include <rv/kunit.h> #include <trace/events/task.h> #include <trace/events/sched.h>
kernel/trace/rv/Kconfig +3 -0
@@ -121,4 +121,7 @@ config RV_MONITORS_KUNIT_TEST These tests verify that monitors correctly detect violations by triggering fake events and validating the expected reactions. + Enabling this may slightly increase overhead of some monitors if any + unrelated KUnit test is running. + If unsure, say N.
kernel/trace/rv/monitors/pagefault/pagefault.c +1 -1
@@ -38,7 +38,7 @@ static void ltl_atoms_init(struct task_struct *task, struct ltl_monitor *mon, bostatic void handle_page_fault (void *data,unsigned long address,struct pt_regs *regs,unsigned long error_code) { -ltl_atom_pulse (current,LTL_PAGEFAULT , true); +ltl_atom_pulse (rv_get_current (),LTL_PAGEFAULT , true); }static int enable_pagefault (void )
kernel/trace/rv/monitors/sleep/sleep.c +12 -12
@@ -102,7 +102,7 @@ static void handle_sched_waking(void *data, struct task_struct *task)if (this_cpu_read (hardirq_context)) {ltl_atom_pulse (task,LTL_WOKEN_BY_HARDIRQ , true); }else if (in_task ()) { -if (current->prio <= task->prio) +if (rv_get_current ()->prio <= task->prio)ltl_atom_pulse (task,LTL_WOKEN_BY_EQUAL_OR_HIGHER_PRIO , true); }else if (in_nmi ()) {ltl_atom_pulse (task,LTL_WOKEN_BY_NMI , true);
@@ -112,12 +112,12 @@ static void handle_sched_waking(void *data, struct task_struct *task)static void handle_contention_begin (void *data,void *lock,unsigned int flags) {if (flags &LCB_F_RT ) -ltl_atom_update (current,LTL_BLOCK_ON_RT_MUTEX , true); +ltl_atom_update (rv_get_current (),LTL_BLOCK_ON_RT_MUTEX , true); }static void handle_contention_end (void *data,void *lock,int ret) { -ltl_atom_update (current,LTL_BLOCK_ON_RT_MUTEX , false); +ltl_atom_update (rv_get_current (),LTL_BLOCK_ON_RT_MUTEX , false); }static void handle_sys_enter (void *data,struct pt_regs *regs,long id)
@@ -126,7 +126,7 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)unsigned long args[6 ];int op, cmd; - mon =ltl_get_monitor (current); + mon =ltl_get_monitor (rv_get_current ());switch (id) {#ifdef __NR_clock_nanosleep
@@ -135,11 +135,11 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)#ifdef __NR_clock_nanosleep_time64case __NR_clock_nanosleep_time64:#endif -syscall_get_arguments (current, regs, args); +syscall_get_arguments (rv_get_current (), regs, args);ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_MONOTONIC , args[0 ] ==CLOCK_MONOTONIC );ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_TAI , args[0 ] ==CLOCK_TAI );ltl_atom_set (mon,LTL_NANOSLEEP_TIMER_ABSTIME , args[1 ] ==TIMER_ABSTIME ); -ltl_atom_update (current,LTL_CLOCK_NANOSLEEP , true); +ltl_atom_update (rv_get_current (),LTL_CLOCK_NANOSLEEP , true);break ;#ifdef __NR_futex
@@ -148,25 +148,25 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)#ifdef __NR_futex_time64case __NR_futex_time64:#endif -syscall_get_arguments (current, regs, args); +syscall_get_arguments (rv_get_current (), regs, args); op = args[1 ]; cmd = op &FUTEX_CMD_MASK ;switch (cmd) {case FUTEX_LOCK_PI :case FUTEX_LOCK_PI2 : -ltl_atom_update (current,LTL_FUTEX_LOCK_PI , true); +ltl_atom_update (rv_get_current (),LTL_FUTEX_LOCK_PI , true);break ;case FUTEX_WAIT :case FUTEX_WAIT_BITSET :case FUTEX_WAIT_REQUEUE_PI : -ltl_atom_update (current,LTL_FUTEX_WAIT , true); +ltl_atom_update (rv_get_current (),LTL_FUTEX_WAIT , true);break ; }break ;#ifdef __NR_epoll_waitcase __NR_epoll_wait: -ltl_atom_update (current,LTL_EPOLL_WAIT , true); +ltl_atom_update (rv_get_current (),LTL_EPOLL_WAIT , true);break ;#endif }
@@ -174,7 +174,7 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)static void handle_sys_exit (void *data,struct pt_regs *regs,long ret) { -struct ltl_monitor *mon =ltl_get_monitor (current); +struct ltl_monitor *mon =ltl_get_monitor (rv_get_current ());ltl_atom_set (mon,LTL_FUTEX_LOCK_PI , false);ltl_atom_set (mon,LTL_FUTEX_WAIT , false);
@@ -182,7 +182,7 @@ static void handle_sys_exit(void *data, struct pt_regs *regs, long ret)ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_TAI , false);ltl_atom_set (mon,LTL_NANOSLEEP_TIMER_ABSTIME , false);ltl_atom_set (mon,LTL_EPOLL_WAIT , false); -ltl_atom_update (current,LTL_CLOCK_NANOSLEEP , false); +ltl_atom_update (rv_get_current (),LTL_CLOCK_NANOSLEEP , false); }static void handle_kthread_stop (void *data,struct task_struct *task)
kernel/trace/rv/rv.c +26 -0
@@ -893,4 +893,30 @@ void rv_clear_testing(struct kunit_suite *suite) mutex_unlock(&rv_interface_lock); }EXPORT_SYMBOL_IF_KUNIT (rv_clear_testing); + +/* +* rv_get_mock_current() is called only if we are running from a KUnit test. +* This can occur from a legitimate RV test or any unrelated test running when +* a real RV monitor is active and triggering events. +* We assume the former case is the only one where mock_current is not NULL and +* can occur only sequentially (KUnit doesn't run tests in parallel). +* We cannot rely on the test's context because there is no way to safely +* understand from which test we are running and KUnit utilities require +* locking, which is unsafe from NMI or scheduling context. +* Note that it is not possible for a real RV monitor to run when the RV KUnit +* tests are running (see rv_set_testing()). +*/ +static struct task_struct *mock_current; + +void rv_mock_current (struct task_struct *tsk) +{ + mock_current = tsk; +} +EXPORT_SYMBOL_IF_KUNIT (rv_mock_current); + +struct task_struct *rv_get_mock_current (void ) +{ +return mock_current ?: current; +} +EXPORT_SYMBOL_GPL (rv_get_mock_current);#endif
kernel/trace/rv/rv_monitors_test.c +1 -0
@@ -54,6 +54,7 @@ void teardown_test(void *arg) mon->rv_this->react =NULL ; active_ctx =NULL ; +rv_mock_current (NULL );if (mon->is_per_task) *mon->task_slot =RV_PER_TASK_MONITOR_INIT ;
Signature · 1 line
2.55.0
Re: [PATCH v5 13/17] rv: Add KUnit mock for current
Quoted 233 lines · Gabriele Monaco
Some monitors do not only rely on tracepoint arguments but also on the currently executing task.
This makes it more challenging to mock events in KUnit.Define wrapper functions around current, the functionality is mocked only during KUnit, an additional function call is avoided using a static branch unless any (even unrelated) KUnit test is running.
Rely on a global
mock_currentvariable that is set only by the RV KUnit tests and cleared on teardown. Unrelated KUnit tests that happen to trigger RV handlers would see it null and use current.Signed-off-by Gabriele Monaco <[email protected]>---
Notes:
V5:
* Drop static stub from current to avoid issues with unrelated KUnit testsinclude/rv/da_monitor.h | 1 + include/rv/kunit.h | 14 +++++++++- include/rv/ltl_monitor.h | 1 + kernel/trace/rv/Kconfig | 3 +++ .../trace/rv/monitors/pagefault/pagefault.c | 2 +- kernel/trace/rv/monitors/sleep/sleep.c | 24 ++++++++--------- kernel/trace/rv/rv.c | 26 +++++++++++++++++++ kernel/trace/rv/rv_monitors_test.c | 1 + 8 files changed, 58 insertions(+), 14 deletions(-)include/rv/da_monitor.h +1
-0@@ -16,6 +16,7 @@#include <rv/automata.h> #include <linux/rv.h> +#include <rv/kunit.h> #include <linux/stringify.h> #include <linux/bug.h> #include <linux/sched.h> include/rv/kunit.h +13
-1@@ -2,7 +2,10 @@/* * Copyright (C) 2026-2029 Red Hat, Inc. Gabriele Monaco <[email protected]> * -* Declaration of utilities to run KUnit tests. +* Declaration of wrappers to allow mocking core functionality, like current, +* and other testing utilities. +* Necessary only when mocking may be needed. If the RV KUnit test is +* enabled, the wrappers incur an additional function call overhead. */ #ifndef _RV_KUNIT_H@@ -57,5 +60,14 @@ void prepare_test(struct kunit *test, const struct rv_kunit_mon *mon);void teardown_test (void *arg);struct task_struct *rv_kunit_alloc_mock_task (struct kunit *test); +void rv_mock_current (struct task_struct *tsk); +struct task_struct *rv_get_mock_current (void ); + +#define rv_get_current () (unlikely(kunit_get_current_test()) ? rv_get_mock_current() : current) + +#else /* !CONFIG_RV_MONITORS_KUNIT_TEST */ + +#define rv_get_current () current +#endif /* CONFIG_RV_MONITORS_KUNIT_TEST */ #endif /* _RV_KUNIT_H */ include/rv/ltl_monitor.h +1
-0@@ -9,6 +9,7 @@#include <linux/stringify.h> #include <linux/seq_buf.h> #include <rv/instrumentation.h> +#include <rv/kunit.h> #include <trace/events/task.h> #include <trace/events/sched.h> kernel/trace/rv/Kconfig +3
-0@@ -121,4 +121,7 @@ config RV_MONITORS_KUNIT_TEST These tests verify that monitors correctly detect violations by triggering fake events and validating the expected reactions. + Enabling this may slightly increase overhead of some monitors if any + unrelated KUnit test is running. + If unsure, say N.kernel/trace/rv/monitors/pagefault/pagefault.c +1
-1@@ -38,7 +38,7 @@ static void ltl_atoms_init(struct task_struct *task, struct ltl_monitor *mon, bostatic void handle_page_fault (void *data,unsigned long address,struct pt_regs *regs,unsigned long error_code) { -ltl_atom_pulse (current,LTL_PAGEFAULT , true); +ltl_atom_pulse (rv_get_current (),LTL_PAGEFAULT , true); }static int enable_pagefault (void )kernel/trace/rv/monitors/sleep/sleep.c +12
-12@@ -102,7 +102,7 @@ static void handle_sched_waking(void *data, struct task_struct *task)if (this_cpu_read (hardirq_context)) {ltl_atom_pulse (task,LTL_WOKEN_BY_HARDIRQ , true); }else if (in_task ()) { -if (current->prio <= task->prio) +if (rv_get_current ()->prio <= task->prio)ltl_atom_pulse (task,LTL_WOKEN_BY_EQUAL_OR_HIGHER_PRIO , true); }else if (in_nmi ()) {ltl_atom_pulse (task,LTL_WOKEN_BY_NMI , true);@@ -112,12 +112,12 @@ static void handle_sched_waking(void *data, struct task_struct *task)static void handle_contention_begin (void *data,void *lock,unsigned int flags) {if (flags &LCB_F_RT ) -ltl_atom_update (current,LTL_BLOCK_ON_RT_MUTEX , true); +ltl_atom_update (rv_get_current (),LTL_BLOCK_ON_RT_MUTEX , true); }static void handle_contention_end (void *data,void *lock,int ret) { -ltl_atom_update (current,LTL_BLOCK_ON_RT_MUTEX , false); +ltl_atom_update (rv_get_current (),LTL_BLOCK_ON_RT_MUTEX , false); }static void handle_sys_enter (void *data,struct pt_regs *regs,long id)@@ -126,7 +126,7 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)unsigned long args[6 ];int op, cmd; - mon =ltl_get_monitor (current); + mon =ltl_get_monitor (rv_get_current ());switch (id) {#ifdef __NR_clock_nanosleep@@ -135,11 +135,11 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)#ifdef __NR_clock_nanosleep_time64case __NR_clock_nanosleep_time64:#endif -syscall_get_arguments (current, regs, args); +syscall_get_arguments (rv_get_current (), regs, args);ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_MONOTONIC , args[0 ] ==CLOCK_MONOTONIC );ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_TAI , args[0 ] ==CLOCK_TAI );ltl_atom_set (mon,LTL_NANOSLEEP_TIMER_ABSTIME , args[1 ] ==TIMER_ABSTIME ); -ltl_atom_update (current,LTL_CLOCK_NANOSLEEP , true); +ltl_atom_update (rv_get_current (),LTL_CLOCK_NANOSLEEP , true);break ;#ifdef __NR_futex@@ -148,25 +148,25 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)#ifdef __NR_futex_time64case __NR_futex_time64:#endif -syscall_get_arguments (current, regs, args); +syscall_get_arguments (rv_get_current (), regs, args); op = args[1 ]; cmd = op &FUTEX_CMD_MASK ;switch (cmd) {case FUTEX_LOCK_PI :case FUTEX_LOCK_PI2 : -ltl_atom_update (current,LTL_FUTEX_LOCK_PI , true); +ltl_atom_update (rv_get_current (),LTL_FUTEX_LOCK_PI , true);break ;case FUTEX_WAIT :case FUTEX_WAIT_BITSET :case FUTEX_WAIT_REQUEUE_PI : -ltl_atom_update (current,LTL_FUTEX_WAIT , true); +ltl_atom_update (rv_get_current (),LTL_FUTEX_WAIT , true);break ; }break ;#ifdef __NR_epoll_waitcase __NR_epoll_wait: -ltl_atom_update (current,LTL_EPOLL_WAIT , true); +ltl_atom_update (rv_get_current (),LTL_EPOLL_WAIT , true);break ;#endif }@@ -174,7 +174,7 @@ static void handle_sys_enter(void *data, struct pt_regs *regs, long id)static void handle_sys_exit (void *data,struct pt_regs *regs,long ret) { -struct ltl_monitor *mon =ltl_get_monitor (current); +struct ltl_monitor *mon =ltl_get_monitor (rv_get_current ());ltl_atom_set (mon,LTL_FUTEX_LOCK_PI , false);ltl_atom_set (mon,LTL_FUTEX_WAIT , false);@@ -182,7 +182,7 @@ static void handle_sys_exit(void *data, struct pt_regs *regs, long ret)ltl_atom_set (mon,LTL_NANOSLEEP_CLOCK_TAI , false);ltl_atom_set (mon,LTL_NANOSLEEP_TIMER_ABSTIME , false);ltl_atom_set (mon,LTL_EPOLL_WAIT , false); -ltl_atom_update (current,LTL_CLOCK_NANOSLEEP , false); +ltl_atom_update (rv_get_current (),LTL_CLOCK_NANOSLEEP , false); }static void handle_kthread_stop (void *data,struct task_struct *task)kernel/trace/rv/rv.c +17
-0@@ -893,4 +893,30 @@ void rv_clear_testing(struct kunit_suite *suite)mutex_unlock (&rv_interface_lock); }EXPORT_SYMBOL_IF_KUNIT (rv_clear_testing); + +/* +* rv_get_mock_current() is called only if we are running from a KUnit test. +* This can occur from a legitimate RV test or any unrelated test running when +* a real RV monitor is active and triggering events. +* We assume the former case is the only one where mock_current is not NULL and +* can occur only sequentially (KUnit doesn't run tests in parallel). +* We cannot rely on the test's context because there is no way to safely +* understand from which test we are running and KUnit utilities require +* locking, which is unsafe from NMI or scheduling context. +* Note that it is not possible for a real RV monitor to run when the RV KUnit +* tests are running (see rv_set_testing()). +*/ +static struct task_struct *mock_current; + +void rv_mock_current (struct task_struct *tsk) +{
kernel/trace/rv/rv.c void rv_clear_testing(struct kunit_suite *suite) · line 922
Quoted 10 lines
kernel/trace/rv/rv.c +9
-0+ mock_current = tsk; +} +EXPORT_SYMBOL_IF_KUNIT (rv_mock_current); + +struct task_struct *rv_get_mock_current (void ) +{ +return mock_current ?: current; +} +EXPORT_SYMBOL_GPL (rv_get_mock_current);#endif
rv_mock_current() uses EXPORT_SYMBOL_IF_KUNIT, but rv_get_mock_current() uses EXPORT_SYMBOL_GPL. Both are defined inside the same CONFIG_RV_MONITORS_KUNIT_TEST block, so rv_get_mock_current should use EXPORT_SYMBOL_IF_KUNIT as well, otherwise it leaks a test-only symbol into production builds.
With that fixed:
--
Best wishes,
Wen
Gabriele Monaco
maintainerRe: [PATCH v5 13/17] rv: Add KUnit mock for current
Il 29 luglio 2026 18:17:31 UTC, Wen Yang <[email protected]> ha scritto:
Quoted 1 line
Quoted 1 line
+#define
rv_get_current()(unlikely(kunit_get_current_test()) ?rv_get_mock_current(): current)
...
Quoted 29 lines
Quoted 16 lines
kernel/trace/rv/rv.c +16
-0+/* +* rv_get_mock_current() is called only if we are running from a KUnit test. +* This can occur from a legitimate RV test or any unrelated test running when +* a real RV monitor is active and triggering events. +* We assume the former case is the only one where mock_current is not NULL and +* can occur only sequentially (KUnit doesn't run tests in parallel). +* We cannot rely on the test's context because there is no way to safely +* understand from which test we are running and KUnit utilities require +* locking, which is unsafe from NMI or scheduling context. +* Note that it is not possible for a real RV monitor to run when the RV KUnit +* tests are running (see rv_set_testing()). +*/ +static struct task_struct *mock_current; + +void rv_mock_current (struct task_struct *tsk) +{kernel/trace/rv/rv.c void rv_clear_testing(struct kunit_suite *suite) · line 922
Quoted 10 lines
kernel/trace/rv/rv.c +9
-0+ mock_current = tsk; +} +EXPORT_SYMBOL_IF_KUNIT (rv_mock_current); + +struct task_struct *rv_get_mock_current (void ) +{ +return mock_current ?: current; +} +EXPORT_SYMBOL_GPL (rv_get_mock_current);#endif
rv_mock_current()usesEXPORT_SYMBOL_IF_KUNIT, butrv_get_mock_current()usesEXPORT_SYMBOL_GPL. Both are defined inside the sameCONFIG_RV_MONITORS_KUNIT_TESTblock, sorv_get_mock_currentshould useEXPORT_SYMBOL_IF_KUNITas well, otherwise it leaks a test-only symbol into production builds.
Quoted 2 lines
With that fixed:
Reviewed-by Wen Yang <[email protected]>
Thanks for the review.
This was intentional however: rv_get_current() can be called by any monitor, those don't have to be KUnit. Since rv_get_current() is a macro also calling rv_get_mock_current() we need to be able to link that too.
The idea is that a "real" (non-kunit) monitor handler could be run when interrupting a KUnit test (not an RV one, we make sure of that). In that case we do call rv_get_mock_current() and return current after the function call.
rv_mock_current() CANNOT be called outside of the RV KUnit test cases, it uses a global variable (for problems I tried to explain in the comment), so should be exported only to KUnit and called directly from the test case.
Does it make sense to you?
Thanks,
Gabriele
Re: [PATCH v5 13/17] rv: Add KUnit mock for current
Quoted 44 lines · Gabriele Monaco
Il 29 luglio 2026 18:17:31 UTC, Wen Yang <[email protected]> ha scritto:
Quoted 1 line
Quoted 1 line
+#define
rv_get_current()(unlikely(kunit_get_current_test()) ?rv_get_mock_current(): current)...
Quoted 29 lines
Quoted 16 lines
(quoted diff) +16
-0+/* + * rv_get_mock_current() is called only if we are running from a KUnit test. + * This can occur from a legitimate RV test or any unrelated test running when + * a real RV monitor is active and triggering events. + * We assume the former case is the only one where mock_current is not NULL and + * can occur only sequentially (KUnit doesn't run tests in parallel). + * We cannot rely on the test's context because there is no way to safely + * understand from which test we are running and KUnit utilities require + * locking, which is unsafe from NMI or scheduling context. + * Note that it is not possible for a real RV monitor to run when the RV KUnit + * tests are running (see rv_set_testing()). + */ +static struct task_struct *mock_current; + +void rv_mock_current(struct task_struct *tsk) +{Review
Quoted 10 lines
(quoted diff) +9
-0+ mock_current = tsk; +} +EXPORT_SYMBOL_IF_KUNIT(rv_mock_current); + +struct task_struct *rv_get_mock_current(void) +{ + return mock_current ?: current; +} +EXPORT_SYMBOL_GPL(rv_get_mock_current); #endif
rv_mock_current()usesEXPORT_SYMBOL_IF_KUNIT, butrv_get_mock_current()usesEXPORT_SYMBOL_GPL. Both are defined inside the sameCONFIG_RV_MONITORS_KUNIT_TESTblock, sorv_get_mock_currentshould useEXPORT_SYMBOL_IF_KUNITas well, otherwise it leaks a test-only symbol into production builds.Quoted 2 lines
With that fixed:
Reviewed-by Wen Yang <[email protected]>Thanks for the review.
This was intentional however:rv_get_current()can be called by any monitor, those don't have to be KUnit. Sincerv_get_current()is a macro also callingrv_get_mock_current()we need to be able to link that too.
Quoted 6 lines
The idea is that a "real" (non-kunit) monitor handler could be run when interrupting a KUnit test (not an RV one, we make sure of that). In that case we do call
rv_get_mock_current()and return current after the function call.
rv_mock_current()CANNOT be called outside of the RV KUnit test cases, it uses a global variable (for problems I tried to explain in the comment), so should be exported only to KUnit and called directly from the test case.Does it make sense to you?
Thanks for the explanation.
That does make sense.
One small thought though -- the kernel already provides KUNIT_STATIC_STUB_REDIRECT as the idiomatic way to handle this kind of pattern. It allows a production function to be transparently redirected to a stub during KUnit tests, with zero overhead when no test is running (since it uses the same static_branch_unlikely(&kunit_running) path as kunit_get_current_test()).
This might be a cleaner fit here, since it avoids exporting rv_mock_current() beyond KUnit and keeps the redirection logic internal to the test harness.
Just wanted to throw that out there -- what do you think?
kernel/trace/rv/rv_monitors_test.c +0 -0
...
+struct task_struct *rv_current(void)
+{
+ KUNIT_STATIC_STUB_REDIRECT(rv_current);
+ return current;
+}
+EXPORT_SYMBOL_GPL(rv_current);
...
kernel/trace/rv/rv_monitors_test.c +0 -0
...
+static struct task_struct *mock_current_task;
+
+static struct task_struct *rv_mock_current_fn(void)
+{
+ return mock_current_task ?: current;
+}
+
+void rv_mock_current(struct kunit *test, struct task_struct *tsk) +{
+ mock_current_task = tsk;
+ if (tsk)
+ kunit_activate_static_stub(test, rv_current, rv_mock_current_fn);
+ else
+ kunit_deactivate_static_stub(test, rv_current);
+}
+EXPORT_SYMBOL_IF_KUNIT(rv_mock_current);
kernel/trace/rv/monitors/pagefault/pagefault_kunit.c +0 -0
@@ -nn,7 +nn,7 @@ static void rv_test_pagefault(struct kunit *test) rv_pagefault_ops.handle_task_newtask (NULL , target,0 ); -rv_mock_current (target); +rv_mock_current (test, target);
--
Best wishes,
Wen
Wen Yang
Reviewed-byRe: [PATCH v5 13/17] rv: Add KUnit mock for current
Quoted 60 lines · Wen Yang
Quoted 50 lines · Gabriele Monaco
Il 29 luglio 2026 18:17:31 UTC, Wen Yang <[email protected]> ha scritto:
Quoted 2 lines
Quoted 2 lines
+#define
rv_get_current()(unlikely(kunit_get_current_test()) ?rv_get_mock_current(): current)...
Quoted 35 lines
Quoted 31 lines
+/*
+ *rv_get_mock_current()is called only if we are running from a KUnit test.
+ * This can occur from a legitimate RV test or any unrelated test running when
+ * a real RV monitor is active and triggering events.
+ * We assume the former case is the only one wheremock_currentis not NULL and
+ * can occur only sequentially (KUnit doesn't run tests in parallel).
+ * We cannot rely on the test's context because there is no way to safely
+ * understand from which test we are running and KUnit utilities require
+ * locking, which is unsafe from NMI or scheduling context.
+ * Note that it is not possible for a real RV monitor to run when the RV KUnit
+ * tests are running (seerv_set_testing()).
+ */(quoted diff) +13
-0+static struct task_struct *mock_current; + +void rv_mock_current(struct task_struct *tsk) +{ + mock_current = tsk; +} +EXPORT_SYMBOL_IF_KUNIT(rv_mock_current); + +struct task_struct *rv_get_mock_current(void) +{ + return mock_current ?: current; +} +EXPORT_SYMBOL_GPL(rv_get_mock_current);Quoted 1 line
#endif
rv_mock_current()usesEXPORT_SYMBOL_IF_KUNIT, butrv_get_mock_current()usesEXPORT_SYMBOL_GPL. Both are defined inside the sameCONFIG_RV_MONITORS_KUNIT_TESTblock, sorv_get_mock_currentshould useEXPORT_SYMBOL_IF_KUNITas well, otherwise it leaks a test-only symbol into production builds.Quoted 2 lines
With that fixed:
Reviewed-by Wen Yang <[email protected]>Thanks for the review.
This was intentional however:rv_get_current()can be called by any monitor, those don't have to be KUnit. Sincerv_get_current()is a macro also callingrv_get_mock_current()we need to be able to link that too.Quoted 6 lines
The idea is that a "real" (non-kunit) monitor handler could be run when interrupting a KUnit test (not an RV one, we make sure of that). In that case we do call
rv_get_mock_current()and return current after the function call.
rv_mock_current()CANNOT be called outside of the RV KUnit test cases, it uses a global variable (for problems I tried to explain in the comment), so should be exported only to KUnit and called directly from the test case.Does it make sense to you?
Quoted 9 lines
Thanks for the explanation.
That does make sense.One small thought though -- the kernel already provides
KUNIT_STATIC_STUB_REDIRECTas the idiomatic way to handle this kind of pattern. It allows a production function to be transparently redirected to a stub during KUnit tests, with zero overhead when no test is running (since it uses the samestatic_branch_unlikely(&kunit_running)path askunit_get_current_test()).This might be a cleaner fit here, since it avoids exporting
rv_mock_current()beyond KUnit and keeps the redirection logic internal to the test harness.Just wanted to throw that out there -- what do you think?
I apologize for the noise. After reading the V5 commit notes more carefully:
* Drop static stub from current to avoid issues with unrelated KUnit
tests
it is clear that KUNIT_STATIC_STUB_REDIRECT was already considered and deliberately dropped. Kunit_find_resource() may acquires spin_lock_irqsave, which does not mask NMIs; using the static stub in an NMI-reachable path would risk deadlock.
This patch is the correct choice, and the comment in rv.c explains exactly why.
--
Best wishes,
Wen
Quoted 10 lines
Signature · 3 lines
-- Best wishes, Wen
Re: [PATCH v5 13/17] rv: Add KUnit mock for current
In reply to Gabriele MonacoQuoted 8 lines · Gabriele Monaco
Some monitors do not only rely on tracepoint arguments but also on the currently executing task.
This makes it more challenging to mock events in KUnit.Define wrapper functions around current, the functionality is mocked only during KUnit, an additional function call is avoided using a static branch unless any (even unrelated) KUnit test is running.
Quoted 5 lines
Rely on a global
mock_currentvariable that is set only by the RV KUnit tests and cleared on teardown. Unrelated KUnit tests that happen to trigger RV handlers would see it null and use current.Signed-off-by Gabriele Monaco <[email protected]>
Gabriele Monaco
maintainerPATCH v5 14/17 Add KUnit tests for some LTL monitors
In reply to Gabriele MonacoValidate the functionality of LTL monitors by injecting events in a controlled environment (KUnit) and expecting reactions, just like it is done in DA monitors.
--- include/rv/ltl_monitor.h | 8 +++ .../trace/rv/monitors/pagefault/pagefault.c | 12 ++++ .../rv/monitors/pagefault/pagefault_kunit.c | 34 +++++++++++ .../rv/monitors/pagefault/pagefault_kunit.h | 24 ++++++++ kernel/trace/rv/monitors/sleep/sleep.c | 19 ++++++ kernel/trace/rv/monitors/sleep/sleep_kunit.c | 58 +++++++++++++++++++ kernel/trace/rv/monitors/sleep/sleep_kunit.h | 30 ++++++++++ kernel/trace/rv/rv_monitors_test.c | 4 ++ 8 files changed, 189 insertions(+) create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_kunit.c create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_kunit.h create mode 100644 kernel/trace/rv/monitors/sleep/sleep_kunit.c create mode 100644 kernel/trace/rv/monitors/sleep/sleep_kunit.h
include/rv/ltl_monitor.h +8 -0
@@ -172,3 +172,11 @@ static void __maybe_unused ltl_atom_pulse(struct task_struct *task, enum ltl_atoltl_atom_set (mon, atom, !value);ltl_validate (task, mon); } + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#define RV_MON_OPS_INIT () { \ + .rv_this = &rv_this, \ + .is_per_task = true, \ + .task_slot = <l_monitor_slot, \ +} +#endif /* CONFIG_RV_MONITORS_KUNIT_TEST */
kernel/trace/rv/monitors/pagefault/pagefault.c +12 -0
@@ -86,3 +86,15 @@ module_exit(unregister_pagefault);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Nam Cao <[email protected]>" );MODULE_DESCRIPTION ("pagefault: Monitor that RT tasks do not raise page faults" ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "pagefault_kunit.h" + +const struct rv_pagefault_ops rv_pagefault_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_page_fault = handle_page_fault, + .handle_task_newtask = handle_task_newtask, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_pagefault_ops); +#endif
kernel/trace/rv/monitors/pagefault/pagefault_kunit.c new file +34 -0
@@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <linux/kernel.h> +#include <linux/rv.h> +#include <rv/kunit.h> +#include <linux/sched/deadline.h> +#include <linux/sched/rt.h> +#include "pagefault_kunit.h" + +#if IS_REACHABLE (CONFIG_RV_MON_PAGEFAULT ) + +static void rv_test_pagefault (struct kunit *test) +{ +struct task_struct *target =rv_kunit_alloc_mock_task (test); +struct rv_kunit_ctx *ctx = test->priv; + +prepare_test (test, &rv_pagefault_ops.mon); + +/* Initial pagefault when non-RT to start the model without failure */ + target->policy =SCHED_NORMAL ; + target->prio =MAX_RT_PRIO +20 ; + rv_pagefault_ops.handle_task_newtask (NULL , target,0 ); +rv_mock_current (target); + rv_pagefault_ops.handle_page_fault (NULL ,0 ,NULL ,0 ); + +/* RT task has a page fault */ + target->policy =SCHED_FIFO ; + target->prio =MAX_RT_PRIO -1 ; + RV_KUNIT_EXPECT_REACTION_HERE(test, ctx) + rv_pagefault_ops.handle_page_fault (NULL ,0 ,NULL ,0 ); +} + +#else +#define rv_test_pagefault rv_test_stub +#endif
kernel/trace/rv/monitors/pagefault/pagefault_kunit.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __PAGEFAULT_KUNIT_H +#define __PAGEFAULT_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_pagefault_ops { +struct rv_kunit_mon mon; +void (*handle_page_fault)(void *data,unsigned long address,struct pt_regs *regs, +unsigned long error_code); +void (*handle_task_newtask)(void *data,struct task_struct *task,u64 flags); +} rv_pagefault_ops; +#endif + +#endif /* __PAGEFAULT_KUNIT_H */
kernel/trace/rv/monitors/sleep/sleep.c +19 -0
@@ -247,3 +247,22 @@ module_exit(unregister_sleep);MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Nam Cao <[email protected]>" );MODULE_DESCRIPTION ("sleep: Monitor that RT tasks do not undesirably sleep" ); + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) +#include <kunit/visibility.h> +#include "sleep_kunit.h" + +const struct rv_sleep_ops rv_sleep_ops = { + .mon =RV_MON_OPS_INIT (), + .handle_sched_waking = handle_sched_waking, + .handle_sched_wakeup = handle_sched_wakeup, + .handle_sched_set_state = handle_sched_set_state, + .handle_contention_begin = handle_contention_begin, + .handle_contention_end = handle_contention_end, + .handle_kthread_stop = handle_kthread_stop, + .handle_sys_enter = handle_sys_enter, + .handle_sys_exit = handle_sys_exit, + .handle_task_newtask = handle_task_newtask, +}; +EXPORT_SYMBOL_IF_KUNIT (rv_sleep_ops); +#endif
kernel/trace/rv/monitors/sleep/sleep_kunit.c new file +58 -0
58 lines not on this page · raw message
kernel/trace/rv/monitors/sleep/sleep_kunit.h new file +30 -0
@@ -0,0 +1,30 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Automatically generated by rvgen kunit. +* May need manual intervention for function prototypes that couldn't be +* found (e.g. are in another file) or variables to be exported. +*/ + +#ifndef __SLEEP_KUNIT_H +#define __SLEEP_KUNIT_H + +#if IS_ENABLED (CONFIG_RV_MONITORS_KUNIT_TEST ) + +#include <linux/rv.h> +#include <rv/kunit.h> + +extern const struct rv_sleep_ops { +struct rv_kunit_mon mon; +void (*handle_sched_waking)(void *data,struct task_struct *task); +void (*handle_sched_wakeup)(void *data,struct task_struct *task); +void (*handle_sched_set_state)(void *data,struct task_struct *task,int state); +void (*handle_contention_begin)(void *data,void *lock,unsigned int flags); +void (*handle_contention_end)(void *data,void *lock,int ret); +void (*handle_kthread_stop)(void *data,struct task_struct *task); +void (*handle_sys_enter)(void *data,struct pt_regs *regs,long id); +void (*handle_sys_exit)(void *data,struct pt_regs *regs,long ret); +void (*handle_task_newtask)(void *data,struct task_struct *task,u64 flags); +} rv_sleep_ops; +#endif + +#endif /* __SLEEP_KUNIT_H */
kernel/trace/rv/rv_monitors_test.c +4 -0
@@ -148,6 +148,8 @@ static void rv_test_dummy(struct kunit *test)#include "monitors/sts/sts_kunit.c" #include "monitors/opid/opid_kunit.c" #include "monitors/nomiss/nomiss_kunit.c" +#include "monitors/pagefault/pagefault_kunit.c" +#include "monitors/sleep/sleep_kunit.c" static struct kunit_case rv_mon_test_cases[] = {KUNIT_CASE (rv_test_dummy),
@@ -156,6 +158,8 @@ static struct kunit_case rv_mon_test_cases[] = {KUNIT_CASE (rv_test_sts),KUNIT_CASE (rv_test_opid),KUNIT_CASE (rv_test_nomiss), +KUNIT_CASE (rv_test_pagefault), + KUNIT_CASE(rv_test_sleep), {} };
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 15/17 selftests/verification: Fix wrong errexit assumption
In reply to Gabriele MonacoRV selftest rely on bash errexit (set -e) to terminate with error, when a step is expected to return false, the following syntax is used:
! cmd
This however prevents the test from exiting when cmd is false (desired) but doesn't exit if cmd is true, since commands prefixed with ! are explicitly excluded from errexit.
Use the syntax
! cmd || false
Which ends up checking the exit value of ! cmd and supplies a false command for errexit to evaluate.
--- .../verification/test.d/rv_monitor_enable_disable.tc | 10 +++++----- .../verification/test.d/rv_monitor_reactor.tc | 4 ++-- .../selftests/verification/test.d/rv_wwnr_printk.tc | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-)
tools/testing/selftests/verification/test.d/rv_monitor_enable_disable.tc +5 -5
@@ -10,7 +10,7 @@ test_simple_monitor() { grep -q "$monitor$" enabled_monitors echo 0 > "monitors/$prefix$monitor/enable" - ! grep -q "$monitor$" enabled_monitors + ! grep -q "$monitor$" enabled_monitors || false echo "$monitor" >> enabled_monitors grep -q 1 "monitors/$prefix$monitor/enable"
@@ -34,12 +34,12 @@ test_container_monitor() { test -n "$nested" echo 0 > "monitors/$monitor/enable" - ! grep -q "^$monitor$" enabled_monitors + ! grep -q "^$monitor$" enabled_monitors || false for nested_dir in "monitors/$monitor"/*; do [ -d "$nested_dir" ] || continue nested=$(basename "$nested_dir") - ! grep -q "^$monitor:$nested$" enabled_monitors + ! grep -q "^$monitor:$nested$" enabled_monitors || false done echo "$monitor" >> enabled_monitors
@@ -71,5 +71,5 @@ for monitor_dir in monitors/*; do fi done -! echo non_existent_monitor > enabled_monitors -! grep -q "^non_existent_monitor$" enabled_monitors +! echo non_existent_monitor > enabled_monitors || false +! grep -q "^non_existent_monitor$" enabled_monitors || false
tools/testing/selftests/verification/test.d/rv_monitor_reactor.tc +2 -2
@@ -64,5 +64,5 @@ done monitor=$(ls /sys/kernel/tracing/rv/monitors -1 | head -n 1) test -f "monitors/$monitor/reactors" -! echo non_existent_reactor > "monitors/$monitor/reactors" -! grep -q "\\[non_existent_reactor\\]" "monitors/$monitor/reactors" +! echo non_existent_reactor > "monitors/$monitor/reactors" || false +! grep -q "\\[non_existent_reactor\\]" "monitors/$monitor/reactors" || false
tools/testing/selftests/verification/test.d/rv_wwnr_printk.tc +2 -2
@@ -17,13 +17,13 @@ echo printk > monitors/wwnr/reactors load echo 0 > monitoring_on -! load +! load || false echo 1 > monitoring_on load echo 0 > reacting_on -! load +! load || false echo 1 > reacting_on echo nop > monitors/wwnr/reactors
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 16/17 selftests/verification: Rearrange the wwnr_printk test
In reply to Gabriele MonacoThe wwnr_printk test expects no reactions in some situations, after fixing the bash assertion, the test is failing because expecting no reaction after a previous step had reactions is flaky without making sure all buffers are flushed.
Wait for reactions to be over when expected by polling dmesg for an interval without any rv message.
Also simplify the load function to stop loads as soon as a reaction occurs, this limits the number of lines to flush and makes tests overall faster and more stable.
---
Notes:
V5:
* Move wait for flush to avoid wwnr/printk selftest to hang V4:
* Wait for dmesg to flush all messages after reactions
.../verification/test.d/rv_wwnr_printk.tc | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-)
tools/testing/selftests/verification/test.d/rv_wwnr_printk.tc +25 -3
@@ -4,11 +4,29 @@ # requires: available_reactors wwnr:monitor printk:reactor stress-ng:program load() { # returns true if there was a reaction - local lines_before num + local lines_before num load_pid ret num=$((($(nproc) + 1) / 2)) lines_before=$(dmesg | wc -l) - stress-ng --cpu-sched "$num" --timer "$num" -t 5 -q - dmesg | tail -n $((lines_before + 1)) | grep -q "rv: monitor wwnr does not allow event" + stress-ng --cpu-sched "$num" --timer "$num" -t 5 -q & + load_pid=$! + timeout 5 dmesg -w | tail -n +$((lines_before + 1)) | \ + grep -m 1 -q "rv: monitor wwnr does not allow event" + ret=$? + kill "$load_pid" || true + wait "$load_pid" || true + return $ret +} + +# loads may flood the ringbuffer, wait for all pending printks (timeout at 2 minutes) +wait_dmesg_flush() { + local last_before last_after + for _ in $(seq 400); do + last_before=$last_after + last_after=$(dmesg | grep "rv:" | tail -n 1 || true) + [ "$last_before" = "$last_after" ] && return 0 + sleep .3 + done + return 1 } echo 1 > monitors/wwnr/enable
@@ -17,12 +35,16 @@ echo printk > monitors/wwnr/reactors load echo 0 > monitoring_on +wait_dmesg_flush + ! load || false echo 1 > monitoring_on load echo 0 > reacting_on +wait_dmesg_flush + ! load || false echo 1 > reacting_on
Signature · 1 line
2.55.0
Gabriele Monaco
maintainerPATCH v5 17/17 selftests/verification: Add selftests for deadline and stall monitors
In reply to Gabriele MonacoAdd selftests to verify deadline monitors don't fail under expected conditions and the stall monitor report violations only when expected.
---
Notes:
V4:
* Restore original stall threshold after selftest
.../verification/test.d/rv_deadline.tc | 23 +++++++++++++ .../selftests/verification/test.d/rv_stall.tc | 33 +++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 tools/testing/selftests/verification/test.d/rv_deadline.tc create mode 100644 tools/testing/selftests/verification/test.d/rv_stall.tc
tools/testing/selftests/verification/test.d/rv_deadline.tc new file +23 -0
@@ -0,0 +1,23 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later +# description: Test deadline monitors trigger no reaction +# requires: available_reactors deadline:monitor printk:reactor stress-ng:program + +load() { # returns true if there was a reaction + local lines_before + lines_before=$(dmesg | wc -l) + stress-ng --cpu 2 --sched deadline --sched-period 100000000 \ + --sched-deadline 100000000 --sched-runtime 20000000 -t 5 & + stress-ng --cpu 2 --sched rr --sched-prio 50 --cyclic 1 \ + --cyclic-policy rr --cyclic-prio 50 -t 5 & + wait + dmesg | tail -n +$((lines_before + 1)) | grep -q "rv: monitor [a-z]\+ does not allow event" +} + +echo 1 > monitors/deadline/enable +echo printk > monitors/deadline/reactors + +! load || false + +echo nop > monitors/deadline/reactors +echo 0 > monitors/deadline/enable
tools/testing/selftests/verification/test.d/rv_stall.tc new file +33 -0
@@ -0,0 +1,33 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later +# description: Test stall monitor +# requires: available_reactors stall:monitor printk:reactor stress-ng:program + +THRESHOLD=/sys/module/stall/parameters/threshold_jiffies +ORIG_THRESHOLD=$(cat $THRESHOLD) +trap 'echo $ORIG_THRESHOLD > $THRESHOLD' EXIT + +load() { # returns true if there was a reaction + local lines_before cpu + cpu=$(($(nproc) - 1)) + lines_before=$(dmesg | wc -l) + stress-ng --cpu 1 --taskset "$cpu" --sched rr --sched-prio 1 -t 3 & + stress-ng --cpu 5 --taskset "$cpu" -t 3 & + wait + dmesg | tail -n +$((lines_before + 1)) | grep -q "rv: monitor stall does not allow event" +} + +echo 5000 > $THRESHOLD +echo 1 > monitors/stall/enable +echo printk > monitors/stall/reactors + +! load || false + +echo 0 > monitors/stall/enable +echo 70 > $THRESHOLD +echo 1 > monitors/stall/enable + +load + +echo nop > monitors/stall/reactors +echo 0 > monitors/stall/enable
Signature · 1 line
2.55.0