[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / dsdebug.c

/******************************************************************************
 *
 * Module Name: dsdebug - Parser/Interpreter interface - debugging
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2015, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include "accommon.h"
#include "acdispat.h"
#include "acnamesp.h"
#ifdef ACPI_DISASSEMBLER
#include "acdisasm.h"
#endif

#define _COMPONENT          ACPI_DISPATCHER
ACPI_MODULE_NAME("dsdebug")

#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
/* Local prototypes */
static void
acpi_ds_print_node_pathname(struct acpi_namespace_node *node,
			    const char *message);

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_print_node_pathname
 *
 * PARAMETERS:  node            - Object
 *              message         - Prefix message
 *
 * DESCRIPTION: Print an object's full namespace pathname
 *              Manages allocation/freeing of a pathname buffer
 *
 ******************************************************************************/

static void
acpi_ds_print_node_pathname(struct acpi_namespace_node *node,
			    const char *message)
{
	struct acpi_buffer buffer;
	acpi_status status;

	ACPI_FUNCTION_TRACE(ds_print_node_pathname);

	if (!node) {
		ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "[NULL NAME]"));
		return_VOID;
	}

	/* Convert handle to full pathname and print it (with supplied message) */

	buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;

	status = acpi_ns_handle_to_pathname(node, &buffer, FALSE);
	if (ACPI_SUCCESS(status)) {
		if (message) {
			ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "%s ",
					      message));
		}

		ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "[%s] (Node %p)",
				      (char *)buffer.pointer, node));
		ACPI_FREE(buffer.pointer);
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_dump_method_stack
 *
 * PARAMETERS:  status          - Method execution status
 *              walk_state      - Current state of the parse tree walk
 *              op              - Executing parse op
 *
 * RETURN:      None
 *
 * DESCRIPTION: Called when a method has been aborted because of an error.
 *              Dumps the method execution stack.
 *
 ******************************************************************************/

void
acpi_ds_dump_method_stack(acpi_status status,
			  struct acpi_walk_state *walk_state,
			  union acpi_parse_object *op)
{
	union acpi_parse_object *next;
	struct acpi_thread_state *thread;
	struct acpi_walk_state *next_walk_state;
	struct acpi_namespace_node *previous_method = NULL;

	ACPI_FUNCTION_TRACE(ds_dump_method_stack);

	/* Ignore control codes, they are not errors */

	if ((status & AE_CODE_MASK) == AE_CODE_CONTROL) {
		return_VOID;
	}

	/* We may be executing a deferred opcode */

	if (walk_state->deferred_node) {
		ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
				  "Executing subtree for Buffer/Package/Region\n"));
		return_VOID;
	}

	/*
	 * If there is no Thread, we are not actually executing a method.
	 * This can happen when the iASL compiler calls the interpreter
	 * to perform constant folding.
	 */
	thread = walk_state->thread;
	if (!thread) {
		return_VOID;
	}

	/* Display exception and method name */

	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
			  "\n**** Exception %s during execution of method ",
			  acpi_format_exception(status)));
	acpi_ds_print_node_pathname(walk_state->method_node, NULL);

	/* Display stack of executing methods */

	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH,
			      "\n\nMethod Execution Stack:\n"));
	next_walk_state = thread->walk_state_list;

	/* Walk list of linked walk states */

	while (next_walk_state) {
		ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
				  "    Method [%4.4s] executing: ",
				  acpi_ut_get_node_name(next_walk_state->
							method_node)));

		/* First method is the currently executing method */

		if (next_walk_state == walk_state) {
			if (op) {

				/* Display currently executing ASL statement */

				next = op->common.next;
				op->common.next = NULL;

#ifdef ACPI_DISASSEMBLER
				acpi_dm_disassemble(next_walk_state, op,
						    ACPI_UINT32_MAX);
#endif
				op->common.next = next;
			}
		} else {
			/*
			 * This method has called another method
			 * NOTE: the method call parse subtree is already deleted at this
			 * point, so we cannot disassemble the method invocation.
			 */
			ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH,
					      "Call to method "));
			acpi_ds_print_node_pathname(previous_method, NULL);
		}

		previous_method = next_walk_state->method_node;
		next_walk_state = next_walk_state->next;
		ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "\n"));
	}

	return_VOID;
}

#else
void
acpi_ds_dump_method_stack(acpi_status status,
			  struct acpi_walk_state *walk_state,
			  union acpi_parse_object *op)
{
	return;
}

