Linear temporal logic monitors for RT application
Subsystems (8)
v10 cover Linear temporal logic monitors for RT application
Real-time applications may have design flaws causing them to have unexpected latency. For example, the applications may raise page faults, or may be blocked trying to take a mutex without priority inheritance.
However, while attempting to implement DA monitors for these real-time rules, deterministic automaton is found to be inappropriate as the specification language. The automaton is complicated, hard to understand, and error-prone.
For these cases, linear temporal logic is found to be more suitable. The LTL is more concise and intuitive.
This series adds support for LTL RV monitor, and use it to implement two monitors for reporting problems with real-time tasks.
Patch 1-12 cleanup and prepare the RV code for the integration of LTL monitors.
Patch 13 adds support for LTL monitors.
Patch 14 adds the container monitor "rtapp". This encapsulates the sub-monitors for real-time.
Patch 15 prepares the pagefault tracepoints on riscv, so that patch 16 can add the monitor which watches real-time tasks doing page faults.
Patch 17 adds the "sleep" monitor: it detects potential undesirable latency with real-time threads.
Patch 18 adds documentation on the new monitors.
Patch 19 allows the number of per-task monitors to be configurable, so that the two new monitors can be enabled simultaneously.
v9->v10 https://lore.kernel.org/lkml/[email protected]
- rebase onto v6.16-rc1 (only the vpanic patch is changed)
- riscv: move page fault tracepoints back to be after kprobe pagefault handling
- drop x86 tracepoint patches, they have already been applied
- drop arm64 tracepoint patch. It requires further discussion and will be sent separately.
- pagefault monitor: set dependency on x86 and riscv, only these archs have the required tracepoints right now.
v8->v9 https://lore.kernel.org/lkml/[email protected]/
- Move page faults tracepoints to be before kprobe pagefault handling
- Add guidance into Kconfig entries whether they should be enabled
- Replace TRACE_EVENT with DECLARE_EVENT_CLASS for the tracepoint classes, so that the class names are not wrongly exposed to userspace
v7->v8 https://lore.kernel.org/lkml/[email protected]/
- Fix some pylint warnings
- Fix some bugs with some currently-unused operators in the ltl2ba.py script
- sleep monitor: Allow all FUTEX_WAIT_* as valid sleep reason
v6->v7 https://lore.kernel.org/lkml/[email protected]/
- Add missing parameter description for vpanic()
- Remove the now-redundant CFLAGS_fault.o for x86
- Change #if to #ifdef to resolve a build warning
- rtapp/sleep monitor:
+ Handle the case where an RT task "aborts" the sleep by setting state to TASK_RUNNING. This case previously caused a false positive. Fix it by adding "ABORT_SLEEP" as an RT-safe wake.
+ Also allow CLOCK_TAI for real-time tasks.
v5->v6 https://lore.kernel.org/lkml/[email protected]
- sleep monitor: Drop the block_on_rt_mutex tracepoints. The contention tracepoints are sufficient.
v4->v5 https://lore.kernel.org/lkml/[email protected]
- sleep monitor: Fix a false positive due to a race with waking and scheduling.
- sleep monitor: Add block_on_rt_mutex tracepoints and use them for BLOCK_ON_RT_MUTEX, instead of trace_sched_pi_setprio
- sleep monitor: tighten the rule on nanosleep: only clock_nanosleep() with TIMER_ABSTIME and CLOCK_MONOTONIC is allowed
- add comments explaining why it is correct to treat PI-boosted tasks as real-time tasks.
It should be noted that due to the changes in v5, 'perf' does not work as well as before, because sometimes the errors happen out of the real-time tasks' contexts. Fixing this is left for future work.
stress-ng is also far noisier in v5, because the rule on nanosleep is tightened.
v3->v4 https://lore.kernel.org/lkml/[email protected]
- support deadline tasks
- rtapp_sleep: use sched_pi_setprio tracepoint instead of contention tracepoints for BLOCK_ON_RT_MUTEX, so that proxy lock is covered.
- fix the scripts generating an "slightly" incorrect verification automaton
- makes rtapp monitor depends on RV_PER_TASK_MONITORS >= 2
- make the event tracepoint output a bit more readable
- some documentation's format fixes
v2->v3 https://lore.kernel.org/lkml/[email protected]/
- fix a problem with sleep monitor's specification (around KTHREAD_SHOULD_STOP)
- merge the patches that move the dot2k/rvgen scripts around
- pull panic/printk changes into separate patches
- fixup some build errors
- fixup monitor's init function return code
- fix some flake8 warnings with the scripts
- add some references to LTL documentation
- fixup some mistakes with rtapp documentation
- fixup capitalization mistake with monitor_synthesis.rst
- remove the now-redundant macro RV_PER_TASK_MONITORS
v1->v2 https://lore.kernel.org/lkml/[email protected]/
- Integrate the LTL scripts into the existing dot2k tool, taking advantage of the existing monitor generation scripts.
- Switch the struct ltl_monitor to use bitmap instead of an array, to optimize memory usage.
- Correct the generated code to be non-deterministic state machine, instead of deterministic state machine
- Put common code for all LTL monitors into a single file (include/rv/ltl_monitor.h), reducing code duplication
- Change the LTL monitors to make user of container. Add a bug fix to container while at it.
- Make the number of per-task monitor configurable
Nam Cao (19):
rv: Add #undef TRACE_INCLUDE_FILE
printk: Make vprintk_deferred() public
panic: Add vpanic()
rv: Let the reactors take care of buffers verification/dot2k: Make a separate dot2k_templates/Kconfig_container verification/dot2k: Remove __buff_to_string() verification/dot2k: Replace is_container() hack with subparsers
rv: rename CONFIG_DA_MON_EVENTS to CONFIG_RV_MON_EVENTS verification/dot2k: Prepare the frontend for LTL inclusion Documentation/rv: Prepare monitor synthesis document for LTL inclusion verification/rvgen: Restructure the templates files verification/rvgen: Restructure the classes to prepare for LTL
inclusion
rv: Add support for LTL monitors
rv: Add rtapp container monitor
riscv: mm: Add page fault trace points
rv: Add rtapp_pagefault monitor
rv: Add rtapp_sleep monitor
rv: Add documentation for rtapp monitor
rv: Allow to configure the number of per-task monitor
.../trace/rv/da_monitor_synthesis.rst | 147 -----
Documentation/trace/rv/index.rst | 4 +-
.../trace/rv/linear_temporal_logic.rst | 122 ++++
Documentation/trace/rv/monitor_rtapp.rst | 116 ++++
Documentation/trace/rv/monitor_synthesis.rst | 256 +++++++++
arch/riscv/mm/fault.c | 8 +
include/linux/panic.h | 3 +
include/linux/printk.h | 5 +
include/linux/rv.h | 74 ++-
include/linux/sched.h | 8 +-
include/rv/da_monitor.h | 45 +-
include/rv/ltl_monitor.h | 184 ++++++
kernel/fork.c | 5 +-
kernel/panic.c | 16 +-
kernel/printk/internal.h | 1 -
kernel/trace/rv/Kconfig | 27 +-
kernel/trace/rv/Makefile | 3 +
kernel/trace/rv/monitors/pagefault/Kconfig | 20 +
.../trace/rv/monitors/pagefault/pagefault.c | 87 +++
.../trace/rv/monitors/pagefault/pagefault.h | 57 ++
.../rv/monitors/pagefault/pagefault_trace.h | 14 +
kernel/trace/rv/monitors/rtapp/Kconfig | 15 +
kernel/trace/rv/monitors/rtapp/rtapp.c | 33 ++
kernel/trace/rv/monitors/rtapp/rtapp.h | 3 +
kernel/trace/rv/monitors/sleep/Kconfig | 22 +
kernel/trace/rv/monitors/sleep/sleep.c | 236 ++++++++
kernel/trace/rv/monitors/sleep/sleep.h | 250 ++++++++
kernel/trace/rv/monitors/sleep/sleep_trace.h | 14 +
kernel/trace/rv/reactor_panic.c | 8 +-
kernel/trace/rv/reactor_printk.c | 8 +-
kernel/trace/rv/rv.c | 10 +-
kernel/trace/rv/rv_reactors.c | 2 +-
kernel/trace/rv/rv_trace.h | 52 +-
tools/verification/dot2/Makefile | 26 -
tools/verification/dot2/dot2k | 53 --
tools/verification/models/rtapp/pagefault.ltl | 1 +
tools/verification/models/rtapp/sleep.ltl | 22 +
tools/verification/rvgen/.gitignore | 3 +
tools/verification/rvgen/Makefile | 27 +
tools/verification/rvgen/__main__.py | 67 +++
tools/verification/{dot2 => rvgen}/dot2c | 2 +-
.../{dot2 => rvgen/rvgen}/automata.py | 0
tools/verification/rvgen/rvgen/container.py | 22 +
.../{dot2 => rvgen/rvgen}/dot2c.py | 2 +-
tools/verification/rvgen/rvgen/dot2k.py | 129 +++++
.../dot2k.py => rvgen/rvgen/generator.py} | 249 ++------
tools/verification/rvgen/rvgen/ltl2ba.py | 540 ++++++++++++++++++
tools/verification/rvgen/rvgen/ltl2k.py | 245 ++++++++
.../rvgen/templates}/Kconfig | 0
.../rvgen/rvgen/templates/container/Kconfig | 5 +
.../rvgen/templates/container/main.c} | 0
.../rvgen/templates/container/main.h} | 0
.../rvgen/templates/dot2k}/main.c | 0
.../rvgen/templates/dot2k}/trace.h | 0
.../rvgen/rvgen/templates/ltl2k/main.c | 102 ++++
.../rvgen/rvgen/templates/ltl2k/trace.h | 14 +
56 files changed, 2873 insertions(+), 491 deletions(-)
delete mode 100644 Documentation/trace/rv/da_monitor_synthesis.rst
create mode 100644 Documentation/trace/rv/linear_temporal_logic.rst
create mode 100644 Documentation/trace/rv/monitor_rtapp.rst
create mode 100644 Documentation/trace/rv/monitor_synthesis.rst
create mode 100644 include/rv/ltl_monitor.h
create mode 100644 kernel/trace/rv/monitors/pagefault/Kconfig
create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault.c
create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault.h
create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_trace.h
create mode 100644 kernel/trace/rv/monitors/rtapp/Kconfig
create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.c
create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.h
create mode 100644 kernel/trace/rv/monitors/sleep/Kconfig
create mode 100644 kernel/trace/rv/monitors/sleep/sleep.c
create mode 100644 kernel/trace/rv/monitors/sleep/sleep.h
create mode 100644 kernel/trace/rv/monitors/sleep/sleep_trace.h
delete mode 100644 tools/verification/dot2/Makefile
delete mode 100644 tools/verification/dot2/dot2k
create mode 100644 tools/verification/models/rtapp/pagefault.ltl
create mode 100644 tools/verification/models/rtapp/sleep.ltl
create mode 100644 tools/verification/rvgen/.gitignore
create mode 100644 tools/verification/rvgen/Makefile
create mode 100644 tools/verification/rvgen/__main__.py
rename tools/verification/{dot2 => rvgen}/dot2c (97%)
rename tools/verification/{dot2 => rvgen/rvgen}/automata.py (100%)
create mode 100644 tools/verification/rvgen/rvgen/container.py
rename tools/verification/{dot2 => rvgen/rvgen}/dot2c.py (99%)
create mode 100644 tools/verification/rvgen/rvgen/dot2k.py
rename tools/verification/{dot2/dot2k.py => rvgen/rvgen/generator.py} (52%)
create mode 100644 tools/verification/rvgen/rvgen/ltl2ba.py
create mode 100644 tools/verification/rvgen/rvgen/ltl2k.py
rename tools/verification/{dot2/dot2k_templates => rvgen/rvgen/templates}/Kconfig (100%)
create mode 100644 tools/verification/rvgen/rvgen/templates/container/Kconfig
rename tools/verification/{dot2/dot2k_templates/main_container.c => rvgen/rvgen/templates/container/main.c} (100%)
rename tools/verification/{dot2/dot2k_templates/main_container.h => rvgen/rvgen/templates/container/main.h} (100%)
rename tools/verification/{dot2/dot2k_templates => rvgen/rvgen/templates/dot2k}/main.c (100%)
rename tools/verification/{dot2/dot2k_templates => rvgen/rvgen/templates/dot2k}/trace.h (100%)
create mode 100644 tools/verification/rvgen/rvgen/templates/ltl2k/main.c
create mode 100644 tools/verification/rvgen/rvgen/templates/ltl2k/trace.hSignature · 1 line
2.39.5
PATCH v10 1/19 Add #undef TRACE_INCLUDE_FILE
Without "#undef TRACE_INCLUDE_FILE", there could be a build error due to TRACE_INCLUDE_FILE being redefined. Therefore add it.
Also fix a typo while at it.
--- kernel/trace/rv/rv_trace.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
kernel/trace/rv/rv_trace.h +2 -1
@@ -129,8 +129,9 @@ DECLARE_EVENT_CLASS(error_da_monitor_id,#endif /* CONFIG_DA_MON_EVENTS_ID */ #endif /* _TRACE_RV_H */ -/* This part ust be outside protection */ +/* This part must be outside protection */ #undef TRACE_INCLUDE_PATH#define TRACE_INCLUDE_PATH . +#undef TRACE_INCLUDE_FILE#define TRACE_INCLUDE_FILE rv_trace#include <trace/define_trace.h>
Signature · 1 line
2.39.5
PATCH v10 2/19 printk: Make vprintk_deferred() public
In reply to Nam Caovprintk_deferred() is useful for implementing runtime verification reactors. Make it public.
---
Cc: John Ogness <[email protected]>
Cc: Sergey Senozhatsky <[email protected]>
--- include/linux/printk.h | 5 +++++ kernel/printk/internal.h | 1 - 2 files changed, 5 insertions(+), 1 deletion(-)
include/linux/printk.h +5 -0
@@ -154,6 +154,7 @@ int vprintk_emit(int facility, int level, asmlinkage __printf(1, 0) int vprintk(const char *fmt, va_list args); +__printf(1, 0) int vprintk_deferred(const char *fmt, va_list args); asmlinkage __printf(1, 2) __cold int _printk(const char *fmt, ...);
@@ -214,6 +215,10 @@ int vprintk(const char *s, va_list args) {return 0 ; } +__printf(1, 0) int vprintk_deferred(const char *fmt, va_list args) +{ +return 0 ; +} static inline __printf(1, 2) __cold int _printk(const char *s, ...) {
kernel/printk/internal.h +0 -1
@@ -72,7 +72,6 @@ int vprintk_store(int facility, int level, const char *fmt, va_list args); __printf(1, 0) int vprintk_default(const char *fmt, va_list args); -__printf(1, 0) int vprintk_deferred(const char *fmt, va_list args);void __printk_safe_enter (void );void __printk_safe_exit (void );
Signature · 1 line
2.39.5
PATCH v10 3/19 panic: Add vpanic()
In reply to Nam Caovpanic() is useful for implementing runtime verification reactors. Add it.
---
Cc: John Ogness <[email protected]>
Cc: Sergey Senozhatsky <[email protected]>
--- include/linux/panic.h | 3 +++ kernel/panic.c | 16 ++++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-)
include/linux/panic.h +3 -0
@@ -3,6 +3,7 @@#define _LINUX_PANIC_H#include <linux/compiler_attributes.h> +#include <linux/stdarg.h> #include <linux/types.h> struct pt_regs ;
@@ -10,6 +11,8 @@ struct pt_regs;extern long (*panic_blink)(int state); __printf(1, 2)void panic (const char *fmt, ...)__noreturn __cold ; +__printf(1, 0) +void vpanic (const char *fmt,va_list args)__noreturn __cold ;void nmi_panic (struct pt_regs *regs,const char *msg);void check_panic_on_warn (const char *origin);extern void oops_enter (void );
kernel/panic.c +12 -4
@@ -309,13 +309,13 @@ static void panic_other_cpus_shutdown(bool crash_kexec)/** * panic - halt the system * @fmt: The text string to print +* @args: Arguments for the format string * * Display a message, then perform cleanups. This function never returns. */ -void panic (const char *fmt, ...) +void vpanic (const char *fmt,va_list args) {static char buf[1024 ]; -va_list args;long i, i_next =0 , len;int state =0 ;int old_cpu, this_cpu;
@@ -366,9 +366,7 @@ void panic(const char *fmt, ...)console_verbose ();bust_spinlocks (1 ); -va_start (args, fmt); len =vscnprintf (buf,sizeof (buf), fmt, args); -va_end (args);if (len && buf[len -1 ] =='\n' ) buf[len -1 ] ='\0' ;
@@ -505,7 +503,17 @@ void panic(const char *fmt, ...)mdelay (PANIC_TIMER_STEP ); } } +EXPORT_SYMBOL (vpanic); +/* Identical to vpanic(), except it takes variadic arguments instead of va_list */ +void panic (const char *fmt, ...) +{ +va_list args; + +va_start (args, fmt); +vpanic (fmt, args); +va_end (args); +}EXPORT_SYMBOL (panic);#define TAINT_FLAG (taint, _c_true, _c_false, _module) \
Signature · 1 line
2.39.5
PATCH v10 4/19 Let the reactors take care of buffers
In reply to Nam CaoEach RV monitor has one static buffer to send to the reactors. If multiple errors are detected simultaneously, the one buffer could be overwritten.
Instead, leave it to the reactors to handle buffering.
---
Cc: Petr Mladek <[email protected]>
Cc: John Ogness <[email protected]>
Cc: Sergey Senozhatsky <[email protected]>
--- include/linux/rv.h | 9 +++++-- include/rv/da_monitor.h | 45 +++++++------------------------- kernel/trace/rv/reactor_panic.c | 8 ++++-- kernel/trace/rv/reactor_printk.c | 8 ++++-- kernel/trace/rv/rv_reactors.c | 2 +- 5 files changed, 30 insertions(+), 42 deletions(-)
include/linux/rv.h +7 -2
@@ -38,7 +38,7 @@ union rv_task_monitor {struct rv_reactor {const char *name;const char *description; -void (*react)(char *msg); + __printf(1, 2) void (*react)(const char *msg, ...); };#endif
@@ -50,7 +50,7 @@ struct rv_monitor {void (*disable)(void );void (*reset)(void );#ifdef CONFIG_RV_REACTORS -void (*react)(char *msg); + __printf(1, 2) void (*react)(const char *msg, ...);#endif };
@@ -64,6 +64,11 @@ void rv_put_task_monitor_slot(int slot);bool rv_reacting_on (void );int rv_unregister_reactor (struct rv_reactor *reactor);int rv_register_reactor (struct rv_reactor *reactor); +#else +static inline bool rv_reacting_on (void ) +{ +return false; +}#endif /* CONFIG_RV_REACTORS */ #endif /* CONFIG_RV */
include/rv/da_monitor.h +10 -35
71 lines not on this page · raw message
kernel/trace/rv/reactor_panic.c +6 -2
@@ -13,9 +13,13 @@#include <linux/init.h> #include <linux/rv.h> -static void rv_panic_reaction (char *msg) +__printf(1, 2) static void rv_panic_reaction(const char *msg, ...) { -panic (msg); +va_list args; + +va_start (args, msg); +vpanic (msg, args); +va_end (args); }static struct rv_reactor rv_panic = {
kernel/trace/rv/reactor_printk.c +6 -2
@@ -12,9 +12,13 @@#include <linux/init.h> #include <linux/rv.h> -static void rv_printk_reaction (char *msg) +__printf(1, 2) static void rv_printk_reaction(const char *msg, ...) { -printk_deferred (msg); +va_list args; + +va_start (args, msg); +vprintk_deferred (msg, args); +va_end (args); }static struct rv_reactor rv_printk = {
kernel/trace/rv/rv_reactors.c +1 -1
@@ -490,7 +490,7 @@ void reactor_cleanup_monitor(struct rv_monitor_def *mdef)/* * Nop reactor register */ -static void rv_nop_reaction (char *msg) +__printf(1, 2) static void rv_nop_reaction(const char *msg, ...) { }
Signature · 1 line
2.39.5
PATCH v10 5/19 verification/dot2k: Make a separate dot2k_templates/Kconfig_container
In reply to Nam CaoA generated container's Kconfig has an incorrect line:
select DA_MON_EVENTS_IMPLICIT
This is due to container generation uses the same template Kconfig file as deterministic automaton monitor.
Therefore, make a separate Kconfig template for container which has only the necessaries for container.
---
Alternatively, we could also modify the Python scripts. I tried both and this solution seems cleaner.
--- tools/verification/dot2/dot2k.py | 3 ++- tools/verification/dot2/dot2k_templates/Kconfig_container | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 tools/verification/dot2/dot2k_templates/Kconfig_container
tools/verification/dot2/dot2k.py +2 -1
@@ -35,6 +35,7 @@ class dot2k(Dot2c): self.states = [] self.main_c = self.__read_file(self.monitor_templates_dir + "main_container.c") self.main_h = self.__read_file(self.monitor_templates_dir + "main_container.h") + self.kconfig = self.__read_file(self.monitor_templates_dir + "Kconfig_container") else: super().__init__(file_path, extra_params.get("model_name"))
@@ -44,7 +45,7 @@ class dot2k(Dot2c): self.monitor_type = MonitorType self.main_c = self.__read_file(self.monitor_templates_dir + "main.c") self.trace_h = self.__read_file(self.monitor_templates_dir + "trace.h") - self.kconfig = self.__read_file(self.monitor_templates_dir + "Kconfig") + self.kconfig = self.__read_file(self.monitor_templates_dir + "Kconfig") self.enum_suffix = "_%s" % self.name self.description = extra_params.get("description", self.name) or "auto-generated" self.auto_patch = extra_params.get("auto_patch")
tools/verification/dot2/dot2k_templates/Kconfig_container new file +5 -0
@@ -0,0 +1,5 @@ +config RV_MON_%%MODEL_NAME_UP%% + depends on RV + bool "%%MODEL_NAME%% monitor" + help + %%DESCRIPTION%%
Signature · 1 line
2.39.5
PATCH v10 6/19 verification/dot2k: Remove __buff_to_string()
In reply to Nam Caostr.join() can do what __buff_to_string() does. Therefore replace __buff_to_string() to make the scripts more pythonic.
--- tools/verification/dot2/dot2k.py | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-)
tools/verification/dot2/dot2k.py +6 -15
@@ -109,15 +109,6 @@ class dot2k(Dot2c): fd.close() return content - def __buff_to_string(self, buff): - string = "" - - for line in buff: - string = string + line + "\n" - - # cut off the last \n - return string[:-1] - def fill_monitor_type(self): return self.monitor_type.upper()
@@ -148,19 +139,19 @@ class dot2k(Dot2c): buff.append("\tda_%s_%s(%s%s);" % (handle, self.name, event, self.enum_suffix)); buff.append("}") buff.append("") - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_tracepoint_attach_probe(self): buff = [] for event in self.events: buff.append("\trv_attach_trace_probe(\"%s\", /* XXX: tracepoint */, handle_%s);" % (self.name, event)) - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_tracepoint_detach_helper(self): buff = [] for event in self.events: buff.append("\trv_detach_trace_probe(\"%s\", /* XXX: tracepoint */, handle_%s);" % (self.name, event)) - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_main_c(self): main_c = self.main_c
@@ -210,7 +201,7 @@ class dot2k(Dot2c): buff = self.fill_model_h_header() buff += self.format_model() - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_monitor_class_type(self): if self.monitor_type == "per_task":
@@ -242,7 +233,7 @@ class dot2k(Dot2c): tp_args_c = ", ".join([b for a,b in tp_args]) buff.append(" TP_PROTO(%s)," % tp_proto_c) buff.append(" TP_ARGS(%s)" % tp_args_c) - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_monitor_deps(self): buff = []
@@ -250,7 +241,7 @@ class dot2k(Dot2c): if self.parent: buff.append(" depends on RV_MON_%s" % self.parent.upper()) buff.append(" default y") - return self.__buff_to_string(buff) + return '\n'.join(buff) def fill_trace_h(self): trace_h = self.trace_h
Signature · 1 line
2.39.5
PATCH v10 7/19 verification/dot2k: Replace is_container() hack with subparsers
In reply to Nam Caodot2k is used for both generating deterministic automaton (DA) monitor and generating container monitor.
Generating DA monitor and generating container requires different parameters. This is implemented by peeking at sys.argv and check whether "--container" is specified, and use that information to make some parameters optional or required.
This works, but is quite hacky and ugly.
Replace this hack with Python's built-in subparsers.
The old commands:
python3 dot2/dot2k -d wip.dot -t per_cpu python3 dot2/dot2k -n sched --container
are equivalent to the new commands:
python3 dot2/dot2k monitor -d wip.dot -t per_cpu python3 dot2/dot2k container -n sched
--- tools/verification/dot2/dot2k | 37 +++++++++++++++++--------------- tools/verification/dot2/dot2k.py | 2 +- 2 files changed, 21 insertions(+), 18 deletions(-)
tools/verification/dot2/dot2k +20 -17
@@ -13,30 +13,33 @@ if __name__ == '__main__': import argparse import sys - def is_container(): - """Should work even before parsing the arguments""" - return "-c" in sys.argv or "--container" in sys.argv - parser = argparse.ArgumentParser(description='transform .dot file into kernel rv monitor') - parser.add_argument('-d', "--dot", dest="dot_file", required=not is_container()) - parser.add_argument('-t', "--monitor_type", dest="monitor_type", required=not is_container(), - help=f"Available options: {', '.join(dot2k.monitor_types.keys())}") - parser.add_argument('-n', "--model_name", dest="model_name", required=is_container()) parser.add_argument("-D", "--description", dest="description", required=False) parser.add_argument("-a", "--auto_patch", dest="auto_patch", action="store_true", required=False, help="Patch the kernel in place") - parser.add_argument("-p", "--parent", dest="parent", - required=False, help="Create a monitor nested to parent") - parser.add_argument("-c", "--container", dest="container", - action="store_true", required=False, - help="Create an empty monitor to be used as a container") + + subparsers = parser.add_subparsers(dest="subcmd", required=True) + + monitor_parser = subparsers.add_parser("monitor") + monitor_parser.add_argument('-n', "--model_name", dest="model_name") + monitor_parser.add_argument("-p", "--parent", dest="parent", + required=False, help="Create a monitor nested to parent") + monitor_parser.add_argument('-d', "--dot", dest="dot_file") + monitor_parser.add_argument('-t', "--monitor_type", dest="monitor_type", + help=f"Available options: {', '.join(dot2k.monitor_types.keys())}") + + container_parser = subparsers.add_parser("container") + container_parser.add_argument('-n', "--model_name", dest="model_name", required=True) + params = parser.parse_args() - if not is_container(): - print("Opening and parsing the dot file %s" % params.dot_file) try: - monitor=dot2k(params.dot_file, params.monitor_type, vars(params)) + if params.subcmd == "monitor": + print("Opening and parsing the dot file %s" % params.dot_file) + monitor = dot2k(params.dot_file, params.monitor_type, vars(params)) + else: + monitor = dot2k(None, None, vars(params)) except Exception as e: print('Error: '+ str(e)) print("Sorry : :-(")
@@ -45,7 +48,7 @@ if __name__ == '__main__': print("Writing the monitor into the directory %s" % monitor.name) monitor.print_files() print("Almost done, checklist") - if not is_container(): + if params.subcmd == "monitor": print(" - Edit the %s/%s.c to add the instrumentation" % (monitor.name, monitor.name)) print(monitor.fill_tracepoint_tooltip()) print(monitor.fill_makefile_tooltip())
tools/verification/dot2/dot2k.py +1 -1
@@ -19,7 +19,7 @@ class dot2k(Dot2c): monitor_type = "per_cpu" def __init__(self, file_path, MonitorType, extra_params={}): - self.container = extra_params.get("container") + self.container = extra_params.get("subcmd") == "container" self.parent = extra_params.get("parent") self.__fill_rv_templates_dir()
Signature · 1 line
2.39.5
PATCH v10 8/19 rename CONFIG_DA_MON_EVENTS to CONFIG_RV_MON_EVENTS
In reply to Nam CaoCONFIG_DA_MON_EVENTS is not specific to deterministic automaton. It could be used for other monitor types. Therefore rename it to CONFIG_RV_MON_EVENTS.
This prepares for the introduction of linear temporal logic monitor.
--- kernel/trace/rv/Kconfig | 6 +++--- kernel/trace/rv/rv.c | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-)
kernel/trace/rv/Kconfig +3 -3
@@ -1,14 +1,14 @@ # SPDX-License-Identifier: GPL-2.0-only # -config DA_MON_EVENTS +config RV_MON_EVENTS bool config DA_MON_EVENTS_IMPLICIT - select DA_MON_EVENTS + select RV_MON_EVENTS bool config DA_MON_EVENTS_ID - select DA_MON_EVENTS + select RV_MON_EVENTS bool menuconfig RV
kernel/trace/rv/rv.c +1 -1
@@ -143,7 +143,7 @@#include <linux/init.h> #include <linux/slab.h> -#ifdef CONFIG_DA_MON_EVENTS +#ifdef CONFIG_RV_MON_EVENTS #define CREATE_TRACE_POINTS #include <rv_trace.h> #endif
Signature · 1 line
2.39.5
PATCH v10 9/19 verification/dot2k: Prepare the frontend for LTL inclusion
In reply to Nam CaoThe dot2k tool has some code that can be reused for linear temporal logic monitor. Prepare its frontend for LTL inclusion:
1. Rename to be generic: rvgen
2. Replace the parameter --dot with 2 parameters:
--class: to specific the monitor class, can be 'da' or 'ltl' --spec: the monitor specification file, .dot file for DA, and .ltl
file for LTL
The old command:
python3 dot2/dot2k monitor -d wip.dot -t per_cpu
is equivalent to the new commands:
python3 rvgen monitor -c da -s wip.dot -t per_cpu
---
tools/verification/{dot2 => rvgen}/Makefile | 10 +++++-----
.../{dot2/dot2k => rvgen/__main__.py} | 18 +++++++++++++-----
tools/verification/{dot2 => rvgen}/dot2c | 2 +-
.../{dot2 => rvgen}/dot2k_templates/Kconfig | 0
.../dot2k_templates/Kconfig_container | 0
.../{dot2 => rvgen}/dot2k_templates/main.c | 0
.../dot2k_templates/main_container.c | 0
.../dot2k_templates/main_container.h | 0
.../{dot2 => rvgen}/dot2k_templates/trace.h | 0
.../{dot2 => rvgen/rvgen}/automata.py | 0
.../{dot2 => rvgen/rvgen}/dot2c.py | 2 +-
.../{dot2 => rvgen/rvgen}/dot2k.py | 10 +++++-----
12 files changed, 25 insertions(+), 17 deletions(-)
rename tools/verification/{dot2 => rvgen}/Makefile (55%)
rename tools/verification/{dot2/dot2k => rvgen/__main__.py} (72%)
rename tools/verification/{dot2 => rvgen}/dot2c (97%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/Kconfig (100%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/Kconfig_container (100%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/main.c (100%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/main_container.c (100%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/main_container.h (100%)
rename tools/verification/{dot2 => rvgen}/dot2k_templates/trace.h (100%)
rename tools/verification/{dot2 => rvgen/rvgen}/automata.py (100%)
rename tools/verification/{dot2 => rvgen/rvgen}/dot2c.py (99%)
rename tools/verification/{dot2 => rvgen/rvgen}/dot2k.py (98%)tools/verification/rvgen/Makefile renamed from tools/verification/dot2/Makefile +5 -5
@@ -3,7 +3,7 @@ INSTALL=install prefix ?= /usr bindir ?= $(prefix)/bin mandir ?= $(prefix)/share/man -miscdir ?= $(prefix)/share/dot2 +miscdir ?= $(prefix)/share/rvgen srcdir ?= $(prefix)/src PYLIB ?= $(shell python3 -c 'import sysconfig; print (sysconfig.get_path("purelib"))')
@@ -16,11 +16,11 @@ clean: .PHONY: install install: - $(INSTALL) automata.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/automata.py - $(INSTALL) dot2c.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/dot2c.py + $(INSTALL) rvgen/automata.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/automata.py + $(INSTALL) rvgen/dot2c.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2c.py $(INSTALL) dot2c -D -m 755 $(DESTDIR)$(bindir)/ - $(INSTALL) dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/dot2k.py - $(INSTALL) dot2k -D -m 755 $(DESTDIR)$(bindir)/ + $(INSTALL) rvgen/dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2k.py + $(INSTALL) __main__.py -D -m 755 $(DESTDIR)$(bindir)/rvgen mkdir -p ${miscdir}/ cp -rp dot2k_templates $(DESTDIR)$(miscdir)/
tools/verification/rvgen/__main__.py renamed from tools/verification/dot2/dot2k +13 -5
@@ -9,11 +9,11 @@ # Documentation/trace/rv/da_monitor_synthesis.rst if __name__ == '__main__': - from dot2.dot2k import dot2k + from rvgen.dot2k import dot2k import argparse import sys - parser = argparse.ArgumentParser(description='transform .dot file into kernel rv monitor') + parser = argparse.ArgumentParser(description='Generate kernel rv monitor') parser.add_argument("-D", "--description", dest="description", required=False) parser.add_argument("-a", "--auto_patch", dest="auto_patch", action="store_true", required=False,
@@ -25,7 +25,9 @@ if __name__ == '__main__': monitor_parser.add_argument('-n', "--model_name", dest="model_name") monitor_parser.add_argument("-p", "--parent", dest="parent", required=False, help="Create a monitor nested to parent") - monitor_parser.add_argument('-d', "--dot", dest="dot_file") + monitor_parser.add_argument('-c', "--class", dest="monitor_class", + help="Monitor class, either \"da\" or \"ltl\"") + monitor_parser.add_argument('-s', "--spec", dest="spec", help="Monitor specification file") monitor_parser.add_argument('-t', "--monitor_type", dest="monitor_type", help=f"Available options: {', '.join(dot2k.monitor_types.keys())}")
@@ -36,8 +38,14 @@ if __name__ == '__main__': try: if params.subcmd == "monitor": - print("Opening and parsing the dot file %s" % params.dot_file) - monitor = dot2k(params.dot_file, params.monitor_type, vars(params)) + print("Opening and parsing the specification file %s" % params.spec) + if params.monitor_class == "da": + monitor = dot2k(params.spec, params.monitor_type, vars(params)) + elif params.monitor_class == "ltl": + raise NotImplementedError + else: + print("Unknown monitor class:", params.monitor_class) + sys.exit(1) else: monitor = dot2k(None, None, vars(params)) except Exception as e:
tools/verification/rvgen/dot2c renamed from tools/verification/dot2/dot2c +1 -1
@@ -14,7 +14,7 @@ # Documentation/trace/rv/deterministic_automata.rst if __name__ == '__main__': - from dot2 import dot2c + from rvgen import dot2c import argparse import sys
tools/verification/rvgen/dot2k_templates/Kconfig renamed from tools/verification/dot2/dot2k_templates/Kconfig +0 -0
tools/verification/rvgen/dot2k_templates/Kconfig_container renamed from tools/verification/dot2/dot2k_templates/Kconfig_container +0 -0
tools/verification/rvgen/dot2k_templates/main.c renamed from tools/verification/dot2/dot2k_templates/main.c +0 -0
tools/verification/rvgen/dot2k_templates/main_container.c renamed from tools/verification/dot2/dot2k_templates/main_container.c +0 -0
tools/verification/rvgen/dot2k_templates/main_container.h renamed from tools/verification/dot2/dot2k_templates/main_container.h +0 -0
tools/verification/rvgen/dot2k_templates/trace.h renamed from tools/verification/dot2/dot2k_templates/trace.h +0 -0
tools/verification/rvgen/rvgen/automata.py renamed from tools/verification/dot2/automata.py +0 -0
tools/verification/rvgen/rvgen/dot2c.py renamed from tools/verification/dot2/dot2c.py +1 -1
@@ -13,7 +13,7 @@ # For further information, see: # Documentation/trace/rv/deterministic_automata.rst -from dot2.automata import Automata +from .automata import Automata class Dot2c(Automata): enum_suffix = ""
tools/verification/rvgen/rvgen/dot2k.py renamed from tools/verification/dot2/dot2k.py +5 -5
@@ -8,13 +8,13 @@ # For further information, see: # Documentation/trace/rv/da_monitor_synthesis.rst -from dot2.dot2c import Dot2c +from .dot2c import Dot2c import platform import os class dot2k(Dot2c): monitor_types = { "global" : 1, "per_cpu" : 2, "per_task" : 3 } - monitor_templates_dir = "dot2/dot2k_templates/" + monitor_templates_dir = "rvgen/dot2k_templates/" rv_dir = "kernel/trace/rv" monitor_type = "per_cpu"
@@ -60,14 +60,14 @@ class dot2k(Dot2c): if platform.system() != "Linux": raise OSError("I can only run on Linux.") - kernel_path = "/lib/modules/%s/build/tools/verification/dot2/dot2k_templates/" % (platform.release()) + kernel_path = "/lib/modules/%s/build/tools/verification/rvgen/dot2k_templates/" % (platform.release()) if os.path.exists(kernel_path): self.monitor_templates_dir = kernel_path return - if os.path.exists("/usr/share/dot2/dot2k_templates/"): - self.monitor_templates_dir = "/usr/share/dot2/dot2k_templates/" + if os.path.exists("/usr/share/rvgen/dot2k_templates/"): + self.monitor_templates_dir = "/usr/share/rvgen/dot2k_templates/" return raise FileNotFoundError("Could not find the template directory, do you have the kernel source installed?")
Signature · 1 line
2.39.5
PATCH v10 10/19 Documentation/rv: Prepare monitor synthesis document for LTL inclusion
In reply to Nam CaoMonitor synthesis from deterministic automaton and linear temporal logic have a lot in common. Therefore a single document should describe both.
Change da_monitor_synthesis.rst to monitor_synthesis.rst. LTL monitor synthesis will be added to this file by a follow-up commit.
This makes the diff far easier to read. If renaming and adding LTL info is done in a single commit, git wouldn't recognize it as a rename, but a file removal and a file addition.
While at it, correct the old dot2k commands to the new rvgen commands.
---
Documentation/trace/rv/index.rst | 2 +-
...or_synthesis.rst => monitor_synthesis.rst} | 20 +++++++++----------
2 files changed, 11 insertions(+), 11 deletions(-)
rename Documentation/trace/rv/{da_monitor_synthesis.rst => monitor_synthesis.rst} (92%)Documentation/trace/rv/index.rst +1 -1
@@ -8,7 +8,7 @@ Runtime Verification runtime-verification.rst deterministic_automata.rst - da_monitor_synthesis.rst + monitor_synthesis.rst da_monitor_instrumentation.rst monitor_wip.rst monitor_wwnr.rst
Documentation/trace/rv/monitor_synthesis.rst renamed from Documentation/trace/rv/da_monitor_synthesis.rst +10 -10
@@ -1,5 +1,5 @@ -Deterministic Automata Monitor Synthesis -======================================== +Runtime Verification Monitor Synthesis +====================================== The starting point for the application of runtime verification (RV) techniques is the *specification* or *modeling* of the desired (or undesired) behavior
@@ -36,24 +36,24 @@ below:: | +----> panic ? +-------> <user-specified> -DA monitor synthesis +RV monitor synthesis -------------------- The synthesis of automata-based models into the Linux *RV monitor* abstraction -is automated by the dot2k tool and the rv/da_monitor.h header file that +is automated by the rvgen tool and the rv/da_monitor.h header file that contains a set of macros that automatically generate the monitor's code. -dot2k +rvgen ----- -The dot2k utility leverages dot2c by converting an automaton model in +The rvgen utility leverages dot2c by converting an automaton model in the DOT format into the C representation [1] and creating the skeleton of a kernel monitor in C. For example, it is possible to transform the wip.dot model present in [1] into a per-cpu monitor with the following command:: - $ dot2k -d wip.dot -t per_cpu + $ rvgen monitor -c da -s wip.dot -t per_cpu This will create a directory named wip/ with the following files:
@@ -87,7 +87,7 @@ the second for monitors with per-cpu instances, and the third with per-task instances. In all cases, the 'name' argument is a string that identifies the monitor, and -the 'type' argument is the data type used by dot2k on the representation of +the 'type' argument is the data type used by rvgen on the representation of the model in C. For example, the wip model with two states and three events can be
@@ -134,7 +134,7 @@ Final remarks ------------- With the monitor synthesis in place using the rv/da_monitor.h and -dot2k, the developer's work should be limited to the instrumentation +rvgen, the developer's work should be limited to the instrumentation of the system, increasing the confidence in the overall approach. [1] For details about deterministic automata format and the translation
@@ -142,6 +142,6 @@ from one representation to another, see:: Documentation/trace/rv/deterministic_automata.rst -[2] dot2k appends the monitor's name suffix to the events enums to +[2] rvgen appends the monitor's name suffix to the events enums to avoid conflicting variables when exporting the global vmlinux.h use by BPF programs.
Signature · 1 line
2.39.5
PATCH v10 11/19 verification/rvgen: Restructure the templates files
In reply to Nam CaoTo simply the scripts and to allow easy integration of new monitor types, restructure the template files as followed:
1. Move the template files to be in the same directory as the rvgen package. Furthermore, the installation will now only install the templates to the package directory, not /usr/share/. This simplify templates reading, as the scripts do not need to find the templates at multiple places.
2. Move dot2k_templates/* to:
- templates/dot2k/
- templates/container/
This allows sharing templates reading code between DA monitor generation and container generation (and any future generation type).
For template files which can be shared between different generation types, support putting them in templates/
This restructure aligns with the recommendation from:
https://python-packaging.readthedocs.io/en/latest/non-code-files.html
---
tools/verification/rvgen/Makefile | 5 +-
tools/verification/rvgen/rvgen/dot2k.py | 47 ++++++++-----------
.../templates}/Kconfig | 0
.../templates/container/Kconfig} | 0
.../templates/container/main.c} | 0
.../templates/container/main.h} | 0
.../templates/dot2k}/main.c | 0
.../templates/dot2k}/trace.h | 0
8 files changed, 20 insertions(+), 32 deletions(-)
rename tools/verification/rvgen/{dot2k_templates => rvgen/templates}/Kconfig (100%)
rename tools/verification/rvgen/{dot2k_templates/Kconfig_container => rvgen/templates/container/Kconfig} (100%)
rename tools/verification/rvgen/{dot2k_templates/main_container.c => rvgen/templates/container/main.c} (100%)
rename tools/verification/rvgen/{dot2k_templates/main_container.h => rvgen/templates/container/main.h} (100%)
rename tools/verification/rvgen/{dot2k_templates => rvgen/templates/dot2k}/main.c (100%)
rename tools/verification/rvgen/{dot2k_templates => rvgen/templates/dot2k}/trace.h (100%)tools/verification/rvgen/Makefile +1 -4
@@ -3,7 +3,6 @@ INSTALL=install prefix ?= /usr bindir ?= $(prefix)/bin mandir ?= $(prefix)/share/man -miscdir ?= $(prefix)/share/rvgen srcdir ?= $(prefix)/src PYLIB ?= $(shell python3 -c 'import sysconfig; print (sysconfig.get_path("purelib"))')
@@ -21,6 +20,4 @@ install: $(INSTALL) dot2c -D -m 755 $(DESTDIR)$(bindir)/ $(INSTALL) rvgen/dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2k.py $(INSTALL) __main__.py -D -m 755 $(DESTDIR)$(bindir)/rvgen - - mkdir -p ${miscdir}/ - cp -rp dot2k_templates $(DESTDIR)$(miscdir)/ + cp -rp rvgen/templates $(DESTDIR)$(PYLIB)/rvgen/
tools/verification/rvgen/rvgen/dot2k.py +19 -28
83 lines not on this page · raw message
tools/verification/rvgen/rvgen/templates/Kconfig renamed from tools/verification/rvgen/dot2k_templates/Kconfig +0 -0
tools/verification/rvgen/rvgen/templates/container/Kconfig renamed from tools/verification/rvgen/dot2k_templates/Kconfig_container +0 -0
tools/verification/rvgen/rvgen/templates/container/main.c renamed from tools/verification/rvgen/dot2k_templates/main_container.c +0 -0
tools/verification/rvgen/rvgen/templates/container/main.h renamed from tools/verification/rvgen/dot2k_templates/main_container.h +0 -0
tools/verification/rvgen/rvgen/templates/dot2k/main.c renamed from tools/verification/rvgen/dot2k_templates/main.c +0 -0
tools/verification/rvgen/rvgen/templates/dot2k/trace.h renamed from tools/verification/rvgen/dot2k_templates/trace.h +0 -0
Signature · 1 line
2.39.5
PATCH v10 12/19 verification/rvgen: Restructure the classes to prepare for LTL inclusion
In reply to Nam CaoBoth container generation and DA monitor generation is implemented in the class dot2k. That requires some ugly "if is_container ... else ...". If linear temporal logic support is added at the current state, the "if else" chain is longer and uglier.
Furthermore, container generation is irrevelant to .dot files. It is therefore illogical to be implemented in class "dot2k".
Clean it up, restructure the dot2k class into the following class hierarchy:
(RVGenerator)
/\
/ \
/ \
/ \
/ \
(Container) (Monitor)
/\
/ \
/ \
/ \
(dot2k) [ltl2k] <- intendedThis allows a simple and clean integration of LTL.
--- tools/verification/rvgen/Makefile | 2 + tools/verification/rvgen/__main__.py | 6 +- tools/verification/rvgen/rvgen/container.py | 22 ++ tools/verification/rvgen/rvgen/dot2k.py | 275 ++------------------ tools/verification/rvgen/rvgen/generator.py | 264 +++++++++++++++++++ 5 files changed, 308 insertions(+), 261 deletions(-) create mode 100644 tools/verification/rvgen/rvgen/container.py create mode 100644 tools/verification/rvgen/rvgen/generator.py
tools/verification/rvgen/Makefile +2 -0
@@ -19,5 +19,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/container.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/container.py + $(INSTALL) rvgen/generator.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/generator.py $(INSTALL) __main__.py -D -m 755 $(DESTDIR)$(bindir)/rvgen cp -rp rvgen/templates $(DESTDIR)$(PYLIB)/rvgen/
tools/verification/rvgen/__main__.py +4 -2
@@ -10,6 +10,8 @@ if __name__ == '__main__': from rvgen.dot2k import dot2k + from rvgen.generator import Monitor + from rvgen.container import Container import argparse import sys
@@ -29,7 +31,7 @@ if __name__ == '__main__': help="Monitor class, either \"da\" or \"ltl\"") monitor_parser.add_argument('-s', "--spec", dest="spec", help="Monitor specification file") monitor_parser.add_argument('-t', "--monitor_type", dest="monitor_type", - help=f"Available options: {', '.join(dot2k.monitor_types.keys())}") + help=f"Available options: {', '.join(Monitor.monitor_types.keys())}") container_parser = subparsers.add_parser("container") container_parser.add_argument('-n', "--model_name", dest="model_name", required=True)
@@ -47,7 +49,7 @@ if __name__ == '__main__': print("Unknown monitor class:", params.monitor_class) sys.exit(1) else: - monitor = dot2k(None, None, vars(params)) + monitor = Container(vars(params)) except Exception as e: print('Error: '+ str(e)) print("Sorry : :-(")
tools/verification/rvgen/rvgen/container.py new file +22 -0
@@ -0,0 +1,22 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0-only +# +# Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <[email protected]> +# +# Generator for runtime verification monitor container + +from . import generator + + +class Container(generator.RVGenerator): + template_dir = "container" + + def __init__(self, extra_params={}): + super().__init__(extra_params) + self.name = extra_params.get("model_name") + self.main_h = self._read_template_file("main.h") + + def fill_model_h(self): + main_h = self.main_h + main_h = main_h.replace("%%MODEL_NAME%%", self.name) + return main_h
tools/verification/rvgen/rvgen/dot2k.py +16 -259
301 lines not on this page · raw message
tools/verification/rvgen/rvgen/generator.py new file +264 -0
264 lines not on this page · raw message
Signature · 1 line
2.39.5
PATCH v10 13/19 Add support for LTL monitors
In reply to Nam CaoWhile attempting to implement DA monitors for some complex specifications, deterministic automaton is found to be inappropriate as the specification language. The automaton is complicated, hard to understand, and error-prone.
For these cases, linear temporal logic is more suitable as the specification language.
Add support for linear temporal logic runtime verification monitor.
For all the details, see the documentations added by this commit.
--- Documentation/trace/rv/index.rst | 1 + .../trace/rv/linear_temporal_logic.rst | 122 ++++ Documentation/trace/rv/monitor_synthesis.rst | 141 ++++- include/linux/rv.h | 62 +- include/rv/ltl_monitor.h | 184 ++++++ kernel/fork.c | 5 +- kernel/trace/rv/Kconfig | 7 + kernel/trace/rv/rv_trace.h | 47 ++ tools/verification/rvgen/.gitignore | 3 + tools/verification/rvgen/Makefile | 2 + tools/verification/rvgen/__main__.py | 3 +- tools/verification/rvgen/rvgen/ltl2ba.py | 540 ++++++++++++++++++ tools/verification/rvgen/rvgen/ltl2k.py | 245 ++++++++ .../rvgen/rvgen/templates/ltl2k/main.c | 102 ++++ .../rvgen/rvgen/templates/ltl2k/trace.h | 14 + 15 files changed, 1453 insertions(+), 25 deletions(-) create mode 100644 Documentation/trace/rv/linear_temporal_logic.rst create mode 100644 include/rv/ltl_monitor.h create mode 100644 tools/verification/rvgen/.gitignore create mode 100644 tools/verification/rvgen/rvgen/ltl2ba.py create mode 100644 tools/verification/rvgen/rvgen/ltl2k.py create mode 100644 tools/verification/rvgen/rvgen/templates/ltl2k/main.c create mode 100644 tools/verification/rvgen/rvgen/templates/ltl2k/trace.h
Documentation/trace/rv/index.rst +1 -0
@@ -8,6 +8,7 @@ Runtime Verification runtime-verification.rst deterministic_automata.rst + linear_temporal_logic.rst monitor_synthesis.rst da_monitor_instrumentation.rst monitor_wip.rst
Documentation/trace/rv/linear_temporal_logic.rst new file +122 -0
122 lines not on this page · raw message
Documentation/trace/rv/monitor_synthesis.rst +125 -16
169 lines not on this page · raw message
include/linux/rv.h +58 -4
81 lines not on this page · raw message
include/rv/ltl_monitor.h new file +184 -0
184 lines not on this page · raw message
kernel/fork.c +1 -4
@@ -1886,10 +1886,7 @@ static void copy_oom_score_adj(u64 clone_flags, struct task_struct *tsk)#ifdef CONFIG_RV static void rv_task_fork (struct task_struct *p) { -int i; - -for (i =0 ; i <RV_PER_TASK_MONITORS ; i++) - p->rv[i].da_mon.monitoring = false; +memset (p->rv,0 ,sizeof (p->rv)); }#else #define rv_task_fork (p) do {} while (0)
kernel/trace/rv/Kconfig +7 -0
@@ -11,6 +11,13 @@ config DA_MON_EVENTS_ID select RV_MON_EVENTS bool +config LTL_MON_EVENTS_ID + select RV_MON_EVENTS + bool + +config RV_LTL_MONITOR + bool + menuconfig RV bool "Runtime Verification" depends on TRACING
kernel/trace/rv/rv_trace.h +47 -0
53 lines not on this page · raw message
tools/verification/rvgen/.gitignore new file +3 -0
@@ -0,0 +1,3 @@ +__pycache__/ +parser.out +parsetab.py
tools/verification/rvgen/Makefile +2 -0
@@ -21,5 +21,7 @@ install: $(INSTALL) rvgen/dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2k.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 + $(INSTALL) rvgen/ltl2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/ltl2k.py $(INSTALL) __main__.py -D -m 755 $(DESTDIR)$(bindir)/rvgen cp -rp rvgen/templates $(DESTDIR)$(PYLIB)/rvgen/
tools/verification/rvgen/__main__.py +2 -1
@@ -12,6 +12,7 @@ if __name__ == '__main__': from rvgen.dot2k import dot2k from rvgen.generator import Monitor from rvgen.container import Container + from rvgen.ltl2k import ltl2k import argparse import sys
@@ -44,7 +45,7 @@ if __name__ == '__main__': if params.monitor_class == "da": monitor = dot2k(params.spec, params.monitor_type, vars(params)) elif params.monitor_class == "ltl": - raise NotImplementedError + monitor = ltl2k(params.spec, params.monitor_type, vars(params)) else: print("Unknown monitor class:", params.monitor_class) sys.exit(1)
tools/verification/rvgen/rvgen/ltl2ba.py new file +540 -0
540 lines not on this page · raw message
tools/verification/rvgen/rvgen/ltl2k.py new file +245 -0
245 lines not on this page · raw message
tools/verification/rvgen/rvgen/templates/ltl2k/main.c new file +102 -0
102 lines not on this page · raw message
tools/verification/rvgen/rvgen/templates/ltl2k/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_%%MODEL_NAME_UP%% +DEFINE_EVENT(event_%%MONITOR_CLASS%%, event_%%MODEL_NAME%%, + TP_PROTO(struct task_struct *task, char *states, char *atoms, char *next), +TP_ARGS (task, states, atoms, next)); +DEFINE_EVENT(error_%%MONITOR_CLASS%%, error_%%MODEL_NAME%%, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_%%MODEL_NAME_UP%% */
Signature · 1 line
2.39.5
PATCH v10 14/19 Add rtapp container monitor
In reply to Nam CaoAdd the container "rtapp" which is the monitor collection for detecting problems with real-time applications. The monitors will be added in the follow-up commits.
--- kernel/trace/rv/Kconfig | 1 + kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/rtapp/Kconfig | 14 +++++++++++ kernel/trace/rv/monitors/rtapp/rtapp.c | 33 ++++++++++++++++++++++++++ kernel/trace/rv/monitors/rtapp/rtapp.h | 3 +++ 5 files changed, 52 insertions(+) create mode 100644 kernel/trace/rv/monitors/rtapp/Kconfig create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.c create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.h
kernel/trace/rv/Kconfig +1 -0
@@ -41,6 +41,7 @@ source "kernel/trace/rv/monitors/snroc/Kconfig" source "kernel/trace/rv/monitors/scpd/Kconfig" source "kernel/trace/rv/monitors/snep/Kconfig" source "kernel/trace/rv/monitors/sncid/Kconfig" +source "kernel/trace/rv/monitors/rtapp/Kconfig" # Add new monitors here config RV_REACTORS
kernel/trace/rv/Makefile +1 -0
@@ -12,6 +12,7 @@ obj-$(CONFIG_RV_MON_SNROC) += monitors/snroc/snroc.o obj-$(CONFIG_RV_MON_SCPD) += monitors/scpd/scpd.o obj-$(CONFIG_RV_MON_SNEP) += monitors/snep/snep.o obj-$(CONFIG_RV_MON_SNCID) += monitors/sncid/sncid.o +obj-$(CONFIG_RV_MON_RTAPP) += monitors/rtapp/rtapp.o # Add new monitors here obj-$(CONFIG_RV_REACTORS) += rv_reactors.o obj-$(CONFIG_RV_REACT_PRINTK) += reactor_printk.o
kernel/trace/rv/monitors/rtapp/Kconfig new file +14 -0
@@ -0,0 +1,14 @@ +config RV_MON_RTAPP + depends on RV + bool "rtapp monitor" + help + Collection of monitors to check for common problems with real-time + application that may cause unexpected latency. + + If you are developing a real-time system and not entirely sure whether + the applications are designed correctly for real-time, you want to say + Y here. + + Beware that enabling this may have impact on performance, even if the + monitors are not running. Therefore you probably should say N for + production kernel.
kernel/trace/rv/monitors/rtapp/rtapp.c new file +33 -0
@@ -0,0 +1,33 @@ +// 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 "rtapp" + +#include "rtapp.h" + +struct rv_monitor rv_rtapp; + +struct rv_monitor rv_rtapp = { + .name ="rtapp" , + .description ="Collection of monitors for detecting problems with real-time applications" , +}; + +static int __init register_rtapp (void ) +{ +return rv_register_monitor (&rv_rtapp,NULL ); +} + +static void __exit unregister_rtapp(void) +{ +rv_unregister_monitor (&rv_rtapp); +} + +module_init (register_rtapp); +module_exit (unregister_rtapp); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("Nam Cao <[email protected]>" ); +MODULE_DESCRIPTION ("Collection of monitors for detecting problems with real-time applications" );
kernel/trace/rv/monitors/rtapp/rtapp.h new file +3 -0
@@ -0,0 +1,3 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +extern struct rv_monitor rv_rtapp;
Signature · 1 line
2.39.5
PATCH v10 15/19 riscv: mm: Add page fault trace points
In reply to Nam CaoAdd page fault trace points, which are useful to implement RV monitor that watches page faults.
---
Cc: Paul Walmsley <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Cc: Albert Ou <[email protected]>
Cc: [email protected]
--- arch/riscv/mm/fault.c | 8 ++++++++ 1 file changed, 8 insertions(+)
arch/riscv/mm/fault.c +8 -0
@@ -20,6 +20,9 @@#include <asm/ptrace.h> #include <asm/tlbflush.h> +#define CREATE_TRACE_POINTS +#include <trace/events/exceptions.h> +#include "../kernel/head.h" static void show_pte (unsigned long addr)
@@ -291,6 +294,11 @@ void handle_page_fault(struct pt_regs *regs)if (kprobe_page_fault (regs, cause))return ; +if (user_mode (regs)) +trace_page_fault_user (addr, regs, cause); +else +trace_page_fault_kernel (addr, regs, cause); +/* * Fault-in kernel-space virtual memory on-demand. * The 'reference' page table is init_mm.pgd.
Signature · 1 line
2.39.5
PATCH v10 16/19 Add rtapp_pagefault monitor
In reply to Nam CaoUserspace real-time applications may have design flaws that they raise page faults in real-time threads, and thus have unexpected latencies.
Add an linear temporal logic monitor to detect this scenario.
--- kernel/trace/rv/Kconfig | 1 + kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/pagefault/Kconfig | 20 +++++ .../trace/rv/monitors/pagefault/pagefault.c | 87 +++++++++++++++++++ .../trace/rv/monitors/pagefault/pagefault.h | 57 ++++++++++++ .../rv/monitors/pagefault/pagefault_trace.h | 14 +++ kernel/trace/rv/rv_trace.h | 1 + tools/verification/models/rtapp/pagefault.ltl | 1 + 8 files changed, 182 insertions(+) create mode 100644 kernel/trace/rv/monitors/pagefault/Kconfig create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault.c create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault.h create mode 100644 kernel/trace/rv/monitors/pagefault/pagefault_trace.h create mode 100644 tools/verification/models/rtapp/pagefault.ltl
kernel/trace/rv/Kconfig +1 -0
@@ -42,6 +42,7 @@ source "kernel/trace/rv/monitors/scpd/Kconfig" source "kernel/trace/rv/monitors/snep/Kconfig" source "kernel/trace/rv/monitors/sncid/Kconfig" source "kernel/trace/rv/monitors/rtapp/Kconfig" +source "kernel/trace/rv/monitors/pagefault/Kconfig" # Add new monitors here config RV_REACTORS
kernel/trace/rv/Makefile +1 -0
@@ -13,6 +13,7 @@ obj-$(CONFIG_RV_MON_SCPD) += monitors/scpd/scpd.o obj-$(CONFIG_RV_MON_SNEP) += monitors/snep/snep.o obj-$(CONFIG_RV_MON_SNCID) += monitors/sncid/sncid.o obj-$(CONFIG_RV_MON_RTAPP) += monitors/rtapp/rtapp.o +obj-$(CONFIG_RV_MON_PAGEFAULT) += monitors/pagefault/pagefault.o # Add new monitors here obj-$(CONFIG_RV_REACTORS) += rv_reactors.o obj-$(CONFIG_RV_REACT_PRINTK) += reactor_printk.o
kernel/trace/rv/monitors/pagefault/Kconfig new file +20 -0
@@ -0,0 +1,20 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_PAGEFAULT + depends on RV + select RV_LTL_MONITOR + depends on RV_MON_RTAPP + depends on X86 || RISCV + default y + select LTL_MON_EVENTS_ID + bool "pagefault monitor" + help + Monitor that real-time tasks do not raise page faults, causing + undesirable latency. + + If you are developing a real-time system and not entirely sure whether + the applications are designed correctly for real-time, you want to say + Y here. + + This monitor does not affect execution speed while it is not running, + therefore it is safe to enable this in production kernel.
kernel/trace/rv/monitors/pagefault/pagefault.c new file +87 -0
87 lines not on this page · raw message
kernel/trace/rv/monitors/pagefault/pagefault.h new file +57 -0
57 lines not on this page · raw message
kernel/trace/rv/monitors/pagefault/pagefault_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_PAGEFAULT +DEFINE_EVENT (event_ltl_monitor_id, event_pagefault, + 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_pagefault, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_PAGEFAULT */
kernel/trace/rv/rv_trace.h +1 -0
@@ -172,6 +172,7 @@ DECLARE_EVENT_CLASS(error_ltl_monitor_id,TP_printk ("%s[%d]: violation detected" ,__get_str (comm), __entry->pid) ); +#include <monitors/pagefault/pagefault_trace.h> // Add new monitors based on CONFIG_LTL_MON_EVENTS_ID here #endif /* CONFIG_LTL_MON_EVENTS_ID */ #endif /* _TRACE_RV_H */
tools/verification/models/rtapp/pagefault.ltl new file +1 -0
@@ -0,0 +1 @@ +RULE = always (RT imply not PAGEFAULT)
Signature · 1 line
2.39.5
PATCH v10 17/19 Add rtapp_sleep monitor
In reply to Nam CaoAdd a monitor for checking that real-time tasks do not go to sleep in a manner that may cause undesirable latency.
Also change
RV depends on TRACING
to
RV select TRACING
to avoid the following recursive dependency:
error: recursive dependency detected!
symbol TRACING is selected by PREEMPTIRQ_TRACEPOINTS symbol PREEMPTIRQ_TRACEPOINTS depends on TRACE_IRQFLAGS symbol TRACE_IRQFLAGS is selected by RV_MON_SLEEP symbol RV_MON_SLEEP depends on RV
symbol RV depends on TRACING
--- kernel/trace/rv/Kconfig | 3 +- kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/sleep/Kconfig | 22 ++ kernel/trace/rv/monitors/sleep/sleep.c | 236 +++++++++++++++++ kernel/trace/rv/monitors/sleep/sleep.h | 250 +++++++++++++++++++ kernel/trace/rv/monitors/sleep/sleep_trace.h | 14 ++ kernel/trace/rv/rv_trace.h | 1 + tools/verification/models/rtapp/sleep.ltl | 22 ++ 8 files changed, 548 insertions(+), 1 deletion(-) create mode 100644 kernel/trace/rv/monitors/sleep/Kconfig create mode 100644 kernel/trace/rv/monitors/sleep/sleep.c create mode 100644 kernel/trace/rv/monitors/sleep/sleep.h create mode 100644 kernel/trace/rv/monitors/sleep/sleep_trace.h create mode 100644 tools/verification/models/rtapp/sleep.ltl
kernel/trace/rv/Kconfig +2 -1
@@ -20,7 +20,7 @@ config RV_LTL_MONITOR menuconfig RV bool "Runtime Verification" - depends on TRACING + select TRACING help Enable the kernel runtime verification infrastructure. RV is a lightweight (yet rigorous) method that complements classical
@@ -43,6 +43,7 @@ source "kernel/trace/rv/monitors/snep/Kconfig" source "kernel/trace/rv/monitors/sncid/Kconfig" source "kernel/trace/rv/monitors/rtapp/Kconfig" source "kernel/trace/rv/monitors/pagefault/Kconfig" +source "kernel/trace/rv/monitors/sleep/Kconfig" # Add new monitors here config RV_REACTORS
kernel/trace/rv/Makefile +1 -0
@@ -14,6 +14,7 @@ obj-$(CONFIG_RV_MON_SNEP) += monitors/snep/snep.o obj-$(CONFIG_RV_MON_SNCID) += monitors/sncid/sncid.o obj-$(CONFIG_RV_MON_RTAPP) += monitors/rtapp/rtapp.o obj-$(CONFIG_RV_MON_PAGEFAULT) += monitors/pagefault/pagefault.o +obj-$(CONFIG_RV_MON_SLEEP) += monitors/sleep/sleep.o # Add new monitors here obj-$(CONFIG_RV_REACTORS) += rv_reactors.o obj-$(CONFIG_RV_REACT_PRINTK) += reactor_printk.o
kernel/trace/rv/monitors/sleep/Kconfig new file +22 -0
@@ -0,0 +1,22 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +config RV_MON_SLEEP + depends on RV + select RV_LTL_MONITOR + depends on HAVE_SYSCALL_TRACEPOINTS + depends on RV_MON_RTAPP + select TRACE_IRQFLAGS + default y + select LTL_MON_EVENTS_ID + bool "sleep monitor" + help + Monitor that real-time tasks do not sleep in a manner that may + cause undesirable latency. + + If you are developing a real-time system and not entirely sure whether + the applications are designed correctly for real-time, you want to say + Y here. + + Enabling this monitor may have performance impact (due to select + TRACE_IRQFLAGS). Therefore, you probably should say N for + production kernel.
kernel/trace/rv/monitors/sleep/sleep.c new file +236 -0
236 lines not on this page · raw message
kernel/trace/rv/monitors/sleep/sleep.h new file +250 -0
250 lines not on this page · raw message
kernel/trace/rv/monitors/sleep/sleep_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_SLEEP +DEFINE_EVENT (event_ltl_monitor_id, event_sleep, + 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_sleep, + TP_PROTO(struct task_struct *task), +TP_ARGS (task)); +#endif /* CONFIG_RV_MON_SLEEP */
kernel/trace/rv/rv_trace.h +1 -0
@@ -173,6 +173,7 @@ DECLARE_EVENT_CLASS(error_ltl_monitor_id,TP_printk ("%s[%d]: violation detected" ,__get_str (comm), __entry->pid) );#include <monitors/pagefault/pagefault_trace.h> +#include <monitors/sleep/sleep_trace.h> // Add new monitors based on CONFIG_LTL_MON_EVENTS_ID here #endif /* CONFIG_LTL_MON_EVENTS_ID */ #endif /* _TRACE_RV_H */
tools/verification/models/rtapp/sleep.ltl new file +22 -0
@@ -0,0 +1,22 @@ +RULE = always ((RT and SLEEP) imply (RT_FRIENDLY_SLEEP or ALLOWLIST)) + +RT_FRIENDLY_SLEEP = (RT_VALID_SLEEP_REASON or KERNEL_THREAD) + and ((not WAKE) until RT_FRIENDLY_WAKE) + +RT_VALID_SLEEP_REASON = FUTEX_WAIT + or RT_FRIENDLY_NANOSLEEP + +RT_FRIENDLY_NANOSLEEP = CLOCK_NANOSLEEP + and NANOSLEEP_TIMER_ABSTIME + and (NANOSLEEP_CLOCK_MONOTONIC or NANOSLEEP_CLOCK_TAI) + +RT_FRIENDLY_WAKE = WOKEN_BY_EQUAL_OR_HIGHER_PRIO + or WOKEN_BY_HARDIRQ + or WOKEN_BY_NMI + or ABORT_SLEEP + or KTHREAD_SHOULD_STOP + +ALLOWLIST = BLOCK_ON_RT_MUTEX + or FUTEX_LOCK_PI + or TASK_IS_RCU + or TASK_IS_MIGRATION
Signature · 1 line
2.39.5
PATCH v10 18/19 Add documentation for rtapp monitor
In reply to Nam CaoAdd documentation describing the rtapp monitor.
--- Documentation/trace/rv/index.rst | 1 + Documentation/trace/rv/monitor_rtapp.rst | 116 +++++++++++++++++++++++ 2 files changed, 117 insertions(+) create mode 100644 Documentation/trace/rv/monitor_rtapp.rst
Documentation/trace/rv/index.rst +1 -0
@@ -14,3 +14,4 @@ Runtime Verification monitor_wip.rst monitor_wwnr.rst monitor_sched.rst + monitor_rtapp.rst
Documentation/trace/rv/monitor_rtapp.rst new file +116 -0
116 lines not on this page · raw message
Signature · 1 line
2.39.5
PATCH v10 19/19 Allow to configure the number of per-task monitor
In reply to Nam CaoNow that there are 2 monitors for real-time applications, users may want to enable both of them simultaneously. Make the number of per-task monitor configurable. Default it to 2 for now.
--- include/linux/rv.h | 9 +-------- include/linux/sched.h | 8 +++----- kernel/trace/rv/Kconfig | 9 +++++++++ kernel/trace/rv/monitors/rtapp/Kconfig | 1 + kernel/trace/rv/rv.c | 8 ++++---- 5 files changed, 18 insertions(+), 17 deletions(-)
include/linux/rv.h +1 -8
@@ -74,14 +74,7 @@ struct ltl_monitor {};#endif /* CONFIG_RV_LTL_MONITOR */ -/* -* Per-task RV monitors count. Nowadays fixed in RV_PER_TASK_MONITORS. -* If we find justification for more monitors, we can think about -* adding more or developing a dynamic method. So far, none of -* these are justified. -*/ -#define RV_PER_TASK_MONITORS 1 -#define RV_PER_TASK_MONITOR_INIT (RV_PER_TASK_MONITORS) +#define RV_PER_TASK_MONITOR_INIT (CONFIG_RV_PER_TASK_MONITORS)union rv_task_monitor {struct da_monitor da_mon;
include/linux/sched.h +3 -5
@@ -1642,12 +1642,10 @@ struct task_struct {#ifdef CONFIG_RV /* -* Per-task RV monitor. Nowadays fixed in RV_PER_TASK_MONITORS. -* If we find justification for more monitors, we can think -* about adding more or developing a dynamic method. So far, -* none of these are justified. +* Per-task RV monitor, fixed in CONFIG_RV_PER_TASK_MONITORS. +* If memory becomes a concern, we can think about a dynamic method. */ -union rv_task_monitor rv[RV_PER_TASK_MONITORS ]; +union rv_task_monitor rv[CONFIG_RV_PER_TASK_MONITORS ];#endif #ifdef CONFIG_USER_EVENTS
kernel/trace/rv/Kconfig +9 -0
@@ -32,6 +32,15 @@ menuconfig RV For further information, see: Documentation/trace/rv/runtime-verification.rst +config RV_PER_TASK_MONITORS + int "Maximum number of per-task monitor" + depends on RV + range 1 8 + default 2 + help + This option configures the maximum number of per-task RV monitors that can run + simultaneously. + source "kernel/trace/rv/monitors/wip/Kconfig" source "kernel/trace/rv/monitors/wwnr/Kconfig" source "kernel/trace/rv/monitors/sched/Kconfig"
kernel/trace/rv/monitors/rtapp/Kconfig +1 -0
@@ -1,5 +1,6 @@ config RV_MON_RTAPP depends on RV + depends on RV_PER_TASK_MONITORS >= 2 bool "rtapp monitor" help Collection of monitors to check for common problems with real-time
kernel/trace/rv/rv.c +4 -4
@@ -165,7 +165,7 @@ struct dentry *get_monitors_root(void)LIST_HEAD (rv_monitors_list);static int task_monitor_count; -static bool task_monitor_slots[RV_PER_TASK_MONITORS ]; +static bool task_monitor_slots[CONFIG_RV_PER_TASK_MONITORS ];int rv_get_task_monitor_slot (void ) {
@@ -173,12 +173,12 @@ int rv_get_task_monitor_slot(void)lockdep_assert_held (&rv_interface_lock); -if (task_monitor_count ==RV_PER_TASK_MONITORS ) +if (task_monitor_count ==CONFIG_RV_PER_TASK_MONITORS )return -EBUSY ; task_monitor_count++; -for (i =0 ; i <RV_PER_TASK_MONITORS ; i++) { +for (i =0 ; i <CONFIG_RV_PER_TASK_MONITORS ; i++) {if (task_monitor_slots[i] == false) { task_monitor_slots[i] = true;return i;
@@ -194,7 +194,7 @@ void rv_put_task_monitor_slot(int slot) {lockdep_assert_held (&rv_interface_lock); -if (slot <0 || slot >=RV_PER_TASK_MONITORS ) { +if (slot <0 || slot >=CONFIG_RV_PER_TASK_MONITORS ) {WARN_ONCE (1 ,"RV releasing an invalid slot!: %d\n" , slot);return ; }
Signature · 1 line
2.39.5
Re: [PATCH v10 15/19] riscv: mm: Add page fault trace points
In reply to Nam CaoQuoted 5 lines · On Tue, 10 Jun 2025 02:43:40 PDT (-0700), [email protected] wrote:
Add page fault trace points, which are useful to implement RV monitor that watches page faults.
Signed-off-by Nam Cao <[email protected]>Acked-by Alexandre Ghiti <[email protected]>
Sorry if you were waiting on me. I'm assuming you want to keep these together.
Hi Steven,
Quoted 9 lines · Nam Cao
Real-time applications may have design flaws causing them to have unexpected latency. For example, the applications may raise page faults, or may be blocked trying to take a mutex without priority inheritance.
However, while attempting to implement DA monitors for these real-time rules, deterministic automaton is found to be inappropriate as the specification language. The automaton is complicated, hard to understand, and error-prone.
Quoted 5 lines
For these cases, linear temporal logic is found to be more suitable. The LTL is more concise and intuitive.
This series adds support for LTL RV monitor, and use it to implement two monitors for reporting problems with real-time tasks.
Is there any chance this series could be applied soon? I have some more patches which depend on this series, so it is holding up the show. I think Gabriele needs this applied for his patches as well.
Best regards,
Nam
Steven Rostedt
maintainerQuoted 3 lines · On Fri, 27 Jun 2025 14:42:48 +0200 Nam Cao <[email protected]> wrote:
Is there any chance this series could be applied soon? I have some more patches which depend on this series, so it is holding up the show. I think Gabriele needs this applied for his patches as well.
I'll try to take a look at these today.
Thanks,
-- Steve
Quoted 8 lines · Steven Rostedt
Quoted 3 lines · On Fri, 27 Jun 2025 14:42:48 +0200 Nam Cao <[email protected]> wrote:
Is there any chance this series could be applied soon? I have some more patches which depend on this series, so it is holding up the show. I think Gabriele needs this applied for his patches as well.
I'll try to take a look at these today.
Thanks!
Nam
Steven Rostedt
maintainerRe: [PATCH v10 13/19] rv: Add support for LTL monitors
In reply to Nam CaoQuoted 10 lines · On Tue, 10 Jun 2025 11:43:38 +0200 Nam Cao <[email protected]> wrote:
Documentation/trace/rv/linear_temporal_logic.rst new file +4
-0@@ -0,0 +1,122 @@ +Linear temporal logic +===================== + +Introduction
Documentation/trace/rv/linear_temporal_logic.rst line 14
Quoted 10 lines
Documentation/trace/rv/linear_temporal_logic.rst new file +10
-0+------------ + +Runtime verification monitor is a verification technique which checks that the kernel follows a +specification. It does so by using tracepoints to monitor the kernel's execution trace, and +verifying that the execution trace sastifies the specification. + +Initially, the specification can only be written in the form of deterministic automaton (DA). +However, while attempting to implement DA monitors for some complex specifications, deterministic +automaton is found to be inappropriate as the specification language. The automaton is complicated, +hard to understand, and error-prone.
The lines in this file are unnecessarily long. Can you keep them at a max of 80 characters? This isn't a hard limit. For examples and where it makes sense to break that limit if it makes the output more readable, then by all means, break the 80 char limit. But There's a lot of places here that break that limit for no reason. As I get older, it becomes harder to read long lines.
Quoted 14 lines
include/linux/rv.h +4
-0@@ -10,6 +10,10 @@#define MAX_DA_NAME_LEN 32#ifdef CONFIG_RV +#include <linux/bitops.h> +#include <linux/types.h> +#include <linux/array_size.h> +/* * Deterministic automaton per-object variables. */
include/linux/rv.h struct da_monitor { · line 29
Quoted 8 lines
include/linux/rv.h +5
-0@@ -18,6 +22,58 @@ struct da_monitor {unsigned int curr_state; }; +#ifdef CONFIG_RV_LTL_MONITOR + +/* +* In the future, if the number of atomic propositions or the size of Buchi automaton is larger, we +* can switch to dynamic allocation. For now, the code is simpler this way.
Same for the comments in the code.
Quoted 87 lines
include/linux/rv.h +49
-4+*/ +#define RV_MAX_LTL_ATOM 32 +#define RV_MAX_BA_STATES 32 + +/** +* struct ltl_monitor - A linear temporal logic runtime verification monitor +* @states: States in the Buchi automaton. As Buchi automaton is a +* non-deterministic state machine, the monitor can be in multiple states +* simultaneously. This is a bitmask of all possible states. +* If this is zero, that means either: +* - The monitor has not started yet (e.g. because not all atomic propositions are +* known). +* - there is no possible state to be in. In other words, a violation of the +* LTL property is detected. +* @atoms: The values of atomic propositions. +* @unknown_atoms: Atomic propositions which are still unknown. +*/ +struct ltl_monitor { + DECLARE_BITMAP(states, RV_MAX_BA_STATES); + DECLARE_BITMAP(atoms, RV_MAX_LTL_ATOM); + DECLARE_BITMAP(unknown_atoms, RV_MAX_LTL_ATOM); +}; + +static inline bool rv_ltl_valid_state (struct ltl_monitor *mon) +{ +for (int i =0 ; i <ARRAY_SIZE (mon->states); ++i) { +if (mon->states[i]) +return true; + } +return false; +} + +static inline bool rv_ltl_all_atoms_known (struct ltl_monitor *mon) +{ +for (int i =0 ; i <ARRAY_SIZE (mon->unknown_atoms); ++i) { +if (mon->unknown_atoms[i]) +return false; + } +return true; +} + +#else + +struct ltl_monitor {}; + +#endif /* CONFIG_RV_LTL_MONITOR */ +/* * Per-task RV monitors count. Nowadays fixed in RV_PER_TASK_MONITORS. * If we find justification for more monitors, we can think about @@ -27,11 +83,9 @@ struct da_monitor {#define RV_PER_TASK_MONITORS 1#define RV_PER_TASK_MONITOR_INIT (RV_PER_TASK_MONITORS) -/* -* Futher monitor types are expected, so make this a union. -*/ union rv_task_monitor { -struct da_monitor da_mon; +struct da_monitor da_mon; +struct ltl_monitor ltl_mon; };#ifdef CONFIG_RV_REACTORS include/rv/ltl_monitor.h new file +17
-0@@ -0,0 +1,184 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/** +* This file must be combined with the $(MODEL_NAME).h file generated by +* tools/verification/rvgen. +*/ + +#include <linux/args.h> +#include <linux/rv.h> +#include <linux/stringify.h> +#include <linux/seq_buf.h> +#include <rv/instrumentation.h> +#include <trace/events/task.h> +#include <trace/events/sched.h> + +#ifndef MONITOR_NAME +#error "MONITOR_NAME macro is not defined. Did you include $(MODEL_NAME).h generated by rvgen?" +#endif
include/rv/ltl_monitor.h line 27
Quoted 10 lines
include/rv/ltl_monitor.h new file +10
-0+ +#ifdef CONFIG_RV_REACTORS +#define RV_MONITOR_NAME CONCATENATE(rv_, MONITOR_NAME) +static struct rv_monitor RV_MONITOR_NAME ; + +static void rv_cond_react (struct task_struct *task) +{ +if (!rv_reacting_on () || !RV_MONITOR_NAME .react) +return ; + RV_MONITOR_NAME.react("rv: "__stringify(MONITOR_NAME)": %s[%d]: violation detected\n",
Note, the above *is* OK to break the limit, as we shouldn't break strings.
Quoted 23 lines
include/rv/ltl_monitor.h new file +18
-0+ task->comm, task->pid); +} +#else +static void rv_cond_react (struct task_struct *task) +{ +} +#endif + +static int ltl_monitor_slot =RV_PER_TASK_MONITOR_INIT ; + +static void ltl_atoms_fetch (struct task_struct *task,struct ltl_monitor *mon); +static void ltl_atoms_init (struct task_struct *task,struct ltl_monitor *mon,bool task_creation); + +static struct ltl_monitor *ltl_get_monitor (struct task_struct *task) +{ +return &task->rv[ltl_monitor_slot].ltl_mon; +} +kernel/fork.c +0
-0
kernel/fork.c static void copy_oom_score_adj(u64 clone_flags, struct task_struct *tsk) · line 1889
Quoted 8 lines
kernel/fork.c +1
-4@@ -1886,10 +1886,7 @@ static void copy_oom_score_adj(u64 clone_flags, struct task_struct *tsk)#ifdef CONFIG_RV static void rv_task_fork (struct task_struct *p) { -int i; - -for (i =0 ; i <RV_PER_TASK_MONITORS ; i++) - p->rv[i].da_mon.monitoring = false; +memset (p->rv,0 ,sizeof (p->rv));
It's not apparent that the above is a static array and memset() like that is commonly a bug. Perhaps make it:
memset(&p->rv, 0, sizeof(p->rv));
So that it doesn't look like a bug?
tools/verification/rvgen/.gitignore
Quoted 14 lines
kernel/fork.c +0
-0}#else #define rv_task_fork (p) do {} while (0)kernel/trace/rv/Kconfig +0
-1--- a/kernel/trace/rv/Kconfigtools/verification/rvgen/.gitignore new file +0
-0
BTW, this is quite a big patch. Can you break it up into three patches?
One for the Documentation, one for the kernel, and one for the tools portion. I may even put the tools and documentation patches into a separate patch that the one that modifies the kernel. As Linus likes tools code to be separate from the kernel code. It's not a hard rule, but it does make things slightly easier.
So far the patches look good. I'm still reviewing them.
-- Steve
Quoted 25 lines
tools/verification/rvgen/.gitignore new file +3
-0@@ -0,0 +1,3 @@ +__pycache__/ +parser.out +parsetab.pytools/verification/rvgen/Makefile +2
-0@@ -21,5 +21,7 @@ install: $(INSTALL) rvgen/dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/dot2k.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 + $(INSTALL) rvgen/ltl2k.py -D -m 644 $(DESTDIR)$(PYLIB)/rvgen/ltl2k.py $(INSTALL) __main__.py -D -m 755 $(DESTDIR)$(bindir)/rvgen cp -rp rvgen/templates $(DESTDIR)$(PYLIB)/rvgen/tools/verification/rvgen/__main__.py +1
-0@@ -12,6 +12,7 @@ if __name__ == '__main__': from rvgen.dot2k import dot2k from rvgen.generator import Monitor from rvgen.container import Container + from rvgen.ltl2k import ltl2k
Steven Rostedt
maintainerRe: [PATCH v10 14/19] rv: Add rtapp container monitor
In reply to Nam CaoQuoted 51 lines · On Tue, 10 Jun 2025 11:43:39 +0200 Nam Cao <[email protected]> wrote:
Add the container "rtapp" which is the monitor collection for detecting problems with real-time applications. The monitors will be added in the follow-up commits.
Reviewed-by Gabriele Monaco <[email protected]>Signed-off-by Nam Cao <[email protected]>--- kernel/trace/rv/Kconfig | 1 + kernel/trace/rv/Makefile | 1 + kernel/trace/rv/monitors/rtapp/Kconfig | 14 +++++++++++ kernel/trace/rv/monitors/rtapp/rtapp.c | 33 ++++++++++++++++++++++++++ kernel/trace/rv/monitors/rtapp/rtapp.h | 3 +++ 5 files changed, 52 insertions(+) create mode 100644 kernel/trace/rv/monitors/rtapp/Kconfig create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.c create mode 100644 kernel/trace/rv/monitors/rtapp/rtapp.hkernel/trace/rv/Kconfig +1
-0@@ -41,6 +41,7 @@ source "kernel/trace/rv/monitors/snroc/Kconfig" source "kernel/trace/rv/monitors/scpd/Kconfig" source "kernel/trace/rv/monitors/snep/Kconfig" source "kernel/trace/rv/monitors/sncid/Kconfig" +source "kernel/trace/rv/monitors/rtapp/Kconfig" # Add new monitors here config RV_REACTORSkernel/trace/rv/Makefile +1
-0@@ -12,6 +12,7 @@ obj-$(CONFIG_RV_MON_SNROC) += monitors/snroc/snroc.o obj-$(CONFIG_RV_MON_SCPD) += monitors/scpd/scpd.o obj-$(CONFIG_RV_MON_SNEP) += monitors/snep/snep.o obj-$(CONFIG_RV_MON_SNCID) += monitors/sncid/sncid.o +obj-$(CONFIG_RV_MON_RTAPP) += monitors/rtapp/rtapp.o # Add new monitors here obj-$(CONFIG_RV_REACTORS) += rv_reactors.o obj-$(CONFIG_RV_REACT_PRINTK) += reactor_printk.okernel/trace/rv/monitors/rtapp/Kconfig new file +4
-0@@ -0,0 +1,14 @@ +config RV_MON_RTAPP + depends on RV + bool "rtapp monitor" + help
kernel/trace/rv/monitors/rtapp/Kconfig line 14
Quoted 10 lines
kernel/trace/rv/monitors/rtapp/Kconfig new file +10
-0+ Collection of monitors to check for common problems with real-time + application that may cause unexpected latency. + + If you are developing a real-time system and not entirely sure whether + the applications are designed correctly for real-time, you want to say + Y here. + + Beware that enabling this may have impact on performance, even if the + monitors are not running. Therefore you probably should say N for + production kernel.
I'm trying to figure out from the patch how exactly does this cause performance issues?
Can you elaborate?
Thanks,
-- Steve
Quoted 48 lines
kernel/trace/rv/monitors/rtapp/rtapp.c new file +33
-0@@ -0,0 +1,33 @@ +// 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 "rtapp" + +#include "rtapp.h" + +struct rv_monitor rv_rtapp; + +struct rv_monitor rv_rtapp = { + .name ="rtapp" , + .description ="Collection of monitors for detecting problems with real-time applications" , +}; + +static int __init register_rtapp (void ) +{ +return rv_register_monitor (&rv_rtapp,NULL ); +} + +static void __exit unregister_rtapp(void) +{ +rv_unregister_monitor (&rv_rtapp); +} + +module_init (register_rtapp); +module_exit (unregister_rtapp); + +MODULE_LICENSE ("GPL" ); +MODULE_AUTHOR ("Nam Cao <[email protected]>" ); +MODULE_DESCRIPTION ("Collection of monitors for detecting problems with real-time applications" );kernel/trace/rv/monitors/rtapp/rtapp.h new file +3
-0@@ -0,0 +1,3 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +extern struct rv_monitor rv_rtapp;
Steven Rostedt
maintainerRe: [PATCH v10 16/19] rv: Add rtapp_pagefault monitor
In reply to Nam Caokernel/trace/rv/monitors/pagefault/pagefault.c line 25
Quoted 5 lines · On Tue, 10 Jun 2025 11:43:41 +0200 Nam Cao <[email protected]> wrote:
kernel/trace/rv/monitors/pagefault/pagefault.c new file +5
-0+static void ltl_atoms_fetch (struct task_struct *task,struct ltl_monitor *mon) +{ +/* +* This includes "actual" real-time tasks and also PI-boosted tasks. A task being PI-boosted +* means it is blocking an "actual" real-task, therefore it should also obey the monitor's
Let's keep the comments below 80 columns.
Thanks,
-- Steve
Quoted 5 lines
kernel/trace/rv/monitors/pagefault/pagefault.c new file +5
-0+* rule, otherwise the "actual" real-task may be delayed. +*/ +ltl_atom_set (mon,LTL_RT ,rt_or_dl_task (task)); +} +
Steven Rostedt
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
In reply to Nam CaoQuoted 40 lines · On Tue, 10 Jun 2025 11:43:42 +0200 Nam Cao <[email protected]> wrote:
kernel/trace/rv/monitors/sleep/sleep.h new file +40
-0+static void +ltl_possible_next_states (struct ltl_monitor *mon,unsigned int state,unsigned long *next) +{ +bool task_is_migration =test_bit (LTL_TASK_IS_MIGRATION , mon->atoms); +bool task_is_rcu =test_bit (LTL_TASK_IS_RCU , mon->atoms); +bool val40 = task_is_rcu || task_is_migration; +bool futex_lock_pi =test_bit (LTL_FUTEX_LOCK_PI , mon->atoms); +bool val41 = futex_lock_pi || val40; +bool block_on_rt_mutex =test_bit (LTL_BLOCK_ON_RT_MUTEX , mon->atoms); +bool val5 = block_on_rt_mutex || val41; +bool kthread_should_stop =test_bit (LTL_KTHREAD_SHOULD_STOP , mon->atoms); +bool abort_sleep =test_bit (LTL_ABORT_SLEEP , mon->atoms); +bool val32 = abort_sleep || kthread_should_stop; +bool woken_by_nmi =test_bit (LTL_WOKEN_BY_NMI , mon->atoms); +bool val33 = woken_by_nmi || val32; +bool woken_by_hardirq =test_bit (LTL_WOKEN_BY_HARDIRQ , mon->atoms); +bool val34 = woken_by_hardirq || val33; +bool woken_by_equal_or_higher_prio =test_bit (LTL_WOKEN_BY_EQUAL_OR_HIGHER_PRIO , + mon->atoms); +bool val14 = woken_by_equal_or_higher_prio || val34; +bool wake =test_bit (LTL_WAKE , mon->atoms); +bool val13 = !wake; +bool kernel_thread =test_bit (LTL_KERNEL_THREAD , mon->atoms); +bool nanosleep_clock_tai =test_bit (LTL_NANOSLEEP_CLOCK_TAI , mon->atoms); +bool nanosleep_clock_monotonic =test_bit (LTL_NANOSLEEP_CLOCK_MONOTONIC , mon->atoms); +bool val24 = nanosleep_clock_monotonic || nanosleep_clock_tai; +bool nanosleep_timer_abstime =test_bit (LTL_NANOSLEEP_TIMER_ABSTIME , mon->atoms); +bool val25 = nanosleep_timer_abstime && val24; +bool clock_nanosleep =test_bit (LTL_CLOCK_NANOSLEEP , mon->atoms); +bool val18 = clock_nanosleep && val25; +bool futex_wait =test_bit (LTL_FUTEX_WAIT , mon->atoms); +bool val9 = futex_wait || val18; +bool val11 = val9 || kernel_thread; +bool sleep =test_bit (LTL_SLEEP , mon->atoms); +bool val2 = !sleep; +bool rt =test_bit (LTL_RT , mon->atoms); +bool val1 = !rt; +bool val3 = val1 || val2; + +switch (state) {
kernel/trace/rv/monitors/sleep/sleep.h line 166
Quoted 10 lines
kernel/trace/rv/monitors/sleep/sleep.h new file +10
-0+case S0 : +if (val3) +__set_bit (S0 , next); +if (val11 && val13) +__set_bit (S1 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val5) +__set_bit (S5 , next); +break ;
What's with all the magic numbers?
Can we turn these into enums so they have some meaning for us humans?
-- Steve
Quoted 84 lines
kernel/trace/rv/monitors/sleep/sleep.h new file +84
-0+case S1 : +if (val11 && val13) +__set_bit (S1 , next); +if (val13 && val3) +__set_bit (S2 , next); +if (val14 && val3) +__set_bit (S3 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val13 && val5) +__set_bit (S6 , next); +if (val14 && val5) +__set_bit (S7 , next); +break ; +case S2 : +if (val11 && val13) +__set_bit (S1 , next); +if (val13 && val3) +__set_bit (S2 , next); +if (val14 && val3) +__set_bit (S3 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val13 && val5) +__set_bit (S6 , next); +if (val14 && val5) +__set_bit (S7 , next); +break ; +case S3 : +if (val3) +__set_bit (S0 , next); +if (val11 && val13) +__set_bit (S1 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val5) +__set_bit (S5 , next); +break ; +case S4 : +if (val3) +__set_bit (S0 , next); +if (val11 && val13) +__set_bit (S1 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val5) +__set_bit (S5 , next); +break ; +case S5 : +if (val3) +__set_bit (S0 , next); +if (val11 && val13) +__set_bit (S1 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val5) +__set_bit (S5 , next); +break ; +case S6 : +if (val11 && val13) +__set_bit (S1 , next); +if (val13 && val3) +__set_bit (S2 , next); +if (val14 && val3) +__set_bit (S3 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val13 && val5) +__set_bit (S6 , next); +if (val14 && val5) +__set_bit (S7 , next); +break ; +case S7 : +if (val3) +__set_bit (S0 , next); +if (val11 && val13) +__set_bit (S1 , next); +if (val11 && val14) +__set_bit (S4 , next); +if (val5) +__set_bit (S5 , next); +break ; + } +}
Steven Rostedt
maintainerRe: [PATCH v10 18/19] rv: Add documentation for rtapp monitor
In reply to Nam CaoQuoted 18 lines · On Tue, 10 Jun 2025 11:43:43 +0200 Nam Cao <[email protected]> wrote:
Documentation/trace/rv/monitor_rtapp.rst new file +15
-0@@ -0,0 +1,116 @@ +Real-time application monitors +============================== + +- Name: rtapp +- Type: container for multiple monitors +- Author: Nam Cao <[email protected]> + +Description +----------- + +Real-time applications may have design flaws such that they experience unexpected latency and fail +to meet their time requirements. Often, these flaws follow a few patterns: + + - Page faults: A real-time thread may access memory that does not have a mapped physical backing + or must first be copied (such as for copy-on-write). Thus a page fault is raised and the kernel
Documentation/trace/rv/monitor_rtapp.rst line 25
Quoted 10 lines
Documentation/trace/rv/monitor_rtapp.rst new file +10
-0+ must first perform the expensive action. This causes significant delays to the real-time thread + - Priority inversion: A real-time thread blocks waiting for a lower-priority thread. This causes + the real-time thread to effectively take on the scheduling priority of the lower-priority + thread. For example, the real-time thread needs to access a shared resource that is protected by + a non-pi-mutex, but the mutex is currently owned by a non-real-time thread. + +The `rtapp` monitor detects these patterns. It aids developers to identify reasons for unexpected +latency with real-time applications. It is a container of multiple sub-monitors described in the +following sections. +
Again, please limit the documentation to 80 columns.
Thanks!
-- Steve
Steven Rostedt
maintainerQuoted 10 lines · On Fri, 27 Jun 2025 16:17:44 +0200 Nam Cao <[email protected]> wrote:
Quoted 8 lines · Steven Rostedt
Quoted 3 lines · On Fri, 27 Jun 2025 14:42:48 +0200 Nam Cao <[email protected]> wrote:
Is there any chance this series could be applied soon? I have some more patches which depend on this series, so it is holding up the show. I think Gabriele needs this applied for his patches as well.
I'll try to take a look at these today.
OK, finished it. I didn't read the lines that were over 80 columns, as that does give me a headache. But that means I may only have questions on the comments and documentation.
The rest looks good besides the comments I made in the series.
Please send a v11.
Thanks,
-- Steve
Re: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
In reply to Steven RostedtQuoted 55 lines · Steven Rostedt
Quoted 40 lines · On Tue, 10 Jun 2025 11:43:42 +0200 Nam Cao <[email protected]> wrote:
(quoted diff) +40
-0+static void +ltl_possible_next_states(struct ltl_monitor *mon, unsigned int state, unsigned long *next) +{ + bool task_is_migration = test_bit(LTL_TASK_IS_MIGRATION, mon->atoms); + bool task_is_rcu = test_bit(LTL_TASK_IS_RCU, mon->atoms); + bool val40 = task_is_rcu || task_is_migration; + bool futex_lock_pi = test_bit(LTL_FUTEX_LOCK_PI, mon->atoms); + bool val41 = futex_lock_pi || val40; + bool block_on_rt_mutex = test_bit(LTL_BLOCK_ON_RT_MUTEX, mon->atoms); + bool val5 = block_on_rt_mutex || val41; + bool kthread_should_stop = test_bit(LTL_KTHREAD_SHOULD_STOP, mon->atoms); + bool abort_sleep = test_bit(LTL_ABORT_SLEEP, mon->atoms); + bool val32 = abort_sleep || kthread_should_stop; + bool woken_by_nmi = test_bit(LTL_WOKEN_BY_NMI, mon->atoms); + bool val33 = woken_by_nmi || val32; + bool woken_by_hardirq = test_bit(LTL_WOKEN_BY_HARDIRQ, mon->atoms); + bool val34 = woken_by_hardirq || val33; + bool woken_by_equal_or_higher_prio = test_bit(LTL_WOKEN_BY_EQUAL_OR_HIGHER_PRIO, + mon->atoms); + bool val14 = woken_by_equal_or_higher_prio || val34; + bool wake = test_bit(LTL_WAKE, mon->atoms); + bool val13 = !wake; + bool kernel_thread = test_bit(LTL_KERNEL_THREAD, mon->atoms); + bool nanosleep_clock_tai = test_bit(LTL_NANOSLEEP_CLOCK_TAI, mon->atoms); + bool nanosleep_clock_monotonic = test_bit(LTL_NANOSLEEP_CLOCK_MONOTONIC, mon->atoms); + bool val24 = nanosleep_clock_monotonic || nanosleep_clock_tai; + bool nanosleep_timer_abstime = test_bit(LTL_NANOSLEEP_TIMER_ABSTIME, mon->atoms); + bool val25 = nanosleep_timer_abstime && val24; + bool clock_nanosleep = test_bit(LTL_CLOCK_NANOSLEEP, mon->atoms); + bool val18 = clock_nanosleep && val25; + bool futex_wait = test_bit(LTL_FUTEX_WAIT, mon->atoms); + bool val9 = futex_wait || val18; + bool val11 = val9 || kernel_thread; + bool sleep = test_bit(LTL_SLEEP, mon->atoms); + bool val2 = !sleep; + bool rt = test_bit(LTL_RT, mon->atoms); + bool val1 = !rt; + bool val3 = val1 || val2; + + switch (state) {Review
Quoted 10 lines
(quoted diff) +10
-0+ case S0: + if (val3) + __set_bit(S0, next); + if (val11 && val13) + __set_bit(S1, next); + if (val11 && val14) + __set_bit(S4, next); + if (val5) + __set_bit(S5, next); + break;What's with all the magic numbers?
Quoted 1 line
Can we turn these into enums so they have some meaning for us humans?
I'm not sure what you mean, we can't use enums as variables.
I haven't come up with a good way of (automatically) giving them meaningful names. They are just intermediate values (e.g. 'and' of other values). Maybe I should integrate AI in my scripts ;)
There's another option: we could drop all these intermediate variables and use the atomic propositions directly. So I could hack my scripts:
tools/verification/rvgen/rvgen/ltl2ba.py +7 -5
@@ -118,11 +118,7 @@ class ASTNode: return self.op.expand(self, node, node_set) def __str__(self): - if isinstance(self.op, Literal): - return str(self.op.value) - if isinstance(self.op, Variable): - return self.op.name.lower() - return "val" + str(self.id) + return str(self.op).lower() def normalize(self): # Get rid of:
@@ -147,6 +143,9 @@ class BinaryOp: yield from self.left yield from self.right + def __str__(self): + return "(%s %s %s)" % (self.left.op, self.op_str, self.right.op) + def normalize(self): raise NotImplementedError
@@ -358,6 +357,9 @@ class Variable: def __iter__(self): yield from () + def __str__(self): + return self.name + def negate(self): new = ASTNode(self) return NotOp(new)
tools/verification/rvgen/rvgen/ltl2k.py +0 -9
@@ -109,17 +109,8 @@ class ltl2k(generator.Monitor): def _fill_atom_values(self): buf = [] for node in self.ltl: - if node.op.is_temporal(): - continue - if isinstance(node.op, ltl2ba.Variable): buf.append("\tbool %s = test_bit(LTL_%s, mon->atoms);" % (node, node.op.name)) - elif isinstance(node.op, ltl2ba.AndOp): - buf.append("\tbool %s = %s && %s;" % (node, node.op.left, node.op.right)) - elif isinstance(node.op, ltl2ba.OrOp): - buf.append("\tbool %s = %s || %s;" % (node, node.op.left, node.op.right)) - elif isinstance(node.op, ltl2ba.NotOp): - buf.append("\tbool %s = !%s;" % (node, node.op.child)) buf.reverse() buf2 = []
And we would get:
static voidltl_possible_next_states(struct ltl_monitor *mon, unsigned int state, unsigned long *next)
{
bool task_is_migration = test_bit(LTL_TASK_IS_MIGRATION, mon->atoms);
bool task_is_rcu = test_bit(LTL_TASK_IS_RCU, mon->atoms);
bool futex_lock_pi = test_bit(LTL_FUTEX_LOCK_PI, mon->atoms);
bool block_on_rt_mutex = test_bit(LTL_BLOCK_ON_RT_MUTEX, mon->atoms);
bool kthread_should_stop = test_bit(LTL_KTHREAD_SHOULD_STOP, mon->atoms);
bool abort_sleep = test_bit(LTL_ABORT_SLEEP, mon->atoms);
bool woken_by_nmi = test_bit(LTL_WOKEN_BY_NMI, mon->atoms);
bool woken_by_hardirq = test_bit(LTL_WOKEN_BY_HARDIRQ, mon->atoms);
bool woken_by_equal_or_higher_prio = test_bit(LTL_WOKEN_BY_EQUAL_OR_HIGHER_PRIO,
mon->atoms);
bool wake = test_bit(LTL_WAKE, mon->atoms);
bool kernel_thread = test_bit(LTL_KERNEL_THREAD, mon->atoms);
bool nanosleep_clock_tai = test_bit(LTL_NANOSLEEP_CLOCK_TAI, mon->atoms);
bool nanosleep_clock_monotonic = test_bit(LTL_NANOSLEEP_CLOCK_MONOTONIC, mon->atoms);
bool nanosleep_timer_abstime = test_bit(LTL_NANOSLEEP_TIMER_ABSTIME, mon->atoms);
bool clock_nanosleep = test_bit(LTL_CLOCK_NANOSLEEP, mon->atoms);
bool futex_wait = test_bit(LTL_FUTEX_WAIT, mon->atoms);
bool sleep = test_bit(LTL_SLEEP, mon->atoms);
bool rt = test_bit(LTL_RT, mon->atoms);
switch (state) {
case S0:
if ((!rt || !sleep))
__set_bit(S0, next);
if (!wake && ((futex_wait || (clock_nanosleep && (nanosleep_timer_abstime &&
(nanosleep_clock_monotonic || nanosleep_clock_tai)))) || kernel_thread))
__set_bit(S1, next);
if (((futex_wait || (clock_nanosleep && (nanosleep_timer_abstime &&
(nanosleep_clock_monotonic || nanosleep_clock_tai)))) || kernel_thread) &&
(woken_by_equal_or_higher_prio || (woken_by_hardirq || (woken_by_nmi ||
(abort_sleep || kthread_should_stop)))))
__set_bit(S5, next);
if ((block_on_rt_mutex || (futex_lock_pi || (task_is_rcu || task_is_migration))))
__set_bit(S6, next);
break;It is just a matter of taste. I will let you pick. Or do you hate this one as well?
Best regards,
Nam
Re: [PATCH v10 14/19] rv: Add rtapp container monitor
In reply to Steven RostedtQuoted 26 lines · Steven Rostedt
Quoted 10 lines · On Tue, 10 Jun 2025 11:43:39 +0200 Nam Cao <[email protected]> wrote:
kernel/trace/rv/monitors/rtapp/Kconfig new file +4
-0@@ -0,0 +1,14 @@ +config RV_MON_RTAPP + depends on RV + bool "rtapp monitor" + helpkernel/trace/rv/monitors/rtapp/Kconfig line 14
Quoted 10 lines
kernel/trace/rv/monitors/rtapp/Kconfig new file +10
-0+ Collection of monitors to check for common problems with real-time + application that may cause unexpected latency. + + If you are developing a real-time system and not entirely sure whether + the applications are designed correctly for real-time, you want to say + Y here. + + Beware that enabling this may have impact on performance, even if the + monitors are not running. Therefore you probably should say N for + production kernel.I'm trying to figure out from the patch how exactly does this cause performance issues?
Quoted 1 line
Can you elaborate?
Sorry for the confusion, this patch alone doesn't affect performance.
It is its child monitor which turns on CONFIG_TRACE_IRQFLAGS, which is added in a later patch.
Let me move this paragraph to that patch instead.
Nam
Quoted 11 lines · Steven Rostedt
Quoted 8 lines · On Fri, 27 Jun 2025 16:17:44 +0200 Nam Cao <[email protected]> wrote:
Quoted 7 lines · Steven Rostedt
Quoted 3 lines · On Fri, 27 Jun 2025 14:42:48 +0200 Nam Cao <[email protected]> wrote:
Is there any chance this series could be applied soon? I have some more patches which depend on this series, so it is holding up the show. I think Gabriele needs this applied for his patches as well.
Quoted 6 lines
Quoted 2 lines
Quoted 1 line
I'll try to take a look at these today.
OK, finished it. I didn't read the lines that were over 80 columns, as that does give me a headache. But that means I may only have questions on the comments and documentation.
Thanks, appreciate it! I'm well aware you are probably busy with other things already.
Quoted 3 lines
The rest looks good besides the comments I made in the series.
Please send a v11.
FYI I'm on some sort of a "business trip" this week, so v11 probably can't arrive until next week.
Best regards,
Nam
Steven Rostedt
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
In reply to Nam CaoQuoted 14 lines · On Tue, 1 Jul 2025 07:17:57 +0200 Nam Cao <[email protected]> wrote:
Quoted 14 lines
Review
Quoted 11 lines
(quoted diff) +11
-0+ switch (state) { + case S0: + if (val3) + __set_bit(S0, next); + if (val11 && val13) + __set_bit(S1, next); + if (val11 && val14) + __set_bit(S4, next); + if (val5) + __set_bit(S5, next); + break;What's with all the magic numbers?
Quoted 3 lines
Quoted 1 line
Can we turn these into enums so they have some meaning for us humans?
I'm not sure what you mean, we can't use enums as variables.
Bah, never mind. My eyes are getting bad and I need to increase my font size, as all the S0, S1, S2 looked to me like 50, 51, 52, and I was wondering what are all these numbers in the fifties??? :-p
[ Note, it is a beautiful day and on nice days like this I go outside
to work using my laptop, which has a much smaller screen than my desktop. I was reviewing your patches on my laptop where these looked like numbers and not something that started with an 'S'!
]
-- Steve
Steven Rostedt
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 17 lines · On Tue, 1 Jul 2025 11:02:18 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 14 lines · On Tue, 1 Jul 2025 07:17:57 +0200 Nam Cao <[email protected]> wrote:
Quoted 14 lines
Review
Quoted 11 lines
(quoted diff) +11
-0+ switch (state) { + case S0: + if (val3) + __set_bit(S0, next); + if (val11 && val13) + __set_bit(S1, next); + if (val11 && val14) + __set_bit(S4, next); + if (val5) + __set_bit(S5, next); + break;What's with all the magic numbers?
Quoted 7 lines
Quoted 3 lines
Quoted 1 line
Can we turn these into enums so they have some meaning for us humans?
I'm not sure what you mean, we can't use enums as variables.
Bah, never mind. My eyes are getting bad and I need to increase my font size, as all the S0, S1, S2 looked to me like 50, 51, 52, and I was wondering what are all these numbers in the fifties??? :-p
Even with my bad eyesight, these state transitions are generated from scripts? If so, can they inject comments that state why they generated this?
There's nothing in the code that even states that this was generated (if they were).
-- Steve
Re: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 20 lines · Steven Rostedt
Quoted 17 lines · On Tue, 1 Jul 2025 11:02:18 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 14 lines · On Tue, 1 Jul 2025 07:17:57 +0200 Nam Cao <[email protected]> wrote:
Quoted 14 lines
Review
Quoted 11 lines
(quoted diff) +11
-0+ switch (state) { + case S0: + if (val3) + __set_bit(S0, next); + if (val11 && val13) + __set_bit(S1, next); + if (val11 && val14) + __set_bit(S4, next); + if (val5) + __set_bit(S5, next); + break;What's with all the magic numbers?
Quoted 7 lines
Quoted 7 lines
Quoted 3 lines
Quoted 1 line
Can we turn these into enums so they have some meaning for us humans?
I'm not sure what you mean, we can't use enums as variables.
Bah, never mind. My eyes are getting bad and I need to increase my font size, as all the S0, S1, S2 looked to me like 50, 51, 52, and I was wondering what are all these numbers in the fifties??? :-p
Oh..
Quoted 6 lines
Even with my bad eyesight, these state transitions are generated from scripts? If so, can they inject comments that state why they generated this?
There's nothing in the code that even states that this was generated (if they were).
Yeah this entire file is generated from the LTL specification. I will add a comment.
Nam
Steven Rostedt
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 5 lines · On Tue, 1 Jul 2025 17:11:14 +0200 Nam Cao <[email protected]> wrote:
Quoted 2 lines
There's nothing in the code that even states that this was generated (if they were).
Yeah this entire file is generated from the LTL specification. I will add a comment.
Yeah, generated code needs a big comment at the top of the file on what generated it. Bonus points if it shows how it was generated so that people will know how to regenerate it.
-- Steve
Re: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 11 lines · Steven Rostedt
Quoted 5 lines · On Tue, 1 Jul 2025 17:11:14 +0200 Nam Cao <[email protected]> wrote:
Quoted 2 lines
There's nothing in the code that even states that this was generated (if they were).
Yeah this entire file is generated from the LTL specification. I will add a comment.
Yeah, generated code needs a big comment at the top of the file on what generated it.
Sure.
Quoted 2 lines
Bonus points if it shows how it was generated so that people will know how to regenerate it.
If it's okay, not in this series. It requires changes to the RV core script, and I prefer not touching things which are not LTL-specific for now, unless necessary. The DA monitors and the containers do not have it as well.
Let me stash it into my TODO list of RV cleanups. I will add this for LTL, deterministic automaton and container in one go.
Best regards,
Nam
Steven Rostedt
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 8 lines · On Tue, 1 Jul 2025 23:03:38 +0200 Nam Cao <[email protected]> wrote:
Quoted 3 lines
Bonus points if it shows how it was generated so that people will know how to regenerate it.
If it's okay, not in this series. It requires changes to the RV core script, and I prefer not touching things which are not LTL-specific for now, unless necessary. The DA monitors and the containers do not have it as well.
Yeah, just update this set to state that this code was generated.
Quoted 3 lines
Let me stash it into my TODO list of RV cleanups. I will add this for LTL, deterministic automaton and container in one go.
Thanks,
-- Steve
Gabriele Monaco
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 15 lines · Steven Rostedt
Quoted 5 lines · On Tue, 1 Jul 2025 23:03:38 +0200 Nam Cao <[email protected]> wrote:
Quoted 4 lines
Bonus points if it shows how it was generated so that people will know
how to regenerate it.Quoted 7 lines
If it's okay, not in this series. It requires changes to the RV core
script, and I prefer not touching things which are not LTL-specific for
now, unless necessary. The DA monitors and the containers do not have it as
well.
Quoted 7 lines
Yeah, just update this set to state that this code was generated.
Quoted 4 lines
Let me stash it into my TODO list of RV cleanups. I will add this for LTL,
deterministic automaton and container in one go.
That's a good point, at the moment the DA monitors have a comment in the /completely/ generated files (the automata header), the others where just a skeleton is prepared have some hints that we removed while filling the monitor.
I'd say for now it's good to just add a comment in the LTL header (like Dot2k:fill_model_h_header), then we can adapt all generated files (whether fully or not) to have also the actual command that generated them starting from the model file.
Or did you have something different in mind, Nam?
Anyway this is all well documented, so pointing to the documentation like we do in the header doesn't look bad to me.
Thanks,
Gabriele
Re: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 10 lines · Gabriele Monaco
That's a good point, at the moment the DA monitors have a comment in the /completely/ generated files (the automata header), the others where just a skeleton is prepared have some hints that we removed while filling the monitor.
I'd say for now it's good to just add a comment in the LTL header (like Dot2k:fill_model_h_header), then we can adapt all generated files (whether fully or not) to have also the actual command that generated them starting from the model file.
Or did you have something different in mind, Nam?
Yes, I think the same.
An easy way to do it is just dump out sys.argv. But one thing I'm unsure
about: I prefer to execute the command from tools/verification, and the command I use would not work for people running from root directory. I would like the printed command to always appear as if it is executed from root directory. However, I see no elegant way to do it - will need to think some more.
Best regards,
Nam
Gabriele Monaco
maintainerRe: [PATCH v10 17/19] rv: Add rtapp_sleep monitor
Quoted 18 lines · Nam Cao
Quoted 7 lines · Gabriele Monaco
That's a good point, at the moment the DA monitors have a comment in
the /completely/ generated files (the automata header), the others where just a skeleton is prepared have some hints that we removed while
filling the monitor.Quoted 7 lines
I'd say for now it's good to just add a comment in the LTL header (like
Dot2k:fill_model_h_header), then we can adapt all generated files (whether fully or not) to have also the actual command that generated
them starting from the model file.
Or did you have something different in mind, Nam?Yes, I think the same.
Quoted 12 lines
An easy way to do it is just dump out sys.argv. But one thing I'm unsure
about: I prefer to execute the command fromtools/verification, and the
command I use would not work for people running from root directory. I
would like the printed command to always appear as if it is executed from
root directory. However, I see no elegant way to do it - will need to think
some more.
Mmh, that's something I didn't think about, but perhaps we shouldn't be too picky and think users would just copy-paste the command provided and expect it to work.
By the way, the sys.argv could be a great start, but depending on the workflow, one may not even keep the model in the location where it would be committed during generation (I usually don't, mostly out of laziness).
Anyway, although I'd prefer running the command from the repo root, just for sake of compactness we could include the command as run from tools/verification, but I'm fine either ways. I think by adding proper documentation, the reader can easily figure that out.
We could edit sys.argv before printing to make sure the model is where we expect it to be, and perhaps strip/add some arguments (e.g. if we want the -a or not), just to keep it always consistent and predictable.
As long as the command written to the files is consistent and clear to understand, I wouldn't mind too much.
Thanks,
Gabriele