From patchwork Wed Nov 16 12:36:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lancelot SIX X-Patchwork-Id: 60694 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 13554395A01B for ; Wed, 16 Nov 2022 12:37:50 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 13554395A01B DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1668602270; bh=QVzSh51IMMqVZrS6N+jS2h5ZWen76SYhzg4vlBnwQA4=; h=To:CC:Subject:Date:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From:Reply-To:From; b=WoEXBQw6eqN6oKXLjuLKMiyeUixOLtTvyjjOYEjKCo4iGb4D5fjQJjXkon36CXcz0 c5yjGxeub1FOQIVbVetcfoXiuFy+8fpErUcHEZUatP0ZTQoi6qEndOe/aL8P5dkBbs rQ4dsiBFQV2HFJIGvPTlPnKO2vvXcMKvqe/u4AOA= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on2059.outbound.protection.outlook.com [40.107.96.59]) by sourceware.org (Postfix) with ESMTPS id 2B86B395A008 for ; Wed, 16 Nov 2022 12:37:21 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 2B86B395A008 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=J9rrZBqJkn/yBeG4a74n5VwfQH0728IaD5DM1eSn78pHemsCS05qkEK1tmPCiVwyf5zLI0J0y//Kafd7ZGSZqYzRtCRI9qhCQtPjcsL35FqXleRCfqUdXH2O0MK2b88Q5bacG39U0A/5TyPEd55k+Hz+LFQlVbTq0aLHDYnDBXXwJW1WC2Vy/YxM21duTWtfZaNyhfOS9msbKInWSshRKukgJkS0JwMlcs2d8rwMgQx4FaZ8MNIIZ6M78BHiFQXJKPhkHMkdkQswcy4/5urUPHSh7tEflp0VMicnCmJA6WzaapUD/XPWeaskKJA1You2panafrvT4YKYJlHL2AoH1Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=QVzSh51IMMqVZrS6N+jS2h5ZWen76SYhzg4vlBnwQA4=; b=eFkdq3PpszV7bThhB2MfDgTgUyrHxC2tMuZJtZeaWBgQ5aXc9yk/8W7K6hb3X3yaWmh1QmrQ4NLTs32+qAE7szb3e5b5MuqZaCxjx86XnB2dws9xLeveEulBC1KfXoObQf1QUdVkGesh8eQGUU8cnV5s0NF+NMhydxUeOGYOnlzvHplOZmjbBfiCzYUrNdVyy5/HQI8xtrKMpkV169MTwGGBh6nHmQazVLrWV82lXKK1MFBNPbEw8m383PWiITieylsonoxoBsIfbGzaD45N4G6oJdf86mE0i7AgSa8onuWK9D3rmZRzzxebbD7/0DEiojZ7/xdbewDCeYwp1lx5SQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=sourceware.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none Received: from MW4PR03CA0310.namprd03.prod.outlook.com (2603:10b6:303:dd::15) by PH7PR12MB5593.namprd12.prod.outlook.com (2603:10b6:510:133::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5813.18; Wed, 16 Nov 2022 12:37:18 +0000 Received: from CO1NAM11FT029.eop-nam11.prod.protection.outlook.com (2603:10b6:303:dd:cafe::6) by MW4PR03CA0310.outlook.office365.com (2603:10b6:303:dd::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5813.19 via Frontend Transport; Wed, 16 Nov 2022 12:37:18 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by CO1NAM11FT029.mail.protection.outlook.com (10.13.174.214) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.5834.8 via Frontend Transport; Wed, 16 Nov 2022 12:37:17 +0000 Received: from khazad-dum.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.34; Wed, 16 Nov 2022 06:37:15 -0600 To: CC: , Lancelot SIX Subject: [PATCH v3] gdb/gcore: interrupt all threads before generating the corefile Date: Wed, 16 Nov 2022 12:36:49 +0000 Message-ID: <20221116123649.2430701-1-lancelot.six@amd.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Originating-IP: [10.180.168.240] X-ClientProxiedBy: SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1NAM11FT029:EE_|PH7PR12MB5593:EE_ X-MS-Office365-Filtering-Correlation-Id: e5a20610-17f8-4622-506a-08dac7cf4c45 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: jgWQqFluCfSR359Fqf/Oc5uyNwm6xO5FZqIyNmaAeYWcvqh5gwx36qeM/V3uqAwADZb+IGEbenmf7TtgQvG5ZMBAZ6JxkSvr1lFOS8kPfprFzf/Yd2d14Yn9i1khRNe32W08R0tDAy989Vfjbw0FmS8MHsJzM6W9PCxAn+HTBhgLakUaaVXKddQRMm3WVkLpYQCVPWp1EhebU1Gciqo7M4yXDyQ0M9YoLxjCkKGxEYfMqmn0bfDa7Cr6bGRHdSQmhSzCmM0DJnFXfmit08QIe7N/QPVOTvzIKTI4RHXDJDHJDLqLosEn2tDiPMyVwn7S/2UvY9Ne17DdfycRZZJ+EAHFSYpLqCcKZs6BBJ0qWSjBHogNt04HSEMKHMkeIt8KvGyNAQRapM9vvqBCfX7UOFnhHMFT0id8VXUewOeTRddnUt0JpheGSgu4l8mPZHNkJmjhziyzsPjTti7XFzd1cvQmcE6GzfBeY3bSDrHEaPaISs0/Y6B1ptRlHZqy1WI/s18cLLwNhEdaILb/JPmaQk+Dl51ficoxgk4RLVjyVBHwAyvmVwhKTCsXV4cj500LbdZ4S4sXWQjXJoMmUZEq9IvFEVpRSMDObeN/EgLk/b2lNFrOBvno2vNiB90ZDiN/ynpgKjm6pm2hauy4pXoYFgbDF3hlsfRxwvQCD+BMh81uoOFTVT9nchgRGl8J4Qb8U6V/Mvye4gAI84uUrDdjuzOiHB54pJ00f4Rqj3WibpSN/eMZl2W7EBr72VO24rv/LKc+jGO1yqhmj2WOtkq9EmLc1mdTMsCrPRuGQVpiRKBHC7IHyP4igcfhGwMIJ+o59dB1+GcJsxOTd6hT9swH+otSvILgev8X5blluJsravE= X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230022)(4636009)(396003)(376002)(136003)(39860400002)(346002)(451199015)(46966006)(36840700001)(40470700004)(8676002)(5660300002)(70206006)(86362001)(54906003)(1076003)(36860700001)(16526019)(4326008)(426003)(36756003)(83380400001)(47076005)(40480700001)(8936002)(2616005)(316002)(70586007)(2906002)(30864003)(6916009)(82310400005)(82740400003)(966005)(40460700003)(478600001)(186003)(7696005)(336012)(356005)(26005)(81166007)(66899015)(41300700001)(6666004)(2004002)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Nov 2022 12:37:17.6709 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: e5a20610-17f8-4622-506a-08dac7cf4c45 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT029.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR12MB5593 X-Spam-Status: No, score=-11.9 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_PASS, SPF_PASS, 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.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Lancelot SIX via Gdb-patches From: Lancelot SIX Reply-To: Lancelot SIX Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Hi, This is a V3 following https://sourceware.org/pipermail/gdb-patches/2022-October/192746.html. Noticeable changes since V2: - The test have been updated following Pedro's comment to be compatible with --target_board=native-extended-gdbserver. - Running the entire testsuite against gdbserver revealed that the original implementation was incompatible with all-stop targets. The V3 improves the implementation to support both all-stop and non-stop targets. This patch have been regression tested against gdb and gdbserver (native-extended-gdbserver). All feedbacks are welcome. Best, Lancelot --- In non-stop mode, if the user tries to generate a core dump (using the gcore command) while some threads are running, a non-helpful error message is shown. Lets consider the following session as an example (debugging the test program included in this patch): (gdb) set non-stop on (gdb) b 37 (gdb) r Thread 1 "gcore-nonstop" hit Breakpoint 1, main () at gcore-nonstop.c:39 (gdb) info thread Id Target Id Frame * 1 Thread 0x7ffff7d7a740 (LWP 431838) "gcore-nonstop" main () at gcore-nonstop.c:39 2 Thread 0x7ffff7d79640 (LWP 431841) "gcore-nonstop" (running) (gdb) gcore Couldn't get registers: No such process. The reported error ("No such process") does not help the user understand what happens. This is due to the fact that we cannot access the registers of a running thread. Even if we ignore this error, generating a core dump while any thread might update memory would most likely result in a core file with an inconsistent view of the process' memory. To solve this, this patch proposes to change the gcore command so it first stops all running threads (from the current inferior) before generating the corefile, and then resumes them in their previous state. To achieve this, this patch exposes the restart_threads function in infrun.h (used to be local to infrun.c). We also allow the first parameter (event_thread) to be nullptr as it is possible that the gcore command is called while all threads are running, in which case we want all threads to be restarted at the end of the procedure. When testing this patch against gdbserver, it appears that using stop_all_threads / restart_threads was not compatible with all-stop targets. For those targets, we need to call target_stop_and_wait / target_resume. The gcore_command has code to handle both configurations. I could not use a RAII-like object to have a cleaner way to restore the state at the end as the restore procedure could throw. Instead, the procedure keeps track of which method was used to interrupt threads so the appropriate method can be used to restore their state. Tested on x86_64 on navite GDB and the native-extended-gdbserver board. --- gdb/NEWS | 5 ++ gdb/doc/gdb.texinfo | 5 ++ gdb/gcore.c | 37 ++++++++++++ gdb/infrun.c | 16 ++--- gdb/infrun.h | 9 +++ gdb/testsuite/gdb.base/gcore-nonstop.c | 44 ++++++++++++++ gdb/testsuite/gdb.base/gcore-nonstop.exp | 77 ++++++++++++++++++++++++ 7 files changed, 182 insertions(+), 11 deletions(-) create mode 100644 gdb/testsuite/gdb.base/gcore-nonstop.c create mode 100644 gdb/testsuite/gdb.base/gcore-nonstop.exp diff --git a/gdb/NEWS b/gdb/NEWS index 3f31515297c..adc0963aecb 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -128,6 +128,11 @@ set style tui-current-position [on|off] * Changed commands +gcore + GDB now ensures that all threads of the current inferior are stopped + before generating a core dump. At the end of the command, threads are + restored to their previous state. + document user-defined It is now possible to document user-defined aliases. When a user-defined alias is documented, the help and apropos commands diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index f5f664fd168..ec2eba4b410 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -13570,6 +13570,11 @@ Produce a core dump of the inferior process. The optional argument specified, the file name defaults to @file{core.@var{pid}}, where @var{pid} is the inferior process ID. +@value{GDBN} ensures that all threads of the current inferior are stopped +while generating the core dump. If any of the inferior's thread is found +running when executing this command, @value{GDBN} stops it and resumes it +when the command is done. + Note that this command is implemented only for some systems (as of this writing, @sc{gnu}/Linux, FreeBSD, Solaris, and S390). diff --git a/gdb/gcore.c b/gdb/gcore.c index ede78534bd8..dda9e7af50b 100644 --- a/gdb/gcore.c +++ b/gdb/gcore.c @@ -34,6 +34,7 @@ #include "regset.h" #include "gdb_bfd.h" #include "readline/tilde.h" +#include "infrun.h" #include #include "gdbsupport/gdb_unlinker.h" #include "gdbsupport/byte-vector.h" @@ -131,6 +132,35 @@ gcore_command (const char *args, int from_tty) if (!target_has_execution ()) noprocess (); + scoped_restore_current_thread restore_current_thread; + scoped_disable_commit_resumed disable_commit_resume ("generating coredump"); + struct inferior *inf = current_inferior (); + scoped_finish_thread_state finish_state (inf->process_target (), + ptid_t (inferior_ptid.pid ())); + bool all_stop_was_running = false; + if (exists_non_stop_target ()) + stop_all_threads ("generating coredump", inf); + else + { + for (thread_info *t + : all_non_exited_threads (inf->process_target (), + ptid_t (inferior_ptid.pid ()))) + { + /* All threads are executing or none is, no need to go through the + entire list. */ + all_stop_was_running = t->executing (); + break; + } + + if (all_stop_was_running) + { + if (!may_stop) + error (_("Cannot stop the target to generate the core dump.")); + + target_stop_and_wait (ptid_t (inferior_ptid.pid ())); + } + } + if (args && *args) corefilename.reset (tilde_expand (args)); else @@ -161,6 +191,13 @@ gcore_command (const char *args, int from_tty) } gdb_printf ("Saved corefile %s\n", corefilename.get ()); + + if (exists_non_stop_target ()) + restart_threads (nullptr, inf); + else if (all_stop_was_running) + target_resume (ptid_t (inferior_ptid.pid ()), 0, GDB_SIGNAL_0); + + disable_commit_resume.reset_and_commit (); } static enum bfd_architecture diff --git a/gdb/infrun.c b/gdb/infrun.c index 6da46b75ac7..c7c8ad5456f 100644 --- a/gdb/infrun.c +++ b/gdb/infrun.c @@ -96,9 +96,6 @@ static void resume (gdb_signal sig); static void wait_for_inferior (inferior *inf); -static void restart_threads (struct thread_info *event_thread, - inferior *inf = nullptr); - static bool start_step_over (void); static bool step_over_info_valid_p (void); @@ -5886,18 +5883,15 @@ handle_inferior_event (struct execution_control_state *ecs) } } -/* Restart threads back to what they were trying to do back when we - paused them (because of an in-line step-over or vfork, for example). - The EVENT_THREAD thread is ignored (not restarted). - - If INF is non-nullptr, only resume threads from INF. */ +/* See infrun.h. */ -static void +void restart_threads (struct thread_info *event_thread, inferior *inf) { INFRUN_SCOPED_DEBUG_START_END ("event_thread=%s, inf=%d", - event_thread->ptid.to_string ().c_str (), - inf != nullptr ? inf->num : -1); + (event_thread != nullptr + ? event_thread->ptid.to_string ().c_str () + : "None"), inf != nullptr ? inf->num : -1); gdb_assert (!step_over_info_valid_p ()); diff --git a/gdb/infrun.h b/gdb/infrun.h index c711b9b21cc..4cd98ec06c5 100644 --- a/gdb/infrun.h +++ b/gdb/infrun.h @@ -175,6 +175,15 @@ extern void nullify_last_target_wait_ptid (); all threads of all inferiors. */ extern void stop_all_threads (const char *reason, inferior *inf = nullptr); +/* Restart threads back to what they were trying to do back when we + paused them (because of an in-line step-over or vfork, for example). + The EVENT_THREAD thread, if non-nullptr, is ignored (not restarted). + + If INF is non-nullptr, only resume threads from INF. */ + +extern void restart_threads (struct thread_info *event_thread, + inferior *inf = nullptr); + extern void prepare_for_detach (void); extern void fetch_inferior_event (); diff --git a/gdb/testsuite/gdb.base/gcore-nonstop.c b/gdb/testsuite/gdb.base/gcore-nonstop.c new file mode 100644 index 00000000000..191a1a26849 --- /dev/null +++ b/gdb/testsuite/gdb.base/gcore-nonstop.c @@ -0,0 +1,44 @@ +/* This testcase is part of GDB, the GNU debugger. + + Copyright 2022 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 . */ + +#include + +static pthread_barrier_t barrier; + +static void * +worker_func (void *) +{ + pthread_barrier_wait (&barrier); + return NULL; +} + +int +main (void) +{ + pthread_t worker_thread; + pthread_barrier_init (&barrier, NULL, 2); + + pthread_create (&worker_thread, NULL, worker_func, NULL); + + /* Break here. */ + + pthread_barrier_wait (&barrier); + pthread_join (worker_thread, NULL); + pthread_barrier_destroy (&barrier); + + return 0; +} diff --git a/gdb/testsuite/gdb.base/gcore-nonstop.exp b/gdb/testsuite/gdb.base/gcore-nonstop.exp new file mode 100644 index 00000000000..56fc909b00b --- /dev/null +++ b/gdb/testsuite/gdb.base/gcore-nonstop.exp @@ -0,0 +1,77 @@ +# Copyright 2022 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 . + +# This testcase checks that when in non-stop mode with some threads running +# the gcore command can interrupt all threads, generate a core dump and +# restart threads as required. + +standard_testfile + +if { [prepare_for_testing "failed to prepare" \ + ${testfile} ${srcfile} {threads debug}] } { + return +} + +save_vars { GDBFLAGS } { + append GDBFLAGS " -ex \"set non-stop on\"" + clean_restart ${binfile} +} + +set lineno [gdb_get_line_number "Break here"] +if { ![runto $lineno] } { + return +} + +# We should be stopped in thread 1 while thread 2 is running. +gdb_test_sequence "info threads" "info threads" { + {Id\s+Target Id\s+Frame} + {\*\s+1[^\n]*\n} + {\s+2\s+[^\n]*\(running\)[^\n]*\n} +} + +set th1_pc "" +gdb_test_multiple "p/x \$pc" "fetch thread 1 PC" { + -wrap -re "$::decimal = ($::hex)" { + set th1_pc $expect_out(1,string) + pass $gdb_test_name + } +} + +set corefile [standard_output_file "corefile"] +if {![gdb_gcore_cmd $corefile "generate corefile"]} { + # gdb_gcore_cmd issues a "UNSUPPORTED". + return +} + +# After the core file is generated, thread 2 should be back running +# and thread 1 should still be selected. +gdb_test_sequence "info threads" "correct thread selection after gcore" { + {Id\s+Target Id\s+Frame} + {\*\s+1[^\n]*\n} + {\s+2\s+[^\n]*\(running\)[^\n]*\n} +} + +# Thread 1 is at the same stop it was before calling the gcore command. +gdb_test "p/x \$pc" "\\\$$::decimal = $th1_pc" "thread 1 unchanged" + +clean_restart $binfile +gdb_test "core-file $corefile" "Core was generated by.*" "load corefile" + +# The core file has the 2 threads. +gdb_test_sequence "info threads" "threads in corefile" { + {Id\s+Target Id\s+Frame} + {\s+1\s+Thread[^\n]*\n} + {\s+2\s+Thread[^\n]*\n} +}