wdb.pcl

vxworks源码源码解读是学习vxworks的最佳途径

*/

/*************************************************************************
*
* WDB_CONTEXT_CONT - continue a context
*
* This routine continues a context that has been suspended
* or has hit a breakpoint.  The input parameters are specified in WDB_CTX:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM, the system context is
* continued.  (This only makes sense if the agent is in system mode.)
* If `contextType' is WDB_CTX_TASK, the task whose
* ID is `contextId' is continued.
*
* ERRORS:
*.iP WDB_ERR_AGENT_MODE 
* Attempting to continue a task from system mode or the
* system from task mode.
* .iP WDB_ERR_INVALID_CONTEXT 
* The context does not exist.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_CONTEXT_CONT
    (
    WDB_CTX *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_CONTEXT_CREATE - create a context on the target
*
* This routine creates a context on the target as specified 
* in WDB_CTX_CREATE_DESC:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX_CREATE_DESC
*
* where WDB_CTX_TYPE is one of the following:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX_TYPE
*
* The output value is the task ID of the new task.
*
* ERRORS: 
* .iP WDB_ERR_RT_ERROR 
* The task creation failed.
*.iP WDB_ERR_NO_AGENT_PROC 
* The agent is in external mode (the version
* 1.0 external-mode agent does not support context creation).
*.iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*
*/

UINT32 WDB_CONTEXT_CREATE
    (
    WDB_CTX_CREATE_DESC *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_CONTEXT_KILL - kill a context on the target
*
* This routine kills the context specified in WDB_CTX:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM, the "system context" is
* killed.  (This means VxWorks is rebooted.)  Otherwise
* the task whose ID is `contextId' is killed.
*
* ERRORS:
* .iP WDB_ERR_AGENT_MODE 
* Trying to kill a task while in system mode.
* .iP WDB_ERR_INVALID_CONTEXT 
* The context does not exist.
* .iP WDB_ERR_NO_RT_PROC
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_CONTEXT_KILL
    (
    WDB_CTX *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_CONTEXT_RESUME - resume a context on the target
*
* This routine resumes the target context specified by WDB_CTX:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM, the "system context" is
* resumed (in other words, VxWorks is resumed).  Otherwise
* the task whose ID is `contextId' is resumed.
*
* ERRORS:
* .iP WDB_ERR_AGENT_MODE 
* Trying to resume a task while in system mode.
* .iP WDB_ERR_INVALID_CONTEXT 
* The context does not exist.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_CONTEXT_RESUME
   (
   WDB_CTX *
   )

   {
   ...
   }

/*************************************************************************
*
* WDB_CONTEXT_STATUS_GET - get the context of a status on the target
*
* This request returns the status of the target context specified
* by WDB_CTX:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM, we get the status of the "system 
* context". At present, this request is only implemented for the "system
* context".
* 
* The return value can be :
* .iP WDB_CTX_RUNNING 25
* The target context is running.
* .iP WTX_CONTEXT_SUSPENDED
* The target context is suspended.
* .LP
*
* ERRORS:
* .iP WDB_ERR_AGENT_MODE
* Trying to get the status of a context other than the system context.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*/

UINT32 * WDB_CONTEXT_STATUS_GET
    (
    (none) *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_CONTEXT_STEP - single step a context
*
* This routine single steps a context.  The context is defined 
* by WDB_CTX_STEP_DESC:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX_STEP_DESC
*
* where WDB_CTX describes the context to step:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* `startAddr' and `endAddr'
* specify the range of instructions to step over. If `startAddr' and `endAddr'
* both equal 0, then one instruction is stepped. Otherwise stepping occurs until
* the pointer is out of the step range.
*
* NOTE: When the step completes, notification occurs by issuing an asynchronous
* event of type WDB_EVT_BP.  See WDB_EVENT_GET for details.
* 
* ERRORS: 
* .iP WDB_ERR_AGENT_MODE 
* Trying to step a task in system mode or
* trying to step the system in task mode.
* .iP WDB_ERR_INVALID_CONTEXT 
* Trying to step an invalid context.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_CONTEXT_STEP
    (
    WDB_CTX_STEP_DESC *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_CONTEXT_SUSPEND - suspend a context on the target
*
* This routine suspends the target context specified by WDB_CTX:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* where WDB_CTX_TYPE is one of the following:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX_TYPE
*
* If `contextType' is WDB_CTX_SYSTEM, the "system context" is
* suspended (in other words, VxWorks is suspended).  Otherwise
* the task whose ID is `contextId' is suspended.
*
* ERRORS:
* .iP WDB_ERR_AGENT_MODE 
* Trying to suspend a task while in system mode
* .iP WDB_ERR_INVALID_CONTEXT
* The context does not exist.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_CONTEXT_SUSPEND
    (
    WDB_CTX *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_DIRECT_CALL - call a function on the target in the agent's context
*
* This routine calls the specified function in the target agent's context and
* waits for the function to return.  The function is specified
* by the `entry' and `args[10]' members of WDB_CTX_CREATE_DESC.  The other
* members are ignored and are set to NULL.
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX_CREATE_DESC
*
* The output contains the result of the function and is a UINT32.
*
* ERRORS: 
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the
* WDB man page.
* 
*
*/

UINT32 WDB_DIRECT_CALL
    (
    WDB_CTX_CREATE_DESC *
    )

    {
    ...
    }


/*************************************************************************
*
* WDB_EVALUATE_GOPHER - execute a Gopher string
* 
* Gopher is a small, interpreted language that allows the traversal of
* simple data structures in target memory.
* This request sends the specified Gopher program to the target for
* evaluation and returns the result of the evaluation in a Gopher tape.  The
* contents of the target memory specified by the Gopher program are written
* to the tape.  For more information
* on the Gopher language, see the documentation of WTX_GOPHER_EVAL in the 
* .I API Reference Manual: WTX Protocol
* or the discussion in the
* .I API User's Guide: The WTX Protocol.
* The string to be evaluated is passed in WDB_STRING_T.
*
* The result of evaluating the Gopher string is returned in a WDB_MEM_XFER
* structure:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* ERRORS:
* .iP WDB_ERR_GOPHER_SYNTAX 
* The Gopher string is malformed.
* .iP WDB_ERR_GOPHER_FAULT 
* A memory fault occurred while executing the string.
* .iP WDB_ERR_GOPHER_TRUNCATED 
* The resulting reply was too large to upload.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
* SEE ALSO: WTX_GOPHER_EVAL
*/

WDB_MEM_XFER WDB_EVALUATE_GOPHER
    (
    WDB_STRING_T *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_EVENTPOINT_ADD - add an asynchronous eventpoint
*
* This routine adds an asynchronous eventpoint to the target.
* The type of event to add an eventpoint for is specified 
* by WDB_EVTPT_ADD_DESC:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_EVTPT_ADD_DESC
*
* where `args' points to an argument list and `context' is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* WDB_ACTION is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_ACTION
*
* and WDB_ACTION_TYPE is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_ACTION_TYPE
*
* Currently, eventpoints can be added for the following event types:
* .iP WDB_EVT_BP 25
* breakpoint
* .iP WDB_EVT_HW_BP
* hardware breakpoint
* .iP WDB_EVT_CTX_EXIT
* context exit
* .iP WDB_EVT_CTX_START
* context creation
* .LP
*
* All possible event types are enumerated by WDB_EVT_TYPE:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_EVT_TYPE