[PATCH] Fix PR16508

[PATCH] Fix PR16508

[Yao Qi]

This patch fixes PR16508, which is about MI "-trace-find frame-number 0"
behaves differently from CLI "tfind 0".  In CLI, we check both
status->running and status->filename, but in MI, we only check
status->running, which looks wrong to me.  This patch moves the code
of checking to a new function check_trace_running, and use it in
both CLI and MI.

This patch also adds a test case pr16508.exp, which fails without this
fix, and passes with the fix applied.

  FAIL: gdb.trace/pr16508.exp: interpreter-exec mi "-trace-find frame-number 0"

Patch is regression tested on x86_64-linux.

gdb:

2014-02-15  Yao Qi  <yao@codesourcery.com>

	PR breakpoints/16508
	* tracepoint.c (check_trace_running): New function.
	(trace_find_command): Move code to check_trace_running and
	call check_trace_running.
	(trace_find_pc_command): Likewise.
	(trace_find_tracepoint_command): Likewise.
	(trace_find_line_command): Likewise.
	(trace_find_range_command): Likewise.
	* tracepoint.h (check_trace_running): Likewise.
	* mi/mi-main.c (mi_cmd_trace_find): Call check_trace_running.

gdb/testsuite:

2014-02-15  Yao Qi  <yao@codesourcery.com>

	* gdb.trace/pr16508.exp: New file.
---
 gdb/mi/mi-main.c                    |    3 +-
 gdb/testsuite/gdb.trace/pr16508.exp |   65 +++++++++++++++++++++++++++++++++++
 gdb/tracepoint.c                    |   29 +++++++--------
 gdb/tracepoint.h                    |    2 +
 4 files changed, 82 insertions(+), 17 deletions(-)
 create mode 100644 gdb/testsuite/gdb.trace/pr16508.exp

diff --git a/gdb/mi/mi-main.c b/gdb/mi/mi-main.c
index 6983e49..8941743 100644
--- a/gdb/mi/mi-main.c
+++ b/gdb/mi/mi-main.c
@@ -2484,8 +2484,7 @@ mi_cmd_trace_find (char *command, char **argv, int argc)
       return;
     }
 
-  if (current_trace_status ()->running)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (strcmp (mode, "frame-number") == 0)
     {
diff --git a/gdb/testsuite/gdb.trace/pr16508.exp b/gdb/testsuite/gdb.trace/pr16508.exp
new file mode 100644
index 0000000..2a21239
--- /dev/null
+++ b/gdb/testsuite/gdb.trace/pr16508.exp
@@ -0,0 +1,65 @@
+# Copyright 2014 Free Software Foundation, Inc.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+load_lib "trace-support.exp"
+
+standard_testfile read-memory.c
+set executable $testfile
+set expfile pr16508.exp
+
+if [prepare_for_testing $expfile $executable $srcfile \
+	[list debug]] {
+    untested "failed to prepare for trace tests"
+    return -1
+}
+
+if ![runto_main] {
+    fail "Can't run to main to check for trace support"
+    return -1
+}
+
+if ![gdb_target_supports_trace] {
+    unsupported "target does not support trace"
+    return -1
+}
+
+gdb_test "trace start" ".*"
+gdb_breakpoint "end"
+
+gdb_test_no_output "tstart"
+
+gdb_test "continue" ".*Breakpoint \[0-9\]+, end .*"
+
+set tracefile [standard_output_file ${testfile}]
+
+# Save trace frames to tfile.
+gdb_test "tsave ${tracefile}.tf" \
+    "Trace data saved to file '${tracefile}.tf'.*" \
+    "save tfile trace file"
+
+# Change target to tfile.
+set test "change to tfile target"
+gdb_test_multiple "target tfile ${tracefile}.tf" "$test" {
+    -re "A program is being debugged already.  Kill it. .y or n. " {
+	send_gdb "y\n"
+	exp_continue
+    }
+    -re "$gdb_prompt $" {
+	pass "$test"
+    }
+}
+
+gdb_test "tfind 0" "Found trace frame 0, tracepoint .*"
+
+gdb_test "interpreter-exec mi \"-trace-find frame-number 0\"" "done.*"
diff --git a/gdb/tracepoint.c b/gdb/tracepoint.c
index 80d0620..8cd5b74 100644
--- a/gdb/tracepoint.c
+++ b/gdb/tracepoint.c
@@ -2447,6 +2447,15 @@ tfind_1 (enum trace_find_type type, int num,
     }
 }
 
