DosPtrace

This function has been renamed to "DosDebug".

Description

This call provides an interface into the OS/2 kernel to facilitate program debugging.

Syntax

DosPtrace (PtraceB)

Parameters

PtraceB (PBYTE) - output

Address of the Ptrace command/data buffer. This buffer is used to communicate between the debug program and the DosPtrace routines.

Return Code

rc (USHORT) - return

Return code descriptions are:

• 0 NO_ERROR
• 1 ERROR_INVALID_FUNCTION
• 5 ERROR_ACCESS_DENIED
• 115 ERROR_PROTECTION_VIOLATION
• 303 ERROR_INVALID_PROCID

Remarks

DosPtrace allows a parent process to control the execution of another process by implementing breakpoint debugging for a debugger. Both the program under test and the program being debugged must be executing in OS/2 mode.

DosPtrace supports debugging of a process with multiple threads by allowing the debugger to read and write registers, freeze and resume thread execution, and get status on the threads.

The debugger must be able to read and write the instructions, data, and registers of the program being debugged to insert breakpoint instructions. When a process runs in OS/2 mode, one process cannot directly manipulate the address space of another process. OS/2 controls this address space through the use of the trace flag facility in DosExecPgm and the Ptrace buffer in DosPtrace.

The steps to program debugging in OS/2 mode follow:

• The debug program issues DosExecPgm for the program to be debugged, and specifies the trace option.
• The debug program calls DosPtrace with the TRC_C_Stop command to initialize the Ptrace Buffer.
• The debug program sets up a Ptrace buffer with commands for inserting the breakpoints and issues repeated DosPtrace requests as necessary.
• The debug program sets up a Ptrace buffer with a command to begin execution and issues DosPtrace. This may be a TRC_CS_Step, or TRC_C_Go.
• When the kernel DosPtrace program receives control from the program being debugged, it returns to the debug program with the Ptrace buffer set to the current register contents and with indicators of the reason for return.
• The kernel DosPtrace program receives control at a breakpoint interrupt, at processor exceptions, or when the program ends.

To debug a process with multiple threads, set a field in the Ptrace buffer (Ptrace_B.TID) to the thread ID of the thread of interest. This causes the read/write register commands to receive only the register set of the specified thread.

Note: For a process with multiple threads, the address space is the same for all the threads in the process. When commands are issued to read/write memory locations or set breakpoints, they affect all the threads in the process, even when a command is issued with a specific thread ID.

The debugger may suspend and resume specific threads through use of the TRC_C_Freeze and TRC_C_Resume commands. Having only selected threads be affected by the breakpoints is useful for manipulating them while other threads are suspended.

When a process debugger terminates, the program being debugged also terminates. To accomplish this, an internal link between the debugger and the program being debugged is maintained. This link is established as a result of the first successful DosPtrace command. Once established, this link can not be reset.

The process being debugged does not need to be a direct child process. In this situation, a small window of time exists between the DosExecPgm call and the first DosPtrace call. If the debugger terminates during this window, the program being debugged cannot be cleaned up. The system automatically terminates the program that was to be debugged.

Specifying a trace option of 2 with DosStartSession enables a debugger running in the parent session to trace all processes associated with an application running in the child session, regardless of whether the process was started by DosStartSession request or by DosExecPgm. See DosStartSession for more information.

Contents of the Ptrace Buffer:

PTRACE_B			STRUCTURE
PID	DW	0	; Process ID of the process being debugged
TID	DW	0	; Thread ID of the process being debugged
Cmd	DW	0	; Request to DosPtrace, or DosPtrace result code
Value	DW	?	; Data to DosPtrace, or DosPtrace error code
OffV	DW	?	; Offset value
SegV	DW	?	; Segment value
MTE	DW	?	; Library Module handle
Ptrace B ENDS|| || ||

Exceptions:

³ PTRACEREGS³    ³    ³ STRUCTURE                        ³
³ rAX       ³ DW ³ ?  ³ ; Registers AX through SS        ³
³ rBX       ³ DW ³ ?  ³                                  ³
³ rCX       ³ DW ³ ?  ³                                  ³
³ rDX       ³ DW ³ ?  ³                                  ³
³ rSI       ³ DW ³ ?  ³                                  ³
³ rDI       ³ DW ³ ?  ³                                  ³
³ rBP       ³ DW ³ ?  ³                                  ³
³ rDS       ³ DW ³ ?  ³                                  ³
³ rES       ³ DW ³ ?  ³                                  ³
³ rIP       ³ DW ³ ?  ³                                  ³
³ rCS       ³ DW ³ ?  ³                                  ³
³ rF        ³ DW ³ ?  ³                                  ³
³ rSP       ³ DW ³ ?  ³                                  ³
³ rSS       ³ DW ³ ?  ³                                  ³
³ Ptraceregs³    ³    ³                                  ³
³ ENDS      ³    ³    ³                                  ³

