自动生成C语言函数指针表

Question

我正在寻找一种方法来自动（作为编译/构建过程的一部分）生成 C 中的函数指针“表”。

具体来说，我想生成一个结构数组，例如：

typedef struct {
  void (*p_func)(void);
  char * funcName;
} funcRecord;

/* Automatically generate the lines below: */

extern void func1(void);
extern void func2(void);
/* ... */

funcRecord funcTable[] =
{
  { .p_func = &func1, .funcName = "func1" },
  { .p_func = &func2, .funcName = "func2" }
  /* ... */
};

/* End automatically-generated code. */

...其中 func1 和 func2在其他源文件中定义。

因此，给定一组源文件，其中每个文件都包含一个不带参数并返回 void 的函数，如何自动（作为构建过程的一部分）生成一个像上面那样包含每个函数的数组从文件中？我希望能够添加新文件并在重新编译时将它们自动插入到表中。

我意识到这可能无法单独使用 C 语言或预处理器来实现，因此请考虑任何常见的 *nix 风格工具（例如 make、perl、shell 脚本（如果必须的话））。

但为什么？

您可能想知道为什么有人想要这样做。我正在为常见数学例程库创建一个小型测试框架。在这个框架下，将会有许多小的“测试用例”，每个测试用例只有几行代码来执行每个数学函数。我希望每个测试用例都作为一个简短的函数存在于自己的源文件中。所有测试用例都将构建到单个可执行文件中，并且可以在调用可执行文件时在命令行上指定要运行的测试用例。 main() 函数将搜索表，如果找到匹配项，则跳转到测试用例函数。

自动化构建测试用例“目录”的过程可确保测试用例不会被遗漏（例如，因为有人忘记将其添加到表中），并使维护人员可以非常简单地添加新的测试用例未来（例如，只需在正确的目录中创建一个新的源文件）。

希望有人以前做过类似的事情。感谢 StackOverflow 社区！

Answer 1

使用宏

如何创建一个宏列表，

#define FUNC_LIST \
  FUNC( func1 ) \
  FUNC( func2 ) \
  FUNC( func3 ) \
  FUNC( func4 ) \
  FUNC( func5 ) 

然后将 extern 定义扩展为，

#define FUNC( _name ) extern void _name(void);

FUNC_LIST

#undef FUNC

然后将表扩展为

#define FUNC( _name ) { .p_func = &_name, .funcName = #_name },

funcRecord funcTable[] = {
  FUNC_LIST
};

#undef FUNC

使用 dlsym(..)

如果您对测试函数有严格的命名约定，另一个建议是研究使用句柄设置为 RTLD_DEFAULT 的函数 dlsym 并编写一个在启动时尝试查找所有函数的函数。

例子

#include <stdio.h>
#include <dlfcn.h>

void test2() {
  printf("Second place is the first loser!\n");
}

void test42() {
  printf("Read The Hitchhikers Guide To The Galaxy!\n");
}

int main() {
  int i;
  for (i=1; i<100; i++) {
    char fname[32];
    void (*func)();
    sprintf(fname, "test%d", i);
    func = dlsym(RTLD_DEFAULT, fname);
    if (func)
      func();
  }
  return 0;
}

Answer 2

如果您使用的是 MSVC，则可以使用

dumpbin /symbols  foo.obj > foo_symbols.txt

将所有符号名称（不仅仅是函数）放入文本文件中。然后解析生成的文件以提取函数名称。函数将是非 UNDEF 部分中的 External 符号。

或者，您可以将对象链接到临时 exe 或 dll，然后查看由该函数生成的 .MAP 文件。链接器来获取函数名称。

或者您可以编写自己的代码来解析 .obj 文件，它们采用修改后的 COFF 格式，定位符号表并对其进行解码并不困难。我对 COFF 格式进行了一次部分解码以获取符号表，并花了几天时间编写代码。 http://en.wikipedia.org/wiki/COFF

Answer 3

听起来像是代码生成的工作。选择您选择的脚本语言，并弄清楚如何从适当的标头中提取函数名称并写出

{ .p_func = &functionname, .funcName = "functionname" },

