HardenedBSD/sys/ddb/ddb.h
Bruce Evans 6337f4efa8 Support statically attaching of ddb commands in non-ddb modules.
The details are hidden in the DB_COMMAND(cmd_name, func_name) and
DB_SHOW_COMMAND(cmd_name, func_name) macros.  DB_COMMAND() adds to
the top-level ddb command table and DB_SHOW_COMMAND adds to the
`show' subtable.  Most external commands will probably be `show'
commands with no side effects.  They should check their pointer
args more carefully than `show map' :-), or ddb should trap internal
faults better (like it does for memory accesses).

The vm ddb commands are temporarily unattached.

ddb.h:
Also declare `db_indent' and db_iprintf() which will replace vm's
`indent' and iprintf().
1996-09-14 09:13:15 +00:00

151 lines
5.1 KiB
C

/*-
* Copyright (c) 1993, Garrett A. Wollman.
* Copyright (c) 1993, University of Vermont and State Agricultural College.
* All rights reserved.
*
* 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.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
*
* $Id: ddb.h,v 1.11 1996/05/08 04:28:36 gpalmer Exp $
*/
/*
* Necessary declarations for the `ddb' kernel debugger.
*/
#ifndef _DDB_DDB_H_
#define _DDB_DDB_H_
#include <machine/db_machdep.h> /* type definitions */
typedef void db_cmdfcn_t __P((db_expr_t addr, boolean_t have_addr,
db_expr_t count, char *modif));
#define DB_COMMAND(cmd_name, func_name) \
DB_SET(cmd_name, func_name, db_cmd_set)
#define DB_SHOW_COMMAND(cmd_name, func_name) \
DB_SET(cmd_name, func_name, db_show_cmd_set)
#define DB_SET(cmd_name, func_name, set) \
static db_cmdfcn_t func_name; \
\
static const struct command __CONCAT(func_name,_cmd) = { \
__STRING(cmd_name), \
func_name, \
0, \
0, \
}; \
TEXT_SET(set, __CONCAT(func_name,_cmd)); \
\
static void \
func_name(addr, have_addr, count, modif) \
db_expr_t addr; \
boolean_t have_addr; \
db_expr_t count; \
char *modif;
extern char *esym;
extern unsigned int db_maxoff;
extern int db_indent;
extern int db_inst_count;
extern int db_load_count;
extern int db_store_count;
extern int db_radix;
extern int db_max_width;
extern int db_tab_stop_width;
struct vm_map;
void cnpollc __P((int));
void db_check_interrupt __P((void));
void db_clear_watchpoints __P((void));
db_addr_t db_disasm __P((db_addr_t loc, boolean_t altfmt));
/* instruction disassembler */
void db_error __P((char *s));
int db_expression __P((db_expr_t *valuep));
int db_get_variable __P((db_expr_t *valuep));
void db_iprintf __P((const char *,...));
struct vm_map *db_map_addr __P((vm_offset_t));
boolean_t db_map_current __P((struct vm_map *));
boolean_t db_map_equal __P((struct vm_map *, struct vm_map *));
void db_print_loc_and_inst __P((db_addr_t loc));
void db_printf __P((const char *fmt, ...));
void db_read_bytes __P((vm_offset_t addr, int size, char *data));
/* machine-dependent */
int db_readline __P((char *lstart, int lsize));
void db_restart_at_pc __P((boolean_t watchpt));
void db_set_watchpoints __P((void));
void db_skip_to_eol __P((void));
boolean_t db_stop_at_pc __P((boolean_t *is_breakpoint));
#define db_strcpy strcpy
void db_trap __P((int type, int code));
int db_value_of_name __P((char *name, db_expr_t *valuep));
void db_write_bytes __P((vm_offset_t addr, int size, char *data));
/* machine-dependent */
void kdb_init __P((void));
void kdbprintf __P((const char *fmt, ...));
db_cmdfcn_t db_breakpoint_cmd;
db_cmdfcn_t db_continue_cmd;
db_cmdfcn_t db_delete_cmd;
db_cmdfcn_t db_deletewatch_cmd;
db_cmdfcn_t db_examine_cmd;
db_cmdfcn_t db_listbreak_cmd;
db_cmdfcn_t db_listwatch_cmd;
db_cmdfcn_t db_print_cmd;
db_cmdfcn_t db_ps;
db_cmdfcn_t db_search_cmd;
db_cmdfcn_t db_set_cmd;
db_cmdfcn_t db_show_regs;
db_cmdfcn_t db_single_step_cmd;
db_cmdfcn_t db_stack_trace_cmd;
db_cmdfcn_t db_trace_until_call_cmd;
db_cmdfcn_t db_trace_until_matching_cmd;
db_cmdfcn_t db_watchpoint_cmd;
db_cmdfcn_t db_write_cmd;
#if 0
db_cmdfcn_t db_help_cmd;
db_cmdfcn_t db_show_all_threads;
db_cmdfcn_t db_show_one_thread;
db_cmdfcn_t ipc_port_print;
db_cmdfcn_t vm_page_print;
#endif
/*
* Command table.
*/
struct command {
char * name; /* command name */
db_cmdfcn_t *fcn; /* function to call */
int flag; /* extra info: */
#define CS_OWN 0x1 /* non-standard syntax */
#define CS_MORE 0x2 /* standard syntax, but may have other words
* at end */
#define CS_SET_DOT 0x100 /* set dot after command */
struct command *more; /* another level of command */
};
#endif /* !_DDB_DDB_H_ */