src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/uterror.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: uterror - Various internal error/warning output functions
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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 #define __UTERROR_C__
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "acnamesp.h"
 121
 122
 123 #define _COMPONENT          ACPI_UTILITIES
 124         ACPI_MODULE_NAME    ("uterror")
 125
 126
 127 /*
 128  * This module contains internal error functions that may
 129  * be configured out.
 130  */
 131 #if !defined (ACPI_NO_ERROR_MESSAGES)
 132
 133 /*******************************************************************************
 134  *
 135  * FUNCTION:    AcpiUtPredefinedWarning
 136  *
 137  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 138  *              LineNumber      - Caller's line number (for error output)
 139  *              Pathname        - Full pathname to the node
 140  *              NodeFlags       - From Namespace node for the method/object
 141  *              Format          - Printf format string + additional args
 142  *
 143  * RETURN:      None
 144  *
 145  * DESCRIPTION: Warnings for the predefined validation module. Messages are
 146  *              only emitted the first time a problem with a particular
 147  *              method/object is detected. This prevents a flood of error
 148  *              messages for methods that are repeatedly evaluated.
 149  *
 150  ******************************************************************************/
 151
 152 void ACPI_INTERNAL_VAR_XFACE
 153 AcpiUtPredefinedWarning (
 154     const char              *ModuleName,
 155     UINT32                  LineNumber,
 156     char                    *Pathname,
 157     UINT8                   NodeFlags,
 158     const char              *Format,
 159     ...)
 160 {
 161     va_list                 ArgList;
 162
 163
 164     /*
 165      * Warning messages for this method/object will be disabled after the
 166      * first time a validation fails or an object is successfully repaired.
 167      */
 168     if (NodeFlags & ANOBJ_EVALUATED)
 169     {
 170         return;
 171     }
 172
 173     AcpiOsPrintf (ACPI_MSG_WARNING "%s: ", Pathname);
 174
 175     va_start (ArgList, Format);
 176     AcpiOsVprintf (Format, ArgList);
 177     ACPI_MSG_SUFFIX;
 178     va_end (ArgList);
 179 }
 180
 181
 182 /*******************************************************************************
 183  *
 184  * FUNCTION:    AcpiUtPredefinedInfo
 185  *
 186  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 187  *              LineNumber      - Caller's line number (for error output)
 188  *              Pathname        - Full pathname to the node
 189  *              NodeFlags       - From Namespace node for the method/object
 190  *              Format          - Printf format string + additional args
 191  *
 192  * RETURN:      None
 193  *
 194  * DESCRIPTION: Info messages for the predefined validation module. Messages
 195  *              are only emitted the first time a problem with a particular
 196  *              method/object is detected. This prevents a flood of
 197  *              messages for methods that are repeatedly evaluated.
 198  *
 199  ******************************************************************************/
 200
 201 void ACPI_INTERNAL_VAR_XFACE
 202 AcpiUtPredefinedInfo (
 203     const char              *ModuleName,
 204     UINT32                  LineNumber,
 205     char                    *Pathname,
 206     UINT8                   NodeFlags,
 207     const char              *Format,
 208     ...)
 209 {
 210     va_list                 ArgList;
 211
 212
 213     /*
 214      * Warning messages for this method/object will be disabled after the
 215      * first time a validation fails or an object is successfully repaired.
 216      */
 217     if (NodeFlags & ANOBJ_EVALUATED)
 218     {
 219         return;
 220     }
 221
 222     AcpiOsPrintf (ACPI_MSG_INFO "%s: ", Pathname);
 223
 224     va_start (ArgList, Format);
 225     AcpiOsVprintf (Format, ArgList);
 226     ACPI_MSG_SUFFIX;
 227     va_end (ArgList);
 228 }
 229
 230
 231 /*******************************************************************************
 232  *
 233  * FUNCTION:    AcpiUtPredefinedBiosError
 234  *
 235  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
 236  *              LineNumber      - Caller's line number (for error output)
 237  *              Pathname        - Full pathname to the node
 238  *              NodeFlags       - From Namespace node for the method/object
 239  *              Format          - Printf format string + additional args
 240  *
 241  * RETURN:      None
 242  *
 243  * DESCRIPTION: BIOS error message for predefined names. Messages
 244  *              are only emitted the first time a problem with a particular
 245  *              method/object is detected. This prevents a flood of
 246  *              messages for methods that are repeatedly evaluated.
 247  *
 248  ******************************************************************************/
 249
 250 void ACPI_INTERNAL_VAR_XFACE
 251 AcpiUtPredefinedBiosError (
 252     const char              *ModuleName,
 253     UINT32                  LineNumber,
 254     char                    *Pathname,
 255     UINT8                   NodeFlags,
 256     const char              *Format,
 257     ...)
 258 {
 259     va_list                 ArgList;
 260
 261
 262     /*
 263      * Warning messages for this method/object will be disabled after the
 264      * first time a validation fails or an object is successfully repaired.
 265      */
 266     if (NodeFlags & ANOBJ_EVALUATED)
 267     {
 268         return;
 269     }
 270
 271     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s: ", Pathname);
 272
 273     va_start (ArgList, Format);
 274     AcpiOsVprintf (Format, ArgList);
 275     ACPI_MSG_SUFFIX;
 276     va_end (ArgList);
 277 }
 278
 279
 280 /*******************************************************************************
 281  *
 282  * FUNCTION:    AcpiUtNamespaceError
 283  *
 284  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 285  *              LineNumber          - Caller's line number (for error output)
 286  *              InternalName        - Name or path of the namespace node
 287  *              LookupStatus        - Exception code from NS lookup
 288  *
 289  * RETURN:      None
 290  *
 291  * DESCRIPTION: Print error message with the full pathname for the NS node.
 292  *
 293  ******************************************************************************/
 294
 295 void
 296 AcpiUtNamespaceError (
 297     const char              *ModuleName,
 298     UINT32                  LineNumber,
 299     const char              *InternalName,
 300     ACPI_STATUS             LookupStatus)
 301 {
 302     ACPI_STATUS             Status;
 303     UINT32                  BadName;
 304     char                    *Name = NULL;
 305
 306
 307     ACPI_MSG_REDIRECT_BEGIN;
 308     AcpiOsPrintf (ACPI_MSG_ERROR);
 309
 310     if (LookupStatus == AE_BAD_CHARACTER)
 311     {
 312         /* There is a non-ascii character in the name */
 313
 314         ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));
 315         AcpiOsPrintf ("[0x%.8X] (NON-ASCII)", BadName);
 316     }
 317     else
 318     {
 319         /* Convert path to external format */
 320
 321         Status = AcpiNsExternalizeName (ACPI_UINT32_MAX,
 322                     InternalName, NULL, &Name);
 323
 324         /* Print target name */
 325
 326         if (ACPI_SUCCESS (Status))
 327         {
 328             AcpiOsPrintf ("[%s]", Name);
 329         }
 330         else
 331         {
 332             AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
 333         }
 334
 335         if (Name)
 336         {
 337             ACPI_FREE (Name);
 338         }
 339     }
 340
 341     AcpiOsPrintf (" Namespace lookup failure, %s",
 342         AcpiFormatException (LookupStatus));
 343
 344     ACPI_MSG_SUFFIX;
 345     ACPI_MSG_REDIRECT_END;
 346 }
 347
 348
 349 /*******************************************************************************
 350  *
 351  * FUNCTION:    AcpiUtMethodError
 352  *
 353  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
 354  *              LineNumber          - Caller's line number (for error output)
 355  *              Message             - Error message to use on failure
 356  *              PrefixNode          - Prefix relative to the path
 357  *              Path                - Path to the node (optional)
 358  *              MethodStatus        - Execution status
 359  *
 360  * RETURN:      None
 361  *
 362  * DESCRIPTION: Print error message with the full pathname for the method.
 363  *
 364  ******************************************************************************/
 365
 366 void
 367 AcpiUtMethodError (
 368     const char              *ModuleName,
 369     UINT32                  LineNumber,
 370     const char              *Message,
 371     ACPI_NAMESPACE_NODE     *PrefixNode,
 372     const char              *Path,
 373     ACPI_STATUS             MethodStatus)
 374 {
 375     ACPI_STATUS             Status;
 376     ACPI_NAMESPACE_NODE     *Node = PrefixNode;
 377
 378
 379     ACPI_MSG_REDIRECT_BEGIN;
 380     AcpiOsPrintf (ACPI_MSG_ERROR);
 381
 382     if (Path)
 383     {
 384         Status = AcpiNsGetNode (PrefixNode, Path, ACPI_NS_NO_UPSEARCH,
 385                     &Node);
 386         if (ACPI_FAILURE (Status))
 387         {
 388             AcpiOsPrintf ("[Could not get node by pathname]");
 389         }
 390     }
 391
 392     AcpiNsPrintNodePathname (Node, Message);
 393     AcpiOsPrintf (", %s", AcpiFormatException (MethodStatus));
 394
 395     ACPI_MSG_SUFFIX;
 396     ACPI_MSG_REDIRECT_END;
 397 }
 398
 399 #endif /* ACPI_NO_ERROR_MESSAGES */