1 /* Implementation header.
2 Copyright (C) 2019-2021 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 <sys/param.h>
26 #include "ctf-decls.h"
29 #include <sys/types.h>
49 /* The proportion of symtypetab entries which must be pads before we consider it
50 worthwhile to emit a symtypetab section as an index. Indexes cost time to
51 look up, but save space all told. Do not set to 1, since this will cause
52 indexes to be eschewed completely, even in child dicts, at considerable space
54 #define CTF_INDEX_PAD_THRESHOLD .75
56 /* Compiler attributes. */
58 #if defined (__GNUC__)
60 /* GCC. We assume that all compilers claiming to be GCC support sufficiently
61 many GCC attributes that the code below works. If some non-GCC compilers
62 masquerading as GCC in fact do not implement these attributes, version checks
65 /* We use the _libctf_*_ pattern to avoid clashes with any future attribute
66 macros glibc may introduce, which have names of the pattern
67 __attribute_blah__. */
69 #define _libctf_printflike_(string_index,first_to_check) \
70 __attribute__ ((__format__ (__printf__, (string_index), (first_to_check))))
71 #define _libctf_unlikely_(x) __builtin_expect ((x), 0)
72 #define _libctf_unused_ __attribute__ ((__unused__))
73 #define _libctf_malloc_ __attribute__((__malloc__))
74 #define _libctf_nonnull_(params) __attribute__((__nonnull__ params))
78 #define _libctf_printflike_(string_index,first_to_check)
79 #define _libctf_unlikely_(x) (x)
80 #define _libctf_unused_
81 #define _libctf_malloc_
82 #define _libctf_nonnull_(params)
87 #if defined (ENABLE_LIBCTF_HASH_DEBUGGING) && !defined (NDEBUG)
89 #define ctf_assert(fp, expr) (assert (expr), 1)
91 #define ctf_assert(fp, expr) \
92 _libctf_unlikely_ (ctf_assert_internal (fp, __FILE__, __LINE__, \
96 /* libctf in-memory state. */
98 typedef struct ctf_fixed_hash ctf_hash_t; /* Private to ctf-hash.c. */
99 typedef struct ctf_dynhash ctf_dynhash_t; /* Private to ctf-hash.c. */
100 typedef struct ctf_dynset ctf_dynset_t; /* Private to ctf-hash.c. */
102 typedef struct ctf_strs
104 const char *cts_strs; /* Base address of string table. */
105 size_t cts_len; /* Size of string table in bytes. */
108 typedef struct ctf_strs_writable
110 char *cts_strs; /* Base address of string table. */
111 size_t cts_len; /* Size of string table in bytes. */
112 } ctf_strs_writable_t;
114 typedef struct ctf_dmodel
116 const char *ctd_name; /* Data model name. */
117 int ctd_code; /* Data model code. */
118 size_t ctd_pointer; /* Size of void * in bytes. */
119 size_t ctd_char; /* Size of char in bytes. */
120 size_t ctd_short; /* Size of short in bytes. */
121 size_t ctd_int; /* Size of int in bytes. */
122 size_t ctd_long; /* Size of long in bytes. */
125 typedef struct ctf_names
127 ctf_hash_t *ctn_readonly; /* Hash table when readonly. */
128 ctf_dynhash_t *ctn_writable; /* Hash table when writable. */
131 typedef struct ctf_lookup
133 const char *ctl_prefix; /* String prefix for this lookup. */
134 size_t ctl_len; /* Length of prefix string in bytes. */
135 ctf_names_t *ctl_hash; /* Pointer to hash table for lookup. */
138 typedef struct ctf_dictops
140 uint32_t (*ctfo_get_kind) (uint32_t);
141 uint32_t (*ctfo_get_root) (uint32_t);
142 uint32_t (*ctfo_get_vlen) (uint32_t);
143 ssize_t (*ctfo_get_ctt_size) (const ctf_dict_t *, const ctf_type_t *,
144 ssize_t *, ssize_t *);
145 ssize_t (*ctfo_get_vbytes) (ctf_dict_t *, unsigned short, ssize_t, size_t);
148 typedef struct ctf_list
150 struct ctf_list *l_prev; /* Previous pointer or tail pointer. */
151 struct ctf_list *l_next; /* Next pointer or head pointer. */
163 typedef struct ctf_decl_node
165 ctf_list_t cd_list; /* Linked list pointers. */
166 ctf_id_t cd_type; /* Type identifier. */
167 uint32_t cd_kind; /* Type kind. */
168 uint32_t cd_n; /* Type dimension if array. */
171 typedef struct ctf_decl
173 ctf_list_t cd_nodes[CTF_PREC_MAX]; /* Declaration node stacks. */
174 int cd_order[CTF_PREC_MAX]; /* Storage order of decls. */
175 ctf_decl_prec_t cd_qualp; /* Qualifier precision. */
176 ctf_decl_prec_t cd_ordp; /* Ordered precision. */
177 char *cd_buf; /* Buffer for output. */
178 int cd_err; /* Saved error value. */
179 int cd_enomem; /* Nonzero if OOM during printing. */
182 typedef struct ctf_dtdef
184 ctf_list_t dtd_list; /* List forward/back pointers. */
185 ctf_id_t dtd_type; /* Type identifier for this definition. */
186 ctf_type_t dtd_data; /* Type node, including name. */
187 size_t dtd_vlen_alloc; /* Total vlen space allocated. */
188 unsigned char *dtd_vlen; /* Variable-length data for this type. */
191 typedef struct ctf_dvdef
193 ctf_list_t dvd_list; /* List forward/back pointers. */
194 char *dvd_name; /* Name associated with variable. */
195 ctf_id_t dvd_type; /* Type of variable. */
196 unsigned long dvd_snapshots; /* Snapshot count when inserted. */
199 typedef struct ctf_err_warning
201 ctf_list_t cew_list; /* List forward/back pointers. */
202 int cew_is_warning; /* 1 if warning, 0 if error. */
203 char *cew_text; /* Error/warning text. */
206 /* Atoms associate strings with a list of the CTF items that reference that
207 string, so that ctf_update() can instantiate all the strings using the
208 ctf_str_atoms and then reassociate them with the real string later.
210 Strings can be interned into ctf_str_atom without having refs associated
211 with them, for values that are returned to callers, etc. Items are only
212 removed from this table on ctf_close(), but on every ctf_update(), all the
213 csa_refs in all entries are purged. */
215 typedef struct ctf_str_atom
217 const char *csa_str; /* Backpointer to string (hash key). */
218 ctf_list_t csa_refs; /* This string's refs. */
219 uint32_t csa_offset; /* Strtab offset, if any. */
220 uint32_t csa_external_offset; /* External strtab offset, if any. */
221 unsigned long csa_snapshot_id; /* Snapshot ID at time of creation. */
224 /* The refs of a single string in the atoms table. */
226 typedef struct ctf_str_atom_ref
228 ctf_list_t caf_list; /* List forward/back pointers. */
229 uint32_t *caf_ref; /* A single ref to this string. */
230 } ctf_str_atom_ref_t;
232 /* A single linker-provided symbol, during symbol addition, possibly before we
233 have been given external strtab refs. */
234 typedef struct ctf_in_flight_dynsym
236 ctf_list_t cid_list; /* List forward/back pointers. */
237 ctf_link_sym_t cid_sym; /* The linker-known symbol. */
238 } ctf_in_flight_dynsym_t;
240 /* The structure used as the key in a ctf_link_type_mapping. The value is a
241 type index, not a type ID. */
243 typedef struct ctf_link_type_key
247 } ctf_link_type_key_t;
249 /* The structure used as the key in a cd_id_to_dict_t on 32-bit platforms. */
250 typedef struct ctf_type_id_key
256 /* Deduplicator state.
258 The dedup state below uses three terms consistently. A "hash" is a
259 ctf_dynhash_t; a "hash value" is the hash value of a type as returned by
260 ctf_dedup_hash_type; a "global type ID" or "global ID" is a packed-together
261 reference to a single ctf_dict_t (by array index in an array of inputs) and
262 ctf_id_t, i.e. a single instance of some hash value in some input.
264 The deduplication algorithm takes a bunch of inputs and yields a single
265 shared "output" and possibly many outputs corresponding to individual inputs
266 that still contain types after sharing of unconflicted types. Almost all
267 deduplicator state is stored in the struct ctf_dedup in the output, though a
268 (very) few things are stored in inputs for simplicity's sake, usually if they
269 are linking together things within the scope of a single TU.
271 Flushed at the end of every ctf_dedup run. */
273 typedef struct ctf_dedup
275 /* The CTF linker flags in force for this dedup run. */
278 /* On 32-bit platforms only, a hash of global type IDs, in the form of
279 a ctf_link_type_id_key_t. */
280 ctf_dynhash_t *cd_id_to_dict_t;
282 /* Atoms tables of decorated names: maps undecorated name to decorated name.
283 (The actual allocations are in the CTF dict for the former and the real
284 atoms table for the latter). Uses the same namespaces as ctf_lookups,
285 below, but has no need for null-termination. */
286 ctf_dynhash_t *cd_decorated_names[4];
288 /* Map type names to a hash from type hash value -> number of times each value
290 ctf_dynhash_t *cd_name_counts;
292 /* Map global type IDs to type hash values. Used to determine if types are
293 already hashed without having to recompute their hash values again, and to
294 link types together at later stages. Forwards that are peeked through to
295 structs and unions are not represented in here, so lookups that might be
296 such a type (in practice, all lookups) must go via cd_replaced_types first
297 to take this into account. Discarded before each rehashing. */
298 ctf_dynhash_t *cd_type_hashes;
300 /* Maps from the names of structs/unions/enums to a a single GID which is the
301 only appearance of that type in any input: if it appears in more than one
302 input, a value which is a GID with an input_num of -1 appears. Used in
303 share-duplicated link mode link modes to determine whether structs/unions
304 can be cited from multiple TUs. Only populated in that link mode. */
305 ctf_dynhash_t *cd_struct_origin;
307 /* Maps type hash values to a set of hash values of the types that cite them:
308 i.e., pointing backwards up the type graph. Used for recursive conflict
309 marking. Citations from tagged structures, unions, and forwards do not
310 appear in this graph. */
311 ctf_dynhash_t *cd_citers;
313 /* Maps type hash values to input global type IDs. The value is a set (a
314 hash) of global type IDs. Discarded before each rehashing. The result of
315 the ctf_dedup function. */
316 ctf_dynhash_t *cd_output_mapping;
318 /* A map giving the GID of the first appearance of each type for each type
320 ctf_dynhash_t *cd_output_first_gid;
322 /* Used to ensure that we never try to map a single type ID to more than one
324 ctf_dynhash_t *cd_output_mapping_guard;
326 /* Maps the global type IDs of structures in input TUs whose members still
327 need emission to the global type ID of the already-emitted target type
328 (which has no members yet) in the appropriate target. Uniquely, the latter
329 ID represents a *target* ID (i.e. the cd_output_mapping of some specified
330 input): we encode the shared (parent) dict with an ID of -1. */
331 ctf_dynhash_t *cd_emission_struct_members;
333 /* A set (a hash) of hash values of conflicting types. */
334 ctf_dynset_t *cd_conflicting_types;
336 /* A hash mapping fp *'s of inputs to their input_nums. Used only by
337 functions outside the core ctf_dedup / ctf_dedup_emit machinery which do
338 not take an inputs array. */
339 ctf_dynhash_t *cd_input_nums;
341 /* Maps type hashes to ctf_id_t's in this dictionary. Populated only at
342 emission time, in the dictionary where emission is taking place. */
343 ctf_dynhash_t *cd_output_emission_hashes;
345 /* Maps the decorated names of conflicted cross-TU forwards that were forcibly
346 emitted in this TU to their emitted ctf_id_ts. Populated only at emission
347 time, in the dictionary where emission is taking place. */
348 ctf_dynhash_t *cd_output_emission_conflicted_forwards;
350 /* Points to the output counterpart of this input dictionary, at emission
352 ctf_dict_t *cd_output;
355 /* The ctf_dict is the structure used to represent a CTF dictionary to library
356 clients, who see it only as an opaque pointer. Modifications can therefore
357 be made freely to this structure without regard to client versioning. The
358 ctf_dict_t typedef appears in <ctf-api.h> and declares a forward tag.
359 (A ctf_file_t typedef also appears there, for historical reasons.)
361 NOTE: ctf_serialize requires that everything inside of ctf_dict either be an
362 immediate value, a pointer to dynamically allocated data *outside* of the
363 ctf_dict itself, a pointer to statically allocated data, or specially handled
364 in ctf_serialize. If you add a pointer to ctf_dict that points to something
365 within the ctf_dict itself, you must make corresponding changes to
370 const ctf_dictops_t *ctf_dictops; /* Version-specific dict operations. */
371 struct ctf_header *ctf_header; /* The header from this CTF dict. */
372 unsigned char ctf_openflags; /* Flags the dict had when opened. */
373 ctf_sect_t ctf_data; /* CTF data from object file. */
374 ctf_sect_t ctf_symtab; /* Symbol table from object file. */
375 ctf_sect_t ctf_strtab; /* String table from object file. */
376 int ctf_symsect_little_endian; /* Endianness of the ctf_symtab. */
377 ctf_dynhash_t *ctf_symhash; /* (partial) hash, symsect name -> idx. */
378 size_t ctf_symhash_latest; /* Amount of symsect scanned so far. */
379 ctf_dynhash_t *ctf_prov_strtab; /* Maps provisional-strtab offsets
381 ctf_dynhash_t *ctf_syn_ext_strtab; /* Maps ext-strtab offsets to names. */
382 void *ctf_data_mmapped; /* CTF data we mmapped, to free later. */
383 size_t ctf_data_mmapped_len; /* Length of CTF data we mmapped. */
384 ctf_names_t ctf_structs; /* Hash table of struct types. */
385 ctf_names_t ctf_unions; /* Hash table of union types. */
386 ctf_names_t ctf_enums; /* Hash table of enum types. */
387 ctf_names_t ctf_names; /* Hash table of remaining type names. */
388 ctf_lookup_t ctf_lookups[5]; /* Pointers to nametabs for name lookup. */
389 ctf_strs_t ctf_str[2]; /* Array of string table base and bounds. */
390 ctf_dynhash_t *ctf_str_atoms; /* Hash table of ctf_str_atoms_t. */
391 ctf_dynset_t *ctf_str_pending_ref; /* Locations awaiting ref addition. */
392 uint64_t ctf_str_num_refs; /* Number of refs to cts_str_atoms. */
393 uint32_t ctf_str_prov_offset; /* Latest provisional offset assigned so far. */
394 unsigned char *ctf_base; /* CTF file pointer. */
395 unsigned char *ctf_dynbase; /* Freeable CTF file pointer. */
396 unsigned char *ctf_buf; /* Uncompressed CTF data buffer. */
397 size_t ctf_size; /* Size of CTF header + uncompressed data. */
398 uint32_t *ctf_sxlate; /* Translation table for unindexed symtypetab
400 unsigned long ctf_nsyms; /* Number of entries in symtab xlate table. */
401 uint32_t *ctf_txlate; /* Translation table for type IDs. */
402 uint32_t *ctf_ptrtab; /* Translation table for pointer-to lookups. */
403 size_t ctf_ptrtab_len; /* Num types storable in ptrtab currently. */
404 uint32_t *ctf_pptrtab; /* Parent types pointed to by child dicts. */
405 size_t ctf_pptrtab_len; /* Num types storable in pptrtab currently. */
406 uint32_t ctf_pptrtab_typemax; /* Max child type when pptrtab last updated. */
407 uint32_t *ctf_funcidx_names; /* Name of each function symbol in symtypetab
409 uint32_t *ctf_objtidx_names; /* Likewise, for object symbols. */
410 size_t ctf_nfuncidx; /* Number of funcidx entries. */
411 uint32_t *ctf_funcidx_sxlate; /* Offsets into funcinfo for a given funcidx. */
412 uint32_t *ctf_objtidx_sxlate; /* Likewise, for ctf_objtidx. */
413 size_t ctf_nobjtidx; /* Number of objtidx entries. */
414 ctf_dynhash_t *ctf_objthash; /* name -> type ID. */
415 ctf_dynhash_t *ctf_funchash; /* name -> CTF_K_FUNCTION type ID. */
417 /* The next three are linker-derived state found in ctf_link targets only. */
419 ctf_dynhash_t *ctf_dynsyms; /* Symbol info from ctf_link_shuffle_syms. */
420 ctf_link_sym_t **ctf_dynsymidx; /* Indexes ctf_dynsyms by symidx. */
421 uint32_t ctf_dynsymmax; /* Maximum ctf_dynsym index. */
422 ctf_list_t ctf_in_flight_dynsyms; /* Dynsyms during accumulation. */
423 struct ctf_varent *ctf_vars; /* Sorted variable->type mapping. */
424 unsigned long ctf_nvars; /* Number of variables in ctf_vars. */
425 unsigned long ctf_typemax; /* Maximum valid type ID number. */
426 const ctf_dmodel_t *ctf_dmodel; /* Data model pointer (see above). */
427 const char *ctf_cuname; /* Compilation unit name (if any). */
428 char *ctf_dyncuname; /* Dynamically allocated name of CU. */
429 struct ctf_dict *ctf_parent; /* Parent CTF dict (if any). */
430 int ctf_parent_unreffed; /* Parent set by ctf_import_unref? */
431 const char *ctf_parlabel; /* Label in parent dict (if any). */
432 const char *ctf_parname; /* Basename of parent (if any). */
433 char *ctf_dynparname; /* Dynamically allocated name of parent. */
434 uint32_t ctf_parmax; /* Highest type ID of a parent type. */
435 uint32_t ctf_refcnt; /* Reference count (for parent links). */
436 uint32_t ctf_flags; /* Libctf flags (see below). */
437 int ctf_errno; /* Error code for most recent error. */
438 int ctf_version; /* CTF data version. */
439 ctf_dynhash_t *ctf_dthash; /* Hash of dynamic type definitions. */
440 ctf_list_t ctf_dtdefs; /* List of dynamic type definitions. */
441 ctf_dynhash_t *ctf_dvhash; /* Hash of dynamic variable mappings. */
442 ctf_list_t ctf_dvdefs; /* List of dynamic variable definitions. */
443 unsigned long ctf_dtoldid; /* Oldest id that has been committed. */
444 unsigned long ctf_snapshots; /* ctf_snapshot() plus ctf_update() count. */
445 unsigned long ctf_snapshot_lu; /* ctf_snapshot() call count at last update. */
446 ctf_archive_t *ctf_archive; /* Archive this ctf_dict_t came from. */
447 ctf_list_t ctf_errs_warnings; /* CTF errors and warnings. */
448 ctf_dynhash_t *ctf_link_inputs; /* Inputs to this link. */
449 ctf_dynhash_t *ctf_link_outputs; /* Additional outputs from this link. */
451 /* Map input types to output types for ctf_add_type. Key is a
452 ctf_link_type_key_t: value is a type ID. */
453 ctf_dynhash_t *ctf_link_type_mapping;
455 /* Map input CU names to output CTF dict names: populated in the top-level
458 Key and value are dynamically-allocated strings. */
459 ctf_dynhash_t *ctf_link_in_cu_mapping;
461 /* Map output CTF dict names to input CU names: populated in the top-level
462 output dict. A hash of string to hash (set) of strings. Key and
463 individual value members are shared with ctf_link_in_cu_mapping. */
464 ctf_dynhash_t *ctf_link_out_cu_mapping;
466 /* CTF linker flags. Set on the parent output dict (the one passed to
467 ctf_link). Only respected when LCTF_LINKING set in ctf_flags. */
470 /* Allow the caller to change the name of link archive members. */
471 ctf_link_memb_name_changer_f *ctf_link_memb_name_changer;
472 void *ctf_link_memb_name_changer_arg; /* Argument for it. */
474 /* Allow the caller to filter out variables they don't care about. */
475 ctf_link_variable_filter_f *ctf_link_variable_filter;
476 void *ctf_link_variable_filter_arg; /* Argument for it. */
478 ctf_dynhash_t *ctf_add_processing; /* Types ctf_add_type is working on now. */
480 /* Atoms table for dedup string storage. All strings in the ctf_dedup_t are
481 stored here. Only the _alloc copy is allocated or freed: the
482 ctf_dedup_atoms may be pointed to some other CTF dict, to share its atoms.
483 We keep the atoms table outside the ctf_dedup so that atoms can be
484 preserved across multiple similar links, such as when doing cu-mapped
486 ctf_dynset_t *ctf_dedup_atoms;
487 ctf_dynset_t *ctf_dedup_atoms_alloc;
489 ctf_dedup_t ctf_dedup; /* Deduplicator state. */
491 char *ctf_tmp_typeslice; /* Storage for slicing up type names. */
492 size_t ctf_tmp_typeslicelen; /* Size of the typeslice. */
493 void *ctf_specific; /* Data for ctf_get/setspecific(). */
496 /* An abstraction over both a ctf_dict_t and a ctf_archive_t. */
498 struct ctf_archive_internal
501 int ctfi_unmap_on_close;
502 ctf_dict_t *ctfi_dict;
503 struct ctf_archive *ctfi_archive;
504 ctf_dynhash_t *ctfi_dicts; /* Dicts we have opened and cached. */
505 ctf_dict_t *ctfi_crossdict_cache; /* Cross-dict caching. */
506 ctf_dict_t **ctfi_symdicts; /* Array of index -> ctf_dict_t *. */
507 ctf_dynhash_t *ctfi_symnamedicts; /* Hash of name -> ctf_dict_t *. */
508 ctf_sect_t ctfi_symsect;
509 int ctfi_symsect_little_endian; /* -1 for unknown / do not set. */
510 ctf_sect_t ctfi_strsect;
511 int ctfi_free_symsect;
512 int ctfi_free_strsect;
514 bfd *ctfi_abfd; /* Optional source of section data. */
515 void (*ctfi_bfd_close) (struct ctf_archive_internal *);
518 /* Iterator state for the *_next() functions. */
520 /* A single hash key/value pair. */
521 typedef struct ctf_next_hkv
529 void (*ctn_iter_fun) (void);
532 ssize_t ctn_increment;
535 /* Some iterators contain other iterators, in addition to their other
537 ctf_next_t *ctn_next;
539 /* We can save space on this side of things by noting that a dictionary is
540 either dynamic or not, as a whole, and a given iterator can only iterate
541 over one kind of thing at once: so we can overlap the DTD and non-DTD
542 members, and the structure, variable and enum members, etc. */
545 const ctf_member_t *ctn_mp;
546 const ctf_lmember_t *ctn_lmp;
547 const ctf_enum_t *ctn_en;
548 const ctf_dvdef_t *ctn_dvd;
549 ctf_next_hkv_t *ctn_sorted_hkv;
550 void **ctn_hash_slot;
553 /* This union is of various sorts of dict we can iterate over:
554 currently dictionaries and archives, dynhashes, and dynsets. */
557 const ctf_dict_t *ctn_fp;
558 const ctf_archive_t *ctn_arc;
559 const ctf_dynhash_t *ctn_h;
560 const ctf_dynset_t *ctn_s;
564 /* Return x rounded up to an alignment boundary.
565 eg, P2ROUNDUP(0x1234, 0x100) == 0x1300 (0x13*align)
566 eg, P2ROUNDUP(0x5600, 0x100) == 0x5600 (0x56*align) */
567 #define P2ROUNDUP(x, align) (-(-(x) & -(align)))
569 /* * If an offs is not aligned already then round it up and align it. */
570 #define LCTF_ALIGN_OFFS(offs, align) ((offs + (align - 1)) & ~(align - 1))
572 #define LCTF_TYPE_ISPARENT(fp, id) ((id) <= fp->ctf_parmax)
573 #define LCTF_TYPE_ISCHILD(fp, id) ((id) > fp->ctf_parmax)
574 #define LCTF_TYPE_TO_INDEX(fp, id) ((id) & (fp->ctf_parmax))
575 #define LCTF_INDEX_TO_TYPE(fp, id, child) (child ? ((id) | (fp->ctf_parmax+1)) : \
578 #define LCTF_INDEX_TO_TYPEPTR(fp, i) \
579 ((fp->ctf_flags & LCTF_RDWR) ? \
580 &(ctf_dtd_lookup (fp, LCTF_INDEX_TO_TYPE \
581 (fp, i, fp->ctf_flags & LCTF_CHILD))->dtd_data) : \
582 (ctf_type_t *)((uintptr_t)(fp)->ctf_buf + (fp)->ctf_txlate[(i)]))
584 #define LCTF_INFO_KIND(fp, info) ((fp)->ctf_dictops->ctfo_get_kind(info))
585 #define LCTF_INFO_ISROOT(fp, info) ((fp)->ctf_dictops->ctfo_get_root(info))
586 #define LCTF_INFO_VLEN(fp, info) ((fp)->ctf_dictops->ctfo_get_vlen(info))
587 #define LCTF_VBYTES(fp, kind, size, vlen) \
588 ((fp)->ctf_dictops->ctfo_get_vbytes(fp, kind, size, vlen))
590 #define LCTF_CHILD 0x0001 /* CTF dict is a child. */
591 #define LCTF_RDWR 0x0002 /* CTF dict is writable. */
592 #define LCTF_DIRTY 0x0004 /* CTF dict has been modified. */
593 #define LCTF_LINKING 0x0008 /* CTF link is underway: respect ctf_link_flags. */
595 extern ctf_names_t *ctf_name_table (ctf_dict_t *, int);
596 extern const ctf_type_t *ctf_lookup_by_id (ctf_dict_t **, ctf_id_t);
597 extern ctf_id_t ctf_lookup_by_rawname (ctf_dict_t *, int, const char *);
598 extern ctf_id_t ctf_lookup_by_rawhash (ctf_dict_t *, ctf_names_t *, const char *);
599 extern void ctf_set_ctl_hashes (ctf_dict_t *);
601 extern int ctf_symtab_skippable (ctf_link_sym_t *sym);
602 extern int ctf_add_funcobjt_sym (ctf_dict_t *, int is_function,
603 const char *, ctf_id_t);
605 extern ctf_dict_t *ctf_get_dict (ctf_dict_t *fp, ctf_id_t type);
607 typedef unsigned int (*ctf_hash_fun) (const void *ptr);
608 extern unsigned int ctf_hash_integer (const void *ptr);
609 extern unsigned int ctf_hash_string (const void *ptr);
610 extern unsigned int ctf_hash_type_key (const void *ptr);
611 extern unsigned int ctf_hash_type_id_key (const void *ptr);
613 typedef int (*ctf_hash_eq_fun) (const void *, const void *);
614 extern int ctf_hash_eq_integer (const void *, const void *);
615 extern int ctf_hash_eq_string (const void *, const void *);
616 extern int ctf_hash_eq_type_key (const void *, const void *);
617 extern int ctf_hash_eq_type_id_key (const void *, const void *);
619 extern int ctf_dynset_eq_string (const void *, const void *);
621 typedef void (*ctf_hash_free_fun) (void *);
623 typedef void (*ctf_hash_iter_f) (void *key, void *value, void *arg);
624 typedef int (*ctf_hash_iter_remove_f) (void *key, void *value, void *arg);
625 typedef int (*ctf_hash_iter_find_f) (void *key, void *value, void *arg);
626 typedef int (*ctf_hash_sort_f) (const ctf_next_hkv_t *, const ctf_next_hkv_t *,
629 extern ctf_hash_t *ctf_hash_create (unsigned long, ctf_hash_fun, ctf_hash_eq_fun);
630 extern int ctf_hash_insert_type (ctf_hash_t *, ctf_dict_t *, uint32_t, uint32_t);
631 extern int ctf_hash_define_type (ctf_hash_t *, ctf_dict_t *, uint32_t, uint32_t);
632 extern ctf_id_t ctf_hash_lookup_type (ctf_hash_t *, ctf_dict_t *, const char *);
633 extern uint32_t ctf_hash_size (const ctf_hash_t *);
634 extern void ctf_hash_destroy (ctf_hash_t *);
636 extern ctf_dynhash_t *ctf_dynhash_create (ctf_hash_fun, ctf_hash_eq_fun,
637 ctf_hash_free_fun, ctf_hash_free_fun);
638 extern int ctf_dynhash_insert (ctf_dynhash_t *, void *, void *);
639 extern void ctf_dynhash_remove (ctf_dynhash_t *, const void *);
640 extern size_t ctf_dynhash_elements (ctf_dynhash_t *);
641 extern void ctf_dynhash_empty (ctf_dynhash_t *);
642 extern void *ctf_dynhash_lookup (ctf_dynhash_t *, const void *);
643 extern int ctf_dynhash_lookup_kv (ctf_dynhash_t *, const void *key,
644 const void **orig_key, void **value);
645 extern void ctf_dynhash_destroy (ctf_dynhash_t *);
646 extern void ctf_dynhash_iter (ctf_dynhash_t *, ctf_hash_iter_f, void *);
647 extern void ctf_dynhash_iter_remove (ctf_dynhash_t *, ctf_hash_iter_remove_f,
649 extern void *ctf_dynhash_iter_find (ctf_dynhash_t *, ctf_hash_iter_find_f,
651 extern int ctf_dynhash_sort_by_name (const ctf_next_hkv_t *,
652 const ctf_next_hkv_t *,
653 void * _libctf_unused_);
654 extern int ctf_dynhash_next (ctf_dynhash_t *, ctf_next_t **,
655 void **key, void **value);
656 extern int ctf_dynhash_next_sorted (ctf_dynhash_t *, ctf_next_t **,
657 void **key, void **value, ctf_hash_sort_f,
660 extern ctf_dynset_t *ctf_dynset_create (htab_hash, htab_eq, ctf_hash_free_fun);
661 extern int ctf_dynset_insert (ctf_dynset_t *, void *);
662 extern void ctf_dynset_remove (ctf_dynset_t *, const void *);
663 extern void ctf_dynset_destroy (ctf_dynset_t *);
664 extern void *ctf_dynset_lookup (ctf_dynset_t *, const void *);
665 extern size_t ctf_dynset_elements (ctf_dynset_t *);
666 extern int ctf_dynset_exists (ctf_dynset_t *, const void *key,
667 const void **orig_key);
668 extern int ctf_dynset_next (ctf_dynset_t *, ctf_next_t **, void **key);
669 extern void *ctf_dynset_lookup_any (ctf_dynset_t *);
671 extern void ctf_sha1_init (ctf_sha1_t *);
672 extern void ctf_sha1_add (ctf_sha1_t *, const void *, size_t);
673 extern char *ctf_sha1_fini (ctf_sha1_t *, char *);
675 #define ctf_list_prev(elem) ((void *)(((ctf_list_t *)(elem))->l_prev))
676 #define ctf_list_next(elem) ((void *)(((ctf_list_t *)(elem))->l_next))
678 extern void ctf_list_append (ctf_list_t *, void *);
679 extern void ctf_list_prepend (ctf_list_t *, void *);
680 extern void ctf_list_delete (ctf_list_t *, void *);
681 extern void ctf_list_splice (ctf_list_t *, ctf_list_t *);
682 extern int ctf_list_empty_p (ctf_list_t *lp);
684 extern int ctf_dtd_insert (ctf_dict_t *, ctf_dtdef_t *, int flag, int kind);
685 extern void ctf_dtd_delete (ctf_dict_t *, ctf_dtdef_t *);
686 extern ctf_dtdef_t *ctf_dtd_lookup (const ctf_dict_t *, ctf_id_t);
687 extern ctf_dtdef_t *ctf_dynamic_type (const ctf_dict_t *, ctf_id_t);
689 extern int ctf_dvd_insert (ctf_dict_t *, ctf_dvdef_t *);
690 extern void ctf_dvd_delete (ctf_dict_t *, ctf_dvdef_t *);
691 extern ctf_dvdef_t *ctf_dvd_lookup (const ctf_dict_t *, const char *);
693 extern ctf_id_t ctf_add_encoded (ctf_dict_t *, uint32_t, const char *,
694 const ctf_encoding_t *, uint32_t kind);
695 extern ctf_id_t ctf_add_reftype (ctf_dict_t *, uint32_t, ctf_id_t,
698 extern int ctf_dedup_atoms_init (ctf_dict_t *);
699 extern int ctf_dedup (ctf_dict_t *, ctf_dict_t **, uint32_t ninputs,
700 uint32_t *parents, int cu_mapped);
701 extern void ctf_dedup_fini (ctf_dict_t *, ctf_dict_t **, uint32_t);
702 extern ctf_dict_t **ctf_dedup_emit (ctf_dict_t *, ctf_dict_t **,
703 uint32_t ninputs, uint32_t *parents,
704 uint32_t *noutputs, int cu_mapped);
705 extern ctf_id_t ctf_dedup_type_mapping (ctf_dict_t *fp, ctf_dict_t *src_fp,
708 extern void ctf_decl_init (ctf_decl_t *);
709 extern void ctf_decl_fini (ctf_decl_t *);
710 extern void ctf_decl_push (ctf_decl_t *, ctf_dict_t *, ctf_id_t);
712 _libctf_printflike_ (2, 3)
713 extern void ctf_decl_sprintf (ctf_decl_t *, const char *, ...);
714 extern char *ctf_decl_buf (ctf_decl_t *cd);
716 extern const char *ctf_strptr (ctf_dict_t *, uint32_t);
717 extern const char *ctf_strraw (ctf_dict_t *, uint32_t);
718 extern const char *ctf_strraw_explicit (ctf_dict_t *, uint32_t,
720 extern int ctf_str_create_atoms (ctf_dict_t *);
721 extern void ctf_str_free_atoms (ctf_dict_t *);
722 extern uint32_t ctf_str_add (ctf_dict_t *, const char *);
723 extern uint32_t ctf_str_add_ref (ctf_dict_t *, const char *, uint32_t *ref);
724 extern uint32_t ctf_str_add_pending (ctf_dict_t *, const char *, uint32_t *);
725 extern int ctf_str_move_pending (ctf_dict_t *, uint32_t *, ptrdiff_t);
726 extern int ctf_str_add_external (ctf_dict_t *, const char *, uint32_t offset);
727 extern void ctf_str_remove_ref (ctf_dict_t *, const char *, uint32_t *ref);
728 extern void ctf_str_rollback (ctf_dict_t *, ctf_snapshot_id_t);
729 extern void ctf_str_purge_refs (ctf_dict_t *);
730 extern ctf_strs_writable_t ctf_str_write_strtab (ctf_dict_t *);
732 extern struct ctf_archive_internal *
733 ctf_new_archive_internal (int is_archive, int unmap_on_close,
734 struct ctf_archive *, ctf_dict_t *,
735 const ctf_sect_t *symsect,
736 const ctf_sect_t *strsect, int *errp);
737 extern struct ctf_archive *ctf_arc_open_internal (const char *, int *);
738 extern void ctf_arc_close_internal (struct ctf_archive *);
739 extern const ctf_preamble_t *ctf_arc_bufpreamble (const ctf_sect_t *);
740 extern void *ctf_set_open_errno (int *, int);
741 extern unsigned long ctf_set_errno (ctf_dict_t *, int);
743 extern ctf_dict_t *ctf_simple_open_internal (const char *, size_t, const char *,
745 const char *, size_t,
746 ctf_dynhash_t *, int, int *);
747 extern ctf_dict_t *ctf_bufopen_internal (const ctf_sect_t *, const ctf_sect_t *,
748 const ctf_sect_t *, ctf_dynhash_t *,
750 extern int ctf_import_unref (ctf_dict_t *fp, ctf_dict_t *pfp);
751 extern int ctf_serialize (ctf_dict_t *);
754 extern void *ctf_mmap (size_t length, size_t offset, int fd);
755 extern void ctf_munmap (void *, size_t);
756 extern ssize_t ctf_pread (int fd, void *buf, ssize_t count, off_t offset);
758 extern void *ctf_realloc (ctf_dict_t *, void *, size_t);
759 extern char *ctf_str_append (char *, const char *);
760 extern char *ctf_str_append_noerr (char *, const char *);
762 extern ctf_id_t ctf_type_resolve_unsliced (ctf_dict_t *, ctf_id_t);
763 extern int ctf_type_kind_unsliced (ctf_dict_t *, ctf_id_t);
765 _libctf_printflike_ (1, 2)
766 extern void ctf_dprintf (const char *, ...);
767 extern void libctf_init_debug (void);
769 _libctf_printflike_ (4, 5)
770 extern void ctf_err_warn (ctf_dict_t *, int is_warning, int err,
772 extern void ctf_err_warn_to_open (ctf_dict_t *);
773 extern void ctf_assert_fail_internal (ctf_dict_t *, const char *,
774 size_t, const char *);
775 extern const char *ctf_link_input_name (ctf_dict_t *);
777 extern ctf_link_sym_t *ctf_elf32_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
778 const Elf32_Sym *src, uint32_t symidx);
779 extern ctf_link_sym_t *ctf_elf64_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
780 const Elf64_Sym *src, uint32_t symidx);
782 /* Variables, all underscore-prepended. */
784 extern const char _CTF_SECTION[]; /* name of CTF ELF section */
785 extern const char _CTF_NULLSTR[]; /* empty string */
787 extern int _libctf_version; /* library client version */
788 extern int _libctf_debug; /* debugging messages enabled */
790 #include "ctf-inlines.h"
796 #endif /* _CTF_IMPL_H */
projects / binutils.git / blob