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 "opt_kstack_pages.h"
36 #include <sys/param.h>
39 #include <sys/systm.h>
44 #include <ddb/db_sym.h>
45 #include <ddb/db_variables.h>
50 * Multiple symbol tables
53 #define MAXNOSYMTABS 3 /* mach, ux, emulator */
56 static db_symtab_t db_symtabs[MAXNOSYMTABS] = {{0,},};
57 static int db_nsymtab = 0;
59 static db_symtab_t *db_last_symtab; /* where last symbol was found */
61 static c_db_sym_t db_lookup( const char *symstr);
62 static char *db_qualify(c_db_sym_t sym, char *symtabname);
63 static bool db_symbol_is_ambiguous(c_db_sym_t sym);
64 static bool db_line_at_pc(c_db_sym_t, char **, int *, db_expr_t);
66 static int db_cpu = -1;
69 static void *db_vnet = NULL;
73 * Validate the CPU number used to interpret per-CPU variables so we can
74 * avoid later confusion if an invalid CPU is requested.
77 db_var_db_cpu(struct db_variable *vp, db_expr_t *valuep, int op)
86 if (*(int *)valuep < -1 && *(int *)valuep > mp_maxid) {
87 db_printf("Invalid value: %d", *(int*)valuep);
90 db_cpu = *(int *)valuep;
94 db_printf("db_var_db_cpu: unknown operation\n");
100 * Read-only variable reporting the current CPU, which is what we use when
101 * db_cpu is set to -1.
104 db_var_curcpu(struct db_variable *vp, db_expr_t *valuep, int op)
113 db_printf("Read-only variable.\n");
117 db_printf("db_var_curcpu: unknown operation\n");
124 * Validate the virtual network pointer used to interpret per-vnet global
125 * variable expansion. Right now we don't do much here, really we should
126 * walk the global vnet list to check it's an OK pointer.
129 db_var_db_vnet(struct db_variable *vp, db_expr_t *valuep, int op)
134 *valuep = (db_expr_t)db_vnet;
138 db_vnet = *(void **)valuep;
142 db_printf("db_var_db_vnet: unknown operation\n");
148 * Read-only variable reporting the current vnet, which is what we use when
149 * db_vnet is set to NULL.
152 db_var_curvnet(struct db_variable *vp, db_expr_t *valuep, int op)
157 *valuep = (db_expr_t)curvnet;
161 db_printf("Read-only variable.\n");
165 db_printf("db_var_curvnet: unknown operation\n");
172 * Add symbol table, with given name, to list of symbol tables.
175 db_add_symbol_table(char *start, char *end, char *name, char *ref)
177 if (db_nsymtab >= MAXNOSYMTABS) {
178 printf ("No slots left for %s symbol table", name);
179 panic ("db_sym.c: db_add_symbol_table");
182 db_symtabs[db_nsymtab].start = start;
183 db_symtabs[db_nsymtab].end = end;
184 db_symtabs[db_nsymtab].name = name;
185 db_symtabs[db_nsymtab].private = ref;
190 * db_qualify("vm_map", "ux") returns "unix:vm_map".
192 * Note: return value points to static data whose content is
193 * overwritten by each call... but in practice this seems okay.
196 db_qualify(c_db_sym_t sym, char *symtabname)
199 static char tmp[256];
201 db_symbol_values(sym, &symname, 0);
202 snprintf(tmp, sizeof(tmp), "%s:%s", symtabname, symname);
208 db_eqname(const char *src, const char *dst, int c)
210 if (!strcmp(src, dst))
213 return (!strcmp(src+1,dst));
218 db_value_of_name(const char *name, db_expr_t *valuep)
222 sym = db_lookup(name);
223 if (sym == C_DB_SYM_NULL)
225 db_symbol_values(sym, &name, valuep);
230 db_value_of_name_pcpu(const char *name, db_expr_t *valuep)
232 static char tmp[256];
241 snprintf(tmp, sizeof(tmp), "pcpu_entry_%s", name);
242 sym = db_lookup(tmp);
243 if (sym == C_DB_SYM_NULL)
245 db_symbol_values(sym, &name, &value);
246 if (value < DPCPU_START || value >= DPCPU_STOP)
248 *valuep = (db_expr_t)((uintptr_t)value + dpcpu_off[cpu]);
253 db_value_of_name_vnet(const char *name, db_expr_t *valuep)
256 static char tmp[256];
265 snprintf(tmp, sizeof(tmp), "vnet_entry_%s", name);
266 sym = db_lookup(tmp);
267 if (sym == C_DB_SYM_NULL)
269 db_symbol_values(sym, &name, &value);
270 if (value < VNET_START || value >= VNET_STOP)
272 *valuep = (db_expr_t)((uintptr_t)value + vnet->vnet_data_base);
281 * If the symbol has a qualifier (e.g., ux:vm_map),
282 * then only the specified symbol table will be searched;
283 * otherwise, all symbol tables will be searched.
286 db_lookup(const char *symstr)
290 int symtab_start = 0;
291 int symtab_end = db_nsymtab;
292 register const char *cp;
295 * Look for, remove, and remember any symbol table specifier.
297 for (cp = symstr; *cp; cp++) {
299 for (i = 0; i < db_nsymtab; i++) {
300 int n = strlen(db_symtabs[i].name);
303 n == (cp - symstr) &&
304 strncmp(symstr, db_symtabs[i].name, n) == 0
311 if (i == db_nsymtab) {
312 db_error("invalid symbol table name");
319 * Look in the specified set of symbol tables.
320 * Return on first match.
322 for (i = symtab_start; i < symtab_end; i++) {
323 sp = X_db_lookup(&db_symtabs[i], symstr);
325 db_last_symtab = &db_symtabs[i];
333 * If true, check across symbol tables for multiple occurrences
334 * of a name. Might slow things down quite a bit.
336 static volatile bool db_qualify_ambiguous_names = false;
339 * Does this symbol name appear in more than one symbol table?
340 * Used by db_symbol_values to decide whether to qualify a symbol.
343 db_symbol_is_ambiguous(c_db_sym_t sym)
345 const char *sym_name;
347 register bool found_once = false;
349 if (!db_qualify_ambiguous_names)
352 db_symbol_values(sym, &sym_name, 0);
353 for (i = 0; i < db_nsymtab; i++) {
354 if (X_db_lookup(&db_symtabs[i], sym_name)) {
364 * Find the closest symbol to val, and return its name
365 * and the difference between val and the symbol found.
368 db_search_symbol(db_addr_t val, db_strategy_t strategy, db_expr_t *offp)
374 c_db_sym_t ret = C_DB_SYM_NULL, sym;
376 newdiff = diff = val;
377 for (i = 0; i < db_nsymtab; i++) {
378 sym = X_db_search_symbol(&db_symtabs[i], val, strategy, &newdiff);
379 if ((uintmax_t)newdiff < (uintmax_t)diff) {
380 db_last_symtab = &db_symtabs[i];
390 * Return name and value of a symbol
393 db_symbol_values(c_db_sym_t sym, const char **namep, db_expr_t *valuep)
397 if (sym == DB_SYM_NULL) {
402 X_db_symbol_values(db_last_symtab, sym, namep, &value);
404 if (db_symbol_is_ambiguous(sym))
405 *namep = db_qualify(sym, db_last_symtab->name);
412 * Print a the closest symbol to value
414 * After matching the symbol according to the given strategy
415 * we print it in the name+offset format, provided the symbol's
416 * value is close enough (eg smaller than db_maxoff).
417 * We also attempt to print [filename:linenum] when applicable
418 * (eg for procedure names).
420 * If we could not find a reasonable name+offset representation,
421 * then we just print the value in hex. Small values might get
422 * bogus symbol associations, e.g. 3 might get some absolute
423 * value like _INCLUDE_VERSION or something, therefore we do
424 * not accept symbols whose value is "small" (and use plain hex).
427 db_expr_t db_maxoff = 0x10000;
430 db_printsym(db_expr_t off, db_strategy_t strategy)
439 cursym = db_search_symbol(off, strategy, &d);
440 db_symbol_values(cursym, &name, &value);
443 if (value >= DB_SMALL_VALUE_MIN && value <= DB_SMALL_VALUE_MAX) {
444 db_printf("%+#lr", (long)off);
447 if (name == NULL || d >= (unsigned long)db_maxoff) {
448 db_printf("%#lr", (unsigned long)off);
452 db_printf("%#lr = %s", (unsigned long)off, name);
454 db_printf("%s", name);
457 db_printf("+%+#lr", (long)d);
458 if (strategy == DB_STGY_PROC) {
459 if (db_line_at_pc(cursym, &filename, &linenum, off))
460 db_printf(" [%s:%d]", filename, linenum);
465 db_line_at_pc(c_db_sym_t sym, char **filename, int *linenum, db_expr_t pc)
467 return (X_db_line_at_pc(db_last_symtab, sym, filename, linenum, pc));
471 db_sym_numargs(c_db_sym_t sym, int *nargp, char **argnames)
473 return (X_db_sym_numargs(db_last_symtab, sym, nargp, argnames));