gcc/dbgcnt.c

   1 /* Debug counter for debugging support
   2    Copyright (C) 2006-2019 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.
  19
  20 See dbgcnt.def for usage information.  */
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "coretypes.h"
  25 #include "diagnostic-core.h"
  26 #include "dumpfile.h"
  27 #include "selftest.h"
  28
  29 #include "dbgcnt.h"
  30
  31 struct string2counter_map {
  32   const char *name;
  33   enum debug_counter counter;
  34 };
  35
  36 #define DEBUG_COUNTER(a) { #a , a },
  37
  38 static struct string2counter_map map[debug_counter_number_of_counters] =
  39 {
  40 #include "dbgcnt.def"
  41 };
  42 #undef DEBUG_COUNTER
  43
  44 typedef std::pair<unsigned int, unsigned int> limit_tuple;
  45
  46 static vec<limit_tuple> limits[debug_counter_number_of_counters];
  47
  48 static unsigned int count[debug_counter_number_of_counters];
  49
  50 static void
  51 print_limit_reach (const char *counter, int limit, bool upper_p)
  52 {
  53   char buffer[128];
  54   sprintf (buffer, "***dbgcnt: %s limit %d reached for %s.***\n",
  55            upper_p ? "upper" : "lower", limit, counter);
  56   fputs (buffer, stderr);
  57   if (dump_file)
  58     fputs (buffer, dump_file);
  59 }
  60
  61 bool
  62 dbg_cnt (enum debug_counter index)
  63 {
  64   unsigned v = ++count[index];
  65
  66   if (!limits[index].exists ())
  67     return true;
  68   else if (limits[index].is_empty ())
  69     return false;
  70
  71   unsigned last = limits[index].length () - 1;
  72   unsigned int min = limits[index][last].first;
  73   unsigned int max = limits[index][last].second;
  74
  75   if (v < min)
  76     return false;
  77   else if (v == min)
  78     {
  79       print_limit_reach (map[index].name, v, false);
  80       if (min == max)
  81         limits[index].pop ();
  82       return true;
  83     }
  84   else if (v < max)
  85     return true;
  86   else if (v == max)
  87     {
  88       print_limit_reach (map[index].name, v, true);
  89       limits[index].pop ();
  90       return true;
  91     }
  92   else
  93     return false;
  94 }
  95
  96 /* Compare limit_tuple intervals by first item in descending order.  */
  97
  98 static int
  99 cmp_tuples (const void *ptr1, const void *ptr2)
 100 {
 101   const limit_tuple *p1 = (const limit_tuple *)ptr1;
 102   const limit_tuple *p2 = (const limit_tuple *)ptr2;
 103
 104   if (p1->first < p2->first)
 105     return 1;
 106   else if (p1->first > p2->first)
 107     return -1;
 108   return 0;
 109 }
 110
 111 static bool
 112 dbg_cnt_set_limit_by_index (enum debug_counter index, const char *name,
 113                             unsigned int low, unsigned int high)
 114 {
 115   if (!limits[index].exists ())
 116     limits[index].create (1);
 117
 118   limits[index].safe_push (limit_tuple (low, high));
 119   limits[index].qsort (cmp_tuples);
 120
 121   for (unsigned i = 0; i < limits[index].length () - 1; i++)
 122     {
 123       limit_tuple t1 = limits[index][i];
 124       limit_tuple t2 = limits[index][i + 1];
 125       if (t1.first <= t2.second)
 126         {
 127           error ("Interval overlap of %<-fdbg-cnt=%s%>: [%u, %u] and "
 128                  "[%u, %u]\n", name, t2.first, t2.second, t1.first, t1.second);
 129           return false;
 130         }
 131     }
 132
 133   return true;
 134 }
 135
 136 static bool
 137 dbg_cnt_set_limit_by_name (const char *name, unsigned int low,
 138                            unsigned int high)
 139 {
 140   if (high < low)
 141     {
 142       error ("%<-fdbg-cnt=%s:%d-%d%> has smaller upper limit than the lower",
 143              name, low, high);
 144       return false;
 145     }
 146
 147   int i;
 148   for (i = debug_counter_number_of_counters - 1; i >= 0; i--)
 149     if (strcmp (map[i].name, name) == 0)
 150       break;
 151
 152   if (i < 0)
 153     return false;
 154
 155   return dbg_cnt_set_limit_by_index ((enum debug_counter) i, name, low, high);
 156 }
 157
 158 /* Process a single "low:high" pair.
 159    Returns NULL if there's no valid pair is found.
 160    Otherwise returns a pointer to the end of the pair. */
 161
 162 static bool
 163 dbg_cnt_process_single_pair (char *name, char *str)
 164 {
 165   char *value1 = strtok (str, "-");
 166   char *value2 = strtok (NULL, "-");
 167
 168   unsigned int high, low;
 169
 170   if (value1 == NULL)
 171     return false;
 172
 173   if (value2 == NULL)
 174     {
 175       low = 1;
 176       high = strtol (value1, NULL, 10);
 177     }
 178   else
 179     {
 180       low = strtol (value1, NULL, 10);
 181       high = strtol (value2, NULL, 10);
 182     }
 183
 184   return dbg_cnt_set_limit_by_name (name, low, high);
 185 }
 186
 187 void
 188 dbg_cnt_process_opt (const char *arg)
 189 {
 190   char *str = xstrdup (arg);
 191   unsigned int start = 0;
 192
 193   auto_vec<char *> tokens;
 194   for (char *next = strtok (str, ","); next != NULL; next = strtok (NULL, ","))
 195     tokens.safe_push (next);
 196
 197   unsigned i;
 198   for (i = 0; i < tokens.length (); i++)
 199     {
 200       auto_vec<char *> ranges;
 201       char *name = strtok (tokens[i], ":");
 202       for (char *part = strtok (NULL, ":"); part; part = strtok (NULL, ":"))
 203         ranges.safe_push (part);
 204
 205       for (unsigned j = 0; j < ranges.length (); j++)
 206         {
 207           if (!dbg_cnt_process_single_pair (name, ranges[j]))
 208             break;
 209         }
 210       start += strlen (tokens[i]) + 1;
 211     }
 212
 213    if (i != tokens.length ())
 214      {
 215        char *buffer = XALLOCAVEC (char, start + 2);
 216        sprintf (buffer, "%*c", start + 1, '^');
 217        error ("cannot find a valid counter:value pair:");
 218        error ("%<-fdbg-cnt=%s%>", arg);
 219        error ("           %s", buffer);
 220      }
 221 }
 222
 223 /* Print name, limit and count of all counters.   */
 224
 225 void
 226 dbg_cnt_list_all_counters (void)
 227 {
 228   int i;
 229   printf ("  %-30s %s\n", "counter name", "closed intervals");
 230   printf ("-----------------------------------------------------------------\n");
 231   for (i = 0; i < debug_counter_number_of_counters; i++)
 232     {
 233       printf ("  %-30s ", map[i].name);
 234       if (limits[i].exists ())
 235         {
 236           for (int j = limits[i].length () - 1; j >= 0; j--)
 237             {
 238               printf ("[%u, %u]", limits[i][j].first, limits[i][j].second);
 239               if (j > 0)
 240                 printf (", ");
 241             }
 242           putchar ('\n');
 243         }
 244       else
 245         printf ("unset\n");
 246     }
 247   printf ("\n");
 248 }
 249
 250 #if CHECKING_P
 251
 252 namespace selftest {
 253
 254 /* Selftests.  */
 255
 256 static void
 257 test_sorted_dbg_counters ()
 258 {
 259   for (unsigned i = 0; i < debug_counter_number_of_counters - 1; i++)
 260     ASSERT_LT (strcmp (map[i].name, map[i + 1].name), 0);
 261 }
 262
 263 void
 264 dbgcnt_c_tests ()
 265 {
 266   test_sorted_dbg_counters ();
 267 }
 268
 269 } // namespace selftest
 270
 271 #endif /* #if CHECKING_P */