For the TRC_C_ReadMemB and TRC_C_WriteMemB commands, the remainder of the Ptrace buffer contains:

³ PTRACEPTR ³    ³    ³ STRUCTURE                        ³
³ OffB      ³ DW ³ ?  ³ ; Buffer Address                 ³
³ SegB      ³ DW ³ ?  ³                                  ³
³ Ptraceptr ³    ³    ³                                  ³
³ ENDS      ³    ³    ³                                  ³

DosPtrace Commands: PTrace_B.Cmd must contain one of the following commands upon entrance to DosPtrace:

³ TRC_C_Null        ³ EQU 0   ³                   ³ ; Invalid        ³
³ TRC_C_ReadMem_I   ³ EQU 1   ³                   ³ ; Instruction    ³
³ TRC_C_ReadMem_D   ³ EQU 2   ³                   ³ ; Data           ³
³ TRC_C_ReadMem     ³ EQU     ³ TRC_C_ReadMem_I   ³                  ³
³ TRC_C_ReadReg     ³ EQU 3   ³                   ³                  ³
³ TRC_C_WriteMem_I  ³ EQU 4   ³                   ³ ; Instruction    ³
³ TRC_C_WriteMem_D  ³ EQU 5   ³                   ³ ; Data           ³
³ TRC_C_WriteMem    ³ EQU     ³ TRC_C_WriteMem_I  ³                  ³
³ TRC_C_WriteReg    ³ EQU 6   ³                   ³                  ³
³ TRC_C_Go          ³ EQU 7   ³                   ³                  ³
³ TRC_C_Term        ³ EQU 8   ³                   ³                  ³
³ TRC_C_SStep       ³ EQU 9   ³                   ³                  ³
³ TRC_C_Stop        ³ EQU 10  ³                   ³ ; Initialize     ³
³ TRC_C_Freeze      ³ EQU 11  ³                   ³                  ³
³ TRC_C_Resume      ³ EQU 12  ³                   ³                  ³
³ TRC_C_NumToSel    ³ EQU 13  ³                   ³                  ³
³ TRC_C_GetFPRegs   ³ EQU 14  ³                   ³                  ³
³ TRC_C_SetFPRegs   ³ EQU 15  ³                   ³                  ³
³ TRC_C_GetLibName  ³ EQU 16  ³                   ³                  ³
³ TRC_C_ThrdStat    ³ EQU 17  ³                   ³                  ³
³ TRC_C_ReadMem_B   ³ EQU 18  ³                   ³ ; Read Block     ³
³ TRC_C_WriteMem_B  ³ EQU 19  ³                   ³ ; Write Block    ³

Commands and Required Input: A command is issued by placing the command number in Ptrace buffer, and calling DosPtrace with that buffer.

All of the commands require that Ptrace_B.PID be the PID of the process to debug.

TRC_C_Null

Not a valid command

Memory Operations: For the following commands, SegV:OffV is the affected location, and Ptrace_B.Value contains the value to write to or that was read from the debugger's memory. GDT segments cannot be written to: all except privilege level 2 and 3 access is disallowed. A write to a shared code segment makes that segment a non-shared segment before the write.

TRC_C_ReadMem_I

Read instruction.

TRC_C_ReadMem_D

Read data.

TRC_C_ReadMem

Read any memory.

TRC_C_WriteMem_I

Write instruction.

TRC_C_WriteMem_D

Write data.

TRC_C_WriteMem

Write to any memory. Block operations:

For the block operations, SegV:OffV must point to the starting address in the debugger's memory, and Value is the number of bytes to copy. On return, Value contains the number of bytes actually copied.

TRC_C_ReadMem_B

Read memory block.

TRC_C_WriteMem_B

Write memory block. Register / Thread Operations:

For the following commands, Ptrace_B.TID must contain the thread ID of the thread in question. If the Ptrace_B.TID field is zero:

• TRC_C_ThrdStat returns the number of threads in the process, (PTrace_B.Value).
• TRC_C_Freeze and TRC_C_Resume affects all of the debugger's threads.

TRC_C_ReadReg

