1 /* Implementation header.
2 Copyright (C) 2019 Free Software Foundation, Inc.
4 This file is part of libctf.
6 libctf is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING. If not see
18 <http://www.gnu.org/licenses/>. */
25 #include "ctf-decls.h"
27 #include <sys/types.h>
42 /* Compiler attributes. */
44 #if defined (__GNUC__)
46 /* GCC. We assume that all compilers claiming to be GCC support sufficiently
47 many GCC attributes that the code below works. If some non-GCC compilers
48 masquerading as GCC in fact do not implement these attributes, version checks
51 /* We use the _libctf_*_ pattern to avoid clashes with any future attribute
52 macros glibc may introduce, which have names of the pattern
53 __attribute_blah__. */
55 #define _libctf_printflike_(string_index,first_to_check) \
56 __attribute__ ((__format__ (__printf__, (string_index), (first_to_check))))
57 #define _libctf_unlikely_(x) __builtin_expect ((x), 0)
58 #define _libctf_unused_ __attribute__ ((__unused__))
59 #define _libctf_malloc_ __attribute__((__malloc__))
63 /* libctf in-memory state. */
65 typedef struct ctf_fixed_hash ctf_hash_t
; /* Private to ctf-hash.c. */
66 typedef struct ctf_dynhash ctf_dynhash_t
; /* Private to ctf-hash.c. */
68 typedef struct ctf_strs
70 const char *cts_strs
; /* Base address of string table. */
71 size_t cts_len
; /* Size of string table in bytes. */
74 typedef struct ctf_strs_writable
76 char *cts_strs
; /* Base address of string table. */
77 size_t cts_len
; /* Size of string table in bytes. */
78 } ctf_strs_writable_t
;
80 typedef struct ctf_dmodel
82 const char *ctd_name
; /* Data model name. */
83 int ctd_code
; /* Data model code. */
84 size_t ctd_pointer
; /* Size of void * in bytes. */
85 size_t ctd_char
; /* Size of char in bytes. */
86 size_t ctd_short
; /* Size of short in bytes. */
87 size_t ctd_int
; /* Size of int in bytes. */
88 size_t ctd_long
; /* Size of long in bytes. */
91 typedef struct ctf_lookup
93 const char *ctl_prefix
; /* String prefix for this lookup. */
94 size_t ctl_len
; /* Length of prefix string in bytes. */
95 ctf_hash_t
*ctl_hash
; /* Pointer to hash table for lookup. */
98 typedef struct ctf_fileops
100 uint32_t (*ctfo_get_kind
) (uint32_t);
101 uint32_t (*ctfo_get_root
) (uint32_t);
102 uint32_t (*ctfo_get_vlen
) (uint32_t);
103 ssize_t (*ctfo_get_ctt_size
) (const ctf_file_t
*, const ctf_type_t
*,
104 ssize_t
*, ssize_t
*);
105 ssize_t (*ctfo_get_vbytes
) (unsigned short, ssize_t
, size_t);
108 typedef struct ctf_list
110 struct ctf_list
*l_prev
; /* Previous pointer or tail pointer. */
111 struct ctf_list
*l_next
; /* Next pointer or head pointer. */
123 typedef struct ctf_decl_node
125 ctf_list_t cd_list
; /* Linked list pointers. */
126 ctf_id_t cd_type
; /* Type identifier. */
127 uint32_t cd_kind
; /* Type kind. */
128 uint32_t cd_n
; /* Type dimension if array. */
131 typedef struct ctf_decl
133 ctf_list_t cd_nodes
[CTF_PREC_MAX
]; /* Declaration node stacks. */
134 int cd_order
[CTF_PREC_MAX
]; /* Storage order of decls. */
135 ctf_decl_prec_t cd_qualp
; /* Qualifier precision. */
136 ctf_decl_prec_t cd_ordp
; /* Ordered precision. */
137 char *cd_buf
; /* Buffer for output. */
138 int cd_err
; /* Saved error value. */
139 int cd_enomem
; /* Nonzero if OOM during printing. */
142 typedef struct ctf_dmdef
144 ctf_list_t dmd_list
; /* List forward/back pointers. */
145 char *dmd_name
; /* Name of this member. */
146 ctf_id_t dmd_type
; /* Type of this member (for sou). */
147 unsigned long dmd_offset
; /* Offset of this member in bits (for sou). */
148 int dmd_value
; /* Value of this member (for enum). */
151 typedef struct ctf_dtdef
153 ctf_list_t dtd_list
; /* List forward/back pointers. */
154 char *dtd_name
; /* Name associated with definition (if any). */
155 ctf_id_t dtd_type
; /* Type identifier for this definition. */
156 ctf_type_t dtd_data
; /* Type node: name left unpopulated. */
159 ctf_list_t dtu_members
; /* struct, union, or enum */
160 ctf_arinfo_t dtu_arr
; /* array */
161 ctf_encoding_t dtu_enc
; /* integer or float */
162 ctf_id_t
*dtu_argv
; /* function */
163 ctf_slice_t dtu_slice
; /* slice */
167 typedef struct ctf_dvdef
169 ctf_list_t dvd_list
; /* List forward/back pointers. */
170 char *dvd_name
; /* Name associated with variable. */
171 ctf_id_t dvd_type
; /* Type of variable. */
172 unsigned long dvd_snapshots
; /* Snapshot count when inserted. */
175 typedef struct ctf_bundle
177 ctf_file_t
*ctb_file
; /* CTF container handle. */
178 ctf_id_t ctb_type
; /* CTF type identifier. */
179 ctf_dtdef_t
*ctb_dtd
; /* CTF dynamic type definition (if any). */
182 /* Atoms associate strings with a list of the CTF items that reference that
183 string, so that ctf_update() can instantiate all the strings using the
184 ctf_str_atoms and then reassociate them with the real string later.
186 Strings can be interned into ctf_str_atom without having refs associated
187 with them, for values that are returned to callers, etc. Items are only
188 removed from this table on ctf_close(), but on every ctf_update(), all the
189 csa_refs in all entries are purged. */
191 typedef struct ctf_str_atom
193 const char *csa_str
; /* Backpointer to string (hash key). */
194 ctf_list_t csa_refs
; /* This string's refs. */
195 unsigned long csa_snapshot_id
; /* Snapshot ID at time of creation. */
198 /* The refs of a single string in the atoms table. */
200 typedef struct ctf_str_atom_ref
202 ctf_list_t caf_list
; /* List forward/back pointers. */
203 uint32_t *caf_ref
; /* A single ref to this string. */
204 } ctf_str_atom_ref_t
;
206 /* The ctf_file is the structure used to represent a CTF container to library
207 clients, who see it only as an opaque pointer. Modifications can therefore
208 be made freely to this structure without regard to client versioning. The
209 ctf_file_t typedef appears in <ctf-api.h> and declares a forward tag.
211 NOTE: ctf_update() requires that everything inside of ctf_file either be an
212 immediate value, a pointer to dynamically allocated data *outside* of the
213 ctf_file itself, or a pointer to statically allocated data. If you add a
214 pointer to ctf_file that points to something within the ctf_file itself,
215 you must make corresponding changes to ctf_update(). */
219 const ctf_fileops_t
*ctf_fileops
; /* Version-specific file operations. */
220 struct ctf_header
*ctf_header
; /* The header from this CTF file. */
221 unsigned char ctf_openflags
; /* Flags the file had when opened. */
222 ctf_sect_t ctf_data
; /* CTF data from object file. */
223 ctf_sect_t ctf_symtab
; /* Symbol table from object file. */
224 ctf_sect_t ctf_strtab
; /* String table from object file. */
225 void *ctf_data_mmapped
; /* CTF data we mmapped, to free later. */
226 size_t ctf_data_mmapped_len
; /* Length of CTF data we mmapped. */
227 ctf_hash_t
*ctf_structs
; /* Hash table of struct types. */
228 ctf_hash_t
*ctf_unions
; /* Hash table of union types. */
229 ctf_hash_t
*ctf_enums
; /* Hash table of enum types. */
230 ctf_hash_t
*ctf_names
; /* Hash table of remaining type names. */
231 ctf_lookup_t ctf_lookups
[5]; /* Pointers to hashes for name lookup. */
232 ctf_strs_t ctf_str
[2]; /* Array of string table base and bounds. */
233 ctf_dynhash_t
*ctf_str_atoms
; /* Hash table of ctf_str_atoms_t. */
234 uint64_t ctf_str_num_refs
; /* Number of refs to cts_str_atoms. */
235 unsigned char *ctf_base
; /* CTF file pointer. */
236 unsigned char *ctf_dynbase
; /* Freeable CTF file pointer. */
237 unsigned char *ctf_buf
; /* Uncompressed CTF data buffer. */
238 size_t ctf_size
; /* Size of CTF header + uncompressed data. */
239 uint32_t *ctf_sxlate
; /* Translation table for symtab entries. */
240 unsigned long ctf_nsyms
; /* Number of entries in symtab xlate table. */
241 uint32_t *ctf_txlate
; /* Translation table for type IDs. */
242 uint32_t *ctf_ptrtab
; /* Translation table for pointer-to lookups. */
243 struct ctf_varent
*ctf_vars
; /* Sorted variable->type mapping. */
244 unsigned long ctf_nvars
; /* Number of variables in ctf_vars. */
245 unsigned long ctf_typemax
; /* Maximum valid type ID number. */
246 const ctf_dmodel_t
*ctf_dmodel
; /* Data model pointer (see above). */
247 const char *ctf_cuname
; /* Compilation unit name (if any). */
248 char *ctf_dyncuname
; /* Dynamically allocated name of CU. */
249 struct ctf_file
*ctf_parent
; /* Parent CTF container (if any). */
250 const char *ctf_parlabel
; /* Label in parent container (if any). */
251 const char *ctf_parname
; /* Basename of parent (if any). */
252 char *ctf_dynparname
; /* Dynamically allocated name of parent. */
253 uint32_t ctf_parmax
; /* Highest type ID of a parent type. */
254 uint32_t ctf_refcnt
; /* Reference count (for parent links). */
255 uint32_t ctf_flags
; /* Libctf flags (see below). */
256 int ctf_errno
; /* Error code for most recent error. */
257 int ctf_version
; /* CTF data version. */
258 ctf_dynhash_t
*ctf_dthash
; /* Hash of dynamic type definitions. */
259 ctf_dynhash_t
*ctf_dtbyname
; /* DTDs, indexed by name. */
260 ctf_list_t ctf_dtdefs
; /* List of dynamic type definitions. */
261 ctf_dynhash_t
*ctf_dvhash
; /* Hash of dynamic variable mappings. */
262 ctf_list_t ctf_dvdefs
; /* List of dynamic variable definitions. */
263 unsigned long ctf_dtnextid
; /* Next dynamic type id to assign. */
264 unsigned long ctf_dtoldid
; /* Oldest id that has been committed. */
265 unsigned long ctf_snapshots
; /* ctf_snapshot() plus ctf_update() count. */
266 unsigned long ctf_snapshot_lu
; /* ctf_snapshot() call count at last update. */
267 ctf_archive_t
*ctf_archive
; /* Archive this ctf_file_t came from. */
268 char *ctf_tmp_typeslice
; /* Storage for slicing up type names. */
269 size_t ctf_tmp_typeslicelen
; /* Size of the typeslice. */
270 void *ctf_specific
; /* Data for ctf_get/setspecific(). */
273 /* An abstraction over both a ctf_file_t and a ctf_archive_t. */
275 struct ctf_archive_internal
278 ctf_file_t
*ctfi_file
;
279 struct ctf_archive
*ctfi_archive
;
280 ctf_sect_t ctfi_symsect
;
281 ctf_sect_t ctfi_strsect
;
283 bfd
*ctfi_abfd
; /* Optional source of section data. */
284 void (*ctfi_bfd_close
) (struct ctf_archive_internal
*);
287 /* Return x rounded up to an alignment boundary.
288 eg, P2ROUNDUP(0x1234, 0x100) == 0x1300 (0x13*align)
289 eg, P2ROUNDUP(0x5600, 0x100) == 0x5600 (0x56*align) */
290 #define P2ROUNDUP(x, align) (-(-(x) & -(align)))
292 /* * If an offs is not aligned already then round it up and align it. */
293 #define LCTF_ALIGN_OFFS(offs, align) ((offs + (align - 1)) & ~(align - 1))
295 #define LCTF_TYPE_ISPARENT(fp, id) ((id) <= fp->ctf_parmax)
296 #define LCTF_TYPE_ISCHILD(fp, id) ((id) > fp->ctf_parmax)
297 #define LCTF_TYPE_TO_INDEX(fp, id) ((id) & (fp->ctf_parmax))
298 #define LCTF_INDEX_TO_TYPE(fp, id, child) (child ? ((id) | (fp->ctf_parmax+1)) : \
301 #define LCTF_INDEX_TO_TYPEPTR(fp, i) \
302 ((ctf_type_t *)((uintptr_t)(fp)->ctf_buf + (fp)->ctf_txlate[(i)]))
304 #define LCTF_INFO_KIND(fp, info) ((fp)->ctf_fileops->ctfo_get_kind(info))
305 #define LCTF_INFO_ISROOT(fp, info) ((fp)->ctf_fileops->ctfo_get_root(info))
306 #define LCTF_INFO_VLEN(fp, info) ((fp)->ctf_fileops->ctfo_get_vlen(info))
307 #define LCTF_VBYTES(fp, kind, size, vlen) \
308 ((fp)->ctf_fileops->ctfo_get_vbytes(kind, size, vlen))
310 static inline ssize_t
ctf_get_ctt_size (const ctf_file_t
*fp
,
311 const ctf_type_t
*tp
,
315 return (fp
->ctf_fileops
->ctfo_get_ctt_size (fp
, tp
, sizep
, incrementp
));
318 #define LCTF_CHILD 0x0001 /* CTF container is a child */
319 #define LCTF_RDWR 0x0002 /* CTF container is writable */
320 #define LCTF_DIRTY 0x0004 /* CTF container has been modified */
322 extern const ctf_type_t
*ctf_lookup_by_id (ctf_file_t
**, ctf_id_t
);
324 typedef unsigned int (*ctf_hash_fun
) (const void *ptr
);
325 extern unsigned int ctf_hash_integer (const void *ptr
);
326 extern unsigned int ctf_hash_string (const void *ptr
);
328 typedef int (*ctf_hash_eq_fun
) (const void *, const void *);
329 extern int ctf_hash_eq_integer (const void *, const void *);
330 extern int ctf_hash_eq_string (const void *, const void *);
332 typedef void (*ctf_hash_free_fun
) (void *);
334 typedef void (*ctf_hash_iter_f
) (void *key
, void *value
, void *arg
);
335 typedef int (*ctf_hash_iter_remove_f
) (void *key
, void *value
, void *arg
);
337 extern ctf_hash_t
*ctf_hash_create (unsigned long, ctf_hash_fun
, ctf_hash_eq_fun
);
338 extern int ctf_hash_insert_type (ctf_hash_t
*, ctf_file_t
*, uint32_t, uint32_t);
339 extern int ctf_hash_define_type (ctf_hash_t
*, ctf_file_t
*, uint32_t, uint32_t);
340 extern ctf_id_t
ctf_hash_lookup_type (ctf_hash_t
*, ctf_file_t
*, const char *);
341 extern uint32_t ctf_hash_size (const ctf_hash_t
*);
342 extern void ctf_hash_destroy (ctf_hash_t
*);
344 extern ctf_dynhash_t
*ctf_dynhash_create (ctf_hash_fun
, ctf_hash_eq_fun
,
345 ctf_hash_free_fun
, ctf_hash_free_fun
);
346 extern int ctf_dynhash_insert (ctf_dynhash_t
*, void *, void *);
347 extern void ctf_dynhash_remove (ctf_dynhash_t
*, const void *);
348 extern void *ctf_dynhash_lookup (ctf_dynhash_t
*, const void *);
349 extern void ctf_dynhash_destroy (ctf_dynhash_t
*);
350 extern void ctf_dynhash_iter (ctf_dynhash_t
*, ctf_hash_iter_f
, void *);
351 extern void ctf_dynhash_iter_remove (ctf_dynhash_t
*, ctf_hash_iter_remove_f
,
354 #define ctf_list_prev(elem) ((void *)(((ctf_list_t *)(elem))->l_prev))
355 #define ctf_list_next(elem) ((void *)(((ctf_list_t *)(elem))->l_next))
357 extern void ctf_list_append (ctf_list_t
*, void *);
358 extern void ctf_list_prepend (ctf_list_t
*, void *);
359 extern void ctf_list_delete (ctf_list_t
*, void *);
361 extern int ctf_dtd_insert (ctf_file_t
*, ctf_dtdef_t
*);
362 extern void ctf_dtd_delete (ctf_file_t
*, ctf_dtdef_t
*);
363 extern ctf_dtdef_t
*ctf_dtd_lookup (const ctf_file_t
*, ctf_id_t
);
364 extern ctf_dtdef_t
*ctf_dynamic_type (const ctf_file_t
*, ctf_id_t
);
366 extern int ctf_dvd_insert (ctf_file_t
*, ctf_dvdef_t
*);
367 extern void ctf_dvd_delete (ctf_file_t
*, ctf_dvdef_t
*);
368 extern ctf_dvdef_t
*ctf_dvd_lookup (const ctf_file_t
*, const char *);
370 extern void ctf_decl_init (ctf_decl_t
*);
371 extern void ctf_decl_fini (ctf_decl_t
*);
372 extern void ctf_decl_push (ctf_decl_t
*, ctf_file_t
*, ctf_id_t
);
374 _libctf_printflike_ (2, 3)
375 extern void ctf_decl_sprintf (ctf_decl_t
*, const char *, ...);
376 extern char *ctf_decl_buf (ctf_decl_t
*cd
);
378 extern const char *ctf_strraw (ctf_file_t
*, uint32_t);
379 extern const char *ctf_strptr (ctf_file_t
*, uint32_t);
380 extern int ctf_str_create_atoms (ctf_file_t
*);
381 extern void ctf_str_free_atoms (ctf_file_t
*);
382 extern const char *ctf_str_add (ctf_file_t
*, const char *);
383 extern const char *ctf_str_add_ref (ctf_file_t
*, const char *, uint32_t *);
384 extern void ctf_str_rollback (ctf_file_t
*, ctf_snapshot_id_t
);
385 extern void ctf_str_purge_refs (ctf_file_t
*);
386 extern ctf_strs_writable_t
ctf_str_write_strtab (ctf_file_t
*);
388 extern struct ctf_archive
*ctf_arc_open_internal (const char *, int *);
389 extern struct ctf_archive
*ctf_arc_bufopen (const void *, size_t, int *);
390 extern void ctf_arc_close_internal (struct ctf_archive
*);
391 extern void *ctf_set_open_errno (int *, int);
392 extern unsigned long ctf_set_errno (ctf_file_t
*, int);
395 extern void *ctf_mmap (size_t length
, size_t offset
, int fd
);
396 extern void ctf_munmap (void *, size_t);
397 extern ssize_t
ctf_pread (int fd
, void *buf
, ssize_t count
, off_t offset
);
400 extern void *ctf_alloc (size_t);
401 extern void ctf_free (void *);
402 extern void *ctf_realloc (ctf_file_t
*, void *, size_t);
405 extern char *ctf_strdup (const char *);
406 extern char *ctf_str_append (char *, const char *);
407 extern const char *ctf_strerror (int);
409 extern ctf_id_t
ctf_type_resolve_unsliced (ctf_file_t
*, ctf_id_t
);
410 extern int ctf_type_kind_unsliced (ctf_file_t
*, ctf_id_t
);
412 _libctf_printflike_ (1, 2)
413 extern void ctf_dprintf (const char *, ...);
414 extern void libctf_init_debug (void);
416 extern Elf64_Sym
*ctf_sym_to_elf64 (const Elf32_Sym
*src
, Elf64_Sym
*dst
);
417 extern const char *ctf_lookup_symbol_name (ctf_file_t
*fp
, unsigned long symidx
);
419 /* Variables, all underscore-prepended. */
421 extern const char _CTF_SECTION
[]; /* name of CTF ELF section */
422 extern const char _CTF_NULLSTR
[]; /* empty string */
424 extern int _libctf_version
; /* library client version */
425 extern int _libctf_debug
; /* debugging messages enabled */
431 #endif /* _CTF_IMPL_H */