From: Tom Tromey <tom@tromey.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tom@tromey.com>
Subject: [PATCH v2 20/32] Introduce thread-safe handling for complaints
Date: Thu, 4 Nov 2021 12:08:55 -0600 [thread overview]
Message-ID: <20211104180907.2360627-21-tom@tromey.com> (raw)
In-Reply-To: <20211104180907.2360627-1-tom@tromey.com>
This introduces a new class that can be used to make the "complaint"
code thread-safe. Instantiating the class installs a new handler that
collects complaints, and then prints them all when the object is
destroyed.
This approach requires some locks. I couldn't think of a better way
to handle this, though, because the I/O system is not thread-safe.
It seemed to me that only GDB developers are likely to enable
complaints, and because the complaint macro handle this case already
(before any locks are required), I reasoned that any performance
degradation that would result here would be fine.
As an aside about complaints -- are they useful at all? I just ignore
them, myself, since mostly they seem to indicate compiler problems
that can't be solved in the GDB world anyway. I'd personally prefer
them to be in a separate tool, like a hypothetical 'dwarflint'.
---
gdb/complaints.c | 68 ++++++++++++++++++++++++++++++++++++++++++++++--
gdb/complaints.h | 33 +++++++++++++++++++++++
2 files changed, 99 insertions(+), 2 deletions(-)
diff --git a/gdb/complaints.c b/gdb/complaints.c
index a823fcb0020..65fa2afe499 100644
--- a/gdb/complaints.c
+++ b/gdb/complaints.c
@@ -23,6 +23,7 @@
#include "gdbcmd.h"
#include "gdbsupport/selftest.h"
#include <unordered_map>
+#include <mutex>
/* Map format strings to counters. */
@@ -34,6 +35,10 @@ static std::unordered_map<const char *, int> counters;
int stop_whining = 0;
+#if CXX_STD_THREAD
+static std::mutex complaint_mutex;
+#endif /* CXX_STD_THREAD */
+
/* See complaints.h. */
void
@@ -41,8 +46,13 @@ complaint_internal (const char *fmt, ...)
{
va_list args;
- if (++counters[fmt] > stop_whining)
- return;
+ {
+#if CXX_STD_THREAD
+ std::lock_guard<std::mutex> guard (complaint_mutex);
+#endif
+ if (++counters[fmt] > stop_whining)
+ return;
+ }
va_start (args, fmt);
@@ -66,6 +76,60 @@ clear_complaints ()
counters.clear ();
}
+/* See complaints.h. */
+
+complaint_interceptor *complaint_interceptor::g_complaint_interceptor;
+
+/* See complaints.h. */
+
+complaint_interceptor::complaint_interceptor ()
+ : m_saved_warning_hook (deprecated_warning_hook)
+{
+ /* These cannot be stacked. */
+ gdb_assert (g_complaint_interceptor == nullptr);
+ g_complaint_interceptor = this;
+ deprecated_warning_hook = issue_complaint;
+}
+
+/* A helper that wraps a warning hook. */
+
+static void
+wrap_warning_hook (void (*hook) (const char *, va_list), ...)
+{
+ va_list args;
+ va_start (args, hook);
+ hook ("%s", args);
+ va_end (args);
+}
+
+/* See complaints.h. */
+
+complaint_interceptor::~complaint_interceptor ()
+{
+ for (const std::string &str : m_complaints)
+ {
+ if (m_saved_warning_hook)
+ wrap_warning_hook (m_saved_warning_hook, str.c_str ());
+ else
+ fprintf_filtered (gdb_stderr, _("During symbol reading: %s\n"),
+ str.c_str ());
+ }
+
+ g_complaint_interceptor = nullptr;
+ deprecated_warning_hook = m_saved_warning_hook;
+}
+
+/* See complaints.h. */
+
+void
+complaint_interceptor::issue_complaint (const char *fmt, va_list args)
+{
+#if CXX_STD_THREAD
+ std::lock_guard<std::mutex> guard (complaint_mutex);
+#endif
+ g_complaint_interceptor->m_complaints.insert (string_vprintf (fmt, args));
+}
+
static void
complaints_show_value (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd, const char *value)
diff --git a/gdb/complaints.h b/gdb/complaints.h
index 485dbb15860..144ce09fa5d 100644
--- a/gdb/complaints.h
+++ b/gdb/complaints.h
@@ -21,6 +21,8 @@
#if !defined (COMPLAINTS_H)
#define COMPLAINTS_H
+#include <unordered_set>
+
/* Helper for complaint. */
extern void complaint_internal (const char *fmt, ...)
ATTRIBUTE_PRINTF (1, 2);
@@ -46,5 +48,36 @@ extern int stop_whining;
extern void clear_complaints ();
+/* A class that can handle calls to complaint from multiple threads.
+ When this is instantiated, it hooks into the complaint mechanism,
+ so the 'complaint' macro can continue to be used. When it is
+ destroyed, it issues all the complaints that have been stored. It
+ should only be instantiated in the main thread. */
+
+class complaint_interceptor
+{
+public:
+
+ complaint_interceptor ();
+ ~complaint_interceptor ();
+
+ DISABLE_COPY_AND_ASSIGN (complaint_interceptor);
+
+private:
+
+ /* The issued complaints. */
+ std::unordered_set<std::string> m_complaints;
+
+ /* The saved value of deprecated_warning_hook. */
+ void (*m_saved_warning_hook) (const char *, va_list)
+ ATTRIBUTE_FPTR_PRINTF(1,0);
+
+ /* A helper function that is used by the 'complaint' implementation
+ to issue a complaint. */
+ static void issue_complaint (const char *, va_list);
+
+ /* This object. Used by the static callback function. */
+ static complaint_interceptor *g_complaint_interceptor;
+};
#endif /* !defined (COMPLAINTS_H) */
--
2.31.1
next prev parent reply other threads:[~2021-11-04 18:10 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-04 18:08 [PATCH v2 00/32] Rewrite the DWARF "partial" reader Tom Tromey
2021-11-04 18:08 ` [PATCH v2 01/32] Introduce make_unique_xstrndup Tom Tromey
2021-11-05 19:20 ` Simon Marchi
2021-11-05 20:08 ` Tom Tromey
2021-11-04 18:08 ` [PATCH v2 02/32] Split create_addrmap_from_aranges Tom Tromey
2021-11-04 18:08 ` [PATCH v2 03/32] Add dwarf2_per_cu_data::addresses_seen Tom Tromey
2021-11-04 18:08 ` [PATCH v2 04/32] Refactor dwarf2_get_pc_bounds Tom Tromey
2021-11-05 19:51 ` Simon Marchi
2021-11-24 15:53 ` Tom Tromey
2021-11-04 18:08 ` [PATCH v2 05/32] Allow ada_decode not to decode operators Tom Tromey
2021-11-04 18:08 ` [PATCH v2 06/32] Let skip_one_die not skip children Tom Tromey
2021-11-04 18:08 ` [PATCH v2 07/32] Add name splitting Tom Tromey
2021-11-04 18:08 ` [PATCH v2 08/32] Add new overload of dwarf5_djb_hash Tom Tromey
2021-11-05 20:01 ` Simon Marchi
2021-11-07 17:02 ` Tom Tromey
2021-11-04 18:08 ` [PATCH v2 09/32] Refactor build_type_psymtabs_reader Tom Tromey
2021-11-04 18:08 ` [PATCH v2 10/32] Add batching parameter to parallel_for_each Tom Tromey
2021-11-04 18:08 ` [PATCH v2 11/32] Return vector of results from parallel_for_each Tom Tromey
2021-11-17 20:37 ` Lancelot SIX
2021-11-18 14:41 ` Tom Tromey
2021-11-04 18:08 ` [PATCH v2 12/32] Specialize std::hash for gdb_exception Tom Tromey
2021-11-04 18:08 ` [PATCH v2 13/32] Introduce DWARF abbrev cache Tom Tromey
2021-11-04 18:08 ` [PATCH v2 14/32] Statically examine abbrev properties Tom Tromey
2021-11-04 18:08 ` [PATCH v2 15/32] Update skip_one_die for new " Tom Tromey
2021-11-04 18:08 ` [PATCH v2 16/32] Introduce the new DWARF index class Tom Tromey
2021-11-04 18:08 ` [PATCH v2 17/32] The new DWARF indexer Tom Tromey
2021-11-04 18:08 ` [PATCH v2 18/32] Implement quick_symbol_functions for cooked DWARF index Tom Tromey
2021-11-04 18:08 ` [PATCH v2 19/32] Wire in the new DWARF indexer Tom Tromey
2021-11-04 18:08 ` Tom Tromey [this message]
2021-11-04 18:08 ` [PATCH v2 21/32] Pre-read DWARF section data Tom Tromey
2021-11-04 18:08 ` [PATCH v2 22/32] Parallelize DWARF indexing Tom Tromey
2021-11-04 18:08 ` [PATCH v2 23/32] "Finalize" the DWARF index in the background Tom Tromey
2021-11-04 18:08 ` [PATCH v2 24/32] Rename write_psymtabs_to_index Tom Tromey
2021-11-04 18:09 ` [PATCH v2 25/32] Change the key type in psym_index_map Tom Tromey
2021-11-04 18:09 ` [PATCH v2 26/32] Change parameters to write_address_map Tom Tromey
2021-11-04 18:09 ` [PATCH v2 27/32] Genericize addrmap handling in the DWARF index writer Tom Tromey
2021-11-04 18:09 ` [PATCH v2 28/32] Adapt .gdb_index writer to new DWARF scanner Tom Tromey
2021-11-04 18:09 ` [PATCH v2 29/32] Adapt .debug_names " Tom Tromey
2021-11-04 18:09 ` [PATCH v2 30/32] Enable the new DWARF indexer Tom Tromey
2021-11-04 18:09 ` [PATCH v2 31/32] Delete DWARF psymtab code Tom Tromey
2021-11-04 18:09 ` [PATCH v2 32/32] Remove dwarf2_per_cu_data::v Tom Tromey
2021-11-06 12:25 ` [PATCH v2 00/32] Rewrite the DWARF "partial" reader Tom de Vries
2021-11-11 12:23 ` Tom de Vries
2021-11-16 23:56 ` Tom Tromey
2021-11-17 9:22 ` Tom de Vries
2021-11-18 14:43 ` Tom Tromey
2021-11-22 19:59 ` Tom Tromey
2021-11-22 20:52 ` Tom de Vries
2021-11-22 22:11 ` Tom Tromey
2021-11-23 7:56 ` Tom de Vries
2021-11-23 17:00 ` Tom Tromey
2021-11-08 17:41 ` Simon Marchi
2021-11-10 19:56 ` Tom Tromey
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211104180907.2360627-21-tom@tromey.com \
--to=tom@tromey.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).