1 /******************************************************************************
3 * Module Name: asfile - Main module for the acpi source processor utility
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
118 /* Local prototypes */
122 ACPI_CONVERSION_TABLE *ConversionTable,
130 AsDetectLoneLineFeeds (
134 static ACPI_INLINE int
135 AsMaxInt (int a, int b)
137 return (a > b ? a : b);
141 /******************************************************************************
143 * FUNCTION: AsDoWildcard
145 * DESCRIPTION: Process files via wildcards
147 ******************************************************************************/
151 ACPI_CONVERSION_TABLE *ConversionTable,
162 char RequestedFileType;
165 if (FileType == FILE_TYPE_DIRECTORY)
167 RequestedFileType = REQUEST_DIR_ONLY;
171 RequestedFileType = REQUEST_FILE_ONLY;
174 VERBOSE_PRINT (("Checking for %s source files in directory \"%s\"\n",
175 WildcardSpec, SourcePath));
177 /* Open the directory for wildcard search */
179 DirInfo = AcpiOsOpenDirectory (SourcePath, WildcardSpec, RequestedFileType);
183 * Get all of the files that match both the
184 * wildcard and the requested file type
186 while ((Filename = AcpiOsGetNextFilename (DirInfo)))
188 /* Looking for directory files, must check file type */
190 switch (RequestedFileType)
192 case REQUEST_DIR_ONLY:
194 /* If we actually have a dir, process the subtree */
196 if (!AsCheckForDirectory (SourcePath, TargetPath, Filename,
197 &SourceDirPath, &TargetDirPath))
199 VERBOSE_PRINT (("Subdirectory: %s\n", Filename));
201 AsProcessTree (ConversionTable, SourceDirPath, TargetDirPath);
202 free (SourceDirPath);
203 free (TargetDirPath);
207 case REQUEST_FILE_ONLY:
209 /* Otherwise, this is a file, not a directory */
211 VERBOSE_PRINT (("File: %s\n", Filename));
213 AsProcessOneFile (ConversionTable, SourcePath, TargetPath,
214 MaxPathLength, Filename, FileType);
224 AcpiOsCloseDirectory (DirInfo);
229 /******************************************************************************
231 * FUNCTION: AsProcessTree
233 * DESCRIPTION: Process the directory tree. Files with the extension ".C" and
234 * ".H" are processed as the tree is traversed.
236 ******************************************************************************/
240 ACPI_CONVERSION_TABLE *ConversionTable,
247 MaxPathLength = AsMaxInt (strlen (SourcePath), strlen (TargetPath));
249 if (!(ConversionTable->Flags & FLG_NO_FILE_OUTPUT))
251 if (ConversionTable->Flags & FLG_LOWERCASE_DIRNAMES)
256 VERBOSE_PRINT (("Creating Directory \"%s\"\n", TargetPath));
257 if (mkdir (TargetPath))
261 printf ("Could not create target directory\n");
267 /* Do the C source files */
269 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
270 FILE_TYPE_SOURCE, "*.c");
272 /* Do the C header files */
274 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
275 FILE_TYPE_HEADER, "*.h");
277 /* Do the Lex file(s) */
279 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
280 FILE_TYPE_SOURCE, "*.l");
282 /* Do the yacc file(s) */
284 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
285 FILE_TYPE_SOURCE, "*.y");
287 /* Do any ASL files */
289 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
290 FILE_TYPE_HEADER, "*.asl");
292 /* Do any subdirectories */
294 AsDoWildcard (ConversionTable, SourcePath, TargetPath, MaxPathLength,
295 FILE_TYPE_DIRECTORY, "*");
301 /******************************************************************************
303 * FUNCTION: AsDetectLoneLineFeeds
305 * DESCRIPTION: Find LF without CR.
307 ******************************************************************************/
310 AsDetectLoneLineFeeds (
316 UINT32 LineCount = 0;
326 if (Buffer[i] == 0x0A)
328 if (Buffer[i-1] != 0x0D)
339 if (LineCount == LfCount)
341 if (!Gbl_IgnoreLoneLineFeeds)
343 printf ("%s: ****File has UNIX format**** (LF only, not CR/LF) %u lines\n",
349 printf ("%s: %u lone linefeeds in file\n", Filename, LfCount);
358 /******************************************************************************
360 * FUNCTION: AsConvertFile
362 * DESCRIPTION: Perform the requested transforms on the file buffer (as
363 * determined by the ConversionTable and the FileType).
365 ******************************************************************************/
369 ACPI_CONVERSION_TABLE *ConversionTable,
372 ACPI_NATIVE_INT FileType)
376 ACPI_STRING_TABLE *StringTable;
377 ACPI_IDENTIFIER_TABLE *ConditionalTable;
378 ACPI_IDENTIFIER_TABLE *LineTable;
379 ACPI_IDENTIFIER_TABLE *MacroTable;
380 ACPI_TYPED_IDENTIFIER_TABLE *StructTable;
385 case FILE_TYPE_SOURCE:
386 Functions = ConversionTable->SourceFunctions;
387 StringTable = ConversionTable->SourceStringTable;
388 LineTable = ConversionTable->SourceLineTable;
389 ConditionalTable = ConversionTable->SourceConditionalTable;
390 MacroTable = ConversionTable->SourceMacroTable;
391 StructTable = ConversionTable->SourceStructTable;
394 case FILE_TYPE_HEADER:
395 Functions = ConversionTable->HeaderFunctions;
396 StringTable = ConversionTable->HeaderStringTable;
397 LineTable = ConversionTable->HeaderLineTable;
398 ConditionalTable = ConversionTable->HeaderConditionalTable;
399 MacroTable = ConversionTable->HeaderMacroTable;
400 StructTable = ConversionTable->HeaderStructTable;
404 printf ("Unknown file type, cannot process\n");
409 Gbl_StructDefs = strstr (FileBuffer, "/* acpisrc:StructDefs");
411 VERBOSE_PRINT (("Processing %u bytes\n",
412 (unsigned int) strlen (FileBuffer)));
416 AsRemoveExtraLines (FileBuffer, Filename);
417 AsRemoveSpacesAfterPeriod (FileBuffer, Filename);
420 if (ConversionTable->LowerCaseTable)
422 for (i = 0; ConversionTable->LowerCaseTable[i].Identifier; i++)
424 AsLowerCaseString (ConversionTable->LowerCaseTable[i].Identifier,
429 /* Process all the string replacements */
433 for (i = 0; StringTable[i].Target; i++)
435 AsReplaceString (StringTable[i].Target, StringTable[i].Replacement,
436 StringTable[i].Type, FileBuffer);
442 for (i = 0; LineTable[i].Identifier; i++)
444 AsRemoveLine (FileBuffer, LineTable[i].Identifier);
448 if (ConditionalTable)
450 for (i = 0; ConditionalTable[i].Identifier; i++)
452 AsRemoveConditionalCompile (FileBuffer, ConditionalTable[i].Identifier);
458 for (i = 0; MacroTable[i].Identifier; i++)
460 AsRemoveMacro (FileBuffer, MacroTable[i].Identifier);
466 for (i = 0; StructTable[i].Identifier; i++)
468 AsInsertPrefix (FileBuffer, StructTable[i].Identifier, StructTable[i].Type);
472 /* Process the function table */
474 for (i = 0; i < 32; i++)
476 /* Decode the function bitmap */
478 switch ((1 << i) & Functions)
481 /* This function not configured */
487 AsCountTabs (FileBuffer, Filename);
491 case CVT_COUNT_NON_ANSI_COMMENTS:
493 AsCountNonAnsiComments (FileBuffer, Filename);
497 case CVT_CHECK_BRACES:
499 AsCheckForBraces (FileBuffer, Filename);
505 AsTrimLines (FileBuffer, Filename);
509 case CVT_COUNT_LINES:
511 AsCountSourceLines (FileBuffer, Filename);
515 case CVT_BRACES_ON_SAME_LINE:
517 AsBracesOnSameLine (FileBuffer);
521 case CVT_MIXED_CASE_TO_UNDERSCORES:
523 AsMixedCaseToUnderscores (FileBuffer, Filename);
527 case CVT_LOWER_CASE_IDENTIFIERS:
529 AsLowerCaseIdentifiers (FileBuffer);
533 case CVT_REMOVE_DEBUG_MACROS:
535 AsRemoveDebugMacros (FileBuffer);
539 case CVT_TRIM_WHITESPACE:
541 AsTrimWhitespace (FileBuffer);
545 case CVT_REMOVE_EMPTY_BLOCKS:
547 AsRemoveEmptyBlocks (FileBuffer, Filename);
551 case CVT_REDUCE_TYPEDEFS:
553 AsReduceTypedefs (FileBuffer, "typedef union");
554 AsReduceTypedefs (FileBuffer, "typedef struct");
558 case CVT_SPACES_TO_TABS4:
560 AsTabify4 (FileBuffer);
564 case CVT_SPACES_TO_TABS8:
566 AsTabify8 (FileBuffer);
569 case CVT_COUNT_SHORTMULTILINE_COMMENTS:
571 #ifdef ACPI_FUTURE_IMPLEMENTATION
572 AsTrimComments (FileBuffer, Filename);
578 printf ("Unknown conversion subfunction opcode\n");
583 if (ConversionTable->NewHeader)
585 AsReplaceHeader (FileBuffer, ConversionTable->NewHeader);
590 /******************************************************************************
592 * FUNCTION: AsProcessOneFile
594 * DESCRIPTION: Process one source file. The file is opened, read entirely
595 * into a buffer, converted, then written to a new file.
597 ******************************************************************************/
601 ACPI_CONVERSION_TABLE *ConversionTable,
606 ACPI_NATIVE_INT FileType)
609 char *OutPathname = NULL;
612 /* Allocate a file pathname buffer for both source and target */
614 Pathname = calloc (MaxPathLength + strlen (Filename) + 2, 1);
617 printf ("Could not allocate buffer for file pathnames\n");
621 Gbl_FileType = FileType;
623 /* Generate the source pathname and read the file */
627 strcpy (Pathname, SourcePath);
628 strcat (Pathname, "/");
631 strcat (Pathname, Filename);
633 if (AsGetFile (Pathname, &Gbl_FileBuffer, &Gbl_FileSize))
639 if (strstr (Filename, ".asl"))
641 Gbl_HeaderSize = LINES_IN_ASL_HEADER; /* Lines in default ASL header */
643 else if (strstr (Gbl_FileBuffer, LEGAL_HEADER_SIGNATURE))
645 Gbl_HeaderSize = LINES_IN_LEGAL_HEADER; /* Normal C file and H header */
647 else if (strstr (Gbl_FileBuffer, LINUX_HEADER_SIGNATURE))
649 Gbl_HeaderSize = LINES_IN_LINUX_HEADER; /* Linuxized C file and H header */
652 /* Process the file in the buffer */
654 Gbl_MadeChanges = FALSE;
655 if (!Gbl_IgnoreLoneLineFeeds && Gbl_HasLoneLineFeeds)
658 * All lone LFs will be converted to CR/LF
659 * (when file is written, Windows version only)
661 printf ("Converting lone linefeeds\n");
662 Gbl_MadeChanges = TRUE;
665 AsConvertFile (ConversionTable, Gbl_FileBuffer, Pathname, FileType);
667 if (!(ConversionTable->Flags & FLG_NO_FILE_OUTPUT))
669 if (!(Gbl_Overwrite && !Gbl_MadeChanges))
671 /* Generate the target pathname and write the file */
673 OutPathname = calloc (MaxPathLength + strlen (Filename) + 2 + strlen (TargetPath), 1);
676 printf ("Could not allocate buffer for file pathnames\n");
680 strcpy (OutPathname, TargetPath);
683 strcat (OutPathname, "/");
684 strcat (OutPathname, Filename);
687 AsPutFile (OutPathname, Gbl_FileBuffer, ConversionTable->Flags);
691 free (Gbl_FileBuffer);
702 /******************************************************************************
704 * FUNCTION: AsCheckForDirectory
706 * DESCRIPTION: Check if the current file is a valid directory. If not,
707 * construct the full pathname for the source and target paths.
708 * Checks for the dot and dot-dot files (they are ignored)
710 ******************************************************************************/
713 AsCheckForDirectory (
724 if (!(strcmp (Filename, ".")) ||
725 !(strcmp (Filename, "..")))
730 SrcPath = calloc (strlen (SourceDirPath) + strlen (Filename) + 2, 1);
733 printf ("Could not allocate buffer for directory source pathname\n");
737 TgtPath = calloc (strlen (TargetDirPath) + strlen (Filename) + 2, 1);
740 printf ("Could not allocate buffer for directory target pathname\n");
745 strcpy (SrcPath, SourceDirPath);
746 strcat (SrcPath, "/");
747 strcat (SrcPath, Filename);
749 strcpy (TgtPath, TargetDirPath);
750 strcat (TgtPath, "/");
751 strcat (TgtPath, Filename);
753 *SourcePath = SrcPath;
754 *TargetPath = TgtPath;
759 /******************************************************************************
761 * FUNCTION: AsGetFile
763 * DESCRIPTION: Open a file and read it entirely into a an allocated buffer
765 ******************************************************************************/
779 /* Binary mode leaves CR/LF pairs */
781 FileHandle = open (Filename, O_BINARY | O_RDONLY);
784 printf ("Could not open %s\n", Filename);
788 if (fstat (FileHandle, &Gbl_StatBuf))
790 printf ("Could not get file status for %s\n", Filename);
795 * Create a buffer for the entire file
796 * Add plenty extra buffer to accommodate string replacements
798 Size = Gbl_StatBuf.st_size;
799 Gbl_TotalSize += Size;
801 Buffer = calloc (Size * 2, 1);
804 printf ("Could not allocate buffer of size %u\n", Size * 2);
808 /* Read the entire file */
810 Size = read (FileHandle, Buffer, Size);
813 printf ("Could not read the input file %s\n", Filename);
817 Buffer [Size] = 0; /* Null terminate the buffer */
820 /* Check for unix contamination */
822 Gbl_HasLoneLineFeeds = AsDetectLoneLineFeeds (Filename, Buffer);
825 * Convert all CR/LF pairs to LF only. We do this locally so that
826 * this code is portable across operating systems.
828 AsConvertToLineFeeds (Buffer);
830 *FileBuffer = Buffer;
843 /******************************************************************************
845 * FUNCTION: AsPutFile
847 * DESCRIPTION: Create a new output file and write the entire contents of the
848 * buffer to the new file. Buffer must be a zero terminated string
850 ******************************************************************************/
863 /* Create the target file */
865 OpenFlags = O_TRUNC | O_CREAT | O_WRONLY | O_BINARY;
867 if (!(SystemFlags & FLG_NO_CARRIAGE_RETURNS))
869 /* Put back the CR before each LF */
871 AsInsertCarriageReturns (FileBuffer);
874 DestHandle = open (Pathname, OpenFlags, S_IREAD | S_IWRITE);
875 if (DestHandle == -1)
877 perror ("Could not create destination file");
878 printf ("Could not create destination file \"%s\"\n", Pathname);
882 /* Write the buffer to the file */
884 FileSize = strlen (FileBuffer);
885 if (write (DestHandle, FileBuffer, FileSize) == -1)
887 printf ("Error writing output file \"%s\"\n", Pathname);