xref: /freebsd/sys/ddb/db_sym.h (revision 48991a368427cadb9cdac39581d1676c29619c52)
1 /*
2  * Mach Operating System
3  * Copyright (c) 1991,1990 Carnegie Mellon University
4  * All Rights Reserved.
5  *
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.
11  *
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.
15  *
16  * Carnegie Mellon requests users of this software to return to
17  *
18  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
19  *  School of Computer Science
20  *  Carnegie Mellon University
21  *  Pittsburgh PA 15213-3890
22  *
23  * any improvements or extensions that they make and grant Carnegie the
24  * rights to redistribute these changes.
25  *
26  *	$Id: db_sym.h,v 1.9 1995/11/24 13:53:01 bde Exp $
27  */
28 
29 #ifndef _DDB_DB_SYM_H_
30 #define	_DDB_DB_SYM_H_
31 
32 /*
33  * 	Author: Alessandro Forin, Carnegie Mellon University
34  *	Date:	8/90
35  */
36 
37 /*
38  * This module can handle multiple symbol tables
39  */
40 typedef struct {
41 	char		*name;		/* symtab name */
42 	char		*start;		/* symtab location */
43 	char		*end;
44 	char		*private;	/* optional machdep pointer */
45 } db_symtab_t;
46 
47 extern db_symtab_t	*db_last_symtab; /* where last symbol was found */
48 
49 /*
50  * Symbol representation is specific to the symtab style:
51  * BSD compilers use dbx' nlist, other compilers might use
52  * a different one
53  */
54 typedef	char *		db_sym_t;	/* opaque handle on symbols */
55 #define	DB_SYM_NULL	((db_sym_t)0)
56 
57 /*
58  * Non-stripped symbol tables will have duplicates, for instance
59  * the same string could match a parameter name, a local var, a
60  * global var, etc.
61  * We are most concern with the following matches.
62  */
63 typedef int		db_strategy_t;	/* search strategy */
64 
65 #define	DB_STGY_ANY	0			/* anything goes */
66 #define DB_STGY_XTRN	1			/* only external symbols */
67 #define DB_STGY_PROC	2			/* only procedures */
68 
69 extern boolean_t	db_qualify_ambiguous_names;
70 					/* if TRUE, check across symbol tables
71 					 * for multiple occurrences of a name.
72 					 * Might slow down quite a bit */
73 
74 /*
75  * Functions exported by the symtable module
76  */
77 void		db_add_symbol_table __P((char *, char *, char *, char *));
78 					/* extend the list of symbol tables */
79 
80 db_sym_t	db_search_symbol __P((db_addr_t, db_strategy_t, db_expr_t *));
81 					/* find symbol given value */
82 
83 void		db_symbol_values __P((db_sym_t, char **, db_expr_t *));
84 					/* return name and value of symbol */
85 
86 #define db_find_sym_and_offset(val,namep,offp)	\
87 	db_symbol_values(db_search_symbol(val,DB_STGY_ANY,offp),namep,0)
88 					/* find name&value given approx val */
89 
90 #define db_find_xtrn_sym_and_offset(val,namep,offp)	\
91 	db_symbol_values(db_search_symbol(val,DB_STGY_XTRN,offp),namep,0)
92 					/* ditto, but no locals */
93 
94 int		db_eqname __P((char *, char *, char));
95 					/* strcmp, modulo leading char */
96 
97 void		db_printsym __P((db_expr_t, db_strategy_t));
98 					/* print closest symbol to a value */
99 
100 int		db_sym_numargs __P((db_sym_t, int *, char **));
101 
102 boolean_t	X_db_line_at_pc __P((db_symtab_t *symtab, db_sym_t cursym,
103 				     char **filename, int *linenum,
104 				     db_expr_t off));
105 db_sym_t	X_db_lookup __P((db_symtab_t *stab, char *symstr));
106 db_sym_t	X_db_search_symbol __P((db_symtab_t *symtab, db_addr_t off,
107 					db_strategy_t strategy,
108 					db_expr_t *diffp));
109 int		X_db_sym_numargs __P((db_symtab_t *, db_sym_t, int *,
110 				      char **));
111 void		X_db_symbol_values __P((db_sym_t sym, char **namep,
112 					db_expr_t *valuep));
113 
114 #endif /* !_DDB_DB_SYM_H_ */
115