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

How to statically link node.js in rust?

本文关键字:链接 节点 js 静态 rust      更新时间:2023-10-16

我想在 Rust 中嵌入 node.js。我对编写节点.js插件与 NAPI 或控制节点不感兴趣.js从 rust 中广泛地编写。我所需要的只是节点.jsmain()启动方法 - 相当于做node myscript.js.

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

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

我拉下 nodejs 源代码

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

并在node_main.cc中重命名主方法

sed -i .bak "s/int main(/int node_main(/g" ./src/node_main.cc

然后我构建节点.js作为静态库

./configure --enable-static
make -j4

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

包装.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++ 包装器构建为二进制文件,同时从 c++ 成功静态链接节点.js库和运行节点.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)

我不确定链接器顺序是否重要,但我尝试了一些不同的排序组合,但没有运气。我还尝试链接node/out/Release中的所有 lib.a文件,但没有区别。我还尝试将node/out/Release中的所有.a文件合并为一个 lib.a文件,但收到重复的符号错误。我尝试了节点的不同标签.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"

如果有任何好的想法,我愿意接受嵌入节点的更好方法.js在 rust 中。

我发现了许多问题,一旦解决,就可以在 Rust 中成功静态链接节点.js。

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

我通过使用nm查找符号来发现这一点。我找不到node_main(),也没有node_main.o符号列表中。因此,我意识到node_main.cc任何东西都不会出口。

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

node.cc

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

需要extern "C",因为 C++ 名称符号重整

同样,使用nm工具搜索libnode.a文件中的所有符号,我能够发现node_main()函数符号被破坏了。为了从 Rust 中找到这个符号,它不能被破坏,这是通过extern "C"

修复:确保在打算暴露给 Rust 的函数前面加上extern "C"

node.cc

extern "C" int node_main()

根据节点版本,缺少一些其他符号

根据 node.js Github 问题 #27431 某些符号存根不会在静态库中获取输出。我正在使用 node.js v13.x.x 标签,这是一个问题,所以我必须为这些额外的存根创建库并在 rust 构建配置中链接它们。

修复:从存根创建静态库,并在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

最终结果

构建节点.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"

包装纸.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(); }
}