dsmethod.c 25.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/******************************************************************************
 *
 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
 *
 *****************************************************************************/

/*
8
 * Copyright (C) 2000 - 2015, Intel Corp.
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * 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>
L
Len Brown 已提交
45 46 47 48
#include "accommon.h"
#include "acdispat.h"
#include "acinterp.h"
#include "acnamesp.h"
L
Len Brown 已提交
49
#ifdef	ACPI_DISASSEMBLER
50
#include "acdisasm.h"
L
Len Brown 已提交
51
#endif
52 53
#include "acparser.h"
#include "amlcode.h"
L
Linus Torvalds 已提交
54 55

#define _COMPONENT          ACPI_DISPATCHER
L
Len Brown 已提交
56
ACPI_MODULE_NAME("dsmethod")
L
Linus Torvalds 已提交
57

B
Bob Moore 已提交
58
/* Local prototypes */
59 60 61 62
static acpi_status
acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
			     union acpi_parse_object **out_op);

B
Bob Moore 已提交
63 64 65
static acpi_status
acpi_ds_create_method_mutex(union acpi_operand_object *method_desc);

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_auto_serialize_method
 *
 * PARAMETERS:  node                        - Namespace Node of the method
 *              obj_desc                    - Method object attached to node
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Parse a control method AML to scan for control methods that
 *              need serialization due to the creation of named objects.
 *
 * NOTE: It is a bit of overkill to mark all such methods serialized, since
 * there is only a problem if the method actually blocks during execution.
 * A blocking operation is, for example, a Sleep() operation, or any access
 * to an operation region. However, it is probably not possible to easily
 * detect whether a method will block or not, so we simply mark all suspicious
 * methods as serialized.
 *
 * NOTE2: This code is essentially a generic routine for parsing a single
 * control method.
 *
 ******************************************************************************/

acpi_status
acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
			      union acpi_operand_object *obj_desc)
{
	acpi_status status;
	union acpi_parse_object *op = NULL;
	struct acpi_walk_state *walk_state;

	ACPI_FUNCTION_TRACE_PTR(ds_auto_serialize_method, node);

	ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
			  "Method auto-serialization parse [%4.4s] %p\n",
			  acpi_ut_get_node_name(node), node));

	/* Create/Init a root op for the method parse tree */

106
	op = acpi_ps_alloc_op(AML_METHOD_OP, obj_desc->method.aml_start);
107 108 109 110 111 112 113 114 115 116 117 118
	if (!op) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	acpi_ps_set_name(op, node->name.integer);
	op->common.node = node;

	/* Create and initialize a new walk state */

	walk_state =
	    acpi_ds_create_walk_state(node->owner_id, NULL, NULL, NULL);
	if (!walk_state) {
119
		acpi_ps_free_op(op);
120 121 122 123 124 125 126 127 128
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	status =
	    acpi_ds_init_aml_walk(walk_state, op, node,
				  obj_desc->method.aml_start,
				  obj_desc->method.aml_length, NULL, 0);
	if (ACPI_FAILURE(status)) {
		acpi_ds_delete_walk_state(walk_state);
129
		acpi_ps_free_op(op);
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
		return_ACPI_STATUS(status);
	}

	walk_state->descending_callback = acpi_ds_detect_named_opcodes;

	/* Parse the method, scan for creation of named objects */

	status = acpi_ps_parse_aml(walk_state);

	acpi_ps_delete_parse_tree(op);
	return_ACPI_STATUS(status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_detect_named_opcodes
 *
 * PARAMETERS:  walk_state      - Current state of the parse tree walk
 *              out_op          - Unused, required for parser interface
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
 *              Currently used to detect methods that must be marked serialized
 *              in order to avoid problems with the creation of named objects.
 *
 ******************************************************************************/

static acpi_status
acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
			     union acpi_parse_object **out_op)
{

	ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);

165
	/* We are only interested in opcodes that create a new name */
166

167 168 169
	if (!
	    (walk_state->op_info->
	     flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
170 171 172 173 174 175 176
		return (AE_OK);
	}

	/*
	 * At this point, we know we have a Named object opcode.
	 * Mark the method as serialized. Later code will create a mutex for
	 * this method to enforce serialization.
177 178 179 180 181
	 *
	 * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
	 * Sync Level mechanism for this method, even though it is now serialized.
	 * Otherwise, there can be conflicts with existing ASL code that actually
	 * uses sync levels.
182
	 */
183 184 185
	walk_state->method_desc->method.sync_level = 0;
	walk_state->method_desc->method.info_flags |=
	    (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
186 187 188 189 190 191 192 193 194 195 196 197

	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
			  "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
			  walk_state->method_node->name.ascii,
			  walk_state->method_node, walk_state->op_info->name,
			  walk_state->opcode));

	/* Abort the parse, no need to examine this method any further */

	return (AE_CTRL_TERMINATE);
}

