freebsd-skq/sys/ddb/ddb.h

296 lines
10 KiB
C
Raw Normal View History

/*-
* 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.
*
1999-08-28 01:08:13 +00:00
* $FreeBSD$
*/
/*
* Necessary declarations for the `ddb' kernel debugger.
*/
#ifndef _DDB_DDB_H_
#define _DDB_DDB_H_
#ifdef SYSCTL_DECL
SYSCTL_DECL(_debug_ddb);
#endif
#include <machine/db_machdep.h> /* type definitions */
#include <sys/queue.h> /* LIST_* */
#include <sys/kernel.h> /* SYSINIT */
#ifndef DB_MAXARGS
#define DB_MAXARGS 10
#endif
#ifndef DB_MAXLINE
#define DB_MAXLINE 120
#endif
#ifndef DB_MAXSCRIPTS
#define DB_MAXSCRIPTS 8
#endif
#ifndef DB_MAXSCRIPTNAME
#define DB_MAXSCRIPTNAME 32
#endif
#ifndef DB_MAXSCRIPTLEN
#define DB_MAXSCRIPTLEN 128
#endif
#ifndef DB_MAXSCRIPTRECURSION
#define DB_MAXSCRIPTRECURSION 3
#endif
#ifndef DB_CALL
#define DB_CALL db_fncall_generic
#else
int DB_CALL(db_expr_t, db_expr_t *, int, db_expr_t[]);
#endif
ddb: allow specifying the exact address of the symtab and strtab When the FreeBSD kernel is loaded from Xen the symtab and strtab are not loaded the same way as the native boot loader. This patch adds three new global variables to ddb that can be used to specify the exact position and size of those tables, so they can be directly used as parameters to db_add_symbol_table. A new helper is introduced, so callers that used to set ksym_start and ksym_end can use this helper to set the new variables. It also adds support for loading them from the Xen PVH port, that was previously missing those tables. Sponsored by: Citrix Systems R&D Reviewed by: kib ddb/db_main.c: - Add three new global variables: ksymtab, kstrtab, ksymtab_size that can be used to specify the position and size of the symtab and strtab. - Use those new variables in db_init in order to call db_add_symbol_table. - Move the logic in db_init to db_fetch_symtab in order to set ksymtab, kstrtab, ksymtab_size from ksym_start and ksym_end. ddb/ddb.h: - Add prototype for db_fetch_ksymtab. - Declate the extern variables ksymtab, kstrtab and ksymtab_size. x86/xen/pv.c: - Add support for finding the symtab and strtab when booted as a Xen PVH guest. Since Xen loads the symtab and strtab as NetBSD expects to find them we have to adapt and use the same method. amd64/amd64/machdep.c: arm/arm/machdep.c: i386/i386/machdep.c: mips/mips/machdep.c: pc98/pc98/machdep.c: powerpc/aim/machdep.c: powerpc/booke/machdep.c: sparc64/sparc64/machdep.c: - Use the newly introduced db_fetch_ksymtab in order to set ksymtab, kstrtab and ksymtab_size.
2014-09-25 08:28:10 +00:00
/*
* Extern variables to set the address and size of the symtab and strtab.
* Most users should use db_fetch_symtab in order to set them from the
* boot loader provided values.
*/
extern vm_offset_t ksymtab, kstrtab, ksymtab_size;
/*
* There are three "command tables":
* - One for simple commands; a list of these is displayed
* by typing 'help' at the debugger prompt.
* - One for sub-commands of 'show'; to see this type 'show'
* without any arguments.
* - The last one for sub-commands of 'show all'; type 'show all'
* without any argument to get a list.
*/
struct command;
LIST_HEAD(command_table, command);
extern struct command_table db_cmd_table;
extern struct command_table db_show_table;
extern struct command_table db_show_all_table;
/*
* Type signature for a function implementing a ddb command.
*/
typedef void db_cmdfcn_t(db_expr_t addr, boolean_t have_addr, db_expr_t count,
char *modif);
/*
* Command table entry.
*/
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_table *more; /* another level of command */
LIST_ENTRY(command) next; /* next entry in the command table */
};
/*
* Arrange for the specified ddb command to be defined and
* bound to the specified function. Commands can be defined
* in modules in which case they will be available only when
* the module is loaded.
*/
#define _DB_SET(_suffix, _name, _func, list, _flag, _more) \
static struct command __CONCAT(_name,_suffix) = { \
.name = __STRING(_name), \
.fcn = _func, \
.flag = _flag, \
.more = _more \
}; \
static void __CONCAT(__CONCAT(_name,_suffix),_add)(void *arg __unused) \
{ db_command_register(&list, &__CONCAT(_name,_suffix)); } \
SYSINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY, \
__CONCAT(__CONCAT(_name,_suffix),_add), NULL); \
static void __CONCAT(__CONCAT(_name,_suffix),_del)(void *arg __unused) \
{ db_command_unregister(&list, &__CONCAT(_name,_suffix)); } \
SYSUNINIT(__CONCAT(_name,_suffix), SI_SUB_KLD, SI_ORDER_ANY, \
__CONCAT(__CONCAT(_name,_suffix),_del), NULL);
/*
* Like _DB_SET but also create the function declaration which
* must be followed immediately by the body; e.g.
* _DB_FUNC(_cmd, panic, db_panic, db_cmd_table, 0, NULL)
* {
* ...panic implementation...
* }
*
* This macro is mostly used to define commands placed in one of
* the ddb command tables; see DB_COMMAND, etc. below.
*/
#define _DB_FUNC(_suffix, _name, _func, list, _flag, _more) \
static db_cmdfcn_t _func; \
_DB_SET(_suffix, _name, _func, list, _flag, _more); \
static void \
_func(db_expr_t addr, boolean_t have_addr, db_expr_t count, char *modif)
/* common idom provided for backwards compatibility */
#define DB_FUNC(_name, _func, list, _flag, _more) \
_DB_FUNC(_cmd, _name, _func, list, _flag, _more)
#define DB_COMMAND(cmd_name, func_name) \
_DB_FUNC(_cmd, cmd_name, func_name, db_cmd_table, 0, NULL)
#define DB_ALIAS(alias_name, func_name) \
_DB_SET(_cmd, alias_name, func_name, db_cmd_table, 0, NULL)
#define DB_SHOW_COMMAND(cmd_name, func_name) \
_DB_FUNC(_show, cmd_name, func_name, db_show_table, 0, NULL)
#define DB_SHOW_ALIAS(alias_name, func_name) \
_DB_SET(_show, alias_name, func_name, db_show_table, 0, NULL)
#define DB_SHOW_ALL_COMMAND(cmd_name, func_name) \
_DB_FUNC(_show_all, cmd_name, func_name, db_show_all_table, 0, NULL)
#define DB_SHOW_ALL_ALIAS(alias_name, func_name) \
_DB_SET(_show_all, alias_name, func_name, db_show_all_table, 0, NULL)
extern db_expr_t db_maxoff;
extern int db_indent;
extern int db_inst_count;
extern int db_load_count;
extern int db_store_count;
extern volatile int db_pager_quit;
extern db_expr_t db_radix;
extern db_expr_t db_max_width;
extern db_expr_t db_tab_stop_width;
extern db_expr_t db_lines_per_page;
struct thread;
struct vm_map;
2002-03-20 05:14:42 +00:00
void db_check_interrupt(void);
void db_clear_watchpoints(void);
db_addr_t db_disasm(db_addr_t loc, boolean_t altfmt);
/* instruction disassembler */
2002-09-21 17:29:36 +00:00
void db_error(const char *s);
2002-03-20 05:14:42 +00:00
int db_expression(db_expr_t *valuep);
int db_get_variable(db_expr_t *valuep);
void db_iprintf(const char *,...) __printflike(1, 2);
struct proc *db_lookup_proc(db_expr_t addr);
struct thread *db_lookup_thread(db_expr_t addr, boolean_t check_pid);
2002-03-20 05:14:42 +00:00
struct vm_map *db_map_addr(vm_offset_t);
boolean_t db_map_current(struct vm_map *);
boolean_t db_map_equal(struct vm_map *, struct vm_map *);
int db_md_set_watchpoint(db_expr_t addr, db_expr_t size);
int db_md_clr_watchpoint(db_expr_t addr, db_expr_t size);
void db_md_list_watchpoints(void);
2002-03-20 05:14:42 +00:00
void db_print_loc_and_inst(db_addr_t loc);
void db_print_thread(void);
int db_printf(const char *fmt, ...) __printflike(1, 2);
int db_read_bytes(vm_offset_t addr, size_t size, char *data);
/* machine-dependent */
2002-03-20 05:14:42 +00:00
int db_readline(char *lstart, int lsize);
void db_restart_at_pc(boolean_t watchpt);
int db_set_variable(db_expr_t value);
2002-03-20 05:14:42 +00:00
void db_set_watchpoints(void);
void db_skip_to_eol(void);
boolean_t db_stop_at_pc(boolean_t *is_breakpoint);
#define db_strcpy strcpy
void db_trace_self(void);
int db_trace_thread(struct thread *, int);
2002-03-20 05:14:42 +00:00
int db_value_of_name(const char *name, db_expr_t *valuep);
Build on Jeff Roberson's linker-set based dynamic per-CPU allocator (DPCPU), as suggested by Peter Wemm, and implement a new per-virtual network stack memory allocator. Modify vnet to use the allocator instead of monolithic global container structures (vinet, ...). This change solves many binary compatibility problems associated with VIMAGE, and restores ELF symbols for virtualized global variables. Each virtualized global variable exists as a "reference copy", and also once per virtual network stack. Virtualized global variables are tagged at compile-time, placing the in a special linker set, which is loaded into a contiguous region of kernel memory. Virtualized global variables in the base kernel are linked as normal, but those in modules are copied and relocated to a reserved portion of the kernel's vnet region with the help of a the kernel linker. Virtualized global variables exist in per-vnet memory set up when the network stack instance is created, and are initialized statically from the reference copy. Run-time access occurs via an accessor macro, which converts from the current vnet and requested symbol to a per-vnet address. When "options VIMAGE" is not compiled into the kernel, normal global ELF symbols will be used instead and indirection is avoided. This change restores static initialization for network stack global variables, restores support for non-global symbols and types, eliminates the need for many subsystem constructors, eliminates large per-subsystem structures that caused many binary compatibility issues both for monitoring applications (netstat) and kernel modules, removes the per-function INIT_VNET_*() macros throughout the stack, eliminates the need for vnet_symmap ksym(2) munging, and eliminates duplicate definitions of virtualized globals under VIMAGE_GLOBALS. Bump __FreeBSD_version and update UPDATING. Portions submitted by: bz Reviewed by: bz, zec Discussed with: gnn, jamie, jeff, jhb, julian, sam Suggested by: peter Approved by: re (kensmith)
2009-07-14 22:48:30 +00:00
int db_value_of_name_pcpu(const char *name, db_expr_t *valuep);
int db_value_of_name_vnet(const char *name, db_expr_t *valuep);
int db_write_bytes(vm_offset_t addr, size_t size, char *data);
void db_command_register(struct command_table *, struct command *);
void db_command_unregister(struct command_table *, struct command *);
ddb: allow specifying the exact address of the symtab and strtab When the FreeBSD kernel is loaded from Xen the symtab and strtab are not loaded the same way as the native boot loader. This patch adds three new global variables to ddb that can be used to specify the exact position and size of those tables, so they can be directly used as parameters to db_add_symbol_table. A new helper is introduced, so callers that used to set ksym_start and ksym_end can use this helper to set the new variables. It also adds support for loading them from the Xen PVH port, that was previously missing those tables. Sponsored by: Citrix Systems R&D Reviewed by: kib ddb/db_main.c: - Add three new global variables: ksymtab, kstrtab, ksymtab_size that can be used to specify the position and size of the symtab and strtab. - Use those new variables in db_init in order to call db_add_symbol_table. - Move the logic in db_init to db_fetch_symtab in order to set ksymtab, kstrtab, ksymtab_size from ksym_start and ksym_end. ddb/ddb.h: - Add prototype for db_fetch_ksymtab. - Declate the extern variables ksymtab, kstrtab and ksymtab_size. x86/xen/pv.c: - Add support for finding the symtab and strtab when booted as a Xen PVH guest. Since Xen loads the symtab and strtab as NetBSD expects to find them we have to adapt and use the same method. amd64/amd64/machdep.c: arm/arm/machdep.c: i386/i386/machdep.c: mips/mips/machdep.c: pc98/pc98/machdep.c: powerpc/aim/machdep.c: powerpc/booke/machdep.c: sparc64/sparc64/machdep.c: - Use the newly introduced db_fetch_ksymtab in order to set ksymtab, kstrtab and ksymtab_size.
2014-09-25 08:28:10 +00:00
int db_fetch_ksymtab(vm_offset_t ksym_start, vm_offset_t ksym_end);
db_cmdfcn_t db_breakpoint_cmd;
db_cmdfcn_t db_capture_cmd;
db_cmdfcn_t db_continue_cmd;
db_cmdfcn_t db_delete_cmd;
db_cmdfcn_t db_deletehwatch_cmd;
db_cmdfcn_t db_deletewatch_cmd;
db_cmdfcn_t db_examine_cmd;
db_cmdfcn_t db_findstack_cmd;
db_cmdfcn_t db_hwatchpoint_cmd;
db_cmdfcn_t db_listbreak_cmd;
db_cmdfcn_t db_scripts_cmd;
db_cmdfcn_t db_print_cmd;
db_cmdfcn_t db_ps;
db_cmdfcn_t db_run_cmd;
db_cmdfcn_t db_script_cmd;
db_cmdfcn_t db_search_cmd;
db_cmdfcn_t db_set_cmd;
db_cmdfcn_t db_set_thread;
db_cmdfcn_t db_show_regs;
db_cmdfcn_t db_show_threads;
db_cmdfcn_t db_single_step_cmd;
Add textdump(4) facility, which provides an alternative form of kernel dump using mechanically generated/extracted debugging output rather than a simple memory dump. Current sources of debugging output are: - DDB output capture buffer, if there is captured output to save - Kernel message buffer - Kernel configuration, if included in kernel - Kernel version string - Panic message Textdumps are stored in swap/dump partitions as with regular dumps, but are laid out as ustar files in order to allow multiple parts to be stored as a stream of sequentially written blocks. Blocks are written out in reverse order, as the size of a textdump isn't known a priori. As with regular dumps, they will be extracted using savecore(8). One new DDB(4) command is added, "textdump", which accepts "set", "unset", and "status" arguments. By default, normal kernel dumps are generated unless "textdump set" is run in order to schedule a textdump. It can be canceled using "textdump unset" to restore generation of a normal kernel dump. Several sysctls exist to configure aspects of textdumps; debug.ddb.textdump.pending can be set to check whether a textdump is pending, or set/unset in order to control whether the next kernel dump will be a textdump from userspace. While textdumps don't have to be generated as a result of a DDB script run automatically as part of a kernel panic, this is a particular useful way to use them, as instead of generating a complete memory dump, a simple transcript of an automated DDB session can be captured using the DDB output capture and textdump facilities. This can be used to generate quite brief kernel bug reports rich in debugging information but not dependent on kernel symbol tables or precisely synchronized source code. Most textdumps I generate are less than 100k including the full message buffer. Using textdumps with an interactive debugging session is also useful, with capture being enabled/disabled in order to record some but not all of the DDB session. MFC after: 3 months
2007-12-26 11:32:33 +00:00
db_cmdfcn_t db_textdump_cmd;
db_cmdfcn_t db_trace_until_call_cmd;
db_cmdfcn_t db_trace_until_matching_cmd;
db_cmdfcn_t db_unscript_cmd;
db_cmdfcn_t db_watchpoint_cmd;
db_cmdfcn_t db_write_cmd;
/*
* Interface between DDB and the DDB output capture facility.
*/
struct dumperinfo;
void db_capture_dump(struct dumperinfo *di);
void db_capture_enterpager(void);
void db_capture_exitpager(void);
void db_capture_write(char *buffer, u_int buflen);
void db_capture_writech(char ch);
/*
* Interface between DDB and the script facility.
*/
void db_script_kdbenter(const char *eventname); /* KDB enter event. */
Add textdump(4) facility, which provides an alternative form of kernel dump using mechanically generated/extracted debugging output rather than a simple memory dump. Current sources of debugging output are: - DDB output capture buffer, if there is captured output to save - Kernel message buffer - Kernel configuration, if included in kernel - Kernel version string - Panic message Textdumps are stored in swap/dump partitions as with regular dumps, but are laid out as ustar files in order to allow multiple parts to be stored as a stream of sequentially written blocks. Blocks are written out in reverse order, as the size of a textdump isn't known a priori. As with regular dumps, they will be extracted using savecore(8). One new DDB(4) command is added, "textdump", which accepts "set", "unset", and "status" arguments. By default, normal kernel dumps are generated unless "textdump set" is run in order to schedule a textdump. It can be canceled using "textdump unset" to restore generation of a normal kernel dump. Several sysctls exist to configure aspects of textdumps; debug.ddb.textdump.pending can be set to check whether a textdump is pending, or set/unset in order to control whether the next kernel dump will be a textdump from userspace. While textdumps don't have to be generated as a result of a DDB script run automatically as part of a kernel panic, this is a particular useful way to use them, as instead of generating a complete memory dump, a simple transcript of an automated DDB session can be captured using the DDB output capture and textdump facilities. This can be used to generate quite brief kernel bug reports rich in debugging information but not dependent on kernel symbol tables or precisely synchronized source code. Most textdumps I generate are less than 100k including the full message buffer. Using textdumps with an interactive debugging session is also useful, with capture being enabled/disabled in order to record some but not all of the DDB session. MFC after: 3 months
2007-12-26 11:32:33 +00:00
/*
* Interface between DDB and the textdump facility.
*
* Text dump blocks are of a fixed size; textdump_block_buffer is a
* statically allocated buffer that code interacting with textdumps can use
* to prepare and hold a pending block in when calling writenextblock().
*/
#define TEXTDUMP_BLOCKSIZE 512
extern char textdump_block_buffer[TEXTDUMP_BLOCKSIZE];
void textdump_mkustar(char *block_buffer, const char *filename,
u_int size);
void textdump_restoreoff(off_t offset);
void textdump_saveoff(off_t *offsetp);
int textdump_writenextblock(struct dumperinfo *di, char *buffer);
/*
* Interface between the kernel and textdumps.
*/
extern int textdump_pending; /* Call textdump_dumpsys() instead. */
void textdump_dumpsys(struct dumperinfo *di);
#endif /* !_DDB_DDB_H_ */