1 /****************************************************************************** 2 * 3 * Module Name: preprocess.h - header for iASL Preprocessor 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2012, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #define __PREPROCESS_H__ 45 46 #ifndef _PREPROCESS 47 #define _PREPROCESS 48 49 #undef PR_EXTERN 50 51 #ifdef _DECLARE_PR_GLOBALS 52 #define PR_EXTERN 53 #define PR_INIT_GLOBAL(a,b) (a)=(b) 54 #else 55 #define PR_EXTERN extern 56 #define PR_INIT_GLOBAL(a,b) (a) 57 #endif 58 59 60 /* 61 * Configuration 62 */ 63 #define PR_MAX_MACRO_ARGS 32 /* Max number of macro args */ 64 #define PR_MAX_ARG_INSTANCES 24 /* Max instances of any one arg */ 65 #define PR_LINES_PER_BLOCK 4096 /* Max input source lines per block */ 66 67 68 /* 69 * Local defines and macros 70 */ 71 #define PR_TOKEN_SEPARATORS " ,(){}\t\n" 72 #define PR_MACRO_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n" 73 #define PR_MACRO_ARGUMENTS " ,\t\n" 74 #define PR_EXPR_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n" 75 76 #define PR_PREFIX_ID "Pr(%.4u) - " /* Used for debug output */ 77 78 #define THIS_TOKEN_OFFSET(t) ((t-Gbl_MainTokenBuffer) + 1) 79 80 81 /* 82 * Preprocessor structures 83 */ 84 typedef struct pr_macro_arg 85 { 86 char *Name; 87 UINT32 Offset[PR_MAX_ARG_INSTANCES]; 88 UINT16 UseCount; 89 90 } PR_MACRO_ARG; 91 92 typedef struct pr_define_info 93 { 94 struct pr_define_info *Previous; 95 struct pr_define_info *Next; 96 char *Identifier; 97 char *Replacement; 98 char *Body; /* Macro body */ 99 PR_MACRO_ARG *Args; /* Macro arg list */ 100 UINT16 ArgCount; /* Macro arg count */ 101 BOOLEAN Persist; /* Keep for entire compiler run */ 102 103 } PR_DEFINE_INFO; 104 105 typedef struct pr_directive_info 106 { 107 char *Name; /* Directive name */ 108 UINT8 ArgCount; /* Required # of args */ 109 110 } PR_DIRECTIVE_INFO; 111 112 typedef struct pr_operator_info 113 { 114 char *Op; 115 116 } PR_OPERATOR_INFO; 117 118 typedef struct pr_file_node 119 { 120 struct pr_file_node *Next; 121 FILE *File; 122 char *Filename; 123 UINT32 CurrentLineNumber; 124 125 } PR_FILE_NODE; 126 127 typedef struct pr_line_mapping 128 { 129 UINT32 *Map; 130 struct pr_line_mapping *Next; 131 132 } PR_LINE_MAPPING; 133 134 135 /* 136 * Globals 137 */ 138 PR_EXTERN char XXXEvalBuffer[ASL_LINE_BUFFER_SIZE]; 139 PR_EXTERN char Gbl_MainTokenBuffer[ASL_LINE_BUFFER_SIZE]; 140 PR_EXTERN char Gbl_MacroTokenBuffer[ASL_LINE_BUFFER_SIZE]; 141 PR_EXTERN char Gbl_ExpressionTokenBuffer[ASL_LINE_BUFFER_SIZE]; 142 143 PR_EXTERN PR_LINE_MAPPING *Gbl_MapBlockHead; 144 PR_EXTERN PR_FILE_NODE *Gbl_InputFileList; 145 PR_EXTERN PR_DEFINE_INFO PR_INIT_GLOBAL (*Gbl_DefineList, NULL); 146 PR_EXTERN UINT32 Gbl_PreprocessorLineNumber; 147 PR_EXTERN int Gbl_IfDepth; 148 PR_EXTERN BOOLEAN PR_INIT_GLOBAL (Gbl_PreprocessorError, FALSE); 149 150 151 /* 152 * prscan - Preprocessor entry 153 */ 154 void 155 PrInitializePreprocessor ( 156 void); 157 158 void 159 PrInitializeGlobals ( 160 void); 161 162 void 163 PrTerminatePreprocessor ( 164 void); 165 166 BOOLEAN 167 PrDoPreprocess ( 168 void); 169 170 UINT32 171 PrGetLineNumber ( 172 UINT32 PreprocessorLineNumber); 173 174 UINT64 175 PrIsDefined ( 176 char *Identifier); 177 178 UINT64 179 PrResolveDefine ( 180 char *Identifier); 181 182 int 183 PrInitLexer ( 184 char *String); 185 186 void 187 PrTerminateLexer ( 188 void); 189 190 191 /* 192 * prmacros - Support for #defines and macros 193 */ 194 void 195 PrDumpPredefinedNames ( 196 void); 197 198 PR_DEFINE_INFO * 199 PrAddDefine ( 200 char *Token, 201 char *Token2, 202 BOOLEAN Persist); 203 204 void 205 PrRemoveDefine ( 206 char *DefineName); 207 208 PR_DEFINE_INFO * 209 PrMatchDefine ( 210 char *MatchString); 211 212 void 213 PrAddMacro ( 214 char *Name, 215 char **Next); 216 217 void 218 PrDoMacroInvocation ( 219 char *TokenBuffer, 220 char *MacroStart, 221 PR_DEFINE_INFO *DefineInfo, 222 char **Next); 223 224 225 /* 226 * prexpress - #if expression support 227 */ 228 ACPI_STATUS 229 PrResolveIntegerExpression ( 230 char *Line, 231 UINT64 *ReturnValue); 232 233 char * 234 PrPrioritizeExpression ( 235 char *OriginalLine); 236 237 /* 238 * prparser - lex/yacc expression parser 239 */ 240 UINT64 241 PrEvaluateExpression ( 242 char *ExprString); 243 244 245 /* 246 * prutils - Preprocesor utilities 247 */ 248 char * 249 PrGetNextToken ( 250 char *Buffer, 251 char *MatchString, 252 char **Next); 253 254 void 255 PrSetLineNumber ( 256 UINT32 OriginalLineNumber, 257 UINT32 NewLineNumber); 258 259 void 260 PrError ( 261 UINT8 Level, 262 UINT8 MessageId, 263 UINT32 Column); 264 265 void 266 PrReplaceData ( 267 char *Buffer, 268 UINT32 LengthToRemove, 269 char *BufferToAdd, 270 UINT32 LengthToAdd); 271 272 void 273 PrOpenIncludeFile ( 274 char *Filename); 275 276 FILE * 277 PrOpenIncludeWithPrefix ( 278 char *PrefixDir, 279 char *Filename); 280 281 void 282 PrPushInputFileStack ( 283 FILE *InputFile, 284 char *Filename); 285 286 BOOLEAN 287 PrPopInputFileStack ( 288 void); 289 290 #endif 291