blob: 8d1b754005158ff0d90329c80e908bebd473a142 [file] [log] [blame]
Erik Schmauss95857632018-03-14 16:13:07 -07001// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*******************************************************************************
3 *
4 * Module Name: dsutils - Dispatcher utilities
5 *
6 ******************************************************************************/
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -05009#include "accommon.h"
10#include "acparser.h"
11#include "amlcode.h"
12#include "acdispat.h"
13#include "acinterp.h"
14#include "acnamesp.h"
15#include "acdebug.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17#define _COMPONENT ACPI_DISPATCHER
Len Brown4be44fc2005-08-05 00:44:28 -040018ACPI_MODULE_NAME("dsutils")
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/*******************************************************************************
21 *
22 * FUNCTION: acpi_ds_clear_implicit_return
23 *
24 * PARAMETERS: walk_state - Current State
25 *
26 * RETURN: None.
27 *
Bob Moore73a30902012-10-31 02:26:55 +000028 * DESCRIPTION: Clear and remove a reference on an implicit return value. Used
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * to delete "stale" return values (if enabled, the return value
30 * from every operator is saved at least momentarily, in case the
31 * parent method exits.)
32 *
33 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -040034void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -070035{
Bob Mooreb229cf92006-04-21 17:15:00 -040036 ACPI_FUNCTION_NAME(ds_clear_implicit_return);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38 /*
39 * Slack must be enabled for this feature
40 */
41 if (!acpi_gbl_enable_interpreter_slack) {
42 return;
43 }
44
45 if (walk_state->implicit_return_obj) {
46 /*
47 * Delete any "stale" implicit return. However, in
48 * complex statements, the implicit return value can be
49 * bubbled up several levels.
50 */
Len Brown4be44fc2005-08-05 00:44:28 -040051 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
52 "Removing reference on stale implicit return obj %p\n",
53 walk_state->implicit_return_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Len Brown4be44fc2005-08-05 00:44:28 -040055 acpi_ut_remove_reference(walk_state->implicit_return_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 walk_state->implicit_return_obj = NULL;
57 }
58}
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#ifndef ACPI_NO_METHOD_EXECUTION
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*******************************************************************************
62 *
63 * FUNCTION: acpi_ds_do_implicit_return
64 *
65 * PARAMETERS: return_desc - The return value
66 * walk_state - Current State
67 * add_reference - True if a reference should be added to the
68 * return object
69 *
70 * RETURN: TRUE if implicit return enabled, FALSE otherwise
71 *
72 * DESCRIPTION: Implements the optional "implicit return". We save the result
73 * of every ASL operator and control method invocation in case the
Bob Moore73a30902012-10-31 02:26:55 +000074 * parent method exit. Before storing a new return value, we
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * delete the previous return value.
76 *
77 ******************************************************************************/
78
79u8
Len Brown4be44fc2005-08-05 00:44:28 -040080acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
81 struct acpi_walk_state *walk_state, u8 add_reference)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
Bob Mooreb229cf92006-04-21 17:15:00 -040083 ACPI_FUNCTION_NAME(ds_do_implicit_return);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 /*
86 * Slack must be enabled for this feature, and we must
87 * have a valid return object
88 */
Len Brown4be44fc2005-08-05 00:44:28 -040089 if ((!acpi_gbl_enable_interpreter_slack) || (!return_desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 return (FALSE);
91 }
92
Len Brown4be44fc2005-08-05 00:44:28 -040093 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
94 "Result %p will be implicitly returned; Prev=%p\n",
95 return_desc, walk_state->implicit_return_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97 /*
98 * Delete any "stale" implicit return value first. However, in
99 * complex statements, the implicit return value can be
100 * bubbled up several levels, so we don't clear the value if it
101 * is the same as the return_desc.
102 */
103 if (walk_state->implicit_return_obj) {
104 if (walk_state->implicit_return_obj == return_desc) {
105 return (TRUE);
106 }
Len Brown4be44fc2005-08-05 00:44:28 -0400107 acpi_ds_clear_implicit_return(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 }
109
110 /* Save the implicit return value, add a reference if requested */
111
112 walk_state->implicit_return_obj = return_desc;
113 if (add_reference) {
Len Brown4be44fc2005-08-05 00:44:28 -0400114 acpi_ut_add_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 }
116
117 return (TRUE);
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*******************************************************************************
121 *
122 * FUNCTION: acpi_ds_is_result_used
123 *
Bob Mooreba494be2012-07-12 09:40:10 +0800124 * PARAMETERS: op - Current Op
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 * walk_state - Current State
126 *
127 * RETURN: TRUE if result is used, FALSE otherwise
128 *
129 * DESCRIPTION: Check if a result object will be used by the parent
130 *
131 ******************************************************************************/
132
133u8
Len Brown4be44fc2005-08-05 00:44:28 -0400134acpi_ds_is_result_used(union acpi_parse_object * op,
135 struct acpi_walk_state * walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136{
Len Brown4be44fc2005-08-05 00:44:28 -0400137 const struct acpi_opcode_info *parent_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Bob Mooreb229cf92006-04-21 17:15:00 -0400139 ACPI_FUNCTION_TRACE_PTR(ds_is_result_used, op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141 /* Must have both an Op and a Result Object */
142
143 if (!op) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500144 ACPI_ERROR((AE_INFO, "Null Op"));
Bob Moorefd1af712013-03-08 09:22:23 +0000145 return_UINT8(TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 }
147
148 /*
149 * We know that this operator is not a
150 * Return() operator (would not come here.) The following code is the
151 * optional support for a so-called "implicit return". Some AML code
152 * assumes that the last value of the method is "implicitly" returned
153 * to the caller. Just save the last result as the return value.
154 * NOTE: this is optional because the ASL language does not actually
155 * support this behavior.
156 */
Len Brown4be44fc2005-08-05 00:44:28 -0400157 (void)acpi_ds_do_implicit_return(walk_state->result_obj, walk_state,
158 TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160 /*
161 * Now determine if the parent will use the result
162 *
163 * If there is no parent, or the parent is a scope_op, we are executing
164 * at the method level. An executing method typically has no parent,
Bob Moore73a30902012-10-31 02:26:55 +0000165 * since each method is parsed separately. A method invoked externally
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 * via execute_control_method has a scope_op as the parent.
167 */
168 if ((!op->common.parent) ||
Len Brown4be44fc2005-08-05 00:44:28 -0400169 (op->common.parent->common.aml_opcode == AML_SCOPE_OP)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 /* No parent, the return value cannot possibly be used */
172
Len Brown4be44fc2005-08-05 00:44:28 -0400173 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
174 "At Method level, result of [%s] not used\n",
175 acpi_ps_get_opcode_name(op->common.
176 aml_opcode)));
Bob Moorefd1af712013-03-08 09:22:23 +0000177 return_UINT8(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 }
179
180 /* Get info on the parent. The root_op is AML_SCOPE */
181
Len Brown4be44fc2005-08-05 00:44:28 -0400182 parent_info =
183 acpi_ps_get_opcode_info(op->common.parent->common.aml_opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 if (parent_info->class == AML_CLASS_UNKNOWN) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500185 ACPI_ERROR((AE_INFO, "Unknown parent opcode Op=%p", op));
Bob Moorefd1af712013-03-08 09:22:23 +0000186 return_UINT8(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 }
188
189 /*
Bob Moore73a30902012-10-31 02:26:55 +0000190 * Decide what to do with the result based on the parent. If
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * the parent opcode will not use the result, delete the object.
192 * Otherwise leave it as is, it will be deleted when it is used
193 * as an operand later.
194 */
195 switch (parent_info->class) {
196 case AML_CLASS_CONTROL:
197
198 switch (op->common.parent->common.aml_opcode) {
199 case AML_RETURN_OP:
200
201 /* Never delete the return value associated with a return opcode */
202
203 goto result_used;
204
205 case AML_IF_OP:
206 case AML_WHILE_OP:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 /*
208 * If we are executing the predicate AND this is the predicate op,
209 * we will use the return value
210 */
Len Brown4be44fc2005-08-05 00:44:28 -0400211 if ((walk_state->control_state->common.state ==
Bob Moore1fad8732015-12-29 13:54:36 +0800212 ACPI_CONTROL_PREDICATE_EXECUTING) &&
213 (walk_state->control_state->control.predicate_op ==
214 op)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 goto result_used;
216 }
217 break;
218
219 default:
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000220
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 /* Ignore other control opcodes */
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 break;
224 }
225
226 /* The general control opcode returns no result */
227
228 goto result_not_used;
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 case AML_CLASS_CREATE:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 /*
232 * These opcodes allow term_arg(s) as operands and therefore
Bob Moore73a30902012-10-31 02:26:55 +0000233 * the operands can be method calls. The result is used.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 */
235 goto result_used;
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 case AML_CLASS_NAMED_OBJECT:
238
Len Brown4be44fc2005-08-05 00:44:28 -0400239 if ((op->common.parent->common.aml_opcode == AML_REGION_OP) ||
240 (op->common.parent->common.aml_opcode == AML_DATA_REGION_OP)
241 || (op->common.parent->common.aml_opcode == AML_PACKAGE_OP)
Len Brown4be44fc2005-08-05 00:44:28 -0400242 || (op->common.parent->common.aml_opcode == AML_BUFFER_OP)
243 || (op->common.parent->common.aml_opcode ==
Bob Moore9ff5a21a2017-04-26 16:18:40 +0800244 AML_VARIABLE_PACKAGE_OP)
245 || (op->common.parent->common.aml_opcode ==
Lin Mingef805d92008-04-10 19:06:41 +0400246 AML_INT_EVAL_SUBTREE_OP)
247 || (op->common.parent->common.aml_opcode ==
248 AML_BANK_FIELD_OP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 /*
250 * These opcodes allow term_arg(s) as operands and therefore
Bob Moore73a30902012-10-31 02:26:55 +0000251 * the operands can be method calls. The result is used.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
253 goto result_used;
254 }
255
256 goto result_not_used;
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 /*
260 * In all other cases. the parent will actually use the return
261 * object, so keep it.
262 */
263 goto result_used;
264 }
265
Lv Zheng10622bf2013-10-29 09:30:02 +0800266result_used:
Len Brown4be44fc2005-08-05 00:44:28 -0400267 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
268 "Result of [%s] used by Parent [%s] Op=%p\n",
269 acpi_ps_get_opcode_name(op->common.aml_opcode),
270 acpi_ps_get_opcode_name(op->common.parent->common.
271 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Bob Moorefd1af712013-03-08 09:22:23 +0000273 return_UINT8(TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Lv Zheng10622bf2013-10-29 09:30:02 +0800275result_not_used:
Len Brown4be44fc2005-08-05 00:44:28 -0400276 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
277 "Result of [%s] not used by Parent [%s] Op=%p\n",
278 acpi_ps_get_opcode_name(op->common.aml_opcode),
279 acpi_ps_get_opcode_name(op->common.parent->common.
280 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Bob Moorefd1af712013-03-08 09:22:23 +0000282 return_UINT8(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283}
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*******************************************************************************
286 *
287 * FUNCTION: acpi_ds_delete_result_if_not_used
288 *
Bob Mooreba494be2012-07-12 09:40:10 +0800289 * PARAMETERS: op - Current parse Op
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 * result_obj - Result of the operation
291 * walk_state - Current state
292 *
293 * RETURN: Status
294 *
Bob Moore73a30902012-10-31 02:26:55 +0000295 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 * result descriptor, check if the parent opcode will actually use
Bob Moore73a30902012-10-31 02:26:55 +0000297 * this result. If not, delete the result now so that it will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 * not become orphaned.
299 *
300 ******************************************************************************/
301
302void
Len Brown4be44fc2005-08-05 00:44:28 -0400303acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
304 union acpi_operand_object *result_obj,
305 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306{
Len Brown4be44fc2005-08-05 00:44:28 -0400307 union acpi_operand_object *obj_desc;
308 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Bob Mooreb229cf92006-04-21 17:15:00 -0400310 ACPI_FUNCTION_TRACE_PTR(ds_delete_result_if_not_used, result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 if (!op) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500313 ACPI_ERROR((AE_INFO, "Null Op"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return_VOID;
315 }
316
317 if (!result_obj) {
318 return_VOID;
319 }
320
Len Brown4be44fc2005-08-05 00:44:28 -0400321 if (!acpi_ds_is_result_used(op, walk_state)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 /* Must pop the result stack (obj_desc should be equal to result_obj) */
324
Len Brown4be44fc2005-08-05 00:44:28 -0400325 status = acpi_ds_result_pop(&obj_desc, walk_state);
326 if (ACPI_SUCCESS(status)) {
327 acpi_ut_remove_reference(result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 }
329 }
330
331 return_VOID;
332}
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334/*******************************************************************************
335 *
336 * FUNCTION: acpi_ds_resolve_operands
337 *
338 * PARAMETERS: walk_state - Current walk state with operands on stack
339 *
340 * RETURN: Status
341 *
Bob Moore73a30902012-10-31 02:26:55 +0000342 * DESCRIPTION: Resolve all operands to their values. Used to prepare
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 * arguments to a control method invocation (a call from one
344 * method to another.)
345 *
346 ******************************************************************************/
347
Len Brown4be44fc2005-08-05 00:44:28 -0400348acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349{
Len Brown4be44fc2005-08-05 00:44:28 -0400350 u32 i;
351 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Bob Mooreb229cf92006-04-21 17:15:00 -0400353 ACPI_FUNCTION_TRACE_PTR(ds_resolve_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 /*
356 * Attempt to resolve each of the valid operands
Bob Moore73a30902012-10-31 02:26:55 +0000357 * Method arguments are passed by reference, not by value. This means
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 * that the actual objects are passed, not copies of the objects.
359 */
360 for (i = 0; i < walk_state->num_operands; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400361 status =
362 acpi_ex_resolve_to_value(&walk_state->operands[i],
363 walk_state);
364 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 break;
366 }
367 }
368
Len Brown4be44fc2005-08-05 00:44:28 -0400369 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370}
371
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372/*******************************************************************************
373 *
374 * FUNCTION: acpi_ds_clear_operands
375 *
376 * PARAMETERS: walk_state - Current walk state with operands on stack
377 *
378 * RETURN: None
379 *
380 * DESCRIPTION: Clear all operands on the current walk state operand stack.
381 *
382 ******************************************************************************/
383
Len Brown4be44fc2005-08-05 00:44:28 -0400384void acpi_ds_clear_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Len Brown4be44fc2005-08-05 00:44:28 -0400386 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Bob Mooreb229cf92006-04-21 17:15:00 -0400388 ACPI_FUNCTION_TRACE_PTR(ds_clear_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 /* Remove a reference on each operand on the stack */
391
392 for (i = 0; i < walk_state->num_operands; i++) {
393 /*
394 * Remove a reference to all operands, including both
395 * "Arguments" and "Targets".
396 */
Len Brown4be44fc2005-08-05 00:44:28 -0400397 acpi_ut_remove_reference(walk_state->operands[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 walk_state->operands[i] = NULL;
399 }
400
401 walk_state->num_operands = 0;
402 return_VOID;
403}
404#endif
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/*******************************************************************************
407 *
408 * FUNCTION: acpi_ds_create_operand
409 *
410 * PARAMETERS: walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800411 * arg - Parse object for the argument
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 * arg_index - Which argument (zero based)
413 *
414 * RETURN: Status
415 *
416 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
Bob Moore73a30902012-10-31 02:26:55 +0000417 * opcode to the equivalent interpreter object. This may include
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 * looking up a name or entering a new name into the internal
419 * namespace.
420 *
421 ******************************************************************************/
422
423acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400424acpi_ds_create_operand(struct acpi_walk_state *walk_state,
425 union acpi_parse_object *arg, u32 arg_index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426{
Len Brown4be44fc2005-08-05 00:44:28 -0400427 acpi_status status = AE_OK;
428 char *name_string;
429 u32 name_length;
430 union acpi_operand_object *obj_desc;
431 union acpi_parse_object *parent_op;
432 u16 opcode;
433 acpi_interpreter_mode interpreter_mode;
434 const struct acpi_opcode_info *op_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Bob Mooreb229cf92006-04-21 17:15:00 -0400436 ACPI_FUNCTION_TRACE_PTR(ds_create_operand, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438 /* A valid name must be looked up in the namespace */
439
440 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
Bob Moore4e3156b2008-04-10 19:06:37 +0400441 (arg->common.value.string) &&
442 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400443 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n",
444 arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 /* Get the entire name string from the AML stream */
447
Bob Moore1fad8732015-12-29 13:54:36 +0800448 status = acpi_ex_get_name_string(ACPI_TYPE_ANY,
449 arg->common.value.buffer,
450 &name_string, &name_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Len Brown4be44fc2005-08-05 00:44:28 -0400452 if (ACPI_FAILURE(status)) {
453 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 }
455
456 /* All prefixes have been handled, and the name is in name_string */
457
458 /*
459 * Special handling for buffer_field declarations. This is a deferred
460 * opcode that unfortunately defines the field name as the last
Bob Moore73a30902012-10-31 02:26:55 +0000461 * parameter instead of the first. We get here when we are performing
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 * the deferred execution, so the actual name of the field is already
Bob Moore73a30902012-10-31 02:26:55 +0000463 * in the namespace. We don't want to attempt to look it up again
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 * because we may be executing in a different scope than where the
465 * actual opcode exists.
466 */
467 if ((walk_state->deferred_node) &&
Len Brown4be44fc2005-08-05 00:44:28 -0400468 (walk_state->deferred_node->type == ACPI_TYPE_BUFFER_FIELD)
Bob Moore1fad8732015-12-29 13:54:36 +0800469 && (arg_index == (u32)
470 ((walk_state->opcode == AML_CREATE_FIELD_OP) ? 3 : 2))) {
Len Brown4be44fc2005-08-05 00:44:28 -0400471 obj_desc =
472 ACPI_CAST_PTR(union acpi_operand_object,
473 walk_state->deferred_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 status = AE_OK;
Len Brown4be44fc2005-08-05 00:44:28 -0400475 } else { /* All other opcodes */
476
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 /*
478 * Differentiate between a namespace "create" operation
479 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
480 * IMODE_EXECUTE) in order to support the creation of
481 * namespace objects during the execution of control methods.
482 */
483 parent_op = arg->common.parent;
Len Brown4be44fc2005-08-05 00:44:28 -0400484 op_info =
485 acpi_ps_get_opcode_info(parent_op->common.
486 aml_opcode);
Bob Moore1fad8732015-12-29 13:54:36 +0800487
488 if ((op_info->flags & AML_NSNODE) &&
489 (parent_op->common.aml_opcode !=
490 AML_INT_METHODCALL_OP)
Len Brown4be44fc2005-08-05 00:44:28 -0400491 && (parent_op->common.aml_opcode != AML_REGION_OP)
492 && (parent_op->common.aml_opcode !=
493 AML_INT_NAMEPATH_OP)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 /* Enter name into namespace if not found */
496
497 interpreter_mode = ACPI_IMODE_LOAD_PASS2;
Len Brown4be44fc2005-08-05 00:44:28 -0400498 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 /* Return a failure if name not found */
500
501 interpreter_mode = ACPI_IMODE_EXECUTE;
502 }
503
Len Brown4be44fc2005-08-05 00:44:28 -0400504 status =
505 acpi_ns_lookup(walk_state->scope_info, name_string,
506 ACPI_TYPE_ANY, interpreter_mode,
507 ACPI_NS_SEARCH_PARENT |
508 ACPI_NS_DONT_OPEN_SCOPE, walk_state,
509 ACPI_CAST_INDIRECT_PTR(struct
510 acpi_namespace_node,
511 &obj_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 /*
513 * The only case where we pass through (ignore) a NOT_FOUND
514 * error is for the cond_ref_of opcode.
515 */
516 if (status == AE_NOT_FOUND) {
Len Brown4be44fc2005-08-05 00:44:28 -0400517 if (parent_op->common.aml_opcode ==
Bob Moore9ff5a21a2017-04-26 16:18:40 +0800518 AML_CONDITIONAL_REF_OF_OP) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 /*
520 * For the Conditional Reference op, it's OK if
521 * the name is not found; We just need a way to
522 * indicate this to the interpreter, set the
523 * object to the root
524 */
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000525 obj_desc =
526 ACPI_CAST_PTR(union
Len Brownfd350942007-05-09 23:34:35 -0400527 acpi_operand_object,
528 acpi_gbl_root_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 status = AE_OK;
Bob Moore56a3d5e2015-04-13 11:50:32 +0800530 } else if (parent_op->common.aml_opcode ==
531 AML_EXTERNAL_OP) {
Bob Moore7fdb5ce2016-08-04 16:42:42 +0800532 /*
533 * This opcode should never appear here. It is used only
534 * by AML disassemblers and is surrounded by an If(0)
535 * by the ASL compiler.
536 *
537 * Therefore, if we see it here, it is a serious error.
538 */
539 status = AE_AML_BAD_OPCODE;
Len Brown4be44fc2005-08-05 00:44:28 -0400540 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 /*
542 * We just plain didn't find it -- which is a
543 * very serious error at this point
544 */
545 status = AE_AML_NAME_NOT_FOUND;
546 }
547 }
548
Len Brown4be44fc2005-08-05 00:44:28 -0400549 if (ACPI_FAILURE(status)) {
Bob Moore16ccf822017-11-17 15:42:22 -0800550 ACPI_ERROR_NAMESPACE(walk_state->scope_info,
551 name_string, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 }
553 }
554
555 /* Free the namestring created above */
556
Bob Moore83135242006-10-03 00:00:00 -0400557 ACPI_FREE(name_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559 /* Check status from the lookup */
560
Len Brown4be44fc2005-08-05 00:44:28 -0400561 if (ACPI_FAILURE(status)) {
562 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 }
564
565 /* Put the resulting object onto the current object stack */
566
Len Brown4be44fc2005-08-05 00:44:28 -0400567 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
568 if (ACPI_FAILURE(status)) {
569 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 }
Lv Zheng8a2a2502015-12-03 10:42:53 +0800571
572 acpi_db_display_argument_object(obj_desc, walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400573 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 /* Check for null name case */
575
Bob Moore4e3156b2008-04-10 19:06:37 +0400576 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
577 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 /*
579 * If the name is null, this means that this is an
580 * optional result parameter that was not specified
Bob Moore73a30902012-10-31 02:26:55 +0000581 * in the original ASL. Create a Zero Constant for a
582 * placeholder. (Store to a constant is a Noop.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 */
Len Brown4be44fc2005-08-05 00:44:28 -0400584 opcode = AML_ZERO_OP; /* Has no arguments! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Len Brown4be44fc2005-08-05 00:44:28 -0400586 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
587 "Null namepath: Arg=%p\n", arg));
588 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 opcode = arg->common.aml_opcode;
590 }
591
592 /* Get the object type of the argument */
593
Len Brown4be44fc2005-08-05 00:44:28 -0400594 op_info = acpi_ps_get_opcode_info(opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 if (op_info->object_type == ACPI_TYPE_INVALID) {
Len Brown4be44fc2005-08-05 00:44:28 -0400596 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
598
Bob Moore1fad8732015-12-29 13:54:36 +0800599 if ((op_info->flags & AML_HAS_RETVAL) ||
600 (arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 /*
602 * Use value that was already previously returned
603 * by the evaluation of this argument
604 */
Bob Moore773069d2008-04-10 19:06:36 +0400605 status = acpi_ds_result_pop(&obj_desc, walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400606 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 /*
608 * Only error is underflow, and this indicates
609 * a missing or null operand!
610 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500611 ACPI_EXCEPTION((AE_INFO, status,
612 "Missing or null operand"));
Len Brown4be44fc2005-08-05 00:44:28 -0400613 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 }
Len Brown4be44fc2005-08-05 00:44:28 -0400615 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /* Create an ACPI_INTERNAL_OBJECT for the argument */
617
Len Brown4be44fc2005-08-05 00:44:28 -0400618 obj_desc =
619 acpi_ut_create_internal_object(op_info->
620 object_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400622 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624
625 /* Initialize the new object */
626
Len Brown4be44fc2005-08-05 00:44:28 -0400627 status =
628 acpi_ds_init_object_from_op(walk_state, arg, opcode,
629 &obj_desc);
630 if (ACPI_FAILURE(status)) {
631 acpi_ut_delete_object_desc(obj_desc);
632 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
634 }
635
636 /* Put the operand object on the object stack */
637
Len Brown4be44fc2005-08-05 00:44:28 -0400638 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
639 if (ACPI_FAILURE(status)) {
640 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 }
642
Lv Zheng8a2a2502015-12-03 10:42:53 +0800643 acpi_db_display_argument_object(obj_desc, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 }
645
Len Brown4be44fc2005-08-05 00:44:28 -0400646 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649/*******************************************************************************
650 *
651 * FUNCTION: acpi_ds_create_operands
652 *
653 * PARAMETERS: walk_state - Current state
654 * first_arg - First argument of a parser argument tree
655 *
656 * RETURN: Status
657 *
658 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
659 * namespace objects and place those argument object on the object
660 * stack in preparation for evaluation by the interpreter.
661 *
662 ******************************************************************************/
663
664acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400665acpi_ds_create_operands(struct acpi_walk_state *walk_state,
666 union acpi_parse_object *first_arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Len Brown4be44fc2005-08-05 00:44:28 -0400668 acpi_status status = AE_OK;
669 union acpi_parse_object *arg;
Bob Moore773069d2008-04-10 19:06:36 +0400670 union acpi_parse_object *arguments[ACPI_OBJ_NUM_OPERANDS];
Bob Mooreb7f9f042008-04-10 19:06:40 +0400671 u32 arg_count = 0;
672 u32 index = walk_state->num_operands;
673 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Bob Mooreb229cf92006-04-21 17:15:00 -0400675 ACPI_FUNCTION_TRACE_PTR(ds_create_operands, first_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Bob Moore773069d2008-04-10 19:06:36 +0400677 /* Get all arguments in the list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 arg = first_arg;
680 while (arg) {
Bob Moore773069d2008-04-10 19:06:36 +0400681 if (index >= ACPI_OBJ_NUM_OPERANDS) {
682 return_ACPI_STATUS(AE_BAD_DATA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 }
684
Bob Moore773069d2008-04-10 19:06:36 +0400685 arguments[index] = arg;
686 walk_state->operands[index] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 /* Move on to next argument, if any */
689
690 arg = arg->common.next;
691 arg_count++;
Bob Moore773069d2008-04-10 19:06:36 +0400692 index++;
693 }
694
Bob Moore87beb7e2014-01-08 13:44:15 +0800695 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
696 "NumOperands %d, ArgCount %d, Index %d\n",
697 walk_state->num_operands, arg_count, index));
698
699 /* Create the interpreter arguments, in reverse order */
700
Bob Moore773069d2008-04-10 19:06:36 +0400701 index--;
Bob Moore773069d2008-04-10 19:06:36 +0400702 for (i = 0; i < arg_count; i++) {
703 arg = arguments[index];
Bob Moore87beb7e2014-01-08 13:44:15 +0800704 walk_state->operand_index = (u8)index;
Bob Moore773069d2008-04-10 19:06:36 +0400705
706 status = acpi_ds_create_operand(walk_state, arg, index);
707 if (ACPI_FAILURE(status)) {
708 goto cleanup;
709 }
710
Bob Moore773069d2008-04-10 19:06:36 +0400711 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Moore87beb7e2014-01-08 13:44:15 +0800712 "Created Arg #%u (%p) %u args total\n",
713 index, arg, arg_count));
714 index--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 }
716
Len Brown4be44fc2005-08-05 00:44:28 -0400717 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Lv Zheng10622bf2013-10-29 09:30:02 +0800719cleanup:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 /*
721 * We must undo everything done above; meaning that we must
722 * pop everything off of the operand stack and delete those
723 * objects
724 */
Bob Moore773069d2008-04-10 19:06:36 +0400725 acpi_ds_obj_stack_pop_and_delete(arg_count, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Bob Mooreb27d6592010-05-26 11:47:13 +0800727 ACPI_EXCEPTION((AE_INFO, status, "While creating Arg %u", index));
Len Brown4be44fc2005-08-05 00:44:28 -0400728 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
Bob Moore4e3156b2008-04-10 19:06:37 +0400730
731/*****************************************************************************
732 *
733 * FUNCTION: acpi_ds_evaluate_name_path
734 *
735 * PARAMETERS: walk_state - Current state of the parse tree walk,
736 * the opcode of current operation should be
737 * AML_INT_NAMEPATH_OP
738 *
739 * RETURN: Status
740 *
741 * DESCRIPTION: Translate the -name_path- parse tree object to the equivalent
742 * interpreter object, convert it to value, if needed, duplicate
743 * it, if needed, and push it onto the current result stack.
744 *
745 ****************************************************************************/
746
747acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state)
748{
749 acpi_status status = AE_OK;
750 union acpi_parse_object *op = walk_state->op;
751 union acpi_operand_object **operand = &walk_state->operands[0];
752 union acpi_operand_object *new_obj_desc;
753 u8 type;
754
755 ACPI_FUNCTION_TRACE_PTR(ds_evaluate_name_path, walk_state);
756
757 if (!op->common.parent) {
758
759 /* This happens after certain exception processing */
760
761 goto exit;
762 }
763
764 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
Bob Moore9ff5a21a2017-04-26 16:18:40 +0800765 (op->common.parent->common.aml_opcode == AML_VARIABLE_PACKAGE_OP) ||
Bob Moore4e3156b2008-04-10 19:06:37 +0400766 (op->common.parent->common.aml_opcode == AML_REF_OF_OP)) {
767
768 /* TBD: Should we specify this feature as a bit of op_info->Flags of these opcodes? */
769
770 goto exit;
771 }
772
773 status = acpi_ds_create_operand(walk_state, op, 0);
774 if (ACPI_FAILURE(status)) {
775 goto exit;
776 }
777
778 if (op->common.flags & ACPI_PARSEOP_TARGET) {
779 new_obj_desc = *operand;
780 goto push_result;
781 }
782
Bob Moore3371c192009-02-18 14:44:03 +0800783 type = (*operand)->common.type;
Bob Moore4e3156b2008-04-10 19:06:37 +0400784
785 status = acpi_ex_resolve_to_value(operand, walk_state);
786 if (ACPI_FAILURE(status)) {
787 goto exit;
788 }
789
790 if (type == ACPI_TYPE_INTEGER) {
791
792 /* It was incremented by acpi_ex_resolve_to_value */
793
794 acpi_ut_remove_reference(*operand);
795
796 status =
797 acpi_ut_copy_iobject_to_iobject(*operand, &new_obj_desc,
798 walk_state);
799 if (ACPI_FAILURE(status)) {
800 goto exit;
801 }
802 } else {
803 /*
804 * The object either was anew created or is
805 * a Namespace node - don't decrement it.
806 */
807 new_obj_desc = *operand;
808 }
809
810 /* Cleanup for name-path operand */
811
812 status = acpi_ds_obj_stack_pop(1, walk_state);
813 if (ACPI_FAILURE(status)) {
814 walk_state->result_obj = new_obj_desc;
815 goto exit;
816 }
817
Lv Zheng10622bf2013-10-29 09:30:02 +0800818push_result:
Bob Moore4e3156b2008-04-10 19:06:37 +0400819
820 walk_state->result_obj = new_obj_desc;
821
822 status = acpi_ds_result_push(walk_state->result_obj, walk_state);
823 if (ACPI_SUCCESS(status)) {
824
825 /* Force to take it from stack */
826
827 op->common.flags |= ACPI_PARSEOP_IN_STACK;
828 }
829
Lv Zheng10622bf2013-10-29 09:30:02 +0800830exit:
Bob Moore4e3156b2008-04-10 19:06:37 +0400831
832 return_ACPI_STATUS(status);
833}