Mô-đun Rust cho Android

Theo nguyên tắc chung, các định nghĩa mô-đun rust_* tuân thủ chặt chẽ cách sử dụng và kỳ vọng của cc_*. Sau đây là ví dụ về định nghĩa mô-đun cho tệp nhị phân Rust:

rust_binary {
    name: "hello_rust",
    crate_name: "hello_rust",
    srcs: ["src/hello_rust.rs"],
    host_supported: true,
}

Trang này trình bày các thuộc tính phổ biến nhất cho mô-đun rust_*. Để biết thêm thông tin về các loại mô-đun cụ thể và định nghĩa mô-đun mẫu, hãy xem phần Mô-đun nhị phân, Mô-đun thư viện hoặc Mô-đun kiểm thử.

Các loại mô-đun cơ bản

LoạiĐịnh nghĩaĐể biết thêm thông tin
rust_binaryTệp nhị phân Rust Trang Mô-đun nhị phân
rust_libraryTạo thư viện Rust và cung cấp cả biến thể rlib và dylib. rust_library, trang Mô-đun thư viện.
rust_ffiTạo một thư viện C Rust mà các mô-đun cc có thể sử dụng, đồng thời cung cấp cả biến thể tĩnh và dùng chung. rust_ffi, trang Mô-đun thư viện
rust_proc_macroTạo thư viện Rust proc-macro. (Đây là các trình bổ trợ tương tự như trình bổ trợ biên dịch.) rust_proc_macro, trang Mô-đun thư viện
rust_testTạo một tệp nhị phân kiểm thử Rust sử dụng bộ kiểm thử Rust tiêu chuẩn. Trang Test Modules (Kiểm thử mô-đun)
rust_fuzzTạo một tệp nhị phân tìm lỗi mã nguồn Rust bằng cách tận dụng libfuzzer. Ví dụ về mô-đun rust_fuzz
rust_protobufTạo nguồn và tạo thư viện Rust cung cấp giao diện cho một protobuf cụ thể. Trang Protobufs Modules (Mô-đun Protobuf) và Source Generators (Trình tạo nguồn)
rust_bindgenTạo nguồn và tạo thư viện Rust chứa các liên kết Rust đến thư viện C. Các trang Mô-đun liên kết Bindgen và Trình tạo nguồn

Các thuộc tính chung quan trọng

Các thuộc tính này phổ biến trên tất cả Mô-đun Rust của Android. Mọi thuộc tính bổ sung (riêng biệt) liên kết với từng mô-đun Rust sẽ được liệt kê trên trang của mô-đun đó.

tên

name là tên của mô-đun. Giống như các mô-đun Soong khác, mô-đun này phải là duy nhất trên hầu hết các loại mô-đun Android.bp. Theo mặc định, name được dùng làm tên tệp đầu ra. Nếu tên tệp đầu ra phải khác với tên mô-đun, hãy sử dụng thuộc tính stem để xác định tên tệp đó.

thân

stem (không bắt buộc) cung cấp quyền kiểm soát trực tiếp đối với tên tệp đầu ra (không bao gồm đuôi tệp và các hậu tố khác). Ví dụ: thư viện rust_library_rlib có giá trị gốc là libfoo sẽ tạo ra tệp libfoo.rlib. Nếu bạn không cung cấp giá trị cho thuộc tính stem, thì tên tệp đầu ra sẽ sử dụng tên mô-đun theo mặc định.

Sử dụng hàm stem khi bạn không thể đặt tên mô-đun thành tên tệp đầu ra mong muốn. Ví dụ: rust_library cho vùng chứa log được đặt tên là liblog_rust, vì liblog cc_library đã tồn tại. Việc sử dụng thuộc tính stem trong trường hợp này đảm bảo rằng tệp đầu ra được đặt tên là liblog.* thay vì liblog_rust.*.

srcs

srcs chứa một tệp nguồn duy nhất đại diện cho điểm truy cập vào mô-đun (thường là main.rs hoặc lib.rs). rustc xử lý độ phân giải và khám phá tất cả các tệp nguồn khác cần thiết để biên dịch, và các tệp này được liệt kê trong tệp deps được tạo.

Khi có thể, hãy tránh sử dụng cách này cho mã nền tảng; hãy xem phần Trình tạo nguồn để biết thêm thông tin.

crate_name

