public inbox for linux-trace-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Wander Lairson Costa <wander@redhat.com>
To: Steven Rostedt <rostedt@goodmis.org>,
	Gabriele Monaco <gmonaco@redhat.com>,
	Nam Cao <namcao@linutronix.de>,
	Wander Lairson Costa <wander@redhat.com>,
	linux-kernel@vger.kernel.org (open list),
	linux-trace-kernel@vger.kernel.org (open list:RUNTIME
	VERIFICATION (RV))
Subject: [PATCH 01/26] rv/rvgen: introduce AutomataError exception class
Date: Mon, 19 Jan 2026 17:45:37 -0300	[thread overview]
Message-ID: <20260119205601.105821-2-wander@redhat.com> (raw)
In-Reply-To: <20260119205601.105821-1-wander@redhat.com>

Replace generic Exception usage with a custom AutomataError class
that inherits from OSError throughout the rvgen tool. This change
provides more precise exception handling for automata parsing and
validation errors while avoiding overly broad exception catches that
could mask programming errors like SyntaxError or TypeError.

The AutomataError class inherits from OSError rather than Exception
because most error conditions involve file I/O operations such as
reading DOT files or handling file access issues. This semantic
alignment makes exception handling more specific and appropriate.
The exception is raised when DOT file processing fails due to invalid
format, I/O errors, or malformed automaton definitions.

Additionally, remove the broad try-except block from __main__.py that
was catching all exceptions. This allows Python's default exception
handling to provide complete stack traces, making debugging
significantly easier by showing exact error types and locations.

Signed-off-by: Wander Lairson Costa <wander@redhat.com>
---
 tools/verification/rvgen/__main__.py        | 25 +++++++++------------
 tools/verification/rvgen/rvgen/automata.py  | 17 +++++++++-----
 tools/verification/rvgen/rvgen/dot2c.py     |  4 ++--
 tools/verification/rvgen/rvgen/generator.py |  7 ++----
 4 files changed, 26 insertions(+), 27 deletions(-)

diff --git a/tools/verification/rvgen/__main__.py b/tools/verification/rvgen/__main__.py
index fa6fc1f4de2f7..768b11a1e978b 100644
--- a/tools/verification/rvgen/__main__.py
+++ b/tools/verification/rvgen/__main__.py
@@ -39,22 +39,17 @@ if __name__ == '__main__':
 
     params = parser.parse_args()
 
-    try:
-        if params.subcmd == "monitor":
-            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":
-                monitor = ltl2k(params.spec, params.monitor_type, vars(params))
-            else:
-                print("Unknown monitor class:", params.monitor_class)
-                sys.exit(1)
+    if params.subcmd == "monitor":
+        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":
+            monitor = ltl2k(params.spec, params.monitor_type, vars(params))
         else:
-            monitor = Container(vars(params))
-    except Exception as e:
-        print('Error: '+ str(e))
-        print("Sorry : :-(")
-        sys.exit(1)
+            print("Unknown monitor class:", params.monitor_class)
+            sys.exit(1)
+    else:
+        monitor = Container(vars(params))
 
     print("Writing the monitor into the directory %s" % monitor.name)
     monitor.print_files()
diff --git a/tools/verification/rvgen/rvgen/automata.py b/tools/verification/rvgen/rvgen/automata.py
index d9a3fe2b74bf2..8d88c3b65d00d 100644
--- a/tools/verification/rvgen/rvgen/automata.py
+++ b/tools/verification/rvgen/rvgen/automata.py
@@ -10,6 +10,13 @@
 
 import ntpath
 
