Skip to contentSkip to conversation

lib: Extend -D flag to support multiple debug levels

PATCH Superseded Li Wang via ltp 2 participants 5 messages Mar 1 – Mar 3 Library code

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 lib: Extend -D flag to support multiple debug levels

This patch extends the LTP debugging framework by introducing multiple levels of verbosity for the '-D' command line option. Instead of a simple on/off toggle, it now allows developers to specify whether they want debug output exclusively from the test process, or from both the test and library processes.

The supported debug levels are:
-D0 : Disable all debug logs (default behavior)
-D1 (-D): Enable debug logs for the test process only
-D2 : Enable verbose debug logs for both the test and library processes

---
 doc/developers/debugging.rst |  6 ++++++
 lib/tst_test.c               | 25 +++++++++++++++----------
 2 files changed, 21 insertions(+), 10 deletions(-)
doc/developers/debugging.rst +6 -0
index 181e5b096..8b5550b73 100644
@@ -12,6 +12,12 @@ The LTP framework supports ``TDEBUG`` flag test debug messages. These
 messages can be enabled using the ``-D`` parameter or setting ``LTP_ENABLE_DEBUG=1``
 environment variable (see :doc:`../users/setup_tests`).
 
+The ``-D`` parameter also supports the following verbosity levels:
+
+  ``-D0``: Disable all debug logs (default behavior).
+  ``-D1`` (or ``-D``): Enable debug logs for the test process only.
+  ``-D2``: Enable verbose debug logs for both the test and library processes.
+
 Tracing and debugging syscalls
 ------------------------------
 
lib/tst_test.c +15 -10
index 239494b6f..f7907223e 100644
@@ -83,7 +83,7 @@ struct context {
 	tst_atomic_t abort_flag;
 	uint32_t mntpoint_mounted:1;
 	uint32_t ovl_mounted:1;
-	uint32_t tdebug:1;
+	uint32_t tdebug;
 };
 
 struct results {
@@ -217,7 +217,7 @@ void tst_reinit(void)
 	tst_max_futexes = (size - offsetof(struct ipc_region, futexes)) / sizeof(futex_t);
 
 	if (context->tdebug)
-		tst_res(TINFO, "Restored metadata for PID %d", getpid());
+		tst_res(TDEBUG, "Restored metadata for PID %d", getpid());
 }
 
 extern char **environ;
@@ -490,19 +490,20 @@ void tst_res_(const char *file, const int lineno, int ttype,
 	va_list va;
 
 	/*
-	 * Suppress TDEBUG output in these cases:
+	 * Control TDEBUG output in these cases:
 	 * 1. No context available (e.g., called before IPC initialization)
-	 * 2. Called from the library process, unless explicitly enabled
-	 * 3. Debug output is not enabled (context->tdebug == 0)
+	 * 2. Debug output is completely disabled (context->tdebug == 0).
+	 * 3. Debug output is only for test process (context->tdebug == 1).
+	 * 4. Debug output is enabled for both test and lib processes (context->tdebug == 2).
 	 */
 	if (ttype == TDEBUG) {
 		if (!context)
 			return;
 
-		if (context->lib_pid == getpid())
+		if (context->tdebug == 0)
 			return;
 
-		if (!context->tdebug)
+		if (context->tdebug == 1 && context->lib_pid == getpid())
 			return;
 	}
 
@@ -657,7 +658,7 @@ static struct option {
 	{"h",  "-h       Prints this help"},
 	{"i:", "-i n     Execute test n times"},
 	{"I:", "-I x     Execute test for n seconds"},
-	{"D",  "-D       Prints debug information"},
+	{"D::", "-D[0-2]  Prints debug information"},
 	{"V",  "-V       Prints LTP version"},
 };
 
@@ -825,8 +826,12 @@ static void parse_opts(int argc, char *argv[])
 			tst_brk(TBROK, "Invalid option");
 		break;
 		case 'D':
-			tst_res(TINFO, "Enabling debug info");
-			context->tdebug = 1;
+			if (optarg)
+				context->tdebug = SAFE_STRTOL(optarg, 0, 2);
+			else
+				context->tdebug = 1;
+
+			tst_res(TINFO, "Enabling debug info (level %d)", context->tdebug);
 		break;
 		case 'h':
 			print_help();
Signature · 5 lines
2.53.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi!

Quoted 48 lines

This patch extends the LTP debugging framework by introducing multiple levels of verbosity for the '-D' command line option. Instead of a simple on/off toggle, it now allows developers to specify whether they want debug output exclusively from the test process, or from both the test and library processes.

The supported debug levels are:
-D0 : Disable all debug logs (default behavior)
-D1 (-D): Enable debug logs for the test process only
-D2 : Enable verbose debug logs for both the test and library processes

---
 doc/developers/debugging.rst |  6 ++++++
 lib/tst_test.c               | 25 +++++++++++++++----------
 2 files changed, 21 insertions(+), 10 deletions(-)
doc/developers/debugging.rst +6 -0
index 181e5b096..8b5550b73 100644
@@ -12,6 +12,12 @@ The LTP framework supports ``TDEBUG`` flag test debug messages. These
 messages can be enabled using the ``-D`` parameter or setting ``LTP_ENABLE_DEBUG=1``
 environment variable (see :doc:`../users/setup_tests`).
 
+The ``-D`` parameter also supports the following verbosity levels:
+
+  ``-D0``: Disable all debug logs (default behavior).
+  ``-D1`` (or ``-D``): Enable debug logs for the test process only.
+  ``-D2``: Enable verbose debug logs for both the test and library processes.
+
 Tracing and debugging syscalls
 ------------------------------
 
lib/tst_test.c +1 -1
index 239494b6f..f7907223e 100644
@@ -83,7 +83,7 @@ struct context {
 	tst_atomic_t abort_flag;
 	uint32_t mntpoint_mounted:1;
 	uint32_t ovl_mounted:1;
-	uint32_t tdebug:1;
+	uint32_t tdebug;
 };
 
 struct results {

lib/tst_test.c void tst_reinit(void) · line 220

Quoted 5 lines
lib/tst_test.c +1 -1
@@ -217,7 +217,7 @@ void tst_reinit(void)
 	tst_max_futexes = (size - offsetof(struct ipc_region, futexes)) / sizeof(futex_t);
 
 	if (context->tdebug)
-		tst_res(TINFO, "Restored metadata for PID %d", getpid());
+		tst_res(TDEBUG, "Restored metadata for PID %d", getpid());

I suppose that we do not need the if (context->tdebug) now.

Otherwise it looks good.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw
Quoted 5 lines · Andrea Cervesato via ltp

Maybe we should also apply the same approach to the LTP_ENABLE_DEBUG environment variables, otherwise we might support only 0/1 while using it.

WDYT?

Sounds reasonable, LTP_ENABLE_DEBUG now should support '0, 1 or 2' and drop the 'y' option.

Signature · 6 lines
Regards,
Li Wang


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#4 lore raw
Quoted 9 lines · Li Wang
Quoted 5 lines · Andrea Cervesato via ltp

Maybe we should also apply the same approach to the LTP_ENABLE_DEBUG environment variables, otherwise we might support only 0/1 while using it.

WDYT?

Sounds reasonable, LTP_ENABLE_DEBUG now should support '0, 1 or 2' and drop the 'y' option.

After thinking over, the 'y option could be reserved for those who are already familiar with its usage, just like the '-D' option represents '-D1'.

Signature · 6 lines
Regards,
Li Wang


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp