From patchwork Mon Oct 16 09:17:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom de Vries X-Patchwork-Id: 77873 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 98CE1385770B for ; Mon, 16 Oct 2023 09:18:35 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from smtp-out1.suse.de (smtp-out1.suse.de [IPv6:2001:67c:2178:6::1c]) by sourceware.org (Postfix) with ESMTPS id 114E73857724 for ; Mon, 16 Oct 2023 09:17:29 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 114E73857724 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=suse.de Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=suse.de ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 114E73857724 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=2001:67c:2178:6::1c ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1697447851; cv=none; b=KpFH963n84nAA1KqynY5rK34T6vaQv0r3bIM8RU4+nQp4eFOpdPBg4TcAbi1LBKsJPAzhstrFVKhqLVVPGTKF46I0ijPGQswp1mRzEo+PSLc3gOAvkePNNbH2t86pOYwX7h78cLMqFBh4UquvMOV8E8xYCqsl1b6mPvt1RHJ2Zc= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1697447851; c=relaxed/simple; bh=v90bZ4NLaes8C1TbXg4XLRdSFG/SczifjhSEX8cE4Fk=; h=DKIM-Signature:DKIM-Signature:From:To:Subject:Date:Message-Id: MIME-Version; b=lhB9+s+za9YfD2fc2d13kD2n9Xzr9Km18VShQZvdbTV5miFtoS5kW7XZWYHW4vh6LRWgcbsjR9P6CY8GF5id1R+TTYG1tp2kRQ2mWScql7fsuTgBU13xmQb0uPR5CZw01WZROYOQ8u1yjD2R3DbILYjZ6Y5JShMVIGIiV4I2CM4= ARC-Authentication-Results: i=1; server2.sourceware.org Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 8117221B62 for ; Mon, 16 Oct 2023 09:17:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1697447847; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=+TWlsD3fgTMx6XT6c4X4d/GHM5K/jAUAEWRSlxlcD/4=; b=e3prIEu8i5PvZtZDmKfv1xr1g6Ca07hVYX32XLfwEEwfO+12zAMXoBS9LXRRFft0qTa7I5 DgYrtgm20IkI6gnuzNQAATwT5XVVkavaW8fqKmjIcTfhWL9ZSW+B9NlSKzF8CBskPfsAUb 7Tpf7nJI1sWSqdf0vuIZIQYzsrtdmAc= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1697447847; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=+TWlsD3fgTMx6XT6c4X4d/GHM5K/jAUAEWRSlxlcD/4=; b=Jh3jXiVXNwf198bIhwLQLSOj5XIw9cK+MTFur5gJl51ikyCnJtGxF0viyrZKQmh7vy45TH amZFKKfL4pac6LDA== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 6D93413A20 for ; Mon, 16 Oct 2023 09:17:27 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id oL6vGaf/LGUXLQAAMHmgww (envelope-from ) for ; Mon, 16 Oct 2023 09:17:27 +0000 From: Tom de Vries To: gdb-patches@sourceware.org Subject: [PATCH v3 4/4] [gdb/cli] Allow source highlighting to be interrupted Date: Mon, 16 Oct 2023 11:17:48 +0200 Message-Id: <20231016091748.26247-5-tdevries@suse.de> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20231016091748.26247-1-tdevries@suse.de> References: <20231016091748.26247-1-tdevries@suse.de> MIME-Version: 1.0 Authentication-Results: smtp-out1.suse.de; none X-Spam-Score: 3.92 X-Spamd-Result: default: False [3.92 / 50.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; R_MISSING_CHARSET(2.50)[]; MIME_GOOD(-0.10)[text/plain]; PREVIOUSLY_DELIVERED(0.00)[gdb-patches@sourceware.org]; BROKEN_CONTENT_TYPE(1.50)[]; RCPT_COUNT_ONE(0.00)[1]; TO_DN_NONE(0.00)[]; DKIM_SIGNED(0.00)[suse.de:s=susede2_rsa,suse.de:s=susede2_ed25519]; NEURAL_HAM_SHORT(-0.98)[-0.980]; NEURAL_SPAM_LONG(3.00)[1.000]; MID_CONTAINS_FROM(1.00)[]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; BAYES_HAM(-3.00)[100.00%] 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, SPF_HELO_NONE, 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.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 In PR cli/30934, a problem is reported where gdb becomes unresponsive for 2m13s because the GNU source-highlight library is taking a lot of time to annotate the source. This is due to a problem in the library [1], for which I've posted a patch [2], which brings down the annotation time to 3s. However, GDB should not become unresponsive due to such a problem. Fix this by installing a srchilite::HighlightEventListener that: - checks whether ^C was pressed, and if so - asks the user whether it should interrupt highlighting, and if so - abandons the highlighting by throwing an exception. Interrupting the highlighting looks like this to the user: ... $ gdb -q a.out -ex "b 56" Reading symbols from a.out... Breakpoint 1 at 0x400e2a: file test.cpp, line 56. (gdb) r Starting program: /data/vries/gdb/a.out Breakpoint 1, Solution::numOfSubarrays () at test.cpp:56 ^CCancel source styling using GNU source highlight of /data/vries/gdb/test.cpp? ([y] or n) y 56 return (int) t; (gdb) ... Note that line 56 still can be highlighted, just by pygments instead of source-highlight. Tested on x86_64-linux. Co-Authored-By: Lancelot Six Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30934 [1] https://savannah.gnu.org/bugs/?64747 [2] https://savannah.gnu.org/patch/index.php?10400 --- gdb/source-cache.c | 68 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 66 insertions(+), 2 deletions(-) diff --git a/gdb/source-cache.c b/gdb/source-cache.c index aa8e40425c2..39d8bcf7aec 100644 --- a/gdb/source-cache.c +++ b/gdb/source-cache.c @@ -37,6 +37,7 @@ #include #include #include +#include #endif /* The number of source files we'll cache. */ @@ -189,6 +190,48 @@ get_language_name (enum language lang) return nullptr; } +/* Class with notify function called during highlighting. */ + +class gdb_highlight_event_listener : public srchilite::HighlightEventListener +{ +public: + gdb_highlight_event_listener (const std::string &fullname) + : m_fullname (fullname) + { + } + + void notify(const srchilite::HighlightEvent &event) override + { + /* If the terminal is ours, we can ask the user a question and get an + answer. */ + gdb_assert (target_terminal::is_ours ()); + + if (!check_quit_flag ()) + { + /* User didn't press ^C, nothing to do. */ + return; + } + + /* Ask the user what to do. */ + int resp + = yquery (_("Cancel source styling using GNU source highlight of %s?\n"), + m_fullname.c_str ()); + if (!resp) + { + /* Continue highlighting. */ + return; + } + + /* Interrupt highlighting. Note that check_quit_flag clears the + quit_flag, so we have to set it again. */ + set_quit_flag (); + QUIT; + } + +private: + const std::string &m_fullname; +}; + #endif /* HAVE_SOURCE_HIGHLIGHT */ /* Try to highlight CONTENTS from file FULLNAME in language LANG using @@ -223,9 +266,27 @@ try_source_highlight (std::string &contents ATTRIBUTE_UNUSED, highlighter->setStyleFile ("esc.style"); } + gdb_highlight_event_listener event_listener (fullname); + highlighter->setHighlightEventListener (&event_listener); + /* Make sure that the highlighter's EventListener doesn't become a + dangling pointer. */ + auto clear_event_listener = make_scope_exit ([]() + { + highlighter->setHighlightEventListener (nullptr); + }); + std::istringstream input (contents); std::ostringstream output; - highlighter->highlight (input, output, lang_name, fullname); + { + /* We want to be able to interrupt the call to source-highlight. If + the current quit_handler is infrun_quit_handler, pressing ^C is + ignored by QUIT (assuming target_terminal::is_ours), so install the + default quit handler. */ + scoped_restore restore_quit_handler + = make_scoped_restore (&quit_handler, default_quit_handler); + + highlighter->highlight (input, output, lang_name, fullname); + } contents = std::move (output).str(); styled = true; } @@ -304,13 +365,16 @@ source_cache::ensure (struct symtab *s) reasons: - the language is not supported. - the language cannot not be auto-detected from the file name. + - styling took too long and was interrupted by the user. - no stylers available. Since styling failed, don't try styling the file again after it drops from the cache. Note that clearing the source cache also clears - m_no_styling_files. */ + m_no_styling_files, so if styling took too long, and the user + interrupted it, and the source cache gets cleared, the user will + need to interrupt styling again. */ m_no_styling_files.insert (fullname); } }