FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/compiler/prexpress.c

     /******************************************************************************
      *
      * Module Name: prexpress - Preprocessor #if expression support
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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/compiler/aslcompiler.h>
   
   #define _COMPONENT          ASL_PREPROCESSOR
           ACPI_MODULE_NAME    ("prexpress")
   
   /* Local prototypes */
   
   static char *
   PrExpandMacros (
       char                    *Line);
   
   
   #ifdef _UNDER_DEVELOPMENT
   /******************************************************************************
    *
    * FUNCTION:    PrUnTokenize
    *
    * PARAMETERS:  Buffer              - Token Buffer
    *              Next                - "Next" buffer from GetNextToken
    *
    * RETURN:      None
    *
    * DESCRIPTION: Un-tokenized the current token buffer. The implementation is
    *              to simply set the null inserted by GetNextToken to a blank.
    *              If Next is NULL, there were no tokens found in the Buffer,
    *              so there is nothing to do.
    *
    *****************************************************************************/
   
   static void
   PrUnTokenize (
       char                    *Buffer,
       char                    *Next)
   {
       UINT32                  Length = strlen (Buffer);
   
   
       if (!Next)
       {
           return;
       }
   
       if (Buffer[Length] != '\n')
       {
           Buffer[strlen(Buffer)] = ' ';
       }
   }
   #endif
   
   
   /******************************************************************************
    *
    * FUNCTION:    PrExpandMacros
    *
    * PARAMETERS:  Line                - Pointer into the current line
    *
    * RETURN:      Updated pointer into the current line
    *
    * DESCRIPTION: Expand any macros found in the current line buffer.
    *
    *****************************************************************************/
   
   static char *
   PrExpandMacros (
       char                    *Line)
   {
       char                    *Token;
       char                    *ReplaceString;
       PR_DEFINE_INFO          *DefineInfo;
       ACPI_SIZE               TokenOffset;
       char                    *Next;
       int                     OffsetAdjust;
   
   
       strcpy (AslGbl_ExpressionTokenBuffer, AslGbl_CurrentLineBuffer);
       Token = PrGetNextToken (AslGbl_ExpressionTokenBuffer, PR_EXPR_SEPARATORS, &Next);
       OffsetAdjust = 0;
   
       while (Token)
       {
           DefineInfo = PrMatchDefine (Token);
           if (DefineInfo)
           {
               if (DefineInfo->Body)
               {
                   /* This is a macro. TBD: Is this allowed? */
   
                   DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
                       "Matched Macro: %s->%s\n",
                       AslGbl_CurrentLineNumber, DefineInfo->Identifier,
                       DefineInfo->Replacement);
   
                   PrDoMacroInvocation (AslGbl_ExpressionTokenBuffer, Token,
                       DefineInfo, &Next);
               }
               else
               {
                   ReplaceString = DefineInfo->Replacement;
   
                   /* Replace the name in the original line buffer */
   
                   TokenOffset = Token - AslGbl_ExpressionTokenBuffer + OffsetAdjust;
                   PrReplaceData (
                       &AslGbl_CurrentLineBuffer[TokenOffset], strlen (Token),
                       ReplaceString, strlen (ReplaceString));
   
                   /* Adjust for length difference between old and new name length */
   
                   OffsetAdjust += strlen (ReplaceString) - strlen (Token);
   
                   DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
                       "Matched #define within expression: %s->%s\n",
                       AslGbl_CurrentLineNumber, Token,
                       *ReplaceString ? ReplaceString : "(NULL STRING)");
               }
           }
   
           Token = PrGetNextToken (NULL, PR_EXPR_SEPARATORS, &Next);
       }
   
       return (Line);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    PrIsDefined
    *
    * PARAMETERS:  Identifier          - Name to be resolved
    *
    * RETURN:      64-bit boolean integer value
    *
    * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
    *
    *****************************************************************************/
   
   UINT64
   PrIsDefined (
       char                    *Identifier)
   {
       UINT64                  Value;
       PR_DEFINE_INFO          *DefineInfo;
   
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "**** Is defined?:  %s\n", AslGbl_CurrentLineNumber, Identifier);
   
       Value = 0; /* Default is "Not defined" -- FALSE */
   
       DefineInfo = PrMatchDefine (Identifier);
       if (DefineInfo)
       {
           Value = ACPI_UINT64_MAX; /* TRUE */
       }
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "[#if defined %s] resolved to: %8.8X%8.8X\n",
           AslGbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
   
       return (Value);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    PrResolveDefine
    *
    * PARAMETERS:  Identifier          - Name to be resolved
    *
    * RETURN:      A 64-bit boolean integer value
    *
    * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
    *
    *****************************************************************************/
   
   UINT64
   PrResolveDefine (
       char                    *Identifier)
   {
       UINT64                  Value;
       PR_DEFINE_INFO          *DefineInfo;
   
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "**** Resolve #define:  %s\n", AslGbl_CurrentLineNumber, Identifier);
   
       Value = 0; /* Default is "Not defined" -- FALSE */
   
       DefineInfo = PrMatchDefine (Identifier);
       if (DefineInfo)
       {
           Value = ACPI_UINT64_MAX; /* TRUE */
       }
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "[#if defined %s] resolved to: %8.8X%8.8X\n",
           AslGbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
   
       return (Value);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    PrResolveIntegerExpression
    *
    * PARAMETERS:  Line                - Pointer to integer expression
    *              ReturnValue         - Where the resolved 64-bit integer is
    *                                    returned.
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Resolve an integer expression to a single value. Supports
    *              both integer constants and labels.
    *
    *****************************************************************************/
   
   ACPI_STATUS
   PrResolveIntegerExpression (
       char                    *Line,
       UINT64                  *ReturnValue)
   {
       UINT64                  Result;
       char                    *ExpandedLine;
   
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "**** Resolve #if:  %s\n", AslGbl_CurrentLineNumber, Line);
   
       /* Expand all macros within the expression first */
   
       ExpandedLine = PrExpandMacros (Line);
   
       /* Now we can evaluate the expression */
   
       Result = PrEvaluateExpression (ExpandedLine);
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "**** Expression Resolved to: %8.8X%8.8X\n",
           AslGbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Result));
   
       *ReturnValue = Result;
       return (AE_OK);
   
   #if 0
   InvalidExpression:
   
       ACPI_FREE (EvalBuffer);
       PrError (ASL_ERROR, ASL_MSG_INVALID_EXPRESSION, 0);
       return (AE_ERROR);
   
   
   NormalExit:
   
       DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
           "**** Expression Resolved to: %8.8X%8.8X\n",
           AslGbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Value1));
   
       *ReturnValue = Value1;
       return (AE_OK);
   #endif
   }

Cache object: 1963bad136eb9ecef1935f048ee1ab51