dsmethod.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  1. /******************************************************************************
  2. *
  3. * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2016, Intel Corp.
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #include <acpi/acpi.h>
  43. #include "accommon.h"
  44. #include "acdispat.h"
  45. #include "acinterp.h"
  46. #include "acnamesp.h"
  47. #include "acparser.h"
  48. #include "amlcode.h"
  49. #include "acdebug.h"
  50. #define _COMPONENT ACPI_DISPATCHER
  51. ACPI_MODULE_NAME("dsmethod")
  52. /* Local prototypes */
  53. static acpi_status
  54. acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
  55. union acpi_parse_object **out_op);
  56. static acpi_status
  57. acpi_ds_create_method_mutex(union acpi_operand_object *method_desc);
  58. /*******************************************************************************
  59. *
  60. * FUNCTION: acpi_ds_auto_serialize_method
  61. *
  62. * PARAMETERS: node - Namespace Node of the method
  63. * obj_desc - Method object attached to node
  64. *
  65. * RETURN: Status
  66. *
  67. * DESCRIPTION: Parse a control method AML to scan for control methods that
  68. * need serialization due to the creation of named objects.
  69. *
  70. * NOTE: It is a bit of overkill to mark all such methods serialized, since
  71. * there is only a problem if the method actually blocks during execution.
  72. * A blocking operation is, for example, a Sleep() operation, or any access
  73. * to an operation region. However, it is probably not possible to easily
  74. * detect whether a method will block or not, so we simply mark all suspicious
  75. * methods as serialized.
  76. *
  77. * NOTE2: This code is essentially a generic routine for parsing a single
  78. * control method.
  79. *
  80. ******************************************************************************/
  81. acpi_status
  82. acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
  83. union acpi_operand_object *obj_desc)
  84. {
  85. acpi_status status;
  86. union acpi_parse_object *op = NULL;
  87. struct acpi_walk_state *walk_state;
  88. ACPI_FUNCTION_TRACE_PTR(ds_auto_serialize_method, node);
  89. ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
  90. "Method auto-serialization parse [%4.4s] %p\n",
  91. acpi_ut_get_node_name(node), node));
  92. /* Create/Init a root op for the method parse tree */
  93. op = acpi_ps_alloc_op(AML_METHOD_OP, obj_desc->method.aml_start);
  94. if (!op) {
  95. return_ACPI_STATUS(AE_NO_MEMORY);
  96. }
  97. acpi_ps_set_name(op, node->name.integer);
  98. op->common.node = node;
  99. /* Create and initialize a new walk state */
  100. walk_state =
  101. acpi_ds_create_walk_state(node->owner_id, NULL, NULL, NULL);
  102. if (!walk_state) {
  103. acpi_ps_free_op(op);
  104. return_ACPI_STATUS(AE_NO_MEMORY);
  105. }
  106. status = acpi_ds_init_aml_walk(walk_state, op, node,
  107. obj_desc->method.aml_start,
  108. obj_desc->method.aml_length, NULL, 0);
  109. if (ACPI_FAILURE(status)) {
  110. acpi_ds_delete_walk_state(walk_state);
  111. acpi_ps_free_op(op);
  112. return_ACPI_STATUS(status);
  113. }
  114. walk_state->descending_callback = acpi_ds_detect_named_opcodes;
  115. /* Parse the method, scan for creation of named objects */
  116. status = acpi_ps_parse_aml(walk_state);
  117. acpi_ps_delete_parse_tree(op);
  118. return_ACPI_STATUS(status);
  119. }
  120. /*******************************************************************************
  121. *
  122. * FUNCTION: acpi_ds_detect_named_opcodes
  123. *
  124. * PARAMETERS: walk_state - Current state of the parse tree walk
  125. * out_op - Unused, required for parser interface
  126. *
  127. * RETURN: Status
  128. *
  129. * DESCRIPTION: Descending callback used during the loading of ACPI tables.
  130. * Currently used to detect methods that must be marked serialized
  131. * in order to avoid problems with the creation of named objects.
  132. *
  133. ******************************************************************************/
  134. static acpi_status
  135. acpi_ds_detect_named_opcodes(struct acpi_walk_state *walk_state,
  136. union acpi_parse_object **out_op)
  137. {
  138. ACPI_FUNCTION_NAME(acpi_ds_detect_named_opcodes);
  139. /* We are only interested in opcodes that create a new name */
  140. if (!
  141. (walk_state->op_info->
  142. flags & (AML_NAMED | AML_CREATE | AML_FIELD))) {
  143. return (AE_OK);
  144. }
  145. /*
  146. * At this point, we know we have a Named object opcode.
  147. * Mark the method as serialized. Later code will create a mutex for
  148. * this method to enforce serialization.
  149. *
  150. * Note, ACPI_METHOD_IGNORE_SYNC_LEVEL flag means that we will ignore the
  151. * Sync Level mechanism for this method, even though it is now serialized.
  152. * Otherwise, there can be conflicts with existing ASL code that actually
  153. * uses sync levels.
  154. */
  155. walk_state->method_desc->method.sync_level = 0;
  156. walk_state->method_desc->method.info_flags |=
  157. (ACPI_METHOD_SERIALIZED | ACPI_METHOD_IGNORE_SYNC_LEVEL);
  158. ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  159. "Method serialized [%4.4s] %p - [%s] (%4.4X)\n",
  160. walk_state->method_node->name.ascii,
  161. walk_state->method_node, walk_state->op_info->name,
  162. walk_state->opcode));
  163. /* Abort the parse, no need to examine this method any further */
  164. return (AE_CTRL_TERMINATE);
  165. }
  166. /*******************************************************************************
  167. *
  168. * FUNCTION: acpi_ds_method_error
  169. *
  170. * PARAMETERS: status - Execution status
  171. * walk_state - Current state
  172. *
  173. * RETURN: Status
  174. *
  175. * DESCRIPTION: Called on method error. Invoke the global exception handler if
  176. * present, dump the method data if the debugger is configured
  177. *
  178. * Note: Allows the exception handler to change the status code
  179. *
  180. ******************************************************************************/
  181. acpi_status
  182. acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state)
  183. {
  184. u32 aml_offset;
  185. ACPI_FUNCTION_ENTRY();
  186. /* Ignore AE_OK and control exception codes */
  187. if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
  188. return (status);
  189. }
  190. /* Invoke the global exception handler */
  191. if (acpi_gbl_exception_handler) {
  192. /* Exit the interpreter, allow handler to execute methods */
  193. acpi_ex_exit_interpreter();
  194. /*
  195. * Handler can map the exception code to anything it wants, including
  196. * AE_OK, in which case the executing method will not be aborted.
  197. */
  198. aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
  199. walk_state->parser_state.
  200. aml_start);
  201. status = acpi_gbl_exception_handler(status,
  202. walk_state->method_node ?
  203. walk_state->method_node->
  204. name.integer : 0,
  205. walk_state->opcode,
  206. aml_offset, NULL);
  207. acpi_ex_enter_interpreter();
  208. }
  209. acpi_ds_clear_implicit_return(walk_state);
  210. if (ACPI_FAILURE(status)) {
  211. acpi_ds_dump_method_stack(status, walk_state, walk_state->op);
  212. /* Display method locals/args if debugger is present */
  213. #ifdef ACPI_DEBUGGER
  214. acpi_db_dump_method_info(status, walk_state);
  215. #endif
  216. }
  217. return (status);
  218. }
  219. /*******************************************************************************
  220. *
  221. * FUNCTION: acpi_ds_create_method_mutex
  222. *
  223. * PARAMETERS: obj_desc - The method object
  224. *
  225. * RETURN: Status
  226. *
  227. * DESCRIPTION: Create a mutex object for a serialized control method
  228. *
  229. ******************************************************************************/
  230. static acpi_status
  231. acpi_ds_create_method_mutex(union acpi_operand_object *method_desc)
  232. {
  233. union acpi_operand_object *mutex_desc;
  234. acpi_status status;
  235. ACPI_FUNCTION_TRACE(ds_create_method_mutex);
  236. /* Create the new mutex object */
  237. mutex_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
  238. if (!mutex_desc) {
  239. return_ACPI_STATUS(AE_NO_MEMORY);
  240. }
  241. /* Create the actual OS Mutex */
  242. status = acpi_os_create_mutex(&mutex_desc->mutex.os_mutex);
  243. if (ACPI_FAILURE(status)) {
  244. acpi_ut_delete_object_desc(mutex_desc);
  245. return_ACPI_STATUS(status);
  246. }
  247. mutex_desc->mutex.sync_level = method_desc->method.sync_level;
  248. method_desc->method.mutex = mutex_desc;
  249. return_ACPI_STATUS(AE_OK);
  250. }
  251. /*******************************************************************************
  252. *
  253. * FUNCTION: acpi_ds_begin_method_execution
  254. *
  255. * PARAMETERS: method_node - Node of the method
  256. * obj_desc - The method object
  257. * walk_state - current state, NULL if not yet executing
  258. * a method.
  259. *
  260. * RETURN: Status
  261. *
  262. * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
  263. * increments the thread count, and waits at the method semaphore
  264. * for clearance to execute.
  265. *
  266. ******************************************************************************/
  267. acpi_status
  268. acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
  269. union acpi_operand_object *obj_desc,
  270. struct acpi_walk_state *walk_state)
  271. {
  272. acpi_status status = AE_OK;
  273. ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
  274. if (!method_node) {
  275. return_ACPI_STATUS(AE_NULL_ENTRY);
  276. }
  277. acpi_ex_start_trace_method(method_node, obj_desc, walk_state);
  278. /* Prevent wraparound of thread count */
  279. if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
  280. ACPI_ERROR((AE_INFO,
  281. "Method reached maximum reentrancy limit (255)"));
  282. return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
  283. }
  284. /*
  285. * If this method is serialized, we need to acquire the method mutex.
  286. */
  287. if (obj_desc->method.info_flags & ACPI_METHOD_SERIALIZED) {
  288. /*
  289. * Create a mutex for the method if it is defined to be Serialized
  290. * and a mutex has not already been created. We defer the mutex creation
  291. * until a method is actually executed, to minimize the object count
  292. */
  293. if (!obj_desc->method.mutex) {
  294. status = acpi_ds_create_method_mutex(obj_desc);
  295. if (ACPI_FAILURE(status)) {
  296. return_ACPI_STATUS(status);
  297. }
  298. }
  299. /*
  300. * The current_sync_level (per-thread) must be less than or equal to
  301. * the sync level of the method. This mechanism provides some
  302. * deadlock prevention.
  303. *
  304. * If the method was auto-serialized, we just ignore the sync level
  305. * mechanism, because auto-serialization of methods can interfere
  306. * with ASL code that actually uses sync levels.
  307. *
  308. * Top-level method invocation has no walk state at this point
  309. */
  310. if (walk_state &&
  311. (!(obj_desc->method.
  312. info_flags & ACPI_METHOD_IGNORE_SYNC_LEVEL))
  313. && (walk_state->thread->current_sync_level >
  314. obj_desc->method.mutex->mutex.sync_level)) {
  315. ACPI_ERROR((AE_INFO,
  316. "Cannot acquire Mutex for method [%4.4s]"
  317. ", current SyncLevel is too large (%u)",
  318. acpi_ut_get_node_name(method_node),
  319. walk_state->thread->current_sync_level));
  320. return_ACPI_STATUS(AE_AML_MUTEX_ORDER);
  321. }
  322. /*
  323. * Obtain the method mutex if necessary. Do not acquire mutex for a
  324. * recursive call.
  325. */
  326. if (!walk_state ||
  327. !obj_desc->method.mutex->mutex.thread_id ||
  328. (walk_state->thread->thread_id !=
  329. obj_desc->method.mutex->mutex.thread_id)) {
  330. /*
  331. * Acquire the method mutex. This releases the interpreter if we
  332. * block (and reacquires it before it returns)
  333. */
  334. status =
  335. acpi_ex_system_wait_mutex(obj_desc->method.mutex->
  336. mutex.os_mutex,
  337. ACPI_WAIT_FOREVER);
  338. if (ACPI_FAILURE(status)) {
  339. return_ACPI_STATUS(status);
  340. }
  341. /* Update the mutex and walk info and save the original sync_level */
  342. if (walk_state) {
  343. obj_desc->method.mutex->mutex.
  344. original_sync_level =
  345. walk_state->thread->current_sync_level;
  346. obj_desc->method.mutex->mutex.thread_id =
  347. walk_state->thread->thread_id;
  348. /*
  349. * Update the current sync_level only if this is not an auto-
  350. * serialized method. In the auto case, we have to ignore
  351. * the sync level for the method mutex (created for the
  352. * auto-serialization) because we have no idea of what the
  353. * sync level should be. Therefore, just ignore it.
  354. */
  355. if (!(obj_desc->method.info_flags &
  356. ACPI_METHOD_IGNORE_SYNC_LEVEL)) {
  357. walk_state->thread->current_sync_level =
  358. obj_desc->method.sync_level;
  359. }
  360. } else {
  361. obj_desc->method.mutex->mutex.
  362. original_sync_level =
  363. obj_desc->method.mutex->mutex.sync_level;
  364. obj_desc->method.mutex->mutex.thread_id =
  365. acpi_os_get_thread_id();
  366. }
  367. }
  368. /* Always increase acquisition depth */
  369. obj_desc->method.mutex->mutex.acquisition_depth++;
  370. }
  371. /*
  372. * Allocate an Owner ID for this method, only if this is the first thread
  373. * to begin concurrent execution. We only need one owner_id, even if the
  374. * method is invoked recursively.
  375. */
  376. if (!obj_desc->method.owner_id) {
  377. status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
  378. if (ACPI_FAILURE(status)) {
  379. goto cleanup;
  380. }
  381. }
  382. /*
  383. * Increment the method parse tree thread count since it has been
  384. * reentered one more time (even if it is the same thread)
  385. */
  386. obj_desc->method.thread_count++;
  387. acpi_method_count++;
  388. return_ACPI_STATUS(status);
  389. cleanup:
  390. /* On error, must release the method mutex (if present) */
  391. if (obj_desc->method.mutex) {
  392. acpi_os_release_mutex(obj_desc->method.mutex->mutex.os_mutex);
  393. }
  394. return_ACPI_STATUS(status);
  395. }
  396. /*******************************************************************************
  397. *
  398. * FUNCTION: acpi_ds_call_control_method
  399. *
  400. * PARAMETERS: thread - Info for this thread
  401. * this_walk_state - Current walk state
  402. * op - Current Op to be walked
  403. *
  404. * RETURN: Status
  405. *
  406. * DESCRIPTION: Transfer execution to a called control method
  407. *
  408. ******************************************************************************/
  409. acpi_status
  410. acpi_ds_call_control_method(struct acpi_thread_state *thread,
  411. struct acpi_walk_state *this_walk_state,
  412. union acpi_parse_object *op)
  413. {
  414. acpi_status status;
  415. struct acpi_namespace_node *method_node;
  416. struct acpi_walk_state *next_walk_state = NULL;
  417. union acpi_operand_object *obj_desc;
  418. struct acpi_evaluate_info *info;
  419. u32 i;
  420. ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
  421. ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  422. "Calling method %p, currentstate=%p\n",
  423. this_walk_state->prev_op, this_walk_state));
  424. /*
  425. * Get the namespace entry for the control method we are about to call
  426. */
  427. method_node = this_walk_state->method_call_node;
  428. if (!method_node) {
  429. return_ACPI_STATUS(AE_NULL_ENTRY);
  430. }
  431. obj_desc = acpi_ns_get_attached_object(method_node);
  432. if (!obj_desc) {
  433. return_ACPI_STATUS(AE_NULL_OBJECT);
  434. }
  435. /* Init for new method, possibly wait on method mutex */
  436. status =
  437. acpi_ds_begin_method_execution(method_node, obj_desc,
  438. this_walk_state);
  439. if (ACPI_FAILURE(status)) {
  440. return_ACPI_STATUS(status);
  441. }
  442. /* Begin method parse/execution. Create a new walk state */
  443. next_walk_state =
  444. acpi_ds_create_walk_state(obj_desc->method.owner_id, NULL, obj_desc,
  445. thread);
  446. if (!next_walk_state) {
  447. status = AE_NO_MEMORY;
  448. goto cleanup;
  449. }
  450. /*
  451. * The resolved arguments were put on the previous walk state's operand
  452. * stack. Operands on the previous walk state stack always
  453. * start at index 0. Also, null terminate the list of arguments
  454. */
  455. this_walk_state->operands[this_walk_state->num_operands] = NULL;
  456. /*
  457. * Allocate and initialize the evaluation information block
  458. * TBD: this is somewhat inefficient, should change interface to
  459. * ds_init_aml_walk. For now, keeps this struct off the CPU stack
  460. */
  461. info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
  462. if (!info) {
  463. status = AE_NO_MEMORY;
  464. goto cleanup;
  465. }
  466. info->parameters = &this_walk_state->operands[0];
  467. status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
  468. obj_desc->method.aml_start,
  469. obj_desc->method.aml_length, info,
  470. ACPI_IMODE_EXECUTE);
  471. ACPI_FREE(info);
  472. if (ACPI_FAILURE(status)) {
  473. goto cleanup;
  474. }
  475. /*
  476. * Delete the operands on the previous walkstate operand stack
  477. * (they were copied to new objects)
  478. */
  479. for (i = 0; i < obj_desc->method.param_count; i++) {
  480. acpi_ut_remove_reference(this_walk_state->operands[i]);
  481. this_walk_state->operands[i] = NULL;
  482. }
  483. /* Clear the operand stack */
  484. this_walk_state->num_operands = 0;
  485. ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  486. "**** Begin nested execution of [%4.4s] **** WalkState=%p\n",
  487. method_node->name.ascii, next_walk_state));
  488. /* Invoke an internal method if necessary */
  489. if (obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
  490. status =
  491. obj_desc->method.dispatch.implementation(next_walk_state);
  492. if (status == AE_OK) {
  493. status = AE_CTRL_TERMINATE;
  494. }
  495. }
  496. return_ACPI_STATUS(status);
  497. cleanup:
  498. /* On error, we must terminate the method properly */
  499. acpi_ds_terminate_control_method(obj_desc, next_walk_state);
  500. acpi_ds_delete_walk_state(next_walk_state);
  501. return_ACPI_STATUS(status);
  502. }
  503. /*******************************************************************************
  504. *
  505. * FUNCTION: acpi_ds_restart_control_method
  506. *
  507. * PARAMETERS: walk_state - State for preempted method (caller)
  508. * return_desc - Return value from the called method
  509. *
  510. * RETURN: Status
  511. *
  512. * DESCRIPTION: Restart a method that was preempted by another (nested) method
  513. * invocation. Handle the return value (if any) from the callee.
  514. *
  515. ******************************************************************************/
  516. acpi_status
  517. acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
  518. union acpi_operand_object *return_desc)
  519. {
  520. acpi_status status;
  521. int same_as_implicit_return;
  522. ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
  523. ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  524. "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
  525. acpi_ut_get_node_name(walk_state->method_node),
  526. walk_state->method_call_op, return_desc));
  527. ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  528. " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
  529. walk_state->return_used,
  530. walk_state->results, walk_state));
  531. /* Did the called method return a value? */
  532. if (return_desc) {
  533. /* Is the implicit return object the same as the return desc? */
  534. same_as_implicit_return =
  535. (walk_state->implicit_return_obj == return_desc);
  536. /* Are we actually going to use the return value? */
  537. if (walk_state->return_used) {
  538. /* Save the return value from the previous method */
  539. status = acpi_ds_result_push(return_desc, walk_state);
  540. if (ACPI_FAILURE(status)) {
  541. acpi_ut_remove_reference(return_desc);
  542. return_ACPI_STATUS(status);
  543. }
  544. /*
  545. * Save as THIS method's return value in case it is returned
  546. * immediately to yet another method
  547. */
  548. walk_state->return_desc = return_desc;
  549. }
  550. /*
  551. * The following code is the optional support for the so-called
  552. * "implicit return". Some AML code assumes that the last value of the
  553. * method is "implicitly" returned to the caller, in the absence of an
  554. * explicit return value.
  555. *
  556. * Just save the last result of the method as the return value.
  557. *
  558. * NOTE: this is optional because the ASL language does not actually
  559. * support this behavior.
  560. */
  561. else if (!acpi_ds_do_implicit_return
  562. (return_desc, walk_state, FALSE)
  563. || same_as_implicit_return) {
  564. /*
  565. * Delete the return value if it will not be used by the
  566. * calling method or remove one reference if the explicit return
  567. * is the same as the implicit return value.
  568. */
  569. acpi_ut_remove_reference(return_desc);
  570. }
  571. }
  572. return_ACPI_STATUS(AE_OK);
  573. }
  574. /*******************************************************************************
  575. *
  576. * FUNCTION: acpi_ds_terminate_control_method
  577. *
  578. * PARAMETERS: method_desc - Method object
  579. * walk_state - State associated with the method
  580. *
  581. * RETURN: None
  582. *
  583. * DESCRIPTION: Terminate a control method. Delete everything that the method
  584. * created, delete all locals and arguments, and delete the parse
  585. * tree if requested.
  586. *
  587. * MUTEX: Interpreter is locked
  588. *
  589. ******************************************************************************/
  590. void
  591. acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
  592. struct acpi_walk_state *walk_state)
  593. {
  594. ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
  595. /* method_desc is required, walk_state is optional */
  596. if (!method_desc) {
  597. return_VOID;
  598. }
  599. if (walk_state) {
  600. /* Delete all arguments and locals */
  601. acpi_ds_method_data_delete_all(walk_state);
  602. /*
  603. * Delete any namespace objects created anywhere within the
  604. * namespace by the execution of this method. Unless:
  605. * 1) This method is a module-level executable code method, in which
  606. * case we want make the objects permanent.
  607. * 2) There are other threads executing the method, in which case we
  608. * will wait until the last thread has completed.
  609. */
  610. if (!(method_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL)
  611. && (method_desc->method.thread_count == 1)) {
  612. /* Delete any direct children of (created by) this method */
  613. (void)acpi_ex_exit_interpreter();
  614. acpi_ns_delete_namespace_subtree(walk_state->
  615. method_node);
  616. (void)acpi_ex_enter_interpreter();
  617. /*
  618. * Delete any objects that were created by this method
  619. * elsewhere in the namespace (if any were created).
  620. * Use of the ACPI_METHOD_MODIFIED_NAMESPACE optimizes the
  621. * deletion such that we don't have to perform an entire
  622. * namespace walk for every control method execution.
  623. */
  624. if (method_desc->method.
  625. info_flags & ACPI_METHOD_MODIFIED_NAMESPACE) {
  626. (void)acpi_ex_exit_interpreter();
  627. acpi_ns_delete_namespace_by_owner(method_desc->
  628. method.
  629. owner_id);
  630. (void)acpi_ex_enter_interpreter();
  631. method_desc->method.info_flags &=
  632. ~ACPI_METHOD_MODIFIED_NAMESPACE;
  633. }
  634. }
  635. /*
  636. * If method is serialized, release the mutex and restore the
  637. * current sync level for this thread
  638. */
  639. if (method_desc->method.mutex) {
  640. /* Acquisition Depth handles recursive calls */
  641. method_desc->method.mutex->mutex.acquisition_depth--;
  642. if (!method_desc->method.mutex->mutex.acquisition_depth) {
  643. walk_state->thread->current_sync_level =
  644. method_desc->method.mutex->mutex.
  645. original_sync_level;
  646. acpi_os_release_mutex(method_desc->method.
  647. mutex->mutex.os_mutex);
  648. method_desc->method.mutex->mutex.thread_id = 0;
  649. }
  650. }
  651. }
  652. /* Decrement the thread count on the method */
  653. if (method_desc->method.thread_count) {
  654. method_desc->method.thread_count--;
  655. } else {
  656. ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
  657. }
  658. /* Are there any other threads currently executing this method? */
  659. if (method_desc->method.thread_count) {
  660. /*
  661. * Additional threads. Do not release the owner_id in this case,
  662. * we immediately reuse it for the next thread executing this method
  663. */
  664. ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  665. "*** Completed execution of one thread, %u threads remaining\n",
  666. method_desc->method.thread_count));
  667. } else {
  668. /* This is the only executing thread for this method */
  669. /*
  670. * Support to dynamically change a method from not_serialized to
  671. * Serialized if it appears that the method is incorrectly written and
  672. * does not support multiple thread execution. The best example of this
  673. * is if such a method creates namespace objects and blocks. A second
  674. * thread will fail with an AE_ALREADY_EXISTS exception.
  675. *
  676. * This code is here because we must wait until the last thread exits
  677. * before marking the method as serialized.
  678. */
  679. if (method_desc->method.
  680. info_flags & ACPI_METHOD_SERIALIZED_PENDING) {
  681. if (walk_state) {
  682. ACPI_INFO(("Marking method %4.4s as Serialized "
  683. "because of AE_ALREADY_EXISTS error",
  684. walk_state->method_node->name.
  685. ascii));
  686. }
  687. /*
  688. * Method tried to create an object twice and was marked as
  689. * "pending serialized". The probable cause is that the method
  690. * cannot handle reentrancy.
  691. *
  692. * The method was created as not_serialized, but it tried to create
  693. * a named object and then blocked, causing the second thread
  694. * entrance to begin and then fail. Workaround this problem by
  695. * marking the method permanently as Serialized when the last
  696. * thread exits here.
  697. */
  698. method_desc->method.info_flags &=
  699. ~ACPI_METHOD_SERIALIZED_PENDING;
  700. method_desc->method.info_flags |=
  701. (ACPI_METHOD_SERIALIZED |
  702. ACPI_METHOD_IGNORE_SYNC_LEVEL);
  703. method_desc->method.sync_level = 0;
  704. }
  705. /* No more threads, we can free the owner_id */
  706. if (!
  707. (method_desc->method.
  708. info_flags & ACPI_METHOD_MODULE_LEVEL)) {
  709. acpi_ut_release_owner_id(&method_desc->method.owner_id);
  710. }
  711. }
  712. acpi_ex_stop_trace_method((struct acpi_namespace_node *)method_desc->
  713. method.node, method_desc, walk_state);
  714. return_VOID;
  715. }