gdb/testsuite/gdb.base/catch-syscall.exp

   1 #   Copyright 1997, 1999, 2007, 2008, 2010, 2011
   2 #   Free Software Foundation, Inc.
   3
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 # This program tests the 'catch syscall' functionality.
  19 #
  20 # It was written by Sergio Durigan Junior <sergiodj@linux.vnet.ibm.com>
  21 # on September/2008.
  22
  23 if { [is_remote target] || ![isnative] } then {
  24     continue
  25 }
  26
  27
  28 global srcfile
  29 set testfile "catch-syscall"
  30 set srcfile ${testfile}.c
  31 set binfile ${objdir}/${subdir}/${testfile}
  32
  33 # All (but the last) syscalls from the example code
  34 # They are ordered according to the file, so do not change this.
  35 set all_syscalls { "close" "chroot" }
  36 set all_syscalls_numbers { }
  37 # The last syscall (exit()) does not return, so
  38 # we cannot expect the catchpoint to be triggered
  39 # twice.  It is a special case.
  40 set last_syscall "exit_group"
  41
  42 if  { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable {debug}] != "" } {
  43      untested catch-syscall.exp
  44      return -1
  45 }
  46
  47 # Until "catch syscall" is implemented on other targets...
  48 if {![istarget "hppa*-hp-hpux*"] && ![istarget "*-linux*"]} then {
  49     continue
  50 }
  51
  52 # This shall be updated whenever 'catch syscall' is implemented
  53 # on some architecture.
  54 #if { ![istarget "i\[34567\]86-*-linux*"]
  55 if { ![istarget "x86_64-*-linux*"] && ![istarget "i\[34567\]86-*-linux*"]
  56      && ![istarget "powerpc-*-linux*"] && ![istarget "powerpc64-*-linux*"]
  57      && ![istarget "sparc-*-linux*"] && ![istarget "sparc64-*-linux*"]
  58      && ![istarget "mips*-linux*"] } {
  59      continue
  60 }
  61
  62 # Internal procedure used to check if, after issuing a 'catch syscall'
  63 # command (without arguments), the 'info breakpoints' command displays
  64 # that '"any syscall"' is to be caught.
  65 proc check_info_bp_any_syscall {} {
  66     global gdb_prompt
  67
  68     # Verifying that the catchpoint appears in the 'info breakpoints'
  69     # command, but with "<any syscall>".
  70     set thistest "catch syscall appears in 'info breakpoints'"
  71     gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscall \"<any syscall>\".*" $thistest
  72 }
  73
  74 # Internal procedure used to check if, after issuing a 'catch syscall X'
  75 # command (with arguments), the 'info breakpoints' command displays
  76 # that the syscall 'X' is to be caught.
  77 proc check_info_bp_specific_syscall { syscall } {
  78     global gdb_prompt
  79
  80     set thistest "syscall(s) $syscall appears in 'info breakpoints'"
  81     gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscall(\[(\]s\[)\])? (.)?${syscall}(.)?.*" $thistest
  82 }
  83
  84 # Internal procedure used to check if, after issuing a 'catch syscall X'
  85 # command (with many arguments), the 'info breakpoints' command displays
  86 # that the syscalls 'X' are to be caught.
  87 proc check_info_bp_many_syscalls { syscalls } {
  88     global gdb_prompt
  89     set filter_str ""
  90
  91     foreach name $syscalls {
  92       set filter_str "${filter_str}${name}, "
  93     }
  94
  95     set filter_str [ string trimright $filter_str ", " ]
  96
  97     set thistest "syscalls $filter_str appears in 'info breakpoints'"
  98     gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscalls (.)?${filter_str}(.)?.*" $thistest
  99 }
 100
 101 # This procedure checks if there was a call to a syscall.
 102 proc check_call_to_syscall { syscall } {
 103     global gdb_prompt
 104
 105     set thistest "program has called $syscall"
 106     gdb_test "continue" "Catchpoint .*(call to syscall .?${syscall}.?).*" $thistest
 107 }
 108
 109 # This procedure checks if the syscall returned.
 110 proc check_return_from_syscall { syscall } {
 111     global gdb_prompt
 112
 113     set thistest "syscall $syscall has returned"
 114     gdb_test "continue" "Catchpoint .*(returned from syscall (.)?${syscall}(.)?).*" $thistest
 115 }
 116
 117 # Internal procedure that performs two 'continue' commands and checks if
 118 # a syscall call AND return occur.
 119 proc check_continue { syscall } {
 120     global gdb_prompt
 121
 122     # Testing if the 'continue' stops at the
 123     # specified syscall_name.  If it does, then it should
 124     # first print that the infeior has called the syscall,
 125     # and after print that the syscall has returned.
 126
 127     # Testing if the inferiorr has called the syscall.
 128     check_call_to_syscall $syscall
 129     # And now, that the syscall has returned.
 130     check_return_from_syscall $syscall
 131 }
 132
 133 # Inserts a syscall catchpoint with an argument.
 134 proc insert_catch_syscall_with_arg { syscall } {
 135     global gdb_prompt
 136
 137     # Trying to set the catchpoint
 138     set thistest "catch syscall with arguments ($syscall)"
 139     gdb_test "catch syscall $syscall" "Catchpoint .*(syscall (.)?${syscall}(.)?( \[\[0-9\]+\])?).*" $thistest
 140
 141     check_info_bp_specific_syscall $syscall
 142 }
 143
 144 # Inserts a syscall catchpoint with many arguments.
 145 proc insert_catch_syscall_with_many_args { syscalls numbers } {
 146     global gdb_prompt
 147     set catch [ join $syscalls " " ]
 148     set filter_str ""
 149
 150     foreach name $syscalls number $numbers {
 151       set filter_str "${filter_str}'${name}' \[${number}\] "
 152     }
 153
 154     set filter_str [ string trimright $filter_str " " ]
 155
 156     # Trying to set the catchpoint
 157     set thistest "catch syscall with arguments ($filter_str)"
 158     gdb_test "catch syscall $catch" "Catchpoint .*(syscalls (.)?${filter_str}(.)?).*" $thistest
 159
 160     check_info_bp_many_syscalls $syscalls
 161 }
 162
 163 proc check_for_program_end {} {
 164     global gdb_prompt
 165
 166     # Deleting the catchpoints
 167     delete_breakpoints
 168
 169     gdb_continue_to_end
 170
 171 }
 172
 173 proc test_catch_syscall_without_args {} {
 174     global gdb_prompt all_syscalls last_syscall
 175
 176     # Trying to set the syscall
 177     set thistest "setting catch syscall without arguments"
 178     gdb_test "catch syscall" "Catchpoint .*(syscall).*" $thistest
 179
 180     check_info_bp_any_syscall
 181
 182     # We have to check every syscall
 183     foreach name $all_syscalls {
 184         check_continue $name
 185     }
 186
 187     # At last but not least, we check if the inferior
 188     # has called the last (exit) syscall.
 189     check_call_to_syscall $last_syscall
 190
 191     # Now let's see if the inferior correctly finishes.
 192     check_for_program_end
 193 }
 194
 195 proc test_catch_syscall_with_args {} {
 196     global gdb_prompt
 197     set syscall_name "close"
 198
 199     insert_catch_syscall_with_arg $syscall_name
 200
 201     # Can we continue until we catch the syscall?
 202     check_continue $syscall_name
 203
 204     # Now let's see if the inferior correctly finishes.
 205     check_for_program_end
 206 }
 207
 208 proc test_catch_syscall_with_many_args {} {
 209     global gdb_prompt all_syscalls all_syscalls_numbers
 210
 211     insert_catch_syscall_with_many_args $all_syscalls $all_syscalls_numbers
 212
 213     # Can we continue until we catch the syscalls?
 214     foreach name $all_syscalls {
 215         check_continue $name
 216     }
 217
 218     # Now let's see if the inferior correctly finishes.
 219     check_for_program_end
 220 }
 221
 222 proc test_catch_syscall_with_wrong_args {} {
 223     global gdb_prompt
 224     # mlock is not called from the source
 225     set syscall_name "mlock"
 226
 227     insert_catch_syscall_with_arg $syscall_name
 228
 229     # Now, we must verify if the program stops with a continue.
 230     # If it doesn't, everything is right (since we don't have
 231     # a syscall named "mlock" in it).  Otherwise, this is a failure.
 232     set thistest "catch syscall with unused syscall ($syscall_name)"
 233     gdb_continue_to_end $thistest
 234 }
 235
 236 proc test_catch_syscall_restarting_inferior {} {
 237     global gdb_prompt
 238     set syscall_name "chroot"
 239
 240     insert_catch_syscall_with_arg $syscall_name
 241
 242     # Let's first reach the call of the syscall.
 243     check_call_to_syscall $syscall_name
 244
 245     # Now, restart the program
 246     rerun_to_main
 247
 248     # And check for call/return
 249     check_continue $syscall_name
 250
 251     # Can we finish?
 252     check_for_program_end
 253 }
 254
 255 proc test_catch_syscall_fail_nodatadir {} {
 256     global gdb_prompt
 257
 258     # Sanitizing.
 259     delete_breakpoints
 260
 261     # Make sure GDB doesn't load the syscalls xml from the system data
 262     # directory.
 263     gdb_test_no_output "set data-directory /the/path/to/nowhere"
 264
 265     # Testing to see if we receive a warning when calling "catch syscall"
 266     # without XML support (without datadir).
 267     set thistest "Catch syscall displays a warning when there is no XML support (no datadir set)"
 268     gdb_test "catch syscall" "warning: Could not load the syscall XML file.*warning: GDB will not be able to display syscall names nor to verify if.*any provided syscall numbers are valid.*Catchpoint .*(syscall).*" $thistest
 269
 270     # Since the catchpoint was set, we must check if it's present at
 271     # "info breakpoints"
 272     check_info_bp_any_syscall
 273
 274     # Sanitizing.
 275     delete_breakpoints
 276 }
 277
 278 proc do_syscall_tests {} {
 279     global gdb_prompt srcdir
 280
 281     # NOTE: We don't have to point gdb at the correct data-directory.
 282     # For the build tree that is handled by INTERNAL_GDBFLAGS.
 283
 284     # Verify that the 'catch syscall' help is available
 285     set thistest "help catch syscall"
 286     gdb_test "help catch syscall" "Catch system calls.*" $thistest
 287
 288     # Try to set a catchpoint to a nonsense syscall
 289     set thistest "catch syscall to a nonsense syscall is prohibited"
 290     gdb_test "catch syscall nonsense_syscall" "Unknown syscall name .*" $thistest
 291
 292     # Testing the 'catch syscall' command without arguments.
 293     # This test should catch any syscalls.
 294     if [runto_main] then { test_catch_syscall_without_args }
 295
 296     # Testing the 'catch syscall' command with arguments.
 297     # This test should only catch the specified syscall.
 298     if [runto_main] then { test_catch_syscall_with_args }
 299
 300     # Testing the 'catch syscall' command with many arguments.
 301     # This test should catch $all_syscalls.
 302     if [runto_main] then { test_catch_syscall_with_many_args }
 303
 304     # Testing the 'catch syscall' command with WRONG arguments.
 305     # This test should not trigger any catchpoints.
 306     if [runto_main] then { test_catch_syscall_with_wrong_args }
 307
 308     # Testing the 'catch' syscall command during a restart of
 309     # the inferior.
 310     if [runto_main] then { test_catch_syscall_restarting_inferior }
 311 }
 312
 313 proc test_catch_syscall_without_args_noxml {} {
 314     # We will need the syscall names even not using it
 315     # because we need to know know many syscalls are in
 316     # the example file.
 317     global gdb_prompt all_syscalls last_syscall
 318
 319     delete_breakpoints
 320
 321     set thistest "Catch syscall without arguments and without XML support"
 322     gdb_test "catch syscall" "Catchpoint .*(syscall).*"
 323
 324     # Now, we should be able to set a catchpoint,
 325     # and GDB shall not display the warning anymore.
 326     foreach name $all_syscalls {
 327         # Unfortunately, we don't know the syscall number
 328         # that will be caught because this information is
 329         # arch-dependent.  Thus, we try to catch anything
 330         # similar to a number.
 331         check_continue "\[0-9\]*"
 332     }
 333
 334     # At last but not least, we check if the inferior
 335     # has called the last (exit) syscall.
 336     check_call_to_syscall "\[0-9\]*"
 337
 338     delete_breakpoints
 339 }
 340
 341 proc test_catch_syscall_with_args_noxml {} {
 342     global gdb_prompt
 343
 344     # The number of the "close" syscall.  This is our
 345     # option for a "long-estabilished" syscall in all
 346     # Linux architectures, but unfortunately x86_64 and
 347     # a few other platforms don't "follow the convention".
 348     # Because of this, we need this ugly check :-(.
 349     set close_number ""
 350     if { [istarget "x86_64-*-linux*"] } {
 351         set close_number "3"
 352     } else {
 353         set close_number "6"
 354     }
 355
 356     delete_breakpoints
 357
 358     insert_catch_syscall_with_arg $close_number
 359
 360     check_continue $close_number
 361
 362     delete_breakpoints
 363 }
 364
 365 proc test_catch_syscall_with_wrong_args_noxml {} {
 366     global gdb_prompt
 367
 368     delete_breakpoints
 369
 370     # Even without XML support, GDB should not accept unknown
 371     # syscall names for the catchpoint.
 372     set thistest "Catch a nonsense syscall without XML support"
 373     gdb_test "catch syscall nonsense_syscall" "Unknown syscall name .nonsense_syscall.*" $thistest
 374
 375     delete_breakpoints
 376 }
 377
 378 proc do_syscall_tests_without_xml {} {
 379     global gdb_prompt srcdir
 380
 381     # Make sure GDB doesn't load the syscalls xml from the system data
 382     # directory.
 383     gdb_test_no_output "set data-directory /the/path/to/nowhere"
 384
 385     # Let's test if we can catch syscalls without XML support.
 386     # We should succeed, but GDB is not supposed to print syscall names.
 387     if [runto_main] then { test_catch_syscall_without_args_noxml }
 388
 389     # The only valid argument "catch syscall" should accept is the
 390     # syscall number, and not the name (since it can't translate a
 391     # name to a number).
 392     #
 393     # It's worth mentioning that we only try to catch the syscall
 394     # close().  This is because the syscall number is an arch-dependent
 395     # information, so we can't assume that we know every syscall number
 396     # in this system.  Therefore, we have decided to use a "long-estabilished"
 397     # system call, and close() just sounded the right choice :-).
 398     if [runto_main] then { test_catch_syscall_with_args_noxml }
 399
 400     # Now, we'll try to provide a syscall name (valid or not) to the command,
 401     # and expect it to fail.
 402     if [runto_main] then { test_catch_syscall_with_wrong_args_noxml }
 403 }
 404
 405 # This procedure fills the vector "all_syscalls_numbers" with the proper
 406 # numbers for the used syscalls according to the architecture.
 407 proc fill_all_syscalls_numbers {} {
 408     global all_syscalls_numbers
 409
 410     # For Linux on x86, PPC, PPC64, SPARC and SPARC64, the numbers for the syscalls
 411     # "close" and "chroot" are the same.
 412     if { [istarget "i\[34567\]86-*-linux*"]
 413          || [istarget "powerpc-*-linux*"] || [istarget "powerpc64-*-linux*"]
 414          || [istarget "sparc-*-linux*"] || [istarget "sparc64-*-linux*"] } {
 415          set all_syscalls_numbers { "6" "61" }
 416     }
 417 }
 418
 419 # Start with a fresh gdb
 420
 421 gdb_exit
 422 set do_xml_test ![gdb_skip_xml_test]
 423 gdb_start
 424 gdb_reinitialize_dir $srcdir/$subdir
 425 gdb_load ${binfile}
 426
 427 # Execute the tests, using XML support
 428 if $do_xml_test {
 429   do_syscall_tests
 430
 431   # Now, we have to see if GDB displays a warning when we
 432   # don't set the data-directory but try to use catch syscall
 433   # anyway.  For that, we must restart GDB first.
 434   gdb_exit
 435   gdb_start
 436   gdb_reinitialize_dir $srcdir/$subdir
 437   gdb_load ${binfile}
 438   test_catch_syscall_fail_nodatadir
 439 }
 440
 441 # Restart gdb
 442
 443 gdb_exit
 444 gdb_start
 445 gdb_reinitialize_dir $srcdir/$subdir
 446 gdb_load ${binfile}
 447
 448 # Execute the tests, without XML support.  In this case, GDB will
 449 # only display syscall numbers, and not syscall names.
 450 do_syscall_tests_without_xml