Nodejs: node-gyp 在 C++ 中链接 C 的文件

Node.js: 在 C++ 中链接 C 的文件

原文链接

原文链接

原因

由于某些原因，我写了一个简单的 C 语言内存池库（GitHub: xmempool）。然后我想到了把之前写的一个 Node.js 包 thmclrx（GitHub: thmclrx）中的“伪·内存池”用新写的内存池替换掉。

然而，问题来了：我似乎无法控制 node-gyp 使用 G++ 来编译 .c 文件。这导致编译后的文件在链接时出现问题。虽然链接没有报错，但在运行时会报错：

➜ thmclrx git:(master) ✗ node test/test.js
dyld: lazy symbol binding failed: Symbol not found: __Z16xmem_create_poolj
  Referenced from: /Users/.../code/huaban/thmclrx/build/Release/thmclrx.node
  Expected in: dynamic lookup

dyld: Symbol not found: __Z16xmem_create_poolj
  Referenced from: /Users/.../code/huaban/thmclrx/build/Release/thmclrx.node
  Expected in: dynamic lookup

[1]    52501 trace trap  node test/test.js

这意味着在编译好的 thmclrx.node 中找不到 __Z16xmem_create_poolj 符号，也就是说 xmempool.o 这个 C 编译出来的文件没有被正确链接。

假想方案

假想一

最初的想法是找到一种方法，可以让 node-gyp 手动选择编译器，而不是让系统自动选择 GCC 来编译 .c 文件。但最终未能实现。

假想二

后来，我决定让编译器能够区分我在跟 C 语言还是 C++ 语言对话。

解决方案

我找到了一个解决方案，该方案来自一个类似的讨论帖（链接）：

在你的 C 头文件中添加以下宏定义：

#ifdef __cplusplus
extern "C" {
#endif

//... your C code here ...

#ifdef __cplusplus
}
#endif

这样做的目的是让 C++ 编译器知道它正在与 C 语言的源文件进行交互，而不是 C++ 源文件。这将确保链接时一切正常。

示例代码

假设你有一个名为 xmempool.h 的头文件：

// xmempool.h
#ifndef XMEMPPOOL_H
#define XMEMPPOOL_H

#ifdef __cplusplus
extern "C" {
#endif

void* xmem_create_pool(size_t size);
void xmem_destroy_pool(void* pool);

#ifdef __cplusplus
}
#endif

#endif // XMEMPPOOL_H

相应的 C 代码 xmempool.c：

// xmempool.c
#include "xmempool.h"

struct XMemPool {
    char data[1024];
};

void* xmem_create_pool(size_t size) {
    return malloc(size);
}

void xmem_destroy_pool(void* pool) {
    free(pool);
}

在 C++ 代码中使用这些函数：

// main.cpp
#include <iostream>
#include "xmempool.h"

int main() {
    void* pool = xmem_create_pool(1024);
    if (pool != nullptr) {
        std::cout << "Memory pool created successfully!" << std::endl;
    }
    xmem_destroy_pool(pool);
    return 0;
}

事后烟

以前我也经常在其他项目中看到 #ifdef __cplusplus 宏定义，但一直不清楚其用途。通过这次经历，我终于明白了它的作用，并学会了如何正确地在 C 和 C++ 之间进行接口设计。