]> sbz's 6dev Repos - ctfdump/.git/blame - ctfdump.c
sync with readdwarf(1)
[ctfdump/.git] / ctfdump.c
CommitLineData
f8621c6a
MP
1/*
2 * Copyright (c) 2016 Martin Pieuchot <mpi@openbsd.org>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
16
17#include <sys/param.h>
18#include <sys/types.h>
19#include <sys/stat.h>
20#include <sys/exec_elf.h>
21#include <sys/mman.h>
22
23#include <err.h>
24#include <fcntl.h>
25#include <locale.h>
26#include <stdio.h>
27#include <stdint.h>
28#include <stdlib.h>
29#include <string.h>
30#include <unistd.h>
31
32#ifdef ZLIB
33#include <zlib.h>
34#endif /* ZLIB */
35
36#include "ctf.h"
37
74b86e22
MP
38#ifndef nitems
39#define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
40#endif
41
f8621c6a
MP
42#define SUNW_CTF ".SUNW_ctf"
43
44#define DUMP_OBJECT (1 << 0)
45#define DUMP_FUNCTION (1 << 1)
46#define DUMP_HEADER (1 << 2)
751fc09a 47#define DUMP_LABEL (1 << 3)
80c28199 48#define DUMP_STRTAB (1 << 4)
74b86e22
MP
49#define DUMP_STATISTIC (1 << 5)
50#define DUMP_TYPE (1 << 6)
f8621c6a 51
c1bd258a 52int dump(const char *, uint8_t);
f8621c6a
MP
53int isctf(const char *, size_t);
54__dead void usage(void);
55
c1bd258a 56int ctf_dump(const char *, size_t, uint8_t);
74b86e22
MP
57unsigned int ctf_dump_type(struct ctf_header *, const char *, off_t,
58 unsigned int, unsigned int);
59const char *ctf_kind2name(unsigned short);
f8621c6a
MP
60const char *ctf_off2name(struct ctf_header *, const char *, off_t,
61 unsigned int);
62
c1bd258a 63int elf_dump(const char *, size_t, uint8_t);
c36bfc0c
MP
64const char *elf_idx2sym(size_t *, unsigned char);
65
66/* elf.c */
67int iself(const char *, size_t);
f8621c6a
MP
68int elf_getshstrtab(const char *, size_t, const char **, size_t *);
69int elf_getsymtab(const char *, const char *, size_t,
70 const Elf_Sym **, size_t *);
2ef38d60
MP
71int elf_getsection(const char *, const char *, const char *,
72 size_t, const char **, size_t *);
f8621c6a
MP
73
74#ifdef ZLIB
75char *decompress(const char *, size_t, off_t);
76#endif /* ZLIB */
77
78int
79main(int argc, char *argv[])
80{
81 const char *filename;
c1bd258a 82 uint8_t flags = 0;
f8621c6a
MP
83 int ch, error = 0;
84
85 setlocale(LC_ALL, "");
86
53477564 87 while ((ch = getopt(argc, argv, "dfhlst")) != -1) {
f8621c6a 88 switch (ch) {
9fe3b2c8
MP
89 case 'd':
90 flags |= DUMP_OBJECT;
91 break;
acada86d
MP
92 case 'f':
93 flags |= DUMP_FUNCTION;
94 break;
f8621c6a
MP
95 case 'h':
96 flags |= DUMP_HEADER;
97 break;
751fc09a
MP
98 case 'l':
99 flags |= DUMP_LABEL;
100 break;
80c28199
MP
101 case 's':
102 flags |= DUMP_STRTAB;
103 break;
74b86e22
MP
104 case 't':
105 flags |= DUMP_TYPE;
106 break;
f8621c6a
MP
107 default:
108 usage();
109 }
110 }
111
112 argc -= optind;
113 argv += optind;
114
c1bd258a
MP
115 /* Dump everything by default */
116 if (flags == 0)
117 flags = 0xff;
118
f8621c6a
MP
119 while ((filename = *argv++) != NULL)
120 error |= dump(filename, flags);
121
122 return error;
123}
124
125int
c1bd258a 126dump(const char *path, uint8_t flags)
f8621c6a
MP
127{
128 struct stat st;
129 int fd, error = 1;
130 char *p;
131
132 fd = open(path, O_RDONLY);
133 if (fd == -1) {
134 warn("open");
135 return 1;
136 }
137 if (fstat(fd, &st) == -1) {
138 warn("fstat");
139 return 1;
140 }
141 if (st.st_size < (off_t)sizeof(struct ctf_header)) {
142 warnx("file too small to be CTF");
143 return 1;
144 }
145 if ((uintmax_t)st.st_size > SIZE_MAX) {
146 warnx("file too big to fit memory");
147 return 1;
148 }
149
150 p = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
151 if (p == MAP_FAILED)
152 err(1, "mmap");
153
154 if (iself(p, st.st_size)) {
155 error = elf_dump(p, st.st_size, flags);
156 } else if (isctf(p, st.st_size)) {
157 error = ctf_dump(p, st.st_size, flags);
158 }
159
160 munmap(p, st.st_size);
161 close(fd);
162
163 return error;
164}
165
f8621c6a
MP
166const char *strtab;
167const Elf_Sym *symtab;
168size_t strtabsize, nsymb;
169
9fe3b2c8
MP
170const char *
171elf_idx2sym(size_t *idx, unsigned char type)
172{
173 const Elf_Sym *st;
174 size_t i;
175
176 for (i = *idx + 1; i < nsymb; i++) {
177 st = &symtab[i];
178
179 if (ELF_ST_TYPE(st->st_info) != type)
180 continue;
181
182 *idx = i;
183 return strtab + st->st_name;
184 }
185
186 return NULL;
187}
188
f8621c6a 189int
c1bd258a 190elf_dump(const char *p, size_t filesize, uint8_t flags)
f8621c6a
MP
191{
192 Elf_Ehdr *eh = (Elf_Ehdr *)p;
193 Elf_Shdr *sh;
194 const char *shstrtab;
195 size_t i, shstrtabsize;
196
197 /* Find section header string table location and size. */
198 if (elf_getshstrtab(p, filesize, &shstrtab, &shstrtabsize))
199 return 1;
200
201 /* Find symbol table location and number of symbols. */
202 if (elf_getsymtab(p, shstrtab, shstrtabsize, &symtab, &nsymb))
203 warnx("symbol table not found");
204
205 /* Find string table location and size. */
2ef38d60 206 if (elf_getsection(p, ELF_STRTAB, shstrtab, shstrtabsize, &strtab, &strtabsize))
f8621c6a
MP
207 warnx("string table not found");
208
209 /* Find CTF section and dump it. */
210 for (i = 0; i < eh->e_shnum; i++) {
211 sh = (Elf_Shdr *)(p + eh->e_shoff + i * eh->e_shentsize);
212
213 if ((sh->sh_link >= eh->e_shnum) ||
214 (sh->sh_name >= shstrtabsize))
215 continue;
216
217 if (strncmp(shstrtab + sh->sh_name, SUNW_CTF, strlen(SUNW_CTF)))
218 continue;
219
220 if (!isctf(p + sh->sh_offset, sh->sh_size))
221 break;
222
223 return ctf_dump(p + sh->sh_offset, sh->sh_size, flags);
224 }
225
226 warnx("%s section not found", SUNW_CTF);
227 return 1;
228}
229
230int
231isctf(const char *p, size_t filesize)
232{
233 struct ctf_header *cth = (struct ctf_header *)p;
234 off_t dlen = cth->cth_stroff + cth->cth_strlen;
235
236 if (cth->cth_magic != CTF_MAGIC || cth->cth_version != CTF_VERSION)
237 return 0;
238
239 if (dlen > filesize && !(cth->cth_flags & CTF_F_COMPRESS)) {
240 warnx("bogus file size");
241 return 0;
242 }
243
244 if ((cth->cth_lbloff & 3) || (cth->cth_objtoff & 1) ||
245 (cth->cth_funcoff & 1) || (cth->cth_typeoff & 3)) {
246 warnx("wrongly aligned offset");
247 return 0;
248 }
249
250 if ((cth->cth_lbloff >= dlen) || (cth->cth_objtoff >= dlen) ||
251 (cth->cth_funcoff >= dlen) || (cth->cth_typeoff >= dlen)) {
252 warnx("truncated file");
253 return 0;
254 }
255
256 if ((cth->cth_lbloff > cth->cth_objtoff) ||
257 (cth->cth_objtoff > cth->cth_funcoff) ||
258 (cth->cth_funcoff > cth->cth_typeoff) ||
259 (cth->cth_typeoff > cth->cth_stroff)) {
260 warnx("corrupted file");
261 return 0;
262 }
263
264 return 1;
265}
266
267int
c1bd258a 268ctf_dump(const char *p, size_t size, uint8_t flags)
f8621c6a
MP
269{
270 struct ctf_header *cth = (struct ctf_header *)p;
f8621c6a 271 off_t dlen = cth->cth_stroff + cth->cth_strlen;
b51bd0d8 272 char *data;
f8621c6a
MP
273
274 if (cth->cth_flags & CTF_F_COMPRESS) {
275 data = decompress(p + sizeof(*cth), size - sizeof(*cth), dlen);
276 if (data == NULL)
277 return 1;
b51bd0d8
MP
278 } else {
279 data = (char *)p + sizeof(*cth);
f8621c6a
MP
280 }
281
282 if (flags & DUMP_HEADER) {
6befd992
MP
283 printf(" cth_magic = 0x%04x\n", cth->cth_magic);
284 printf(" cth_version = %d\n", cth->cth_version);
285 printf(" cth_flags = 0x%02x\n", cth->cth_flags);
286 printf(" cth_parlabel = %s\n",
f8621c6a 287 ctf_off2name(cth, data, dlen, cth->cth_parname));
6befd992 288 printf(" cth_parname = %s\n",
f8621c6a 289 ctf_off2name(cth, data, dlen, cth->cth_parname));
6befd992
MP
290 printf(" cth_lbloff = %d\n", cth->cth_lbloff);
291 printf(" cth_objtoff = %d\n", cth->cth_objtoff);
292 printf(" cth_funcoff = %d\n", cth->cth_funcoff);
293 printf(" cth_typeoff = %d\n", cth->cth_typeoff);
294 printf(" cth_stroff = %d\n", cth->cth_stroff);
295 printf(" cth_strlen = %d\n", cth->cth_strlen);
296 printf("\n");
f8621c6a
MP
297 }
298
751fc09a
MP
299 if (flags & DUMP_LABEL) {
300 unsigned int lbloff = cth->cth_lbloff;
301 struct ctf_lblent *ctl;
302
303 while (lbloff < cth->cth_objtoff) {
304 ctl = (struct ctf_lblent *)(data + lbloff);
305
6befd992 306 printf(" %5u %s\n", ctl->ctl_typeidx,
751fc09a
MP
307 ctf_off2name(cth, data, dlen, ctl->ctl_label));
308
309 lbloff += sizeof(*ctl);
310 }
6befd992 311 printf("\n");
751fc09a
MP
312 }
313
9fe3b2c8
MP
314 if (flags & DUMP_OBJECT) {
315 unsigned int objtoff = cth->cth_objtoff;
316 size_t idx = 0, i = 0;
317 unsigned short *dsp;
318 const char *s;
319 int l;
320
321 while (objtoff < cth->cth_funcoff) {
322 dsp = (unsigned short *)(data + objtoff);
323
6befd992 324 l = printf(" [%zu] %u", i++, *dsp);
9fe3b2c8 325 if ((s = elf_idx2sym(&idx, STT_OBJECT)) != NULL)
6befd992 326 printf("%*s %s (%zu)\n", (15 - l), "", s, idx);
9fe3b2c8
MP
327 else
328 printf("\n");
329
330 objtoff += sizeof(*dsp);
331 }
6befd992 332 printf("\n");
9fe3b2c8
MP
333 }
334
acada86d
MP
335 if (flags & DUMP_FUNCTION) {
336 unsigned short *fsp, kind, vlen;
337 size_t idx = 0, i = 0;
338 const char *s;
339 int l;
340
341 fsp = (unsigned short *)(data + cth->cth_funcoff);
342 while (fsp < (unsigned short *)(data + cth->cth_typeoff)) {
343 kind = CTF_INFO_KIND(*fsp);
344 vlen = CTF_INFO_VLEN(*fsp);
345 fsp++;
346
347 if (kind == CTF_K_UNKNOWN && vlen == 0)
348 continue;
349
6befd992 350 l = printf(" [%zu]", i++);
acada86d 351 if ((s = elf_idx2sym(&idx, STT_FUNC)) != NULL)
6befd992 352 printf(" %s (%zu)", s, idx);
acada86d
MP
353 printf(" returns: %u args: (", *fsp++);
354 while (vlen-- > 0)
355 printf("%u%s", *fsp++, (vlen > 0) ? ", " : "");
356 printf(")\n");
357 }
6befd992 358 printf("\n");
acada86d
MP
359 }
360
80c28199
MP
361 if (flags & DUMP_STRTAB) {
362 unsigned int offset = 0;
363 const char *str;
364
365 while (offset < cth->cth_strlen) {
3093320c 366 str = ctf_off2name(cth, data, dlen, offset);
80c28199 367
6befd992 368 printf(" [%u] ", offset);
3093320c 369 if (strcmp(str, "(anon)"))
80c28199
MP
370 offset += printf("%s\n", str);
371 else {
372 printf("\\0\n");
373 offset++;
374 }
375 }
6befd992 376 printf("\n");
80c28199
MP
377 }
378
74b86e22
MP
379 if (flags & DUMP_TYPE) {
380 unsigned int idx = 1, offset = 0;
381
6befd992 382 while (offset < cth->cth_stroff) {
74b86e22 383 offset += ctf_dump_type(cth, data, dlen, offset, idx++);
6befd992
MP
384 }
385 printf("\n");
74b86e22
MP
386 }
387
f8621c6a
MP
388 if (cth->cth_flags & CTF_F_COMPRESS)
389 free(data);
390
391 return 0;
392}
393
74b86e22
MP
394unsigned int
395ctf_dump_type(struct ctf_header *cth, const char *data, off_t dlen,
396 unsigned int offset, unsigned int idx)
397{
23543ec6
MP
398 const char *p = data + cth->cth_typeoff + offset;
399 const struct ctf_type *ctt = (struct ctf_type *)p;
400 unsigned short i, kind, vlen, root;
401 unsigned int eob, toff;
74b86e22
MP
402 uint64_t size;
403 const char *name, *kname;
404
74b86e22
MP
405 kind = CTF_INFO_KIND(ctt->ctt_info);
406 vlen = CTF_INFO_VLEN(ctt->ctt_info);
407 root = CTF_INFO_ISROOT(ctt->ctt_info);
408 name = ctf_off2name(cth, data, dlen, ctt->ctt_name);
409
410 if (root)
6befd992 411 printf(" <%u> ", idx);
74b86e22 412 else
6befd992 413 printf(" [%u] ", idx);
74b86e22
MP
414
415 if ((kname = ctf_kind2name(kind)) != NULL)
416 printf("%s %s", kname, name);
417
418 if (ctt->ctt_size <= CTF_MAX_SIZE) {
419 size = ctt->ctt_size;
420 toff = sizeof(struct ctf_stype);
421 } else {
422 size = CTF_TYPE_LSIZE(ctt);
423 toff = sizeof(struct ctf_type);
424 }
425
426 switch (kind) {
427 case CTF_K_UNKNOWN:
428 case CTF_K_FORWARD:
429 break;
430 case CTF_K_INTEGER:
23543ec6
MP
431 eob = *((unsigned int *)((char *)ctt + toff));
432 toff += sizeof(unsigned int);
433 printf(" encoding=0x%x offset=%u bits=%u",
434 CTF_INT_ENCODING(eob), CTF_INT_OFFSET(eob),
435 CTF_INT_BITS(eob));
74b86e22
MP
436 break;
437 case CTF_K_FLOAT:
23543ec6
MP
438 eob = *((unsigned int *)((char *)ctt + toff));
439 toff += sizeof(unsigned int);
440 printf(" encoding=0x%x offset=%u bits=%u",
441 CTF_FP_ENCODING(eob), CTF_FP_OFFSET(eob), CTF_FP_BITS(eob));
74b86e22
MP
442 break;
443 case CTF_K_ARRAY:
23543ec6 444 toff += sizeof(struct ctf_array);
74b86e22
MP
445 break;
446 case CTF_K_FUNCTION:
23543ec6 447 toff += (vlen + (vlen & 1)) * sizeof(unsigned short);
74b86e22
MP
448 break;
449 case CTF_K_STRUCT:
450 case CTF_K_UNION:
23543ec6
MP
451 printf(" (%llu bytes)\n", size);
452
453 if (size < CTF_LSTRUCT_THRESH) {
454 for (i = 0; i < vlen; i++) {
455 struct ctf_member *ctm;
456
457 ctm = (struct ctf_member *)(p + toff);
458 toff += sizeof(struct ctf_member);
459
460 printf("\t%s type=%u off=%u\n",
461 ctf_off2name(cth, data, dlen,
462 ctm->ctm_name),
463 ctm->ctm_type, ctm->ctm_offset);
464 }
465 } else {
466 for (i = 0; i < vlen; i++) {
467 struct ctf_lmember *ctlm;
468
469 ctlm = (struct ctf_lmember *)(p + toff);
470 toff += sizeof(struct ctf_lmember);
471
472 printf("\t%s type=%u off=%llu\n",
473 ctf_off2name(cth, data, dlen,
474 ctlm->ctlm_name),
475 ctlm->ctlm_type, CTF_LMEM_OFFSET(ctlm));
476 }
477 }
74b86e22
MP
478 break;
479 case CTF_K_ENUM:
23543ec6
MP
480 printf("\n");
481 for (i = 0; i < vlen; i++) {
482 struct ctf_enum *cte;
483
484 cte = (struct ctf_enum *)(p + toff);
485 toff += sizeof(struct ctf_enum);
486
487 printf("\t%s = %u\n",
488 ctf_off2name(cth, data, dlen, cte->cte_name),
489 cte->cte_value);
490 }
74b86e22
MP
491 break;
492 case CTF_K_POINTER:
74b86e22
MP
493 case CTF_K_TYPEDEF:
494 case CTF_K_VOLATILE:
495 case CTF_K_CONST:
496 case CTF_K_RESTRICT:
497 printf(" refers to %u", ctt->ctt_type);
498 break;
499 default:
500 errx(1, "incorrect type %u at offset %u", kind, offset);
501 }
502
503 printf("\n");
504
23543ec6 505 return toff;
74b86e22
MP
506}
507
508const char *
509ctf_kind2name(unsigned short kind)
510{
511 static const char *kind_name[] = { NULL, "INTEGER", "FLOAT", "POINTER",
512 "ARRAYS", "FUNCTION", "STRUCT", "UNION", "ENUM", "FORWARD",
513 "TYPEDEF", "VOLATILE", "CONST", "RESTRICT" };
514
515 if (kind >= nitems(kind_name))
516 return NULL;
517
518 return kind_name[kind];
519}
520
f8621c6a
MP
521const char *
522ctf_off2name(struct ctf_header *cth, const char *data, off_t dlen,
523 unsigned int offset)
524{
525 const char *name;
526
527 if (CTF_NAME_STID(offset) != CTF_STRTAB_0)
528 return "external";
529
530 if (CTF_NAME_OFFSET(offset) >= cth->cth_strlen)
531 return "exceeds strlab";
532
533 if (cth->cth_stroff + CTF_NAME_OFFSET(offset) >= dlen)
534 return "invalid";
535
536 name = data + cth->cth_stroff + CTF_NAME_OFFSET(offset);
537 if (*name == '\0')
538 return "(anon)";
539
540 return name;
541}
542
543char *
544decompress(const char *buf, size_t size, off_t len)
545{
546#ifdef ZLIB
547 z_stream stream;
548 char *data;
549 int error;
550
551 data = malloc(len);
552 if (data == NULL) {
553 warn(NULL);
554 return NULL;
555 }
556
557 memset(&stream, 0, sizeof(stream));
558 stream.next_in = (void *)buf;
559 stream.avail_in = size;
560 stream.next_out = data;
561 stream.avail_out = len;
562
563 if ((error = inflateInit(&stream)) != Z_OK) {
564 warnx("zlib inflateInit failed: %s", zError(error));
565 goto exit;
566 }
567
568 if ((error = inflate(&stream, Z_FINISH)) != Z_STREAM_END) {
569 warnx("zlib inflate failed: %s", zError(error));
570 goto exit;
571 }
572
573 if ((error = inflateEnd(&stream)) != Z_OK) {
574 warnx("zlib inflateEnd failed: %s", zError(error));
575 goto exit;
576 }
577
578 if (stream.total_out != len) {
579 warnx("decompression failed: %llu != %llu",
580 stream.total_out, len);
581 goto exit;
582 }
583
584 return data;
585
586exit:
587 free(data);
588#endif /* ZLIB */
589 return NULL;
590}
591
592__dead void
593usage(void)
594{
595 extern char *__progname;
596
53477564 597 fprintf(stderr, "usage: %s [-dfhlst] [file ...]\n",
f8621c6a
MP
598 __progname);
599 exit(1);
600}
601