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