Subversion Repositories Kolibri OS

/*******************************************************************************

 *

 * Module Name: utxferror - Various error/warning output functions

 *

 ******************************************************************************/

/******************************************************************************

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.

 * All rights reserved.

 *

 * 2. License

 *

 * 2.1. This is your license from Intel Corp. under its intellectual property

 * rights.  You may have additional license terms from the party that provided

 * you this software, covering your right to use that party's intellectual

 * property rights.

 *

 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a

 * copy of the source code appearing in this file ("Covered Code") an

 * irrevocable, perpetual, worldwide license under Intel's copyrights in the

 * base code distributed originally by Intel ("Original Intel Code") to copy,

 * make derivatives, distribute, use and display any portion of the Covered

 * Code in any form, with the right to sublicense such rights; and

 *

 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent

 * license (with the right to sublicense), under only those claims of Intel

 * patents that are infringed by the Original Intel Code, to make, use, sell,

 * offer to sell, and import the Covered Code and derivative works thereof

 * solely to the minimum extent necessary to exercise the above copyright

 * license, and in no event shall the patent license extend to any additions

 * to or modifications of the Original Intel Code.  No other license or right

 * is granted directly or by implication, estoppel or otherwise;

 *

 * The above copyright and patent license is granted only if the following

 * conditions are met:

 *

 * 3. Conditions

 *

 * 3.1. Redistribution of Source with Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification with rights to further distribute source must include

 * the above Copyright Notice, the above License, this list of Conditions,

 * and the following Disclaimer and Export Compliance provision.  In addition,

 * Licensee must cause all Covered Code to which Licensee contributes to

 * contain a file documenting the changes Licensee made to create that Covered

 * Code and the date of any change.  Licensee must include in that file the

 * documentation of any changes made by any predecessor Licensee.  Licensee

 * must include a prominent statement that the modification is derived,

 * directly or indirectly, from Original Intel Code.

 *

 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification without rights to further distribute source must

 * include the following Disclaimer and Export Compliance provision in the

 * documentation and/or other materials provided with distribution.  In

 * addition, Licensee may not authorize further sublicense of source of any

 * portion of the Covered Code, and must include terms to the effect that the

 * license from Licensee to its licensee is limited to the intellectual

 * property embodied in the software Licensee provides to its licensee, and

 * not to intellectual property embodied in modifications its licensee may

 * make.

 *

 * 3.3. Redistribution of Executable. Redistribution in executable form of any

 * substantial portion of the Covered Code or modification must reproduce the

 * above Copyright Notice, and the following Disclaimer and Export Compliance

 * provision in the documentation and/or other materials provided with the

 * distribution.

 *

 * 3.4. Intel retains all right, title, and interest in and to the Original

 * Intel Code.

 *

 * 3.5. Neither the name Intel nor any other trademark owned or controlled by

 * Intel shall be used in advertising or otherwise to promote the sale, use or

 * other dealings in products derived from or relating to the Covered Code

 * without prior written authorization from Intel.

 *

 * 4. Disclaimer and Export Compliance

 *

 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED

 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE

 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,

 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY

 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY

 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A

 * PARTICULAR PURPOSE.

 *

 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES

 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR

 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,

 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY

 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL

 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS

 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY

 * LIMITED REMEDY.

 *

 * 4.3. Licensee shall not export, either directly or indirectly, any of this

 * software or system incorporating such software without first obtaining any

 * required license or other approval from the U. S. Department of Commerce or

 * any other agency or department of the United States Government.  In the

 * event Licensee exports any such software from the United States or

 * re-exports any such software from a foreign destination, Licensee shall

 * ensure that the distribution and export/re-export of the software is in

 * compliance with all laws, regulations, orders, or other restrictions of the

 * U.S. Export Administration Regulations. Licensee agrees that neither it nor

 * any of its subsidiaries will export/re-export any technical data, process,

 * software, or service, directly or indirectly, to any country for which the

 * United States government or any agency thereof requires an export license,

 * other governmental approval, or letter of assurance, without first obtaining

 * such license, approval or letter.

 *

 *****************************************************************************/

#define __UTXFERROR_C__

#include "acpi.h"

#include "accommon.h"

#include "acnamesp.h"

#define _COMPONENT          ACPI_UTILITIES

        ACPI_MODULE_NAME    ("utxferror")