+class AutomataError(OSError):
+    """Exception raised for errors in automata parsing and validation.
+
+    Raised when DOT file processing fails due to invalid format, I/O errors,
+    or malformed automaton definitions.
+    """
+
 class Automata:
     """Automata class: Reads a dot file and part it as an automata.
 
@@ -32,11 +39,11 @@ class Automata:
         basename = ntpath.basename(self.__dot_path)
         if not basename.endswith(".dot") and not basename.endswith(".gv"):
             print("not a dot file")
-            raise Exception("not a dot file: %s" % self.__dot_path)
+            raise AutomataError("not a dot file: %s" % self.__dot_path)
 
         model_name = ntpath.splitext(basename)[0]
         if model_name.__len__() == 0:
-            raise Exception("not a dot file: %s" % self.__dot_path)
+            raise AutomataError("not a dot file: %s" % self.__dot_path)
 
         return model_name
 
@@ -45,8 +52,8 @@ class Automata:
         dot_lines = []
         try:
             dot_file = open(self.__dot_path)
-        except:
-            raise Exception("Cannot open the file: %s" % self.__dot_path)
+        except OSError as exc:
+            raise AutomataError(f"Cannot open the file: {self.__dot_path}") from exc
 
         dot_lines = dot_file.read().splitlines()
         dot_file.close()
@@ -55,7 +62,7 @@ class Automata:
         line = dot_lines[cursor].split()
 
         if (line[0] != "digraph") and (line[1] != "state_automaton"):
-            raise Exception("Not a valid .dot format: %s" % self.__dot_path)
+            raise AutomataError("Not a valid .dot format: %s" % self.__dot_path)
         else:
             cursor += 1
         return dot_lines
diff --git a/tools/verification/rvgen/rvgen/dot2c.py b/tools/verification/rvgen/rvgen/dot2c.py
index b9b6f14cc536a..1a1770e7f20c0 100644
--- a/tools/verification/rvgen/rvgen/dot2c.py
+++ b/tools/verification/rvgen/rvgen/dot2c.py
@@ -13,7 +13,7 @@
 # For further information, see:
 #   Documentation/trace/rv/deterministic_automata.rst
 
-from .automata import Automata
+from .automata import Automata, AutomataError
 
 class Dot2c(Automata):
     enum_suffix = ""
@@ -93,7 +93,7 @@ class Dot2c(Automata):
             min_type = "unsigned int"
 
         if self.states.__len__() > 1000000:
-            raise Exception("Too many states: %d" % self.states.__len__())
+            raise AutomataError("Too many states: %d" % self.states.__len__())
 
         return min_type
 
diff --git a/tools/verification/rvgen/rvgen/generator.py b/tools/verification/rvgen/rvgen/generator.py
index 3441385c11770..a7bee6b1ea70c 100644
--- a/tools/verification/rvgen/rvgen/generator.py
+++ b/tools/verification/rvgen/rvgen/generator.py
@@ -51,10 +51,7 @@ class RVGenerator:
         raise FileNotFoundError("Could not find the rv directory, do you have the kernel source installed?")
 
     def _read_file(self, path):
-        try:
-            fd = open(path, 'r')
-        except OSError:
-            raise Exception("Cannot open the file: %s" % path)
+        fd = open(path, 'r')
 
         content = fd.read()
 
@@ -65,7 +62,7 @@ class RVGenerator:
         try:
             path = os.path.join(self.abs_template_dir, file)
             return self._read_file(path)
-        except Exception:
+        except OSError:
             # Specific template file not found. Try the generic template file in the template/
             # directory, which is one level up
             path = os.path.join(self.abs_template_dir, "..", file)
-- 
2.52.0


  reply	other threads:[~2026-01-19 20:59 UTC|newest]

Thread overview: 95+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-19 20:45 [PATCH 00/26] rv/rvgen: Robustness, modernization, and fixes Wander Lairson Costa
2026-01-19 20:45 ` Wander Lairson Costa [this message]
2026-01-20  7:33   ` [PATCH 01/26] rv/rvgen: introduce AutomataError exception class Gabriele Monaco
2026-01-20 12:39     ` Wander Lairson Costa
2026-01-20 15:08       ` Gabriele Monaco
2026-01-22 14:39         ` Nam Cao
2026-01-19 20:45 ` [PATCH 02/26] rv/rvgen: remove bare except clauses in generator Wander Lairson Costa
2026-01-20 10:05   ` Gabriele Monaco
2026-01-22 14:43   ` Nam Cao
2026-01-19 20:45 ` [PATCH 03/26] rv/rvgen: replace % string formatting with f-strings Wander Lairson Costa
2026-01-20 10:02   ` Gabriele Monaco
2026-01-22 14:46   ` Nam Cao
2026-01-19 20:45 ` [PATCH 04/26] rv/rvgen: replace __len__() calls with len() Wander Lairson Costa
2026-01-20  7:41   ` Gabriele Monaco
2026-01-22 14:46   ` Nam Cao
2026-01-19 20:45 ` [PATCH 05/26] rv/rvgen: remove unnecessary semicolons Wander Lairson Costa
2026-01-20  7:42   ` Gabriele Monaco
2026-01-22 14:47   ` Nam Cao
2026-01-19 20:45 ` [PATCH 06/26] rv/rvgen: use context managers for file operations Wander Lairson Costa
2026-01-20  7:44   ` Gabriele Monaco
2026-01-22 14:50   ` Nam Cao
2026-01-19 20:45 ` [PATCH 07/26] rv/rvgen: replace __contains__() with in operator Wander Lairson Costa
2026-01-20  7:45   ` Gabriele Monaco
2026-01-22 14:51   ` Nam Cao
2026-01-19 20:45 ` [PATCH 08/26] rv/rvgen: simplify boolean comparison Wander Lairson Costa
2026-01-20  7:48   ` Gabriele Monaco
2026-01-22 14:51   ` Nam Cao
2026-01-19 20:45 ` [PATCH 09/26] rv/rvgen: replace inline NotImplemented with decorator Wander Lairson Costa
2026-01-21 13:43   ` Gabriele Monaco
2026-01-21 17:49     ` Wander Lairson Costa
2026-01-22 14:57   ` Nam Cao
2026-01-19 20:45 ` [PATCH 10/26] rv/rvgen: fix typos in automata docstring and comments Wander Lairson Costa
2026-01-22 14:58   ` Nam Cao
2026-01-19 20:45 ` [PATCH 11/26] rv/rvgen: fix typo in generator module docstring Wander Lairson Costa
2026-01-20  7:51   ` Gabriele Monaco
2026-01-22 14:59   ` Nam Cao
2026-01-19 20:45 ` [PATCH 12/26] rv/rvgen: fix PEP 8 whitespace violations Wander Lairson Costa
2026-01-20  7:53   ` Gabriele Monaco
2026-01-22 14:59   ` Nam Cao
2026-01-19 20:45 ` [PATCH 13/26] rv/rvgen: fix DOT file validation logic error Wander Lairson Costa
2026-01-20  7:56   ` Gabriele Monaco
2026-01-22 15:01   ` Nam Cao
2026-01-19 20:45 ` [PATCH 14/26] rv/rvgen: remove redundant initial_state removal Wander Lairson Costa
2026-01-20  8:01   ` Gabriele Monaco
2026-01-20 12:05     ` Wander Lairson Costa
2026-01-19 20:45 ` [PATCH 15/26] rv/rvgen: use class constant for init marker Wander Lairson Costa
2026-01-20  8:06   ` Gabriele Monaco
2026-01-22 15:02   ` Nam Cao
2026-01-19 20:45 ` [PATCH 16/26] rv/rvgen: fix unbound initial_state variable Wander Lairson Costa
2026-01-20  8:21   ` Gabriele Monaco
2026-01-20 11:42     ` Wander Lairson Costa
2026-01-20 11:53       ` Gabriele Monaco
2026-01-19 20:45 ` [PATCH 17/26] rv/rvgen: fix possibly unbound variable in ltl2k Wander Lairson Costa
2026-01-20  8:59   ` Gabriele Monaco
2026-01-20 11:37     ` Wander Lairson Costa
2026-01-20 12:30       ` Gabriele Monaco
2026-01-20 19:38         ` Wander Lairson Costa
2026-01-21  6:31           ` Gabriele Monaco
2026-01-22 15:31   ` Nam Cao
2026-01-19 20:45 ` [PATCH 18/26] rv/rvgen: add fill_tracepoint_args_skel stub to ltl2k Wander Lairson Costa
2026-01-21 13:57   ` Gabriele Monaco
2026-01-21 17:53     ` Wander Lairson Costa
2026-01-22 13:10       ` Wander Lairson Costa
2026-01-22 13:49         ` Gabriele Monaco
2026-01-23 12:19           ` Wander Lairson Costa
2026-01-23 12:26             ` Gabriele Monaco
2026-01-23 14:04               ` Wander Lairson Costa
2026-01-19 20:45 ` [PATCH 19/26] rv/rvgen: add abstract method stubs to Container class Wander Lairson Costa
2026-01-21 13:59   ` Gabriele Monaco
2026-01-21 17:56     ` Wander Lairson Costa
2026-01-22 15:33     ` Nam Cao
2026-01-19 20:45 ` [PATCH 20/26] rv/rvgen: refactor automata.py to use iterator-based parsing Wander Lairson Costa
2026-01-20  9:43   ` Gabriele Monaco
2026-01-22 15:35     ` Nam Cao
2026-01-22 15:40       ` Gabriele Monaco
2026-01-22 16:01         ` Nam Cao
2026-01-19 20:45 ` [PATCH 21/26] rv/rvgen: remove unused sys import from dot2c Wander Lairson Costa
2026-01-20  9:16   ` Gabriele Monaco
2026-01-19 20:45 ` [PATCH 22/26] rv/rvgen: remove unused __get_main_name method Wander Lairson Costa
2026-01-20  9:08   ` Gabriele Monaco
2026-01-19 20:45 ` [PATCH 23/26] rv/rvgen: add type annotations to fix pyright errors Wander Lairson Costa
2026-01-22 15:43   ` Nam Cao
2026-01-19 20:46 ` [PATCH 24/26] rv/rvgen: make monitor arguments required in rvgen Wander Lairson Costa
2026-01-20  9:07   ` Gabriele Monaco
2026-01-22 15:44   ` Nam Cao
2026-01-19 20:46 ` [PATCH 25/26] rv/rvgen: fix isinstance check in Variable.expand() Wander Lairson Costa
2026-01-22 15:53   ` Nam Cao
2026-01-19 20:46 ` [PATCH 26/26] rv/rvgen: extract node marker string to class constant Wander Lairson Costa
2026-01-20  9:03   ` Gabriele Monaco
2026-01-20 11:34     ` Wander Lairson Costa
2026-01-20 12:36       ` Gabriele Monaco
2026-01-20 13:11         ` Gabriele Monaco
2026-01-20 18:56           ` Wander Lairson Costa
2026-01-21  6:16             ` Gabriele Monaco
2026-01-20  7:20 ` [PATCH 00/26] rv/rvgen: Robustness, modernization, and fixes Nam Cao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260119205601.105821-2-wander@redhat.com \
    --to=wander@redhat.com \
    --cc=gmonaco@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=namcao@linutronix.de \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox