debug.c revision 1.76
1 /* $NetBSD: debug.c,v 1.76 2024/05/01 07:40:11 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.76 2024/05/01 07:40:11 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->u.sym->s_name, 202 scl_name(tn->u.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->u.value.u.floating); 220 else if (is_uinteger(tn->tn_type->t_tspec)) 221 debug_printf(", value %llu", 222 (unsigned long long)tn->u.value.u.integer); 223 else if (is_integer(tn->tn_type->t_tspec)) 224 debug_printf(", value %lld", 225 (long long)tn->u.value.u.integer); 226 else { 227 lint_assert(tn->tn_type->t_tspec == BOOL); 228 debug_printf(", value %s", 229 tn->u.value.u.integer != 0 ? "true" : "false"); 230 } 231 if (tn->u.value.v_unsigned_since_c90) 232 debug_printf(", unsigned_since_c90"); 233 if (tn->u.value.v_char_constant) 234 debug_printf(", char_constant"); 235 debug_printf("\n"); 236 break; 237 case STRING: 238 if (tn->u.str_literals->data != NULL) 239 debug_printf(", %s\n", tn->u.str_literals->data); 240 else 241 debug_printf(", length %zu\n", tn->u.str_literals->len); 242 break; 243 case CALL: 244 debug_printf("\n"); 245 246 debug_indent_inc(); 247 const function_call *call = tn->u.call; 248 debug_node(call->func); 249 for (size_t i = 0, n = call->args_len; i < n; i++) 250 debug_node(call->args[i]); 251 debug_indent_dec(); 252 break; 253 default: 254 debug_printf("\n"); 255 256 debug_indent_inc(); 257 lint_assert(has_operands(tn)); 258 lint_assert(tn->u.ops.left != NULL); 259 debug_node(tn->u.ops.left); 260 if (op != INCBEF && op != INCAFT 261 && op != DECBEF && op != DECAFT) 262 lint_assert(is_binary(tn) == (tn->u.ops.right != NULL)); 263 if (tn->u.ops.right != NULL) 264 debug_node(tn->u.ops.right); 265 debug_indent_dec(); 266 } 267 } 268 269 static const char * 270 def_name(def_t def) 271 { 272 static const char *const name[] = { 273 "not-declared", 274 "declared", 275 "tentative-defined", 276 "defined", 277 }; 278 279 return name[def]; 280 } 281 282 const char * 283 decl_level_kind_name(decl_level_kind kind) 284 { 285 static const char *const name[] = { 286 "extern", 287 "struct", 288 "union", 289 "enum", 290 "old-style-function-parameters", 291 "prototype-parameters", 292 "auto", 293 "abstract", 294 }; 295 296 return name[kind]; 297 } 298 299 const char * 300 scl_name(scl_t scl) 301 { 302 static const char *const name[] = { 303 "none", 304 "extern", 305 "static", 306 "auto", 307 "register", 308 "typedef", 309 "thread_local", 310 "struct", 311 "union", 312 "enum", 313 "member-of-struct", 314 "member-of-union", 315 "abstract", 316 "old-style-function-parameter", 317 "prototype-parameter", 318 }; 319 320 return name[scl]; 321 } 322 323 const char * 324 symbol_kind_name(symbol_kind kind) 325 { 326 static const char *const name[] = { 327 "var-func-type", 328 "member", 329 "tag", 330 "label", 331 }; 332 333 return name[kind]; 334 } 335 336 const char * 337 type_qualifiers_string(type_qualifiers tq) 338 { 339 static char buf[32]; 340 341 snprintf(buf, sizeof(buf), "%s%s%s%s", 342 tq.tq_const ? " const" : "", 343 tq.tq_restrict ? " restrict" : "", 344 tq.tq_volatile ? " volatile" : "", 345 tq.tq_atomic ? " atomic" : ""); 346 return buf[0] != '\0' ? buf + 1 : "none"; 347 } 348 349 const char * 350 function_specifier_name(function_specifier spec) 351 { 352 static const char *const name[] = { 353 "inline", 354 "_Noreturn", 355 }; 356 357 return name[spec]; 358 } 359 360 static void 361 debug_word(bool flag, const char *name) 362 { 363 364 if (flag) 365 debug_printf(" %s", name); 366 } 367 368 void 369 debug_sym(const char *prefix, const sym_t *sym, const char *suffix) 370 { 371 372 debug_printf("%s%s", prefix, sym->s_name); 373 if (sym->s_type != NULL) 374 debug_printf(" type='%s'", type_name(sym->s_type)); 375 if (sym->s_rename != NULL) 376 debug_printf(" rename=%s", sym->s_rename); 377 debug_printf(" %s", symbol_kind_name(sym->s_kind)); 378 debug_word(sym->s_keyword != NULL, "keyword"); 379 debug_word(sym->s_bitfield, "bit-field"); 380 debug_word(sym->s_set, "set"); 381 debug_word(sym->s_used, "used"); 382 debug_word(sym->s_param, "parameter"); 383 debug_word(sym->s_register, "register"); 384 debug_word(sym->s_defparam, "old-style-undefined"); 385 debug_word(sym->s_return_type_implicit_int, "return-int"); 386 debug_word(sym->s_osdef, "old-style"); 387 debug_word(sym->s_inline, "inline"); 388 debug_word(sym->s_ext_sym != NULL, "has-external"); 389 debug_word(sym->s_scl != NO_SCL, scl_name(sym->s_scl)); 390 debug_word(sym->s_keyword == NULL, def_name(sym->s_def)); 391 392 if (sym->s_def_pos.p_file != NULL) 393 debug_printf(" defined-at=%s:%d", 394 sym->s_def_pos.p_file, sym->s_def_pos.p_line); 395 if (sym->s_set_pos.p_file != NULL) 396 debug_printf(" set-at=%s:%d", 397 sym->s_set_pos.p_file, sym->s_set_pos.p_line); 398 if (sym->s_use_pos.p_file != NULL) 399 debug_printf(" used-at=%s:%d", 400 sym->s_use_pos.p_file, sym->s_use_pos.p_line); 401 402 if (sym->s_type != NULL && sym->s_type->t_is_enum) 403 debug_printf(" value=%d", sym->u.s_enum_constant); 404 if (sym->s_type != NULL && sym->s_type->t_tspec == BOOL) 405 debug_printf(" value=%s", 406 sym->u.s_bool_constant ? "true" : "false"); 407 408 if (is_member(sym)) { 409 struct_or_union *sou = sym->u.s_member.sm_containing_type; 410 const char *tag = sou->sou_tag->s_name; 411 const sym_t *def = sou->sou_first_typedef; 412 if (tag == unnamed && def != NULL) 413 debug_printf(" sou='typedef %s'", def->s_name); 414 else 415 debug_printf(" sou='%s'", tag); 416 } 417 418 if (sym->s_keyword != NULL) { 419 int t = sym->u.s_keyword.sk_token; 420 if (t == T_TYPE || t == T_STRUCT_OR_UNION) 421 debug_printf(" %s", 422 tspec_name(sym->u.s_keyword.u.sk_tspec)); 423 if (t == T_QUAL) 424 debug_printf(" %s", type_qualifiers_string( 425 sym->u.s_keyword.u.sk_type_qualifier)); 426 if (t == T_FUNCTION_SPECIFIER) 427 debug_printf(" %s", function_specifier_name( 428 sym->u.s_keyword.u.function_specifier)); 429 } 430 431 debug_word(sym->s_osdef && sym->u.s_old_style_params != NULL, 432 "old-style-params"); 433 434 if (strcmp(suffix, "\n") == 0) 435 debug_printf("\n"); 436 else 437 debug_printf("%s", suffix); 438 } 439 440 static void 441 debug_decl_level(const decl_level *dl) 442 { 443 444 debug_printf("kind=%s", decl_level_kind_name(dl->d_kind)); 445 if (dl->d_scl != NO_SCL) 446 debug_printf(" %s", scl_name(dl->d_scl)); 447 if (dl->d_type != NULL) 448 debug_printf(" '%s'", type_name(dl->d_type)); 449 else { 450 if (dl->d_abstract_type != NO_TSPEC) 451 debug_printf(" %s", tspec_name(dl->d_abstract_type)); 452 if (dl->d_complex_mod != NO_TSPEC) 453 debug_printf(" %s", tspec_name(dl->d_complex_mod)); 454 if (dl->d_sign_mod != NO_TSPEC) 455 debug_printf(" %s", tspec_name(dl->d_sign_mod)); 456 if (dl->d_rank_mod != NO_TSPEC) 457 debug_printf(" %s", tspec_name(dl->d_rank_mod)); 458 } 459 if (dl->d_redeclared_symbol != NULL) 460 debug_sym(" redeclared=(", dl->d_redeclared_symbol, ")"); 461 if (dl->d_sou_size_in_bits != 0) 462 debug_printf(" size=%u", dl->d_sou_size_in_bits); 463 if (dl->d_sou_align_in_bits != 0) 464 debug_printf(" sou_align=%u", dl->d_sou_align_in_bits); 465 if (dl->d_mem_align_in_bits != 0) 466 debug_printf(" mem_align=%u", dl->d_mem_align_in_bits); 467 468 debug_word(dl->d_qual.tq_const, "const"); 469 debug_word(dl->d_qual.tq_restrict, "restrict"); 470 debug_word(dl->d_qual.tq_volatile, "volatile"); 471 debug_word(dl->d_qual.tq_atomic, "atomic"); 472 debug_word(dl->d_inline, "inline"); 473 debug_word(dl->d_multiple_storage_classes, "multiple_storage_classes"); 474 debug_word(dl->d_invalid_type_combination, "invalid_type_combination"); 475 debug_word(dl->d_nonempty_decl, "nonempty_decl"); 476 debug_word(dl->d_no_type_specifier, "no_type_specifier"); 477 debug_word(dl->d_asm, "asm"); 478 debug_word(dl->d_packed, "packed"); 479 debug_word(dl->d_used, "used"); 480 481 if (dl->d_tag_type != NULL) 482 debug_printf(" tag_type='%s'", type_name(dl->d_tag_type)); 483 for (const sym_t *p = dl->d_func_params; p != NULL; p = p->s_next) 484 debug_sym(" param(", p, ")"); 485 if (dl->d_func_def_pos.p_file != NULL) 486 debug_printf(" func_def_pos=%s:%d:%d", 487 dl->d_func_def_pos.p_file, dl->d_func_def_pos.p_line, 488 dl->d_func_def_pos.p_uniq); 489 for (const sym_t *sym = dl->d_func_proto_syms; 490 sym != NULL; sym = sym->s_next) 491 debug_sym(" func_proto_sym(", sym, ")"); 492 debug_printf("\n"); 493 } 494 495 void 496 debug_dcs(void) 497 { 498 debug_printf("dcs "); 499 debug_decl_level(dcs); 500 } 501 502 void 503 debug_dcs_all(void) 504 { 505 size_t i = 0; 506 for (const decl_level *dl = dcs; dl != NULL; dl = dl->d_enclosing) { 507 debug_printf("dcs[%zu] ", i++); 508 debug_decl_level(dl); 509 } 510 } 511 #endif 512
Indexes created Wed Oct 01 15:09:59 GMT 2025