B
Bob Moore 已提交
198 199 200 201
/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_method_error
 *
202
 * PARAMETERS:  status          - Execution status
B
Bob Moore 已提交
203 204 205 206 207 208 209 210 211 212
 *              walk_state      - Current state
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Called on method error. Invoke the global exception handler if
 *              present, dump the method data if the disassembler is configured
 *
 *              Note: Allows the exception handler to change the status code
 *
 ******************************************************************************/
B
Bob Moore 已提交
213

B
Bob Moore 已提交
214
acpi_status
215
acpi_ds_method_error(acpi_status status, struct acpi_walk_state * walk_state)
B
Bob Moore 已提交
216
{
217 218
	u32 aml_offset;

B
Bob Moore 已提交
219 220 221 222 223 224 225 226 227 228 229
	ACPI_FUNCTION_ENTRY();

	/* Ignore AE_OK and control exception codes */

	if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
		return (status);
	}

	/* Invoke the global exception handler */

	if (acpi_gbl_exception_handler) {
B
Bob Moore 已提交
230

B
Bob Moore 已提交
231 232 233 234 235 236 237 238
		/* Exit the interpreter, allow handler to execute methods */

		acpi_ex_exit_interpreter();

		/*
		 * Handler can map the exception code to anything it wants, including
		 * AE_OK, in which case the executing method will not be aborted.
		 */
239 240 241 242
		aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
						walk_state->parser_state.
						aml_start);

B
Bob Moore 已提交
243 244 245 246 247
		status = acpi_gbl_exception_handler(status,
						    walk_state->method_node ?
						    walk_state->method_node->
						    name.integer : 0,
						    walk_state->opcode,
248
						    aml_offset, NULL);
249
		acpi_ex_enter_interpreter();
B
Bob Moore 已提交
250
	}
251 252 253

	acpi_ds_clear_implicit_return(walk_state);

B
Bob Moore 已提交
254
	if (ACPI_FAILURE(status)) {
255
		acpi_ds_dump_method_stack(status, walk_state, walk_state->op);
B
Bob Moore 已提交
256

B
Bob Moore 已提交
257 258
		/* Display method locals/args if disassembler is present */

259 260
#ifdef ACPI_DISASSEMBLER
		acpi_dm_dump_method_info(status, walk_state);
B
Bob Moore 已提交
261
#endif
262
	}
B
Bob Moore 已提交
263 264 265 266

	return (status);
}

B
Bob Moore 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_create_method_mutex
 *
 * PARAMETERS:  obj_desc            - The method object
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Create a mutex object for a serialized control method
 *
 ******************************************************************************/

