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

   1 /******************************************************************************
   2  *
   3  * Module Name: asldebug -- Debug output support
   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 "aslcompiler.h"
 153 #include "aslcompiler.y.h"
 154
 155
 156 #define _COMPONENT          ACPI_COMPILER
 157         ACPI_MODULE_NAME    ("asldebug")
 158
 159
 160 /* Local prototypes */
 161
 162 static void
 163 UtDumpParseOpName (
 164     ACPI_PARSE_OBJECT       *Op,
 165     UINT32                  Level,
 166     UINT32                  DataLength);
 167
 168 static char *
 169 UtCreateEscapeSequences (
 170     char                    *InString);
 171
 172
 173 /*******************************************************************************
 174  *
 175  * FUNCTION:    CvDbgPrint
 176  *
 177  * PARAMETERS:  Type                - Type of output
 178  *              Fmt                 - Printf format string
 179  *              ...                 - variable printf list
 180  *
 181  * RETURN:      None
 182  *
 183  * DESCRIPTION: Print statement for debug messages within the converter.
 184  *
 185  ******************************************************************************/
 186
 187 void
 188 CvDbgPrint (
 189     char                    *Fmt,
 190     ...)
 191 {
 192     va_list                 Args;
 193
 194
 195     if (!Gbl_CaptureComments || !AcpiGbl_DebugAslConversion)
 196     {
 197         return;
 198     }
 199
 200     va_start (Args, Fmt);
 201     (void) vfprintf (AcpiGbl_ConvDebugFile, Fmt, Args);
 202     va_end (Args);
 203     return;
 204 }
 205
 206
 207 /*******************************************************************************
 208  *
 209  * FUNCTION:    UtDumpIntegerOp
 210  *
 211  * PARAMETERS:  Op                  - Current parse op
 212  *              Level               - Current output indentation level
 213  *              IntegerLength       - Output length of the integer (2/4/8/16)
 214  *
 215  * RETURN:      None
 216  *
 217  * DESCRIPTION: Emit formatted debug output for "integer" ops.
 218  *              Note: IntegerLength must be one of 2,4,8,16.
 219  *
 220  ******************************************************************************/
 221
 222 void
 223 UtDumpIntegerOp (
 224     ACPI_PARSE_OBJECT       *Op,
 225     UINT32                  Level,
 226     UINT32                  IntegerLength)
 227 {
 228
 229     /* Emit the ParseOp name, leaving room for the integer */
 230
 231     UtDumpParseOpName (Op, Level, IntegerLength);
 232
 233     /* Emit the integer based upon length */
 234
 235     switch (IntegerLength)
 236     {
 237     case 2: /* Byte */
 238     case 4: /* Word */
 239     case 8: /* Dword */
 240
 241         DbgPrint (ASL_TREE_OUTPUT,
 242             "%*.*X", IntegerLength, IntegerLength, Op->Asl.Value.Integer);
 243         break;
 244
 245     case 16: /* Qword and Integer */
 246
 247         DbgPrint (ASL_TREE_OUTPUT,
 248             "%8.8X%8.8X", ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
 249         break;
 250
 251     default:
 252         break;
 253     }
 254 }
 255
 256
 257 /*******************************************************************************
 258  *
 259  * FUNCTION:    UtDumpStringOp
 260  *
 261  * PARAMETERS:  Op                  - Current parse op
 262  *              Level               - Current output indentation level
 263  *
 264  * RETURN:      None
 265  *
 266  * DESCRIPTION: Emit formatted debug output for String/Pathname ops.
 267  *
 268  ******************************************************************************/
 269
 270 void
 271 UtDumpStringOp (
 272     ACPI_PARSE_OBJECT       *Op,
 273     UINT32                  Level)
 274 {
 275     char                    *String;
 276
 277
 278     String = Op->Asl.Value.String;
 279     if (Op->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
 280     {
 281         /*
 282          * For the "path" ops NAMEPATH, NAMESEG, METHODCALL -- if the
 283          * ExternalName is valid, it takes precedence. In these cases the
 284          * Value.String is the raw "internal" name from the AML code, which
 285          * we don't want to use, because it contains non-ascii characters.
 286          */
 287         if (Op->Asl.ExternalName)
 288         {
 289             String = Op->Asl.ExternalName;
 290         }
 291     }
 292
 293     if (!String)
 294     {
 295         DbgPrint (ASL_TREE_OUTPUT,
 296             " ERROR: Could not find a valid String/Path pointer\n");
 297         return;
 298     }
 299
 300     String = UtCreateEscapeSequences (String);
 301
 302     /* Emit the ParseOp name, leaving room for the string */
 303
 304     UtDumpParseOpName (Op, Level, strlen (String));
 305     DbgPrint (ASL_TREE_OUTPUT, "%s", String);
 306 }
 307
 308
 309 /*******************************************************************************
 310  *
 311  * FUNCTION:    UtCreateEscapeSequences
 312  *
 313  * PARAMETERS:  InString            - ASCII string to be expanded
 314  *
 315  * RETURN:      Expanded string
 316  *
 317  * DESCRIPTION: Expand all non-printable ASCII bytes (0-0x1F) to escape
 318  *              sequences. For example, hex 14 becomes \x14
 319  *
 320  * NOTE:        Since this function is used for debug output only, it does
 321  *              not attempt to translate into the "known" escape sequences
 322  *              such as \a, \f, \t, etc.
 323  *
 324  ******************************************************************************/
 325
 326 static char *
 327 UtCreateEscapeSequences (
 328     char                    *InString)
 329 {
 330     char                    *String = InString;
 331     char                    *OutString;
 332     char                    *OutStringPtr;
 333     UINT32                  InStringLength = 0;
 334     UINT32                  EscapeCount = 0;
 335
 336
 337     /*
 338      * Determine up front how many escapes are within the string.
 339      * Obtain the input string length while doing so.
 340      */
 341     while (*String)
 342     {
 343         if ((*String <= 0x1F) || (*String >= 0x7F))
 344         {
 345             EscapeCount++;
 346         }
 347
 348         InStringLength++;
 349         String++;
 350     }
 351
 352     if (!EscapeCount)
 353     {
 354         return (InString); /* No escapes, nothing to do */
 355     }
 356
 357     /* New string buffer, 3 extra chars per escape (4 total) */
 358
 359     OutString = UtLocalCalloc (InStringLength + (EscapeCount * 3));
 360     OutStringPtr = OutString;
 361
 362     /* Convert non-ascii or non-printable chars to escape sequences */
 363
 364     while (*InString)
 365     {
 366         if ((*InString <= 0x1F) || (*InString >= 0x7F))
 367         {
 368             /* Insert a \x hex escape sequence */
 369
 370             OutStringPtr[0] = '\\';
 371             OutStringPtr[1] = 'x';
 372             OutStringPtr[2] = AcpiUtHexToAsciiChar (*InString, 4);
 373             OutStringPtr[3] = AcpiUtHexToAsciiChar (*InString, 0);
 374             OutStringPtr += 4;
 375         }
 376         else /* Normal ASCII character */
 377         {
 378             *OutStringPtr = *InString;
 379             OutStringPtr++;
 380         }
 381
 382         InString++;
 383     }
 384
 385     return (OutString);
 386 }
 387
 388
 389 /*******************************************************************************
 390  *
 391  * FUNCTION:    UtDumpBasicOp
 392  *
 393  * PARAMETERS:  Op                  - Current parse op
 394  *              Level               - Current output indentation level
 395  *
 396  * RETURN:      None
 397  *
 398  * DESCRIPTION: Generic formatted debug output for "basic" ops that have no
 399  *              associated strings or integer values.
 400  *
 401  ******************************************************************************/
 402
 403 void
 404 UtDumpBasicOp (
 405     ACPI_PARSE_OBJECT       *Op,
 406     UINT32                  Level)
 407 {
 408
 409     /* Just print out the ParseOp name, there is no extra data */
 410
 411     UtDumpParseOpName (Op, Level, 0);
 412 }
 413
 414
 415 /*******************************************************************************
 416  *
 417  * FUNCTION:    UtDumpParseOpName
 418  *
 419  * PARAMETERS:  Op                  - Current parse op
 420  *              Level               - Current output indentation level
 421  *              DataLength          - Length of data to appear after the name
 422  *
 423  * RETURN:      None
 424  *
 425  * DESCRIPTION: Indent and emit the ascii ParseOp name for the op
 426  *
 427  ******************************************************************************/
 428
 429 static void
 430 UtDumpParseOpName (
 431     ACPI_PARSE_OBJECT       *Op,
 432     UINT32                  Level,
 433     UINT32                  DataLength)
 434 {
 435     char                    *ParseOpName;
 436     UINT32                  IndentLength;
 437     UINT32                  NameLength;
 438     UINT32                  LineLength;
 439     UINT32                  PaddingLength;
 440
 441
 442     /* Emit the LineNumber/IndentLevel prefix on each output line */
 443
 444     DbgPrint (ASL_TREE_OUTPUT,
 445         "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);
 446
 447     ParseOpName = UtGetOpName (Op->Asl.ParseOpcode);
 448
 449     /* Calculate various lengths for output alignment */
 450
 451     IndentLength = Level * DEBUG_SPACES_PER_INDENT;
 452     NameLength = strlen (ParseOpName);
 453     LineLength = IndentLength + 1 + NameLength + 1 + DataLength;
 454     PaddingLength = (DEBUG_MAX_LINE_LENGTH + 1) - LineLength;
 455
 456     /* Parse tree indentation is based upon the nesting/indent level */
 457
 458     if (Level)
 459     {
 460         DbgPrint (ASL_TREE_OUTPUT, "%*s", IndentLength, " ");
 461     }
 462
 463     /* Emit the actual name here */
 464
 465     DbgPrint (ASL_TREE_OUTPUT, " %s", ParseOpName);
 466
 467     /* Emit extra padding blanks for alignment of later data items */
 468
 469     if (LineLength > DEBUG_MAX_LINE_LENGTH)
 470     {
 471         /* Split a long line immediately after the ParseOpName string */
 472
 473         DbgPrint (ASL_TREE_OUTPUT, "\n%*s",
 474             (DEBUG_FULL_LINE_LENGTH - DataLength), " ");
 475     }
 476     else
 477     {
 478         DbgPrint (ASL_TREE_OUTPUT, "%*s", PaddingLength, " ");
 479     }
 480 }