debug.c revision 1.20 
1/*	$NetBSD: debug.c,v 1.20 2023/05/22 10:28:59 rillig Exp $	*/
2
3/*-
4 * Copyright (c) 2023 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Roland Illig <rillig@NetBSD.org>.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#include <sys/cdefs.h>
33__RCSID("$NetBSD: debug.c,v 1.20 2023/05/22 10:28:59 rillig Exp $");
34
35#include <stdarg.h>
36
37#include "indent.h"
38
39#ifdef debug
40
41/*-
42 * false	show only the changes to the parser state
43 * true		show unchanged parts of the parser state as well
44 */
45static bool debug_full_parser_state = true;
46
47const char *const lsym_name[] = {
48	"eof",
49	"preprocessing",
50	"newline",
51	"comment",
52	"lparen_or_lbracket",
53	"rparen_or_rbracket",
54	"lbrace",
55	"rbrace",
56	"period",
57	"unary_op",
58	"binary_op",
59	"postfix_op",
60	"question",
61	"colon",
62	"comma",
63	"semicolon",
64	"typedef",
65	"storage_class",
66	"type_outside_parentheses",
67	"type_in_parentheses",
68	"tag",
69	"case_label",
70	"sizeof",
71	"offsetof",
72	"word",
73	"funcname",
74	"do",
75	"else",
76	"for",
77	"if",
78	"switch",
79	"while",
80	"return",
81};
82
83const char *const psym_name[] = {
84	"0",
85	"lbrace",
86	"rbrace",
87	"decl",
88	"stmt",
89	"stmt_list",
90	"for_exprs",
91	"if_expr",
92	"if_expr_stmt",
93	"if_expr_stmt_else",
94	"else",
95	"switch_expr",
96	"do",
97	"do_stmt",
98	"while_expr",
99};
100
101static const char *const declaration_name[] = {
102	"no",
103	"begin",
104	"end",
105};
106
107static const char *const in_enum_name[] = {
108	"no",
109	"enum",
110	"type",
111	"brace",
112};
113
114const char *const paren_level_cast_name[] = {
115	"(unknown cast)",
116	"(maybe cast)",
117	"(no cast)",
118};
119
120const char *const line_kind_name[] = {
121	"other",
122	"blank",
123	"#if",
124	"#endif",
125	"stmt head",
126	"}",
127	"block comment",
128};
129
130void
131debug_printf(const char *fmt, ...)
132{
133	FILE *f = output == stdout ? stderr : stdout;
134	va_list ap;
135
136	va_start(ap, fmt);
137	vfprintf(f, fmt, ap);
138	va_end(ap);
139}
140
141void
142debug_println(const char *fmt, ...)
143{
144	FILE *f = output == stdout ? stderr : stdout;
145	va_list ap;
146
147	va_start(ap, fmt);
148	vfprintf(f, fmt, ap);
149	va_end(ap);
150	fprintf(f, "\n");
151}
152
153void
154debug_vis_range(const char *prefix, const char *s, size_t len,
155    const char *suffix)
156{
157	debug_printf("%s", prefix);
158	for (size_t i = 0; i < len; i++) {
159		const char *p = s + i;
160		if (*p == '\\' || *p == '"')
161			debug_printf("\\%c", *p);
162		else if (isprint((unsigned char)*p))
163			debug_printf("%c", *p);
164		else if (*p == '\n')
165			debug_printf("\\n");
166		else if (*p == '\t')
167			debug_printf("\\t");
168		else
169			debug_printf("\\x%02x", (unsigned char)*p);
170	}
171	debug_printf("%s", suffix);
172}
173
174static void
175debug_print_buf(const char *name, const struct buffer *buf)
176{
177	if (buf->len > 0) {
178		debug_printf("%s ", name);
179		debug_vis_range("\"", buf->st, buf->len, "\"\n");
180	}
181}
182
183void
184debug_buffers(void)
185{
186	if (lab.len > 0) {
187		debug_printf(" label ");
188		debug_vis_range("\"", lab.st, lab.len, "\"");
189	}
190	if (code.len > 0) {
191		debug_printf(" code ");
192		debug_vis_range("\"", code.st, code.len, "\"");
193	}
194	if (com.len > 0) {
195		debug_printf(" comment ");
196		debug_vis_range("\"", com.st, com.len, "\"");
197	}
198}
199
200#define debug_ps_bool(name) \
201	if (ps.name != prev_ps.name) \
202	    debug_println("[%c] -> [%c] ps." #name, \
203		prev_ps.name ? 'x' : ' ', ps.name ? 'x' : ' '); \
204	else if (debug_full_parser_state) \
205	    debug_println("       [%c] ps." #name, ps.name ? 'x' : ' ')
206#define debug_ps_int(name) \
207	if (ps.name != prev_ps.name) \
208	    debug_println("%3d -> %3d ps." #name, prev_ps.name, ps.name); \
209	else if (debug_full_parser_state) \
210	    debug_println("       %3d ps." #name, ps.name)
211#define debug_ps_enum(name, names) \
212	if (ps.name != prev_ps.name) \
213	    debug_println("%3s -> %3s ps." #name, \
214		(names)[prev_ps.name], (names)[ps.name]); \
215	else if (debug_full_parser_state) \
216	    debug_println("%10s ps." #name, (names)[ps.name])
217
218static bool
219ps_paren_has_changed(const struct parser_state *prev_ps)
220{
221	if (prev_ps->nparen != ps.nparen)
222		return true;
223
224	const paren_level_props *prev = prev_ps->paren, *curr = ps.paren;
225	for (int i = 0; i < ps.nparen; i++)
226		if (curr[i].indent != prev[i].indent
227		    || curr[i].cast != prev[i].cast)
228			return true;
229	return false;
230}
231
232static void
233debug_ps_paren(const struct parser_state *prev_ps)
234{
235	if (!debug_full_parser_state && !ps_paren_has_changed(prev_ps))
236		return;
237
238	debug_printf("           ps.paren:");
239	for (int i = 0; i < ps.nparen; i++) {
240		debug_printf(" %s%d",
241		    paren_level_cast_name[ps.paren[i].cast],
242		    ps.paren[i].indent);
243	}
244	if (ps.nparen == 0)
245		debug_printf(" none");
246	debug_println("");
247}
248
249static bool
250ps_di_stack_has_changed(const struct parser_state *prev_ps)
251{
252	if (prev_ps->decl_level != ps.decl_level)
253		return true;
254	for (int i = 0; i < ps.decl_level; i++)
255		if (prev_ps->di_stack[i] != ps.di_stack[i])
256			return true;
257	return false;
258}
259
260static void
261debug_ps_di_stack(const struct parser_state *prev_ps)
262{
263	bool changed = ps_di_stack_has_changed(prev_ps);
264	if (!debug_full_parser_state && !changed)
265		return;
266
267	debug_printf("    %s     ps.di_stack:", changed ? "->" : "  ");
268	for (int i = 0; i < ps.decl_level; i++)
269		debug_printf(" %d", ps.di_stack[i]);
270	if (ps.decl_level == 0)
271		debug_printf(" none");
272	debug_println("");
273}
274
275void
276debug_parser_state(lexer_symbol lsym)
277{
278	static struct parser_state prev_ps;
279
280	debug_println("");
281	debug_printf("line %d: %s", line_no, lsym_name[lsym]);
282	debug_vis_range(" \"", token.st, token.len, "\"\n");
283
284	debug_print_buf("label", &lab);
285	debug_print_buf("code", &code);
286	debug_print_buf("comment", &com);
287
288	debug_println("           ps.prev_token = %s",
289	    lsym_name[ps.prev_token]);
290	debug_ps_bool(curr_col_1);
291	debug_ps_bool(next_col_1);
292	debug_ps_bool(next_unary);
293	debug_ps_bool(is_function_definition);
294	debug_ps_bool(want_blank);
295	debug_ps_bool(force_nl);
296	debug_ps_int(line_start_nparen);
297	debug_ps_int(nparen);
298	debug_ps_paren(&prev_ps);
299
300	debug_ps_int(comment_delta);
301	debug_ps_int(n_comment_delta);
302	debug_ps_int(com_ind);
303
304	debug_ps_bool(block_init);
305	debug_ps_int(block_init_level);
306	debug_ps_bool(init_or_struct);
307
308	debug_ps_int(ind_level);
309	debug_ps_int(ind_level_follow);
310
311	debug_ps_int(decl_level);
312	debug_ps_di_stack(&prev_ps);
313	debug_ps_bool(decl_on_line);
314	debug_ps_bool(in_decl);
315	debug_ps_enum(declaration, declaration_name);
316	debug_ps_bool(blank_line_after_decl);
317	debug_ps_bool(in_func_def_params);
318	debug_ps_enum(in_enum, in_enum_name);
319	debug_ps_bool(decl_indent_done);
320	debug_ps_int(decl_ind);
321	debug_ps_bool(tabs_to_var);
322
323	debug_ps_bool(in_stmt_or_decl);
324	debug_ps_bool(in_stmt_cont);
325	debug_ps_bool(is_case_label);
326	debug_ps_bool(seen_case);
327
328	// The debug output for the parser symbols is done in 'parse' instead.
329
330	debug_ps_enum(spaced_expr_psym, psym_name);
331	debug_ps_int(quest_level);
332
333	prev_ps = ps;
334}
335
336void
337debug_parse_stack(const char *situation)
338{
339	printf("parse stack %s:", situation);
340	for (int i = 1; i <= ps.tos; ++i)
341		printf(" %s %d", psym_name[ps.s_sym[i]], ps.s_ind_level[i]);
342	if (ps.tos == 0)
343		printf(" empty");
344	printf("\n");
345}
346#endif
347