/*

 * This module is used for the in-kernel ACPICA as well as the ACPICA

 * tools/applications.

 *

 * For the iASL compiler case, the output is redirected to stderr so that

 * any of the various ACPI errors and warnings do not appear in the output

 * files, for either the compiler or disassembler portions of the tool.

 */

#ifdef ACPI_ASL_COMPILER

#include 

extern FILE                 *AcpiGbl_OutputFile;

#define ACPI_MSG_REDIRECT_BEGIN \

    FILE                    *OutputFile = AcpiGbl_OutputFile; \

    AcpiOsRedirectOutput (stderr);

#define ACPI_MSG_REDIRECT_END \

    AcpiOsRedirectOutput (OutputFile);

#else

/*

 * non-iASL case - no redirection, nothing to do

 */

#define ACPI_MSG_REDIRECT_BEGIN

#define ACPI_MSG_REDIRECT_END

#endif

/*

 * Common message prefixes

 */

#define ACPI_MSG_ERROR          "ACPI Error: "

#define ACPI_MSG_EXCEPTION      "ACPI Exception: "

#define ACPI_MSG_WARNING        "ACPI Warning: "

#define ACPI_MSG_INFO           "ACPI: "

/*

 * Common message suffix

 */

#define ACPI_MSG_SUFFIX \

    AcpiOsPrintf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, ModuleName, LineNumber)

/*******************************************************************************

 *

 * FUNCTION:    AcpiError

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              Format              - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print "ACPI Error" message with module/line/version info

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiError (

    const char              *ModuleName,

    UINT32                  LineNumber,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_ERROR);

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    ACPI_MSG_SUFFIX;

    va_end (ArgList);

    ACPI_MSG_REDIRECT_END;

}

ACPI_EXPORT_SYMBOL (AcpiError)

/*******************************************************************************

 *

 * FUNCTION:    AcpiException

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              Status              - Status to be formatted

 *              Format              - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print "ACPI Exception" message with module/line/version info

 *              and decoded ACPI_STATUS.

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiException (

    const char              *ModuleName,

    UINT32                  LineNumber,

    ACPI_STATUS             Status,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_EXCEPTION "%s, ", AcpiFormatException (Status));

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    ACPI_MSG_SUFFIX;

    va_end (ArgList);

    ACPI_MSG_REDIRECT_END;

}

ACPI_EXPORT_SYMBOL (AcpiException)

/*******************************************************************************

 *

 * FUNCTION:    AcpiWarning

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              Format              - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print "ACPI Warning" message with module/line/version info

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiWarning (

    const char              *ModuleName,

    UINT32                  LineNumber,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_WARNING);

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    ACPI_MSG_SUFFIX;

    va_end (ArgList);

    ACPI_MSG_REDIRECT_END;

}

ACPI_EXPORT_SYMBOL (AcpiWarning)

/*******************************************************************************

 *

 * FUNCTION:    AcpiInfo

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              Format              - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print generic "ACPI:" information message. There is no

 *              module/line/version info in order to keep the message simple.

 *

 * TBD: ModuleName and LineNumber args are not needed, should be removed.

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiInfo (

    const char              *ModuleName,

    UINT32                  LineNumber,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_INFO);

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    AcpiOsPrintf ("\n");

    va_end (ArgList);

    ACPI_MSG_REDIRECT_END;

}

ACPI_EXPORT_SYMBOL (AcpiInfo)

/*

 * The remainder of this module contains internal error functions that may

 * be configured out.

 */

#if !defined (ACPI_NO_ERROR_MESSAGES) && !defined (ACPI_BIN_APP)

/*******************************************************************************

 *

 * FUNCTION:    AcpiUtPredefinedWarning

 *

 * PARAMETERS:  ModuleName      - Caller's module name (for error output)

 *              LineNumber      - Caller's line number (for error output)

 *              Pathname        - Full pathname to the node

 *              NodeFlags       - From Namespace node for the method/object

 *              Format          - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Warnings for the predefined validation module. Messages are

 *              only emitted the first time a problem with a particular

 *              method/object is detected. This prevents a flood of error

 *              messages for methods that are repeatedly evaluated.

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiUtPredefinedWarning (

    const char              *ModuleName,

    UINT32                  LineNumber,

    char                    *Pathname,

    UINT8                   NodeFlags,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    /*

     * Warning messages for this method/object will be disabled after the

     * first time a validation fails or an object is successfully repaired.

     */

    if (NodeFlags & ANOBJ_EVALUATED)

    {

        return;

    }

    AcpiOsPrintf (ACPI_MSG_WARNING "For %s: ", Pathname);

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    ACPI_MSG_SUFFIX;

    va_end (ArgList);

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiUtPredefinedInfo

 *

 * PARAMETERS:  ModuleName      - Caller's module name (for error output)

 *              LineNumber      - Caller's line number (for error output)

 *              Pathname        - Full pathname to the node

 *              NodeFlags       - From Namespace node for the method/object

 *              Format          - Printf format string + additional args

 *

 * RETURN:      None

 *

 * DESCRIPTION: Info messages for the predefined validation module. Messages

 *              are only emitted the first time a problem with a particular

 *              method/object is detected. This prevents a flood of

 *              messages for methods that are repeatedly evaluated.

 *

 ******************************************************************************/

