1 /*******************************************************************************
3 * Module Name: dsmthdat - control method arguments and local variables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acdispat.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acinterp.h>
52 #define _COMPONENT ACPI_DISPATCHER
53 ACPI_MODULE_NAME ("dsmthdat")
56 /*******************************************************************************
58 * FUNCTION: acpi_ds_method_data_init
60 * PARAMETERS: walk_state - Current walk state object
64 * DESCRIPTION: Initialize the data structures that hold the method's arguments
65 * and locals. The data struct is an array of NTEs for each.
66 * This allows ref_of and de_ref_of to work properly for these
69 * NOTES: walk_state fields are initialized to zero by the
70 * ACPI_MEM_CALLOCATE().
72 * A pseudo-Namespace Node is assigned to each argument and local
73 * so that ref_of() can return a pointer to the Node.
75 ******************************************************************************/
78 acpi_ds_method_data_init (
79 struct acpi_walk_state *walk_state)
84 ACPI_FUNCTION_TRACE ("ds_method_data_init");
87 /* Init the method arguments */
89 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
90 ACPI_MOVE_32_TO_32 (&walk_state->arguments[i].name,
92 walk_state->arguments[i].name.integer |= (i << 24);
93 walk_state->arguments[i].descriptor = ACPI_DESC_TYPE_NAMED;
94 walk_state->arguments[i].type = ACPI_TYPE_ANY;
95 walk_state->arguments[i].flags = ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_ARG;
98 /* Init the method locals */
100 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
101 ACPI_MOVE_32_TO_32 (&walk_state->local_variables[i].name,
104 walk_state->local_variables[i].name.integer |= (i << 24);
105 walk_state->local_variables[i].descriptor = ACPI_DESC_TYPE_NAMED;
106 walk_state->local_variables[i].type = ACPI_TYPE_ANY;
107 walk_state->local_variables[i].flags = ANOBJ_END_OF_PEER_LIST | ANOBJ_METHOD_LOCAL;
114 /*******************************************************************************
116 * FUNCTION: acpi_ds_method_data_delete_all
118 * PARAMETERS: walk_state - Current walk state object
122 * DESCRIPTION: Delete method locals and arguments. Arguments are only
123 * deleted if this method was called from another method.
125 ******************************************************************************/
128 acpi_ds_method_data_delete_all (
129 struct acpi_walk_state *walk_state)
134 ACPI_FUNCTION_TRACE ("ds_method_data_delete_all");
137 /* Detach the locals */
139 for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
140 if (walk_state->local_variables[index].object) {
141 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Deleting Local%d=%p\n",
142 index, walk_state->local_variables[index].object));
144 /* Detach object (if present) and remove a reference */
146 acpi_ns_detach_object (&walk_state->local_variables[index]);
150 /* Detach the arguments */
152 for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
153 if (walk_state->arguments[index].object) {
154 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Deleting Arg%d=%p\n",
155 index, walk_state->arguments[index].object));
157 /* Detach object (if present) and remove a reference */
159 acpi_ns_detach_object (&walk_state->arguments[index]);
167 /*******************************************************************************
169 * FUNCTION: acpi_ds_method_data_init_args
171 * PARAMETERS: *Params - Pointer to a parameter list for the method
172 * max_param_count - The arg count for this method
173 * walk_state - Current walk state object
177 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
178 * of ACPI operand objects, either null terminated or whose length
179 * is defined by max_param_count.
181 ******************************************************************************/
184 acpi_ds_method_data_init_args (
185 union acpi_operand_object **params,
187 struct acpi_walk_state *walk_state)
193 ACPI_FUNCTION_TRACE_PTR ("ds_method_data_init_args", params);
197 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "No param list passed to method\n"));
198 return_ACPI_STATUS (AE_OK);
201 /* Copy passed parameters into the new method stack frame */
203 while ((index < ACPI_METHOD_NUM_ARGS) && (index < max_param_count) && params[index]) {
206 * Store the argument in the method/walk descriptor.
207 * Do not copy the arg in order to implement call by reference
209 status = acpi_ds_method_data_set_value (AML_ARG_OP, index, params[index], walk_state);
210 if (ACPI_FAILURE (status)) {
211 return_ACPI_STATUS (status);
217 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%d args passed to method\n", index));
218 return_ACPI_STATUS (AE_OK);
222 /*******************************************************************************
224 * FUNCTION: acpi_ds_method_data_get_node
226 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
227 * Index - which local_var or argument whose type
229 * walk_state - Current walk state object
231 * RETURN: Get the Node associated with a local or arg.
233 ******************************************************************************/
236 acpi_ds_method_data_get_node (
239 struct acpi_walk_state *walk_state,
240 struct acpi_namespace_node **node)
242 ACPI_FUNCTION_TRACE ("ds_method_data_get_node");
246 * Method Locals and Arguments are supported
251 if (index > ACPI_METHOD_MAX_LOCAL) {
252 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Local index %d is invalid (max %d)\n",
253 index, ACPI_METHOD_MAX_LOCAL));
254 return_ACPI_STATUS (AE_AML_INVALID_INDEX);
257 /* Return a pointer to the pseudo-node */
259 *node = &walk_state->local_variables[index];
264 if (index > ACPI_METHOD_MAX_ARG) {
265 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Arg index %d is invalid (max %d)\n",
266 index, ACPI_METHOD_MAX_ARG));
267 return_ACPI_STATUS (AE_AML_INVALID_INDEX);
270 /* Return a pointer to the pseudo-node */
272 *node = &walk_state->arguments[index];
276 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Opcode %d is invalid\n", opcode));
277 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
280 return_ACPI_STATUS (AE_OK);
284 /*******************************************************************************
286 * FUNCTION: acpi_ds_method_data_set_value
288 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
289 * Index - which local_var or argument to get
290 * Object - Object to be inserted into the stack entry
291 * walk_state - Current walk state object
295 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
296 * Note: There is no "implicit conversion" for locals.
298 ******************************************************************************/
301 acpi_ds_method_data_set_value (
304 union acpi_operand_object *object,
305 struct acpi_walk_state *walk_state)
308 struct acpi_namespace_node *node;
311 ACPI_FUNCTION_TRACE ("ds_method_data_set_value");
314 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
315 "new_obj %p Opcode %X, Refs=%d [%s]\n", object,
316 opcode, object->common.reference_count,
317 acpi_ut_get_type_name (object->common.type)));
319 /* Get the namespace node for the arg/local */
321 status = acpi_ds_method_data_get_node (opcode, index, walk_state, &node);
322 if (ACPI_FAILURE (status)) {
323 return_ACPI_STATUS (status);
327 * Increment ref count so object can't be deleted while installed.
328 * NOTE: We do not copy the object in order to preserve the call by
329 * reference semantics of ACPI Control Method invocation.
330 * (See ACPI specification 2.0_c)
332 acpi_ut_add_reference (object);
334 /* Install the object */
336 node->object = object;
337 return_ACPI_STATUS (status);
341 /*******************************************************************************
343 * FUNCTION: acpi_ds_method_data_get_type
345 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
346 * Index - which local_var or argument whose type
348 * walk_state - Current walk state object
350 * RETURN: Data type of current value of the selected Arg or Local
352 ******************************************************************************/
353 #ifdef ACPI_FUTURE_USAGE
355 acpi_ds_method_data_get_type (
358 struct acpi_walk_state *walk_state)
361 struct acpi_namespace_node *node;
362 union acpi_operand_object *object;
365 ACPI_FUNCTION_TRACE ("ds_method_data_get_type");
368 /* Get the namespace node for the arg/local */
370 status = acpi_ds_method_data_get_node (opcode, index, walk_state, &node);
371 if (ACPI_FAILURE (status)) {
372 return_VALUE ((ACPI_TYPE_NOT_FOUND));
377 object = acpi_ns_get_attached_object (node);
379 /* Uninitialized local/arg, return TYPE_ANY */
381 return_VALUE (ACPI_TYPE_ANY);
384 /* Get the object type */
386 return_VALUE (ACPI_GET_OBJECT_TYPE (object));
388 #endif /* ACPI_FUTURE_USAGE */
391 /*******************************************************************************
393 * FUNCTION: acpi_ds_method_data_get_value
395 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
396 * Index - which local_var or argument to get
397 * walk_state - Current walk state object
398 * *dest_desc - Ptr to Descriptor into which selected Arg
399 * or Local value should be copied
403 * DESCRIPTION: Retrieve value of selected Arg or Local from the method frame
404 * at the current top of the method stack.
405 * Used only in acpi_ex_resolve_to_value().
407 ******************************************************************************/
410 acpi_ds_method_data_get_value (
413 struct acpi_walk_state *walk_state,
414 union acpi_operand_object **dest_desc)
417 struct acpi_namespace_node *node;
418 union acpi_operand_object *object;
421 ACPI_FUNCTION_TRACE ("ds_method_data_get_value");
424 /* Validate the object descriptor */
427 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null object descriptor pointer\n"));
428 return_ACPI_STATUS (AE_BAD_PARAMETER);
431 /* Get the namespace node for the arg/local */
433 status = acpi_ds_method_data_get_node (opcode, index, walk_state, &node);
434 if (ACPI_FAILURE (status)) {
435 return_ACPI_STATUS (status);
438 /* Get the object from the node */
440 object = node->object;
442 /* Examine the returned object, it must be valid. */
446 * Index points to uninitialized object.
447 * This means that either 1) The expected argument was
448 * not passed to the method, or 2) A local variable
449 * was referenced by the method (via the ASL)
450 * before it was initialized. Either case is an error.
453 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
455 if (acpi_gbl_enable_interpreter_slack) {
456 object = acpi_ut_create_internal_object (ACPI_TYPE_INTEGER);
458 return_ACPI_STATUS (AE_NO_MEMORY);
461 object->integer.value = 0;
462 node->object = object;
465 /* Otherwise, return the error */
467 else switch (opcode) {
470 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Uninitialized Arg[%d] at node %p\n",
473 return_ACPI_STATUS (AE_AML_UNINITIALIZED_ARG);
477 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Uninitialized Local[%d] at node %p\n",
480 return_ACPI_STATUS (AE_AML_UNINITIALIZED_LOCAL);
483 ACPI_REPORT_ERROR (("Not Arg/Local opcode: %X\n", opcode));
484 return_ACPI_STATUS (AE_AML_INTERNAL);
489 * The Index points to an initialized and valid object.
490 * Return an additional reference to the object
493 acpi_ut_add_reference (object);
495 return_ACPI_STATUS (AE_OK);
499 /*******************************************************************************
501 * FUNCTION: acpi_ds_method_data_delete_value
503 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
504 * Index - which local_var or argument to delete
505 * walk_state - Current walk state object
509 * DESCRIPTION: Delete the entry at Opcode:Index on the method stack. Inserts
510 * a null into the stack slot after the object is deleted.
512 ******************************************************************************/
515 acpi_ds_method_data_delete_value (
518 struct acpi_walk_state *walk_state)
521 struct acpi_namespace_node *node;
522 union acpi_operand_object *object;
525 ACPI_FUNCTION_TRACE ("ds_method_data_delete_value");
528 /* Get the namespace node for the arg/local */
530 status = acpi_ds_method_data_get_node (opcode, index, walk_state, &node);
531 if (ACPI_FAILURE (status)) {
535 /* Get the associated object */
537 object = acpi_ns_get_attached_object (node);
540 * Undefine the Arg or Local by setting its descriptor
541 * pointer to NULL. Locals/Args can contain both
542 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
547 (ACPI_GET_DESCRIPTOR_TYPE (object) == ACPI_DESC_TYPE_OPERAND)) {
549 * There is a valid object.
550 * Decrement the reference count by one to balance the
551 * increment when the object was stored.
553 acpi_ut_remove_reference (object);
560 /*******************************************************************************
562 * FUNCTION: acpi_ds_store_object_to_local
564 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
565 * Index - which local_var or argument to set
566 * obj_desc - Value to be stored
567 * walk_state - Current walk state
571 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
572 * as the new value for the Arg or Local and the reference count
573 * for obj_desc is incremented.
575 ******************************************************************************/
578 acpi_ds_store_object_to_local (
581 union acpi_operand_object *obj_desc,
582 struct acpi_walk_state *walk_state)
585 struct acpi_namespace_node *node;
586 union acpi_operand_object *current_obj_desc;
587 union acpi_operand_object *new_obj_desc;
590 ACPI_FUNCTION_TRACE ("ds_store_object_to_local");
591 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Opcode=%X Index=%d Obj=%p\n",
592 opcode, index, obj_desc));
594 /* Parameter validation */
597 return_ACPI_STATUS (AE_BAD_PARAMETER);
600 /* Get the namespace node for the arg/local */
602 status = acpi_ds_method_data_get_node (opcode, index, walk_state, &node);
603 if (ACPI_FAILURE (status)) {
604 return_ACPI_STATUS (status);
607 current_obj_desc = acpi_ns_get_attached_object (node);
608 if (current_obj_desc == obj_desc) {
609 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj=%p already installed!\n",
611 return_ACPI_STATUS (status);
615 * If the reference count on the object is more than one, we must
616 * take a copy of the object before we store. A reference count
617 * of exactly 1 means that the object was just created during the
618 * evaluation of an expression, and we can safely use it since it
619 * is not used anywhere else.
621 new_obj_desc = obj_desc;
622 if (obj_desc->common.reference_count > 1) {
623 status = acpi_ut_copy_iobject_to_iobject (obj_desc, &new_obj_desc, walk_state);
624 if (ACPI_FAILURE (status)) {
625 return_ACPI_STATUS (status);
630 * If there is an object already in this slot, we either
631 * have to delete it, or if this is an argument and there
632 * is an object reference stored there, we have to do
635 if (current_obj_desc) {
637 * Check for an indirect store if an argument
638 * contains an object reference (stored as an Node).
639 * We don't allow this automatic dereferencing for
640 * locals, since a store to a local should overwrite
641 * anything there, including an object reference.
643 * If both Arg0 and Local0 contain ref_of (Local4):
645 * Store (1, Arg0) - Causes indirect store to local4
646 * Store (1, Local0) - Stores 1 in local0, overwriting
647 * the reference to local4
648 * Store (1, de_refof (Local0)) - Causes indirect store to local4
652 if (opcode == AML_ARG_OP) {
654 * Make sure that the object is the correct type. This may be overkill, but
655 * it is here because references were NS nodes in the past. Now they are
656 * operand objects of type Reference.
658 if (ACPI_GET_DESCRIPTOR_TYPE (current_obj_desc) != ACPI_DESC_TYPE_OPERAND) {
659 ACPI_REPORT_ERROR (("Invalid descriptor type while storing to method arg: [%s]\n",
660 acpi_ut_get_descriptor_name (current_obj_desc)));
661 return_ACPI_STATUS (AE_AML_INTERNAL);
665 * If we have a valid reference object that came from ref_of(), do the
668 if ((current_obj_desc->common.type == ACPI_TYPE_LOCAL_REFERENCE) &&
669 (current_obj_desc->reference.opcode == AML_REF_OF_OP)) {
670 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
671 "Arg (%p) is an obj_ref(Node), storing in node %p\n",
672 new_obj_desc, current_obj_desc));
675 * Store this object to the Node (perform the indirect store)
676 * NOTE: No implicit conversion is performed, as per the ACPI
677 * specification rules on storing to Locals/Args.
679 status = acpi_ex_store_object_to_node (new_obj_desc,
680 current_obj_desc->reference.object, walk_state,
681 ACPI_NO_IMPLICIT_CONVERSION);
683 /* Remove local reference if we copied the object above */
685 if (new_obj_desc != obj_desc) {
686 acpi_ut_remove_reference (new_obj_desc);
688 return_ACPI_STATUS (status);
693 * Delete the existing object
694 * before storing the new one
696 acpi_ds_method_data_delete_value (opcode, index, walk_state);
700 * Install the Obj descriptor (*new_obj_desc) into
701 * the descriptor for the Arg or Local.
702 * (increments the object reference count by one)
704 status = acpi_ds_method_data_set_value (opcode, index, new_obj_desc, walk_state);
706 /* Remove local reference if we copied the object above */
708 if (new_obj_desc != obj_desc) {
709 acpi_ut_remove_reference (new_obj_desc);
712 return_ACPI_STATUS (status);