debug.c revision 1.17
1 /* $NetBSD: debug.c,v 1.17 2023/05/20 10:46:21 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 (at) 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.17 2023/05/20 10:46:21 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 */ 45 static bool debug_full_parser_state = true; 46 47 const 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 83 const 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 101 static const char *const declaration_name[] = { 102 "no", 103 "begin", 104 "end", 105 }; 106 107 static const char *const in_enum_name[] = { 108 "no", 109 "enum", 110 "type", 111 "brace", 112 }; 113 114 const char *const paren_level_cast_name[] = { 115 "(unknown cast)", 116 "(maybe cast)", 117 "(no cast)", 118 }; 119 120 static const char *const line_kind_name[] = { 121 "other", 122 "#if", 123 "#endif", 124 "}", 125 }; 126 127 void 128 debug_printf(const char *fmt, ...) 129 { 130 FILE *f = output == stdout ? stderr : stdout; 131 va_list ap; 132 133 va_start(ap, fmt); 134 vfprintf(f, fmt, ap); 135 va_end(ap); 136 } 137 138 void 139 debug_println(const char *fmt, ...) 140 { 141 FILE *f = output == stdout ? stderr : stdout; 142 va_list ap; 143 144 va_start(ap, fmt); 145 vfprintf(f, fmt, ap); 146 va_end(ap); 147 fprintf(f, "\n"); 148 } 149 150 void 151 debug_vis_range(const char *prefix, const char *s, size_t len, 152 const char *suffix) 153 { 154 debug_printf("%s", prefix); 155 for (size_t i = 0; i < len; i++) { 156 const char *p = s + i; 157 if (*p == '\\' || *p == '"') 158 debug_printf("\\%c", *p); 159 else if (isprint((unsigned char)*p)) 160 debug_printf("%c", *p); 161 else if (*p == '\n') 162 debug_printf("\\n"); 163 else if (*p == '\t') 164 debug_printf("\\t"); 165 else 166 debug_printf("\\x%02x", (unsigned char)*p); 167 } 168 debug_printf("%s", suffix); 169 } 170 171 static void 172 debug_print_buf(const char *name, const struct buffer *buf) 173 { 174 if (buf->len > 0) { 175 debug_printf("%s ", name); 176 debug_vis_range("\"", buf->st, buf->len, "\"\n"); 177 } 178 } 179 180 void 181 debug_buffers(void) 182 { 183 if (lab.len > 0) { 184 debug_printf(" label "); 185 debug_vis_range("\"", lab.st, lab.len, "\""); 186 } 187 if (code.len > 0) { 188 debug_printf(" code "); 189 debug_vis_range("\"", code.st, code.len, "\""); 190 } 191 if (com.len > 0) { 192 debug_printf(" comment "); 193 debug_vis_range("\"", com.st, com.len, "\""); 194 } 195 } 196 197 #define debug_ps_bool(name) \ 198 if (ps.name != prev_ps.name) \ 199 debug_println("[%c] -> [%c] ps." #name, \ 200 prev_ps.name ? 'x' : ' ', ps.name ? 'x' : ' '); \ 201 else if (debug_full_parser_state) \ 202 debug_println(" [%c] ps." #name, ps.name ? 'x' : ' ') 203 #define debug_ps_int(name) \ 204 if (ps.name != prev_ps.name) \ 205 debug_println("%3d -> %3d ps." #name, prev_ps.name, ps.name); \ 206 else if (debug_full_parser_state) \ 207 debug_println(" %3d ps." #name, ps.name) 208 #define debug_ps_enum(name, names) \ 209 if (ps.name != prev_ps.name) \ 210 debug_println("%3s -> %3s ps." #name, \ 211 (names)[prev_ps.name], (names)[ps.name]); \ 212 else if (debug_full_parser_state) \ 213 debug_println("%10s ps." #name, (names)[ps.name]) 214 215 static bool 216 ps_paren_has_changed(const struct parser_state *prev_ps) 217 { 218 if (prev_ps->nparen != ps.nparen) 219 return true; 220 221 const paren_level_props *prev = prev_ps->paren, *curr = ps.paren; 222 for (int i = 0; i < ps.nparen; i++) 223 if (curr[i].indent != prev[i].indent 224 || curr[i].cast != prev[i].cast) 225 return true; 226 return false; 227 } 228 229 static void 230 debug_ps_paren(const struct parser_state *prev_ps) 231 { 232 if (!debug_full_parser_state && !ps_paren_has_changed(prev_ps)) 233 return; 234 235 debug_printf(" ps.paren:"); 236 for (int i = 0; i < ps.nparen; i++) { 237 debug_printf(" %s%d", 238 paren_level_cast_name[ps.paren[i].cast], 239 ps.paren[i].indent); 240 } 241 if (ps.nparen == 0) 242 debug_printf(" none"); 243 debug_println(""); 244 } 245 246 static bool 247 ps_di_stack_has_changed(const struct parser_state *prev_ps) 248 { 249 if (prev_ps->decl_level != ps.decl_level) 250 return true; 251 for (int i = 0; i < ps.decl_level; i++) 252 if (prev_ps->di_stack[i] != ps.di_stack[i]) 253 return true; 254 return false; 255 } 256 257 static void 258 debug_ps_di_stack(const struct parser_state *prev_ps) 259 { 260 bool changed = ps_di_stack_has_changed(prev_ps); 261 if (!debug_full_parser_state && !changed) 262 return; 263 264 debug_printf(" %s ps.di_stack:", changed ? "->" : " "); 265 for (int i = 0; i < ps.decl_level; i++) 266 debug_printf(" %d", ps.di_stack[i]); 267 if (ps.decl_level == 0) 268 debug_printf(" none"); 269 debug_println(""); 270 } 271 272 void 273 debug_parser_state(lexer_symbol lsym) 274 { 275 static struct parser_state prev_ps; 276 277 debug_println(""); 278 debug_printf("line %d: %s", line_no, lsym_name[lsym]); 279 debug_vis_range(" \"", token.st, token.len, "\"\n"); 280 281 debug_print_buf("label", &lab); 282 debug_print_buf("code", &code); 283 debug_print_buf("comment", &com); 284 285 debug_println(" ps.prev_token = %s", 286 lsym_name[ps.prev_token]); 287 debug_ps_bool(curr_col_1); 288 debug_ps_bool(next_col_1); 289 debug_ps_bool(next_unary); 290 debug_ps_bool(is_function_definition); 291 debug_ps_bool(want_blank); 292 debug_ps_bool(force_nl); 293 debug_ps_int(line_start_nparen); 294 debug_ps_int(nparen); 295 debug_ps_paren(&prev_ps); 296 297 debug_ps_int(comment_delta); 298 debug_ps_int(n_comment_delta); 299 debug_ps_int(com_ind); 300 301 debug_ps_bool(block_init); 302 debug_ps_int(block_init_level); 303 debug_ps_bool(init_or_struct); 304 305 debug_ps_int(ind_level); 306 debug_ps_int(ind_level_follow); 307 308 debug_ps_int(decl_level); 309 debug_ps_di_stack(&prev_ps); 310 debug_ps_bool(decl_on_line); 311 debug_ps_bool(in_decl); 312 debug_ps_enum(declaration, declaration_name); 313 debug_ps_bool(blank_line_after_decl); 314 debug_ps_bool(in_func_def_params); 315 debug_ps_enum(in_enum, in_enum_name); 316 debug_ps_bool(decl_indent_done); 317 debug_ps_int(decl_ind); 318 debug_ps_bool(tabs_to_var); 319 320 debug_ps_bool(in_stmt_or_decl); 321 debug_ps_bool(in_stmt_cont); 322 debug_ps_bool(is_case_label); 323 debug_ps_bool(seen_case); 324 325 // The debug output for the parser symbols is done in 'parse' instead. 326 327 debug_ps_enum(spaced_expr_psym, psym_name); 328 debug_ps_int(quest_level); 329 330 debug_ps_enum(line_kind, line_kind_name); 331 debug_ps_enum(prev_line_kind, line_kind_name); 332 333 prev_ps = ps; 334 } 335 336 void 337 debug_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
Indexes created Tue Sep 30 20:09:53 GMT 2025