[gdb] Only force INTERP_CONSOLE ui_out for breakpoint commands in MI mode
authorTom de Vries <tdevries@suse.de>
Thu, 21 Nov 2019 10:02:27 +0000 (11:02 +0100)
committerTom de Vries <tdevries@suse.de>
Thu, 21 Nov 2019 10:02:27 +0000 (11:02 +0100)
The problem reported in PR mi/25055 is that the output of the backtrace
command, when executed as breakpoint command does not show when executing
using the MI interpreter:
...
$ gdb a.out
Reading symbols from a.out...
(gdb) break main
Breakpoint 1 at 0x4003c0: file test.c, line 19.
(gdb) commands
Type commands for breakpoint(s) 1, one per line.
End with a line saying just "end".
>bt
>end
(gdb) interpreter-exec mi "-exec-run"
^done

Breakpoint 1, main () at test.c:19
19        return foo (4);
(gdb)
...

Interestingly, the function print_frame is called twice during -exec-run:
- once during tui_on_normal_stop where the ui_out is temporarily set to
  tui->interp_ui_out (), resulting in the part after the comma in
  "Breakpoint 1, main () at test.c:19"
- once during execute_control_command, where the ui_out is the default for the
  current interpreter: mi_ui_out, which ignores calls to output text.

The commit 3a87ae656c2 "Use console uiout when executing breakpoint commands"
fixes the problem by temporarily switching to the ui_out of INTERP_CONSOLE in
execute_control_command.

This however caused a regression in redirection (escaping '#' using '\' for
git commit message convenience):
...
$ rm -f gdb.txt; gdb a.out
Reading symbols from a.out...
(gdb) break main
Breakpoint 1 at 0x4003c0: file test.c, line 19.
(gdb) commands
Type commands for breakpoint(s) 1, one per line.
End with a line saying just "end".
>bt
>end
(gdb) set logging redirect on
(gdb) set logging on
Redirecting output to gdb.txt.
Copying debug output to gdb.txt.
(gdb) run
\#0  main () at test.c:19
(gdb) q
A debugging session is active.

        Inferior 1 [process 22428] will be killed.

Quit anyway? (y or n) y
$ cat gdb.txt
Starting program: /data/gdb_versions/devel/a.out

Breakpoint 1, main () at test.c:19
19        return foo (4);
...

The problem is that the '#0  main () at test.c:19' ends up in the gdb output
output rather than in gdb.txt.  This is due to the fact that the redirect is
setup for the current ui_out (which is tui->interp_ui_out ()), while the
backtrace output is printed to the INTERP_CONSOLE ui_out.

Fix this by limiting switching to INTERP_CONSOLE ui_out to when INTERP_MI is
active.

Tested on x86_64-linux.

gdb/ChangeLog:

2019-11-21  Tom de Vries  <tdevries@suse.de>

PR gdb/24956
* cli/cli-script.c (execute_control_command): Only switch to
INTERP_CONSOLE's ui_out when INTERP_MI is active.

gdb/testsuite/ChangeLog:

2019-11-21  Tom de Vries  <tdevries@suse.de>

PR gdb/24956
* gdb.base/ui-redirect.exp: Test output of user-defined command.

Change-Id: Id1771e7fcc9496a7d97ec2b2ea6b1487596f1ef7

gdb/ChangeLog
gdb/cli/cli-script.c
gdb/testsuite/ChangeLog
gdb/testsuite/gdb.base/ui-redirect.exp

index cf65de2e21134eeb8d3ceedc6a60a088d07b003b..3652685986fb75ba36e3ea4d070c6e71d8382254 100644 (file)
@@ -1,3 +1,9 @@
+2019-11-21  Tom de Vries  <tdevries@suse.de>
+
+       PR gdb/24956
+       * cli/cli-script.c (execute_control_command): Only switch to
+       INTERP_CONSOLE's ui_out when INTERP_MI is active.
+
 2019-11-19  Tom Tromey  <tom@tromey.com>
 
        * tui/tui-win.c (tui_partial_win_by_name): Move from tui-data.c.
index 316aca0f274772016a6c587a808e3e092e908448..06cdcd6bfe5c3f3a90f912a2ecc449b1b708f361 100644 (file)
@@ -696,6 +696,9 @@ execute_control_command_1 (struct command_line *cmd, int from_tty)
 enum command_control_type
 execute_control_command (struct command_line *cmd, int from_tty)
 {
+  if (!current_uiout->is_mi_like_p ())
+    return execute_control_command_1 (cmd, from_tty);
+
   /* Make sure we use the console uiout.  It's possible that we are executing
      breakpoint commands while running the MI interpreter.  */
   interp *console = interp_lookup (current_ui, INTERP_CONSOLE);
index f47ed172a640158d5bbf26ac7e543fe88e636eb4..16027e474981d62b66940f01c722dab9e48685a1 100644 (file)
@@ -1,3 +1,8 @@
+2019-11-21  Tom de Vries  <tdevries@suse.de>
+
+       PR gdb/24956
+       * gdb.base/ui-redirect.exp: Test output of user-defined command.
+
 2019-11-20  Sergio Durigan Junior  <sergiodj@redhat.com>
 
        * gdb.python/py-progspace.exp: Add missing parentheses on some
index efcac14b7ccbb05b08250ff2793e59c414c8b312..932c74af4b57df1cb1949947338e705483f6ca87 100644 (file)
@@ -57,6 +57,24 @@ set cmds "$cmds\n"
 set outdir [standard_output_file {}]
 set cmds_file "$outdir/cmds.txt"
 
+with_test_prefix "userdefined" {
+    set test "define userdefined"
+    gdb_test_multiple $test $test {
+       -re "End with a line saying just \"end\"\\.\r\n>$" {
+           pass $test
+       }
+    }
+
+    set test "bt"
+    gdb_test_multiple $test $test {
+       -re "\r\n>$" {
+           pass $test
+       }
+    }
+
+    gdb_test_no_output "end"
+}
+
 with_test_prefix "logging" {
     gdb_test_no_output "set logging file /dev/null"
     gdb_test "set logging on" \
@@ -64,6 +82,7 @@ with_test_prefix "logging" {
     gdb_test "save breakpoints $cmds_file" "Saved to file '$cmds_file'\\." \
        "save breakpoints cmds.txt"
     cmp_file_string "$cmds_file" "$cmds" "cmds.txt"
+    gdb_test "userdefined" "#0  main ().*"
     gdb_test "set logging off" "Done logging to /dev/null\\."
     gdb_test "help" "List of classes of commands:.*"
 }
@@ -74,6 +93,7 @@ with_test_prefix "redirect" {
     "Redirecting output to /dev/null.*Copying debug output to /dev/null\\."
     gdb_test_no_output "save breakpoints $cmds_file" "save breakpoints cmds.txt"
     cmp_file_string "$cmds_file" "$cmds" "cmds.txt"
+    gdb_test_no_output "userdefined"
     gdb_test "set logging off" "Done logging to /dev/null\\."
     gdb_test "help" "List of classes of commands:.*"
 }
@@ -87,6 +107,7 @@ with_test_prefix "redirect while already logging" {
     gdb_test "save breakpoints $cmds_file" "Saved to file '$cmds_file'\\." \
        "save breakpoints cmds.txt"
     cmp_file_string "$cmds_file" "$cmds" "cmds.txt"
+    gdb_test "userdefined" "#0  main ().*"
     gdb_test "set logging off" "Done logging to /dev/null\\."
     gdb_test "help" "List of classes of commands:.*"
     gdb_test_no_output "set logging redirect off"