sys/contrib/dev/acpica/utcache.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utcache - local cache allocation routines
   4  *              $Revision: 1.8 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #define __UTCACHE_C__
 118
 119 #include <contrib/dev/acpica/acpi.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->LinkOffset = 8;
 171     Cache->ListName   = CacheName;
 172     Cache->ObjectSize = ObjectSize;
 173     Cache->MaxDepth   = MaxDepth;
 174
 175     *ReturnCache = Cache;
 176     return (AE_OK);
 177 }
 178
 179
 180 /*******************************************************************************
 181  *
 182  * FUNCTION:    AcpiOsPurgeCache
 183  *
 184  * PARAMETERS:  Cache           - Handle to cache object
 185  *
 186  * RETURN:      Status
 187  *
 188  * DESCRIPTION: Free all objects within the requested cache.
 189  *
 190  ******************************************************************************/
 191
 192 ACPI_STATUS
 193 AcpiOsPurgeCache (
 194     ACPI_MEMORY_LIST        *Cache)
 195 {
 196     char                    *Next;
 197
 198
 199     ACPI_FUNCTION_ENTRY ();
 200
 201
 202     if (!Cache)
 203     {
 204         return (AE_BAD_PARAMETER);
 205     }
 206
 207     /* Walk the list of objects in this cache */
 208
 209     while (Cache->ListHead)
 210     {
 211         /* Delete and unlink one cached state object */
 212
 213         Next = *(ACPI_CAST_INDIRECT_PTR (char,
 214                     &(((char *) Cache->ListHead)[Cache->LinkOffset])));
 215         ACPI_FREE (Cache->ListHead);
 216
 217         Cache->ListHead = Next;
 218         Cache->CurrentDepth--;
 219     }
 220
 221     return (AE_OK);
 222 }
 223
 224
 225 /*******************************************************************************
 226  *
 227  * FUNCTION:    AcpiOsDeleteCache
 228  *
 229  * PARAMETERS:  Cache           - Handle to cache object
 230  *
 231  * RETURN:      Status
 232  *
 233  * DESCRIPTION: Free all objects within the requested cache and delete the
 234  *              cache object.
 235  *
 236  ******************************************************************************/
 237
 238 ACPI_STATUS
 239 AcpiOsDeleteCache (
 240     ACPI_MEMORY_LIST        *Cache)
 241 {
 242     ACPI_STATUS             Status;
 243
 244
 245     ACPI_FUNCTION_ENTRY ();
 246
 247
 248    /* Purge all objects in the cache */
 249
 250     Status = AcpiOsPurgeCache (Cache);
 251     if (ACPI_FAILURE (Status))
 252     {
 253         return (Status);
 254     }
 255
 256     /* Now we can delete the cache object */
 257
 258     AcpiOsFree (Cache);
 259     return (AE_OK);
 260 }
 261
 262
 263 /*******************************************************************************
 264  *
 265  * FUNCTION:    AcpiOsReleaseObject
 266  *
 267  * PARAMETERS:  Cache       - Handle to cache object
 268  *              Object      - The object to be released
 269  *
 270  * RETURN:      None
 271  *
 272  * DESCRIPTION: Release an object to the specified cache.  If cache is full,
 273  *              the object is deleted.
 274  *
 275  ******************************************************************************/
 276
 277 ACPI_STATUS
 278 AcpiOsReleaseObject (
 279     ACPI_MEMORY_LIST        *Cache,
 280     void                    *Object)
 281 {
 282     ACPI_STATUS             Status;
 283
 284
 285     ACPI_FUNCTION_ENTRY ();
 286
 287
 288     if (!Cache || !Object)
 289     {
 290         return (AE_BAD_PARAMETER);
 291     }
 292
 293     /* If cache is full, just free this object */
 294
 295     if (Cache->CurrentDepth >= Cache->MaxDepth)
 296     {
 297         ACPI_FREE (Object);
 298         ACPI_MEM_TRACKING (Cache->TotalFreed++);
 299     }
 300
 301     /* Otherwise put this object back into the cache */
 302
 303     else
 304     {
 305         Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
 306         if (ACPI_FAILURE (Status))
 307         {
 308             return (Status);
 309         }
 310
 311         /* Mark the object as cached */
 312
 313         ACPI_MEMSET (Object, 0xCA, Cache->ObjectSize);
 314         ACPI_SET_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_CACHED);
 315
 316         /* Put the object at the head of the cache list */
 317
 318         * (ACPI_CAST_INDIRECT_PTR (char,
 319             &(((char *) Object)[Cache->LinkOffset]))) = Cache->ListHead;
 320         Cache->ListHead = Object;
 321         Cache->CurrentDepth++;
 322
 323         (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
 324     }
 325
 326     return (AE_OK);
 327 }
 328
 329
 330 /*******************************************************************************
 331  *
 332  * FUNCTION:    AcpiOsAcquireObject
 333  *
 334  * PARAMETERS:  Cache           - Handle to cache object
 335  *
 336  * RETURN:      the acquired object.  NULL on error
 337  *
 338  * DESCRIPTION: Get an object from the specified cache.  If cache is empty,
 339  *              the object is allocated.
 340  *
 341  ******************************************************************************/
 342
 343 void *
 344 AcpiOsAcquireObject (
 345     ACPI_MEMORY_LIST        *Cache)
 346 {
 347     ACPI_STATUS             Status;
 348     void                    *Object;
 349
 350
 351     ACPI_FUNCTION_NAME (OsAcquireObject);
 352
 353
 354     if (!Cache)
 355     {
 356         return (NULL);
 357     }
 358
 359     Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
 360     if (ACPI_FAILURE (Status))
 361     {
 362         return (NULL);
 363     }
 364
 365     ACPI_MEM_TRACKING (Cache->Requests++);
 366
 367     /* Check the cache first */
 368
 369     if (Cache->ListHead)
 370     {
 371         /* There is an object available, use it */
 372
 373         Object = Cache->ListHead;
 374         Cache->ListHead = *(ACPI_CAST_INDIRECT_PTR (char,
 375                                 &(((char *) Object)[Cache->LinkOffset])));
 376
 377         Cache->CurrentDepth--;
 378
 379         ACPI_MEM_TRACKING (Cache->Hits++);
 380         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 381             "Object %p from %s cache\n", Object, Cache->ListName));
 382
 383         Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
 384         if (ACPI_FAILURE (Status))
 385         {
 386             return (NULL);
 387         }
 388
 389         /* Clear (zero) the previously used Object */
 390
 391         ACPI_MEMSET (Object, 0, Cache->ObjectSize);
 392     }
 393     else
 394     {
 395         /* The cache is empty, create a new object */
 396
 397         ACPI_MEM_TRACKING (Cache->TotalAllocated++);
 398
 399 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 400         if ((Cache->TotalAllocated - Cache->TotalFreed) > Cache->MaxOccupied)
 401         {
 402             Cache->MaxOccupied = Cache->TotalAllocated - Cache->TotalFreed;
 403         }
 404 #endif
 405
 406         /* Avoid deadlock with ACPI_ALLOCATE_ZEROED */
 407
 408         Status = AcpiUtReleaseMutex (ACPI_MTX_CACHES);
 409         if (ACPI_FAILURE (Status))
 410         {
 411             return (NULL);
 412         }
 413
 414         Object = ACPI_ALLOCATE_ZEROED (Cache->ObjectSize);
 415         if (!Object)
 416         {
 417             return (NULL);
 418         }
 419     }
 420
 421     return (Object);
 422 }
 423 #endif /* ACPI_USE_LOCAL_CACHE */
 424
 425