1 /******************************************************************************
2 *
3 * Module Name: aslprintf - ASL Printf/Fprintf macro 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 "amlcode.h"
155
156 #define _COMPONENT ACPI_COMPILER
157 ACPI_MODULE_NAME ("aslprintf")
158
159
160 /* Local prototypes */
161
162 static void
163 OpcCreateConcatenateNode (
164 ACPI_PARSE_OBJECT *Op,
165 ACPI_PARSE_OBJECT *Node);
166
167 static void
168 OpcParsePrintf (
169 ACPI_PARSE_OBJECT *Op,
170 ACPI_PARSE_OBJECT *DestOp);
171
172
173 /*******************************************************************************
174 *
175 * FUNCTION: OpcDoPrintf
176 *
177 * PARAMETERS: Op - printf parse node
178 *
179 * RETURN: None
180 *
181 * DESCRIPTION: Convert printf macro to a Store(..., Debug) AML operation.
182 *
183 ******************************************************************************/
184
185 void
OpcDoPrintf(ACPI_PARSE_OBJECT * Op)186 OpcDoPrintf (
187 ACPI_PARSE_OBJECT *Op)
188 {
189 ACPI_PARSE_OBJECT *DestOp;
190
191
192 /* Store destination is the Debug op */
193
194 DestOp = TrAllocateOp (PARSEOP_DEBUG);
195 DestOp->Asl.AmlOpcode = AML_DEBUG_OP;
196 DestOp->Asl.Parent = Op;
197 DestOp->Asl.LogicalLineNumber = Op->Asl.LogicalLineNumber;
198
199 OpcParsePrintf (Op, DestOp);
200 }
201
202
203 /*******************************************************************************
204 *
205 * FUNCTION: OpcDoFprintf
206 *
207 * PARAMETERS: Op - fprintf parse node
208 *
209 * RETURN: None
210 *
211 * DESCRIPTION: Convert fprintf macro to a Store AML operation.
212 *
213 ******************************************************************************/
214
215 void
OpcDoFprintf(ACPI_PARSE_OBJECT * Op)216 OpcDoFprintf (
217 ACPI_PARSE_OBJECT *Op)
218 {
219 ACPI_PARSE_OBJECT *DestOp;
220
221
222 /* Store destination is the first argument of fprintf */
223
224 DestOp = Op->Asl.Child;
225 Op->Asl.Child = DestOp->Asl.Next;
226 DestOp->Asl.Next = NULL;
227
228 OpcParsePrintf (Op, DestOp);
229 }
230
231
232 /*******************************************************************************
233 *
234 * FUNCTION: OpcParsePrintf
235 *
236 * PARAMETERS: Op - Printf parse node
237 * DestOp - Destination of Store operation
238 *
239 * RETURN: None
240 *
241 * DESCRIPTION: Convert printf macro to a Store AML operation. The printf
242 * macro parse tree is layed out as follows:
243 *
244 * Op - printf parse op
245 * Op->Child - Format string
246 * Op->Next - Format string arguments
247 *
248 ******************************************************************************/
249
250 static void
OpcParsePrintf(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * DestOp)251 OpcParsePrintf (
252 ACPI_PARSE_OBJECT *Op,
253 ACPI_PARSE_OBJECT *DestOp)
254 {
255 char *Format;
256 char *StartPosition = NULL;
257 ACPI_PARSE_OBJECT *ArgNode;
258 ACPI_PARSE_OBJECT *NextNode;
259 UINT32 StringLength = 0;
260 char *NewString;
261 BOOLEAN StringToProcess = FALSE;
262 ACPI_PARSE_OBJECT *NewOp;
263
264
265 /* Get format string */
266
267 Format = ACPI_CAST_PTR (char, Op->Asl.Child->Asl.Value.String);
268 ArgNode = Op->Asl.Child->Asl.Next;
269
270 /*
271 * Detach argument list so that we can use a NULL check to distinguish
272 * the first concatenation operation we need to make
273 */
274 Op->Asl.Child = NULL;
275
276 for (; *Format; ++Format)
277 {
278 if (*Format != '%')
279 {
280 if (!StringToProcess)
281 {
282 /* Mark the beginning of a string */
283
284 StartPosition = Format;
285 StringToProcess = TRUE;
286 }
287
288 ++StringLength;
289 continue;
290 }
291
292 /* Save string, if any, to new string object and concat it */
293
294 if (StringToProcess)
295 {
296 NewString = UtLocalCacheCalloc (StringLength + 1);
297 strncpy (NewString, StartPosition, StringLength);
298
299 NewOp = TrAllocateOp (PARSEOP_STRING_LITERAL);
300 NewOp->Asl.Value.String = NewString;
301 NewOp->Asl.AmlOpcode = AML_STRING_OP;
302 NewOp->Asl.AcpiBtype = ACPI_BTYPE_STRING;
303 NewOp->Asl.LogicalLineNumber = Op->Asl.LogicalLineNumber;
304
305 OpcCreateConcatenateNode(Op, NewOp);
306
307 StringLength = 0;
308 StringToProcess = FALSE;
309 }
310
311 ++Format;
312
313 /*
314 * We have a format parameter and will need an argument to go
315 * with it
316 */
317 if (!ArgNode ||
318 ArgNode->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
319 {
320 AslError(ASL_ERROR, ASL_MSG_ARG_COUNT_LO, Op, NULL);
321 return;
322 }
323
324 /*
325 * We do not support sub-specifiers of printf (flags, width,
326 * precision, length). For specifiers we only support %x/%X for
327 * hex or %s for strings. Also, %o for generic "acpi object".
328 */
329 switch (*Format)
330 {
331 case 's':
332
333 if (ArgNode->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
334 {
335 AslError(ASL_ERROR, ASL_MSG_INVALID_TYPE, ArgNode,
336 "String required");
337 return;
338 }
339
340 NextNode = ArgNode->Asl.Next;
341 ArgNode->Asl.Next = NULL;
342 OpcCreateConcatenateNode(Op, ArgNode);
343 ArgNode = NextNode;
344 continue;
345
346 case 'X':
347 case 'x':
348 case 'o':
349
350 NextNode = ArgNode->Asl.Next;
351 ArgNode->Asl.Next = NULL;
352
353 /*
354 * Append an empty string if the first argument is
355 * not a string. This will implicitly conver the 2nd
356 * concat source to a string per the ACPI specification.
357 */
358 if (!Op->Asl.Child)
359 {
360 NewOp = TrAllocateOp (PARSEOP_STRING_LITERAL);
361 NewOp->Asl.Value.String = "";
362 NewOp->Asl.AmlOpcode = AML_STRING_OP;
363 NewOp->Asl.AcpiBtype = ACPI_BTYPE_STRING;
364 NewOp->Asl.LogicalLineNumber = Op->Asl.LogicalLineNumber;
365
366 OpcCreateConcatenateNode(Op, NewOp);
367 }
368
369 OpcCreateConcatenateNode(Op, ArgNode);
370 ArgNode = NextNode;
371 break;
372
373 default:
374
375 AslError(ASL_ERROR, ASL_MSG_INVALID_OPERAND, Op,
376 "Unrecognized format specifier");
377 continue;
378 }
379 }
380
381 /* Process any remaining string */
382
383 if (StringToProcess)
384 {
385 NewString = UtLocalCacheCalloc (StringLength + 1);
386 strncpy (NewString, StartPosition, StringLength);
387
388 NewOp = TrAllocateOp (PARSEOP_STRING_LITERAL);
389 NewOp->Asl.Value.String = NewString;
390 NewOp->Asl.AcpiBtype = ACPI_BTYPE_STRING;
391 NewOp->Asl.AmlOpcode = AML_STRING_OP;
392 NewOp->Asl.LogicalLineNumber = Op->Asl.LogicalLineNumber;
393
394 OpcCreateConcatenateNode(Op, NewOp);
395 }
396
397 /*
398 * If we get here and there's no child node then Format
399 * was an empty string. Just make a no op.
400 */
401 if (!Op->Asl.Child)
402 {
403 Op->Asl.ParseOpcode = PARSEOP_NOOP;
404 AslError(ASL_WARNING, ASL_MSG_NULL_STRING, Op,
405 "Converted to NOOP");
406 return;
407 }
408
409 /* Check for erroneous extra arguments */
410
411 if (ArgNode &&
412 ArgNode->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG)
413 {
414 AslError(ASL_WARNING, ASL_MSG_ARG_COUNT_HI, ArgNode,
415 "Extra arguments ignored");
416 }
417
418 /* Change Op to a Store */
419
420 Op->Asl.ParseOpcode = PARSEOP_STORE;
421 Op->Common.AmlOpcode = AML_STORE_OP;
422 Op->Asl.CompileFlags = 0;
423
424 /* Disable further optimization */
425
426 Op->Asl.CompileFlags &= ~OP_COMPILE_TIME_CONST;
427 UtSetParseOpName (Op);
428
429 /* Set Store destination */
430
431 Op->Asl.Child->Asl.Next = DestOp;
432 }
433
434
435 /*******************************************************************************
436 *
437 * FUNCTION: OpcCreateConcatenateNode
438 *
439 * PARAMETERS: Op - Parse node
440 * Node - Parse node to be concatenated
441 *
442 * RETURN: None
443 *
444 * DESCRIPTION: Make Node the child of Op. If child node already exists, then
445 * concat child with Node and makes concat node the child of Op.
446 *
447 ******************************************************************************/
448
449 static void
OpcCreateConcatenateNode(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * Node)450 OpcCreateConcatenateNode (
451 ACPI_PARSE_OBJECT *Op,
452 ACPI_PARSE_OBJECT *Node)
453 {
454 ACPI_PARSE_OBJECT *NewConcatOp;
455
456
457 if (!Op->Asl.Child)
458 {
459 Op->Asl.Child = Node;
460 Node->Asl.Parent = Op;
461 return;
462 }
463
464 NewConcatOp = TrAllocateOp (PARSEOP_CONCATENATE);
465 NewConcatOp->Asl.AmlOpcode = AML_CONCATENATE_OP;
466 NewConcatOp->Asl.AcpiBtype = 0x7;
467 NewConcatOp->Asl.LogicalLineNumber = Op->Asl.LogicalLineNumber;
468
469 /* First arg is child of Op*/
470
471 NewConcatOp->Asl.Child = Op->Asl.Child;
472 Op->Asl.Child->Asl.Parent = NewConcatOp;
473
474 /* Second arg is Node */
475
476 NewConcatOp->Asl.Child->Asl.Next = Node;
477 Node->Asl.Parent = NewConcatOp;
478
479 /* Third arg is Zero (not used) */
480
481 NewConcatOp->Asl.Child->Asl.Next->Asl.Next =
482 TrAllocateOp (PARSEOP_ZERO);
483 NewConcatOp->Asl.Child->Asl.Next->Asl.Next->Asl.Parent =
484 NewConcatOp;
485
486 Op->Asl.Child = NewConcatOp;
487 NewConcatOp->Asl.Parent = Op;
488 }
489