From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id 2L9TGZJdBWbUdhkAWB0awg (envelope-from ) for ; Thu, 28 Mar 2024 08:07:46 -0400 Authentication-Results: simark.ca; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=CaLA8nhP; dkim-atps=neutral Received: by simark.ca (Postfix, from userid 112) id 603181E0C0; Thu, 28 Mar 2024 08:07:46 -0400 (EDT) Received: from server2.sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 44B231E030 for ; Thu, 28 Mar 2024 08:07:44 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id D33AE385841C for ; Thu, 28 Mar 2024 12:07:43 +0000 (GMT) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10]) by sourceware.org (Postfix) with ESMTPS id DC5AF3858D38 for ; Thu, 28 Mar 2024 12:06:30 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org DC5AF3858D38 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 DC5AF3858D38 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=192.198.163.10 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1711627602; cv=none; b=qu2cLvyicnbhrboJCFoRojSVY+a0d9TnUx0GaFVlNmoaRztLXcSzpnnqDh2A4eY63IkM5aWy9vlaXbJf8L0zsGUDjrxDd1XIlKUp2ST+Q9Ywl8n9xKBMoZZI2c3U5o3d/YOaz6Ys9KJrUwBnmMdPNKWq97yUDhTMkIejl+oskec= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1711627602; c=relaxed/simple; bh=rka6ZPDwEqtHJ6Cj6AuNqjlf7Zlr8heRaL7QTmdcT/4=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=fFRO7DOiMKvKgfnpwEdItnQMKR8ptZAI3ZaRENBj4eX9y2KOdShA/u8AirsiTynp9RZyq6vm5SBrsSCLI7t/Puwel4VWV7uLjuldKAmQe9fjPokwYmFk5qRJ6iBJ2wQBu7A0FsXD9+HymB9UnQzp5YB0mErJ7kV6KuOP8Le3erI= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1711627591; x=1743163591; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=rka6ZPDwEqtHJ6Cj6AuNqjlf7Zlr8heRaL7QTmdcT/4=; b=CaLA8nhPL6azqMHE7rbPiJwqnfmrAi1QUhoLKY06k8XwHdQZQ8Lh59Xv oiaVXTwZs2aOk3Kl1IhsBB1ugSqHBog90U0BF5o1NiTBOO/oDtTsi72tJ nC1N9N+Cil4zuNrUq2gwKldwTEBn9VIx/3WWM0Vc0xor+0H/7KdUirgaA NJvpnYPkvGcXfALbBOX2VRsVONgg+7QC/OSc8D6kJ1Me55RV7Q4RM/LBZ KwEWdjI9XZzeov2MdXN3RBdB5OKdm48ILiKfDmTpN1HmS2aYMHdxUP0zZ VgEx3HJfllvTEjQsXj9HNAZ6f0vQ2c0aQkJDx/bQfCtdvU58cX/oMHcfb g==; X-CSE-ConnectionGUID: BxXOJYI+QbmOcV7MKhJ8ig== X-CSE-MsgGUID: LlqCbFUDQoWg+GTgRcKEIA== X-IronPort-AV: E=McAfee;i="6600,9927,11026"; a="18158620" X-IronPort-AV: E=Sophos;i="6.07,161,1708416000"; d="scan'208";a="18158620" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Mar 2024 05:06:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.07,161,1708416000"; d="scan'208";a="47816090" Received: from abijaz-mobl2.ger.corp.intel.com (HELO localhost) ([10.246.42.1]) by smtpauth.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Mar 2024 05:06:28 -0700 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 v6 05/10] gdb: Skip trampoline functions for the finish and reverse-finish commands. Date: Thu, 28 Mar 2024 13:05:23 +0100 Message-Id: <20240328120528.30382-6-abdul.b.ijaz@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240328120528.30382-1-abdul.b.ijaz@intel.com> References: <20240328120528.30382-1-abdul.b.ijaz@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-10.7 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_LOW, 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+public-inbox=simark.ca@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-03-28 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 025f2e1a17e..b8577c58af7 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -898,8 +898,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 gdb will handle trampoline functions the same as any other function. diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 6117f6e889f..5782e06b91d 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -6475,6 +6475,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 600c90c055a..cd9baa03ecd 100644 --- a/gdb/infcmd.c +++ b/gdb/infcmd.c @@ -1801,6 +1801,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 1c5711b8c41..5419d58bf3b 100644 --- a/gdb/infrun.c +++ b/gdb/infrun.c @@ -8095,6 +8095,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" -- 2.34.1 Intel Deutschland GmbH Registered Address: Am Campeon 10, 85579 Neubiberg, Germany Tel: +49 89 99 8853-0, www.intel.de Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva Chairperson of the Supervisory Board: Nicole Lau Registered Office: Munich Commercial Register: Amtsgericht Muenchen HRB 186928