1 /* Debug counter for debugging support
2 Copyright (C) 2006-2021 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 #include "intl.h"
29
30 #include "dbgcnt.h"
31
32 struct string2counter_map {
33 const char *name;
34 enum debug_counter counter;
35 };
36
37 #define DEBUG_COUNTER(a) { #a , a },
38
39 static struct string2counter_map map[debug_counter_number_of_counters] =
40 {
41 #include "dbgcnt.def"
42 };
43 #undef DEBUG_COUNTER
44
45 typedef std::pair<unsigned int, unsigned int> limit_tuple;
46
47 static vec<limit_tuple> limits[debug_counter_number_of_counters];
48 static vec<limit_tuple> original_limits[debug_counter_number_of_counters];
49
50 static unsigned int count[debug_counter_number_of_counters];
51
52 static void
print_limit_reach(const char * counter,int limit,bool upper_p)53 print_limit_reach (const char *counter, int limit, bool upper_p)
54 {
55 char buffer[128];
56 sprintf (buffer, "***dbgcnt: %s limit %d reached for %s.***\n",
57 upper_p ? "upper" : "lower", limit, counter);
58 fputs (buffer, stderr);
59 if (dump_file)
60 fputs (buffer, dump_file);
61 }
62
63 bool
dbg_cnt(enum debug_counter index)64 dbg_cnt (enum debug_counter index)
65 {
66 unsigned v = ++count[index];
67
68 if (!limits[index].exists ())
69 return true;
70 else if (limits[index].is_empty ())
71 return false;
72
73 unsigned last = limits[index].length () - 1;
74 unsigned int min = limits[index][last].first;
75 unsigned int max = limits[index][last].second;
76
77 if (v < min)
78 return false;
79 else if (v == min)
80 {
81 print_limit_reach (map[index].name, v, false);
82 if (min == max)
83 {
84 print_limit_reach (map[index].name, v, true);
85 limits[index].pop ();
86 }
87 return true;
88 }
89 else if (v < max)
90 return true;
91 else if (v == max)
92 {
93 print_limit_reach (map[index].name, v, true);
94 limits[index].pop ();
95 return true;
96 }
97 else
98 return false;
99 }
100
101 /* Compare limit_tuple intervals by first item in descending order. */
102
103 static int
cmp_tuples(const void * ptr1,const void * ptr2)104 cmp_tuples (const void *ptr1, const void *ptr2)
105 {
106 const limit_tuple *p1 = (const limit_tuple *)ptr1;
107 const limit_tuple *p2 = (const limit_tuple *)ptr2;
108
109 if (p1->first < p2->first)
110 return 1;
111 else if (p1->first > p2->first)
112 return -1;
113 return 0;
114 }
115
116 static bool
dbg_cnt_set_limit_by_index(enum debug_counter index,const char * name,unsigned int low,unsigned int high)117 dbg_cnt_set_limit_by_index (enum debug_counter index, const char *name,
118 unsigned int low, unsigned int high)
119 {
120 if (!limits[index].exists ())
121 limits[index].create (1);
122
123 limits[index].safe_push (limit_tuple (low, high));
124 limits[index].qsort (cmp_tuples);
125
126 for (unsigned i = 0; i < limits[index].length () - 1; i++)
127 {
128 limit_tuple t1 = limits[index][i];
129 limit_tuple t2 = limits[index][i + 1];
130 if (t1.first <= t2.second)
131 {
132 error ("Interval overlap of %<-fdbg-cnt=%s%>: [%u, %u] and "
133 "[%u, %u]", name, t2.first, t2.second, t1.first, t1.second);
134 return false;
135 }
136 }
137
138 original_limits[index] = limits[index].copy ();
139
140 return true;
141 }
142
143 static bool
dbg_cnt_set_limit_by_name(const char * name,unsigned int low,unsigned int high)144 dbg_cnt_set_limit_by_name (const char *name, unsigned int low,
145 unsigned int high)
146 {
147 if (high < low)
148 {
149 error ("%<-fdbg-cnt=%s:%d-%d%> has smaller upper limit than the lower",
150 name, low, high);
151 return false;
152 }
153
154 int i;
155 for (i = debug_counter_number_of_counters - 1; i >= 0; i--)
156 if (strcmp (map[i].name, name) == 0)
157 break;
158
159 if (i < 0)
160 {
161 error ("cannot find a valid counter name %qs of %<-fdbg-cnt=%> option",
162 name);
163 return false;
164 }
165
166 return dbg_cnt_set_limit_by_index ((enum debug_counter) i, name, low, high);
167 }
168
169 /* Process a single "low:high" pair.
170 Returns NULL if there's no valid pair is found.
171 Otherwise returns a pointer to the end of the pair. */
172
173 static bool
dbg_cnt_process_single_pair(char * name,char * str)174 dbg_cnt_process_single_pair (char *name, char *str)
175 {
176 char *value1 = strtok (str, "-");
177 char *value2 = strtok (NULL, "-");
178
179 unsigned int high, low;
180
181 if (value1 == NULL)
182 return false;
183
184 if (value2 == NULL)
185 {
186 high = strtol (value1, NULL, 10);
187 /* Let's allow 0:0. */
188 low = high == 0 ? 0 : 1;
189 }
190 else
191 {
192 low = strtol (value1, NULL, 10);
193 high = strtol (value2, NULL, 10);
194 }
195
196 return dbg_cnt_set_limit_by_name (name, low, high);
197 }
198
199 void
dbg_cnt_process_opt(const char * arg)200 dbg_cnt_process_opt (const char *arg)
201 {
202 char *str = xstrdup (arg);
203 unsigned int start = 0;
204
205 auto_vec<char *> tokens;
206 for (char *next = strtok (str, ","); next != NULL; next = strtok (NULL, ","))
207 tokens.safe_push (next);
208
209 unsigned i;
210 for (i = 0; i < tokens.length (); i++)
211 {
212 auto_vec<char *> ranges;
213 char *name = strtok (tokens[i], ":");
214 for (char *part = strtok (NULL, ":"); part; part = strtok (NULL, ":"))
215 ranges.safe_push (part);
216
217 for (unsigned j = 0; j < ranges.length (); j++)
218 {
219 if (!dbg_cnt_process_single_pair (name, ranges[j]))
220 break;
221 }
222 start += strlen (tokens[i]) + 1;
223 }
224 }
225
226 /* Print name, limit and count of all counters. */
227
228 void
dbg_cnt_list_all_counters(void)229 dbg_cnt_list_all_counters (void)
230 {
231 int i;
232 fprintf (stderr, " %-30s%-15s %s\n", G_("counter name"),
233 G_("counter value"), G_("closed intervals"));
234 fprintf (stderr, "-----------------------------------------------------------------\n");
235 for (i = 0; i < debug_counter_number_of_counters; i++)
236 {
237 fprintf (stderr, " %-30s%-15d ", map[i].name, count[i]);
238 if (original_limits[i].exists ())
239 {
240 for (int j = original_limits[i].length () - 1; j >= 0; j--)
241 {
242 fprintf (stderr, "[%u, %u]", original_limits[i][j].first,
243 original_limits[i][j].second);
244 if (j > 0)
245 fprintf (stderr, ", ");
246 }
247 fprintf (stderr, "\n");
248 }
249 else
250 fprintf (stderr, "unset\n");
251 }
252 fprintf (stderr, "\n");
253 }
254
255 #if CHECKING_P
256
257 namespace selftest {
258
259 /* Selftests. */
260
261 static void
test_sorted_dbg_counters()262 test_sorted_dbg_counters ()
263 {
264 for (unsigned i = 0; i < debug_counter_number_of_counters - 1; i++)
265 ASSERT_LT (strcmp (map[i].name, map[i + 1].name), 0);
266 }
267
268 void
dbgcnt_c_tests()269 dbgcnt_c_tests ()
270 {
271 test_sorted_dbg_counters ();
272 }
273
274 } // namespace selftest
275
276 #endif /* #if CHECKING_P */
277