static acpi_status
acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
{
	union acpi_operand_object *mutex_desc;
	acpi_status status;

B
Bob Moore 已提交
285
	ACPI_FUNCTION_TRACE(ds_create_method_mutex);
B
Bob Moore 已提交
286 287 288 289 290 291 292 293 294 295 296 297

	/* Create the new mutex object */

	mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
	if (!mutex_desc) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	/* Create the actual OS Mutex */

	status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
	if (ACPI_FAILURE(status)) {
298
		acpi_ut_delete_object_desc(mutex_desc);
B
Bob Moore 已提交
299 300 301 302 303 304 305 306
		return_ACPI_STATUS(status);
	}

	mutex_desc->mutex.sync_level = method_desc->method.sync_level;
	method_desc->method.mutex = mutex_desc;
	return_ACPI_STATUS(AE_OK);
}

L
Linus Torvalds 已提交
307 308 309 310 311 312
/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_begin_method_execution
 *
 * PARAMETERS:  method_node         - Node of the method
 *              obj_desc            - The method object
B
Bob Moore 已提交
313 314
 *              walk_state          - current state, NULL if not yet executing
 *                                    a method.
L
Linus Torvalds 已提交
315 316 317
 *
 * RETURN:      Status
 *
318
 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
L
Linus Torvalds 已提交
319 320 321 322
 *              increments the thread count, and waits at the method semaphore
 *              for clearance to execute.
 *
 ******************************************************************************/
B
Bob Moore 已提交
323

L
Linus Torvalds 已提交
324
acpi_status
B
Bob Moore 已提交
325 326 327
acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
			       union acpi_operand_object *obj_desc,
			       struct acpi_walk_state *walk_state)
L
Linus Torvalds 已提交
328
{
L
Len Brown 已提交
329
	acpi_status status = AE_OK;
L
Linus Torvalds 已提交
330

B
Bob Moore 已提交
331
	ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
L
Linus Torvalds 已提交
332 333

	if (!method_node) {
L
Len Brown 已提交
334
		return_ACPI_STATUS(AE_NULL_ENTRY);
L
Linus Torvalds 已提交
335 336
	}

337
	acpi_ex_start_trace_method(method_node, obj_desc, walk_state);
338

R
Robert Moore 已提交
339 340 341
	/* Prevent wraparound of thread count */

	if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
B
Bob Moore 已提交
342 343
		ACPI_ERROR((AE_INFO,
			    "Method reached maximum reentrancy limit (255)"));
R
Robert Moore 已提交
344 345 346
		return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
	}

L
Linus Torvalds 已提交
347
	/*
B
Bob Moore 已提交
348
	 * If this method is serialized, we need to acquire the method mutex.
L
Linus Torvalds 已提交
349
	 */
350
	if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
L
Linus Torvalds 已提交
351
		/*
B
Bob Moore 已提交
352 353 354
		 * Create a mutex for the method if it is defined to be Serialized
		 * and a mutex has not already been created. We defer the mutex creation
		 * until a method is actually executed, to minimize the object count
L
Linus Torvalds 已提交
355
		 */
B
Bob Moore 已提交
356 357 358 359
		if (!obj_desc->method.mutex) {
			status = acpi_ds_create_method_mutex(obj_desc);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
360 361 362 363
			}
		}

		/*
B
Bob Moore 已提交
364 365
		 * The current_sync_level (per-thread) must be less than or equal to
		 * the sync level of the method. This mechanism provides some
366 367 368 369 370
		 * deadlock prevention.
		 *
		 * If the method was auto-serialized, we just ignore the sync level
		 * mechanism, because auto-serialization of methods can interfere
		 * with ASL code that actually uses sync levels.
B
Bob Moore 已提交
371 372
		 *
		 * Top-level method invocation has no walk state at this point
L
Linus Torvalds 已提交
373
		 */
