VirtualBox

source: vbox/trunk/src/VBox/ExtPacks/VBoxDTrace/onnv/common/ctf/ctf_impl.h

Last change on this file was 69435, checked in by vboxsync, 7 years ago

Debugger,DTrace,IPRT: Use iprt/formats/elf*.h instead of the internal IPRT headers.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.1 KB
Line 
1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License, Version 1.0 only
6 * (the "License"). You may not use this file except in compliance
7 * with the License.
8 *
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or http://www.opensolaris.org/os/licensing.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
13 *
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
19 *
20 * CDDL HEADER END
21 */
22
23/*
24 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
25 * Use is subject to license terms.
26 */
27
28#ifndef _CTF_IMPL_H
29#define _CTF_IMPL_H
30
31#ifndef VBOX
32#pragma ident "%Z%%M% %I% %E% SMI"
33
34#include <sys/types.h>
35#include <sys/errno.h>
36#include <sys/sysmacros.h>
37#else /* VBOX */
38# include <iprt/formats/elf32.h>
39# include <iprt/formats/elf64.h>
40# include <errno.h>
41# include "VBoxDTraceLibCWrappers.h"
42#endif /* VBOX */
43#include <sys/ctf_api.h>
44
45#ifdef _KERNEL
46
47#ifndef VBOX
48#include <sys/systm.h>
49#include <sys/cmn_err.h>
50#include <sys/varargs.h>
51#endif
52
53#define isspace(c) \
54 ((c) == ' ' || (c) == '\t' || (c) == '\n' || \
55 (c) == '\r' || (c) == '\f' || (c) == '\v')
56
57#define MAP_FAILED ((void *)-1)
58
59#else /* _KERNEL */
60
61#ifndef VBOX
62#include <strings.h>
63#include <stdlib.h>
64#include <stdarg.h>
65#include <stdio.h>
66#include <limits.h>
67#include <ctype.h>
68#endif
69
70#endif /* _KERNEL */
71
72#ifdef __cplusplus
73extern "C" {
74#endif
75
76typedef struct ctf_helem {
77 uint_t h_name; /* reference to name in string table */
78 ushort_t h_type; /* corresponding type ID number */
79 ushort_t h_next; /* index of next element in hash chain */
80} ctf_helem_t;
81
82typedef struct ctf_hash {
83 ushort_t *h_buckets; /* hash bucket array (chain indices) */
84 ctf_helem_t *h_chains; /* hash chains buffer */
85 ushort_t h_nbuckets; /* number of elements in bucket array */
86 ushort_t h_nelems; /* number of elements in hash table */
87 uint_t h_free; /* index of next free hash element */
88} ctf_hash_t;
89
90typedef struct ctf_strs {
91 const char *cts_strs; /* base address of string table */
92 size_t cts_len; /* size of string table in bytes */
93} ctf_strs_t;
94
95typedef struct ctf_dmodel {
96 const char *ctd_name; /* data model name */
97 int ctd_code; /* data model code */
98 size_t ctd_pointer; /* size of void * in bytes */
99 size_t ctd_char; /* size of char in bytes */
100 size_t ctd_short; /* size of short in bytes */
101 size_t ctd_int; /* size of int in bytes */
102 size_t ctd_long; /* size of long in bytes */
103} ctf_dmodel_t;
104
105typedef struct ctf_lookup {
106 const char *ctl_prefix; /* string prefix for this lookup */
107 size_t ctl_len; /* length of prefix string in bytes */
108 ctf_hash_t *ctl_hash; /* pointer to hash table for lookup */
109} ctf_lookup_t;
110
111typedef struct ctf_fileops {
112 ushort_t (*ctfo_get_kind)(ushort_t);
113 ushort_t (*ctfo_get_root)(ushort_t);
114 ushort_t (*ctfo_get_vlen)(ushort_t);
115} ctf_fileops_t;
116
117typedef struct ctf_list {
118 struct ctf_list *l_prev; /* previous pointer or tail pointer */
119 struct ctf_list *l_next; /* next pointer or head pointer */
120} ctf_list_t;
121
122typedef enum {
123 CTF_PREC_BASE,
124 CTF_PREC_POINTER,
125 CTF_PREC_ARRAY,
126 CTF_PREC_FUNCTION,
127 CTF_PREC_MAX
128} ctf_decl_prec_t;
129
130typedef struct ctf_decl_node {
131 ctf_list_t cd_list; /* linked list pointers */
132 ctf_id_t cd_type; /* type identifier */
133 uint_t cd_kind; /* type kind */
134 uint_t cd_n; /* type dimension if array */
135} ctf_decl_node_t;
136
137typedef struct ctf_decl {
138 ctf_list_t cd_nodes[CTF_PREC_MAX]; /* declaration node stacks */
139 int cd_order[CTF_PREC_MAX]; /* storage order of decls */
140 ctf_decl_prec_t cd_qualp; /* qualifier precision */
141 ctf_decl_prec_t cd_ordp; /* ordered precision */
142 char *cd_buf; /* buffer for output */
143 char *cd_ptr; /* buffer location */
144 char *cd_end; /* buffer limit */
145 size_t cd_len; /* buffer space required */
146 int cd_err; /* saved error value */
147} ctf_decl_t;
148
149typedef struct ctf_dmdef {
150 ctf_list_t dmd_list; /* list forward/back pointers */
151 char *dmd_name; /* name of this member */
152 ctf_id_t dmd_type; /* type of this member (for sou) */
153 ulong_t dmd_offset; /* offset of this member in bits (for sou) */
154 int dmd_value; /* value of this member (for enum) */
155} ctf_dmdef_t;
156
157typedef struct ctf_dtdef {
158 ctf_list_t dtd_list; /* list forward/back pointers */
159 struct ctf_dtdef *dtd_hash; /* hash chain pointer for ctf_dthash */
160 char *dtd_name; /* name associated with definition (if any) */
161 ctf_id_t dtd_type; /* type identifier for this definition */
162 ctf_type_t dtd_data; /* type node (see <sys/ctf.h>) */
163 union {
164 ctf_list_t dtu_members; /* struct, union, or enum */
165 ctf_arinfo_t dtu_arr; /* array */
166 ctf_encoding_t dtu_enc; /* integer or float */
167 ctf_id_t *dtu_argv; /* function */
168 } dtd_u;
169} ctf_dtdef_t;
170
171typedef struct ctf_bundle {
172 ctf_file_t *ctb_file; /* CTF container handle */
173 ctf_id_t ctb_type; /* CTF type identifier */
174 ctf_dtdef_t *ctb_dtd; /* CTF dynamic type definition (if any) */
175} ctf_bundle_t;
176
177/*
178 * The ctf_file is the structure used to represent a CTF container to library
179 * clients, who see it only as an opaque pointer. Modifications can therefore
180 * be made freely to this structure without regard to client versioning. The
181 * ctf_file_t typedef appears in <sys/ctf_api.h> and declares a forward tag.
182 *
183 * NOTE: ctf_update() requires that everything inside of ctf_file either be an
184 * immediate value, a pointer to dynamically allocated data *outside* of the
185 * ctf_file itself, or a pointer to statically allocated data. If you add a
186 * pointer to ctf_file that points to something within the ctf_file itself,
187 * you must make corresponding changes to ctf_update().
188 */
189struct ctf_file {
190 const ctf_fileops_t *ctf_fileops; /* version-specific file operations */
191 ctf_sect_t ctf_data; /* CTF data from object file */
192 ctf_sect_t ctf_symtab; /* symbol table from object file */
193 ctf_sect_t ctf_strtab; /* string table from object file */
194 ctf_hash_t ctf_structs; /* hash table of struct types */
195 ctf_hash_t ctf_unions; /* hash table of union types */
196 ctf_hash_t ctf_enums; /* hash table of enum types */
197 ctf_hash_t ctf_names; /* hash table of remaining type names */
198 ctf_lookup_t ctf_lookups[5]; /* pointers to hashes for name lookup */
199 ctf_strs_t ctf_str[2]; /* array of string table base and bounds */
200 const uchar_t *ctf_base; /* base of CTF header + uncompressed buffer */
201 const uchar_t *ctf_buf; /* uncompressed CTF data buffer */
202 size_t ctf_size; /* size of CTF header + uncompressed data */
203 uint_t *ctf_sxlate; /* translation table for symtab entries */
204 ulong_t ctf_nsyms; /* number of entries in symtab xlate table */
205 uint_t *ctf_txlate; /* translation table for type IDs */
206 ushort_t *ctf_ptrtab; /* translation table for pointer-to lookups */
207 ulong_t ctf_typemax; /* maximum valid type ID number */
208 const ctf_dmodel_t *ctf_dmodel; /* data model pointer (see above) */
209 struct ctf_file *ctf_parent; /* parent CTF container (if any) */
210 const char *ctf_parlabel; /* label in parent container (if any) */
211 const char *ctf_parname; /* basename of parent (if any) */
212 uint_t ctf_refcnt; /* reference count (for parent links) */
213 uint_t ctf_flags; /* libctf flags (see below) */
214 int ctf_errno; /* error code for most recent error */
215 int ctf_version; /* CTF data version */
216 ctf_dtdef_t **ctf_dthash; /* hash of dynamic type definitions */
217 ulong_t ctf_dthashlen; /* size of dynamic type hash bucket array */
218 ctf_list_t ctf_dtdefs; /* list of dynamic type definitions */
219 size_t ctf_dtstrlen; /* total length of dynamic type strings */
220 ulong_t ctf_dtnextid; /* next dynamic type id to assign */
221 ulong_t ctf_dtoldid; /* oldest id that has been committed */
222 void *ctf_specific; /* data for ctf_get/setspecific */
223};
224
225#define LCTF_INDEX_TO_TYPEPTR(fp, i) \
226 ((ctf_type_t *)((uintptr_t)(fp)->ctf_buf + (fp)->ctf_txlate[(i)]))
227
228#define LCTF_INFO_KIND(fp, info) ((fp)->ctf_fileops->ctfo_get_kind(info))
229#define LCTF_INFO_ROOT(fp, info) ((fp)->ctf_fileops->ctfo_get_root(info))
230#define LCTF_INFO_VLEN(fp, info) ((fp)->ctf_fileops->ctfo_get_vlen(info))
231
232#define LCTF_MMAP 0x0001 /* libctf should munmap buffers on close */
233#define LCTF_CHILD 0x0002 /* CTF container is a child */
234#define LCTF_RDWR 0x0004 /* CTF container is writable */
235#define LCTF_DIRTY 0x0008 /* CTF container has been modified */
236
237#define ECTF_BASE 1000 /* base value for libctf errnos */
238
239enum {
240 ECTF_FMT = ECTF_BASE, /* file is not in CTF or ELF format */
241 ECTF_ELFVERS, /* ELF version is more recent than libctf */
242 ECTF_CTFVERS, /* CTF version is more recent than libctf */
243 ECTF_ENDIAN, /* data is different endian-ness than lib */
244 ECTF_SYMTAB, /* symbol table uses invalid entry size */
245 ECTF_SYMBAD, /* symbol table data buffer invalid */
246 ECTF_STRBAD, /* string table data buffer invalid */
247 ECTF_CORRUPT, /* file data corruption detected */
248 ECTF_NOCTFDATA, /* ELF file does not contain CTF data */
249 ECTF_NOCTFBUF, /* buffer does not contain CTF data */
250 ECTF_NOSYMTAB, /* symbol table data is not available */
251 ECTF_NOPARENT, /* parent CTF container is not available */
252 ECTF_DMODEL, /* data model mismatch */
253 ECTF_MMAP, /* failed to mmap a data section */
254 ECTF_ZMISSING, /* decompression library not installed */
255 ECTF_ZINIT, /* failed to initialize decompression library */
256 ECTF_ZALLOC, /* failed to allocate decompression buffer */
257 ECTF_DECOMPRESS, /* failed to decompress CTF data */
258 ECTF_STRTAB, /* string table for this string is missing */
259 ECTF_BADNAME, /* string offset is corrupt w.r.t. strtab */
260 ECTF_BADID, /* invalid type ID number */
261 ECTF_NOTSOU, /* type is not a struct or union */
262 ECTF_NOTENUM, /* type is not an enum */
263 ECTF_NOTSUE, /* type is not a struct, union, or enum */
264 ECTF_NOTINTFP, /* type is not an integer or float */
265 ECTF_NOTARRAY, /* type is not an array */
266 ECTF_NOTREF, /* type does not reference another type */
267 ECTF_NAMELEN, /* buffer is too small to hold type name */
268 ECTF_NOTYPE, /* no type found corresponding to name */
269 ECTF_SYNTAX, /* syntax error in type name */
270 ECTF_NOTFUNC, /* symtab entry does not refer to a function */
271 ECTF_NOFUNCDAT, /* no func info available for function */
272 ECTF_NOTDATA, /* symtab entry does not refer to a data obj */
273 ECTF_NOTYPEDAT, /* no type info available for object */
274 ECTF_NOLABEL, /* no label found corresponding to name */
275 ECTF_NOLABELDATA, /* file does not contain any labels */
276 ECTF_NOTSUP, /* feature not supported */
277 ECTF_NOENUMNAM, /* enum element name not found */
278 ECTF_NOMEMBNAM, /* member name not found */
279 ECTF_RDONLY, /* CTF container is read-only */
280 ECTF_DTFULL, /* CTF type is full (no more members allowed) */
281 ECTF_FULL, /* CTF container is full */
282 ECTF_DUPMEMBER, /* duplicate member name definition */
283 ECTF_CONFLICT /* conflicting type definition present */
284};
285
286extern ssize_t ctf_get_ctt_size(const ctf_file_t *, const ctf_type_t *,
287 ssize_t *, ssize_t *);
288
289extern const ctf_type_t *ctf_lookup_by_id(ctf_file_t **, ctf_id_t);
290
291extern int ctf_hash_create(ctf_hash_t *, ulong_t);
292extern int ctf_hash_insert(ctf_hash_t *, ctf_file_t *, ushort_t, uint_t);
293extern int ctf_hash_define(ctf_hash_t *, ctf_file_t *, ushort_t, uint_t);
294extern ctf_helem_t *ctf_hash_lookup(ctf_hash_t *, ctf_file_t *,
295 const char *, size_t);
296extern uint_t ctf_hash_size(const ctf_hash_t *);
297extern void ctf_hash_destroy(ctf_hash_t *);
298
299#define ctf_list_prev(elem) ((void *)(((ctf_list_t *)(elem))->l_prev))
300#define ctf_list_next(elem) ((void *)(((ctf_list_t *)(elem))->l_next))
301
302extern void ctf_list_append(ctf_list_t *, void *);
303extern void ctf_list_prepend(ctf_list_t *, void *);
304extern void ctf_list_delete(ctf_list_t *, void *);
305
306extern void ctf_dtd_insert(ctf_file_t *, ctf_dtdef_t *);
307extern void ctf_dtd_delete(ctf_file_t *, ctf_dtdef_t *);
308extern ctf_dtdef_t *ctf_dtd_lookup(ctf_file_t *, ctf_id_t);
309
310extern void ctf_decl_init(ctf_decl_t *, char *, size_t);
311extern void ctf_decl_fini(ctf_decl_t *);
312extern void ctf_decl_push(ctf_decl_t *, ctf_file_t *, ctf_id_t);
313extern void ctf_decl_sprintf(ctf_decl_t *, const char *, ...);
314
315extern const char *ctf_strraw(ctf_file_t *, uint_t);
316extern const char *ctf_strptr(ctf_file_t *, uint_t);
317
318extern ctf_file_t *ctf_set_open_errno(int *, int);
319extern long ctf_set_errno(ctf_file_t *, int);
320
321extern const void *ctf_sect_mmap(ctf_sect_t *, int);
322extern void ctf_sect_munmap(const ctf_sect_t *);
323
324extern void *ctf_data_alloc(size_t);
325extern void ctf_data_free(void *, size_t);
326extern void ctf_data_protect(void *, size_t);
327
328extern void *ctf_alloc(size_t);
329extern void ctf_free(void *, size_t);
330
331extern char *ctf_strdup(const char *);
332extern const char *ctf_strerror(int);
333extern void ctf_dprintf(const char *, ...);
334
335extern void *ctf_zopen(int *);
336
337extern const char _CTF_SECTION[]; /* name of CTF ELF section */
338extern const char _CTF_NULLSTR[]; /* empty string */
339
340extern int _libctf_version; /* library client version */
341extern int _libctf_debug; /* debugging messages enabled */
342
343#ifdef VBOX
344# ifndef MAP_FAILED /* returned by ctf_data_alloc on failure. */
345# define MAP_FAILED ((void *)~(uintptr_t)0)
346# endif
347#endif
348
349#ifdef __cplusplus
350}
351#endif
352
353#endif /* _CTF_IMPL_H */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette