1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: nsdump - table dumping routines for debug
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
13 #include <acpi/acoutput.h>
15 #define _COMPONENT ACPI_NAMESPACE
16 ACPI_MODULE_NAME("nsdump")
18 /* Local prototypes */
19 #ifdef ACPI_OBSOLETE_FUNCTIONS
20 void acpi_ns_dump_root_devices(void);
23 acpi_ns_dump_one_device(acpi_handle obj_handle
,
24 u32 level
, void *context
, void **return_value
);
27 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
30 acpi_ns_dump_one_object_path(acpi_handle obj_handle
,
31 u32 level
, void *context
, void **return_value
);
34 acpi_ns_get_max_depth(acpi_handle obj_handle
,
35 u32 level
, void *context
, void **return_value
);
37 /*******************************************************************************
39 * FUNCTION: acpi_ns_print_pathname
41 * PARAMETERS: num_segments - Number of ACPI name segments
42 * pathname - The compressed (internal) path
46 * DESCRIPTION: Print an object's full namespace pathname
48 ******************************************************************************/
50 void acpi_ns_print_pathname(u32 num_segments
, const char *pathname
)
54 ACPI_FUNCTION_NAME(ns_print_pathname
);
56 /* Check if debug output enabled */
58 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_NAMES
, ACPI_NAMESPACE
)) {
62 /* Print the entire name */
64 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
, "["));
66 while (num_segments
) {
67 for (i
= 0; i
< 4; i
++) {
68 isprint((int)pathname
[i
]) ?
69 acpi_os_printf("%c", pathname
[i
]) :
73 pathname
+= ACPI_NAMESEG_SIZE
;
80 acpi_os_printf("]\n");
83 #ifdef ACPI_OBSOLETE_FUNCTIONS
84 /* Not used at this time, perhaps later */
86 /*******************************************************************************
88 * FUNCTION: acpi_ns_dump_pathname
90 * PARAMETERS: handle - Object
91 * msg - Prefix message
92 * level - Desired debug level
93 * component - Caller's component ID
97 * DESCRIPTION: Print an object's full namespace pathname
98 * Manages allocation/freeing of a pathname buffer
100 ******************************************************************************/
103 acpi_ns_dump_pathname(acpi_handle handle
,
104 const char *msg
, u32 level
, u32 component
)
107 ACPI_FUNCTION_TRACE(ns_dump_pathname
);
109 /* Do this only if the requested debug level and component are enabled */
111 if (!ACPI_IS_DEBUG_ENABLED(level
, component
)) {
115 /* Convert handle to a full pathname and print it (with supplied message) */
117 acpi_ns_print_node_pathname(handle
, msg
);
118 acpi_os_printf("\n");
123 /*******************************************************************************
125 * FUNCTION: acpi_ns_dump_one_object
127 * PARAMETERS: obj_handle - Node to be dumped
128 * level - Nesting level of the handle
129 * context - Passed into walk_namespace
130 * return_value - Not used
134 * DESCRIPTION: Dump a single Node
135 * This procedure is a user_function called by acpi_ns_walk_namespace.
137 ******************************************************************************/
140 acpi_ns_dump_one_object(acpi_handle obj_handle
,
141 u32 level
, void *context
, void **return_value
)
143 struct acpi_walk_info
*info
= (struct acpi_walk_info
*)context
;
144 struct acpi_namespace_node
*this_node
;
145 union acpi_operand_object
*obj_desc
= NULL
;
146 acpi_object_type obj_type
;
147 acpi_object_type type
;
152 ACPI_FUNCTION_NAME(ns_dump_one_object
);
154 /* Is output enabled? */
156 if (!(acpi_dbg_level
& info
->debug_level
)) {
161 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Null object handle\n"));
165 this_node
= acpi_ns_validate_handle(obj_handle
);
167 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Invalid object handle %p\n",
172 type
= this_node
->type
;
175 /* Check if the owner matches */
177 if ((info
->owner_id
!= ACPI_OWNER_ID_MAX
) &&
178 (info
->owner_id
!= this_node
->owner_id
)) {
182 if (!(info
->display_type
& ACPI_DISPLAY_SHORT
)) {
184 /* Indent the object according to the level */
186 acpi_os_printf("%2d%*s", (u32
) level
- 1, (int)level
* 2, " ");
188 /* Check the node type and name */
190 if (type
> ACPI_TYPE_LOCAL_MAX
) {
191 ACPI_WARNING((AE_INFO
,
192 "Invalid ACPI Object Type 0x%08X", type
));
195 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node
));
198 /* Now we can print out the pertinent information */
200 acpi_os_printf(" %-12s %p %3.3X ",
201 acpi_ut_get_type_name(type
), this_node
,
202 this_node
->owner_id
);
204 dbg_level
= acpi_dbg_level
;
206 obj_desc
= acpi_ns_get_attached_object(this_node
);
207 acpi_dbg_level
= dbg_level
;
209 /* Temp nodes are those nodes created by a control method */
211 if (this_node
->flags
& ANOBJ_TEMPORARY
) {
212 acpi_os_printf("(T) ");
215 switch (info
->display_type
& ACPI_DISPLAY_MASK
) {
216 case ACPI_DISPLAY_SUMMARY
:
220 /* No attached object. Some types should always have an object */
223 case ACPI_TYPE_INTEGER
:
224 case ACPI_TYPE_PACKAGE
:
225 case ACPI_TYPE_BUFFER
:
226 case ACPI_TYPE_STRING
:
227 case ACPI_TYPE_METHOD
:
229 acpi_os_printf("<No attached object>");
237 acpi_os_printf("\n");
242 case ACPI_TYPE_PROCESSOR
:
244 acpi_os_printf("ID %02X Len %02X Addr %8.8X%8.8X\n",
245 obj_desc
->processor
.proc_id
,
246 obj_desc
->processor
.length
,
247 ACPI_FORMAT_UINT64(obj_desc
->processor
.
251 case ACPI_TYPE_DEVICE
:
253 acpi_os_printf("Notify Object: %p\n", obj_desc
);
256 case ACPI_TYPE_METHOD
:
258 acpi_os_printf("Args %X Len %.4X Aml %p\n",
259 (u32
) obj_desc
->method
.param_count
,
260 obj_desc
->method
.aml_length
,
261 obj_desc
->method
.aml_start
);
264 case ACPI_TYPE_INTEGER
:
266 acpi_os_printf("= %8.8X%8.8X\n",
267 ACPI_FORMAT_UINT64(obj_desc
->integer
.
271 case ACPI_TYPE_PACKAGE
:
273 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
274 acpi_os_printf("Elements %.2X\n",
275 obj_desc
->package
.count
);
277 acpi_os_printf("[Length not yet evaluated]\n");
281 case ACPI_TYPE_BUFFER
:
283 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
284 acpi_os_printf("Len %.2X",
285 obj_desc
->buffer
.length
);
287 /* Dump some of the buffer */
289 if (obj_desc
->buffer
.length
> 0) {
290 acpi_os_printf(" =");
292 (i
< obj_desc
->buffer
.length
294 acpi_os_printf(" %2.2X",
299 acpi_os_printf("\n");
301 acpi_os_printf("[Length not yet evaluated]\n");
305 case ACPI_TYPE_STRING
:
307 acpi_os_printf("Len %.2X ", obj_desc
->string
.length
);
308 acpi_ut_print_string(obj_desc
->string
.pointer
, 80);
309 acpi_os_printf("\n");
312 case ACPI_TYPE_REGION
:
314 acpi_os_printf("[%s]",
315 acpi_ut_get_region_name(obj_desc
->region
.
317 if (obj_desc
->region
.flags
& AOPOBJ_DATA_VALID
) {
318 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
319 ACPI_FORMAT_UINT64(obj_desc
->
322 obj_desc
->region
.length
);
325 (" [Address/Length not yet evaluated]\n");
329 case ACPI_TYPE_LOCAL_REFERENCE
:
331 acpi_os_printf("[%s]\n",
332 acpi_ut_get_reference_name(obj_desc
));
335 case ACPI_TYPE_BUFFER_FIELD
:
337 if (obj_desc
->buffer_field
.buffer_obj
&&
338 obj_desc
->buffer_field
.buffer_obj
->buffer
.node
) {
339 acpi_os_printf("Buf [%4.4s]",
340 acpi_ut_get_node_name(obj_desc
->
348 case ACPI_TYPE_LOCAL_REGION_FIELD
:
350 acpi_os_printf("Rgn [%4.4s]",
351 acpi_ut_get_node_name(obj_desc
->
357 case ACPI_TYPE_LOCAL_BANK_FIELD
:
359 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
360 acpi_ut_get_node_name(obj_desc
->
364 acpi_ut_get_node_name(obj_desc
->
371 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
373 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
374 acpi_ut_get_node_name(obj_desc
->
378 acpi_ut_get_node_name(obj_desc
->
385 case ACPI_TYPE_LOCAL_ALIAS
:
386 case ACPI_TYPE_LOCAL_METHOD_ALIAS
:
388 acpi_os_printf("Target %4.4s (%p)\n",
389 acpi_ut_get_node_name(obj_desc
),
395 acpi_os_printf("Object %p\n", obj_desc
);
399 /* Common field handling */
402 case ACPI_TYPE_BUFFER_FIELD
:
403 case ACPI_TYPE_LOCAL_REGION_FIELD
:
404 case ACPI_TYPE_LOCAL_BANK_FIELD
:
405 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
407 acpi_os_printf(" Off %.3X Len %.2X Acc %.2X\n",
408 (obj_desc
->common_field
.
409 base_byte_offset
* 8)
411 obj_desc
->common_field
.
412 start_field_bit_offset
,
413 obj_desc
->common_field
.bit_length
,
414 obj_desc
->common_field
.
424 case ACPI_DISPLAY_OBJECTS
:
426 acpi_os_printf("O:%p", obj_desc
);
429 /* No attached object, we are done */
431 acpi_os_printf("\n");
435 acpi_os_printf("(R%u)", obj_desc
->common
.reference_count
);
438 case ACPI_TYPE_METHOD
:
440 /* Name is a Method and its AML offset/length are set */
442 acpi_os_printf(" M:%p-%X\n", obj_desc
->method
.aml_start
,
443 obj_desc
->method
.aml_length
);
446 case ACPI_TYPE_INTEGER
:
448 acpi_os_printf(" I:%8.8X8.8%X\n",
449 ACPI_FORMAT_UINT64(obj_desc
->integer
.
453 case ACPI_TYPE_STRING
:
455 acpi_os_printf(" S:%p-%X\n", obj_desc
->string
.pointer
,
456 obj_desc
->string
.length
);
459 case ACPI_TYPE_BUFFER
:
461 acpi_os_printf(" B:%p-%X\n", obj_desc
->buffer
.pointer
,
462 obj_desc
->buffer
.length
);
467 acpi_os_printf("\n");
473 acpi_os_printf("\n");
477 /* If debug turned off, done */
479 if (!(acpi_dbg_level
& ACPI_LV_VALUES
)) {
483 /* If there is an attached object, display it */
485 dbg_level
= acpi_dbg_level
;
487 obj_desc
= acpi_ns_get_attached_object(this_node
);
488 acpi_dbg_level
= dbg_level
;
490 /* Dump attached objects */
493 obj_type
= ACPI_TYPE_INVALID
;
494 acpi_os_printf("Attached Object %p: ", obj_desc
);
496 /* Decode the type of attached object and dump the contents */
498 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
)) {
499 case ACPI_DESC_TYPE_NAMED
:
501 acpi_os_printf("(Ptr to Node)\n");
502 bytes_to_dump
= sizeof(struct acpi_namespace_node
);
503 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
506 case ACPI_DESC_TYPE_OPERAND
:
508 obj_type
= obj_desc
->common
.type
;
510 if (obj_type
> ACPI_TYPE_LOCAL_MAX
) {
512 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
518 ("(Pointer to ACPI Object type %.2X [%s])\n",
519 obj_type
, acpi_ut_get_type_name(obj_type
));
522 sizeof(union acpi_operand_object
);
525 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
533 /* If value is NOT an internal object, we are done */
535 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
) !=
536 ACPI_DESC_TYPE_OPERAND
) {
540 /* Valid object, get the pointer to next level, if any */
543 case ACPI_TYPE_BUFFER
:
544 case ACPI_TYPE_STRING
:
546 * NOTE: takes advantage of common fields between string/buffer
548 bytes_to_dump
= obj_desc
->string
.length
;
549 obj_desc
= (void *)obj_desc
->string
.pointer
;
551 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
552 obj_desc
, bytes_to_dump
);
553 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
556 case ACPI_TYPE_BUFFER_FIELD
:
559 (union acpi_operand_object
*)obj_desc
->buffer_field
.
563 case ACPI_TYPE_PACKAGE
:
565 obj_desc
= (void *)obj_desc
->package
.elements
;
568 case ACPI_TYPE_METHOD
:
570 obj_desc
= (void *)obj_desc
->method
.aml_start
;
573 case ACPI_TYPE_LOCAL_REGION_FIELD
:
575 obj_desc
= (void *)obj_desc
->field
.region_obj
;
578 case ACPI_TYPE_LOCAL_BANK_FIELD
:
580 obj_desc
= (void *)obj_desc
->bank_field
.region_obj
;
583 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
585 obj_desc
= (void *)obj_desc
->index_field
.index_obj
;
595 acpi_os_printf("\n");
599 /*******************************************************************************
601 * FUNCTION: acpi_ns_dump_objects
603 * PARAMETERS: type - Object type to be dumped
604 * display_type - 0 or ACPI_DISPLAY_SUMMARY
605 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
606 * for an effectively unlimited depth.
607 * owner_id - Dump only objects owned by this ID. Use
608 * ACPI_UINT32_MAX to match all owners.
609 * start_handle - Where in namespace to start/end search
613 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
614 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
616 ******************************************************************************/
619 acpi_ns_dump_objects(acpi_object_type type
,
622 acpi_owner_id owner_id
, acpi_handle start_handle
)
624 struct acpi_walk_info info
;
627 ACPI_FUNCTION_ENTRY();
630 * Just lock the entire namespace for the duration of the dump.
631 * We don't want any changes to the namespace during this time,
632 * especially the temporary nodes since we are going to display
635 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
636 if (ACPI_FAILURE(status
)) {
637 acpi_os_printf("Could not acquire namespace mutex\n");
642 info
.debug_level
= ACPI_LV_TABLES
;
643 info
.owner_id
= owner_id
;
644 info
.display_type
= display_type
;
646 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
647 ACPI_NS_WALK_NO_UNLOCK
|
648 ACPI_NS_WALK_TEMP_NODES
,
649 acpi_ns_dump_one_object
, NULL
,
650 (void *)&info
, NULL
);
652 acpi_os_printf("\nNamespace node count: %u\n\n", info
.count
);
653 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
656 /*******************************************************************************
658 * FUNCTION: acpi_ns_dump_one_object_path, acpi_ns_get_max_depth
660 * PARAMETERS: obj_handle - Node to be dumped
661 * level - Nesting level of the handle
662 * context - Passed into walk_namespace
663 * return_value - Not used
667 * DESCRIPTION: Dump the full pathname to a namespace object. acp_ns_get_max_depth
668 * computes the maximum nesting depth in the namespace tree, in
669 * order to simplify formatting in acpi_ns_dump_one_object_path.
670 * These procedures are user_functions called by acpi_ns_walk_namespace.
672 ******************************************************************************/
675 acpi_ns_dump_one_object_path(acpi_handle obj_handle
,
676 u32 level
, void *context
, void **return_value
)
678 u32 max_level
= *((u32
*)context
);
680 struct acpi_namespace_node
*node
;
687 node
= acpi_ns_validate_handle(obj_handle
);
690 /* Ignore bad node during namespace walk */
695 pathname
= acpi_ns_get_normalized_pathname(node
, TRUE
);
698 if (level
<= max_level
) {
699 path_indent
= max_level
- level
+ 1;
702 acpi_os_printf("%2d%*s%-12s%*s",
703 level
, level
, " ", acpi_ut_get_type_name(node
->type
),
706 acpi_os_printf("%s\n", &pathname
[1]);
712 acpi_ns_get_max_depth(acpi_handle obj_handle
,
713 u32 level
, void *context
, void **return_value
)
715 u32
*max_level
= (u32
*)context
;
717 if (level
> *max_level
) {
723 /*******************************************************************************
725 * FUNCTION: acpi_ns_dump_object_paths
727 * PARAMETERS: type - Object type to be dumped
728 * display_type - 0 or ACPI_DISPLAY_SUMMARY
729 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
730 * for an effectively unlimited depth.
731 * owner_id - Dump only objects owned by this ID. Use
732 * ACPI_UINT32_MAX to match all owners.
733 * start_handle - Where in namespace to start/end search
737 * DESCRIPTION: Dump full object pathnames within the loaded namespace. Uses
738 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object_path.
740 ******************************************************************************/
743 acpi_ns_dump_object_paths(acpi_object_type type
,
746 acpi_owner_id owner_id
, acpi_handle start_handle
)
751 ACPI_FUNCTION_ENTRY();
754 * Just lock the entire namespace for the duration of the dump.
755 * We don't want any changes to the namespace during this time,
756 * especially the temporary nodes since we are going to display
759 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
760 if (ACPI_FAILURE(status
)) {
761 acpi_os_printf("Could not acquire namespace mutex\n");
765 /* Get the max depth of the namespace tree, for formatting later */
767 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
768 ACPI_NS_WALK_NO_UNLOCK
|
769 ACPI_NS_WALK_TEMP_NODES
,
770 acpi_ns_get_max_depth
, NULL
,
771 (void *)&max_level
, NULL
);
773 /* Now dump the entire namespace */
775 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
776 ACPI_NS_WALK_NO_UNLOCK
|
777 ACPI_NS_WALK_TEMP_NODES
,
778 acpi_ns_dump_one_object_path
, NULL
,
779 (void *)&max_level
, NULL
);
781 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
784 /*******************************************************************************
786 * FUNCTION: acpi_ns_dump_entry
788 * PARAMETERS: handle - Node to be dumped
789 * debug_level - Output level
793 * DESCRIPTION: Dump a single Node
795 ******************************************************************************/
797 void acpi_ns_dump_entry(acpi_handle handle
, u32 debug_level
)
799 struct acpi_walk_info info
;
801 ACPI_FUNCTION_ENTRY();
803 info
.debug_level
= debug_level
;
804 info
.owner_id
= ACPI_OWNER_ID_MAX
;
805 info
.display_type
= ACPI_DISPLAY_SUMMARY
;
807 (void)acpi_ns_dump_one_object(handle
, 1, &info
, NULL
);
810 #ifdef ACPI_ASL_COMPILER
811 /*******************************************************************************
813 * FUNCTION: acpi_ns_dump_tables
815 * PARAMETERS: search_base - Root of subtree to be dumped, or
816 * NS_ALL to dump the entire namespace
817 * max_depth - Maximum depth of dump. Use INT_MAX
818 * for an effectively unlimited depth.
822 * DESCRIPTION: Dump the name space, or a portion of it.
824 ******************************************************************************/
826 void acpi_ns_dump_tables(acpi_handle search_base
, u32 max_depth
)
828 acpi_handle search_handle
= search_base
;
830 ACPI_FUNCTION_TRACE(ns_dump_tables
);
832 if (!acpi_gbl_root_node
) {
834 * If the name space has not been initialized,
835 * there is nothing to dump.
837 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
,
838 "namespace not initialized!\n"));
842 if (ACPI_NS_ALL
== search_base
) {
844 /* Entire namespace */
846 search_handle
= acpi_gbl_root_node
;
847 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
, "\\\n"));
850 acpi_ns_dump_objects(ACPI_TYPE_ANY
, ACPI_DISPLAY_OBJECTS
, max_depth
,
851 ACPI_OWNER_ID_MAX
, search_handle
);