B
Bob Moore 已提交
374
		if (walk_state &&
375 376 377 378
		    (!(obj_desc->method.
		       info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
		    && (walk_state->thread->current_sync_level >
			obj_desc->method.mutex->mutex.sync_level)) {
B
Bob Moore 已提交
379
			ACPI_ERROR((AE_INFO,
380
				    "Cannot acquire Mutex for method [%4.4s], current SyncLevel is too large (%u)",
B
Bob Moore 已提交
381 382 383 384
				    acpi_ut_get_node_name(method_node),
				    walk_state->thread->current_sync_level));

			return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
B
Bob Moore 已提交
385
		}
B
Bob Moore 已提交
386 387 388 389 390

		/*
		 * Obtain the method mutex if necessary. Do not acquire mutex for a
		 * recursive call.
		 */
391
		if (!walk_state ||
392 393 394
		    !obj_desc->method.mutex->mutex.thread_id ||
		    (walk_state->thread->thread_id !=
		     obj_desc->method.mutex->mutex.thread_id)) {
B
Bob Moore 已提交
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
			/*
			 * Acquire the method mutex. This releases the interpreter if we
			 * block (and reacquires it before it returns)
			 */
			status =
			    acpi_ex_system_wait_mutex(obj_desc->method.mutex->
						      mutex.os_mutex,
						      ACPI_WAIT_FOREVER);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
			}

			/* Update the mutex and walk info and save the original sync_level */

			if (walk_state) {
				obj_desc->method.mutex->mutex.
				    original_sync_level =
				    walk_state->thread->current_sync_level;

414 415
				obj_desc->method.mutex->mutex.thread_id =
				    walk_state->thread->thread_id;
B
Bob Moore 已提交
416 417 418 419 420 421 422 423 424 425 426 427
				walk_state->thread->current_sync_level =
				    obj_desc->method.sync_level;
			} else {
				obj_desc->method.mutex->mutex.
				    original_sync_level =
				    obj_desc->method.mutex->mutex.sync_level;
			}
		}

		/* Always increase acquisition depth */

		obj_desc->method.mutex->mutex.acquisition_depth++;
L
Linus Torvalds 已提交
428 429
	}

R
Robert Moore 已提交
430 431 432 433 434 435 436 437
	/*
	 * Allocate an Owner ID for this method, only if this is the first thread
	 * to begin concurrent execution. We only need one owner_id, even if the
	 * method is invoked recursively.
	 */
	if (!obj_desc->method.owner_id) {
		status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
		if (ACPI_FAILURE(status)) {
B
Bob Moore 已提交
438
			goto cleanup;
R
Robert Moore 已提交
439 440 441
		}
	}

L
Linus Torvalds 已提交
442 443 444 445 446
	/*
	 * Increment the method parse tree thread count since it has been
	 * reentered one more time (even if it is the same thread)
	 */
	obj_desc->method.thread_count++;
L
Lv Zheng 已提交
447
	acpi_method_count++;
L
Len Brown 已提交
448
	return_ACPI_STATUS(status);
B
Bob Moore 已提交
449

450
cleanup:
B
Bob Moore 已提交
451
	/* On error, must release the method mutex (if present) */
B
Bob Moore 已提交
452

B
Bob Moore 已提交
453 454
	if (obj_desc->method.mutex) {
		acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
B
Bob Moore 已提交
455 456
	}
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
457 458 459 460 461 462
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_call_control_method
 *
463
 * PARAMETERS:  thread              - Info for this thread
L
Linus Torvalds 已提交
464
 *              this_walk_state     - Current walk state
465
 *              op                  - Current Op to be walked
L
Linus Torvalds 已提交
466 467 468 469 470 471 472 473
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Transfer execution to a called control method
 *
 ******************************************************************************/

acpi_status
L
Len Brown 已提交
474 475 476
acpi_ds_call_control_method(struct acpi_thread_state *thread,
			    struct acpi_walk_state *this_walk_state,
			    union acpi_parse_object *op)
