diff options
Diffstat (limited to 'gdb/osf-share/cma_debug_client.h')
| -rw-r--r-- | gdb/osf-share/cma_debug_client.h | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/gdb/osf-share/cma_debug_client.h b/gdb/osf-share/cma_debug_client.h new file mode 100644 index 00000000000..adb0909ad7d --- /dev/null +++ b/gdb/osf-share/cma_debug_client.h @@ -0,0 +1,195 @@ +/* + * (c) Copyright 1990-1996 OPEN SOFTWARE FOUNDATION, INC. + * (c) Copyright 1990-1996 HEWLETT-PACKARD COMPANY + * (c) Copyright 1990-1996 DIGITAL EQUIPMENT CORPORATION + * (c) Copyright 1991, 1992 Siemens-Nixdorf Information Systems + * To anyone who acknowledges that this file is provided "AS IS" without + * any express or implied warranty: permission to use, copy, modify, and + * distribute this file for any purpose is hereby granted without fee, + * provided that the above copyright notices and this notice appears in + * all source code copies, and that none of the names listed above be used + * in advertising or publicity pertaining to distribution of the software + * without specific, written prior permission. None of these organizations + * makes any representations about the suitability of this software for + * any purpose. + */ +/* + * Header file providing access to CMA clients that implement + * language run-times to the CMA debugger capabilities. + * + * NOTE: the clients that are able to use this interface is + * very limited because clients needing task debugging must have + * support in the system debugger as well as here (at present). + * The following are the only legitimate clients of this interface: + * ADA runtime, C++ tasking library, and CMA. + * + *FIX-ME* We shall endeavor to extend these capabilities so that the + * all-platform CMA debugger CMA_DEBUG and any client can layer + * on thread debugging. But that is still an open design problem. + * The design here does not preclude that extension (for example, + * the identity of the debug-client is indicated in an "open" + * manner by using the CMA context key as the identifier. + */ + +#ifndef CMA_DEBUG_CLIENT +#define CMA_DEBUG_CLIENT + +/* + * INCLUDE FILES + */ +#include <cma.h> + +/* + * CONSTANTS AND MACROS + */ + +/* + * TYPEDEFS + */ + +/* + * Type describing constants for a valid TCB sentinel. + * Exactly one value is valid, but we provide a symbolic name for + * at least one invalid sentinel as a convenience. + */ +typedef enum CMA_T_TCB_SENTINEL { + cma_c_tcb_sentinel_nogood = 0, /* Invalid sentinel constant */ + cma_c_tcb_sentinel = 0x0ACEFACE /* Valid TCB sentinel */ + } cma_t_tcb_sentinel; + +/* + * Type describing pad fields needed to align the "standard prolog" + * to the right byte at the front of each TCB. These fields are + * free to be put to any use by the client. + * + * This is 32 bytes long and is fixed at this size for all clients + * and CMA, for all time. + */ +typedef struct CMA_T_TCB_PRIVATE { + cma_t_integer pad1; + cma_t_integer pad2; + cma_t_integer pad3; + cma_t_integer pad4; + cma_t_integer pad5; + cma_t_integer pad6; + cma_t_integer pad7; + cma_t_integer pad8; + } cma_t_tcb_private; + +/* + * Type describing the "standard prolog" that clients should use + * within their task control blocks. We assume that the client will + * store their "task control block" as a per-thread context under + * the context key specified here. + */ +typedef struct CMA_T_TCB_PROLOG { + cma_t_tcb_sentinel sentinel; /* Validity sentinel */ + cma_t_thread client_thread; /* Thread corresonding to task */ + cma_t_key client_key; /* Context key this is stored under */ + cma_t_address reserved1; /* Must be zero, reserved to CMA */ + } cma_t_tcb_prolog; + +/* + * Type defining the layout of all TCBs and TASKS. This format + * ensures that tasks will be self-identifying to the debugger. + * this layout must never change as the CMA DEBUG Clients cannot + * be changed after CMA ships. + */ +typedef struct CMA_T_TCB_HEADER { + cma_t_tcb_private IGNORED; /* TCB fields private to the client */ + cma_t_tcb_prolog prolog; /* The standard prolog goes here */ + } cma_t_tcb_header; + + +/* + * Type describing the kinds of information that a CMA debug + * client can GET about a thread. + */ +typedef enum CMA_T_DEBUG_GET { + /* + * All of the following items use a buffer whose size is + * four bytes. (That is four must be passed as the buffer_size + * parameter to cma_debug_get.) + */ + cma_c_debget_guardsize = 1, /* Current guard size (bytes) */ + cma_c_debget_is_held = 2, /* Is it on hold? */ + cma_c_debget_is_initial = 3, /* Is it the initial thread? */ + cma_c_debget_number = 4, /* Thread's number */ + cma_c_debget_stack_ptr = 5, /* Current stack pointer */ + cma_c_debget_stack_base = 6, /* Stack base address */ + cma_c_debget_stack_top = 7, /* Stack top address */ + cma_c_debget_sched_state = 8, /* Scheduler state + * 0 - run + * 1 - ready + * 2 - blocked + * 3 - terminated + */ + cma_c_debget_reserve_size = 9, /* Size of stack reserve (bytes) */ + cma_c_debget_base_prio = 10, /* Base priority */ + cma_c_debget_priority = 11, /* Current priority */ + cma_c_debget_regs = 12, /* Register set (and proc. state) */ + cma_c_debget_alt_pending = 13, /* Alert is pending */ + cma_c_debget_alt_a_enable = 14, /* Asynch alert delivery enabled */ + cma_c_debget_alt_g_enable = 15, /* General alert delivery enabled */ + cma_c_debget_substate = 16, /* Substate (or wait state) */ + cma_c_debget_object_addr = 17, /* Address of thread object */ + cma_c_debget_thkind = 18, /* Kind of thread */ + cma_c_debget_detached = 19, /* Thread is detached */ + cma_c_debget_tcb_size = 20, /* TCB size */ + cma_c_debget_start_pc = 21, /* Start address */ + cma_c_debget_next_pc = 22, /* Next instruction */ + cma_c_debget_policy = 23, /* Sched policy */ + cma_c_debget_stack_yellow = 24, /* Addr of start of guard area */ + cma_c_debget_stack_default = 25 /* True if on default stack */ + + } cma_t_debug_get; + +/* + * Type describing the kinds of information that a CMA debug + * client can SET (or change) about a thread using cma_debug_set. + */ +typedef enum CMA_T_DEBUG_SET { + /* + * All of the following items use a buffer whose size is + * four bytes. (That is four must be passed as the buffer_size + * parameter to cma_debug_set.) + */ + cma_c_debset_priority = 1, /* Set the priority */ + cma_c_debset_policy = 2, /* Set the sched policy */ + cma_c_debset_hold = 3, /* Put thread on hold */ + cma_c_debset_regs = 4 /* Set the regs and proc. state */ + + } cma_t_debug_set; + + +/* + * GLOBAL DATA + * + * none + */ + +/* + * EXTERNAL INTERFACES + */ + +/* + * Routine to register with the CMA debug dispatcher. + */ +extern void cma_debug_register (cma_t_address,cma_t_key,cma_t_integer,cma_t_boolean); + +/* + * Routine to get get thread state needed by the CMA debug client. + */ +extern void cma_debug_get (cma_t_thread *,cma_t_debug_get,cma_t_address,cma_t_integer); + +/* + * Get thread context given an sp and a key + */ +extern void cma_debug_get_sp_context (cma_t_address,cma_t_key,cma_t_address *); + +/* + * Routine to set thread state as needed by the CMA debug client. + */ +extern void cma_debug_set (cma_t_thread *,cma_t_debug_set,cma_t_address,cma_t_integer); + +#endif |