- Port rtw(4) from NetBSD, which supports various RealTek 8180 chip based
[dragonfly.git] / sys / ddb / db_sym.h
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  * $FreeBSD: src/sys/ddb/db_sym.h,v 1.19 1999/08/28 00:41:10 peter Exp $
27  * $DragonFly: src/sys/ddb/db_sym.h,v 1.4 2006/05/20 02:42:01 dillon Exp $
28  */
29
30 #ifndef _DDB_DB_SYM_H_
31 #define _DDB_DB_SYM_H_
32
33 #ifndef _DDB_DDB_H_
34 #include <ddb/ddb.h>
35 #endif
36
37 /*
38  *      Author: Alessandro Forin, Carnegie Mellon University
39  *      Date:   8/90
40  */
41
42 /*
43  * This module can handle multiple symbol tables
44  */
45 typedef struct {
46         char            *name;          /* symtab name */
47         char            *start;         /* symtab location */
48         char            *end;
49         char            *private;       /* optional machdep pointer */
50 } db_symtab_t;
51
52 /*
53  * Symbol representation is specific to the symtab style:
54  * BSD compilers use dbx' nlist, other compilers might use
55  * a different one
56  */
57 typedef char *          db_sym_t;       /* opaque handle on symbols */
58 typedef const char *    c_db_sym_t;     /* opaque handle on symbols */
59 #define DB_SYM_NULL     ((db_sym_t)0)
60 #define C_DB_SYM_NULL   ((c_db_sym_t)0)
61
62 /*
63  * Non-stripped symbol tables will have duplicates, for instance
64  * the same string could match a parameter name, a local var, a
65  * global var, etc.
66  * We are most concern with the following matches.
67  */
68 typedef int             db_strategy_t;  /* search strategy */
69
70 #define DB_STGY_ANY     0                       /* anything goes */
71 #define DB_STGY_XTRN    1                       /* only external symbols */
72 #define DB_STGY_PROC    2                       /* only procedures */
73
74 /*
75  * Functions exported by the symtable module
76  */
77 void            db_add_symbol_table (char *, char *, char *, char *);
78                                         /* extend the list of symbol tables */
79
80 c_db_sym_t      db_search_symbol (db_addr_t, db_strategy_t, db_expr_t *);
81                                         /* find symbol given value */
82
83 void            db_symbol_values (c_db_sym_t, const 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 (const char *, const char *, int);
95                                         /* strcmp, modulo leading char */
96
97 void            db_printsym (db_expr_t, db_strategy_t);
98                                         /* print closest symbol to a value */
99
100 int             db_sym_numargs (c_db_sym_t, int *, char **);
101
102 boolean_t       X_db_line_at_pc (db_symtab_t *symtab, c_db_sym_t cursym,
103                                      char **filename, int *linenum,
104                                      db_expr_t off);
105 c_db_sym_t      X_db_lookup (db_symtab_t *stab, const char *symstr);
106 c_db_sym_t      X_db_search_symbol (db_symtab_t *symtab, db_addr_t off,
107                                         db_strategy_t strategy,
108                                         db_expr_t *diffp);
109 int             X_db_sym_numargs (db_symtab_t *, c_db_sym_t, int *,
110                                       char **);
111 void            X_db_symbol_values (db_symtab_t *symtab,
112                                         c_db_sym_t sym, const char **namep,
113                                         db_expr_t *valuep);
114
115 #endif /* !_DDB_DB_SYM_H_ */