L
Linus Torvalds 已提交
477
{
L
Len Brown 已提交
478 479 480 481
	acpi_status status;
	struct acpi_namespace_node *method_node;
	struct acpi_walk_state *next_walk_state = NULL;
	union acpi_operand_object *obj_desc;
B
Bob Moore 已提交
482
	struct acpi_evaluate_info *info;
L
Len Brown 已提交
483
	u32 i;
L
Linus Torvalds 已提交
484

B
Bob Moore 已提交
485
	ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
L
Linus Torvalds 已提交
486

L
Len Brown 已提交
487
	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
488
			  "Calling method %p, currentstate=%p\n",
L
Len Brown 已提交
489
			  this_walk_state->prev_op, this_walk_state));
L
Linus Torvalds 已提交
490 491 492 493 494 495

	/*
	 * Get the namespace entry for the control method we are about to call
	 */
	method_node = this_walk_state->method_call_node;
	if (!method_node) {
L
Len Brown 已提交
496
		return_ACPI_STATUS(AE_NULL_ENTRY);
L
Linus Torvalds 已提交
497 498
	}

L
Len Brown 已提交
499
	obj_desc = acpi_ns_get_attached_object(method_node);
L
Linus Torvalds 已提交
500
	if (!obj_desc) {
L
Len Brown 已提交
501
		return_ACPI_STATUS(AE_NULL_OBJECT);
L
Linus Torvalds 已提交
502 503
	}

B
Bob Moore 已提交
504
	/* Init for new method, possibly wait on method mutex */
L
Linus Torvalds 已提交
505

L
Len Brown 已提交
506
	status = acpi_ds_begin_method_execution(method_node, obj_desc,
B
Bob Moore 已提交
507
						this_walk_state);
L
Len Brown 已提交
508
	if (ACPI_FAILURE(status)) {
B
Bob Moore 已提交
509
		return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
510 511
	}

512
	/* Begin method parse/execution. Create a new walk state */
L
Linus Torvalds 已提交
513

L
Len Brown 已提交
514 515
	next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
						    NULL, obj_desc, thread);
L
Linus Torvalds 已提交
516 517 518 519
	if (!next_walk_state) {
		status = AE_NO_MEMORY;
		goto cleanup;
	}
B
Bob Moore 已提交
520

L
Linus Torvalds 已提交
521 522
	/*
	 * The resolved arguments were put on the previous walk state's operand
R
Robert Moore 已提交
523 524
	 * stack. Operands on the previous walk state stack always
	 * start at index 0. Also, null terminate the list of arguments
L
Linus Torvalds 已提交
525
	 */
L
Len Brown 已提交
526
	this_walk_state->operands[this_walk_state->num_operands] = NULL;
L
Linus Torvalds 已提交
527

B
Bob Moore 已提交
528 529 530 531 532 533 534
	/*
	 * Allocate and initialize the evaluation information block
	 * TBD: this is somewhat inefficient, should change interface to
	 * ds_init_aml_walk. For now, keeps this struct off the CPU stack
	 */
	info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
	if (!info) {
J
Jesper Juhl 已提交
535 536
		status = AE_NO_MEMORY;
		goto cleanup;
B
Bob Moore 已提交
537 538 539
	}

	info->parameters = &this_walk_state->operands[0];
L
Linus Torvalds 已提交
540

L
Len Brown 已提交
541 542
	status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
				       obj_desc->method.aml_start,
543 544
				       obj_desc->method.aml_length, info,
				       ACPI_IMODE_EXECUTE);
B
Bob Moore 已提交
545 546

	ACPI_FREE(info);
L
Len Brown 已提交
547
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
548 549 550 551 552 553 554 555
		goto cleanup;
	}

	/*
	 * Delete the operands on the previous walkstate operand stack
	 * (they were copied to new objects)
	 */
	for (i = 0; i < obj_desc->method.param_count; i++) {
L
Len Brown 已提交
556 557
		acpi_ut_remove_reference(this_walk_state->operands[i]);
		this_walk_state->operands[i] = NULL;
L
Linus Torvalds 已提交
558 559 560 561 562 563
	}

	/* Clear the operand stack */

	this_walk_state->num_operands = 0;

