1 /******************************************************************************
2 *
3 * Module Name: utcache - local cache allocation routines
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 "acpi.h"
153 #include "accommon.h"
154
155 #define _COMPONENT ACPI_UTILITIES
156 ACPI_MODULE_NAME ("utcache")
157
158
159 #ifdef ACPI_USE_LOCAL_CACHE
160 /*******************************************************************************
161 *
162 * FUNCTION: AcpiOsCreateCache
163 *
164 * PARAMETERS: CacheName - Ascii name for the cache
165 * ObjectSize - Size of each cached object
166 * MaxDepth - Maximum depth of the cache (in objects)
167 * ReturnCache - Where the new cache object is returned
168 *
169 * RETURN: Status
170 *
171 * DESCRIPTION: Create a cache object
172 *
173 ******************************************************************************/
174
175 ACPI_STATUS
AcpiOsCreateCache(char * CacheName,UINT16 ObjectSize,UINT16 MaxDepth,ACPI_MEMORY_LIST ** ReturnCache)176 AcpiOsCreateCache (
177 char *CacheName,
178 UINT16 ObjectSize,
179 UINT16 MaxDepth,
180 ACPI_MEMORY_LIST **ReturnCache)
181 {
182 ACPI_MEMORY_LIST *Cache;
183
184
185 ACPI_FUNCTION_ENTRY ();
186
187
188 if (!CacheName || !ReturnCache || !ObjectSize)
189 {
190 return (AE_BAD_PARAMETER);
191 }
192
193 /* Create the cache object */
194
195 Cache = AcpiOsAllocate (sizeof (ACPI_MEMORY_LIST));
196 if (!Cache)
197 {
198 return (AE_NO_MEMORY);
199 }
200
201 /* Populate the cache object and return it */
202
203 memset (Cache, 0, sizeof (ACPI_MEMORY_LIST));
204 Cache->ListName = CacheName;
205 Cache->ObjectSize = ObjectSize;
206 Cache->MaxDepth = MaxDepth;
207
208 *ReturnCache = Cache;
209 return (AE_OK);
210 }
211
212
213 /*******************************************************************************
214 *
215 * FUNCTION: AcpiOsPurgeCache
216 *
217 * PARAMETERS: Cache - Handle to cache object
218 *
219 * RETURN: Status
220 *
221 * DESCRIPTION: Free all objects within the requested cache.
222 *
223 ******************************************************************************/
224
225 ACPI_STATUS
AcpiOsPurgeCache(ACPI_MEMORY_LIST * Cache)226 AcpiOsPurgeCache (
227 ACPI_MEMORY_LIST *Cache)
228 {
229 void *Next;
230 ACPI_STATUS Status;
231
232
233 ACPI_FUNCTION_ENTRY ();
234
235
236 if (!Cache)
237 {
238 return (AE_BAD_PARAMETER);
239 }
240
241 Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
242 if (ACPI_FAILURE (Status))
243 {
244 return (Status);
245 }
246
247 /* Walk the list of objects in this cache */
248
249 while (Cache->ListHead)
250 {
251 /* Delete and unlink one cached state object */
252
253 Next = ACPI_GET_DESCRIPTOR_PTR (Cache->ListHead);
254 ACPI_FREE (Cache->ListHead);
255
256 Cache->ListHead = Next;
257 Cache->CurrentDepth--;
258 }
259
260 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
261 return (AE_OK);
262 }
263
264
265 /*******************************************************************************
266 *
267 * FUNCTION: AcpiOsDeleteCache
268 *
269 * PARAMETERS: Cache - Handle to cache object
270 *
271 * RETURN: Status
272 *
273 * DESCRIPTION: Free all objects within the requested cache and delete the
274 * cache object.
275 *
276 ******************************************************************************/
277
278 ACPI_STATUS
AcpiOsDeleteCache(ACPI_MEMORY_LIST * Cache)279 AcpiOsDeleteCache (
280 ACPI_MEMORY_LIST *Cache)
281 {
282 ACPI_STATUS Status;
283
284
285 ACPI_FUNCTION_ENTRY ();
286
287
288 /* Purge all objects in the cache */
289
290 Status = AcpiOsPurgeCache (Cache);
291 if (ACPI_FAILURE (Status))
292 {
293 return (Status);
294 }
295
296 /* Now we can delete the cache object */
297
298 AcpiOsFree (Cache);
299 return (AE_OK);
300 }
301
302
303 /*******************************************************************************
304 *
305 * FUNCTION: AcpiOsReleaseObject
306 *
307 * PARAMETERS: Cache - Handle to cache object
308 * Object - The object to be released
309 *
310 * RETURN: None
311 *
312 * DESCRIPTION: Release an object to the specified cache. If cache is full,
313 * the object is deleted.
314 *
315 ******************************************************************************/
316
317 ACPI_STATUS
AcpiOsReleaseObject(ACPI_MEMORY_LIST * Cache,void * Object)318 AcpiOsReleaseObject (
319 ACPI_MEMORY_LIST *Cache,
320 void *Object)
321 {
322 ACPI_STATUS Status;
323
324
325 ACPI_FUNCTION_ENTRY ();
326
327
328 if (!Cache || !Object)
329 {
330 return (AE_BAD_PARAMETER);
331 }
332
333 /* If cache is full, just free this object */
334
335 if (Cache->CurrentDepth >= Cache->MaxDepth)
336 {
337 ACPI_FREE (Object);
338 ACPI_MEM_TRACKING (Cache->TotalFreed++);
339 }
340
341 /* Otherwise put this object back into the cache */
342
343 else
344 {
345 Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
346 if (ACPI_FAILURE (Status))
347 {
348 return (Status);
349 }
350
351 /* Mark the object as cached */
352
353 memset (Object, 0xCA, Cache->ObjectSize);
354 ACPI_SET_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_CACHED);
355
356 /* Put the object at the head of the cache list */
357
358 ACPI_SET_DESCRIPTOR_PTR (Object, Cache->ListHead);
359 Cache->ListHead = Object;
360 Cache->CurrentDepth++;
361
362 (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
363 }
364
365 return (AE_OK);
366 }
367
368
369 /*******************************************************************************
370 *
371 * FUNCTION: AcpiOsAcquireObject
372 *
373 * PARAMETERS: Cache - Handle to cache object
374 *
375 * RETURN: the acquired object. NULL on error
376 *
377 * DESCRIPTION: Get an object from the specified cache. If cache is empty,
378 * the object is allocated.
379 *
380 ******************************************************************************/
381
382 void *
AcpiOsAcquireObject(ACPI_MEMORY_LIST * Cache)383 AcpiOsAcquireObject (
384 ACPI_MEMORY_LIST *Cache)
385 {
386 ACPI_STATUS Status;
387 void *Object;
388
389
390 ACPI_FUNCTION_TRACE (OsAcquireObject);
391
392
393 if (!Cache)
394 {
395 return_PTR (NULL);
396 }
397
398 Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
399 if (ACPI_FAILURE (Status))
400 {
401 return_PTR (NULL);
402 }
403
404 ACPI_MEM_TRACKING (Cache->Requests++);
405
406 /* Check the cache first */
407
408 if (Cache->ListHead)
409 {
410 /* There is an object available, use it */
411
412 Object = Cache->ListHead;
413 Cache->ListHead = ACPI_GET_DESCRIPTOR_PTR (Object);
414
415 Cache->CurrentDepth--;
416
417 ACPI_MEM_TRACKING (Cache->Hits++);
418 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
419 "%s: Object %p from %s cache\n",
420 ACPI_GET_FUNCTION_NAME, Object, Cache->ListName));
421
422 Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
423 if (ACPI_FAILURE (Status))
424 {
425 return_PTR (NULL);
426 }
427
428 /* Clear (zero) the previously used Object */
429
430 memset (Object, 0, Cache->ObjectSize);
431 }
432 else
433 {
434 /* The cache is empty, create a new object */
435
436 ACPI_MEM_TRACKING (Cache->TotalAllocated++);
437
438 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
439 if ((Cache->TotalAllocated - Cache->TotalFreed) > Cache->MaxOccupied)
440 {
441 Cache->MaxOccupied = Cache->TotalAllocated - Cache->TotalFreed;
442 }
443 #endif
444
445 /* Avoid deadlock with ACPI_ALLOCATE_ZEROED */
446
447 Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
448 if (ACPI_FAILURE (Status))
449 {
450 return_PTR (NULL);
451 }
452
453 Object = ACPI_ALLOCATE_ZEROED (Cache->ObjectSize);
454 if (!Object)
455 {
456 return_PTR (NULL);
457 }
458 }
459
460 return_PTR (Object);
461 }
462 #endif /* ACPI_USE_LOCAL_CACHE */
463
