1 /******************************************************************************
2 *
3 * Module Name: aslexternal - ASL External opcode compiler support
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "aslcompiler.h"
153 #include "aslcompiler.y.h"
154 #include "acparser.h"
155 #include "amlcode.h"
156 #include "acnamesp.h"
157
158
159 #define _COMPONENT ACPI_COMPILER
160 ACPI_MODULE_NAME ("aslexternal")
161
162
163 /* Local prototypes */
164
165 static void
166 ExInsertArgCount (
167 ACPI_PARSE_OBJECT *Op);
168
169 static void
170 ExMoveExternals (
171 ACPI_PARSE_OBJECT *DefinitionBlockOp);
172
173
174 /*******************************************************************************
175 *
176 * FUNCTION: ExDoExternal
177 *
178 * PARAMETERS: Op - Current Parse node
179 *
180 * RETURN: None
181 *
182 * DESCRIPTION: Add an External() definition to the global list. This list
183 * is used to generate External opcodes.
184 *
185 ******************************************************************************/
186
187 void
ExDoExternal(ACPI_PARSE_OBJECT * Op)188 ExDoExternal (
189 ACPI_PARSE_OBJECT *Op)
190 {
191 ACPI_PARSE_OBJECT *ListOp;
192 ACPI_PARSE_OBJECT *Prev;
193 ACPI_PARSE_OBJECT *Next;
194 ACPI_PARSE_OBJECT *ArgCountOp;
195
196
197 ArgCountOp = Op->Asl.Child->Asl.Next->Asl.Next;
198 ArgCountOp->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
199 ArgCountOp->Asl.ParseOpcode = PARSEOP_BYTECONST;
200 ArgCountOp->Asl.Value.Integer = 0;
201 UtSetParseOpName (ArgCountOp);
202
203 /* Create new list node of arbitrary type */
204
205 ListOp = TrAllocateOp (PARSEOP_DEFAULT_ARG);
206
207 /* Store External node as child */
208
209 ListOp->Asl.Child = Op;
210 ListOp->Asl.Next = NULL;
211
212 if (Gbl_ExternalsListHead)
213 {
214 /* Link new External to end of list */
215
216 Prev = Gbl_ExternalsListHead;
217 Next = Prev;
218 while (Next)
219 {
220 Prev = Next;
221 Next = Next->Asl.Next;
222 }
223
224 Prev->Asl.Next = ListOp;
225 }
226 else
227 {
228 Gbl_ExternalsListHead = ListOp;
229 }
230 }
231
232
233 /*******************************************************************************
234 *
235 * FUNCTION: ExInsertArgCount
236 *
237 * PARAMETERS: Op - Op for a method invocation
238 *
239 * RETURN: None
240 *
241 * DESCRIPTION: Obtain the number of arguments for a control method -- from
242 * the actual invocation.
243 *
244 ******************************************************************************/
245
246 static void
ExInsertArgCount(ACPI_PARSE_OBJECT * Op)247 ExInsertArgCount (
248 ACPI_PARSE_OBJECT *Op)
249 {
250 ACPI_PARSE_OBJECT *Next;
251 ACPI_PARSE_OBJECT *NameOp;
252 ACPI_PARSE_OBJECT *Child;
253 ACPI_PARSE_OBJECT *ArgCountOp;
254 char * ExternalName;
255 char * CallName;
256 UINT16 ArgCount = 0;
257 ACPI_STATUS Status;
258
259
260 CallName = AcpiNsGetNormalizedPathname (Op->Asl.Node, TRUE);
261
262 Next = Gbl_ExternalsListHead;
263 while (Next)
264 {
265 ArgCount = 0;
266
267 /* Skip if External node already handled */
268
269 if (Next->Asl.Child->Asl.CompileFlags & OP_VISITED)
270 {
271 Next = Next->Asl.Next;
272 continue;
273 }
274
275 NameOp = Next->Asl.Child->Asl.Child;
276 ExternalName = AcpiNsGetNormalizedPathname (NameOp->Asl.Node, TRUE);
277
278 if (strcmp (CallName, ExternalName))
279 {
280 ACPI_FREE (ExternalName);
281 Next = Next->Asl.Next;
282 continue;
283 }
284
285 Next->Asl.Child->Asl.CompileFlags |= OP_VISITED;
286
287 /*
288 * Since we will reposition Externals to the Root, set Namepath
289 * to the fully qualified name and recalculate the aml length
290 */
291 Status = UtInternalizeName (ExternalName,
292 &NameOp->Asl.Value.String);
293
294 ACPI_FREE (ExternalName);
295 if (ACPI_FAILURE (Status))
296 {
297 AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
298 NULL, "- Could not Internalize External");
299 break;
300 }
301
302 NameOp->Asl.AmlLength = strlen (NameOp->Asl.Value.String);
303
304 /* Get argument count */
305
306 Child = Op->Asl.Child;
307 while (Child)
308 {
309 ArgCount++;
310 Child = Child->Asl.Next;
311 }
312
313 /* Setup ArgCount operand */
314
315 ArgCountOp = Next->Asl.Child->Asl.Child->Asl.Next->Asl.Next;
316 ArgCountOp->Asl.Value.Integer = ArgCount;
317 break;
318 }
319
320 ACPI_FREE (CallName);
321 }
322
323
324 /*******************************************************************************
325 *
326 * FUNCTION: ExAmlExternalWalkBegin
327 *
328 * PARAMETERS: ASL_WALK_CALLBACK
329 *
330 * RETURN: None
331 *
332 * DESCRIPTION: Parse tree walk to create external opcode list for methods.
333 *
334 ******************************************************************************/
335
336 ACPI_STATUS
ExAmlExternalWalkBegin(ACPI_PARSE_OBJECT * Op,UINT32 Level,void * Context)337 ExAmlExternalWalkBegin (
338 ACPI_PARSE_OBJECT *Op,
339 UINT32 Level,
340 void *Context)
341 {
342
343 /* External list head saved in the definition block op */
344
345 if (Op->Asl.ParseOpcode == PARSEOP_DEFINITION_BLOCK)
346 {
347 Gbl_ExternalsListHead = Op->Asl.Value.Arg;
348 }
349
350 if (!Gbl_ExternalsListHead)
351 {
352 return (AE_OK);
353 }
354
355 if (Op->Asl.ParseOpcode != PARSEOP_METHODCALL)
356 {
357 return (AE_OK);
358 }
359
360 /*
361 * The NameOp child under an ExternalOp gets turned into PARSE_METHODCALL
362 * by XfNamespaceLocateBegin(). Ignore these.
363 */
364 if (Op->Asl.Parent &&
365 Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_EXTERNAL)
366 {
367 return (AE_OK);
368 }
369
370 ExInsertArgCount (Op);
371 return (AE_OK);
372 }
373
374
375 /*******************************************************************************
376 *
377 * FUNCTION: ExAmlExternalWalkEnd
378 *
379 * PARAMETERS: ASL_WALK_CALLBACK
380 *
381 * RETURN: None
382 *
383 * DESCRIPTION: Parse tree walk to create external opcode list for methods.
384 * Here, we just want to catch the case where a definition block
385 * has been completed. Then we move all of the externals into
386 * a single block in the parse tree and thus the AML code.
387 *
388 ******************************************************************************/
389
390 ACPI_STATUS
ExAmlExternalWalkEnd(ACPI_PARSE_OBJECT * Op,UINT32 Level,void * Context)391 ExAmlExternalWalkEnd (
392 ACPI_PARSE_OBJECT *Op,
393 UINT32 Level,
394 void *Context)
395 {
396
397 if (Op->Asl.ParseOpcode == PARSEOP_DEFINITION_BLOCK)
398 {
399 /*
400 * Process any existing external list. (Support for
401 * multiple definition blocks in a single file/compile)
402 */
403 ExMoveExternals (Op);
404 Gbl_ExternalsListHead = NULL;
405 }
406
407 return (AE_OK);
408 }
409
410
411 /*******************************************************************************
412 *
413 * FUNCTION: ExMoveExternals
414 *
415 * PARAMETERS: DefinitionBlockOp - Op for current definition block
416 *
417 * RETURN: None
418 *
419 * DESCRIPTION: Move all externals present in the source file into a single
420 * block of AML code, surrounded by an "If (0)" to prevent
421 * AML interpreters from attempting to execute the External
422 * opcodes.
423 *
424 ******************************************************************************/
425
426 static void
ExMoveExternals(ACPI_PARSE_OBJECT * DefinitionBlockOp)427 ExMoveExternals (
428 ACPI_PARSE_OBJECT *DefinitionBlockOp)
429 {
430 ACPI_PARSE_OBJECT *ParentOp;
431 ACPI_PARSE_OBJECT *ExternalOp;
432 ACPI_PARSE_OBJECT *PredicateOp;
433 ACPI_PARSE_OBJECT *NextOp;
434 ACPI_PARSE_OBJECT *Prev;
435 ACPI_PARSE_OBJECT *Next;
436 char *ExternalName;
437 ACPI_OBJECT_TYPE ObjType;
438 ACPI_STATUS Status;
439 UINT32 i;
440
441
442 if (!Gbl_ExternalsListHead)
443 {
444 return;
445 }
446
447 /* Remove the External nodes from the tree */
448
449 NextOp = Gbl_ExternalsListHead;
450 while (NextOp)
451 {
452 /*
453 * The External is stored in child pointer of each node in the
454 * list
455 */
456 ExternalOp = NextOp->Asl.Child;
457
458 /* Get/set the fully qualified name */
459
460 ExternalName = AcpiNsGetNormalizedPathname (ExternalOp->Asl.Node, TRUE);
461 ExternalOp->Asl.ExternalName = ExternalName;
462 ExternalOp->Asl.Namepath = ExternalName;
463
464 /* Set line numbers (for listings, etc.) */
465
466 ExternalOp->Asl.LineNumber = 0;
467 ExternalOp->Asl.LogicalLineNumber = 0;
468
469 Next = ExternalOp->Asl.Child;
470 Next->Asl.LineNumber = 0;
471 Next->Asl.LogicalLineNumber = 0;
472
473 if (Next->Asl.ParseOpcode == PARSEOP_NAMESEG)
474 {
475 Next->Asl.ParseOpcode = PARSEOP_NAMESTRING;
476 }
477
478 Next->Asl.ExternalName = ExternalName;
479 Status = UtInternalizeName (ExternalName, &Next->Asl.Value.String);
480 if (ACPI_FAILURE (Status))
481 {
482 AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
483 Next, "Could not internalize namestring");
484 return;
485 }
486
487 Next->Asl.AmlLength = strlen (Next->Asl.Value.String);
488
489 Next = Next->Asl.Next;
490 Next->Asl.LineNumber = 0;
491 Next->Asl.LogicalLineNumber = 0;
492
493 Next = Next->Asl.Next;
494 Next->Asl.LineNumber = 0;
495 Next->Asl.LogicalLineNumber = 0;
496
497 Next = Next->Asl.Next;
498 Next->Asl.LineNumber = 0;
499 Next->Asl.LogicalLineNumber = 0;
500
501 ParentOp = ExternalOp->Asl.Parent;
502 Prev = Next = ParentOp->Asl.Child;
503
504 /* Now find the External node's position in parse tree */
505
506 while (Next != ExternalOp)
507 {
508 Prev = Next;
509 Next = Next->Asl.Next;
510 }
511
512 /* Remove the External from the parse tree */
513
514 if (Prev == ExternalOp)
515 {
516 /* External was the first child node */
517
518 ParentOp->Asl.Child = ExternalOp->Asl.Next;
519 }
520
521 Prev->Asl.Next = ExternalOp->Asl.Next;
522 ExternalOp->Asl.Next = NULL;
523 ExternalOp->Asl.Parent = Gbl_ExternalsListHead;
524
525 /* Point the External to the next in the list */
526
527 if (NextOp->Asl.Next)
528 {
529 ExternalOp->Asl.Next = NextOp->Asl.Next->Asl.Child;
530 }
531
532 NextOp = NextOp->Asl.Next;
533 }
534
535 /*
536 * Loop again to remove MethodObj Externals for which
537 * a MethodCall was not found (dead external reference)
538 */
539 Prev = Gbl_ExternalsListHead->Asl.Child;
540 Next = Prev;
541 while (Next)
542 {
543 ObjType = (ACPI_OBJECT_TYPE)
544 Next->Asl.Child->Asl.Next->Asl.Value.Integer;
545
546 if (ObjType == ACPI_TYPE_METHOD &&
547 !(Next->Asl.CompileFlags & OP_VISITED))
548 {
549 if (Next == Prev)
550 {
551 Gbl_ExternalsListHead->Asl.Child = Next->Asl.Next;
552 Next->Asl.Next = NULL;
553 Prev = Gbl_ExternalsListHead->Asl.Child;
554 Next = Prev;
555 continue;
556 }
557 else
558 {
559 Prev->Asl.Next = Next->Asl.Next;
560 Next->Asl.Next = NULL;
561 Next = Prev->Asl.Next;
562 continue;
563 }
564 }
565
566 Prev = Next;
567 Next = Next->Asl.Next;
568 }
569
570 /* If list is now empty, don't bother to make If (0) block */
571
572 if (!Gbl_ExternalsListHead->Asl.Child)
573 {
574 return;
575 }
576
577 /* Convert Gbl_ExternalsListHead parent to If(). */
578
579 Gbl_ExternalsListHead->Asl.ParseOpcode = PARSEOP_IF;
580 Gbl_ExternalsListHead->Asl.AmlOpcode = AML_IF_OP;
581 Gbl_ExternalsListHead->Asl.CompileFlags = OP_AML_PACKAGE;
582 UtSetParseOpName (Gbl_ExternalsListHead);
583
584 /* Create a Zero op for the If predicate */
585
586 PredicateOp = TrAllocateOp (PARSEOP_ZERO);
587 PredicateOp->Asl.AmlOpcode = AML_ZERO_OP;
588
589 PredicateOp->Asl.Parent = Gbl_ExternalsListHead;
590 PredicateOp->Asl.Child = NULL;
591 PredicateOp->Asl.Next = Gbl_ExternalsListHead->Asl.Child;
592 Gbl_ExternalsListHead->Asl.Child = PredicateOp;
593
594 /* Set line numbers (for listings, etc.) */
595
596 Gbl_ExternalsListHead->Asl.LineNumber = 0;
597 Gbl_ExternalsListHead->Asl.LogicalLineNumber = 0;
598
599 PredicateOp->Asl.LineNumber = 0;
600 PredicateOp->Asl.LogicalLineNumber = 0;
601
602 /* Insert block back in the list */
603
604 Prev = DefinitionBlockOp->Asl.Child;
605 Next = Prev;
606
607 /* Find last default arg */
608
609 for (i = 0; i < 6; i++)
610 {
611 Prev = Next;
612 Next = Prev->Asl.Next;
613 }
614
615 if (Next)
616 {
617 /* Definition Block is not empty */
618
619 Gbl_ExternalsListHead->Asl.Next = Next;
620 }
621 else
622 {
623 /* Definition Block is empty. */
624
625 Gbl_ExternalsListHead->Asl.Next = NULL;
626 }
627
628 Prev->Asl.Next = Gbl_ExternalsListHead;
629 Gbl_ExternalsListHead->Asl.Parent = Prev->Asl.Parent;
630 }
631