LXR linux/kernel/debug/kdb/kdb

   1#ifndef _KDBPRIVATE_H
   2#define _KDBPRIVATE_H
   3
   4/*
   5 * Kernel Debugger Architecture Independent Private Headers
   6 *
   7 * This file is subject to the terms and conditions of the GNU General Public
   8 * License.  See the file "COPYING" in the main directory of this archive
   9 * for more details.
  10 *
  11 * Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
  12 * Copyright (c) 2009 Wind River Systems, Inc.  All Rights Reserved.
  13 */
  14
  15#include <linux/kgdb.h>
  16#include "../debug_core.h"
  17
  18/* Kernel Debugger Command codes.  Must not overlap with error codes. */
  19#define KDB_CMD_GO      (-1001)
  20#define KDB_CMD_CPU     (-1002)
  21#define KDB_CMD_SS      (-1003)
  22#define KDB_CMD_SSB     (-1004)
  23#define KDB_CMD_KGDB (-1005)
  24
  25/* Internal debug flags */
  26#define KDB_DEBUG_FLAG_BP       0x0002  /* Breakpoint subsystem debug */
  27#define KDB_DEBUG_FLAG_BB_SUMM  0x0004  /* Basic block analysis, summary only */
  28#define KDB_DEBUG_FLAG_AR       0x0008  /* Activation record, generic */
  29#define KDB_DEBUG_FLAG_ARA      0x0010  /* Activation record, arch specific */
  30#define KDB_DEBUG_FLAG_BB       0x0020  /* All basic block analysis */
  31#define KDB_DEBUG_FLAG_STATE    0x0040  /* State flags */
  32#define KDB_DEBUG_FLAG_MASK     0xffff  /* All debug flags */
  33#define KDB_DEBUG_FLAG_SHIFT    16      /* Shift factor for dbflags */
  34
  35#define KDB_DEBUG(flag) (kdb_flags & \
  36        (KDB_DEBUG_FLAG_##flag << KDB_DEBUG_FLAG_SHIFT))
  37#define KDB_DEBUG_STATE(text, value) if (KDB_DEBUG(STATE)) \
  38                kdb_print_state(text, value)
  39
  40#if BITS_PER_LONG == 32
  41
  42#define KDB_PLATFORM_ENV        "BYTESPERWORD=4"
  43
  44#define kdb_machreg_fmt         "0x%lx"
  45#define kdb_machreg_fmt0        "0x%08lx"
  46#define kdb_bfd_vma_fmt         "0x%lx"
  47#define kdb_bfd_vma_fmt0        "0x%08lx"
  48#define kdb_elfw_addr_fmt       "0x%x"
  49#define kdb_elfw_addr_fmt0      "0x%08x"
  50#define kdb_f_count_fmt         "%d"
  51
  52#elif BITS_PER_LONG == 64
  53
  54#define KDB_PLATFORM_ENV        "BYTESPERWORD=8"
  55
  56#define kdb_machreg_fmt         "0x%lx"
  57#define kdb_machreg_fmt0        "0x%016lx"
  58#define kdb_bfd_vma_fmt         "0x%lx"
  59#define kdb_bfd_vma_fmt0        "0x%016lx"
  60#define kdb_elfw_addr_fmt       "0x%x"
  61#define kdb_elfw_addr_fmt0      "0x%016x"
  62#define kdb_f_count_fmt         "%ld"
  63
  64#endif
  65
  66/*
  67 * KDB_MAXBPT describes the total number of breakpoints
  68 * supported by this architecure.
  69 */
  70#define KDB_MAXBPT      16
  71
  72/* Symbol table format returned by kallsyms. */
  73typedef struct __ksymtab {
  74                unsigned long value;    /* Address of symbol */
  75                const char *mod_name;   /* Module containing symbol or
  76                                         * "kernel" */
  77                unsigned long mod_start;
  78                unsigned long mod_end;
  79                const char *sec_name;   /* Section containing symbol */
  80                unsigned long sec_start;
  81                unsigned long sec_end;
  82                const char *sym_name;   /* Full symbol name, including
  83                                         * any version */
  84                unsigned long sym_start;
  85                unsigned long sym_end;
  86                } kdb_symtab_t;
  87extern int kallsyms_symbol_next(char *prefix_name, int flag);
  88extern int kallsyms_symbol_complete(char *prefix_name, int max_len);
  89
  90/* Exported Symbols for kernel loadable modules to use. */
  91extern int kdb_getarea_size(void *, unsigned long, size_t);
  92extern int kdb_putarea_size(unsigned long, void *, size_t);
  93
  94/*
  95 * Like get_user and put_user, kdb_getarea and kdb_putarea take variable
  96 * names, not pointers.  The underlying *_size functions take pointers.
  97 */
  98#define kdb_getarea(x, addr) kdb_getarea_size(&(x), addr, sizeof((x)))
  99#define kdb_putarea(addr, x) kdb_putarea_size(addr, &(x), sizeof((x)))
 100
 101extern int kdb_getphysword(unsigned long *word,
 102                        unsigned long addr, size_t size);
 103extern int kdb_getword(unsigned long *, unsigned long, size_t);
 104extern int kdb_putword(unsigned long, unsigned long, size_t);
 105
 106extern int kdbgetularg(const char *, unsigned long *);
 107extern int kdbgetu64arg(const char *, u64 *);
 108extern char *kdbgetenv(const char *);
 109extern int kdbgetaddrarg(int, const char **, int*, unsigned long *,
 110                         long *, char **);
 111extern int kdbgetsymval(const char *, kdb_symtab_t *);
 112extern int kdbnearsym(unsigned long, kdb_symtab_t *);
 113extern void kdbnearsym_cleanup(void);
 114extern char *kdb_strdup(const char *str, gfp_t type);
 115extern void kdb_symbol_print(unsigned long, const kdb_symtab_t *, unsigned int);
 116
 117/* Routine for debugging the debugger state. */
 118extern void kdb_print_state(const char *, int);
 119
 120extern int kdb_state;
 121#define KDB_STATE_KDB           0x00000001      /* Cpu is inside kdb */
 122#define KDB_STATE_LEAVING       0x00000002      /* Cpu is leaving kdb */
 123#define KDB_STATE_CMD           0x00000004      /* Running a kdb command */
 124#define KDB_STATE_KDB_CONTROL   0x00000008      /* This cpu is under
 125                                                 * kdb control */
 126#define KDB_STATE_HOLD_CPU      0x00000010      /* Hold this cpu inside kdb */
 127#define KDB_STATE_DOING_SS      0x00000020      /* Doing ss command */
 128#define KDB_STATE_DOING_SSB     0x00000040      /* Doing ssb command,
 129                                                 * DOING_SS is also set */
 130#define KDB_STATE_SSBPT         0x00000080      /* Install breakpoint
 131                                                 * after one ss, independent of
 132                                                 * DOING_SS */
 133#define KDB_STATE_REENTRY       0x00000100      /* Valid re-entry into kdb */
 134#define KDB_STATE_SUPPRESS      0x00000200      /* Suppress error messages */
 135#define KDB_STATE_PAGER         0x00000400      /* pager is available */
 136#define KDB_STATE_GO_SWITCH     0x00000800      /* go is switching
 137                                                 * back to initial cpu */
 138#define KDB_STATE_PRINTF_LOCK   0x00001000      /* Holds kdb_printf lock */
 139#define KDB_STATE_WAIT_IPI      0x00002000      /* Waiting for kdb_ipi() NMI */
 140#define KDB_STATE_RECURSE       0x00004000      /* Recursive entry to kdb */
 141#define KDB_STATE_IP_ADJUSTED   0x00008000      /* Restart IP has been
 142                                                 * adjusted */
 143#define KDB_STATE_GO1           0x00010000      /* go only releases one cpu */
 144#define KDB_STATE_KEYBOARD      0x00020000      /* kdb entered via
 145                                                 * keyboard on this cpu */
 146#define KDB_STATE_KEXEC         0x00040000      /* kexec issued */
 147#define KDB_STATE_DOING_KGDB    0x00080000      /* kgdb enter now issued */
 148#define KDB_STATE_KGDB_TRANS    0x00200000      /* Transition to kgdb */
 149#define KDB_STATE_ARCH          0xff000000      /* Reserved for arch
 150                                                 * specific use */
 151
 152#define KDB_STATE(flag) (kdb_state & KDB_STATE_##flag)
 153#define KDB_STATE_SET(flag) ((void)(kdb_state |= KDB_STATE_##flag))
 154#define KDB_STATE_CLEAR(flag) ((void)(kdb_state &= ~KDB_STATE_##flag))
 155
 156extern int kdb_nextline; /* Current number of lines displayed */
 157
 158typedef struct _kdb_bp {
 159        unsigned long   bp_addr;        /* Address breakpoint is present at */
 160        unsigned int    bp_free:1;      /* This entry is available */
 161        unsigned int    bp_enabled:1;   /* Breakpoint is active in register */
 162        unsigned int    bp_type:4;      /* Uses hardware register */
 163        unsigned int    bp_installed:1; /* Breakpoint is installed */
 164        unsigned int    bp_delay:1;     /* Do delayed bp handling */
 165        unsigned int    bp_delayed:1;   /* Delayed breakpoint */
 166        unsigned int    bph_length;     /* HW break length */
 167} kdb_bp_t;
 168
 169#ifdef CONFIG_KGDB_KDB
 170extern kdb_bp_t kdb_breakpoints[/* KDB_MAXBPT */];
 171
 172/* The KDB shell command table */
 173typedef struct _kdbtab {
 174        char    *cmd_name;              /* Command name */
 175        kdb_func_t cmd_func;            /* Function to execute command */
 176        char    *cmd_usage;             /* Usage String for this command */
 177        char    *cmd_help;              /* Help message for this command */
 178        short    cmd_flags;             /* Parsing flags */
 179        short    cmd_minlen;            /* Minimum legal # command
 180                                         * chars required */
 181        kdb_repeat_t cmd_repeat;        /* Does command auto repeat on enter? */
 182} kdbtab_t;
 183
 184extern int kdb_bt(int, const char **);  /* KDB display back trace */
 185
 186/* KDB breakpoint management functions */
 187extern void kdb_initbptab(void);
 188extern void kdb_bp_install(struct pt_regs *);
 189extern void kdb_bp_remove(void);
 190
 191typedef enum {
 192        KDB_DB_BPT,     /* Breakpoint */
 193        KDB_DB_SS,      /* Single-step trap */
 194        KDB_DB_SSB,     /* Single step to branch */
 195        KDB_DB_SSBPT,   /* Single step over breakpoint */
 196        KDB_DB_NOBPT    /* Spurious breakpoint */
 197} kdb_dbtrap_t;
 198
 199extern int kdb_main_loop(kdb_reason_t, kdb_reason_t,
 200                         int, kdb_dbtrap_t, struct pt_regs *);
 201
 202/* Miscellaneous functions and data areas */
 203extern int kdb_grepping_flag;
 204extern char kdb_grep_string[];
 205extern int kdb_grep_leading;
 206extern int kdb_grep_trailing;
 207extern char *kdb_cmds[];
 208extern unsigned long kdb_task_state_string(const char *);
 209extern char kdb_task_state_char (const struct task_struct *);
 210extern unsigned long kdb_task_state(const struct task_struct *p,
 211                                    unsigned long mask);
 212extern void kdb_ps_suppressed(void);
 213extern void kdb_ps1(const struct task_struct *p);
 214extern void kdb_print_nameval(const char *name, unsigned long val);
 215extern void kdb_send_sig_info(struct task_struct *p, struct siginfo *info);
 216extern void kdb_meminfo_proc_show(void);
 217extern char *kdb_getstr(char *, size_t, char *);
 218extern void kdb_gdb_state_pass(char *buf);
 219
 220/* Defines for kdb_symbol_print */
 221#define KDB_SP_SPACEB   0x0001          /* Space before string */
 222#define KDB_SP_SPACEA   0x0002          /* Space after string */
 223#define KDB_SP_PAREN    0x0004          /* Parenthesis around string */
 224#define KDB_SP_VALUE    0x0008          /* Print the value of the address */
 225#define KDB_SP_SYMSIZE  0x0010          /* Print the size of the symbol */
 226#define KDB_SP_NEWLINE  0x0020          /* Newline after string */
 227#define KDB_SP_DEFAULT (KDB_SP_VALUE|KDB_SP_PAREN)
 228
 229#define KDB_TSK(cpu) kgdb_info[cpu].task
 230#define KDB_TSKREGS(cpu) kgdb_info[cpu].debuggerinfo
 231
 232extern struct task_struct *kdb_curr_task(int);
 233
 234#define kdb_task_has_cpu(p) (task_curr(p))
 235
 236/* Simplify coexistence with NPTL */
 237#define kdb_do_each_thread(g, p) do_each_thread(g, p)
 238#define kdb_while_each_thread(g, p) while_each_thread(g, p)
 239
 240#define GFP_KDB (in_interrupt() ? GFP_ATOMIC : GFP_KERNEL)
 241
 242extern void *debug_kmalloc(size_t size, gfp_t flags);
 243extern void debug_kfree(void *);
 244extern void debug_kusage(void);
 245
 246extern void kdb_set_current_task(struct task_struct *);
 247extern struct task_struct *kdb_current_task;
 248
 249#ifdef CONFIG_KDB_KEYBOARD
 250extern void kdb_kbd_cleanup_state(void);
 251#else /* ! CONFIG_KDB_KEYBOARD */
 252#define kdb_kbd_cleanup_state()
 253#endif /* ! CONFIG_KDB_KEYBOARD */
 254
 255#ifdef CONFIG_MODULES
 256extern struct list_head *kdb_modules;
 257#endif /* CONFIG_MODULES */
 258
 259extern char kdb_prompt_str[];
 260
 261#define KDB_WORD_SIZE   ((int)sizeof(unsigned long))
 262
 263#endif /* CONFIG_KGDB_KDB */
 264#endif  /* !_KDBPRIVATE_H */
 265