L
Len Brown 已提交
564
	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
565 566
			  "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
			  method_node->name.ascii, next_walk_state));
L
Linus Torvalds 已提交
567

B
Bob Moore 已提交
568 569
	/* Invoke an internal method if necessary */

570 571 572
	if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
		status =
		    obj_desc->method.dispatch.implementation(next_walk_state);
573 574 575
		if (status == AE_OK) {
			status = AE_CTRL_TERMINATE;
		}
L
Linus Torvalds 已提交
576 577
	}

R
Robert Moore 已提交
578
	return_ACPI_STATUS(status);
L
Len Brown 已提交
579

580
cleanup:
L
Len Brown 已提交
581

B
Bob Moore 已提交
582
	/* On error, we must terminate the method properly */
R
Robert Moore 已提交
583

B
Bob Moore 已提交
584 585 586 587
	acpi_ds_terminate_control_method(obj_desc, next_walk_state);
	if (next_walk_state) {
		acpi_ds_delete_walk_state(next_walk_state);
	}
R
Robert Moore 已提交
588

L
Len Brown 已提交
589
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
590 591 592 593 594 595 596 597 598 599 600 601
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_restart_control_method
 *
 * PARAMETERS:  walk_state          - State for preempted method (caller)
 *              return_desc         - Return value from the called method
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Restart a method that was preempted by another (nested) method
602
 *              invocation. Handle the return value (if any) from the callee.
L
Linus Torvalds 已提交
603 604 605 606
 *
 ******************************************************************************/

acpi_status
L
Len Brown 已提交
607 608
acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
			       union acpi_operand_object *return_desc)
L
Linus Torvalds 已提交
609
{
L
Len Brown 已提交
610
	acpi_status status;
B
Bob Moore 已提交
611
	int same_as_implicit_return;
L
Linus Torvalds 已提交
612

B
Bob Moore 已提交
613
	ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
L
Linus Torvalds 已提交
614

L
Len Brown 已提交
615
	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
B
Bob Moore 已提交
616
			  "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
B
Bob Moore 已提交
617
			  acpi_ut_get_node_name(walk_state->method_node),
L
Len Brown 已提交
618
			  walk_state->method_call_op, return_desc));
L
Linus Torvalds 已提交
619

L
Len Brown 已提交
620
	ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
B
Bob Moore 已提交
621
			  "    ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
L
Len Brown 已提交
622 623
			  walk_state->return_used,
			  walk_state->results, walk_state));
L
Linus Torvalds 已提交
624 625 626 627

	/* Did the called method return a value? */

	if (return_desc) {
B
Bob Moore 已提交
628

B
Bob Moore 已提交
629 630 631 632 633
		/* Is the implicit return object the same as the return desc? */

		same_as_implicit_return =
		    (walk_state->implicit_return_obj == return_desc);

L
Linus Torvalds 已提交
634 635 636
		/* Are we actually going to use the return value? */

		if (walk_state->return_used) {
B
Bob Moore 已提交
637

L
Linus Torvalds 已提交
638 639
			/* Save the return value from the previous method */

L
Len Brown 已提交
640 641 642 643
			status = acpi_ds_result_push(return_desc, walk_state);
			if (ACPI_FAILURE(status)) {
				acpi_ut_remove_reference(return_desc);
				return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
644 645 646 647 648 649 650 651 652 653
			}

			/*
			 * Save as THIS method's return value in case it is returned
			 * immediately to yet another method
			 */
			walk_state->return_desc = return_desc;
		}

		/*
B
Bob Moore 已提交
654 655 656 657 658 659 660
		 * The following code is the optional support for the so-called
		 * "implicit return". Some AML code assumes that the last value of the
		 * method is "implicitly" returned to the caller, in the absence of an
		 * explicit return value.
		 *
		 * Just save the last result of the method as the return value.
		 *
L
Linus Torvalds 已提交
661 662 663
		 * NOTE: this is optional because the ASL language does not actually
		 * support this behavior.
		 */
L
Len Brown 已提交
664
		else if (!acpi_ds_do_implicit_return
B
Bob Moore 已提交
665 666
			 (return_desc, walk_state, FALSE)
			 || same_as_implicit_return) {
L
Linus Torvalds 已提交
667 668
			/*
			 * Delete the return value if it will not be used by the
B
Bob Moore 已提交
669 670
			 * calling method or remove one reference if the explicit return
			 * is the same as the implicit return value.
L
Linus Torvalds 已提交
671
			 */
L
Len Brown 已提交
672
			acpi_ut_remove_reference(return_desc);
L
Linus Torvalds 已提交
673 674 675
		}
	}