crate_name đặt siêu dữ liệu tên vùng chứa thông qua cờ rustc --crate_name. Đối với các mô-đun tạo thư viện, tên này phải khớp với tên vùng chứa dự kiến được sử dụng trong nguồn. Ví dụ: nếu mô-đun libfoo_bar được tham chiếu trong nguồn là extern crate foo_bar, thì phải là crate_name: "foo_bar".

Thuộc tính này phổ biến cho tất cả các mô-đun rust_*, nhưng là bắt buộc đối với các mô-đun tạo thư viện Rust (chẳng hạn như rust_library rust_ffi, rust_bindgen, rust_protobuf và rust_proc_macro). Các mô-đun này thực thi các yêu cầu rustc về mối quan hệ giữa crate_name và tên tệp đầu ra. Để biết thêm thông tin, hãy xem phần Mô-đun thư viện.

tìm lỗi mã nguồn

Trình tìm lỗi mã nguồn rustc được chạy theo mặc định cho tất cả các loại mô-đun ngoại trừ trình tạo nguồn. Một số bộ tìm lỗi mã nguồn được xác định và dùng để xác thực nguồn mô-đun. Các giá trị có thể có cho các nhóm tìm lỗi mã nguồn như sau:

  • default bộ tìm lỗi mã nguồn mặc định, tuỳ thuộc vào vị trí của mô-đun
  • android bộ tìm lỗi mã nguồn nghiêm ngặt nhất áp dụng cho tất cả mã nền tảng Android
  • vendor một bộ công cụ tìm lỗi mã nguồn đơn giản được áp dụng cho mã của nhà cung cấp
  • none để bỏ qua tất cả cảnh báo và lỗi tìm lỗi mã nguồn

clippy_lints

Trình tìm lỗi mã nguồn clippy cũng chạy theo mặc định cho tất cả các loại mô-đun ngoại trừ trình tạo nguồn. Một vài bộ tìm lỗi mã nguồn được xác định để dùng cho việc xác thực nguồn mô-đun. Dưới đây là một số giá trị có thể có:

  • Bộ công cụ tìm lỗi mã nguồn mặc định default tuỳ thuộc vào vị trí của mô-đun
  • android bộ tìm lỗi mã nguồn nghiêm ngặt nhất áp dụng cho tất cả mã nền tảng Android
  • vendor một bộ công cụ tìm lỗi mã nguồn đơn giản được áp dụng cho mã của nhà cung cấp
  • none để bỏ qua tất cả cảnh báo và lỗi tìm lỗi mã nguồn

ấn bản

edition xác định phiên bản Rust để sử dụng cho việc biên dịch mã này. Điều này tương tự như các phiên bản std cho C và C++. Các giá trị hợp lệ là 2015, 2018 và 2021 (mặc định).

flags

flags chứa danh sách chuỗi cờ để truyền đến rustc trong quá trình biên dịch.

ld_flags

ld-flags chứa danh sách chuỗi cờ để truyền đến trình liên kết khi biên dịch nguồn. Các giá trị này được truyền bằng cờ rustc -C linker-args. clang được dùng làm giao diện người dùng của trình liên kết, gọi lld để liên kết thực tế.

tính năng

features là danh sách chuỗi các tính năng phải được bật trong quá trình biên dịch. --cfg 'feature="foo"' sẽ truyền giá trị này đến rustc. Hầu hết các tính năng đều có tính chất bổ sung, vì vậy, trong nhiều trường hợp, tính năng này bao gồm toàn bộ các tính năng mà tất cả các mô-đun phụ thuộc yêu cầu. Tuy nhiên, trong trường hợp các tính năng độc quyền với nhau, hãy xác định các mô-đun bổ sung trong mọi tệp bản dựng cung cấp các tính năng xung đột.

cfgs

cfgs chứa danh sách chuỗi gồm các cờ cfg cần bật trong quá trình biên dịch. Giá trị này được --cfg foo và --cfg "fizz=buzz" truyền đến rustc.

Hệ thống xây dựng tự động đặt một số cờ cfg nhất định trong các trường hợp cụ thể, như liệt kê dưới đây:

  • Các mô-đun được tạo dưới dạng dylib sẽ có tập hợp cfg android_dylib.

  • Các mô-đun sử dụng VNDK sẽ có tập hợp cfg android_vndk. Điều này tương tự như định nghĩa __ANDROID_VNDK__ cho C++.

dải

