sys/ddb/ddb.h

   1 /*-
   2  * Copyright (c) 1993, Garrett A. Wollman.
   3  * Copyright (c) 1993, University of Vermont and State Agricultural College.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the University nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD: src/sys/ddb/ddb.h,v 1.24.2.2 2002/08/30 22:27:49 gibbs Exp $
  31  */
  32
  33 /*
  34  * Necessary declarations for the `ddb' kernel debugger.
  35  */
  36
  37 #ifndef _DDB_DDB_H_
  38 #define _DDB_DDB_H_
  39
  40 #ifndef _SYS_QUEUE_H_
  41 #include <sys/queue.h>
  42 #endif
  43
  44 #include <machine/db_machdep.h>         /* type definitions */
  45
  46 #ifndef _MACHINE_GLOBALDATA_H_
  47 #include <machine/globaldata.h>
  48 #endif
  49
  50 typedef void db_cmdfcn_t (db_expr_t addr, boolean_t have_addr,
  51                               db_expr_t count, char *modif);
  52
  53 #define DB_COMMAND(cmd_name, func_name) \
  54         DB_SET(cmd_name, func_name, db_cmd_set, 0, NULL)
  55 #define DB_SHOW_COMMAND(cmd_name, func_name) \
  56         DB_SET(cmd_name, func_name, db_show_cmd_set, 0, NULL)
  57
  58 #define DB_SET(cmd_name, func_name, set, flag, more)            \
  59 static db_cmdfcn_t      func_name;                              \
  60                                                                 \
  61 static const struct command __CONCAT(func_name,_cmd) = {        \
  62         __STRING(cmd_name),                                     \
  63         func_name,                                              \
  64         flag,                                                   \
  65         more                                                    \
  66 };                                                              \
  67 TEXT_SET(set, __CONCAT(func_name,_cmd));                        \
  68                                                                 \
  69 static void                                                     \
  70 func_name(db_expr_t addr, boolean_t have_addr, db_expr_t count, \
  71           char *modif)
  72
  73 extern char *esym;
  74 extern db_expr_t db_maxoff;
  75 extern int db_active;
  76 extern int db_indent;
  77 extern int db_inst_count;
  78 extern int db_load_count;
  79 extern int debugger_on_panic;
  80 extern int db_store_count;
  81 extern db_expr_t db_radix;
  82 extern db_expr_t db_max_width;
  83 extern db_expr_t db_tab_stop_width;
  84
  85 struct vm_map;
  86
  87 int             db_more(int *nl);
  88 void            db_check_interrupt (void);
  89 void            db_clear_watchpoints (void);
  90 db_addr_t       db_disasm (db_addr_t loc, boolean_t altfmt, db_regs_t *regs);
  91                                 /* instruction disassembler */
  92 void            db_error (char *s);
  93 int             db_expression (db_expr_t *valuep);
  94 int             db_get_variable (db_expr_t *valuep);
  95 void            db_iprintf (const char *,...) __printflike(1, 2);
  96 struct vm_map   *db_map_addr (vm_offset_t);
  97 boolean_t       db_map_current (struct vm_map *);
  98 boolean_t       db_map_equal (struct vm_map *, struct vm_map *);
  99 void            db_print_loc_and_inst (db_addr_t loc, db_regs_t *regs);
 100 void            db_printf (const char *fmt, ...) __printflike(1, 2);
 101 void            db_vprintf (const char *fmt, __va_list va) __printflike(1, 0);
 102 void            db_read_bytes (vm_offset_t addr, size_t size, char *data);
 103                                 /* machine-dependent */
 104 int             db_readline (char *lstart, int lsize);
 105 void            db_restart_at_pc (boolean_t watchpt);
 106 void            db_set_watchpoints (void);
 107 void            db_skip_to_eol (void);
 108 boolean_t       db_stop_at_pc (boolean_t *is_breakpoint);
 109 #define         db_strcpy       strcpy
 110 void            db_trap (int type, int code);
 111 int             db_value_of_name (const char *name, db_expr_t *valuep);
 112 void            db_write_bytes (vm_offset_t addr, size_t size, char *data);
 113                                 /* machine-dependent */
 114 void            kdb_init (void);
 115
 116 db_cmdfcn_t     db_breakpoint_cmd;
 117 db_cmdfcn_t     db_continue_cmd;
 118 db_cmdfcn_t     db_delete_cmd;
 119 db_cmdfcn_t     db_deletehwatch_cmd;
 120 db_cmdfcn_t     db_deletewatch_cmd;
 121 db_cmdfcn_t     db_examine_cmd;
 122 db_cmdfcn_t     db_hwatchpoint_cmd;
 123 db_cmdfcn_t     db_listbreak_cmd;
 124 db_cmdfcn_t     db_print_cmd;
 125 db_cmdfcn_t     db_ps;
 126 db_cmdfcn_t     db_search_cmd;
 127 db_cmdfcn_t     db_set_cmd;
 128 db_cmdfcn_t     db_show_regs;
 129 db_cmdfcn_t     db_single_step_cmd;
 130 db_cmdfcn_t     db_stack_trace_cmd;
 131 db_cmdfcn_t     db_trace_until_call_cmd;
 132 db_cmdfcn_t     db_trace_until_matching_cmd;
 133 db_cmdfcn_t     db_watchpoint_cmd;
 134 db_cmdfcn_t     db_write_cmd;
 135
 136 #if 0
 137 db_cmdfcn_t     db_help_cmd;
 138 db_cmdfcn_t     db_show_all_threads;
 139 db_cmdfcn_t     db_show_one_thread;
 140 db_cmdfcn_t     ipc_port_print;
 141 db_cmdfcn_t     vm_page_print;
 142 #endif
 143
 144 /*
 145  * Command table.
 146  */
 147 struct command {
 148         char *  name;           /* command name */
 149         db_cmdfcn_t *fcn;       /* function to call */
 150         int     flag;           /* extra info: */
 151 #define CS_OWN          0x1     /* non-standard syntax */
 152 #define CS_MORE         0x2     /* standard syntax, but may have other words
 153                                  * at end */
 154 #define CS_SET_DOT      0x100   /* set dot after command */
 155         struct command *more;   /* another level of command */
 156 };
 157
 158 #endif /* !_DDB_DDB_H_ */