acpica/utilities/uterror.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: uterror - Various internal error/warning output functions
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155
0156
0157 #define _COMPONENT          ACPI_UTILITIES
0158         ACPI_MODULE_NAME    ("uterror")
0159
0160
0161 /*
0162  * This module contains internal error functions that may
0163  * be configured out.
0164  */
0165 #if !defined (ACPI_NO_ERROR_MESSAGES)
0166
0167 /*******************************************************************************
0168  *
0169  * FUNCTION:    AcpiUtPredefinedWarning
0170  *
0171  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
0172  *              LineNumber      - Caller's line number (for error output)
0173  *              Pathname        - Full pathname to the node
0174  *              NodeFlags       - From Namespace node for the method/object
0175  *              Format          - Printf format string + additional args
0176  *
0177  * RETURN:      None
0178  *
0179  * DESCRIPTION: Warnings for the predefined validation module. Messages are
0180  *              only emitted the first time a problem with a particular
0181  *              method/object is detected. This prevents a flood of error
0182  *              messages for methods that are repeatedly evaluated.
0183  *
0184  ******************************************************************************/
0185
0186 void ACPI_INTERNAL_VAR_XFACE
0187 AcpiUtPredefinedWarning (
0188     const char              *ModuleName,
0189     UINT32                  LineNumber,
0190     char                    *Pathname,
0191     UINT16                  NodeFlags,
0192     const char              *Format,
0193     ...)
0194 {
0195     va_list                 ArgList;
0196
0197
0198     /*
0199      * Warning messages for this method/object will be disabled after the
0200      * first time a validation fails or an object is successfully repaired.
0201      */
0202     if (NodeFlags & ANOBJ_EVALUATED)
0203     {
0204         return;
0205     }
0206
0207     AcpiOsPrintf (ACPI_MSG_WARNING "%s: ", Pathname);
0208
0209     va_start (ArgList, Format);
0210     AcpiOsVprintf (Format, ArgList);
0211     ACPI_MSG_SUFFIX;
0212     va_end (ArgList);
0213 }
0214
0215
0216 /*******************************************************************************
0217  *
0218  * FUNCTION:    AcpiUtPredefinedInfo
0219  *
0220  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
0221  *              LineNumber      - Caller's line number (for error output)
0222  *              Pathname        - Full pathname to the node
0223  *              NodeFlags       - From Namespace node for the method/object
0224  *              Format          - Printf format string + additional args
0225  *
0226  * RETURN:      None
0227  *
0228  * DESCRIPTION: Info messages for the predefined validation module. Messages
0229  *              are only emitted the first time a problem with a particular
0230  *              method/object is detected. This prevents a flood of
0231  *              messages for methods that are repeatedly evaluated.
0232  *
0233  ******************************************************************************/
0234
0235 void ACPI_INTERNAL_VAR_XFACE
0236 AcpiUtPredefinedInfo (
0237     const char              *ModuleName,
0238     UINT32                  LineNumber,
0239     char                    *Pathname,
0240     UINT16                  NodeFlags,
0241     const char              *Format,
0242     ...)
0243 {
0244     va_list                 ArgList;
0245
0246
0247     /*
0248      * Warning messages for this method/object will be disabled after the
0249      * first time a validation fails or an object is successfully repaired.
0250      */
0251     if (NodeFlags & ANOBJ_EVALUATED)
0252     {
0253         return;
0254     }
0255
0256     AcpiOsPrintf (ACPI_MSG_INFO "%s: ", Pathname);
0257
0258     va_start (ArgList, Format);
0259     AcpiOsVprintf (Format, ArgList);
0260     ACPI_MSG_SUFFIX;
0261     va_end (ArgList);
0262 }
0263
0264
0265 /*******************************************************************************
0266  *
0267  * FUNCTION:    AcpiUtPredefinedBiosError
0268  *
0269  * PARAMETERS:  ModuleName      - Caller's module name (for error output)
0270  *              LineNumber      - Caller's line number (for error output)
0271  *              Pathname        - Full pathname to the node
0272  *              NodeFlags       - From Namespace node for the method/object
0273  *              Format          - Printf format string + additional args
0274  *
0275  * RETURN:      None
0276  *
0277  * DESCRIPTION: BIOS error message for predefined names. Messages
0278  *              are only emitted the first time a problem with a particular
0279  *              method/object is detected. This prevents a flood of
0280  *              messages for methods that are repeatedly evaluated.
0281  *
0282  ******************************************************************************/
0283
0284 void ACPI_INTERNAL_VAR_XFACE
0285 AcpiUtPredefinedBiosError (
0286     const char              *ModuleName,
0287     UINT32                  LineNumber,
0288     char                    *Pathname,
0289     UINT16                  NodeFlags,
0290     const char              *Format,
0291     ...)
0292 {
0293     va_list                 ArgList;
0294
0295
0296     /*
0297      * Warning messages for this method/object will be disabled after the
0298      * first time a validation fails or an object is successfully repaired.
0299      */
0300     if (NodeFlags & ANOBJ_EVALUATED)
0301     {
0302         return;
0303     }
0304
0305     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR "%s: ", Pathname);
0306
0307     va_start (ArgList, Format);
0308     AcpiOsVprintf (Format, ArgList);
0309     ACPI_MSG_SUFFIX;
0310     va_end (ArgList);
0311 }
0312
0313
0314 /*******************************************************************************
0315  *
0316  * FUNCTION:    AcpiUtPrefixedNamespaceError
0317  *
0318  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0319  *              LineNumber          - Caller's line number (for error output)
0320  *              PrefixScope         - Scope/Path that prefixes the internal path
0321  *              InternalPath        - Name or path of the namespace node
0322  *              LookupStatus        - Exception code from NS lookup
0323  *
0324  * RETURN:      None
0325  *
0326  * DESCRIPTION: Print error message with the full pathname constructed this way:
0327  *
0328  *                  PrefixScopeNodeFullPath.ExternalizedInternalPath
0329  *
0330  * NOTE:        10/2017: Treat the major NsLookup errors as firmware errors
0331  *
0332  ******************************************************************************/
0333
0334 void
0335 AcpiUtPrefixedNamespaceError (
0336     const char              *ModuleName,
0337     UINT32                  LineNumber,
0338     ACPI_GENERIC_STATE      *PrefixScope,
0339     const char              *InternalPath,
0340     ACPI_STATUS             LookupStatus)
0341 {
0342     char                    *FullPath;
0343     const char              *Message;
0344
0345
0346     /*
0347      * Main cases:
0348      * 1) Object creation, object must not already exist
0349      * 2) Object lookup, object must exist
0350      */
0351     switch (LookupStatus)
0352     {
0353     case AE_ALREADY_EXISTS:
0354
0355         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
0356         Message = "Failure creating named object";
0357         break;
0358
0359     case AE_NOT_FOUND:
0360
0361         AcpiOsPrintf (ACPI_MSG_BIOS_ERROR);
0362         Message = "Could not resolve symbol";
0363         break;
0364
0365     default:
0366
0367         AcpiOsPrintf (ACPI_MSG_ERROR);
0368         Message = "Failure resolving symbol";
0369         break;
0370     }
0371
0372     /* Concatenate the prefix path and the internal path */
0373
0374     FullPath = AcpiNsBuildPrefixedPathname (PrefixScope, InternalPath);
0375
0376     AcpiOsPrintf ("%s [%s], %s", Message,
0377         FullPath ? FullPath : "Could not get pathname",
0378         AcpiFormatException (LookupStatus));
0379
0380     if (FullPath)
0381     {
0382         ACPI_FREE (FullPath);
0383     }
0384
0385     ACPI_MSG_SUFFIX;
0386 }
0387
0388
0389 #ifdef __OBSOLETE_FUNCTION
0390 /*******************************************************************************
0391  *
0392  * FUNCTION:    AcpiUtNamespaceError
0393  *
0394  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0395  *              LineNumber          - Caller's line number (for error output)
0396  *              InternalName        - Name or path of the namespace node
0397  *              LookupStatus        - Exception code from NS lookup
0398  *
0399  * RETURN:      None
0400  *
0401  * DESCRIPTION: Print error message with the full pathname for the NS node.
0402  *
0403  ******************************************************************************/
0404
0405 void
0406 AcpiUtNamespaceError (
0407     const char              *ModuleName,
0408     UINT32                  LineNumber,
0409     const char              *InternalName,
0410     ACPI_STATUS             LookupStatus)
0411 {
0412     ACPI_STATUS             Status;
0413     UINT32                  BadName;
0414     char                    *Name = NULL;
0415
0416
0417     ACPI_MSG_REDIRECT_BEGIN;
0418     AcpiOsPrintf (ACPI_MSG_ERROR);
0419
0420     if (LookupStatus == AE_BAD_CHARACTER)
0421     {
0422         /* There is a non-ascii character in the name */
0423
0424         ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));
0425         AcpiOsPrintf ("[0x%.8X] (NON-ASCII)", BadName);
0426     }
0427     else
0428     {
0429         /* Convert path to external format */
0430
0431         Status = AcpiNsExternalizeName (
0432             ACPI_UINT32_MAX, InternalName, NULL, &Name);
0433
0434         /* Print target name */
0435
0436         if (ACPI_SUCCESS (Status))
0437         {
0438             AcpiOsPrintf ("[%s]", Name);
0439         }
0440         else
0441         {
0442             AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");
0443         }
0444
0445         if (Name)
0446         {
0447             ACPI_FREE (Name);
0448         }
0449     }
0450
0451     AcpiOsPrintf (" Namespace lookup failure, %s",
0452         AcpiFormatException (LookupStatus));
0453
0454     ACPI_MSG_SUFFIX;
0455     ACPI_MSG_REDIRECT_END;
0456 }
0457 #endif
0458
0459 /*******************************************************************************
0460  *
0461  * FUNCTION:    AcpiUtMethodError
0462  *
0463  * PARAMETERS:  ModuleName          - Caller's module name (for error output)
0464  *              LineNumber          - Caller's line number (for error output)
0465  *              Message             - Error message to use on failure
0466  *              PrefixNode          - Prefix relative to the path
0467  *              Path                - Path to the node (optional)
0468  *              MethodStatus        - Execution status
0469  *
0470  * RETURN:      None
0471  *
0472  * DESCRIPTION: Print error message with the full pathname for the method.
0473  *
0474  ******************************************************************************/
0475
0476 void
0477 AcpiUtMethodError (
0478     const char              *ModuleName,
0479     UINT32                  LineNumber,
0480     const char              *Message,
0481     ACPI_NAMESPACE_NODE     *PrefixNode,
0482     const char              *Path,
0483     ACPI_STATUS             MethodStatus)
0484 {
0485     ACPI_STATUS             Status;
0486     ACPI_NAMESPACE_NODE     *Node = PrefixNode;
0487
0488
0489     ACPI_MSG_REDIRECT_BEGIN;
0490     AcpiOsPrintf (ACPI_MSG_ERROR);
0491
0492     if (Path)
0493     {
0494         Status = AcpiNsGetNode (PrefixNode, Path,
0495             ACPI_NS_NO_UPSEARCH, &Node);
0496         if (ACPI_FAILURE (Status))
0497         {
0498             AcpiOsPrintf ("[Could not get node by pathname]");
0499         }
0500     }
0501
0502     AcpiNsPrintNodePathname (Node, Message);
0503     AcpiOsPrintf (" due to previous error (%s)",
0504         AcpiFormatException (MethodStatus));
0505
0506     ACPI_MSG_SUFFIX;
0507     ACPI_MSG_REDIRECT_END;
0508 }
0509
0510 #endif /* ACPI_NO_ERROR_MESSAGES */