strip kiểm soát việc tệp đầu ra có bị xoá hay không và cách xoá (nếu có). Nếu bạn không đặt giá trị này, các mô-đun thiết bị sẽ mặc định xoá mọi thứ ngoại trừ mini debuginfo. Theo mặc định, các mô-đun lưu trữ không xoá bất kỳ ký hiệu nào. Các giá trị hợp lệ bao gồm none để tắt tính năng loại bỏ và all để loại bỏ mọi thứ, bao gồm cả debuginfo mini. Bạn có thể tìm thấy các giá trị bổ sung trong Tài liệu tham khảo về mô-đun Soong.

host_supported

Đối với các mô-đun thiết bị, tham số host_supported cho biết liệu mô-đun đó có nên cung cấp biến thể máy chủ hay không.

Xác định phần phụ thuộc thư viện

Các mô-đun Rust có thể phụ thuộc vào cả thư viện CC và Rust thông qua các thuộc tính sau:

Tên thuộc tính Mô tả
rustlibs Danh sách các mô-đun rust_library cũng là phần phụ thuộc. Hãy sử dụng phương thức này làm phương thức khai báo phần phụ thuộc mà bạn muốn, vì phương thức này cho phép hệ thống xây dựng chọn mối liên kết ưu tiên. (Xem phần Khi liên kết với thư viện Rust bên dưới)
rlibs Danh sách các mô-đun rust_library phải được liên kết tĩnh dưới dạng rlibs. (Hãy sử dụng cẩn thận; hãy xem phần Khi liên kết với thư viện Rust ở bên dưới.)
shared_libs Danh sách các mô-đun cc_library phải được liên kết động dưới dạng thư viện dùng chung.
static_libs Danh sách các mô-đun cc_library phải được liên kết tĩnh dưới dạng thư viện tĩnh.
whole_static_libs Danh sách các mô-đun cc_library phải được liên kết tĩnh dưới dạng thư viện tĩnh và được đưa vào toàn bộ thư viện thu được. Đối với các biến thể rust_ffi_static, whole_static_libraries sẽ được đưa vào bản lưu trữ thư viện tĩnh thu được. Đối với các biến thể rust_library_rlib, thư viện whole_static_libraries sẽ được đóng gói vào thư viện rlib thu được.

Khi liên kết với các thư viện Rust, bạn nên sử dụng thuộc tính rustlibs thay vì rlibs hoặc dylibs, trừ phi bạn có lý do cụ thể. Điều này cho phép hệ thống xây dựng chọn đường liên kết chính xác dựa trên yêu cầu của mô-đun gốc, đồng thời giảm khả năng cây phần phụ thuộc chứa cả phiên bản rlib và dylib của thư viện (khiến quá trình biên dịch không thành công).

Các tính năng xây dựng hỗ trợ không được hỗ trợ và bị hạn chế

Rust của Soong hỗ trợ hạn chế cho hình ảnh và ảnh chụp nhanh vendor và vendor_ramdisk. Tuy nhiên, staticlibs, cdylibs, rlibs và binaries được hỗ trợ. Đối với mục tiêu bản dựng hình ảnh của nhà cung cấp, thuộc tính android_vndk cfg sẽ được đặt. Bạn có thể sử dụng mã này trong mã nếu có sự khác biệt giữa hệ thống và mục tiêu của nhà cung cấp. rust_proc_macros không được ghi lại trong ảnh chụp nhanh của nhà cung cấp; nếu các tệp này phụ thuộc vào nhau, hãy đảm bảo bạn kiểm soát phiên bản của các tệp đó một cách thích hợp.

Hình ảnh sản phẩm, VNDK và hình ảnh khôi phục không được hỗ trợ.

Bản dựng tăng dần

Nhà phát triển có thể bật tính năng biên dịch gia tăng nguồn Rust bằng cách đặt biến môi trường SOONG_RUSTC_INCREMENTAL thành true.

Cảnh báo: Việc này không đảm bảo sẽ tạo ra các tệp nhị phân giống hệt với các tệp nhị phân do trình tạo bản dựng tạo ra. Địa chỉ của các hàm hoặc dữ liệu có trong tệp đối tượng có thể khác nhau. Để đảm bảo rằng các cấu phần phần mềm được tạo giống hệt 100% với các cấu phần phần mềm do cơ sở hạ tầng EngProd tạo, hãy để giá trị này không được đặt.