1 /******************************************************************************
3 * Module Name: utcache - local cache allocation routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
117 #include "accommon.h"
119 #define _COMPONENT ACPI_UTILITIES
120 ACPI_MODULE_NAME ("utcache")
123 #ifdef ACPI_USE_LOCAL_CACHE
124 /*******************************************************************************
126 * FUNCTION: AcpiOsCreateCache
128 * PARAMETERS: CacheName - Ascii name for the cache
129 * ObjectSize - Size of each cached object
130 * MaxDepth - Maximum depth of the cache (in objects)
131 * ReturnCache - Where the new cache object is returned
135 * DESCRIPTION: Create a cache object
137 ******************************************************************************/
144 ACPI_MEMORY_LIST
**ReturnCache
)
146 ACPI_MEMORY_LIST
*Cache
;
149 ACPI_FUNCTION_ENTRY ();
152 if (!CacheName
|| !ReturnCache
|| (ObjectSize
< 16))
154 return (AE_BAD_PARAMETER
);
157 /* Create the cache object */
159 Cache
= AcpiOsAllocate (sizeof (ACPI_MEMORY_LIST
));
162 return (AE_NO_MEMORY
);
165 /* Populate the cache object and return it */
167 memset (Cache
, 0, sizeof (ACPI_MEMORY_LIST
));
168 Cache
->ListName
= CacheName
;
169 Cache
->ObjectSize
= ObjectSize
;
170 Cache
->MaxDepth
= MaxDepth
;
172 *ReturnCache
= Cache
;
177 /*******************************************************************************
179 * FUNCTION: AcpiOsPurgeCache
181 * PARAMETERS: Cache - Handle to cache object
185 * DESCRIPTION: Free all objects within the requested cache.
187 ******************************************************************************/
191 ACPI_MEMORY_LIST
*Cache
)
197 ACPI_FUNCTION_ENTRY ();
202 return (AE_BAD_PARAMETER
);
205 Status
= AcpiUtAcquireMutex (ACPI_MTX_CACHES
);
206 if (ACPI_FAILURE (Status
))
211 /* Walk the list of objects in this cache */
213 while (Cache
->ListHead
)
215 /* Delete and unlink one cached state object */
217 Next
= ACPI_GET_DESCRIPTOR_PTR (Cache
->ListHead
);
218 ACPI_FREE (Cache
->ListHead
);
220 Cache
->ListHead
= Next
;
221 Cache
->CurrentDepth
--;
224 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES
);
229 /*******************************************************************************
231 * FUNCTION: AcpiOsDeleteCache
233 * PARAMETERS: Cache - Handle to cache object
237 * DESCRIPTION: Free all objects within the requested cache and delete the
240 ******************************************************************************/
244 ACPI_MEMORY_LIST
*Cache
)
249 ACPI_FUNCTION_ENTRY ();
252 /* Purge all objects in the cache */
254 Status
= AcpiOsPurgeCache (Cache
);
255 if (ACPI_FAILURE (Status
))
260 /* Now we can delete the cache object */
267 /*******************************************************************************
269 * FUNCTION: AcpiOsReleaseObject
271 * PARAMETERS: Cache - Handle to cache object
272 * Object - The object to be released
276 * DESCRIPTION: Release an object to the specified cache. If cache is full,
277 * the object is deleted.
279 ******************************************************************************/
282 AcpiOsReleaseObject (
283 ACPI_MEMORY_LIST
*Cache
,
289 ACPI_FUNCTION_ENTRY ();
292 if (!Cache
|| !Object
)
294 return (AE_BAD_PARAMETER
);
297 /* If cache is full, just free this object */
299 if (Cache
->CurrentDepth
>= Cache
->MaxDepth
)
302 ACPI_MEM_TRACKING (Cache
->TotalFreed
++);
305 /* Otherwise put this object back into the cache */
309 Status
= AcpiUtAcquireMutex (ACPI_MTX_CACHES
);
310 if (ACPI_FAILURE (Status
))
315 /* Mark the object as cached */
317 memset (Object
, 0xCA, Cache
->ObjectSize
);
318 ACPI_SET_DESCRIPTOR_TYPE (Object
, ACPI_DESC_TYPE_CACHED
);
320 /* Put the object at the head of the cache list */
322 ACPI_SET_DESCRIPTOR_PTR (Object
, Cache
->ListHead
);
323 Cache
->ListHead
= Object
;
324 Cache
->CurrentDepth
++;
326 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES
);
333 /*******************************************************************************
335 * FUNCTION: AcpiOsAcquireObject
337 * PARAMETERS: Cache - Handle to cache object
339 * RETURN: the acquired object. NULL on error
341 * DESCRIPTION: Get an object from the specified cache. If cache is empty,
342 * the object is allocated.
344 ******************************************************************************/
347 AcpiOsAcquireObject (
348 ACPI_MEMORY_LIST
*Cache
)
354 ACPI_FUNCTION_NAME (OsAcquireObject
);
362 Status
= AcpiUtAcquireMutex (ACPI_MTX_CACHES
);
363 if (ACPI_FAILURE (Status
))
368 ACPI_MEM_TRACKING (Cache
->Requests
++);
370 /* Check the cache first */
374 /* There is an object available, use it */
376 Object
= Cache
->ListHead
;
377 Cache
->ListHead
= ACPI_GET_DESCRIPTOR_PTR (Object
);
379 Cache
->CurrentDepth
--;
381 ACPI_MEM_TRACKING (Cache
->Hits
++);
382 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
383 "Object %p from %s cache\n", Object
, Cache
->ListName
));
385 Status
= AcpiUtReleaseMutex (ACPI_MTX_CACHES
);
386 if (ACPI_FAILURE (Status
))
391 /* Clear (zero) the previously used Object */
393 memset (Object
, 0, Cache
->ObjectSize
);
397 /* The cache is empty, create a new object */
399 ACPI_MEM_TRACKING (Cache
->TotalAllocated
++);
401 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
402 if ((Cache
->TotalAllocated
- Cache
->TotalFreed
) > Cache
->MaxOccupied
)
404 Cache
->MaxOccupied
= Cache
->TotalAllocated
- Cache
->TotalFreed
;
408 /* Avoid deadlock with ACPI_ALLOCATE_ZEROED */
410 Status
= AcpiUtReleaseMutex (ACPI_MTX_CACHES
);
411 if (ACPI_FAILURE (Status
))
416 Object
= ACPI_ALLOCATE_ZEROED (Cache
->ObjectSize
);
425 #endif /* ACPI_USE_LOCAL_CACHE */