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