本頁面會概略說明系統如何支援生成來源, 如何在建構系統中使用
所有來源產生器都提供類似的建構系統功能。這三種建構系統支援的來源產生用途,是使用 bindgen、AIDL 介面和 protobuf 介面產生 C 繫結。
產生來源的 Crate
每個產生來源程式的 Rust 模組都可以用作 Crate,就像是定義為 rust_library
一樣。(也就是說,廣告素材可定義為
rustlibs
、rlibs
和 dylibs
屬性中的依附元件)。最佳用量
平台程式碼的模式是使用產生的來源做為 Crate。雖然產生來源支援 include!
巨集,但其主要目的是支援位於 external/
中的第三方程式碼。
在某些情況下,平台程式碼可能會透過 include!()
巨集使用產生的來源,例如當您使用 genrule
模組以獨特方式產生來源時。
使用 include!() 納入已產生的來源
每個特定 (相對應) 模組頁面中的範例都會說明如何使用產生的來源做為 Crate。本節說明如何參照產生的來源
透過 include!()
巨集請注意,這項程序適用於所有來源
產生器
先修規定
這個範例假設您已定義 rust_bindgen
模組 (libbuzz_bindgen
),並且可以繼續執行步驟:內含產生的來源,以便使用 include!()
巨集。如果您尚未定義,請參閱「定義 Rust 繫結代模組」。
請建立 libbuzz_bindgen
,然後返回這裡。
請注意,此處的建構檔案部分適用於所有來源產生器。
加入產生來源的步驟
使用以下內容建立 external/rust/hello_bindgen/Android.bp
:
rust_binary {
name: "hello_bzip_bindgen_include",
srcs: [
// The primary rust source file must come first in this list.
"src/lib.rs",
// The module providing the bindgen bindings is
// included in srcs prepended by ":".
":libbuzz_bindgen",
],
// Dependencies need to be redeclared when generated source is used via srcs.
shared_libs: [
"libbuzz",
],
}
使用以下內容建立 external/rust/hello_bindgen/src/bindings.rs
:
#![allow(clippy::all)]
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(unused)]
#![allow(missing_docs)]
// Note that "bzip_bindings.rs" here must match the source_stem property from
// the rust_bindgen module.
include!(concat!(env!("OUT_DIR"), "/bzip_bindings.rs"));
使用以下內容建立 external/rust/hello_bindgen/src/lib.rs
:
mod bindings;
fn main() {
let mut x = bindings::foo { x: 2 };
unsafe { bindings::fizz(1, &mut x as *mut bindings::foo) }
}
為何要為產生的來源建立 Crate
與 C/C++ 編譯器不同,rustc
只接受單一來源檔案
代表二進位或程式庫的進入點它會預期來源
結構,使所有必要的來源檔案都能
發現。也就是說,產生的來源必須置於來源中
或透過 include 指令提供:
include!("/path/to/hello.rs");
Rust 社群依附於 build.rs
指令碼,以及對
Cargo 建構環境,以便處理這項差異。
cargo
指令會在建構時設定 OUT_DIR
環境變數
預計將產生的原始碼放入其中 build.rs
指令碼使用
加入原始碼:
include!(concat!(env!("OUT_DIR"), "/hello.rs"));
這對 Soong 來說是一大挑戰,因為每個單元的輸出內容都放在
自己的 out/
目錄1。沒有任何 OUT_DIR
會輸出依附元件產生的來源。
針對平台程式碼,Android 開放原始碼計畫會優先將產生的來源封裝至可匯入的 Crate,原因如下:
- 防止系統產生的來源檔案名稱相互衝突。
- 減少需要維護的樹狀結構中檢入的樣板程式碼。任何 對產生的原始碼編譯所需的程式碼 可集中維護
- 避免在產生的程式碼與周遭 Crate 之間隱含2互動。
- 動態連結常用的產生的來源,以降低記憶體和磁碟的壓力。
因此,所有 Android 的 Rust 來源產生模組類型都會產生可編譯並用於 crate 的程式碼。如果模組的所有產生來源依附元件都複製到單一模組目錄中,Soong 仍可支援第三方 Crate,無須修改,類似於 Cargo。在這種情況下,Soong 會設定 OUT_DIR
環境變數
加入該目錄後就能找到產生的原始碼。
不過,基於上述原因,建議您僅在必要時才在平台程式碼中使用此機制。