ACPICA: Dispatcher: Cleanup union acpi_operand_object's AML address assignments
[firefly-linux-kernel-4.4.55.git] / drivers / acpi / acpica / psparse.c
1 /******************************************************************************
2  *
3  * Module Name: psparse - Parser top level AML parse routines
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 /*
45  * Parse the AML and build an operation tree as most interpreters,
46  * like Perl, do. Parsing is done by hand rather than with a YACC
47  * generated parser to tightly constrain stack and dynamic memory
48  * usage. At the same time, parsing is kept flexible and the code
49  * fairly compact by parsing based on a list of AML opcode
50  * templates in aml_op_info[]
51  */
52
53 #include <acpi/acpi.h>
54 #include "accommon.h"
55 #include "acparser.h"
56 #include "acdispat.h"
57 #include "amlcode.h"
58 #include "acinterp.h"
59
60 #define _COMPONENT          ACPI_PARSER
61 ACPI_MODULE_NAME("psparse")
62
63 /*******************************************************************************
64  *
65  * FUNCTION:    acpi_ps_get_opcode_size
66  *
67  * PARAMETERS:  opcode          - An AML opcode
68  *
69  * RETURN:      Size of the opcode, in bytes (1 or 2)
70  *
71  * DESCRIPTION: Get the size of the current opcode.
72  *
73  ******************************************************************************/
74 u32 acpi_ps_get_opcode_size(u32 opcode)
75 {
76
77         /* Extended (2-byte) opcode if > 255 */
78
79         if (opcode > 0x00FF) {
80                 return (2);
81         }
82
83         /* Otherwise, just a single byte opcode */
84
85         return (1);
86 }
87
88 /*******************************************************************************
89  *
90  * FUNCTION:    acpi_ps_peek_opcode
91  *
92  * PARAMETERS:  parser_state        - A parser state object
93  *
94  * RETURN:      Next AML opcode
95  *
96  * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
97  *
98  ******************************************************************************/
99
100 u16 acpi_ps_peek_opcode(struct acpi_parse_state * parser_state)
101 {
102         u8 *aml;
103         u16 opcode;
104
105         aml = parser_state->aml;
106         opcode = (u16) ACPI_GET8(aml);
107
108         if (opcode == AML_EXTENDED_OP_PREFIX) {
109
110                 /* Extended opcode, get the second opcode byte */
111
112                 aml++;
113                 opcode = (u16) ((opcode << 8) | ACPI_GET8(aml));
114         }
115
116         return (opcode);
117 }
118
119 /*******************************************************************************
120  *
121  * FUNCTION:    acpi_ps_complete_this_op
122  *
123  * PARAMETERS:  walk_state      - Current State
124  *              op              - Op to complete
125  *
126  * RETURN:      Status
127  *
128  * DESCRIPTION: Perform any cleanup at the completion of an Op.
129  *
130  ******************************************************************************/
131
132 acpi_status
133 acpi_ps_complete_this_op(struct acpi_walk_state * walk_state,
134                          union acpi_parse_object * op)
135 {
136         union acpi_parse_object *prev;
137         union acpi_parse_object *next;
138         const struct acpi_opcode_info *parent_info;
139         union acpi_parse_object *replacement_op = NULL;
140         acpi_status status = AE_OK;
141
142         ACPI_FUNCTION_TRACE_PTR(ps_complete_this_op, op);
143
144         /* Check for null Op, can happen if AML code is corrupt */
145
146         if (!op) {
147                 return_ACPI_STATUS(AE_OK);      /* OK for now */
148         }
149
150         /* Delete this op and the subtree below it if asked to */
151
152         if (((walk_state->parse_flags & ACPI_PARSE_TREE_MASK) !=
153              ACPI_PARSE_DELETE_TREE)
154             || (walk_state->op_info->class == AML_CLASS_ARGUMENT)) {
155                 return_ACPI_STATUS(AE_OK);
156         }
157
158         /* Make sure that we only delete this subtree */
159
160         if (op->common.parent) {
161                 prev = op->common.parent->common.value.arg;
162                 if (!prev) {
163
164                         /* Nothing more to do */
165
166                         goto cleanup;
167                 }
168
169                 /*
170                  * Check if we need to replace the operator and its subtree
171                  * with a return value op (placeholder op)
172                  */
173                 parent_info =
174                     acpi_ps_get_opcode_info(op->common.parent->common.
175                                             aml_opcode);
176
177                 switch (parent_info->class) {
178                 case AML_CLASS_CONTROL:
179
180                         break;
181
182                 case AML_CLASS_CREATE:
183                         /*
184                          * These opcodes contain term_arg operands. The current
185                          * op must be replaced by a placeholder return op
186                          */
187                         replacement_op =
188                             acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
189                                              op->common.aml);
190                         if (!replacement_op) {
191                                 status = AE_NO_MEMORY;
192                         }
193                         break;
194
195                 case AML_CLASS_NAMED_OBJECT:
196                         /*
197                          * These opcodes contain term_arg operands. The current
198                          * op must be replaced by a placeholder return op
199                          */
200                         if ((op->common.parent->common.aml_opcode ==
201                              AML_REGION_OP)
202                             || (op->common.parent->common.aml_opcode ==
203                                 AML_DATA_REGION_OP)
204                             || (op->common.parent->common.aml_opcode ==
205                                 AML_BUFFER_OP)
206                             || (op->common.parent->common.aml_opcode ==
207                                 AML_PACKAGE_OP)
208                             || (op->common.parent->common.aml_opcode ==
209                                 AML_BANK_FIELD_OP)
210                             || (op->common.parent->common.aml_opcode ==
211                                 AML_VAR_PACKAGE_OP)) {
212                                 replacement_op =
213                                     acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
214                                                      op->common.aml);
215                                 if (!replacement_op) {
216                                         status = AE_NO_MEMORY;
217                                 }
218                         } else
219                             if ((op->common.parent->common.aml_opcode ==
220                                  AML_NAME_OP)
221                                 && (walk_state->pass_number <=
222                                     ACPI_IMODE_LOAD_PASS2)) {
223                                 if ((op->common.aml_opcode == AML_BUFFER_OP)
224                                     || (op->common.aml_opcode == AML_PACKAGE_OP)
225                                     || (op->common.aml_opcode ==
226                                         AML_VAR_PACKAGE_OP)) {
227                                         replacement_op =
228                                             acpi_ps_alloc_op(op->common.
229                                                              aml_opcode,
230                                                              op->common.aml);
231                                         if (!replacement_op) {
232                                                 status = AE_NO_MEMORY;
233                                         } else {
234                                                 replacement_op->named.data =
235                                                     op->named.data;
236                                                 replacement_op->named.length =
237                                                     op->named.length;
238                                         }
239                                 }
240                         }
241                         break;
242
243                 default:
244
245                         replacement_op =
246                             acpi_ps_alloc_op(AML_INT_RETURN_VALUE_OP,
247                                              op->common.aml);
248                         if (!replacement_op) {
249                                 status = AE_NO_MEMORY;
250                         }
251                 }
252
253                 /* We must unlink this op from the parent tree */
254
255                 if (prev == op) {
256
257                         /* This op is the first in the list */
258
259                         if (replacement_op) {
260                                 replacement_op->common.parent =
261                                     op->common.parent;
262                                 replacement_op->common.value.arg = NULL;
263                                 replacement_op->common.node = op->common.node;
264                                 op->common.parent->common.value.arg =
265                                     replacement_op;
266                                 replacement_op->common.next = op->common.next;
267                         } else {
268                                 op->common.parent->common.value.arg =
269                                     op->common.next;
270                         }
271                 }
272
273                 /* Search the parent list */
274
275                 else
276                         while (prev) {
277
278                                 /* Traverse all siblings in the parent's argument list */
279
280                                 next = prev->common.next;
281                                 if (next == op) {
282                                         if (replacement_op) {
283                                                 replacement_op->common.parent =
284                                                     op->common.parent;
285                                                 replacement_op->common.value.
286                                                     arg = NULL;
287                                                 replacement_op->common.node =
288                                                     op->common.node;
289                                                 prev->common.next =
290                                                     replacement_op;
291                                                 replacement_op->common.next =
292                                                     op->common.next;
293                                                 next = NULL;
294                                         } else {
295                                                 prev->common.next =
296                                                     op->common.next;
297                                                 next = NULL;
298                                         }
299                                 }
300                                 prev = next;
301                         }
302         }
303
304 cleanup:
305
306         /* Now we can actually delete the subtree rooted at Op */
307
308         acpi_ps_delete_parse_tree(op);
309         return_ACPI_STATUS(status);
310 }
311
312 /*******************************************************************************
313  *
314  * FUNCTION:    acpi_ps_next_parse_state
315  *
316  * PARAMETERS:  walk_state          - Current state
317  *              op                  - Current parse op
318  *              callback_status     - Status from previous operation
319  *
320  * RETURN:      Status
321  *
322  * DESCRIPTION: Update the parser state based upon the return exception from
323  *              the parser callback.
324  *
325  ******************************************************************************/
326
327 acpi_status
328 acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
329                          union acpi_parse_object *op,
330                          acpi_status callback_status)
331 {
332         struct acpi_parse_state *parser_state = &walk_state->parser_state;
333         acpi_status status = AE_CTRL_PENDING;
334
335         ACPI_FUNCTION_TRACE_PTR(ps_next_parse_state, op);
336
337         switch (callback_status) {
338         case AE_CTRL_TERMINATE:
339                 /*
340                  * A control method was terminated via a RETURN statement.
341                  * The walk of this method is complete.
342                  */
343                 parser_state->aml = parser_state->aml_end;
344                 status = AE_CTRL_TERMINATE;
345                 break;
346
347         case AE_CTRL_BREAK:
348
349                 parser_state->aml = walk_state->aml_last_while;
350                 walk_state->control_state->common.value = FALSE;
351                 status = AE_CTRL_BREAK;
352                 break;
353
354         case AE_CTRL_CONTINUE:
355
356                 parser_state->aml = walk_state->aml_last_while;
357                 status = AE_CTRL_CONTINUE;
358                 break;
359
360         case AE_CTRL_PENDING:
361
362                 parser_state->aml = walk_state->aml_last_while;
363                 break;
364
365 #if 0
366         case AE_CTRL_SKIP:
367
368                 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
369                 status = AE_OK;
370                 break;
371 #endif
372
373         case AE_CTRL_TRUE:
374                 /*
375                  * Predicate of an IF was true, and we are at the matching ELSE.
376                  * Just close out this package
377                  */
378                 parser_state->aml = acpi_ps_get_next_package_end(parser_state);
379                 status = AE_CTRL_PENDING;
380                 break;
381
382         case AE_CTRL_FALSE:
383                 /*
384                  * Either an IF/WHILE Predicate was false or we encountered a BREAK
385                  * opcode. In both cases, we do not execute the rest of the
386                  * package;  We simply close out the parent (finishing the walk of
387                  * this branch of the tree) and continue execution at the parent
388                  * level.
389                  */
390                 parser_state->aml = parser_state->scope->parse_scope.pkg_end;
391
392                 /* In the case of a BREAK, just force a predicate (if any) to FALSE */
393
394                 walk_state->control_state->common.value = FALSE;
395                 status = AE_CTRL_END;
396                 break;
397
398         case AE_CTRL_TRANSFER:
399
400                 /* A method call (invocation) -- transfer control */
401
402                 status = AE_CTRL_TRANSFER;
403                 walk_state->prev_op = op;
404                 walk_state->method_call_op = op;
405                 walk_state->method_call_node =
406                     (op->common.value.arg)->common.node;
407
408                 /* Will return value (if any) be used by the caller? */
409
410                 walk_state->return_used =
411                     acpi_ds_is_result_used(op, walk_state);
412                 break;
413
414         default:
415
416                 status = callback_status;
417                 if ((callback_status & AE_CODE_MASK) == AE_CODE_CONTROL) {
418                         status = AE_OK;
419                 }
420                 break;
421         }
422
423         return_ACPI_STATUS(status);
424 }
425
426 /*******************************************************************************
427  *
428  * FUNCTION:    acpi_ps_parse_aml
429  *
430  * PARAMETERS:  walk_state      - Current state
431  *
432  *
433  * RETURN:      Status
434  *
435  * DESCRIPTION: Parse raw AML and return a tree of ops
436  *
437  ******************************************************************************/
438
439 acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state)
440 {
441         acpi_status status;
442         struct acpi_thread_state *thread;
443         struct acpi_thread_state *prev_walk_list = acpi_gbl_current_walk_list;
444         struct acpi_walk_state *previous_walk_state;
445
446         ACPI_FUNCTION_TRACE(ps_parse_aml);
447
448         ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
449                           "Entered with WalkState=%p Aml=%p size=%X\n",
450                           walk_state, walk_state->parser_state.aml,
451                           walk_state->parser_state.aml_size));
452
453         if (!walk_state->parser_state.aml) {
454                 return_ACPI_STATUS(AE_NULL_OBJECT);
455         }
456
457         /* Create and initialize a new thread state */
458
459         thread = acpi_ut_create_thread_state();
460         if (!thread) {
461                 if (walk_state->method_desc) {
462
463                         /* Executing a control method - additional cleanup */
464
465                         acpi_ds_terminate_control_method(walk_state->
466                                                          method_desc,
467                                                          walk_state);
468                 }
469
470                 acpi_ds_delete_walk_state(walk_state);
471                 return_ACPI_STATUS(AE_NO_MEMORY);
472         }
473
474         walk_state->thread = thread;
475
476         /*
477          * If executing a method, the starting sync_level is this method's
478          * sync_level
479          */
480         if (walk_state->method_desc) {
481                 walk_state->thread->current_sync_level =
482                     walk_state->method_desc->method.sync_level;
483         }
484
485         acpi_ds_push_walk_state(walk_state, thread);
486
487         /*
488          * This global allows the AML debugger to get a handle to the currently
489          * executing control method.
490          */
491         acpi_gbl_current_walk_list = thread;
492
493         /*
494          * Execute the walk loop as long as there is a valid Walk State. This
495          * handles nested control method invocations without recursion.
496          */
497         ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "State=%p\n", walk_state));
498
499         status = AE_OK;
500         while (walk_state) {
501                 if (ACPI_SUCCESS(status)) {
502                         /*
503                          * The parse_loop executes AML until the method terminates
504                          * or calls another method.
505                          */
506                         status = acpi_ps_parse_loop(walk_state);
507                 }
508
509                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
510                                   "Completed one call to walk loop, %s State=%p\n",
511                                   acpi_format_exception(status), walk_state));
512
513                 if (status == AE_CTRL_TRANSFER) {
514                         /*
515                          * A method call was detected.
516                          * Transfer control to the called control method
517                          */
518                         status =
519                             acpi_ds_call_control_method(thread, walk_state,
520                                                         NULL);
521                         if (ACPI_FAILURE(status)) {
522                                 status =
523                                     acpi_ds_method_error(status, walk_state);
524                         }
525
526                         /*
527                          * If the transfer to the new method method call worked, a new walk
528                          * state was created -- get it
529                          */
530                         walk_state = acpi_ds_get_current_walk_state(thread);
531                         continue;
532                 } else if (status == AE_CTRL_TERMINATE) {
533                         status = AE_OK;
534                 } else if ((status != AE_OK) && (walk_state->method_desc)) {
535
536                         /* Either the method parse or actual execution failed */
537
538                         ACPI_ERROR_METHOD("Method parse/execution failed",
539                                           walk_state->method_node, NULL,
540                                           status);
541
542                         /* Check for possible multi-thread reentrancy problem */
543
544                         if ((status == AE_ALREADY_EXISTS) &&
545                             (!(walk_state->method_desc->method.
546                                info_flags & ACPI_METHOD_SERIALIZED))) {
547                                 /*
548                                  * Method is not serialized and tried to create an object
549                                  * twice. The probable cause is that the method cannot
550                                  * handle reentrancy. Mark as "pending serialized" now, and
551                                  * then mark "serialized" when the last thread exits.
552                                  */
553                                 walk_state->method_desc->method.info_flags |=
554                                     ACPI_METHOD_SERIALIZED_PENDING;
555                         }
556                 }
557
558                 /* We are done with this walk, move on to the parent if any */
559
560                 walk_state = acpi_ds_pop_walk_state(thread);
561
562                 /* Reset the current scope to the beginning of scope stack */
563
564                 acpi_ds_scope_stack_clear(walk_state);
565
566                 /*
567                  * If we just returned from the execution of a control method or if we
568                  * encountered an error during the method parse phase, there's lots of
569                  * cleanup to do
570                  */
571                 if (((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
572                      ACPI_PARSE_EXECUTE) || (ACPI_FAILURE(status))) {
573                         acpi_ds_terminate_control_method(walk_state->
574                                                          method_desc,
575                                                          walk_state);
576                 }
577
578                 /* Delete this walk state and all linked control states */
579
580                 acpi_ps_cleanup_scope(&walk_state->parser_state);
581                 previous_walk_state = walk_state;
582
583                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
584                                   "ReturnValue=%p, ImplicitValue=%p State=%p\n",
585                                   walk_state->return_desc,
586                                   walk_state->implicit_return_obj, walk_state));
587
588                 /* Check if we have restarted a preempted walk */
589
590                 walk_state = acpi_ds_get_current_walk_state(thread);
591                 if (walk_state) {
592                         if (ACPI_SUCCESS(status)) {
593                                 /*
594                                  * There is another walk state, restart it.
595                                  * If the method return value is not used by the parent,
596                                  * The object is deleted
597                                  */
598                                 if (!previous_walk_state->return_desc) {
599                                         /*
600                                          * In slack mode execution, if there is no return value
601                                          * we should implicitly return zero (0) as a default value.
602                                          */
603                                         if (acpi_gbl_enable_interpreter_slack &&
604                                             !previous_walk_state->
605                                             implicit_return_obj) {
606                                                 previous_walk_state->
607                                                     implicit_return_obj =
608                                                     acpi_ut_create_integer_object
609                                                     ((u64) 0);
610                                                 if (!previous_walk_state->
611                                                     implicit_return_obj) {
612                                                         return_ACPI_STATUS
613                                                             (AE_NO_MEMORY);
614                                                 }
615                                         }
616
617                                         /* Restart the calling control method */
618
619                                         status =
620                                             acpi_ds_restart_control_method
621                                             (walk_state,
622                                              previous_walk_state->
623                                              implicit_return_obj);
624                                 } else {
625                                         /*
626                                          * We have a valid return value, delete any implicit
627                                          * return value.
628                                          */
629                                         acpi_ds_clear_implicit_return
630                                             (previous_walk_state);
631
632                                         status =
633                                             acpi_ds_restart_control_method
634                                             (walk_state,
635                                              previous_walk_state->return_desc);
636                                 }
637                                 if (ACPI_SUCCESS(status)) {
638                                         walk_state->walk_type |=
639                                             ACPI_WALK_METHOD_RESTART;
640                                 }
641                         } else {
642                                 /* On error, delete any return object or implicit return */
643
644                                 acpi_ut_remove_reference(previous_walk_state->
645                                                          return_desc);
646                                 acpi_ds_clear_implicit_return
647                                     (previous_walk_state);
648                         }
649                 }
650
651                 /*
652                  * Just completed a 1st-level method, save the final internal return
653                  * value (if any)
654                  */
655                 else if (previous_walk_state->caller_return_desc) {
656                         if (previous_walk_state->implicit_return_obj) {
657                                 *(previous_walk_state->caller_return_desc) =
658                                     previous_walk_state->implicit_return_obj;
659                         } else {
660                                 /* NULL if no return value */
661
662                                 *(previous_walk_state->caller_return_desc) =
663                                     previous_walk_state->return_desc;
664                         }
665                 } else {
666                         if (previous_walk_state->return_desc) {
667
668                                 /* Caller doesn't want it, must delete it */
669
670                                 acpi_ut_remove_reference(previous_walk_state->
671                                                          return_desc);
672                         }
673                         if (previous_walk_state->implicit_return_obj) {
674
675                                 /* Caller doesn't want it, must delete it */
676
677                                 acpi_ut_remove_reference(previous_walk_state->
678                                                          implicit_return_obj);
679                         }
680                 }
681
682                 acpi_ds_delete_walk_state(previous_walk_state);
683         }
684
685         /* Normal exit */
686
687         acpi_ex_release_all_mutexes(thread);
688         acpi_ut_delete_generic_state(ACPI_CAST_PTR
689                                      (union acpi_generic_state, thread));
690         acpi_gbl_current_walk_list = prev_walk_list;
691         return_ACPI_STATUS(status);
692 }