From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTPS id 95A5E3858407 for ; Thu, 8 Sep 2022 01:58:43 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 95A5E3858407 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-397-mJQEcSsQMc-CBlNUFzVsaQ-1; Wed, 07 Sep 2022 21:58:42 -0400 X-MC-Unique: mJQEcSsQMc-CBlNUFzVsaQ-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D2165803301; Thu, 8 Sep 2022 01:58:41 +0000 (UTC) Received: from f36-1.lan (unknown [10.2.16.60]) by smtp.corp.redhat.com (Postfix) with ESMTP id 507AC141511A; Thu, 8 Sep 2022 01:58:41 +0000 (UTC) From: Kevin Buettner To: gdb-patches@sourceware.org Cc: lsix@lancelotsix.com, simark@simark.ca, Kevin Buettner Subject: [PATCH v3 1/2] Suppress printing of superfluous BFD error messages Date: Wed, 7 Sep 2022 18:58:11 -0700 Message-Id: <20220908015812.12175-2-kevinb@redhat.com> In-Reply-To: <20220908015812.12175-1-kevinb@redhat.com> References: <20220908015812.12175-1-kevinb@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-Spam-Status: No, score=-11.0 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_LOW, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE 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-List-Received-Date: Thu, 08 Sep 2022 01:58:47 -0000 This commit adds a hook to the BFD error handler for suppressing identical messages which have been output once already. It's motivated by this Fedora bug... https://bugzilla.redhat.com/show_bug.cgi?id=2083315 ...in which over 900,000 BFD error messages are output when attaching to firefox. From the bug report, the messages all say: BFD: /usr/lib/debug/usr/lib64/firefox/libxul.so-100.0-2.fc35.x86_64.debug: attempt to load strings from a non-string section (number 38) Since there's no (additional) context which might assist the user in determining what's wrong, there's really no point in outputting more than one message. Of course, if BFD should output some other/different message, it should be output too, but all future messages identical to those already output should be suppressed. For the firefox problem, it turned out that there were only 37 sections, but something was referring to section #38. I haven't investigated further to find out how this came to be. Despite this problem, useful debugging might still be done, especially if the user doesn't care about debugging the problematic library. If it turns out that knowing the quantity of messages might be useful, I've implemented the suppression mechanism by keeping a count of each identical message. A new GDB command, perhaps a 'maintenance' command, could be added to print out each message along with the count. I haven't implemented this though because I'm not convinced of its utility. Also, the BFD message printer has support for BFD- specific format specifiers. The BFD message strings that GDB stores in its map are sufficient for distinguishing messages from each other, but are not identical to those output by BFD's default error handler. So, that problem would need to be solved too. --- gdb/gdb_bfd.c | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/gdb/gdb_bfd.c b/gdb/gdb_bfd.c index 6c03ae5ef05..6299148d419 100644 --- a/gdb/gdb_bfd.c +++ b/gdb/gdb_bfd.c @@ -33,6 +33,7 @@ #include "gdb/fileio.h" #include "inferior.h" #include "cli/cli-style.h" +#include /* An object of this type is stored in the section's user data when mapping a section. */ @@ -1125,6 +1126,69 @@ maintenance_info_bfds (const char *arg, int from_tty) htab_traverse (all_bfds, print_one_bfd, uiout); } +/* BFD related per-inferior data. */ + +struct bfd_inferior_data +{ + std::unordered_map bfd_error_string_counts; +}; + +/* Per-inferior data key. */ + +static const registry::key bfd_inferior_data_key; + +/* Fetch per-inferior BFD data. It always returns a valid pointer to + a bfd_inferior_data struct. */ + +static struct bfd_inferior_data * +get_bfd_inferior_data (struct inferior *inf) +{ + struct bfd_inferior_data *data; + + data = bfd_inferior_data_key.get (inf); + if (data == nullptr) + data = bfd_inferior_data_key.emplace (inf); + + return data; +} + +/* Increment the BFD error count for STR and return the updated + count. */ + +static unsigned long +increment_bfd_error_count (std::string str) +{ + struct bfd_inferior_data *bid = get_bfd_inferior_data (current_inferior ()); + + auto &map = bid->bfd_error_string_counts; + return ++map[std::move (str)]; +} + +static bfd_error_handler_type default_bfd_error_handler; + +/* Define a BFD error handler which will suppress the printing of + messages which have been printed once already. This is done on a + per-inferior basis. */ + +static void +gdb_bfd_error_handler (const char *fmt, va_list ap) +{ + va_list ap_copy; + + va_copy(ap_copy, ap); + const std::string str = string_vprintf (fmt, ap_copy); + va_end (ap_copy); + + if (increment_bfd_error_count (std::move (str)) > 1) + return; + + /* We must call the BFD mechanism for printing format strings since + it supports additional format specifiers that GDB's vwarning() doesn't + recognize. It also outputs additional text, i.e. "BFD: ", which + makes it clear that it's a BFD warning/error. */ + (*default_bfd_error_handler) (fmt, ap); +} + void _initialize_gdb_bfd (); void _initialize_gdb_bfd () @@ -1157,4 +1221,7 @@ When non-zero, bfd cache specific debugging is enabled."), NULL, &show_bfd_cache_debug, &setdebuglist, &showdebuglist); + + /* Hook the BFD error/warning handler to limit amount of output. */ + default_bfd_error_handler = bfd_set_error_handler (gdb_bfd_error_handler); } -- 2.37.3