5 * This work is licensed under the terms of 3-clause BSD license.
6 * See COPYING file in the top-level directory.
13 unsigned int is_array:1;
14 unsigned int is_ptr:1;
15 unsigned int is_struct:1; // split for args
16 unsigned int is_retreg:1; // register to return to caller
17 unsigned int is_va_list:1;
20 struct parsed_proto_arg {
22 struct parsed_type type;
23 struct parsed_proto *fptr;
30 struct parsed_type ret_type;
31 struct parsed_type type;
33 struct parsed_proto_arg arg[16];
37 unsigned int is_func:1;
38 unsigned int is_stdcall:1;
39 unsigned int is_fastcall:1;
40 unsigned int is_vararg:1; // vararg func
41 unsigned int is_fptr:1;
42 unsigned int is_noreturn:1;
43 unsigned int is_unresolved:1;
44 unsigned int is_userstack:1;
45 unsigned int is_include:1; // not from top-level header
46 unsigned int is_osinc:1; // OS/system library func
47 unsigned int is_cinc:1; // crt library func
48 unsigned int is_arg:1; // declared in some func arg
49 unsigned int has_structarg:1;
50 unsigned int has_retreg:1;
53 struct parsed_struct {
57 struct parsed_proto pp;
62 static const char *hdrfn;
63 static int hdrfline = 0;
65 static void pp_copy_arg(struct parsed_proto_arg *d,
66 const struct parsed_proto_arg *s);
68 static int b_pp_c_handler(char *proto, const char *fname,
69 int is_include, int is_osinc, int is_cinc);
70 static int struct_handler(FILE *fhdr, char *proto, int *line);
72 static int do_protostrs(FILE *fhdr, const char *fname, int is_include)
74 const char *finc_name;
75 const char *hdrfn_saved;
89 is_cinc = strstr(fname, "stdc.hlist") != NULL;
90 is_osinc = is_cinc || strstr(fname, "win32.hlist") != NULL;
92 while (fgets(protostr, sizeof(protostr), fhdr))
95 if (strncmp(protostr, "//#include ", 11) == 0) {
96 finc_name = protostr + 11;
97 p = strpbrk(finc_name, "\r\n ");
102 p = strrchr(hdrfn_saved, '/');
104 memcpy(path, hdrfn_saved,
105 p - hdrfn_saved + 1);
106 path[p - hdrfn_saved + 1] = 0;
108 snprintf(fname_inc, sizeof(fname_inc), "%s%s",
110 finc = fopen(fname_inc, "r");
112 printf("%s:%d: can't open '%s'\n",
113 fname_inc, line, finc_name);
116 ret = do_protostrs(finc, finc_name, 1);
122 if (strncmp(sskip(protostr), "//", 2) == 0)
125 p = protostr + strlen(protostr);
126 for (p--; p >= protostr && my_isblank(*p); --p)
133 if (!strncmp(protostr, "struct", 6)
134 && strchr(protostr, '{') != NULL)
135 ret = struct_handler(fhdr, protostr, &line);
137 ret = b_pp_c_handler(protostr, hdrfn,
138 is_include, is_osinc, is_cinc);
151 static int get_regparm(char *dst, size_t dlen, char *p, int *retreg)
166 for (o = 0; o < dlen; i++) {
178 static const char *known_type_mod[] = {
187 static const char *known_ptr_types[] = {
202 "HIMC", // DWORD in mingw, ptr in wine..
221 "PMEMORY_BASIC_INFORMATION",
233 static const char *ignored_keywords[] = {
241 static int typecmp(const char *n, const char *t)
243 for (; *t != 0; n++, t++) {
244 while (n[0] == ' ' && (n[1] == ' ' || n[1] == '*'))
246 while (t[0] == ' ' && (t[1] == ' ' || t[1] == '*'))
255 static const char *skip_type_mod(const char *n)
260 for (i = 0; i < ARRAY_SIZE(known_type_mod); i++) {
261 len = strlen(known_type_mod[i]);
262 if (strncmp(n, known_type_mod[i], len) != 0)
264 if (!my_isblank(n[len]))
268 while (my_isblank(*n))
276 static int check_type(const char *name, struct parsed_type *type)
282 n = skip_type_mod(name);
284 if (!strncmp(n, "struct", 6) && my_isblank(n[6])) {
288 while (my_isblank(*n))
292 for (i = 0; i < ARRAY_SIZE(known_ptr_types); i++) {
293 if (typecmp(n, known_ptr_types[i]))
300 if (n[0] == 'L' && n[1] == 'P' && strncmp(n, "LPARAM", 6))
303 // assume single word
304 while (!my_isblank(*n) && !my_issep(*n))
309 while (my_isblank(*n))
320 type->name = strndup(name, ret);
321 if (IS(type->name, "__VALIST") || IS(type->name, "va_list"))
322 type->is_va_list = 1;
323 if (IS(type->name, "VOID"))
324 memcpy(type->name, "void", 4);
329 /* args are always expanded to 32bit */
330 static const char *map_reg(const char *reg)
332 const char *regs_f[] = { "eax", "ebx", "ecx", "edx", "esi", "edi" };
333 const char *regs_w[] = { "ax", "bx", "cx", "dx", "si", "di" };
334 const char *regs_b[] = { "al", "bl", "cl", "dl" };
337 for (i = 0; i < ARRAY_SIZE(regs_w); i++)
338 if (IS(reg, regs_w[i]))
341 for (i = 0; i < ARRAY_SIZE(regs_b); i++)
342 if (IS(reg, regs_b[i]))
348 static int check_struct_arg(struct parsed_proto_arg *arg)
350 if (IS(arg->type.name, "POINT"))
356 static int parse_protostr(char *protostr, struct parsed_proto *pp)
358 struct parsed_proto_arg *arg;
369 if (p[0] == '/' && p[1] == '/') {
370 printf("%s:%d: commented out?\n", hdrfn, hdrfline);
374 // allow start of line comment
375 if (p[0] == '/' && p[1] == '*') {
376 p = strstr(p + 2, "*/");
378 printf("%s:%d: multiline comments unsupported\n",
385 // we need remaining hints in comments, so strip / *
386 for (p1 = p; p1[0] != 0 && p1[1] != 0; p1++) {
387 if ((p1[0] == '/' && p1[1] == '*')
388 || (p1[0] == '*' && p1[1] == '/'))
392 if (!strncmp(p, "DECLSPEC_NORETURN ", 18)) {
397 for (i = 0; i < ARRAY_SIZE(ignored_keywords); i++) {
398 l = strlen(ignored_keywords[i]);
399 if (!strncmp(p, ignored_keywords[i], l) && my_isblank(p[l]))
400 p = sskip(p + l + 1);
403 ret = check_type(p, &pp->ret_type);
405 printf("%s:%d:%zd: unhandled return in '%s'\n",
406 hdrfn, hdrfline, (p - protostr) + 1, protostr);
411 if (!strncmp(p, "noreturn ", 9)) {
416 if (!strchr(p, ')')) {
417 p = next_idt(buf, sizeof(buf), p);
420 printf("%s:%d:%zd: var name missing\n",
421 hdrfn, hdrfline, (p - protostr) + 1);
424 strcpy(pp->name, buf);
429 pp->ret_type.is_array = 1;
441 p = next_word(cconv, sizeof(cconv), p);
444 printf("%s:%d:%zd: cconv missing\n",
445 hdrfn, hdrfline, (p - protostr) + 1);
448 if (IS(cconv, "__cdecl"))
450 else if (IS(cconv, "__stdcall"))
452 else if (IS(cconv, "__fastcall")) {
454 pp->is_stdcall = 1; // sort of..
456 else if (IS(cconv, "__thiscall"))
458 else if (IS(cconv, "__userpurge"))
459 pp->is_stdcall = 1; // IDA
460 else if (IS(cconv, "__usercall"))
461 pp->is_stdcall = 0; // IDA
462 else if (IS(cconv, "__userstack")) {
463 pp->is_stdcall = 0; // custom
464 pp->is_userstack = 1;
466 else if (IS(cconv, "WINAPI"))
469 printf("%s:%d:%zd: unhandled cconv: '%s'\n",
470 hdrfn, hdrfline, (p - protostr) + 1, cconv);
476 printf("%s:%d:%zd: '*' expected\n",
477 hdrfn, hdrfline, (p - protostr) + 1);
481 // XXX: skipping extra asterisks, for now
487 p = next_idt(buf, sizeof(buf), p);
490 //printf("%s:%d:%zd: func name missing\n",
491 // hdrfn, hdrfline, (p - protostr) + 1);
494 strcpy(pp->name, buf);
496 ret = get_regparm(regparm, sizeof(regparm), p, &is_retreg);
498 if (!IS(regparm, "eax") && !IS(regparm, "ax")
499 && !IS(regparm, "al") && !IS(regparm, "edx:eax"))
501 printf("%s:%d:%zd: bad regparm: %s\n",
502 hdrfn, hdrfline, (p - protostr) + 1, regparm);
511 // not really ret_type is array, but ohwell
512 pp->ret_type.is_array = 1;
513 p = strchr(p + 1, ']');
515 printf("%s:%d:%zd: ']' expected\n",
516 hdrfn, hdrfline, (p - protostr) + 1);
522 printf("%s:%d:%zd: ')' expected\n",
523 hdrfn, hdrfline, (p - protostr) + 1);
530 printf("%s:%d:%zd: '(' expected, got '%c'\n",
531 hdrfn, hdrfline, (p - protostr) + 1, *p);
538 if ((!strncmp(p, "void", 4) || !strncmp(p, "VOID", 4))
539 && *sskip(p + 4) == ')')
550 printf("%s:%d:%zd: ',' expected\n",
551 hdrfn, hdrfline, (p - protostr) + 1);
557 if (!strncmp(p, "...", 3)) {
564 printf("%s:%d:%zd: ')' expected\n",
565 hdrfn, hdrfline, (p - protostr) + 1);
569 arg = &pp->arg[xarg];
573 ret = check_type(p, &arg->type);
575 printf("%s:%d:%zd: unhandled type for arg%d\n",
576 hdrfn, hdrfline, (p - protostr) + 1, xarg);
583 arg->fptr = calloc(1, sizeof(*arg->fptr));
584 ret = parse_protostr(p1, arg->fptr);
586 printf("%s:%d:%zd: funcarg parse failed\n",
587 hdrfn, hdrfline, p1 - protostr);
590 arg->fptr->is_arg = 1;
591 // we don't use actual names right now..
592 snprintf(arg->fptr->name,
593 sizeof(arg->fptr->name), "a%d", xarg);
594 // we'll treat it as void * for non-calls
595 arg->type.name = strdup("void *");
596 arg->type.is_ptr = 1;
601 p = next_idt(buf, sizeof(buf), p);
605 printf("%s:%d:%zd: idt missing for arg%d\n",
606 hdrfn, hdrfline, (p - protostr) + 1, xarg);
612 ret = get_regparm(regparm, sizeof(regparm), p, &is_retreg);
617 arg->reg = strdup(map_reg(regparm));
618 arg->type.is_retreg = is_retreg;
619 pp->has_retreg |= is_retreg;
622 if (strstr(arg->type.name, "int64")
623 || IS(arg->type.name, "double"))
626 free(arg->type.name);
627 arg->type.name = strdup("int");
628 pp_copy_arg(&pp->arg[xarg], arg);
632 ret = check_struct_arg(arg);
634 pp->has_structarg = 1;
635 arg->type.is_struct = 1;
636 free(arg->type.name);
637 arg->type.name = strdup("int");
638 for (l = 0; l < ret; l++) {
639 pp_copy_arg(&pp->arg[xarg], arg);
645 if (xarg > 0 && (IS(cconv, "__fastcall") || IS(cconv, "__thiscall"))) {
646 if (pp->arg[0].reg != NULL) {
647 printf("%s:%d: %s with arg1 spec %s?\n",
648 hdrfn, hdrfline, cconv, pp->arg[0].reg);
650 pp->arg[0].reg = strdup("ecx");
653 if (xarg > 1 && IS(cconv, "__fastcall")) {
654 if (pp->arg[1].reg != NULL) {
655 printf("%s:%d: %s with arg2 spec %s?\n",
656 hdrfn, hdrfline, cconv, pp->arg[1].reg);
658 pp->arg[1].reg = strdup("edx");
663 for (i = 0; i < pp->argc; i++) {
664 if (pp->arg[i].reg == NULL)
670 if (pp->argc == 1 && pp->arg[0].reg != NULL
671 && IS(pp->arg[0].reg, "ecx"))
675 else if (pp->argc_reg == 2
676 && pp->arg[0].reg != NULL && IS(pp->arg[0].reg, "ecx")
677 && pp->arg[1].reg != NULL && IS(pp->arg[1].reg, "edx"))
682 if (pp->is_vararg && (pp->is_stdcall || pp->is_fastcall)) {
683 printf("%s:%d: vararg %s?\n", hdrfn, hdrfline, cconv);
690 static int pp_name_cmp(const void *p1, const void *p2)
692 const struct parsed_proto *pp1 = p1, *pp2 = p2;
693 return strcmp(pp1->name, pp2->name);
696 static int ps_name_cmp(const void *p1, const void *p2)
698 const struct parsed_struct *ps1 = p1, *ps2 = p2;
699 return strcmp(ps1->name, ps2->name);
702 // parsed struct cache
703 static struct parsed_struct *ps_cache;
704 static int ps_cache_size;
705 static int ps_cache_alloc;
707 static int struct_handler(FILE *fhdr, char *proto, int *line)
709 struct parsed_struct *ps;
715 if (ps_cache_size >= ps_cache_alloc) {
716 ps_cache_alloc = ps_cache_alloc * 2 + 64;
717 ps_cache = realloc(ps_cache, ps_cache_alloc
718 * sizeof(ps_cache[0]));
719 my_assert_not(ps_cache, NULL);
720 memset(ps_cache + ps_cache_size, 0,
721 (ps_cache_alloc - ps_cache_size)
722 * sizeof(ps_cache[0]));
725 ps = &ps_cache[ps_cache_size++];
726 ret = sscanf(proto, "struct %255s {", ps->name);
728 printf("%s:%d: struct parse failed\n", hdrfn, *line);
732 while (fgets(lstr, sizeof(lstr), fhdr))
737 if (p[0] == '/' && p[1] == '/')
742 if (m >= ARRAY_SIZE(ps->members)) {
743 printf("%s:%d: too many struct members\n",
749 ret = parse_protostr(p, &ps->members[m].pp);
751 printf("%s:%d: struct member #%d/%02x "
752 "doesn't parse\n", hdrfn, *line,
756 ps->members[m].offset = offset;
761 ps->member_count = m;
766 // parsed proto cache
767 static struct parsed_proto *pp_cache;
768 static int pp_cache_size;
769 static int pp_cache_alloc;
771 static int b_pp_c_handler(char *proto, const char *fname,
772 int is_include, int is_osinc, int is_cinc)
776 if (pp_cache_size >= pp_cache_alloc) {
777 pp_cache_alloc = pp_cache_alloc * 2 + 64;
778 pp_cache = realloc(pp_cache, pp_cache_alloc
779 * sizeof(pp_cache[0]));
780 my_assert_not(pp_cache, NULL);
781 memset(pp_cache + pp_cache_size, 0,
782 (pp_cache_alloc - pp_cache_size)
783 * sizeof(pp_cache[0]));
786 ret = parse_protostr(proto, &pp_cache[pp_cache_size]);
790 pp_cache[pp_cache_size].is_include = is_include;
791 pp_cache[pp_cache_size].is_osinc = is_osinc;
792 pp_cache[pp_cache_size].is_cinc = is_cinc;
797 static void build_caches(FILE *fhdr)
805 ret = do_protostrs(fhdr, hdrfn, 0);
809 qsort(pp_cache, pp_cache_size, sizeof(pp_cache[0]), pp_name_cmp);
810 qsort(ps_cache, ps_cache_size, sizeof(ps_cache[0]), ps_name_cmp);
811 fseek(fhdr, pos, SEEK_SET);
814 static const struct parsed_proto *proto_parse(FILE *fhdr, const char *sym,
817 const struct parsed_proto *pp_ret;
818 struct parsed_proto pp_search;
821 if (pp_cache == NULL)
824 if (sym[0] == '_') // && strncmp(fname, "stdc", 4) == 0)
827 strcpy(pp_search.name, sym);
828 p = strchr(pp_search.name, '@');
832 pp_ret = bsearch(&pp_search, pp_cache, pp_cache_size,
833 sizeof(pp_cache[0]), pp_name_cmp);
834 if (pp_ret == NULL && !quiet)
835 printf("%s: sym '%s' is missing\n", hdrfn, sym);
840 static const struct parsed_proto *proto_lookup_struct(FILE *fhdr,
841 const char *type, int offset)
843 struct parsed_struct ps_search, *ps;
846 if (pp_cache == NULL)
848 if (ps_cache_size == 0)
851 while (my_isblank(*type))
853 if (!strncmp(type, "struct", 6) && my_isblank(type[6]))
856 if (sscanf(type, "%255s", ps_search.name) != 1)
859 ps = bsearch(&ps_search, ps_cache, ps_cache_size,
860 sizeof(ps_cache[0]), ps_name_cmp);
862 printf("%s: struct '%s' is missing\n",
863 hdrfn, ps_search.name);
867 for (m = 0; m < ps->member_count; m++) {
868 if (ps->members[m].offset == offset)
869 return &ps->members[m].pp;
875 static void pp_copy_arg(struct parsed_proto_arg *d,
876 const struct parsed_proto_arg *s)
878 memcpy(d, s, sizeof(*d));
880 if (s->reg != NULL) {
881 d->reg = strdup(s->reg);
882 my_assert_not(d->reg, NULL);
884 if (s->type.name != NULL) {
885 d->type.name = strdup(s->type.name);
886 my_assert_not(d->type.name, NULL);
888 if (s->fptr != NULL) {
889 d->fptr = malloc(sizeof(*d->fptr));
890 my_assert_not(d->fptr, NULL);
891 memcpy(d->fptr, s->fptr, sizeof(*d->fptr));
895 struct parsed_proto *proto_clone(const struct parsed_proto *pp_c)
897 struct parsed_proto *pp;
900 pp = malloc(sizeof(*pp));
901 my_assert_not(pp, NULL);
902 memcpy(pp, pp_c, sizeof(*pp)); // lazy..
904 // do the actual deep copy..
905 for (i = 0; i < pp_c->argc; i++)
906 pp_copy_arg(&pp->arg[i], &pp_c->arg[i]);
907 if (pp_c->ret_type.name != NULL)
908 pp->ret_type.name = strdup(pp_c->ret_type.name);
914 static inline int pp_cmp_func(const struct parsed_proto *pp1,
915 const struct parsed_proto *pp2)
919 if (pp1->argc != pp2->argc || pp1->argc_reg != pp2->argc_reg)
922 for (i = 0; i < pp1->argc; i++) {
923 if ((pp1->arg[i].reg != NULL) != (pp2->arg[i].reg != NULL))
926 if ((pp1->arg[i].reg != NULL)
927 && !IS(pp1->arg[i].reg, pp2->arg[i].reg))
937 static inline void pp_print(char *buf, size_t buf_size,
938 const struct parsed_proto *pp)
943 snprintf(buf, buf_size, "%s %s(", pp->ret_type.name, pp->name);
946 for (i = 0; i < pp->argc_reg; i++) {
947 snprintf(buf + l, buf_size - l, "%s%s",
948 i == 0 ? "" : ", ", pp->arg[i].reg);
951 if (pp->argc_stack > 0) {
952 snprintf(buf + l, buf_size - l, "%s{%d stack}",
953 i == 0 ? "" : ", ", pp->argc_stack);
956 snprintf(buf + l, buf_size - l, ")");
959 static inline void proto_release(struct parsed_proto *pp)
963 for (i = 0; i < pp->argc; i++) {
964 if (pp->arg[i].reg != NULL)
965 free(pp->arg[i].reg);
966 if (pp->arg[i].type.name != NULL)
967 free(pp->arg[i].type.name);
968 if (pp->arg[i].fptr != NULL)
969 free(pp->arg[i].fptr);
971 if (pp->ret_type.name != NULL)
972 free(pp->ret_type.name);
975 (void)proto_lookup_struct;