2 * Copyright (c) 2008 Hyogeol Lee <hyogeollee@gmail.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/types.h>
38 #include "_libelftc.h"
40 ELFTC_VCSID("$Id: libelftc_dem_arm.c 3513 2016-12-29 07:04:22Z kaiwang27 $");
43 * @file cpp_demangle_arm.c
44 * @brief Decode function name encoding in ARM.
46 * Function name encoding in "The Annotated C++ Reference Manual".
48 * Ref : "The Annotated C++ Reference Manual", Margaet A.Ellis,
49 * Bjarne Stroustrup, AT&T Bell Laboratories 1990, pp 122-126.
53 ENCODE_FUNC, ENCODE_OP, ENCODE_OP_CT, ENCODE_OP_DT, ENCODE_OP_USER
61 struct demangle_data {
62 bool ptr, ref, cnst, array;
63 struct cstring array_str;
65 enum encode_type type;
66 struct vector_str vec;
67 struct vector_str arg;
70 #define SIMPLE_HASH(x,y) (64 * x + y)
71 #define VEC_PUSH_STR(d,s) vector_str_push((d), (s), strlen((s)))
72 #define CPP_DEMANGLE_ARM_TRY 128
74 static void dest_cstring(struct cstring *);
75 static void dest_demangle_data(struct demangle_data *);
76 static bool init_cstring(struct cstring *, size_t);
77 static bool init_demangle_data(struct demangle_data *);
78 static bool push_CTDT(const char *, size_t, struct vector_str *);
79 static bool read_array(struct demangle_data *);
80 static bool read_class(struct demangle_data *);
81 static bool read_func(struct demangle_data *);
82 static bool read_func_name(struct demangle_data *);
83 static bool read_func_ptr(struct demangle_data *);
84 static bool read_memptr(struct demangle_data *);
85 static bool read_op(struct demangle_data *);
86 static bool read_op_user(struct demangle_data *);
87 static bool read_qual_name(struct demangle_data *);
88 static int read_subst(struct demangle_data *);
89 static int read_subst_iter(struct demangle_data *);
90 static bool read_type(struct demangle_data *);
93 * @brief Decode the input string by the ARM style.
95 * @return New allocated demangled string or NULL if failed.
98 cpp_demangle_ARM(const char *org)
100 struct demangle_data d;
101 size_t arg_begin, arg_len;
108 if (init_demangle_data(&d) == false)
115 if (read_func_name(&d) == false)
118 if (d.type == ENCODE_OP_CT) {
119 if (push_CTDT("::", 2, &d.vec) == false)
125 if (d.type == ENCODE_OP_DT) {
126 if (push_CTDT("::~", 3, &d.vec) == false)
132 if (d.type == ENCODE_OP_USER)
140 /* start argument types */
141 if (VEC_PUSH_STR(&d.vec, "(") == false)
146 const int rtn_subst = read_subst(&d);
150 else if (rtn_subst == 1)
157 const int rtn_subst_iter = read_subst_iter(&d);
159 if (rtn_subst_iter == -1)
161 else if(rtn_subst_iter == 1)
167 arg_begin = d.vec.size;
169 if (read_type(&d) == false)
173 if (VEC_PUSH_STR(&d.vec, "*") == false)
180 if (VEC_PUSH_STR(&d.vec, "&") == false)
186 if (d.cnst == true) {
187 if (VEC_PUSH_STR(&d.vec, " const") == false)
193 if (d.array == true) {
194 if (vector_str_push(&d.vec, d.array_str.buf,
195 d.array_str.size) == false)
198 dest_cstring(&d.array_str);
205 if ((arg = vector_str_substr(&d.vec, arg_begin, d.vec.size - 1,
209 if (vector_str_push(&d.arg, arg, arg_len) == false)
214 if (VEC_PUSH_STR(&d.vec, ", ") == false)
217 if (++try > CPP_DEMANGLE_ARM_TRY)
221 /* end argument types */
222 if (VEC_PUSH_STR(&d.vec, ")") == false)
226 rtn = vector_str_get_flat(&d.vec, NULL);
228 dest_demangle_data(&d);
234 * @brief Test input string is encoded by the ARM style.
236 * @return True if input string is encoded by the ARM style.
239 is_cpp_mangled_ARM(const char *org)
245 return (strstr(org, "__") != NULL);
249 dest_cstring(struct cstring *s)
261 dest_demangle_data(struct demangle_data *d)
265 vector_str_dest(&d->arg);
266 vector_str_dest(&d->vec);
268 dest_cstring(&d->array_str);
273 init_cstring(struct cstring *s, size_t len)
276 if (s == NULL || len <= 1)
279 if ((s->buf = malloc(sizeof(char) * len)) == NULL)
288 init_demangle_data(struct demangle_data *d)
299 d->array_str.buf = NULL;
300 d->array_str.size = 0;
302 d->type = ENCODE_FUNC;
304 if (vector_str_init(&d->vec) == false)
307 if (vector_str_init(&d->arg) == false) {
308 vector_str_dest(&d->vec);
317 push_CTDT(const char *s, size_t l, struct vector_str *v)
320 if (s == NULL || l == 0 || v == NULL)
323 if (vector_str_push(v, s, l) == false)
327 if (VEC_PUSH_STR(v, v->container[v->size - 2]) == false)
330 if (VEC_PUSH_STR(v, "()") == false)
337 read_array(struct demangle_data *d)
342 if (d == NULL || d->p == NULL)
352 if (ELFTC_ISDIGIT(*end) == 0)
364 dest_cstring(&d->array_str);
365 if (init_cstring(&d->array_str, len + 3) == false)
368 strncpy(d->array_str.buf + 1, d->p, len);
369 *d->array_str.buf = '[';
370 *(d->array_str.buf + len + 1) = ']';
379 read_class(struct demangle_data *d)
387 len = strtol(d->p, &str, 10);
388 if (len == 0 && (errno == EINVAL || errno == ERANGE))
394 if (vector_str_push(&d->vec, str, len) == false)
403 read_func(struct demangle_data *d)
412 assert(d->p != NULL && "d->p (org str) is NULL");
413 if ((delim = strstr(d->p, "__")) == NULL)
423 if (*d->p == 'Q' && ELFTC_ISDIGIT(*(d->p + 1))) {
426 if (read_qual_name(d) == false)
428 } else if (ELFTC_ISDIGIT(*d->p)) {
429 if (read_class(d) == false)
432 if (VEC_PUSH_STR(&d->vec, "::") == false)
436 if (vector_str_push(&d->vec, name, len) == false)
443 read_func_name(struct demangle_data *d)
455 assert(d->p != NULL && "d->p (org str) is NULL");
457 if (*d->p == '_' && *(d->p + 1) == '_') {
461 if (read_op(d) == false)
464 if (d->type == ENCODE_OP_CT || d->type == ENCODE_OP_DT ||
465 d->type == ENCODE_OP_USER)
471 /* assume delimiter is removed */
472 if (*d->p == 'Q' && ELFTC_ISDIGIT(*(d->p + 1))) {
475 assert(d->vec.size > 0);
477 len = strlen(d->vec.container[d->vec.size - 1]);
478 if ((op_name = malloc(sizeof(char) * (len + 1)))
482 snprintf(op_name, len + 1, "%s",
483 d->vec.container[d->vec.size - 1]);
484 vector_str_pop(&d->vec);
486 if (read_qual_name(d) == false)
489 if (VEC_PUSH_STR(&d->vec, "::") == false)
492 if (vector_str_push(&d->vec, op_name, len) == false)
496 } else if (ELFTC_ISDIGIT(*d->p)) {
497 assert(d->vec.size > 0);
499 len = strlen(d->vec.container[d->vec.size - 1]);
500 if ((op_name = malloc(sizeof(char) * (len + 1)))
504 snprintf(op_name, len + 1, "%s",
505 d->vec.container[d->vec.size - 1]);
506 vector_str_pop(&d->vec);
508 if (read_class(d) == false)
511 if (VEC_PUSH_STR(&d->vec, "::") == false)
514 if (vector_str_push(&d->vec, op_name, len) == false)
520 return (read_func(d));
528 /* Read function ptr type */
530 read_func_ptr(struct demangle_data *d)
532 struct demangle_data fptr;
533 size_t arg_len, rtn_len;
534 char *arg_type, *rtn_type;
540 if (init_demangle_data(&fptr) == false)
549 if (read_type(&fptr) == false) {
550 dest_demangle_data(&fptr);
555 if (fptr.ptr == true) {
556 if (VEC_PUSH_STR(&fptr.vec, "*") == false) {
557 dest_demangle_data(&fptr);
565 if (fptr.ref == true) {
566 if (VEC_PUSH_STR(&fptr.vec, "&") == false) {
567 dest_demangle_data(&fptr);
575 if (fptr.cnst == true) {
576 if (VEC_PUSH_STR(&fptr.vec, " const") == false) {
577 dest_demangle_data(&fptr);
588 if (VEC_PUSH_STR(&fptr.vec, ", ") == false) {
589 dest_demangle_data(&fptr);
594 if (++lim > CPP_DEMANGLE_ARM_TRY) {
596 dest_demangle_data(&fptr);
602 arg_type = vector_str_get_flat(&fptr.vec, &arg_len);
606 dest_demangle_data(&fptr);
608 if (init_demangle_data(&fptr) == false) {
617 if (read_type(&fptr) == false) {
619 dest_demangle_data(&fptr);
624 rtn_type = vector_str_get_flat(&fptr.vec, &rtn_len);
628 dest_demangle_data(&fptr);
630 if (vector_str_push(&d->vec, rtn_type, rtn_len) == false) {
639 if (VEC_PUSH_STR(&d->vec, " (*)(") == false) {
645 if (vector_str_push(&d->vec, arg_type, arg_len) == false) {
653 return (VEC_PUSH_STR(&d->vec, ")"));
657 read_memptr(struct demangle_data *d)
659 struct demangle_data mptr;
664 if (d == NULL || d->p == NULL)
667 if (init_demangle_data(&mptr) == false)
674 if (*mptr.p == 'Q') {
677 if (read_qual_name(&mptr) == false)
680 if (read_class(&mptr) == false)
686 if ((mptr_str = vector_str_get_flat(&mptr.vec, &len)) == NULL)
689 if (vector_str_push(&d->vec, mptr_str, len) == false)
692 if (VEC_PUSH_STR(&d->vec, "::*") == false)
698 dest_demangle_data(&mptr);
704 read_op(struct demangle_data *d)
710 assert(d->p != NULL && "d->p (org str) is NULL");
712 switch (SIMPLE_HASH(*(d->p), *(d->p+1))) {
713 case SIMPLE_HASH('m', 'l') :
715 return (VEC_PUSH_STR(&d->vec, "operator*"));
716 case SIMPLE_HASH('d', 'v') :
718 return (VEC_PUSH_STR(&d->vec, "operator/"));
719 case SIMPLE_HASH('m', 'd') :
721 return (VEC_PUSH_STR(&d->vec, "operator%"));
722 case SIMPLE_HASH('p', 'l') :
724 return (VEC_PUSH_STR(&d->vec, "operator+"));
725 case SIMPLE_HASH('m', 'i') :
727 return (VEC_PUSH_STR(&d->vec, "operator-"));
728 case SIMPLE_HASH('l', 's') :
730 return (VEC_PUSH_STR(&d->vec, "operator<<"));
731 case SIMPLE_HASH('r', 's') :
733 return (VEC_PUSH_STR(&d->vec, "operator>>"));
734 case SIMPLE_HASH('e', 'q') :
736 return (VEC_PUSH_STR(&d->vec, "operator=="));
737 case SIMPLE_HASH('n', 'e') :
739 return (VEC_PUSH_STR(&d->vec, "operator!="));
740 case SIMPLE_HASH('l', 't') :
742 return (VEC_PUSH_STR(&d->vec, "operator<"));
743 case SIMPLE_HASH('g', 't') :
745 return (VEC_PUSH_STR(&d->vec, "operator>"));
746 case SIMPLE_HASH('l', 'e') :
748 return (VEC_PUSH_STR(&d->vec, "operator<="));
749 case SIMPLE_HASH('g', 'e') :
751 return (VEC_PUSH_STR(&d->vec, "operator>="));
752 case SIMPLE_HASH('a', 'd') :
756 return (VEC_PUSH_STR(&d->vec, "operator/="));
758 return (VEC_PUSH_STR(&d->vec, "operator&"));
759 case SIMPLE_HASH('o', 'r') :
761 return (VEC_PUSH_STR(&d->vec, "operator|"));
762 case SIMPLE_HASH('e', 'r') :
764 return (VEC_PUSH_STR(&d->vec, "operator^"));
765 case SIMPLE_HASH('a', 'a') :
769 return (VEC_PUSH_STR(&d->vec, "operator&="));
771 return (VEC_PUSH_STR(&d->vec, "operator&&"));
772 case SIMPLE_HASH('o', 'o') :
774 return (VEC_PUSH_STR(&d->vec, "operator||"));
775 case SIMPLE_HASH('n', 't') :
777 return (VEC_PUSH_STR(&d->vec, "operator!"));
778 case SIMPLE_HASH('c', 'o') :
780 return (VEC_PUSH_STR(&d->vec, "operator~"));
781 case SIMPLE_HASH('p', 'p') :
783 return (VEC_PUSH_STR(&d->vec, "operator++"));
784 case SIMPLE_HASH('m', 'm') :
786 return (VEC_PUSH_STR(&d->vec, "operator--"));
787 case SIMPLE_HASH('a', 's') :
789 return (VEC_PUSH_STR(&d->vec, "operator="));
790 case SIMPLE_HASH('r', 'f') :
792 return (VEC_PUSH_STR(&d->vec, "operator->"));
793 case SIMPLE_HASH('a', 'p') :
795 if (*(d->p + 2) != 'l')
799 return (VEC_PUSH_STR(&d->vec, "operator+="));
800 case SIMPLE_HASH('a', 'm') :
804 return (VEC_PUSH_STR(&d->vec, "operator-="));
805 } else if (*d->p == 'u') {
807 return (VEC_PUSH_STR(&d->vec, "operator*="));
808 } else if (*d->p == 'd') {
810 return (VEC_PUSH_STR(&d->vec, "operator%="));
814 case SIMPLE_HASH('a', 'l') :
816 if (*(d->p + 2) != 's')
820 return (VEC_PUSH_STR(&d->vec, "operator<<="));
821 case SIMPLE_HASH('a', 'r') :
823 if (*(d->p + 2) != 's')
827 return (VEC_PUSH_STR(&d->vec, "operator>>="));
828 case SIMPLE_HASH('a', 'o') :
830 if (*(d->p + 2) != 'r')
834 return (VEC_PUSH_STR(&d->vec, "operator|="));
835 case SIMPLE_HASH('a', 'e') :
837 if (*(d->p + 2) != 'r')
841 return (VEC_PUSH_STR(&d->vec, "operator^="));
842 case SIMPLE_HASH('c', 'm') :
844 return (VEC_PUSH_STR(&d->vec, "operator,"));
845 case SIMPLE_HASH('r', 'm') :
847 return (VEC_PUSH_STR(&d->vec, "operator->*"));
848 case SIMPLE_HASH('c', 'l') :
850 return (VEC_PUSH_STR(&d->vec, "()"));
851 case SIMPLE_HASH('v', 'c') :
853 return (VEC_PUSH_STR(&d->vec, "[]"));
854 case SIMPLE_HASH('c', 't') :
856 d->type = ENCODE_OP_CT;
858 if (*d->p == 'Q' && ELFTC_ISDIGIT(*(d->p + 1))) {
861 return (read_qual_name(d));
862 } else if (ELFTC_ISDIGIT(*d->p))
863 return (read_class(d));
866 case SIMPLE_HASH('d', 't') :
868 d->type = ENCODE_OP_DT;
870 if (*d->p == 'Q' && ELFTC_ISDIGIT(*(d->p + 1))) {
873 return (read_qual_name(d));
874 } else if (ELFTC_ISDIGIT(*d->p))
875 return (read_class(d));
878 case SIMPLE_HASH('n', 'w') :
880 return (VEC_PUSH_STR(&d->vec, "operator new()"));
881 case SIMPLE_HASH('d', 'l') :
883 return (VEC_PUSH_STR(&d->vec, "operator delete()"));
884 case SIMPLE_HASH('o', 'p') :
885 /* __op<TO_TYPE>__<FROM_TYPE> */
888 d->type = ENCODE_OP_USER;
890 return (read_op_user(d));
897 read_op_user(struct demangle_data *d)
899 struct demangle_data from, to;
900 size_t from_len, to_len;
902 char *from_str, *to_str;
907 if (init_demangle_data(&from) == false)
913 if (init_demangle_data(&to) == false)
920 if (read_qual_name(&to) == false)
924 if (vector_str_pop(&to.vec) == false)
927 if (read_class(&to) == false)
934 if ((to_str = vector_str_get_flat(&to.vec, &to_len)) == NULL)
938 if (*from.p == 'Q') {
941 if (read_qual_name(&from) == false)
945 if (vector_str_pop(&from.vec) == false)
948 if (read_class(&from) == false)
952 if ((from_str = vector_str_get_flat(&from.vec, &from_len)) == NULL)
955 if (vector_str_push(&d->vec, from_str, from_len) == false)
958 if (VEC_PUSH_STR(&d->vec, "::operator ") == false)
961 if (vector_str_push(&d->vec, to_str, to_len) == false)
964 rtn = VEC_PUSH_STR(&d->vec, "()");
968 dest_demangle_data(&to);
969 dest_demangle_data(&from);
974 /* single digit + class names */
976 read_qual_name(struct demangle_data *d)
984 assert(d->p != NULL && "d->p (org str) is NULL");
985 assert(*d->p > 48 && *d->p < 58 && "*d->p not in ASCII numeric range");
992 for (i = 0; i < num ; ++i) {
993 if (read_class(d) == false)
996 if (VEC_PUSH_STR(&d->vec, "::") == false)
1006 /* Return -1 at fail, 0 at success, and 1 at end */
1008 read_subst(struct demangle_data *d)
1016 idx = strtol(d->p + 1, &str, 10);
1017 if (idx == 0 && (errno == EINVAL || errno == ERANGE))
1021 assert(str != NULL);
1025 if (VEC_PUSH_STR(&d->vec, d->arg.container[idx - 1]) == false)
1028 if (VEC_PUSH_STR(&d->arg, d->arg.container[idx - 1]) == false)
1038 read_subst_iter(struct demangle_data *d)
1049 assert(*d->p > 48 && *d->p < 58 && "*d->p not in ASCII numeric range");
1051 repeat = *d->p - 48;
1057 idx = strtol(d->p, &str, 10);
1058 if (idx == 0 && (errno == EINVAL || errno == ERANGE))
1062 assert(str != NULL);
1066 for (i = 0; i < repeat ; ++i) {
1067 if (VEC_PUSH_STR(&d->vec, d->arg.container[idx - 1]) == false)
1070 if (VEC_PUSH_STR(&d->arg, d->arg.container[idx - 1]) == false)
1073 if (i != repeat - 1 &&
1074 VEC_PUSH_STR(&d->vec, ", ") == false)
1085 read_type(struct demangle_data *d)
1091 assert(d->p != NULL && "d->p (org str) is NULL");
1093 while (*d->p == 'U' || *d->p == 'C' || *d->p == 'V' || *d->p == 'S' ||
1094 *d->p == 'P' || *d->p == 'R' || *d->p == 'A' || *d->p == 'F' ||
1100 if (VEC_PUSH_STR(&d->vec, "unsigned ") == false)
1110 if (VEC_PUSH_STR(&d->vec, "const ") ==
1119 if (VEC_PUSH_STR(&d->vec, "volatile ") == false)
1126 if (VEC_PUSH_STR(&d->vec, "signed ") == false)
1134 return (read_func_ptr(d));
1150 if (read_array(d) == false)
1157 if (read_memptr(d) == false)
1166 if (ELFTC_ISDIGIT(*d->p))
1167 return (read_class(d));
1173 return (read_qual_name(d));
1177 return (VEC_PUSH_STR(&d->vec, "void"));
1181 return (VEC_PUSH_STR(&d->vec, "char"));
1185 return (VEC_PUSH_STR(&d->vec, "short"));
1189 return (VEC_PUSH_STR(&d->vec, "int"));
1193 return (VEC_PUSH_STR(&d->vec, "long"));
1197 return (VEC_PUSH_STR(&d->vec, "float"));
1201 return (VEC_PUSH_STR(&d->vec, "double"));
1205 return (VEC_PUSH_STR(&d->vec, "long double"));
1209 return (VEC_PUSH_STR(&d->vec, "..."));