xref: /freebsd/sys/contrib/dev/acpica/compiler/aslallocate.c (revision f5f40dd63bc7acbb5312b26ac1ea1103c12352a6)
1 /******************************************************************************
2  *
3  * Module Name: aslallocate -- Local memory allocation
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 heap allocation wrappers. See aslcache.c for allocation from local
156  * cache allocations
157  */
158 
159 
160 /*******************************************************************************
161  *
162  * FUNCTION:    UtLocalCalloc
163  *
164  * PARAMETERS:  Size                - Bytes to be allocated
165  *
166  * RETURN:      Pointer to the allocated memory. If this function returns
167  *              (the compiler is not aborted), the pointer is guaranteed to
168  *              be valid.
169  *
170  * DESCRIPTION: Allocate zero-initialized memory. The point of this function
171  *              is to abort the compile on an allocation failure, on the
172  *              assumption that nothing more can be accomplished.
173  *
174  * NOTE:        For allocation from the local caches, see aslcache.c
175  *
176  ******************************************************************************/
177 
178 void *
179 UtLocalCalloc (
180     UINT32                  Size)
181 {
182     void                    *Allocated;
183 
184 
185     Allocated = ACPI_ALLOCATE_ZEROED (Size);
186     if (!Allocated)
187     {
188         AslCommonError (ASL_ERROR, ASL_MSG_MEMORY_ALLOCATION,
189             AslGbl_CurrentLineNumber, AslGbl_LogicalLineNumber,
190             AslGbl_InputByteCount, AslGbl_CurrentColumn,
191             AslGbl_Files[ASL_FILE_INPUT].Filename, NULL);
192 
193         CmCleanupAndExit ();
194         exit (1);
195     }
196 
197     AslGbl_TotalAllocations++;
198     AslGbl_TotalAllocated += Size;
199     return (Allocated);
200 }
201 
202 
203 /******************************************************************************
204  *
205  * FUNCTION:    UtExpandLineBuffers
206  *
207  * PARAMETERS:  None. Updates global line buffer pointers.
208  *
209  * RETURN:      None. Reallocates the global line buffers
210  *
211  * DESCRIPTION: Called if the current line buffer becomes filled. Reallocates
212  *              all global line buffers and updates AslGbl_LineBufferSize. NOTE:
213  *              Also used for the initial allocation of the buffers, when
214  *              all of the buffer pointers are NULL. Initial allocations are
215  *              of size ASL_DEFAULT_LINE_BUFFER_SIZE
216  *
217  *****************************************************************************/
218 
219 void
220 UtExpandLineBuffers (
221     void)
222 {
223     UINT32                  NewSize;
224 
225 
226     /* Attempt to double the size of all line buffers */
227 
228     NewSize = AslGbl_LineBufferSize * 2;
229     if (AslGbl_CurrentLineBuffer)
230     {
231         DbgPrint (ASL_DEBUG_OUTPUT,
232             "Increasing line buffer size from %u to %u\n",
233             AslGbl_LineBufferSize, NewSize);
234     }
235 
236     UtReallocLineBuffers (&AslGbl_CurrentLineBuffer, AslGbl_LineBufferSize, NewSize);
237     UtReallocLineBuffers (&AslGbl_MainTokenBuffer, AslGbl_LineBufferSize, NewSize);
238     UtReallocLineBuffers (&AslGbl_MacroTokenBuffer, AslGbl_LineBufferSize, NewSize);
239     UtReallocLineBuffers (&AslGbl_ExpressionTokenBuffer, AslGbl_LineBufferSize, NewSize);
240 
241     AslGbl_LineBufPtr = AslGbl_CurrentLineBuffer;
242     AslGbl_LineBufferSize = NewSize;
243 }
244 
245 
246 /******************************************************************************
247  *
248  * FUNCTION:    UtReallocLineBuffers
249  *
250  * PARAMETERS:  Buffer              - Buffer to realloc
251  *              OldSize             - Old size of Buffer
252  *              NewSize             - New size of Buffer
253  *
254  * RETURN:      none
255  *
256  * DESCRIPTION: Reallocate and initialize Buffer
257  *
258  *****************************************************************************/
259 
260 void
261 UtReallocLineBuffers (
262     char                    **Buffer,
263     UINT32                  OldSize,
264     UINT32                  NewSize)
265 {
266 
267     *Buffer = realloc (*Buffer, NewSize);
268     if (*Buffer)
269     {
270         memset (*Buffer + OldSize, 0, NewSize - OldSize);
271         return;
272     }
273 
274     printf ("Could not increase line buffer size from %u to %u\n",
275         OldSize, NewSize);
276 
277     AslError (ASL_ERROR, ASL_MSG_BUFFER_ALLOCATION, NULL, NULL);
278     AslAbort ();
279 }
280 
281 
282 /******************************************************************************
283  *
284  * FUNCTION:    UtFreeLineBuffers
285  *
286  * PARAMETERS:  None
287  *
288  * RETURN:      None
289  *
290  * DESCRIPTION: Free all line buffers
291  *
292  *****************************************************************************/
293 
294 void
295 UtFreeLineBuffers (
296     void)
297 {
298     free (AslGbl_CurrentLineBuffer);
299 
300     free (AslGbl_MainTokenBuffer);
301 
302     free (AslGbl_MacroTokenBuffer);
303 
304     free (AslGbl_MacroTokenReplaceBuffer);
305 
306     free (AslGbl_ExpressionTokenBuffer);
307 }
308