Examine thread's registers.

TRC_C_WriteReg

Write thread's registers.

TRC_C_Freeze

Suspend a thread.

TRC_C_Resume

Resume a suspended thread.

TRC_C_ThrdStat

Get thread status. Command Operations:

For the following commands, the Ptrace_B.PID must be valid. The Ptrace_B registers are ignored for these commands. For TRC_C_Go and TRC_C_SStep, any thread may gain control first. The TRC_C_Term command terminates the program being debugged.

TRC_C_Go

Run the program being debugged.

TRC_C_Term

Terminate the program being debugged.

TRC_C_SStep

Run one instruction.

TRC_C_Stop

Initialize PTrace buffer. Library Support:

For TRC_C_NumToSel, Ptrace_B.Value should be set to the segment number on entrance, and a valid selector on exit. Also, Ptrace_B.MTE should be set to the module's handle. The MTE identifies the different library files in the program being debugged.

For TRC_C_GetLibName, SegV:OffV should point to a buffer where the name of the library is returned. PTrace_B.Value should hold the library's module handle (MTE).

TRC_C_NumToSel

Convert Segment number to selector.

TRC_C_GetLibName

Return name of module. Floating Point Support:

For the following two commands, SegV:OffV must contain a pointer to a 94 byte buffer to be used to read/write the floating point registers from/to.

The layout of this area is described in the NPX287 manual under the heading FSAVE/FRSTOR memory layout.

TRC_C_GetFPRegs

Read floating point registers.

TRC_C_SetFPRegs

Write floating point registers. DosPtrace Return Codes:

When DosPtrace returns to the debug program, the result is placed in Ptrace_B.Cmd, and reflects the reason for the return.

The values returned are:

TRC_C_SUC_ret  ³ EQU 0    ; Success
TRC_C_ERR_ret  ³ EQU -1   ; Error
TRC_C_SIG_ret  ³ EQU -2   ; Signal
TRC_C_TBT_ret  ³ EQU -3   ; Single Step
TRC_C_BPT_ret  ³ EQU -4   ; Breakpoint
TRC_C_NMI_ret  ³ EQU -5   ; Parity Error
TRC_C_KIL_ret  ³ EQU -6   ; Process dying
TRC_C_GPF_ret  ³ EQU -7   ; GP fault
TRC_C_LIB_ret  ³ EQU -8   ; Library load
TRC_C_FPE_ret  ³ EQU -9   ; FP error
TRC_C_THD_ret  ³ EQU -10  ; Thread ending
TRC_C_STP_ret  ³ EQU -11  ; Async. Stop.

If Ptrace_B.Cmd is returned as TRC_C_ERR_ret, Ptrace_B.Value is set to one of the following:

TRACE_BAD_COMMAND       EQU 1 
TRACE_CHILD_NOT_FOUND   EQU 2 
TRACE_CHILD_UNTRACEABLE EQU 5 

If Ptrace_B.Cmd is returned as TRC_C_SIG_ret, the process is about to receive a signal.

If Ptrace_B.Cmd is returned as TRC_C_KIL_ret, the process is about to terminate.

If Ptrace_B.Cmd returns as TRC_C_GPF_ret, the process creates a General Protection fault. The fault type is returned in PTrace_B.Value, and SegV:OffV contains the reference that generated the fault.

If Ptrace_B.Cmd is returned as TRC_C_LIB_ret, a library module has been loaded. The new module table entry (MTE) is returned in Ptrace_B.Value. This can be used with the library support commands to identify the library module. The program module's MTE is returned in PTrace_B.MTE. In this case, the initial TRC_C_Stop command should be re-issued until TRC_C_SUC_ret is returned.

If Ptrace_B.Cmd is returned as TRC_C_FPE_ret, the process has generated a floating point error.

If Ptrace_B.Cmd is returned as TRC_C_THD_ret, the Ptrace_b.TID field contains the thread ID of the terminating thread.

If Ptrace_B.Cmd is returned as TRC_C_STP_ret, then the asynchronous stop caused the debugger to stop.

Example Code

C Binding

#define INCL_DOSQUEUES

USHORT  rc = DosPtrace(PtraceB);

PBYTE            PtraceB;       /* Ptrace buffer (returned) */

USHORT               rc;        /* return code */

MASM Binding

EXTRN  DosPtrace:FAR
INCL_DOSQUEUES      EQU 1

PUSH@  OTHER   Ptrace_B      ;Ptrace buffer (returned)
CALL   DosPtrace

Returns WORD