prscan.c revision 199767f8919635c4928607450d9e0abb932109ce
/******************************************************************************
*
* Module Name: prscan - Preprocessor start-up and file scan module
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2015, Intel Corp.
* All rights reserved.
*
* 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.
*
* Alternatively, this software may be distributed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*
* NO WARRANTY
* 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 MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
*/
#define _DECLARE_PR_GLOBALS
/*
* TBDs:
*
* No nested macros, maybe never
* Implement ASL "Include" as well as "#include" here?
*/
#define _COMPONENT ASL_PREPROCESSOR
ACPI_MODULE_NAME ("prscan")
/* Local prototypes */
static void
void);
static void
char *DirectiveToken,
char **Next);
static void
void);
static UINT32
static int
char *Directive);
static void
int Directive,
char *Argument);
static ACPI_STATUS
void);
static void
char *Action,
char *DirectiveName);
static void
char *Pathname,
char *BufferName);
static void
char *Pathname);
/*
* Supported preprocessor directives
* Each entry is of the form "Name, ArgumentCount"
*/
static const PR_DIRECTIVE_INFO Gbl_DirectiveInfo[] =
{
{"define", 1},
{"elif", 0}, /* Converted to #else..#if internally */
{"else", 0},
{"endif", 0},
{"error", 1},
{"if", 1},
{"ifdef", 1},
{"ifndef", 1},
{"include", 0}, /* Argument is not standard format, so just use 0 here */
{"includebuffer", 0}, /* Argument is not standard format, so just use 0 here */
{"line", 1},
{"pragma", 1},
{"undef", 1},
{"warning", 1},
{NULL, 0}
};
/* This table must match ordering of above table exactly */
enum Gbl_DirectiveIndexes
{
PR_DIRECTIVE_DEFINE = 0,
};
#define ASL_DIRECTIVE_NOT_FOUND -1
/*******************************************************************************
*
* FUNCTION: PrInitializePreprocessor
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Startup initialization for the Preprocessor.
*
******************************************************************************/
void
void)
{
/* Init globals and the list of #defines */
}
/*******************************************************************************
*
* FUNCTION: PrInitializeGlobals
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Initialize globals for the Preprocessor. Used for startuup
* initialization and re-initialization between compiles during
* a multiple source file compile.
*
******************************************************************************/
void
void)
{
/* Init globals */
/* These are used to track #if/#else blocks (possibly nested) */
Gbl_IfDepth = 0;
}
/*******************************************************************************
*
* FUNCTION: PrTerminatePreprocessor
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Termination of the preprocessor. Delete lists. Keep any
* defines that were specified on the command line, in order to
* support multiple compiles with a single compiler invocation.
*
******************************************************************************/
void
void)
{
/*
* The persistent defines (created on the command line) are always at the
* end of the list. We save them.
*/
{
}
}
/*******************************************************************************
*
* FUNCTION: PrDoPreprocess
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Main entry point for the iASL Preprocessor. Input file must
* be already open. Handles multiple input files via the
* #include directive.
*
******************************************************************************/
void
void)
{
FlSeekFile (ASL_FILE_INPUT, 0);
/* Main preprocessor loop, handles include files */
do
{
} while (MoreInputFiles);
/* Point compiler input to the new preprocessor output file (.pre) */
/* Reset globals to allow compiler to run */
FlSeekFile (ASL_FILE_INPUT, 0);
if (!Gbl_PreprocessOnly)
{
}
}
/*******************************************************************************
*
* FUNCTION: PrPreprocessInputFile
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Preprocess one entire file, line-by-line.
*
* Input: Raw user ASL from ASL_FILE_INPUT
* Output: Preprocessed file written to ASL_FILE_PREPROCESSOR and
* (optionally) ASL_FILE_PREPROCESSOR_USER
*
******************************************************************************/
static void
void)
{
char *Token;
char *ReplaceString;
char *Next;
int OffsetAdjust;
/* Scan source line-by-line and process directives. Then write the .i file */
{
if ((Status == ASL_WITHIN_COMMENT) ||
(Status == ASL_BLANK_LINE))
{
goto WriteEntireLine;
}
/* Need a copy of the input line for strok() */
OffsetAdjust = 0;
/* All preprocessor directives must begin with '#' */
{
{
}
else
{
Token++; /* Skip leading # */
}
/* Execute the directive, do not write line to output file */
continue;
}
/*
* FALSE, ignore the line and do not write it to the output file.
* This continues until an #else or #endif is encountered.
*/
{
continue;
}
/* Match and replace all #defined names within this source line */
while (Token)
{
if (DefineInfo)
{
if (DefineInfo->Body)
{
/* This is a macro */
"Matched Macro: %s->%s\n",
DefineInfo, &Next);
}
else
{
/* Replace the name in the original line buffer */
/* Adjust for length difference between old and new name length */
"Matched #define: %s->%s\n",
}
}
}
/*
* Now we can write the possibly modified source line to the
* preprocessor file(s).
*/
}
}
/*******************************************************************************
*
* FUNCTION: PrDoDirective
*
* PARAMETERS: Directive - Pointer to directive name token
* Next - "Next" buffer from GetNextToken
*
* RETURN: None.
*
* DESCRIPTION: Main processing for all preprocessor directives
*
******************************************************************************/
static void
char *DirectiveToken,
char **Next)
{
char *Token = Gbl_MainTokenBuffer;
char *End;
int Directive;
if (!DirectiveToken)
{
goto SyntaxError;
}
if (Directive == ASL_DIRECTIVE_NOT_FOUND)
{
"#%s: Unknown directive\n",
return;
}
/*
* Emit a line directive into the preprocessor file (.pre) after
* every matched directive. This is passed through to the compiler
* original source file.
*/
/*
* If we are currently ignoring this block and we encounter a #else or
* #elif, we must ignore their blocks also if the parent block is also
* being ignored.
*/
{
switch (Directive)
{
case PR_DIRECTIVE_ELSE:
case PR_DIRECTIVE_ELIF:
{
return;
}
break;
default:
break;
}
}
/*
* Need to always check for #else, #elif, #endif regardless of
* whether we are ignoring the current code block, since these
* are conditional code block terminators.
*/
switch (Directive)
{
case PR_DIRECTIVE_ELSE:
return;
case PR_DIRECTIVE_ELIF:
if (Gbl_IgnoringThisCodeBlock == TRUE)
{
/* Not executing the ELSE part -- all done here */
return;
}
/*
* After this, we will execute the IF part further below.
* First, however, pop off the original #if directive.
*/
if (ACPI_FAILURE (PrPopDirective ()))
{
}
break;
case PR_DIRECTIVE_ENDIF:
/* Pop the owning #if/#ifdef/#ifndef */
if (ACPI_FAILURE (PrPopDirective ()))
{
}
return;
default:
break;
}
/* Most directives have at least one argument */
{
if (!Token)
{
goto SyntaxError;
}
}
{
if (!Token2)
{
goto SyntaxError;
}
}
/*
* At this point, if we are ignoring the current code block,
* do not process any more directives (i.e., ignore them also.)
* must do this to keep track of #endif directives
*/
{
switch (Directive)
{
case PR_DIRECTIVE_IF:
case PR_DIRECTIVE_IFDEF:
case PR_DIRECTIVE_IFNDEF:
break;
default:
break;
}
return;
}
/*
* Execute the directive
*/
switch (Directive)
{
case PR_DIRECTIVE_IF:
/* Need to expand #define macros in the expression string first */
if (ACPI_FAILURE (Status))
{
return;
}
if (!Value)
{
}
"Resolved #if: %8.8X%8.8X %s\n",
break;
case PR_DIRECTIVE_IFDEF:
if (!PrMatchDefine (Token))
{
}
break;
case PR_DIRECTIVE_IFNDEF:
if (PrMatchDefine (Token))
{
}
break;
case PR_DIRECTIVE_DEFINE:
/*
* By definition, if first char after the name is a paren,
* this is a function macro.
*/
{
#ifndef MACROS_SUPPORTED
AcpiOsPrintf ("%s ERROR - line %u: #define macros are not supported yet\n",
exit(1);
#else
#endif
}
else
{
/* Use the remainder of the line for the #define */
if (Token2)
{
{
Token2++;
}
while (*End != '\n')
{
End++;
}
*End = 0;
}
else
{
Token2 = "";
}
#if 0
if (!Token2)
{
Token2 = "";
}
#endif
"New #define: %s->%s\n",
}
break;
case PR_DIRECTIVE_ERROR:
/* Note: No macro expansion */
Gbl_SourceLine = 0;
CmCleanupAndExit ();
exit(1);
case PR_DIRECTIVE_INCLUDE:
if (!Token)
{
goto SyntaxError;
}
"Start #include file \"%s\"\n", Gbl_CurrentLineNumber,
break;
if (!Token)
{
goto SyntaxError;
}
if (!Token2)
{
goto SyntaxError;
}
"Start #includebuffer input from file \"%s\", buffer name %s\n",
break;
case PR_DIRECTIVE_LINE:
if (ACPI_FAILURE (Status))
{
return;
}
"User #line invocation %s\n", Gbl_CurrentLineNumber,
Token);
/* Emit #line into the preprocessor file */
break;
case PR_DIRECTIVE_PRAGMA:
{
if (!Token)
{
goto SyntaxError;
}
}
{
if (!Token)
{
goto SyntaxError;
}
}
else
{
return;
}
break;
case PR_DIRECTIVE_UNDEF:
break;
case PR_DIRECTIVE_WARNING:
Gbl_SourceLine = 0;
break;
default:
/* Should never get here */
"Unrecognized directive: %u\n",
break;
}
return;
return;
}
/*******************************************************************************
*
* FUNCTION: PrGetNextLine, PrGetNextLineInit
*
* PARAMETERS: Handle - Open file handle for the source file
*
* RETURN: Status of the GetLine operation:
* AE_OK - Normal line, OK status
* ASL_WITHIN_COMMENT - Line is part of a multi-line comment
* ASL_EOF - End-of-file reached
*
* DESCRIPTION: Get the next text line from the input file. Does not strip
* comments.
*
******************************************************************************/
#define PR_NORMAL_TEXT 0
#define PR_MULTI_LINE_COMMENT 1
#define PR_SINGLE_LINE_COMMENT 2
#define PR_QUOTED_STRING 3
static void
void)
{
}
static UINT32
{
UINT32 i;
int c = 0;
int PreviousChar;
/* Always clear the global line buffer */
for (i = 0; ;)
{
/*
* If line is too long, expand the line buffers. Also increases
* Gbl_LineBufferSize.
*/
if (i >= Gbl_LineBufferSize)
{
}
PreviousChar = c;
if (c == EOF)
{
return (ASL_EOF);
}
/* Update state machine as necessary */
switch (AcpiGbl_LineScanState)
{
case PR_NORMAL_TEXT:
/* Check for multi-line comment start */
{
}
/* Check for single-line comment start */
{
}
/* Check for quoted string start */
else if (PreviousChar == '"')
{
}
break;
case PR_QUOTED_STRING:
if (PreviousChar == '"')
{
}
break;
case PR_MULTI_LINE_COMMENT:
/* Check for multi-line comment end */
{
}
break;
case PR_SINGLE_LINE_COMMENT: /* Just ignore text until EOL */
default:
break;
}
/* Always copy the character into line buffer */
Gbl_CurrentLineBuffer[i] = (char) c;
i++;
/* Always exit on end-of-line */
if (c == '\n')
{
/* Handle multi-line comments */
{
return (ASL_WITHIN_COMMENT);
}
/* End of single-line comment */
{
return (AE_OK);
}
/* Blank line */
if (i == 1)
{
return (ASL_BLANK_LINE);
}
return (AE_OK);
}
}
}
/*******************************************************************************
*
* FUNCTION: PrMatchDirective
*
* PARAMETERS: Directive - Pointer to directive name token
*
* RETURN: Index into command array, -1 if not found
*
* DESCRIPTION: Lookup the incoming directive in the known directives table.
*
******************************************************************************/
static int
char *Directive)
{
int i;
{
return (ASL_DIRECTIVE_NOT_FOUND);
}
for (i = 0; Gbl_DirectiveInfo[i].Name; i++)
{
{
return (i);
}
}
return (ASL_DIRECTIVE_NOT_FOUND); /* Command not recognized */
}
/*******************************************************************************
*
* FUNCTION: PrPushDirective
*
* PARAMETERS: Directive - Encoded directive ID
* Argument - String containing argument to the
* directive
*
* RETURN: None
*
* DESCRIPTION: Push an item onto the directive stack. Used for processing
* nested #if/#else type conditional compilation directives.
* Specifically: Used on detection of #if/#ifdef/#ifndef to open
* a block.
*
******************************************************************************/
static void
int Directive,
char *Argument)
{
/* Allocate and populate a stack info item */
"Pr(%.4u) - [%u %s] %*s Pushed [#%s %s]: IgnoreFlag = %s\n",
/* Push new item */
Gbl_IfDepth++;
}
/*******************************************************************************
*
* FUNCTION: PrPopDirective
*
* PARAMETERS: None
*
* RETURN: Status. Error if the stack is empty.
*
* DESCRIPTION: Pop an item off the directive stack. Used for processing
* nested #if/#else type conditional compilation directives.
* Specifically: Used on detection of #elif and #endif to remove
* the original #if/#ifdef/#ifndef from the stack and close
* the block.
*
******************************************************************************/
static ACPI_STATUS
void)
{
/* Check for empty stack */
if (!Info)
{
return (AE_ERROR);
}
/* Pop one item, keep globals up-to-date */
Gbl_IfDepth--;
"Pr(%.4u) - [%u %s] %*s Popped [#%s %s]: IgnoreFlag now = %s\n",
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: PrDbgPrint
*
* PARAMETERS: Action - Action being performed
* DirectiveName - Directive being processed
*
* RETURN: None
*
* DESCRIPTION: Special debug print for directive processing.
*
******************************************************************************/
static void
char *Action,
char *DirectiveName)
{
"%*s %s #%s, IfDepth %u\n",
}
/*******************************************************************************
*
* FUNCTION: PrDoIncludeFile
*
* PARAMETERS: Pathname - Name of the input file
*
* RETURN: None.
*
* DESCRIPTION: Open an include file, from #include.
*
******************************************************************************/
static void
char *Pathname)
{
char *FullPathname;
}
/*******************************************************************************
*
* FUNCTION: PrDoIncludeBuffer
*
* PARAMETERS: Pathname - Name of the input binary file
* BufferName - ACPI namepath of the buffer
*
* RETURN: None.
*
* DESCRIPTION: Create an ACPI buffer object from a binary file. The contents
* of the file are emitted into the buffer object as ascii
* hex data. From #includebuffer.
*
******************************************************************************/
static void
char *Pathname,
char *BufferName)
{
char *FullPathname;
UINT32 i = 0;
UINT8 c;
if (!BinaryBufferFile)
{
return;
}
/* Emit "Name (XXXX, Buffer() {" header */
/* Dump the entire file in ascii hex format */
{
if (!(i % 8))
{
}
i++;
}
"#includebuffer: read %u bytes from %s\n",
/* Close the Name() operator */
}