drivers/acpi/acpica/psloop.c

   1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
   2 /******************************************************************************
   3  *
   4  * Module Name: psloop - Main AML parse loop
   5  *
   6  * Copyright (C) 2000 - 2018, Intel Corp.
   7  *
   8  *****************************************************************************/
   9
  10 /*
  11  * Parse the AML and build an operation tree as most interpreters, (such as
  12  * Perl) do. Parsing is done by hand rather than with a YACC generated parser
  13  * to tightly constrain stack and dynamic memory usage. Parsing is kept
  14  * flexible and the code fairly compact by parsing based on a list of AML
  15  * opcode templates in aml_op_info[].
  16  */
  17
  18 #include <acpi/acpi.h>
  19 #include "accommon.h"
  20 #include "acinterp.h"
  21 #include "acparser.h"
  22 #include "acdispat.h"
  23 #include "amlcode.h"
  24 #include "acconvert.h"
  25
  26 #define _COMPONENT          ACPI_PARSER
  27 ACPI_MODULE_NAME("psloop")
  28
  29 /* Local prototypes */
  30 static acpi_status
  31 acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
  32                       u8 * aml_op_start, union acpi_parse_object *op);
  33
  34 static void
  35 acpi_ps_link_module_code(union acpi_parse_object *parent_op,
  36                          u8 *aml_start, u32 aml_length, acpi_owner_id owner_id);
  37
  38 /*******************************************************************************
  39  *
  40  * FUNCTION:    acpi_ps_get_arguments
  41  *
  42  * PARAMETERS:  walk_state          - Current state
  43  *              aml_op_start        - Op start in AML
  44  *              op                  - Current Op
  45  *
  46  * RETURN:      Status
  47  *
  48  * DESCRIPTION: Get arguments for passed Op.
  49  *
  50  ******************************************************************************/
  51
  52 static acpi_status
  53 acpi_ps_get_arguments(struct acpi_walk_state *walk_state,
  54                       u8 * aml_op_start, union acpi_parse_object *op)
  55 {
  56         acpi_status status = AE_OK;
  57         union acpi_parse_object *arg = NULL;
  58         const struct acpi_opcode_info *op_info;
  59
  60         ACPI_FUNCTION_TRACE_PTR(ps_get_arguments, walk_state);
  61
  62         ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
  63                           "Get arguments for opcode [%s]\n",
  64                           op->common.aml_op_name));
  65
  66         switch (op->common.aml_opcode) {
  67         case AML_BYTE_OP:       /* AML_BYTEDATA_ARG */
  68         case AML_WORD_OP:       /* AML_WORDDATA_ARG */
  69         case AML_DWORD_OP:      /* AML_DWORDATA_ARG */
  70         case AML_QWORD_OP:      /* AML_QWORDATA_ARG */
  71         case AML_STRING_OP:     /* AML_ASCIICHARLIST_ARG */
  72
  73                 /* Fill in constant or string argument directly */
  74
  75                 acpi_ps_get_next_simple_arg(&(walk_state->parser_state),
  76                                             GET_CURRENT_ARG_TYPE(walk_state->
  77                                                                  arg_types),
  78                                             op);
  79                 break;
  80
  81         case AML_INT_NAMEPATH_OP:       /* AML_NAMESTRING_ARG */
  82
  83                 status = acpi_ps_get_next_namepath(walk_state,
  84                                                    &(walk_state->parser_state),
  85                                                    op,
  86                                                    ACPI_POSSIBLE_METHOD_CALL);
  87                 if (ACPI_FAILURE(status)) {
  88                         return_ACPI_STATUS(status);
  89                 }
  90
  91                 walk_state->arg_types = 0;
  92                 break;
  93
  94         default:
  95                 /*
  96                  * Op is not a constant or string, append each argument to the Op
  97                  */
  98                 while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) &&
  99                        !walk_state->arg_count) {
 100                         walk_state->aml = walk_state->parser_state.aml;
 101
 102                         switch (op->common.aml_opcode) {
 103                         case AML_METHOD_OP:
 104                         case AML_BUFFER_OP:
 105                         case AML_PACKAGE_OP:
 106                         case AML_VARIABLE_PACKAGE_OP:
 107                         case AML_WHILE_OP:
 108
 109                                 break;
 110
 111                         default:
 112
 113                                 ASL_CV_CAPTURE_COMMENTS(walk_state);
 114                                 break;
 115                         }
 116
 117                         status =
 118                             acpi_ps_get_next_arg(walk_state,
 119                                                  &(walk_state->parser_state),
 120                                                  GET_CURRENT_ARG_TYPE
 121                                                  (walk_state->arg_types), &arg);
 122                         if (ACPI_FAILURE(status)) {
 123                                 return_ACPI_STATUS(status);
 124                         }
 125
 126                         if (arg) {
 127                                 acpi_ps_append_arg(op, arg);
 128                         }
 129
 130                         INCREMENT_ARG_LIST(walk_state->arg_types);
 131                 }
 132
 133                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 134                                   "Final argument count: %8.8X pass %u\n",
 135                                   walk_state->arg_count,
 136                                   walk_state->pass_number));
 137
 138                 /*
 139                  * This case handles the legacy option that groups all module-level
 140                  * code blocks together and defers execution until all of the tables
 141                  * are loaded. Execute all of these blocks at this time.
 142                  * Execute any module-level code that was detected during the table
 143                  * load phase.
 144                  *
 145                  * Note: this option is deprecated and will be eliminated in the
 146                  * future. Use of this option can cause problems with AML code that
 147                  * depends upon in-order immediate execution of module-level code.
 148                  */
 149                 if (acpi_gbl_group_module_level_code &&
 150                     (walk_state->pass_number <= ACPI_IMODE_LOAD_PASS2) &&
 151                     ((walk_state->parse_flags & ACPI_PARSE_DISASSEMBLE) == 0)) {
 152                         /*
 153                          * We want to skip If/Else/While constructs during Pass1 because we
 154                          * want to actually conditionally execute the code during Pass2.
 155                          *
 156                          * Except for disassembly, where we always want to walk the
 157                          * If/Else/While packages
 158                          */
 159                         switch (op->common.aml_opcode) {
 160                         case AML_IF_OP:
 161                         case AML_ELSE_OP:
 162                         case AML_WHILE_OP:
 163                                 /*
 164                                  * Currently supported module-level opcodes are:
 165                                  * IF/ELSE/WHILE. These appear to be the most common,
 166                                  * and easiest to support since they open an AML
 167                                  * package.
 168                                  */
 169                                 if (walk_state->pass_number ==
 170                                     ACPI_IMODE_LOAD_PASS1) {
 171                                         acpi_ps_link_module_code(op->common.
 172                                                                  parent,
 173                                                                  aml_op_start,
 174                                                                  (u32)
 175                                                                  (walk_state->
 176                                                                  parser_state.
 177                                                                  pkg_end -
 178                                                                  aml_op_start),
 179                                                                  walk_state->
 180                                                                  owner_id);
 181                                 }
 182
 183                                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 184                                                   "Pass1: Skipping an If/Else/While body\n"));
 185
 186                                 /* Skip body of if/else/while in pass 1 */
 187
 188                                 walk_state->parser_state.aml =
 189                                     walk_state->parser_state.pkg_end;
 190                                 walk_state->arg_count = 0;
 191                                 break;
 192
 193                         default:
 194                                 /*
 195                                  * Check for an unsupported executable opcode at module
 196                                  * level. We must be in PASS1, the parent must be a SCOPE,
 197                                  * The opcode class must be EXECUTE, and the opcode must
 198                                  * not be an argument to another opcode.
 199                                  */
 200                                 if ((walk_state->pass_number ==
 201                                      ACPI_IMODE_LOAD_PASS1)
 202                                     && (op->common.parent->common.aml_opcode ==
 203                                         AML_SCOPE_OP)) {
 204                                         op_info =
 205                                             acpi_ps_get_opcode_info(op->common.
 206                                                                     aml_opcode);
 207                                         if ((op_info->class ==
 208                                              AML_CLASS_EXECUTE) && (!arg)) {
 209                                                 ACPI_WARNING((AE_INFO,
 210                                                               "Unsupported module-level executable opcode "
 211                                                               "0x%.2X at table offset 0x%.4X",
 212                                                               op->common.
 213                                                               aml_opcode,
 214                                                               (u32)
 215                                                               (ACPI_PTR_DIFF
 216                                                                (aml_op_start,
 217                                                                 walk_state->
 218                                                                 parser_state.
 219                                                                 aml_start) +
 220                                                                sizeof(struct
 221                                                                       acpi_table_header))));
 222                                         }
 223                                 }
 224                                 break;
 225                         }
 226                 }
 227
 228                 /* Special processing for certain opcodes */
 229
 230                 switch (op->common.aml_opcode) {
 231                 case AML_METHOD_OP:
 232                         /*
 233                          * Skip parsing of control method because we don't have enough
 234                          * info in the first pass to parse it correctly.
 235                          *
 236                          * Save the length and address of the body
 237                          */
 238                         op->named.data = walk_state->parser_state.aml;
 239                         op->named.length = (u32)
 240                             (walk_state->parser_state.pkg_end -
 241                              walk_state->parser_state.aml);
 242
 243                         /* Skip body of method */
 244
 245                         walk_state->parser_state.aml =
 246                             walk_state->parser_state.pkg_end;
 247                         walk_state->arg_count = 0;
 248                         break;
 249
 250                 case AML_BUFFER_OP:
 251                 case AML_PACKAGE_OP:
 252                 case AML_VARIABLE_PACKAGE_OP:
 253
 254                         if ((op->common.parent) &&
 255                             (op->common.parent->common.aml_opcode ==
 256                              AML_NAME_OP)
 257                             && (walk_state->pass_number <=
 258                                 ACPI_IMODE_LOAD_PASS2)) {
 259                                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 260                                                   "Setup Package/Buffer: Pass %u, AML Ptr: %p\n",
 261                                                   walk_state->pass_number,
 262                                                   aml_op_start));
 263
 264                                 /*
 265                                  * Skip parsing of Buffers and Packages because we don't have
 266                                  * enough info in the first pass to parse them correctly.
 267                                  */
 268                                 op->named.data = aml_op_start;
 269                                 op->named.length = (u32)
 270                                     (walk_state->parser_state.pkg_end -
 271                                      aml_op_start);
 272
 273                                 /* Skip body */
 274
 275                                 walk_state->parser_state.aml =
 276                                     walk_state->parser_state.pkg_end;
 277                                 walk_state->arg_count = 0;
 278                         }
 279                         break;
 280
 281                 case AML_WHILE_OP:
 282
 283                         if (walk_state->control_state) {
 284                                 walk_state->control_state->control.package_end =
 285                                     walk_state->parser_state.pkg_end;
 286                         }
 287                         break;
 288
 289                 default:
 290
 291                         /* No action for all other opcodes */
 292
 293                         break;
 294                 }
 295
 296                 break;
 297         }
 298
 299         return_ACPI_STATUS(AE_OK);
 300 }
 301
 302 /*******************************************************************************
 303  *
 304  * FUNCTION:    acpi_ps_link_module_code
 305  *
 306  * PARAMETERS:  parent_op           - Parent parser op
 307  *              aml_start           - Pointer to the AML
 308  *              aml_length          - Length of executable AML
 309  *              owner_id            - owner_id of module level code
 310  *
 311  * RETURN:      None.
 312  *
 313  * DESCRIPTION: Wrap the module-level code with a method object and link the
 314  *              object to the global list. Note, the mutex field of the method
 315  *              object is used to link multiple module-level code objects.
 316  *
 317  * NOTE: In this legacy option, each block of detected executable AML
 318  * code that is outside of any control method is wrapped with a temporary
 319  * control method object and placed on a global list below.
 320  *
 321  * This function executes the module-level code for all tables only after
 322  * all of the tables have been loaded. It is a legacy option and is
 323  * not compatible with other ACPI implementations. See acpi_ns_load_table.
 324  *
 325  * This function will be removed when the legacy option is removed.
 326  *
 327  ******************************************************************************/
 328
 329 static void
 330 acpi_ps_link_module_code(union acpi_parse_object *parent_op,
 331                          u8 *aml_start, u32 aml_length, acpi_owner_id owner_id)
 332 {
 333         union acpi_operand_object *prev;
 334         union acpi_operand_object *next;
 335         union acpi_operand_object *method_obj;
 336         struct acpi_namespace_node *parent_node;
 337
 338         ACPI_FUNCTION_TRACE(ps_link_module_code);
 339
 340         /* Get the tail of the list */
 341
 342         prev = next = acpi_gbl_module_code_list;
 343         while (next) {
 344                 prev = next;
 345                 next = next->method.mutex;
 346         }
 347
 348         /*
 349          * Insert the module level code into the list. Merge it if it is
 350          * adjacent to the previous element.
 351          */
 352         if (!prev ||
 353             ((prev->method.aml_start + prev->method.aml_length) != aml_start)) {
 354
 355                 /* Create, initialize, and link a new temporary method object */
 356
 357                 method_obj = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
 358                 if (!method_obj) {
 359                         return_VOID;
 360                 }
 361
 362                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 363                                   "Create/Link new code block: %p\n",
 364                                   method_obj));
 365
 366                 if (parent_op->common.node) {
 367                         parent_node = parent_op->common.node;
 368                 } else {
 369                         parent_node = acpi_gbl_root_node;
 370                 }
 371
 372                 method_obj->method.aml_start = aml_start;
 373                 method_obj->method.aml_length = aml_length;
 374                 method_obj->method.owner_id = owner_id;
 375                 method_obj->method.info_flags |= ACPI_METHOD_MODULE_LEVEL;
 376
 377                 /*
 378                  * Save the parent node in next_object. This is cheating, but we
 379                  * don't want to expand the method object.
 380                  */
 381                 method_obj->method.next_object =
 382                     ACPI_CAST_PTR(union acpi_operand_object, parent_node);
 383
 384                 if (!prev) {
 385                         acpi_gbl_module_code_list = method_obj;
 386                 } else {
 387                         prev->method.mutex = method_obj;
 388                 }
 389         } else {
 390                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 391                                   "Appending to existing code block: %p\n",
 392                                   prev));
 393
 394                 prev->method.aml_length += aml_length;
 395         }
 396
 397         return_VOID;
 398 }
 399
 400 /*******************************************************************************
 401  *
 402  * FUNCTION:    acpi_ps_parse_loop
 403  *
 404  * PARAMETERS:  walk_state          - Current state
 405  *
 406  * RETURN:      Status
 407  *
 408  * DESCRIPTION: Parse AML (pointed to by the current parser state) and return
 409  *              a tree of ops.
 410  *
 411  ******************************************************************************/
 412
 413 acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state)
 414 {
 415         acpi_status status = AE_OK;
 416         union acpi_parse_object *op = NULL;     /* current op */
 417         struct acpi_parse_state *parser_state;
 418         u8 *aml_op_start = NULL;
 419
 420         ACPI_FUNCTION_TRACE_PTR(ps_parse_loop, walk_state);
 421
 422         if (walk_state->descending_callback == NULL) {
 423                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 424         }
 425
 426         parser_state = &walk_state->parser_state;
 427         walk_state->arg_types = 0;
 428
 429 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
 430
 431         if (walk_state->walk_type & ACPI_WALK_METHOD_RESTART) {
 432
 433                 /* We are restarting a preempted control method */
 434
 435                 if (acpi_ps_has_completed_scope(parser_state)) {
 436                         /*
 437                          * We must check if a predicate to an IF or WHILE statement
 438                          * was just completed
 439                          */
 440                         if ((parser_state->scope->parse_scope.op) &&
 441                             ((parser_state->scope->parse_scope.op->common.
 442                               aml_opcode == AML_IF_OP)
 443                              || (parser_state->scope->parse_scope.op->common.
 444                                  aml_opcode == AML_WHILE_OP))
 445                             && (walk_state->control_state)
 446                             && (walk_state->control_state->common.state ==
 447                                 ACPI_CONTROL_PREDICATE_EXECUTING)) {
 448                                 /*
 449                                  * A predicate was just completed, get the value of the
 450                                  * predicate and branch based on that value
 451                                  */
 452                                 walk_state->op = NULL;
 453                                 status =
 454                                     acpi_ds_get_predicate_value(walk_state,
 455                                                                 ACPI_TO_POINTER
 456                                                                 (TRUE));
 457                                 if (ACPI_FAILURE(status)
 458                                     && ((status & AE_CODE_MASK) !=
 459                                         AE_CODE_CONTROL)) {
 460                                         if (status == AE_AML_NO_RETURN_VALUE) {
 461                                                 ACPI_EXCEPTION((AE_INFO, status,
 462                                                                 "Invoked method did not return a value"));
 463                                         }
 464
 465                                         ACPI_EXCEPTION((AE_INFO, status,
 466                                                         "GetPredicate Failed"));
 467                                         return_ACPI_STATUS(status);
 468                                 }
 469
 470                                 status =
 471                                     acpi_ps_next_parse_state(walk_state, op,
 472                                                              status);
 473                         }
 474
 475                         acpi_ps_pop_scope(parser_state, &op,
 476                                           &walk_state->arg_types,
 477                                           &walk_state->arg_count);
 478                         ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 479                                           "Popped scope, Op=%p\n", op));
 480                 } else if (walk_state->prev_op) {
 481
 482                         /* We were in the middle of an op */
 483
 484                         op = walk_state->prev_op;
 485                         walk_state->arg_types = walk_state->prev_arg_types;
 486                 }
 487         }
 488 #endif
 489
 490         /* Iterative parsing loop, while there is more AML to process: */
 491
 492         while ((parser_state->aml < parser_state->aml_end) || (op)) {
 493                 ASL_CV_CAPTURE_COMMENTS(walk_state);
 494
 495                 aml_op_start = parser_state->aml;
 496                 if (!op) {
 497                         status =
 498                             acpi_ps_create_op(walk_state, aml_op_start, &op);
 499                         if (ACPI_FAILURE(status)) {
 500                                 if (status == AE_CTRL_PARSE_CONTINUE) {
 501                                         continue;
 502                                 }
 503
 504                                 if (status == AE_CTRL_PARSE_PENDING) {
 505                                         status = AE_OK;
 506                                 }
 507
 508                                 if (status == AE_CTRL_TERMINATE) {
 509                                         return_ACPI_STATUS(status);
 510                                 }
 511
 512                                 status =
 513                                     acpi_ps_complete_op(walk_state, &op,
 514                                                         status);
 515                                 if (ACPI_FAILURE(status)) {
 516                                         return_ACPI_STATUS(status);
 517                                 }
 518
 519                                 continue;
 520                         }
 521
 522                         acpi_ex_start_trace_opcode(op, walk_state);
 523                 }
 524
 525                 /*
 526                  * Start arg_count at zero because we don't know if there are
 527                  * any args yet
 528                  */
 529                 walk_state->arg_count = 0;
 530
 531                 switch (op->common.aml_opcode) {
 532                 case AML_BYTE_OP:
 533                 case AML_WORD_OP:
 534                 case AML_DWORD_OP:
 535                 case AML_QWORD_OP:
 536
 537                         break;
 538
 539                 default:
 540
 541                         ASL_CV_CAPTURE_COMMENTS(walk_state);
 542                         break;
 543                 }
 544
 545                 /* Are there any arguments that must be processed? */
 546
 547                 if (walk_state->arg_types) {
 548
 549                         /* Get arguments */
 550
 551                         status =
 552                             acpi_ps_get_arguments(walk_state, aml_op_start, op);
 553                         if (ACPI_FAILURE(status)) {
 554                                 status =
 555                                     acpi_ps_complete_op(walk_state, &op,
 556                                                         status);
 557                                 if (ACPI_FAILURE(status)) {
 558                                         return_ACPI_STATUS(status);
 559                                 }
 560
 561                                 continue;
 562                         }
 563                 }
 564
 565                 /* Check for arguments that need to be processed */
 566
 567                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 568                                   "Parseloop: argument count: %8.8X\n",
 569                                   walk_state->arg_count));
 570
 571                 if (walk_state->arg_count) {
 572                         /*
 573                          * There are arguments (complex ones), push Op and
 574                          * prepare for argument
 575                          */
 576                         status = acpi_ps_push_scope(parser_state, op,
 577                                                     walk_state->arg_types,
 578                                                     walk_state->arg_count);
 579                         if (ACPI_FAILURE(status)) {
 580                                 status =
 581                                     acpi_ps_complete_op(walk_state, &op,
 582                                                         status);
 583                                 if (ACPI_FAILURE(status)) {
 584                                         return_ACPI_STATUS(status);
 585                                 }
 586
 587                                 continue;
 588                         }
 589
 590                         op = NULL;
 591                         continue;
 592                 }
 593
 594                 /*
 595                  * All arguments have been processed -- Op is complete,
 596                  * prepare for next
 597                  */
 598                 walk_state->op_info =
 599                     acpi_ps_get_opcode_info(op->common.aml_opcode);
 600                 if (walk_state->op_info->flags & AML_NAMED) {
 601                         if (op->common.aml_opcode == AML_REGION_OP ||
 602                             op->common.aml_opcode == AML_DATA_REGION_OP) {
 603                                 /*
 604                                  * Skip parsing of control method or opregion body,
 605                                  * because we don't have enough info in the first pass
 606                                  * to parse them correctly.
 607                                  *
 608                                  * Completed parsing an op_region declaration, we now
 609                                  * know the length.
 610                                  */
 611                                 op->named.length =
 612                                     (u32) (parser_state->aml - op->named.data);
 613                         }
 614                 }
 615
 616                 if (walk_state->op_info->flags & AML_CREATE) {
 617                         /*
 618                          * Backup to beginning of create_XXXfield declaration (1 for
 619                          * Opcode)
 620                          *
 621                          * body_length is unknown until we parse the body
 622                          */
 623                         op->named.length =
 624                             (u32) (parser_state->aml - op->named.data);
 625                 }
 626
 627                 if (op->common.aml_opcode == AML_BANK_FIELD_OP) {
 628                         /*
 629                          * Backup to beginning of bank_field declaration
 630                          *
 631                          * body_length is unknown until we parse the body
 632                          */
 633                         op->named.length =
 634                             (u32) (parser_state->aml - op->named.data);
 635                 }
 636
 637                 /* This op complete, notify the dispatcher */
 638
 639                 if (walk_state->ascending_callback != NULL) {
 640                         walk_state->op = op;
 641                         walk_state->opcode = op->common.aml_opcode;
 642
 643                         status = walk_state->ascending_callback(walk_state);
 644                         status =
 645                             acpi_ps_next_parse_state(walk_state, op, status);
 646                         if (status == AE_CTRL_PENDING) {
 647                                 status = AE_OK;
 648                         }
 649                 }
 650
 651                 status = acpi_ps_complete_op(walk_state, &op, status);
 652                 if (ACPI_FAILURE(status)) {
 653                         return_ACPI_STATUS(status);
 654                 }
 655
 656         }                       /* while parser_state->Aml */
 657
 658         status = acpi_ps_complete_final_op(walk_state, op, status);
 659         return_ACPI_STATUS(status);
 660 }