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/>. */
23 #include <sys/types.h>
29 static const ctf_dmodel_t _libctf_models
[] = {
30 {"ILP32", CTF_MODEL_ILP32
, 4, 1, 2, 4, 4},
31 {"LP64", CTF_MODEL_LP64
, 8, 1, 2, 4, 8},
32 {NULL
, 0, 0, 0, 0, 0, 0}
35 const char _CTF_SECTION
[] = ".ctf";
36 const char _CTF_NULLSTR
[] = "";
38 /* Version-sensitive accessors. */
41 get_kind_v1 (uint32_t info
)
43 return (CTF_V1_INFO_KIND (info
));
47 get_root_v1 (uint32_t info
)
49 return (CTF_V1_INFO_ISROOT (info
));
53 get_vlen_v1 (uint32_t info
)
55 return (CTF_V1_INFO_VLEN (info
));
59 get_kind_v2 (uint32_t info
)
61 return (CTF_V2_INFO_KIND (info
));
65 get_root_v2 (uint32_t info
)
67 return (CTF_V2_INFO_ISROOT (info
));
71 get_vlen_v2 (uint32_t info
)
73 return (CTF_V2_INFO_VLEN (info
));
77 get_ctt_size_common (const ctf_dict_t
*fp _libctf_unused_
,
78 const ctf_type_t
*tp _libctf_unused_
,
79 ssize_t
*sizep
, ssize_t
*incrementp
, size_t lsize
,
80 size_t csize
, size_t ctf_type_size
,
81 size_t ctf_stype_size
, size_t ctf_lsize_sent
)
83 ssize_t size
, increment
;
85 if (csize
== ctf_lsize_sent
)
88 increment
= ctf_type_size
;
93 increment
= ctf_stype_size
;
99 *incrementp
= increment
;
105 get_ctt_size_v1 (const ctf_dict_t
*fp
, const ctf_type_t
*tp
,
106 ssize_t
*sizep
, ssize_t
*incrementp
)
108 ctf_type_v1_t
*t1p
= (ctf_type_v1_t
*) tp
;
110 return (get_ctt_size_common (fp
, tp
, sizep
, incrementp
,
111 CTF_TYPE_LSIZE (t1p
), t1p
->ctt_size
,
112 sizeof (ctf_type_v1_t
), sizeof (ctf_stype_v1_t
),
116 /* Return the size that a v1 will be once it is converted to v2. */
119 get_ctt_size_v2_unconverted (const ctf_dict_t
*fp
, const ctf_type_t
*tp
,
120 ssize_t
*sizep
, ssize_t
*incrementp
)
122 ctf_type_v1_t
*t1p
= (ctf_type_v1_t
*) tp
;
124 return (get_ctt_size_common (fp
, tp
, sizep
, incrementp
,
125 CTF_TYPE_LSIZE (t1p
), t1p
->ctt_size
,
126 sizeof (ctf_type_t
), sizeof (ctf_stype_t
),
131 get_ctt_size_v2 (const ctf_dict_t
*fp
, const ctf_type_t
*tp
,
132 ssize_t
*sizep
, ssize_t
*incrementp
)
134 return (get_ctt_size_common (fp
, tp
, sizep
, incrementp
,
135 CTF_TYPE_LSIZE (tp
), tp
->ctt_size
,
136 sizeof (ctf_type_t
), sizeof (ctf_stype_t
),
141 get_vbytes_common (ctf_dict_t
*fp
, unsigned short kind
,
142 ssize_t size _libctf_unused_
, size_t vlen
)
148 return (sizeof (uint32_t));
150 return (sizeof (ctf_slice_t
));
152 return (sizeof (ctf_enum_t
) * vlen
);
162 ctf_set_errno (fp
, ECTF_CORRUPT
);
163 ctf_err_warn (fp
, 0, 0, _("detected invalid CTF kind: %x"), kind
);
169 get_vbytes_v1 (ctf_dict_t
*fp
, unsigned short kind
, ssize_t size
, size_t vlen
)
174 return (sizeof (ctf_array_v1_t
));
176 return (sizeof (unsigned short) * (vlen
+ (vlen
& 1)));
179 if (size
< CTF_LSTRUCT_THRESH_V1
)
180 return (sizeof (ctf_member_v1_t
) * vlen
);
182 return (sizeof (ctf_lmember_v1_t
) * vlen
);
185 return (get_vbytes_common (fp
, kind
, size
, vlen
));
189 get_vbytes_v2 (ctf_dict_t
*fp
, unsigned short kind
, ssize_t size
, size_t vlen
)
194 return (sizeof (ctf_array_t
));
196 return (sizeof (uint32_t) * (vlen
+ (vlen
& 1)));
199 if (size
< CTF_LSTRUCT_THRESH
)
200 return (sizeof (ctf_member_t
) * vlen
);
202 return (sizeof (ctf_lmember_t
) * vlen
);
205 return (get_vbytes_common (fp
, kind
, size
, vlen
));
208 static const ctf_dictops_t ctf_dictops
[] = {
209 {NULL
, NULL
, NULL
, NULL
, NULL
},
211 {get_kind_v1
, get_root_v1
, get_vlen_v1
, get_ctt_size_v1
, get_vbytes_v1
},
212 /* CTF_VERSION_1_UPGRADED_3 */
213 {get_kind_v2
, get_root_v2
, get_vlen_v2
, get_ctt_size_v2
, get_vbytes_v2
},
215 {get_kind_v2
, get_root_v2
, get_vlen_v2
, get_ctt_size_v2
, get_vbytes_v2
},
216 /* CTF_VERSION_3, identical to 2: only new type kinds */
217 {get_kind_v2
, get_root_v2
, get_vlen_v2
, get_ctt_size_v2
, get_vbytes_v2
},
220 /* Initialize the symtab translation table as appropriate for its indexing
221 state. For unindexed symtypetabs, fill each entry with the offset of the CTF
222 type or function data corresponding to each STT_FUNC or STT_OBJECT entry in
223 the symbol table. For indexed symtypetabs, do nothing: the needed
224 initialization for indexed lookups may be quite expensive, so it is done only
225 as needed, when lookups happen. (In particular, the majority of indexed
226 symtypetabs come from the compiler, and all the linker does is iteration over
227 all entries, which doesn't need this initialization.)
229 The SP symbol table section may be NULL if there is no symtab.
231 If init_symtab works on one call, it cannot fail on future calls to the same
232 fp: ctf_symsect_endianness relies on this. */
235 init_symtab (ctf_dict_t
*fp
, const ctf_header_t
*hp
, const ctf_sect_t
*sp
)
237 const unsigned char *symp
;
238 int skip_func_info
= 0;
240 uint32_t *xp
= fp
->ctf_sxlate
;
241 uint32_t *xend
= xp
+ fp
->ctf_nsyms
;
243 uint32_t objtoff
= hp
->cth_objtoff
;
244 uint32_t funcoff
= hp
->cth_funcoff
;
246 /* If the CTF_F_NEWFUNCINFO flag is not set, pretend the func info section
247 is empty: this compiler is too old to emit a function info section we
250 if (!(hp
->cth_flags
& CTF_F_NEWFUNCINFO
))
253 if (hp
->cth_objtidxoff
< hp
->cth_funcidxoff
)
254 fp
->ctf_objtidx_names
= (uint32_t *) (fp
->ctf_buf
+ hp
->cth_objtidxoff
);
255 if (hp
->cth_funcidxoff
< hp
->cth_varoff
&& !skip_func_info
)
256 fp
->ctf_funcidx_names
= (uint32_t *) (fp
->ctf_buf
+ hp
->cth_funcidxoff
);
258 /* Don't bother doing the rest if everything is indexed, or if we don't have a
259 symbol table: we will never use it. */
260 if ((fp
->ctf_objtidx_names
&& fp
->ctf_funcidx_names
) || !sp
|| !sp
->cts_data
)
263 /* The CTF data object and function type sections are ordered to match the
264 relative order of the respective symbol types in the symtab, unless there
265 is an index section, in which case the order is arbitrary and the index
266 gives the mapping. If no type information is available for a symbol table
267 entry, a pad is inserted in the CTF section. As a further optimization,
268 anonymous or undefined symbols are omitted from the CTF data. If an
269 index is available for function symbols but not object symbols, or vice
270 versa, we populate the xslate table for the unindexed symbols only. */
272 for (i
= 0, symp
= sp
->cts_data
; xp
< xend
; xp
++, symp
+= sp
->cts_entsize
,
277 switch (sp
->cts_entsize
)
279 case sizeof (Elf64_Sym
):
281 const Elf64_Sym
*symp64
= (Elf64_Sym
*) (uintptr_t) symp
;
282 ctf_elf64_to_link_sym (fp
, &sym
, symp64
, i
);
285 case sizeof (Elf32_Sym
):
287 const Elf32_Sym
*symp32
= (Elf32_Sym
*) (uintptr_t) symp
;
288 ctf_elf32_to_link_sym (fp
, &sym
, symp32
, i
);
295 /* This call may be led astray if our idea of the symtab's endianness is
296 wrong, but when this is fixed by a call to ctf_symsect_endianness,
297 init_symtab will be called again with the right endianness in
299 if (ctf_symtab_skippable (&sym
))
308 if (fp
->ctf_objtidx_names
|| objtoff
>= hp
->cth_funcoff
)
315 objtoff
+= sizeof (uint32_t);
319 if (fp
->ctf_funcidx_names
|| funcoff
>= hp
->cth_objtidxoff
327 funcoff
+= sizeof (uint32_t);
336 ctf_dprintf ("loaded %lu symtab entries\n", fp
->ctf_nsyms
);
340 /* Reset the CTF base pointer and derive the buf pointer from it, initializing
341 everything in the ctf_dict that depends on the base or buf pointers.
343 The original gap between the buf and base pointers, if any -- the original,
344 unconverted CTF header -- is kept, but its contents are not specified and are
348 ctf_set_base (ctf_dict_t
*fp
, const ctf_header_t
*hp
, unsigned char *base
)
350 fp
->ctf_buf
= base
+ (fp
->ctf_buf
- fp
->ctf_base
);
352 fp
->ctf_vars
= (ctf_varent_t
*) ((const char *) fp
->ctf_buf
+
354 fp
->ctf_nvars
= (hp
->cth_typeoff
- hp
->cth_varoff
) / sizeof (ctf_varent_t
);
356 fp
->ctf_str
[CTF_STRTAB_0
].cts_strs
= (const char *) fp
->ctf_buf
358 fp
->ctf_str
[CTF_STRTAB_0
].cts_len
= hp
->cth_strlen
;
360 /* If we have a parent dict name and label, store the relocated string
361 pointers in the CTF dict for easy access later. */
363 /* Note: before conversion, these will be set to values that will be
364 immediately invalidated by the conversion process, but the conversion
365 process will call ctf_set_base() again to fix things up. */
367 if (hp
->cth_parlabel
!= 0)
368 fp
->ctf_parlabel
= ctf_strptr (fp
, hp
->cth_parlabel
);
369 if (hp
->cth_parname
!= 0)
370 fp
->ctf_parname
= ctf_strptr (fp
, hp
->cth_parname
);
371 if (hp
->cth_cuname
!= 0)
372 fp
->ctf_cuname
= ctf_strptr (fp
, hp
->cth_cuname
);
375 ctf_dprintf ("ctf_set_base: CU name %s\n", fp
->ctf_cuname
);
377 ctf_dprintf ("ctf_set_base: parent name %s (label %s)\n",
379 fp
->ctf_parlabel
? fp
->ctf_parlabel
: "<NULL>");
382 /* Set the version of the CTF file. */
384 /* When this is reset, LCTF_* changes behaviour, but there is no guarantee that
385 the variable data list associated with each type has been upgraded: the
386 caller must ensure this has been done in advance. */
389 ctf_set_version (ctf_dict_t
*fp
, ctf_header_t
*cth
, int ctf_version
)
391 fp
->ctf_version
= ctf_version
;
392 cth
->cth_version
= ctf_version
;
393 fp
->ctf_dictops
= &ctf_dictops
[ctf_version
];
397 /* Upgrade the header to CTF_VERSION_3. The upgrade is done in-place. */
399 upgrade_header (ctf_header_t
*hp
)
401 ctf_header_v2_t
*oldhp
= (ctf_header_v2_t
*) hp
;
403 hp
->cth_strlen
= oldhp
->cth_strlen
;
404 hp
->cth_stroff
= oldhp
->cth_stroff
;
405 hp
->cth_typeoff
= oldhp
->cth_typeoff
;
406 hp
->cth_varoff
= oldhp
->cth_varoff
;
407 hp
->cth_funcidxoff
= hp
->cth_varoff
; /* No index sections. */
408 hp
->cth_objtidxoff
= hp
->cth_funcidxoff
;
409 hp
->cth_funcoff
= oldhp
->cth_funcoff
;
410 hp
->cth_objtoff
= oldhp
->cth_objtoff
;
411 hp
->cth_lbloff
= oldhp
->cth_lbloff
;
412 hp
->cth_cuname
= 0; /* No CU name. */
415 /* Upgrade the type table to CTF_VERSION_3 (really CTF_VERSION_1_UPGRADED_3)
418 The upgrade is not done in-place: the ctf_base is moved. ctf_strptr() must
419 not be called before reallocation is complete.
421 Sections not checked here due to nonexistence or nonpopulated state in older
422 formats: objtidx, funcidx.
424 Type kinds not checked here due to nonexistence in older formats:
427 upgrade_types_v1 (ctf_dict_t
*fp
, ctf_header_t
*cth
)
429 const ctf_type_v1_t
*tbuf
;
430 const ctf_type_v1_t
*tend
;
431 unsigned char *ctf_base
, *old_ctf_base
= (unsigned char *) fp
->ctf_dynbase
;
434 ssize_t increase
= 0, size
, increment
, v2increment
, vbytes
, v2bytes
;
435 const ctf_type_v1_t
*tp
;
438 tbuf
= (ctf_type_v1_t
*) (fp
->ctf_buf
+ cth
->cth_typeoff
);
439 tend
= (ctf_type_v1_t
*) (fp
->ctf_buf
+ cth
->cth_stroff
);
441 /* Much like init_types(), this is a two-pass process.
443 First, figure out the new type-section size needed. (It is possible,
444 in theory, for it to be less than the old size, but this is very
445 unlikely. It cannot be so small that cth_typeoff ends up of negative
446 size. We validate this with an assertion below.)
448 We must cater not only for changes in vlen and types sizes but also
449 for changes in 'increment', which happen because v2 places some types
450 into ctf_stype_t where v1 would be forced to use the larger non-stype. */
452 for (tp
= tbuf
; tp
< tend
;
453 tp
= (ctf_type_v1_t
*) ((uintptr_t) tp
+ increment
+ vbytes
))
455 unsigned short kind
= CTF_V1_INFO_KIND (tp
->ctt_info
);
456 unsigned long vlen
= CTF_V1_INFO_VLEN (tp
->ctt_info
);
458 size
= get_ctt_size_v1 (fp
, (const ctf_type_t
*) tp
, NULL
, &increment
);
459 vbytes
= get_vbytes_v1 (fp
, kind
, size
, vlen
);
461 get_ctt_size_v2_unconverted (fp
, (const ctf_type_t
*) tp
, NULL
,
463 v2bytes
= get_vbytes_v2 (fp
, kind
, size
, vlen
);
465 if ((vbytes
< 0) || (size
< 0))
468 increase
+= v2increment
- increment
; /* May be negative. */
469 increase
+= v2bytes
- vbytes
;
472 /* Allocate enough room for the new buffer, then copy everything but the type
473 section into place, and reset the base accordingly. Leave the version
474 number unchanged, so that LCTF_INFO_* still works on the
475 as-yet-untranslated type info. */
477 if ((ctf_base
= malloc (fp
->ctf_size
+ increase
)) == NULL
)
480 /* Start at ctf_buf, not ctf_base, to squeeze out the original header: we
481 never use it and it is unconverted. */
483 memcpy (ctf_base
, fp
->ctf_buf
, cth
->cth_typeoff
);
484 memcpy (ctf_base
+ cth
->cth_stroff
+ increase
,
485 fp
->ctf_buf
+ cth
->cth_stroff
, cth
->cth_strlen
);
487 memset (ctf_base
+ cth
->cth_typeoff
, 0, cth
->cth_stroff
- cth
->cth_typeoff
490 cth
->cth_stroff
+= increase
;
491 fp
->ctf_size
+= increase
;
492 assert (cth
->cth_stroff
>= cth
->cth_typeoff
);
493 fp
->ctf_base
= ctf_base
;
494 fp
->ctf_buf
= ctf_base
;
495 fp
->ctf_dynbase
= ctf_base
;
496 ctf_set_base (fp
, cth
, ctf_base
);
498 t2buf
= (ctf_type_t
*) (fp
->ctf_buf
+ cth
->cth_typeoff
);
500 /* Iterate through all the types again, upgrading them.
502 Everything that hasn't changed can just be outright memcpy()ed.
503 Things that have changed need field-by-field consideration. */
505 for (tp
= tbuf
, t2p
= t2buf
; tp
< tend
;
506 tp
= (ctf_type_v1_t
*) ((uintptr_t) tp
+ increment
+ vbytes
),
507 t2p
= (ctf_type_t
*) ((uintptr_t) t2p
+ v2increment
+ v2bytes
))
509 unsigned short kind
= CTF_V1_INFO_KIND (tp
->ctt_info
);
510 int isroot
= CTF_V1_INFO_ISROOT (tp
->ctt_info
);
511 unsigned long vlen
= CTF_V1_INFO_VLEN (tp
->ctt_info
);
513 void *vdata
, *v2data
;
515 size
= get_ctt_size_v1 (fp
, (const ctf_type_t
*) tp
, NULL
, &increment
);
516 vbytes
= get_vbytes_v1 (fp
, kind
, size
, vlen
);
518 t2p
->ctt_name
= tp
->ctt_name
;
519 t2p
->ctt_info
= CTF_TYPE_INFO (kind
, isroot
, vlen
);
530 t2p
->ctt_type
= tp
->ctt_type
;
539 if ((size_t) size
<= CTF_MAX_SIZE
)
540 t2p
->ctt_size
= size
;
543 t2p
->ctt_lsizehi
= CTF_SIZE_TO_LSIZE_HI (size
);
544 t2p
->ctt_lsizelo
= CTF_SIZE_TO_LSIZE_LO (size
);
549 v2size
= get_ctt_size_v2 (fp
, t2p
, NULL
, &v2increment
);
550 v2bytes
= get_vbytes_v2 (fp
, kind
, v2size
, vlen
);
552 /* Catch out-of-sync get_ctt_size_*(). The count goes wrong if
553 these are not identical (and having them different makes no
554 sense semantically). */
556 assert (size
== v2size
);
558 /* Now the varlen info. */
560 vdata
= (void *) ((uintptr_t) tp
+ increment
);
561 v2data
= (void *) ((uintptr_t) t2p
+ v2increment
);
567 const ctf_array_v1_t
*ap
= (const ctf_array_v1_t
*) vdata
;
568 ctf_array_t
*a2p
= (ctf_array_t
*) v2data
;
570 a2p
->cta_contents
= ap
->cta_contents
;
571 a2p
->cta_index
= ap
->cta_index
;
572 a2p
->cta_nelems
= ap
->cta_nelems
;
579 const ctf_member_v1_t
*m1
= (const ctf_member_v1_t
*) vdata
;
580 const ctf_lmember_v1_t
*lm1
= (const ctf_lmember_v1_t
*) m1
;
581 ctf_member_t
*m2
= (ctf_member_t
*) v2data
;
582 ctf_lmember_t
*lm2
= (ctf_lmember_t
*) m2
;
585 /* We walk all four pointers forward, but only reference the two
586 that are valid for the given size, to avoid quadruplicating all
589 for (i
= vlen
; i
!= 0; i
--, m1
++, lm1
++, m2
++, lm2
++)
592 if (size
< CTF_LSTRUCT_THRESH_V1
)
594 offset
= m1
->ctm_offset
;
595 tmp
.ctm_name
= m1
->ctm_name
;
596 tmp
.ctm_type
= m1
->ctm_type
;
600 offset
= CTF_LMEM_OFFSET (lm1
);
601 tmp
.ctm_name
= lm1
->ctlm_name
;
602 tmp
.ctm_type
= lm1
->ctlm_type
;
604 if (size
< CTF_LSTRUCT_THRESH
)
606 m2
->ctm_name
= tmp
.ctm_name
;
607 m2
->ctm_type
= tmp
.ctm_type
;
608 m2
->ctm_offset
= offset
;
612 lm2
->ctlm_name
= tmp
.ctm_name
;
613 lm2
->ctlm_type
= tmp
.ctm_type
;
614 lm2
->ctlm_offsethi
= CTF_OFFSET_TO_LMEMHI (offset
);
615 lm2
->ctlm_offsetlo
= CTF_OFFSET_TO_LMEMLO (offset
);
623 unsigned short *a1
= (unsigned short *) vdata
;
624 uint32_t *a2
= (uint32_t *) v2data
;
626 for (i
= vlen
; i
!= 0; i
--, a1
++, a2
++)
631 /* Catch out-of-sync get_vbytes_*(). */
632 assert (vbytes
== v2bytes
);
633 memcpy (v2data
, vdata
, vbytes
);
637 /* Verify that the entire region was converted. If not, we are either
638 converting too much, or too little (leading to a buffer overrun either here
639 or at read time, in init_types().) */
641 assert ((size_t) t2p
- (size_t) fp
->ctf_buf
== cth
->cth_stroff
);
643 ctf_set_version (fp
, cth
, CTF_VERSION_1_UPGRADED_3
);
649 /* Upgrade from any earlier version. */
651 upgrade_types (ctf_dict_t
*fp
, ctf_header_t
*cth
)
653 switch (cth
->cth_version
)
655 /* v1 requires a full pass and reformatting. */
657 upgrade_types_v1 (fp
, cth
);
659 /* Already-converted v1 is just like later versions except that its
660 parent/child boundary is unchanged (and much lower). */
662 case CTF_VERSION_1_UPGRADED_3
:
663 fp
->ctf_parmax
= CTF_MAX_PTYPE_V1
;
665 /* v2 is just the same as v3 except for new types and sections:
666 no upgrading required. */
667 case CTF_VERSION_2
: ;
673 /* Initialize the type ID translation table with the byte offset of each type,
674 and initialize the hash tables of each named type. Upgrade the type table to
675 the latest supported representation in the process, if needed, and if this
676 recension of libctf supports upgrading. */
679 init_types (ctf_dict_t
*fp
, ctf_header_t
*cth
)
681 const ctf_type_t
*tbuf
;
682 const ctf_type_t
*tend
;
684 unsigned long pop
[CTF_K_MAX
+ 1] = { 0 };
685 const ctf_type_t
*tp
;
689 /* We determine whether the dict is a child or a parent based on the value of
692 int child
= cth
->cth_parname
!= 0;
693 int nlstructs
= 0, nlunions
= 0;
696 assert (!(fp
->ctf_flags
& LCTF_RDWR
));
698 if (_libctf_unlikely_ (fp
->ctf_version
== CTF_VERSION_1
))
701 if ((err
= upgrade_types (fp
, cth
)) != 0)
702 return err
; /* Upgrade failed. */
705 tbuf
= (ctf_type_t
*) (fp
->ctf_buf
+ cth
->cth_typeoff
);
706 tend
= (ctf_type_t
*) (fp
->ctf_buf
+ cth
->cth_stroff
);
708 /* We make two passes through the entire type section. In this first
709 pass, we count the number of each type and the total number of types. */
711 for (tp
= tbuf
; tp
< tend
; fp
->ctf_typemax
++)
713 unsigned short kind
= LCTF_INFO_KIND (fp
, tp
->ctt_info
);
714 unsigned long vlen
= LCTF_INFO_VLEN (fp
, tp
->ctt_info
);
715 ssize_t size
, increment
, vbytes
;
717 (void) ctf_get_ctt_size (fp
, tp
, &size
, &increment
);
718 vbytes
= LCTF_VBYTES (fp
, kind
, size
, vlen
);
723 /* For forward declarations, ctt_type is the CTF_K_* kind for the tag,
724 so bump that population count too. */
725 if (kind
== CTF_K_FORWARD
)
728 tp
= (ctf_type_t
*) ((uintptr_t) tp
+ increment
+ vbytes
);
734 ctf_dprintf ("CTF dict %p is a child\n", (void *) fp
);
735 fp
->ctf_flags
|= LCTF_CHILD
;
738 ctf_dprintf ("CTF dict %p is a parent\n", (void *) fp
);
740 /* Now that we've counted up the number of each type, we can allocate
741 the hash tables, type translation table, and pointer table. */
743 if ((fp
->ctf_structs
.ctn_readonly
744 = ctf_hash_create (pop
[CTF_K_STRUCT
], ctf_hash_string
,
745 ctf_hash_eq_string
)) == NULL
)
748 if ((fp
->ctf_unions
.ctn_readonly
749 = ctf_hash_create (pop
[CTF_K_UNION
], ctf_hash_string
,
750 ctf_hash_eq_string
)) == NULL
)
753 if ((fp
->ctf_enums
.ctn_readonly
754 = ctf_hash_create (pop
[CTF_K_ENUM
], ctf_hash_string
,
755 ctf_hash_eq_string
)) == NULL
)
758 if ((fp
->ctf_names
.ctn_readonly
759 = ctf_hash_create (pop
[CTF_K_INTEGER
] +
761 pop
[CTF_K_FUNCTION
] +
764 pop
[CTF_K_VOLATILE
] +
768 ctf_hash_eq_string
)) == NULL
)
771 fp
->ctf_txlate
= malloc (sizeof (uint32_t) * (fp
->ctf_typemax
+ 1));
772 fp
->ctf_ptrtab_len
= fp
->ctf_typemax
+ 1;
773 fp
->ctf_ptrtab
= malloc (sizeof (uint32_t) * fp
->ctf_ptrtab_len
);
775 if (fp
->ctf_txlate
== NULL
|| fp
->ctf_ptrtab
== NULL
)
776 return ENOMEM
; /* Memory allocation failed. */
779 *xp
++ = 0; /* Type id 0 is used as a sentinel value. */
781 memset (fp
->ctf_txlate
, 0, sizeof (uint32_t) * (fp
->ctf_typemax
+ 1));
782 memset (fp
->ctf_ptrtab
, 0, sizeof (uint32_t) * (fp
->ctf_typemax
+ 1));
784 /* In the second pass through the types, we fill in each entry of the
785 type and pointer tables and add names to the appropriate hashes. */
787 for (id
= 1, tp
= tbuf
; tp
< tend
; xp
++, id
++)
789 unsigned short kind
= LCTF_INFO_KIND (fp
, tp
->ctt_info
);
790 unsigned short isroot
= LCTF_INFO_ISROOT (fp
, tp
->ctt_info
);
791 unsigned long vlen
= LCTF_INFO_VLEN (fp
, tp
->ctt_info
);
792 ssize_t size
, increment
, vbytes
;
796 (void) ctf_get_ctt_size (fp
, tp
, &size
, &increment
);
797 name
= ctf_strptr (fp
, tp
->ctt_name
);
798 /* Cannot fail: shielded by call in loop above. */
799 vbytes
= LCTF_VBYTES (fp
, kind
, size
, vlen
);
805 /* Names are reused by bit-fields, which are differentiated by their
806 encodings, and so typically we'd record only the first instance of
807 a given intrinsic. However, we replace an existing type with a
808 root-visible version so that we can be sure to find it when
809 checking for conflicting definitions in ctf_add_type(). */
811 if (((ctf_hash_lookup_type (fp
->ctf_names
.ctn_readonly
,
815 err
= ctf_hash_define_type (fp
->ctf_names
.ctn_readonly
, fp
,
816 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
823 /* These kinds have no name, so do not need interning into any
833 err
= ctf_hash_insert_type (fp
->ctf_names
.ctn_readonly
, fp
,
834 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
841 if (size
>= CTF_LSTRUCT_THRESH
)
847 err
= ctf_hash_define_type (fp
->ctf_structs
.ctn_readonly
, fp
,
848 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
857 if (size
>= CTF_LSTRUCT_THRESH
)
863 err
= ctf_hash_define_type (fp
->ctf_unions
.ctn_readonly
, fp
,
864 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
875 err
= ctf_hash_define_type (fp
->ctf_enums
.ctn_readonly
, fp
,
876 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
887 err
= ctf_hash_insert_type (fp
->ctf_names
.ctn_readonly
, fp
,
888 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
896 ctf_names_t
*np
= ctf_name_table (fp
, tp
->ctt_type
);
901 /* Only insert forward tags into the given hash if the type or tag
902 name is not already present. */
903 if (ctf_hash_lookup_type (np
->ctn_readonly
, fp
, name
) == 0)
905 err
= ctf_hash_insert_type (np
->ctn_readonly
, fp
,
906 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
915 /* If the type referenced by the pointer is in this CTF dict, then
916 store the index of the pointer type in fp->ctf_ptrtab[ index of
917 referenced type ]. */
919 if (LCTF_TYPE_ISCHILD (fp
, tp
->ctt_type
) == child
920 && LCTF_TYPE_TO_INDEX (fp
, tp
->ctt_type
) <= fp
->ctf_typemax
)
921 fp
->ctf_ptrtab
[LCTF_TYPE_TO_INDEX (fp
, tp
->ctt_type
)] = id
;
930 err
= ctf_hash_insert_type (fp
->ctf_names
.ctn_readonly
, fp
,
931 LCTF_INDEX_TO_TYPE (fp
, id
, child
),
937 ctf_err_warn (fp
, 0, ECTF_CORRUPT
,
938 _("init_types(): unhandled CTF kind: %x"), kind
);
942 *xp
= (uint32_t) ((uintptr_t) tp
- (uintptr_t) fp
->ctf_buf
);
943 tp
= (ctf_type_t
*) ((uintptr_t) tp
+ increment
+ vbytes
);
946 ctf_dprintf ("%lu total types processed\n", fp
->ctf_typemax
);
947 ctf_dprintf ("%u enum names hashed\n",
948 ctf_hash_size (fp
->ctf_enums
.ctn_readonly
));
949 ctf_dprintf ("%u struct names hashed (%d long)\n",
950 ctf_hash_size (fp
->ctf_structs
.ctn_readonly
), nlstructs
);
951 ctf_dprintf ("%u union names hashed (%d long)\n",
952 ctf_hash_size (fp
->ctf_unions
.ctn_readonly
), nlunions
);
953 ctf_dprintf ("%u base type names hashed\n",
954 ctf_hash_size (fp
->ctf_names
.ctn_readonly
));
959 /* Endianness-flipping routines.
961 We flip everything, mindlessly, even 1-byte entities, so that future
962 expansions do not require changes to this code. */
964 /* Flip the endianness of the CTF header. */
967 flip_header (ctf_header_t
*cth
)
969 swap_thing (cth
->cth_preamble
.ctp_magic
);
970 swap_thing (cth
->cth_preamble
.ctp_version
);
971 swap_thing (cth
->cth_preamble
.ctp_flags
);
972 swap_thing (cth
->cth_parlabel
);
973 swap_thing (cth
->cth_parname
);
974 swap_thing (cth
->cth_cuname
);
975 swap_thing (cth
->cth_objtoff
);
976 swap_thing (cth
->cth_funcoff
);
977 swap_thing (cth
->cth_objtidxoff
);
978 swap_thing (cth
->cth_funcidxoff
);
979 swap_thing (cth
->cth_varoff
);
980 swap_thing (cth
->cth_typeoff
);
981 swap_thing (cth
->cth_stroff
);
982 swap_thing (cth
->cth_strlen
);
985 /* Flip the endianness of the label section, an array of ctf_lblent_t. */
988 flip_lbls (void *start
, size_t len
)
990 ctf_lblent_t
*lbl
= start
;
993 for (i
= len
/ sizeof (struct ctf_lblent
); i
> 0; lbl
++, i
--)
995 swap_thing (lbl
->ctl_label
);
996 swap_thing (lbl
->ctl_type
);
1000 /* Flip the endianness of the data-object or function sections or their indexes,
1001 all arrays of uint32_t. */
1004 flip_objts (void *start
, size_t len
)
1006 uint32_t *obj
= start
;
1009 for (i
= len
/ sizeof (uint32_t); i
> 0; obj
++, i
--)
1013 /* Flip the endianness of the variable section, an array of ctf_varent_t. */
1016 flip_vars (void *start
, size_t len
)
1018 ctf_varent_t
*var
= start
;
1021 for (i
= len
/ sizeof (struct ctf_varent
); i
> 0; var
++, i
--)
1023 swap_thing (var
->ctv_name
);
1024 swap_thing (var
->ctv_type
);
1028 /* Flip the endianness of the type section, a tagged array of ctf_type or
1029 ctf_stype followed by variable data. */
1032 flip_types (ctf_dict_t
*fp
, void *start
, size_t len
)
1034 ctf_type_t
*t
= start
;
1036 while ((uintptr_t) t
< ((uintptr_t) start
) + len
)
1038 swap_thing (t
->ctt_name
);
1039 swap_thing (t
->ctt_info
);
1040 swap_thing (t
->ctt_size
);
1042 uint32_t kind
= CTF_V2_INFO_KIND (t
->ctt_info
);
1043 size_t size
= t
->ctt_size
;
1044 uint32_t vlen
= CTF_V2_INFO_VLEN (t
->ctt_info
);
1045 size_t vbytes
= get_vbytes_v2 (fp
, kind
, size
, vlen
);
1047 if (_libctf_unlikely_ (size
== CTF_LSIZE_SENT
))
1049 swap_thing (t
->ctt_lsizehi
);
1050 swap_thing (t
->ctt_lsizelo
);
1051 size
= CTF_TYPE_LSIZE (t
);
1052 t
= (ctf_type_t
*) ((uintptr_t) t
+ sizeof (ctf_type_t
));
1055 t
= (ctf_type_t
*) ((uintptr_t) t
+ sizeof (ctf_stype_t
));
1063 case CTF_K_VOLATILE
:
1065 case CTF_K_RESTRICT
:
1066 /* These types have no vlen data to swap. */
1067 assert (vbytes
== 0);
1073 /* These types have a single uint32_t. */
1075 uint32_t *item
= (uint32_t *) t
;
1081 case CTF_K_FUNCTION
:
1083 /* This type has a bunch of uint32_ts. */
1085 uint32_t *item
= (uint32_t *) t
;
1088 for (i
= vlen
; i
> 0; item
++, i
--)
1095 /* This has a single ctf_array_t. */
1097 ctf_array_t
*a
= (ctf_array_t
*) t
;
1099 assert (vbytes
== sizeof (ctf_array_t
));
1100 swap_thing (a
->cta_contents
);
1101 swap_thing (a
->cta_index
);
1102 swap_thing (a
->cta_nelems
);
1109 /* This has a single ctf_slice_t. */
1111 ctf_slice_t
*s
= (ctf_slice_t
*) t
;
1113 assert (vbytes
== sizeof (ctf_slice_t
));
1114 swap_thing (s
->cts_type
);
1115 swap_thing (s
->cts_offset
);
1116 swap_thing (s
->cts_bits
);
1124 /* This has an array of ctf_member or ctf_lmember, depending on
1125 size. We could consider it to be a simple array of uint32_t,
1126 but for safety's sake in case these structures ever acquire
1127 non-uint32_t members, do it member by member. */
1129 if (_libctf_unlikely_ (size
>= CTF_LSTRUCT_THRESH
))
1131 ctf_lmember_t
*lm
= (ctf_lmember_t
*) t
;
1133 for (i
= vlen
; i
> 0; i
--, lm
++)
1135 swap_thing (lm
->ctlm_name
);
1136 swap_thing (lm
->ctlm_offsethi
);
1137 swap_thing (lm
->ctlm_type
);
1138 swap_thing (lm
->ctlm_offsetlo
);
1143 ctf_member_t
*m
= (ctf_member_t
*) t
;
1145 for (i
= vlen
; i
> 0; i
--, m
++)
1147 swap_thing (m
->ctm_name
);
1148 swap_thing (m
->ctm_offset
);
1149 swap_thing (m
->ctm_type
);
1157 /* This has an array of ctf_enum_t. */
1159 ctf_enum_t
*item
= (ctf_enum_t
*) t
;
1162 for (i
= vlen
; i
> 0; item
++, i
--)
1164 swap_thing (item
->cte_name
);
1165 swap_thing (item
->cte_value
);
1170 ctf_err_warn (fp
, 0, ECTF_CORRUPT
,
1171 _("unhandled CTF kind in endianness conversion: %x"),
1173 return ECTF_CORRUPT
;
1176 t
= (ctf_type_t
*) ((uintptr_t) t
+ vbytes
);
1182 /* Flip the endianness of BUF, given the offsets in the (already endian-
1185 All of this stuff happens before the header is fully initialized, so the
1186 LCTF_*() macros cannot be used yet. Since we do not try to endian-convert v1
1187 data, this is no real loss. */
1190 flip_ctf (ctf_dict_t
*fp
, ctf_header_t
*cth
, unsigned char *buf
)
1192 flip_lbls (buf
+ cth
->cth_lbloff
, cth
->cth_objtoff
- cth
->cth_lbloff
);
1193 flip_objts (buf
+ cth
->cth_objtoff
, cth
->cth_funcoff
- cth
->cth_objtoff
);
1194 flip_objts (buf
+ cth
->cth_funcoff
, cth
->cth_objtidxoff
- cth
->cth_funcoff
);
1195 flip_objts (buf
+ cth
->cth_objtidxoff
, cth
->cth_funcidxoff
- cth
->cth_objtidxoff
);
1196 flip_objts (buf
+ cth
->cth_funcidxoff
, cth
->cth_varoff
- cth
->cth_funcidxoff
);
1197 flip_vars (buf
+ cth
->cth_varoff
, cth
->cth_typeoff
- cth
->cth_varoff
);
1198 return flip_types (fp
, buf
+ cth
->cth_typeoff
, cth
->cth_stroff
- cth
->cth_typeoff
);
1201 /* Set up the ctl hashes in a ctf_dict_t. Called by both writable and
1202 non-writable dictionary initialization. */
1203 void ctf_set_ctl_hashes (ctf_dict_t
*fp
)
1205 /* Initialize the ctf_lookup_by_name top-level dictionary. We keep an
1206 array of type name prefixes and the corresponding ctf_hash to use. */
1207 fp
->ctf_lookups
[0].ctl_prefix
= "struct";
1208 fp
->ctf_lookups
[0].ctl_len
= strlen (fp
->ctf_lookups
[0].ctl_prefix
);
1209 fp
->ctf_lookups
[0].ctl_hash
= &fp
->ctf_structs
;
1210 fp
->ctf_lookups
[1].ctl_prefix
= "union";
1211 fp
->ctf_lookups
[1].ctl_len
= strlen (fp
->ctf_lookups
[1].ctl_prefix
);
1212 fp
->ctf_lookups
[1].ctl_hash
= &fp
->ctf_unions
;
1213 fp
->ctf_lookups
[2].ctl_prefix
= "enum";
1214 fp
->ctf_lookups
[2].ctl_len
= strlen (fp
->ctf_lookups
[2].ctl_prefix
);
1215 fp
->ctf_lookups
[2].ctl_hash
= &fp
->ctf_enums
;
1216 fp
->ctf_lookups
[3].ctl_prefix
= _CTF_NULLSTR
;
1217 fp
->ctf_lookups
[3].ctl_len
= strlen (fp
->ctf_lookups
[3].ctl_prefix
);
1218 fp
->ctf_lookups
[3].ctl_hash
= &fp
->ctf_names
;
1219 fp
->ctf_lookups
[4].ctl_prefix
= NULL
;
1220 fp
->ctf_lookups
[4].ctl_len
= 0;
1221 fp
->ctf_lookups
[4].ctl_hash
= NULL
;
1224 /* Open a CTF file, mocking up a suitable ctf_sect. */
1226 ctf_dict_t
*ctf_simple_open (const char *ctfsect
, size_t ctfsect_size
,
1227 const char *symsect
, size_t symsect_size
,
1228 size_t symsect_entsize
,
1229 const char *strsect
, size_t strsect_size
,
1232 return ctf_simple_open_internal (ctfsect
, ctfsect_size
, symsect
, symsect_size
,
1233 symsect_entsize
, strsect
, strsect_size
, NULL
,
1237 /* Open a CTF file, mocking up a suitable ctf_sect and overriding the external
1238 strtab with a synthetic one. */
1240 ctf_dict_t
*ctf_simple_open_internal (const char *ctfsect
, size_t ctfsect_size
,
1241 const char *symsect
, size_t symsect_size
,
1242 size_t symsect_entsize
,
1243 const char *strsect
, size_t strsect_size
,
1244 ctf_dynhash_t
*syn_strtab
, int writable
,
1247 ctf_sect_t skeleton
;
1249 ctf_sect_t ctf_sect
, sym_sect
, str_sect
;
1250 ctf_sect_t
*ctfsectp
= NULL
;
1251 ctf_sect_t
*symsectp
= NULL
;
1252 ctf_sect_t
*strsectp
= NULL
;
1254 skeleton
.cts_name
= _CTF_SECTION
;
1255 skeleton
.cts_entsize
= 1;
1259 memcpy (&ctf_sect
, &skeleton
, sizeof (struct ctf_sect
));
1260 ctf_sect
.cts_data
= ctfsect
;
1261 ctf_sect
.cts_size
= ctfsect_size
;
1262 ctfsectp
= &ctf_sect
;
1267 memcpy (&sym_sect
, &skeleton
, sizeof (struct ctf_sect
));
1268 sym_sect
.cts_data
= symsect
;
1269 sym_sect
.cts_size
= symsect_size
;
1270 sym_sect
.cts_entsize
= symsect_entsize
;
1271 symsectp
= &sym_sect
;
1276 memcpy (&str_sect
, &skeleton
, sizeof (struct ctf_sect
));
1277 str_sect
.cts_data
= strsect
;
1278 str_sect
.cts_size
= strsect_size
;
1279 strsectp
= &str_sect
;
1282 return ctf_bufopen_internal (ctfsectp
, symsectp
, strsectp
, syn_strtab
,
1286 /* Decode the specified CTF buffer and optional symbol table, and create a new
1287 CTF dict representing the symbolic debugging information. This code can
1288 be used directly by the debugger, or it can be used as the engine for
1289 ctf_fdopen() or ctf_open(), below. */
1292 ctf_bufopen (const ctf_sect_t
*ctfsect
, const ctf_sect_t
*symsect
,
1293 const ctf_sect_t
*strsect
, int *errp
)
1295 return ctf_bufopen_internal (ctfsect
, symsect
, strsect
, NULL
, 0, errp
);
1298 /* Like ctf_bufopen, but overriding the external strtab with a synthetic one. */
1301 ctf_bufopen_internal (const ctf_sect_t
*ctfsect
, const ctf_sect_t
*symsect
,
1302 const ctf_sect_t
*strsect
, ctf_dynhash_t
*syn_strtab
,
1303 int writable
, int *errp
)
1305 const ctf_preamble_t
*pp
;
1306 size_t hdrsz
= sizeof (ctf_header_t
);
1309 int foreign_endian
= 0;
1312 libctf_init_debug();
1314 if ((ctfsect
== NULL
) || ((symsect
!= NULL
) &&
1315 ((strsect
== NULL
) && syn_strtab
== NULL
)))
1316 return (ctf_set_open_errno (errp
, EINVAL
));
1318 if (symsect
!= NULL
&& symsect
->cts_entsize
!= sizeof (Elf32_Sym
) &&
1319 symsect
->cts_entsize
!= sizeof (Elf64_Sym
))
1320 return (ctf_set_open_errno (errp
, ECTF_SYMTAB
));
1322 if (symsect
!= NULL
&& symsect
->cts_data
== NULL
)
1323 return (ctf_set_open_errno (errp
, ECTF_SYMBAD
));
1325 if (strsect
!= NULL
&& strsect
->cts_data
== NULL
)
1326 return (ctf_set_open_errno (errp
, ECTF_STRBAD
));
1328 if (ctfsect
->cts_size
< sizeof (ctf_preamble_t
))
1329 return (ctf_set_open_errno (errp
, ECTF_NOCTFBUF
));
1331 pp
= (const ctf_preamble_t
*) ctfsect
->cts_data
;
1333 ctf_dprintf ("ctf_bufopen: magic=0x%x version=%u\n",
1334 pp
->ctp_magic
, pp
->ctp_version
);
1336 /* Validate each part of the CTF header.
1338 First, we validate the preamble (common to all versions). At that point,
1339 we know the endianness and specific header version, and can validate the
1340 version-specific parts including section offsets and alignments.
1342 We specifically do not support foreign-endian old versions. */
1344 if (_libctf_unlikely_ (pp
->ctp_magic
!= CTF_MAGIC
))
1346 if (pp
->ctp_magic
== bswap_16 (CTF_MAGIC
))
1348 if (pp
->ctp_version
!= CTF_VERSION_3
)
1349 return (ctf_set_open_errno (errp
, ECTF_CTFVERS
));
1353 return (ctf_set_open_errno (errp
, ECTF_NOCTFBUF
));
1356 if (_libctf_unlikely_ ((pp
->ctp_version
< CTF_VERSION_1
)
1357 || (pp
->ctp_version
> CTF_VERSION_3
)))
1358 return (ctf_set_open_errno (errp
, ECTF_CTFVERS
));
1360 if ((symsect
!= NULL
) && (pp
->ctp_version
< CTF_VERSION_2
))
1362 /* The symtab can contain function entries which contain embedded ctf
1363 info. We do not support dynamically upgrading such entries (none
1364 should exist in any case, since dwarf2ctf does not create them). */
1366 ctf_err_warn (NULL
, 0, ECTF_NOTSUP
, _("ctf_bufopen: CTF version %d "
1367 "symsect not supported"),
1369 return (ctf_set_open_errno (errp
, ECTF_NOTSUP
));
1372 if (pp
->ctp_version
< CTF_VERSION_3
)
1373 hdrsz
= sizeof (ctf_header_v2_t
);
1375 if (_libctf_unlikely_ (pp
->ctp_flags
> CTF_F_MAX
))
1377 ctf_err_warn (NULL
, 0, ECTF_FLAGS
, _("ctf_bufopen: invalid header "
1379 (unsigned int) pp
->ctp_flags
);
1380 return (ctf_set_open_errno (errp
, ECTF_FLAGS
));
1383 if (ctfsect
->cts_size
< hdrsz
)
1384 return (ctf_set_open_errno (errp
, ECTF_NOCTFBUF
));
1386 if ((fp
= malloc (sizeof (ctf_dict_t
))) == NULL
)
1387 return (ctf_set_open_errno (errp
, ENOMEM
));
1389 memset (fp
, 0, sizeof (ctf_dict_t
));
1392 fp
->ctf_flags
|= LCTF_RDWR
;
1394 if ((fp
->ctf_header
= malloc (sizeof (struct ctf_header
))) == NULL
)
1397 return (ctf_set_open_errno (errp
, ENOMEM
));
1399 hp
= fp
->ctf_header
;
1400 memcpy (hp
, ctfsect
->cts_data
, hdrsz
);
1401 if (pp
->ctp_version
< CTF_VERSION_3
)
1402 upgrade_header (hp
);
1406 fp
->ctf_openflags
= hp
->cth_flags
;
1407 fp
->ctf_size
= hp
->cth_stroff
+ hp
->cth_strlen
;
1409 ctf_dprintf ("ctf_bufopen: uncompressed size=%lu\n",
1410 (unsigned long) fp
->ctf_size
);
1412 if (hp
->cth_lbloff
> fp
->ctf_size
|| hp
->cth_objtoff
> fp
->ctf_size
1413 || hp
->cth_funcoff
> fp
->ctf_size
|| hp
->cth_objtidxoff
> fp
->ctf_size
1414 || hp
->cth_funcidxoff
> fp
->ctf_size
|| hp
->cth_typeoff
> fp
->ctf_size
1415 || hp
->cth_stroff
> fp
->ctf_size
)
1417 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
, _("header offset exceeds CTF size"));
1418 return (ctf_set_open_errno (errp
, ECTF_CORRUPT
));
1421 if (hp
->cth_lbloff
> hp
->cth_objtoff
1422 || hp
->cth_objtoff
> hp
->cth_funcoff
1423 || hp
->cth_funcoff
> hp
->cth_typeoff
1424 || hp
->cth_funcoff
> hp
->cth_objtidxoff
1425 || hp
->cth_objtidxoff
> hp
->cth_funcidxoff
1426 || hp
->cth_funcidxoff
> hp
->cth_varoff
1427 || hp
->cth_varoff
> hp
->cth_typeoff
|| hp
->cth_typeoff
> hp
->cth_stroff
)
1429 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
, _("overlapping CTF sections"));
1430 return (ctf_set_open_errno (errp
, ECTF_CORRUPT
));
1433 if ((hp
->cth_lbloff
& 3) || (hp
->cth_objtoff
& 2)
1434 || (hp
->cth_funcoff
& 2) || (hp
->cth_objtidxoff
& 2)
1435 || (hp
->cth_funcidxoff
& 2) || (hp
->cth_varoff
& 3)
1436 || (hp
->cth_typeoff
& 3))
1438 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
,
1439 _("CTF sections not properly aligned"));
1440 return (ctf_set_open_errno (errp
, ECTF_CORRUPT
));
1443 /* This invariant will be lifted in v4, but for now it is true. */
1445 if ((hp
->cth_funcidxoff
- hp
->cth_objtidxoff
!= 0) &&
1446 (hp
->cth_funcidxoff
- hp
->cth_objtidxoff
1447 != hp
->cth_funcoff
- hp
->cth_objtoff
))
1449 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
,
1450 _("Object index section exists is neither empty nor the "
1451 "same length as the object section: %u versus %u "
1452 "bytes"), hp
->cth_funcoff
- hp
->cth_objtoff
,
1453 hp
->cth_funcidxoff
- hp
->cth_objtidxoff
);
1454 return (ctf_set_open_errno (errp
, ECTF_CORRUPT
));
1457 if ((hp
->cth_varoff
- hp
->cth_funcidxoff
!= 0) &&
1458 (hp
->cth_varoff
- hp
->cth_funcidxoff
1459 != hp
->cth_objtidxoff
- hp
->cth_funcoff
))
1461 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
,
1462 _("Function index section exists is neither empty nor the "
1463 "same length as the function section: %u versus %u "
1464 "bytes"), hp
->cth_objtidxoff
- hp
->cth_funcoff
,
1465 hp
->cth_varoff
- hp
->cth_funcidxoff
);
1466 return (ctf_set_open_errno (errp
, ECTF_CORRUPT
));
1469 /* Once everything is determined to be valid, attempt to decompress the CTF
1470 data buffer if it is compressed, or copy it into new storage if it is not
1471 compressed but needs endian-flipping. Otherwise we just put the data
1472 section's buffer pointer into ctf_buf, below. */
1474 /* Note: if this is a v1 buffer, it will be reallocated and expanded by
1477 if (hp
->cth_flags
& CTF_F_COMPRESS
)
1484 /* We are allocating this ourselves, so we can drop the ctf header
1485 copy in favour of ctf->ctf_header. */
1487 if ((fp
->ctf_base
= malloc (fp
->ctf_size
)) == NULL
)
1492 fp
->ctf_dynbase
= fp
->ctf_base
;
1493 hp
->cth_flags
&= ~CTF_F_COMPRESS
;
1495 src
= (unsigned char *) ctfsect
->cts_data
+ hdrsz
;
1496 srclen
= ctfsect
->cts_size
- hdrsz
;
1497 dstlen
= fp
->ctf_size
;
1498 fp
->ctf_buf
= fp
->ctf_base
;
1500 if ((rc
= uncompress (fp
->ctf_base
, &dstlen
, src
, srclen
)) != Z_OK
)
1502 ctf_err_warn (NULL
, 0, ECTF_DECOMPRESS
, _("zlib inflate err: %s"),
1504 err
= ECTF_DECOMPRESS
;
1508 if ((size_t) dstlen
!= fp
->ctf_size
)
1510 ctf_err_warn (NULL
, 0, ECTF_CORRUPT
,
1511 _("zlib inflate short: got %lu of %lu bytes"),
1512 (unsigned long) dstlen
, (unsigned long) fp
->ctf_size
);
1517 else if (foreign_endian
)
1519 if ((fp
->ctf_base
= malloc (fp
->ctf_size
)) == NULL
)
1524 fp
->ctf_dynbase
= fp
->ctf_base
;
1525 memcpy (fp
->ctf_base
, ((unsigned char *) ctfsect
->cts_data
) + hdrsz
,
1527 fp
->ctf_buf
= fp
->ctf_base
;
1531 /* We are just using the section passed in -- but its header may be an old
1532 version. Point ctf_buf past the old header, and never touch it
1534 fp
->ctf_base
= (unsigned char *) ctfsect
->cts_data
;
1535 fp
->ctf_dynbase
= NULL
;
1536 fp
->ctf_buf
= fp
->ctf_base
+ hdrsz
;
1539 /* Once we have uncompressed and validated the CTF data buffer, we can
1540 proceed with initializing the ctf_dict_t we allocated above.
1542 Nothing that depends on buf or base should be set directly in this function
1543 before the init_types() call, because it may be reallocated during
1544 transparent upgrade if this recension of libctf is so configured: see
1547 ctf_set_version (fp
, hp
, hp
->cth_version
);
1548 ctf_str_create_atoms (fp
);
1549 fp
->ctf_parmax
= CTF_MAX_PTYPE
;
1550 memcpy (&fp
->ctf_data
, ctfsect
, sizeof (ctf_sect_t
));
1552 if (symsect
!= NULL
)
1554 memcpy (&fp
->ctf_symtab
, symsect
, sizeof (ctf_sect_t
));
1555 memcpy (&fp
->ctf_strtab
, strsect
, sizeof (ctf_sect_t
));
1558 if (fp
->ctf_data
.cts_name
!= NULL
)
1559 if ((fp
->ctf_data
.cts_name
= strdup (fp
->ctf_data
.cts_name
)) == NULL
)
1564 if (fp
->ctf_symtab
.cts_name
!= NULL
)
1565 if ((fp
->ctf_symtab
.cts_name
= strdup (fp
->ctf_symtab
.cts_name
)) == NULL
)
1570 if (fp
->ctf_strtab
.cts_name
!= NULL
)
1571 if ((fp
->ctf_strtab
.cts_name
= strdup (fp
->ctf_strtab
.cts_name
)) == NULL
)
1577 if (fp
->ctf_data
.cts_name
== NULL
)
1578 fp
->ctf_data
.cts_name
= _CTF_NULLSTR
;
1579 if (fp
->ctf_symtab
.cts_name
== NULL
)
1580 fp
->ctf_symtab
.cts_name
= _CTF_NULLSTR
;
1581 if (fp
->ctf_strtab
.cts_name
== NULL
)
1582 fp
->ctf_strtab
.cts_name
= _CTF_NULLSTR
;
1584 if (strsect
!= NULL
)
1586 fp
->ctf_str
[CTF_STRTAB_1
].cts_strs
= strsect
->cts_data
;
1587 fp
->ctf_str
[CTF_STRTAB_1
].cts_len
= strsect
->cts_size
;
1589 fp
->ctf_syn_ext_strtab
= syn_strtab
;
1591 if (foreign_endian
&&
1592 (err
= flip_ctf (fp
, hp
, fp
->ctf_buf
)) != 0)
1594 /* We can be certain that flip_ctf() will have endian-flipped everything
1595 other than the types table when we return. In particular the header
1596 is fine, so set it, to allow freeing to use the usual code path. */
1598 ctf_set_base (fp
, hp
, fp
->ctf_base
);
1602 ctf_set_base (fp
, hp
, fp
->ctf_base
);
1604 /* No need to do anything else for dynamic dicts: they do not support symbol
1605 lookups, and the type table is maintained in the dthashes. */
1606 if (fp
->ctf_flags
& LCTF_RDWR
)
1612 if ((err
= init_types (fp
, hp
)) != 0)
1615 /* Allocate and initialize the symtab translation table, pointed to by
1616 ctf_sxlate, and the corresponding index sections. This table may be too
1617 large for the actual size of the object and function info sections: if so,
1618 ctf_nsyms will be adjusted and the excess will never be used. It's
1619 possible to do indexed symbol lookups even without a symbol table, so check
1620 even in that case. Initially, we assume the symtab is native-endian: if it
1621 isn't, the caller will inform us later by calling ctf_symsect_endianness. */
1622 #ifdef WORDS_BIGENDIAN
1623 fp
->ctf_symsect_little_endian
= 0;
1625 fp
->ctf_symsect_little_endian
= 1;
1628 if (symsect
!= NULL
)
1630 fp
->ctf_nsyms
= symsect
->cts_size
/ symsect
->cts_entsize
;
1631 fp
->ctf_sxlate
= malloc (fp
->ctf_nsyms
* sizeof (uint32_t));
1633 if (fp
->ctf_sxlate
== NULL
)
1640 if ((err
= init_symtab (fp
, hp
, symsect
)) != 0)
1643 ctf_set_ctl_hashes (fp
);
1645 if (symsect
!= NULL
)
1647 if (symsect
->cts_entsize
== sizeof (Elf64_Sym
))
1648 (void) ctf_setmodel (fp
, CTF_MODEL_LP64
);
1650 (void) ctf_setmodel (fp
, CTF_MODEL_ILP32
);
1653 (void) ctf_setmodel (fp
, CTF_MODEL_NATIVE
);
1659 ctf_set_open_errno (errp
, err
);
1660 ctf_err_warn_to_open (fp
);
1661 ctf_dict_close (fp
);
1665 /* Bump the refcount on the specified CTF dict, to allow export of ctf_dict_t's
1666 from iterators that open and close the ctf_dict_t around the loop. (This
1667 does not extend their lifetime beyond that of the ctf_archive_t in which they
1671 ctf_ref (ctf_dict_t
*fp
)
1676 /* Close the specified CTF dict and free associated data structures. Note that
1677 ctf_dict_close() is a reference counted operation: if the specified file is
1678 the parent of other active dict, its reference count will be greater than one
1679 and it will be freed later when no active children exist. */
1682 ctf_dict_close (ctf_dict_t
*fp
)
1684 ctf_dtdef_t
*dtd
, *ntd
;
1685 ctf_dvdef_t
*dvd
, *nvd
;
1686 ctf_in_flight_dynsym_t
*did
, *nid
;
1687 ctf_err_warning_t
*err
, *nerr
;
1690 return; /* Allow ctf_dict_close(NULL) to simplify caller code. */
1692 ctf_dprintf ("ctf_dict_close(%p) refcnt=%u\n", (void *) fp
, fp
->ctf_refcnt
);
1694 if (fp
->ctf_refcnt
> 1)
1700 /* It is possible to recurse back in here, notably if dicts in the
1701 ctf_link_inputs or ctf_link_outputs cite this dict as a parent without
1702 using ctf_import_unref. Do nothing in that case. */
1703 if (fp
->ctf_refcnt
== 0)
1707 free (fp
->ctf_dyncuname
);
1708 free (fp
->ctf_dynparname
);
1709 if (fp
->ctf_parent
&& !fp
->ctf_parent_unreffed
)
1710 ctf_dict_close (fp
->ctf_parent
);
1712 for (dtd
= ctf_list_next (&fp
->ctf_dtdefs
); dtd
!= NULL
; dtd
= ntd
)
1714 ntd
= ctf_list_next (dtd
);
1715 ctf_dtd_delete (fp
, dtd
);
1717 ctf_dynhash_destroy (fp
->ctf_dthash
);
1718 if (fp
->ctf_flags
& LCTF_RDWR
)
1720 ctf_dynhash_destroy (fp
->ctf_structs
.ctn_writable
);
1721 ctf_dynhash_destroy (fp
->ctf_unions
.ctn_writable
);
1722 ctf_dynhash_destroy (fp
->ctf_enums
.ctn_writable
);
1723 ctf_dynhash_destroy (fp
->ctf_names
.ctn_writable
);
1727 ctf_hash_destroy (fp
->ctf_structs
.ctn_readonly
);
1728 ctf_hash_destroy (fp
->ctf_unions
.ctn_readonly
);
1729 ctf_hash_destroy (fp
->ctf_enums
.ctn_readonly
);
1730 ctf_hash_destroy (fp
->ctf_names
.ctn_readonly
);
1733 for (dvd
= ctf_list_next (&fp
->ctf_dvdefs
); dvd
!= NULL
; dvd
= nvd
)
1735 nvd
= ctf_list_next (dvd
);
1736 ctf_dvd_delete (fp
, dvd
);
1738 ctf_dynhash_destroy (fp
->ctf_dvhash
);
1740 ctf_dynhash_destroy (fp
->ctf_symhash
);
1741 free (fp
->ctf_funcidx_sxlate
);
1742 free (fp
->ctf_objtidx_sxlate
);
1743 ctf_dynhash_destroy (fp
->ctf_objthash
);
1744 ctf_dynhash_destroy (fp
->ctf_funchash
);
1745 free (fp
->ctf_dynsymidx
);
1746 ctf_dynhash_destroy (fp
->ctf_dynsyms
);
1747 for (did
= ctf_list_next (&fp
->ctf_in_flight_dynsyms
); did
!= NULL
; did
= nid
)
1749 nid
= ctf_list_next (did
);
1750 ctf_list_delete (&fp
->ctf_in_flight_dynsyms
, did
);
1754 ctf_str_free_atoms (fp
);
1755 free (fp
->ctf_tmp_typeslice
);
1757 if (fp
->ctf_data
.cts_name
!= _CTF_NULLSTR
)
1758 free ((char *) fp
->ctf_data
.cts_name
);
1760 if (fp
->ctf_symtab
.cts_name
!= _CTF_NULLSTR
)
1761 free ((char *) fp
->ctf_symtab
.cts_name
);
1763 if (fp
->ctf_strtab
.cts_name
!= _CTF_NULLSTR
)
1764 free ((char *) fp
->ctf_strtab
.cts_name
);
1765 else if (fp
->ctf_data_mmapped
)
1766 ctf_munmap (fp
->ctf_data_mmapped
, fp
->ctf_data_mmapped_len
);
1768 free (fp
->ctf_dynbase
);
1770 ctf_dynhash_destroy (fp
->ctf_syn_ext_strtab
);
1771 ctf_dynhash_destroy (fp
->ctf_link_inputs
);
1772 ctf_dynhash_destroy (fp
->ctf_link_outputs
);
1773 ctf_dynhash_destroy (fp
->ctf_link_type_mapping
);
1774 ctf_dynhash_destroy (fp
->ctf_link_in_cu_mapping
);
1775 ctf_dynhash_destroy (fp
->ctf_link_out_cu_mapping
);
1776 ctf_dynhash_destroy (fp
->ctf_add_processing
);
1777 ctf_dedup_fini (fp
, NULL
, 0);
1778 ctf_dynset_destroy (fp
->ctf_dedup_atoms_alloc
);
1780 for (err
= ctf_list_next (&fp
->ctf_errs_warnings
); err
!= NULL
; err
= nerr
)
1782 nerr
= ctf_list_next (err
);
1783 ctf_list_delete (&fp
->ctf_errs_warnings
, err
);
1784 free (err
->cew_text
);
1788 free (fp
->ctf_sxlate
);
1789 free (fp
->ctf_txlate
);
1790 free (fp
->ctf_ptrtab
);
1791 free (fp
->ctf_pptrtab
);
1793 free (fp
->ctf_header
);
1797 /* Backward compatibility. */
1799 ctf_file_close (ctf_file_t
*fp
)
1801 ctf_dict_close (fp
);
1804 /* The converse of ctf_open(). ctf_open() disguises whatever it opens as an
1805 archive, so closing one is just like closing an archive. */
1807 ctf_close (ctf_archive_t
*arc
)
1809 ctf_arc_close (arc
);
1812 /* Get the CTF archive from which this ctf_dict_t is derived. */
1814 ctf_get_arc (const ctf_dict_t
*fp
)
1816 return fp
->ctf_archive
;
1819 /* Return the ctfsect out of the core ctf_impl. Useful for freeing the
1820 ctfsect's data * after ctf_dict_close(), which is why we return the actual
1821 structure, not a pointer to it, since that is likely to become a pointer to
1822 freed data before the return value is used under the expected use case of
1823 ctf_getsect()/ ctf_dict_close()/free(). */
1825 ctf_getdatasect (const ctf_dict_t
*fp
)
1827 return fp
->ctf_data
;
1831 ctf_getsymsect (const ctf_dict_t
*fp
)
1833 return fp
->ctf_symtab
;
1837 ctf_getstrsect (const ctf_dict_t
*fp
)
1839 return fp
->ctf_strtab
;
1842 /* Set the endianness of the symbol table attached to FP. */
1844 ctf_symsect_endianness (ctf_dict_t
*fp
, int little_endian
)
1846 int old_endianness
= fp
->ctf_symsect_little_endian
;
1848 fp
->ctf_symsect_little_endian
= !!little_endian
;
1850 /* If we already have a symtab translation table, we need to repopulate it if
1851 our idea of the endianness has changed. */
1853 if (old_endianness
!= fp
->ctf_symsect_little_endian
1854 && fp
->ctf_sxlate
!= NULL
&& fp
->ctf_symtab
.cts_data
!= NULL
)
1855 assert (init_symtab (fp
, fp
->ctf_header
, &fp
->ctf_symtab
) == 0);
1858 /* Return the CTF handle for the parent CTF dict, if one exists. Otherwise
1859 return NULL to indicate this dict has no imported parent. */
1861 ctf_parent_dict (ctf_dict_t
*fp
)
1863 return fp
->ctf_parent
;
1866 /* Backward compatibility. */
1868 ctf_parent_file (ctf_dict_t
*fp
)
1870 return ctf_parent_dict (fp
);
1873 /* Return the name of the parent CTF dict, if one exists, or NULL otherwise. */
1875 ctf_parent_name (ctf_dict_t
*fp
)
1877 return fp
->ctf_parname
;
1880 /* Set the parent name. It is an error to call this routine without calling
1881 ctf_import() at some point. */
1883 ctf_parent_name_set (ctf_dict_t
*fp
, const char *name
)
1885 if (fp
->ctf_dynparname
!= NULL
)
1886 free (fp
->ctf_dynparname
);
1888 if ((fp
->ctf_dynparname
= strdup (name
)) == NULL
)
1889 return (ctf_set_errno (fp
, ENOMEM
));
1890 fp
->ctf_parname
= fp
->ctf_dynparname
;
1894 /* Return the name of the compilation unit this CTF file applies to. Usually
1895 non-NULL only for non-parent dicts. */
1897 ctf_cuname (ctf_dict_t
*fp
)
1899 return fp
->ctf_cuname
;
1902 /* Set the compilation unit name. */
1904 ctf_cuname_set (ctf_dict_t
*fp
, const char *name
)
1906 if (fp
->ctf_dyncuname
!= NULL
)
1907 free (fp
->ctf_dyncuname
);
1909 if ((fp
->ctf_dyncuname
= strdup (name
)) == NULL
)
1910 return (ctf_set_errno (fp
, ENOMEM
));
1911 fp
->ctf_cuname
= fp
->ctf_dyncuname
;
1915 /* Import the types from the specified parent dict by storing a pointer to it in
1916 ctf_parent and incrementing its reference count. Only one parent is allowed:
1917 if a parent already exists, it is replaced by the new parent. The pptrtab
1918 is wiped, and will be refreshed by the next ctf_lookup_by_name call. */
1920 ctf_import (ctf_dict_t
*fp
, ctf_dict_t
*pfp
)
1922 if (fp
== NULL
|| fp
== pfp
|| (pfp
!= NULL
&& pfp
->ctf_refcnt
== 0))
1923 return (ctf_set_errno (fp
, EINVAL
));
1925 if (pfp
!= NULL
&& pfp
->ctf_dmodel
!= fp
->ctf_dmodel
)
1926 return (ctf_set_errno (fp
, ECTF_DMODEL
));
1928 if (fp
->ctf_parent
&& !fp
->ctf_parent_unreffed
)
1929 ctf_dict_close (fp
->ctf_parent
);
1930 fp
->ctf_parent
= NULL
;
1932 free (fp
->ctf_pptrtab
);
1933 fp
->ctf_pptrtab
= NULL
;
1934 fp
->ctf_pptrtab_len
= 0;
1935 fp
->ctf_pptrtab_typemax
= 0;
1941 if (fp
->ctf_parname
== NULL
)
1942 if ((err
= ctf_parent_name_set (fp
, "PARENT")) < 0)
1945 fp
->ctf_flags
|= LCTF_CHILD
;
1947 fp
->ctf_parent_unreffed
= 0;
1950 fp
->ctf_parent
= pfp
;
1954 /* Like ctf_import, but does not increment the refcount on the imported parent
1955 or close it at any point: as a result it can go away at any time and the
1956 caller must do all freeing itself. Used internally to avoid refcount
1959 ctf_import_unref (ctf_dict_t
*fp
, ctf_dict_t
*pfp
)
1961 if (fp
== NULL
|| fp
== pfp
|| (pfp
!= NULL
&& pfp
->ctf_refcnt
== 0))
1962 return (ctf_set_errno (fp
, EINVAL
));
1964 if (pfp
!= NULL
&& pfp
->ctf_dmodel
!= fp
->ctf_dmodel
)
1965 return (ctf_set_errno (fp
, ECTF_DMODEL
));
1967 if (fp
->ctf_parent
&& !fp
->ctf_parent_unreffed
)
1968 ctf_dict_close (fp
->ctf_parent
);
1969 fp
->ctf_parent
= NULL
;
1971 free (fp
->ctf_pptrtab
);
1972 fp
->ctf_pptrtab
= NULL
;
1973 fp
->ctf_pptrtab_len
= 0;
1974 fp
->ctf_pptrtab_typemax
= 0;
1979 if (fp
->ctf_parname
== NULL
)
1980 if ((err
= ctf_parent_name_set (fp
, "PARENT")) < 0)
1983 fp
->ctf_flags
|= LCTF_CHILD
;
1984 fp
->ctf_parent_unreffed
= 1;
1987 fp
->ctf_parent
= pfp
;
1991 /* Set the data model constant for the CTF dict. */
1993 ctf_setmodel (ctf_dict_t
*fp
, int model
)
1995 const ctf_dmodel_t
*dp
;
1997 for (dp
= _libctf_models
; dp
->ctd_name
!= NULL
; dp
++)
1999 if (dp
->ctd_code
== model
)
2001 fp
->ctf_dmodel
= dp
;
2006 return (ctf_set_errno (fp
, EINVAL
));
2009 /* Return the data model constant for the CTF dict. */
2011 ctf_getmodel (ctf_dict_t
*fp
)
2013 return fp
->ctf_dmodel
->ctd_code
;
2016 /* The caller can hang an arbitrary pointer off each ctf_dict_t using this
2019 ctf_setspecific (ctf_dict_t
*fp
, void *data
)
2021 fp
->ctf_specific
= data
;
2024 /* Retrieve the arbitrary pointer again. */
2026 ctf_getspecific (ctf_dict_t
*fp
)
2028 return fp
->ctf_specific
;