xref: /illumos-gate/usr/src/cmd/acpi/iasl/aslcache.c (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
1 /******************************************************************************
2  *
3  * Module Name: aslcache -- Local cache support for iASL
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 
154 /*
155  * Local caches. The caches are fully deleted after the compilation/disassembly
156  * of each individual input file. Thus, individual allocations from the cache
157  * memory do not need to be freed or even released back into the cache.
158  *
159  * See aslallocate.c for standard heap allocations.
160  */
161 
162 
163 /*******************************************************************************
164  *
165  * FUNCTION:    UtLocalCacheCalloc
166  *
167  * PARAMETERS:  Length              - Size of buffer requested
168  *
169  * RETURN:      Pointer to the buffer. Aborts compiler on allocation failure
170  *
171  * DESCRIPTION: Allocate a string buffer. Bypass the local
172  *              dynamic memory manager for performance reasons (This has a
173  *              major impact on the speed of the compiler.)
174  *
175  ******************************************************************************/
176 
177 char *
178 UtLocalCacheCalloc (
179     UINT32                  Length)
180 {
181     char                    *Buffer;
182     ASL_CACHE_INFO          *Cache;
183     UINT32                  CacheSize = ASL_STRING_CACHE_SIZE;
184 
185 
186     if (Length > CacheSize)
187     {
188         CacheSize = Length;
189 
190         if (Gbl_StringCacheList)
191         {
192             Cache = UtLocalCalloc (sizeof (Cache->Next) + CacheSize);
193 
194             /* Link new cache buffer just following head of list */
195 
196             Cache->Next = Gbl_StringCacheList->Next;
197             Gbl_StringCacheList->Next = Cache;
198 
199             /* Leave cache management pointers alone as they pertain to head */
200 
201             Gbl_StringCount++;
202             Gbl_StringSize += Length;
203 
204             return (Cache->Buffer);
205         }
206     }
207 
208     if ((Gbl_StringCacheNext + Length) >= Gbl_StringCacheLast)
209     {
210         /* Allocate a new buffer */
211 
212         Cache = UtLocalCalloc (sizeof (Cache->Next) + CacheSize);
213 
214         /* Link new cache buffer to head of list */
215 
216         Cache->Next = Gbl_StringCacheList;
217         Gbl_StringCacheList = Cache;
218 
219         /* Setup cache management pointers */
220 
221         Gbl_StringCacheNext = Cache->Buffer;
222         Gbl_StringCacheLast = Gbl_StringCacheNext + CacheSize;
223     }
224 
225     Gbl_StringCount++;
226     Gbl_StringSize += Length;
227 
228     Buffer = Gbl_StringCacheNext;
229     Gbl_StringCacheNext += Length;
230     return (Buffer);
231 }
232 
233 
234 /*******************************************************************************
235  *
236  * FUNCTION:    UtParseOpCacheCalloc
237  *
238  * PARAMETERS:  None
239  *
240  * RETURN:      New parse op. Aborts on allocation failure
241  *
242  * DESCRIPTION: Allocate a new parse op for the parse tree. Bypass the local
243  *              dynamic memory manager for performance reasons (This has a
244  *              major impact on the speed of the compiler.)
245  *
246  ******************************************************************************/
247 
248 ACPI_PARSE_OBJECT *
249 UtParseOpCacheCalloc (
250     void)
251 {
252     ASL_CACHE_INFO          *Cache;
253 
254 
255     if (Gbl_ParseOpCacheNext >= Gbl_ParseOpCacheLast)
256     {
257         /* Allocate a new buffer */
258 
259         Cache = UtLocalCalloc (sizeof (Cache->Next) +
260             (sizeof (ACPI_PARSE_OBJECT) * ASL_PARSEOP_CACHE_SIZE));
261 
262         /* Link new cache buffer to head of list */
263 
264         Cache->Next = Gbl_ParseOpCacheList;
265         Gbl_ParseOpCacheList = Cache;
266 
267         /* Setup cache management pointers */
268 
269         Gbl_ParseOpCacheNext = ACPI_CAST_PTR (ACPI_PARSE_OBJECT, Cache->Buffer);
270         Gbl_ParseOpCacheLast = Gbl_ParseOpCacheNext + ASL_PARSEOP_CACHE_SIZE;
271     }
272 
273     Gbl_ParseOpCount++;
274     return (Gbl_ParseOpCacheNext++);
275 }
276 
277 
278 /*******************************************************************************
279  *
280  * FUNCTION:    UtSubtableCacheCalloc - Data Table compiler
281  *
282  * PARAMETERS:  None
283  *
284  * RETURN:      Pointer to the buffer. Aborts on allocation failure
285  *
286  * DESCRIPTION: Allocate a subtable object buffer. Bypass the local
287  *              dynamic memory manager for performance reasons (This has a
288  *              major impact on the speed of the compiler.)
289  *
290  ******************************************************************************/
291 
292 DT_SUBTABLE *
293 UtSubtableCacheCalloc (
294     void)
295 {
296     ASL_CACHE_INFO          *Cache;
297 
298 
299     if (Gbl_SubtableCacheNext >= Gbl_SubtableCacheLast)
300     {
301         /* Allocate a new buffer */
302 
303         Cache = UtLocalCalloc (sizeof (Cache->Next) +
304             (sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE));
305 
306         /* Link new cache buffer to head of list */
307 
308         Cache->Next = Gbl_SubtableCacheList;
309         Gbl_SubtableCacheList = Cache;
310 
311         /* Setup cache management pointers */
312 
313         Gbl_SubtableCacheNext = ACPI_CAST_PTR (DT_SUBTABLE, Cache->Buffer);
314         Gbl_SubtableCacheLast = Gbl_SubtableCacheNext + ASL_SUBTABLE_CACHE_SIZE;
315     }
316 
317     Gbl_SubtableCount++;
318     return (Gbl_SubtableCacheNext++);
319 }
320 
321 
322 /*******************************************************************************
323  *
324  * FUNCTION:    UtFieldCacheCalloc - Data Table compiler
325  *
326  * PARAMETERS:  None
327  *
328  * RETURN:      Pointer to the buffer. Aborts on allocation failure
329  *
330  * DESCRIPTION: Allocate a field object buffer. Bypass the local
331  *              dynamic memory manager for performance reasons (This has a
332  *              major impact on the speed of the compiler.)
333  *
334  ******************************************************************************/
335 
336 DT_FIELD *
337 UtFieldCacheCalloc (
338     void)
339 {
340     ASL_CACHE_INFO          *Cache;
341 
342 
343     if (Gbl_FieldCacheNext >= Gbl_FieldCacheLast)
344     {
345         /* Allocate a new buffer */
346 
347         Cache = UtLocalCalloc (sizeof (Cache->Next) +
348             (sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE));
349 
350         /* Link new cache buffer to head of list */
351 
352         Cache->Next = Gbl_FieldCacheList;
353         Gbl_FieldCacheList = Cache;
354 
355         /* Setup cache management pointers */
356 
357         Gbl_FieldCacheNext = ACPI_CAST_PTR (DT_FIELD, Cache->Buffer);
358         Gbl_FieldCacheLast = Gbl_FieldCacheNext + ASL_FIELD_CACHE_SIZE;
359     }
360 
361     Gbl_FieldCount++;
362     return (Gbl_FieldCacheNext++);
363 }
364 
365 
366 /*******************************************************************************
367  *
368  * FUNCTION:    UtDeleteLocalCaches
369  *
370  * PARAMETERS:  None
371  *
372  * RETURN:      None
373  *
374  * DESCRIPTION: Delete all local cache buffer blocks
375  *
376  ******************************************************************************/
377 
378 void
379 UtDeleteLocalCaches (
380     void)
381 {
382     UINT32                  BufferCount;
383     ASL_CACHE_INFO          *Next;
384 
385 
386     /*
387      * Generic cache, arbitrary size allocations
388      */
389     BufferCount = 0;
390     while (Gbl_StringCacheList)
391     {
392         Next = Gbl_StringCacheList->Next;
393         ACPI_FREE (Gbl_StringCacheList);
394         Gbl_StringCacheList = Next;
395         BufferCount++;
396     }
397 
398     DbgPrint (ASL_DEBUG_OUTPUT,
399         "%u Strings (%u bytes), Buffer size: %u bytes, %u Buffers\n",
400         Gbl_StringCount, Gbl_StringSize, ASL_STRING_CACHE_SIZE, BufferCount);
401 
402     /* Reset cache globals */
403 
404     Gbl_StringSize = 0;
405     Gbl_StringCount = 0;
406     Gbl_StringCacheNext = NULL;
407     Gbl_StringCacheLast = NULL;
408 
409 
410     /*
411      * Parse Op cache
412      */
413     BufferCount = 0;
414     while (Gbl_ParseOpCacheList)
415     {
416         Next = Gbl_ParseOpCacheList->Next;
417         ACPI_FREE (Gbl_ParseOpCacheList);
418         Gbl_ParseOpCacheList = Next;
419         BufferCount++;
420     }
421 
422     DbgPrint (ASL_DEBUG_OUTPUT,
423         "%u ParseOps, Buffer size: %u ops (%u bytes), %u Buffers\n",
424         Gbl_ParseOpCount, ASL_PARSEOP_CACHE_SIZE,
425         (sizeof (ACPI_PARSE_OBJECT) * ASL_PARSEOP_CACHE_SIZE), BufferCount);
426 
427     /* Reset cache globals */
428 
429     Gbl_ParseOpCount = 0;
430     Gbl_ParseOpCacheNext = NULL;
431     Gbl_ParseOpCacheLast = NULL;
432     Gbl_ParseTreeRoot = NULL;
433 
434 
435     /*
436      * Table Compiler - Field cache
437      */
438     BufferCount = 0;
439     while (Gbl_FieldCacheList)
440     {
441         Next = Gbl_FieldCacheList->Next;
442         ACPI_FREE (Gbl_FieldCacheList);
443         Gbl_FieldCacheList = Next;
444         BufferCount++;
445     }
446 
447     DbgPrint (ASL_DEBUG_OUTPUT,
448         "%u Fields, Buffer size: %u fields (%u bytes), %u Buffers\n",
449         Gbl_FieldCount, ASL_FIELD_CACHE_SIZE,
450         (sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE), BufferCount);
451 
452     /* Reset cache globals */
453 
454     Gbl_FieldCount = 0;
455     Gbl_FieldCacheNext = NULL;
456     Gbl_FieldCacheLast = NULL;
457 
458 
459     /*
460      * Table Compiler - Subtable cache
461      */
462     BufferCount = 0;
463     while (Gbl_SubtableCacheList)
464     {
465         Next = Gbl_SubtableCacheList->Next;
466         ACPI_FREE (Gbl_SubtableCacheList);
467         Gbl_SubtableCacheList = Next;
468         BufferCount++;
469     }
470 
471     DbgPrint (ASL_DEBUG_OUTPUT,
472         "%u Subtables, Buffer size: %u subtables (%u bytes), %u Buffers\n",
473         Gbl_SubtableCount, ASL_SUBTABLE_CACHE_SIZE,
474         (sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE), BufferCount);
475 
476     /* Reset cache globals */
477 
478     Gbl_SubtableCount = 0;
479     Gbl_SubtableCacheNext = NULL;
480     Gbl_SubtableCacheLast = NULL;
481 }
482