L
Len Brown 已提交
676
	return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
677 678 679 680 681 682
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ds_terminate_control_method
 *
B
Bob Moore 已提交
683 684
 * PARAMETERS:  method_desc         - Method object
 *              walk_state          - State associated with the method
L
Linus Torvalds 已提交
685
 *
R
Robert Moore 已提交
686
 * RETURN:      None
L
Linus Torvalds 已提交
687
 *
688
 * DESCRIPTION: Terminate a control method. Delete everything that the method
L
Linus Torvalds 已提交
689 690 691
 *              created, delete all locals and arguments, and delete the parse
 *              tree if requested.
 *
B
Bob Moore 已提交
692 693
 * MUTEX:       Interpreter is locked
 *
L
Linus Torvalds 已提交
694 695
 ******************************************************************************/

B
Bob Moore 已提交
696 697 698
void
acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
				 struct acpi_walk_state *walk_state)
L
Linus Torvalds 已提交
699 700
{

B
Bob Moore 已提交
701
	ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
L
Linus Torvalds 已提交
702

B
Bob Moore 已提交
703
	/* method_desc is required, walk_state is optional */
L
Linus Torvalds 已提交
704

B
Bob Moore 已提交
705
	if (!method_desc) {
R
Robert Moore 已提交
706
		return_VOID;
L
Linus Torvalds 已提交
707 708
	}

B
Bob Moore 已提交
709
	if (walk_state) {
L
Linus Torvalds 已提交
710

B
Bob Moore 已提交
711 712 713
		/* Delete all arguments and locals */

		acpi_ds_method_data_delete_all(walk_state);
L
Linus Torvalds 已提交
714

715 716 717 718 719
		/*
		 * If method is serialized, release the mutex and restore the
		 * current sync level for this thread
		 */
		if (method_desc->method.mutex) {
L
Linus Torvalds 已提交
720

721
			/* Acquisition Depth handles recursive calls */
L
Linus Torvalds 已提交
722

723 724 725 726 727
			method_desc->method.mutex->mutex.acquisition_depth--;
			if (!method_desc->method.mutex->mutex.acquisition_depth) {
				walk_state->thread->current_sync_level =
				    method_desc->method.mutex->mutex.
				    original_sync_level;
B
Bob Moore 已提交
728

729 730
				acpi_os_release_mutex(method_desc->method.
						      mutex->mutex.os_mutex);
731
				method_desc->method.mutex->mutex.thread_id = 0;
732
			}
L
Linus Torvalds 已提交
733 734
		}

B
Bob Moore 已提交
735
		/*
736
		 * Delete any namespace objects created anywhere within the
737 738 739 740 741
		 * namespace by the execution of this method. Unless:
		 * 1) This method is a module-level executable code method, in which
		 *    case we want make the objects permanent.
		 * 2) There are other threads executing the method, in which case we
		 *    will wait until the last thread has completed.
B
Bob Moore 已提交
742
		 */
743 744
		if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
		    && (method_desc->method.thread_count == 1)) {
745 746 747 748 749 750 751 752 753

			/* Delete any direct children of (created by) this method */

			acpi_ns_delete_namespace_subtree(walk_state->
							 method_node);

			/*
			 * Delete any objects that were created by this method
			 * elsewhere in the namespace (if any were created).
754 755 756
			 * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
			 * deletion such that we don't have to perform an entire
			 * namespace walk for every control method execution.
757 758
			 */
			if (method_desc->method.
759
			    info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
760 761 762
				acpi_ns_delete_namespace_by_owner(method_desc->
								  method.
								  owner_id);
763 764
				method_desc->method.info_flags &=
				    ~ACPI_METHOD_MODIFIED_NAMESPACE;
765
			}
766
		}
B
Bob Moore 已提交
767 768
	}

