db_sym.h revision 1.1 1 1.1 cgd /*
2 1.1 cgd * Mach Operating System
3 1.1 cgd * Copyright (c) 1991,1990 Carnegie Mellon University
4 1.1 cgd * All Rights Reserved.
5 1.1 cgd *
6 1.1 cgd * Permission to use, copy, modify and distribute this software and its
7 1.1 cgd * documentation is hereby granted, provided that both the copyright
8 1.1 cgd * notice and this permission notice appear in all copies of the
9 1.1 cgd * software, derivative works or modified versions, and any portions
10 1.1 cgd * thereof, and that both notices appear in supporting documentation.
11 1.1 cgd *
12 1.1 cgd * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
13 1.1 cgd * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 1.1 cgd * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 1.1 cgd *
16 1.1 cgd * Carnegie Mellon requests users of this software to return to
17 1.1 cgd *
18 1.1 cgd * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
19 1.1 cgd * School of Computer Science
20 1.1 cgd * Carnegie Mellon University
21 1.1 cgd * Pittsburgh PA 15213-3890
22 1.1 cgd *
23 1.1 cgd * any improvements or extensions that they make and grant Carnegie the
24 1.1 cgd * rights to redistribute these changes.
25 1.1 cgd */
26 1.1 cgd /*
27 1.1 cgd * HISTORY
28 1.1 cgd * $Log: db_sym.h,v $
29 1.1 cgd * Revision 1.1 1993/03/21 09:45:37 cgd
30 1.1 cgd * Initial revision
31 1.1 cgd *
32 1.1 cgd * Revision 1.1 1992/03/25 21:45:29 pace
33 1.1 cgd * Initial revision
34 1.1 cgd *
35 1.1 cgd * Revision 2.3 91/02/05 17:07:12 mrt
36 1.1 cgd * Changed to new Mach copyright
37 1.1 cgd * [91/01/31 16:19:27 mrt]
38 1.1 cgd *
39 1.1 cgd * Revision 2.2 90/08/27 21:52:39 dbg
40 1.1 cgd * Changed type of db_sym_t to char * - it's a better type for an
41 1.1 cgd * opaque pointer.
42 1.1 cgd * [90/08/22 dbg]
43 1.1 cgd *
44 1.1 cgd * Created.
45 1.1 cgd * [90/08/19 af]
46 1.1 cgd *
47 1.1 cgd */
48 1.1 cgd /*
49 1.1 cgd * Author: Alessandro Forin, Carnegie Mellon University
50 1.1 cgd * Date: 8/90
51 1.1 cgd */
52 1.1 cgd
53 1.1 cgd /*
54 1.1 cgd * This module can handle multiple symbol tables
55 1.1 cgd */
56 1.1 cgd typedef struct {
57 1.1 cgd char *name; /* symtab name */
58 1.1 cgd char *start; /* symtab location */
59 1.1 cgd char *end;
60 1.1 cgd char *private; /* optional machdep pointer */
61 1.1 cgd } db_symtab_t;
62 1.1 cgd
63 1.1 cgd extern db_symtab_t *db_last_symtab; /* where last symbol was found */
64 1.1 cgd
65 1.1 cgd /*
66 1.1 cgd * Symbol representation is specific to the symtab style:
67 1.1 cgd * BSD compilers use dbx' nlist, other compilers might use
68 1.1 cgd * a different one
69 1.1 cgd */
70 1.1 cgd typedef char * db_sym_t; /* opaque handle on symbols */
71 1.1 cgd #define DB_SYM_NULL ((db_sym_t)0)
72 1.1 cgd
73 1.1 cgd /*
74 1.1 cgd * Non-stripped symbol tables will have duplicates, for instance
75 1.1 cgd * the same string could match a parameter name, a local var, a
76 1.1 cgd * global var, etc.
77 1.1 cgd * We are most concern with the following matches.
78 1.1 cgd */
79 1.1 cgd typedef int db_strategy_t; /* search strategy */
80 1.1 cgd
81 1.1 cgd #define DB_STGY_ANY 0 /* anything goes */
82 1.1 cgd #define DB_STGY_XTRN 1 /* only external symbols */
83 1.1 cgd #define DB_STGY_PROC 2 /* only procedures */
84 1.1 cgd
85 1.1 cgd extern boolean_t db_qualify_ambiguous_names;
86 1.1 cgd /* if TRUE, check across symbol tables
87 1.1 cgd * for multiple occurrences of a name.
88 1.1 cgd * Might slow down quite a bit */
89 1.1 cgd
90 1.1 cgd /*
91 1.1 cgd * Functions exported by the symtable module
92 1.1 cgd */
93 1.1 cgd extern void db_add_symbol_table();
94 1.1 cgd /* extend the list of symbol tables */
95 1.1 cgd
96 1.1 cgd extern int db_value_of_name(/* char*, db_expr_t* */);
97 1.1 cgd /* find symbol value given name */
98 1.1 cgd
99 1.1 cgd extern db_sym_t db_search_symbol(/* db_expr_t, db_strategy_t, int* */);
100 1.1 cgd /* find symbol given value */
101 1.1 cgd
102 1.1 cgd extern void db_symbol_values(/* db_sym_t, char**, db_expr_t* */);
103 1.1 cgd /* return name and value of symbol */
104 1.1 cgd
105 1.1 cgd #define db_find_sym_and_offset(val,namep,offp) \
106 1.1 cgd db_symbol_values(db_search_symbol(val,DB_STGY_ANY,offp),namep,0)
107 1.1 cgd /* find name&value given approx val */
108 1.1 cgd
109 1.1 cgd #define db_find_xtrn_sym_and_offset(val,namep,offp) \
110 1.1 cgd db_symbol_values(db_search_symbol(val,DB_STGY_XTRN,offp),namep,0)
111 1.1 cgd /* ditto, but no locals */
112 1.1 cgd
113 1.1 cgd extern int db_eqname(/* char*, char*, char */);
114 1.1 cgd /* strcmp, modulo leading char */
115
116 extern void db_printsym(/* db_expr_t, db_strategy_t */);
117 /* print closest symbol to a value */
118