1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
47 #include <acpi/acoutput.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsdump")
52 /* Local prototypes */
53 #ifdef ACPI_OBSOLETE_FUNCTIONS
54 void acpi_ns_dump_root_devices(void);
57 acpi_ns_dump_one_device(acpi_handle obj_handle,
58 u32 level, void *context, void **return_value);
61 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
64 acpi_ns_dump_one_object_path(acpi_handle obj_handle,
65 u32 level, void *context, void **return_value);
68 acpi_ns_get_max_depth(acpi_handle obj_handle,
69 u32 level, void *context, void **return_value);
71 /*******************************************************************************
73 * FUNCTION: acpi_ns_print_pathname
75 * PARAMETERS: num_segments - Number of ACPI name segments
76 * pathname - The compressed (internal) path
80 * DESCRIPTION: Print an object's full namespace pathname
82 ******************************************************************************/
84 void acpi_ns_print_pathname(u32 num_segments, char *pathname)
88 ACPI_FUNCTION_NAME(ns_print_pathname);
90 /* Check if debug output enabled */
92 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_NAMES, ACPI_NAMESPACE)) {
96 /* Print the entire name */
98 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "["));
100 while (num_segments) {
101 for (i = 0; i < 4; i++) {
102 isprint((int)pathname[i]) ?
103 acpi_os_printf("%c", pathname[i]) :
107 pathname += ACPI_NAME_SIZE;
114 acpi_os_printf("]\n");
117 /*******************************************************************************
119 * FUNCTION: acpi_ns_dump_pathname
121 * PARAMETERS: handle - Object
122 * msg - Prefix message
123 * level - Desired debug level
124 * component - Caller's component ID
128 * DESCRIPTION: Print an object's full namespace pathname
129 * Manages allocation/freeing of a pathname buffer
131 ******************************************************************************/
134 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component)
137 ACPI_FUNCTION_TRACE(ns_dump_pathname);
139 /* Do this only if the requested debug level and component are enabled */
141 if (!ACPI_IS_DEBUG_ENABLED(level, component)) {
145 /* Convert handle to a full pathname and print it (with supplied message) */
147 acpi_ns_print_node_pathname(handle, msg);
148 acpi_os_printf("\n");
152 /*******************************************************************************
154 * FUNCTION: acpi_ns_dump_one_object
156 * PARAMETERS: obj_handle - Node to be dumped
157 * level - Nesting level of the handle
158 * context - Passed into walk_namespace
159 * return_value - Not used
163 * DESCRIPTION: Dump a single Node
164 * This procedure is a user_function called by acpi_ns_walk_namespace.
166 ******************************************************************************/
169 acpi_ns_dump_one_object(acpi_handle obj_handle,
170 u32 level, void *context, void **return_value)
172 struct acpi_walk_info *info = (struct acpi_walk_info *)context;
173 struct acpi_namespace_node *this_node;
174 union acpi_operand_object *obj_desc = NULL;
175 acpi_object_type obj_type;
176 acpi_object_type type;
181 ACPI_FUNCTION_NAME(ns_dump_one_object);
183 /* Is output enabled? */
185 if (!(acpi_dbg_level & info->debug_level)) {
190 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Null object handle\n"));
194 this_node = acpi_ns_validate_handle(obj_handle);
196 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Invalid object handle %p\n",
201 type = this_node->type;
203 /* Check if the owner matches */
205 if ((info->owner_id != ACPI_OWNER_ID_MAX) &&
206 (info->owner_id != this_node->owner_id)) {
210 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
212 /* Indent the object according to the level */
214 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
216 /* Check the node type and name */
218 if (type > ACPI_TYPE_LOCAL_MAX) {
219 ACPI_WARNING((AE_INFO,
220 "Invalid ACPI Object Type 0x%08X", type));
223 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
226 /* Now we can print out the pertinent information */
228 acpi_os_printf(" %-12s %p %2.2X ",
229 acpi_ut_get_type_name(type), this_node,
230 this_node->owner_id);
232 dbg_level = acpi_dbg_level;
234 obj_desc = acpi_ns_get_attached_object(this_node);
235 acpi_dbg_level = dbg_level;
237 /* Temp nodes are those nodes created by a control method */
239 if (this_node->flags & ANOBJ_TEMPORARY) {
240 acpi_os_printf("(T) ");
243 switch (info->display_type & ACPI_DISPLAY_MASK) {
244 case ACPI_DISPLAY_SUMMARY:
248 /* No attached object. Some types should always have an object */
251 case ACPI_TYPE_INTEGER:
252 case ACPI_TYPE_PACKAGE:
253 case ACPI_TYPE_BUFFER:
254 case ACPI_TYPE_STRING:
255 case ACPI_TYPE_METHOD:
257 acpi_os_printf("<No attached object>");
265 acpi_os_printf("\n");
270 case ACPI_TYPE_PROCESSOR:
272 acpi_os_printf("ID %02X Len %02X Addr %8.8X%8.8X\n",
273 obj_desc->processor.proc_id,
274 obj_desc->processor.length,
275 ACPI_FORMAT_UINT64(obj_desc->processor.
279 case ACPI_TYPE_DEVICE:
281 acpi_os_printf("Notify Object: %p\n", obj_desc);
284 case ACPI_TYPE_METHOD:
286 acpi_os_printf("Args %X Len %.4X Aml %p\n",
287 (u32) obj_desc->method.param_count,
288 obj_desc->method.aml_length,
289 obj_desc->method.aml_start);
292 case ACPI_TYPE_INTEGER:
294 acpi_os_printf("= %8.8X%8.8X\n",
295 ACPI_FORMAT_UINT64(obj_desc->integer.
299 case ACPI_TYPE_PACKAGE:
301 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
302 acpi_os_printf("Elements %.2X\n",
303 obj_desc->package.count);
305 acpi_os_printf("[Length not yet evaluated]\n");
309 case ACPI_TYPE_BUFFER:
311 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
312 acpi_os_printf("Len %.2X",
313 obj_desc->buffer.length);
315 /* Dump some of the buffer */
317 if (obj_desc->buffer.length > 0) {
318 acpi_os_printf(" =");
320 (i < obj_desc->buffer.length
322 acpi_os_printf(" %.2hX",
327 acpi_os_printf("\n");
329 acpi_os_printf("[Length not yet evaluated]\n");
333 case ACPI_TYPE_STRING:
335 acpi_os_printf("Len %.2X ", obj_desc->string.length);
336 acpi_ut_print_string(obj_desc->string.pointer, 32);
337 acpi_os_printf("\n");
340 case ACPI_TYPE_REGION:
342 acpi_os_printf("[%s]",
343 acpi_ut_get_region_name(obj_desc->region.
345 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
346 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
347 ACPI_FORMAT_UINT64(obj_desc->
350 obj_desc->region.length);
353 (" [Address/Length not yet evaluated]\n");
357 case ACPI_TYPE_LOCAL_REFERENCE:
359 acpi_os_printf("[%s]\n",
360 acpi_ut_get_reference_name(obj_desc));
363 case ACPI_TYPE_BUFFER_FIELD:
365 if (obj_desc->buffer_field.buffer_obj &&
366 obj_desc->buffer_field.buffer_obj->buffer.node) {
367 acpi_os_printf("Buf [%4.4s]",
368 acpi_ut_get_node_name(obj_desc->
376 case ACPI_TYPE_LOCAL_REGION_FIELD:
378 acpi_os_printf("Rgn [%4.4s]",
379 acpi_ut_get_node_name(obj_desc->
385 case ACPI_TYPE_LOCAL_BANK_FIELD:
387 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
388 acpi_ut_get_node_name(obj_desc->
392 acpi_ut_get_node_name(obj_desc->
399 case ACPI_TYPE_LOCAL_INDEX_FIELD:
401 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
402 acpi_ut_get_node_name(obj_desc->
406 acpi_ut_get_node_name(obj_desc->
413 case ACPI_TYPE_LOCAL_ALIAS:
414 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
416 acpi_os_printf("Target %4.4s (%p)\n",
417 acpi_ut_get_node_name(obj_desc),
423 acpi_os_printf("Object %p\n", obj_desc);
427 /* Common field handling */
430 case ACPI_TYPE_BUFFER_FIELD:
431 case ACPI_TYPE_LOCAL_REGION_FIELD:
432 case ACPI_TYPE_LOCAL_BANK_FIELD:
433 case ACPI_TYPE_LOCAL_INDEX_FIELD:
435 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
436 (obj_desc->common_field.
437 base_byte_offset * 8)
439 obj_desc->common_field.
440 start_field_bit_offset,
441 obj_desc->common_field.bit_length,
442 obj_desc->common_field.
452 case ACPI_DISPLAY_OBJECTS:
454 acpi_os_printf("O:%p", obj_desc);
457 /* No attached object, we are done */
459 acpi_os_printf("\n");
463 acpi_os_printf("(R%u)", obj_desc->common.reference_count);
466 case ACPI_TYPE_METHOD:
468 /* Name is a Method and its AML offset/length are set */
470 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
471 obj_desc->method.aml_length);
474 case ACPI_TYPE_INTEGER:
476 acpi_os_printf(" I:%8.8X8.8%X\n",
477 ACPI_FORMAT_UINT64(obj_desc->integer.
481 case ACPI_TYPE_STRING:
483 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
484 obj_desc->string.length);
487 case ACPI_TYPE_BUFFER:
489 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
490 obj_desc->buffer.length);
495 acpi_os_printf("\n");
501 acpi_os_printf("\n");
505 /* If debug turned off, done */
507 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
511 /* If there is an attached object, display it */
513 dbg_level = acpi_dbg_level;
515 obj_desc = acpi_ns_get_attached_object(this_node);
516 acpi_dbg_level = dbg_level;
518 /* Dump attached objects */
521 obj_type = ACPI_TYPE_INVALID;
522 acpi_os_printf("Attached Object %p: ", obj_desc);
524 /* Decode the type of attached object and dump the contents */
526 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
527 case ACPI_DESC_TYPE_NAMED:
529 acpi_os_printf("(Ptr to Node)\n");
530 bytes_to_dump = sizeof(struct acpi_namespace_node);
531 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
534 case ACPI_DESC_TYPE_OPERAND:
536 obj_type = obj_desc->common.type;
538 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
540 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
546 ("(Pointer to ACPI Object type %.2X [%s])\n",
547 obj_type, acpi_ut_get_type_name(obj_type));
550 sizeof(union acpi_operand_object);
553 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
561 /* If value is NOT an internal object, we are done */
563 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
564 ACPI_DESC_TYPE_OPERAND) {
568 /* Valid object, get the pointer to next level, if any */
571 case ACPI_TYPE_BUFFER:
572 case ACPI_TYPE_STRING:
574 * NOTE: takes advantage of common fields between string/buffer
576 bytes_to_dump = obj_desc->string.length;
577 obj_desc = (void *)obj_desc->string.pointer;
579 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
580 obj_desc, bytes_to_dump);
581 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
584 case ACPI_TYPE_BUFFER_FIELD:
587 (union acpi_operand_object *)obj_desc->buffer_field.
591 case ACPI_TYPE_PACKAGE:
593 obj_desc = (void *)obj_desc->package.elements;
596 case ACPI_TYPE_METHOD:
598 obj_desc = (void *)obj_desc->method.aml_start;
601 case ACPI_TYPE_LOCAL_REGION_FIELD:
603 obj_desc = (void *)obj_desc->field.region_obj;
606 case ACPI_TYPE_LOCAL_BANK_FIELD:
608 obj_desc = (void *)obj_desc->bank_field.region_obj;
611 case ACPI_TYPE_LOCAL_INDEX_FIELD:
613 obj_desc = (void *)obj_desc->index_field.index_obj;
621 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
625 acpi_os_printf("\n");
629 /*******************************************************************************
631 * FUNCTION: acpi_ns_dump_objects
633 * PARAMETERS: type - Object type to be dumped
634 * display_type - 0 or ACPI_DISPLAY_SUMMARY
635 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
636 * for an effectively unlimited depth.
637 * owner_id - Dump only objects owned by this ID. Use
638 * ACPI_UINT32_MAX to match all owners.
639 * start_handle - Where in namespace to start/end search
643 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
644 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
646 ******************************************************************************/
649 acpi_ns_dump_objects(acpi_object_type type,
652 acpi_owner_id owner_id, acpi_handle start_handle)
654 struct acpi_walk_info info;
657 ACPI_FUNCTION_ENTRY();
660 * Just lock the entire namespace for the duration of the dump.
661 * We don't want any changes to the namespace during this time,
662 * especially the temporary nodes since we are going to display
665 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
666 if (ACPI_FAILURE(status)) {
667 acpi_os_printf("Could not acquire namespace mutex\n");
671 info.debug_level = ACPI_LV_TABLES;
672 info.owner_id = owner_id;
673 info.display_type = display_type;
675 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
676 ACPI_NS_WALK_NO_UNLOCK |
677 ACPI_NS_WALK_TEMP_NODES,
678 acpi_ns_dump_one_object, NULL,
679 (void *)&info, NULL);
681 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
684 /*******************************************************************************
686 * FUNCTION: acpi_ns_dump_one_object_path, acpi_ns_get_max_depth
688 * PARAMETERS: obj_handle - Node to be dumped
689 * level - Nesting level of the handle
690 * context - Passed into walk_namespace
691 * return_value - Not used
695 * DESCRIPTION: Dump the full pathname to a namespace object. acp_ns_get_max_depth
696 * computes the maximum nesting depth in the namespace tree, in
697 * order to simplify formatting in acpi_ns_dump_one_object_path.
698 * These procedures are user_functions called by acpi_ns_walk_namespace.
700 ******************************************************************************/
703 acpi_ns_dump_one_object_path(acpi_handle obj_handle,
704 u32 level, void *context, void **return_value)
706 u32 max_level = *((u32 *)context);
708 struct acpi_namespace_node *node;
715 node = acpi_ns_validate_handle(obj_handle);
718 /* Ignore bad node during namespace walk */
723 pathname = acpi_ns_get_normalized_pathname(node, TRUE);
726 if (level <= max_level) {
727 path_indent = max_level - level + 1;
730 acpi_os_printf("%2d%*s%-12s%*s",
731 level, level, " ", acpi_ut_get_type_name(node->type),
734 acpi_os_printf("%s\n", &pathname[1]);
740 acpi_ns_get_max_depth(acpi_handle obj_handle,
741 u32 level, void *context, void **return_value)
743 u32 *max_level = (u32 *)context;
745 if (level > *max_level) {
751 /*******************************************************************************
753 * FUNCTION: acpi_ns_dump_object_paths
755 * PARAMETERS: type - Object type to be dumped
756 * display_type - 0 or ACPI_DISPLAY_SUMMARY
757 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
758 * for an effectively unlimited depth.
759 * owner_id - Dump only objects owned by this ID. Use
760 * ACPI_UINT32_MAX to match all owners.
761 * start_handle - Where in namespace to start/end search
765 * DESCRIPTION: Dump full object pathnames within the loaded namespace. Uses
766 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object_path.
768 ******************************************************************************/
771 acpi_ns_dump_object_paths(acpi_object_type type,
774 acpi_owner_id owner_id, acpi_handle start_handle)
779 ACPI_FUNCTION_ENTRY();
782 * Just lock the entire namespace for the duration of the dump.
783 * We don't want any changes to the namespace during this time,
784 * especially the temporary nodes since we are going to display
787 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
788 if (ACPI_FAILURE(status)) {
789 acpi_os_printf("Could not acquire namespace mutex\n");
793 /* Get the max depth of the namespace tree, for formatting later */
795 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
796 ACPI_NS_WALK_NO_UNLOCK |
797 ACPI_NS_WALK_TEMP_NODES,
798 acpi_ns_get_max_depth, NULL,
799 (void *)&max_level, NULL);
801 /* Now dump the entire namespace */
803 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
804 ACPI_NS_WALK_NO_UNLOCK |
805 ACPI_NS_WALK_TEMP_NODES,
806 acpi_ns_dump_one_object_path, NULL,
807 (void *)&max_level, NULL);
809 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
812 /*******************************************************************************
814 * FUNCTION: acpi_ns_dump_entry
816 * PARAMETERS: handle - Node to be dumped
817 * debug_level - Output level
821 * DESCRIPTION: Dump a single Node
823 ******************************************************************************/
825 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
827 struct acpi_walk_info info;
829 ACPI_FUNCTION_ENTRY();
831 info.debug_level = debug_level;
832 info.owner_id = ACPI_OWNER_ID_MAX;
833 info.display_type = ACPI_DISPLAY_SUMMARY;
835 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
838 #ifdef ACPI_ASL_COMPILER
839 /*******************************************************************************
841 * FUNCTION: acpi_ns_dump_tables
843 * PARAMETERS: search_base - Root of subtree to be dumped, or
844 * NS_ALL to dump the entire namespace
845 * max_depth - Maximum depth of dump. Use INT_MAX
846 * for an effectively unlimited depth.
850 * DESCRIPTION: Dump the name space, or a portion of it.
852 ******************************************************************************/
854 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
856 acpi_handle search_handle = search_base;
858 ACPI_FUNCTION_TRACE(ns_dump_tables);
860 if (!acpi_gbl_root_node) {
862 * If the name space has not been initialized,
863 * there is nothing to dump.
865 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
866 "namespace not initialized!\n"));
870 if (ACPI_NS_ALL == search_base) {
872 /* Entire namespace */
874 search_handle = acpi_gbl_root_node;
875 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
878 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
879 ACPI_OWNER_ID_MAX, search_handle);