xref: /netbsd-src/sys/ddb/db_sym.h (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1 /*	$NetBSD: db_sym.h,v 1.6 1994/10/09 08:19:41 mycroft 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
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 	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 extern boolean_t	db_qualify_ambiguous_names;
65 					/* if TRUE, check across symbol tables
66 					 * for multiple occurrences of a name.
67 					 * Might slow down quite a bit */
68 
69 /*
70  * Functions exported by the symtable module
71  */
72 int db_add_symbol_table __P((char *, char *, char *, char *));
73 					/* extend the list of symbol tables */
74 
75 void db_del_symbol_table __P((char *));
76 					/* remove a symbol table from list */
77 
78 int db_value_of_name __P((char *, db_expr_t *));
79 					/* find symbol value given name */
80 
81 db_sym_t db_search_symbol __P((db_addr_t, db_strategy_t, db_expr_t *));
82 					/* find symbol given value */
83 
84 void db_symbol_values __P((db_sym_t, char **, db_expr_t *));
85 					/* return name and value of symbol */
86 
87 #define db_find_sym_and_offset(val,namep,offp)	\
88 	db_symbol_values(db_search_symbol(val,DB_STGY_ANY,offp),namep,0)
89 					/* find name&value given approx val */
90 
91 #define db_find_xtrn_sym_and_offset(val,namep,offp)	\
92 	db_symbol_values(db_search_symbol(val,DB_STGY_XTRN,offp),namep,0)
93 					/* ditto, but no locals */
94 
95 int db_eqname __P((char *, char *, char));
96 					/* strcmp, modulo leading char */
97 
98 void db_printsym __P((db_expr_t, db_strategy_t));
99 					/* print closest symbol to a value */
100