From patchwork Sat Dec 17 00:15:25 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Aaron Merey X-Patchwork-Id: 62085 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 576BA3830FD9 for ; Sat, 17 Dec 2022 00:17:37 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 576BA3830FD9 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1671236257; bh=tzFDMAzb2F0gunEAtWHeTMP9o8XhAxQBjsRGDFxJ+kk=; h=To:Cc:Subject:Date:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From:Reply-To:From; b=QDn7IU8p3ifBxgKm9HfYvIio3/KXZOXfvJWujLMwJaBJ+ewAJdL4HoY98OIFnHcd7 PFYxTAKuRtrF4q3u8kh21FRf2YjR3bCK746tL8lCye4g0nX2bU7sl5SanJ5czvrAcW 4BQcYa/i1AZxrTmu10zD7S9YsBUorny8TmTTfSLY= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id C83DA383437B for ; Sat, 17 Dec 2022 00:15:55 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org C83DA383437B Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-444-xhyX9idvMta9lR2PMZrkKg-1; Fri, 16 Dec 2022 19:15:54 -0500 X-MC-Unique: xhyX9idvMta9lR2PMZrkKg-1 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 091C2811E6E; Sat, 17 Dec 2022 00:15:54 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.22.17.230]) by smtp.corp.redhat.com (Postfix) with ESMTP id C5CAA40C2064; Sat, 17 Dec 2022 00:15:52 +0000 (UTC) To: gdb-patches@sourceware.org Cc: pedro@palves.net, tdevries@suse.de, Aaron Merey , =?utf-8?q?Martin_Li=C5=A1ka?= Subject: [PATCH v2] [gdb/debuginfod] Ask to cancel further downloads Date: Fri, 16 Dec 2022 19:15:25 -0500 Message-Id: <20221217001525.82647-1-amerey@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.3 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, 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.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Aaron Merey via Gdb-patches From: Aaron Merey Reply-To: Aaron Merey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" v1 can be found here: https://sourceware.org/pipermail/gdb-patches/2022-September/192188.html v2 adds ^C pressed-twice functionality to debuginfod downloads based on Pedro's feedback: https://sourceware.org/pipermail/gdb-patches/2022-September/192225.html Currently gdb only allows for debuginfod downloads to be cancelled one at a time via ^C. This can be a burden if one wishes to cancel a large series of downloads. Additionally there can also be ambiguity between whether ^C during a download was intended to cancel the download or interrupt the inferior. This patch addresses these issues by adding a new debuginfod setting and changing the behavior of ^C during a download. Add a new command "set debuginfod cancel one/all/ask", where: - "one" means ^C cancels one download, - "all" means ^C cancels all further downloads, and - "ask" means ^C asks whether to cancel all further downloads. A "yes" implies "set debuginfod cancel all", and a "no" implies "set debuginfod cancel one", so the question is only asked once. Note that the behaviour as it was before this patch is equivalent to "set debuginfod cancel one". Instead, the new default is "set debuginfod cancel ask". Note that cancelling all further downloads implies "set debuginfod enabled off". Additionally, a single ^C during downloading now sets the quit_flag and proceeds with all downloads. If the inferior has the terminal, then a second ^C during downloading triggers a query asking whether to cancel the download or interrupt the inferior. If the user wishes to cancel the download then the setting of 'set debuginfod cancel' determines whether one or all downloads are cancelled. In the case of "set debuginfod cancel ask", there will be another query at this point asking whether to cancel one or all downloads. If the inferior does not have the terminal, then a second ^C during downloading simply cancels the download according to the setting of "set debuginfod cancel". In this case there is no query asking whether to interrupt the inferior or cancel a download. Example session where inferior has terminal: (gdb) run [...] Downloading separate debug info for /lib64/libxyz.so [### ]^C^C Cancel the current download? If no, then ^C will be sent to the target process. ([y] or n) y Cancelling download of separate debug info for /lib64/libxyz.so... Cancel further downloading for this session? (y or [n]) n Downloading separate debug info for /lib64/libabcd.so Example session where inferior does not have terminal: (gdb) run [...] Downloading separate debug info for /lib64/libxyz.so [### ]^C^C Cancelling download of separate debug info for /lib64/libxyz.so... Cancel further downloading for this session? (y or [n]) y Debuginfod has been disabled. To re-enable use the 'set debuginfod enabled on' command. Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=29582 Suggested-By: Martin Liška Co-Authored-By: Tom de Vries --- gdb/debuginfod-support.c | 131 +++++++++++++++++++++++++++++++++++++-- gdb/doc/gdb.texinfo | 23 +++++++ 2 files changed, 150 insertions(+), 4 deletions(-) diff --git a/gdb/debuginfod-support.c b/gdb/debuginfod-support.c index f1249203da0..da4af4a144b 100644 --- a/gdb/debuginfod-support.c +++ b/gdb/debuginfod-support.c @@ -34,6 +34,8 @@ static cmd_list_element *show_debuginfod_prefix_list; static const char debuginfod_on[] = "on"; static const char debuginfod_off[] = "off"; static const char debuginfod_ask[] = "ask"; +static const char debuginfod_one[] = "one"; +static const char debuginfod_all[] = "all"; static const char *debuginfod_enabled_enum[] = { @@ -43,6 +45,20 @@ static const char *debuginfod_enabled_enum[] = nullptr }; +/* Valid values for set debuginfod cancel command. */ + +static const char *debuginfod_cancel_enum[] = +{ + debuginfod_one, + debuginfod_all, + debuginfod_ask, + nullptr +}; + +/* Value of debuginfod cancellation mode. */ + +static const char *debuginfod_cancel = debuginfod_ask; + static const char *debuginfod_enabled = #if defined(HAVE_LIBDEBUGINFOD) debuginfod_ask; @@ -88,9 +104,11 @@ debuginfod_exec_query (const unsigned char *build_id, struct user_data { user_data (const char *desc, const char *fname) - : desc (desc), fname (fname) + : pass_quit_flag (false), inf_had_term (false), desc (desc), fname (fname) { } + bool pass_quit_flag; + bool inf_had_term; const char * const desc; const char * const fname; ui_out::progress_update progress; @@ -148,9 +166,45 @@ progressfn (debuginfod_client *c, long cur, long total) if (check_quit_flag ()) { - gdb_printf ("Cancelling download of %s %s...\n", - data->desc, styled_fname.c_str ()); - return 1; + /* If a single ^C occurs during downloading, let it propagate to the + target. If more than one ^C occurs, ask whether to cancel the + current download or interrupt the target. If the download is + cancelled, the setting of debuginfod_cancel will determine whether + the current download is cancelled or debuginfod is disabled. */ + if (!data->pass_quit_flag) + data->pass_quit_flag = true; + else + { + int resp = 1; + + if (data->inf_had_term) + resp = yquery (_("Cancel the current download?\nIf no, then ^C " + "will be sent to the target process. ")); + if (resp) + { + gdb_printf (_("Cancelling download of %s %s...\n"), + data->desc, styled_fname.c_str ()); + if (debuginfod_cancel == debuginfod_ask) + { + resp = nquery + (_("Cancel further downloading for this session? ")); + if (resp) + debuginfod_cancel = debuginfod_all; + else + debuginfod_cancel = debuginfod_one; + } + if (debuginfod_cancel == debuginfod_all) + { + gdb_printf (_("Debuginfod has been disabled.\nTo re-enable " + "use the 'set debuginfod enabled on' " + "command.\n")); + debuginfod_enabled = debuginfod_off; + } + + data->pass_quit_flag = false; + return 1; + } + } } if (debuginfod_verbose == 0) @@ -293,6 +347,10 @@ debuginfod_source_query (const unsigned char *build_id, user_data data ("source file", srcpath); debuginfod_set_user_data (c, &data); + + if (!target_terminal::is_ours ()) + data.inf_had_term = true; + gdb::optional term_state; if (target_supports_terminal_ours ()) { @@ -308,6 +366,10 @@ debuginfod_source_query (const unsigned char *build_id, debuginfod_set_user_data (c, nullptr); print_outcome (data, fd.get ()); + if (data.pass_quit_flag) + set_quit_flag (); + if (data.inf_had_term && term_state.has_value ()) + target_terminal::inferior (); if (fd.get () >= 0) destname->reset (dname); @@ -334,6 +396,10 @@ debuginfod_debuginfo_query (const unsigned char *build_id, user_data data ("separate debug info for", filename); debuginfod_set_user_data (c, &data); + + if (!target_terminal::is_ours ()) + data.inf_had_term = true; + gdb::optional term_state; if (target_supports_terminal_ours ()) { @@ -346,6 +412,10 @@ debuginfod_debuginfo_query (const unsigned char *build_id, debuginfod_set_user_data (c, nullptr); print_outcome (data, fd.get ()); + if (data.pass_quit_flag) + set_quit_flag (); + if (data.inf_had_term && term_state.has_value ()) + target_terminal::inferior (); if (fd.get () >= 0) destname->reset (dname); @@ -372,6 +442,10 @@ debuginfod_exec_query (const unsigned char *build_id, user_data data ("executable for", filename); debuginfod_set_user_data (c, &data); + + if (!target_terminal::is_ours ()) + data.inf_had_term = true; + gdb::optional term_state; if (target_supports_terminal_ours ()) { @@ -383,6 +457,10 @@ debuginfod_exec_query (const unsigned char *build_id, debuginfod_set_user_data (c, nullptr); print_outcome (data, fd.get ()); + if (data.pass_quit_flag) + set_quit_flag (); + if (data.inf_had_term && term_state.has_value ()) + target_terminal::inferior (); if (fd.get () >= 0) destname->reset (dname); @@ -423,6 +501,33 @@ show_debuginfod_enabled (ui_file *file, int from_tty, cmd_list_element *cmd, "\"%s\".\n"), debuginfod_enabled); } +/* Set callback for "set debuginfod cancel". */ + +static void +set_debuginfod_cancel (const char *value) +{ + debuginfod_cancel = value; +} + +/* Get callback for "set debuginfod cancel". */ + +static const char * +get_debuginfod_cancel () +{ + return debuginfod_cancel; +} + +/* Show callback for "set debuginfod cancel". */ + +static void +show_debuginfod_cancel (ui_file *file, int from_tty, cmd_list_element *cmd, + const char *value) +{ + gdb_printf (file, + _("Debuginfod cancellation mode is currently set to " + "\"%s\".\n"), debuginfod_cancel); +} + /* Set callback for "set debuginfod urls". */ static void @@ -503,6 +608,24 @@ source files."), &set_debuginfod_prefix_list, &show_debuginfod_prefix_list); + add_setshow_enum_cmd ("cancel", class_run, debuginfod_cancel_enum, + _("Set cancellation mode for debuginfod."), + _("Show cancellation mode for debuginfod."), + _("\ +The cancellation mode modifies the behavior of ^C while a file is downloading\ + from debuginfod.\nWhen set to one, two ^C cancels a single download.\n\ +When set to all, two ^C cancels all further downloads.\n\ +When set to ask, two ^C asks what to do.\nA single ^C during downloading is\ + passed to the target process being debugged.\nA second ^C during downloading\ + may raise a prompt asking whether to cancel the download or send ^C to the\ + target.\nIf the download is to be cancelled, the cancellation mode takes\ + effect and no ^C is sent to the target."), + set_debuginfod_cancel, + get_debuginfod_cancel, + show_debuginfod_cancel, + &set_debuginfod_prefix_list, + &show_debuginfod_prefix_list); + /* set/show debuginfod urls */ add_setshow_string_noescape_cmd ("urls", class_run, _("\ Set the list of debuginfod server URLs."), _("\ diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index bababf3c7ff..246854d229a 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -48270,6 +48270,29 @@ is set to @code{ask} for interactive sessions. Display whether @code{debuginfod enabled} is set to @code{on}, @code{off} or @code{ask}. +@kindex set debuginfod cancel +@anchor{set debuginfod cancel} +@item set debuginfod cancel +@itemx set debuginfod cancel one +@cindex debuginfod cancellation mode +Pressing @code{^C} twice during downloading will cancel the current +download. + +@item set debuginfod cancel all +Pressing @code{^C} twice during downloading will cancel all further +downloads. + +@item set debuginfod cancel ask +Pressing @code{^C} twice during a download will prompt the user to +cancel all further downloads before attempting to perform the next query. +By default, @code{debuginfod cancel} is set to @code{ask} for interactive +sessions. + +@kindex show debuginfod cancel +@item show debuginfod cancel +Display whether @code{debuginfod cancel} is set to @code{one}, @code{all} or +@code{ask}. + @kindex set debuginfod urls @cindex configure debuginfod URLs @item set debuginfod urls