FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/utilities/utownerid.c

     /*******************************************************************************
      *
      * Module Name: utownerid - Support for Table/Method Owner IDs
      *
      ******************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/include/acpi.h>
   #include <contrib/dev/acpica/include/accommon.h>
   #include <contrib/dev/acpica/include/acnamesp.h>
   
   
   #define _COMPONENT          ACPI_UTILITIES
           ACPI_MODULE_NAME    ("utownerid")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtAllocateOwnerId
    *
    * PARAMETERS:  OwnerId         - Where the new owner ID is returned
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
    *              track objects created by the table or method, to be deleted
    *              when the method exits or the table is unloaded.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiUtAllocateOwnerId (
       ACPI_OWNER_ID           *OwnerId)
   {
       UINT32                  i;
       UINT32                  j;
       UINT32                  k;
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE (UtAllocateOwnerId);
   
   
       /* Guard against multiple allocations of ID to the same location */
   
       if (*OwnerId)
       {
           ACPI_ERROR ((AE_INFO,
               "Owner ID [0x%3.3X] already exists", *OwnerId));
           return_ACPI_STATUS (AE_ALREADY_EXISTS);
       }
   
       /* Mutex for the global ID mask */
   
       Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
       if (ACPI_FAILURE (Status))
       {
           return_ACPI_STATUS (Status);
       }
   
       /*
        * Find a free owner ID, cycle through all possible IDs on repeated
        * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index
        * may have to be scanned twice.
        */
       for (i = 0, j = AcpiGbl_LastOwnerIdIndex;
            i < (ACPI_NUM_OWNERID_MASKS + 1);
            i++, j++)
       {
           if (j >= ACPI_NUM_OWNERID_MASKS)
           {
               j = 0;  /* Wraparound to start of mask array */
           }
   
           for (k = AcpiGbl_NextOwnerIdOffset; k < 32; k++)
           {
               if (AcpiGbl_OwnerIdMask[j] == ACPI_UINT32_MAX)
               {
                   /* There are no free IDs in this mask */
   
                   break;
               }
   
               /*
                * Note: the UINT32 cast ensures that 1 is stored as a unsigned
                * integer. Omitting the cast may result in 1 being stored as an
                * int. Some compilers or runtime error detection may flag this as
                * an error.
                */
               if (!(AcpiGbl_OwnerIdMask[j] & ((UINT32) 1 << k)))
               {
                   /*
                    * Found a free ID. The actual ID is the bit index plus one,
                    * making zero an invalid Owner ID. Save this as the last ID
                    * allocated and update the global ID mask.
                    */
                   AcpiGbl_OwnerIdMask[j] |= ((UINT32) 1 << k);
   
                   AcpiGbl_LastOwnerIdIndex = (UINT8) j;
                   AcpiGbl_NextOwnerIdOffset = (UINT8) (k + 1);
   
                   /*
                    * Construct encoded ID from the index and bit position
                    *
                    * Note: Last [j].k (bit 4095) is never used and is marked
                    * permanently allocated (prevents +1 overflow)
                    */
                   *OwnerId = (ACPI_OWNER_ID) ((k + 1) + ACPI_MUL_32 (j));
   
                   ACPI_DEBUG_PRINT ((ACPI_DB_VALUES,
                       "Allocated OwnerId: 0x%3.3X\n", (unsigned int) *OwnerId));
                   goto Exit;
               }
           }
   
           AcpiGbl_NextOwnerIdOffset = 0;
       }
   
       /*
        * All OwnerIds have been allocated. This typically should
        * not happen since the IDs are reused after deallocation. The IDs are
        * allocated upon table load (one per table) and method execution, and
        * they are released when a table is unloaded or a method completes
        * execution.
        *
        * If this error happens, there may be very deep nesting of invoked
        * control methods, or there may be a bug where the IDs are not released.
        */
       Status = AE_OWNER_ID_LIMIT;
       ACPI_ERROR ((AE_INFO,
           "Could not allocate new OwnerId (4095 max), AE_OWNER_ID_LIMIT"));
   
   Exit:
       (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtReleaseOwnerId
    *
    * PARAMETERS:  OwnerIdPtr          - Pointer to a previously allocated OwnerID
    *
    * RETURN:      None. No error is returned because we are either exiting a
    *              control method or unloading a table. Either way, we would
    *              ignore any error anyway.
    *
    * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255
    *
    ******************************************************************************/
   
   void
   AcpiUtReleaseOwnerId (
       ACPI_OWNER_ID           *OwnerIdPtr)
   {
       ACPI_OWNER_ID           OwnerId = *OwnerIdPtr;
       ACPI_STATUS             Status;
       UINT32                  Index;
       UINT32                  Bit;
   
   
       ACPI_FUNCTION_TRACE_U32 (UtReleaseOwnerId, OwnerId);
   
   
       /* Always clear the input OwnerId (zero is an invalid ID) */
   
       *OwnerIdPtr = 0;
   
       /* Zero is not a valid OwnerID */
   
       if (OwnerId == 0)
       {
           ACPI_ERROR ((AE_INFO, "Invalid OwnerId: 0x%3.3X", OwnerId));
           return_VOID;
       }
   
       /* Mutex for the global ID mask */
   
       Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
       if (ACPI_FAILURE (Status))
       {
           return_VOID;
       }
   
       /* Normalize the ID to zero */
   
       OwnerId--;
   
       /* Decode ID to index/offset pair */
   
       Index = ACPI_DIV_32 (OwnerId);
       Bit = (UINT32) 1 << ACPI_MOD_32 (OwnerId);
   
       /* Free the owner ID only if it is valid */
   
       if (AcpiGbl_OwnerIdMask[Index] & Bit)
       {
           AcpiGbl_OwnerIdMask[Index] ^= Bit;
       }
       else
       {
           ACPI_ERROR ((AE_INFO,
               "Attempted release of non-allocated OwnerId: 0x%3.3X", OwnerId + 1));
       }
   
       (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
       return_VOID;
   }

Cache object: f5f37aae94000e9a0096665ded899ba2