1# Copyright 1997-2020 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 3 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, see <http://www.gnu.org/licenses/>. 15 16 17# This program tests the 'catch syscall' functionality. 18# 19# It was written by Sergio Durigan Junior <sergiodj@linux.vnet.ibm.com> 20# on September/2008. 21 22standard_testfile 23 24if { [prepare_for_testing "failed to prepare" $testfile ${testfile}.c] } { 25 return -1 26} 27 28# Check target supports catch syscall or not. 29clean_restart $binfile 30if ![runto_main] then { 31 fail "can't run to main" 32 return 33} 34 35set test "catch syscall" 36gdb_test_multiple $test $test { 37 -re "The feature \'catch syscall\' is not supported.*\r\n$gdb_prompt $" { 38 unsupported "catch syscall isn't supported" 39 return -1 40 } 41 -re ".*$gdb_prompt $" { 42 pass $test 43 } 44} 45 46set test "check catch syscall" 47gdb_test_multiple "continue" $test { 48 -re ".*Your system does not support this type\r\nof catchpoint.*$gdb_prompt $" { 49 unsupported "catch syscall isn't supported" 50 return -1 51 } 52 -re ".*Catchpoint.*$gdb_prompt $" { 53 pass $test 54 } 55} 56 57# All (but the last) syscalls from the example code. It is filled in 58# proc setup_all_syscalls. 59set all_syscalls { } 60set all_syscalls_numbers { } 61 62# The last syscall (exit()) does not return, so 63# we cannot expect the catchpoint to be triggered 64# twice. It is a special case. 65set last_syscall "exit_group" 66set last_syscall_number { } 67 68set vfork_syscalls "(vfork|clone2?)" 69 70set unknown_syscall_number { } 71 72# Internal procedure used to check if, after issuing a 'catch syscall' 73# command (without arguments), the 'info breakpoints' command displays 74# that '"any syscall"' is to be caught. 75proc check_info_bp_any_syscall {} { 76 # Verifying that the catchpoint appears in the 'info breakpoints' 77 # command, but with "<any syscall>". 78 set thistest "catch syscall appears in 'info breakpoints'" 79 gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscall \"<any syscall>\".*" $thistest 80} 81 82# Internal procedure used to check if, after issuing a 'catch syscall X' 83# command (with arguments), the 'info breakpoints' command displays 84# that the syscall 'X' is to be caught. 85proc check_info_bp_specific_syscall { syscall } { 86 set thistest "syscall(s) $syscall appears in 'info breakpoints'" 87 gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscall(\[(\]s\[)\])? (.)?${syscall}(.)?.*" $thistest 88} 89 90# Internal procedure used to check if, after issuing a 'catch syscall X' 91# command (with many arguments), the 'info breakpoints' command displays 92# that the syscalls 'X' are to be caught. 93proc check_info_bp_many_syscalls { syscalls } { 94 set filter_str "" 95 96 foreach name $syscalls { 97 set filter_str "${filter_str}${name}, " 98 } 99 100 set filter_str [ string trimright $filter_str ", " ] 101 102 set thistest "syscalls $filter_str appears in 'info breakpoints'" 103 gdb_test "info breakpoints" ".*catchpoint.*keep y.*syscalls (.)?${filter_str}(.)?.*" $thistest 104} 105 106# This procedure checks if there was a call to a syscall. The optional 107# pattern can match syscalls that vary in implementation, like vfork. 108proc check_call_to_syscall { syscall { pattern "" } } { 109 global decimal 110 111 if { $pattern eq "" } { 112 set pattern "${syscall}" 113 } 114 115 set thistest "program has called $syscall" 116 gdb_test "continue" "Catchpoint $decimal \\(call to syscall .?${pattern}.?\\).*" $thistest 117} 118 119# This procedure checks if the syscall returned. The optional pattern 120# can match syscalls that vary in implementation, like vfork. 121proc check_return_from_syscall { syscall { pattern "" } } { 122 global decimal 123 124 if { $pattern eq "" } { 125 set pattern "${syscall}" 126 } 127 128 set thistest "syscall $syscall has returned" 129 gdb_test "continue" "Catchpoint $decimal \\(returned from syscall ${pattern}\\).*" $thistest 130} 131 132# Internal procedure that performs two 'continue' commands and checks if 133# a syscall call AND return occur. The optional pattern can match 134# syscalls that vary in implementation, like vfork. 135proc check_continue { syscall { pattern "" } } { 136 # Testing if the 'continue' stops at the 137 # specified syscall_name. If it does, then it should 138 # first print that the infeior has called the syscall, 139 # and after print that the syscall has returned. 140 141 # Testing if the inferior has called the syscall. 142 check_call_to_syscall $syscall $pattern 143 # And now, that the syscall has returned. 144 check_return_from_syscall $syscall $pattern 145} 146 147# Inserts a syscall catchpoint with an argument. 148proc insert_catch_syscall_with_arg { syscall } { 149 global decimal 150 151 # Trying to set the catchpoint 152 set thistest "catch syscall with arguments ($syscall)" 153 gdb_test "catch syscall $syscall" "Catchpoint $decimal \\(syscall \'?${syscall}\'?( \[${decimal}\])?\\)" $thistest 154 155 check_info_bp_specific_syscall $syscall 156} 157 158# Inserts a syscall catchpoint with many arguments. 159proc insert_catch_syscall_with_many_args { syscalls numbers } { 160 global decimal 161 162 set catch [ join $syscalls " " ] 163 set filter_str "" 164 165 foreach name $syscalls number $numbers { 166 set filter_str "${filter_str}'${name}' \\\[${number}\\\] " 167 } 168 169 set filter_str [ string trimright $filter_str " " ] 170 171 # Trying to set the catchpoint 172 set thistest "catch syscall with arguments ($filter_str)" 173 gdb_test "catch syscall $catch" "Catchpoint $decimal \\(syscalls ${filter_str}\\).*" $thistest 174 175 check_info_bp_many_syscalls $syscalls 176} 177 178proc check_for_program_end {} { 179 # Deleting the catchpoints 180 delete_breakpoints 181 182 gdb_continue_to_end "" continue 1 183} 184 185proc test_catch_syscall_without_args {} { 186 global all_syscalls last_syscall vfork_syscalls unknown_syscall_number decimal 187 188 with_test_prefix "without arguments" { 189 # Trying to set the syscall. 190 gdb_test "catch syscall" "Catchpoint $decimal \\(any syscall\\)" 191 192 check_info_bp_any_syscall 193 194 # We have to check every syscall. 195 foreach name $all_syscalls { 196 check_continue $name 197 } 198 199 check_continue "vfork" $vfork_syscalls 200 201 with_test_prefix "ENOSYS" { 202 check_continue $unknown_syscall_number 203 } 204 205 # At last but not least, we check if the inferior has called 206 # the last (exit) syscall. 207 check_call_to_syscall $last_syscall 208 209 # Now let's see if the inferior correctly finishes. 210 check_for_program_end 211 } 212} 213 214proc test_catch_syscall_with_args {} { 215 with_test_prefix "with arguments" { 216 set syscall_name "close" 217 insert_catch_syscall_with_arg $syscall_name 218 219 # Can we continue until we catch the syscall? 220 check_continue $syscall_name 221 222 # Now let's see if the inferior correctly finishes. 223 check_for_program_end 224 } 225} 226 227proc test_catch_syscall_with_many_args {} { 228 with_test_prefix "with many arguments" { 229 global all_syscalls all_syscalls_numbers 230 231 insert_catch_syscall_with_many_args $all_syscalls $all_syscalls_numbers 232 233 # Can we continue until we catch the syscalls? 234 foreach name $all_syscalls { 235 check_continue $name 236 } 237 238 # Now let's see if the inferior correctly finishes. 239 check_for_program_end 240 } 241} 242 243proc test_catch_syscall_with_wrong_args {} { 244 with_test_prefix "wrong args" { 245 # mlock is not called from the source 246 set syscall_name "mlock" 247 insert_catch_syscall_with_arg $syscall_name 248 249 # Now, we must verify if the program stops with a continue. 250 # If it doesn't, everything is right (since we don't have 251 # a syscall named "mlock" in it). Otherwise, this is a failure. 252 set thistest "catch syscall with unused syscall ($syscall_name)" 253 gdb_continue_to_end $thistest continue 1 254 } 255} 256 257proc test_catch_syscall_restarting_inferior {} { 258 with_test_prefix "restarting inferior" { 259 set syscall_name "chroot" 260 261 with_test_prefix "entry" { 262 insert_catch_syscall_with_arg $syscall_name 263 264 # Let's first reach the entry of the syscall. 265 check_call_to_syscall $syscall_name 266 } 267 268 with_test_prefix "entry/return" { 269 # Now, restart the program. 270 rerun_to_main 271 272 # And check for entry/return. 273 check_continue $syscall_name 274 275 # Can we finish? 276 check_for_program_end 277 } 278 } 279} 280 281proc test_catch_syscall_skipping_return {} { 282 with_test_prefix "skipping return" { 283 with_test_prefix "entry" { 284 set syscall_name "write" 285 286 insert_catch_syscall_with_arg $syscall_name 287 288 # Let's first reach the entry of the syscall. 289 check_call_to_syscall $syscall_name 290 291 # Now purposely skip the syscall return. 292 delete_breakpoints 293 gdb_test "stepi" ".*" "step over syscall return" 294 } 295 296 # With a naive entry/return toggle, gdb will still think 297 # the target is due for a syscall return. 298 299 with_test_prefix "entry/return" { 300 set syscall_name "read" 301 302 insert_catch_syscall_with_arg $syscall_name 303 304 # Check for entry first, then return. 305 check_continue $syscall_name 306 307 # Can we finish? 308 check_for_program_end 309 } 310 } 311} 312 313proc test_catch_syscall_mid_vfork {} { 314 global gdb_prompt decimal vfork_syscalls 315 316 with_test_prefix "mid-vfork" { 317 # Verify that the system supports "catch vfork". 318 gdb_test "catch vfork" "Catchpoint $decimal \\(vfork\\)" "insert first vfork catchpoint" 319 gdb_test_multiple "continue" "continue to first vfork catchpoint" { 320 -re ".*Your system does not support this type\r\nof catchpoint.*$gdb_prompt $" { 321 unsupported "continue to first vfork catchpoint" 322 return 323 } 324 -re ".*Catchpoint $decimal \\(vforked process $decimal\\).*$gdb_prompt $" { 325 pass "continue to first vfork catchpoint" 326 } 327 } 328 329 # Check that we now reach vfork return only. 330 # (The actual syscall used varies by architecture.) 331 gdb_test "catch syscall" "Catchpoint $decimal \\(any syscall\\)" 332 check_return_from_syscall "vfork" $vfork_syscalls 333 334 # Can we finish? 335 check_for_program_end 336 } 337} 338 339proc test_catch_syscall_execve {} { 340 global gdb_prompt decimal 341 342 with_test_prefix "execve" { 343 344 # Tell the test program we want an execve. 345 gdb_test_no_output "set do_execve = 1" 346 347 # Check for entry/return across the execve, making sure that the 348 # syscall_state isn't lost when turning into a new process. 349 insert_catch_syscall_with_arg "execve" 350 check_continue "execve" 351 352 # Continue to main so extended-remote can read files as needed. 353 # (Otherwise that "Reading" output confuses gdb_continue_to_end.) 354 gdb_continue "main" 355 356 # Now can we finish? 357 check_for_program_end 358 } 359} 360 361proc test_catch_syscall_fail_nodatadir {} { 362 with_test_prefix "fail no datadir" { 363 # Sanitizing. 364 delete_breakpoints 365 366 # Make sure GDB doesn't load the syscalls xml from the system 367 # data directory. 368 gdb_test "set data-directory /the/path/to/nowhere" \ 369 "Warning: /the/path/to/nowhere: .*" 370 371 # Testing to see if we receive a warning when calling "catch 372 # syscall" without XML support (without datadir). 373 set thistest "catch syscall displays a warning when there is no XML support" 374 gdb_test "catch syscall" \ 375 "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).*" \ 376 $thistest 377 378 # Since the catchpoint was set, we must check if it's present 379 # in "info breakpoints" output. 380 check_info_bp_any_syscall 381 382 # Sanitizing. 383 delete_breakpoints 384 } 385} 386 387proc test_catch_syscall_group {} { 388 global decimal 389 390 set sysnum "\\\[${decimal}\\\]" 391 392 gdb_test "catch syscall g:process" \ 393 "Catchpoint $decimal \\(syscalls (\'(clone|fork|execve|exit)\' $sysnum)+.*" \ 394 "set catchpoint on a group of syscalls" 395 396 gdb_test "catch syscall group:process read" \ 397 "Catchpoint $decimal \\(syscalls (\'(clone|fork|execve|exit)\' $sysnum)+.*read.*\\)" \ 398 "set catchpoints on a group of syscalls and on a single syscall" 399 400 gdb_test "catch syscall group:" \ 401 "Unknown syscall group ''\." \ 402 "set catchpoints on an invalid group" 403 404 gdb_test "catch syscall g:junk" \ 405 "Unknown syscall group 'junk'\." \ 406 "set catchpoints on an unknown group." 407 408 gdb_test "complete catch syscall g:proc" \ 409 "catch syscall g:process" \ 410 "complete catch syscall group with 'g:' prefix" 411 412 gdb_test "complete catch syscall group:proc" \ 413 "catch syscall group:process" \ 414 "complete catch syscall group with 'group:' prefix" 415 416 gdb_test_sequence "complete catch syscall g" \ 417 "complete catch syscall group suggests 'group:' prefix" { 418 "group:descriptor" "group:file" "group:ipc" "group:memory" 419 "group:network" "group:process" "group:signal" 420 } 421} 422 423proc do_syscall_tests {} { 424 # NOTE: We don't have to point gdb at the correct data-directory. 425 # For the build tree that is handled by INTERNAL_GDBFLAGS. 426 427 # Verify that the 'catch syscall' help is available 428 gdb_test "help catch syscall" "Catch system calls.*" 429 430 # Try to set a catchpoint to a nonsense syscall 431 set thistest "catch syscall to a nonsense syscall is prohibited" 432 gdb_test "catch syscall nonsense_syscall" "Unknown syscall name .*" $thistest 433 434 # Regression test for syscall completer bug. 435 gdb_test "complete catch syscall close chroo" \ 436 "catch syscall close chroot" \ 437 "complete catch syscall with multiple words" 438 439 # Testing the 'catch syscall' command without arguments. 440 # This test should catch any syscalls. 441 if [runto_main] then { test_catch_syscall_without_args } 442 443 # Testing the 'catch syscall' command with arguments. 444 # This test should only catch the specified syscall. 445 if [runto_main] then { test_catch_syscall_with_args } 446 447 # Testing the 'catch syscall' command with many arguments. 448 # This test should catch $all_syscalls. 449 if [runto_main] then { test_catch_syscall_with_many_args } 450 451 # Testing the 'catch syscall' command with WRONG arguments. 452 # This test should not trigger any catchpoints. 453 if [runto_main] then { test_catch_syscall_with_wrong_args } 454 455 # Testing the 'catch syscall' command during a restart of 456 # the inferior. 457 if [runto_main] then { test_catch_syscall_restarting_inferior } 458 459 # Testing the 'catch syscall' command toggling off past a 460 # syscall return, then resuming entry/return as normal. 461 if [runto_main] then { test_catch_syscall_skipping_return } 462 463 # Testing the 'catch syscall' command starting mid-vfork. 464 if [runto_main] then { test_catch_syscall_mid_vfork } 465 466 # Testing that 'catch syscall' entry/return tracks across execve. 467 if [runto_main] then { test_catch_syscall_execve } 468 469 # Testing if the 'catch syscall' command works when switching to 470 # different architectures on-the-fly (PR gdb/10737). 471 if [runto_main] then { test_catch_syscall_multi_arch } 472 473 # Testing the 'catch' syscall command for a group of syscalls. 474 if [runto_main] then { test_catch_syscall_group } 475} 476 477proc test_catch_syscall_without_args_noxml {} { 478 with_test_prefix "without args noxml" { 479 # We will need the syscall names even not using it because we 480 # need to know know many syscalls are in the example file. 481 global decimal all_syscalls last_syscall_number unknown_syscall_number all_syscalls_numbers 482 483 delete_breakpoints 484 485 gdb_test "catch syscall" "Catchpoint .*(syscall).*" 486 487 # Now, we should be able to set a catchpoint, and GDB shall 488 # not display the warning anymore. 489 foreach name $all_syscalls number $all_syscalls_numbers { 490 with_test_prefix "$name" { 491 check_continue $number 492 } 493 } 494 495 check_continue "vfork" $decimal 496 497 with_test_prefix "ENOSYS" { 498 check_continue $unknown_syscall_number 499 } 500 501 # At last but not least, we check if the inferior has called 502 # the last (exit) syscall. 503 check_call_to_syscall $last_syscall_number 504 505 delete_breakpoints 506 } 507} 508 509proc test_catch_syscall_with_args_noxml {} { 510 with_test_prefix "with args noxml" { 511 global all_syscalls_numbers 512 513 delete_breakpoints 514 515 # Inserting all syscalls numbers to be caught 516 foreach syscall_number $all_syscalls_numbers { 517 insert_catch_syscall_with_arg $syscall_number 518 } 519 520 # Checking that all syscalls are caught. 521 foreach syscall_number $all_syscalls_numbers { 522 check_continue $syscall_number 523 } 524 525 delete_breakpoints 526 } 527} 528 529proc test_catch_syscall_with_wrong_args_noxml {} { 530 with_test_prefix "with wrong args noxml" { 531 delete_breakpoints 532 533 # Even without XML support, GDB should not accept unknown 534 # syscall names for the catchpoint. 535 gdb_test "catch syscall nonsense_syscall" \ 536 "Unknown syscall name .nonsense_syscall.*" 537 538 delete_breakpoints 539 } 540} 541 542proc test_catch_syscall_multi_arch {} { 543 global decimal binfile 544 545 if { [istarget "i*86-*-*"] || [istarget "x86_64-*-*"] } { 546 set arch1 "i386" 547 set arch2 "i386:x86-64" 548 set syscall1_name "exit" 549 set syscall2_name "write" 550 set syscall_number 1 551 } elseif { [istarget "powerpc-*-linux*"] \ 552 || [istarget "powerpc64-*-linux*"] } { 553 set arch1 "powerpc:common" 554 set arch2 "powerpc:common64" 555 set syscall1_name "openat" 556 set syscall2_name "unlinkat" 557 set syscall_number 286 558 } elseif { [istarget "sparc-*-linux*"] \ 559 || [istarget "sparc64-*-linux*"] } { 560 set arch1 "sparc" 561 set arch2 "sparc:v9" 562 set syscall1_name "setresuid32" 563 set syscall2_name "setresuid" 564 set syscall_number 108 565 } elseif { [istarget "mips*-linux*"] } { 566 # MIPS does not use the same numbers for syscalls on 32 and 64 567 # bits. 568 verbose "Not testing MIPS for multi-arch syscall support" 569 return 570 } elseif { [istarget "arm*-linux*"] } { 571 # catch syscall supports only 32-bit ARM for now. 572 verbose "Not testing ARM for multi-arch syscall support" 573 return 574 } elseif { [istarget "aarch64*-linux*"] } { 575 set arch1 "aarch64" 576 set arch2 "arm" 577 set syscall1_name "reboot" 578 set syscall2_name "_newselect" 579 set syscall_number 142 580 } elseif { [istarget "s390*-linux*"] } { 581 set arch1 "s390:31-bit" 582 set arch2 "s390:64-bit" 583 set syscall1_name "_newselect" 584 set syscall2_name "select" 585 set syscall_number 142 586 } 587 588 with_test_prefix "multiple targets" { 589 # We are not interested in loading any binary here, and in 590 # some systems (PowerPC, for example), if we load a binary 591 # there is no way to set other architecture. 592 gdb_exit 593 gdb_start 594 595 gdb_test "set architecture $arch1" \ 596 "The target architecture is set to \"$arch1\"\\." 597 598 gdb_test "catch syscall $syscall_number" \ 599 "Catchpoint $decimal \\(syscall .${syscall1_name}. \\\[${syscall_number}\\\]\\)" \ 600 "insert catch syscall on syscall $syscall_number -- $syscall1_name on $arch1" 601 602 gdb_test "set architecture $arch2" \ 603 "The target architecture is set to \"$arch2\"\\." 604 605 gdb_test "catch syscall $syscall_number" \ 606 "Catchpoint $decimal \\(syscall .${syscall2_name}. \\\[${syscall_number}\\\]\\)" \ 607 "insert catch syscall on syscall $syscall_number -- $syscall2_name on $arch2" 608 609 clean_restart $binfile 610 } 611} 612 613proc do_syscall_tests_without_xml {} { 614 # Make sure GDB doesn't load the syscalls xml from the system data 615 # directory. 616 gdb_test "set data-directory /the/path/to/nowhere" \ 617 "Warning: /the/path/to/nowhere: .*" 618 619 # Let's test if we can catch syscalls without XML support. 620 # We should succeed, but GDB is not supposed to print syscall names. 621 if [runto_main] then { test_catch_syscall_without_args_noxml } 622 623 # The only valid argument "catch syscall" should accept is the 624 # syscall number, and not the name (since it can't translate a 625 # name to a number). 626 if [runto_main] then { test_catch_syscall_with_args_noxml } 627 628 # Now, we'll try to provide a syscall name (valid or not) to the command, 629 # and expect it to fail. 630 if [runto_main] then { test_catch_syscall_with_wrong_args_noxml } 631} 632 633# This procedure fills the vector "all_syscalls_numbers" with the proper 634# numbers for the used syscalls according to the architecture. 635proc fill_all_syscalls_numbers {} { 636 global all_syscalls_numbers last_syscall_number unknown_syscall_number all_syscalls 637 638 foreach syscall $all_syscalls { 639 lappend all_syscalls_numbers [get_integer_valueof "${syscall}_syscall" -1] 640 } 641 642 set last_syscall_number [get_integer_valueof "exit_group_syscall" -1] 643 set unknown_syscall_number [get_integer_valueof "unknown_syscall" -1] 644} 645 646# Set up the vector all_syscalls. 647 648proc setup_all_syscalls {} { 649 global all_syscalls 650 global gdb_prompt 651 652 # They are ordered according to the file, so do not change this. 653 lappend all_syscalls "close" 654 lappend all_syscalls "chroot" 655 656 # SYS_pipe doesn't exist on aarch64 kernel. 657 set test "check SYS_pipe" 658 gdb_test_multiple "p pipe_syscall" $test { 659 -re " = .*$gdb_prompt $" { 660 pass $test 661 lappend all_syscalls "pipe" 662 } 663 -re "No symbol .*$gdb_prompt $" { 664 pass $test 665 # SYS_pipe isn't defined, use SYS_pipe2 instead. 666 lappend all_syscalls "pipe2" 667 } 668 } 669 670 lappend all_syscalls "write" 671 lappend all_syscalls "read" 672} 673 674setup_all_syscalls 675 676# Fill all the syscalls numbers before starting anything. 677fill_all_syscalls_numbers 678 679# Execute the tests, using XML support 680gdb_exit 681if { ![gdb_skip_xml_test] } { 682 clean_restart $binfile 683 do_syscall_tests 684 685 # Now, we have to see if GDB displays a warning when we 686 # don't set the data-directory but try to use catch syscall 687 # anyway. For that, we must restart GDB first. 688 clean_restart $binfile 689 test_catch_syscall_fail_nodatadir 690} 691 692# Restart gdb 693clean_restart $binfile 694 695# Execute the tests, without XML support. In this case, GDB will 696# only display syscall numbers, and not syscall names. 697do_syscall_tests_without_xml 698