debug.c revision 1.72
1 /* $NetBSD: debug.c,v 1.72 2024/03/09 13:20:55 rillig Exp $ */ 2 3 /*- 4 * Copyright (c) 2021 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 #if HAVE_NBTOOL_CONFIG_H 33 #include "nbtool_config.h" 34 #endif 35 36 #include <sys/cdefs.h> 37 #if defined(__RCSID) 38 __RCSID("$NetBSD: debug.c,v 1.72 2024/03/09 13:20:55 rillig Exp $"); 39 #endif 40 41 #include <stdlib.h> 42 #include <string.h> 43 44 #include "lint1.h" 45 #include "cgram.h" 46 47 48 #ifdef DEBUG 49 50 static int debug_indentation = 0; 51 static bool did_indentation; 52 53 54 static FILE * 55 debug_file(void) 56 { 57 /* 58 * Using stdout preserves the order between the debug messages and 59 * lint's diagnostics. 60 */ 61 return yflag ? stderr : stdout; 62 } 63 64 static void 65 debug_vprintf(const char *fmt, va_list va) 66 { 67 68 if (!did_indentation) { 69 did_indentation = true; 70 fprintf(debug_file(), "%s%*s", 71 yflag ? "| " : "", 2 * debug_indentation, ""); 72 } 73 74 (void)vfprintf(debug_file(), fmt, va); 75 76 did_indentation = strchr(fmt, '\n') == NULL; 77 } 78 79 void 80 debug_printf(const char *fmt, ...) 81 { 82 va_list va; 83 84 va_start(va, fmt); 85 debug_vprintf(fmt, va); 86 va_end(va); 87 } 88 89 void 90 debug_skip_indent(void) 91 { 92 93 did_indentation = true; 94 } 95 96 void 97 debug_indent_inc(void) 98 { 99 100 debug_indentation++; 101 } 102 103 void 104 debug_indent_dec(void) 105 { 106 107 lint_assert(debug_indentation > 0); 108 debug_indentation--; 109 } 110 111 bool 112 debug_push_indented(bool indented) 113 { 114 bool prev = did_indentation; 115 did_indentation = indented; 116 return prev; 117 } 118 119 void 120 debug_pop_indented(bool indented) 121 { 122 did_indentation = indented; 123 } 124 125 void 126 debug_step(const char *fmt, ...) 127 { 128 va_list va; 129 130 va_start(va, fmt); 131 debug_vprintf(fmt, va); 132 va_end(va); 133 debug_printf("\n"); 134 } 135 136 void 137 debug_enter_func(const char *func) 138 { 139 140 debug_step("+ %s", func); 141 debug_indent_inc(); 142 } 143 144 void 145 debug_leave_func(const char *func) 146 { 147 148 debug_indent_dec(); 149 debug_step("- %s", func); 150 } 151 152 static void 153 debug_type_details(const type_t *tp) 154 { 155 156 if (is_struct_or_union(tp->t_tspec)) { 157 debug_indent_inc(); 158 debug_step("size %u bits, align %u bits, %s", 159 tp->u.sou->sou_size_in_bits, tp->u.sou->sou_align_in_bits, 160 tp->u.sou->sou_incomplete ? "incomplete" : "complete"); 161 162 for (const sym_t *mem = tp->u.sou->sou_first_member; 163 mem != NULL; mem = mem->s_next) { 164 debug_sym("", mem, "\n"); 165 debug_type_details(mem->s_type); 166 } 167 debug_indent_dec(); 168 } 169 if (tp->t_is_enum) { 170 debug_indent_inc(); 171 for (const sym_t *en = tp->u.enumer->en_first_enumerator; 172 en != NULL; en = en->s_next) { 173 debug_sym("", en, "\n"); 174 } 175 debug_indent_dec(); 176 } 177 } 178 179 void 180 debug_type(const type_t *tp) 181 { 182 183 debug_step("type details for '%s':", type_name(tp)); 184 debug_type_details(tp); 185 } 186 187 void 188 debug_node(const tnode_t *tn) // NOLINT(misc-no-recursion) 189 { 190 191 if (tn == NULL) { 192 debug_step("null"); 193 return; 194 } 195 196 op_t op = tn->tn_op; 197 debug_printf("'%s'", 198 op == CVT && tn->tn_cast ? "cast" : op_name(op)); 199 if (op == NAME) 200 debug_printf(" '%s' with %s", 201 tn->tn_sym->s_name, 202 scl_name(tn->tn_sym->s_scl)); 203 else 204 debug_printf(" type"); 205 debug_printf(" '%s'", type_name(tn->tn_type)); 206 if (tn->tn_lvalue) 207 debug_printf(", lvalue"); 208 if (tn->tn_parenthesized) 209 debug_printf(", parenthesized"); 210 if (tn->tn_sys) 211 debug_printf(", sys"); 212 213 switch (op) { 214 case NAME: 215 debug_printf("\n"); 216 break; 217 case CON: 218 if (is_floating(tn->tn_type->t_tspec)) 219 debug_printf(", value %Lg", tn->tn_val.u.floating); 220 else if (is_uinteger(tn->tn_type->t_tspec)) 221 debug_printf(", value %llu", 222 (unsigned long long)tn->tn_val.u.integer); 223 else if (is_integer(tn->tn_type->t_tspec)) 224 debug_printf(", value %lld", 225 (long long)tn->tn_val.u.integer); 226 else { 227 lint_assert(tn->tn_type->t_tspec == BOOL); 228 debug_printf(", value %s", 229 tn->tn_val.u.integer != 0 ? "true" : "false"); 230 } 231 if (tn->tn_val.v_unsigned_since_c90) 232 debug_printf(", unsigned_since_c90"); 233 if (tn->tn_val.v_char_constant) 234 debug_printf(", char_constant"); 235 debug_printf("\n"); 236 break; 237 case STRING: 238 if (tn->tn_string->data != NULL) 239 debug_printf(", %s\n", tn->tn_string->data); 240 else 241 debug_printf(", length %zu\n", tn->tn_string->len); 242 break; 243 case CALL: 244 case ICALL: 245 debug_printf("\n"); 246 247 debug_indent_inc(); 248 const function_call *call = tn->tn_call; 249 debug_node(call->func); 250 if (call->args != NULL) { 251 for (size_t i = 0; i < call->args_len; i++) 252 debug_node(call->args[i]); 253 } else 254 debug_step("error in arguments"); 255 debug_indent_dec(); 256 break; 257 default: 258 debug_printf("\n"); 259 260 debug_indent_inc(); 261 lint_assert(has_operands(tn)); 262 lint_assert(tn->tn_left != NULL); 263 debug_node(tn->tn_left); 264 if (op != INCBEF && op != INCAFT 265 && op != DECBEF && op != DECAFT 266 && op != CALL && op != ICALL) 267 lint_assert(is_binary(tn) == (tn->tn_right != NULL)); 268 if (tn->tn_right != NULL) 269 debug_node(tn->tn_right); 270 debug_indent_dec(); 271 } 272 } 273 274 static const char * 275 def_name(def_t def) 276 { 277 static const char *const name[] = { 278 "not-declared", 279 "declared", 280 "tentative-defined", 281 "defined", 282 }; 283 284 return name[def]; 285 } 286 287 const char * 288 decl_level_kind_name(decl_level_kind kind) 289 { 290 static const char *const name[] = { 291 "extern", 292 "struct", 293 "union", 294 "enum", 295 "old-style-function-parameters", 296 "prototype-parameters", 297 "auto", 298 "abstract", 299 }; 300 301 return name[kind]; 302 } 303 304 const char * 305 scl_name(scl_t scl) 306 { 307 static const char *const name[] = { 308 "none", 309 "extern", 310 "static", 311 "auto", 312 "register", 313 "typedef", 314 "thread_local", 315 "struct", 316 "union", 317 "enum", 318 "member-of-struct", 319 "member-of-union", 320 "abstract", 321 "old-style-function-parameter", 322 "prototype-parameter", 323 }; 324 325 return name[scl]; 326 } 327 328 const char * 329 symbol_kind_name(symbol_kind kind) 330 { 331 static const char *const name[] = { 332 "var-func-type", 333 "member", 334 "tag", 335 "label", 336 }; 337 338 return name[kind]; 339 } 340 341 const char * 342 type_qualifiers_string(type_qualifiers tq) 343 { 344 static char buf[32]; 345 346 snprintf(buf, sizeof(buf), "%s%s%s%s", 347 tq.tq_const ? " const" : "", 348 tq.tq_restrict ? " restrict" : "", 349 tq.tq_volatile ? " volatile" : "", 350 tq.tq_atomic ? " atomic" : ""); 351 return buf[0] != '\0' ? buf + 1 : "none"; 352 } 353 354 const char * 355 function_specifier_name(function_specifier spec) 356 { 357 static const char *const name[] = { 358 "inline", 359 "_Noreturn", 360 }; 361 362 return name[spec]; 363 } 364 365 static void 366 debug_word(bool flag, const char *name) 367 { 368 369 if (flag) 370 debug_printf(" %s", name); 371 } 372 373 void 374 debug_sym(const char *prefix, const sym_t *sym, const char *suffix) 375 { 376 377 debug_printf("%s%s", prefix, sym->s_name); 378 if (sym->s_type != NULL) 379 debug_printf(" type='%s'", type_name(sym->s_type)); 380 if (sym->s_rename != NULL) 381 debug_printf(" rename=%s", sym->s_rename); 382 debug_printf(" %s", symbol_kind_name(sym->s_kind)); 383 debug_word(sym->s_keyword != NULL, "keyword"); 384 debug_word(sym->s_bitfield, "bit-field"); 385 debug_word(sym->s_set, "set"); 386 debug_word(sym->s_used, "used"); 387 debug_word(sym->s_param, "parameter"); 388 debug_word(sym->s_register, "register"); 389 debug_word(sym->s_defparam, "old-style-undefined"); 390 debug_word(sym->s_return_type_implicit_int, "return-int"); 391 debug_word(sym->s_osdef, "old-style"); 392 debug_word(sym->s_inline, "inline"); 393 debug_word(sym->s_ext_sym != NULL, "has-external"); 394 debug_word(sym->s_scl != NO_SCL, scl_name(sym->s_scl)); 395 debug_word(sym->s_keyword == NULL, def_name(sym->s_def)); 396 397 if (sym->s_def_pos.p_file != NULL) 398 debug_printf(" defined-at=%s:%d", 399 sym->s_def_pos.p_file, sym->s_def_pos.p_line); 400 if (sym->s_set_pos.p_file != NULL) 401 debug_printf(" set-at=%s:%d", 402 sym->s_set_pos.p_file, sym->s_set_pos.p_line); 403 if (sym->s_use_pos.p_file != NULL) 404 debug_printf(" used-at=%s:%d", 405 sym->s_use_pos.p_file, sym->s_use_pos.p_line); 406 407 if (sym->s_type != NULL && sym->s_type->t_is_enum) 408 debug_printf(" value=%d", sym->u.s_enum_constant); 409 if (sym->s_type != NULL && sym->s_type->t_tspec == BOOL) 410 debug_printf(" value=%s", 411 sym->u.s_bool_constant ? "true" : "false"); 412 413 if (is_member(sym)) { 414 struct_or_union *sou = sym->u.s_member.sm_containing_type; 415 const char *tag = sou->sou_tag->s_name; 416 const sym_t *def = sou->sou_first_typedef; 417 if (tag == unnamed && def != NULL) 418 debug_printf(" sou='typedef %s'", def->s_name); 419 else 420 debug_printf(" sou='%s'", tag); 421 } 422 423 if (sym->s_keyword != NULL) { 424 int t = sym->u.s_keyword.sk_token; 425 if (t == T_TYPE || t == T_STRUCT_OR_UNION) 426 debug_printf(" %s", 427 tspec_name(sym->u.s_keyword.u.sk_tspec)); 428 if (t == T_QUAL) 429 debug_printf(" %s", type_qualifiers_string( 430 sym->u.s_keyword.u.sk_type_qualifier)); 431 if (t == T_FUNCTION_SPECIFIER) 432 debug_printf(" %s", function_specifier_name( 433 sym->u.s_keyword.u.function_specifier)); 434 } 435 436 debug_word(sym->s_osdef && sym->u.s_old_style_params != NULL, 437 "old-style-params"); 438 439 if (strcmp(suffix, "\n") == 0) 440 debug_printf("\n"); 441 else 442 debug_printf("%s", suffix); 443 } 444 445 static void 446 debug_decl_level(const decl_level *dl) 447 { 448 449 debug_printf("kind=%s", decl_level_kind_name(dl->d_kind)); 450 if (dl->d_scl != NO_SCL) 451 debug_printf(" %s", scl_name(dl->d_scl)); 452 if (dl->d_type != NULL) 453 debug_printf(" '%s'", type_name(dl->d_type)); 454 else { 455 if (dl->d_abstract_type != NO_TSPEC) 456 debug_printf(" %s", tspec_name(dl->d_abstract_type)); 457 if (dl->d_complex_mod != NO_TSPEC) 458 debug_printf(" %s", tspec_name(dl->d_complex_mod)); 459 if (dl->d_sign_mod != NO_TSPEC) 460 debug_printf(" %s", tspec_name(dl->d_sign_mod)); 461 if (dl->d_rank_mod != NO_TSPEC) 462 debug_printf(" %s", tspec_name(dl->d_rank_mod)); 463 } 464 if (dl->d_redeclared_symbol != NULL) 465 debug_sym(" redeclared=(", dl->d_redeclared_symbol, ")"); 466 if (dl->d_sou_size_in_bits != 0) 467 debug_printf(" size=%u", dl->d_sou_size_in_bits); 468 if (dl->d_sou_align_in_bits != 0) 469 debug_printf(" align=%u", dl->d_sou_align_in_bits); 470 471 debug_word(dl->d_qual.tq_const, "const"); 472 debug_word(dl->d_qual.tq_restrict, "restrict"); 473 debug_word(dl->d_qual.tq_volatile, "volatile"); 474 debug_word(dl->d_qual.tq_atomic, "atomic"); 475 debug_word(dl->d_inline, "inline"); 476 debug_word(dl->d_multiple_storage_classes, "multiple_storage_classes"); 477 debug_word(dl->d_invalid_type_combination, "invalid_type_combination"); 478 debug_word(dl->d_nonempty_decl, "nonempty_decl"); 479 debug_word(dl->d_no_type_specifier, "no_type_specifier"); 480 debug_word(dl->d_asm, "asm"); 481 debug_word(dl->d_packed, "packed"); 482 debug_word(dl->d_used, "used"); 483 484 if (dl->d_tag_type != NULL) 485 debug_printf(" tag_type='%s'", type_name(dl->d_tag_type)); 486 for (const sym_t *p = dl->d_func_params; p != NULL; p = p->s_next) 487 debug_sym(" param(", p, ")"); 488 if (dl->d_func_def_pos.p_file != NULL) 489 debug_printf(" func_def_pos=%s:%d:%d", 490 dl->d_func_def_pos.p_file, dl->d_func_def_pos.p_line, 491 dl->d_func_def_pos.p_uniq); 492 for (const sym_t *sym = dl->d_func_proto_syms; 493 sym != NULL; sym = sym->s_next) 494 debug_sym(" func_proto_sym(", sym, ")"); 495 debug_printf("\n"); 496 } 497 498 void 499 debug_dcs(void) 500 { 501 debug_printf("dcs "); 502 debug_decl_level(dcs); 503 } 504 505 void 506 debug_dcs_all(void) 507 { 508 size_t i = 0; 509 for (const decl_level *dl = dcs; dl != NULL; dl = dl->d_enclosing) { 510 debug_printf("dcs[%zu] ", i++); 511 debug_decl_level(dl); 512 } 513 } 514 #endif 515
Indexes created Tue Sep 23 07:09:52 GMT 2025