2 * Mach Operating System
3 * Copyright (c) 1991,1990 Carnegie Mellon University
6 * Permission to use, copy, modify and distribute this software and its
7 * documentation is hereby granted, provided that both the copyright
8 * notice and this permission notice appear in all copies of the
9 * software, derivative works or modified versions, and any portions
10 * thereof, and that both notices appear in supporting documentation.
12 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
13 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
16 * Carnegie Mellon requests users of this software to return to
18 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 * School of Computer Science
20 * Carnegie Mellon University
21 * Pittsburgh PA 15213-3890
23 * any improvements or extensions that they make and grant Carnegie the
24 * rights to redistribute these changes.
26 * $FreeBSD: src/sys/ddb/db_sym.c,v 1.32 1999/08/28 00:41:10 peter Exp $
27 * $DragonFly: src/sys/ddb/db_sym.c,v 1.4 2003/08/27 10:47:13 rob Exp $
31 * Author: David B. Golub, Carnegie Mellon University
34 #include <sys/param.h>
35 #include <sys/systm.h>
38 #include <ddb/db_sym.h>
41 * Multiple symbol tables
44 #define MAXNOSYMTABS 3 /* mach, ux, emulator */
47 static db_symtab_t db_symtabs[MAXNOSYMTABS] = {{0,},};
48 static int db_nsymtab = 0;
50 static db_symtab_t *db_last_symtab; /* where last symbol was found */
52 static c_db_sym_t db_lookup ( const char *symstr);
53 static char *db_qualify (c_db_sym_t sym, char *symtabname);
54 static boolean_t db_symbol_is_ambiguous (c_db_sym_t sym);
55 static boolean_t db_line_at_pc (c_db_sym_t, char **, int *,
59 * Add symbol table, with given name, to list of symbol tables.
62 db_add_symbol_table(start, end, name, ref)
68 if (db_nsymtab >= MAXNOSYMTABS) {
69 printf ("No slots left for %s symbol table", name);
70 panic ("db_sym.c: db_add_symbol_table");
73 db_symtabs[db_nsymtab].start = start;
74 db_symtabs[db_nsymtab].end = end;
75 db_symtabs[db_nsymtab].name = name;
76 db_symtabs[db_nsymtab].private = ref;
81 * db_qualify("vm_map", "ux") returns "unix:vm_map".
83 * Note: return value points to static data whose content is
84 * overwritten by each call... but in practice this seems okay.
87 db_qualify(sym, symtabname)
94 db_symbol_values(sym, &symname, 0);
95 snprintf(tmp, sizeof(tmp), "%s:%s", symtabname, symname);
101 db_eqname(src, dst, c)
106 if (!strcmp(src, dst))
109 return (!strcmp(src+1,dst));
114 db_value_of_name(name, valuep)
120 sym = db_lookup(name);
121 if (sym == C_DB_SYM_NULL)
123 db_symbol_values(sym, &name, valuep);
130 * If the symbol has a qualifier (e.g., ux:vm_map),
131 * then only the specified symbol table will be searched;
132 * otherwise, all symbol tables will be searched.
140 int symtab_start = 0;
141 int symtab_end = db_nsymtab;
145 * Look for, remove, and remember any symbol table specifier.
147 for (cp = symstr; *cp; cp++) {
149 for (i = 0; i < db_nsymtab; i++) {
150 int n = strlen(db_symtabs[i].name);
153 n == (cp - symstr) &&
154 strncmp(symstr, db_symtabs[i].name, n) == 0
161 if (i == db_nsymtab) {
162 db_error("invalid symbol table name");
169 * Look in the specified set of symbol tables.
170 * Return on first match.
172 for (i = symtab_start; i < symtab_end; i++) {
173 sp = X_db_lookup(&db_symtabs[i], symstr);
175 db_last_symtab = &db_symtabs[i];
183 * If TRUE, check across symbol tables for multiple occurrences
184 * of a name. Might slow things down quite a bit.
186 static volatile boolean_t db_qualify_ambiguous_names = FALSE;
189 * Does this symbol name appear in more than one symbol table?
190 * Used by db_symbol_values to decide whether to qualify a symbol.
193 db_symbol_is_ambiguous(sym)
196 const char *sym_name;
199 boolean_t found_once = FALSE;
201 if (!db_qualify_ambiguous_names)
204 db_symbol_values(sym, &sym_name, 0);
205 for (i = 0; i < db_nsymtab; i++) {
206 if (X_db_lookup(&db_symtabs[i], sym_name)) {
216 * Find the closest symbol to val, and return its name
217 * and the difference between val and the symbol found.
220 db_search_symbol( val, strategy, offp)
222 db_strategy_t strategy;
229 c_db_sym_t ret = C_DB_SYM_NULL, sym;
233 for (i = 0; i < db_nsymtab; i++) {
234 sym = X_db_search_symbol(&db_symtabs[i], val, strategy, &newdiff);
235 if (newdiff < diff) {
236 db_last_symtab = &db_symtabs[i];
246 * Return name and value of a symbol
249 db_symbol_values(sym, namep, valuep)
256 if (sym == DB_SYM_NULL) {
261 X_db_symbol_values(db_last_symtab, sym, namep, &value);
263 if (db_symbol_is_ambiguous(sym))
264 *namep = db_qualify(sym, db_last_symtab->name);
271 * Print a the closest symbol to value
273 * After matching the symbol according to the given strategy
274 * we print it in the name+offset format, provided the symbol's
275 * value is close enough (eg smaller than db_maxoff).
276 * We also attempt to print [filename:linenum] when applicable
277 * (eg for procedure names).
279 * If we could not find a reasonable name+offset representation,
280 * then we just print the value in hex. Small values might get
281 * bogus symbol associations, e.g. 3 might get some absolute
282 * value like _INCLUDE_VERSION or something, therefore we do
283 * not accept symbols whose value is "small" (and use plain hex).
286 db_expr_t db_maxoff = 0x10000;
289 db_printsym(off, strategy)
291 db_strategy_t strategy;
300 cursym = db_search_symbol(off, strategy, &d);
301 db_symbol_values(cursym, &name, &value);
304 if (value >= DB_SMALL_VALUE_MIN && value <= DB_SMALL_VALUE_MAX) {
305 db_printf("%+#lr", (long)off);
308 if (name == 0 || d >= (unsigned long)db_maxoff) {
309 db_printf("%#lr", (unsigned long)off);
312 db_printf("%s", name);
314 db_printf("+%+#lr", (long)d);
315 if (strategy == DB_STGY_PROC) {
316 if (db_line_at_pc(cursym, &filename, &linenum, off))
317 db_printf(" [%s:%d]", filename, linenum);
322 db_line_at_pc( sym, filename, linenum, pc)
328 return X_db_line_at_pc( db_last_symtab, sym, filename, linenum, pc);
332 db_sym_numargs(sym, nargp, argnames)
337 return X_db_sym_numargs(db_last_symtab, sym, nargp, argnames);