1 /****************************************************************************** 2 * 3 * Module Name: asmain - Main module for the acpi source processor utility 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpisrc.h" 153 154 /* Local prototypes */ 155 156 int 157 AsExaminePaths ( 158 ACPI_CONVERSION_TABLE *ConversionTable, 159 char *Source, 160 char *Target, 161 UINT32 *SourceFileType); 162 163 void 164 AsDisplayStats ( 165 void); 166 167 void 168 AsDisplayUsage ( 169 void); 170 171 /* Globals */ 172 173 UINT32 Gbl_Tabs = 0; 174 UINT32 Gbl_MissingBraces = 0; 175 UINT32 Gbl_NonAnsiComments = 0; 176 UINT32 Gbl_Files = 0; 177 UINT32 Gbl_WhiteLines = 0; 178 UINT32 Gbl_CommentLines = 0; 179 UINT32 Gbl_SourceLines = 0; 180 UINT32 Gbl_LongLines = 0; 181 UINT32 Gbl_TotalLines = 0; 182 UINT32 Gbl_TotalSize = 0; 183 UINT32 Gbl_HeaderLines = 0; 184 UINT32 Gbl_HeaderSize = 0; 185 void *Gbl_StructDefs = NULL; 186 187 struct stat Gbl_StatBuf; 188 char *Gbl_FileBuffer; 189 UINT32 Gbl_FileSize; 190 UINT32 Gbl_FileType; 191 BOOLEAN Gbl_VerboseMode = FALSE; 192 BOOLEAN Gbl_QuietMode = FALSE; 193 BOOLEAN Gbl_BatchMode = FALSE; 194 BOOLEAN Gbl_DebugStatementsMode = FALSE; 195 BOOLEAN Gbl_MadeChanges = FALSE; 196 BOOLEAN Gbl_Overwrite = FALSE; 197 BOOLEAN Gbl_WidenDeclarations = FALSE; 198 BOOLEAN Gbl_IgnoreLoneLineFeeds = FALSE; 199 BOOLEAN Gbl_HasLoneLineFeeds = FALSE; 200 BOOLEAN Gbl_Cleanup = FALSE; 201 BOOLEAN Gbl_IgnoreTranslationEscapes = FALSE; 202 203 #define AS_UTILITY_NAME "ACPI Source Code Conversion Utility" 204 #define AS_SUPPORTED_OPTIONS "cdhilqsuv^y" 205 206 207 /****************************************************************************** 208 * 209 * FUNCTION: AsExaminePaths 210 * 211 * DESCRIPTION: Source and Target pathname verification and handling 212 * 213 ******************************************************************************/ 214 215 int 216 AsExaminePaths ( 217 ACPI_CONVERSION_TABLE *ConversionTable, 218 char *Source, 219 char *Target, 220 UINT32 *SourceFileType) 221 { 222 int Status; 223 int Response; 224 225 226 Status = stat (Source, &Gbl_StatBuf); 227 if (Status) 228 { 229 printf ("Source path \"%s\" does not exist\n", Source); 230 return (-1); 231 } 232 233 /* Return the filetype -- file or a directory */ 234 235 *SourceFileType = 0; 236 if (Gbl_StatBuf.st_mode & S_IFDIR) 237 { 238 *SourceFileType = S_IFDIR; 239 } 240 241 /* 242 * If we are in no-output mode or in batch mode, we are done 243 */ 244 if ((ConversionTable->Flags & FLG_NO_FILE_OUTPUT) || 245 (Gbl_BatchMode)) 246 { 247 return (0); 248 } 249 250 if (!AcpiUtStricmp (Source, Target)) 251 { 252 printf ("Target path is the same as the source path, overwrite?\n"); 253 Response = getchar (); 254 255 /* Check response */ 256 257 if (Response != 'y') 258 { 259 return (-1); 260 } 261 262 Gbl_Overwrite = TRUE; 263 } 264 else 265 { 266 Status = stat (Target, &Gbl_StatBuf); 267 if (!Status) 268 { 269 printf ("Target path already exists, overwrite?\n"); 270 Response = getchar (); 271 272 /* Check response */ 273 274 if (Response != 'y') 275 { 276 return (-1); 277 } 278 } 279 } 280 281 return (0); 282 } 283 284 285 /****************************************************************************** 286 * 287 * FUNCTION: AsDisplayStats 288 * 289 * DESCRIPTION: Display global statistics gathered during translation 290 * 291 ******************************************************************************/ 292 293 void 294 AsDisplayStats ( 295 void) 296 { 297 298 if (Gbl_QuietMode) 299 { 300 return; 301 } 302 303 printf ("\nAcpiSrc statistics:\n\n"); 304 printf ("%8u Files processed\n", Gbl_Files); 305 306 if (!Gbl_Files) 307 { 308 return; 309 } 310 311 printf ("%8u Total bytes (%.1fK/file)\n", 312 Gbl_TotalSize, ((double) Gbl_TotalSize/Gbl_Files)/1024); 313 printf ("%8u Tabs found\n", Gbl_Tabs); 314 printf ("%8u Missing if/else/while braces\n", Gbl_MissingBraces); 315 printf ("%8u Non-ANSI // comments found\n", Gbl_NonAnsiComments); 316 printf ("%8u Total Lines\n", Gbl_TotalLines); 317 printf ("%8u Lines of code\n", Gbl_SourceLines); 318 printf ("%8u Lines of non-comment whitespace\n", Gbl_WhiteLines); 319 printf ("%8u Lines of comments\n", Gbl_CommentLines); 320 printf ("%8u Long lines found\n", Gbl_LongLines); 321 322 if (Gbl_WhiteLines > 0) 323 { 324 printf ("%8.1f Ratio of code to whitespace\n", 325 ((float) Gbl_SourceLines / (float) Gbl_WhiteLines)); 326 } 327 328 if ((Gbl_CommentLines + Gbl_NonAnsiComments) > 0) 329 { 330 printf ("%8.1f Ratio of code to comments\n", 331 ((float) Gbl_SourceLines / 332 (float) (Gbl_CommentLines + Gbl_NonAnsiComments))); 333 } 334 335 if (!Gbl_TotalLines) 336 { 337 return; 338 } 339 340 printf (" %u%% code, %u%% comments, %u%% whitespace, %u%% headers\n", 341 (Gbl_SourceLines * 100) / Gbl_TotalLines, 342 (Gbl_CommentLines * 100) / Gbl_TotalLines, 343 (Gbl_WhiteLines * 100) / Gbl_TotalLines, 344 (Gbl_HeaderLines * 100) / Gbl_TotalLines); 345 return; 346 } 347 348 349 /****************************************************************************** 350 * 351 * FUNCTION: AsDisplayUsage 352 * 353 * DESCRIPTION: Usage message 354 * 355 ******************************************************************************/ 356 357 void 358 AsDisplayUsage ( 359 void) 360 { 361 362 ACPI_USAGE_HEADER ("acpisrc [-c|l|u] [-dsvy] <SourceDir> <DestinationDir>"); 363 364 ACPI_OPTION ("-c", "Generate cleaned version of the source"); 365 ACPI_OPTION ("-h", "Insert dual-license header into all modules"); 366 ACPI_OPTION ("-i", "Cleanup macro indentation"); 367 ACPI_OPTION ("-l", "Generate Linux version of the source"); 368 ACPI_OPTION ("-u", "Generate Custom source translation"); 369 370 ACPI_USAGE_TEXT ("\n"); 371 ACPI_OPTION ("-d", "Leave debug statements in code"); 372 ACPI_OPTION ("-s", "Generate source statistics only"); 373 ACPI_OPTION ("-v", "Display version information"); 374 ACPI_OPTION ("-vb", "Verbose mode"); 375 ACPI_OPTION ("-y", "Suppress file overwrite prompts"); 376 } 377 378 379 /****************************************************************************** 380 * 381 * FUNCTION: main 382 * 383 * DESCRIPTION: C main function 384 * 385 ******************************************************************************/ 386 387 int ACPI_SYSTEM_XFACE 388 main ( 389 int argc, 390 char *argv[]) 391 { 392 int j; 393 ACPI_CONVERSION_TABLE *ConversionTable = NULL; 394 char *SourcePath; 395 char *TargetPath; 396 UINT32 FileType; 397 398 399 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 400 AcpiOsInitialize (); 401 printf (ACPI_COMMON_SIGNON (AS_UTILITY_NAME)); 402 403 if (argc < 2) 404 { 405 AsDisplayUsage (); 406 return (0); 407 } 408 409 /* Command line options */ 410 411 while ((j = AcpiGetopt (argc, argv, AS_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j) 412 { 413 case 'l': 414 415 /* Linux code generation */ 416 417 printf ("Creating Linux source code\n"); 418 ConversionTable = &LinuxConversionTable; 419 Gbl_WidenDeclarations = TRUE; 420 Gbl_IgnoreLoneLineFeeds = TRUE; 421 break; 422 423 case 'c': 424 425 /* Cleanup code */ 426 427 printf ("Code cleanup\n"); 428 ConversionTable = &CleanupConversionTable; 429 Gbl_Cleanup = TRUE; 430 break; 431 432 case 'h': 433 434 /* Inject Dual-license header */ 435 436 printf ("Inserting Dual-license header to all modules\n"); 437 ConversionTable = &LicenseConversionTable; 438 break; 439 440 case 'i': 441 442 /* Cleanup wrong indent result */ 443 444 printf ("Cleaning up macro indentation\n"); 445 ConversionTable = &IndentConversionTable; 446 Gbl_IgnoreLoneLineFeeds = TRUE; 447 Gbl_IgnoreTranslationEscapes = TRUE; 448 break; 449 450 case 's': 451 452 /* Statistics only */ 453 454 break; 455 456 case 'u': 457 458 /* custom conversion */ 459 460 printf ("Custom source translation\n"); 461 ConversionTable = &CustomConversionTable; 462 break; 463 464 case 'v': 465 466 switch (AcpiGbl_Optarg[0]) 467 { 468 case '^': /* -v: (Version): signon already emitted, just exit */ 469 470 exit (0); 471 472 case 'b': 473 474 /* Verbose mode */ 475 476 Gbl_VerboseMode = TRUE; 477 break; 478 479 default: 480 481 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg); 482 return (-1); 483 } 484 485 break; 486 487 case 'y': 488 489 /* Batch mode */ 490 491 Gbl_BatchMode = TRUE; 492 break; 493 494 case 'd': 495 496 /* Leave debug statements in */ 497 498 Gbl_DebugStatementsMode = TRUE; 499 break; 500 501 case 'q': 502 503 /* Quiet mode */ 504 505 Gbl_QuietMode = TRUE; 506 break; 507 508 default: 509 510 AsDisplayUsage (); 511 return (-1); 512 } 513 514 515 SourcePath = argv[AcpiGbl_Optind]; 516 if (!SourcePath) 517 { 518 printf ("Missing source path\n"); 519 AsDisplayUsage (); 520 return (-1); 521 } 522 523 TargetPath = argv[AcpiGbl_Optind+1]; 524 525 if (!ConversionTable) 526 { 527 /* Just generate statistics. Ignore target path */ 528 529 TargetPath = SourcePath; 530 531 printf ("Source code statistics only\n"); 532 ConversionTable = &StatsConversionTable; 533 } 534 else if (!TargetPath) 535 { 536 TargetPath = SourcePath; 537 } 538 539 if (Gbl_DebugStatementsMode) 540 { 541 ConversionTable->SourceFunctions &= ~CVT_REMOVE_DEBUG_MACROS; 542 } 543 544 /* Check source and target paths and files */ 545 546 if (AsExaminePaths (ConversionTable, SourcePath, TargetPath, &FileType)) 547 { 548 return (-1); 549 } 550 551 /* Source/target can be either directories or a files */ 552 553 if (FileType == S_IFDIR) 554 { 555 /* Process the directory tree */ 556 557 AsProcessTree (ConversionTable, SourcePath, TargetPath); 558 } 559 else 560 { 561 /* Process a single file */ 562 563 /* Differentiate between source and header files */ 564 565 if (strstr (SourcePath, ".h")) 566 { 567 AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, 568 SourcePath, FILE_TYPE_HEADER); 569 } 570 else if (strstr (SourcePath, ".c")) 571 { 572 AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, 573 SourcePath, FILE_TYPE_SOURCE); 574 } 575 else if (strstr (SourcePath, ".patch")) 576 { 577 AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, 578 SourcePath, FILE_TYPE_PATCH); 579 } 580 else 581 { 582 printf ("Unknown file type - %s\n", SourcePath); 583 } 584 } 585 586 /* Always display final summary and stats */ 587 588 AsDisplayStats (); 589 return (0); 590 } 591