B
Bob Moore 已提交
769 770 771 772 773 774 775
	/* Decrement the thread count on the method */

	if (method_desc->method.thread_count) {
		method_desc->method.thread_count--;
	} else {
		ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
	}
B
Bob Moore 已提交
776 777 778

	/* Are there any other threads currently executing this method? */

B
Bob Moore 已提交
779
	if (method_desc->method.thread_count) {
B
Bob Moore 已提交
780 781 782 783
		/*
		 * Additional threads. Do not release the owner_id in this case,
		 * we immediately reuse it for the next thread executing this method
		 */
L
Len Brown 已提交
784
		ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
785
				  "*** Completed execution of one thread, %u threads remaining\n",
B
Bob Moore 已提交
786
				  method_desc->method.thread_count));
B
Bob Moore 已提交
787 788
	} else {
		/* This is the only executing thread for this method */
L
Linus Torvalds 已提交
789 790 791

		/*
		 * Support to dynamically change a method from not_serialized to
B
Bob Moore 已提交
792
		 * Serialized if it appears that the method is incorrectly written and
B
Bob Moore 已提交
793 794
		 * does not support multiple thread execution. The best example of this
		 * is if such a method creates namespace objects and blocks. A second
795
		 * thread will fail with an AE_ALREADY_EXISTS exception.
L
Linus Torvalds 已提交
796 797
		 *
		 * This code is here because we must wait until the last thread exits
798
		 * before marking the method as serialized.
L
Linus Torvalds 已提交
799
		 */
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
		if (method_desc->method.
		    info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
			if (walk_state) {
				ACPI_INFO((AE_INFO,
					   "Marking method %4.4s as Serialized because of AE_ALREADY_EXISTS error",
					   walk_state->method_node->name.
					   ascii));
			}

			/*
			 * Method tried to create an object twice and was marked as
			 * "pending serialized". The probable cause is that the method
			 * cannot handle reentrancy.
			 *
			 * The method was created as not_serialized, but it tried to create
			 * a named object and then blocked, causing the second thread
			 * entrance to begin and then fail. Workaround this problem by
			 * marking the method permanently as Serialized when the last
			 * thread exits here.
			 */
			method_desc->method.info_flags &=
			    ~ACPI_METHOD_SERIALIZED_PENDING;
			method_desc->method.info_flags |=
823 824
			    (ACPI_METHOD_SERIALIZED |
			     ACPI_METHOD_IGNORE_SYNC_LEVEL);
825
			method_desc->method.sync_level = 0;
L
Linus Torvalds 已提交
826 827
		}

B
Bob Moore 已提交
828
		/* No more threads, we can free the owner_id */
L
Linus Torvalds 已提交
829

830 831 832
		if (!
		    (method_desc->method.
		     info_flags & ACPI_METHOD_MODULE_LEVEL)) {
833 834
			acpi_ut_release_owner_id(&method_desc->method.owner_id);
		}
L
Linus Torvalds 已提交
835
	}
L
Len Brown 已提交
836

837 838
	acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc->
				  method.node, method_desc, walk_state);
839

R
Robert Moore 已提交
840
	return_VOID;
L
Linus Torvalds 已提交
841
}