1 /****************************************************************************** 2 * 3 * Module Name: dswload - Dispatcher first pass namespace load callbacks 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2018, 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 "acdispat.h" 49 #include "acinterp.h" 50 #include "acnamesp.h" 51 52 #ifdef ACPI_ASL_COMPILER 53 #include "acdisasm.h" 54 #endif 55 56 #define _COMPONENT ACPI_DISPATCHER 57 ACPI_MODULE_NAME("dswload") 58 59 /******************************************************************************* 60 * 61 * FUNCTION: acpi_ds_init_callbacks 62 * 63 * PARAMETERS: walk_state - Current state of the parse tree walk 64 * pass_number - 1, 2, or 3 65 * 66 * RETURN: Status 67 * 68 * DESCRIPTION: Init walk state callbacks 69 * 70 ******************************************************************************/ 71 acpi_status 72 acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number) 73 { 74 75 switch (pass_number) { 76 case 0: 77 78 /* Parse only - caller will setup callbacks */ 79 80 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 | 81 ACPI_PARSE_DELETE_TREE | ACPI_PARSE_DISASSEMBLE; 82 walk_state->descending_callback = NULL; 83 walk_state->ascending_callback = NULL; 84 break; 85 86 case 1: 87 88 /* Load pass 1 */ 89 90 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 | 91 ACPI_PARSE_DELETE_TREE; 92 walk_state->descending_callback = acpi_ds_load1_begin_op; 93 walk_state->ascending_callback = acpi_ds_load1_end_op; 94 break; 95 96 case 2: 97 98 /* Load pass 2 */ 99 100 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 | 101 ACPI_PARSE_DELETE_TREE; 102 walk_state->descending_callback = acpi_ds_load2_begin_op; 103 walk_state->ascending_callback = acpi_ds_load2_end_op; 104 break; 105 106 case 3: 107 108 /* Execution pass */ 109 110 #ifndef ACPI_NO_METHOD_EXECUTION 111 walk_state->parse_flags |= ACPI_PARSE_EXECUTE | 112 ACPI_PARSE_DELETE_TREE; 113 walk_state->descending_callback = acpi_ds_exec_begin_op; 114 walk_state->ascending_callback = acpi_ds_exec_end_op; 115 #endif 116 break; 117 118 default: 119 120 return (AE_BAD_PARAMETER); 121 } 122 123 return (AE_OK); 124 } 125 126 /******************************************************************************* 127 * 128 * FUNCTION: acpi_ds_load1_begin_op 129 * 130 * PARAMETERS: walk_state - Current state of the parse tree walk 131 * out_op - Where to return op if a new one is created 132 * 133 * RETURN: Status 134 * 135 * DESCRIPTION: Descending callback used during the loading of ACPI tables. 136 * 137 ******************************************************************************/ 138 139 acpi_status 140 acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state, 141 union acpi_parse_object **out_op) 142 { 143 union acpi_parse_object *op; 144 struct acpi_namespace_node *node; 145 acpi_status status; 146 acpi_object_type object_type; 147 char *path; 148 u32 flags; 149 150 ACPI_FUNCTION_TRACE(ds_load1_begin_op); 151 152 op = walk_state->op; 153 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 154 walk_state)); 155 156 /* We are only interested in opcodes that have an associated name */ 157 158 if (op) { 159 if (!(walk_state->op_info->flags & AML_NAMED)) { 160 *out_op = op; 161 return_ACPI_STATUS(AE_OK); 162 } 163 164 /* Check if this object has already been installed in the namespace */ 165 166 if (op->common.node) { 167 *out_op = op; 168 return_ACPI_STATUS(AE_OK); 169 } 170 } 171 172 path = acpi_ps_get_next_namestring(&walk_state->parser_state); 173 174 /* Map the raw opcode into an internal object type */ 175 176 object_type = walk_state->op_info->object_type; 177 178 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 179 "State=%p Op=%p [%s]\n", walk_state, op, 180 acpi_ut_get_type_name(object_type))); 181 182 switch (walk_state->opcode) { 183 case AML_SCOPE_OP: 184 /* 185 * The target name of the Scope() operator must exist at this point so 186 * that we can actually open the scope to enter new names underneath it. 187 * Allow search-to-root for single namesegs. 188 */ 189 status = 190 acpi_ns_lookup(walk_state->scope_info, path, object_type, 191 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT, 192 walk_state, &(node)); 193 #ifdef ACPI_ASL_COMPILER 194 if (status == AE_NOT_FOUND) { 195 /* 196 * Table disassembly: 197 * Target of Scope() not found. Generate an External for it, and 198 * insert the name into the namespace. 199 */ 200 acpi_dm_add_op_to_external_list(op, path, 201 ACPI_TYPE_DEVICE, 0, 0); 202 status = 203 acpi_ns_lookup(walk_state->scope_info, path, 204 object_type, ACPI_IMODE_LOAD_PASS1, 205 ACPI_NS_SEARCH_PARENT, walk_state, 206 &node); 207 } 208 #endif 209 if (ACPI_FAILURE(status)) { 210 ACPI_ERROR_NAMESPACE(walk_state->scope_info, path, 211 status); 212 return_ACPI_STATUS(status); 213 } 214 215 /* 216 * Check to make sure that the target is 217 * one of the opcodes that actually opens a scope 218 */ 219 switch (node->type) { 220 case ACPI_TYPE_ANY: 221 case ACPI_TYPE_LOCAL_SCOPE: /* Scope */ 222 case ACPI_TYPE_DEVICE: 223 case ACPI_TYPE_POWER: 224 case ACPI_TYPE_PROCESSOR: 225 case ACPI_TYPE_THERMAL: 226 227 /* These are acceptable types */ 228 break; 229 230 case ACPI_TYPE_INTEGER: 231 case ACPI_TYPE_STRING: 232 case ACPI_TYPE_BUFFER: 233 /* 234 * These types we will allow, but we will change the type. 235 * This enables some existing code of the form: 236 * 237 * Name (DEB, 0) 238 * Scope (DEB) { ... } 239 * 240 * Note: silently change the type here. On the second pass, 241 * we will report a warning 242 */ 243 ACPI_DEBUG_PRINT((ACPI_DB_INFO, 244 "Type override - [%4.4s] had invalid type (%s) " 245 "for Scope operator, changed to type ANY\n", 246 acpi_ut_get_node_name(node), 247 acpi_ut_get_type_name(node->type))); 248 249 node->type = ACPI_TYPE_ANY; 250 walk_state->scope_info->common.value = ACPI_TYPE_ANY; 251 break; 252 253 case ACPI_TYPE_METHOD: 254 /* 255 * Allow scope change to root during execution of module-level 256 * code. Root is typed METHOD during this time. 257 */ 258 if ((node == acpi_gbl_root_node) && 259 (walk_state-> 260 parse_flags & ACPI_PARSE_MODULE_LEVEL)) { 261 break; 262 } 263 264 /*lint -fallthrough */ 265 266 default: 267 268 /* All other types are an error */ 269 270 ACPI_ERROR((AE_INFO, 271 "Invalid type (%s) for target of " 272 "Scope operator [%4.4s] (Cannot override)", 273 acpi_ut_get_type_name(node->type), 274 acpi_ut_get_node_name(node))); 275 276 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 277 } 278 break; 279 280 default: 281 /* 282 * For all other named opcodes, we will enter the name into 283 * the namespace. 284 * 285 * Setup the search flags. 286 * Since we are entering a name into the namespace, we do not want to 287 * enable the search-to-root upsearch. 288 * 289 * There are only two conditions where it is acceptable that the name 290 * already exists: 291 * 1) the Scope() operator can reopen a scoping object that was 292 * previously defined (Scope, Method, Device, etc.) 293 * 2) Whenever we are parsing a deferred opcode (op_region, Buffer, 294 * buffer_field, or Package), the name of the object is already 295 * in the namespace. 296 */ 297 if (walk_state->deferred_node) { 298 299 /* This name is already in the namespace, get the node */ 300 301 node = walk_state->deferred_node; 302 status = AE_OK; 303 break; 304 } 305 306 /* 307 * If we are executing a method, do not create any namespace objects 308 * during the load phase, only during execution. 309 */ 310 if (walk_state->method_node) { 311 node = NULL; 312 status = AE_OK; 313 break; 314 } 315 316 flags = ACPI_NS_NO_UPSEARCH; 317 if ((walk_state->opcode != AML_SCOPE_OP) && 318 (!(walk_state->parse_flags & ACPI_PARSE_DEFERRED_OP))) { 319 if (walk_state->namespace_override) { 320 flags |= ACPI_NS_OVERRIDE_IF_FOUND; 321 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 322 "[%s] Override allowed\n", 323 acpi_ut_get_type_name 324 (object_type))); 325 } else { 326 flags |= ACPI_NS_ERROR_IF_FOUND; 327 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 328 "[%s] Cannot already exist\n", 329 acpi_ut_get_type_name 330 (object_type))); 331 } 332 } else { 333 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 334 "[%s] Both Find or Create allowed\n", 335 acpi_ut_get_type_name(object_type))); 336 } 337 338 /* 339 * Enter the named type into the internal namespace. We enter the name 340 * as we go downward in the parse tree. Any necessary subobjects that 341 * involve arguments to the opcode must be created as we go back up the 342 * parse tree later. 343 */ 344 status = 345 acpi_ns_lookup(walk_state->scope_info, path, object_type, 346 ACPI_IMODE_LOAD_PASS1, flags, walk_state, 347 &node); 348 if (ACPI_FAILURE(status)) { 349 if (status == AE_ALREADY_EXISTS) { 350 351 /* The name already exists in this scope */ 352 353 if (node->flags & ANOBJ_IS_EXTERNAL) { 354 /* 355 * Allow one create on an object or segment that was 356 * previously declared External 357 */ 358 node->flags &= ~ANOBJ_IS_EXTERNAL; 359 node->type = (u8) object_type; 360 361 /* Just retyped a node, probably will need to open a scope */ 362 363 if (acpi_ns_opens_scope(object_type)) { 364 status = 365 acpi_ds_scope_stack_push 366 (node, object_type, 367 walk_state); 368 if (ACPI_FAILURE(status)) { 369 return_ACPI_STATUS 370 (status); 371 } 372 } 373 374 status = AE_OK; 375 } 376 } 377 378 if (ACPI_FAILURE(status)) { 379 ACPI_ERROR_NAMESPACE(walk_state->scope_info, 380 path, status); 381 return_ACPI_STATUS(status); 382 } 383 } 384 break; 385 } 386 387 /* Common exit */ 388 389 if (!op) { 390 391 /* Create a new op */ 392 393 op = acpi_ps_alloc_op(walk_state->opcode, walk_state->aml); 394 if (!op) { 395 return_ACPI_STATUS(AE_NO_MEMORY); 396 } 397 } 398 399 /* Initialize the op */ 400 401 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)) 402 op->named.path = path; 403 #endif 404 405 if (node) { 406 /* 407 * Put the Node in the "op" object that the parser uses, so we 408 * can get it again quickly when this scope is closed 409 */ 410 op->common.node = node; 411 op->named.name = node->name.integer; 412 } 413 414 acpi_ps_append_arg(acpi_ps_get_parent_scope(&walk_state->parser_state), 415 op); 416 *out_op = op; 417 return_ACPI_STATUS(status); 418 } 419 420 /******************************************************************************* 421 * 422 * FUNCTION: acpi_ds_load1_end_op 423 * 424 * PARAMETERS: walk_state - Current state of the parse tree walk 425 * 426 * RETURN: Status 427 * 428 * DESCRIPTION: Ascending callback used during the loading of the namespace, 429 * both control methods and everything else. 430 * 431 ******************************************************************************/ 432 433 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state) 434 { 435 union acpi_parse_object *op; 436 acpi_object_type object_type; 437 acpi_status status = AE_OK; 438 439 #ifdef ACPI_ASL_COMPILER 440 u8 param_count; 441 #endif 442 443 ACPI_FUNCTION_TRACE(ds_load1_end_op); 444 445 op = walk_state->op; 446 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 447 walk_state)); 448 449 /* We are only interested in opcodes that have an associated name */ 450 451 if (!(walk_state->op_info->flags & (AML_NAMED | AML_FIELD))) { 452 return_ACPI_STATUS(AE_OK); 453 } 454 455 /* Get the object type to determine if we should pop the scope */ 456 457 object_type = walk_state->op_info->object_type; 458 459 #ifndef ACPI_NO_METHOD_EXECUTION 460 if (walk_state->op_info->flags & AML_FIELD) { 461 /* 462 * If we are executing a method, do not create any namespace objects 463 * during the load phase, only during execution. 464 */ 465 if (!walk_state->method_node) { 466 if (walk_state->opcode == AML_FIELD_OP || 467 walk_state->opcode == AML_BANK_FIELD_OP || 468 walk_state->opcode == AML_INDEX_FIELD_OP) { 469 status = 470 acpi_ds_init_field_objects(op, walk_state); 471 } 472 } 473 return_ACPI_STATUS(status); 474 } 475 476 /* 477 * If we are executing a method, do not create any namespace objects 478 * during the load phase, only during execution. 479 */ 480 if (!walk_state->method_node) { 481 if (op->common.aml_opcode == AML_REGION_OP) { 482 status = 483 acpi_ex_create_region(op->named.data, 484 op->named.length, 485 (acpi_adr_space_type) 486 ((op->common.value.arg)-> 487 common.value.integer), 488 walk_state); 489 if (ACPI_FAILURE(status)) { 490 return_ACPI_STATUS(status); 491 } 492 } else if (op->common.aml_opcode == AML_DATA_REGION_OP) { 493 status = 494 acpi_ex_create_region(op->named.data, 495 op->named.length, 496 ACPI_ADR_SPACE_DATA_TABLE, 497 walk_state); 498 if (ACPI_FAILURE(status)) { 499 return_ACPI_STATUS(status); 500 } 501 } 502 } 503 #endif 504 505 if (op->common.aml_opcode == AML_NAME_OP) { 506 507 /* For Name opcode, get the object type from the argument */ 508 509 if (op->common.value.arg) { 510 object_type = (acpi_ps_get_opcode_info((op->common. 511 value.arg)-> 512 common. 513 aml_opcode))-> 514 object_type; 515 516 /* Set node type if we have a namespace node */ 517 518 if (op->common.node) { 519 op->common.node->type = (u8) object_type; 520 } 521 } 522 } 523 #ifdef ACPI_ASL_COMPILER 524 /* 525 * For external opcode, get the object type from the argument and 526 * get the parameter count from the argument's next. 527 */ 528 if (acpi_gbl_disasm_flag && 529 op->common.node && op->common.aml_opcode == AML_EXTERNAL_OP) { 530 /* 531 * Note, if this external is not a method 532 * Op->Common.Value.Arg->Common.Next->Common.Value.Integer == 0 533 * Therefore, param_count will be 0. 534 */ 535 param_count = 536 (u8)op->common.value.arg->common.next->common.value.integer; 537 object_type = (u8)op->common.value.arg->common.value.integer; 538 op->common.node->flags |= ANOBJ_IS_EXTERNAL; 539 op->common.node->type = (u8)object_type; 540 541 acpi_dm_create_subobject_for_external((u8)object_type, 542 &op->common.node, 543 param_count); 544 545 /* 546 * Add the external to the external list because we may be 547 * emitting code based off of the items within the external list. 548 */ 549 acpi_dm_add_op_to_external_list(op, op->named.path, 550 (u8)object_type, param_count, 551 ACPI_EXT_ORIGIN_FROM_OPCODE | 552 ACPI_EXT_RESOLVED_REFERENCE); 553 } 554 #endif 555 556 /* 557 * If we are executing a method, do not create any namespace objects 558 * during the load phase, only during execution. 559 */ 560 if (!walk_state->method_node) { 561 if (op->common.aml_opcode == AML_METHOD_OP) { 562 /* 563 * method_op pkg_length name_string method_flags term_list 564 * 565 * Note: We must create the method node/object pair as soon as we 566 * see the method declaration. This allows later pass1 parsing 567 * of invocations of the method (need to know the number of 568 * arguments.) 569 */ 570 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 571 "LOADING-Method: State=%p Op=%p NamedObj=%p\n", 572 walk_state, op, op->named.node)); 573 574 if (!acpi_ns_get_attached_object(op->named.node)) { 575 walk_state->operands[0] = 576 ACPI_CAST_PTR(void, op->named.node); 577 walk_state->num_operands = 1; 578 579 status = 580 acpi_ds_create_operands(walk_state, 581 op->common.value. 582 arg); 583 if (ACPI_SUCCESS(status)) { 584 status = 585 acpi_ex_create_method(op->named. 586 data, 587 op->named. 588 length, 589 walk_state); 590 } 591 592 walk_state->operands[0] = NULL; 593 walk_state->num_operands = 0; 594 595 if (ACPI_FAILURE(status)) { 596 return_ACPI_STATUS(status); 597 } 598 } 599 } 600 } 601 602 /* Pop the scope stack (only if loading a table) */ 603 604 if (!walk_state->method_node && 605 op->common.aml_opcode != AML_EXTERNAL_OP && 606 acpi_ns_opens_scope(object_type)) { 607 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 608 "(%s): Popping scope for Op %p\n", 609 acpi_ut_get_type_name(object_type), op)); 610 611 status = acpi_ds_scope_stack_pop(walk_state); 612 } 613 614 return_ACPI_STATUS(status); 615 } 616