drivers/acpi/acpica/dsmethod.c

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