#endif
Commit	Line	Data
0bac4295 LZ	1	/******************************************************************************
	2	*
	3	* Module Name: dsdebug - Parser/Interpreter interface - debugging
	4	*
	5	*****************************************************************************/
	6
	7	/*
	8	* Copyright (C) 2000 - 2015, 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 "acdispat.h"
	47	#include "acnamesp.h"
	48	#ifdef ACPI_DISASSEMBLER
	49	#include "acdisasm.h"
	50	#endif
	51
	52	#define _COMPONENT ACPI_DISPATCHER
	53	ACPI_MODULE_NAME("dsdebug")
	54
	55	#if defined(ACPI_DEBUG_OUTPUT) \|\| defined(ACPI_DEBUGGER)
	56	/* Local prototypes */
	57	static void
	58	acpi_ds_print_node_pathname(struct acpi_namespace_node *node,
	59	const char *message);
	60
	61	/*******************************************************************************
	62	*
	63	* FUNCTION: acpi_ds_print_node_pathname
	64	*
65	* PARAMETERS: node - Object
66	* message - Prefix message
67	*
68	* DESCRIPTION: Print an object's full namespace pathname
69	* Manages allocation/freeing of a pathname buffer
70	*
71	******************************************************************************/
72
73	static void
74	acpi_ds_print_node_pathname(struct acpi_namespace_node *node,
75	const char *message)
76	{
77	struct acpi_buffer buffer;
78	acpi_status status;
79
80	ACPI_FUNCTION_TRACE(ds_print_node_pathname);
81
82	if (!node) {
83	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "[NULL NAME]"));
84	return_VOID;
85	}
86
87	/* Convert handle to full pathname and print it (with supplied message) */
88
89	buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
90
91	status = acpi_ns_handle_to_pathname(node, &buffer, FALSE);
92	if (ACPI_SUCCESS(status)) {
93	if (message) {
94	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "%s ",
95	message));
96	}
97
98	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "[%s] (Node %p)",
99	(char *)buffer.pointer, node));
100	ACPI_FREE(buffer.pointer);
101	}
102
103	return_VOID;
104	}
105
106	/*******************************************************************************
107	*
108	* FUNCTION: acpi_ds_dump_method_stack
109	*
110	* PARAMETERS: status - Method execution status
111	* walk_state - Current state of the parse tree walk
112	* op - Executing parse op
113	*
114	* RETURN: None
115	*
116	* DESCRIPTION: Called when a method has been aborted because of an error.
117	* Dumps the method execution stack.
118	*
119	******************************************************************************/
120
121	void
122	acpi_ds_dump_method_stack(acpi_status status,
123	struct acpi_walk_state *walk_state,
124	union acpi_parse_object *op)
125	{
126	union acpi_parse_object *next;
127	struct acpi_thread_state *thread;
128	struct acpi_walk_state *next_walk_state;
129	struct acpi_namespace_node *previous_method = NULL;
130
131	ACPI_FUNCTION_TRACE(ds_dump_method_stack);
132
133	/* Ignore control codes, they are not errors */
134
135	if ((status & AE_CODE_MASK) == AE_CODE_CONTROL) {
136	return_VOID;
137	}
138
139	/* We may be executing a deferred opcode */
140
141	if (walk_state->deferred_node) {
142	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
143	"Executing subtree for Buffer/Package/Region\n"));
144	return_VOID;
145	}
146
147	/*
148	* If there is no Thread, we are not actually executing a method.
149	* This can happen when the iASL compiler calls the interpreter
150	* to perform constant folding.
151	*/
152	thread = walk_state->thread;
153	if (!thread) {
154	return_VOID;
155	}
156
157	/* Display exception and method name */
158
159	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
160	"\n**** Exception %s during execution of method ",
161	acpi_format_exception(status)));
162	acpi_ds_print_node_pathname(walk_state->method_node, NULL);
163
164	/* Display stack of executing methods */
165
166	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH,
167	"\n\nMethod Execution Stack:\n"));
168	next_walk_state = thread->walk_state_list;
169
170	/* Walk list of linked walk states */
171
172	while (next_walk_state) {
173	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
174	" Method [%4.4s] executing: ",
175	acpi_ut_get_node_name(next_walk_state->
176	method_node)));
177
178	/* First method is the currently executing method */
179
180	if (next_walk_state == walk_state) {
181	if (op) {
182
183	/* Display currently executing ASL statement */
184
185	next = op->common.next;
186	op->common.next = NULL;
187
188	#ifdef ACPI_DISASSEMBLER
189	acpi_dm_disassemble(next_walk_state, op,
190	ACPI_UINT32_MAX);
191	#endif
192	op->common.next = next;
193	}
194	} else {
195	/*
196	* This method has called another method
197	* NOTE: the method call parse subtree is already deleted at this
198	* point, so we cannot disassemble the method invocation.
199	*/
200	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH,
201	"Call to method "));
202	acpi_ds_print_node_pathname(previous_method, NULL);
203	}
204
205	previous_method = next_walk_state->method_node;
206	next_walk_state = next_walk_state->next;
207	ACPI_DEBUG_PRINT_RAW((ACPI_DB_DISPATCH, "\n"));
208	}
209
210	return_VOID;
211	}
212
213	#else
214	void
215	acpi_ds_dump_method_stack(acpi_status status,
216	struct acpi_walk_state *walk_state,
217	union acpi_parse_object *op)
218	{
219	return;
220	}
221
222	#endif