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.
27 * Author: David B. Golub, Carnegie Mellon University
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
37 #include <sys/systm.h>
42 #include <ddb/db_sym.h>
43 #include <ddb/db_variables.h>
48 * Multiple symbol tables
51 #define MAXNOSYMTABS 3 /* mach, ux, emulator */
54 static db_symtab_t db_symtabs[MAXNOSYMTABS] = {{0,},};
55 static int db_nsymtab = 0;
57 static db_symtab_t *db_last_symtab; /* where last symbol was found */
59 static c_db_sym_t db_lookup( const char *symstr);
60 static char *db_qualify(c_db_sym_t sym, char *symtabname);
61 static boolean_t db_symbol_is_ambiguous(c_db_sym_t sym);
62 static boolean_t db_line_at_pc(c_db_sym_t, char **, int *, db_expr_t);
64 static int db_cpu = -1;
67 static void *db_vnet = NULL;
71 * Validate the CPU number used to interpret per-CPU variables so we can
72 * avoid later confusion if an invalid CPU is requested.
75 db_var_db_cpu(struct db_variable *vp, db_expr_t *valuep, int op)
84 if (*(int *)valuep < -1 && *(int *)valuep > mp_maxid) {
85 db_printf("Invalid value: %d", *(int*)valuep);
88 db_cpu = *(int *)valuep;
92 db_printf("db_var_db_cpu: unknown operation\n");
98 * Read-only variable reporting the current CPU, which is what we use when
99 * db_cpu is set to -1.
102 db_var_curcpu(struct db_variable *vp, db_expr_t *valuep, int op)
111 db_printf("Read-only variable.\n");
115 db_printf("db_var_curcpu: unknown operation\n");
122 * Validate the virtual network pointer used to interpret per-vnet global
123 * variable expansion. Right now we don't do much here, really we should
124 * walk the global vnet list to check it's an OK pointer.
127 db_var_db_vnet(struct db_variable *vp, db_expr_t *valuep, int op)
132 *valuep = (db_expr_t)db_vnet;
136 db_vnet = *(void **)valuep;
140 db_printf("db_var_db_vnet: unknown operation\n");
146 * Read-only variable reporting the current vnet, which is what we use when
147 * db_vnet is set to NULL.
150 db_var_curvnet(struct db_variable *vp, db_expr_t *valuep, int op)
155 *valuep = (db_expr_t)curvnet;
159 db_printf("Read-only variable.\n");
163 db_printf("db_var_curcpu: unknown operation\n");
170 * Add symbol table, with given name, to list of symbol tables.
173 db_add_symbol_table(char *start, char *end, char *name, char *ref)
175 if (db_nsymtab >= MAXNOSYMTABS) {
176 printf ("No slots left for %s symbol table", name);
177 panic ("db_sym.c: db_add_symbol_table");
180 db_symtabs[db_nsymtab].start = start;
181 db_symtabs[db_nsymtab].end = end;
182 db_symtabs[db_nsymtab].name = name;
183 db_symtabs[db_nsymtab].private = ref;
188 * db_qualify("vm_map", "ux") returns "unix:vm_map".
190 * Note: return value points to static data whose content is
191 * overwritten by each call... but in practice this seems okay.
194 db_qualify(c_db_sym_t sym, char *symtabname)
197 static char tmp[256];
199 db_symbol_values(sym, &symname, 0);
200 snprintf(tmp, sizeof(tmp), "%s:%s", symtabname, symname);
206 db_eqname(const char *src, const char *dst, int c)
208 if (!strcmp(src, dst))
211 return (!strcmp(src+1,dst));
216 db_value_of_name(const char *name, db_expr_t *valuep)
220 sym = db_lookup(name);
221 if (sym == C_DB_SYM_NULL)
223 db_symbol_values(sym, &name, valuep);
228 db_value_of_name_pcpu(const char *name, db_expr_t *valuep)
230 static char tmp[256];
239 snprintf(tmp, sizeof(tmp), "pcpu_entry_%s", name);
240 sym = db_lookup(tmp);
241 if (sym == C_DB_SYM_NULL)
243 db_symbol_values(sym, &name, &value);
244 if (value < DPCPU_START || value >= DPCPU_STOP)
246 *valuep = (db_expr_t)((uintptr_t)value + dpcpu_off[cpu]);
251 db_value_of_name_vnet(const char *name, db_expr_t *valuep)
254 static char tmp[256];
263 snprintf(tmp, sizeof(tmp), "vnet_entry_%s", name);
264 sym = db_lookup(tmp);
265 if (sym == C_DB_SYM_NULL)
267 db_symbol_values(sym, &name, &value);
268 if (value < VNET_START || value >= VNET_STOP)
270 *valuep = (db_expr_t)((uintptr_t)value + vnet->vnet_data_base);
279 * If the symbol has a qualifier (e.g., ux:vm_map),
280 * then only the specified symbol table will be searched;
281 * otherwise, all symbol tables will be searched.
284 db_lookup(const char *symstr)
288 int symtab_start = 0;
289 int symtab_end = db_nsymtab;
290 register const char *cp;
293 * Look for, remove, and remember any symbol table specifier.
295 for (cp = symstr; *cp; cp++) {
297 for (i = 0; i < db_nsymtab; i++) {
298 int n = strlen(db_symtabs[i].name);
301 n == (cp - symstr) &&
302 strncmp(symstr, db_symtabs[i].name, n) == 0
309 if (i == db_nsymtab) {
310 db_error("invalid symbol table name");
317 * Look in the specified set of symbol tables.
318 * Return on first match.
320 for (i = symtab_start; i < symtab_end; i++) {
321 sp = X_db_lookup(&db_symtabs[i], symstr);
323 db_last_symtab = &db_symtabs[i];
331 * If TRUE, check across symbol tables for multiple occurrences
332 * of a name. Might slow things down quite a bit.
334 static volatile boolean_t db_qualify_ambiguous_names = FALSE;
337 * Does this symbol name appear in more than one symbol table?
338 * Used by db_symbol_values to decide whether to qualify a symbol.
341 db_symbol_is_ambiguous(c_db_sym_t sym)
343 const char *sym_name;
346 boolean_t found_once = FALSE;
348 if (!db_qualify_ambiguous_names)
351 db_symbol_values(sym, &sym_name, 0);
352 for (i = 0; i < db_nsymtab; i++) {
353 if (X_db_lookup(&db_symtabs[i], sym_name)) {
363 * Find the closest symbol to val, and return its name
364 * and the difference between val and the symbol found.
367 db_search_symbol(db_addr_t val, db_strategy_t strategy, db_expr_t *offp)
373 c_db_sym_t ret = C_DB_SYM_NULL, sym;
376 for (i = 0; i < db_nsymtab; i++) {
377 sym = X_db_search_symbol(&db_symtabs[i], val, strategy, &newdiff);
378 if (newdiff < diff) {
379 db_last_symtab = &db_symtabs[i];
389 * Return name and value of a symbol
392 db_symbol_values(c_db_sym_t sym, const char **namep, db_expr_t *valuep)
396 if (sym == DB_SYM_NULL) {
401 X_db_symbol_values(db_last_symtab, sym, namep, &value);
403 if (db_symbol_is_ambiguous(sym))
404 *namep = db_qualify(sym, db_last_symtab->name);
411 * Print a the closest symbol to value
413 * After matching the symbol according to the given strategy
414 * we print it in the name+offset format, provided the symbol's
415 * value is close enough (eg smaller than db_maxoff).
416 * We also attempt to print [filename:linenum] when applicable
417 * (eg for procedure names).
419 * If we could not find a reasonable name+offset representation,
420 * then we just print the value in hex. Small values might get
421 * bogus symbol associations, e.g. 3 might get some absolute
422 * value like _INCLUDE_VERSION or something, therefore we do
423 * not accept symbols whose value is "small" (and use plain hex).
426 db_expr_t db_maxoff = 0x10000;
429 db_printsym(db_expr_t off, db_strategy_t strategy)
438 cursym = db_search_symbol(off, strategy, &d);
439 db_symbol_values(cursym, &name, &value);
442 if (value >= DB_SMALL_VALUE_MIN && value <= DB_SMALL_VALUE_MAX) {
443 db_printf("%+#lr", (long)off);
446 if (name == 0 || d >= (unsigned long)db_maxoff) {
447 db_printf("%#lr", (unsigned long)off);
451 db_printf("%#lr = %s", (unsigned long)off, name);
453 db_printf("%s", name);
456 db_printf("+%+#lr", (long)d);
457 if (strategy == DB_STGY_PROC) {
458 if (db_line_at_pc(cursym, &filename, &linenum, off))
459 db_printf(" [%s:%d]", filename, linenum);
464 db_line_at_pc(c_db_sym_t sym, char **filename, int *linenum, db_expr_t pc)
466 return X_db_line_at_pc( db_last_symtab, sym, filename, linenum, pc);
470 db_sym_numargs(c_db_sym_t sym, int *nargp, char **argnames)
472 return X_db_sym_numargs(db_last_symtab, sym, nargp, argnames);