執行 ABI 監控

本頁面說明如何建構 Android 核心 ABI 表示法,並執行 ABI 監控。這項設定適用於 Android 14 更高。如需較低版本的資訊,請參閱舊版核心版本

另請參閱 Kleaf 參考文件: 支援 ABI 監控 (GKI)。支援 ABI 監控 (裝置)

建構核心及其 ABI 表示法

下載 GKI 來源後 執行下列指令,建構 GKI 核心和 ABI 構件:

tools/bazel run //common:kernel_aarch64_abi_dist

這個指令會建構目前的 ABI 表示法,並將其與已建構的核心和模組一起複製到 out_abi/kernel_aarch64/dist/abi.stg

您可以在 -- 後面的指令結尾指定 ABI 工具的額外引數。例如,變更 ABI 的目的地和建構構件時,您 可以使用 --dist_dir 選項:

tools/bazel run //common:kernel_aarch64_abi_dist -- --dist_dir=out/dist

分析建構作業與參考表示法之間的 ABI 差異

在上述指令中執行的 //common:kernel_aarch64_abi_dist 目標會分析並回報在 common/android/abi_gki_aarch64.stg 中 (在 BUILD.bazel 中定義) 的版本與參考表示法之間的任何 ABI 差異。這些差異會在建構結束時列印出來,如以下範例所示:

INFO: From [stg] Comparing Kernel ABI @//common:kernel_aarch64_abi_diff:
INFO: ABI DIFFERENCES HAVE BEEN DETECTED!

列印報表來自位於 out_abi/kernel_aarch64/dist/abi_stgdiff/abi.report.short 的建構成果,以及其他格式的報表。

自動化作業應使用建構指令的結束代碼,如果發現差異,則該代碼會為非零值。

請注意, 開發階段 分支版本 (包括 android-mainline) 沒有參照 ABI 表示法。 否則 //common:kernel_aarch64_abi_dist 不會偵測到任何差異。

更新參考 ABI 表示法

任何會影響核心 ABI 的變更,例如 符號清單更新 這些要求都必須反映在參照 ABI 表示法中 (common/android/abi_gki_aarch64.stg,定義於 BUILD.bazel)。 如要執行這項操作,請執行下列指令:

​​tools/bazel run //common:kernel_aarch64_abi_update

這個指令會執行「分析 ABI 差異」步驟中的所有操作,並更新來源中的參照表示法。接著,您就能將更新後的 ABI 上傳到 與變更相同的修訂版本納入 ABI 與 在修訂訊息的 $DIST_DIR/abi.report.short 中回報。

ABI 監控和裝置目標

您只需為核心核心建構目標設定 ABI 監控功能。直接使用 GKI 核心編譯的混合式建構設定 (定義 base_kernel 的設定),只需要新增追蹤裝置符號清單的支援功能。您使用 GKI 版本更新 ABI 定義。

另請參閱 Kleaf 參考文件: 支援 ABI 監控 (裝置)

較舊的核心版本

Android 13

建構操作說明與 Android 14,但 ABI 格式是 XML 和 參考 ABI 表示法為 common/android/abi_gki_aarch64.xml

Android 13 以下版本

如同 Android 13,ABI 格式為 XML。

較舊的核心會使用 build.sh 而非 Kleaf。如要進行 ABI 監控,則應使用 build_abi.sh,這個參數可接受相同的環境變數自訂 建構為 build.sh例如:

BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.sh

這會建構核心,並將 ABI 表示法擷取至 OUT_DIR (預設為 out_abi) 子目錄,相當於 Kleaf 的 //common:kernel_aarch64_abi_dist 目標 (請參閱「建構核心和 ABI 構件」)。

參考 ABI 表示法會儲存在 android/abi_gki_aarch64.xml 中,如 common/build.config.gki.aarch64ABI_DEFINITION 變數所定義。

如果您需要更新核心 ABI 表示法,最便利的方法就是 使用 --update--print-report 選項:

BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.sh --update --print-report

--print-report 會列印檔案與新產生的 ABI 之間的 ABI 差異。

--update 選項會覆寫參照 ABI 表示法。它也會 這個 符號清單更新 在已設定 KMI_SYMBOL_LIST 的裝置上使用 BUILD_CONFIG 時。