gdb/complaints.c

   1 /* Support for complaint handling during symbol reading in GDB.
   2
   3    Copyright (C) 1990-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "complaints.h"
  22 #include "command.h"
  23 #include "gdbcmd.h"
  24 #include "run-on-main-thread.h"
  25 #include "gdbsupport/selftest.h"
  26 #include <unordered_map>
  27 #include <mutex>
  28
  29 /* Map format strings to counters.  */
  30
  31 static std::unordered_map<const char *, int> counters;
  32
  33 /* How many complaints about a particular thing should be printed
  34    before we stop whining about it?  Default is no whining at all,
  35    since so many systems have ill-constructed symbol files.  */
  36
  37 int stop_whining = 0;
  38
  39 #if CXX_STD_THREAD
  40 static std::mutex complaint_mutex;
  41 #endif /* CXX_STD_THREAD */
  42
  43 /* See complaints.h.  */
  44
  45 void
  46 complaint_internal (const char *fmt, ...)
  47 {
  48   va_list args;
  49
  50   {
  51 #if CXX_STD_THREAD
  52     std::lock_guard<std::mutex> guard (complaint_mutex);
  53 #endif
  54     if (++counters[fmt] > stop_whining)
  55       return;
  56   }
  57
  58   va_start (args, fmt);
  59
  60   if (deprecated_warning_hook)
  61     (*deprecated_warning_hook) (fmt, args);
  62   else
  63     {
  64       gdb_puts (_("During symbol reading: "), gdb_stderr);
  65       gdb_vprintf (gdb_stderr, fmt, args);
  66       gdb_puts ("\n", gdb_stderr);
  67     }
  68
  69   va_end (args);
  70 }
  71
  72 /* See complaints.h.  */
  73
  74 void
  75 clear_complaints ()
  76 {
  77   counters.clear ();
  78 }
  79
  80 /* See complaints.h.  */
  81
  82 thread_local complaint_interceptor *complaint_interceptor::g_complaint_interceptor;
  83
  84 /* See complaints.h.  */
  85
  86 complaint_interceptor::complaint_interceptor ()
  87   : m_saved_warning_hook (&deprecated_warning_hook, issue_complaint),
  88     m_saved_complaint_interceptor (&g_complaint_interceptor, this)
  89 {
  90 }
  91
  92 /* A helper that wraps a warning hook.  */
  93
  94 static void
  95 wrap_warning_hook (void (*hook) (const char *, va_list), ...)
  96 {
  97   va_list args;
  98   va_start (args, hook);
  99   hook ("%s", args);
 100   va_end (args);
 101 }
 102
 103 /* See complaints.h.  */
 104
 105 void
 106 re_emit_complaints (const complaint_collection &complaints)
 107 {
 108   gdb_assert (is_main_thread ());
 109
 110   for (const std::string &str : complaints)
 111     {
 112       if (deprecated_warning_hook)
 113         wrap_warning_hook (deprecated_warning_hook, str.c_str ());
 114       else
 115         gdb_printf (gdb_stderr, _("During symbol reading: %s\n"),
 116                     str.c_str ());
 117     }
 118 }
 119
 120 /* See complaints.h.  */
 121
 122 void
 123 complaint_interceptor::issue_complaint (const char *fmt, va_list args)
 124 {
 125 #if CXX_STD_THREAD
 126   std::lock_guard<std::mutex> guard (complaint_mutex);
 127 #endif
 128   g_complaint_interceptor->m_complaints.insert (string_vprintf (fmt, args));
 129 }
 130
 131 static void
 132 complaints_show_value (struct ui_file *file, int from_tty,
 133                        struct cmd_list_element *cmd, const char *value)
 134 {
 135   gdb_printf (file, _("Max number of complaints about incorrect"
 136                       " symbols is %s.\n"),
 137               value);
 138 }
 139
 140 #if GDB_SELF_TEST
 141 namespace selftests {
 142
 143 /* Entry point for complaints unit tests.  */
 144
 145 static void
 146 test_complaints ()
 147 {
 148   std::unordered_map<const char *, int> tmp;
 149   scoped_restore reset_counters = make_scoped_restore (&counters, tmp);
 150   scoped_restore reset_stop_whining = make_scoped_restore (&stop_whining, 2);
 151
 152 #define CHECK_COMPLAINT(STR, CNT)                                       \
 153   do                                                                    \
 154     {                                                                   \
 155       std::string output;                                               \
 156       execute_fn_to_string (output, []() { complaint (STR); }, false);  \
 157       std::string expected                                              \
 158         = _("During symbol reading: ") + std::string (STR "\n");        \
 159       SELF_CHECK (output == expected);                                  \
 160       SELF_CHECK (counters[STR] == CNT);                                \
 161     } while (0)
 162
 163 #define CHECK_COMPLAINT_SILENT(STR, CNT)                                \
 164   do                                                                    \
 165     {                                                                   \
 166       std::string output;                                               \
 167       execute_fn_to_string (output, []() { complaint (STR); }, false);  \
 168       SELF_CHECK (output.empty ());                                     \
 169       SELF_CHECK (counters[STR] == CNT);                                \
 170     } while (0)
 171
 172   CHECK_COMPLAINT ("maintenance complaint 0", 1);
 173   CHECK_COMPLAINT ("maintenance complaint 0", 2);
 174   CHECK_COMPLAINT_SILENT ("maintenance complaint 0", 3);
 175   CHECK_COMPLAINT ("maintenance complaint 1", 1);
 176   clear_complaints ();
 177   CHECK_COMPLAINT ("maintenance complaint 0", 1);
 178
 179 #undef CHECK_COMPLAINT
 180 #undef CHECK_COMPLAINT_SILENT
 181 }
 182
 183
 184 } // namespace selftests
 185 #endif /* GDB_SELF_TEST */
 186
 187 void _initialize_complaints ();
 188 void
 189 _initialize_complaints ()
 190 {
 191   add_setshow_zinteger_cmd ("complaints", class_support,
 192                             &stop_whining, _("\
 193 Set max number of complaints about incorrect symbols."), _("\
 194 Show max number of complaints about incorrect symbols."), NULL,
 195                             NULL, complaints_show_value,
 196                             &setlist, &showlist);
 197
 198 #if GDB_SELF_TEST
 199   selftests::register_test ("complaints", selftests::test_complaints);
 200 #endif /* GDB_SELF_TEST */
 201 }