[gdb/testsuite] Fix dwo path in fission-*.S
[deliverable/binutils-gdb.git] / libctf / ctf-open.c
CommitLineData
72f33921 1/* Opening CTF files.
250d07de 2 Copyright (C) 2019-2021 Free Software Foundation, Inc.
72f33921
NA
3
4 This file is part of libctf.
5
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
9 version.
10
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.
15
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/>. */
19
20#include <ctf-impl.h>
21#include <stddef.h>
22#include <string.h>
23#include <sys/types.h>
24#include <elf.h>
72f33921
NA
25#include "swap.h"
26#include <bfd.h>
27#include <zlib.h>
28
72f33921
NA
29static 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}
33};
34
35const char _CTF_SECTION[] = ".ctf";
36const char _CTF_NULLSTR[] = "";
37
38/* Version-sensitive accessors. */
39
40static uint32_t
41get_kind_v1 (uint32_t info)
42{
43 return (CTF_V1_INFO_KIND (info));
44}
45
46static uint32_t
47get_root_v1 (uint32_t info)
48{
49 return (CTF_V1_INFO_ISROOT (info));
50}
51
52static uint32_t
53get_vlen_v1 (uint32_t info)
54{
55 return (CTF_V1_INFO_VLEN (info));
56}
57
58static uint32_t
59get_kind_v2 (uint32_t info)
60{
61 return (CTF_V2_INFO_KIND (info));
62}
63
64static uint32_t
65get_root_v2 (uint32_t info)
66{
67 return (CTF_V2_INFO_ISROOT (info));
68}
69
70static uint32_t
71get_vlen_v2 (uint32_t info)
72{
73 return (CTF_V2_INFO_VLEN (info));
74}
75
76static inline ssize_t
139633c3 77get_ctt_size_common (const ctf_dict_t *fp _libctf_unused_,
72f33921
NA
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)
82{
83 ssize_t size, increment;
84
85 if (csize == ctf_lsize_sent)
86 {
87 size = lsize;
88 increment = ctf_type_size;
89 }
90 else
91 {
92 size = csize;
93 increment = ctf_stype_size;
94 }
95
96 if (sizep)
97 *sizep = size;
98 if (incrementp)
99 *incrementp = increment;
100
101 return size;
102}
103
104static ssize_t
139633c3 105get_ctt_size_v1 (const ctf_dict_t *fp, const ctf_type_t *tp,
72f33921
NA
106 ssize_t *sizep, ssize_t *incrementp)
107{
108 ctf_type_v1_t *t1p = (ctf_type_v1_t *) tp;
109
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),
113 CTF_LSIZE_SENT_V1));
114}
115
116/* Return the size that a v1 will be once it is converted to v2. */
117
118static ssize_t
139633c3 119get_ctt_size_v2_unconverted (const ctf_dict_t *fp, const ctf_type_t *tp,
72f33921
NA
120 ssize_t *sizep, ssize_t *incrementp)
121{
122 ctf_type_v1_t *t1p = (ctf_type_v1_t *) tp;
123
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),
127 CTF_LSIZE_SENT));
128}
129
130static ssize_t
139633c3 131get_ctt_size_v2 (const ctf_dict_t *fp, const ctf_type_t *tp,
72f33921
NA
132 ssize_t *sizep, ssize_t *incrementp)
133{
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),
137 CTF_LSIZE_SENT));
138}
139
140static ssize_t
139633c3 141get_vbytes_common (ctf_dict_t *fp, unsigned short kind,
926c9e76 142 ssize_t size _libctf_unused_, size_t vlen)
72f33921
NA
143{
144 switch (kind)
145 {
146 case CTF_K_INTEGER:
147 case CTF_K_FLOAT:
148 return (sizeof (uint32_t));
149 case CTF_K_SLICE:
7cee1826 150 return (sizeof (ctf_slice_t));
72f33921
NA
151 case CTF_K_ENUM:
152 return (sizeof (ctf_enum_t) * vlen);
153 case CTF_K_FORWARD:
154 case CTF_K_UNKNOWN:
155 case CTF_K_POINTER:
156 case CTF_K_TYPEDEF:
157 case CTF_K_VOLATILE:
158 case CTF_K_CONST:
159 case CTF_K_RESTRICT:
160 return 0;
161 default:
926c9e76
NA
162 ctf_set_errno (fp, ECTF_CORRUPT);
163 ctf_err_warn (fp, 0, 0, _("detected invalid CTF kind: %x"), kind);
164 return -1;
72f33921
NA
165 }
166}
167
168static ssize_t
139633c3 169get_vbytes_v1 (ctf_dict_t *fp, unsigned short kind, ssize_t size, size_t vlen)
72f33921
NA
170{
171 switch (kind)
172 {
173 case CTF_K_ARRAY:
174 return (sizeof (ctf_array_v1_t));
175 case CTF_K_FUNCTION:
176 return (sizeof (unsigned short) * (vlen + (vlen & 1)));
177 case CTF_K_STRUCT:
178 case CTF_K_UNION:
179 if (size < CTF_LSTRUCT_THRESH_V1)
180 return (sizeof (ctf_member_v1_t) * vlen);
181 else
182 return (sizeof (ctf_lmember_v1_t) * vlen);
183 }
184
926c9e76 185 return (get_vbytes_common (fp, kind, size, vlen));
72f33921
NA
186}
187
188static ssize_t
139633c3 189get_vbytes_v2 (ctf_dict_t *fp, unsigned short kind, ssize_t size, size_t vlen)
72f33921
NA
190{
191 switch (kind)
192 {
193 case CTF_K_ARRAY:
194 return (sizeof (ctf_array_t));
195 case CTF_K_FUNCTION:
196 return (sizeof (uint32_t) * (vlen + (vlen & 1)));
197 case CTF_K_STRUCT:
198 case CTF_K_UNION:
199 if (size < CTF_LSTRUCT_THRESH)
200 return (sizeof (ctf_member_t) * vlen);
201 else
202 return (sizeof (ctf_lmember_t) * vlen);
203 }
204
926c9e76 205 return (get_vbytes_common (fp, kind, size, vlen));
72f33921
NA
206}
207
139633c3 208static const ctf_dictops_t ctf_dictops[] = {
72f33921
NA
209 {NULL, NULL, NULL, NULL, NULL},
210 /* CTF_VERSION_1 */
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},
214 /* CTF_VERSION_2 */
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},
218};
219
1136c379
NA
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.)
228
53651de8
NA
229 The SP symbol table section may be NULL if there is no symtab.
230
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. */
72f33921
NA
233
234static int
1136c379 235init_symtab (ctf_dict_t *fp, const ctf_header_t *hp, const ctf_sect_t *sp)
72f33921 236{
1136c379
NA
237 const unsigned char *symp;
238 int skip_func_info = 0;
239 int i;
72f33921
NA
240 uint32_t *xp = fp->ctf_sxlate;
241 uint32_t *xend = xp + fp->ctf_nsyms;
242
243 uint32_t objtoff = hp->cth_objtoff;
244 uint32_t funcoff = hp->cth_funcoff;
245
1136c379
NA
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
248 understand. */
249
250 if (!(hp->cth_flags & CTF_F_NEWFUNCINFO))
251 skip_func_info = 1;
252
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);
257
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)
261 return 0;
262
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. */
271
272 for (i = 0, symp = sp->cts_data; xp < xend; xp++, symp += sp->cts_entsize,
273 i++)
72f33921 274 {
1136c379 275 ctf_link_sym_t sym;
72f33921 276
1136c379
NA
277 switch (sp->cts_entsize)
278 {
279 case sizeof (Elf64_Sym):
280 {
281 const Elf64_Sym *symp64 = (Elf64_Sym *) (uintptr_t) symp;
282 ctf_elf64_to_link_sym (fp, &sym, symp64, i);
283 }
284 break;
285 case sizeof (Elf32_Sym):
286 {
287 const Elf32_Sym *symp32 = (Elf32_Sym *) (uintptr_t) symp;
288 ctf_elf32_to_link_sym (fp, &sym, symp32, i);
289 }
290 break;
291 default:
292 return ECTF_SYMTAB;
293 }
72f33921 294
53651de8
NA
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
298 force. */
1136c379 299 if (ctf_symtab_skippable (&sym))
72f33921
NA
300 {
301 *xp = -1u;
302 continue;
303 }
304
1136c379 305 switch (sym.st_type)
72f33921
NA
306 {
307 case STT_OBJECT:
1136c379 308 if (fp->ctf_objtidx_names || objtoff >= hp->cth_funcoff)
72f33921
NA
309 {
310 *xp = -1u;
311 break;
312 }
313
314 *xp = objtoff;
315 objtoff += sizeof (uint32_t);
316 break;
317
318 case STT_FUNC:
1136c379
NA
319 if (fp->ctf_funcidx_names || funcoff >= hp->cth_objtidxoff
320 || skip_func_info)
72f33921
NA
321 {
322 *xp = -1u;
323 break;
324 }
325
326 *xp = funcoff;
1136c379 327 funcoff += sizeof (uint32_t);
72f33921
NA
328 break;
329
330 default:
331 *xp = -1u;
332 break;
333 }
334 }
335
336 ctf_dprintf ("loaded %lu symtab entries\n", fp->ctf_nsyms);
337 return 0;
338}
339
fd55eae8 340/* Reset the CTF base pointer and derive the buf pointer from it, initializing
139633c3 341 everything in the ctf_dict that depends on the base or buf pointers.
fd55eae8
NA
342
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
345 never used. */
72f33921
NA
346
347static void
139633c3 348ctf_set_base (ctf_dict_t *fp, const ctf_header_t *hp, unsigned char *base)
72f33921 349{
fd55eae8 350 fp->ctf_buf = base + (fp->ctf_buf - fp->ctf_base);
72f33921 351 fp->ctf_base = base;
72f33921
NA
352 fp->ctf_vars = (ctf_varent_t *) ((const char *) fp->ctf_buf +
353 hp->cth_varoff);
354 fp->ctf_nvars = (hp->cth_typeoff - hp->cth_varoff) / sizeof (ctf_varent_t);
355
356 fp->ctf_str[CTF_STRTAB_0].cts_strs = (const char *) fp->ctf_buf
357 + hp->cth_stroff;
358 fp->ctf_str[CTF_STRTAB_0].cts_len = hp->cth_strlen;
359
139633c3
NA
360 /* If we have a parent dict name and label, store the relocated string
361 pointers in the CTF dict for easy access later. */
72f33921
NA
362
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. */
366
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);
fd55eae8
NA
371 if (hp->cth_cuname != 0)
372 fp->ctf_cuname = ctf_strptr (fp, hp->cth_cuname);
373
374 if (fp->ctf_cuname)
375 ctf_dprintf ("ctf_set_base: CU name %s\n", fp->ctf_cuname);
376 if (fp->ctf_parname)
377 ctf_dprintf ("ctf_set_base: parent name %s (label %s)\n",
378 fp->ctf_parname,
72f33921
NA
379 fp->ctf_parlabel ? fp->ctf_parlabel : "<NULL>");
380}
381
72f33921
NA
382/* Set the version of the CTF file. */
383
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. */
387
388static void
139633c3 389ctf_set_version (ctf_dict_t *fp, ctf_header_t *cth, int ctf_version)
72f33921
NA
390{
391 fp->ctf_version = ctf_version;
392 cth->cth_version = ctf_version;
139633c3 393 fp->ctf_dictops = &ctf_dictops[ctf_version];
72f33921
NA
394}
395
fd55eae8
NA
396
397/* Upgrade the header to CTF_VERSION_3. The upgrade is done in-place. */
398static void
399upgrade_header (ctf_header_t *hp)
400{
401 ctf_header_v2_t *oldhp = (ctf_header_v2_t *) hp;
402
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;
2db912ba
NA
407 hp->cth_funcidxoff = hp->cth_varoff; /* No index sections. */
408 hp->cth_objtidxoff = hp->cth_funcidxoff;
fd55eae8
NA
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. */
413}
414
415/* Upgrade the type table to CTF_VERSION_3 (really CTF_VERSION_1_UPGRADED_3)
416 from CTF_VERSION_1.
72f33921
NA
417
418 The upgrade is not done in-place: the ctf_base is moved. ctf_strptr() must
419 not be called before reallocation is complete.
420
2db912ba
NA
421 Sections not checked here due to nonexistence or nonpopulated state in older
422 formats: objtidx, funcidx.
423
72f33921
NA
424 Type kinds not checked here due to nonexistence in older formats:
425 CTF_K_SLICE. */
426static int
139633c3 427upgrade_types_v1 (ctf_dict_t *fp, ctf_header_t *cth)
72f33921
NA
428{
429 const ctf_type_v1_t *tbuf;
430 const ctf_type_v1_t *tend;
fd55eae8 431 unsigned char *ctf_base, *old_ctf_base = (unsigned char *) fp->ctf_dynbase;
72f33921
NA
432 ctf_type_t *t2buf;
433
434 ssize_t increase = 0, size, increment, v2increment, vbytes, v2bytes;
435 const ctf_type_v1_t *tp;
436 ctf_type_t *t2p;
72f33921
NA
437
438 tbuf = (ctf_type_v1_t *) (fp->ctf_buf + cth->cth_typeoff);
439 tend = (ctf_type_v1_t *) (fp->ctf_buf + cth->cth_stroff);
440
441 /* Much like init_types(), this is a two-pass process.
442
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.)
447
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. */
451
452 for (tp = tbuf; tp < tend;
453 tp = (ctf_type_v1_t *) ((uintptr_t) tp + increment + vbytes))
454 {
455 unsigned short kind = CTF_V1_INFO_KIND (tp->ctt_info);
456 unsigned long vlen = CTF_V1_INFO_VLEN (tp->ctt_info);
457
458 size = get_ctt_size_v1 (fp, (const ctf_type_t *) tp, NULL, &increment);
926c9e76 459 vbytes = get_vbytes_v1 (fp, kind, size, vlen);
72f33921
NA
460
461 get_ctt_size_v2_unconverted (fp, (const ctf_type_t *) tp, NULL,
462 &v2increment);
926c9e76 463 v2bytes = get_vbytes_v2 (fp, kind, size, vlen);
72f33921
NA
464
465 if ((vbytes < 0) || (size < 0))
466 return ECTF_CORRUPT;
467
468 increase += v2increment - increment; /* May be negative. */
469 increase += v2bytes - vbytes;
470 }
471
fd55eae8
NA
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
72f33921
NA
475 as-yet-untranslated type info. */
476
de07e349 477 if ((ctf_base = malloc (fp->ctf_size + increase)) == NULL)
72f33921
NA
478 return ECTF_ZALLOC;
479
fd55eae8
NA
480 /* Start at ctf_buf, not ctf_base, to squeeze out the original header: we
481 never use it and it is unconverted. */
72f33921 482
fd55eae8
NA
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);
72f33921 486
fd55eae8
NA
487 memset (ctf_base + cth->cth_typeoff, 0, cth->cth_stroff - cth->cth_typeoff
488 + increase);
72f33921 489
fd55eae8 490 cth->cth_stroff += increase;
72f33921 491 fp->ctf_size += increase;
fd55eae8
NA
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);
72f33921 497
fd55eae8 498 t2buf = (ctf_type_t *) (fp->ctf_buf + cth->cth_typeoff);
72f33921
NA
499
500 /* Iterate through all the types again, upgrading them.
501
502 Everything that hasn't changed can just be outright memcpy()ed.
503 Things that have changed need field-by-field consideration. */
504
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))
508 {
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);
512 ssize_t v2size;
513 void *vdata, *v2data;
514
515 size = get_ctt_size_v1 (fp, (const ctf_type_t *) tp, NULL, &increment);
926c9e76 516 vbytes = get_vbytes_v1 (fp, kind, size, vlen);
72f33921
NA
517
518 t2p->ctt_name = tp->ctt_name;
519 t2p->ctt_info = CTF_TYPE_INFO (kind, isroot, vlen);
520
521 switch (kind)
522 {
523 case CTF_K_FUNCTION:
524 case CTF_K_FORWARD:
525 case CTF_K_TYPEDEF:
526 case CTF_K_POINTER:
527 case CTF_K_VOLATILE:
528 case CTF_K_CONST:
529 case CTF_K_RESTRICT:
530 t2p->ctt_type = tp->ctt_type;
531 break;
532 case CTF_K_INTEGER:
533 case CTF_K_FLOAT:
534 case CTF_K_ARRAY:
535 case CTF_K_STRUCT:
536 case CTF_K_UNION:
537 case CTF_K_ENUM:
538 case CTF_K_UNKNOWN:
a0486bac 539 if ((size_t) size <= CTF_MAX_SIZE)
72f33921
NA
540 t2p->ctt_size = size;
541 else
542 {
543 t2p->ctt_lsizehi = CTF_SIZE_TO_LSIZE_HI (size);
544 t2p->ctt_lsizelo = CTF_SIZE_TO_LSIZE_LO (size);
545 }
546 break;
547 }
548
549 v2size = get_ctt_size_v2 (fp, t2p, NULL, &v2increment);
926c9e76 550 v2bytes = get_vbytes_v2 (fp, kind, v2size, vlen);
72f33921
NA
551
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). */
555
556 assert (size == v2size);
557
558 /* Now the varlen info. */
559
560 vdata = (void *) ((uintptr_t) tp + increment);
561 v2data = (void *) ((uintptr_t) t2p + v2increment);
562
563 switch (kind)
564 {
565 case CTF_K_ARRAY:
566 {
567 const ctf_array_v1_t *ap = (const ctf_array_v1_t *) vdata;
568 ctf_array_t *a2p = (ctf_array_t *) v2data;
569
570 a2p->cta_contents = ap->cta_contents;
571 a2p->cta_index = ap->cta_index;
572 a2p->cta_nelems = ap->cta_nelems;
573 break;
574 }
575 case CTF_K_STRUCT:
576 case CTF_K_UNION:
577 {
578 ctf_member_t tmp;
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;
583 unsigned long i;
584
585 /* We walk all four pointers forward, but only reference the two
586 that are valid for the given size, to avoid quadruplicating all
587 the code. */
588
589 for (i = vlen; i != 0; i--, m1++, lm1++, m2++, lm2++)
590 {
591 size_t offset;
592 if (size < CTF_LSTRUCT_THRESH_V1)
593 {
594 offset = m1->ctm_offset;
595 tmp.ctm_name = m1->ctm_name;
596 tmp.ctm_type = m1->ctm_type;
597 }
598 else
599 {
600 offset = CTF_LMEM_OFFSET (lm1);
601 tmp.ctm_name = lm1->ctlm_name;
602 tmp.ctm_type = lm1->ctlm_type;
603 }
604 if (size < CTF_LSTRUCT_THRESH)
605 {
606 m2->ctm_name = tmp.ctm_name;
607 m2->ctm_type = tmp.ctm_type;
608 m2->ctm_offset = offset;
609 }
610 else
611 {
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);
616 }
617 }
618 break;
619 }
620 case CTF_K_FUNCTION:
621 {
622 unsigned long i;
623 unsigned short *a1 = (unsigned short *) vdata;
624 uint32_t *a2 = (uint32_t *) v2data;
625
626 for (i = vlen; i != 0; i--, a1++, a2++)
627 *a2 = *a1;
628 }
629 /* FALLTHRU */
630 default:
631 /* Catch out-of-sync get_vbytes_*(). */
632 assert (vbytes == v2bytes);
633 memcpy (v2data, vdata, vbytes);
634 }
635 }
636
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().) */
640
fd55eae8 641 assert ((size_t) t2p - (size_t) fp->ctf_buf == cth->cth_stroff);
72f33921 642
fd55eae8 643 ctf_set_version (fp, cth, CTF_VERSION_1_UPGRADED_3);
de07e349 644 free (old_ctf_base);
72f33921
NA
645
646 return 0;
647}
648
fd55eae8
NA
649/* Upgrade from any earlier version. */
650static int
139633c3 651upgrade_types (ctf_dict_t *fp, ctf_header_t *cth)
fd55eae8
NA
652{
653 switch (cth->cth_version)
654 {
655 /* v1 requires a full pass and reformatting. */
656 case CTF_VERSION_1:
657 upgrade_types_v1 (fp, cth);
658 /* FALLTHRU */
659 /* Already-converted v1 is just like later versions except that its
660 parent/child boundary is unchanged (and much lower). */
661
662 case CTF_VERSION_1_UPGRADED_3:
663 fp->ctf_parmax = CTF_MAX_PTYPE_V1;
664
665 /* v2 is just the same as v3 except for new types and sections:
666 no upgrading required. */
667 case CTF_VERSION_2: ;
668 /* FALLTHRU */
669 }
670 return 0;
671}
672
72f33921
NA
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. */
677
678static int
139633c3 679init_types (ctf_dict_t *fp, ctf_header_t *cth)
72f33921
NA
680{
681 const ctf_type_t *tbuf;
682 const ctf_type_t *tend;
683
684 unsigned long pop[CTF_K_MAX + 1] = { 0 };
685 const ctf_type_t *tp;
78f28b89 686 uint32_t id;
72f33921
NA
687 uint32_t *xp;
688
139633c3
NA
689 /* We determine whether the dict is a child or a parent based on the value of
690 cth_parname. */
72f33921
NA
691
692 int child = cth->cth_parname != 0;
693 int nlstructs = 0, nlunions = 0;
694 int err;
695
676c3ecb
NA
696 assert (!(fp->ctf_flags & LCTF_RDWR));
697
72f33921
NA
698 if (_libctf_unlikely_ (fp->ctf_version == CTF_VERSION_1))
699 {
700 int err;
701 if ((err = upgrade_types (fp, cth)) != 0)
702 return err; /* Upgrade failed. */
703 }
704
705 tbuf = (ctf_type_t *) (fp->ctf_buf + cth->cth_typeoff);
706 tend = (ctf_type_t *) (fp->ctf_buf + cth->cth_stroff);
707
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. */
710
711 for (tp = tbuf; tp < tend; fp->ctf_typemax++)
712 {
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;
716
717 (void) ctf_get_ctt_size (fp, tp, &size, &increment);
718 vbytes = LCTF_VBYTES (fp, kind, size, vlen);
719
720 if (vbytes < 0)
721 return ECTF_CORRUPT;
722
2484ca43
NA
723 /* For forward declarations, ctt_type is the CTF_K_* kind for the tag,
724 so bump that population count too. */
72f33921 725 if (kind == CTF_K_FORWARD)
2484ca43 726 pop[tp->ctt_type]++;
72f33921 727
72f33921
NA
728 tp = (ctf_type_t *) ((uintptr_t) tp + increment + vbytes);
729 pop[kind]++;
730 }
731
732 if (child)
733 {
139633c3 734 ctf_dprintf ("CTF dict %p is a child\n", (void *) fp);
72f33921
NA
735 fp->ctf_flags |= LCTF_CHILD;
736 }
737 else
139633c3 738 ctf_dprintf ("CTF dict %p is a parent\n", (void *) fp);
72f33921
NA
739
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. */
742
676c3ecb
NA
743 if ((fp->ctf_structs.ctn_readonly
744 = ctf_hash_create (pop[CTF_K_STRUCT], ctf_hash_string,
745 ctf_hash_eq_string)) == NULL)
72f33921
NA
746 return ENOMEM;
747
676c3ecb
NA
748 if ((fp->ctf_unions.ctn_readonly
749 = ctf_hash_create (pop[CTF_K_UNION], ctf_hash_string,
750 ctf_hash_eq_string)) == NULL)
72f33921
NA
751 return ENOMEM;
752
676c3ecb
NA
753 if ((fp->ctf_enums.ctn_readonly
754 = ctf_hash_create (pop[CTF_K_ENUM], ctf_hash_string,
755 ctf_hash_eq_string)) == NULL)
72f33921
NA
756 return ENOMEM;
757
676c3ecb 758 if ((fp->ctf_names.ctn_readonly
49da556c
NA
759 = ctf_hash_create (pop[CTF_K_UNKNOWN] +
760 pop[CTF_K_INTEGER] +
676c3ecb
NA
761 pop[CTF_K_FLOAT] +
762 pop[CTF_K_FUNCTION] +
763 pop[CTF_K_TYPEDEF] +
764 pop[CTF_K_POINTER] +
765 pop[CTF_K_VOLATILE] +
766 pop[CTF_K_CONST] +
767 pop[CTF_K_RESTRICT],
768 ctf_hash_string,
769 ctf_hash_eq_string)) == NULL)
72f33921
NA
770 return ENOMEM;
771
de07e349 772 fp->ctf_txlate = malloc (sizeof (uint32_t) * (fp->ctf_typemax + 1));
676c3ecb 773 fp->ctf_ptrtab_len = fp->ctf_typemax + 1;
de07e349 774 fp->ctf_ptrtab = malloc (sizeof (uint32_t) * fp->ctf_ptrtab_len);
72f33921
NA
775
776 if (fp->ctf_txlate == NULL || fp->ctf_ptrtab == NULL)
777 return ENOMEM; /* Memory allocation failed. */
778
779 xp = fp->ctf_txlate;
780 *xp++ = 0; /* Type id 0 is used as a sentinel value. */
781
782 memset (fp->ctf_txlate, 0, sizeof (uint32_t) * (fp->ctf_typemax + 1));
783 memset (fp->ctf_ptrtab, 0, sizeof (uint32_t) * (fp->ctf_typemax + 1));
784
785 /* In the second pass through the types, we fill in each entry of the
786 type and pointer tables and add names to the appropriate hashes. */
787
788 for (id = 1, tp = tbuf; tp < tend; xp++, id++)
789 {
790 unsigned short kind = LCTF_INFO_KIND (fp, tp->ctt_info);
fe4c2d55 791 unsigned short isroot = LCTF_INFO_ISROOT (fp, tp->ctt_info);
72f33921
NA
792 unsigned long vlen = LCTF_INFO_VLEN (fp, tp->ctt_info);
793 ssize_t size, increment, vbytes;
794
795 const char *name;
796
797 (void) ctf_get_ctt_size (fp, tp, &size, &increment);
798 name = ctf_strptr (fp, tp->ctt_name);
926c9e76 799 /* Cannot fail: shielded by call in loop above. */
72f33921
NA
800 vbytes = LCTF_VBYTES (fp, kind, size, vlen);
801
802 switch (kind)
803 {
49da556c 804 case CTF_K_UNKNOWN:
72f33921
NA
805 case CTF_K_INTEGER:
806 case CTF_K_FLOAT:
807 /* Names are reused by bit-fields, which are differentiated by their
808 encodings, and so typically we'd record only the first instance of
809 a given intrinsic. However, we replace an existing type with a
810 root-visible version so that we can be sure to find it when
811 checking for conflicting definitions in ctf_add_type(). */
812
676c3ecb
NA
813 if (((ctf_hash_lookup_type (fp->ctf_names.ctn_readonly,
814 fp, name)) == 0)
fe4c2d55 815 || isroot)
72f33921 816 {
676c3ecb 817 err = ctf_hash_define_type (fp->ctf_names.ctn_readonly, fp,
72f33921
NA
818 LCTF_INDEX_TO_TYPE (fp, id, child),
819 tp->ctt_name);
d851ecd3 820 if (err != 0)
72f33921
NA
821 return err;
822 }
823 break;
824
825 /* These kinds have no name, so do not need interning into any
826 hashtables. */
827 case CTF_K_ARRAY:
828 case CTF_K_SLICE:
829 break;
830
831 case CTF_K_FUNCTION:
fe4c2d55
NA
832 if (!isroot)
833 break;
834
676c3ecb 835 err = ctf_hash_insert_type (fp->ctf_names.ctn_readonly, fp,
72f33921
NA
836 LCTF_INDEX_TO_TYPE (fp, id, child),
837 tp->ctt_name);
d851ecd3 838 if (err != 0)
72f33921
NA
839 return err;
840 break;
841
842 case CTF_K_STRUCT:
fe4c2d55
NA
843 if (size >= CTF_LSTRUCT_THRESH)
844 nlstructs++;
845
846 if (!isroot)
847 break;
848
676c3ecb 849 err = ctf_hash_define_type (fp->ctf_structs.ctn_readonly, fp,
72f33921
NA
850 LCTF_INDEX_TO_TYPE (fp, id, child),
851 tp->ctt_name);
852
d851ecd3 853 if (err != 0)
72f33921
NA
854 return err;
855
72f33921
NA
856 break;
857
858 case CTF_K_UNION:
fe4c2d55
NA
859 if (size >= CTF_LSTRUCT_THRESH)
860 nlunions++;
861
862 if (!isroot)
863 break;
864
676c3ecb 865 err = ctf_hash_define_type (fp->ctf_unions.ctn_readonly, fp,
72f33921
NA
866 LCTF_INDEX_TO_TYPE (fp, id, child),
867 tp->ctt_name);
868
d851ecd3 869 if (err != 0)
72f33921 870 return err;
72f33921
NA
871 break;
872
873 case CTF_K_ENUM:
fe4c2d55
NA
874 if (!isroot)
875 break;
876
676c3ecb 877 err = ctf_hash_define_type (fp->ctf_enums.ctn_readonly, fp,
72f33921
NA
878 LCTF_INDEX_TO_TYPE (fp, id, child),
879 tp->ctt_name);
880
d851ecd3 881 if (err != 0)
72f33921
NA
882 return err;
883 break;
884
885 case CTF_K_TYPEDEF:
fe4c2d55
NA
886 if (!isroot)
887 break;
888
676c3ecb 889 err = ctf_hash_insert_type (fp->ctf_names.ctn_readonly, fp,
72f33921
NA
890 LCTF_INDEX_TO_TYPE (fp, id, child),
891 tp->ctt_name);
d851ecd3 892 if (err != 0)
72f33921
NA
893 return err;
894 break;
895
896 case CTF_K_FORWARD:
676c3ecb
NA
897 {
898 ctf_names_t *np = ctf_name_table (fp, tp->ctt_type);
fe4c2d55
NA
899
900 if (!isroot)
901 break;
902
676c3ecb
NA
903 /* Only insert forward tags into the given hash if the type or tag
904 name is not already present. */
905 if (ctf_hash_lookup_type (np->ctn_readonly, fp, name) == 0)
906 {
907 err = ctf_hash_insert_type (np->ctn_readonly, fp,
908 LCTF_INDEX_TO_TYPE (fp, id, child),
909 tp->ctt_name);
910 if (err != 0)
911 return err;
912 }
913 break;
914 }
72f33921
NA
915
916 case CTF_K_POINTER:
139633c3
NA
917 /* If the type referenced by the pointer is in this CTF dict, then
918 store the index of the pointer type in fp->ctf_ptrtab[ index of
919 referenced type ]. */
72f33921
NA
920
921 if (LCTF_TYPE_ISCHILD (fp, tp->ctt_type) == child
922 && LCTF_TYPE_TO_INDEX (fp, tp->ctt_type) <= fp->ctf_typemax)
923 fp->ctf_ptrtab[LCTF_TYPE_TO_INDEX (fp, tp->ctt_type)] = id;
924 /*FALLTHRU*/
925
926 case CTF_K_VOLATILE:
927 case CTF_K_CONST:
928 case CTF_K_RESTRICT:
fe4c2d55
NA
929 if (!isroot)
930 break;
931
676c3ecb 932 err = ctf_hash_insert_type (fp->ctf_names.ctn_readonly, fp,
72f33921
NA
933 LCTF_INDEX_TO_TYPE (fp, id, child),
934 tp->ctt_name);
d851ecd3 935 if (err != 0)
72f33921
NA
936 return err;
937 break;
0b4fa56e 938 default:
926c9e76
NA
939 ctf_err_warn (fp, 0, ECTF_CORRUPT,
940 _("init_types(): unhandled CTF kind: %x"), kind);
0b4fa56e 941 return ECTF_CORRUPT;
72f33921
NA
942 }
943
944 *xp = (uint32_t) ((uintptr_t) tp - (uintptr_t) fp->ctf_buf);
945 tp = (ctf_type_t *) ((uintptr_t) tp + increment + vbytes);
946 }
947
948 ctf_dprintf ("%lu total types processed\n", fp->ctf_typemax);
676c3ecb
NA
949 ctf_dprintf ("%u enum names hashed\n",
950 ctf_hash_size (fp->ctf_enums.ctn_readonly));
72f33921 951 ctf_dprintf ("%u struct names hashed (%d long)\n",
676c3ecb 952 ctf_hash_size (fp->ctf_structs.ctn_readonly), nlstructs);
72f33921 953 ctf_dprintf ("%u union names hashed (%d long)\n",
676c3ecb
NA
954 ctf_hash_size (fp->ctf_unions.ctn_readonly), nlunions);
955 ctf_dprintf ("%u base type names hashed\n",
956 ctf_hash_size (fp->ctf_names.ctn_readonly));
72f33921 957
72f33921
NA
958 return 0;
959}
960
961/* Endianness-flipping routines.
962
963 We flip everything, mindlessly, even 1-byte entities, so that future
964 expansions do not require changes to this code. */
965
72f33921
NA
966/* Flip the endianness of the CTF header. */
967
968static void
969flip_header (ctf_header_t *cth)
970{
971 swap_thing (cth->cth_preamble.ctp_magic);
972 swap_thing (cth->cth_preamble.ctp_version);
973 swap_thing (cth->cth_preamble.ctp_flags);
974 swap_thing (cth->cth_parlabel);
975 swap_thing (cth->cth_parname);
fd55eae8 976 swap_thing (cth->cth_cuname);
72f33921
NA
977 swap_thing (cth->cth_objtoff);
978 swap_thing (cth->cth_funcoff);
2db912ba
NA
979 swap_thing (cth->cth_objtidxoff);
980 swap_thing (cth->cth_funcidxoff);
72f33921
NA
981 swap_thing (cth->cth_varoff);
982 swap_thing (cth->cth_typeoff);
983 swap_thing (cth->cth_stroff);
984 swap_thing (cth->cth_strlen);
985}
986
987/* Flip the endianness of the label section, an array of ctf_lblent_t. */
988
989static void
990flip_lbls (void *start, size_t len)
991{
992 ctf_lblent_t *lbl = start;
5ae6af75 993 ssize_t i;
72f33921 994
5ae6af75 995 for (i = len / sizeof (struct ctf_lblent); i > 0; lbl++, i--)
72f33921
NA
996 {
997 swap_thing (lbl->ctl_label);
998 swap_thing (lbl->ctl_type);
999 }
1000}
1001
2db912ba 1002/* Flip the endianness of the data-object or function sections or their indexes,
1136c379 1003 all arrays of uint32_t. */
72f33921
NA
1004
1005static void
1006flip_objts (void *start, size_t len)
1007{
1008 uint32_t *obj = start;
5ae6af75 1009 ssize_t i;
72f33921 1010
5ae6af75 1011 for (i = len / sizeof (uint32_t); i > 0; obj++, i--)
72f33921
NA
1012 swap_thing (*obj);
1013}
1014
1015/* Flip the endianness of the variable section, an array of ctf_varent_t. */
1016
1017static void
1018flip_vars (void *start, size_t len)
1019{
1020 ctf_varent_t *var = start;
5ae6af75 1021 ssize_t i;
72f33921 1022
5ae6af75 1023 for (i = len / sizeof (struct ctf_varent); i > 0; var++, i--)
72f33921
NA
1024 {
1025 swap_thing (var->ctv_name);
1026 swap_thing (var->ctv_type);
1027 }
1028}
1029
1030/* Flip the endianness of the type section, a tagged array of ctf_type or
1031 ctf_stype followed by variable data. */
1032
1033static int
139633c3 1034flip_types (ctf_dict_t *fp, void *start, size_t len)
72f33921
NA
1035{
1036 ctf_type_t *t = start;
1037
1038 while ((uintptr_t) t < ((uintptr_t) start) + len)
1039 {
1040 swap_thing (t->ctt_name);
1041 swap_thing (t->ctt_info);
1042 swap_thing (t->ctt_size);
1043
1044 uint32_t kind = CTF_V2_INFO_KIND (t->ctt_info);
1045 size_t size = t->ctt_size;
1046 uint32_t vlen = CTF_V2_INFO_VLEN (t->ctt_info);
926c9e76 1047 size_t vbytes = get_vbytes_v2 (fp, kind, size, vlen);
72f33921
NA
1048
1049 if (_libctf_unlikely_ (size == CTF_LSIZE_SENT))
1050 {
1051 swap_thing (t->ctt_lsizehi);
1052 swap_thing (t->ctt_lsizelo);
1053 size = CTF_TYPE_LSIZE (t);
1054 t = (ctf_type_t *) ((uintptr_t) t + sizeof (ctf_type_t));
1055 }
1056 else
1057 t = (ctf_type_t *) ((uintptr_t) t + sizeof (ctf_stype_t));
1058
1059 switch (kind)
1060 {
1061 case CTF_K_FORWARD:
1062 case CTF_K_UNKNOWN:
1063 case CTF_K_POINTER:
1064 case CTF_K_TYPEDEF:
1065 case CTF_K_VOLATILE:
1066 case CTF_K_CONST:
1067 case CTF_K_RESTRICT:
1068 /* These types have no vlen data to swap. */
1069 assert (vbytes == 0);
1070 break;
1071
1072 case CTF_K_INTEGER:
1073 case CTF_K_FLOAT:
1074 {
1075 /* These types have a single uint32_t. */
1076
1077 uint32_t *item = (uint32_t *) t;
1078
1079 swap_thing (*item);
1080 break;
1081 }
1082
1083 case CTF_K_FUNCTION:
1084 {
1085 /* This type has a bunch of uint32_ts. */
1086
1087 uint32_t *item = (uint32_t *) t;
5ae6af75 1088 ssize_t i;
72f33921 1089
5ae6af75 1090 for (i = vlen; i > 0; item++, i--)
72f33921
NA
1091 swap_thing (*item);
1092 break;
1093 }
1094
1095 case CTF_K_ARRAY:
1096 {
1097 /* This has a single ctf_array_t. */
1098
1099 ctf_array_t *a = (ctf_array_t *) t;
1100
1101 assert (vbytes == sizeof (ctf_array_t));
1102 swap_thing (a->cta_contents);
1103 swap_thing (a->cta_index);
1104 swap_thing (a->cta_nelems);
1105
1106 break;
1107 }
1108
1109 case CTF_K_SLICE:
1110 {
1111 /* This has a single ctf_slice_t. */
1112
1113 ctf_slice_t *s = (ctf_slice_t *) t;
1114
1115 assert (vbytes == sizeof (ctf_slice_t));
1116 swap_thing (s->cts_type);
1117 swap_thing (s->cts_offset);
1118 swap_thing (s->cts_bits);
1119
1120 break;
1121 }
1122
1123 case CTF_K_STRUCT:
1124 case CTF_K_UNION:
1125 {
1126 /* This has an array of ctf_member or ctf_lmember, depending on
1127 size. We could consider it to be a simple array of uint32_t,
1128 but for safety's sake in case these structures ever acquire
1129 non-uint32_t members, do it member by member. */
1130
1131 if (_libctf_unlikely_ (size >= CTF_LSTRUCT_THRESH))
1132 {
1133 ctf_lmember_t *lm = (ctf_lmember_t *) t;
5ae6af75
NA
1134 ssize_t i;
1135 for (i = vlen; i > 0; i--, lm++)
72f33921
NA
1136 {
1137 swap_thing (lm->ctlm_name);
1138 swap_thing (lm->ctlm_offsethi);
1139 swap_thing (lm->ctlm_type);
1140 swap_thing (lm->ctlm_offsetlo);
1141 }
1142 }
1143 else
1144 {
1145 ctf_member_t *m = (ctf_member_t *) t;
5ae6af75
NA
1146 ssize_t i;
1147 for (i = vlen; i > 0; i--, m++)
72f33921
NA
1148 {
1149 swap_thing (m->ctm_name);
1150 swap_thing (m->ctm_offset);
1151 swap_thing (m->ctm_type);
1152 }
1153 }
1154 break;
1155 }
1156
1157 case CTF_K_ENUM:
1158 {
1159 /* This has an array of ctf_enum_t. */
1160
1161 ctf_enum_t *item = (ctf_enum_t *) t;
5ae6af75 1162 ssize_t i;
72f33921 1163
5ae6af75 1164 for (i = vlen; i > 0; item++, i--)
72f33921
NA
1165 {
1166 swap_thing (item->cte_name);
1167 swap_thing (item->cte_value);
1168 }
1169 break;
1170 }
1171 default:
926c9e76
NA
1172 ctf_err_warn (fp, 0, ECTF_CORRUPT,
1173 _("unhandled CTF kind in endianness conversion: %x"),
1174 kind);
72f33921
NA
1175 return ECTF_CORRUPT;
1176 }
1177
1178 t = (ctf_type_t *) ((uintptr_t) t + vbytes);
1179 }
1180
1181 return 0;
1182}
1183
fd55eae8 1184/* Flip the endianness of BUF, given the offsets in the (already endian-
72f33921
NA
1185 converted) CTH.
1186
1187 All of this stuff happens before the header is fully initialized, so the
1188 LCTF_*() macros cannot be used yet. Since we do not try to endian-convert v1
1189 data, this is no real loss. */
1190
1191static int
139633c3 1192flip_ctf (ctf_dict_t *fp, ctf_header_t *cth, unsigned char *buf)
72f33921 1193{
fd55eae8
NA
1194 flip_lbls (buf + cth->cth_lbloff, cth->cth_objtoff - cth->cth_lbloff);
1195 flip_objts (buf + cth->cth_objtoff, cth->cth_funcoff - cth->cth_objtoff);
2db912ba
NA
1196 flip_objts (buf + cth->cth_funcoff, cth->cth_objtidxoff - cth->cth_funcoff);
1197 flip_objts (buf + cth->cth_objtidxoff, cth->cth_funcidxoff - cth->cth_objtidxoff);
1198 flip_objts (buf + cth->cth_funcidxoff, cth->cth_varoff - cth->cth_funcidxoff);
fd55eae8 1199 flip_vars (buf + cth->cth_varoff, cth->cth_typeoff - cth->cth_varoff);
926c9e76 1200 return flip_types (fp, buf + cth->cth_typeoff, cth->cth_stroff - cth->cth_typeoff);
72f33921
NA
1201}
1202
139633c3 1203/* Set up the ctl hashes in a ctf_dict_t. Called by both writable and
676c3ecb 1204 non-writable dictionary initialization. */
139633c3 1205void ctf_set_ctl_hashes (ctf_dict_t *fp)
676c3ecb
NA
1206{
1207 /* Initialize the ctf_lookup_by_name top-level dictionary. We keep an
1208 array of type name prefixes and the corresponding ctf_hash to use. */
1209 fp->ctf_lookups[0].ctl_prefix = "struct";
1210 fp->ctf_lookups[0].ctl_len = strlen (fp->ctf_lookups[0].ctl_prefix);
1211 fp->ctf_lookups[0].ctl_hash = &fp->ctf_structs;
1212 fp->ctf_lookups[1].ctl_prefix = "union";
1213 fp->ctf_lookups[1].ctl_len = strlen (fp->ctf_lookups[1].ctl_prefix);
1214 fp->ctf_lookups[1].ctl_hash = &fp->ctf_unions;
1215 fp->ctf_lookups[2].ctl_prefix = "enum";
1216 fp->ctf_lookups[2].ctl_len = strlen (fp->ctf_lookups[2].ctl_prefix);
1217 fp->ctf_lookups[2].ctl_hash = &fp->ctf_enums;
1218 fp->ctf_lookups[3].ctl_prefix = _CTF_NULLSTR;
1219 fp->ctf_lookups[3].ctl_len = strlen (fp->ctf_lookups[3].ctl_prefix);
1220 fp->ctf_lookups[3].ctl_hash = &fp->ctf_names;
1221 fp->ctf_lookups[4].ctl_prefix = NULL;
1222 fp->ctf_lookups[4].ctl_len = 0;
1223 fp->ctf_lookups[4].ctl_hash = NULL;
1224}
1225
72f33921 1226/* Open a CTF file, mocking up a suitable ctf_sect. */
d851ecd3 1227
139633c3 1228ctf_dict_t *ctf_simple_open (const char *ctfsect, size_t ctfsect_size,
72f33921
NA
1229 const char *symsect, size_t symsect_size,
1230 size_t symsect_entsize,
1231 const char *strsect, size_t strsect_size,
1232 int *errp)
d851ecd3
NA
1233{
1234 return ctf_simple_open_internal (ctfsect, ctfsect_size, symsect, symsect_size,
1235 symsect_entsize, strsect, strsect_size, NULL,
676c3ecb 1236 0, errp);
d851ecd3
NA
1237}
1238
1239/* Open a CTF file, mocking up a suitable ctf_sect and overriding the external
1240 strtab with a synthetic one. */
1241
139633c3 1242ctf_dict_t *ctf_simple_open_internal (const char *ctfsect, size_t ctfsect_size,
d851ecd3
NA
1243 const char *symsect, size_t symsect_size,
1244 size_t symsect_entsize,
1245 const char *strsect, size_t strsect_size,
676c3ecb
NA
1246 ctf_dynhash_t *syn_strtab, int writable,
1247 int *errp)
72f33921
NA
1248{
1249 ctf_sect_t skeleton;
1250
1251 ctf_sect_t ctf_sect, sym_sect, str_sect;
1252 ctf_sect_t *ctfsectp = NULL;
1253 ctf_sect_t *symsectp = NULL;
1254 ctf_sect_t *strsectp = NULL;
1255
1256 skeleton.cts_name = _CTF_SECTION;
72f33921 1257 skeleton.cts_entsize = 1;
72f33921
NA
1258
1259 if (ctfsect)
1260 {
1261 memcpy (&ctf_sect, &skeleton, sizeof (struct ctf_sect));
1262 ctf_sect.cts_data = ctfsect;
1263 ctf_sect.cts_size = ctfsect_size;
1264 ctfsectp = &ctf_sect;
1265 }
1266
1267 if (symsect)
1268 {
1269 memcpy (&sym_sect, &skeleton, sizeof (struct ctf_sect));
1270 sym_sect.cts_data = symsect;
1271 sym_sect.cts_size = symsect_size;
1272 sym_sect.cts_entsize = symsect_entsize;
1273 symsectp = &sym_sect;
1274 }
1275
1276 if (strsect)
1277 {
1278 memcpy (&str_sect, &skeleton, sizeof (struct ctf_sect));
1279 str_sect.cts_data = strsect;
1280 str_sect.cts_size = strsect_size;
1281 strsectp = &str_sect;
1282 }
1283
676c3ecb
NA
1284 return ctf_bufopen_internal (ctfsectp, symsectp, strsectp, syn_strtab,
1285 writable, errp);
72f33921
NA
1286}
1287
1288/* Decode the specified CTF buffer and optional symbol table, and create a new
139633c3 1289 CTF dict representing the symbolic debugging information. This code can
72f33921
NA
1290 be used directly by the debugger, or it can be used as the engine for
1291 ctf_fdopen() or ctf_open(), below. */
1292
139633c3 1293ctf_dict_t *
72f33921
NA
1294ctf_bufopen (const ctf_sect_t *ctfsect, const ctf_sect_t *symsect,
1295 const ctf_sect_t *strsect, int *errp)
d851ecd3 1296{
676c3ecb 1297 return ctf_bufopen_internal (ctfsect, symsect, strsect, NULL, 0, errp);
d851ecd3
NA
1298}
1299
1300/* Like ctf_bufopen, but overriding the external strtab with a synthetic one. */
1301
139633c3 1302ctf_dict_t *
d851ecd3
NA
1303ctf_bufopen_internal (const ctf_sect_t *ctfsect, const ctf_sect_t *symsect,
1304 const ctf_sect_t *strsect, ctf_dynhash_t *syn_strtab,
676c3ecb 1305 int writable, int *errp)
72f33921
NA
1306{
1307 const ctf_preamble_t *pp;
fd55eae8
NA
1308 size_t hdrsz = sizeof (ctf_header_t);
1309 ctf_header_t *hp;
139633c3 1310 ctf_dict_t *fp;
72f33921
NA
1311 int foreign_endian = 0;
1312 int err;
1313
1314 libctf_init_debug();
1315
d851ecd3
NA
1316 if ((ctfsect == NULL) || ((symsect != NULL) &&
1317 ((strsect == NULL) && syn_strtab == NULL)))
72f33921
NA
1318 return (ctf_set_open_errno (errp, EINVAL));
1319
1320 if (symsect != NULL && symsect->cts_entsize != sizeof (Elf32_Sym) &&
1321 symsect->cts_entsize != sizeof (Elf64_Sym))
1322 return (ctf_set_open_errno (errp, ECTF_SYMTAB));
1323
1324 if (symsect != NULL && symsect->cts_data == NULL)
1325 return (ctf_set_open_errno (errp, ECTF_SYMBAD));
1326
1327 if (strsect != NULL && strsect->cts_data == NULL)
1328 return (ctf_set_open_errno (errp, ECTF_STRBAD));
1329
1330 if (ctfsect->cts_size < sizeof (ctf_preamble_t))
1331 return (ctf_set_open_errno (errp, ECTF_NOCTFBUF));
1332
1333 pp = (const ctf_preamble_t *) ctfsect->cts_data;
1334
1335 ctf_dprintf ("ctf_bufopen: magic=0x%x version=%u\n",
1336 pp->ctp_magic, pp->ctp_version);
1337
1338 /* Validate each part of the CTF header.
1339
1340 First, we validate the preamble (common to all versions). At that point,
1341 we know the endianness and specific header version, and can validate the
1342 version-specific parts including section offsets and alignments.
1343
1344 We specifically do not support foreign-endian old versions. */
1345
1346 if (_libctf_unlikely_ (pp->ctp_magic != CTF_MAGIC))
1347 {
1348 if (pp->ctp_magic == bswap_16 (CTF_MAGIC))
1349 {
1350 if (pp->ctp_version != CTF_VERSION_3)
1351 return (ctf_set_open_errno (errp, ECTF_CTFVERS));
1352 foreign_endian = 1;
1353 }
1354 else
1355 return (ctf_set_open_errno (errp, ECTF_NOCTFBUF));
1356 }
1357
1358 if (_libctf_unlikely_ ((pp->ctp_version < CTF_VERSION_1)
1359 || (pp->ctp_version > CTF_VERSION_3)))
1360 return (ctf_set_open_errno (errp, ECTF_CTFVERS));
1361
1362 if ((symsect != NULL) && (pp->ctp_version < CTF_VERSION_2))
1363 {
1364 /* The symtab can contain function entries which contain embedded ctf
1365 info. We do not support dynamically upgrading such entries (none
1366 should exist in any case, since dwarf2ctf does not create them). */
1367
1136c379
NA
1368 ctf_err_warn (NULL, 0, ECTF_NOTSUP, _("ctf_bufopen: CTF version %d "
1369 "symsect not supported"),
1370 pp->ctp_version);
72f33921
NA
1371 return (ctf_set_open_errno (errp, ECTF_NOTSUP));
1372 }
1373
fd55eae8
NA
1374 if (pp->ctp_version < CTF_VERSION_3)
1375 hdrsz = sizeof (ctf_header_v2_t);
1376
ec388c16 1377 if (_libctf_unlikely_ (pp->ctp_flags > CTF_F_MAX))
1136c379
NA
1378 {
1379 ctf_err_warn (NULL, 0, ECTF_FLAGS, _("ctf_bufopen: invalid header "
1380 "flags: %x"),
1381 (unsigned int) pp->ctp_flags);
1382 return (ctf_set_open_errno (errp, ECTF_FLAGS));
1383 }
ec388c16 1384
fd55eae8 1385 if (ctfsect->cts_size < hdrsz)
72f33921
NA
1386 return (ctf_set_open_errno (errp, ECTF_NOCTFBUF));
1387
139633c3 1388 if ((fp = malloc (sizeof (ctf_dict_t))) == NULL)
fd55eae8
NA
1389 return (ctf_set_open_errno (errp, ENOMEM));
1390
139633c3 1391 memset (fp, 0, sizeof (ctf_dict_t));
fd55eae8 1392
676c3ecb
NA
1393 if (writable)
1394 fp->ctf_flags |= LCTF_RDWR;
1395
de07e349 1396 if ((fp->ctf_header = malloc (sizeof (struct ctf_header))) == NULL)
fd55eae8 1397 {
de07e349 1398 free (fp);
fd55eae8
NA
1399 return (ctf_set_open_errno (errp, ENOMEM));
1400 }
1401 hp = fp->ctf_header;
1402 memcpy (hp, ctfsect->cts_data, hdrsz);
1403 if (pp->ctp_version < CTF_VERSION_3)
1404 upgrade_header (hp);
72f33921
NA
1405
1406 if (foreign_endian)
fd55eae8 1407 flip_header (hp);
9b32cba4 1408 fp->ctf_openflags = hp->cth_flags;
fd55eae8 1409 fp->ctf_size = hp->cth_stroff + hp->cth_strlen;
72f33921 1410
fd55eae8
NA
1411 ctf_dprintf ("ctf_bufopen: uncompressed size=%lu\n",
1412 (unsigned long) fp->ctf_size);
72f33921 1413
fd55eae8 1414 if (hp->cth_lbloff > fp->ctf_size || hp->cth_objtoff > fp->ctf_size
2db912ba
NA
1415 || hp->cth_funcoff > fp->ctf_size || hp->cth_objtidxoff > fp->ctf_size
1416 || hp->cth_funcidxoff > fp->ctf_size || hp->cth_typeoff > fp->ctf_size
fd55eae8 1417 || hp->cth_stroff > fp->ctf_size)
1136c379
NA
1418 {
1419 ctf_err_warn (NULL, 0, ECTF_CORRUPT, _("header offset exceeds CTF size"));
1420 return (ctf_set_open_errno (errp, ECTF_CORRUPT));
1421 }
72f33921 1422
fd55eae8
NA
1423 if (hp->cth_lbloff > hp->cth_objtoff
1424 || hp->cth_objtoff > hp->cth_funcoff
1425 || hp->cth_funcoff > hp->cth_typeoff
2db912ba
NA
1426 || hp->cth_funcoff > hp->cth_objtidxoff
1427 || hp->cth_objtidxoff > hp->cth_funcidxoff
1428 || hp->cth_funcidxoff > hp->cth_varoff
fd55eae8 1429 || hp->cth_varoff > hp->cth_typeoff || hp->cth_typeoff > hp->cth_stroff)
1136c379
NA
1430 {
1431 ctf_err_warn (NULL, 0, ECTF_CORRUPT, _("overlapping CTF sections"));
1432 return (ctf_set_open_errno (errp, ECTF_CORRUPT));
1433 }
72f33921 1434
fd55eae8 1435 if ((hp->cth_lbloff & 3) || (hp->cth_objtoff & 2)
2db912ba
NA
1436 || (hp->cth_funcoff & 2) || (hp->cth_objtidxoff & 2)
1437 || (hp->cth_funcidxoff & 2) || (hp->cth_varoff & 3)
fd55eae8 1438 || (hp->cth_typeoff & 3))
1136c379
NA
1439 {
1440 ctf_err_warn (NULL, 0, ECTF_CORRUPT,
1441 _("CTF sections not properly aligned"));
1442 return (ctf_set_open_errno (errp, ECTF_CORRUPT));
1443 }
1444
1445 /* This invariant will be lifted in v4, but for now it is true. */
1446
1447 if ((hp->cth_funcidxoff - hp->cth_objtidxoff != 0) &&
1448 (hp->cth_funcidxoff - hp->cth_objtidxoff
1449 != hp->cth_funcoff - hp->cth_objtoff))
1450 {
1451 ctf_err_warn (NULL, 0, ECTF_CORRUPT,
1452 _("Object index section exists is neither empty nor the "
1453 "same length as the object section: %u versus %u "
1454 "bytes"), hp->cth_funcoff - hp->cth_objtoff,
1455 hp->cth_funcidxoff - hp->cth_objtidxoff);
1456 return (ctf_set_open_errno (errp, ECTF_CORRUPT));
1457 }
1458
1459 if ((hp->cth_varoff - hp->cth_funcidxoff != 0) &&
1460 (hp->cth_varoff - hp->cth_funcidxoff
1461 != hp->cth_objtidxoff - hp->cth_funcoff))
1462 {
1463 ctf_err_warn (NULL, 0, ECTF_CORRUPT,
1464 _("Function index section exists is neither empty nor the "
1465 "same length as the function section: %u versus %u "
1466 "bytes"), hp->cth_objtidxoff - hp->cth_funcoff,
1467 hp->cth_varoff - hp->cth_funcidxoff);
1468 return (ctf_set_open_errno (errp, ECTF_CORRUPT));
1469 }
72f33921
NA
1470
1471 /* Once everything is determined to be valid, attempt to decompress the CTF
1472 data buffer if it is compressed, or copy it into new storage if it is not
1473 compressed but needs endian-flipping. Otherwise we just put the data
1474 section's buffer pointer into ctf_buf, below. */
1475
1476 /* Note: if this is a v1 buffer, it will be reallocated and expanded by
1477 init_types(). */
1478
fd55eae8 1479 if (hp->cth_flags & CTF_F_COMPRESS)
72f33921 1480 {
a0486bac
JM
1481 size_t srclen;
1482 uLongf dstlen;
72f33921
NA
1483 const void *src;
1484 int rc = Z_OK;
1485
fd55eae8
NA
1486 /* We are allocating this ourselves, so we can drop the ctf header
1487 copy in favour of ctf->ctf_header. */
72f33921 1488
de07e349 1489 if ((fp->ctf_base = malloc (fp->ctf_size)) == NULL)
fd55eae8
NA
1490 {
1491 err = ECTF_ZALLOC;
1492 goto bad;
1493 }
1494 fp->ctf_dynbase = fp->ctf_base;
1495 hp->cth_flags &= ~CTF_F_COMPRESS;
72f33921
NA
1496
1497 src = (unsigned char *) ctfsect->cts_data + hdrsz;
1498 srclen = ctfsect->cts_size - hdrsz;
fd55eae8
NA
1499 dstlen = fp->ctf_size;
1500 fp->ctf_buf = fp->ctf_base;
72f33921 1501
fd55eae8 1502 if ((rc = uncompress (fp->ctf_base, &dstlen, src, srclen)) != Z_OK)
72f33921 1503 {
926c9e76
NA
1504 ctf_err_warn (NULL, 0, ECTF_DECOMPRESS, _("zlib inflate err: %s"),
1505 zError (rc));
fd55eae8
NA
1506 err = ECTF_DECOMPRESS;
1507 goto bad;
72f33921
NA
1508 }
1509
fd55eae8 1510 if ((size_t) dstlen != fp->ctf_size)
72f33921 1511 {
926c9e76
NA
1512 ctf_err_warn (NULL, 0, ECTF_CORRUPT,
1513 _("zlib inflate short: got %lu of %lu bytes"),
1514 (unsigned long) dstlen, (unsigned long) fp->ctf_size);
fd55eae8
NA
1515 err = ECTF_CORRUPT;
1516 goto bad;
72f33921 1517 }
72f33921
NA
1518 }
1519 else if (foreign_endian)
1520 {
de07e349 1521 if ((fp->ctf_base = malloc (fp->ctf_size)) == NULL)
fd55eae8
NA
1522 {
1523 err = ECTF_ZALLOC;
1524 goto bad;
1525 }
1526 fp->ctf_dynbase = fp->ctf_base;
1527 memcpy (fp->ctf_base, ((unsigned char *) ctfsect->cts_data) + hdrsz,
1528 fp->ctf_size);
1529 fp->ctf_buf = fp->ctf_base;
72f33921
NA
1530 }
1531 else
fd55eae8
NA
1532 {
1533 /* We are just using the section passed in -- but its header may be an old
1534 version. Point ctf_buf past the old header, and never touch it
1535 again. */
1536 fp->ctf_base = (unsigned char *) ctfsect->cts_data;
1537 fp->ctf_dynbase = NULL;
1538 fp->ctf_buf = fp->ctf_base + hdrsz;
1539 }
72f33921
NA
1540
1541 /* Once we have uncompressed and validated the CTF data buffer, we can
139633c3 1542 proceed with initializing the ctf_dict_t we allocated above.
72f33921
NA
1543
1544 Nothing that depends on buf or base should be set directly in this function
1545 before the init_types() call, because it may be reallocated during
1546 transparent upgrade if this recension of libctf is so configured: see
fd55eae8 1547 ctf_set_base(). */
72f33921 1548
fd55eae8 1549 ctf_set_version (fp, hp, hp->cth_version);
e4c78f30
NA
1550 if (ctf_str_create_atoms (fp) < 0)
1551 {
1552 err = ENOMEM;
1553 goto bad;
1554 }
1555
fd55eae8 1556 fp->ctf_parmax = CTF_MAX_PTYPE;
72f33921
NA
1557 memcpy (&fp->ctf_data, ctfsect, sizeof (ctf_sect_t));
1558
1559 if (symsect != NULL)
1560 {
1561 memcpy (&fp->ctf_symtab, symsect, sizeof (ctf_sect_t));
1562 memcpy (&fp->ctf_strtab, strsect, sizeof (ctf_sect_t));
1563 }
1564
1565 if (fp->ctf_data.cts_name != NULL)
de07e349
NA
1566 if ((fp->ctf_data.cts_name = strdup (fp->ctf_data.cts_name)) == NULL)
1567 {
1568 err = ENOMEM;
1569 goto bad;
1570 }
72f33921 1571 if (fp->ctf_symtab.cts_name != NULL)
de07e349
NA
1572 if ((fp->ctf_symtab.cts_name = strdup (fp->ctf_symtab.cts_name)) == NULL)
1573 {
1574 err = ENOMEM;
1575 goto bad;
1576 }
72f33921 1577 if (fp->ctf_strtab.cts_name != NULL)
de07e349
NA
1578 if ((fp->ctf_strtab.cts_name = strdup (fp->ctf_strtab.cts_name)) == NULL)
1579 {
1580 err = ENOMEM;
1581 goto bad;
1582 }
72f33921
NA
1583
1584 if (fp->ctf_data.cts_name == NULL)
1585 fp->ctf_data.cts_name = _CTF_NULLSTR;
1586 if (fp->ctf_symtab.cts_name == NULL)
1587 fp->ctf_symtab.cts_name = _CTF_NULLSTR;
1588 if (fp->ctf_strtab.cts_name == NULL)
1589 fp->ctf_strtab.cts_name = _CTF_NULLSTR;
1590
1591 if (strsect != NULL)
1592 {
1593 fp->ctf_str[CTF_STRTAB_1].cts_strs = strsect->cts_data;
1594 fp->ctf_str[CTF_STRTAB_1].cts_len = strsect->cts_size;
1595 }
d851ecd3 1596 fp->ctf_syn_ext_strtab = syn_strtab;
72f33921
NA
1597
1598 if (foreign_endian &&
926c9e76 1599 (err = flip_ctf (fp, hp, fp->ctf_buf)) != 0)
72f33921
NA
1600 {
1601 /* We can be certain that flip_ctf() will have endian-flipped everything
fa56cdcd
NA
1602 other than the types table when we return. In particular the header
1603 is fine, so set it, to allow freeing to use the usual code path. */
72f33921 1604
fd55eae8 1605 ctf_set_base (fp, hp, fp->ctf_base);
72f33921
NA
1606 goto bad;
1607 }
1608
fd55eae8 1609 ctf_set_base (fp, hp, fp->ctf_base);
72f33921 1610
139633c3
NA
1611 /* No need to do anything else for dynamic dicts: they do not support symbol
1612 lookups, and the type table is maintained in the dthashes. */
676c3ecb
NA
1613 if (fp->ctf_flags & LCTF_RDWR)
1614 {
1615 fp->ctf_refcnt = 1;
1616 return fp;
1617 }
1618
fd55eae8
NA
1619 if ((err = init_types (fp, hp)) != 0)
1620 goto bad;
72f33921 1621
1136c379
NA
1622 /* Allocate and initialize the symtab translation table, pointed to by
1623 ctf_sxlate, and the corresponding index sections. This table may be too
1624 large for the actual size of the object and function info sections: if so,
1625 ctf_nsyms will be adjusted and the excess will never be used. It's
1626 possible to do indexed symbol lookups even without a symbol table, so check
53651de8
NA
1627 even in that case. Initially, we assume the symtab is native-endian: if it
1628 isn't, the caller will inform us later by calling ctf_symsect_endianness. */
1629#ifdef WORDS_BIGENDIAN
1630 fp->ctf_symsect_little_endian = 0;
1631#else
1632 fp->ctf_symsect_little_endian = 1;
1633#endif
72f33921
NA
1634
1635 if (symsect != NULL)
1636 {
1637 fp->ctf_nsyms = symsect->cts_size / symsect->cts_entsize;
de07e349 1638 fp->ctf_sxlate = malloc (fp->ctf_nsyms * sizeof (uint32_t));
72f33921
NA
1639
1640 if (fp->ctf_sxlate == NULL)
1641 {
fd55eae8 1642 err = ENOMEM;
72f33921
NA
1643 goto bad;
1644 }
72f33921
NA
1645 }
1646
1136c379
NA
1647 if ((err = init_symtab (fp, hp, symsect)) != 0)
1648 goto bad;
1649
676c3ecb 1650 ctf_set_ctl_hashes (fp);
72f33921
NA
1651
1652 if (symsect != NULL)
1653 {
1654 if (symsect->cts_entsize == sizeof (Elf64_Sym))
1655 (void) ctf_setmodel (fp, CTF_MODEL_LP64);
1656 else
1657 (void) ctf_setmodel (fp, CTF_MODEL_ILP32);
1658 }
1659 else
1660 (void) ctf_setmodel (fp, CTF_MODEL_NATIVE);
1661
1662 fp->ctf_refcnt = 1;
1663 return fp;
1664
1665bad:
fd55eae8 1666 ctf_set_open_errno (errp, err);
926c9e76 1667 ctf_err_warn_to_open (fp);
139633c3 1668 ctf_dict_close (fp);
72f33921
NA
1669 return NULL;
1670}
1671
139633c3
NA
1672/* Bump the refcount on the specified CTF dict, to allow export of ctf_dict_t's
1673 from iterators that open and close the ctf_dict_t around the loop. (This
1674 does not extend their lifetime beyond that of the ctf_archive_t in which they
1675 are contained.) */
2399827b
NA
1676
1677void
139633c3 1678ctf_ref (ctf_dict_t *fp)
2399827b
NA
1679{
1680 fp->ctf_refcnt++;
1681}
1682
139633c3
NA
1683/* Close the specified CTF dict and free associated data structures. Note that
1684 ctf_dict_close() is a reference counted operation: if the specified file is
1685 the parent of other active dict, its reference count will be greater than one
1686 and it will be freed later when no active children exist. */
72f33921
NA
1687
1688void
139633c3 1689ctf_dict_close (ctf_dict_t *fp)
72f33921
NA
1690{
1691 ctf_dtdef_t *dtd, *ntd;
1692 ctf_dvdef_t *dvd, *nvd;
1136c379 1693 ctf_in_flight_dynsym_t *did, *nid;
8b37e7b6 1694 ctf_err_warning_t *err, *nerr;
72f33921
NA
1695
1696 if (fp == NULL)
139633c3 1697 return; /* Allow ctf_dict_close(NULL) to simplify caller code. */
72f33921 1698
139633c3 1699 ctf_dprintf ("ctf_dict_close(%p) refcnt=%u\n", (void *) fp, fp->ctf_refcnt);
72f33921
NA
1700
1701 if (fp->ctf_refcnt > 1)
1702 {
1703 fp->ctf_refcnt--;
1704 return;
1705 }
1706
1fa7a0c2
NA
1707 /* It is possible to recurse back in here, notably if dicts in the
1708 ctf_link_inputs or ctf_link_outputs cite this dict as a parent without
1709 using ctf_import_unref. Do nothing in that case. */
1710 if (fp->ctf_refcnt == 0)
1711 return;
1712
1713 fp->ctf_refcnt--;
de07e349
NA
1714 free (fp->ctf_dyncuname);
1715 free (fp->ctf_dynparname);
1fa7a0c2 1716 if (fp->ctf_parent && !fp->ctf_parent_unreffed)
139633c3 1717 ctf_dict_close (fp->ctf_parent);
72f33921
NA
1718
1719 for (dtd = ctf_list_next (&fp->ctf_dtdefs); dtd != NULL; dtd = ntd)
1720 {
1721 ntd = ctf_list_next (dtd);
1722 ctf_dtd_delete (fp, dtd);
1723 }
1724 ctf_dynhash_destroy (fp->ctf_dthash);
676c3ecb
NA
1725 if (fp->ctf_flags & LCTF_RDWR)
1726 {
1727 ctf_dynhash_destroy (fp->ctf_structs.ctn_writable);
1728 ctf_dynhash_destroy (fp->ctf_unions.ctn_writable);
1729 ctf_dynhash_destroy (fp->ctf_enums.ctn_writable);
1730 ctf_dynhash_destroy (fp->ctf_names.ctn_writable);
1731 }
1732 else
1733 {
1734 ctf_hash_destroy (fp->ctf_structs.ctn_readonly);
1735 ctf_hash_destroy (fp->ctf_unions.ctn_readonly);
1736 ctf_hash_destroy (fp->ctf_enums.ctn_readonly);
1737 ctf_hash_destroy (fp->ctf_names.ctn_readonly);
1738 }
72f33921
NA
1739
1740 for (dvd = ctf_list_next (&fp->ctf_dvdefs); dvd != NULL; dvd = nvd)
1741 {
1742 nvd = ctf_list_next (dvd);
1743 ctf_dvd_delete (fp, dvd);
1744 }
1745 ctf_dynhash_destroy (fp->ctf_dvhash);
1136c379 1746
f4f60336 1747 ctf_dynhash_destroy (fp->ctf_symhash);
1136c379
NA
1748 free (fp->ctf_funcidx_sxlate);
1749 free (fp->ctf_objtidx_sxlate);
1750 ctf_dynhash_destroy (fp->ctf_objthash);
1751 ctf_dynhash_destroy (fp->ctf_funchash);
1752 free (fp->ctf_dynsymidx);
1753 ctf_dynhash_destroy (fp->ctf_dynsyms);
1754 for (did = ctf_list_next (&fp->ctf_in_flight_dynsyms); did != NULL; did = nid)
1755 {
1756 nid = ctf_list_next (did);
1757 ctf_list_delete (&fp->ctf_in_flight_dynsyms, did);
1758 free (did);
1759 }
1760
f5e9c9bd 1761 ctf_str_free_atoms (fp);
de07e349 1762 free (fp->ctf_tmp_typeslice);
72f33921 1763
fd55eae8 1764 if (fp->ctf_data.cts_name != _CTF_NULLSTR)
de07e349 1765 free ((char *) fp->ctf_data.cts_name);
72f33921 1766
fd55eae8 1767 if (fp->ctf_symtab.cts_name != _CTF_NULLSTR)
de07e349 1768 free ((char *) fp->ctf_symtab.cts_name);
72f33921 1769
fd55eae8 1770 if (fp->ctf_strtab.cts_name != _CTF_NULLSTR)
de07e349 1771 free ((char *) fp->ctf_strtab.cts_name);
72f33921
NA
1772 else if (fp->ctf_data_mmapped)
1773 ctf_munmap (fp->ctf_data_mmapped, fp->ctf_data_mmapped_len);
1774
de07e349 1775 free (fp->ctf_dynbase);
72f33921 1776
d851ecd3 1777 ctf_dynhash_destroy (fp->ctf_syn_ext_strtab);
72c83edd
NA
1778 ctf_dynhash_destroy (fp->ctf_link_inputs);
1779 ctf_dynhash_destroy (fp->ctf_link_outputs);
886453cb 1780 ctf_dynhash_destroy (fp->ctf_link_type_mapping);
5f54462c
NA
1781 ctf_dynhash_destroy (fp->ctf_link_in_cu_mapping);
1782 ctf_dynhash_destroy (fp->ctf_link_out_cu_mapping);
99dc3ebd 1783 ctf_dynhash_destroy (fp->ctf_add_processing);
0f0c11f7
NA
1784 ctf_dedup_fini (fp, NULL, 0);
1785 ctf_dynset_destroy (fp->ctf_dedup_atoms_alloc);
d851ecd3 1786
8b37e7b6
NA
1787 for (err = ctf_list_next (&fp->ctf_errs_warnings); err != NULL; err = nerr)
1788 {
1789 nerr = ctf_list_next (err);
1790 ctf_list_delete (&fp->ctf_errs_warnings, err);
1791 free (err->cew_text);
1792 free (err);
1793 }
1794
de07e349
NA
1795 free (fp->ctf_sxlate);
1796 free (fp->ctf_txlate);
1797 free (fp->ctf_ptrtab);
abe4ca69 1798 free (fp->ctf_pptrtab);
72f33921 1799
de07e349
NA
1800 free (fp->ctf_header);
1801 free (fp);
72f33921
NA
1802}
1803
139633c3
NA
1804/* Backward compatibility. */
1805void
1806ctf_file_close (ctf_file_t *fp)
1807{
1808 ctf_dict_close (fp);
1809}
1810
143dce84
NA
1811/* The converse of ctf_open(). ctf_open() disguises whatever it opens as an
1812 archive, so closing one is just like closing an archive. */
1813void
1814ctf_close (ctf_archive_t *arc)
1815{
1816 ctf_arc_close (arc);
1817}
1818
139633c3 1819/* Get the CTF archive from which this ctf_dict_t is derived. */
9402cc59 1820ctf_archive_t *
139633c3 1821ctf_get_arc (const ctf_dict_t *fp)
9402cc59
NA
1822{
1823 return fp->ctf_archive;
1824}
1825
72f33921 1826/* Return the ctfsect out of the core ctf_impl. Useful for freeing the
139633c3 1827 ctfsect's data * after ctf_dict_close(), which is why we return the actual
72f33921
NA
1828 structure, not a pointer to it, since that is likely to become a pointer to
1829 freed data before the return value is used under the expected use case of
139633c3 1830 ctf_getsect()/ ctf_dict_close()/free(). */
676c3ecb 1831ctf_sect_t
139633c3 1832ctf_getdatasect (const ctf_dict_t *fp)
72f33921
NA
1833{
1834 return fp->ctf_data;
1835}
1836
97a2a623
NA
1837ctf_sect_t
1838ctf_getsymsect (const ctf_dict_t *fp)
1839{
1840 return fp->ctf_symtab;
1841}
1842
1843ctf_sect_t
1844ctf_getstrsect (const ctf_dict_t *fp)
1845{
1846 return fp->ctf_strtab;
1847}
1848
53651de8
NA
1849/* Set the endianness of the symbol table attached to FP. */
1850void
1851ctf_symsect_endianness (ctf_dict_t *fp, int little_endian)
1852{
1853 int old_endianness = fp->ctf_symsect_little_endian;
1854
1855 fp->ctf_symsect_little_endian = !!little_endian;
1856
1857 /* If we already have a symtab translation table, we need to repopulate it if
1858 our idea of the endianness has changed. */
1859
1860 if (old_endianness != fp->ctf_symsect_little_endian
1861 && fp->ctf_sxlate != NULL && fp->ctf_symtab.cts_data != NULL)
1862 assert (init_symtab (fp, fp->ctf_header, &fp->ctf_symtab) == 0);
1863}
1864
139633c3
NA
1865/* Return the CTF handle for the parent CTF dict, if one exists. Otherwise
1866 return NULL to indicate this dict has no imported parent. */
1867ctf_dict_t *
1868ctf_parent_dict (ctf_dict_t *fp)
72f33921
NA
1869{
1870 return fp->ctf_parent;
1871}
1872
139633c3
NA
1873/* Backward compatibility. */
1874ctf_dict_t *
1875ctf_parent_file (ctf_dict_t *fp)
1876{
1877 return ctf_parent_dict (fp);
1878}
1879
1880/* Return the name of the parent CTF dict, if one exists, or NULL otherwise. */
72f33921 1881const char *
139633c3 1882ctf_parent_name (ctf_dict_t *fp)
72f33921
NA
1883{
1884 return fp->ctf_parname;
1885}
1886
1887/* Set the parent name. It is an error to call this routine without calling
1888 ctf_import() at some point. */
de07e349 1889int
139633c3 1890ctf_parent_name_set (ctf_dict_t *fp, const char *name)
72f33921
NA
1891{
1892 if (fp->ctf_dynparname != NULL)
de07e349 1893 free (fp->ctf_dynparname);
72f33921 1894
de07e349
NA
1895 if ((fp->ctf_dynparname = strdup (name)) == NULL)
1896 return (ctf_set_errno (fp, ENOMEM));
72f33921 1897 fp->ctf_parname = fp->ctf_dynparname;
de07e349 1898 return 0;
72f33921
NA
1899}
1900
fd55eae8 1901/* Return the name of the compilation unit this CTF file applies to. Usually
139633c3 1902 non-NULL only for non-parent dicts. */
fd55eae8 1903const char *
139633c3 1904ctf_cuname (ctf_dict_t *fp)
fd55eae8
NA
1905{
1906 return fp->ctf_cuname;
1907}
1908
1909/* Set the compilation unit name. */
de07e349 1910int
139633c3 1911ctf_cuname_set (ctf_dict_t *fp, const char *name)
fd55eae8
NA
1912{
1913 if (fp->ctf_dyncuname != NULL)
de07e349 1914 free (fp->ctf_dyncuname);
fd55eae8 1915
de07e349
NA
1916 if ((fp->ctf_dyncuname = strdup (name)) == NULL)
1917 return (ctf_set_errno (fp, ENOMEM));
fd55eae8 1918 fp->ctf_cuname = fp->ctf_dyncuname;
de07e349 1919 return 0;
fd55eae8
NA
1920}
1921
139633c3
NA
1922/* Import the types from the specified parent dict by storing a pointer to it in
1923 ctf_parent and incrementing its reference count. Only one parent is allowed:
abe4ca69
NA
1924 if a parent already exists, it is replaced by the new parent. The pptrtab
1925 is wiped, and will be refreshed by the next ctf_lookup_by_name call. */
72f33921 1926int
139633c3 1927ctf_import (ctf_dict_t *fp, ctf_dict_t *pfp)
72f33921
NA
1928{
1929 if (fp == NULL || fp == pfp || (pfp != NULL && pfp->ctf_refcnt == 0))
1930 return (ctf_set_errno (fp, EINVAL));
1931
1932 if (pfp != NULL && pfp->ctf_dmodel != fp->ctf_dmodel)
1933 return (ctf_set_errno (fp, ECTF_DMODEL));
1934
1fa7a0c2 1935 if (fp->ctf_parent && !fp->ctf_parent_unreffed)
139633c3 1936 ctf_dict_close (fp->ctf_parent);
1fa7a0c2
NA
1937 fp->ctf_parent = NULL;
1938
abe4ca69
NA
1939 free (fp->ctf_pptrtab);
1940 fp->ctf_pptrtab = NULL;
1941 fp->ctf_pptrtab_len = 0;
1942 fp->ctf_pptrtab_typemax = 0;
1943
1fa7a0c2 1944 if (pfp != NULL)
de07e349 1945 {
1fa7a0c2
NA
1946 int err;
1947
1948 if (fp->ctf_parname == NULL)
1949 if ((err = ctf_parent_name_set (fp, "PARENT")) < 0)
1950 return err;
1951
1952 fp->ctf_flags |= LCTF_CHILD;
1953 pfp->ctf_refcnt++;
1954 fp->ctf_parent_unreffed = 0;
de07e349 1955 }
72f33921 1956
1fa7a0c2
NA
1957 fp->ctf_parent = pfp;
1958 return 0;
1959}
1960
1961/* Like ctf_import, but does not increment the refcount on the imported parent
1962 or close it at any point: as a result it can go away at any time and the
1963 caller must do all freeing itself. Used internally to avoid refcount
1964 loops. */
1965int
139633c3 1966ctf_import_unref (ctf_dict_t *fp, ctf_dict_t *pfp)
1fa7a0c2
NA
1967{
1968 if (fp == NULL || fp == pfp || (pfp != NULL && pfp->ctf_refcnt == 0))
1969 return (ctf_set_errno (fp, EINVAL));
1970
1971 if (pfp != NULL && pfp->ctf_dmodel != fp->ctf_dmodel)
1972 return (ctf_set_errno (fp, ECTF_DMODEL));
1973
1974 if (fp->ctf_parent && !fp->ctf_parent_unreffed)
139633c3 1975 ctf_dict_close (fp->ctf_parent);
1fa7a0c2
NA
1976 fp->ctf_parent = NULL;
1977
abe4ca69
NA
1978 free (fp->ctf_pptrtab);
1979 fp->ctf_pptrtab = NULL;
1980 fp->ctf_pptrtab_len = 0;
1981 fp->ctf_pptrtab_typemax = 0;
72f33921
NA
1982 if (pfp != NULL)
1983 {
de07e349 1984 int err;
72f33921
NA
1985
1986 if (fp->ctf_parname == NULL)
de07e349
NA
1987 if ((err = ctf_parent_name_set (fp, "PARENT")) < 0)
1988 return err;
1989
1990 fp->ctf_flags |= LCTF_CHILD;
1fa7a0c2 1991 fp->ctf_parent_unreffed = 1;
72f33921 1992 }
ad613f1d 1993
72f33921
NA
1994 fp->ctf_parent = pfp;
1995 return 0;
1996}
1997
139633c3 1998/* Set the data model constant for the CTF dict. */
72f33921 1999int
139633c3 2000ctf_setmodel (ctf_dict_t *fp, int model)
72f33921
NA
2001{
2002 const ctf_dmodel_t *dp;
2003
2004 for (dp = _libctf_models; dp->ctd_name != NULL; dp++)
2005 {
2006 if (dp->ctd_code == model)
2007 {
2008 fp->ctf_dmodel = dp;
2009 return 0;
2010 }
2011 }
2012
2013 return (ctf_set_errno (fp, EINVAL));
2014}
2015
139633c3 2016/* Return the data model constant for the CTF dict. */
72f33921 2017int
139633c3 2018ctf_getmodel (ctf_dict_t *fp)
72f33921
NA
2019{
2020 return fp->ctf_dmodel->ctd_code;
2021}
2022
139633c3 2023/* The caller can hang an arbitrary pointer off each ctf_dict_t using this
a0486bac 2024 function. */
72f33921 2025void
139633c3 2026ctf_setspecific (ctf_dict_t *fp, void *data)
72f33921
NA
2027{
2028 fp->ctf_specific = data;
2029}
2030
a0486bac 2031/* Retrieve the arbitrary pointer again. */
72f33921 2032void *
139633c3 2033ctf_getspecific (ctf_dict_t *fp)
72f33921
NA
2034{
2035 return fp->ctf_specific;
2036}
This page took 0.226437 seconds and 4 git commands to generate.