FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/parser/psutils.c

     /******************************************************************************
      *
      * Module Name: psutils - Parser miscellaneous utilities (Parser only)
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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/acparser.h>
   #include <contrib/dev/acpica/include/amlcode.h>
   #include <contrib/dev/acpica/include/acconvert.h>
   
   #define _COMPONENT          ACPI_PARSER
           ACPI_MODULE_NAME    ("psutils")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiPsCreateScopeOp
    *
    * PARAMETERS:  None
    *
    * RETURN:      A new Scope object, null on failure
    *
    * DESCRIPTION: Create a Scope and associated namepath op with the root name
    *
    ******************************************************************************/
   
   ACPI_PARSE_OBJECT *
   AcpiPsCreateScopeOp (
       UINT8                   *Aml)
   {
       ACPI_PARSE_OBJECT       *ScopeOp;
   
   
       ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
       if (!ScopeOp)
       {
           return (NULL);
       }
   
       ScopeOp->Named.Name = ACPI_ROOT_NAME;
       return (ScopeOp);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiPsInitOp
    *
    * PARAMETERS:  Op              - A newly allocated Op object
    *              Opcode          - Opcode to store in the Op
    *
    * RETURN:      None
    *
    * DESCRIPTION: Initialize a parse (Op) object
    *
    ******************************************************************************/
   
   void
   AcpiPsInitOp (
       ACPI_PARSE_OBJECT       *Op,
       UINT16                  Opcode)
   {
       ACPI_FUNCTION_ENTRY ();
   
   
       Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
       Op->Common.AmlOpcode = Opcode;
   
       ACPI_DISASM_ONLY_MEMBERS (AcpiUtSafeStrncpy (Op->Common.AmlOpName,
           (AcpiPsGetOpcodeInfo (Opcode))->Name,
           sizeof (Op->Common.AmlOpName)));
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiPsAllocOp
    *
    * PARAMETERS:  Opcode          - Opcode that will be stored in the new Op
    *              Aml             - Address of the opcode
    *
    * RETURN:      Pointer to the new Op, null on failure
    *
    * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
    *              opcode. A cache of opcodes is available for the pure
    *              GENERIC_OP, since this is by far the most commonly used.
    *
    ******************************************************************************/
   
   ACPI_PARSE_OBJECT*
   AcpiPsAllocOp (
       UINT16                  Opcode,
       UINT8                   *Aml)
   {
       ACPI_PARSE_OBJECT       *Op;
       const ACPI_OPCODE_INFO  *OpInfo;
       UINT8                   Flags = ACPI_PARSEOP_GENERIC;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       OpInfo = AcpiPsGetOpcodeInfo (Opcode);
   
       /* Determine type of ParseOp required */
   
       if (OpInfo->Flags & AML_DEFER)
       {
           Flags = ACPI_PARSEOP_DEFERRED;
       }
       else if (OpInfo->Flags & AML_NAMED)
       {
           Flags = ACPI_PARSEOP_NAMED_OBJECT;
       }
       else if (Opcode == AML_INT_BYTELIST_OP)
       {
           Flags = ACPI_PARSEOP_BYTELIST;
       }
   
       /* Allocate the minimum required size object */
   
       if (Flags == ACPI_PARSEOP_GENERIC)
       {
           /* The generic op (default) is by far the most common (16 to 1) */
   
           Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
       }
       else
       {
           /* Extended parseop */
   
           Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
       }
   
       /* Initialize the Op */
   
       if (Op)
       {
           AcpiPsInitOp (Op, Opcode);
           Op->Common.Aml = Aml;
           Op->Common.Flags = Flags;
           ASL_CV_CLEAR_OP_COMMENTS(Op);
   
           if (Opcode == AML_SCOPE_OP)
           {
               AcpiGbl_CurrentScope = Op;
           }
   
           if (AcpiGbl_CaptureComments)
           {
               ASL_CV_TRANSFER_COMMENTS (Op);
           }
       }
   
       return (Op);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiPsFreeOp
    *
    * PARAMETERS:  Op              - Op to be freed
    *
    * RETURN:      None.
    *
    * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
    *              or actually free it.
    *
    ******************************************************************************/
   
   void
   AcpiPsFreeOp (
       ACPI_PARSE_OBJECT       *Op)
   {
       ACPI_FUNCTION_NAME (PsFreeOp);
   
   
       ASL_CV_CLEAR_OP_COMMENTS(Op);
       if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
       {
           ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
               "Free retval op: %p\n", Op));
       }
   
       if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
       {
           (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
       }
       else
       {
           (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    Utility functions
    *
    * DESCRIPTION: Low level character and object functions
    *
    ******************************************************************************/
   
   
   /*
    * Is "c" a namestring lead character?
    */
   BOOLEAN
   AcpiPsIsLeadingChar (
       UINT32                  c)
   {
       return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
   }
   
   
   /*
    * Get op's name (4-byte name segment) or 0 if unnamed
    */
   UINT32
   AcpiPsGetName (
       ACPI_PARSE_OBJECT       *Op)
   {
   
       /* The "generic" object has no name associated with it */
   
       if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
       {
           return (0);
       }
   
       /* Only the "Extended" parse objects have a name */
   
       return (Op->Named.Name);
   }
   
   
   /*
    * Set op's name
    */
   void
   AcpiPsSetName (
       ACPI_PARSE_OBJECT       *Op,
       UINT32                  name)
   {
   
       /* The "generic" object has no name associated with it */
   
       if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
       {
           return;
       }
   
       Op->Named.Name = name;
   }

Cache object: 8a7aab18baf23a6a81f73d46e1477f0e