void ACPI_INTERNAL_VAR_XFACE

AcpiUtPredefinedInfo (

    const char              *ModuleName,

    UINT32                  LineNumber,

    char                    *Pathname,

    UINT8                   NodeFlags,

    const char              *Format,

    ...)

{

    va_list                 ArgList;

    /*

     * Warning messages for this method/object will be disabled after the

     * first time a validation fails or an object is successfully repaired.

     */

    if (NodeFlags & ANOBJ_EVALUATED)

    {

        return;

    }

    AcpiOsPrintf (ACPI_MSG_INFO "For %s: ", Pathname);

    va_start (ArgList, Format);

    AcpiOsVprintf (Format, ArgList);

    ACPI_MSG_SUFFIX;

    va_end (ArgList);

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiUtNamespaceError

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              InternalName        - Name or path of the namespace node

 *              LookupStatus        - Exception code from NS lookup

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print error message with the full pathname for the NS node.

 *

 ******************************************************************************/

void

AcpiUtNamespaceError (

    const char              *ModuleName,

    UINT32                  LineNumber,

    const char              *InternalName,

    ACPI_STATUS             LookupStatus)

{

    ACPI_STATUS             Status;

    UINT32                  BadName;

    char                    *Name = NULL;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_ERROR);

    if (LookupStatus == AE_BAD_CHARACTER)

    {

        /* There is a non-ascii character in the name */

        ACPI_MOVE_32_TO_32 (&BadName, ACPI_CAST_PTR (UINT32, InternalName));

        AcpiOsPrintf ("[0x%4.4X] (NON-ASCII)", BadName);

    }

    else

    {

        /* Convert path to external format */

        Status = AcpiNsExternalizeName (ACPI_UINT32_MAX,

                    InternalName, NULL, &Name);

        /* Print target name */

        if (ACPI_SUCCESS (Status))

        {

            AcpiOsPrintf ("[%s]", Name);

        }

        else

        {

            AcpiOsPrintf ("[COULD NOT EXTERNALIZE NAME]");

        }

        if (Name)

        {

            ACPI_FREE (Name);

        }

    }

    AcpiOsPrintf (" Namespace lookup failure, %s",

        AcpiFormatException (LookupStatus));

    ACPI_MSG_SUFFIX;

    ACPI_MSG_REDIRECT_END;

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiUtMethodError

 *

 * PARAMETERS:  ModuleName          - Caller's module name (for error output)

 *              LineNumber          - Caller's line number (for error output)

 *              Message             - Error message to use on failure

 *              PrefixNode          - Prefix relative to the path

 *              Path                - Path to the node (optional)

 *              MethodStatus        - Execution status

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print error message with the full pathname for the method.

 *

 ******************************************************************************/

void

AcpiUtMethodError (

    const char              *ModuleName,

    UINT32                  LineNumber,

    const char              *Message,

    ACPI_NAMESPACE_NODE     *PrefixNode,

    const char              *Path,

    ACPI_STATUS             MethodStatus)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node = PrefixNode;

    ACPI_MSG_REDIRECT_BEGIN;

    AcpiOsPrintf (ACPI_MSG_ERROR);

    if (Path)

    {

        Status = AcpiNsGetNode (PrefixNode, Path, ACPI_NS_NO_UPSEARCH,

                    &Node);

        if (ACPI_FAILURE (Status))

        {

            AcpiOsPrintf ("[Could not get node by pathname]");

        }

    }

    AcpiNsPrintNodePathname (Node, Message);

    AcpiOsPrintf (", %s", AcpiFormatException (MethodStatus));

    ACPI_MSG_SUFFIX;

    ACPI_MSG_REDIRECT_END;

}

#endif /* ACPI_NO_ERROR_MESSAGES */