1 /****************************************************************************** 2 * 3 * Module Name: psobject - Support for parse objects 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2017, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #include <acpi/acpi.h> 45 #include "accommon.h" 46 #include "acparser.h" 47 #include "amlcode.h" 48 #include "acconvert.h" 49 50 #define _COMPONENT ACPI_PARSER 51 ACPI_MODULE_NAME("psobject") 52 53 /* Local prototypes */ 54 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state); 55 56 /******************************************************************************* 57 * 58 * FUNCTION: acpi_ps_get_aml_opcode 59 * 60 * PARAMETERS: walk_state - Current state 61 * 62 * RETURN: Status 63 * 64 * DESCRIPTION: Extract the next AML opcode from the input stream. 65 * 66 ******************************************************************************/ 67 68 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state) 69 { 70 u32 aml_offset; 71 72 ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode, walk_state); 73 74 walk_state->aml = walk_state->parser_state.aml; 75 walk_state->opcode = acpi_ps_peek_opcode(&(walk_state->parser_state)); 76 77 /* 78 * First cut to determine what we have found: 79 * 1) A valid AML opcode 80 * 2) A name string 81 * 3) An unknown/invalid opcode 82 */ 83 walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode); 84 85 switch (walk_state->op_info->class) { 86 case AML_CLASS_ASCII: 87 case AML_CLASS_PREFIX: 88 /* 89 * Starts with a valid prefix or ASCII char, this is a name 90 * string. Convert the bare name string to a namepath. 91 */ 92 walk_state->opcode = AML_INT_NAMEPATH_OP; 93 walk_state->arg_types = ARGP_NAMESTRING; 94 break; 95 96 case AML_CLASS_UNKNOWN: 97 98 /* The opcode is unrecognized. Complain and skip unknown opcodes */ 99 100 if (walk_state->pass_number == 2) { 101 aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml, 102 walk_state-> 103 parser_state.aml_start); 104 105 ACPI_ERROR((AE_INFO, 106 "Unknown opcode 0x%.2X at table offset 0x%.4X, ignoring", 107 walk_state->opcode, 108 (u32)(aml_offset + 109 sizeof(struct acpi_table_header)))); 110 111 ACPI_DUMP_BUFFER((walk_state->parser_state.aml - 16), 112 48); 113 114 #ifdef ACPI_ASL_COMPILER 115 /* 116 * This is executed for the disassembler only. Output goes 117 * to the disassembled ASL output file. 118 */ 119 acpi_os_printf 120 ("/*\nError: Unknown opcode 0x%.2X at table offset 0x%.4X, context:\n", 121 walk_state->opcode, 122 (u32)(aml_offset + 123 sizeof(struct acpi_table_header))); 124 125 ACPI_ERROR((AE_INFO, 126 "Aborting disassembly, AML byte code is corrupt")); 127 128 /* Dump the context surrounding the invalid opcode */ 129 130 acpi_ut_dump_buffer(((u8 *)walk_state->parser_state. 131 aml - 16), 48, DB_BYTE_DISPLAY, 132 (aml_offset + 133 sizeof(struct acpi_table_header) - 134 16)); 135 acpi_os_printf(" */\n"); 136 137 /* 138 * Just abort the disassembly, cannot continue because the 139 * parser is essentially lost. The disassembler can then 140 * randomly fail because an ill-constructed parse tree 141 * can result. 142 */ 143 return_ACPI_STATUS(AE_AML_BAD_OPCODE); 144 #endif 145 } 146 147 /* Increment past one-byte or two-byte opcode */ 148 149 walk_state->parser_state.aml++; 150 if (walk_state->opcode > 0xFF) { /* Can only happen if first byte is 0x5B */ 151 walk_state->parser_state.aml++; 152 } 153 154 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); 155 156 default: 157 158 /* Found opcode info, this is a normal opcode */ 159 160 walk_state->parser_state.aml += 161 acpi_ps_get_opcode_size(walk_state->opcode); 162 walk_state->arg_types = walk_state->op_info->parse_args; 163 break; 164 } 165 166 return_ACPI_STATUS(AE_OK); 167 } 168 169 /******************************************************************************* 170 * 171 * FUNCTION: acpi_ps_build_named_op 172 * 173 * PARAMETERS: walk_state - Current state 174 * aml_op_start - Begin of named Op in AML 175 * unnamed_op - Early Op (not a named Op) 176 * op - Returned Op 177 * 178 * RETURN: Status 179 * 180 * DESCRIPTION: Parse a named Op 181 * 182 ******************************************************************************/ 183 184 acpi_status 185 acpi_ps_build_named_op(struct acpi_walk_state *walk_state, 186 u8 *aml_op_start, 187 union acpi_parse_object *unnamed_op, 188 union acpi_parse_object **op) 189 { 190 acpi_status status = AE_OK; 191 union acpi_parse_object *arg = NULL; 192 193 ACPI_FUNCTION_TRACE_PTR(ps_build_named_op, walk_state); 194 195 unnamed_op->common.value.arg = NULL; 196 unnamed_op->common.arg_list_length = 0; 197 unnamed_op->common.aml_opcode = walk_state->opcode; 198 199 /* 200 * Get and append arguments until we find the node that contains 201 * the name (the type ARGP_NAME). 202 */ 203 while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) && 204 (GET_CURRENT_ARG_TYPE(walk_state->arg_types) != ARGP_NAME)) { 205 ASL_CV_CAPTURE_COMMENTS(walk_state); 206 status = 207 acpi_ps_get_next_arg(walk_state, 208 &(walk_state->parser_state), 209 GET_CURRENT_ARG_TYPE(walk_state-> 210 arg_types), &arg); 211 if (ACPI_FAILURE(status)) { 212 return_ACPI_STATUS(status); 213 } 214 215 acpi_ps_append_arg(unnamed_op, arg); 216 INCREMENT_ARG_LIST(walk_state->arg_types); 217 } 218 219 /* are there any inline comments associated with the name_seg?? If so, save this. */ 220 221 ASL_CV_CAPTURE_COMMENTS(walk_state); 222 223 #ifdef ACPI_ASL_COMPILER 224 if (acpi_gbl_current_inline_comment != NULL) { 225 unnamed_op->common.name_comment = 226 acpi_gbl_current_inline_comment; 227 acpi_gbl_current_inline_comment = NULL; 228 } 229 #endif 230 231 /* 232 * Make sure that we found a NAME and didn't run out of arguments 233 */ 234 if (!GET_CURRENT_ARG_TYPE(walk_state->arg_types)) { 235 return_ACPI_STATUS(AE_AML_NO_OPERAND); 236 } 237 238 /* We know that this arg is a name, move to next arg */ 239 240 INCREMENT_ARG_LIST(walk_state->arg_types); 241 242 /* 243 * Find the object. This will either insert the object into 244 * the namespace or simply look it up 245 */ 246 walk_state->op = NULL; 247 248 status = walk_state->descending_callback(walk_state, op); 249 if (ACPI_FAILURE(status)) { 250 if (status != AE_CTRL_TERMINATE) { 251 ACPI_EXCEPTION((AE_INFO, status, 252 "During name lookup/catalog")); 253 } 254 return_ACPI_STATUS(status); 255 } 256 257 if (!*op) { 258 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); 259 } 260 261 status = acpi_ps_next_parse_state(walk_state, *op, status); 262 if (ACPI_FAILURE(status)) { 263 if (status == AE_CTRL_PENDING) { 264 status = AE_CTRL_PARSE_PENDING; 265 } 266 return_ACPI_STATUS(status); 267 } 268 269 acpi_ps_append_arg(*op, unnamed_op->common.value.arg); 270 271 #ifdef ACPI_ASL_COMPILER 272 273 /* save any comments that might be associated with unnamed_op. */ 274 275 (*op)->common.inline_comment = unnamed_op->common.inline_comment; 276 (*op)->common.end_node_comment = unnamed_op->common.end_node_comment; 277 (*op)->common.close_brace_comment = 278 unnamed_op->common.close_brace_comment; 279 (*op)->common.name_comment = unnamed_op->common.name_comment; 280 (*op)->common.comment_list = unnamed_op->common.comment_list; 281 (*op)->common.end_blk_comment = unnamed_op->common.end_blk_comment; 282 (*op)->common.cv_filename = unnamed_op->common.cv_filename; 283 (*op)->common.cv_parent_filename = 284 unnamed_op->common.cv_parent_filename; 285 (*op)->named.aml = unnamed_op->common.aml; 286 287 unnamed_op->common.inline_comment = NULL; 288 unnamed_op->common.end_node_comment = NULL; 289 unnamed_op->common.close_brace_comment = NULL; 290 unnamed_op->common.name_comment = NULL; 291 unnamed_op->common.comment_list = NULL; 292 unnamed_op->common.end_blk_comment = NULL; 293 #endif 294 295 if ((*op)->common.aml_opcode == AML_REGION_OP || 296 (*op)->common.aml_opcode == AML_DATA_REGION_OP) { 297 /* 298 * Defer final parsing of an operation_region body, because we don't 299 * have enough info in the first pass to parse it correctly (i.e., 300 * there may be method calls within the term_arg elements of the body.) 301 * 302 * However, we must continue parsing because the opregion is not a 303 * standalone package -- we don't know where the end is at this point. 304 * 305 * (Length is unknown until parse of the body complete) 306 */ 307 (*op)->named.data = aml_op_start; 308 (*op)->named.length = 0; 309 } 310 311 return_ACPI_STATUS(AE_OK); 312 } 313 314 /******************************************************************************* 315 * 316 * FUNCTION: acpi_ps_create_op 317 * 318 * PARAMETERS: walk_state - Current state 319 * aml_op_start - Op start in AML 320 * new_op - Returned Op 321 * 322 * RETURN: Status 323 * 324 * DESCRIPTION: Get Op from AML 325 * 326 ******************************************************************************/ 327 328 acpi_status 329 acpi_ps_create_op(struct acpi_walk_state *walk_state, 330 u8 *aml_op_start, union acpi_parse_object **new_op) 331 { 332 acpi_status status = AE_OK; 333 union acpi_parse_object *op; 334 union acpi_parse_object *named_op = NULL; 335 union acpi_parse_object *parent_scope; 336 u8 argument_count; 337 const struct acpi_opcode_info *op_info; 338 339 ACPI_FUNCTION_TRACE_PTR(ps_create_op, walk_state); 340 341 status = acpi_ps_get_aml_opcode(walk_state); 342 if (status == AE_CTRL_PARSE_CONTINUE) { 343 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); 344 } 345 if (ACPI_FAILURE(status)) { 346 return_ACPI_STATUS(status); 347 } 348 349 /* Create Op structure and append to parent's argument list */ 350 351 walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode); 352 op = acpi_ps_alloc_op(walk_state->opcode, aml_op_start); 353 if (!op) { 354 return_ACPI_STATUS(AE_NO_MEMORY); 355 } 356 357 if (walk_state->op_info->flags & AML_NAMED) { 358 status = 359 acpi_ps_build_named_op(walk_state, aml_op_start, op, 360 &named_op); 361 acpi_ps_free_op(op); 362 if (ACPI_FAILURE(status)) { 363 return_ACPI_STATUS(status); 364 } 365 366 *new_op = named_op; 367 return_ACPI_STATUS(AE_OK); 368 } 369 370 /* Not a named opcode, just allocate Op and append to parent */ 371 372 if (walk_state->op_info->flags & AML_CREATE) { 373 /* 374 * Backup to beginning of create_XXXfield declaration 375 * body_length is unknown until we parse the body 376 */ 377 op->named.data = aml_op_start; 378 op->named.length = 0; 379 } 380 381 if (walk_state->opcode == AML_BANK_FIELD_OP) { 382 /* 383 * Backup to beginning of bank_field declaration 384 * body_length is unknown until we parse the body 385 */ 386 op->named.data = aml_op_start; 387 op->named.length = 0; 388 } 389 390 parent_scope = acpi_ps_get_parent_scope(&(walk_state->parser_state)); 391 acpi_ps_append_arg(parent_scope, op); 392 393 if (parent_scope) { 394 op_info = 395 acpi_ps_get_opcode_info(parent_scope->common.aml_opcode); 396 if (op_info->flags & AML_HAS_TARGET) { 397 argument_count = 398 acpi_ps_get_argument_count(op_info->type); 399 if (parent_scope->common.arg_list_length > 400 argument_count) { 401 op->common.flags |= ACPI_PARSEOP_TARGET; 402 } 403 } 404 405 /* 406 * Special case for both Increment() and Decrement(), where 407 * the lone argument is both a source and a target. 408 */ 409 else if ((parent_scope->common.aml_opcode == AML_INCREMENT_OP) 410 || (parent_scope->common.aml_opcode == 411 AML_DECREMENT_OP)) { 412 op->common.flags |= ACPI_PARSEOP_TARGET; 413 } 414 } 415 416 if (walk_state->descending_callback != NULL) { 417 /* 418 * Find the object. This will either insert the object into 419 * the namespace or simply look it up 420 */ 421 walk_state->op = *new_op = op; 422 423 status = walk_state->descending_callback(walk_state, &op); 424 status = acpi_ps_next_parse_state(walk_state, op, status); 425 if (status == AE_CTRL_PENDING) { 426 status = AE_CTRL_PARSE_PENDING; 427 } 428 } 429 430 return_ACPI_STATUS(status); 431 } 432 433 /******************************************************************************* 434 * 435 * FUNCTION: acpi_ps_complete_op 436 * 437 * PARAMETERS: walk_state - Current state 438 * op - Returned Op 439 * status - Parse status before complete Op 440 * 441 * RETURN: Status 442 * 443 * DESCRIPTION: Complete Op 444 * 445 ******************************************************************************/ 446 447 acpi_status 448 acpi_ps_complete_op(struct acpi_walk_state *walk_state, 449 union acpi_parse_object **op, acpi_status status) 450 { 451 acpi_status status2; 452 453 ACPI_FUNCTION_TRACE_PTR(ps_complete_op, walk_state); 454 455 /* 456 * Finished one argument of the containing scope 457 */ 458 walk_state->parser_state.scope->parse_scope.arg_count--; 459 460 /* Close this Op (will result in parse subtree deletion) */ 461 462 status2 = acpi_ps_complete_this_op(walk_state, *op); 463 if (ACPI_FAILURE(status2)) { 464 return_ACPI_STATUS(status2); 465 } 466 467 *op = NULL; 468 469 switch (status) { 470 case AE_OK: 471 472 break; 473 474 case AE_CTRL_TRANSFER: 475 476 /* We are about to transfer to a called method */ 477 478 walk_state->prev_op = NULL; 479 walk_state->prev_arg_types = walk_state->arg_types; 480 return_ACPI_STATUS(status); 481 482 case AE_CTRL_END: 483 484 acpi_ps_pop_scope(&(walk_state->parser_state), op, 485 &walk_state->arg_types, 486 &walk_state->arg_count); 487 488 if (*op) { 489 walk_state->op = *op; 490 walk_state->op_info = 491 acpi_ps_get_opcode_info((*op)->common.aml_opcode); 492 walk_state->opcode = (*op)->common.aml_opcode; 493 494 status = walk_state->ascending_callback(walk_state); 495 status = 496 acpi_ps_next_parse_state(walk_state, *op, status); 497 498 status2 = acpi_ps_complete_this_op(walk_state, *op); 499 if (ACPI_FAILURE(status2)) { 500 return_ACPI_STATUS(status2); 501 } 502 } 503 504 status = AE_OK; 505 break; 506 507 case AE_CTRL_BREAK: 508 case AE_CTRL_CONTINUE: 509 510 /* Pop off scopes until we find the While */ 511 512 while (!(*op) || ((*op)->common.aml_opcode != AML_WHILE_OP)) { 513 acpi_ps_pop_scope(&(walk_state->parser_state), op, 514 &walk_state->arg_types, 515 &walk_state->arg_count); 516 } 517 518 /* Close this iteration of the While loop */ 519 520 walk_state->op = *op; 521 walk_state->op_info = 522 acpi_ps_get_opcode_info((*op)->common.aml_opcode); 523 walk_state->opcode = (*op)->common.aml_opcode; 524 525 status = walk_state->ascending_callback(walk_state); 526 status = acpi_ps_next_parse_state(walk_state, *op, status); 527 528 status2 = acpi_ps_complete_this_op(walk_state, *op); 529 if (ACPI_FAILURE(status2)) { 530 return_ACPI_STATUS(status2); 531 } 532 533 status = AE_OK; 534 break; 535 536 case AE_CTRL_TERMINATE: 537 538 /* Clean up */ 539 do { 540 if (*op) { 541 status2 = 542 acpi_ps_complete_this_op(walk_state, *op); 543 if (ACPI_FAILURE(status2)) { 544 return_ACPI_STATUS(status2); 545 } 546 547 acpi_ut_delete_generic_state 548 (acpi_ut_pop_generic_state 549 (&walk_state->control_state)); 550 } 551 552 acpi_ps_pop_scope(&(walk_state->parser_state), op, 553 &walk_state->arg_types, 554 &walk_state->arg_count); 555 556 } while (*op); 557 558 return_ACPI_STATUS(AE_OK); 559 560 default: /* All other non-AE_OK status */ 561 562 do { 563 if (*op) { 564 status2 = 565 acpi_ps_complete_this_op(walk_state, *op); 566 if (ACPI_FAILURE(status2)) { 567 return_ACPI_STATUS(status2); 568 } 569 } 570 571 acpi_ps_pop_scope(&(walk_state->parser_state), op, 572 &walk_state->arg_types, 573 &walk_state->arg_count); 574 575 } while (*op); 576 577 #if 0 578 /* 579 * TBD: Cleanup parse ops on error 580 */ 581 if (*op == NULL) { 582 acpi_ps_pop_scope(parser_state, op, 583 &walk_state->arg_types, 584 &walk_state->arg_count); 585 } 586 #endif 587 walk_state->prev_op = NULL; 588 walk_state->prev_arg_types = walk_state->arg_types; 589 return_ACPI_STATUS(status); 590 } 591 592 /* This scope complete? */ 593 594 if (acpi_ps_has_completed_scope(&(walk_state->parser_state))) { 595 acpi_ps_pop_scope(&(walk_state->parser_state), op, 596 &walk_state->arg_types, 597 &walk_state->arg_count); 598 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Popped scope, Op=%p\n", *op)); 599 } else { 600 *op = NULL; 601 } 602 603 return_ACPI_STATUS(AE_OK); 604 } 605 606 /******************************************************************************* 607 * 608 * FUNCTION: acpi_ps_complete_final_op 609 * 610 * PARAMETERS: walk_state - Current state 611 * op - Current Op 612 * status - Current parse status before complete last 613 * Op 614 * 615 * RETURN: Status 616 * 617 * DESCRIPTION: Complete last Op. 618 * 619 ******************************************************************************/ 620 621 acpi_status 622 acpi_ps_complete_final_op(struct acpi_walk_state *walk_state, 623 union acpi_parse_object *op, acpi_status status) 624 { 625 acpi_status status2; 626 627 ACPI_FUNCTION_TRACE_PTR(ps_complete_final_op, walk_state); 628 629 /* 630 * Complete the last Op (if not completed), and clear the scope stack. 631 * It is easily possible to end an AML "package" with an unbounded number 632 * of open scopes (such as when several ASL blocks are closed with 633 * sequential closing braces). We want to terminate each one cleanly. 634 */ 635 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "AML package complete at Op %p\n", 636 op)); 637 do { 638 if (op) { 639 if (walk_state->ascending_callback != NULL) { 640 walk_state->op = op; 641 walk_state->op_info = 642 acpi_ps_get_opcode_info(op->common. 643 aml_opcode); 644 walk_state->opcode = op->common.aml_opcode; 645 646 status = 647 walk_state->ascending_callback(walk_state); 648 status = 649 acpi_ps_next_parse_state(walk_state, op, 650 status); 651 if (status == AE_CTRL_PENDING) { 652 status = 653 acpi_ps_complete_op(walk_state, &op, 654 AE_OK); 655 if (ACPI_FAILURE(status)) { 656 return_ACPI_STATUS(status); 657 } 658 } 659 660 if (status == AE_CTRL_TERMINATE) { 661 status = AE_OK; 662 663 /* Clean up */ 664 do { 665 if (op) { 666 status2 = 667 acpi_ps_complete_this_op 668 (walk_state, op); 669 if (ACPI_FAILURE 670 (status2)) { 671 return_ACPI_STATUS 672 (status2); 673 } 674 } 675 676 acpi_ps_pop_scope(& 677 (walk_state-> 678 parser_state), 679 &op, 680 &walk_state-> 681 arg_types, 682 &walk_state-> 683 arg_count); 684 685 } while (op); 686 687 return_ACPI_STATUS(status); 688 } 689 690 else if (ACPI_FAILURE(status)) { 691 692 /* First error is most important */ 693 694 (void) 695 acpi_ps_complete_this_op(walk_state, 696 op); 697 return_ACPI_STATUS(status); 698 } 699 } 700 701 status2 = acpi_ps_complete_this_op(walk_state, op); 702 if (ACPI_FAILURE(status2)) { 703 return_ACPI_STATUS(status2); 704 } 705 } 706 707 acpi_ps_pop_scope(&(walk_state->parser_state), &op, 708 &walk_state->arg_types, 709 &walk_state->arg_count); 710 711 } while (op); 712 713 return_ACPI_STATUS(status); 714 } 715