1# Copyright 1999, 2000, 2001, 2002, 2004 Free Software Foundation, Inc.
2
3# This program is free software; you can redistribute it and/or modify
4# it under the terms of the GNU General Public License as published by
5# the Free Software Foundation; either version 2 of the License, or
6# (at your option) any later version.
7#
8# This program is distributed in the hope that it will be useful,
9# but WITHOUT ANY WARRANTY; without even the implied warranty of
10# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11# GNU General Public License for more details.
12#
13# You should have received a copy of the GNU General Public License
14# along with this program; if not, write to the Free Software
15# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
16
17#
18# Test essential Machine interface (MI) operations
19#
20# Verify that, using the MI, we can run a simple program and perform basic
21# debugging activities like: insert breakpoints, run the program,
22# step, next, continue until it ends and, last but not least, quit.
23#
24# The goal is not to test gdb functionality, which is done by other tests,
25# but to verify the correct output response to MI operations.
26#
27
28load_lib mi-support.exp
29set MIFLAGS "-i=mi"
30
31gdb_exit
32if [mi_gdb_start] {
33    continue
34}
35
36set testfile "basics"
37set srcfile ${testfile}.c
38set binfile ${objdir}/${subdir}/${testfile}
39if  { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable {debug additional_flags=-DFAKEARGV}] != "" } {
40     gdb_suppress_entire_file "Testcase compile failed, so all tests in this file will automatically fail."
41}
42
43mi_delete_breakpoints
44mi_gdb_reinitialize_dir $srcdir/$subdir
45mi_gdb_reinitialize_dir $srcdir/$subdir
46mi_gdb_load ${binfile}
47
48proc test_breakpoints_creation_and_listing {} {
49    global mi_gdb_prompt
50    global srcfile
51    global hex
52
53    set line_callee4_head  [gdb_get_line_number "callee4 ("]
54    set line_callee3_head  [gdb_get_line_number "callee3 ("]
55    set line_callee2_head  [gdb_get_line_number "callee2 ("]
56    set line_callee2_body  [expr $line_callee2_head + 2]
57    set line_main_head     [gdb_get_line_number "main ("]
58    set line_main_body     [expr $line_main_head + 2]
59
60    # Insert some breakpoints and list them
61    # Also, disable some so they do not interfere with other tests
62    # Tests:
63    # -break-insert
64    # -break-list
65    # -break-disable
66    # -break-info
67
68    mi_gdb_test "200-break-insert main" \
69             "200\\^done,bkpt=\{number=\"1\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"main\",file=\".*basics.c\",line=\"$line_main_body\",times=\"0\"\}" \
70             "break-insert operation"
71
72    mi_gdb_test "201-break-insert basics.c:callee2" \
73             "201\\^done,bkpt=\{number=\"2\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"callee2\",file=\".*basics.c\",line=\"$line_callee2_body\",times=\"0\"\}" \
74             "insert breakpoint at basics.c:callee2"
75
76    mi_gdb_test "202-break-insert basics.c:$line_callee3_head" \
77             "202\\^done,bkpt=\{number=\"3\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"callee3\",file=\".*basics.c\",line=\"$line_callee3_head\",times=\"0\"\}" \
78             "insert breakpoint at basics.c:\$line_callee3_head"
79
80    mi_gdb_test "203-break-insert \"\\\"${srcfile}\\\":$line_callee4_head\"" \
81             "203\\^done,bkpt=\{number=\"4\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"callee4\",file=\".*basics.c\",line=\"$line_callee4_head\",times=\"0\"\}" \
82             "insert breakpoint at \"<fullfilename>\":\$line_callee4_head"
83
84    mi_gdb_test "204-break-list" \
85	    "204\\^done,BreakpointTable=\{.*,hdr=\\\[.*\\\],body=\\\[bkpt=\{number=\"1\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"main\",file=\".*basics.c\",line=\"$line_main_body\",times=\"0\"\},.*\}\\\]\}" \
86                "list of breakpoints"
87
88    mi_gdb_test "205-break-disable 2 3 4" \
89                "205\\^done.*" \
90                "disabling of breakpoints"
91
92    mi_gdb_test "206-break-info 2" \
93	    "206\\^done,BreakpointTable=\{.*,hdr=\\\[.*\\\],body=\\\[bkpt=\{number=\"2\",.*,enabled=\"n\",.*\}\\\]\}" \
94                "list of breakpoints, 16 disabled"
95}
96
97proc test_running_the_program {} {
98    global mi_gdb_prompt
99    global hex
100
101    set line_main_head     [gdb_get_line_number "main ("]
102    set line_main_body     [expr $line_main_head + 2]
103
104    # Run the program without args, then specify srgs and rerun the program
105    # Tests:
106    # -exec-run
107    # -gdb-set
108
109    # mi_gdb_test cannot be used for asynchronous commands because there are
110    # two prompts involved and this can lead to a race condition.
111    # The following is equivalent to a send_gdb "000-exec-run\n"
112    mi_run_cmd
113    gdb_expect {
114	-re "000\\*stopped,reason=\"breakpoint-hit\",bkptno=\"1\",thread-id=\"\[01\]\",frame=\{addr=\"$hex\",func=\"main\",args=\\\[\\\],file=\".*basics.c\",line=\"$line_main_body\"\}\r\n$mi_gdb_prompt$" {
115	    pass "run to main"
116	}
117	-re ".*$mi_gdb_prompt$" {
118	    fail "run to main (2)"
119	}
120	timeout {
121	    fail "run to main (timeout)"
122	}
123    }
124}
125
126proc test_controlled_execution {} {
127    global mi_gdb_prompt
128    global hex
129
130    set line_callee4_head         [gdb_get_line_number "callee4 ("]
131    set line_callee4_body         [expr $line_callee4_head + 2]
132    set line_callee3_head         [gdb_get_line_number "callee3 ("]
133    set line_callee3_close_brace  [expr $line_callee3_head + 3]
134    set line_callee1_head         [gdb_get_line_number "callee1 ("]
135    set line_callee1_body         [expr $line_callee1_head + 2]
136    set line_main_head            [gdb_get_line_number "main ("]
137    set line_main_body            [expr $line_main_head + 2]
138
139    # Continue execution until a breakpoint is reached, step into calls, verifying
140    # if the arguments are correctly shown, continue to the end of a called
141    # function, step over a call (next).
142    # Tests:
143    # -exec-continue
144    # -exec-next
145    # -exec-step
146    # -exec-finish
147
148    mi_next_to "main" "" "basics.c" [expr $line_main_body + 1] "next at main"
149
150    # FIXME: A string argument is not printed right; should be fixed and
151    #        we should look for the right thing here.
152    # NOTE: The ``\\\\\"'' is for \".
153    mi_step_to "callee1" \
154	"\{name=\"intarg\",value=\"2\"\},\{name=\"strarg\",value=\"$hex \\\\\"A string argument\.\\\\\"\"\},\{name=\"fltarg\",value=\"3.5\"\}" \
155	"basics.c" "$line_callee1_body" "step at main"
156
157    # FIXME: A string argument is not printed right; should be fixed and
158    #        we should look for the right thing here.
159    mi_execute_to "exec-step 3" "end-stepping-range" "callee4" "" \
160	"basics.c" $line_callee4_body "" "step to callee4"
161
162    # FIXME: A string argument is not printed right; should be fixed and
163    #        we should look for the right thing here.
164    # NOTE: The ``.'' is part of ``gdb-result-var="$1"''
165    mi_finish_to "callee3" ".*" "basics.c" $line_callee3_close_brace ".1" "0" "exec-finish"
166}
167
168proc test_controlling_breakpoints {} {
169    global mi_gdb_prompt
170
171    # Enable, delete, set ignore counts in breakpoints
172    # (disable was already tested above)
173    # Tests:
174    # -break-delete
175    # -break-enable
176    # -break-after
177    # -break-condition
178
179}
180
181proc test_program_termination {} {
182    global mi_gdb_prompt
183
184    # Run to completion: normal and forced
185    # Tests:
186    # -exec-abort
187    # (normal termination of inferior)
188
189    # FIXME: "stopped" doesn't seem appropriate.
190    # mi_gdb_test cannot be used for asynchronous commands because there are
191    # two prompts involved and this can lead to a race condition.
192    send_gdb "999-exec-continue\n"
193    gdb_expect {
194      -re "999\\^running\r\n$mi_gdb_prompt" {
195        gdb_expect {
196          -re "999\\*stopped,reason=\"exited-normally\"\r\n$mi_gdb_prompt$" {
197            pass "continue to end"
198          }
199          -re ".*$mi_gdb_prompt$" {fail "continue to end (2)"}
200          timeout {fail "continue to end (timeout 2)"}
201        }
202      }
203      -re ".*$mi_gdb_prompt$" {fail "continue to end (1)"}
204      timeout {fail "continue to end (timeout 1)"}
205    }
206}
207
208test_breakpoints_creation_and_listing
209test_running_the_program
210test_controlled_execution
211test_controlling_breakpoints
212test_program_termination
213
214mi_gdb_exit
215return 0
216