1 /****************************************************************************** 2 * 3 * Module Name: aslmain - compiler main and utilities 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, 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 _DECLARE_GLOBALS 45 46 #include "aslcompiler.h" 47 #include "acapps.h" 48 #include "acdisasm.h" 49 #include <signal.h> 50 51 #define _COMPONENT ACPI_COMPILER 52 ACPI_MODULE_NAME ("aslmain") 53 54 /* 55 * Main routine for the iASL compiler. 56 * 57 * Portability note: The compiler depends upon the host for command-line 58 * wildcard support - it is not implemented locally. For example: 59 * 60 * Linux/Unix systems: Shell expands wildcards automatically. 61 * 62 * Windows: The setargv.obj module must be linked in to automatically 63 * expand wildcards. 64 */ 65 66 /* Local prototypes */ 67 68 static void ACPI_SYSTEM_XFACE 69 AslSignalHandler ( 70 int Sig); 71 72 static void 73 AslInitialize ( 74 void); 75 76 UINT8 77 AcpiIsBigEndianMachine ( 78 void); 79 80 81 /******************************************************************************* 82 * 83 * FUNCTION: AcpiIsBigEndianMachine 84 * 85 * PARAMETERS: None 86 * 87 * RETURN: TRUE if machine is big endian 88 * FALSE if machine is little endian 89 * 90 * DESCRIPTION: Detect whether machine is little endian or big endian. 91 * 92 ******************************************************************************/ 93 94 UINT8 95 AcpiIsBigEndianMachine ( 96 void) 97 { 98 union { 99 UINT32 Integer; 100 UINT8 Bytes[4]; 101 } Overlay = {0xFF000000}; 102 103 return (Overlay.Bytes[0]); /* Returns 0xFF (TRUE) for big endian */ 104 } 105 106 107 /******************************************************************************* 108 * 109 * FUNCTION: Usage 110 * 111 * PARAMETERS: None 112 * 113 * RETURN: None 114 * 115 * DESCRIPTION: Display option help message. 116 * Optional items in square brackets. 117 * 118 ******************************************************************************/ 119 120 void 121 Usage ( 122 void) 123 { 124 printf ("%s\n\n", ASL_COMPLIANCE); 125 ACPI_USAGE_HEADER ("iasl [Options] [Files]"); 126 127 printf ("\nGeneral:\n"); 128 ACPI_OPTION ("-@ <file>", "Specify command file"); 129 ACPI_OPTION ("-I <dir>", "Specify additional include directory"); 130 ACPI_OPTION ("-T <sig list>|ALL", "Create ACPI table template/example files"); 131 ACPI_OPTION ("-T <count>", "Emit DSDT and <count> SSDTs to same file"); 132 ACPI_OPTION ("-p <prefix>", "Specify path/filename prefix for all output files"); 133 ACPI_OPTION ("-v", "Display compiler version"); 134 ACPI_OPTION ("-vo", "Enable optimization comments"); 135 ACPI_OPTION ("-vs", "Disable signon"); 136 137 printf ("\nHelp:\n"); 138 ACPI_OPTION ("-h", "This message"); 139 ACPI_OPTION ("-hc", "Display operators allowed in constant expressions"); 140 ACPI_OPTION ("-hf", "Display help for output filename generation"); 141 ACPI_OPTION ("-hr", "Display ACPI reserved method names"); 142 ACPI_OPTION ("-ht", "Display currently supported ACPI table names"); 143 144 printf ("\nPreprocessor:\n"); 145 ACPI_OPTION ("-D <symbol>", "Define symbol for preprocessor use"); 146 ACPI_OPTION ("-li", "Create preprocessed output file (*.i)"); 147 ACPI_OPTION ("-P", "Preprocess only and create preprocessor output file (*.i)"); 148 ACPI_OPTION ("-Pn", "Disable preprocessor"); 149 150 printf ("\nErrors, Warnings, and Remarks:\n"); 151 ACPI_OPTION ("-va", "Disable all errors/warnings/remarks"); 152 ACPI_OPTION ("-ve", "Report only errors (ignore warnings and remarks)"); 153 ACPI_OPTION ("-vi", "Less verbose errors and warnings for use with IDEs"); 154 ACPI_OPTION ("-vr", "Disable remarks"); 155 ACPI_OPTION ("-vw <messageid>", "Disable specific warning or remark"); 156 ACPI_OPTION ("-w1 -w2 -w3", "Set warning reporting level"); 157 ACPI_OPTION ("-we", "Report warnings as errors"); 158 159 printf ("\nAML Code Generation (*.aml):\n"); 160 ACPI_OPTION ("-oa", "Disable all optimizations (compatibility mode)"); 161 ACPI_OPTION ("-of", "Disable constant folding"); 162 ACPI_OPTION ("-oi", "Disable integer optimization to Zero/One/Ones"); 163 ACPI_OPTION ("-on", "Disable named reference string optimization"); 164 ACPI_OPTION ("-ot", "Disable typechecking"); 165 ACPI_OPTION ("-cr", "Disable Resource Descriptor error checking"); 166 ACPI_OPTION ("-in", "Ignore NoOp operators"); 167 ACPI_OPTION ("-r <revision>", "Override table header Revision (1-255)"); 168 169 printf ("\nOptional Source Code Output Files:\n"); 170 ACPI_OPTION ("-sc -sa", "Create source file in C or assembler (*.c or *.asm)"); 171 ACPI_OPTION ("-ic -ia", "Create include file in C or assembler (*.h or *.inc)"); 172 ACPI_OPTION ("-tc -ta -ts", "Create hex AML table in C, assembler, or ASL (*.hex)"); 173 ACPI_OPTION ("-so", "Create offset table in C (*.offset.h)"); 174 175 printf ("\nOptional Listing Files:\n"); 176 ACPI_OPTION ("-l", "Create mixed listing file (ASL source and AML) (*.lst)"); 177 ACPI_OPTION ("-lm", "Create hardware summary map file (*.map)"); 178 ACPI_OPTION ("-ln", "Create namespace file (*.nsp)"); 179 ACPI_OPTION ("-ls", "Create combined source file (expanded includes) (*.src)"); 180 181 printf ("\nData Table Compiler:\n"); 182 ACPI_OPTION ("-G", "Compile custom table that contains generic operators"); 183 ACPI_OPTION ("-vt", "Create verbose template files (full disassembly)"); 184 185 printf ("\nAML Disassembler:\n"); 186 ACPI_OPTION ("-d <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)"); 187 ACPI_OPTION ("", " (Optional, file type is automatically detected)"); 188 ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace"); 189 ACPI_OPTION ("-db", "Do not translate Buffers to Resource Templates"); 190 ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it"); 191 ACPI_OPTION ("", " (Obtain DSDT from current system if no input file)"); 192 ACPI_OPTION ("-df", "Force disassembler to assume table contains valid AML"); 193 ACPI_OPTION ("-dl", "Emit legacy ASL code only (no C-style operators)"); 194 ACPI_OPTION ("-e <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution"); 195 ACPI_OPTION ("-fe <file>", "Specify external symbol declaration file"); 196 ACPI_OPTION ("-in", "Ignore NoOp opcodes"); 197 ACPI_OPTION ("-l", "Disassemble to mixed ASL and AML code"); 198 ACPI_OPTION ("-vt", "Dump binary table data in hex format within output file"); 199 200 printf ("\nDebug Options:\n"); 201 ACPI_OPTION ("-bf", "Create debug file (full output) (*.txt)"); 202 ACPI_OPTION ("-bs", "Create debug file (parse tree only) (*.txt)"); 203 ACPI_OPTION ("-bp <depth>", "Prune ASL parse tree"); 204 ACPI_OPTION ("-bt <type>", "Object type to be pruned from the parse tree"); 205 ACPI_OPTION ("-f", "Ignore errors, force creation of AML output file(s)"); 206 ACPI_OPTION ("-m <size>", "Set internal line buffer size (in Kbytes)"); 207 ACPI_OPTION ("-n", "Parse only, no output generation"); 208 ACPI_OPTION ("-oc", "Display compile times and statistics"); 209 ACPI_OPTION ("-x <level>", "Set debug level for trace output"); 210 ACPI_OPTION ("-z", "Do not insert new compiler ID for DataTables"); 211 } 212 213 214 /******************************************************************************* 215 * 216 * FUNCTION: FilenameHelp 217 * 218 * PARAMETERS: None 219 * 220 * RETURN: None 221 * 222 * DESCRIPTION: Display help message for output filename generation 223 * 224 ******************************************************************************/ 225 226 void 227 AslFilenameHelp ( 228 void) 229 { 230 231 printf ("\nAML output filename generation:\n"); 232 printf (" Output filenames are generated by appending an extension to a common\n"); 233 printf (" filename prefix. The filename prefix is obtained via one of the\n"); 234 printf (" following methods (in priority order):\n"); 235 printf (" 1) The -p option specifies the prefix\n"); 236 printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n"); 237 printf (" 3) The prefix of the input filename\n"); 238 printf ("\n"); 239 } 240 241 242 /****************************************************************************** 243 * 244 * FUNCTION: AslSignalHandler 245 * 246 * PARAMETERS: Sig - Signal that invoked this handler 247 * 248 * RETURN: None 249 * 250 * DESCRIPTION: Control-C handler. Delete any intermediate files and any 251 * output files that may be left in an indeterminate state. 252 * 253 *****************************************************************************/ 254 255 static void ACPI_SYSTEM_XFACE 256 AslSignalHandler ( 257 int Sig) 258 { 259 UINT32 i; 260 261 262 signal (Sig, SIG_IGN); 263 printf ("Aborting\n\n"); 264 265 /* Close all open files */ 266 267 Gbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL; /* the .pre file is same as source file */ 268 269 for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++) 270 { 271 FlCloseFile (i); 272 } 273 274 /* Delete any output files */ 275 276 for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++) 277 { 278 FlDeleteFile (i); 279 } 280 281 exit (0); 282 } 283 284 285 /******************************************************************************* 286 * 287 * FUNCTION: AslInitialize 288 * 289 * PARAMETERS: None 290 * 291 * RETURN: None 292 * 293 * DESCRIPTION: Initialize compiler globals 294 * 295 ******************************************************************************/ 296 297 static void 298 AslInitialize ( 299 void) 300 { 301 UINT32 i; 302 303 304 AcpiGbl_DmOpt_Verbose = FALSE; 305 306 for (i = 0; i < ASL_NUM_FILES; i++) 307 { 308 Gbl_Files[i].Handle = NULL; 309 Gbl_Files[i].Filename = NULL; 310 } 311 312 Gbl_Files[ASL_FILE_STDOUT].Handle = stdout; 313 Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT"; 314 315 Gbl_Files[ASL_FILE_STDERR].Handle = stderr; 316 Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR"; 317 } 318 319 320 /******************************************************************************* 321 * 322 * FUNCTION: main 323 * 324 * PARAMETERS: Standard argc/argv 325 * 326 * RETURN: Program termination code 327 * 328 * DESCRIPTION: C main routine for the Asl Compiler. Handle command line 329 * options and begin the compile for each file on the command line 330 * 331 ******************************************************************************/ 332 333 int ACPI_SYSTEM_XFACE 334 main ( 335 int argc, 336 char **argv) 337 { 338 ACPI_STATUS Status; 339 int Index1; 340 int Index2; 341 int ReturnStatus = 0; 342 343 344 /* 345 * Big-endian machines are not currently supported. ACPI tables must 346 * be little-endian, and support for big-endian machines needs to 347 * be implemented. 348 */ 349 if (AcpiIsBigEndianMachine ()) 350 { 351 fprintf (stderr, 352 "iASL is not currently supported on big-endian machines.\n"); 353 return (-1); 354 } 355 356 AcpiOsInitialize (); 357 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 358 359 /* Initialize preprocessor and compiler before command line processing */ 360 361 signal (SIGINT, AslSignalHandler); 362 AcpiGbl_ExternalFileList = NULL; 363 AcpiDbgLevel = 0; 364 PrInitializePreprocessor (); 365 AslInitialize (); 366 367 Index1 = Index2 = AslCommandLine (argc, argv); 368 369 /* Allocate the line buffer(s), must be after command line */ 370 371 Gbl_LineBufferSize /= 2; 372 UtExpandLineBuffers (); 373 374 /* Perform global actions first/only */ 375 376 if (Gbl_DisassembleAll) 377 { 378 while (argv[Index1]) 379 { 380 Status = AcpiDmAddToExternalFileList (argv[Index1]); 381 if (ACPI_FAILURE (Status)) 382 { 383 return (-1); 384 } 385 386 Index1++; 387 } 388 } 389 390 /* Process each pathname/filename in the list, with possible wildcards */ 391 392 while (argv[Index2]) 393 { 394 /* 395 * If -p not specified, we will use the input filename as the 396 * output filename prefix 397 */ 398 if (Gbl_UseDefaultAmlFilename) 399 { 400 Gbl_OutputFilenamePrefix = argv[Index2]; 401 UtConvertBackslashes (Gbl_OutputFilenamePrefix); 402 } 403 404 Status = AslDoOneFile (argv[Index2]); 405 if (ACPI_FAILURE (Status)) 406 { 407 ReturnStatus = -1; 408 goto CleanupAndExit; 409 } 410 411 Index2++; 412 } 413 414 415 CleanupAndExit: 416 417 UtFreeLineBuffers (); 418 AslParserCleanup (); 419 420 if (AcpiGbl_ExternalFileList) 421 { 422 AcpiDmClearExternalFileList(); 423 } 424 425 return (ReturnStatus); 426 } 427