1 /* $NetBSD: db_sym.h,v 1.16 2002/02/15 07:33:53 simonb Exp $ */ 2 3 /* 4 * Mach Operating System 5 * Copyright (c) 1991,1990 Carnegie Mellon University 6 * All Rights Reserved. 7 * 8 * Permission to use, copy, modify and distribute this software and its 9 * documentation is hereby granted, provided that both the copyright 10 * notice and this permission notice appear in all copies of the 11 * software, derivative works or modified versions, and any portions 12 * thereof, and that both notices appear in supporting documentation. 13 * 14 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 15 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 16 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 17 * 18 * Carnegie Mellon requests users of this software to return to 19 * 20 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 21 * School of Computer Science 22 * Carnegie Mellon University 23 * Pittsburgh PA 15213-3890 24 * 25 * any improvements or extensions that they make and grant Carnegie the 26 * rights to redistribute these changes. 27 * 28 * Author: Alessandro Forin, Carnegie Mellon University 29 * Date: 8/90 30 */ 31 32 /* 33 * This module can handle multiple symbol tables 34 */ 35 typedef struct { 36 const char *name; /* symtab name */ 37 char *start; /* symtab location */ 38 char *end; 39 char *private; /* optional machdep pointer */ 40 } db_symtab_t; 41 42 extern db_symtab_t *db_last_symtab; /* where last symbol was found */ 43 44 /* 45 * Symbol representation is specific to the symtab style: 46 * BSD compilers use dbx' nlist, other compilers might use 47 * a different one 48 */ 49 typedef char * db_sym_t; /* opaque handle on symbols */ 50 #define DB_SYM_NULL ((db_sym_t)0) 51 52 /* 53 * Non-stripped symbol tables will have duplicates, for instance 54 * the same string could match a parameter name, a local var, a 55 * global var, etc. 56 * We are most concern with the following matches. 57 */ 58 typedef int db_strategy_t; /* search strategy */ 59 60 #define DB_STGY_ANY 0 /* anything goes */ 61 #define DB_STGY_XTRN 1 /* only external symbols */ 62 #define DB_STGY_PROC 2 /* only procedures */ 63 64 65 /* 66 * Internal db_forall function calling convention: 67 * 68 * (*db_forall_func)(stab, sym, name, suffix, prefix, arg); 69 * 70 * stab is the symbol table, symbol the (opaque) symbol pointer, 71 * name the name of the symbol, suffix a string representing 72 * the type, prefix an initial ignorable function prefix (e.g. "_" 73 * in a.out), and arg an opaque argument to be passed in. 74 */ 75 typedef void (db_forall_func_t) 76 (db_symtab_t *, db_sym_t, char *, char *, int, void *); 77 78 /* 79 * A symbol table may be in one of many formats. All symbol tables 80 * must be of the same format as the master kernel symbol table. 81 */ 82 typedef struct { 83 const char *sym_format; 84 boolean_t (*sym_init)(int, void *, void *, const char *); 85 db_sym_t (*sym_lookup)(db_symtab_t *, char *); 86 db_sym_t (*sym_search)(db_symtab_t *, db_addr_t, db_strategy_t, 87 db_expr_t *); 88 void (*sym_value)(db_symtab_t *, db_sym_t, char **, 89 db_expr_t *); 90 boolean_t (*sym_line_at_pc)(db_symtab_t *, db_sym_t, char **, 91 int *, db_expr_t); 92 boolean_t (*sym_numargs)(db_symtab_t *, db_sym_t, int *, char **); 93 void (*sym_forall)(db_symtab_t *, 94 db_forall_func_t *db_forall_func, void *); 95 } db_symformat_t; 96 97 extern boolean_t db_qualify_ambiguous_names; 98 /* if TRUE, check across symbol tables 99 * for multiple occurrences of a name. 100 * Might slow down quite a bit */ 101 102 extern unsigned int db_maxoff; /* like gdb's "max-symbolic-offset" */ 103 104 /* 105 * Functions exported by the symtable module 106 */ 107 int db_add_symbol_table(char *, char *, const char *, char *); 108 /* extend the list of symbol tables */ 109 110 void db_del_symbol_table(char *); 111 /* remove a symbol table from list */ 112 113 boolean_t db_eqname(char *, char *, int); 114 /* strcmp, modulo leading char */ 115 116 int db_value_of_name(char *, db_expr_t *); 117 /* find symbol value given name */ 118 119 void db_sifting(char *, int); 120 /* print partially matching symbol names */ 121 122 boolean_t db_symbol_is_ambiguous(db_sym_t); 123 124 db_sym_t db_search_symbol(db_addr_t, db_strategy_t, db_expr_t *); 125 /* find symbol given value */ 126 127 void db_symbol_values(db_sym_t, char **, db_expr_t *); 128 /* return name and value of symbol */ 129 130 #define db_find_sym_and_offset(val,namep,offp) \ 131 db_symbol_values(db_search_symbol(val,DB_STGY_ANY,offp),namep,0) 132 /* find name&value given approx val */ 133 134 #define db_find_xtrn_sym_and_offset(val,namep,offp) \ 135 db_symbol_values(db_search_symbol(val,DB_STGY_XTRN,offp),namep,0) 136 /* ditto, but no locals */ 137 138 void db_symstr(char *, db_expr_t, db_strategy_t); 139 void db_printsym(db_expr_t, db_strategy_t, 140 void(*)(const char *, ...)); 141 /* print closest symbol to a value */ 142 143 int db_sym_numargs(db_sym_t, int *, char **); 144 145 #ifdef DB_AOUT_SYMBOLS 146 extern const db_symformat_t db_symformat_aout; 147 #endif 148 #ifdef DB_ELF_SYMBOLS 149 extern const db_symformat_t db_symformat_elf; 150 #endif 151