xref: /freebsd/sys/contrib/dev/acpica/compiler/aslcache.c (revision 722b16673c40aedf280895f2f2f676bb494518d7)
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 - 2023, 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 <contrib/dev/acpica/compiler/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 *
UtLocalCacheCalloc(UINT32 Length)178 UtLocalCacheCalloc (
179     UINT32                  Length)
180 {
181     char                    *Buffer;
182     ASL_CACHE_INFO          *Cache;
183     UINT32                  CacheSize = ASL_STRING_CACHE_SIZE;
184 
185 
186 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
187     /* Used for objects other than strings, so keep allocations aligned */
188     Length = ACPI_ROUND_UP_TO_NATIVE_WORD (Length);
189 #endif
190 
191     if (Length > CacheSize)
192     {
193         CacheSize = Length;
194 
195         if (AslGbl_StringCacheList)
196         {
197             Cache = UtLocalCalloc (sizeof (Cache->Next) + CacheSize);
198 
199             /* Link new cache buffer just following head of list */
200 
201             Cache->Next = AslGbl_StringCacheList->Next;
202             AslGbl_StringCacheList->Next = Cache;
203 
204             /* Leave cache management pointers alone as they pertain to head */
205 
206             AslGbl_StringCount++;
207             AslGbl_StringSize += Length;
208 
209             return (Cache->Buffer);
210         }
211     }
212 
213     if ((AslGbl_StringCacheNext + Length) >= AslGbl_StringCacheLast)
214     {
215         /* Allocate a new buffer */
216 
217         Cache = UtLocalCalloc (sizeof (Cache->Next) + CacheSize);
218 
219         /* Link new cache buffer to head of list */
220 
221         Cache->Next = AslGbl_StringCacheList;
222         AslGbl_StringCacheList = Cache;
223 
224         /* Setup cache management pointers */
225 
226         AslGbl_StringCacheNext = Cache->Buffer;
227         AslGbl_StringCacheLast = AslGbl_StringCacheNext + CacheSize;
228     }
229 
230     AslGbl_StringCount++;
231     AslGbl_StringSize += Length;
232 
233     Buffer = AslGbl_StringCacheNext;
234     AslGbl_StringCacheNext += Length;
235     return (Buffer);
236 }
237 
238 
239 /*******************************************************************************
240  *
241  * FUNCTION:    UtParseOpCacheCalloc
242  *
243  * PARAMETERS:  None
244  *
245  * RETURN:      New parse op. Aborts on allocation failure
246  *
247  * DESCRIPTION: Allocate a new parse op for the parse tree. Bypass the local
248  *              dynamic memory manager for performance reasons (This has a
249  *              major impact on the speed of the compiler.)
250  *
251  ******************************************************************************/
252 
253 ACPI_PARSE_OBJECT *
UtParseOpCacheCalloc(void)254 UtParseOpCacheCalloc (
255     void)
256 {
257     ASL_CACHE_INFO          *Cache;
258 
259 
260     if (AslGbl_ParseOpCacheNext >= AslGbl_ParseOpCacheLast)
261     {
262         /* Allocate a new buffer */
263 
264         Cache = UtLocalCalloc (sizeof (Cache->Next) +
265             (sizeof (ACPI_PARSE_OBJECT) * ASL_PARSEOP_CACHE_SIZE));
266 
267         /* Link new cache buffer to head of list */
268 
269         Cache->Next = AslGbl_ParseOpCacheList;
270         AslGbl_ParseOpCacheList = Cache;
271 
272         /* Setup cache management pointers */
273 
274         AslGbl_ParseOpCacheNext = ACPI_CAST_PTR (ACPI_PARSE_OBJECT, Cache->Buffer);
275         AslGbl_ParseOpCacheLast = AslGbl_ParseOpCacheNext + ASL_PARSEOP_CACHE_SIZE;
276     }
277 
278     AslGbl_ParseOpCount++;
279     return (AslGbl_ParseOpCacheNext++);
280 }
281 
282 
283 /*******************************************************************************
284  *
285  * FUNCTION:    UtSubtableCacheCalloc - Data Table compiler
286  *
287  * PARAMETERS:  None
288  *
289  * RETURN:      Pointer to the buffer. Aborts on allocation failure
290  *
291  * DESCRIPTION: Allocate a subtable object buffer. Bypass the local
292  *              dynamic memory manager for performance reasons (This has a
293  *              major impact on the speed of the compiler.)
294  *
295  ******************************************************************************/
296 
297 DT_SUBTABLE *
UtSubtableCacheCalloc(void)298 UtSubtableCacheCalloc (
299     void)
300 {
301     ASL_CACHE_INFO          *Cache;
302 
303 
304     if (AslGbl_SubtableCacheNext >= AslGbl_SubtableCacheLast)
305     {
306         /* Allocate a new buffer */
307 
308         Cache = UtLocalCalloc (sizeof (Cache->Next) +
309             (sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE));
310 
311         /* Link new cache buffer to head of list */
312 
313         Cache->Next = AslGbl_SubtableCacheList;
314         AslGbl_SubtableCacheList = Cache;
315 
316         /* Setup cache management pointers */
317 
318         AslGbl_SubtableCacheNext = ACPI_CAST_PTR (DT_SUBTABLE, Cache->Buffer);
319         AslGbl_SubtableCacheLast = AslGbl_SubtableCacheNext + ASL_SUBTABLE_CACHE_SIZE;
320     }
321 
322     AslGbl_SubtableCount++;
323     return (AslGbl_SubtableCacheNext++);
324 }
325 
326 
327 /*******************************************************************************
328  *
329  * FUNCTION:    UtFieldCacheCalloc - Data Table compiler
330  *
331  * PARAMETERS:  None
332  *
333  * RETURN:      Pointer to the buffer. Aborts on allocation failure
334  *
335  * DESCRIPTION: Allocate a field object buffer. Bypass the local
336  *              dynamic memory manager for performance reasons (This has a
337  *              major impact on the speed of the compiler.)
338  *
339  ******************************************************************************/
340 
341 DT_FIELD *
UtFieldCacheCalloc(void)342 UtFieldCacheCalloc (
343     void)
344 {
345     ASL_CACHE_INFO          *Cache;
346 
347 
348     if (AslGbl_FieldCacheNext >= AslGbl_FieldCacheLast)
349     {
350         /* Allocate a new buffer */
351 
352         Cache = UtLocalCalloc (sizeof (Cache->Next) +
353             (sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE));
354 
355         /* Link new cache buffer to head of list */
356 
357         Cache->Next = AslGbl_FieldCacheList;
358         AslGbl_FieldCacheList = Cache;
359 
360         /* Setup cache management pointers */
361 
362         AslGbl_FieldCacheNext = ACPI_CAST_PTR (DT_FIELD, Cache->Buffer);
363         AslGbl_FieldCacheLast =AslGbl_FieldCacheNext + ASL_FIELD_CACHE_SIZE;
364     }
365 
366     AslGbl_FieldCount++;
367     return (AslGbl_FieldCacheNext++);
368 }
369 
370 
371 /*******************************************************************************
372  *
373  * FUNCTION:    UtDeleteLocalCaches
374  *
375  * PARAMETERS:  None
376  *
377  * RETURN:      None
378  *
379  * DESCRIPTION: Delete all local cache buffer blocks
380  *
381  ******************************************************************************/
382 
383 void
UtDeleteLocalCaches(void)384 UtDeleteLocalCaches (
385     void)
386 {
387     UINT32                  BufferCount;
388     ASL_CACHE_INFO          *Next;
389 
390 
391     /*
392      * Generic cache, arbitrary size allocations
393      */
394     BufferCount = 0;
395     while (AslGbl_StringCacheList)
396     {
397         Next = AslGbl_StringCacheList->Next;
398         ACPI_FREE (AslGbl_StringCacheList);
399         AslGbl_StringCacheList = Next;
400         BufferCount++;
401     }
402 
403     DbgPrint (ASL_DEBUG_OUTPUT,
404         "%u Strings (%u bytes), Buffer size: %u bytes, %u Buffers\n",
405         AslGbl_StringCount, AslGbl_StringSize, ASL_STRING_CACHE_SIZE, BufferCount);
406 
407     /* Reset cache globals */
408 
409     AslGbl_StringSize = 0;
410     AslGbl_StringCount = 0;
411     AslGbl_StringCacheNext = NULL;
412     AslGbl_StringCacheLast = NULL;
413 
414     /*
415      * Parse Op cache
416      */
417     BufferCount = 0;
418     while (AslGbl_ParseOpCacheList)
419     {
420         Next = AslGbl_ParseOpCacheList->Next;
421         ACPI_FREE (AslGbl_ParseOpCacheList);
422         AslGbl_ParseOpCacheList = Next;
423         BufferCount++;
424     }
425 
426     DbgPrint (ASL_DEBUG_OUTPUT,
427         "%u ParseOps, Buffer size: %u ops (%u bytes), %u Buffers\n",
428         AslGbl_ParseOpCount, ASL_PARSEOP_CACHE_SIZE,
429         ((UINT32) sizeof (ACPI_PARSE_OBJECT) * ASL_PARSEOP_CACHE_SIZE), BufferCount);
430 
431     /* Reset cache globals */
432 
433     AslGbl_ParseOpCount = 0;
434     AslGbl_ParseOpCacheNext = NULL;
435     AslGbl_ParseOpCacheLast = NULL;
436     AslGbl_ParseTreeRoot = NULL;
437 
438     /*
439      * Table Compiler - Field cache
440      */
441     BufferCount = 0;
442     while (AslGbl_FieldCacheList)
443     {
444         Next = AslGbl_FieldCacheList->Next;
445         ACPI_FREE (AslGbl_FieldCacheList);
446         AslGbl_FieldCacheList = Next;
447         BufferCount++;
448     }
449 
450     DbgPrint (ASL_DEBUG_OUTPUT,
451         "%u Fields, Buffer size: %u fields (%u bytes), %u Buffers\n",
452         AslGbl_FieldCount, ASL_FIELD_CACHE_SIZE,
453         ((UINT32) sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE), BufferCount);
454 
455     /* Reset cache globals */
456 
457     AslGbl_FieldCount = 0;
458     AslGbl_FieldCacheNext = NULL;
459     AslGbl_FieldCacheLast = NULL;
460 
461     /*
462      * Table Compiler - Subtable cache
463      */
464     BufferCount = 0;
465     while (AslGbl_SubtableCacheList)
466     {
467         Next = AslGbl_SubtableCacheList->Next;
468         ACPI_FREE (AslGbl_SubtableCacheList);
469         AslGbl_SubtableCacheList = Next;
470         BufferCount++;
471     }
472 
473     DbgPrint (ASL_DEBUG_OUTPUT,
474         "%u Subtables, Buffer size: %u subtables (%u bytes), %u Buffers\n",
475         AslGbl_SubtableCount, ASL_SUBTABLE_CACHE_SIZE,
476         ((UINT32) sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE), BufferCount);
477 
478     /* Reset cache globals */
479 
480     AslGbl_SubtableCount = 0;
481     AslGbl_SubtableCacheNext = NULL;
482     AslGbl_SubtableCacheLast = NULL;
483 }
484