From patchwork Sun Nov 24 22:03:48 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Ijaz, Abdul B" X-Patchwork-Id: 101808 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 818B43858CD9 for ; Sun, 24 Nov 2024 22:10:01 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 818B43858CD9 Authentication-Results: sourceware.org; dkim=pass (2048-bit key, unprotected) header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=d9DW1Khe X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.15]) by sourceware.org (Postfix) with ESMTPS id A7D6D385840E for ; Sun, 24 Nov 2024 22:04:55 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org A7D6D385840E Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=intel.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=intel.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org A7D6D385840E Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=192.198.163.15 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1732485895; cv=none; b=clkOttpDGShNhu8WRviSE0Uq7xk/PF+BuFAtSz6fV5VsS1VxvtK3jhbXf4rld/xtTcyMqAd253VdDeb89gF8KrzvjcZI79a4NFPMLcM/apLjNv8s8HOjmd+v53EW8UWT11SaBv7SXNAutcMZ/LfQgIEI0ylaCyl8tvcDWc1babE= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1732485895; c=relaxed/simple; bh=uVxf2w3Ga6GKml62F6p+PV1h3Zho1L4t4QouVza2aco=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=ay9swBSczvL04YYEO6XVyH8rjgsiq30qtkeB3UXbs/2K6BfXnWeyUSOqBzx+TPr54a8Sa1yWn6LqDByCJ6uEliRcNE4hG/ci7wjVko9/H5KEav9dT2tpuYdwnuUCtU4j6SDmgvqTQADSA+BTZGt8syGl82v79rZDy+5WmQKDGYc= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org A7D6D385840E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1732485895; x=1764021895; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=uVxf2w3Ga6GKml62F6p+PV1h3Zho1L4t4QouVza2aco=; b=d9DW1KheeJ7WCTg7ZHGmUljYQY94Tc9AKs59S6vk+FpRZNP0yfAUaJ9E D1Peh11dZ8BSH1f39lj123lYegpE22s3v5ePSYh2Epxutm0Uua8cYRDu/ ClXokpiSUiCFXWod2FE9KWiPedv37hmfxkw5Yf8bNlwcoWHJP2LR8XOxf pNUE8cZfJboNUsuhOzJg+sBOsitPDe4zROIZAN72uVCtN0HYWcdQjOZ1L 4A1Jbf6qfz4RPVQvlPZLhBRBu4p40t+TbuPJ852T4LbTcyZLdOFUwc0KZ i0s9eBcKrR0t+oErBz859e62THdBQ13lnCclj1FbuPjOfYZr7n+tnGhto w==; X-CSE-ConnectionGUID: yfR5CPAqTimPpudONRw2Kg== X-CSE-MsgGUID: hdQPxbMURfyClzBccuZh+g== X-IronPort-AV: E=McAfee;i="6700,10204,11266"; a="32704400" X-IronPort-AV: E=Sophos;i="6.12,181,1728975600"; d="scan'208";a="32704400" Received: from fmviesa010.fm.intel.com ([10.60.135.150]) by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Nov 2024 14:04:54 -0800 X-CSE-ConnectionGUID: kH9bsVYBSh+8hPl5PFQDaQ== X-CSE-MsgGUID: Nyr0QwpCQVyCCP1DXWNUNg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.12,181,1728975600"; d="scan'208";a="91429045" Received: from abijaz-mobl2.ger.corp.intel.com (HELO localhost) ([10.245.166.144]) by fmviesa010-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Nov 2024 14:04:52 -0800 From: Abdul Basit Ijaz To: gdb-patches@sourceware.org Cc: abdul.b.ijaz@intel.com, JiniSusan.George@amd.com, tom@tromey.com, eliz@gnu.org Subject: [PATCH v9 05/10] gdb: Skip trampoline functions for the finish and reverse-finish commands. Date: Sun, 24 Nov 2024 23:03:48 +0100 Message-Id: <20241124220353.3465-6-abdul.b.ijaz@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241124220353.3465-1-abdul.b.ijaz@intel.com> References: <20241124220353.3465-1-abdul.b.ijaz@intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-10.6 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces~patchwork=sourceware.org@sourceware.org From: "Ijaz, Abdul B" This change skips trampoline functions when the option 'skip-trampoline-functions' is set to 'on' for the finish or reverse-finish command. Before this change, for these commands GDB returns to the trampoline function indicated by the compiler with DIE "DW_AT_trampoline". For better user experience, all such frames can be hidden from the user. In this example the IFX compiler emits "DW_AT_trampoline" tag for the 'first' and 'second' trampoline functions like following: function second (x, y) result(z) integer, intent(in) :: x, y integer :: z z = x * y ! breakpt-finish end function second function first (num1, num2) result(total) integer, intent(in) :: num1, num2 integer :: total total = second (num1 + 4, num2 * 3) ! first-breakpt total = total + 30 end function first Related Dwarf: 0x0000013f: DW_TAG_subprogram DW_AT_low_pc (0x0000000000404350) DW_AT_high_pc (0x000000000040435f) DW_AT_frame_base (DW_OP_reg6 RBP) DW_AT_linkage_name ("second_.t74p.t75p") DW_AT_name ("second_.t74p.t75p") DW_AT_trampoline ("second_") 0x0000015a: DW_TAG_subprogram DW_AT_low_pc (0x00000000004044a0) DW_AT_high_pc (0x00000000004044af) DW_AT_frame_base (DW_OP_reg6 RBP) DW_AT_linkage_name ("first_.t104p.t105p") DW_AT_name ("first_.t104p.t105p") DW_AT_trampoline ("first_") Before this change, the finish command output looks like: ''' (gdb) finish Run till exit from #0 second (x=20, y=9) at test.f90:4 0x0000000000405209 in second_.t74p.t75p () at test.f90:12 12 end function first Value returned is $1 = 180 ''' The reverse-finish command output in this test before the change: ''' (gdb) reverse-finish Run back to call of #0 second (x=20, y=9) at test.f90:4 0x0000000000405204 in second_.t74p.t75p () at test.f90:12 12 end function first ''' After this change: ''' (gdb) finish Run till exit from #0 second (x=20, y=9) at test.f90:4 0x00000000004051e3 in first (num1=16, num2=3) at test.f90:10 10 total = second (num1 + 4, num2 * 3) ! first-breakpt Value returned is $1 = 180 (gdb) reverse-finish Run back to call of #0 second (x=20, y=9) at test.f90:4 0x00000000004051de in first (num1=16, num2=3) at test.f90:10 10 total = second (num1 + 4, num2 * 3) ! first-breakpt ''' The test gdb.fortran/func-trampoline.exp is updated for testing the finish command. The test gdb.reverse/finish-reverse-trampoline.exp is added for testing the reverse-finish command. 2024-11-24 Ijaz, Abdul B --- gdb/NEWS | 5 +- gdb/doc/gdb.texinfo | 4 ++ gdb/infcmd.c | 12 ++++ gdb/infrun.c | 8 +++ gdb/infrun.h | 5 ++ gdb/testsuite/gdb.fortran/func-trampoline.exp | 13 ++++- .../gdb.reverse/finish-reverse-trampoline.exp | 56 +++++++++++++++++++ 7 files changed, 99 insertions(+), 4 deletions(-) create mode 100644 gdb/testsuite/gdb.reverse/finish-reverse-trampoline.exp diff --git a/gdb/NEWS b/gdb/NEWS index 3e7647987f1..636bce4bd34 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -1085,8 +1085,9 @@ show skip-trampoline-functions recognize function calls that have been marked as trampolines in the debug info. It improves stepping behavior in that it steps over the trampoline code and hides it from the user. It improves the printing of the stack by - hiding trampoline functions from the backtrace. Currently, only DWARF - trampolines are supported. + hiding the trampoline frames from the backtrace and skips trampoline + functions while returning from the target function of a trampoline call. + Currently, only DWARF trampolines are supported. If this is turned off, GDB will handle @dfn{trampoline functions} the same as any other function. diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 1a1529a3021..dadc4a36694 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -6544,6 +6544,10 @@ DWARF trampolines marked via DW_AT_trampoline are supported by this. When issuing a @code{backtrace}, if @code{skip-trampoline-functions} is set, @value{GDBN} will skip trampoline frames while printing the stack. +When issuing a @code{finish} or @code{reverse-finish}, if +@code{skip-trampoline-functions} is set, @value{GDBN} will skip trampoline +frames while returning from the target function. + Currently, only DWARF trampolines marked via DW_AT_trampoline are supported by this. diff --git a/gdb/infcmd.c b/gdb/infcmd.c index 5c0e3f51162..aa91b9b7d33 100644 --- a/gdb/infcmd.c +++ b/gdb/infcmd.c @@ -1803,6 +1803,18 @@ finish_command (const char *arg, int from_tty) if (frame == 0) error (_("\"finish\" not meaningful in the outermost frame.")); + if (skip_trampoline_functions) + { + for (int i = 0; (SAFE_TRAMPOLINE_CHAIN (i, frame) + && in_trampoline_frame (frame)); ++i) + frame = get_prev_frame (frame); + + if (frame == nullptr) + error (_("\"finish\" not meaningful in the outermost non-trampoline \ +frame. Consider running \"set skip-trampoline-functions off\", to stop in \ +trampoline frames for the \"finish\" command.")); + } + clear_proceed_status (0); tp = inferior_thread (); diff --git a/gdb/infrun.c b/gdb/infrun.c index 8eab93a224d..920648f0ce1 100644 --- a/gdb/infrun.c +++ b/gdb/infrun.c @@ -8080,6 +8080,14 @@ process_event_stop_test (struct execution_control_state *ecs) keep_going (ecs); return; } + else if (skip_trampoline_functions && in_trampoline_function (stop_pc)) + { + /* While reverse stepping if we are in a trampoline function call + we will just continue single step in the hope of leaving the + trampoline again soon. */ + keep_going (ecs); + return; + } } /* This always returns the sal for the inner-most frame when we are in a diff --git a/gdb/infrun.h b/gdb/infrun.h index fbe88ad4595..3873cca7619 100644 --- a/gdb/infrun.h +++ b/gdb/infrun.h @@ -81,6 +81,11 @@ infrun_debug_show_threads (const char *title, ThreadRange threads) information. */ #define MAX_TRAMPOLINE_CHAIN_SIZE 10 +/* True if the trampoline index "i" is less then the maximum allowed size + of a trampoline chain. */ +#define SAFE_TRAMPOLINE_CHAIN(i, frame) \ + (i < MAX_TRAMPOLINE_CHAIN_SIZE && (frame != nullptr)) + /* Nonzero if we want to give control to the user when we're notified of shared library events by the dynamic linker. */ extern int stop_on_solib_events; diff --git a/gdb/testsuite/gdb.fortran/func-trampoline.exp b/gdb/testsuite/gdb.fortran/func-trampoline.exp index bfa0002cf0e..4cb9e4f4919 100644 --- a/gdb/testsuite/gdb.fortran/func-trampoline.exp +++ b/gdb/testsuite/gdb.fortran/func-trampoline.exp @@ -13,8 +13,8 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# Test "backtrace" and "backtrace -n" commands for functions with trampoline -# calls. +# Test "backtrace", "backtrace -n" and "finish" commands for functions with +# trampoline calls. require allow_fortran_tests @@ -75,3 +75,12 @@ with_test_prefix "backtrace outerframes" { "#$decimal.* $middle_desc" \ "#$decimal.* $outer_desc.*"] } + +with_test_prefix "finish" { + init_test + + gdb_test "finish" [multi_line \ + "Run till exit from #0 $fill second \\(x=20, y=9\\) $fill" \ + "${fill}first \\(num1=16, num2=3\\)${fill}" \ + "${fill}(\r\nValue returned is $valnum_re = 180)"] +} diff --git a/gdb/testsuite/gdb.reverse/finish-reverse-trampoline.exp b/gdb/testsuite/gdb.reverse/finish-reverse-trampoline.exp new file mode 100644 index 00000000000..3a23a30ad0d --- /dev/null +++ b/gdb/testsuite/gdb.reverse/finish-reverse-trampoline.exp @@ -0,0 +1,56 @@ +# Copyright 2024 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 . + +# Test "reverse-finish" command for functions with trampoline. + +require supports_reverse allow_fortran_tests + +if {![test_compiler_info {ifx-*} f90]} { + untested "This test is only applicable for IFX, which emits the\ + trampoline DIE in Dwarf." + return -1 +} + +load_lib fortran.exp + +set testfile finish-reverse-trampoline +set srcfile "${srcdir}/gdb.fortran/func-trampoline.f90" +set binfile [standard_output_file $testfile] + +if {[prepare_for_testing "failed to prepare" ${testfile} ${srcfile} \ + {debug f90}]} { + return -1 +} + +if {![fortran_runto_main]} { + return -1 +} + +set inner_loc [gdb_get_line_number "second-breakpt"] + +if [supports_process_record] { + # Activate process record/replay + gdb_test_no_output "record" "turn on process record" +} + +# Set breakpoint inside the innermost function 'second'. +gdb_breakpoint "$srcfile:$inner_loc" +gdb_continue_to_breakpoint "innermost-body" ".*$srcfile:$inner_loc.*" + +gdb_test "reverse-finish" [multi_line \ + "Run back to call of #0 second \\(x=20, y=9\\).*" \ + ".*in first \\(num1=16, num2=3\\).*"] + +gdb_test "frame" "#0.*first.*" "Frame 0 shows first function"