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