gdb/complaints.c

   1 /* Support for complaint handling during symbol reading in GDB.
   2
   3    Copyright (C) 1990-2022 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 "gdbsupport/selftest.h"
  25 #include <unordered_map>
  26
  27 /* Map format strings to counters.  */
  28
  29 static std::unordered_map<const char *, int> counters;
  30
  31 /* How many complaints about a particular thing should be printed
  32    before we stop whining about it?  Default is no whining at all,
  33    since so many systems have ill-constructed symbol files.  */
  34
  35 int stop_whining = 0;
  36
  37 /* See complaints.h.  */
  38
  39 void
  40 complaint_internal (const char *fmt, ...)
  41 {
  42   va_list args;
  43
  44   if (++counters[fmt] > stop_whining)
  45     return;
  46
  47   va_start (args, fmt);
  48
  49   if (deprecated_warning_hook)
  50     (*deprecated_warning_hook) (fmt, args);
  51   else
  52     {
  53       fputs_filtered (_("During symbol reading: "), gdb_stderr);
  54       vfprintf_filtered (gdb_stderr, fmt, args);
  55       fputs_filtered ("\n", gdb_stderr);
  56     }
  57
  58   va_end (args);
  59 }
  60
  61 /* See complaints.h.  */
  62
  63 void
  64 clear_complaints ()
  65 {
  66   counters.clear ();
  67 }
  68
  69 static void
  70 complaints_show_value (struct ui_file *file, int from_tty,
  71                        struct cmd_list_element *cmd, const char *value)
  72 {
  73   fprintf_filtered (file, _("Max number of complaints about incorrect"
  74                             " symbols is %s.\n"),
  75                     value);
  76 }
  77
  78 #if GDB_SELF_TEST
  79 namespace selftests {
  80
  81 /* Entry point for complaints unit tests.  */
  82
  83 static void
  84 test_complaints ()
  85 {
  86   std::unordered_map<const char *, int> tmp;
  87   scoped_restore reset_counters = make_scoped_restore (&counters, tmp);
  88   scoped_restore reset_stop_whining = make_scoped_restore (&stop_whining, 2);
  89
  90 #define CHECK_COMPLAINT(STR, CNT)                                       \
  91   do                                                                    \
  92     {                                                                   \
  93       std::string output;                                               \
  94       execute_fn_to_string (output, []() { complaint (STR); }, false);  \
  95       std::string expected                                              \
  96         = _("During symbol reading: ") + std::string (STR "\n");        \
  97       SELF_CHECK (output == expected);                                  \
  98       SELF_CHECK (counters[STR] == CNT);                                \
  99     } while (0)
 100
 101 #define CHECK_COMPLAINT_SILENT(STR, CNT)                                \
 102   do                                                                    \
 103     {                                                                   \
 104       std::string output;                                               \
 105       execute_fn_to_string (output, []() { complaint (STR); }, false);  \
 106       SELF_CHECK (output.empty ());                                     \
 107       SELF_CHECK (counters[STR] == CNT);                                \
 108     } while (0)
 109
 110   CHECK_COMPLAINT ("maintenance complaint 0", 1);
 111   CHECK_COMPLAINT ("maintenance complaint 0", 2);
 112   CHECK_COMPLAINT_SILENT ("maintenance complaint 0", 3);
 113   CHECK_COMPLAINT ("maintenance complaint 1", 1);
 114   clear_complaints ();
 115   CHECK_COMPLAINT ("maintenance complaint 0", 1);
 116
 117 #undef CHECK_COMPLAINT
 118 #undef CHECK_COMPLAINT_SILENT
 119 }
 120
 121
 122 } // namespace selftests
 123 #endif /* GDB_SELF_TEST */
 124
 125 void _initialize_complaints ();
 126 void
 127 _initialize_complaints ()
 128 {
 129   add_setshow_zinteger_cmd ("complaints", class_support,
 130                             &stop_whining, _("\
 131 Set max number of complaints about incorrect symbols."), _("\
 132 Show max number of complaints about incorrect symbols."), NULL,
 133                             NULL, complaints_show_value,
 134                             &setlist, &showlist);
 135
 136 #if GDB_SELF_TEST
 137   selftests::register_test ("complaints", selftests::test_complaints);
 138 #endif /* GDB_SELF_TEST */
 139 }