如何在rust中静态链接node.js?

时间:2019-07-29 02:06:29

标签: c++ node.js rust static-linking

我想将node.js嵌入Rust。我对使用NAPI编写node.js插件或从rust中广泛控制node.js感兴趣。我需要的只是node.js main()的启动方法-等效于进行node myscript.js

为什么?我正在Rust中构建一个自包含的单文件二进制桌面应用程序,并希望使用嵌入的node.js运行时来运行node.js脚本。不能保证将Node.js安装在最终用户的计算机上,并且启动时间很敏感,因此不希望从二进制文件中提取独立的node.js zip到文件系统。

我相信在rust(二进制)项目中静态链接node.js时遇到问题。

我下拉了nodejs源代码

git clone https://github.com/nodejs/node

并在node_main.cc

中重命名main方法
sed -i .bak "s/int main(/int node_main(/g" ./src/node_main.cc

然后我将node.js构建为静态库

./configure --enable-static
make -j4

我有一个c ++包装文件wrapper.cpp,用于通过node_main()公开extern c方法

wrapper.cpp:

#include <string>
#include <iostream>

using namespace std;

int node_main(int argc, char **argv);

extern "C" {
  void run_node() {
    cout << "hello there! general kenobi..." << endl;
    char *args[] = { (char*)"tester.js", NULL };
    node_main(1, args);
  }
}

在这一点上,我能够成功地将c ++包装器构建为二进制文件,同时静态链接node.js库并从c ++成功运行node.js。但是,从锈...

main.rs:

extern {
  fn run_node();
}

fn main() {
  println!("hey there this is RUST");
  unsafe { run_node(); }
}

build.rs:

extern crate cc;

fn main() {
  println!("cargo:rustc-link-search=native=../node/out/Release");

  println!("cargo:rustc-link-lib=static=node");
  println!("cargo:rustc-link-lib=static=uv");

  println!("cargo:rustc-link-lib=static=v8_base");
  println!("cargo:rustc-link-lib=static=v8_libbase");
  println!("cargo:rustc-link-lib=static=v8_snapshot");
  println!("cargo:rustc-link-lib=static=v8_libplatform");

  println!("cargo:rustc-link-lib=static=icuucx");
  println!("cargo:rustc-link-lib=static=icui18n");
  println!("cargo:rustc-link-lib=static=icudata");
  println!("cargo:rustc-link-lib=static=icustubdata");

  println!("cargo:rustc-link-lib=static=brotli");
  println!("cargo:rustc-link-lib=static=nghttp2");

  cc::Build::new()
    .cpp(true)
    .file("wrapper.cpp")
    .compile("libwrapper.a");
}

请注意,rustc-link-search路径是相对的。

运行cargo build时出现以下错误:

= note: Undefined symbols for architecture x86_64:
          "node_main(int, char**)", referenced from:
              _run_node in libwrapper.a(wrapper.o)
        ld: symbol(s) not found for architecture x86_64
        clang: error: linker command failed with exit code 1 (use -v to see invocation)

我不确定链接器的顺序是否重要,但是我尝试了一些不同的顺序组合,但是没有运气。我还尝试链接来自.a的所有lib node/out/Release文件,但没有区别。我还尝试将.a中的所有node/out/Release文件组合到一个lib .a文件中,但是收到重复的符号错误。我尝试了不同的node.js标签(例如v11.15.0),没有区别。

我正在MacOS 10.14.5上执行此操作

$ rustc --version
rustc 1.36.0 (a53f9df32 2019-07-03)
$ cargo --version
cargo 1.36.0 (c4fcfb725 2019-05-15)
$ g++ --version
Configured with: --prefix=/Library/Developer/CommandLineTools/usr --with-gxx-include-dir=/Library/Devel
oper/CommandLineTools/SDKs/MacOSX10.14.sdk/usr/include/c++/4.2.1
Apple LLVM version 10.0.1 (clang-1001.0.46.4)
Target: x86_64-apple-darwin18.6.0
Thread model: posix
InstalledDir: /Library/Developer/CommandLineTools/usr/bin

Cargo.toml:

[build-dependencies]
cc = "1.0"

如果有什么好主意,我愿意采用更好的方法将node.js嵌入rust。

1 个答案:

答案 0 :(得分:2)

我发现了许多问题,这些问题一经解决,就可以在Rust中成功成功静态链接node.js。

node_main.cc未包含在libnode.a输出中

我通过使用nm查找符号发现了这一点。我在符号列表中找不到node_main(),也找不到node_main.o。因此,我意识到node_main.cc中的任何内容都不会导出。

修复:将库入口点C函数公开在另一个文件中,例如node.cc。请注意,这里我们添加了一个全新的函数,该函数调用node::Start()

node.cc

extern "C" int node_main(int argc, char** argv) {
    return node::Start(argc, argv);
}

由于c ++名称符号修饰而需要extern "C"

同样,再次使用nm工具搜索libnode.a文件中的所有符号,我发现node_main()功能符号被弄乱了。为了从Rust中找到该符号,一定不要弄乱它,这可以通过extern "C"

完成

修复:确保使用extern "C"

预先设置要暴露给Rust的功能。

node.cc

extern "C" int node_main()

取决于节点版本,缺少一些其他符号

根据node.js Github问题#27431,某些符号存根未在静态库中获得输出。我使用的是node.js v13.x.x标记,这是一个问题,因此我必须为这些额外的存根创建库,并将它们链接到rust build配置中。

修复:从存根创建静态库,并将其链接到build.rs

ar rcs obj/Release/lib_stub_code_cache.a obj/Release/obj.target/cctest/src/node_code_cache_stub.o
ar rcs obj/Release/lib_stub_snapshot.a obj/Release/obj.target/cctest/src/node_snapshot_stub.o

最终结果

构建node.js

git clone https://github.com/nodejs/node
cd node
printf 'extern "C" int node_main(int argc, char** argv) { return node::Start(argc, argv); }' >> src/node.cc
./configure --enable-static
make -j4

# temporary fix: https://github.com/nodejs/node/issues/27431#issuecomment-487288275
REL=obj/Release
STUBS=$REL/obj.target/cctest/src
ar rcs "$REL/lib_stub_code_cache.a $STUBS/node_code_cache_stub.o"
ar rcs "$REL/lib_stub_snapshot.a $STUBS/node_snapshot_stub.o"

wrapper.cpp

#include <string>
#include <iostream>
using namespace std;

extern "C" {
  int node_main(int argc, char** argv);

  void run_node() {
    cout << "hello there! general kenobi...\n";
    char *args[] = { (char*)"tester.js", NULL };
    node_main(1, args);
  }
}

build.rs

extern crate cc;

fn main() {
  cc::Build::new()
    .cpp(true)
    .file("wrapper.cpp")
    .compile("libwrapper.a");

  println!("cargo:rustc-link-search=native=../node/out/Release");

  println!("cargo:rustc-link-lib=static=node");
  println!("cargo:rustc-link-lib=static=uv");

  // temporary fix - https://github.com/nodejs/node/issues/27431#issuecomment-487288275
  println!("cargo:rustc-link-lib=static=_stub_code_cache");
  println!("cargo:rustc-link-lib=static=_stub_snapshot");
  // end temporary fix

  println!("cargo:rustc-link-lib=static=v8_base_without_compiler");
  println!("cargo:rustc-link-lib=static=v8_compiler");
  println!("cargo:rustc-link-lib=static=v8_initializers");
  println!("cargo:rustc-link-lib=static=v8_libbase");
  println!("cargo:rustc-link-lib=static=v8_libplatform");
  println!("cargo:rustc-link-lib=static=v8_libsampler");
  println!("cargo:rustc-link-lib=static=v8_snapshot");

  println!("cargo:rustc-link-lib=static=icuucx");
  println!("cargo:rustc-link-lib=static=icui18n");
  println!("cargo:rustc-link-lib=static=icudata");
  println!("cargo:rustc-link-lib=static=icustubdata");

  println!("cargo:rustc-link-lib=static=zlib");
  println!("cargo:rustc-link-lib=static=brotli");
  println!("cargo:rustc-link-lib=static=cares");
  println!("cargo:rustc-link-lib=static=histogram");
  println!("cargo:rustc-link-lib=static=http_parser");
  println!("cargo:rustc-link-lib=static=llhttp");
  println!("cargo:rustc-link-lib=static=nghttp2");
  println!("cargo:rustc-link-lib=static=openssl");
}

main.rs

extern {
  fn run_node();
}

fn main() {
  println!("a surprise to be sure, but a welcome one");
  unsafe { run_node(); }
}