Move ELF functions into elf.c
[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 *);
71int elf_getstrtab(const char *, const char *, size_t,
72 const char **, size_t *);
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. */
206 if (elf_getstrtab(p, shstrtab, shstrtabsize, &strtab, &strtabsize))
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) {
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",
287 ctf_off2name(cth, data, dlen, cth->cth_parname));
288 printf("cth_parname = %s\n",
289 ctf_off2name(cth, data, dlen, cth->cth_parname));
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 }
297
751fc09a
MP
298 if (flags & DUMP_LABEL) {
299 unsigned int lbloff = cth->cth_lbloff;
300 struct ctf_lblent *ctl;
301
302 while (lbloff < cth->cth_objtoff) {
303 ctl = (struct ctf_lblent *)(data + lbloff);
304
305 printf("%5u %s\n", ctl->ctl_typeidx,
306 ctf_off2name(cth, data, dlen, ctl->ctl_label));
307
308 lbloff += sizeof(*ctl);
309 }
310 }
311
9fe3b2c8
MP
312 if (flags & DUMP_OBJECT) {
313 unsigned int objtoff = cth->cth_objtoff;
314 size_t idx = 0, i = 0;
315 unsigned short *dsp;
316 const char *s;
317 int l;
318
319 while (objtoff < cth->cth_funcoff) {
320 dsp = (unsigned short *)(data + objtoff);
321
322 l = printf("[%zu] %u", i++, *dsp);
323 if ((s = elf_idx2sym(&idx, STT_OBJECT)) != NULL)
324 printf("%*s %s (%zu)\n", (12 - l), "", s, idx);
325 else
326 printf("\n");
327
328 objtoff += sizeof(*dsp);
329 }
330 }
331
acada86d
MP
332 if (flags & DUMP_FUNCTION) {
333 unsigned short *fsp, kind, vlen;
334 size_t idx = 0, i = 0;
335 const char *s;
336 int l;
337
338 fsp = (unsigned short *)(data + cth->cth_funcoff);
339 while (fsp < (unsigned short *)(data + cth->cth_typeoff)) {
340 kind = CTF_INFO_KIND(*fsp);
341 vlen = CTF_INFO_VLEN(*fsp);
342 fsp++;
343
344 if (kind == CTF_K_UNKNOWN && vlen == 0)
345 continue;
346
347 l = printf("%u [%zu] FUNC", vlen, i++);
348 if ((s = elf_idx2sym(&idx, STT_FUNC)) != NULL)
349 printf(" (%s)", s);
350 printf(" returns: %u args: (", *fsp++);
351 while (vlen-- > 0)
352 printf("%u%s", *fsp++, (vlen > 0) ? ", " : "");
353 printf(")\n");
354 }
355 }
356
80c28199
MP
357 if (flags & DUMP_STRTAB) {
358 unsigned int offset = 0;
359 const char *str;
360
361 while (offset < cth->cth_strlen) {
362 str = data + cth->cth_stroff + offset;
363
364 printf("[%u] ", offset);
365 if (*str != '\0')
366 offset += printf("%s\n", str);
367 else {
368 printf("\\0\n");
369 offset++;
370 }
371 }
372 }
373
74b86e22
MP
374 if (flags & DUMP_TYPE) {
375 unsigned int idx = 1, offset = 0;
376
377 while (offset < cth->cth_stroff)
378 offset += ctf_dump_type(cth, data, dlen, offset, idx++);
379
380 }
381
f8621c6a
MP
382 if (cth->cth_flags & CTF_F_COMPRESS)
383 free(data);
384
385 return 0;
386}
387
74b86e22
MP
388unsigned int
389ctf_dump_type(struct ctf_header *cth, const char *data, off_t dlen,
390 unsigned int offset, unsigned int idx)
391{
23543ec6
MP
392 const char *p = data + cth->cth_typeoff + offset;
393 const struct ctf_type *ctt = (struct ctf_type *)p;
394 unsigned short i, kind, vlen, root;
395 unsigned int eob, toff;
74b86e22
MP
396 uint64_t size;
397 const char *name, *kname;
398
74b86e22
MP
399 kind = CTF_INFO_KIND(ctt->ctt_info);
400 vlen = CTF_INFO_VLEN(ctt->ctt_info);
401 root = CTF_INFO_ISROOT(ctt->ctt_info);
402 name = ctf_off2name(cth, data, dlen, ctt->ctt_name);
403
404 if (root)
405 printf("<%u> ", idx);
406 else
407 printf("[%u] ", idx);
408
409 if ((kname = ctf_kind2name(kind)) != NULL)
410 printf("%s %s", kname, name);
411
412 if (ctt->ctt_size <= CTF_MAX_SIZE) {
413 size = ctt->ctt_size;
414 toff = sizeof(struct ctf_stype);
415 } else {
416 size = CTF_TYPE_LSIZE(ctt);
417 toff = sizeof(struct ctf_type);
418 }
419
420 switch (kind) {
421 case CTF_K_UNKNOWN:
422 case CTF_K_FORWARD:
423 break;
424 case CTF_K_INTEGER:
23543ec6
MP
425 eob = *((unsigned int *)((char *)ctt + toff));
426 toff += sizeof(unsigned int);
427 printf(" encoding=0x%x offset=%u bits=%u",
428 CTF_INT_ENCODING(eob), CTF_INT_OFFSET(eob),
429 CTF_INT_BITS(eob));
74b86e22
MP
430 break;
431 case CTF_K_FLOAT:
23543ec6
MP
432 eob = *((unsigned int *)((char *)ctt + toff));
433 toff += sizeof(unsigned int);
434 printf(" encoding=0x%x offset=%u bits=%u",
435 CTF_FP_ENCODING(eob), CTF_FP_OFFSET(eob), CTF_FP_BITS(eob));
74b86e22
MP
436 break;
437 case CTF_K_ARRAY:
23543ec6 438 toff += sizeof(struct ctf_array);
74b86e22
MP
439 break;
440 case CTF_K_FUNCTION:
23543ec6 441 toff += (vlen + (vlen & 1)) * sizeof(unsigned short);
74b86e22
MP
442 break;
443 case CTF_K_STRUCT:
444 case CTF_K_UNION:
23543ec6
MP
445 printf(" (%llu bytes)\n", size);
446
447 if (size < CTF_LSTRUCT_THRESH) {
448 for (i = 0; i < vlen; i++) {
449 struct ctf_member *ctm;
450
451 ctm = (struct ctf_member *)(p + toff);
452 toff += sizeof(struct ctf_member);
453
454 printf("\t%s type=%u off=%u\n",
455 ctf_off2name(cth, data, dlen,
456 ctm->ctm_name),
457 ctm->ctm_type, ctm->ctm_offset);
458 }
459 } else {
460 for (i = 0; i < vlen; i++) {
461 struct ctf_lmember *ctlm;
462
463 ctlm = (struct ctf_lmember *)(p + toff);
464 toff += sizeof(struct ctf_lmember);
465
466 printf("\t%s type=%u off=%llu\n",
467 ctf_off2name(cth, data, dlen,
468 ctlm->ctlm_name),
469 ctlm->ctlm_type, CTF_LMEM_OFFSET(ctlm));
470 }
471 }
74b86e22
MP
472 break;
473 case CTF_K_ENUM:
23543ec6
MP
474 printf("\n");
475 for (i = 0; i < vlen; i++) {
476 struct ctf_enum *cte;
477
478 cte = (struct ctf_enum *)(p + toff);
479 toff += sizeof(struct ctf_enum);
480
481 printf("\t%s = %u\n",
482 ctf_off2name(cth, data, dlen, cte->cte_name),
483 cte->cte_value);
484 }
74b86e22
MP
485 break;
486 case CTF_K_POINTER:
74b86e22
MP
487 case CTF_K_TYPEDEF:
488 case CTF_K_VOLATILE:
489 case CTF_K_CONST:
490 case CTF_K_RESTRICT:
491 printf(" refers to %u", ctt->ctt_type);
492 break;
493 default:
494 errx(1, "incorrect type %u at offset %u", kind, offset);
495 }
496
497 printf("\n");
498
23543ec6 499 return toff;
74b86e22
MP
500}
501
502const char *
503ctf_kind2name(unsigned short kind)
504{
505 static const char *kind_name[] = { NULL, "INTEGER", "FLOAT", "POINTER",
506 "ARRAYS", "FUNCTION", "STRUCT", "UNION", "ENUM", "FORWARD",
507 "TYPEDEF", "VOLATILE", "CONST", "RESTRICT" };
508
509 if (kind >= nitems(kind_name))
510 return NULL;
511
512 return kind_name[kind];
513}
514
f8621c6a
MP
515const char *
516ctf_off2name(struct ctf_header *cth, const char *data, off_t dlen,
517 unsigned int offset)
518{
519 const char *name;
520
521 if (CTF_NAME_STID(offset) != CTF_STRTAB_0)
522 return "external";
523
524 if (CTF_NAME_OFFSET(offset) >= cth->cth_strlen)
525 return "exceeds strlab";
526
527 if (cth->cth_stroff + CTF_NAME_OFFSET(offset) >= dlen)
528 return "invalid";
529
530 name = data + cth->cth_stroff + CTF_NAME_OFFSET(offset);
531 if (*name == '\0')
532 return "(anon)";
533
534 return name;
535}
536
537char *
538decompress(const char *buf, size_t size, off_t len)
539{
540#ifdef ZLIB
541 z_stream stream;
542 char *data;
543 int error;
544
545 data = malloc(len);
546 if (data == NULL) {
547 warn(NULL);
548 return NULL;
549 }
550
551 memset(&stream, 0, sizeof(stream));
552 stream.next_in = (void *)buf;
553 stream.avail_in = size;
554 stream.next_out = data;
555 stream.avail_out = len;
556
557 if ((error = inflateInit(&stream)) != Z_OK) {
558 warnx("zlib inflateInit failed: %s", zError(error));
559 goto exit;
560 }
561
562 if ((error = inflate(&stream, Z_FINISH)) != Z_STREAM_END) {
563 warnx("zlib inflate failed: %s", zError(error));
564 goto exit;
565 }
566
567 if ((error = inflateEnd(&stream)) != Z_OK) {
568 warnx("zlib inflateEnd failed: %s", zError(error));
569 goto exit;
570 }
571
572 if (stream.total_out != len) {
573 warnx("decompression failed: %llu != %llu",
574 stream.total_out, len);
575 goto exit;
576 }
577
578 return data;
579
580exit:
581 free(data);
582#endif /* ZLIB */
583 return NULL;
584}
585
586__dead void
587usage(void)
588{
589 extern char *__progname;
590
53477564 591 fprintf(stderr, "usage: %s [-dfhlst] [file ...]\n",
f8621c6a
MP
592 __progname);
593 exit(1);
594}
595