utcache.c revision 1.3.4.2 1 1.3.4.2 rmind /******************************************************************************
2 1.3.4.2 rmind *
3 1.3.4.2 rmind * Module Name: utcache - local cache allocation routines
4 1.3.4.2 rmind *
5 1.3.4.2 rmind *****************************************************************************/
6 1.3.4.2 rmind
7 1.3.4.2 rmind /*
8 1.3.4.2 rmind * Copyright (C) 2000 - 2011, Intel Corp.
9 1.3.4.2 rmind * All rights reserved.
10 1.3.4.2 rmind *
11 1.3.4.2 rmind * Redistribution and use in source and binary forms, with or without
12 1.3.4.2 rmind * modification, are permitted provided that the following conditions
13 1.3.4.2 rmind * are met:
14 1.3.4.2 rmind * 1. Redistributions of source code must retain the above copyright
15 1.3.4.2 rmind * notice, this list of conditions, and the following disclaimer,
16 1.3.4.2 rmind * without modification.
17 1.3.4.2 rmind * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.3.4.2 rmind * substantially similar to the "NO WARRANTY" disclaimer below
19 1.3.4.2 rmind * ("Disclaimer") and any redistribution must be conditioned upon
20 1.3.4.2 rmind * including a substantially similar Disclaimer requirement for further
21 1.3.4.2 rmind * binary redistribution.
22 1.3.4.2 rmind * 3. Neither the names of the above-listed copyright holders nor the names
23 1.3.4.2 rmind * of any contributors may be used to endorse or promote products derived
24 1.3.4.2 rmind * from this software without specific prior written permission.
25 1.3.4.2 rmind *
26 1.3.4.2 rmind * Alternatively, this software may be distributed under the terms of the
27 1.3.4.2 rmind * GNU General Public License ("GPL") version 2 as published by the Free
28 1.3.4.2 rmind * Software Foundation.
29 1.3.4.2 rmind *
30 1.3.4.2 rmind * NO WARRANTY
31 1.3.4.2 rmind * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.3.4.2 rmind * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.3.4.2 rmind * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.3.4.2 rmind * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.3.4.2 rmind * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.3.4.2 rmind * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.3.4.2 rmind * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.3.4.2 rmind * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.3.4.2 rmind * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.3.4.2 rmind * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.3.4.2 rmind * POSSIBILITY OF SUCH DAMAGES.
42 1.3.4.2 rmind */
43 1.3.4.2 rmind
44 1.3.4.2 rmind #define __UTCACHE_C__
45 1.3.4.2 rmind
46 1.3.4.2 rmind #include "acpi.h"
47 1.3.4.2 rmind #include "accommon.h"
48 1.3.4.2 rmind
49 1.3.4.2 rmind #define _COMPONENT ACPI_UTILITIES
50 1.3.4.2 rmind ACPI_MODULE_NAME ("utcache")
51 1.3.4.2 rmind
52 1.3.4.2 rmind
53 1.3.4.2 rmind #ifdef ACPI_USE_LOCAL_CACHE
54 1.3.4.2 rmind /*******************************************************************************
55 1.3.4.2 rmind *
56 1.3.4.2 rmind * FUNCTION: AcpiOsCreateCache
57 1.3.4.2 rmind *
58 1.3.4.2 rmind * PARAMETERS: CacheName - Ascii name for the cache
59 1.3.4.2 rmind * ObjectSize - Size of each cached object
60 1.3.4.2 rmind * MaxDepth - Maximum depth of the cache (in objects)
61 1.3.4.2 rmind * ReturnCache - Where the new cache object is returned
62 1.3.4.2 rmind *
63 1.3.4.2 rmind * RETURN: Status
64 1.3.4.2 rmind *
65 1.3.4.2 rmind * DESCRIPTION: Create a cache object
66 1.3.4.2 rmind *
67 1.3.4.2 rmind ******************************************************************************/
68 1.3.4.2 rmind
69 1.3.4.2 rmind ACPI_STATUS
70 1.3.4.2 rmind AcpiOsCreateCache (
71 1.3.4.2 rmind const char *CacheName,
72 1.3.4.2 rmind UINT16 ObjectSize,
73 1.3.4.2 rmind UINT16 MaxDepth,
74 1.3.4.2 rmind ACPI_MEMORY_LIST **ReturnCache)
75 1.3.4.2 rmind {
76 1.3.4.2 rmind ACPI_MEMORY_LIST *Cache;
77 1.3.4.2 rmind
78 1.3.4.2 rmind
79 1.3.4.2 rmind ACPI_FUNCTION_ENTRY ();
80 1.3.4.2 rmind
81 1.3.4.2 rmind
82 1.3.4.2 rmind if (!CacheName || !ReturnCache || (ObjectSize < 16))
83 1.3.4.2 rmind {
84 1.3.4.2 rmind return (AE_BAD_PARAMETER);
85 1.3.4.2 rmind }
86 1.3.4.2 rmind
87 1.3.4.2 rmind /* Create the cache object */
88 1.3.4.2 rmind
89 1.3.4.2 rmind Cache = AcpiOsAllocate (sizeof (ACPI_MEMORY_LIST));
90 1.3.4.2 rmind if (!Cache)
91 1.3.4.2 rmind {
92 1.3.4.2 rmind return (AE_NO_MEMORY);
93 1.3.4.2 rmind }
94 1.3.4.2 rmind
95 1.3.4.2 rmind /* Populate the cache object and return it */
96 1.3.4.2 rmind
97 1.3.4.2 rmind ACPI_MEMSET (Cache, 0, sizeof (ACPI_MEMORY_LIST));
98 1.3.4.2 rmind Cache->LinkOffset = 8;
99 1.3.4.2 rmind Cache->ListName = __UNCONST(CacheName);
100 1.3.4.2 rmind Cache->ObjectSize = ObjectSize;
101 1.3.4.2 rmind Cache->MaxDepth = MaxDepth;
102 1.3.4.2 rmind
103 1.3.4.2 rmind *ReturnCache = Cache;
104 1.3.4.2 rmind return (AE_OK);
105 1.3.4.2 rmind }
106 1.3.4.2 rmind
107 1.3.4.2 rmind
108 1.3.4.2 rmind /*******************************************************************************
109 1.3.4.2 rmind *
110 1.3.4.2 rmind * FUNCTION: AcpiOsPurgeCache
111 1.3.4.2 rmind *
112 1.3.4.2 rmind * PARAMETERS: Cache - Handle to cache object
113 1.3.4.2 rmind *
114 1.3.4.2 rmind * RETURN: Status
115 1.3.4.2 rmind *
116 1.3.4.2 rmind * DESCRIPTION: Free all objects within the requested cache.
117 1.3.4.2 rmind *
118 1.3.4.2 rmind ******************************************************************************/
119 1.3.4.2 rmind
120 1.3.4.2 rmind ACPI_STATUS
121 1.3.4.2 rmind AcpiOsPurgeCache (
122 1.3.4.2 rmind ACPI_MEMORY_LIST *Cache)
123 1.3.4.2 rmind {
124 1.3.4.2 rmind char *Next;
125 1.3.4.2 rmind ACPI_STATUS Status;
126 1.3.4.2 rmind
127 1.3.4.2 rmind
128 1.3.4.2 rmind ACPI_FUNCTION_ENTRY ();
129 1.3.4.2 rmind
130 1.3.4.2 rmind
131 1.3.4.2 rmind if (!Cache)
132 1.3.4.2 rmind {
133 1.3.4.2 rmind return (AE_BAD_PARAMETER);
134 1.3.4.2 rmind }
135 1.3.4.2 rmind
136 1.3.4.2 rmind Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
137 1.3.4.2 rmind if (ACPI_FAILURE (Status))
138 1.3.4.2 rmind {
139 1.3.4.2 rmind return (Status);
140 1.3.4.2 rmind }
141 1.3.4.2 rmind
142 1.3.4.2 rmind /* Walk the list of objects in this cache */
143 1.3.4.2 rmind
144 1.3.4.2 rmind while (Cache->ListHead)
145 1.3.4.2 rmind {
146 1.3.4.2 rmind /* Delete and unlink one cached state object */
147 1.3.4.2 rmind
148 1.3.4.2 rmind Next = *(ACPI_CAST_INDIRECT_PTR (char,
149 1.3.4.2 rmind &(((char *) Cache->ListHead)[Cache->LinkOffset])));
150 1.3.4.2 rmind ACPI_FREE (Cache->ListHead);
151 1.3.4.2 rmind
152 1.3.4.2 rmind Cache->ListHead = Next;
153 1.3.4.2 rmind Cache->CurrentDepth--;
154 1.3.4.2 rmind }
155 1.3.4.2 rmind
156 1.3.4.2 rmind (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
157 1.3.4.2 rmind return (AE_OK);
158 1.3.4.2 rmind }
159 1.3.4.2 rmind
160 1.3.4.2 rmind
161 1.3.4.2 rmind /*******************************************************************************
162 1.3.4.2 rmind *
163 1.3.4.2 rmind * FUNCTION: AcpiOsDeleteCache
164 1.3.4.2 rmind *
165 1.3.4.2 rmind * PARAMETERS: Cache - Handle to cache object
166 1.3.4.2 rmind *
167 1.3.4.2 rmind * RETURN: Status
168 1.3.4.2 rmind *
169 1.3.4.2 rmind * DESCRIPTION: Free all objects within the requested cache and delete the
170 1.3.4.2 rmind * cache object.
171 1.3.4.2 rmind *
172 1.3.4.2 rmind ******************************************************************************/
173 1.3.4.2 rmind
174 1.3.4.2 rmind ACPI_STATUS
175 1.3.4.2 rmind AcpiOsDeleteCache (
176 1.3.4.2 rmind ACPI_MEMORY_LIST *Cache)
177 1.3.4.2 rmind {
178 1.3.4.2 rmind ACPI_STATUS Status;
179 1.3.4.2 rmind
180 1.3.4.2 rmind
181 1.3.4.2 rmind ACPI_FUNCTION_ENTRY ();
182 1.3.4.2 rmind
183 1.3.4.2 rmind
184 1.3.4.2 rmind /* Purge all objects in the cache */
185 1.3.4.2 rmind
186 1.3.4.2 rmind Status = AcpiOsPurgeCache (Cache);
187 1.3.4.2 rmind if (ACPI_FAILURE (Status))
188 1.3.4.2 rmind {
189 1.3.4.2 rmind return (Status);
190 1.3.4.2 rmind }
191 1.3.4.2 rmind
192 1.3.4.2 rmind /* Now we can delete the cache object */
193 1.3.4.2 rmind
194 1.3.4.2 rmind AcpiOsFree (Cache);
195 1.3.4.2 rmind return (AE_OK);
196 1.3.4.2 rmind }
197 1.3.4.2 rmind
198 1.3.4.2 rmind
199 1.3.4.2 rmind /*******************************************************************************
200 1.3.4.2 rmind *
201 1.3.4.2 rmind * FUNCTION: AcpiOsReleaseObject
202 1.3.4.2 rmind *
203 1.3.4.2 rmind * PARAMETERS: Cache - Handle to cache object
204 1.3.4.2 rmind * Object - The object to be released
205 1.3.4.2 rmind *
206 1.3.4.2 rmind * RETURN: None
207 1.3.4.2 rmind *
208 1.3.4.2 rmind * DESCRIPTION: Release an object to the specified cache. If cache is full,
209 1.3.4.2 rmind * the object is deleted.
210 1.3.4.2 rmind *
211 1.3.4.2 rmind ******************************************************************************/
212 1.3.4.2 rmind
213 1.3.4.2 rmind ACPI_STATUS
214 1.3.4.2 rmind AcpiOsReleaseObject (
215 1.3.4.2 rmind ACPI_MEMORY_LIST *Cache,
216 1.3.4.2 rmind void *Object)
217 1.3.4.2 rmind {
218 1.3.4.2 rmind ACPI_STATUS Status;
219 1.3.4.2 rmind
220 1.3.4.2 rmind
221 1.3.4.2 rmind ACPI_FUNCTION_ENTRY ();
222 1.3.4.2 rmind
223 1.3.4.2 rmind
224 1.3.4.2 rmind if (!Cache || !Object)
225 1.3.4.2 rmind {
226 1.3.4.2 rmind return (AE_BAD_PARAMETER);
227 1.3.4.2 rmind }
228 1.3.4.2 rmind
229 1.3.4.2 rmind /* If cache is full, just free this object */
230 1.3.4.2 rmind
231 1.3.4.2 rmind if (Cache->CurrentDepth >= Cache->MaxDepth)
232 1.3.4.2 rmind {
233 1.3.4.2 rmind ACPI_FREE (Object);
234 1.3.4.2 rmind ACPI_MEM_TRACKING (Cache->TotalFreed++);
235 1.3.4.2 rmind }
236 1.3.4.2 rmind
237 1.3.4.2 rmind /* Otherwise put this object back into the cache */
238 1.3.4.2 rmind
239 1.3.4.2 rmind else
240 1.3.4.2 rmind {
241 1.3.4.2 rmind Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
242 1.3.4.2 rmind if (ACPI_FAILURE (Status))
243 1.3.4.2 rmind {
244 1.3.4.2 rmind return (Status);
245 1.3.4.2 rmind }
246 1.3.4.2 rmind
247 1.3.4.2 rmind /* Mark the object as cached */
248 1.3.4.2 rmind
249 1.3.4.2 rmind ACPI_MEMSET (Object, 0xCA, Cache->ObjectSize);
250 1.3.4.2 rmind ACPI_SET_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_CACHED);
251 1.3.4.2 rmind
252 1.3.4.2 rmind /* Put the object at the head of the cache list */
253 1.3.4.2 rmind
254 1.3.4.2 rmind * (ACPI_CAST_INDIRECT_PTR (char,
255 1.3.4.2 rmind &(((char *) Object)[Cache->LinkOffset]))) = Cache->ListHead;
256 1.3.4.2 rmind Cache->ListHead = Object;
257 1.3.4.2 rmind Cache->CurrentDepth++;
258 1.3.4.2 rmind
259 1.3.4.2 rmind (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
260 1.3.4.2 rmind }
261 1.3.4.2 rmind
262 1.3.4.2 rmind return (AE_OK);
263 1.3.4.2 rmind }
264 1.3.4.2 rmind
265 1.3.4.2 rmind
266 1.3.4.2 rmind /*******************************************************************************
267 1.3.4.2 rmind *
268 1.3.4.2 rmind * FUNCTION: AcpiOsAcquireObject
269 1.3.4.2 rmind *
270 1.3.4.2 rmind * PARAMETERS: Cache - Handle to cache object
271 1.3.4.2 rmind *
272 1.3.4.2 rmind * RETURN: the acquired object. NULL on error
273 1.3.4.2 rmind *
274 1.3.4.2 rmind * DESCRIPTION: Get an object from the specified cache. If cache is empty,
275 1.3.4.2 rmind * the object is allocated.
276 1.3.4.2 rmind *
277 1.3.4.2 rmind ******************************************************************************/
278 1.3.4.2 rmind
279 1.3.4.2 rmind void *
280 1.3.4.2 rmind AcpiOsAcquireObject (
281 1.3.4.2 rmind ACPI_MEMORY_LIST *Cache)
282 1.3.4.2 rmind {
283 1.3.4.2 rmind ACPI_STATUS Status;
284 1.3.4.2 rmind void *Object;
285 1.3.4.2 rmind
286 1.3.4.2 rmind
287 1.3.4.2 rmind ACPI_FUNCTION_NAME (OsAcquireObject);
288 1.3.4.2 rmind
289 1.3.4.2 rmind
290 1.3.4.2 rmind if (!Cache)
291 1.3.4.2 rmind {
292 1.3.4.2 rmind return (NULL);
293 1.3.4.2 rmind }
294 1.3.4.2 rmind
295 1.3.4.2 rmind Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
296 1.3.4.2 rmind if (ACPI_FAILURE (Status))
297 1.3.4.2 rmind {
298 1.3.4.2 rmind return (NULL);
299 1.3.4.2 rmind }
300 1.3.4.2 rmind
301 1.3.4.2 rmind ACPI_MEM_TRACKING (Cache->Requests++);
302 1.3.4.2 rmind
303 1.3.4.2 rmind /* Check the cache first */
304 1.3.4.2 rmind
305 1.3.4.2 rmind if (Cache->ListHead)
306 1.3.4.2 rmind {
307 1.3.4.2 rmind /* There is an object available, use it */
308 1.3.4.2 rmind
309 1.3.4.2 rmind Object = Cache->ListHead;
310 1.3.4.2 rmind Cache->ListHead = *(ACPI_CAST_INDIRECT_PTR (char,
311 1.3.4.2 rmind &(((char *) Object)[Cache->LinkOffset])));
312 1.3.4.2 rmind
313 1.3.4.2 rmind Cache->CurrentDepth--;
314 1.3.4.2 rmind
315 1.3.4.2 rmind ACPI_MEM_TRACKING (Cache->Hits++);
316 1.3.4.2 rmind ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
317 1.3.4.2 rmind "Object %p from %s cache\n", Object, Cache->ListName));
318 1.3.4.2 rmind
319 1.3.4.2 rmind Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
320 1.3.4.2 rmind if (ACPI_FAILURE (Status))
321 1.3.4.2 rmind {
322 1.3.4.2 rmind return (NULL);
323 1.3.4.2 rmind }
324 1.3.4.2 rmind
325 1.3.4.2 rmind /* Clear (zero) the previously used Object */
326 1.3.4.2 rmind
327 1.3.4.2 rmind ACPI_MEMSET (Object, 0, Cache->ObjectSize);
328 1.3.4.2 rmind }
329 1.3.4.2 rmind else
330 1.3.4.2 rmind {
331 1.3.4.2 rmind /* The cache is empty, create a new object */
332 1.3.4.2 rmind
333 1.3.4.2 rmind ACPI_MEM_TRACKING (Cache->TotalAllocated++);
334 1.3.4.2 rmind
335 1.3.4.2 rmind #ifdef ACPI_DBG_TRACK_ALLOCATIONS
336 1.3.4.2 rmind if ((Cache->TotalAllocated - Cache->TotalFreed) > Cache->MaxOccupied)
337 1.3.4.2 rmind {
338 1.3.4.2 rmind Cache->MaxOccupied = Cache->TotalAllocated - Cache->TotalFreed;
339 1.3.4.2 rmind }
340 1.3.4.2 rmind #endif
341 1.3.4.2 rmind
342 1.3.4.2 rmind /* Avoid deadlock with ACPI_ALLOCATE_ZEROED */
343 1.3.4.2 rmind
344 1.3.4.2 rmind Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
345 1.3.4.2 rmind if (ACPI_FAILURE (Status))
346 1.3.4.2 rmind {
347 1.3.4.2 rmind return (NULL);
348 1.3.4.2 rmind }
349 1.3.4.2 rmind
350 1.3.4.2 rmind Object = ACPI_ALLOCATE_ZEROED (Cache->ObjectSize);
351 1.3.4.2 rmind if (!Object)
352 1.3.4.2 rmind {
353 1.3.4.2 rmind return (NULL);
354 1.3.4.2 rmind }
355 1.3.4.2 rmind }
356 1.3.4.2 rmind
357 1.3.4.2 rmind return (Object);
358 1.3.4.2 rmind }
359 1.3.4.2 rmind #endif /* ACPI_USE_LOCAL_CACHE */
360 1.3.4.2 rmind
361 1.3.4.2 rmind
362