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