if inflate() fails, free the stream instead of leaking it
[ctfdump/.git] / ctfdump.c
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
38 #ifndef nitems
39 #define nitems(_a)      (sizeof((_a)) / sizeof((_a)[0]))
40 #endif
41
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)
47 #define DUMP_LABEL      (1 << 3)
48 #define DUMP_STRTAB     (1 << 4)
49 #define DUMP_STATISTIC  (1 << 5)
50 #define DUMP_TYPE       (1 << 6)
51
52 int              dump(const char *, uint8_t);
53 int              isctf(const char *, size_t);
54 __dead void      usage(void);
55
56 int              ctf_dump(const char *, size_t, uint8_t);
57 unsigned int     ctf_dump_type(struct ctf_header *, const char *, off_t,
58                      unsigned int, unsigned int);
59 const char      *ctf_kind2name(unsigned short);
60 const char      *ctf_off2name(struct ctf_header *, const char *, off_t,
61                      unsigned int);
62
63 int              elf_dump(const char *, size_t, uint8_t);
64 const char      *elf_idx2sym(size_t *, unsigned char);
65
66 /* elf.c */
67 int              iself(const char *, size_t);
68 int              elf_getshstrtab(const char *, size_t, const char **, size_t *);
69 int              elf_getsymtab(const char *, const char *, size_t,
70                      const Elf_Sym **, size_t *);
71 int              elf_getsection(const char *, const char *, const char *,
72                      size_t, const char **, size_t *);
73
74 #ifdef ZLIB
75 char            *decompress(const char *, size_t, off_t);
76 #endif /* ZLIB */
77
78 int
79 main(int argc, char *argv[])
80 {
81         const char *filename;
82         uint8_t flags = 0;
83         int ch, error = 0;
84
85         setlocale(LC_ALL, "");
86
87         while ((ch = getopt(argc, argv, "dfhlst")) != -1) {
88                 switch (ch) {
89                 case 'd':
90                         flags |= DUMP_OBJECT;
91                         break;
92                 case 'f':
93                         flags |= DUMP_FUNCTION;
94                         break;
95                 case 'h':
96                         flags |= DUMP_HEADER;
97                         break;
98                 case 'l':
99                         flags |= DUMP_LABEL;
100                         break;
101                 case 's':
102                         flags |= DUMP_STRTAB;
103                         break;
104                 case 't':
105                         flags |= DUMP_TYPE;
106                         break;
107                 default:
108                         usage();
109                 }
110         }
111
112         argc -= optind;
113         argv += optind;
114
115         /* Dump everything by default */
116         if (flags == 0)
117                 flags = 0xff;
118
119         while ((filename = *argv++) != NULL)
120                 error |= dump(filename, flags);
121
122         return error;
123 }
124
125 int
126 dump(const char *path, uint8_t flags)
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
166 const char              *strtab;
167 const Elf_Sym           *symtab;
168 size_t                   strtabsize, nsymb;
169
170 const char *
171 elf_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
189 int
190 elf_dump(const char *p, size_t filesize, uint8_t flags)
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_getsection(p, ELF_STRTAB, 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
230 int
231 isctf(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
267 int
268 ctf_dump(const char *p, size_t size, uint8_t flags)
269 {
270         struct ctf_header       *cth = (struct ctf_header *)p;
271         off_t                    dlen = cth->cth_stroff + cth->cth_strlen;
272         char                    *data;
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;
278         } else {
279                 data = (char *)p + sizeof(*cth);
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                 printf("\n");
297         }
298
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
306                         printf("  %5u %s\n", ctl->ctl_typeidx,
307                             ctf_off2name(cth, data, dlen, ctl->ctl_label));
308
309                         lbloff += sizeof(*ctl);
310                 }
311                 printf("\n");
312         }
313
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
324                         l = printf("  [%zu] %u", i++, *dsp);
325                         if ((s = elf_idx2sym(&idx, STT_OBJECT)) != NULL)
326                                 printf("%*s %s (%zu)\n", (14 - l), "", s, idx);
327                         else
328                                 printf("\n");
329
330                         objtoff += sizeof(*dsp);
331                 }
332         }
333
334         if (flags & DUMP_FUNCTION) {
335                 unsigned short          *fsp, kind, vlen;
336                 size_t                   idx = 0, i = 0;
337                 const char              *s;
338                 int                      l;
339
340                 fsp = (unsigned short *)(data + cth->cth_funcoff);
341                 while (fsp < (unsigned short *)(data + cth->cth_typeoff)) {
342                         kind = CTF_INFO_KIND(*fsp);
343                         vlen = CTF_INFO_VLEN(*fsp);
344                         fsp++;
345
346                         if (kind == CTF_K_UNKNOWN && vlen == 0)
347                                 continue;
348
349                         l = printf("  [%zu] FUNC ", i++);
350                         if ((s = elf_idx2sym(&idx, STT_FUNC)) != NULL)
351                                 printf("(%s)", s);
352                         printf(" returns: %u args: (", *fsp++);
353                         while (vlen-- > 0)
354                                 printf("%u%s", *fsp++, (vlen > 0) ? ", " : "");
355                         printf(")\n");
356                 }
357                 printf("\n");
358         }
359
360         if (flags & DUMP_STRTAB) {
361                 unsigned int             offset = 0;
362                 const char              *str;
363
364                 while (offset < cth->cth_strlen) {
365                         str = ctf_off2name(cth, data, dlen, offset);
366
367                         printf("  [%u] ", offset);
368                         if (strcmp(str, "(anon)"))
369                                 offset += printf("%s\n", str);
370                         else {
371                                 printf("\\0\n");
372                                 offset++;
373                         }
374                 }
375                 printf("\n");
376         }
377
378         if (flags & DUMP_TYPE) {
379                 unsigned int             idx = 1, offset = 0;
380
381                 while (offset < cth->cth_stroff) {
382                         offset += ctf_dump_type(cth, data, dlen, offset, idx++);
383                 }
384                 printf("\n");
385         }
386
387         if (cth->cth_flags & CTF_F_COMPRESS)
388                 free(data);
389
390         return 0;
391 }
392
393 unsigned int
394 ctf_dump_type(struct ctf_header *cth, const char *data, off_t dlen,
395     unsigned int offset, unsigned int idx)
396 {
397         const char              *p = data + cth->cth_typeoff + offset;
398         const struct ctf_type   *ctt = (struct ctf_type *)p;
399         unsigned short           i, kind, vlen, root;
400         unsigned int             eob, toff;
401         uint64_t                 size;
402         const char              *name, *kname;
403
404         kind = CTF_INFO_KIND(ctt->ctt_info);
405         vlen = CTF_INFO_VLEN(ctt->ctt_info);
406         root = CTF_INFO_ISROOT(ctt->ctt_info);
407         name = ctf_off2name(cth, data, dlen, ctt->ctt_name);
408
409         if (root)
410                 printf("  <%u> ", idx);
411         else
412                 printf("  [%u] ", idx);
413
414         if ((kname = ctf_kind2name(kind)) != NULL)
415                 printf("%s %s", kname, name);
416
417         if (ctt->ctt_size <= CTF_MAX_SIZE) {
418                 size = ctt->ctt_size;
419                 toff = sizeof(struct ctf_stype);
420         } else {
421                 size = CTF_TYPE_LSIZE(ctt);
422                 toff = sizeof(struct ctf_type);
423         }
424
425         switch (kind) {
426         case CTF_K_UNKNOWN:
427         case CTF_K_FORWARD:
428                 break;
429         case CTF_K_INTEGER:
430                 eob = *((unsigned int *)((char *)ctt + toff));
431                 toff += sizeof(unsigned int);
432                 printf(" encoding=0x%x offset=%u bits=%u",
433                     CTF_INT_ENCODING(eob), CTF_INT_OFFSET(eob),
434                     CTF_INT_BITS(eob));
435                 break;
436         case CTF_K_FLOAT:
437                 eob = *((unsigned int *)((char *)ctt + toff));
438                 toff += sizeof(unsigned int);
439                 printf(" encoding=0x%x offset=%u bits=%u",
440                     CTF_FP_ENCODING(eob), CTF_FP_OFFSET(eob), CTF_FP_BITS(eob));
441                 break;
442         case CTF_K_ARRAY:
443                 toff += sizeof(struct ctf_array);
444                 break;
445         case CTF_K_FUNCTION:
446                 toff += (vlen + (vlen & 1)) * sizeof(unsigned short);
447                 break;
448         case CTF_K_STRUCT:
449         case CTF_K_UNION:
450                 printf(" (%llu bytes)\n", size);
451
452                 if (size < CTF_LSTRUCT_THRESH) {
453                         for (i = 0; i < vlen; i++) {
454                                 struct ctf_member       *ctm;
455
456                                 ctm = (struct ctf_member *)(p + toff);
457                                 toff += sizeof(struct ctf_member);
458
459                                 printf("\t%s type=%u off=%u\n",
460                                     ctf_off2name(cth, data, dlen,
461                                         ctm->ctm_name),
462                                     ctm->ctm_type, ctm->ctm_offset);
463                         }
464                 } else {
465                         for (i = 0; i < vlen; i++) {
466                                 struct ctf_lmember      *ctlm;
467
468                                 ctlm = (struct ctf_lmember *)(p + toff);
469                                 toff += sizeof(struct ctf_lmember);
470
471                                 printf("\t%s type=%u off=%llu\n",
472                                     ctf_off2name(cth, data, dlen,
473                                         ctlm->ctlm_name),
474                                     ctlm->ctlm_type, CTF_LMEM_OFFSET(ctlm));
475                         }
476                 }
477                 break;
478         case CTF_K_ENUM:
479                 printf("\n");
480                 for (i = 0; i < vlen; i++) {
481                         struct ctf_enum *cte;
482
483                         cte = (struct ctf_enum *)(p + toff);
484                         toff += sizeof(struct ctf_enum);
485
486                         printf("\t%s = %u\n",
487                             ctf_off2name(cth, data, dlen, cte->cte_name),
488                             cte->cte_value);
489                 }
490                 break;
491         case CTF_K_POINTER:
492         case CTF_K_TYPEDEF:
493         case CTF_K_VOLATILE:
494         case CTF_K_CONST:
495         case CTF_K_RESTRICT:
496                 printf(" refers to %u", ctt->ctt_type);
497                 break;
498         default:
499                 errx(1, "incorrect type %u at offset %u", kind, offset);
500         }
501
502         printf("\n");
503
504         return toff;
505 }
506
507 const char *
508 ctf_kind2name(unsigned short kind)
509 {
510         static const char *kind_name[] = { NULL, "INTEGER", "FLOAT", "POINTER",
511            "ARRAYS", "FUNCTION", "STRUCT", "UNION", "ENUM", "FORWARD",
512            "TYPEDEF", "VOLATILE", "CONST", "RESTRICT" };
513
514         if (kind >= nitems(kind_name))
515                 return NULL;
516
517         return kind_name[kind];
518 }
519
520 const char *
521 ctf_off2name(struct ctf_header *cth, const char *data, off_t dlen,
522     unsigned int offset)
523 {
524         const char              *name;
525
526         if (CTF_NAME_STID(offset) != CTF_STRTAB_0)
527                 return "external";
528
529         if (CTF_NAME_OFFSET(offset) >= cth->cth_strlen)
530                 return "exceeds strlab";
531
532         if (cth->cth_stroff + CTF_NAME_OFFSET(offset) >= dlen)
533                 return "invalid";
534
535         name = data + cth->cth_stroff + CTF_NAME_OFFSET(offset);
536         if (*name == '\0')
537                 return "(anon)";
538
539         return name;
540 }
541
542 char *
543 decompress(const char *buf, size_t size, off_t len)
544 {
545 #ifdef ZLIB
546         z_stream                 stream;
547         char                    *data;
548         int                      error;
549
550         data = malloc(len);
551         if (data == NULL) {
552                 warn(NULL);
553                 return NULL;
554         }
555
556         memset(&stream, 0, sizeof(stream));
557         stream.next_in = (void *)buf;
558         stream.avail_in = size;
559         stream.next_out = data;
560         stream.avail_out = len;
561
562         if ((error = inflateInit(&stream)) != Z_OK) {
563                 warnx("zlib inflateInit failed: %s", zError(error));
564                 goto exit;
565         }
566
567         if ((error = inflate(&stream, Z_FINISH)) != Z_STREAM_END) {
568                 warnx("zlib inflate failed: %s", zError(error));
569                 inflateEnd(&stream);
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
586 exit:
587         free(data);
588 #endif /* ZLIB */
589         return NULL;
590 }
591
592 __dead void
593 usage(void)
594 {
595         extern char             *__progname;
596
597         fprintf(stderr, "usage: %s [-dfhlst] [file ...]\n",
598             __progname);
599         exit(1);
600 }
601