sys/contrib/dev/acpica/source/compiler/aslascii.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aslascii - ASCII detection and support routines
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 "aslcompiler.h"
 153 #include <actables.h>
 154 #include <acapps.h>
 155
 156 #define _COMPONENT          ACPI_COMPILER
 157         ACPI_MODULE_NAME    ("aslascii")
 158
 159
 160 /* Local prototypes */
 161
 162 static void
 163 FlConsumeAnsiComment (
 164     FILE                    *Handle,
 165     ASL_FILE_STATUS         *Status);
 166
 167 static void
 168 FlConsumeNewComment (
 169     FILE                    *Handle,
 170     ASL_FILE_STATUS         *Status);
 171
 172
 173 /*******************************************************************************
 174  *
 175  * FUNCTION:    FlIsFileAsciiSource
 176  *
 177  * PARAMETERS:  Filename            - Full input filename
 178  *              DisplayErrors       - TRUE if error messages desired
 179  *
 180  * RETURN:      Status
 181  *
 182  * DESCRIPTION: Verify that the input file is entirely ASCII. Ignores characters
 183  *              within comments. Note: does not handle nested comments and does
 184  *              not handle comment delimiters within string literals. However,
 185  *              on the rare chance this happens and an invalid character is
 186  *              missed, the parser will catch the error by failing in some
 187  *              spectactular manner.
 188  *
 189  ******************************************************************************/
 190
 191 ACPI_STATUS
 192 FlIsFileAsciiSource (
 193     char                    *Filename,
 194     BOOLEAN                 DisplayErrors)
 195 {
 196     UINT8                   Byte;
 197     UINT32                  BadBytes = 0;
 198     BOOLEAN                 OpeningComment = FALSE;
 199     ASL_FILE_STATUS         Status;
 200     FILE                    *Handle;
 201
 202
 203     /* Open file in text mode so file offset is always accurate */
 204
 205     Handle = fopen (Filename, "rb");
 206     if (!Handle)
 207     {
 208         perror ("Could not open input file");
 209         return (AE_ERROR);
 210     }
 211
 212     Status.Line = 1;
 213     Status.Offset = 0;
 214
 215     /* Read the entire file */
 216
 217     while (fread (&Byte, 1, 1, Handle) == 1)
 218     {
 219         /* Ignore comment fields (allow non-ascii within) */
 220
 221         if (OpeningComment)
 222         {
 223             /* Check for second comment open delimiter */
 224
 225             if (Byte == '*')
 226             {
 227                 FlConsumeAnsiComment (Handle, &Status);
 228             }
 229
 230             if (Byte == '/')
 231             {
 232                 FlConsumeNewComment (Handle, &Status);
 233             }
 234
 235             /* Reset */
 236
 237             OpeningComment = FALSE;
 238         }
 239         else if (Byte == '/')
 240         {
 241             OpeningComment = TRUE;
 242         }
 243
 244         /* Check for an ASCII character */
 245
 246         if (!ACPI_IS_ASCII (Byte))
 247         {
 248             if ((BadBytes < 10) && (DisplayErrors))
 249             {
 250                 AcpiOsPrintf (
 251                     "Found non-ASCII character in source text: "
 252                     "0x%2.2X in line %u, file offset 0x%2.2X\n",
 253                     Byte, Status.Line, Status.Offset);
 254             }
 255             BadBytes++;
 256         }
 257
 258         /* Ensure character is either printable or a "space" char */
 259
 260         else if (!isprint (Byte) && !isspace (Byte))
 261         {
 262             if ((BadBytes < 10) && (DisplayErrors))
 263             {
 264                 AcpiOsPrintf (
 265                     "Found invalid character in source text: "
 266                     "0x%2.2X in line %u, file offset 0x%2.2X\n",
 267                     Byte, Status.Line, Status.Offset);
 268             }
 269             BadBytes++;
 270         }
 271
 272         /* Update line counter as necessary */
 273
 274         if (Byte == 0x0A)
 275         {
 276             Status.Line++;
 277         }
 278
 279         Status.Offset++;
 280     }
 281
 282     fclose (Handle);
 283
 284     /* Were there any non-ASCII characters in the file? */
 285
 286     if (BadBytes)
 287     {
 288         fprintf (stderr,
 289             "File appears to be binary: found %u non-ASCII characters, disassembling\n",
 290             BadBytes);
 291         if (DisplayErrors)
 292         {
 293             AcpiOsPrintf (
 294                 "Total %u invalid characters found in input source text, "
 295                 "could be a binary file\n", BadBytes);
 296             AslError (ASL_ERROR, ASL_MSG_NON_ASCII, NULL, Filename);
 297         }
 298
 299         return (AE_BAD_CHARACTER);
 300     }
 301
 302     /* File is OK (100% ASCII) */
 303
 304     return (AE_OK);
 305 }
 306
 307
 308 /*******************************************************************************
 309  *
 310  * FUNCTION:    FlConsumeAnsiComment
 311  *
 312  * PARAMETERS:  Handle              - Open input file
 313  *              Status              - File current status struct
 314  *
 315  * RETURN:      Number of lines consumed
 316  *
 317  * DESCRIPTION: Step over a normal slash-star type comment
 318  *
 319  ******************************************************************************/
 320
 321 static void
 322 FlConsumeAnsiComment (
 323     FILE                    *Handle,
 324     ASL_FILE_STATUS         *Status)
 325 {
 326     UINT8                   Byte;
 327     BOOLEAN                 ClosingComment = FALSE;
 328
 329
 330     while (fread (&Byte, 1, 1, Handle) == 1)
 331     {
 332         /* Scan until comment close is found */
 333
 334         if (ClosingComment)
 335         {
 336             if (Byte == '/')
 337             {
 338                 Status->Offset++;
 339                 return;
 340             }
 341
 342             if (Byte != '*')
 343             {
 344                 /* Reset */
 345
 346                 ClosingComment = FALSE;
 347             }
 348         }
 349         else if (Byte == '*')
 350         {
 351             ClosingComment = TRUE;
 352         }
 353
 354         /* Maintain line count */
 355
 356         if (Byte == 0x0A)
 357         {
 358             Status->Line++;
 359         }
 360
 361         Status->Offset++;
 362     }
 363 }
 364
 365
 366 /*******************************************************************************
 367  *
 368  * FUNCTION:    FlConsumeNewComment
 369  *
 370  * PARAMETERS:  Handle              - Open input file
 371  *              Status              - File current status struct
 372  *
 373  * RETURN:      Number of lines consumed
 374  *
 375  * DESCRIPTION: Step over a slash-slash type of comment
 376  *
 377  ******************************************************************************/
 378
 379 static void
 380 FlConsumeNewComment (
 381     FILE                    *Handle,
 382     ASL_FILE_STATUS         *Status)
 383 {
 384     UINT8                   Byte;
 385
 386
 387     while (fread (&Byte, 1, 1, Handle) == 1)
 388     {
 389         Status->Offset++;
 390
 391         /* Comment ends at newline */
 392
 393         if (Byte == 0x0A)
 394         {
 395             Status->Line++;
 396             return;
 397         }
 398     }
 399 }