sys/contrib/dev/acpica/source/tools/acpisrc/asmain.c

   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 - 2021, 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_CheckAscii = FALSE;
 192 BOOLEAN                 Gbl_VerboseMode = FALSE;
 193 BOOLEAN                 Gbl_QuietMode = FALSE;
 194 BOOLEAN                 Gbl_BatchMode = FALSE;
 195 BOOLEAN                 Gbl_DebugStatementsMode = FALSE;
 196 BOOLEAN                 Gbl_MadeChanges = FALSE;
 197 BOOLEAN                 Gbl_Overwrite = FALSE;
 198 BOOLEAN                 Gbl_WidenDeclarations = FALSE;
 199 BOOLEAN                 Gbl_IgnoreLoneLineFeeds = FALSE;
 200 BOOLEAN                 Gbl_HasLoneLineFeeds = FALSE;
 201 BOOLEAN                 Gbl_Cleanup = FALSE;
 202 BOOLEAN                 Gbl_IgnoreTranslationEscapes = FALSE;
 203
 204 #define AS_UTILITY_NAME             "ACPI Source Code Conversion Utility"
 205 #define AS_SUPPORTED_OPTIONS        "acdhilqsuv^y"
 206
 207
 208 /******************************************************************************
 209  *
 210  * FUNCTION:    AsExaminePaths
 211  *
 212  * DESCRIPTION: Source and Target pathname verification and handling
 213  *
 214  ******************************************************************************/
 215
 216 int
 217 AsExaminePaths (
 218     ACPI_CONVERSION_TABLE   *ConversionTable,
 219     char                    *Source,
 220     char                    *Target,
 221     UINT32                  *SourceFileType)
 222 {
 223     int                     Status;
 224     int                     Response;
 225
 226
 227     Status = stat (Source, &Gbl_StatBuf);
 228     if (Status)
 229     {
 230         printf ("Source path \"%s\" does not exist\n", Source);
 231         return (-1);
 232     }
 233
 234     /* Return the filetype -- file or a directory */
 235
 236     *SourceFileType = 0;
 237     if (Gbl_StatBuf.st_mode & S_IFDIR)
 238     {
 239         *SourceFileType = S_IFDIR;
 240     }
 241
 242     /*
 243      * If we are in no-output mode or in batch mode, we are done
 244      */
 245     if ((ConversionTable->Flags & FLG_NO_FILE_OUTPUT) ||
 246         (Gbl_BatchMode))
 247     {
 248         return (0);
 249     }
 250
 251     if (!AcpiUtStricmp (Source, Target))
 252     {
 253         printf ("Target path is the same as the source path, overwrite?\n");
 254         Response = getchar ();
 255
 256         /* Check response */
 257
 258         if (Response != 'y')
 259         {
 260             return (-1);
 261         }
 262
 263         Gbl_Overwrite = TRUE;
 264     }
 265     else
 266     {
 267         Status = stat (Target, &Gbl_StatBuf);
 268         if (!Status)
 269         {
 270             printf ("Target path already exists, overwrite?\n");
 271             Response = getchar ();
 272
 273             /* Check response */
 274
 275             if (Response != 'y')
 276             {
 277                 return (-1);
 278             }
 279         }
 280     }
 281
 282     return (0);
 283 }
 284
 285
 286 /******************************************************************************
 287  *
 288  * FUNCTION:    AsDisplayStats
 289  *
 290  * DESCRIPTION: Display global statistics gathered during translation
 291  *
 292  ******************************************************************************/
 293
 294 void
 295 AsDisplayStats (
 296     void)
 297 {
 298
 299     if (Gbl_QuietMode)
 300     {
 301         return;
 302     }
 303
 304     printf ("\nAcpiSrc statistics:\n\n");
 305     printf ("%8u Files processed\n", Gbl_Files);
 306
 307     if (!Gbl_Files)
 308     {
 309         return;
 310     }
 311
 312     printf ("%8u Total bytes (%.1fK/file)\n",
 313         Gbl_TotalSize, ((double) Gbl_TotalSize/Gbl_Files)/1024);
 314     printf ("%8u Tabs found\n", Gbl_Tabs);
 315     printf ("%8u Missing if/else/while braces\n", Gbl_MissingBraces);
 316     printf ("%8u Non-ANSI // comments found\n", Gbl_NonAnsiComments);
 317     printf ("%8u Total Lines\n", Gbl_TotalLines);
 318     printf ("%8u Lines of code\n", Gbl_SourceLines);
 319     printf ("%8u Lines of non-comment whitespace\n", Gbl_WhiteLines);
 320     printf ("%8u Lines of comments\n", Gbl_CommentLines);
 321     printf ("%8u Long lines found\n", Gbl_LongLines);
 322
 323     if (Gbl_WhiteLines > 0)
 324     {
 325         printf ("%8.1f Ratio of code to whitespace\n",
 326             ((float) Gbl_SourceLines / (float) Gbl_WhiteLines));
 327     }
 328
 329     if ((Gbl_CommentLines + Gbl_NonAnsiComments) > 0)
 330     {
 331         printf ("%8.1f Ratio of code to comments\n",
 332             ((float) Gbl_SourceLines /
 333             (float) (Gbl_CommentLines + Gbl_NonAnsiComments)));
 334     }
 335
 336     if (!Gbl_TotalLines)
 337     {
 338         return;
 339     }
 340
 341     printf ("         %u%% code, %u%% comments, %u%% whitespace, %u%% headers\n",
 342         (Gbl_SourceLines * 100) / Gbl_TotalLines,
 343         (Gbl_CommentLines * 100) / Gbl_TotalLines,
 344         (Gbl_WhiteLines * 100) / Gbl_TotalLines,
 345         (Gbl_HeaderLines * 100) / Gbl_TotalLines);
 346     return;
 347 }
 348
 349
 350 /******************************************************************************
 351  *
 352  * FUNCTION:    AsDisplayUsage
 353  *
 354  * DESCRIPTION: Usage message
 355  *
 356  ******************************************************************************/
 357
 358 void
 359 AsDisplayUsage (
 360     void)
 361 {
 362
 363     ACPI_USAGE_HEADER ("acpisrc [-c|l|u] [-dsvy] <SourceDir> <DestinationDir>");
 364
 365     ACPI_OPTION ("-a <file>",   "Check entire file for non-printable characters");
 366     ACPI_OPTION ("-c",          "Generate cleaned version of the source");
 367     ACPI_OPTION ("-h",          "Insert dual-license header into all modules");
 368     ACPI_OPTION ("-i",          "Cleanup macro indentation");
 369     ACPI_OPTION ("-l",          "Generate Linux version of the source");
 370     ACPI_OPTION ("-u",          "Generate Custom source translation");
 371
 372     ACPI_USAGE_TEXT ("\n");
 373     ACPI_OPTION ("-d",          "Leave debug statements in code");
 374     ACPI_OPTION ("-s",          "Generate source statistics only");
 375     ACPI_OPTION ("-v",          "Display version information");
 376     ACPI_OPTION ("-vb",         "Verbose mode");
 377     ACPI_OPTION ("-vd",         "Display build date and time");
 378     ACPI_OPTION ("-y",          "Suppress file overwrite prompts");
 379 }
 380
 381
 382 /******************************************************************************
 383  *
 384  * FUNCTION:    main
 385  *
 386  * DESCRIPTION: C main function
 387  *
 388  ******************************************************************************/
 389
 390 int ACPI_SYSTEM_XFACE
 391 main (
 392     int                     argc,
 393     char                    *argv[])
 394 {
 395     int                     j;
 396     ACPI_CONVERSION_TABLE   *ConversionTable = NULL;
 397     char                    *SourcePath;
 398     char                    *TargetPath;
 399     UINT32                  FileType;
 400
 401
 402     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 403     AcpiOsInitialize ();
 404     printf (ACPI_COMMON_SIGNON (AS_UTILITY_NAME));
 405
 406     if (argc < 2)
 407     {
 408         AsDisplayUsage ();
 409         return (0);
 410     }
 411
 412     /* Command line options */
 413
 414     while ((j = AcpiGetopt (argc, argv, AS_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j)
 415     {
 416     case 'l':
 417
 418         /* Linux code generation */
 419
 420         printf ("Creating Linux source code\n");
 421         ConversionTable = &LinuxConversionTable;
 422         Gbl_WidenDeclarations = TRUE;
 423         Gbl_IgnoreLoneLineFeeds = TRUE;
 424         break;
 425
 426     case 'c':
 427
 428         /* Cleanup code */
 429
 430         printf ("Code cleanup\n");
 431         ConversionTable = &CleanupConversionTable;
 432         Gbl_Cleanup = TRUE;
 433         break;
 434
 435     case 'h':
 436
 437         /* Inject Dual-license header */
 438
 439         printf ("Inserting Dual-license header to all modules\n");
 440         ConversionTable = &LicenseConversionTable;
 441         break;
 442
 443     case 'i':
 444
 445         /* Cleanup wrong indent result */
 446
 447         printf ("Cleaning up macro indentation\n");
 448         ConversionTable = &IndentConversionTable;
 449         Gbl_IgnoreLoneLineFeeds = TRUE;
 450         Gbl_IgnoreTranslationEscapes = TRUE;
 451         break;
 452
 453     case 's':
 454
 455         /* Statistics only */
 456
 457         break;
 458
 459     case 'u':
 460
 461         /* custom conversion  */
 462
 463         printf ("Custom source translation\n");
 464         ConversionTable = &CustomConversionTable;
 465         break;
 466
 467     case 'v':
 468
 469         switch (AcpiGbl_Optarg[0])
 470         {
 471         case '^':  /* -v: (Version): signon already emitted, just exit */
 472
 473             exit (0);
 474
 475         case 'b':
 476
 477             /* Verbose mode */
 478
 479             Gbl_VerboseMode = TRUE;
 480             break;
 481
 482         case 'd':
 483
 484             printf (ACPI_COMMON_BUILD_TIME);
 485             return (0);
 486
 487         default:
 488
 489             printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
 490             return (-1);
 491         }
 492
 493         break;
 494
 495     case 'y':
 496
 497         /* Batch mode */
 498
 499         Gbl_BatchMode = TRUE;
 500         break;
 501
 502     case 'd':
 503
 504         /* Leave debug statements in */
 505
 506         Gbl_DebugStatementsMode = TRUE;
 507         break;
 508
 509     case 'q':
 510
 511         /* Quiet mode */
 512
 513         Gbl_QuietMode = TRUE;
 514         break;
 515
 516     case 'a':
 517
 518         Gbl_CheckAscii = TRUE;
 519         break;
 520
 521     default:
 522
 523         AsDisplayUsage ();
 524         return (-1);
 525     }
 526
 527
 528     SourcePath = argv[AcpiGbl_Optind];
 529     if (!SourcePath)
 530     {
 531         printf ("Missing source path\n");
 532         AsDisplayUsage ();
 533         return (-1);
 534     }
 535
 536     /* This option checks the entire file for printable ascii chars */
 537
 538     if (Gbl_CheckAscii)
 539     {
 540         AsProcessOneFile (NULL, NULL, NULL, 0, SourcePath, FILE_TYPE_SOURCE);
 541         return (0);
 542     }
 543
 544     TargetPath = argv[AcpiGbl_Optind+1];
 545
 546     if (!ConversionTable)
 547     {
 548         /* Just generate statistics. Ignore target path */
 549
 550         TargetPath = SourcePath;
 551
 552         printf ("Source code statistics only\n");
 553         ConversionTable = &StatsConversionTable;
 554     }
 555     else if (!TargetPath)
 556     {
 557         TargetPath = SourcePath;
 558     }
 559
 560     if (Gbl_DebugStatementsMode)
 561     {
 562         ConversionTable->SourceFunctions &= ~CVT_REMOVE_DEBUG_MACROS;
 563     }
 564
 565     /*
 566      * Set LF only support. Note ACPI_SRC_OS_LF_ONLY indicates that newlines
 567      * are represented as LF only rather than CR/LF
 568      */
 569     ConversionTable->Flags |= ACPI_SRC_OS_LF_ONLY;
 570     Gbl_IgnoreLoneLineFeeds = ACPI_SRC_OS_LF_ONLY;
 571
 572     /* Check source and target paths and files */
 573
 574     if (AsExaminePaths (ConversionTable, SourcePath, TargetPath, &FileType))
 575     {
 576         return (-1);
 577     }
 578
 579     /* Source/target can be either directories or a files */
 580
 581     if (FileType == S_IFDIR)
 582     {
 583         /* Process the directory tree */
 584
 585         AsProcessTree (ConversionTable, SourcePath, TargetPath);
 586     }
 587     else
 588     {
 589         if (Gbl_CheckAscii)
 590         {
 591             AsProcessOneFile (NULL, NULL, NULL, 0,
 592                 SourcePath, FILE_TYPE_SOURCE);
 593             return (0);
 594         }
 595
 596         /* Process a single file */
 597
 598         /* Differentiate between source and header files */
 599
 600         if (strstr (SourcePath, ".h"))
 601         {
 602             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0,
 603                 SourcePath, FILE_TYPE_HEADER);
 604         }
 605         else if (strstr (SourcePath, ".c"))
 606         {
 607             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0,
 608                 SourcePath, FILE_TYPE_SOURCE);
 609         }
 610         else if (strstr (SourcePath, ".patch"))
 611         {
 612             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0,
 613                 SourcePath, FILE_TYPE_PATCH);
 614         }
 615         else
 616         {
 617             printf ("Unknown file type - %s\n", SourcePath);
 618         }
 619     }
 620
 621     /* Always display final summary and stats */
 622
 623     AsDisplayStats ();
 624     return (0);
 625 }