1 /****************************************************************************** 2 * 3 * Module Name: nsdump - table dumping routines for debug 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2012, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #include <acpi/acpi.h> 45 #include "accommon.h" 46 #include "acnamesp.h" 47 48 #define _COMPONENT ACPI_NAMESPACE 49 ACPI_MODULE_NAME("nsdump") 50 51 /* Local prototypes */ 52 #ifdef ACPI_OBSOLETE_FUNCTIONS 53 void acpi_ns_dump_root_devices(void); 54 55 static acpi_status 56 acpi_ns_dump_one_device(acpi_handle obj_handle, 57 u32 level, void *context, void **return_value); 58 #endif 59 60 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) 61 /******************************************************************************* 62 * 63 * FUNCTION: acpi_ns_print_pathname 64 * 65 * PARAMETERS: num_segments - Number of ACPI name segments 66 * pathname - The compressed (internal) path 67 * 68 * RETURN: None 69 * 70 * DESCRIPTION: Print an object's full namespace pathname 71 * 72 ******************************************************************************/ 73 74 void acpi_ns_print_pathname(u32 num_segments, char *pathname) 75 { 76 u32 i; 77 78 ACPI_FUNCTION_NAME(ns_print_pathname); 79 80 if (!(acpi_dbg_level & ACPI_LV_NAMES) 81 || !(acpi_dbg_layer & ACPI_NAMESPACE)) { 82 return; 83 } 84 85 /* Print the entire name */ 86 87 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "[")); 88 89 while (num_segments) { 90 for (i = 0; i < 4; i++) { 91 ACPI_IS_PRINT(pathname[i]) ? 92 acpi_os_printf("%c", pathname[i]) : 93 acpi_os_printf("?"); 94 } 95 96 pathname += ACPI_NAME_SIZE; 97 num_segments--; 98 if (num_segments) { 99 acpi_os_printf("."); 100 } 101 } 102 103 acpi_os_printf("]\n"); 104 } 105 106 /******************************************************************************* 107 * 108 * FUNCTION: acpi_ns_dump_pathname 109 * 110 * PARAMETERS: handle - Object 111 * msg - Prefix message 112 * level - Desired debug level 113 * component - Caller's component ID 114 * 115 * RETURN: None 116 * 117 * DESCRIPTION: Print an object's full namespace pathname 118 * Manages allocation/freeing of a pathname buffer 119 * 120 ******************************************************************************/ 121 122 void 123 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component) 124 { 125 126 ACPI_FUNCTION_TRACE(ns_dump_pathname); 127 128 /* Do this only if the requested debug level and component are enabled */ 129 130 if (!(acpi_dbg_level & level) || !(acpi_dbg_layer & component)) { 131 return_VOID; 132 } 133 134 /* Convert handle to a full pathname and print it (with supplied message) */ 135 136 acpi_ns_print_node_pathname(handle, msg); 137 acpi_os_printf("\n"); 138 return_VOID; 139 } 140 141 /******************************************************************************* 142 * 143 * FUNCTION: acpi_ns_dump_one_object 144 * 145 * PARAMETERS: obj_handle - Node to be dumped 146 * level - Nesting level of the handle 147 * context - Passed into walk_namespace 148 * return_value - Not used 149 * 150 * RETURN: Status 151 * 152 * DESCRIPTION: Dump a single Node 153 * This procedure is a user_function called by acpi_ns_walk_namespace. 154 * 155 ******************************************************************************/ 156 157 acpi_status 158 acpi_ns_dump_one_object(acpi_handle obj_handle, 159 u32 level, void *context, void **return_value) 160 { 161 struct acpi_walk_info *info = (struct acpi_walk_info *)context; 162 struct acpi_namespace_node *this_node; 163 union acpi_operand_object *obj_desc = NULL; 164 acpi_object_type obj_type; 165 acpi_object_type type; 166 u32 bytes_to_dump; 167 u32 dbg_level; 168 u32 i; 169 170 ACPI_FUNCTION_NAME(ns_dump_one_object); 171 172 /* Is output enabled? */ 173 174 if (!(acpi_dbg_level & info->debug_level)) { 175 return (AE_OK); 176 } 177 178 if (!obj_handle) { 179 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Null object handle\n")); 180 return (AE_OK); 181 } 182 183 this_node = acpi_ns_validate_handle(obj_handle); 184 if (!this_node) { 185 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Invalid object handle %p\n", 186 obj_handle)); 187 return (AE_OK); 188 } 189 190 type = this_node->type; 191 192 /* Check if the owner matches */ 193 194 if ((info->owner_id != ACPI_OWNER_ID_MAX) && 195 (info->owner_id != this_node->owner_id)) { 196 return (AE_OK); 197 } 198 199 if (!(info->display_type & ACPI_DISPLAY_SHORT)) { 200 201 /* Indent the object according to the level */ 202 203 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " "); 204 205 /* Check the node type and name */ 206 207 if (type > ACPI_TYPE_LOCAL_MAX) { 208 ACPI_WARNING((AE_INFO, 209 "Invalid ACPI Object Type 0x%08X", type)); 210 } 211 212 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node)); 213 } 214 215 /* Now we can print out the pertinent information */ 216 217 acpi_os_printf(" %-12s %p %2.2X ", 218 acpi_ut_get_type_name(type), this_node, 219 this_node->owner_id); 220 221 dbg_level = acpi_dbg_level; 222 acpi_dbg_level = 0; 223 obj_desc = acpi_ns_get_attached_object(this_node); 224 acpi_dbg_level = dbg_level; 225 226 /* Temp nodes are those nodes created by a control method */ 227 228 if (this_node->flags & ANOBJ_TEMPORARY) { 229 acpi_os_printf("(T) "); 230 } 231 232 switch (info->display_type & ACPI_DISPLAY_MASK) { 233 case ACPI_DISPLAY_SUMMARY: 234 235 if (!obj_desc) { 236 237 /* No attached object. Some types should always have an object */ 238 239 switch (type) { 240 case ACPI_TYPE_INTEGER: 241 case ACPI_TYPE_PACKAGE: 242 case ACPI_TYPE_BUFFER: 243 case ACPI_TYPE_STRING: 244 case ACPI_TYPE_METHOD: 245 acpi_os_printf("<No attached object>"); 246 break; 247 248 default: 249 break; 250 } 251 252 acpi_os_printf("\n"); 253 return (AE_OK); 254 } 255 256 switch (type) { 257 case ACPI_TYPE_PROCESSOR: 258 259 acpi_os_printf("ID %02X Len %02X Addr %p\n", 260 obj_desc->processor.proc_id, 261 obj_desc->processor.length, 262 ACPI_CAST_PTR(void, 263 obj_desc->processor. 264 address)); 265 break; 266 267 case ACPI_TYPE_DEVICE: 268 269 acpi_os_printf("Notify Object: %p\n", obj_desc); 270 break; 271 272 case ACPI_TYPE_METHOD: 273 274 acpi_os_printf("Args %X Len %.4X Aml %p\n", 275 (u32) obj_desc->method.param_count, 276 obj_desc->method.aml_length, 277 obj_desc->method.aml_start); 278 break; 279 280 case ACPI_TYPE_INTEGER: 281 282 acpi_os_printf("= %8.8X%8.8X\n", 283 ACPI_FORMAT_UINT64(obj_desc->integer. 284 value)); 285 break; 286 287 case ACPI_TYPE_PACKAGE: 288 289 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) { 290 acpi_os_printf("Elements %.2X\n", 291 obj_desc->package.count); 292 } else { 293 acpi_os_printf("[Length not yet evaluated]\n"); 294 } 295 break; 296 297 case ACPI_TYPE_BUFFER: 298 299 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) { 300 acpi_os_printf("Len %.2X", 301 obj_desc->buffer.length); 302 303 /* Dump some of the buffer */ 304 305 if (obj_desc->buffer.length > 0) { 306 acpi_os_printf(" ="); 307 for (i = 0; 308 (i < obj_desc->buffer.length 309 && i < 12); i++) { 310 acpi_os_printf(" %.2hX", 311 obj_desc->buffer. 312 pointer[i]); 313 } 314 } 315 acpi_os_printf("\n"); 316 } else { 317 acpi_os_printf("[Length not yet evaluated]\n"); 318 } 319 break; 320 321 case ACPI_TYPE_STRING: 322 323 acpi_os_printf("Len %.2X ", obj_desc->string.length); 324 acpi_ut_print_string(obj_desc->string.pointer, 32); 325 acpi_os_printf("\n"); 326 break; 327 328 case ACPI_TYPE_REGION: 329 330 acpi_os_printf("[%s]", 331 acpi_ut_get_region_name(obj_desc->region. 332 space_id)); 333 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) { 334 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n", 335 ACPI_FORMAT_NATIVE_UINT 336 (obj_desc->region.address), 337 obj_desc->region.length); 338 } else { 339 acpi_os_printf 340 (" [Address/Length not yet evaluated]\n"); 341 } 342 break; 343 344 case ACPI_TYPE_LOCAL_REFERENCE: 345 346 acpi_os_printf("[%s]\n", 347 acpi_ut_get_reference_name(obj_desc)); 348 break; 349 350 case ACPI_TYPE_BUFFER_FIELD: 351 352 if (obj_desc->buffer_field.buffer_obj && 353 obj_desc->buffer_field.buffer_obj->buffer.node) { 354 acpi_os_printf("Buf [%4.4s]", 355 acpi_ut_get_node_name(obj_desc-> 356 buffer_field. 357 buffer_obj-> 358 buffer. 359 node)); 360 } 361 break; 362 363 case ACPI_TYPE_LOCAL_REGION_FIELD: 364 365 acpi_os_printf("Rgn [%4.4s]", 366 acpi_ut_get_node_name(obj_desc-> 367 common_field. 368 region_obj->region. 369 node)); 370 break; 371 372 case ACPI_TYPE_LOCAL_BANK_FIELD: 373 374 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]", 375 acpi_ut_get_node_name(obj_desc-> 376 common_field. 377 region_obj->region. 378 node), 379 acpi_ut_get_node_name(obj_desc-> 380 bank_field. 381 bank_obj-> 382 common_field. 383 node)); 384 break; 385 386 case ACPI_TYPE_LOCAL_INDEX_FIELD: 387 388 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]", 389 acpi_ut_get_node_name(obj_desc-> 390 index_field. 391 index_obj-> 392 common_field.node), 393 acpi_ut_get_node_name(obj_desc-> 394 index_field. 395 data_obj-> 396 common_field. 397 node)); 398 break; 399 400 case ACPI_TYPE_LOCAL_ALIAS: 401 case ACPI_TYPE_LOCAL_METHOD_ALIAS: 402 403 acpi_os_printf("Target %4.4s (%p)\n", 404 acpi_ut_get_node_name(obj_desc), 405 obj_desc); 406 break; 407 408 default: 409 410 acpi_os_printf("Object %p\n", obj_desc); 411 break; 412 } 413 414 /* Common field handling */ 415 416 switch (type) { 417 case ACPI_TYPE_BUFFER_FIELD: 418 case ACPI_TYPE_LOCAL_REGION_FIELD: 419 case ACPI_TYPE_LOCAL_BANK_FIELD: 420 case ACPI_TYPE_LOCAL_INDEX_FIELD: 421 422 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n", 423 (obj_desc->common_field. 424 base_byte_offset * 8) 425 + 426 obj_desc->common_field. 427 start_field_bit_offset, 428 obj_desc->common_field.bit_length, 429 obj_desc->common_field. 430 access_byte_width); 431 break; 432 433 default: 434 break; 435 } 436 break; 437 438 case ACPI_DISPLAY_OBJECTS: 439 440 acpi_os_printf("O:%p", obj_desc); 441 if (!obj_desc) { 442 443 /* No attached object, we are done */ 444 445 acpi_os_printf("\n"); 446 return (AE_OK); 447 } 448 449 acpi_os_printf("(R%u)", obj_desc->common.reference_count); 450 451 switch (type) { 452 case ACPI_TYPE_METHOD: 453 454 /* Name is a Method and its AML offset/length are set */ 455 456 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start, 457 obj_desc->method.aml_length); 458 break; 459 460 case ACPI_TYPE_INTEGER: 461 462 acpi_os_printf(" I:%8.8X8.8%X\n", 463 ACPI_FORMAT_UINT64(obj_desc->integer. 464 value)); 465 break; 466 467 case ACPI_TYPE_STRING: 468 469 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer, 470 obj_desc->string.length); 471 break; 472 473 case ACPI_TYPE_BUFFER: 474 475 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer, 476 obj_desc->buffer.length); 477 break; 478 479 default: 480 481 acpi_os_printf("\n"); 482 break; 483 } 484 break; 485 486 default: 487 acpi_os_printf("\n"); 488 break; 489 } 490 491 /* If debug turned off, done */ 492 493 if (!(acpi_dbg_level & ACPI_LV_VALUES)) { 494 return (AE_OK); 495 } 496 497 /* If there is an attached object, display it */ 498 499 dbg_level = acpi_dbg_level; 500 acpi_dbg_level = 0; 501 obj_desc = acpi_ns_get_attached_object(this_node); 502 acpi_dbg_level = dbg_level; 503 504 /* Dump attached objects */ 505 506 while (obj_desc) { 507 obj_type = ACPI_TYPE_INVALID; 508 acpi_os_printf("Attached Object %p: ", obj_desc); 509 510 /* Decode the type of attached object and dump the contents */ 511 512 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) { 513 case ACPI_DESC_TYPE_NAMED: 514 515 acpi_os_printf("(Ptr to Node)\n"); 516 bytes_to_dump = sizeof(struct acpi_namespace_node); 517 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump); 518 break; 519 520 case ACPI_DESC_TYPE_OPERAND: 521 522 obj_type = obj_desc->common.type; 523 524 if (obj_type > ACPI_TYPE_LOCAL_MAX) { 525 acpi_os_printf 526 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n", 527 obj_type); 528 bytes_to_dump = 32; 529 } else { 530 acpi_os_printf 531 ("(Pointer to ACPI Object type %.2X [%s])\n", 532 obj_type, acpi_ut_get_type_name(obj_type)); 533 bytes_to_dump = 534 sizeof(union acpi_operand_object); 535 } 536 537 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump); 538 break; 539 540 default: 541 542 break; 543 } 544 545 /* If value is NOT an internal object, we are done */ 546 547 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != 548 ACPI_DESC_TYPE_OPERAND) { 549 goto cleanup; 550 } 551 552 /* Valid object, get the pointer to next level, if any */ 553 554 switch (obj_type) { 555 case ACPI_TYPE_BUFFER: 556 case ACPI_TYPE_STRING: 557 /* 558 * NOTE: takes advantage of common fields between string/buffer 559 */ 560 bytes_to_dump = obj_desc->string.length; 561 obj_desc = (void *)obj_desc->string.pointer; 562 acpi_os_printf("(Buffer/String pointer %p length %X)\n", 563 obj_desc, bytes_to_dump); 564 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump); 565 goto cleanup; 566 567 case ACPI_TYPE_BUFFER_FIELD: 568 obj_desc = 569 (union acpi_operand_object *)obj_desc->buffer_field. 570 buffer_obj; 571 break; 572 573 case ACPI_TYPE_PACKAGE: 574 obj_desc = (void *)obj_desc->package.elements; 575 break; 576 577 case ACPI_TYPE_METHOD: 578 obj_desc = (void *)obj_desc->method.aml_start; 579 break; 580 581 case ACPI_TYPE_LOCAL_REGION_FIELD: 582 obj_desc = (void *)obj_desc->field.region_obj; 583 break; 584 585 case ACPI_TYPE_LOCAL_BANK_FIELD: 586 obj_desc = (void *)obj_desc->bank_field.region_obj; 587 break; 588 589 case ACPI_TYPE_LOCAL_INDEX_FIELD: 590 obj_desc = (void *)obj_desc->index_field.index_obj; 591 break; 592 593 default: 594 goto cleanup; 595 } 596 597 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */ 598 } 599 600 cleanup: 601 acpi_os_printf("\n"); 602 return (AE_OK); 603 } 604 605 #ifdef ACPI_FUTURE_USAGE 606 /******************************************************************************* 607 * 608 * FUNCTION: acpi_ns_dump_objects 609 * 610 * PARAMETERS: type - Object type to be dumped 611 * display_type - 0 or ACPI_DISPLAY_SUMMARY 612 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX 613 * for an effectively unlimited depth. 614 * owner_id - Dump only objects owned by this ID. Use 615 * ACPI_UINT32_MAX to match all owners. 616 * start_handle - Where in namespace to start/end search 617 * 618 * RETURN: None 619 * 620 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses 621 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object. 622 * 623 ******************************************************************************/ 624 625 void 626 acpi_ns_dump_objects(acpi_object_type type, 627 u8 display_type, 628 u32 max_depth, 629 acpi_owner_id owner_id, acpi_handle start_handle) 630 { 631 struct acpi_walk_info info; 632 acpi_status status; 633 634 ACPI_FUNCTION_ENTRY(); 635 636 /* 637 * Just lock the entire namespace for the duration of the dump. 638 * We don't want any changes to the namespace during this time, 639 * especially the temporary nodes since we are going to display 640 * them also. 641 */ 642 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); 643 if (ACPI_FAILURE(status)) { 644 acpi_os_printf("Could not acquire namespace mutex\n"); 645 return; 646 } 647 648 info.debug_level = ACPI_LV_TABLES; 649 info.owner_id = owner_id; 650 info.display_type = display_type; 651 652 (void)acpi_ns_walk_namespace(type, start_handle, max_depth, 653 ACPI_NS_WALK_NO_UNLOCK | 654 ACPI_NS_WALK_TEMP_NODES, 655 acpi_ns_dump_one_object, NULL, 656 (void *)&info, NULL); 657 658 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); 659 } 660 #endif /* ACPI_FUTURE_USAGE */ 661 662 /******************************************************************************* 663 * 664 * FUNCTION: acpi_ns_dump_entry 665 * 666 * PARAMETERS: handle - Node to be dumped 667 * debug_level - Output level 668 * 669 * RETURN: None 670 * 671 * DESCRIPTION: Dump a single Node 672 * 673 ******************************************************************************/ 674 675 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level) 676 { 677 struct acpi_walk_info info; 678 679 ACPI_FUNCTION_ENTRY(); 680 681 info.debug_level = debug_level; 682 info.owner_id = ACPI_OWNER_ID_MAX; 683 info.display_type = ACPI_DISPLAY_SUMMARY; 684 685 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL); 686 } 687 688 #ifdef ACPI_ASL_COMPILER 689 /******************************************************************************* 690 * 691 * FUNCTION: acpi_ns_dump_tables 692 * 693 * PARAMETERS: search_base - Root of subtree to be dumped, or 694 * NS_ALL to dump the entire namespace 695 * max_depth - Maximum depth of dump. Use INT_MAX 696 * for an effectively unlimited depth. 697 * 698 * RETURN: None 699 * 700 * DESCRIPTION: Dump the name space, or a portion of it. 701 * 702 ******************************************************************************/ 703 704 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth) 705 { 706 acpi_handle search_handle = search_base; 707 708 ACPI_FUNCTION_TRACE(ns_dump_tables); 709 710 if (!acpi_gbl_root_node) { 711 /* 712 * If the name space has not been initialized, 713 * there is nothing to dump. 714 */ 715 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, 716 "namespace not initialized!\n")); 717 return_VOID; 718 } 719 720 if (ACPI_NS_ALL == search_base) { 721 722 /* Entire namespace */ 723 724 search_handle = acpi_gbl_root_node; 725 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n")); 726 } 727 728 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth, 729 ACPI_OWNER_ID_MAX, search_handle); 730 return_VOID; 731 } 732 #endif /* _ACPI_ASL_COMPILER */ 733 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */ 734