+/* Error on looking at traceframes while trace is running.  */
+
+void
+check_trace_running (struct trace_status *status)
+{
+  if (status->running && status->filename == NULL)
+    error (_("May not look at trace frames while trace is running."));
+}
+
 /* trace_find_command takes a trace frame number n, 
    sends "QTFrame:<n>" to the target, 
    and accepts a reply that may contain several optional pieces
@@ -2467,9 +2476,7 @@ trace_find_command (char *args, int from_tty)
 { /* This should only be called with a numeric argument.  */
   int frameno = -1;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
   
   if (args == 0 || *args == 0)
     { /* TFIND with no args means find NEXT trace frame.  */
@@ -2519,9 +2526,7 @@ trace_find_pc_command (char *args, int from_tty)
 {
   CORE_ADDR pc;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     pc = regcache_read_pc (get_current_regcache ());
@@ -2538,9 +2543,7 @@ trace_find_tracepoint_command (char *args, int from_tty)
   int tdp;
   struct tracepoint *tp;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     {
@@ -2578,9 +2581,7 @@ trace_find_line_command (char *args, int from_tty)
   struct symtab_and_line sal;
   struct cleanup *old_chain;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     {
@@ -2644,9 +2645,7 @@ trace_find_range_command (char *args, int from_tty)
   static CORE_ADDR start, stop;
   char *tmp;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     { /* XXX FIXME: what should default behavior be?  */
diff --git a/gdb/tracepoint.h b/gdb/tracepoint.h
index dd9b48b..88ee3c8 100644
--- a/gdb/tracepoint.h
+++ b/gdb/tracepoint.h
@@ -434,6 +434,8 @@ extern void query_if_trace_running (int from_tty);
 extern void disconnect_tracing (void);
 extern void trace_reset_local_state (void);
 
+extern void check_trace_running (struct trace_status *);
+
 extern void start_tracing (char *notes);
 extern void stop_tracing (char *notes);
 
-- 
1.7.7.6

ping: [PATCH] Fix PR16508

[Yao Qi]

On 02/15/2014 02:56 PM, Yao Qi wrote:
> This patch fixes PR16508, which is about MI "-trace-find frame-number 0"
> behaves differently from CLI "tfind 0".  In CLI, we check both
> status->running and status->filename, but in MI, we only check
> status->running, which looks wrong to me.  This patch moves the code
> of checking to a new function check_trace_running, and use it in
> both CLI and MI.
> 
> This patch also adds a test case pr16508.exp, which fails without this
> fix, and passes with the fix applied.
> 
>   FAIL: gdb.trace/pr16508.exp: interpreter-exec mi "-trace-find frame-number 0"
> 
> Patch is regression tested on x86_64-linux.
> 
> gdb:
> 
> 2014-02-15  Yao Qi  <yao@codesourcery.com>
> 
> 	PR breakpoints/16508
> 	* tracepoint.c (check_trace_running): New function.
> 	(trace_find_command): Move code to check_trace_running and
> 	call check_trace_running.
> 	(trace_find_pc_command): Likewise.
> 	(trace_find_tracepoint_command): Likewise.
> 	(trace_find_line_command): Likewise.
> 	(trace_find_range_command): Likewise.
> 	* tracepoint.h (check_trace_running): Likewise.
> 	* mi/mi-main.c (mi_cmd_trace_find): Call check_trace_running.
> 
> gdb/testsuite:
> 
> 2014-02-15  Yao Qi  <yao@codesourcery.com>
> 
> 	* gdb.trace/pr16508.exp: New file.

Ping.  https://sourceware.org/ml/gdb-patches/2014-02/msg00508.html

-- 
Yao (齐尧)

Re: [PATCH] Fix PR16508

[Tom Tromey]

>>>>> "Yao" == Yao Qi <yao@codesourcery.com> writes:

Yao> 2014-02-15  Yao Qi  <yao@codesourcery.com>
Yao> 	PR breakpoints/16508
Yao> 	* tracepoint.c (check_trace_running): New function.
Yao> 	(trace_find_command): Move code to check_trace_running and
Yao> 	call check_trace_running.
Yao> 	(trace_find_pc_command): Likewise.
Yao> 	(trace_find_tracepoint_command): Likewise.
Yao> 	(trace_find_line_command): Likewise.
Yao> 	(trace_find_range_command): Likewise.
Yao> 	* tracepoint.h (check_trace_running): Likewise.
Yao> 	* mi/mi-main.c (mi_cmd_trace_find): Call check_trace_running.

One trivial nit here.

Yao> +if [prepare_for_testing $expfile $executable $srcfile \
Yao> +	[list debug]] {
Yao> +    untested "failed to prepare for trace tests"

prepare calls untested for you, so no need to do it again.

Ok with this change.

Tom

Re: [PATCH] Fix PR16508

[Pedro Alves]

On 03/05/2014 08:03 PM, Tom Tromey wrote:

> Yao> +if [prepare_for_testing $expfile $executable $srcfile \
> Yao> +	[list debug]] {
> Yao> +    untested "failed to prepare for trace tests"
> 
> prepare calls untested for you, so no need to do it again.

Note that the first argument to prepare_for_testing is
what is passed to untested (and really only used for that),
so a better alternative even is to do:

if [prepare_for_testing "failed to prepare for trace tests" \
	$executable $srcfile [list debug]] {

Although we do that all over the place, passing $expfile
to untested is useless, as that information will be
in the gdb.sum before UNTESTED anyway.

I'd support us starting to use this pattern more.

-- 
Pedro Alves

Re: [PATCH] Fix PR16508

[Yao Qi]

On 03/06/2014 04:33 AM, Pedro Alves wrote:
> Note that the first argument to prepare_for_testing is
> what is passed to untested (and really only used for that),
> so a better alternative even is to do:
> 
> if [prepare_for_testing "failed to prepare for trace tests" \
> 	$executable $srcfile [list debug]] {
> 
> Although we do that all over the place, passing $expfile
> to untested is useless, as that information will be
> in the gdb.sum before UNTESTED anyway.
> 
> I'd support us starting to use this pattern more.

OK, let us use this pattern.  Patch below is pushed in.

-- 
Yao (齐尧)

commit ccd34f75c5f6e05469f80ceece793de62fdf66db
Author: Yao Qi <yao@codesourcery.com>
Date:   Sat Feb 15 08:48:53 2014 +0800

    Fix PR16508
    
    This patch fixes PR16508, which is about MI "-trace-find frame-number 0"
    behaves differently from CLI "tfind 0".  In CLI, we check both
    status->running and status->filename, but in MI, we only check
    status->running, which looks wrong to me.  This patch moves the code
    of checking to a new function check_trace_running, and use it in
    both CLI and MI.
    
    This patch also adds a test case pr16508.exp, which fails without this
    fix, and passes with the fix applied.
    
      FAIL: gdb.trace/pr16508.exp: interpreter-exec mi "-trace-find frame-number 0"
    
    gdb:
    
    2014-03-06  Yao Qi  <yao@codesourcery.com>
    
    	PR breakpoints/16508
    	* tracepoint.c (check_trace_running): New function.
    	(trace_find_command): Move code to check_trace_running and
    	call check_trace_running.
    	(trace_find_pc_command): Likewise.
    	(trace_find_tracepoint_command): Likewise.
    	(trace_find_line_command): Likewise.
    	(trace_find_range_command): Likewise.
    	* tracepoint.h (check_trace_running): Likewise.
    	* mi/mi-main.c (mi_cmd_trace_find): Call check_trace_running.
    
    gdb/testsuite:
    
    2014-03-06  Yao Qi  <yao@codesourcery.com>
    
    	* gdb.trace/pr16508.exp: New file.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index e3911e9..b5a92fb 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,18 @@
 2014-03-06  Yao Qi  <yao@codesourcery.com>
 
+	PR breakpoints/16508
+	* tracepoint.c (check_trace_running): New function.
+	(trace_find_command): Move code to check_trace_running and
+	call check_trace_running.
+	(trace_find_pc_command): Likewise.
+	(trace_find_tracepoint_command): Likewise.
+	(trace_find_line_command): Likewise.
+	(trace_find_range_command): Likewise.
+	* tracepoint.h (check_trace_running): Likewise.
+	* mi/mi-main.c (mi_cmd_trace_find): Call check_trace_running.
+
+2014-03-06  Yao Qi  <yao@codesourcery.com>
+
 	* target.h (struct target_ops) <to_traceframe_info>: Use
 	TARGET_DEFAULT_NORETURN (tcomplain ()).
 	* target-delegates.c: Regenerated.
diff --git a/gdb/mi/mi-main.c b/gdb/mi/mi-main.c
index 6983e49..8941743 100644
--- a/gdb/mi/mi-main.c
+++ b/gdb/mi/mi-main.c
@@ -2484,8 +2484,7 @@ mi_cmd_trace_find (char *command, char **argv, int argc)
       return;
     }
 
-  if (current_trace_status ()->running)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (strcmp (mode, "frame-number") == 0)
     {
diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index 65b4f95..a078554 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,3 +1,7 @@
+2014-03-06  Yao Qi  <yao@codesourcery.com>
+
+	* gdb.trace/pr16508.exp: New file.
+
 2014-03-05  Pedro Alves  <palves@redhat.com>
 
 	PR gdb/16575
diff --git a/gdb/testsuite/gdb.trace/pr16508.exp b/gdb/testsuite/gdb.trace/pr16508.exp
new file mode 100644
index 0000000..ff01b40
--- /dev/null
+++ b/gdb/testsuite/gdb.trace/pr16508.exp
@@ -0,0 +1,63 @@
+# Copyright 2014 Free Software Foundation, Inc.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+load_lib "trace-support.exp"
+
+standard_testfile read-memory.c
+set executable $testfile
+
+if [prepare_for_testing "failed to prepare for trace tests" \
+	$executable $srcfile [list debug]] {
+    return -1
+}
+
+if ![runto_main] {
+    fail "Can't run to main to check for trace support"
+    return -1
+}
+
+if ![gdb_target_supports_trace] {
+    unsupported "target does not support trace"
+    return -1
+}
+
+gdb_test "trace start" ".*"
+gdb_breakpoint "end"
+
+gdb_test_no_output "tstart"
+
+gdb_test "continue" ".*Breakpoint \[0-9\]+, end .*"
+
+set tracefile [standard_output_file ${testfile}]
+
+# Save trace frames to tfile.
+gdb_test "tsave ${tracefile}.tf" \
+    "Trace data saved to file '${tracefile}.tf'.*" \
+    "save tfile trace file"
+
+# Change target to tfile.
+set test "change to tfile target"
+gdb_test_multiple "target tfile ${tracefile}.tf" "$test" {
+    -re "A program is being debugged already.  Kill it. .y or n. " {
+	send_gdb "y\n"
+	exp_continue
+    }
+    -re "$gdb_prompt $" {
+	pass "$test"
+    }
+}
+
+gdb_test "tfind 0" "Found trace frame 0, tracepoint .*"
+
+gdb_test "interpreter-exec mi \"-trace-find frame-number 0\"" "done.*"
diff --git a/gdb/tracepoint.c b/gdb/tracepoint.c
index 51d59b6..cea40e3 100644
--- a/gdb/tracepoint.c
+++ b/gdb/tracepoint.c
@@ -2443,6 +2443,15 @@ tfind_1 (enum trace_find_type type, int num,
     }
 }
 
+/* Error on looking at traceframes while trace is running.  */
+
+void
+check_trace_running (struct trace_status *status)
+{
+  if (status->running && status->filename == NULL)
+    error (_("May not look at trace frames while trace is running."));
+}
+
 /* trace_find_command takes a trace frame number n, 
    sends "QTFrame:<n>" to the target, 
    and accepts a reply that may contain several optional pieces
@@ -2463,9 +2472,7 @@ trace_find_command (char *args, int from_tty)
 { /* This should only be called with a numeric argument.  */
   int frameno = -1;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
   
   if (args == 0 || *args == 0)
     { /* TFIND with no args means find NEXT trace frame.  */
@@ -2515,9 +2522,7 @@ trace_find_pc_command (char *args, int from_tty)
 {
   CORE_ADDR pc;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     pc = regcache_read_pc (get_current_regcache ());
@@ -2534,9 +2539,7 @@ trace_find_tracepoint_command (char *args, int from_tty)
   int tdp;
   struct tracepoint *tp;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     {
@@ -2574,9 +2577,7 @@ trace_find_line_command (char *args, int from_tty)
   struct symtab_and_line sal;
   struct cleanup *old_chain;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     {
@@ -2640,9 +2641,7 @@ trace_find_range_command (char *args, int from_tty)
   static CORE_ADDR start, stop;
   char *tmp;
 
-  if (current_trace_status ()->running
-      && current_trace_status ()->filename == NULL)
-    error (_("May not look at trace frames while trace is running."));
+  check_trace_running (current_trace_status ());
 
   if (args == 0 || *args == 0)
     { /* XXX FIXME: what should default behavior be?  */
diff --git a/gdb/tracepoint.h b/gdb/tracepoint.h
index 6b00b30..8a1abbf 100644
--- a/gdb/tracepoint.h
+++ b/gdb/tracepoint.h
@@ -334,6 +334,8 @@ extern void query_if_trace_running (int from_tty);
 extern void disconnect_tracing (void);
 extern void trace_reset_local_state (void);
 
+extern void check_trace_running (struct trace_status *);
+
 extern void start_tracing (char *notes);
 extern void stop_tracing (char *notes);

Re: [PATCH] Fix PR16508

[Joel Brobecker]

> if [prepare_for_testing "failed to prepare for trace tests" \
> 	$executable $srcfile [list debug]] {
> 
> Although we do that all over the place, passing $expfile
> to untested is useless, as that information will be
> in the gdb.sum before UNTESTED anyway.
> 
> I'd support us starting to use this pattern more.

I think that's a good idea. I've updated the Wiki's "testcase cookbook"
accordingly. My only concern with the current verbiage is copy/pasting
of existing examples will always require some additional edits to
adjust the message for the testcase. In the wiki example, I used
"[***FILL ME IN***]" which (I think) will cause a TCL error, but
the favorite programming method being copy-and-modify, I think we are
going to miss some. So perhaps something a little more generic?

-- 
Joel