然后告诉您构建系统生成标头头文件。在 make 中它可能看起来像

UTILITY_FUNCTION_HEADER:= func1.h func2.h func3.h
func_table.h: ${UTILITY_FUNCTION_HEADERS}
        write_header.sh > $@
        for file in @^; do extract_function_name.sh >> $@; done
        write_footer.sh >>$@

Answer 4

关于提取问题，我想我会以某种方式标记我想要导出的函数，然后在构建过程中提取它。

您可以使用“语义宏”à la gettext（即除了向外部工具提供语义信息之外不执行任何操作的宏）：

#define TEST_CASE(f) f

T TEST_CASE(f)(D x, ...)
{
        /* ... */
}

然后您可以使用 sed 或 awk 或您喜欢的任何内容轻松提取该宏，并以正确的方式创建列表以此为基础的格式。这是 awk 中的一些简单代码，因为这是我最了解的，但您可能想使用其他代码：

match($0, /TEST_CASE\([a-zA-Z_][a-zA-Z_0-9]*\)/) {
        name = substr($0, RSTART, RLENGTH)
        sub(/^TEST_CASE\(/, "", name)
        sub(/\)$/, "", name)
        funcs[name]
}

END {
        for (f in funcs)
                printf "func_type %s;\n", f
        print "funcRecord funcTable[] = {"
        for (f in funcs)
                printf "\t{ .p_func = %s, .funcName = \"%s\" },\n", f, f
        print "};"
}

如果您要对名称进行排序（对 bsearch()-ing 很有用），我建议使用三个过滤器：提取过滤器（sed 单行在这里是合适的），排序（1），然后是生成过滤器（我在这里使用 awk）。不过，您必须单独生成页眉/页脚，并进行两次传递或将提取结果存储在临时文件中，以便生成外部声明和数组条目。

我认为尝试提取具有给定原型的函数不是一个好主意，例如 void (void)。最好使用 typedef （在我的示例中为 func_type ）和显式语义宏，恕我直言，它更健壮（对于更改，以及不同的编码风格，例如将返回类型单独放在一行与不放在一行）。

剩下要做的就是将该生成过程添加到您的 makefile 中，如 dmckee 的回复中所示（尽管我认为您实际上希望将所有生成的代码放入 .c 而不是 .h 中）。为了完整起见，这是我的版本：

TEST_SRCS=      test1.c test2.c test3.c

test_funcs.c: ${TEST_SRCS}
        echo '#include "test.h"' >$@
        awk -f extract_test_funcs.awk ${TEST_SRCS} >>$@

Answer 5

我倾向于用不同的方式来解决这个问题。当我开发一些东西时，我通常会想：正确的 C 文件，其中包含这样一个函数的代码，例如在 /project-devel/project/new_function.c 中。当我写这篇文章时，我倾向于创建 /project-devel/tests/test_new_function.c 和 /project-devel/tests/make_new_function_test 你猜它会构建一个测试二进制文件，包括测试该新功能所需的一切。

我想问题是你能自动化这个吗？我不打算为它编写代码（因为我还没有想清楚），但您可以创建一个 perl/python 脚本来一次性创建 makefile、new function.c/.h 和测试引导程序。您可以通过对诸如 r"#include \\\"(\s+?).h\\\"" 之类的内容进行正则化来获取所需的包含内容，并创建一个测试功能“更新脚本”来重新-根据新信息创建测试用例/makefile。它仍然依赖于您编写实际的 test.c，但这对于建立的想法来说是微不足道的。

只是一个想法。

Answer 6

C 编译器就是这样做的。在 Linux 系统下，尝试在已编译的 C 文件上调用 nm foo.o。它将打印出“符号表”，其中包括所有函数，包括静态函数。

编辑： 困难在于从源代码中提取信息（“有一个名为 'func1()' 的函数”）。它需要解析 C 源文件。 C 编译器已经做到了这一点（这就是它的工作），因此使用 C 编译器的输出是有意义的。输出是一个目标文件，其中包含包含该信息的符号表。所以我们的想法是解析 nm 的输出并生成定义“函数表”的 C 源文件。这可以通过 makefile 自动执行，以便始终生成该表。