xref: /freebsd/sys/ddb/db_ctf.h (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2023 Bojan Novković <bnovkov@freebsd.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _DDB_DB_CTF_H_
29 #define _DDB_DB_CTF_H_
30 
31 #include <sys/types.h>
32 #include <sys/ctf.h>
33 #include <sys/linker.h>
34 
35 #include <ddb/ddb.h>
36 #include <ddb/db_sym.h>
37 
38 #define DB_CTF_INVALID_OFF 0xffffffff
39 
40 struct db_ctf_sym_data {
41 	linker_ctf_t lc;
42 	Elf_Sym *sym;
43 };
44 
45 typedef struct db_ctf_sym_data *db_ctf_sym_data_t;
46 
47 /*
48  * Routines for finding symbols and CTF info accross all loaded linker files.
49  */
50 int db_ctf_find_symbol(const char *name, db_ctf_sym_data_t sd);
51 struct ctf_type_v3 *db_ctf_find_typename(db_ctf_sym_data_t sd,
52     const char *typename);
53 bool db_ctf_lookup_typename(linker_ctf_t *lc, const char *typename);
54 
55 /*
56  * Routines for working with CTF data.
57  */
58 struct ctf_type_v3 *db_ctf_sym_to_type(db_ctf_sym_data_t sd);
59 const char *db_ctf_stroff_to_str(db_ctf_sym_data_t sd, uint32_t off);
60 struct ctf_type_v3 *db_ctf_typename_to_type(linker_ctf_t *lc, const char *name);
61 struct ctf_type_v3 *db_ctf_typeid_to_type(db_ctf_sym_data_t sd,
62     uint32_t typeid);
63 
64 #endif /* !_DDB_DB_CTF_H_ */
65