src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utcache.c

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