Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
29ddd7f4
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
29ddd7f4
编写于
5月 29, 2023
作者:
O
openharmony_ci
提交者:
Gitee
5月 29, 2023
浏览文件
操作
浏览文件
下载
差异文件
!18678 Modify the Rust compilation guidance document
Merge pull request !18678 from liuguangfeng/master
上级
f665e9a2
4ead4d48
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
28 addition
and
20 deletion
+28
-20
zh-cn/device-dev/subsystems/subsys-build-all.md
zh-cn/device-dev/subsystems/subsys-build-all.md
+1
-0
zh-cn/device-dev/subsystems/subsys-build-cargo2gn-guide.md
zh-cn/device-dev/subsystems/subsys-build-cargo2gn-guide.md
+3
-3
zh-cn/device-dev/subsystems/subsys-build-rust-compilation.md
zh-cn/device-dev/subsystems/subsys-build-rust-compilation.md
+24
-17
未找到文件。
zh-cn/device-dev/subsystems/subsys-build-all.md
浏览文件 @
29ddd7f4
...
...
@@ -105,6 +105,7 @@ OpenHarmony编译子系统是以GN和Ninja构建为基座,对构建和配置
-
[
子系统配置规则
](
subsys-build-subsystem.md#子系统配置规则
)
-
[
部件配置规则
](
subsys-build-component.md#部件配置规则
)
-
[
模块配置规则
](
subsys-build-module.md#模块配置规则
)
-
[
Rust模块配置规则
](
subsys-build-rust-compilation.md#Rust模块配置规则
)
-
[
芯片解决方案配置规则
](
subsys-build-chip_solution.md#芯片解决方案配置规则
)
-
[
特性配置规则
](
subsys-build-feature.md#特性配置规则
)
-
[
系统能力配置规则
](
subsys-build-syscap.md#如何按需配置部件的系统能力
)
...
...
zh-cn/device-dev/subsystems/subsys-build-cargo2gn-guide.md
浏览文件 @
29ddd7f4
...
...
@@ -12,7 +12,7 @@ rust三方库使用cargo编译,配置为Cargo.toml。集成到OpenHarmony上
2.
创建配置文件cargo2gn.json,可以参考如下配置。
```
```
json
{
"copy-out"
:
true
,
"run"
:
true
,
...
...
@@ -24,7 +24,7 @@ rust三方库使用cargo编译,配置为Cargo.toml。集成到OpenHarmony上
3.
执行以下命令进行转换。
```
python /mnt/xxx/openharmony/build/scripts/cargo2gn.py --config cargo2gn.json
python
3
/mnt/xxx/openharmony/build/scripts/cargo2gn.py --config cargo2gn.json
```
转换结果
...
...
@@ -83,7 +83,7 @@ rust三方库使用cargo编译,配置为Cargo.toml。集成到OpenHarmony上
```
2.
把所有需要转换的rust三方库添加到rust目录下的Cargo.toml的[workspace]里,如下所示。
```
```
toml
[workspace]
members
=
[
"aho-corasick"
,
...
...
zh-cn/device-dev/subsystems/subsys-build-rust-compilation.md
浏览文件 @
29ddd7f4
...
...
@@ -12,7 +12,7 @@ OpenHarmony为了集成C/C++代码和提升编译速度,使用了GN + Ninja的
| ----- | ------------------------------------------------------------ |
| Cargo | Cargo是Rust官方使用的构建工具,允许Rust项目声明其各种依赖项,并确保您始终获得可重复的构建。 |
| crate | crate是一个独立的可编译单元。 |
|
lints | lints
是指出常见编程错误、错误、样式错误和可疑结构的工具。可以对程序进行更加广泛的错误分析。 |
|
Lint | Lint
是指出常见编程错误、错误、样式错误和可疑结构的工具。可以对程序进行更加广泛的错误分析。 |
...
...
@@ -100,6 +100,9 @@ OpenHarmony提供了用于Rust代码编译构建的各类型GN模板,可以用
!
[
test_rlib_crate
](
./figures/test_rlib_crate.png
)
### 配置三方库示例
rust三方库的BUILD.gn文件可通过cargo2gn工具自动生成。参见:
[
Cargo2gn工具操作指导
](
subsys-build-cargo2gn-guide.md
)
该示例用于测试包含预编译文件build.rs的三方静态库rlib文件的编译,使用了模板ohos_rust_executable和ohos_rust_cargo_crate。操作步骤如下:
1.
创建build/rust/tests/test_rlib_cargo_crate/crate/src/lib.rs,如下所示:
...
...
@@ -301,26 +304,27 @@ OpenHarmony提供了用于Rust代码编译构建的各类型GN模板,可以用
在build/rust/tests目录下有Rust各类型模块的配置实例可供参考:
| 用例目录 | 测试功能 |
| -------------------------------------------- | ------------------------------------------------------------ |
| build/rust/tests/test_bin_crate |
测试ohos_rust_executable的host和target编译链接及运行
|
| build/rust/tests/test_static_link | 测试
ohos_rust_executable对libstd.rlib进行静态链接
|
| build/rust/tests/test_dylib_crate | 测试
ohos_rust_executable对ohos_rust_shared_library的编译依赖和运行
|
| build/rust/tests/test_rlib_crate | 测试
ohos_rust_executable对ohos_rust_static_library的编译依赖和运行
|
| build/rust/tests/test_proc_macro_crate | 测试
ohos_rust_executable对ohos_rust_proc_macro的编译依赖和运行,对不同类型都有用例覆盖
|
| build/rust/tests/test_cdylib_crate | 测试
ohos_rust_executable对ohos_rust_shared_ffi的编译依赖和运行
|
| build/rust/tests/test_staticlib_crate | 测试
ohos_rust_executable对ohos_rust_static_ffi的编译依赖和运行
|
| build/rust/tests/test_rust_ut | 测试
ohos_rust_unittest,用例代码与特性代码在同一个文件中
|
| build/rust/tests/test_rust_st | 测试
ohos_rust_systemtest,用例代码在独立的test目录中
|
| build/rust/tests/test_bin_cargo_crate | 测试
ohos_cargo_crate对拥有build.rs预编译的可执行文件编译链接和运行,适用于rust三方crate编译依赖
|
| build/rust/tests/test_rlib_cargo_crate | 测试
ohos_cargo_crate对拥有build.rs预编译的静态库文件编译链接和运行,适用于rust三方crate编译依赖
|
| build/rust/tests/test_proc_macro_cargo_crate | 测试
ohos_cargo_crate对拥有build.rs预编译的过程宏编译链接和运行,适用于rust三方crate编译依赖
|
| build/rust/tests/test_bin_crate |
用ohos_rust_executable模板在host平台编译可执行文件,在target平台上运行可执行文件。
|
| build/rust/tests/test_static_link | 测试
可执行文件对标准库的静态链接。
|
| build/rust/tests/test_dylib_crate | 测试
对动态库的编译和动态链接功能
|
| build/rust/tests/test_rlib_crate | 测试
对静态库的编译和静态链接功能
|
| build/rust/tests/test_proc_macro_crate | 测试
对Rust过程宏的编译和链接功能。提供对不同类型的宏的测试用例。
|
| build/rust/tests/test_cdylib_crate | 测试
将Rust代码编译成C/C++动态库。
|
| build/rust/tests/test_staticlib_crate | 测试
将Rust代码编译成C/C++静态库。
|
| build/rust/tests/test_rust_ut | 测试
Rust代码单元测试模板功能(ability)。
|
| build/rust/tests/test_rust_st | 测试
Rust代码系统测试模板功能(ability)。
|
| build/rust/tests/test_bin_cargo_crate | 测试
Rust三方可执行文件的编译和运行。三方源码中包含build.rs。
|
| build/rust/tests/test_rlib_cargo_crate | 测试
Rust三方静态库的编译和静态链接。三方源码中包含build.rs。
|
| build/rust/tests/test_proc_macro_cargo_crate | 测试
Rust三方过程宏的编译和链接。三方源码中包含build.rs。
|
## 参考
### 特性点实例
#### Rust源码依赖调用C/C++库
OpenHarmony上C/C++模块动态库默认用.z.so后缀,但是Rust的编译命令通过-l链接时,默认只会链接.so后缀的动态库。因此如果要依赖一个C/C++动态库编译模块,需要在该动态库的GN构建文件中添加output_exte
r
nsion = "so"的声明,这样编译得到的动态库将会以".so"作为后缀,而不是".z.so"。
OpenHarmony上C/C++模块动态库默认用.z.so后缀,但是Rust的编译命令通过-l链接时,默认只会链接.so后缀的动态库。因此如果要依赖一个C/C++动态库编译模块,需要在该动态库的GN构建文件中添加output_extension = "so"的声明,这样编译得到的动态库将会以".so"作为后缀,而不是".z.so"。
在Rust源码中如果直接链接动态库,后缀也需要使用".so",这时使用动态库的中间名,不需要添加lib前缀。例如Rust源码中链接libhilog.so:
```
rust
#[link(name
=
"hilog"
)]
```
...
...
@@ -335,10 +339,11 @@ executable("foo") {
}]
}
```
###
lints
规则
OpenHarmony框架支持rustc lints和clippy lints两种
lints,每种lints
划为三个等级的标准:"openharmony"、"vendor"和"none",严格程度按照"openharmony" -> "vendor" -> "none"逐级递减。
配置Rust模块时可以通过rustc_lints和clippy_lints来指定使用
lints
的等级。
###
Lint
规则
OpenHarmony框架支持rustc lints和clippy lints两种
Lint,每种Lint
划为三个等级的标准:"openharmony"、"vendor"和"none",严格程度按照"openharmony" -> "vendor" -> "none"逐级递减。
配置Rust模块时可以通过rustc_lints和clippy_lints来指定使用
Lint
的等级。
模块中没有配置rustc_lints或者clippy_lints时会根据模块所在路径来匹配lints等级。不同路径下的Rust代码的语法规范会有不同程度地约束,因此用户在OpenHarmony配置Rust代码编译模块时还应关注模块所在路径。
#### rustc lints和clippy lints的各等级标志
|
**lints类型**
|
**模块属性**
|
**lints等级**
|
**lints等级标志**
|
**lints内容**
|
| ------------- | ------------ | ------------- | ----------------- | ------------------------------------------------------------ |
...
...
@@ -358,3 +363,5 @@ OpenHarmony框架支持rustc lints和clippy lints两种lints,每种lints划为
| device | vendor |
| others | openharmony |
### [交互工具使用指导](subsys-build-bindgen-cxx-guide.md)
### [Cargo2gn工具操作指导](subsys-build-cargo2gn-guide.md)
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录