mirror of https://github.com/F-Stack/f-stack.git
476 lines
16 KiB
C
476 lines
16 KiB
C
/******************************************************************************
|
|
*
|
|
* Module Name: osgendbg - Generic debugger command signalling
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/******************************************************************************
|
|
*
|
|
* 1. Copyright Notice
|
|
*
|
|
* Some or all of this work - Copyright (c) 1999 - 2015, 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.
|
|
*
|
|
*****************************************************************************
|
|
*
|
|
* Alternatively, you may choose to be licensed under the terms of the
|
|
* following license:
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions, and the following disclaimer,
|
|
* without modification.
|
|
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
|
|
* substantially similar to the "NO WARRANTY" disclaimer below
|
|
* ("Disclaimer") and any redistribution must be conditioned upon
|
|
* including a substantially similar Disclaimer requirement for further
|
|
* binary redistribution.
|
|
* 3. Neither the names of the above-listed copyright holders nor the names
|
|
* of any contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* Alternatively, you may choose to be licensed under the terms of the
|
|
* GNU General Public License ("GPL") version 2 as published by the Free
|
|
* Software Foundation.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
#include <contrib/dev/acpica/include/acpi.h>
|
|
#include <contrib/dev/acpica/include/accommon.h>
|
|
#include <contrib/dev/acpica/include/acdebug.h>
|
|
|
|
|
|
#define _COMPONENT ACPI_CA_DEBUGGER
|
|
ACPI_MODULE_NAME ("osgendbg")
|
|
|
|
|
|
/* Local prototypes */
|
|
|
|
static void
|
|
AcpiDbRunRemoteDebugger (
|
|
char *BatchBuffer);
|
|
|
|
|
|
static ACPI_MUTEX AcpiGbl_DbCommandReady;
|
|
static ACPI_MUTEX AcpiGbl_DbCommandComplete;
|
|
static BOOLEAN AcpiGbl_DbCommandSignalsInitialized = FALSE;
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiDbRunRemoteDebugger
|
|
*
|
|
* PARAMETERS: BatchBuffer - Buffer containing commands running in
|
|
* the batch mode
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Run multi-threading debugger remotely
|
|
*
|
|
*****************************************************************************/
|
|
|
|
static void
|
|
AcpiDbRunRemoteDebugger (
|
|
char *BatchBuffer)
|
|
{
|
|
ACPI_STATUS Status;
|
|
char *Ptr = BatchBuffer;
|
|
char *Cmd = Ptr;
|
|
|
|
|
|
while (!AcpiGbl_DbTerminateLoop)
|
|
{
|
|
if (BatchBuffer)
|
|
{
|
|
if (*Ptr)
|
|
{
|
|
while (*Ptr)
|
|
{
|
|
if (*Ptr == ',')
|
|
{
|
|
/* Convert commas to spaces */
|
|
*Ptr = ' ';
|
|
}
|
|
else if (*Ptr == ';')
|
|
{
|
|
*Ptr = '\0';
|
|
continue;
|
|
}
|
|
|
|
Ptr++;
|
|
}
|
|
|
|
AcpiUtSafeStrncpy (AcpiGbl_DbLineBuf, Cmd, ACPI_DB_LINE_BUFFER_SIZE);
|
|
Ptr++;
|
|
Cmd = Ptr;
|
|
}
|
|
else
|
|
{
|
|
return;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* Force output to console until a command is entered */
|
|
|
|
AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
|
|
|
|
/* Different prompt if method is executing */
|
|
|
|
if (!AcpiGbl_MethodExecuting)
|
|
{
|
|
AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
|
|
}
|
|
else
|
|
{
|
|
AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
|
|
}
|
|
|
|
/* Get the user input line */
|
|
|
|
Status = AcpiOsGetLine (AcpiGbl_DbLineBuf,
|
|
ACPI_DB_LINE_BUFFER_SIZE, NULL);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Signal the debug thread that we have a command to execute,
|
|
* and wait for the command to complete.
|
|
*/
|
|
AcpiOsReleaseMutex (AcpiGbl_DbCommandReady);
|
|
|
|
Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandComplete,
|
|
ACPI_WAIT_FOREVER);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiOsWaitCommandReady
|
|
*
|
|
* PARAMETERS: None
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Negotiate with the debugger foreground thread (the user
|
|
* thread) to wait the readiness of a command.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
ACPI_STATUS
|
|
AcpiOsWaitCommandReady (
|
|
void)
|
|
{
|
|
ACPI_STATUS Status = AE_OK;
|
|
|
|
|
|
if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
|
|
{
|
|
Status = AE_TIME;
|
|
|
|
while (Status == AE_TIME)
|
|
{
|
|
if (AcpiGbl_DbTerminateLoop)
|
|
{
|
|
Status = AE_CTRL_TERMINATE;
|
|
}
|
|
else
|
|
{
|
|
Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandReady, 1000);
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* Force output to console until a command is entered */
|
|
|
|
AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
|
|
|
|
/* Different prompt if method is executing */
|
|
|
|
if (!AcpiGbl_MethodExecuting)
|
|
{
|
|
AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
|
|
}
|
|
else
|
|
{
|
|
AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
|
|
}
|
|
|
|
/* Get the user input line */
|
|
|
|
Status = AcpiOsGetLine (AcpiGbl_DbLineBuf,
|
|
ACPI_DB_LINE_BUFFER_SIZE, NULL);
|
|
}
|
|
|
|
if (ACPI_FAILURE (Status) && Status != AE_CTRL_TERMINATE)
|
|
{
|
|
ACPI_EXCEPTION ((AE_INFO, Status,
|
|
"While parsing/handling command line"));
|
|
}
|
|
return (Status);
|
|
}
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiOsNotifyCommandComplete
|
|
*
|
|
* PARAMETERS: void
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Negotiate with the debugger foreground thread (the user
|
|
* thread) to notify the completion of a command.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
ACPI_STATUS
|
|
AcpiOsNotifyCommandComplete (
|
|
void)
|
|
{
|
|
|
|
if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
|
|
{
|
|
AcpiOsReleaseMutex (AcpiGbl_DbCommandComplete);
|
|
}
|
|
return (AE_OK);
|
|
}
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiOsInitializeDebugger
|
|
*
|
|
* PARAMETERS: None
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Initialize OSPM specific part of the debugger
|
|
*
|
|
*****************************************************************************/
|
|
|
|
ACPI_STATUS
|
|
AcpiOsInitializeDebugger (
|
|
void)
|
|
{
|
|
ACPI_STATUS Status;
|
|
|
|
|
|
/* Create command signals */
|
|
|
|
Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandReady);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandComplete);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
goto ErrorReady;
|
|
}
|
|
|
|
/* Initialize the states of the command signals */
|
|
|
|
Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandComplete,
|
|
ACPI_WAIT_FOREVER);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
goto ErrorComplete;
|
|
}
|
|
Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandReady,
|
|
ACPI_WAIT_FOREVER);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
goto ErrorComplete;
|
|
}
|
|
|
|
AcpiGbl_DbCommandSignalsInitialized = TRUE;
|
|
return (Status);
|
|
|
|
ErrorComplete:
|
|
AcpiOsDeleteMutex (AcpiGbl_DbCommandComplete);
|
|
ErrorReady:
|
|
AcpiOsDeleteMutex (AcpiGbl_DbCommandReady);
|
|
return (Status);
|
|
}
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiOsTerminateDebugger
|
|
*
|
|
* PARAMETERS: None
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Terminate signals used by the multi-threading debugger
|
|
*
|
|
*****************************************************************************/
|
|
|
|
void
|
|
AcpiOsTerminateDebugger (
|
|
void)
|
|
{
|
|
|
|
if (AcpiGbl_DbCommandSignalsInitialized)
|
|
{
|
|
AcpiOsDeleteMutex (AcpiGbl_DbCommandReady);
|
|
AcpiOsDeleteMutex (AcpiGbl_DbCommandComplete);
|
|
}
|
|
}
|
|
|
|
|
|
/******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiRunDebugger
|
|
*
|
|
* PARAMETERS: BatchBuffer - Buffer containing commands running in
|
|
* the batch mode
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Run a local/remote debugger
|
|
*
|
|
*****************************************************************************/
|
|
|
|
void
|
|
AcpiRunDebugger (
|
|
char *BatchBuffer)
|
|
{
|
|
/* Check for single or multithreaded debug */
|
|
|
|
if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
|
|
{
|
|
AcpiDbRunRemoteDebugger (BatchBuffer);
|
|
}
|
|
else
|
|
{
|
|
AcpiDbUserCommands ();
|
|
}
|
|
}
|
|
|
|
ACPI_EXPORT_SYMBOL (AcpiRunDebugger)
|