xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utalloc.c (revision d64b771b96050fca8ff1859daa5ec44ff3493af7)
1 /******************************************************************************
2  *
3  * Module Name: utalloc - local memory allocation routines
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2014, 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 #define __UTALLOC_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acdebug.h"
121 
122 #define _COMPONENT          ACPI_UTILITIES
123         ACPI_MODULE_NAME    ("utalloc")
124 
125 
126 #if !defined (USE_NATIVE_ALLOCATE_ZEROED)
127 /*******************************************************************************
128  *
129  * FUNCTION:    AcpiOsAllocateZeroed
130  *
131  * PARAMETERS:  Size                - Size of the allocation
132  *
133  * RETURN:      Address of the allocated memory on success, NULL on failure.
134  *
135  * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
136  *              This is the default implementation. Can be overridden via the
137  *              USE_NATIVE_ALLOCATE_ZEROED flag.
138  *
139  ******************************************************************************/
140 
141 void *
142 AcpiOsAllocateZeroed (
143     ACPI_SIZE               Size)
144 {
145     void                    *Allocation;
146 
147 
148     ACPI_FUNCTION_ENTRY ();
149 
150 
151     Allocation = AcpiOsAllocate (Size);
152     if (Allocation)
153     {
154         /* Clear the memory block */
155 
156         ACPI_MEMSET (Allocation, 0, Size);
157     }
158 
159     return (Allocation);
160 }
161 
162 #endif /* !USE_NATIVE_ALLOCATE_ZEROED */
163 
164 
165 /*******************************************************************************
166  *
167  * FUNCTION:    AcpiUtCreateCaches
168  *
169  * PARAMETERS:  None
170  *
171  * RETURN:      Status
172  *
173  * DESCRIPTION: Create all local caches
174  *
175  ******************************************************************************/
176 
177 ACPI_STATUS
178 AcpiUtCreateCaches (
179     void)
180 {
181     ACPI_STATUS             Status;
182 
183 
184     /* Object Caches, for frequently used objects */
185 
186     Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
187                 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
188     if (ACPI_FAILURE (Status))
189     {
190         return (Status);
191     }
192 
193     Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
194                 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
195     if (ACPI_FAILURE (Status))
196     {
197         return (Status);
198     }
199 
200     Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
201                 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
202     if (ACPI_FAILURE (Status))
203     {
204         return (Status);
205     }
206 
207     Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
208                 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
209     if (ACPI_FAILURE (Status))
210     {
211         return (Status);
212     }
213 
214     Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
215                 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
216     if (ACPI_FAILURE (Status))
217     {
218         return (Status);
219     }
220 
221 
222 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
223 
224     /* Memory allocation lists */
225 
226     Status = AcpiUtCreateList ("Acpi-Global", 0,
227                 &AcpiGbl_GlobalList);
228     if (ACPI_FAILURE (Status))
229     {
230         return (Status);
231     }
232 
233     Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
234                 &AcpiGbl_NsNodeList);
235     if (ACPI_FAILURE (Status))
236     {
237         return (Status);
238     }
239 #endif
240 
241     return (AE_OK);
242 }
243 
244 
245 /*******************************************************************************
246  *
247  * FUNCTION:    AcpiUtDeleteCaches
248  *
249  * PARAMETERS:  None
250  *
251  * RETURN:      Status
252  *
253  * DESCRIPTION: Purge and delete all local caches
254  *
255  ******************************************************************************/
256 
257 ACPI_STATUS
258 AcpiUtDeleteCaches (
259     void)
260 {
261 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
262     char                    Buffer[7];
263 
264     if (AcpiGbl_DisplayFinalMemStats)
265     {
266         ACPI_STRCPY (Buffer, "MEMORY");
267         (void) AcpiDbDisplayStatistics (Buffer);
268     }
269 #endif
270 
271     (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
272     AcpiGbl_NamespaceCache = NULL;
273 
274     (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
275     AcpiGbl_StateCache = NULL;
276 
277     (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
278     AcpiGbl_OperandCache = NULL;
279 
280     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
281     AcpiGbl_PsNodeCache = NULL;
282 
283     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
284     AcpiGbl_PsNodeExtCache = NULL;
285 
286 
287 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
288 
289     /* Debug only - display leftover memory allocation, if any */
290 
291     AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
292 
293     /* Free memory lists */
294 
295     AcpiOsFree (AcpiGbl_GlobalList);
296     AcpiGbl_GlobalList = NULL;
297 
298     AcpiOsFree (AcpiGbl_NsNodeList);
299     AcpiGbl_NsNodeList = NULL;
300 #endif
301 
302     return (AE_OK);
303 }
304 
305 
306 /*******************************************************************************
307  *
308  * FUNCTION:    AcpiUtValidateBuffer
309  *
310  * PARAMETERS:  Buffer              - Buffer descriptor to be validated
311  *
312  * RETURN:      Status
313  *
314  * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
315  *
316  ******************************************************************************/
317 
318 ACPI_STATUS
319 AcpiUtValidateBuffer (
320     ACPI_BUFFER             *Buffer)
321 {
322 
323     /* Obviously, the structure pointer must be valid */
324 
325     if (!Buffer)
326     {
327         return (AE_BAD_PARAMETER);
328     }
329 
330     /* Special semantics for the length */
331 
332     if ((Buffer->Length == ACPI_NO_BUFFER)              ||
333         (Buffer->Length == ACPI_ALLOCATE_BUFFER)        ||
334         (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
335     {
336         return (AE_OK);
337     }
338 
339     /* Length is valid, the buffer pointer must be also */
340 
341     if (!Buffer->Pointer)
342     {
343         return (AE_BAD_PARAMETER);
344     }
345 
346     return (AE_OK);
347 }
348 
349 
350 /*******************************************************************************
351  *
352  * FUNCTION:    AcpiUtInitializeBuffer
353  *
354  * PARAMETERS:  Buffer              - Buffer to be validated
355  *              RequiredLength      - Length needed
356  *
357  * RETURN:      Status
358  *
359  * DESCRIPTION: Validate that the buffer is of the required length or
360  *              allocate a new buffer. Returned buffer is always zeroed.
361  *
362  ******************************************************************************/
363 
364 ACPI_STATUS
365 AcpiUtInitializeBuffer (
366     ACPI_BUFFER             *Buffer,
367     ACPI_SIZE               RequiredLength)
368 {
369     ACPI_SIZE               InputBufferLength;
370 
371 
372     /* Parameter validation */
373 
374     if (!Buffer || !RequiredLength)
375     {
376         return (AE_BAD_PARAMETER);
377     }
378 
379     /*
380      * Buffer->Length is used as both an input and output parameter. Get the
381      * input actual length and set the output required buffer length.
382      */
383     InputBufferLength = Buffer->Length;
384     Buffer->Length = RequiredLength;
385 
386     /*
387      * The input buffer length contains the actual buffer length, or the type
388      * of buffer to be allocated by this routine.
389      */
390     switch (InputBufferLength)
391     {
392     case ACPI_NO_BUFFER:
393 
394         /* Return the exception (and the required buffer length) */
395 
396         return (AE_BUFFER_OVERFLOW);
397 
398     case ACPI_ALLOCATE_BUFFER:
399         /*
400          * Allocate a new buffer. We directectly call AcpiOsAllocate here to
401          * purposefully bypass the (optionally enabled) internal allocation
402          * tracking mechanism since we only want to track internal
403          * allocations. Note: The caller should use AcpiOsFree to free this
404          * buffer created via ACPI_ALLOCATE_BUFFER.
405          */
406         Buffer->Pointer = AcpiOsAllocate (RequiredLength);
407         break;
408 
409     case ACPI_ALLOCATE_LOCAL_BUFFER:
410 
411         /* Allocate a new buffer with local interface to allow tracking */
412 
413         Buffer->Pointer = ACPI_ALLOCATE (RequiredLength);
414         break;
415 
416     default:
417 
418         /* Existing buffer: Validate the size of the buffer */
419 
420         if (InputBufferLength < RequiredLength)
421         {
422             return (AE_BUFFER_OVERFLOW);
423         }
424         break;
425     }
426 
427     /* Validate allocation from above or input buffer pointer */
428 
429     if (!Buffer->Pointer)
430     {
431         return (AE_NO_MEMORY);
432     }
433 
434     /* Have a valid buffer, clear it */
435 
436     ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
437     return (AE_OK);
438 }
439