Remove some duplicate FreeBSD CVS IDs, move some IDs to better places.
[dragonfly.git] / sys / ddb / db_sym.h
CommitLineData
984263bc
MD
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 $
43c0ece6 27 * $DragonFly: src/sys/ddb/db_sym.h,v 1.3 2003/08/27 10:47:13 rob Exp $
984263bc
MD
28 */
29
30#ifndef _DDB_DB_SYM_H_
31#define _DDB_DB_SYM_H_
32
33/*
34 * Author: Alessandro Forin, Carnegie Mellon University
35 * Date: 8/90
36 */
37
38/*
39 * This module can handle multiple symbol tables
40 */
41typedef struct {
42 char *name; /* symtab name */
43 char *start; /* symtab location */
44 char *end;
45 char *private; /* optional machdep pointer */
46} db_symtab_t;
47
48/*
49 * Symbol representation is specific to the symtab style:
50 * BSD compilers use dbx' nlist, other compilers might use
51 * a different one
52 */
53typedef char * db_sym_t; /* opaque handle on symbols */
54typedef const char * c_db_sym_t; /* opaque handle on symbols */
55#define DB_SYM_NULL ((db_sym_t)0)
56#define C_DB_SYM_NULL ((c_db_sym_t)0)
57
58/*
59 * Non-stripped symbol tables will have duplicates, for instance
60 * the same string could match a parameter name, a local var, a
61 * global var, etc.
62 * We are most concern with the following matches.
63 */
64typedef int db_strategy_t; /* search strategy */
65
66#define DB_STGY_ANY 0 /* anything goes */
67#define DB_STGY_XTRN 1 /* only external symbols */
68#define DB_STGY_PROC 2 /* only procedures */
69
70/*
71 * Functions exported by the symtable module
72 */
43c0ece6 73void db_add_symbol_table (char *, char *, char *, char *);
984263bc
MD
74 /* extend the list of symbol tables */
75
43c0ece6 76c_db_sym_t db_search_symbol (db_addr_t, db_strategy_t, db_expr_t *);
984263bc
MD
77 /* find symbol given value */
78
43c0ece6 79void db_symbol_values (c_db_sym_t, const char **, db_expr_t *);
984263bc
MD
80 /* return name and value of symbol */
81
82#define db_find_sym_and_offset(val,namep,offp) \
83 db_symbol_values(db_search_symbol(val,DB_STGY_ANY,offp),namep,0)
84 /* find name&value given approx val */
85
86#define db_find_xtrn_sym_and_offset(val,namep,offp) \
87 db_symbol_values(db_search_symbol(val,DB_STGY_XTRN,offp),namep,0)
88 /* ditto, but no locals */
89
43c0ece6 90int db_eqname (const char *, const char *, int);
984263bc
MD
91 /* strcmp, modulo leading char */
92
43c0ece6 93void db_printsym (db_expr_t, db_strategy_t);
984263bc
MD
94 /* print closest symbol to a value */
95
43c0ece6 96int db_sym_numargs (c_db_sym_t, int *, char **);
984263bc 97
43c0ece6 98boolean_t X_db_line_at_pc (db_symtab_t *symtab, c_db_sym_t cursym,
984263bc 99 char **filename, int *linenum,
43c0ece6
RG
100 db_expr_t off);
101c_db_sym_t X_db_lookup (db_symtab_t *stab, const char *symstr);
102c_db_sym_t X_db_search_symbol (db_symtab_t *symtab, db_addr_t off,
984263bc 103 db_strategy_t strategy,
43c0ece6
RG
104 db_expr_t *diffp);
105int X_db_sym_numargs (db_symtab_t *, c_db_sym_t, int *,
106 char **);
107void X_db_symbol_values (db_symtab_t *symtab,
984263bc 108 c_db_sym_t sym, const char **namep,
43c0ece6 109 db_expr_t *valuep);
984263bc
MD
110
111#endif /* !_DDB_DB_SYM_H_ */