debug/kdb/kdb_private.h

0001 #ifndef _KDBPRIVATE_H
0002 #define _KDBPRIVATE_H
0003
0004 /*
0005  * Kernel Debugger Architecture Independent Private Headers
0006  *
0007  * This file is subject to the terms and conditions of the GNU General Public
0008  * License.  See the file "COPYING" in the main directory of this archive
0009  * for more details.
0010  *
0011  * Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
0012  * Copyright (c) 2009 Wind River Systems, Inc.  All Rights Reserved.
0013  */
0014
0015 #include <linux/kgdb.h>
0016 #include "../debug_core.h"
0017
0018 /* Kernel Debugger Command codes.  Must not overlap with error codes. */
0019 #define KDB_CMD_GO  (-1001)
0020 #define KDB_CMD_CPU (-1002)
0021 #define KDB_CMD_SS  (-1003)
0022 #define KDB_CMD_KGDB (-1005)
0023
0024 /* Internal debug flags */
0025 #define KDB_DEBUG_FLAG_BP   0x0002  /* Breakpoint subsystem debug */
0026 #define KDB_DEBUG_FLAG_BB_SUMM  0x0004  /* Basic block analysis, summary only */
0027 #define KDB_DEBUG_FLAG_AR   0x0008  /* Activation record, generic */
0028 #define KDB_DEBUG_FLAG_ARA  0x0010  /* Activation record, arch specific */
0029 #define KDB_DEBUG_FLAG_BB   0x0020  /* All basic block analysis */
0030 #define KDB_DEBUG_FLAG_STATE    0x0040  /* State flags */
0031 #define KDB_DEBUG_FLAG_MASK 0xffff  /* All debug flags */
0032 #define KDB_DEBUG_FLAG_SHIFT    16  /* Shift factor for dbflags */
0033
0034 #define KDB_DEBUG(flag) (kdb_flags & \
0035     (KDB_DEBUG_FLAG_##flag << KDB_DEBUG_FLAG_SHIFT))
0036 #define KDB_DEBUG_STATE(text, value) if (KDB_DEBUG(STATE)) \
0037         kdb_print_state(text, value)
0038
0039 #if BITS_PER_LONG == 32
0040
0041 #define KDB_PLATFORM_ENV    "BYTESPERWORD=4"
0042
0043 #define kdb_machreg_fmt     "0x%lx"
0044 #define kdb_machreg_fmt0    "0x%08lx"
0045 #define kdb_bfd_vma_fmt     "0x%lx"
0046 #define kdb_bfd_vma_fmt0    "0x%08lx"
0047 #define kdb_elfw_addr_fmt   "0x%x"
0048 #define kdb_elfw_addr_fmt0  "0x%08x"
0049 #define kdb_f_count_fmt     "%d"
0050
0051 #elif BITS_PER_LONG == 64
0052
0053 #define KDB_PLATFORM_ENV    "BYTESPERWORD=8"
0054
0055 #define kdb_machreg_fmt     "0x%lx"
0056 #define kdb_machreg_fmt0    "0x%016lx"
0057 #define kdb_bfd_vma_fmt     "0x%lx"
0058 #define kdb_bfd_vma_fmt0    "0x%016lx"
0059 #define kdb_elfw_addr_fmt   "0x%x"
0060 #define kdb_elfw_addr_fmt0  "0x%016x"
0061 #define kdb_f_count_fmt     "%ld"
0062
0063 #endif
0064
0065 /*
0066  * KDB_MAXBPT describes the total number of breakpoints
0067  * supported by this architecture.
0068  */
0069 #define KDB_MAXBPT  16
0070
0071 /* Symbol table format returned by kallsyms. */
0072 typedef struct __ksymtab {
0073         unsigned long value;    /* Address of symbol */
0074         const char *mod_name;   /* Module containing symbol or
0075                      * "kernel" */
0076         unsigned long mod_start;
0077         unsigned long mod_end;
0078         const char *sec_name;   /* Section containing symbol */
0079         unsigned long sec_start;
0080         unsigned long sec_end;
0081         const char *sym_name;   /* Full symbol name, including
0082                      * any version */
0083         unsigned long sym_start;
0084         unsigned long sym_end;
0085         } kdb_symtab_t;
0086 extern int kallsyms_symbol_next(char *prefix_name, int flag, int buf_size);
0087 extern int kallsyms_symbol_complete(char *prefix_name, int max_len);
0088
0089 /* Exported Symbols for kernel loadable modules to use. */
0090 extern int kdb_getarea_size(void *, unsigned long, size_t);
0091 extern int kdb_putarea_size(unsigned long, void *, size_t);
0092
0093 /*
0094  * Like get_user and put_user, kdb_getarea and kdb_putarea take variable
0095  * names, not pointers.  The underlying *_size functions take pointers.
0096  */
0097 #define kdb_getarea(x, addr) kdb_getarea_size(&(x), addr, sizeof((x)))
0098 #define kdb_putarea(addr, x) kdb_putarea_size(addr, &(x), sizeof((x)))
0099
0100 extern int kdb_getphysword(unsigned long *word,
0101             unsigned long addr, size_t size);
0102 extern int kdb_getword(unsigned long *, unsigned long, size_t);
0103 extern int kdb_putword(unsigned long, unsigned long, size_t);
0104
0105 extern int kdbgetularg(const char *, unsigned long *);
0106 extern int kdbgetu64arg(const char *, u64 *);
0107 extern char *kdbgetenv(const char *);
0108 extern int kdbgetaddrarg(int, const char **, int*, unsigned long *,
0109              long *, char **);
0110 extern int kdbgetsymval(const char *, kdb_symtab_t *);
0111 extern int kdbnearsym(unsigned long, kdb_symtab_t *);
0112 extern char *kdb_strdup(const char *str, gfp_t type);
0113 extern void kdb_symbol_print(unsigned long, const kdb_symtab_t *, unsigned int);
0114
0115 /* Routine for debugging the debugger state. */
0116 extern void kdb_print_state(const char *, int);
0117
0118 extern int kdb_state;
0119 #define KDB_STATE_KDB       0x00000001  /* Cpu is inside kdb */
0120 #define KDB_STATE_LEAVING   0x00000002  /* Cpu is leaving kdb */
0121 #define KDB_STATE_CMD       0x00000004  /* Running a kdb command */
0122 #define KDB_STATE_KDB_CONTROL   0x00000008  /* This cpu is under
0123                          * kdb control */
0124 #define KDB_STATE_HOLD_CPU  0x00000010  /* Hold this cpu inside kdb */
0125 #define KDB_STATE_DOING_SS  0x00000020  /* Doing ss command */
0126 #define KDB_STATE_SSBPT     0x00000080  /* Install breakpoint
0127                          * after one ss, independent of
0128                          * DOING_SS */
0129 #define KDB_STATE_REENTRY   0x00000100  /* Valid re-entry into kdb */
0130 #define KDB_STATE_SUPPRESS  0x00000200  /* Suppress error messages */
0131 #define KDB_STATE_PAGER     0x00000400  /* pager is available */
0132 #define KDB_STATE_GO_SWITCH 0x00000800  /* go is switching
0133                          * back to initial cpu */
0134 #define KDB_STATE_WAIT_IPI  0x00002000  /* Waiting for kdb_ipi() NMI */
0135 #define KDB_STATE_RECURSE   0x00004000  /* Recursive entry to kdb */
0136 #define KDB_STATE_IP_ADJUSTED   0x00008000  /* Restart IP has been
0137                          * adjusted */
0138 #define KDB_STATE_GO1       0x00010000  /* go only releases one cpu */
0139 #define KDB_STATE_KEYBOARD  0x00020000  /* kdb entered via
0140                          * keyboard on this cpu */
0141 #define KDB_STATE_KEXEC     0x00040000  /* kexec issued */
0142 #define KDB_STATE_DOING_KGDB    0x00080000  /* kgdb enter now issued */
0143 #define KDB_STATE_KGDB_TRANS    0x00200000  /* Transition to kgdb */
0144 #define KDB_STATE_ARCH      0xff000000  /* Reserved for arch
0145                          * specific use */
0146
0147 #define KDB_STATE(flag) (kdb_state & KDB_STATE_##flag)
0148 #define KDB_STATE_SET(flag) ((void)(kdb_state |= KDB_STATE_##flag))
0149 #define KDB_STATE_CLEAR(flag) ((void)(kdb_state &= ~KDB_STATE_##flag))
0150
0151 extern int kdb_nextline; /* Current number of lines displayed */
0152
0153 typedef struct _kdb_bp {
0154     unsigned long   bp_addr;    /* Address breakpoint is present at */
0155     unsigned int    bp_free:1;  /* This entry is available */
0156     unsigned int    bp_enabled:1;   /* Breakpoint is active in register */
0157     unsigned int    bp_type:4;  /* Uses hardware register */
0158     unsigned int    bp_installed:1; /* Breakpoint is installed */
0159     unsigned int    bp_delay:1; /* Do delayed bp handling */
0160     unsigned int    bp_delayed:1;   /* Delayed breakpoint */
0161     unsigned int    bph_length; /* HW break length */
0162 } kdb_bp_t;
0163
0164 #ifdef CONFIG_KGDB_KDB
0165 extern kdb_bp_t kdb_breakpoints[/* KDB_MAXBPT */];
0166
0167 extern void kdb_register_table(kdbtab_t *kp, size_t len);
0168 extern int kdb_bt(int, const char **);  /* KDB display back trace */
0169
0170 /* KDB breakpoint management functions */
0171 extern void kdb_initbptab(void);
0172 extern void kdb_bp_install(struct pt_regs *);
0173 extern void kdb_bp_remove(void);
0174
0175 typedef enum {
0176     KDB_DB_BPT, /* Breakpoint */
0177     KDB_DB_SS,  /* Single-step trap */
0178     KDB_DB_SSBPT,   /* Single step over breakpoint */
0179     KDB_DB_NOBPT    /* Spurious breakpoint */
0180 } kdb_dbtrap_t;
0181
0182 extern int kdb_main_loop(kdb_reason_t, kdb_reason_t,
0183              int, kdb_dbtrap_t, struct pt_regs *);
0184
0185 /* Miscellaneous functions and data areas */
0186 extern int kdb_grepping_flag;
0187 #define KDB_GREPPING_FLAG_SEARCH 0x8000
0188 extern char kdb_grep_string[];
0189 #define KDB_GREP_STRLEN 256
0190 extern int kdb_grep_leading;
0191 extern int kdb_grep_trailing;
0192 extern char *kdb_cmds[];
0193 extern char kdb_task_state_char (const struct task_struct *);
0194 extern bool kdb_task_state(const struct task_struct *p, const char *mask);
0195 extern void kdb_ps_suppressed(void);
0196 extern void kdb_ps1(const struct task_struct *p);
0197 extern void kdb_send_sig(struct task_struct *p, int sig);
0198 extern char kdb_getchar(void);
0199 extern char *kdb_getstr(char *, size_t, const char *);
0200 extern void kdb_gdb_state_pass(char *buf);
0201
0202 /* Defines for kdb_symbol_print */
0203 #define KDB_SP_SPACEB   0x0001      /* Space before string */
0204 #define KDB_SP_SPACEA   0x0002      /* Space after string */
0205 #define KDB_SP_PAREN    0x0004      /* Parenthesis around string */
0206 #define KDB_SP_VALUE    0x0008      /* Print the value of the address */
0207 #define KDB_SP_SYMSIZE  0x0010      /* Print the size of the symbol */
0208 #define KDB_SP_NEWLINE  0x0020      /* Newline after string */
0209 #define KDB_SP_DEFAULT (KDB_SP_VALUE|KDB_SP_PAREN)
0210
0211 #define KDB_TSK(cpu) kgdb_info[cpu].task
0212 #define KDB_TSKREGS(cpu) kgdb_info[cpu].debuggerinfo
0213
0214 extern struct task_struct *kdb_curr_task(int);
0215
0216 #define kdb_task_has_cpu(p) (task_curr(p))
0217
0218 #define GFP_KDB (in_dbg_master() ? GFP_ATOMIC : GFP_KERNEL)
0219
0220 extern struct task_struct *kdb_current_task;
0221 extern struct pt_regs *kdb_current_regs;
0222
0223 #ifdef CONFIG_KDB_KEYBOARD
0224 extern void kdb_kbd_cleanup_state(void);
0225 #else /* ! CONFIG_KDB_KEYBOARD */
0226 #define kdb_kbd_cleanup_state()
0227 #endif /* ! CONFIG_KDB_KEYBOARD */
0228
0229 extern char kdb_prompt_str[];
0230
0231 #define KDB_WORD_SIZE   ((int)sizeof(unsigned long))
0232
0233 #endif /* CONFIG_KGDB_KDB */
0234
0235 #define kdb_func_printf(format, args...) \
0236     kdb_printf("%s: " format, __func__, ## args)
0237
0238 #define kdb_dbg_printf(mask, format, args...) \
0239     do { \
0240         if (KDB_DEBUG(mask)) \
0241             kdb_func_printf(format, ## args); \
0242     } while (0)
0243
0244 #endif  /* !_KDBPRIVATE_H */